From 432705930dde63be2383d65d1fa217b20e1a4694 Mon Sep 17 00:00:00 2001 From: General Kroll Date: Thu, 25 Jul 2024 19:39:20 +1000 Subject: [PATCH 1/3] dashboard-patches-01 Summary: - Small changes noted in manual querying for dashboards, round 1. --- .../src/azure/v00.00.00000/services/network.yaml | 12 ++++++------ providers/src/googleadmin/v00.00.00000/provider.yaml | 1 + 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/providers/src/azure/v00.00.00000/services/network.yaml b/providers/src/azure/v00.00.00000/services/network.yaml index 8d185feb..f4ea6bb3 100644 --- a/providers/src/azure/v00.00.00000/services/network.yaml +++ b/providers/src/azure/v00.00.00000/services/network.yaml @@ -22007,25 +22007,25 @@ components: methods: delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups~1{ruleCollectionGroupName}~1?api-version=2023-11-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups~1{ruleCollectionGroupName}?api-version=2023-11-01/delete' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups~1{ruleCollectionGroupName}~1?api-version=2023-11-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups~1{ruleCollectionGroupName}?api-version=2023-11-01/get' response: mediaType: application/json openAPIDocKey: '200' create_or_update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups~1{ruleCollectionGroupName}~1?api-version=2023-11-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups~1{ruleCollectionGroupName}?api-version=2023-11-01/put' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups~1?api-version=2023-11-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Network~1firewallPolicies~1{firewallPolicyName}~1ruleCollectionGroups?api-version=2023-11-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -31651,7 +31651,7 @@ paths: $ref: '#/components/schemas/CloudError' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}/?api-version=2023-11-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}?api-version=2023-11-01: delete: tags: - FirewallPolicyRuleCollectionGroups @@ -31786,7 +31786,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/?api-version=2023-11-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups?api-version=2023-11-01: get: tags: - FirewallPolicyRuleCollectionGroups diff --git a/providers/src/googleadmin/v00.00.00000/provider.yaml b/providers/src/googleadmin/v00.00.00000/provider.yaml index 5fe15bca..b839a26b 100644 --- a/providers/src/googleadmin/v00.00.00000/provider.yaml +++ b/providers/src/googleadmin/v00.00.00000/provider.yaml @@ -18,3 +18,4 @@ config: scopes: - 'https://www.googleapis.com/auth/cloud-platform' - 'https://www.googleapis.com/auth/admin.directory.user.readonly' + - 'https://www.googleapis.com/auth/admin.directory.group.readonly' From c04f29aa6ff611f8e569152694c3591c36df60bf Mon Sep 17 00:00:00 2001 From: General Kroll Date: Sat, 27 Jul 2024 08:17:03 +1000 Subject: [PATCH 2/3] azure-pass-01 Summary: - A bunch of `azure.storage` schema objects are lacking `name` and `id` attributes in schema definition that are actually present in response bodies, and significant. Eg: `FileShareItem`. - Trailing `/` immediately followed by query parameters is sometimes ok, sometimes not; either way appears erroneous. --- .../azure/v00.00.00000/services/storage.yaml | 355 +++++++++--------- 1 file changed, 187 insertions(+), 168 deletions(-) diff --git a/providers/src/azure/v00.00.00000/services/storage.yaml b/providers/src/azure/v00.00.00000/services/storage.yaml index 77833c47..ccb75985 100644 --- a/providers/src/azure/v00.00.00000/services/storage.yaml +++ b/providers/src/azure/v00.00.00000/services/storage.yaml @@ -1253,6 +1253,12 @@ components: ListContainerItem: description: The blob container properties be listed out. properties: + id: + type: string + description: Fully qualified resource ID for the Resource. + name: + type: string + description: The name of the resource properties: $ref: '#/components/schemas/ContainerProperties' x-ms-client-flatten: true @@ -3235,6 +3241,13 @@ components: StorageAccount: description: The storage account. properties: + id: + readOnly: true + type: string + description: Resource Id + name: + type: string + description: Resource name sku: $ref: '#/components/schemas/Sku' readOnly: true @@ -4845,6 +4858,12 @@ components: FileShareItem: description: The file share properties be listed out. properties: + name: + type: string + description: The name of the share. + id: + type: string + description: Fully qualified resource ID for the resource. properties: $ref: '#/components/schemas/FileShareProperties' x-ms-client-flatten: true @@ -5330,14 +5349,14 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value set_service_properties: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1{tableServiceName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1{tableServiceName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' @@ -5354,7 +5373,7 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1{tableServiceName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1{tableServiceName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5371,31 +5390,31 @@ components: methods: create: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}~1?api-version=2023-05-01/patch' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}?api-version=2023-05-01/patch' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1{tableName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1tableServices~1default~1tables?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5416,20 +5435,20 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1networkSecurityPerimeterConfigurations~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1networkSecurityPerimeterConfigurations?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1networkSecurityPerimeterConfigurations~1{networkSecurityPerimeterConfigurationName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1networkSecurityPerimeterConfigurations~1{networkSecurityPerimeterConfigurationName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' reconcile: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1networkSecurityPerimeterConfigurations~1{networkSecurityPerimeterConfigurationName}~1reconcile~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1networkSecurityPerimeterConfigurations~1{networkSecurityPerimeterConfigurationName}~1reconcile?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -5447,14 +5466,14 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value set_service_properties: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1{BlobServicesName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1{BlobServicesName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' @@ -5471,7 +5490,7 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1{BlobServicesName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1{BlobServicesName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5488,68 +5507,68 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value create: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1?api-version=2023-05-01/patch' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}?api-version=2023-05-01/patch' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' set_legal_hold: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1setLegalHold~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1setLegalHold?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' clear_legal_hold: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1clearLegalHold~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1clearLegalHold?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' lock_immutability_policy: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1default~1lock~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1default~1lock?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' extend_immutability_policy: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1default~1extend~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1default~1extend?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' lease: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1lease~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1lease?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' object_level_worm: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1migrate~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1migrate?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -5569,19 +5588,19 @@ components: methods: create_or_update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1{immutabilityPolicyName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1{immutabilityPolicyName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1{immutabilityPolicyName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1{immutabilityPolicyName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1{immutabilityPolicyName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1blobServices~1default~1containers~1{containerName}~1immutabilityPolicies~1{immutabilityPolicyName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -5600,14 +5619,14 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value set_service_properties: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1{queueServiceName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1{queueServiceName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' @@ -5624,7 +5643,7 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1{queueServiceName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1{queueServiceName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5641,31 +5660,31 @@ components: methods: create: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}~1?api-version=2023-05-01/patch' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}?api-version=2023-05-01/patch' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1{queueName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1queueServices~1default~1queues?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5686,7 +5705,7 @@ components: methods: list: operation: - $ref: '#/paths/~1providers~1Microsoft.Storage~1operations~1?api-version=2023-05-01/get' + $ref: '#/paths/~1providers~1Microsoft.Storage~1operations?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5704,7 +5723,7 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1skus~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1skus?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5722,81 +5741,81 @@ components: methods: check_name_availability: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1checkNameAvailability~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1checkNameAvailability?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' create: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1?api-version=2023-05-01/patch' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}?api-version=2023-05-01/patch' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1storageAccounts~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1storageAccounts?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value list_by_resource_group: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value regenerate_key: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1regenerateKey~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1regenerateKey?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' failover: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1failover~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1failover?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' hierarchical_namespace_migration: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourcegroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1hnsonmigration~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourcegroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1hnsonmigration?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' abort_hierarchical_namespace_migration: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourcegroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1aborthnsonmigration~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourcegroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1aborthnsonmigration?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' customer_initiated_migration: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1startAccountMigration~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1startAccountMigration?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' restore_blob_ranges: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1restoreBlobRanges~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1restoreBlobRanges?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' revoke_user_delegation_keys: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1revokeUserDelegationKeys~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1revokeUserDelegationKeys?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -5816,7 +5835,7 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5833,14 +5852,14 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1deletedAccounts~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1deletedAccounts?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1locations~1{location}~1deletedAccounts~1{deletedAccountName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1locations~1{location}~1deletedAccounts~1{deletedAccountName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5858,7 +5877,7 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1listKeys~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1listKeys?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -5875,7 +5894,7 @@ components: methods: list_by_location: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1locations~1{location}~1usages~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1providers~1Microsoft.Storage~1locations~1{location}~1usages?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5893,7 +5912,7 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1ListAccountSas~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1ListAccountSas?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -5910,7 +5929,7 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1ListServiceSas~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1ListServiceSas?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -5927,7 +5946,7 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1accountMigrations~1{migrationName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1accountMigrations~1{migrationName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5944,19 +5963,19 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1managementPolicies~1{managementPolicyName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1managementPolicies~1{managementPolicyName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' create_or_update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1managementPolicies~1{managementPolicyName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1managementPolicies~1{managementPolicyName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1managementPolicies~1{managementPolicyName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1managementPolicies~1{managementPolicyName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -5975,25 +5994,25 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies~1{blobInventoryPolicyName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies~1{blobInventoryPolicyName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' create_or_update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies~1{blobInventoryPolicyName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies~1{blobInventoryPolicyName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies~1{blobInventoryPolicyName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies~1{blobInventoryPolicyName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1inventoryPolicies?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -6014,26 +6033,26 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections~1{privateEndpointConnectionName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections~1{privateEndpointConnectionName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' put: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections~1{privateEndpointConnectionName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections~1{privateEndpointConnectionName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections~1{privateEndpointConnectionName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateEndpointConnections~1{privateEndpointConnectionName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -6052,7 +6071,7 @@ components: methods: list_by_storage_account: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateLinkResources~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1privateLinkResources?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -6070,26 +6089,26 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies~1{objectReplicationPolicyId}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies~1{objectReplicationPolicyId}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' create_or_update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies~1{objectReplicationPolicyId}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies~1{objectReplicationPolicyId}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies~1{objectReplicationPolicyId}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1objectReplicationPolicies~1{objectReplicationPolicyId}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -6109,32 +6128,32 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' create_or_update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' regenerate_password: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}~1regeneratePassword~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}~1regeneratePassword?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -6154,7 +6173,7 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}~1listKeys~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1localUsers~1{username}~1listKeys?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -6171,25 +6190,25 @@ components: methods: put: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes~1{encryptionScopeName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes~1{encryptionScopeName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' patch: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes~1{encryptionScopeName}~1?api-version=2023-05-01/patch' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes~1{encryptionScopeName}?api-version=2023-05-01/patch' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes~1{encryptionScopeName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes~1{encryptionScopeName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1encryptionScopes?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -6208,14 +6227,14 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value set_service_properties: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1{FileServicesName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1{FileServicesName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' @@ -6232,7 +6251,7 @@ components: methods: get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1{FileServicesName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1{FileServicesName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -6249,44 +6268,44 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' objectKey: $.value create: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1?api-version=2023-05-01/patch' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}?api-version=2023-05-01/patch' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' restore: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1restore~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1restore?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' lease: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1lease~1?api-version=2023-05-01/post' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1fileServices~1default~1shares~1{shareName}~1lease?api-version=2023-05-01/post' response: mediaType: application/json openAPIDocKey: '200' @@ -6306,31 +6325,31 @@ components: methods: create: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}~1?api-version=2023-05-01/put' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}?api-version=2023-05-01/put' response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}~1?api-version=2023-05-01/patch' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}?api-version=2023-05-01/patch' response: mediaType: application/json openAPIDocKey: '200' get: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' delete: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}~1?api-version=2023-05-01/delete' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}?api-version=2023-05-01/delete' response: mediaType: application/json openAPIDocKey: '200' list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -6351,7 +6370,7 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1reports~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1reports?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -6369,7 +6388,7 @@ components: methods: list: operation: - $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}~1reports~1?api-version=2023-05-01/get' + $ref: '#/paths/~1subscriptions~1{subscriptionId}~1resourceGroups~1{resourceGroupName}~1providers~1Microsoft.Storage~1storageAccounts~1{accountName}~1storageTaskAssignments~1{storageTaskAssignmentName}~1reports?api-version=2023-05-01/get' response: mediaType: application/json openAPIDocKey: '200' @@ -6381,7 +6400,7 @@ components: update: [] delete: [] paths: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices?api-version=2023-05-01: get: tags: - TableServiceProperties @@ -6404,7 +6423,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}?api-version=2023-05-01: put: tags: - TableServiceProperties @@ -6459,7 +6478,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}?api-version=2023-05-01: put: tags: - TableService @@ -6564,7 +6583,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables?api-version=2023-05-01: get: tags: - TableService @@ -6589,7 +6608,7 @@ paths: $ref: '#/components/schemas/CloudError' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations?api-version=2023-05-01: get: tags: - StorageAccounts NetworkSecurityPerimeterConfigurations @@ -6614,7 +6633,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}?api-version=2023-05-01: get: tags: - StorageAccounts NetworkSecurityPerimeterConfigurations @@ -6638,7 +6657,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile?api-version=2023-05-01: post: tags: - StorageAccounts NetworkSecurityPerimeterConfigurations @@ -6665,7 +6684,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices?api-version=2023-05-01: get: tags: - BlobService @@ -6684,7 +6703,7 @@ paths: $ref: '#/components/schemas/BlobServiceItems' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}?api-version=2023-05-01: put: tags: - BlobService @@ -6727,7 +6746,7 @@ paths: application/json: schema: $ref: '#/components/schemas/BlobServiceProperties' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers?api-version=2023-05-01: get: tags: - BlobContainers @@ -6767,7 +6786,7 @@ paths: $ref: '#/components/schemas/ListContainerItems' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}?api-version=2023-05-01: put: tags: - BlobContainers @@ -6857,7 +6876,7 @@ paths: description: OK -- Delete Container operation completed successfully. '204': description: No Content -- The Container not exist. - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold?api-version=2023-05-01: post: tags: - BlobContainers @@ -6883,7 +6902,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LegalHold' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold?api-version=2023-05-01: post: tags: - BlobContainers @@ -6909,7 +6928,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LegalHold' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}?api-version=2023-05-01: put: tags: - BlobContainers @@ -7004,7 +7023,7 @@ paths: schema: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/lock/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/lock?api-version=2023-05-01: post: tags: - BlobContainers @@ -7033,7 +7052,7 @@ paths: schema: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/extend/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/extend?api-version=2023-05-01: post: tags: - BlobContainers @@ -7069,7 +7088,7 @@ paths: schema: type: string description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/lease/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/lease?api-version=2023-05-01: post: tags: - BlobContainers @@ -7094,7 +7113,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LeaseContainerResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/migrate/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/migrate?api-version=2023-05-01: post: tags: - BlobContainers @@ -7119,7 +7138,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices?api-version=2023-05-01: get: tags: - QueueServiceProperties @@ -7142,7 +7161,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}?api-version=2023-05-01: put: tags: - QueueServiceProperties @@ -7197,7 +7216,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}?api-version=2023-05-01: put: tags: - QueueService @@ -7302,7 +7321,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues?api-version=2023-05-01: get: tags: - QueueService @@ -7337,7 +7356,7 @@ paths: $ref: '#/components/schemas/CloudError' x-ms-pageable: nextLinkName: nextLink - /providers/Microsoft.Storage/operations/?api-version=2023-05-01: + /providers/Microsoft.Storage/operations?api-version=2023-05-01: get: tags: - Operations @@ -7353,7 +7372,7 @@ paths: $ref: '#/components/schemas/OperationListResult' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus?api-version=2023-05-01: get: tags: - Skus @@ -7370,7 +7389,7 @@ paths: $ref: '#/components/schemas/StorageSkuListResult' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7393,7 +7412,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CheckNameAvailabilityResult' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2023-05-01: put: tags: - StorageAccounts @@ -7487,7 +7506,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StorageAccount' - /subscriptions/{subscriptionId}/providers/Microsoft.Storage/deletedAccounts/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/deletedAccounts?api-version=2023-05-01: get: tags: - DeletedAccounts @@ -7510,7 +7529,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/deletedAccounts/{deletedAccountName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/deletedAccounts/{deletedAccountName}?api-version=2023-05-01: get: tags: - DeletedAccounts @@ -7538,7 +7557,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts?api-version=2023-05-01: get: tags: - StorageAccounts @@ -7555,7 +7574,7 @@ paths: $ref: '#/components/schemas/StorageAccountListResult' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts?api-version=2023-05-01: get: tags: - StorageAccounts @@ -7573,7 +7592,7 @@ paths: $ref: '#/components/schemas/StorageAccountListResult' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7600,7 +7619,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StorageAccountListKeysResult' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7625,7 +7644,7 @@ paths: application/json: schema: $ref: '#/components/schemas/StorageAccountListKeysResult' - /subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages?api-version=2023-05-01: get: tags: - LocationUsage @@ -7648,7 +7667,7 @@ paths: $ref: '#/components/schemas/UsageListResult' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7673,7 +7692,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListAccountSasResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7698,7 +7717,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListServiceSasResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7727,7 +7746,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/hnsonmigration/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/hnsonmigration?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7757,7 +7776,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/aborthnsonmigration/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/aborthnsonmigration?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7781,7 +7800,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration?api-version=2023-05-01: post: tags: - AccountMigrations @@ -7817,7 +7836,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}?api-version=2023-05-01: get: tags: - AccountMigrations @@ -7841,7 +7860,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/restoreBlobRanges/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/restoreBlobRanges?api-version=2023-05-01: post: tags: - StorageAccounts @@ -7875,7 +7894,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}?api-version=2023-05-01: get: tags: - ManagementPolicies @@ -7933,7 +7952,7 @@ paths: description: OK -- Delete the managementpolicy successfully. '204': description: No Content -- The managementpolicy does not exist. - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}?api-version=2023-05-01: get: tags: - BlobInventoryPolicies @@ -8009,7 +8028,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies?api-version=2023-05-01: get: tags: - BlobInventoryPolicies @@ -8034,7 +8053,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections?api-version=2023-05-01: get: tags: - PrivateEndpointConnections @@ -8053,7 +8072,7 @@ paths: $ref: '#/components/schemas/PrivateEndpointConnectionListResult' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-05-01: get: tags: - PrivateEndpointConnections @@ -8129,7 +8148,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateLinkResources/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateLinkResources?api-version=2023-05-01: get: tags: - PrivateLinkResources @@ -8146,7 +8165,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PrivateLinkResourceListResult' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies?api-version=2023-05-01: get: tags: - ObjectReplicationPolicies @@ -8171,7 +8190,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}?api-version=2023-05-01: get: tags: - ObjectReplicationPolicies @@ -8247,7 +8266,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/revokeUserDelegationKeys/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/revokeUserDelegationKeys?api-version=2023-05-01: post: tags: - StorageAccounts @@ -8267,7 +8286,7 @@ paths: responses: '200': description: OK -- revoke user delegation keys succeeded. - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers?api-version=2023-05-01: get: tags: - LocalUsers @@ -8316,7 +8335,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' x-ms-pageable: nextLinkName: null - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}?api-version=2023-05-01: get: tags: - LocalUsers @@ -8392,7 +8411,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/listKeys/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/listKeys?api-version=2023-05-01: post: tags: - LocalUsers @@ -8416,7 +8435,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/regeneratePassword/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/regeneratePassword?api-version=2023-05-01: post: tags: - LocalUsers @@ -8440,7 +8459,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}?api-version=2023-05-01: put: tags: - EncryptionScopes @@ -8532,7 +8551,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes?api-version=2023-05-01: get: tags: - EncryptionScopes @@ -8577,7 +8596,7 @@ paths: $ref: '#/components/schemas/EncryptionScopeListResult' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices?api-version=2023-05-01: get: tags: - FileService @@ -8600,7 +8619,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}?api-version=2023-05-01: put: tags: - FileService @@ -8655,7 +8674,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares?api-version=2023-05-01: get: tags: - FileShares @@ -8696,7 +8715,7 @@ paths: $ref: '#/components/schemas/CloudError' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2023-05-01: put: tags: - FileShares @@ -8840,7 +8859,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore?api-version=2023-05-01: post: tags: - FileShares @@ -8867,7 +8886,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/lease/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/lease?api-version=2023-05-01: post: tags: - FileShares @@ -8909,7 +8928,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CloudError' - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}?api-version=2023-05-01: put: tags: - StorageTaskAssignments @@ -9047,7 +9066,7 @@ paths: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments?api-version=2023-05-01: get: tags: - StorageTaskAssignments @@ -9077,7 +9096,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/reports/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/reports?api-version=2023-05-01: get: tags: - StorageTaskAssignments @@ -9112,7 +9131,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' x-ms-pageable: nextLinkName: nextLink - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/reports/?api-version=2023-05-01: + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/reports?api-version=2023-05-01: get: tags: - StorageTaskAssignments From b9aa3942d9d2a6925a10d573a97c52fc7b97bbc8 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Fri, 13 Sep 2024 17:35:01 +1000 Subject: [PATCH 3/3] updated google --- .../googleapis.com/v00.00.00000/provider.yaml | 77 +- .../v00.00.00000/services/accessapproval.yaml | 119 +- .../services/accesscontextmanager.yaml | 311 +- .../services/addressvalidation.yaml | 1681 +- .../services/advisorynotifications.yaml | 563 +- .../v00.00.00000/services/aiplatform.yaml | 60317 +++++++++------- .../v00.00.00000/services/airquality.yaml | 1163 + .../v00.00.00000/services/alloydb.yaml | 756 +- .../v00.00.00000/services/analyticshub.yaml | 831 +- .../v00.00.00000/services/apigateway.yaml | 130 +- .../v00.00.00000/services/apigee.yaml | 27271 +++---- .../v00.00.00000/services/apigeeregistry.yaml | 416 +- .../v00.00.00000/services/apikeys.yaml | 721 +- .../v00.00.00000/services/apim.yaml | 1956 + .../v00.00.00000/services/appengine.yaml | 206 +- .../v00.00.00000/services/apphub.yaml | 144 +- .../services/artifactregistry.yaml | 266 +- .../services/assuredworkloads.yaml | 2212 +- .../v00.00.00000/services/backupdr.yaml | 4988 +- .../services/baremetalsolution.yaml | 200 +- .../v00.00.00000/services/batch.yaml | 269 +- .../v00.00.00000/services/beyondcorp.yaml | 301 +- .../v00.00.00000/services/biglake.yaml | 48 +- .../v00.00.00000/services/bigquery.yaml | 352 +- .../services/bigqueryconnection.yaml | 52 +- .../services/bigquerydatapolicy.yaml | 46 +- .../services/bigquerydatatransfer.yaml | 141 +- .../services/bigqueryreservation.yaml | 66 +- .../v00.00.00000/services/bigtableadmin.yaml | 446 +- .../v00.00.00000/services/billingbudgets.yaml | 958 +- .../services/binaryauthorization.yaml | 102 +- .../services/blockchainnodeengine.yaml | 48 +- .../services/certificatemanager.yaml | 291 +- .../v00.00.00000/services/cloudasset.yaml | 138 +- .../v00.00.00000/services/cloudbilling.yaml | 97 +- .../v00.00.00000/services/cloudbuild.yaml | 4589 +- .../services/cloudcommerceprocurement.yaml | 1278 +- .../services/cloudcontrolspartner.yaml | 83 +- .../v00.00.00000/services/clouddeploy.yaml | 478 +- .../services/clouderrorreporting.yaml | 314 +- .../v00.00.00000/services/cloudfunctions.yaml | 436 +- .../v00.00.00000/services/cloudidentity.yaml | 231 +- .../v00.00.00000/services/cloudkms.yaml | 373 +- .../v00.00.00000/services/cloudprofiler.yaml | 21 +- .../services/cloudresourcemanager.yaml | 230 +- .../v00.00.00000/services/cloudscheduler.yaml | 38 +- .../v00.00.00000/services/cloudshell.yaml | 40 +- .../v00.00.00000/services/cloudsupport.yaml | 1758 +- .../v00.00.00000/services/cloudtasks.yaml | 99 +- .../v00.00.00000/services/cloudtrace.yaml | 6 +- .../v00.00.00000/services/composer.yaml | 113 +- .../v00.00.00000/services/compute.yaml | 4302 +- .../v00.00.00000/services/config.yaml | 147 +- .../v00.00.00000/services/connectors.yaml | 119 +- .../services/contactcenteraiplatform.yaml | 99 +- .../services/contactcenterinsights.yaml | 9804 ++- .../v00.00.00000/services/container.yaml | 488 +- .../services/containeranalysis.yaml | 10324 +-- .../services/contentwarehouse.yaml | 9498 +-- .../v00.00.00000/services/datacatalog.yaml | 236 +- .../v00.00.00000/services/dataflow.yaml | 462 +- .../v00.00.00000/services/dataform.yaml | 623 +- .../v00.00.00000/services/datafusion.yaml | 511 +- .../v00.00.00000/services/datalabeling.yaml | 184 +- .../v00.00.00000/services/datalineage.yaml | 1247 +- .../v00.00.00000/services/datamigration.yaml | 448 +- .../v00.00.00000/services/datapipelines.yaml | 1420 +- .../v00.00.00000/services/dataplex.yaml | 3744 +- .../v00.00.00000/services/dataproc.yaml | 397 +- .../v00.00.00000/services/datastore.yaml | 55 +- .../v00.00.00000/services/datastream.yaml | 271 +- .../services/deploymentmanager.yaml | 94 +- .../services/developerconnect.yaml | 97 +- .../v00.00.00000/services/dialogflow.yaml | 1406 +- .../services/discoveryengine.yaml | 10877 ++- .../v00.00.00000/services/dlp.yaml | 17773 ++--- .../v00.00.00000/services/dns.yaml | 457 +- .../v00.00.00000/services/documentai.yaml | 11789 ++- .../v00.00.00000/services/domains.yaml | 900 +- .../services/essentialcontacts.yaml | 872 +- .../v00.00.00000/services/eventarc.yaml | 151 +- .../v00.00.00000/services/file.yaml | 301 +- .../v00.00.00000/services/firestore.yaml | 553 +- .../v00.00.00000/services/gkebackup.yaml | 237 +- .../v00.00.00000/services/gkehub.yaml | 7169 +- .../v00.00.00000/services/gkeonprem.yaml | 428 +- .../v00.00.00000/services/healthcare.yaml | 1825 +- .../v00.00.00000/services/iam.yaml | 7190 +- .../v00.00.00000/services/iamcredentials.yaml | 5 +- .../v00.00.00000/services/iamv2.yaml | 1106 + .../v00.00.00000/services/iamv2beta.yaml | 1106 + .../v00.00.00000/services/iap.yaml | 151 +- .../services/identitytoolkit.yaml | 22 +- .../v00.00.00000/services/ids.yaml | 66 +- .../v00.00.00000/services/integrations.yaml | 20196 +++--- .../v00.00.00000/services/jobs.yaml | 230 +- .../v00.00.00000/services/kmsinventory.yaml | 1030 +- .../v00.00.00000/services/language.yaml | 7474 +- .../v00.00.00000/services/libraryagent.yaml | 342 +- .../v00.00.00000/services/lifesciences.yaml | 37 +- .../v00.00.00000/services/logging.yaml | 3098 +- .../v00.00.00000/services/looker.yaml | 165 +- .../services/managedidentities.yaml | 189 +- .../v00.00.00000/services/memcache.yaml | 69 +- .../v00.00.00000/services/metastore.yaml | 790 +- .../services/migrationcenter.yaml | 258 +- .../v00.00.00000/services/ml.yaml | 160 +- .../v00.00.00000/services/monitoring.yaml | 317 +- .../services/networkconnectivity.yaml | 440 +- .../services/networkmanagement.yaml | 236 +- .../services/networksecurity.yaml | 590 +- .../services/networkservices.yaml | 1054 +- .../v00.00.00000/services/notebooks.yaml | 192 +- .../services/ondemandscanning.yaml | 39 +- .../v00.00.00000/services/orgpolicy.yaml | 1597 +- .../v00.00.00000/services/osconfig.yaml | 148 +- .../v00.00.00000/services/oslogin.yaml | 8 +- .../v00.00.00000/services/places.yaml | 3107 +- .../v00.00.00000/services/policyanalyzer.yaml | 261 +- .../services/policysimulator.yaml | 3911 +- .../services/policytroubleshooter.yaml | 1001 +- .../v00.00.00000/services/pollen.yaml | 653 + .../v00.00.00000/services/privateca.yaml | 209 +- .../services/prod_tt_sasportal.yaml | 4044 +- .../v00.00.00000/services/publicca.yaml | 5 +- .../v00.00.00000/services/pubsub.yaml | 228 +- .../v00.00.00000/services/pubsublite.yaml | 109 +- .../services/rapidmigrationassessment.yaml | 59 +- .../services/recaptchaenterprise.yaml | 4028 +- .../services/recommendationengine.yaml | 100 +- .../v00.00.00000/services/recommender.yaml | 2766 +- .../v00.00.00000/services/redis.yaml | 884 +- .../services/resourcesettings.yaml | 488 +- .../v00.00.00000/services/retail.yaml | 390 +- .../v00.00.00000/services/run.yaml | 478 +- .../v00.00.00000/services/runtimeconfig.yaml | 20 +- .../v00.00.00000/services/sasportal.yaml | 3870 +- .../v00.00.00000/services/secretmanager.yaml | 117 +- .../v00.00.00000/services/securitycenter.yaml | 1558 +- .../services/serviceconsumermanagement.yaml | 6101 +- .../v00.00.00000/services/servicecontrol.yaml | 30 +- .../services/servicedirectory.yaml | 98 +- .../services/servicemanagement.yaml | 256 +- .../services/servicenetworking.yaml | 7494 +- .../v00.00.00000/services/serviceusage.yaml | 6595 +- .../v00.00.00000/services/solar.yaml | 1465 +- .../v00.00.00000/services/sourcerepo.yaml | 1260 - .../v00.00.00000/services/spanner.yaml | 1621 +- .../v00.00.00000/services/speech.yaml | 51 +- .../v00.00.00000/services/sqladmin.yaml | 570 +- .../v00.00.00000/services/storage.yaml | 364 +- .../services/storagetransfer.yaml | 62 +- .../v00.00.00000/services/testing.yaml | 37 +- .../v00.00.00000/services/texttospeech.yaml | 34 +- .../v00.00.00000/services/tpu.yaml | 107 +- .../services/trafficdirector.yaml | 5 +- .../v00.00.00000/services/transcoder.yaml | 36 +- .../v00.00.00000/services/translate.yaml | 278 +- .../services/videointelligence.yaml | 28 +- .../v00.00.00000/services/vision.yaml | 152 +- .../v00.00.00000/services/vmmigration.yaml | 566 +- .../v00.00.00000/services/vmwareengine.yaml | 439 +- .../v00.00.00000/services/vpcaccess.yaml | 64 +- .../v00.00.00000/services/webrisk.yaml | 868 +- .../services/websecurityscanner.yaml | 1691 +- .../services/workflowexecutions.yaml | 170 +- .../v00.00.00000/services/workflows.yaml | 81 +- .../services/workloadmanager.yaml | 300 +- .../v00.00.00000/services/workstations.yaml | 243 +- 169 files changed, 178555 insertions(+), 146180 deletions(-) create mode 100644 providers/src/googleapis.com/v00.00.00000/services/airquality.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/apim.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml create mode 100644 providers/src/googleapis.com/v00.00.00000/services/pollen.yaml delete mode 100644 providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml diff --git a/providers/src/googleapis.com/v00.00.00000/provider.yaml b/providers/src/googleapis.com/v00.00.00000/provider.yaml index 181da522..71fc082d 100644 --- a/providers/src/googleapis.com/v00.00.00000/provider.yaml +++ b/providers/src/googleapis.com/v00.00.00000/provider.yaml @@ -63,6 +63,15 @@ providerServices: description: >- Train high-quality custom machine learning models with minimal machine learning expertise and effort. + airquality: + id: airquality:v00.00.00000 + name: airquality + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/airquality.yaml + title: Air Quality API + version: v00.00.00000 + description: The Air Quality API. alloydb: id: alloydb:v00.00.00000 name: alloydb @@ -133,6 +142,17 @@ providerServices: title: API Keys API version: v00.00.00000 description: Manages the API keys associated with developer projects. + apim: + id: apim:v00.00.00000 + name: apim + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/apim.yaml + title: API Management API + version: v00.00.00000 + description: >- + Enables users to discover shadow APIs in existing Google Cloud + infrastructure. appengine: id: appengine:v00.00.00000 name: appengine @@ -867,7 +887,7 @@ providerServices: preferred: true service: $ref: googleapis.com/v00.00.00000/services/gkeonprem.yaml - title: Anthos On-Prem API + title: GDC Virtual API version: v00.00.00000 description: '' healthcare: @@ -906,6 +926,36 @@ providerServices: Creates short-lived credentials for impersonating IAM service accounts. Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API. + iamv2: + id: iamv2:v00.00.00000 + name: iamv2 + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/iamv2.yaml + title: Identity and Access Management (IAM) API + version: v00.00.00000 + description: >- + Manages identity and access control for Google Cloud resources, including + the creation of service accounts, which you can use to authenticate to + Google and make API calls. Enabling this API also enables the IAM Service + Account Credentials API (iamcredentials.googleapis.com). However, + disabling this API doesn't disable the IAM Service Account Credentials + API. + iamv2beta: + id: iamv2beta:v00.00.00000 + name: iamv2beta + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/iamv2beta.yaml + title: Identity and Access Management (IAM) API + version: v00.00.00000 + description: >- + Manages identity and access control for Google Cloud resources, including + the creation of service accounts, which you can use to authenticate to + Google and make API calls. Enabling this API also enables the IAM Service + Account Credentials API (iamcredentials.googleapis.com). However, + disabling this API doesn't disable the IAM Service Account Credentials + API. iap: id: iap:v00.00.00000 name: iap @@ -1206,6 +1256,15 @@ providerServices: title: Policy Troubleshooter API version: v00.00.00000 description: '' + pollen: + id: pollen:v00.00.00000 + name: pollen + preferred: true + service: + $ref: googleapis.com/v00.00.00000/services/pollen.yaml + title: Pollen API + version: v00.00.00000 + description: 'The Pollen API. ' privateca: id: privateca:v00.00.00000 name: privateca @@ -1473,22 +1532,6 @@ providerServices: title: Solar API version: v00.00.00000 description: Solar API. - sourcerepo: - id: sourcerepo:v00.00.00000 - name: sourcerepo - preferred: true - service: - $ref: googleapis.com/v00.00.00000/services/sourcerepo.yaml - title: Cloud Source Repositories API - version: v00.00.00000 - description: >- - Accesses source code repositories hosted by Google. Important: Cloud - Source Repositories is scheduled for end of sales starting June 17, 2024. - Customers who have enabled the API prior to this date will not be affected - and can continue to use Cloud Source Repositories. Organizations or - projects who have not previously enabled the API cannot use Cloud Source - Repositories after this date. View Cloud Source Repositories documentation - for more info. spanner: id: spanner:v00.00.00000 name: spanner diff --git a/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml b/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml index 218ee1fe..dc44e752 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accessapproval.yaml @@ -7,8 +7,8 @@ info: title: Access Approval API description: An API for controlling access to data by Google personnel. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/assured-workloads/access-approval/docs servers: @@ -69,6 +69,9 @@ components: "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. type: string + requestedAugmentedInfo: + description: This field contains the augmented information of the request. + $ref: '#/components/schemas/AugmentedInfo' requestedResourceProperties: description: >- Properties related to the resource represented by @@ -100,6 +103,17 @@ components: dismiss: description: The request was dismissed. $ref: '#/components/schemas/DismissDecision' + AugmentedInfo: + id: AugmentedInfo + description: This field contains the augmented information of the request. + type: object + properties: + command: + description: >- + For command-line tools, the full command-line exactly as entered by + the actor without adding any additional characters (such as + quotation marks). + type: string ResourceProperties: id: ResourceProperties description: The properties associated with the resource of the request. @@ -457,6 +471,27 @@ components: Optional. A setting to require approval request justifications to be customer visible. type: boolean + requestScopeMaxWidthPreference: + description: >- + Optional. A setting to indicate the maximum width of an Access + Approval request. + type: string + enumDescriptions: + - Default value for proto, shouldn't be used. + - >- + This is the widest scope possible. It means the customer has no + scope restriction when it comes to Access Approval requests. + - >- + Customer allows the scope of Access Approval requests as broad as + the Folder level. + - >- + Customer allows the scope of Access Approval requests as broad as + the Project level. + enum: + - REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED + - ORGANIZATION + - FOLDER + - PROJECT EnrolledService: id: EnrolledService description: Represents the enrollment of a cloud resource into a specific service. @@ -680,7 +715,14 @@ components: - $ref: >- #/components/x-stackQL-resources/access_approval_settings/methods/organizations_get_access_approval_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/access_approval_settings/methods/projects_update_access_approval_settings + - $ref: >- + #/components/x-stackQL-resources/access_approval_settings/methods/folders_update_access_approval_settings + - $ref: >- + #/components/x-stackQL-resources/access_approval_settings/methods/organizations_update_access_approval_settings + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/access_approval_settings/methods/projects_delete_access_approval_settings @@ -721,22 +763,20 @@ components: #/components/x-stackQL-resources/service_account/methods/organizations_get_service_account insert: [] update: [] + replace: [] delete: [] approval_requests: id: google.accessapproval.approval_requests name: approval_requests title: Approval_requests methods: - _projects_approval_requests_list: - operation: &ref_1 + projects_approval_requests_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1approvalRequests/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.approvalRequests - projects_approval_requests_list: - operation: *ref_1 - response: *ref_2 projects_approval_requests_get: operation: $ref: >- @@ -765,16 +805,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_approval_requests_list: - operation: &ref_3 + folders_approval_requests_list: + operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1approvalRequests/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.approvalRequests - folders_approval_requests_list: - operation: *ref_3 - response: *ref_4 folders_approval_requests_get: operation: $ref: >- @@ -803,17 +840,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_approval_requests_list: - operation: &ref_5 + organizations_approval_requests_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1approvalRequests/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.approvalRequests - organizations_approval_requests_list: - operation: *ref_5 - response: *ref_6 organizations_approval_requests_get: operation: $ref: >- @@ -858,10 +892,11 @@ components: #/components/x-stackQL-resources/approval_requests/methods/organizations_approval_requests_list insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/accessApprovalSettings: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -955,7 +990,7 @@ paths: schema: type: string /v1/projects/{projectsId}/serviceAccount: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Retrieves the service account that is used by Access Approval to access @@ -980,7 +1015,7 @@ paths: schema: type: string /v1/projects/{projectsId}/approvalRequests: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists approval requests associated with a project, folder, or @@ -1019,7 +1054,7 @@ paths: schema: type: string /v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets an approval request. Returns NOT_FOUND if the request does not @@ -1049,7 +1084,7 @@ paths: schema: type: string /v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:approve: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Approves a request and returns the updated ApprovalRequest. Returns @@ -1085,7 +1120,7 @@ paths: schema: type: string /v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:dismiss: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Dismisses a request. Returns the updated ApprovalRequest. NOTE: This @@ -1123,7 +1158,7 @@ paths: schema: type: string /v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:invalidate: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Invalidates an existing ApprovalRequest. Returns the updated @@ -1161,7 +1196,7 @@ paths: schema: type: string /v1/folders/{foldersId}/accessApprovalSettings: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets the settings associated with a project, folder, or organization. operationId: accessapproval.folders.getAccessApprovalSettings @@ -1244,7 +1279,7 @@ paths: schema: type: string /v1/folders/{foldersId}/serviceAccount: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Retrieves the service account that is used by Access Approval to access @@ -1269,7 +1304,7 @@ paths: schema: type: string /v1/folders/{foldersId}/approvalRequests: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists approval requests associated with a project, folder, or @@ -1308,7 +1343,7 @@ paths: schema: type: string /v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets an approval request. Returns NOT_FOUND if the request does not @@ -1338,7 +1373,7 @@ paths: schema: type: string /v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:approve: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Approves a request and returns the updated ApprovalRequest. Returns @@ -1374,7 +1409,7 @@ paths: schema: type: string /v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:dismiss: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Dismisses a request. Returns the updated ApprovalRequest. NOTE: This @@ -1412,7 +1447,7 @@ paths: schema: type: string /v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:invalidate: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Invalidates an existing ApprovalRequest. Returns the updated @@ -1450,7 +1485,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/accessApprovalSettings: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets the settings associated with a project, folder, or organization. operationId: accessapproval.organizations.getAccessApprovalSettings @@ -1533,7 +1568,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/serviceAccount: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Retrieves the service account that is used by Access Approval to access @@ -1558,7 +1593,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/approvalRequests: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists approval requests associated with a project, folder, or @@ -1597,7 +1632,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets an approval request. Returns NOT_FOUND if the request does not @@ -1627,7 +1662,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:approve: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Approves a request and returns the updated ApprovalRequest. Returns @@ -1663,7 +1698,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:dismiss: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Dismisses a request. Returns the updated ApprovalRequest. NOTE: This @@ -1701,7 +1736,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:invalidate: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Invalidates an existing ApprovalRequest. Returns the updated diff --git a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml index 91946546..1affe51f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/accesscontextmanager.yaml @@ -17,8 +17,8 @@ info: Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/access-context-manager/docs/reference/rest/ servers: @@ -183,8 +183,8 @@ components: properties: name: description: >- - Output only. Resource name of the `AccessPolicy`. Format: - `accessPolicies/{access_policy}` + Output only. Identifier. Resource name of the `AccessPolicy`. + Format: `accessPolicies/{access_policy}` type: string parent: description: >- @@ -216,9 +216,10 @@ components: description: >- Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, - meaning that two Access Polices will be identical if and only if + meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. + readOnly: true type: string ListAccessLevelsResponse: id: ListAccessLevelsResponse @@ -245,7 +246,7 @@ components: properties: name: description: >- - Resource name for the `AccessLevel`. Format: + Identifier. Resource name for the `AccessLevel`. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The `access_level` component must begin with a letter, followed by alphanumeric characters or `_`. Its maximum length is 50 characters. @@ -617,7 +618,7 @@ components: properties: name: description: >- - Resource name for the `ServicePerimeter`. Format: + Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a @@ -801,9 +802,10 @@ components: description: >- A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service - account, Google group, or third-party identity. The `v1` identities - that have the prefix `user`, `group`, `serviceAccount`, `principal`, - and `principalSet` in + account, Google group, or third-party identity. For third-party + identity, only single identities are supported and other identity + types are not supported. The `v1` identities that have the prefix + `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. type: array @@ -962,9 +964,11 @@ components: description: >- A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, - or third-party identity. The `v1` identities that have the prefix - `user`, `group`, `serviceAccount`, `principal`, and `principalSet` - in https://cloud.google.com/iam/docs/principal-identifiers#v1 are + or third-party identity. For third-party identity, only single + identities are supported and other identity types are not supported. + The `v1` identities that have the prefix `user`, `group`, + `serviceAccount`, and `principal` in + https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. type: array items: @@ -1217,6 +1221,23 @@ components: [documentation](https://cloud.google.com/vpc-service-controls/docs/supported-products) for details. type: boolean + serviceSupportStage: + description: The support stage of the service. + type: string + enumDescriptions: + - Do not use this default value. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + PREVIEW indicates a pre-release stage where the product is + functionally complete but undergoing real-world testing. + - Deprecated features are scheduled to be shut down and removed. + enum: + - SERVICE_SUPPORT_STAGE_UNSPECIFIED + - GA + - PREVIEW + - DEPRECATED ListGcpUserAccessBindingsResponse: id: ListGcpUserAccessBindingsResponse description: Response of ListGcpUserAccessBindings. @@ -1277,6 +1298,9 @@ components: type: array items: type: string + reauthSettings: + description: Optional. GCSL policy for the group key. + $ref: '#/components/schemas/ReauthSettings' restrictedClientApplications: description: >- Optional. A list of applications that are subject to this binding's @@ -1285,6 +1309,70 @@ components: type: array items: $ref: '#/components/schemas/Application' + scopedAccessSettings: + description: >- + Optional. A list of scoped access settings that set this binding's + restrictions on a subset of applications. This field cannot be set + if restricted_client_applications is set. + type: array + items: + $ref: '#/components/schemas/ScopedAccessSettings' + ReauthSettings: + id: ReauthSettings + description: >- + Stores settings related to Google Cloud Session Length including session + duration, the type of challenge (i.e. method) they should face when + their session expires, and other related settings. + type: object + properties: + reauthMethod: + description: Optional. Reauth method when users GCP session is up. + type: string + enumDescriptions: + - If method undefined in API, we will use LOGIN by default. + - >- + The user will prompted to perform regular login. Users who are + enrolled for two-step verification and haven't chosen to "Remember + this computer" will be prompted for their second factor. + - >- + The user will be prompted to autheticate using their security key. + If no security key has been configured, then we will fallback to + LOGIN. + - The user will be prompted for their password. + enum: + - REAUTH_METHOD_UNSPECIFIED + - LOGIN + - SECURITY_KEY + - PASSWORD + sessionLength: + description: >- + Optional. The session length. Setting this field to zero is equal to + disabling. Reauth. Also can set infinite session by flipping the + enabled bit to false below. If use_oidc_max_age is true, for OIDC + apps, the session length will be the minimum of this field and OIDC + max_age param. + type: string + format: google-duration + maxInactivity: + description: >- + Optional. How long a user is allowed to take between actions before + a new access token must be issued. Presently only set for Cloud + Apps. + type: string + format: google-duration + useOidcMaxAge: + description: >- + Optional. Only useful for OIDC apps. When false, the OIDC max_age + param, if passed in the authentication request will be ignored. When + true, the re-auth period will be the minimum of the session_length + field and the max_age OIDC param. + type: boolean + sessionLengthEnabled: + description: >- + Optional. Big red button to turn off GCSL. When false, all fields + set above will be disregarded and the session length is basically + infinite. + type: boolean Application: id: Application description: An application that accesses Google Cloud APIs. @@ -1296,6 +1384,68 @@ components: name: description: 'The name of the application. Example: "Cloud Console"' type: string + ScopedAccessSettings: + id: ScopedAccessSettings + description: A relationship between access settings and its scope. + type: object + properties: + scope: + description: >- + Optional. Application, etc. to which the access settings will be + applied to. Implicitly, this is the scoped access settings key; as + such, it must be unique and non-empty. + $ref: '#/components/schemas/AccessScope' + activeSettings: + description: >- + Optional. Access settings for this scoped access settings. This + field may be empty if dry_run_settings is set. + $ref: '#/components/schemas/AccessSettings' + dryRunSettings: + description: >- + Optional. Dry-run access settings for this scoped access settings. + This field may be empty if active_settings is set. + $ref: '#/components/schemas/AccessSettings' + AccessScope: + id: AccessScope + description: >- + Access scope represents the client scope, etc. to which the settings + will be applied to. + type: object + properties: + clientScope: + description: Optional. Client scope for this access scope. + $ref: '#/components/schemas/ClientScope' + ClientScope: + id: ClientScope + description: >- + Client scope represents the application, etc. subject to this binding's + restrictions. + type: object + properties: + restrictedClientApplication: + description: Optional. The application that is subject to this binding's scope. + $ref: '#/components/schemas/Application' + AccessSettings: + id: AccessSettings + description: >- + Access settings represent the set of conditions that must be met for + access to be granted. At least one of the fields must be set. + type: object + properties: + accessLevels: + description: >- + Optional. Access level that a user must have to be granted access. + Only one access level is supported, not multiple. This repeated + field must have exactly one element. Example: + "accessPolicies/9522/accessLevels/device_trusted" + type: array + items: + type: string + reauthSettings: + description: >- + Optional. Reauth settings applied to user access on a given + AccessScope. + $ref: '#/components/schemas/ReauthSettings' SetIamPolicyRequest: id: SetIamPolicyRequest description: Request message for `SetIamPolicy` method. @@ -1640,7 +1790,7 @@ components: properties: name: description: >- - Resource name for the `AuthorizedOrgsDesc`. Format: + Identifier. Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin with a letter, followed by alphanumeric characters or `_`. After you create an @@ -1838,16 +1988,13 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/get' @@ -1872,6 +2019,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' access_policies: @@ -1879,16 +2027,13 @@ components: name: access_policies title: Access_policies methods: - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1accessPolicies/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.accessPolicies - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: '#/paths/~1v1~1accessPolicies/post' @@ -1921,6 +2066,7 @@ components: - $ref: '#/components/x-stackQL-resources/access_policies/methods/create' update: - $ref: '#/components/x-stackQL-resources/access_policies/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete' access_policies_iam_policies: @@ -1934,16 +2080,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: '#/paths/~1v1~1accessPolicies~1{accessPoliciesId}:getIamPolicy/post' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: >- @@ -1957,22 +2100,22 @@ components: #/components/x-stackQL-resources/access_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/access_policies_iam_policies/methods/set_iam_policy delete: [] access_levels: id: google.accesscontextmanager.access_levels name: access_levels title: Access_levels methods: - _list: - operation: &ref_7 + list: + operation: $ref: '#/paths/~1v1~1accessPolicies~1{accessPoliciesId}~1accessLevels/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.accessLevels - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -2016,6 +2159,8 @@ components: - $ref: '#/components/x-stackQL-resources/access_levels/methods/create' update: - $ref: '#/components/x-stackQL-resources/access_levels/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/access_levels/methods/replace_all' delete: - $ref: '#/components/x-stackQL-resources/access_levels/methods/delete' access_levels_iam_policies: @@ -2034,23 +2179,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] service_perimeters: id: google.accesscontextmanager.service_perimeters name: service_perimeters title: Service_perimeters methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1accessPolicies~1{accessPoliciesId}~1servicePerimeters/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.servicePerimeters - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -2101,6 +2244,9 @@ components: - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/create' update: - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/patch' + replace: + - $ref: >- + #/components/x-stackQL-resources/service_perimeters/methods/replace_all delete: - $ref: '#/components/x-stackQL-resources/service_perimeters/methods/delete' service_perimeters_iam_policies: @@ -2119,23 +2265,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] authorized_orgs_descs: id: google.accesscontextmanager.authorized_orgs_descs name: authorized_orgs_descs title: Authorized_orgs_descs methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1accessPolicies~1{accessPoliciesId}~1authorizedOrgsDescs/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.authorizedOrgsDescs - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -2175,6 +2319,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/authorized_orgs_descs/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/authorized_orgs_descs/methods/delete @@ -2183,16 +2328,13 @@ components: name: services title: Services methods: - _list: - operation: &ref_13 + list: + operation: $ref: '#/paths/~1v1~1services/get' - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.supportedServices - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: '#/paths/~1v1~1services~1{name}/get' @@ -2205,23 +2347,21 @@ components: - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: [] update: [] + replace: [] delete: [] gcp_user_access_bindings: id: google.accesscontextmanager.gcp_user_access_bindings name: gcp_user_access_bindings title: Gcp_user_access_bindings methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1gcpUserAccessBindings/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.gcpUserAccessBindings - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -2262,12 +2402,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/gcp_user_access_bindings/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/gcp_user_access_bindings/methods/delete paths: /v1/operations: - parameters: &ref_17 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2311,7 +2452,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2362,7 +2503,7 @@ paths: schema: type: string /v1/operations/{operationsId}:cancel: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2399,7 +2540,7 @@ paths: schema: type: string /v1/accessPolicies: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists all access policies in an organization. operationId: accesscontextmanager.accessPolicies.list @@ -2456,7 +2597,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: [] /v1/accessPolicies/{accessPoliciesId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Returns an access policy based on the name. operationId: accesscontextmanager.accessPolicies.get @@ -2537,7 +2678,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}:setIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Sets the IAM policy for the specified Access Context Manager access @@ -2569,7 +2710,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}:getIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Gets the IAM policy for the specified Access Context Manager access @@ -2599,7 +2740,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns the IAM permissions that the caller has on the specified Access @@ -2631,7 +2772,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/accessLevels: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists all access levels for an access policy. operationId: accesscontextmanager.accessPolicies.accessLevels.list @@ -2697,7 +2838,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets an access level based on the resource name. operationId: accesscontextmanager.accessPolicies.accessLevels.get @@ -2798,7 +2939,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/accessLevels:replaceAll: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Replaces all existing access levels in an access policy with the access @@ -2835,7 +2976,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns the IAM permissions that the caller has on the specified Access @@ -2872,7 +3013,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/servicePerimeters: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists all service perimeters for an access policy. operationId: accesscontextmanager.accessPolicies.servicePerimeters.list @@ -2934,7 +3075,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets a service perimeter based on the resource name. operationId: accesscontextmanager.accessPolicies.servicePerimeters.get @@ -3031,7 +3172,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/servicePerimeters:replaceAll: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Replace all existing service perimeters in an access policy with the @@ -3067,7 +3208,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/servicePerimeters:commit: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Commits the dry-run specification for all the service perimeters in an @@ -3107,7 +3248,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns the IAM permissions that the caller has on the specified Access @@ -3144,7 +3285,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/authorizedOrgsDescs: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists all authorized orgs descs for an access policy. operationId: accesscontextmanager.accessPolicies.authorizedOrgsDescs.list @@ -3207,7 +3348,7 @@ paths: schema: type: string /v1/accessPolicies/{accessPoliciesId}/authorizedOrgsDescs/{authorizedOrgsDescsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets an authorized orgs desc based on the resource name. operationId: accesscontextmanager.accessPolicies.authorizedOrgsDescs.get @@ -3307,7 +3448,7 @@ paths: schema: type: string /v1/services: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists all VPC-SC supported services. operationId: accesscontextmanager.services.list @@ -3334,7 +3475,7 @@ paths: schema: type: string /v1/services/{name}: - parameters: *ref_17 + parameters: *ref_1 get: description: Returns a VPC-SC supported service based on the service name. operationId: accesscontextmanager.services.get @@ -3357,7 +3498,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/gcpUserAccessBindings: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists all GcpUserAccessBindings for a Google Cloud organization. operationId: accesscontextmanager.organizations.gcpUserAccessBindings.list @@ -3420,7 +3561,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/gcpUserAccessBindings/{gcpUserAccessBindingsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets the GcpUserAccessBinding with the given name. operationId: accesscontextmanager.organizations.gcpUserAccessBindings.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml index 4666fd88..59e16ce9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/addressvalidation.yaml @@ -11,8 +11,8 @@ info: the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address. version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240911' + x-generated-date: '2024-09-13' externalDocs: url: https://developers.google.com/maps/documentation/addressvalidation servers: @@ -26,12 +26,12 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/maps-platform.addressvalidation: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.addressvalidation https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. + https://www.googleapis.com/auth/maps-platform.addressvalidation: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.addressvalidation Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -41,207 +41,23 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: - type: object - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse - properties: {} - description: >- - The response for validation feedback. The response is empty if the - feedback is sent successfully. - GoogleGeoTypeViewport: - description: >- - A latitude-longitude viewport, represented as two diagonally opposite - `low` and `high` points. A viewport is considered a closed region, i.e. - it includes its boundary. The latitude bounds must range between -90 to - 90 degrees inclusive, and the longitude bounds must range between -180 - to 180 degrees inclusive. Various cases include: - If `low` = `high`, - the viewport consists of that single point. - If `low.longitude` > - `high.longitude`, the longitude range is inverted (the viewport crosses - the 180 degree longitude line). - If `low.longitude` = -180 degrees and - `high.longitude` = 180 degrees, the viewport includes all longitudes. - - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, - the longitude range is empty. - If `low.latitude` > `high.latitude`, the - latitude range is empty. Both `low` and `high` must be populated, and - the represented box cannot be empty (as specified by the definitions - above). An empty viewport will result in an error. For example, this - viewport fully encloses New York City: { "low": { "latitude": 40.477398, - "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": - -73.70018 } } - properties: - high: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: Required. The high point of the viewport. - low: - description: Required. The low point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' - id: GoogleGeoTypeViewport - type: object - GoogleMapsAddressvalidationV1AddressComponent: - id: GoogleMapsAddressvalidationV1AddressComponent - properties: - spellCorrected: - type: boolean - description: >- - Indicates a correction to a misspelling in the component name. The - API does not always flag changes from one spelling variant to - another, such as when changing "centre" to "center". It also does - not always flag common misspellings, such as when changing - "Amphitheater Pkwy" to "Amphitheatre Pkwy". - confirmationLevel: - enum: - - CONFIRMATION_LEVEL_UNSPECIFIED - - CONFIRMED - - UNCONFIRMED_BUT_PLAUSIBLE - - UNCONFIRMED_AND_SUSPICIOUS - enumDescriptions: - - Default value. This value is unused. - - >- - We were able to verify that this component exists and makes sense - in the context of the rest of the address. - - >- - This component could not be confirmed, but it is plausible that it - exists. For example, a street number within a known valid range of - numbers on a street where specific house numbers are not known. - - >- - This component was not confirmed and is likely to be wrong. For - example, a neighborhood that does not fit the rest of the address. - description: >- - Indicates the level of certainty that we have that the component is - correct. - type: string - inferred: - type: boolean - description: >- - Indicates that the component was not part of the input, but we - inferred it for the address location and believe it should be - provided for a complete address. - replaced: - description: >- - Indicates the name of the component was replaced with a completely - different one, for example a wrong postal code being replaced with - one that is correct for the address. This is not a cosmetic change, - the input component has been changed to a different one. - type: boolean - unexpected: - type: boolean - description: >- - Indicates an address component that is not expected to be present in - a postal address for the given region. We have retained it only - because it was part of the input. - componentName: - description: The name for this component. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' - componentType: - description: >- - The type of the address component. See [Table 2: Additional types - returned by the Places - service](https://developers.google.com/places/web-service/supported_types#table2) - for a list of possible types. - type: string - type: object - description: Represents an address component, such as a street, city, or state. - GoogleMapsAddressvalidationV1AddressMetadata: - id: GoogleMapsAddressvalidationV1AddressMetadata - properties: - residential: - type: boolean - description: >- - Indicates that this is the address of a residence. If unset, - indicates that the value is unknown. - poBox: - type: boolean - description: >- - Indicates that the address of a PO box. If unset, indicates that the - value is unknown. - business: - type: boolean - description: >- - Indicates that this is the address of a business. If unset, - indicates that the value is unknown. - description: >- - The metadata for the address. `metadata` is not guaranteed to be fully - populated for every address sent to the Address Validation API. - type: object - GoogleMapsAddressvalidationV1PlusCode: - type: object - description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. + GoogleMapsAddressvalidationV1ValidateAddressResponse: + description: The response to an address validation request. properties: - compoundCode: + result: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' + description: The result of the address validation. + responseId: description: >- - Place's compound code, such as "33GV+HQ, Ramberg, Norway", - containing the suffix of the global code and replacing the prefix - with a formatted name of a reference entity. - type: string - globalCode: + The UUID that identifies this response. If the address needs to be + re-validated, this UUID *must* accompany the new request. type: string - description: >- - Place's global (full) code, such as "9FWM33GV+HQ", representing an - 1/8000 by 1/8000 degree area (~14 by 14 meters). - id: GoogleMapsAddressvalidationV1PlusCode - GoogleMapsAddressvalidationV1ValidationResult: - description: The result of validating an address. + id: GoogleMapsAddressvalidationV1ValidateAddressResponse type: object - id: GoogleMapsAddressvalidationV1ValidationResult - properties: - uspsData: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' - description: >- - Extra deliverability flags provided by USPS. Only provided in region - `US` and `PR`. - verdict: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' - description: Overall verdict flags - metadata: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressMetadata' - description: >- - Other information relevant to deliverability. `metadata` is not - guaranteed to be fully populated for every address sent to the - Address Validation API. - geocode: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' - description: >- - Information about the location and place that the address geocoded - to. - englishLatinAddress: - description: >- - Preview: This feature is in Preview (pre-GA). Pre-GA products and - features might have limited support, and changes to pre-GA products - and features might not be compatible with other pre-GA versions. - Pre-GA Offerings are covered by the [Google Maps Platform Service - Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). The - address translated to English. Translated addresses are not reusable - as API input. The service provides them so that the user can use - their native language to confirm or deny the validation of the - originally-provided address. If part of the address doesn't have an - English translation, the service returns that part in an alternate - language that uses a Latin script. See - [here](https://developers.google.com/maps/documentation/address-validation/convert-addresses-english) - for an explanation of how the alternate language is selected. If - part of the address doesn't have any translations or - transliterations in a language that uses a Latin script, the service - returns that part in the local language associated with the address. - Enable this output by using the - [google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address] - flag. Note: the - [google.maps.addressvalidation.v1.Address.unconfirmed_component_types] - field in the `english_latin_address` and the - [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] - fields in `english_latin_address.address_components` are not - populated. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' - address: - description: Information about the address itself as opposed to the geocode. - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' GoogleMapsAddressvalidationV1ValidateAddressRequest: properties: sessionToken: + type: string description: >- Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with @@ -261,6 +77,14 @@ components: API, not the Autocomplete API. See https://developers.google.com/maps/documentation/places/web-service/session-pricing for more details. + previousResponseId: + description: >- + This field must be empty for the first address validation request. + If more requests are necessary to fully validate a single address + (for example if the changes the user makes after the initial + validation need to be re-validated), then each followup request must + populate this field with the response_id from the very first + response in the validation sequence. type: string languageOptions: $ref: '#/components/schemas/GoogleMapsAddressvalidationV1LanguageOptions' @@ -275,15 +99,21 @@ components: descriptions](https://developers.google.com/maps/launch-stages). Enables the Address Validation API to include additional information in the response. - previousResponseId: + enableUspsCass: + type: boolean description: >- - This field must be empty for the first address validation request. - If more requests are necessary to fully validate a single address - (for example if the changes the user makes after the initial - validation need to be re-validated), then each followup request must - populate this field with the response_id from the very first - response in the validation sequence. - type: string + Enables USPS CASS compatible mode. This affects _only_ the + [google.maps.addressvalidation.v1.ValidationResult.usps_data] field + of [google.maps.addressvalidation.v1.ValidationResult]. Note: for + USPS CASS enabled requests for addresses in Puerto Rico, a + [google.type.PostalAddress.region_code] of the `address` must be + provided as "PR", or an + [google.type.PostalAddress.administrative_area] of the `address` + must be provided as "Puerto Rico" (case-insensitive) or "PR". It's + recommended to use a componentized `address`, or alternatively + specify at least two [google.type.PostalAddress.address_lines] where + the first line contains the street number and name and the second + line contains the city, state, and zip code. address: $ref: '#/components/schemas/GoogleTypePostalAddress' description: >- @@ -298,231 +128,638 @@ components: identified by the system. The Address Validation API ignores the values in recipients and organization. Any values in those fields will be discarded and not returned. Please do not set them. - enableUspsCass: - description: >- - Enables USPS CASS compatible mode. This affects _only_ the - [google.maps.addressvalidation.v1.ValidationResult.usps_data] field - of [google.maps.addressvalidation.v1.ValidationResult]. Note: for - USPS CASS enabled requests for addresses in Puerto Rico, a - [google.type.PostalAddress.region_code] of the `address` must be - provided as "PR", or an - [google.type.PostalAddress.administrative_area] of the `address` - must be provided as "Puerto Rico" (case-insensitive) or "PR". It's - recommended to use a componentized `address`, or alternatively - specify at least two [google.type.PostalAddress.address_lines] where - the first line contains the street number and name and the second - line contains the city, state, and zip code. - type: boolean id: GoogleMapsAddressvalidationV1ValidateAddressRequest - description: The request for validating an address. type: object - GoogleMapsAddressvalidationV1Verdict: - description: High level overview of the address validation result and geocode. - id: GoogleMapsAddressvalidationV1Verdict + description: The request for validating an address. + GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: type: object + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest properties: - addressComplete: - type: boolean - description: >- - The address is considered complete if there are no unresolved - tokens, no unexpected or missing address components. If unset, - indicates that the value is `false`. See `missing_component_types`, - `unresolved_tokens` or `unexpected` fields for more details. - hasUnconfirmedComponents: - type: boolean - description: >- - At least one address component cannot be categorized or validated, - see [google.maps.addressvalidation.v1.Address.address_components] - for details. - validationGranularity: - description: >- - The granularity level that the API can fully **validate** the - address to. For example, an `validation_granularity` of `PREMISE` - indicates all address components at the level of `PREMISE` or more - coarse can be validated. Per address component validation result can - be found in - [google.maps.addressvalidation.v1.Address.address_components]. + conclusion: enumDescriptions: - - Default value. This value is unused. - - Below-building level result, such as an apartment. - - Building-level result. - >- - A geocode that approximates the building-level location of the - address. + This value is unused. If the + `ProvideValidationFeedbackRequest.conclusion` field is set to + `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error + will be returned. - >- - The address or geocode indicates a block. Only used in regions - which have block-level addressing, such as Japan. + The version of the address returned by the Address Validation API + was used for the transaction. - >- - The geocode or address is granular to route, such as a street, - road, or highway. + The version of the address provided by the user was used for the + transaction - >- - All other granularities, which are bucketed together since they - are not deliverable. + A version of the address that was entered after the last + validation attempt but that was not re-validated was used for the + transaction. + - The transaction was abandoned and the address was not used. + description: >- + Required. The outcome of the sequence of validation attempts. If + this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an + `INVALID_ARGUMENT` error will be returned. enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER + - VALIDATION_CONCLUSION_UNSPECIFIED + - VALIDATED_VERSION_USED + - USER_VERSION_USED + - UNVALIDATED_VERSION_USED + - UNUSED + type: string + responseId: type: string - hasInferredComponents: - description: >- - At least one address component was inferred (added) that wasn't in - the input, see - [google.maps.addressvalidation.v1.Address.address_components] for - details. - type: boolean - hasReplacedComponents: - type: boolean description: >- - At least one address component was replaced, see - [google.maps.addressvalidation.v1.Address.address_components] for - details. - inputGranularity: - enumDescriptions: - - Default value. This value is unused. - - Below-building level result, such as an apartment. - - Building-level result. - - >- - A geocode that approximates the building-level location of the - address. - - >- - The address or geocode indicates a block. Only used in regions - which have block-level addressing, such as Japan. - - >- - The geocode or address is granular to route, such as a street, - road, or highway. - - >- - All other granularities, which are bucketed together since they - are not deliverable. + Required. The ID of the response that this feedback is for. This + should be the response_id from the first response in a series of + address validation attempts. + description: The request for sending validation feedback. + GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse: + description: >- + The response for validation feedback. The response is empty if the + feedback is sent successfully. + properties: {} + type: object + id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse + GoogleMapsAddressvalidationV1AddressComponent: + properties: + componentType: description: >- - The granularity of the **input** address. This is the result of - parsing the input address and does not give any validation signals. - For validation signals, refer to `validation_granularity` below. For - example, if the input address includes a specific apartment number, - then the `input_granularity` here will be `SUB_PREMISE`. If we - cannot match the apartment number in the databases or the apartment - number is invalid, the `validation_granularity` will likely be - `PREMISE` or below. + The type of the address component. See [Table 2: Additional types + returned by the Places + service](https://developers.google.com/places/web-service/supported_types#table2) + for a list of possible types. type: string - enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER - geocodeGranularity: + replaced: + type: boolean description: >- - Information about the granularity of the `geocode`. This can be - understood as the semantic meaning of how coarse or fine the - geocoded location is. This can differ from the - `validation_granularity` above occasionally. For example, our - database might record the existence of an apartment number but do - not have a precise location for the apartment within a big apartment - complex. In that case, the `validation_granularity` will be - `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. - enum: - - GRANULARITY_UNSPECIFIED - - SUB_PREMISE - - PREMISE - - PREMISE_PROXIMITY - - BLOCK - - ROUTE - - OTHER + Indicates the name of the component was replaced with a completely + different one, for example a wrong postal code being replaced with + one that is correct for the address. This is not a cosmetic change, + the input component has been changed to a different one. + confirmationLevel: enumDescriptions: - Default value. This value is unused. - - Below-building level result, such as an apartment. - - Building-level result. - - >- - A geocode that approximates the building-level location of the - address. - >- - The address or geocode indicates a block. Only used in regions - which have block-level addressing, such as Japan. + We were able to verify that this component exists and makes sense + in the context of the rest of the address. - >- - The geocode or address is granular to route, such as a street, - road, or highway. + This component could not be confirmed, but it is plausible that it + exists. For example, a street number within a known valid range of + numbers on a street where specific house numbers are not known. - >- - All other granularities, which are bucketed together since they - are not deliverable. + This component was not confirmed and is likely to be wrong. For + example, a neighborhood that does not fit the rest of the address. + enum: + - CONFIRMATION_LEVEL_UNSPECIFIED + - CONFIRMED + - UNCONFIRMED_BUT_PLAUSIBLE + - UNCONFIRMED_AND_SUSPICIOUS type: string - GoogleMapsAddressvalidationV1UspsData: + description: >- + Indicates the level of certainty that we have that the component is + correct. + unexpected: + description: >- + Indicates an address component that is not expected to be present in + a postal address for the given region. We have retained it only + because it was part of the input. + type: boolean + spellCorrected: + type: boolean + description: >- + Indicates a correction to a misspelling in the component name. The + API does not always flag changes from one spelling variant to + another, such as when changing "centre" to "center". It also does + not always flag common misspellings, such as when changing + "Amphitheater Pkwy" to "Amphitheatre Pkwy". + inferred: + description: >- + Indicates that the component was not part of the input, but we + inferred it for the address location and believe it should be + provided for a complete address. + type: boolean + componentName: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ComponentName' + description: The name for this component. + description: Represents an address component, such as a street, city, or state. + type: object + id: GoogleMapsAddressvalidationV1AddressComponent + GoogleTypeLatLng: + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. type: object - id: GoogleMapsAddressvalidationV1UspsData properties: - dpvConfirmation: - description: >- - The possible values for DPV confirmation. Returns a single character - or returns no value. * `N`: Primary and any secondary number - information failed to DPV confirm. * `D`: Address was DPV confirmed - for the primary number only, and the secondary number information - was missing. * `S`: Address was DPV confirmed for the primary number - only, and the secondary number information was present but not - confirmed. * `Y`: Address was DPV confirmed for primary and any - secondary numbers. * Empty: If the response does not contain a - `dpv_confirmation` value, the address was not submitted for DPV - confirmation. + longitude: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + type: number + format: double + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + format: double + type: number + id: GoogleTypeLatLng + GoogleMapsAddressvalidationV1UspsAddress: + id: GoogleMapsAddressvalidationV1UspsAddress + type: object + properties: + state: + description: 2 letter state code. type: string - postOfficeCity: + city: type: string - description: Main post office city. - lacsLinkIndicator: + description: City name. + secondAddressLine: type: string - description: LACSLink indicator. - cassProcessed: - description: Indicator that the request has been CASS processed. - type: boolean - dpvFootnote: + description: Second address line. + urbanization: type: string + description: Puerto Rican urbanization name. + cityStateZipAddressLine: + type: string + description: City + state + postal code. + firstAddressLine: + type: string + description: First address line. + zipCode: + type: string + description: Postal code e.g. 10009. + zipCodeExtension: + description: 4-digit postal code extension e.g. 5023. + type: string + firm: + type: string + description: Firm name. + description: USPS representation of a US address. + GoogleTypePostalAddress: + id: GoogleTypePostalAddress + properties: + sublocality: + type: string + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + revision: + format: int32 + type: integer + description: >- + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + recipients: + type: array + items: + type: string + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. + locality: + description: >- + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. + type: string + postalCode: + description: >- + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). + type: string + regionCode: + description: >- + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + type: string + addressLines: + type: array + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for + large-to-small ordering and "ja-Latn" or "en" for small-to-large). + This way, the most specific line of an address can be selected based + on the language. The minimum permitted structural representation of + an address consists of a region_code with all remaining information + placed in the address_lines. It would be possible to format such an + address very approximately without geocoding, but no semantic + reasoning could be made about any of the address components until it + was at least partially resolved. Creating an address only containing + a region_code and address_lines, and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + items: + type: string + languageCode: + type: string + description: >- + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + sortingCode: + type: string + description: >- + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). + administrativeArea: + description: >- + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (e.g. + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. E.g. in Switzerland this + should be left unpopulated. + type: string + organization: + description: Optional. The name of the organization at the address. + type: string + type: object + description: >- + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + GoogleMapsAddressvalidationV1ValidationResult: + description: The result of validating an address. + type: object + properties: + verdict: + description: Overall verdict flags + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Verdict' + address: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + description: Information about the address itself as opposed to the geocode. + uspsData: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsData' + description: >- + Extra deliverability flags provided by USPS. Only provided in region + `US` and `PR`. + metadata: + description: >- + Other information relevant to deliverability. `metadata` is not + guaranteed to be fully populated for every address sent to the + Address Validation API. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1AddressMetadata' + englishLatinAddress: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Address' + description: >- + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products + and features might not be compatible with other pre-GA versions. + Pre-GA Offerings are covered by the [Google Maps Platform Service + Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). The + address translated to English. Translated addresses are not reusable + as API input. The service provides them so that the user can use + their native language to confirm or deny the validation of the + originally-provided address. If part of the address doesn't have an + English translation, the service returns that part in an alternate + language that uses a Latin script. See + [here](https://developers.google.com/maps/documentation/address-validation/convert-addresses-english) + for an explanation of how the alternate language is selected. If + part of the address doesn't have any translations or + transliterations in a language that uses a Latin script, the service + returns that part in the local language associated with the address. + Enable this output by using the + [google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address] + flag. Note: the + [google.maps.addressvalidation.v1.Address.unconfirmed_component_types] + field in the `english_latin_address` and the + [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] + fields in `english_latin_address.address_components` are not + populated. + geocode: + description: >- + Information about the location and place that the address geocoded + to. + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1Geocode' + id: GoogleMapsAddressvalidationV1ValidationResult + GoogleMapsAddressvalidationV1AddressMetadata: + id: GoogleMapsAddressvalidationV1AddressMetadata + properties: + residential: + description: >- + Indicates that this is the address of a residence. If unset, + indicates that the value is unknown. + type: boolean + business: + description: >- + Indicates that this is the address of a business. If unset, + indicates that the value is unknown. + type: boolean + poBox: + type: boolean + description: >- + Indicates that the address of a PO box. If unset, indicates that the + value is unknown. + description: >- + The metadata for the address. `metadata` is not guaranteed to be fully + populated for every address sent to the Address Validation API. + type: object + GoogleMapsAddressvalidationV1Verdict: + description: High level overview of the address validation result and geocode. + type: object + id: GoogleMapsAddressvalidationV1Verdict + properties: + validationGranularity: + description: >- + The granularity level that the API can fully **validate** the + address to. For example, an `validation_granularity` of `PREMISE` + indicates all address components at the level of `PREMISE` or more + coarse can be validated. Per address component validation result can + be found in + [google.maps.addressvalidation.v1.Address.address_components]. + type: string + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + enumDescriptions: + - Default value. This value is unused. + - Below-building level result, such as an apartment. + - Building-level result. + - >- + A geocode that approximates the building-level location of the + address. + - >- + The address or geocode indicates a block. Only used in regions + which have block-level addressing, such as Japan. + - >- + The geocode or address is granular to route, such as a street, + road, or highway. + - >- + All other granularities, which are bucketed together since they + are not deliverable. + hasInferredComponents: + type: boolean + description: >- + At least one address component was inferred (added) that wasn't in + the input, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. + inputGranularity: + type: string + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + enumDescriptions: + - Default value. This value is unused. + - Below-building level result, such as an apartment. + - Building-level result. + - >- + A geocode that approximates the building-level location of the + address. + - >- + The address or geocode indicates a block. Only used in regions + which have block-level addressing, such as Japan. + - >- + The geocode or address is granular to route, such as a street, + road, or highway. + - >- + All other granularities, which are bucketed together since they + are not deliverable. + description: >- + The granularity of the **input** address. This is the result of + parsing the input address and does not give any validation signals. + For validation signals, refer to `validation_granularity` below. For + example, if the input address includes a specific apartment number, + then the `input_granularity` here will be `SUB_PREMISE`. If we + cannot match the apartment number in the databases or the apartment + number is invalid, the `validation_granularity` will likely be + `PREMISE` or below. + geocodeGranularity: + type: string + enumDescriptions: + - Default value. This value is unused. + - Below-building level result, such as an apartment. + - Building-level result. + - >- + A geocode that approximates the building-level location of the + address. + - >- + The address or geocode indicates a block. Only used in regions + which have block-level addressing, such as Japan. + - >- + The geocode or address is granular to route, such as a street, + road, or highway. + - >- + All other granularities, which are bucketed together since they + are not deliverable. + enum: + - GRANULARITY_UNSPECIFIED + - SUB_PREMISE + - PREMISE + - PREMISE_PROXIMITY + - BLOCK + - ROUTE + - OTHER + description: >- + Information about the granularity of the `geocode`. This can be + understood as the semantic meaning of how coarse or fine the + geocoded location is. This can differ from the + `validation_granularity` above occasionally. For example, our + database might record the existence of an apartment number but do + not have a precise location for the apartment within a big apartment + complex. In that case, the `validation_granularity` will be + `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`. + hasReplacedComponents: + type: boolean + description: >- + At least one address component was replaced, see + [google.maps.addressvalidation.v1.Address.address_components] for + details. + hasUnconfirmedComponents: + description: >- + At least one address component cannot be categorized or validated, + see [google.maps.addressvalidation.v1.Address.address_components] + for details. + type: boolean + addressComplete: + type: boolean + description: >- + The address is considered complete if there are no unresolved + tokens, no unexpected or missing address components. If unset, + indicates that the value is `false`. See `missing_component_types`, + `unresolved_tokens` or `unexpected` fields for more details. + GoogleMapsAddressvalidationV1PlusCode: + description: >- + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. + properties: + globalCode: + description: >- + Place's global (full) code, such as "9FWM33GV+HQ", representing an + 1/8000 by 1/8000 degree area (~14 by 14 meters). + type: string + compoundCode: + type: string + description: >- + Place's compound code, such as "33GV+HQ, Ramberg, Norway", + containing the suffix of the global code and replacing the prefix + with a formatted name of a reference entity. + type: object + id: GoogleMapsAddressvalidationV1PlusCode + GoogleMapsAddressvalidationV1Geocode: + description: Contains information about the place the input was geocoded to. + id: GoogleMapsAddressvalidationV1Geocode + properties: + location: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: >- + The geocoded location of the input. Using place IDs is preferred + over using addresses, latitude/longitude coordinates, or plus codes. + Using coordinates when routing or calculating driving directions + will always result in the point being snapped to the road nearest to + those coordinates. This may not be a road that will quickly or + safely lead to the destination and may not be near an access point + to the property. Additionally, when a location is reverse geocoded, + there is no guarantee that the returned address will match the + original. + placeId: + description: >- + The PlaceID of the place this input geocodes to. For more + information about Place IDs see + [here](https://developers.google.com/maps/documentation/places/web-service/place-id). + type: string + bounds: + description: The bounds of the geocoded place. + $ref: '#/components/schemas/GoogleGeoTypeViewport' + plusCode: + $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' + description: The plus code corresponding to the `location`. + placeTypes: description: >- - The footnotes from delivery point validation. Multiple footnotes may - be strung together in the same string. * `AA`: Input address matched - to the ZIP+4 file * `A1`: Input address was not matched to the ZIP+4 - file * `BB`: Matched to DPV (all components) * `CC`: Secondary - number not matched and not required * `C1`: Secondary number not - matched but required * `N1`: High-rise address missing secondary - number * `M1`: Primary number missing * `M3`: Primary number invalid - * `P1`: Input address PO, RR or HC box number missing * `P3`: Input - address PO, RR, or HC Box number invalid * `F1`: Input address - matched to a military address * `G1`: Input address matched to a - general delivery address * `U1`: Input address matched to a unique - ZIP code * `PB`: Input address matched to PBSA record * `RR`: DPV - confirmed address with PMB information * `R1`: DPV confirmed address - without PMB information * `R7`: Carrier Route R777 or R779 record * - `IA`: Informed Address identified * `TA`: Primary number matched by - dropping a trailing alpha - dpvNonDeliveryDaysValues: - format: int32 - type: integer + The type(s) of place that the input geocoded to. For example, + `['locality', 'political']`. The full list of types can be found + [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + type: array + items: + type: string + featureSizeMeters: + type: number description: >- - Integer identifying non-delivery days. It can be interrogated using - bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a - non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – - Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery - day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a - non-delivery day - dpvPbsa: + The size of the geocoded place, in meters. This is another measure + of the coarseness of the geocoded location, but in physical size + rather than in semantic meaning. + format: float + type: object + GoogleMapsAddressvalidationV1ComponentName: + id: GoogleMapsAddressvalidationV1ComponentName + description: A wrapper for the name of the component. + type: object + properties: + languageCode: + type: string description: >- - Indicates the address was matched to PBSA record. Returns a single - character. * `Y`: The address was matched to PBSA record. * `N`: The - address was not matched to PBSA record. + The BCP-47 language code. This will not be present if the component + name is not associated with a language, such as a street number. + text: type: string - suitelinkFootnote: + description: >- + The name text. For example, "5th Avenue" for a street name or "1253" + for a street number. + GoogleGeoTypeViewport: + properties: + high: + description: Required. The high point of the viewport. + $ref: '#/components/schemas/GoogleTypeLatLng' + low: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: Required. The low point of the viewport. + id: GoogleGeoTypeViewport + type: object + description: >- + A latitude-longitude viewport, represented as two diagonally opposite + `low` and `high` points. A viewport is considered a closed region, i.e. + it includes its boundary. The latitude bounds must range between -90 to + 90 degrees inclusive, and the longitude bounds must range between -180 + to 180 degrees inclusive. Various cases include: - If `low` = `high`, + the viewport consists of that single point. - If `low.longitude` > + `high.longitude`, the longitude range is inverted (the viewport crosses + the 180 degree longitude line). - If `low.longitude` = -180 degrees and + `high.longitude` = 180 degrees, the viewport includes all longitudes. - + If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, + the longitude range is empty. - If `low.latitude` > `high.latitude`, the + latitude range is empty. Both `low` and `high` must be populated, and + the represented box cannot be empty (as specified by the definitions + above). An empty viewport will result in an error. For example, this + viewport fully encloses New York City: { "low": { "latitude": 40.477398, + "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": + -73.70018 } } + GoogleMapsAddressvalidationV1UspsData: + description: >- + The USPS data for the address. `uspsData` is not guaranteed to be fully + populated for every US or PR address sent to the Address Validation API. + It's recommended to integrate the backup address fields in the response + if you utilize uspsData as the primary part of the response. + id: GoogleMapsAddressvalidationV1UspsData + type: object + properties: + elotNumber: type: string + description: Enhanced Line of Travel (eLOT) number. + suitelinkFootnote: description: >- Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned. * `A`: SuiteLink record match, business address improved. * `00`: No match, business address is not improved. + type: string carrierRouteIndicator: description: Carrier route rate sort indicator. type: string - addressRecordType: + dpvNoStat: + type: string + description: >- + Is this a no stat address or an active address? No stat addresses + are ones which are not continuously occupied or addresses that the + USPS does not service. Returns a single character. * `Y`: The + address is not active * `N`: The address is active + county: type: string + description: County name. + addressRecordType: description: >- Type of the address record that matches the input address. * `F`: FIRM. This is a match to a Firm Record, which is the finest level of @@ -534,105 +771,23 @@ components: Highway Contract record, both of which may have associated Box Number ranges. * `S`: STREET RECORD: This is a match to a Street record containing a valid primary number range. - dpvVacant: - description: >- - Is this place vacant? Returns a single character. * `Y`: The address - is vacant * `N`: The address is not vacant - type: string - errorMessage: - type: string - description: >- - Error message for USPS data retrieval. This is populated when USPS - processing is suspended because of the detection of artificially - created addresses. The USPS data fields might not be populated when - this error is present. - deliveryPointCode: - type: string - description: 2 digit delivery point code - deliveryPointCheckDigit: - type: string - description: >- - The delivery point check digit. This number is added to the end of - the delivery_point_barcode for mechanically scanned mail. Adding all - the digits of the delivery_point_barcode, - delivery_point_check_digit, postal code, and ZIP+4 together should - yield a number divisible by 10. - elotFlag: - type: string - description: eLOT Ascending/Descending Flag (A/D). - dpvDrop: - description: >- - Flag indicates mail is delivered to a single receptable at a site. - Returns a single character. * `Y`: The mail is delivered to a single - receptable at a site. * `N`: The mail is not delivered to a single - receptable at a site. - type: string - dpvNoSecureLocation: type: string - description: >- - Flag indicates door is accessible, but package will not be left due - to security concerns. Returns a single character. * `Y`: The package - will not be left due to security concerns. * `N`: No indication the - package will not be left due to security concerns. - pmbDesignator: + abbreviatedCity: type: string - description: PMB (Private Mail Box) unit designator. - dpvNoStat: + description: Abbreviated city. + fipsCountyCode: + description: FIPS county code. type: string - description: >- - Is this a no stat address or an active address? No stat addresses - are ones which are not continuously occupied or addresses that the - USPS does not service. Returns a single character. * `Y`: The - address is not active * `N`: The address is active standardizedAddress: description: USPS standardized address. $ref: '#/components/schemas/GoogleMapsAddressvalidationV1UspsAddress' - postOfficeState: - description: Main post office state. - type: string - fipsCountyCode: - description: FIPS county code. - type: string - county: - description: County name. - type: string - elotNumber: - description: Enhanced Line of Travel (eLOT) number. - type: string - lacsLinkReturnCode: - description: LACSLink return code. - type: string - dpvEnhancedDeliveryCode: - description: >- - Indicates that more than one DPV return code is valid for the - address. Returns a single character. * `Y`: Address was DPV - confirmed for primary and any secondary numbers. * `N`: Primary and - any secondary number information failed to DPV confirm. * `S`: - Address was DPV confirmed for the primary number only, and the - secondary number information was present by not confirmed, or a - single trailing alpha on a primary number was dropped to make a DPV - match and secondary information required. * `D`: Address was DPV - confirmed for the primary number only, and the secondary number - information was missing. * `R`: Address confirmed but assigned to - phantom route R777 and R779 and USPS delivery is not provided. - type: string - pmbNumber: - type: string - description: PMB (Private Mail Box) number; - abbreviatedCity: - description: Abbreviated city. - type: string - ewsNoMatch: + dpvNonDeliveryDays: description: >- - The delivery address is matchable, but the EWS file indicates that - an exact match will be available soon. - type: boolean - dpvThrowback: + Flag indicates mail delivery is not performed every day of the week. + Returns a single character. * `Y`: The mail delivery is not + performed every day of the week. * `N`: No indication the mail + delivery is not performed every day of the week. type: string - description: >- - Indicates that mail is not delivered to the street address. Returns - a single character. * `Y`: The mail is not delivered to the street - address. * `N`: The mail is delivered to the street address. carrierRoute: type: string description: >- @@ -641,14 +796,13 @@ components: Carrier route (or city route) * `R`: Rural route * `H`: Highway Contract Route * `B`: Post Office Box Section * `G`: General delivery unit - dpvCmra: - type: string + defaultAddress: description: >- - Indicates if the address is a CMRA (Commercial Mail Receiving - Agency)--a private business receiving mail for clients. Returns a - single character. * `Y`: The address is a CMRA * `N`: The address is - not a CMRA + Indicator that a default address was found, but more specific + addresses exists. + type: boolean dpvNoStatReasonCode: + type: integer description: >- Indicates the NoStat type. Returns a reason code as int. * `1`: IDA (Internal Drop Address) – Addresses that do not receive mail @@ -662,267 +816,184 @@ components: Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries. * `6`: Secondary Required - The address requires secondary information. - type: integer format: int32 - dpvNonDeliveryDays: - type: string - description: >- - Flag indicates mail delivery is not performed every day of the week. - Returns a single character. * `Y`: The mail delivery is not - performed every day of the week. * `N`: No indication the mail - delivery is not performed every day of the week. - defaultAddress: - type: boolean - description: >- - Indicator that a default address was found, but more specific - addresses exists. - poBoxOnlyPostalCode: - description: PO Box only postal code. - type: boolean - dpvDoorNotAccessible: - type: string - description: >- - Flag indicates addresses where USPS cannot knock on a door to - deliver mail. Returns a single character. * `Y`: The door is not - accessible. * `N`: No indication the door is not accessible. - description: >- - The USPS data for the address. `uspsData` is not guaranteed to be fully - populated for every US or PR address sent to the Address Validation API. - It's recommended to integrate the backup address fields in the response - if you utilize uspsData as the primary part of the response. - GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest: - type: object - id: GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest - description: The request for sending validation feedback. - properties: - responseId: - description: >- - Required. The ID of the response that this feedback is for. This - should be the response_id from the first response in a series of - address validation attempts. + postOfficeState: type: string - conclusion: - enumDescriptions: - - >- - This value is unused. If the - `ProvideValidationFeedbackRequest.conclusion` field is set to - `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error - will be returned. - - >- - The version of the address returned by the Address Validation API - was used for the transaction. - - >- - The version of the address provided by the user was used for the - transaction - - >- - A version of the address that was entered after the last - validation attempt but that was not re-validated was used for the - transaction. - - The transaction was abandoned and the address was not used. + description: Main post office state. + postOfficeCity: + description: Main post office city. type: string - enum: - - VALIDATION_CONCLUSION_UNSPECIFIED - - VALIDATED_VERSION_USED - - USER_VERSION_USED - - UNVALIDATED_VERSION_USED - - UNUSED + dpvVacant: description: >- - Required. The outcome of the sequence of validation attempts. If - this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an - `INVALID_ARGUMENT` error will be returned. - GoogleTypeLatLng: - properties: - latitude: - format: double - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - type: number - longitude: - type: number - format: double - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - id: GoogleTypeLatLng - type: object - GoogleTypePostalAddress: - type: object - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - id: GoogleTypePostalAddress - properties: - recipients: - type: array - items: - type: string + Is this place vacant? Returns a single character. * `Y`: The address + is vacant * `N`: The address is not vacant + type: string + dpvThrowback: description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. - sublocality: + Indicates that mail is not delivered to the street address. Returns + a single character. * `Y`: The mail is not delivered to the street + address. * `N`: The mail is delivered to the street address. + type: string + ewsNoMatch: + type: boolean description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. + The delivery address is matchable, but the EWS file indicates that + an exact match will be available soon. + lacsLinkReturnCode: + description: LACSLink return code. type: string - organization: + elotFlag: + description: eLOT Ascending/Descending Flag (A/D). type: string - description: Optional. The name of the organization at the address. - languageCode: - description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + pmbNumber: + description: PMB (Private Mail Box) number; type: string - regionCode: + pmbDesignator: + description: PMB (Private Mail Box) unit designator. + type: string + cassProcessed: + type: boolean + description: Indicator that the request has been CASS processed. + dpvFootnote: description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. + The footnotes from delivery point validation. Multiple footnotes may + be strung together in the same string. * `AA`: Input address matched + to the ZIP+4 file * `A1`: Input address was not matched to the ZIP+4 + file * `BB`: Matched to DPV (all components) * `CC`: Secondary + number not matched and not required * `C1`: Secondary number not + matched but required * `N1`: High-rise address missing secondary + number * `M1`: Primary number missing * `M3`: Primary number invalid + * `P1`: Input address PO, RR or HC box number missing * `P3`: Input + address PO, RR, or HC Box number invalid * `F1`: Input address + matched to a military address * `G1`: Input address matched to a + general delivery address * `U1`: Input address matched to a unique + ZIP code * `PB`: Input address matched to PBSA record * `RR`: DPV + confirmed address with PMB information * `R1`: DPV confirmed address + without PMB information * `R7`: Carrier Route R777 or R779 record * + `IA`: Informed Address identified * `TA`: Primary number matched by + dropping a trailing alpha type: string - administrativeArea: + dpvPbsa: description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. + Indicates the address was matched to PBSA record. Returns a single + character. * `Y`: The address was matched to PBSA record. * `N`: The + address was not matched to PBSA record. type: string - revision: + deliveryPointCode: + description: 2 digit delivery point code + type: string + dpvNonDeliveryDaysValues: format: int32 type: integer description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - addressLines: - type: array - items: - type: string + Integer identifying non-delivery days. It can be interrogated using + bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a + non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – + Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery + day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a + non-delivery day + dpvDoorNotAccessible: description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - sortingCode: + Flag indicates addresses where USPS cannot knock on a door to + deliver mail. Returns a single character. * `Y`: The door is not + accessible. * `N`: No indication the door is not accessible. + type: string + poBoxOnlyPostalCode: + type: boolean + description: PO Box only postal code. + dpvDrop: description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). + Flag indicates mail is delivered to a single receptable at a site. + Returns a single character. * `Y`: The mail is delivered to a single + receptable at a site. * `N`: The mail is not delivered to a single + receptable at a site. type: string - postalCode: + lacsLinkIndicator: + description: LACSLink indicator. type: string - description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - locality: + errorMessage: type: string description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - GoogleMapsAddressvalidationV1Geocode: - properties: - plusCode: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1PlusCode' - description: The plus code corresponding to the `location`. - location: - $ref: '#/components/schemas/GoogleTypeLatLng' + Error message for USPS data retrieval. This is populated when USPS + processing is suspended because of the detection of artificially + created addresses. The USPS data fields might not be populated when + this error is present. + dpvCmra: description: >- - The geocoded location of the input. Using place IDs is preferred - over using addresses, latitude/longitude coordinates, or plus codes. - Using coordinates when routing or calculating driving directions - will always result in the point being snapped to the road nearest to - those coordinates. This may not be a road that will quickly or - safely lead to the destination and may not be near an access point - to the property. Additionally, when a location is reverse geocoded, - there is no guarantee that the returned address will match the - original. - placeId: + Indicates if the address is a CMRA (Commercial Mail Receiving + Agency)--a private business receiving mail for clients. Returns a + single character. * `Y`: The address is a CMRA * `N`: The address is + not a CMRA + type: string + dpvConfirmation: + description: >- + The possible values for DPV confirmation. Returns a single character + or returns no value. * `N`: Primary and any secondary number + information failed to DPV confirm. * `D`: Address was DPV confirmed + for the primary number only, and the secondary number information + was missing. * `S`: Address was DPV confirmed for the primary number + only, and the secondary number information was present but not + confirmed. * `Y`: Address was DPV confirmed for primary and any + secondary numbers. * Empty: If the response does not contain a + `dpv_confirmation` value, the address was not submitted for DPV + confirmation. + type: string + dpvNoSecureLocation: + type: string description: >- - The PlaceID of the place this input geocodes to. For more - information about Place IDs see - [here](https://developers.google.com/maps/documentation/places/web-service/place-id). + Flag indicates door is accessible, but package will not be left due + to security concerns. Returns a single character. * `Y`: The package + will not be left due to security concerns. * `N`: No indication the + package will not be left due to security concerns. + dpvEnhancedDeliveryCode: type: string - placeTypes: - items: - type: string description: >- - The type(s) of place that the input geocoded to. For example, - `['locality', 'political']`. The full list of types can be found - [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). - type: array - featureSizeMeters: - type: number - format: float + Indicates that more than one DPV return code is valid for the + address. Returns a single character. * `Y`: Address was DPV + confirmed for primary and any secondary numbers. * `N`: Primary and + any secondary number information failed to DPV confirm. * `S`: + Address was DPV confirmed for the primary number only, and the + secondary number information was present but not confirmed, or a + single trailing alpha on a primary number was dropped to make a DPV + match and secondary information required. * `D`: Address was DPV + confirmed for the primary number only, and the secondary number + information was missing. * `R`: Address confirmed but assigned to + phantom route R777 and R779 and USPS delivery is not provided. + deliveryPointCheckDigit: description: >- - The size of the geocoded place, in meters. This is another measure - of the coarseness of the geocoded location, but in physical size - rather than in semantic meaning. - bounds: - description: The bounds of the geocoded place. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - type: object - description: Contains information about the place the input was geocoded to. - id: GoogleMapsAddressvalidationV1Geocode - GoogleMapsAddressvalidationV1ComponentName: - id: GoogleMapsAddressvalidationV1ComponentName - description: A wrapper for the name of the component. + The delivery point check digit. This number is added to the end of + the delivery_point_barcode for mechanically scanned mail. Adding all + the digits of the delivery_point_barcode, + delivery_point_check_digit, postal code, and ZIP+4 together should + yield a number divisible by 10. + type: string + GoogleMapsAddressvalidationV1LanguageOptions: + id: GoogleMapsAddressvalidationV1LanguageOptions + description: >- + Preview: This feature is in Preview (pre-GA). Pre-GA products and + features might have limited support, and changes to pre-GA products and + features might not be compatible with other pre-GA versions. Pre-GA + Offerings are covered by the [Google Maps Platform Service Specific + Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). + For more information, see the [launch stage + descriptions](https://developers.google.com/maps/launch-stages). Enables + the Address Validation API to include additional information in the + response. type: object properties: - languageCode: - description: >- - The BCP-47 language code. This will not be present if the component - name is not associated with a language, such as a street number. - type: string - text: + returnEnglishLatinAddress: description: >- - The name text. For example, "5th Avenue" for a street name or "1253" - for a street number. - type: string + Preview: Return a [google.maps.addressvalidation.v1.Address] in + English. See + [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] + for details. + type: boolean GoogleMapsAddressvalidationV1Address: + type: object + description: >- + Details of the post-processed address. Post-processing includes + correcting misspelled parts of the address, replacing incorrect parts, + and inferring missing parts. id: GoogleMapsAddressvalidationV1Address properties: missingComponentTypes: @@ -939,24 +1010,15 @@ components: found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). unresolvedTokens: + type: array items: type: string - type: array description: >- Any tokens in the input that could not be resolved. This might be an input that was not recognized as a valid part of an address (for example in an input like "123235253253 Main St, San Francisco, CA, 94105", the unresolved tokens may look like `["123235253253"]` since that does not look like a valid street number. - formattedAddress: - type: string - description: >- - The post-processed address, formatted as a single-line address - following the address formatting rules of the region where the - address is located. - postalAddress: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: The post-processed address represented as a postal address. addressComponents: type: array items: @@ -978,101 +1040,32 @@ components: CONFIRMED or the inferred flag is not set to `true`. The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types). + type: array items: type: string - type: array - type: object - description: >- - Details of the post-processed address. Post-processing includes - correcting misspelled parts of the address, replacing incorrect parts, - and inferring missing parts. - GoogleMapsAddressvalidationV1ValidateAddressResponse: - type: object - properties: - responseId: - description: >- - The UUID that identifies this response. If the address needs to be - re-validated, this UUID *must* accompany the new request. - type: string - result: - $ref: '#/components/schemas/GoogleMapsAddressvalidationV1ValidationResult' - description: The result of the address validation. - id: GoogleMapsAddressvalidationV1ValidateAddressResponse - description: The response to an address validation request. - GoogleMapsAddressvalidationV1LanguageOptions: - type: object - id: GoogleMapsAddressvalidationV1LanguageOptions - properties: - returnEnglishLatinAddress: + postalAddress: + description: The post-processed address represented as a postal address. + $ref: '#/components/schemas/GoogleTypePostalAddress' + formattedAddress: description: >- - Preview: Return a [google.maps.addressvalidation.v1.Address] in - English. See - [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] - for details. - type: boolean - description: >- - Preview: This feature is in Preview (pre-GA). Pre-GA products and - features might have limited support, and changes to pre-GA products and - features might not be compatible with other pre-GA versions. Pre-GA - Offerings are covered by the [Google Maps Platform Service Specific - Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). - For more information, see the [launch stage - descriptions](https://developers.google.com/maps/launch-stages). Enables - the Address Validation API to include additional information in the - response. - GoogleMapsAddressvalidationV1UspsAddress: - description: USPS representation of a US address. - id: GoogleMapsAddressvalidationV1UspsAddress - properties: - urbanization: - type: string - description: Puerto Rican urbanization name. - firstAddressLine: - type: string - description: First address line. - state: - description: 2 letter state code. - type: string - city: - description: City name. - type: string - firm: - type: string - description: Firm name. - zipCode: - description: Postal code e.g. 10009. - type: string - secondAddressLine: - type: string - description: Second address line. - cityStateZipAddressLine: - description: City + state + postal code. - type: string - zipCodeExtension: + The post-processed address, formatted as a single-line address + following the address formatting rules of the region where the + address is located. type: string - description: 4-digit postal code extension e.g. 5023. - type: object parameters: - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - fields: - description: Selector specifying which fields to include in a partial response. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: fields + name: quotaUser schema: type: string upload_protocol: @@ -1081,12 +1074,6 @@ components: name: upload_protocol schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -1096,36 +1083,49 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + _.xgafv: + description: V1 error format. in: query - name: quotaUser + name: $.xgafv schema: type: string + enum: + - '1' + - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' + - json + - media + - proto + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query @@ -1154,20 +1154,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1:validateAddress: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' post: description: Validates an address. diff --git a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml index 49a9b680..949e197f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/advisorynotifications.yaml @@ -7,8 +7,8 @@ info: title: Advisory Notifications API description: An API for accessing Advisory Notifications in Google Cloud version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/advisory-notifications servers: @@ -34,77 +34,40 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAdvisorynotificationsV1Notification: + GoogleCloudAdvisorynotificationsV1Message: + description: A message which contains notification details. + id: GoogleCloudAdvisorynotificationsV1Message + type: object properties: - notificationType: - enumDescriptions: - - Default type - - Security and privacy advisory notifications - - Sensitive action notifications - - General security MSA - - Threat horizons MSA - type: string - description: Type of notification - enum: - - NOTIFICATION_TYPE_UNSPECIFIED - - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY - - NOTIFICATION_TYPE_SENSITIVE_ACTIONS - - NOTIFICATION_TYPE_SECURITY_MSA - - NOTIFICATION_TYPE_THREAT_HORIZONS - subject: - description: The subject line of the notification. - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' - name: - description: >- - The resource name of the notification. Format: - organizations/{organization}/locations/{location}/notifications/{notification} - or - projects/{project}/locations/{location}/notifications/{notification}. + localizationTime: + format: google-datetime type: string + description: Time when Message was localized + body: + description: The message content. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' createTime: - description: Output only. Time the notification was created. - type: string - readOnly: true format: google-datetime - messages: - description: A list of messages in the notification. + description: The Message creation timestamp. + type: string + attachments: + description: The attachments to download. type: array items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Message' - id: GoogleCloudAdvisorynotificationsV1Notification - description: >- - A notification object for notifying customers about security and privacy - issues. - type: object - GoogleCloudAdvisorynotificationsV1Attachment: - type: object - description: Attachment with specific information about the issue. - id: GoogleCloudAdvisorynotificationsV1Attachment - properties: - csv: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' - description: A CSV file attachment. Max size is 10 MB. - displayName: - type: string - description: The title of the attachment. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' GoogleCloudAdvisorynotificationsV1Text: - description: A text object containing the English text and its localized copies. + type: object id: GoogleCloudAdvisorynotificationsV1Text + description: A text object containing the English text and its localized copies. properties: - localizedText: - type: string - description: The requested localized copy (if applicable). - enText: - type: string - description: The English copy. localizationState: type: string - description: Status of the localization. enum: - LOCALIZATION_STATE_UNSPECIFIED - LOCALIZATION_STATE_NOT_APPLICABLE - LOCALIZATION_STATE_PENDING - LOCALIZATION_STATE_COMPLETED + description: Status of the localization. enumDescriptions: - Not used. - >- @@ -118,170 +81,183 @@ components: Localization for requested language is in progress, and not ready yet. - Localization for requested language is completed. - type: object - GoogleCloudAdvisorynotificationsV1NotificationSettings: - description: Settings for each NotificationType. - id: GoogleCloudAdvisorynotificationsV1NotificationSettings + enText: + description: The English copy. + type: string + localizedText: + description: The requested localized copy (if applicable). + type: string + GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: + description: Response of ListNotifications endpoint. properties: - enabled: - type: boolean - description: Whether the associated NotificationType is enabled. + nextPageToken: + type: string + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + notifications: + items: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + type: array + description: List of notifications under a given parent. + totalSize: + type: integer + description: Estimation of a total number of notifications. + format: int32 + id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse type: object GoogleCloudAdvisorynotificationsV1Csv: - type: object id: GoogleCloudAdvisorynotificationsV1Csv - description: >- - A representation of a CSV file attachment, as a list of column headers - and a list of data rows. + type: object properties: - headers: - type: array - description: The list of headers for data columns in a CSV file. - items: - type: string dataRows: type: array + items: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' description: >- The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string. - items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1CsvCsvRow' - GoogleCloudAdvisorynotificationsV1CsvCsvRow: - type: object - description: A representation of a single data row in a CSV file. - properties: - entries: + headers: type: array items: type: string - description: >- - The data entries in a CSV file row, as a string array rather than a - single comma-separated string. - id: GoogleCloudAdvisorynotificationsV1CsvCsvRow + description: The list of headers for data columns in a CSV file. + description: >- + A representation of a CSV file attachment, as a list of column headers + and a list of data rows. GoogleCloudAdvisorynotificationsV1Subject: description: A subject line of a notification. + type: object + id: GoogleCloudAdvisorynotificationsV1Subject properties: text: description: The text content. $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' + GoogleCloudAdvisorynotificationsV1NotificationSettings: + properties: + enabled: + description: Whether the associated NotificationType is enabled. + type: boolean type: object - id: GoogleCloudAdvisorynotificationsV1Subject + description: Settings for each NotificationType. + id: GoogleCloudAdvisorynotificationsV1NotificationSettings GoogleCloudAdvisorynotificationsV1Settings: - id: GoogleCloudAdvisorynotificationsV1Settings properties: etag: - type: string description: >- Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle. - name: type: string + name: description: >- Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. + type: string notificationSettings: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1NotificationSettings description: >- Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAdvisorynotificationsV1NotificationSettings type: object + type: object + id: GoogleCloudAdvisorynotificationsV1Settings description: Settings for Advisory Notifications. + GoogleCloudAdvisorynotificationsV1CsvCsvRow: type: object - GoogleCloudAdvisorynotificationsV1MessageBody: properties: - text: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' - description: The text content of the message body. - type: object - id: GoogleCloudAdvisorynotificationsV1MessageBody - description: A message body containing text. - GoogleCloudAdvisorynotificationsV1Message: - description: A message which contains notification details. - id: GoogleCloudAdvisorynotificationsV1Message + entries: + description: >- + The data entries in a CSV file row, as a string array rather than a + single comma-separated string. + type: array + items: + type: string + description: A representation of a single data row in a CSV file. + id: GoogleCloudAdvisorynotificationsV1CsvCsvRow + GoogleCloudAdvisorynotificationsV1Notification: properties: - attachments: + messages: items: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Attachment' + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Message' type: array - description: The attachments to download. - body: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1MessageBody' - description: The message content. - localizationTime: + description: A list of messages in the notification. + notificationType: + description: Type of notification + enumDescriptions: + - Default type + - Security and privacy advisory notifications + - Sensitive action notifications + - General security MSA + - Threat horizons MSA + enum: + - NOTIFICATION_TYPE_UNSPECIFIED + - NOTIFICATION_TYPE_SECURITY_PRIVACY_ADVISORY + - NOTIFICATION_TYPE_SENSITIVE_ACTIONS + - NOTIFICATION_TYPE_SECURITY_MSA + - NOTIFICATION_TYPE_THREAT_HORIZONS + type: string + name: + description: >- + The resource name of the notification. Format: + organizations/{organization}/locations/{location}/notifications/{notification} + or + projects/{project}/locations/{location}/notifications/{notification}. type: string - description: Time when Message was localized - format: google-datetime createTime: - description: The Message creation timestamp. format: google-datetime type: string + description: Output only. Time the notification was created. + readOnly: true + subject: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Subject' + description: The subject line of the notification. + id: GoogleCloudAdvisorynotificationsV1Notification + description: >- + A notification object for notifying customers about security and privacy + issues. type: object - GoogleCloudAdvisorynotificationsV1ListNotificationsResponse: + GoogleCloudAdvisorynotificationsV1Attachment: + id: GoogleCloudAdvisorynotificationsV1Attachment + description: Attachment with specific information about the issue. type: object - id: GoogleCloudAdvisorynotificationsV1ListNotificationsResponse - description: Response of ListNotifications endpoint. properties: - notifications: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification - description: List of notifications under a given parent. - totalSize: - description: Estimation of a total number of notifications. - format: int32 - type: integer - nextPageToken: + displayName: type: string - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + description: The title of the attachment. + csv: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Csv' + description: A CSV file attachment. Max size is 10 MB. + GoogleCloudAdvisorynotificationsV1MessageBody: + properties: + text: + description: The text content of the message body. + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Text' + id: GoogleCloudAdvisorynotificationsV1MessageBody + type: object + description: A message body containing text. parameters: - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean - _.xgafv: - description: V1 error format. + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' alt: description: Data format for response. in: query @@ -292,10 +268,16 @@ components: - json - media - proto - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string uploadType: @@ -304,22 +286,40 @@ components: name: uploadType schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string - callback: - description: JSONP + enum: + - '1' + - '2' + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. in: query - name: callback + name: key schema: type: string x-stackQL-resources: @@ -328,76 +328,73 @@ components: name: notifications title: Notifications methods: - _list: - operation: &ref_1 + get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications/get - response: &ref_2 + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.notifications list: - operation: *ref_1 - response: *ref_2 - get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications~1{notificationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1notifications/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.notifications sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/notifications/methods/get' - - $ref: '#/components/x-stackQL-resources/notifications/methods/get' - - $ref: '#/components/x-stackQL-resources/notifications/methods/list' - $ref: '#/components/x-stackQL-resources/notifications/methods/list' insert: [] update: [] + replace: [] delete: [] settings: id: google.advisorynotifications.settings name: settings title: Settings methods: - get_settings: + update_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/patch response: mediaType: application/json openAPIDocKey: '200' - update_settings: + get_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1settings/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' - - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' + replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/notifications: - parameters: &ref_3 - - $ref: '#/components/parameters/key' + /v1/projects/{projectsId}/locations/{locationsId}/notifications/{notificationsId}: + parameters: &ref_1 + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' get: - description: Lists notifications under a given parent. - operationId: advisorynotifications.projects.locations.notifications.list + description: Gets a notification. + operationId: advisorynotifications.projects.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -410,7 +407,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path name: projectsId @@ -422,28 +419,20 @@ paths: required: true schema: type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: pageToken + - in: path + name: notificationsId + required: true schema: type: string - in: query - name: view + name: languageCode schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notifications/{notificationsId}: - parameters: *ref_3 + /v1/projects/{projectsId}/locations/{locationsId}/notifications: + parameters: *ref_1 get: - description: Gets a notification. - operationId: advisorynotifications.projects.locations.notifications.get + description: Lists notifications under a given parent. + operationId: advisorynotifications.projects.locations.notifications.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -456,7 +445,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse parameters: - in: path name: projectsId @@ -468,20 +457,33 @@ paths: required: true schema: type: string - - in: path - name: notificationsId - required: true + - in: query + name: languageCode schema: type: string - in: query - name: languageCode + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: view schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/settings: - parameters: *ref_3 - get: - description: Get notification settings. - operationId: advisorynotifications.projects.locations.getSettings + parameters: *ref_1 + patch: + description: Update notification settings. + operationId: advisorynotifications.projects.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -506,14 +508,9 @@ paths: required: true schema: type: string - patch: - description: Update notification settings. - operationId: advisorynotifications.projects.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + get: + description: Get notification settings. + operationId: advisorynotifications.projects.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -538,11 +535,11 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications: - parameters: *ref_3 + /v1/organizations/{organizationsId}/locations/{locationsId}/settings: + parameters: *ref_1 get: - description: Lists notifications under a given parent. - operationId: advisorynotifications.organizations.locations.notifications.list + description: Get notification settings. + operationId: advisorynotifications.organizations.locations.getSettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -555,7 +552,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path name: organizationsId @@ -567,28 +564,14 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: - parameters: *ref_3 - get: - description: Gets a notification. - operationId: advisorynotifications.organizations.locations.notifications.get + patch: + description: Update notification settings. + operationId: advisorynotifications.organizations.locations.updateSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -601,7 +584,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification + #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings parameters: - in: path name: organizationsId @@ -613,25 +596,11 @@ paths: required: true schema: type: string - - in: path - name: notificationsId - required: true - schema: - type: string - - in: query - name: languageCode - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/settings: - parameters: *ref_3 - patch: - description: Update notification settings. - operationId: advisorynotifications.organizations.locations.updateSettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAdvisorynotificationsV1Settings' + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}: + parameters: *ref_1 + get: + description: Gets a notification. + operationId: advisorynotifications.organizations.locations.notifications.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -644,7 +613,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1Notification parameters: - in: path name: organizationsId @@ -656,9 +625,20 @@ paths: required: true schema: type: string + - in: path + name: notificationsId + required: true + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/notifications: + parameters: *ref_1 get: - description: Get notification settings. - operationId: advisorynotifications.organizations.locations.getSettings + description: Lists notifications under a given parent. + operationId: advisorynotifications.organizations.locations.notifications.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -671,7 +651,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAdvisorynotificationsV1Settings + #/components/schemas/GoogleCloudAdvisorynotificationsV1ListNotificationsResponse parameters: - in: path name: organizationsId @@ -683,3 +663,20 @@ paths: required: true schema: type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: view + schema: + type: string + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml index 055d29ad..6de234dc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/aiplatform.yaml @@ -9,8 +9,8 @@ info: Train high-quality custom machine learning models with minimal machine learning expertise and effort. version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/vertex-ai/ servers: @@ -39,993 +39,1098 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation - type: object - properties: - columnName: - type: string - description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. - GoogleCloudAiplatformV1PipelineTaskDetail: + GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: + description: Represents one Dataset in datalabeling.googleapis.com. type: object - description: The runtime detail of a task execution. properties: - executorDetail: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail - description: Output only. The detailed execution info. - readOnly: true - taskId: - format: int64 - type: string - readOnly: true - description: Output only. The system generated ID of the task. - outputs: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - readOnly: true - description: Output only. The runtime output artifacts of the task. - inputs: - readOnly: true - description: Output only. The runtime input artifacts of the task. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList - type: object - execution: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - description: Output only. The execution metadata of the task. - pipelineTaskStatus: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus - description: >- - Output only. A list of task status. This field keeps a record of - task status evolving over time. - readOnly: true - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. Task create time. - error: - readOnly: true - description: >- - Output only. The error that occurred during task execution. Only - populated when the task's state is FAILED or CANCELLED. - $ref: '#/components/schemas/GoogleRpcStatus' - taskName: + dataset: description: >- - Output only. The user specified name of the task that is defined in - pipeline_spec. - type: string - readOnly: true - startTime: - description: Output only. Task start time. - format: google-datetime - type: string - readOnly: true - state: - type: string - description: Output only. State of the task. - enumDescriptions: - - Unspecified. - - Specifies pending state for the task. - - Specifies task is being executed. - - Specifies task completed successfully. - - Specifies Task cancel is in pending state. - - Specifies task is being cancelled. - - Specifies task was cancelled. - - Specifies task failed. - - Specifies task was skipped due to cache hit. - - >- - Specifies that the task was not triggered because the task's - trigger policy is not satisfied. The trigger policy is specified - in the `condition` field of PipelineJob.pipeline_spec. - readOnly: true - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED - endTime: - readOnly: true + Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. type: string - description: Output only. Task end time. - format: google-datetime - parentTaskId: - format: int64 + datasetDisplayName: + description: The Dataset's display name in datalabeling.googleapis.com. type: string + dataLabelingAnnotatedDatasets: description: >- - Output only. The id of the parent task if the task is within a - component scope. Empty if the task is at the root level. - readOnly: true - id: GoogleCloudAiplatformV1PipelineTaskDetail - GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: - description: Request message for JobService.CancelHyperparameterTuningJob. - type: object - properties: {} - id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest - GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: - description: Details of operations that perform create FeatureView. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureView Create. - id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata + The migratable AnnotatedDataset in datalabeling.googleapis.com + belongs to the data labeling Dataset. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + type: array + id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. properties: - windowConfig: - description: Config containing strategy for generating sliding windows. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - validationOptions: + timeFormat: type: string description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue - additionalExperiments: - description: Additional experiment flags for the time series forcasting training. - items: - type: string - type: array - forecastHorizon: - description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - format: int64 + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + columnName: type: string - unavailableAtForecastColumns: + GoogleCloudAiplatformV1DataItemView: + description: A container for a single DataItem and Annotations on it. + id: GoogleCloudAiplatformV1DataItemView + type: object + properties: + annotations: type: array - description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. - items: - type: string - holidayRegions: - description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. items: - type: string - type: array - targetColumn: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - type: string - optimizationObjective: - type: string + The Annotations on the DataItem. If too many Annotations should be + returned for the DataItem, this field will be truncated per + annotations_limit in request. If it was, then the + has_truncated_annotations will be set to true. + dataItem: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' + description: The DataItem. + hasTruncatedAnnotations: + type: boolean description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. - contextWindow: + True if and only if the Annotations field has been truncated. It + happens if more Annotations for this DataItem met the request's + annotation_filter than are allowed to be returned by + annotations_limit. Note that if Annotations field is not being + returned due to field mask, then this field will not be set to true + no matter how many Annotations are there. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics + description: Metrics for general pairwise text generation evaluation results. + type: object + properties: + accuracy: + format: float + type: number + description: Fraction of cases where the autorater agreed with the human raters. + baselineModelWinRate: description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. + Percentage of time the autorater decided the baseline model had the + better response. + type: number + format: float + falseNegativeCount: type: string - format: int64 - availableAtForecastColumns: - type: array - items: - type: string - description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - exportEvaluatedDataItemsConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - quantiles: description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`. Up to 5 quantiles are allowed of values - between 0 and 1, exclusive. Required if the value of - optimization_objective is minimize-quantile-loss. Represents the - percent quantiles to use for that objective. Quantiles must be - unique. - type: array - items: - type: number - format: double - hierarchyConfig: + Number of examples where the autorater chose the baseline model, but + humans preferred the model. + format: int64 + precision: + type: number + format: float description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - trainBudgetMilliNodeHours: + Fraction of cases where the autorater and humans thought the model + had a better response out of all cases where the autorater thought + the model had a better response. True positive divided by all + positive. + falsePositiveCount: format: int64 + description: >- + Number of examples where the autorater chose the model, but humans + preferred the baseline model. type: string + modelWinRate: + type: number description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. - timeColumn: + Percentage of time the autorater decided the model had the better + response. + format: float + truePositiveCount: description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. + Number of examples where both the autorater and humans decided that + the model had the better response. type: string - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. + format: int64 + f1Score: + description: Harmonic mean of precision and recall. + type: number + format: float + humanPreferenceModelWinRate: + type: number + format: float + description: Percentage of time humans decided the model had the better response. + trueNegativeCount: type: string - weightColumn: + format: int64 description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. This column must be available at forecast. - type: string - transformations: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation - type: array + Number of examples where both the autorater and humans decided that + the model had the worse response. + recall: + type: number description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - dataGranularity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - timeSeriesAttributeColumns: + Fraction of cases where the autorater and humans thought the model + had a better response out of all cases where the humans thought the + model had a better response. + format: float + cohensKappa: + type: number description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - items: - type: string - type: array - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs - type: object - GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: + A measurement of agreement between the autorater and human raters + that takes the likelihood of random agreement into account. + format: float + humanPreferenceBaselineModelWinRate: + description: >- + Percentage of time humans decided the baseline model had the better + response. + type: number + format: float + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: type: object - id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition properties: - allowedIssuers: - description: >- - A list of allowed JWT issuers. Each entry must be a valid Google - service account, in the following format: - `service-account-name@project-id.iam.gserviceaccount.com` + values: type: array items: - type: string - audiences: + type: number + format: double description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. - items: - type: string - type: array - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: + Required. Matches values of the parent parameter of 'DISCRETE' type. + All values must exist in `discrete_value_spec` of parent parameter. + The Epsilon of the value matching is 1e-10. + description: Represents the spec to match discrete values from parent parameter. + GoogleCloudAiplatformV1ListIndexesResponse: properties: - artifactId: + indexes: + description: List of indexes in the requested page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + nextPageToken: type: string description: >- - Artifact resource id from MLMD. Which is the last portion of an - artifact resource name: - `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. - The artifact must stay within the same project, location and default - metadatastore as the pipeline. - type: object - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact - description: The type of an input artifact. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: + A token to retrieve next page of results. Pass to + ListIndexesRequest.page_token to obtain that page. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. * A boolean value that indicates whether the - value is valid. + id: GoogleCloudAiplatformV1ListIndexesResponse + description: Response message for IndexService.ListIndexes. + GoogleIamV1Binding: properties: - invalidValuesAllowed: + condition: + $ref: '#/components/schemas/GoogleTypeExpr' description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. - type: boolean - columnName: + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + role: type: string - GoogleCloudAiplatformV1XraiAttribution: - type: object - properties: - stepCount: - description: >- - Required. The number of steps for approximating the path integral. A - good value to start is 50 and gradually increase until the sum to - diff property is met within the desired error range. Valid range of - its value is [1, 100], inclusively. - format: int32 - type: integer - smoothGradConfig: description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy - samples in the vicinity of the inputs. Adding noise can help improve - the computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' - blurBaselineConfig: + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + members: + type: array + items: + type: string description: >- - Config for XRAI with blur baseline. When enabled, a linear path from - the maximally blurred image to the input image is created. Using a - blurred baseline instead of zero (black image) is motivated by the - BlurIG approach explained here: https://arxiv.org/abs/2004.03383 - $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' - id: GoogleCloudAiplatformV1XraiAttribution - description: >- - An explanation method that redistributes Integrated Gradients - attributions to segmented regions, taking advantage of the model's fully - differentiable structure. Refer to this paper for more details: - https://arxiv.org/abs/1906.02825 Supported only by image Models. - GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: - properties: - diskUtilizationBytes: - description: The disk utilization of the MetadataStore in bytes. - type: string - format: int64 + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. type: object - description: Represents state information for a MetadataStore. - id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: - description: >- - Config for migrating Dataset in automl.googleapis.com to Vertex AI's - Dataset. + GoogleCloudAiplatformV1PublisherModelDocumentation: + description: A named piece of documentation. + id: GoogleCloudAiplatformV1PublisherModelDocumentation properties: - dataset: - description: >- - Required. Full resource name of automl Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}`. + content: type: string - datasetDisplayName: - description: >- - Required. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. + description: Required. Content of this piece of document (in Markdown format). + title: type: string + description: >- + Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, + JAVA, NODE.JS, etc.. type: object - id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig - CloudAiLargeModelsVisionRaiInfoDetectedLabels: + GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: type: object - description: Filters returning list of deteceted labels, scores, and bounding boxes. - id: CloudAiLargeModelsVisionRaiInfoDetectedLabels properties: - raiCategory: - description: The RAI category for the deteceted labels. + sum: + description: Output only. Sum of a given population of values. + readOnly: true + format: int64 type: string - entities: + p5: + type: number + readOnly: true + description: Output only. The 5th percentile of the values in the population. + format: double + mean: + type: number + readOnly: true + format: double + description: Output only. The arithmetic mean of the values in the population. + billableSum: + format: int64 + description: Output only. Sum of a given population of values that are billable. + type: string + readOnly: true + max: + format: double + description: Output only. The maximum of the population values. + readOnly: true + type: number + buckets: type: array + readOnly: true + description: Output only. Defines the histogram bucket. items: $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - description: The list of detected entities for the rai signal. - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: - description: Specification for how the data should be sliced. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + median: + description: Output only. The median of the values in the population. + readOnly: true + format: double + type: number + p95: + format: double + description: Output only. The 95th percentile of the values in the population. + type: number + readOnly: true + min: + description: Output only. The minimum of the population values. + readOnly: true + type: number + format: double + description: Dataset distribution for Supervised Tuning. + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + GoogleCloudAiplatformV1Segment: type: object properties: - configs: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + startIndex: + readOnly: true + type: integer description: >- - Mapping configuration for this SliceSpec. The key is the name of the - feature. By default, the key will be prefixed by "instance" as a - dictionary prefix for Vertex Batch Predictions output format. - GoogleCloudAiplatformV1CancelPipelineJobRequest: - id: GoogleCloudAiplatformV1CancelPipelineJobRequest - properties: {} - description: Request message for PipelineService.CancelPipelineJob. + Output only. Start index in the given Part, measured in bytes. + Offset from the start of the Part, inclusive, starting at zero. + format: int32 + endIndex: + readOnly: true + type: integer + description: >- + Output only. End index in the given Part, measured in bytes. Offset + from the start of the Part, exclusive, starting at zero. + format: int32 + partIndex: + format: int32 + description: >- + Output only. The index of a Part object within its parent Content + object. + readOnly: true + type: integer + text: + description: >- + Output only. The text corresponding to the segment from the + response. + type: string + readOnly: true + id: GoogleCloudAiplatformV1Segment + description: Segment of the content. + GoogleCloudAiplatformV1CsvSource: + id: GoogleCloudAiplatformV1CsvSource + description: The storage details for CSV input content. + properties: + gcsSource: + description: Required. Google Cloud Storage location. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' type: object - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: - id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization - description: Visualization configurations for image explanation. + GoogleCloudAiplatformV1Tool: + properties: + functionDeclarations: + description: >- + Optional. Function tool type. One or more function declarations to + be passed to the model along with the current user query. Model may + decide to call a subset of these functions by populating + FunctionCall in the response. User should provide a FunctionResponse + for each function call in the next turn. Based on the function + responses, Model will generate the final response back to the user. + Maximum 64 function declarations can be provided. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' + type: array + googleSearchRetrieval: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' + description: >- + Optional. GoogleSearchRetrieval tool type. Specialized retrieval + tool that is powered by Google search. + retrieval: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' + description: >- + Optional. Retrieval tool type. System will always execute the + provided retrieval tool(s) to get external knowledge to answer the + prompt. Retrieval results are presented to the model for generation. + description: >- + Tool details that the model may use to generate response. A `Tool` is a + piece of code that enables the system to interact with external systems + to perform an action, or set of actions, outside of knowledge and scope + of the model. A Tool object should contain exactly one type of Tool (e.g + FunctionDeclaration, Retrieval or GoogleSearchRetrieval). type: object + id: GoogleCloudAiplatformV1Tool + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation properties: - clipPercentLowerbound: - format: float + columnName: + type: string + type: object + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: + type: object + description: Training Dataset information. + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + properties: + loggingSamplingStrategy: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. - type: number - colorMap: - enum: - - COLOR_MAP_UNSPECIFIED - - PINK_GREEN - - VIRIDIS - - RED - - GREEN - - RED_GREEN - - PINK_WHITE_GREEN + Strategy to sample data from Training Dataset. If not set, we + process the whole dataset. + dataFormat: type: string - enumDescriptions: - - Should not be used. - - 'Positive: green. Negative: pink.' - - >- - Viridis color map: A perceptually uniform color mapping which is - easier to see by those with colorblindness and progresses from - yellow to green to blue. Positive: yellow. Negative: blue. - - 'Positive: red. Negative: red.' - - 'Positive: green. Negative: green.' - - 'Positive: green. Negative: red.' - - PiYG palette. description: >- - The color scheme used for the highlighted areas. Defaults to - PINK_GREEN for Integrated Gradients attribution, which shows - positive attributions in green and negative in pink. Defaults to - VIRIDIS for XRAI attribution, which highlights the most influential - regions in yellow and the least influential in blue. - overlayType: + Data format of the dataset, only applicable if the input is from + Google Cloud Storage. The possible formats are: "tf-record" The + source file is a TFRecord file. "csv" The source file is a CSV file. + "jsonl" The source file is a JSONL file. + targetField: type: string - enum: - - OVERLAY_TYPE_UNSPECIFIED - - NONE - - ORIGINAL - - GRAYSCALE - - MASK_BLACK description: >- - How the original image is displayed in the visualization. Adjusting - the overlay can help increase visual clarity if the original image - makes it difficult to view the visualization. Defaults to NONE. - enumDescriptions: - - Default value. This is the same as NONE. - - No overlay. - - The attributions are shown on top of the original image. - - >- - The attributions are shown on top of grayscaled version of the - original image. - - >- - The attributions are used as a mask to reveal predictive parts of - the image and hide the un-predictive parts. - type: + The target field name the model is to predict. This field will be + excluded when doing Predict and (or) Explain for the training data. + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' description: >- - Type of the image visualization. Only applicable to Integrated - Gradients attribution. OUTLINES shows regions of attribution, while - PIXELS shows per-pixel attribution. Defaults to OUTLINES. - enumDescriptions: - - Should not be used. - - Shows which pixel contributed to the image prediction. - - >- - Shows which region contributed to the image prediction by - outlining the region. - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - type: string - polarity: - enumDescriptions: - - Default value. This is the same as POSITIVE. - - >- - Highlights the pixels/outlines that were most influential to the - model's prediction. - - >- - Setting polarity to negative highlights areas that does not lead - to the models's current prediction. - - Shows both positive and negative attributions. - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH + The Google Cloud Storage uri of the unmanaged Dataset used to train + this Model. + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. + The BigQuery table of the unmanaged Dataset used to train this + Model. + dataset: + description: The resource name of the Dataset used to train this Model. type: string - clipPercentUpperbound: - format: float - description: >- - Excludes attributions above the specified percentile from the - highlighted areas. Using the clip_percent_upperbound and - clip_percent_lowerbound together can be useful for filtering out - noise and making it easier to see areas of strong attribution. - Defaults to 99.9. - type: number - GoogleCloudAiplatformV1ImportDataResponse: - description: Response message for DatasetService.ImportData. - properties: {} + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: + id: >- + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult type: object - id: GoogleCloudAiplatformV1ImportDataResponse - GoogleCloudAiplatformV1SearchMigratableResourcesResponse: - description: Response message for MigrationService.SearchMigratableResources. properties: - nextPageToken: + dataset: type: string + description: Migrated dataset resource name. + model: + type: string + description: Migrated model resource name. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The error result of the migration request in case of failure. + request: description: >- - The standard next-page token. The migratable_resources may not fill - page_size in SearchMigratableResourcesRequest even when there are - subsequent pages. - migratableResources: - type: array - description: >- - All migratable resources that can be migrated to the location - specified in the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' - type: object - id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse - GoogleCloudAiplatformV1ListOptimalTrialsRequest: + It's the same as the value in + MigrateResourceRequest.migrate_resource_requests. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + description: >- + Represents a partial result in batch migration operation for one + MigrateResourceRequest. + GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: type: object - description: Request message for VizierService.ListOptimalTrials. - properties: {} - id: GoogleCloudAiplatformV1ListOptimalTrialsRequest - GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: + id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec properties: - nextPageToken: + minReplicaCount: + description: >- + Optional. min replicas in the node pool, must be ≤ replica_count and + < max_replica_count or will throw error. For autoscaling enabled + Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 + to match the OSS Ray + behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). + As for Persistent Resource, the min_replica_count must be > 0, we + added a corresponding validation inside + CreatePersistentResourceRequestValidator.java. type: string + format: int64 + maxReplicaCount: + format: int64 description: >- - A token, which can be sent as - ListTensorboardExperimentsRequest.page_token to retrieve the next - page. If this field is omitted, there are no subsequent pages. - tensorboardExperiments: - type: array - description: The TensorboardExperiments mathching the request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' - description: Response message for TensorboardService.ListTensorboardExperiments. - id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse - type: object - GoogleCloudAiplatformV1DataItem: + Optional. max replicas in the node pool, must be ≥ replica_count and + > min_replica_count or will throw error + type: string + description: The min/max number of replicas allowed if enabling autoscaling + GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: type: object + description: >- + The dedicated serving endpoint for this FeatureOnlineStore. Only need to + set when you choose Optimized storage type. Public endpoint is + provisioned by default. + id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint properties: - updateTime: - readOnly: true - description: Output only. Timestamp when this DataItem was last updated. - type: string - format: google-datetime - payload: - type: any + privateServiceConnectConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig description: >- - Required. The data that the DataItem represents (for example, an - image or a text snippet). The schema of the payload is stored in the - parent Dataset's metadata schema's dataItemSchemaUri field. - name: + Optional. Private service connect config. The private service + connection is available only for Optimized storage type, not for + embedding management now. If + PrivateServiceConnectConfig.enable_private_service_connect set to + true, customers will use private service connection to send request. + Otherwise, the connection will set to public endpoint. + publicEndpointDomainName: readOnly: true - description: Output only. The resource name of the DataItem. - type: string - etag: + description: >- + Output only. This field will be populated with the domain name to + use for this FeatureOnlineStore type: string + serviceAttachment: description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - createTime: - format: google-datetime + Output only. The name of the service attachment resource. Populated + if private service connect is enabled and after FeatureViewSync is + created. type: string readOnly: true - description: Output only. Timestamp when this DataItem was created. - labels: - description: >- - Optional. The labels with user-defined metadata to organize your - DataItems. Label keys and values can be no longer than 64 characters - (Unicode codepoints), can only contain lowercase letters, numeric - characters, underscores and dashes. International characters are - allowed. No more than 64 user labels can be associated with one - DataItem(System labels are excluded). See https://goo.gl/xmQnxf for - more information and examples of labels. System reserved label keys - are prefixed with "aiplatform.googleapis.com/" and are immutable. - additionalProperties: - type: string - type: object - description: >- - A piece of data in a Dataset. Could be an image, a video, a document or - plain text. - id: GoogleCloudAiplatformV1DataItem - GoogleCloudAiplatformV1ListTensorboardRunsResponse: - id: GoogleCloudAiplatformV1ListTensorboardRunsResponse - type: object - description: Response message for TensorboardService.ListTensorboardRuns. + GoogleCloudAiplatformV1Port: + id: GoogleCloudAiplatformV1Port + description: Represents a network port in a container. properties: - nextPageToken: - type: string + containerPort: description: >- - A token, which can be sent as ListTensorboardRunsRequest.page_token - to retrieve the next page. If this field is omitted, there are no - subsequent pages. - tensorboardRuns: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - type: array - description: The TensorboardRuns mathching the request. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics + The number of the port to expose on the pod's IP address. Must be a + valid port number, between 1 and 65535 inclusive. + format: int32 + type: integer type: object - description: >- - UNIMPLEMENTED. Track matching model metrics for a single track match - threshold and multiple label match confidence thresholds. + GoogleCloudAiplatformV1TuningJob: properties: - meanMismatchRate: - type: number - description: The mean mismatch rate over all confidence thresholds. - format: float - iouThreshold: - format: float - type: number + supervisedTuningSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' + description: Tuning Spec for Supervised Fine Tuning. + tuningDataStats: description: >- - The intersection-over-union threshold value between bounding boxes - across frames used to compute this metric entry. - meanBoundingBoxIou: - description: The mean bounding box iou over all confidence thresholds. - type: number - format: float - meanTrackingAveragePrecision: - type: number - description: The mean average precision over all confidence thresholds. - format: float - confidenceMetrics: - type: array + Output only. The tuning data statistics associated with this + TuningJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' + readOnly: true + name: + readOnly: true description: >- - Metrics for each label-match `confidenceThreshold` from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics - GoogleCloudAiplatformV1CancelCustomJobRequest: - description: Request message for JobService.CancelCustomJob. - properties: {} - id: GoogleCloudAiplatformV1CancelCustomJobRequest - type: object - GoogleProtobufEmpty: - type: object - id: GoogleProtobufEmpty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: - type: object - properties: - displayName: + Output only. Identifier. Resource name of a TuningJob. Format: + `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + type: string + state: + type: string + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + readOnly: true + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + description: Output only. The detailed state of the job. + updateTime: + description: Output only. Time when the TuningJob was most recently updated. + readOnly: true + type: string + format: google-datetime + tunedModel: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. + Output only. The tuned model resources assiociated with this + TuningJob. + encryptionSpec: + description: >- + Customer-managed encryption key options for a TuningJob. If this is + set, then all resources created by the TuningJob will be encrypted + with the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + tunedModelDisplayName: + description: >- + Optional. The display name of the TunedModel. The name can be up to + 128 characters long and can consist of any UTF-8 characters. type: string - annotationSpecId: + endTime: + description: >- + Output only. Time when the TuningJob entered any of the following + JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. + format: google-datetime + readOnly: true type: string + experiment: + type: string + readOnly: true + description: Output only. The Experiment associated with this TuningJob. + error: description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - timeSegment: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + description: + description: Optional. The description of the TuningJob. + type: string + startTime: + format: google-datetime + readOnly: true description: >- - This Annotation applies to the time period represented by the - TimeSegment. If it's not set, the Annotation applies to the whole - video. - description: Annotation details specific to video classification. - id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata: + Output only. Time when the TuningJob for the first time entered the + `JOB_STATE_RUNNING` state. + type: string + createTime: + description: Output only. Time when the TuningJob was created. + readOnly: true + type: string + format: google-datetime + baseModel: + type: string + description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". + labels: + description: >- + Optional. The labels with user-defined metadata to organize + TuningJob and generated resources such as Model and Endpoint. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + additionalProperties: + type: string + type: object + id: GoogleCloudAiplatformV1TuningJob + description: Represents a TuningJob that runs with Google owned models. + GoogleCloudAiplatformV1ListModelsResponse: + id: GoogleCloudAiplatformV1ListModelsResponse properties: - contentValidationStats: - type: array + nextPageToken: description: >- - The validation stats of the content (per file) to be inserted or - updated on the Matching Engine Index resource. Populated if - contentsDeltaUri is provided as part of Index.metadata. Please note - that, currently for those files that are broken or has unsupported - file format, we will not have the stats for those files. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats - dataBytesCount: - description: The ingested data size in bytes. - format: int64 + A token to retrieve next page of results. Pass to + ListModelsRequest.page_token to obtain that page. type: string + models: + description: List of Models in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + type: array type: object - description: Runtime operation metadata with regard to Matching Engine Index. - id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata - GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: - description: Runtime operation information for ModelService.UpdateExplanationDataset. + description: Response message for ModelService.ListModels + GoogleCloudAiplatformV1ToolNameMatchInstance: + id: GoogleCloudAiplatformV1ToolNameMatchInstance + description: Spec for tool name match instance. + type: object + properties: + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + prediction: + description: Required. Output of the evaluated model. + type: string + GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: properties: genericMetadata: + description: The operation generic information. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. + description: Runtime operation information for CreateDeploymentResourcePool method. + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata type: object - id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata - GoogleCloudAiplatformV1ResourceRuntime: - id: GoogleCloudAiplatformV1ResourceRuntime - description: Persistent Cluster runtime information as output + GoogleCloudAiplatformV1NetworkSpec: properties: - accessUris: + subnetwork: description: >- - Output only. URIs for user to connect to the Cluster. Example: { - "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" - "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } - additionalProperties: - type: string - type: object - readOnly: true + The name of the subnet that this instance is in. Format: + `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` + type: string + enableInternetAccess: + description: Whether to enable public internet access. Default false. + type: boolean + network: + description: >- + The full name of the Google Compute Engine + [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) + type: string + description: Network spec. type: object - GoogleCloudAiplatformV1NasTrialDetail: - id: GoogleCloudAiplatformV1NasTrialDetail - description: >- - Represents a NasTrial details along with its parameters. If there is a - corresponding train NasTrial, the train NasTrial is also returned. + id: GoogleCloudAiplatformV1NetworkSpec + GoogleCloudAiplatformV1Context: properties: - trainTrial: - description: >- - The train NasTrial corresponding to search_trial. Only populated if - search_trial is used for training. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - parameters: - description: The parameters for the NasJob NasTrial. + description: type: string - name: - description: Output only. Resource name of the NasTrialDetail. + description: Description of the Context + updateTime: + description: Output only. Timestamp when this Context was last updated. + format: google-datetime readOnly: true type: string - searchTrial: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - description: The requested search NasTrial. - type: object - GoogleCloudAiplatformV1ComputeTokensResponse: - type: object - description: Response message for ComputeTokens RPC call. - id: GoogleCloudAiplatformV1ComputeTokensResponse - properties: - tokensInfo: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TokensInfo' + displayName: + type: string description: >- - Lists of tokens info from the input. A ComputeTokensRequest could - have multiple instances with a prompt in each instance. We also need - to return lists of tokens info for the request with multiple - instances. + User provided display name of the Context. May be up to 128 Unicode + characters. + parentContexts: + description: >- + Output only. A list of resource names of Contexts that are parents + of this Context. A Context may have at most 10 parent_contexts. + readOnly: true + items: + type: string type: array - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: + createTime: + type: string + description: Output only. Timestamp when this Context was created. + readOnly: true + format: google-datetime + labels: + type: object + description: >- + The labels with user-defined metadata to organize your Contexts. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Context (System + labels are excluded). + additionalProperties: + type: string + name: + description: Immutable. The resource name of the Context. + type: string + schemaTitle: + type: string + description: >- + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + metadata: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: >- + Properties of the Context. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + etag: + description: >- + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + type: string + schemaVersion: + description: >- + The version of the schema in schema_name to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + type: string + type: object + id: GoogleCloudAiplatformV1Context + description: Instance of a general context. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: type: object + description: Metrics for image object detection evaluation results. id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics properties: - f1ScoreMicro: - format: float - type: number - description: Micro-averaged F1 Score. - f1Score: - description: >- - The harmonic mean of recall and precision. For summary metrics, it - computes the micro-averaged F1 score. - type: number - format: float - maxPredictions: + boundingBoxMetrics: description: >- - Metrics are computed with an assumption that the Model always - returns at most this many predictions (ordered by their score, - descendingly), but they all still need to meet the - `confidenceThreshold`. + The bounding boxes match metrics for each intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + evaluatedBoundingBoxCount: format: int32 type: integer - recall: - format: float - description: Recall (True Positive Rate) for the given confidence threshold. - type: number - confidenceThreshold: - type: number description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. - format: float - falseNegativeCount: - type: string - format: int64 + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. + boundingBoxMeanAveragePrecision: description: >- - The number of ground truth labels that are not matched by a Model - created label. - falsePositiveRate: - type: number - format: float - description: False Positive Rate for the given confidence threshold. - truePositiveCount: - type: string - description: The number of Model created labels that match a ground truth label. - format: int64 - f1ScoreAt1: - type: number - description: The harmonic mean of recallAt1 and precisionAt1. - format: float - precision: + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all + `boundingBoxMetricsEntries`. format: float type: number - description: Precision for the given confidence threshold. - recallAt1: - description: >- - The Recall (True Positive Rate) when only considering the label that - has the highest prediction score and not below the confidence - threshold for each DataItem. - type: number - format: float - trueNegativeCount: + GoogleCloudAiplatformV1ImportFeatureValuesResponse: + id: GoogleCloudAiplatformV1ImportFeatureValuesResponse + type: object + properties: + invalidRowCount: + type: string description: >- - The number of labels that were not created by the Model, but if they - would, they would not match a ground truth label. + The number of rows in input source that weren't imported due to + either * Not having any featureValues. * Having a null entityId. * + Having a null timestamp. * Not being parsable (applicable for CSV + sources). + format: int64 + importedFeatureValueCount: + description: Number of Feature values that have been imported by the operation. type: string format: int64 - f1ScoreMacro: - description: Macro-averaged F1 Score. - type: number - format: float - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: Confusion matrix of the evaluation for this confidence_threshold. - falsePositiveCount: - description: >- - The number of Model created labels that do not match a ground truth - label. + importedEntityCount: format: int64 type: string - falsePositiveRateAt1: - type: number - format: float - description: >- - The False Positive Rate when only considering the label that has the - highest prediction score and not below the confidence threshold for - each DataItem. - precisionAt1: - type: number + description: Number of entities that have been imported by the operation. + timestampOutsideRetentionRowsCount: + type: string + format: int64 description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - DataItem. - format: float - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask - properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata - description: The metadata information. - inputs: - description: The input parameters of this HyperparameterTuningTask. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec - type: object - description: A TrainingJob that tunes Hypererparameters of a custom code Model. - GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: - description: >- - Runtime operation information for - SpecialistPoolService.CreateSpecialistPool. + The number rows that weren't ingested due to having feature + timestamps outside the retention boundary. + description: Response message for FeaturestoreService.ImportFeatureValues. + GoogleCloudAiplatformV1BatchDedicatedResources: type: object - id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1ThresholdConfig: - description: The config for feature monitoring threshold. + id: GoogleCloudAiplatformV1BatchDedicatedResources properties: - value: - format: double + maxReplicaCount: + type: integer description: >- - Specify a threshold value that can trigger the alert. If this - threshold config is for feature distribution distance: 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. Each feature - must have a non-zero threshold if they need to be monitored. - Otherwise no alert will be triggered for that feature. - type: number - id: GoogleCloudAiplatformV1ThresholdConfig - type: object - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: - type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - properties: - uri: - type: string + Immutable. The maximum number of machine replicas the batch + operation may be scaled to. The default value is 10. + format: int32 + machineSpec: + description: Required. Immutable. The specification of a single machine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + startingReplicaCount: + type: integer description: >- - The URI of a BigQuery table. e.g. - bq://projectId.bqDatasetId.bqTableId - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse - type: object + Immutable. The number of machine replicas used at the start of the + batch operation. If not set, Vertex AI decides starting number, not + greater than max_replica_count + format: int32 description: >- - Response message for - TensorboardService.BatchCreateTensorboardTimeSeries. - properties: - tensorboardTimeSeries: - description: The created TensorboardTimeSeries. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - GoogleCloudAiplatformV1ModelGardenSource: + A description of resources that are used for performing batch + operations, are dedicated to a Model, and need manual configuration. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs properties: - publicModelName: + disableEarlyStopping: + type: boolean + description: >- + Use the entire training budget. This disables the early stopping + feature. When false the early stopping feature is enabled, which + means that AutoML Image Object Detection might stop training before + the entire training budget has been used. + uptrainBaseModelId: type: string - description: Required. The model garden source model resource name. + description: >- + The ID of `base` model for upTraining. If it is specified, the new + model will be upTrained based on the `base` model for upTraining. + Otherwise, the new model will be trained from scratch. The `base` + model for upTraining must be in the same Project and Location as the + new Model to train, and have the same modelType. + modelType: + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to have a higher latency, but should + also have a higher prediction quality than other cloud models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to have a low latency, but may have + lower prediction quality than other cloud models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Compared to the CLOUD_HIGH_ACCURACY_1 and + CLOUD_LOW_LATENCY_1 models above, it is expected to have higher + prediction quality and lower latency. + - >- + A model that, in addition to being available within Google Cloud + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. Expected to have + low latency, but may have lower prediction quality than other + mobile models. + - >- + A model that, in addition to being available within Google Cloud + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) and used on a + mobile or edge device with TensorFlow afterwards. Expected to have + a higher latency, but should also have a higher prediction quality + than other mobile models. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Expected to best support predictions in + streaming with lower latency and lower prediction quality than + other cloud models. + - >- + SpineNet for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + YOLO for Model Garden training with customizable hyperparameters. + Best tailored to be used within Google Cloud, and cannot be + exported externally. + type: string + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD_HIGH_ACCURACY_1 + - CLOUD_LOW_LATENCY_1 + - CLOUD_1 + - MOBILE_TF_LOW_LATENCY_1 + - MOBILE_TF_VERSATILE_1 + - MOBILE_TF_HIGH_ACCURACY_1 + - CLOUD_STREAMING_1 + - SPINENET + - YOLO + budgetMilliNodeHours: + description: >- + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. For modelType + `cloud`(default), the budget must be between 20,000 and 900,000 + milli node hours, inclusive. The default value is 216,000 which + represents one day in wall time, considering 9 nodes are used. For + model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, + `mobile-tf-high-accuracy-1` the training budget must be between + 1,000 and 100,000 milli node hours, inclusive. The default value is + 24,000 which represents one day in wall time on a single node that + is used. + format: int64 + type: string + tunableParameter: + description: Trainer type for Vision TrainRequest. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + type: object + GoogleCloudAiplatformV1UpsertDatapointsResponse: + type: object + description: Response message for IndexService.UpsertDatapoints + id: GoogleCloudAiplatformV1UpsertDatapointsResponse + properties: {} + GoogleCloudAiplatformV1IndexDatapointNumericRestriction: + type: object description: >- - Contains information about the source of the models generated from Model - Garden. - id: GoogleCloudAiplatformV1ModelGardenSource + This field allows restricts to be based on numeric comparisons rather + than categorical tokens. + id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction + properties: + valueDouble: + description: Represents 64 bit float. + type: number + format: double + valueFloat: + description: Represents 32 bit float. + format: float + type: number + valueInt: + type: string + format: int64 + description: Represents 64 bit integer. + op: + enumDescriptions: + - Default value of the enum. + - Datapoints are eligible iff their value is < the query's. + - Datapoints are eligible iff their value is <= the query's. + - Datapoints are eligible iff their value is == the query's. + - Datapoints are eligible iff their value is >= the query's. + - Datapoints are eligible iff their value is > the query's. + - Datapoints are eligible iff their value is != the query's. + type: string + description: >- + This MUST be specified for queries and must NOT be specified for + datapoints. + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL + namespace: + description: 'The namespace of this restriction. e.g.: cost.' + type: string + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: + description: Model metadata specific to AutoML Tables. + properties: + evaluatedDataItemsBigqueryUri: + description: BigQuery destination uri for exported evaluated examples. + type: string + trainCostMilliNodeHours: + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + format: int64 + type: string + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata type: object GoogleCloudAiplatformV1BatchPredictionJob: + id: GoogleCloudAiplatformV1BatchPredictionJob + type: object description: >- A job that uses a Model to produce predictions on multiple input instances. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances. - id: GoogleCloudAiplatformV1BatchPredictionJob - type: object properties: - startTime: + createTime: + readOnly: true + format: google-datetime + type: string + description: Output only. Time when the BatchPredictionJob was created. + disableContainerLogging: + type: boolean description: >- - Output only. Time when the BatchPredictionJob for the first time - entered the `JOB_STATE_RUNNING` state. + For custom-trained Models and AutoML Tabular Models, the container + of the DeployedModel instances will send `stderr` and `stdout` + streams to Cloud Logging by default. Please note that the logs incur + cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. + completionStats: + description: >- + Output only. Statistics on completed and failed prediction + instances. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' + displayName: type: string + description: Required. The user-defined name of this BatchPredictionJob. + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + labels: + description: >- + The labels with user-defined metadata to organize + BatchPredictionJobs. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. + type: object + additionalProperties: + type: string + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Only populated when the job's state is JOB_STATE_FAILED + or JOB_STATE_CANCELLED. readOnly: true - format: google-datetime generateExplanation: type: boolean description: >- @@ -1040,24 +1145,6 @@ components: for CSV format is not supported. If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated. - outputInfo: - readOnly: true - description: Output only. Information further describing the output of this job. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo - outputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputConfig - description: >- - Required. The Configuration specifying where output predictions - should be written. The schema of any single prediction may be - specified as a concatenation of Model's PredictSchemata's - instance_schema_uri and prediction_schema_uri. - createTime: - format: google-datetime - type: string - description: Output only. Time when the BatchPredictionJob was created. - readOnly: true explanationSpec: $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' description: >- @@ -1067,12 +1154,22 @@ components: explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited. - instanceConfig: + serviceAccount: description: >- - Configuration for how to convert batch prediction input instances to - the prediction instances that are sent to the Model. + The service account that the DeployedModel's container runs as. If + not specified, a system generated one will be used, which has + minimal permissions and the custom container, if used, may not have + enough permission to access other Google Cloud resources. Users + deploying the Model must have the `iam.serviceAccounts.actAs` + permission on this service account. + type: string + manualBatchTuningParameters: + description: >- + Immutable. Parameters configuring the batch behavior. Currently only + applicable when dedicated_resources are used (in other cases Vertex + AI does the tuning itself). $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + #/components/schemas/GoogleCloudAiplatformV1ManualBatchTuningParameters dedicatedResources: description: >- The config of resources used by the Model during the batch @@ -1080,21 +1177,20 @@ components: may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided. $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchDedicatedResources' - updateTime: + resourcesConsumed: description: >- - Output only. Time when the BatchPredictionJob was most recently - updated. + Output only. Information about resources that had been consumed by + this job. Provided in real time at best effort basis, as well as a + final value once the job completes. Note: This field currently may + be not populated for batch predictions that use AutoML Models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' + readOnly: true + name: + description: Output only. Resource name of the BatchPredictionJob. readOnly: true type: string - format: google-datetime - manualBatchTuningParameters: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ManualBatchTuningParameters - description: >- - Immutable. Parameters configuring the batch behavior. Currently only - applicable when dedicated_resources are used (in other cases Vertex - AI does the tuning itself). model: + type: string description: >- The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job @@ -1108,45 +1204,60 @@ components: model resource could also be a publisher model. Example: `publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` + endTime: type: string - serviceAccount: + readOnly: true description: >- - The service account that the DeployedModel's container runs as. If - not specified, a system generated one will be used, which has - minimal permissions and the custom container, if used, may not have - enough permission to access other Google Cloud resources. Users - deploying the Model must have the `iam.serviceAccounts.actAs` - permission on this service account. + Output only. Time when the BatchPredictionJob entered any of the + following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + format: google-datetime + unmanagedContainerModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UnmanagedContainerModel' + description: >- + Contains model information necessary to perform batch prediction + without requiring uploading to model registry. Exactly one of model + and unmanaged_container_model must be set. + updateTime: + readOnly: true + format: google-datetime + description: >- + Output only. Time when the BatchPredictionJob was most recently + updated. type: string - completionStats: + instanceConfig: + description: >- + Configuration for how to convert batch prediction input instances to + the prediction instances that are sent to the Model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + outputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + description: >- + Required. The Configuration specifying where output predictions + should be written. The schema of any single prediction may be + specified as a concatenation of Model's PredictSchemata's + instance_schema_uri and prediction_schema_uri. + outputInfo: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + description: Output only. Information further describing the output of this job. readOnly: true + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInputConfig description: >- - Output only. Statistics on completed and failed prediction - instances. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompletionStats' - endTime: + Required. Input configuration of the instances on which predictions + are performed. The schema of any single instance may be specified + via the Model's PredictSchemata's instance_schema_uri. + modelVersionId: + description: >- + Output only. The version ID of the Model that produces the + predictions via this job. readOnly: true type: string - format: google-datetime - description: >- - Output only. Time when the BatchPredictionJob entered any of the - following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. state: - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - readOnly: true type: string enumDescriptions: - The job state is unspecified. @@ -1171,72 +1282,24 @@ components: The job is partially succeeded, some results may be missing due to errors. description: Output only. The detailed state of the job. - disableContainerLogging: - type: boolean - description: >- - For custom-trained Models and AutoML Tabular Models, the container - of the DeployedModel instances will send `stderr` and `stdout` - streams to Cloud Logging by default. Please note that the logs incur - cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - error: - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. Only populated when the job's state is JOB_STATE_FAILED - or JOB_STATE_CANCELLED. - modelVersionId: - type: string - description: >- - Output only. The version ID of the Model that produces the - predictions via this job. - readOnly: true - unmanagedContainerModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UnmanagedContainerModel' - description: >- - Contains model information necessary to perform batch prediction - without requiring uploading to model registry. Exactly one of model - and unmanaged_container_model must be set. - labels: - additionalProperties: - type: string - type: object - description: >- - The labels with user-defined metadata to organize - BatchPredictionJobs. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key options for a BatchPredictionJob. If - this is set, then all resources created by the BatchPredictionJob - will be encrypted with the provided encryption key. - inputConfig: - description: >- - Required. Input configuration of the instances on which predictions - are performed. The schema of any single instance may be specified - via the Model's PredictSchemata's instance_schema_uri. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchPredictionJobInputConfig - name: readOnly: true - description: Output only. Resource name of the BatchPredictionJob. - type: string - resourcesConsumed: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcesConsumed' - description: >- - Output only. Information about resources that had been consumed by - this job. Provided in real time at best effort basis, as well as a - final value once the job completes. Note: This field currently may - be not populated for batch predictions that use AutoML Models. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean readOnly: true - displayName: - description: Required. The user-defined name of this BatchPredictionJob. - type: string partialFailures: type: array readOnly: true @@ -1247,3628 +1310,3794 @@ components: that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details. modelParameters: - type: any description: >- The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri. - GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: - properties: - notebookRuntimeTemplate: + type: any + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key options for a BatchPredictionJob. If + this is set, then all resources created by the BatchPredictionJob + will be encrypted with the provided encryption key. + startTime: + format: google-datetime type: string - description: Immutable. A resource name of the NotebookRuntimeTemplate. - id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + readOnly: true + description: >- + Output only. Time when the BatchPredictionJob for the first time + entered the `JOB_STATE_RUNNING` state. + GoogleCloudAiplatformV1ExportModelOperationMetadata: type: object - description: Points to a NotebookRuntimeTemplateRef. - GoogleCloudAiplatformV1ListModelsResponse: - description: Response message for ModelService.ListModels - id: GoogleCloudAiplatformV1ListModelsResponse + id: GoogleCloudAiplatformV1ExportModelOperationMetadata + description: Details of ModelService.ExportModel operation. properties: - models: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - description: List of Models in the requested page. - type: array - nextPageToken: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + outputInfo: description: >- - A token to retrieve next page of results. Pass to - ListModelsRequest.page_token to obtain that page. - type: string + Output only. Information further describing the output of this Model + export. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo + GoogleCloudAiplatformV1Tensorboard: type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset: properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: >- - The Google Cloud Storage uri of the unmanaged Dataset used to train - this Model. - dataset: - description: The resource name of the Dataset used to train this Model. + runCount: + description: Output only. The number of Runs stored in this Tensorboard. + readOnly: true + type: integer + format: int32 + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + createTime: type: string - loggingSamplingStrategy: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' - description: >- - Strategy to sample data from Training Dataset. If not set, we - process the whole dataset. - dataFormat: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this Tensorboard was created. + description: + description: Description of this Tensorboard. type: string + isDefault: description: >- - Data format of the dataset, only applicable if the input is from - Google Cloud Storage. The possible formats are: "tf-record" The - source file is a TFRecord file. "csv" The source file is a CSV file. - "jsonl" The source file is a JSONL file. - targetField: + Used to indicate if the TensorBoard instance is the default one. + Each project & region can have at most one default TensorBoard + instance. Creation of a default TensorBoard instance and updating an + existing TensorBoard instance to be default will mark all other + TensorBoard instances (if any) as non default. + type: boolean + name: + readOnly: true type: string description: >- - The target field name the model is to predict. This field will be - excluded when doing Predict and (or) Explain for the training data. - bigquerySource: - description: >- - The BigQuery table of the unmanaged Dataset used to train this - Model. - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: Training Dataset information. - type: object - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset - GoogleCloudAiplatformV1PredictRequest: - id: GoogleCloudAiplatformV1PredictRequest - type: object - description: Request message for PredictionService.Predict. - properties: - instances: - items: - type: any - description: >- - Required. The instances that are the input to the prediction call. A - DeployedModel may have an upper limit on the number of instances it - supports per request, and when it is exceeded the prediction call - errors in case of AutoML Models, or, in case of customer created - Models, the behaviour is as documented by that Model. The schema of - any single instance may be specified via Endpoint's DeployedModels' - Model's PredictSchemata's instance_schema_uri. - type: array - parameters: + Output only. Name of the Tensorboard. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + displayName: + type: string + description: Required. User provided name of this Tensorboard. + encryptionSpec: description: >- - The parameters that govern the prediction. The schema of the - parameters may be specified via Endpoint's DeployedModels' Model's - PredictSchemata's parameters_schema_uri. - type: any - GoogleCloudAiplatformV1AddContextChildrenResponse: - description: Response message for MetadataService.AddContextChildren. - id: GoogleCloudAiplatformV1AddContextChildrenResponse - properties: {} - type: object - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: - type: object - description: Represents a metric to optimize. - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec - properties: - goal: - description: Required. The optimization goal of the metric. + Customer-managed encryption key spec for a Tensorboard. If set, this + Tensorboard and all sub-resources of this Tensorboard will be + secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + blobStoragePathPrefix: + readOnly: true type: string - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. - enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - metricId: + description: >- + Output only. Consumer project Cloud Storage path prefix used to + store blob data, which can either be a bucket or directory. Does not + end with a '/'. + etag: type: string - description: Required. The ID of the metric. Must not contain whitespaces. - GoogleCloudAiplatformV1FeatureViewBigQuerySource: - id: GoogleCloudAiplatformV1FeatureViewBigQuerySource - type: object - properties: - uri: description: >- - Required. The BigQuery view URI that will be materialized on each - sync trigger based on FeatureView.SyncConfig. + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + updateTime: + format: google-datetime type: string - entityIdColumns: - description: Required. Columns to construct entity_id / row keys. - type: array - items: + readOnly: true + description: Output only. Timestamp when this Tensorboard was last updated. + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + labels: + type: object + description: >- + The labels with user-defined metadata to organize your Tensorboards. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Tensorboard + (System labels are excluded). See https://goo.gl/xmQnxf for more + information and examples of labels. System reserved label keys are + prefixed with "aiplatform.googleapis.com/" and are immutable. + additionalProperties: type: string - GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: - type: object + id: GoogleCloudAiplatformV1Tensorboard + description: >- + Tensorboard is a physical database that stores users' training metrics. + A default Tensorboard is provided in each region of a Google Cloud + project. If needed users can also create extra Tensorboards in their + projects. + GoogleCloudAiplatformV1BleuInstance: + id: GoogleCloudAiplatformV1BleuInstance properties: - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata - description: The metadata of Datasets that contain tables data. - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams - description: Prediction model parameters for Video Object Tracking. + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + prediction: + description: Required. Output of the evaluated model. + type: string + type: object + description: Spec for bleu instance. + GoogleCloudAiplatformV1ListTrialsResponse: type: object + description: Response message for VizierService.ListTrials. properties: - maxPredictions: - format: int32 - description: >- - The model only returns up to that many top, by confidence score, - predictions per frame of the video. If this number is very high, the - Model may return fewer predictions per frame. Default value is 50. - type: integer - minBoundingBoxSize: - description: >- - Only bounding boxes with shortest edge at least that long as a - relative value of video frame size are returned. Default value is - 0.0. - type: number - format: float - confidenceThreshold: - type: number + nextPageToken: + type: string description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - format: float - GoogleCloudAiplatformV1CitationMetadata: - properties: - citations: + Pass this token as the `page_token` field of the request for a + subsequent call. If this field is omitted, there are no subsequent + pages. + trials: + description: The Trials associated with the Study. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Citation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' type: array - readOnly: true - description: Output only. List of citations. - id: GoogleCloudAiplatformV1CitationMetadata - type: object - description: A collection of source attributions for a piece of content. - GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: + id: GoogleCloudAiplatformV1ListTrialsResponse + GoogleCloudAiplatformV1ReadFeatureValuesRequest: properties: - sourceField: - description: >- - Source column to get the Feature values from. If not set, uses the - column with the same name as the Feature ID. + entityId: type: string - id: description: >- - Required. ID of the Feature to import values of. This Feature must - exist in the target EntityType, or the request will fail. + Required. ID for a specific entity. For example, for a machine + learning model predicting user clicks on a website, an entity ID + could be `user_123`. + featureSelector: + description: Required. Selector choosing Features of the target EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + id: GoogleCloudAiplatformV1ReadFeatureValuesRequest + type: object + description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. + GoogleCloudAiplatformV1PredefinedSplit: + description: >- + Assigns input data to training, validation, and test sets based on the + value of a provided key. Supported only for tabular Datasets. + properties: + key: type: string - id: GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + description: >- + Required. The key is a name of one of the Dataset's data columns. + The value of the key (either the label's value or value in the + column) must be one of {`training`, `validation`, `test`}, and it + defines to which set the given piece of data is assigned. If for a + piece of data the key is not present or has an invalid value, that + piece is ignored by the pipeline. + id: GoogleCloudAiplatformV1PredefinedSplit type: object - description: Defines the Feature value(s) to import. - GoogleCloudAiplatformV1GenerateContentResponse: + GoogleCloudAiplatformV1ProbeExecAction: type: object - description: Response message for [PredictionService.GenerateContent]. + description: ExecAction specifies a command to execute. properties: - candidates: - readOnly: true - description: Output only. Generated candidates. + command: + description: >- + Command is the command line to execute inside the container, the + working directory for the command is root ('/') in the container's + filesystem. The command is simply exec'd, it is not run inside a + shell, so traditional shell instructions ('|', etc) won't work. To + use a shell, you need to explicitly call out to that shell. Exit + status of 0 is treated as live/healthy and non-zero is unhealthy. + items: + type: string + type: array + id: GoogleCloudAiplatformV1ProbeExecAction + GoogleCloudAiplatformV1ListExecutionsResponse: + properties: + executions: + description: The Executions retrieved from the MetadataStore. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' - usageMetadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - description: Usage metadata about the response(s). - promptFeedback: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + nextPageToken: + type: string description: >- - Output only. Content filter results for a prompt sent in the - request. Note: Sent only in the first stream chunk. Only happens - when no candidates were generated due to content violations. - id: GoogleCloudAiplatformV1GenerateContentResponse - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: + A token, which can be sent as ListExecutionsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. type: object - description: Per user usage data. - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData - properties: - username: - type: string - description: User's username - viewCount: - format: int64 - type: string - description: Number of times the user has read data within the Tensorboard. - GoogleCloudAiplatformV1Endpoint: - id: GoogleCloudAiplatformV1Endpoint + description: Response message for MetadataService.ListExecutions. + id: GoogleCloudAiplatformV1ListExecutionsResponse + GoogleCloudAiplatformV1AddContextChildrenResponse: type: object + description: Response message for MetadataService.AddContextChildren. + properties: {} + id: GoogleCloudAiplatformV1AddContextChildrenResponse + GoogleCloudAiplatformV1IndexEndpoint: description: >- - Models are deployed into it, and afterwards Endpoint is called to obtain - predictions and explanations. + Indexes are deployed into it. An IndexEndpoint can have multiple + DeployedIndexes. + id: GoogleCloudAiplatformV1IndexEndpoint + type: object properties: - etag: - type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - privateServiceConnectConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + Immutable. Customer-managed encryption key spec for an + IndexEndpoint. If set, this IndexEndpoint and all sub-resources of + this IndexEndpoint will be secured by this key. + network: description: >- - Optional. Configuration for private service connect. network and + Optional. The full name of the Google Compute Engine + [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) + to which the IndexEndpoint should be peered. Private services access + must already be configured for the network. If left unspecified, the + Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. - displayName: - description: >- - Required. The display name of the Endpoint. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - type: string - description: + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where {project} is a + project number, as in '12345', and {network} is network name. type: string - description: The description of the Endpoint. - modelDeploymentMonitoringJob: + displayName: type: string - readOnly: true description: >- - Output only. Resource name of the Model Monitoring job associated - with this Endpoint if monitoring is enabled by - JobService.CreateModelDeploymentMonitoringJob. Format: - `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - network: + Required. The display name of the IndexEndpoint. The name can be up + to 128 characters long and can consist of any UTF-8 characters. + publicEndpointDomainName: type: string description: >- - Optional. The full name of the Google Compute Engine - [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) - to which the Endpoint should be peered. Private services access must - already be configured for the network. If left unspecified, the - Endpoint is not peered with any network. Only one of the fields, - network or enable_private_service_connect, can be set. - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where `{project}` is - a project number, as in `12345`, and `{network}` is network name. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key spec for an Endpoint. If set, this - Endpoint and all sub-resources of this Endpoint will be secured by - this key. - deployedModels: + Output only. If public_endpoint_enabled is true, this field will be + populated with the domain name to use for this index endpoint. + readOnly: true + deployedIndexes: + description: Output only. The indexes deployed in this endpoint. readOnly: true items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' type: array + publicEndpointEnabled: + type: boolean description: >- - Output only. The models deployed in this Endpoint. To add or remove - DeployedModels use EndpointService.DeployModel and - EndpointService.UndeployModel respectively. - trafficSplit: - type: object + Optional. If true, the deployed index will be accessible through + public endpoint. + name: + type: string + readOnly: true + description: Output only. The resource name of the IndexEndpoint. + enablePrivateServiceConnect: description: >- - A map from a DeployedModel's ID to the percentage of this Endpoint's - traffic that should be forwarded to that DeployedModel. If a - DeployedModel's ID is not listed in this map, then it receives no - traffic. The traffic percentage values must add up to 100, or map - must be empty if the Endpoint is to not accept any traffic at a - moment. - additionalProperties: - format: int32 - type: integer + Optional. Deprecated: If true, expose the IndexEndpoint via private + service connect. Only one of the fields, network or + enable_private_service_connect, can be set. + type: boolean + deprecated: true + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + etag: + type: string + description: >- + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. labels: additionalProperties: type: string description: >- - The labels with user-defined metadata to organize your Endpoints. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. + The labels with user-defined metadata to organize your + IndexEndpoints. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. type: object - name: - type: string + satisfiesPzi: + type: boolean + description: Output only. Reserved for future use. readOnly: true - description: Output only. The resource name of the Endpoint. + privateServiceConnectConfig: + description: >- + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig createTime: - type: string + description: Output only. Timestamp when this IndexEndpoint was created. readOnly: true + type: string format: google-datetime - description: Output only. Timestamp when this Endpoint was created. - predictRequestResponseLoggingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig - description: Configures the request-response logging for online prediction. - enablePrivateServiceConnect: - type: boolean - deprecated: true - description: >- - Deprecated: If true, expose the Endpoint via private service - connect. Only one of the fields, network or - enable_private_service_connect, can be set. + description: + description: The description of the IndexEndpoint. + type: string updateTime: + description: >- + Output only. Timestamp when this IndexEndpoint was last updated. + This timestamp is not updated when the endpoint's DeployedIndexes + are updated, e.g. due to updates of the original Indexes they are + the deployments of. + type: string readOnly: true format: google-datetime - description: Output only. Timestamp when this Endpoint was last updated. - type: string - GoogleCloudAiplatformV1ListPipelineJobsResponse: - id: GoogleCloudAiplatformV1ListPipelineJobsResponse + GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue: type: object properties: - nextPageToken: - description: >- - A token to retrieve the next page of results. Pass to - ListPipelineJobsRequest.page_token to obtain that page. - type: string - pipelineJobs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' - description: List of PipelineJobs in the requested page. - type: array - description: Response message for PipelineService.ListPipelineJobs - GoogleCloudAiplatformV1GoogleSearchRetrieval: - description: Tool to retrieve public web data for grounding, powered by Google. + score: + description: Output only. Tool parameter key match score. + type: number + readOnly: true + format: float + id: GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue + description: Tool parameter key match metric value for an instance. + GoogleCloudAiplatformV1WorkerPoolSpec: type: object - properties: {} - id: GoogleCloudAiplatformV1GoogleSearchRetrieval - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: - description: Prediction model parameters for Image Classification. + description: Represents the spec of a worker pool in a job. + properties: + machineSpec: + description: Optional. Immutable. The specification of a single machine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + nfsMounts: + type: array + description: Optional. List of NFS mount spec. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' + diskSpec: + description: Disk spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + replicaCount: + description: Optional. The number of worker replicas to use for this worker pool. + type: string + format: int64 + containerSpec: + description: The custom container task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' + pythonPackageSpec: + description: The Python packaged task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' + id: GoogleCloudAiplatformV1WorkerPoolSpec + GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams properties: - confidenceThreshold: - format: float + startTime: + type: string + format: google-datetime description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - type: number - maxPredictions: + Excludes Feature values with feature generation timestamp before + this timestamp. If not set, retrieve oldest values kept in Feature + Store. Timestamp, if present, must not have higher than millisecond + precision. + endTime: + type: string + format: google-datetime description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. If this number is very high, the Model may - return fewer predictions. Default value is 10. - type: integer - format: int32 - GoogleCloudAiplatformV1PurgeArtifactsResponse: + Exports Feature values as of this timestamp. If not set, retrieve + values as of now. Timestamp, if present, must not have higher than + millisecond precision. + description: >- + Describes exporting all historical Feature values of all entities of the + EntityType between [start_time, end_time]. + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport + GoogleCloudAiplatformV1Part: + id: GoogleCloudAiplatformV1Part type: object properties: - purgeCount: - format: int64 - type: string + videoMetadata: description: >- - The number of Artifacts that this request deleted (or, if `force` is - false, the number of Artifacts that will be deleted). This can be an - estimate. - purgeSample: - type: array - items: - type: string + Optional. Video metadata. The metadata should only be specified + while the video data is presented in inline_data or file_data. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' + functionCall: description: >- - A sample of the Artifact names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). - description: Response message for MetadataService.PurgeArtifacts. - id: GoogleCloudAiplatformV1PurgeArtifactsResponse - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: + Optional. A predicted [FunctionCall] returned from the model that + contains a string representing the [FunctionDeclaration.name] with + the parameters and their values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' + inlineData: + description: Optional. Inlined bytes data. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' + text: + description: Optional. Text part (can be code). + type: string + functionResponse: + description: >- + Optional. The result output of a [FunctionCall] that contains a + string representing the [FunctionDeclaration.name] and a structured + JSON object containing any output from the function call. It is used + as context to the model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' + fileData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' + description: Optional. URI based data. + description: >- + A datatype containing media that is part of a multi-part `Content` + message. A `Part` consists of data which has an associated datatype. A + `Part` can only contain one of the accepted types in `Part.data`. A + `Part` must have a fixed IANA MIME type identifying the type and subtype + of the media if `inline_data` or `file_data` field is filled with raw + bytes. + GoogleCloudAiplatformV1NasTrialDetail: properties: - searchTrialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + searchTrial: + description: The requested search NasTrial. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + parameters: + type: string + description: The parameters for the NasJob NasTrial. + trainTrial: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' description: >- - Required. The spec of a search trial job. The same spec applies to - all search trials. - maxParallelTrialCount: - format: int32 - description: Required. The maximum number of trials to run in parallel. + The train NasTrial corresponding to search_trial. Only populated if + search_trial is used for training. + name: + type: string + description: Output only. Resource name of the NasTrialDetail. + readOnly: true + type: object + description: >- + Represents a NasTrial details along with its parameters. If there is a + corresponding train NasTrial, the train NasTrial is also returned. + id: GoogleCloudAiplatformV1NasTrialDetail + GoogleCloudAiplatformV1ExamplesOverride: + properties: + neighborCount: type: integer - maxTrialCount: + description: The number of neighbors to return. + format: int32 + restrictions: + type: array description: >- - Required. The maximum number of Neural Architecture Search (NAS) - trials to run. + Restrict the resulting nearest neighbors to respect these + constraints. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + crowdingCount: type: integer format: int32 - maxFailedTrialCount: - format: int32 - type: integer - description: >- - The number of failed trials that need to be seen before failing the - NasJob. If set to 0, Vertex AI decides how many trials must fail - before the whole job fails. - description: Represent spec for search trials. - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + description: The number of neighbors to return that have the same crowding tag. + dataFormat: + enumDescriptions: + - Unspecified format. Must not be used. + - Provided data is a set of model inputs. + - Provided data is a set of embeddings. + enum: + - DATA_FORMAT_UNSPECIFIED + - INSTANCES + - EMBEDDINGS + type: string + description: The format of the data being provided with each call. + returnEmbeddings: + type: boolean + description: If true, return the embeddings instead of neighbors. type: object + id: GoogleCloudAiplatformV1ExamplesOverride + description: Overrides for example-based explanations. + GoogleCloudAiplatformV1IntegratedGradientsAttribution: + id: GoogleCloudAiplatformV1IntegratedGradientsAttribution description: >- - Treats the column as numerical array and performs following - transformation functions. * All transformations for Numerical types - applied to the average of the all elements. * The average of empty - arrays is treated as zero. + An attribution method that computes the Aumann-Shapley value taking + advantage of the model's fully differentiable structure. Refer to this + paper for more details: https://arxiv.org/abs/1703.01365 properties: - columnName: - type: string - invalidValuesAllowed: - type: boolean + blurBaselineConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. - GoogleCloudAiplatformV1IndexDatapoint: - id: GoogleCloudAiplatformV1IndexDatapoint + Config for IG with blur baseline. When enabled, a linear path from + the maximally blurred image to the input image is created. Using a + blurred baseline instead of zero (black image) is motivated by the + BlurIG approach explained here: https://arxiv.org/abs/2004.03383 + smoothGradConfig: + description: >- + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy + samples in the vicinity of the inputs. Adding noise can help improve + the computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' + stepCount: + description: >- + Required. The number of steps for approximating the path integral. A + good value to start is 50 and gradually increase until the sum to + diff property is within the desired error range. Valid range of its + value is [1, 100], inclusively. + type: integer + format: int32 type: object - description: A datapoint of Index. + GoogleCloudAiplatformV1IdMatcher: properties: - featureVector: - description: >- - Required. Feature embedding vector for dense index. An array of - numbers with the length of [NearestNeighborSearchConfig.dimensions]. - items: - type: number - format: float - type: array - restricts: + ids: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction + type: string description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses categorical - tokens. See: - https://cloud.google.com/vertex-ai/docs/matching-engine/filtering + Required. The following are accepted as `ids`: * A single-element + list containing only `*`, which selects all Features in the target + EntityType, or * A list containing only Feature IDs, which selects + only Features with those IDs in the target EntityType. type: array - datapointId: - description: Required. Unique identifier of the datapoint. + type: object + id: GoogleCloudAiplatformV1IdMatcher + description: Matcher for Features of an EntityType by Feature ID. + GoogleCloudAiplatformV1MetadataSchema: + properties: + schemaType: type: string - numericRestricts: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction + enumDescriptions: + - Unspecified type for the MetadataSchema. + - >- + A type indicating that the MetadataSchema will be used by + Artifacts. + - >- + A typee indicating that the MetadataSchema will be used by + Executions. + - >- + A state indicating that the MetadataSchema will be used by + Contexts. + enum: + - METADATA_SCHEMA_TYPE_UNSPECIFIED + - ARTIFACT_TYPE + - EXECUTION_TYPE + - CONTEXT_TYPE description: >- - Optional. List of Restrict of the datapoint, used to perform - "restricted searches" where boolean rule are used to filter the - subset of the database eligible for matching. This uses numeric - comparisons. + The type of the MetadataSchema. This is a property that identifies + which metadata types will use the MetadataSchema. + schema: + description: >- + Required. The raw YAML string representation of the MetadataSchema. + The combination of [MetadataSchema.version] and the schema name + given by `title` in [MetadataSchema.schema] must be unique within a + MetadataStore. The schema is defined as an OpenAPI 3.0.2 + [MetadataSchema + Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) + type: string + description: + description: Description of the Metadata Schema + type: string + schemaVersion: + description: >- + The version of the MetadataSchema. The version's format must match + the following regular expression: `^[0-9]+.+.+$`, which would allow + to order/compare different versions. Example: 1.0.0, 1.0.1, etc. + type: string + name: + description: Output only. The resource name of the MetadataSchema. + type: string + readOnly: true + createTime: + format: google-datetime + description: Output only. Timestamp when this MetadataSchema was created. + type: string + readOnly: true + id: GoogleCloudAiplatformV1MetadataSchema + type: object + description: Instance of a general MetadataSchema. + GoogleCloudAiplatformV1SummarizationVerbosityResult: + properties: + confidence: + readOnly: true + type: number + format: float + description: Output only. Confidence for summarization verbosity score. + explanation: + description: Output only. Explanation for summarization verbosity score. + readOnly: true + type: string + score: + format: float + readOnly: true + description: Output only. Summarization Verbosity score. + type: number + description: Spec for summarization verbosity result. + id: GoogleCloudAiplatformV1SummarizationVerbosityResult + type: object + GoogleCloudAiplatformV1BleuResults: + id: GoogleCloudAiplatformV1BleuResults + description: Results for bleu metric. + type: object + properties: + bleuMetricValues: type: array - sparseEmbedding: - description: Optional. Feature embedding vector for sparse index. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - crowdingTag: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuMetricValue' + readOnly: true + description: Output only. Bleu metric values. + CloudAiLargeModelsVisionImage: + type: object + description: Image. + properties: + image: + format: byte + description: Raw bytes. + type: string + encoding: + type: string + description: Image encoding, encoded as "image/png" or "image/jpg". + generationSeed: + format: int32 description: >- - Optional. CrowdingTag of the datapoint, the number of neighbors to - return in each crowding can be configured during query. - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + Generation seed for the sampled image. This parameter is exposed to + the user only if one of the following is true: 1. The user specified + per-example seeds in the request. 2. The user doesn't specify the + generation seed in the request. + type: integer + imageRaiScores: + $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' + description: RAI scores for generated image. + uri: + type: string + description: Path to another storage (typically Google Cloud Storage). + raiInfo: + description: RAI info for image. + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' + semanticFilterResponse: + $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' + description: Semantic filter info for image. + text: + type: string + description: Text/Expanded text input for imagen. + id: CloudAiLargeModelsVisionImage + GoogleCloudAiplatformV1DeleteFeatureValuesResponse: + description: Response message for FeaturestoreService.DeleteFeatureValues. type: object + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse + properties: + selectTimeRangeAndFeature: + description: Response for request specifying time range and feature + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature + selectEntity: + description: Response for request specifying the entities to delete + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: description: >- - The time series Dataset's data source. The Dataset doesn't store the - data directly, but only pointer(s) to its data. + The tables Dataset's data source. The Dataset doesn't store the data + directly, but only pointer(s) to its data. properties: bigquerySource: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource gcsSource: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult: + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig type: object - id: >- - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult - description: >- - Represents a partial result in batch migration operation for one - MigrateResourceRequest. + GoogleCloudAiplatformV1SchemaTextDatasetMetadata: + description: The metadata of Datasets that contain Text DataItems. + id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The error result of the migration request in case of failure. - request: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' - description: >- - It's the same as the value in - MigrateResourceRequest.migrate_resource_requests. - dataset: - description: Migrated dataset resource name. + dataItemSchemaUri: type: string - model: - description: Migrated model resource name. + description: >- + Points to a YAML file stored on Google Cloud Storage describing + payload of the Text DataItems that belong to this Dataset. + gcsBucket: type: string - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: - description: >- - Message to select entity. If an entity id is selected, all the feature - values corresponding to the entity id will be deleted, including the - entityId. - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + description: >- + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. type: object + GoogleCloudAiplatformV1ReadIndexDatapointsResponse: properties: - entityIdSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' - description: >- - Required. Selectors choosing feature values of which entity id to be - deleted from the EntityType. - GoogleCloudAiplatformV1MeasurementMetric: - description: A message representing a metric in the measurement. + datapoints: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: The result list of datapoints. type: object - id: GoogleCloudAiplatformV1MeasurementMetric + description: The response message for MatchService.ReadIndexDatapoints. + id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse + GoogleCloudAiplatformV1PredictSchemata: + type: object + id: GoogleCloudAiplatformV1PredictSchemata + description: >- + Contains the schemata used in Model's predictions and explanations via + PredictionService.Predict, PredictionService.Explain and + BatchPredictionJob. properties: - value: - format: double - readOnly: true - description: Output only. The value for this metric. - type: number - metricId: - readOnly: true + predictionSchemaUri: description: >- - Output only. The ID of the Metric. The Metric should be defined in - StudySpec's Metrics. + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the format of a single prediction produced by this Model, + which are returned via PredictResponse.predictions, + ExplainResponse.explanations, and BatchPredictionJob.output_config. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. type: string - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: + instanceSchemaUri: + type: string + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the format of a single instance, which are used in + PredictRequest.instances, ExplainRequest.instances and + BatchPredictionJob.input_config. The schema is defined as an OpenAPI + 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. + parametersSchemaUri: + type: string + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing the parameters of prediction and explanation via + PredictRequest.parameters, ExplainRequest.parameters and + BatchPredictionJob.model_parameters. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI, if no + parameters are supported, then it is set to an empty string. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. + GoogleCloudAiplatformV1ListArtifactsResponse: + id: GoogleCloudAiplatformV1ListArtifactsResponse + description: Response message for MetadataService.ListArtifacts. properties: nextPageToken: description: >- - The page token that can be used by the next - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + A token, which can be sent as ListArtifactsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. type: string - monitoringStats: + artifacts: type: array - description: >- - Stats retrieved for requested objectives. There are at most 1000 - ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats - in the response. + description: The Artifacts retrieved from the MetadataStore. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse - description: >- - Response message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' type: object - GoogleCloudAiplatformV1DeployModelRequest: - description: Request message for EndpointService.DeployModel. - id: GoogleCloudAiplatformV1DeployModelRequest + GoogleTypeInterval: + type: object + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + id: GoogleTypeInterval properties: - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + startTime: + type: string + format: google-datetime description: >- - Required. The DeployedModel to be created within the Endpoint. Note - that Endpoint.traffic_split must be updated for the DeployedModel to - start receiving traffic, either as part of this call, or via - EndpointService.UpdateEndpoint. - trafficSplit: + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. + endTime: + type: string + format: google-datetime description: >- - A map from a DeployedModel's ID to the percentage of this Endpoint's - traffic that should be forwarded to that DeployedModel. If this - field is non-empty, then the Endpoint's traffic_split will be - overwritten with it. To refer to the ID of the just being deployed - Model, a "0" should be used, and the actual ID of the new - DeployedModel will be filled in its place by this method. The - traffic percentage values must add up to 100. If this field is - empty, then the Endpoint's traffic_split is not updated. - type: object - additionalProperties: - type: integer - format: int32 + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + GoogleCloudAiplatformV1ExportFilterSplit: + id: GoogleCloudAiplatformV1ExportFilterSplit type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + description: >- + Assigns input data to training, validation, and test sets based on the + given filters, data pieces not matched by any filter are ignored. + Currently only supported for Datasets containing DataItems. If any of + the filters in this message are to match nothing, then they can be set + as '-' (the minus sign). Supported only for unstructured Datasets. properties: - unit: - description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" + validationFilter: type: string - quantity: - format: int64 description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to validate the Model. A filter with same + syntax as the one used in DatasetService.ListDataItems may be used. + If a single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + trainingFilter: + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to train the Model. A filter with same syntax + as the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. type: string - description: A duration of time expressed in time granularity units. - type: object - GoogleCloudAiplatformV1ImportDataOperationMetadata: - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - id: GoogleCloudAiplatformV1ImportDataOperationMetadata - description: Runtime operation information for DatasetService.ImportData. - GoogleCloudAiplatformV1PredictResponse: - id: GoogleCloudAiplatformV1PredictResponse + testFilter: + description: >- + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to test the Model. A filter with same syntax as + the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + type: string + GoogleCloudAiplatformV1PersistentResource: type: object - description: Response message for PredictionService.Predict. properties: - modelVersionId: - description: >- - Output only. The version ID of the Model which is deployed as the - DeployedModel that this prediction hits. + updateTime: + format: google-datetime type: string readOnly: true - metadata: description: >- - Output only. Request-level metadata returned by the model. The - metadata type will be dependent upon the model implementation. - type: any + Output only. Time when the PersistentResource was most recently + updated. + resourcePools: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' + type: array + description: Required. The spec of the pools of different resources. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Only populated when persistent resource's state is + `STOPPING` or `ERROR`. readOnly: true - model: - type: string + satisfiesPzs: readOnly: true + description: Output only. Reserved for future use. + type: boolean + displayName: description: >- - Output only. The resource name of the Model which is deployed as the - DeployedModel that this prediction hits. - predictions: - type: array - items: - type: any + Optional. The display name of the PersistentResource. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. + type: string + network: + type: string description: >- - The predictions that are the output of the predictions call. The - schema of any single prediction may be specified via Endpoint's - DeployedModels' Model's PredictSchemata's prediction_schema_uri. - modelDisplayName: + Optional. The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to peered + with Vertex AI to host the persistent resources. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + To specify this field, you must have already [configured VPC Network + Peering for Vertex + AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If + this field is left unspecified, the resources aren't peered with any + network. + resourceRuntimeSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' description: >- - Output only. The display name of the Model which is deployed as the - DeployedModel that this prediction hits. + Optional. Persistent Resource runtime spec. For example, used for + Ray cluster configuration. + createTime: + description: Output only. Time when the PersistentResource was created. + format: google-datetime type: string readOnly: true - deployedModelId: + resourceRuntime: + description: Output only. Runtime information of the Persistent Resource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' + readOnly: true + state: + readOnly: true + description: Output only. The detailed state of a Study. type: string - description: ID of the Endpoint's DeployedModel that served this prediction. - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: - properties: - type: - enum: - - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED - - RAW_FEATURE_SKEW - - RAW_FEATURE_DRIFT - - FEATURE_ATTRIBUTION_SKEW - - FEATURE_ATTRIBUTION_DRIFT enumDescriptions: - - Default value, should not be set. + - Not set. - >- - Raw feature values' stats to detect skew between - Training-Prediction datasets. + The PROVISIONING state indicates the persistent resources is being + created. - >- - Raw feature values' stats to detect drift between - Serving-Prediction datasets. + The RUNNING state indicates the persistent resource is healthy and + fully usable. - >- - Feature attribution scores to detect skew between - Training-Prediction datasets. + The STOPPING state indicates the persistent resource is being + deleted. - >- - Feature attribution scores to detect skew between Prediction - datasets collected within different time windows. - type: string - topFeatureCount: - format: int32 - type: integer - description: >- - If set, all attribution scores between - SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and - SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are - fetched, and page token doesn't take effect in this case. Only used - to retrieve attribution score for the top Features which has the - highest attribution score in the latest monitoring run. - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective - description: Stats requested for specific objective. - type: object - GoogleCloudAiplatformV1StreamingPredictResponse: - type: object - description: Response message for PredictionService.StreamingPredict. - properties: - outputs: - description: The prediction output. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: array - parameters: - description: The parameters that govern the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - id: GoogleCloudAiplatformV1StreamingPredictResponse - CloudAiLargeModelsVisionRaiInfo: - properties: - scores: - type: array - description: >- - List of rai scores mapping to the rai categories. Rounded to 1 - decimal place. - items: - format: float - type: number - detectedLabels: - description: The list of detected labels for different rai categories. - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' - type: array - raiCategories: - type: array - description: List of rai categories' information to return - items: - type: string - type: object - id: CloudAiLargeModelsVisionRaiInfo - GoogleCloudAiplatformV1FeatureView: - type: object - id: GoogleCloudAiplatformV1FeatureView - properties: - name: + The ERROR state indicates the persistent resource may be unusable. + Details can be found in the `error` field. + - >- + The REBOOTING state indicates the persistent resource is being + rebooted (PR is not available right now but is expected to be + ready again later). + - >- + The UPDATING state indicates the persistent resource is being + updated. + enum: + - STATE_UNSPECIFIED + - PROVISIONING + - RUNNING + - STOPPING + - ERROR + - REBOOTING + - UPDATING + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + startTime: type: string description: >- - Identifier. Name of the FeatureView. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` - bigQuerySource: - description: >- - Optional. Configures how data is supposed to be extracted from a - BigQuery source to be loaded onto the FeatureOnlineStore. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewBigQuerySource - createTime: + Output only. Time when the PersistentResource for the first time + entered the `RUNNING` state. format: google-datetime - description: Output only. Timestamp when this FeatureView was created. readOnly: true - type: string - indexConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfig' - description: >- - Optional. Configuration for index preparation for vector search. It - contains the required configurations to create an index from source - data, so that approximate nearest neighbor (a.k.a ANN) algorithms - search can be performed during online serving. - etag: - type: string - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - featureRegistrySource: - description: >- - Optional. Configures the features from a Feature Registry source - that need to be loaded onto the FeatureOnlineStore. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource - syncConfig: - description: >- - Configures when data is to be synced/updated for this FeatureView. - At the end of the sync the latest featureValues for each entityId of - this FeatureView are made ready for online serving. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' labels: - type: object description: >- - Optional. The labels with user-defined metadata to organize your - FeatureViews. Label keys and values can be no longer than 64 + Optional. The labels with user-defined metadata to organize + PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureOnlineStore(System labels are excluded)." System - reserved label keys are prefixed with "aiplatform.googleapis.com/" - and are immutable. + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. additionalProperties: type: string - updateTime: - format: google-datetime - readOnly: true - description: Output only. Timestamp when this FeatureView was last updated. - type: string - description: >- - FeatureView is representation of values that the FeatureOnlineStore will - serve based on its syncConfig. - GoogleCloudAiplatformV1ExplainResponse: - type: object - description: Response message for PredictionService.Explain. - id: GoogleCloudAiplatformV1ExplainResponse - properties: - predictions: + type: object + reservedIpRanges: description: >- - The predictions that are the output of the predictions call. Same as - PredictResponse.predictions. - items: - type: any + Optional. A list of names for the reserved IP ranges under the VPC + network that can be used for this persistent resource. If set, we + will deploy the persistent resource within the provided IP ranges. + Otherwise, the persistent resource is deployed to any IP ranges + under the provided VPC network. Example: ['vertex-ai-ip-range']. type: array - deployedModelId: - type: string - description: ID of the Endpoint's DeployedModel that served this explanation. - explanations: - description: >- - The explanations of the Model's PredictResponse.predictions. It has - the same number of elements as instances to be explained. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' - type: array - GoogleCloudAiplatformV1FeatureOnlineStore: - type: object - description: >- - Vertex AI Feature Online Store provides a centralized repository for - serving ML features and embedding indexes at low latency. The Feature - Online Store is a top-level container. - id: GoogleCloudAiplatformV1FeatureOnlineStore - properties: - bigtable: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable - description: >- - Contains settings for the Cloud Bigtable instance that will be - created to serve featureValues for all FeatureViews under this - FeatureOnlineStore. - optimized: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreOptimized - description: >- - Contains settings for the Optimized store that will be created to - serve featureValues for all FeatureViews under this - FeatureOnlineStore. When choose Optimized storage type, need to set - PrivateServiceConnectConfig.enable_private_service_connect to use - private endpoint. Otherwise will use public endpoint by default. - etag: - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - type: string - labels: - type: object - additionalProperties: type: string - description: >- - Optional. The labels with user-defined metadata to organize your - FeatureOnlineStore. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureOnlineStore(System labels are excluded)." System - reserved label keys are prefixed with "aiplatform.googleapis.com/" - and are immutable. - updateTime: - type: string - description: >- - Output only. Timestamp when this FeatureOnlineStore was last - updated. - readOnly: true - format: google-datetime - state: - enumDescriptions: - - Default value. This value is unused. - - >- - State when the featureOnlineStore configuration is not being - updated and the fields reflect the current configuration of the - featureOnlineStore. The featureOnlineStore is usable in this - state. - - >- - The state of the featureOnlineStore configuration when it is being - updated. During an update, the fields reflect either the original - configuration or the updated configuration of the - featureOnlineStore. The featureOnlineStore is still usable in this - state. - type: string - readOnly: true - enum: - - STATE_UNSPECIFIED - - STABLE - - UPDATING - description: Output only. State of the featureOnlineStore. - dedicatedServingEndpoint: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint - description: >- - Optional. The dedicated serving endpoint for this - FeatureOnlineStore, which is different from common Vertex service - endpoint. - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. Timestamp when this FeatureOnlineStore was created. name: - description: >- - Identifier. Name of the FeatureOnlineStore. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` type: string + description: Immutable. Resource name of a PersistentResource. encryptionSpec: $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Optional. Customer-managed encryption key spec for data storage. If - set, online store will be secured by this key. - GoogleCloudAiplatformV1FunctionCallingConfig: + Optional. Customer-managed encryption key spec for a + PersistentResource. If set, this PersistentResource and all + sub-resources of this PersistentResource will be secured by this + key. + description: >- + Represents long-lasting resources that are dedicated to users to runs + custom workloads. A PersistentResource can have multiple node pools and + each node pool can have its own machine spec. + id: GoogleCloudAiplatformV1PersistentResource + GoogleCloudAiplatformV1CancelDataLabelingJobRequest: + properties: {} type: object - id: GoogleCloudAiplatformV1FunctionCallingConfig - description: Function calling config. + description: Request message for JobService.CancelDataLabelingJob. + id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest + GoogleCloudAiplatformV1BatchCreateFeaturesRequest: properties: - mode: - enumDescriptions: - - Unspecified function calling mode. This value should not be used. - - >- - Default model behavior, model decides to predict either a function - call or a natural language repspose. - - >- - Model is constrained to always predicting a function call only. If - "allowed_function_names" are set, the predicted function call will - be limited to any one of "allowed_function_names", else the - predicted function call will be any one of the provided - "function_declarations". - - >- - Model will not predict any function call. Model behavior is same - as when not passing any function declarations. - description: Optional. Function calling mode. - enum: - - MODE_UNSPECIFIED - - AUTO - - ANY - - NONE - type: string - allowedFunctionNames: - description: >- - Optional. Function names to call. Only set when the Mode is ANY. - Function names should match [FunctionDeclaration.name]. With mode - set to ANY, model will predict a function call from the set of - function names provided. - type: array + requests: items: - type: string - GoogleCloudAiplatformV1ListNasJobsResponse: - properties: - nasJobs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' type: array description: >- - List of NasJobs in the requested page. NasJob.nas_job_output of the - jobs will not be returned. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' - nextPageToken: - type: string - description: >- - A token to retrieve the next page of results. Pass to - ListNasJobsRequest.page_token to obtain that page. + Required. The request message specifying the Features to create. All + Features must be created under the same parent EntityType. The + `parent` field in each child request message can be omitted. If + `parent` is set in a child request, then the value must match the + `parent` value in this request message. + id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest + description: Request message for FeaturestoreService.BatchCreateFeatures. type: object - description: Response message for JobService.ListNasJobs - id: GoogleCloudAiplatformV1ListNasJobsResponse - GoogleCloudAiplatformV1TFRecordDestination: - id: GoogleCloudAiplatformV1TFRecordDestination - properties: - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Required. Google Cloud Storage location. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation type: object - description: The storage details for TFRecord output content. - GoogleCloudAiplatformV1Probe: - id: GoogleCloudAiplatformV1Probe description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. + Treats the column as categorical array and performs following + transformation functions. * For each element in the array, convert the + category name to a dictionary lookup index and generate an embedding for + each index. Combine the embedding of all elements into a single + embedding using the mean. * Empty arrays treated as an embedding of + zeroes. + properties: + columnName: + type: string + GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: type: object + id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse properties: - exec: - description: ExecAction probes the health of a container by executing a command. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' - timeoutSeconds: - type: integer - format: int32 - description: >- - Number of seconds after which the probe times out. Defaults to 1 - second. Minimum value is 1. Must be greater or equal to - period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - periodSeconds: - type: integer + nextPageToken: description: >- - How often (in seconds) to perform the probe. Default to 10 seconds. - Minimum value is 1. Must be less than timeout_seconds. Maps to - Kubernetes probe argument 'periodSeconds'. - format: int32 - GoogleCloudAiplatformV1ProbeExecAction: + A token, which can be sent as + ListFeatureOnlineStoresRequest.page_token to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + featureOnlineStores: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + type: array + description: The FeatureOnlineStores matching the request. + description: >- + Response message for + FeatureOnlineStoreAdminService.ListFeatureOnlineStores. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: + description: A TrainingJob that trains and uploads an AutoML Tables Model. type: object - id: GoogleCloudAiplatformV1ProbeExecAction - description: ExecAction specifies a command to execute. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables properties: - command: - type: array - items: - type: string - description: >- - Command is the command line to execute inside the container, the - working directory for the command is root ('/') in the container's - filesystem. The command is simply exec'd, it is not run inside a - shell, so traditional shell instructions ('|', etc) won't work. To - use a shell, you need to explicitly call out to that shell. Exit - status of 0 is treated as live/healthy and non-zero is unhealthy. - GoogleCloudAiplatformV1ExportModelRequestOutputConfig: - properties: - artifactDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: >- - The Cloud Storage location where the Model artifact is to be written - to. Under the directory given as the destination a new one with name - "`model-export--`", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ - ISO-8601 format, will be created. Inside, the Model and any of its - supporting files will be written. This field should only be set when - the `exportableContent` field of the - [Model.supported_export_formats] object contains `ARTIFACT`. - imageDestination: + inputs: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ContainerRegistryDestination - description: >- - The Google Container Registry or Artifact Registry uri where the - Model container image will be copied to. This field should only be - set when the `exportableContent` field of the - [Model.supported_export_formats] object contains `IMAGE`. - exportFormatId: - description: >- - The ID of the format in which the Model must be exported. Each Model - lists the export formats it supports. If no value is provided here, - then the first from the list of the Model's supported formats is - used by default. - type: string - description: Output configuration for the Model export. - type: object - id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs + description: The input parameters of this TrainingJob. + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata + GoogleCloudAiplatformV1BatchPredictionJobOutputConfig: description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. + Configures the output of BatchPredictionJob. See + Model.supported_output_storage_formats for supported output formats, and + how predictions are expressed via any of them. + id: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig + type: object properties: - columnName: + bigqueryDestination: + description: >- + The BigQuery project or dataset location where the output is to be + written to. If project is provided, a new dataset is created with + name `prediction__` where is made BigQuery-dataset-name compatible + (for example, most special characters become underscores), and + timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. + In the dataset two tables will be created, `predictions`, and + `errors`. If the Model has both instance and prediction schemata + defined then the tables have columns as follows: The `predictions` + table contains instances for which the prediction succeeded, it has + columns as per a concatenation of the Model's instance and + prediction schemata. The `errors` table contains rows for which the + prediction has failed, it has instance columns, as per the instance + schema, followed by a single "errors" column, which as values has + google.rpc.Status represented as a STRUCT, and containing only + `code` and `message`. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + predictionsFormat: type: string + description: >- + Required. The format in which Vertex AI gives the predictions, must + be one of the Model's supported_output_storage_formats. + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: >- + The Cloud Storage location of the directory where the output is to + be written to. In the given directory a new directory is created. + Its name is `prediction--`, where timestamp is in + YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files + `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are + created where `` depends on chosen predictions_format, and N may + equal 0001 and depends on the total number of successfully predicted + instances. If the Model has both instance and prediction schemata + defined then each such file contains predictions as per the + predictions_format. If prediction for any instance failed (partially + or completely), then an additional `errors_0001.`, + `errors_0002.`,..., `errors_N.` files are created (N depends on + total number of failed predictions). These files contain the failed + instances, as per their schema, followed by an additional `error` + field which as value has google.rpc.Status containing only `code` + and `message` fields. + GoogleCloudAiplatformV1Probe: type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation - GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: + id: GoogleCloudAiplatformV1Probe properties: - nextPageToken: + timeoutSeconds: + type: integer description: >- - A token, which can be sent as - ListTensorboardTimeSeriesRequest.page_token to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - tensorboardTimeSeries: - type: array - description: The TensorboardTimeSeries mathching the request. + Number of seconds after which the probe times out. Defaults to 1 + second. Minimum value is 1. Must be greater or equal to + period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. + format: int32 + periodSeconds: + type: integer + description: >- + How often (in seconds) to perform the probe. Default to 10 seconds. + Minimum value is 1. Must be less than timeout_seconds. Maps to + Kubernetes probe argument 'periodSeconds'. + format: int32 + exec: + description: ExecAction probes the health of a container by executing a command. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ProbeExecAction' + description: >- + Probe describes a health check to be performed against a container to + determine whether it is alive or ready to receive traffic. + GoogleCloudAiplatformV1DoubleArray: + properties: + values: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse + format: double + type: number + type: array + description: A list of double values. + description: A list of double values. + id: GoogleCloudAiplatformV1DoubleArray + type: object + GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: type: object - description: Response message for TensorboardService.ListTensorboardTimeSeries. - GoogleCloudAiplatformV1UploadModelRequest: - id: GoogleCloudAiplatformV1UploadModelRequest - description: Request message for ModelService.UploadModel. properties: - modelId: + minNumTrials: + type: integer + format: int32 description: >- - Optional. The ID to use for the uploaded Model, which will become - the final component of the model resource name. This value may be up - to 63 characters, and valid characters are `[a-z0-9_-]`. The first - character cannot be a number or hyphen. - type: string - serviceAccount: + If there are fewer than this many COMPLETED trials, do not stop the + study. + shouldStopAsap: + type: boolean description: >- - Optional. The user-provided custom service account to use to do the - model upload. If empty, [Vertex AI Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) - will be used to access resources needed to upload the model. This - account must belong to the target project where the model is - uploaded to, i.e., the project specified in the `parent` field of - this request and have necessary read permissions (to Google Cloud - Storage, Artifact Registry, etc.). - type: string - model: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - description: Required. The Model to create. - parentModel: + If true, a Study enters STOPPING_ASAP whenever it would normally + enters STOPPING state. The bottom line is: set to true if you want + to interrupt on-going evaluations of Trials as soon as the study + stopping condition is met. (Please see Study.State documentation for + the source of truth). + maxNumTrialsNoProgress: + type: integer + description: >- + If the objective value has not improved for this many consecutive + trials, stop the study. WARNING: Effective only for single-objective + studies. + format: int32 + maximumRuntimeConstraint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' + description: If the specified time or duration has passed, stop the study. + maxDurationNoProgress: + description: >- + If the objective value has not improved for this much time, stop the + study. WARNING: Effective only for single-objective studies. + format: google-duration type: string + maxNumTrials: + format: int32 + type: integer + description: If there are more than this many trials, stop the study. + minimumRuntimeConstraint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' description: >- - Optional. The resource name of the model into which to upload the - version. Only specify this field when uploading a new version. + Each "stopping rule" in this proto specifies an "if" condition. + Before Vizier would generate a new suggestion, it first checks each + specified stopping rule, from top to bottom in this list. Note that + the first few rules (e.g. minimum_runtime_constraint, + min_num_trials) will prevent other stopping rules from being + evaluated until they are met. For example, setting + `min_num_trials=5` and `always_stop_after= 1 hour` means that the + Study will ONLY stop after it has 5 COMPLETED trials, even if more + than an hour has passed since its creation. It follows the first + applicable rule (whose "if" condition is satisfied) to make a + stopping decision. If none of the specified rules are applicable, + then Vizier decides that the study should not stop. If Vizier + decides that the study should stop, the study enters STOPPING state + (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The + automatic study state transition happens precisely as described + above; that is, deleting trials or updating StudyConfig NEVER + automatically moves the study state back to ACTIVE. If you want to + _resume_ a Study that was stopped, 1) change the stopping conditions + if necessary, 2) activate the study, and then 3) ask for + suggestions. If the specified time or duration has not passed, do + not stop the study. + description: >- + The configuration (stopping conditions) for automated stopping of a + Study. Conditions include trial budgets, time budgets, and convergence + detection. + id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask: + description: A TrainingJob that tunes Hypererparameters of a custom code Model. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningTask + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec + description: The input parameters of this HyperparameterTuningTask. + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + description: The metadata information. type: object - GoogleCloudAiplatformV1ListDatasetVersionsResponse: - id: GoogleCloudAiplatformV1ListDatasetVersionsResponse + GoogleCloudAiplatformV1MeasurementMetric: properties: - nextPageToken: - type: string - description: The standard List next-page token. - datasetVersions: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + value: + format: double + readOnly: true + description: Output only. The value for this metric. + type: number + metricId: description: >- - A list of DatasetVersions that matches the specified filter in the - request. - description: Response message for DatasetService.ListDatasetVersions. - type: object - GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: + Output only. The ID of the Metric. The Metric should be defined in + StudySpec's Metrics. + readOnly: true + type: string type: object - id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata - description: >- - Runtime operation information for - IndexEndpointService.CreateIndexEndpoint. + id: GoogleCloudAiplatformV1MeasurementMetric + description: A message representing a metric in the measurement. + GoogleCloudAiplatformV1FeatureValue: + id: GoogleCloudAiplatformV1FeatureValue properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - GoogleCloudAiplatformV1ListDatasetsResponse: - description: Response message for DatasetService.ListDatasets. + bytesValue: + format: byte + type: string + description: Bytes feature value. + boolArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' + description: A list of bool type feature value. + stringArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' + description: A list of string type feature value. + stringValue: + type: string + description: String feature value. + metadata: + description: Metadata of feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' + structValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' + description: A struct type feature value. + doubleArrayValue: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' + description: A list of double type feature value. + int64ArrayValue: + description: A list of int64 type feature value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' + doubleValue: + description: Double type feature value. + type: number + format: double + int64Value: + format: int64 + type: string + description: Int64 feature value. + boolValue: + type: boolean + description: Bool type feature value. + type: object + description: Value for a feature. + GoogleCloudAiplatformV1ToolNameMatchInput: type: object - id: GoogleCloudAiplatformV1ListDatasetsResponse properties: - datasets: + instances: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' - description: A list of Datasets that matches the specified filter in the request. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInstance' type: array - nextPageToken: - type: string - description: The standard List next-page token. - GoogleCloudAiplatformV1ShieldedVmConfig: - properties: - enableSecureBoot: - type: boolean - description: >- - Defines whether the instance has [Secure - Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) - enabled. Secure Boot helps ensure that the system only runs - authentic software by verifying the digital signature of all boot - components, and halting the boot process if signature verification - fails. - id: GoogleCloudAiplatformV1ShieldedVmConfig + description: Required. Repeated tool name match instances. + metricSpec: + description: Required. Spec for tool name match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchSpec' + id: GoogleCloudAiplatformV1ToolNameMatchInput + description: Input for tool name match metric. + GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: type: object - description: >- - A set of Shielded Instance options. See [Images using supported Shielded - VM - features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). - GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata properties: genericMetadata: - description: Operation metadata for FeatureOnlineStore. + description: Operation metadata for Feature Update. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata - type: object - description: Details of operations that perform create FeatureOnlineStore. - GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: - description: Details of operations that perform update FeatureGroup. + description: Details of operations that perform update Feature. + GoogleCloudAiplatformV1DeployIndexOperationMetadata: + description: Runtime operation information for IndexEndpointService.DeployIndex. + id: GoogleCloudAiplatformV1DeployIndexOperationMetadata properties: genericMetadata: - description: Operation metadata for FeatureGroup. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + deployedIndexId: + type: string + description: The unique index id specified by user type: object - id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata - GoogleCloudAiplatformV1MutateDeployedModelRequest: - description: Request message for EndpointService.MutateDeployedModel. - id: GoogleCloudAiplatformV1MutateDeployedModelRequest + GoogleCloudAiplatformV1LargeModelReference: + type: object + description: Contains information about the Large Model. + id: GoogleCloudAiplatformV1LargeModelReference properties: - updateMask: + name: description: >- - Required. The update mask applies to the resource. See - google.protobuf.FieldMask. + Required. The unique name of the large Foundation or pre-built + model. Like "chat-bison", "text-bison". Or model name with version + ID, like "chat-bison@001", "text-bison@005", etc. type: string - format: google-fieldmask - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: >- - Required. The DeployedModel to be mutated within the Endpoint. Only - the following fields can be mutated: * `min_replica_count` in either - DedicatedResources or AutomaticResources * `max_replica_count` in - either DedicatedResources or AutomaticResources * - autoscaling_metric_specs * `disable_container_logging` (v1 only) * - `enable_container_logging` (v1beta1 only) + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: type: object - GoogleCloudAiplatformV1Measurement: - id: GoogleCloudAiplatformV1Measurement description: >- - A message representing a Measurement of a Trial. A Measurement contains - the Metrics got by executing a Trial using suggested hyperparameter - values. - type: object + Online serving scaling configuration. If min_node_count and + max_node_count are set to the same value, the cluster will be configured + with the fixed number of node (no auto-scaling). + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling properties: - stepCount: - readOnly: true + cpuUtilizationTarget: + type: integer description: >- - Output only. The number of steps the machine learning model has been - trained for. Must be non-negative. - format: int64 - type: string - elapsedDuration: - readOnly: true - format: google-duration + Optional. The cpu utilization that the Autoscaler should be trying + to achieve. This number is on a scale from 0 (no utilization) to 100 + (total utilization), and is limited between 10 and 80. When a + cluster's CPU utilization exceeds the target that you have set, + Bigtable immediately adds nodes to the cluster. When CPU utilization + is substantially lower than the target, Bigtable removes nodes. If + not set or set to 0, default to 50. + format: int32 + maxNodeCount: + type: integer description: >- - Output only. Time that the Trial has been running at the point of - this Measurement. - type: string - metrics: + The maximum number of nodes to scale up to. Must be greater than + min_node_count, and less than or equal to 10 times of + 'min_node_count'. + format: int32 + minNodeCount: description: >- - Output only. A list of metrics got by evaluating the objective - functions using suggested Parameter values. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' - readOnly: true - GoogleCloudAiplatformV1Study: + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + format: int32 + type: integer + GoogleCloudAiplatformV1FulfillmentSpec: + type: object + id: GoogleCloudAiplatformV1FulfillmentSpec + description: Spec for fulfillment metric. properties: - createTime: - description: Output only. Time at which the study was created. - readOnly: true - format: google-datetime - type: string - name: - readOnly: true + version: + type: integer + description: Optional. Which version to use for evaluation. + format: int32 + GoogleCloudAiplatformV1SummarizationVerbosityInstance: + properties: + context: type: string - description: >- - Output only. The name of a study. The study's globally unique - identifier. Format: - `projects/{project}/locations/{location}/studies/{study}` - state: - readOnly: true + description: Required. Text to be summarized. + reference: type: string - enumDescriptions: - - The study state is unspecified. - - The study is active. - - The study is stopped due to an internal error. - - >- - The study is done when the service exhausts the parameter search - space or max_trial_count is reached. - enum: - - STATE_UNSPECIFIED - - ACTIVE - - INACTIVE - - COMPLETED - description: Output only. The detailed state of a Study. - inactiveReason: - description: >- - Output only. A human readable reason why the Study is inactive. This - should be empty if a study is ACTIVE or COMPLETED. + description: Optional. Ground truth used to compare against the prediction. + instruction: + description: Optional. Summarization prompt for LLM. type: string - readOnly: true - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - description: Required. Configuration of the Study. - displayName: + prediction: + description: Required. Output of the evaluated model. type: string - description: Required. Describes the Study, default value is empty string. - id: GoogleCloudAiplatformV1Study - description: A message representing a Study. + id: GoogleCloudAiplatformV1SummarizationVerbosityInstance + description: Spec for summarization verbosity instance. type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: type: object properties: - exactMatch: + backingCustomJob: + type: string description: >- - The rate at which the input predicted strings exactly match their - references. - type: number - format: float - GoogleIamV1TestIamPermissionsResponse: + The resource name of the CustomJob that has been created to carry + out this custom task. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + GoogleCloudAiplatformV1SpecialistPool: properties: - permissions: + pendingDataLabelingJobs: + items: + type: string + type: array + readOnly: true + description: Output only. The resource name of the pending data labeling jobs. + specialistManagerEmails: type: array - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. items: type: string - type: object - id: GoogleIamV1TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: - description: >- - The detail of a container execution. It contains the job names of the - lifecycle of a container execution. - properties: - failedMainJobs: - type: array + description: The email addresses of the managers in the SpecialistPool. + specialistManagersCount: + description: Output only. The number of managers in this SpecialistPool. + type: integer + format: int32 readOnly: true + specialistWorkerEmails: items: type: string - description: >- - Output only. The names of the previously failed CustomJob for the - main container executions. The list includes the all attempts in - chronological order. - preCachingCheckJob: + description: The email addresses of workers in the SpecialistPool. + type: array + displayName: type: string description: >- - Output only. The name of the CustomJob for the pre-caching-check - container execution. This job will be available if the - PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in - the lifecycle events. - readOnly: true - mainJob: + Required. The user-defined name of the SpecialistPool. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. This field should be unique on project-level. + name: + description: Required. The resource name of the SpecialistPool. type: string + id: GoogleCloudAiplatformV1SpecialistPool + type: object + description: >- + SpecialistPool represents customers' own workforce to work on their data + labeling jobs. It includes a group of specialist managers and workers. + Managers are responsible for managing the workers in this pool as well + as customers' data labeling jobs associated with this pool. Customers + create specialist pool as well as start data labeling jobs on Cloud, + managers and workers handle the jobs using CrowdCompute console. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: + type: object + properties: + parentIntValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition description: >- - Output only. The name of the CustomJob for the main container - execution. - readOnly: true - failedPreCachingCheckJobs: - items: - type: string - readOnly: true + The spec for matching values from a parent parameter of `INTEGER` + type. + parameterSpec: + description: Required. The spec for a conditional parameter. + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + parentDiscreteValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition description: >- - Output only. The names of the previously failed CustomJob for the - pre-caching-check container executions. This job will be available - if the PipelineJob.pipeline_spec specifies the `pre_caching_check` - hook in the lifecycle events. The list includes the all attempts in - chronological order. - type: array + The spec for matching values from a parent parameter of `DISCRETE` + type. + parentCategoricalValues: + description: >- + The spec for matching values from a parent parameter of + `CATEGORICAL` type. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + description: Represents a parameter spec with condition from its parent parameter. + id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec + GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeatureGroupOperationMetadata type: object - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail - GoogleCloudAiplatformV1NasTrial: - description: Represents a uCAIP NasJob trial. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for FeatureGroup. + description: Details of operations that perform update FeatureGroup. + GoogleLongrunningOperation: type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. properties: - state: - description: Output only. The detailed state of the NasTrial. - enum: - - STATE_UNSPECIFIED - - REQUESTED - - ACTIVE - - STOPPING - - SUCCEEDED - - INFEASIBLE - readOnly: true - enumDescriptions: - - The NasTrial state is unspecified. - - >- - Indicates that a specific NasTrial has been requested, but it has - not yet been suggested by the service. - - Indicates that the NasTrial has been suggested. - - Indicates that the NasTrial should stop according to the service. - - Indicates that the NasTrial is completed successfully. - - >- - Indicates that the NasTrial should not be attempted again. The - service will set a NasTrial to INFEASIBLE when it's done but - missing the final_measurement. - type: string - startTime: - type: string - format: google-datetime - description: Output only. Time when the NasTrial was started. - readOnly: true - finalMeasurement: - readOnly: true - description: Output only. The final measurement containing the objective value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - id: - type: string - description: Output only. The identifier of the NasTrial assigned by the service. - readOnly: true - endTime: - format: google-datetime + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + name: type: string description: >- - Output only. Time when the NasTrial's status changed to `SUCCEEDED` - or `INFEASIBLE`. - readOnly: true - id: GoogleCloudAiplatformV1NasTrial - GoogleCloudAiplatformV1IndexDatapointCrowdingTag: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + metadata: + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + type: boolean + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + id: GoogleLongrunningOperation + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: properties: - crowdingAttribute: + featureGroups: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup + description: Required. List of features that need to be synced to Online Store. + type: array + projectNumber: description: >- - The attribute value used for crowding. The maximum number of - neighbors to return per crowding attribute value - (per_crowding_attribute_num_neighbors) is configured per-query. This - field is ignored if per_crowding_attribute_num_neighbors is larger - than the total number of neighbors to return for a given query. + Optional. The project number of the parent project of the Feature + Groups. type: string - id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag - type: object + format: int64 description: >- - Crowding tag is a constraint on a neighbor list produced by nearest - neighbor search requiring that no more than some value k' of the k - neighbors returned have the same value of crowding_attribute. - GoogleCloudAiplatformV1IndexPrivateEndpoints: + A Feature Registry source for features that need to be synced to Online + Store. + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + type: object + GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: + description: Value specification for a parameter in `DISCRETE` type. + id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec type: object - description: >- - IndexPrivateEndpoints proto is used to provide paths for users to send - requests via private endpoints (e.g. private service access, private - service connect). To send request via private service access, use - match_grpc_address. To send request via private service connect, use - service_attachment. - id: GoogleCloudAiplatformV1IndexPrivateEndpoints properties: - serviceAttachment: - readOnly: true + defaultValue: + description: >- + A default value for a `DISCRETE` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. It automatically rounds to the nearest + feasible discrete point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. + format: double + type: number + values: + type: array + items: + format: double + type: number + description: >- + Required. A list of possible values. The list should be in + increasing order and at least 1e-10 apart. For instance, this + parameter might have possible settings of 1.5, 2.5, and 4.0. This + list should not contain more than 1,000 values. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs: + properties: + optimizationObjective: + description: >- + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. type: string + targetColumn: description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. - matchGrpcAddress: - readOnly: true + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. type: string - description: Output only. The ip address used to send match gRPC requests. - pscAutomatedEndpoints: + exportEvaluatedDataItemsConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + description: >- + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + transformations: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + description: >- + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. type: array + availableAtForecastColumns: + items: + type: string description: >- - Output only. PscAutomatedEndpoints is populated if private service - connect is enabled if PscAutomatedConfig is set. - readOnly: true + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + type: array + additionalExperiments: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: - description: A duration of time expressed in time granularity units. - properties: - unit: + type: string + type: array + description: Additional experiment flags for the time series forcasting training. + holidayRegions: description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. + items: + type: string + type: array + windowConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + dataGranularity: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + validationOptions: type: string - quantity: description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + forecastHorizon: format: int64 type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity - type: object - GoogleCloudAiplatformV1SafetySetting: - type: object - id: GoogleCloudAiplatformV1SafetySetting - description: Safety settings. - properties: - threshold: - type: string - enum: - - HARM_BLOCK_THRESHOLD_UNSPECIFIED - - BLOCK_LOW_AND_ABOVE - - BLOCK_MEDIUM_AND_ABOVE - - BLOCK_ONLY_HIGH - - BLOCK_NONE - enumDescriptions: - - Unspecified harm block threshold. - - Block low threshold and above (i.e. block more). - - Block medium threshold and above. - - Block only high threshold (i.e. block less). - - Block none. - description: Required. The harm block threshold. - category: - description: Required. Harm category. - type: string - enumDescriptions: - - The harm category is unspecified. - - The harm category is hate speech. - - The harm category is dangerous content. - - The harm category is harassment. - - The harm category is sexually explicit content. - enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT - method: - enum: - - HARM_BLOCK_METHOD_UNSPECIFIED - - SEVERITY - - PROBABILITY - enumDescriptions: - - The harm block method is unspecified. - - The harm block method uses both probability and severity scores. - - The harm block method uses the probability score. - type: string description: >- - Optional. Specify if the threshold is used for probability or - severity score. If not specified, the threshold is used for - probability score. - CloudAiLargeModelsVisionGenerateVideoResponse: - type: object - description: Generate video response. - properties: - raiMediaFilteredCount: - description: Returns if any videos were filtered due to RAI policies. - format: int32 - type: integer - generatedSamples: - type: array - description: The generates samples. - items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' - raiMediaFilteredReasons: + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + timeSeriesAttributeColumns: + description: >- + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. items: type: string type: array - description: Returns rai failure reasons if any. - id: CloudAiLargeModelsVisionGenerateVideoResponse - GoogleCloudAiplatformV1TimeSeriesDataPoint: - type: object - description: A TensorboardTimeSeries data point. - properties: - wallTime: - format: google-datetime + quantiles: + type: array + items: + type: number + format: double description: >- - Wall clock timestamp when this data point is generated by the end - user. + Quantiles to use for minimize-quantile-loss + `optimization_objective`. Up to 5 quantiles are allowed of values + between 0 and 1, exclusive. Required if the value of + optimization_objective is minimize-quantile-loss. Represents the + percent quantiles to use for that objective. Quantiles must be + unique. + hierarchyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + description: >- + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + weightColumn: + description: >- + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. This column must be available at forecast. type: string - tensor: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' - description: A tensor value. - blobs: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' - description: A blob sequence value. - scalar: - description: A scalar value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' - step: - description: Step index of this data point within the run. + trainBudgetMilliNodeHours: + description: >- + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. format: int64 type: string - id: GoogleCloudAiplatformV1TimeSeriesDataPoint - GoogleCloudAiplatformV1ScheduleRunResponse: - id: GoogleCloudAiplatformV1ScheduleRunResponse - description: Status of a scheduled run. - properties: - scheduledRunTime: - format: google-datetime + unavailableAtForecastColumns: + type: array + description: >- + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. + items: + type: string + timeColumn: + description: >- + The name of the column that identifies time order in the time + series. This column must be available at forecast. type: string - description: The scheduled run time based on the user-specified schedule. - runResponse: + contextWindow: + description: >- + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. + format: int64 type: string - description: The response of the scheduled run. + timeSeriesIdentifierColumn: + type: string + description: The name of the column that identifies the time series. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs type: object - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: + GoogleCloudAiplatformV1TensorboardTensor: type: object + id: GoogleCloudAiplatformV1TensorboardTensor + description: One point viewable on a tensor metric plot. properties: - key: - type: string + value: + format: byte description: >- - This field is only used for batch prediction. If a key is provided, - the batch prediction result will by mapped to this key. If omitted, - then the batch prediction result will contain the entire input - instance. Vertex AI will not check if keys in the request are - duplicates, so it is up to the caller to ensure the keys are unique. - content: + Required. Serialized form of + https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto type: string - description: The text snippet to make the predictions on. - mimeType: - description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain - type: string - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance - description: Prediction input format for Text Extraction. - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: - description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + versionNumber: + format: int32 + description: Optional. Version number of TensorProto used to serialize value. + type: integer + GoogleCloudAiplatformV1BleuMetricValue: + description: Bleu metric value for an instance. + type: object properties: - low: - description: Inclusive low value for the range. - format: float + score: + readOnly: true type: number - high: format: float - description: Exclusive high value for the range. - type: number - type: object - GoogleCloudAiplatformV1FeatureViewSyncConfig: - description: Configuration for Sync. Only one option is set. - id: GoogleCloudAiplatformV1FeatureViewSyncConfig + description: Output only. Bleu score. + id: GoogleCloudAiplatformV1BleuMetricValue + GoogleCloudAiplatformV1PointwiseMetricResult: type: object + id: GoogleCloudAiplatformV1PointwiseMetricResult + description: Spec for pointwise metric result. properties: - cron: + explanation: + readOnly: true type: string - description: >- - Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch - scheduled runs. To explicitly set a timezone to the cron tab, apply - a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * - * *". - GoogleCloudAiplatformV1ListNotebookRuntimesResponse: + description: Output only. Explanation for pointwise metric score. + score: + type: number + readOnly: true + description: Output only. Pointwise metric score. + format: float + GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: properties: - nextPageToken: - description: >- - A token to retrieve next page of results. Pass to - ListNotebookRuntimesRequest.page_token to obtain that page. - type: string - notebookRuntimes: + notebooks: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' - description: List of NotebookRuntimes in the requested page. - type: object - description: Response message for NotebookService.ListNotebookRuntimes. - id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse - GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Required. Regional resource references to notebooks. + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + description: Open notebooks. type: object - id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation - description: Annotation details specific to image object detection. + GoogleCloudAiplatformV1ContainerSpec: + description: The spec of a Container. properties: - annotationSpecId: - type: string + command: + items: + type: string + type: array description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - xMin: - description: The leftmost coordinate of the bounding box. - type: number - format: double - yMin: - type: number - description: The topmost coordinate of the bounding box. - format: double - yMax: - type: number - description: The bottommost coordinate of the bounding box. - format: double - xMax: - description: The rightmost coordinate of the bounding box. - format: double - type: number - displayName: + The command to be invoked when the container is started. It + overrides the entrypoint instruction in Dockerfile when provided. + args: + description: The arguments to be passed when starting the container. + items: + type: string + type: array + imageUri: + description: >- + Required. The URI of a container image in the Container Registry + that is to be run on each worker replica. type: string + env: description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - GoogleCloudAiplatformV1MigratableResourceAutomlModel: - id: GoogleCloudAiplatformV1MigratableResourceAutomlModel - description: Represents one Model in automl.googleapis.com. + Environment variables to be passed to the container. Maximum limit + is 100. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + type: array + id: GoogleCloudAiplatformV1ContainerSpec type: object + GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: properties: - modelDisplayName: - description: The Model's display name in automl.googleapis.com. - type: string - model: + nextPageToken: description: >- - Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. + A token to retrieve next page of results. Pass to + ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. type: string - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: + notebookRuntimeTemplates: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + description: List of NotebookRuntimeTemplates in the requested page. + description: Response message for NotebookService.ListNotebookRuntimeTemplates. + type: object + id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + GoogleCloudAiplatformV1FeatureViewVertexRagSource: type: object properties: uri: - items: - type: string description: >- - Cloud Storage URI of one or more files. Only CSV files are - supported. The first line of the CSV file is used as the header. If - there are multiple files, the header is the first line of the - lexicographically first file, the other files must either contain - the exact same header or omit the header. - type: array - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource - GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: - type: object - id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation - description: Annotation details specific to text sentiment. - properties: - sentimentMax: - format: int32 - description: The sentiment max score for text. - type: integer - displayName: + Required. The BigQuery view/table URI that will be materialized on + each manual sync trigger. The table/view is expected to have the + following columns at least: Field name Type Mode corpus_id STRING + REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING + REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE + chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED + file_original_uri STRING REQUIRED/NULLABLE type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - sentiment: - description: The sentiment score for text. - format: int32 - type: integer - annotationSpecId: + ragCorpusId: + description: Optional. The RAG corpus id corresponding to this FeatureView. + format: int64 type: string - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse - description: Response message for VizierService.CheckTrialEarlyStoppingState. - properties: - shouldStop: - type: boolean - description: True if the Trial should stop. + id: GoogleCloudAiplatformV1FeatureViewVertexRagSource + description: A Vertex Rag source for features that need to be synced to Online Store. + GoogleCloudAiplatformV1UndeployModelOperationMetadata: type: object - GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: + description: Runtime operation information for EndpointService.UndeployModel. properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore batch read Features values. + description: The operation generic information. + id: GoogleCloudAiplatformV1UndeployModelOperationMetadata + GoogleCloudAiplatformV1Attribution: type: object - description: Details of operations that batch reads Feature values. - id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata - GoogleCloudAiplatformV1Schema: - description: >- - Schema is used to define the format of input/output data. Represents a - select subset of an [OpenAPI 3.0 schema - object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be - added in the future as needed. - id: GoogleCloudAiplatformV1Schema properties: - minLength: - format: int64 + outputDisplayName: description: >- - Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the - Type.STRING - type: string - minItems: - description: Optional. Minimum number of the elements for Type.ARRAY. + Output only. The display name of the output identified by + output_index. For example, the predicted class name by a + multi-classification Model. This field is only populated iff the + Model predicts display names as a separate field along with the + explained output. The predicted display name must has the same shape + of the explained output, and can be located using output_index. + readOnly: true type: string - format: int64 - example: + instanceOutputValue: + type: number + readOnly: true + description: >- + Output only. Model predicted output on the corresponding explanation + instance. The field name of the output is determined by the key in + ExplanationMetadata.outputs. If the Model predicted output has + multiple dimensions, this is the value in the output located by + output_index. + format: double + featureAttributions: type: any description: >- - Optional. Example of the object. Will only populated when the object - is the root. - description: - type: string - description: Optional. The description of the data. - items: + Output only. Attributions of each explained feature. Features are + extracted from the prediction instances according to explanation + metadata for inputs. The value is a struct, whose keys are the name + of the feature. The values are how much the feature in the instance + contributed to the predicted result. The format of the value is + determined by the feature's input format: * If the feature is a + scalar value, the attribution value is a floating number. * If the + feature is an array of scalar values, the attribution value is an + array. * If the feature is a struct, the attribution value is a + struct. The keys in the attribution value struct are the same as the + keys in the feature struct. The formats of the values in the + attribution struct are determined by the formats of the values in + the feature struct. The + ExplanationMetadata.feature_attributions_schema_uri field, pointed + to by the ExplanationSpec field of the Endpoint.deployed_models + object, points to the schema file that describes the features and + their attribution values (if it is populated). + readOnly: true + outputName: description: >- - Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of - Type.ARRAY. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - maxItems: - description: Optional. Maximum number of the elements for Type.ARRAY. - format: int64 + Output only. Name of the explain output. Specified as the key in + ExplanationMetadata.outputs. type: string - minimum: + readOnly: true + baselineOutputValue: + type: number + description: >- + Output only. Model predicted output if the input instance is + constructed from the baselines of all the features defined in + ExplanationMetadata.inputs. The field name of the output is + determined by the key in ExplanationMetadata.outputs. If the Model's + predicted output has multiple dimensions (rank > 1), this is the + value in the output located by output_index. If there are multiple + baselines, their output values are averaged. format: double + readOnly: true + outputIndex: description: >- - Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of - the Type.INTEGER and Type.NUMBER - type: number - nullable: - type: boolean - description: Optional. Indicates if the value may be null. - required: - description: Optional. Required properties of Type.OBJECT. + Output only. The index that locates the explained prediction output. + If the prediction output is a scalar value, output_index is not + populated. If the prediction output has multiple dimensions, the + length of the output_index list is the same as the number of + dimensions of the output. The i-th element in output_index is the + element index of the i-th dimension of the output vector. Indices + start from 0. + readOnly: true type: array items: - type: string - maxLength: - type: string - description: Optional. Maximum length of the Type.STRING - format: int64 - default: - type: any - description: Optional. Default value of the data. - type: - enum: - - TYPE_UNSPECIFIED - - STRING - - NUMBER - - INTEGER - - BOOLEAN - - ARRAY - - OBJECT - description: Optional. The type of the data. - enumDescriptions: - - Not specified, should not be used. - - OpenAPI string type - - OpenAPI number type - - OpenAPI integer type - - OpenAPI boolean type - - OpenAPI array type - - OpenAPI object type - type: string - maximum: + format: int32 + type: integer + approximationError: + description: >- + Output only. Error of feature_attributions caused by approximation + used in the explanation method. Lower value means more precise + attributions. * For Sampled Shapley attribution, increasing + path_count might reduce the error. * For Integrated Gradients + attribution, increasing step_count might reduce the error. * For + XRAI attribution, increasing step_count might reduce the error. See + [this introduction](/vertex-ai/docs/explainable-ai/overview) for + more information. format: double - description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER + readOnly: true type: number - pattern: - description: >- - Optional. Pattern of the Type.STRING to restrict a string to a - regular expression. - type: string - minProperties: - format: int64 - type: string - description: Optional. Minimum number of the properties for Type.OBJECT. - title: + description: Attribution that explains a particular prediction output. + id: GoogleCloudAiplatformV1Attribution + GoogleCloudAiplatformV1EntityType: + properties: + etag: type: string - description: Optional. The title of the Schema. - enum: - type: array description: >- - Optional. Possible values of the element of Type.STRING with enum - format. For example we can define an Enum Direction as : - {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - items: - type: string - format: + Optional. Used to perform a consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + createTime: type: string + description: Output only. Timestamp when this EntityType was created. + format: google-datetime + readOnly: true + name: description: >- - Optional. The format of the data. Supported formats: for NUMBER - type: "float", "double" for INTEGER type: "int32", "int64" for - STRING type: "email", "byte", etc - maxProperties: - format: int64 + Immutable. Name of the EntityType. Format: + `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + The last part entity_type is assigned by the client. The entity_type + can be up to 64 characters long and can consist only of ASCII Latin + letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting + with a letter. The value will be unique given a featurestore. type: string - description: Optional. Maximum number of the properties for Type.OBJECT. - properties: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - type: object - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: - description: Prediction input format for Video Classification. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance - properties: - timeSegmentEnd: + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + updateTime: + readOnly: true description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. + Output only. Timestamp when this EntityType was most recently + updated. + format: google-datetime type: string - content: + offlineStorageTtlDays: + type: integer + format: int32 description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. - type: string - mimeType: + Optional. Config for data retention policy in offline storage. TTL + in days for feature values that will be stored in offline storage. + The Feature Store offline storage periodically removes obsolete + feature values older than `offline_storage_ttl_days` since the + feature generation time. If unset (or explicitly set to 0), default + to 4000 days TTL. + description: type: string + description: Optional. Description of the EntityType. + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + monitoringConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfig description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime - timeSegmentStart: - type: string + Optional. The default monitoring configuration for all Features with + value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under + this EntityType. If this is populated with + [FeaturestoreMonitoringConfig.monitoring_interval] specified, + snapshot analysis monitoring is enabled. Otherwise, snapshot + analysis monitoring is disabled. + labels: + type: object description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. - type: object - GoogleCloudAiplatformV1BatchPredictionJobInputConfig: + Optional. The labels with user-defined metadata to organize your + EntityTypes. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one EntityType (System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + additionalProperties: + type: string type: object description: >- - Configures the input to BatchPredictionJob. See - Model.supported_input_storage_formats for Model's supported input - formats, and how instances should be expressed via any of them. - id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig - properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: The Cloud Storage location for the input instances. - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: >- - The BigQuery location of the input table. The schema of the table - should be in the format described by the given context OpenAPI - Schema, if one is provided. The table may contain additional columns - that are not described by the schema, and they will be ignored. - instancesFormat: - description: >- - Required. The format in which instances are given, must be one of - the Model's supported_input_storage_formats. - type: string - GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: - id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata + An entity type is a type of object in a system that needs to be modeled + and have stored information about. For example, driver is an entity + type, and driver0 is an instance of an entity type driver. + id: GoogleCloudAiplatformV1EntityType + GoogleCloudAiplatformV1MetadataStoreMetadataStoreState: + description: Represents state information for a MetadataStore. + id: GoogleCloudAiplatformV1MetadataStoreMetadataStoreState type: object - description: Details of operations that perform update Tensorboard. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Tensorboard. - GoogleCloudAiplatformV1ExportFeatureValuesRequest: - description: Request message for FeaturestoreService.ExportFeatureValues. - id: GoogleCloudAiplatformV1ExportFeatureValuesRequest properties: - settings: - description: Per-Feature export settings. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting - type: array - destination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - description: Required. Specifies destination location and format. - snapshotExport: - description: >- - Exports the latest Feature values of all entities of the EntityType - within a time range. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - description: Required. Selects Features to export values of. - fullExport: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport - description: >- - Exports all historical values of all entities of the EntityType - within a time range + diskUtilizationBytes: + format: int64 + type: string + description: The disk utilization of the MetadataStore in bytes. + CloudAiLargeModelsVisionVideo: type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult: properties: - displayName: - description: The display name of the AnnotationSpec that had been identified. + uri: + description: Path to another storage (typically Google Cloud Storage). type: string - id: + video: + description: Raw bytes. + format: byte type: string - description: The resource ID of the AnnotationSpec that had been identified. - timeSegmentEnd: + description: Video + id: CloudAiLargeModelsVisionVideo + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: + type: object + properties: + modelType: + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which c + annot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A versatile model that is meant to be exported (see + ModelService.ExportModel) and used on a Google Coral device. + - >- + A model that trades off quality for low latency, to be exported + (see ModelService.ExportModel) and used on a Google Coral device. + - >- + A versatile model that is meant to be exported (see + ModelService.ExportModel) and used on an NVIDIA Jetson device. + - >- + A model that trades off quality for low latency, to be exported + (see ModelService.ExportModel) and used on an NVIDIA Jetson + device. + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_CORAL_VERSATILE_1 + - MOBILE_CORAL_LOW_LATENCY_1 + - MOBILE_JETSON_VERSATILE_1 + - MOBILE_JETSON_LOW_LATENCY_1 type: string - format: google-duration - description: >- - The end, inclusive, of the video's time segment in which the object - instance has been detected. Expressed as a number of seconds as - measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. - confidence: - description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - format: float - type: number - frames: - type: array + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: + properties: + error: + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - All of the frames of the video in which a single object instance has - been detected. The bounding boxes in the frames identify the same - object. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame - timeSegmentStart: + Output only. The error that occurred during the state. May be set + when the state is any of the non-final state + (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is + FAILED, the error here is final and not going to be retried. If the + state is a non-final state, the error indicates a system-error being + retried. + state: + enumDescriptions: + - Unspecified. + - Specifies pending state for the task. + - Specifies task is being executed. + - Specifies task completed successfully. + - Specifies Task cancel is in pending state. + - Specifies task is being cancelled. + - Specifies task was cancelled. + - Specifies task failed. + - Specifies task was skipped due to cache hit. + - >- + Specifies that the task was not triggered because the task's + trigger policy is not satisfied. The trigger policy is specified + in the `condition` field of PipelineJob.pipeline_spec. + readOnly: true + description: Output only. The state of the task. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - CANCEL_PENDING + - CANCELLING + - CANCELLED + - FAILED + - SKIPPED + - NOT_TRIGGERED type: string - format: google-duration - description: >- - The beginning, inclusive, of the video's time segment in which the - object instance has been detected. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. + updateTime: + type: string + readOnly: true + description: Output only. Update time of this status. + format: google-datetime + description: A single record of the task status. + id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult - description: Prediction output format for Video Object Tracking. - GoogleCloudAiplatformV1ListFeatureViewsResponse: - id: GoogleCloudAiplatformV1ListFeatureViewsResponse + GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: + description: A neighbor of the query vector. type: object - description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. properties: - featureViews: + distance: + type: number + description: The distance between the neighbor and the dense embedding query. + format: double + sparseDistance: + type: number + description: The distance between the neighbor and the query sparse_embedding. + format: double + datapoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: >- + The datapoint of the neighbor. Note that full datapoints are + returned only when "return_full_datapoint" is set to true. + Otherwise, only the "datapoint_id" and "crowding_tag" fields are + populated. + id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: + type: object + properties: + keyField: + type: string + description: >- + The name of the field that is considered as a key. The values + identified by the key field is not included in the transformed + instances that is sent to the Model. This is similar to specifying + this name of the field in excluded_fields. In addition, the batch + prediction output will not include the instances. Instead the output + will only include the value of the key field, in a field named `key` + in the output: * For `jsonl` output format, the output will have a + `key` field instead of the `instance` field. * For `csv`/`bigquery` + output format, the output will have have a `key` column instead of + the instance feature columns. The input must be JSONL with objects + at each line, CSV, BigQuery or TfRecord. + instanceType: + type: string + description: >- + The format of the instance that the Model accepts. Vertex AI will + convert compatible batch prediction input instance formats to the + specified format. Supported values are: * `object`: Each input is + converted to JSON object format. * For `bigquery`, each row is + converted to an object. * For `jsonl`, each line of the JSONL input + must be an object. * Does not apply to `csv`, `file-list`, + `tf-record`, or `tf-record-gzip`. * `array`: Each input is converted + to JSON array format. * For `bigquery`, each row is converted to an + array. The order of columns is determined by the BigQuery column + order, unless included_fields is populated. included_fields must be + populated for specifying field orders. * For `jsonl`, if each line + of the JSONL input is an object, included_fields must be populated + for specifying field orders. * Does not apply to `csv`, `file-list`, + `tf-record`, or `tf-record-gzip`. If not specified, Vertex AI + converts the batch prediction input as follows: * For `bigquery` and + `csv`, the behavior is the same as `array`. The order of columns is + the same as defined in the file or table, unless included_fields is + populated. * For `jsonl`, the prediction instance format is + determined by each line of the input. * For + `tf-record`/`tf-record-gzip`, each record will be converted to an + object in the format of `{"b64": }`, where `` is the Base64-encoded + string of the content of the record. * For `file-list`, each file in + the list will be converted to an object in the format of `{"b64": + }`, where `` is the Base64-encoded string of the content of the + file. + excludedFields: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + type: string + description: >- + Fields that will be excluded in the prediction instance that is sent + to the Model. Excluded will be attached to the batch prediction + output if key_field is not specified. When excluded_fields is + populated, included_fields must be empty. The input must be JSONL + with objects at each line, BigQuery or TfRecord. type: array - description: The FeatureViews matching the request. - nextPageToken: - type: string + includedFields: + items: + type: string description: >- - A token, which can be sent as ListFeatureViewsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: - description: Details of operations that perform MetadataService.CreateMetadataStore. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for creating a MetadataStore. - id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata + Fields that will be included in the prediction instance that is sent + to the Model. If instance_type is `array`, the order of field names + in included_fields also determines the order of the values in the + array. When included_fields is populated, excluded_fields must be + empty. The input must be JSONL with objects at each line, BigQuery + or TfRecord. + type: array + description: >- + Configuration defining how to transform batch prediction input instances + to the instances that the Model accepts. + id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig + GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: type: object - GoogleCloudAiplatformV1MigrateResourceResponse: + id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport properties: - migratableResource: + startTime: + type: string + format: google-datetime description: >- - Before migration, the identifier in ml.googleapis.com, - automl.googleapis.com or datalabeling.googleapis.com. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' - dataset: + Excludes Feature values with feature generation timestamp before + this timestamp. If not set, retrieve oldest values kept in Feature + Store. Timestamp, if present, must not have higher than millisecond + precision. + snapshotTime: type: string - description: Migrated Dataset's resource name. - model: - description: Migrated Model's resource name. + description: >- + Exports Feature values as of this timestamp. If not set, retrieve + values as of now. Timestamp, if present, must not have higher than + millisecond precision. + format: google-datetime + description: >- + Describes exporting the latest Feature values of all entities of the + EntityType between [start_time, snapshot_time]. + GoogleCloudAiplatformV1SyncFeatureViewRequest: + id: GoogleCloudAiplatformV1SyncFeatureViewRequest + description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. + type: object + properties: {} + GoogleCloudAiplatformV1RougeInstance: + properties: + prediction: + description: Required. Output of the evaluated model. type: string - description: Describes a successfully migrated resource. + reference: + description: Required. Ground truth used to compare against the prediction. + type: string + id: GoogleCloudAiplatformV1RougeInstance type: object - id: GoogleCloudAiplatformV1MigrateResourceResponse - GoogleCloudAiplatformV1ModelOriginalModelInfo: + description: Spec for rouge instance. + GoogleCloudAiplatformV1Explanation: type: object + id: GoogleCloudAiplatformV1Explanation + description: >- + Explanation of a prediction (provided in PredictResponse.predictions) + produced by the Model on a given instance. properties: - model: + neighbors: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' readOnly: true description: >- - Output only. The resource name of the Model this Model is a copy of, - including the revision. Format: - `projects/{project}/locations/{location}/models/{model_id}@{version_id}` - type: string - description: Contains information about the original Model if this Model is a copy. - id: GoogleCloudAiplatformV1ModelOriginalModelInfo - GoogleCloudAiplatformV1PersistentDiskSpec: + Output only. List of the nearest neighbors for example-based + explanations. For models deployed with the examples explanations + feature enabled, the attributions field is empty and instead the + neighbors field is populated. + attributions: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + readOnly: true + type: array + description: >- + Output only. Feature attributions grouped by predicted outputs. For + Models that predict only one output, such as regression Models that + predict only one score, there is only one attibution that explains + the predicted output. For Models that predict multiple outputs, such + as multiclass Models that predict multiple classes, each element + explains one specific item. Attribution.output_index can be used to + identify which output this attribution is explaining. By default, we + provide Shapley values for the predicted class. However, you can + configure the explanation request to generate Shapley values for any + other classes too. For example, if a model predicts a probability of + `0.4` for approving a loan application, the model's decision is to + reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, + and the default Shapley values would be computed for rejection + decision and not approval, even though the latter might be the + positive class. If users set ExplanationParameters.top_k, the + attributions are sorted by instance_output_value in descending + order. If ExplanationParameters.output_indices is specified, the + attributions are stored by Attribution.output_index in the same + order as they appear in the output_indices. + GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: + description: Annotation details specific to text classification. + id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation + type: object properties: - diskType: + displayName: type: string description: >- - Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" - (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk - Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) - "pd-extreme" (Extreme Persistent Disk) - diskSizeGb: - description: Size in GB of the disk (default is 100GB). - format: int64 + The display name of the AnnotationSpec that this Annotation pertains + to. + annotationSpecId: type: string + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: type: object - description: Represents the spec of persistent disk options. - id: GoogleCloudAiplatformV1PersistentDiskSpec - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: - type: object - description: Model evaluation metrics for text sentiment problems. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics + description: Annotation details specific to video object tracking. + id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation properties: - meanSquaredError: - format: float - type: number + instanceId: + format: int64 + type: string description: >- - Mean squared error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - precision: + The instance of the object, expressed as a positive integer. Used to + track the same object across different frames. + yMax: type: number - format: float - description: Precision. - meanAbsoluteError: + description: The bottommost coordinate of the bounding box. + format: double + xMax: type: number + format: double + description: The rightmost coordinate of the bounding box. + displayName: description: >- - Mean absolute error. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - format: float - quadraticKappa: - type: number + The display name of the AnnotationSpec that this Annotation pertains + to. + type: string + annotationSpecId: + type: string description: >- - Quadratic weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - format: float - f1Score: - format: float - type: number - description: The harmonic mean of recall and precision. - recall: + The resource Id of the AnnotationSpec that this Annotation pertains + to. + yMin: type: number - description: Recall. - format: float - linearKappa: + description: The topmost coordinate of the bounding box. + format: double + xMin: + format: double type: number - format: float - description: >- - Linear weighted kappa. Only set for ModelEvaluations, not for - ModelEvaluationSlices. - confusionMatrix: - description: >- - Confusion matrix of the evaluation. Only set for ModelEvaluations, - not for ModelEvaluationSlices. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: - properties: - successfulStopReason: - enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. - type: string - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED - description: >- - For successful job completions, this is the reason why the job has - finished. - costMilliNodeHours: - format: int64 + description: The leftmost coordinate of the bounding box. + timeOffset: type: string description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. + A time (frame) of a video to which this annotation pertains. + Represented as the duration since the video's start. + format: google-duration + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: type: object + properties: + columnName: + type: string id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata - GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: - id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation + description: >- + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + GoogleCloudAiplatformV1GenieSource: + id: GoogleCloudAiplatformV1GenieSource properties: - gcsOutputDirectory: - readOnly: true - description: >- - Output only. The full path of the Cloud Storage directory created, - into which the prediction output is written. + baseModelUri: + description: Required. The public base model URI. type: string - bigqueryOutputDataset: + description: >- + Contains information about the source of the models generated from + Generative AI Studio. + type: object + GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: + description: Restrictions namespace for example-based explanations overrides. + properties: + allow: + type: array + description: The list of allowed tags. + items: + type: string + deny: + type: array + items: + type: string + description: The list of deny tags. + namespaceName: type: string - readOnly: true + description: The namespace name. + id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace + type: object + GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: + type: object + properties: + failedJobs: + items: + type: string + type: array description: >- - Output only. The path of the BigQuery dataset created, in - `bq://projectId.bqDatasetId` format, into which the prediction - output is written. - bigqueryOutputTable: + Output only. The names of the previously failed CustomJob. The list + includes the all attempts in chronological order. + readOnly: true + job: + description: Output only. The name of the CustomJob. type: string readOnly: true - description: >- - Output only. The name of the BigQuery table created, in - `predictions_` format, into which the prediction output is written. - Can be used by UI to generate the BigQuery output path, for example. - type: object - description: Further describes this job's output. Supplements output_config. - GoogleCloudAiplatformV1CreateIndexOperationMetadata: - description: Runtime operation information for IndexService.CreateIndex. + description: The detailed info for a custom job executor. + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + GoogleCloudAiplatformV1ComputeTokensRequest: + id: GoogleCloudAiplatformV1ComputeTokensRequest type: object + description: Request message for ComputeTokens RPC call. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - nearestNeighborSearchOperationMetadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + model: description: >- - The operation metadata with regard to Matching Engine Index - operation. - id: GoogleCloudAiplatformV1CreateIndexOperationMetadata - GoogleCloudAiplatformV1ModelSourceInfo: - description: Detail description of the source information of the model. - id: GoogleCloudAiplatformV1ModelSourceInfo - type: object - properties: - copy: - type: boolean - description: >- - If this Model is copy of another Model. If true then source_type - pertains to the original. - sourceType: + Optional. The name of the publisher model requested to serve the + prediction. Format: + projects/{project}/locations/{location}/publishers/*/models/* type: string - enum: - - MODEL_SOURCE_TYPE_UNSPECIFIED - - AUTOML - - CUSTOM - - BQML - - MODEL_GARDEN - - GENIE - - CUSTOM_TEXT_EMBEDDING - - MARKETPLACE - description: Type of the model source. - enumDescriptions: - - Should not be used. - - The Model is uploaded by automl training pipeline. - - The Model is uploaded by user or custom training pipeline. - - The Model is registered and sync'ed from BigQuery ML. - - The Model is saved or tuned from Model Garden. - - The Model is saved or tuned from Genie. - - The Model is uploaded by text embedding finetuning pipeline. - - The Model is saved or tuned from Marketplace. - GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: + instances: + items: + type: any + type: array + description: >- + Optional. The instances that are the input to token computing API + call. Schema is identical to the prediction schema of the text + model, even for the non-text models, like chat models, or Codey + models. + contents: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: Optional. Input content. + GoogleCloudAiplatformV1SummarizationHelpfulnessInstance: + description: Spec for summarization helpfulness instance. type: object + id: GoogleCloudAiplatformV1SummarizationHelpfulnessInstance properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. - description: Details of operations that perform create FeatureGroup. - id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata - GoogleCloudAiplatformV1NasJobSpec: - properties: - resumeNasJobId: - description: >- - The ID of the existing NasJob in the same Project and Location which - will be used to resume search. search_space_spec and - nas_algorithm_spec are obtained from previous NasJob hence should - not provide them again for this NasJob. + prediction: + description: Required. Output of the evaluated model. type: string - multiTrialAlgorithmSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec - description: The spec of multi-trial algorithms. - searchSpaceSpec: + instruction: type: string - description: It defines the search space for Neural Architecture Search (NAS). - type: object - description: Represents the spec of a NasJob. - id: GoogleCloudAiplatformV1NasJobSpec - GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + description: Optional. Summarization prompt for LLM. + context: + description: Required. Text to be summarized. + type: string + reference: + type: string + description: Optional. Ground truth used to compare against the prediction. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: type: object - properties: - autoScaling: - description: Required. Autoscaling config applied to Bigtable Instance. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: + description: Configuration for exporting test set predictions to a BigQuery table. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification - type: object - description: >- - A TrainingJob that trains and uploads an AutoML Text Classification - Model. - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs - description: The input parameters of this TrainingJob. - GoogleCloudAiplatformV1ListTrainingPipelinesResponse: - id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig properties: - trainingPipelines: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' - description: List of TrainingPipelines in the requested page. - nextPageToken: + destinationBigqueryUri: type: string description: >- - A token to retrieve the next page of results. Pass to - ListTrainingPipelinesRequest.page_token to obtain that page. - description: Response message for PipelineService.ListTrainingPipelines + URI of desired destination BigQuery table. Expected format: + `bq://{project_id}:{dataset_id}:{table}` If not specified, then + results are exported to the following auto-created BigQuery table: + `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples` + overrideExistingTable: + description: >- + If true and an export destination is specified, then the contents of + the destination are overwritten. Otherwise, if the export + destination already exists, then the export operation fails. + type: boolean + GoogleCloudAiplatformV1VertexRagStoreRagResource: + description: The definition of the Rag resource. + id: GoogleCloudAiplatformV1VertexRagStoreRagResource type: object - GoogleCloudAiplatformV1BatchCreateFeaturesResponse: - id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse properties: - features: + ragCorpus: + type: string + description: >- + Optional. RagCorpora resource name. Format: + `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + ragFileIds: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - description: The Features created. + type: string type: array - description: Response message for FeaturestoreService.BatchCreateFeatures. - type: object - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: - properties: - range: - description: >- - A range of values for a numerical feature. Example: - `{"range":{"low":10000.0,"high":50000.0}}` will capture 12345 and - 23334 in the slice. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange - allValues: - description: >- - If all_values is set to true, then all possible labels of the keyed - feature will have another slice computed. Example: - `{"all_values":{"value":true}}` - type: boolean - value: description: >- - A unique specific value for a given feature. Example: `{ "value": { - "string_value": "12345" } }` - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + Optional. rag_file_id. The files should be in the same rag_corpus + set in rag_corpus field. + GoogleCloudAiplatformV1Measurement: type: object + id: GoogleCloudAiplatformV1Measurement description: >- - Specification message containing the config for this SliceSpec. When - `kind` is selected as `value` and/or `range`, only a single slice will - be computed. When `all_values` is present, a separate slice will be - computed for each possible label/value for the corresponding key in - `config`. Examples, with feature zip_code with values 12345, 23334, - 88888 and feature country with values "US", "Canada", "Mexico" in the - dataset: Example 1: { "zip_code": { "value": { "float_value": 12345.0 } - } } A single slice for any data with zip_code 12345 in the dataset. - Example 2: { "zip_code": { "range": { "low": 12345, "high": 20000 } } } - A single slice containing data where the zip_codes between 12345 and - 20000 For this example, data with the zip_code of 12345 will be in this - slice. Example 3: { "zip_code": { "range": { "low": 10000, "high": 20000 - } }, "country": { "value": { "string_value": "US" } } } A single slice - containing data where the zip_codes between 10000 and 20000 has the - country "US". For this example, data with the zip_code of 12345 and - country "US" will be in this slice. Example 4: { "country": - {"all_values": { "value": true } } } Three slices are computed, one for - each unique country in the dataset. Example 5: { "country": { - "all_values": { "value": true } }, "zip_code": { "value": { - "float_value": 12345.0 } } } Three slices are computed, one for each - unique country in the dataset where the zip_code is also 12345. For this - example, data with zip_code 12345 and country "US" will be in one slice, - zip_code 12345 and country "Canada" in another slice, and zip_code 12345 - and country "Mexico" in another slice, totaling 3 slices. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig - GoogleCloudAiplatformV1ResumeScheduleRequest: - properties: - catchUp: - description: >- - Optional. Whether to backfill missed runs when the schedule is - resumed from PAUSED state. If set to true, all missed runs will be - scheduled. New runs will be scheduled after the backfill is - complete. This will also update Schedule.catch_up field. Default to - false. - type: boolean - id: GoogleCloudAiplatformV1ResumeScheduleRequest - description: Request message for ScheduleService.ResumeSchedule. - type: object - GoogleCloudAiplatformV1TimestampSplit: - id: GoogleCloudAiplatformV1TimestampSplit + A message representing a Measurement of a Trial. A Measurement contains + the Metrics got by executing a Trial using suggested hyperparameter + values. properties: - testFraction: - description: >- - The fraction of the input data that is to be used to evaluate the - Model. - format: double - type: number - validationFraction: - type: number + stepCount: + format: int64 + readOnly: true + type: string description: >- - The fraction of the input data that is to be used to validate the - Model. - format: double - key: + Output only. The number of steps the machine learning model has been + trained for. Must be non-negative. + metrics: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MeasurementMetric' description: >- - Required. The key is a name of one of the Dataset's data columns. - The values of the key (the values in the column) must be in RFC 3339 - `date-time` format, where `time-offset` = `"Z"` (e.g. - 1985-04-12T23:20:50.52Z). If for a piece of data the key is not - present or has an invalid value, that piece is ignored by the - pipeline. + Output only. A list of metrics got by evaluating the objective + functions using suggested Parameter values. + elapsedDuration: + readOnly: true type: string - trainingFraction: + format: google-duration description: >- - The fraction of the input data that is to be used to train the - Model. + Output only. Time that the Trial has been running at the point of + this Measurement. + GoogleCloudAiplatformV1CoherenceResult: + id: GoogleCloudAiplatformV1CoherenceResult + description: Spec for coherence result. + properties: + score: type: number - format: double + format: float + description: Output only. Coherence score. + readOnly: true + explanation: + readOnly: true + description: Output only. Explanation for coherence score. + type: string + confidence: + type: number + readOnly: true + description: Output only. Confidence for coherence score. + format: float type: object - description: >- - Assigns input data to training, validation, and test sets based on a - provided timestamps. The youngest data pieces are assigned to training - set, next to validation set, and the oldest to the test set. Supported - only for tabular Datasets. - GoogleCloudAiplatformV1ReadTensorboardUsageResponse: - properties: - monthlyUsageData: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData - type: object - description: Maps year-month (YYYYMM) string to per month usage data. - description: Response message for TensorboardService.ReadTensorboardUsage. + GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: + description: Request message for TensorboardService.WriteTensorboardExperimentData. type: object - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: properties: - evaluatedDataItemsBigqueryUri: - type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: - format: int64 + writeRunDataRequests: + type: array description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - type: string - description: Model metadata specific to Seq2Seq Plus Forecasting. - type: object + Required. Requests containing per-run TensorboardTimeSeries data to + write. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation properties: - modelEvaluationSlices: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' - description: Required. Model evaluation slice resource to be imported. - type: array - type: object - description: Request message for ModelService.BatchImportModelEvaluationSlices - GoogleCloudAiplatformV1NotebookRuntimeTemplate: - id: GoogleCloudAiplatformV1NotebookRuntimeTemplate + columnName: + type: string description: >- - A template that specifies runtime configurations such as machine type, - runtime version, network configurations, etc. Multiple runtimes can be - created from a runtime template. + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + type: object + GoogleCloudAiplatformV1MutateDeployedModelRequest: + type: object + description: Request message for EndpointService.MutateDeployedModel. + id: GoogleCloudAiplatformV1MutateDeployedModelRequest properties: - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: >- - Optional. Immutable. The specification of a single machine for the - template. - updateTime: + updateMask: description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was most - recently updated. - format: google-datetime + Required. The update mask applies to the resource. See + google.protobuf.FieldMask. + format: google-fieldmask type: string - readOnly: true - networkTags: - items: - type: string - type: array + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' description: >- - Optional. The Compute Engine tags to add to runtime (see [Tagging - instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). - description: - description: The description of the NotebookRuntimeTemplate. - type: string - isDefault: - description: Output only. The default template to use if not specified. + Required. The DeployedModel to be mutated within the Endpoint. Only + the following fields can be mutated: * `min_replica_count` in either + DedicatedResources or AutomaticResources * `max_replica_count` in + either DedicatedResources or AutomaticResources * + autoscaling_metric_specs * `disable_container_logging` (v1 only) * + `enable_container_logging` (v1beta1 only) + GoogleCloudAiplatformV1Index: + description: >- + A representation of a collection of database items organized in a way + that allows for approximate nearest neighbor (a.k.a ANN) algorithms + search. + id: GoogleCloudAiplatformV1Index + properties: + indexStats: + readOnly: true + description: Output only. Stats of the index resource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' + satisfiesPzi: type: boolean + description: Output only. Reserved for future use. + readOnly: true + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. readOnly: true - encryptionSpec: - description: Customer-managed encryption key spec for the notebook runtime. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' name: type: string - description: The resource name of the NotebookRuntimeTemplate. - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + readOnly: true + description: Output only. The resource name of the Index. + indexUpdateMethod: type: string - notebookRuntimeType: enumDescriptions: + - Should not be used. - >- - Unspecified notebook runtime type, NotebookRuntimeType will - default to USER_DEFINED. - - runtime or template with coustomized configurations from user. - - runtime or template with system defined configurations. - description: Optional. Immutable. The type of the notebook runtime template. - type: string + BatchUpdate: user can call UpdateIndex with files on Cloud Storage + of Datapoints to update. + - >- + StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to + update the Index and the updates will be applied in corresponding + DeployedIndexes in nearly real-time. enum: - - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - - USER_DEFINED - - ONE_CLICK - shieldedVmConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' - description: Optional. Immutable. Runtime Shielded VM spec. - networkSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' - description: Optional. Network spec. - labels: - additionalProperties: - type: string - type: object - description: >- - The labels with user-defined metadata to organize the - NotebookRuntimeTemplates. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - displayName: - type: string + - INDEX_UPDATE_METHOD_UNSPECIFIED + - BATCH_UPDATE + - STREAM_UPDATE description: >- - Required. The display name of the NotebookRuntimeTemplate. The name - can be up to 128 characters long and can consist of any UTF-8 - characters. - eucConfig: - description: EUC configuration of the NotebookRuntimeTemplate. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' - idleShutdownConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + Immutable. The update method to use with this Index. If not set, + BATCH_UPDATE will be used by default. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - The idle shutdown configuration of NotebookRuntimeTemplate. This - config will only be set when idle shutdown is enabled. + Immutable. Customer-managed encryption key spec for an Index. If + set, this Index and all sub-resources of this Index will be secured + by this key. createTime: + description: Output only. Timestamp when this Index was created. format: google-datetime + type: string readOnly: true + metadata: + type: any + description: >- + An additional information about the Index; the schema of the + metadata can be found in metadata_schema. + metadataSchemaUri: + description: >- + Immutable. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Index, that is specific + to it. Unset if the Index does not have any additional information. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + Note: The URI given on output will be immutable and probably + different, including the URI scheme, than the one given on input. + The output URI will point to a location where the user only has a + read access. + type: string + description: type: string + description: The description of the Index. + deployedIndexes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' + readOnly: true description: >- - Output only. Timestamp when this NotebookRuntimeTemplate was - created. - dataPersistentDiskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' + Output only. The pointers to DeployedIndexes created from this + Index. An Index can be only deleted if all its DeployedIndexes had + been undeployed first. + displayName: + type: string description: >- - Optional. The specification of persistent disk attached to the - runtime as data disk storage. - serviceAccount: + Required. The display name of the Index. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + updateTime: type: string + readOnly: true description: >- - The service account that the runtime workload runs as. You can use - any service account within the same project, but you must have the - service account user permission to use the instance. If not - specified, the [Compute Engine default service - account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) - is used. - type: object - GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: - id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature - description: Noise sigma for a single feature. - type: object - properties: - sigma: - format: float - type: number + Output only. Timestamp when this Index was most recently updated. + This also includes any update to the contents of the Index. Note + that Operations working on this Index may have their + Operations.metadata.generic_metadata.update_time a little after the + value of this timestamp, yet that does not mean their results are + not already reflected in the Index. Result of any successfully + completed Operation on the Index is reflected in it. + format: google-datetime + labels: + type: object + additionalProperties: + type: string description: >- - This represents the standard deviation of the Gaussian kernel that - will be used to add noise to the feature prior to computing - gradients. Similar to noise_sigma but represents the noise added to - the current feature. Defaults to 0.1. - name: + The labels with user-defined metadata to organize your Indexes. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + etag: type: string description: >- - The name of the input feature for which noise sigma is provided. The - features are defined in explanation metadata inputs. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: object - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + GoogleCloudAiplatformV1IndexDatapointCrowdingTag: properties: - annotationSpecs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + crowdingAttribute: + type: string description: >- - AnnotationSpecs used in the confusion matrix. For AutoML Text - Extraction, a special negative AnnotationSpec with empty `id` and - `displayName` of "NULL" will be added as the last element. - type: array - rows: - type: array - description: >- - Rows in the confusion matrix. The number of rows is equal to the - size of `annotationSpecs`. `rowsi` is the number of DataItems that - have ground truth of the `annotationSpecs[i]` and are predicted as - `annotationSpecs[j]` by the Model being evaluated. For Text - Extraction, when `annotationSpecs[i]` is the last element in - `annotationSpecs`, i.e. the special negative AnnotationSpec, `rowsi` - is the number of predicted entities of `annoatationSpec[j]` that are - not labeled as any of the ground truth AnnotationSpec. When - annotationSpecs[j] is the special negative AnnotationSpec, `rowsi` - is the number of entities have ground truth of `annotationSpec[i]` - that are not predicted as an entity by the Model. The value of the - last cell, i.e. `rowi` where i == j and `annotationSpec[i]` is the - special negative AnnotationSpec, is always 0. - items: - items: - type: any - type: array - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: - description: >- - A TrainingJob that trains and uploads an AutoML Video Classification - Model. + The attribute value used for crowding. The maximum number of + neighbors to return per crowding attribute value + (per_crowding_attribute_num_neighbors) is configured per-query. This + field is ignored if per_crowding_attribute_num_neighbors is larger + than the total number of neighbors to return for a given query. type: object - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs - description: The input parameters of this TrainingJob. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification - GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: + description: >- + Crowding tag is a constraint on a neighbor list produced by nearest + neighbor search requiring that no more than some value k' of the k + neighbors returned have the same value of crowding_attribute. + id: GoogleCloudAiplatformV1IndexDatapointCrowdingTag + GoogleCloudAiplatformV1ListModelEvaluationsResponse: properties: nextPageToken: - description: >- - A token to retrieve the next page of results. Pass to - ListHyperparameterTuningJobsRequest.page_token to obtain that page. type: string - hyperparameterTuningJobs: - type: array description: >- - List of HyperparameterTuningJobs in the requested page. - HyperparameterTuningJob.trials of the jobs will be not be returned. + A token to retrieve next page of results. Pass to + ListModelEvaluationsRequest.page_token to obtain that page. + modelEvaluations: + description: List of ModelEvaluations in the requested page. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob - description: Response message for JobService.ListHyperparameterTuningJobs - id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse - type: object - GoogleCloudAiplatformV1ListIndexEndpointsResponse: - description: Response message for IndexEndpointService.ListIndexEndpoints. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + type: array + id: GoogleCloudAiplatformV1ListModelEvaluationsResponse type: object + description: Response message for ModelService.ListModelEvaluations. + GoogleCloudAiplatformV1ListOptimalTrialsResponse: + id: GoogleCloudAiplatformV1ListOptimalTrialsResponse + description: Response message for VizierService.ListOptimalTrials. properties: - nextPageToken: - type: string + optimalTrials: description: >- - A token to retrieve next page of results. Pass to - ListIndexEndpointsRequest.page_token to obtain that page. - indexEndpoints: - description: List of IndexEndpoints in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + The pareto-optimal Trials for multiple objective Study or the + optimal trial for single objective Study. The definition of + pareto-optimal can be checked in wiki page. + https://en.wikipedia.org/wiki/Pareto_efficiency type: array - id: GoogleCloudAiplatformV1ListIndexEndpointsResponse - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics + GoogleCloudAiplatformV1DeployModelRequest: properties: - bleu: - type: number + trafficSplit: + type: object + additionalProperties: + type: integer + format: int32 description: >- - BLEU (bilingual evaluation understudy) scores based on sacrebleu - implementation. - format: float - rougeLSum: - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. - format: float - type: number - GoogleCloudAiplatformV1FileData: - id: GoogleCloudAiplatformV1FileData + A map from a DeployedModel's ID to the percentage of this Endpoint's + traffic that should be forwarded to that DeployedModel. If this + field is non-empty, then the Endpoint's traffic_split will be + overwritten with it. To refer to the ID of the just being deployed + Model, a "0" should be used, and the actual ID of the new + DeployedModel will be filled in its place by this method. The + traffic percentage values must add up to 100. If this field is + empty, then the Endpoint's traffic_split is not updated. + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: >- + Required. The DeployedModel to be created within the Endpoint. Note + that Endpoint.traffic_split must be updated for the DeployedModel to + start receiving traffic, either as part of this call, or via + EndpointService.UpdateEndpoint. + type: object + description: Request message for EndpointService.DeployModel. + id: GoogleCloudAiplatformV1DeployModelRequest + GoogleCloudAiplatformV1StructFieldValue: + id: GoogleCloudAiplatformV1StructFieldValue properties: - fileUri: - description: Required. URI. - type: string - mimeType: - description: Required. The IANA standard MIME type of the source data. + value: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: The value for this field. + name: + description: Name of the field in the struct feature. type: string - description: URI based data. type: object - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: - description: The config for Featurestore Monitoring threshold. - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + description: One field of a Struct (or object) type feature value. + GoogleCloudAiplatformV1Tensor: type: object properties: - value: - type: number - format: double - description: >- - Specify a threshold value that can trigger the alert. 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. Each feature - must have a non-zero threshold if they need to be monitored. - Otherwise no alert will be triggered for that feature. - GoogleCloudAiplatformV1Feature: - description: >- - Feature Metadata information. For example, color is a feature that - describes an apple. - properties: - disableMonitoring: - description: >- - Optional. Only applicable for Vertex AI Feature Store (Legacy). If - not set, use the monitoring_config defined for the EntityType this - Feature belongs to. Only Features with type (Feature.ValueType) - BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, - all types of data monitoring are disabled despite the config on - EntityType. - type: boolean - description: - type: string - description: Description of the Feature. - etag: - description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - type: string - name: + uintVal: + type: array + description: UINT8 UINT16 UINT32 + items: + format: uint32 + type: integer + floatVal: + description: FLOAT + type: array + items: + type: number + format: float + uint64Val: + type: array + description: UINT64 + items: + format: uint64 + type: string + structVal: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: A map of string to tensor. + type: object + int64Val: + description: INT64 + items: + type: string + format: int64 + type: array + stringVal: + type: array + items: + type: string + description: STRING + shape: + items: + format: int64 + type: string + type: array + description: Shape of the tensor. + dtype: + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - STRING + - FLOAT + - DOUBLE + - INT8 + - INT16 + - INT32 + - INT64 + - UINT8 + - UINT16 + - UINT32 + - UINT64 type: string + description: The data type of tensor. + enumDescriptions: + - >- + Not a legal value for DataType. Used to indicate a DataType field + has not been set. + - >- + Data types that all computation devices are expected to be capable + to support. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + boolVal: description: >- - Immutable. Name of the Feature. Format: - `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` - `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` - The last part feature is assigned by the client. The feature can be - up to 64 characters long and can consist only of ASCII Latin letters - A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a - letter. The value will be unique given an entity type. - versionColumnName: + Type specific representations that make it easy to create tensor + protos in all languages. Only the representation corresponding to + "dtype" can be set. The values hold the flattened representation of + the tensor in row major order. BOOL + items: + type: boolean + type: array + listVal: + type: array + description: A list of tensor values. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + doubleVal: + type: array + items: + format: double + type: number + description: DOUBLE + intVal: + description: INT_8 INT_16 INT_32 + items: + format: int32 + type: integer + type: array + tensorVal: + format: byte type: string + description: Serialized raw tensor content. + bytesVal: + type: array + description: STRING + items: + type: string + format: byte + description: A tensor value type. + id: GoogleCloudAiplatformV1Tensor + GoogleCloudAiplatformV1FeatureViewBigQuerySource: + properties: + entityIdColumns: + description: Required. Columns to construct entity_id / row keys. + items: + type: string + type: array + uri: description: >- - Only applicable for Vertex AI Feature Store. The name of the - BigQuery Table/View column hosting data for this version. If no - value is provided, will use feature_id. - updateTime: - format: google-datetime - readOnly: true + Required. The BigQuery view URI that will be materialized on each + sync trigger based on FeatureView.SyncConfig. type: string + type: object + id: GoogleCloudAiplatformV1FeatureViewBigQuerySource + GoogleCloudAiplatformV1ListContextsResponse: + properties: + nextPageToken: description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was most recently updated. - pointOfContact: + A token, which can be sent as ListContextsRequest.page_token to + retrieve the next page. If this field is not populated, there are no + subsequent pages. type: string - description: >- - Entity responsible for maintaining this feature. Can be comma - separated list of email addresses or URIs. - labels: - description: >- - Optional. The labels with user-defined metadata to organize your - Features. Label keys and values can be no longer than 64 characters - (Unicode codepoints), can only contain lowercase letters, numeric - characters, underscores and dashes. International characters are - allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one Feature (System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - additionalProperties: - type: string - type: object - createTime: - description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - Timestamp when this EntityType was created. + contexts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + description: The Contexts retrieved from the MetadataStore. + type: object + id: GoogleCloudAiplatformV1ListContextsResponse + description: Response message for MetadataService.ListContexts. + GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + description: Runtime operation information for DatasetService.CreateDatasetVersion. + type: object + id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata + GoogleCloudAiplatformV1UploadModelResponse: + type: object + properties: + modelVersionId: readOnly: true - format: google-datetime type: string - monitoringStatsAnomalies: + description: Output only. The version ID of the model that is uploaded. + model: + type: string description: >- - Output only. Only applicable for Vertex AI Feature Store (Legacy). - The list of historical stats and anomalies with specified - objectives. + The name of the uploaded Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` + description: Response message of ModelService.UploadModel operation. + id: GoogleCloudAiplatformV1UploadModelResponse + GoogleCloudAiplatformV1RemoveContextChildrenRequest: + description: Request message for MetadataService.DeleteContextChildrenRequest. + properties: + childContexts: type: array - readOnly: true items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly - valueType: - type: string - enumDescriptions: - - The value type is unspecified. - - Used for Feature that is a boolean. - - Used for Feature that is a list of boolean. - - Used for Feature that is double. - - Used for Feature that is a list of double. - - Used for Feature that is INT64. - - Used for Feature that is a list of INT64. - - Used for Feature that is string. - - Used for Feature that is a list of String. - - Used for Feature that is bytes. - - Used for Feature that is struct. - description: >- - Immutable. Only applicable for Vertex AI Feature Store (Legacy). - Type of Feature value. - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - BOOL_ARRAY - - DOUBLE - - DOUBLE_ARRAY - - INT64 - - INT64_ARRAY - - STRING - - STRING_ARRAY - - BYTES - - STRUCT - type: object - id: GoogleCloudAiplatformV1Feature - GoogleCloudAiplatformV1ListCustomJobsResponse: - id: GoogleCloudAiplatformV1ListCustomJobsResponse - description: Response message for JobService.ListCustomJobs + type: string + description: The resource names of the child Contexts. type: object + id: GoogleCloudAiplatformV1RemoveContextChildrenRequest + GoogleCloudAiplatformV1GroundingMetadata: + id: GoogleCloudAiplatformV1GroundingMetadata properties: - customJobs: + webSearchQueries: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + type: string type: array - description: List of CustomJobs in the requested page. - nextPageToken: - type: string + description: Optional. Web search queries for the following-up web search. + searchEntryPoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' + description: Optional. Google search entry for the following-up web searches. + groundingSupports: + type: array + description: Optional. List of grounding support. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingSupport' + groundingChunks: description: >- - A token to retrieve the next page of results. Pass to - ListCustomJobsRequest.page_token to obtain that page. + List of supporting references retrieved from specified grounding + source. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunk' + description: Metadata returned to client when grounding is enabled. + type: object GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig: type: object - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig properties: explanationConfig: $ref: >- #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig description: The config for integrating with Vertex Explainable AI. + trainingDataset: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset + description: >- + Training dataset for models. This field has to be set only if + TrainingPredictionSkewDetectionConfig is specified. trainingPredictionSkewDetectionConfig: - description: The config for skew between training data and prediction data. $ref: >- #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + description: The config for skew between training data and prediction data. predictionDriftDetectionConfig: description: The config for drift of prediction data. $ref: >- #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig - trainingDataset: - description: >- - Training dataset for models. This field has to be set only if - TrainingPredictionSkewDetectionConfig is specified. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingDataset description: >- The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model. - GoogleCloudAiplatformV1MigrateResourceRequest: - id: GoogleCloudAiplatformV1MigrateResourceRequest + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig + GoogleCloudAiplatformV1NearestNeighborQueryParameters: + properties: + leafNodesSearchFraction: + description: >- + Optional. The fraction of the number of leaves to search, set at + query time allows user to tune search performance. This value + increase result in both search accuracy and latency increase. The + value should be between 0.0 and 1.0. + format: double + type: number + approximateNeighborCandidates: + description: >- + Optional. The number of neighbors to find via approximate search + before exact reordering is performed; if set, this value must be > + neighbor_count. + format: int32 + type: integer type: object description: >- - Config of migrating one resource from automl.googleapis.com, - datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. + Parameters that can be overrided in each query to tune query latency and + recall. + id: GoogleCloudAiplatformV1NearestNeighborQueryParameters + GoogleCloudAiplatformV1ModelOriginalModelInfo: + description: Contains information about the original Model if this Model is a copy. + type: object + id: GoogleCloudAiplatformV1ModelOriginalModelInfo properties: - migrateAutomlModelConfig: + model: + readOnly: true description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's + Output only. The resource name of the Model this Model is a copy of, + including the revision. Format: + `projects/{project}/locations/{location}/models/{model_id}@{version_id}` + type: string + GoogleCloudAiplatformV1ModelEvaluationSlice: + id: GoogleCloudAiplatformV1ModelEvaluationSlice + description: >- + A collection of metrics calculated by comparing Model's predictions on a + slice of the test data against ground truth annotations. + properties: + name: + description: Output only. The resource name of the ModelEvaluationSlice. + readOnly: true + type: string + createTime: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this ModelEvaluationSlice was created. + type: string + slice: + readOnly: true + description: >- + Output only. The slice of the test data that is used to evaluate the Model. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig - migrateAutomlDatasetConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSlice + modelExplanation: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' description: >- - Config for migrating Dataset in automl.googleapis.com to Vertex AI's - Dataset. - migrateMlEngineModelVersionConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + Output only. Aggregated explanation metrics for the Model's + prediction output over the data this ModelEvaluation uses. This + field is populated only if the Model is evaluated with explanations, + and only for tabular Models. + readOnly: true + metricsSchemaUri: + type: string description: >- - Config for migrating Version in ml.googleapis.com to Vertex AI's - Model. - migrateDataLabelingDatasetConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + Output only. Points to a YAML file stored on Google Cloud Storage + describing the metrics of this ModelEvaluationSlice. The schema is + defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + readOnly: true + metrics: description: >- - Config for migrating Dataset in datalabeling.googleapis.com to - Vertex AI's Dataset. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation: + Output only. Sliced evaluation metrics of the Model. The schema of + the metrics is stored in metrics_schema_uri + type: any + readOnly: true type: object - properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation - description: >- - Treats the column as text array and performs following transformation - functions. * Concatenate all text values in the array into a single text - value using a space (" ") as a delimiter, and then treat the result as a - single text value. Apply the transformations for Text columns. * Empty - arrays treated as an empty text. - GoogleCloudAiplatformV1PipelineJobRuntimeConfig: + GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata: type: object + id: GoogleCloudAiplatformV1BatchReadFeatureValuesOperationMetadata + description: Details of operations that batch reads Feature values. properties: - parameters: - deprecated: true - description: >- - Deprecated. Use RuntimeConfig.parameter_values instead. The runtime - parameters of the PipelineJob. The parameters will be passed into - PipelineJob.pipeline_spec to replace the placeholders at runtime. - This field is used by pipelines built using - `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as - pipelines built using Kubeflow Pipelines SDK 1.8 or lower. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Value' - type: object - failurePolicy: - type: string - description: >- - Represents the failure policy of a pipeline. Currently, the default - of a pipeline is that the pipeline will continue to run until no - more tasks can be executed, also known as - PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to - PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new - tasks when a task has failed. Any scheduled tasks will continue to - completion. - enum: - - PIPELINE_FAILURE_POLICY_UNSPECIFIED - - PIPELINE_FAILURE_POLICY_FAIL_SLOW - - PIPELINE_FAILURE_POLICY_FAIL_FAST - enumDescriptions: - - Default value, and follows fail slow behavior. - - >- - Indicates that the pipeline should continue to run until all - possible tasks have been scheduled and completed. - - >- - Indicates that the pipeline should stop scheduling new tasks after - a task has failed. - parameterValues: - description: >- - The runtime parameters of the PipelineJob. The parameters will be - passed into PipelineJob.pipeline_spec to replace the placeholders at - runtime. This field is used by pipelines built using - `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines - built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. - additionalProperties: - type: any - type: object - gcsOutputDirectory: - description: >- - Required. A path in a Cloud Storage bucket, which will be treated as - the root output directory of the pipeline. It is used by the system - to generate the paths of output artifacts. The artifact paths are - generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` - under the specified output directory. The service account specified - in this pipeline must have the `storage.objects.get` and - `storage.objects.create` permissions for this bucket. - type: string - inputArtifacts: - description: >- - The runtime artifacts of the PipelineJob. The key will be the input - artifact name and the value would be one of the InputArtifact. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact - type: object - description: The runtime config of a PipelineJob. - id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore batch read Features values. + GoogleCloudAiplatformV1FileData: + id: GoogleCloudAiplatformV1FileData + description: URI based data. properties: - impactedFeatureCount: - type: string - format: int64 - description: >- - The count of the features or columns impacted. This is the same as - the feature count in the request. - onlineStorageModifiedEntityCount: - description: >- - The count of modified entities in the online storage. Each entity ID - corresponds to one entity. Within each entity, only the features - specified in the request are deleted. + fileUri: type: string - format: int64 - offlineStorageModifiedEntityRowCount: - format: int64 - description: >- - The count of modified entity rows in the offline storage. Each row - corresponds to the combination of an entity ID and a timestamp. One - entity ID can have multiple rows in the offline storage. Within each - row, only the features specified in the request are deleted. + description: Required. URI. + mimeType: type: string - id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - description: >- - Response message if the request uses the SelectTimeRangeAndFeature - option. + description: Required. The IANA standard MIME type of the source data. type: object - GoogleCloudAiplatformV1GenerateContentRequest: + GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: type: object - id: GoogleCloudAiplatformV1GenerateContentRequest properties: - toolConfig: - description: >- - Optional. Tool config. This config is shared for all tools provided - in the request. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' - generationConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' - description: Optional. Generation config. - tools: - type: array - description: >- - Optional. A list of `Tools` the model may use to generate the next - response. A `Tool` is a piece of code that enables the system to - interact with external systems to perform an action, or set of - actions, outside of knowledge and scope of the model. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' - contents: + count: + type: number + readOnly: true + format: double + description: Output only. Number of values in the bucket. + right: + description: Output only. Right bound of the bucket. + format: double + type: number + readOnly: true + left: + readOnly: true + format: double + type: number + description: Output only. Left bound of the bucket. + description: >- + Dataset bucket used to create a histogram for the distribution given a + population of values. + id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket + GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: + description: Response message for ListDeploymentResourcePools method. + id: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse + properties: + deploymentResourcePools: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - type: array - description: >- - Required. The content of the current conversation with the model. - For single-turn queries, this is a single instance. For multi-turn - queries, this is a repeated field that contains conversation history - + latest request. - safetySettings: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' type: array + description: The DeploymentResourcePools from the specified location. + nextPageToken: description: >- - Optional. Per request settings for blocking unsafe content. Enforced - on GenerateContentResponse.candidates. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' - systemInstruction: - description: >- - Optional. The user provided system instructions for the model. Note: - only text should be used in parts and content in each part will be - in a separate paragraph. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: Request message for [PredictionService.GenerateContent]. - GoogleCloudAiplatformV1ModelEvaluationSlice: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string type: object - id: GoogleCloudAiplatformV1ModelEvaluationSlice + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse: description: >- - A collection of metrics calculated by comparing Model's predictions on a - slice of the test data against ground truth annotations. - properties: - metrics: - readOnly: true - type: any - description: >- - Output only. Sliced evaluation metrics of the Model. The schema of - the metrics is stored in metrics_schema_uri - createTime: - format: google-datetime - description: Output only. Timestamp when this ModelEvaluationSlice was created. - type: string - readOnly: true - metricsSchemaUri: - type: string - description: >- - Output only. Points to a YAML file stored on Google Cloud Storage - describing the metrics of this ModelEvaluationSlice. The schema is - defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - readOnly: true - name: - readOnly: true - description: Output only. The resource name of the ModelEvaluationSlice. - type: string - slice: - description: >- - Output only. The slice of the test data that is used to evaluate the - Model. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSlice - modelExplanation: - description: >- - Output only. Aggregated explanation metrics for the Model's - prediction output over the data this ModelEvaluation uses. This - field is populated only if the Model is evaluated with explanations, - and only for tabular Models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' - readOnly: true - GoogleCloudAiplatformV1GcsSource: - description: The Google Cloud Storage location for the input content. + Response message for + TensorboardService.BatchCreateTensorboardTimeSeries. + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse type: object - id: GoogleCloudAiplatformV1GcsSource properties: - uris: - type: array + tensorboardTimeSeries: items: - type: string - description: >- - Required. Google Cloud Storage URI(-s) to the input file(s). May - contain wildcards. For more information on wildcards, see - https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. - GoogleCloudAiplatformV1NfsMount: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + description: The created TensorboardTimeSeries. + type: array + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult: + description: Spec for pairwise question answering quality result. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult properties: - path: - type: string - description: >- - Required. Source path exported from NFS server. Has to start with - '/', and combined with the ip address, it indicates the source mount - path in the form of `server:path` - mountPoint: - description: >- - Required. Destination mount path. The NFS will be mounted for the - user under /mnt/nfs/ + confidence: + format: float + description: Output only. Confidence for question answering quality score. + type: number + readOnly: true + pairwiseChoice: + readOnly: true + enum: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + enumDescriptions: + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined type: string - server: + description: Output only. Pairwise question answering prediction choice. + explanation: + description: Output only. Explanation for question answering quality score. + readOnly: true type: string - description: Required. IP address of the NFS server. type: object - description: Represents a mount configuration for Network File System (NFS) to mount. - id: GoogleCloudAiplatformV1NfsMount - GoogleCloudAiplatformV1NasJobOutput: - id: GoogleCloudAiplatformV1NasJobOutput + GoogleCloudAiplatformV1SampledShapleyAttribution: + id: GoogleCloudAiplatformV1SampledShapleyAttribution type: object properties: - multiTrialJobOutput: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + pathCount: + type: integer description: >- - Output only. The output of this multi-trial Neural Architecture - Search (NAS) job. - description: Represents a uCAIP NasJob output. - GoogleCloudAiplatformV1ListNasTrialDetailsResponse: + Required. The number of feature permutations to consider when + approximating the Shapley values. Valid range of its value is [1, + 50], inclusively. + format: int32 + description: >- + An attribution method that approximates Shapley values for features that + contribute to the label being predicted. A sampling strategy is used to + approximate the value rather than considering all subsets of features. + GoogleCloudAiplatformV1ListBatchPredictionJobsResponse: + id: GoogleCloudAiplatformV1ListBatchPredictionJobsResponse properties: + batchPredictionJobs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + description: List of BatchPredictionJobs in the requested page. + type: array nextPageToken: + type: string description: >- A token to retrieve the next page of results. Pass to - ListNasTrialDetailsRequest.page_token to obtain that page. - type: string - nasTrialDetails: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' - type: array - description: List of top NasTrials in the requested page. - description: Response message for JobService.ListNasTrialDetails - id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse + ListBatchPredictionJobsRequest.page_token to obtain that page. + description: Response message for JobService.ListBatchPredictionJobs type: object - GoogleCloudAiplatformV1TimeSeriesData: + GoogleCloudAiplatformV1DirectPredictResponse: + id: GoogleCloudAiplatformV1DirectPredictResponse + properties: + outputs: + type: array + description: The prediction output. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. + description: Response message for PredictionService.DirectPredict. type: object + GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: + description: Value specification for a parameter in `CATEGORICAL` type. properties: - valueType: - type: string - enumDescriptions: - - The value type is unspecified. - - >- - Used for TensorboardTimeSeries that is a list of scalars. E.g. - accuracy of a model over epochs/time. - - >- - Used for TensorboardTimeSeries that is a list of tensors. E.g. - histograms of weights of layer in a model over epoch/time. - - >- - Used for TensorboardTimeSeries that is a list of blob sequences. - E.g. set of sample images with labels over epochs/time. - enum: - - VALUE_TYPE_UNSPECIFIED - - SCALAR - - TENSOR - - BLOB_SEQUENCE - description: >- - Required. Immutable. The value type of this time series. All the - values in this time series data must match this value type. - tensorboardTimeSeriesId: + defaultValue: description: >- - Required. The ID of the TensorboardTimeSeries, which will become the - final component of the TensorboardTimeSeries' resource name + A default value for a `CATEGORICAL` parameter that is assumed to be + a relatively good starting point. Unset value signals that there is + no offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. type: string values: - type: array + description: Required. The list of possible categories. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' - description: Required. Data points in this time series. - id: GoogleCloudAiplatformV1TimeSeriesData - description: All the data stored in a TensorboardTimeSeries. - GoogleCloudAiplatformV1Value: - id: GoogleCloudAiplatformV1Value - properties: - intValue: - type: string - format: int64 - description: An integer value. - doubleValue: - description: A double value. - format: double - type: number - stringValue: - type: string - description: A string value. + type: string + type: array + id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec type: object - description: Value is the value of the field. - GoogleCloudAiplatformV1PipelineTemplateMetadata: + GoogleCloudAiplatformV1NearestNeighborQueryStringFilter: + description: >- + String filter is used to search a subset of the entities by using + boolean rules on string columns. For example: if a query specifies + string filter with 'name = color, allow_tokens = {red, blue}, + deny_tokens = {purple}',' then that query will match entities that are + red or blue, but if those points are also purple, then they will be + excluded even if they are red/blue. Only string filter is supported for + now, numeric filter will be supported in the near future. + id: GoogleCloudAiplatformV1NearestNeighborQueryStringFilter type: object - id: GoogleCloudAiplatformV1PipelineTemplateMetadata properties: - version: + denyTokens: + items: + type: string + description: Optional. The denied tokens. + type: array + name: type: string - description: >- - The version_name in artifact registry. Will always be presented in - output if the PipelineJob.template_uri is from supported template - registry. Format is "sha256:abcdef123456...". - description: >- - Pipeline template metadata if PipelineJob.template_uri is from supported - template registry. Currently, the only supported registry is Artifact - Registry. + description: Required. Column names in BigQuery that used as filters. + allowTokens: + items: + type: string + type: array + description: Optional. The allowed tokens. GoogleCloudAiplatformV1ListSpecialistPoolsResponse: - type: object properties: - nextPageToken: - description: The standard List next-page token. - type: string specialistPools: - type: array items: $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' description: >- A list of SpecialistPools that matches the specified filter in the request. - id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse - description: Response message for SpecialistPoolService.ListSpecialistPools. - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: + type: array + nextPageToken: + type: string + description: The standard List next-page token. type: object - description: Prediction output format for Image Segmentation. + description: Response message for SpecialistPoolService.ListSpecialistPools. + id: GoogleCloudAiplatformV1ListSpecialistPoolsResponse + GoogleCloudAiplatformV1SummarizationQualityInput: + id: GoogleCloudAiplatformV1SummarizationQualityInput properties: - categoryMask: - description: >- - A PNG image where each pixel in the mask represents the category in - which the pixel in the original image was predicted to belong to. - The size of this image will be the same as the original image. The - mapping between the AnntoationSpec and the color can be found in - model's metadata. The model will choose the most likely category and - if none of the categories reach the confidence threshold, the pixel - will be marked as background. - type: string - confidenceMask: - type: string - description: >- - A one channel image which is encoded as an 8bit lossless PNG. The - size of the image will be the same as the original image. For a - specific pixel, darker color means less confidence in correctness of - the cateogry in the categoryMask for the corresponding pixel. Black - means no confidence and white means complete confidence. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult - GoogleCloudAiplatformV1Model: + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SummarizationQualitySpec' + description: Required. Spec for summarization quality score metric. + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInstance + description: Required. Summarization quality instance. + description: Input for summarization quality metric. type: object + GoogleCloudAiplatformV1DatasetVersion: properties: - dataStats: + etag: + type: string description: >- - Stats of data used for training or evaluating the Model. Only - populated when the Model is trained by a TrainingPipeline with - data_input_config. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' - versionUpdateTime: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + createTime: + description: Output only. Timestamp when this DatasetVersion was created. type: string format: google-datetime readOnly: true - description: Output only. Timestamp when this version was most recently updated. - versionDescription: + updateTime: type: string - description: The description of this version. - versionId: - description: >- - Output only. Immutable. The version ID of the model. A new version - is committed when a new model version is uploaded or trained under - an existing model id. It is an auto-incrementing decimal number in - string representation. + format: google-datetime + readOnly: true + description: Output only. Timestamp when this DatasetVersion was last updated. + bigQueryDatasetName: + description: Output only. Name of the associated BigQuery dataset. + readOnly: true + type: string + modelReference: readOnly: true type: string - labels: - type: object - additionalProperties: - type: string - description: >- - The labels with user-defined metadata to organize your Models. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - supportedInputStorageFormats: - type: array description: >- - Output only. The formats this Model supports in - BatchPredictionJob.input_config. If - PredictSchemata.instance_schema_uri exists, the instances should be - given as per that schema. The possible formats are: * `jsonl` The - JSON Lines format, where each instance is a single line. Uses - GcsSource. * `csv` The CSV format, where each instance is a single - comma-separated line. The first line in the file is the header, - containing comma-separated field names. Uses GcsSource. * - `tf-record` The TFRecord format, where each instance is a single - record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` - Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * - `bigquery` Each instance is a single row in BigQuery. Uses - BigQuerySource. * `file-list` Each line of the file is the location - of an instance to process, uses `gcs_source` field of the - InputConfig object. If this Model doesn't support any of these - formats it means it cannot be used with a BatchPredictionJob. - However, if it has supported_deployment_resources_types, it could - serve online predictions by using PredictionService.Predict or - PredictionService.Explain. - items: - type: string + Output only. Reference to the public base model last used by the + dataset version. Only set for prompt dataset versions. + name: + description: Output only. Identifier. The resource name of the DatasetVersion. readOnly: true + type: string metadata: - type: any - description: >- - Immutable. An additional information about the Model; the schema of - the metadata can be found in metadata_schema. Unset if the Model - does not have any additional information. - modelSourceInfo: - description: >- - Output only. Source of a model. It can either be automl training - pipeline, custom training pipeline, BigQuery ML, or saved and tuned - from Genie or Model Garden. readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelSourceInfo' - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + type: any description: >- - Customer-managed encryption key spec for a Model. If set, this Model - and all sub-resources of this Model will be secured by this key. + Required. Output only. Additional information about the + DatasetVersion. displayName: type: string description: >- - Required. The display name of the Model. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - pipelineJob: - type: string - description: >- - Optional. This field is populated if the model is produced by a - pipeline job. - originalModelInfo: + The user-defined name of the DatasetVersion. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean readOnly: true + id: GoogleCloudAiplatformV1DatasetVersion + type: object + description: Describes the dataset version. + GoogleCloudAiplatformV1ResumeScheduleRequest: + properties: + catchUp: + type: boolean description: >- - Output only. If this Model is a copy of another Model, this contains - info about the original. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' - versionAliases: - type: array + Optional. Whether to backfill missed runs when the schedule is + resumed from PAUSED state. If set to true, all missed runs will be + scheduled. New runs will be scheduled after the backfill is + complete. This will also update Schedule.catch_up field. Default to + false. + type: object + id: GoogleCloudAiplatformV1ResumeScheduleRequest + description: Request message for ScheduleService.ResumeSchedule. + GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: + id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest + type: object + properties: + deploymentResourcePoolId: description: >- - User provided version aliases so that a model version can be - referenced via alias (i.e. - `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` - instead of auto-generated version id (i.e. - `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. - The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A - default version alias will be created for the first version of the - model, and there must be exactly one default version alias for a - model. + Required. The ID to use for the DeploymentResourcePool, which will + become the final component of the DeploymentResourcePool's resource + name. The maximum length is 63 characters, and valid characters are + `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. + type: string + deploymentResourcePool: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' + description: Required. The DeploymentResourcePool to create. + description: Request message for CreateDeploymentResourcePool method. + GoogleCloudAiplatformV1WriteFeatureValuesResponse: + id: GoogleCloudAiplatformV1WriteFeatureValuesResponse + properties: {} + type: object + description: >- + Response message for + FeaturestoreOnlineServingService.WriteFeatureValues. + GoogleCloudAiplatformV1SearchDataItemsResponse: + id: GoogleCloudAiplatformV1SearchDataItemsResponse + description: Response message for DatasetService.SearchDataItems. + type: object + properties: + dataItemViews: + description: The DataItemViews read. items: - type: string - description: - description: The description of the Model. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' + type: array + nextPageToken: type: string - metadataSchemaUri: + description: >- + A token to retrieve next page of results. Pass to + SearchDataItemsRequest.page_token to obtain that page. + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: + type: object + properties: + onlineStorageDeletedEntityCount: type: string + format: int64 description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Model, that is specific - to it. Unset if the Model does not have any additional information. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI, if no - additional metadata is needed, this field is set to an empty string. - Note: The URI given on output will be immutable and probably - different, including the URI scheme, than the one given on input. - The output URI will point to a location where the user only has a - read access. - predictSchemata: + The count of deleted entities in the online storage. Each entity ID + corresponds to one entity. + offlineStorageDeletedEntityRowCount: + format: int64 description: >- - The schemata that describe formats of the Model's predictions and - explanations as given and returned via PredictionService.Predict and - PredictionService.Explain. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - etag: + The count of deleted entity rows in the offline storage. Each row + corresponds to the combination of an entity ID and a timestamp. One + entity ID can have multiple rows in the offline storage. type: string + id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity + description: Response message if the request uses the SelectEntity option. + GoogleCloudAiplatformV1FeatureGroupBigQuery: + type: object + id: GoogleCloudAiplatformV1FeatureGroupBigQuery + properties: + dense: + description: >- + Optional. If set, all feature values will be fetched from a single + row per unique entityId including nulls. If not set, will collapse + all rows for each unique entityId into a singe row with any non-null + values if present, if no non-null values are present will sync null. + ex: If source has schema (entity_id, feature_timestamp, f0, f1) and + values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, + 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) + is synced to online stores. If dense is not set, (e1, 20, 15) is + synced to online stores. + type: boolean + bigQuerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - supportedOutputStorageFormats: + Required. Immutable. The BigQuery source URI that points to either a + BigQuery Table or View. + staticDataSource: + description: Optional. Set if the data source is not a time-series. + type: boolean + timeSeries: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries description: >- - Output only. The formats this Model supports in - BatchPredictionJob.output_config. If both - PredictSchemata.instance_schema_uri and - PredictSchemata.prediction_schema_uri exist, the predictions are - returned together with their instances. In other words, the - prediction has the original instance data first, followed by the - actual prediction content (as per the schema). The possible formats - are: * `jsonl` The JSON Lines format, where each prediction is a - single line. Uses GcsDestination. * `csv` The CSV format, where each - prediction is a single comma-separated line. The first line in the - file is the header, containing comma-separated field names. Uses - GcsDestination. * `bigquery` Each prediction is a single row in a - BigQuery table, uses BigQueryDestination . If this Model doesn't - support any of these formats it means it cannot be used with a - BatchPredictionJob. However, if it has - supported_deployment_resources_types, it could serve online - predictions by using PredictionService.Predict or - PredictionService.Explain. - type: array - readOnly: true + Optional. If the source is a time-series source, this can be set to + control how downstream sources (ex: FeatureView ) will treat + time-series sources. If not set, will treat the source as a + time-series source with `feature_timestamp` as timestamp column and + no scan boundary. + entityIdColumns: + description: >- + Optional. Columns to construct entity_id / row keys. If not provided + defaults to `entity_id`. items: type: string - deployedModels: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' type: array + description: Input source type for BigQuery Tables and Views. + GoogleCloudAiplatformV1FeatureViewDataKey: + description: Lookup key for a feature view. + type: object + properties: + compositeKey: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey description: >- - Output only. The pointers to DeployedModels created from this Model. - Note that Model could have been deployed to Endpoints in different - Locations. - readOnly: true - containerSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' - description: >- - Input only. The specification of the container that is to be used - when deploying this Model. The specification is ingested upon - ModelService.UploadModel, and all binaries it contains are copied - and stored internally by Vertex AI. Not required for AutoML Models. - baseModelSource: - description: >- - Optional. User input field to specify the base model source. - Currently it only supports specifing the Model Garden models and - Genie models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelBaseModelSource' - updateTime: - format: google-datetime - description: Output only. Timestamp when this Model was most recently updated. - type: string - readOnly: true - artifactUri: - type: string - description: >- - Immutable. The path to the directory containing the Model artifact - and any of its supporting files. Not required for AutoML Models. - versionCreateTime: - readOnly: true - format: google-datetime + The actual Entity ID will be composed from this struct. This should + match with the way ID is defined in the FeatureView spec. + key: type: string - description: Output only. Timestamp when this version was created. - supportedExportFormats: - readOnly: true + description: String key to use for lookup. + id: GoogleCloudAiplatformV1FeatureViewDataKey + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics + description: Model evaluation metrics for text sentiment problems. + properties: + confusionMatrix: description: >- - Output only. The formats in which this Model may be exported. If - empty, this Model is not available for export. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExportFormat' - type: array - name: - type: string - description: The resource name of the Model. - explanationSpec: + Confusion matrix of the evaluation. Only set for ModelEvaluations, + not for ModelEvaluationSlices. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + f1Score: + type: number + format: float + description: The harmonic mean of recall and precision. + recall: + description: Recall. + format: float + type: number + meanAbsoluteError: description: >- - The default explanation specification for this Model. The Model can - be used for requesting explanation after being deployed if it is - populated. The Model can be used for batch explanation if it is - populated. All fields of the explanation_spec can be overridden by - explanation_spec of DeployModelRequest.deployed_model, or - explanation_spec of BatchPredictionJob. If the default explanation - specification is not set for this Model, this Model can still be - used for requesting explanation by setting explanation_spec of - DeployModelRequest.deployed_model and for batch explanation by - setting explanation_spec of BatchPredictionJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - trainingPipeline: - readOnly: true - type: string + Mean absolute error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + format: float + type: number + meanSquaredError: + format: float description: >- - Output only. The resource name of the TrainingPipeline that uploaded - this Model, if any. - createTime: - format: google-datetime - type: string - readOnly: true - description: Output only. Timestamp when this Model was uploaded into Vertex AI. - supportedDeploymentResourcesTypes: - readOnly: true + Mean squared error. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + type: number + quadraticKappa: + type: number description: >- - Output only. When this Model is deployed, its prediction resources - are described by the `prediction_resources` field of the - Endpoint.deployed_models object. Because not all Models support all - resource configuration types, the configuration types this Model - supports are listed here. If no configuration types are listed, the - Model cannot be deployed to an Endpoint and does not support online - predictions (PredictionService.Predict or - PredictionService.Explain). Such a Model can serve predictions by - using a BatchPredictionJob, if it has at least one entry each in - supported_input_storage_formats and - supported_output_storage_formats. - type: array - items: - enumDescriptions: - - Should not be used. - - >- - Resources that are dedicated to the DeployedModel, and that need - a higher degree of manual configuration. - - >- - Resources that to large degree are decided by Vertex AI, and - require only a modest additional configuration. - - >- - Resources that can be shared by multiple DeployedModels. A - pre-configured DeploymentResourcePool is required. - enum: - - DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED - - DEDICATED_RESOURCES - - AUTOMATIC_RESOURCES - - SHARED_RESOURCES - type: string - metadataArtifact: + Quadratic weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. + format: float + precision: + format: float + type: number + description: Precision. + linearKappa: + type: number + format: float description: >- - Output only. The resource name of the Artifact that was created in - MetadataStore when creating the Model. The Artifact resource name - pattern is - `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. - type: string - readOnly: true - description: A trained machine learning Model. - id: GoogleCloudAiplatformV1Model - GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: - type: object - properties: - genericMetadata: - description: Operation metadata for FeatureOnlineStore. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata - description: Details of operations that perform update FeatureOnlineStore. - GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: - id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest + Linear weighted kappa. Only set for ModelEvaluations, not for + ModelEvaluationSlices. type: object - description: Request message for ModelService.UpdateExplanationDataset. - properties: - examples: - description: The example config containing the location of the dataset. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' - GoogleCloudAiplatformV1MigratableResource: - id: GoogleCloudAiplatformV1MigratableResource - description: >- - Represents one resource that exists in automl.googleapis.com, - datalabeling.googleapis.com or ml.googleapis.com. + GoogleCloudAiplatformV1PipelineTaskExecutorDetail: type: object properties: - mlEngineModelVersion: - description: Output only. Represents one Version in ml.googleapis.com. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion - readOnly: true - automlDataset: - description: Output only. Represents one Dataset in automl.googleapis.com. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset - readOnly: true - dataLabelingDataset: - description: Output only. Represents one Dataset in datalabeling.googleapis.com. + containerDetail: readOnly: true + description: Output only. The detailed info for a container executor. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset - automlModel: - description: Output only. Represents one Model in automl.googleapis.com. + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + customJobDetail: readOnly: true $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel - lastUpdateTime: - type: string - format: google-datetime + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + description: Output only. The detailed info for a custom job executor. + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail + description: The runtime detail of a pipeline executor. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + type: object + properties: + iouScore: + type: number + format: float description: >- - Output only. Timestamp when this MigratableResource was last - updated. - readOnly: true - lastMigrateTime: - type: string + The intersection-over-union score. The measure of overlap of the + annotation's category mask with ground truth category mask on the + DataItem. + precision: + format: float + description: Precision for the given confidence threshold. + type: number + diceScoreCoefficient: + description: DSC or the F1 score, The harmonic mean of recall and precision. + format: float + type: number + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix for the given confidence threshold. + confidenceThreshold: description: >- - Output only. Timestamp when the last migration attempt on this - MigratableResource started. Will not be set if there's no migration - attempt on this MigratableResource. - readOnly: true - format: google-datetime - GoogleCloudAiplatformV1Trial: - id: GoogleCloudAiplatformV1Trial + Metrics are computed with an assumption that the model never returns + predictions with score lower than this value. + format: float + type: number + recall: + type: number + format: float + description: Recall (True Positive Rate) for the given confidence threshold. + GoogleCloudAiplatformV1TrialContext: type: object + id: GoogleCloudAiplatformV1TrialContext properties: + description: + description: >- + A human-readable field which can store a description of this + context. This will become part of the resulting Trial's description + field. + type: string parameters: - description: Output only. The parameters of the Trial. - readOnly: true - type: array items: $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' - state: - enumDescriptions: - - The Trial state is unspecified. - - >- - Indicates that a specific Trial has been requested, but it has not - yet been suggested by the service. - - Indicates that the Trial has been suggested. - - Indicates that the Trial should stop according to the service. - - Indicates that the Trial is completed successfully. - - >- - Indicates that the Trial should not be attempted again. The - service will set a Trial to INFEASIBLE when it's done but missing - the final_measurement. - type: string - description: Output only. The detailed state of the Trial. - readOnly: true - enum: - - STATE_UNSPECIFIED - - REQUESTED - - ACTIVE - - STOPPING - - SUCCEEDED - - INFEASIBLE - startTime: - type: string - format: google-datetime - description: Output only. Time when the Trial was started. - readOnly: true - infeasibleReason: - type: string + type: array description: >- - Output only. A human readable string describing why the Trial is - infeasible. This is set only if Trial state is `INFEASIBLE`. - readOnly: true - measurements: + If/when a Trial is generated or selected from this Context, its + Parameters will match any parameters specified here. (I.e. if this + context specifies parameter name:'a' int_value:3, then a resulting + Trial will have int_value:3 for its parameter named 'a'.) Note that + we first attempt to match existing REQUESTED Trials with contexts, + and if there are no matches, we generate suggestions in the subspace + defined by the parameters specified here. NOTE: a Context without + any Parameters matches the entire feasible search space. + GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse: + id: GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse + type: object + properties: + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListHyperparameterTuningJobsRequest.page_token to obtain that page. + hyperparameterTuningJobs: type: array description: >- - Output only. A list of measurements that are strictly - lexicographically ordered by their induced tuples (steps, - elapsed_duration). These are used for early stopping computations. + List of HyperparameterTuningJobs in the requested page. + HyperparameterTuningJob.trials of the jobs will be not be returned. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + description: Response message for JobService.ListHyperparameterTuningJobs + GoogleCloudAiplatformV1DeployedModel: + type: object + description: A deployment of a Model. Endpoints contain one or more DeployedModels. + id: GoogleCloudAiplatformV1DeployedModel + properties: + createTime: + description: Output only. Timestamp when the DeployedModel was created. + format: google-datetime + type: string readOnly: true - webAccessUris: + disableExplanations: + type: boolean description: >- - Output only. URIs for accessing [interactive - shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - (one URI for each training node). Only available if this trial is - part of a HyperparameterTuningJob and the job's - trial_job_spec.enable_web_access field is `true`. The keys are names - of each node used for the trial; for example, `workerpool0-0` for - the primary node, `workerpool1-0` for the first node in the second - worker pool, and `workerpool1-1` for the second node in the second - worker pool. The values are the URIs for each node's interactive - shell. - type: object - additionalProperties: - type: string - readOnly: true - customJob: + If true, deploy the model without explainable feature, regardless + the existence of Model.explanation_spec or explanation_spec. + displayName: type: string description: >- - Output only. The CustomJob name linked to the Trial. It's set for a - HyperparameterTuningJob's Trial. - readOnly: true - endTime: - format: google-datetime + The display name of the DeployedModel. If not provided upon + creation, the Model's display_name is used. + model: type: string description: >- - Output only. Time when the Trial's status changed to `SUCCEEDED` or - `INFEASIBLE`. - readOnly: true + Required. The resource name of the Model that this is the deployment + of. Note that the Model may be in a different location than the + DeployedModel's Endpoint. The resource name may contain version id + or version alias to specify the version. Example: + `projects/{project}/locations/{location}/models/{model}@2` or + `projects/{project}/locations/{location}/models/{model}@golden` if + no version is specified, the default version will be deployed. + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + description: >- + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + explanationSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + description: >- + Explanation configuration for this DeployedModel. When deploying a + Model using EndpointService.DeployModel, this value overrides the + value of Model.explanation_spec. All fields of explanation_spec are + optional in the request. If a field of explanation_spec is not + populated, the value of the same field of Model.explanation_spec is + inherited. If the corresponding Model.explanation_spec is not + populated, all fields of the explanation_spec will be used for the + explanation configuration. id: - description: Output only. The identifier of the Trial assigned by the service. - readOnly: true + description: >- + Immutable. The ID of the DeployedModel. If not provided upon + deployment, Vertex AI will generate a value for this ID. This value + should be 1-10 characters, and valid characters are `/[0-9]/`. type: string - finalMeasurement: - readOnly: true - description: Output only. The final measurement containing the objective value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - clientId: + enableAccessLogging: + type: boolean description: >- - Output only. The identifier of the client that originally requested - this Trial. Each client is identified by a unique client_id. When a - client asks for a suggestion, Vertex AI Vizier will assign it a - Trial. The client should evaluate the Trial, complete it, and report - back to Vertex AI Vizier. If suggestion is asked again by same - client_id before the Trial is completed, the same Trial will be - returned. Multiple clients with different client_ids can ask for - suggestions simultaneously, each of them will get their own Trial. - readOnly: true + If true, online prediction access logs are sent to Cloud Logging. + These logs are like standard server access logs, containing + information like timestamp and latency for each prediction request. + Note that logs may incur a cost, especially if your project receives + prediction requests at a high queries per second rate (QPS). + Estimate your costs before enabling this option. + sharedResources: + description: >- + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` type: string - name: - description: Output only. Resource name of the Trial assigned by the service. + serviceAccount: type: string + description: >- + The service account that the DeployedModel's container runs as. + Specify the email address of the service account. If this service + account is not specified, the container runs as a service account + that doesn't have access to the resource project. Users deploying + the Model must have the `iam.serviceAccounts.actAs` permission on + this service account. + modelVersionId: + description: Output only. The version ID of the model that is deployed. readOnly: true - description: >- - A message representing a Trial. A Trial contains a unique set of - Parameters that has been or will be evaluated, along with the objective - metrics got by running the Trial. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs: + type: string + privateEndpoints: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' + readOnly: true + description: >- + Output only. Provide paths for users to send predict/explain/health + requests directly to the deployed model services running on Cloud + via private services access. This field is populated if network is + configured. + automaticResources: + description: >- + A description of resources that to large degree are decided by + Vertex AI, and require only a modest additional configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + disableContainerLogging: + type: boolean + description: >- + For custom-trained Models and AutoML Tabular Models, the container + of the DeployedModel instances will send `stderr` and `stdout` + streams to Cloud Logging by default. Please note that the logs incur + cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: + description: Request message for VizierService.CheckTrialEarlyStoppingState. + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + properties: {} type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata properties: - budgetMilliNodeHours: + evaluatedDataItemsBigqueryUri: + type: string + description: BigQuery destination uri for exported evaluated examples. + trainCostMilliNodeHours: + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + format: int64 + type: string + type: object + description: Model metadata specific to Seq2Seq Plus Forecasting. + GoogleCloudAiplatformV1GenerationConfig: + id: GoogleCloudAiplatformV1GenerationConfig + type: object + properties: + responseSchema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: >- + Optional. The `Schema` object allows the definition of input and + output data types. These types can be objects, but also primitives + and arrays. Represents a select subset of an [OpenAPI 3.0 schema + object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a + compatible response_mime_type must also be set. Compatible + mimetypes: `application/json`: Schema for JSON response. + routingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfig + description: Optional. Routing configuration. + topP: + type: number + format: float + description: Optional. If specified, nucleus sampling will be used. + candidateCount: + type: integer + format: int32 + description: Optional. Number of candidates to generate. + responseMimeType: + type: string + description: >- + Optional. Output response mimetype of the generated candidate text. + Supported mimetype: - `text/plain`: (default) Text output. - + `application/json`: JSON response in the candidates. The model needs + to be prompted to output the appropriate response type, otherwise + the behavior is undefined. This is a preview feature. + stopSequences: + type: array + items: + type: string + description: Optional. Stop sequences. + topK: + format: float + description: Optional. If specified, top-k sampling will be used. + type: number + maxOutputTokens: + description: >- + Optional. The maximum number of output tokens to generate per + message. + format: int32 + type: integer + frequencyPenalty: + format: float + description: Optional. Frequency penalties. + type: number + presencePenalty: + type: number + format: float + description: Optional. Positive penalties. + seed: + format: int32 + type: integer + description: Optional. Seed. + temperature: + format: float + description: Optional. Controls the randomness of predictions. + type: number + description: Generation config. + GoogleCloudAiplatformV1BoolArray: + id: GoogleCloudAiplatformV1BoolArray + description: A list of boolean values. + properties: + values: + description: A list of bool values. + type: array + items: + type: boolean + type: object + GoogleCloudAiplatformV1ServiceAccountSpec: + id: GoogleCloudAiplatformV1ServiceAccountSpec + type: object + description: >- + Configuration for the use of custom service account to run the + workloads. + properties: + enableCustomServiceAccount: + type: boolean + description: >- + Required. If true, custom user-managed service account is enforced + to run any workloads (for example, Vertex Jobs) on the resource. + Otherwise, uses the [Vertex AI Custom Code Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + serviceAccount: type: string + description: >- + Optional. Required when all below conditions are met * + `enable_custom_service_account` is true; * any runtime is specified + via `ResourceRuntimeSpec` on creation time, for example, Ray The + users must have `iam.serviceAccounts.actAs` permission on this + service account and then the specified runtime containers will run + as it. Do not set this field if you want to submit jobs using custom + service account to this PersistentResource after creation, but only + specify the `service_account` inside the job. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: + properties: + budgetMilliNodeHours: format: int64 + type: string description: >- The training budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual @@ -4877,11 +5106,11 @@ components: will stop without using the full budget and the metadata.successfulStopReason will be `model-converged`. Note, node_hour = actual_hour * number_of_nodes_involved. For modelType - `cloud`(default), the budget must be between 20,000 and 900,000 - milli node hours, inclusive. The default value is 216,000 which - represents one day in wall time, considering 9 nodes are used. For - model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, - `mobile-tf-high-accuracy-1` the training budget must be between + `cloud`(default), the budget must be between 8,000 and 800,000 milli + node hours, inclusive. The default value is 192,000 which represents + one day in wall time, considering 8 nodes are used. For model types + `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, + `mobile-tf-high-accuracy-1`, the training budget must be between 1,000 and 100,000 milli node hours, inclusive. The default value is 24,000 which represents one day in wall time on a single node that is used. @@ -4889,1047 +5118,1333 @@ components: description: >- Use the entire training budget. This disables the early stopping feature. When false the early stopping feature is enabled, which - means that AutoML Image Object Detection might stop training before + means that AutoML Image Classification might stop training before the entire training budget has been used. type: boolean tunableParameter: - description: Trainer type for Vision TrainRequest. $ref: >- #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + description: Trainer type for Vision TrainRequest. + baseModelId: + type: string + description: >- + The ID of the `base` model. If it is specified, the new model will + be trained based on the `base` model. Otherwise, the new model will + be trained from scratch. The `base` model must be in the same + Project and Location as the new Model to train, and have the same + modelType. uptrainBaseModelId: + type: string description: >- The ID of `base` model for upTraining. If it is specified, the new model will be upTrained based on the `base` model for upTraining. Otherwise, the new model will be trained from scratch. The `base` model for upTraining must be in the same Project and Location as the new Model to train, and have the same modelType. - type: string modelType: + type: string enum: - MODEL_TYPE_UNSPECIFIED - - CLOUD_HIGH_ACCURACY_1 - - CLOUD_LOW_LATENCY_1 + - CLOUD - CLOUD_1 - MOBILE_TF_LOW_LATENCY_1 - MOBILE_TF_VERSATILE_1 - MOBILE_TF_HIGH_ACCURACY_1 - - CLOUD_STREAMING_1 - - SPINENET - - YOLO + - EFFICIENTNET + - MAXVIT + - VIT + - COCA enumDescriptions: - Should not be set. - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to have a higher latency, but should - also have a higher prediction quality than other cloud models. - - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to have a low latency, but may have - lower prediction quality than other cloud models. + A Model best tailored to be used within Google Cloud, and which + cannot be exported. Default. - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Compared to the CLOUD_HIGH_ACCURACY_1 and - CLOUD_LOW_LATENCY_1 models above, it is expected to have higher - prediction quality and lower latency. + A model type best tailored to be used within Google Cloud, which + cannot be exported externally. Compared to the CLOUD model above, + it is expected to have higher prediction accuracy. - >- - A model that, in addition to being available within Google Cloud - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. Expected to have - low latency, but may have lower prediction quality than other - mobile models. + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device afterwards. + Expected to have low latency, but may have lower prediction + quality than other mobile models. - >- - A model that, in addition to being available within Google Cloud - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device with + afterwards. - >- A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) and used on a - mobile or edge device with TensorFlow afterwards. Expected to have - a higher latency, but should also have a higher prediction quality - than other mobile models. + can also be exported (see ModelService.ExportModel) as TensorFlow + or Core ML model and used on a mobile or edge device afterwards. + Expected to have a higher latency, but should also have a higher + prediction quality than other mobile models. - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Expected to best support predictions in - streaming with lower latency and lower prediction quality than - other cloud models. + EfficientNet model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. - >- - SpineNet for Model Garden training with customizable + MaxViT model for Model Garden training with customizable hyperparameters. Best tailored to be used within Google Cloud, and cannot be exported externally. - >- - YOLO for Model Garden training with customizable hyperparameters. - Best tailored to be used within Google Cloud, and cannot be - exported externally. - type: string - GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: + ViT model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + - >- + CoCa model for Model Garden training with customizable + hyperparameters. Best tailored to be used within Google Cloud, and + cannot be exported externally. + multiLabel: + type: boolean + description: >- + If false, a single-label (multi-class) Model will be trained (i.e. + assuming that for each image just up to one annotation may be + applicable). If true, a multi-label Model will be trained (i.e. + assuming that for each image multiple annotations may be + applicable). + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs + type: object + GoogleCloudAiplatformV1TunedModel: properties: + model: + type: string + description: >- + Output only. The resource name of the TunedModel. Format: + `projects/{project}/locations/{location}/models/{model}`. + readOnly: true endpoint: + readOnly: true type: string description: >- - The ml.googleapis.com endpoint that this model Version currently - lives in. Example values: * ml.googleapis.com * - us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * - asia-east1-ml.googleapis.com - version: + Output only. A resource name of an Endpoint. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}`. + type: object + id: GoogleCloudAiplatformV1TunedModel + description: >- + The Model Registry Model and Online Prediction Endpoint assiociated with + this TuningJob. + GoogleCloudAiplatformV1CreateFeatureOperationMetadata: + description: Details of operations that perform create Feature. + type: object + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata + GoogleCloudAiplatformV1MutateDeployedModelResponse: + description: Response message for EndpointService.MutateDeployedModel. + id: GoogleCloudAiplatformV1MutateDeployedModelResponse + type: object + properties: + deployedModel: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: The DeployedModel that's being mutated. + GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore. + type: object + description: Details of operations that perform update Featurestore. + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + properties: + datasetDisplayName: + type: string description: >- - Full resource name of ml engine model Version. Format: - `projects/{project}/models/{model}/versions/{version}`. + Optional. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. + dataset: type: string + description: >- + Required. Full resource name of data labeling Dataset. Format: + `projects/{project}/datasets/{dataset}`. + migrateDataLabelingAnnotatedDatasetConfigs: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig + description: >- + Optional. Configs for migrating AnnotatedDataset in + datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified + AnnotatedDatasets have to belong to the datalabeling Dataset. type: object - description: Represents one model Version in ml.googleapis.com. - id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion - GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus: - id: GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus - type: object - description: A single record of the task status. + description: >- + Config for migrating Dataset in datalabeling.googleapis.com to Vertex + AI's Dataset. + GoogleCloudAiplatformV1NasTrial: + id: GoogleCloudAiplatformV1NasTrial properties: - updateTime: - format: google-datetime + endTime: + description: >- + Output only. Time when the NasTrial's status changed to `SUCCEEDED` + or `INFEASIBLE`. readOnly: true + format: google-datetime type: string - description: Output only. Update time of this status. - error: + id: + description: Output only. The identifier of the NasTrial assigned by the service. readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. The error that occurred during the state. May be set - when the state is any of the non-final state - (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is - FAILED, the error here is final and not going to be retried. If the - state is a non-final state, the error indicates a system-error being - retried. + type: string state: + enumDescriptions: + - The NasTrial state is unspecified. + - >- + Indicates that a specific NasTrial has been requested, but it has + not yet been suggested by the service. + - Indicates that the NasTrial has been suggested. + - Indicates that the NasTrial should stop according to the service. + - Indicates that the NasTrial is completed successfully. + - >- + Indicates that the NasTrial should not be attempted again. The + service will set a NasTrial to INFEASIBLE when it's done but + missing the final_measurement. enum: - STATE_UNSPECIFIED - - PENDING - - RUNNING + - REQUESTED + - ACTIVE + - STOPPING - SUCCEEDED - - CANCEL_PENDING - - CANCELLING - - CANCELLED - - FAILED - - SKIPPED - - NOT_TRIGGERED + - INFEASIBLE readOnly: true - description: Output only. The state of the task. + type: string + description: Output only. The detailed state of the NasTrial. + finalMeasurement: + description: Output only. The final measurement containing the objective value. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + startTime: + description: Output only. Time when the NasTrial was started. + readOnly: true + type: string + format: google-datetime + description: Represents a uCAIP NasJob trial. + type: object + GoogleCloudAiplatformV1StudySpec: + description: Represents specification of a Study. + properties: + metrics: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' + description: Required. Metric specs for the Study. + observationNoise: + enum: + - OBSERVATION_NOISE_UNSPECIFIED + - LOW + - HIGH enumDescriptions: - - Unspecified. - - Specifies pending state for the task. - - Specifies task is being executed. - - Specifies task completed successfully. - - Specifies Task cancel is in pending state. - - Specifies task is being cancelled. - - Specifies task was cancelled. - - Specifies task failed. - - Specifies task was skipped due to cache hit. + - The default noise level chosen by Vertex AI. - >- - Specifies that the task was not triggered because the task's - trigger policy is not satisfied. The trigger policy is specified - in the `condition` field of PipelineJob.pipeline_spec. + Vertex AI assumes that the objective function is (nearly) + perfectly reproducible, and will never repeat the same Trial + parameters. + - >- + Vertex AI will estimate the amount of noise in metric evaluations, + it may repeat the same Trial parameters more than once. type: string - GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: - description: Details of operations that perform import Feature values. - id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata - properties: - timestampOutsideRetentionRowsCount: description: >- - The number rows that weren't ingested due to having timestamps - outside the retention boundary. - format: int64 - type: string - importedFeatureValueCount: - format: int64 - type: string - description: Number of Feature values that have been imported by the operation. - importedEntityCount: - description: Number of entities that have been imported by the operation. + The observation noise level of the study. Currently only supported + by the Vertex AI Vizier service. Not supported by + HyperparameterTuningJob or TrainingPipeline. + parameters: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' + type: array + description: Required. The set of parameters to tune. + decayCurveStoppingSpec: + description: The automated early stopping spec using decay curve rule. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec + convexAutomatedStoppingSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec + description: The automated early stopping spec using convex stopping rule. + algorithm: type: string - format: int64 - invalidRowCount: + description: The search algorithm specified for the Study. + enumDescriptions: + - >- + The default algorithm used by Vertex AI for [hyperparameter + tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) + and [Vertex AI + Vizier](https://cloud.google.com/vertex-ai/docs/vizier). + - >- + Simple grid search within the feasible space. To use grid search, + all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`. + - Simple random search within the feasible space. + enum: + - ALGORITHM_UNSPECIFIED + - GRID_SEARCH + - RANDOM_SEARCH + medianAutomatedStoppingSpec: + description: The automated early stopping spec using median rule. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec + measurementSelectionType: + enumDescriptions: + - Will be treated as LAST_MEASUREMENT. + - Use the last measurement reported. + - Use the best measurement reported. + description: Describe which measurement selection type will be used type: string - format: int64 + enum: + - MEASUREMENT_SELECTION_TYPE_UNSPECIFIED + - LAST_MEASUREMENT + - BEST_MEASUREMENT + studyStoppingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig description: >- - The number of rows in input source that weren't imported due to - either * Not having any featureValues. * Having a null entityId. * - Having a null timestamp. * Not being parsable (applicable for CSV - sources). - sourceUris: + Conditions for automated stopping of a Study. Enable automated + stopping by configuring at least one condition. + type: object + id: GoogleCloudAiplatformV1StudySpec + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + type: object + properties: + evaluatedAnnotations: + description: Required. Evaluated annotations resource to be imported. type: array - description: The source URI from where Feature values are imported. - items: - type: string - genericMetadata: - description: Operation metadata for Featurestore import Feature values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - blockingOperationIds: items: - format: int64 - type: string - type: array - description: >- - List of ImportFeatureValues operations running under a single - EntityType that are blocking this operation. - type: object - GoogleCloudAiplatformV1PscAutomatedEndpoints: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' + description: Request message for ModelService.BatchImportEvaluatedAnnotations + GoogleCloudAiplatformV1ListTensorboardRunsResponse: + id: GoogleCloudAiplatformV1ListTensorboardRunsResponse + description: Response message for TensorboardService.ListTensorboardRuns. properties: - network: - description: Corresponding network in pscAutomationConfigs. - type: string - matchAddress: - type: string - description: Ip Address created by the automated forwarding rule. - projectId: + nextPageToken: type: string - description: Corresponding project_id in pscAutomationConfigs + description: >- + A token, which can be sent as ListTensorboardRunsRequest.page_token + to retrieve the next page. If this field is omitted, there are no + subsequent pages. + tensorboardRuns: + description: The TensorboardRuns mathching the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + type: array type: object - description: >- - PscAutomatedEndpoints defines the output of the forwarding rule - automatically created by each PscAutomationConfig. - id: GoogleCloudAiplatformV1PscAutomatedEndpoints - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata + type: object properties: - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_JETSON_VERSATILE_1 + successfulStopReason: type: string + description: >- + For successful job completions, this is the reason why the job has + finished. + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED enumDescriptions: - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. - >- - A model best tailored to be used within Google Cloud, and which - cannot be exported. Default. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) to a Jetson - device afterwards. + Further training of the Model ceased to increase its quality, + since it already has converged. + costMilliNodeHours: + format: int64 + description: >- + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. + type: string + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + properties: + confidenceThreshold: + description: The confidence threshold value used to compute the metrics. + type: number + format: float + f1Score: + type: number + format: float + description: The harmonic mean of recall and precision. + precision: + format: float + description: Precision under the given confidence threshold. + type: number + recall: + format: float + description: Recall under the given confidence threshold. + type: number + description: Metrics for a single confidence threshold. type: object - GoogleCloudAiplatformV1TunedModel: + GoogleCloudAiplatformV1Featurestore: + type: object + id: GoogleCloudAiplatformV1Featurestore description: >- - The Model Registry Model and Online Prediction Endpoint assiociated with - this TuningJob. + Vertex AI Feature Store provides a centralized repository for + organizing, storing, and serving ML features. The Featurestore is a + top-level container for your features and their values. properties: - model: - readOnly: true + onlineStorageTtlDays: + type: integer description: >- - Output only. The resource name of the TunedModel. Format: - `projects/{project}/locations/{location}/models/{model}`. - type: string - endpoint: + Optional. TTL in days for feature values that will be stored in + online serving storage. The Feature Store online storage + periodically removes obsolete feature values older than + `online_storage_ttl_days` since the feature generation time. Note + that `online_storage_ttl_days` should be less than or equal to + `offline_storage_ttl_days` for each EntityType under a featurestore. + If not set, default to 4000 days + format: int32 + encryptionSpec: description: >- - Output only. A resource name of an Endpoint. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}`. - type: string + Optional. Customer-managed encryption key spec for data storage. If + set, both of the online and offline data storage will be secured by + this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + name: + description: >- + Output only. Name of the Featurestore. Format: + `projects/{project}/locations/{location}/featurestores/{featurestore}` readOnly: true - type: object - id: GoogleCloudAiplatformV1TunedModel - GoogleCloudAiplatformV1Schedule: - description: >- - An instance of a Schedule periodically schedules runs to make API calls - based on user specified time specification and API request type. - properties: - updateTime: - format: google-datetime type: string + state: + description: Output only. State of the featurestore. + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + State when the featurestore configuration is not being updated and + the fields reflect the current configuration of the featurestore. + The featurestore is usable in this state. + - >- + The state of the featurestore configuration when it is being + updated. During an update, the fields reflect either the original + configuration or the updated configuration of the featurestore. + For example, `online_serving_config.fixed_node_count` can take + minutes to update. While the update is in progress, the + featurestore is in the UPDATING state, and the value of + `fixed_node_count` can be the original value or the updated value, + depending on the progress of the operation. Until the update + completes, the actual number of nodes can still be the original + value of `fixed_node_count`. The featurestore is still usable in + this state. + enum: + - STATE_UNSPECIFIED + - STABLE + - UPDATING readOnly: true - description: Output only. Timestamp when this Schedule was updated. - lastPauseTime: - readOnly: true + createTime: format: google-datetime - description: >- - Output only. Timestamp when this Schedule was last paused. Unset if - never paused. - type: string - maxRunCount: - format: int64 + description: Output only. Timestamp when this Featurestore was created. + readOnly: true type: string + labels: + type: object description: >- - Optional. Maximum run count of the schedule. If specified, The - schedule will be completed when either started_run_count >= - max_run_count or when end_time is reached. If not specified, new - runs will keep getting scheduled until this Schedule is paused or - deleted. Already scheduled runs will be allowed to complete. Unset - if not specified. - startedRunCount: - format: int64 - description: Output only. The number of runs started by this schedule. + Optional. The labels with user-defined metadata to organize your + Featurestore. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one Featurestore(System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + additionalProperties: + type: string + etag: type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + onlineServingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + description: >- + Optional. Config for online storage resources. The field should not + co-exist with the field of `OnlineStoreReplicationConfig`. If both + of it and OnlineStoreReplicationConfig are unset, the feature store + will not have an online store and cannot be used for online serving. + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + updateTime: readOnly: true - createTime: type: string - description: Output only. Timestamp when this Schedule was created. + description: Output only. Timestamp when this Featurestore was last updated. format: google-datetime + satisfiesPzi: + description: Output only. Reserved for future use. readOnly: true - catchUp: - description: >- - Output only. Whether to backfill missed runs when the schedule is - resumed from PAUSED state. If set to true, all missed runs will be - scheduled. New runs will be scheduled after the backfill is - complete. Default to false. type: boolean - readOnly: true - nextRunTime: + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: + properties: + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation + GoogleCloudAiplatformV1Scalar: + properties: + value: + type: number + description: Value of the point at this step / timestamp. + format: double + id: GoogleCloudAiplatformV1Scalar + type: object + description: One point viewable on a scalar metric plot. + GoogleCloudAiplatformV1PipelineTaskDetail: + description: The runtime detail of a task execution. + type: object + id: GoogleCloudAiplatformV1PipelineTaskDetail + properties: + endTime: + description: Output only. Task end time. readOnly: true type: string - description: >- - Output only. Timestamp when this Schedule should schedule the next - run. Having a next_run_time in the past means the runs are being - started behind schedule. format: google-datetime - name: - description: Immutable. The resource name of the Schedule. + executorDetail: + description: Output only. The detailed execution info. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetail + state: type: string - lastScheduledRunResponse: - description: >- - Output only. Response of the last scheduled run. This is the - response for starting the scheduled requests and not the execution - of the operations/jobs created by the requests (if applicable). - Unset if no run has been scheduled yet. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' + description: Output only. State of the task. + enumDescriptions: + - Unspecified. + - Specifies pending state for the task. + - Specifies task is being executed. + - Specifies task completed successfully. + - Specifies Task cancel is in pending state. + - Specifies task is being cancelled. + - Specifies task was cancelled. + - Specifies task failed. + - Specifies task was skipped due to cache hit. + - >- + Specifies that the task was not triggered because the task's + trigger policy is not satisfied. The trigger policy is specified + in the `condition` field of PipelineJob.pipeline_spec. readOnly: true - createPipelineJobRequest: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - CANCEL_PENDING + - CANCELLING + - CANCELLED + - FAILED + - SKIPPED + - NOT_TRIGGERED + outputs: + readOnly: true + type: object + description: Output only. The runtime output artifacts of the task. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + error: description: >- - Request for PipelineService.CreatePipelineJob. - CreatePipelineJobRequest.parent field is required (format: - projects/{project}/locations/{location}). - lastResumeTime: - format: google-datetime + Output only. The error that occurred during task execution. Only + populated when the task's state is FAILED or CANCELLED. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + taskName: description: >- - Output only. Timestamp when this Schedule was last resumed. Unset if - never resumed from pause. + Output only. The user specified name of the task that is defined in + pipeline_spec. + type: string + readOnly: true + inputs: readOnly: true + type: object + description: Output only. The runtime input artifacts of the task. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + taskId: type: string - displayName: - description: >- - Required. User provided name of the Schedule. The name can be up to - 128 characters long and can consist of any UTF-8 characters. + format: int64 + readOnly: true + description: Output only. The system generated ID of the task. + parentTaskId: type: string - allowQueueing: - type: boolean + format: int64 description: >- - Optional. Whether new scheduled runs can be queued when - max_concurrent_runs limit is reached. If set to true, new runs will - be queued instead of skipped. Default to false. + Output only. The id of the parent task if the task is within a + component scope. Empty if the task is at the root level. + readOnly: true startTime: + description: Output only. Task start time. format: google-datetime - description: >- - Optional. Timestamp after which the first run can be scheduled. - Default to Schedule create time if not specified. + readOnly: true type: string - state: - description: Output only. The state of this Schedule. + execution: + description: Output only. The execution metadata of the task. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + readOnly: true + createTime: + description: Output only. Task create time. type: string - enumDescriptions: - - Unspecified. - - >- - The Schedule is active. Runs are being scheduled on the - user-specified timespec. - - >- - The schedule is paused. No new runs will be created until the - schedule is resumed. Already started runs will be allowed to - complete. - - >- - The Schedule is completed. No new runs will be scheduled. Already - started runs will be allowed to complete. Schedules in completed - state cannot be paused or resumed. readOnly: true - enum: - - STATE_UNSPECIFIED - - ACTIVE - - PAUSED - - COMPLETED - endTime: format: google-datetime - type: string - description: >- - Optional. Timestamp after which no new runs can be scheduled. If - specified, The schedule will be completed when either end_time is - reached or when scheduled_run_count >= max_run_count. If not - specified, new runs will keep getting scheduled until this Schedule - is paused or deleted. Already scheduled runs will be allowed to - complete. Unset if not specified. - cron: - type: string - description: >- - Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch - scheduled runs. To explicitly set a timezone to the cron tab, apply - a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or - "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid - string from IANA time zone database. For example, - "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * - * *". - maxConcurrentRunCount: - type: string - format: int64 + pipelineTaskStatus: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetailPipelineTaskStatus + readOnly: true + type: array description: >- - Required. Maximum number of runs that can be started concurrently - for this Schedule. This is the limit for starting the scheduled - requests and not the execution of the operations/jobs created by the - requests (if applicable). + Output only. A list of task status. This field keeps a record of + task status evolving over time. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: type: object - id: GoogleCloudAiplatformV1Schedule - GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: properties: - gcsBucket: + precisionWindowLength: + format: google-duration description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. - type: string - dataItemSchemaUri: + This VideoActionMetrics is calculated based on this prediction + window length. If the predicted action's timestamp is inside the + time window whose center is the ground truth action's timestamp with + this specific length, the prediction result is treated as a true + positive. type: string - description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Video DataItems that belong to this Dataset. - id: GoogleCloudAiplatformV1SchemaVideoDatasetMetadata - type: object - description: The metadata of Datasets that contain Video DataItems. - GoogleCloudAiplatformV1NearestNeighborQueryStringFilter: - id: GoogleCloudAiplatformV1NearestNeighborQueryStringFilter - description: >- - String filter is used to search a subset of the entities by using - boolean rules on string columns. For example: if a query specifies - string filter with 'name = color, allow_tokens = {red, blue}, - deny_tokens = {purple}',' then that query will match entities that are - red or blue, but if those points are also purple, then they will be - excluded even if they are red/blue. Only string filter is supported for - now, numeric filter will be supported in the near future. - properties: - allowTokens: - description: Optional. The allowed tokens. + meanAveragePrecision: + type: number + description: The mean average precision. + format: float + confidenceMetrics: type: array items: - type: string - denyTokens: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics + description: >- + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + description: The Evaluation metrics given a specific precision_window_length. + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: + properties: + tensorboardRun: + description: >- + Required. The resource name of the TensorboardRun to write data to. + Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + type: string + timeSeriesData: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + description: >- + Required. The TensorboardTimeSeries data to write. Values with in a + time series are indexed by their step value. Repeated writes to the + same step will overwrite the existing value for that step. The upper + limit of data points per write request is 5000. type: array - description: Optional. The denied tokens. - name: - type: string - description: Required. Column names in BigQuery that used as filters. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: + description: Request message for TensorboardService.WriteTensorboardRunData. + id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest type: object + GoogleCloudAiplatformV1NasJob: properties: - groupColumns: - items: - type: string + createTime: + format: google-datetime + readOnly: true + description: Output only. Time when the NasJob was created. + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - A list of time series attribute column names that define the time - series hierarchy. Only one level of hierarchy is supported, ex. - 'region' for a hierarchy of stores or 'department' for a hierarchy - of products. If multiple columns are specified, time series will be - grouped by their combined values, ex. ('blue', 'large') for 'color' - and 'size', up to 5 columns are accepted. If no group columns are - specified, all time series are considered to be part of the same - group. - type: array - groupTotalWeight: - format: double + Customer-managed encryption key options for a NasJob. If this is + set, then all resources created by the NasJob will be encrypted with + the provided encryption key. + startTime: + format: google-datetime description: >- - The weight of the loss for predictions aggregated over time series - in the same group. - type: number - temporalTotalWeight: - format: double - type: number + Output only. Time when the NasJob for the first time entered the + `JOB_STATE_RUNNING` state. + readOnly: true + type: string + error: description: >- - The weight of the loss for predictions aggregated over the horizon - for a single time series. - groupTemporalTotalWeight: - type: number - format: double + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + satisfiesPzi: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + nasJobSpec: + description: Required. The specification of a NasJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + nasJobOutput: + description: Output only. Output of the NasJob. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' + displayName: + type: string description: >- - The weight of the loss for predictions aggregated over both the - horizon and time series in the same hierarchy group. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - description: >- - Configuration that defines the hierarchical relationship of time series - and parameters for hierarchical forecasting strategies. - GoogleCloudAiplatformV1GenieSource: - description: >- - Contains information about the source of the models generated from - Generative AI Studio. - type: object - properties: - baseModelUri: - description: Required. The public base model URI. + Required. The display name of the NasJob. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + endTime: + format: google-datetime + description: >- + Output only. Time when the NasJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. type: string - id: GoogleCloudAiplatformV1GenieSource - GoogleCloudAiplatformV1IndexDatapointRestriction: - description: >- - Restriction of a datapoint which describe its attributes(tokens) from - each of several attribute categories(namespaces). - properties: - namespace: - description: 'The namespace of this restriction. e.g.: color.' + readOnly: true + updateTime: type: string - allowList: - type: array - description: 'The attributes to allow in this namespace. e.g.: ''red''' - items: - type: string - denyList: - description: 'The attributes to deny in this namespace. e.g.: ''blue''' - items: + description: Output only. Time when the NasJob was most recently updated. + readOnly: true + format: google-datetime + enableRestrictedImageTraining: + type: boolean + deprecated: true + description: >- + Optional. Enable a separation of Custom model training and + restricted image training for tenant project. + labels: + description: >- + The labels with user-defined metadata to organize NasJobs. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + additionalProperties: type: string - type: array - id: GoogleCloudAiplatformV1IndexDatapointRestriction - type: object - GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: + name: + readOnly: true + description: Output only. Resource name of the NasJob. + type: string + state: + description: Output only. The detailed state of the job. + readOnly: true + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + type: string + id: GoogleCloudAiplatformV1NasJob + description: Represents a Neural Architecture Search (NAS) job. type: object - description: Value specification for a parameter in `INTEGER` type. - id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. * A boolean value that indicates whether the + value is valid. properties: - minValue: - description: Required. Inclusive minimum value of the parameter. - type: string - format: int64 - maxValue: - description: Required. Inclusive maximum value of the parameter. + columnName: type: string - format: int64 - defaultValue: + invalidValuesAllowed: + type: boolean description: >- - A default value for an `INTEGER` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - type: string - format: int64 - GoogleCloudAiplatformV1NearestNeighbors: - id: GoogleCloudAiplatformV1NearestNeighbors - properties: - neighbors: - description: All its neighbors. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor - type: array - type: object - description: Nearest neighbors for one query. - GoogleCloudAiplatformV1DoubleArray: + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + GoogleCloudAiplatformV1SearchEntryPoint: + description: Google search entry point. properties: - values: - description: A list of double values. - items: - format: double - type: number - type: array - description: A list of double values. - id: GoogleCloudAiplatformV1DoubleArray - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: - properties: - content: - description: The image bytes to make the predictions on. + sdkBlob: type: string - mimeType: + description: Optional. Base64 encoded JSON representing array of tuple. + format: byte + renderedContent: type: string description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/png - description: Prediction input format for Image Segmentation. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance + Optional. Web content snippet that can be embedded in a web page or + an app webview. + id: GoogleCloudAiplatformV1SearchEntryPoint type: object - GoogleCloudAiplatformV1ManualBatchTuningParameters: + GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec: properties: - batchSize: - type: integer + useReference: + type: boolean description: >- - Immutable. The number of the records (e.g. instances) of the - operation given in each batch to a machine replica. Machine type, - and size of a single record should be considered when setting this - parameter, higher value speeds up the batch operation's execution, - but too high value will result in a whole batch not fitting in a - machine's memory, and the whole operation will fail. The default - value is 64. + Optional. Whether to use instance.reference to compute pairwise + summarization quality. + version: + description: Optional. Which version to use for evaluation. + type: integer format: int32 - description: Manual batch tuning parameters. + id: GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec + type: object + description: Spec for pairwise summarization quality score metric. + GoogleCloudAiplatformV1SupervisedTuningSpec: + description: Tuning Spec for Supervised Tuning. type: object - id: GoogleCloudAiplatformV1ManualBatchTuningParameters - GoogleCloudAiplatformV1SpecialistPool: - description: >- - SpecialistPool represents customers' own workforce to work on their data - labeling jobs. It includes a group of specialist managers and workers. - Managers are responsible for managing the workers in this pool as well - as customers' data labeling jobs associated with this pool. Customers - create specialist pool as well as start data labeling jobs on Cloud, - managers and workers handle the jobs using CrowdCompute console. properties: - name: + validationDatasetUri: type: string - description: Required. The resource name of the SpecialistPool. - specialistManagersCount: - readOnly: true - type: integer - format: int32 - description: Output only. The number of managers in this SpecialistPool. - specialistManagerEmails: - description: The email addresses of the managers in the SpecialistPool. - items: - type: string - type: array - displayName: description: >- - Required. The user-defined name of the SpecialistPool. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. This field should be unique on project-level. + Optional. Cloud Storage path to file containing validation dataset + for tuning. The dataset must be formatted as a JSONL file. + trainingDatasetUri: + description: >- + Required. Cloud Storage path to file containing training dataset for + tuning. The dataset must be formatted as a JSONL file. type: string - specialistWorkerEmails: - description: The email addresses of workers in the SpecialistPool. + hyperParameters: + description: Optional. Hyperparameters for SFT. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters + id: GoogleCloudAiplatformV1SupervisedTuningSpec + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: + properties: + bboxes: + items: + type: array + items: + type: any type: array + description: >- + Bounding boxes, i.e. the rectangles over the image, that pinpoint + the found AnnotationSpecs. Given in order that matches the IDs. Each + bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and + `yMax`, which represent the extremal coordinates of the box. They + are relative to the image size, and the point 0,0 is in the top left + of the image. + confidences: items: - type: string - pendingDataLabelingJobs: - readOnly: true + type: number + format: float + description: >- + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + type: array + displayNames: items: type: string type: array - description: Output only. The resource name of the pending data labeling jobs. - id: GoogleCloudAiplatformV1SpecialistPool - type: object - GoogleCloudAiplatformV1DirectPredictRequest: - description: Request message for PredictionService.DirectPredict. - properties: - inputs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: >- + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. + ids: type: array - description: The prediction input. - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - description: The parameters that govern the prediction. - type: object - id: GoogleCloudAiplatformV1DirectPredictRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs - description: The input parameters of this TrainingJob. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment + description: >- + The resource IDs of the AnnotationSpecs that had been identified, + ordered by the confidence score descendingly. + items: + type: string + format: int64 type: object - description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. - GoogleCloudAiplatformV1RemoveContextChildrenRequest: - id: GoogleCloudAiplatformV1RemoveContextChildrenRequest + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult + description: Prediction output format for Image Object Detection. + GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: properties: - childContexts: + nextPageToken: + description: >- + A token, which can be sent as ListFeatureViewSyncsRequest.page_token + to retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + featureViewSyncs: items: - type: string - description: The resource names of the child Contexts. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + description: The FeatureViewSyncs matching the request. type: array type: object - description: Request message for MetadataService.DeleteContextChildrenRequest. - GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: - type: object + description: >- + Response message for + FeatureOnlineStoreAdminService.ListFeatureViewSyncs. + id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs properties: - genericMetadata: - description: Operation metadata for FeatureView Update. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform update FeatureView. - id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata - GoogleCloudAiplatformV1UndeployIndexResponse: + baseModelId: + description: >- + The ID of the `base` model. If it is specified, the new model will + be trained based on the `base` model. Otherwise, the new model will + be trained from scratch. The `base` model must be in the same + Project and Location as the new Model to train, and have the same + modelType. + type: string + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD_HIGH_ACCURACY_1 + - CLOUD_LOW_ACCURACY_1 + - MOBILE_TF_LOW_LATENCY_1 + type: string + enumDescriptions: + - Should not be set. + - >- + A model to be used via prediction calls to uCAIP API. Expected to + have a higher latency, but should also have a higher prediction + quality than other models. + - >- + A model to be used via prediction calls to uCAIP API. Expected to + have a lower latency but relatively lower prediction quality. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as TensorFlow + model and used on a mobile or edge device afterwards. Expected to + have low latency, but may have lower prediction quality than other + mobile models. + budgetMilliNodeHours: + description: >- + The training budget of creating this model, expressed in milli node + hours i.e. 1,000 value in this field means 1 node hour. The actual + metadata.costMilliNodeHours will be equal or less than this value. + If further model training ceases to provide any improvements, it + will stop without using the full budget and the + metadata.successfulStopReason will be `model-converged`. Note, + node_hour = actual_hour * number_of_nodes_involved. Or + actual_wall_clock_hours = train_budget_milli_node_hours / + (number_of_nodes_involved * 1000) For modelType + `cloud-high-accuracy-1`(default), the budget must be between 20,000 + and 2,000,000 milli node hours, inclusive. The default value is + 192,000 which represents one day in wall time (1000 milli * 24 hours + * 8 nodes). + type: string + format: int64 type: object - description: Response message for IndexEndpointService.UndeployIndex. - properties: {} - id: GoogleCloudAiplatformV1UndeployIndexResponse - GoogleCloudAiplatformV1SuggestTrialsMetadata: + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: type: object - id: GoogleCloudAiplatformV1SuggestTrialsMetadata + description: Prediction output format for Video Classification. properties: - genericMetadata: - description: Operation metadata for suggesting Trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - clientId: + displayName: + type: string + description: The display name of the AnnotationSpec that had been identified. + type: type: string description: >- - The identifier of the client that is requesting the suggestion. If - multiple SuggestTrialsRequests have the same `client_id`, the - service will return the identical suggested Trial if the Trial is - pending, and provide a new Trial if the last suggested Trial was - completed. - description: Details of operations that perform Trials suggestion. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation: - properties: - timeFormat: + The type of the prediction. The requested types can be configured + via parameters. This will be one of - segment-classification - + shot-classification - one-sec-interval-classification + id: + description: The resource ID of the AnnotationSpec that had been identified. + type: string + timeSegmentStart: description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + The beginning, inclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. Note that + for 'segment-classification' prediction type, this equals the + original 'timeSegmentStart' from the input instance, for other types + it is the start of a shot or a 1 second interval respectively. + format: google-duration type: string - columnName: + confidence: + format: float + description: >- + The Model's confidence in correction of this prediction, higher + value means higher confidence. + type: number + timeSegmentEnd: + format: google-duration type: string - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. + description: >- + The end, exclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. Note that + for 'segment-classification' prediction type, this equals the + original 'timeSegmentEnd' from the input instance, for other types + it is the end of a shot or a 1 second interval respectively. id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation: + GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult + GoogleCloudAiplatformV1PairwiseSummarizationQualityInput: + description: Input for pairwise summarization quality metric. + properties: + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualitySpec + description: Required. Spec for pairwise summarization quality score metric. + instance: + description: Required. Pairwise summarization quality instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInput type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: properties: - columnName: + floatValue: + type: number + description: Float type. + format: float + stringValue: type: string - description: >- - Treats the column as categorical array and performs following - transformation functions. * For each element in the array, convert the - category name to a dictionary lookup index and generate an embedding for - each index. Combine the embedding of all elements into a single - embedding using the mean. * Empty arrays treated as an embedding of - zeroes. - GoogleCloudAiplatformV1RayMetricSpec: + description: String type. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + description: Single value that supports strings and floats. type: object - id: GoogleCloudAiplatformV1RayMetricSpec - description: Configuration for the Ray metrics. - properties: - disabled: - description: Optional. Flag to disable the Ray metrics collection. - type: boolean - GoogleCloudAiplatformV1BatchMigrateResourcesResponse: + CloudAiLargeModelsVisionImageRAIScores: properties: - migrateResourceResponses: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse - type: array - description: Successfully migrated resources. - id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse - description: Response message for MigrationService.BatchMigrateResources. - type: object - GoogleCloudAiplatformV1ImportDataRequest: - description: Request message for DatasetService.ImportData. - id: GoogleCloudAiplatformV1ImportDataRequest + agileWatermarkDetectionScore: + description: Agile watermark score for image. + type: number + format: double type: object - properties: - importConfigs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' - description: >- - Required. The desired input locations. The contents of all input - locations will be imported in one batch. - type: array - GoogleCloudAiplatformV1EvaluatedAnnotation: + description: RAI scores for generated image returned. + id: CloudAiLargeModelsVisionImageRAIScores + GoogleRpcStatus: + id: GoogleRpcStatus type: object description: >- - True positive, false positive, or false negative. EvaluatedAnnotation is - only available under ModelEvaluationSlice with slice of `annotationSpec` - dimension. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - type: - enum: - - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED - - TRUE_POSITIVE - - FALSE_POSITIVE - - FALSE_NEGATIVE - enumDescriptions: - - Invalid value. - - >- - The EvaluatedAnnotation is a true positive. It has a prediction - created by the Model and a ground truth Annotation which the - prediction matches. - - >- - The EvaluatedAnnotation is false positive. It has a prediction - created by the Model which does not match any ground truth - annotation. - - >- - The EvaluatedAnnotation is false negative. It has a ground truth - annotation which is not matched by any of the model created - predictions. - description: Output only. Type of the EvaluatedAnnotation. - type: string - readOnly: true - dataItemPayload: - description: >- - Output only. The data item payload that the Model predicted this - EvaluatedAnnotation on. - type: any - readOnly: true - evaluatedDataItemViewId: - description: >- - Output only. ID of the EvaluatedDataItemView under the same ancestor - ModelEvaluation. The EvaluatedDataItemView consists of all ground - truths and predictions on data_item_payload. + message: type: string - readOnly: true - predictions: - readOnly: true - type: array description: >- - Output only. The model predicted annotations. For true positive, - there is one and only one prediction, which matches the only one - ground truth annotation in ground_truths. For false positive, there - is one and only one prediction, which doesn't match any ground truth - annotation of the corresponding data_item_view_id. For false - negative, there are zero or more predictions which are similar to - the only ground truth annotation in ground_truths but not enough for - a match. The schema of the prediction is stored in - ModelEvaluation.annotation_schema_uri - items: - type: any - explanations: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + details: description: >- - Explanations of predictions. Each element of the explanations - indicates the explanation for one explanation Method. The - attributions list in the EvaluatedAnnotationExplanation.explanation - object corresponds to the predictions list. For example, the second - element in the attributions list explains the second element in the - predictions list. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - groundTruths: items: - type: any + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + GoogleCloudAiplatformV1ExplanationMetadataOverride: + properties: + inputs: description: >- - Output only. The ground truth Annotations, i.e. the Annotations that - exist in the test data the Model is evaluated on. For true positive, - there is one and only one ground truth annotation, which matches the - only prediction in predictions. For false positive, there are zero - or more ground truth annotations that are similar to the only - prediction in predictions, but not enough for a match. For false - negative, there is one and only one ground truth annotation, which - doesn't match any predictions created by the model. The schema of - the ground truth is stored in ModelEvaluation.annotation_schema_uri - readOnly: true - type: array - errorAnalysisAnnotations: - items: + Required. Overrides the input metadata of the features. The key is + the name of the feature to be overridden. The keys specified here + must exist in the input metadata to be overridden. If a feature is + not specified here, the corresponding feature's input metadata is + not overridden. + additionalProperties: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation - description: Annotations of model error analysis results. - type: array - id: GoogleCloudAiplatformV1EvaluatedAnnotation - GoogleCloudAiplatformV1IntegratedGradientsAttribution: - id: GoogleCloudAiplatformV1IntegratedGradientsAttribution + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + type: object + id: GoogleCloudAiplatformV1ExplanationMetadataOverride type: object description: >- - An attribution method that computes the Aumann-Shapley value taking - advantage of the model's fully differentiable structure. Refer to this - paper for more details: https://arxiv.org/abs/1703.01365 - properties: - smoothGradConfig: - description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy - samples in the vicinity of the inputs. Adding noise can help improve - the computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf - $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' - stepCount: - type: integer - description: >- - Required. The number of steps for approximating the path integral. A - good value to start is 50 and gradually increase until the sum to - diff property is within the desired error range. Valid range of its - value is [1, 100], inclusively. - format: int32 - blurBaselineConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' - description: >- - Config for IG with blur baseline. When enabled, a linear path from - the maximally blurred image to the input image is created. Using a - blurred baseline instead of zero (black image) is motivated by the - BlurIG approach explained here: https://arxiv.org/abs/2004.03383 - GoogleCloudAiplatformV1ContainerSpec: + The ExplanationMetadata entries that can be overridden at online + explanation time. + GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries: type: object + id: GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries properties: - env: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + timestampColumn: description: >- - Environment variables to be passed to the container. Maximum limit - is 100. - command: - type: array - items: - type: string + Optional. Column hosting timestamp values for a time-series source. + Will be used to determine the latest `feature_values` for each + entity. Optional. If not provided, column named `feature_timestamp` + of type `TIMESTAMP` will be used. + type: string + GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: + properties: + requestResponseLoggingSchemaVersion: description: >- - The command to be invoked when the container is started. It - overrides the entrypoint instruction in Dockerfile when provided. - args: - description: The arguments to be passed when starting the container. - items: - type: string - type: array - imageUri: + Output only. The schema version of the request/response logging + BigQuery table. Default to v1 if unset. + readOnly: true + type: string + bigqueryTablePath: type: string description: >- - Required. The URI of a container image in the Container Registry - that is to be run on each worker replica. - id: GoogleCloudAiplatformV1ContainerSpec - description: The spec of a Container. - GoogleCloudAiplatformV1DeployModelResponse: - description: Response message for EndpointService.DeployModel. + The created BigQuery table to store logs. Customer could do their + own query & analysis. Format: `bq://.model_deployment_monitoring_._` + logType: + enum: + - LOG_TYPE_UNSPECIFIED + - PREDICT + - EXPLAIN + description: The type of log. + type: string + enumDescriptions: + - Unspecified type. + - Predict logs. + - Explain logs. + logSource: + enumDescriptions: + - Unspecified source. + - Logs coming from Training dataset. + - Logs coming from Serving traffic. + type: string + description: The source of log. + enum: + - LOG_SOURCE_UNSPECIFIED + - TRAINING + - SERVING + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable type: object - id: GoogleCloudAiplatformV1DeployModelResponse - properties: - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: The DeployedModel that had been deployed in the Endpoint. - GoogleCloudAiplatformV1StartNotebookRuntimeRequest: - properties: {} - description: Request message for NotebookService.StartNotebookRuntime. + description: >- + ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name + as well as some information of the logs stored in this table. + GoogleCloudAiplatformV1BlurBaselineConfig: + description: >- + Config for blur baseline. When enabled, a linear path from the maximally + blurred image to the input image is created. Using a blurred baseline + instead of zero (black image) is motivated by the BlurIG approach + explained here: https://arxiv.org/abs/2004.03383 type: object - id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: - description: A TrainingJob that trains a custom code Model. properties: - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata - inputs: - description: The input parameters of this CustomTask. - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask + maxBlurSigma: + description: >- + The standard deviation of the blur kernel for the blurred baseline. + The same blurring parameter is used for both the height and the + width dimension. If not set, the method defaults to the zero (i.e. + black for images) baseline. + type: number + format: float + id: GoogleCloudAiplatformV1BlurBaselineConfig + GoogleCloudAiplatformV1ReadFeatureValuesResponse: + id: GoogleCloudAiplatformV1ReadFeatureValuesResponse type: object - GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader properties: - featureDescriptors: - description: >- - List of Feature metadata corresponding to each piece of - ReadFeatureValuesResponse.EntityView.data. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor - type: array - entityType: + header: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + description: Response header. + entityView: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView description: >- - The resource name of the EntityType from the - ReadFeatureValuesRequest. Value format: - `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. - type: string + Entity view with Feature values. This may be the entity in the + Featurestore if values for all Features were requested, or a + projection of the entity in the Featurestore if values for only some + Features were requested. + description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. + GoogleCloudAiplatformV1ImportModelEvaluationRequest: + id: GoogleCloudAiplatformV1ImportModelEvaluationRequest + properties: + modelEvaluation: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + description: Required. Model evaluation resource to be imported. type: object + description: Request message for ModelService.ImportModelEvaluation + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: description: >- - Response header with metadata for the requested - ReadFeatureValuesRequest.entity_type and Features. - GoogleCloudAiplatformV1ResourcePool: + Training pipeline will perform following transformation functions. * The + categorical string as is--no change to case, punctuation, spelling, + tense, and so on. * Convert the category name to a dictionary lookup + index and generate an embedding for each index. * Categories that appear + less than 5 times in the training dataset are treated as the "unknown" + category. The "unknown" category gets its own special lookup index and + resulting embedding. + properties: + columnName: + type: string type: object - id: GoogleCloudAiplatformV1ResourcePool - description: >- - Represents the spec of a group of resources of the same type, for - example machine type, disk, and accelerators, in a PersistentResource. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode: properties: - replicaCount: - description: >- - Optional. The total number of machines to use for this resource - pool. + modelName: type: string - format: int64 - autoscalingSpec: - description: Optional. Optional spec to configure GKE autoscaling - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec - diskSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - description: Optional. Disk spec for the machine in this node pool. - usedReplicaCount: description: >- - Output only. The number of machines currently in use by training - jobs for this resource pool. Will replace idle_replica_count. + The model name to use. Only the public LLM models are accepted. e.g. + 'gemini-1.5-pro-001'. + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode + type: object + description: When manual routing is set, the specified model will be used directly. + GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: + properties: + featureStats: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + description: A list of historical Stats and Anomalies generated for all Features. + type: array + objective: type: string - readOnly: true - format: int64 - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: Required. Immutable. The specification of a single machine. - id: + description: Model Monitoring Objective those stats and anomalies belonging to. + enumDescriptions: + - Default value, should not be set. + - >- + Raw feature values' stats to detect skew between + Training-Prediction datasets. + - >- + Raw feature values' stats to detect drift between + Serving-Prediction datasets. + - >- + Feature attribution scores to detect skew between + Training-Prediction datasets. + - >- + Feature attribution scores to detect skew between Prediction + datasets collected within different time windows. + enum: + - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED + - RAW_FEATURE_SKEW + - RAW_FEATURE_DRIFT + - FEATURE_ATTRIBUTION_SKEW + - FEATURE_ATTRIBUTION_DRIFT + deployedModelId: type: string - description: >- - Immutable. The unique ID in a PersistentResource for referring to - this resource pool. User can specify it if necessary. Otherwise, - it's generated automatically. - GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: - description: Details of operations that perform create Tensorboard. - id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata + description: Deployed Model ID. + anomalyCount: + format: int32 + description: Number of anomalies within all stats. + type: integer + description: Statistics and anomalies generated by Model Monitoring. + id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies type: object + GoogleCloudAiplatformV1BleuSpec: properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Tensorboard. - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame: + useEffectiveOrder: + type: boolean + description: Optional. Whether to use_effective_order to compute bleu score. + type: object + id: GoogleCloudAiplatformV1BleuSpec description: >- - The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box, - i.e. the rectangle over the video frame pinpointing the found - AnnotationSpec. The coordinates are relative to the frame size, and the - point 0,0 is in the top left of the frame. + Spec for bleu score metric - calculates the precision of n-grams in the + prediction as compared to reference - returns a score ranging between 0 + to 1. + GoogleCloudAiplatformV1CancelPipelineJobRequest: type: object - properties: - xMin: - format: float - type: number - description: The leftmost coordinate of the bounding box. - yMax: - format: float - type: number - description: The bottommost coordinate of the bounding box. - xMax: - type: number - description: The rightmost coordinate of the bounding box. - format: float - yMin: - type: number - description: The topmost coordinate of the bounding box. - format: float - timeOffset: - description: >- - A time (frame) of a video in which the object has been detected. - Expressed as a number of seconds as measured from the start of the - video, with fractions up to a microsecond precision, and with "s" - appended at the end. - type: string - format: google-duration - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation: - description: The mask based segmentation annotation. + description: Request message for PipelineService.CancelPipelineJob. + properties: {} + id: GoogleCloudAiplatformV1CancelPipelineJobRequest + GoogleCloudAiplatformV1RougeResults: + description: Results for rouge metric. type: object + id: GoogleCloudAiplatformV1RougeResults properties: - annotationSpecColors: - description: The mapping between color and AnnotationSpec for this Annotation. + rougeMetricValues: + readOnly: true + description: Output only. Rouge metric values. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaAnnotationSpecColor + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeMetricValue' type: array - maskGcsUri: - type: string + GoogleCloudAiplatformV1NotebookEucConfig: + description: The euc configuration of NotebookRuntimeTemplate. + id: GoogleCloudAiplatformV1NotebookEucConfig + properties: + eucDisabled: + type: boolean description: >- - Google Cloud Storage URI that points to the mask image. The image - must be in PNG format. It must have the same size as the DataItem's - image. Each pixel in the image mask represents the AnnotationSpec - which the pixel in the image DataItem belong to. Each color is - mapped to one AnnotationSpec based on annotation_spec_colors. - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: + Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. + In proto3, the default value of a boolean is false. In this way, by + default EUC will be enabled for NotebookRuntimeTemplate. + bypassActasCheck: + type: boolean + description: >- + Output only. Whether ActAs check is bypassed for service account + attached to the VM. If false, we need ActAs check for the default + Compute Engine Service account. When a Runtime is created, a VM is + allocated using Default Compute Engine Service Account. Any user + requesting to use this Runtime requires Service Account User (ActAs) + permission over this SA. If true, Runtime owner is using EUC and + does not require the above permission as VM no longer use default + Compute Engine SA, but a P4SA. + readOnly: true + type: object + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig: + type: object + properties: + value: + format: double + description: >- + Specify a threshold value that can trigger the alert. 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. Each feature + must have a non-zero threshold if they need to be monitored. + Otherwise no alert will be triggered for that feature. + type: number + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + description: The config for Featurestore Monitoring threshold. + GoogleCloudAiplatformV1SchemaVertex: + id: GoogleCloudAiplatformV1SchemaVertex + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. + type: object + properties: + x: + type: number + description: X coordinate. + format: double + 'y': + type: number + format: double + description: Y coordinate. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. properties: - columnName: - type: string timeFormat: + type: string description: >- The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * @@ -5938,388 +6453,624 @@ components: the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + columnName: type: string - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation type: object - GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec: - description: >- - The median automated stopping rule stops a pending Trial if the Trial's - best objective_value is strictly below the median 'performance' of all - completed Trials reported up to the Trial's last measurement. Currently, - 'performance' refers to the running average of the objective values - reported by the Trial in each measurement. - id: GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: type: object + description: The config for Prediction data drift detection. + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig properties: - useElapsedDuration: - type: boolean + defaultDriftThreshold: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' description: >- - True if median automated stopping rule applies on - Measurement.elapsed_duration. It means that elapsed_duration field - of latest measurement of current Trial is used to compute median - objective value for each completed Trials. - GoogleCloudAiplatformV1FeatureViewSync: - id: GoogleCloudAiplatformV1FeatureViewSync - properties: - name: + Drift anomaly detection threshold used by all features. When the + per-feature thresholds are not set, this field can be used to + specify a threshold for all features. + driftThresholds: description: >- - Identifier. Name of the FeatureViewSync. Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` - type: string - syncSummary: - description: Output only. Summary of the sync job. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary - readOnly: true - runTime: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Output only. Time when this FeatureViewSync is finished. - readOnly: true - createTime: - type: string - format: google-datetime + Key is the feature name and value is the threshold. If a feature + needs to be monitored for drift, a value threshold must be + configured for that feature. The threshold here is against feature + distribution distance between different time windws. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + type: object + attributionScoreDriftThresholds: description: >- - Output only. Time when this FeatureViewSync is created. Creation of - a FeatureViewSync means that the job is pending / waiting for - sufficient resources but may not have started the actual data - transfer yet. - readOnly: true - finalStatus: - description: Output only. Final status of the FeatureViewSync. - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true + Key is the feature name and value is the threshold. The threshold + here is against attribution score distance between different time + windows. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + type: object + GoogleCloudAiplatformV1NotebookRuntime: description: >- - FeatureViewSync is a representation of sync operation which copies data - from data source to Feature View in Online Store. - type: object - GoogleCloudAiplatformV1SchemaTextDataItem: - description: Payload of Text DataItem. + A runtime is a virtual machine allocated to a particular user for a + particular Notebook file on temporary basis with lifetime limited to 24 + hours. properties: - gcsUri: - description: >- - Output only. Google Cloud Storage URI points to the original text in - user's bucket. The text file is up to 10MB in size. + notebookRuntimeType: + enum: + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK + readOnly: true + enumDescriptions: + - >- + Unspecified notebook runtime type, NotebookRuntimeType will + default to USER_DEFINED. + - runtime or template with coustomized configurations from user. + - runtime or template with system defined configurations. type: string + description: Output only. The type of the notebook runtime. + serviceAccount: readOnly: true - type: object - id: GoogleCloudAiplatformV1SchemaTextDataItem - GoogleCloudAiplatformV1CustomJobSpec: - description: Represents the spec of a CustomJob. - properties: - experiment: description: >- - Optional. The Experiment associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` + Output only. The service account that the NotebookRuntime workload + runs as. type: string - reservedIpRanges: - items: - type: string - type: array + name: + readOnly: true + description: Output only. The resource name of the NotebookRuntime. + type: string + displayName: description: >- - Optional. A list of names for the reserved ip ranges under the VPC - network that can be used for this job. If set, we will deploy the - job within the provided ip ranges. Otherwise, the job will be - deployed to any ip ranges under the provided VPC network. Example: - ['vertex-ai-ip-range']. - experimentRun: + Required. The display name of the NotebookRuntime. The name can be + up to 128 characters long and can consist of any UTF-8 characters. + type: string + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + runtimeState: + enumDescriptions: + - Unspecified runtime state. + - NotebookRuntime is in running state. + - NotebookRuntime is in starting state. + - NotebookRuntime is in stopping state. + - NotebookRuntime is in stopped state. + - >- + NotebookRuntime is in upgrading state. It is in the middle of + upgrading process. + - NotebookRuntime was unable to start/stop properly. + - NotebookRuntime is in invalid state. Cannot be recovered. + description: Output only. The runtime (instance) state of the NotebookRuntime. + type: string + enum: + - RUNTIME_STATE_UNSPECIFIED + - RUNNING + - BEING_STARTED + - BEING_STOPPED + - STOPPED + - BEING_UPGRADED + - ERROR + - INVALID + readOnly: true + encryptionSpec: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Optional. The Experiment Run associated with this job. Format: - `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` + Output only. Customer-managed encryption key spec for the notebook + runtime. + runtimeUser: type: string - models: + description: Required. The user email of the NotebookRuntime. + networkTags: items: type: string - description: >- - Optional. The name of the Model resources for which to generate a - mapping to artifact URIs. Applicable only to some of the - Google-provided custom jobs. Format: - `projects/{project}/locations/{location}/models/{model}` In order to - retrieve a specific version of the model, also provide the version - ID or version alias. Example: - `projects/{project}/locations/{location}/models/{model}@2` or - `projects/{project}/locations/{location}/models/{model}@golden` If - no version ID or alias is specified, the "default" version will be - returned. The "default" version alias is created for the first - version of the model, and can be moved to other versions later on. - There will be exactly one default version. type: array - baseOutputDirectory: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' description: >- - The Cloud Storage location to store the output of this CustomJob or - HyperparameterTuningJob. For HyperparameterTuningJob, the - baseOutputDirectory of each child CustomJob backing a Trial is set - to a subdirectory of name id under its parent - HyperparameterTuningJob's baseOutputDirectory. The following Vertex - AI environment variables will be passed to containers or python - modules when this field is set: For CustomJob: * AIP_MODEL_DIR = - `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * - AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of - HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * - AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = - `//logs/` - enableDashboardAccess: + Optional. The Compute Engine tags to add to runtime (see [Tagging + instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). + isUpgradable: + readOnly: true type: boolean + description: Output only. Whether NotebookRuntime is upgradable. + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + notebookRuntimeTemplateRef: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef description: >- - Optional. Whether you want Vertex AI to enable access to the - customized dashboard in training chief container. If set to `true`, - you can access the dashboard at the URIs given by - CustomJob.web_access_uris or Trial.web_access_uris (within - HyperparameterTuningJob.trials). - workerPoolSpecs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' - type: array - description: >- - Required. The spec of the worker pools including machine type and - Docker image. All worker pools except the first one are optional and - can be skipped by providing an empty value. - serviceAccount: + Output only. The pointer to NotebookRuntimeTemplate this + NotebookRuntime is created from. + createTime: + format: google-datetime + description: Output only. Timestamp when this NotebookRuntime was created. type: string + readOnly: true + expirationTime: description: >- - Specifies the service account for workload run-as account. Users - submitting jobs must have act-as permission on this run-as account. - If unspecified, the [Vertex AI Custom Code Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) - for the CustomJob's project is used. - persistentResourceId: + Output only. Timestamp when this NotebookRuntime will be expired: 1. + System Predefined NotebookRuntime: 24 hours after creation. After + expiration, system predifined runtime will be deleted. 2. User + created NotebookRuntime: 6 months after last upgrade. After + expiration, user created runtime will be stopped and allowed for + upgrade. + format: google-datetime + type: string + readOnly: true + version: + description: Output only. The VM os image version of NotebookRuntime. + type: string + readOnly: true + labels: + type: object description: >- - Optional. The ID of the PersistentResource in the same Project and - Location which to run If this is specified, the job will be run on - existing machines held by the PersistentResource instead of - on-demand short-live machines. The network and CMEK configs on the - job should be consistent with those on the PersistentResource, - otherwise, the job will be rejected. + The labels with user-defined metadata to organize your + NotebookRuntime. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. No more than 64 user labels can be associated with one + NotebookRuntime (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for NotebookRuntime: * + "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output + only, its value is the Compute Engine instance id. * + "aiplatform.googleapis.com/colab_enterprise_entry_service": its + value is either "bigquery" or "vertex"; if absent, it should be + "vertex". This is to describe the entry service, either BigQuery or + Vertex. + additionalProperties: + type: string + description: + description: The description of the NotebookRuntime. type: string - network: + idleShutdownConfig: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig description: >- - Optional. The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to which - the Job should be peered. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - To specify this field, you must have already [configured VPC Network - Peering for Vertex - AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If - this field is left unspecified, the job is not peered with any - network. + Output only. The idle shutdown configuration of the notebook + runtime. + proxyUri: + description: Output only. The proxy endpoint used to access the NotebookRuntime. type: string - protectedArtifactLocationId: + readOnly: true + healthState: + enum: + - HEALTH_STATE_UNSPECIFIED + - HEALTHY + - UNHEALTHY + enumDescriptions: + - Unspecified health state. + - NotebookRuntime is in healthy state. Applies to ACTIVE state. + - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. + readOnly: true + description: Output only. The health state of the NotebookRuntime. type: string - description: >- - The ID of the location to store protected artifacts. e.g. - us-central1. Populate only when the location is different than - CustomJob location. List of supported locations: - https://cloud.google.com/vertex-ai/docs/general/locations - tensorboard: - description: >- - Optional. The name of a Vertex AI Tensorboard resource to which this - CustomJob will upload Tensorboard logs. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + updateTime: + format: google-datetime + readOnly: true type: string - scheduling: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' - description: Scheduling options for a CustomJob. - enableWebAccess: - type: boolean description: >- - Optional. Whether you want Vertex AI to enable [interactive shell - access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - to training containers. If set to `true`, you can access interactive - shells at the URIs given by CustomJob.web_access_uris or - Trial.web_access_uris (within HyperparameterTuningJob.trials). - id: GoogleCloudAiplatformV1CustomJobSpec - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation + Output only. Timestamp when this NotebookRuntime was most recently + updated. + id: GoogleCloudAiplatformV1NotebookRuntime type: object - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. * A boolean value that indicates whether the - value is valid. + GoogleCloudAiplatformV1BatchMigrateResourcesRequest: properties: - columnName: + migrateResourceRequests: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + description: >- + Required. The request messages specifying the resources to migrate. + They must be in the same location as the destination. Up to 50 + resources can be migrated in one batch. + type: array + type: object + id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest + description: Request message for MigrationService.BatchMigrateResources. + GoogleCloudAiplatformV1ExportFeatureValuesResponse: + id: GoogleCloudAiplatformV1ExportFeatureValuesResponse + description: Response message for FeaturestoreService.ExportFeatureValues. + properties: {} + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification: + description: >- + A TrainingJob that trains and uploads an AutoML Text Classification + Model. + type: object + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + description: The input parameters of this TrainingJob. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassification + GoogleCloudAiplatformV1SearchNearestEntitiesResponse: + properties: + nearestNeighbors: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighbors' + description: The nearest neighbors of the query entity. + id: GoogleCloudAiplatformV1SearchNearestEntitiesResponse + type: object + description: Response message for FeatureOnlineStoreService.SearchNearestEntities + GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: + type: object + description: Metadata information for NotebookService.UpgradeNotebookRuntime. + properties: + progressMessage: type: string - GoogleCloudAiplatformV1FunctionCall: + description: >- + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata + GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: + description: Runtime operation information for EndpointService.MutateDeployedModel. + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + type: object + id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata + GoogleCloudAiplatformV1CreateTensorboardOperationMetadata: type: object + description: Details of operations that perform create Tensorboard. + id: GoogleCloudAiplatformV1CreateTensorboardOperationMetadata properties: - args: - additionalProperties: - description: Properties of the object. - type: any + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Tensorboard. + GoogleCloudAiplatformV1AutoscalingMetricSpec: + description: >- + The metric specification that defines the target resource utilization + (CPU utilization, accelerator's duty cycle, and so on) for calculating + the desired replica count. + id: GoogleCloudAiplatformV1AutoscalingMetricSpec + properties: + metricName: + type: string description: >- - Optional. Required. The function parameters and values in JSON - object format. See [FunctionDeclaration.parameters] for parameter - details. - type: object - name: + Required. The resource metric name. Supported metrics: * For Online + Prediction: * + `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` + * `aiplatform.googleapis.com/prediction/online/cpu/utilization` + target: + type: integer description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name]. - type: string - id: GoogleCloudAiplatformV1FunctionCall - description: >- - A predicted [FunctionCall] returned from the model that contains a - string representing the [FunctionDeclaration.name] and a structured JSON - object containing the parameters and their values. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs - properties: {} + The target resource utilization in percentage (1% - 100%) for the + given metric; once the real usage deviates from the target by a + certain percentage, the machine replicas change. The default value + is 60 (representing 60%) if not provided. + format: int32 type: object - GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset: + GoogleCloudAiplatformV1CountTokensRequest: type: object + id: GoogleCloudAiplatformV1CountTokensRequest + description: Request message for PredictionService.CountTokens. properties: - dataset: + contents: + description: Optional. Input content. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + tools: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' description: >- - Full resource name of data labeling Dataset. Format: - `projects/{project}/datasets/{dataset}`. - type: string - datasetDisplayName: - description: The Dataset's display name in datalabeling.googleapis.com. + Optional. A list of `Tools` the model may use to generate the next + response. A `Tool` is a piece of code that enables the system to + interact with external systems to perform an action, or set of + actions, outside of knowledge and scope of the model. + systemInstruction: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: >- + Optional. The user provided system instructions for the model. Note: + only text should be used in parts and content in each part will be + in a separate paragraph. + model: type: string - dataLabelingAnnotatedDatasets: - type: array description: >- - The migratable AnnotatedDataset in datalabeling.googleapis.com - belongs to the data labeling Dataset. + Optional. The name of the publisher model requested to serve the + prediction. Format: + `projects/{project}/locations/{location}/publishers/*/models/*` + instances: + description: >- + Optional. The instances that are the input to token counting call. + Schema is identical to the prediction schema of the underlying + model. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset - id: GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset - description: Represents one Dataset in datalabeling.googleapis.com. - GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation: - id: GoogleCloudAiplatformV1SchemaVideoObjectTrackingAnnotation + type: any + type: array + GoogleCloudAiplatformV1IndexStats: + properties: + vectorsCount: + format: int64 + description: Output only. The number of dense vectors in the Index. + type: string + readOnly: true + sparseVectorsCount: + format: int64 + readOnly: true + type: string + description: Output only. The number of sparse vectors in the Index. + shardsCount: + format: int32 + description: Output only. The number of shards in the Index. + type: integer + readOnly: true + description: Stats of the Index. + id: GoogleCloudAiplatformV1IndexStats + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame: + description: >- + The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box, + i.e. the rectangle over the video frame pinpointing the found + AnnotationSpec. The coordinates are relative to the frame size, and the + point 0,0 is in the top left of the frame. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame properties: yMin: description: The topmost coordinate of the bounding box. type: number - format: double - instanceId: - description: >- - The instance of the object, expressed as a positive integer. Used to - track the same object across different frames. - format: int64 - type: string + format: float yMax: + format: float type: number description: The bottommost coordinate of the bounding box. - format: double - annotationSpecId: - description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - timeOffset: - type: string - description: >- - A time (frame) of a video to which this annotation pertains. - Represented as the duration since the video's start. - format: google-duration xMax: description: The rightmost coordinate of the bounding box. - format: double + format: float type: number - displayName: - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - type: string xMin: + format: float type: number description: The leftmost coordinate of the bounding box. - format: double - description: Annotation details specific to video object tracking. + timeOffset: + description: >- + A time (frame) of a video in which the object has been detected. + Expressed as a number of seconds as measured from the start of the + video, with fractions up to a microsecond precision, and with "s" + appended at the end. + format: google-duration + type: string type: object - GoogleCloudAiplatformV1ReadIndexDatapointsRequest: + GoogleCloudAiplatformV1TensorboardTimeSeries: type: object + id: GoogleCloudAiplatformV1TensorboardTimeSeries properties: - ids: - type: array - items: - type: string - description: IDs of the datapoints to be searched for. - deployedIndexId: - description: The ID of the DeployedIndex that will serve the request. + description: + description: Description of this TensorboardTimeSeries. type: string - id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest - description: The request message for MatchService.ReadIndexDatapoints. - CloudAiLargeModelsVisionMedia: + createTime: + type: string + format: google-datetime + description: Output only. Timestamp when this TensorboardTimeSeries was created. + readOnly: true + pluginName: + description: >- + Immutable. Name of the plugin this time series pertain to. Such as + Scalar, Tensor, Blob + type: string + pluginData: + format: byte + description: Data of the current plugin, with the size limited to 65KB. + type: string + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + description: >- + Output only. Scalar, Tensor, or Blob metadata for this + TensorboardTimeSeries. + readOnly: true + updateTime: + description: >- + Output only. Timestamp when this TensorboardTimeSeries was last + updated. + format: google-datetime + readOnly: true + type: string + name: + description: Output only. Name of the TensorboardTimeSeries. + readOnly: true + type: string + valueType: + description: Required. Immutable. Type of TensorboardTimeSeries value. + type: string + enum: + - VALUE_TYPE_UNSPECIFIED + - SCALAR + - TENSOR + - BLOB_SEQUENCE + enumDescriptions: + - The value type is unspecified. + - >- + Used for TensorboardTimeSeries that is a list of scalars. E.g. + accuracy of a model over epochs/time. + - >- + Used for TensorboardTimeSeries that is a list of tensors. E.g. + histograms of weights of layer in a model over epoch/time. + - >- + Used for TensorboardTimeSeries that is a list of blob sequences. + E.g. set of sample images with labels over epochs/time. + etag: + description: >- + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + type: string + displayName: + type: string + description: >- + Required. User provided name of this TensorboardTimeSeries. This + value should be unique among all TensorboardTimeSeries resources + belonging to the same TensorboardRun resource (parent resource). + description: TensorboardTimeSeries maps to times series produced in training runs + GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: type: object - description: Media. + id: GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec properties: - video: - $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' - description: Video - image: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' - description: Image. - id: CloudAiLargeModelsVisionMedia - GoogleCloudAiplatformV1DeployIndexOperationMetadata: + useElapsedDuration: + type: boolean + description: >- + True if Measurement.elapsed_duration is used as the x-axis of each + Trials Decay Curve. Otherwise, Measurement.step_count will be used + as the x-axis. + description: >- + The decay curve automated stopping rule builds a Gaussian Process + Regressor to predict the final objective value of a Trial based on the + already completed Trials and the intermediate measurements of the + current Trial. Early stopping is requested for the current Trial if + there is very low probability to exceed the optimal value found so far. + GoogleCloudAiplatformV1CoherenceInput: type: object + description: Input for coherence metric. + id: GoogleCloudAiplatformV1CoherenceInput properties: - deployedIndexId: - description: The unique index id specified by user + instance: + description: Required. Coherence instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInstance' + metricSpec: + description: Required. Spec for coherence score metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceSpec' + GoogleCloudAiplatformV1Study: + properties: + name: + type: string + description: >- + Output only. The name of a study. The study's globally unique + identifier. Format: + `projects/{project}/locations/{location}/studies/{study}` + readOnly: true + displayName: + type: string + description: Required. Describes the Study, default value is empty string. + createTime: + format: google-datetime + description: Output only. Time at which the study was created. + type: string + readOnly: true + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: Required. Configuration of the Study. + state: + enumDescriptions: + - The study state is unspecified. + - The study is active. + - The study is stopped due to an internal error. + - >- + The study is done when the service exhausts the parameter search + space or max_trial_count is reached. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - COMPLETED + type: string + description: Output only. The detailed state of a Study. + readOnly: true + inactiveReason: + type: string + description: >- + Output only. A human readable reason why the Study is inactive. This + should be empty if a study is ACTIVE or COMPLETED. + readOnly: true + type: object + id: GoogleCloudAiplatformV1Study + description: A message representing a Study. + GoogleCloudAiplatformV1CitationMetadata: + id: GoogleCloudAiplatformV1CitationMetadata + type: object + description: A collection of source attributions for a piece of content. + properties: + citations: + description: Output only. List of citations. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Citation' + readOnly: true + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: + description: >- + This message will be placed in the metadata field of a + google.longrunning.Operation associated with a + CheckTrialEarlyStoppingState request. + properties: + study: + description: The name of the Study that the Trial belongs to. + type: string + trial: type: string + description: The Trial name. genericMetadata: - description: The operation generic information. + description: Operation metadata for suggesting Trials. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for IndexEndpointService.DeployIndex. - id: GoogleCloudAiplatformV1DeployIndexOperationMetadata - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: - description: Metrics for a single confidence threshold. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata type: object + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: properties: - confidenceThreshold: + timeSegmentStart: description: >- - Output only. The confidence threshold value used to compute the - metrics. - type: number - format: float - f1Score: - format: float - type: number - description: Output only. The harmonic mean of recall and precision. - recall: - type: number - format: float - description: Output only. Recall for the given confidence threshold. - precision: - type: number - description: Output only. Precision for the given confidence threshold. - format: float - GoogleCloudAiplatformV1SyncFeatureViewResponse: + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. + type: string + mimeType: + type: string + description: >- + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + timeSegmentEnd: + description: >- + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. + type: string + content: + type: string + description: >- + The Google Cloud Storage location of the video on which to perform + the prediction. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance + description: Prediction input format for Video Action Recognition. type: object - id: GoogleCloudAiplatformV1SyncFeatureViewResponse + GoogleCloudAiplatformV1PipelineJob: + type: object + description: An instance of a machine learning PipelineJob. + id: GoogleCloudAiplatformV1PipelineJob properties: - featureViewSync: + runtimeConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' + description: Runtime config of the pipeline. + labels: + type: object description: >- - Format: - `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` + The labels with user-defined metadata to organize PipelineJob. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + Note there is some reserved label key for Vertex AI Pipelines. - + `vertex-ai-pipelines-run-billing-id`, user set value will get + overrided. + additionalProperties: + type: string + templateUri: type: string - description: Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. - GoogleCloudAiplatformV1TrainingPipeline: - properties: + description: >- + A template uri from where the PipelineJob.pipeline_spec, if empty, + will be downloaded. Currently, only uri from Vertex Template + Registry & Gallery is supported. Reference to + https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. state: - description: Output only. The detailed state of the pipeline. + readOnly: true enum: - PIPELINE_STATE_UNSPECIFIED - PIPELINE_STATE_QUEUED @@ -6330,7 +7081,7 @@ components: - PIPELINE_STATE_CANCELLING - PIPELINE_STATE_CANCELLED - PIPELINE_STATE_PAUSED - readOnly: true + description: Output only. The detailed state of the job. type: string enumDescriptions: - The pipeline state is unspecified. @@ -6347,267 +7098,161 @@ components: or PIPELINE_STATE_CANCELLED. - The pipeline has been cancelled. - The pipeline has been stopped, and can be resumed. - createTime: - description: Output only. Time when the TrainingPipeline was created. - type: string - format: google-datetime + name: readOnly: true - modelId: type: string + description: Output only. The resource name of the PipelineJob. + displayName: description: >- - Optional. The ID to use for the uploaded Model, which will become - the final component of the model resource name. This value may be up - to 63 characters, and valid characters are `[a-z0-9_-]`. The first - character cannot be a number or hyphen. - name: - description: Output only. Resource name of the TrainingPipeline. + The display name of the Pipeline. The name can be up to 128 + characters long and can consist of any UTF-8 characters. type: string - readOnly: true - labels: - type: object - description: >- - The labels with user-defined metadata to organize TrainingPipelines. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - additionalProperties: - type: string - parentModel: + encryptionSpec: description: >- - Optional. When specify this field, the `model_to_upload` will not be - uploaded as a new model, instead, it will become a new version of - this `parent_model`. - type: string - encryptionSpec: - description: >- - Customer-managed encryption key spec for a TrainingPipeline. If set, - this TrainingPipeline will be secured by this key. Note: Model - trained by this TrainingPipeline is also secured by this key if - model_to_upload is not set separately. + Customer-managed encryption key spec for a pipelineJob. If set, this + PipelineJob and all of its sub-resources will be secured by this + key. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - endTime: - type: string - description: >- - Output only. Time when the TrainingPipeline entered any of the - following states: `PIPELINE_STATE_SUCCEEDED`, - `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. - readOnly: true - format: google-datetime updateTime: description: >- - Output only. Time when the TrainingPipeline was most recently + Output only. Timestamp when this PipelineJob was most recently updated. + readOnly: true + type: string format: google-datetime + startTime: + description: Output only. Pipeline start time. type: string readOnly: true - modelToUpload: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' - description: >- - Describes the Model that may be uploaded (via - ModelService.UploadModel) by this TrainingPipeline. The - TrainingPipeline's training_task_definition should make clear - whether this Model description should be populated, and if there are - any special requirements regarding how it should be filled. If - nothing is mentioned in the training_task_definition, then it should - be assumed that this field should not be filled and the training - task either uploads the Model without a need of this information, or - that training task does not support uploading a Model as part of the - pipeline. When the Pipeline's state becomes - `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded - into Vertex AI, then the model_to_upload's resource name is - populated. The Model is always uploaded into the Project and - Location in which this pipeline is. - error: - description: >- - Output only. Only populated when the pipeline's state is - `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. + format: google-datetime + createTime: + description: Output only. Pipeline creation time. readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - trainingTaskDefinition: + format: google-datetime type: string + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Required. A Google Cloud Storage path to the YAML file that defines - the training task which is responsible for producing the model - artifact, and may also include additional auxiliary work. The - definition files that can be used here are found in - gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - inputDataConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1InputDataConfig' + Output only. The error that occurred during pipeline execution. Only + populated when the pipeline's state is FAILED or CANCELLED. + readOnly: true + templateMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' description: >- - Specifies Vertex AI owned input data that may be used for training - the Model. The TrainingPipeline's training_task_definition should - make clear whether this config is used and if there are any special - requirements on how it should be filled. If nothing about this - config is mentioned in the training_task_definition, then it should - be assumed that the TrainingPipeline does not depend on this - configuration. - startTime: - format: google-datetime + Output only. Pipeline template metadata. Will fill up fields if + PipelineJob.template_uri is from supported template registry. readOnly: true + network: type: string description: >- - Output only. Time when the TrainingPipeline for the first time - entered the `PIPELINE_STATE_RUNNING` state. - trainingTaskMetadata: - readOnly: true - type: any + The full name of the Compute Engine + [network](/compute/docs/networks-and-firewalls#networks) to which + the Pipeline Job's workload should be peered. For example, + `projects/12345/global/networks/myVPC`. + [Format](/compute/docs/reference/rest/v1/networks/insert) is of the + form `projects/{project}/global/networks/{network}`. Where {project} + is a project number, as in `12345`, and {network} is a network name. + Private services access must already be configured for the network. + Pipeline job will apply the network configuration to the Google + Cloud resources being launched, if applied, such as Vertex AI + Training or Dataflow job. If left unspecified, the workload is not + peered with any network. + reservedIpRanges: + type: array description: >- - Output only. The metadata information as specified in the - training_task_definition's `metadata`. This metadata is an auxiliary - runtime and final information about the training task. While the - pipeline is running this information is populated only at a best - effort basis. Only present if the pipeline's - training_task_definition contains `metadata` object. - trainingTaskInputs: + A list of names for the reserved ip ranges under the VPC network + that can be used for this Pipeline Job's workload. If set, we will + deploy the Pipeline Job's workload within the provided ip ranges. + Otherwise, the job will be deployed to any ip ranges under the + provided VPC network. Example: ['vertex-ai-ip-range']. + items: + type: string + pipelineSpec: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: The spec of the pipeline. + preflightValidations: + type: boolean description: >- - Required. The training task's parameter(s), as specified in the - training_task_definition's `inputs`. - type: any - displayName: + Optional. Whether to do component level validations before job + creation. + serviceAccount: type: string - description: Required. The user-defined name of this TrainingPipeline. - id: GoogleCloudAiplatformV1TrainingPipeline - description: >- - The TrainingPipeline orchestrates tasks associated with training a - Model. It always executes the training task, and optionally may also - export data from Vertex AI's Dataset which becomes the training input, - upload the Model to Vertex AI, and evaluate the Model. - type: object - GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution: - type: object - properties: - max: - type: number - readOnly: true - format: double - description: Output only. The maximum of the population values. - p95: - readOnly: true - description: Output only. The 95th percentile of the values in the population. - type: number - format: double - p5: - readOnly: true - format: double - type: number - description: Output only. The 5th percentile of the values in the population. - mean: - format: double - type: number - readOnly: true - description: Output only. The arithmetic mean of the values in the population. - min: - readOnly: true - type: number - description: Output only. The minimum of the population values. - format: double - buckets: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - type: array - description: Output only. Defines the histogram bucket. + description: >- + The service account that the pipeline workload runs as. If not + specified, the Compute Engine default service account in the project + will be used. See + https://cloud.google.com/compute/docs/access/service-accounts#default_service_account + Users starting the pipeline must have the + `iam.serviceAccounts.actAs` permission on this service account. + scheduleName: readOnly: true - sum: type: string + description: >- + Output only. The schedule resource name. Only returned if the + Pipeline is created by Schedule API. + jobDetail: readOnly: true - description: Output only. Sum of a given population of values. - format: int64 - median: - format: double - type: number - description: Output only. The median of the values in the population. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' + description: >- + Output only. The details of pipeline run. Not available in the list + view. + endTime: + format: google-datetime + description: Output only. Pipeline end time. + type: string readOnly: true - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - description: Dataset distribution for Supervised Tuning. - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: + description: Describe pass-through fields in read_instance source. type: object - id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError properties: - errorMessage: + fieldName: description: >- - A human-readable message that is shown to the user to help them fix - the error. Note that this message may change from time to time, your - code should check against error_type as the source of truth. - type: string - sourceGcsUri: - type: string - description: Cloud Storage URI pointing to the original file in user's bucket. - errorType: - description: The error type of this record. - type: string - enumDescriptions: - - Default, shall not be used. - - The record is empty. - - Invalid json format. - - Invalid csv format. - - Invalid avro format. - - The embedding id is not valid. - - >- - The size of the dense embedding vectors does not match with the - specified dimension. - - The `namespace` field is missing. - - >- - Generic catch-all error. Only used for validation failure where - the root cause cannot be easily retrieved programmatically. - - There are multiple restricts with the same `namespace` value. - - Numeric restrict has operator specified in datapoint. - - Numeric restrict has multiple values specified. - - Numeric restrict has invalid numeric value specified. - - File is not in UTF_8 format. - - Error parsing sparse dimensions field. - - Token restrict value is invalid. - - Invalid sparse embedding. - - Invalid embedding. - enum: - - ERROR_TYPE_UNSPECIFIED - - EMPTY_LINE - - INVALID_JSON_SYNTAX - - INVALID_CSV_SYNTAX - - INVALID_AVRO_SYNTAX - - INVALID_EMBEDDING_ID - - EMBEDDING_SIZE_MISMATCH - - NAMESPACE_MISSING - - PARSING_ERROR - - DUPLICATE_NAMESPACE - - OP_IN_DATAPOINT - - MULTIPLE_VALUES - - INVALID_NUMERIC_VALUE - - INVALID_ENCODING - - INVALID_SPARSE_DIMENSIONS - - INVALID_TOKEN_VALUE - - INVALID_SPARSE_EMBEDDING - - INVALID_EMBEDDING - rawRecord: - description: The original content of this record. - type: string - embeddingId: + Required. The name of the field in the CSV header or the name of the + column in BigQuery table. The naming restriction is the same as + Feature.name. type: string - description: Empty if the embedding id is failed to parse. - GoogleCloudAiplatformV1FeatureNoiseSigma: + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + GoogleCloudAiplatformV1DeployModelResponse: + description: Response message for EndpointService.DeployModel. + id: GoogleCloudAiplatformV1DeployModelResponse properties: - noiseSigma: + deployedModel: + description: The DeployedModel that had been deployed in the Endpoint. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + type: object + GoogleCloudAiplatformV1ToolCallValidMetricValue: + type: object + description: Tool call valid metric value for an instance. + id: GoogleCloudAiplatformV1ToolCallValidMetricValue + properties: + score: + readOnly: true + format: float + description: Output only. Tool call valid score. + type: number + CloudAiLargeModelsVisionSemanticFilterResponse: + properties: + namedBoundingBoxes: type: array - description: >- - Noise sigma per feature. No noise is added to features that are not - set. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature - description: >- - Noise sigma by features. Noise sigma represents the standard deviation - of the gaussian kernel that will be used to add noise to interpolated - inputs prior to computing gradients. - id: GoogleCloudAiplatformV1FeatureNoiseSigma + $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' + description: >- + Class labels of the bounding boxes that failed the semantic + filtering. Bounding box coordinates. + passedSemanticFilter: + description: >- + This response is added when semantic filter config is turned on in + EditConfig. It reports if this image is passed semantic filter + response. If passed_semantic_filter is false, the bounding box + information will be populated for user to check what caused the + semantic filter to fail. + type: boolean + id: CloudAiLargeModelsVisionSemanticFilterResponse type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation: - properties: - columnName: - type: string + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation: description: >- Training pipeline will perform following transformation functions. * The categorical string as is--no change to case, punctuation, spelling, @@ -6616,250 +7261,508 @@ components: less than 5 times in the training dataset are treated as the "unknown" category. The "unknown" category gets its own special lookup index and resulting embedding. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + properties: + columnName: + type: string type: object - GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint: - id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + GoogleCloudAiplatformV1BatchMigrateResourcesResponse: + description: Response message for MigrationService.BatchMigrateResources. type: object + properties: + migrateResourceResponses: + description: Successfully migrated resources. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceResponse + id: GoogleCloudAiplatformV1BatchMigrateResourcesResponse + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig: description: >- - The dedicated serving endpoint for this FeatureOnlineStore. Only need to - set when you choose Optimized storage type. Public endpoint is - provisioned by default. + Specification message containing the config for this SliceSpec. When + `kind` is selected as `value` and/or `range`, only a single slice will + be computed. When `all_values` is present, a separate slice will be + computed for each possible label/value for the corresponding key in + `config`. Examples, with feature zip_code with values 12345, 23334, + 88888 and feature country with values "US", "Canada", "Mexico" in the + dataset: Example 1: { "zip_code": { "value": { "float_value": 12345.0 } + } } A single slice for any data with zip_code 12345 in the dataset. + Example 2: { "zip_code": { "range": { "low": 12345, "high": 20000 } } } + A single slice containing data where the zip_codes between 12345 and + 20000 For this example, data with the zip_code of 12345 will be in this + slice. Example 3: { "zip_code": { "range": { "low": 10000, "high": 20000 + } }, "country": { "value": { "string_value": "US" } } } A single slice + containing data where the zip_codes between 10000 and 20000 has the + country "US". For this example, data with the zip_code of 12345 and + country "US" will be in this slice. Example 4: { "country": + {"all_values": { "value": true } } } Three slices are computed, one for + each unique country in the dataset. Example 5: { "country": { + "all_values": { "value": true } }, "zip_code": { "value": { + "float_value": 12345.0 } } } Three slices are computed, one for each + unique country in the dataset where the zip_code is also 12345. For this + example, data with zip_code 12345 and country "US" will be in one slice, + zip_code 12345 and country "Canada" in another slice, and zip_code 12345 + and country "Mexico" in another slice, totaling 3 slices. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig properties: - publicEndpointDomainName: - type: string + allValues: + type: boolean description: >- - Output only. This field will be populated with the domain name to - use for this FeatureOnlineStore - readOnly: true - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs: + If all_values is set to true, then all possible labels of the keyed + feature will have another slice computed. Example: + `{"all_values":{"value":true}}` + value: + description: >- + A unique specific value for a given feature. Example: `{ "value": { + "string_value": "12345" } }` + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue + range: + description: >- + A range of values for a numerical feature. Example: + `{"range":{"low":10000.0,"high":50000.0}}` will capture 12345 and + 23334 in the slice. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange type: object + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs - properties: - modelType: - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which c - annot be exported. Default. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. - - >- - A versatile model that is meant to be exported (see - ModelService.ExportModel) and used on a Google Coral device. - - >- - A model that trades off quality for low latency, to be exported - (see ModelService.ExportModel) and used on a Google Coral device. - - >- - A versatile model that is meant to be exported (see - ModelService.ExportModel) and used on an NVIDIA Jetson device. - - >- - A model that trades off quality for low latency, to be exported - (see ModelService.ExportModel) and used on an NVIDIA Jetson - device. - type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_CORAL_VERSATILE_1 - - MOBILE_CORAL_LOW_LATENCY_1 - - MOBILE_JETSON_VERSATILE_1 - - MOBILE_JETSON_LOW_LATENCY_1 - GoogleCloudAiplatformV1StreamRawPredictRequest: + GoogleCloudAiplatformV1SchemaPredictParamsVideoObjectTrackingPredictionParams properties: - httpBody: - $ref: '#/components/schemas/GoogleApiHttpBody' + minBoundingBoxSize: + format: float + type: number description: >- - The prediction input. Supports HTTP headers and arbitrary data - payload. - id: GoogleCloudAiplatformV1StreamRawPredictRequest - description: Request message for PredictionService.StreamRawPredict. + Only bounding boxes with shortest edge at least that long as a + relative value of video frame size are returned. Default value is + 0.0. + maxPredictions: + format: int32 + type: integer + description: >- + The model only returns up to that many top, by confidence score, + predictions per frame of the video. If this number is very high, the + Model may return fewer predictions per frame. Default value is 50. + confidenceThreshold: + format: float + type: number + description: >- + The Model only returns predictions with at least this confidence + score. Default value is 0.0 type: object - GoogleCloudAiplatformV1DeployModelOperationMetadata: + description: Prediction model parameters for Video Object Tracking. + GoogleCloudAiplatformV1PointwiseMetricSpec: + description: Spec for pointwise metric. + id: GoogleCloudAiplatformV1PointwiseMetricSpec + properties: + metricPromptTemplate: + description: Required. Metric prompt template for pointwise metric. + type: string + type: object + GoogleCloudAiplatformV1CreateEndpointOperationMetadata: + type: object + description: Runtime operation information for EndpointService.CreateEndpoint. + id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata properties: genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' description: The operation generic information. - description: Runtime operation information for EndpointService.DeployModel. - id: GoogleCloudAiplatformV1DeployModelOperationMetadata - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1MutateDeployedIndexResponse: type: object + id: GoogleCloudAiplatformV1MutateDeployedIndexResponse properties: - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - repeatedCategorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation - repeatedText: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation - repeatedNumeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation: - description: >- - Training pipeline will perform following transformation functions. * The - categorical string as is--no change to case, punctuation, spelling, - tense, and so on. * Convert the category name to a dictionary lookup - index and generate an embedding for each index. * Categories that appear - less than 5 times in the training dataset are treated as the "unknown" - category. The "unknown" category gets its own special lookup index and - resulting embedding. + deployedIndex: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: The DeployedIndex that had been updated in the IndexEndpoint. + description: Response message for IndexEndpointService.MutateDeployedIndex. + GoogleCloudAiplatformV1PurgeExecutionsRequest: + id: GoogleCloudAiplatformV1PurgeExecutionsRequest type: object properties: - columnName: + force: + type: boolean + description: >- + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Execution names + that would be deleted. + filter: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation - GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: - id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig - description: >- - Config for migrating Model in automl.googleapis.com to Vertex AI's - Model. + description: >- + Required. A required filter matching the Executions to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + description: Request message for MetadataService.PurgeExecutions. + GoogleCloudAiplatformV1ToolParameterKVMatchInput: properties: - model: + instances: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInstance + description: Required. Repeated tool parameter key value match instances. + type: array + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchSpec' + description: Required. Spec for tool parameter key value match metric. + description: Input for tool parameter key value match metric. + type: object + id: GoogleCloudAiplatformV1ToolParameterKVMatchInput + GoogleCloudAiplatformV1SchemaAnnotationSpecColor: + properties: + displayName: + type: string description: >- - Required. Full resource name of automl Model. Format: - `projects/{project}/locations/{location}/models/{model}`. + The display name of the AnnotationSpec represented by the color in + the segmentation mask. + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: The color of the AnnotationSpec in a segmentation mask. + id: type: string - modelDisplayName: + description: >- + The ID of the AnnotationSpec represented by the color in the + segmentation mask. + description: >- + An entry of mapping between color and AnnotationSpec. The mapping is + used in segmentation mask. + id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor + type: object + GoogleCloudAiplatformV1EnvVar: + id: GoogleCloudAiplatformV1EnvVar + description: >- + Represents an environment variable present in a Container or Python + Module. + properties: + value: + description: >- + Required. Variables that reference a $(VAR_NAME) are expanded using + the previous defined environment variables in the container and any + service environment variables. If a variable cannot be resolved, the + reference in the input string will be unchanged. The $(VAR_NAME) + syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped + references will never be expanded, regardless of whether the + variable exists or not. type: string + name: description: >- - Optional. Display name of the model in Vertex AI. System will pick a - display name if unspecified. + Required. Name of the environment variable. Must be a valid C + identifier. + type: string type: object - GoogleCloudAiplatformV1DatasetStats: + GoogleCloudAiplatformV1Blob: properties: - totalTuningCharacterCount: + mimeType: type: string - format: int64 - readOnly: true - description: Output only. Number of tuning characters in the tuning dataset. - totalBillableCharacterCount: - format: int64 + description: Required. The IANA standard MIME type of the source data. + data: type: string - readOnly: true - description: Output only. Number of billable characters in the tuning dataset. - tuningStepCount: + description: Required. Raw bytes. + format: byte + description: >- + Content blob. It's preferred to send as text directly rather than raw + bytes. + id: GoogleCloudAiplatformV1Blob + type: object + GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata: + description: Details of operations that perform MetadataService.CreateMetadataStore. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for creating a MetadataStore. + type: object + id: GoogleCloudAiplatformV1CreateMetadataStoreOperationMetadata + GoogleCloudAiplatformV1ExportDataOperationMetadata: + properties: + gcsOutputDirectory: + type: string + description: >- + A Google Cloud Storage directory which path ends with '/'. The + exported data is stored in the directory. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + id: GoogleCloudAiplatformV1ExportDataOperationMetadata + type: object + description: Runtime operation information for DatasetService.ExportData. + GoogleCloudAiplatformV1SummarizationVerbositySpec: + id: GoogleCloudAiplatformV1SummarizationVerbositySpec + type: object + description: Spec for summarization verbosity score metric. + properties: + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + useReference: + type: boolean + description: >- + Optional. Whether to use instance.reference to compute summarization + verbosity. + GoogleCloudAiplatformV1ListSavedQueriesResponse: + description: Response message for DatasetService.ListSavedQueries. + type: object + properties: + savedQueries: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + description: >- + A list of SavedQueries that match the specified filter in the + request. + type: array + nextPageToken: + type: string + description: The standard List next-page token. + id: GoogleCloudAiplatformV1ListSavedQueriesResponse + GoogleCloudAiplatformV1ReadTensorboardSizeResponse: + properties: + storageSizeByte: + description: Payload storage size for the TensorBoard type: string format: int64 - description: Output only. Number of tuning steps for this Tuning Job. - readOnly: true - userInputTokenDistribution: - readOnly: true - description: Output only. Dataset distributions for the user input tokens. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' - tuningDatasetExampleCount: - format: int64 - description: Output only. Number of examples in the tuning dataset. - readOnly: true + description: Response message for TensorboardService.ReadTensorboardSize. + type: object + id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: + type: object + properties: + columnName: type: string - userMessagePerExampleDistribution: - description: Output only. Dataset distributions for the messages per example. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' - readOnly: true - userOutputTokenDistribution: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetDistribution' - description: Output only. Dataset distributions for the user output tokens. - readOnly: true - userDatasetExamples: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. + GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: + description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. + id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline: + properties: + predictionFormat: + enum: + - PREDICTION_FORMAT_UNSPECIFIED + - JSONL + - BIGQUERY + type: string + description: The storage format of the predictions generated BatchPrediction job. + enumDescriptions: + - Should not be set. + - Predictions are in JSONL files. + - Predictions are in BigQuery. + bigquery: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + description: BigQuery location for BatchExplain output. + gcs: + description: Cloud Storage location for BatchExplain output. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + type: object + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + description: >- + Output from BatchPredictionJob for Model Monitoring baseline dataset, + which can be used to generate baseline attribution scores. + GoogleCloudAiplatformV1SamplingStrategy: + properties: + randomSampleConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig + description: Random sample config. Will support more sampling strategies later. + id: GoogleCloudAiplatformV1SamplingStrategy + type: object + description: >- + Sampling Strategy for logging, can be for both training and prediction + dataset. + GoogleCloudAiplatformV1ToolParameterKeyMatchResults: + type: object + id: GoogleCloudAiplatformV1ToolParameterKeyMatchResults + properties: + toolParameterKeyMatchMetricValues: type: array + description: Output only. Tool parameter key match metric values. readOnly: true - description: Output only. Sample user messages in the training dataset uri. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchMetricValue + description: Results for tool parameter key match metric. + GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: + properties: + artifacts: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + type: array + description: Output only. A list of artifact metadata. + readOnly: true type: object - id: GoogleCloudAiplatformV1DatasetStats - description: Statistics computed over a tuning dataset. - GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest: + description: A list of artifact metadata. + id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList + GoogleCloudAiplatformV1EncryptionSpec: properties: - names: + kmsKeyName: + description: >- + Required. The Cloud KMS resource identifier of the customer managed + encryption key used to protect a resource. Has the form: + `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. + The key needs to be in the same region as where the compute resource + is created. + type: string + type: object + id: GoogleCloudAiplatformV1EncryptionSpec + description: >- + Represents a customer-managed encryption key spec that can be applied to + a top-level resource. + GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: + type: object + properties: + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + partialResults: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult description: >- - Required. The names of the PipelineJobs to cancel. A maximum of 32 - PipelineJobs can be cancelled in a batch. Format: - `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` + Partial results that reflect the latest migration operation + progress. type: array + id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + description: >- + Runtime operation information for + MigrationService.BatchMigrateResources. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting type: object - id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest - description: Request message for PipelineService.BatchCancelPipelineJobs. - GoogleCloudAiplatformV1FeatureValueDestination: + properties: + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata + description: The metadata information. + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs + CloudAiLargeModelsVisionNamedBoundingBox: + properties: + y1: + format: float + type: number + classes: + items: + type: string + type: array + x2: + format: float + type: number + entities: + type: array + items: + type: string + y2: + type: number + format: float + scores: + items: + format: float + type: number + type: array + x1: + type: number + format: float type: object - id: GoogleCloudAiplatformV1FeatureValueDestination - description: A destination location for Feature values and format. + id: CloudAiLargeModelsVisionNamedBoundingBox + GoogleCloudAiplatformV1FluencySpec: + id: GoogleCloudAiplatformV1FluencySpec + description: Spec for fluency score metric. properties: - tfrecordDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TFRecordDestination' - description: >- - Output in TFRecord format. Below are the mapping from Feature value - type in Featurestore to Feature value type in TFRecord: Value type - in Featurestore | Value type in TFRecord DOUBLE, DOUBLE_ARRAY | - FLOAT_LIST INT64, INT64_ARRAY | INT64_LIST STRING, STRING_ARRAY, - BYTES | BYTES_LIST true -> byte_string("true"), false -> - byte_string("false") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST - csvDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvDestination' - description: >- - Output in CSV format. Array Feature value types are not allowed in - CSV format. - bigqueryDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: >- - Output in BigQuery format. BigQueryDestination.output_uri in - FeatureValueDestination.bigquery_destination must refer to a table. - GoogleCloudAiplatformV1CancelTrainingPipelineRequest: + version: + type: integer + description: Optional. Which version to use for evaluation. + format: int32 type: object - id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest - description: Request message for PipelineService.CancelTrainingPipeline. - properties: {} - GoogleCloudAiplatformV1PublisherModelResourceReference: + GoogleCloudAiplatformV1SafetyRating: properties: - useCase: - type: string - deprecated: true - description: Use case (CUJ) of the resource. - resourceName: + severityScore: + format: float + description: Output only. Harm severity score. + readOnly: true + type: number + category: type: string - description: The resource name of the Google Cloud resource. - description: + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + readOnly: true + description: Output only. Harm category. + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + probabilityScore: + description: Output only. Harm probability score. + readOnly: true + format: float + type: number + blocked: + readOnly: true + description: >- + Output only. Indicates whether the content was filtered out because + of this rating. + type: boolean + severity: + readOnly: true + enum: + - HARM_SEVERITY_UNSPECIFIED + - HARM_SEVERITY_NEGLIGIBLE + - HARM_SEVERITY_LOW + - HARM_SEVERITY_MEDIUM + - HARM_SEVERITY_HIGH + enumDescriptions: + - Harm severity unspecified. + - Negligible level of harm severity. + - Low level of harm severity. + - Medium level of harm severity. + - High level of harm severity. type: string - deprecated: true - description: Description of the resource. - uri: - description: The URI of the resource. + description: Output only. Harm severity levels in the content. + probability: + description: Output only. Harm probability levels in the content. type: string - description: Reference to a resource. + enumDescriptions: + - Harm probability unspecified. + - Negligible level of harm. + - Low level of harm. + - Medium level of harm. + - High level of harm. + readOnly: true + enum: + - HARM_PROBABILITY_UNSPECIFIED + - NEGLIGIBLE + - LOW + - MEDIUM + - HIGH + description: Safety rating corresponding to the generated content. type: object - id: GoogleCloudAiplatformV1PublisherModelResourceReference + id: GoogleCloudAiplatformV1SafetyRating GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult: - description: Prediction output format for Tabular Regression. type: object + description: Prediction output format for Tabular Regression. id: >- GoogleCloudAiplatformV1SchemaPredictPredictionTabularRegressionPredictionResult properties: + quantilePredictions: + description: Quantile predictions, in 1-1 correspondence with quantile_values. + items: + type: number + format: float + type: array upperBound: description: The upper bound of the prediction interval. format: float @@ -6868,1046 +7771,695 @@ components: type: number description: The lower bound of the prediction interval. format: float + value: + format: float + type: number + description: The regression value. quantileValues: - description: Quantile values. items: type: number format: float type: array - quantilePredictions: - type: array - items: - type: number - format: float - description: Quantile predictions, in 1-1 correspondence with quantile_values. - value: - description: The regression value. - type: number - format: float - GoogleCloudAiplatformV1SchemaPredictionResult: - description: Represents a line of JSONL in the batch prediction output file. - id: GoogleCloudAiplatformV1SchemaPredictionResult + description: Quantile values. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics type: object properties: - instance: - additionalProperties: - description: Properties of the object. - type: any - type: object + rootMeanSquaredLogError: description: >- - User's input instance. Struct is used here instead of Any so that - JsonFormat does not append an extra "@type" field when we convert - the proto to JSON. - key: - type: string - description: Optional user-provided key from the input instance. - error: - description: The error result. Do not set prediction if this is set. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictionResultError - prediction: + Root mean squared log error. Undefined when there are negative + ground truth values or predictions. + format: float + type: number + meanAbsolutePercentageError: + format: float description: >- - The prediction result. Value is used here instead of Any so that - JsonFormat does not append an extra "@type" field when we convert - the proto to JSON and so we can represent array of objects. Do not - set error if this is set. - type: any - GoogleCloudAiplatformV1CreateTensorboardRunRequest: - description: Request message for TensorboardService.CreateTensorboardRun. + Mean absolute percentage error. Infinity when there are zeros in the + ground truth. + type: number + meanAbsoluteError: + type: number + description: Mean Absolute Error (MAE). + format: float + rSquared: + description: >- + Coefficient of determination as Pearson correlation coefficient. + Undefined when ground truth or predictions are constant or near + constant. + type: number + format: float + rootMeanSquaredError: + description: Root Mean Squared Error (RMSE). + format: float + type: number + description: Metrics for regression evaluation results. + GoogleCloudAiplatformV1Execution: + id: GoogleCloudAiplatformV1Execution type: object - id: GoogleCloudAiplatformV1CreateTensorboardRunRequest properties: - parent: + name: type: string - description: >- - Required. The resource name of the TensorboardExperiment to create - the TensorboardRun in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - tensorboardRunId: + description: Output only. The resource name of the Execution. + readOnly: true + description: + type: string + description: Description of the Execution + state: type: string + enum: + - STATE_UNSPECIFIED + - NEW + - RUNNING + - COMPLETE + - FAILED + - CACHED + - CANCELLED + enumDescriptions: + - Unspecified Execution state + - The Execution is new + - The Execution is running + - The Execution has finished running + - The Execution has failed + - The Execution completed through Cache hit. + - The Execution was cancelled. description: >- - Required. The ID to use for the Tensorboard run, which becomes the - final component of the Tensorboard run's resource name. This value - should be 1-128 characters, and valid characters are `/a-z-/`. - tensorboardRun: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - description: Required. The TensorboardRun to create. - GoogleCloudAiplatformV1PurgeContextsMetadata: + The state of this Execution. This is a property of the Execution, + and does not imply or capture any ongoing process. This property is + managed by clients (such as Vertex AI Pipelines) and the system does + not prescribe or check the validity of state transitions. + labels: + additionalProperties: + type: string + type: object + description: >- + The labels with user-defined metadata to organize your Executions. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Execution + (System labels are excluded). + createTime: + type: string + format: google-datetime + description: Output only. Timestamp when this Execution was created. + readOnly: true + displayName: + description: >- + User provided display name of the Execution. May be up to 128 + Unicode characters. + type: string + schemaVersion: + description: >- + The version of the schema in `schema_title` to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + type: string + schemaTitle: + description: >- + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + type: string + etag: + type: string + description: >- + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + updateTime: + format: google-datetime + readOnly: true + description: Output only. Timestamp when this Execution was last updated. + type: string + metadata: + description: >- + Properties of the Execution. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + type: object + additionalProperties: + description: Properties of the object. + type: any + description: Instance of a general execution. + CloudAiLargeModelsVisionMedia: + type: object + properties: + video: + $ref: '#/components/schemas/CloudAiLargeModelsVisionVideo' + description: Video + image: + $ref: '#/components/schemas/CloudAiLargeModelsVisionImage' + description: Image. + description: Media. + id: CloudAiLargeModelsVisionMedia + GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeatureOnlineStoreOperationMetadata + description: Details of operations that perform create FeatureOnlineStore. + type: object properties: genericMetadata: - description: Operation metadata for purging Contexts. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - type: object - description: Details of operations that perform MetadataService.PurgeContexts. - id: GoogleCloudAiplatformV1PurgeContextsMetadata - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: - type: object - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + description: Operation metadata for FeatureOnlineStore. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs properties: - inputs: - description: The input parameters of this TrainingJob. + enableProbabilisticInference: + description: >- + If probabilistic inference is enabled, the model will fit a + distribution that captures the uncertainty of a prediction. At + inference time, the predictive distribution is used to make a point + prediction that minimizes the optimization objective. For example, + the mean of a predictive distribution is the point prediction that + minimizes RMSE loss. If quantiles are specified, then the quantiles + of the distribution are also returned. The optimization objective + cannot be minimize-quantile-loss. + type: boolean + exportEvaluatedDataItemsConfig: + description: >- + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs - metadata: + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + dataGranularity: + description: Expected difference in time granularity between rows in the data. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata - description: The metadata information. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting - GoogleCloudAiplatformV1InputDataConfig: - type: object - properties: - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + quantiles: description: >- - The Cloud Storage location where the training data is to be written - to. In the given directory a new directory is created with name: - `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 - format. All training input data is written into that directory. The - Vertex AI environment variables representing Cloud Storage data URIs - are represented in the Cloud Storage wildcard format to support - sharded data. e.g.: "gs://.../training-*.jsonl" * AIP_DATA_FORMAT = - "jsonl" for non-tabular data, "csv" for tabular data * - AIP_TRAINING_DATA_URI = - "gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}" * - AIP_VALIDATION_DATA_URI = - "gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}" * - AIP_TEST_DATA_URI = - "gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}" - annotationSchemaUri: + Quantiles to use for minimize-quantile-loss + `optimization_objective`, or for probabilistic inference. Up to 5 + quantiles are allowed of values between 0 and 1, exclusive. Required + if the value of optimization_objective is minimize-quantile-loss. + Represents the percent quantiles to use for that objective. + Quantiles must be unique. + items: + format: double + type: number + type: array + timeColumn: + type: string description: >- - Applicable only to custom training with Datasets that have DataItems - and Annotations. Cloud Storage URI that points to a YAML file - describing the annotation schema. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that - the chosen schema must be consistent with metadata of the Dataset - specified by dataset_id. Only Annotations that both match this - schema and belong to DataItems not ignored by the split method are - used in respectively training, validation or test role, depending on - the role of the DataItem they are on. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both annotations_filter and annotation_schema_uri. + The name of the column that identifies time order in the time + series. This column must be available at forecast. + validationOptions: type: string - persistMlUseAssignment: - type: boolean - description: Whether to persist the ML use assignment to data item system labels. - savedQueryId: + description: >- + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + windowConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + trainBudgetMilliNodeHours: + format: int64 + description: >- + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. type: string + unavailableAtForecastColumns: + type: array description: >- - Only applicable to Datasets that have SavedQueries. The ID of a - SavedQuery (annotation set) under the Dataset specified by - dataset_id used for filtering Annotations for training. Only - Annotations that are associated with this SavedQuery are used in - respectively training. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both saved_query_id and annotations_filter. Only one of - saved_query_id and annotation_schema_uri should be specified as both - of them represent the same thing: problem type. - annotationsFilter: + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. + items: + type: string + contextWindow: + type: string description: >- - Applicable only to Datasets that have DataItems and Annotations. A - filter on Annotations of the Dataset. Only Annotations that both - match this filter and belong to DataItems not ignored by the split - method are used in respectively training, validation or test role, - depending on the role of the DataItem they are on (for the - auto-assigned that role is decided by Vertex AI). A filter with same - syntax as the one used in ListAnnotations may be used, but note here - it filters across all Annotations of the Dataset, and not just - within a single DataItem. + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. + format: int64 + forecastHorizon: + format: int64 type: string - filterSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' - description: Split based on the provided filters for each set. - fractionSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' - description: Split based on fractions defining the size of each set. - datasetId: + description: >- + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + availableAtForecastColumns: + type: array + description: >- + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + items: + type: string + targetColumn: type: string description: >- - Required. The ID of the Dataset in the same Project and Location - which data will be used to train the Model. The Dataset must use - schema compatible with Model being trained, and what is compatible - should be described in the used TrainingPipeline's - training_task_definition. For tabular Datasets, all their data is - exported to training, to pick and choose from. - timestampSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + optimizationObjective: + type: string description: >- - Supported only for tabular Datasets. Split based on the timestamp of - the input data pieces. - predefinedSplit: + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. + type: string + hierarchyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig description: >- - Supported only for tabular Datasets. Split based on a predefined - key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' - stratifiedSplit: + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + additionalExperiments: + items: + type: string + type: array + description: Additional experiment flags for the time series forcasting training. + timeSeriesAttributeColumns: + items: + type: string description: >- - Supported only for tabular Datasets. Split based on the distribution - of the specified column. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' - bigqueryDestination: + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. + type: array + holidayRegions: description: >- - Only applicable to custom training with tabular Dataset with - BigQuery source. The BigQuery project location where the training - data is to be written to. In the given project a new dataset is - created with name `dataset___` where timestamp is in - YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written - into that dataset. In the dataset three tables are created, - `training`, `validation` and `test`. * AIP_DATA_FORMAT = "bigquery". - * AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" - * AIP_VALIDATION_DATA_URI = - "bigquery_destination.dataset___.validation" * AIP_TEST_DATA_URI = - "bigquery_destination.dataset___.test" - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: >- - Specifies Vertex AI owned input data to be used for training, and - possibly evaluating, the Model. - id: GoogleCloudAiplatformV1InputDataConfig - GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: - type: object - description: Response message for FeaturestoreService.BatchReadFeatureValues. - id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse - properties: {} - GoogleCloudAiplatformV1PublisherModelCallToAction: - description: Actions could take on this Publisher Model. + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. + items: + type: string + type: array + transformations: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation + description: >- + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. + type: array + weightColumn: + type: string + description: >- + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. type: object + GoogleCloudAiplatformV1RayLogsSpec: properties: - openGenie: - description: Optional. Open Genie / Playground. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - openNotebook: - description: Optional. Open notebook of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - requestAccess: - description: Optional. Request for access. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - openEvaluationPipeline: - description: Optional. Open evaluation pipeline of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - viewRestApi: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi - description: Optional. To view Rest API docs. - deployGke: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke - description: Optional. Deploy PublisherModel to Google Kubernetes Engine. - openFineTuningPipelines: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines - description: Optional. Open fine-tuning pipelines of the PublisherModel. - createApplication: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Optional. Create application using the PublisherModel. - openFineTuningPipeline: - description: Optional. Open fine-tuning pipeline of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - deploy: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy - description: Optional. Deploy the PublisherModel to Vertex Endpoint. - openNotebooks: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - description: Optional. Open notebooks of the PublisherModel. - openPromptTuningPipeline: - description: Optional. Open prompt-tuning pipeline of the PublisherModel. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - openGenerationAiStudio: - description: Optional. Open in Generation AI Studio. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - fineTune: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + disabled: description: >- - Optional. Fine tune the PublisherModel with the third-party model - tuning UI. - id: GoogleCloudAiplatformV1PublisherModelCallToAction - GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig: + Optional. Flag to disable the export of Ray OSS logs to Cloud + Logging. + type: boolean + type: object + description: Configuration for the Ray OSS Logs. + id: GoogleCloudAiplatformV1RayLogsSpec + GoogleCloudAiplatformV1ListTuningJobsResponse: type: object - id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig properties: - desiredMinSafeTrialsFraction: - type: number - format: double + tuningJobs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + description: List of TuningJobs in the requested page. + nextPageToken: + type: string description: >- - Desired minimum fraction of safe trials (over total number of - trials) that should be targeted by the algorithm at any time during - the study (best effort). This should be between 0.0 and 1.0 and a - value of 0.0 means that there is no minimum and an algorithm - proceeds without targeting any specific fraction. A value of 1.0 - means that the algorithm attempts to only Suggest safe Trials. - safetyThreshold: + A token to retrieve the next page of results. Pass to + ListTuningJobsRequest.page_token to obtain that page. + description: Response message for GenAiTuningService.ListTuningJobs + id: GoogleCloudAiplatformV1ListTuningJobsResponse + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec: + type: object + properties: + useReference: description: >- - Safety threshold (boundary value between safe and unsafe). NOTE that - if you leave SafetyMetricConfig unset, a default value of 0 will be - used. - format: double + Optional. Whether to use instance.reference to compute question + answering quality. + type: boolean + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + description: Spec for pairwise question answering quality score metric. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec + GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue: + properties: + score: + format: float type: number - description: >- - Used in safe optimization to specify threshold levels and risk - tolerance. - GoogleCloudAiplatformV1DeployedModelRef: - description: Points to a DeployedModel. - id: GoogleCloudAiplatformV1DeployedModelRef + readOnly: true + description: Output only. Tool parameter key value match score. type: object + description: Tool parameter key value match metric value for an instance. + id: GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: + description: Represents a polygon in image. properties: - endpoint: - description: Immutable. A resource name of an Endpoint. + annotationSpecId: + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. type: string - deployedModelId: - description: Immutable. An ID of a DeployedModel in the above Endpoint. + vertexes: + description: >- + The vertexes are connected one by one and the last vertex is + connected to the first one to represent a polygon. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' + displayName: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting: - type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs - description: The input parameters of this TrainingJob. - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation type: object - description: Feature name & value pair. - properties: - value: - description: Feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - name: - description: Feature short name. - type: string - GoogleCloudAiplatformV1SchemaAnnotationSpecColor: - description: >- - An entry of mapping between color and AnnotationSpec. The mapping is - used in segmentation mask. + GoogleCloudAiplatformV1FunctionDeclaration: + id: GoogleCloudAiplatformV1FunctionDeclaration type: object properties: - displayName: + response: description: >- - The display name of the AnnotationSpec represented by the color in - the segmentation mask. - type: string - color: - description: The color of the AnnotationSpec in a segmentation mask. - $ref: '#/components/schemas/GoogleTypeColor' - id: + Optional. Describes the output from this function in JSON Schema + format. Reflects the Open API 3.03 Response Object. The Schema + defines the type used for the response value of the function. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: >- + Optional. Describes the parameters to this function in JSON Schema + Object format. Reflects the Open API 3.03 Parameter Object. string + Key: the name of the parameter. Parameter names are case sensitive. + Schema Value: the Schema defining the type used for the parameter. + For function with no parameters, this can be left unset. Parameter + names must start with a letter or an underscore and must only + contain chars a-z, A-Z, 0-9, or underscores with a maximum length of + 64. Example with 1 required and 1 optional parameter: type: OBJECT + properties: param1: type: STRING param2: type: INTEGER required: - + param1 + name: + description: >- + Required. The name of the function to call. Must start with a letter + or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, + dots and dashes, with a maximum length of 64. type: string + description: description: >- - The ID of the AnnotationSpec represented by the color in the - segmentation mask. - id: GoogleCloudAiplatformV1SchemaAnnotationSpecColor - GoogleIamV1Policy: + Optional. Description and purpose of the function. Model uses it to + decide how and whether to call the function. + type: string + description: >- + Structured representation of a function declaration as defined by the + [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). + Included in this declaration are the function name and parameters. This + FunctionDeclaration is a representation of a block of code that can be + used as a `Tool` by the model and executed by the client. + GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature: type: object properties: - version: - format: int32 + sigma: + type: number + format: float description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - etag: - format: byte + This represents the standard deviation of the Gaussian kernel that + will be used to add noise to the feature prior to computing + gradients. Similar to noise_sigma but represents the noise added to + the current feature. Defaults to 0.1. + name: type: string description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - bindings: + The name of the input feature for which noise sigma is provided. The + features are defined in explanation metadata inputs. + id: GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + description: Noise sigma for a single feature. + GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider: + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + properties: + allowedIssuers: + type: array + items: + type: string description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. + A list of allowed JWT issuers. Each entry must be a valid Google + service account, in the following format: + `service-account-name@project-id.iam.gserviceaccount.com` + audiences: type: array items: - $ref: '#/components/schemas/GoogleIamV1Binding' - id: GoogleIamV1Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - GoogleCloudAiplatformV1StudySpecStudyStoppingConfig: + type: string + description: >- + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. + id: GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider type: object - description: >- - The configuration (stopping conditions) for automated stopping of a - Study. Conditions include trial budgets, time budgets, and convergence - detection. - id: GoogleCloudAiplatformV1StudySpecStudyStoppingConfig + GoogleCloudAiplatformV1ListTensorboardsResponse: properties: - maxNumTrials: - type: integer - format: int32 - description: If there are more than this many trials, stop the study. - minNumTrials: - description: >- - If there are fewer than this many COMPLETED trials, do not stop the - study. - type: integer - format: int32 - shouldStopAsap: - type: boolean - description: >- - If true, a Study enters STOPPING_ASAP whenever it would normally - enters STOPPING state. The bottom line is: set to true if you want - to interrupt on-going evaluations of Trials as soon as the study - stopping condition is met. (Please see Study.State documentation for - the source of truth). - maxDurationNoProgress: - description: >- - If the objective value has not improved for this much time, stop the - study. WARNING: Effective only for single-objective studies. - format: google-duration + nextPageToken: type: string - maxNumTrialsNoProgress: - description: >- - If the objective value has not improved for this many consecutive - trials, stop the study. WARNING: Effective only for single-objective - studies. - format: int32 - type: integer - minimumRuntimeConstraint: description: >- - Each "stopping rule" in this proto specifies an "if" condition. - Before Vizier would generate a new suggestion, it first checks each - specified stopping rule, from top to bottom in this list. Note that - the first few rules (e.g. minimum_runtime_constraint, - min_num_trials) will prevent other stopping rules from being - evaluated until they are met. For example, setting - `min_num_trials=5` and `always_stop_after= 1 hour` means that the - Study will ONLY stop after it has 5 COMPLETED trials, even if more - than an hour has passed since its creation. It follows the first - applicable rule (whose "if" condition is satisfied) to make a - stopping decision. If none of the specified rules are applicable, - then Vizier decides that the study should not stop. If Vizier - decides that the study should stop, the study enters STOPPING state - (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The - automatic study state transition happens precisely as described - above; that is, deleting trials or updating StudyConfig NEVER - automatically moves the study state back to ACTIVE. If you want to - _resume_ a Study that was stopped, 1) change the stopping conditions - if necessary, 2) activate the study, and then 3) ask for - suggestions. If the specified time or duration has not passed, do - not stop the study. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' - maximumRuntimeConstraint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudyTimeConstraint' - description: If the specified time or duration has passed, stop the study. - GoogleCloudAiplatformV1FeatureStatsAnomaly: + A token, which can be sent as ListTensorboardsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + tensorboards: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + description: The Tensorboards mathching the request. + type: array + type: object + description: Response message for TensorboardService.ListTensorboards. + id: GoogleCloudAiplatformV1ListTensorboardsResponse + GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource: properties: - score: - type: number - format: double - description: >- - Feature importance score, only populated when cross-feature - monitoring is enabled. For now only used to represent feature - attribution score within range [0, 1] for - ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and - ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT. - distributionDeviation: - type: number - description: >- - Deviation from the current stats to baseline stats. 1. For - categorical feature, the distribution distance is calculated by - L-inifinity norm. 2. For numerical feature, the distribution - distance is calculated by Jensen–Shannon divergence. - format: double - startTime: - description: >- - The start timestamp of window where stats were generated. For - objectives where time window doesn't make sense (e.g. Featurestore - Snapshot Monitoring), start_time is only used to indicate the - monitoring intervals, so it always equals to (end_time - - monitoring_interval). - format: google-datetime + content: + format: byte + description: The base64-encoded contents of the input notebook file. type: string - statsUri: - description: >- - Path of the stats file for current feature values in Cloud Storage - bucket. Format: gs:////stats. Example: - gs://monitoring_bucket/feature_name/stats. Stats are stored as - binary format with Protobuf message - [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto). + id: GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource + type: object + description: The content of the input notebook in ipynb format. + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance: + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoClassificationPredictionInstance + description: Prediction input format for Video Classification. + properties: + timeSegmentStart: type: string - endTime: + description: >- + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. + content: type: string description: >- - The end timestamp of window where stats were generated. For - objectives where time window doesn't make sense (e.g. Featurestore - Snapshot Monitoring), end_time indicates the timestamp of the data - used to generate stats (e.g. timestamp we take snapshots for feature - values). - format: google-datetime - anomalyDetectionThreshold: - format: double - type: number + The Google Cloud Storage location of the video on which to perform + the prediction. + timeSegmentEnd: description: >- - This is the threshold used when detecting anomalies. The threshold - can be changed by user, so this one might be different from - ThresholdConfig.value. - anomalyUri: + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. type: string + mimeType: description: >- - Path of the anomaly file for current feature values in Cloud Storage - bucket. Format: gs:////anomalies. Example: - gs://monitoring_bucket/feature_name/anomalies. Stats are stored as - binary format with Protobuf message Anoamlies are stored as binary - format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] - (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto). - description: >- - Stats and Anomaly generated at specific timestamp for specific Feature. - The start_time and end_time are used to define the time range of the - dataset that current stats belongs to, e.g. prediction traffic is - bucketed into prediction datasets by time window. If the Dataset is not - defined by time window, start_time = end_time. Timestamp of the stats - and anomalies always refers to end_time. Raw stats and anomalies are - stored in stats_uri or anomaly_uri in the tensorflow defined protos. - Field data_stats contains almost identical information with the raw - stats in Vertex AI defined proto, for UI to display. + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime + type: string type: object - id: GoogleCloudAiplatformV1FeatureStatsAnomaly - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + description: The configuration for grounding checking. type: object - id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig properties: - scaling: - description: >- - Online serving scaling configuration. Only one of `fixed_node_count` - and `scaling` can be set. Setting one will reset the other. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling - fixedNodeCount: - format: int32 - type: integer + sources: + description: The sources for the grounding checking. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + disableAttribution: description: >- - The number of nodes for the online store. The number of nodes - doesn't scale automatically, but you can manually update the number - of nodes. If set to 0, the featurestore will not have an online - store and cannot be used for online serving. - description: >- - OnlineServingConfig specifies the details for provisioning online - serving resources. - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: - description: Prediction input format for Text Sentiment. + If set, skip finding claim attributions (i.e not generate grounding + citation). + type: boolean + deprecated: true + GoogleCloudAiplatformV1SuggestTrialsResponse: type: object properties: - content: + studyState: + type: string + enumDescriptions: + - The study state is unspecified. + - The study is active. + - The study is stopped due to an internal error. + - >- + The study is done when the service exhausts the parameter search + space or max_trial_count is reached. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - INACTIVE + - COMPLETED + description: The state of the Study. + startTime: + format: google-datetime + type: string + description: The time at which the operation was started. + endTime: + description: The time at which operation processing completed. + format: google-datetime type: string + trials: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + description: A list of Trials. + id: GoogleCloudAiplatformV1SuggestTrialsResponse + description: Response message for VizierService.SuggestTrials. + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance + type: object + properties: + content: description: The text snippet to make the predictions on. - mimeType: type: string + mimeType: description: >- The MIME type of the text snippet. The supported MIME types are listed below. - text/plain + type: string + description: Prediction input format for Text Classification. + GoogleCloudAiplatformV1ToolCallValidInstance: + properties: + reference: + type: string + description: Required. Ground truth used to compare against the prediction. + prediction: + type: string + description: Required. Output of the evaluated model. + description: Spec for tool call valid instance. + id: GoogleCloudAiplatformV1ToolCallValidInstance + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification: + description: >- + A TrainingJob that trains and uploads an AutoML Video Classification + Model. + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + description: The input parameters of this TrainingJob. id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance - GoogleCloudAiplatformV1DeployedIndexRef: - id: GoogleCloudAiplatformV1DeployedIndexRef + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassification + type: object + GoogleCloudAiplatformV1SummarizationQualityInstance: + description: Spec for summarization quality instance. + type: object + id: GoogleCloudAiplatformV1SummarizationQualityInstance properties: - deployedIndexId: - description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. + instruction: type: string - displayName: - readOnly: true + description: Required. Summarization prompt for LLM. + reference: type: string - description: Output only. The display name of the DeployedIndex. - indexEndpoint: + description: Optional. Ground truth used to compare against the prediction. + context: + description: Required. Text to be summarized. type: string - description: Immutable. A resource name of the IndexEndpoint. - description: Points to a DeployedIndex. - type: object - GoogleCloudAiplatformV1DeployIndexResponse: + prediction: + description: Required. Output of the evaluated model. + type: string + GoogleCloudAiplatformV1TuningDataStats: + id: GoogleCloudAiplatformV1TuningDataStats properties: - deployedIndex: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - description: The DeployedIndex that had been deployed in the IndexEndpoint. - id: GoogleCloudAiplatformV1DeployIndexResponse + supervisedTuningDataStats: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats + description: The SFT Tuning data stats. type: object - description: Response message for IndexEndpointService.DeployIndex. - GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: - id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors + description: The tuning data statistic values for TuningJob. + GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: properties: - neighbors: + requests: type: array - description: All its neighbors. + description: >- + Required. The request message specifying the TensorboardTimeSeries + to create. A maximum of 1000 TensorboardTimeSeries can be created in + a batch. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor - id: - description: The ID of the query datapoint. - type: string - description: Nearest neighbors for one query. + #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest + id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest type: object - GoogleCloudAiplatformV1IndexEndpoint: - id: GoogleCloudAiplatformV1IndexEndpoint - description: >- - Indexes are deployed into it. An IndexEndpoint can have multiple - DeployedIndexes. + description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. + GoogleCloudAiplatformV1RemoveDatapointsResponse: + properties: {} + description: Response message for IndexService.RemoveDatapoints + id: GoogleCloudAiplatformV1RemoveDatapointsResponse + type: object + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: + type: object + description: Prediction input format for Image Classification. properties: - name: - readOnly: true - description: Output only. The resource name of the IndexEndpoint. + content: type: string - publicEndpointDomainName: - description: >- - Output only. If public_endpoint_enabled is true, this field will be - populated with the domain name to use for this index endpoint. + description: The image bytes or Cloud Storage URI to make the prediction on. + mimeType: type: string - readOnly: true - publicEndpointEnabled: - type: boolean description: >- - Optional. If true, the deployed index will be accessible through - public endpoint. - createTime: - type: string - readOnly: true - description: Output only. Timestamp when this IndexEndpoint was created. - format: google-datetime - updateTime: - format: google-datetime - type: string - readOnly: true - description: >- - Output only. Timestamp when this IndexEndpoint was last updated. - This timestamp is not updated when the endpoint's DeployedIndexes - are updated, e.g. due to updates of the original Indexes they are - the deployments of. - labels: - type: object - description: >- - The labels with user-defined metadata to organize your - IndexEndpoints. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - additionalProperties: - type: string - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - deployedIndexes: - description: Output only. The indexes deployed in this endpoint. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - displayName: - description: >- - Required. The display name of the IndexEndpoint. The name can be up - to 128 characters long and can consist of any UTF-8 characters. - type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Immutable. Customer-managed encryption key spec for an - IndexEndpoint. If set, this IndexEndpoint and all sub-resources of - this IndexEndpoint will be secured by this key. - enablePrivateServiceConnect: - type: boolean - description: >- - Optional. Deprecated: If true, expose the IndexEndpoint via private - service connect. Only one of the fields, network or - enable_private_service_connect, can be set. - deprecated: true - privateServiceConnectConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig - description: >- - Optional. Configuration for private service connect. network and - private_service_connect_config are mutually exclusive. - description: - type: string - description: The description of the IndexEndpoint. - network: - description: >- - Optional. The full name of the Google Compute Engine - [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) - to which the IndexEndpoint should be peered. Private services access - must already be configured for the network. If left unspecified, the - Endpoint is not peered with any network. network and - private_service_connect_config are mutually exclusive. - [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - `projects/{project}/global/networks/{network}`. Where {project} is a - project number, as in '12345', and {network} is network name. - type: string - type: object - GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse - description: Response message for TensorboardService.WriteTensorboardExperimentData. - properties: {} - type: object - GoogleCloudAiplatformV1ListOptimalTrialsResponse: - id: GoogleCloudAiplatformV1ListOptimalTrialsResponse - properties: - optimalTrials: - description: >- - The pareto-optimal Trials for multiple objective Study or the - optimal trial for single objective Study. The definition of - pareto-optimal can be checked in wiki page. - https://en.wikipedia.org/wiki/Pareto_efficiency - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - type: array - type: object - description: Response message for VizierService.ListOptimalTrials. - GoogleCloudAiplatformV1SafetyRating: - id: GoogleCloudAiplatformV1SafetyRating - properties: - severityScore: - type: number - readOnly: true - description: Output only. Harm severity score. - format: float - category: - description: Output only. Harm category. - enumDescriptions: - - The harm category is unspecified. - - The harm category is hate speech. - - The harm category is dangerous content. - - The harm category is harassment. - - The harm category is sexually explicit content. - enum: - - HARM_CATEGORY_UNSPECIFIED - - HARM_CATEGORY_HATE_SPEECH - - HARM_CATEGORY_DANGEROUS_CONTENT - - HARM_CATEGORY_HARASSMENT - - HARM_CATEGORY_SEXUALLY_EXPLICIT - readOnly: true - type: string - probabilityScore: - format: float - type: number - readOnly: true - description: Output only. Harm probability score. - probability: - enum: - - HARM_PROBABILITY_UNSPECIFIED - - NEGLIGIBLE - - LOW - - MEDIUM - - HIGH - description: Output only. Harm probability levels in the content. - type: string - readOnly: true - enumDescriptions: - - Harm probability unspecified. - - Negligible level of harm. - - Low level of harm. - - Medium level of harm. - - High level of harm. - severity: - enumDescriptions: - - Harm severity unspecified. - - Negligible level of harm severity. - - Low level of harm severity. - - Medium level of harm severity. - - High level of harm severity. - type: string - enum: - - HARM_SEVERITY_UNSPECIFIED - - HARM_SEVERITY_NEGLIGIBLE - - HARM_SEVERITY_LOW - - HARM_SEVERITY_MEDIUM - - HARM_SEVERITY_HIGH - readOnly: true - description: Output only. Harm severity levels in the content. - blocked: - readOnly: true - description: >- - Output only. Indicates whether the content was filtered out because - of this rating. - type: boolean - type: object - description: Safety rating corresponding to the generated content. - GoogleCloudAiplatformV1WriteTensorboardRunDataRequest: - properties: - tensorboardRun: - type: string - description: >- - Required. The resource name of the TensorboardRun to write data to. - Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - timeSeriesData: - type: array - description: >- - Required. The TensorboardTimeSeries data to write. Values with in a - time series are indexed by their step value. Repeated writes to the - same step will overwrite the existing value for that step. The upper - limit of data points per write request is 5000. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - description: Request message for TensorboardService.WriteTensorboardRunData. - type: object - id: GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics - type: object - properties: - f1Score: - description: The harmonic mean of recall and precision. - type: number - format: float - precision: - description: Precision for the given confidence threshold. - type: number - format: float - recall: - format: float - description: Recall (True Positive Rate) for the given confidence threshold. - type: number - confidenceThreshold: - description: >- - Metrics are computed with an assumption that the Model never returns - predictions with score lower than this value. - type: number - format: float - GoogleCloudAiplatformV1TrainingConfig: - properties: - timeoutTrainingMilliHours: - format: int64 - description: >- - The timeout hours for the CMLE training job, expressed in milli - hours i.e. 1,000 value in this field means 1 hour. - type: string - description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained model - will be used by data sampling algorithm to select DataItems. - type: object - id: GoogleCloudAiplatformV1TrainingConfig - GoogleCloudAiplatformV1DirectPredictResponse: - properties: - outputs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: array - description: The prediction output. - parameters: - description: The parameters that govern the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - id: GoogleCloudAiplatformV1DirectPredictResponse - description: Response message for PredictionService.DirectPredict. - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: - properties: - rougeLSum: - type: number - description: ROUGE-L (Longest Common Subsequence) scoring at summary level. - format: float - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics - type: object - GoogleCloudAiplatformV1TensorboardTimeSeries: - properties: - pluginName: - type: string - description: >- - Immutable. Name of the plugin this time series pertain to. Such as - Scalar, Tensor, Blob - valueType: - enumDescriptions: - - The value type is unspecified. - - >- - Used for TensorboardTimeSeries that is a list of scalars. E.g. - accuracy of a model over epochs/time. - - >- - Used for TensorboardTimeSeries that is a list of tensors. E.g. - histograms of weights of layer in a model over epoch/time. - - >- - Used for TensorboardTimeSeries that is a list of blob sequences. - E.g. set of sample images with labels over epochs/time. - description: Required. Immutable. Type of TensorboardTimeSeries value. - type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - SCALAR - - TENSOR - - BLOB_SEQUENCE - displayName: - description: >- - Required. User provided name of this TensorboardTimeSeries. This - value should be unique among all TensorboardTimeSeries resources - belonging to the same TensorboardRun resource (parent resource). - type: string - createTime: - format: google-datetime - type: string - description: Output only. Timestamp when this TensorboardTimeSeries was created. - readOnly: true - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata - readOnly: true - description: >- - Output only. Scalar, Tensor, or Blob metadata for this - TensorboardTimeSeries. - pluginData: - type: string - description: Data of the current plugin, with the size limited to 65KB. - format: byte - etag: - type: string - description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - description: - description: Description of this TensorboardTimeSeries. - type: string - name: - type: string - description: Output only. Name of the TensorboardTimeSeries. - readOnly: true - updateTime: - type: string - format: google-datetime - description: >- - Output only. Timestamp when this TensorboardTimeSeries was last - updated. - readOnly: true - type: object - id: GoogleCloudAiplatformV1TensorboardTimeSeries - description: TensorboardTimeSeries maps to times series produced in training runs - GoogleCloudAiplatformV1SearchNearestEntitiesRequest: - type: object - description: The request message for FeatureOnlineStoreService.SearchNearestEntities. - properties: - returnFullEntity: - description: >- - Optional. If set to true, the full entities (including all vector - values and metadata) of the nearest neighbors are returned; - otherwise only entity id of the nearest neighbors will be returned. - Note that returning full entities will significantly increase the - latency and cost of the query. - type: boolean - query: - description: Required. The query. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighborQuery' - id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest - GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: - description: Metadata information for NotebookService.StartNotebookRuntime. - properties: - progressMessage: - type: string - description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata - type: object - GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks: - description: Open notebooks. - properties: - notebooks: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - description: Required. Regional resource references to notebooks. - type: array - type: object - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks - GoogleCloudAiplatformV1SyncFeatureViewRequest: - type: object - id: GoogleCloudAiplatformV1SyncFeatureViewRequest - description: Request message for FeatureOnlineStoreAdminService.SyncFeatureView. - properties: {} - GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: - type: object - properties: - timeSeriesData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' - description: The returned time series data. - id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse - description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. - GoogleCloudAiplatformV1SuggestTrialsRequest: - id: GoogleCloudAiplatformV1SuggestTrialsRequest - description: Request message for VizierService.SuggestTrials. - properties: - suggestionCount: - type: integer - format: int32 - description: Required. The number of suggestions requested. It must be positive. - clientId: + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/gif - + image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance + GoogleCloudAiplatformV1SuggestTrialsRequest: + type: object + id: GoogleCloudAiplatformV1SuggestTrialsRequest + properties: + clientId: type: string description: >- Required. The identifier of the client that is requesting the @@ -7916,6 +8468,9 @@ components: if the Trial is pending, and provide a new Trial if the last suggested Trial was completed. contexts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' description: >- Optional. This allows you to specify the "context" for a Trial; a context is a slice (a subspace) of the search space. Typical uses @@ -7947,965 +8502,732 @@ components: Generation of suggestions involves a match between a Context and (optionally) a REQUESTED trial; if that match is not fully specified, a suggestion will be geneated in the merged subspace. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialContext' - type: object - GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + suggestionCount: + type: integer + format: int32 + description: Required. The number of suggestions requested. It must be positive. + description: Request message for VizierService.SuggestTrials. + GoogleCloudAiplatformV1FindNeighborsResponse: + id: GoogleCloudAiplatformV1FindNeighborsResponse properties: - requests: - description: >- - Required. The request message specifying the TensorboardRuns to - create. A maximum of 1000 TensorboardRuns can be created in a batch. + nearestNeighbors: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardRunRequest + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors type: array - description: Request message for TensorboardService.BatchCreateTensorboardRuns. - type: object - GoogleCloudAiplatformV1RemoveDatapointsResponse: - properties: {} - description: Response message for IndexService.RemoveDatapoints - id: GoogleCloudAiplatformV1RemoveDatapointsResponse + description: The nearest neighbors of the query datapoints. type: object - GoogleTypeDate: + description: The response message for MatchService.FindNeighbors. + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec: + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec + description: Spec for question answering correctness metric. type: object properties: - day: - type: integer - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. + version: + description: Optional. Which version to use for evaluation. format: int32 - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. type: integer - format: int32 - month: - format: int32 + useReference: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - id: GoogleTypeDate - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: - properties: - multiLabel: + Optional. Whether to use instance.reference to compute question + answering correctness. type: boolean - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs - GoogleCloudAiplatformV1MetadataStoreDataplexConfig: - id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig + GoogleCloudAiplatformV1SafetyInstance: properties: - enabledPipelinesLineage: - description: >- - Optional. Whether or not Data Lineage synchronization is enabled for - Vertex Pipelines. - type: boolean + prediction: + description: Required. Output of the evaluated model. + type: string + description: Spec for safety instance. type: object - description: Represents Dataplex integration settings. - GoogleCloudAiplatformV1UserActionReference: + id: GoogleCloudAiplatformV1SafetyInstance + GoogleTypeExpr: properties: - method: + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + description: type: string description: >- - The method name of the API RPC call. For example, - "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" - dataLabelingJob: + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + location: type: string description: >- - For API calls that start a LabelingJob. Resource name of the - LabelingJob. Format: - `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` - operation: + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + expression: type: string description: >- - For API calls that return a long running operation. Resource name of - the long running operation. Format: - `projects/{project}/locations/{location}/operations/{operation}` - id: GoogleCloudAiplatformV1UserActionReference - description: >- - References an API call. It contains more information about long running - operation and Jobs that are triggered by the API call. - type: object - GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata: - id: GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. + Textual representation of an expression in Common Expression + Language syntax. + id: GoogleTypeExpr type: object - description: Metadata information for NotebookService.CreateNotebookRuntimeTemplate. - GoogleCloudAiplatformV1CountTokensRequest: + 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. + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: + description: Represents the spec to match integer values from parent parameter. properties: - contents: + values: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: Required. Input content. + format: int64 + type: string type: array - model: description: >- - Required. The name of the publisher model requested to serve the - prediction. Format: - `projects/{project}/locations/{location}/publishers/*/models/*` - type: string + Required. Matches values of the parent parameter of 'INTEGER' type. + All values must lie in `integer_value_spec` of parent parameter. + type: object + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition + GoogleCloudAiplatformV1RougeInput: + properties: instances: type: array items: - type: any - description: >- - Required. The instances that are the input to token counting call. - Schema is identical to the prediction schema of the underlying - model. - id: GoogleCloudAiplatformV1CountTokensRequest - description: Request message for PredictionService.CountTokens. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInstance' + description: Required. Repeated rouge instances. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeSpec' + description: Required. Spec for rouge score metric. + description: Input for rouge metric. + id: GoogleCloudAiplatformV1RougeInput type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + GoogleCloudAiplatformV1FulfillmentInput: properties: - modelType: - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - MOBILE_VERSATILE_1 - - MOBILE_JETSON_VERSATILE_1 - - MOBILE_CORAL_VERSATILE_1 - enumDescriptions: - - Should not be set. - - >- - A model best tailored to be used within Google Cloud, and which c - annot be exported. Default. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a mobile or edge - device afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) to a Jetson - device afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as a - TensorFlow or TensorFlow Lite model and used on a Coral device - afterwards. - type: string - CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentSpec' + description: Required. Spec for fulfillment score metric. + instance: + description: Required. Fulfillment instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInstance' type: object - description: The properties for a detected entity from the rai signal. + id: GoogleCloudAiplatformV1FulfillmentInput + description: Input for fulfillment metric. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: properties: - score: - description: Confidence score of the label - type: number - format: float - mid: - description: MID of the label - type: string - boundingBox: - description: Bounding box of the label + inputs: $ref: >- - #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - description: - type: string - description: Description of the label - iouScore: - description: >- - The intersection ratio between the detection bounding box and the - mask. - type: number - format: float - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: - type: object - properties: - threshold: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - description: Threshold for anomaly detection. - trainingStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - description: Stats calculated for the Training Dataset. - featureDisplayName: - description: Display Name of the Feature. - type: string - predictionStats: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - description: >- - A list of historical stats generated by different time window's - Prediction Dataset. - type: array + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + description: The input parameters of this TrainingJob. + description: >- + A TrainingJob that trains and uploads an AutoML Video Action Recognition + Model. id: >- - GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - description: Historical Stats (and Anomalies) for a specific Feature. - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: - description: Prediction output format for Text Sentiment + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition type: object - properties: - sentiment: - format: int32 - description: >- - The integer sentiment labels between 0 (inclusive) and sentimentMax - label (inclusive), while 0 maps to the least positive sentiment and - sentimentMax maps to the most positive one. The higher the score is, - the more positive the sentiment in the text snippet is. Note: - sentimentMax is an integer value between 1 (inclusive) and 10 - (inclusive). - type: integer - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult - GoogleCloudAiplatformV1ListMetadataStoresResponse: - description: Response message for MetadataService.ListMetadataStores. - properties: - metadataStores: - description: The MetadataStores found for the Location. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' - nextPageToken: - type: string - description: >- - A token, which can be sent as ListMetadataStoresRequest.page_token - to retrieve the next page. If this field is not populated, there are - no subsequent pages. - id: GoogleCloudAiplatformV1ListMetadataStoresResponse + GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode: + description: >- + When automated routing is specified, the routing will be determined by + the pretrained routing model and customer provided model routing + preference. + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode type: object - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField: properties: - fieldName: + modelRoutingPreference: + description: The model routing preference. type: string - description: >- - Required. The name of the field in the CSV header or the name of the - column in BigQuery table. The naming restriction is the same as - Feature.name. - description: Describe pass-through fields in read_instance source. - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + enumDescriptions: + - Unspecified model routing preference. + - Prefer higher quality over low cost. + - Balanced model routing preference. + - Prefer lower cost over higher quality. + enum: + - UNKNOWN + - PRIORITIZE_QUALITY + - BALANCED + - PRIORITIZE_COST + GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest: + properties: {} + description: Request message for JobService.CancelHyperparameterTuningJob. type: object - GoogleCloudAiplatformV1CountTokensResponse: - description: Response message for PredictionService.CountTokens. + id: GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: properties: - totalBillableCharacters: - format: int32 - description: >- - The total number of billable characters counted across all instances - from the request. - type: integer - totalTokens: + specialistPool: description: >- - The total number of tokens counted across all instances from the - request. - type: integer - format: int32 - id: GoogleCloudAiplatformV1CountTokensResponse + Output only. The name of the SpecialistPool to which the specialists + are being added. Format: + `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` + type: string + readOnly: true + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. type: object - GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: + id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata + description: >- + Runtime operation metadata for + SpecialistPoolService.UpdateSpecialistPool. + GoogleCloudAiplatformV1ExactMatchInput: properties: - timeSeriesData: + metricSpec: + description: Required. Spec for exact match metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchSpec' + instances: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInstance' + description: Required. Repeated exact match instances. type: array - description: The returned time series data. - type: object - id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse - description: >- - Response message for - TensorboardService.BatchReadTensorboardTimeSeriesData. - GoogleCloudAiplatformV1ExplanationMetadataOverride: + description: Input for exact match metric. type: object - id: GoogleCloudAiplatformV1ExplanationMetadataOverride + id: GoogleCloudAiplatformV1ExactMatchInput + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: properties: inputs: - type: object - description: >- - Required. Overrides the input metadata of the features. The key is - the name of the feature to be overridden. The keys specified here - must exist in the input metadata to be overridden. If a feature is - not specified here, the corresponding feature's input metadata is - not overridden. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride - description: >- - The ExplanationMetadata entries that can be overridden at online - explanation time. - GoogleCloudAiplatformV1CsvDestination: - properties: - gcsDestination: - description: Required. Google Cloud Storage location. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: The storage details for CSV output content. - type: object - id: GoogleCloudAiplatformV1CsvDestination - GoogleCloudAiplatformV1ListPersistentResourcesResponse: - properties: - persistentResources: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' - nextPageToken: - type: string - description: >- - A token to retrieve next page of results. Pass to - ListPersistentResourcesRequest.page_token to obtain that page. - id: GoogleCloudAiplatformV1ListPersistentResourcesResponse - type: object - description: Response message for PersistentResourceService.ListPersistentResources - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs + description: The input parameters of this TrainingJob. + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams - properties: - maxPredictions: - description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. If this number is very high, the Model may - return fewer predictions. Default value is 10,000. - type: integer - format: int32 - segmentClassification: - type: boolean - description: >- - Set to true to request segment-level classification. Vertex AI - returns labels and their confidence scores for the entire time - segment of the video that user specified in the input instance. - Default value is true - confidenceThreshold: - format: float - type: number - description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - oneSecIntervalClassification: - description: >- - Set to true to request classification for a video at one-second - intervals. Vertex AI returns labels and their confidence scores for - each second of the entire time segment of the video that user - specified in the input WARNING: Model evaluation is not done for - this classification type, the quality of it depends on the training - data, but there are no metrics provided to describe that quality. - Default value is false - type: boolean - shotClassification: - description: >- - Set to true to request shot-level classification. Vertex AI - determines the boundaries for each camera shot in the entire time - segment of the video that user specified in the input instance. - Vertex AI then returns labels and their confidence scores for each - detected shot, along with the start and end time of the shot. - WARNING: Model evaluation is not done for this classification type, - the quality of it depends on the training data, but there are no - metrics provided to describe that quality. Default value is false - type: boolean - type: object - description: Prediction model parameters for Video Classification. - GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: - properties: - blobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' - description: Blob messages containing blob bytes. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation + description: >- + A TrainingJob that trains and uploads an AutoML Image Segmentation + Model. type: object - description: Response message for TensorboardService.ReadTensorboardBlobData. - id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse - GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies: - description: Statistics and anomalies generated by Model Monitoring. + GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: type: object + id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized + properties: {} + description: Optimized storage type + GoogleCloudAiplatformV1Annotation: + id: GoogleCloudAiplatformV1Annotation properties: - anomalyCount: - type: integer - format: int32 - description: Number of anomalies within all stats. - deployedModelId: - description: Deployed Model ID. - type: string - objective: - enum: - - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED - - RAW_FEATURE_SKEW - - RAW_FEATURE_DRIFT - - FEATURE_ATTRIBUTION_SKEW - - FEATURE_ATTRIBUTION_DRIFT - type: string - enumDescriptions: - - Default value, should not be set. - - >- - Raw feature values' stats to detect skew between - Training-Prediction datasets. - - >- - Raw feature values' stats to detect drift between - Serving-Prediction datasets. - - >- - Feature attribution scores to detect skew between - Training-Prediction datasets. - - >- - Feature attribution scores to detect skew between Prediction - datasets collected within different time windows. - description: Model Monitoring Objective those stats and anomalies belonging to. - featureStats: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies - description: A list of historical Stats and Anomalies generated for all Features. - type: array - id: GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource - properties: - uri: + payloadSchemaUri: type: string - description: The URI of a BigQuery table. - type: object - GoogleCloudAiplatformV1FeatureGroup: - type: object - description: Vertex AI Feature Group. - id: GoogleCloudAiplatformV1FeatureGroup - properties: - updateTime: - description: Output only. Timestamp when this FeatureGroup was last updated. + description: >- + Required. Google Cloud Storage URI points to a YAML file describing + payload. The schema is defined as an [OpenAPI 3.0.2 Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/, note that + the chosen schema must be consistent with the parent Dataset's + metadata. + annotationSource: + description: Output only. The source of the Annotation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' readOnly: true + createTime: format: google-datetime + readOnly: true type: string - description: - description: Optional. Description of the FeatureGroup. - type: string + description: Output only. Timestamp when this Annotation was created. etag: - type: string description: >- Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. - createTime: - description: Output only. Timestamp when this FeatureGroup was created. - format: google-datetime type: string - readOnly: true labels: additionalProperties: type: string + type: object description: >- Optional. The labels with user-defined metadata to organize your - FeatureGroup. Label keys and values can be no longer than 64 + Annotations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one FeatureGroup(System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - type: object - name: + are allowed. No more than 64 user labels can be associated with one + Annotation(System labels are excluded). See https://goo.gl/xmQnxf + for more information and examples of labels. System reserved label + keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. Following system labels exist for each Annotation: * + "aiplatform.googleapis.com/annotation_set_name": optional, name of + the UI's annotation set this Annotation belongs to. If not set, the + Annotation is not visible in the UI. * + "aiplatform.googleapis.com/payload_schema": output only, its value + is the payload_schema's title. + updateTime: + format: google-datetime + readOnly: true type: string - description: >- - Identifier. Name of the FeatureGroup. Format: - `projects/{project}/locations/{location}/featureGroups/{featureGroup}` - bigQuery: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQuery' - description: >- - Indicates that features for this group come from BigQuery - Table/View. By default treats the source as a sparse time series - source. The BigQuery source table or view must have at least one - entity ID column and a column named `feature_timestamp`. - GoogleCloudAiplatformV1UndeployModelRequest: - properties: - deployedModelId: + description: Output only. Timestamp when this Annotation was last updated. + name: type: string - description: >- - Required. The ID of the DeployedModel to be undeployed from the - Endpoint. - trafficSplit: - type: object - description: >- - If this field is provided, then the Endpoint's traffic_split will be - overwritten with it. If last DeployedModel is being undeployed from - the Endpoint, the [Endpoint.traffic_split] will always end up empty - when this call returns. A DeployedModel will be successfully - undeployed only if it doesn't have any traffic assigned to it when - this method executes, or if this field unassigns any traffic to it. - additionalProperties: - format: int32 - type: integer - description: Request message for EndpointService.UndeployModel. - id: GoogleCloudAiplatformV1UndeployModelRequest + readOnly: true + description: Output only. Resource name of the Annotation. + payload: + description: Required. The schema of the payload can be found in payload_schema. + type: any + description: >- + Used to assign specific AnnotationSpec to a particular area of a + DataItem or the whole part of the DataItem. type: object - GoogleCloudAiplatformV1Citation: + GoogleCloudAiplatformV1FulfillmentResult: properties: - endIndex: - format: int32 - readOnly: true - description: Output only. End index into the content. - type: integer - license: - description: Output only. License of the attribution. - type: string - readOnly: true - publicationDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: Output only. Publication date of the attribution. - readOnly: true - uri: - description: Output only. Url reference of the attribution. - type: string + score: + format: float + type: number + description: Output only. Fulfillment score. readOnly: true - startIndex: + explanation: readOnly: true - format: int32 - description: Output only. Start index into the content. - type: integer - title: - description: Output only. Title of the attribution. type: string + description: Output only. Explanation for fulfillment score. + confidence: readOnly: true - id: GoogleCloudAiplatformV1Citation - description: Source attributions for content. + format: float + description: Output only. Confidence for fulfillment score. + type: number + description: Spec for fulfillment result. + id: GoogleCloudAiplatformV1FulfillmentResult + type: object + GoogleCloudAiplatformV1ToolParameterKeyMatchInput: + description: Input for tool parameter key match metric. + id: GoogleCloudAiplatformV1ToolParameterKeyMatchInput type: object - GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse: properties: - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - deploymentResourcePools: + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchSpec + description: Required. Spec for tool parameter key match metric. + instances: + description: Required. Repeated tool parameter key match instances. + type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInstance + GoogleCloudAiplatformV1MergeVersionAliasesRequest: + id: GoogleCloudAiplatformV1MergeVersionAliasesRequest + description: Request message for ModelService.MergeVersionAliases. + properties: + versionAliases: type: array - description: The DeploymentResourcePools from the specified location. - id: GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse - type: object - description: Response message for ListDeploymentResourcePools method. - GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: - description: >- - A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats - requested by user, sorted by FeatureStatsAnomaly.start_time descending. - id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + description: >- + Required. The set of version aliases to merge. The alias should be + at most 128 characters, and match `a-z{0,126}[a-z-0-9]`. Add the `-` + prefix to an alias means removing that alias from the version. `-` + is NOT counted in the 128 characters. Example: `-golden` means + removing the `golden` alias from the version. There is NO ordering + in aliases, which means 1) The aliases returned from GetModel API + might not have the exactly same order from this MergeVersionAliases + API. 2) Adding and deleting the same alias in the request is not + recommended, and the 2 operations will be cancelled out. + items: + type: string type: object + GoogleCloudAiplatformV1TimeSeriesDataPoint: + id: GoogleCloudAiplatformV1TimeSeriesDataPoint properties: - featureStatsAnomaly: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' - description: >- - Output only. The stats and anomalies generated at specific - timestamp. - readOnly: true - objective: - readOnly: true - enumDescriptions: - - If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. - - Stats are generated by Import Feature Analysis. - - Stats are generated by Snapshot Analysis. + step: type: string - description: Output only. The objective for each stats. - enum: - - OBJECTIVE_UNSPECIFIED - - IMPORT_FEATURE_ANALYSIS - - SNAPSHOT_ANALYSIS - GoogleCloudAiplatformV1ExportFilterSplit: - description: >- - Assigns input data to training, validation, and test sets based on the - given filters, data pieces not matched by any filter are ignored. - Currently only supported for Datasets containing DataItems. If any of - the filters in this message are to match nothing, then they can be set - as '-' (the minus sign). Supported only for unstructured Datasets. + description: Step index of this data point within the run. + format: int64 + wallTime: + type: string + format: google-datetime + description: >- + Wall clock timestamp when this data point is generated by the end + user. + blobs: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlobSequence' + description: A blob sequence value. + scalar: + description: A scalar value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scalar' + tensor: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTensor' + description: A tensor value. type: object + description: A TensorboardTimeSeries data point. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask: + type: object + description: A TrainingJob that trains a custom code Model. properties: - trainingFilter: + inputs: + description: The input parameters of this CustomTask. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + metadata: + description: The metadata information. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomTask + GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: + properties: + textSegment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTextSegment' + description: The segment of the text content. + displayName: type: string description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to train the Model. A filter with same syntax - as the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - validationFilter: + The display name of the AnnotationSpec that this Annotation pertains + to. + annotationSpecId: type: string description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to validate the Model. A filter with same - syntax as the one used in DatasetService.ListDataItems may be used. - If a single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - testFilter: + The resource Id of the AnnotationSpec that this Annotation pertains + to. + id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation + type: object + description: Annotation details specific to text extraction. + GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec: + type: object + description: Value specification for a parameter in `INTEGER` type. + properties: + maxValue: type: string + format: int64 + description: Required. Inclusive maximum value of the parameter. + defaultValue: description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to test the Model. A filter with same syntax as - the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - id: GoogleCloudAiplatformV1ExportFilterSplit - GoogleCloudAiplatformV1SavedQuery: + A default value for an `INTEGER` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. + type: string + format: int64 + minValue: + description: Required. Inclusive minimum value of the parameter. + format: int64 + type: string + id: GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics: type: object - description: >- - A SavedQuery is a view of the dataset. It references a subset of - annotations by problem type and filters. properties: - displayName: + falsePositiveCount: + format: int64 description: >- - Required. The user-defined name of the SavedQuery. The name can be - up to 128 characters long and can consist of any UTF-8 characters. - type: string - updateTime: - format: google-datetime - description: Output only. Timestamp when SavedQuery was last updated. + The number of Model created labels that do not match a ground truth + label. type: string - readOnly: true - annotationFilter: + precisionAt1: + format: float + type: number + description: >- + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + DataItem. + confusionMatrix: + description: Confusion matrix of the evaluation for this confidence_threshold. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + trueNegativeCount: type: string - description: Output only. Filters on the Annotations in the dataset. - readOnly: true - etag: + format: int64 description: >- - Used to perform a consistent read-modify-write update. If not set, a - blind "overwrite" update happens. + The number of labels that were not created by the Model, but if they + would, they would not match a ground truth label. + falsePositiveRate: + description: False Positive Rate for the given confidence threshold. + type: number + format: float + f1ScoreMicro: + format: float + description: Micro-averaged F1 Score. + type: number + f1ScoreMacro: + type: number + description: Macro-averaged F1 Score. + format: float + truePositiveCount: + description: The number of Model created labels that match a ground truth label. + format: int64 type: string - metadata: - type: any - description: Some additional information about the SavedQuery. - name: + f1Score: + format: float + description: >- + The harmonic mean of recall and precision. For summary metrics, it + computes the micro-averaged F1 score. + type: number + f1ScoreAt1: + description: The harmonic mean of recallAt1 and precisionAt1. + format: float + type: number + recall: + description: Recall (True Positive Rate) for the given confidence threshold. + type: number + format: float + falseNegativeCount: type: string - readOnly: true - description: Output only. Resource name of the SavedQuery. - annotationSpecCount: - format: int32 - type: integer - readOnly: true description: >- - Output only. Number of AnnotationSpecs in the context of the - SavedQuery. - problemType: + The number of ground truth labels that are not matched by a Model + created label. + format: int64 + confidenceThreshold: + format: float description: >- - Required. Problem type of the SavedQuery. Allowed values: * - IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL - * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * - TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * - TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * - VIDEO_OBJECT_TRACKING - type: string - createTime: - type: string - description: Output only. Timestamp when this SavedQuery was created. - readOnly: true - format: google-datetime - supportAutomlTraining: - readOnly: true - type: boolean + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. + type: number + maxPredictions: description: >- - Output only. If the Annotations belonging to the SavedQuery can be - used for AutoML training. - id: GoogleCloudAiplatformV1SavedQuery - GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: - id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata - type: object - properties: - sentimentMax: + Metrics are computed with an assumption that the Model always + returns at most this many predictions (ordered by their score, + descendingly), but they all still need to meet the + `confidenceThreshold`. type: integer - description: The maximum sentiment of sentiment Anntoation in this SavedQuery. format: int32 - description: The metadata of SavedQuery contains TextSentiment Annotations. - GoogleCloudAiplatformV1TensorboardExperiment: - description: >- - A TensorboardExperiment is a group of TensorboardRuns, that are - typically the results of a training job run, in a Tensorboard. - id: GoogleCloudAiplatformV1TensorboardExperiment - properties: - etag: + falsePositiveRateAt1: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each DataItem. + format: float + type: number + precision: + description: Precision for the given confidence threshold. + format: float + type: number + recallAt1: + format: float + type: number + description: >- + The Recall (True Positive Rate) when only considering the label that + has the highest prediction score and not below the confidence + threshold for each DataItem. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics + GoogleCloudAiplatformV1SchemaTimeSegment: + properties: + startTimeOffset: type: string - source: + format: google-duration description: >- - Immutable. Source of the TensorboardExperiment. Example: a custom - training job. + Start of the time segment (inclusive), represented as the duration + since the start of the DataItem. + endTimeOffset: + format: google-duration + description: >- + End of the time segment (exclusive), represented as the duration + since the start of the DataItem. type: string - labels: - type: object + type: object + id: GoogleCloudAiplatformV1SchemaTimeSegment + description: >- + A time period inside of a DataItem that has a time dimension (e.g. + video). + GoogleCloudAiplatformV1ModelDataStats: + id: GoogleCloudAiplatformV1ModelDataStats + type: object + properties: + testAnnotationsCount: description: >- - The labels with user-defined metadata to organize your - TensorboardExperiment. Label keys and values cannot be longer than - 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. No more than 64 user labels can be - associated with one Dataset (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - `aiplatform.googleapis.com/` and are immutable. The following system - labels exist for each Dataset: * - `aiplatform.googleapis.com/dataset_metadata_schema`: output only. - Its value is the metadata_schema's title. - additionalProperties: - type: string - displayName: + Number of Annotations that are used for evaluating this Model. If + the Model is evaluated multiple times, this will be the number of + test Annotations used by the first evaluation. If the Model is not + evaluated, the number is 0. type: string - description: User provided name of this TensorboardExperiment. - createTime: - description: Output only. Timestamp when this TensorboardExperiment was created. - format: google-datetime + format: int64 + trainingAnnotationsCount: type: string - readOnly: true - updateTime: - format: google-datetime + description: Number of Annotations that are used for training this Model. + format: int64 + trainingDataItemsCount: + description: Number of DataItems that were used for training this Model. type: string - readOnly: true + format: int64 + testDataItemsCount: + format: int64 description: >- - Output only. Timestamp when this TensorboardExperiment was last - updated. - description: + Number of DataItems that were used for evaluating this Model. If the + Model is evaluated multiple times, this will be the number of test + DataItems used by the first evaluation. If the Model is not + evaluated, the number is 0. type: string - description: Description of this TensorboardExperiment. - name: + validationDataItemsCount: + format: int64 type: string description: >- - Output only. Name of the TensorboardExperiment. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - readOnly: true - type: object - GoogleCloudAiplatformV1ExportDataRequest: - id: GoogleCloudAiplatformV1ExportDataRequest - properties: - exportConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' - description: Required. The desired output location. - description: Request message for DatasetService.ExportData. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation: - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation - properties: - columnName: + Number of DataItems that were used for validating this Model during + training. + validationAnnotationsCount: + format: int64 + description: >- + Number of Annotations that are used for validating this Model during + training. type: string - GoogleCloudAiplatformV1ListEntityTypesResponse: - id: GoogleCloudAiplatformV1ListEntityTypesResponse + description: Stats of data used for train or evaluate the Model. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs: properties: - entityTypes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' - description: The EntityTypes matching the request. - nextPageToken: - description: >- - A token, which can be sent as ListEntityTypesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. + modelType: type: string - description: Response message for FeaturestoreService.ListEntityTypes. + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which c + annot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) to a Jetson + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a Coral device + afterwards. + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 + - MOBILE_CORAL_VERSATILE_1 type: object - GoogleCloudAiplatformV1MachineSpec: - description: Specification of a single machine. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs + GoogleCloudAiplatformV1ContainerRegistryDestination: + id: GoogleCloudAiplatformV1ContainerRegistryDestination type: object - id: GoogleCloudAiplatformV1MachineSpec + description: The Container Registry location for the container image. properties: - machineType: - type: string - description: >- - Immutable. The type of the machine. See the [list of machine types - supported for - prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) - See the [list of machine types supported for custom - training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). - For DeployedModel this field is optional, and the default value is - `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec - this field is required. - acceleratorType: - description: >- - Immutable. The type of accelerator(s) that may be attached to the - machine as per accelerator_count. - enum: - - ACCELERATOR_TYPE_UNSPECIFIED - - NVIDIA_TESLA_K80 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_V100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_L4 - - NVIDIA_H100_80GB - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD - enumDescriptions: - - Unspecified accelerator type, which means no accelerator. - - Nvidia Tesla K80 GPU. - - Nvidia Tesla P100 GPU. - - Nvidia Tesla V100 GPU. - - Nvidia Tesla P4 GPU. - - Nvidia Tesla T4 GPU. - - Nvidia Tesla A100 GPU. - - Nvidia A100 80GB GPU. - - Nvidia L4 GPU. - - Nvidia H100 80Gb GPU. - - TPU v2. - - TPU v3. - - TPU v4. - - TPU v5. - type: string - tpuTopology: + outputUri: type: string description: >- - Immutable. The topology of the TPUs. Corresponds to the TPU - topologies available from GKE. (Example: tpu_topology: "2x2x1"). - acceleratorCount: - type: integer - description: The number of accelerators to attach to the machine. - format: int32 - GoogleCloudAiplatformV1ResourcesConsumed: + Required. Container Registry URI of a container image. Only Google + Container Registry and Artifact Registry are supported now. Accepted + forms: * Google Container Registry path. For example: + `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For + example: + `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a + tag is not specified, "latest" will be used as the default tag. + GoogleCloudAiplatformV1RougeMetricValue: properties: - replicaHours: - description: >- - Output only. The number of replica hours used. Note that many - replicas may run in parallel, and additionally any given work may be - queued for some time. Therefore this value is not strictly related - to wall time. - readOnly: true + score: type: number - format: double + format: float + readOnly: true + description: Output only. Rouge score. type: object - id: GoogleCloudAiplatformV1ResourcesConsumed - description: Statistics information about resource consumption. - GoogleCloudAiplatformV1ExplanationSpecOverride: - id: GoogleCloudAiplatformV1ExplanationSpecOverride + description: Rouge metric value for an instance. + id: GoogleCloudAiplatformV1RougeMetricValue + GoogleCloudAiplatformV1CountTokensResponse: properties: - examplesOverride: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' - description: The example-based explanations parameter overrides. - parameters: + totalTokens: + type: integer description: >- - The parameters to be overridden. Note that the attribution method - cannot be changed. If not specified, no parameter is overridden. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' - metadata: + The total number of tokens counted across all instances from the + request. + format: int32 + totalBillableCharacters: description: >- - The metadata to be overridden. If not specified, no metadata is - overridden. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride - description: >- - The ExplanationSpec entries that can be overridden at online explanation - time. + The total number of billable characters counted across all instances + from the request. + format: int32 + type: integer + description: Response message for PredictionService.CountTokens. + id: GoogleCloudAiplatformV1CountTokensResponse type: object - GoogleCloudAiplatformV1TrialContext: - description: 'Next ID: 3' + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics: type: object + description: Metrics for a single confidence threshold. properties: - parameters: - type: array + precision: + description: Output only. Precision for the given confidence threshold. + type: number + format: float + confidenceThreshold: description: >- - If/when a Trial is generated or selected from this Context, its - Parameters will match any parameters specified here. (I.e. if this - context specifies parameter name:'a' int_value:3, then a resulting - Trial will have int_value:3 for its parameter named 'a'.) Note that - we first attempt to match existing REQUESTED Trials with contexts, - and if there are no matches, we generate suggestions in the subspace - defined by the parameters specified here. NOTE: a Context without - any Parameters matches the entire feasible search space. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' - description: - description: >- - A human-readable field which can store a description of this - context. This will become part of the resulting Trial's description - field. - type: string - id: GoogleCloudAiplatformV1TrialContext - GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: - description: Metadata for requested Features. - type: object - properties: - id: - description: Feature ID. - type: string - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: + Output only. The confidence threshold value used to compute the + metrics. + format: float + type: number + f1Score: + type: number + format: float + description: Output only. The harmonic mean of recall and precision. + recall: + format: float + type: number + description: Output only. Recall for the given confidence threshold. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics + GoogleCloudAiplatformV1ComputeTokensResponse: type: object properties: - quantity: - format: int64 - type: string - description: >- - The number of granularity_units between data points in the training - data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. - For all other values of `granularity_unit`, must be 1. - unit: + tokensInfo: + type: array description: >- - The time granularity unit of this time period. The supported units - are: * "minute" * "hour" * "day" * "week" * "month" * "year" - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity - description: A duration of time expressed in time granularity units. - GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for deleting a MetadataStore. - description: Details of operations that perform MetadataService.DeleteMetadataStore. - id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata - type: object - GoogleCloudAiplatformV1SearchEntryPoint: - type: object + Lists of tokens info from the input. A ComputeTokensRequest could + have multiple instances with a prompt in each instance. We also need + to return lists of tokens info for the request with multiple + instances. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TokensInfo' + description: Response message for ComputeTokens RPC call. + id: GoogleCloudAiplatformV1ComputeTokensResponse + GoogleCloudAiplatformV1SampleConfig: + description: >- + Active learning data sampling config. For every active learning labeling + iteration, it will select a batch of data based on the sampling + strategy. properties: - renderedContent: + sampleStrategy: description: >- - Optional. Web content snippet that can be embedded in a web page or - an app webview. - type: string - sdkBlob: - description: Optional. Base64 encoded JSON representing array of tuple. + Field to choose sampling strategy. Sampling strategy will decide + which data should be selected for human labeling in every batch. type: string - format: byte - id: GoogleCloudAiplatformV1SearchEntryPoint - description: Google search entry point. - GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: + enum: + - SAMPLE_STRATEGY_UNSPECIFIED + - UNCERTAINTY + enumDescriptions: + - Default will be treated as UNCERTAINTY. + - Sample the most uncertain data to label. + followingBatchSamplePercentage: + description: >- + The percentage of data needed to be labeled in each following batch + (except the first batch). + format: int32 + type: integer + initialBatchSamplePercentage: + description: The percentage of data needed to be labeled in the first batch. + type: integer + format: int32 + id: GoogleCloudAiplatformV1SampleConfig + type: object + GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation: properties: displayName: - type: string description: >- The display name of the AnnotationSpec that this Annotation pertains to. + type: string + xMin: + format: double + description: The leftmost coordinate of the bounding box. + type: number annotationSpecId: + type: string description: >- The resource Id of the AnnotationSpec that this Annotation pertains to. - type: string - type: object - id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation - description: Annotation details specific to image classification. - GoogleCloudAiplatformV1CreateFeatureOperationMetadata: - description: Details of operations that perform create Feature. - properties: - genericMetadata: - description: Operation metadata for Feature. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CreateFeatureOperationMetadata + yMin: + type: number + format: double + description: The topmost coordinate of the bounding box. + xMax: + type: number + description: The rightmost coordinate of the bounding box. + format: double + yMax: + type: number + format: double + description: The bottommost coordinate of the bounding box. type: object + id: GoogleCloudAiplatformV1SchemaImageBoundingBoxAnnotation + description: Annotation details specific to image object detection. GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification: properties: metadata: @@ -8916,239 +9238,151 @@ components: $ref: >- #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs description: The input parameters of this TrainingJob. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification description: >- A TrainingJob that trains and uploads an AutoML Image Classification Model. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassification type: object - GoogleCloudAiplatformV1PurgeContextsRequest: + GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec: + description: Spec for question answering relevance metric. + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec properties: - force: + version: + type: integer + format: int32 + description: Optional. Which version to use for evaluation. + useReference: type: boolean description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Context names - that would be deleted. - filter: - description: >- - Required. A required filter matching the Contexts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - type: string - description: Request message for MetadataService.PurgeContexts. - type: object - id: GoogleCloudAiplatformV1PurgeContextsRequest - GoogleCloudAiplatformV1ListAnnotationsResponse: - id: GoogleCloudAiplatformV1ListAnnotationsResponse - description: Response message for DatasetService.ListAnnotations. + Optional. Whether to use instance.reference to compute question + answering relevance. type: object + GoogleCloudAiplatformV1ExportModelRequest: properties: - nextPageToken: - type: string - description: The standard List next-page token. - annotations: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - type: array - description: >- - A list of Annotations that matches the specified filter in the - request. - GoogleCloudAiplatformV1Examples: - id: GoogleCloudAiplatformV1Examples - description: >- - Example-based explainability that returns the nearest neighbors from the - provided dataset. - properties: - neighborCount: - type: integer - format: int32 - description: The number of neighbors to return when querying for examples. - exampleGcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' - description: The Cloud Storage input instances. - presets: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Presets' - description: >- - Simplified preset configuration, which automatically sets - configuration values based on the desired query speed-precision - trade-off and modality. - nearestNeighborSearchConfig: - type: any - description: >- - The full configuration for the generated index, the semantics are - the same as metadata and should match - [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). + outputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig + description: Required. The desired output location and configuration. + description: Request message for ModelService.ExportModel. + id: GoogleCloudAiplatformV1ExportModelRequest + type: object + GoogleCloudAiplatformV1PurgeArtifactsResponse: type: object - GoogleCloudAiplatformV1AddContextChildrenRequest: - id: GoogleCloudAiplatformV1AddContextChildrenRequest - description: Request message for MetadataService.AddContextChildren. properties: - childContexts: + purgeSample: type: array + description: >- + A sample of the Artifact names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). items: type: string - description: The resource names of the child Contexts. - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry - properties: - iouScore: + purgeCount: description: >- - The intersection-over-union score. The measure of overlap of the - annotation's category mask with ground truth category mask on the - DataItem. - type: number - format: float - diceScoreCoefficient: - type: number - description: DSC or the F1 score, The harmonic mean of recall and precision. - format: float - confusionMatrix: + The number of Artifacts that this request deleted (or, if `force` is + false, the number of Artifacts that will be deleted). This can be an + estimate. + format: int64 + type: string + description: Response message for MetadataService.PurgeArtifacts. + id: GoogleCloudAiplatformV1PurgeArtifactsResponse + GoogleCloudAiplatformV1QuestionAnsweringQualityInput: + description: Input for question answering quality metric. + properties: + instance: + description: Required. Question answering quality instance. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: Confusion matrix for the given confidence threshold. - recall: - description: Recall (True Positive Rate) for the given confidence threshold. - type: number - format: float - confidenceThreshold: - type: number - description: >- - Metrics are computed with an assumption that the model never returns - predictions with score lower than this value. - format: float - precision: - format: float - description: Precision for the given confidence threshold. - type: number + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInstance + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualitySpec + description: Required. Spec for question answering quality score metric. + id: GoogleCloudAiplatformV1QuestionAnsweringQualityInput type: object - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams - description: Prediction model parameters for Image Object Detection. + GoogleCloudAiplatformV1ToolNameMatchSpec: + properties: {} + description: Spec for tool name match metric. + id: GoogleCloudAiplatformV1ToolNameMatchSpec type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs properties: - maxPredictions: + exportEvaluatedDataItemsConfig: description: >- - The Model only returns up to that many top, by confidence score, - predictions per instance. Note that number of returned predictions - is also limited by metadata's predictionsLimit. Default value is 10. - type: integer - format: int32 - confidenceThreshold: + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig + weightColumnName: + type: string description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. + optimizationObjective: + type: string + description: >- + Objective function the model is optimizing towards. The training + process creates a model that maximizes/minimizes the value of the + objective function over the validation set. The supported + optimization objectives depend on the prediction type. If the field + is not set, a default objective function is used. classification + (binary): "maximize-au-roc" (default) - Maximize the area under the + receiver operating characteristic (ROC) curve. "minimize-log-loss" - + Minimize log loss. "maximize-au-prc" - Maximize the area under the + precision-recall curve. "maximize-precision-at-recall" - Maximize + precision for a specified recall value. + "maximize-recall-at-precision" - Maximize recall for a specified + precision value. classification (multi-class): "minimize-log-loss" + (default) - Minimize log loss. regression: "minimize-rmse" (default) + - Minimize root-mean-squared error (RMSE). "minimize-mae" - Minimize + mean-absolute error (MAE). "minimize-rmsle" - Minimize + root-mean-squared log error (RMSLE). + disableEarlyStopping: + type: boolean + description: >- + Use the entire training budget. This disables the early stopping + feature. By default, the early stopping feature is enabled, which + means that AutoML Tables might stop training before the entire + training budget has been used. + optimizationObjectiveRecallValue: format: float type: number - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - type: object - properties: - type: - type: string - enumDescriptions: - - '' - - Uses Web Search to check the grounding. - - >- - Uses Vertex AI Search to check the grounding. Deprecated. Use - VERTEX_AI_SEARCH instead. - - Uses Vertex AI Search to check the grounding - - Uses inline context to check the grounding. - description: The type of the grounding checking source. - enum: - - UNSPECIFIED - - WEB - - ENTERPRISE - - VERTEX_AI_SEARCH - - INLINE - enumDeprecated: - - false - - false - - true - - false - - false - enterpriseDatastore: description: >- - The uri of the Vertex AI Search data source. Deprecated. Use - vertex_ai_search_datastore instead. - deprecated: true + Required when optimization_objective is + "maximize-precision-at-recall". Must be between 0 and 1, inclusive. + targetColumn: type: string - vertexAiSearchDatastore: - description: The uri of the Vertex AI Search data source. + description: The column name of the target column that the model is to predict. + predictionType: type: string - inlineContext: description: >- - The grounding text passed inline with the Predict API. It can - support up to 1 million bytes. - type: string - description: Single source entry for the grounding checking. - GoogleCloudAiplatformV1ExamplesRestrictionsNamespace: - id: GoogleCloudAiplatformV1ExamplesRestrictionsNamespace - type: object - description: Restrictions namespace for example-based explanations overrides. - properties: - allow: - type: array - items: - type: string - description: The list of allowed tags. - namespaceName: - type: string - description: The namespace name. - deny: + The type of prediction the Model is to produce. "classification" - + Predict one out of multiple target values is picked for each row. + "regression" - Predict a value based on its relation to other + values. This type is available only to columns that contain + semantically numeric values, i.e. integers or floating point number, + even if stored as e.g. strings. + additionalExperiments: type: array items: type: string - description: The list of deny tags. - GoogleCloudAiplatformV1BigQuerySource: - type: object - properties: - inputUri: - description: >- - Required. BigQuery URI to a table, up to 2000 characters long. - Accepted forms: * BigQuery path. For example: - `bq://projectId.bqDatasetId.bqTableId`. - type: string - id: GoogleCloudAiplatformV1BigQuerySource - description: The BigQuery location for the input content. - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: - description: All metadata of most recent monitoring pipelines. - properties: - runTime: - description: >- - The time that most recent monitoring pipelines that is related to - this run. - format: google-datetime - type: string - status: - description: The status of the most recent monitoring pipeline. - $ref: '#/components/schemas/GoogleRpcStatus' - type: object - id: >- - GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs: - type: object - properties: - holidayRegions: - description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. + description: Additional experiment flags for the Tables training pipeline. + transformations: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation type: array - validationOptions: - type: string description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. trainBudgetMilliNodeHours: description: >- Required. The train budget of creating this model, expressed in @@ -9163,270 +9397,254 @@ components: between 1,000 and 72,000 milli node hours, inclusive. format: int64 type: string - forecastHorizon: - description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - type: string - format: int64 - exportEvaluatedDataItemsConfig: - description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - unavailableAtForecastColumns: - description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. - items: - type: string - type: array - targetColumn: - description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. - type: string - timeSeriesAttributeColumns: - description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - items: - type: string - type: array - hierarchyConfig: - description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - additionalExperiments: - items: - type: string - description: Additional experiment flags for the time series forcasting training. - type: array - dataGranularity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - windowConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - description: Config containing strategy for generating sliding windows. - contextWindow: + optimizationObjectivePrecisionValue: description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. - format: int64 + Required when optimization_objective is + "maximize-recall-at-precision". Must be between 0 and 1, inclusive. + type: number + format: float + type: object + GoogleCloudAiplatformV1SearchMigratableResourcesRequest: + id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest + description: Request message for MigrationService.SearchMigratableResources. + type: object + properties: + pageToken: + description: The standard page token. type: string - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. + pageSize: + description: The standard page size. The default and maximum value is 100. + type: integer + format: int32 + filter: type: string - quantiles: - type: array description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`, or for probabilistic inference. Up to 5 - quantiles are allowed of values between 0 and 1, exclusive. Required - if the value of optimization_objective is minimize-quantile-loss. - Represents the percent quantiles to use for that objective. - Quantiles must be unique. - items: - format: double - type: number - enableProbabilisticInference: - description: >- - If probabilistic inference is enabled, the model will fit a - distribution that captures the uncertainty of a prediction. At - inference time, the predictive distribution is used to make a point - prediction that minimizes the optimization objective. For example, - the mean of a predictive distribution is the point prediction that - minimizes RMSE loss. If quantiles are specified, then the quantiles - of the distribution are also returned. The optimization objective - cannot be minimize-quantile-loss. - type: boolean - timeColumn: - description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. + A filter for your search. You can use the following types of + filters: * Resource type filters. The following strings filter for a + specific type of MigratableResource: * `ml_engine_model_version:*` * + `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * + "Migrated or not" filters. The following strings filter for + resources that either have or have not already been migrated: * + `last_migrate_time:*` filters for migrated resources. * `NOT + last_migrate_time:*` filters for not yet migrated resources. + GoogleCloudAiplatformV1ModelGardenSource: + properties: + publicModelName: + description: Required. The model garden source model resource name. type: string - weightColumn: + description: >- + Contains information about the source of the models generated from Model + Garden. + type: object + id: GoogleCloudAiplatformV1ModelGardenSource + GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata: + type: object + description: Details of operations that perform update FeatureOnlineStore. + properties: + genericMetadata: + description: Operation metadata for FeatureOnlineStore. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1UpdateFeatureOnlineStoreOperationMetadata + GoogleCloudAiplatformV1ExportDataRequest: + properties: + exportConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataConfig' + description: Required. The desired output location. + id: GoogleCloudAiplatformV1ExportDataRequest + type: object + description: Request message for DatasetService.ExportData. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation + type: object + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + properties: + columnName: type: string - description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. - availableAtForecastColumns: - type: array - items: - type: string - description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - optimizationObjective: + GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata: + properties: + progressMessage: type: string description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. - transformations: - type: array + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + description: Metadata information for NotebookService.StartNotebookRuntime. + id: GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata + type: object + GoogleCloudAiplatformV1ModelSourceInfo: + properties: + sourceType: + description: Type of the model source. + enum: + - MODEL_SOURCE_TYPE_UNSPECIFIED + - AUTOML + - CUSTOM + - BQML + - MODEL_GARDEN + - GENIE + - CUSTOM_TEXT_EMBEDDING + - MARKETPLACE + type: string + enumDescriptions: + - Should not be used. + - The Model is uploaded by automl training pipeline. + - The Model is uploaded by user or custom training pipeline. + - The Model is registered and sync'ed from BigQuery ML. + - The Model is saved or tuned from Model Garden. + - The Model is saved or tuned from Genie. + - The Model is uploaded by text embedding finetuning pipeline. + - The Model is saved or tuned from Marketplace. + copy: + type: boolean description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs - GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig - description: The config for email alert. + If this Model is copy of another Model. If true then source_type + pertains to the original. + description: Detail description of the source information of the model. + type: object + id: GoogleCloudAiplatformV1ModelSourceInfo + GoogleCloudAiplatformV1PurgeArtifactsMetadata: properties: - userEmails: - description: The email addresses to send the alert. - items: - type: string - type: array + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for purging Artifacts. + description: Details of operations that perform MetadataService.PurgeArtifacts. type: object - GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable: + id: GoogleCloudAiplatformV1PurgeArtifactsMetadata + GoogleCloudAiplatformV1PublisherModelResourceReference: + type: object + id: GoogleCloudAiplatformV1PublisherModelResourceReference properties: - bigqueryTablePath: + useCase: type: string - description: >- - The created BigQuery table to store logs. Customer could do their - own query & analysis. Format: `bq://.model_deployment_monitoring_._` - logType: - enum: - - LOG_TYPE_UNSPECIFIED - - PREDICT - - EXPLAIN + deprecated: true + description: Use case (CUJ) of the resource. + resourceName: + description: The resource name of the Google Cloud resource. type: string - enumDescriptions: - - Unspecified type. - - Predict logs. - - Explain logs. - description: The type of log. - logSource: - enumDescriptions: - - Unspecified source. - - Logs coming from Training dataset. - - Logs coming from Serving traffic. - description: The source of log. + uri: type: string - enum: - - LOG_SOURCE_UNSPECIFIED - - TRAINING - - SERVING - requestResponseLoggingSchemaVersion: - description: >- - Output only. The schema version of the request/response logging - BigQuery table. Default to v1 if unset. + description: The URI of the resource. + description: type: string - readOnly: true - type: object - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + deprecated: true + description: Description of the resource. + description: Reference to a resource. + GoogleApiHttpBody: description: >- - ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name - as well as some information of the logs stored in this table. - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: - description: Prediction output format for Text Extraction. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. type: object + id: GoogleApiHttpBody properties: - textSegmentStartOffsets: - type: array - items: - type: string - format: int64 + contentType: + type: string description: >- - The start offsets, inclusive, of the text segment in which the - AnnotationSpec has been identified. Expressed as a zero-based number - of characters as measured from the start of the text snippet. - ids: - type: array + The HTTP Content-Type header value specifying the content type of + the body. + data: + type: string + format: byte + description: The HTTP request/response body as raw binary. + extensions: description: >- - The resource IDs of the AnnotationSpecs that had been identified, - ordered by the confidence score descendingly. - items: - format: int64 - type: string - confidences: + Application specific response metadata. Must be set in the first + response for streaming APIs. items: - format: float - type: number - description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any type: array - displayNames: - description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. + GoogleCloudAiplatformV1ReadIndexDatapointsRequest: + type: object + id: GoogleCloudAiplatformV1ReadIndexDatapointsRequest + description: The request message for MatchService.ReadIndexDatapoints. + properties: + ids: type: array + description: IDs of the datapoints to be searched for. items: type: string - textSegmentEndOffsets: + deployedIndexId: + type: string + description: The ID of the DeployedIndex that will serve the request. + GoogleCloudAiplatformV1GroundingChunk: + type: object + description: Grounding chunk. + id: GoogleCloudAiplatformV1GroundingChunk + properties: + retrievedContext: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GroundingChunkRetrievedContext + description: Grounding chunk from context retrieved by the retrieval tools. + web: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingChunkWeb' + description: Grounding chunk from the web. + GoogleCloudAiplatformV1ListTrainingPipelinesResponse: + description: Response message for PipelineService.ListTrainingPipelines + properties: + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListTrainingPipelinesRequest.page_token to obtain that page. + trainingPipelines: + description: List of TrainingPipelines in the requested page. type: array items: - type: string - format: int64 - description: >- - The end offsets, inclusive, of the text segment in which the - AnnotationSpec has been identified. Expressed as a zero-based number - of characters as measured from the start of the text snippet. - GoogleCloudAiplatformV1AddTrialMeasurementRequest: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + id: GoogleCloudAiplatformV1ListTrainingPipelinesResponse type: object + GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata: properties: - measurement: - description: Required. The measurement to be added to a Trial. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - id: GoogleCloudAiplatformV1AddTrialMeasurementRequest - description: Request message for VizierService.AddTrialMeasurement. + genericMetadata: + description: Operation metadata for Feature. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + type: object + id: GoogleCloudAiplatformV1CreateRegistryFeatureOperationMetadata + description: Details of operations that perform create FeatureGroup. GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature: - id: >- - GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature properties: featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' description: >- Required. Selectors choosing which feature values to be deleted from the EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + timeRange: + description: >- + Required. Select feature generated within a half-inclusive time + range. The time range is lower inclusive and upper exclusive. + $ref: '#/components/schemas/GoogleTypeInterval' skipOnlineStorageDelete: - type: boolean description: >- If set, data will not be deleted from online storage. When time range is older than the data in online storage, setting this to be true will make the deletion have no impact on online serving. - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: >- - Required. Select feature generated within a half-inclusive time - range. The time range is lower inclusive and upper exclusive. + type: boolean + type: object description: >- Message to select time range and feature. Values of the selected feature generated within an inclusive time range will be deleted. Using this @@ -9434,269 +9652,232 @@ components: IDs within the specified time range. This might include data from the online storage. If you want to retain any deleted historical data in the online storage, you must re-ingest it. - type: object - GoogleCloudAiplatformV1ReadTensorboardSizeResponse: + id: >- + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature + GoogleCloudAiplatformV1SavedQuery: + description: >- + A SavedQuery is a view of the dataset. It references a subset of + annotations by problem type and filters. properties: - storageSizeByte: - format: int64 + annotationFilter: + description: Output only. Filters on the Annotations in the dataset. + readOnly: true type: string - description: Payload storage size for the TensorBoard + metadata: + type: any + description: Some additional information about the SavedQuery. + annotationSpecCount: + description: >- + Output only. Number of AnnotationSpecs in the context of the + SavedQuery. + type: integer + readOnly: true + format: int32 + createTime: + type: string + description: Output only. Timestamp when this SavedQuery was created. + format: google-datetime + readOnly: true + displayName: + description: >- + Required. The user-defined name of the SavedQuery. The name can be + up to 128 characters long and can consist of any UTF-8 characters. + type: string + problemType: + type: string + description: >- + Required. Problem type of the SavedQuery. Allowed values: * + IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL + * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * + TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * + TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * + VIDEO_OBJECT_TRACKING + supportAutomlTraining: + description: >- + Output only. If the Annotations belonging to the SavedQuery can be + used for AutoML training. + type: boolean + readOnly: true + updateTime: + description: Output only. Timestamp when SavedQuery was last updated. + readOnly: true + format: google-datetime + type: string + name: + type: string + description: Output only. Resource name of the SavedQuery. + readOnly: true + etag: + type: string + description: >- + Used to perform a consistent read-modify-write update. If not set, a + blind "overwrite" update happens. + id: GoogleCloudAiplatformV1SavedQuery type: object - description: Response message for TensorboardService.ReadTensorboardSize. - id: GoogleCloudAiplatformV1ReadTensorboardSizeResponse - GoogleCloudAiplatformV1PurgeArtifactsMetadata: + GoogleCloudAiplatformV1SchemaPredictionResult: + id: GoogleCloudAiplatformV1SchemaPredictionResult + description: Represents a line of JSONL in the batch prediction output file. properties: - genericMetadata: - description: Operation metadata for purging Artifacts. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform MetadataService.PurgeArtifacts. - type: object - id: GoogleCloudAiplatformV1PurgeArtifactsMetadata - GoogleCloudAiplatformV1ListEndpointsResponse: - id: GoogleCloudAiplatformV1ListEndpointsResponse - description: Response message for EndpointService.ListEndpoints. + key: + description: Optional user-provided key from the input instance. + type: string + prediction: + description: >- + The prediction result. Value is used here instead of Any so that + JsonFormat does not append an extra "@type" field when we convert + the proto to JSON and so we can represent array of objects. Do not + set error if this is set. + type: any + error: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictionResultError + description: The error result. Do not set prediction if this is set. + instance: + additionalProperties: + description: Properties of the object. + type: any + description: >- + User's input instance. Struct is used here instead of Any so that + JsonFormat does not append an extra "@type" field when we convert + the proto to JSON. + type: object type: object + GoogleCloudAiplatformV1SearchMigratableResourcesResponse: properties: - nextPageToken: + migratableResources: description: >- - A token to retrieve the next page of results. Pass to - ListEndpointsRequest.page_token to obtain that page. - type: string - endpoints: + All migratable resources that can be migrated to the location + specified in the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' type: array - description: List of Endpoints in the requested page. - GoogleCloudAiplatformV1ListFeatureViewSyncsResponse: - id: GoogleCloudAiplatformV1ListFeatureViewSyncsResponse - properties: nextPageToken: type: string description: >- - A token, which can be sent as ListFeatureViewSyncsRequest.page_token - to retrieve the next page. If this field is omitted, there are no + The standard next-page token. The migratable_resources may not fill + page_size in SearchMigratableResourcesRequest even when there are subsequent pages. - featureViewSyncs: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' - type: array - description: The FeatureViewSyncs matching the request. + id: GoogleCloudAiplatformV1SearchMigratableResourcesResponse + description: Response message for MigrationService.SearchMigratableResources. type: object - description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureViewSyncs. - GoogleCloudAiplatformV1ExportDataOperationMetadata: + GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata: + id: GoogleCloudAiplatformV1UpdateFeatureViewOperationMetadata properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - gcsOutputDirectory: - description: >- - A Google Cloud Storage directory which path ends with '/'. The - exported data is stored in the directory. - type: string + description: Operation metadata for FeatureView Update. type: object - description: Runtime operation information for DatasetService.ExportData. - id: GoogleCloudAiplatformV1ExportDataOperationMetadata - GoogleCloudAiplatformV1DirectRawPredictRequest: - id: GoogleCloudAiplatformV1DirectRawPredictRequest + description: Details of operations that perform update FeatureView. + GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata: + type: object + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata + description: >- + Metadata information about the deployment for managing deployment + config. properties: - input: - type: string - description: The prediction input. - format: byte - methodName: + sampleRequest: + description: Optional. Sample request for deployed endpoint. type: string + labels: description: >- - Fully qualified name of the API method being invoked to perform - predictions. Format: `/namespace.Service/Method/` Example: - `/tensorflow.serving.PredictionService/Predict` - description: Request message for PredictionService.DirectRawPredict. - type: object - GoogleCloudAiplatformV1GcsDestination: - type: object - description: The Google Cloud Storage location where the output is to be written to. + Optional. Labels for the deployment. For managing deployment config + like verifying, source of deployment config, etc. + type: object + additionalProperties: + type: string + GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest: properties: - outputUriPrefix: - type: string + requests: + type: array description: >- - Required. Google Cloud Storage URI to output directory. If the uri - doesn't end with '/', a '/' will be automatically appended. The - directory is created if it doesn't exist. - id: GoogleCloudAiplatformV1GcsDestination - GoogleCloudAiplatformV1ExplanationParameters: - id: GoogleCloudAiplatformV1ExplanationParameters - properties: - topK: - type: integer - format: int32 - description: >- - If populated, returns attributions for top K indices of outputs - (defaults to 1). Only applies to Models that predicts more than one - outputs (e,g, multi-class Models). When set to -1, returns - explanations for all outputs. - integratedGradientsAttribution: - description: >- - An attribution method that computes Aumann-Shapley values taking - advantage of the model's fully differentiable structure. Refer to - this paper for more details: https://arxiv.org/abs/1703.01365 - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1IntegratedGradientsAttribution - sampledShapleyAttribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SampledShapleyAttribution - description: >- - An attribution method that approximates Shapley values for features - that contribute to the label being predicted. A sampling strategy is - used to approximate the value rather than considering all subsets of - features. Refer to this paper for model details: - https://arxiv.org/abs/1306.4265. - examples: - description: >- - Example-based explanations that returns the nearest neighbors from - the provided dataset. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' - outputIndices: - description: >- - If populated, only returns attributions that have output_index - contained in output_indices. It must be an ndarray of integers, with - the same shape of the output it's explaining. If not populated, - returns attributions for top_k indices of outputs. If neither top_k - nor output_indices is populated, returns the argmax index of the - outputs. Only applicable to Models that predict multiple outputs - (e,g, multi-class Models that predict multiple classes). + Required. The request message specifying the TensorboardRuns to + create. A maximum of 1000 TensorboardRuns can be created in a batch. items: - type: any - type: array - xraiAttribution: - $ref: '#/components/schemas/GoogleCloudAiplatformV1XraiAttribution' - description: >- - An attribution method that redistributes Integrated Gradients - attribution to segmented regions, taking advantage of the model's - fully differentiable structure. Refer to this paper for more - details: https://arxiv.org/abs/1906.02825 XRAI currently performs - better on natural images, like a picture of a house or an animal. If - the images are taken in artificial environments, like a lab or - manufacturing line, or from diagnostic equipment, like x-rays or - quality-control cameras, use Integrated Gradients instead. - type: object - description: Parameters to configure explaining for Model's predictions. - GoogleCloudAiplatformV1BlurBaselineConfig: - properties: - maxBlurSigma: - description: >- - The standard deviation of the blur kernel for the blurred baseline. - The same blurring parameter is used for both the height and the - width dimension. If not set, the method defaults to the zero (i.e. - black for images) baseline. - type: number - format: float - id: GoogleCloudAiplatformV1BlurBaselineConfig + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardRunRequest + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest type: object - description: >- - Config for blur baseline. When enabled, a linear path from the maximally - blurred image to the input image is created. Using a blurred baseline - instead of zero (black image) is motivated by the BlurIG approach - explained here: https://arxiv.org/abs/2004.03383 - GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: + description: Request message for TensorboardService.BatchCreateTensorboardRuns. + GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly: type: object - id: GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec description: >- - Configuration for ConvexAutomatedStoppingSpec. When there are enough - completed trials (configured by min_measurement_count), for pending - trials with enough measurements and steps, the policy first computes an - overestimate of the objective value at max_num_steps according to the - slope of the incomplete objective value curve. No prediction can be made - if the curve is completely flat. If the overestimation is worse than the - best objective value of the completed trials, this pending trial will be - early-stopped, but a last measurement will be added to the pending trial - with max_num_steps and predicted objective value from the autoregression - model. + A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats + requested by user, sorted by FeatureStatsAnomaly.start_time descending. properties: - minMeasurementCount: - type: string - description: >- - The minimal number of measurements in a Trial. Early-stopping checks - will not trigger if less than min_measurement_count+1 completed - trials or pending trials with less than min_measurement_count - measurements. If not defined, the default value is 5. - format: int64 - learningRateParameterName: - type: string - description: >- - The hyper-parameter name used in the tuning job that stands for - learning rate. Leave it blank if learning rate is not in a parameter - in tuning. The learning_rate is used to estimate the objective value - of the ongoing trial. - minStepCount: - format: int64 + featureStatsAnomaly: + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' description: >- - Minimum number of steps for a trial to complete. Trials which do not - have a measurement with step_count > min_step_count won't be - considered for early stopping. It's ok to set it to 0, and a trial - can be early stopped at any stage. By default, min_step_count is set - to be one-tenth of the max_step_count. When use_elapsed_duration is - true, this field is set to the minimum elapsed seconds. + Output only. The stats and anomalies generated at specific + timestamp. + objective: + enumDescriptions: + - If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty. + - Stats are generated by Import Feature Analysis. + - Stats are generated by Snapshot Analysis. + enum: + - OBJECTIVE_UNSPECIFIED + - IMPORT_FEATURE_ANALYSIS + - SNAPSHOT_ANALYSIS + readOnly: true type: string - updateAllStoppedTrials: - type: boolean - description: >- - ConvexAutomatedStoppingSpec by default only updates the trials that - needs to be early stopped using a newly trained auto-regressive - model. When this flag is set to True, all stopped trials from the - beginning are potentially updated in terms of their - `final_measurement`. Also, note that the training logic of - autoregressive models is different in this case. Enabling this - option has shown better results and this may be the default option - in the future. - useElapsedDuration: - type: boolean - description: >- - This bool determines whether or not the rule is applied based on - elapsed_secs or steps. If use_elapsed_duration==false, the early - stopping decision is made according to the predicted objective - values according to the target steps. If use_elapsed_duration==true, - elapsed_secs is used instead of steps. Also, in this case, the - parameters max_num_steps and min_num_steps are overloaded to contain - max_elapsed_seconds and min_elapsed_seconds. - maxStepCount: + description: Output only. The objective for each stats. + id: GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + GoogleCloudAiplatformV1Neighbor: + properties: + neighborDistance: + readOnly: true + format: double + type: number + description: Output only. The neighbor distance. + neighborId: type: string - format: int64 - description: >- - Steps used in predicting the final objective for early stopped - trials. In general, it's set to be the same as the defined steps in - training / tuning. If not defined, it will learn it from the - completed trials. When use_steps is false, this field is set to the - maximum elapsed seconds. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + description: Output only. The neighbor id. + readOnly: true + description: Neighbors for example-based explanations. type: object - properties: - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics: + id: GoogleCloudAiplatformV1Neighbor + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsRegressionEvaluationMetrics - description: Metrics for regression evaluation results. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics + description: Metrics for forecasting evaluation results. + type: object properties: meanAbsoluteError: - format: float description: Mean Absolute Error (MAE). type: number + format: float + rootMeanSquaredPercentageError: + description: >- + Root Mean Square Percentage Error. Square root of MSPE. + Undefined/imaginary when MSPE is negative. + type: number + format: float + quantileMetrics: + description: The quantile metrics entries for each quantile. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + type: array + rSquared: + description: >- + Coefficient of determination as Pearson correlation coefficient. + Undefined when ground truth or predictions are constant or near + constant. + type: number + format: float + rootMeanSquaredError: + type: number + description: Root Mean Squared Error (RMSE). + format: float + weightedAbsolutePercentageError: + type: number + description: >- + Weighted Absolute Percentage Error. Does not use weights, this is + just what the metric is called. Undefined if actual values sum to + zero. Will be very large if actual values sum to a very small + number. + format: float rootMeanSquaredLogError: format: float type: number @@ -9704,2821 +9885,3289 @@ components: Root mean squared log error. Undefined when there are negative ground truth values or predictions. meanAbsolutePercentageError: - format: float type: number + format: float description: >- Mean absolute percentage error. Infinity when there are zeros in the ground truth. - rootMeanSquaredError: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: + properties: + trackingRecall: + type: number + format: float + description: Tracking recall. + trackingPrecision: format: float - description: Root Mean Squared Error (RMSE). type: number - rSquared: + description: Tracking precision. + mismatchRate: type: number format: float description: >- - Coefficient of determination as Pearson correlation coefficient. - Undefined when ground truth or predictions are constant or near - constant. + Mismatch rate, which measures the tracking consistency, i.e. + correctness of instance ID continuity. + boundingBoxIou: + type: number + format: float + description: >- + Bounding box intersection-over-union precision. Measures how well + the bounding boxes overlap between each other (e.g. complete overlap + or just barely above iou_threshold). + confidenceThreshold: + format: float + description: The confidence threshold value used to compute the metrics. + type: number + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + description: Metrics for a single confidence threshold. type: object - GoogleCloudAiplatformV1AutoscalingMetricSpec: - description: >- - The metric specification that defines the target resource utilization - (CPU utilization, accelerator's duty cycle, and so on) for calculating - the desired replica count. + GoogleCloudAiplatformV1WriteFeatureValuesRequest: properties: - metricName: + payloads: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesPayload description: >- - Required. The resource metric name. Supported metrics: * For Online - Prediction: * - `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` - * `aiplatform.googleapis.com/prediction/online/cpu/utilization` + Required. The entities to be written. Up to 100,000 feature values + can be written across all `payloads`. + type: array + id: GoogleCloudAiplatformV1WriteFeatureValuesRequest + type: object + description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. + GoogleCloudAiplatformV1FeatureViewSyncConfig: + description: Configuration for Sync. Only one option is set. + id: GoogleCloudAiplatformV1FeatureViewSyncConfig + properties: + cron: type: string - target: - type: integer - format: int32 description: >- - The target resource utilization in percentage (1% - 100%) for the - given metric; once the real usage deviates from the target by a - certain percentage, the machine replicas change. The default value - is 60 (representing 60%) if not provided. + Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch + scheduled runs. To explicitly set a timezone to the cron tab, apply + a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * + * *". + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation type: object - id: GoogleCloudAiplatformV1AutoscalingMetricSpec - GoogleCloudAiplatformV1DataLabelingJob: - id: GoogleCloudAiplatformV1DataLabelingJob description: >- - DataLabelingJob is used to trigger a human labeling job on unlabeled - data from the following Dataset: + Training pipeline will infer the proper transformation based on the + statistic of dataset. properties: - currentSpend: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Output only. Estimated cost(in US dollars) that the DataLabelingJob - has incurred to date. - readOnly: true - inputsSchemaUri: + columnName: type: string + GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: + description: Request message for NotebookService.UpgradeNotebookRuntime. + id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + properties: {} + type: object + GoogleCloudAiplatformV1TrialParameter: + description: A message representing a parameter to be tuned. + id: GoogleCloudAiplatformV1TrialParameter + type: object + properties: + value: + type: any description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing the config for a specific type of DataLabelingJob. The - schema files that can be used here are found in the - https://storage.googleapis.com/google-cloud-aiplatform bucket in the - /schema/datalabelingjob/inputs/ folder. - activeLearningConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' + Output only. The value of the parameter. `number_value` will be set + if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' + or 'DISCRETE'. `string_value` will be set if a parameter defined in + StudySpec is in type 'CATEGORICAL'. + readOnly: true + parameterId: + readOnly: true description: >- - Parameters that configure the active learning pipeline. Active - learning will label the data incrementally via several iterations. - For every iteration, it will select a batch of data based on the - sampling strategy. - name: + Output only. The ID of the parameter. The parameter should be + defined in StudySpec's Parameters. type: string - description: Output only. Resource name of the DataLabelingJob. - readOnly: true - specialistPools: + GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse: + type: object + properties: + nextPageToken: + type: string + description: >- + A token, which can be sent as + ListTensorboardTimeSeriesRequest.page_token to retrieve the next + page. If this field is omitted, there are no subsequent pages. + tensorboardTimeSeries: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + description: The TensorboardTimeSeries mathching the request. type: array - description: The SpecialistPools' resource names associated with this job. - datasets: + id: GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse + description: Response message for TensorboardService.ListTensorboardTimeSeries. + GoogleCloudAiplatformV1TimeSeriesData: + description: All the data stored in a TensorboardTimeSeries. + id: GoogleCloudAiplatformV1TimeSeriesData + properties: + valueType: description: >- - Required. Dataset resource names. Right now we only support labeling - from a single Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}` + Required. Immutable. The value type of this time series. All the + values in this time series data must match this value type. + enum: + - VALUE_TYPE_UNSPECIFIED + - SCALAR + - TENSOR + - BLOB_SEQUENCE + type: string + enumDescriptions: + - The value type is unspecified. + - >- + Used for TensorboardTimeSeries that is a list of scalars. E.g. + accuracy of a model over epochs/time. + - >- + Used for TensorboardTimeSeries that is a list of tensors. E.g. + histograms of weights of layer in a model over epoch/time. + - >- + Used for TensorboardTimeSeries that is a list of blob sequences. + E.g. set of sample images with labels over epochs/time. + values: items: - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + description: Required. Data points in this time series. type: array - displayName: + tensorboardTimeSeriesId: type: string description: >- - Required. The user-defined name of the DataLabelingJob. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. Display name of a DataLabelingJob. - annotationLabels: - additionalProperties: - type: string + Required. The ID of the TensorboardTimeSeries, which will become the + final component of the TensorboardTimeSeries' resource name + type: object + GoogleCloudAiplatformV1ExplanationMetadata: + id: GoogleCloudAiplatformV1ExplanationMetadata + description: Metadata describing the Model's input and output for explanation. + type: object + properties: + outputs: type: object - description: >- - Labels to assign to annotations generated by this DataLabelingJob. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - inputs: - description: Required. Input config parameters for the DataLabelingJob. - type: any - labels: - description: >- - The labels with user-defined metadata to organize your - DataLabelingJobs. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for each DataLabelingJob: * - "aiplatform.googleapis.com/schema": output only, its value is the - inputs_schema's title. additionalProperties: - type: string - type: object - encryptionSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata description: >- - Customer-managed encryption key spec for a DataLabelingJob. If set, - this DataLabelingJob will be secured by this key. Note: Annotations - created in the DataLabelingJob are associated with the - EncryptionSpec of the Dataset they are exported to. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - error: - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' + Required. Map from output names to output metadata. For Vertex + AI-provided Tensorflow images, keys can be any user defined string + that consists of any UTF-8 characters. For custom images, keys are + the name of the output field in the prediction to be explained. + Currently only one key is allowed. + featureAttributionsSchemaUri: description: >- - Output only. DataLabelingJob errors. It is only populated when job's - state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. - createTime: - format: google-datetime - description: Output only. Timestamp when this DataLabelingJob was created. + Points to a YAML file stored on Google Cloud Storage describing the + format of the feature attributions. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML tabular Models always have this field populated by Vertex AI. + Note: The URI given on output may be different, including the URI + scheme, than the one given on input. The output URI will point to a + location where the user only has a read access. type: string - readOnly: true - labelingProgress: - readOnly: true - format: int32 + inputs: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadata description: >- - Output only. Current labeling job progress percentage scaled in - interval [0, 100], indicating the percentage of DataItems that has - been finished. - type: integer - labelerCount: - type: integer - description: Required. Number of labelers to work on each DataItem. - format: int32 - instructionUri: + Required. Map from feature names to feature input metadata. Keys are + the name of the features. Values are the specification of the + feature. An empty InputMetadata is valid. It describes a text + feature which has the name specified as the key in + ExplanationMetadata.inputs. The baseline of the empty feature is + chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the + key can be any friendly name of the feature. Once specified, + featureAttributions are keyed by this key (if not grouped with + another feature). For custom images, the key must match with the key + in instance. + latentSpaceSource: type: string description: >- - Required. The Google Cloud Storage location of the instruction pdf. - This pdf is shared with labelers, and provides detailed description - on how to label DataItems in Datasets. - updateTime: - format: google-datetime - readOnly: true + Name of the source to generate embeddings for example based + explanations. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: + description: >- + A TrainingJob that trains and uploads an AutoML Image Object Detection + Model. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection + type: object + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs + description: The input parameters of this TrainingJob. + metadata: + description: The metadata information + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata + GoogleCloudAiplatformV1DeployIndexResponse: + id: GoogleCloudAiplatformV1DeployIndexResponse + description: Response message for IndexEndpointService.DeployIndex. + properties: + deployedIndex: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: The DeployedIndex that had been deployed in the IndexEndpoint. + type: object + GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata: + properties: + progressMessage: type: string description: >- - Output only. Timestamp when this DataLabelingJob was updated most - recently. - state: - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - type: string - description: Output only. The detailed state of the job. - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - readOnly: true + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Metadata information for NotebookService.CreateNotebookExecutionJob. type: object - GoogleTypeMoney: - description: Represents an amount of money with its currency type. + id: GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: + id: >- + GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata properties: - units: + multiLabel: + type: boolean + description: Whether or not the classification label is multi_label. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + properties: + unit: + type: string description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" + quantity: format: int64 type: string - currencyCode: - description: The three-letter currency code defined in ISO 4217. - type: string - nanos: - type: integer - format: int32 description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - id: GoogleTypeMoney + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. + description: A duration of time expressed in time granularity units. type: object - GoogleCloudAiplatformV1ModelContainerSpec: - id: GoogleCloudAiplatformV1ModelContainerSpec + GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata: + type: object + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + id: GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata description: >- - Specification of a container for serving predictions. Some fields in - this message correspond to fields in the [Kubernetes Container v1 core - specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + Runtime operation information for + SpecialistPoolService.CreateSpecialistPool. + GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: type: object + description: Open fine tuning pipelines. properties: - predictRoute: - type: string - description: >- - Immutable. HTTP path on the container to send prediction requests - to. Vertex AI forwards requests sent using - projects.locations.endpoints.predict to this path on the container's - IP address and port. Vertex AI then returns the container's response - in the API response. For example, if you set this field to `/foo`, - then when Vertex AI receives a prediction request, it forwards the - request body in a POST request to the `/foo` path on the port of - your container specified by the first value of this - `ModelContainerSpec`'s ports field. If you don't specify this field, - it defaults to the following value when you deploy this Model to an - Endpoint: - /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The - placeholders in this value are replaced as follows: * ENDPOINT: The - last segment (following `endpoints/`)of the Endpoint.name][] field - of the Endpoint where this Model has been deployed. (Vertex AI makes - this value available to your container code as the - [`AIP_ENDPOINT_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex - AI makes this value available to your container code as the - [`AIP_DEPLOYED_MODEL_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - startupProbe: - description: Immutable. Specification for Kubernetes startup probe. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - command: + fineTuningPipelines: + description: Required. Regional resource references to fine tuning pipelines. items: - type: string - description: >- - Immutable. Specifies the command that runs when the container - starts. This overrides the container's - [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). - Specify this field as an array of executable and arguments, similar - to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you - do not specify this field, then the container's `ENTRYPOINT` runs, - in conjunction with the args field or the container's - [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if - either exists. If this field is not specified and the container does - not have an `ENTRYPOINT`, then refer to the Docker documentation - about [how `CMD` and `ENTRYPOINT` - interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). - If you specify this field, then you can also specify the `args` - field to provide additional arguments for this command. However, if - you specify this field, then the container's `CMD` is ignored. See - the [Kubernetes documentation about how the `command` and `args` - fields interact with a container's `ENTRYPOINT` and - `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). - In this field, you can reference [environment variables set by - Vertex - AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - and environment variables set in the env field. You cannot reference - environment variables set in the Docker image. In order for - environment variables to be expanded, reference them by using the - following syntax: $( VARIABLE_NAME) Note that this differs from Bash - variable expansion, which does not use parentheses. If a variable - cannot be resolved, the reference in the input string is used - unchanged. To avoid variable expansion, you can escape this syntax - with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to - the `command` field of the Kubernetes Containers [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences type: array - imageUri: + id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines + GoogleCloudAiplatformV1FeatureSelector: + description: Selector for Features of an EntityType. + properties: + idMatcher: + description: Required. Matches Features based on ID. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' + id: GoogleCloudAiplatformV1FeatureSelector + type: object + GoogleCloudAiplatformV1BatchReadFeatureValuesResponse: + properties: {} + id: GoogleCloudAiplatformV1BatchReadFeatureValuesResponse + type: object + description: Response message for FeaturestoreService.BatchReadFeatureValues. + GoogleCloudAiplatformV1VertexAISearch: + description: >- + Retrieve from Vertex AI Search datastore for grounding. See + https://cloud.google.com/products/agent-builder + properties: + datastore: description: >- - Required. Immutable. URI of the Docker image to be used as the - custom container for serving predictions. This URI must identify an - image in Artifact Registry or Container Registry. Learn more about - the [container publishing - requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), - including permissions requirements for the Vertex AI Service Agent. - The container image is ingested upon ModelService.UploadModel, - stored internally, and this original path is afterwards not used. To - learn about the requirements for the Docker image itself, see - [Custom container - requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). - You can use the URI to one of Vertex AI's [pre-built container - images for - prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) - in this field. + Required. Fully-qualified Vertex AI Search data store resource ID. + Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` type: string - grpcPorts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' - description: >- - Immutable. List of ports to expose from the container. Vertex AI - sends gRPC prediction requests that it receives to the first port on - this list. Vertex AI also sends liveness and health checks to this - port. If you do not specify this field, gRPC requests to the - container will be disabled. Vertex AI does not use ports other than - the first one listed. This field corresponds to the `ports` field of - the Kubernetes Containers v1 core API. - type: array - env: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' - description: >- - Immutable. List of environment variables to set in the container. - After the container starts running, code running in the container - can read these environment variables. Additionally, the command and - args fields can reference these variables. Later entries in this - list can also reference earlier entries. For example, the following - example sets the variable `VAR_2` to have the value `foo bar`: - ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", - "value": "$(VAR_1) bar" } ] ``` If you switch the order of the - variables in the example, then the expansion does not occur. This - field corresponds to the `env` field of the Kubernetes Containers - [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - ports: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' - type: array - description: >- - Immutable. List of ports to expose from the container. Vertex AI - sends any prediction requests that it receives to the first port on - this list. Vertex AI also sends [liveness and health - checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) - to this port. If you do not specify this field, it defaults to - following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI - does not use ports other than the first one listed. This field - corresponds to the `ports` field of the Kubernetes Containers [v1 - core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - args: - items: - type: string + id: GoogleCloudAiplatformV1VertexAISearch + type: object + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: + type: object + description: Annotation details specific to image segmentation. + properties: + polylineAnnotation: + description: Polyline annotation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + maskAnnotation: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation description: >- - Immutable. Specifies arguments for the command that runs when the - container starts. This overrides the container's - [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). - Specify this field as an array of executable and arguments, similar - to a Docker `CMD`'s "default parameters" form. If you don't specify - this field but do specify the command field, then the command from - the `command` field runs without any additional arguments. See the - [Kubernetes documentation about how the `command` and `args` fields - interact with a container's `ENTRYPOINT` and - `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). - If you don't specify this field and don't specify the `command` - field, then the container's - [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) - and `CMD` determine what runs based on their default behavior. See - the Docker documentation about [how `CMD` and `ENTRYPOINT` - interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). - In this field, you can reference [environment variables set by - Vertex - AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - and environment variables set in the env field. You cannot reference - environment variables set in the Docker image. In order for - environment variables to be expanded, reference them by using the - following syntax: $( VARIABLE_NAME) Note that this differs from Bash - variable expansion, which does not use parentheses. If a variable - cannot be resolved, the reference in the input string is used - unchanged. To avoid variable expansion, you can escape this syntax - with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to - the `args` field of the Kubernetes Containers [v1 core - API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - type: array - deploymentTimeout: - format: google-duration - type: string + Mask based segmentation annotation. Only one mask annotation can + exist for one image. + polygonAnnotation: + description: Polygon annotation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation + GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource: + id: GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource + type: object + properties: + generation: description: >- - Immutable. Deployment timeout. Limit for deployment timeout is 2 - hours. - sharedMemorySizeMb: + The version of the Cloud Storage object to read. If unset, the + current version of the object is read. See + https://cloud.google.com/storage/docs/metadata#generation-number. type: string + uri: description: >- - Immutable. The amount of the VM memory to reserve as the shared - memory for the model in megabytes. - format: int64 - healthProbe: - description: Immutable. Specification for Kubernetes readiness probe. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' - healthRoute: + The Cloud Storage uri pointing to the ipynb file. Format: + `gs://bucket/notebook_file.ipynb` type: string + description: The Cloud Storage uri for the input notebook. + GoogleCloudAiplatformV1PurgeContextsMetadata: + type: object + description: Details of operations that perform MetadataService.PurgeContexts. + id: GoogleCloudAiplatformV1PurgeContextsMetadata + properties: + genericMetadata: + description: Operation metadata for purging Contexts. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1CreateIndexOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + nearestNeighborSearchOperationMetadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata description: >- - Immutable. HTTP path on the container to send health checks to. - Vertex AI intermittently sends GET requests to this path on the - container's IP address and port to check that the container is - healthy. Read more about [health - checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). - For example, if you set this field to `/bar`, then Vertex AI - intermittently sends a GET request to the `/bar` path on the port of - your container specified by the first value of this - `ModelContainerSpec`'s ports field. If you don't specify this field, - it defaults to the following value when you deploy this Model to an - Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ - DEPLOYED_MODEL:predict The placeholders in this value are replaced - as follows: * ENDPOINT: The last segment (following `endpoints/`)of - the Endpoint.name][] field of the Endpoint where this Model has been - deployed. (Vertex AI makes this value available to your container - code as the [`AIP_ENDPOINT_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex - AI makes this value available to your container code as the - [`AIP_DEPLOYED_MODEL_ID` environment - variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - GoogleCloudAiplatformV1ListTrialsResponse: + The operation metadata with regard to Matching Engine Index + operation. + description: Runtime operation information for IndexService.CreateIndex. + type: object + id: GoogleCloudAiplatformV1CreateIndexOperationMetadata + GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors: + type: object + id: GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors + description: Nearest neighbors for one query. properties: - trials: - type: array + neighbors: + description: All its neighbors. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - description: The Trials associated with the Study. - nextPageToken: - description: >- - Pass this token as the `page_token` field of the request for a - subsequent call. If this field is omitted, there are no subsequent - pages. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNeighbor + type: array + id: + description: The ID of the query datapoint. type: string - description: Response message for VizierService.ListTrials. + GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: type: object - id: GoogleCloudAiplatformV1ListTrialsResponse - GoogleCloudAiplatformV1BatchCreateFeaturesRequest: - id: GoogleCloudAiplatformV1BatchCreateFeaturesRequest - description: Request message for FeaturestoreService.BatchCreateFeatures. + description: Rest API docs. properties: - requests: + title: + description: Required. The title of the view rest API. + type: string + documentations: type: array - description: >- - Required. The request message specifying the Features to create. All - Features must be created under the same parent EntityType. The - `parent` field in each child request message can be omitted. If - `parent` is set in a child request, then the value must match the - `parent` value in this request message. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CreateFeatureRequest' - type: object - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation + description: Required. + id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + GoogleCloudAiplatformV1SummarizationQualitySpec: properties: - pageSize: - description: The standard list page size. - type: integer + version: format: int32 - featureDisplayName: + type: integer + description: Optional. Which version to use for evaluation. + useReference: + type: boolean description: >- - The feature display name. If specified, only return the stats - belonging to this feature. Format: - ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, - example: "user_destination". - type: string - startTime: + Optional. Whether to use instance.reference to compute summarization + quality. + type: object + id: GoogleCloudAiplatformV1SummarizationQualitySpec + description: Spec for summarization quality score metric. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: + properties: + meanAveragePrecision: + description: The mean average precision, most often close to `auPrc`. + type: number + format: float + iouThreshold: + format: float + type: number description: >- - The earliest timestamp of stats being generated. If not set, - indicates fetching stats till the earliest possible one. - type: string - format: google-datetime - objectives: + The intersection-over-union threshold value used to compute this + metrics entry. + confidenceMetrics: + description: >- + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. + type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective - description: Required. Objectives of the stats to retrieve. + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + type: object + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics + GoogleCloudAiplatformV1NotebookRuntimeTemplateRef: + properties: + notebookRuntimeTemplate: + type: string + description: Immutable. A resource name of the NotebookRuntimeTemplate. + id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef + type: object + description: Points to a NotebookRuntimeTemplateRef. + GoogleCloudAiplatformV1BatchCreateFeaturesResponse: + id: GoogleCloudAiplatformV1BatchCreateFeaturesResponse + properties: + features: type: array - deployedModelId: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + description: The Features created. + type: object + description: Response message for FeaturestoreService.BatchCreateFeatures. + GoogleCloudAiplatformV1FluencyInstance: + type: object + description: Spec for fluency instance. + id: GoogleCloudAiplatformV1FluencyInstance + properties: + prediction: type: string + description: Required. Output of the evaluated model. + GoogleCloudAiplatformV1Schedule: + properties: + lastPauseTime: + format: google-datetime description: >- - Required. The DeployedModel ID of the - [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. - pageToken: + Output only. Timestamp when this Schedule was last paused. Unset if + never paused. + readOnly: true type: string + catchUp: + readOnly: true + type: boolean description: >- - A page token received from a previous - JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + Output only. Whether to backfill missed runs when the schedule is + resumed from PAUSED state. If set to true, all missed runs will be + scheduled. New runs will be scheduled after the backfill is + complete. Default to false. + maxRunCount: + format: int64 + type: string + description: >- + Optional. Maximum run count of the schedule. If specified, The + schedule will be completed when either started_run_count >= + max_run_count or when end_time is reached. If not specified, new + runs will keep getting scheduled until this Schedule is paused or + deleted. Already scheduled runs will be allowed to complete. Unset + if not specified. + allowQueueing: + type: boolean + description: >- + Optional. Whether new scheduled runs can be queued when + max_concurrent_runs limit is reached. If set to true, new runs will + be queued instead of skipped. Default to false. + createNotebookExecutionJobRequest: + description: Request for NotebookService.CreateNotebookExecutionJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest + state: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - PAUSED + - COMPLETED + enumDescriptions: + - Unspecified. + - >- + The Schedule is active. Runs are being scheduled on the + user-specified timespec. + - >- + The schedule is paused. No new runs will be created until the + schedule is resumed. Already started runs will be allowed to + complete. + - >- + The Schedule is completed. No new runs will be scheduled. Already + started runs will be allowed to complete. Schedules in completed + state cannot be paused or resumed. + readOnly: true + description: Output only. The state of this Schedule. + type: string + cron: + type: string + description: >- + Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch + scheduled runs. To explicitly set a timezone to the cron tab, apply + a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * + * *". endTime: + description: >- + Optional. Timestamp after which no new runs can be scheduled. If + specified, The schedule will be completed when either end_time is + reached or when scheduled_run_count >= max_run_count. If not + specified, new runs will keep getting scheduled until this Schedule + is paused or deleted. Already scheduled runs will be allowed to + complete. Unset if not specified. type: string format: google-datetime + startTime: + format: google-datetime description: >- - The latest timestamp of stats being generated. If not set, indicates - feching stats till the latest possible one. - description: >- - Request message for - JobService.SearchModelDeploymentMonitoringStatsAnomalies. - type: object - id: >- - GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest - CloudAiLargeModelsVisionImageRAIScores: - type: object - id: CloudAiLargeModelsVisionImageRAIScores - properties: - agileWatermarkDetectionScore: - format: double - type: number - description: Agile watermark score for image. - description: RAI scores for generated image returned. - GoogleCloudAiplatformV1TensorboardBlobSequence: - type: object - properties: - values: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' - type: array - description: List of blobs contained within the sequence. - description: >- - One point viewable on a blob metric plot, but mostly just a wrapper - message to work around repeated fields can't be used directly within - `oneof` fields. - id: GoogleCloudAiplatformV1TensorboardBlobSequence - GoogleCloudAiplatformV1FeatureViewSyncSyncSummary: - description: >- - Summary from the Sync job. For continuous syncs, the summary is updated - periodically. For batch syncs, it gets updated on completion of the - sync. - properties: - rowSynced: + Optional. Timestamp after which the first run can be scheduled. + Default to Schedule create time if not specified. + type: string + createPipelineJobRequest: + description: >- + Request for PipelineService.CreatePipelineJob. + CreatePipelineJobRequest.parent field is required (format: + projects/{project}/locations/{location}). + $ref: '#/components/schemas/GoogleCloudAiplatformV1CreatePipelineJobRequest' + name: + description: Immutable. The resource name of the Schedule. + type: string + lastResumeTime: + type: string + description: >- + Output only. Timestamp when this Schedule was last resumed. Unset if + never resumed from pause. + format: google-datetime + readOnly: true + createTime: + description: Output only. Timestamp when this Schedule was created. + format: google-datetime + readOnly: true + type: string + displayName: + type: string + description: >- + Required. User provided name of the Schedule. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + updateTime: + format: google-datetime + readOnly: true + type: string + description: Output only. Timestamp when this Schedule was updated. + maxConcurrentRunCount: + description: >- + Required. Maximum number of runs that can be started concurrently + for this Schedule. This is the limit for starting the scheduled + requests and not the execution of the operations/jobs created by the + requests (if applicable). + type: string format: int64 - description: Output only. Total number of rows synced. + nextRunTime: readOnly: true + description: >- + Output only. Timestamp when this Schedule should schedule the next + run. Having a next_run_time in the past means the runs are being + started behind schedule. type: string - totalSlot: + format: google-datetime + lastScheduledRunResponse: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ScheduleRunResponse' readOnly: true - description: Output only. BigQuery slot milliseconds consumed for the sync job. + description: >- + Output only. Response of the last scheduled run. This is the + response for starting the scheduled requests and not the execution + of the operations/jobs created by the requests (if applicable). + Unset if no run has been scheduled yet. + startedRunCount: type: string + description: Output only. The number of runs started by this schedule. format: int64 + readOnly: true type: object - id: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary - GoogleCloudAiplatformV1ListSchedulesResponse: - description: Response message for ScheduleService.ListSchedules - id: GoogleCloudAiplatformV1ListSchedulesResponse + description: >- + An instance of a Schedule periodically schedules runs to make API calls + based on user specified time specification and API request type. + id: GoogleCloudAiplatformV1Schedule + GoogleCloudAiplatformV1CsvDestination: + description: The storage details for CSV output content. + id: GoogleCloudAiplatformV1CsvDestination properties: - nextPageToken: + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Required. Google Cloud Storage location. + type: object + GoogleCloudAiplatformV1NasJobSpec: + properties: + multiTrialAlgorithmSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec + description: The spec of multi-trial algorithms. + searchSpaceSpec: + type: string + description: It defines the search space for Neural Architecture Search (NAS). + resumeNasJobId: type: string description: >- - A token to retrieve the next page of results. Pass to - ListSchedulesRequest.page_token to obtain that page. - schedules: + The ID of the existing NasJob in the same Project and Location which + will be used to resume search. search_space_spec and + nas_algorithm_spec are obtained from previous NasJob hence should + not provide them again for this NasJob. + id: GoogleCloudAiplatformV1NasJobSpec + description: Represents the spec of a NasJob. + type: object + GoogleCloudAiplatformV1PointwiseMetricInput: + properties: + instance: + description: Required. Pointwise metric instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInstance' + metricSpec: + description: Required. Spec for pointwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricSpec' + type: object + description: Input for pointwise metric. + id: GoogleCloudAiplatformV1PointwiseMetricInput + GoogleCloudAiplatformV1ListModelVersionsResponse: + description: Response message for ModelService.ListModelVersions + properties: + models: + description: >- + List of Model versions in the requested page. In the returned Model + name field, version ID instead of regvision tag will be included. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' - description: List of Schedules in the requested page. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' type: array + nextPageToken: + description: >- + A token to retrieve the next page of results. Pass to + ListModelVersionsRequest.page_token to obtain that page. + type: string + id: GoogleCloudAiplatformV1ListModelVersionsResponse type: object - GoogleIamV1Binding: - id: GoogleIamV1Binding + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation: properties: - role: + columnName: type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + type: object + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. + GoogleCloudAiplatformV1CancelCustomJobRequest: + properties: {} + description: Request message for JobService.CancelCustomJob. + type: object + id: GoogleCloudAiplatformV1CancelCustomJobRequest + GoogleCloudAiplatformV1ReadTensorboardUsageResponse: + properties: + monthlyUsageData: + description: Maps year-month (YYYYMM) string to per month usage data. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData + description: Response message for TensorboardService.ReadTensorboardUsage. + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponse + type: object + GoogleCloudAiplatformV1GroundingSupport: + id: GoogleCloudAiplatformV1GroundingSupport + properties: + confidenceScores: description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - members: + Confidence score of the support references. Ranges from 0 to 1. 1 is + the most confident. This list must have the same size as the + grounding_chunk_indices. items: - type: string + type: number + format: float + type: array + groundingChunkIndices: + items: + format: int32 + type: integer description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + A list of indices (into 'grounding_chunk') specifying the citations + associated with the claim. For instance [1,3,4] means that + grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the + retrieved content attributed to the claim. type: array - description: Associates `members`, or principals, with a `role`. - type: object - GoogleCloudAiplatformV1SearchDataItemsResponse: - id: GoogleCloudAiplatformV1SearchDataItemsResponse + segment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Segment' + description: Segment of the content this support belongs to. type: object - description: Response message for DatasetService.SearchDataItems. + description: Grounding support. + GoogleCloudAiplatformV1ModelEvaluationSliceSlice: + description: Definition of a slice. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice properties: - nextPageToken: + sliceSpec: + readOnly: true + description: Output only. Specification for how the data was sliced. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec + dimension: + type: string description: >- - A token to retrieve next page of results. Pass to - SearchDataItemsRequest.page_token to obtain that page. + Output only. The dimension of the slice. Well-known dimensions are: + * `annotationSpec`: This slice is on the test data that has either + ground truth or prediction with AnnotationSpec.display_name equals + to value. * `slice`: This slice is a user customized slice defined + by its SliceSpec. + readOnly: true + value: + readOnly: true type: string - dataItemViews: - type: array - description: The DataItemViews read. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItemView' - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: + description: Output only. The value of the dimension in this slice. + type: object + GoogleCloudAiplatformV1FeatureViewSyncSyncSummary: properties: - evaluatedDataItemsBigqueryUri: + totalSlot: type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: + readOnly: true format: int64 + description: Output only. BigQuery slot milliseconds consumed for the sync job. + systemWatermarkTime: + format: google-datetime + type: string description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. + Lower bound of the system time watermark for the sync job. This is + only set for continuously syncing feature views. + rowSynced: + format: int64 + readOnly: true type: string - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + description: Output only. Total number of rows synced. type: object - description: Model metadata specific to TFT Forecasting. - GoogleCloudAiplatformV1FunctionDeclaration: - id: GoogleCloudAiplatformV1FunctionDeclaration + id: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary + description: >- + Summary from the Sync job. For continuous syncs, the summary is updated + periodically. For batch syncs, it gets updated on completion of the + sync. + GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: properties: - parameters: - description: >- - Optional. Describes the parameters to this function in JSON Schema - Object format. Reflects the Open API 3.03 Parameter Object. string - Key: the name of the parameter. Parameter names are case sensitive. - Schema Value: the Schema defining the type used for the parameter. - For function with no parameters, this can be left unset. Parameter - names must start with a letter or an underscore and must only - contain chars a-z, A-Z, 0-9, or underscores with a maximum length of - 64. Example with 1 required and 1 optional parameter: type: OBJECT - properties: param1: type: STRING param2: type: INTEGER required: - - param1 - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' - description: - description: >- - Optional. Description and purpose of the function. Model uses it to - decide how and whether to call the function. - type: string - name: + deployedModelId: + description: The DeployedModel ID of the objective config. type: string + objectiveConfig: description: >- - Required. The name of the function to call. Must start with a letter - or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, - dots and dashes, with a maximum length of 64. + The objective config of for the modelmonitoring job of this deployed + model. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig type: object description: >- - Structured representation of a function declaration as defined by the - [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). - Included in this declaration are the function name and parameters. This - FunctionDeclaration is a representation of a block of code that can be - used as a `Tool` by the model and executed by the client. - GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: + ModelDeploymentMonitoringObjectiveConfig contains the pair of + deployed_model_id to ModelMonitoringObjectiveConfig. + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: description: >- - Request message for - FeaturestoreOnlineServingService.StreamingFeatureValuesRead. - id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + Config for migrating AnnotatedDataset in datalabeling.googleapis.com to + Vertex AI's SavedQuery. type: object + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig properties: - featureSelector: - description: >- - Required. Selector choosing Features of the target EntityType. - Feature IDs will be deduplicated. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - entityIds: - items: - type: string + annotatedDataset: description: >- - Required. IDs of entities to read Feature values of. The maximum - number of IDs is 100. For example, for a machine learning model - predicting user clicks on a website, an entity ID could be - `user_123`. - type: array - GoogleCloudAiplatformV1ExportFeatureValuesResponse: + Required. Full resource name of data labeling AnnotatedDataset. + Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + type: string + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance: type: object - properties: {} - id: GoogleCloudAiplatformV1ExportFeatureValuesResponse - description: Response message for FeaturestoreService.ExportFeatureValues. - GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: + description: Prediction input format for Video Object Tracking. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance properties: - importFeaturesAnalysis: - description: The config for ImportFeatures Analysis Based Feature Monitoring. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis - snapshotAnalysis: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis - description: The config for Snapshot Analysis Based Feature Monitoring. - categoricalThresholdConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + timeSegmentEnd: + type: string description: >- - Threshold for categorical features of anomaly detection. This is - shared by all types of Featurestore Monitoring for categorical - features (i.e. Features with type (Feature.ValueType) BOOL or - STRING). - numericalThresholdConfig: + The end, exclusive, of the video's time segment on which to perform + the prediction. Expressed as a number of seconds as measured from + the start of the video, with "s" appended at the end. Fractions are + allowed, up to a microsecond precision, and "inf" or "Infinity" is + allowed, which means the end of the video. + content: description: >- - Threshold for numerical features of anomaly detection. This is - shared by all objectives of Featurestore Monitoring for numerical - features (i.e. Features with type (Feature.ValueType) DOUBLE or - INT64). - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig - type: object - description: Configuration of how features in Featurestore are monitored. - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig - GoogleCloudAiplatformV1NearestNeighborQueryParameters: - type: object - properties: - approximateNeighborCandidates: - format: int32 - type: integer + The Google Cloud Storage location of the video on which to perform + the prediction. + type: string + mimeType: description: >- - Optional. The number of neighbors to find via approximate search - before exact reordering is performed; if set, this value must be > - neighbor_count. - leafNodesSearchFraction: - format: double - description: >- - Optional. The fraction of the number of leaves to search, set at - query time allows user to tune search performance. This value - increase result in both search accuracy and latency increase. The - value should be between 0.0 and 1.0. - type: number - id: GoogleCloudAiplatformV1NearestNeighborQueryParameters - description: >- - Parameters that can be overrided in each query to tune query latency and - recall. - GoogleCloudAiplatformV1CancelTuningJobRequest: - properties: {} - id: GoogleCloudAiplatformV1CancelTuningJobRequest - type: object - description: Request message for GenAiTuningService.CancelTuningJob. - GoogleCloudAiplatformV1Dataset: - properties: - metadataArtifact: - readOnly: true + The MIME type of the content of the video. Only the following are + supported: video/mp4 video/avi video/quicktime type: string + timeSegmentStart: description: >- - Output only. The resource name of the Artifact that was created in - MetadataStore when creating the Dataset. The Artifact resource name - pattern is - `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. - encryptionSpec: - description: >- - Customer-managed encryption key spec for a Dataset. If set, this - Dataset and all sub-resources of this Dataset will be secured by - this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - name: + The beginning, inclusive, of the video's time segment on which to + perform the prediction. Expressed as a number of seconds as measured + from the start of the video, with "s" appended at the end. Fractions + are allowed, up to a microsecond precision. type: string - readOnly: true - description: Output only. The resource name of the Dataset. - description: + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance: + description: Spec for question answering correctness instance. + type: object + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance + properties: + reference: type: string - description: The description of the Dataset. - metadataSchemaUri: - description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Dataset. The schema is - defined as an OpenAPI 3.0.2 Schema Object. The schema files that can - be used here are found in - gs://google-cloud-aiplatform/schema/dataset/metadata/. + description: Optional. Ground truth used to compare against the prediction. + prediction: type: string - etag: + description: Required. Output of the evaluated model. + context: type: string - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - dataItemCount: + description: Optional. Text provided as context to answer the question. + instruction: type: string - format: int64 - readOnly: true - description: >- - Output only. The number of DataItems in this Dataset. Only apply for - non-structured Dataset. - savedQueries: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' - type: array description: >- - All SavedQueries belong to the Dataset will be returned in List/Get - Dataset response. The annotation_specs field will not be populated - except for UI cases which will only use annotation_spec_count. In - CreateDataset request, a SavedQuery is created together if this - field is set, up to one SavedQuery can be set in - CreateDatasetRequest. The SavedQuery should not contain any - AnnotationSpec. - displayName: - type: string + Required. The question asked and other instruction in the inference + prompt. + GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity: + type: object + description: >- + Message to select entity. If an entity id is selected, all the feature + values corresponding to the entity id will be deleted, including the + entityId. + properties: + entityIdSelector: description: >- - Required. The user-defined name of the Dataset. The name can be up - to 128 characters long and can consist of any UTF-8 characters. - labels: - additionalProperties: - type: string + Required. Selectors choosing feature values of which entity id to be + deleted from the EntityType. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityIdSelector' + id: GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams: + description: Prediction model parameters for Image Object Detection. + type: object + properties: + confidenceThreshold: description: >- - The labels with user-defined metadata to organize your Datasets. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Dataset (System - labels are excluded). See https://goo.gl/xmQnxf for more information - and examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for each Dataset: * - "aiplatform.googleapis.com/dataset_metadata_schema": output only, - its value is the metadata_schema's title. - type: object - metadata: - type: any - description: Required. Additional information about the Dataset. - modelReference: + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + format: float + type: number + maxPredictions: description: >- - Optional. Reference to the public base model last used by the - dataset. Only set for prompt datasets. - type: string - createTime: - readOnly: true - format: google-datetime - description: Output only. Timestamp when this Dataset was created. - type: string - updateTime: - readOnly: true - description: Output only. Timestamp when this Dataset was last updated. - format: google-datetime - type: string - description: A collection of DataItems and Annotations on them. - id: GoogleCloudAiplatformV1Dataset - type: object - GoogleCloudAiplatformV1WriteFeatureValuesPayload: + The Model only returns up to that many top, by confidence score, + predictions per instance. Note that number of returned predictions + is also limited by metadata's predictionsLimit. Default value is 10. + format: int32 + type: integer + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageObjectDetectionPredictionParams + GoogleCloudAiplatformV1FeatureValueMetadata: + description: Metadata of feature value. type: object + id: GoogleCloudAiplatformV1FeatureValueMetadata properties: - featureValues: - type: object + generateTime: + format: google-datetime description: >- - Required. Feature values to be written, mapping from Feature ID to - value. Up to 100,000 `feature_values` entries may be written across - all payloads. The feature generation time, aligned by days, must be - no older than five years (1825 days) and no later than one year (366 - days) in the future. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - entityId: - description: Required. The ID of the entity. + Feature generation timestamp. Typically, it is provided by user at + feature ingestion time. If not, feature store will use the system + timestamp when the data is ingested into feature store. For + streaming ingestion, the time, aligned by days, must be no older + than five years (1825 days) and no later than one year (366 days) in + the future. type: string - id: GoogleCloudAiplatformV1WriteFeatureValuesPayload - description: Contains Feature values to be written for a specific entity. - GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: + GoogleCloudAiplatformV1EvaluateInstancesRequest: type: object - description: Response message for TensorboardService.WriteTensorboardRunData. - id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse - properties: {} - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: - description: >- - Runtime operation information for - JobService.UpdateModelDeploymentMonitoringJob. - id: >- - GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata + id: GoogleCloudAiplatformV1EvaluateInstancesRequest + properties: + bleuInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInput' + description: Instances and metric spec for bleu metric. + questionAnsweringCorrectnessInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput + description: Input for question answering correctness metric. + summarizationQualityInput: + description: Input for summarization quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityInput + toolParameterKvMatchInput: + description: Input for tool parameter key value match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchInput + pairwiseSummarizationQualityInput: + description: Input for pairwise summarization quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityInput + pairwiseQuestionAnsweringQualityInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput + description: Input for pairwise question answering quality metric. + fulfillmentInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentInput' + description: Input for fulfillment metric. + groundednessInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInput' + description: Input for groundedness metric. + safetyInput: + description: Input for safety metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInput' + pointwiseMetricInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricInput' + description: Input for pointwise metric. + summarizationHelpfulnessInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInput + description: Input for summarization helpfulness metric. + toolNameMatchInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchInput' + description: Input for tool name match metric. + summarizationVerbosityInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInput + description: Input for summarization verbosity metric. + toolCallValidInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInput' + description: Tool call metric instances. Input for tool call valid metric. + questionAnsweringRelevanceInput: + description: Input for question answering relevance metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput + coherenceInput: + description: Input for coherence metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceInput' + exactMatchInput: + description: >- + Auto metric instances. Instances and metric spec for exact match + metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchInput' + questionAnsweringHelpfulnessInput: + description: Input for question answering helpfulness metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput + rougeInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeInput' + description: Instances and metric spec for rouge metric. + pairwiseMetricInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInput' + description: Input for pairwise metric. + questionAnsweringQualityInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityInput + description: Input for question answering quality metric. + toolParameterKeyMatchInput: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchInput + description: Input for tool parameter key match metric. + fluencyInput: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInput' + description: >- + LLM-based metric instance. General text generation metrics, + applicable to other categories. Input for fluency metric. + description: Request message for EvaluationService.EvaluateInstances. + GoogleCloudAiplatformV1SummarizationVerbosityInput: type: object + id: GoogleCloudAiplatformV1SummarizationVerbosityInput properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - GoogleCloudLocationLocation: - id: GoogleCloudLocationLocation + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbositySpec + description: Required. Spec for summarization verbosity score metric. + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityInstance + description: Required. Summarization verbosity instance. + description: Input for summarization verbosity metric. + GoogleCloudAiplatformV1ExactMatchMetricValue: + id: GoogleCloudAiplatformV1ExactMatchMetricValue + properties: + score: + format: float + type: number + description: Output only. Exact match score. + readOnly: true + description: Exact match metric value for an instance. + type: object + GoogleCloudAiplatformV1ListPersistentResourcesResponse: type: object - description: A resource that represents a Google Cloud location. properties: - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - locationId: - type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - name: + persistentResources: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + type: array + nextPageToken: type: string description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - labels: - type: object - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} + A token to retrieve next page of results. Pass to + ListPersistentResourcesRequest.page_token to obtain that page. + id: GoogleCloudAiplatformV1ListPersistentResourcesResponse + description: Response message for PersistentResourceService.ListPersistentResources + GoogleCloudAiplatformV1UndeployModelRequest: + id: GoogleCloudAiplatformV1UndeployModelRequest + description: Request message for EndpointService.UndeployModel. + type: object + properties: + trafficSplit: additionalProperties: - type: string - metadata: + format: int32 + type: integer description: >- - Service-specific metadata. For example the available capacity at the - given location. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + If this field is provided, then the Endpoint's traffic_split will be + overwritten with it. If last DeployedModel is being undeployed from + the Endpoint, the [Endpoint.traffic_split] will always end up empty + when this call returns. A DeployedModel will be successfully + undeployed only if it doesn't have any traffic assigned to it when + this method executes, or if this field unassigns any traffic to it. type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig: - description: >- - Config for migrating AnnotatedDataset in datalabeling.googleapis.com to - Vertex AI's SavedQuery. + deployedModelId: + type: string + description: >- + Required. The ID of the DeployedModel to be undeployed from the + Endpoint. + GoogleCloudAiplatformV1ExplainResponse: + id: GoogleCloudAiplatformV1ExplainResponse properties: - annotatedDataset: + deployedModelId: + description: ID of the Endpoint's DeployedModel that served this explanation. type: string + predictions: + items: + type: any + type: array description: >- - Required. Full resource name of data labeling AnnotatedDataset. - Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig - type: object - GoogleCloudAiplatformV1SuggestTrialsResponse: + The predictions that are the output of the predictions call. Same as + PredictResponse.predictions. + explanations: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + type: array + description: >- + The explanations of the Model's PredictResponse.predictions. It has + the same number of elements as instances to be explained. + description: Response message for PredictionService.Explain. type: object - description: Response message for VizierService.SuggestTrials. - id: GoogleCloudAiplatformV1SuggestTrialsResponse + GoogleCloudAiplatformV1IndexDatapointRestriction: properties: - trials: - description: A list of Trials. + denyList: + items: + type: string + type: array + description: 'The attributes to deny in this namespace. e.g.: ''blue''' + allowList: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' - studyState: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - INACTIVE - - COMPLETED - description: The state of the Study. + type: string + description: 'The attributes to allow in this namespace. e.g.: ''red''' + namespace: type: string - enumDescriptions: - - The study state is unspecified. - - The study is active. - - The study is stopped due to an internal error. - - >- - The study is done when the service exhausts the parameter search - space or max_trial_count is reached. - startTime: + description: 'The namespace of this restriction. e.g.: color.' + type: object + id: GoogleCloudAiplatformV1IndexDatapointRestriction + description: >- + Restriction of a datapoint which describe its attributes(tokens) from + each of several attribute categories(namespaces). + GoogleCloudAiplatformV1SearchNearestEntitiesRequest: + id: GoogleCloudAiplatformV1SearchNearestEntitiesRequest + properties: + query: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighborQuery' + description: Required. The query. + returnFullEntity: + type: boolean + description: >- + Optional. If set to true, the full entities (including all vector + values and metadata) of the nearest neighbors are returned; + otherwise only entity id of the nearest neighbors will be returned. + Note that returning full entities will significantly increase the + latency and cost of the query. + description: The request message for FeatureOnlineStoreService.SearchNearestEntities. + type: object + GoogleCloudAiplatformV1ToolParameterKVMatchInstance: + id: GoogleCloudAiplatformV1ToolParameterKVMatchInstance + type: object + properties: + prediction: + description: Required. Output of the evaluated model. type: string - description: The time at which the operation was started. - format: google-datetime - endTime: + reference: type: string - description: The time at which operation processing completed. - format: google-datetime - GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: + description: Required. Ground truth used to compare against the prediction. + description: Spec for tool parameter key value match instance. + GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: + type: object properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for PersistentResource. - progressMessage: - description: Progress Message for Update LRO - type: string - id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata - description: Details of operations that perform update PersistentResource. - type: object - GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest: + description: Operation metadata for Featurestore export Feature values. + description: Details of operations that exports Features values. + id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata + GoogleCloudAiplatformV1UndeployModelResponse: + id: GoogleCloudAiplatformV1UndeployModelResponse type: object - id: GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest + properties: {} + description: Response message for EndpointService.UndeployModel. + GoogleCloudAiplatformV1StreamingPredictRequest: + id: GoogleCloudAiplatformV1StreamingPredictRequest properties: - requests: + parameters: + description: The parameters that govern the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + inputs: type: array - description: >- - Required. The request message specifying the TensorboardTimeSeries - to create. A maximum of 1000 TensorboardTimeSeries can be created in - a batch. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest - description: Request message for TensorboardService.BatchCreateTensorboardTimeSeries. - GoogleCloudAiplatformV1VideoMetadata: - properties: - startOffset: - description: Optional. The start offset of the video. - format: google-duration - type: string - endOffset: - format: google-duration - type: string - description: Optional. The end offset of the video. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The prediction input. type: object - id: GoogleCloudAiplatformV1VideoMetadata - description: Metadata describes the input video content. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics: - description: Metrics for general pairwise text generation evaluation results. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics + description: >- + Request message for PredictionService.StreamingPredict. The first + message must contain endpoint field and optionally input. The subsequent + messages must contain input. + GoogleCloudAiplatformV1NearestNeighborsNeighbor: + id: GoogleCloudAiplatformV1NearestNeighborsNeighbor properties: - modelWinRate: - format: float + entityKeyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse description: >- - Percentage of time the autorater decided the model had the better - response. + The attributes of the neighbor, e.g. filters, crowding and metadata + Note that full entities are returned only when "return_full_entity" + is set to true. Otherwise, only the "entity_id" and "distance" + fields are populated. + distance: + format: double + description: The distance between the neighbor and the query vector. type: number - falseNegativeCount: + entityId: + type: string + description: The id of the similar entity. + description: A neighbor of the query vector. + type: object + GoogleCloudAiplatformV1ListFeatureGroupsResponse: + id: GoogleCloudAiplatformV1ListFeatureGroupsResponse + properties: + featureGroups: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + description: The FeatureGroups matching the request. + type: array + nextPageToken: type: string - format: int64 - description: >- - Number of examples where the autorater chose the baseline model, but - humans preferred the model. - accuracy: - description: Fraction of cases where the autorater agreed with the human raters. - type: number - format: float - recall: - type: number description: >- - Fraction of cases where the autorater and humans thought the model - had a better response out of all cases where the humans thought the - model had a better response. - format: float - f1Score: - format: float - description: Harmonic mean of precision and recall. - type: number - baselineModelWinRate: + A token, which can be sent as ListFeatureGroupsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + description: Response message for FeatureRegistryService.ListFeatureGroups. + type: object + GoogleCloudAiplatformV1SafetyInput: + type: object + description: Input for safety metric. + properties: + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySpec' + description: Required. Spec for safety metric. + instance: + description: Required. Safety instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyInstance' + id: GoogleCloudAiplatformV1SafetyInput + GoogleCloudAiplatformV1TensorboardRun: + description: >- + TensorboardRun maps to a specific execution of a training job with a + given set of hyperparameter values, model definition, dataset, etc + id: GoogleCloudAiplatformV1TensorboardRun + type: object + properties: + createTime: + description: Output only. Timestamp when this TensorboardRun was created. + format: google-datetime + readOnly: true + type: string + name: + readOnly: true description: >- - Percentage of time the autorater decided the baseline model had the - better response. - type: number - format: float - truePositiveCount: + Output only. Name of the TensorboardRun. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + type: string + updateTime: + type: string + description: Output only. Timestamp when this TensorboardRun was last updated. + format: google-datetime + readOnly: true + displayName: + type: string description: >- - Number of examples where both the autorater and humans decided that - the model had the better response. - format: int64 + Required. User provided name of this TensorboardRun. This value must + be unique among all TensorboardRuns belonging to the same parent + TensorboardExperiment. + etag: type: string - cohensKappa: - format: float - type: number description: >- - A measurement of agreement between the autorater and human raters - that takes the likelihood of random agreement into account. - falsePositiveCount: + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. + description: type: string + description: Description of this TensorboardRun. + labels: + additionalProperties: + type: string + type: object description: >- - Number of examples where the autorater chose the model, but humans - preferred the baseline model. - format: int64 - trueNegativeCount: + The labels with user-defined metadata to organize your + TensorboardRuns. This field will be used to filter and visualize + Runs in the Tensorboard UI. For example, a Vertex AI training job + can set a label aiplatform.googleapis.com/training_job_id=xxxxx to + all the runs created within that job. An end user can set a label + experiment_id=xxxxx for all the runs produced in a Jupyter notebook. + These runs can be grouped by a label value and visualized together + in the Tensorboard UI. Label keys and values can be no longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. No more than 64 user labels can be + associated with one TensorboardRun (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + GoogleCloudAiplatformV1PipelineJobDetail: + description: The runtime detail of PipelineJob. + type: object + id: GoogleCloudAiplatformV1PipelineJobDetail + properties: + taskDetails: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' + description: Output only. The runtime details of the tasks under the pipeline. + readOnly: true + type: array + pipelineContext: + readOnly: true + description: Output only. The context of the pipeline. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + pipelineRunContext: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + readOnly: true + description: Output only. The context of the current pipeline run. + GoogleCloudAiplatformV1ExplanationSpecOverride: + description: >- + The ExplanationSpec entries that can be overridden at online explanation + time. + type: object + properties: + metadata: description: >- - Number of examples where both the autorater and humans decided that - the model had the worse response. - format: int64 + The metadata to be overridden. If not specified, no metadata is + overridden. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOverride + examplesOverride: + description: The example-based explanations parameter overrides. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesOverride' + parameters: + description: >- + The parameters to be overridden. Note that the attribution method + cannot be changed. If not specified, no parameter is overridden. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' + id: GoogleCloudAiplatformV1ExplanationSpecOverride + GoogleCloudAiplatformV1SchemaImageDatasetMetadata: + type: object + properties: + gcsBucket: + description: >- + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. + type: string + dataItemSchemaUri: type: string - humanPreferenceBaselineModelWinRate: - format: float description: >- - Percentage of time humans decided the baseline model had the better - response. + Points to a YAML file stored on Google Cloud Storage describing + payload of the Image DataItems that belong to this Dataset. + id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata + description: The metadata of Datasets that contain Image DataItems. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult: + type: object + description: Spec for question answering helpfulness result. + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult + properties: + explanation: + readOnly: true + type: string + description: Output only. Explanation for question answering helpfulness score. + score: type: number - humanPreferenceModelWinRate: format: float - description: Percentage of time humans decided the model had the better response. - type: number - precision: + readOnly: true + description: Output only. Question Answering Helpfulness score. + confidence: format: float + readOnly: true type: number - description: >- - Fraction of cases where the autorater and humans thought the model - had a better response out of all cases where the autorater thought - the model had a better response. True positive divided by all - positive. + description: Output only. Confidence for question answering helpfulness score. + GoogleCloudAiplatformV1DeployIndexRequest: + description: Request message for IndexEndpointService.DeployIndex. type: object - CloudAiLargeModelsVisionVideo: - id: CloudAiLargeModelsVisionVideo properties: - video: - format: byte - description: Raw bytes. + deployedIndex: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + description: Required. The DeployedIndex to be created within the IndexEndpoint. + id: GoogleCloudAiplatformV1DeployIndexRequest + GoogleCloudAiplatformV1PairwiseSummarizationQualityResult: + type: object + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityResult + description: Spec for pairwise summarization quality result. + properties: + explanation: + readOnly: true type: string - uri: - description: Path to another storage (typically Google Cloud Storage). + description: Output only. Explanation for summarization quality score. + confidence: + readOnly: true + description: Output only. Confidence for summarization quality score. + format: float + type: number + pairwiseChoice: + description: Output only. Pairwise summarization prediction choice. + enum: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + enumDescriptions: + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined + readOnly: true type: string - description: Video + GoogleCloudAiplatformV1ModelBaseModelSource: type: object - GoogleCloudAiplatformV1DeleteFeatureValuesResponse: - description: Response message for FeaturestoreService.DeleteFeatureValues. - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponse + id: GoogleCloudAiplatformV1ModelBaseModelSource + description: >- + User input field to specify the base model source. Currently it only + supports specifing the Model Garden models and Genie models. properties: - selectTimeRangeAndFeature: - description: Response for request specifying time range and feature - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature - selectEntity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity - description: Response for request specifying the entities to delete - type: object - GoogleCloudAiplatformV1Blob: + modelGardenSource: + description: Source information of Model Garden models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' + genieSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' + description: Information about the base model of Genie models. + GoogleCloudAiplatformV1PairwiseMetricInput: type: object properties: - data: - description: Required. Raw bytes. - type: string - format: byte - mimeType: - type: string - description: Required. The IANA standard MIME type of the source data. - description: >- - Content blob. It's preferred to send as text directly rather than raw - bytes. - id: GoogleCloudAiplatformV1Blob - GoogleCloudAiplatformV1LargeModelReference: - description: Contains information about the Large Model. + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricInstance' + description: Required. Pairwise metric instance. + metricSpec: + description: Required. Spec for pairwise metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricSpec' + id: GoogleCloudAiplatformV1PairwiseMetricInput + description: Input for pairwise metric. + GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry: type: object + description: Single source entry for the grounding checking. properties: - name: + type: type: string + enumDescriptions: + - '' + - Uses Web Search to check the grounding. + - >- + Uses Vertex AI Search to check the grounding. Deprecated. Use + VERTEX_AI_SEARCH instead. + - Uses Vertex AI Search to check the grounding + - Uses inline context to check the grounding. + enumDeprecated: + - false + - false + - true + - false + - false + enum: + - UNSPECIFIED + - WEB + - ENTERPRISE + - VERTEX_AI_SEARCH + - INLINE + description: The type of the grounding checking source. + inlineContext: description: >- - Required. The unique name of the large Foundation or pre-built - model. Like "chat-bison", "text-bison". Or model name with version - ID, like "chat-bison@001", "text-bison@005", etc. - id: GoogleCloudAiplatformV1LargeModelReference - GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: - type: object - id: GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig - properties: - leafNodeEmbeddingCount: + The grounding text passed inline with the Predict API. It can + support up to 1 million bytes. + type: string + enterpriseDatastore: + deprecated: true description: >- - Optional. Number of embeddings on each leaf node. The default value - is 1000 if not set. + The uri of the Vertex AI Search data source. Deprecated. Use + vertex_ai_search_datastore instead. type: string - format: int64 - description: Configuration options for the tree-AH algorithm. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: - type: object + vertexAiSearchDatastore: + description: The uri of the Vertex AI Search data source. + type: string + id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry + GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor: properties: - backingHyperparameterTuningJob: - description: >- - The resource name of the HyperparameterTuningJob that has been - created to carry out this HyperparameterTuning task. + id: + description: Feature ID. type: string - bestTrialBackingCustomJob: + type: object + description: Metadata for requested Features. + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor + GoogleLongrunningListOperationsResponse: + type: object + properties: + nextPageToken: type: string + description: The standard List next-page token. + operations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - The resource name of the CustomJob that has been created to run the - best Trial of this HyperparameterTuning task. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata - GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail: - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail + A list of operations that matches the specified filter in the + request. + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + GoogleCloudAiplatformV1ToolCallValidInput: + description: Input for tool call valid metric. type: object properties: - failedJobs: + instances: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidInstance' + description: Required. Repeated tool call valid instances. type: array + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidSpec' + description: Required. Spec for tool call valid metric. + id: GoogleCloudAiplatformV1ToolCallValidInput + GoogleCloudAiplatformV1EvaluateInstancesResponse: + properties: + pairwiseQuestionAnsweringQualityResult: + description: Result for pairwise question answering quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult + rougeResults: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RougeResults' + description: Results for rouge metric. + fluencyResult: + description: >- + LLM-based metric evaluation result. General text generation metrics, + applicable to other categories. Result for fluency metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyResult' + toolNameMatchResults: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolNameMatchResults' + description: Results for tool name match metric. + pointwiseMetricResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PointwiseMetricResult' + description: Generic metrics. Result for pointwise metric. + questionAnsweringRelevanceResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult + description: Result for question answering relevance metric. + pairwiseMetricResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PairwiseMetricResult' + description: Result for pairwise metric. + questionAnsweringQualityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringQualityResult description: >- - Output only. The names of the previously failed CustomJob. The list - includes the all attempts in chronological order. - readOnly: true - items: - type: string - job: - description: Output only. The name of the CustomJob. - readOnly: true - type: string - description: The detailed info for a custom job executor. - GoogleCloudAiplatformV1ImportDataConfig: + Question answering only metrics. Result for question answering + quality metric. + summarizationVerbosityResult: + description: Result for summarization verbosity metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationVerbosityResult + summarizationQualityResult: + description: Summarization only metrics. Result for summarization quality metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationQualityResult + groundednessResult: + description: Result for groundedness metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessResult' + exactMatchResults: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchResults' + description: Auto metric evaluation results. Results for exact match metric. + bleuResults: + description: Results for bleu metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuResults' + toolParameterKeyMatchResults: + description: Results for tool parameter key match metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKeyMatchResults + coherenceResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CoherenceResult' + description: Result for coherence metric. + fulfillmentResult: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FulfillmentResult' + description: Result for fulfillment metric. + questionAnsweringCorrectnessResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult + description: Result for question answering correctness metric. + pairwiseSummarizationQualityResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseSummarizationQualityResult + description: Result for pairwise summarization quality metric. + toolCallValidResults: + description: Tool call metrics. Results for tool call valid metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolCallValidResults' + toolParameterKvMatchResults: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchResults + description: Results for tool parameter key value match metric. + questionAnsweringHelpfulnessResult: + description: Result for question answering helpfulness metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessResult + summarizationHelpfulnessResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessResult + description: Result for summarization helpfulness metric. + safetyResult: + description: Result for safety metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyResult' + type: object + id: GoogleCloudAiplatformV1EvaluateInstancesResponse + description: Response message for EvaluationService.EvaluateInstances. + GoogleCloudAiplatformV1FilterSplit: + id: GoogleCloudAiplatformV1FilterSplit type: object - id: GoogleCloudAiplatformV1ImportDataConfig + description: >- + Assigns input data to training, validation, and test sets based on the + given filters, data pieces not matched by any filter are ignored. + Currently only supported for Datasets containing DataItems. If any of + the filters in this message are to match nothing, then they can be set + as '-' (the minus sign). Supported only for unstructured Datasets. properties: - annotationLabels: - additionalProperties: - type: string + validationFilter: + type: string description: >- - Labels that will be applied to newly imported Annotations. If two - Annotations are identical, one of them will be deduped. Two - Annotations are considered identical if their payload, - payload_schema_uri and all of their labels are the same. These - labels will be overridden by Annotation labels specified inside - index file referenced by import_schema_uri, e.g. jsonl file. - type: object - gcsSource: - description: The Google Cloud Storage location for the input content. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - importSchemaUri: + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to validate the Model. A filter with same + syntax as the one used in DatasetService.ListDataItems may be used. + If a single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + testFilter: type: string description: >- - Required. Points to a YAML file stored on Google Cloud Storage - describing the import format. Validation will be done against the - schema. The schema is defined as an [OpenAPI 3.0.2 Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - dataItemLabels: - type: object - additionalProperties: - type: string + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to test the Model. A filter with same syntax as + the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + trainingFilter: description: >- - Labels that will be applied to newly imported DataItems. If an - identical DataItem as one being imported already exists in the - Dataset, then these labels will be appended to these of the already - existing one, and if labels with identical key is imported before, - the old label value will be overwritten. If two DataItems are - identical in the same import data operation, the labels will be - combined and if key collision happens in this case, one of the - values will be picked randomly. Two DataItems are considered - identical if their content bytes are identical (e.g. image bytes or - pdf bytes). These labels will be overridden by Annotation labels - specified inside index file referenced by import_schema_uri, e.g. - jsonl file. - description: >- - Describes the location from where we import data into a Dataset, - together with the labels that will be applied to the DataItems and the - Annotations. - GoogleCloudAiplatformV1DatasetVersion: + Required. A filter on DataItems of the Dataset. DataItems that match + this filter are used to train the Model. A filter with same syntax + as the one used in DatasetService.ListDataItems may be used. If a + single DataItem is matched by more than one of the FilterSplit + filters, then it is assigned to the first set that applies to it in + the training, validation, test order. + type: string + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics + properties: + videoActionMetrics: + type: array + description: 'The metric entries for precision window lengths: 1s,2s,3s.' + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics + evaluatedActionCount: + format: int32 + type: integer + description: The number of ground truth actions used to create this evaluation. type: object - id: GoogleCloudAiplatformV1DatasetVersion + description: Model evaluation metrics for video action recognition. + GoogleCloudAiplatformV1MigratableResource: + id: GoogleCloudAiplatformV1MigratableResource + type: object + description: >- + Represents one resource that exists in automl.googleapis.com, + datalabeling.googleapis.com or ml.googleapis.com. properties: - metadata: - type: any + dataLabelingDataset: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceDataLabelingDataset + description: Output only. Represents one Dataset in datalabeling.googleapis.com. readOnly: true - description: >- - Required. Output only. Additional information about the - DatasetVersion. - etag: - description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. - type: string - modelReference: - description: >- - Output only. Reference to the public base model last used by the - dataset version. Only set for prompt dataset versions. - type: string + automlModel: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlModel readOnly: true - bigQueryDatasetName: - description: Output only. Name of the associated BigQuery dataset. + description: Output only. Represents one Model in automl.googleapis.com. + mlEngineModelVersion: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion readOnly: true + description: Output only. Represents one Version in ml.googleapis.com. + lastMigrateTime: type: string - name: readOnly: true - description: Output only. The resource name of the DatasetVersion. - type: string - displayName: - type: string description: >- - The user-defined name of the DatasetVersion. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - createTime: - type: string - description: Output only. Timestamp when this DatasetVersion was created. - readOnly: true + Output only. Timestamp when the last migration attempt on this + MigratableResource started. Will not be set if there's no migration + attempt on this MigratableResource. format: google-datetime - updateTime: + lastUpdateTime: readOnly: true - description: Output only. Timestamp when this DatasetVersion was last updated. type: string format: google-datetime - description: Describes the dataset version. - GoogleCloudAiplatformV1FeatureValueMetadata: - properties: - generateTime: - format: google-datetime - type: string - description: >- - Feature generation timestamp. Typically, it is provided by user at - feature ingestion time. If not, feature store will use the system - timestamp when the data is ingested into feature store. For - streaming ingestion, the time, aligned by days, must be no older - than five years (1825 days) and no later than one year (366 days) in - the future. - id: GoogleCloudAiplatformV1FeatureValueMetadata - type: object - description: Metadata of feature value. - GoogleCloudAiplatformV1ReinforcementLearningDataStats: - type: object - id: GoogleCloudAiplatformV1ReinforcementLearningDataStats - properties: - preferenceDatasetStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' - description: >- - Output only. Statistics computed for the preference dataset. This - can be either a human preference dataset or a preference dataset - generated from AI feedback. - readOnly: true - promptDatasetStats: description: >- - Output only. Statistics computed for the prompt dataset used during - reinforcement learning. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' + Output only. Timestamp when this MigratableResource was last + updated. + automlDataset: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigratableResourceAutomlDataset readOnly: true - description: Statistics computed for datasets used for reinforcement learning. - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult: + description: Output only. Represents one Dataset in automl.googleapis.com. + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource: + type: object properties: - timeSegmentEnd: + uri: type: string - format: google-duration - description: >- - The end, exclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. Note that - for 'segment-classification' prediction type, this equals the - original 'timeSegmentEnd' from the input instance, for other types - it is the end of a shot or a 1 second interval respectively. - timeSegmentStart: + description: The URI of a BigQuery table. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + GoogleCloudAiplatformV1RougeSpec: + type: object + description: >- + Spec for rouge score metric - calculates the recall of n-grams in + prediction as compared to reference - returns a score ranging between 0 + and 1. + id: GoogleCloudAiplatformV1RougeSpec + properties: + splitSummaries: + type: boolean + description: Optional. Whether to split summaries while using rougeLsum. + rougeType: description: >- - The beginning, inclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. Note that - for 'segment-classification' prediction type, this equals the - original 'timeSegmentStart' from the input instance, for other types - it is the start of a shot or a 1 second interval respectively. - format: google-duration + Optional. Supported rouge types are rougen[1-9], rougeL, and + rougeLsum. type: string - type: + useStemmer: + type: boolean + description: Optional. Whether to use stemmer to compute rouge score. + GoogleCloudAiplatformV1Presets: + type: object + description: Preset configuration for example-based explanations + id: GoogleCloudAiplatformV1Presets + properties: + modality: + enumDescriptions: + - Should not be set. Added as a recommended best practice for enums + - IMAGE modality + - TEXT modality + - TABULAR modality description: >- - The type of the prediction. The requested types can be configured - via parameters. This will be one of - segment-classification - - shot-classification - one-sec-interval-classification + The modality of the uploaded model, which automatically configures + the distance measurement and feature normalization for the + underlying example index and queries. If your model does not + precisely fit one of these types, it is okay to choose the closest + type. + enum: + - MODALITY_UNSPECIFIED + - IMAGE + - TEXT + - TABULAR type: string - confidence: - type: number + query: + enumDescriptions: + - More precise neighbors as a trade-off against slower response. + - Faster response as a trade-off against less precise neighbors. description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - format: float - displayName: + Preset option controlling parameters for speed-precision trade-off + when querying for examples. If omitted, defaults to `PRECISE`. type: string - description: The display name of the AnnotationSpec that had been identified. - id: + enum: + - PRECISE + - FAST + GoogleCloudAiplatformV1DirectRawPredictResponse: + id: GoogleCloudAiplatformV1DirectRawPredictResponse + properties: + output: + format: byte + description: The prediction output. type: string - description: The resource ID of the AnnotationSpec that had been identified. - description: Prediction output format for Video Classification. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoClassificationPredictionResult + description: Response message for PredictionService.DirectRawPredict. type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs - description: The input parameters of this TrainingJob. + GoogleCloudAiplatformV1PurgeExecutionsMetadata: + description: Details of operations that perform MetadataService.PurgeExecutions. + id: GoogleCloudAiplatformV1PurgeExecutionsMetadata type: object - description: >- - A TrainingJob that trains and uploads an AutoML Video ObjectTracking - Model. - GoogleCloudAiplatformV1PipelineTaskDetailArtifactList: - id: GoogleCloudAiplatformV1PipelineTaskDetailArtifactList properties: - artifacts: - description: Output only. A list of artifact metadata. + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for purging Executions. + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult: + description: Prediction output format for Text Extraction. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextExtractionPredictionResult + properties: + displayNames: + description: >- + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. + items: + type: string + type: array + ids: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - readOnly: true - description: A list of artifact metadata. - type: object - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: - description: Represents a polyline in image. - properties: - vertexes: + format: int64 + type: string description: >- - The vertexes are connected one by one and the last vertex in not - connected to the first one. + The resource IDs of the AnnotationSpecs that had been identified, + ordered by the confidence score descendingly. + textSegmentEndOffsets: + type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' + format: int64 + type: string + description: >- + The end offsets, inclusive, of the text segment in which the + AnnotationSpec has been identified. Expressed as a zero-based number + of characters as measured from the start of the text snippet. + textSegmentStartOffsets: + items: + type: string + format: int64 type: array - displayName: - type: string description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - annotationSpecId: + The start offsets, inclusive, of the text segment in which the + AnnotationSpec has been identified. Expressed as a zero-based number + of characters as measured from the start of the text snippet. + confidences: + items: + format: float + type: number description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation - type: object - GoogleCloudAiplatformV1FeatureValue: + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + type: array type: object + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec properties: - structValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructValue' - description: A struct type feature value. - bytesValue: - type: string - description: Bytes feature value. - format: byte - doubleArrayValue: - description: A list of double type feature value. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DoubleArray' - int64Value: - format: int64 - description: Int64 feature value. - type: string - metadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueMetadata' - description: Metadata of feature value. - stringArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StringArray' - description: A list of string type feature value. - doubleValue: - format: double - type: number - description: Double type feature value. - int64ArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Int64Array' - description: A list of int64 type feature value. - stringValue: + trainTrialSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + description: >- + Spec for train trials. Top N + [TrainTrialSpec.max_parallel_trial_count] search trials will be + trained for every M [TrainTrialSpec.frequency] trials searched. + searchTrialSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec + description: Required. Spec for search trials. + multiTrialAlgorithm: + enumDescriptions: + - Defaults to `REINFORCEMENT_LEARNING`. + - >- + The Reinforcement Learning Algorithm for Multi-trial Neural + Architecture Search (NAS). + - >- + The Grid Search Algorithm for Multi-trial Neural Architecture + Search (NAS). + description: >- + The multi-trial Neural Architecture Search (NAS) algorithm type. + Defaults to `REINFORCEMENT_LEARNING`. type: string - description: String feature value. - boolValue: - description: Bool type feature value. - type: boolean - boolArrayValue: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BoolArray' - description: A list of bool type feature value. - description: Value for a feature. - id: GoogleCloudAiplatformV1FeatureValue - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: + enum: + - MULTI_TRIAL_ALGORITHM_UNSPECIFIED + - REINFORCEMENT_LEARNING + - GRID_SEARCH + metric: + description: >- + Metric specs for the NAS job. Validation for this field is done at + `multi_trial_algorithm_spec` field. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + type: object + description: The spec of multi-trial Neural Architecture Search (NAS). + GoogleCloudAiplatformV1TokensInfo: + description: >- + Tokens info with a list of tokens and the corresponding list of token + ids. + id: GoogleCloudAiplatformV1TokensInfo properties: - artifacts: + tokenIds: items: type: string + format: int64 + description: A list of token ids from the input. type: array - description: >- - The resource names of the Artifacts to attribute to the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` - executions: + tokens: + description: A list of tokens from the input. items: type: string + format: byte type: array + role: + type: string description: >- - The resource names of the Executions to associate with the Context. - Format: - `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` - description: Request message for MetadataService.AddContextArtifactsAndExecutions. - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + Optional. Optional fields for the role from the corresponding + Content. type: object - GoogleCloudAiplatformV1PrivateServiceConnectConfig: + GoogleCloudAiplatformV1ResourceRuntimeSpec: properties: - projectAllowlist: - type: array + serviceAccountSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' description: >- - A list of Projects from which the forwarding rule will target the - service attachment. - items: - type: string - enablePrivateServiceConnect: - type: boolean + Optional. Configure the use of workload identity on the + PersistentResource + raySpec: description: >- - Required. If true, expose the IndexEndpoint via private service - connect. - description: Represents configuration for private service connect. - type: object - id: GoogleCloudAiplatformV1PrivateServiceConnectConfig - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata: + Optional. Ray cluster configuration. Required when creating a + dedicated RayCluster on the PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' type: object - description: Model metadata specific to AutoML Tables. - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata + id: GoogleCloudAiplatformV1ResourceRuntimeSpec + description: >- + Configuration for the runtime on a PersistentResource instance, + including but not limited to: * Service accounts used to run the + workloads. * Whether to make it a dedicated Ray Cluster. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation: + description: >- + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the timestamp as + a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. properties: - evaluatedDataItemsBigqueryUri: + columnName: + type: string + timeFormat: type: string - description: BigQuery destination uri for exported evaluated examples. - trainCostMilliNodeHours: description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - format: int64 + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + type: object + GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: + id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for PersistentResource. + progressMessage: type: string - GoogleCloudAiplatformV1TrialParameter: - description: A message representing a parameter to be tuned. - id: GoogleCloudAiplatformV1TrialParameter + description: Progress Message for Reboot LRO + description: Details of operations that perform reboot PersistentResource. + type: object + GoogleCloudAiplatformV1WriteFeatureValuesPayload: type: object properties: - value: - readOnly: true + featureValues: description: >- - Output only. The value of the parameter. `number_value` will be set - if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' - or 'DISCRETE'. `string_value` will be set if a parameter defined in - StudySpec is in type 'CATEGORICAL'. - type: any - parameterId: + Required. Feature values to be written, mapping from Feature ID to + value. Up to 100,000 `feature_values` entries may be written across + all payloads. The feature generation time, aligned by days, must be + no older than five years (1825 days) and no later than one year (366 + days) in the future. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + entityId: + type: string + description: Required. The ID of the entity. + id: GoogleCloudAiplatformV1WriteFeatureValuesPayload + description: Contains Feature values to be written for a specific entity. + GoogleCloudAiplatformV1UnmanagedContainerModel: + id: GoogleCloudAiplatformV1UnmanagedContainerModel + description: >- + Contains model information necessary to perform batch prediction without + requiring a full model import. + properties: + predictSchemata: + description: Contains the schemata used in Model's predictions and explanations + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + containerSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' description: >- - Output only. The ID of the parameter. The parameter should be - defined in StudySpec's Parameters. - readOnly: true + Input only. The specification of the container that is to be used + when deploying this Model. + artifactUri: + description: >- + The path to the directory containing the Model artifact and any of + its supporting files. type: string - GoogleCloudAiplatformV1ReadIndexDatapointsResponse: type: object + GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling properties: - datapoints: + cpuUtilizationTarget: + description: >- + Optional. A percentage of the cluster's CPU capacity. Can be from + 10% to 80%. When a cluster's CPU utilization exceeds the target that + you have set, Bigtable immediately adds nodes to the cluster. When + CPU utilization is substantially lower than the target, Bigtable + removes nodes. If not set will default to 50%. + type: integer + format: int32 + minNodeCount: + type: integer + format: int32 + description: >- + Required. The minimum number of nodes to scale down to. Must be + greater than or equal to 1. + maxNodeCount: + description: >- + Required. The maximum number of nodes to scale up to. Must be + greater than or equal to min_node_count, and less than or equal to + 10 times of 'min_node_count'. + format: int32 + type: integer + type: object + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest: + description: Request message for ModelService.BatchImportModelEvaluationSlices + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesRequest + properties: + modelEvaluationSlices: type: array - description: The result list of datapoints. + description: Required. Model evaluation slice resource to be imported. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - id: GoogleCloudAiplatformV1ReadIndexDatapointsResponse - description: The response message for MatchService.ReadIndexDatapoints. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation - properties: - columnName: - type: string - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' type: object - GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: - description: Details of operations that perform batch create Features. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature. + GoogleCloudAiplatformV1SchemaVideoDataItem: type: object - id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata - GoogleCloudAiplatformV1StudyTimeConstraint: - description: Time-based Constraint for Study - id: GoogleCloudAiplatformV1StudyTimeConstraint + description: Payload of Video DataItem. + id: GoogleCloudAiplatformV1SchemaVideoDataItem properties: - maxDuration: - description: Counts the wallclock time passed since the creation of this Study. + mimeType: + readOnly: true type: string - format: google-duration - endTime: - format: google-datetime - description: Compares the wallclock time to this time. Must use UTC timezone. + description: >- + Output only. The mime type of the content of the video. Only the + videos in below listed mime types are supported. Supported + mime_type: - video/mp4 - video/avi - video/quicktime + gcsUri: + description: >- + Required. Google Cloud Storage URI points to the original video in + user's bucket. The video is up to 50 GB in size and up to 3 hour in + duration. type: string - type: object - GoogleCloudAiplatformV1FetchFeatureValuesResponse: - id: GoogleCloudAiplatformV1FetchFeatureValuesResponse + GoogleCloudAiplatformV1BigQueryDestination: + description: The BigQuery location for the output content. properties: - protoStruct: - type: object - description: Feature values in proto Struct format. - additionalProperties: - description: Properties of the object. - type: any - dataKey: + outputUri: + type: string description: >- - The data key associated with this response. Will only be populated - for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' - keyValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList - description: Feature values in KeyValue format. - type: object - description: Response message for FeatureOnlineStoreService.FetchFeatureValues - GoogleCloudAiplatformV1ImportModelEvaluationRequest: + Required. BigQuery URI to a project or table, up to 2000 characters + long. When only the project is specified, the Dataset and Table is + created. When the full table reference is specified, the Dataset + must exist and table must not exist. Accepted forms: * BigQuery + path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` + or `bq://projectId.bqDatasetId.bqTableId`. + id: GoogleCloudAiplatformV1BigQueryDestination type: object - description: Request message for ModelService.ImportModelEvaluation + GoogleCloudAiplatformV1EntityIdSelector: properties: - modelEvaluation: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' - description: Required. Model evaluation resource to be imported. - id: GoogleCloudAiplatformV1ImportModelEvaluationRequest - GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec: - description: The min/max number of replicas allowed if enabling autoscaling + csvSource: + description: Source of Csv + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + entityIdField: + type: string + description: >- + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. + description: Selector for entityId. Getting ids from the given source. + type: object + id: GoogleCloudAiplatformV1EntityIdSelector + GoogleCloudAiplatformV1Value: type: object - id: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec properties: - maxReplicaCount: - format: int64 - description: >- - Optional. max replicas in the node pool, must be ≥ replica_count and - > min_replica_count or will throw error + intValue: type: string - minReplicaCount: - description: >- - Optional. min replicas in the node pool, must be ≤ replica_count and - < max_replica_count or will throw error format: int64 + description: An integer value. + stringValue: + description: A string value. type: string - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: + doubleValue: + type: number + format: double + description: A double value. + id: GoogleCloudAiplatformV1Value + description: Value is the value of the field. + GoogleCloudAiplatformV1SchemaVideoDatasetMetadata: properties: - nextPageToken: + gcsBucket: + type: string description: >- - A token, which can be sent as page_token to retrieve the next page. - If this field is omitted, there are no subsequent pages. + Google Cloud Storage Bucket name that contains the blob data of this + Dataset. + dataItemSchemaUri: type: string - timeSeriesDataPoints: - description: The returned time series data points. + description: >- + Points to a YAML file stored on Google Cloud Storage describing + payload of the Video DataItems that belong to this Dataset. + type: object + description: The metadata of Datasets that contain Video DataItems. + id: GoogleCloudAiplatformV1SchemaVideoDatasetMetadata + GoogleCloudAiplatformV1LineageSubgraph: + type: object + description: >- + A subgraph of the overall lineage graph. Event edges connect Artifact + and Execution nodes. + id: GoogleCloudAiplatformV1LineageSubgraph + properties: + events: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' + description: The Event edges between Artifacts and Executions in the subgraph. type: array - description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. - type: object - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig: + artifacts: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + description: The Artifact nodes in the subgraph. + type: array + executions: + description: The Execution nodes in the subgraph. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + GoogleCloudAiplatformV1ListMetadataSchemasResponse: + id: GoogleCloudAiplatformV1ListMetadataSchemasResponse type: object properties: - defaultDriftThreshold: - description: >- - Drift anomaly detection threshold used by all features. When the - per-feature thresholds are not set, this field can be used to - specify a threshold for all features. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - attributionScoreDriftThresholds: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + metadataSchemas: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + description: The MetadataSchemas found for the MetadataStore. + nextPageToken: + type: string description: >- - Key is the feature name and value is the threshold. The threshold - here is against attribution score distance between different time - windows. - type: object - driftThresholds: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - description: >- - Key is the feature name and value is the threshold. If a feature - needs to be monitored for drift, a value threshold must be - configured for that feature. The threshold here is against feature - distribution distance between different time windws. - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig - description: The config for Prediction data drift detection. - GoogleCloudAiplatformV1CsvSource: - id: GoogleCloudAiplatformV1CsvSource - description: The storage details for CSV input content. + A token, which can be sent as ListMetadataSchemasRequest.page_token + to retrieve the next page. If this field is not populated, there are + no subsequent pages. + description: Response message for MetadataService.ListMetadataSchemas. + GoogleCloudAiplatformV1AddExecutionEventsResponse: + properties: {} + id: GoogleCloudAiplatformV1AddExecutionEventsResponse + type: object + description: Response message for MetadataService.AddExecutionEvents. + GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: + id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse + description: Response message for TensorboardService.BatchCreateTensorboardRuns. + type: object properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: Required. Google Cloud Storage location. + tensorboardRuns: + type: array + description: The created TensorboardRuns. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + id: >- + GoogleCloudAiplatformV1UpdateModelDeploymentMonitoringJobOperationMetadata + description: >- + Runtime operation information for + JobService.UpdateModelDeploymentMonitoringJob. type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics: - description: Metrics for a single confidence threshold. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata: id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata + type: object properties: - precision: - type: number - description: Precision under the given confidence threshold. - format: float - f1Score: - format: float - description: The harmonic mean of recall and precision. - type: number - confidenceThreshold: - description: The confidence threshold value used to compute the metrics. - format: float - type: number - recall: - format: float - type: number - description: Recall under the given confidence threshold. + bestTrialBackingCustomJob: + type: string + description: >- + The resource name of the CustomJob that has been created to run the + best Trial of this HyperparameterTuning task. + backingHyperparameterTuningJob: + type: string + description: >- + The resource name of the HyperparameterTuningJob that has been + created to carry out this HyperparameterTuning task. + GoogleCloudAiplatformV1PairwiseMetricSpec: type: object - GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: - id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata + properties: + metricPromptTemplate: + description: Required. Metric prompt template for pairwise metric. + type: string + id: GoogleCloudAiplatformV1PairwiseMetricSpec + description: Spec for pairwise metric. + GoogleCloudAiplatformV1ResourcesConsumed: + properties: + replicaHours: + format: double + readOnly: true + type: number + description: >- + Output only. The number of replica hours used. Note that many + replicas may run in parallel, and additionally any given work may be + queued for some time. Therefore this value is not strictly related + to wall time. + id: GoogleCloudAiplatformV1ResourcesConsumed type: object - description: Details of operations that perform create PersistentResource. + description: Statistics information about resource consumption. + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: properties: - progressMessage: + annotatedDatasetDisplayName: type: string - description: Progress Message for Create LRO - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for PersistentResource. - GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: - description: Response message for ModelService.BatchImportModelEvaluationSlices + description: The AnnotatedDataset's display name in datalabeling.googleapis.com. + annotatedDataset: + type: string + description: >- + Full resource name of data labeling AnnotatedDataset. Format: + `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. + type: object + description: Represents one AnnotatedDataset in datalabeling.googleapis.com. + id: >- + GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation: properties: - importedModelEvaluationSlices: + annotationSpecColors: + description: The mapping between color and AnnotationSpec for this Annotation. items: - type: string - readOnly: true - description: Output only. List of imported ModelEvaluationSlice.name. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaAnnotationSpecColor type: array + maskGcsUri: + description: >- + Google Cloud Storage URI that points to the mask image. The image + must be in PNG format. It must have the same size as the DataItem's + image. Each pixel in the image mask represents the AnnotationSpec + which the pixel in the image DataItem belong to. Each color is + mapped to one AnnotationSpec based on annotation_spec_colors. + type: string + id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation type: object - id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse - GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse: + description: The mask based segmentation annotation. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics: + type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics properties: - featureOnlineStores: - description: The FeatureOnlineStores matching the request. + bleu: + description: >- + BLEU (bilingual evaluation understudy) scores based on sacrebleu + implementation. + type: number + format: float + rougeLSum: + type: number + format: float + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. + GoogleCloudAiplatformV1WriteTensorboardRunDataResponse: + description: Response message for TensorboardService.WriteTensorboardRunData. + properties: {} + id: GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + type: object + GoogleCloudAiplatformV1ListDataLabelingJobsResponse: + type: object + description: Response message for JobService.ListDataLabelingJobs. + properties: + dataLabelingJobs: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + description: >- + A list of DataLabelingJobs that matches the specified filter in the + request. type: array nextPageToken: - description: >- - A token, which can be sent as - ListFeatureOnlineStoresRequest.page_token to retrieve the next page. - If this field is omitted, there are no subsequent pages. type: string + description: The standard List next-page token. + id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse + GoogleCloudAiplatformV1AvroSource: + description: The storage details for Avro input content. + id: GoogleCloudAiplatformV1AvroSource + properties: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: Required. Google Cloud Storage location. type: object + GoogleCloudAiplatformV1Examples: description: >- - Response message for - FeatureOnlineStoreAdminService.ListFeatureOnlineStores. - id: GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse - GoogleCloudAiplatformV1ImportFeatureValuesRequest: + Example-based explainability that returns the nearest neighbors from the + provided dataset. + type: object properties: - avroSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' - featureTimeField: + nearestNeighborSearchConfig: description: >- - Source column that holds the Feature timestamp for all Feature - values in each entity. - type: string - entityIdField: + The full configuration for the generated index, the semantics are + the same as metadata and should match + [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). + type: any + neighborCount: + format: int32 + description: The number of neighbors to return when querying for examples. + type: integer + exampleGcsSource: + description: The Cloud Storage input instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExamplesExampleGcsSource' + presets: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Presets' description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. - type: string - disableOnlineServing: - type: boolean + Simplified preset configuration, which automatically sets + configuration values based on the desired query speed-precision + trade-off and modality. + id: GoogleCloudAiplatformV1Examples + GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + type: object + description: Runtime operation information for UpdateDeploymentResourcePool method. + id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata + GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: + properties: + indexDisplayNameMapping: + type: any description: >- - If set, data will not be imported for online serving. This is - typically used for backfilling, where Feature generation timestamps - are not in the timestamp range needed for online serving. - disableIngestionAnalysis: - description: If true, API doesn't start ingestion analysis pipeline. - type: boolean - featureTime: + Static mapping between the index and display name. Use this if the + outputs are a deterministic n-dimensional array, e.g. a list of + scores of all the classes in a pre-defined order for a + multi-classification Model. It's not feasible if the outputs are + non-deterministic, e.g. the Model produces top-k classes or sort the + outputs by their values. The shape of the value must be an + n-dimensional array of strings. The number of dimensions must match + that of the outputs to be explained. The + Attribution.output_display_name is populated by locating in the + mapping with Attribution.output_index. + displayNameMappingKey: description: >- - Single Feature timestamp for all entities being imported. The - timestamp must not have higher than millisecond precision. - format: google-datetime + Specify a field name in the prediction to look for the display name. + Use this if the prediction contains the display names for the + outputs. The display names in the prediction must have the same + shape of the outputs, so that it can be located by + Attribution.output_index for a specific output. type: string - bigquerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - csvSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - workerCount: - type: integer + outputTensorName: description: >- - Specifies the number of workers that are used to write data to the - Featurestore. Consider the online serving capacity that you require - to achieve the desired import throughput without interfering with - online serving. The value must be positive, and less than or equal - to 100. If not set, defaults to using 1 worker. The low count - ensures minimal impact on online serving performance. - format: int32 - featureSpecs: + Name of the output tensor. Required and is only applicable to Vertex + AI provided images for Tensorflow. + type: string + id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata + type: object + description: Metadata of the prediction output to be explained. + GoogleCloudAiplatformV1Candidate: + properties: + safetyRatings: description: >- - Required. Specifications defining which Feature values to import - from the entity. The request fails if no feature_specs are provided, - and having multiple feature_specs for one Feature is not allowed. + Output only. List of ratings for the safety of a response candidate. + There is at most one rating per category. + readOnly: true items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' type: array - id: GoogleCloudAiplatformV1ImportFeatureValuesRequest - type: object - description: Request message for FeaturestoreService.ImportFeatureValues. - GoogleCloudAiplatformV1SchemaPredictionResultError: - properties: - message: - description: Error message with additional details. - type: string - status: + avgLogprobs: + description: Output only. Average log probability score of the candidate. + type: number + readOnly: true + format: double + finishMessage: + readOnly: true type: string description: >- - Error status. This will be serialized into the enum name e.g. - "NOT_FOUND". - enum: - - OK - - CANCELLED - - UNKNOWN - - INVALID_ARGUMENT - - DEADLINE_EXCEEDED - - NOT_FOUND - - ALREADY_EXISTS - - PERMISSION_DENIED - - UNAUTHENTICATED - - RESOURCE_EXHAUSTED - - FAILED_PRECONDITION - - ABORTED - - OUT_OF_RANGE - - UNIMPLEMENTED - - INTERNAL - - UNAVAILABLE - - DATA_LOSS + Output only. Describes the reason the mode stopped generating tokens + in more detail. This is only filled when `finish_reason` is set. + index: + description: Output only. Index of the candidate. + readOnly: true + format: int32 + type: integer + groundingMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' + readOnly: true + description: >- + Output only. Metadata specifies sources used to ground generated + content. + finishReason: + description: >- + Output only. The reason why the model stopped generating tokens. If + empty, the model has not stopped generating the tokens. enumDescriptions: - - 'Not an error; returned on success. HTTP Mapping: 200 OK' - - >- - The operation was cancelled, typically by the caller. HTTP - Mapping: 499 Client Closed Request - - >- - Unknown error. For example, this error may be returned when a - `Status` value received from another address space belongs to an - error space that is not known in this address space. Also errors - raised by APIs that do not return enough error information may be - converted to this error. HTTP Mapping: 500 Internal Server Error - - >- - The client specified an invalid argument. Note that this differs - from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments - that are problematic regardless of the state of the system (e.g., - a malformed file name). HTTP Mapping: 400 Bad Request - - >- - The deadline expired before the operation could complete. For - operations that change the state of the system, this error may be - returned even if the operation has completed successfully. For - example, a successful response from a server could have been - delayed long enough for the deadline to expire. HTTP Mapping: 504 - Gateway Timeout - - >- - Some requested entity (e.g., file or directory) was not found. - Note to server developers: if a request is denied for an entire - class of users, such as gradual feature rollout or undocumented - allowlist, `NOT_FOUND` may be used. If a request is denied for - some users within a class of users, such as user-based access - control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not - Found - - >- - The entity that a client attempted to create (e.g., file or - directory) already exists. HTTP Mapping: 409 Conflict - - >- - The caller does not have permission to execute the specified - operation. `PERMISSION_DENIED` must not be used for rejections - caused by exhausting some resource (use `RESOURCE_EXHAUSTED` - instead for those errors). `PERMISSION_DENIED` must not be used if - the caller can not be identified (use `UNAUTHENTICATED` instead - for those errors). This error code does not imply the request is - valid or the requested entity exists or satisfies other - pre-conditions. HTTP Mapping: 403 Forbidden - - >- - The request does not have valid authentication credentials for the - operation. HTTP Mapping: 401 Unauthorized - - >- - Some resource has been exhausted, perhaps a per-user quota, or - perhaps the entire file system is out of space. HTTP Mapping: 429 - Too Many Requests - - >- - The operation was rejected because the system is not in a state - required for the operation's execution. For example, the directory - to be deleted is non-empty, an rmdir operation is applied to a - non-directory, etc. Service implementors can use the following - guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and - `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just - the failing call. (b) Use `ABORTED` if the client should retry at - a higher level. For example, when a client-specified test-and-set - fails, indicating the client should restart a read-modify-write - sequence. (c) Use `FAILED_PRECONDITION` if the client should not - retry until the system state has been explicitly fixed. For - example, if an "rmdir" fails because the directory is non-empty, - `FAILED_PRECONDITION` should be returned since the client should - not retry unless the files are deleted from the directory. HTTP - Mapping: 400 Bad Request + - The finish reason is unspecified. - >- - The operation was aborted, typically due to a concurrency issue - such as a sequencer check failure or transaction abort. See the - guidelines above for deciding between `FAILED_PRECONDITION`, - `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + Token generation reached a natural stopping point or a configured + stop sequence. + - Token generation reached the configured maximum output tokens. - >- - The operation was attempted past the valid range. E.g., seeking or - reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error - indicates a problem that may be fixed if the system state changes. - For example, a 32-bit file system will generate `INVALID_ARGUMENT` - if asked to read at an offset that is not in the range [0,2^32-1], - but it will generate `OUT_OF_RANGE` if asked to read from an - offset past the current file size. There is a fair bit of overlap - between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend - using `OUT_OF_RANGE` (the more specific error) when it applies so - that callers who are iterating through a space can easily look for - an `OUT_OF_RANGE` error to detect when they are done. HTTP - Mapping: 400 Bad Request + Token generation stopped because the content potentially contains + safety violations. NOTE: When streaming, content is empty if + content filters blocks the output. - >- - The operation is not implemented or is not supported/enabled in - this service. HTTP Mapping: 501 Not Implemented + Token generation stopped because the content potentially contains + copyright violations. + - All other reasons that stopped the token generation. - >- - Internal errors. This means that some invariants expected by the - underlying system have been broken. This error code is reserved - for serious errors. HTTP Mapping: 500 Internal Server Error + Token generation stopped because the content contains forbidden + terms. - >- - The service is currently unavailable. This is most likely a - transient condition, which can be corrected by retrying with a - backoff. Note that it is not always safe to retry non-idempotent - operations. See the guidelines above for deciding between - `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: - 503 Service Unavailable + Token generation stopped for potentially containing prohibited + content. - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error + Token generation stopped because the content potentially contains + Sensitive Personally Identifiable Information (SPII). + - The function call generated by the model is invalid. + type: string + enum: + - FINISH_REASON_UNSPECIFIED + - STOP + - MAX_TOKENS + - SAFETY + - RECITATION + - OTHER + - BLOCKLIST + - PROHIBITED_CONTENT + - SPII + - MALFORMED_FUNCTION_CALL + readOnly: true + citationMetadata: + description: Output only. Source attribution of the generated content. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' + content: + readOnly: true + description: Output only. Content parts of the candidate. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + id: GoogleCloudAiplatformV1Candidate + description: A response candidate generated from the model. type: object - id: GoogleCloudAiplatformV1SchemaPredictionResultError - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation: - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation + GoogleCloudAiplatformV1StreamingPredictResponse: type: object properties: - columnName: - type: string - GoogleCloudAiplatformV1ListBatchPredictionJobsResponse: - id: GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The parameters that govern the prediction. + outputs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: The prediction output. + description: Response message for PredictionService.StreamingPredict. + id: GoogleCloudAiplatformV1StreamingPredictResponse + GoogleCloudAiplatformV1VertexRagStore: type: object - description: Response message for JobService.ListBatchPredictionJobs + id: GoogleCloudAiplatformV1VertexRagStore properties: - batchPredictionJobs: - description: List of BatchPredictionJobs in the requested page. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + ragCorpora: + description: Optional. Deprecated. Please use rag_resources instead. type: array - nextPageToken: + items: + type: string + deprecated: true + ragResources: description: >- - A token to retrieve the next page of results. Pass to - ListBatchPredictionJobsRequest.page_token to obtain that page. - type: string - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics - description: Metrics for image segmentation evaluation results. - type: object - properties: - confidenceMetricsEntries: + Optional. The representation of the rag source. It can be used to + specify corpus only or ragfiles. Currently only support one corpus + or multiple files from one corpus. In the future we may open up + multiple corpora support. + type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + #/components/schemas/GoogleCloudAiplatformV1VertexRagStoreRagResource + similarityTopK: + format: int32 description: >- - Metrics for each confidenceThreshold in - 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 Precision-recall curve - can be derived from it. - type: array - GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics: - properties: - meanAveragePrecision: - type: number - description: The mean average precision, most often close to `auPrc`. - format: float - iouThreshold: - format: float + Optional. Number of top k results to return from the selected + corpora. + type: integer + vectorDistanceThreshold: + format: double type: number description: >- - The intersection-over-union threshold value used to compute this - metrics entry. - confidenceMetrics: - type: array + Optional. Only return results with vector distance smaller than the + threshold. + description: Retrieve from Vertex RAG Store for grounding. + GoogleCloudAiplatformV1ExportFeatureValuesRequest: + description: Request message for FeaturestoreService.ExportFeatureValues. + id: GoogleCloudAiplatformV1ExportFeatureValuesRequest + properties: + destination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' + description: Required. Specifies destination location and format. + snapshotExport: description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. + Exports the latest Feature values of all entities of the EntityType + within a time range. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport + settings: + type: array + description: Per-Feature export settings. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics + #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + featureSelector: + description: Required. Selects Features to export values of. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' + fullExport: + description: >- + Exports all historical values of all entities of the EntityType + within a time range + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport type: object - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. - GoogleCloudAiplatformV1StratifiedSplit: - description: >- - Assigns input data to the training, validation, and test sets so that - the distribution of values found in the categorical column (as specified - by the `key` field) is mirrored within each split. The fraction values - determine the relative sizes of the splits. For example, if the - specified column has three values, with 50% of the rows having value - "A", 25% value "B", and 25% value "C", and the split fractions are - specified as 80/10/10, then the training set will constitute 80% of the - training data, with about 50% of the training set rows having the value - "A" for the specified column, about 25% having the value "B", and about - 25% having the value "C". Only the top 500 occurring values are used; - any values not in the top 500 values are randomly assigned to a split. - If less than three rows contain a specific value, those rows are - randomly assigned. Supported only for tabular Datasets. + GoogleCloudAiplatformV1GcsSource: properties: - key: - type: string - description: >- - Required. The key is a name of one of the Dataset's data columns. - The key provided must be for a categorical column. - testFraction: - description: >- - The fraction of the input data that is to be used to evaluate the - Model. - type: number - format: double - validationFraction: - format: double - description: >- - The fraction of the input data that is to be used to validate the - Model. - type: number - trainingFraction: - format: double - type: number + uris: description: >- - The fraction of the input data that is to be used to train the - Model. - id: GoogleCloudAiplatformV1StratifiedSplit + Required. Google Cloud Storage URI(-s) to the input file(s). May + contain wildcards. For more information on wildcards, see + https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames. + items: + type: string + type: array type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs: + description: The Google Cloud Storage location for the input content. + id: GoogleCloudAiplatformV1GcsSource + GoogleCloudAiplatformV1StructValue: + description: Struct (or object) type feature value. + id: GoogleCloudAiplatformV1StructValue type: object properties: - exportEvaluatedDataItemsConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - predictionType: - description: >- - The type of prediction the Model is to produce. "classification" - - Predict one out of multiple target values is picked for each row. - "regression" - Predict a value based on its relation to other - values. This type is available only to columns that contain - semantically numeric values, i.e. integers or floating point number, - even if stored as e.g. strings. - type: string - additionalExperiments: + values: + description: A list of field values. type: array - description: Additional experiment flags for the Tables training pipeline. items: - type: string - disableEarlyStopping: - description: >- - Use the entire training budget. This disables the early stopping - feature. By default, the early stopping feature is enabled, which - means that AutoML Tables might stop training before the entire - training budget has been used. - type: boolean - trainBudgetMilliNodeHours: - format: int64 + $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' + GoogleCloudAiplatformV1QueryDeployedModelsResponse: + properties: + totalDeployedModelCount: + description: The total number of DeployedModels on this DeploymentResourcePool. + format: int32 + type: integer + totalEndpointCount: + type: integer description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. - type: string - optimizationObjective: + The total number of Endpoints that have DeployedModels on this + DeploymentResourcePool. + format: int32 + nextPageToken: description: >- - Objective function the model is optimizing towards. The training - process creates a model that maximizes/minimizes the value of the - objective function over the validation set. The supported - optimization objectives depend on the prediction type. If the field - is not set, a default objective function is used. classification - (binary): "maximize-au-roc" (default) - Maximize the area under the - receiver operating characteristic (ROC) curve. "minimize-log-loss" - - Minimize log loss. "maximize-au-prc" - Maximize the area under the - precision-recall curve. "maximize-precision-at-recall" - Maximize - precision for a specified recall value. - "maximize-recall-at-precision" - Maximize recall for a specified - precision value. classification (multi-class): "minimize-log-loss" - (default) - Minimize log loss. regression: "minimize-rmse" (default) - - Minimize root-mean-squared error (RMSE). "minimize-mae" - Minimize - mean-absolute error (MAE). "minimize-rmsle" - Minimize - root-mean-squared log error (RMSLE). - type: string - targetColumn: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: The column name of the target column that the model is to predict. - optimizationObjectivePrecisionValue: + deployedModelRefs: + type: array description: >- - Required when optimization_objective is - "maximize-recall-at-precision". Must be between 0 and 1, inclusive. - type: number - format: float - transformations: + References to the DeployedModels that share the specified + deploymentResourcePool. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' + deployedModels: type: array + deprecated: true items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: DEPRECATED Use deployed_model_refs instead. + description: Response message for QueryDeployedModels method. + id: GoogleCloudAiplatformV1QueryDeployedModelsResponse + type: object + GoogleCloudAiplatformV1ExportModelResponse: + description: Response message of ModelService.ExportModel operation. + id: GoogleCloudAiplatformV1ExportModelResponse + properties: {} + type: object + GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest: + id: GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + type: object + description: >- + Request message for + FeaturestoreOnlineServingService.StreamingFeatureValuesRead. + properties: + entityIds: description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - optimizationObjectiveRecallValue: - type: number - format: float + Required. IDs of entities to read Feature values of. The maximum + number of IDs is 100. For example, for a machine learning model + predicting user clicks on a website, an entity ID could be + `user_123`. + items: + type: string + type: array + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' description: >- - Required when optimization_objective is - "maximize-precision-at-recall". Must be between 0 and 1, inclusive. - weightColumnName: + Required. Selector choosing Features of the target EntityType. + Feature IDs will be deduplicated. + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance: + description: Spec for question answering helpfulness instance. + properties: + context: + type: string + description: Optional. Text provided as context to answer the question. + instruction: description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. + Required. The question asked and other instruction in the inference + prompt. type: string - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs - GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: + reference: + type: string + description: Optional. Ground truth used to compare against the prediction. + prediction: + description: Required. Output of the evaluated model. + type: string + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance + type: object + GoogleCloudAiplatformV1CopyModelResponse: + id: GoogleCloudAiplatformV1CopyModelResponse properties: - tensorboardTimeSeriesId: + modelVersionId: type: string + readOnly: true + description: Output only. The version ID of the model that is copied. + model: description: >- - Optional. The user specified unique ID to use for the - TensorboardTimeSeries, which becomes the final component of the - TensorboardTimeSeries's resource name. This value should match - "a-z0-9{0, 127}" - tensorboardTimeSeries: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' - description: Required. The TensorboardTimeSeries to create. - parent: + The name of the copied Model resource. Format: + `projects/{project}/locations/{location}/models/{model}` type: string - description: >- - Required. The resource name of the TensorboardRun to create the - TensorboardTimeSeries in. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` - id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest - description: Request message for TensorboardService.CreateTensorboardTimeSeries. + description: Response message of ModelService.CopyModel operation. type: object - GoogleCloudAiplatformV1Context: - description: Instance of a general context. - id: GoogleCloudAiplatformV1Context + GoogleCloudAiplatformV1SupervisedTuningDataStats: + type: object + id: GoogleCloudAiplatformV1SupervisedTuningDataStats properties: - parentContexts: + tuningDatasetExampleCount: + format: int64 + readOnly: true + description: Output only. Number of examples in the tuning dataset. + type: string + tuningStepCount: + readOnly: true + format: int64 + type: string + description: Output only. Number of tuning steps for this Tuning Job. + userOutputTokenDistribution: + description: Output only. Dataset distributions for the user output tokens. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + totalBillableCharacterCount: + description: Output only. Number of billable characters in the tuning dataset. + readOnly: true + deprecated: true + type: string + format: int64 + totalTruncatedExampleCount: + type: string + format: int64 + description: >- + The number of examples in the dataset that have been truncated by + any amount. + userDatasetExamples: + type: array + readOnly: true + description: Output only. Sample user messages in the training dataset uri. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + totalBillableTokenCount: + format: int64 + description: Output only. Number of billable tokens in the tuning dataset. + readOnly: true + type: string + truncatedExampleIndices: items: + format: int64 type: string description: >- - Output only. A list of resource names of Contexts that are parents - of this Context. A Context may have at most 10 parent_contexts. + A partial sample of the indices (starting from 1) of the truncated + examples. type: array + userMessagePerExampleDistribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution readOnly: true - schemaVersion: + description: Output only. Dataset distributions for the messages per example. + userInputTokenDistribution: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution + description: Output only. Dataset distributions for the user input tokens. + readOnly: true + totalTuningCharacterCount: + readOnly: true + description: Output only. Number of tuning characters in the tuning dataset. + format: int64 type: string + description: Tuning data statistics for Supervised Tuning. + GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult + properties: + classes: + type: array description: >- - The version of the schema in schema_name to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - schemaTitle: + The name of the classes being classified, contains all possible + values of the target column. + items: + type: string + scores: + items: + format: float + type: number description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. + The model's confidence in each class being correct, higher value + means higher confidence. The N-th score corresponds to the N-th + class in classes. + type: array + description: Prediction output format for Tabular Classification. + GoogleCloudAiplatformV1FeatureOnlineStore: + id: GoogleCloudAiplatformV1FeatureOnlineStore + properties: + dedicatedServingEndpoint: + description: >- + Optional. The dedicated serving endpoint for this + FeatureOnlineStore, which is different from common Vertex service + endpoint. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint + updateTime: + format: google-datetime + readOnly: true + description: >- + Output only. Timestamp when this FeatureOnlineStore was last + updated. type: string - displayName: + etag: type: string description: >- - User provided display name of the Context. May be up to 128 Unicode - characters. - createTime: + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. readOnly: true - description: Output only. Timestamp when this Context was created. - type: string - format: google-datetime labels: - type: object description: >- - The labels with user-defined metadata to organize your Contexts. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Context (System - labels are excluded). + Optional. The labels with user-defined metadata to organize your + FeatureOnlineStore. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureOnlineStore(System labels are excluded)." System + reserved label keys are prefixed with "aiplatform.googleapis.com/" + and are immutable. + type: object additionalProperties: type: string - description: + createTime: type: string - description: Description of the Context - updateTime: readOnly: true - description: Output only. Timestamp when this Context was last updated. + description: Output only. Timestamp when this FeatureOnlineStore was created. format: google-datetime - type: string - metadata: - additionalProperties: - description: Properties of the object. - type: any + optimized: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreOptimized description: >- - Properties of the Context. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - type: object - etag: + Contains settings for the Optimized store that will be created to + serve featureValues for all FeatureViews under this + FeatureOnlineStore. When choose Optimized storage type, need to set + PrivateServiceConnectConfig.enable_private_service_connect to use + private endpoint. Otherwise will use public endpoint by default. + name: type: string description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - name: - description: Immutable. The resource name of the Context. + Identifier. Name of the FeatureOnlineStore. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` + bigtable: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + description: >- + Contains settings for the Cloud Bigtable instance that will be + created to serve featureValues for all FeatureViews under this + FeatureOnlineStore. + state: + enum: + - STATE_UNSPECIFIED + - STABLE + - UPDATING type: string - type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: + description: Output only. State of the featureOnlineStore. + enumDescriptions: + - Default value. This value is unused. + - >- + State when the featureOnlineStore configuration is not being + updated and the fields reflect the current configuration of the + featureOnlineStore. The featureOnlineStore is usable in this + state. + - >- + The state of the featureOnlineStore configuration when it is being + updated. During an update, the fields reflect either the original + configuration or the updated configuration of the + featureOnlineStore. The featureOnlineStore is still usable in this + state. + readOnly: true + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Optional. Customer-managed encryption key spec for data storage. If + set, online store will be secured by this key. + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. description: >- - The config for integrating with Vertex Explainable AI. Only applicable - if the Model has explanation_spec populated. + Vertex AI Feature Online Store provides a centralized repository for + serving ML features and embedding indexes at low latency. The Feature + Online Store is a top-level container. type: object - id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig: + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig properties: - enableFeatureAttributes: - type: boolean + model: description: >- - If want to analyze the Vertex Explainable AI feature attribute - scores or not. If set to true, Vertex AI will log the feature - attributions from explain response and do the skew/drift detection - for them. - explanationBaseline: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + Required. Full resource name of automl Model. Format: + `projects/{project}/locations/{location}/models/{model}`. + type: string + modelDisplayName: + type: string description: >- - Predictions generated by the BatchPredictionJob using baseline - dataset. - GoogleCloudAiplatformV1Explanation: - id: GoogleCloudAiplatformV1Explanation + Optional. Display name of the model in Vertex AI. System will pick a + display name if unspecified. + description: >- + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. + type: object + GoogleCloudAiplatformV1CreateTensorboardRunRequest: + type: object + id: GoogleCloudAiplatformV1CreateTensorboardRunRequest + description: Request message for TensorboardService.CreateTensorboardRun. properties: - attributions: - type: array + tensorboardRun: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + description: Required. The TensorboardRun to create. + tensorboardRunId: + type: string description: >- - Output only. Feature attributions grouped by predicted outputs. For - Models that predict only one output, such as regression Models that - predict only one score, there is only one attibution that explains - the predicted output. For Models that predict multiple outputs, such - as multiclass Models that predict multiple classes, each element - explains one specific item. Attribution.output_index can be used to - identify which output this attribution is explaining. By default, we - provide Shapley values for the predicted class. However, you can - configure the explanation request to generate Shapley values for any - other classes too. For example, if a model predicts a probability of - `0.4` for approving a loan application, the model's decision is to - reject the application since `p(reject) = 0.6 > p(approve) = 0.4`, - and the default Shapley values would be computed for rejection - decision and not approval, even though the latter might be the - positive class. If users set ExplanationParameters.top_k, the - attributions are sorted by instance_output_value in descending - order. If ExplanationParameters.output_indices is specified, the - attributions are stored by Attribution.output_index in the same - order as they appear in the output_indices. - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' - neighbors: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Neighbor' - type: array + Required. The ID to use for the Tensorboard run, which becomes the + final component of the Tensorboard run's resource name. This value + should be 1-128 characters, and valid characters are `/a-z-/`. + parent: + type: string description: >- - Output only. List of the nearest neighbors for example-based - explanations. For models deployed with the examples explanations - feature enabled, the attributions field is empty and instead the - neighbors field is populated. - readOnly: true - description: >- - Explanation of a prediction (provided in PredictResponse.predictions) - produced by the Model on a given instance. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation: - properties: - metadata: - description: The metadata information. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentation - description: >- - A TrainingJob that trains and uploads an AutoML Image Segmentation - Model. - GoogleCloudAiplatformV1ReadFeatureValuesResponse: + Required. The resource name of the TensorboardExperiment to create + the TensorboardRun in. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig: properties: - entityView: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView + desiredMinSafeTrialsFraction: description: >- - Entity view with Feature values. This may be the entity in the - Featurestore if values for all Features were requested, or a - projection of the entity in the Featurestore if values for only some - Features were requested. - header: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader - description: Response header. - description: Response message for FeaturestoreOnlineServingService.ReadFeatureValues. - type: object - id: GoogleCloudAiplatformV1ReadFeatureValuesResponse - GoogleCloudAiplatformV1UpsertDatapointsResponse: - id: GoogleCloudAiplatformV1UpsertDatapointsResponse - description: Response message for IndexService.UpsertDatapoints - properties: {} - type: object - GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: - properties: - samplingRate: + Desired minimum fraction of safe trials (over total number of + trials) that should be targeted by the algorithm at any time during + the study (best effort). This should be between 0.0 and 1.0 and a + value of 0.0 means that there is no minimum and an algorithm + proceeds without targeting any specific fraction. A value of 1.0 + means that the algorithm attempts to only Suggest safe Trials. + format: double type: number + safetyThreshold: description: >- - Percentage of requests to be logged, expressed as a fraction in - range(0,1]. + Safety threshold (boundary value between safe and unsafe). NOTE that + if you leave SafetyMetricConfig unset, a default value of 0 will be + used. + type: number format: double - enabled: - type: boolean - description: If logging is enabled or not. - bigqueryDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: >- - BigQuery table for logging. If only given a project, a new dataset - will be created with name `logging__` where will be made - BigQuery-dataset-name compatible (e.g. most special characters will - become underscores). If no table name is given, a new table will be - created with name `request_response_logging` - description: Configuration for logging request-response to a BigQuery table. - type: object - id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig - GoogleCloudAiplatformV1ExamplesOverride: + description: >- + Used in safe optimization to specify threshold levels and risk + tolerance. + id: GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig type: object + GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: + id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey properties: - neighborCount: - type: integer - format: int32 - description: The number of neighbors to return. - restrictions: - type: array + parts: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExamplesRestrictionsNamespace - description: >- - Restrict the resulting nearest neighbors to respect these - constraints. - crowdingCount: - format: int32 - type: integer - description: The number of neighbors to return that have the same crowding tag. - returnEmbeddings: - description: If true, return the embeddings instead of neighbors. - type: boolean - dataFormat: - description: The format of the data being provided with each call. - type: string - enum: - - DATA_FORMAT_UNSPECIFIED - - INSTANCES - - EMBEDDINGS - enumDescriptions: - - Unspecified format. Must not be used. - - Provided data is a set of model inputs. - - Provided data is a set of embeddings. - description: Overrides for example-based explanations. - id: GoogleCloudAiplatformV1ExamplesOverride - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition: - description: Represents the spec to match discrete values from parent parameter. - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition - properties: - values: - description: >- - Required. Matches values of the parent parameter of 'DISCRETE' type. - All values must exist in `discrete_value_spec` of parent parameter. - The Epsilon of the value matching is 1e-10. + type: string type: array - items: - format: double - type: number + description: >- + Parts to construct Entity ID. Should match with the same ID columns + as defined in FeatureView in the same order. + description: ID that is comprised from several parts (columns). type: object - GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata: - id: GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata + GoogleCloudAiplatformV1ListFeatureViewsResponse: + description: Response message for FeatureOnlineStoreAdminService.ListFeatureViews. properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - specialistPool: + featureViews: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + type: array + description: The FeatureViews matching the request. + nextPageToken: type: string description: >- - Output only. The name of the SpecialistPool to which the specialists - are being added. Format: - `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` - readOnly: true + A token, which can be sent as ListFeatureViewsRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + id: GoogleCloudAiplatformV1ListFeatureViewsResponse type: object - description: >- - Runtime operation metadata for - SpecialistPoolService.UpdateSpecialistPool. - GoogleCloudAiplatformV1CancelNasJobRequest: + GoogleCloudAiplatformV1IndexDatapoint: type: object - id: GoogleCloudAiplatformV1CancelNasJobRequest - properties: {} - description: Request message for JobService.CancelNasJob. - GoogleCloudAiplatformV1SampledShapleyAttribution: + description: A datapoint of Index. properties: - pathCount: + sparseEmbedding: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + description: Optional. Feature embedding vector for sparse index. + crowdingTag: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointCrowdingTag description: >- - Required. The number of feature permutations to consider when - approximating the Shapley values. Valid range of its value is [1, - 50], inclusively. - format: int32 - type: integer - description: >- - An attribution method that approximates Shapley values for features that - contribute to the label being predicted. A sampling strategy is used to - approximate the value rather than considering all subsets of features. - id: GoogleCloudAiplatformV1SampledShapleyAttribution - type: object - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation: - type: object - id: >- - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - properties: - annotationSpecId: - type: string + Optional. CrowdingTag of the datapoint, the number of neighbors to + return in each crowding can be configured during query. + numericRestricts: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointNumericRestriction description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - vertexes: + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses numeric + comparisons. + type: array + restricts: type: array description: >- - The vertexes are connected one by one and the last vertex is - connected to the first one to represent a polygon. + Optional. List of Restrict of the datapoint, used to perform + "restricted searches" where boolean rule are used to filter the + subset of the database eligible for matching. This uses categorical + tokens. See: + https://cloud.google.com/vertex-ai/docs/matching-engine/filtering items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' - displayName: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IndexDatapointRestriction + featureVector: + type: array + items: + type: number + format: float description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - description: Represents a polygon in image. - GoogleCloudAiplatformV1DiskSpec: - description: Represents the spec of disk options. - id: GoogleCloudAiplatformV1DiskSpec + Required. Feature embedding vector for dense index. An array of + numbers with the length of [NearestNeighborSearchConfig.dimensions]. + datapointId: + description: Required. Unique identifier of the datapoint. + type: string + id: GoogleCloudAiplatformV1IndexDatapoint + GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: + description: >- + Selects Features of an EntityType to read values of and specifies read + settings. type: object properties: - bootDiskSizeGb: - description: Size in GB of the boot disk (default is 100GB). - format: int32 - type: integer - bootDiskType: + settings: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + type: array + description: Per-Feature settings for the batch read. + featureSelector: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' description: >- - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" - (Persistent Disk Solid State Drive) or "pd-standard" (Persistent - Disk Hard Disk Drive). - type: string - GoogleCloudAiplatformV1SchemaTextExtractionAnnotation: - properties: - annotationSpecId: - type: string + Required. Selectors choosing which Feature values to read from the + EntityType. + entityTypeId: description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - textSegment: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTextSegment' - description: The segment of the text content. - displayName: + Required. ID of the EntityType to select Features. The EntityType id + is the entity_type_id specified during EntityType creation. type: string - description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec + GoogleCloudAiplatformV1MigratableResourceAutomlDataset: + id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset type: object - id: GoogleCloudAiplatformV1SchemaTextExtractionAnnotation - description: Annotation details specific to text extraction. - GoogleCloudAiplatformV1DestinationFeatureSetting: - id: GoogleCloudAiplatformV1DestinationFeatureSetting + description: Represents one Dataset in automl.googleapis.com. properties: - featureId: - description: Required. The ID of the Feature to apply the setting to. + dataset: type: string - destinationField: description: >- - Specify the field name in the export destination. If not specified, - Feature ID is used. + Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + datasetDisplayName: + description: The Dataset's display name in automl.googleapis.com. type: string - type: object - GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec: - type: object - properties: - useElapsedDuration: - type: boolean - description: >- - True if Measurement.elapsed_duration is used as the x-axis of each - Trials Decay Curve. Otherwise, Measurement.step_count will be used - as the x-axis. - description: >- - The decay curve automated stopping rule builds a Gaussian Process - Regressor to predict the final objective value of a Trial based on the - already completed Trials and the intermediate measurements of the - current Trial. Early stopping is requested for the current Trial if - there is very low probability to exceed the optimal value found so far. - id: GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec - GoogleCloudAiplatformV1ExportDataResponse: - description: Response message for DatasetService.ExportData. + GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest: type: object properties: - dataStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' + names: description: >- - Only present for custom code training export use case. Records data - stats, i.e., train/validation/test item/annotation counts calculated - during the export operation. - exportedFiles: + Required. The names of the PipelineJobs to cancel. A maximum of 32 + PipelineJobs can be cancelled in a batch. Format: + `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` items: type: string type: array + id: GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest + description: Request message for PipelineService.BatchCancelPipelineJobs. + GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse: + id: GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse + properties: + nextPageToken: description: >- - All of the files that are exported in this export operation. For - custom code training export, only three (training, validation and - test) Cloud Storage paths in wildcard format are populated (for - example, gs://.../training-*). - id: GoogleCloudAiplatformV1ExportDataResponse - GoogleCloudAiplatformV1AvroSource: + A token to retrieve next page of results. Pass to + ListNotebookExecutionJobs.page_token to obtain that page. + type: string + notebookExecutionJobs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + description: List of NotebookExecutionJobs in the requested page. + description: Response message for [NotebookService.CreateNotebookExecutionJob] type: object - description: The storage details for Avro input content. - id: GoogleCloudAiplatformV1AvroSource + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: properties: - gcsSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' - description: Required. Google Cloud Storage location. - GoogleCloudAiplatformV1DeleteFeatureValuesRequest: + attributionScoreSkewThresholds: + type: object + description: >- + Key is the feature name and value is the threshold. The threshold + here is against attribution score distance between the training and + prediction feature. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + skewThresholds: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + type: object + description: >- + Key is the feature name and value is the threshold. If a feature + needs to be monitored for skew, a value threshold must be configured + for that feature. The threshold here is against feature distribution + distance between the training and prediction feature. + defaultSkewThreshold: + description: >- + Skew anomaly detection threshold used by all features. When the + per-feature thresholds are not set, this field can be used to + specify a threshold for all features. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' type: object + description: >- + The config for Training & Prediction data skew detection. It specifies + the training dataset sources and the skew detection parameters. + id: >- + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata: + id: >- + GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata + type: object + description: All metadata of most recent monitoring pipelines. properties: - selectEntity: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the most recent monitoring pipeline. + runTime: + description: >- + The time that most recent monitoring pipelines that is related to + this run. + type: string + format: google-datetime + GoogleCloudAiplatformV1FeaturestoreMonitoringConfig: + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfig + properties: + snapshotAnalysis: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity - description: Select feature values to be deleted by specifying entities. - selectTimeRangeAndFeature: + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis + description: The config for Snapshot Analysis Based Feature Monitoring. + categoricalThresholdConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig description: >- - Select feature values to be deleted by specifying time range and - features. - description: Request message for FeaturestoreService.DeleteFeatureValues. - id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest - GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: - description: Request message for JobService.ResumeModelDeploymentMonitoringJob. - properties: {} + Threshold for categorical features of anomaly detection. This is + shared by all types of Featurestore Monitoring for categorical + features (i.e. Features with type (Feature.ValueType) BOOL or + STRING). + numericalThresholdConfig: + description: >- + Threshold for numerical features of anomaly detection. This is + shared by all objectives of Featurestore Monitoring for numerical + features (i.e. Features with type (Feature.ValueType) DOUBLE or + INT64). + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigThresholdConfig + importFeaturesAnalysis: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis + description: The config for ImportFeatures Analysis Based Feature Monitoring. + type: object + description: Configuration of how features in Featurestore are monitored. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: type: object - id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest - GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: - description: Request message for NotebookService.AssignNotebookRuntime. - id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest properties: - notebookRuntimeId: + targetColumn: type: string - description: Optional. User specified ID for the notebook runtime. - notebookRuntime: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' description: >- - Required. Provide runtime specific information (e.g. runtime owner, - notebook id) used for NotebookRuntime assignment. - notebookRuntimeTemplate: + The name of the column that the Model is to predict values for. This + column must be unavailable at forecast. + dataGranularity: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity + description: Expected difference in time granularity between rows in the data. + contextWindow: type: string description: >- - Required. The resource name of the NotebookRuntimeTemplate based on - which a NotebookRuntime will be assigned (reuse or create a new - one). - type: object - GoogleCloudAiplatformV1BigQueryDestination: - type: object - id: GoogleCloudAiplatformV1BigQueryDestination - properties: - outputUri: + The amount of time into the past training and prediction data is + used for model training and prediction respectively. Expressed in + number of units defined by the `data_granularity` field. + format: int64 + hierarchyConfig: + description: >- + Configuration that defines the hierarchical relationship of time + series and parameters for hierarchical forecasting strategies. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + additionalExperiments: + description: Additional experiment flags for the time series forcasting training. + items: + type: string + type: array + forecastHorizon: type: string description: >- - Required. BigQuery URI to a project or table, up to 2000 characters - long. When only the project is specified, the Dataset and Table is - created. When the full table reference is specified, the Dataset - must exist and table must not exist. Accepted forms: * BigQuery - path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` - or `bq://projectId.bqDatasetId.bqTableId`. - description: The BigQuery location for the output content. - GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: - type: object - id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for FeatureGroup. - description: Details of operations that perform create FeatureGroup. - GoogleCloudAiplatformV1ExportDataConfig: - id: GoogleCloudAiplatformV1ExportDataConfig - description: >- - Describes what part of the Dataset is to be exported, the destination of - the export and how to export. - type: object - properties: - fractionSplit: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' - description: Split based on fractions defining the size of each set. - filterSplit: - description: Split based on the provided filters for each set. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: >- - The Google Cloud Storage location where the output is to be written - to. In the given directory a new directory will be created with - name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ - ISO-8601 format. All export output will be written into that - directory. Inside that directory, annotations with the same schema - will be grouped into sub directories which are named with the - corresponding annotations' schema title. Inside these sub - directories, a schema.yaml will be created to describe the output - format. - annotationSchemaUri: + The amount of time into the future for which forecasted values for + the target are returned. Expressed in number of units defined by the + `data_granularity` field. + format: int64 + trainBudgetMilliNodeHours: description: >- - The Cloud Storage URI that points to a YAML file describing the - annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/, note that - the chosen schema must be consistent with metadata of the Dataset - specified by dataset_id. Only used for custom training data export - use cases. Only applicable to Datasets that have DataItems and - Annotations. Only Annotations that both match this schema and belong - to DataItems not ignored by the split method are used in - respectively training, validation or test role, depending on the - role of the DataItem they are on. When used in conjunction with - annotations_filter, the Annotations used for training are filtered - by both annotations_filter and annotation_schema_uri. - type: string - exportUse: - enumDescriptions: - - Regular user export. - - Export for custom code training. - enum: - - EXPORT_USE_UNSPECIFIED - - CUSTOM_CODE_TRAINING + Required. The train budget of creating this model, expressed in + milli node hours i.e. 1,000 value in this field means 1 node hour. + The training cost of the model will not exceed this budget. The + final cost will be attempted to be close to the budget, though may + end up being (even) noticeably smaller - at the backend's + discretion. This especially may happen when further model training + ceases to provide any improvements. If the budget is set to a value + known to be insufficient to train a model for the given dataset, the + training won't be attempted and will error. The train budget must be + between 1,000 and 72,000 milli node hours, inclusive. + format: int64 type: string - description: Indicates the usage of the exported files. - annotationsFilter: + unavailableAtForecastColumns: description: >- - An expression for filtering what part of the Dataset is to be - exported. Only Annotations that match this filter will be exported. - The filter syntax is the same as in ListAnnotations. + Names of columns that are unavailable when a forecast is requested. + This column contains information for the given entity (identified by + the time_series_identifier_column) that is unknown before the + forecast For example, actual weather on a given day. + type: array + items: + type: string + timeSeriesAttributeColumns: + items: + type: string + description: >- + Column names that should be used as attribute columns. The value of + these columns does not vary as a function of time. For example, + store ID or item color. + type: array + timeSeriesIdentifierColumn: + description: The name of the column that identifies the time series. type: string - savedQueryId: + validationOptions: type: string description: >- - The ID of a SavedQuery (annotation set) under the Dataset specified - by dataset_id used for filtering Annotations for training. Only used - for custom training data export use cases. Only applicable to - Datasets that have SavedQueries. Only Annotations that are - associated with this SavedQuery are used in respectively training. - When used in conjunction with annotations_filter, the Annotations - used for training are filtered by both saved_query_id and - annotations_filter. Only one of saved_query_id and - annotation_schema_uri should be specified as both of them represent - the same thing: problem type. - GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: - description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. - type: object - properties: - pageToken: + Validation options for the data validation component. The available + options are: * "fail-pipeline" - default, will validate against the + validation and fail the pipeline if it fails. * "ignore-validation" + - ignore the results of the validation and continue + optimizationObjective: description: >- - A page token, received from a previous - ExportTensorboardTimeSeriesData call. Provide this to retrieve the - subsequent page. When paginating, all other parameters provided to - ExportTensorboardTimeSeriesData must match the call that provided - the page token. + Objective function the model is optimizing towards. The training + process creates a model that optimizes the value of the objective + function over the validation set. The supported optimization + objectives: * "minimize-rmse" (default) - Minimize root-mean-squared + error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). + * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * + "minimize-rmspe" - Minimize root-mean-squared percentage error + (RMSPE). * "minimize-wape-mae" - Minimize the combination of + weighted absolute percentage error (WAPE) and mean-absolute-error + (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at + the quantiles defined in `quantiles`. * "minimize-mape" - Minimize + the mean absolute percentage error. type: string - filter: + availableAtForecastColumns: + type: array + description: >- + Names of columns that are available and provided when a forecast is + requested. These columns contain information for the given entity + (identified by the time_series_identifier_column column) that is + known at forecast. For example, predicted weather for a specific + day. + items: + type: string + weightColumn: type: string description: >- - Exports the TensorboardTimeSeries' data that match the filter - expression. - pageSize: - format: int32 + Column name that should be used as the weight column. Higher values + in this column give more importance to the row during model + training. The column must have numeric values between 0 and 10000 + inclusively; 0 means the row is ignored for training. If weight + column field is not set, then all rows are assumed to have equal + weight of 1. This column must be available at forecast. + holidayRegions: + items: + type: string + type: array description: >- - The maximum number of data points to return per page. The default - page_size is 1000. Values must be between 1 and 10000. Values above - 10000 are coerced to 10000. - type: integer - orderBy: + The geographical region based on which the holiday effect is applied + in modeling by adding holiday categorical array feature that include + all holidays matching the date. This option only allowed when + data_granularity is day. By default, holiday effect modeling is + disabled. To turn it on, specify the holiday region using this + option. + windowConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + description: Config containing strategy for generating sliding windows. + timeColumn: + description: >- + The name of the column that identifies time order in the time + series. This column must be available at forecast. type: string + quantiles: + type: array description: >- - Field to use to sort the TensorboardTimeSeries' data. By default, - TensorboardTimeSeries' data is returned in a pseudo random order. - id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest - GoogleCloudAiplatformV1WriteFeatureValuesRequest: - type: object - description: Request message for FeaturestoreOnlineServingService.WriteFeatureValues. - properties: - payloads: + Quantiles to use for minimize-quantile-loss + `optimization_objective`. Up to 5 quantiles are allowed of values + between 0 and 1, exclusive. Required if the value of + optimization_objective is minimize-quantile-loss. Represents the + percent quantiles to use for that objective. Quantiles must be + unique. + items: + type: number + format: double + transformations: type: array + description: >- + Each transformation will apply transform function to given input + column. And the result will be used for training. When creating + transformation for BigQuery Struct column, the column should be + flattened using "." as the delimiter. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesPayload + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + exportEvaluatedDataItemsConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig description: >- - Required. The entities to be written. Up to 100,000 feature values - can be written across all `payloads`. - id: GoogleCloudAiplatformV1WriteFeatureValuesRequest - GoogleCloudAiplatformV1ListStudiesResponse: - description: Response message for VizierService.ListStudies. - id: GoogleCloudAiplatformV1ListStudiesResponse + Configuration for exporting test set predictions to a BigQuery + table. If this configuration is absent, then the export is not + performed. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + GoogleCloudAiplatformV1CustomJobSpec: + type: object properties: - nextPageToken: + workerPoolSpecs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1WorkerPoolSpec' + type: array description: >- - Passes this token as the `page_token` field of the request for a - subsequent call. If this field is omitted, there are no subsequent - pages. + Required. The spec of the worker pools including machine type and + Docker image. All worker pools except the first one are optional and + can be skipped by providing an empty value. + tensorboard: type: string - studies: - type: array - description: The studies associated with the project. + description: >- + Optional. The name of a Vertex AI Tensorboard resource to which this + CustomJob will upload Tensorboard logs. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + experimentRun: + description: >- + Optional. The Experiment Run associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}` + type: string + reservedIpRanges: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' - type: object - GoogleCloudAiplatformV1StructValue: - id: GoogleCloudAiplatformV1StructValue - type: object - description: Struct (or object) type feature value. - properties: - values: + type: string type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StructFieldValue' - description: A list of field values. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation - type: object - properties: - columnName: + description: >- + Optional. A list of names for the reserved ip ranges under the VPC + network that can be used for this job. If set, we will deploy the + job within the provided ip ranges. Otherwise, the job will be + deployed to any ip ranges under the provided VPC network. Example: + ['vertex-ai-ip-range']. + scheduling: + description: Scheduling options for a CustomJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Scheduling' + protectedArtifactLocationId: type: string - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport: - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestSnapshotExport - type: object - description: >- - Describes exporting the latest Feature values of all entities of the - EntityType between [start_time, snapshot_time]. - properties: - startTime: - format: google-datetime + description: >- + The ID of the location to store protected artifacts. e.g. + us-central1. Populate only when the location is different than + CustomJob location. List of supported locations: + https://cloud.google.com/vertex-ai/docs/general/locations + serviceAccount: type: string description: >- - Excludes Feature values with feature generation timestamp before - this timestamp. If not set, retrieve oldest values kept in Feature - Store. Timestamp, if present, must not have higher than millisecond - precision. - snapshotTime: + Specifies the service account for workload run-as account. Users + submitting jobs must have act-as permission on this run-as account. + If unspecified, the [Vertex AI Custom Code Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + for the CustomJob's project is used. + baseOutputDirectory: + description: >- + The Cloud Storage location to store the output of this CustomJob or + HyperparameterTuningJob. For HyperparameterTuningJob, the + baseOutputDirectory of each child CustomJob backing a Trial is set + to a subdirectory of name id under its parent + HyperparameterTuningJob's baseOutputDirectory. The following Vertex + AI environment variables will be passed to containers or python + modules when this field is set: For CustomJob: * AIP_MODEL_DIR = + `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * + AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of + HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * + AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = + `//logs/` + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + enableWebAccess: + description: >- + Optional. Whether you want Vertex AI to enable [interactive shell + access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + to training containers. If set to `true`, you can access interactive + shells at the URIs given by CustomJob.web_access_uris or + Trial.web_access_uris (within HyperparameterTuningJob.trials). + type: boolean + experiment: type: string - format: google-datetime description: >- - Exports Feature values as of this timestamp. If not set, retrieve - values as of now. Timestamp, if present, must not have higher than - millisecond precision. - GoogleCloudAiplatformV1ExportModelResponse: - id: GoogleCloudAiplatformV1ExportModelResponse - type: object - properties: {} - description: Response message of ModelService.ExportModel operation. - GoogleCloudAiplatformV1PersistentResource: - id: GoogleCloudAiplatformV1PersistentResource - properties: - createTime: + Optional. The Experiment associated with this job. Format: + `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}` + models: + items: + type: string + type: array + description: >- + Optional. The name of the Model resources for which to generate a + mapping to artifact URIs. Applicable only to some of the + Google-provided custom jobs. Format: + `projects/{project}/locations/{location}/models/{model}` In order to + retrieve a specific version of the model, also provide the version + ID or version alias. Example: + `projects/{project}/locations/{location}/models/{model}@2` or + `projects/{project}/locations/{location}/models/{model}@golden` If + no version ID or alias is specified, the "default" version will be + returned. The "default" version alias is created for the first + version of the model, and can be moved to other versions later on. + There will be exactly one default version. + persistentResourceId: type: string - readOnly: true - description: Output only. Time when the PersistentResource was created. - format: google-datetime + description: >- + Optional. The ID of the PersistentResource in the same Project and + Location which to run If this is specified, the job will be run on + existing machines held by the PersistentResource instead of + on-demand short-live machines. The network and CMEK configs on the + job should be consistent with those on the PersistentResource, + otherwise, the job will be rejected. network: description: >- Optional. The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to peered - with Vertex AI to host the persistent resources. For example, + [network](/compute/docs/networks-and-firewalls#networks) to which + the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} @@ -12526,2138 +13175,1559 @@ components: To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If - this field is left unspecified, the resources aren't peered with any + this field is left unspecified, the job is not peered with any network. type: string - reservedIpRanges: - items: - type: string - description: >- - Optional. A list of names for the reserved IP ranges under the VPC - network that can be used for this persistent resource. If set, we - will deploy the persistent resource within the provided IP ranges. - Otherwise, the persistent resource is deployed to any IP ranges - under the provided VPC network. Example: ['vertex-ai-ip-range']. - type: array - startTime: - readOnly: true + enableDashboardAccess: description: >- - Output only. Time when the PersistentResource for the first time - entered the `RUNNING` state. - type: string - format: google-datetime - updateTime: - readOnly: true - type: string - format: google-datetime + Optional. Whether you want Vertex AI to enable access to the + customized dashboard in training chief container. If set to `true`, + you can access the dashboard at the URIs given by + CustomJob.web_access_uris or Trial.web_access_uris (within + HyperparameterTuningJob.trials). + type: boolean + id: GoogleCloudAiplatformV1CustomJobSpec + description: Represents the spec of a CustomJob. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentiment + type: object + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs + description: The input parameters of this TrainingJob. + description: A TrainingJob that trains and uploads an AutoML Text Sentiment Model. + GoogleCloudAiplatformV1FeatureViewIndexConfig: + id: GoogleCloudAiplatformV1FeatureViewIndexConfig + description: Configuration for vector indexing. + properties: + bruteForceConfig: description: >- - Output only. Time when the PersistentResource was most recently - updated. - state: - description: Output only. The detailed state of a Study. + Optional. Configuration options for using brute force search, which + simply implements the standard linear search in the database for + each query. It is primarily meant for benchmarking and to generate + the ground truth for approximate search. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig + embeddingDimension: + format: int32 + type: integer + description: Optional. The number of dimensions of the input embedding. + distanceMeasureType: enum: - - STATE_UNSPECIFIED - - PROVISIONING - - RUNNING - - STOPPING - - ERROR - - REBOOTING - - UPDATING - readOnly: true - type: string + - DISTANCE_MEASURE_TYPE_UNSPECIFIED + - SQUARED_L2_DISTANCE + - COSINE_DISTANCE + - DOT_PRODUCT_DISTANCE enumDescriptions: - - Not set. - - >- - The PROVISIONING state indicates the persistent resources is being - created. - - >- - The RUNNING state indicates the persistent resource is healthy and - fully usable. - - >- - The STOPPING state indicates the persistent resource is being - deleted. - - >- - The ERROR state indicates the persistent resource may be unusable. - Details can be found in the `error` field. - - >- - The REBOOTING state indicates the persistent resource is being - rebooted (PR is not available right now but is expected to be - ready again later). + - Should not be set. + - Euclidean (L_2) Distance. - >- - The UPDATING state indicates the persistent resource is being - updated. - resourceRuntime: - description: Output only. Runtime information of the Persistent Resource. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntime' - resourcePools: - description: Required. The spec of the pools of different resources. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourcePool' - type: array - encryptionSpec: + Cosine Distance. Defined as 1 - cosine similarity. We strongly + suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of + COSINE distance. Our algorithms have been more optimized for + DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is + mathematically equivalent to COSINE distance and results in the + same ranking. + - Dot Product Distance. Defined as a negative of the dot product. + type: string + description: Optional. The distance measure used in nearest neighbor search. + crowdingColumn: description: >- - Optional. Customer-managed encryption key spec for a - PersistentResource. If set, this PersistentResource and all - sub-resources of this PersistentResource will be secured by this - key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - name: + Optional. Column of crowding. This column contains crowding + attribute which is a constraint on a neighbor list produced by + FeatureOnlineStoreService.SearchNearestEntities to diversify search + results. If + NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to + K in SearchNearestEntitiesRequest, it's guaranteed that no more than + K entities of the same crowding attribute are returned in the + response. type: string - description: Immutable. Resource name of a PersistentResource. - labels: - additionalProperties: + filterColumns: + items: type: string description: >- - Optional. The labels with user-defined metadata to organize - PersistentResource. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information and - examples of labels. - type: object - displayName: - type: string - description: >- - Optional. The display name of the PersistentResource. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. Columns of features that're used to filter vector search + results. + type: array + treeAhConfig: description: >- - Output only. Only populated when persistent resource's state is - `STOPPING` or `ERROR`. - readOnly: true - resourceRuntimeSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ResourceRuntimeSpec' + Optional. Configuration options for the tree-AH algorithm (Shallow + tree + Asymmetric Hashing). Please refer to this paper for more + details: https://arxiv.org/abs/1908.10396 + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig + embeddingColumn: description: >- - Optional. Persistent Resource runtime spec. For example, used for - Ray cluster configuration. + Optional. Column of embedding. This column contains the source data + to create index for vector search. embedding_column must be set when + using vector search. + type: string type: object - description: >- - Represents long-lasting resources that are dedicated to users to runs - custom workloads. A PersistentResource can have multiple node pools and - each node pool can have its own machine spec. - GoogleCloudAiplatformV1ModelEvaluationSliceSlice: - description: Definition of a slice. + GoogleCloudAiplatformV1RemoveDatapointsRequest: + description: Request message for IndexService.RemoveDatapoints + properties: + datapointIds: + description: A list of datapoint ids to be deleted. + items: + type: string + type: array + id: GoogleCloudAiplatformV1RemoveDatapointsRequest + type: object + GoogleCloudAiplatformV1PauseScheduleRequest: + description: Request message for ScheduleService.PauseSchedule. + type: object + id: GoogleCloudAiplatformV1PauseScheduleRequest + properties: {} + GoogleCloudAiplatformV1TrainingConfig: type: object + id: GoogleCloudAiplatformV1TrainingConfig properties: - dimension: - type: string + timeoutTrainingMilliHours: description: >- - Output only. The dimension of the slice. Well-known dimensions are: - * `annotationSpec`: This slice is on the test data that has either - ground truth or prediction with AnnotationSpec.display_name equals - to value. * `slice`: This slice is a user customized slice defined - by its SliceSpec. - readOnly: true - value: + The timeout hours for the CMLE training job, expressed in milli + hours i.e. 1,000 value in this field means 1 hour. type: string - readOnly: true - description: Output only. The value of the dimension in this slice. - sliceSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec - readOnly: true - description: Output only. Specification for how the data was sliced. - id: GoogleCloudAiplatformV1ModelEvaluationSliceSlice - GoogleCloudAiplatformV1Tool: + format: int64 + description: >- + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained model + will be used by data sampling algorithm to select DataItems. + GoogleCloudAiplatformV1XraiAttribution: + type: object + id: GoogleCloudAiplatformV1XraiAttribution properties: - retrieval: + smoothGradConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SmoothGradConfig' description: >- - Optional. Retrieval tool type. System will always execute the - provided retrieval tool(s) to get external knowledge to answer the - prompt. Retrieval results are presented to the model for generation. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Retrieval' - functionDeclarations: + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy + samples in the vicinity of the inputs. Adding noise can help improve + the computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + stepCount: + type: integer + format: int32 description: >- - Optional. Function tool type. One or more function declarations to - be passed to the model along with the current user query. Model may - decide to call a subset of these functions by populating - FunctionCall in the response. User should provide a FunctionResponse - for each function call in the next turn. Based on the function - responses, Model will generate the final response back to the user. - Maximum 64 function declarations can be provided. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionDeclaration' - type: array - googleSearchRetrieval: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GoogleSearchRetrieval' + Required. The number of steps for approximating the path integral. A + good value to start is 50 and gradually increase until the sum to + diff property is met within the desired error range. Valid range of + its value is [1, 100], inclusively. + blurBaselineConfig: description: >- - Optional. GoogleSearchRetrieval tool type. Specialized retrieval - tool that is powered by Google search. - id: GoogleCloudAiplatformV1Tool + Config for XRAI with blur baseline. When enabled, a linear path from + the maximally blurred image to the input image is created. Using a + blurred baseline instead of zero (black image) is motivated by the + BlurIG approach explained here: https://arxiv.org/abs/2004.03383 + $ref: '#/components/schemas/GoogleCloudAiplatformV1BlurBaselineConfig' description: >- - Tool details that the model may use to generate response. A `Tool` is a - piece of code that enables the system to interact with external systems - to perform an action, or set of actions, outside of knowledge and scope - of the model. A Tool object should contain exactly one type of Tool (e.g - FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + An explanation method that redistributes Integrated Gradients + attributions to segmented regions, taking advantage of the model's fully + differentiable structure. Refer to this paper for more details: + https://arxiv.org/abs/1906.02825 Supported only by image Models. + GoogleCloudAiplatformV1PersistentDiskSpec: + id: GoogleCloudAiplatformV1PersistentDiskSpec + properties: + diskType: + description: >- + Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" + (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk + Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) + "pd-extreme" (Extreme Persistent Disk) + type: string + diskSizeGb: + type: string + format: int64 + description: Size in GB of the disk (default is 100GB). + description: Represents the spec of persistent disk options. type: object - GoogleCloudAiplatformV1ExplanationMetadataInputMetadata: - id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadata + GoogleCloudAiplatformV1FeatureNoiseSigma: description: >- - Metadata of the input of a feature. Fields other than - InputMetadata.input_baselines are applicable only for Models that are - using Vertex AI-provided images for Tensorflow. + Noise sigma by features. Noise sigma represents the standard deviation + of the gaussian kernel that will be used to add noise to interpolated + inputs prior to computing gradients. + type: object + id: GoogleCloudAiplatformV1FeatureNoiseSigma properties: - inputTensorName: - type: string + noiseSigma: description: >- - Name of the input tensor for this feature. Required and is only - applicable to Vertex AI-provided images for Tensorflow. - encodedBaselines: - items: - type: any + Noise sigma per feature. No noise is added to features that are not + set. type: array - description: >- - A list of baselines for the encoded tensor. The shape of each - baseline should match the shape of the encoded tensor. If a scalar - is provided, Vertex AI broadcasts to the same shape as the encoded - tensor. - denseShapeTensorName: - description: >- - Specifies the shape of the values of the input if the input is a - sparse representation. Refer to Tensorflow documentation for more - details: - https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigmaNoiseSigmaForFeature + GoogleCloudAiplatformV1CancelNasJobRequest: + id: GoogleCloudAiplatformV1CancelNasJobRequest + description: Request message for JobService.CancelNasJob. + properties: {} + type: object + GoogleCloudAiplatformV1Artifact: + description: Instance of a general artifact. + properties: + etag: type: string - encodedTensorName: description: >- - Encoded tensor is a transformation of the input tensor. Must be - provided if choosing Integrated Gradients attribution or XRAI - attribution and the input tensor is not differentiable. An encoded - tensor is generated if the input tensor is encoded by a lookup - table. + An eTag used to perform consistent read-modify-write updates. If not + set, a blind "overwrite" update happens. + schemaTitle: type: string - inputBaselines: - description: >- - Baseline inputs for this feature. If no baseline is specified, - Vertex AI chooses the baseline for this feature. If multiple - baselines are specified, Vertex AI returns the average attributions - across them in Attribution.feature_attributions. For Vertex - AI-provided Tensorflow images (both 1.x and 2.x), the shape of each - baseline must match the shape of the input tensor. If a scalar is - provided, we broadcast to the same shape as the input tensor. For - custom images, the element of the baselines must be in the same - format as the feature's input in the instance[]. The schema of any - single instance may be specified via Endpoint's DeployedModels' - Model's PredictSchemata's instance_schema_uri. - items: - type: any - type: array - visualization: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization - description: Visualization configurations for image explanation. - featureValueDomain: description: >- - The domain details of the input feature value. Like min/max, - original mean or standard deviation if normalized. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain - indicesTensorName: + The title of the schema describing the metadata. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + name: type: string + description: Output only. The resource name of the Artifact. + readOnly: true + metadata: + type: object + additionalProperties: + description: Properties of the object. + type: any description: >- - Specifies the index of the values of the input tensor. Required when - the input tensor is a sparse representation. Refer to Tensorflow - documentation for more details: - https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. - modality: - description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. + Properties of the Artifact. Top level metadata keys' heading and + trailing spaces will be trimmed. The size of this field should not + exceed 200KB. + updateTime: + description: Output only. Timestamp when this Artifact was last updated. + readOnly: true + format: google-datetime type: string - groupName: + labels: + additionalProperties: + type: string + type: object description: >- - Name of the group that the input belongs to. Features with the same - group name will be treated as one feature when computing - attributions. Features grouped together can have different shapes in - value. If provided, there will be one single attribution generated - in Attribution.feature_attributions, keyed by the group name. + The labels with user-defined metadata to organize your Artifacts. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Artifact (System + labels are excluded). + schemaVersion: type: string - encoding: description: >- - Defines how the feature is encoded into the input tensor. Defaults - to IDENTITY. - type: string + The version of the schema in schema_name to use. Schema title and + version is expected to be registered in earlier Create Schema calls. + And both are used together as unique identifiers to identify schemas + within the local metadata store. + state: enum: - - ENCODING_UNSPECIFIED - - IDENTITY - - BAG_OF_FEATURES - - BAG_OF_FEATURES_SPARSE - - INDICATOR - - COMBINED_EMBEDDING - - CONCAT_EMBEDDING + - STATE_UNSPECIFIED + - PENDING + - LIVE + description: >- + The state of this Artifact. This is a property of the Artifact, and + does not imply or capture any ongoing process. This property is + managed by clients (such as Vertex AI Pipelines), and the system + does not prescribe or check the validity of state transitions. enumDescriptions: - - Default value. This is the same as IDENTITY. - - The tensor represents one feature. - - >- - The tensor represents a bag of features where each index maps to a - feature. InputMetadata.index_feature_mapping must be provided for - this encoding. For example: ``` input = [27, 6.0, 150] - index_feature_mapping = ["age", "height", "weight"] ``` - - >- - The tensor represents a bag of features where each index maps to a - feature. Zero values in the tensor indicates feature being - non-existent. InputMetadata.index_feature_mapping must be provided - for this encoding. For example: ``` input = [2, 0, 5, 0, 1] - index_feature_mapping = ["a", "b", "c", "d", "e"] ``` - - >- - The tensor is a list of binaries representing whether a feature - exists or not (1 indicates existence). - InputMetadata.index_feature_mapping must be provided for this - encoding. For example: ``` input = [1, 0, 1, 0, 1] - index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + - Unspecified state for the Artifact. - >- - The tensor is encoded into a 1-dimensional array represented by an - encoded tensor. InputMetadata.encoded_tensor_name must be provided - for this encoding. For example: ``` input = ["This", "is", "a", - "test", "."] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ``` + A state used by systems like Vertex AI Pipelines to indicate that + the underlying data item represented by this Artifact is being + created. - >- - Select this encoding when the input tensor is encoded into a - 2-dimensional array represented by an encoded tensor. - InputMetadata.encoded_tensor_name must be provided for this - encoding. The first dimension of the encoded tensor's shape is the - same as the input tensor's shape. For example: ``` input = - ["This", "is", "a", "test", "."] encoded = [[0.1, 0.2, 0.3, 0.4, - 0.5], [0.2, 0.1, 0.4, 0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, - 0.3, 0.1, 0.2, 0.4], [0.4, 0.3, 0.2, 0.5, 0.1]] ``` - indexFeatureMapping: - items: - type: string + A state indicating that the Artifact should exist, unless + something external to the system deletes it. + type: string + displayName: + type: string description: >- - A list of feature names for each index in the input tensor. Required - when the input InputMetadata.encoding is BAG_OF_FEATURES, - BAG_OF_FEATURES_SPARSE, INDICATOR. - type: array - type: object - GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: - description: The embedding vector. + User provided display name of the Artifact. May be up to 128 Unicode + characters. + description: + description: Description of the Artifact + type: string + uri: + type: string + description: >- + The uniform resource identifier of the artifact file. May be empty + if there is no actual artifact file. + createTime: + type: string + format: google-datetime + description: Output only. Timestamp when this Artifact was created. + readOnly: true + id: GoogleCloudAiplatformV1Artifact type: object + GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse: + description: Response message for ModelService.BatchImportModelEvaluationSlices properties: - value: - items: - format: float - type: number - description: Optional. Individual value in the embedding. + importedModelEvaluationSlices: type: array - id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding - GoogleCloudAiplatformV1SamplingStrategy: - properties: - randomSampleConfig: - description: Random sample config. Will support more sampling strategies later. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - type: object - description: >- - Sampling Strategy for logging, can be for both training and prediction - dataset. - id: GoogleCloudAiplatformV1SamplingStrategy - GoogleCloudAiplatformV1Event: - type: object - id: GoogleCloudAiplatformV1Event - description: >- - An edge describing the relationship between an Artifact and an Execution - in a lineage graph. - properties: - eventTime: - type: string - format: google-datetime - description: Output only. Time the Event occurred. + description: Output only. List of imported ModelEvaluationSlice.name. readOnly: true - labels: - type: object - description: >- - The labels with user-defined metadata to annotate Events. Label keys - and values can be no longer than 64 characters (Unicode codepoints), - can only contain lowercase letters, numeric characters, underscores - and dashes. International characters are allowed. No more than 64 - user labels can be associated with one Event (System labels are - excluded). See https://goo.gl/xmQnxf for more information and - examples of labels. System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - additionalProperties: + items: type: string - artifact: - description: Required. The relative resource name of the Artifact in the Event. - type: string - execution: - readOnly: true - type: string + type: object + id: GoogleCloudAiplatformV1BatchImportModelEvaluationSlicesResponse + GoogleCloudAiplatformV1SyncFeatureViewResponse: + id: GoogleCloudAiplatformV1SyncFeatureViewResponse + description: Response message for FeatureOnlineStoreAdminService.SyncFeatureView. + properties: + featureViewSync: description: >- - Output only. The relative resource name of the Execution in the - Event. - type: - enumDescriptions: - - Unspecified whether input or output of the Execution. - - An input of the Execution. - - An output of the Execution. - description: Required. The type of the Event. + Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` type: string - enum: - - TYPE_UNSPECIFIED - - INPUT - - OUTPUT - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: - description: Metrics for text extraction evaluation results. type: object + GoogleCloudAiplatformV1ListDatasetVersionsResponse: properties: - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: >- - Confusion matrix of the evaluation. Only set for Models where number - of AnnotationSpecs is no more than 10. Only set for - ModelEvaluations, not for ModelEvaluationSlices. - confidenceMetrics: - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from them. + nextPageToken: + type: string + description: The standard List next-page token. + datasetVersions: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' type: array - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics: - description: Model evaluation metrics for video action recognition. + description: >- + A list of DatasetVersions that matches the specified filter in the + request. + type: object + id: GoogleCloudAiplatformV1ListDatasetVersionsResponse + description: Response message for DatasetService.ListDatasetVersions. + GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionRecognitionMetrics properties: - evaluatedActionCount: - description: The number of ground truth actions used to create this evaluation. + candidatesTokenCount: + format: int32 + description: Number of tokens in the response(s). + type: integer + promptTokenCount: type: integer format: int32 - videoActionMetrics: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics - description: 'The metric entries for precision window lengths: 1s,2s,3s.' - GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: - id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec - properties: - explanationType: - type: string description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - description: Explanation spec details. - type: object - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource: + Number of tokens in the request. When `cached_content` is set, this + is still the total effective prompt size meaning this includes the + number of tokens in the cached content. + totalTokenCount: + format: int32 + description: Total token count for prompt and response candidates. + type: integer + description: Usage metadata about response(s). + id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata + GoogleCloudAiplatformV1GroundednessResult: + id: GoogleCloudAiplatformV1GroundednessResult type: object + description: Spec for groundedness result. properties: - featureGroups: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - description: Required. List of features that need to be synced to Online Store. - projectNumber: + confidence: + type: number + format: float + readOnly: true + description: Output only. Confidence for groundedness score. + score: + readOnly: true + type: number + description: Output only. Groundedness score. + format: float + explanation: type: string - format: int64 - description: >- - Optional. The project number of the parent project of the Feature - Groups. - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource - description: >- - A Feature Registry source for features that need to be synced to Online - Store. - GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata: + description: Output only. Explanation for groundedness score. + readOnly: true + GoogleCloudAiplatformV1SummarizationQualityResult: + description: Spec for summarization quality result. + type: object + id: GoogleCloudAiplatformV1SummarizationQualityResult properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. + score: + format: float + readOnly: true + type: number + description: Output only. Summarization Quality score. + explanation: + type: string + readOnly: true + description: Output only. Explanation for summarization quality score. + confidence: + type: number + description: Output only. Confidence for summarization quality score. + readOnly: true + format: float + GoogleCloudAiplatformV1QuestionAnsweringQualityInstance: + properties: + prediction: + type: string + description: Required. Output of the evaluated model. + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + context: + type: string + description: Required. Text to answer the question. + instruction: + description: Required. Question Answering prompt for LLM. + type: string + id: GoogleCloudAiplatformV1QuestionAnsweringQualityInstance type: object - description: Runtime operation information for CreateDeploymentResourcePool method. - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolOperationMetadata - GoogleCloudAiplatformV1TokensInfo: + description: Spec for question answering quality instance. + GoogleCloudAiplatformV1ExportFractionSplit: description: >- - Tokens info with a list of tokens and the corresponding list of token - ids. - id: GoogleCloudAiplatformV1TokensInfo + Assigns the input data to training, validation, and test sets as per the + given fractions. Any of `training_fraction`, `validation_fraction` and + `test_fraction` may optionally be provided, they must sum to up to 1. If + the provided ones sum to less than 1, the remainder is assigned to sets + as decided by Vertex AI. If none of the fractions are set, by default + roughly 80% of data is used for training, 10% for validation, and 10% + for test. + id: GoogleCloudAiplatformV1ExportFractionSplit + type: object properties: - tokens: - description: A list of tokens from the input. - type: array - items: - format: byte - type: string - tokenIds: - description: A list of token ids from the input. - type: array - items: - type: string - format: int64 + validationFraction: + format: double + type: number + description: >- + The fraction of the input data that is to be used to validate the + Model. + testFraction: + description: >- + The fraction of the input data that is to be used to evaluate the + Model. + type: number + format: double + trainingFraction: + format: double + type: number + description: >- + The fraction of the input data that is to be used to train the + Model. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: type: object - GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + properties: + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation + GoogleCloudAiplatformV1ListIndexEndpointsResponse: type: object - description: Configurations for PublisherModel GKE deployment properties: - gkeYamlConfigs: + indexEndpoints: items: - type: string - description: Optional. GKE deployment configuration in yaml format. + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' type: array - GoogleCloudAiplatformV1UndeployIndexRequest: - description: Request message for IndexEndpointService.UndeployIndex. - type: object - properties: - deployedIndexId: + description: List of IndexEndpoints in the requested page. + nextPageToken: description: >- - Required. The ID of the DeployedIndex to be undeployed from the - IndexEndpoint. + A token to retrieve next page of results. Pass to + ListIndexEndpointsRequest.page_token to obtain that page. type: string - id: GoogleCloudAiplatformV1UndeployIndexRequest - GoogleCloudAiplatformV1BatchMigrateResourcesRequest: + id: GoogleCloudAiplatformV1ListIndexEndpointsResponse + description: Response message for IndexEndpointService.ListIndexEndpoints. + GoogleCloudAiplatformV1ModelContainerSpec: + id: GoogleCloudAiplatformV1ModelContainerSpec + description: >- + Specification of a container for serving predictions. Some fields in + this message correspond to fields in the [Kubernetes Container v1 core + specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). type: object - description: Request message for MigrationService.BatchMigrateResources. properties: - migrateResourceRequests: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequest' + startupProbe: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + description: Immutable. Specification for Kubernetes startup probe. + imageUri: description: >- - Required. The request messages specifying the resources to migrate. - They must be in the same location as the destination. Up to 50 - resources can be migrated in one batch. + Required. Immutable. URI of the Docker image to be used as the + custom container for serving predictions. This URI must identify an + image in Artifact Registry or Container Registry. Learn more about + the [container publishing + requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), + including permissions requirements for the Vertex AI Service Agent. + The container image is ingested upon ModelService.UploadModel, + stored internally, and this original path is afterwards not used. To + learn about the requirements for the Docker image itself, see + [Custom container + requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). + You can use the URI to one of Vertex AI's [pre-built container + images for + prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) + in this field. + type: string + grpcPorts: type: array - id: GoogleCloudAiplatformV1BatchMigrateResourcesRequest - GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling: - properties: - cpuUtilizationTarget: - type: integer - format: int32 - description: >- - Optional. A percentage of the cluster's CPU capacity. Can be from - 10% to 80%. When a cluster's CPU utilization exceeds the target that - you have set, Bigtable immediately adds nodes to the cluster. When - CPU utilization is substantially lower than the target, Bigtable - removes nodes. If not set will default to 50%. - minNodeCount: - type: integer description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. - format: int32 - maxNodeCount: + Immutable. List of ports to expose from the container. Vertex AI + sends gRPC prediction requests that it receives to the first port on + this list. Vertex AI also sends liveness and health checks to this + port. If you do not specify this field, gRPC requests to the + container will be disabled. Vertex AI does not use ports other than + the first one listed. This field corresponds to the `ports` field of + the Kubernetes Containers v1 core API. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' + command: + type: array + items: + type: string description: >- - Required. The maximum number of nodes to scale up to. Must be - greater than or equal to min_node_count, and less than or equal to - 10 times of 'min_node_count'. - type: integer - format: int32 - id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling - type: object - GoogleCloudAiplatformV1CopyModelResponse: - type: object - id: GoogleCloudAiplatformV1CopyModelResponse - description: Response message of ModelService.CopyModel operation. - properties: - modelVersionId: - description: Output only. The version ID of the model that is copied. + Immutable. Specifies the command that runs when the container + starts. This overrides the container's + [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). + Specify this field as an array of executable and arguments, similar + to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you + do not specify this field, then the container's `ENTRYPOINT` runs, + in conjunction with the args field or the container's + [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if + either exists. If this field is not specified and the container does + not have an `ENTRYPOINT`, then refer to the Docker documentation + about [how `CMD` and `ENTRYPOINT` + interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). + If you specify this field, then you can also specify the `args` + field to provide additional arguments for this command. However, if + you specify this field, then the container's `CMD` is ignored. See + the [Kubernetes documentation about how the `command` and `args` + fields interact with a container's `ENTRYPOINT` and + `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). + In this field, you can reference [environment variables set by + Vertex + AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) + and environment variables set in the env field. You cannot reference + environment variables set in the Docker image. In order for + environment variables to be expanded, reference them by using the + following syntax: $( VARIABLE_NAME) Note that this differs from Bash + variable expansion, which does not use parentheses. If a variable + cannot be resolved, the reference in the input string is used + unchanged. To avoid variable expansion, you can escape this syntax + with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to + the `command` field of the Kubernetes Containers [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + sharedMemorySizeMb: + format: int64 type: string - readOnly: true - model: description: >- - The name of the copied Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` - type: string - GoogleCloudAiplatformV1PublisherModelDocumentation: - id: GoogleCloudAiplatformV1PublisherModelDocumentation - description: A named piece of documentation. - properties: - content: - type: string - description: Required. Content of this piece of document (in Markdown format). - title: + Immutable. The amount of the VM memory to reserve as the shared + memory for the model in megabytes. + deploymentTimeout: + format: google-duration description: >- - Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, - JAVA, NODE.JS, etc.. + Immutable. Deployment timeout. Limit for deployment timeout is 2 + hours. type: string - type: object - GoogleCloudAiplatformV1DeploymentResourcePool: - id: GoogleCloudAiplatformV1DeploymentResourcePool - properties: - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + healthRoute: description: >- - Required. The underlying DedicatedResources that the - DeploymentResourcePool uses. - serviceAccount: + Immutable. HTTP path on the container to send health checks to. + Vertex AI intermittently sends GET requests to this path on the + container's IP address and port to check that the container is + healthy. Read more about [health + checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). + For example, if you set this field to `/bar`, then Vertex AI + intermittently sends a GET request to the `/bar` path on the port of + your container specified by the first value of this + `ModelContainerSpec`'s ports field. If you don't specify this field, + it defaults to the following value when you deploy this Model to an + Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ + DEPLOYED_MODEL:predict The placeholders in this value are replaced + as follows: * ENDPOINT: The last segment (following `endpoints/`)of + the Endpoint.name][] field of the Endpoint where this Model has been + deployed. (Vertex AI makes this value available to your container + code as the [`AIP_ENDPOINT_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex + AI makes this value available to your container code as the + [`AIP_DEPLOYED_MODEL_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) type: string + predictRoute: description: >- - The service account that the DeploymentResourcePool's container(s) - run as. Specify the email address of the service account. If this - service account is not specified, the container(s) run as a service - account that doesn't have access to the resource project. Users - deploying the Models to this DeploymentResourcePool must have the - `iam.serviceAccounts.actAs` permission on this service account. - name: + Immutable. HTTP path on the container to send prediction requests + to. Vertex AI forwards requests sent using + projects.locations.endpoints.predict to this path on the container's + IP address and port. Vertex AI then returns the container's response + in the API response. For example, if you set this field to `/foo`, + then when Vertex AI receives a prediction request, it forwards the + request body in a POST request to the `/foo` path on the port of + your container specified by the first value of this + `ModelContainerSpec`'s ports field. If you don't specify this field, + it defaults to the following value when you deploy this Model to an + Endpoint: + /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The + placeholders in this value are replaced as follows: * ENDPOINT: The + last segment (following `endpoints/`)of the Endpoint.name][] field + of the Endpoint where this Model has been deployed. (Vertex AI makes + this value available to your container code as the + [`AIP_ENDPOINT_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) + * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex + AI makes this value available to your container code as the + [`AIP_DEPLOYED_MODEL_ID` environment + variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) type: string + args: + type: array + items: + type: string description: >- - Immutable. The resource name of the DeploymentResourcePool. Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Immutable. Specifies arguments for the command that runs when the + container starts. This overrides the container's + [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). + Specify this field as an array of executable and arguments, similar + to a Docker `CMD`'s "default parameters" form. If you don't specify + this field but do specify the command field, then the command from + the `command` field runs without any additional arguments. See the + [Kubernetes documentation about how the `command` and `args` fields + interact with a container's `ENTRYPOINT` and + `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). + If you don't specify this field and don't specify the `command` + field, then the container's + [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) + and `CMD` determine what runs based on their default behavior. See + the Docker documentation about [how `CMD` and `ENTRYPOINT` + interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). + In this field, you can reference [environment variables set by + Vertex + AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) + and environment variables set in the env field. You cannot reference + environment variables set in the Docker image. In order for + environment variables to be expanded, reference them by using the + following syntax: $( VARIABLE_NAME) Note that this differs from Bash + variable expansion, which does not use parentheses. If a variable + cannot be resolved, the reference in the input string is used + unchanged. To avoid variable expansion, you can escape this syntax + with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to + the `args` field of the Kubernetes Containers [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + env: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' description: >- - Customer-managed encryption key spec for a DeploymentResourcePool. - If set, this DeploymentResourcePool will be secured by this key. - Endpoints and the DeploymentResourcePool they deploy in need to have - the same EncryptionSpec. - createTime: - description: Output only. Timestamp when this DeploymentResourcePool was created. - format: google-datetime - readOnly: true - type: string - disableContainerLogging: - type: boolean + Immutable. List of environment variables to set in the container. + After the container starts running, code running in the container + can read these environment variables. Additionally, the command and + args fields can reference these variables. Later entries in this + list can also reference earlier entries. For example, the following + example sets the variable `VAR_2` to have the value `foo bar`: + ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", + "value": "$(VAR_1) bar" } ] ``` If you switch the order of the + variables in the example, then the expansion does not occur. This + field corresponds to the `env` field of the Kubernetes Containers + [v1 core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + healthProbe: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Probe' + description: Immutable. Specification for Kubernetes readiness probe. + ports: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Port' description: >- - If the DeploymentResourcePool is deployed with custom-trained Models - or AutoML Tabular Models, the container(s) of the - DeploymentResourcePool will send `stderr` and `stdout` streams to - Cloud Logging by default. Please note that the logs incur cost, - which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - description: >- - A description of resources that can be shared by multiple - DeployedModels, whose underlying specification consists of a - DedicatedResources. - type: object - GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: - properties: {} - id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + Immutable. List of ports to expose from the container. Vertex AI + sends any prediction requests that it receives to the first port on + this list. Vertex AI also sends [liveness and health + checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) + to this port. If you do not specify this field, it defaults to + following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI + does not use ports other than the first one listed. This field + corresponds to the `ports` field of the Kubernetes Containers [v1 + core + API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). + GoogleCloudAiplatformV1ListEntityTypesResponse: + description: Response message for FeaturestoreService.ListEntityTypes. + id: GoogleCloudAiplatformV1ListEntityTypesResponse type: object - description: Request message for JobService.PauseModelDeploymentMonitoringJob. - GoogleCloudAiplatformV1MutateDeployedIndexResponse: properties: - deployedIndex: - description: The DeployedIndex that had been updated in the IndexEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - id: GoogleCloudAiplatformV1MutateDeployedIndexResponse + nextPageToken: + description: >- + A token, which can be sent as ListEntityTypesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + type: string + entityTypes: + type: array + description: The EntityTypes matching the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + GoogleCloudAiplatformV1PipelineJobRuntimeConfig: type: object - description: Response message for IndexEndpointService.MutateDeployedIndex. - GoogleCloudAiplatformV1BatchDedicatedResources: - description: >- - A description of resources that are used for performing batch - operations, are dedicated to a Model, and need manual configuration. - id: GoogleCloudAiplatformV1BatchDedicatedResources + description: The runtime config of a PipelineJob. properties: - startingReplicaCount: + gcsOutputDirectory: description: >- - Immutable. The number of machine replicas used at the start of the - batch operation. If not set, Vertex AI decides starting number, not - greater than max_replica_count - type: integer - format: int32 - maxReplicaCount: - format: int32 - type: integer + Required. A path in a Cloud Storage bucket, which will be treated as + the root output directory of the pipeline. It is used by the system + to generate the paths of output artifacts. The artifact paths are + generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` + under the specified output directory. The service account specified + in this pipeline must have the `storage.objects.get` and + `storage.objects.create` permissions for this bucket. + type: string + parameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Value' + type: object description: >- - Immutable. The maximum number of machine replicas the batch - operation may be scaled to. The default value is 10. - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: Required. Immutable. The specification of a single machine. - type: object - GoogleCloudAiplatformV1IndexDatapointNumericRestriction: - id: GoogleCloudAiplatformV1IndexDatapointNumericRestriction - description: >- - This field allows restricts to be based on numeric comparisons rather - than categorical tokens. - type: object - properties: - valueDouble: - type: number - description: Represents 64 bit float. - format: double - valueInt: - description: Represents 64 bit integer. + Deprecated. Use RuntimeConfig.parameter_values instead. The runtime + parameters of the PipelineJob. The parameters will be passed into + PipelineJob.pipeline_spec to replace the placeholders at runtime. + This field is used by pipelines built using + `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as + pipelines built using Kubeflow Pipelines SDK 1.8 or lower. + deprecated: true + inputArtifacts: + description: >- + The runtime artifacts of the PipelineJob. The key will be the input + artifact name and the value would be one of the InputArtifact. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact + type: object + failurePolicy: type: string - format: int64 - op: description: >- - This MUST be specified for queries and must NOT be specified for - datapoints. - enumDescriptions: - - Default value of the enum. - - Datapoints are eligible iff their value is < the query's. - - Datapoints are eligible iff their value is <= the query's. - - Datapoints are eligible iff their value is == the query's. - - Datapoints are eligible iff their value is >= the query's. - - Datapoints are eligible iff their value is > the query's. - - Datapoints are eligible iff their value is != the query's. + Represents the failure policy of a pipeline. Currently, the default + of a pipeline is that the pipeline will continue to run until no + more tasks can be executed, also known as + PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to + PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new + tasks when a task has failed. Any scheduled tasks will continue to + completion. enum: - - OPERATOR_UNSPECIFIED - - LESS - - LESS_EQUAL - - EQUAL - - GREATER_EQUAL - - GREATER - - NOT_EQUAL - type: string - namespace: - type: string - description: 'The namespace of this restriction. e.g.: cost.' - valueFloat: - description: Represents 32 bit float. - format: float - type: number - GoogleCloudAiplatformV1Tensor: - type: object - description: A tensor value type. - properties: - structVal: - description: A map of string to tensor. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - stringVal: - items: - type: string - type: array - description: STRING - shape: - items: - format: int64 - type: string - description: Shape of the tensor. - type: array - uintVal: - description: UINT8 UINT16 UINT32 - type: array - items: - format: uint32 - type: integer - boolVal: - type: array - description: >- - Type specific representations that make it easy to create tensor - protos in all languages. Only the representation corresponding to - "dtype" can be set. The values hold the flattened representation of - the tensor in row major order. BOOL - items: - type: boolean - intVal: - items: - format: int32 - type: integer - type: array - description: INT_8 INT_16 INT_32 - tensorVal: - description: Serialized raw tensor content. - format: byte - type: string - floatVal: - description: FLOAT - type: array - items: - format: float - type: number - bytesVal: - description: STRING - type: array - items: - type: string - format: byte - int64Val: - items: - type: string - format: int64 - description: INT64 - type: array - doubleVal: - items: - format: double - type: number - description: DOUBLE - type: array - dtype: - type: string - description: The data type of tensor. - enum: - - DATA_TYPE_UNSPECIFIED - - BOOL - - STRING - - FLOAT - - DOUBLE - - INT8 - - INT16 - - INT32 - - INT64 - - UINT8 - - UINT16 - - UINT32 - - UINT64 + - PIPELINE_FAILURE_POLICY_UNSPECIFIED + - PIPELINE_FAILURE_POLICY_FAIL_SLOW + - PIPELINE_FAILURE_POLICY_FAIL_FAST enumDescriptions: + - Default value, and follows fail slow behavior. - >- - Not a legal value for DataType. Used to indicate a DataType field - has not been set. + Indicates that the pipeline should continue to run until all + possible tasks have been scheduled and completed. - >- - Data types that all computation devices are expected to be capable - to support. - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - uint64Val: - items: - type: string - format: uint64 - description: UINT64 - type: array - listVal: - description: A list of tensor values. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: array - id: GoogleCloudAiplatformV1Tensor - GoogleCloudAiplatformV1Tensorboard: - type: object - properties: - displayName: - type: string - description: Required. User provided name of this Tensorboard. - blobStoragePathPrefix: - description: >- - Output only. Consumer project Cloud Storage path prefix used to - store blob data, which can either be a bucket or directory. Does not - end with a '/'. - readOnly: true - type: string - isDefault: - type: boolean - description: >- - Used to indicate if the TensorBoard instance is the default one. - Each project & region can have at most one default TensorBoard - instance. Creation of a default TensorBoard instance and updating an - existing TensorBoard instance to be default will mark all other - TensorBoard instances (if any) as non default. - encryptionSpec: - description: >- - Customer-managed encryption key spec for a Tensorboard. If set, this - Tensorboard and all sub-resources of this Tensorboard will be - secured by this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - labels: + Indicates that the pipeline should stop scheduling new tasks after + a task has failed. + parameterValues: + additionalProperties: + type: any type: object description: >- - The labels with user-defined metadata to organize your Tensorboards. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Tensorboard - (System labels are excluded). See https://goo.gl/xmQnxf for more - information and examples of labels. System reserved label keys are - prefixed with "aiplatform.googleapis.com/" and are immutable. - additionalProperties: - type: string - createTime: - description: Output only. Timestamp when this Tensorboard was created. - format: google-datetime + The runtime parameters of the PipelineJob. The parameters will be + passed into PipelineJob.pipeline_spec to replace the placeholders at + runtime. This field is used by pipelines built using + `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines + built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfig + GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: + type: object + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + properties: + monitorWindow: + format: google-duration type: string - readOnly: true - etag: description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - type: string - runCount: - format: int32 - type: integer - description: Output only. The number of Runs stored in this Tensorboard. - readOnly: true - updateTime: - type: string - format: google-datetime - description: Output only. Timestamp when this Tensorboard was last updated. - readOnly: true - name: - readOnly: true - type: string + The time window of the prediction data being included in each + prediction dataset. This window specifies how long the data should + be collected from historical model results for each run. If not set, + ModelDeploymentMonitoringScheduleConfig.monitor_interval will be + used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and + the monitor_window is set to be 3600, then data from 2022-01-08 + 13:30:00 to 2022-01-08 14:30:00 will be retrieved and aggregated to + calculate the monitoring statistics. + monitorInterval: description: >- - Output only. Name of the Tensorboard. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}` - description: - description: Description of this Tensorboard. + Required. The model monitoring job scheduling interval. It will be + rounded up to next full hour. This defines how often the monitoring + jobs are triggered. type: string + format: google-duration + description: The config for scheduling monitoring job. + GoogleCloudAiplatformV1PrivateEndpoints: description: >- - Tensorboard is a physical database that stores users' training metrics. - A default Tensorboard is provided in each region of a Google Cloud - project. If needed users can also create extra Tensorboards in their - projects. - id: GoogleCloudAiplatformV1Tensorboard - GoogleCloudAiplatformV1SupervisedTuningDataStats: - description: Tuning data statistics for Supervised Tuning. + PrivateEndpoints proto is used to provide paths for users to send + requests privately. To send request via private service access, use + predict_http_uri, explain_http_uri or health_http_uri. To send request + via private service connect, use service_attachment. properties: - tuningStepCount: - readOnly: true - type: string - format: int64 - description: Output only. Number of tuning steps for this Tuning Job. - tuningDatasetExampleCount: + serviceAttachment: type: string readOnly: true - description: Output only. Number of examples in the tuning dataset. - format: int64 - userInputTokenDistribution: - description: Output only. Dataset distributions for the user input tokens. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - userMessagePerExampleDistribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - readOnly: true - description: Output only. Dataset distributions for the messages per example. - userOutputTokenDistribution: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution - description: Output only. Dataset distributions for the user output tokens. - readOnly: true - userDatasetExamples: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: >- + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. + explainHttpUri: readOnly: true - description: Output only. Sample user messages in the training dataset uri. - totalTuningCharacterCount: type: string - format: int64 - description: Output only. Number of tuning characters in the tuning dataset. + description: Output only. Http(s) path to send explain requests. + predictHttpUri: readOnly: true - totalBillableCharacterCount: + description: Output only. Http(s) path to send prediction requests. type: string - readOnly: true - format: int64 - description: Output only. Number of billable characters in the tuning dataset. - id: GoogleCloudAiplatformV1SupervisedTuningDataStats - type: object - GoogleCloudAiplatformV1SchemaImageDataItem: - description: Payload of Image DataItem. - properties: - gcsUri: - description: >- - Required. Google Cloud Storage URI points to the original image in - user's bucket. The image is up to 30MB in size. + healthHttpUri: type: string - mimeType: readOnly: true - type: string - description: >- - Output only. The mime type of the content of the image. Only the - images in below listed mime types are supported. - image/jpeg - - image/gif - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon - type: object - id: GoogleCloudAiplatformV1SchemaImageDataItem - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: - description: Prediction output format for Time Series Forecasting. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult - type: object - properties: - value: - format: float - type: number - description: The regression value. - quantileValues: - description: Quantile values. - type: array - items: - type: number - format: float - tftFeatureImportance: - description: Only use these if TFt is enabled. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance - quantilePredictions: - description: Quantile predictions, in 1-1 correspondence with quantile_values. - type: array - items: - format: float - type: number - GoogleCloudAiplatformV1DataItemView: - id: GoogleCloudAiplatformV1DataItemView - properties: - dataItem: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' - description: The DataItem. - annotations: - description: >- - The Annotations on the DataItem. If too many Annotations should be - returned for the DataItem, this field will be truncated per - annotations_limit in request. If it was, then the - has_truncated_annotations will be set to true. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' - type: array - hasTruncatedAnnotations: - description: >- - True if and only if the Annotations field has been truncated. It - happens if more Annotations for this DataItem met the request's - annotation_filter than are allowed to be returned by - annotations_limit. Note that if Annotations field is not being - returned due to field mask, then this field will not be set to true - no matter how many Annotations are there. - type: boolean - description: A container for a single DataItem and Annotations on it. + description: Output only. Http(s) path to send health check requests. type: object - GoogleCloudAiplatformV1ListDataLabelingJobsResponse: - description: Response message for JobService.ListDataLabelingJobs. - id: GoogleCloudAiplatformV1ListDataLabelingJobsResponse + id: GoogleCloudAiplatformV1PrivateEndpoints + GoogleCloudLocationListLocationsResponse: type: object properties: nextPageToken: - description: The standard List next-page token. type: string - dataLabelingJobs: + description: The standard List next-page token. + locations: + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' description: >- - A list of DataLabelingJobs that matches the specified filter in the + A list of locations that matches the specified filter in the request. type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' - GoogleCloudAiplatformV1CompleteTrialRequest: - description: Request message for VizierService.CompleteTrial. + description: The response message for Locations.ListLocations. + id: GoogleCloudLocationListLocationsResponse + GoogleCloudAiplatformV1RebootPersistentResourceRequest: + type: object + id: GoogleCloudAiplatformV1RebootPersistentResourceRequest + description: Request message for PersistentResourceService.RebootPersistentResource. + properties: {} + GoogleCloudAiplatformV1DirectRawPredictRequest: type: object + id: GoogleCloudAiplatformV1DirectRawPredictRequest properties: - infeasibleReason: + input: type: string + format: byte + description: The prediction input. + methodName: description: >- - Optional. A human readable reason why the trial was infeasible. This - should only be provided if `trial_infeasible` is true. - trialInfeasible: - description: >- - Optional. True if the Trial cannot be run with the given Parameter, - and final_measurement will be ignored. - type: boolean - finalMeasurement: - description: >- - Optional. If provided, it will be used as the completed Trial's - final_measurement; Otherwise, the service will auto-select a - previously reported measurement as the final-measurement - $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' - id: GoogleCloudAiplatformV1CompleteTrialRequest - GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: + Fully qualified name of the API method being invoked to perform + predictions. Format: `/namespace.Service/Method/` Example: + `/tensorflow.serving.PredictionService/Predict` + type: string + description: Request message for PredictionService.DirectRawPredict. + GoogleCloudAiplatformV1CopyModelOperationMetadata: properties: - horizonWeights: - items: - type: number - format: float - type: array - horizonColumns: - type: array - items: - type: string - contextWeights: - type: array + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + type: object + description: Details of ModelService.CopyModel operation. + id: GoogleCloudAiplatformV1CopyModelOperationMetadata + GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: + id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding + description: >- + Feature embedding vector for sparse index. An array of numbers whose + values are located in the specified dimensions. + properties: + dimensions: description: >- - TFT feature importance values. Each pair for - {context/horizon/attribute} should have the same shape since the - weight corresponds to the column names. - items: - format: float - type: number - attributeColumns: - items: - type: string - type: array - contextColumns: + Required. The list of indexes for the embedding values of the sparse + vector. items: type: string + format: int64 type: array - attributeWeights: + values: type: array items: type: number format: float - id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance - type: object - GoogleCloudAiplatformV1ExportModelOperationMetadata: - description: Details of ModelService.ExportModel operation. + description: Required. The list of embedding values of the sparse vector. type: object - id: GoogleCloudAiplatformV1ExportModelOperationMetadata + GoogleCloudAiplatformV1InputDataConfig: properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - outputInfo: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - readOnly: true + stratifiedSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StratifiedSplit' description: >- - Output only. Information further describing the output of this Model - export. - GoogleCloudAiplatformV1SchemaTextClassificationAnnotation: - type: object - id: GoogleCloudAiplatformV1SchemaTextClassificationAnnotation - properties: - displayName: - type: string + Supported only for tabular Datasets. Split based on the distribution + of the specified column. + timestampSplit: description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - annotationSpecId: + Supported only for tabular Datasets. Split based on the timestamp of + the input data pieces. + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimestampSplit' + predefinedSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredefinedSplit' description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - type: string - description: Annotation details specific to text classification. - GoogleCloudAiplatformV1QueryDeployedModelsResponse: - description: Response message for QueryDeployedModels method. - id: GoogleCloudAiplatformV1QueryDeployedModelsResponse - properties: - nextPageToken: + Supported only for tabular Datasets. Split based on a predefined + key. + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: >- + The Cloud Storage location where the training data is to be written + to. In the given directory a new directory is created with name: + `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 + format. All training input data is written into that directory. The + Vertex AI environment variables representing Cloud Storage data URIs + are represented in the Cloud Storage wildcard format to support + sharded data. e.g.: "gs://.../training-*.jsonl" * AIP_DATA_FORMAT = + "jsonl" for non-tabular data, "csv" for tabular data * + AIP_TRAINING_DATA_URI = + "gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}" * + AIP_VALIDATION_DATA_URI = + "gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}" * + AIP_TEST_DATA_URI = + "gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}" + datasetId: type: string description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - totalDeployedModelCount: - type: integer - format: int32 - description: The total number of DeployedModels on this DeploymentResourcePool. - deployedModelRefs: + Required. The ID of the Dataset in the same Project and Location + which data will be used to train the Model. The Dataset must use + schema compatible with Model being trained, and what is compatible + should be described in the used TrainingPipeline's + training_task_definition. For tabular Datasets, all their data is + exported to training, to pick and choose from. + filterSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FilterSplit' + description: Split based on the provided filters for each set. + annotationsFilter: + type: string description: >- - References to the DeployedModels that share the specified - deploymentResourcePool. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' - totalEndpointCount: + Applicable only to Datasets that have DataItems and Annotations. A + filter on Annotations of the Dataset. Only Annotations that both + match this filter and belong to DataItems not ignored by the split + method are used in respectively training, validation or test role, + depending on the role of the DataItem they are on (for the + auto-assigned that role is decided by Vertex AI). A filter with same + syntax as the one used in ListAnnotations may be used, but note here + it filters across all Annotations of the Dataset, and not just + within a single DataItem. + fractionSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FractionSplit' + description: Split based on fractions defining the size of each set. + bigqueryDestination: description: >- - The total number of Endpoints that have DeployedModels on this - DeploymentResourcePool. - format: int32 - type: integer - deployedModels: - description: DEPRECATED Use deployed_model_refs instead. - deprecated: true - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - type: array - type: object - GoogleCloudAiplatformV1ListFeatureGroupsResponse: - id: GoogleCloudAiplatformV1ListFeatureGroupsResponse - properties: - featureGroups: - description: The FeatureGroups matching the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' - nextPageToken: + Only applicable to custom training with tabular Dataset with + BigQuery source. The BigQuery project location where the training + data is to be written to. In the given project a new dataset is + created with name `dataset___` where timestamp is in + YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written + into that dataset. In the dataset three tables are created, + `training`, `validation` and `test`. * AIP_DATA_FORMAT = "bigquery". + * AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" + * AIP_VALIDATION_DATA_URI = + "bigquery_destination.dataset___.validation" * AIP_TEST_DATA_URI = + "bigquery_destination.dataset___.test" + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + savedQueryId: type: string description: >- - A token, which can be sent as ListFeatureGroupsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - description: Response message for FeatureRegistryService.ListFeatureGroups. + Only applicable to Datasets that have SavedQueries. The ID of a + SavedQuery (annotation set) under the Dataset specified by + dataset_id used for filtering Annotations for training. Only + Annotations that are associated with this SavedQuery are used in + respectively training. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both saved_query_id and annotations_filter. Only one of + saved_query_id and annotation_schema_uri should be specified as both + of them represent the same thing: problem type. + persistMlUseAssignment: + description: Whether to persist the ML use assignment to data item system labels. + type: boolean + annotationSchemaUri: + type: string + description: >- + Applicable only to custom training with Datasets that have DataItems + and Annotations. Cloud Storage URI that points to a YAML file + describing the annotation schema. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that + the chosen schema must be consistent with metadata of the Dataset + specified by dataset_id. Only Annotations that both match this + schema and belong to DataItems not ignored by the split method are + used in respectively training, validation or test role, depending on + the role of the DataItem they are on. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both annotations_filter and annotation_schema_uri. type: object - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: + description: >- + Specifies Vertex AI owned input data to be used for training, and + possibly evaluating, the Model. + id: GoogleCloudAiplatformV1InputDataConfig + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: properties: - importedEvaluatedAnnotationsCount: - description: Output only. Number of EvaluatedAnnotations imported. - type: integer - format: int32 - readOnly: true - description: Response message for ModelService.BatchImportEvaluatedAnnotations - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + maxValue: + type: number + description: The maximum permissible value for this feature. + format: float + minValue: + type: number + description: The minimum permissible value for this feature. + format: float + originalStddev: + format: float + type: number + description: >- + If this input feature has been normalized to a standard deviation of + 1.0, the original_stddev specifies the standard deviation of the + domain prior to normalization. + originalMean: + format: float + description: >- + If this input feature has been normalized to a mean value of 0, the + original_mean specifies the mean value of the domain prior to + normalization. + type: number + id: >- + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + description: >- + Domain details of the input feature value. Provides numeric information + about the feature, such as its range (min, max). If the feature has been + pre-processed, for example with z-scoring, then it provides information + about how to recover the original feature. For example, if the input + feature is an image and it has been pre-processed to obtain 0-mean and + stddev = 1 values, then original_mean, and original_stddev refer to the + mean and stddev of the original feature (e.g. image tensor) from which + input feature (with mean = 0 and stddev = 1) was obtained. type: object - GoogleCloudAiplatformV1PipelineJob: + GoogleCloudAiplatformV1ToolParameterKeyMatchSpec: + properties: {} + id: GoogleCloudAiplatformV1ToolParameterKeyMatchSpec + type: object + description: Spec for tool parameter key match metric. + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams: + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoClassificationPredictionParams + description: Prediction model parameters for Video Classification. type: object - description: An instance of a machine learning PipelineJob. - id: GoogleCloudAiplatformV1PipelineJob properties: - endTime: - format: google-datetime - readOnly: true - description: Output only. Pipeline end time. - type: string - serviceAccount: - description: >- - The service account that the pipeline workload runs as. If not - specified, the Compute Engine default service account in the project - will be used. See - https://cloud.google.com/compute/docs/access/service-accounts#default_service_account - Users starting the pipeline must have the - `iam.serviceAccounts.actAs` permission on this service account. - type: string - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key spec for a pipelineJob. If set, this - PipelineJob and all of its sub-resources will be secured by this - key. - scheduleName: - readOnly: true - type: string - description: >- - Output only. The schedule resource name. Only returned if the - Pipeline is created by Schedule API. - error: - readOnly: true - description: >- - Output only. The error that occurred during pipeline execution. Only - populated when the pipeline's state is FAILED or CANCELLED. - $ref: '#/components/schemas/GoogleRpcStatus' - updateTime: - type: string - readOnly: true + segmentClassification: + type: boolean description: >- - Output only. Timestamp when this PipelineJob was most recently - updated. - format: google-datetime - runtimeConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobRuntimeConfig' - description: Runtime config of the pipeline. - pipelineSpec: - description: The spec of the pipeline. - additionalProperties: - type: any - description: Properties of the object. - type: object - labels: - type: object - additionalProperties: - type: string + Set to true to request segment-level classification. Vertex AI + returns labels and their confidence scores for the entire time + segment of the video that user specified in the input instance. + Default value is true + maxPredictions: + type: integer description: >- - The labels with user-defined metadata to organize PipelineJob. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - Note there is some reserved label key for Vertex AI Pipelines. - - `vertex-ai-pipelines-run-billing-id`, user set value will get - overrided. - templateMetadata: + The Model only returns up to that many top, by confidence score, + predictions per instance. If this number is very high, the Model may + return fewer predictions. Default value is 10,000. + format: int32 + oneSecIntervalClassification: + type: boolean description: >- - Output only. Pipeline template metadata. Will fill up fields if - PipelineJob.template_uri is from supported template registry. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTemplateMetadata' - readOnly: true - state: - readOnly: true - type: string - description: Output only. The detailed state of the job. - enumDescriptions: - - The pipeline state is unspecified. - - >- - The pipeline has been created or resumed, and processing has not - yet begun. - - The service is preparing to run the pipeline. - - The pipeline is in progress. - - The pipeline completed successfully. - - The pipeline failed. - - >- - The pipeline is being cancelled. From this state, the pipeline may - only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED - or PIPELINE_STATE_CANCELLED. - - The pipeline has been cancelled. - - The pipeline has been stopped, and can be resumed. - enum: - - PIPELINE_STATE_UNSPECIFIED - - PIPELINE_STATE_QUEUED - - PIPELINE_STATE_PENDING - - PIPELINE_STATE_RUNNING - - PIPELINE_STATE_SUCCEEDED - - PIPELINE_STATE_FAILED - - PIPELINE_STATE_CANCELLING - - PIPELINE_STATE_CANCELLED - - PIPELINE_STATE_PAUSED - reservedIpRanges: - type: array - items: - type: string + Set to true to request classification for a video at one-second + intervals. Vertex AI returns labels and their confidence scores for + each second of the entire time segment of the video that user + specified in the input WARNING: Model evaluation is not done for + this classification type, the quality of it depends on the training + data, but there are no metrics provided to describe that quality. + Default value is false + shotClassification: description: >- - A list of names for the reserved ip ranges under the VPC network - that can be used for this Pipeline Job's workload. If set, we will - deploy the Pipeline Job's workload within the provided ip ranges. - Otherwise, the job will be deployed to any ip ranges under the - provided VPC network. Example: ['vertex-ai-ip-range']. - displayName: - type: string + Set to true to request shot-level classification. Vertex AI + determines the boundaries for each camera shot in the entire time + segment of the video that user specified in the input instance. + Vertex AI then returns labels and their confidence scores for each + detected shot, along with the start and end time of the shot. + WARNING: Model evaluation is not done for this classification type, + the quality of it depends on the training data, but there are no + metrics provided to describe that quality. Default value is false + type: boolean + confidenceThreshold: + format: float + type: number description: >- - The display name of the Pipeline. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - startTime: + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance: + properties: + reference: type: string - format: google-datetime - description: Output only. Pipeline start time. - readOnly: true - templateUri: + description: Optional. Ground truth used to compare against the prediction. + prediction: + description: Required. Output of the candidate model. type: string - description: >- - A template uri from where the PipelineJob.pipeline_spec, if empty, - will be downloaded. Currently, only uri from Vertex Template - Registry & Gallery is supported. Reference to - https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. - jobDetail: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJobDetail' - readOnly: true - description: >- - Output only. The details of pipeline run. Not available in the list - view. - name: + baselinePrediction: type: string - description: Output only. The resource name of the PipelineJob. - readOnly: true - createTime: + description: Required. Output of the baseline model. + instruction: + description: Required. Summarization prompt for LLM. type: string - readOnly: true - format: google-datetime - description: Output only. Pipeline creation time. - network: + context: type: string - description: >- - The full name of the Compute Engine - [network](/compute/docs/networks-and-firewalls#networks) to which - the Pipeline Job's workload should be peered. For example, - `projects/12345/global/networks/myVPC`. - [Format](/compute/docs/reference/rest/v1/networks/insert) is of the - form `projects/{project}/global/networks/{network}`. Where {project} - is a project number, as in `12345`, and {network} is a network name. - Private services access must already be configured for the network. - Pipeline job will apply the network configuration to the Google - Cloud resources being launched, if applied, such as Vertex AI - Training or Dataflow job. If left unspecified, the workload is not - peered with any network. - GoogleCloudAiplatformV1AddExecutionEventsRequest: + description: Required. Text to be summarized. + id: GoogleCloudAiplatformV1PairwiseSummarizationQualityInstance type: object - properties: - events: - description: The Events to create and add. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' - id: GoogleCloudAiplatformV1AddExecutionEventsRequest - description: Request message for MetadataService.AddExecutionEvents. - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance: - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageClassificationPredictionInstance - type: object - properties: - mimeType: - description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/gif - - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon - type: string - content: - type: string - description: The image bytes or Cloud Storage URI to make the prediction on. - description: Prediction input format for Image Classification. - GoogleCloudAiplatformV1EntityType: - description: >- - An entity type is a type of object in a system that needs to be modeled - and have stored information about. For example, driver is an entity - type, and driver0 is an instance of an entity type driver. + description: Spec for pairwise summarization quality instance. + GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec: type: object - id: GoogleCloudAiplatformV1EntityType properties: - createTime: + explanationSpec: + description: Explanation spec details. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + explanationType: type: string - description: Output only. Timestamp when this EntityType was created. - readOnly: true - format: google-datetime - labels: - description: >- - Optional. The labels with user-defined metadata to organize your - EntityTypes. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one EntityType (System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - additionalProperties: - type: string - type: object - name: description: >- - Immutable. Name of the EntityType. Format: - `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` - The last part entity_type is assigned by the client. The entity_type - can be up to 64 characters long and can consist only of ASCII Latin - letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting - with a letter. The value will be unique given a featurestore. - type: string - description: - type: string - description: Optional. Description of the EntityType. - offlineStorageTtlDays: + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + id: GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: + properties: + stalenessDays: type: integer description: >- - Optional. Config for data retention policy in offline storage. TTL - in days for feature values that will be stored in offline storage. - The Feature Store offline storage periodically removes obsolete - feature values older than `offline_storage_ttl_days` since the - feature generation time. If unset (or explicitly set to 0), default - to 4000 days TTL. + Customized export features time window for snapshot analysis. Unit + is one day. Default value is 3 weeks. Minimum value is 1 day. + Maximum value is 4000 days. format: int32 - monitoringConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreMonitoringConfig - description: >- - Optional. The default monitoring configuration for all Features with - value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under - this EntityType. If this is populated with - [FeaturestoreMonitoringConfig.monitoring_interval] specified, - snapshot analysis monitoring is enabled. Otherwise, snapshot - analysis monitoring is disabled. - updateTime: - type: string - format: google-datetime + disabled: description: >- - Output only. Timestamp when this EntityType was most recently - updated. - readOnly: true - etag: - type: string + The monitoring schedule for snapshot analysis. For EntityType-level + config: unset / disabled = true indicates disabled by default for + Features under it; otherwise by default enable snapshot analysis + monitoring with monitoring_interval for Features under it. + Feature-level config: disabled = true indicates disabled regardless + of the EntityType-level config; unset monitoring_interval indicates + going with EntityType-level config; otherwise run snapshot analysis + monitoring with monitoring_interval regardless of the + EntityType-level config. Explicitly Disable the snapshot analysis + based monitoring. + type: boolean + monitoringIntervalDays: + type: integer description: >- - Optional. Used to perform a consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: - description: Requests are randomly selected. - type: object - id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig - properties: - sampleRate: - format: double - type: number - description: Sample rate (0, 1] - GoogleCloudAiplatformV1NetworkSpec: + Configuration of the snapshot analysis based monitoring pipeline + running interval. The value indicates number of days. + format: int32 type: object + id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis + description: >- + Configuration of the Featurestore's Snapshot Analysis Based Monitoring. + This type of analysis generates statistics for each Feature based on a + snapshot of the latest feature value of each entities every + monitoring_interval. + GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: properties: - subnetwork: - type: string + startTime: description: >- - The name of the subnet that this instance is in. Format: - `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` - enableInternetAccess: - type: boolean - description: Whether to enable public internet access. Default false. - network: + Optional. Excludes Feature values with feature generation timestamp + before this timestamp. If not set, retrieve oldest values kept in + Feature Store. Timestamp, if present, must not have higher than + millisecond precision. type: string - description: >- - The full name of the Google Compute Engine - [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) - description: Network spec. - id: GoogleCloudAiplatformV1NetworkSpec - GoogleCloudAiplatformV1ListModelVersionsResponse: - properties: - models: + format: google-datetime + bigqueryReadInstances: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + description: Similar to csv_read_instances, but from BigQuery source. + entityTypeSpecs: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec type: array description: >- - List of Model versions in the requested page. In the returned Model - name field, version ID instead of regvision tag will be included. - nextPageToken: + Required. Specifies EntityType grouping Features to read values of + and settings. + csvReadInstances: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' description: >- - A token to retrieve the next page of results. Pass to - ListModelVersionsRequest.page_token to obtain that page. - type: string - id: GoogleCloudAiplatformV1ListModelVersionsResponse - type: object - description: Response message for ModelService.ListModelVersions - GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec: + Each read instance consists of exactly one read timestamp and one or + more entity IDs identifying entities of the corresponding + EntityTypes whose Features are requested. Each output instance + contains Feature values of requested entities concatenated together + as of the read time. An example read instance may be `foo_entity_id, + bar_entity_id, 2020-01-01T10:00:00.123Z`. An example output instance + may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, + foo_entity_feature1_value, bar_entity_feature2_value`. Timestamp in + each read instance must be millisecond-aligned. `csv_read_instances` + are read instances stored in a plain-text CSV file. The header + should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The + columns can be in any order. Values in the timestamp column must use + the RFC 3339 format, e.g. `2012-07-30T10:43:17.123Z`. + destination: + description: Required. Specifies output location and format. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' + passThroughFields: + description: >- + When not empty, the specified fields in the *_read_instances source + will be joined as-is in the output, in addition to those fields from + the Featurestore Entity. For BigQuery source, the type of the + pass-through values will be automatically inferred. For CSV source, + the pass-through values will be passed as opaque bytes. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + type: array + id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + type: object + description: Request message for FeaturestoreService.BatchReadFeatureValues. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation: properties: - searchTrialSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec - description: Required. Spec for search trials. - multiTrialAlgorithm: - enumDescriptions: - - Defaults to `REINFORCEMENT_LEARNING`. - - >- - The Reinforcement Learning Algorithm for Multi-trial Neural - Architecture Search (NAS). - - >- - The Grid Search Algorithm for Multi-trial Neural Architecture - Search (NAS). + columnName: type: string - enum: - - MULTI_TRIAL_ALGORITHM_UNSPECIFIED - - REINFORCEMENT_LEARNING - - GRID_SEARCH - description: >- - The multi-trial Neural Architecture Search (NAS) algorithm type. - Defaults to `REINFORCEMENT_LEARNING`. - metric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec - description: >- - Metric specs for the NAS job. Validation for this field is done at - `multi_trial_algorithm_spec` field. - trainTrialSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec - description: >- - Spec for train trials. Top N - [TrainTrialSpec.max_parallel_trial_count] search trials will be - trained for every M [TrainTrialSpec.frequency] trials searched. - description: The spec of multi-trial Neural Architecture Search (NAS). + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. * A boolean value that indicates whether the + value is valid. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation type: object - id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpec - GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance: + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: properties: - content: + partialErrors: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. + The detail information of the partial failures encountered for those + invalid records that couldn't be parsed. Up to 50 partial errors + will be reported. + type: array + validSparseRecordCount: + format: int64 type: string - timeSegmentEnd: description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. + Number of sparse records in this file that were successfully + processed. + validRecordCount: type: string - mimeType: - description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime + description: Number of records in this file that were successfully processed. + format: int64 + invalidRecordCount: + description: Number of records in this file we skipped due to validate errors. type: string - timeSegmentStart: + format: int64 + invalidSparseRecordCount: type: string description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. + Number of sparse records in this file we skipped due to validate + errors. + format: int64 + sourceGcsUri: + type: string + description: Cloud Storage URI pointing to the original file in user's bucket. + type: object id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoObjectTrackingPredictionInstance - description: Prediction input format for Video Object Tracking. + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange: + description: A range of values for slice(s). `low` is inclusive, `high` is exclusive. + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecRange + properties: + high: + type: number + format: float + description: Exclusive high value for the range. + low: + type: number + description: Inclusive low value for the range. + format: float type: object - GoogleCloudAiplatformV1PurgeArtifactsRequest: - description: Request message for MetadataService.PurgeArtifacts. - id: GoogleCloudAiplatformV1PurgeArtifactsRequest + GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: + id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation type: object + description: Explanation result of the prediction produced by the Model. properties: - filter: + explanationType: type: string description: >- - Required. A required filter matching the Artifacts to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. - force: - description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Artifact names - that would be deleted. - type: boolean - CloudAiLargeModelsVisionSemanticFilterResponse: - type: object + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + explanation: + description: Explanation attribution response details. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' + GoogleCloudAiplatformV1ListStudiesResponse: + id: GoogleCloudAiplatformV1ListStudiesResponse + description: Response message for VizierService.ListStudies. properties: - passedSemanticFilter: + nextPageToken: description: >- - This response is added when semantic filter config is turned on in - EditConfig. It reports if this image is passed semantic filter - response. If passed_semantic_filter is false, the bounding box - information will be populated for user to check what caused the - semantic filter to fail. - type: boolean - namedBoundingBoxes: + Passes this token as the `page_token` field of the request for a + subsequent call. If this field is omitted, there are no subsequent + pages. + type: string + studies: items: - $ref: '#/components/schemas/CloudAiLargeModelsVisionNamedBoundingBox' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + description: The studies associated with the project. type: array - description: >- - Class labels of the bounding boxes that failed the semantic - filtering. Bounding box coordinates. - id: CloudAiLargeModelsVisionSemanticFilterResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs: + type: object + GoogleCloudAiplatformV1FindNeighborsRequestQuery: properties: - budgetMilliNodeHours: - type: string - description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. For modelType - `cloud`(default), the budget must be between 8,000 and 800,000 milli - node hours, inclusive. The default value is 192,000 which represents - one day in wall time, considering 8 nodes are used. For model types - `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, - `mobile-tf-high-accuracy-1`, the training budget must be between - 1,000 and 100,000 milli node hours, inclusive. The default value is - 24,000 which represents one day in wall time on a single node that - is used. - format: int64 - multiLabel: - type: boolean + neighborCount: + format: int32 + type: integer description: >- - If false, a single-label (multi-class) Model will be trained (i.e. - assuming that for each image just up to one annotation may be - applicable). If true, a multi-label Model will be trained (i.e. - assuming that for each image multiple annotations may be - applicable). - uptrainBaseModelId: - type: string + The number of nearest neighbors to be retrieved from database for + each query. If not set, will use the default from the service + configuration + (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config). + datapoint: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' description: >- - The ID of `base` model for upTraining. If it is specified, the new - model will be upTrained based on the `base` model for upTraining. - Otherwise, the new model will be trained from scratch. The `base` - model for upTraining must be in the same Project and Location as the - new Model to train, and have the same modelType. - baseModelId: + Required. The datapoint/vector whose nearest neighbors should be + searched for. + approximateNeighborCount: description: >- - The ID of the `base` model. If it is specified, the new model will - be trained based on the `base` model. Otherwise, the new model will - be trained from scratch. The `base` model must be in the same - Project and Location as the new Model to train, and have the same - modelType. - type: string - disableEarlyStopping: - type: boolean + The number of neighbors to find via approximate search before exact + reordering is performed. If not set, the default value from scam + config is used; if set, this value must be > 0. + type: integer + format: int32 + fractionLeafNodesToSearchOverride: + format: double + type: number description: >- - Use the entire training budget. This disables the early stopping - feature. When false the early stopping feature is enabled, which - means that AutoML Image Classification might stop training before - the entire training budget has been used. - modelType: - enumDescriptions: - - Should not be set. - - >- - A Model best tailored to be used within Google Cloud, and which - cannot be exported. Default. - - >- - A model type best tailored to be used within Google Cloud, which - cannot be exported externally. Compared to the CLOUD model above, - it is expected to have higher prediction accuracy. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device afterwards. - Expected to have low latency, but may have lower prediction - quality than other mobile models. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device with - afterwards. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - or Core ML model and used on a mobile or edge device afterwards. - Expected to have a higher latency, but should also have a higher - prediction quality than other mobile models. - - >- - EfficientNet model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - MaxViT model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - ViT model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - - >- - CoCa model for Model Garden training with customizable - hyperparameters. Best tailored to be used within Google Cloud, and - cannot be exported externally. - type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD - - CLOUD_1 - - MOBILE_TF_LOW_LATENCY_1 - - MOBILE_TF_VERSATILE_1 - - MOBILE_TF_HIGH_ACCURACY_1 - - EFFICIENTNET - - MAXVIT - - VIT - - COCA - tunableParameter: - description: Trainer type for Vision TrainRequest. + The fraction of the number of leaves to search, set at query time + allows user to tune search performance. This value increase result + in both search accuracy and latency increase. The value should be + between 0.0 and 1.0. If not set or set to 0.0, query uses the + default value specified in + NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search. + rrf: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs - type: object - GoogleCloudAiplatformV1GenericOperationMetadata: + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + description: Optional. Represents RRF algorithm that combines search results. + perCrowdingAttributeNeighborCount: + description: >- + Crowding is a constraint on a neighbor list produced by nearest + neighbor search requiring that no more than some value k' of the k + neighbors returned have the same value of crowding_attribute. It's + used for improving result diversity. This field is the maximum + number of matches with the same crowding tag. + format: int32 + type: integer + description: >- + A query to find a number of the nearest neighbors (most similar vectors) + of a vector. + id: GoogleCloudAiplatformV1FindNeighborsRequestQuery type: object - id: GoogleCloudAiplatformV1GenericOperationMetadata - description: Generic Metadata shared by all operations. + GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: properties: - createTime: - format: google-datetime - readOnly: true - description: Output only. Time when the operation was created. + nextPageToken: type: string - partialFailures: - readOnly: true - items: - $ref: '#/components/schemas/GoogleRpcStatus' + description: The standard List next-page token. + modelDeploymentMonitoringJobs: description: >- - Output only. Partial failures encountered. E.g. single files that - couldn't be read. This field should never exceed 20 entries. Status - details field will contain standard Google Cloud error details. + A list of ModelDeploymentMonitoringJobs that matches the specified + filter in the request. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob type: array - updateTime: - readOnly: true - type: string - description: >- - Output only. Time when the operation was updated for the last time. - If the operation has finished (successfully or not), this is the - finish time. - format: google-datetime - GoogleCloudAiplatformV1PredefinedSplit: - properties: - key: - description: >- - Required. The key is a name of one of the Dataset's data columns. - The value of the key (either the label's value or value in the - column) must be one of {`training`, `validation`, `test`}, and it - defines to which set the given piece of data is assigned. If for a - piece of data the key is not present or has an invalid value, that - piece is ignored by the pipeline. - type: string - description: >- - Assigns input data to training, validation, and test sets based on the - value of a provided key. Supported only for tabular Datasets. type: object - id: GoogleCloudAiplatformV1PredefinedSplit - GoogleCloudAiplatformV1StudySpecMetricSpec: - id: GoogleCloudAiplatformV1StudySpecMetricSpec + description: Response message for JobService.ListModelDeploymentMonitoringJobs. + id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + GoogleCloudAiplatformV1SearchFeaturesResponse: + type: object + description: Response message for FeaturestoreService.SearchFeatures. + id: GoogleCloudAiplatformV1SearchFeaturesResponse properties: - safetyConfig: + features: description: >- - Used for safe search. In the case, the metric will be a safety - metric. You must provide a separate metric for objective metric. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig - metricId: + The Features matching the request. Fields returned: * `name` * + `description` * `labels` * `create_time` * `update_time` + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + type: array + nextPageToken: description: >- - Required. The ID of the metric. Must not contain whitespaces and - must be unique amongst all MetricSpecs. - type: string - goal: - description: Required. The optimization goal of the metric. - enumDescriptions: - - Goal Type will default to maximize. - - Maximize the goal metric. - - Minimize the goal metric. + A token, which can be sent as SearchFeaturesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. type: string - enum: - - GOAL_TYPE_UNSPECIFIED - - MAXIMIZE - - MINIMIZE - description: Represents a metric to optimize. - type: object - GoogleCloudAiplatformV1TensorboardTensor: + GoogleCloudAiplatformV1CreateDatasetOperationMetadata: + id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata type: object - description: One point viewable on a tensor metric plot. + description: Runtime operation information for DatasetService.CreateDataset. properties: - value: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig: + properties: + scaling: description: >- - Required. Serialized form of - https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto - format: byte - type: string - versionNumber: - description: Optional. Version number of TensorProto used to serialize value. - type: integer + Online serving scaling configuration. Only one of `fixed_node_count` + and `scaling` can be set. Setting one will reset the other. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling + fixedNodeCount: + description: >- + The number of nodes for the online store. The number of nodes + doesn't scale automatically, but you can manually update the number + of nodes. If set to 0, the featurestore will not have an online + store and cannot be used for online serving. format: int32 - id: GoogleCloudAiplatformV1TensorboardTensor - GoogleCloudAiplatformV1PythonPackageSpec: - description: The spec of a Python packaged code. - id: GoogleCloudAiplatformV1PythonPackageSpec + type: integer + description: >- + OnlineServingConfig specifies the details for provisioning online + serving resources. + id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig type: object + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse: properties: - args: - type: array - items: - type: string - description: Command line arguments to be passed to the Python task. - pythonModule: - type: string - description: >- - Required. The Python module name to run after installing the - packages. - executorImageUri: - description: >- - Required. The URI of a container image in Artifact Registry that - will run the provided Python package. Vertex AI provides a wide - range of executor images with pre-installed packages to meet users' - various use cases. See the list of [pre-built containers for - training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). - You must use an image from this list. + nextPageToken: type: string - env: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' description: >- - Environment variables to be passed to the python module. Maximum - limit is 100. - type: array - packageUris: + The page token that can be used by the next + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + monitoringStats: description: >- - Required. The Google Cloud Storage location of the Python package - files which are the training program and its dependent packages. The - maximum number of package URIs is 100. + Stats retrieved for requested objectives. There are at most 1000 + ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats + in the response. items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringStatsAnomalies type: array - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics: + description: >- + Response message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. + type: object + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse + GoogleCloudAiplatformV1RaySpec: properties: - rootMeanSquaredError: - type: number - format: float - description: Root Mean Squared Error (RMSE). - weightedAbsolutePercentageError: - type: number - description: >- - Weighted Absolute Percentage Error. Does not use weights, this is - just what the metric is called. Undefined if actual values sum to - zero. Will be very large if actual values sum to a very small - number. - format: float - rootMeanSquaredPercentageError: - format: float - description: >- - Root Mean Square Percentage Error. Square root of MSPE. - Undefined/imaginary when MSPE is negative. - type: number - rSquared: - description: >- - Coefficient of determination as Pearson correlation coefficient. - Undefined when ground truth or predictions are constant or near - constant. - type: number - format: float - meanAbsolutePercentageError: + resourcePoolImages: + additionalProperties: + type: string description: >- - Mean absolute percentage error. Infinity when there are zeros in the - ground truth. - format: float - type: number - meanAbsoluteError: - type: number - description: Mean Absolute Error (MAE). - format: float - quantileMetrics: - description: The quantile metrics entries for each quantile. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry - rootMeanSquaredLogError: - format: float + Optional. Required if image_uri isn't set. A map of resource_pool_id + to prebuild Ray image if user need to use different images for + different head/worker pools. This map needs to cover all the + resource pool ids. Example: { "ray_head_node_pool": "head image" + "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": + "another worker image" } + type: object + rayMetricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' + description: Optional. Ray metrics configurations. + imageUri: + type: string description: >- - Root mean squared log error. Undefined when there are negative - ground truth values or predictions. - type: number - type: object - description: Metrics for forecasting evaluation results. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetrics - GoogleCloudAiplatformV1ActiveLearningConfig: - properties: - trainingConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' + Optional. Default image for user to choose a preferred ML framework + (for example, TensorFlow or Pytorch) by choosing from [Vertex + prebuilt + images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + Either this or the resource_pool_images is required. Use this field + if you need all the resource pools to have the same Ray image. + Otherwise, use the {@code resource_pool_images} field. + rayLogsSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RayLogsSpec' + description: Optional. OSS Ray logging configurations. + headNodeResourcePoolId: description: >- - CMLE training config. For every active learning labeling iteration, - system will train a machine learning model on CMLE. The trained - model will be used by data sampling algorithm to select DataItems. - maxDataItemPercentage: - format: int32 - type: integer - description: Max percent of total DataItems for human labeling. - maxDataItemCount: + Optional. This will be used to indicate which resource pool will + serve as the Ray head node(the first node within that pool). Will + use the machine from the first workerpool as the head node by + default if this field isn't set. type: string - description: Max number of human labeled DataItems. - format: int64 - sampleConfig: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' - description: >- - Active learning data sampling config. For every active learning - labeling iteration, it will select a batch of data based on the - sampling strategy. type: object description: >- - Parameters that configure the active learning pipeline. Active learning - will label the data incrementally by several iterations. For every - iteration, it will select a batch of data based on the sampling - strategy. - id: GoogleCloudAiplatformV1ActiveLearningConfig - GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata: - type: object - description: Details of operations that perform update Featurestore. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. - id: GoogleCloudAiplatformV1UpdateFeaturestoreOperationMetadata - GoogleRpcStatus: - id: GoogleRpcStatus + Configuration information for the Ray cluster. For experimental launch, + Ray cluster creation and Persistent cluster creation are 1:1 mapping: We + will provision all the nodes within the Persistent cluster as Ray nodes. + id: GoogleCloudAiplatformV1RaySpec + GoogleCloudAiplatformV1MigrateResourceRequest: properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: - type: array + migrateAutomlDatasetConfig: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - GoogleCloudAiplatformV1ExportModelRequest: - properties: - outputConfig: + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportModelRequestOutputConfig - description: Required. The desired output location and configuration. - id: GoogleCloudAiplatformV1ExportModelRequest - description: Request message for ModelService.ExportModel. - type: object - GoogleCloudAiplatformV1ListExecutionsResponse: - id: GoogleCloudAiplatformV1ListExecutionsResponse - description: Response message for MetadataService.ListExecutions. - type: object - properties: - nextPageToken: - type: string - description: >- - A token, which can be sent as ListExecutionsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. - executions: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - description: The Executions retrieved from the MetadataStore. - type: array - GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: - id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest - properties: {} - type: object - description: Request message for JobService.CancelBatchPredictionJob. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: - type: object - properties: - maxTrialCount: - description: The desired total number of Trials. - format: int32 - type: integer - maxFailedTrialCount: - description: >- - The number of failed Trials that need to be seen before failing the - HyperparameterTuningJob. If set to 0, Vertex AI decides how many - Trials must fail before the whole job fails. - format: int32 - type: integer - parallelTrialCount: - format: int32 - description: The desired number of Trials to run in parallel. - type: integer - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - description: Study configuration of the HyperparameterTuningJob. - trialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: >- - The spec of a trial job. The same spec applies to the CustomJobs - created in all the trials. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec - GoogleCloudAiplatformV1BatchReadFeatureValuesRequest: - description: Request message for FeaturestoreService.BatchReadFeatureValues. - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequest - properties: - startTime: - type: string - format: google-datetime - description: >- - Optional. Excludes Feature values with feature generation timestamp - before this timestamp. If not set, retrieve oldest values kept in - Feature Store. Timestamp, if present, must not have higher than - millisecond precision. - destination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueDestination' - description: Required. Specifies output location and format. - passThroughFields: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestPassThroughField + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig + migrateDataLabelingDatasetConfig: description: >- - When not empty, the specified fields in the *_read_instances source - will be joined as-is in the output, in addition to those fields from - the Featurestore Entity. For BigQuery source, the type of the - pass-through values will be automatically inferred. For CSV source, - the pass-through values will be passed as opaque bytes. - bigqueryReadInstances: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: Similar to csv_read_instances, but from BigQuery source. - entityTypeSpecs: + Config for migrating Dataset in datalabeling.googleapis.com to + Vertex AI's Dataset. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig + migrateMlEngineModelVersionConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig description: >- - Required. Specifies EntityType grouping Features to read values of - and settings. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec - type: array - csvReadInstances: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + Config for migrating Version in ml.googleapis.com to Vertex AI's + Model. + migrateAutomlModelConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlModelConfig description: >- - Each read instance consists of exactly one read timestamp and one or - more entity IDs identifying entities of the corresponding - EntityTypes whose Features are requested. Each output instance - contains Feature values of requested entities concatenated together - as of the read time. An example read instance may be `foo_entity_id, - bar_entity_id, 2020-01-01T10:00:00.123Z`. An example output instance - may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, - foo_entity_feature1_value, bar_entity_feature2_value`. Timestamp in - each read instance must be millisecond-aligned. `csv_read_instances` - are read instances stored in a plain-text CSV file. The header - should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The - columns can be in any order. Values in the timestamp column must use - the RFC 3339 format, e.g. `2012-07-30T10:43:17.123Z`. + Config for migrating Model in automl.googleapis.com to Vertex AI's + Model. + description: >- + Config of migrating one resource from automl.googleapis.com, + datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. + id: GoogleCloudAiplatformV1MigrateResourceRequest type: object - GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines: - description: Open fine tuning pipelines. - id: GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines - properties: - fineTuningPipelines: - description: Required. Regional resource references to fine tuning pipelines. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + GoogleCloudAiplatformV1ListDatasetsResponse: + description: Response message for DatasetService.ListDatasets. + id: GoogleCloudAiplatformV1ListDatasetsResponse type: object - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: - description: >- - Response structure in the format of key (feature name) and (feature) - value pair. - id: >- - GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList properties: - features: - description: List of feature names and values. + datasets: + description: A list of Datasets that matches the specified filter in the request. type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + nextPageToken: + description: The standard List next-page token. + type: string + GoogleCloudAiplatformV1FeatureValueDestination: type: object - GoogleCloudAiplatformV1Content: - description: >- - The base structured datatype containing multi-part content of a message. - A `Content` includes a `role` field designating the producer of the - `Content` and a `parts` field containing multi-part data that contains - the content of the message turn. + id: GoogleCloudAiplatformV1FeatureValueDestination + description: A destination location for Feature values and format. properties: - parts: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' + tfrecordDestination: description: >- - Required. Ordered `Parts` that constitute a single message. Parts - may have different IANA MIME types. - role: + Output in TFRecord format. Below are the mapping from Feature value + type in Featurestore to Feature value type in TFRecord: Value type + in Featurestore | Value type in TFRecord DOUBLE, DOUBLE_ARRAY | + FLOAT_LIST INT64, INT64_ARRAY | INT64_LIST STRING, STRING_ARRAY, + BYTES | BYTES_LIST true -> byte_string("true"), false -> + byte_string("false") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST + $ref: '#/components/schemas/GoogleCloudAiplatformV1TFRecordDestination' + bigqueryDestination: description: >- - Optional. The producer of the content. Must be either 'user' or - 'model'. Useful to set for multi-turn conversations, otherwise can - be left blank or unset. - type: string - id: GoogleCloudAiplatformV1Content - type: object - GoogleCloudAiplatformV1ListContextsResponse: - properties: - nextPageToken: - type: string + Output in BigQuery format. BigQueryDestination.output_uri in + FeatureValueDestination.bigquery_destination must refer to a table. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + csvDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvDestination' description: >- - A token, which can be sent as ListContextsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. - contexts: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - description: The Contexts retrieved from the MetadataStore. - type: array - id: GoogleCloudAiplatformV1ListContextsResponse - description: Response message for MetadataService.ListContexts. - type: object - GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: + Output in CSV format. Array Feature value types are not allowed in + CSV format. + GoogleCloudAiplatformV1FeatureValueList: + description: Container for list of values. type: object - description: The input metadata entries to be overridden. + id: GoogleCloudAiplatformV1FeatureValueList properties: - inputBaselines: - description: >- - Baseline inputs for this feature. This overrides the - `input_baseline` field of the ExplanationMetadata.InputMetadata - object of the corresponding feature's input metadata. If it's not - specified, the original baselines are not overridden. - type: array + values: items: - type: any - id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride - GoogleIamV1SetIamPolicyRequest: - type: object - id: GoogleIamV1SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - GoogleCloudAiplatformV1ListArtifactsResponse: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: A list of feature values. All of them should be the same data type. + type: array + GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult: type: object - description: Response message for MetadataService.ListArtifacts. + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceResult properties: - nextPageToken: - description: >- - A token, which can be sent as ListArtifactsRequest.page_token to - retrieve the next page. If this field is not populated, there are no - subsequent pages. + score: + description: Output only. Question Answering Relevance score. + format: float + type: number + readOnly: true + confidence: + type: number + format: float + readOnly: true + description: Output only. Confidence for question answering relevance score. + explanation: type: string - artifacts: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - description: The Artifacts retrieved from the MetadataStore. - id: GoogleCloudAiplatformV1ListArtifactsResponse + description: Output only. Explanation for question answering relevance score. + readOnly: true + description: Spec for question answering relevance result. GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation: type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation description: >- Training pipeline will perform following transformation functions. * The text as is--no change to case, punctuation, spelling, tense, and so on. @@ -14667,109 +14737,106 @@ components: based on unicode script boundaries. * Missing values get their own lookup index and resulting embedding. * Stop-words receive no special treatment and are not removed. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation properties: columnName: type: string - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: + GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata: type: object - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata - description: The metadata of Datasets that contain time series data. + description: Details of operations that perform update Tensorboard. + id: GoogleCloudAiplatformV1UpdateTensorboardOperationMetadata properties: - timeColumn: - type: string - description: >- - The column name of the time column that identifies time order in the - time series. - timeSeriesIdentifierColumn: - type: string - description: >- - The column name of the time series identifier column that identifies - the time series. - inputConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig - GoogleCloudAiplatformV1PurgeExecutionsRequest: - id: GoogleCloudAiplatformV1PurgeExecutionsRequest - description: Request message for MetadataService.PurgeExecutions. + genericMetadata: + description: Operation metadata for Tensorboard. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec: properties: - filter: + sourceField: description: >- - Required. A required filter matching the Executions to be purged. - E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + Source column to get the Feature values from. If not set, uses the + column with the same name as the Feature ID. type: string - force: - type: boolean + id: description: >- - Optional. Flag to indicate to actually perform the purge. If `force` - is set to false, the method will return a sample of Execution names - that would be deleted. + Required. ID of the Feature to import values of. This Feature must + exist in the target EntityType, or the request will fail. + type: string + id: GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + type: object + description: Defines the Feature value(s) to import. + GoogleCloudAiplatformV1ImportDataResponse: + id: GoogleCloudAiplatformV1ImportDataResponse type: object - GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: - id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse properties: {} - description: Response message for MetadataService.AddContextArtifactsAndExecutions. + description: Response message for DatasetService.ImportData. + GoogleCloudAiplatformV1MetadataStoreDataplexConfig: + id: GoogleCloudAiplatformV1MetadataStoreDataplexConfig type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. + description: Represents Dataplex integration settings. properties: - columnName: - type: string - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionCustomJobMetadata + enabledPipelinesLineage: + description: >- + Optional. Whether or not Data Lineage synchronization is enabled for + Vertex Pipelines. + type: boolean + GoogleCloudAiplatformV1UpdateIndexOperationMetadata: type: object + id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata + description: Runtime operation information for IndexService.UpdateIndex. properties: - backingCustomJob: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + nearestNeighborSearchOperationMetadata: description: >- - The resource name of the CustomJob that has been created to carry - out this custom task. - type: string - GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling: + The operation metadata with regard to Matching Engine Index + operation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata + GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig: + type: object properties: - maxNodeCount: + datasetDisplayName: description: >- - The maximum number of nodes to scale up to. Must be greater than - min_node_count, and less than or equal to 10 times of - 'min_node_count'. - type: integer - format: int32 - minNodeCount: - type: integer - format: int32 + Required. Display name of the Dataset in Vertex AI. System will pick + a display name if unspecified. + type: string + dataset: + type: string description: >- - Required. The minimum number of nodes to scale down to. Must be - greater than or equal to 1. - cpuUtilizationTarget: - type: integer - description: >- - Optional. The cpu utilization that the Autoscaler should be trying - to achieve. This number is on a scale from 0 (no utilization) to 100 - (total utilization), and is limited between 10 and 80. When a - cluster's CPU utilization exceeds the target that you have set, - Bigtable immediately adds nodes to the cluster. When CPU utilization - is substantially lower than the target, Bigtable removes nodes. If - not set or set to 0, default to 50. - format: int32 + Required. Full resource name of automl Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}`. + id: GoogleCloudAiplatformV1MigrateResourceRequestMigrateAutomlDatasetConfig description: >- - Online serving scaling configuration. If min_node_count and - max_node_count are set to the same value, the cluster will be configured - with the fixed number of node (no auto-scaling). + Config for migrating Dataset in automl.googleapis.com to Vertex AI's + Dataset. + GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata: type: object - id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfigScaling + id: GoogleCloudAiplatformV1DeleteMetadataStoreOperationMetadata + description: Details of operations that perform MetadataService.DeleteMetadataStore. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for deleting a MetadataStore. + GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput: + type: object + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInput + properties: + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance + description: Required. Question answering relevance instance. + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringRelevanceSpec + description: Required. Spec for question answering relevance score metric. + description: Input for question answering relevance metric. CloudAiPlatformCommonCreatePipelineJobApiErrorDetail: + type: object properties: publicMessage: type: string description: Public messages contains actionable items for the error cause. errorCause: - description: The error root cause returned by CreatePipelineJob API. - type: string enum: - ERROR_CAUSE_UNSPECIFIED - INVALID_PIPELINE_SPEC_FORMAT @@ -14796,6 +14863,7 @@ components: - INVALID_DAG_SPEC - INSUFFICIENT_QUOTA - INTERNAL + type: string enumDescriptions: - Should never be used. - IR Pipeline Spec can not been parsed to yaml or json format. @@ -14822,5449 +14890,5051 @@ components: - DagSpec is invalid. - Project does not have enough quota. - An internal error with unknown cause. - type: object + description: The error root cause returned by CreatePipelineJob API. description: 'Create API error message for Vertex Pipeline. Next Id: 3.' id: CloudAiPlatformCommonCreatePipelineJobApiErrorDetail - GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation: - id: GoogleCloudAiplatformV1SchemaImageSegmentationAnnotation - description: Annotation details specific to image segmentation. + GoogleCloudAiplatformV1BigQuerySource: properties: - maskAnnotation: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationMaskAnnotation + inputUri: description: >- - Mask based segmentation annotation. Only one mask annotation can - exist for one image. - polygonAnnotation: - description: Polygon annotation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolygonAnnotation - polylineAnnotation: - description: Polyline annotation. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + Required. BigQuery URI to a table, up to 2000 characters long. + Accepted forms: * BigQuery path. For example: + `bq://projectId.bqDatasetId.bqTableId`. + type: string + type: object + description: The BigQuery location for the input content. + id: GoogleCloudAiplatformV1BigQuerySource + GoogleCloudAiplatformV1DeployedModelRef: + id: GoogleCloudAiplatformV1DeployedModelRef + description: Points to a DeployedModel. type: object - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig: properties: - migrateDataLabelingAnnotatedDatasetConfigs: - description: >- - Optional. Configs for migrating AnnotatedDataset in - datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified - AnnotatedDatasets have to belong to the datalabeling Dataset. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig - type: array - dataset: + deployedModelId: type: string - description: >- - Required. Full resource name of data labeling Dataset. Format: - `projects/{project}/datasets/{dataset}`. - datasetDisplayName: + description: Immutable. An ID of a DeployedModel in the above Endpoint. + endpoint: type: string - description: >- - Optional. Display name of the Dataset in Vertex AI. System will pick - a display name if unspecified. - description: >- - Config for migrating Dataset in datalabeling.googleapis.com to Vertex - AI's Dataset. - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateDataLabelingDatasetConfig - type: object - GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity: - description: Response message if the request uses the SelectEntity option. - id: GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectEntity + description: Immutable. A resource name of an Endpoint. + GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest: type: object + properties: {} + description: Request message for JobService.PauseModelDeploymentMonitoringJob. + id: GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + GoogleCloudAiplatformV1UploadModelRequest: properties: - offlineStorageDeletedEntityRowCount: - description: >- - The count of deleted entity rows in the offline storage. Each row - corresponds to the combination of an entity ID and a timestamp. One - entity ID can have multiple rows in the offline storage. + parentModel: type: string - format: int64 - onlineStorageDeletedEntityCount: + description: >- + Optional. The resource name of the model into which to upload the + version. Only specify this field when uploading a new version. + serviceAccount: + description: >- + Optional. The user-provided custom service account to use to do the + model upload. If empty, [Vertex AI Service + Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + will be used to access resources needed to upload the model. This + account must belong to the target project where the model is + uploaded to, i.e., the project specified in the `parent` field of + this request and have necessary read permissions (to Google Cloud + Storage, Artifact Registry, etc.). type: string - format: int64 + modelId: description: >- - The count of deleted entities in the online storage. Each entity ID - corresponds to one entity. - GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest: - properties: {} + Optional. The ID to use for the uploaded Model, which will become + the final component of the model resource name. This value may be up + to 63 characters, and valid characters are `[a-z0-9_-]`. The first + character cannot be a number or hyphen. + type: string + model: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + description: Required. The Model to create. + id: GoogleCloudAiplatformV1UploadModelRequest + description: Request message for ModelService.UploadModel. type: object - id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest - description: Request message for NotebookService.UpgradeNotebookRuntime. - GoogleCloudAiplatformV1FetchFeatureValuesRequest: - description: >- - Request message for FeatureOnlineStoreService.FetchFeatureValues. All - the features under the requested feature view will be returned. - id: GoogleCloudAiplatformV1FetchFeatureValuesRequest + GoogleCloudAiplatformV1FeatureViewSync: properties: - dataKey: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' - description: Optional. The request key to fetch feature values for. - dataFormat: - enumDescriptions: - - Not set. Will be treated as the KeyValue format. - - Return response data in key-value format. - - Return response data in proto Struct format. - enum: - - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED - - KEY_VALUE - - PROTO_STRUCT + runTime: + description: Output only. Time when this FeatureViewSync is finished. + readOnly: true + $ref: '#/components/schemas/GoogleTypeInterval' + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + name: + type: string description: >- - Optional. Response data format. If not set, - FeatureViewDataFormat.KEY_VALUE will be used. + Identifier. Name of the FeatureViewSync. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` + finalStatus: + description: Output only. Final status of the FeatureViewSync. + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + syncSummary: + readOnly: true + description: Output only. Summary of the sync job. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncSyncSummary + createTime: + format: google-datetime + description: >- + Output only. Time when this FeatureViewSync is created. Creation of + a FeatureViewSync means that the job is pending / waiting for + sufficient resources but may not have started the actual data + transfer yet. + readOnly: true type: string + description: >- + FeatureViewSync is a representation of sync operation which copies data + from data source to Feature View in Online Store. + id: GoogleCloudAiplatformV1FeatureViewSync type: object - GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: - description: Metadata information for NotebookService.AssignNotebookRuntime. - id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation: + properties: + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation + description: >- + Training pipeline will infer the proper transformation based on the + statistic of dataset. type: object + GoogleCloudAiplatformV1SuggestTrialsMetadata: + type: object + id: GoogleCloudAiplatformV1SuggestTrialsMetadata + description: Details of operations that perform Trials suggestion. properties: - progressMessage: + clientId: description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. + The identifier of the client that is requesting the suggestion. If + multiple SuggestTrialsRequests have the same `client_id`, the + service will return the identical suggested Trial if the Trial is + pending, and provide a new Trial if the last suggested Trial was + completed. type: string genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - GoogleCloudAiplatformV1VertexAISearch: - description: >- - Retrieve from Vertex AI Search datastore for grounding. See - https://cloud.google.com/vertex-ai-search-and-conversation + description: Operation metadata for suggesting Trials. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation: properties: - datastore: - description: >- - Required. Fully-qualified Vertex AI Search's datastore resource ID. - Format: - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + columnName: type: string - id: GoogleCloudAiplatformV1VertexAISearch - type: object - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: + description: >- + Treats the column as text array and performs following transformation + functions. * Concatenate all text values in the array into a single text + value using a space (" ") as a delimiter, and then treat the result as a + single text value. Apply the transformations for Text columns. * Empty + arrays treated as an empty text. id: >- - GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams - properties: - confidenceThreshold: - type: number - format: float - description: >- - When the model predicts category of pixels of the image, it will - only provide predictions for pixels that it is at least this much - confident about. All other pixels will be classified as background. - Default value is 0.5. - description: Prediction model parameters for Image Segmentation. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation type: object - GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec: - description: >- - Selects Features of an EntityType to read values of and specifies read - settings. + GoogleCloudAiplatformV1GroundingChunkRetrievedContext: + description: Chunk from context retrieved by the retrieval tools. type: object - id: GoogleCloudAiplatformV1BatchReadFeatureValuesRequestEntityTypeSpec properties: - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - description: >- - Required. Selectors choosing which Feature values to read from the - EntityType. - entityTypeId: + title: + description: Title of the attribution. + type: string + uri: + description: URI reference of the attribution. type: string + id: GoogleCloudAiplatformV1GroundingChunkRetrievedContext + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput: + description: Input for pairwise question answering quality metric. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput + type: object + properties: + metricSpec: + description: Required. Spec for pairwise question answering quality score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualitySpec + instance: + description: Required. Pairwise question answering quality instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: + type: object + id: >- + GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + description: Represents the spec to match categorical values from parent parameter. + properties: + values: description: >- - Required. ID of the EntityType to select Features. The EntityType id - is the entity_type_id specified during EntityType creation. - settings: - description: Per-Feature settings for the batch read. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DestinationFeatureSetting + Required. Matches values of the parent parameter of 'CATEGORICAL' + type. All values must exist in `categorical_value_spec` of parent + parameter. type: array - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + items: + type: string + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: type: object - description: >- - Config that contains the strategy used to generate sliding windows in - time series training. A window is a series of rows that comprise the - context up to the time of prediction, and the horizon following. The - corresponding row for each window marks the start of the forecast - horizon. Each window is used as an input example for - training/evaluation. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata properties: - strideLength: - type: string + successfulStopReason: + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED description: >- - Stride length used to generate input examples. Within one time - series, every {$STRIDE_LENGTH} rows will be used to generate a - sliding window. - format: int64 - maxCount: + For successful job completions, this is the reason why the job has + finished. + type: string + costMilliNodeHours: description: >- - Maximum number of windows that should be generated across all time - series. + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. format: int64 type: string - column: + GoogleCloudAiplatformV1PipelineTemplateMetadata: + id: GoogleCloudAiplatformV1PipelineTemplateMetadata + properties: + version: description: >- - Name of the column that should be used to generate sliding windows. - The column should contain either booleans or string booleans; if the - value of the row is True, generate a sliding window with the horizon - starting at that row. The column will not be used as a feature in - training. + The version_name in artifact registry. Will always be presented in + output if the PipelineJob.template_uri is from supported template + registry. Format is "sha256:abcdef123456...". type: string - GoogleCloudAiplatformV1MutateDeployedModelResponse: + description: >- + Pipeline template metadata if PipelineJob.template_uri is from supported + template registry. Currently, the only supported registry is Artifact + Registry. type: object - properties: - deployedModel: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' - description: The DeployedModel that's being mutated. - id: GoogleCloudAiplatformV1MutateDeployedModelResponse - description: Response message for EndpointService.MutateDeployedModel. - GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: + GoogleCloudAiplatformV1SummarizationHelpfulnessSpec: type: object - description: The output of a multi-trial Neural Architecture Search (NAS) jobs. + description: Spec for summarization helpfulness score metric. + id: GoogleCloudAiplatformV1SummarizationHelpfulnessSpec properties: - trainTrials: - type: array - description: >- - Output only. List of NasTrials that were started as part of train - stage. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - readOnly: true - searchTrials: - readOnly: true + useReference: + type: boolean description: >- - Output only. List of NasTrials that were started as part of search - stage. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' - type: array - id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput - GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest: + Optional. Whether to use instance.reference to compute summarization + helpfulness. + version: + format: int32 + type: integer + description: Optional. Which version to use for evaluation. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + type: object properties: - deploymentResourcePoolId: - description: >- - Required. The ID to use for the DeploymentResourcePool, which will - become the final component of the DeploymentResourcePool's resource - name. The maximum length is 63 characters, and valid characters are - `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. + columnName: type: string - deploymentResourcePool: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool' - description: Required. The DeploymentResourcePool to create. - type: object - description: Request message for CreateDeploymentResourcePool method. - id: GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest - GoogleCloudAiplatformV1ModelEvaluation: - id: GoogleCloudAiplatformV1ModelEvaluation description: >- - A collection of metrics calculated by comparing Model's predictions on - all of the test data against annotations from the test data. + Training pipeline will infer the proper transformation based on the + statistic of dataset. + CloudAiLargeModelsVisionRaiInfo: + id: CloudAiLargeModelsVisionRaiInfo properties: - dataItemSchemaUri: - description: >- - Points to a YAML file stored on Google Cloud Storage describing - EvaluatedDataItemView.data_item_payload and - EvaluatedAnnotation.data_item_payload. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - This field is not populated if there are neither - EvaluatedDataItemViews nor EvaluatedAnnotations under this - ModelEvaluation. + modelName: type: string - annotationSchemaUri: - type: string - description: >- - Points to a YAML file stored on Google Cloud Storage describing - EvaluatedDataItemView.predictions, - EvaluatedDataItemView.ground_truths, - EvaluatedAnnotation.predictions, and - EvaluatedAnnotation.ground_truths. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - This field is not populated if there are neither - EvaluatedDataItemViews nor EvaluatedAnnotations under this - ModelEvaluation. - modelExplanation: description: >- - Aggregated explanation metrics for the Model's prediction output - over the data this ModelEvaluation uses. This field is populated - only if the Model is evaluated with explanations, and only for - AutoML tabular Models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' - explanationSpecs: + The model name used to indexing into the RaiFilterConfig map. Would + either be one of imagegeneration@002-006, imagen-3.0-... api + endpoint names, or internal names used for mapping to different + filter configs (genselfie, ai_watermark) than its api endpoint. + scores: description: >- - Describes the values of ExplanationSpec that are used for explaining - the predicted values on the evaluated data. + List of rai scores mapping to the rai categories. Rounded to 1 + decimal place. + type: array items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + type: number + format: float + raiCategories: type: array - metrics: - type: any - description: >- - Evaluation metrics of the Model. The schema of the metrics is stored - in metrics_schema_uri - createTime: - description: Output only. Timestamp when this ModelEvaluation was created. - readOnly: true - format: google-datetime - type: string - name: - readOnly: true - description: Output only. The resource name of the ModelEvaluation. - type: string - metadata: - type: any - description: >- - The metadata of the ModelEvaluation. For the ModelEvaluation - uploaded from Managed Pipeline, metadata contains a structured value - with keys of "pipeline_job_id", "evaluation_dataset_type", - "evaluation_dataset_path", "row_based_metrics_path". - metricsSchemaUri: - description: >- - Points to a YAML file stored on Google Cloud Storage describing the - metrics of this ModelEvaluation. The schema is defined as an OpenAPI - 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - type: string - sliceDimensions: + description: List of rai categories' information to return items: type: string + detectedLabels: + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabels' type: array - description: >- - All possible dimensions of ModelEvaluationSlices. The dimensions can - be used as the filter of the ModelService.ListModelEvaluationSlices - request, in the form of `slice.dimension = `. - displayName: - type: string - description: The display name of the ModelEvaluation. + description: The list of detected labels for different rai categories. type: object - GoogleCloudAiplatformV1Execution: + GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: + properties: {} + description: Configuration options for using brute force search. + id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig type: object - id: GoogleCloudAiplatformV1Execution + GoogleCloudAiplatformV1AddContextChildrenRequest: + type: object + id: GoogleCloudAiplatformV1AddContextChildrenRequest + description: Request message for MetadataService.AddContextChildren. properties: - state: - enum: - - STATE_UNSPECIFIED - - NEW - - RUNNING - - COMPLETE - - FAILED - - CACHED - - CANCELLED - enumDescriptions: - - Unspecified Execution state - - The Execution is new - - The Execution is running - - The Execution has finished running - - The Execution has failed - - The Execution completed through Cache hit. - - The Execution was cancelled. - type: string - description: >- - The state of this Execution. This is a property of the Execution, - and does not imply or capture any ongoing process. This property is - managed by clients (such as Vertex AI Pipelines) and the system does - not prescribe or check the validity of state transitions. - createTime: - format: google-datetime - description: Output only. Timestamp when this Execution was created. - readOnly: true - type: string - etag: - description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. - type: string - displayName: + childContexts: + type: array + description: The resource names of the child Contexts. + items: + type: string + GoogleCloudAiplatformV1Retrieval: + type: object + properties: + vertexRagStore: description: >- - User provided display name of the Execution. May be up to 128 - Unicode characters. - type: string - schemaVersion: + Set to use data source powered by Vertex RAG store. User data is + uploaded via the VertexRagDataService. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexRagStore' + vertexAiSearch: + description: Set to use data source powered by Vertex AI Search. + $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' + disableAttribution: + description: Optional. Deprecated. This option is no longer supported. + type: boolean + deprecated: true + id: GoogleCloudAiplatformV1Retrieval + description: >- + Defines a retrieval tool that model can call to access external + knowledge. + GoogleCloudAiplatformV1NotebookIdleShutdownConfig: + type: object + description: >- + The idle shutdown configuration of NotebookRuntimeTemplate, which + contains the idle_timeout as required field. + properties: + idleTimeout: type: string description: >- - The version of the schema in `schema_title` to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - metadata: + Required. Duration is accurate to the second. In Notebook, Idle + Timeout is accurate to minute so the range of idle_timeout (second) + is: 10 * 60 ~ 1440 * 60. + format: google-duration + idleShutdownDisabled: + type: boolean + description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. + id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig + GoogleCloudAiplatformV1FunctionResponse: + description: >- + The result output from a [FunctionCall] that contains a string + representing the [FunctionDeclaration.name] and a structured JSON object + containing any output from the function is used as context to the model. + This should contain the result of a [FunctionCall] made based on model + prediction. + properties: + response: + type: object additionalProperties: - type: any description: Properties of the object. + type: any description: >- - Properties of the Execution. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. - type: object - labels: - type: object - description: >- - The labels with user-defined metadata to organize your Executions. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Execution - (System labels are excluded). - additionalProperties: - type: string + Required. The function response in JSON object format. Use "output" + key to specify function output and "error" key to specify error + details (if any). If "output" and "error" keys are not specified, + then whole "response" is treated as function output. name: - readOnly: true - type: string - description: Output only. The resource name of the Execution. - updateTime: - description: Output only. Timestamp when this Execution was last updated. - format: google-datetime - readOnly: true - type: string - description: - description: Description of the Execution - type: string - schemaTitle: description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. + Required. The name of the function to call. Matches + [FunctionDeclaration.name] and [FunctionCall.name]. type: string - description: Instance of a general execution. - GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket: + id: GoogleCloudAiplatformV1FunctionResponse type: object - properties: - count: - type: number - description: Output only. Number of values in the bucket. - readOnly: true - format: double - left: - type: number - format: double - readOnly: true - description: Output only. Left bound of the bucket. - right: - format: double - description: Output only. Right bound of the bucket. - type: number - readOnly: true - description: >- - Dataset bucket used to create a histogram for the distribution given a - population of values. - id: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetection + GoogleCloudAiplatformV1StudySpecParameterSpec: type: object + id: GoogleCloudAiplatformV1StudySpecParameterSpec properties: - inputs: - description: The input parameters of this TrainingJob. + conditionalParameterSpecs: + type: array + description: >- + A conditional parameter node is active if the parameter's value + matches the conditional node's parent_value_condition. If two items + in conditional_parameter_specs have the same name, they must have + disjoint parent_value_condition. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec + integerValueSpec: + description: The value spec for an 'INTEGER' parameter. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs - metadata: - description: The metadata information + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec + discreteValueSpec: + description: The value spec for a 'DISCRETE' parameter. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata - description: >- - A TrainingJob that trains and uploads an AutoML Image Object Detection - Model. - GoogleCloudAiplatformV1TuningDataStats: - id: GoogleCloudAiplatformV1TuningDataStats - type: object - properties: - distillationDataStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DistillationDataStats' - description: Statistics for distillation. - supervisedTuningDataStats: + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec + doubleValueSpec: + description: The value spec for a 'DOUBLE' parameter. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedTuningDataStats - description: The SFT Tuning data stats. - reinforcementLearningDataStats: + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + categoricalValueSpec: + description: The value spec for a 'CATEGORICAL' parameter. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReinforcementLearningDataStats - description: Statistics for reinforcement learning. - description: The tuning data statistic values for TuningJob. - GoogleCloudAiplatformV1ListFeaturesResponse: + #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec + parameterId: + type: string + description: >- + Required. The ID of the parameter. Must not contain whitespaces and + must be unique amongst all ParameterSpecs. + scaleType: + enumDescriptions: + - By default, no scaling is applied. + - Scales the feasible space to (0, 1) linearly. + - >- + Scales the feasible space logarithmically to (0, 1). The entire + feasible space must be strictly positive. + - >- + Scales the feasible space "reverse" logarithmically to (0, 1). The + result is that values close to the top of the feasible space are + spread out more than points near the bottom. The entire feasible + space must be strictly positive. + description: >- + How the parameter should be scaled. Leave unset for `CATEGORICAL` + parameters. + enum: + - SCALE_TYPE_UNSPECIFIED + - UNIT_LINEAR_SCALE + - UNIT_LOG_SCALE + - UNIT_REVERSE_LOG_SCALE + type: string + description: Represents a single parameter to optimize. + GoogleCloudAiplatformV1EvaluatedAnnotation: + id: GoogleCloudAiplatformV1EvaluatedAnnotation description: >- - Response message for FeaturestoreService.ListFeatures. Response message - for FeatureRegistryService.ListFeatures. - id: GoogleCloudAiplatformV1ListFeaturesResponse - type: object + True positive, false positive, or false negative. EvaluatedAnnotation is + only available under ModelEvaluationSlice with slice of `annotationSpec` + dimension. properties: - features: + dataItemPayload: + readOnly: true + description: >- + Output only. The data item payload that the Model predicted this + EvaluatedAnnotation on. + type: any + type: + readOnly: true + type: string + description: Output only. Type of the EvaluatedAnnotation. + enumDescriptions: + - Invalid value. + - >- + The EvaluatedAnnotation is a true positive. It has a prediction + created by the Model and a ground truth Annotation which the + prediction matches. + - >- + The EvaluatedAnnotation is false positive. It has a prediction + created by the Model which does not match any ground truth + annotation. + - >- + The EvaluatedAnnotation is false negative. It has a ground truth + annotation which is not matched by any of the model created + predictions. + enum: + - EVALUATED_ANNOTATION_TYPE_UNSPECIFIED + - TRUE_POSITIVE + - FALSE_POSITIVE + - FALSE_NEGATIVE + errorAnalysisAnnotations: type: array - description: The Features matching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - nextPageToken: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotation + description: Annotations of model error analysis results. + groundTruths: + type: array + readOnly: true + items: + type: any description: >- - A token, which can be sent as ListFeaturesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. + Output only. The ground truth Annotations, i.e. the Annotations that + exist in the test data the Model is evaluated on. For true positive, + there is one and only one ground truth annotation, which matches the + only prediction in predictions. For false positive, there are zero + or more ground truth annotations that are similar to the only + prediction in predictions, but not enough for a match. For false + negative, there is one and only one ground truth annotation, which + doesn't match any predictions created by the model. The schema of + the ground truth is stored in ModelEvaluation.annotation_schema_uri + explanations: + description: >- + Explanations of predictions. Each element of the explanations + indicates the explanation for one explanation Method. The + attributions list in the EvaluatedAnnotationExplanation.explanation + object corresponds to the predictions list. For example, the second + element in the attributions list explains the second element in the + predictions list. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + evaluatedDataItemViewId: + description: >- + Output only. ID of the EvaluatedDataItemView under the same ancestor + ModelEvaluation. The EvaluatedDataItemView consists of all ground + truths and predictions on data_item_payload. type: string - GoogleCloudAiplatformV1UndeployModelResponse: + readOnly: true + predictions: + readOnly: true + description: >- + Output only. The model predicted annotations. For true positive, + there is one and only one prediction, which matches the only one + ground truth annotation in ground_truths. For false positive, there + is one and only one prediction, which doesn't match any ground truth + annotation of the corresponding data_item_view_id. For false + negative, there are zero or more predictions which are similar to + the only ground truth annotation in ground_truths but not enough for + a match. The schema of the prediction is stored in + ModelEvaluation.annotation_schema_uri + items: + type: any + type: array type: object - description: Response message for EndpointService.UndeployModel. - properties: {} - id: GoogleCloudAiplatformV1UndeployModelResponse - GoogleCloudAiplatformV1AutomaticResources: - description: >- - A description of resources that to large degree are decided by Vertex - AI, and require only a modest additional configuration. Each Model - supporting these resources documents its specific guidelines. + GoogleCloudAiplatformV1NearestNeighborQuery: properties: - maxReplicaCount: - type: integer - description: >- - Immutable. The maximum number of replicas this DeployedModel may be - deployed on when the traffic against it increases. If the requested - value is too large, the deployment will error, but if deployment - succeeds then the ability to scale the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel increases beyond what its replicas at maximum may - handle, a portion of the traffic will be dropped. If this value is - not provided, a no upper bound for scaling under heavy traffic will - be assume, though Vertex AI may be unable to scale beyond certain - replica number. + stringFilters: + description: Optional. The list of string filters. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter + type: array + perCrowdingAttributeNeighborCount: format: int32 - minReplicaCount: + description: >- + Optional. Crowding is a constraint on a neighbor list produced by + nearest neighbor search requiring that no more than + sper_crowding_attribute_neighbor_count of the k neighbors returned + have the same value of crowding_attribute. It's used for improving + result diversity. + type: integer + parameters: + description: Optional. Parameters that can be set to tune query on the fly. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters + neighborCount: type: integer format: int32 description: >- - Immutable. The minimum number of replicas this DeployedModel will be - always deployed on. If traffic against it increases, it may - dynamically be deployed onto more replicas up to max_replica_count, - and as traffic decreases, some of these extra replicas may be freed. - If the requested value is too large, the deployment will error. + Optional. The number of similar entities to be retrieved from + feature view for each query. + numericFilters: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter + type: array + description: Optional. The list of numeric filters. + entityId: + type: string + description: >- + Optional. The entity id whose similar entities should be searched + for. If embedding is set, search will use embedding instead of + entity_id. + embedding: + description: Optional. The embedding vector that be used for similar search. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryEmbedding + description: A query to find a number of similar entities. type: object - id: GoogleCloudAiplatformV1AutomaticResources - GoogleCloudAiplatformV1Attribution: - description: Attribution that explains a particular prediction output. + id: GoogleCloudAiplatformV1NearestNeighborQuery + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource: type: object + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource properties: - baselineOutputValue: - type: number - description: >- - Output only. Model predicted output if the input instance is - constructed from the baselines of all the features defined in - ExplanationMetadata.inputs. The field name of the output is - determined by the key in ExplanationMetadata.outputs. If the Model's - predicted output has multiple dimensions (rank > 1), this is the - value in the output located by output_index. If there are multiple - baselines, their output values are averaged. - format: double - readOnly: true - outputDisplayName: - type: string - readOnly: true - description: >- - Output only. The display name of the output identified by - output_index. For example, the predicted class name by a - multi-classification Model. This field is only populated iff the - Model predicts display names as a separate field along with the - explained output. The predicted display name must has the same shape - of the explained output, and can be located using output_index. - outputName: - readOnly: true - description: >- - Output only. Name of the explain output. Specified as the key in - ExplanationMetadata.outputs. + uri: type: string - outputIndex: - items: - format: int32 - type: integer - type: array - description: >- - Output only. The index that locates the explained prediction output. - If the prediction output is a scalar value, output_index is not - populated. If the prediction output has multiple dimensions, the - length of the output_index list is the same as the number of - dimensions of the output. The i-th element in output_index is the - element index of the i-th dimension of the output vector. Indices - start from 0. - readOnly: true - approximationError: description: >- - Output only. Error of feature_attributions caused by approximation - used in the explanation method. Lower value means more precise - attributions. * For Sampled Shapley attribution, increasing - path_count might reduce the error. * For Integrated Gradients - attribution, increasing step_count might reduce the error. * For - XRAI attribution, increasing step_count might reduce the error. See - [this introduction](/vertex-ai/docs/explainable-ai/overview) for - more information. - format: double - readOnly: true + The URI of a BigQuery table. e.g. + bq://projectId.bqDatasetId.bqTableId + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult: + properties: + confidence: type: number - instanceOutputValue: + format: float + description: Output only. Confidence for question answering correctness score. readOnly: true - format: double - description: >- - Output only. Model predicted output on the corresponding explanation - instance. The field name of the output is determined by the key in - ExplanationMetadata.outputs. If the Model predicted output has - multiple dimensions, this is the value in the output located by - output_index. + score: + format: float type: number - featureAttributions: - type: any + description: Output only. Question Answering Correctness score. readOnly: true - description: >- - Output only. Attributions of each explained feature. Features are - extracted from the prediction instances according to explanation - metadata for inputs. The value is a struct, whose keys are the name - of the feature. The values are how much the feature in the instance - contributed to the predicted result. The format of the value is - determined by the feature's input format: * If the feature is a - scalar value, the attribution value is a floating number. * If the - feature is an array of scalar values, the attribution value is an - array. * If the feature is a struct, the attribution value is a - struct. The keys in the attribution value struct are the same as the - keys in the feature struct. The formats of the values in the - attribution struct are determined by the formats of the values in - the feature struct. The - ExplanationMetadata.feature_attributions_schema_uri field, pointed - to by the ExplanationSpec field of the Endpoint.deployed_models - object, points to the schema file that describes the features and - their attribution values (if it is populated). - id: GoogleCloudAiplatformV1Attribution - GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: - description: Details of operations that perform create Featurestore. - id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata - type: object - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Featurestore. - GoogleCloudAiplatformV1MetadataSchema: - id: GoogleCloudAiplatformV1MetadataSchema - description: Instance of a general MetadataSchema. - properties: - name: + explanation: + description: Output only. Explanation for question answering correctness score. readOnly: true - description: Output only. The resource name of the MetadataSchema. type: string - schemaVersion: + description: Spec for question answering correctness result. + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: + properties: + displayName: type: string + description: The display name of the AnnotationSpec that had been identified. + timeSegmentEnd: description: >- - The version of the MetadataSchema. The version's format must match - the following regular expression: `^[0-9]+.+.+$`, which would allow - to order/compare different versions. Example: 1.0.0, 1.0.1, etc. - description: - description: Description of the Metadata Schema - type: string - createTime: + The end, exclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + format: google-duration type: string - format: google-datetime - readOnly: true - description: Output only. Timestamp when this MetadataSchema was created. - schema: + timeSegmentStart: + description: >- + The beginning, inclusive, of the video's time segment in which the + AnnotationSpec has been identified. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + format: google-duration type: string + confidence: description: >- - Required. The raw YAML string representation of the MetadataSchema. - The combination of [MetadataSchema.version] and the schema name - given by `title` in [MetadataSchema.schema] must be unique within a - MetadataStore. The schema is defined as an OpenAPI 3.0.2 - [MetadataSchema - Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) - schemaType: - enum: - - METADATA_SCHEMA_TYPE_UNSPECIFIED - - ARTIFACT_TYPE - - EXECUTION_TYPE - - CONTEXT_TYPE + The Model's confidence in correction of this prediction, higher + value means higher confidence. + format: float + type: number + id: + type: string + description: The resource ID of the AnnotationSpec that had been identified. + description: Prediction output format for Video Action Recognition. + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult + GoogleCloudAiplatformV1Scheduling: + type: object + description: All parameters related to queuing and scheduling of custom jobs. + properties: + timeout: + description: The maximum job running time. The default is 7 days. + type: string + format: google-duration + disableRetries: description: >- - The type of the MetadataSchema. This is a property that identifies - which metadata types will use the MetadataSchema. + Optional. Indicates if the job should retry for internal errors + after the job starts running. If true, overrides + `Scheduling.restart_job_on_worker_restart` to false. + type: boolean + strategy: + type: string + description: Optional. This determines which type of scheduling strategy to use. + enumDeprecated: + - false + - true + - true + - false + - false + - false enumDescriptions: - - Unspecified type for the MetadataSchema. - - >- - A type indicating that the MetadataSchema will be used by - Artifacts. - - >- - A typee indicating that the MetadataSchema will be used by - Executions. - - >- - A state indicating that the MetadataSchema will be used by - Contexts. + - Strategy will default to STANDARD. + - Deprecated. Regular on-demand provisioning strategy. + - Deprecated. Low cost by making potential use of spot resources. + - Standard provisioning strategy uses regular on-demand resources. + - Spot provisioning strategy uses spot resources. + - Flex Start strategy uses DWS to queue for resources. + enum: + - STRATEGY_UNSPECIFIED + - ON_DEMAND + - LOW_COST + - STANDARD + - SPOT + - FLEX_START + restartJobOnWorkerRestart: + description: >- + Restarts the entire CustomJob if a worker gets restarted. This + feature can be used by distributed training jobs that are not + resilient to workers leaving and joining a job. + type: boolean + maxWaitDuration: + format: google-duration + description: >- + Optional. This is the maximum duration that a job will wait for the + requested resources to be provisioned if the scheduling strategy is + set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait + indefinitely. The default is 24 hours. type: string + id: GoogleCloudAiplatformV1Scheduling + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec: type: object - GoogleCloudAiplatformV1Artifact: - id: GoogleCloudAiplatformV1Artifact - type: object - description: Instance of a general artifact. + description: Spec for question answering helpfulness metric. + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec properties: - etag: + version: + description: Optional. Which version to use for evaluation. + type: integer + format: int32 + useReference: description: >- - An eTag used to perform consistent read-modify-write updates. If not - set, a blind "overwrite" update happens. + Optional. Whether to use instance.reference to compute question + answering helpfulness. + type: boolean + GoogleCloudAiplatformV1ToolParameterKeyMatchInstance: + properties: + prediction: + description: Required. Output of the evaluated model. type: string - uri: + reference: type: string + description: Required. Ground truth used to compare against the prediction. + description: Spec for tool parameter key match instance. + id: GoogleCloudAiplatformV1ToolParameterKeyMatchInstance + type: object + GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: + description: Annotation details specific to video action recognition. + properties: + annotationSpecId: description: >- - The uniform resource identifier of the artifact file. May be empty - if there is no actual artifact file. + The resource Id of the AnnotationSpec that this Annotation pertains + to. + type: string + timeSegment: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + description: >- + This Annotation applies to the time period represented by the + TimeSegment. If it's not set, the Annotation applies to the whole + video. displayName: description: >- - User provided display name of the Artifact. May be up to 128 Unicode - characters. + The display name of the AnnotationSpec that this Annotation pertains + to. type: string + id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation + type: object + GoogleCloudAiplatformV1TensorboardExperiment: + id: GoogleCloudAiplatformV1TensorboardExperiment + type: object + description: >- + A TensorboardExperiment is a group of TensorboardRuns, that are + typically the results of a training job run, in a Tensorboard. + properties: labels: additionalProperties: type: string - type: object description: >- - The labels with user-defined metadata to organize your Artifacts. - Label keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. No - more than 64 user labels can be associated with one Artifact (System - labels are excluded). + The labels with user-defined metadata to organize your + TensorboardExperiment. Label keys and values cannot be longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. No more than 64 user labels can be + associated with one Dataset (System labels are excluded). See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + `aiplatform.googleapis.com/` and are immutable. The following system + labels exist for each Dataset: * + `aiplatform.googleapis.com/dataset_metadata_schema`: output only. + Its value is the metadata_schema's title. + type: object + displayName: + description: User provided name of this TensorboardExperiment. + type: string updateTime: + description: >- + Output only. Timestamp when this TensorboardExperiment was last + updated. + format: google-datetime + type: string + readOnly: true + source: type: string + description: >- + Immutable. Source of the TensorboardExperiment. Example: a custom + training job. + createTime: format: google-datetime - description: Output only. Timestamp when this Artifact was last updated. readOnly: true - schemaVersion: type: string + description: Output only. Timestamp when this TensorboardExperiment was created. + etag: description: >- - The version of the schema in schema_name to use. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. - description: - description: Description of the Artifact + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. type: string - schemaTitle: + name: + readOnly: true description: >- - The title of the schema describing the metadata. Schema title and - version is expected to be registered in earlier Create Schema calls. - And both are used together as unique identifiers to identify schemas - within the local metadata store. + Output only. Name of the TensorboardExperiment. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` type: string - state: - enumDescriptions: - - Unspecified state for the Artifact. - - >- - A state used by systems like Vertex AI Pipelines to indicate that - the underlying data item represented by this Artifact is being - created. - - >- - A state indicating that the Artifact should exist, unless - something external to the system deletes it. + description: + description: Description of this TensorboardExperiment. + type: string + GoogleCloudLocationLocation: + type: object + description: A resource that represents a Google Cloud location. + id: GoogleCloudLocationLocation + properties: + displayName: description: >- - The state of this Artifact. This is a property of the Artifact, and - does not imply or capture any ongoing process. This property is - managed by clients (such as Vertex AI Pipelines), and the system - does not prescribe or check the validity of state transitions. + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". type: string - enum: - - STATE_UNSPECIFIED - - PENDING - - LIVE name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` type: string - description: Output only. The resource name of the Artifact. - readOnly: true + labels: + type: object + additionalProperties: + type: string + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. additionalProperties: type: any - description: Properties of the object. - description: >- - Properties of the Artifact. Top level metadata keys' heading and - trailing spaces will be trimmed. The size of this field should not - exceed 200KB. + description: Properties of the object. Contains field @type with type URL. type: object - createTime: + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' type: string - format: google-datetime - readOnly: true - description: Output only. Timestamp when this Artifact was created. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs: + GoogleCloudAiplatformV1UpdateExplanationDatasetRequest: + type: object + description: Request message for ModelService.UpdateExplanationDataset. properties: - dataGranularity: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsGranularity - description: Expected difference in time granularity between rows in the data. - timeColumn: - type: string + examples: + description: The example config containing the location of the dataset. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + id: GoogleCloudAiplatformV1UpdateExplanationDatasetRequest + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance: + type: object + description: Prediction input format for Text Sentiment. + properties: + mimeType: description: >- - The name of the column that identifies time order in the time - series. This column must be available at forecast. - contextWindow: + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + type: string + content: + description: The text snippet to make the predictions on. + type: string + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextSentimentPredictionInstance + GoogleCloudAiplatformV1SafetySetting: + id: GoogleCloudAiplatformV1SafetySetting + description: Safety settings. + properties: + threshold: + enumDescriptions: + - Unspecified harm block threshold. + - Block low threshold and above (i.e. block more). + - Block medium threshold and above. + - Block only high threshold (i.e. block less). + - Block none. + type: string + enum: + - HARM_BLOCK_THRESHOLD_UNSPECIFIED + - BLOCK_LOW_AND_ABOVE + - BLOCK_MEDIUM_AND_ABOVE + - BLOCK_ONLY_HIGH + - BLOCK_NONE + description: Required. The harm block threshold. + category: + enum: + - HARM_CATEGORY_UNSPECIFIED + - HARM_CATEGORY_HATE_SPEECH + - HARM_CATEGORY_DANGEROUS_CONTENT + - HARM_CATEGORY_HARASSMENT + - HARM_CATEGORY_SEXUALLY_EXPLICIT + type: string + description: Required. Harm category. + enumDescriptions: + - The harm category is unspecified. + - The harm category is hate speech. + - The harm category is dangerous content. + - The harm category is harassment. + - The harm category is sexually explicit content. + method: + enum: + - HARM_BLOCK_METHOD_UNSPECIFIED + - SEVERITY + - PROBABILITY + enumDescriptions: + - The harm block method is unspecified. + - The harm block method uses both probability and severity scores. + - The harm block method uses the probability score. description: >- - The amount of time into the past training and prediction data is - used for model training and prediction respectively. Expressed in - number of units defined by the `data_granularity` field. - format: int64 + Optional. Specify if the threshold is used for probability or + severity score. If not specified, the threshold is used for + probability score. + type: string + type: object + GoogleCloudAiplatformV1SchemaTextDataItem: + id: GoogleCloudAiplatformV1SchemaTextDataItem + description: Payload of Text DataItem. + type: object + properties: + gcsUri: + readOnly: true type: string - hierarchyConfig: description: >- - Configuration that defines the hierarchical relationship of time - series and parameters for hierarchical forecasting strategies. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig - transformations: + Output only. Google Cloud Storage URI points to the original text in + user's bucket. The text file is up to 10MB in size. + GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader: + properties: + featureDescriptors: + type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseFeatureDescriptor description: >- - Each transformation will apply transform function to given input - column. And the result will be used for training. When creating - transformation for BigQuery Struct column, the column should be - flattened using "." as the delimiter. - type: array - forecastHorizon: + List of Feature metadata corresponding to each piece of + ReadFeatureValuesResponse.EntityView.data. + entityType: + type: string description: >- - The amount of time into the future for which forecasted values for - the target are returned. Expressed in number of units defined by the - `data_granularity` field. - format: int64 + The resource name of the EntityType from the + ReadFeatureValuesRequest. Value format: + `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + description: >- + Response header with metadata for the requested + ReadFeatureValuesRequest.entity_type and Features. + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseHeader + type: object + GoogleCloudAiplatformV1ToolCallValidSpec: + description: Spec for tool call valid metric. + id: GoogleCloudAiplatformV1ToolCallValidSpec + properties: {} + type: object + GoogleCloudAiplatformV1ExamplesExampleGcsSource: + description: The Cloud Storage input instances. + id: GoogleCloudAiplatformV1ExamplesExampleGcsSource + type: object + properties: + dataFormat: type: string - timeSeriesAttributeColumns: + enum: + - DATA_FORMAT_UNSPECIFIED + - JSONL description: >- - Column names that should be used as attribute columns. The value of - these columns does not vary as a function of time. For example, - store ID or item color. - type: array - items: - type: string - trainBudgetMilliNodeHours: - format: int64 + The format in which instances are given, if not specified, assume + it's JSONL format. Currently only JSONL format is supported. + enumDescriptions: + - Format unspecified, used when unset. + - Examples are stored in JSONL files. + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: The Cloud Storage location for the input instances. + GoogleCloudAiplatformV1CopyModelRequest: + description: Request message for ModelService.CopyModel. + id: GoogleCloudAiplatformV1CopyModelRequest + type: object + properties: + parentModel: description: >- - Required. The train budget of creating this model, expressed in - milli node hours i.e. 1,000 value in this field means 1 node hour. - The training cost of the model will not exceed this budget. The - final cost will be attempted to be close to the budget, though may - end up being (even) noticeably smaller - at the backend's - discretion. This especially may happen when further model training - ceases to provide any improvements. If the budget is set to a value - known to be insufficient to train a model for the given dataset, the - training won't be attempted and will error. The train budget must be - between 1,000 and 72,000 milli node hours, inclusive. + Optional. Specify this field to copy source_model into this existing + Model as a new version. Format: + `projects/{project}/locations/{location}/models/{model}` type: string - quantiles: - type: array + encryptionSpec: description: >- - Quantiles to use for minimize-quantile-loss - `optimization_objective`. Up to 5 quantiles are allowed of values - between 0 and 1, exclusive. Required if the value of - optimization_objective is minimize-quantile-loss. Represents the - percent quantiles to use for that objective. Quantiles must be - unique. - items: - type: number - format: double - holidayRegions: - items: - type: string + Customer-managed encryption key options. If this is set, then the + Model copy will be encrypted with the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + modelId: description: >- - The geographical region based on which the holiday effect is applied - in modeling by adding holiday categorical array feature that include - all holidays matching the date. This option only allowed when - data_granularity is day. By default, holiday effect modeling is - disabled. To turn it on, specify the holiday region using this - option. - type: array - timeSeriesIdentifierColumn: - description: The name of the column that identifies the time series. + Optional. Copy source_model into a new Model with this ID. The ID + will become the final component of the model resource name. This + value may be up to 63 characters, and valid characters are + `[a-z0-9_-]`. The first character cannot be a number or hyphen. type: string - additionalExperiments: - type: array - description: Additional experiment flags for the time series forcasting training. - items: - type: string - optimizationObjective: - description: >- - Objective function the model is optimizing towards. The training - process creates a model that optimizes the value of the objective - function over the validation set. The supported optimization - objectives: * "minimize-rmse" (default) - Minimize root-mean-squared - error (RMSE). * "minimize-mae" - Minimize mean-absolute error (MAE). - * "minimize-rmsle" - Minimize root-mean-squared log error (RMSLE). * - "minimize-rmspe" - Minimize root-mean-squared percentage error - (RMSPE). * "minimize-wape-mae" - Minimize the combination of - weighted absolute percentage error (WAPE) and mean-absolute-error - (MAE). * "minimize-quantile-loss" - Minimize the quantile loss at - the quantiles defined in `quantiles`. * "minimize-mape" - Minimize - the mean absolute percentage error. + sourceModel: type: string - exportEvaluatedDataItemsConfig: - description: >- - Configuration for exporting test set predictions to a BigQuery - table. If this configuration is absent, then the export is not - performed. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - unavailableAtForecastColumns: description: >- - Names of columns that are unavailable when a forecast is requested. - This column contains information for the given entity (identified by - the time_series_identifier_column) that is unknown before the - forecast For example, actual weather on a given day. + Required. The resource name of the Model to copy. That Model must be + in the same Project. Format: + `projects/{project}/locations/{location}/models/{model}` + CloudAiLargeModelsVisionRaiInfoDetectedLabels: + description: Filters returning list of deteceted labels, scores, and bounding boxes. + type: object + properties: + entities: + description: The list of detected entities for the rai signal. items: - type: string + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity type: array - targetColumn: + raiCategory: + description: The RAI category for the deteceted labels. + type: string + id: CloudAiLargeModelsVisionRaiInfoDetectedLabels + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics + type: object + properties: + exactMatch: + format: float description: >- - The name of the column that the Model is to predict values for. This - column must be unavailable at forecast. + The rate at which the input predicted strings exactly match their + references. + type: number + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature: + description: >- + Response message if the request uses the SelectTimeRangeAndFeature + option. + properties: + impactedFeatureCount: type: string - availableAtForecastColumns: - type: array description: >- - Names of columns that are available and provided when a forecast is - requested. These columns contain information for the given entity - (identified by the time_series_identifier_column column) that is - known at forecast. For example, predicted weather for a specific - day. - items: - type: string - weightColumn: + The count of the features or columns impacted. This is the same as + the feature count in the request. + format: int64 + offlineStorageModifiedEntityRowCount: type: string + format: int64 description: >- - Column name that should be used as the weight column. Higher values - in this column give more importance to the row during model - training. The column must have numeric values between 0 and 10000 - inclusively; 0 means the row is ignored for training. If weight - column field is not set, then all rows are assumed to have equal - weight of 1. This column must be available at forecast. - validationOptions: + The count of modified entity rows in the offline storage. Each row + corresponds to the combination of an entity ID and a timestamp. One + entity ID can have multiple rows in the offline storage. Within each + row, only the features specified in the request are deleted. + onlineStorageModifiedEntityCount: + type: string description: >- - Validation options for the data validation component. The available - options are: * "fail-pipeline" - default, will validate against the - validation and fail the pipeline if it fails. * "ignore-validation" - - ignore the results of the validation and continue - type: string - windowConfig: - description: Config containing strategy for generating sliding windows. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig - type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - GoogleCloudAiplatformV1ToolConfig: - id: GoogleCloudAiplatformV1ToolConfig - properties: - functionCallingConfig: - description: Optional. Function calling config. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' + The count of modified entities in the online storage. Each entity ID + corresponds to one entity. Within each entity, only the features + specified in the request are deleted. + format: int64 type: object - description: >- - Tool config. This config is shared for all tools provided in the - request. - GoogleCloudAiplatformV1SchemaVideoDataItem: + id: >- + GoogleCloudAiplatformV1DeleteFeatureValuesResponseSelectTimeRangeAndFeature + GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata: type: object - description: Payload of Video DataItem. - id: GoogleCloudAiplatformV1SchemaVideoDataItem + description: Details of operations that perform update PersistentResource. + id: GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata properties: - gcsUri: - type: string - description: >- - Required. Google Cloud Storage URI points to the original video in - user's bucket. The video is up to 50 GB in size and up to 3 hour in - duration. - mimeType: - readOnly: true - description: >- - Output only. The mime type of the content of the video. Only the - videos in below listed mime types are supported. Supported - mime_type: - video/mp4 - video/avi - video/quicktime + progressMessage: type: string - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest: - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest - properties: {} - type: object - description: Request message for VizierService.CheckTrialEarlyStoppingState. - GoogleCloudAiplatformV1RemoveDatapointsRequest: - properties: - datapointIds: - type: array - items: - type: string - description: A list of datapoint ids to be deleted. - id: GoogleCloudAiplatformV1RemoveDatapointsRequest - type: object - description: Request message for IndexService.RemoveDatapoints - GoogleCloudAiplatformV1NearestNeighborsNeighbor: - id: GoogleCloudAiplatformV1NearestNeighborsNeighbor - description: A neighbor of the query vector. + description: Progress Message for Update LRO + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for PersistentResource. + GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance: type: object properties: - distance: - type: number - description: The distance between the neighbor and the query vector. - format: double - entityId: + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + context: + type: string + description: Optional. Text provided as context to answer the question. + instruction: type: string - description: The id of the similar entity. - entityKeyValues: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse description: >- - The attributes of the neighbor, e.g. filters, crowding and metadata - Note that full entities are returned only when "return_full_entity" - is set to true. Otherwise, only the "entity_id" and "distance" - fields are populated. - GoogleCloudAiplatformV1PipelineTaskExecutorDetail: - description: The runtime detail of a pipeline executor. - properties: - customJobDetail: - description: Output only. The detailed info for a custom job executor. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailCustomJobDetail - containerDetail: - description: Output only. The detailed info for a container executor. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail - id: GoogleCloudAiplatformV1PipelineTaskExecutorDetail - type: object - GoogleCloudAiplatformV1SupervisedHyperParameters: - description: Hyperparameters for SFT. + Required. The question asked and other instruction in the inference + prompt. + prediction: + description: Required. Output of the evaluated model. + type: string + id: GoogleCloudAiplatformV1QuestionAnsweringRelevanceInstance + description: Spec for question answering relevance instance. + GoogleCloudAiplatformV1AssignNotebookRuntimeRequest: + id: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest + description: Request message for NotebookService.AssignNotebookRuntime. properties: - learningRateMultiplier: - format: double - description: Optional. Multiplier for adjusting the default learning rate. - type: number - adapterSize: - enumDescriptions: - - Adapter size is unspecified. - - Adapter size 1. - - Adapter size 4. - - Adapter size 8. - - Adapter size 16. - description: Optional. Adapter size for tuning. + notebookRuntimeTemplate: + description: >- + Required. The resource name of the NotebookRuntimeTemplate based on + which a NotebookRuntime will be assigned (reuse or create a new + one). type: string - enum: - - ADAPTER_SIZE_UNSPECIFIED - - ADAPTER_SIZE_ONE - - ADAPTER_SIZE_FOUR - - ADAPTER_SIZE_EIGHT - - ADAPTER_SIZE_SIXTEEN - epochCount: - format: int64 + notebookRuntime: description: >- - Optional. Number of complete passes the model makes over the entire - training dataset during training. + Required. Provide runtime specific information (e.g. runtime owner, + notebook id) used for NotebookRuntime assignment. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + notebookRuntimeId: type: string - id: GoogleCloudAiplatformV1SupervisedHyperParameters - type: object - GoogleCloudAiplatformV1IdMatcher: - description: Matcher for Features of an EntityType by Feature ID. + description: Optional. User specified ID for the notebook runtime. type: object - properties: - ids: - description: >- - Required. The following are accepted as `ids`: * A single-element - list containing only `*`, which selects all Features in the target - EntityType, or * A list containing only Feature IDs, which selects - only Features with those IDs in the target EntityType. - items: - type: string - type: array - id: GoogleCloudAiplatformV1IdMatcher GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig: - id: >- - GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig type: object - description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. properties: - modelVersion: - type: string - description: >- - Required. Full resource name of ml engine model version. Format: - `projects/{project}/models/{model}/versions/{version}`. modelDisplayName: + type: string description: >- Required. Display name of the model in Vertex AI. System will pick a display name if unspecified. + modelVersion: type: string + description: >- + Required. Full resource name of ml engine model version. Format: + `projects/{project}/models/{model}/versions/{version}`. endpoint: + type: string description: >- Required. The ml.googleapis.com endpoint that this model version should be migrated from. Example values: * ml.googleapis.com * us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-east1-ml.googleapis.com + description: Config for migrating version in ml.googleapis.com to Vertex AI's Model. + id: >- + GoogleCloudAiplatformV1MigrateResourceRequestMigrateMlEngineModelVersionConfig + GoogleCloudAiplatformV1PscAutomatedEndpoints: + description: >- + PscAutomatedEndpoints defines the output of the forwarding rule + automatically created by each PscAutomationConfig. + id: GoogleCloudAiplatformV1PscAutomatedEndpoints + properties: + projectId: + description: Corresponding project_id in pscAutomationConfigs type: string - GoogleCloudAiplatformV1Candidate: - description: A response candidate generated from the model. + network: + type: string + description: Corresponding network in pscAutomationConfigs. + matchAddress: + type: string + description: Ip Address created by the automated forwarding rule. + type: object + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest: + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest + description: Request message for TensorboardService.ExportTensorboardTimeSeriesData. type: object - id: GoogleCloudAiplatformV1Candidate properties: - citationMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CitationMetadata' - description: Output only. Source attribution of the generated content. - readOnly: true - finishMessage: - readOnly: true + pageToken: + type: string description: >- - Output only. Describes the reason the mode stopped generating tokens - in more detail. This is only filled when `finish_reason` is set. + A page token, received from a previous + ExportTensorboardTimeSeriesData call. Provide this to retrieve the + subsequent page. When paginating, all other parameters provided to + ExportTensorboardTimeSeriesData must match the call that provided + the page token. + orderBy: type: string - content: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' - description: Output only. Content parts of the candidate. - index: - type: integer - format: int32 - readOnly: true - description: Output only. Index of the candidate. - safetyRatings: description: >- - Output only. List of ratings for the safety of a response candidate. - There is at most one rating per category. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' - finishReason: - enum: - - FINISH_REASON_UNSPECIFIED - - STOP - - MAX_TOKENS - - SAFETY - - RECITATION - - OTHER - - BLOCKLIST - - PROHIBITED_CONTENT - - SPII + Field to use to sort the TensorboardTimeSeries' data. By default, + TensorboardTimeSeries' data is returned in a pseudo random order. + filter: type: string description: >- - Output only. The reason why the model stopped generating tokens. If - empty, the model has not stopped generating the tokens. - readOnly: true - enumDescriptions: - - The finish reason is unspecified. - - Natural stop point of the model or provided stop sequence. - - >- - The maximum number of tokens as specified in the request was - reached. - - >- - The token generation was stopped as the response was flagged for - safety reasons. NOTE: When streaming the Candidate.content will be - empty if content filters blocked the output. - - >- - The token generation was stopped as the response was flagged for - unauthorized citations. - - All other reasons that stopped the token generation - - >- - The token generation was stopped as the response was flagged for - the terms which are included from the terminology blocklist. - - >- - The token generation was stopped as the response was flagged for - the prohibited contents. - - >- - The token generation was stopped as the response was flagged for - Sensitive Personally Identifiable Information (SPII) contents. - groundingMetadata: + Exports the TensorboardTimeSeries' data that match the filter + expression. + pageSize: + format: int32 + type: integer description: >- - Output only. Metadata specifies sources used to ground generated - content. - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundingMetadata' - GoogleCloudAiplatformV1UndeployIndexOperationMetadata: + The maximum number of data points to return per page. The default + page_size is 1000. Values must be between 1 and 10000. Values above + 10000 are coerced to 10000. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation: + properties: + columnName: + type: string + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation + description: >- + Training pipeline will perform following transformation functions. * The + value converted to float32. * The z_score of the value. * log(value+1) + when the value is greater than or equal to 0. Otherwise, this + transformation is not applied and the value is considered a missing + value. * z_score of log(value+1) when the value is greater than or equal + to 0. Otherwise, this transformation is not applied and the value is + considered a missing value. type: object - id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata - description: Runtime operation information for IndexEndpointService.UndeployIndex. + GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: + description: Details of operations that perform create EntityType. properties: genericMetadata: - description: The operation generic information. + description: Operation metadata for EntityType. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1ExplanationSpec: - type: object - properties: - metadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' - description: >- - Optional. Metadata describing the Model's input and output for - explanation. - parameters: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' - description: >- - Required. Parameters that configure explaining of the Model's - predictions. - id: GoogleCloudAiplatformV1ExplanationSpec - description: Specification of Model explanation. - GoogleCloudAiplatformV1ExplainRequest: - properties: - explanationSpecOverride: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpecOverride' - description: >- - If specified, overrides the explanation_spec of the DeployedModel. - Can be used for explaining prediction results with different - configurations, such as: - Explaining top-5 predictions results as - opposed to top-1; - Increasing path count or step count of the - attribution methods to reduce approximate errors; - Using different - baselines for explaining the prediction results. - parameters: - description: >- - The parameters that govern the prediction. The schema of the - parameters may be specified via Endpoint's DeployedModels' Model's - PredictSchemata's parameters_schema_uri. - type: any - deployedModelId: - type: string - description: >- - If specified, this ExplainRequest will be served by the chosen - DeployedModel, overriding Endpoint.traffic_split. - instances: - description: >- - Required. The instances that are the input to the explanation call. - A DeployedModel may have an upper limit on the number of instances - it supports per request, and when it is exceeded the explanation - call errors in case of AutoML Models, or, in case of customer - created Models, the behaviour is as documented by that Model. The - schema of any single instance may be specified via Endpoint's - DeployedModels' Model's PredictSchemata's instance_schema_uri. - type: array - items: - type: any - description: Request message for PredictionService.Explain. - id: GoogleCloudAiplatformV1ExplainRequest + id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata type: object - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance: + GoogleCloudAiplatformV1PurgeContextsRequest: + description: Request message for MetadataService.PurgeContexts. type: object - description: Prediction input format for Video Action Recognition. - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceVideoActionRecognitionPredictionInstance properties: - content: - type: string - description: >- - The Google Cloud Storage location of the video on which to perform - the prediction. - timeSegmentEnd: + filter: type: string description: >- - The end, exclusive, of the video's time segment on which to perform - the prediction. Expressed as a number of seconds as measured from - the start of the video, with "s" appended at the end. Fractions are - allowed, up to a microsecond precision, and "inf" or "Infinity" is - allowed, which means the end of the video. - timeSegmentStart: - description: >- - The beginning, inclusive, of the video's time segment on which to - perform the prediction. Expressed as a number of seconds as measured - from the start of the video, with "s" appended at the end. Fractions - are allowed, up to a microsecond precision. - type: string - mimeType: - type: string + Required. A required filter matching the Contexts to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + force: + type: boolean description: >- - The MIME type of the content of the video. Only the following are - supported: video/mp4 video/avi video/quicktime - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Context names + that would be deleted. + id: GoogleCloudAiplatformV1PurgeContextsRequest + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams - description: Prediction model parameters for Video Action Recognition. - properties: - confidenceThreshold: - description: >- - The Model only returns predictions with at least this confidence - score. Default value is 0.0 - type: number - format: float - maxPredictions: - description: >- - The model only returns up to that many top, by confidence score, - predictions per frame of the video. If this number is very high, the - Model may return fewer predictions per frame. Default value is 50. - type: integer - format: int32 - GoogleCloudAiplatformV1StudySpecParameterSpec: + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData properties: - conditionalParameterSpecs: - description: >- - A conditional parameter node is active if the parameter's value - matches the conditional node's parent_value_condition. If two items - in conditional_parameter_specs have the same name, they must have - disjoint parent_value_condition. + userUsageData: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData type: array - categoricalValueSpec: - description: The value spec for a 'CATEGORICAL' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec - integerValueSpec: - description: The value spec for an 'INTEGER' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecIntegerValueSpec - doubleValueSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec - description: The value spec for a 'DOUBLE' parameter. - discreteValueSpec: - description: The value spec for a 'DISCRETE' parameter. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec - parameterId: - description: >- - Required. The ID of the parameter. Must not contain whitespaces and - must be unique amongst all ParameterSpecs. - type: string - scaleType: - enum: - - SCALE_TYPE_UNSPECIFIED - - UNIT_LINEAR_SCALE - - UNIT_LOG_SCALE - - UNIT_REVERSE_LOG_SCALE - type: string - description: >- - How the parameter should be scaled. Leave unset for `CATEGORICAL` - parameters. - enumDescriptions: - - By default, no scaling is applied. - - Scales the feasible space to (0, 1) linearly. - - >- - Scales the feasible space logarithmically to (0, 1). The entire - feasible space must be strictly positive. - - >- - Scales the feasible space "reverse" logarithmically to (0, 1). The - result is that values close to the top of the feasible space are - spread out more than points near the bottom. The entire feasible - space must be strictly positive. - type: object - id: GoogleCloudAiplatformV1StudySpecParameterSpec - description: Represents a single parameter to optimize. - GoogleCloudAiplatformV1DeleteOperationMetadata: - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Details of operations that perform deletes of any entities. - id: GoogleCloudAiplatformV1DeleteOperationMetadata + description: Usage data for each user in the given month. + description: Per month usage data + GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse: type: object - GoogleCloudAiplatformV1UpsertDatapointsRequest: + description: Response message for TensorboardService.ReadTensorboardTimeSeriesData. + id: GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse properties: - datapoints: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: A list of datapoints to be created/updated. - type: array - updateMask: - description: >- - Optional. Update mask is used to specify the fields to be - overwritten in the datapoints by the update. The fields specified in - the update_mask are relative to each IndexDatapoint inside - datapoints, not the full request. Updatable fields: * Use - `all_restricts` to update both restricts and numeric_restricts. - format: google-fieldmask - type: string - id: GoogleCloudAiplatformV1UpsertDatapointsRequest - type: object - description: Request message for IndexService.UpsertDatapoints - GoogleCloudAiplatformV1FeatureViewDataKey: - type: object + timeSeriesData: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + description: The returned time series data. + GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse: + description: Response message for ModelService.BatchImportEvaluatedAnnotations properties: - key: - type: string - description: String key to use for lookup. - compositeKey: - description: >- - The actual Entity ID will be composed from this struct. This should - match with the way ID is defined in the FeatureView spec. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey - description: Lookup key for a feature view. - id: GoogleCloudAiplatformV1FeatureViewDataKey - GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata: + importedEvaluatedAnnotationsCount: + type: integer + format: int32 + readOnly: true + description: Output only. Number of EvaluatedAnnotations imported. + id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse type: object + GoogleTypeColor: properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - progressMessage: - type: string + alpha: + format: float + type: number description: >- - A human-readable message that shows the intermediate progress - details of NotebookRuntime. - id: GoogleCloudAiplatformV1UpgradeNotebookRuntimeOperationMetadata - description: Metadata information for NotebookService.UpgradeNotebookRuntime. - GoogleCloudAiplatformV1NotebookRuntime: - id: GoogleCloudAiplatformV1NotebookRuntime + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + green: + description: The amount of green in the color as a value in the interval [0, 1]. + type: number + format: float + red: + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + type: number + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + id: GoogleTypeColor + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + type: object + GoogleCloudAiplatformV1SafetySpec: properties: - runtimeState: + version: + format: int32 + description: Optional. Which version to use for evaluation. + type: integer + id: GoogleCloudAiplatformV1SafetySpec + type: object + description: Spec for safety metric. + GoogleCloudAiplatformV1SafetyResult: + type: object + properties: + score: + format: float readOnly: true - description: Output only. The runtime (instance) state of the NotebookRuntime. - type: string - enumDescriptions: - - Unspecified runtime state. - - NotebookRuntime is in running state. - - NotebookRuntime is in starting state. - - NotebookRuntime is in stopping state. - - NotebookRuntime is in stopped state. - - >- - NotebookRuntime is in upgrading state. It is in the middle of - upgrading process. - - NotebookRuntime was unable to start/stop properly. - - NotebookRuntime is in invalid state. Cannot be recovered. - enum: - - RUNTIME_STATE_UNSPECIFIED - - RUNNING - - BEING_STARTED - - BEING_STOPPED - - STOPPED - - BEING_UPGRADED - - ERROR - - INVALID - proxyUri: - description: Output only. The proxy endpoint used to access the NotebookRuntime. - type: string + type: number + description: Output only. Safety score. + confidence: + type: number + description: Output only. Confidence for safety score. + format: float readOnly: true - notebookRuntimeType: - enumDescriptions: - - >- - Unspecified notebook runtime type, NotebookRuntimeType will - default to USER_DEFINED. - - runtime or template with coustomized configurations from user. - - runtime or template with system defined configurations. + explanation: readOnly: true + description: Output only. Explanation for safety score. type: string - description: Output only. The type of the notebook runtime. - enum: - - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED - - USER_DEFINED - - ONE_CLICK - idleShutdownConfig: - readOnly: true + id: GoogleCloudAiplatformV1SafetyResult + description: Spec for safety result. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation: + properties: + columnName: + type: string + invalidValuesAllowed: + type: boolean description: >- - Output only. The idle shutdown configuration of the notebook - runtime. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig - expirationTime: - format: google-datetime + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + description: >- + Treats the column as numerical array and performs following + transformation functions. * All transformations for Numerical types + applied to the average of the all elements. * The average of empty + arrays is treated as zero. + GoogleCloudAiplatformV1GroundingChunkWeb: + description: Chunk from the web. + type: object + id: GoogleCloudAiplatformV1GroundingChunkWeb + properties: + title: + type: string + description: Title of the chunk. + uri: + description: URI reference of the chunk. + type: string + GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse: + description: Response message for TensorboardService.ReadTensorboardBlobData. + type: object + id: GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + properties: + blobs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' + description: Blob messages containing blob bytes. + type: array + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: + description: Model metadata specific to AutoML Forecasting. + properties: + trainCostMilliNodeHours: description: >- - Output only. Timestamp when this NotebookRuntime will be expired: 1. - System Predefined NotebookRuntime: 24 hours after creation. After - expiration, system predifined runtime will be deleted. 2. User - created NotebookRuntime: 6 months after last upgrade. After - expiration, user created runtime will be stopped and allowed for - upgrade. + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. type: string - readOnly: true - healthState: + format: int64 + evaluatedDataItemsBigqueryUri: type: string - description: Output only. The health state of the NotebookRuntime. - enumDescriptions: - - Unspecified health state. - - NotebookRuntime is in healthy state. Applies to ACTIVE state. - - NotebookRuntime is in unhealthy state. Applies to ACTIVE state. - enum: - - HEALTH_STATE_UNSPECIFIED - - HEALTHY - - UNHEALTHY - readOnly: true - version: + description: BigQuery destination uri for exported evaluated examples. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + type: object + GoogleCloudAiplatformV1FetchFeatureValuesRequest: + id: GoogleCloudAiplatformV1FetchFeatureValuesRequest + type: object + description: >- + Request message for FeatureOnlineStoreService.FetchFeatureValues. All + the features under the requested feature view will be returned. + properties: + dataKey: + description: Optional. The request key to fetch feature values for. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' + dataFormat: type: string - description: Output only. The VM os image version of NotebookRuntime. - readOnly: true - notebookRuntimeTemplateRef: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplateRef description: >- - Output only. The pointer to NotebookRuntimeTemplate this - NotebookRuntime is created from. - isUpgradable: - type: boolean - readOnly: true - description: Output only. Whether NotebookRuntime is upgradable. - encryptionSpec: - readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Optional. Response data format. If not set, + FeatureViewDataFormat.KEY_VALUE will be used. + enumDescriptions: + - Not set. Will be treated as the KeyValue format. + - Return response data in key-value format. + - Return response data in proto Struct format. + enum: + - FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED + - KEY_VALUE + - PROTO_STRUCT + GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata: + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Feature. + description: Details of operations that perform batch create Features. + id: GoogleCloudAiplatformV1BatchCreateFeaturesOperationMetadata + type: object + GoogleCloudAiplatformV1ExplanationMetadataInputMetadata: + properties: + inputBaselines: description: >- - Output only. Customer-managed encryption key spec for the notebook - runtime. - description: - description: The description of the NotebookRuntime. - type: string - displayName: - type: string + Baseline inputs for this feature. If no baseline is specified, + Vertex AI chooses the baseline for this feature. If multiple + baselines are specified, Vertex AI returns the average attributions + across them in Attribution.feature_attributions. For Vertex + AI-provided Tensorflow images (both 1.x and 2.x), the shape of each + baseline must match the shape of the input tensor. If a scalar is + provided, we broadcast to the same shape as the input tensor. For + custom images, the element of the baselines must be in the same + format as the feature's input in the instance[]. The schema of any + single instance may be specified via Endpoint's DeployedModels' + Model's PredictSchemata's instance_schema_uri. + items: + type: any + type: array + visualization: + description: Visualization configurations for image explanation. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + denseShapeTensorName: description: >- - Required. The display name of the NotebookRuntime. The name can be - up to 128 characters long and can consist of any UTF-8 characters. - updateTime: + Specifies the shape of the values of the input if the input is a + sparse representation. Refer to Tensorflow documentation for more + details: + https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. type: string - description: >- - Output only. Timestamp when this NotebookRuntime was most recently - updated. - format: google-datetime - readOnly: true - createTime: + encoding: + enum: + - ENCODING_UNSPECIFIED + - IDENTITY + - BAG_OF_FEATURES + - BAG_OF_FEATURES_SPARSE + - INDICATOR + - COMBINED_EMBEDDING + - CONCAT_EMBEDDING type: string - readOnly: true - format: google-datetime - description: Output only. Timestamp when this NotebookRuntime was created. - networkTags: description: >- - Optional. The Compute Engine tags to add to runtime (see [Tagging - instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). + Defines how the feature is encoded into the input tensor. Defaults + to IDENTITY. + enumDescriptions: + - Default value. This is the same as IDENTITY. + - The tensor represents one feature. + - >- + The tensor represents a bag of features where each index maps to a + feature. InputMetadata.index_feature_mapping must be provided for + this encoding. For example: ``` input = [27, 6.0, 150] + index_feature_mapping = ["age", "height", "weight"] ``` + - >- + The tensor represents a bag of features where each index maps to a + feature. Zero values in the tensor indicates feature being + non-existent. InputMetadata.index_feature_mapping must be provided + for this encoding. For example: ``` input = [2, 0, 5, 0, 1] + index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + - >- + The tensor is a list of binaries representing whether a feature + exists or not (1 indicates existence). + InputMetadata.index_feature_mapping must be provided for this + encoding. For example: ``` input = [1, 0, 1, 0, 1] + index_feature_mapping = ["a", "b", "c", "d", "e"] ``` + - >- + The tensor is encoded into a 1-dimensional array represented by an + encoded tensor. InputMetadata.encoded_tensor_name must be provided + for this encoding. For example: ``` input = ["This", "is", "a", + "test", "."] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ``` + - >- + Select this encoding when the input tensor is encoded into a + 2-dimensional array represented by an encoded tensor. + InputMetadata.encoded_tensor_name must be provided for this + encoding. The first dimension of the encoded tensor's shape is the + same as the input tensor's shape. For example: ``` input = + ["This", "is", "a", "test", "."] encoded = [[0.1, 0.2, 0.3, 0.4, + 0.5], [0.2, 0.1, 0.4, 0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, + 0.3, 0.1, 0.2, 0.4], [0.4, 0.3, 0.2, 0.5, 0.1]] ``` + indexFeatureMapping: type: array + description: >- + A list of feature names for each index in the input tensor. Required + when the input InputMetadata.encoding is BAG_OF_FEATURES, + BAG_OF_FEATURES_SPARSE, INDICATOR. items: type: string - name: - description: Output only. The resource name of the NotebookRuntime. - readOnly: true + modality: + description: >- + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + type: string + indicesTensorName: type: string - serviceAccount: description: >- - Output only. The service account that the NotebookRuntime workload - runs as. - readOnly: true + Specifies the index of the values of the input tensor. Required when + the input tensor is a sparse representation. Refer to Tensorflow + documentation for more details: + https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor. + groupName: type: string - runtimeUser: + description: >- + Name of the group that the input belongs to. Features with the same + group name will be treated as one feature when computing + attributions. Features grouped together can have different shapes in + value. If provided, there will be one single attribution generated + in Attribution.feature_attributions, keyed by the group name. + inputTensorName: + description: >- + Name of the input tensor for this feature. Required and is only + applicable to Vertex AI-provided images for Tensorflow. + type: string + encodedTensorName: type: string - description: Required. The user email of the NotebookRuntime. - satisfiesPzi: - readOnly: true - description: Output only. Reserved for future use. - type: boolean - labels: - type: object - additionalProperties: - type: string description: >- - The labels with user-defined metadata to organize your - NotebookRuntime. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. No more than 64 user labels can be associated with one - NotebookRuntime (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. Following system - labels exist for NotebookRuntime: * - "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output - only, its value is the Compute Engine instance id. * - "aiplatform.googleapis.com/colab_enterprise_entry_service": its - value is either "bigquery" or "vertex"; if absent, it should be - "vertex". This is to describe the entry service, either BigQuery or - Vertex. - satisfiesPzs: - type: boolean - readOnly: true - description: Output only. Reserved for future use. + Encoded tensor is a transformation of the input tensor. Must be + provided if choosing Integrated Gradients attribution or XRAI + attribution and the input tensor is not differentiable. An encoded + tensor is generated if the input tensor is encoded by a lookup + table. + featureValueDomain: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + description: >- + The domain details of the input feature value. Like min/max, + original mean or standard deviation if normalized. + encodedBaselines: + items: + type: any + type: array + description: >- + A list of baselines for the encoded tensor. The shape of each + baseline should match the shape of the encoded tensor. If a scalar + is provided, Vertex AI broadcasts to the same shape as the encoded + tensor. type: object description: >- - A runtime is a virtual machine allocated to a particular user for a - particular Notebook file on temporary basis with lifetime limited to 24 - hours. - GoogleCloudAiplatformV1LookupStudyRequest: - description: Request message for VizierService.LookupStudy. + Metadata of the input of a feature. Fields other than + InputMetadata.input_baselines are applicable only for Models that are + using Vertex AI-provided images for Tensorflow. + id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadata + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics: type: object + description: >- + UNIMPLEMENTED. Track matching model metrics for a single track match + threshold and multiple label match confidence thresholds. + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics properties: - displayName: - description: Required. The user-defined display name of the Study - type: string - id: GoogleCloudAiplatformV1LookupStudyRequest - GoogleCloudAiplatformV1ListTuningJobsResponse: - description: Response message for GenAiTuningService.ListTuningJobs - properties: - nextPageToken: - type: string + meanBoundingBoxIou: + format: float + description: The mean bounding box iou over all confidence thresholds. + type: number + confidenceMetrics: description: >- - A token to retrieve the next page of results. Pass to - ListTuningJobsRequest.page_token to obtain that page. - tuningJobs: - description: List of TuningJobs in the requested page. + Metrics for each label-match `confidenceThreshold` from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' - type: object - id: GoogleCloudAiplatformV1ListTuningJobsResponse - GoogleCloudAiplatformV1DistillationDataStats: - description: Statistics computed for datasets used for distillation. - id: GoogleCloudAiplatformV1DistillationDataStats - type: object - properties: - trainingDatasetStats: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetStats' - readOnly: true - description: Output only. Statistics computed for the training dataset. - GoogleCloudAiplatformV1FindNeighborsResponseNeighbor: - type: object - id: GoogleCloudAiplatformV1FindNeighborsResponseNeighbor - description: A neighbor of the query vector. - properties: - distance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics + meanTrackingAveragePrecision: type: number - format: double - description: The distance between the neighbor and the dense embedding query. - sparseDistance: - description: The distance between the neighbor and the query sparse_embedding. - format: double + format: float + description: The mean average precision over all confidence thresholds. + iouThreshold: type: number - datapoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + format: float description: >- - The datapoint of the neighbor. Note that full datapoints are - returned only when "return_full_datapoint" is set to true. - Otherwise, only the "datapoint_id" and "crowding_tag" fields are - populated. - GoogleCloudAiplatformV1DeployedIndex: + The intersection-over-union threshold value between bounding boxes + across frames used to compute this metric entry. + meanMismatchRate: + type: number + description: The mean mismatch rate over all confidence thresholds. + format: float + GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact: + type: object + description: The type of an input artifact. properties: - reservedIpRanges: - type: array - items: - type: string + artifactId: + type: string description: >- - Optional. A list of reserved ip ranges under the VPC network that - can be used for this DeployedIndex. If set, we will deploy the index - within the provided ip ranges. Otherwise, the index might be - deployed to any ip ranges under the provided VPC network. The value - should be the name of the address - (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) - Example: ['vertex-ai-ip-range']. For more information about subnets - and network IP ranges, please see - https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' - description: >- - Optional. A description of resources that are dedicated to the - DeployedIndex, and that need a higher degree of manual - configuration. The field min_replica_count must be set to a value - strictly greater than 0, or else validation will fail. We don't - provide SLA when min_replica_count=1. If max_replica_count is not - set, the default value is min_replica_count. The max allowed replica - count is 1000. Available machine types for SMALL shard: - e2-standard-2 and all machine types available for MEDIUM and LARGE - shard. Available machine types for MEDIUM shard: e2-standard-16 and - all machine types available for LARGE shard. Available machine types - for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and - n1-standard-32 are still available, but we recommend e2-standard-16 - and e2-highmem-16 for cost efficiency. - indexSyncTime: - readOnly: true - format: google-datetime - description: >- - Output only. The DeployedIndex may depend on various data on its - original Index. Additionally when certain changes to the original - Index are being done (e.g. when what the Index contains is being - changed) the DeployedIndex may be asynchronously updated in the - background to reflect these changes. If this timestamp's value is at - least the Index.update_time of the original Index, it means that - this DeployedIndex and the original Index are in sync. If this - timestamp is older, then to see which updates this DeployedIndex - already contains (and which it does not), one must list the - operations that are running on the original Index. Only the - successfully completed Operations with update_time equal or before - this sync time are contained in this DeployedIndex. - type: string - id: + Artifact resource id from MLMD. Which is the last portion of an + artifact resource name: + `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. + The artifact must stay within the same project, location and default + metadatastore as the pipeline. + id: GoogleCloudAiplatformV1PipelineJobRuntimeConfigInputArtifact + GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse: + description: >- + Response message for + TensorboardService.BatchReadTensorboardTimeSeriesData. + type: object + properties: + timeSeriesData: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesData' + type: array + description: The returned time series data. + id: GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + GoogleCloudAiplatformV1SchemaImageClassificationAnnotation: + id: GoogleCloudAiplatformV1SchemaImageClassificationAnnotation + description: Annotation details specific to image classification. + type: object + properties: + annotationSpecId: type: string description: >- - Required. The user specified ID of the DeployedIndex. The ID can be - up to 128 characters long and must start with a letter and only - contain letters, numbers, and underscores. The ID must be unique - within the project it is created in. + The resource Id of the AnnotationSpec that this Annotation pertains + to. displayName: - type: string description: >- - The display name of the DeployedIndex. If not provided upon - creation, the Index's display_name is used. - createTime: - description: Output only. Timestamp when the DeployedIndex was created. + The display name of the AnnotationSpec that this Annotation pertains + to. type: string - format: google-datetime - readOnly: true - enableAccessLogging: - type: boolean + GoogleCloudAiplatformV1PredictRequest: + description: Request message for PredictionService.Predict. + type: object + properties: + parameters: + type: any description: >- - Optional. If true, private endpoint's access logs are sent to Cloud - Logging. These logs are like standard server access logs, containing - information like timestamp and latency for each MatchRequest. Note - that logs may incur a cost, especially if the deployed index - receives a high queries per second rate (QPS). Estimate your costs - before enabling this option. - automaticResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + The parameters that govern the prediction. The schema of the + parameters may be specified via Endpoint's DeployedModels' Model's + PredictSchemata's parameters_schema_uri. + instances: + type: array + items: + type: any description: >- - Optional. A description of resources that the DeployedIndex uses, - which to large degree are decided by Vertex AI, and optionally - allows only a modest additional configuration. If min_replica_count - is not set, the default value is 2 (we don't provide SLA when - min_replica_count=1). If max_replica_count is not set, the default - value is min_replica_count. The max allowed replica count is 1000. - privateEndpoints: + Required. The instances that are the input to the prediction call. A + DeployedModel may have an upper limit on the number of instances it + supports per request, and when it is exceeded the prediction call + errors in case of AutoML Models, or, in case of customer created + Models, the behaviour is as documented by that Model. The schema of + any single instance may be specified via Endpoint's DeployedModels' + Model's PredictSchemata's instance_schema_uri. + id: GoogleCloudAiplatformV1PredictRequest + GoogleCloudAiplatformV1Int64Array: + id: GoogleCloudAiplatformV1Int64Array + type: object + properties: + values: + items: + type: string + format: int64 + description: A list of int64 values. + type: array + description: A list of int64 values. + GoogleCloudAiplatformV1VideoMetadata: + properties: + endOffset: + description: Optional. The end offset of the video. + format: google-duration + type: string + startOffset: + format: google-duration + description: Optional. The start offset of the video. + type: string + type: object + id: GoogleCloudAiplatformV1VideoMetadata + description: Metadata describes the input video content. + GoogleCloudAiplatformV1PublisherModel: + id: GoogleCloudAiplatformV1PublisherModel + properties: + versionId: + type: string description: >- - Output only. Provides paths for users to send requests directly to - the deployed index services running on Cloud via private services - access. This field is populated if network is configured. - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' + Output only. Immutable. The version ID of the PublisherModel. A new + version is committed when a new model version is uploaded under an + existing model id. It is an auto-incrementing decimal number in + string representation. readOnly: true - deployedIndexAuthConfig: + supportedActions: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction + description: Optional. Supported call-to-action options. + predictSchemata: description: >- - Optional. If set, the authentication is enabled for the private - endpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' - deploymentGroup: + Optional. The schemata that describes formats of the + PublisherModel's predictions and explanations as given and returned + via PredictionService.Predict. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + frameworks: + description: Optional. Additional information about the model's Frameworks. + items: + type: string + type: array + openSourceCategory: + description: Required. Indicates the open source category of the publisher model. + enumDescriptions: + - The open source category is unspecified, which should not be used. + - Used to indicate the PublisherModel is not open sourced. + - >- + Used to indicate the PublisherModel is a Google-owned open source + model w/ Google checkpoint. + - >- + Used to indicate the PublisherModel is a 3p-owned open source + model w/ Google checkpoint. + - >- + Used to indicate the PublisherModel is a Google-owned pure open + source model. + - >- + Used to indicate the PublisherModel is a 3p-owned pure open source + model. + enum: + - OPEN_SOURCE_CATEGORY_UNSPECIFIED + - PROPRIETARY + - GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT + - THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT + - GOOGLE_OWNED_OSS + - THIRD_PARTY_OWNED_OSS type: string - description: >- - Optional. The deployment group can be no longer than 64 characters - (eg: 'test', 'prod'). If not set, we will use the 'default' - deployment group. Creating `deployment_groups` with - `reserved_ip_ranges` is a recommended practice when the peered - network has multiple peering ranges. This creates your deployments - from predictable IP spaces for easier traffic administration. Also, - one deployment_group (except 'default') can only be used with the - same reserved_ip_ranges which means if the deployment_group has been - used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, - e] is disallowed. Note: we only support up to 5 deployment - groups(not including 'default'). - index: + publisherModelTemplate: type: string + readOnly: true description: >- - Required. The name of the Index this is the deployment of. We may - refer to this Index as the DeployedIndex's "original" Index. - description: >- - A deployment of an Index. IndexEndpoints contain one or more - DeployedIndexes. + Optional. Output only. Immutable. Used to indicate this model has a + publisher model and provide the template of the publisher model + resource name. + versionState: + enum: + - VERSION_STATE_UNSPECIFIED + - VERSION_STATE_STABLE + - VERSION_STATE_UNSTABLE + type: string + description: Optional. Indicates the state of the model version. + enumDescriptions: + - The version state is unspecified. + - Used to indicate the version is stable. + - Used to indicate the version is unstable. + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - EXPERIMENTAL + - PRIVATE_PREVIEW + - PUBLIC_PREVIEW + - GA + type: string + enumDescriptions: + - The model launch stage is unspecified. + - >- + Used to indicate the PublisherModel is at Experimental launch + stage, available to a small set of customers. + - >- + Used to indicate the PublisherModel is at Private Preview launch + stage, only available to a small set of customers, although a + larger set of customers than an Experimental launch. Previews are + the first launch stage used to get feedback from customers. + - >- + Used to indicate the PublisherModel is at Public Preview launch + stage, available to all customers, although not supported for + production workloads. + - >- + Used to indicate the PublisherModel is at GA launch stage, + available to all customers and ready for production workload. + description: Optional. Indicates the launch stage of the model. + name: + type: string + readOnly: true + description: Output only. The resource name of the PublisherModel. + description: A Model Garden Publisher Model. type: object - id: GoogleCloudAiplatformV1DeployedIndex - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis: + GoogleCloudAiplatformV1ExportDataConfig: properties: - disabled: - type: boolean + filterSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFilterSplit' + description: Split based on the provided filters for each set. + gcsDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' description: >- - The monitoring schedule for snapshot analysis. For EntityType-level - config: unset / disabled = true indicates disabled by default for - Features under it; otherwise by default enable snapshot analysis - monitoring with monitoring_interval for Features under it. - Feature-level config: disabled = true indicates disabled regardless - of the EntityType-level config; unset monitoring_interval indicates - going with EntityType-level config; otherwise run snapshot analysis - monitoring with monitoring_interval regardless of the - EntityType-level config. Explicitly Disable the snapshot analysis - based monitoring. - monitoringIntervalDays: + The Google Cloud Storage location where the output is to be written + to. In the given directory a new directory will be created with + name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ + ISO-8601 format. All export output will be written into that + directory. Inside that directory, annotations with the same schema + will be grouped into sub directories which are named with the + corresponding annotations' schema title. Inside these sub + directories, a schema.yaml will be created to describe the output + format. + savedQueryId: description: >- - Configuration of the snapshot analysis based monitoring pipeline - running interval. The value indicates number of days. - format: int32 - type: integer - stalenessDays: - type: integer + The ID of a SavedQuery (annotation set) under the Dataset specified + by dataset_id used for filtering Annotations for training. Only used + for custom training data export use cases. Only applicable to + Datasets that have SavedQueries. Only Annotations that are + associated with this SavedQuery are used in respectively training. + When used in conjunction with annotations_filter, the Annotations + used for training are filtered by both saved_query_id and + annotations_filter. Only one of saved_query_id and + annotation_schema_uri should be specified as both of them represent + the same thing: problem type. + type: string + exportUse: + type: string + description: Indicates the usage of the exported files. + enum: + - EXPORT_USE_UNSPECIFIED + - CUSTOM_CODE_TRAINING + enumDescriptions: + - Regular user export. + - Export for custom code training. + annotationSchemaUri: description: >- - Customized export features time window for snapshot analysis. Unit - is one day. Default value is 3 weeks. Minimum value is 1 day. - Maximum value is 4000 days. - format: int32 + The Cloud Storage URI that points to a YAML file describing the + annotation schema. The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + The schema files that can be used here are found in + gs://google-cloud-aiplatform/schema/dataset/annotation/, note that + the chosen schema must be consistent with metadata of the Dataset + specified by dataset_id. Only used for custom training data export + use cases. Only applicable to Datasets that have DataItems and + Annotations. Only Annotations that both match this schema and belong + to DataItems not ignored by the split method are used in + respectively training, validation or test role, depending on the + role of the DataItem they are on. When used in conjunction with + annotations_filter, the Annotations used for training are filtered + by both annotations_filter and annotation_schema_uri. + type: string + annotationsFilter: + type: string + description: >- + An expression for filtering what part of the Dataset is to be + exported. Only Annotations that match this filter will be exported. + The filter syntax is the same as in ListAnnotations. + fractionSplit: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportFractionSplit' + description: Split based on fractions defining the size of each set. description: >- - Configuration of the Featurestore's Snapshot Analysis Based Monitoring. - This type of analysis generates statistics for each Feature based on a - snapshot of the latest feature value of each entities every - monitoring_interval. - id: GoogleCloudAiplatformV1FeaturestoreMonitoringConfigSnapshotAnalysis - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables: - properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputs - description: The input parameters of this TrainingJob. - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesMetadata - description: The metadata information. - description: A TrainingJob that trains and uploads an AutoML Tables Model. + Describes what part of the Dataset is to be exported, the destination of + the export and how to export. type: object - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTables - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics: + id: GoogleCloudAiplatformV1ExportDataConfig + GoogleCloudAiplatformV1ListPipelineJobsResponse: properties: - meanAveragePrecision: - description: The mean average precision. - format: float - type: number - precisionWindowLength: - format: google-duration - description: >- - This VideoActionMetrics is calculated based on this prediction - window length. If the predicted action's timestamp is inside the - time window whose center is the ground truth action's timestamp with - this specific length, the prediction result is treated as a true - positive. + nextPageToken: type: string - confidenceMetrics: - type: array description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + A token to retrieve the next page of results. Pass to + ListPipelineJobsRequest.page_token to obtain that page. + pipelineJobs: + description: List of PipelineJobs in the requested page. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics - description: The Evaluation metrics given a specific precision_window_length. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + type: array + description: Response message for PipelineService.ListPipelineJobs + id: GoogleCloudAiplatformV1ListPipelineJobsResponse type: object - id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoActionMetrics - GoogleCloudAiplatformV1SearchMigratableResourcesRequest: + GoogleCloudAiplatformV1DeploymentResourcePool: type: object + description: >- + A description of resources that can be shared by multiple + DeployedModels, whose underlying specification consists of a + DedicatedResources. + id: GoogleCloudAiplatformV1DeploymentResourcePool properties: - filter: + serviceAccount: type: string description: >- - A filter for your search. You can use the following types of - filters: * Resource type filters. The following strings filter for a - specific type of MigratableResource: * `ml_engine_model_version:*` * - `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * - "Migrated or not" filters. The following strings filter for - resources that either have or have not already been migrated: * - `last_migrate_time:*` filters for migrated resources. * `NOT - last_migrate_time:*` filters for not yet migrated resources. - pageSize: - description: The standard page size. The default and maximum value is 100. - format: int32 - type: integer - pageToken: + The service account that the DeploymentResourcePool's container(s) + run as. Specify the email address of the service account. If this + service account is not specified, the container(s) run as a service + account that doesn't have access to the resource project. Users + deploying the Models to this DeploymentResourcePool must have the + `iam.serviceAccounts.actAs` permission on this service account. + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + description: >- + Required. The underlying DedicatedResources that the + DeploymentResourcePool uses. + disableContainerLogging: + description: >- + If the DeploymentResourcePool is deployed with custom-trained Models + or AutoML Tabular Models, the container(s) of the + DeploymentResourcePool will send `stderr` and `stdout` streams to + Cloud Logging by default. Please note that the logs incur cost, + which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging/pricing). User can disable + container logging by setting this flag to true. + type: boolean + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key spec for a DeploymentResourcePool. + If set, this DeploymentResourcePool will be secured by this key. + Endpoints and the DeploymentResourcePool they deploy in need to have + the same EncryptionSpec. + createTime: + readOnly: true + format: google-datetime + type: string + description: Output only. Timestamp when this DeploymentResourcePool was created. + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + name: type: string - description: The standard page token. - id: GoogleCloudAiplatformV1SearchMigratableResourcesRequest - description: Request message for MigrationService.SearchMigratableResources. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: - properties: - quantile: - description: The quantile for this entry. - type: number - format: double - scaledPinballLoss: - description: The scaled pinball loss of this quantile. - type: number - format: float - observedQuantile: - type: number description: >- - This is a custom metric that calculates the percentage of true - values that were less than the predicted value for that quantile. - Only populated when optimization_objective is minimize-quantile-loss - and each entry corresponds to an entry in quantiles The percent - value can be used to compare with the quantile value, which is the - target value. - format: double - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry - type: object - description: Entry for the Quantiles loss type optimization objective. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation: + Immutable. The resource name of the DeploymentResourcePool. Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + GoogleCloudAiplatformV1DeployedIndexAuthConfig: properties: - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - timestamp: + authProvider: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation + #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider + description: Defines the authentication provider that the DeployedIndex uses. + id: GoogleCloudAiplatformV1DeployedIndexAuthConfig + description: Used to set up the auth on the DeployedIndex's private endpoint. type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation - GoogleCloudAiplatformV1SampleConfig: - id: GoogleCloudAiplatformV1SampleConfig + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance: type: object - description: >- - Active learning data sampling config. For every active learning labeling - iteration, it will select a batch of data based on the sampling - strategy. + description: Prediction input format for Text Extraction. properties: - sampleStrategy: - enumDescriptions: - - Default will be treated as UNCERTAINTY. - - Sample the most uncertain data to label. + mimeType: type: string - enum: - - SAMPLE_STRATEGY_UNSPECIFIED - - UNCERTAINTY description: >- - Field to choose sampling strategy. Sampling strategy will decide - which data should be selected for human labeling in every batch. - followingBatchSamplePercentage: + The MIME type of the text snippet. The supported MIME types are + listed below. - text/plain + key: description: >- - The percentage of data needed to be labeled in each following batch - (except the first batch). - type: integer - format: int32 - initialBatchSamplePercentage: - format: int32 - description: The percentage of data needed to be labeled in the first batch. - type: integer - GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: + This field is only used for batch prediction. If a key is provided, + the batch prediction result will by mapped to this key. If omitted, + then the batch prediction result will contain the entire input + instance. Vertex AI will not check if keys in the request are + duplicates, so it is up to the caller to ensure the keys are unique. + type: string + content: + type: string + description: The text snippet to make the predictions on. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceTextExtractionPredictionInstance + GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: + type: object properties: - publicArtifactUri: + artifactOutputUri: + readOnly: true type: string description: >- - Optional. The signed URI for ephemeral Cloud Storage access to model - artifact. - title: - type: string - description: Required. The title of the regional resource reference. - largeModelReference: + Output only. If the Model artifact is being exported to Google Cloud + Storage this is the full path of the directory created, into which + the Model files are being written to. + imageOutputUri: description: >- - Optional. Large model reference. When this is set, - model_artifact_spec is not needed. - $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' - artifactUri: + Output only. If the Model image is being exported to Google + Container Registry or Artifact Registry this is the full path of the + image created. type: string + readOnly: true + id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo + description: >- + Further describes the output of the ExportModel. Supplements + ExportModelRequest.OutputConfig. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + type: object + properties: {} + CloudAiLargeModelsVisionGenerateVideoResponse: + id: CloudAiLargeModelsVisionGenerateVideoResponse + description: Generate video response. + type: object + properties: + raiMediaFilteredCount: + format: int32 + description: Returns if any videos were filtered due to RAI policies. + type: integer + generatedSamples: + items: + $ref: '#/components/schemas/CloudAiLargeModelsVisionMedia' + description: The generates samples. + type: array + raiMediaFilteredReasons: + description: Returns rai failure reasons if any. + items: + type: string + type: array + GoogleCloudAiplatformV1ImportFeatureValuesRequest: + type: object + description: Request message for FeaturestoreService.ImportFeatureValues. + properties: + bigquerySource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + disableOnlineServing: + type: boolean description: >- - Optional. The path to the directory containing the Model artifact - and any of its supporting files. - automaticResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - description: >- - A description of resources that to large degree are decided by - Vertex AI, and require only a modest additional configuration. - containerSpec: + If set, data will not be imported for online serving. This is + typically used for backfilling, where Feature generation timestamps + are not in the timestamp range needed for online serving. + featureTimeField: + type: string description: >- - Optional. The specification of the container that is to be used when - deploying this Model in Vertex AI. Not present for Large Models. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' - modelDisplayName: - description: Optional. Default model display name. + Source column that holds the Feature timestamp for all Feature + values in each entity. + entityIdField: type: string - deployTaskName: + description: >- + Source column that holds entity IDs. If not provided, entity IDs are + extracted from the column named entity_id. + disableIngestionAnalysis: + description: If true, API doesn't start ingestion analysis pipeline. + type: boolean + featureTime: + format: google-datetime type: string description: >- - Optional. The name of the deploy task (e.g., "text to image - generation"). - dedicatedResources: + Single Feature timestamp for all entities being imported. The + timestamp must not have higher than millisecond precision. + workerCount: + format: int32 description: >- - A description of resources that are dedicated to the DeployedModel, - and that need a higher degree of manual configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' - sharedResources: - type: string + Specifies the number of workers that are used to write data to the + Featurestore. Consider the online serving capacity that you require + to achieve the desired import throughput without interfering with + online serving. The value must be positive, and less than or equal + to 100. If not set, defaults to using 1 worker. The low count + ensures minimal impact on online serving performance. + type: integer + csvSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' + avroSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AvroSource' + featureSpecs: description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + Required. Specifications defining which Feature values to import + from the entity. The request fails if no feature_specs are provided, + and having multiple feature_specs for one Feature is not allowed. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec + type: array + id: GoogleCloudAiplatformV1ImportFeatureValuesRequest + GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata: + id: GoogleCloudAiplatformV1UpdateExplanationDatasetOperationMetadata + description: Runtime operation information for ModelService.UpdateExplanationDataset. type: object - description: >- - Model metadata that is needed for UploadModel or - DeployModel/CreateEndpoint requests. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition: properties: - inputs: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs - description: The input parameters of this TrainingJob. - type: object + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation: id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition - description: >- - A TrainingJob that trains and uploads an AutoML Video Action Recognition - Model. - GoogleCloudAiplatformV1Part: - description: >- - A datatype containing media that is part of a multi-part `Content` - message. A `Part` consists of data which has an associated datatype. A - `Part` can only contain one of the accepted types in `Part.data`. A - `Part` must have a fixed IANA MIME type identifying the type and subtype - of the media if `inline_data` or `file_data` field is filled with raw - bytes. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation type: object properties: - functionCall: - description: >- - Optional. A predicted [FunctionCall] returned from the model that - contains a string representing the [FunctionDeclaration.name] with - the parameters and their values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCall' - fileData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FileData' - description: Optional. URI based data. - videoMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1VideoMetadata' - description: >- - Optional. Video metadata. The metadata should only be specified - while the video data is presented in inline_data or file_data. + repeatedCategorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation + repeatedNumeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation + repeatedText: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation + GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: + description: >- + Runtime operation information for + IndexEndpointService.MutateDeployedIndex. + id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata + properties: + deployedIndexId: + description: The unique index id specified by user type: string - description: Optional. Text part (can be code). - functionResponse: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionResponse' - description: >- - Optional. The result output of a [FunctionCall] that contains a - string representing the [FunctionDeclaration.name] and a structured - JSON object containing any output from the function call. It is used - as context to the model. - inlineData: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Blob' - description: Optional. Inlined bytes data. - id: GoogleCloudAiplatformV1Part - GoogleCloudAiplatformV1RemoveContextChildrenResponse: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. type: object - id: GoogleCloudAiplatformV1RemoveContextChildrenResponse - description: Response message for MetadataService.RemoveContextChildren. + GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse: + description: Response message for TensorboardService.WriteTensorboardExperimentData. properties: {} - GoogleCloudAiplatformV1ExportFractionSplit: + type: object + id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec: + type: object + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec properties: - validationFraction: - type: number - format: double + maxParallelTrialCount: + type: integer + format: int32 + description: Required. The maximum number of trials to run in parallel. + maxTrialCount: + format: int32 description: >- - The fraction of the input data that is to be used to validate the - Model. - trainingFraction: - format: double + Required. The maximum number of Neural Architecture Search (NAS) + trials to run. + type: integer + maxFailedTrialCount: + format: int32 + type: integer description: >- - The fraction of the input data that is to be used to train the - Model. - type: number - testFraction: + The number of failed trials that need to be seen before failing the + NasJob. If set to 0, Vertex AI decides how many trials must fail + before the whole job fails. + searchTrialJobSpec: description: >- - The fraction of the input data that is to be used to evaluate the - Model. - format: double - type: number - id: GoogleCloudAiplatformV1ExportFractionSplit + Required. The spec of a search trial job. The same spec applies to + all search trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: Represent spec for search trials. + GoogleCloudAiplatformV1TFRecordDestination: type: object - description: >- - Assigns the input data to training, validation, and test sets as per the - given fractions. Any of `training_fraction`, `validation_fraction` and - `test_fraction` may optionally be provided, they must sum to up to 1. If - the provided ones sum to less than 1, the remainder is assigned to sets - as decided by Vertex AI. If none of the fractions are set, by default - roughly 80% of data is used for training, 10% for validation, and 10% - for test. - GoogleCloudAiplatformV1DatasetDistribution: + id: GoogleCloudAiplatformV1TFRecordDestination + description: The storage details for TFRecord output content. + properties: + gcsDestination: + description: Required. Google Cloud Storage location. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + GoogleCloudAiplatformV1PythonPackageSpec: type: object - description: Distribution computed over a tuning dataset. - id: GoogleCloudAiplatformV1DatasetDistribution properties: - p5: - description: Output only. The 5th percentile of the values in the population. - type: number - format: double - readOnly: true - median: - readOnly: true - description: Output only. The median of the values in the population. - format: double - type: number - min: - description: Output only. The minimum of the population values. - readOnly: true - type: number - format: double - sum: - type: number - description: Output only. Sum of a given population of values. - format: double - readOnly: true - mean: - format: double - type: number - readOnly: true - description: Output only. The arithmetic mean of the values in the population. - buckets: - readOnly: true + args: items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DatasetDistributionDistributionBucket - description: Output only. Defines the histogram bucket. + type: string type: array - max: - description: Output only. The maximum of the population values. - format: double - readOnly: true - type: number - p95: - format: double - readOnly: true - description: Output only. The 95th percentile of the values in the population. - type: number - GoogleCloudAiplatformV1FilterSplit: - description: >- - Assigns input data to training, validation, and test sets based on the - given filters, data pieces not matched by any filter are ignored. - Currently only supported for Datasets containing DataItems. If any of - the filters in this message are to match nothing, then they can be set - as '-' (the minus sign). Supported only for unstructured Datasets. - id: GoogleCloudAiplatformV1FilterSplit - properties: - validationFilter: + description: Command line arguments to be passed to the Python task. + pythonModule: type: string description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to validate the Model. A filter with same - syntax as the one used in DatasetService.ListDataItems may be used. - If a single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - trainingFilter: + Required. The Python module name to run after installing the + packages. + env: description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to train the Model. A filter with same syntax - as the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - type: string - testFilter: + Environment variables to be passed to the python module. Maximum + limit is 100. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EnvVar' + type: array + executorImageUri: type: string description: >- - Required. A filter on DataItems of the Dataset. DataItems that match - this filter are used to test the Model. A filter with same syntax as - the one used in DatasetService.ListDataItems may be used. If a - single DataItem is matched by more than one of the FilterSplit - filters, then it is assigned to the first set that applies to it in - the training, validation, test order. - type: object - GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec: - id: GoogleCloudAiplatformV1StudySpecParameterSpecCategoricalValueSpec - description: Value specification for a parameter in `CATEGORICAL` type. - properties: - values: + Required. The URI of a container image in Artifact Registry that + will run the provided Python package. Vertex AI provides a wide + range of executor images with pre-installed packages to meet users' + various use cases. See the list of [pre-built containers for + training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). + You must use an image from this list. + packageUris: + description: >- + Required. The Google Cloud Storage location of the Python package + files which are the training program and its dependent packages. The + maximum number of package URIs is 100. type: array items: type: string - description: Required. The list of possible categories. - defaultValue: + description: The spec of a Python packaged code. + id: GoogleCloudAiplatformV1PythonPackageSpec + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata: + description: The metadata of Datasets that contain time series data. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadata + properties: + timeSeriesIdentifierColumn: type: string description: >- - A default value for a `CATEGORICAL` parameter that is assumed to be - a relatively good starting point. Unset value signals that there is - no offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - type: object - GoogleCloudAiplatformV1DeployIndexRequest: - properties: - deployedIndex: - description: Required. The DeployedIndex to be created within the IndexEndpoint. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' - type: object - id: GoogleCloudAiplatformV1DeployIndexRequest - description: Request message for IndexEndpointService.DeployIndex. - GoogleCloudAiplatformV1RawPredictRequest: - properties: - httpBody: - $ref: '#/components/schemas/GoogleApiHttpBody' + The column name of the time series identifier column that identifies + the time series. + timeColumn: description: >- - The prediction input. Supports HTTP headers and arbitrary data - payload. A DeployedModel may have an upper limit on the number of - instances it supports per request. When this limit it is exceeded - for an AutoML model, the RawPredict method returns an error. When - this limit is exceeded for a custom-trained model, the behavior - varies depending on the model. You can specify the schema for each - instance in the predict_schemata.instance_schema_uri field when you - create a Model. This schema applies when you deploy the `Model` as a - `DeployedModel` to an Endpoint and use the `RawPredict` method. - id: GoogleCloudAiplatformV1RawPredictRequest + The column name of the time column that identifies time order in the + time series. + type: string + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig type: object - description: Request message for PredictionService.RawPredict. - GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse: - description: Response message for NotebookService.ListNotebookRuntimeTemplates. + GoogleCloudAiplatformV1ToolCallValidResults: + description: Results for tool call valid metric. + id: GoogleCloudAiplatformV1ToolCallValidResults properties: - notebookRuntimeTemplates: + toolCallValidMetricValues: + description: Output only. Tool call valid metric values. items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate - description: List of NotebookRuntimeTemplates in the requested page. + #/components/schemas/GoogleCloudAiplatformV1ToolCallValidMetricValue + readOnly: true type: array - nextPageToken: - description: >- - A token to retrieve next page of results. Pass to - ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. - type: string - id: GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse type: object - GoogleCloudAiplatformV1DeployedModel: + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: + description: Metrics for classification evaluation results. type: object - description: A deployment of a Model. Endpoints contain one or more DeployedModels. properties: - id: - type: string - description: >- - Immutable. The ID of the DeployedModel. If not provided upon - deployment, Vertex AI will generate a value for this ID. This value - should be 1-10 characters, and valid characters are `/[0-9]/`. - displayName: - type: string + auRoc: + format: float description: >- - The display name of the DeployedModel. If not provided upon - creation, the Model's display_name is used. - enableAccessLogging: - type: boolean + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. + type: number + confusionMatrix: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + description: Confusion matrix of the evaluation. + auPrc: + type: number + format: float description: >- - If true, online prediction access logs are sent to Cloud Logging. - These logs are like standard server access logs, containing - information like timestamp and latency for each prediction request. - Note that logs may incur a cost, especially if your project receives - prediction requests at a high queries per second rate (QPS). - Estimate your costs before enabling this option. - createTime: - description: Output only. Timestamp when the DeployedModel was created. - type: string - format: google-datetime - readOnly: true - disableContainerLogging: - type: boolean - description: >- - For custom-trained Models and AutoML Tabular Models, the container - of the DeployedModel instances will send `stderr` and `stdout` - streams to Cloud Logging by default. Please note that the logs incur - cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging/pricing). User can disable - container logging by setting this flag to true. - modelVersionId: - description: Output only. The version ID of the model that is deployed. - readOnly: true - type: string - model: + The Area Under Precision-Recall Curve metric. Micro-averaged for the + overall evaluation. + logLoss: + description: The Log Loss metric. + format: float + type: number + confidenceMetrics: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics description: >- - Required. The resource name of the Model that this is the deployment - of. Note that the Model may be in a different location than the - DeployedModel's Endpoint. The resource name may contain version id - or version alias to specify the version. Example: - `projects/{project}/locations/{location}/models/{model}@2` or - `projects/{project}/locations/{location}/models/{model}@golden` if - no version is specified, the default version will be deployed. + Metrics for each `confidenceThreshold` in + 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and `positionThreshold` + = INT32_MAX_VALUE. ROC and precision-recall curves, and other + aggregated metrics are derived from them. The confidence metrics + entries may also be supplied for additional values of + `positionThreshold`, but from these no aggregated metrics are + computed. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + description: >- + A wrapper class which contains the tunable parameters in an AutoML Image + training job. + properties: + trainerType: type: string - privateEndpoints: - description: >- - Output only. Provide paths for users to send predict/explain/health - requests directly to the deployed model services running on Cloud - via private services access. This field is populated if network is - configured. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PrivateEndpoints' - readOnly: true - sharedResources: + enum: + - TRAINER_TYPE_UNSPECIFIED + - AUTOML_TRAINER + - MODEL_GARDEN_TRAINER + enumDescriptions: + - Default value. + - '' + - '' + trainerConfig: + additionalProperties: + type: string + description: Customizable trainer settings, used in the `model_garden_trainer`. + type: object + checkpointName: type: string description: >- - The resource name of the shared DeploymentResourcePool to deploy on. - Format: - `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - explanationSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' - description: >- - Explanation configuration for this DeployedModel. When deploying a - Model using EndpointService.DeployModel, this value overrides the - value of Model.explanation_spec. All fields of explanation_spec are - optional in the request. If a field of explanation_spec is not - populated, the value of the same field of Model.explanation_spec is - inherited. If the corresponding Model.explanation_spec is not - populated, all fields of the explanation_spec will be used for the - explanation configuration. - automaticResources: - description: >- - A description of resources that to large degree are decided by - Vertex AI, and require only a modest additional configuration. - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' - dedicatedResources: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' - description: >- - A description of resources that are dedicated to the DeployedModel, - and that need a higher degree of manual configuration. - disableExplanations: - type: boolean - description: >- - If true, deploy the model without explainable feature, regardless - the existence of Model.explanation_spec or explanation_spec. - serviceAccount: - type: string + Optional. An unique name of pretrained model checkpoint provided in + model garden, it will be mapped to a GCS location internally. + datasetConfig: + type: object + description: Customizable dataset settings, used in the `model_garden_trainer`. + additionalProperties: + type: string + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' description: >- - The service account that the DeployedModel's container runs as. - Specify the email address of the service account. If this service - account is not specified, the container runs as a service account - that doesn't have access to the resource project. Users deploying - the Model must have the `iam.serviceAccounts.actAs` permission on - this service account. - id: GoogleCloudAiplatformV1DeployedModel - GoogleCloudAiplatformV1FractionSplit: + Optioinal. StudySpec of hyperparameter tuning job. Required for + `model_garden_trainer`. + type: object + GoogleCloudAiplatformV1QuestionAnsweringQualityResult: properties: - validationFraction: - type: number - description: >- - The fraction of the input data that is to be used to validate the - Model. - format: double - testFraction: - format: double - description: >- - The fraction of the input data that is to be used to evaluate the - Model. + confidence: type: number - trainingFraction: - format: double - description: >- - The fraction of the input data that is to be used to train the - Model. + description: Output only. Confidence for question answering quality score. + format: float + readOnly: true + explanation: + type: string + description: Output only. Explanation for question answering quality score. + readOnly: true + score: + description: Output only. Question Answering Quality score. + readOnly: true + format: float type: number - description: >- - Assigns the input data to training, validation, and test sets as per the - given fractions. Any of `training_fraction`, `validation_fraction` and - `test_fraction` may optionally be provided, they must sum to up to 1. If - the provided ones sum to less than 1, the remainder is assigned to sets - as decided by Vertex AI. If none of the fractions are set, by default - roughly 80% of data is used for training, 10% for validation, and 10% - for test. - id: GoogleCloudAiplatformV1FractionSplit type: object - GoogleCloudAiplatformV1DirectRawPredictResponse: + id: GoogleCloudAiplatformV1QuestionAnsweringQualityResult + description: Spec for question answering quality result. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics: type: object properties: - output: - description: The prediction output. - type: string - format: byte - id: GoogleCloudAiplatformV1DirectRawPredictResponse - description: Response message for PredictionService.DirectRawPredict. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition: - properties: - values: - description: >- - Required. Matches values of the parent parameter of 'INTEGER' type. - All values must lie in `integer_value_spec` of parent parameter. - type: array - items: - type: string - format: int64 + rougeLSum: + description: ROUGE-L (Longest Common Subsequence) scoring at summary level. + type: number + format: float id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition - description: Represents the spec to match integer values from parent parameter. - type: object - GoogleCloudAiplatformV1CancelDataLabelingJobRequest: - description: Request message for JobService.CancelDataLabelingJob. - id: GoogleCloudAiplatformV1CancelDataLabelingJobRequest - properties: {} - type: object - GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey: - type: object - description: ID that is comprised from several parts (columns). - id: GoogleCloudAiplatformV1FeatureViewDataKeyCompositeKey + GoogleCloudAiplatformV1SchemaModelevaluationMetricsSummarizationEvaluationMetrics + GoogleTypeMoney: + description: Represents an amount of money with its currency type. properties: - parts: - type: array + units: description: >- - Parts to construct Entity ID. Should match with the same ID columns - as defined in FeatureView in the same order. - items: - type: string - GoogleCloudAiplatformV1EncryptionSpec: - type: object - properties: - kmsKeyName: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string + format: int64 + nanos: description: >- - Required. The Cloud KMS resource identifier of the customer managed - encryption key used to protect a resource. Has the form: - `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. - The key needs to be in the same region as where the compute resource - is created. - description: >- - Represents a customer-managed encryption key spec that can be applied to - a top-level resource. - id: GoogleCloudAiplatformV1EncryptionSpec - GoogleCloudAiplatformV1SchemaTextDatasetMetadata: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + format: int32 + type: integer + currencyCode: + description: The three-letter currency code defined in ISO 4217. + type: string + type: object + id: GoogleTypeMoney + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: properties: - dataItemSchemaUri: + id: + type: string + description: ID of the AnnotationSpec. + displayName: + description: Display name of the AnnotationSpec. type: string + type: object + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity: + description: A duration of time expressed in time granularity units. + properties: + quantity: + format: int64 description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Text DataItems that belong to this Dataset. - gcsBucket: + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. type: string + unit: description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" + type: string type: object - description: The metadata of Datasets that contain Text DataItems. - id: GoogleCloudAiplatformV1SchemaTextDatasetMetadata - GoogleCloudAiplatformV1SearchNearestEntitiesResponse: - id: GoogleCloudAiplatformV1SearchNearestEntitiesResponse + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity + GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex: + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex type: object + description: Multiple setups to deploy the PublisherModel. properties: - nearestNeighbors: - description: The nearest neighbors of the query entity. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NearestNeighbors' - description: Response message for FeatureOnlineStoreService.SearchNearestEntities - GoogleCloudAiplatformV1EvaluatedAnnotationExplanation: - id: GoogleCloudAiplatformV1EvaluatedAnnotationExplanation + multiDeployVertex: + description: Optional. One click deployment configurations. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + type: array + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse: + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + properties: {} + description: Response message for MetadataService.AddContextArtifactsAndExecutions. type: object + GoogleCloudAiplatformV1Dataset: + description: A collection of DataItems and Annotations on them. properties: - explanationType: + metadataSchemaUri: description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` + Required. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Dataset. The schema is + defined as an OpenAPI 3.0.2 Schema Object. The schema files that can + be used here are found in + gs://google-cloud-aiplatform/schema/dataset/metadata/. type: string - explanation: - description: Explanation attribution response details. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Explanation' - description: Explanation result of the prediction produced by the Model. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter: - properties: - studySpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + updateTime: + readOnly: true + description: Output only. Timestamp when this Dataset was last updated. + type: string + format: google-datetime + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + metadataArtifact: + type: string + readOnly: true description: >- - Optioinal. StudySpec of hyperparameter tuning job. Required for - `model_garden_trainer`. - trainerType: + Output only. The resource name of the Artifact that was created in + MetadataStore when creating the Dataset. The Artifact resource name + pattern is + `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + description: + description: The description of the Dataset. type: string - enumDescriptions: - - Default value. - - '' - - '' - enum: - - TRAINER_TYPE_UNSPECIFIED - - AUTOML_TRAINER - - MODEL_GARDEN_TRAINER - checkpointName: + createTime: + readOnly: true type: string + description: Output only. Timestamp when this Dataset was created. + format: google-datetime + satisfiesPzs: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + metadata: + type: any + description: Required. Additional information about the Dataset. + etag: description: >- - Optional. An unique name of pretrained model checkpoint provided in - model garden, it will be mapped to a GCS location internally. - trainerConfig: - description: Customizable trainer settings, used in the `model_garden_trainer`. - additionalProperties: - type: string - type: object - datasetConfig: - description: Customizable dataset settings, used in the `model_garden_trainer`. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + type: string + displayName: + type: string + description: >- + Required. The user-defined name of the Dataset. The name can be up + to 128 characters long and can consist of any UTF-8 characters. + dataItemCount: + readOnly: true + description: >- + Output only. The number of DataItems in this Dataset. Only apply for + non-structured Dataset. + type: string + format: int64 + name: + type: string + description: Output only. Identifier. The resource name of the Dataset. + readOnly: true + labels: type: object + description: >- + The labels with user-defined metadata to organize your Datasets. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. No + more than 64 user labels can be associated with one Dataset (System + labels are excluded). See https://goo.gl/xmQnxf for more information + and examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for each Dataset: * + "aiplatform.googleapis.com/dataset_metadata_schema": output only, + its value is the metadata_schema's title. additionalProperties: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter + modelReference: + type: string + description: >- + Optional. Reference to the public base model last used by the + dataset. Only set for prompt datasets. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key spec for a Dataset. If set, this + Dataset and all sub-resources of this Dataset will be secured by + this key. + savedQueries: + description: >- + All SavedQueries belong to the Dataset will be returned in List/Get + Dataset response. The annotation_specs field will not be populated + except for UI cases which will only use annotation_spec_count. In + CreateDataset request, a SavedQuery is created together if this + field is set, up to one SavedQuery can be set in + CreateDatasetRequest. The SavedQuery should not contain any + AnnotationSpec. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + type: array + id: GoogleCloudAiplatformV1Dataset type: object - description: >- - A wrapper class which contains the tunable parameters in an AutoML Image - training job. - GoogleCloudAiplatformV1WorkerPoolSpec: - id: GoogleCloudAiplatformV1WorkerPoolSpec + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest: type: object properties: - containerSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ContainerSpec' - description: The custom container task. - replicaCount: - format: int64 + featureDisplayName: + description: >- + The feature display name. If specified, only return the stats + belonging to this feature. Format: + ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, + example: "user_destination". type: string - description: Optional. The number of worker replicas to use for this worker pool. - diskSpec: - description: Disk spec. - $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' - pythonPackageSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PythonPackageSpec' - description: The Python packaged task. - machineSpec: - description: Optional. Immutable. The specification of a single machine. - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - nfsMounts: - type: array + objectives: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NfsMount' - description: Optional. List of NFS mount spec. - description: Represents the spec of a worker pool in a job. - GoogleCloudAiplatformV1EnvVar: - properties: - value: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + description: Required. Objectives of the stats to retrieve. + type: array + pageToken: type: string description: >- - Required. Variables that reference a $(VAR_NAME) are expanded using - the previous defined environment variables in the container and any - service environment variables. If a variable cannot be resolved, the - reference in the input string will be unchanged. The $(VAR_NAME) - syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped - references will never be expanded, regardless of whether the - variable exists or not. - name: + A page token received from a previous + JobService.SearchModelDeploymentMonitoringStatsAnomalies call. + deployedModelId: description: >- - Required. Name of the environment variable. Must be a valid C - identifier. + Required. The DeployedModel ID of the + [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id]. + type: string + endTime: type: string - id: GoogleCloudAiplatformV1EnvVar - description: >- - Represents an environment variable present in a Container or Python - Module. - type: object - GoogleCloudAiplatformV1FindNeighborsRequestQuery: - id: GoogleCloudAiplatformV1FindNeighborsRequestQuery - properties: - perCrowdingAttributeNeighborCount: - type: integer - format: int32 description: >- - Crowding is a constraint on a neighbor list produced by nearest - neighbor search requiring that no more than some value k' of the k - neighbors returned have the same value of crowding_attribute. It's - used for improving result diversity. This field is the maximum - number of matches with the same crowding tag. - rrf: - description: Optional. Represents RRF algorithm that combines search results. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF - neighborCount: + The latest timestamp of stats being generated. If not set, indicates + feching stats till the latest possible one. + format: google-datetime + startTime: description: >- - The number of nearest neighbors to be retrieved from database for - each query. If not set, will use the default from the service - configuration - (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config). - type: integer + The earliest timestamp of stats being generated. If not set, + indicates fetching stats till the earliest possible one. + format: google-datetime + type: string + pageSize: + description: The standard list page size. format: int32 - datapoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' - description: >- - Required. The datapoint/vector whose nearest neighbors should be - searched for. - fractionLeafNodesToSearchOverride: - type: number - description: >- - The fraction of the number of leaves to search, set at query time - allows user to tune search performance. This value increase result - in both search accuracy and latency increase. The value should be - between 0.0 and 1.0. If not set or set to 0.0, query uses the - default value specified in - NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search. - format: double - approximateNeighborCount: type: integer - format: int32 - description: >- - The number of neighbors to find via approximate search before exact - reordering is performed. If not set, the default value from scam - config is used; if set, this value must be > 0. + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest description: >- - A query to find a number of the nearest neighbors (most similar vectors) - of a vector. - type: object - GoogleCloudAiplatformV1Neighbor: + Request message for + JobService.SearchModelDeploymentMonitoringStatsAnomalies. + GoogleCloudAiplatformV1PurgeExecutionsResponse: + description: Response message for MetadataService.PurgeExecutions. + id: GoogleCloudAiplatformV1PurgeExecutionsResponse properties: - neighborDistance: - type: number - readOnly: true - description: Output only. The neighbor distance. - format: double - neighborId: + purgeCount: + description: >- + The number of Executions that this request deleted (or, if `force` + is false, the number of Executions that will be deleted). This can + be an estimate. type: string - description: Output only. The neighbor id. - readOnly: true - description: Neighbors for example-based explanations. - id: GoogleCloudAiplatformV1Neighbor + format: int64 + purgeSample: + description: >- + A sample of the Execution names that will be deleted. Only populated + if `force` is set to false. The maximum number of samples is 100 (it + is possible to return fewer). + type: array + items: + type: string type: object - GoogleTypeColor: + GoogleCloudAiplatformV1Content: type: object description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... + The base structured datatype containing multi-part content of a message. + A `Content` includes a `role` field designating the producer of the + `Content` and a `parts` field containing multi-part data that contains + the content of the message turn. + id: GoogleCloudAiplatformV1Content properties: - green: - format: float - type: number - description: The amount of green in the color as a value in the interval [0, 1]. - alpha: - format: float - type: number + role: + type: string description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - red: - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - blue: - format: float - description: The amount of blue in the color as a value in the interval [0, 1]. - type: number - id: GoogleTypeColor - GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport: + Optional. The producer of the content. Must be either 'user' or + 'model'. Useful to set for multi-turn conversations, otherwise can + be left blank or unset. + parts: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Part' + description: >- + Required. Ordered `Parts` that constitute a single message. Parts + may have different IANA MIME types. + GoogleCloudAiplatformV1FeatureGroup: + id: GoogleCloudAiplatformV1FeatureGroup + description: Vertex AI Feature Group. properties: - startTime: + bigQuery: description: >- - Excludes Feature values with feature generation timestamp before - this timestamp. If not set, retrieve oldest values kept in Feature - Store. Timestamp, if present, must not have higher than millisecond - precision. - format: google-datetime + Indicates that features for this group come from BigQuery + Table/View. By default treats the source as a sparse time series + source. The BigQuery source table or view must have at least one + entity ID column and a column named `feature_timestamp`. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroupBigQuery' + updateTime: type: string - endTime: - description: >- - Exports Feature values as of this timestamp. If not set, retrieve - values as of now. Timestamp, if present, must not have higher than - millisecond precision. + readOnly: true format: google-datetime - type: string - description: >- - Describes exporting all historical Feature values of all entities of the - EntityType between [start_time, end_time]. - type: object - id: GoogleCloudAiplatformV1ExportFeatureValuesRequestFullExport - GoogleLongrunningOperation: - id: GoogleLongrunningOperation - properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. + description: Output only. Timestamp when this FeatureGroup was last updated. name: + type: string description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + Identifier. Name of the FeatureGroup. Format: + `projects/{project}/locations/{location}/featureGroups/{featureGroup}` + description: + description: Optional. Description of the FeatureGroup. type: string - metadata: - type: object + labels: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. + Optional. The labels with user-defined metadata to organize your + FeatureGroup. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureGroup(System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - response: + type: string type: object + createTime: + description: Output only. Timestamp when this FeatureGroup was created. + readOnly: true + format: google-datetime + type: string + etag: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + type: string type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleApiHttpBody: - id: GoogleApiHttpBody + GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: type: object - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata + description: Details of operations that delete Feature values. properties: - extensions: + genericMetadata: + description: Operation metadata for Featurestore delete Features values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1RawPredictRequest: + type: object + properties: + httpBody: + $ref: '#/components/schemas/GoogleApiHttpBody' description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - type: array - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - data: + The prediction input. Supports HTTP headers and arbitrary data + payload. A DeployedModel may have an upper limit on the number of + instances it supports per request. When this limit it is exceeded + for an AutoML model, the RawPredict method returns an error. When + this limit is exceeded for a custom-trained model, the behavior + varies depending on the model. You can specify the schema for each + instance in the predict_schemata.instance_schema_uri field when you + create a Model. This schema applies when you deploy the `Model` as a + `DeployedModel` to an Endpoint and use the `RawPredict` method. + id: GoogleCloudAiplatformV1RawPredictRequest + description: Request message for PredictionService.RawPredict. + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: + properties: + content: type: string - description: The HTTP request/response body as raw binary. - format: byte - contentType: - description: >- - The HTTP Content-Type header value specifying the content type of - the body. + description: The image bytes or Cloud Storage URI to make the prediction on. + mimeType: type: string - GoogleCloudAiplatformV1ResourceRuntimeSpec: - id: GoogleCloudAiplatformV1ResourceRuntimeSpec - properties: - serviceAccountSpec: - description: >- - Optional. Configure the use of workload identity on the - PersistentResource - $ref: '#/components/schemas/GoogleCloudAiplatformV1ServiceAccountSpec' - raySpec: description: >- - Optional. Ray cluster configuration. Required when creating a - dedicated RayCluster on the PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1RaySpec' + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/gif - + image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + description: Prediction input format for Image Object Detection. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance type: object + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: + id: >- + GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis description: >- - Configuration for the runtime on a PersistentResource instance, - including but not limited to: * Service accounts used to run the - workloads. * Whether to make it a dedicated Ray Cluster. - GoogleCloudAiplatformV1Port: - description: Represents a network port in a container. + Configuration of the Featurestore's ImportFeature Analysis Based + Monitoring. This type of analysis generates statistics for values of + each Feature imported by every ImportFeatureValues operation. type: object properties: - containerPort: + anomalyDetectionBaseline: + type: string + enum: + - BASELINE_UNSPECIFIED + - LATEST_STATS + - MOST_RECENT_SNAPSHOT_STATS + - PREVIOUS_IMPORT_FEATURES_STATS + enumDescriptions: + - Should not be used. + - >- + Choose the later one statistics generated by either most recent + snapshot analysis or previous import features analysis. If non of + them exists, skip anomaly detection and only generate a + statistics. + - >- + Use the statistics generated by the most recent snapshot analysis + if exists. + - >- + Use the statistics generated by the previous import features + analysis if exists. description: >- - The number of the port to expose on the pod's IP address. Must be a - valid port number, between 1 and 65535 inclusive. - format: int32 - type: integer - id: GoogleCloudAiplatformV1Port - GoogleCloudAiplatformV1LineageSubgraph: + The baseline used to do anomaly detection for the statistics + generated by import features analysis. + state: + description: >- + Whether to enable / disable / inherite default hebavior for import + features analysis. + enumDescriptions: + - Should not be used. + - >- + The default behavior of whether to enable the monitoring. + EntityType-level config: disabled. Feature-level config: inherited + from the configuration of EntityType this Feature belongs to. + - >- + Explicitly enables import features analysis. EntityType-level + config: by default enables import features analysis for all + Features under it. Feature-level config: enables import features + analysis regardless of the EntityType-level config. + - >- + Explicitly disables import features analysis. EntityType-level + config: by default disables import features analysis for all + Features under it. Feature-level config: disables import features + analysis regardless of the EntityType-level config. + type: string + enum: + - STATE_UNSPECIFIED + - DEFAULT + - ENABLED + - DISABLED + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair: + id: >- + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + description: Feature name & value pair. + properties: + name: + description: Feature short name. + type: string + value: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: Feature value. type: object - description: >- - A subgraph of the overall lineage graph. Event edges connect Artifact - and Execution nodes. + GoogleCloudAiplatformV1SchemaTablesDatasetMetadata: + description: The metadata of Datasets that contain tables data. + type: object + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadata properties: - executions: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - description: The Execution nodes in the subgraph. - events: - type: array + inputConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig + GoogleCloudAiplatformV1ListFeaturestoresResponse: + properties: + nextPageToken: + type: string + description: >- + A token, which can be sent as ListFeaturestoresRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + featurestores: + description: The Featurestores matching the request. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' - description: The Event edges between Artifacts and Executions in the subgraph. - artifacts: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' type: array - description: The Artifact nodes in the subgraph. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' - id: GoogleCloudAiplatformV1LineageSubgraph - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata: + id: GoogleCloudAiplatformV1ListFeaturestoresResponse type: object + description: Response message for FeaturestoreService.ListFeaturestores. + GoogleCloudAiplatformV1ListNotebookRuntimesResponse: + description: Response message for NotebookService.ListNotebookRuntimes. properties: - costMilliNodeHours: - format: int64 - description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. - type: string - successfulStopReason: + notebookRuntimes: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + description: List of NotebookRuntimes in the requested page. + type: array + nextPageToken: description: >- - For successful job completions, this is the reason why the job has - finished. - enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED + A token to retrieve next page of results. Pass to + ListNotebookRuntimesRequest.page_token to obtain that page. type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata - GoogleCloudAiplatformV1CreateDatasetOperationMetadata: + type: object + id: GoogleCloudAiplatformV1ListNotebookRuntimesResponse + GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: + type: object + id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata properties: genericMetadata: - description: The operation generic information. + description: The common part of the operation metadata. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for DatasetService.CreateDataset. + description: Runtime operation information for DatasetService.RestoreDatasetVersion. + GoogleCloudAiplatformV1FulfillmentInstance: + id: GoogleCloudAiplatformV1FulfillmentInstance + description: Spec for fulfillment instance. type: object - id: GoogleCloudAiplatformV1CreateDatasetOperationMetadata - GoogleCloudAiplatformV1MigratableResourceAutomlDataset: properties: - dataset: + instruction: + description: Required. Inference instruction prompt to compare prediction with. type: string - description: >- - Full resource name of automl Dataset. Format: - `projects/{project}/locations/{location}/datasets/{dataset}`. - datasetDisplayName: + prediction: + description: Required. Output of the evaluated model. type: string - description: The Dataset's display name in automl.googleapis.com. - description: Represents one Dataset in automl.googleapis.com. - id: GoogleCloudAiplatformV1MigratableResourceAutomlDataset - type: object - GoogleCloudAiplatformV1CopyModelRequest: + GoogleCloudAiplatformV1DataLabelingJob: + description: >- + DataLabelingJob is used to trigger a human labeling job on unlabeled + data from the following Dataset: properties: - parentModel: + createTime: + readOnly: true + format: google-datetime type: string + description: Output only. Timestamp when this DataLabelingJob was created. + displayName: description: >- - Optional. Specify this field to copy source_model into this existing - Model as a new version. Format: - `projects/{project}/locations/{location}/models/{model}` + Required. The user-defined name of the DataLabelingJob. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. Display name of a DataLabelingJob. + type: string encryptionSpec: - description: >- - Customer-managed encryption key options. If this is set, then the - Model copy will be encrypted with the provided encryption key. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - modelId: description: >- - Optional. Copy source_model into a new Model with this ID. The ID - will become the final component of the model resource name. This - value may be up to 63 characters, and valid characters are - `[a-z0-9_-]`. The first character cannot be a number or hyphen. + Customer-managed encryption key spec for a DataLabelingJob. If set, + this DataLabelingJob will be secured by this key. Note: Annotations + created in the DataLabelingJob are associated with the + EncryptionSpec of the Dataset they are exported to. + labelerCount: + type: integer + format: int32 + description: Required. Number of labelers to work on each DataItem. + annotationLabels: + additionalProperties: + type: string + type: object + description: >- + Labels to assign to annotations generated by this DataLabelingJob. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + updateTime: + description: >- + Output only. Timestamp when this DataLabelingJob was updated most + recently. + format: google-datetime + readOnly: true type: string - sourceModel: + inputsSchemaUri: type: string description: >- - Required. The resource name of the Model to copy. That Model must be - in the same Project. Format: - `projects/{project}/locations/{location}/models/{model}` - description: Request message for ModelService.CopyModel. - id: GoogleCloudAiplatformV1CopyModelRequest + Required. Points to a YAML file stored on Google Cloud Storage + describing the config for a specific type of DataLabelingJob. The + schema files that can be used here are found in the + https://storage.googleapis.com/google-cloud-aiplatform bucket in the + /schema/datalabelingjob/inputs/ folder. + inputs: + type: any + description: Required. Input config parameters for the DataLabelingJob. + datasets: + type: array + items: + type: string + description: >- + Required. Dataset resource names. Right now we only support labeling + from a single Dataset. Format: + `projects/{project}/locations/{location}/datasets/{dataset}` + labels: + type: object + additionalProperties: + type: string + description: >- + The labels with user-defined metadata to organize your + DataLabelingJobs. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information and + examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. Following system + labels exist for each DataLabelingJob: * + "aiplatform.googleapis.com/schema": output only, its value is the + inputs_schema's title. + name: + type: string + readOnly: true + description: Output only. Resource name of the DataLabelingJob. + state: + type: string + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + description: Output only. The detailed state of the job. + readOnly: true + currentSpend: + readOnly: true + description: >- + Output only. Estimated cost(in US dollars) that the DataLabelingJob + has incurred to date. + $ref: '#/components/schemas/GoogleTypeMoney' + activeLearningConfig: + description: >- + Parameters that configure the active learning pipeline. Active + learning will label the data incrementally via several iterations. + For every iteration, it will select a batch of data based on the + sampling strategy. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ActiveLearningConfig' + labelingProgress: + readOnly: true + description: >- + Output only. Current labeling job progress percentage scaled in + interval [0, 100], indicating the percentage of DataItems that has + been finished. + type: integer + format: int32 + instructionUri: + description: >- + Required. The Google Cloud Storage location of the instruction pdf. + This pdf is shared with labelers, and provides detailed description + on how to label DataItems in Datasets. + type: string + specialistPools: + description: The SpecialistPools' resource names associated with this job. + type: array + items: + type: string + error: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + description: >- + Output only. DataLabelingJob errors. It is only populated when job's + state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. type: object - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain: - id: >- - GoogleCloudAiplatformV1ExplanationMetadataInputMetadataFeatureValueDomain + id: GoogleCloudAiplatformV1DataLabelingJob + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation: type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation description: >- - Domain details of the input feature value. Provides numeric information - about the feature, such as its range (min, max). If the feature has been - pre-processed, for example with z-scoring, then it provides information - about how to recover the original feature. For example, if the input - feature is an image and it has been pre-processed to obtain 0-mean and - stddev = 1 values, then original_mean, and original_stddev refer to the - mean and stddev of the original feature (e.g. image tensor) from which - input feature (with mean = 0 and stddev = 1) was obtained. + Training pipeline will perform following transformation functions. * + Apply the transformation functions for Numerical columns. * Determine + the year, month, day,and weekday. Treat each value from the * timestamp + as a Categorical column. * Invalid numerical values (for example, values + that fall outside of a typical timestamp range, or are extreme values) + receive no special treatment and are not removed. properties: - originalMean: + columnName: + type: string + invalidValuesAllowed: + type: boolean description: >- - If this input feature has been normalized to a mean value of 0, the - original_mean specifies the mean value of the domain prior to - normalization. - type: number - format: float - minValue: - type: number - format: float - description: The minimum permissible value for this feature. - originalStddev: - format: float + If invalid values is allowed, the training pipeline will create a + boolean feature that indicated whether the value is valid. + Otherwise, the training pipeline will discard the input row from + trainining data. + timeFormat: description: >- - If this input feature has been normalized to a standard deviation of - 1.0, the original_stddev specifies the standard deviation of the - domain prior to normalization. - type: number - maxValue: - format: float - description: The maximum permissible value for this feature. - type: number - GoogleCloudAiplatformV1PipelineJobDetail: - type: object - id: GoogleCloudAiplatformV1PipelineJobDetail + The format in which that time field is expressed. The time_format + must either be one of: * `unix-seconds` * `unix-milliseconds` * + `unix-microseconds` * `unix-nanoseconds` (for respectively number of + seconds, milliseconds, microseconds and nanoseconds since start of + the Unix epoch); or be written in `strftime` syntax. If time_format + is not set, then the default format is RFC 3339 `date-time` format, + where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + type: string + GoogleCloudAiplatformV1PairwiseMetricResult: + description: Spec for pairwise metric result. properties: - taskDetails: - type: array - readOnly: true - description: Output only. The runtime details of the tasks under the pipeline. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineTaskDetail' - pipelineRunContext: - description: Output only. The context of the current pipeline run. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - readOnly: true - pipelineContext: - description: Output only. The context of the pipeline. + pairwiseChoice: + enum: + - PAIRWISE_CHOICE_UNSPECIFIED + - BASELINE + - CANDIDATE + - TIE + enumDescriptions: + - Unspecified prediction choice. + - Baseline prediction wins + - Candidate prediction wins + - Winner cannot be determined readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' - description: The runtime detail of PipelineJob. - GoogleCloudAiplatformV1RebootPersistentResourceRequest: - id: GoogleCloudAiplatformV1RebootPersistentResourceRequest - type: object - properties: {} - description: Request message for PersistentResourceService.RebootPersistentResource. - GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata: - properties: - deployedIndexId: type: string - description: The unique index id specified by user - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: >- - Runtime operation information for - IndexEndpointService.MutateDeployedIndex. - id: GoogleCloudAiplatformV1MutateDeployedIndexOperationMetadata + description: Output only. Pairwise metric choice. + explanation: + description: Output only. Explanation for pairwise metric score. + type: string + readOnly: true + id: GoogleCloudAiplatformV1PairwiseMetricResult type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig: + GoogleCloudAiplatformV1SupervisedHyperParameters: + description: Hyperparameters for SFT. + id: GoogleCloudAiplatformV1SupervisedHyperParameters type: object properties: - skewThresholds: - description: >- - Key is the feature name and value is the threshold. If a feature - needs to be monitored for skew, a value threshold must be configured - for that feature. The threshold here is against feature distribution - distance between the training and prediction feature. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - type: object - defaultSkewThreshold: - description: >- - Skew anomaly detection threshold used by all features. When the - per-feature thresholds are not set, this field can be used to - specify a threshold for all features. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - attributionScoreSkewThresholds: + adapterSize: + enum: + - ADAPTER_SIZE_UNSPECIFIED + - ADAPTER_SIZE_ONE + - ADAPTER_SIZE_FOUR + - ADAPTER_SIZE_EIGHT + - ADAPTER_SIZE_SIXTEEN + - ADAPTER_SIZE_THIRTY_TWO + type: string + enumDescriptions: + - Adapter size is unspecified. + - Adapter size 1. + - Adapter size 4. + - Adapter size 8. + - Adapter size 16. + - Adapter size 32. + description: Optional. Adapter size for tuning. + learningRateMultiplier: + description: Optional. Multiplier for adjusting the default learning rate. + type: number + format: double + epochCount: + type: string description: >- - Key is the feature name and value is the threshold. The threshold - here is against attribution score distance between the training and - prediction feature. - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig + Optional. Number of complete passes the model makes over the entire + training dataset during training. + format: int64 + GoogleCloudAiplatformV1ListFeaturesResponse: description: >- - The config for Training & Prediction data skew detection. It specifies - the training dataset sources and the skew detection parameters. - GoogleCloudAiplatformV1PurgeExecutionsResponse: - type: object - id: GoogleCloudAiplatformV1PurgeExecutionsResponse + Response message for FeaturestoreService.ListFeatures. Response message + for FeatureRegistryService.ListFeatures. properties: - purgeCount: + nextPageToken: type: string description: >- - The number of Executions that this request deleted (or, if `force` - is false, the number of Executions that will be deleted). This can - be an estimate. - format: int64 - purgeSample: + A token, which can be sent as ListFeaturesRequest.page_token to + retrieve the next page. If this field is omitted, there are no + subsequent pages. + features: + description: The Features matching the request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' type: array + id: GoogleCloudAiplatformV1ListFeaturesResponse + type: object + GoogleCloudAiplatformV1PurgeContextsResponse: + type: object + id: GoogleCloudAiplatformV1PurgeContextsResponse + description: Response message for MetadataService.PurgeContexts. + properties: + purgeSample: items: type: string + type: array description: >- - A sample of the Execution names that will be deleted. Only populated + A sample of the Context names that will be deleted. Only populated if `force` is set to false. The maximum number of samples is 100 (it is possible to return fewer). - description: Response message for MetadataService.PurgeExecutions. - GoogleCloudAiplatformV1AnnotationSpec: - description: Identifies a concept with which DataItems may be annotated with. - id: GoogleCloudAiplatformV1AnnotationSpec + purgeCount: + type: string + format: int64 + description: >- + The number of Contexts that this request deleted (or, if `force` is + false, the number of Contexts that will be deleted). This can be an + estimate. + GoogleCloudAiplatformV1ToolNameMatchResults: + description: Results for tool name match metric. type: object properties: - updateTime: - type: string - description: Output only. Timestamp when AnnotationSpec was last updated. - format: google-datetime + toolNameMatchMetricValues: readOnly: true - displayName: + description: Output only. Tool name match metric values. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ToolNameMatchMetricValue + id: GoogleCloudAiplatformV1ToolNameMatchResults + GoogleCloudAiplatformV1PredictResponse: + description: Response message for PredictionService.Predict. + type: object + id: GoogleCloudAiplatformV1PredictResponse + properties: + predictions: + items: + type: any description: >- - Required. The user-defined name of the AnnotationSpec. The name can - be up to 128 characters long and can consist of any UTF-8 - characters. + The predictions that are the output of the predictions call. The + schema of any single prediction may be specified via Endpoint's + DeployedModels' Model's PredictSchemata's prediction_schema_uri. + type: array + metadata: + description: >- + Output only. Request-level metadata returned by the model. The + metadata type will be dependent upon the model implementation. + readOnly: true + type: any + deployedModelId: + description: ID of the Endpoint's DeployedModel that served this prediction. type: string - etag: + model: description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + Output only. The resource name of the Model which is deployed as the + DeployedModel that this prediction hits. + readOnly: true type: string - createTime: - format: google-datetime - description: Output only. Timestamp when this AnnotationSpec was created. + modelDisplayName: type: string readOnly: true - name: - readOnly: true + description: >- + Output only. The display name of the Model which is deployed as the + DeployedModel that this prediction hits. + modelVersionId: type: string - description: Output only. Resource name of the AnnotationSpec. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: + description: >- + Output only. The version ID of the Model which is deployed as the + DeployedModel that this prediction hits. + readOnly: true + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams: + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageSegmentationPredictionParams + description: Prediction model parameters for Image Segmentation. type: object properties: - sentimentMax: - format: int32 - type: integer + confidenceThreshold: description: >- - A sentiment is expressed as an integer ordinal, where higher value - means a more positive sentiment. The range of sentiments that will - be used is between 0 and sentimentMax (inclusive on both ends), and - all the values in the range must be represented in the dataset - before a model can be created. Only the Annotations with this - sentimentMax will be used for training. sentimentMax value must be - between 1 and 10 (inclusive). - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs - GoogleCloudAiplatformV1TensorboardRun: + When the model predicts category of pixels of the image, it will + only provide predictions for pixels that it is at least this much + confident about. All other pixels will be classified as background. + Default value is 0.5. + type: number + format: float + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig: + properties: + bigquerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataBigQuerySource + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource description: >- - TensorboardRun maps to a specific execution of a training job with a - given set of hyperparameter values, model definition, dataset, etc - id: GoogleCloudAiplatformV1TensorboardRun + The time series Dataset's data source. The Dataset doesn't store the + data directly, but only pointer(s) to its data. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataInputConfig + type: object + GoogleCloudAiplatformV1UserActionReference: properties: - displayName: + operation: type: string description: >- - Required. User provided name of this TensorboardRun. This value must - be unique among all TensorboardRuns belonging to the same parent - TensorboardExperiment. - name: - readOnly: true - description: >- - Output only. Name of the TensorboardRun. Format: - `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + For API calls that return a long running operation. Resource name of + the long running operation. Format: + `projects/{project}/locations/{location}/operations/{operation}` + dataLabelingJob: type: string - labels: - additionalProperties: - type: string - type: object description: >- - The labels with user-defined metadata to organize your - TensorboardRuns. This field will be used to filter and visualize - Runs in the Tensorboard UI. For example, a Vertex AI training job - can set a label aiplatform.googleapis.com/training_job_id=xxxxx to - all the runs created within that job. An end user can set a label - experiment_id=xxxxx for all the runs produced in a Jupyter notebook. - These runs can be grouped by a label value and visualized together - in the Tensorboard UI. Label keys and values can be no longer than - 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. No more than 64 user labels can be - associated with one TensorboardRun (System labels are excluded). See - https://goo.gl/xmQnxf for more information and examples of labels. - System reserved label keys are prefixed with - "aiplatform.googleapis.com/" and are immutable. - createTime: - type: string - description: Output only. Timestamp when this TensorboardRun was created. - readOnly: true - format: google-datetime - updateTime: - description: Output only. Timestamp when this TensorboardRun was last updated. - readOnly: true - format: google-datetime - type: string - etag: - type: string + For API calls that start a LabelingJob. Resource name of the + LabelingJob. Format: + `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + method: description: >- - Used to perform a consistent read-modify-write updates. If not set, - a blind "overwrite" update happens. - description: + The method name of the API RPC call. For example, + "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset" type: string - description: Description of this TensorboardRun. - type: object - GoogleLongrunningListOperationsResponse: + id: GoogleCloudAiplatformV1UserActionReference + description: >- + References an API call. It contains more information about long running + operation and Jobs that are triggered by the API call. type: object - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult + description: Prediction output format for Image and Text Classification. properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: + displayNames: + description: >- + The display names of the AnnotationSpecs that had been identified, + order matches the IDs. type: array items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + type: string + ids: + items: + type: string + format: int64 + type: array + description: The resource IDs of the AnnotationSpecs that had been identified. + confidences: description: >- - A list of operations that matches the specified filter in the - request. - GoogleCloudAiplatformV1CreateEndpointOperationMetadata: - id: GoogleCloudAiplatformV1CreateEndpointOperationMetadata - description: Runtime operation information for EndpointService.CreateEndpoint. + The Model's confidences in correctness of the predicted IDs, higher + value means higher confidence. Order matches the Ids. + type: array + items: + format: float + type: number + type: object + GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig: + properties: + explanationBaseline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + description: >- + Predictions generated by the BatchPredictionJob using baseline + dataset. + enableFeatureAttributes: + description: >- + If want to analyze the Vertex Explainable AI feature attribute + scores or not. If set to true, Vertex AI will log the feature + attributions from explain response and do the skew/drift detection + for them. + type: boolean + type: object + id: GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfig + description: >- + The config for integrating with Vertex Explainable AI. Only applicable + if the Model has explanation_spec populated. + GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata: + properties: + genericMetadata: + description: Operation metadata for PersistentResource. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + progressMessage: + description: Progress Message for Create LRO + type: string + id: GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata + type: object + description: Details of operations that perform create PersistentResource. + GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig: + type: object + properties: + userEmails: + type: array + description: The email addresses to send the alert. + items: + type: string + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + description: The config for email alert. + GoogleCloudAiplatformV1DeployModelOperationMetadata: + id: GoogleCloudAiplatformV1DeployModelOperationMetadata + type: object properties: genericMetadata: $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' description: The operation generic information. + description: Runtime operation information for EndpointService.DeployModel. + GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: + description: Response message for ModelService.ListModelEvaluationSlices. + id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse type: object - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis: properties: - anomalyDetectionBaseline: - enumDescriptions: - - Should not be used. - - >- - Choose the later one statistics generated by either most recent - snapshot analysis or previous import features analysis. If non of - them exists, skip anomaly detection and only generate a - statistics. - - >- - Use the statistics generated by the most recent snapshot analysis - if exists. - - >- - Use the statistics generated by the previous import features - analysis if exists. - description: >- - The baseline used to do anomaly detection for the statistics - generated by import features analysis. - type: string - enum: - - BASELINE_UNSPECIFIED - - LATEST_STATS - - MOST_RECENT_SNAPSHOT_STATS - - PREVIOUS_IMPORT_FEATURES_STATS - state: + modelEvaluationSlices: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + type: array + description: List of ModelEvaluations in the requested page. + nextPageToken: type: string - enumDescriptions: - - Should not be used. - - >- - The default behavior of whether to enable the monitoring. - EntityType-level config: disabled. Feature-level config: inherited - from the configuration of EntityType this Feature belongs to. - - >- - Explicitly enables import features analysis. EntityType-level - config: by default enables import features analysis for all - Features under it. Feature-level config: enables import features - analysis regardless of the EntityType-level config. - - >- - Explicitly disables import features analysis. EntityType-level - config: by default disables import features analysis for all - Features under it. Feature-level config: disables import features - analysis regardless of the EntityType-level config. - enum: - - STATE_UNSPECIFIED - - DEFAULT - - ENABLED - - DISABLED description: >- - Whether to enable / disable / inherite default hebavior for import - features analysis. - description: >- - Configuration of the Featurestore's ImportFeature Analysis Based - Monitoring. This type of analysis generates statistics for values of - each Feature imported by every ImportFeatureValues operation. - type: object - id: >- - GoogleCloudAiplatformV1FeaturestoreMonitoringConfigImportFeaturesAnalysis - CloudAiLargeModelsVisionImage: + A token to retrieve next page of results. Pass to + ListModelEvaluationSlicesRequest.page_token to obtain that page. + GoogleCloudAiplatformV1DestinationFeatureSetting: properties: - image: - format: byte - description: Raw bytes. - type: string - uri: - description: Path to another storage (typically Google Cloud Storage). - type: string - imageRaiScores: - $ref: '#/components/schemas/CloudAiLargeModelsVisionImageRAIScores' - description: RAI scores for generated image. - raiInfo: - $ref: '#/components/schemas/CloudAiLargeModelsVisionRaiInfo' - description: RAI info for image. - text: + featureId: + description: Required. The ID of the Feature to apply the setting to. type: string - description: Text/Expanded text input for imagen. - encoding: + destinationField: type: string - description: Image encoding, encoded as "image/png" or "image/jpg". - semanticFilterResponse: - $ref: '#/components/schemas/CloudAiLargeModelsVisionSemanticFilterResponse' - description: Semantic filter info for image. - id: CloudAiLargeModelsVisionImage - description: Image. + description: >- + Specify the field name in the export destination. If not specified, + Feature ID is used. type: object - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult: + id: GoogleCloudAiplatformV1DestinationFeatureSetting + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity: + description: A duration of time expressed in time granularity units. properties: - timeSegmentEnd: - format: google-duration - type: string - description: >- - The end, exclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. - timeSegmentStart: + quantity: + format: int64 type: string - format: google-duration description: >- - The beginning, inclusive, of the video's time segment in which the - AnnotationSpec has been identified. Expressed as a number of seconds - as measured from the start of the video, with fractions up to a - microsecond precision, and with "s" appended at the end. - displayName: + The number of granularity_units between data points in the training + data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. + For all other values of `granularity_unit`, must be 1. + unit: type: string - description: The display name of the AnnotationSpec that had been identified. - confidence: - format: float description: >- - The Model's confidence in correction of this prediction, higher - value means higher confidence. - type: number - id: - description: The resource ID of the AnnotationSpec that had been identified. - type: string - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionVideoActionRecognitionPredictionResult - type: object - description: Prediction output format for Video Action Recognition. - GoogleCloudAiplatformV1UpdateFeatureOperationMetadata: + The time granularity unit of this time period. The supported units + are: * "minute" * "hour" * "day" * "week" * "month" * "year" type: object - id: GoogleCloudAiplatformV1UpdateFeatureOperationMetadata - description: Details of operations that perform update Feature. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for Feature Update. - CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity + GoogleCloudAiplatformV1DedicatedResources: properties: - x2: + spot: + type: boolean + description: >- + Optional. If true, schedule the deployment workload on [spot + VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). + machineSpec: + description: >- + Required. Immutable. The specification of a single machine used by + the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + autoscalingMetricSpecs: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoscalingMetricSpec' + description: >- + Immutable. The metric specifications that overrides a resource + utilization metric (CPU utilization, accelerator's duty cycle, and + so on) target value (default to 60 if not set). At most one entry is + allowed per metric. If machine_spec.accelerator_count is above 0, + the autoscaling will be based on both CPU utilization and + accelerator's duty cycle metrics and scale up when either metrics + exceeds its target value while scale down if both metrics are under + their target value. The default target value is 60 for both metrics. + If machine_spec.accelerator_count is 0, the autoscaling will be + based on CPU utilization metric only with default target value 60 if + not explicitly set. For example, in the case of Online Prediction, + if you want to override target CPU utilization to 80, you should set + autoscaling_metric_specs.metric_name to + `aiplatform.googleapis.com/prediction/online/cpu/utilization` and + autoscaling_metric_specs.target to `80`. + type: array + minReplicaCount: format: int32 + description: >- + Required. Immutable. The minimum number of machine replicas this + DeployedModel will be always deployed on. This value must be greater + than or equal to 1. If traffic against the DeployedModel increases, + it may dynamically be deployed onto more replicas, and as traffic + decreases, some of these extra replicas may be freed. type: integer - description: The X coordinate of the bottom-right corner, in pixels. - y2: + maxReplicaCount: + description: >- + Immutable. The maximum number of replicas this DeployedModel may be + deployed on when the traffic against it increases. If the requested + value is too large, the deployment will error, but if deployment + succeeds then the ability to scale the model to that many replicas + is guaranteed (barring service outages). If traffic against the + DeployedModel increases beyond what its replicas at maximum may + handle, a portion of the traffic will be dropped. If this value is + not provided, will use min_replica_count as the default value. The + value of this field impacts the charge against Vertex CPU and GPU + quotas. Specifically, you will be charged for (max_replica_count * + number of cores in the selected machine type) and (max_replica_count + * number of GPUs per replica in the selected machine type). format: int32 - description: The Y coordinate of the bottom-right corner, in pixels. type: integer - y1: + type: object + id: GoogleCloudAiplatformV1DedicatedResources + description: >- + A description of resources that are dedicated to a DeployedModel, and + that need a higher degree of manual configuration. + GoogleCloudAiplatformV1AutomaticResources: + properties: + minReplicaCount: format: int32 - description: The Y coordinate of the top-left corner, in pixels. + description: >- + Immutable. The minimum number of replicas this DeployedModel will be + always deployed on. If traffic against it increases, it may + dynamically be deployed onto more replicas up to max_replica_count, + and as traffic decreases, some of these extra replicas may be freed. + If the requested value is too large, the deployment will error. type: integer - x1: + maxReplicaCount: + description: >- + Immutable. The maximum number of replicas this DeployedModel may be + deployed on when the traffic against it increases. If the requested + value is too large, the deployment will error, but if deployment + succeeds then the ability to scale the model to that many replicas + is guaranteed (barring service outages). If traffic against the + DeployedModel increases beyond what its replicas at maximum may + handle, a portion of the traffic will be dropped. If this value is + not provided, a no upper bound for scaling under heavy traffic will + be assume, though Vertex AI may be unable to scale beyond certain + replica number. format: int32 - description: The X coordinate of the top-left corner, in pixels. type: integer type: object + id: GoogleCloudAiplatformV1AutomaticResources description: >- - An integer bounding box of original pixels of the image for the detected - labels. - id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox - GoogleCloudAiplatformV1UnmanagedContainerModel: - id: GoogleCloudAiplatformV1UnmanagedContainerModel + A description of resources that to large degree are decided by Vertex + AI, and require only a modest additional configuration. Each Model + supporting these resources documents its specific guidelines. + GoogleCloudAiplatformV1PointwiseMetricInstance: properties: - predictSchemata: - description: Contains the schemata used in Model's predictions and explanations - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' - artifactUri: + jsonInstance: type: string description: >- - The path to the directory containing the Model artifact and any of - its supporting files. - containerSpec: - description: >- - Input only. The specification of the container that is to be used - when deploying this Model. - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' + Instance specified as a json string. String key-value pairs are + expected in the json_instance to render + PointwiseMetricSpec.instance_prompt_template. type: object description: >- - Contains model information necessary to perform batch prediction without - requiring a full model import. - GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig: - description: >- - Configuration defining how to transform batch prediction input instances - to the instances that the Model accepts. + Pointwise metric instance. Usually one instance corresponds to one row + in an evaluation dataset. + id: GoogleCloudAiplatformV1PointwiseMetricInstance + GoogleCloudAiplatformV1AddExecutionEventsRequest: + id: GoogleCloudAiplatformV1AddExecutionEventsRequest properties: - excludedFields: + events: + description: The Events to create and add. items: - type: string - description: >- - Fields that will be excluded in the prediction instance that is sent - to the Model. Excluded will be attached to the batch prediction - output if key_field is not specified. When excluded_fields is - populated, included_fields must be empty. The input must be JSONL - with objects at each line, BigQuery or TfRecord. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Event' type: array - includedFields: + type: object + description: Request message for MetadataService.AddExecutionEvents. + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTextSentimentPredictionResult + type: object + description: Prediction output format for Text Sentiment + properties: + sentiment: description: >- - Fields that will be included in the prediction instance that is sent - to the Model. If instance_type is `array`, the order of field names - in included_fields also determines the order of the values in the - array. When included_fields is populated, excluded_fields must be - empty. The input must be JSONL with objects at each line, BigQuery - or TfRecord. - items: - type: string - type: array - instanceType: + The integer sentiment labels between 0 (inclusive) and sentimentMax + label (inclusive), while 0 maps to the least positive sentiment and + sentimentMax maps to the most positive one. The higher the score is, + the more positive the sentiment in the text snippet is. Note: + sentimentMax is an integer value between 1 (inclusive) and 10 + (inclusive). + type: integer + format: int32 + GoogleCloudAiplatformV1GenerationConfigRoutingConfig: + description: The configuration for routing the request to a specific model. + id: GoogleCloudAiplatformV1GenerationConfigRoutingConfig + properties: + manualMode: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode + description: Manual routing. + autoMode: + description: Automated routing. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode + type: object + GoogleCloudAiplatformV1ExportModelRequestOutputConfig: + id: GoogleCloudAiplatformV1ExportModelRequestOutputConfig + description: Output configuration for the Model export. + type: object + properties: + exportFormatId: + description: >- + The ID of the format in which the Model must be exported. Each Model + lists the export formats it supports. If no value is provided here, + then the first from the list of the Model's supported formats is + used by default. type: string + artifactDestination: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' description: >- - The format of the instance that the Model accepts. Vertex AI will - convert compatible batch prediction input instance formats to the - specified format. Supported values are: * `object`: Each input is - converted to JSON object format. * For `bigquery`, each row is - converted to an object. * For `jsonl`, each line of the JSONL input - must be an object. * Does not apply to `csv`, `file-list`, - `tf-record`, or `tf-record-gzip`. * `array`: Each input is converted - to JSON array format. * For `bigquery`, each row is converted to an - array. The order of columns is determined by the BigQuery column - order, unless included_fields is populated. included_fields must be - populated for specifying field orders. * For `jsonl`, if each line - of the JSONL input is an object, included_fields must be populated - for specifying field orders. * Does not apply to `csv`, `file-list`, - `tf-record`, or `tf-record-gzip`. If not specified, Vertex AI - converts the batch prediction input as follows: * For `bigquery` and - `csv`, the behavior is the same as `array`. The order of columns is - the same as defined in the file or table, unless included_fields is - populated. * For `jsonl`, the prediction instance format is - determined by each line of the input. * For - `tf-record`/`tf-record-gzip`, each record will be converted to an - object in the format of `{"b64": }`, where `` is the Base64-encoded - string of the content of the record. * For `file-list`, each file in - the list will be converted to an object in the format of `{"b64": - }`, where `` is the Base64-encoded string of the content of the - file. - keyField: + The Cloud Storage location where the Model artifact is to be written + to. Under the directory given as the destination a new one with name + "`model-export--`", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ + ISO-8601 format, will be created. Inside, the Model and any of its + supporting files will be written. This field should only be set when + the `exportableContent` field of the + [Model.supported_export_formats] object contains `ARTIFACT`. + imageDestination: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ContainerRegistryDestination description: >- - The name of the field that is considered as a key. The values - identified by the key field is not included in the transformed - instances that is sent to the Model. This is similar to specifying - this name of the field in excluded_fields. In addition, the batch - prediction output will not include the instances. Instead the output - will only include the value of the key field, in a field named `key` - in the output: * For `jsonl` output format, the output will have a - `key` field instead of the `instance` field. * For `csv`/`bigquery` - output format, the output will have have a `key` column instead of - the instance feature columns. The input must be JSONL with objects - at each line, CSV, BigQuery or TfRecord. + The Google Container Registry or Artifact Registry uri where the + Model container image will be copied to. This field should only be + set when the `exportableContent` field of the + [Model.supported_export_formats] object contains `IMAGE`. + GoogleCloudAiplatformV1ListNasJobsResponse: + type: object + properties: + nextPageToken: type: string + description: >- + A token to retrieve the next page of results. Pass to + ListNasJobsRequest.page_token to obtain that page. + nasJobs: + description: >- + List of NasJobs in the requested page. NasJob.nas_job_output of the + jobs will not be returned. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + description: Response message for JobService.ListNasJobs + id: GoogleCloudAiplatformV1ListNasJobsResponse + GoogleCloudAiplatformV1StreamRawPredictRequest: + description: Request message for PredictionService.StreamRawPredict. + id: GoogleCloudAiplatformV1StreamRawPredictRequest type: object - id: GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig - GoogleCloudAiplatformV1PublisherModel: properties: - supportedActions: - description: Optional. Supported call-to-action options. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToAction - openSourceCategory: - enum: - - OPEN_SOURCE_CATEGORY_UNSPECIFIED - - PROPRIETARY - - GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT - - THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT - - GOOGLE_OWNED_OSS - - THIRD_PARTY_OWNED_OSS - enumDescriptions: - - The open source category is unspecified, which should not be used. - - Used to indicate the PublisherModel is not open sourced. - - >- - Used to indicate the PublisherModel is a Google-owned open source - model w/ Google checkpoint. - - >- - Used to indicate the PublisherModel is a 3p-owned open source - model w/ Google checkpoint. - - >- - Used to indicate the PublisherModel is a Google-owned pure open - source model. - - >- - Used to indicate the PublisherModel is a 3p-owned pure open source - model. - description: Required. Indicates the open source category of the publisher model. + httpBody: + description: >- + The prediction input. Supports HTTP headers and arbitrary data + payload. + $ref: '#/components/schemas/GoogleApiHttpBody' + GoogleCloudAiplatformV1ScheduleRunResponse: + type: object + properties: + scheduledRunTime: + description: The scheduled run time based on the user-specified schedule. + format: google-datetime type: string - launchStage: - description: Optional. Indicates the launch stage of the model. + runResponse: + description: The response of the scheduled run. + type: string + description: Status of a scheduled run. + id: GoogleCloudAiplatformV1ScheduleRunResponse + GoogleCloudAiplatformV1StudySpecMetricSpec: + id: GoogleCloudAiplatformV1StudySpecMetricSpec + type: object + properties: + goal: type: string enum: - - LAUNCH_STAGE_UNSPECIFIED - - EXPERIMENTAL - - PRIVATE_PREVIEW - - PUBLIC_PREVIEW - - GA + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE + description: Required. The optimization goal of the metric. enumDescriptions: - - The model launch stage is unspecified. - - >- - Used to indicate the PublisherModel is at Experimental launch - stage, available to a small set of customers. - - >- - Used to indicate the PublisherModel is at Private Preview launch - stage, only available to a small set of customers, although a - larger set of customers than an Experimental launch. Previews are - the first launch stage used to get feedback from customers. - - >- - Used to indicate the PublisherModel is at Public Preview launch - stage, available to all customers, although not supported for - production workloads. - - >- - Used to indicate the PublisherModel is at GA launch stage, - available to all customers and ready for production workload. - frameworks: - type: array - items: - type: string - description: Optional. Additional information about the model's Frameworks. - publisherModelTemplate: - readOnly: true - type: string - description: >- - Optional. Output only. Immutable. Used to indicate this model has a - publisher model and provide the template of the publisher model - resource name. - versionState: - enum: - - VERSION_STATE_UNSPECIFIED - - VERSION_STATE_STABLE - - VERSION_STATE_UNSTABLE - type: string - enumDescriptions: - - The version state is unspecified. - - Used to indicate the version is stable. - - Used to indicate the version is unstable. - description: Optional. Indicates the state of the model version. - predictSchemata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. + metricId: description: >- - Optional. The schemata that describes formats of the - PublisherModel's predictions and explanations as given and returned - via PredictionService.Predict. - name: + Required. The ID of the metric. Must not contain whitespaces and + must be unique amongst all MetricSpecs. type: string - readOnly: true - description: Output only. The resource name of the PublisherModel. - versionId: + safetyConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig description: >- - Output only. Immutable. The version ID of the PublisherModel. A new - version is committed when a new model version is uploaded under an - existing model id. It is an auto-incrementing decimal number in - string representation. - type: string - readOnly: true - id: GoogleCloudAiplatformV1PublisherModel + Used for safe search. In the case, the metric will be a safety + metric. You must provide a separate metric for objective metric. + description: Represents a metric to optimize. + GoogleCloudAiplatformV1ResourcePool: type: object - description: A Model Garden Publisher Model. - GoogleCloudAiplatformV1ExplanationMetadata: - description: Metadata describing the Model's input and output for explanation. + description: >- + Represents the spec of a group of resources of the same type, for + example machine type, disk, and accelerators, in a PersistentResource. properties: - outputs: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata - description: >- - Required. Map from output names to output metadata. For Vertex - AI-provided Tensorflow images, keys can be any user defined string - that consists of any UTF-8 characters. For custom images, keys are - the name of the output field in the prediction to be explained. - Currently only one key is allowed. - type: object - latentSpaceSource: + usedReplicaCount: type: string description: >- - Name of the source to generate embeddings for example based - explanations. - inputs: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExplanationMetadataInputMetadata - type: object - description: >- - Required. Map from feature names to feature input metadata. Keys are - the name of the features. Values are the specification of the - feature. An empty InputMetadata is valid. It describes a text - feature which has the name specified as the key in - ExplanationMetadata.inputs. The baseline of the empty feature is - chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the - key can be any friendly name of the feature. Once specified, - featureAttributions are keyed by this key (if not grouped with - another feature). For custom images, the key must match with the key - in instance. - featureAttributionsSchemaUri: + Output only. The number of machines currently in use by training + jobs for this resource pool. Will replace idle_replica_count. + readOnly: true + format: int64 + replicaCount: type: string + format: int64 description: >- - Points to a YAML file stored on Google Cloud Storage describing the - format of the feature attributions. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML tabular Models always have this field populated by Vertex AI. - Note: The URI given on output may be different, including the URI - scheme, than the one given on input. The output URI will point to a - location where the user only has a read access. - id: GoogleCloudAiplatformV1ExplanationMetadata - type: object - GoogleCloudAiplatformV1ContainerRegistryDestination: - description: The Container Registry location for the container image. - properties: - outputUri: + Optional. The total number of machines to use for this resource + pool. + id: + description: >- + Immutable. The unique ID in a PersistentResource for referring to + this resource pool. User can specify it if necessary. Otherwise, + it's generated automatically. type: string + diskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DiskSpec' + description: Optional. Disk spec for the machine in this node pool. + machineSpec: + description: Required. Immutable. The specification of a single machine. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + autoscalingSpec: description: >- - Required. Container Registry URI of a container image. Only Google - Container Registry and Artifact Registry are supported now. Accepted - forms: * Google Container Registry path. For example: - `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For - example: - `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a - tag is not specified, "latest" will be used as the default tag. - id: GoogleCloudAiplatformV1ContainerRegistryDestination - type: object - GoogleCloudAiplatformV1GroundingMetadata: - type: object - id: GoogleCloudAiplatformV1GroundingMetadata + Optional. Optional spec to configure GKE or Ray-on-Vertex + autoscaling + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec + id: GoogleCloudAiplatformV1ResourcePool + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList: properties: - webSearchQueries: + features: type: array - description: Optional. Web search queries for the following-up web search. items: - type: string - searchEntryPoint: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SearchEntryPoint' - description: Optional. Google search entry for the following-up web searches. - description: Metadata returned to client when grounding is enabled. - GoogleCloudAiplatformV1UploadModelOperationMetadata: - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - description: Details of ModelService.UploadModel operation. - id: GoogleCloudAiplatformV1UploadModelOperationMetadata - type: object - GoogleCloudAiplatformV1CopyModelOperationMetadata: - description: Details of ModelService.CopyModel operation. - properties: - genericMetadata: - description: The common part of the operation metadata. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1CopyModelOperationMetadata - type: object - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair + description: List of feature names and values. type: object - description: Prediction output format for Image and Text Classification. + description: >- + Response structure in the format of key (feature name) and (feature) + value pair. id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionClassificationPredictionResult + GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + GoogleCloudAiplatformV1CustomJob: + id: GoogleCloudAiplatformV1CustomJob + type: object + description: >- + Represents a job that runs custom workloads such as a Docker container + or a Python package. A CustomJob can have multiple worker pools and each + worker pool can have its own machine and input spec. A CustomJob will be + cleaned up once the job enters terminal state (failed or succeeded). properties: - displayNames: - description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. - type: array - items: - type: string - ids: - items: - format: int64 - type: string - type: array - description: The resource IDs of the AnnotationSpecs that had been identified. - confidences: - type: array - items: - format: float - type: number + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + displayName: description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. - GoogleCloudAiplatformV1MergeVersionAliasesRequest: - properties: - versionAliases: + Required. The display name of the CustomJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + type: string + encryptionSpec: description: >- - Required. The set of version aliases to merge. The alias should be - at most 128 characters, and match `a-z{0,126}[a-z-0-9]`. Add the `-` - prefix to an alias means removing that alias from the version. `-` - is NOT counted in the 128 characters. Example: `-golden` means - removing the `golden` alias from the version. There is NO ordering - in aliases, which means 1) The aliases returned from GetModel API - might not have the exactly same order from this MergeVersionAliases - API. 2) Adding and deleting the same alias in the request is not - recommended, and the 2 operations will be cancelled out. - type: array - items: + Customer-managed encryption key options for a CustomJob. If this is + set, then all resources created by the CustomJob will be encrypted + with the provided encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + webAccessUris: + additionalProperties: type: string - type: object - id: GoogleCloudAiplatformV1MergeVersionAliasesRequest - description: Request message for ModelService.MergeVersionAliases. - GoogleCloudAiplatformV1SupervisedTuningSpec: - properties: - trainingDatasetUri: - type: string + type: object + readOnly: true description: >- - Required. Cloud Storage path to file containing training dataset for - tuning. The dataset must be formatted as a JSONL file. - validationDatasetUri: + Output only. URIs for accessing [interactive + shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + (one URI for each training node). Only available if + job_spec.enable_web_access is `true`. The keys are names of each + node in the training job; for example, `workerpool0-0` for the + primary node, `workerpool1-0` for the first node in the second + worker pool, and `workerpool1-1` for the second node in the second + worker pool. The values are the URIs for each node's interactive + shell. + updateTime: type: string - description: >- - Optional. Cloud Storage path to file containing validation dataset - for tuning. The dataset must be formatted as a JSONL file. - hyperParameters: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SupervisedHyperParameters - description: Optional. Hyperparameters for SFT. - type: object - id: GoogleCloudAiplatformV1SupervisedTuningSpec - description: Tuning Spec for Supervised Tuning. - GoogleCloudAiplatformV1PrivateEndpoints: - id: GoogleCloudAiplatformV1PrivateEndpoints - description: >- - PrivateEndpoints proto is used to provide paths for users to send - requests privately. To send request via private service access, use - predict_http_uri, explain_http_uri or health_http_uri. To send request - via private service connect, use service_attachment. - type: object - properties: - explainHttpUri: + description: Output only. Time when the CustomJob was most recently updated. + format: google-datetime readOnly: true + state: type: string - description: Output only. Http(s) path to send explain requests. - serviceAttachment: + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. readOnly: true + description: Output only. The detailed state of the job. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + error: description: >- - Output only. The name of the service attachment resource. Populated - if private service connect is enabled. - type: string - predictHttpUri: - description: Output only. Http(s) path to send prediction requests. + Output only. Only populated when job's state is `JOB_STATE_FAILED` + or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true - type: string - healthHttpUri: + satisfiesPzi: + type: boolean readOnly: true + description: Output only. Reserved for future use. + createTime: + readOnly: true + format: google-datetime type: string - description: Output only. Http(s) path to send health check requests. - GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata: - description: Details of operations that exports Features values. - id: GoogleCloudAiplatformV1ExportFeatureValuesOperationMetadata - type: object - properties: - genericMetadata: - description: Operation metadata for Featurestore export Feature values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1ModelDataStats: - type: object - id: GoogleCloudAiplatformV1ModelDataStats - description: Stats of data used for train or evaluate the Model. - properties: - trainingDataItemsCount: - type: string - format: int64 - description: Number of DataItems that were used for training this Model. - testDataItemsCount: - format: int64 + description: Output only. Time when the CustomJob was created. + labels: + type: object description: >- - Number of DataItems that were used for evaluating this Model. If the - Model is evaluated multiple times, this will be the number of test - DataItems used by the first evaluation. If the Model is not - evaluated, the number is 0. - type: string - trainingAnnotationsCount: + The labels with user-defined metadata to organize CustomJobs. Label + keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + additionalProperties: + type: string + name: type: string - description: Number of Annotations that are used for training this Model. - format: int64 - validationDataItemsCount: + readOnly: true + description: Output only. Resource name of a CustomJob. + jobSpec: + description: Required. Job spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + endTime: type: string - format: int64 - description: >- - Number of DataItems that were used for validating this Model during - training. - validationAnnotationsCount: + readOnly: true + format: google-datetime description: >- - Number of Annotations that are used for validating this Model during - training. + Output only. Time when the CustomJob entered any of the following + states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. + startTime: type: string - format: int64 - testAnnotationsCount: - format: int64 description: >- - Number of Annotations that are used for evaluating this Model. If - the Model is evaluated multiple times, this will be the number of - test Annotations used by the first evaluation. If the Model is not - evaluated, the number is 0. - type: string - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: - type: object - description: A TrainingJob that trains and uploads an AutoML Forecasting Model. - properties: - metadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata - description: The metadata information. - inputs: - description: The input parameters of this TrainingJob. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting - GoogleCloudAiplatformV1DeployedIndexAuthConfig: - type: object - description: Used to set up the auth on the DeployedIndex's private endpoint. - properties: - authProvider: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfigAuthProvider - description: Defines the authentication provider that the DeployedIndex uses. - id: GoogleCloudAiplatformV1DeployedIndexAuthConfig - GoogleCloudAiplatformV1SearchFeaturesResponse: - id: GoogleCloudAiplatformV1SearchFeaturesResponse + Output only. Time when the CustomJob for the first time entered the + `JOB_STATE_RUNNING` state. + format: google-datetime + readOnly: true + GoogleCloudAiplatformV1UndeployIndexRequest: properties: - nextPageToken: - description: >- - A token, which can be sent as SearchFeaturesRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. + deployedIndexId: type: string - features: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' description: >- - The Features matching the request. Fields returned: * `name` * - `description` * `labels` * `create_time` * `update_time` - type: array + Required. The ID of the DeployedIndex to be undeployed from the + IndexEndpoint. + description: Request message for IndexEndpointService.UndeployIndex. type: object - description: Response message for FeaturestoreService.SearchFeatures. - GoogleCloudAiplatformV1UpdateIndexOperationMetadata: - id: GoogleCloudAiplatformV1UpdateIndexOperationMetadata - properties: - nearestNeighborSearchOperationMetadata: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata - description: >- - The operation metadata with regard to Matching Engine Index - operation. - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. + id: GoogleCloudAiplatformV1UndeployIndexRequest + GoogleCloudAiplatformV1ModelExportFormat: type: object - description: Runtime operation information for IndexService.UpdateIndex. - GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse: properties: - nextPageToken: + id: type: string + readOnly: true description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationSlicesRequest.page_token to obtain that page. - modelEvaluationSlices: - description: List of ModelEvaluations in the requested page. + Output only. The ID of the export format. The possible format IDs + are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` + Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * + `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be + used in the browser and in Node.js using JavaScript. * `core-ml` + Used for iOS mobile devices. * `custom-trained` A Model that was + uploaded or trained by custom code. + exportableContents: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice' + type: string + enum: + - EXPORTABLE_CONTENT_UNSPECIFIED + - ARTIFACT + - IMAGE + enumDescriptions: + - Should not be used. + - >- + Model artifact and any of its supported files. Will be exported + to the location specified by the `artifactDestination` field of + the ExportModelRequest.output_config object. + - >- + The container image that is to be used when deploying this + Model. Will be exported to the location specified by the + `imageDestination` field of the ExportModelRequest.output_config + object. + readOnly: true + description: Output only. The content of this Model that may be exported. type: array - type: object - description: Response message for ModelService.ListModelEvaluationSlices. - id: GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse - GoogleCloudAiplatformV1FindNeighborsResponse: - type: object - description: The response message for MatchService.FindNeighbors. - properties: - nearestNeighbors: - type: array - description: The nearest neighbors of the query datapoints. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponseNearestNeighbors - id: GoogleCloudAiplatformV1FindNeighborsResponse - GoogleCloudAiplatformV1NotebookIdleShutdownConfig: - id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig - type: object + id: GoogleCloudAiplatformV1ModelExportFormat description: >- - The idle shutdown configuration of NotebookRuntimeTemplate, which - contains the idle_timeout as required field. - properties: - idleTimeout: - format: google-duration - type: string - description: >- - Required. Duration is accurate to the second. In Notebook, Idle - Timeout is accurate to minute so the range of idle_timeout (second) - is: 10 * 60 ~ 1440 * 60. - idleShutdownDisabled: - description: Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. - type: boolean - GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: - id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata - properties: {} - type: object - GoogleCloudAiplatformV1FindNeighborsRequest: - type: object + Represents export format supported by the Model. All formats export to + Google Cloud Storage. + GoogleCloudAiplatformV1FeatureStatsAnomaly: properties: - returnFullDatapoint: + score: + type: number + format: double description: >- - If set to true, the full datapoints (including all vector values and - restricts) of the nearest neighbors are returned. Note that - returning full datapoint will significantly increase the latency and - cost of the query. - type: boolean - queries: - type: array - description: The list of queries. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery - deployedIndexId: - type: string + Feature importance score, only populated when cross-feature + monitoring is enabled. For now only used to represent feature + attribution score within range [0, 1] for + ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and + ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT. + anomalyUri: description: >- - The ID of the DeployedIndex that will serve the request. This - request is sent to a specific IndexEndpoint, as per the - IndexEndpoint.network. That IndexEndpoint also has - IndexEndpoint.deployed_indexes, and each such index has a - DeployedIndex.id field. The value of the field below must equal one - of the DeployedIndex.id fields of the IndexEndpoint that is being - called for this request. - description: The request message for MatchService.FindNeighbors. - id: GoogleCloudAiplatformV1FindNeighborsRequest - GoogleCloudAiplatformV1UploadModelResponse: - id: GoogleCloudAiplatformV1UploadModelResponse - type: object - description: Response message of ModelService.UploadModel operation. - properties: - modelVersionId: - readOnly: true - description: Output only. The version ID of the model that is uploaded. - type: string - model: + Path of the anomaly file for current feature values in Cloud Storage + bucket. Format: gs:////anomalies. Example: + gs://monitoring_bucket/feature_name/anomalies. Stats are stored as + binary format with Protobuf message Anoamlies are stored as binary + format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] + (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto). type: string + anomalyDetectionThreshold: description: >- - The name of the uploaded Model resource. Format: - `projects/{project}/locations/{location}/models/{model}` - GoogleCloudAiplatformV1Annotation: - properties: - name: - description: Output only. Resource name of the Annotation. - readOnly: true - type: string - payload: - type: any - description: Required. The schema of the payload can be found in payload_schema. - createTime: + This is the threshold used when detecting anomalies. The threshold + can be changed by user, so this one might be different from + ThresholdConfig.value. + format: double + type: number + endTime: format: google-datetime - readOnly: true - type: string - description: Output only. Timestamp when this Annotation was created. - annotationSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UserActionReference' - description: Output only. The source of the Annotation. - readOnly: true - labels: - description: >- - Optional. The labels with user-defined metadata to organize your - Annotations. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. No more than 64 user labels can be associated with one - Annotation(System labels are excluded). See https://goo.gl/xmQnxf - for more information and examples of labels. System reserved label - keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. Following system labels exist for each Annotation: * - "aiplatform.googleapis.com/annotation_set_name": optional, name of - the UI's annotation set this Annotation belongs to. If not set, the - Annotation is not visible in the UI. * - "aiplatform.googleapis.com/payload_schema": output only, its value - is the payload_schema's title. - type: object - additionalProperties: - type: string - payloadSchemaUri: description: >- - Required. Google Cloud Storage URI points to a YAML file describing - payload. The schema is defined as an [OpenAPI 3.0.2 Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - The schema files that can be used here are found in - gs://google-cloud-aiplatform/schema/dataset/annotation/, note that - the chosen schema must be consistent with the parent Dataset's - metadata. + The end timestamp of window where stats were generated. For + objectives where time window doesn't make sense (e.g. Featurestore + Snapshot Monitoring), end_time indicates the timestamp of the data + used to generate stats (e.g. timestamp we take snapshots for feature + values). type: string - etag: + distributionDeviation: + description: >- + Deviation from the current stats to baseline stats. 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. + type: number + format: double + statsUri: type: string description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. - updateTime: - description: Output only. Timestamp when this Annotation was last updated. + Path of the stats file for current feature values in Cloud Storage + bucket. Format: gs:////stats. Example: + gs://monitoring_bucket/feature_name/stats. Stats are stored as + binary format with Protobuf message + [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto). + startTime: format: google-datetime - readOnly: true type: string + description: >- + The start timestamp of window where stats were generated. For + objectives where time window doesn't make sense (e.g. Featurestore + Snapshot Monitoring), start_time is only used to indicate the + monitoring intervals, so it always equals to (end_time - + monitoring_interval). type: object description: >- - Used to assign specific AnnotationSpec to a particular area of a - DataItem or the whole part of the DataItem. - id: GoogleCloudAiplatformV1Annotation - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation - type: object + Stats and Anomaly generated at specific timestamp for specific Feature. + The start_time and end_time are used to define the time range of the + dataset that current stats belongs to, e.g. prediction traffic is + bucketed into prediction datasets by time window. If the Dataset is not + defined by time window, start_time = end_time. Timestamp of the stats + and anomalies always refers to end_time. Raw stats and anomalies are + stored in stats_uri or anomaly_uri in the tensorflow defined protos. + Field data_stats contains almost identical information with the raw + stats in Vertex AI defined proto, for UI to display. + id: GoogleCloudAiplatformV1FeatureStatsAnomaly + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation: properties: - timeFormat: + vertexes: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaVertex' + type: array description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) + The vertexes are connected one by one and the last vertex in not + connected to the first one. + displayName: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. type: string - columnName: + annotationSpecId: type: string - invalidValuesAllowed: - type: boolean description: >- - If invalid values is allowed, the training pipeline will create a - boolean feature that indicated whether the value is valid. - Otherwise, the training pipeline will discard the input row from - trainining data. - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the * timestamp - as a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: + The resource Id of the AnnotationSpec that this Annotation pertains + to. + description: Represents a polyline in image. type: object - id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse - description: Response message of ModelService.UpdateExplanationDataset operation. - properties: {} - GoogleCloudAiplatformV1GenerationConfig: - id: GoogleCloudAiplatformV1GenerationConfig + id: >- + GoogleCloudAiplatformV1SchemaImageSegmentationAnnotationPolylineAnnotation + GoogleCloudAiplatformV1ListEndpointsResponse: type: object - description: Generation config. properties: - stopSequences: - description: Optional. Stop sequences. - type: array + endpoints: items: - type: string - maxOutputTokens: - format: int32 + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + type: array + description: List of Endpoints in the requested page. + nextPageToken: + type: string description: >- - Optional. The maximum number of output tokens to generate per - message. - type: integer - responseSchema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + A token to retrieve the next page of results. Pass to + ListEndpointsRequest.page_token to obtain that page. + description: Response message for EndpointService.ListEndpoints. + id: GoogleCloudAiplatformV1ListEndpointsResponse + GoogleCloudAiplatformV1SchemaImageDataItem: + id: GoogleCloudAiplatformV1SchemaImageDataItem + type: object + properties: + gcsUri: + type: string description: >- - Optional. The `Schema` object allows the definition of input and - output data types. These types can be objects, but also primitives - and arrays. Represents a select subset of an [OpenAPI 3.0 schema - object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a - compatible response_mime_type must also be set. Compatible - mimetypes: `application/json`: Schema for JSON response. - frequencyPenalty: - description: Optional. Frequency penalties. - type: number - format: float - topP: - type: number - format: float - description: Optional. If specified, nucleus sampling will be used. - candidateCount: - type: integer - format: int32 - description: Optional. Number of candidates to generate. - responseMimeType: + Required. Google Cloud Storage URI points to the original image in + user's bucket. The image is up to 30MB in size. + mimeType: type: string + readOnly: true description: >- - Optional. Output response mimetype of the generated candidate text. - Supported mimetype: - `text/plain`: (default) Text output. - - `application/json`: JSON response in the candidates. The model needs - to be prompted to output the appropriate response type, otherwise - the behavior is undefined. This is a preview feature. - temperature: - description: Optional. Controls the randomness of predictions. - type: number - format: float - topK: - description: Optional. If specified, top-k sampling will be used. - format: float - type: number - presencePenalty: - type: number - description: Optional. Positive penalties. - format: float - GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult: + Output only. The mime type of the content of the image. Only the + images in below listed mime types are supported. - image/jpeg - + image/gif - image/png - image/webp - image/bmp - image/tiff - + image/vnd.microsoft.icon + description: Payload of Image DataItem. + GoogleCloudAiplatformV1MigratableResourceAutomlModel: + description: Represents one Model in automl.googleapis.com. + id: GoogleCloudAiplatformV1MigratableResourceAutomlModel properties: - classes: - items: - type: string + modelDisplayName: + description: The Model's display name in automl.googleapis.com. + type: string + model: description: >- - The name of the classes being classified, contains all possible - values of the target column. - type: array - scores: - items: - format: float - type: number - type: array + Full resource name of automl Model. Format: + `projects/{project}/locations/{location}/models/{model}`. + type: string + type: object + GoogleCloudAiplatformV1FunctionCall: + properties: + name: description: >- - The model's confidence in each class being correct, higher value - means higher confidence. The N-th score corresponds to the N-th - class in classes. - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionTabularClassificationPredictionResult - description: Prediction output format for Tabular Classification. + Required. The name of the function to call. Matches + [FunctionDeclaration.name]. + type: string + args: + additionalProperties: + description: Properties of the object. + type: any + type: object + description: >- + Optional. Required. The function parameters and values in JSON + object format. See [FunctionDeclaration.parameters] for parameter + details. + id: GoogleCloudAiplatformV1FunctionCall type: object - GoogleCloudAiplatformV1UndeployModelOperationMetadata: - id: GoogleCloudAiplatformV1UndeployModelOperationMetadata + description: >- + A predicted [FunctionCall] returned from the model that contains a + string representing the [FunctionDeclaration.name] and a structured JSON + object containing the parameters and their values. + GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata: properties: genericMetadata: - description: The operation generic information. + description: Operation metadata for FeatureGroup. $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Runtime operation information for EndpointService.UndeployModel. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig: - description: Configuration for exporting test set predictions to a BigQuery table. + description: Details of operations that perform create FeatureGroup. + id: GoogleCloudAiplatformV1CreateFeatureGroupOperationMetadata type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs: properties: - overrideExistingTable: - description: >- - If true and an export destination is specified, then the contents of - the destination are overwritten. Otherwise, if the export - destination already exists, then the export operation fails. + multiLabel: type: boolean - destinationBigqueryUri: - type: string - description: >- - URI of desired destination BigQuery table. Expected format: - `bq://{project_id}:{dataset_id}:{table}` If not specified, then - results are exported to the following auto-created BigQuery table: - `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples` + type: object id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig - GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig: - properties: {} - description: Configuration options for using brute force search. - id: GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs + GoogleCloudAiplatformV1CoherenceInstance: + description: Spec for coherence instance. + properties: + prediction: + type: string + description: Required. Output of the evaluated model. + id: GoogleCloudAiplatformV1CoherenceInstance type: object - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: - description: Entity view with Feature values. + GoogleCloudAiplatformV1GroundednessSpec: type: object properties: - data: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData - description: >- - Each piece of data holds the k requested values for one requested - Feature. If no values for the requested Feature exist, the - corresponding cell will be empty. This has the same size and is in - the same order as the features from the header - ReadFeatureValuesResponse.header. + version: + description: Optional. Which version to use for evaluation. + format: int32 + type: integer + description: Spec for groundedness metric. + id: GoogleCloudAiplatformV1GroundednessSpec + GoogleCloudAiplatformV1StringArray: + id: GoogleCloudAiplatformV1StringArray + properties: + values: type: array - entityId: - description: ID of the requested entity. - type: string - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView + items: + type: string + description: A list of string values. + type: object + description: A list of string values. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting: + properties: + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + description: The metadata information. + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputs + description: The input parameters of this TrainingJob. + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecasting + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. + type: object GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec: id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec + type: object + description: Represent spec for train trials. properties: - trainTrialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: >- - Required. The spec of a train trial job. The same spec applies to - all train trials. frequency: - format: int32 description: >- Required. Frequency of search trials to start train stage. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched. + format: int32 type: integer + trainTrialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + description: >- + Required. The spec of a train trial job. The same spec applies to + all train trials. maxParallelTrialCount: + type: integer description: Required. The maximum number of trials to run in parallel. format: int32 - type: integer + GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec: type: object - description: Represent spec for train trials. - GoogleCloudAiplatformV1ImportFeatureValuesResponse: + description: Represents a metric to optimize. properties: - timestampOutsideRetentionRowsCount: + goal: + enumDescriptions: + - Goal Type will default to maximize. + - Maximize the goal metric. + - Minimize the goal metric. + enum: + - GOAL_TYPE_UNSPECIFIED + - MAXIMIZE + - MINIMIZE + description: Required. The optimization goal of the metric. type: string - format: int64 - description: >- - The number rows that weren't ingested due to having feature - timestamps outside the retention boundary. - invalidRowCount: + metricId: type: string - description: >- - The number of rows in input source that weren't imported due to - either * Not having any featureValues. * Having a null entityId. * - Having a null timestamp. * Not being parsable (applicable for CSV - sources). - format: int64 - importedEntityCount: - description: Number of entities that have been imported by the operation. + description: Required. The ID of the metric. Must not contain whitespaces. + id: GoogleCloudAiplatformV1NasJobSpecMultiTrialAlgorithmSpecMetricSpec + GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData: + properties: + viewCount: type: string format: int64 - importedFeatureValueCount: - format: int64 - description: Number of Feature values that have been imported by the operation. + description: Number of times the user has read data within the Tensorboard. + username: type: string - description: Response message for FeaturestoreService.ImportFeatureValues. + description: User's username + description: Per user usage data. type: object - id: GoogleCloudAiplatformV1ImportFeatureValuesResponse - GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata: + id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData + GoogleProtobufEmpty: + id: GoogleProtobufEmpty + type: object + properties: {} description: >- - Runtime operation information for - MigrationService.BatchMigrateResources. + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: + description: >- + Training pipeline will perform following transformation functions. * The + text as is--no change to case, punctuation, spelling, tense, and so on. + * Convert the category name to a dictionary lookup index and generate an + embedding for each index. + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - partialResults: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadataPartialResult + columnName: + type: string + GoogleCloudAiplatformV1NasJobOutput: + type: object + description: Represents a uCAIP NasJob output. + properties: + multiTrialJobOutput: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput description: >- - Partial results that reflect the latest migration operation - progress. - type: array - id: GoogleCloudAiplatformV1BatchMigrateResourcesOperationMetadata + Output only. The output of this multi-trial Neural Architecture + Search (NAS) job. + id: GoogleCloudAiplatformV1NasJobOutput + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: type: object - GoogleCloudAiplatformV1SchemaImageDatasetMetadata: - id: GoogleCloudAiplatformV1SchemaImageDatasetMetadata + description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. + properties: + inputs: + description: The input parameters of this TrainingJob. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction + GoogleCloudAiplatformV1LookupStudyRequest: type: object properties: - dataItemSchemaUri: + displayName: + description: Required. The user-defined display name of the Study type: string + id: GoogleCloudAiplatformV1LookupStudyRequest + description: Request message for VizierService.LookupStudy. + GoogleCloudAiplatformV1PrivateServiceConnectConfig: + properties: + serviceAttachment: + readOnly: true description: >- - Points to a YAML file stored on Google Cloud Storage describing - payload of the Image DataItems that belong to this Dataset. - gcsBucket: + Output only. The name of the generated service attachment resource. + This is only populated if the endpoint is deployed with + PrivateServiceConnect. type: string + enablePrivateServiceConnect: + type: boolean description: >- - Google Cloud Storage Bucket name that contains the blob data of this - Dataset. - description: The metadata of Datasets that contain Image DataItems. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata: - properties: - trainCostMilliNodeHours: + Required. If true, expose the IndexEndpoint via private service + connect. + projectAllowlist: + type: array description: >- - Output only. The actual training cost of the model, expressed in - milli node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed the train budget. - type: string - format: int64 - evaluatedDataItemsBigqueryUri: - type: string - description: BigQuery destination uri for exported evaluated examples. - type: object - description: Model metadata specific to AutoML Forecasting. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata - GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata: - type: object - id: GoogleCloudAiplatformV1CreateDatasetVersionOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - description: Runtime operation information for DatasetService.CreateDatasetVersion. - GoogleCloudAiplatformV1FeatureGroupBigQuery: - properties: - entityIdColumns: + A list of Projects from which the forwarding rule will target the + service attachment. items: type: string - type: array - description: >- - Optional. Columns to construct entity_id / row keys. If not provided - defaults to `entity_id`. - bigQuerySource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' - description: >- - Required. Immutable. The BigQuery source URI that points to either a - BigQuery Table or View. - id: GoogleCloudAiplatformV1FeatureGroupBigQuery + id: GoogleCloudAiplatformV1PrivateServiceConnectConfig + description: Represents configuration for private service connect. type: object - description: Input source type for BigQuery Tables and Views. - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: + GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest: + id: GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest properties: - references: - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference - description: Required. - resourceTitle: - description: Optional. Title of the resource. - type: string - title: - type: string - description: 'Required. ' - resourceUseCase: + notebookExecutionJob: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' + description: Required. The NotebookExecutionJob to create. + parent: type: string - description: Optional. Use case (CUJ) of the resource. - resourceDescription: - description: Optional. Description of the resource. + description: >- + Required. The resource name of the Location to create the + NotebookExecutionJob. Format: + `projects/{project}/locations/{location}` + notebookExecutionJobId: + description: Optional. User specified ID for the NotebookExecutionJob. type: string type: object - description: >- - The regional resource name or the URI. Key is region, e.g., us-central1, - europe-west2, global, etc.. - id: >- - GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences - GoogleCloudAiplatformV1StructFieldValue: + description: Request message for [NotebookService.CreateNotebookExecutionJob] + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecasting + type: object + description: A TrainingJob that trains and uploads an AutoML Forecasting Model. properties: - name: - type: string - description: Name of the field in the struct feature. - value: - description: The value for this field. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + metadata: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingMetadata + description: The metadata information. + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputs + description: The input parameters of this TrainingJob. + GoogleCloudAiplatformV1ListTensorboardExperimentsResponse: type: object - id: GoogleCloudAiplatformV1StructFieldValue - description: One field of a Struct (or object) type feature value. - GoogleCloudAiplatformV1ExamplesExampleGcsSource: - description: The Cloud Storage input instances. - id: GoogleCloudAiplatformV1ExamplesExampleGcsSource properties: - dataFormat: - description: >- - The format in which instances are given, if not specified, assume - it's JSONL format. Currently only JSONL format is supported. + nextPageToken: type: string - enumDescriptions: - - Format unspecified, used when unset. - - Examples are stored in JSONL files. - enum: - - DATA_FORMAT_UNSPECIFIED - - JSONL - gcsSource: - description: The Cloud Storage location for the input instances. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: >- + A token, which can be sent as + ListTensorboardExperimentsRequest.page_token to retrieve the next + page. If this field is omitted, there are no subsequent pages. + tensorboardExperiments: + description: The TensorboardExperiments mathching the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment' + description: Response message for TensorboardService.ListTensorboardExperiments. + id: GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + GoogleCloudAiplatformV1ShieldedVmConfig: + properties: + enableSecureBoot: + type: boolean + description: >- + Defines whether the instance has [Secure + Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) + enabled. Secure Boot helps ensure that the system only runs + authentic software by verifying the digital signature of all boot + components, and halting the boot process if signature verification + fails. type: object - GoogleCloudAiplatformV1MetadataStore: - id: GoogleCloudAiplatformV1MetadataStore + id: GoogleCloudAiplatformV1ShieldedVmConfig description: >- - Instance of a metadata store. Contains a set of metadata that can be - queried. + A set of Shielded Instance options. See [Images using supported Shielded + VM + features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). + GoogleCloudAiplatformV1Model: + description: A trained machine learning Model. + id: GoogleCloudAiplatformV1Model properties: - name: - description: Output only. The resource name of the MetadataStore instance. - type: string + dataStats: + description: >- + Stats of data used for training or evaluating the Model. Only + populated when the Model is trained by a TrainingPipeline with + data_input_config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' + supportedDeploymentResourcesTypes: + type: array + items: + enum: + - DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED + - DEDICATED_RESOURCES + - AUTOMATIC_RESOURCES + - SHARED_RESOURCES + type: string + enumDescriptions: + - Should not be used. + - >- + Resources that are dedicated to the DeployedModel, and that need + a higher degree of manual configuration. + - >- + Resources that to large degree are decided by Vertex AI, and + require only a modest additional configuration. + - >- + Resources that can be shared by multiple DeployedModels. A + pre-configured DeploymentResourcePool is required. + description: >- + Output only. When this Model is deployed, its prediction resources + are described by the `prediction_resources` field of the + Endpoint.deployed_models object. Because not all Models support all + resource configuration types, the configuration types this Model + supports are listed here. If no configuration types are listed, the + Model cannot be deployed to an Endpoint and does not support online + predictions (PredictionService.Predict or + PredictionService.Explain). Such a Model can serve predictions by + using a BatchPredictionJob, if it has at least one entry each in + supported_input_storage_formats and + supported_output_storage_formats. readOnly: true - state: - description: Output only. State information of the MetadataStore. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + versionId: + description: >- + Output only. Immutable. The version ID of the model. A new version + is committed when a new model version is uploaded or trained under + an existing model id. It is an auto-incrementing decimal number in + string representation. + type: string readOnly: true createTime: - format: google-datetime - type: string - description: Output only. Timestamp when this MetadataStore was created. + description: Output only. Timestamp when this Model was uploaded into Vertex AI. readOnly: true - encryptionSpec: - description: >- - Customer-managed encryption key spec for a Metadata Store. If set, - this Metadata Store and all sub-resources of this Metadata Store are - secured using this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: - type: string - description: Description of the MetadataStore. - updateTime: - type: string format: google-datetime - description: Output only. Timestamp when this MetadataStore was last updated. - readOnly: true - dataplexConfig: - description: Optional. Dataplex integration settings. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig - type: object - GoogleCloudAiplatformV1FunctionResponse: - properties: - response: - type: object - additionalProperties: - type: any - description: Properties of the object. - description: Required. The function response in JSON object format. - name: type: string + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + containerSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' description: >- - Required. The name of the function to call. Matches - [FunctionDeclaration.name] and [FunctionCall.name]. - id: GoogleCloudAiplatformV1FunctionResponse - description: >- - The result output from a [FunctionCall] that contains a string - representing the [FunctionDeclaration.name] and a structured JSON object - containing any output from the function is used as context to the model. - This should contain the result of a [FunctionCall] made based on model - prediction. - type: object - GoogleCloudAiplatformV1DedicatedResources: - properties: - maxReplicaCount: - format: int32 - description: >- - Immutable. The maximum number of replicas this DeployedModel may be - deployed on when the traffic against it increases. If the requested - value is too large, the deployment will error, but if deployment - succeeds then the ability to scale the model to that many replicas - is guaranteed (barring service outages). If traffic against the - DeployedModel increases beyond what its replicas at maximum may - handle, a portion of the traffic will be dropped. If this value is - not provided, will use min_replica_count as the default value. The - value of this field impacts the charge against Vertex CPU and GPU - quotas. Specifically, you will be charged for (max_replica_count * - number of cores in the selected machine type) and (max_replica_count - * number of GPUs per replica in the selected machine type). - type: integer - machineSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' - description: >- - Required. Immutable. The specification of a single machine used by - the prediction. - minReplicaCount: - format: int32 + Input only. The specification of the container that is to be used + when deploying this Model. The specification is ingested upon + ModelService.UploadModel, and all binaries it contains are copied + and stored internally by Vertex AI. Not required for AutoML Models. + versionAliases: description: >- - Required. Immutable. The minimum number of machine replicas this - DeployedModel will be always deployed on. This value must be greater - than or equal to 1. If traffic against the DeployedModel increases, - it may dynamically be deployed onto more replicas, and as traffic - decreases, some of these extra replicas may be freed. - type: integer - autoscalingMetricSpecs: + User provided version aliases so that a model version can be + referenced via alias (i.e. + `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` + instead of auto-generated version id (i.e. + `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. + The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A + default version alias will be created for the first version of the + model, and there must be exactly one default version alias for a + model. + items: + type: string type: array + deployedModels: + readOnly: true description: >- - Immutable. The metric specifications that overrides a resource - utilization metric (CPU utilization, accelerator's duty cycle, and - so on) target value (default to 60 if not set). At most one entry is - allowed per metric. If machine_spec.accelerator_count is above 0, - the autoscaling will be based on both CPU utilization and - accelerator's duty cycle metrics and scale up when either metrics - exceeds its target value while scale down if both metrics are under - their target value. The default target value is 60 for both metrics. - If machine_spec.accelerator_count is 0, the autoscaling will be - based on CPU utilization metric only with default target value 60 if - not explicitly set. For example, in the case of Online Prediction, - if you want to override target CPU utilization to 80, you should set - autoscaling_metric_specs.metric_name to - `aiplatform.googleapis.com/prediction/online/cpu/utilization` and - autoscaling_metric_specs.target to `80`. + Output only. The pointers to DeployedModels created from this Model. + Note that Model could have been deployed to Endpoints in different + Locations. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AutoscalingMetricSpec' - id: GoogleCloudAiplatformV1DedicatedResources - description: >- - A description of resources that are dedicated to a DeployedModel, and - that need a higher degree of manual configuration. - type: object - GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata: - type: object - properties: - genericMetadata: - description: The operation generic information. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - id: GoogleCloudAiplatformV1UpdateDeploymentResourcePoolOperationMetadata - description: Runtime operation information for UpdateDeploymentResourcePool method. - GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig: - type: object - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig - properties: - monitorWindow: - format: google-duration - type: string + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModelRef' + type: array + baseModelSource: description: >- - The time window of the prediction data being included in each - prediction dataset. This window specifies how long the data should - be collected from historical model results for each run. If not set, - ModelDeploymentMonitoringScheduleConfig.monitor_interval will be - used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and - the monitor_window is set to be 3600, then data from 2022-01-08 - 13:30:00 to 2022-01-08 14:30:00 will be retrieved and aggregated to - calculate the monitoring statistics. - monitorInterval: - format: google-duration + Optional. User input field to specify the base model source. + Currently it only supports specifing the Model Garden models and + Genie models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelBaseModelSource' + versionCreateTime: + readOnly: true + description: Output only. Timestamp when this version was created. + format: google-datetime + type: string + etag: type: string description: >- - Required. The model monitoring job scheduling interval. It will be - rounded up to next full hour. This defines how often the monitoring - jobs are triggered. - description: The config for scheduling monitoring job. - GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec: - properties: - defaultValue: + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + predictSchemata: description: >- - A default value for a `DISCRETE` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. It automatically rounds to the nearest - feasible discrete point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - format: double - type: number - values: - type: array + The schemata that describe formats of the Model's predictions and + explanations as given and returned via PredictionService.Predict and + PredictionService.Explain. + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictSchemata' + modelSourceInfo: description: >- - Required. A list of possible values. The list should be in - increasing order and at least 1e-10 apart. For instance, this - parameter might have possible settings of 1.5, 2.5, and 4.0. This - list should not contain more than 1,000 values. - items: - format: double - type: number - id: GoogleCloudAiplatformV1StudySpecParameterSpecDiscreteValueSpec - description: Value specification for a parameter in `DISCRETE` type. - type: object - GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: - properties: - uri: + Output only. Source of a model. It can either be automl training + pipeline, custom training pipeline, BigQuery ML, or saved and tuned + from Genie or Model Garden. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelSourceInfo' + supportedOutputStorageFormats: items: type: string - description: >- - Cloud Storage URI of one or more files. Only CSV files are - supported. The first line of the CSV file is used as the header. If - there are multiple files, the header is the first line of the - lexicographically first file, the other files must either contain - the exact same header or omit the header. type: array - id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource - type: object - GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation: - id: GoogleCloudAiplatformV1SchemaVideoActionRecognitionAnnotation - properties: - annotationSpecId: + description: >- + Output only. The formats this Model supports in + BatchPredictionJob.output_config. If both + PredictSchemata.instance_schema_uri and + PredictSchemata.prediction_schema_uri exist, the predictions are + returned together with their instances. In other words, the + prediction has the original instance data first, followed by the + actual prediction content (as per the schema). The possible formats + are: * `jsonl` The JSON Lines format, where each prediction is a + single line. Uses GcsDestination. * `csv` The CSV format, where each + prediction is a single comma-separated line. The first line in the + file is the header, containing comma-separated field names. Uses + GcsDestination. * `bigquery` Each prediction is a single row in a + BigQuery table, uses BigQueryDestination . If this Model doesn't + support any of these formats it means it cannot be used with a + BatchPredictionJob. However, if it has + supported_deployment_resources_types, it could serve online + predictions by using PredictionService.Predict or + PredictionService.Explain. + readOnly: true + metadata: + description: >- + Immutable. An additional information about the Model; the schema of + the metadata can be found in metadata_schema. Unset if the Model + does not have any additional information. + type: any + metadataSchemaUri: type: string description: >- - The resource Id of the AnnotationSpec that this Annotation pertains - to. - timeSegment: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + Immutable. Points to a YAML file stored on Google Cloud Storage + describing additional information about the Model, that is specific + to it. Unset if the Model does not have any additional information. + The schema is defined as an OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + AutoML Models always have this field populated by Vertex AI, if no + additional metadata is needed, this field is set to an empty string. + Note: The URI given on output will be immutable and probably + different, including the URI scheme, than the one given on input. + The output URI will point to a location where the user only has a + read access. + supportedExportFormats: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExportFormat' description: >- - This Annotation applies to the time period represented by the - TimeSegment. If it's not set, the Annotation applies to the whole - video. - displayName: + Output only. The formats in which this Model may be exported. If + empty, this Model is not available for export. + artifactUri: type: string description: >- - The display name of the AnnotationSpec that this Annotation pertains - to. - description: Annotation details specific to video action recognition. - type: object - GoogleCloudAiplatformV1ListSavedQueriesResponse: - id: GoogleCloudAiplatformV1ListSavedQueriesResponse - properties: - nextPageToken: - type: string - description: The standard List next-page token. - savedQueries: - description: >- - A list of SavedQueries that match the specified filter in the - request. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SavedQuery' + Immutable. The path to the directory containing the Model artifact + and any of its supporting files. Not required for AutoML Models. + supportedInputStorageFormats: type: array - type: object - description: Response message for DatasetService.ListSavedQueries. - GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig: - type: object - properties: - deployedModelId: - description: The DeployedModel ID of the objective config. - type: string - objectiveConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringObjectiveConfig - description: >- - The objective config of for the modelmonitoring job of this deployed - model. - description: >- - ModelDeploymentMonitoringObjectiveConfig contains the pair of - deployed_model_id to ModelMonitoringObjectiveConfig. - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig - GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: - id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata - properties: - systemInstruction: - type: string - description: The content of the prompt dataset system instruction. - systemInstructionGcsUri: - type: string - description: >- - The Google Cloud Storage URI that stores the system instruction, - starting with gs://. - maxOutputTokens: - format: int64 - type: string - description: >- - Value of the maximum number of tokens generated set when the dataset - was saved. - topP: - format: float - description: >- - Top P value set when the dataset was saved. Given topK tokens for - decoding, top candidates will be selected until the sum of their - probabilities is topP. - type: number - topK: - format: int64 - description: >- - Top K value set when the dataset was saved. This value determines - how many candidates with highest probability from the vocab would be - selected for each decoding step. - type: string - temperature: + readOnly: true description: >- - Temperature value used for sampling set when the dataset was saved. - This value is used to tune the degree of randomness. - type: number - format: float - groundingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig - description: Grounding checking configuration. - gcsUri: - type: string - description: The Google Cloud Storage URI that stores the prompt data. - promptType: - description: Type of the prompt dataset. - type: string - note: - type: string - description: User-created prompt note. Note size limit is 2KB. - hasPromptVariable: - description: Whether the prompt dataset has prompt variable. - type: boolean - candidateCount: - format: int64 - description: Number of candidates. - type: string - stopSequences: + Output only. The formats this Model supports in + BatchPredictionJob.input_config. If + PredictSchemata.instance_schema_uri exists, the instances should be + given as per that schema. The possible formats are: * `jsonl` The + JSON Lines format, where each instance is a single line. Uses + GcsSource. * `csv` The CSV format, where each instance is a single + comma-separated line. The first line in the file is the header, + containing comma-separated field names. Uses GcsSource. * + `tf-record` The TFRecord format, where each instance is a single + record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` + Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * + `bigquery` Each instance is a single row in BigQuery. Uses + BigQuerySource. * `file-list` Each line of the file is the location + of an instance to process, uses `gcs_source` field of the + InputConfig object. If this Model doesn't support any of these + formats it means it cannot be used with a BatchPredictionJob. + However, if it has supported_deployment_resources_types, it could + serve online predictions by using PredictionService.Predict or + PredictionService.Explain. items: type: string - description: Customized stop sequences. - type: array - text: - type: string - description: The content of the prompt dataset. - type: object - description: The metadata of Datasets that contain Text Prompt data. - GoogleCloudAiplatformV1Index: - properties: - createTime: - format: google-datetime - description: Output only. Timestamp when this Index was created. + explanationSpec: + description: >- + The default explanation specification for this Model. The Model can + be used for requesting explanation after being deployed if it is + populated. The Model can be used for batch explanation if it is + populated. All fields of the explanation_spec can be overridden by + explanation_spec of DeployModelRequest.deployed_model, or + explanation_spec of BatchPredictionJob. If the default explanation + specification is not set for this Model, this Model can still be + used for requesting explanation by setting explanation_spec of + DeployModelRequest.deployed_model and for batch explanation by + setting explanation_spec of BatchPredictionJob. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpec' + satisfiesPzs: + type: boolean + description: Output only. Reserved for future use. readOnly: true + versionUpdateTime: + format: google-datetime + description: Output only. Timestamp when this version was most recently updated. type: string - indexUpdateMethod: - enum: - - INDEX_UPDATE_METHOD_UNSPECIFIED - - BATCH_UPDATE - - STREAM_UPDATE - type: string - enumDescriptions: - - Should not be used. - - >- - BatchUpdate: user can call UpdateIndex with files on Cloud Storage - of Datapoints to update. - - >- - StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to - update the Index and the updates will be applied in corresponding - DeployedIndexes in nearly real-time. - description: >- - Immutable. The update method to use with this Index. If not set, - BATCH_UPDATE will be used by default. + readOnly: true updateTime: - description: >- - Output only. Timestamp when this Index was most recently updated. - This also includes any update to the contents of the Index. Note - that Operations working on this Index may have their - Operations.metadata.generic_metadata.update_time a little after the - value of this timestamp, yet that does not mean their results are - not already reflected in the Index. Result of any successfully - completed Operation on the Index is reflected in it. - type: string + description: Output only. Timestamp when this Model was most recently updated. format: google-datetime readOnly: true - metadata: - type: any - description: >- - An additional information about the Index; the schema of the - metadata can be found in metadata_schema. - metadataSchemaUri: - type: string - description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing additional information about the Index, that is specific - to it. Unset if the Index does not have any additional information. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - Note: The URI given on output will be immutable and probably - different, including the URI scheme, than the one given on input. - The output URI will point to a location where the user only has a - read access. - name: - readOnly: true - description: Output only. The resource name of the Index. - type: string - displayName: - description: >- - Required. The display name of the Index. The name can be up to 128 - characters long and can consist of any UTF-8 characters. type: string - deployedIndexes: - readOnly: true - type: array - description: >- - Output only. The pointers to DeployedIndexes created from this - Index. An Index can be only deleted if all its DeployedIndexes had - been undeployed first. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexRef' description: + description: The description of the Model. type: string - description: The description of the Index. - indexStats: - readOnly: true - description: Output only. Stats of the index resource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexStats' - etag: + trainingPipeline: description: >- - Used to perform consistent read-modify-write updates. If not set, a - blind "overwrite" update happens. + Output only. The resource name of the TrainingPipeline that uploaded + this Model, if any. type: string + readOnly: true labels: type: object + additionalProperties: + type: string description: >- - The labels with user-defined metadata to organize your Indexes. - Label keys and values can be no longer than 64 characters (Unicode + The labels with user-defined metadata to organize your Models. Label + keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - additionalProperties: - type: string + versionDescription: + type: string + description: The description of this version. + metadataArtifact: + type: string + readOnly: true + description: >- + Output only. The resource name of the Artifact that was created in + MetadataStore when creating the Model. The Artifact resource name + pattern is + `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + pipelineJob: + description: >- + Optional. This field is populated if the model is produced by a + pipeline job. + type: string + displayName: + description: >- + Required. The display name of the Model. The name can be up to 128 + characters long and can consist of any UTF-8 characters. + type: string encryptionSpec: + description: >- + Customer-managed encryption key spec for a Model. If set, this Model + and all sub-resources of this Model will be secured by this key. $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + name: + description: The resource name of the Model. + type: string + originalModelInfo: description: >- - Immutable. Customer-managed encryption key spec for an Index. If - set, this Index and all sub-resources of this Index will be secured - by this key. + Output only. If this Model is a copy of another Model, this contains + info about the original. + readOnly: true + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelOriginalModelInfo' type: object - description: >- - A representation of a collection of database items organized in a way - that allows for approximate nearest neighbor (a.k.a ANN) algorithms - search. - id: GoogleCloudAiplatformV1Index - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata: - id: >- - GoogleCloudAiplatformV1SchemaVisualInspectionClassificationLabelSavedQueryMetadata + GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata: + id: GoogleCloudAiplatformV1CreateFeatureViewOperationMetadata + description: Details of operations that perform create FeatureView. type: object properties: - multiLabel: - description: Whether or not the classification label is multi_label. - type: boolean - GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest: - id: GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest - description: Request message for TensorboardService.WriteTensorboardExperimentData. + genericMetadata: + description: Operation metadata for FeatureView Create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource: + id: GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource type: object + description: The Dataform Repository containing the input notebook. properties: - writeRunDataRequests: + commitSha: + type: string description: >- - Required. Requests containing per-run TensorboardTimeSeries data to - write. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest - GoogleCloudAiplatformV1TuningJob: + The commit SHA to read repository with. If unset, the file will be + read at HEAD. + dataformRepositoryResourceName: + type: string + description: >- + The resource name of the Dataform Repository. Format: + `projects/{project_id}/locations/{location}/repositories/{repository_id}` + GoogleCloudAiplatformV1UploadModelOperationMetadata: + id: GoogleCloudAiplatformV1UploadModelOperationMetadata + description: Details of ModelService.UploadModel operation. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. type: object + GoogleCloudAiplatformV1NotebookRuntimeTemplate: properties: - updateTime: - readOnly: true - description: Output only. Time when the TuningJob was most recently updated. - format: google-datetime + machineSpec: + description: >- + Optional. Immutable. The specification of a single machine for the + template. + $ref: '#/components/schemas/GoogleCloudAiplatformV1MachineSpec' + notebookRuntimeType: + description: Optional. Immutable. The type of the notebook runtime template. + enumDescriptions: + - >- + Unspecified notebook runtime type, NotebookRuntimeType will + default to USER_DEFINED. + - runtime or template with coustomized configurations from user. + - runtime or template with system defined configurations. + enum: + - NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED + - USER_DEFINED + - ONE_CLICK type: string - endTime: + shieldedVmConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ShieldedVmConfig' + description: Optional. Immutable. Runtime Shielded VM spec. + name: type: string - readOnly: true - description: >- - Output only. Time when the TuningJob entered any of the following - JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. - format: google-datetime - startTime: - description: >- - Output only. Time when the TuningJob for the first time entered the - `JOB_STATE_RUNNING` state. - format: google-datetime + description: The resource name of the NotebookRuntimeTemplate. + description: + description: The description of the NotebookRuntimeTemplate. + type: string + displayName: type: string - readOnly: true - encryptionSpec: description: >- - Customer-managed encryption key options for a TuningJob. If this is - set, then all resources created by the TuningJob will be encrypted - with the provided encryption key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + Required. The display name of the NotebookRuntimeTemplate. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. labels: - type: object additionalProperties: type: string description: >- - Optional. The labels with user-defined metadata to organize - TuningJob and generated resources such as Model and Endpoint. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - state: - type: string - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - description: Output only. The detailed state of the job. + The labels with user-defined metadata to organize the + NotebookRuntimeTemplates. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. + type: object + eucConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookEucConfig' + description: EUC configuration of the NotebookRuntimeTemplate. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: Customer-managed encryption key spec for the notebook runtime. + isDefault: + type: boolean + description: Output only. The default template to use if not specified. readOnly: true - enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. - - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. - - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. - - >- - The job is partially succeeded, some results may be missing due to - errors. - tuningDataStats: + serviceAccount: + type: string + description: >- + The service account that the runtime workload runs as. You can use + any service account within the same project, but you must have the + service account user permission to use the instance. If not + specified, the [Compute Engine default service + account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) + is used. + networkSpec: + description: Optional. Network spec. + $ref: '#/components/schemas/GoogleCloudAiplatformV1NetworkSpec' + createTime: + format: google-datetime + type: string readOnly: true description: >- - Output only. The tuning data statistics associated with this - TuningJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningDataStats' - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Output only. Timestamp when this NotebookRuntimeTemplate was + created. + idleShutdownConfig: description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. - readOnly: true - tunedModelDisplayName: + The idle shutdown configuration of NotebookRuntimeTemplate. This + config will only be set when idle shutdown is enabled. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookIdleShutdownConfig + etag: type: string description: >- - Optional. The display name of the TunedModel. The name can be up to - 128 characters long and can consist of any UTF-8 characters. - name: - type: string - readOnly: true + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + dataPersistentDiskSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentDiskSpec' description: >- - Output only. Identifier. Resource name of a TuningJob. Format: - `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` - experiment: + Optional. The specification of persistent disk attached to the + runtime as data disk storage. + updateTime: type: string - description: Output only. The Experiment associated with this TuningJob. - readOnly: true - tunedModel: + description: >- + Output only. Timestamp when this NotebookRuntimeTemplate was most + recently updated. readOnly: true - $ref: '#/components/schemas/GoogleCloudAiplatformV1TunedModel' + format: google-datetime + networkTags: description: >- - Output only. The tuned model resources assiociated with this - TuningJob. + Optional. The Compute Engine tags to add to runtime (see [Tagging + instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)). + items: + type: string + type: array + type: object + id: GoogleCloudAiplatformV1NotebookRuntimeTemplate + description: >- + A template that specifies runtime configurations such as machine type, + runtime version, network configurations, etc. Multiple runtimes can be + created from a runtime template. + GoogleCloudAiplatformV1Feature: + id: GoogleCloudAiplatformV1Feature + description: >- + Feature Metadata information. For example, color is a feature that + describes an apple. + properties: + labels: + type: object + description: >- + Optional. The labels with user-defined metadata to organize your + Features. Label keys and values can be no longer than 64 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are + allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one Feature (System labels are excluded)." System reserved + label keys are prefixed with "aiplatform.googleapis.com/" and are + immutable. + additionalProperties: + type: string createTime: - description: Output only. Time when the TuningJob was created. - type: string - format: google-datetime readOnly: true - baseModel: + description: >- + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was created. type: string - description: The base model that is being tuned, e.g., "gemini-1.0-pro-002". - supervisedTuningSpec: - description: Tuning Spec for Supervised Fine Tuning. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SupervisedTuningSpec' - description: + format: google-datetime + versionColumnName: type: string - description: Optional. The description of the TuningJob. - description: Represents a TuningJob that runs with Google owned models. - id: GoogleCloudAiplatformV1TuningJob - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics: - properties: - confidenceThreshold: - format: float - type: number - description: The confidence threshold value used to compute the metrics. - boundingBoxIou: - type: number - format: float - description: >- - Bounding box intersection-over-union precision. Measures how well - the bounding boxes overlap between each other (e.g. complete overlap - or just barely above iou_threshold). - mismatchRate: description: >- - Mismatch rate, which measures the tracking consistency, i.e. - correctness of instance ID continuity. - type: number - format: float - trackingRecall: - type: number - format: float - description: Tracking recall. - trackingPrecision: - format: float - type: number - description: Tracking precision. - type: object - description: Metrics for a single confidence threshold. - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics - GoogleCloudAiplatformV1Retrieval: - properties: - disableAttribution: + Only applicable for Vertex AI Feature Store. The name of the + BigQuery Table/View column hosting data for this version. If no + value is provided, will use feature_id. + valueType: + enumDescriptions: + - The value type is unspecified. + - Used for Feature that is a boolean. + - Used for Feature that is a list of boolean. + - Used for Feature that is double. + - Used for Feature that is a list of double. + - Used for Feature that is INT64. + - Used for Feature that is a list of INT64. + - Used for Feature that is string. + - Used for Feature that is a list of String. + - Used for Feature that is bytes. + - Used for Feature that is struct. description: >- - Optional. Disable using the result from this tool in detecting - grounding attribution. This does not affect how the result is given - to the model for generation. + Immutable. Only applicable for Vertex AI Feature Store (Legacy). + Type of Feature value. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - BOOL_ARRAY + - DOUBLE + - DOUBLE_ARRAY + - INT64 + - INT64_ARRAY + - STRING + - STRING_ARRAY + - BYTES + - STRUCT + type: string + disableMonitoring: type: boolean - vertexAiSearch: - $ref: '#/components/schemas/GoogleCloudAiplatformV1VertexAISearch' - description: Set to use data source powered by Vertex AI Search. - id: GoogleCloudAiplatformV1Retrieval - description: >- - Defines a retrieval tool that model can call to access external - knowledge. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation: - type: object - properties: - columnName: + description: >- + Optional. Only applicable for Vertex AI Feature Store (Legacy). If + not set, use the monitoring_config defined for the EntityType this + Feature belongs to. Only Features with type (Feature.ValueType) + BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, + all types of data monitoring are disabled despite the config on + EntityType. + etag: + description: >- + Used to perform a consistent read-modify-write updates. If not set, + a blind "overwrite" update happens. type: string - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation - GoogleCloudAiplatformV1SchemaTimeSegment: - description: >- - A time period inside of a DataItem that has a time dimension (e.g. - video). - properties: - endTimeOffset: + description: + type: string + description: Description of the Feature. + updateTime: + readOnly: true description: >- - End of the time segment (exclusive), represented as the duration - since the start of the DataItem. - format: google-duration + Output only. Only applicable for Vertex AI Feature Store (Legacy). + Timestamp when this EntityType was most recently updated. + format: google-datetime + type: string + name: type: string - startTimeOffset: description: >- - Start of the time segment (inclusive), represented as the duration - since the start of the DataItem. - format: google-duration + Immutable. Name of the Feature. Format: + `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` + `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` + The last part feature is assigned by the client. The feature can be + up to 64 characters long and can consist only of ASCII Latin letters + A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a + letter. The value will be unique given an entity type. + monitoringStatsAnomalies: + description: >- + Output only. Only applicable for Vertex AI Feature Store (Legacy). + The list of historical stats and anomalies with specified + objectives. + readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly + type: array + pointOfContact: type: string + description: >- + Entity responsible for maintaining this feature. Can be comma + separated list of email addresses or URIs. type: object - id: GoogleCloudAiplatformV1SchemaTimeSegment - GoogleCloudAiplatformV1ErrorAnalysisAnnotation: - description: Model error analysis for each annotation. - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies: properties: - outlierThreshold: - type: number - format: double + threshold: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ThresholdConfig' + description: Threshold for anomaly detection. + predictionStats: description: >- - The threshold used to determine if this annotation is an outlier or - not. - outlierScore: + A list of historical stats generated by different time window's + Prediction Dataset. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + trainingStats: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureStatsAnomaly' + description: Stats calculated for the Training Dataset. + featureDisplayName: + description: Display Name of the Feature. + type: string + description: Historical Stats (and Anomalies) for a specific Feature. + type: object + id: >- + GoogleCloudAiplatformV1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies + GoogleCloudAiplatformV1ReservationAffinity: + description: >- + A ReservationAffinity can be used to configure a Vertex AI resource + (e.g., a DeployedModel) to draw its Compute Engine resources from a + Shared Reservation, or exclusively from on-demand capacity. + id: GoogleCloudAiplatformV1ReservationAffinity + properties: + key: description: >- - The outlier score of this annotated item. Usually defined as the min - of all distances from attributed items. - type: number - format: double - queryType: + Optional. Corresponds to the label key of a reservation resource. To + target a SPECIFIC_RESERVATION by name, use + `compute.googleapis.com/reservation-name` as the key and specify the + name of your reservation as its value. + type: string + reservationAffinityType: enumDescriptions: - - Unspecified query type for model error analysis. - - Query similar samples across all classes in the dataset. - - Query similar samples from the same class of the input sample. - - Query dissimilar samples from the same class of the input sample. + - Default value. This should not be used. + - Do not consume from any reserved capacity, only use on-demand. + - Consume any reservation available, falling back to on-demand. + - >- + Consume from a specific reservation. When chosen, the reservation + must be identified via the `key` and `values` fields. enum: - - QUERY_TYPE_UNSPECIFIED - - ALL_SIMILAR - - SAME_CLASS_SIMILAR - - SAME_CLASS_DISSIMILAR - description: The query type used for finding the attributed items. + - TYPE_UNSPECIFIED + - NO_RESERVATION + - ANY_RESERVATION + - SPECIFIC_RESERVATION type: string - attributedItems: - type: array + description: Required. Specifies the reservation affinity type. + values: description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem - type: object - GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse: - id: GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse - properties: - tensorboardRuns: + Optional. Corresponds to the label values of a reservation resource. + This must be the full resource name of the reservation. items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' - description: The created TensorboardRuns. + type: string type: array - description: Response message for TensorboardService.BatchCreateTensorboardRuns. type: object - GoogleTypeInterval: + GoogleCloudAiplatformV1StratifiedSplit: properties: - endTime: + key: + description: >- + Required. The key is a name of one of the Dataset's data columns. + The key provided must be for a categorical column. type: string - format: google-datetime + trainingFraction: description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - startTime: + The fraction of the input data that is to be used to train the + Model. + type: number + format: double + testFraction: + type: number + format: double description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - type: string - format: google-datetime - description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - id: GoogleTypeInterval - type: object - GoogleCloudAiplatformV1ListDataItemsResponse: - properties: - nextPageToken: - type: string - description: The standard List next-page token. - dataItems: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' + The fraction of the input data that is to be used to evaluate the + Model. + validationFraction: + type: number + format: double description: >- - A list of DataItems that matches the specified filter in the - request. + The fraction of the input data that is to be used to validate the + Model. + id: GoogleCloudAiplatformV1StratifiedSplit + description: >- + Assigns input data to the training, validation, and test sets so that + the distribution of values found in the categorical column (as specified + by the `key` field) is mirrored within each split. The fraction values + determine the relative sizes of the splits. For example, if the + specified column has three values, with 50% of the rows having value + "A", 25% value "B", and 25% value "C", and the split fractions are + specified as 80/10/10, then the training set will constitute 80% of the + training data, with about 50% of the training set rows having the value + "A" for the specified column, about 25% having the value "B", and about + 25% having the value "C". Only the top 500 occurring values are used; + any values not in the top 500 values are randomly assigned to a split. + If less than three rows contain a specific value, those rows are + randomly assigned. Supported only for tabular Datasets. type: object - description: Response message for DatasetService.ListDataItems. - id: GoogleCloudAiplatformV1ListDataItemsResponse - GoogleCloudAiplatformV1SmoothGradConfig: + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams: type: object - description: >- - Config for SmoothGrad approximation of gradients. When enabled, the - gradients are approximated by averaging the gradients from noisy samples - in the vicinity of the inputs. Adding noise can help improve the - computed gradients. Refer to this paper for more details: - https://arxiv.org/pdf/1706.03825.pdf + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams + description: Prediction model parameters for Image Classification. properties: - featureNoiseSigma: + maxPredictions: description: >- - This is similar to noise_sigma, but provides additional flexibility. - A separate noise sigma can be provided for each feature, which is - useful if their distributions are different. No noise is added to - features that are not set. If this field is unset, noise_sigma will - be used for all features. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigma' - noiseSigma: + The Model only returns up to that many top, by confidence score, + predictions per instance. If this number is very high, the Model may + return fewer predictions. Default value is 10. + type: integer + format: int32 + confidenceThreshold: description: >- - This is a single float value and will be used to add noise to all - the features. Use this field when all features are normalized to - have the same distribution: scale to range [0, 1], [-1, 1] or - z-scoring, where features are normalized to have 0-mean and - 1-variance. Learn more about - [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). - For best results the recommended value is about 10% - 20% of the - standard deviation of the input feature. Refer to section 3.2 of the - SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to - 0.1. If the distribution is different per feature, set - feature_noise_sigma instead for each feature. - type: number + The Model only returns predictions with at least this confidence + score. Default value is 0.0 format: float - noisySampleCount: - description: >- - The number of gradient samples to use for approximation. The higher - this number, the more accurate the gradient is, but the runtime - complexity increases by this factor as well. Valid range of its - value is [1, 50]. Defaults to 3. - format: int32 - type: integer - id: GoogleCloudAiplatformV1SmoothGradConfig - GoogleCloudAiplatformV1BoolArray: + type: number + GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: + id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest properties: - values: - description: A list of bool values. + names: + description: >- + Required. The names of the PipelineJobs to delete. A maximum of 32 + PipelineJobs can be deleted in a batch. Format: + `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` items: - type: boolean + type: string type: array - description: A list of boolean values. type: object - id: GoogleCloudAiplatformV1BoolArray - GoogleCloudAiplatformV1NotebookEucConfig: - id: GoogleCloudAiplatformV1NotebookEucConfig + description: Request message for PipelineService.BatchDeletePipelineJobs. + GoogleCloudAiplatformV1UndeployIndexOperationMetadata: + properties: + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Runtime operation information for IndexEndpointService.UndeployIndex. + type: object + id: GoogleCloudAiplatformV1UndeployIndexOperationMetadata + GoogleCloudAiplatformV1DataItem: type: object + description: >- + A piece of data in a Dataset. Could be an image, a video, a document or + plain text. + id: GoogleCloudAiplatformV1DataItem properties: - bypassActasCheck: + createTime: + description: Output only. Timestamp when this DataItem was created. + format: google-datetime + type: string + readOnly: true + payload: + type: any description: >- - Output only. Whether ActAs check is bypassed for service account - attached to the VM. If false, we need ActAs check for the default - Compute Engine Service account. When a Runtime is created, a VM is - allocated using Default Compute Engine Service Account. Any user - requesting to use this Runtime requires Service Account User (ActAs) - permission over this SA. If true, Runtime owner is using EUC and - does not require the above permission as VM no longer use default - Compute Engine SA, but a P4SA. + Required. The data that the DataItem represents (for example, an + image or a text snippet). The schema of the payload is stored in the + parent Dataset's metadata schema's dataItemSchemaUri field. + etag: + type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + labels: + additionalProperties: + type: string + description: >- + Optional. The labels with user-defined metadata to organize your + DataItems. Label keys and values can be no longer than 64 characters + (Unicode codepoints), can only contain lowercase letters, numeric + characters, underscores and dashes. International characters are + allowed. No more than 64 user labels can be associated with one + DataItem(System labels are excluded). See https://goo.gl/xmQnxf for + more information and examples of labels. System reserved label keys + are prefixed with "aiplatform.googleapis.com/" and are immutable. + type: object + updateTime: + type: string readOnly: true + format: google-datetime + description: Output only. Timestamp when this DataItem was last updated. + satisfiesPzi: + description: Output only. Reserved for future use. type: boolean - eucDisabled: - description: >- - Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. - In proto3, the default value of a boolean is false. In this way, by - default EUC will be enabled for NotebookRuntimeTemplate. + readOnly: true + name: + description: Output only. The resource name of the DataItem. + readOnly: true + type: string + satisfiesPzs: type: boolean - description: The euc configuration of NotebookRuntimeTemplate. - GoogleCloudAiplatformV1FeatureValueList: - type: object - properties: - values: - description: A list of feature values. All of them should be the same data type. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - type: array - id: GoogleCloudAiplatformV1FeatureValueList - description: Container for list of values. - GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi: - type: object + description: Output only. Reserved for future use. + readOnly: true + GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse: properties: - documentations: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PublisherModelDocumentation - description: Required. - type: array - title: - type: string - description: Required. The title of the view rest API. - description: Rest API docs. - id: GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi - GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig: - description: The configuration for grounding checking. + shouldStop: + description: True if the Trial should stop. + type: boolean + description: Response message for VizierService.CheckTrialEarlyStoppingState. + id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateResponse type: object + GoogleCloudAiplatformV1ManualBatchTuningParameters: properties: - disableAttribution: + batchSize: description: >- - If set, skip finding claim attributions (i.e not generate grounding - citation). - type: boolean - sources: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry - description: The sources for the grounding checking. - type: array - id: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig - GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse: - description: Response message for JobService.ListModelDeploymentMonitoringJobs. - id: GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse + Immutable. The number of the records (e.g. instances) of the + operation given in each batch to a machine replica. Machine type, + and size of a single record should be considered when setting this + parameter, higher value speeds up the batch operation's execution, + but too high value will result in a whole batch not fitting in a + machine's memory, and the whole operation will fail. The default + value is 64. + type: integer + format: int32 + description: Manual batch tuning parameters. + type: object + id: GoogleCloudAiplatformV1ManualBatchTuningParameters + GoogleCloudAiplatformV1DeleteFeatureValuesRequest: properties: - nextPageToken: - type: string - description: The standard List next-page token. - modelDeploymentMonitoringJobs: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob - type: array + selectEntity: + description: Select feature values to be deleted by specifying entities. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectEntity + selectTimeRangeAndFeature: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequestSelectTimeRangeAndFeature description: >- - A list of ModelDeploymentMonitoringJobs that matches the specified - filter in the request. + Select feature values to be deleted by specifying time range and + features. type: object - GoogleCloudAiplatformV1ListMetadataSchemasResponse: - id: GoogleCloudAiplatformV1ListMetadataSchemasResponse - description: Response message for MetadataService.ListMetadataSchemas. + id: GoogleCloudAiplatformV1DeleteFeatureValuesRequest + description: Request message for FeaturestoreService.DeleteFeatureValues. + GoogleCloudAiplatformV1Event: + id: GoogleCloudAiplatformV1Event type: object + description: >- + An edge describing the relationship between an Artifact and an Execution + in a lineage graph. properties: - nextPageToken: + labels: description: >- - A token, which can be sent as ListMetadataSchemasRequest.page_token - to retrieve the next page. If this field is not populated, there are - no subsequent pages. - type: string - metadataSchemas: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' - type: array - description: The MetadataSchemas found for the MetadataStore. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: - type: object - properties: - costMilliNodeHours: - description: >- - The actual training cost of creating this model, expressed in milli - node hours, i.e. 1,000 value in this field means 1 node hour. - Guaranteed to not exceed inputs.budgetMilliNodeHours. - type: string - format: int64 - successfulStopReason: - enumDescriptions: - - Should not be set. - - The inputs.budgetMilliNodeHours had been reached. - - >- - Further training of the Model ceased to increase its quality, - since it already has converged. - description: >- - For successful job completions, this is the reason why the job has - finished. - type: string - enum: - - SUCCESSFUL_STOP_REASON_UNSPECIFIED - - BUDGET_REACHED - - MODEL_CONVERGED - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata - GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata: - type: object - id: GoogleCloudAiplatformV1ExplanationMetadataOutputMetadata - description: Metadata of the prediction output to be explained. - properties: - outputTensorName: - type: string - description: >- - Name of the output tensor. Required and is only applicable to Vertex - AI provided images for Tensorflow. - displayNameMappingKey: - type: string - description: >- - Specify a field name in the prediction to look for the display name. - Use this if the prediction contains the display names for the - outputs. The display names in the prediction must have the same - shape of the outputs, so that it can be located by - Attribution.output_index for a specific output. - indexDisplayNameMapping: - type: any - description: >- - Static mapping between the index and display name. Use this if the - outputs are a deterministic n-dimensional array, e.g. a list of - scores of all the classes in a pre-defined order for a - multi-classification Model. It's not feasible if the outputs are - non-deterministic, e.g. the Model produces top-k classes or sort the - outputs by their values. The shape of the value must be an - n-dimensional array of strings. The number of dimensions must match - that of the outputs to be explained. The - Attribution.output_display_name is populated by locating in the - mapping with Attribution.output_index. - GoogleCloudAiplatformV1ServiceAccountSpec: - properties: - serviceAccount: - type: string - description: >- - Optional. Required when all below conditions are met * - `enable_custom_service_account` is true; * any runtime is specified - via `ResourceRuntimeSpec` on creation time, for example, Ray The - users must have `iam.serviceAccounts.actAs` permission on this - service account and then the specified runtime containers will run - as it. Do not set this field if you want to submit jobs using custom - service account to this PersistentResource after creation, but only - specify the `service_account` inside the job. - enableCustomServiceAccount: - type: boolean - description: >- - Required. If true, custom user-managed service account is enforced - to run any workloads (for example, Vertex Jobs) on the resource. - Otherwise, uses the [Vertex AI Custom Code Service - Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - type: object - id: GoogleCloudAiplatformV1ServiceAccountSpec - description: >- - Configuration for the use of custom service account to run the - workloads. - GoogleCloudAiplatformV1SchemaVertex: - properties: - x: - format: double - type: number - description: X coordinate. - 'y': - description: Y coordinate. - type: number - format: double - type: object - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - id: GoogleCloudAiplatformV1SchemaVertex - GoogleCloudAiplatformV1Int64Array: - type: object - id: GoogleCloudAiplatformV1Int64Array - description: A list of int64 values. - properties: - values: - type: array - description: A list of int64 values. - items: - format: int64 + The labels with user-defined metadata to annotate Events. Label keys + and values can be no longer than 64 characters (Unicode codepoints), + can only contain lowercase letters, numeric characters, underscores + and dashes. International characters are allowed. No more than 64 + user labels can be associated with one Event (System labels are + excluded). See https://goo.gl/xmQnxf for more information and + examples of labels. System reserved label keys are prefixed with + "aiplatform.googleapis.com/" and are immutable. + type: object + additionalProperties: type: string - GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue: - description: Single value that supports strings and floats. - properties: - stringValue: - type: string - description: String type. - floatValue: - description: Float type. - type: number - format: float - type: object - id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecValue - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance: - description: Prediction input format for Image Object Detection. - type: object - properties: - content: + eventTime: type: string - description: The image bytes or Cloud Storage URI to make the prediction on. - mimeType: - description: >- - The MIME type of the content of the image. Only the images in below - listed MIME types are supported. - image/jpeg - image/gif - - image/png - image/webp - image/bmp - image/tiff - - image/vnd.microsoft.icon + format: google-datetime + readOnly: true + description: Output only. Time the Event occurred. + artifact: type: string - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceImageObjectDetectionPredictionInstance - GoogleCloudAiplatformV1Scheduling: - properties: - timeout: - format: google-duration + description: Required. The relative resource name of the Artifact in the Event. + type: + description: Required. The type of the Event. type: string - description: The maximum job running time. The default is 7 days. - disableRetries: - type: boolean - description: >- - Optional. Indicates if the job should retry for internal errors - after the job starts running. If true, overrides - `Scheduling.restart_job_on_worker_restart` to false. - restartJobOnWorkerRestart: - type: boolean - description: >- - Restarts the entire CustomJob if a worker gets restarted. This - feature can be used by distributed training jobs that are not - resilient to workers leaving and joining a job. - description: All parameters related to queuing and scheduling of custom jobs. - id: GoogleCloudAiplatformV1Scheduling - type: object - GoogleCloudAiplatformV1ListFeaturestoresResponse: - id: GoogleCloudAiplatformV1ListFeaturestoresResponse - description: Response message for FeaturestoreService.ListFeaturestores. - properties: - featurestores: - description: The Featurestores matching the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' - nextPageToken: + enumDescriptions: + - Unspecified whether input or output of the Execution. + - An input of the Execution. + - An output of the Execution. + enum: + - TYPE_UNSPECIFIED + - INPUT + - OUTPUT + execution: description: >- - A token, which can be sent as ListFeaturestoresRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. + Output only. The relative resource name of the Execution in the + Event. type: string - type: object - GoogleCloudAiplatformV1BatchPredictionJobOutputConfig: + readOnly: true + GoogleCloudAiplatformV1PairwiseMetricInstance: description: >- - Configures the output of BatchPredictionJob. See - Model.supported_output_storage_formats for supported output formats, and - how predictions are expressed via any of them. - type: object - id: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig - properties: - gcsDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: >- - The Cloud Storage location of the directory where the output is to - be written to. In the given directory a new directory is created. - Its name is `prediction--`, where timestamp is in - YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files - `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are - created where `` depends on chosen predictions_format, and N may - equal 0001 and depends on the total number of successfully predicted - instances. If the Model has both instance and prediction schemata - defined then each such file contains predictions as per the - predictions_format. If prediction for any instance failed (partially - or completely), then an additional `errors_0001.`, - `errors_0002.`,..., `errors_N.` files are created (N depends on - total number of failed predictions). These files contain the failed - instances, as per their schema, followed by an additional `error` - field which as value has google.rpc.Status containing only `code` - and `message` fields. - bigqueryDestination: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: >- - The BigQuery project or dataset location where the output is to be - written to. If project is provided, a new dataset is created with - name `prediction__` where is made BigQuery-dataset-name compatible - (for example, most special characters become underscores), and - timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. - In the dataset two tables will be created, `predictions`, and - `errors`. If the Model has both instance and prediction schemata - defined then the tables have columns as follows: The `predictions` - table contains instances for which the prediction succeeded, it has - columns as per a concatenation of the Model's instance and - prediction schemata. The `errors` table contains rows for which the - prediction has failed, it has instance columns, as per the instance - schema, followed by a single "errors" column, which as values has - google.rpc.Status represented as a STRUCT, and containing only - `code` and `message`. - predictionsFormat: - type: string - description: >- - Required. The format in which Vertex AI gives the predictions, must - be one of the Model's supported_output_storage_formats. - GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: - properties: - alpha: - type: number - format: float - description: >- - Required. Users can provide an alpha value to give more weight to - dense vs sparse results. For example, if the alpha is 0, we only - return sparse and if the alpha is 1, we only return dense. + Pairwise metric instance. Usually one instance corresponds to one row in + an evaluation dataset. + id: GoogleCloudAiplatformV1PairwiseMetricInstance type: object - description: Parameters for RRF algorithm that combines search results. - id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance: properties: - content: - type: string - description: The text snippet to make the predictions on. - mimeType: + jsonInstance: description: >- - The MIME type of the text snippet. The supported MIME types are - listed below. - text/plain + Instance specified as a json string. String key-value pairs are + expected in the json_instance to render + PairwiseMetricSpec.instance_prompt_template. type: string - description: Prediction input format for Text Classification. - type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictInstanceTextClassificationPredictionInstance - GoogleCloudAiplatformV1CompletionStats: + GoogleCloudAiplatformV1HyperparameterTuningJob: properties: - failedCount: - description: >- - Output only. The number of entities for which any error was - encountered. - format: int64 - readOnly: true + name: type: string - successfulForecastPointCount: readOnly: true - format: int64 - description: >- - Output only. The number of the successful forecast points that are - generated by the forecasting model. This is ONLY used by the - forecasting batch prediction. - type: string - successfulCount: - type: string - format: int64 + description: Output only. Resource name of the HyperparameterTuningJob. + trialJobSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' description: >- - Output only. The number of entities that had been processed - successfully. + Required. The spec of a trial job. The same spec applies to the + CustomJobs created in all the trials. + error: readOnly: true - incompleteCount: - type: string - format: int64 description: >- - Output only. In cases when enough errors are encountered a job, - pipeline, or operation may be failed as a whole. Below is the number - of entities for which the processing had not been finished (either - in successful or failed state). Set to -1 if the number is unknown - (for example, the operation failed before the total entity number - could be collected). - readOnly: true - description: >- - Success and error statistics of processing multiple entities (for - example, DataItems or structured data rows) in batch. - id: GoogleCloudAiplatformV1CompletionStats - type: object - GoogleCloudAiplatformV1NasJob: - properties: - createTime: + Output only. Only populated when job's state is JOB_STATE_FAILED or + JOB_STATE_CANCELLED. + $ref: '#/components/schemas/GoogleRpcStatus' + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: Required. Study configuration of the HyperparameterTuningJob. + updateTime: type: string - readOnly: true - description: Output only. Time when the NasJob was created. format: google-datetime - nasJobOutput: readOnly: true - description: Output only. Output of the NasJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobOutput' - enableRestrictedImageTraining: - type: boolean - deprecated: true description: >- - Optional. Enable a separation of Custom model training and - restricted image training for tenant project. - updateTime: + Output only. Time when the HyperparameterTuningJob was most recently + updated. + createTime: + description: Output only. Time when the HyperparameterTuningJob was created. format: google-datetime - description: Output only. Time when the NasJob was most recently updated. type: string readOnly: true - displayName: - type: string - description: >- - Required. The display name of the NasJob. The name can be up to 128 - characters long and can consist of any UTF-8 characters. - endTime: - format: google-datetime - type: string + trials: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' readOnly: true - description: >- - Output only. Time when the NasJob entered any of the following - states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - nasJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJobSpec' - description: Required. The specification of a NasJob. + description: Output only. Trials of the HyperparameterTuningJob. + type: array + maxTrialCount: + type: integer + format: int32 + description: Required. The desired total number of Trials. labels: + description: >- + The labels with user-defined metadata to organize + HyperparameterTuningJobs. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. type: object additionalProperties: type: string - description: >- - The labels with user-defined metadata to organize NasJobs. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key options for a NasJob. If this is - set, then all resources created by the NasJob will be encrypted with - the provided encryption key. + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean state: - description: Output only. The detailed state of the job. - type: string enum: - JOB_STATE_UNSPECIFIED - JOB_STATE_QUEUED @@ -20301,276 +19971,396 @@ components: The job is partially succeeded, some results may be missing due to errors. readOnly: true - name: + description: Output only. The detailed state of the job. + type: string + maxFailedTrialCount: + type: integer + description: >- + The number of failed Trials that need to be seen before failing the + HyperparameterTuningJob. If set to 0, Vertex AI decides how many + Trials must fail before the whole job fails. + format: int32 + endTime: + format: google-datetime + type: string + description: >- + Output only. Time when the HyperparameterTuningJob entered any of + the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + `JOB_STATE_CANCELLED`. readOnly: true - description: Output only. Resource name of the NasJob. + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + displayName: + description: >- + Required. The display name of the HyperparameterTuningJob. The name + can be up to 128 characters long and can consist of any UTF-8 + characters. type: string + encryptionSpec: + description: >- + Customer-managed encryption key options for a + HyperparameterTuningJob. If this is set, then all resources created + by the HyperparameterTuningJob will be encrypted with the provided + encryption key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' startTime: readOnly: true type: string format: google-datetime description: >- - Output only. Time when the NasJob for the first time entered the - `JOB_STATE_RUNNING` state. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. - readOnly: true - description: Represents a Neural Architecture Search (NAS) job. - id: GoogleCloudAiplatformV1NasJob + Output only. Time when the HyperparameterTuningJob for the first + time entered the `JOB_STATE_RUNNING` state. + parallelTrialCount: + type: integer + description: Required. The desired number of Trials to run in parallel. + format: int32 + id: GoogleCloudAiplatformV1HyperparameterTuningJob type: object - GoogleCloudAiplatformV1Presets: + description: >- + Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a + Study specification and multiple CustomJobs with identical CustomJob + specification. + GoogleCloudAiplatformV1DeleteOperationMetadata: properties: - modality: - description: >- - The modality of the uploaded model, which automatically configures - the distance measurement and feature normalization for the - underlying example index and queries. If your model does not - precisely fit one of these types, it is okay to choose the closest - type. - type: string - enumDescriptions: - - Should not be set. Added as a recommended best practice for enums - - IMAGE modality - - TEXT modality - - TABULAR modality - enum: - - MODALITY_UNSPECIFIED - - IMAGE - - TEXT - - TABULAR - query: - enumDescriptions: - - More precise neighbors as a trade-off against slower response. - - Faster response as a trade-off against less precise neighbors. + genericMetadata: + description: The common part of the operation metadata. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + id: GoogleCloudAiplatformV1DeleteOperationMetadata + type: object + description: Details of operations that perform deletes of any entities. + GoogleCloudAiplatformV1ThresholdConfig: + description: The config for feature monitoring threshold. + properties: + value: + format: double + type: number description: >- - Preset option controlling parameters for speed-precision trade-off - when querying for examples. If omitted, defaults to `PRECISE`. - enum: - - PRECISE - - FAST - type: string - id: GoogleCloudAiplatformV1Presets + Specify a threshold value that can trigger the alert. If this + threshold config is for feature distribution distance: 1. For + categorical feature, the distribution distance is calculated by + L-inifinity norm. 2. For numerical feature, the distribution + distance is calculated by Jensen–Shannon divergence. Each feature + must have a non-zero threshold if they need to be monitored. + Otherwise no alert will be triggered for that feature. type: object - description: Preset configuration for example-based explanations - GoogleCloudAiplatformV1StudySpec: - id: GoogleCloudAiplatformV1StudySpec + id: GoogleCloudAiplatformV1ThresholdConfig + GoogleCloudAiplatformV1FractionSplit: + description: >- + Assigns the input data to training, validation, and test sets as per the + given fractions. Any of `training_fraction`, `validation_fraction` and + `test_fraction` may optionally be provided, they must sum to up to 1. If + the provided ones sum to less than 1, the remainder is assigned to sets + as decided by Vertex AI. If none of the fractions are set, by default + roughly 80% of data is used for training, 10% for validation, and 10% + for test. properties: - algorithm: - description: The search algorithm specified for the Study. - type: string - enum: - - ALGORITHM_UNSPECIFIED - - GRID_SEARCH - - RANDOM_SEARCH - enumDescriptions: - - >- - The default algorithm used by Vertex AI for [hyperparameter - tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) - and [Vertex AI - Vizier](https://cloud.google.com/vertex-ai/docs/vizier). - - >- - Simple grid search within the feasible space. To use grid search, - all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`. - - Simple random search within the feasible space. - medianAutomatedStoppingSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec - description: The automated early stopping spec using median rule. - observationNoise: - enumDescriptions: - - The default noise level chosen by Vertex AI. - - >- - Vertex AI assumes that the objective function is (nearly) - perfectly reproducible, and will never repeat the same Trial - parameters. - - >- - Vertex AI will estimate the amount of noise in metric evaluations, - it may repeat the same Trial parameters more than once. - type: string - enum: - - OBSERVATION_NOISE_UNSPECIFIED - - LOW - - HIGH + trainingFraction: + format: double description: >- - The observation noise level of the study. Currently only supported - by the Vertex AI Vizier service. Not supported by - HyperparameterTuningJob or TrainingPipeline. - parameters: - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' - description: Required. The set of parameters to tune. - metrics: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecMetricSpec' - type: array - description: Required. Metric specs for the Study. - measurementSelectionType: - description: Describe which measurement selection type will be used - type: string - enum: - - MEASUREMENT_SELECTION_TYPE_UNSPECIFIED - - LAST_MEASUREMENT - - BEST_MEASUREMENT - enumDescriptions: - - Will be treated as LAST_MEASUREMENT. - - Use the last measurement reported. - - Use the best measurement reported. - convexAutomatedStoppingSpec: - description: The automated early stopping spec using convex stopping rule. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec - decayCurveStoppingSpec: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecDecayCurveAutomatedStoppingSpec - description: The automated early stopping spec using decay curve rule. - studyStoppingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecStudyStoppingConfig + The fraction of the input data that is to be used to train the + Model. + type: number + validationFraction: + type: number + format: double description: >- - Conditions for automated stopping of a Study. Enable automated - stopping by configuring at least one condition. - type: object - description: Represents specification of a Study. - GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata: - description: Details of operations that perform create EntityType. - type: object - id: GoogleCloudAiplatformV1CreateEntityTypeOperationMetadata - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: Operation metadata for EntityType. - GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig: + The fraction of the input data that is to be used to validate the + Model. + testFraction: + format: double + type: number + description: >- + The fraction of the input data that is to be used to evaluate the + Model. type: object - id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig - description: >- - The tables Dataset's data source. The Dataset doesn't store the data - directly, but only pointer(s) to its data. + id: GoogleCloudAiplatformV1FractionSplit + GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec: + id: GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpec properties: - bigquerySource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataBigQuerySource - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource - GoogleCloudAiplatformV1StringArray: + configs: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSliceSliceSliceSpecSliceConfig + description: >- + Mapping configuration for this SliceSpec. The key is the name of the + feature. By default, the key will be prefixed by "instance" as a + dictionary prefix for Vertex Batch Predictions output format. + type: object + description: Specification for how the data should be sliced. type: object - id: GoogleCloudAiplatformV1StringArray - description: A list of string values. + GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: properties: - values: - items: - type: string - description: A list of string values. - type: array - GoogleCloudAiplatformV1IndexStats: - id: GoogleCloudAiplatformV1IndexStats + annotationResourceName: + type: string + description: >- + The unique ID for each annotation. Used by FE to allocate the + annotation in DB. + distance: + type: number + description: The distance of this item to the annotation. + format: double type: object - description: Stats of the Index. + description: >- + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem + GoogleCloudAiplatformV1FeatureView: properties: - sparseVectorsCount: - format: int64 - description: Output only. The number of sparse vectors in the Index. - type: string + satisfiesPzs: readOnly: true - shardsCount: - description: Output only. The number of shards in the Index. + type: boolean + description: Output only. Reserved for future use. + createTime: + description: Output only. Timestamp when this FeatureView was created. readOnly: true - type: integer - format: int32 - vectorsCount: + type: string + format: google-datetime + etag: + type: string + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + satisfiesPzi: + type: boolean + description: Output only. Reserved for future use. + readOnly: true + labels: + description: >- + Optional. The labels with user-defined metadata to organize your + FeatureViews. Label keys and values can be no longer than 64 + characters (Unicode codepoints), can only contain lowercase letters, + numeric characters, underscores and dashes. International characters + are allowed. See https://goo.gl/xmQnxf for more information on and + examples of labels. No more than 64 user labels can be associated + with one FeatureOnlineStore(System labels are excluded)." System + reserved label keys are prefixed with "aiplatform.googleapis.com/" + and are immutable. + additionalProperties: + type: string + type: object + bigQuerySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewBigQuerySource + description: >- + Optional. Configures how data is supposed to be extracted from a + BigQuery source to be loaded onto the FeatureOnlineStore. + name: + description: >- + Identifier. Name of the FeatureView. Format: + `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + type: string + updateTime: readOnly: true + description: Output only. Timestamp when this FeatureView was last updated. + format: google-datetime type: string - description: Output only. The number of dense vectors in the Index. - format: int64 - GoogleCloudAiplatformV1StreamingPredictRequest: - properties: - parameters: - description: The parameters that govern the prediction. - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - inputs: - description: The prediction input. - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' - type: array - id: GoogleCloudAiplatformV1StreamingPredictRequest + featureRegistrySource: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewFeatureRegistrySource + description: >- + Optional. Configures the features from a Feature Registry source + that need to be loaded onto the FeatureOnlineStore. + indexConfig: + description: >- + Optional. Configuration for index preparation for vector search. It + contains the required configurations to create an index from source + data, so that approximate nearest neighbor (a.k.a ANN) algorithms + search can be performed during online serving. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfig' + vertexRagSource: + description: Optional. The Vertex RAG Source that the FeatureView is linked to. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureViewVertexRagSource + syncConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSyncConfig' + description: >- + Configures when data is to be synced/updated for this FeatureView. + At the end of the sync the latest featureValues for each entityId of + this FeatureView are made ready for online serving. description: >- - Request message for PredictionService.StreamingPredict. The first - message must contain endpoint field and optionally input. The subsequent - messages must contain input. + FeatureView is representation of values that the FeatureOnlineStore will + serve based on its syncConfig. type: object - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline: - id: >- - GoogleCloudAiplatformV1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline + id: GoogleCloudAiplatformV1FeatureView + GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata: + type: object + id: GoogleCloudAiplatformV1SchemaVisualInspectionMaskSavedQueryMetadata + properties: {} + GoogleCloudAiplatformV1ImportDataConfig: type: object properties: - gcs: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Cloud Storage location for BatchExplain output. - bigquery: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' - description: BigQuery location for BatchExplain output. - predictionFormat: + gcsSource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + description: The Google Cloud Storage location for the input content. + importSchemaUri: type: string - description: The storage format of the predictions generated BatchPrediction job. - enum: - - PREDICTION_FORMAT_UNSPECIFIED - - JSONL - - BIGQUERY - enumDescriptions: - - Should not be set. - - Predictions are in JSONL files. - - Predictions are in BigQuery. + description: >- + Required. Points to a YAML file stored on Google Cloud Storage + describing the import format. Validation will be done against the + schema. The schema is defined as an [OpenAPI 3.0.2 Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + dataItemLabels: + type: object + description: >- + Labels that will be applied to newly imported DataItems. If an + identical DataItem as one being imported already exists in the + Dataset, then these labels will be appended to these of the already + existing one, and if labels with identical key is imported before, + the old label value will be overwritten. If two DataItems are + identical in the same import data operation, the labels will be + combined and if key collision happens in this case, one of the + values will be picked randomly. Two DataItems are considered + identical if their content bytes are identical (e.g. image bytes or + pdf bytes). These labels will be overridden by Annotation labels + specified inside index file referenced by import_schema_uri, e.g. + jsonl file. + additionalProperties: + type: string + annotationLabels: + type: object + description: >- + Labels that will be applied to newly imported Annotations. If two + Annotations are identical, one of them will be deduped. Two + Annotations are considered identical if their payload, + payload_schema_uri and all of their labels are the same. These + labels will be overridden by Annotation labels specified inside + index file referenced by import_schema_uri, e.g. jsonl file. + additionalProperties: + type: string + id: GoogleCloudAiplatformV1ImportDataConfig description: >- - Output from BatchPredictionJob for Model Monitoring baseline dataset, - which can be used to generate baseline attribution scores. - GoogleCloudAiplatformV1FeatureSelector: + Describes the location from where we import data into a Dataset, + together with the labels that will be applied to the DataItems and the + Annotations. + GoogleCloudAiplatformV1StartNotebookRuntimeRequest: + properties: {} + id: GoogleCloudAiplatformV1StartNotebookRuntimeRequest + type: object + description: Request message for NotebookService.StartNotebookRuntime. + GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: + description: Value specification for a parameter in `DOUBLE` type. properties: - idMatcher: - description: Required. Matches Features based on ID. - $ref: '#/components/schemas/GoogleCloudAiplatformV1IdMatcher' + defaultValue: + format: double + type: number + description: >- + A default value for a `DOUBLE` parameter that is assumed to be a + relatively good starting point. Unset value signals that there is no + offered starting point. Currently only supported by the Vertex AI + Vizier service. Not supported by HyperparameterTuningJob or + TrainingPipeline. + maxValue: + type: number + description: Required. Inclusive maximum value of the parameter. + format: double + minValue: + format: double + type: number + description: Required. Inclusive minimum value of the parameter. type: object - id: GoogleCloudAiplatformV1FeatureSelector - description: Selector for Features of an EntityType. - GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata: - id: GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata + id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec + GoogleCloudAiplatformV1ExactMatchSpec: + properties: {} type: object - properties: - study: - type: string - description: The name of the Study that the Trial belongs to. - trial: - type: string - description: The Trial name. - genericMetadata: - description: Operation metadata for suggesting Trials. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' description: >- - This message will be placed in the metadata field of a - google.longrunning.Operation associated with a - CheckTrialEarlyStoppingState request. - GoogleCloudAiplatformV1CustomJob: + Spec for exact match metric - returns 1 if prediction and reference + exactly matches, otherwise 0. + id: GoogleCloudAiplatformV1ExactMatchSpec + GoogleCloudAiplatformV1ModelDeploymentMonitoringJob: + id: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob properties: - name: + displayName: + description: >- + Required. The user-defined name of the ModelDeploymentMonitoringJob. + The name can be up to 128 characters long and can consist of any + UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. type: string - description: Output only. Resource name of a CustomJob. - readOnly: true - endTime: + samplePredictInstance: + description: >- + Sample Predict instance, same format as PredictRequest.instances, + this can be set as a replacement of + ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not + set, we will generate predict schema from collected predict + requests. + type: any + bigqueryTables: readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable + type: array + description: >- + Output only. The created bigquery tables for the job under customer + project. Customer could do their own query & analysis. There could + be 4 log tables in maximum: 1. Training data logging predict + request/response 2. Serving data logging predict request/response + nextScheduleTime: type: string + readOnly: true + description: >- + Output only. Timestamp when this monitoring pipeline will be + scheduled to run for the next round. format: google-datetime + satisfiesPzi: + type: boolean + readOnly: true + description: Output only. Reserved for future use. + scheduleState: + enumDescriptions: + - Unspecified state. + - The pipeline is picked up and wait to run. + - The pipeline is offline and will be scheduled for next run. + - The pipeline is running. description: >- - Output only. Time when the CustomJob entered any of the following - states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. - jobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: Required. Job spec. + Output only. Schedule state when the monitoring job is in Running + state. + readOnly: true + type: string + enum: + - MONITORING_SCHEDULE_STATE_UNSPECIFIED + - PENDING + - OFFLINE + - RUNNING + predictInstanceSchemaUri: + description: >- + YAML schema file uri describing the format of a single instance, + which are given to format this Endpoint's prediction (and + explanation). If not set, we will generate predict schema from + collected predict requests. + type: string + logTtl: + format: google-duration + type: string + description: >- + The TTL of BigQuery tables in user projects which stores logs. A day + is the basic unit of the TTL and we take the ceil of TTL/86400(a + day). e.g. { second: 3600} indicates ttl = 1 day. + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean + readOnly: true state: - description: Output only. The detailed state of the job. + description: >- + Output only. The detailed state of the monitoring job. When the job + is still creating, the state will be 'PENDING'. Once the job is + successfully created, the state will be 'RUNNING'. Pause the job, + the state will be 'PAUSED'. Resume the job, the state will return to + 'RUNNING'. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED enumDescriptions: - The job state is unspecified. - >- @@ -20594,3517 +20384,6043 @@ components: The job is partially succeeded, some results may be missing due to errors. readOnly: true - enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - type: string - error: - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. Only populated when job's state is `JOB_STATE_FAILED` - or `JOB_STATE_CANCELLED`. - startTime: - description: >- - Output only. Time when the CustomJob for the first time entered the - `JOB_STATE_RUNNING` state. type: string - format: google-datetime - readOnly: true - updateTime: - description: Output only. Time when the CustomJob was most recently updated. + statsAnomaliesBaseDirectory: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' + description: Stats anomalies base folder path. + modelDeploymentMonitoringScheduleConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig + description: Required. Schedule config for running the monitoring job. + endpoint: type: string - format: google-datetime - readOnly: true - webAccessUris: + description: >- + Required. Endpoint resource name. Format: + `projects/{project}/locations/{location}/endpoints/{endpoint}` + modelMonitoringAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig + description: Alert config for model monitoring. + latestMonitoringPipelineMetadata: + description: Output only. Latest triggered monitoring pipeline metadata. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata readOnly: true + encryptionSpec: description: >- - Output only. URIs for accessing [interactive - shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) - (one URI for each training node). Only available if - job_spec.enable_web_access is `true`. The keys are names of each - node in the training job; for example, `workerpool0-0` for the - primary node, `workerpool1-0` for the first node in the second - worker pool, and `workerpool1-1` for the second node in the second - worker pool. The values are the URIs for each node's interactive - shell. - type: object - additionalProperties: - type: string + Customer-managed encryption key spec for a + ModelDeploymentMonitoringJob. If set, this + ModelDeploymentMonitoringJob and all sub-resources of this + ModelDeploymentMonitoringJob will be secured by this key. + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' labels: type: object + description: >- + The labels with user-defined metadata to organize your + ModelDeploymentMonitoringJob. Label keys and values can be no longer + than 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. additionalProperties: type: string + analysisInstanceSchemaUri: description: >- - The labels with user-defined metadata to organize CustomJobs. Label - keys and values can be no longer than 64 characters (Unicode - codepoints), can only contain lowercase letters, numeric characters, - underscores and dashes. International characters are allowed. See - https://goo.gl/xmQnxf for more information and examples of labels. - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Customer-managed encryption key options for a CustomJob. If this is - set, then all resources created by the CustomJob will be encrypted - with the provided encryption key. - createTime: + YAML schema file uri describing the format of a single instance that + you want Tensorflow Data Validation (TFDV) to analyze. If this field + is empty, all the feature data types are inferred from + predict_instance_schema_uri, meaning that TFDV will use the data in + the exact format(data type) as prediction request/response. If there + are any data type differences between predict instance and TFDV + instance, this field can be used to override the schema. For models + trained with Vertex AI, this field must be set as all the fields in + predict instance formatted as string. + type: string + loggingSamplingStrategy: + description: Required. Sample Strategy for logging. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' + name: + description: Output only. Resource name of a ModelDeploymentMonitoringJob. readOnly: true type: string - description: Output only. Time when the CustomJob was created. + enableMonitoringPipelineLogs: + type: boolean + description: >- + If true, the scheduled monitoring pipeline logs are sent to Google + Cloud Logging, including pipeline status and anomalies detected. + Please note the logs incur cost, which are subject to [Cloud Logging + pricing](https://cloud.google.com/logging#pricing). + updateTime: format: google-datetime - displayName: + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + updated most recently. type: string + readOnly: true + error: + readOnly: true description: >- - Required. The display name of the CustomJob. The name can be up to - 128 characters long and can consist of any UTF-8 characters. + Output only. Only populated when the job's state is + `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + $ref: '#/components/schemas/GoogleRpcStatus' + createTime: + type: string + format: google-datetime + readOnly: true + description: >- + Output only. Timestamp when this ModelDeploymentMonitoringJob was + created. + modelDeploymentMonitoringObjectiveConfigs: + description: >- + Required. The config for monitoring objectives. This is a per + DeployedModel config. Each DeployedModel needs to be configured + separately. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig description: >- - Represents a job that runs custom workloads such as a Docker container - or a Python package. A CustomJob can have multiple worker pools and each - worker pool can have its own machine and input spec. A CustomJob will be - cleaned up once the job enters terminal state (failed or succeeded). - id: GoogleCloudAiplatformV1CustomJob + Represents a job that runs periodically to monitor the deployed models + in an endpoint. It will analyze the logged training & prediction data to + detect any abnormal behaviors. type: object - GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: + GoogleCloudAiplatformV1CancelTrainingPipelineRequest: + properties: {} + id: GoogleCloudAiplatformV1CancelTrainingPipelineRequest + description: Request message for PipelineService.CancelTrainingPipeline. type: object - description: Describes metadata for a TensorboardTimeSeries. + GoogleCloudAiplatformV1DiskSpec: properties: - maxWallTime: - readOnly: true + bootDiskType: type: string description: >- - Output only. Max wall clock timestamp of all data points within a - TensorboardTimeSeries. - format: google-datetime - maxBlobSequenceLength: + Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" + (Persistent Disk Solid State Drive) or "pd-standard" (Persistent + Disk Hard Disk Drive). + bootDiskSizeGb: + description: Size in GB of the boot disk (default is 100GB). + format: int32 + type: integer + id: GoogleCloudAiplatformV1DiskSpec + type: object + description: Represents the spec of disk options. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking: + properties: + inputs: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs + description: The input parameters of this TrainingJob. + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking + type: object + description: >- + A TrainingJob that trains and uploads an AutoML Video ObjectTracking + Model. + GoogleCloudAiplatformV1FluencyInput: + type: object + properties: + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencySpec' + description: Required. Spec for fluency score metric. + instance: + description: Required. Fluency instance. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FluencyInstance' + description: Input for fluency metric. + id: GoogleCloudAiplatformV1FluencyInput + GoogleCloudAiplatformV1RemoveContextChildrenResponse: + description: Response message for MetadataService.RemoveContextChildren. + id: GoogleCloudAiplatformV1RemoveContextChildrenResponse + type: object + properties: {} + GoogleCloudAiplatformV1ExplainRequest: + type: object + properties: + parameters: + type: any description: >- - Output only. The largest blob sequence length (number of blobs) of - all data points in this time series, if its ValueType is - BLOB_SEQUENCE. - readOnly: true - format: int64 - type: string - maxStep: + The parameters that govern the prediction. The schema of the + parameters may be specified via Endpoint's DeployedModels' Model's + PredictSchemata's parameters_schema_uri. + explanationSpecOverride: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationSpecOverride' description: >- - Output only. Max step index of all data points within a - TensorboardTimeSeries. + If specified, overrides the explanation_spec of the DeployedModel. + Can be used for explaining prediction results with different + configurations, such as: - Explaining top-5 predictions results as + opposed to top-1; - Increasing path count or step count of the + attribution methods to reduce approximate errors; - Using different + baselines for explaining the prediction results. + instances: + type: array + description: >- + Required. The instances that are the input to the explanation call. + A DeployedModel may have an upper limit on the number of instances + it supports per request, and when it is exceeded the explanation + call errors in case of AutoML Models, or, in case of customer + created Models, the behaviour is as documented by that Model. The + schema of any single instance may be specified via Endpoint's + DeployedModels' Model's PredictSchemata's instance_schema_uri. + items: + type: any + deployedModelId: + description: >- + If specified, this ExplainRequest will be served by the chosen + DeployedModel, overriding Endpoint.traffic_split. type: string - format: int64 - readOnly: true - id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata - GoogleCloudAiplatformV1PurgeContextsResponse: + description: Request message for PredictionService.Explain. + id: GoogleCloudAiplatformV1ExplainRequest + GoogleCloudAiplatformV1FindNeighborsRequest: type: object - id: GoogleCloudAiplatformV1PurgeContextsResponse + id: GoogleCloudAiplatformV1FindNeighborsRequest properties: - purgeSample: + returnFullDatapoint: + type: boolean + description: >- + If set to true, the full datapoints (including all vector values and + restricts) of the nearest neighbors are returned. Note that + returning full datapoint will significantly increase the latency and + cost of the query. + queries: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequestQuery + description: The list of queries. type: array + deployedIndexId: description: >- - A sample of the Context names that will be deleted. Only populated - if `force` is set to false. The maximum number of samples is 100 (it - is possible to return fewer). - purgeCount: + The ID of the DeployedIndex that will serve the request. This + request is sent to a specific IndexEndpoint, as per the + IndexEndpoint.network. That IndexEndpoint also has + IndexEndpoint.deployed_indexes, and each such index has a + DeployedIndex.id field. The value of the field below must equal one + of the DeployedIndex.id fields of the IndexEndpoint that is being + called for this request. + type: string + description: The request message for MatchService.FindNeighbors. + GoogleCloudAiplatformV1CreateFeatureRequest: + id: GoogleCloudAiplatformV1CreateFeatureRequest + properties: + parent: + type: string description: >- - The number of Contexts that this request deleted (or, if `force` is - false, the number of Contexts that will be deleted). This can be an - estimate. - format: int64 + Required. The resource name of the EntityType or FeatureGroup to + create a Feature. Format for entity_type as parent: + `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + Format for feature_group as parent: + `projects/{project}/locations/{location}/featureGroups/{feature_group}` + feature: + description: Required. The Feature to create. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + featureId: + description: >- + Required. The ID to use for the Feature, which will become the final + component of the Feature's resource name. This value may be up to + 128 characters, and valid characters are `[a-z0-9_]`. The first + character cannot be a number. The value must be unique within an + EntityType/FeatureGroup. type: string - description: Response message for MetadataService.PurgeContexts. - GoogleCloudAiplatformV1ModelDeploymentMonitoringJob: - id: GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + description: >- + Request message for FeaturestoreService.CreateFeature. Request message + for FeatureRegistryService.CreateFeature. type: object + GoogleCloudAiplatformV1MetadataStore: properties: - labels: - additionalProperties: - type: string - description: >- - The labels with user-defined metadata to organize your - ModelDeploymentMonitoringJob. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - type: object - modelDeploymentMonitoringScheduleConfig: - description: Required. Schedule config for running the monitoring job. + dataplexConfig: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig - latestMonitoringPipelineMetadata: + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreDataplexConfig + description: Optional. Dataplex integration settings. + state: readOnly: true + description: Output only. State information of the MetadataStore. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata - description: Output only. Latest triggered monitoring pipeline metadata. - modelMonitoringAlertConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfig - description: Alert config for model monitoring. - createTime: + #/components/schemas/GoogleCloudAiplatformV1MetadataStoreMetadataStoreState + name: + type: string + description: Output only. The resource name of the MetadataStore instance. readOnly: true + createTime: format: google-datetime - description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - created. type: string + readOnly: true + description: Output only. Timestamp when this MetadataStore was created. + description: + description: Description of the MetadataStore. + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key spec for a Metadata Store. If set, + this Metadata Store and all sub-resources of this Metadata Store are + secured using this key. updateTime: type: string + format: google-datetime readOnly: true - description: >- - Output only. Timestamp when this ModelDeploymentMonitoringJob was - updated most recently. + description: Output only. Timestamp when this MetadataStore was last updated. + description: >- + Instance of a metadata store. Contains a set of metadata that can be + queried. + id: GoogleCloudAiplatformV1MetadataStore + type: object + GoogleCloudAiplatformV1DeployedIndex: + properties: + createTime: + type: string + description: Output only. Timestamp when the DeployedIndex was created. format: google-datetime - error: + readOnly: true + dedicatedResources: description: >- - Output only. Only populated when the job's state is - `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. A description of resources that are dedicated to the + DeployedIndex, and that need a higher degree of manual + configuration. The field min_replica_count must be set to a value + strictly greater than 0, or else validation will fail. We don't + provide SLA when min_replica_count=1. If max_replica_count is not + set, the default value is min_replica_count. The max allowed replica + count is 1000. Available machine types for SMALL shard: + e2-standard-2 and all machine types available for MEDIUM and LARGE + shard. Available machine types for MEDIUM shard: e2-standard-16 and + all machine types available for LARGE shard. Available machine types + for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and + n1-standard-32 are still available, but we recommend e2-standard-16 + and e2-highmem-16 for cost efficiency. + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' + privateEndpoints: + description: >- + Output only. Provides paths for users to send requests directly to + the deployed index services running on Cloud via private services + access. This field is populated if network is configured. readOnly: true - scheduleState: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexPrivateEndpoints' + deployedIndexAuthConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndexAuthConfig' description: >- - Output only. Schedule state when the monitoring job is in Running - state. + Optional. If set, the authentication is enabled for the private + endpoint. + automaticResources: + description: >- + Optional. A description of resources that the DeployedIndex uses, + which to large degree are decided by Vertex AI, and optionally + allows only a modest additional configuration. If min_replica_count + is not set, the default value is 2 (we don't provide SLA when + min_replica_count=1). If max_replica_count is not set, the default + value is min_replica_count. The max allowed replica count is 1000. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + id: type: string - enum: - - MONITORING_SCHEDULE_STATE_UNSPECIFIED - - PENDING - - OFFLINE - - RUNNING - enumDescriptions: - - Unspecified state. - - The pipeline is picked up and wait to run. - - The pipeline is offline and will be scheduled for next run. - - The pipeline is running. - readOnly: true - enableMonitoringPipelineLogs: - type: boolean description: >- - If true, the scheduled monitoring pipeline logs are sent to Google - Cloud Logging, including pipeline status and anomalies detected. - Please note the logs incur cost, which are subject to [Cloud Logging - pricing](https://cloud.google.com/logging#pricing). - logTtl: + Required. The user specified ID of the DeployedIndex. The ID can be + up to 128 characters long and must start with a letter and only + contain letters, numbers, and underscores. The ID must be unique + within the project it is created in. + displayName: description: >- - The TTL of BigQuery tables in user projects which stores logs. A day - is the basic unit of the TTL and we take the ceil of TTL/86400(a - day). e.g. { second: 3600} indicates ttl = 1 day. - format: google-duration + The display name of the DeployedIndex. If not provided upon + creation, the Index's display_name is used. type: string - modelDeploymentMonitoringObjectiveConfigs: + reservedIpRanges: + type: array description: >- - Required. The config for monitoring objectives. This is a per - DeployedModel config. Each DeployedModel needs to be configured - separately. + Optional. A list of reserved ip ranges under the VPC network that + can be used for this DeployedIndex. If set, we will deploy the index + within the provided ip ranges. Otherwise, the index might be + deployed to any ip ranges under the provided VPC network. The value + should be the name of the address + (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) + Example: ['vertex-ai-ip-range']. For more information about subnets + and network IP ranges, please see + https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig - type: array - name: + type: string + enableAccessLogging: + type: boolean + description: >- + Optional. If true, private endpoint's access logs are sent to Cloud + Logging. These logs are like standard server access logs, containing + information like timestamp and latency for each MatchRequest. Note + that logs may incur a cost, especially if the deployed index + receives a high queries per second rate (QPS). Estimate your costs + before enabling this option. + indexSyncTime: + description: >- + Output only. The DeployedIndex may depend on various data on its + original Index. Additionally when certain changes to the original + Index are being done (e.g. when what the Index contains is being + changed) the DeployedIndex may be asynchronously updated in the + background to reflect these changes. If this timestamp's value is at + least the Index.update_time of the original Index, it means that + this DeployedIndex and the original Index are in sync. If this + timestamp is older, then to see which updates this DeployedIndex + already contains (and which it does not), one must list the + operations that are running on the original Index. Only the + successfully completed Operations with update_time equal or before + this sync time are contained in this DeployedIndex. + format: google-datetime type: string readOnly: true - description: Output only. Resource name of a ModelDeploymentMonitoringJob. - analysisInstanceSchemaUri: + index: + type: string description: >- - YAML schema file uri describing the format of a single instance that - you want Tensorflow Data Validation (TFDV) to analyze. If this field - is empty, all the feature data types are inferred from - predict_instance_schema_uri, meaning that TFDV will use the data in - the exact format(data type) as prediction request/response. If there - are any data type differences between predict instance and TFDV - instance, this field can be used to override the schema. For models - trained with Vertex AI, this field must be set as all the fields in - predict instance formatted as string. + Required. The name of the Index this is the deployment of. We may + refer to this Index as the DeployedIndex's "original" Index. + deploymentGroup: + description: >- + Optional. The deployment group can be no longer than 64 characters + (eg: 'test', 'prod'). If not set, we will use the 'default' + deployment group. Creating `deployment_groups` with + `reserved_ip_ranges` is a recommended practice when the peered + network has multiple peering ranges. This creates your deployments + from predictable IP spaces for easier traffic administration. Also, + one deployment_group (except 'default') can only be used with the + same reserved_ip_ranges which means if the deployment_group has been + used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, + e] is disallowed. Note: we only support up to 5 deployment + groups(not including 'default'). type: string - statsAnomaliesBaseDirectory: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsDestination' - description: Stats anomalies base folder path. - bigqueryTables: + type: object + id: GoogleCloudAiplatformV1DeployedIndex + description: >- + A deployment of an Index. IndexEndpoints contain one or more + DeployedIndexes. + GoogleCloudAiplatformV1SummarizationHelpfulnessInput: + type: object + description: Input for summarization helpfulness metric. + properties: + instance: + description: Required. Summarization helpfulness instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessInstance + metricSpec: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SummarizationHelpfulnessSpec + description: Required. Spec for summarization helpfulness score metric. + id: GoogleCloudAiplatformV1SummarizationHelpfulnessInput + GoogleCloudAiplatformV1GroundednessInput: + description: Input for groundedness metric. + type: object + id: GoogleCloudAiplatformV1GroundednessInput + properties: + instance: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessInstance' + description: Required. Groundedness instance. + metricSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GroundednessSpec' + description: Required. Spec for groundedness metric. + GoogleCloudAiplatformV1ToolParameterKVMatchResults: + id: GoogleCloudAiplatformV1ToolParameterKVMatchResults + properties: + toolParameterKvMatchMetricValues: items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable - readOnly: true + #/components/schemas/GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue type: array - description: >- - Output only. The created bigquery tables for the job under customer - project. Customer could do their own query & analysis. There could - be 4 log tables in maximum: 1. Training data logging predict - request/response 2. Serving data logging predict request/response - encryptionSpec: - description: >- - Customer-managed encryption key spec for a - ModelDeploymentMonitoringJob. If set, this - ModelDeploymentMonitoringJob and all sub-resources of this - ModelDeploymentMonitoringJob will be secured by this key. - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - state: readOnly: true + description: Output only. Tool parameter key value match metric values. + description: Results for tool parameter key value match metric. + type: object + GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig: + description: Configuration options for the tree-AH algorithm. + id: GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig + type: object + properties: + leafNodeEmbeddingCount: + type: string + description: >- + Optional. Number of embeddings on each leaf node. The default value + is 1000 if not set. + format: int64 + GoogleCloudAiplatformV1FunctionCallingConfig: + id: GoogleCloudAiplatformV1FunctionCallingConfig + type: object + properties: + mode: enumDescriptions: - - The job state is unspecified. - - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. + - Unspecified function calling mode. This value should not be used. - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. + Default model behavior, model decides to predict either function + calls or natural language response. - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. + Model is constrained to always predicting function calls only. If + "allowed_function_names" are set, the predicted function calls + will be limited to any one of "allowed_function_names", else the + predicted function calls will be any one of the provided + "function_declarations". - >- - The job is partially succeeded, some results may be missing due to - errors. - type: string - description: >- - Output only. The detailed state of the monitoring job. When the job - is still creating, the state will be 'PENDING'. Once the job is - successfully created, the state will be 'RUNNING'. Pause the job, - the state will be 'PAUSED'. Resume the job, the state will return to - 'RUNNING'. + Model will not predict any function calls. Model behavior is same + as when not passing any function declarations. enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - displayName: + - MODE_UNSPECIFIED + - AUTO + - ANY + - NONE type: string + description: Optional. Function calling mode. + allowedFunctionNames: + type: array description: >- - Required. The user-defined name of the ModelDeploymentMonitoringJob. - The name can be up to 128 characters long and can consist of any - UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. - loggingSamplingStrategy: - description: Required. Sample Strategy for logging. - $ref: '#/components/schemas/GoogleCloudAiplatformV1SamplingStrategy' - endpoint: + Optional. Function names to call. Only set when the Mode is ANY. + Function names should match [FunctionDeclaration.name]. With mode + set to ANY, model will predict a function call from the set of + function names provided. + items: + type: string + description: Function calling config. + GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail: + type: object + description: >- + The detail of a container execution. It contains the job names of the + lifecycle of a container execution. + id: GoogleCloudAiplatformV1PipelineTaskExecutorDetailContainerDetail + properties: + mainJob: + readOnly: true description: >- - Required. Endpoint resource name. Format: - `projects/{project}/locations/{location}/endpoints/{endpoint}` + Output only. The name of the CustomJob for the main container + execution. type: string - nextScheduleTime: - format: google-datetime - description: >- - Output only. Timestamp when this monitoring pipeline will be - scheduled to run for the next round. + preCachingCheckJob: readOnly: true - type: string - predictInstanceSchemaUri: - type: string - description: >- - YAML schema file uri describing the format of a single instance, - which are given to format this Endpoint's prediction (and - explanation). If not set, we will generate predict schema from - collected predict requests. - samplePredictInstance: - type: any description: >- - Sample Predict instance, same format as PredictRequest.instances, - this can be set as a replacement of - ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not - set, we will generate predict schema from collected predict - requests. - description: >- - Represents a job that runs periodically to monitor the deployed models - in an endpoint. It will analyze the logged training & prediction data to - detect any abnormal behaviors. - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult: - description: Prediction output format for Image Object Detection. - properties: - bboxes: - type: array + Output only. The name of the CustomJob for the pre-caching-check + container execution. This job will be available if the + PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in + the lifecycle events. + type: string + failedPreCachingCheckJobs: description: >- - Bounding boxes, i.e. the rectangles over the image, that pinpoint - the found AnnotationSpecs. Given in order that matches the IDs. Each - bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and - `yMax`, which represent the extremal coordinates of the box. They - are relative to the image size, and the point 0,0 is in the top left - of the image. - items: - type: array - items: - type: any - ids: + Output only. The names of the previously failed CustomJob for the + pre-caching-check container executions. This job will be available + if the PipelineJob.pipeline_spec specifies the `pre_caching_check` + hook in the lifecycle events. The list includes the all attempts in + chronological order. items: type: string - format: int64 - type: array - description: >- - The resource IDs of the AnnotationSpecs that had been identified, - ordered by the confidence score descendingly. - confidences: - type: array - description: >- - The Model's confidences in correctness of the predicted IDs, higher - value means higher confidence. Order matches the Ids. - items: - format: float - type: number - displayNames: + readOnly: true type: array + failedMainJobs: items: type: string description: >- - The display names of the AnnotationSpecs that had been identified, - order matches the IDs. + Output only. The names of the previously failed CustomJob for the + main container executions. The list includes the all attempts in + chronological order. + type: array + readOnly: true + GoogleCloudAiplatformV1RayMetricSpec: type: object - id: >- - GoogleCloudAiplatformV1SchemaPredictPredictionImageObjectDetectionPredictionResult - GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem: - id: GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem + properties: + disabled: + type: boolean + description: Optional. Flag to disable the Ray metrics collection. + description: Configuration for the Ray metrics. + id: GoogleCloudAiplatformV1RayMetricSpec + GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec: type: object properties: - distance: - type: number - format: double - description: The distance of this item to the annotation. - annotationResourceName: - type: string + useElapsedDuration: + type: boolean description: >- - The unique ID for each annotation. Used by FE to allocate the - annotation in DB. - description: >- - Attributed items for a given annotation, typically representing - neighbors from the training sets constrained by the query type. - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics: - properties: - confidenceMetrics: - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics - type: array + This bool determines whether or not the rule is applied based on + elapsed_secs or steps. If use_elapsed_duration==false, the early + stopping decision is made according to the predicted objective + values according to the target steps. If use_elapsed_duration==true, + elapsed_secs is used instead of steps. Also, in this case, the + parameters max_num_steps and min_num_steps are overloaded to contain + max_elapsed_seconds and min_elapsed_seconds. + minStepCount: description: >- - Metrics for each `confidenceThreshold` in - 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and `positionThreshold` - = INT32_MAX_VALUE. ROC and precision-recall curves, and other - aggregated metrics are derived from them. The confidence metrics - entries may also be supplied for additional values of - `positionThreshold`, but from these no aggregated metrics are - computed. - confusionMatrix: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix - description: Confusion matrix of the evaluation. - auRoc: + Minimum number of steps for a trial to complete. Trials which do not + have a measurement with step_count > min_step_count won't be + considered for early stopping. It's ok to set it to 0, and a trial + can be early stopped at any stage. By default, min_step_count is set + to be one-tenth of the max_step_count. When use_elapsed_duration is + true, this field is set to the minimum elapsed seconds. + format: int64 + type: string + maxStepCount: + format: int64 description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - type: number - format: float - logLoss: - format: float - description: The Log Loss metric. - type: number - auPrc: - type: number + Steps used in predicting the final objective for early stopped + trials. In general, it's set to be the same as the defined steps in + training / tuning. If not defined, it will learn it from the + completed trials. When use_steps is false, this field is set to the + maximum elapsed seconds. + type: string + learningRateParameterName: description: >- - The Area Under Precision-Recall Curve metric. Micro-averaged for the - overall evaluation. - format: float - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetrics - description: Metrics for classification evaluation results. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation: - properties: - timeFormat: + The hyper-parameter name used in the tuning job that stands for + learning rate. Leave it blank if learning rate is not in a parameter + in tuning. The learning_rate is used to estimate the objective value + of the ongoing trial. type: string + updateAllStoppedTrials: description: >- - The format in which that time field is expressed. The time_format - must either be one of: * `unix-seconds` * `unix-milliseconds` * - `unix-microseconds` * `unix-nanoseconds` (for respectively number of - seconds, milliseconds, microseconds and nanoseconds since start of - the Unix epoch); or be written in `strftime` syntax. If time_format - is not set, then the default format is RFC 3339 `date-time` format, - where `time-offset` = `"Z"` (e.g. 1985-04-12T23:20:50.52Z) - columnName: + ConvexAutomatedStoppingSpec by default only updates the trials that + needs to be early stopped using a newly trained auto-regressive + model. When this flag is set to True, all stopped trials from the + beginning are potentially updated in terms of their + `final_measurement`. Also, note that the training logic of + autoregressive models is different in this case. Enabling this + option has shown better results and this may be the default option + in the future. + type: boolean + minMeasurementCount: type: string - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation - description: >- - Training pipeline will perform following transformation functions. * - Apply the transformation functions for Numerical columns. * Determine - the year, month, day,and weekday. Treat each value from the timestamp as - a Categorical column. * Invalid numerical values (for example, values - that fall outside of a typical timestamp range, or are extreme values) - receive no special treatment and are not removed. - GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest: - properties: - names: - type: array - items: - type: string description: >- - Required. The names of the PipelineJobs to delete. A maximum of 32 - PipelineJobs can be deleted in a batch. Format: - `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` + The minimal number of measurements in a Trial. Early-stopping checks + will not trigger if less than min_measurement_count+1 completed + trials or pending trials with less than min_measurement_count + measurements. If not defined, the default value is 5. + format: int64 + id: GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec + description: >- + Configuration for ConvexAutomatedStoppingSpec. When there are enough + completed trials (configured by min_measurement_count), for pending + trials with enough measurements and steps, the policy first computes an + overestimate of the objective value at max_num_steps according to the + slope of the incomplete objective value curve. No prediction can be made + if the curve is completely flat. If the overestimation is worse than the + best objective value of the completed trials, this pending trial will be + early-stopped, but a last measurement will be added to the pending trial + with max_num_steps and predicted objective value from the autoregression + model. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs type: object - description: Request message for PipelineService.BatchDeletePipelineJobs. - id: GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest - GoogleCloudAiplatformV1ListTensorboardsResponse: - id: GoogleCloudAiplatformV1ListTensorboardsResponse - description: Response message for TensorboardService.ListTensorboards. properties: - tensorboards: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' - type: array - description: The Tensorboards mathching the request. - nextPageToken: - type: string + sentimentMax: + type: integer + format: int32 description: >- - A token, which can be sent as ListTensorboardsRequest.page_token to - retrieve the next page. If this field is omitted, there are no - subsequent pages. - type: object - GoogleCloudAiplatformV1ListModelEvaluationsResponse: - id: GoogleCloudAiplatformV1ListModelEvaluationsResponse - type: object - description: Response message for ModelService.ListModelEvaluations. + A sentiment is expressed as an integer ordinal, where higher value + means a more positive sentiment. The range of sentiments that will + be used is between 0 and sentimentMax (inclusive on both ends), and + all the values in the range must be represented in the dataset + before a model can be created. Only the Annotations with this + sentimentMax will be used for training. sentimentMax value must be + between 1 and 10 (inclusive). + GoogleCloudAiplatformV1GenericOperationMetadata: + description: Generic Metadata shared by all operations. properties: - nextPageToken: + createTime: + description: Output only. Time when the operation was created. + type: string + readOnly: true + format: google-datetime + updateTime: + format: google-datetime type: string description: >- - A token to retrieve next page of results. Pass to - ListModelEvaluationsRequest.page_token to obtain that page. - modelEvaluations: + Output only. Time when the operation was updated for the last time. + If the operation has finished (successfully or not), this is the + finish time. + readOnly: true + partialFailures: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: '#/components/schemas/GoogleRpcStatus' type: array - description: List of ModelEvaluations in the requested page. - GoogleCloudAiplatformV1DatasetDistributionDistributionBucket: + readOnly: true + description: >- + Output only. Partial failures encountered. E.g. single files that + couldn't be read. This field should never exceed 20 entries. Status + details field will contain standard Google Cloud error details. + type: object + id: GoogleCloudAiplatformV1GenericOperationMetadata + GoogleCloudAiplatformV1AnnotationSpec: properties: - right: + updateTime: + format: google-datetime readOnly: true - description: Output only. Right bound of the bucket. - format: double - type: number - left: + description: Output only. Timestamp when AnnotationSpec was last updated. + type: string + etag: + description: >- + Optional. Used to perform consistent read-modify-write updates. If + not set, a blind "overwrite" update happens. + type: string + name: readOnly: true - type: number - format: double - description: Output only. Left bound of the bucket. - count: + description: Output only. Resource name of the AnnotationSpec. + type: string + createTime: + type: string readOnly: true + format: google-datetime + description: Output only. Timestamp when this AnnotationSpec was created. + displayName: type: string - description: Output only. Number of values in the bucket. - format: int64 - id: GoogleCloudAiplatformV1DatasetDistributionDistributionBucket + description: >- + Required. The user-defined name of the AnnotationSpec. The name can + be up to 128 characters long and can consist of any UTF-8 + characters. + id: GoogleCloudAiplatformV1AnnotationSpec type: object - description: >- - Dataset bucket used to create a histogram for the distribution given a - population of values. - GoogleCloudAiplatformV1ModelExplanation: - description: Aggregated explanation metrics for a Model over a set of instances. + description: Identifies a concept with which DataItems may be annotated with. + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError: properties: - meanAttributions: + errorType: + type: string + description: The error type of this record. + enum: + - ERROR_TYPE_UNSPECIFIED + - EMPTY_LINE + - INVALID_JSON_SYNTAX + - INVALID_CSV_SYNTAX + - INVALID_AVRO_SYNTAX + - INVALID_EMBEDDING_ID + - EMBEDDING_SIZE_MISMATCH + - NAMESPACE_MISSING + - PARSING_ERROR + - DUPLICATE_NAMESPACE + - OP_IN_DATAPOINT + - MULTIPLE_VALUES + - INVALID_NUMERIC_VALUE + - INVALID_ENCODING + - INVALID_SPARSE_DIMENSIONS + - INVALID_TOKEN_VALUE + - INVALID_SPARSE_EMBEDDING + - INVALID_EMBEDDING + enumDescriptions: + - Default, shall not be used. + - The record is empty. + - Invalid json format. + - Invalid csv format. + - Invalid avro format. + - The embedding id is not valid. + - >- + The size of the dense embedding vectors does not match with the + specified dimension. + - The `namespace` field is missing. + - >- + Generic catch-all error. Only used for validation failure where + the root cause cannot be easily retrieved programmatically. + - There are multiple restricts with the same `namespace` value. + - Numeric restrict has operator specified in datapoint. + - Numeric restrict has multiple values specified. + - Numeric restrict has invalid numeric value specified. + - File is not in UTF_8 format. + - Error parsing sparse dimensions field. + - Token restrict value is invalid. + - Invalid sparse embedding. + - Invalid dense embedding. + errorMessage: description: >- - Output only. Aggregated attributions explaining the Model's - prediction outputs over the set of instances. The attributions are - grouped by outputs. For Models that predict only one output, such as - regression Models that predict only one score, there is only one - attibution that explains the predicted output. For Models that - predict multiple outputs, such as multiclass Models that predict - multiple classes, each element explains one specific item. - Attribution.output_index can be used to identify which output this - attribution is explaining. The baselineOutputValue, - instanceOutputValue and featureAttributions fields are averaged over - the test data. NOTE: Currently AutoML tabular classification Models - produce only one attribution, which averages attributions over all - the classes it predicts. Attribution.approximation_error is not - populated. - type: array - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' - readOnly: true + A human-readable message that is shown to the user to help them fix + the error. Note that this message may change from time to time, your + code should check against error_type as the source of truth. + type: string + sourceGcsUri: + type: string + description: Cloud Storage URI pointing to the original file in user's bucket. + embeddingId: + type: string + description: Empty if the embedding id is failed to parse. + rawRecord: + type: string + description: The original content of this record. + id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError type: object - id: GoogleCloudAiplatformV1ModelExplanation - GoogleCloudAiplatformV1Scalar: - description: One point viewable on a scalar metric plot. + GoogleCloudAiplatformV1NearestNeighborQueryEmbedding: + type: object + id: GoogleCloudAiplatformV1NearestNeighborQueryEmbedding properties: value: - format: double - description: Value of the point at this step / timestamp. - type: number - id: GoogleCloudAiplatformV1Scalar - type: object - GoogleCloudAiplatformV1WriteFeatureValuesResponse: + description: Optional. Individual value in the embedding. + type: array + items: + format: float + type: number + description: The embedding vector. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: type: object - properties: {} - id: GoogleCloudAiplatformV1WriteFeatureValuesResponse + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics description: >- - Response message for - FeaturestoreOnlineServingService.WriteFeatureValues. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition: - description: Represents the spec to match categorical values from parent parameter. - type: object + Model evaluation metrics for video object tracking problems. Evaluates + prediction quality of both labeled bounding boxes and labeled tracks + (i.e. series of bounding boxes sharing same label and instance ID). properties: - values: + trackMetrics: + description: >- + UNIMPLEMENTED. The tracks match metrics for each + intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics type: array + boundingBoxMeanAveragePrecision: + format: float + type: number description: >- - Required. Matches values of the parent parameter of 'CATEGORICAL' - type. All values must exist in `categorical_value_spec` of parent - parameter. - items: - type: string - id: >- - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats: - properties: - sourceGcsUri: - type: string - description: Cloud Storage URI pointing to the original file in user's bucket. - invalidRecordCount: - type: string - description: Number of records in this file we skipped due to validate errors. - format: int64 - validSparseRecordCount: - description: >- - Number of sparse records in this file that were successfully - processed. - format: int64 - type: string - partialErrors: + The single metric for bounding boxes evaluation: the + `meanAveragePrecision` averaged over all `boundingBoxMetrics`. + boundingBoxMetrics: + type: array items: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError - description: >- - The detail information of the partial failures encountered for those - invalid records that couldn't be parsed. Up to 50 partial errors - will be reported. - type: array - invalidSparseRecordCount: - type: string + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics description: >- - Number of sparse records in this file we skipped due to validate - errors. - format: int64 - validRecordCount: - description: Number of records in this file that were successfully processed. - format: int64 - type: string - id: >- - GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats - type: object - GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData: - properties: - userUsageData: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerUserUsageData - description: Usage data for each user in the given month. - description: Per month usage data - type: object - id: GoogleCloudAiplatformV1ReadTensorboardUsageResponsePerMonthUsageData - GoogleCloudAiplatformV1FeatureViewIndexConfig: - description: Configuration for vector indexing. - id: GoogleCloudAiplatformV1FeatureViewIndexConfig - type: object - properties: - embeddingColumn: - type: string + The bounding boxes match metrics for each intersection-over-union + threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label + confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. + evaluatedTrackCount: + type: integer description: >- - Optional. Column of embedding. This column contains the source data - to create index for vector search. embedding_column must be set when - using vector search. - distanceMeasureType: - type: string - description: Optional. The distance measure used in nearest neighbor search. - enum: - - DISTANCE_MEASURE_TYPE_UNSPECIFIED - - SQUARED_L2_DISTANCE - - COSINE_DISTANCE - - DOT_PRODUCT_DISTANCE - enumDescriptions: - - Should not be set. - - Euclidean (L_2) Distance. - - >- - Cosine Distance. Defined as 1 - cosine similarity. We strongly - suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of - COSINE distance. Our algorithms have been more optimized for - DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is - mathematically equivalent to COSINE distance and results in the - same ranking. - - Dot Product Distance. Defined as a negative of the dot product. - treeAhConfig: + UNIMPLEMENTED. The total number of tracks (i.e. as seen across all + frames) the ground truth used to create this evaluation had. + format: int32 + trackMeanMismatchRate: description: >- - Optional. Configuration options for the tree-AH algorithm (Shallow - tree + Asymmetric Hashing). Please refer to this paper for more - details: https://arxiv.org/abs/1908.10396 - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigTreeAHConfig - filterColumns: + UNIMPLEMENTED. The single metric for tracking consistency + evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. + format: float + type: number + trackMeanBoundingBoxIou: description: >- - Optional. Columns of features that're used to filter vector search - results. - type: array - items: - type: string - bruteForceConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeatureViewIndexConfigBruteForceConfig + UNIMPLEMENTED. The single metric for tracks bounding box iou + evaluation: the `meanBoundingBoxIou` averaged over all + `trackMetrics`. + type: number + format: float + evaluatedBoundingBoxCount: description: >- - Optional. Configuration options for using brute force search, which - simply implements the standard linear search in the database for - each query. It is primarily meant for benchmarking and to generate - the ground truth for approximate search. - crowdingColumn: - type: string + UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over + all frames) the ground truth used to create this evaluation had. + format: int32 + type: integer + evaluatedFrameCount: description: >- - Optional. Column of crowding. This column contains crowding - attribute which is a constraint on a neighbor list produced by - FeatureOnlineStoreService.SearchNearestEntities to diversify search - results. If - NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to - K in SearchNearestEntitiesRequest, it's guaranteed that no more than - K entities of the same crowding attribute are returned in the - response. - embeddingDimension: + UNIMPLEMENTED. The number of video frames used to create this + evaluation. format: int32 - description: Optional. The number of dimensions of the input embedding. type: integer - GoogleCloudAiplatformV1EntityIdSelector: + trackMeanAveragePrecision: + description: >- + UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the + `meanAveragePrecision` averaged over all `trackMetrics`. + type: number + format: float + GoogleCloudAiplatformV1GroundednessInstance: + type: object + id: GoogleCloudAiplatformV1GroundednessInstance properties: - csvSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CsvSource' - description: Source of Csv - entityIdField: + prediction: + description: Required. Output of the evaluated model. + type: string + context: type: string description: >- - Source column that holds entity IDs. If not provided, entity IDs are - extracted from the column named entity_id. + Required. Background information provided in context used to compare + against the prediction. + description: Spec for groundedness instance. + GoogleCloudAiplatformV1StudyTimeConstraint: + properties: + maxDuration: + description: Counts the wallclock time passed since the creation of this Study. + type: string + format: google-duration + endTime: + format: google-datetime + description: Compares the wallclock time to this time. Must use UTC timezone. + type: string + description: Time-based Constraint for Study + id: GoogleCloudAiplatformV1StudyTimeConstraint type: object - id: GoogleCloudAiplatformV1EntityIdSelector - description: Selector for entityId. Getting ids from the given source. - GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: - id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup - description: >- - Features belonging to a single feature group that will be synced to - Online Store. + GoogleCloudAiplatformV1ToolNameMatchMetricValue: + description: Tool name match metric value for an instance. + properties: + score: + format: float + readOnly: true + description: Output only. Tool name match score. + type: number + id: GoogleCloudAiplatformV1ToolNameMatchMetricValue + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance: type: object properties: - featureGroupId: - type: string - description: Required. Identifier of the feature group. - featureIds: - description: Required. Identifiers of features under the feature group. + contextColumns: type: array items: type: string - GoogleCloudAiplatformV1ModelMonitoringAlertConfig: - description: The alert config for model monitoring. - id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig - type: object - properties: - notificationChannels: + contextWeights: + description: >- + TFT feature importance values. Each pair for + {context/horizon/attribute} should have the same shape since the + weight corresponds to the column names. + type: array + items: + type: number + format: float + horizonWeights: + items: + format: float + type: number + type: array + horizonColumns: items: type: string - description: >- - Resource names of the NotificationChannels to send alert. Must be of - the format `projects//notificationChannels/` type: array - emailAlertConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig - description: Email alert config. - enableLogging: - type: boolean - description: >- - Dump the anomalies to Cloud Logging. The anomalies will be put to - json payload encoded from proto - google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. - This can be further sinked to Pub/Sub or any other services - supported by Cloud Logging. - GoogleCloudAiplatformV1FeatureOnlineStoreOptimized: - properties: {} + attributeColumns: + items: + type: string + type: array + attributeWeights: + type: array + items: + format: float + type: number + id: GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + GoogleCloudAiplatformV1ImportDataOperationMetadata: + type: object + description: Runtime operation information for DatasetService.ImportData. + id: GoogleCloudAiplatformV1ImportDataOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The common part of the operation metadata. + GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec: type: object - id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized - description: Optimized storage type - GoogleCloudAiplatformV1PredictSchemata: description: >- - Contains the schemata used in Model's predictions and explanations via - PredictionService.Predict, PredictionService.Explain and - BatchPredictionJob. + The median automated stopping rule stops a pending Trial if the Trial's + best objective_value is strictly below the median 'performance' of all + completed Trials reported up to the Trial's last measurement. Currently, + 'performance' refers to the running average of the objective values + reported by the Trial in each measurement. properties: - predictionSchemaUri: + useElapsedDuration: description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the format of a single prediction produced by this Model, - which are returned via PredictResponse.predictions, - ExplainResponse.explanations, and BatchPredictionJob.output_config. - The schema is defined as an OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. + True if median automated stopping rule applies on + Measurement.elapsed_duration. It means that elapsed_duration field + of latest measurement of current Trial is used to compute median + objective value for each completed Trials. + type: boolean + id: GoogleCloudAiplatformV1StudySpecMedianAutomatedStoppingSpec + GoogleCloudAiplatformV1NotebookExecutionJob: + description: NotebookExecutionJob represents an instance of a notebook execution. + properties: + updateTime: type: string - parametersSchemaUri: + readOnly: true + format: google-datetime description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the parameters of prediction and explanation via - PredictRequest.parameters, ExplainRequest.parameters and - BatchPredictionJob.model_parameters. The schema is defined as an - OpenAPI 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI, if no - parameters are supported, then it is set to an empty string. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. + Output only. Timestamp when this NotebookExecutionJob was most + recently updated. + createTime: + readOnly: true type: string - instanceSchemaUri: + format: google-datetime + description: Output only. Timestamp when this NotebookExecutionJob was created. + notebookRuntimeTemplateResourceName: type: string + description: The NotebookRuntimeTemplate to source compute configuration from. + executionTimeout: description: >- - Immutable. Points to a YAML file stored on Google Cloud Storage - describing the format of a single instance, which are used in - PredictRequest.instances, ExplainRequest.instances and - BatchPredictionJob.input_config. The schema is defined as an OpenAPI - 3.0.2 [Schema - Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). - AutoML Models always have this field populated by Vertex AI. Note: - The URI given on output will be immutable and probably different, - including the URI scheme, than the one given on input. The output - URI will point to a location where the user only has a read access. - type: object - id: GoogleCloudAiplatformV1PredictSchemata - GoogleCloudAiplatformV1CreateFeatureRequest: - id: GoogleCloudAiplatformV1CreateFeatureRequest - properties: - featureId: + Max running time of the execution job in seconds (default 86400s / + 24 hrs). + type: string + format: google-duration + gcsOutputUri: description: >- - Required. The ID to use for the Feature, which will become the final - component of the Feature's resource name. This value may be up to - 128 characters, and valid characters are `[a-z0-9_]`. The first - character cannot be a number. The value must be unique within an - EntityType/FeatureGroup. + The Cloud Storage location to upload the result to. Format: + `gs://bucket-name` type: string - parent: + serviceAccount: type: string + description: The service account to run the execution as. + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Required. The resource name of the EntityType or FeatureGroup to - create a Feature. Format for entity_type as parent: - `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` - Format for feature_group as parent: - `projects/{project}/locations/{location}/featureGroups/{feature_group}` - feature: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' - description: Required. The Feature to create. - description: >- - Request message for FeaturestoreService.CreateFeature. Request message - for FeatureRegistryService.CreateFeature. - type: object - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation: - type: object - properties: - columnName: + Customer-managed encryption key spec for the notebook execution job. + This field is auto-populated if the + NotebookService.NotebookRuntimeTemplate has an encryption spec. + displayName: type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation - description: >- - Training pipeline will perform following transformation functions. * The - text as is--no change to case, punctuation, spelling, tense, and so on. - * Convert the category name to a dictionary lookup index and generate an - embedding for each index. - GoogleCloudAiplatformV1PauseScheduleRequest: - type: object - properties: {} - id: GoogleCloudAiplatformV1PauseScheduleRequest - description: Request message for ScheduleService.PauseSchedule. - GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec: - id: GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpec - properties: - parameterSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpec' - description: Required. The spec for a conditional parameter. - parentIntValues: description: >- - The spec for matching values from a parent parameter of `INTEGER` - type. + The display name of the NotebookExecutionJob. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + dataformRepositorySource: + description: >- + The Dataform Repository pointing to a single file notebook + repository. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecIntValueCondition - parentDiscreteValues: + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource + executionUser: + type: string + description: >- + The user email to run the execution as. Only supported by Colab + runtimes. + scheduleResourceName: + description: >- + Output only. The Schedule resource name if this job is triggered by + one. Format: + `projects/{project_id}/locations/{location}/schedules/{schedule_id}` + type: string + readOnly: true + name: + type: string + readOnly: true + description: >- + Output only. The resource name of this NotebookExecutionJob. Format: + `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` + gcsNotebookSource: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource description: >- - The spec for matching values from a parent parameter of `DISCRETE` - type. - parentCategoricalValues: + The Cloud Storage url pointing to the ipynb file. Format: + `gs://bucket/notebook_file.ipynb` + labels: description: >- - The spec for matching values from a parent parameter of - `CATEGORICAL` type. + The labels with user-defined metadata to organize + NotebookExecutionJobs. Label keys and values can be no longer than + 64 characters (Unicode codepoints), can only contain lowercase + letters, numeric characters, underscores and dashes. International + characters are allowed. See https://goo.gl/xmQnxf for more + information and examples of labels. System reserved label keys are + prefixed with "aiplatform.googleapis.com/" and are immutable. + additionalProperties: + type: string + type: object + directNotebookSource: + description: The contents of an input notebook file. $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource + status: + description: >- + Output only. Populated when the NotebookExecutionJob is completed. + When there is an error during notebook execution, the error details + are populated. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + jobState: + description: Output only. The state of the NotebookExecutionJob. + enum: + - JOB_STATE_UNSPECIFIED + - JOB_STATE_QUEUED + - JOB_STATE_PENDING + - JOB_STATE_RUNNING + - JOB_STATE_SUCCEEDED + - JOB_STATE_FAILED + - JOB_STATE_CANCELLING + - JOB_STATE_CANCELLED + - JOB_STATE_PAUSED + - JOB_STATE_EXPIRED + - JOB_STATE_UPDATING + - JOB_STATE_PARTIALLY_SUCCEEDED + type: string + readOnly: true + enumDescriptions: + - The job state is unspecified. + - >- + The job has been just created or resumed and processing has not + yet begun. + - The service is preparing to run the job. + - The job is in progress. + - The job completed successfully. + - The job failed. + - >- + The job is being cancelled. From this state the job may only go to + either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or + `JOB_STATE_CANCELLED`. + - The job has been cancelled. + - The job has been stopped, and can be resumed. + - The job has expired. + - >- + The job is being updated. Only jobs in the `RUNNING` state can be + updated. After updating, the job goes back to the `RUNNING` state. + - >- + The job is partially succeeded, some results may be missing due to + errors. + id: GoogleCloudAiplatformV1NotebookExecutionJob type: object - description: Represents a parameter spec with condition from its parent parameter. - GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: + GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke: + description: Configurations for PublisherModel GKE deployment type: object + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke + properties: + gkeYamlConfigs: + description: Optional. GKE deployment configuration in yaml format. + items: + type: string + type: array + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig: description: >- - Container to hold value(s), successive in time, for one Feature from the - request. - id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData + Config that contains the strategy used to generate sliding windows in + time series training. A window is a series of rows that comprise the + context up to the time of prediction, and the horizon following. The + corresponding row for each window marks the start of the forecast + horizon. Each window is used as an input example for + training/evaluation. properties: - values: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' + column: + type: string description: >- - Feature values list if values, successive in time, are requested. If - the requested number of values is greater than the number of - existing Feature values, nonexistent values are omitted instead of - being returned as empty. - value: - description: Feature value if a single value is requested. - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset: - properties: - annotatedDatasetDisplayName: - description: The AnnotatedDataset's display name in datalabeling.googleapis.com. + Name of the column that should be used to generate sliding windows. + The column should contain either booleans or string booleans; if the + value of the row is True, generate a sliding window with the horizon + starting at that row. The column will not be used as a feature in + training. + strideLength: + description: >- + Stride length used to generate input examples. Within one time + series, every {$STRIDE_LENGTH} rows will be used to generate a + sliding window. + format: int64 type: string - annotatedDataset: + maxCount: type: string + format: int64 description: >- - Full resource name of data labeling AnnotatedDataset. Format: - `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. - description: Represents one AnnotatedDataset in datalabeling.googleapis.com. - id: >- - GoogleCloudAiplatformV1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset - type: object - GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec: - description: Value specification for a parameter in `DOUBLE` type. + Maximum number of windows that should be generated across all time + series. type: object + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionWindowConfig + GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest: properties: - maxValue: - type: number - description: Required. Inclusive maximum value of the parameter. - format: double - defaultValue: - type: number + artifacts: + items: + type: string description: >- - A default value for a `DOUBLE` parameter that is assumed to be a - relatively good starting point. Unset value signals that there is no - offered starting point. Currently only supported by the Vertex AI - Vizier service. Not supported by HyperparameterTuningJob or - TrainingPipeline. - format: double - minValue: - format: double - description: Required. Inclusive minimum value of the parameter. - type: number - id: GoogleCloudAiplatformV1StudySpecParameterSpecDoubleValueSpec - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation: - description: >- - Training pipeline will infer the proper transformation based on the - statistic of dataset. - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation - properties: - columnName: - type: string + The resource names of the Artifacts to attribute to the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + type: array + executions: + description: >- + The resource names of the Executions to associate with the Context. + Format: + `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + items: + type: string + type: array + description: Request message for MetadataService.AddContextArtifactsAndExecutions. + id: GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest type: object - GoogleCloudAiplatformV1CreatePipelineJobRequest: + GoogleCloudAiplatformV1Endpoint: + id: GoogleCloudAiplatformV1Endpoint + description: >- + Models are deployed into it, and afterwards Endpoint is called to obtain + predictions and explanations. properties: - parent: + dedicatedEndpointDns: + readOnly: true type: string description: >- - Required. The resource name of the Location to create the - PipelineJob in. Format: `projects/{project}/locations/{location}` - pipelineJob: - description: Required. The PipelineJob to create. - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' - pipelineJobId: + Output only. DNS of the dedicated endpoint. Will only be populated + if dedicated_endpoint_enabled is true. Format: + `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + displayName: type: string description: >- - The ID to use for the PipelineJob, which will become the final - component of the PipelineJob name. If not provided, an ID will be - automatically generated. This value should be less than 128 - characters, and valid characters are `/a-z-/`. - type: object - description: Request message for PipelineService.CreatePipelineJob. - id: GoogleCloudAiplatformV1CreatePipelineJobRequest - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs: - type: object - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs - properties: - budgetMilliNodeHours: + Required. The display name of the Endpoint. The name can be up to + 128 characters long and can consist of any UTF-8 characters. + trafficSplit: description: >- - The training budget of creating this model, expressed in milli node - hours i.e. 1,000 value in this field means 1 node hour. The actual - metadata.costMilliNodeHours will be equal or less than this value. - If further model training ceases to provide any improvements, it - will stop without using the full budget and the - metadata.successfulStopReason will be `model-converged`. Note, - node_hour = actual_hour * number_of_nodes_involved. Or - actual_wall_clock_hours = train_budget_milli_node_hours / - (number_of_nodes_involved * 1000) For modelType - `cloud-high-accuracy-1`(default), the budget must be between 20,000 - and 2,000,000 milli node hours, inclusive. The default value is - 192,000 which represents one day in wall time (1000 milli * 24 hours - * 8 nodes). - format: int64 + A map from a DeployedModel's ID to the percentage of this Endpoint's + traffic that should be forwarded to that DeployedModel. If a + DeployedModel's ID is not listed in this map, then it receives no + traffic. The traffic percentage values must add up to 100, or map + must be empty if the Endpoint is to not accept any traffic at a + moment. + type: object + additionalProperties: + format: int32 + type: integer + predictRequestResponseLoggingConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + description: Configures the request-response logging for online prediction. + updateTime: + format: google-datetime + description: Output only. Timestamp when this Endpoint was last updated. type: string - modelType: - enumDescriptions: - - Should not be set. - - >- - A model to be used via prediction calls to uCAIP API. Expected to - have a higher latency, but should also have a higher prediction - quality than other models. - - >- - A model to be used via prediction calls to uCAIP API. Expected to - have a lower latency but relatively lower prediction quality. - - >- - A model that, in addition to being available within Google Cloud, - can also be exported (see ModelService.ExportModel) as TensorFlow - model and used on a mobile or edge device afterwards. Expected to - have low latency, but may have lower prediction quality than other - mobile models. - enum: - - MODEL_TYPE_UNSPECIFIED - - CLOUD_HIGH_ACCURACY_1 - - CLOUD_LOW_ACCURACY_1 - - MOBILE_TF_LOW_LATENCY_1 + readOnly: true + privateServiceConnectConfig: + description: >- + Optional. Configuration for private service connect. network and + private_service_connect_config are mutually exclusive. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PrivateServiceConnectConfig + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key spec for an Endpoint. If set, this + Endpoint and all sub-resources of this Endpoint will be secured by + this key. + etag: type: string - baseModelId: description: >- - The ID of the `base` model. If it is specified, the new model will - be trained based on the `base` model. Otherwise, the new model will - be trained from scratch. The `base` model must be in the same - Project and Location as the new Model to train, and have the same - modelType. + Used to perform consistent read-modify-write updates. If not set, a + blind "overwrite" update happens. + name: + description: Output only. The resource name of the Endpoint. + readOnly: true type: string - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics: - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsVideoObjectTrackingMetrics + enablePrivateServiceConnect: + deprecated: true + type: boolean + description: >- + Deprecated: If true, expose the Endpoint via private service + connect. Only one of the fields, network or + enable_private_service_connect, can be set. + modelDeploymentMonitoringJob: + type: string + readOnly: true + description: >- + Output only. Resource name of the Model Monitoring job associated + with this Endpoint if monitoring is enabled by + JobService.CreateModelDeploymentMonitoringJob. Format: + `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + labels: + type: object + description: >- + The labels with user-defined metadata to organize your Endpoints. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + additionalProperties: + type: string + deployedModels: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedModel' + description: >- + Output only. The models deployed in this Endpoint. To add or remove + DeployedModels use EndpointService.DeployModel and + EndpointService.UndeployModel respectively. + satisfiesPzs: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + network: + type: string + description: >- + Optional. The full name of the Google Compute Engine + [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) + to which the Endpoint should be peered. Private services access must + already be configured for the network. If left unspecified, the + Endpoint is not peered with any network. Only one of the fields, + network or enable_private_service_connect, can be set. + [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): + `projects/{project}/global/networks/{network}`. Where `{project}` is + a project number, as in `12345`, and `{network}` is network name. + satisfiesPzi: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + description: + description: The description of the Endpoint. + type: string + createTime: + type: string + description: Output only. Timestamp when this Endpoint was created. + readOnly: true + format: google-datetime + dedicatedEndpointEnabled: + description: >- + If true, the endpoint will be exposed through a dedicated DNS + [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS + will be isolated from other users' traffic and will have better + performance and reliability. Note: Once you enabled dedicated + endpoint, you won't be able to send request to the shared DNS + {region}-aiplatform.googleapis.com. The limitation will be removed + soon. + type: boolean + type: object + GoogleCloudAiplatformV1UpdateExplanationDatasetResponse: + id: GoogleCloudAiplatformV1UpdateExplanationDatasetResponse + properties: {} + description: Response message of ModelService.UpdateExplanationDataset operation. + type: object + GoogleCloudAiplatformV1FetchFeatureValuesResponse: type: object + id: GoogleCloudAiplatformV1FetchFeatureValuesResponse + description: Response message for FeatureOnlineStoreService.FetchFeatureValues properties: - boundingBoxMeanAveragePrecision: + dataKey: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewDataKey' description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all `boundingBoxMetrics`. + The data key associated with this response. Will only be populated + for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs. + keyValues: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList + description: Feature values in KeyValue format. + protoStruct: + description: Feature values in proto Struct format. + additionalProperties: + type: any + description: Properties of the object. + type: object + GoogleCloudAiplatformV1ListOptimalTrialsRequest: + type: object + description: Request message for VizierService.ListOptimalTrials. + id: GoogleCloudAiplatformV1ListOptimalTrialsRequest + properties: {} + GoogleCloudAiplatformV1SummarizationHelpfulnessResult: + properties: + score: + description: Output only. Summarization Helpfulness score. + format: float + type: number + readOnly: true + explanation: + type: string + readOnly: true + description: Output only. Explanation for summarization helpfulness score. + confidence: + description: Output only. Confidence for summarization helpfulness score. + readOnly: true type: number format: float - evaluatedTrackCount: - type: integer - format: int32 - description: >- - UNIMPLEMENTED. The total number of tracks (i.e. as seen across all - frames) the ground truth used to create this evaluation had. - trackMeanBoundingBoxIou: - description: >- - UNIMPLEMENTED. The single metric for tracks bounding box iou - evaluation: the `meanBoundingBoxIou` averaged over all - `trackMetrics`. + id: GoogleCloudAiplatformV1SummarizationHelpfulnessResult + type: object + description: Spec for summarization helpfulness result. + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics: + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics + properties: + f1Score: type: number format: float - trackMeanAveragePrecision: + description: The harmonic mean of recall and precision. + confidenceThreshold: format: float type: number description: >- - UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the - `meanAveragePrecision` averaged over all `trackMetrics`. - trackMeanMismatchRate: + Metrics are computed with an assumption that the Model never returns + predictions with score lower than this value. + recall: format: float - description: >- - UNIMPLEMENTED. The single metric for tracking consistency - evaluation: the `meanMismatchRate` averaged over all `trackMetrics`. + description: Recall (True Positive Rate) for the given confidence threshold. + type: number + precision: + format: float + description: Precision for the given confidence threshold. type: number - evaluatedFrameCount: - description: >- - UNIMPLEMENTED. The number of video frames used to create this - evaluation. - format: int32 - type: integer - evaluatedBoundingBoxCount: - type: integer - description: >- - UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over - all frames) the ground truth used to create this evaluation had. - format: int32 - trackMetrics: - description: >- - UNIMPLEMENTED. The tracks match metrics for each - intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTrackMetrics - boundingBoxMetrics: - type: array - description: >- - The bounding boxes match metrics for each intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - description: >- - Model evaluation metrics for video object tracking problems. Evaluates - prediction quality of both labeled bounding boxes and labeled tracks - (i.e. series of bounding boxes sharing same label and instance ID). - GoogleTypeExpr: - id: GoogleTypeExpr - 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. type: object + GoogleCloudAiplatformV1BatchPredictionJobOutputInfo: + id: GoogleCloudAiplatformV1BatchPredictionJobOutputInfo properties: - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - expression: + bigqueryOutputDataset: description: >- - Textual representation of an expression in Common Expression - Language syntax. + Output only. The path of the BigQuery dataset created, in + `bq://projectId.bqDatasetId` format, into which the prediction + output is written. type: string - location: + readOnly: true + bigqueryOutputTable: type: string description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - description: + Output only. The name of the BigQuery table created, in + `predictions_` format, into which the prediction output is written. + Can be used by UI to generate the BigQuery output path, for example. + readOnly: true + gcsOutputDirectory: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. + Output only. The full path of the Cloud Storage directory created, + into which the prediction output is written. type: string - GoogleCloudAiplatformV1PurgeExecutionsMetadata: + readOnly: true + description: Further describes this job's output. Supplements output_config. type: object - id: GoogleCloudAiplatformV1PurgeExecutionsMetadata - description: Details of operations that perform MetadataService.PurgeExecutions. - properties: - genericMetadata: - description: Operation metadata for purging Executions. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation: - description: >- - Training pipeline will perform following transformation functions. * The - value converted to float32. * The z_score of the value. * log(value+1) - when the value is greater than or equal to 0. Otherwise, this - transformation is not applied and the value is considered a missing - value. * z_score of log(value+1) when the value is greater than or equal - to 0. Otherwise, this transformation is not applied and the value is - considered a missing value. - properties: - columnName: - type: string - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation + GoogleCloudAiplatformV1ExactMatchResults: type: object - GoogleCloudAiplatformV1StopTrialRequest: - description: Request message for VizierService.StopTrial. - id: GoogleCloudAiplatformV1StopTrialRequest - properties: {} + id: GoogleCloudAiplatformV1ExactMatchResults + description: Results for exact match metric. + properties: + exactMatchMetricValues: + description: Output only. Exact match metric values. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExactMatchMetricValue' + readOnly: true + GoogleCloudAiplatformV1DirectPredictRequest: + id: GoogleCloudAiplatformV1DirectPredictRequest type: object - GoogleCloudAiplatformV1ReadFeatureValuesRequest: - description: Request message for FeaturestoreOnlineServingService.ReadFeatureValues. + properties: + inputs: + description: The prediction input. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + type: array + parameters: + description: The parameters that govern the prediction. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensor' + description: Request message for PredictionService.DirectPredict. + GoogleIamV1SetIamPolicyRequest: type: object - id: GoogleCloudAiplatformV1ReadFeatureValuesRequest properties: - entityId: - type: string + policy: description: >- - Required. ID for a specific entity. For example, for a machine - learning model predicting user clicks on a website, an entity ID - could be `user_123`. - featureSelector: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureSelector' - description: Required. Selector choosing Features of the target EntityType. - GoogleCloudAiplatformV1RaySpec: + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/GoogleIamV1Policy' + description: Request message for `SetIamPolicy` method. + id: GoogleIamV1SetIamPolicyRequest + GoogleCloudAiplatformV1ToolParameterKVMatchSpec: + id: GoogleCloudAiplatformV1ToolParameterKVMatchSpec + properties: + useStrictStringMatch: + description: Optional. Whether to use STRCIT string match on parameter values. + type: boolean + description: Spec for tool parameter key value match metric. type: object - description: >- - Configuration information for the Ray cluster. For experimental launch, - Ray cluster creation and Persistent cluster creation are 1:1 mapping: We - will provision all the nodes within the Persistent cluster as Ray nodes. - id: GoogleCloudAiplatformV1RaySpec + GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata: + id: GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadata properties: - imageUri: - type: string - description: >- - Optional. Default image for user to choose a preferred ML framework - (for example, TensorFlow or Pytorch) by choosing from [Vertex - prebuilt - images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). - Either this or the resource_pool_images is required. Use this field - if you need all the resource pools to have the same Ray image. - Otherwise, use the {@code resource_pool_images} field. - headNodeResourcePoolId: - description: >- - Optional. This will be used to indicate which resource pool will - serve as the Ray head node(the first node within that pool). Will - use the machine from the first workerpool as the head node by - default if this field isn't set. + dataBytesCount: type: string - resourcePoolImages: + format: int64 + description: The ingested data size in bytes. + contentValidationStats: description: >- - Optional. Required if image_uri isn't set. A map of resource_pool_id - to prebuild Ray image if user need to use different images for - different head/worker pools. This map needs to cover all the - resource pool ids. Example: { "ray_head_node_pool": "head image" - "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": - "another worker image" } - additionalProperties: - type: string - type: object - rayMetricSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RayMetricSpec' - description: Optional. Ray metrics configurations. - GoogleCloudAiplatformV1HyperparameterTuningJob: + The validation stats of the content (per file) to be inserted or + updated on the Matching Engine Index resource. Populated if + contentsDeltaUri is provided as part of Index.metadata. Please note + that, currently for those files that are broken or has unsupported + file format, we will not have the stats for those files. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataContentValidationStats + type: object + description: Runtime operation metadata with regard to Matching Engine Index. + GoogleCloudAiplatformV1CancelTuningJobRequest: + type: object + properties: {} + description: Request message for GenAiTuningService.CancelTuningJob. + id: GoogleCloudAiplatformV1CancelTuningJobRequest + GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata: + id: GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata + description: Metadata information for NotebookService.AssignNotebookRuntime. type: object properties: - labels: - description: >- - The labels with user-defined metadata to organize - HyperparameterTuningJobs. Label keys and values can be no longer - than 64 characters (Unicode codepoints), can only contain lowercase - letters, numeric characters, underscores and dashes. International - characters are allowed. See https://goo.gl/xmQnxf for more - information and examples of labels. - type: object - additionalProperties: - type: string - updateTime: + progressMessage: type: string - format: google-datetime description: >- - Output only. Time when the HyperparameterTuningJob was most recently - updated. - readOnly: true - name: - readOnly: true - description: Output only. Resource name of the HyperparameterTuningJob. + A human-readable message that shows the intermediate progress + details of NotebookRuntime. + genericMetadata: + description: The operation generic information. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + GoogleCloudAiplatformV1ExactMatchInstance: + description: Spec for exact match instance. + properties: + reference: type: string - trials: - readOnly: true + description: Required. Ground truth used to compare against the prediction. + prediction: + type: string + description: Required. Output of the evaluated model. + type: object + id: GoogleCloudAiplatformV1ExactMatchInstance + GoogleCloudAiplatformV1ImportDataRequest: + properties: + importConfigs: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataConfig' type: array - description: Output only. Trials of the HyperparameterTuningJob. - state: - readOnly: true + description: >- + Required. The desired input locations. The contents of all input + locations will be imported in one batch. + type: object + description: Request message for DatasetService.ImportData. + id: GoogleCloudAiplatformV1ImportDataRequest + GoogleCloudAiplatformV1SchemaPredictionResultError: + id: GoogleCloudAiplatformV1SchemaPredictionResultError + type: object + properties: + status: enumDescriptions: - - The job state is unspecified. + - 'Not an error; returned on success. HTTP Mapping: 200 OK' - >- - The job has been just created or resumed and processing has not - yet begun. - - The service is preparing to run the job. - - The job is in progress. - - The job completed successfully. - - The job failed. + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request - >- - The job is being cancelled. From this state the job may only go to - either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or - `JOB_STATE_CANCELLED`. - - The job has been cancelled. - - The job has been stopped, and can be resumed. - - The job has expired. + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error - >- - The job is being updated. Only jobs in the `RUNNING` state can be - updated. After updating, the job goes back to the `RUNNING` state. + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request - >- - The job is partially succeeded, some results may be missing due to - errors. - description: Output only. The detailed state of the job. - type: string + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error enum: - - JOB_STATE_UNSPECIFIED - - JOB_STATE_QUEUED - - JOB_STATE_PENDING - - JOB_STATE_RUNNING - - JOB_STATE_SUCCEEDED - - JOB_STATE_FAILED - - JOB_STATE_CANCELLING - - JOB_STATE_CANCELLED - - JOB_STATE_PAUSED - - JOB_STATE_EXPIRED - - JOB_STATE_UPDATING - - JOB_STATE_PARTIALLY_SUCCEEDED - displayName: - type: string - description: >- - Required. The display name of the HyperparameterTuningJob. The name - can be up to 128 characters long and can consist of any UTF-8 - characters. - error: - description: >- - Output only. Only populated when job's state is JOB_STATE_FAILED or - JOB_STATE_CANCELLED. - readOnly: true - $ref: '#/components/schemas/GoogleRpcStatus' - startTime: - description: >- - Output only. Time when the HyperparameterTuningJob for the first - time entered the `JOB_STATE_RUNNING` state. - readOnly: true - format: google-datetime - type: string - trialJobSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' - description: >- - Required. The spec of a trial job. The same spec applies to the - CustomJobs created in all the trials. - parallelTrialCount: - type: integer - description: Required. The desired number of Trials to run in parallel. - format: int32 - endTime: - format: google-datetime - description: >- - Output only. Time when the HyperparameterTuningJob entered any of - the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, - `JOB_STATE_CANCELLED`. + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS type: string - readOnly: true - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' description: >- - Customer-managed encryption key options for a - HyperparameterTuningJob. If this is set, then all resources created - by the HyperparameterTuningJob will be encrypted with the provided - encryption key. - createTime: + Error status. This will be serialized into the enum name e.g. + "NOT_FOUND". + message: + description: Error message with additional details. type: string - description: Output only. Time when the HyperparameterTuningJob was created. - readOnly: true - format: google-datetime - maxFailedTrialCount: - type: integer - format: int32 + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics: + type: object + description: Metrics for image segmentation evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics + properties: + confidenceMetricsEntries: + type: array description: >- - The number of failed Trials that need to be seen before failing the - HyperparameterTuningJob. If set to 0, Vertex AI decides how many - Trials must fail before the whole job fails. - maxTrialCount: - format: int32 - type: integer - description: Required. The desired total number of Trials. - studySpec: - description: Required. Study configuration of the HyperparameterTuningJob. - $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' - id: GoogleCloudAiplatformV1HyperparameterTuningJob - description: >- - Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a - Study specification and multiple CustomJobs with identical CustomJob - specification. - GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata: + Metrics for each confidenceThreshold in + 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 Precision-recall curve + can be derived from it. + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry + GoogleCloudAiplatformV1UndeployIndexResponse: + description: Response message for IndexEndpointService.UndeployIndex. + properties: {} type: object - id: GoogleCloudAiplatformV1MutateDeployedModelOperationMetadata + id: GoogleCloudAiplatformV1UndeployIndexResponse + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs: properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The operation generic information. - description: Runtime operation information for EndpointService.MutateDeployedModel. - CloudAiLargeModelsVisionNamedBoundingBox: + modelType: + type: string + enum: + - MODEL_TYPE_UNSPECIFIED + - CLOUD + - MOBILE_VERSATILE_1 + - MOBILE_JETSON_VERSATILE_1 + enumDescriptions: + - Should not be set. + - >- + A model best tailored to be used within Google Cloud, and which + cannot be exported. Default. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) as a + TensorFlow or TensorFlow Lite model and used on a mobile or edge + device afterwards. + - >- + A model that, in addition to being available within Google Cloud, + can also be exported (see ModelService.ExportModel) to a Jetson + device afterwards. type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs + GoogleCloudAiplatformV1ModelMonitoringAlertConfig: properties: - classes: + enableLogging: + type: boolean + description: >- + Dump the anomalies to Cloud Logging. The anomalies will be put to + json payload encoded from proto + google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. + This can be further sinked to Pub/Sub or any other services + supported by Cloud Logging. + emailAlertConfig: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelMonitoringAlertConfigEmailAlertConfig + description: Email alert config. + notificationChannels: items: type: string type: array - scores: - items: - format: float - type: number - type: array - y2: - type: number - format: float - x1: - format: float - type: number - entities: - type: array - items: - type: string - y1: - type: number - format: float - x2: - type: number - format: float - id: CloudAiLargeModelsVisionNamedBoundingBox - GoogleCloudAiplatformV1TensorboardBlob: - properties: - data: - description: >- - Optional. The bytes of the blob is not present unless it's returned - by the ReadTensorboardBlobData endpoint. - format: byte - type: string - id: description: >- - Output only. A URI safe key uniquely identifying a blob. Can be used - to locate the blob stored in the Cloud Storage bucket of the - consumer project. - type: string - readOnly: true - id: GoogleCloudAiplatformV1TensorboardBlob - description: One blob (e.g, image, graph) viewable on a blob metric plot. + Resource names of the NotificationChannels to send alert. Must be of + the format `projects//notificationChannels/` + id: GoogleCloudAiplatformV1ModelMonitoringAlertConfig + description: The alert config for model monitoring. type: object - GoogleCloudAiplatformV1SchemaTextSegment: + GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata: + description: Details of operations that perform import Feature values. + type: object + id: GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata properties: - startOffset: - type: string - description: >- - Zero-based character index of the first character of the text - segment (counting characters from the beginning of the text). - format: uint64 - content: + importedFeatureValueCount: type: string - description: The text content in the segment for output only. - endOffset: + format: int64 + description: Number of Feature values that have been imported by the operation. + invalidRowCount: description: >- - Zero-based character index of the first character past the end of - the text segment (counting character from the beginning of the - text). The character at the end_offset is NOT included in the text - segment. + The number of rows in input source that weren't imported due to + either * Not having any featureValues. * Having a null entityId. * + Having a null timestamp. * Not being parsable (applicable for CSV + sources). type: string - format: uint64 - id: GoogleCloudAiplatformV1SchemaTextSegment - description: The text segment inside of DataItem. - type: object - GoogleCloudAiplatformV1IndexDatapointSparseEmbedding: - description: >- - Feature embedding vector for sparse index. An array of numbers whose - values are located in the specified dimensions. - properties: - values: - items: - type: number - format: float - description: Required. The list of embedding values of the sparse vector. + format: int64 + genericMetadata: + description: Operation metadata for Featurestore import Feature values. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + sourceUris: + description: The source URI from where Feature values are imported. type: array - dimensions: items: - format: int64 type: string + blockingOperationIds: description: >- - Required. The list of indexes for the embedding values of the sparse - vector. - type: array - id: GoogleCloudAiplatformV1IndexDatapointSparseEmbedding - type: object - GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata: - id: GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata - properties: - candidatesTokenCount: - description: Number of tokens in the response(s). - type: integer - format: int32 - promptTokenCount: - format: int32 - description: Number of tokens in the request. - type: integer - totalTokenCount: - type: integer - format: int32 - type: object - description: Usage metadata about response(s). - GoogleCloudAiplatformV1ComputeTokensRequest: - type: object - properties: - instances: + List of ImportFeatureValues operations running under a single + EntityType that are blocking this operation. items: - type: any + format: int64 + type: string type: array + timestampOutsideRetentionRowsCount: description: >- - Required. The instances that are the input to token computing API - call. Schema is identical to the prediction schema of the text - model, even for the non-text models, like chat models, or Codey - models. - description: Request message for ComputeTokens RPC call. - id: GoogleCloudAiplatformV1ComputeTokensRequest - GoogleCloudAiplatformV1ModelBaseModelSource: - properties: - modelGardenSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelGardenSource' - description: Source information of Model Garden models. - genieSource: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenieSource' - description: Information about the base model of Genie models. - description: >- - User input field to specify the base model source. Currently it only - supports specifing the Model Garden models and Genie models. - type: object - id: GoogleCloudAiplatformV1ModelBaseModelSource - GoogleCloudAiplatformV1NearestNeighborQuery: + The number rows that weren't ingested due to having timestamps + outside the retention boundary. + format: int64 + type: string + importedEntityCount: + description: Number of entities that have been imported by the operation. + format: int64 + type: string + GoogleCloudAiplatformV1PublisherModelCallToActionDeploy: type: object + id: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + description: >- + Model metadata that is needed for UploadModel or + DeployModel/CreateEndpoint requests. properties: - stringFilters: - type: array - description: Optional. The list of string filters. - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryStringFilter - embedding: - description: Optional. The embedding vector that be used for similar search. - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryEmbedding - perCrowdingAttributeNeighborCount: - format: int32 - type: integer + largeModelReference: description: >- - Optional. Crowding is a constraint on a neighbor list produced by - nearest neighbor search requiring that no more than - sper_crowding_attribute_neighbor_count of the k neighbors returned - have the same value of crowding_attribute. It's used for improving - result diversity. - neighborCount: + Optional. Large model reference. When this is set, + model_artifact_spec is not needed. + $ref: '#/components/schemas/GoogleCloudAiplatformV1LargeModelReference' + containerSpec: description: >- - Optional. The number of similar entities to be retrieved from - feature view for each query. - type: integer - format: int32 - parameters: - description: Optional. Parameters that can be set to tune query on the fly. + Optional. The specification of the container that is to be used when + deploying this Model in Vertex AI. Not present for Large Models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelContainerSpec' + deployTaskName: + description: >- + Optional. The name of the deploy task (e.g., "text to image + generation"). + type: string + deployMetadata: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NearestNeighborQueryParameters - entityId: + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata + description: Optional. Metadata information about this deployment config. + sharedResources: + description: >- + The resource name of the shared DeploymentResourcePool to deploy on. + Format: + `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` type: string + dedicatedResources: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DedicatedResources' description: >- - Optional. The entity id whose similar entities should be searched - for. If embedding is set, search will use embedding instead of - entity_id. - id: GoogleCloudAiplatformV1NearestNeighborQuery - description: A query to find a number of similar entities. - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation: - id: >- - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformation - type: object - properties: - numeric: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation - timestamp: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation - auto: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation - text: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation - categorical: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation - GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo: - description: >- - Further describes the output of the ExportModel. Supplements - ExportModelRequest.OutputConfig. - id: GoogleCloudAiplatformV1ExportModelOperationMetadataOutputInfo - properties: - artifactOutputUri: + A description of resources that are dedicated to the DeployedModel, + and that need a higher degree of manual configuration. + automaticResources: description: >- - Output only. If the Model artifact is being exported to Google Cloud - Storage this is the full path of the directory created, into which - the Model files are being written to. + A description of resources that to large degree are decided by + Vertex AI, and require only a modest additional configuration. + $ref: '#/components/schemas/GoogleCloudAiplatformV1AutomaticResources' + artifactUri: type: string - readOnly: true - imageOutputUri: description: >- - Output only. If the Model image is being exported to Google - Container Registry or Artifact Registry this is the full path of the - image created. - readOnly: true + Optional. The path to the directory containing the Model artifact + and any of its supporting files. + modelDisplayName: type: string - type: object - GoogleCloudAiplatformV1Featurestore: + description: Optional. Default model display name. + publicArtifactUri: + type: string + description: >- + Optional. The signed URI for ephemeral Cloud Storage access to model + artifact. + title: + description: Required. The title of the regional resource reference. + type: string + GoogleCloudAiplatformV1Trial: description: >- - Vertex AI Feature Store provides a centralized repository for - organizing, storing, and serving ML features. The Featurestore is a - top-level container for your features and their values. - type: object + A message representing a Trial. A Trial contains a unique set of + Parameters that has been or will be evaluated, along with the objective + metrics got by running the Trial. properties: - encryptionSpec: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' - description: >- - Optional. Customer-managed encryption key spec for data storage. If - set, both of the online and offline data storage will be secured by - this key. - updateTime: + state: + enumDescriptions: + - The Trial state is unspecified. + - >- + Indicates that a specific Trial has been requested, but it has not + yet been suggested by the service. + - Indicates that the Trial has been suggested. + - Indicates that the Trial should stop according to the service. + - Indicates that the Trial is completed successfully. + - >- + Indicates that the Trial should not be attempted again. The + service will set a Trial to INFEASIBLE when it's done but missing + the final_measurement. type: string - description: Output only. Timestamp when this Featurestore was last updated. + enum: + - STATE_UNSPECIFIED + - REQUESTED + - ACTIVE + - STOPPING + - SUCCEEDED + - INFEASIBLE + readOnly: true + description: Output only. The detailed state of the Trial. + startTime: readOnly: true format: google-datetime - labels: - additionalProperties: - type: string + type: string + description: Output only. Time when the Trial was started. + finalMeasurement: + description: Output only. The final measurement containing the objective value. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + readOnly: true + clientId: + type: string + readOnly: true description: >- - Optional. The labels with user-defined metadata to organize your - Featurestore. Label keys and values can be no longer than 64 - characters (Unicode codepoints), can only contain lowercase letters, - numeric characters, underscores and dashes. International characters - are allowed. See https://goo.gl/xmQnxf for more information on and - examples of labels. No more than 64 user labels can be associated - with one Featurestore(System labels are excluded)." System reserved - label keys are prefixed with "aiplatform.googleapis.com/" and are - immutable. - type: object - createTime: + Output only. The identifier of the client that originally requested + this Trial. Each client is identified by a unique client_id. When a + client asks for a suggestion, Vertex AI Vizier will assign it a + Trial. The client should evaluate the Trial, complete it, and report + back to Vertex AI Vizier. If suggestion is asked again by same + client_id before the Trial is completed, the same Trial will be + returned. Multiple clients with different client_ids can ask for + suggestions simultaneously, each of them will get their own Trial. + id: + description: Output only. The identifier of the Trial assigned by the service. readOnly: true - format: google-datetime - description: Output only. Timestamp when this Featurestore was created. type: string - onlineStorageTtlDays: - format: int32 + measurements: + type: array description: >- - Optional. TTL in days for feature values that will be stored in - online serving storage. The Feature Store online storage - periodically removes obsolete feature values older than - `online_storage_ttl_days` since the feature generation time. Note - that `online_storage_ttl_days` should be less than or equal to - `offline_storage_ttl_days` for each EntityType under a featurestore. - If not set, default to 4000 days - type: integer - onlineServingConfig: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig + Output only. A list of measurements that are strictly + lexicographically ordered by their induced tuples (steps, + elapsed_duration). These are used for early stopping computations. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + readOnly: true + webAccessUris: + type: object + readOnly: true description: >- - Optional. Config for online storage resources. The field should not - co-exist with the field of `OnlineStoreReplicationConfig`. If both - of it and OnlineStoreReplicationConfig are unset, the feature store - will not have an online store and cannot be used for online serving. - name: + Output only. URIs for accessing [interactive + shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) + (one URI for each training node). Only available if this trial is + part of a HyperparameterTuningJob and the job's + trial_job_spec.enable_web_access field is `true`. The keys are names + of each node used for the trial; for example, `workerpool0-0` for + the primary node, `workerpool1-0` for the first node in the second + worker pool, and `workerpool1-1` for the second node in the second + worker pool. The values are the URIs for each node's interactive + shell. + additionalProperties: + type: string + parameters: + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrialParameter' + description: Output only. The parameters of the Trial. + type: array + endTime: description: >- - Output only. Name of the Featurestore. Format: - `projects/{project}/locations/{location}/featurestores/{featurestore}` + Output only. Time when the Trial's status changed to `SUCCEEDED` or + `INFEASIBLE`. type: string readOnly: true - etag: - description: >- - Optional. Used to perform consistent read-modify-write updates. If - not set, a blind "overwrite" update happens. + format: google-datetime + infeasibleReason: type: string - state: + readOnly: true + description: >- + Output only. A human readable string describing why the Trial is + infeasible. This is set only if Trial state is `INFEASIBLE`. + name: + readOnly: true type: string + description: Output only. Resource name of the Trial assigned by the service. + customJob: readOnly: true - enum: - - STATE_UNSPECIFIED - - STABLE - - UPDATING - description: Output only. State of the featurestore. - enumDescriptions: - - Default value. This value is unused. - - >- - State when the featurestore configuration is not being updated and - the fields reflect the current configuration of the featurestore. - The featurestore is usable in this state. - - >- - The state of the featurestore configuration when it is being - updated. During an update, the fields reflect either the original - configuration or the updated configuration of the featurestore. - For example, `online_serving_config.fixed_node_count` can take - minutes to update. While the update is in progress, the - featurestore is in the UPDATING state, and the value of - `fixed_node_count` can be the original value or the updated value, - depending on the progress of the operation. Until the update - completes, the actual number of nodes can still be the original - value of `fixed_node_count`. The featurestore is still usable in - this state. - id: GoogleCloudAiplatformV1Featurestore - GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata: - id: GoogleCloudAiplatformV1DeleteFeatureValuesOperationMetadata + type: string + description: >- + Output only. The CustomJob name linked to the Trial. It's set for a + HyperparameterTuningJob's Trial. + id: GoogleCloudAiplatformV1Trial type: object - description: Details of operations that delete Feature values. - properties: - genericMetadata: - description: Operation metadata for Featurestore delete Features values. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudAiplatformV1AddExecutionEventsResponse: - id: GoogleCloudAiplatformV1AddExecutionEventsResponse - description: Response message for MetadataService.AddExecutionEvents. + GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest: type: object + description: Request message for JobService.ResumeModelDeploymentMonitoringJob. properties: {} - GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata: - type: object - id: GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata - description: Details of operations that perform reboot PersistentResource. + id: GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + GoogleCloudAiplatformV1ErrorAnalysisAnnotation: + description: Model error analysis for each annotation. properties: - progressMessage: + attributedItems: + description: >- + Attributed items for a given annotation, typically representing + neighbors from the training sets constrained by the query type. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ErrorAnalysisAnnotationAttributedItem + outlierScore: + format: double + description: >- + The outlier score of this annotated item. Usually defined as the min + of all distances from attributed items. + type: number + outlierThreshold: + format: double + description: >- + The threshold used to determine if this annotation is an outlier or + not. + type: number + queryType: + description: The query type used for finding the attributed items. + enumDescriptions: + - Unspecified query type for model error analysis. + - Query similar samples across all classes in the dataset. + - Query similar samples from the same class of the input sample. + - Query dissimilar samples from the same class of the input sample. type: string - description: Progress Message for Reboot LRO - genericMetadata: - description: Operation metadata for PersistentResource. - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - GoogleCloudLocationListLocationsResponse: - description: The response message for Locations.ListLocations. + enum: + - QUERY_TYPE_UNSPECIFIED + - ALL_SIMILAR + - SAME_CLASS_SIMILAR + - SAME_CLASS_DISSIMILAR + type: object + id: GoogleCloudAiplatformV1ErrorAnalysisAnnotation + GoogleCloudAiplatformV1ExportDataResponse: + id: GoogleCloudAiplatformV1ExportDataResponse properties: - nextPageToken: - type: string - description: The standard List next-page token. - locations: + dataStats: description: >- - A list of locations that matches the specified filter in the - request. - type: array + Only present for custom code training export use case. Records data + stats, i.e., train/validation/test item/annotation counts calculated + during the export operation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelDataStats' + exportedFiles: + description: >- + All of the files that are exported in this export operation. For + custom code training export, only three (training, validation and + test) Cloud Storage paths in wildcard format are populated (for + example, gs://.../training-*). items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + type: string + type: array + description: Response message for DatasetService.ExportData. type: object - id: GoogleCloudLocationListLocationsResponse - GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction: + GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput: type: object properties: - inputs: - description: The input parameters of this TrainingJob. + metricSpec: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs - id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlTextExtraction - description: A TrainingJob that trains and uploads an AutoML Text Extraction Model. - GoogleCloudAiplatformV1ModelExportFormat: + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessSpec + description: Required. Spec for question answering helpfulness score metric. + instance: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInstance + description: Required. Question answering helpfulness instance. + id: GoogleCloudAiplatformV1QuestionAnsweringHelpfulnessInput + description: Input for question answering helpfulness metric. + GoogleCloudAiplatformV1ResourceRuntime: type: object + description: Persistent Cluster runtime information as output + id: GoogleCloudAiplatformV1ResourceRuntime properties: - exportableContents: - items: - enum: - - EXPORTABLE_CONTENT_UNSPECIFIED - - ARTIFACT - - IMAGE - type: string - enumDescriptions: - - Should not be used. - - >- - Model artifact and any of its supported files. Will be exported - to the location specified by the `artifactDestination` field of - the ExportModelRequest.output_config object. - - >- - The container image that is to be used when deploying this - Model. Will be exported to the location specified by the - `imageDestination` field of the ExportModelRequest.output_config - object. - description: Output only. The content of this Model that may be exported. - readOnly: true - type: array - id: - type: string + accessUris: readOnly: true + type: object + additionalProperties: + type: string description: >- - Output only. The ID of the export format. The possible format IDs - are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * - `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be - used in the browser and in Node.js using JavaScript. * `core-ml` - Used for iOS mobile devices. * `custom-trained` A Model that was - uploaded or trained by custom code. - description: >- - Represents export format supported by the Model. All formats export to - Google Cloud Storage. - id: GoogleCloudAiplatformV1ModelExportFormat - GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest: + Output only. URIs for user to connect to the Cluster. Example: { + "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" + "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } + GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource: type: object properties: - evaluatedAnnotations: + uri: type: array items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EvaluatedAnnotation' - description: Required. Evaluated annotations resource to be imported. - description: Request message for ModelService.BatchImportEvaluatedAnnotations - id: GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest - GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: - description: Content filter results for a prompt sent in the request. + type: string + description: >- + Cloud Storage URI of one or more files. Only CSV files are + supported. The first line of the CSV file is used as the header. If + there are multiple files, the header is the first line of the + lexicographically first file, the other files must either contain + the exact same header or omit the header. + id: GoogleCloudAiplatformV1SchemaTimeSeriesDatasetMetadataGcsSource + GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata: type: object + description: The metadata of Datasets that contain Text Prompt data. + id: GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata properties: - safetyRatings: + gcsUri: + description: The Google Cloud Storage URI that stores the prompt data. + type: string + stopSequences: items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' - readOnly: true + type: string type: array - description: Output only. Safety ratings. - blockReasonMessage: + description: Customized stop sequences. + groundingConfig: + description: Grounding checking configuration. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig + promptType: type: string - description: Output only. A readable block reason message. - readOnly: true - blockReason: - enum: - - BLOCKED_REASON_UNSPECIFIED - - SAFETY - - OTHER - - BLOCKLIST - - PROHIBITED_CONTENT - enumDescriptions: - - Unspecified blocked reason. - - Candidates blocked due to safety. - - Candidates blocked due to other reason. - - >- - Candidates blocked due to the terms which are included from the - terminology blocklist. - - Candidates blocked due to prohibited content. - readOnly: true - description: Output only. Blocked reason. + description: Type of the prompt dataset. + systemInstruction: + description: The content of the prompt dataset system instruction. type: string - id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback - GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata: - id: GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata - description: Runtime operation information for DatasetService.RestoreDatasetVersion. - properties: - genericMetadata: - $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' - description: The common part of the operation metadata. - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics: - description: Metrics for image object detection evaluation results. - properties: - boundingBoxMeanAveragePrecision: + topK: + type: string + description: >- + Top K value set when the dataset was saved. This value determines + how many candidates with highest probability from the vocab would be + selected for each decoding step. + format: int64 + candidateCount: + type: string + description: Number of candidates. + format: int64 + note: + description: User-created prompt note. Note size limit is 2KB. + type: string + hasPromptVariable: + type: boolean + description: Whether the prompt dataset has prompt variable. + systemInstructionGcsUri: + type: string + description: >- + The Google Cloud Storage URI that stores the system instruction, + starting with gs://. + temperature: format: float description: >- - The single metric for bounding boxes evaluation: the - `meanAveragePrecision` averaged over all - `boundingBoxMetricsEntries`. + Temperature value used for sampling set when the dataset was saved. + This value is used to tune the degree of randomness. type: number - boundingBoxMetrics: - description: >- - The bounding boxes match metrics for each intersection-over-union - threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label - confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsBoundingBoxMetrics - evaluatedBoundingBoxCount: - type: integer + maxOutputTokens: description: >- - The total number of bounding boxes (i.e. summed over all images) the - ground truth used to create this evaluation had. - format: int32 - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics - type: object - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef: - properties: - displayName: - description: Display name of the AnnotationSpec. + Value of the maximum number of tokens generated set when the dataset + was saved. type: string - id: - description: ID of the AnnotationSpec. + format: int64 + topP: + type: number + format: float + description: >- + Top P value set when the dataset was saved. Given topK tokens for + decoding, top candidates will be selected until the sum of their + probabilities is topP. + text: + description: The content of the prompt dataset. type: string + GoogleCloudAiplatformV1GenerateContentResponse: type: object - id: >- - GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef - GoogleCloudAiplatformV1ListIndexesResponse: - type: object + description: Response message for [PredictionService.GenerateContent]. + id: GoogleCloudAiplatformV1GenerateContentResponse properties: - indexes: - items: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + usageMetadata: + description: Usage metadata about the response(s). + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata + candidates: + readOnly: true type: array - description: List of indexes in the requested page. - nextPageToken: - type: string + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Candidate' + description: Output only. Generated candidates. + promptFeedback: description: >- - A token to retrieve next page of results. Pass to - ListIndexesRequest.page_token to obtain that page. - description: Response message for IndexService.ListIndexes. - id: GoogleCloudAiplatformV1ListIndexesResponse - parameters: - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - key: + Output only. Content filter results for a prompt sent in the + request. Note: Sent only in the first stream chunk. Only happens + when no candidates were generated due to content violations. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + readOnly: true + GoogleCloudAiplatformV1FeatureOnlineStoreBigtable: + id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable + type: object + properties: + autoScaling: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStoreBigtableAutoScaling + description: Required. Autoscaling config applied to Bigtable Instance. + GoogleCloudAiplatformV1SmoothGradConfig: + id: GoogleCloudAiplatformV1SmoothGradConfig + properties: + featureNoiseSigma: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureNoiseSigma' + description: >- + This is similar to noise_sigma, but provides additional flexibility. + A separate noise sigma can be provided for each feature, which is + useful if their distributions are different. No noise is added to + features that are not set. If this field is unset, noise_sigma will + be used for all features. + noisySampleCount: + description: >- + The number of gradient samples to use for approximation. The higher + this number, the more accurate the gradient is, but the runtime + complexity increases by this factor as well. Valid range of its + value is [1, 50]. Defaults to 3. + format: int32 + type: integer + noiseSigma: + format: float + type: number + description: >- + This is a single float value and will be used to add noise to all + the features. Use this field when all features are normalized to + have the same distribution: scale to range [0, 1], [-1, 1] or + z-scoring, where features are normalized to have 0-mean and + 1-variance. Learn more about + [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). + For best results the recommended value is about 10% - 20% of the + standard deviation of the input feature. Refer to section 3.2 of the + SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to + 0.1. If the distribution is different per feature, set + feature_noise_sigma instead for each feature. + type: object description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - quotaUser: + Config for SmoothGrad approximation of gradients. When enabled, the + gradients are approximated by averaging the gradients from noisy samples + in the vicinity of the inputs. Adding noise can help improve the + computed gradients. Refer to this paper for more details: + https://arxiv.org/pdf/1706.03825.pdf + GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig: + properties: + sampleRate: + type: number + description: Sample rate (0, 1] + format: double + description: Requests are randomly selected. + type: object + id: GoogleCloudAiplatformV1SamplingStrategyRandomSampleConfig + GoogleCloudAiplatformV1NfsMount: + id: GoogleCloudAiplatformV1NfsMount + properties: + path: + type: string + description: >- + Required. Source path exported from NFS server. Has to start with + '/', and combined with the ip address, it indicates the source mount + path in the form of `server:path` + mountPoint: + description: >- + Required. Destination mount path. The NFS will be mounted for the + user under /mnt/nfs/ + type: string + server: + description: Required. IP address of the NFS server. + type: string + description: Represents a mount configuration for Network File System (NFS) to mount. + type: object + GoogleCloudAiplatformV1BatchPredictionJobInputConfig: + properties: + bigquerySource: + description: >- + The BigQuery location of the input table. The schema of the table + should be in the format described by the given context OpenAPI + Schema, if one is provided. The table may contain additional columns + that are not described by the schema, and they will be ignored. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQuerySource' + gcsSource: + description: The Cloud Storage location for the input instances. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GcsSource' + instancesFormat: + type: string + description: >- + Required. The format in which instances are given, must be one of + the Model's supported_input_storage_formats. + type: object + id: GoogleCloudAiplatformV1BatchPredictionJobInputConfig description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - x-stackQL-resources: - models: - id: google.aiplatform.models - name: models - title: Models - methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - copy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:copy/post - response: - mediaType: application/json - openAPIDocKey: '200' - upload: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:upload/post - response: - mediaType: application/json - openAPIDocKey: '200' - export: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:export/post - response: - mediaType: application/json - openAPIDocKey: '200' - merge_version_aliases: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:mergeVersionAliases/post - response: - mediaType: application/json - openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.models - list: - operation: *ref_1 - response: *ref_2 - server_streaming_predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:serverStreamingPredict/post - response: - mediaType: application/json - openAPIDocKey: '200' - generate_content: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:generateContent/post - response: - mediaType: application/json - openAPIDocKey: '200' - count_tokens: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:countTokens/post - response: - mediaType: application/json - openAPIDocKey: '200' - stream_raw_predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamRawPredict/post - response: - mediaType: application/json - openAPIDocKey: '200' - raw_predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:rawPredict/post - response: - mediaType: application/json - openAPIDocKey: '200' - stream_generate_content: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post - response: - mediaType: application/json - openAPIDocKey: '200' - predict: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post - response: - mediaType: application/json - openAPIDocKey: '200' - compute_tokens: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:computeTokens/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/models/methods/get' - - $ref: '#/components/x-stackQL-resources/models/methods/get' - - $ref: '#/components/x-stackQL-resources/models/methods/list' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/models/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/models/methods/delete' - locations: - id: google.aiplatform.locations - name: locations - title: Locations - methods: - _list: - operation: &ref_3 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.locations - list: - operation: *ref_3 - response: *ref_4 - get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/locations/methods/get' - - $ref: '#/components/x-stackQL-resources/locations/methods/list' - insert: [] - update: [] - delete: [] - operations: - id: google.aiplatform.operations - name: operations - title: Operations - methods: - _list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_5 - response: *ref_6 - cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - wait: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}:wait/post - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: + Configures the input to BatchPredictionJob. See + Model.supported_input_storage_formats for Model's supported input + formats, and how instances should be expressed via any of them. + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult: + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionImageSegmentationPredictionResult + properties: + categoryMask: + description: >- + A PNG image where each pixel in the mask represents the category in + which the pixel in the original image was predicted to belong to. + The size of this image will be the same as the original image. The + mapping between the AnntoationSpec and the color can be found in + model's metadata. The model will choose the most likely category and + if none of the categories reach the confidence threshold, the pixel + will be marked as background. + type: string + confidenceMask: + type: string + description: >- + A one channel image which is encoded as an 8bit lossless PNG. The + size of the image will be the same as the original image. For a + specific pixel, darker color means less confidence in correctness of + the cateogry in the categoryMask for the corresponding pixel. Black + means no confidence and white means complete confidence. + description: Prediction output format for Image Segmentation. + type: object + GoogleCloudAiplatformV1ListAnnotationsResponse: + type: object + description: Response message for DatasetService.ListAnnotations. + properties: + nextPageToken: + type: string + description: The standard List next-page token. + annotations: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Annotation' + type: array + description: >- + A list of Annotations that matches the specified filter in the + request. + id: GoogleCloudAiplatformV1ListAnnotationsResponse + GoogleCloudAiplatformV1PublisherModelCallToAction: + id: GoogleCloudAiplatformV1PublisherModelCallToAction + properties: + openNotebook: + description: Optional. Open notebook of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + openFineTuningPipelines: + description: Optional. Open fine-tuning pipelines of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines + requestAccess: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Request for access. + openFineTuningPipeline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open fine-tuning pipeline of the PublisherModel. + openGenerationAiStudio: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open in Generation AI Studio. + multiDeployVertex: + description: >- + Optional. Multiple setups to deploy the PublisherModel to Vertex + Endpoint. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex + deployGke: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke + description: Optional. Deploy PublisherModel to Google Kubernetes Engine. + openGenie: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open Genie / Playground. + openPromptTuningPipeline: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Open prompt-tuning pipeline of the PublisherModel. + openNotebooks: + description: Optional. Open notebooks of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionOpenNotebooks + viewRestApi: + description: Optional. To view Rest API docs. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionViewRestApi + deploy: + description: Optional. Deploy the PublisherModel to Vertex Endpoint. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionDeploy + createApplication: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Optional. Create application using the PublisherModel. + openEvaluationPipeline: + description: Optional. Open evaluation pipeline of the PublisherModel. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + description: Actions could take on this Publisher Model. + type: object + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult: + properties: + timeSegmentStart: + type: string + description: >- + The beginning, inclusive, of the video's time segment in which the + object instance has been detected. Expressed as a number of seconds + as measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + format: google-duration + displayName: + type: string + description: The display name of the AnnotationSpec that had been identified. + confidence: + type: number + format: float + description: >- + The Model's confidence in correction of this prediction, higher + value means higher confidence. + id: + type: string + description: The resource ID of the AnnotationSpec that had been identified. + timeSegmentEnd: + description: >- + The end, inclusive, of the video's time segment in which the object + instance has been detected. Expressed as a number of seconds as + measured from the start of the video, with fractions up to a + microsecond precision, and with "s" appended at the end. + type: string + format: google-duration + frames: + items: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] - update: [] + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame + description: >- + All of the frames of the video in which a single object instance has + been detected. The bounding boxes in the frames identify the same + object. + type: array + type: object + description: Prediction output format for Video Object Tracking. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionVideoObjectTrackingPredictionResult + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHierarchyConfig + type: object + properties: + groupColumns: + description: >- + A list of time series attribute column names that define the time + series hierarchy. Only one level of hierarchy is supported, ex. + 'region' for a hierarchy of stores or 'department' for a hierarchy + of products. If multiple columns are specified, time series will be + grouped by their combined values, ex. ('blue', 'large') for 'color' + and 'size', up to 5 columns are accepted. If no group columns are + specified, all time series are considered to be part of the same + group. + type: array + items: + type: string + temporalTotalWeight: + type: number + format: double + description: >- + The weight of the loss for predictions aggregated over the horizon + for a single time series. + groupTotalWeight: + description: >- + The weight of the loss for predictions aggregated over time series + in the same group. + type: number + format: double + groupTemporalTotalWeight: + type: number + description: >- + The weight of the loss for predictions aggregated over both the + horizon and time series in the same hierarchy group. + format: double + description: >- + Configuration that defines the hierarchical relationship of time series + and parameters for hierarchical forecasting strategies. + GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata: + id: GoogleCloudAiplatformV1CreateIndexEndpointOperationMetadata + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: The operation generic information. + description: >- + Runtime operation information for + IndexEndpointService.CreateIndexEndpoint. + type: object + GoogleCloudAiplatformV1ActiveLearningConfig: + properties: + sampleConfig: + description: >- + Active learning data sampling config. For every active learning + labeling iteration, it will select a batch of data based on the + sampling strategy. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SampleConfig' + maxDataItemCount: + format: int64 + type: string + description: Max number of human labeled DataItems. + trainingConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingConfig' + description: >- + CMLE training config. For every active learning labeling iteration, + system will train a machine learning model on CMLE. The trained + model will be used by data sampling algorithm to select DataItems. + maxDataItemPercentage: + description: Max percent of total DataItems for human labeling. + format: int32 + type: integer + id: GoogleCloudAiplatformV1ActiveLearningConfig + description: >- + Parameters that configure the active learning pipeline. Active learning + will label the data incrementally by several iterations. For every + iteration, it will select a batch of data based on the sampling + strategy. + type: object + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata: + id: GoogleCloudAiplatformV1SchemaTrainingjobDefinitionTftForecastingMetadata + properties: + evaluatedDataItemsBigqueryUri: + type: string + description: BigQuery destination uri for exported evaluated examples. + trainCostMilliNodeHours: + description: >- + Output only. The actual training cost of the model, expressed in + milli node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed the train budget. + format: int64 + type: string + description: Model metadata specific to TFT Forecasting. + type: object + GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata: + description: Details of operations that perform create Featurestore. + properties: + genericMetadata: + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenericOperationMetadata' + description: Operation metadata for Featurestore. + id: GoogleCloudAiplatformV1CreateFeaturestoreOperationMetadata + type: object + GoogleCloudAiplatformV1GoogleSearchRetrieval: + description: Tool to retrieve public web data for grounding, powered by Google. + properties: {} + id: GoogleCloudAiplatformV1GoogleSearchRetrieval + type: object + GoogleCloudAiplatformV1ListMetadataStoresResponse: + properties: + metadataStores: + type: array + description: The MetadataStores found for the Location. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + nextPageToken: + type: string + description: >- + A token, which can be sent as ListMetadataStoresRequest.page_token + to retrieve the next page. If this field is not populated, there are + no subsequent pages. + id: GoogleCloudAiplatformV1ListMetadataStoresResponse + description: Response message for MetadataService.ListMetadataStores. + type: object + GoogleCloudAiplatformV1StopTrialRequest: + id: GoogleCloudAiplatformV1StopTrialRequest + properties: {} + type: object + description: Request message for VizierService.StopTrial. + GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata: + properties: + maxWallTime: + readOnly: true + format: google-datetime + description: >- + Output only. Max wall clock timestamp of all data points within a + TensorboardTimeSeries. + type: string + maxBlobSequenceLength: + readOnly: true + type: string + format: int64 + description: >- + Output only. The largest blob sequence length (number of blobs) of + all data points in this time series, if its ValueType is + BLOB_SEQUENCE. + maxStep: + type: string + format: int64 + readOnly: true + description: >- + Output only. Max step index of all data points within a + TensorboardTimeSeries. + id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata + description: Describes metadata for a TensorboardTimeSeries. + type: object + GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource: + type: object + id: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataGcsSource + properties: + uri: + description: >- + Cloud Storage URI of one or more files. Only CSV files are + supported. The first line of the CSV file is used as the header. If + there are multiple files, the header is the first line of the + lexicographically first file, the other files must either contain + the exact same header or omit the header. + type: array + items: + type: string + GoogleCloudAiplatformV1CreatePipelineJobRequest: + id: GoogleCloudAiplatformV1CreatePipelineJobRequest + properties: + pipelineJobId: + description: >- + The ID to use for the PipelineJob, which will become the final + component of the PipelineJob name. If not provided, an ID will be + automatically generated. This value should be less than 128 + characters, and valid characters are `/a-z-/`. + type: string + parent: + type: string + description: >- + Required. The resource name of the Location to create the + PipelineJob in. Format: `projects/{project}/locations/{location}` + pipelineJob: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + description: Required. The PipelineJob to create. + type: object + description: Request message for PipelineService.CreatePipelineJob. + GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest: + type: object + properties: + tensorboardTimeSeriesId: + description: >- + Optional. The user specified unique ID to use for the + TensorboardTimeSeries, which becomes the final component of the + TensorboardTimeSeries's resource name. This value should match + "a-z0-9{0, 127}" + type: string + tensorboardTimeSeries: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries' + description: Required. The TensorboardTimeSeries to create. + parent: + description: >- + Required. The resource name of the TensorboardRun to create the + TensorboardTimeSeries in. Format: + `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + type: string + description: Request message for TensorboardService.CreateTensorboardTimeSeries. + id: GoogleCloudAiplatformV1CreateTensorboardTimeSeriesRequest + GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse: + description: Response message for TensorboardService.ExportTensorboardTimeSeriesData. + id: GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + properties: + nextPageToken: + description: >- + A token, which can be sent as page_token to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + timeSeriesDataPoints: + description: The returned time series data points. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TimeSeriesDataPoint' + type: object + GoogleCloudAiplatformV1ExplanationSpec: + type: object + properties: + metadata: + description: >- + Optional. Metadata describing the Model's input and output for + explanation. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationMetadata' + parameters: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplanationParameters' + description: >- + Required. Parameters that configure explaining of the Model's + predictions. + id: GoogleCloudAiplatformV1ExplanationSpec + description: Specification of Model explanation. + GoogleCloudAiplatformV1ListNasTrialDetailsResponse: + type: object + id: GoogleCloudAiplatformV1ListNasTrialDetailsResponse + description: Response message for JobService.ListNasTrialDetails + properties: + nasTrialDetails: + description: List of top NasTrials in the requested page. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + type: array + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListNasTrialDetailsRequest.page_token to obtain that page. + GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig: + id: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig + type: object + description: Configuration for logging request-response to a BigQuery table. + properties: + samplingRate: + type: number + format: double + description: >- + Percentage of requests to be logged, expressed as a fraction in + range(0,1]. + enabled: + description: If logging is enabled or not. + type: boolean + bigqueryDestination: + description: >- + BigQuery table for logging. If only given a project, a new dataset + will be created with name `logging__` where will be made + BigQuery-dataset-name compatible (e.g. most special characters will + become underscores). If no table name is given, a new table will be + created with name `request_response_logging` + $ref: '#/components/schemas/GoogleCloudAiplatformV1BigQueryDestination' + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry: + description: Entry for the Quantiles loss type optimization objective. + properties: + scaledPinballLoss: + format: float + description: The scaled pinball loss of this quantile. + type: number + observedQuantile: + type: number + description: >- + This is a custom metric that calculates the percentage of true + values that were less than the predicted value for that quantile. + Only populated when optimization_objective is minimize-quantile-loss + and each entry corresponds to an entry in quantiles The percent + value can be used to compare with the quantile value, which is the + target value. + format: double + quantile: + type: number + format: double + description: The quantile for this entry. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry + type: object + GoogleIamV1Policy: + properties: + version: + format: int32 + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + bindings: + type: array + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + etag: + description: >- + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + format: byte + type: string + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + id: GoogleIamV1Policy + GoogleCloudAiplatformV1TimestampSplit: + properties: + validationFraction: + description: >- + The fraction of the input data that is to be used to validate the + Model. + type: number + format: double + key: + type: string + description: >- + Required. The key is a name of one of the Dataset's data columns. + The values of the key (the values in the column) must be in RFC 3339 + `date-time` format, where `time-offset` = `"Z"` (e.g. + 1985-04-12T23:20:50.52Z). If for a piece of data the key is not + present or has an invalid value, that piece is ignored by the + pipeline. + trainingFraction: + type: number + format: double + description: >- + The fraction of the input data that is to be used to train the + Model. + testFraction: + format: double + description: >- + The fraction of the input data that is to be used to evaluate the + Model. + type: number + id: GoogleCloudAiplatformV1TimestampSplit + type: object + description: >- + Assigns input data to training, validation, and test sets based on a + provided timestamps. The youngest data pieces are assigned to training + set, next to validation set, and the oldest to the test set. Supported + only for tabular Datasets. + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective: + type: object + description: Stats requested for specific objective. + id: >- + GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective + properties: + type: + type: string + enum: + - MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED + - RAW_FEATURE_SKEW + - RAW_FEATURE_DRIFT + - FEATURE_ATTRIBUTION_SKEW + - FEATURE_ATTRIBUTION_DRIFT + enumDescriptions: + - Default value, should not be set. + - >- + Raw feature values' stats to detect skew between + Training-Prediction datasets. + - >- + Raw feature values' stats to detect drift between + Serving-Prediction datasets. + - >- + Feature attribution scores to detect skew between + Training-Prediction datasets. + - >- + Feature attribution scores to detect skew between Prediction + datasets collected within different time windows. + topFeatureCount: + description: >- + If set, all attribution scores between + SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and + SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are + fetched, and page token doesn't take effect in this case. Only used + to retrieve attribution score for the top Features which has the + highest attribution score in the latest monitoring run. + format: int32 + type: integer + GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization: + id: GoogleCloudAiplatformV1ExplanationMetadataInputMetadataVisualization + type: object + properties: + colorMap: + description: >- + The color scheme used for the highlighted areas. Defaults to + PINK_GREEN for Integrated Gradients attribution, which shows + positive attributions in green and negative in pink. Defaults to + VIRIDIS for XRAI attribution, which highlights the most influential + regions in yellow and the least influential in blue. + enumDescriptions: + - Should not be used. + - 'Positive: green. Negative: pink.' + - >- + Viridis color map: A perceptually uniform color mapping which is + easier to see by those with colorblindness and progresses from + yellow to green to blue. Positive: yellow. Negative: blue. + - 'Positive: red. Negative: red.' + - 'Positive: green. Negative: green.' + - 'Positive: green. Negative: red.' + - PiYG palette. + enum: + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + type: string + overlayType: + enum: + - OVERLAY_TYPE_UNSPECIFIED + - NONE + - ORIGINAL + - GRAYSCALE + - MASK_BLACK + type: string + enumDescriptions: + - Default value. This is the same as NONE. + - No overlay. + - The attributions are shown on top of the original image. + - >- + The attributions are shown on top of grayscaled version of the + original image. + - >- + The attributions are used as a mask to reveal predictive parts of + the image and hide the un-predictive parts. + description: >- + How the original image is displayed in the visualization. Adjusting + the overlay can help increase visual clarity if the original image + makes it difficult to view the visualization. Defaults to NONE. + clipPercentUpperbound: + description: >- + Excludes attributions above the specified percentile from the + highlighted areas. Using the clip_percent_upperbound and + clip_percent_lowerbound together can be useful for filtering out + noise and making it easier to see areas of strong attribution. + Defaults to 99.9. + format: float + type: number + type: + description: >- + Type of the image visualization. Only applicable to Integrated + Gradients attribution. OUTLINES shows regions of attribution, while + PIXELS shows per-pixel attribution. Defaults to OUTLINES. + enumDescriptions: + - Should not be used. + - Shows which pixel contributed to the image prediction. + - >- + Shows which region contributed to the image prediction by + outlining the region. + type: string + enum: + - TYPE_UNSPECIFIED + - PIXELS + - OUTLINES + polarity: + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + description: >- + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + enumDescriptions: + - Default value. This is the same as POSITIVE. + - >- + Highlights the pixels/outlines that were most influential to the + model's prediction. + - >- + Setting polarity to negative highlights areas that does not lead + to the models's current prediction. + - Shows both positive and negative attributions. + type: string + clipPercentLowerbound: + format: float + description: >- + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. + type: number + description: Visualization configurations for image explanation. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec: + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec + properties: + maxFailedTrialCount: + description: >- + The number of failed Trials that need to be seen before failing the + HyperparameterTuningJob. If set to 0, Vertex AI decides how many + Trials must fail before the whole job fails. + type: integer + format: int32 + trialJobSpec: + description: >- + The spec of a trial job. The same spec applies to the CustomJobs + created in all the trials. + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJobSpec' + parallelTrialCount: + description: The desired number of Trials to run in parallel. + format: int32 + type: integer + maxTrialCount: + type: integer + format: int32 + description: The desired total number of Trials. + studySpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StudySpec' + description: Study configuration of the HyperparameterTuningJob. + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation: + properties: + auto: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation + text: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation + timestamp: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation + numeric: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation + categorical: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation + type: object + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation + GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride: + description: The input metadata entries to be overridden. + id: GoogleCloudAiplatformV1ExplanationMetadataOverrideInputMetadataOverride + type: object + properties: + inputBaselines: + type: array + description: >- + Baseline inputs for this feature. This overrides the + `input_baseline` field of the ExplanationMetadata.InputMetadata + object of the corresponding feature's input metadata. If it's not + specified, the original baselines are not overridden. + items: + type: any + GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion: + id: GoogleCloudAiplatformV1MigratableResourceMlEngineModelVersion + type: object + description: Represents one model Version in ml.googleapis.com. + properties: + version: + description: >- + Full resource name of ml engine model Version. Format: + `projects/{project}/models/{model}/versions/{version}`. + type: string + endpoint: + description: >- + The ml.googleapis.com endpoint that this model Version currently + lives in. Example values: * ml.googleapis.com * + us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * + asia-east1-ml.googleapis.com + type: string + GoogleCloudAiplatformV1ModelEvaluation: + description: >- + A collection of metrics calculated by comparing Model's predictions on + all of the test data against annotations from the test data. + properties: + dataItemSchemaUri: + type: string + description: >- + Points to a YAML file stored on Google Cloud Storage describing + EvaluatedDataItemView.data_item_payload and + EvaluatedAnnotation.data_item_payload. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + This field is not populated if there are neither + EvaluatedDataItemViews nor EvaluatedAnnotations under this + ModelEvaluation. + explanationSpecs: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationModelEvaluationExplanationSpec + type: array + description: >- + Describes the values of ExplanationSpec that are used for explaining + the predicted values on the evaluated data. + metadata: + description: >- + The metadata of the ModelEvaluation. For the ModelEvaluation + uploaded from Managed Pipeline, metadata contains a structured value + with keys of "pipeline_job_id", "evaluation_dataset_type", + "evaluation_dataset_path", "row_based_metrics_path". + type: any + annotationSchemaUri: + type: string + description: >- + Points to a YAML file stored on Google Cloud Storage describing + EvaluatedDataItemView.predictions, + EvaluatedDataItemView.ground_truths, + EvaluatedAnnotation.predictions, and + EvaluatedAnnotation.ground_truths. The schema is defined as an + OpenAPI 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + This field is not populated if there are neither + EvaluatedDataItemViews nor EvaluatedAnnotations under this + ModelEvaluation. + createTime: + description: Output only. Timestamp when this ModelEvaluation was created. + type: string + readOnly: true + format: google-datetime + name: + readOnly: true + description: Output only. The resource name of the ModelEvaluation. + type: string + displayName: + description: The display name of the ModelEvaluation. + type: string + modelExplanation: + description: >- + Aggregated explanation metrics for the Model's prediction output + over the data this ModelEvaluation uses. This field is populated + only if the Model is evaluated with explanations, and only for + AutoML tabular Models. + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelExplanation' + metrics: + description: >- + Evaluation metrics of the Model. The schema of the metrics is stored + in metrics_schema_uri + type: any + metricsSchemaUri: + type: string + description: >- + Points to a YAML file stored on Google Cloud Storage describing the + metrics of this ModelEvaluation. The schema is defined as an OpenAPI + 3.0.2 [Schema + Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). + sliceDimensions: + type: array + items: + type: string + description: >- + All possible dimensions of ModelEvaluationSlices. The dimensions can + be used as the filter of the ModelService.ListModelEvaluationSlices + request, in the form of `slice.dimension = `. + type: object + id: GoogleCloudAiplatformV1ModelEvaluation + GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata: + description: The metadata of SavedQuery contains TextSentiment Annotations. + type: object + id: GoogleCloudAiplatformV1SchemaTextSentimentSavedQueryMetadata + properties: + sentimentMax: + type: integer + description: The maximum sentiment of sentiment Anntoation in this SavedQuery. + format: int32 + GoogleCloudAiplatformV1NearestNeighbors: + properties: + neighbors: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NearestNeighborsNeighbor + description: All its neighbors. + type: array + type: object + id: GoogleCloudAiplatformV1NearestNeighbors + description: Nearest neighbors for one query. + GoogleCloudAiplatformV1BleuInput: + description: Input for bleu metric. + properties: + instances: + type: array + description: Required. Repeated bleu instances. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuInstance' + metricSpec: + description: Required. Spec for bleu score metric. + $ref: '#/components/schemas/GoogleCloudAiplatformV1BleuSpec' + id: GoogleCloudAiplatformV1BleuInput + type: object + GoogleCloudAiplatformV1CompletionStats: + description: >- + Success and error statistics of processing multiple entities (for + example, DataItems or structured data rows) in batch. + properties: + successfulForecastPointCount: + description: >- + Output only. The number of the successful forecast points that are + generated by the forecasting model. This is ONLY used by the + forecasting batch prediction. + format: int64 + type: string + readOnly: true + failedCount: + format: int64 + type: string + description: >- + Output only. The number of entities for which any error was + encountered. + readOnly: true + successfulCount: + type: string + readOnly: true + format: int64 + description: >- + Output only. The number of entities that had been processed + successfully. + incompleteCount: + format: int64 + readOnly: true + type: string + description: >- + Output only. In cases when enough errors are encountered a job, + pipeline, or operation may be failed as a whole. Below is the number + of entities for which the processing had not been finished (either + in successful or failed state). Set to -1 if the number is unknown + (for example, the operation failed before the total entity number + could be collected). + id: GoogleCloudAiplatformV1CompletionStats + type: object + GoogleCloudAiplatformV1SchemaTextSentimentAnnotation: + description: Annotation details specific to text sentiment. + type: object + id: GoogleCloudAiplatformV1SchemaTextSentimentAnnotation + properties: + displayName: + type: string + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + annotationSpecId: + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + type: string + sentimentMax: + type: integer + format: int32 + description: The sentiment max score for text. + sentiment: + format: int32 + type: integer + description: The sentiment score for text. + GoogleCloudAiplatformV1DeployedIndexRef: + id: GoogleCloudAiplatformV1DeployedIndexRef + properties: + deployedIndexId: + type: string + description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. + displayName: + readOnly: true + description: Output only. The display name of the DeployedIndex. + type: string + indexEndpoint: + description: Immutable. A resource name of the IndexEndpoint. + type: string + type: object + description: Points to a DeployedIndex. + GoogleCloudAiplatformV1PurgeArtifactsRequest: + id: GoogleCloudAiplatformV1PurgeArtifactsRequest + description: Request message for MetadataService.PurgeArtifacts. + properties: + force: + description: >- + Optional. Flag to indicate to actually perform the purge. If `force` + is set to false, the method will return a sample of Artifact names + that would be deleted. + type: boolean + filter: + type: string + description: >- + Required. A required filter matching the Artifacts to be purged. + E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + type: object + GoogleCloudAiplatformV1SchemaTextSegment: + type: object + description: The text segment inside of DataItem. + properties: + endOffset: + type: string + description: >- + Zero-based character index of the first character past the end of + the text segment (counting character from the beginning of the + text). The character at the end_offset is NOT included in the text + segment. + format: uint64 + startOffset: + description: >- + Zero-based character index of the first character of the text + segment (counting characters from the beginning of the text). + type: string + format: uint64 + content: + type: string + description: The text content in the segment for output only. + id: GoogleCloudAiplatformV1SchemaTextSegment + GoogleCloudAiplatformV1GenerateContentRequest: + type: object + id: GoogleCloudAiplatformV1GenerateContentRequest + properties: + generationConfig: + description: Optional. Generation config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1GenerationConfig' + safetySettings: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetySetting' + description: >- + Optional. Per request settings for blocking unsafe content. Enforced + on GenerateContentResponse.candidates. + contents: + description: >- + Required. The content of the current conversation with the model. + For single-turn queries, this is a single instance. For multi-turn + queries, this is a repeated field that contains conversation history + + latest request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + toolConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ToolConfig' + description: >- + Optional. Tool config. This config is shared for all tools provided + in the request. + tools: + description: >- + Optional. A list of `Tools` the model may use to generate the next + response. A `Tool` is a piece of code that enables the system to + interact with external systems to perform an action, or set of + actions, outside of knowledge and scope of the model. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tool' + type: array + systemInstruction: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Content' + description: >- + Optional. The user provided system instructions for the model. Note: + only text should be used in parts and content in each part will be + in a separate paragraph. + description: Request message for [PredictionService.GenerateContent]. + GoogleIamV1TestIamPermissionsResponse: + id: GoogleIamV1TestIamPermissionsResponse + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + items: + type: string + type: array + description: Response message for `TestIamPermissions` method. + type: object + GoogleCloudAiplatformV1GcsDestination: + description: The Google Cloud Storage location where the output is to be written to. + type: object + id: GoogleCloudAiplatformV1GcsDestination + properties: + outputUriPrefix: + type: string + description: >- + Required. Google Cloud Storage URI to output directory. If the uri + doesn't end with '/', a '/' will be automatically appended. The + directory is created if it doesn't exist. + GoogleCloudAiplatformV1CancelBatchPredictionJobRequest: + id: GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + type: object + properties: {} + description: Request message for JobService.CancelBatchPredictionJob. + CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox: + type: object + description: >- + An integer bounding box of original pixels of the image for the detected + labels. + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + properties: + y2: + type: integer + description: The Y coordinate of the bottom-right corner, in pixels. + format: int32 + x2: + format: int32 + type: integer + description: The X coordinate of the bottom-right corner, in pixels. + x1: + type: integer + description: The X coordinate of the top-left corner, in pixels. + format: int32 + y1: + format: int32 + description: The Y coordinate of the top-left corner, in pixels. + type: integer + GoogleCloudAiplatformV1IndexPrivateEndpoints: + description: >- + IndexPrivateEndpoints proto is used to provide paths for users to send + requests via private endpoints (e.g. private service access, private + service connect). To send request via private service access, use + match_grpc_address. To send request via private service connect, use + service_attachment. + properties: + pscAutomatedEndpoints: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PscAutomatedEndpoints' + description: >- + Output only. PscAutomatedEndpoints is populated if private service + connect is enabled if PscAutomatedConfig is set. + matchGrpcAddress: + type: string + readOnly: true + description: Output only. The ip address used to send match gRPC requests. + serviceAttachment: + type: string + description: >- + Output only. The name of the service attachment resource. Populated + if private service connect is enabled. + readOnly: true + id: GoogleCloudAiplatformV1IndexPrivateEndpoints + type: object + GoogleCloudAiplatformV1TensorboardBlob: + description: One blob (e.g, image, graph) viewable on a blob metric plot. + type: object + id: GoogleCloudAiplatformV1TensorboardBlob + properties: + data: + format: byte + description: >- + Optional. The bytes of the blob is not present unless it's returned + by the ReadTensorboardBlobData endpoint. + type: string + id: + type: string + description: >- + Output only. A URI safe key uniquely identifying a blob. Can be used + to locate the blob stored in the Cloud Storage bucket of the + consumer project. + readOnly: true + GoogleCloudAiplatformV1QuestionAnsweringQualitySpec: + type: object + id: GoogleCloudAiplatformV1QuestionAnsweringQualitySpec + description: Spec for question answering quality score metric. + properties: + version: + type: integer + description: Optional. Which version to use for evaluation. + format: int32 + useReference: + type: boolean + description: >- + Optional. Whether to use instance.reference to compute question + answering quality. + GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback: + id: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback + properties: + blockReason: + type: string + enum: + - BLOCKED_REASON_UNSPECIFIED + - SAFETY + - OTHER + - BLOCKLIST + - PROHIBITED_CONTENT + enumDescriptions: + - Unspecified blocked reason. + - Candidates blocked due to safety. + - Candidates blocked due to other reason. + - >- + Candidates blocked due to the terms which are included from the + terminology blocklist. + - Candidates blocked due to prohibited content. + description: Output only. Blocked reason. + readOnly: true + safetyRatings: + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SafetyRating' + description: Output only. Safety ratings. + type: array + blockReasonMessage: + description: Output only. A readable block reason message. + readOnly: true + type: string + type: object + description: Content filter results for a prompt sent in the request. + CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity: + properties: + boundingBox: + description: Bounding box of the label + $ref: >- + #/components/schemas/CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox + description: + description: Description of the label + type: string + iouScore: + description: >- + The intersection ratio between the detection bounding box and the + mask. + type: number + format: float + score: + description: Confidence score of the label + type: number + format: float + mid: + type: string + description: MID of the label + id: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity + description: The properties for a detected entity from the rai signal. + type: object + GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation: + id: GoogleCloudAiplatformV1SchemaVideoClassificationAnnotation + properties: + timeSegment: + description: >- + This Annotation applies to the time period represented by the + TimeSegment. If it's not set, the Annotation applies to the whole + video. + $ref: '#/components/schemas/GoogleCloudAiplatformV1SchemaTimeSegment' + displayName: + description: >- + The display name of the AnnotationSpec that this Annotation pertains + to. + type: string + annotationSpecId: + description: >- + The resource Id of the AnnotationSpec that this Annotation pertains + to. + type: string + description: Annotation details specific to video classification. + type: object + GoogleCloudAiplatformV1ExplanationParameters: + properties: + topK: + format: int32 + type: integer + description: >- + If populated, returns attributions for top K indices of outputs + (defaults to 1). Only applies to Models that predicts more than one + outputs (e,g, multi-class Models). When set to -1, returns + explanations for all outputs. + examples: + description: >- + Example-based explanations that returns the nearest neighbors from + the provided dataset. + $ref: '#/components/schemas/GoogleCloudAiplatformV1Examples' + sampledShapleyAttribution: + description: >- + An attribution method that approximates Shapley values for features + that contribute to the label being predicted. A sampling strategy is + used to approximate the value rather than considering all subsets of + features. Refer to this paper for model details: + https://arxiv.org/abs/1306.4265. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SampledShapleyAttribution + xraiAttribution: + $ref: '#/components/schemas/GoogleCloudAiplatformV1XraiAttribution' + description: >- + An attribution method that redistributes Integrated Gradients + attribution to segmented regions, taking advantage of the model's + fully differentiable structure. Refer to this paper for more + details: https://arxiv.org/abs/1906.02825 XRAI currently performs + better on natural images, like a picture of a house or an animal. If + the images are taken in artificial environments, like a lab or + manufacturing line, or from diagnostic equipment, like x-rays or + quality-control cameras, use Integrated Gradients instead. + outputIndices: + items: + type: any + type: array + description: >- + If populated, only returns attributions that have output_index + contained in output_indices. It must be an ndarray of integers, with + the same shape of the output it's explaining. If not populated, + returns attributions for top_k indices of outputs. If neither top_k + nor output_indices is populated, returns the argmax index of the + outputs. Only applicable to Models that predict multiple outputs + (e,g, multi-class Models that predict multiple classes). + integratedGradientsAttribution: + description: >- + An attribution method that computes Aumann-Shapley values taking + advantage of the model's fully differentiable structure. Refer to + this paper for more details: https://arxiv.org/abs/1703.01365 + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1IntegratedGradientsAttribution + id: GoogleCloudAiplatformV1ExplanationParameters + description: Parameters to configure explaining for Model's predictions. + type: object + GoogleCloudAiplatformV1MachineSpec: + description: Specification of a single machine. + properties: + acceleratorCount: + description: The number of accelerators to attach to the machine. + format: int32 + type: integer + reservationAffinity: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ReservationAffinity' + description: >- + Optional. Immutable. Configuration controlling how this resource + pool consumes reservation. + tpuTopology: + description: >- + Immutable. The topology of the TPUs. Corresponds to the TPU + topologies available from GKE. (Example: tpu_topology: "2x2x1"). + type: string + acceleratorType: + enumDescriptions: + - Unspecified accelerator type, which means no accelerator. + - >- + Deprecated: Nvidia Tesla K80 GPU has reached end of support, see + https://cloud.google.com/compute/docs/eol/k80-eol. + - Nvidia Tesla P100 GPU. + - Nvidia Tesla V100 GPU. + - Nvidia Tesla P4 GPU. + - Nvidia Tesla T4 GPU. + - Nvidia Tesla A100 GPU. + - Nvidia A100 80GB GPU. + - Nvidia L4 GPU. + - Nvidia H100 80Gb GPU. + - TPU v2. + - TPU v3. + - TPU v4. + - TPU v5. + type: string + enum: + - ACCELERATOR_TYPE_UNSPECIFIED + - NVIDIA_TESLA_K80 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_V100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_L4 + - NVIDIA_H100_80GB + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + description: >- + Immutable. The type of accelerator(s) that may be attached to the + machine as per accelerator_count. + enumDeprecated: + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + machineType: + description: >- + Immutable. The type of the machine. See the [list of machine types + supported for + prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) + See the [list of machine types supported for custom + training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). + For DeployedModel this field is optional, and the default value is + `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec + this field is required. + type: string + id: GoogleCloudAiplatformV1MachineSpec + type: object + GoogleCloudAiplatformV1FluencyResult: + type: object + properties: + confidence: + type: number + readOnly: true + description: Output only. Confidence for fluency score. + format: float + explanation: + type: string + readOnly: true + description: Output only. Explanation for fluency score. + score: + readOnly: true + type: number + format: float + description: Output only. Fluency score. + id: GoogleCloudAiplatformV1FluencyResult + description: Spec for fluency result. + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams: + type: object + id: >- + GoogleCloudAiplatformV1SchemaPredictParamsVideoActionRecognitionPredictionParams + properties: + maxPredictions: + format: int32 + description: >- + The model only returns up to that many top, by confidence score, + predictions per frame of the video. If this number is very high, the + Model may return fewer predictions per frame. Default value is 50. + type: integer + confidenceThreshold: + format: float + type: number + description: >- + The Model only returns predictions with at least this confidence + score. Default value is 0.0 + description: Prediction model parameters for Video Action Recognition. + GoogleCloudAiplatformV1TensorboardBlobSequence: + properties: + values: + description: List of blobs contained within the sequence. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardBlob' + type: array + description: >- + One point viewable on a blob metric plot, but mostly just a wrapper + message to work around repeated fields can't be used directly within + `oneof` fields. + id: GoogleCloudAiplatformV1TensorboardBlobSequence + type: object + GoogleCloudAiplatformV1CompleteTrialRequest: + type: object + id: GoogleCloudAiplatformV1CompleteTrialRequest + description: Request message for VizierService.CompleteTrial. + properties: + infeasibleReason: + type: string + description: >- + Optional. A human readable reason why the trial was infeasible. This + should only be provided if `trial_infeasible` is true. + trialInfeasible: + type: boolean + description: >- + Optional. True if the Trial cannot be run with the given Parameter, + and final_measurement will be ignored. + finalMeasurement: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + description: >- + Optional. If provided, it will be used as the completed Trial's + final_measurement; Otherwise, the service will auto-select a + previously reported measurement as the final-measurement + GoogleCloudAiplatformV1AddTrialMeasurementRequest: + properties: + measurement: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Measurement' + description: Required. The measurement to be added to a Trial. + type: object + description: Request message for VizierService.AddTrialMeasurement. + id: GoogleCloudAiplatformV1AddTrialMeasurementRequest + GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix: + properties: + annotationSpecs: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef + description: >- + AnnotationSpecs used in the confusion matrix. For AutoML Text + Extraction, a special negative AnnotationSpec with empty `id` and + `displayName` of "NULL" will be added as the last element. + type: array + rows: + type: array + items: + type: array + items: + type: any + description: >- + Rows in the confusion matrix. The number of rows is equal to the + size of `annotationSpecs`. `rowsi` is the number of DataItems that + have ground truth of the `annotationSpecs[i]` and are predicted as + `annotationSpecs[j]` by the Model being evaluated. For Text + Extraction, when `annotationSpecs[i]` is the last element in + `annotationSpecs`, i.e. the special negative AnnotationSpec, `rowsi` + is the number of predicted entities of `annoatationSpec[j]` that are + not labeled as any of the ground truth AnnotationSpec. When + annotationSpecs[j] is the special negative AnnotationSpec, `rowsi` + is the number of entities have ground truth of `annotationSpec[i]` + that are not predicted as an entity by the Model. The value of the + last cell, i.e. `rowi` where i == j and `annotationSpec[i]` is the + special negative AnnotationSpec, is always 0. + type: object + id: GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + GoogleCloudAiplatformV1MigrateResourceResponse: + properties: + model: + type: string + description: Migrated Model's resource name. + dataset: + type: string + description: Migrated Dataset's resource name. + migratableResource: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MigratableResource' + description: >- + Before migration, the identifier in ml.googleapis.com, + automl.googleapis.com or datalabeling.googleapis.com. + description: Describes a successfully migrated resource. + id: GoogleCloudAiplatformV1MigrateResourceResponse + type: object + GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput: + description: Input for question answering correctness metric. + properties: + instance: + description: Required. Question answering correctness instance. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInstance + metricSpec: + description: Required. Spec for question answering correctness score metric. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1QuestionAnsweringCorrectnessSpec + id: GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput + type: object + GoogleCloudAiplatformV1UpsertDatapointsRequest: + type: object + properties: + updateMask: + type: string + description: >- + Optional. Update mask is used to specify the fields to be + overwritten in the datapoints by the update. The fields specified in + the update_mask are relative to each IndexDatapoint inside + datapoints, not the full request. Updatable fields: * Use + `all_restricts` to update both restricts and numeric_restricts. + format: google-fieldmask + datapoints: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexDatapoint' + description: A list of datapoints to be created/updated. + description: Request message for IndexService.UpsertDatapoints + id: GoogleCloudAiplatformV1UpsertDatapointsRequest + GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF: + properties: + alpha: + type: number + format: float + description: >- + Required. Users can provide an alpha value to give more weight to + dense vs sparse results. For example, if the alpha is 0, we only + return sparse and if the alpha is 1, we only return dense. + description: Parameters for RRF algorithm that combines search results. + id: GoogleCloudAiplatformV1FindNeighborsRequestQueryRRF + type: object + GoogleTypeDate: + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + properties: + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + year: + type: integer + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + month: + format: int32 + type: integer + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + id: GoogleTypeDate + GoogleCloudAiplatformV1ModelExplanation: + description: Aggregated explanation metrics for a Model over a set of instances. + properties: + meanAttributions: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Attribution' + readOnly: true + description: >- + Output only. Aggregated attributions explaining the Model's + prediction outputs over the set of instances. The attributions are + grouped by outputs. For Models that predict only one output, such as + regression Models that predict only one score, there is only one + attibution that explains the predicted output. For Models that + predict multiple outputs, such as multiclass Models that predict + multiple classes, each element explains one specific item. + Attribution.output_index can be used to identify which output this + attribution is explaining. The baselineOutputValue, + instanceOutputValue and featureAttributions fields are averaged over + the test data. NOTE: Currently AutoML tabular classification Models + produce only one attribution, which averages attributions over all + the classes it predicts. Attribution.approximation_error is not + populated. + type: object + id: GoogleCloudAiplatformV1ModelExplanation + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance: + type: object + properties: + mimeType: + description: >- + The MIME type of the content of the image. Only the images in below + listed MIME types are supported. - image/jpeg - image/png + type: string + content: + type: string + description: The image bytes to make the predictions on. + description: Prediction input format for Image Segmentation. + id: >- + GoogleCloudAiplatformV1SchemaPredictInstanceImageSegmentationPredictionInstance + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata: + id: >- + GoogleCloudAiplatformV1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata + properties: + costMilliNodeHours: + description: >- + The actual training cost of creating this model, expressed in milli + node hours, i.e. 1,000 value in this field means 1 node hour. + Guaranteed to not exceed inputs.budgetMilliNodeHours. + type: string + format: int64 + successfulStopReason: + enumDescriptions: + - Should not be set. + - The inputs.budgetMilliNodeHours had been reached. + - >- + Further training of the Model ceased to increase its quality, + since it already has converged. + description: >- + For successful job completions, this is the reason why the job has + finished. + enum: + - SUCCESSFUL_STOP_REASON_UNSPECIFIED + - BUDGET_REACHED + - MODEL_CONVERGED + type: string + type: object + GoogleCloudAiplatformV1ListDataItemsResponse: + description: Response message for DatasetService.ListDataItems. + id: GoogleCloudAiplatformV1ListDataItemsResponse + properties: + dataItems: + type: array + description: >- + A list of DataItems that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataItem' + nextPageToken: + type: string + description: The standard List next-page token. + type: object + GoogleCloudAiplatformV1CoherenceSpec: + id: GoogleCloudAiplatformV1CoherenceSpec + description: Spec for coherence score metric. + type: object + properties: + version: + type: integer + description: Optional. Which version to use for evaluation. + format: int32 + GoogleCloudAiplatformV1ListCustomJobsResponse: + description: Response message for JobService.ListCustomJobs + id: GoogleCloudAiplatformV1ListCustomJobsResponse + properties: + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListCustomJobsRequest.page_token to obtain that page. + customJobs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + description: List of CustomJobs in the requested page. + type: object + GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance: + description: Spec for pairwise question answering quality instance. + id: GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInstance + properties: + baselinePrediction: + description: Required. Output of the baseline model. + type: string + instruction: + type: string + description: Required. Question Answering prompt for LLM. + context: + type: string + description: Required. Text to answer the question. + prediction: + type: string + description: Required. Output of the candidate model. + reference: + description: Optional. Ground truth used to compare against the prediction. + type: string + type: object + GoogleCloudAiplatformV1TrainingPipeline: + properties: + createTime: + description: Output only. Time when the TrainingPipeline was created. + readOnly: true + format: google-datetime + type: string + startTime: + format: google-datetime + readOnly: true + type: string + description: >- + Output only. Time when the TrainingPipeline for the first time + entered the `PIPELINE_STATE_RUNNING` state. + trainingTaskDefinition: + type: string + description: >- + Required. A Google Cloud Storage path to the YAML file that defines + the training task which is responsible for producing the model + artifact, and may also include additional auxiliary work. The + definition files that can be used here are found in + gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: + The URI given on output will be immutable and probably different, + including the URI scheme, than the one given on input. The output + URI will point to a location where the user only has a read access. + inputDataConfig: + $ref: '#/components/schemas/GoogleCloudAiplatformV1InputDataConfig' + description: >- + Specifies Vertex AI owned input data that may be used for training + the Model. The TrainingPipeline's training_task_definition should + make clear whether this config is used and if there are any special + requirements on how it should be filled. If nothing about this + config is mentioned in the training_task_definition, then it should + be assumed that the TrainingPipeline does not depend on this + configuration. + trainingTaskMetadata: + type: any + description: >- + Output only. The metadata information as specified in the + training_task_definition's `metadata`. This metadata is an auxiliary + runtime and final information about the training task. While the + pipeline is running this information is populated only at a best + effort basis. Only present if the pipeline's + training_task_definition contains `metadata` object. + readOnly: true + parentModel: + description: >- + Optional. When specify this field, the `model_to_upload` will not be + uploaded as a new model, instead, it will become a new version of + this `parent_model`. + type: string + endTime: + type: string + format: google-datetime + description: >- + Output only. Time when the TrainingPipeline entered any of the + following states: `PIPELINE_STATE_SUCCEEDED`, + `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. + readOnly: true + modelToUpload: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + description: >- + Describes the Model that may be uploaded (via + ModelService.UploadModel) by this TrainingPipeline. The + TrainingPipeline's training_task_definition should make clear + whether this Model description should be populated, and if there are + any special requirements regarding how it should be filled. If + nothing is mentioned in the training_task_definition, then it should + be assumed that this field should not be filled and the training + task either uploads the Model without a need of this information, or + that training task does not support uploading a Model as part of the + pipeline. When the Pipeline's state becomes + `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded + into Vertex AI, then the model_to_upload's resource name is + populated. The Model is always uploaded into the Project and + Location in which this pipeline is. + updateTime: + type: string + readOnly: true + description: >- + Output only. Time when the TrainingPipeline was most recently + updated. + format: google-datetime + labels: + additionalProperties: + type: string + description: >- + The labels with user-defined metadata to organize TrainingPipelines. + Label keys and values can be no longer than 64 characters (Unicode + codepoints), can only contain lowercase letters, numeric characters, + underscores and dashes. International characters are allowed. See + https://goo.gl/xmQnxf for more information and examples of labels. + type: object + modelId: + description: >- + Optional. The ID to use for the uploaded Model, which will become + the final component of the model resource name. This value may be up + to 63 characters, and valid characters are `[a-z0-9_-]`. The first + character cannot be a number or hyphen. + type: string + state: + description: Output only. The detailed state of the pipeline. + enumDescriptions: + - The pipeline state is unspecified. + - >- + The pipeline has been created or resumed, and processing has not + yet begun. + - The service is preparing to run the pipeline. + - The pipeline is in progress. + - The pipeline completed successfully. + - The pipeline failed. + - >- + The pipeline is being cancelled. From this state, the pipeline may + only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED + or PIPELINE_STATE_CANCELLED. + - The pipeline has been cancelled. + - The pipeline has been stopped, and can be resumed. + readOnly: true + enum: + - PIPELINE_STATE_UNSPECIFIED + - PIPELINE_STATE_QUEUED + - PIPELINE_STATE_PENDING + - PIPELINE_STATE_RUNNING + - PIPELINE_STATE_SUCCEEDED + - PIPELINE_STATE_FAILED + - PIPELINE_STATE_CANCELLING + - PIPELINE_STATE_CANCELLED + - PIPELINE_STATE_PAUSED + type: string + encryptionSpec: + $ref: '#/components/schemas/GoogleCloudAiplatformV1EncryptionSpec' + description: >- + Customer-managed encryption key spec for a TrainingPipeline. If set, + this TrainingPipeline will be secured by this key. Note: Model + trained by this TrainingPipeline is also secured by this key if + model_to_upload is not set separately. + trainingTaskInputs: + description: >- + Required. The training task's parameter(s), as specified in the + training_task_definition's `inputs`. + type: any + displayName: + type: string + description: Required. The user-defined name of this TrainingPipeline. + name: + readOnly: true + description: Output only. Resource name of the TrainingPipeline. + type: string + error: + $ref: '#/components/schemas/GoogleRpcStatus' + readOnly: true + description: >- + Output only. Only populated when the pipeline's state is + `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. + description: >- + The TrainingPipeline orchestrates tasks associated with training a + Model. It always executes the training task, and optionally may also + export data from Vertex AI's Dataset which becomes the training input, + upload the Model to Vertex AI, and evaluate the Model. + type: object + id: GoogleCloudAiplatformV1TrainingPipeline + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView: + properties: + entityId: + type: string + description: ID of the requested entity. + data: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData + type: array + description: >- + Each piece of data holds the k requested values for one requested + Feature. If no values for the requested Feature exist, the + corresponding cell will be empty. This has the same size and is in + the same order as the features from the header + ReadFeatureValuesResponse.header. + type: object + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityView + description: Entity view with Feature values. + GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput: + id: GoogleCloudAiplatformV1NasJobOutputMultiTrialJobOutput + type: object + properties: + trainTrials: + type: array + readOnly: true + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + description: >- + Output only. List of NasTrials that were started as part of train + stage. + searchTrials: + description: >- + Output only. List of NasTrials that were started as part of search + stage. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrial' + readOnly: true + type: array + description: The output of a multi-trial Neural Architecture Search (NAS) jobs. + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult: + description: Prediction output format for Time Series Forecasting. + properties: + quantileValues: + description: Quantile values. + type: array + items: + type: number + format: float + tftFeatureImportance: + description: Only use these if TFt is enabled. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaPredictPredictionTftFeatureImportance + quantilePredictions: + type: array + items: + type: number + format: float + description: Quantile predictions, in 1-1 correspondence with quantile_values. + value: + format: float + type: number + description: The regression value. + id: >- + GoogleCloudAiplatformV1SchemaPredictPredictionTimeSeriesForecastingPredictionResult + type: object + GoogleCloudAiplatformV1ListSchedulesResponse: + description: Response message for ScheduleService.ListSchedules + properties: + schedules: + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + description: List of Schedules in the requested page. + type: array + nextPageToken: + type: string + description: >- + A token to retrieve the next page of results. Pass to + ListSchedulesRequest.page_token to obtain that page. + id: GoogleCloudAiplatformV1ListSchedulesResponse + type: object + GoogleCloudAiplatformV1Citation: + properties: + startIndex: + description: Output only. Start index into the content. + format: int32 + type: integer + readOnly: true + uri: + description: Output only. Url reference of the attribution. + readOnly: true + type: string + publicationDate: + readOnly: true + description: Output only. Publication date of the attribution. + $ref: '#/components/schemas/GoogleTypeDate' + endIndex: + format: int32 + type: integer + description: Output only. End index into the content. + readOnly: true + license: + type: string + description: Output only. License of the attribution. + readOnly: true + title: + type: string + readOnly: true + description: Output only. Title of the attribution. + id: GoogleCloudAiplatformV1Citation + type: object + description: Source attributions for content. + GoogleCloudAiplatformV1Schema: + type: object + properties: + minimum: + type: number + description: >- + Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of + the Type.INTEGER and Type.NUMBER + format: double + minItems: + description: Optional. Minimum number of the elements for Type.ARRAY. + type: string + format: int64 + maxItems: + description: Optional. Maximum number of the elements for Type.ARRAY. + type: string + format: int64 + nullable: + type: boolean + description: Optional. Indicates if the value may be null. + items: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + description: >- + Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of + Type.ARRAY. + minProperties: + type: string + description: Optional. Minimum number of the properties for Type.OBJECT. + format: int64 + maximum: + format: double + type: number + description: Optional. Maximum value of the Type.INTEGER and Type.NUMBER + maxProperties: + type: string + format: int64 + description: Optional. Maximum number of the properties for Type.OBJECT. + example: + type: any + description: >- + Optional. Example of the object. Will only populated when the object + is the root. + enum: + items: + type: string + description: >- + Optional. Possible values of the element of Type.STRING with enum + format. For example we can define an Enum Direction as : + {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + type: array + maxLength: + description: Optional. Maximum length of the Type.STRING + type: string + format: int64 + required: + items: + type: string + description: Optional. Required properties of Type.OBJECT. + type: array + title: + type: string + description: Optional. The title of the Schema. + description: + description: Optional. The description of the data. + type: string + default: + type: any + description: Optional. Default value of the data. + format: + type: string + description: >- + Optional. The format of the data. Supported formats: for NUMBER + type: "float", "double" for INTEGER type: "int32", "int64" for + STRING type: "email", "byte", etc + pattern: + type: string + description: >- + Optional. Pattern of the Type.STRING to restrict a string to a + regular expression. + properties: + type: object + description: Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schema' + type: + description: Optional. The type of the data. + enum: + - TYPE_UNSPECIFIED + - STRING + - NUMBER + - INTEGER + - BOOLEAN + - ARRAY + - OBJECT + enumDescriptions: + - Not specified, should not be used. + - OpenAPI string type + - OpenAPI number type + - OpenAPI integer type + - OpenAPI boolean type + - OpenAPI array type + - OpenAPI object type + type: string + minLength: + description: >- + Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the + Type.STRING + type: string + format: int64 + id: GoogleCloudAiplatformV1Schema + description: >- + Schema is used to define the format of input/output data. Represents a + select subset of an [OpenAPI 3.0 schema + object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields + may be added in the future as needed. + GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData: + properties: + values: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValueList' + description: >- + Feature values list if values, successive in time, are requested. If + the requested number of values is greater than the number of + existing Feature values, nonexistent values are omitted instead of + being returned as empty. + value: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureValue' + description: Feature value if a single value is requested. + id: GoogleCloudAiplatformV1ReadFeatureValuesResponseEntityViewData + description: >- + Container to hold value(s), successive in time, for one Feature from the + request. + type: object + GoogleCloudAiplatformV1ToolConfig: + type: object + properties: + functionCallingConfig: + description: Optional. Function calling config. + $ref: '#/components/schemas/GoogleCloudAiplatformV1FunctionCallingConfig' + description: >- + Tool config. This config is shared for all tools provided in the + request. + id: GoogleCloudAiplatformV1ToolConfig + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics: + description: Metrics for text extraction evaluation results. + id: >- + GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics + properties: + confidenceMetrics: + items: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from them. + type: array + confusionMatrix: + description: >- + Confusion matrix of the evaluation. Only set for Models where number + of AnnotationSpecs is no more than 10. Only set for + ModelEvaluations, not for ModelEvaluationSlices. + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix + type: object + GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter: + id: GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter + properties: + valueDouble: + format: double + description: double value type. + type: number + valueInt: + format: int64 + type: string + description: int value type. + valueFloat: + type: number + description: float value type. + format: float + name: + description: Required. Column name in BigQuery that used as filters. + type: string + op: + type: string + description: >- + Optional. This MUST be specified for queries and must NOT be + specified for database points. + enumDescriptions: + - Unspecified operator. + - Entities are eligible if their value is < the query's. + - Entities are eligible if their value is <= the query's. + - Entities are eligible if their value is == the query's. + - Entities are eligible if their value is >= the query's. + - Entities are eligible if their value is > the query's. + - Entities are eligible if their value is != the query's. + enum: + - OPERATOR_UNSPECIFIED + - LESS + - LESS_EQUAL + - EQUAL + - GREATER_EQUAL + - GREATER + - NOT_EQUAL + type: object + description: >- + Numeric filter is used to search a subset of the entities by using + boolean rules on numeric columns. For example: Database Point 0: {name: + "a" value_int: 42} {name: "b" value_float: 1.0} Database Point 1: {name: + "a" value_int: 10} {name: "b" value_float: 2.0} Database Point 2: {name: + "a" value_int: -1} {name: "b" value_float: 3.0} Query: {name: "a" + value_int: 12 operator: LESS} // Matches Point 1, 2 {name: "b" + value_float: 2.0 operator: EQUAL} // Matches Point 1 + GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup: + type: object + properties: + featureIds: + description: Required. Identifiers of features under the feature group. + items: + type: string + type: array + featureGroupId: + description: Required. Identifier of the feature group. + type: string + description: >- + Features belonging to a single feature group that will be synced to + Online Store. + id: GoogleCloudAiplatformV1FeatureViewFeatureRegistrySourceFeatureGroup + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences: + properties: + references: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PublisherModelResourceReference + description: Required. + type: object + resourceTitle: + type: string + description: Optional. Title of the resource. + resourceDescription: + description: Optional. Description of the resource. + type: string + resourceUseCase: + description: Optional. Use case (CUJ) of the resource. + type: string + title: + type: string + description: 'Required. ' + id: >- + GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences + type: object + description: >- + The regional resource name or the URI. Key is region, e.g., us-central1, + europe-west2, global, etc.. + parameters: + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + x-stackQL-resources: + models: + id: google.aiplatform.models + name: models + title: Models + methods: + count_tokens: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:countTokens/post + response: + mediaType: application/json + openAPIDocKey: '200' + compute_tokens: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:computeTokens/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_content: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:generateContent/post + response: + mediaType: application/json + openAPIDocKey: '200' + stream_generate_content: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamGenerateContent/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + server_streaming_predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:serverStreamingPredict/post + response: + mediaType: application/json + openAPIDocKey: '200' + predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:predict/post + response: + mediaType: application/json + openAPIDocKey: '200' + stream_raw_predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:streamRawPredict/post + response: + mediaType: application/json + openAPIDocKey: '200' + raw_predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1publishers~1{publishersId}~1models~1{modelsId}:rawPredict/post + response: + mediaType: application/json + openAPIDocKey: '200' delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - training_pipelines: - id: google.aiplatform.training_pipelines - name: training_pipelines - title: Training_pipelines + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + merge_version_aliases: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:mergeVersionAliases/post + response: + mediaType: application/json + openAPIDocKey: '200' + export: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:export/post + response: + mediaType: application/json + openAPIDocKey: '200' + copy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:copy/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.models + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/models/methods/get' + - $ref: '#/components/x-stackQL-resources/models/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/models/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/delete' + operations: + id: google.aiplatform.operations + name: operations + title: Operations methods: - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.trainingPipelines list: - operation: *ref_7 - response: *ref_8 - delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.operations + wait: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}:wait/post response: mediaType: application/json openAPIDocKey: '200' cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/get' - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/create' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' - slices: - id: google.aiplatform.slices - name: slices - title: Slices + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + migratable_resources: + id: google.aiplatform.migratable_resources + name: migratable_resources + title: Migratable_resources methods: - get: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:search/post response: mediaType: application/json openAPIDocKey: '200' - batch_import: + batch_migrate: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}:batchImport/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + operations_wait: + id: google.aiplatform.operations_wait + name: operations_wait + title: Operations_wait + methods: + list_wait: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get - response: &ref_10 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}~1operations~1{operationsId}:wait/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelEvaluationSlices - list: - operation: *ref_9 - response: *ref_10 + objectKey: $.operations sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/slices/methods/get' - - $ref: '#/components/x-stackQL-resources/slices/methods/list' + - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' insert: [] update: [] + replace: [] delete: [] - evaluations: - id: google.aiplatform.evaluations - name: evaluations - title: Evaluations + feature_views: + id: google.aiplatform.feature_views + name: feature_views + title: Feature_views methods: - import: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get - response: &ref_12 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.featureViews + search_nearest_entities: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelEvaluations - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sync: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:sync/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' - - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' - insert: [] - update: [] - delete: [] - models_iam_policies: - id: google.aiplatform.models_iam_policies - name: models_iam_policies - title: Models_iam_policies + - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' + feature_views_iam_policies: + id: google.aiplatform.feature_views_iam_policies + name: feature_views_iam_policies + title: Feature_views_iam_policies methods: - _get_iam_policy: - operation: &ref_13 + get_iam_policy: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post - response: &ref_14 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:getIamPolicy/post + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_13 - response: *ref_14 - set_iam_policy: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/models_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/feature_views_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/feature_views_iam_policies/methods/set_iam_policy delete: [] - models_versions: - id: google.aiplatform.models_versions - name: models_versions - title: Models_versions + feature_views_feature_values: + id: google.aiplatform.feature_views_feature_values + name: feature_views_feature_values + title: Feature_views_feature_values methods: - _list_versions: - operation: &ref_15 + fetch_feature_values: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get - response: &ref_16 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.models - list_versions: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/models_versions/methods/list_versions + #/components/x-stackQL-resources/feature_views_feature_values/methods/fetch_feature_values insert: [] update: [] + replace: [] delete: [] - models_explanation_dataset: - id: google.aiplatform.models_explanation_dataset - name: models_explanation_dataset - title: Models_explanation_dataset + feature_view_syncs: + id: google.aiplatform.feature_view_syncs + name: feature_view_syncs + title: Feature_view_syncs methods: - update_explanation_dataset: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs~1{featureViewSyncsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.featureViewSyncs sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/list' insert: [] update: [] + replace: [] delete: [] - models_version: - id: google.aiplatform.models_version - name: models_version - title: Models_version + feature_online_stores: + id: google.aiplatform.feature_online_stores + name: feature_online_stores + title: Feature_online_stores methods: - delete_version: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:deleteVersion/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.featureOnlineStores sqlVerbs: - select: [] - insert: [] - update: [] + select: + - $ref: '#/components/x-stackQL-resources/feature_online_stores/methods/get' + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores/methods/patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/models_version/methods/delete_version - studies: - id: google.aiplatform.studies - name: studies - title: Studies + #/components/x-stackQL-resources/feature_online_stores/methods/delete + feature_online_stores_iam_policies: + id: google.aiplatform.feature_online_stores_iam_policies + name: feature_online_stores_iam_policies + title: Feature_online_stores_iam_policies methods: - lookup: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + get_iam_policy: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get - response: &ref_18 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:getIamPolicy/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.studies + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/feature_online_stores_iam_policies/methods/set_iam_policy + delete: [] + persistent_resources: + id: google.aiplatform.persistent_resources + name: persistent_resources + title: Persistent_resources + methods: list: - operation: *ref_17 - response: *ref_18 + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.persistentResources create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + reboot: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}:reboot/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/studies/methods/get' - - $ref: '#/components/x-stackQL-resources/studies/methods/list' + - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/get' + - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/studies/methods/create' - update: [] + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/patch + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/studies/methods/delete' - trials: - id: google.aiplatform.trials - name: trials - title: Trials + - $ref: >- + #/components/x-stackQL-resources/persistent_resources/methods/delete + endpoints: + id: google.aiplatform.endpoints + name: endpoints + title: Endpoints methods: + stream_raw_predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamRawPredict/post + response: + mediaType: application/json + openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_19 + deploy_model: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get - response: &ref_20 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:deployModel/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.trials - list: - operation: *ref_19 - response: *ref_20 - create: + server_streaming_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:serverStreamingPredict/post response: mediaType: application/json openAPIDocKey: '200' - complete: + mutate_deployed_model: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:complete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:mutateDeployedModel/post response: mediaType: application/json openAPIDocKey: '200' - stop: + direct_raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directRawPredict/post response: mediaType: application/json openAPIDocKey: '200' - suggest: + count_tokens: + operation: + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:countTokens/post' + response: + mediaType: application/json + openAPIDocKey: '200' + explain: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:suggest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:explain/post response: mediaType: application/json openAPIDocKey: '200' - check_trial_early_stopping_state: + stream_generate_content: + operation: + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:streamGenerateContent/post' + response: + mediaType: application/json + openAPIDocKey: '200' + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/trials/methods/get' - - $ref: '#/components/x-stackQL-resources/trials/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/trials/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/trials/methods/delete' - trials_optimal_trials: - id: google.aiplatform.trials_optimal_trials - name: trials_optimal_trials - title: Trials_optimal_trials - methods: - list_optimal_trials: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - trials_trial_measurement: - id: google.aiplatform.trials_trial_measurement - name: trials_trial_measurement - title: Trials_trial_measurement - methods: - add_trial_measurement: + objectKey: $.endpoints + raw_predict: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:rawPredict/post + response: + mediaType: application/json + openAPIDocKey: '200' + predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post + response: + mediaType: application/json + openAPIDocKey: '200' + undeploy_model: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post + response: + mediaType: application/json + openAPIDocKey: '200' + compute_tokens: + operation: + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:computeTokens/post' + response: + mediaType: application/json + openAPIDocKey: '200' + direct_predict: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directPredict/post + response: + mediaType: application/json + openAPIDocKey: '200' + generate_content: + operation: + $ref: '#/paths/~1v1~1endpoints~1{endpointsId}:generateContent/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - index_endpoints: - id: google.aiplatform.index_endpoints - name: index_endpoints - title: Index_endpoints + select: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' + hyperparameter_tuning_jobs: + id: google.aiplatform.hyperparameter_tuning_jobs + name: hyperparameter_tuning_jobs + title: Hyperparameter_tuning_jobs methods: - mutate_deployed_index: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post response: mediaType: application/json openAPIDocKey: '200' - undeploy_index: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.hyperparameterTuningJobs delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - read_index_datapoints: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/get + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete + notebook_execution_jobs: + id: google.aiplatform.notebook_execution_jobs + name: notebook_execution_jobs + title: Notebook_execution_jobs + methods: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_21 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.indexEndpoints list: - operation: *ref_21 - response: *ref_22 - create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs/get response: mediaType: application/json openAPIDocKey: '200' - find_neighbors: + objectKey: $.notebookExecutionJobs + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - deploy_index: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookExecutionJobs~1{notebookExecutionJobsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/list' + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/get + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/list insert: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/create + update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' - time_series: - id: google.aiplatform.time_series - name: time_series - title: Time_series + - $ref: >- + #/components/x-stackQL-resources/notebook_execution_jobs/methods/delete + notebook_runtime_templates_iam_policies: + id: google.aiplatform.notebook_runtime_templates_iam_policies + name: notebook_runtime_templates_iam_policies + title: Notebook_runtime_templates_iam_policies methods: - delete: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.bindings + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - patch: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/set_iam_policy + delete: [] + notebook_runtime_templates: + id: google.aiplatform.notebook_runtime_templates + name: notebook_runtime_templates + title: Notebook_runtime_templates + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_23 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get - response: &ref_24 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardTimeSeries - list: - operation: *ref_23 - response: *ref_24 - read_blob_data: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:readBlobData/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - read: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:read/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get response: mediaType: application/json openAPIDocKey: '200' - export_tensorboard_time_series: + objectKey: $.notebookRuntimeTemplates + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:exportTensorboardTimeSeries/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/time_series/methods/get' - - $ref: '#/components/x-stackQL-resources/time_series/methods/list' + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/get + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/list insert: - - $ref: '#/components/x-stackQL-resources/time_series/methods/create' + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/create update: - - $ref: '#/components/x-stackQL-resources/time_series/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/patch + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' - runs: - id: google.aiplatform.runs - name: runs - title: Runs + - $ref: >- + #/components/x-stackQL-resources/notebook_runtime_templates/methods/delete + schedules: + id: google.aiplatform.schedules + name: schedules + title: Schedules methods: - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.schedules + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/get response: mediaType: application/json openAPIDocKey: '200' - write: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}:write/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_25 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get - response: &ref_26 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboardRuns - list: - operation: *ref_25 - response: *ref_26 - create: + pause: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post response: mediaType: application/json openAPIDocKey: '200' - batch_create: + resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/runs/methods/get' - - $ref: '#/components/x-stackQL-resources/runs/methods/list' + - $ref: '#/components/x-stackQL-resources/schedules/methods/get' + - $ref: '#/components/x-stackQL-resources/schedules/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/runs/methods/create' + - $ref: '#/components/x-stackQL-resources/schedules/methods/create' update: - - $ref: '#/components/x-stackQL-resources/runs/methods/patch' + - $ref: '#/components/x-stackQL-resources/schedules/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/runs/methods/delete' - experiments: - id: google.aiplatform.experiments - name: experiments - title: Experiments + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' + custom_jobs: + id: google.aiplatform.custom_jobs + name: custom_jobs + title: Custom_jobs methods: - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get response: mediaType: application/json openAPIDocKey: '200' - batch_create: + objectKey: $.customJobs + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_27 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get - response: &ref_28 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.tensorboardExperiments - list: - operation: *ref_27 - response: *ref_28 - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - write: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:write/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/experiments/methods/get' - - $ref: '#/components/x-stackQL-resources/experiments/methods/list' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/experiments/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/experiments/methods/patch' + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' + update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' - tensorboards: - id: google.aiplatform.tensorboards - name: tensorboards - title: Tensorboards + - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' + tuning_jobs: + id: google.aiplatform.tuning_jobs + name: tuning_jobs + title: Tuning_jobs methods: - batch_read: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.tuningJobs create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_29 + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get - response: &ref_30 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tensorboards + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' + update: [] + replace: [] + delete: [] + saved_queries: + id: google.aiplatform.saved_queries + name: saved_queries + title: Saved_queries + methods: list: - operation: *ref_29 - response: *ref_30 - read_usage: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readUsage/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.savedQueries delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries~1{savedQueriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' + annotations: + id: google.aiplatform.annotations + name: annotations + title: Annotations + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.annotations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/annotations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + data_items: + id: google.aiplatform.data_items + name: data_items + title: Data_items + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get response: mediaType: application/json openAPIDocKey: '200' - read_size: + objectKey: $.dataItems + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/data_items/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + annotation_specs: + id: google.aiplatform.annotation_specs + name: annotation_specs + title: Annotation_specs + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1annotationSpecs~1{annotationSpecsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/get' - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/tensorboards/methods/delete' - persistent_resources: - id: google.aiplatform.persistent_resources - name: persistent_resources - title: Persistent_resources + - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + dataset_versions: + id: google.aiplatform.dataset_versions + name: dataset_versions + title: Dataset_versions methods: - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/get + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/patch + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}/delete + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/post + $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/get' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_31 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources/get - response: &ref_32 + objectKey: $.datasetVersions + create: + operation: + $ref: '#/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions/post' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.persistentResources - list: - operation: *ref_31 - response: *ref_32 - reboot: + restore: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1persistentResources~1{persistentResourcesId}:reboot/post + #/paths/~1v1~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/get' - - $ref: '#/components/x-stackQL-resources/persistent_resources/methods/list' + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/get' + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/create + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/patch + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/patch' + replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/persistent_resources/methods/delete - deployment_resource_pools: - id: google.aiplatform.deployment_resource_pools - name: deployment_resource_pools - title: Deployment_resource_pools + - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/delete' + datasets: + id: google.aiplatform.datasets + name: datasets + title: Datasets methods: create: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/post + $ref: '#/paths/~1v1~1datasets/post' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_33 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/get - response: &ref_34 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deploymentResourcePools list: - operation: *ref_33 - response: *ref_34 - delete: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/delete + $ref: '#/paths/~1v1~1datasets/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.datasets get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - query_deployed_models: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get + $ref: '#/paths/~1v1~1datasets~1{datasetsId}/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/get - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/create - update: [] delete: - - $ref: >- - #/components/x-stackQL-resources/deployment_resource_pools/methods/delete - features: - id: google.aiplatform.features - name: features - title: Features - methods: - patch: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/patch + $ref: '#/paths/~1v1~1datasets~1{datasetsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/delete + $ref: '#/paths/~1v1~1datasets~1{datasetsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - get: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/post response: mediaType: application/json openAPIDocKey: '200' - create: + search_data_items: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:searchDataItems/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_35 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/get - response: &ref_36 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.features - list: - operation: *ref_35 - response: *ref_36 - batch_create: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features:batchCreate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/features/methods/get' - - $ref: '#/components/x-stackQL-resources/features/methods/list' - - $ref: '#/components/x-stackQL-resources/features/methods/get' - - $ref: '#/components/x-stackQL-resources/features/methods/list' + - $ref: '#/components/x-stackQL-resources/datasets/methods/get' + - $ref: '#/components/x-stackQL-resources/datasets/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/features/methods/create' - - $ref: '#/components/x-stackQL-resources/features/methods/create' + - $ref: '#/components/x-stackQL-resources/datasets/methods/create' update: - - $ref: '#/components/x-stackQL-resources/features/methods/patch' - - $ref: '#/components/x-stackQL-resources/features/methods/patch' + - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/features/methods/delete' - - $ref: '#/components/x-stackQL-resources/features/methods/delete' - entity_types: - id: google.aiplatform.entity_types - name: entity_types - title: Entity_types + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' + runs: + id: google.aiplatform.runs + name: runs + title: Runs methods: - export_feature_values: + batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:exportFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - import_feature_values: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:importFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}/patch response: mediaType: application/json openAPIDocKey: '200' - read_feature_values: + write: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:readFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}:write/post response: mediaType: application/json openAPIDocKey: '200' - streaming_read_feature_values: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:streamingReadFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.tensorboardRuns create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post - response: - mediaType: application/json - openAPIDocKey: '200' - _list: - operation: &ref_37 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get - response: &ref_38 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.entityTypes - list: - operation: *ref_37 - response: *ref_38 - write_feature_values: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:writeFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' - - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' + - $ref: '#/components/x-stackQL-resources/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/runs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/create' + - $ref: '#/components/x-stackQL-resources/runs/methods/batch_create' + - $ref: '#/components/x-stackQL-resources/runs/methods/create' update: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/patch' + - $ref: '#/components/x-stackQL-resources/runs/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' - entity_types_iam_policies: - id: google.aiplatform.entity_types_iam_policies - name: entity_types_iam_policies - title: Entity_types_iam_policies + - $ref: '#/components/x-stackQL-resources/runs/methods/delete' + time_series: + id: google.aiplatform.time_series + name: time_series + title: Time_series methods: - test_iam_permissions: + read: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:read/get + response: + mediaType: application/json + openAPIDocKey: '200' + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/get response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_39 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post - response: &ref_40 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_39 - response: *ref_40 - set_iam_policy: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] - entity_types_feature_values: - id: google.aiplatform.entity_types_feature_values - name: entity_types_feature_values - title: Entity_types_feature_values - methods: - delete_feature_values: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - featurestores_iam_policies: - id: google.aiplatform.featurestores_iam_policies - name: featurestores_iam_policies - title: Featurestores_iam_policies - methods: - test_iam_permissions: + objectKey: $.tensorboardTimeSeries + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries/post response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_41 + read_blob_data: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post - response: &ref_42 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:readBlobData/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_41 - response: *ref_42 - set_iam_policy: + export_tensorboard_time_series: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}~1runs~1{runsId}~1timeSeries~1{timeSeriesId}:exportTensorboardTimeSeries/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] - featurestores: - id: google.aiplatform.featurestores - name: featurestores - title: Featurestores - methods: + - $ref: '#/components/x-stackQL-resources/time_series/methods/get' + - $ref: '#/components/x-stackQL-resources/time_series/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/time_series/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/time_series/methods/patch' + replace: [] delete: + - $ref: '#/components/x-stackQL-resources/time_series/methods/delete' + experiments: + id: google.aiplatform.experiments + name: experiments + title: Experiments + methods: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - search_features: + batch_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores:searchFeatures/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_43 + list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get - response: &ref_44 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featurestores - list: - operation: *ref_43 - response: *ref_44 - batch_read_feature_values: + objectKey: $.tensorboardExperiments + write: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:batchReadFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}~1experiments~1{experimentsId}:write/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' - - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' + - $ref: '#/components/x-stackQL-resources/experiments/methods/get' + - $ref: '#/components/x-stackQL-resources/experiments/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/create' + - $ref: '#/components/x-stackQL-resources/experiments/methods/batch_create' + - $ref: '#/components/x-stackQL-resources/experiments/methods/create' update: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/patch' + - $ref: '#/components/x-stackQL-resources/experiments/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/featurestores/methods/delete' - tuning_jobs: - id: google.aiplatform.tuning_jobs - name: tuning_jobs - title: Tuning_jobs + - $ref: '#/components/x-stackQL-resources/experiments/methods/delete' + tensorboards: + id: google.aiplatform.tensorboards + name: tensorboards + title: Tensorboards methods: - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/patch response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_45 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/get - response: &ref_46 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tuningJobs list: - operation: *ref_45 - response: *ref_46 + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tensorboards create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + batch_read: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tuningJobs~1{tuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:batchRead/get + response: + mediaType: application/json + openAPIDocKey: '200' + read_usage: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readUsage/get + response: + mediaType: application/json + openAPIDocKey: '200' + read_size: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tensorboards~1{tensorboardsId}:readSize/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/get' + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/tuning_jobs/methods/create' - update: [] - delete: [] + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/tensorboards/methods/delete' batch_prediction_jobs: id: google.aiplatform.batch_prediction_jobs name: batch_prediction_jobs title: Batch_prediction_jobs methods: - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_47 + objectKey: $.batchPredictionJobs + create: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/get - response: &ref_48 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.batchPredictionJobs - list: - operation: *ref_47 - response: *ref_48 - cancel: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -24115,10 +26431,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batchPredictionJobs~1{batchPredictionJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' @@ -24131,1410 +26447,1387 @@ components: - $ref: >- #/components/x-stackQL-resources/batch_prediction_jobs/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/batch_prediction_jobs/methods/delete - specialist_pools: - id: google.aiplatform.specialist_pools - name: specialist_pools - title: Specialist_pools + training_pipelines: + id: google.aiplatform.training_pipelines + name: training_pipelines + title: Training_pipelines methods: - _list: - operation: &ref_49 + list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get - response: &ref_50 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.specialistPools - list: - operation: *ref_49 - response: *ref_50 + objectKey: $.trainingPipelines create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines/post response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trainingPipelines~1{trainingPipelinesId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/get' - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/list' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/get' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/patch' + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/create' + update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' - endpoints: - id: google.aiplatform.endpoints - name: endpoints - title: Endpoints + - $ref: '#/components/x-stackQL-resources/training_pipelines/methods/delete' + indexes: + id: google.aiplatform.indexes + name: indexes + title: Indexes methods: - count_tokens: + upsert_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:countTokens/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post response: mediaType: application/json openAPIDocKey: '200' - generate_content: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:generateContent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get response: mediaType: application/json openAPIDocKey: '200' - mutate_deployed_model: + objectKey: $.indexes + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/indexes/methods/get' + - $ref: '#/components/x-stackQL-resources/indexes/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/indexes/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/indexes/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' + indexes_datapoints: + id: google.aiplatform.indexes_datapoints + name: indexes_datapoints + title: Indexes_datapoints + methods: + remove_datapoints: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:mutateDeployedModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post response: mediaType: application/json openAPIDocKey: '200' - compute_tokens: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/indexes_datapoints/methods/remove_datapoints + notebook_runtimes: + id: google.aiplatform.notebook_runtimes + name: notebook_runtimes + title: Notebook_runtimes + methods: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:computeTokens/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete response: mediaType: application/json openAPIDocKey: '200' - undeploy_model: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:undeployModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get response: mediaType: application/json openAPIDocKey: '200' - explain: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:explain/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_51 + objectKey: $.notebookRuntimes + upgrade: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/get - response: &ref_52 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.endpoints - list: - operation: *ref_51 - response: *ref_52 - create: + start: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post response: mediaType: application/json openAPIDocKey: '200' - direct_predict: + assign: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/post response: mediaType: application/json openAPIDocKey: '200' - server_streaming_predict: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' + featurestores_iam_policies: + id: google.aiplatform.featurestores_iam_policies + name: featurestores_iam_policies + title: Featurestores_iam_policies + methods: + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:serverStreamingPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - stream_raw_predict: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - deploy_model: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:deployModel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - raw_predict: + objectKey: $.bindings + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/featurestores_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/featurestores_iam_policies/methods/set_iam_policy + delete: [] + featurestores: + id: google.aiplatform.featurestores + name: featurestores + title: Featurestores + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:rawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/get response: mediaType: application/json openAPIDocKey: '200' - predict: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:predict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - direct_raw_predict: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:directRawPredict/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}/patch response: mediaType: application/json openAPIDocKey: '200' - stream_generate_content: + batch_read_feature_values: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}:batchReadFeatureValues/post + response: + mediaType: application/json + openAPIDocKey: '200' + search_features: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores:searchFeatures/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:streamGenerateContent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.featurestores sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/get' - - $ref: '#/components/x-stackQL-resources/endpoints/methods/list' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/get' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/create' update: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' + - $ref: '#/components/x-stackQL-resources/featurestores/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' - notebook_runtimes: - id: google.aiplatform.notebook_runtimes - name: notebook_runtimes - title: Notebook_runtimes + - $ref: '#/components/x-stackQL-resources/featurestores/methods/delete' + entity_types: + id: google.aiplatform.entity_types + name: entity_types + title: Entity_types methods: - upgrade: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:upgrade/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/post response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.entityTypes get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - assign: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes:assign/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - start: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes~1{notebookRuntimesId}:start/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_53 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimes/get - response: &ref_54 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.notebookRuntimes - list: - operation: *ref_53 - response: *ref_54 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/get' - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/list' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/notebook_runtimes/methods/delete' - custom_jobs: - id: google.aiplatform.custom_jobs - name: custom_jobs - title: Custom_jobs - methods: - _list: - operation: &ref_55 + read_feature_values: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/get - response: &ref_56 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:readFeatureValues/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customJobs - list: - operation: *ref_55 - response: *ref_56 - create: + import_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:importFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + streaming_read_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:streamingReadFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - get: + write_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:writeFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' - delete: + export_feature_values: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customJobs~1{customJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:exportFeatureValues/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' + - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/create' - update: [] + - $ref: '#/components/x-stackQL-resources/entity_types/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/entity_types/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/custom_jobs/methods/delete' - migratable_resources: - id: google.aiplatform.migratable_resources - name: migratable_resources - title: Migratable_resources + - $ref: '#/components/x-stackQL-resources/entity_types/methods/delete' + entity_types_iam_policies: + id: google.aiplatform.entity_types_iam_policies + name: entity_types_iam_policies + title: Entity_types_iam_policies methods: - search: + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:search/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - batch_migrate: + objectKey: $.bindings + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migratableResources:batchMigrate/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/entity_types_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entity_types_iam_policies/methods/set_iam_policy delete: [] - operations_wait: - id: google.aiplatform.operations_wait - name: operations_wait - title: Operations_wait + entity_types_feature_values: + id: google.aiplatform.entity_types_feature_values + name: entity_types_feature_values + title: Entity_types_feature_values methods: - _list_wait: - operation: &ref_57 + delete_feature_values: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1operations~1{operationsId}:wait/get - response: &ref_58 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}:deleteFeatureValues/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - list_wait: - operation: *ref_57 - response: *ref_58 sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' - - $ref: '#/components/x-stackQL-resources/operations_wait/methods/list_wait' + select: [] insert: [] update: [] - delete: [] - feature_groups: - id: google.aiplatform.feature_groups - name: feature_groups - title: Feature_groups + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/entity_types_feature_values/methods/delete_feature_values + features: + id: google.aiplatform.features + name: features + title: Features methods: - get: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.features delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_59 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get - response: &ref_60 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureGroups - list: - operation: *ref_59 - response: *ref_60 - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}~1features~1{featuresId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + batch_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featurestores~1{featurestoresId}~1entityTypes~1{entityTypesId}~1features:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' + - $ref: '#/components/x-stackQL-resources/features/methods/get' + - $ref: '#/components/x-stackQL-resources/features/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' + - $ref: '#/components/x-stackQL-resources/features/methods/create' + - $ref: '#/components/x-stackQL-resources/features/methods/batch_create' update: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' + - $ref: '#/components/x-stackQL-resources/features/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' - nas_trial_details: - id: google.aiplatform.nas_trial_details - name: nas_trial_details - title: Nas_trial_details + - $ref: '#/components/x-stackQL-resources/features/methods/delete' + studies: + id: google.aiplatform.studies + name: studies + title: Studies methods: - _list: - operation: &ref_61 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get - response: &ref_62 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nasTrialDetails list: - operation: *ref_61 - response: *ref_62 - get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails~1{nasTrialDetailsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' - - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' - insert: [] - update: [] - delete: [] - nas_jobs: - id: google.aiplatform.nas_jobs - name: nas_jobs - title: Nas_jobs - methods: - _list: - operation: &ref_63 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get - response: &ref_64 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nasJobs - list: - operation: *ref_63 - response: *ref_64 + objectKey: $.studies create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies/post response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}/get response: mediaType: application/json openAPIDocKey: '200' - cancel: + lookup: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies:lookup/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/list' + - $ref: '#/components/x-stackQL-resources/studies/methods/get' + - $ref: '#/components/x-stackQL-resources/studies/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/create' + - $ref: '#/components/x-stackQL-resources/studies/methods/create' update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' - datasets: - id: google.aiplatform.datasets - name: datasets - title: Datasets + - $ref: '#/components/x-stackQL-resources/studies/methods/delete' + trials: + id: google.aiplatform.trials + name: trials + title: Trials methods: - export: + stop: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:stop/post response: mediaType: application/json openAPIDocKey: '200' - search_data_items: + suggest: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:searchDataItems/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:suggest/post response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_65 + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/get - response: &ref_66 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.datasets list: - operation: *ref_65 - response: *ref_66 - delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.trials + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials/post response: mediaType: application/json openAPIDocKey: '200' - patch: + complete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:complete/post response: mediaType: application/json openAPIDocKey: '200' - import: + check_trial_early_stopping_state: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:checkTrialEarlyStoppingState/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/datasets/methods/get' - - $ref: '#/components/x-stackQL-resources/datasets/methods/list' + - $ref: '#/components/x-stackQL-resources/trials/methods/get' + - $ref: '#/components/x-stackQL-resources/trials/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/datasets/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' + - $ref: '#/components/x-stackQL-resources/trials/methods/create' + update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' - annotation_specs: - id: google.aiplatform.annotation_specs - name: annotation_specs - title: Annotation_specs + - $ref: '#/components/x-stackQL-resources/trials/methods/delete' + trials_optimal_trials: + id: google.aiplatform.trials_optimal_trials + name: trials_optimal_trials + title: Trials_optimal_trials methods: - get: + list_optimal_trials: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1annotationSpecs~1{annotationSpecsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials:listOptimalTrials/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/annotation_specs/methods/get' + - $ref: >- + #/components/x-stackQL-resources/trials_optimal_trials/methods/list_optimal_trials insert: [] update: [] + replace: [] delete: [] - dataset_versions: - id: google.aiplatform.dataset_versions - name: dataset_versions - title: Dataset_versions + trials_trial_measurement: + id: google.aiplatform.trials_trial_measurement + name: trials_trial_measurement + title: Trials_trial_measurement methods: - delete: + add_trial_measurement: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1studies~1{studiesId}~1trials~1{trialsId}:addTrialMeasurement/post response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/trials_trial_measurement/methods/add_trial_measurement + update: [] + replace: [] + delete: [] + index_endpoints: + id: google.aiplatform.index_endpoints + name: index_endpoints + title: Index_endpoints + methods: + find_neighbors: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:findNeighbors/post response: mediaType: application/json openAPIDocKey: '200' - patch: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_67 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/get - response: &ref_68 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.datasetVersions list: - operation: *ref_67 - response: *ref_68 - create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints/get response: mediaType: application/json openAPIDocKey: '200' - restore: + objectKey: $.indexEndpoints + mutate_deployed_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1datasetVersions~1{datasetVersionsId}:restore/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:mutateDeployedIndex/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/get' - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/dataset_versions/methods/delete' - annotations: - id: google.aiplatform.annotations - name: annotations - title: Annotations - methods: - _list: - operation: &ref_69 + read_index_datapoints: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems~1{dataItemsId}~1annotations/get - response: &ref_70 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:readIndexDatapoints/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.annotations - list: - operation: *ref_69 - response: *ref_70 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/annotations/methods/list' - insert: [] - update: [] - delete: [] - data_items: - id: google.aiplatform.data_items - name: data_items - title: Data_items - methods: - _list: - operation: &ref_71 + undeploy_index: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataItems/get - response: &ref_72 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:undeployIndex/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataItems - list: - operation: *ref_71 - response: *ref_72 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_items/methods/list' - insert: [] - update: [] - delete: [] - saved_queries: - id: google.aiplatform.saved_queries - name: saved_queries - title: Saved_queries - methods: - delete: + deploy_index: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries~1{savedQueriesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}:deployIndex/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_73 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1savedQueries/get - response: &ref_74 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.savedQueries - list: - operation: *ref_73 - response: *ref_74 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' - insert: [] - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' - model_deployment_monitoring_jobs: - id: google.aiplatform.model_deployment_monitoring_jobs - name: model_deployment_monitoring_jobs - title: Model_deployment_monitoring_jobs - methods: - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexEndpoints~1{indexEndpointsId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/get' + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/index_endpoints/methods/delete' + deployment_resource_pools: + id: google.aiplatform.deployment_resource_pools + name: deployment_resource_pools + title: Deployment_resource_pools + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/get response: mediaType: application/json openAPIDocKey: '200' - pause: + objectKey: $.deploymentResourcePools + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools/post response: mediaType: application/json openAPIDocKey: '200' - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_75 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get - response: &ref_76 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.modelDeploymentMonitoringJobs - list: - operation: *ref_75 - response: *ref_76 - search_model_deployment_monitoring_stats_anomalies: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - resume: + query_deployed_models: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deploymentResourcePools~1{deploymentResourcePoolsId}:queryDeployedModels/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/get + #/components/x-stackQL-resources/deployment_resource_pools/methods/get - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/list + #/components/x-stackQL-resources/deployment_resource_pools/methods/query_deployed_models + - $ref: >- + #/components/x-stackQL-resources/deployment_resource_pools/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create + #/components/x-stackQL-resources/deployment_resource_pools/methods/create update: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/patch + #/components/x-stackQL-resources/deployment_resource_pools/methods/patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete - feature_views: - id: google.aiplatform.feature_views - name: feature_views - title: Feature_views + #/components/x-stackQL-resources/deployment_resource_pools/methods/delete + nas_trial_details: + id: google.aiplatform.nas_trial_details + name: nas_trial_details + title: Nas_trial_details methods: - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails~1{nasTrialDetailsId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_77 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews/get - response: &ref_78 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.featureViews list: - operation: *ref_77 - response: *ref_78 - search_nearest_entities: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:searchNearestEntities/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}~1nasTrialDetails/get response: mediaType: application/json openAPIDocKey: '200' - sync: + objectKey: $.nasTrialDetails + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/get' + - $ref: '#/components/x-stackQL-resources/nas_trial_details/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + nas_jobs: + id: google.aiplatform.nas_jobs + name: nas_jobs + title: Nas_jobs + methods: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:sync/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/post response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.nasJobs delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nasJobs~1{nasJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_views/methods/list' + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/patch' + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/create' + update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/feature_views/methods/delete' - feature_views_feature_values: - id: google.aiplatform.feature_views_feature_values - name: feature_views_feature_values - title: Feature_views_feature_values + - $ref: '#/components/x-stackQL-resources/nas_jobs/methods/delete' + data_labeling_jobs: + id: google.aiplatform.data_labeling_jobs + name: data_labeling_jobs + title: Data_labeling_jobs methods: - fetch_feature_values: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}:fetchFeatureValues/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.dataLabelingJobs + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/create' update: [] - delete: [] - feature_view_syncs: - id: google.aiplatform.feature_view_syncs - name: feature_view_syncs - title: Feature_view_syncs + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/delete' + model_deployment_monitoring_jobs: + id: google.aiplatform.model_deployment_monitoring_jobs + name: model_deployment_monitoring_jobs + title: Model_deployment_monitoring_jobs methods: - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs~1{featureViewSyncsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_79 + objectKey: $.modelDeploymentMonitoringJobs + create: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}~1featureViews~1{featureViewsId}~1featureViewSyncs/get - response: &ref_80 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureViewSyncs - list: - operation: *ref_79 - response: *ref_80 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/get' - - $ref: '#/components/x-stackQL-resources/feature_view_syncs/methods/list' - insert: [] - update: [] - delete: [] - feature_online_stores: - id: google.aiplatform.feature_online_stores - name: feature_online_stores - title: Feature_online_stores - methods: patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/patch response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + resume: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores~1{featureOnlineStoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:resume/post response: mediaType: application/json openAPIDocKey: '200' - create: + search_model_deployment_monitoring_stats_anomalies: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_81 + pause: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureOnlineStores/get - response: &ref_82 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1modelDeploymentMonitoringJobs~1{modelDeploymentMonitoringJobsId}:pause/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.featureOnlineStores - list: - operation: *ref_81 - response: *ref_82 sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/feature_online_stores/methods/get' - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/list + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/get + - $ref: >- + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/list insert: - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/create + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/create update: - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/patch + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/feature_online_stores/methods/delete - indexes: - id: google.aiplatform.indexes - name: indexes - title: Indexes + #/components/x-stackQL-resources/model_deployment_monitoring_jobs/methods/delete + evaluations: + id: google.aiplatform.evaluations + name: evaluations + title: Evaluations methods: - _list: - operation: &ref_83 + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/get - response: &ref_84 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.indexes - list: - operation: *ref_83 - response: *ref_84 - create: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations:import/post response: mediaType: application/json openAPIDocKey: '200' - upsert_datapoints: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:upsertDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.modelEvaluations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/evaluations/methods/get' + - $ref: '#/components/x-stackQL-resources/evaluations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + slices: + id: google.aiplatform.slices + name: slices + title: Slices + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices/get response: mediaType: application/json openAPIDocKey: '200' - patch: + objectKey: $.modelEvaluationSlices + batch_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}:batchImport/post response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}~1evaluations~1{evaluationsId}~1slices~1{slicesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/indexes/methods/get' - - $ref: '#/components/x-stackQL-resources/indexes/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/indexes/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/indexes/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' - indexes_datapoints: - id: google.aiplatform.indexes_datapoints - name: indexes_datapoints - title: Indexes_datapoints + - $ref: '#/components/x-stackQL-resources/slices/methods/get' + - $ref: '#/components/x-stackQL-resources/slices/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + models_versions: + id: google.aiplatform.models_versions + name: models_versions + title: Models_versions methods: - remove_datapoints: + list_versions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1indexes~1{indexesId}:removeDatapoints/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:listVersions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.models sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/models_versions/methods/list_versions insert: [] update: [] + replace: [] delete: [] - data_labeling_jobs: - id: google.aiplatform.data_labeling_jobs - name: data_labeling_jobs - title: Data_labeling_jobs + models_iam_policies: + id: google.aiplatform.models_iam_policies + name: models_iam_policies + title: Models_iam_policies methods: - get: + get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.bindings + set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs~1{dataLabelingJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_85 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/get - response: &ref_86 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.dataLabelingJobs - list: - operation: *ref_85 - response: *ref_86 - create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/models_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/models_iam_policies/methods/set_iam_policy + delete: [] + models_version: + id: google.aiplatform.models_version + name: models_version + title: Models_version + methods: + delete_version: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataLabelingJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:deleteVersion/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/create' + select: [] + insert: [] update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/data_labeling_jobs/methods/delete' - artifacts: - id: google.aiplatform.artifacts - name: artifacts - title: Artifacts + - $ref: >- + #/components/x-stackQL-resources/models_version/methods/delete_version + models_explanation_dataset: + id: google.aiplatform.models_explanation_dataset + name: models_explanation_dataset + title: Models_explanation_dataset methods: - purge: + update_explanation_dataset: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1models~1{modelsId}:updateExplanationDataset/post response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/models_explanation_dataset/methods/update_explanation_dataset + replace: [] + delete: [] + specialist_pools: + id: google.aiplatform.specialist_pools + name: specialist_pools + title: Specialist_pools + methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools~1{specialistPoolsId}/delete response: mediaType: application/json openAPIDocKey: '200' - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_87 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get - response: &ref_88 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.artifacts - list: - operation: *ref_87 - response: *ref_88 - query_artifact_lineage_subgraph: + objectKey: $.specialistPools + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}:queryArtifactLineageSubgraph/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1specialistPools/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' - - $ref: '#/components/x-stackQL-resources/artifacts/methods/list' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/create' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/create' update: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/patch' + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' - executions_execution_events: - id: google.aiplatform.executions_execution_events - name: executions_execution_events - title: Executions_execution_events + - $ref: '#/components/x-stackQL-resources/specialist_pools/methods/delete' + pipeline_jobs: + id: google.aiplatform.pipeline_jobs + name: pipeline_jobs + title: Pipeline_jobs methods: - add_execution_events: + batch_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - executions: - id: google.aiplatform.executions - name: executions - title: Executions - methods: - _list: - operation: &ref_89 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get - response: &ref_90 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.executions - list: - operation: *ref_89 - response: *ref_90 - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' - patch: + batch_cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post response: mediaType: application/json openAPIDocKey: '200' - query_execution_inputs_and_outputs: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post response: mediaType: application/json openAPIDocKey: '200' - purge: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.pipelineJobs sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/executions/methods/get' - - $ref: '#/components/x-stackQL-resources/executions/methods/list' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/executions/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/executions/methods/patch' + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' + update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/executions/methods/delete' - contexts: - id: google.aiplatform.contexts - name: contexts - title: Contexts + - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/pipeline_jobs/methods/batch_delete + feature_groups: + id: google.aiplatform.feature_groups + name: feature_groups + title: Feature_groups methods: - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - patch: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups~1{featureGroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_91 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get - response: &ref_92 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.contexts - list: - operation: *ref_91 - response: *ref_92 create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post - response: - mediaType: application/json - openAPIDocKey: '200' - purge: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/post response: mediaType: application/json openAPIDocKey: '200' - query_context_lineage_subgraph: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:queryContextLineageSubgraph/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1featureGroups/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.featureGroups sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/contexts/methods/get' - - $ref: '#/components/x-stackQL-resources/contexts/methods/list' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/get' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/contexts/methods/create' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create' update: - - $ref: '#/components/x-stackQL-resources/contexts/methods/patch' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/contexts/methods/delete' - contexts_context_children: - id: google.aiplatform.contexts_context_children - name: contexts_context_children - title: Contexts_context_children - methods: - remove_context_children: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post - response: - mediaType: application/json - openAPIDocKey: '200' - add_context_children: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - contexts_context_artifacts_and_executions: - id: google.aiplatform.contexts_context_artifacts_and_executions - name: contexts_context_artifacts_and_executions - title: Contexts_context_artifacts_and_executions - methods: - add_context_artifacts_and_executions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextArtifactsAndExecutions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete' metadata_schemas: id: google.aiplatform.metadata_schemas name: metadata_schemas title: Metadata_schemas methods: - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_93 + objectKey: $.metadataSchemas + create: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/get - response: &ref_94 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1metadataSchemas/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.metadataSchemas - list: - operation: *ref_93 - response: *ref_94 get: operation: $ref: >- @@ -25549,358 +27842,2801 @@ components: insert: - $ref: '#/components/x-stackQL-resources/metadata_schemas/methods/create' update: [] + replace: [] delete: [] - metadata_stores: - id: google.aiplatform.metadata_stores - name: metadata_stores - title: Metadata_stores + artifacts: + id: google.aiplatform.artifacts + name: artifacts + title: Artifacts methods: - _list: - operation: &ref_95 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/get - response: &ref_96 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.metadataStores - list: - operation: *ref_95 - response: *ref_96 - create: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/patch response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/get' - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/delete' - notebook_runtime_templates: - id: google.aiplatform.notebook_runtime_templates - name: notebook_runtime_templates - title: Notebook_runtime_templates - methods: - _list: - operation: &ref_97 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/get - response: &ref_98 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.notebookRuntimeTemplates - list: - operation: *ref_97 - response: *ref_98 - create: + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts:purge/post response: mediaType: application/json openAPIDocKey: '200' - delete: + query_artifact_lineage_subgraph: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts~1{artifactsId}:queryArtifactLineageSubgraph/get response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.artifacts + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1artifacts/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: '#/components/x-stackQL-resources/artifacts/methods/get' - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/get - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/list + #/components/x-stackQL-resources/artifacts/methods/query_artifact_lineage_subgraph + - $ref: '#/components/x-stackQL-resources/artifacts/methods/list' insert: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/create + - $ref: '#/components/x-stackQL-resources/artifacts/methods/create' update: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/patch + - $ref: '#/components/x-stackQL-resources/artifacts/methods/patch' + replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates/methods/delete - notebook_runtime_templates_iam_policies: - id: google.aiplatform.notebook_runtime_templates_iam_policies - name: notebook_runtime_templates_iam_policies - title: Notebook_runtime_templates_iam_policies + - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete' + contexts: + id: google.aiplatform.contexts + name: contexts + title: Contexts methods: - _get_iam_policy: - operation: &ref_99 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:getIamPolicy/post - response: &ref_100 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_99 - response: *ref_100 - set_iam_policy: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/delete response: mediaType: application/json openAPIDocKey: '200' - test_iam_permissions: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notebookRuntimeTemplates~1{notebookRuntimeTemplatesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/patch response: mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/notebook_runtime_templates_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] - pipeline_jobs: - id: google.aiplatform.pipeline_jobs - name: pipeline_jobs - title: Pipeline_jobs - methods: + openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}/get response: mediaType: application/json openAPIDocKey: '200' - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_101 + list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/get - response: &ref_102 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.pipelineJobs - list: - operation: *ref_101 - response: *ref_102 - create: + objectKey: $.contexts + purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts:purge/post response: mediaType: application/json openAPIDocKey: '200' - cancel: + query_context_lineage_subgraph: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs~1{pipelineJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:queryContextLineageSubgraph/get response: mediaType: application/json openAPIDocKey: '200' - batch_delete: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/contexts/methods/get' + - $ref: >- + #/components/x-stackQL-resources/contexts/methods/query_context_lineage_subgraph + - $ref: '#/components/x-stackQL-resources/contexts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/contexts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/contexts/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/contexts/methods/delete' + contexts_context_children: + id: google.aiplatform.contexts_context_children + name: contexts_context_children + title: Contexts_context_children + methods: + add_context_children: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchDelete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextChildren/post response: mediaType: application/json openAPIDocKey: '200' - batch_cancel: + remove_context_children: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelineJobs:batchCancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:removeContextChildren/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/get' - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/list' + select: [] insert: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/create' + - $ref: >- + #/components/x-stackQL-resources/contexts_context_children/methods/add_context_children update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/pipeline_jobs/methods/delete' - schedules: - id: google.aiplatform.schedules - name: schedules - title: Schedules + - $ref: >- + #/components/x-stackQL-resources/contexts_context_children/methods/remove_context_children + contexts_context_artifacts_and_executions: + id: google.aiplatform.contexts_context_artifacts_and_executions + name: contexts_context_artifacts_and_executions + title: Contexts_context_artifacts_and_executions methods: - pause: + add_context_artifacts_and_executions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:pause/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1contexts~1{contextsId}:addContextArtifactsAndExecutions/post response: mediaType: application/json openAPIDocKey: '200' - delete: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/contexts_context_artifacts_and_executions/methods/add_context_artifacts_and_executions + update: [] + replace: [] + delete: [] + executions_execution_events: + id: google.aiplatform.executions_execution_events + name: executions_execution_events + title: Executions_execution_events + methods: + add_execution_events: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:addExecutionEvents/post response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/executions_execution_events/methods/add_execution_events + update: [] + replace: [] + delete: [] + executions: + id: google.aiplatform.executions + name: executions + title: Executions + methods: + query_execution_inputs_and_outputs: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}:queryExecutionInputsAndOutputs/get response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.executions create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_103 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules/get - response: &ref_104 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.schedules - list: - operation: *ref_103 - response: *ref_104 - resume: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1schedules~1{schedulesId}:resume/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions~1{executionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}~1executions:purge/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/schedules/methods/get' - - $ref: '#/components/x-stackQL-resources/schedules/methods/list' + - $ref: >- + #/components/x-stackQL-resources/executions/methods/query_execution_inputs_and_outputs + - $ref: '#/components/x-stackQL-resources/executions/methods/get' + - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/schedules/methods/create' + - $ref: '#/components/x-stackQL-resources/executions/methods/create' update: - - $ref: '#/components/x-stackQL-resources/schedules/methods/patch' + - $ref: '#/components/x-stackQL-resources/executions/methods/patch' + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/schedules/methods/delete' - hyperparameter_tuning_jobs: - id: google.aiplatform.hyperparameter_tuning_jobs - name: hyperparameter_tuning_jobs - title: Hyperparameter_tuning_jobs + - $ref: '#/components/x-stackQL-resources/executions/methods/delete' + metadata_stores: + id: google.aiplatform.metadata_stores + name: metadata_stores + title: Metadata_stores methods: - create: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_105 + objectKey: $.metadataStores + create: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs/get - response: &ref_106 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.hyperparameterTuningJobs - list: - operation: *ref_105 - response: *ref_106 - cancel: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/delete response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataStores~1{metadataStoresId}/get response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/get' + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/create' + update: [] + replace: [] delete: + - $ref: '#/components/x-stackQL-resources/metadata_stores/methods/delete' + locations: + id: google.aiplatform.locations + name: locations + title: Locations + methods: + evaluate_instances: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1hyperparameterTuningJobs~1{hyperparameterTuningJobsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:evaluateInstances/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.locations sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/get - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/list - insert: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/create + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/hyperparameter_tuning_jobs/methods/delete + replace: [] + delete: [] paths: - /v1/publishers/{publishersId}/models/{modelsId}: - parameters: &ref_107 - - $ref: '#/components/parameters/_.xgafv' + /v1/publishers/{publishersId}/models/{modelsId}:countTokens: + parameters: &ref_1 - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' + post: + description: Perform a token counting. + operationId: aiplatform.publishers.models.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}:computeTokens: + parameters: *ref_1 + post: + description: Return a list of tokens based on the input text. + operationId: aiplatform.publishers.models.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}:generateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs. + operationId: aiplatform.publishers.models.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.publishers.models.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/publishers/{publishersId}/models/{modelsId}: + parameters: *ref_1 + get: + description: Gets a Model Garden publisher model. + operationId: aiplatform.publishers.models.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PublisherModel' + parameters: + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: isHuggingFaceModel + schema: + type: boolean + - in: query + name: huggingFaceToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.migratableResources.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migratableResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.migratableResources.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migratableResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.migratableResources.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migratableResourcesId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.migratableResources.operations.wait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migratableResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.migratableResources.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migratableResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: + parameters: *ref_1 + post: + description: >- + Searches all of the resources in automl.googleapis.com, + datalabeling.googleapis.com and ml.googleapis.com that can be migrated + to Vertex AI's given location. + operationId: aiplatform.projects.locations.migratableResources.search + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: + parameters: *ref_1 + post: + description: >- + Batch migrates resources from ml.googleapis.com, automl.googleapis.com, + and datalabeling.googleapis.com to Vertex AI. + operationId: aiplatform.projects.locations.migratableResources.batchMigrate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featureOnlineStores.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: + parameters: *ref_1 + post: + description: Creates a new FeatureView in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: query + name: runSyncImmediately + schema: + type: boolean + - in: query + name: featureViewId + schema: + type: string + get: + description: Lists FeatureViews in a given FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: + parameters: *ref_1 + post: + description: >- + Search the nearest entities under a FeatureView. Search only works for + indexable feature view; if a feature view isn't indexable, returns + Invalid argument response. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: + parameters: *ref_1 + get: + description: Gets details of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + delete: + description: Deletes a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: + parameters: *ref_1 + post: + description: Fetch feature values under a FeatureView. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: + parameters: *ref_1 + post: + description: Triggers on-demand sync for the FeatureView. + operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: + parameters: *ref_1 + get: + description: Gets details of a single FeatureViewSync. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: featureViewSyncsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: + parameters: *ref_1 + get: + description: Lists FeatureViewSyncs in a given FeatureView. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: path + name: featureViewsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: + parameters: *ref_1 + get: + description: Gets details of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + delete: + description: >- + Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not + contain any FeatureViews. + operationId: aiplatform.projects.locations.featureOnlineStores.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + patch: + description: Updates the parameters of a single FeatureOnlineStore. + operationId: aiplatform.projects.locations.featureOnlineStores.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: aiplatform.projects.locations.featureOnlineStores.testIamPermissions + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: + parameters: *ref_1 + post: + description: Creates a new FeatureOnlineStore in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: featureOnlineStoreId + schema: + type: string + get: + description: Lists FeatureOnlineStores in a given project and location. + operationId: aiplatform.projects.locations.featureOnlineStores.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featureOnlineStores.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featureOnlineStores.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: featureOnlineStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.persistentResources.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.persistentResources.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.persistentResources.operations.wait + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.persistentResources.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: + parameters: *ref_1 get: - description: Gets a Model Garden publisher model. - operationId: aiplatform.publishers.models.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.persistentResources.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: + parameters: *ref_1 + get: + description: Lists PersistentResources in a Location. + operationId: aiplatform.projects.locations.persistentResources.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: persistentResourceId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: + parameters: *ref_1 + delete: + description: Deletes a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + get: + description: Gets a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + patch: + description: Updates a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: + parameters: *ref_1 + post: + description: Reboots a PersistentResource. + operationId: aiplatform.projects.locations.persistentResources.reboot + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: persistentResourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.endpoints.operations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: endpointsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.endpoints.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: endpointsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.endpoints.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: endpointsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.endpoints.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: endpointsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.endpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25912,67 +30648,81 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PublisherModel' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: publishersId + name: projectsId required: true schema: type: string - in: path - name: modelsId + name: locationsId required: true schema: type: string - - in: query - name: view + - in: path + name: endpointsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - in: query - name: languageCode + name: timeout schema: type: string - /v1/projects/{projectsId}/locations: - parameters: *ref_107 - get: - description: Lists information about the supported locations for this service. - operationId: aiplatform.projects.locations.list + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: + parameters: *ref_1 + post: + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.endpoints.streamRawPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: endpointsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: + parameters: *ref_1 get: - description: Gets information about a location. - operationId: aiplatform.projects.locations.get + description: Gets an Endpoint. + operationId: aiplatform.projects.locations.endpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -25984,7 +30734,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -25996,13 +30746,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.list + - in: path + name: endpointsId + required: true + schema: + type: string + patch: + description: Updates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26014,7 +30770,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' parameters: - in: path name: projectsId @@ -26027,37 +30783,18 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel + format: google-fieldmask + delete: + description: Deletes an Endpoint. + operationId: aiplatform.projects.locations.endpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26069,7 +30806,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -26082,41 +30819,78 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: + parameters: *ref_1 + post: + description: Deploys a Model into this Endpoint, creating a DeployedModel within it. + operationId: aiplatform.projects.locations.endpoints.deployModel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: - parameters: *ref_107 + - in: path + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: + parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.trainingPipelines.operations.wait + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -26129,41 +30903,83 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: + parameters: *ref_1 + post: + description: >- + Updates an existing deployed model. Updatable fields include + `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, + `disable_container_logging` (v1 only), and `enable_container_logging` + (v1beta1 only). + operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: endpointsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: - parameters: *ref_107 - delete: + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.trainingPipelines.operations.delete + Perform an unary online prediction request to a gRPC model server for + custom containers. + operationId: aiplatform.projects.locations.endpoints.directRawPredict + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse parameters: - in: path name: projectsId @@ -26176,33 +30992,79 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: + parameters: *ref_1 + post: + description: Perform a token counting. + operationId: aiplatform.projects.locations.endpoints.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - get: + - in: path + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.trainingPipelines.operations.get + Perform an online explanation. If deployed_model_id is specified, the + corresponding DeployModel must have explanation_spec populated. If + deployed_model_id is not specified, all DeployedModels must have + explanation_spec populated. + operationId: aiplatform.projects.locations.endpoints.explain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' parameters: - in: path name: projectsId @@ -26215,27 +31077,64 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.endpoints.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: - parameters: *ref_107 + - in: path + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints: + parameters: *ref_1 post: - description: >- - Creates a TrainingPipeline. A created TrainingPipeline right away will - be attempted to be run. - operationId: aiplatform.projects.locations.trainingPipelines.create + description: Creates an Endpoint. + operationId: aiplatform.projects.locations.endpoints.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26247,7 +31146,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -26259,9 +31158,13 @@ paths: required: true schema: type: string + - in: query + name: endpointId + schema: + type: string get: - description: Lists TrainingPipelines in a Location. - operationId: aiplatform.projects.locations.trainingPipelines.list + description: Lists Endpoints in a Location. + operationId: aiplatform.projects.locations.endpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26274,7 +31177,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse + #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse parameters: - in: path name: projectsId @@ -26286,41 +31189,59 @@ paths: required: true schema: type: string + - in: query + name: orderBy + schema: + type: string - in: query name: filter schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query name: readMask schema: type: string format: google-fieldmask - in: query - name: pageToken + name: pageSize schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: - parameters: *ref_107 - delete: - description: Deletes a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.delete + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: + parameters: *ref_1 + post: + description: >- + Perform an online prediction with an arbitrary HTTP payload. The + response includes the following HTTP headers: * + `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this + prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + DeployedModel that served this prediction. + operationId: aiplatform.projects.locations.endpoints.rawPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -26333,25 +31254,36 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId required: true schema: type: string - get: - description: Gets a TrainingPipeline. - operationId: aiplatform.projects.locations.trainingPipelines.get + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: + parameters: *ref_1 + post: + description: Perform an online prediction. + operationId: aiplatform.projects.locations.endpoints.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -26364,30 +31296,60 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: + parameters: *ref_1 post: description: >- - Cancels a TrainingPipeline. Starts asynchronous cancellation on the - TrainingPipeline. The server makes a best effort to cancel the pipeline, - but success is not guaranteed. Clients can use - PipelineService.GetTrainingPipeline or other methods to check whether - the cancellation succeeded or whether the pipeline completed despite - cancellation. On successful cancellation, the TrainingPipeline is not - deleted; instead it becomes a pipeline with a TrainingPipeline.error - value with a google.rpc.Status.code of 1, corresponding to - `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.trainingPipelines.cancel + Undeploys a Model from an Endpoint, removing a DeployedModel from it, + and freeing all resources it's using. + operationId: aiplatform.projects.locations.endpoints.undeployModel requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: endpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: + parameters: *ref_1 + post: + description: Return a list of tokens based on the input text. + operationId: aiplatform.projects.locations.endpoints.computeTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26399,7 +31361,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -26412,20 +31375,31 @@ paths: schema: type: string - in: path - name: trainingPipelinesId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: - parameters: *ref_107 - get: - description: Gets a ModelEvaluationSlice. - operationId: aiplatform.projects.locations.models.evaluations.slices.get + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: + parameters: *ref_1 + post: + description: >- + Perform an unary online prediction request to a gRPC model server for + Vertex first-party products and frameworks. + operationId: aiplatform.projects.locations.endpoints.directPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -26433,7 +31407,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice + #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse parameters: - in: path name: projectsId @@ -26446,36 +31420,30 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: slicesId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: + parameters: *ref_1 post: - description: Imports a list of externally generated EvaluatedAnnotations. - operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.endpoints.generateContent requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -26483,7 +31451,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -26496,25 +31464,19 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: path - name: slicesId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: - parameters: *ref_107 - get: - description: Lists ModelEvaluationSlices in a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.slices.list + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26526,8 +31488,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -26540,41 +31501,21 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId required: true schema: type: string - in: path - name: evaluationsId + name: operationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: - parameters: *ref_107 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.models.evaluations.operations.get + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26599,12 +31540,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -26613,13 +31549,13 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26631,7 +31567,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -26644,22 +31580,25 @@ paths: schema: type: string - in: path - name: modelsId + name: hyperparameterTuningJobsId required: true schema: type: string - - in: path - name: evaluationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: - parameters: *ref_107 + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -26671,7 +31610,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.models.evaluations.operations.wait + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26696,12 +31635,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -26715,61 +31649,8 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -26781,7 +31662,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.models.evaluations.operations.cancel + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26806,12 +31687,7 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId + name: hyperparameterTuningJobsId required: true schema: type: string @@ -26820,17 +31696,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: + parameters: *ref_1 post: - description: Imports an externally generated ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.import + description: Creates a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26842,7 +31718,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -26854,16 +31731,9 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: - parameters: *ref_107 get: - description: Lists ModelEvaluations in a Model. - operationId: aiplatform.projects.locations.models.evaluations.list + description: Lists HyperparameterTuningJobs in a Location. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26876,7 +31746,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse + #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse parameters: - in: path name: projectsId @@ -26888,22 +31758,17 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -26911,52 +31776,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: - parameters: *ref_107 - get: - description: Gets a ModelEvaluation. - operationId: aiplatform.projects.locations.models.evaluations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: - parameters: *ref_107 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.models.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: + parameters: *ref_1 + delete: + description: Deletes a HyperparameterTuningJob. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -26981,22 +31805,13 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId + name: hyperparameterTuningJobsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.operations.delete + get: + description: Gets a HyperparameterTuningJob + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27008,7 +31823,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob parameters: - in: path name: projectsId @@ -27021,29 +31837,31 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId + name: hyperparameterTuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: + parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.models.operations.cancel + Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on + the HyperparameterTuningJob. The server makes a best effort to cancel + the job, but success is not guaranteed. Clients can use + JobService.GetHyperparameterTuningJob or other methods to check whether + the cancellation succeeded or whether the job completed despite + cancellation. On successful cancellation, the HyperparameterTuningJob is + not deleted; instead it becomes a job with a + HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is + set to `CANCELLED`. + operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27068,65 +31886,12 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.models.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: modelsId + name: hyperparameterTuningJobsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -27138,7 +31903,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.models.operations.wait + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27163,7 +31928,7 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookExecutionJobsId required: true schema: type: string @@ -27177,11 +31942,15 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: - parameters: *ref_107 - get: - description: Gets a Model. - operationId: aiplatform.projects.locations.models.get + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27193,7 +31962,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -27206,15 +31975,21 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookExecutionJobsId required: true schema: type: string - delete: + - in: path + name: operationsId + required: true + schema: + type: string + get: description: >- - Deletes a Model. A model cannot be deleted if any Endpoint resource has - a DeployedModel based on the model in its deployed_models field. - operationId: aiplatform.projects.locations.models.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27239,18 +32014,29 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookExecutionJobsId required: true schema: type: string - patch: - description: Updates a Model. - operationId: aiplatform.projects.locations.models.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27262,7 +32048,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -27275,60 +32061,22 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models:copy: - parameters: *ref_107 - post: - description: >- - Copies an already existing Vertex AI Model into the specified Location. - The source Model must exist in the same Project. When copying custom - Models, the users themselves are responsible for Model.metadata content - to be region-agnostic, as well as making sure that any resources (e.g. - files) it depends on remain accessible. - operationId: aiplatform.projects.locations.models.copy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId + name: notebookExecutionJobsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations: + parameters: *ref_1 + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.models.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookExecutionJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27340,7 +32088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -27353,28 +32101,33 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookExecutionJobsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs: + parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.models.setIamPolicy + description: Creates a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27386,7 +32139,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -27398,16 +32151,13 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true + - in: query + name: notebookExecutionJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: - parameters: *ref_107 get: - description: Lists versions of the specified model. - operationId: aiplatform.projects.locations.models.listVersions + description: Lists NotebookExecutionJobs in a Location. + operationId: aiplatform.projects.locations.notebookExecutionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27420,7 +32170,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse + #/components/schemas/GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse parameters: - in: path name: projectsId @@ -27432,22 +32182,16 @@ paths: required: true schema: type: string - - in: path - name: modelsId - required: true - schema: - type: string - in: query - name: orderBy + name: view schema: type: string - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -27456,19 +32200,14 @@ paths: type: integer format: int32 - in: query - name: filter + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models:upload: - parameters: *ref_107 - post: - description: Uploads a Model artifact into Vertex AI. - operationId: aiplatform.projects.locations.models.upload - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' + /v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}: + parameters: *ref_1 + delete: + description: Deletes a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27492,19 +32231,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: - parameters: *ref_107 - post: - description: >- - Exports a trained, exportable Model to a location specified by the user. - A Model is considered to be exportable if it has at least one supported - export format. - operationId: aiplatform.projects.locations.models.export - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' + - in: path + name: notebookExecutionJobsId + required: true + schema: + type: string + get: + description: Gets a NotebookExecutionJob. + operationId: aiplatform.projects.locations.notebookExecutionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27516,7 +32250,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookExecutionJob parameters: - in: path name: projectsId @@ -27529,21 +32264,28 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookExecutionJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: - parameters: *ref_107 + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Incrementally update the dataset used for an examples model. - operationId: aiplatform.projects.locations.models.updateExplanationDataset - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27568,21 +32310,34 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Merges a set of aliases for a Model version. - operationId: aiplatform.projects.locations.models.mergeVersionAliases - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27594,7 +32349,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -27607,15 +32362,23 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Lists Models in a Location. - operationId: aiplatform.projects.locations.models.list + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27627,7 +32390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -27639,36 +32402,23 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: notebookRuntimeTemplatesId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: - parameters: *ref_107 delete: description: >- - Deletes a Model version. Model version can only be deleted if there are - no DeployedModels created from it. Deleting the only version in the - Model is not allowed. Use DeleteModel for deleting the Model instead. - operationId: aiplatform.projects.locations.models.deleteVersion + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27680,7 +32430,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -27693,20 +32443,22 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: - parameters: *ref_107 - post: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations: + parameters: *ref_1 + get: description: >- - 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. - operationId: aiplatform.projects.locations.models.testIamPermissions + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27718,7 +32470,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -27731,26 +32483,30 @@ paths: schema: type: string - in: path - name: modelsId + name: notebookRuntimeTemplatesId required: true schema: type: string - in: query - name: permissions + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: - parameters: *ref_107 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: + parameters: *ref_1 post: description: >- - Looks a study up using the user-defined display_name field instead of - the fully qualified resource name. - operationId: aiplatform.projects.locations.studies.lookup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27762,7 +32518,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -27774,11 +32530,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies: - parameters: *ref_107 - get: - description: Lists all the studies in a region for an associated project. - operationId: aiplatform.projects.locations.studies.list + - in: path + name: notebookRuntimeTemplatesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: + parameters: *ref_1 + delete: + description: Deletes a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27790,8 +32556,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -27803,25 +32568,20 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: notebookRuntimeTemplatesId + required: true schema: type: string - post: - description: >- - Creates a Study. A resource name will be generated after creation of the - Study. - operationId: aiplatform.projects.locations.studies.create + patch: + description: Updates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27833,7 +32593,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -27845,11 +32606,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: - parameters: *ref_107 + - in: path + name: notebookRuntimeTemplatesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Gets a Study by name. - operationId: aiplatform.projects.locations.studies.get + description: Gets a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27861,7 +32630,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate parameters: - in: path name: projectsId @@ -27874,13 +32644,21 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - delete: - description: Deletes a Study. - operationId: aiplatform.projects.locations.studies.delete + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: >- + aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27892,7 +32670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -27905,19 +32683,19 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.operations.delete + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: + parameters: *ref_1 + get: + description: Lists NotebookRuntimeTemplates in a Location. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27929,7 +32707,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse parameters: - in: path name: projectsId @@ -27941,22 +32720,37 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string - - in: path - name: operationsId - required: true + format: google-fieldmask + - in: query + name: orderBy schema: type: string - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.studies.operations.get + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a NotebookRuntimeTemplate. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -27980,23 +32774,23 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: notebookRuntimeTemplateId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: - parameters: *ref_107 - get: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.operations.list + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28008,7 +32802,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -28021,25 +32815,12 @@ paths: schema: type: string - in: path - name: studiesId + name: notebookRuntimeTemplatesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -28051,7 +32832,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.studies.operations.cancel + operationId: aiplatform.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28075,18 +32856,13 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -28098,7 +32874,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.studies.operations.wait + operationId: aiplatform.projects.locations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28122,11 +32898,6 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - in: path name: operationsId required: true @@ -28137,11 +32908,14 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a Trial. - operationId: aiplatform.projects.locations.studies.trials.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28153,7 +32927,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -28166,65 +32940,17 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: operationsId required: true schema: type: string delete: - description: Deletes a Trial. - operationId: aiplatform.projects.locations.studies.trials.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: - parameters: *ref_107 - post: description: >- - Lists the pareto-optimal Trials for multi-objective Study or the optimal - Trials for single-objective Study. The definition of pareto-optimal can - be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency - operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28236,8 +32962,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -28250,15 +32975,17 @@ paths: schema: type: string - in: path - name: studiesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 get: - description: Lists the Trials associated with a Study. - operationId: aiplatform.projects.locations.studies.trials.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28270,7 +32997,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -28282,11 +33009,6 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - in: query name: pageToken schema: @@ -28296,14 +33018,24 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Adds a user provided Trial to a Study. - operationId: aiplatform.projects.locations.studies.trials.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.schedules.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28315,7 +33047,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -28328,20 +33060,22 @@ paths: schema: type: string - in: path - name: studiesId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: - parameters: *ref_107 - post: - description: Marks a Trial as complete. - operationId: aiplatform.projects.locations.studies.trials.complete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.schedules.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28353,7 +33087,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -28366,25 +33100,32 @@ paths: schema: type: string - in: path - name: studiesId + name: schedulesId required: true schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: - parameters: *ref_107 - post: - description: Stops a Trial. - operationId: aiplatform.projects.locations.studies.trials.stop - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.schedules.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28396,7 +33137,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -28409,28 +33150,21 @@ paths: schema: type: string - in: path - name: studiesId + name: schedulesId required: true schema: type: string - in: path - name: trialsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: - parameters: *ref_107 - post: + get: description: >- - Adds a measurement of the objective metrics to a Trial. This measurement - is assumed to have been taken before the Trial is complete. - operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.schedules.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28442,7 +33176,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -28455,29 +33189,29 @@ paths: schema: type: string - in: path - name: studiesId + name: schedulesId required: true schema: type: string - in: path - name: trialsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- - Adds one or more Trials to a Study, with parameter values suggested by - Vertex AI Vizier. Returns a long-running operation associated with the - generation of Trial suggestions. When this long-running operation - succeeds, it will contain a SuggestTrialsResponse. - operationId: aiplatform.projects.locations.studies.trials.suggest - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.schedules.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28502,25 +33236,30 @@ paths: schema: type: string - in: path - name: studiesId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/schedules: + parameters: *ref_1 post: - description: >- - Checks whether a Trial should stop or not. Returns a long-running - operation. When the operation is successful, it will contain a - CheckTrialEarlyStoppingStateResponse. - operationId: >- - aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState + description: Creates a Schedule. + operationId: aiplatform.projects.locations.schedules.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28532,7 +33271,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -28544,25 +33283,9 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.trials.operations.delete + get: + description: Lists Schedules in a Location. + operationId: aiplatform.projects.locations.schedules.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28574,7 +33297,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse parameters: - in: path name: projectsId @@ -28586,27 +33310,28 @@ paths: required: true schema: type: string - - in: path - name: studiesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: trialsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: + parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.studies.trials.operations.get + description: Gets a Schedule. + operationId: aiplatform.projects.locations.schedules.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28618,7 +33343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -28631,27 +33356,23 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: - parameters: *ref_107 - get: + patch: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.studies.trials.operations.list + Updates an active or paused Schedule. When the Schedule is updated, new + runs will be scheduled starting from the updated next execution time + after the update time based on the time_specification in the updated + Schedule. All unstarted runs before the update time will be skipped + while already created runs will NOT be paused or canceled. + operationId: aiplatform.projects.locations.schedules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28663,7 +33384,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' parameters: - in: path name: projectsId @@ -28676,42 +33397,18 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId + name: schedulesId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.studies.trials.operations.wait + format: google-fieldmask + delete: + description: Deletes a Schedule. + operationId: aiplatform.projects.locations.schedules.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28736,39 +33433,23 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: schedulesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: + parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.studies.trials.operations.cancel + Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule + is paused, no new runs will be created. Already created runs will NOT be + paused or canceled. + operationId: aiplatform.projects.locations.schedules.pause + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28793,50 +33474,39 @@ paths: schema: type: string - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: trialsId - required: true - schema: - type: string - - in: path - name: operationsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: + parameters: *ref_1 post: description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict + Resumes a paused Schedule to start scheduling new runs. Will mark + Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When + the Schedule is resumed, new runs will be scheduled starting from the + next execution time after the current time based on the + time_specification in the Schedule. If Schedule.catchUp is set up true, + all missed runs will be scheduled for backfill first. + operationId: aiplatform.projects.locations.schedules.resume requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -28849,43 +33519,34 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: schedulesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/customJobs: + parameters: *ref_1 post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.publishers.models.generateContent + description: >- + Creates a CustomJob. A created CustomJob right away will be attempted to + be run. + operationId: aiplatform.projects.locations.customJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -28897,26 +33558,9 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: - parameters: *ref_107 - post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.publishers.models.countTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + get: + description: Lists CustomJobs in a Location. + operationId: aiplatform.projects.locations.customJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -28929,7 +33573,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse parameters: - in: path name: projectsId @@ -28941,43 +33585,41 @@ paths: required: true schema: type: string - - in: path - name: publishersId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask schema: type: string - - in: path - name: modelsId - required: true + format: google-fieldmask + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: - parameters: *ref_107 - post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.publishers.models.streamRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: + parameters: *ref_1 + get: + description: Gets a CustomJob. + operationId: aiplatform.projects.locations.customJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' parameters: - in: path name: projectsId @@ -28990,46 +33632,25 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: - parameters: *ref_107 - post: - description: >- - Perform an online prediction with an arbitrary HTTP payload. The - response includes the following HTTP headers: * - `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this - prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's - DeployedModel that served this prediction. - operationId: aiplatform.projects.locations.publishers.models.rawPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + delete: + description: Deletes a CustomJob. + operationId: aiplatform.projects.locations.customJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29042,90 +33663,83 @@ paths: schema: type: string - in: path - name: publishersId - required: true - schema: - type: string - - in: path - name: modelsId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: + parameters: *ref_1 post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent + description: >- + Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. + The server makes a best effort to cancel the job, but success is not + guaranteed. Clients can use JobService.GetCustomJob or other methods to + check whether the cancellation succeeded or whether the job completed + despite cancellation. On successful cancellation, the CustomJob is not + deleted; instead it becomes a job with a CustomJob.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and + CustomJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.customJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: projectsId required: true schema: type: string - in: path - name: publishersId + name: locationsId required: true schema: type: string - in: path - name: modelsId + name: customJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.publishers.models.predict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.customJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29138,25 +33752,28 @@ paths: schema: type: string - in: path - name: publishersId + name: customJobsId required: true schema: type: string - in: path - name: modelsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: - parameters: *ref_107 - post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.projects.locations.publishers.models.computeTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.customJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29168,8 +33785,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29182,24 +33798,22 @@ paths: schema: type: string - in: path - name: publishersId + name: customJobsId required: true schema: type: string - in: path - name: modelsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: - parameters: *ref_107 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.delete + operationId: aiplatform.projects.locations.customJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29224,7 +33838,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: customJobsId required: true schema: type: string @@ -29233,12 +33847,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.indexEndpoints.operations.get + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.customJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29250,7 +33872,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29263,7 +33885,7 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: customJobsId required: true schema: type: string @@ -29272,20 +33894,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: + parameters: *ref_1 + get: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.indexEndpoints.operations.wait + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.customJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29297,7 +33912,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29310,34 +33925,42 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: customJobsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: timeout + name: filter schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: + parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.cancel + Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. + The server makes a best effort to cancel the job, but success is not + guaranteed. Clients can use GenAiTuningService.GetTuningJob or other + methods to check whether the cancellation succeeded or whether the job + completed despite cancellation. On successful cancellation, the + TuningJob is not deleted; instead it becomes a job with a + TuningJob.error value with a google.rpc.Status.code of 1, corresponding + to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.tuningJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29362,22 +33985,15 @@ paths: schema: type: string - in: path - name: indexEndpointsId - required: true - schema: - type: string - - in: path - name: operationsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexEndpoints.operations.list + description: Lists TuningJobs in a Location. + operationId: aiplatform.projects.locations.tuningJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29389,7 +34005,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse parameters: - in: path name: projectsId @@ -29401,11 +34018,6 @@ paths: required: true schema: type: string - - in: path - name: indexEndpointsId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -29419,16 +34031,16 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: - parameters: *ref_107 post: - description: Update an existing DeployedIndex under an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex + description: >- + Creates a TuningJob. A created TuningJob right away will be attempted to + be run. + operationId: aiplatform.projects.locations.tuningJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29440,7 +34052,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: + parameters: *ref_1 + get: + description: Gets a TuningJob. + operationId: aiplatform.projects.locations.tuningJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' parameters: - in: path name: projectsId @@ -29453,22 +34093,18 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from - it, and freeing all resources it's using. - operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.tuningJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29493,15 +34129,29 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tuningJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: - parameters: *ref_107 - delete: - description: Deletes an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.delete + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.tuningJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29513,7 +34163,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29526,18 +34176,22 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tuningJobsId required: true schema: type: string - patch: - description: Updates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tuningJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29549,7 +34203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29562,18 +34216,28 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: tuningJobsId required: true schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: + parameters: *ref_1 get: - description: Gets an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.get + description: Lists SavedQueries in a Dataset. + operationId: aiplatform.projects.locations.datasets.savedQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29585,7 +34249,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse parameters: - in: path name: projectsId @@ -29598,23 +34263,37 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: - parameters: *ref_107 - post: - description: >- - Reads the datapoints/vectors of the given IDs. A maximum of 1000 - datapoints can be retrieved in a batch. - operationId: aiplatform.projects.locations.indexEndpoints.readIndexDatapoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsRequest + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: + parameters: *ref_1 + delete: + description: Deletes a SavedQuery. + operationId: aiplatform.projects.locations.datasets.savedQueries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29626,8 +34305,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29640,15 +34318,29 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: - parameters: *ref_107 - get: - description: Lists IndexEndpoints in a Location. - operationId: aiplatform.projects.locations.indexEndpoints.list + - in: path + name: savedQueriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29660,8 +34352,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29673,32 +34364,30 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: datasetsId + required: true schema: type: string - - in: query - name: readMask + - in: path + name: savedQueriesId + required: true schema: type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - post: - description: Creates an IndexEndpoint. - operationId: aiplatform.projects.locations.indexEndpoints.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29710,7 +34399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29722,16 +34411,27 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: - parameters: *ref_107 - post: - description: Finds the nearest neighbors of each vector within the request. - operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: savedQueriesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29743,8 +34443,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29757,22 +34456,27 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: - parameters: *ref_107 - post: + - in: path + name: savedQueriesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: + parameters: *ref_1 + get: description: >- - Deploys an Index into this IndexEndpoint, creating a DeployedIndex - within it. Only non-empty Indexes can be deployed. - operationId: aiplatform.projects.locations.indexEndpoints.deployIndex - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29784,7 +34488,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -29797,20 +34501,42 @@ paths: schema: type: string - in: path - name: indexEndpointsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: - parameters: *ref_107 - delete: + - in: path + name: savedQueriesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29822,7 +34548,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -29835,32 +34561,33 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: savedQueriesId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.get + operationId: aiplatform.projects.locations.datasets.dataItems.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29885,17 +34612,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string - in: path - name: runsId + name: dataItemsId required: true schema: type: string @@ -29904,14 +34626,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: - parameters: *ref_107 - get: + delete: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.list + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -29923,7 +34644,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -29936,35 +34657,22 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -29976,8 +34684,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait + operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30002,17 +34709,12 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string - in: path - name: runsId + name: dataItemsId required: true schema: type: string @@ -30026,21 +34728,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30052,7 +34746,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -30065,31 +34759,42 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - - in: path - name: runsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: - parameters: *ref_107 - delete: - description: Deletes a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30101,7 +34806,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30114,38 +34819,33 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string - in: path - name: runsId + name: dataItemsId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: + parameters: *ref_1 get: - description: Gets a TensorboardTimeSeries. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get + description: >- + Lists Annotations belongs to a dataitem This RPC is only available in + InternalDatasetService. It is only used for exporting conversation data + to CCAI Insights. + operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -30153,7 +34853,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse parameters: - in: path name: projectsId @@ -30166,35 +34866,45 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - - in: path - name: runsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: timeSeriesId - required: true + format: google-fieldmask + - in: query + name: pageToken schema: type: string - patch: - description: Updates a TensorboardTimeSeries. + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + aiplatform.projects.locations.datasets.dataItems.annotations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30206,8 +34916,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -30220,42 +34929,48 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - in: path - name: runsId + name: annotationsId required: true schema: type: string - - in: path - name: timeSeriesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Creates a TensorboardTimeSeries. + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30267,8 +34982,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30281,45 +34995,52 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - in: path - name: runsId + name: annotationsId required: true schema: type: string - - in: query - name: tensorboardTimeSeriesId + - in: path + name: operationsId + required: true schema: type: string - get: - description: Lists TensorboardTimeSeries in a Location. + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list + aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30332,68 +35053,52 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - in: path - name: runsId + name: annotationsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: - parameters: *ref_107 - get: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: + parameters: *ref_1 + delete: description: >- - Gets bytes of TensorboardBlobs. This is to allow reading blob data - stored in consumer project's Cloud Storage bucket without users having - to obtain Cloud Storage access permission. + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData + aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30406,57 +35111,44 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - in: path - name: runsId + name: annotationsId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string - - in: query - name: blobIds - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: - parameters: *ref_107 get: description: >- - Reads a TensorboardTimeSeries' data. By default, if the number of data - points stored is less than 1000, all data is returned. Otherwise, 1000 - data points is randomly selected from this time series and returned. - This value can be changed by changing max_data_points, which can't be - greater than 10k. + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read + aiplatform.projects.locations.datasets.dataItems.annotations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30469,48 +35161,30 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: dataItemsId required: true schema: type: string - in: path - name: runsId + name: annotationsId required: true schema: type: string - in: path - name: timeSeriesId + name: operationsId required: true schema: type: string - - in: query - name: maxDataPoints - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: - parameters: *ref_107 - post: - description: >- - Exports a TensorboardTimeSeries' data. Data is returned in paginated - responses. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: + parameters: *ref_1 + get: + description: Lists DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.dataItems.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30523,7 +35197,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse + #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse parameters: - in: path name: projectsId @@ -30536,33 +35210,39 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: runsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: timeSeriesId - required: true + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: - parameters: *ref_107 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list + operationId: aiplatform.projects.locations.datasets.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30587,31 +35267,16 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: datasetsId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -30619,16 +35284,14 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: - parameters: *ref_107 - delete: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.datasets.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30640,7 +35303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30653,22 +35316,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: datasetsId required: true schema: type: string @@ -30677,53 +35325,38 @@ paths: required: true schema: type: string - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: tensorboardsId - required: true - schema: - type: string + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: experimentsId + name: projectsId required: true schema: type: string - in: path - name: runsId + name: locationsId required: true schema: type: string - in: path - name: timeSeriesId + name: datasetsId required: true schema: type: string @@ -30732,8 +35365,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -30745,8 +35378,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait + operationId: aiplatform.projects.locations.datasets.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30771,22 +35403,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: datasetsId required: true schema: type: string @@ -30800,8 +35417,8 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -30813,8 +35430,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel + operationId: aiplatform.projects.locations.datasets.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30839,22 +35455,7 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: runsId - required: true - schema: - type: string - - in: path - name: timeSeriesId + name: datasetsId required: true schema: type: string @@ -30863,27 +35464,26 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30896,23 +35496,27 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: annotationSpecsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string delete: - description: Deletes a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30924,7 +35528,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -30937,28 +35541,34 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: annotationSpecsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - patch: - description: Updates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -30970,7 +35580,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -30983,38 +35593,39 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: annotationSpecsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: - parameters: *ref_107 + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- - Write time series data points into multiple TensorboardTimeSeries under - a TensorboardRun. If any data fail to be ingested, an error is returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31026,8 +35637,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31040,42 +35650,39 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: annotationSpecsId required: true schema: type: string - in: path - name: runsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: + parameters: *ref_1 get: - description: Lists TensorboardRuns in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -31088,12 +35695,12 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: annotationSpecsId required: true schema: type: string @@ -31102,31 +35709,19 @@ paths: schema: type: integer format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - post: - description: Creates a TensorboardRun. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: + parameters: *ref_1 + get: + description: Gets an AnnotationSpec. + operationId: aiplatform.projects.locations.datasets.annotationSpecs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31138,7 +35733,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' + $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' parameters: - in: path name: projectsId @@ -31151,30 +35746,25 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: annotationSpecsId required: true schema: type: string - in: query - name: tensorboardRunId + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: - parameters: *ref_107 - post: - description: Batch create TensorboardRuns. - operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: + parameters: *ref_1 + delete: + description: Deletes a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31186,8 +35776,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31200,29 +35789,18 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: datasetVersionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait + get: + description: Gets a Dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31234,7 +35812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -31247,32 +35825,28 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list + format: google-fieldmask + patch: + description: Updates a DatasetVersion. + operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31284,7 +35858,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' parameters: - in: path name: projectsId @@ -31297,17 +35871,52 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: path - name: experimentsId + name: datasetVersionsId required: true schema: type: string - in: query - name: pageToken + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: + parameters: *ref_1 + get: + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true schema: type: string - in: query @@ -31315,19 +35924,31 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete + - in: query + name: orderBy + schema: + type: string + post: + description: Create a version from a Dataset. + operationId: aiplatform.projects.locations.datasets.datasetVersions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31339,7 +35960,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31352,26 +35973,15 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId - required: true - schema: - type: string - - in: path - name: operationsId + name: datasetsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get + description: Restores a dataset version. + operationId: aiplatform.projects.locations.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31396,34 +36006,25 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets: + parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel + description: Creates a Dataset. + operationId: aiplatform.projects.locations.datasets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31435,7 +36036,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31447,43 +36048,72 @@ paths: required: true schema: type: string + get: + description: Lists Datasets in a Location. + operationId: aiplatform.projects.locations.datasets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + parameters: - in: path - name: tensorboardsId + name: projectsId required: true schema: type: string - in: path - name: experimentsId + name: locationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: - parameters: *ref_107 + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: + parameters: *ref_1 get: - description: Gets a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.get + description: Gets a Dataset. + operationId: aiplatform.projects.locations.datasets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -31496,24 +36126,18 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: readMask schema: type: string - patch: - description: Updates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + format: google-fieldmask + delete: + description: Deletes a Dataset. + operationId: aiplatform.projects.locations.datasets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31525,8 +36149,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31539,23 +36162,18 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.delete + patch: + description: Updates a Dataset. + operationId: aiplatform.projects.locations.datasets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31567,7 +36185,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' parameters: - in: path name: projectsId @@ -31580,28 +36198,25 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - - in: path - name: experimentsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: - parameters: *ref_107 + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: + parameters: *ref_1 post: - description: >- - Batch create TensorboardTimeSeries that belong to a - TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate + description: Exports data from a Dataset. + operationId: aiplatform.projects.locations.datasets.export requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31613,8 +36228,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31627,29 +36241,20 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: + parameters: *ref_1 get: - description: Lists TensorboardExperiments in a Location. - operationId: aiplatform.projects.locations.tensorboards.experiments.list + description: Searches DataItems in a Dataset. + operationId: aiplatform.projects.locations.datasets.searchDataItems security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -31657,7 +36262,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse + #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse parameters: - in: path name: projectsId @@ -31670,12 +36275,12 @@ paths: schema: type: string - in: path - name: tensorboardsId + name: datasetsId required: true schema: type: string - in: query - name: filter + name: orderByDataItem schema: type: string - in: query @@ -31683,75 +36288,62 @@ paths: schema: type: string - in: query - name: pageSize + name: orderByAnnotation.orderBy schema: - type: integer - format: int32 + type: string - in: query - name: readMask + name: dataItemFilter + schema: + type: string + - in: query + name: orderByAnnotation.savedQuery schema: type: string - format: google-fieldmask + - in: query + name: annotationFilters + schema: + type: string + - in: query + name: annotationsLimit + schema: + type: integer + format: int32 - in: query name: pageToken schema: type: string - post: - description: Creates a TensorboardExperiment. - operationId: aiplatform.projects.locations.tensorboards.experiments.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment - parameters: - - in: path - name: projectsId - required: true + - in: query + name: savedQuery schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: fieldMask schema: type: string - - in: path - name: tensorboardsId - required: true + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: annotationsFilter schema: type: string - in: query - name: tensorboardExperimentId + name: dataLabelingJob schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: + parameters: *ref_1 post: - description: >- - Write time series data points of multiple TensorboardTimeSeries in - multiple TensorboardRun's. If any data fail to be ingested, an error is - returned. - operationId: aiplatform.projects.locations.tensorboards.experiments.write + description: Imports data into a Dataset. + operationId: aiplatform.projects.locations.datasets.import requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31763,8 +36355,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31777,23 +36368,19 @@ paths: schema: type: string - in: path - name: tensorboardsId - required: true - schema: - type: string - - in: path - name: experimentsId + name: datasetsId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}: - parameters: *ref_107 - get: + parameters: *ref_1 + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.tensorboards.operations.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.tensorboards.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31805,7 +36392,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31827,13 +36414,12 @@ paths: required: true schema: type: string - delete: + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tensorboards.operations.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.tensorboards.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31845,7 +36431,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -31867,20 +36453,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.tensorboards.operations.wait + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.tensorboards.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31892,7 +36478,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -31914,13 +36500,8 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations: - parameters: *ref_107 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -31954,10 +36535,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: @@ -31967,20 +36544,24 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.tensorboards.operations.cancel + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.tensorboards.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -31992,7 +36573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32014,16 +36595,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: - parameters: *ref_107 - get: - description: >- - Reads multiple TensorboardTimeSeries' data. The data point number limit - is 1000 for scalars, 100 for tensors and blob references. If the number - of data points stored is less than the limit, all data is returned. - Otherwise, the number limit of data points is randomly selected from - this time series and returned. - operationId: aiplatform.projects.locations.tensorboards.batchRead + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate: + parameters: *ref_1 + post: + description: Batch create TensorboardRuns. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32036,7 +36623,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse parameters: - in: path name: projectsId @@ -32053,46 +36640,16 @@ paths: required: true schema: type: string - - in: query - name: timeSeries - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: - parameters: *ref_107 - post: - description: Creates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: experimentsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}: + parameters: *ref_1 get: - description: Lists Tensorboards in a Location. - operationId: aiplatform.projects.locations.tensorboards.list + description: Gets a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32108,8 +36665,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -32121,67 +36677,24 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: - parameters: *ref_107 - get: - description: Returns a list of monthly active users for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readUsage - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse - parameters: - in: path - name: projectsId + name: tensorboardsId required: true schema: type: string - in: path - name: locationsId + name: experimentsId required: true schema: type: string - in: path - name: tensorboardsId + name: runsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: - parameters: *ref_107 delete: - description: Deletes a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.delete + description: Deletes a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32210,49 +36723,24 @@ paths: required: true schema: type: string - get: - description: Gets a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: experimentsId required: true schema: type: string - in: path - name: tensorboardsId + name: runsId required: true schema: type: string patch: - description: Updates a Tensorboard. - operationId: aiplatform.projects.locations.tensorboards.patch + description: Updates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32264,7 +36752,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -32281,59 +36769,34 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: - parameters: *ref_107 - get: - description: Returns the storage size for a given TensorBoard instance. - operationId: aiplatform.projects.locations.tensorboards.readSize - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - - in: path - name: tensorboardsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait: - parameters: *ref_107 + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write: + parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.persistentResources.operations.wait + Write time series data points into multiple TensorboardTimeSeries under + a TensorboardRun. If any data fail to be ingested, an error is returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.write + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32345,7 +36808,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardRunDataResponse parameters: - in: path name: projectsId @@ -32358,46 +36822,42 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: runsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.persistentResources.operations.cancel + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs: + parameters: *ref_1 + get: + description: Lists TensorboardRuns in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardRunsResponse parameters: - in: path name: projectsId @@ -32410,52 +36870,17 @@ paths: schema: type: string - in: path - name: persistentResourcesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.persistentResources.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: tensorboardsId required: true schema: type: string - in: path - name: persistentResourcesId + name: experimentsId required: true schema: type: string - in: query - name: filter + name: orderBy schema: type: string - in: query @@ -32463,19 +36888,27 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.persistentResources.operations.delete + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + post: + description: Creates a TensorboardRun. + operationId: aiplatform.projects.locations.tensorboards.experiments.runs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32487,7 +36920,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TensorboardRun' parameters: - in: path name: projectsId @@ -32500,21 +36933,28 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string + - in: query + name: tensorboardRunId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.persistentResources.operations.get + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32539,7 +36979,17 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string @@ -32548,11 +36998,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}: - parameters: *ref_107 - get: - description: Gets a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.get + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32564,7 +37017,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32577,54 +37030,40 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: tensorboardsId required: true schema: type: string - patch: - description: Updates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: persistentResourcesId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.delete + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32649,50 +37088,45 @@ paths: schema: type: string - in: path - name: persistentResourcesId + name: tensorboardsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources: - parameters: *ref_107 - post: - description: Creates a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PersistentResource' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: persistentResourceId + name: timeout schema: type: string - get: - description: Lists PersistentResources in a Location. - operationId: aiplatform.projects.locations.persistentResources.list + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32704,8 +37138,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPersistentResourcesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32717,61 +37150,34 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: tensorboardsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot: - parameters: *ref_107 - post: - description: Reboots a PersistentResource. - operationId: aiplatform.projects.locations.persistentResources.reboot - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RebootPersistentResourceRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: persistentResourcesId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32796,12 +37202,18 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: tensorboardsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true schema: type: string - in: query @@ -32813,20 +37225,19 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32838,7 +37249,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -32851,7 +37262,22 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId required: true schema: type: string @@ -32860,15 +37286,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: - parameters: *ref_107 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32893,7 +37318,22 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId required: true schema: type: string @@ -32902,12 +37342,21 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32919,7 +37368,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -32932,7 +37381,22 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId required: true schema: type: string @@ -32941,8 +37405,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -32954,7 +37418,8 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -32979,95 +37444,43 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId - required: true - schema: - type: string - - in: path - name: operationsId + name: tensorboardsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: - parameters: *ref_107 - post: - description: Create a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - get: - description: List DeploymentResourcePools in a location. - operationId: aiplatform.projects.locations.deploymentResourcePools.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse - parameters: - in: path - name: projectsId + name: timeSeriesId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string - in: query - name: pageToken + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: - parameters: *ref_107 - delete: - description: Delete a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.delete + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33079,7 +37492,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -33092,55 +37505,58 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: tensorboardsId required: true schema: type: string - get: - description: Get a DeploymentResourcePool. - operationId: aiplatform.projects.locations.deploymentResourcePools.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: deploymentResourcePoolsId + name: timeSeriesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: - parameters: *ref_107 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read: + parameters: *ref_1 get: description: >- - List DeployedModels that have been deployed on this - DeploymentResourcePool. + Reads a TensorboardTimeSeries' data. By default, if the number of data + points stored is less than 1000, all data is returned. Otherwise, 1000 + data points is randomly selected from this time series and returned. + This value can be changed by changing max_data_points, which can't be + greater than 10k. operationId: >- - aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -33148,7 +37564,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -33161,79 +37577,57 @@ paths: schema: type: string - in: path - name: deploymentResourcePoolsId + name: tensorboardsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - in: path - name: projectsId + name: experimentsId required: true schema: type: string - in: path - name: locationsId + name: runsId required: true schema: type: string - in: path - name: featurestoresId + name: timeSeriesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string + - in: query + name: maxDataPoints + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}: + parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featurestores.operations.get + description: Gets a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -33246,29 +37640,35 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.featurestores.operations.cancel + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + patch: + description: Updates a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33280,7 +37680,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -33293,29 +37694,34 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featurestores.operations.wait + - in: path + name: runsId + required: true + schema: + type: string + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a TensorboardTimeSeries. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33340,39 +37746,48 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: runsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: - parameters: *ref_107 + - in: path + name: timeSeriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.operations.list + description: Lists TensorboardTimeSeries in a Location. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -33385,33 +37800,52 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId + required: true + schema: + type: string + - in: path + name: experimentsId + required: true + schema: + type: string + - in: path + name: runsId required: true schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. + post: + description: Creates a TensorboardTimeSeries. operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.delete + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33423,7 +37857,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardTimeSeries parameters: - in: path name: projectsId @@ -33436,38 +37871,50 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: experimentsId required: true schema: type: string - in: path - name: operationsId + name: runsId required: true schema: type: string + - in: query + name: tensorboardTimeSeriesId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData: + parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get + Gets bytes of TensorboardBlobs. This is to allow reading blob data + stored in consumer project's Cloud Storage bucket without users having + to obtain Cloud Storage access permission. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse parameters: - in: path name: projectsId @@ -33480,34 +37927,43 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: experimentsId required: true schema: type: string - in: path - name: operationsId + name: runsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: - parameters: *ref_107 + - in: path + name: timeSeriesId + required: true + schema: + type: string + - in: query + name: blobIds + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries: + parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait + Exports a TensorboardTimeSeries' data. Data is returned in paginated + responses. + operationId: >- + aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33519,7 +37975,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse parameters: - in: path name: projectsId @@ -33532,32 +37989,32 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: experimentsId required: true schema: type: string - in: path - name: operationsId + name: runsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: timeSeriesId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33582,12 +38039,12 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: experimentsId required: true schema: type: string @@ -33596,82 +38053,22 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.operations.cancel - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33683,7 +38080,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -33696,17 +38093,12 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string - in: path - name: featuresId + name: experimentsId required: true schema: type: string @@ -33715,16 +38107,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: - parameters: *ref_107 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33749,17 +38138,12 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string - in: path - name: featuresId + name: experimentsId required: true schema: type: string @@ -33768,13 +38152,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.get + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33799,33 +38190,39 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: experimentsId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: - parameters: *ref_107 - get: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.list + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.tensorboards.experiments.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33837,7 +38234,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -33850,48 +38247,31 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: experimentsId required: true schema: type: string - in: path - name: featuresId + name: operationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}: + parameters: *ref_1 + patch: + description: Updates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -33903,7 +38283,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -33916,52 +38297,40 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - - in: path - name: featuresId + name: tensorboardsId required: true schema: type: string - in: path - name: operationsId + name: experimentsId required: true schema: type: string - in: query - name: timeout + name: updateMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: - parameters: *ref_107 - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + format: google-fieldmask + get: + description: Gets a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -33974,28 +38343,18 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string - in: path - name: featuresId + name: experimentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete + description: Deletes a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34020,23 +38379,28 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string - in: path - name: featuresId + name: experimentsId required: true schema: type: string - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate: + parameters: *ref_1 + post: + description: >- + Batch create TensorboardTimeSeries that belong to a + TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34048,7 +38412,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse parameters: - in: path name: projectsId @@ -34061,30 +38426,26 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string - in: path - name: featuresId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments: + parameters: *ref_1 post: - description: Creates a new Feature in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create + description: Creates a TensorboardExperiment. + operationId: aiplatform.projects.locations.tensorboards.experiments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34096,7 +38457,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1TensorboardExperiment parameters: - in: path name: projectsId @@ -34109,27 +38471,26 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string - in: query - name: featureId + name: tensorboardExperimentId schema: type: string get: - description: Lists Features in a given EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list + description: Lists TensorboardExperiments in a Location. + operationId: aiplatform.projects.locations.tensorboards.experiments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -34137,7 +38498,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardExperimentsResponse parameters: - in: path name: projectsId @@ -34150,12 +38511,7 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string @@ -34176,28 +38532,25 @@ paths: name: filter schema: type: string - - in: query - name: latestStatsCount - schema: - type: integer - format: int32 - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write: + parameters: *ref_1 post: - description: Creates a batch of Features in a given EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate + description: >- + Write time series data points of multiple TensorboardTimeSeries in + multiple TensorboardRun's. If any data fail to be ingested, an error is + returned. + operationId: aiplatform.projects.locations.tensorboards.experiments.write requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34209,7 +38562,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse parameters: - in: path name: projectsId @@ -34222,27 +38576,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - in: path - name: entityTypesId + name: experimentsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: - parameters: *ref_107 - post: - description: Exports Feature values from all the entities of a target EntityType. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}: + parameters: *ref_1 + patch: + description: Updates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34267,20 +38619,18 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: - parameters: *ref_107 - get: - description: Gets details of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.get + format: google-fieldmask + delete: + description: Deletes a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34292,7 +38642,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34305,32 +38655,29 @@ paths: schema: type: string - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId + name: tensorboardsId required: true schema: type: string - delete: - description: >- - Deletes a single EntityType. The EntityType must not have any Features - or `force` must be set to true for the request to succeed. - operationId: aiplatform.projects.locations.featurestores.entityTypes.delete + get: + description: Gets a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' parameters: - in: path name: projectsId @@ -34343,27 +38690,73 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards: + parameters: *ref_1 + get: + description: Lists Tensorboards in a Location. + operationId: aiplatform.projects.locations.tensorboards.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTensorboardsResponse + parameters: - in: path - name: entityTypesId + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string - in: query - name: force + name: pageToken schema: - type: boolean - patch: - description: Updates the parameters of a single EntityType. - operationId: aiplatform.projects.locations.featurestores.entityTypes.patch + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + post: + description: Creates a Tensorboard. + operationId: aiplatform.projects.locations.tensorboards.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Tensorboard' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34375,7 +38768,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -34387,32 +38780,54 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead: + parameters: *ref_1 + get: + description: >- + Reads multiple TensorboardTimeSeries' data. The data point number limit + is 1000 for scalars, 100 for tensors and blob references. If the number + of data points stored is less than the limit, all data is returned. + Otherwise, the number limit of data points is randomly selected from + this time series and returned. + operationId: aiplatform.projects.locations.tensorboards.batchRead + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse + parameters: - in: path - name: featurestoresId + name: projectsId required: true schema: type: string - in: path - name: entityTypesId + name: locationsId + required: true + schema: + type: string + - in: path + name: tensorboardsId required: true schema: type: string - in: query - name: updateMask + name: timeSeries schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: - parameters: *ref_107 - post: - description: >- - 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. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage: + parameters: *ref_1 + get: + description: Returns a list of monthly active users for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readUsage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34424,7 +38839,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardUsageResponse parameters: - in: path name: projectsId @@ -34437,57 +38853,74 @@ paths: schema: type: string - in: path - name: featurestoresId + name: tensorboardsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize: + parameters: *ref_1 + get: + description: Returns the storage size for a given TensorBoard instance. + operationId: aiplatform.projects.locations.tensorboards.readSize + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadTensorboardSizeResponse + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: entityTypesId + name: locationsId required: true schema: type: string - - in: query - name: permissions + - in: path + name: tensorboardsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict: + parameters: *ref_1 post: description: >- - Imports Feature values into the Featurestore from a source storage. The - progress of the import is tracked by the returned operation. The - imported features are guaranteed to be visible to subsequent read - operations after the operation is marked as successfully done. If an - import operation fails, the Feature values returned from reads and - exports may be inconsistent. If consistency is required, the caller must - retry the same import request again and wait till the new operation - returned is marked as successfully done. There are also scenarios where - the caller can cause inconsistency. - Source data for import contains - multiple distinct Feature values for the same entity ID and timestamp. - - Source is modified during an import. This includes adding, updating, or - removing source data and/or metadata. Examples of updating metadata - include but are not limited to changing storage location, storage class, - or retention policy. - Online serving cluster is under-provisioned. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues + Perform a server-side streaming online prediction request for Vertex LLM + streaming. + operationId: aiplatform.projects.locations.publishers.models.serverStreamingPredict requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse parameters: - in: path name: projectsId @@ -34500,30 +38933,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: publishersId required: true schema: type: string - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens: + parameters: *ref_1 post: - description: >- - Reads Feature values of a specific entity of an EntityType. For reading - feature values of multiple entities of an EntityType, please use - StreamingReadFeatureValues. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues + description: Perform a token counting. + operationId: aiplatform.projects.locations.publishers.models.countTokens requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34536,7 +38964,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path name: projectsId @@ -34549,34 +38977,41 @@ paths: schema: type: string - in: path - name: featurestoresId + name: publishersId required: true schema: type: string - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict: + parameters: *ref_1 post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy + description: Perform an online prediction. + operationId: aiplatform.projects.locations.publishers.models.predict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' parameters: - in: path name: projectsId @@ -34589,39 +39024,35 @@ paths: schema: type: string - in: path - name: featurestoresId + name: publishersId required: true schema: type: string - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent: + parameters: *ref_1 post: - description: >- - Reads Feature values for multiple entities. Depending on their size, - data for different entities may be broken up across multiple responses. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.projects.locations.publishers.models.streamGenerateContent requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -34629,7 +39060,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path name: projectsId @@ -34642,37 +39073,42 @@ paths: schema: type: string - in: path - name: featurestoresId + name: publishersId required: true schema: type: string - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict: + parameters: *ref_1 post: - description: Creates a new EntityType in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.create + description: Perform a streaming online prediction with an arbitrary HTTP payload. + operationId: aiplatform.projects.locations.publishers.models.streamRawPredict requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -34685,30 +39121,46 @@ paths: schema: type: string - in: path - name: featurestoresId + name: publishersId required: true schema: type: string - - in: query - name: entityTypeId + - in: path + name: modelsId + required: true schema: type: string - get: - description: Lists EntityTypes in a given Featurestore. - operationId: aiplatform.projects.locations.featurestores.entityTypes.list + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict: + parameters: *ref_1 + post: + description: >- + Perform an online prediction with an arbitrary HTTP payload. The + response includes the following HTTP headers: * + `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this + prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + DeployedModel that served this prediction. + operationId: aiplatform.projects.locations.publishers.models.rawPredict + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: projectsId @@ -34721,45 +39173,25 @@ paths: schema: type: string - in: path - name: featurestoresId + name: publishersId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: modelsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens: + parameters: *ref_1 post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy + description: Return a list of tokens based on the input text. + operationId: aiplatform.projects.locations.publishers.models.computeTokens requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34771,7 +39203,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path name: projectsId @@ -34784,31 +39217,69 @@ paths: schema: type: string - in: path - name: featurestoresId + name: publishersId required: true schema: type: string - in: path - name: entityTypesId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent: + parameters: *ref_1 post: - description: >- - Writes Feature values of one or more entities of an EntityType. The - Feature values are merged into existing entities if any. The Feature - values to be written must have timestamp within the online storage - retention. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues + description: Generate content with multimodal inputs. + operationId: aiplatform.projects.locations.publishers.models.generateContent requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: publishersId + required: true + schema: + type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: + parameters: *ref_1 + get: + description: Lists BatchPredictionJobs in a Location. + operationId: aiplatform.projects.locations.batchPredictionJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34821,7 +39292,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse + #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse parameters: - in: path name: projectsId @@ -34833,36 +39304,34 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: entityTypesId - required: true + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: - parameters: *ref_107 post: description: >- - Delete Feature values from Featurestore. The progress of the deletion is - tracked by the returned operation. The deleted feature values are - guaranteed to be invisible to subsequent read operations after the - operation is marked as successfully done. If a delete feature values - operation fails, the feature values returned from reads and exports may - be inconsistent. If consistency is required, the caller must retry the - same delete request again and wait till the new operation returned is - marked as successfully done. - operationId: >- - aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues + Creates a BatchPredictionJob. A BatchPredictionJob once created will + right away be attempted to start. + operationId: aiplatform.projects.locations.batchPredictionJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34874,7 +39343,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -34886,26 +39355,11 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - - in: path - name: entityTypesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: - parameters: *ref_107 - post: - description: >- - 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. - operationId: aiplatform.projects.locations.featurestores.testIamPermissions + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: + parameters: *ref_1 + get: + description: Gets a BatchPredictionJob + operationId: aiplatform.projects.locations.batchPredictionJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34917,7 +39371,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' parameters: - in: path name: projectsId @@ -34930,21 +39384,15 @@ paths: schema: type: string - in: path - name: featurestoresId + name: batchPredictionJobsId required: true schema: type: string - - in: query - name: permissions - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: - parameters: *ref_107 delete: description: >- - Deletes a single Featurestore. The Featurestore must not contain any - EntityTypes or `force` must be set to true for the request to succeed. - operationId: aiplatform.projects.locations.featurestores.delete + Deletes a BatchPredictionJob. Can only be called on jobs that already + finished. + operationId: aiplatform.projects.locations.batchPredictionJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34969,17 +39417,29 @@ paths: schema: type: string - in: path - name: featurestoresId + name: batchPredictionJobsId required: true schema: type: string - - in: query - name: force - schema: - type: boolean - get: - description: Gets details of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.get + /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: + parameters: *ref_1 + post: + description: >- + Cancels a BatchPredictionJob. Starts asynchronous cancellation on the + BatchPredictionJob. The server makes the best effort to cancel the job, + but success is not guaranteed. Clients can use + JobService.GetBatchPredictionJob or other methods to check whether the + cancellation succeeded or whether the job completed despite + cancellation. On a successful cancellation, the BatchPredictionJob is + not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. + Any files already outputted by the job are not deleted. + operationId: aiplatform.projects.locations.batchPredictionJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -34991,7 +39451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35004,18 +39464,24 @@ paths: schema: type: string - in: path - name: featurestoresId + name: batchPredictionJobsId required: true schema: type: string - patch: - description: Updates the parameters of a single Featurestore. - operationId: aiplatform.projects.locations.featurestores.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.trainingPipelines.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35040,20 +39506,29 @@ paths: schema: type: string - in: path - name: featurestoresId + name: trainingPipelinesId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: - parameters: *ref_107 - get: - description: Searches Features matching a query in a given project. - operationId: aiplatform.projects.locations.featurestores.searchFeatures + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35065,8 +39540,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35078,29 +39552,22 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: trainingPipelinesId + required: true schema: type: string - - in: query - name: query + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores: - parameters: *ref_107 - post: - description: Creates a new Featurestore in a given project and location. - operationId: aiplatform.projects.locations.featurestores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.trainingPipelines.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35124,13 +39591,23 @@ paths: required: true schema: type: string - - in: query - name: featurestoreId + - in: path + name: trainingPipelinesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations: + parameters: *ref_1 get: - description: Lists Featurestores in a given project and location. - operationId: aiplatform.projects.locations.featurestores.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35142,8 +39619,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35155,35 +39631,38 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: trainingPipelinesId + required: true schema: type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query name: pageToken schema: type: string - - in: query - name: orderBy - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.featurestores.getIamPolicy + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.trainingPipelines.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35195,7 +39674,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35208,28 +39687,20 @@ paths: schema: type: string - in: path - name: featurestoresId + name: trainingPipelinesId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: - parameters: *ref_107 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.featurestores.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + type: string + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines: + parameters: *ref_1 + get: + description: Lists TrainingPipelines in a Location. + operationId: aiplatform.projects.locations.trainingPipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35241,7 +39712,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListTrainingPipelinesResponse parameters: - in: path name: projectsId @@ -35253,27 +39725,34 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: - parameters: *ref_107 post: description: >- - Batch reads Feature values from a Featurestore. This API enables batch - reading Feature values, where each read instance in the batch may read - Feature values of entities from one or more EntityTypes. Point-in-time - correctness is guaranteed for Feature values of each read instance as of - each instance's read timestamp. - operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues + Creates a TrainingPipeline. A created TrainingPipeline right away will + be attempted to be run. + operationId: aiplatform.projects.locations.trainingPipelines.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35285,7 +39764,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -35297,16 +39776,11 @@ paths: required: true schema: type: string - - in: path - name: featurestoresId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}: - parameters: *ref_107 - get: - description: Gets a TuningJob. - operationId: aiplatform.projects.locations.tuningJobs.get + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}: + parameters: *ref_1 + delete: + description: Deletes a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35318,7 +39792,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35331,15 +39805,13 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: trainingPipelinesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs: - parameters: *ref_107 get: - description: Lists TuningJobs in a Location. - operationId: aiplatform.projects.locations.tuningJobs.list + description: Gets a TrainingPipeline. + operationId: aiplatform.projects.locations.trainingPipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35351,8 +39823,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListTuningJobsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1TrainingPipeline' parameters: - in: path name: projectsId @@ -35364,29 +39835,31 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: trainingPipelinesId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel: + parameters: *ref_1 post: description: >- - Creates a TuningJob. A created TuningJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.tuningJobs.create + Cancels a TrainingPipeline. Starts asynchronous cancellation on the + TrainingPipeline. The server makes a best effort to cancel the pipeline, + but success is not guaranteed. Clients can use + PipelineService.GetTrainingPipeline or other methods to check whether + the cancellation succeeded or whether the pipeline completed despite + cancellation. On successful cancellation, the TrainingPipeline is not + deleted; instead it becomes a pipeline with a TrainingPipeline.error + value with a google.rpc.Status.code of 1, corresponding to + `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.trainingPipelines.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelTrainingPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35398,7 +39871,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1TuningJob' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35410,25 +39883,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel: - parameters: *ref_107 - post: + - in: path + name: trainingPipelinesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. - The server makes a best effort to cancel the job, but success is not - guaranteed. Clients can use GenAiTuningService.GetTuningJob or other - methods to check whether the cancellation succeeded or whether the job - completed despite cancellation. On successful cancellation, the - TuningJob is not deleted; instead it becomes a job with a - TuningJob.error value with a google.rpc.Status.code of 1, corresponding - to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.tuningJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelTuningJobRequest + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.indexes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35440,7 +39907,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35453,17 +39920,22 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations: - parameters: *ref_107 - get: + - in: path + name: operationsId + required: true + schema: + type: string + delete: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.tuningJobs.operations.list + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.indexes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35475,7 +39947,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -35488,31 +39960,22 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: indexesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: + parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.tuningJobs.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.indexes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35524,7 +39987,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -35537,17 +40000,25 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: indexesId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -35559,7 +40030,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.tuningJobs.operations.cancel + operationId: aiplatform.projects.locations.indexes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35584,7 +40055,7 @@ paths: schema: type: string - in: path - name: tuningJobsId + name: indexesId required: true schema: type: string @@ -35593,18 +40064,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- - Creates a BatchPredictionJob. A BatchPredictionJob once created will - right away be attempted to start. - operationId: aiplatform.projects.locations.batchPredictionJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.indexes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35616,7 +40089,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35628,9 +40101,32 @@ paths: required: true schema: type: string - get: - description: Lists BatchPredictionJobs in a Location. - operationId: aiplatform.projects.locations.batchPredictionJobs.list + - in: path + name: indexesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: + parameters: *ref_1 + post: + description: Add/update Datapoints into an Index. + operationId: aiplatform.projects.locations.indexes.upsertDatapoints + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35643,7 +40139,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListBatchPredictionJobsResponse + #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse parameters: - in: path name: projectsId @@ -35655,43 +40151,22 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: indexesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: + parameters: *ref_1 post: - description: >- - Cancels a BatchPredictionJob. Starts asynchronous cancellation on the - BatchPredictionJob. The server makes the best effort to cancel the job, - but success is not guaranteed. Clients can use - JobService.GetBatchPredictionJob or other methods to check whether the - cancellation succeeded or whether the job completed despite - cancellation. On a successful cancellation, the BatchPredictionJob is - not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. - Any files already outputted by the job are not deleted. - operationId: aiplatform.projects.locations.batchPredictionJobs.cancel + description: Remove Datapoints from an Index. + operationId: aiplatform.projects.locations.indexes.removeDatapoints requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelBatchPredictionJobRequest + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35703,7 +40178,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse parameters: - in: path name: projectsId @@ -35716,17 +40192,17 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: + parameters: *ref_1 delete: description: >- - Deletes a BatchPredictionJob. Can only be called on jobs that already - finished. - operationId: aiplatform.projects.locations.batchPredictionJobs.delete + Deletes an Index. An Index can only be deleted when all its + DeployedIndexes had been undeployed. + operationId: aiplatform.projects.locations.indexes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35751,13 +40227,18 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: indexesId required: true schema: type: string - get: - description: Gets a BatchPredictionJob - operationId: aiplatform.projects.locations.batchPredictionJobs.get + patch: + description: Updates an Index. + operationId: aiplatform.projects.locations.indexes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35769,7 +40250,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1BatchPredictionJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35782,18 +40263,18 @@ paths: schema: type: string - in: path - name: batchPredictionJobsId + name: indexesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: - parameters: *ref_107 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.specialistPools.operations.get + description: Gets an Index. + operationId: aiplatform.projects.locations.indexes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35805,7 +40286,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' parameters: - in: path name: projectsId @@ -35818,22 +40299,20 @@ paths: schema: type: string - in: path - name: specialistPoolsId - required: true - schema: - type: string - - in: path - name: operationsId + name: indexesId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.specialistPools.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/indexes: + parameters: *ref_1 + post: + description: Creates an Index. + operationId: aiplatform.projects.locations.indexes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35845,7 +40324,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35857,30 +40336,9 @@ paths: required: true schema: type: string - - in: path - name: specialistPoolsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.specialistPools.operations.wait + get: + description: Lists Indexes in a Location. + operationId: aiplatform.projects.locations.indexes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35892,7 +40350,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse parameters: - in: path name: projectsId @@ -35904,35 +40363,29 @@ paths: required: true schema: type: string - - in: path - name: specialistPoolsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.specialistPools.operations.cancel + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: + parameters: *ref_1 + delete: + description: Deletes a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35944,7 +40397,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -35957,22 +40410,13 @@ paths: schema: type: string - in: path - name: specialistPoolsId - required: true - schema: - type: string - - in: path - name: operationsId + name: notebookRuntimesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: - parameters: *ref_107 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.specialistPools.operations.list + description: Gets a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -35984,7 +40428,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' parameters: - in: path name: projectsId @@ -35997,28 +40441,15 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: + parameters: *ref_1 get: - description: Lists SpecialistPools in a Location. - operationId: aiplatform.projects.locations.specialistPools.list + description: Lists NotebookRuntimes in a Location. + operationId: aiplatform.projects.locations.notebookRuntimes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36031,7 +40462,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse + #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse parameters: - in: path name: projectsId @@ -36043,6 +40474,10 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -36053,18 +40488,25 @@ paths: schema: type: string format: google-fieldmask + - in: query + name: orderBy + schema: + type: string - in: query name: pageToken schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: + parameters: *ref_1 post: - description: Creates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.create + description: Upgrades a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.upgrade requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36088,16 +40530,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: - parameters: *ref_107 - patch: - description: Updates a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.patch + - in: path + name: notebookRuntimesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: + parameters: *ref_1 + post: + description: Starts a NotebookRuntime. + operationId: aiplatform.projects.locations.notebookRuntimes.start requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36122,18 +40570,24 @@ paths: schema: type: string - in: path - name: specialistPoolsId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a SpecialistPool as well as all Specialists in the pool. - operationId: aiplatform.projects.locations.specialistPools.delete + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: + parameters: *ref_1 + post: + description: >- + Assigns a NotebookRuntime to a user for a particular Notebook file. This + method will either returns an existing assignment or generates a new + one. + operationId: aiplatform.projects.locations.notebookRuntimes.assign + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36157,18 +40611,13 @@ paths: required: true schema: type: string - - in: path - name: specialistPoolsId - required: true - schema: - type: string - - in: query - name: force - schema: - type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations: + parameters: *ref_1 get: - description: Gets a SpecialistPool. - operationId: aiplatform.projects.locations.specialistPools.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36180,7 +40629,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -36193,65 +40642,31 @@ paths: schema: type: string - in: path - name: specialistPoolsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.endpoints.operations.cancel - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId + name: notebookRuntimesId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: endpointsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.endpoints.operations.get + operationId: aiplatform.projects.locations.notebookRuntimes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36276,7 +40691,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: notebookRuntimesId required: true schema: type: string @@ -36291,7 +40706,7 @@ paths: is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.endpoints.operations.delete + operationId: aiplatform.projects.locations.notebookRuntimes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36316,7 +40731,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: notebookRuntimesId required: true schema: type: string @@ -36325,13 +40740,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations: - parameters: *ref_107 - get: + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.endpoints.operations.list + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36343,7 +40765,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36356,37 +40778,34 @@ paths: schema: type: string - in: path - name: endpointsId + name: notebookRuntimesId required: true schema: type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - in: query - name: pageToken + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait: - parameters: *ref_107 + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.endpoints.operations.wait + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.notebookRuntimes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36398,7 +40817,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36411,7 +40830,7 @@ paths: schema: type: string - in: path - name: endpointsId + name: notebookRuntimesId required: true schema: type: string @@ -36420,21 +40839,19 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy: + parameters: *ref_1 post: - description: Perform a token counting. - operationId: aiplatform.projects.locations.endpoints.countTokens + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36446,8 +40863,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -36460,15 +40876,20 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: - parameters: *ref_107 - delete: - description: Deletes an Endpoint. - operationId: aiplatform.projects.locations.endpoints.delete + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: aiplatform.projects.locations.featurestores.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36480,7 +40901,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -36493,13 +40914,19 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}: + parameters: *ref_1 get: - description: Gets an Endpoint. - operationId: aiplatform.projects.locations.endpoints.get + description: Gets details of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36511,7 +40938,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' parameters: - in: path name: projectsId @@ -36524,18 +40951,15 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - patch: - description: Updates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + delete: + description: >- + Deletes a single Featurestore. The Featurestore must not contain any + EntityTypes or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36547,7 +40971,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36560,43 +40984,34 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - in: query - name: updateMask + name: force schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent: - parameters: *ref_107 - post: - description: Generate content with multimodal inputs. - operationId: aiplatform.projects.locations.endpoints.generateContent + type: boolean + patch: + description: Updates the parameters of a single Featurestore. + operationId: aiplatform.projects.locations.featurestores.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36609,25 +41024,31 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel: - parameters: *ref_107 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues: + parameters: *ref_1 post: description: >- - Updates an existing deployed model. Updatable fields include - `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, - `disable_container_logging` (v1 only), and `enable_container_logging` - (v1beta1 only). - operationId: aiplatform.projects.locations.endpoints.mutateDeployedModel + Batch reads Feature values from a Featurestore. This API enables batch + reading Feature values, where each read instance in the batch may read + Feature values of entities from one or more EntityTypes. Point-in-time + correctness is guaranteed for Feature values of each read instance as of + each instance's read timestamp. + operationId: aiplatform.projects.locations.featurestores.batchReadFeatureValues requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1MutateDeployedModelRequest + #/components/schemas/GoogleCloudAiplatformV1BatchReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36652,20 +41073,15 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens: - parameters: *ref_107 - post: - description: Return a list of tokens based on the input text. - operationId: aiplatform.projects.locations.endpoints.computeTokens - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' + /v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures: + parameters: *ref_1 + get: + description: Searches Features matching a query in a given project. + operationId: aiplatform.projects.locations.featurestores.searchFeatures security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36678,7 +41094,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse + #/components/schemas/GoogleCloudAiplatformV1SearchFeaturesResponse parameters: - in: path name: projectsId @@ -36690,23 +41106,29 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true + - in: query + name: query schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel: - parameters: *ref_107 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores: + parameters: *ref_1 post: - description: >- - Undeploys a Model from an Endpoint, removing a DeployedModel from it, - and freeing all resources it's using. - operationId: aiplatform.projects.locations.endpoints.undeployModel + description: Creates a new Featurestore in a given project and location. + operationId: aiplatform.projects.locations.featurestores.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployModelRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Featurestore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36730,41 +41152,26 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true + - in: query + name: featurestoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain: - parameters: *ref_107 - post: - description: >- - Perform an online explanation. If deployed_model_id is specified, the - corresponding DeployModel must have explanation_spec populated. If - deployed_model_id is not specified, all DeployedModels must have - explanation_spec populated. - operationId: aiplatform.projects.locations.endpoints.explain - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainRequest' + get: + description: Lists Featurestores in a given project and location. + operationId: aiplatform.projects.locations.featurestores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExplainResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturestoresResponse parameters: - in: path name: projectsId @@ -36776,16 +41183,35 @@ paths: required: true schema: type: string - - in: path - name: endpointsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints: - parameters: *ref_107 - get: - description: Lists Endpoints in a Location. - operationId: aiplatform.projects.locations.endpoints.list + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36797,8 +41223,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListEndpointsResponse + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -36810,36 +41235,24 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask + - in: path + name: featurestoresId + required: true schema: type: string - format: google-fieldmask - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - post: - description: Creates an Endpoint. - operationId: aiplatform.projects.locations.endpoints.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Endpoint' + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featurestores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -36863,39 +41276,35 @@ paths: required: true schema: type: string - - in: query - name: endpointId + - in: path + name: featurestoresId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict: - parameters: *ref_107 - post: + - in: path + name: operationsId + required: true + schema: + type: string + delete: description: >- - Perform an unary online prediction request to a gRPC model server for - Vertex first-party products and frameworks. - operationId: aiplatform.projects.locations.endpoints.directPredict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DirectPredictRequest' + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectPredictResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -36908,40 +41317,41 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- - Perform a server-side streaming online prediction request for Vertex LLM - streaming. - operationId: aiplatform.projects.locations.endpoints.serverStreamingPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictRequest + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featurestores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamingPredictResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -36954,37 +41364,39 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict: - parameters: *ref_107 - post: - description: Perform a streaming online prediction with an arbitrary HTTP payload. - operationId: aiplatform.projects.locations.endpoints.streamRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StreamRawPredictRequest + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featurestores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -36997,20 +41409,37 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel: - parameters: *ref_107 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Deploys a Model into this Endpoint, creating a DeployedModel within it. - operationId: aiplatform.projects.locations.endpoints.deployModel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployModelRequest' + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.featurestores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37022,7 +41451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -37035,41 +41464,37 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes: + parameters: *ref_1 post: - description: >- - Perform an online prediction with an arbitrary HTTP payload. The - response includes the following HTTP headers: * - `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this - prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's - DeployedModel that served this prediction. - operationId: aiplatform.projects.locations.endpoints.rawPredict + description: Creates a new EntityType in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1RawPredictRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37082,36 +41507,30 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict: - parameters: *ref_107 - post: - description: Perform an online prediction. - operationId: aiplatform.projects.locations.endpoints.predict - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictRequest' + - in: query + name: entityTypeId + schema: + type: string + get: + description: Lists EntityTypes in a given Featurestore. + operationId: aiplatform.projects.locations.featurestores.entityTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PredictResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListEntityTypesResponse parameters: - in: path name: projectsId @@ -37124,40 +41543,49 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict: - parameters: *ref_107 - post: - description: >- - Perform an unary online prediction request to a gRPC model server for - custom containers. - operationId: aiplatform.projects.locations.endpoints.directRawPredict - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictRequest + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}: + parameters: *ref_1 + get: + description: Gets details of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1DirectRawPredictResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -37170,38 +41598,32 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent: - parameters: *ref_107 - post: - description: Generate content with multimodal inputs with streaming support. - operationId: aiplatform.projects.locations.endpoints.streamGenerateContent - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest + - in: path + name: entityTypesId + required: true + schema: + type: string + delete: + description: >- + Deletes a single EntityType. The EntityType must not have any Features + or `force` must be set to true for the request to succeed. + operationId: aiplatform.projects.locations.featurestores.entityTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37214,21 +41636,27 @@ paths: schema: type: string - in: path - name: endpointsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade: - parameters: *ref_107 - post: - description: Upgrades a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.upgrade + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: force + schema: + type: boolean + patch: + description: Updates the parameters of a single EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37240,7 +41668,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1EntityType' parameters: - in: path name: projectsId @@ -37253,15 +41681,35 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}: - parameters: *ref_107 - delete: - description: Deletes a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.delete + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues: + parameters: *ref_1 + post: + description: >- + Reads Feature values of a specific entity of an EntityType. For reading + feature values of multiple entities of an EntityType, please use + StreamingReadFeatureValues. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37273,7 +41721,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -37286,13 +41735,26 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: featurestoresId required: true schema: type: string - get: - description: Gets a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.get + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37304,7 +41766,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NotebookRuntime' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -37317,24 +41779,26 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign: - parameters: *ref_107 - post: - description: >- - Assigns a NotebookRuntime to a user for a particular Notebook file. This - method will either returns an existing assignment or generates a new - one. - operationId: aiplatform.projects.locations.notebookRuntimes.assign - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AssignNotebookRuntimeRequest + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: permissions + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37346,7 +41810,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -37358,17 +41822,47 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start: - parameters: *ref_107 + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues: + parameters: *ref_1 post: - description: Starts a NotebookRuntime. - operationId: aiplatform.projects.locations.notebookRuntimes.start + description: >- + Imports Feature values into the Featurestore from a source storage. The + progress of the import is tracked by the returned operation. The + imported features are guaranteed to be visible to subsequent read + operations after the operation is marked as successfully done. If an + import operation fails, the Feature values returned from reads and + exports may be inconsistent. If consistency is required, the caller must + retry the same import request again and wait till the new operation + returned is marked as successfully done. There are also scenarios where + the caller can cause inconsistency. - Source data for import contains + multiple distinct Feature values for the same entity ID and timestamp. - + Source is modified during an import. This includes adding, updating, or + removing source data and/or metadata. Examples of updating metadata + include but are not limited to changing storage location, storage class, + or retention policy. - Online serving cluster is under-provisioned. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1StartNotebookRuntimeRequest + #/components/schemas/GoogleCloudAiplatformV1ImportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37393,15 +41887,35 @@ paths: schema: type: string - in: path - name: notebookRuntimesId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes: - parameters: *ref_107 - get: - description: Lists NotebookRuntimes in a Location. - operationId: aiplatform.projects.locations.notebookRuntimes.list + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues: + parameters: *ref_1 + post: + description: >- + Delete Feature values from Featurestore. The progress of the deletion is + tracked by the returned operation. The deleted feature values are + guaranteed to be invisible to subsequent read operations after the + operation is marked as successfully done. If a delete feature values + operation fails, the feature values returned from reads and exports may + be inconsistent. If consistency is required, the caller must retry the + same delete request again and wait till the new operation returned is + marked as successfully done. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeleteFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37413,8 +41927,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37426,33 +41939,30 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: featurestoresId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: entityTypesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs: - parameters: *ref_107 - get: - description: Lists CustomJobs in a Location. - operationId: aiplatform.projects.locations.customJobs.list + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues: + parameters: *ref_1 + post: + description: >- + Reads Feature values for multiple entities. Depending on their size, + data for different entities may be broken up across multiple responses. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37465,7 +41975,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListCustomJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ReadFeatureValuesResponse parameters: - in: path name: projectsId @@ -37477,34 +41987,32 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: featurestoresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: entityTypesId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues: + parameters: *ref_1 post: description: >- - Creates a CustomJob. A created CustomJob right away will be attempted to - be run. - operationId: aiplatform.projects.locations.customJobs.create + Writes Feature values of one or more entities of an EntityType. The + Feature values are merged into existing entities if any. The Feature + values to be written must have timestamp within the online storage + retention. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37516,7 +42024,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1WriteFeatureValuesResponse parameters: - in: path name: projectsId @@ -37528,25 +42037,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel: - parameters: *ref_107 + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy: + parameters: *ref_1 post: description: >- - Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. - The server makes a best effort to cancel the job, but success is not - guaranteed. Clients can use JobService.GetCustomJob or other methods to - check whether the cancellation succeeded or whether the job completed - despite cancellation. On successful cancellation, the CustomJob is not - deleted; instead it becomes a job with a CustomJob.error value with a - google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and - CustomJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.customJobs.cancel + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelCustomJobRequest + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37558,7 +42071,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -37571,15 +42084,27 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}: - parameters: *ref_107 - get: - description: Gets a CustomJob. - operationId: aiplatform.projects.locations.customJobs.get + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues: + parameters: *ref_1 + post: + description: Exports Feature values from all the entities of a target EntityType. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ExportFeatureValuesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37591,7 +42116,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CustomJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37604,13 +42129,25 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - delete: - description: Deletes a CustomJob. - operationId: aiplatform.projects.locations.customJobs.delete + - in: path + name: entityTypesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features: + parameters: *ref_1 + post: + description: Creates a new Feature in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37635,19 +42172,22 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.customJobs.operations.delete + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: query + name: featureId + schema: + type: string + get: + description: Lists Features in a given EntityType. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37659,7 +42199,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -37672,21 +42213,47 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.customJobs.operations.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: latestStatsCount + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}: + parameters: *ref_1 + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37711,29 +42278,28 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.customJobs.operations.wait + - in: path + name: featuresId + required: true + schema: + type: string + patch: + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37745,7 +42311,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -37758,34 +42324,28 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string - in: query - name: timeout + name: updateMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.customJobs.operations.cancel + format: google-fieldmask + get: + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featurestores.entityTypes.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37797,7 +42357,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -37810,22 +42370,32 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.customJobs.operations.list + - in: path + name: featuresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate: + parameters: *ref_1 + post: + description: Creates a batch of Features in a given EntityType. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCreateFeaturesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37837,7 +42407,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37850,32 +42420,25 @@ paths: schema: type: string - in: path - name: customJobsId + name: featurestoresId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: entityTypesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}: + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.migratableResources.operations.delete + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37900,7 +42463,17 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -37914,7 +42487,8 @@ paths: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.migratableResources.operations.get + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37939,7 +42513,17 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -37948,20 +42532,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.migratableResources.operations.cancel + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -37973,7 +42558,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -37986,7 +42571,17 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId required: true schema: type: string @@ -37995,13 +42590,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations: - parameters: *ref_107 + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.migratableResources.operations.list + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38026,12 +42627,18 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: featurestoresId required: true schema: type: string - - in: query - name: filter + - in: path + name: entityTypesId + required: true + schema: + type: string + - in: path + name: featuresId + required: true schema: type: string - in: query @@ -38043,20 +42650,25 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.migratableResources.operations.wait + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38068,7 +42680,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38081,34 +42693,40 @@ paths: schema: type: string - in: path - name: migratableResourcesId + name: featurestoresId required: true schema: type: string - in: path - name: operationsId + name: entityTypesId required: true schema: type: string - - in: query - name: timeout + - in: path + name: featuresId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- - Searches all of the resources in automl.googleapis.com, - datalabeling.googleapis.com and ml.googleapis.com that can be migrated - to Vertex AI's given location. - operationId: aiplatform.projects.locations.migratableResources.search - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesRequest + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38120,8 +42738,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchMigratableResourcesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38133,49 +42750,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate: - parameters: *ref_107 - post: - description: >- - Batch migrates resources from ml.googleapis.com, automl.googleapis.com, - and datalabeling.googleapis.com to Vertex AI. - operationId: aiplatform.projects.locations.migratableResources.batchMigrate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchMigrateResourcesRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: featurestoresId required: true schema: type: string - in: path - name: locationsId + name: entityTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.operations.list + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38199,12 +42795,14 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: featurestoresId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: entityTypesId + required: true schema: type: string - in: query @@ -38212,15 +42810,22 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_107 - delete: + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.operations.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38232,7 +42837,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38244,17 +42849,29 @@ paths: required: true schema: type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.operations.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.featurestores.entityTypes.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38266,7 +42883,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38278,13 +42895,23 @@ paths: required: true schema: type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -38296,7 +42923,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.operations.wait + operationId: aiplatform.projects.locations.featurestores.entityTypes.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38320,6 +42947,16 @@ paths: required: true schema: type: string + - in: path + name: featurestoresId + required: true + schema: + type: string + - in: path + name: entityTypesId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -38330,20 +42967,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.operations.cancel + /v1/projects/{projectsId}/locations/{locationsId}/studies: + parameters: *ref_1 + get: + description: Lists all the studies in a region for an associated project. + operationId: aiplatform.projects.locations.studies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38355,7 +42983,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListStudiesResponse parameters: - in: path name: projectsId @@ -38367,16 +42996,25 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: - parameters: *ref_107 - delete: - description: Deletes a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Creates a Study. A resource name will be generated after creation of the + Study. + operationId: aiplatform.projects.locations.studies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38388,7 +43026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -38400,19 +43038,11 @@ paths: required: true schema: type: string - - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - get: - description: Gets details of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.get + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: + parameters: *ref_1 + delete: + description: Deletes a Study. + operationId: aiplatform.projects.locations.studies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38424,7 +43054,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38437,23 +43067,13 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: studiesId required: true schema: type: string - patch: - description: Updates the parameters of a single Feature. - operationId: aiplatform.projects.locations.featureGroups.features.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + get: + description: Gets a Study by name. + operationId: aiplatform.projects.locations.studies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38465,7 +43085,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -38478,30 +43098,22 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: featuresId + name: studiesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/studies:lookup: + parameters: *ref_1 post: - description: Creates a new Feature in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.create + description: >- + Looks a study up using the user-defined display_name field instead of + the fully qualified resource name. + operationId: aiplatform.projects.locations.studies.lookup requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LookupStudyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38513,7 +43125,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Study' parameters: - in: path name: projectsId @@ -38525,18 +43137,14 @@ paths: required: true schema: type: string - - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: query - name: featureId - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Lists Features in a given FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.features.list + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.studies.trials.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38548,8 +43156,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -38562,46 +43169,27 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: trialsId + required: true schema: type: string - - in: query - name: latestStatsCount - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: - parameters: *ref_107 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.delete + operationId: aiplatform.projects.locations.studies.trials.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38626,12 +43214,12 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - in: path - name: featuresId + name: trialsId required: true schema: type: string @@ -38640,12 +43228,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featureGroups.features.operations.get + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.studies.trials.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38670,12 +43266,12 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - in: path - name: featuresId + name: trialsId required: true schema: type: string @@ -38684,13 +43280,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: - parameters: *ref_107 - get: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.studies.trials.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38702,7 +43310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38715,12 +43323,12 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - in: path - name: featuresId + name: trialsId required: true schema: type: string @@ -38729,8 +43337,44 @@ paths: required: true schema: type: string - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.studies.trials.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: studiesId + required: true + schema: + type: string + - in: path + name: trialsId + required: true schema: type: string - in: query @@ -38742,18 +43386,20 @@ paths: schema: type: integer format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: + parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featureGroups.features.operations.wait + description: Stops a Trial. + operationId: aiplatform.projects.locations.studies.trials.stop + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1StopTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38765,7 +43411,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38778,33 +43424,62 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - in: path - name: featuresId + name: trialsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: + parameters: *ref_1 + post: + description: >- + Adds one or more Trials to a Study, with parameter values suggested by + Vertex AI Vizier. Returns a long-running operation associated with the + generation of Trial suggestions. When this long-running operation + succeeds, it will contain a SuggestTrialsResponse. + operationId: aiplatform.projects.locations.studies.trials.suggest + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SuggestTrialsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: studiesId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: - parameters: *ref_107 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featureGroups.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: + parameters: *ref_1 + delete: + description: Deletes a Trial. + operationId: aiplatform.projects.locations.studies.trials.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38816,7 +43491,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -38829,22 +43504,18 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.operations.delete + get: + description: Gets a Trial. + operationId: aiplatform.projects.locations.studies.trials.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38856,7 +43527,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38869,22 +43540,20 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - in: path - name: operationsId + name: trialsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureGroups.operations.listWait + description: Lists the Trials associated with a Study. + operationId: aiplatform.projects.locations.studies.trials.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38896,7 +43565,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListTrialsResponse' parameters: - in: path name: projectsId @@ -38909,12 +43578,7 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId + name: studiesId required: true schema: type: string @@ -38927,22 +43591,14 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featureGroups.operations.wait + description: Adds a user provided Trial to a Study. + operationId: aiplatform.projects.locations.studies.trials.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38954,7 +43610,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -38967,25 +43623,24 @@ paths: schema: type: string - in: path - name: featureGroupsId - required: true - schema: - type: string - - in: path - name: operationsId + name: studiesId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: - parameters: *ref_107 - get: - description: Gets details of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.get + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: + parameters: *ref_1 + post: + description: >- + Lists the pareto-optimal Trials for multi-objective Study or the optimal + Trials for single-objective Study. The definition of pareto-optimal can + be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency + operationId: aiplatform.projects.locations.studies.trials.listOptimalTrials + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -38997,7 +43652,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListOptimalTrialsResponse parameters: - in: path name: projectsId @@ -39010,18 +43666,20 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - patch: - description: Updates the parameters of a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.patch + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: + parameters: *ref_1 + post: + description: Marks a Trial as complete. + operationId: aiplatform.projects.locations.studies.trials.complete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + $ref: '#/components/schemas/GoogleCloudAiplatformV1CompleteTrialRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39033,7 +43691,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -39046,18 +43704,28 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: trialsId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a single FeatureGroup. - operationId: aiplatform.projects.locations.featureGroups.delete + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement: + parameters: *ref_1 + post: + description: >- + Adds a measurement of the objective metrics to a Trial. This measurement + is assumed to have been taken before the Trial is complete. + operationId: aiplatform.projects.locations.studies.trials.addTrialMeasurement + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddTrialMeasurementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39069,7 +43737,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Trial' parameters: - in: path name: projectsId @@ -39082,19 +43750,30 @@ paths: schema: type: string - in: path - name: featureGroupsId + name: studiesId required: true schema: type: string - - in: query - name: force + - in: path + name: trialsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: - parameters: *ref_107 - get: - description: Lists FeatureGroups in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.list + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState: + parameters: *ref_1 + post: + description: >- + Checks whether a Trial should stop or not. Returns a long-running + operation. When the operation is successful, it will contain a + CheckTrialEarlyStoppingStateResponse. + operationId: >- + aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39106,8 +43785,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39119,31 +43797,30 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: studiesId + required: true schema: type: string - - in: query - name: filter + - in: path + name: trialsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Creates a new FeatureGroup in a given project and location. - operationId: aiplatform.projects.locations.featureGroups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.studies.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39155,7 +43832,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39167,15 +43844,30 @@ paths: required: true schema: type: string - - in: query - name: featureGroupId + - in: path + name: studiesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: - parameters: *ref_107 - get: - description: List top NasTrialDetails of a NasJob. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.studies.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39187,8 +43879,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39201,24 +43892,28 @@ paths: schema: type: string - in: path - name: nasJobsId + name: studiesId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: operationsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: - parameters: *ref_107 + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a NasTrialDetail. - operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.studies.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39230,7 +43925,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39243,20 +43938,22 @@ paths: schema: type: string - in: path - name: nasJobsId + name: studiesId required: true schema: type: string - in: path - name: nasTrialDetailsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: - parameters: *ref_107 - get: - description: Lists NasJobs in a Location. - operationId: aiplatform.projects.locations.nasJobs.list + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.studies.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39268,8 +43965,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39281,32 +43977,23 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: studiesId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - post: - description: Creates a NasJob - operationId: aiplatform.projects.locations.nasJobs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.studies.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39318,7 +44005,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -39330,27 +44017,47 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: - parameters: *ref_107 - get: - description: Gets a NasJob - operationId: aiplatform.projects.locations.nasJobs.get + - in: path + name: studiesId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors: + parameters: *ref_1 + post: + description: Finds the nearest neighbors of each vector within the request. + operationId: aiplatform.projects.locations.indexEndpoints.findNeighbors + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1FindNeighborsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1FindNeighborsResponse parameters: - in: path name: projectsId @@ -39363,13 +44070,20 @@ paths: schema: type: string - in: path - name: nasJobsId + name: indexEndpointsId required: true schema: type: string - delete: - description: Deletes a NasJob. - operationId: aiplatform.projects.locations.nasJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints: + parameters: *ref_1 + post: + description: Creates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39393,29 +44107,9 @@ paths: required: true schema: type: string - - in: path - name: nasJobsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: - parameters: *ref_107 - post: - description: >- - Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The - server makes a best effort to cancel the job, but success is not - guaranteed. Clients can use JobService.GetNasJob or other methods to - check whether the cancellation succeeded or whether the job completed - despite cancellation. On successful cancellation, the NasJob is not - deleted; instead it becomes a job with a NasJob.error value with a - google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and - NasJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.nasJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' + get: + description: Lists IndexEndpoints in a Location. + operationId: aiplatform.projects.locations.indexEndpoints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39427,7 +44121,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListIndexEndpointsResponse parameters: - in: path name: projectsId @@ -39439,21 +44134,34 @@ paths: required: true schema: type: string - - in: path - name: nasJobsId - required: true + - in: query + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export: - parameters: *ref_107 + format: google-fieldmask + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex: + parameters: *ref_1 post: - description: Exports data from a Dataset. - operationId: aiplatform.projects.locations.datasets.export + description: Update an existing DeployedIndex under an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportDataRequest' + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployedIndex' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39478,15 +44186,23 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems: - parameters: *ref_107 - get: - description: Searches DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.searchDataItems + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints: + parameters: *ref_1 + post: + description: >- + Reads the datapoints/vectors of the given IDs. A maximum of 1000 + datapoints can be retrieved in a batch. + operationId: aiplatform.projects.locations.indexEndpoints.readIndexDatapoints + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39499,7 +44215,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchDataItemsResponse + #/components/schemas/GoogleCloudAiplatformV1ReadIndexDatapointsResponse parameters: - in: path name: projectsId @@ -39512,75 +44228,22 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: annotationsFilter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: savedQuery - schema: - type: string - - in: query - name: orderByAnnotation.savedQuery - schema: - type: string - - in: query - name: dataItemFilter - schema: - type: string - - in: query - name: orderByDataItem - schema: - type: string - - in: query - name: annotationsLimit - schema: - type: integer - format: int32 - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderByAnnotation.orderBy - schema: - type: string - - in: query - name: dataLabelingJob - schema: - type: string - - in: query - name: annotationFilters - schema: - type: string - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex: + parameters: *ref_1 post: - description: Creates a Dataset. - operationId: aiplatform.projects.locations.datasets.create + description: >- + Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from + it, and freeing all resources it's using. + operationId: aiplatform.projects.locations.indexEndpoints.undeployIndex requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleCloudAiplatformV1UndeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39604,9 +44267,23 @@ paths: required: true schema: type: string - get: - description: Lists Datasets in a Location. - operationId: aiplatform.projects.locations.datasets.list + - in: path + name: indexEndpointsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex: + parameters: *ref_1 + post: + description: >- + Deploys an Index into this IndexEndpoint, creating a DeployedIndex + within it. Only non-empty Indexes can be deployed. + operationId: aiplatform.projects.locations.indexEndpoints.deployIndex + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DeployIndexRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39618,8 +44295,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39631,33 +44307,21 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: indexEndpointsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: - parameters: *ref_107 - delete: - description: Deletes a Dataset. - operationId: aiplatform.projects.locations.datasets.delete + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}: + parameters: *ref_1 + patch: + description: Updates an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39669,7 +44333,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -39682,13 +44346,18 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Gets a Dataset. - operationId: aiplatform.projects.locations.datasets.get + description: Gets an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39700,7 +44369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleCloudAiplatformV1IndexEndpoint' parameters: - in: path name: projectsId @@ -39713,23 +44382,13 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - patch: - description: Updates a Dataset. - operationId: aiplatform.projects.locations.datasets.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + delete: + description: Deletes an IndexEndpoint. + operationId: aiplatform.projects.locations.indexEndpoints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39741,7 +44400,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39754,25 +44413,19 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import: - parameters: *ref_107 - post: - description: Imports data into a Dataset. - operationId: aiplatform.projects.locations.datasets.import - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1ImportDataRequest' + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.indexEndpoints.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39784,7 +44437,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -39797,17 +44450,21 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations: - parameters: *ref_107 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.list + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.indexEndpoints.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39819,7 +44476,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -39832,30 +44489,17 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string - in: path - name: annotationSpecsId + name: operationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -39867,7 +44511,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel + operationId: aiplatform.projects.locations.indexEndpoints.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39892,12 +44536,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: indexEndpointsId required: true schema: type: string @@ -39906,8 +44545,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -39919,7 +44558,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.wait + operationId: aiplatform.projects.locations.indexEndpoints.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39944,12 +44583,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId + name: indexEndpointsId required: true schema: type: string @@ -39963,15 +44597,13 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}: - parameters: *ref_107 - delete: + /v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.indexEndpoints.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -39983,7 +44615,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -39996,26 +44628,28 @@ paths: schema: type: string - in: path - name: datasetsId + name: indexEndpointsId required: true schema: type: string - - in: path - name: annotationSpecsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools: + parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.operations.get + description: List DeploymentResourcePools in a location. + operationId: aiplatform.projects.locations.deploymentResourcePools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40027,7 +44661,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse parameters: - in: path name: projectsId @@ -40039,26 +44674,24 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}: - parameters: *ref_107 - get: - description: Gets an AnnotationSpec. - operationId: aiplatform.projects.locations.datasets.annotationSpecs.get + type: integer + format: int32 + post: + description: Create a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40070,7 +44703,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1AnnotationSpec' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40082,26 +44715,11 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: annotationSpecsId - required: true - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: - parameters: *ref_107 - delete: - description: Deletes a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.delete + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}: + parameters: *ref_1 + get: + description: Get a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40113,7 +44731,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool parameters: - in: path name: projectsId @@ -40126,18 +44745,13 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId + name: deploymentResourcePoolsId required: true schema: type: string - get: - description: Gets a Dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.get + delete: + description: Delete a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40149,7 +44763,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40162,28 +44776,19 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId + name: deploymentResourcePoolsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask patch: - description: Updates a DatasetVersion. - operationId: aiplatform.projects.locations.datasets.datasetVersions.patch + description: Update a DeploymentResourcePool. + operationId: aiplatform.projects.locations.deploymentResourcePools.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1DeploymentResourcePool security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40195,7 +44800,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40208,12 +44813,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: datasetVersionsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -40222,11 +44822,14 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels: + parameters: *ref_1 get: - description: Lists DatasetVersions in a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.list + description: >- + List DeployedModels that have been deployed on this + DeploymentResourcePool. + operationId: >- + aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40239,7 +44842,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse + #/components/schemas/GoogleCloudAiplatformV1QueryDeployedModelsResponse parameters: - in: path name: projectsId @@ -40252,40 +44855,28 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId required: true schema: type: string - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Create a version from a Dataset. - operationId: aiplatform.projects.locations.datasets.datasetVersions.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40297,7 +44888,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40310,15 +44901,21 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: - parameters: *ref_107 get: - description: Restores a dataset version. - operationId: aiplatform.projects.locations.datasets.datasetVersions.restore + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40343,24 +44940,22 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId required: true schema: type: string - in: path - name: datasetVersionsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: - parameters: *ref_107 - delete: + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40372,7 +44967,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -40385,21 +44980,37 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - get: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.datasets.operations.get + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40411,7 +45022,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -40424,7 +45035,7 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -40433,8 +45044,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -40446,7 +45057,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.operations.wait + operationId: aiplatform.projects.locations.deploymentResourcePools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40471,7 +45082,7 @@ paths: schema: type: string - in: path - name: datasetsId + name: deploymentResourcePoolsId required: true schema: type: string @@ -40485,13 +45096,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.operations.list + description: Gets a NasTrialDetail. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40503,7 +45112,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasTrialDetail' parameters: - in: path name: projectsId @@ -40516,37 +45125,20 @@ paths: schema: type: string - in: path - name: datasetsId + name: nasJobsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: nasTrialDetailsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.operations.cancel + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails: + parameters: *ref_1 + get: + description: List top NasTrialDetails of a NasJob. + operationId: aiplatform.projects.locations.nasJobs.nasTrialDetails.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40558,7 +45150,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNasTrialDetailsResponse parameters: - in: path name: projectsId @@ -40571,30 +45164,29 @@ paths: schema: type: string - in: path - name: datasetsId + name: nasJobsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs: + parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait + description: Creates a NasJob + operationId: aiplatform.projects.locations.nasJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40606,7 +45198,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -40618,41 +45210,56 @@ paths: required: true schema: type: string + get: + description: Lists NasJobs in a Location. + operationId: aiplatform.projects.locations.nasJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListNasJobsResponse + parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: dataItemsId + name: locationsId required: true schema: type: string - - in: path - name: annotationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}: - parameters: *ref_107 + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}: + parameters: *ref_1 delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete + description: Deletes a NasJob. + operationId: aiplatform.projects.locations.nasJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40664,7 +45271,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40677,44 +45284,29 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: annotationsId - required: true - schema: - type: string - - in: path - name: operationsId + name: nasJobsId required: true schema: type: string get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.get + description: Gets a NasJob + operationId: aiplatform.projects.locations.nasJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1NasJob' parameters: - in: path name: projectsId @@ -40727,40 +45319,28 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: annotationsId - required: true - schema: - type: string - - in: path - name: operationsId + name: nasJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel: + parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel + Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The + server makes a best effort to cancel the job, but success is not + guaranteed. Clients can use JobService.GetNasJob or other methods to + check whether the cancellation succeeded or whether the job completed + despite cancellation. On successful cancellation, the NasJob is not + deleted; instead it becomes a job with a NasJob.error value with a + google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and + NasJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.nasJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CancelNasJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40785,33 +45365,54 @@ paths: schema: type: string - in: path - name: datasetsId + name: nasJobsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: + parameters: *ref_1 + post: + description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. + operationId: aiplatform.projects.locations.dataLabelingJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: - in: path - name: dataItemsId + name: projectsId required: true schema: type: string - in: path - name: annotationsId + name: locationsId required: true schema: type: string - in: path - name: operationsId + name: dataLabelingJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.datasets.dataItems.annotations.operations.list + description: Lists DataLabelingJobs in a Location. + operationId: aiplatform.projects.locations.dataLabelingJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40823,7 +45424,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse parameters: - in: path name: projectsId @@ -40835,19 +45437,16 @@ paths: required: true schema: type: string - - in: path - name: datasetsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: dataItemsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: annotationsId - required: true + - in: query + name: orderBy schema: type: string - in: query @@ -40856,18 +45455,18 @@ paths: type: integer format: int32 - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations: - parameters: *ref_107 - get: - description: Lists Annotations belongs to a dataitem - operationId: aiplatform.projects.locations.datasets.dataItems.annotations.list + format: google-fieldmask + post: + description: Creates a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40879,8 +45478,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListAnnotationsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' parameters: - in: path name: projectsId @@ -40892,45 +45490,42 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: + parameters: *ref_1 + get: + description: Gets a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + parameters: - in: path - name: datasetsId + name: projectsId required: true schema: type: string - in: path - name: dataItemsId + name: locationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: dataLabelingJobsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.list + delete: + description: Deletes a DataLabelingJob. + operationId: aiplatform.projects.locations.dataLabelingJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -40942,7 +45537,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -40955,30 +45550,12 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: dataLabelingJobsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -40990,7 +45567,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.cancel + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41015,12 +45592,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: dataLabelingJobsId required: true schema: type: string @@ -41029,15 +45601,15 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.delete + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41062,12 +45634,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: dataLabelingJobsId required: true schema: type: string @@ -41081,59 +45648,7 @@ paths: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.dataItems.operations.wait + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41158,12 +45673,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dataItemsId + name: dataLabelingJobsId required: true schema: type: string @@ -41172,16 +45682,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: + parameters: *ref_1 get: - description: Lists DataItems in a Dataset. - operationId: aiplatform.projects.locations.datasets.dataItems.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41193,8 +45700,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataItemsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41207,37 +45713,37 @@ paths: schema: type: string - in: path - name: datasetsId + name: dataLabelingJobsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}: - parameters: *ref_107 - delete: - description: Deletes a SavedQuery. - operationId: aiplatform.projects.locations.datasets.savedQueries.delete + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41262,80 +45768,35 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries: - parameters: *ref_107 - get: - description: Lists SavedQueries in a Dataset. - operationId: aiplatform.projects.locations.datasets.savedQueries.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSavedQueriesResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: dataLabelingJobsId required: true schema: type: string - in: path - name: datasetsId + name: operationsId required: true schema: type: string - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: timeout schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}: - parameters: *ref_107 - delete: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.delete + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41360,12 +45821,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41374,12 +45830,14 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: + parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41391,7 +45849,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -41404,34 +45862,33 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: path - name: savedQueriesId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: + parameters: *ref_1 + delete: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.cancel + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41456,12 +45913,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41470,13 +45922,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations: - parameters: *ref_107 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.list + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41488,7 +45940,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41501,30 +45953,17 @@ paths: schema: type: string - in: path - name: datasetsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - in: path - name: savedQueriesId + name: operationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -41536,7 +45975,8 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.datasets.savedQueries.operations.wait + operationId: >- + aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41561,12 +46001,7 @@ paths: schema: type: string - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: savedQueriesId + name: modelDeploymentMonitoringJobsId required: true schema: type: string @@ -41580,11 +46015,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: - parameters: *ref_107 - delete: - description: Deletes a ModelDeploymentMonitoringJob. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: + parameters: *ref_1 + get: + description: Lists ModelDeploymentMonitoringJobs in a Location. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41596,7 +46031,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse parameters: - in: path name: projectsId @@ -41608,11 +46044,61 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + post: + description: >- + Creates a ModelDeploymentMonitoringJob. It will run periodically on a + configured interval. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: modelDeploymentMonitoringJobsId + name: locationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}: + parameters: *ref_1 get: description: Gets a ModelDeploymentMonitoringJob. operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.get @@ -41687,20 +46173,9 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: - parameters: *ref_107 - post: - description: >- - Pauses a ModelDeploymentMonitoringJob. If the job is running, the server - makes a best effort to cancel the job. Will mark - ModelDeploymentMonitoringJob.state to 'PAUSED'. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest + delete: + description: Deletes a ModelDeploymentMonitoringJob. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41712,7 +46187,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -41729,19 +46204,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: + parameters: *ref_1 post: description: >- - Creates a ModelDeploymentMonitoringJob. It will run periodically on a - configured interval. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.create + Resumes a paused ModelDeploymentMonitoringJob. It will start to run from + next scheduled time. A deleted ModelDeploymentMonitoringJob can't be + resumed. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41753,8 +46229,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ModelDeploymentMonitoringJob + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -41766,53 +46241,13 @@ paths: required: true schema: type: string - get: - description: Lists ModelDeploymentMonitoringJobs in a Location. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: modelDeploymentMonitoringJobsId required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies: - parameters: *ref_107 + parameters: *ref_1 post: description: >- Searches Model Monitoring Statistics generated within a given time @@ -41854,20 +46289,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause: + parameters: *ref_1 post: description: >- - Resumes a paused ModelDeploymentMonitoringJob. It will start to run from - next scheduled time. A deleted ModelDeploymentMonitoringJob can't be - resumed. - operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume + Pauses a ModelDeploymentMonitoringJob. If the job is running, the server + makes a best effort to cancel the job. Will mark + ModelDeploymentMonitoringJob.state to 'PAUSED'. + operationId: aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest + #/components/schemas/GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41896,21 +46331,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}: + parameters: *ref_1 + get: + description: Gets a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41922,7 +46347,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -41935,35 +46360,26 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: modelsId required: true schema: type: string - in: path - name: operationsId + name: evaluationsId required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import: + parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel + description: Imports an externally generated ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ImportModelEvaluationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -41975,7 +46391,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ModelEvaluation' parameters: - in: path name: projectsId @@ -41988,23 +46404,15 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list + description: Lists ModelEvaluations in a Model. + operationId: aiplatform.projects.locations.models.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42016,7 +46424,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationsResponse parameters: - in: path name: projectsId @@ -42029,33 +46438,33 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: modelsId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}: - parameters: *ref_107 - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices: + parameters: *ref_1 + get: + description: Lists ModelEvaluationSlices in a ModelEvaluation. + operationId: aiplatform.projects.locations.models.evaluations.slices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42067,7 +46476,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse parameters: - in: path name: projectsId @@ -42080,65 +46490,44 @@ paths: schema: type: string - in: path - name: modelDeploymentMonitoringJobsId + name: modelsId required: true schema: type: string - in: path - name: operationsId + name: evaluationsId required: true schema: type: string - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: locationsId - required: true + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: modelDeploymentMonitoringJobsId - required: true + - in: query + name: readMask schema: type: string - - in: path - name: operationsId - required: true + format: google-fieldmask + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport: + parameters: *ref_1 post: - description: Creates a new FeatureView in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.create + description: Imports a list of externally generated EvaluatedAnnotations. + operationId: aiplatform.projects.locations.models.evaluations.slices.batchImport requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42150,7 +46539,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse parameters: - in: path name: projectsId @@ -42163,21 +46553,25 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - - in: query - name: featureViewId + - in: path + name: evaluationsId + required: true schema: type: string - - in: query - name: runSyncImmediately + - in: path + name: slicesId + required: true schema: - type: boolean + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}: + parameters: *ref_1 get: - description: Lists FeatureViews in a given FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.list + description: Gets a ModelEvaluationSlice. + operationId: aiplatform.projects.locations.models.evaluations.slices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42190,7 +46584,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewsResponse + #/components/schemas/GoogleCloudAiplatformV1ModelEvaluationSlice parameters: - in: path name: projectsId @@ -42203,42 +46597,27 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + - in: path + name: evaluationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: slicesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations: + parameters: *ref_1 + get: description: >- - Search the nearest entities under a FeatureView. Search only works for - indexable feature view; if a feature view isn't indexable, returns - Invalid argument response. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.evaluations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42250,8 +46629,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SearchNearestEntitiesResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -42264,70 +46642,36 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync: - parameters: *ref_107 - post: - description: Triggers on-demand sync for the FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.sync - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1SyncFeatureViewResponse - parameters: - in: path - name: projectsId + name: evaluationsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: featureOnlineStoresId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: featureViewsId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}: - parameters: *ref_107 - patch: - description: Updates the parameters of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.models.evaluations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42352,23 +46696,27 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - in: path - name: featureViewsId + name: evaluationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask delete: - description: Deletes a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.evaluations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42380,7 +46728,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42393,18 +46741,34 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - in: path - name: featureViewsId + name: evaluationsId required: true schema: type: string - get: - description: Gets details of a single FeatureView. - operationId: aiplatform.projects.locations.featureOnlineStores.featureViews.get + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.models.evaluations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42416,7 +46780,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureView' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42429,27 +46793,34 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - in: path - name: featureViewsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Fetch feature values under a FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesRequest + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.models.evaluations.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42461,8 +46832,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1FetchFeatureValuesResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42475,24 +46845,39 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - in: path - name: featureViewsId + name: evaluationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}: - parameters: *ref_107 - get: + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.models.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42504,7 +46889,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42517,12 +46902,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelsId required: true schema: type: string @@ -42531,14 +46911,20 @@ paths: required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.models.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42550,7 +46936,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42563,28 +46949,27 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - in: path - name: featureViewsId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait: - parameters: *ref_107 + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait + operationId: aiplatform.projects.locations.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42609,17 +46994,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelsId required: true schema: type: string @@ -42636,19 +47011,15 @@ paths: name: pageToken schema: type: string - post: + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}: + parameters: *ref_1 + delete: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.models.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42660,7 +47031,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -42673,12 +47044,7 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelsId required: true schema: type: string @@ -42687,17 +47053,12 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}: - parameters: *ref_107 get: - description: Gets details of a single FeatureViewSync. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42709,7 +47070,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureViewSync' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -42722,26 +47083,20 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelsId required: true schema: type: string - in: path - name: featureViewSyncsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: + parameters: *ref_1 get: - description: Lists FeatureViewSyncs in a given FeatureView. - operationId: >- - aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list + description: Gets a Model. + operationId: aiplatform.projects.locations.models.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42753,8 +47108,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureViewSyncsResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -42767,40 +47121,15 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: featureViewsId + name: modelsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}: - parameters: *ref_107 - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.get + Deletes a Model. A model cannot be deleted if any Endpoint resource has + a DeployedModel based on the model in its deployed_models field. + operationId: aiplatform.projects.locations.models.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42825,22 +47154,18 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId - required: true - schema: - type: string - - in: path - name: operationsId + name: modelsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.delete + patch: + description: Updates a Model. + operationId: aiplatform.projects.locations.models.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42852,7 +47177,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' parameters: - in: path name: projectsId @@ -42865,22 +47190,20 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait: - parameters: *ref_107 + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.listWait + description: Lists versions of the specified model. + operationId: aiplatform.projects.locations.models.listVersions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42892,7 +47215,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListModelVersionsResponse parameters: - in: path name: projectsId @@ -42905,40 +47229,39 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy schema: type: string - in: query - name: pageSize + name: filter schema: - type: integer - format: int32 + type: string - in: query name: pageToken schema: type: string - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy: + parameters: *ref_1 post: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.featureOnlineStores.operations.wait + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: aiplatform.projects.locations.models.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -42950,7 +47273,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -42963,30 +47286,67 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases: + parameters: *ref_1 + post: + description: Merges a set of aliases for a Model version. + operationId: aiplatform.projects.locations.models.mergeVersionAliases + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1MergeVersionAliasesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Model' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - - in: query - name: timeout + - in: path + name: modelsId + required: true schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}: - parameters: *ref_107 - patch: - description: Updates the parameters of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.patch + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export: + parameters: *ref_1 + post: + description: >- + Exports a trained, exportable Model to a location specified by the user. + A Model is considered to be exportable if it has at least one supported + export format. + operationId: aiplatform.projects.locations.models.export requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: '#/components/schemas/GoogleCloudAiplatformV1ExportModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43011,18 +47371,18 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets details of a single FeatureOnlineStore. - operationId: aiplatform.projects.locations.featureOnlineStores.get + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion: + parameters: *ref_1 + delete: + description: >- + Deletes a Model version. Model version can only be deleted if there are + no DeployedModels created from it. Deleting the only version in the + Model is not allowed. Use DeleteModel for deleting the Model instead. + operationId: aiplatform.projects.locations.models.deleteVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43034,7 +47394,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43047,15 +47407,25 @@ paths: schema: type: string - in: path - name: featureOnlineStoresId + name: modelsId required: true schema: type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/models:copy: + parameters: *ref_1 + post: description: >- - Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not - contain any FeatureViews. - operationId: aiplatform.projects.locations.featureOnlineStores.delete + Copies an already existing Vertex AI Model into the specified Location. + The source Model must exist in the same Project. When copying custom + Models, the users themselves are responsible for Model.metadata content + to be region-agnostic, as well as making sure that any resources (e.g. + files) it depends on remain accessible. + operationId: aiplatform.projects.locations.models.copy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CopyModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43079,25 +47449,58 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: aiplatform.projects.locations.models.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: featureOnlineStoresId + name: locationsId required: true schema: type: string - - in: query - name: force + - in: path + name: modelsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores: - parameters: *ref_107 + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset: + parameters: *ref_1 post: - description: Creates a new FeatureOnlineStore in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.create + description: Incrementally update the dataset used for an examples model. + operationId: aiplatform.projects.locations.models.updateExplanationDataset requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureOnlineStore' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1UpdateExplanationDatasetRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43121,13 +47524,16 @@ paths: required: true schema: type: string - - in: query - name: featureOnlineStoreId - schema: - type: string + - in: path + name: modelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/models: + parameters: *ref_1 get: - description: Lists FeatureOnlineStores in a given project and location. - operationId: aiplatform.projects.locations.featureOnlineStores.list + description: Lists Models in a Location. + operationId: aiplatform.projects.locations.models.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43139,8 +47545,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1ListModelsResponse' parameters: - in: path name: projectsId @@ -43153,11 +47558,11 @@ paths: schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -43169,13 +47574,21 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations: - parameters: *ref_107 - get: + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexes.operations.list + 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. + operationId: aiplatform.projects.locations.models.testIamPermissions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43187,7 +47600,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -43200,31 +47613,24 @@ paths: schema: type: string - in: path - name: indexesId + name: modelsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + name: permissions schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}: - parameters: *ref_107 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.indexes.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/models:upload: + parameters: *ref_1 + post: + description: Uploads a Model artifact into Vertex AI. + operationId: aiplatform.projects.locations.models.upload + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1UploadModelRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43248,23 +47654,11 @@ paths: required: true schema: type: string - - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.indexes.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}: + parameters: *ref_1 + get: + description: Gets a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43276,7 +47670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' parameters: - in: path name: projectsId @@ -43289,29 +47683,18 @@ paths: schema: type: string - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId + name: specialistPoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.indexes.operations.wait + patch: + description: Updates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43336,34 +47719,18 @@ paths: schema: type: string - in: path - name: indexesId - required: true - schema: - type: string - - in: path - name: operationsId + name: specialistPoolsId required: true schema: type: string - in: query - name: timeout + name: updateMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.indexes.operations.cancel + format: google-fieldmask + delete: + description: Deletes a SpecialistPool as well as all Specialists in the pool. + operationId: aiplatform.projects.locations.specialistPools.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43375,7 +47742,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43388,20 +47755,19 @@ paths: schema: type: string - in: path - name: indexesId + name: specialistPoolsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: force schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes: - parameters: *ref_107 + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools: + parameters: *ref_1 get: - description: Lists Indexes in a Location. - operationId: aiplatform.projects.locations.indexes.list + description: Lists SpecialistPools in a Location. + operationId: aiplatform.projects.locations.specialistPools.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43414,7 +47780,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListIndexesResponse + #/components/schemas/GoogleCloudAiplatformV1ListSpecialistPoolsResponse parameters: - in: path name: projectsId @@ -43426,6 +47792,11 @@ paths: required: true schema: type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask - in: query name: pageSize schema: @@ -43435,23 +47806,14 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask post: - description: Creates an Index. - operationId: aiplatform.projects.locations.indexes.create + description: Creates a SpecialistPool. + operationId: aiplatform.projects.locations.specialistPools.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleCloudAiplatformV1SpecialistPool' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43475,17 +47837,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints: - parameters: *ref_107 - post: - description: Add/update Datapoints into an Index. - operationId: aiplatform.projects.locations.indexes.upsertDatapoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsRequest + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.specialistPools.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43497,8 +47856,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1UpsertDatapointsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43511,21 +47869,22 @@ paths: schema: type: string - in: path - name: indexesId + name: specialistPoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints: - parameters: *ref_107 - post: - description: Remove Datapoints from an Index. - operationId: aiplatform.projects.locations.indexes.removeDatapoints - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsRequest + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.specialistPools.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43537,8 +47896,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveDatapointsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43551,15 +47909,29 @@ paths: schema: type: string - in: path - name: indexesId + name: specialistPoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}: - parameters: *ref_107 - get: - description: Gets an Index. - operationId: aiplatform.projects.locations.indexes.get + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.specialistPools.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43571,7 +47943,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43584,18 +47956,29 @@ paths: schema: type: string - in: path - name: indexesId + name: specialistPoolsId required: true schema: type: string - patch: - description: Updates an Index. - operationId: aiplatform.projects.locations.indexes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Index' + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.specialistPools.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43620,20 +48003,27 @@ paths: schema: type: string - in: path - name: indexesId + name: specialistPoolsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string - in: query - name: updateMask + name: timeout schema: type: string - format: google-fieldmask - delete: + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations: + parameters: *ref_1 + get: description: >- - Deletes an Index. An Index can only be deleted when all its - DeployedIndexes had been undeployed. - operationId: aiplatform.projects.locations.indexes.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.specialistPools.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43645,7 +48035,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -43658,12 +48048,25 @@ paths: schema: type: string - in: path - name: indexesId + name: specialistPoolsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -43675,7 +48078,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.cancel + operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43700,7 +48103,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId required: true schema: type: string @@ -43709,20 +48112,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.wait + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.pipelineJobs.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43747,7 +48144,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId required: true schema: type: string @@ -43756,18 +48153,13 @@ paths: required: true schema: type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations: - parameters: *ref_107 - get: + delete: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.list + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43779,7 +48171,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -43792,31 +48184,29 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}: - parameters: *ref_107 - get: + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.get + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.pipelineJobs.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43841,7 +48231,7 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId required: true schema: type: string @@ -43850,13 +48240,18 @@ paths: required: true schema: type: string - delete: + - in: query + name: timeout + schema: + type: string + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.dataLabelingJobs.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.pipelineJobs.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43868,7 +48263,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -43881,20 +48276,65 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: + parameters: *ref_1 + post: + description: >- + Batch deletes PipelineJobs The Operation is atomic. If it fails, none of + the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs + are deleted. + operationId: aiplatform.projects.locations.pipelineJobs.batchDelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: operationsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}: - parameters: *ref_107 - get: - description: Gets a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.get + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: + parameters: *ref_1 + delete: + description: Deletes a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43906,7 +48346,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -43919,13 +48359,13 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId required: true schema: type: string - delete: - description: Deletes a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.delete + get: + description: Gets a PipelineJob. + operationId: aiplatform.projects.locations.pipelineJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43937,7 +48377,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -43950,21 +48390,30 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: + parameters: *ref_1 post: - description: Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - operationId: aiplatform.projects.locations.dataLabelingJobs.cancel + description: >- + Cancels a PipelineJob. Starts asynchronous cancellation on the + PipelineJob. The server makes a best effort to cancel the pipeline, but + success is not guaranteed. Clients can use + PipelineService.GetPipelineJob or other methods to check whether the + cancellation succeeded or whether the pipeline completed despite + cancellation. On successful cancellation, the PipelineJob is not + deleted; instead it becomes a pipeline with a PipelineJob.error value + with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, + and PipelineJob.state is set to `CANCELLED`. + operationId: aiplatform.projects.locations.pipelineJobs.cancel requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelDataLabelingJobRequest + #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -43989,15 +48438,27 @@ paths: schema: type: string - in: path - name: dataLabelingJobsId + name: pipelineJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs: - parameters: *ref_107 - get: - description: Lists DataLabelingJobs in a Location. - operationId: aiplatform.projects.locations.dataLabelingJobs.list + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: + parameters: *ref_1 + post: + description: >- + Batch cancel PipelineJobs. Firstly the server will check if all the jobs + are in non-terminal states, and skip the jobs that are already + terminated. If the operation failed, none of the pipeline jobs are + cancelled. The server will poll the states of all the pipeline jobs + periodically to check the cancellation status. This operation will + return an LRO. + operationId: aiplatform.projects.locations.pipelineJobs.batchCancel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44009,8 +48470,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListDataLabelingJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44022,36 +48482,16 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: + parameters: *ref_1 post: - description: Creates a DataLabelingJob. - operationId: aiplatform.projects.locations.dataLabelingJobs.create + description: Creates a PipelineJob. A PipelineJob will run immediately when created. + operationId: aiplatform.projects.locations.pipelineJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44063,7 +48503,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1DataLabelingJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' parameters: - in: path name: projectsId @@ -44075,13 +48515,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: - parameters: *ref_107 + - in: query + name: pipelineJobId + schema: + type: string get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list + description: Lists PipelineJobs in a Location. + operationId: aiplatform.projects.locations.pipelineJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44093,7 +48533,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse parameters: - in: path name: projectsId @@ -44105,16 +48546,19 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: filter schema: type: string - - in: path - name: artifactsId - required: true + - in: query + name: orderBy + schema: + type: string + - in: query + name: readMask schema: type: string + format: google-fieldmask - in: query name: pageToken schema: @@ -44124,19 +48568,15 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}: + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete + operationId: aiplatform.projects.locations.featureGroups.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44161,12 +48601,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: featureGroupsId required: true schema: type: string @@ -44180,7 +48615,7 @@ paths: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get + operationId: aiplatform.projects.locations.featureGroups.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44205,12 +48640,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: featureGroupsId required: true schema: type: string @@ -44219,8 +48649,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -44232,7 +48662,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait + operationId: aiplatform.projects.locations.featureGroups.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44257,12 +48687,7 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: artifactsId + name: featureGroupsId required: true schema: type: string @@ -44276,20 +48701,11 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44301,7 +48717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -44314,31 +48730,42 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: operationsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: - parameters: *ref_107 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Purges Artifacts. - operationId: aiplatform.projects.locations.metadataStores.artifacts.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.featureGroups.features.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44363,15 +48790,30 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: - parameters: *ref_107 + - in: path + name: featuresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: google-duration get: - description: Retrieves a specific Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.get + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.listWait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44383,7 +48825,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -44396,18 +48838,41 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - delete: - description: Deletes an Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.delete + - in: path + name: operationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.featureGroups.features.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44432,27 +48897,27 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - - in: query - name: etag + - in: path + name: operationsId + required: true schema: type: string - patch: - description: Updates a stored Artifact. - operationId: aiplatform.projects.locations.metadataStores.artifacts.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.featureGroups.features.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44464,7 +48929,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -44477,34 +48942,25 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: - parameters: *ref_107 - post: - description: Creates an Artifact associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}: + parameters: *ref_1 + get: + description: Gets details of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44516,7 +48972,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' parameters: - in: path name: projectsId @@ -44529,17 +48985,18 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - - in: query - name: artifactId + - in: path + name: featuresId + required: true schema: type: string - get: - description: Lists Artifacts in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.artifacts.list + delete: + description: Deletes a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44551,8 +49008,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44565,35 +49021,23 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: featuresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: - parameters: *ref_107 - get: - description: >- - Retrieves lineage of an Artifact represented through Artifacts and - Executions connected by Event edges and returned as a LineageSubgraph. - operationId: >- - aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph + patch: + description: Updates the parameters of a single Feature. + operationId: aiplatform.projects.locations.featureGroups.features.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44605,7 +49049,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44618,40 +49062,30 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: path - name: artifactsId + name: featuresId required: true schema: type: string - in: query - name: maxHops - schema: - type: integer - format: int32 - - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: - parameters: *ref_107 + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features: + parameters: *ref_1 post: - description: >- - Adds Events to the specified Execution. An Event indicates whether an - Artifact was used as an input or output for an Execution. If an Event - already exists between the Execution and the Artifact, the Event is - skipped. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.addExecutionEvents + description: Creates a new Feature in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1Feature' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44663,8 +49097,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44677,20 +49110,17 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: featureId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: - parameters: *ref_107 get: - description: Lists Executions in the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.list + description: Lists Features in a given FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.features.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44703,7 +49133,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse + #/components/schemas/GoogleCloudAiplatformV1ListFeaturesResponse parameters: - in: path name: projectsId @@ -44716,35 +49146,47 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: query - name: filter + name: readMask schema: type: string + format: google-fieldmask - in: query - name: pageSize + name: latestStatsCount schema: type: integer format: int32 - in: query - name: orderBy + name: filter schema: type: string - in: query name: pageToken schema: type: string - post: - description: Creates an Execution associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.executions.create + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}: + parameters: *ref_1 + patch: + description: Updates the parameters of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44756,7 +49198,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -44769,55 +49211,18 @@ paths: schema: type: string - in: path - name: metadataStoresId + name: featureGroupsId required: true schema: type: string - in: query - name: executionId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: - parameters: *ref_107 - get: - description: Retrieves a specific Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId - required: true + name: updateMask schema: type: string + format: google-fieldmask delete: - description: Deletes an Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.delete + description: Deletes a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44842,78 +49247,17 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: query - name: etag - schema: - type: string - patch: - description: Updates a stored Execution. - operationId: aiplatform.projects.locations.metadataStores.executions.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: featureGroupsId required: true schema: type: string - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: updateMask + name: force schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: - parameters: *ref_107 + type: boolean get: - description: >- - Obtains the set of input and output Artifacts for this Execution, in the - form of LineageSubgraph that also contains the Execution and connecting - Events. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs + description: Gets details of a single FeatureGroup. + operationId: aiplatform.projects.locations.featureGroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44925,7 +49269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' parameters: - in: path name: projectsId @@ -44938,26 +49282,20 @@ paths: schema: type: string - in: path - name: metadataStoresId - required: true - schema: - type: string - - in: path - name: executionsId + name: featureGroupsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/featureGroups: + parameters: *ref_1 post: - description: Purges Executions. - operationId: aiplatform.projects.locations.metadataStores.executions.purge + description: Creates a new FeatureGroup in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1FeatureGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -44981,19 +49319,13 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: featureGroupId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: - parameters: *ref_107 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.get + description: Lists FeatureGroups in a given project and location. + operationId: aiplatform.projects.locations.featureGroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45005,7 +49337,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListFeatureGroupsResponse parameters: - in: path name: projectsId @@ -45017,29 +49350,28 @@ paths: required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: orderBy schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.delete + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: + parameters: *ref_1 + get: + description: Lists MetadataSchemas. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45051,7 +49383,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse parameters: - in: path name: projectsId @@ -45068,30 +49401,27 @@ paths: required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: - parameters: *ref_107 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.wait + description: Creates a MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45103,7 +49433,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -45120,36 +49450,15 @@ paths: required: true schema: type: string - - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - in: query - name: timeout + name: metadataSchemaId schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - aiplatform.projects.locations.metadataStores.executions.operations.cancel + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: + parameters: *ref_1 + get: + description: Retrieves a specific MetadataSchema. + operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45161,7 +49470,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' parameters: - in: path name: projectsId @@ -45179,22 +49488,17 @@ paths: schema: type: string - in: path - name: executionsId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataSchemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.executions.operations.list + operationId: aiplatform.projects.locations.metadataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45223,9 +49527,12 @@ paths: required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string - in: query @@ -45233,19 +49540,54 @@ paths: schema: type: integer format: int32 - - in: query - name: filter + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: - parameters: *ref_107 get: - description: Retrieves a specific Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.metadataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45257,7 +49599,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45275,13 +49617,24 @@ paths: schema: type: string - in: path - name: contextsId + name: operationsId required: true schema: type: string - delete: - description: Deletes a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.delete + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: + parameters: *ref_1 + post: + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.metadataStores.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45311,26 +49664,29 @@ paths: schema: type: string - in: path - name: contextsId + name: operationsId required: true schema: type: string - in: query - name: etag + name: timeout schema: type: string - - in: query - name: force - schema: - type: boolean - patch: - description: Updates a stored Context. - operationId: aiplatform.projects.locations.metadataStores.contexts.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.metadataStores.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45342,7 +49698,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45360,34 +49716,19 @@ paths: schema: type: string - in: path - name: contextsId + name: operationsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: allowMissing - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}: + parameters: *ref_1 + delete: description: >- - Remove a set of children contexts from a parent Context. If any of the - child Contexts were NOT added to the parent Context, they are simply - skipped. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.removeContextChildren - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45399,8 +49740,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45418,25 +49758,21 @@ paths: schema: type: string - in: path - name: contextsId + name: artifactsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: - parameters: *ref_107 - post: + - in: path + name: operationsId + required: true + schema: + type: string + get: description: >- - Adds a set of Artifacts and Executions to a Context. If any of the - Artifacts or Executions have already been added to a Context, they are - simply skipped. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45448,8 +49784,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45467,15 +49802,22 @@ paths: schema: type: string - in: path - name: contextsId + name: artifactsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: - parameters: *ref_107 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations: + parameters: *ref_1 get: - description: Lists Contexts on the MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45487,8 +49829,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -45505,8 +49846,13 @@ paths: required: true schema: type: string + - in: path + name: artifactsId + required: true + schema: + type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -45515,21 +49861,23 @@ paths: type: integer format: int32 - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + name: filter schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: - description: Creates a Context associated with a MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.contexts.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + description: >- + Waits until the specified long-running operation is done or reaches at + most a specified timeout, returning the latest state. If the operation + is already done, the latest state is immediately returned. If the + timeout specified is greater than the default HTTP/RPC timeout, the + HTTP/RPC timeout is used. If the server does not support this method, it + returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a + best-effort basis. It may return the latest state before the specified + timeout (including immediately), meaning even an immediate response is + no guarantee that the operation is done. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45541,7 +49889,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45558,20 +49906,35 @@ paths: required: true schema: type: string + - in: path + name: artifactsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string - in: query - name: contextId + name: timeout schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: - parameters: *ref_107 + format: google-duration + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Purges Contexts. - operationId: aiplatform.projects.locations.metadataStores.contexts.purge - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PurgeContextsRequest' + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: aiplatform.projects.locations.metadataStores.artifacts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45583,7 +49946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -45600,22 +49963,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: - parameters: *ref_107 - post: - description: >- - Adds a set of Contexts as children to a parent Context. If any of the - child Contexts have already been added to the parent Context, they are - simply skipped. If this call would create a cycle or cause any Context - to have more than 10 parents, the request will fail with an - INVALID_ARGUMENT error. - operationId: aiplatform.projects.locations.metadataStores.contexts.addContextChildren - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenRequest + - in: path + name: artifactsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}: + parameters: *ref_1 + get: + description: Retrieves a specific Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45627,8 +49989,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -45646,18 +50007,18 @@ paths: schema: type: string - in: path - name: contextsId + name: artifactsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: - parameters: *ref_107 - get: - description: >- - Retrieves Artifacts and Executions within the specified Context, - connected by Event edges and returned as a LineageSubgraph. - operationId: >- - aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph + patch: + description: Updates a stored Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45669,7 +50030,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -45687,19 +50048,22 @@ paths: schema: type: string - in: path - name: contextsId + name: artifactsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: - parameters: *ref_107 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete + description: Deletes an Artifact. + operationId: aiplatform.projects.locations.metadataStores.artifacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45711,7 +50075,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -45729,21 +50093,25 @@ paths: schema: type: string - in: path - name: contextsId + name: artifactsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: etag schema: type: string - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge: + parameters: *ref_1 + post: + description: Purges Artifacts. + operationId: aiplatform.projects.locations.metadataStores.artifacts.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PurgeArtifactsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45772,30 +50140,14 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel + Retrieves lineage of an Artifact represented through Artifacts and + Executions connected by Event edges and returned as a LineageSubgraph. + operationId: >- + aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45807,7 +50159,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -45825,22 +50177,24 @@ paths: schema: type: string - in: path - name: contextsId + name: artifactsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: maxHops + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list + description: Lists Artifacts in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45852,7 +50206,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListArtifactsResponse parameters: - in: path name: projectsId @@ -45869,17 +50224,16 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true + - in: query + name: filter schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -45887,20 +50241,14 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: - parameters: *ref_107 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait + description: Creates an Artifact associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.artifacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45912,7 +50260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Artifact' parameters: - in: path name: projectsId @@ -45929,23 +50277,12 @@ paths: required: true schema: type: string - - in: path - name: contextsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - in: query - name: timeout + name: artifactId schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -45957,7 +50294,7 @@ paths: cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.metadataStores.operations.cancel + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -45987,60 +50324,17 @@ paths: schema: type: string - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations: - parameters: *ref_107 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: contextsId required: true schema: type: string - in: path - name: metadataStoresId + name: operationsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -46052,7 +50346,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.metadataStores.operations.wait + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46081,6 +50375,11 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -46091,15 +50390,15 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}: + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.metadataStores.operations.delete + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46128,6 +50427,11 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: path name: operationsId required: true @@ -46138,7 +50442,7 @@ paths: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: aiplatform.projects.locations.metadataStores.operations.get + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46168,55 +50472,22 @@ paths: schema: type: string - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas: - parameters: *ref_107 - post: - description: Creates a MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: contextsId required: true schema: type: string - in: path - name: metadataStoresId + name: operationsId required: true schema: type: string - - in: query - name: metadataSchemaId - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations: + parameters: *ref_1 get: - description: Lists MetadataSchemas. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.contexts.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46228,8 +50499,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataSchemasResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -46246,24 +50516,29 @@ paths: required: true schema: type: string + - in: path + name: contextsId + required: true + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query - name: pageToken + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}: - parameters: *ref_107 - get: - description: Retrieves a specific MetadataSchema. - operationId: aiplatform.projects.locations.metadataStores.metadataSchemas.get + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}: + parameters: *ref_1 + delete: + description: Deletes a stored Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46275,7 +50550,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataSchema' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46293,56 +50568,26 @@ paths: schema: type: string - in: path - name: metadataSchemasId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: - parameters: *ref_107 - get: - description: Lists MetadataStores for a Location. - operationId: aiplatform.projects.locations.metadataStores.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: contextsId required: true schema: type: string - in: query - name: pageToken + name: etag schema: type: string - in: query - name: pageSize + name: force schema: - type: integer - format: int32 - post: - description: Initializes a MetadataStore, including allocation of resources. - operationId: aiplatform.projects.locations.metadataStores.create + type: boolean + patch: + description: Updates a stored Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46354,7 +50599,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -46366,48 +50611,28 @@ paths: required: true schema: type: string - - in: query - name: metadataStoreId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: - parameters: *ref_107 - get: - description: Retrieves a specific MetadataStore. - operationId: aiplatform.projects.locations.metadataStores.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' - parameters: - in: path - name: projectsId + name: metadataStoresId required: true schema: type: string - in: path - name: locationsId + name: contextsId required: true schema: type: string - - in: path - name: metadataStoresId - required: true + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask schema: type: string - delete: - description: >- - Deletes a single MetadataStore and all its child resources (Artifacts, - Executions, and Contexts). - operationId: aiplatform.projects.locations.metadataStores.delete + format: google-fieldmask + get: + description: Retrieves a specific Context. + operationId: aiplatform.projects.locations.metadataStores.contexts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46419,7 +50644,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -46436,15 +50661,27 @@ paths: required: true schema: type: string - - in: query - name: force + - in: path + name: contextsId + required: true schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates: - parameters: *ref_107 - get: - description: Lists NotebookRuntimeTemplates in a Location. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.list + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren: + parameters: *ref_1 + post: + description: >- + Adds a set of Contexts as children to a parent Context. If any of the + child Contexts have already been added to the parent Context, they are + simply skipped. If this call would create a cycle or cause any Context + to have more than 10 parents, the request will fail with an + INVALID_ARGUMENT error. + operationId: aiplatform.projects.locations.metadataStores.contexts.addContextChildren + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46457,7 +50694,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse + #/components/schemas/GoogleCloudAiplatformV1AddContextChildrenResponse parameters: - in: path name: projectsId @@ -46469,37 +50706,26 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: metadataStoresId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: contextsId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts: + parameters: *ref_1 post: - description: Creates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.create + description: Creates a Context associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.contexts.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46511,7 +50737,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Context' parameters: - in: path name: projectsId @@ -46523,15 +50749,18 @@ paths: required: true schema: type: string + - in: path + name: metadataStoresId + required: true + schema: + type: string - in: query - name: notebookRuntimeTemplateId + name: contextId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}: - parameters: *ref_107 - delete: - description: Deletes a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.delete + get: + description: Lists Contexts on the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.contexts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46543,7 +50772,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListContextsResponse parameters: - in: path name: projectsId @@ -46556,56 +50786,37 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: metadataStoresId required: true schema: type: string - patch: - description: Updates a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate - parameters: - - in: path - name: projectsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: notebookRuntimeTemplatesId - required: true + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - get: - description: Gets a NotebookRuntimeTemplate. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.get + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge: + parameters: *ref_1 + post: + description: Purges Contexts. + operationId: aiplatform.projects.locations.metadataStores.contexts.purge + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1PurgeContextsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46617,8 +50828,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1NotebookRuntimeTemplate + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -46631,17 +50841,18 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph: + parameters: *ref_1 + get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy + Retrieves Artifacts and Executions within the specified Context, + connected by Event edges and returned as a LineageSubgraph. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46653,7 +50864,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -46666,28 +50877,30 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: metadataStoresId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion + - in: path + name: contextsId + required: true schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy: - parameters: *ref_107 + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren: + parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy + Remove a set of children contexts from a parent Context. If any of the + child Contexts were NOT added to the parent Context, they are simply + skipped. + operationId: >- + aiplatform.projects.locations.metadataStores.contexts.removeContextChildren requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46699,7 +50912,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1RemoveContextChildrenResponse parameters: - in: path name: projectsId @@ -46712,21 +50926,30 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions: - parameters: *ref_107 + - in: path + name: contextsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions: + parameters: *ref_1 post: description: >- - 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. + Adds a set of Artifacts and Executions to a Context. If any of the + Artifacts or Executions have already been added to a Context, they are + simply skipped. operationId: >- - aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions + aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46738,7 +50961,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse parameters: - in: path name: projectsId @@ -46751,19 +50975,31 @@ paths: schema: type: string - in: path - name: notebookRuntimeTemplatesId + name: metadataStoresId required: true schema: type: string - - in: query - name: permissions + - in: path + name: contextsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}: - parameters: *ref_107 - get: - description: Gets a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.get + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents: + parameters: *ref_1 + post: + description: >- + Adds Events to the specified Execution. An Event indicates whether an + Artifact was used as an input or output for an Execution. If an Event + already exists between the Execution and the Artifact, the Event is + skipped. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.addExecutionEvents + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46775,7 +51011,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1AddExecutionEventsResponse parameters: - in: path name: projectsId @@ -46788,13 +51025,24 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - delete: - description: Deletes a PipelineJob. - operationId: aiplatform.projects.locations.pipelineJobs.delete + - in: path + name: executionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs: + parameters: *ref_1 + get: + description: >- + Obtains the set of input and output Artifacts for this Execution, in the + form of LineageSubgraph that also contains the Execution and connecting + Events. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46806,7 +51054,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1LineageSubgraph' parameters: - in: path name: projectsId @@ -46819,15 +51067,20 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs: - parameters: *ref_107 + - in: path + name: executionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions: + parameters: *ref_1 get: - description: Lists PipelineJobs in a Location. - operationId: aiplatform.projects.locations.pipelineJobs.list + description: Lists Executions in the MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46840,7 +51093,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListPipelineJobsResponse + #/components/schemas/GoogleCloudAiplatformV1ListExecutionsResponse parameters: - in: path name: projectsId @@ -46852,36 +51105,36 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: metadataStoresId + required: true schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query - name: pageSize + name: orderBy schema: - type: integer - format: int32 + type: string - in: query - name: readMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 post: - description: Creates a PipelineJob. A PipelineJob will run immediately when created. - operationId: aiplatform.projects.locations.pipelineJobs.create + description: Creates an Execution associated with a MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.executions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46893,7 +51146,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PipelineJob' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -46905,72 +51158,20 @@ paths: required: true schema: type: string - - in: query - name: pipelineJobId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel: - parameters: *ref_107 - post: - description: >- - Cancels a PipelineJob. Starts asynchronous cancellation on the - PipelineJob. The server makes a best effort to cancel the pipeline, but - success is not guaranteed. Clients can use - PipelineService.GetPipelineJob or other methods to check whether the - cancellation succeeded or whether the pipeline completed despite - cancellation. On successful cancellation, the PipelineJob is not - deleted; instead it becomes a pipeline with a PipelineJob.error value - with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, - and PipelineJob.state is set to `CANCELLED`. - operationId: aiplatform.projects.locations.pipelineJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelPipelineJobRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: metadataStoresId required: true schema: type: string - - in: path - name: pipelineJobsId - required: true + - in: query + name: executionId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete: - parameters: *ref_107 - post: - description: >- - Batch deletes PipelineJobs The Operation is atomic. If it fails, none of - the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs - are deleted. - operationId: aiplatform.projects.locations.pipelineJobs.batchDelete - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}: + parameters: *ref_1 + delete: + description: Deletes an Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -46994,54 +51195,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel: - parameters: *ref_107 - post: - description: >- - Batch cancel PipelineJobs. Firstly the server will check if all the jobs - are in non-terminal states, and skip the jobs that are already - terminated. If the operation failed, none of the pipeline jobs are - cancelled. The server will poll the states of all the pipeline jobs - periodically to check the cancellation status. This operation will - return an LRO. - operationId: aiplatform.projects.locations.pipelineJobs.batchCancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: metadataStoresId required: true schema: type: string - in: path - name: locationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}: - parameters: *ref_107 + - in: query + name: etag + schema: + type: string get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.pipelineJobs.operations.get + description: Retrieves a specific Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47053,7 +51223,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -47066,22 +51236,23 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.delete + patch: + description: Updates a stored Execution. + operationId: aiplatform.projects.locations.metadataStores.executions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47093,7 +51264,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1Execution' parameters: - in: path name: projectsId @@ -47106,29 +51277,35 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - in: path - name: operationsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge: + parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.cancel + description: Purges Executions. + operationId: aiplatform.projects.locations.metadataStores.executions.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1PurgeExecutionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47140,7 +51317,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47153,17 +51330,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait: + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -47175,7 +51347,7 @@ paths: best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - operationId: aiplatform.projects.locations.pipelineJobs.operations.wait + operationId: aiplatform.projects.locations.metadataStores.executions.operations.wait security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47200,7 +51372,12 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId + required: true + schema: + type: string + - in: path + name: executionsId required: true schema: type: string @@ -47214,13 +51391,21 @@ paths: schema: type: string format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations: - parameters: *ref_107 - get: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.pipelineJobs.operations.list + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47232,7 +51417,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47245,36 +51430,27 @@ paths: schema: type: string - in: path - name: pipelineJobsId + name: metadataStoresId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause: - parameters: *ref_107 - post: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations: + parameters: *ref_1 + get: description: >- - Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule - is paused, no new runs will be created. Already created runs will NOT be - paused or canceled. - operationId: aiplatform.projects.locations.schedules.pause - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1PauseScheduleRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: aiplatform.projects.locations.metadataStores.executions.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47286,7 +51462,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -47299,15 +51475,38 @@ paths: schema: type: string - in: path - name: schedulesId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}: - parameters: *ref_107 + - in: path + name: executionsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}: + parameters: *ref_1 delete: - description: Deletes a Schedule. - operationId: aiplatform.projects.locations.schedules.delete + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: >- + aiplatform.projects.locations.metadataStores.executions.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47319,7 +51518,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -47332,54 +51531,26 @@ paths: schema: type: string - in: path - name: schedulesId - required: true - schema: - type: string - get: - description: Gets a Schedule. - operationId: aiplatform.projects.locations.schedules.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' - parameters: - - in: path - name: projectsId + name: metadataStoresId required: true schema: type: string - in: path - name: locationsId + name: executionsId required: true schema: type: string - in: path - name: schedulesId + name: operationsId required: true schema: type: string - patch: + get: description: >- - Updates an active or paused Schedule. When the Schedule is updated, new - runs will be scheduled starting from the updated next execution time - after the update time based on the time_specification in the updated - Schedule. All unstarted runs before the update time will be skipped - while already created runs will NOT be paused or canceled. - operationId: aiplatform.projects.locations.schedules.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: aiplatform.projects.locations.metadataStores.executions.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47391,7 +51562,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47404,51 +51575,25 @@ paths: schema: type: string - in: path - name: schedulesId + name: metadataStoresId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/schedules: - parameters: *ref_107 - post: - description: Creates a Schedule. - operationId: aiplatform.projects.locations.schedules.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAiplatformV1Schedule' - parameters: - in: path - name: projectsId + name: executionsId required: true schema: type: string - in: path - name: locationsId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores: + parameters: *ref_1 get: - description: Lists Schedules in a Location. - operationId: aiplatform.projects.locations.schedules.list + description: Lists MetadataStores for a Location. + operationId: aiplatform.projects.locations.metadataStores.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47461,7 +51606,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListSchedulesResponse + #/components/schemas/GoogleCloudAiplatformV1ListMetadataStoresResponse parameters: - in: path name: projectsId @@ -47473,40 +51618,23 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume: - parameters: *ref_107 + - in: query + name: pageToken + schema: + type: string post: - description: >- - Resumes a paused Schedule to start scheduling new runs. Will mark - Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When - the Schedule is resumed, new runs will be scheduled starting from the - next execution time after the current time based on the - time_specification in the Schedule. If Schedule.catchUp is set up true, - all missed runs will be scheduled for backfill first. - operationId: aiplatform.projects.locations.schedules.resume + description: Initializes a MetadataStore, including allocation of resources. + operationId: aiplatform.projects.locations.metadataStores.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ResumeScheduleRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47518,7 +51646,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -47530,19 +51658,17 @@ paths: required: true schema: type: string - - in: path - name: schedulesId - required: true + - in: query + name: metadataStoreId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}: - parameters: *ref_107 - get: + /v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}: + parameters: *ref_1 + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.schedules.operations.get + Deletes a single MetadataStore and all its child resources (Artifacts, + Executions, and Contexts). + operationId: aiplatform.projects.locations.metadataStores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47567,22 +51693,17 @@ paths: schema: type: string - in: path - name: schedulesId + name: metadataStoresId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: force schema: - type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.schedules.operations.delete + type: boolean + get: + description: Retrieves a specific MetadataStore. + operationId: aiplatform.projects.locations.metadataStores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47594,7 +51715,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAiplatformV1MetadataStore' parameters: - in: path name: projectsId @@ -47607,29 +51728,21 @@ paths: schema: type: string - in: path - name: schedulesId - required: true - schema: - type: string - - in: path - name: operationsId + name: metadataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances: + parameters: *ref_1 post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.schedules.operations.wait + description: Evaluates instances based on a given metric. + operationId: aiplatform.projects.locations.evaluateInstances + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47641,7 +51754,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1EvaluateInstancesResponse parameters: - in: path name: projectsId @@ -47653,28 +51767,11 @@ paths: required: true schema: type: string - - in: path - name: schedulesId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - - in: query - name: timeout - schema: - type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations: - parameters: *ref_107 + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.schedules.operations.list + description: Gets information about a location. + operationId: aiplatform.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47686,7 +51783,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudLocationLocation' parameters: - in: path name: projectsId @@ -47698,8 +51795,26 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: aiplatform.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + parameters: - in: path - name: schedulesId + name: projectsId required: true schema: type: string @@ -47716,20 +51831,11 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.schedules.operations.cancel + /v1/datasets/{datasetsId}/datasetVersions: + parameters: *ref_1 + get: + description: Lists DatasetVersions in a Dataset. + operationId: aiplatform.datasets.datasetVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47741,36 +51847,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetVersionsResponse parameters: - in: path - name: projectsId + name: datasetsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: schedulesId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}: - parameters: *ref_107 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.get + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Create a version from a Dataset. + operationId: aiplatform.datasets.datasetVersions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47785,32 +51899,51 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: datasetsId required: true schema: type: string + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}: + parameters: *ref_1 + patch: + description: Updates a DatasetVersion. + operationId: aiplatform.datasets.datasetVersions.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + parameters: - in: path - name: locationsId + name: datasetsId required: true schema: type: string - in: path - name: hyperparameterTuningJobsId + name: datasetVersionsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete + description: Deletes a Dataset version. + operationId: aiplatform.datasets.datasetVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47822,42 +51955,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: datasetsId required: true schema: type: string - in: path - name: locationsId + name: datasetVersionsId required: true schema: type: string + get: + description: Gets a Dataset version. + operationId: aiplatform.datasets.datasetVersions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1DatasetVersion' + parameters: - in: path - name: hyperparameterTuningJobsId + name: datasetsId required: true schema: type: string - in: path - name: operationsId + name: datasetVersionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel: - parameters: *ref_107 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + /v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore: + parameters: *ref_1 + get: + description: Restores a dataset version. + operationId: aiplatform.datasets.datasetVersions.restore security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47869,42 +52014,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: datasetsId required: true schema: type: string - in: path - name: locationsId + name: datasetVersionsId required: true schema: type: string + /v1/datasets/{datasetsId}: + parameters: *ref_1 + patch: + description: Updates a Dataset. + operationId: aiplatform.datasets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + parameters: - in: path - name: hyperparameterTuningJobsId + name: datasetsId required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait: - parameters: *ref_107 - post: - description: >- - Waits until the specified long-running operation is done or reaches at - most a specified timeout, returning the latest state. If the operation - is already done, the latest state is immediately returned. If the - timeout specified is greater than the default HTTP/RPC timeout, the - HTTP/RPC timeout is used. If the server does not support this method, it - returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a - best-effort basis. It may return the latest state before the specified - timeout (including immediately), meaning even an immediate response is - no guarantee that the operation is done. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait + format: google-fieldmask + delete: + description: Deletes a Dataset. + operationId: aiplatform.datasets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47919,37 +52076,41 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId + name: datasetsId required: true schema: type: string + get: + description: Gets a Dataset. + operationId: aiplatform.datasets.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' + parameters: - in: path - name: operationsId + name: datasetsId required: true schema: type: string - in: query - name: timeout + name: readMask schema: type: string - format: google-duration - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations: - parameters: *ref_107 + format: google-fieldmask + /v1/datasets: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.operations.list + description: Lists Datasets in a Location. + operationId: aiplatform.datasets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -47961,27 +52122,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ListDatasetsResponse parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: hyperparameterTuningJobsId - required: true + - in: query + name: parent schema: type: string - in: query - name: pageToken + name: readMask schema: type: string + format: google-fieldmask - in: query name: filter schema: @@ -47991,17 +52147,18 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs: - parameters: *ref_107 + - in: query + name: orderBy + schema: + type: string post: - description: Creates a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.create + description: Creates a Dataset. + operationId: aiplatform.datasets.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleCloudAiplatformV1Dataset' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48013,27 +52170,32 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true + - in: query + name: parent schema: type: string - get: - description: Lists HyperparameterTuningJobs in a Location. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.list + /v1/endpoints/{endpointsId}:streamGenerateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs with streaming support. + operationId: aiplatform.endpoints.streamGenerateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response @@ -48041,57 +52203,23 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: endpointsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel: - parameters: *ref_107 + /v1/endpoints/{endpointsId}:computeTokens: + parameters: *ref_1 post: - description: >- - Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on - the HyperparameterTuningJob. The server makes a best effort to cancel - the job, but success is not guaranteed. Clients can use - JobService.GetHyperparameterTuningJob or other methods to check whether - the cancellation succeeded or whether the job completed despite - cancellation. On successful cancellation, the HyperparameterTuningJob is - not deleted; instead it becomes a job with a - HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is - set to `CANCELLED`. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.cancel + description: Return a list of tokens based on the input text. + operationId: aiplatform.endpoints.computeTokens requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest + $ref: '#/components/schemas/GoogleCloudAiplatformV1ComputeTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48103,28 +52231,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1ComputeTokensResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId + name: endpointsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}: - parameters: *ref_107 - get: - description: Gets a HyperparameterTuningJob - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.get + /v1/endpoints/{endpointsId}:countTokens: + parameters: *ref_1 + post: + description: Perform a token counting. + operationId: aiplatform.endpoints.countTokens + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAiplatformV1CountTokensRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -48137,51 +52261,44 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudAiplatformV1HyperparameterTuningJob + #/components/schemas/GoogleCloudAiplatformV1CountTokensResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId + name: endpointsId required: true schema: type: string - delete: - description: Deletes a HyperparameterTuningJob. - operationId: aiplatform.projects.locations.hyperparameterTuningJobs.delete + /v1/endpoints/{endpointsId}:generateContent: + parameters: *ref_1 + post: + description: Generate content with multimodal inputs. + operationId: aiplatform.endpoints.generateContent + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudAiplatformV1GenerateContentResponse parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: hyperparameterTuningJobsId + name: endpointsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml new file mode 100644 index 00000000..9b591e05 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/airquality.yaml @@ -0,0 +1,1163 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Air Quality API + description: The Air Quality API. + version: v1 + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' +externalDocs: + url: https://developers.google.com/maps/documentation/air-quality +servers: + - url: https://airquality.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + HourlyForecast: + type: object + properties: + healthRecommendations: + $ref: '#/components/schemas/HealthRecommendations' + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + pollutants: + description: >- + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + type: array + items: + $ref: '#/components/schemas/Pollutant' + dateTime: + format: google-datetime + type: string + description: >- + A rounded down timestamp indicating the time (hour) the data refers + to in RFC3339 UTC "Zulu" format. For example: + "2014-10-02T15:00:00Z". + indexes: + type: array + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + `universal_aqi` boolean is set to true. - Local AQI. Will be + returned if the LOCAL_AQI extra computation is specified. + items: + $ref: '#/components/schemas/AirQualityIndex' + id: HourlyForecast + description: >- + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of forecast there + will be 48 elements of hourly forecasts. + Interval: + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + id: Interval + type: object + properties: + startTime: + format: google-datetime + description: >- + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. + type: string + endTime: + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + format: google-datetime + type: string + HttpBody: + id: HttpBody + properties: + contentType: + type: string + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + data: + description: The HTTP request/response body as raw binary. + type: string + format: byte + extensions: + type: array + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + type: object + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + HourInfo: + description: >- + Contains the air quality information for each hour in the requested + range. For example, if the request is for 48 hours of history there will + be 48 elements of hourly info. + type: object + properties: + dateTime: + type: string + format: google-datetime + description: >- + A rounded down timestamp indicating the time the data refers to in + RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine + fractional digits. For example: "2014-10-02T15:00:00Z". + indexes: + items: + $ref: '#/components/schemas/AirQualityIndex' + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. + type: array + healthRecommendations: + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' + pollutants: + description: >- + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + items: + $ref: '#/components/schemas/Pollutant' + type: array + id: HourInfo + LatLng: + properties: + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + format: double + type: number + longitude: + format: double + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + id: LatLng + description: >- + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + type: object + LookupHistoryResponse: + id: LookupHistoryResponse + type: object + properties: + regionCode: + description: >- + Optional. The ISO_3166-1 alpha-2 code of the country/region + corresponding to the location provided in the request. This field + might be omitted from the response if the location provided in the + request resides in a disputed territory. + type: string + hoursInfo: + items: + $ref: '#/components/schemas/HourInfo' + description: >- + Optional. Contains the air quality information for each hour in the + requested range. For example, if the request is for 48 hours of + history there will be 48 elements of hourly info. + type: array + nextPageToken: + type: string + description: Optional. The token to retrieve the next page. + LookupForecastRequest: + type: object + properties: + languageCode: + description: >- + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard (default = + 'en'). + type: string + pageSize: + type: integer + description: >- + Optional. The maximum number of hourly info records to return per + page (default = 24). + format: int32 + period: + description: >- + Indicates the start and end period for which to get the forecast + data. The timestamp is rounded to the previous exact hour. + $ref: '#/components/schemas/Interval' + uaqiColorPalette: + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + type: string + enumDescriptions: + - The default value. Ignored if passed as a parameter. + - Determines whether to use a red/green palette. + - Determines whether to use a indigo/persian palette (dark theme). + - Determines whether to use a indigo/persian palette (light theme). + description: >- + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. + customLocalAqis: + items: + $ref: '#/components/schemas/CustomLocalAqi' + description: >- + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. + type: array + pageToken: + type: string + description: >- + Optional. A page token received from a previous forecast call. It is + used to retrieve the subsequent page. + universalAqi: + description: >- + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response (default = true). + type: boolean + location: + description: >- + Required. The latitude and longitude for which the API looks for air + quality data. + $ref: '#/components/schemas/LatLng' + dateTime: + format: google-datetime + type: string + description: >- + A timestamp for which to return the data for a specific point in + time. The timestamp is rounded to the previous exact hour. Note: + this will return hourly data for the requested timestamp only (i.e. + a single hourly info element). For example, a request sent where the + date_time parameter is set to 2023-01-03T11:05:49Z will be rounded + down to 2023-01-03T11:00:00Z. + extraComputations: + description: >- + Optional. Additional features that can be optionally enabled. + Specifying extra computations will result in the relevant elements + and fields to be returned in the response. + items: + enumDescriptions: + - >- + The default value. The server ignores it if it is passed as a + parameter. + - >- + Determines whether to include the local (national) AQI of the + requested location (country) in the response. If specified, the + response will contain an 'air_quality_index' data structure with + all the relevant data on the location's local AQI. + - >- + Determines whether the response will include the health advice + and recommended actions for the current AQI conditions. The + recommendations are tailored for the general population and six + populations at risk groups with greater sensitivities to + pollutants than the general population. If specified, the + `health_recommendations` field will be populated in the response + when the relevant data is available. + - >- + Determines whether to include in the response the additional + information of each pollutant. If specified, each air quality + index object contained in the 'indexes' field response will + include an `additional_info` field when the data is available. + - >- + Determines whether the response would include the concentrations + of the dominant pollutants measured according to global and/or + local indexes. If the request specified both the global AQI and + the local AQI, there may be up to two pollutant codes returned. + If specified, the dominant pollutant object contained in the + 'pollutants' list will include a `concentration` field when the + data is available. + - >- + Determines whether the response would include the concentrations + of all pollutants with available measurements according to + global and/or local indexes. If specified, each pollutant object + contained in the 'pollutants' field in the response will include + a `concentration` field when the data is available. + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION + type: string + type: array + id: LookupForecastRequest + description: The request object of the air quality forecast API. + Color: + properties: + red: + type: number + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + green: + type: number + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + blue: + type: number + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + alpha: + format: float + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + id: Color + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + type: object + HealthRecommendations: + id: HealthRecommendations + description: >- + Health recommendations for different population groups in a free text + format. The recommendations are derived from their associated air + quality conditions. + properties: + generalPopulation: + type: string + description: No specific sensitivities. + lungDiseasePopulation: + type: string + description: Respiratory related problems and asthma suffers. + pregnantWomen: + type: string + description: Women at all stages of pregnancy. + elderly: + type: string + description: Retirees and people older than the general population. + children: + description: Younger populations including children, toddlers, and babies. + type: string + athletes: + type: string + description: Sports and other strenuous outdoor activities. + heartDiseasePopulation: + description: Heart and circulatory system diseases. + type: string + type: object + CustomLocalAqi: + description: >- + Expresses a 'country/region to AQI' relationship. Pairs a country/region + with a desired AQI so that air quality data that is required for that + country/region will be displayed according to the chosen AQI. + properties: + aqi: + type: string + description: >- + The AQI to associate the country/region with. Value should be a + [valid index](/maps/documentation/air-quality/laqis) code. + regionCode: + type: string + description: >- + The country/region requiring the custom AQI. Value should be + provided using [ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code. + type: object + id: CustomLocalAqi + Pollutant: + properties: + concentration: + description: >- + The pollutant's concentration level measured by one of the standard + air pollutation measure units. + $ref: '#/components/schemas/Concentration' + displayName: + type: string + description: 'The pollutant''s display name. For example: "NOx".' + additionalInfo: + $ref: '#/components/schemas/AdditionalInfo' + description: Additional information about the pollutant. + fullName: + description: >- + The pollutant's full name. For chemical compounds, this is the IUPAC + name. Example: "Sulfur Dioxide". For more information about the + IUPAC names table, see + https://iupac.org/what-we-do/periodic-table-of-elements/. + type: string + code: + type: string + description: >- + The pollutant's code name (for example, "so2"). For a list of + supported pollutant codes, see [Reported + pollutants](/maps/documentation/air-quality/pollutants#reported_pollutants). + id: Pollutant + description: Data regarding an air quality pollutant. + type: object + LookupCurrentConditionsResponse: + id: LookupCurrentConditionsResponse + type: object + properties: + healthRecommendations: + description: >- + Health advice and recommended actions related to the reported air + quality conditions. Recommendations are tailored differently for + populations at risk, groups with greater sensitivities to + pollutants, and the general population. + $ref: '#/components/schemas/HealthRecommendations' + pollutants: + description: >- + A list of pollutants affecting the location specified in the + request. Note: This field will be returned only for requests that + specified one or more of the following extra computations: + POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, + POLLUTANT_CONCENTRATION. + items: + $ref: '#/components/schemas/Pollutant' + type: array + dateTime: + format: google-datetime + description: >- + A rounded down timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. For example: + "2014-10-02T15:00:00Z". + type: string + indexes: + description: >- + Based on the request parameters, this list will include (up to) two + air quality indexes: - Universal AQI. Will be returned if the + universalAqi boolean is set to true. - Local AQI. Will be returned + if the LOCAL_AQI extra computation is specified. + type: array + items: + $ref: '#/components/schemas/AirQualityIndex' + regionCode: + description: >- + The ISO_3166-1 alpha-2 code of the country/region corresponding to + the location provided in the request. This field might be omitted + from the response if the location provided in the request resides in + a disputed territory. + type: string + AdditionalInfo: + properties: + effects: + type: string + description: Text representing the pollutant's main health effects. + sources: + description: Text representing the pollutant's main emission sources. + type: string + description: The emission sources and health effects of a given pollutant. + type: object + id: AdditionalInfo + AirQualityIndex: + id: AirQualityIndex + description: >- + The basic object for representing different air quality metrics. When + brought together, these metrics provide a snapshot about the current air + quality conditions. There are multiple indexes in the world serving + different purposes and groups interested in measuring different aspects + of air quality. + properties: + aqiDisplay: + description: >- + Textual representation of the index numeric score, that may include + prefix or suffix symbols, which usually represents the worst index + score. Example: >100 or 10+. Note: This field should be used when + you want to display the index score. For non-numeric indexes, this + field is empty. + type: string + code: + description: >- + The index's code. This field represents the index for programming + purposes by using snake case instead of spaces. Examples: "uaqi", + "fra_atmo". + type: string + dominantPollutant: + description: 'The chemical symbol of the dominant pollutant. For example: "CO".' + type: string + color: + $ref: '#/components/schemas/Color' + description: The color used to represent the AQI numeric score. + category: + description: >- + Textual classification of the index numeric score interpretation. + For example: "Excellent air quality". + type: string + aqi: + description: ' The index''s numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field.' + type: integer + format: int32 + displayName: + type: string + description: >- + A human readable representation of the index name. Example: "AQI + (US)" + type: object + LookupHistoryRequest: + id: LookupHistoryRequest + properties: + extraComputations: + items: + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION + type: string + enumDescriptions: + - >- + The default value. The server ignores it if it is passed as a + parameter. + - >- + Determines whether to include the local (national) AQI of the + requested location (country) in the response. If specified, the + response will contain an 'air_quality_index' data structure with + all the relevant data on the location's local AQI. + - >- + Determines whether the response will include the health advice + and recommended actions for the current AQI conditions. The + recommendations are tailored for the general population and six + populations at risk groups with greater sensitivities to + pollutants than the general population. If specified, the + `health_recommendations` field will be populated in the response + when the relevant data is available. + - >- + Determines whether to include in the response the additional + information of each pollutant. If specified, each air quality + index object contained in the 'indexes' field response will + include an `additional_info` field when the data is available. + - >- + Determines whether the response would include the concentrations + of the dominant pollutants measured according to global and/or + local indexes. If the request specified both the global AQI and + the local AQI, there may be up to two pollutant codes returned. + If specified, the dominant pollutant object contained in the + 'pollutants' list will include a `concentration` field when the + data is available. + - >- + Determines whether the response would include the concentrations + of all pollutants with available measurements according to + global and/or local indexes. If specified, each pollutant object + contained in the 'pollutants' field in the response will include + a `concentration` field when the data is available. + type: array + description: >- + Optional. Additional features that can be optionally enabled. + Specifying extra computations will result in the relevant elements + and fields to be returned in the response. + pageSize: + description: >- + Optional. The maximum number of hourly info records to return per + page. The default is 72 and the max value is 168 (7 days of data). + format: int32 + type: integer + period: + $ref: '#/components/schemas/Interval' + description: >- + Indicates the start and end period for which to get the historical + data. The timestamp is rounded to the previous exact hour. + hours: + description: >- + Number from 1 to 720 that indicates the hours range for the request. + For example: A value of 48 will yield data from the last 48 hours. + format: int32 + type: integer + languageCode: + description: >- + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard. Default + value is en. + type: string + customLocalAqis: + type: array + items: + $ref: '#/components/schemas/CustomLocalAqi' + description: >- + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. + location: + $ref: '#/components/schemas/LatLng' + description: >- + Required. The latitude and longitude for which the API looks for air + quality history data. + uaqiColorPalette: + description: >- + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + enumDescriptions: + - The default value. Ignored if passed as a parameter. + - Determines whether to use a red/green palette. + - Determines whether to use a indigo/persian palette (dark theme). + - Determines whether to use a indigo/persian palette (light theme). + type: string + pageToken: + type: string + description: >- + Optional. A page token received from a previous history call. It is + used to retrieve the subsequent page. Note that when providing a + value for this parameter all other parameters provided must match + the call that provided the page token (the previous call). + dateTime: + description: >- + A timestamp for which to return historical data. The timestamp is + rounded to the previous exact hour. Note: this will return hourly + data for the requested timestamp only (i.e. a single hourly info + element). For example, a request sent where the dateTime parameter + is set to 2023-01-03T11:05:49Z will be rounded down to + 2023-01-03T11:00:00Z. A timestamp in RFC3339 UTC "Zulu" format, with + nanosecond resolution and up to nine fractional digits. Examples: + "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". + format: google-datetime + type: string + universalAqi: + description: >- + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response. Default value is true. + type: boolean + description: The request object of the air quality history API. + type: object + LookupForecastResponse: + properties: + nextPageToken: + description: Optional. The token to retrieve the next page. + type: string + regionCode: + description: >- + Optional. The ISO_3166-1 alpha-2 code of the country/region + corresponding to the location provided in the request. This field + might be omitted from the response if the location provided in the + request resides in a disputed territory. + type: string + hourlyForecasts: + description: >- + Optional. Contains the air quality information for each hour in the + requested range. For example, if the request is for 48 hours of + forecast there will be 48 elements of hourly forecasts. + items: + $ref: '#/components/schemas/HourlyForecast' + type: array + type: object + description: The response object of the air quality forecast API. + id: LookupForecastResponse + Concentration: + properties: + units: + enum: + - UNIT_UNSPECIFIED + - PARTS_PER_BILLION + - MICROGRAMS_PER_CUBIC_METER + type: string + description: Units for measuring this pollutant concentration. + enumDescriptions: + - Unspecified concentration unit. + - The ppb (parts per billion) concentration unit. + - The "µg/m^3" (micrograms per cubic meter) concentration unit. + value: + description: Value of the pollutant concentration. + format: float + type: number + type: object + description: The concentration of a given pollutant in the air. + id: Concentration + LookupCurrentConditionsRequest: + type: object + properties: + location: + description: >- + Required. The longitude and latitude from which the API looks for + air quality current conditions data. + $ref: '#/components/schemas/LatLng' + customLocalAqis: + items: + $ref: '#/components/schemas/CustomLocalAqi' + description: >- + Optional. Expresses a 'country/region to AQI' relationship. Pairs a + country/region with a desired AQI so that air quality data that is + required for that country/region will be displayed according to the + chosen AQI. This parameter can be used to specify a non-default AQI + for a given country, for example, to get the US EPA index for Canada + rather than the default index for Canada. + type: array + universalAqi: + type: boolean + description: >- + Optional. If set to true, the Universal AQI will be included in the + 'indexes' field of the response. Default value is true. + uaqiColorPalette: + type: string + enum: + - COLOR_PALETTE_UNSPECIFIED + - RED_GREEN + - INDIGO_PERSIAN_DARK + - INDIGO_PERSIAN_LIGHT + enumDescriptions: + - The default value. Ignored if passed as a parameter. + - Determines whether to use a red/green palette. + - Determines whether to use a indigo/persian palette (dark theme). + - Determines whether to use a indigo/persian palette (light theme). + description: >- + Optional. Determines the color palette used for data provided by the + 'Universal Air Quality Index' (UAQI). This color palette is relevant + just for UAQI, other AQIs have a predetermined color palette that + can't be controlled. + languageCode: + description: >- + Optional. Allows the client to choose the language for the response. + If data cannot be provided for that language the API uses the + closest match. Allowed values rely on the IETF standard. Default + value is en. + type: string + extraComputations: + description: >- + Optional. Additional features that can be optionally enabled. + Specifying extra computations will result in the relevant elements + and fields to be returned in the response. + type: array + items: + type: string + enum: + - EXTRA_COMPUTATION_UNSPECIFIED + - LOCAL_AQI + - HEALTH_RECOMMENDATIONS + - POLLUTANT_ADDITIONAL_INFO + - DOMINANT_POLLUTANT_CONCENTRATION + - POLLUTANT_CONCENTRATION + enumDescriptions: + - >- + The default value. The server ignores it if it is passed as a + parameter. + - >- + Determines whether to include the local (national) AQI of the + requested location (country) in the response. If specified, the + response will contain an 'air_quality_index' data structure with + all the relevant data on the location's local AQI. + - >- + Determines whether the response will include the health advice + and recommended actions for the current AQI conditions. The + recommendations are tailored for the general population and six + populations at risk groups with greater sensitivities to + pollutants than the general population. If specified, the + `health_recommendations` field will be populated in the response + when the relevant data is available. + - >- + Determines whether to include in the response the additional + information of each pollutant. If specified, each air quality + index object contained in the 'indexes' field response will + include an `additional_info` field when the data is available. + - >- + Determines whether the response would include the concentrations + of the dominant pollutants measured according to global and/or + local indexes. If the request specified both the global AQI and + the local AQI, there may be up to two pollutant codes returned. + If specified, the dominant pollutant object contained in the + 'pollutants' list will include a `concentration` field when the + data is available. + - >- + Determines whether the response would include the concentrations + of all pollutants with available measurements according to + global and/or local indexes. If specified, each pollutant object + contained in the 'pollutants' field in the response will include + a `concentration` field when the data is available. + description: The request definition of the air quality current conditions. + id: LookupCurrentConditionsRequest + parameters: + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + x-stackQL-resources: + current_conditions: + id: google.airquality.current_conditions + name: current_conditions + title: Current_conditions + methods: + lookup: + operation: + $ref: '#/paths/~1v1~1currentConditions:lookup/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + forecast: + id: google.airquality.forecast + name: forecast + title: Forecast + methods: + lookup: + operation: + $ref: '#/paths/~1v1~1forecast:lookup/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + history: + id: google.airquality.history + name: history + title: History + methods: + lookup: + operation: + $ref: '#/paths/~1v1~1history:lookup/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + heatmap_tiles: + id: google.airquality.heatmap_tiles + name: heatmap_tiles + title: Heatmap_tiles + methods: + lookup_heatmap_tile: + operation: + $ref: >- + #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1/currentConditions:lookup: + parameters: &ref_1 + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + post: + description: >- + The Current Conditions endpoint provides hourly air quality information + in more than 100 countries, up to a 500 x 500 meters resolution. + Includes over 70 local indexes and global air quality index and + categories. + operationId: airquality.currentConditions.lookup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupCurrentConditionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LookupCurrentConditionsResponse' + parameters: [] + /v1/forecast:lookup: + parameters: *ref_1 + post: + description: >- + Returns air quality forecast for a specific location for a given time + range. + operationId: airquality.forecast.lookup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupForecastRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LookupForecastResponse' + parameters: [] + /v1/history:lookup: + parameters: *ref_1 + post: + description: >- + Returns air quality history for a specific location for a given time + range. + operationId: airquality.history.lookup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LookupHistoryRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LookupHistoryResponse' + parameters: [] + /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: + parameters: *ref_1 + get: + description: Returns a bytes array containing the data of the tile PNG image. + operationId: airquality.mapTypes.heatmapTiles.lookupHeatmapTile + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: mapType + required: true + schema: + type: string + - in: path + name: zoom + required: true + schema: + type: string + - in: path + name: x + required: true + schema: + type: string + - in: path + name: 'y' + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml b/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml index 30dd328d..9e97fccb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/alloydb.yaml @@ -18,8 +18,8 @@ info: resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases. version: v1 - x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240828' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/alloydb/ servers: @@ -408,6 +408,23 @@ components: a specific rollout if a maintenance window is set. readOnly: true $ref: '#/components/schemas/MaintenanceSchedule' + subscriptionType: + description: Optional. Subscription type of the cluster. + type: string + enumDescriptions: + - >- + This is an unknown Subscription type (By default, Subscription + Type is STANDARD) + - Standard subscription. + - Trial subscription. + enum: + - SUBSCRIPTION_TYPE_UNSPECIFIED + - STANDARD + - TRIAL + trialMetadata: + description: Output only. Metadata for free trial clusters + readOnly: true + $ref: '#/components/schemas/TrialMetadata' BackupSource: id: BackupSource description: Message describing a BackupSource. @@ -908,6 +925,77 @@ components: readOnly: true type: string format: google-datetime + TrialMetadata: + id: TrialMetadata + description: Contains information and all metadata related to TRIAL clusters. + type: object + properties: + startTime: + description: start time of the trial cluster. + type: string + format: google-datetime + endTime: + description: End time of the trial cluster. + type: string + format: google-datetime + upgradeTime: + description: Upgrade time of trial cluster to Standard cluster. + type: string + format: google-datetime + graceEndTime: + description: grace end time of the cluster. + type: string + format: google-datetime + UpgradeClusterRequest: + id: UpgradeClusterRequest + description: Upgrades a cluster. + type: object + properties: + version: + description: Required. The version the cluster is going to be upgraded to. + type: string + enumDescriptions: + - This is an unknown database version. + - DEPRECATED - The database version is Postgres 13. + - The database version is Postgres 14. + - The database version is Postgres 15. + enumDeprecated: + - false + - true + - false + - false + enum: + - DATABASE_VERSION_UNSPECIFIED + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + validateOnly: + description: >- + Optional. If set, performs request validation (e.g. permission + checks and any other type of validation), but does not actually + execute the upgrade. + type: boolean + etag: + description: >- + Optional. The current etag of the Cluster. If an etag is provided + and does not match the current etag of the Cluster, upgrade will be + blocked and an ABORTED error will be returned. + type: string PromoteClusterRequest: id: PromoteClusterRequest description: Message for promoting a Cluster @@ -940,6 +1028,32 @@ components: checks and any other type of validation), but do not actually execute the delete. type: boolean + SwitchoverClusterRequest: + id: SwitchoverClusterRequest + description: Message for switching over to a cluster + type: object + properties: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + validateOnly: + description: >- + Optional. If set, performs request validation (e.g. permission + checks and any other type of validation), but do not actually + execute the delete. + type: boolean RestoreClusterRequest: id: RestoreClusterRequest description: >- @@ -1234,6 +1348,14 @@ components: networkConfig: description: Optional. Instance level network configuration. $ref: '#/components/schemas/InstanceNetworkConfig' + outboundPublicIpAddresses: + description: >- + Output only. All outbound public IP addresses configured for the + instance. + readOnly: true + type: array + items: + type: string MachineConfig: id: MachineConfig description: MachineConfig describes the configuration of a machine. @@ -1359,6 +1481,11 @@ components: enablePublicIp: description: Optional. Enabling public ip for the instance. type: boolean + enableOutboundPublicIp: + description: >- + Optional. Enabling an outbound public IP address to support a + database server sending requests out into the internet. + type: boolean AuthorizedNetwork: id: AuthorizedNetwork description: AuthorizedNetwork contains metadata for an authorized network. @@ -1453,6 +1580,13 @@ components: checks and any other type of validation), but do not actually execute the restart. type: boolean + nodeIds: + description: >- + Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL + to restart upon. Only applicable for read instances. + type: array + items: + type: string ListBackupsResponse: id: ListBackupsResponse description: Message for response to listing Backups @@ -1865,6 +1999,11 @@ components: - USER_TYPE_UNSPECIFIED - ALLOYDB_BUILT_IN - ALLOYDB_IAM_USER + keepExtraRoles: + description: >- + Input only. If the user already exists and it has additional roles, + keep them granted. + type: boolean GoogleCloudLocationListLocationsResponse: id: GoogleCloudLocationListLocationsResponse description: The response message for Locations.ListLocations. @@ -1955,6 +2094,207 @@ components: description: Output only. API version used to start the operation. readOnly: true type: string + UpgradeClusterResponse: + id: UpgradeClusterResponse + description: >- + UpgradeClusterResponse contains the response for upgrade cluster + operation. + type: object + properties: + status: + description: Status of upgrade operation. + type: string + enumDescriptions: + - Unspecified status. + - Not started. + - In progress. + - Operation succeeded. + - Operation failed. + - Operation partially succeeded. + enum: + - STATUS_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - SUCCESS + - FAILED + - PARTIAL_SUCCESS + message: + description: >- + A user friendly message summarising the upgrade operation details + and the next steps for the user if there is any. + type: string + clusterUpgradeDetails: + description: >- + Array of upgrade details for the current cluster and all the + secondary clusters associated with this cluster. + type: array + items: + $ref: '#/components/schemas/ClusterUpgradeDetails' + ClusterUpgradeDetails: + id: ClusterUpgradeDetails + description: Upgrade details of a cluster. This cluster can be primary or secondary. + type: object + properties: + name: + description: Normalized name of the cluster + type: string + upgradeStatus: + description: Upgrade status of the cluster. + type: string + enumDescriptions: + - Unspecified status. + - Not started. + - In progress. + - Operation succeeded. + - Operation failed. + - Operation partially succeeded. + enum: + - STATUS_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - SUCCESS + - FAILED + - PARTIAL_SUCCESS + clusterType: + description: Cluster type which can either be primary or secondary. + type: string + enumDescriptions: + - The type of the cluster is unknown. + - Primary cluster that support read and write operations. + - >- + Secondary cluster that is replicating from another region. This + only supports read. + enum: + - CLUSTER_TYPE_UNSPECIFIED + - PRIMARY + - SECONDARY + databaseVersion: + description: >- + Database version of the cluster after the upgrade operation. This + will be the target version if the upgrade was successful otherwise + it remains the same as that before the upgrade operation. + type: string + enumDescriptions: + - This is an unknown database version. + - DEPRECATED - The database version is Postgres 13. + - The database version is Postgres 14. + - The database version is Postgres 15. + enumDeprecated: + - false + - true + - false + - false + enum: + - DATABASE_VERSION_UNSPECIFIED + - POSTGRES_13 + - POSTGRES_14 + - POSTGRES_15 + stageInfo: + description: Array containing stage info associated with this cluster. + type: array + items: + $ref: '#/components/schemas/StageInfo' + instanceUpgradeDetails: + description: >- + Upgrade details of the instances directly associated with this + cluster. + type: array + items: + $ref: '#/components/schemas/InstanceUpgradeDetails' + StageInfo: + id: StageInfo + description: Stage information for different stages in the upgrade process. + type: object + properties: + stage: + description: The stage. + type: string + enumDescriptions: + - Unspecified stage. + - Pre-upgrade custom checks, not covered by pg_upgrade. + - Pre-upgrade pg_upgrade checks. + - Clone the original cluster. + - Upgrade the primary instance(downtime). + - This stage is read pool upgrade. + - Rollback in case of critical failures. + - Cleanup. + enum: + - STAGE_UNSPECIFIED + - ALLOYDB_PRECHECK + - PG_UPGRADE_CHECK + - PREPARE_FOR_UPGRADE + - PRIMARY_INSTANCE_UPGRADE + - READ_POOL_INSTANCES_UPGRADE + - ROLLBACK + - CLEANUP + status: + description: Status of the stage. + type: string + enumDescriptions: + - Unspecified status. + - Not started. + - In progress. + - Operation succeeded. + - Operation failed. + - Operation partially succeeded. + enum: + - STATUS_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - SUCCESS + - FAILED + - PARTIAL_SUCCESS + logsUrl: + description: >- + logs_url is the URL for the logs associated with a stage if that + stage has logs. Right now, only three stages have logs: + ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE. + type: string + InstanceUpgradeDetails: + id: InstanceUpgradeDetails + description: Details regarding the upgrade of instaces associated with a cluster. + type: object + properties: + name: + description: Normalized name of the instance. + type: string + upgradeStatus: + description: Upgrade status of the instance. + type: string + enumDescriptions: + - Unspecified status. + - Not started. + - In progress. + - Operation succeeded. + - Operation failed. + - Operation partially succeeded. + enum: + - STATUS_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - SUCCESS + - FAILED + - PARTIAL_SUCCESS + instanceType: + description: Instance type. + type: string + enumDescriptions: + - The type of the instance is unknown. + - PRIMARY instances support read and write operations. + - >- + READ POOL instances support read operations only. Each read pool + instance consists of one or more homogeneous nodes. * Read pool of + size 1 can only have zonal availability. * Read pools with node + count of 2 or more can have regional availability (nodes are + present in 2 or more zones in a region). + - >- + SECONDARY instances support read operations only. SECONDARY + instance is a cross-region read replica + enum: + - INSTANCE_TYPE_UNSPECIFIED + - PRIMARY + - READ_POOL + - SECONDARY StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed: id: StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed description: >- @@ -1998,7 +2338,6 @@ components: $ref: >- #/components/schemas/StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData observabilityMetricData: - description: More feed data would be added in subsequent CLs $ref: >- #/components/schemas/StorageDatabasecenterPartnerapiV1mainObservabilityMetricData StorageDatabasecenterPartnerapiV1mainDatabaseResourceId: @@ -2047,7 +2386,10 @@ components: Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, - spanner.googleapis.com/Instance REQUIRED Please refer + spanner.googleapis.com/Instance, spanner.googleapis.com/Database, + firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, + bigtableadmin.googleapis.com/Cluster, + bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel type: string StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata: @@ -2174,14 +2516,6 @@ components: product: description: The product this resource represents. $ref: '#/components/schemas/StorageDatabasecenterProtoCommonProduct' - userLabels: - description: >- - User-provided labels, represented as a dictionary where each label - is a single key value pair. - deprecated: true - type: object - additionalProperties: - type: string availabilityConfiguration: description: Availability configuration for this instance $ref: >- @@ -2234,6 +2568,7 @@ components: - >- Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum. + - Firestore product area in GCP. enumDeprecated: - false - false @@ -2246,6 +2581,7 @@ components: - false - false - false + - false enum: - PRODUCT_TYPE_UNSPECIFIED - PRODUCT_TYPE_CLOUD_SQL @@ -2258,6 +2594,7 @@ components: - PRODUCT_TYPE_MEMORYSTORE - PRODUCT_TYPE_BIGTABLE - PRODUCT_TYPE_OTHER + - PRODUCT_TYPE_FIRESTORE engine: description: The specific engine that the underlying database is running. type: string @@ -2278,6 +2615,8 @@ components: - >- Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum. + - Firestore with native mode. + - Firestore with datastore mode. enumDeprecated: - false - false @@ -2293,6 +2632,8 @@ components: - false - false - false + - false + - false enum: - ENGINE_UNSPECIFIED - ENGINE_MYSQL @@ -2308,6 +2649,8 @@ components: - ENGINE_MEMORYSTORE_FOR_REDIS - ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER - ENGINE_OTHER + - ENGINE_FIRESTORE_WITH_NATIVE_MODE + - ENGINE_FIRESTORE_WITH_DATASTORE_MODE version: description: >- Version of the underlying database engine. Example values: For @@ -2347,6 +2690,12 @@ components: Checks for resources that are configured to have redundancy, and ongoing replication across regions type: boolean + automaticFailoverRoutingConfigured: + description: >- + Checks for existence of (multi-cluster) routing configuration that + allows automatic failover to a different zone/region in case of an + outage. Applicable to Bigtable resources. + type: boolean StorageDatabasecenterPartnerapiV1mainBackupConfiguration: id: StorageDatabasecenterPartnerapiV1mainBackupConfiguration description: Configuration for automatic backups @@ -2458,22 +2807,28 @@ components: StorageDatabasecenterPartnerapiV1mainCustomMetadataData: id: StorageDatabasecenterPartnerapiV1mainCustomMetadataData description: >- - Any custom metadata associated with the resource. i.e. A spanner + Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data type: object properties: - databaseMetadata: + internalResourceMetadata: + description: >- + Metadata for individual internal resources in an instance. e.g. + spanner instance can have multiple databases with unique + configuration. type: array items: $ref: >- - #/components/schemas/StorageDatabasecenterPartnerapiV1mainDatabaseMetadata - StorageDatabasecenterPartnerapiV1mainDatabaseMetadata: - id: StorageDatabasecenterPartnerapiV1mainDatabaseMetadata + #/components/schemas/StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata + StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata: + id: StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata description: >- - Metadata for individual databases created in an instance. i.e. spanner + Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. + Similarly bigtable can have multiple clusters within same bigtable + instance. type: object properties: resourceId: @@ -2481,8 +2836,9 @@ components: #/components/schemas/StorageDatabasecenterPartnerapiV1mainDatabaseResourceId resourceName: description: >- - Required. Database name. Resource name to follow CAIS resource_name - format as noted here go/condor-common-datamodel + Required. internal resource name for spanner this will be database + name + e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1" type: string product: $ref: '#/components/schemas/StorageDatabasecenterProtoCommonProduct' @@ -2545,11 +2901,15 @@ components: type: object properties: cpuCount: - description: The number of CPUs. + description: >- + The number of CPUs. TODO(b/342344482, b/342346271) add proto + validations again after bug fix. type: integer format: int32 memorySizeInBytes: - description: Memory size in bytes. + description: >- + Memory size in bytes. TODO(b/342344482, b/342346271) add proto + validations again after bug fix. type: string format: int64 StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData: @@ -2661,6 +3021,33 @@ components: - MISCONFIGURATION - OBSERVATION - ERROR + signalSeverity: + description: The severity of the signal, such as if it's a HIGH or LOW severity. + type: string + enumDescriptions: + - >- + This value is used for findings when a source doesn't write a + severity value. + - >- + A critical vulnerability is easily discoverable by an external + actor, exploitable. + - >- + A high risk vulnerability can be easily discovered and exploited + in combination with other vulnerabilities. + - >- + A medium risk vulnerability could be used by an actor to gain + access to resources or privileges that enable them to eventually + gain access and the ability to execute arbitrary code or + exfiltrate data. + - >- + A low risk vulnerability hampers a security organization's ability + to detect vulnerabilities or active threats in their deployment. + enum: + - SIGNAL_SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW compliance: description: >- Industry standards associated with this signal; if this signal is an @@ -2709,9 +3096,19 @@ components: - Represents if a resource violates CIS GCP Foundation 1.2. - Represents if a resource violates CIS GCP Foundation 1.1. - Represents if a resource violates CIS GCP Foundation 1.0. + - Represents if a resource violates CIS Controls 8.0. - Represents if a resource violates NIST 800-53. + - Represents if a resource violates NIST 800-53 R5. + - >- + Represents if a resource violates NIST Cybersecurity Framework + 1.0. - Represents if a resource violates ISO-27001. + - Represents if a resource violates ISO 27001 2022. - Represents if a resource violates PCI-DSS v3.2.1. + - Represents if a resource violates PCI-DSS v4.0. + - Represents if a resource violates Cloud Controls Matrix v4.0. + - Represents if a resource violates HIPAA. + - Represents if a resource violates SOC2 v2017. - >- Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on. @@ -2914,6 +3311,14 @@ components: - false - false - false + - false + - false + - false + - false + - false + - false + - false + - false enum: - SIGNAL_TYPE_UNSPECIFIED - SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER @@ -2930,9 +3335,17 @@ components: - SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2 - SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1 - SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0 + - SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0 - SIGNAL_TYPE_VIOLATES_NIST_800_53 + - SIGNAL_TYPE_VIOLATES_NIST_800_53_R5 + - SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0 - SIGNAL_TYPE_VIOLATES_ISO_27001 + - SIGNAL_TYPE_VIOLATES_ISO_27001_V2022 - SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1 + - SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0 + - SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4 + - SIGNAL_TYPE_VIOLATES_HIPAA + - SIGNAL_TYPE_VIOLATES_SOC2_V2017 - SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING - SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED - SIGNAL_TYPE_VERBOSE_ERROR_LOGGING @@ -3042,9 +3455,19 @@ components: - Represents if a resource violates CIS GCP Foundation 1.2. - Represents if a resource violates CIS GCP Foundation 1.1. - Represents if a resource violates CIS GCP Foundation 1.0. + - Represents if a resource violates CIS Controls 8.0. - Represents if a resource violates NIST 800-53. + - Represents if a resource violates NIST 800-53 R5. + - >- + Represents if a resource violates NIST Cybersecurity Framework + 1.0. - Represents if a resource violates ISO-27001. + - Represents if a resource violates ISO 27001 2022. - Represents if a resource violates PCI-DSS v3.2.1. + - Represents if a resource violates PCI-DSS v4.0. + - Represents if a resource violates Cloud Controls Matrix v4.0. + - Represents if a resource violates HIPAA. + - Represents if a resource violates SOC2 v2017. - >- Represents if log_checkpoints database flag for a Cloud SQL for PostgreSQL instance is not set to on. @@ -3247,6 +3670,14 @@ components: - false - false - false + - false + - false + - false + - false + - false + - false + - false + - false enum: - SIGNAL_TYPE_UNSPECIFIED - SIGNAL_TYPE_NOT_PROTECTED_BY_AUTOMATIC_FAILOVER @@ -3263,9 +3694,17 @@ components: - SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_2 - SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_1 - SIGNAL_TYPE_VIOLATES_CIS_GCP_FOUNDATION_1_0 + - SIGNAL_TYPE_VIOLATES_CIS_CONTROLS_V8_0 - SIGNAL_TYPE_VIOLATES_NIST_800_53 + - SIGNAL_TYPE_VIOLATES_NIST_800_53_R5 + - SIGNAL_TYPE_VIOLATES_NIST_CYBERSECURITY_FRAMEWORK_V1_0 - SIGNAL_TYPE_VIOLATES_ISO_27001 + - SIGNAL_TYPE_VIOLATES_ISO_27001_V2022 - SIGNAL_TYPE_VIOLATES_PCI_DSS_V3_2_1 + - SIGNAL_TYPE_VIOLATES_PCI_DSS_V4_0 + - SIGNAL_TYPE_VIOLATES_CLOUD_CONTROLS_MATRIX_V4 + - SIGNAL_TYPE_VIOLATES_HIPAA + - SIGNAL_TYPE_VIOLATES_SOC2_V2017 - SIGNAL_TYPE_LOGS_NOT_OPTIMIZED_FOR_TROUBLESHOOTING - SIGNAL_TYPE_QUERY_DURATIONS_NOT_LOGGED - SIGNAL_TYPE_VERBOSE_ERROR_LOGGING @@ -3396,23 +3835,68 @@ components: description: Required. Type of metric like CPU, Memory, etc. type: string enumDescriptions: - - '' + - Unspecified metric type. - >- - Peak CPU utilization for a DB instance as a fraction between 0.0 - and 1.0 (may momentarily exceed 1.0 in some cases) List will keep - increasing, e.g. PEAK_MEMORY_UTILISATION, NUMBER_OF_CONNECTIONS, - SUCCESS_RATIO_FOR_QUERIES, etc. + CPU utilization for a resource. The value is a fraction between + 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). + - >- + Memory utilization for a resource. The value is a fraction between + 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). + - Number of network connections for a resource. + - >- + Storage utilization for a resource. The value is a fraction + between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). + - Sotrage used by a resource. enum: - METRIC_TYPE_UNSPECIFIED - - INSTANCE_PEAK_CPU_UTILISATION + - CPU_UTILIZATION + - MEMORY_UTILIZATION + - NETWORK_CONNECTIONS + - STORAGE_UTILIZATION + - STORAGE_USED_BYTES + aggregationType: + description: Required. Type of aggregation performed on the metric. + type: string + enumDescriptions: + - Unspecified aggregation type. + - PEAK aggregation type. + - P99 aggregation type. + - P95 aggregation type. + - current aggregation type. + enum: + - AGGREGATION_TYPE_UNSPECIFIED + - PEAK + - P99 + - P95 + - CURRENT value: description: Required. Value of the metric type. + $ref: '#/components/schemas/StorageDatabasecenterProtoCommonTypedValue' + observationTime: + description: Required. The time the metric value was observed. + type: string + format: google-datetime + StorageDatabasecenterProtoCommonTypedValue: + id: StorageDatabasecenterProtoCommonTypedValue + description: >- + TypedValue represents the value of a metric type. It can either be a + double, an int64, a string or a bool. + type: object + properties: + doubleValue: + description: For double value type: number format: double - metricTimestamp: - description: Required. The timestamp of the metric value. + int64Value: + description: For integer value type: string - format: google-datetime + format: int64 + stringValue: + description: For string value + type: string + boolValue: + description: For boolean value + type: boolean CloudControl2SharedOperationsReconciliationOperationMetadata: id: CloudControl2SharedOperationsReconciliationOperationMetadata description: >- @@ -3532,16 +4016,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3554,23 +4035,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.alloydb.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -3598,6 +4077,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' clusters: @@ -3605,17 +4085,14 @@ components: name: clusters title: Clusters methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clusters - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -3644,6 +4121,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + upgrade: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:upgrade/patch + response: + mediaType: application/json + openAPIDocKey: '200' promote: operation: $ref: >- @@ -3651,6 +4135,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + switchover: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:switchover/post + response: + mediaType: application/json + openAPIDocKey: '200' restore: operation: $ref: >- @@ -3666,6 +4157,7 @@ components: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' update: - $ref: '#/components/x-stackQL-resources/clusters/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' clusters_secondary: @@ -3686,23 +4178,21 @@ components: - $ref: >- #/components/x-stackQL-resources/clusters_secondary/methods/createsecondary update: [] + replace: [] delete: [] instances: id: google.alloydb.instances name: instances title: Instances methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1instances/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -3760,6 +4250,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_secondary: @@ -3780,6 +4271,7 @@ components: - $ref: >- #/components/x-stackQL-resources/instances_secondary/methods/createsecondary update: [] + replace: [] delete: [] instances_connection_info: id: google.alloydb.instances_connection_info @@ -3799,23 +4291,21 @@ components: #/components/x-stackQL-resources/instances_connection_info/methods/get_connection_info insert: [] update: [] + replace: [] delete: [] users: id: google.alloydb.users name: users title: Users methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}~1users/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.users - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -3852,6 +4342,7 @@ components: - $ref: '#/components/x-stackQL-resources/users/methods/create' update: - $ref: '#/components/x-stackQL-resources/users/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/users/methods/delete' backups: @@ -3859,17 +4350,14 @@ components: name: backups title: Backups methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backups/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backups - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -3906,6 +4394,7 @@ components: - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: - $ref: '#/components/x-stackQL-resources/backups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' supported_database_flags: @@ -3913,27 +4402,25 @@ components: name: supported_database_flags title: Supported_database_flags methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1supportedDatabaseFlags/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.supportedDatabaseFlags - list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/supported_database_flags/methods/list insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_15 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3980,7 +4467,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets information about a location. operationId: alloydb.projects.locations.get @@ -4008,7 +4495,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4051,7 +4538,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4122,7 +4609,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4169,7 +4656,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists Clusters in a given project and location. operationId: alloydb.projects.locations.clusters.list @@ -4257,7 +4744,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets details of a single Cluster. operationId: alloydb.projects.locations.clusters.get @@ -4393,8 +4880,46 @@ paths: name: force schema: type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade: + parameters: *ref_1 + patch: + description: Upgrades a single Cluster. Imperative only. + operationId: alloydb.projects.locations.clusters.upgrade + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpgradeClusterRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:promote: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Promotes a SECONDARY cluster. This turns down replication from the @@ -4434,8 +4959,49 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:switchover: + parameters: *ref_1 + post: + description: >- + Switches the role of PRIMARY and SECONDARY cluster without any data + loss. This promotes the SECONDARY cluster to PRIMARY and sets up + original PRIMARY cluster to replicate from this newly promoted cluster. + operationId: alloydb.projects.locations.clusters.switchover + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SwitchoverClusterRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters:restore: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Creates a new Cluster in a given project and location, with a volume @@ -4471,7 +5037,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters:createsecondary: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Creates a cluster of type SECONDARY in the given location using the @@ -4518,7 +5084,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists Instances in a given project and location. operationId: alloydb.projects.locations.clusters.instances.list @@ -4616,7 +5182,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets details of a single Instance. operationId: alloydb.projects.locations.clusters.instances.get @@ -4764,7 +5330,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances:createsecondary: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new SECONDARY Instance in a given project and location. operationId: alloydb.projects.locations.clusters.instances.createsecondary @@ -4814,7 +5380,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:failover: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Forces a Failover for a highly available instance. Failover promotes the @@ -4859,7 +5425,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:injectFault: - parameters: *ref_15 + parameters: *ref_1 post: description: Injects fault in an instance. Imperative only. operationId: alloydb.projects.locations.clusters.instances.injectFault @@ -4902,7 +5468,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:restart: - parameters: *ref_15 + parameters: *ref_1 post: description: Restart an Instance in a cluster. Imperative only. operationId: alloydb.projects.locations.clusters.instances.restart @@ -4945,7 +5511,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}/connectionInfo: - parameters: *ref_15 + parameters: *ref_1 get: description: Get instance metadata used for a connection. operationId: alloydb.projects.locations.clusters.instances.getConnectionInfo @@ -4987,7 +5553,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists Users in a given project and location. operationId: alloydb.projects.locations.clusters.users.list @@ -5085,7 +5651,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets details of a single User. operationId: alloydb.projects.locations.clusters.users.get @@ -5225,7 +5791,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/backups: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists Backups in a given project and location. operationId: alloydb.projects.locations.backups.list @@ -5313,7 +5879,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets details of a single Backup. operationId: alloydb.projects.locations.backups.get @@ -5442,7 +6008,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/supportedDatabaseFlags: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists SupportedDatabaseFlags for a given project and location. operationId: alloydb.projects.locations.supportedDatabaseFlags.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml b/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml index d533cdc6..219d6c89 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/analyticshub.yaml @@ -7,8 +7,8 @@ info: title: Analytics Hub API description: Exchange data and analytics assets securely and efficiently. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240826' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigquery/docs/analytics-hub-introduction servers: @@ -108,6 +108,25 @@ components: Optional. Configurable data sharing environment option for a data exchange. $ref: '#/components/schemas/SharingEnvironmentConfig' + discoveryType: + description: >- + Optional. Type of discovery on the discovery page for all the + listings under this exchange. Updating this field also updates + (overwrites) the discovery_type field for all the listings under + this exchange. + type: string + enumDescriptions: + - Unspecified. Defaults to DISCOVERY_TYPE_PRIVATE. + - >- + The Data exchange/listing can be discovered in the 'Private' + results list. + - >- + The Data exchange/listing can be discovered in the 'Public' + results list. + enum: + - DISCOVERY_TYPE_UNSPECIFIED + - DISCOVERY_TYPE_PRIVATE + - DISCOVERY_TYPE_PUBLIC SharingEnvironmentConfig: id: SharingEnvironmentConfig description: >- @@ -202,6 +221,9 @@ components: bigqueryDataset: description: Required. Shared dataset i.e. BigQuery dataset source. $ref: '#/components/schemas/BigQueryDatasetSource' + pubsubTopic: + description: Required. Pub/Sub topic source. + $ref: '#/components/schemas/PubSubTopicSource' name: description: >- Output only. The resource name of the listing. e.g. @@ -320,6 +342,33 @@ components: Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset. $ref: '#/components/schemas/RestrictedExportConfig' + discoveryType: + description: Optional. Type of discovery of the listing on the discovery page. + type: string + enumDescriptions: + - Unspecified. Defaults to DISCOVERY_TYPE_PRIVATE. + - >- + The Data exchange/listing can be discovered in the 'Private' + results list. + - >- + The Data exchange/listing can be discovered in the 'Public' + results list. + enum: + - DISCOVERY_TYPE_UNSPECIFIED + - DISCOVERY_TYPE_PRIVATE + - DISCOVERY_TYPE_PUBLIC + resourceType: + description: Output only. Listing shared asset type. + readOnly: true + type: string + enumDescriptions: + - Not specified. + - BigQuery Dataset Asset. + - Pub/Sub Topic Asset. + enum: + - SHARED_RESOURCE_TYPE_UNSPECIFIED + - BIGQUERY_DATASET + - PUBSUB_TOPIC BigQueryDatasetSource: id: BigQueryDatasetSource description: >- @@ -338,9 +387,8 @@ components: type: string selectedResources: description: >- - Optional. Resources in this dataset that are selectively shared. If - this field is empty, then the entire dataset (all resources) are - shared. This field is only valid for data clean room exchanges. + Optional. Resource in this dataset that is selectively shared. This + field is required for data clean room exchanges. type: array items: $ref: '#/components/schemas/SelectedResource' @@ -351,7 +399,7 @@ components: $ref: '#/components/schemas/RestrictedExportPolicy' SelectedResource: id: SelectedResource - description: Resource in this dataset that are selectively shared. + description: Resource in this dataset that is selectively shared. type: object properties: table: @@ -380,6 +428,24 @@ components: Optional. If true, restrict export of query result derived from restricted linked dataset table. type: boolean + PubSubTopicSource: + id: PubSubTopicSource + description: Pub/Sub topic source. + type: object + properties: + topic: + description: >- + Required. Resource name of the Pub/Sub topic source for this + listing. e.g. projects/myproject/topics/topicId + type: string + dataAffinityRegions: + description: >- + Optional. Region hint on where the data might be published. Data + affinity regions are modifiable. See go/regions for full listing of + possible Cloud regions. + type: array + items: + type: string DataProvider: id: DataProvider description: Contains details of the data provider. @@ -435,6 +501,11 @@ components: Input only. BigQuery destination dataset to create for the subscriber. $ref: '#/components/schemas/DestinationDataset' + destinationPubsubSubscription: + description: >- + Required. Input only. Destination Pub/Sub subscription to create for + the subscriber. + $ref: '#/components/schemas/DestinationPubSubSubscription' DestinationDataset: id: DestinationDataset description: Defines the destination bigquery dataset. @@ -479,6 +550,583 @@ components: projectId: description: Required. The ID of the project containing this dataset. type: string + DestinationPubSubSubscription: + id: DestinationPubSubSubscription + description: Defines the destination Pub/Sub subscription. + type: object + properties: + pubsubSubscription: + description: Required. Destination Pub/Sub subscription resource. + $ref: '#/components/schemas/GooglePubsubV1Subscription' + GooglePubsubV1Subscription: + id: GooglePubsubV1Subscription + description: >- + A subscription resource. If none of `push_config`, `bigquery_config`, or + `cloud_storage_config` is set, then the subscriber will pull and ack + messages using API methods. At most one of these fields may be set. + type: object + properties: + name: + description: >- + Required. Name of the subscription. Format is + `projects/{project}/subscriptions/{sub}`. + type: string + pushConfig: + description: >- + Optional. If push delivery is used with this subscription, this + field is used to configure it. + $ref: '#/components/schemas/PushConfig' + bigqueryConfig: + description: >- + Optional. If delivery to BigQuery is used with this subscription, + this field is used to configure it. + $ref: '#/components/schemas/BigQueryConfig' + cloudStorageConfig: + description: >- + Optional. If delivery to Google Cloud Storage is used with this + subscription, this field is used to configure it. + $ref: '#/components/schemas/CloudStorageConfig' + ackDeadlineSeconds: + description: >- + Optional. The approximate amount of time (on a best-effort basis) + Pub/Sub waits for the subscriber to acknowledge receipt before + resending the message. In the interval after the message is + delivered and before it is acknowledged, it is considered to be + _outstanding_. During that time period, the message will not be + redelivered (on a best-effort basis). For pull subscriptions, this + value is used as the initial value for the ack deadline. To override + this value for a given message, call `ModifyAckDeadline` with the + corresponding `ack_id` if using non-streaming pull or send the + `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming + pull. The minimum custom deadline you can specify is 10 seconds. The + maximum custom deadline you can specify is 600 seconds (10 minutes). + If this parameter is 0, a default value of 10 seconds is used. For + push delivery, this value is also used to set the request timeout + for the call to the push endpoint. If the subscriber never + acknowledges the message, the Pub/Sub system will eventually + redeliver the message. + type: integer + format: int32 + retainAckedMessages: + description: >- + Optional. Indicates whether to retain acknowledged messages. If + true, then messages are not expunged from the subscription's + backlog, even if they are acknowledged, until they fall out of the + `message_retention_duration` window. This must be true if you would + like to [`Seek` to a timestamp] + (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) + in the past to replay previously-acknowledged messages. + type: boolean + messageRetentionDuration: + description: >- + 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 7 days or less than 10 minutes. + type: string + format: google-duration + labels: + description: >- + Optional. See [Creating and managing + labels](https://cloud.google.com/pubsub/docs/labels). + type: object + additionalProperties: + type: string + enableMessageOrdering: + description: >- + Optional. If true, messages published with the same `ordering_key` + in `PubsubMessage` will be delivered to the subscribers in the order + in which they are received by the Pub/Sub system. Otherwise, they + may be delivered in any order. + type: boolean + expirationPolicy: + description: >- + Optional. A policy that specifies the conditions for this + subscription's expiration. A subscription is considered active as + long as any connected subscriber is successfully consuming messages + from the subscription or is issuing operations on the subscription. + If `expiration_policy` is not set, a *default policy* with `ttl` of + 31 days will be used. The minimum allowed value for + `expiration_policy.ttl` is 1 day. If `expiration_policy` is set, but + `expiration_policy.ttl` is not set, the subscription never expires. + $ref: '#/components/schemas/ExpirationPolicy' + filter: + description: >- + Optional. An expression written in the Pub/Sub [filter + language](https://cloud.google.com/pubsub/docs/filtering). If + non-empty, then only `PubsubMessage`s whose `attributes` field + matches the filter are delivered on this subscription. If empty, + then no messages are filtered out. + type: string + deadLetterPolicy: + description: >- + Optional. A policy that specifies the conditions for dead lettering + messages in this subscription. If dead_letter_policy is not set, + dead lettering is disabled. The Pub/Sub service account associated + with this subscriptions's parent project (i.e., + service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must + have permission to Acknowledge() messages on this subscription. + $ref: '#/components/schemas/DeadLetterPolicy' + retryPolicy: + description: >- + Optional. A policy that specifies how Pub/Sub retries message + delivery for this subscription. If not set, the default retry policy + is applied. This generally implies that messages will be retried as + soon as possible for healthy subscribers. RetryPolicy will be + triggered on NACKs or acknowledgement deadline exceeded events for a + given message. + $ref: '#/components/schemas/RetryPolicy' + detached: + description: >- + Optional. Indicates whether the subscription is detached from its + topic. Detached subscriptions don't receive messages from their + topic and don't retain any backlog. `Pull` and `StreamingPull` + requests will return FAILED_PRECONDITION. If the subscription is a + push subscription, pushes to the endpoint will not be made. + type: boolean + enableExactlyOnceDelivery: + description: >- + Optional. If true, Pub/Sub provides the following guarantees for the + delivery of a message with a given value of `message_id` on this + subscription: * The message sent to a subscriber is guaranteed not + to be resent before the message's acknowledgement deadline expires. + * An acknowledged message will not be resent to a subscriber. Note + that subscribers may still receive multiple copies of a message when + `enable_exactly_once_delivery` is true if the message was published + multiple times by a publisher client. These copies are considered + distinct by Pub/Sub and have distinct `message_id` values. + type: boolean + topicMessageRetentionDuration: + description: >- + Output only. Indicates the minimum duration for which a message is + retained after it is published to the subscription's topic. If this + field is set, messages published to the subscription's topic in the + last `topic_message_retention_duration` are always available to + subscribers. See the `message_retention_duration` field in `Topic`. + This field is set only in responses from the server; it is ignored + if it is set in any requests. + readOnly: true + type: string + format: google-duration + state: + description: >- + Output only. An output-only field indicating whether or not the + subscription can receive messages. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The subscription can actively receive messages + - >- + The subscription cannot receive messages because of an error with + the resource to which it pushes messages. See the more detailed + error state in the corresponding configuration. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - RESOURCE_ERROR + analyticsHubSubscriptionInfo: + description: >- + Output only. Information about the associated Analytics Hub + subscription. Only set if the subscritpion is created by Analytics + Hub. + readOnly: true + $ref: '#/components/schemas/AnalyticsHubSubscriptionInfo' + PushConfig: + id: PushConfig + description: Configuration for a push delivery endpoint. + type: object + properties: + pushEndpoint: + description: >- + Optional. A URL locating the endpoint to which messages should be + pushed. For example, a Webhook endpoint might use + `https://example.com/push`. + type: string + attributes: + description: >- + 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" }` + type: object + additionalProperties: + type: string + oidcToken: + description: >- + Optional. If specified, Pub/Sub will generate and attach an OIDC JWT + token as an `Authorization` header in the HTTP request for every + pushed message. + $ref: '#/components/schemas/OidcToken' + pubsubWrapper: + description: >- + Optional. When set, the payload to the push endpoint is in the form + of the JSON representation of a PubsubMessage + (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). + $ref: '#/components/schemas/PubsubWrapper' + noWrapper: + description: Optional. When set, the payload to the push endpoint is not wrapped. + $ref: '#/components/schemas/NoWrapper' + OidcToken: + id: OidcToken + description: >- + Contains information needed for generating an [OpenID Connect + token](https://developers.google.com/identity/protocols/OpenIDConnect). + type: object + properties: + serviceAccountEmail: + description: >- + Optional. [Service account + email](https://cloud.google.com/iam/docs/service-accounts) used for + generating the OIDC token. For more information on setting up + authentication, see [Push + subscriptions](https://cloud.google.com/pubsub/docs/push). + type: string + audience: + description: >- + Optional. Audience to be used when generating OIDC token. The + audience claim identifies the recipients that the JWT is intended + for. The audience value is a single case-sensitive string. Having + multiple values (array) for the audience field is not supported. + More info about the OIDC JWT token audience here: + https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not + specified, the Push endpoint URL will be used. + type: string + PubsubWrapper: + id: PubsubWrapper + description: >- + The payload to the push endpoint is in the form of the JSON + representation of a PubsubMessage + (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage). + type: object + properties: {} + NoWrapper: + id: NoWrapper + description: Sets the `data` field as the HTTP body for delivery. + type: object + properties: + writeMetadata: + description: >- + Optional. When true, writes the Pub/Sub message metadata to + `x-goog-pubsub-:` headers of the HTTP request. Writes the Pub/Sub + message attributes to `:` headers of the HTTP request. + type: boolean + BigQueryConfig: + id: BigQueryConfig + description: Configuration for a BigQuery subscription. + type: object + properties: + table: + description: >- + Optional. The name of the table to which to write data, of the form + {projectId}.{datasetId}.{tableId} + type: string + useTopicSchema: + description: >- + Optional. When true, use the topic's schema as the columns to write + to in BigQuery, if it exists. `use_topic_schema` and + `use_table_schema` cannot be enabled at the same time. + type: boolean + writeMetadata: + description: >- + Optional. When true, write the subscription name, message_id, + publish_time, attributes, and ordering_key to additional columns in + the table. The subscription name, message_id, and publish_time + fields are put in their own columns while all other message + properties (other than data) are written to a JSON object in the + attributes column. + type: boolean + dropUnknownFields: + description: >- + Optional. When true and use_topic_schema is true, any fields that + are a part of the topic schema that are not part of the BigQuery + table schema are dropped when writing to BigQuery. Otherwise, the + schemas must be kept in sync and any messages with extra fields are + not written and remain in the subscription's backlog. + type: boolean + state: + description: >- + Output only. An output-only field that indicates whether or not the + subscription can receive messages. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The subscription can actively send messages to BigQuery + - >- + Cannot write to the BigQuery table because of permission denied + errors. This can happen if - Pub/Sub SA has not been granted the + [appropriate BigQuery IAM + permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account) + - bigquery.googleapis.com API is not enabled for the project + ([instructions](https://cloud.google.com/service-usage/docs/enable-disable)) + - Cannot write to the BigQuery table because it does not exist. + - Cannot write to the BigQuery table due to a schema mismatch. + - >- + Cannot write to the destination because enforce_in_transit is set + to true and the destination locations are not in the allowed + regions. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - PERMISSION_DENIED + - NOT_FOUND + - SCHEMA_MISMATCH + - IN_TRANSIT_LOCATION_RESTRICTION + useTableSchema: + description: >- + Optional. When true, use the BigQuery table's schema as the columns + to write to in BigQuery. `use_table_schema` and `use_topic_schema` + cannot be enabled at the same time. + type: boolean + serviceAccountEmail: + description: >- + Optional. The service account to use to write to BigQuery. The + subscription creator or updater that specifies this field must have + `iam.serviceAccounts.actAs` permission on the service account. If + not specified, the Pub/Sub [service + agent](https://cloud.google.com/iam/docs/service-agents), + service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is + used. + type: string + CloudStorageConfig: + id: CloudStorageConfig + description: Configuration for a Cloud Storage subscription. + type: object + properties: + bucket: + description: >- + Required. User-provided name for the Cloud Storage bucket. The + bucket must be created by the user. The bucket name must be without + any prefix like "gs://". See the [bucket naming requirements] + (https://cloud.google.com/storage/docs/buckets#naming). + type: string + filenamePrefix: + description: >- + Optional. User-provided prefix for Cloud Storage filename. See the + [object naming + requirements](https://cloud.google.com/storage/docs/objects#naming). + type: string + filenameSuffix: + description: >- + Optional. User-provided suffix for Cloud Storage filename. See the + [object naming + requirements](https://cloud.google.com/storage/docs/objects#naming). + Must not end in "/". + type: string + filenameDatetimeFormat: + description: >- + Optional. User-provided format string specifying how to represent + datetimes in Cloud Storage filenames. See the [datetime format + guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names). + type: string + textConfig: + description: >- + Optional. If set, message data will be written to Cloud Storage in + text format. + $ref: '#/components/schemas/TextConfig' + avroConfig: + description: >- + Optional. If set, message data will be written to Cloud Storage in + Avro format. + $ref: '#/components/schemas/AvroConfig' + maxDuration: + description: >- + Optional. The maximum duration that can elapse before a new Cloud + Storage file is created. Min 1 minute, max 10 minutes, default 5 + minutes. May not exceed the subscription's acknowledgement deadline. + type: string + format: google-duration + maxBytes: + description: >- + Optional. The maximum bytes that can be written to a Cloud Storage + file before a new file is created. Min 1 KB, max 10 GiB. The + max_bytes limit may be exceeded in cases where messages are larger + than the limit. + type: string + format: int64 + maxMessages: + description: >- + Optional. The maximum number of messages that can be written to a + Cloud Storage file before a new file is created. Min 1000 messages. + type: string + format: int64 + state: + description: >- + Output only. An output-only field that indicates whether or not the + subscription can receive messages. + readOnly: true + type: string + enumDescriptions: + - Default value. This value is unused. + - The subscription can actively send messages to Cloud Storage. + - >- + Cannot write to the Cloud Storage bucket because of permission + denied errors. + - >- + Cannot write to the Cloud Storage bucket because it does not + exist. + - >- + Cannot write to the destination because enforce_in_transit is set + to true and the destination locations are not in the allowed + regions. + - >- + Cannot write to the Cloud Storage bucket due to an incompatibility + between the topic schema and subscription settings. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - PERMISSION_DENIED + - NOT_FOUND + - IN_TRANSIT_LOCATION_RESTRICTION + - SCHEMA_MISMATCH + serviceAccountEmail: + description: >- + Optional. The service account to use to write to Cloud Storage. The + subscription creator or updater that specifies this field must have + `iam.serviceAccounts.actAs` permission on the service account. If + not specified, the Pub/Sub [service + agent](https://cloud.google.com/iam/docs/service-agents), + service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is + used. + type: string + TextConfig: + id: TextConfig + description: >- + Configuration for writing message data in text format. Message payloads + will be written to files as raw text, separated by a newline. + type: object + properties: {} + AvroConfig: + id: AvroConfig + description: >- + Configuration for writing message data in Avro format. Message payloads + and metadata will be written to files as an Avro binary. + type: object + properties: + writeMetadata: + description: >- + Optional. When true, write the subscription name, message_id, + publish_time, attributes, and ordering_key as additional fields in + the output. The subscription name, message_id, and publish_time + fields are put in their own fields while all other message + properties other than data (for example, an ordering_key, if + present) are added as entries in the attributes map. + type: boolean + useTopicSchema: + description: >- + Optional. When true, the output Cloud Storage file will be + serialized using the topic schema, if it exists. + type: boolean + ExpirationPolicy: + id: ExpirationPolicy + description: >- + A policy that specifies the conditions for resource expiration (i.e., + automatic resource deletion). + type: object + properties: + ttl: + description: >- + Optional. Specifies the "time-to-live" duration for an associated + resource. The resource expires if it is not active for a period of + `ttl`. The definition of "activity" depends on the type of the + associated resource. The minimum and maximum allowed values for + `ttl` depend on the type of the associated resource, as well. If + `ttl` is not set, the associated resource never expires. + type: string + format: google-duration + DeadLetterPolicy: + id: DeadLetterPolicy + description: >- + Dead lettering is done on a best effort basis. The same message might be + dead lettered multiple times. If validation on any of the fields fails + at subscription creation/updation, the create/update subscription + request will fail. + type: object + properties: + deadLetterTopic: + description: >- + Optional. The name of the topic to which dead letter messages should + be published. Format is `projects/{project}/topics/{topic}`.The + Pub/Sub service account associated with the enclosing subscription's + parent project (i.e., + service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must + have permission to Publish() to this topic. The operation will fail + if the topic does not exist. Users should ensure that there is a + subscription attached to this topic since messages published to a + topic with no subscriptions are lost. + type: string + maxDeliveryAttempts: + description: >- + Optional. The maximum number of delivery attempts for any message. + The value must be between 5 and 100. The number of delivery attempts + is defined as 1 + (the sum of number of NACKs and number of times + the acknowledgement deadline has been exceeded for the message). A + NACK is any call to ModifyAckDeadline with a 0 deadline. Note that + client libraries may automatically extend ack_deadlines. This field + will be honored on a best effort basis. If this parameter is 0, a + default value of 5 is used. + type: integer + format: int32 + RetryPolicy: + id: RetryPolicy + description: >- + A policy that specifies how Pub/Sub retries message delivery. Retry + delay will be exponential based on provided minimum and maximum + backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy + will be triggered on NACKs or acknowledgement deadline exceeded events + for a given message. Retry Policy is implemented on a best effort basis. + At times, the delay between consecutive deliveries may not match the + configuration. That is, delay can be more or less than configured + backoff. + type: object + properties: + minimumBackoff: + description: >- + Optional. The minimum delay between consecutive deliveries of a + given message. Value should be between 0 and 600 seconds. Defaults + to 10 seconds. + type: string + format: google-duration + maximumBackoff: + description: >- + Optional. The maximum delay between consecutive deliveries of a + given message. Value should be between 0 and 600 seconds. Defaults + to 600 seconds. + type: string + format: google-duration + AnalyticsHubSubscriptionInfo: + id: AnalyticsHubSubscriptionInfo + description: >- + Information about an associated Analytics Hub subscription + (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions). + type: object + properties: + listing: + description: >- + Optional. The name of the associated Analytics Hub listing resource. + Pattern: + "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}" + type: string + subscription: + description: >- + Optional. The name of the associated Analytics Hub subscription + resource. Pattern: + "projects/{project}/locations/{location}/subscriptions/{subscription}" + type: string SubscribeListingResponse: id: SubscribeListingResponse description: Message for response when you subscribe to a listing. @@ -568,6 +1216,26 @@ components: description: Output only. Email of the subscriber. readOnly: true type: string + linkedResources: + description: >- + Output only. Linked resources created in the subscription. Only + contains values if state = STATE_ACTIVE. + readOnly: true + type: array + items: + $ref: '#/components/schemas/LinkedResource' + resourceType: + description: Output only. Listing shared asset type. + readOnly: true + type: string + enumDescriptions: + - Not specified. + - BigQuery Dataset Asset. + - Pub/Sub Topic Asset. + enum: + - SHARED_RESOURCE_TYPE_UNSPECIFIED + - BIGQUERY_DATASET + - PUBSUB_TOPIC LinkedResource: id: LinkedResource description: Reference to a linked resource tracked by this Subscription. @@ -579,6 +1247,16 @@ components: projects/subscriberproject/datasets/linked_dataset readOnly: true type: string + linkedPubsubSubscription: + description: >- + Output only. Name of the Pub/Sub subscription, e.g. + projects/subscriberproject/subscriptions/subscriptions/sub_id + readOnly: true + type: string + listing: + description: Output only. Listing for which linked resource is created. + readOnly: true + type: string SubscribeDataExchangeRequest: id: SubscribeDataExchangeRequest description: Message for subscribing to a Data Exchange. @@ -715,7 +1393,7 @@ components: properties: {} RevokeSubscriptionResponse: id: RevokeSubscriptionResponse - description: Message for response when you revoke a subscription. + description: Message for response when you revoke a subscription. Empty for now. type: object properties: {} GetIamPolicyRequest: @@ -1223,17 +1901,14 @@ components: name: data_exchanges title: Data_exchanges methods: - _projects_locations_data_exchanges_list: - operation: &ref_1 + projects_locations_data_exchanges_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataExchanges - projects_locations_data_exchanges_list: - operation: *ref_1 - response: *ref_2 projects_locations_data_exchanges_create: operation: $ref: >- @@ -1269,17 +1944,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_data_exchanges_list: - operation: &ref_3 + organizations_locations_data_exchanges_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1dataExchanges/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataExchanges - organizations_locations_data_exchanges_list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: >- @@ -1294,6 +1966,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/data_exchanges/methods/projects_locations_data_exchanges_delete @@ -1302,40 +1975,35 @@ components: name: data_exchanges_subscriptions title: Data_exchanges_subscriptions methods: - _projects_locations_data_exchanges_list_subscriptions: - operation: &ref_5 + projects_locations_data_exchanges_list_subscriptions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}:listSubscriptions/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sharedResourceSubscriptions - projects_locations_data_exchanges_list_subscriptions: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/data_exchanges_subscriptions/methods/projects_locations_data_exchanges_list_subscriptions insert: [] update: [] + replace: [] delete: [] data_exchanges_iam_policies: id: google.analyticshub.data_exchanges_iam_policies name: data_exchanges_iam_policies title: Data_exchanges_iam_policies methods: - _projects_locations_data_exchanges_get_iam_policy: - operation: &ref_7 + projects_locations_data_exchanges_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}:getIamPolicy/post - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_data_exchanges_get_iam_policy: - operation: *ref_7 - response: *ref_8 projects_locations_data_exchanges_set_iam_policy: operation: $ref: >- @@ -1356,23 +2024,23 @@ components: #/components/x-stackQL-resources/data_exchanges_iam_policies/methods/projects_locations_data_exchanges_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/data_exchanges_iam_policies/methods/projects_locations_data_exchanges_set_iam_policy delete: [] listings: id: google.analyticshub.listings name: listings title: Listings methods: - _projects_locations_data_exchanges_listings_list: - operation: &ref_9 + projects_locations_data_exchanges_listings_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1listings/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.listings - projects_locations_data_exchanges_listings_list: - operation: *ref_9 - response: *ref_10 projects_locations_data_exchanges_listings_create: operation: $ref: >- @@ -1420,6 +2088,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/listings/methods/projects_locations_data_exchanges_listings_delete @@ -1428,40 +2097,35 @@ components: name: listings_subscriptions title: Listings_subscriptions methods: - _projects_locations_data_exchanges_listings_list_subscriptions: - operation: &ref_11 + projects_locations_data_exchanges_listings_list_subscriptions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1listings~1{listingsId}:listSubscriptions/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sharedResourceSubscriptions - projects_locations_data_exchanges_listings_list_subscriptions: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/listings_subscriptions/methods/projects_locations_data_exchanges_listings_list_subscriptions insert: [] update: [] + replace: [] delete: [] listings_iam_policies: id: google.analyticshub.listings_iam_policies name: listings_iam_policies title: Listings_iam_policies methods: - _projects_locations_data_exchanges_listings_get_iam_policy: - operation: &ref_13 + projects_locations_data_exchanges_listings_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataExchanges~1{dataExchangesId}~1listings~1{listingsId}:getIamPolicy/post - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_data_exchanges_listings_get_iam_policy: - operation: *ref_13 - response: *ref_14 projects_locations_data_exchanges_listings_set_iam_policy: operation: $ref: >- @@ -1482,6 +2146,9 @@ components: #/components/x-stackQL-resources/listings_iam_policies/methods/projects_locations_data_exchanges_listings_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/listings_iam_policies/methods/projects_locations_data_exchanges_listings_set_iam_policy delete: [] subscriptions: id: google.analyticshub.subscriptions @@ -1509,17 +2176,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_subscriptions_list: - operation: &ref_15 + projects_locations_subscriptions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1subscriptions/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.subscriptions - projects_locations_subscriptions_list: - operation: *ref_15 - response: *ref_16 projects_locations_subscriptions_revoke: operation: $ref: >- @@ -1535,6 +2199,7 @@ components: #/components/x-stackQL-resources/subscriptions/methods/projects_locations_subscriptions_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/projects_locations_subscriptions_delete @@ -1543,17 +2208,14 @@ components: name: subscriptions_iam_policies title: Subscriptions_iam_policies methods: - _projects_locations_subscriptions_get_iam_policy: - operation: &ref_17 + projects_locations_subscriptions_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1subscriptions~1{subscriptionsId}:getIamPolicy/post - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_subscriptions_get_iam_policy: - operation: *ref_17 - response: *ref_18 projects_locations_subscriptions_set_iam_policy: operation: $ref: >- @@ -1567,10 +2229,13 @@ components: #/components/x-stackQL-resources/subscriptions_iam_policies/methods/projects_locations_subscriptions_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/subscriptions_iam_policies/methods/projects_locations_subscriptions_set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1661,7 +2326,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets the details of a data exchange. operationId: analyticshub.projects.locations.dataExchanges.get @@ -1778,10 +2443,10 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:subscribe: - parameters: *ref_19 + parameters: *ref_1 post: description: >- - Creates a Subscription to a Data Exchange. This is a long-running + Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. operationId: analyticshub.projects.locations.dataExchanges.subscribe requestBody: @@ -1822,7 +2487,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:listSubscriptions: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists all subscriptions on a given Data Exchange or Listing. operationId: analyticshub.projects.locations.dataExchanges.listSubscriptions @@ -1872,7 +2537,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: Gets the IAM policy. operationId: analyticshub.projects.locations.dataExchanges.getIamPolicy @@ -1914,7 +2579,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: Sets the IAM policy. operationId: analyticshub.projects.locations.dataExchanges.setIamPolicy @@ -1956,7 +2621,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: Returns the permissions that a caller has. operationId: analyticshub.projects.locations.dataExchanges.testIamPermissions @@ -1998,7 +2663,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists all listings in a given project and location. operationId: analyticshub.projects.locations.dataExchanges.listings.list @@ -2088,7 +2753,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets the details of a listing. operationId: analyticshub.projects.locations.dataExchanges.listings.get @@ -2220,7 +2885,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:subscribe: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Subscribes to a listing. Currently, with Analytics Hub, you can create @@ -2271,7 +2936,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:listSubscriptions: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists all subscriptions on a given Data Exchange or Listing. operationId: analyticshub.projects.locations.dataExchanges.listings.listSubscriptions @@ -2326,7 +2991,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: Gets the IAM policy. operationId: analyticshub.projects.locations.dataExchanges.listings.getIamPolicy @@ -2373,7 +3038,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: Sets the IAM policy. operationId: analyticshub.projects.locations.dataExchanges.listings.setIamPolicy @@ -2420,7 +3085,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}/listings/{listingsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: Returns the permissions that a caller has. operationId: >- @@ -2468,7 +3133,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:refresh: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Refreshes a Subscription to a Data Exchange. A Data Exchange can become @@ -2513,7 +3178,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets the details of a Subscription. operationId: analyticshub.projects.locations.subscriptions.get @@ -2585,7 +3250,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/subscriptions: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists all subscriptions in a given project and location. operationId: analyticshub.projects.locations.subscriptions.list @@ -2630,7 +3295,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:revoke: - parameters: *ref_19 + parameters: *ref_1 post: description: Revokes a given subscription. operationId: analyticshub.projects.locations.subscriptions.revoke @@ -2672,7 +3337,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: Gets the IAM policy. operationId: analyticshub.projects.locations.subscriptions.getIamPolicy @@ -2714,7 +3379,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: Sets the IAM policy. operationId: analyticshub.projects.locations.subscriptions.setIamPolicy @@ -2756,7 +3421,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/dataExchanges: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists all data exchanges from projects in a given organization and diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml index 5ad234a0..4fdd0ed8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigateway.yaml @@ -7,8 +7,8 @@ info: title: API Gateway API description: '' version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240814' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/api-gateway/docs servers: @@ -990,16 +990,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1012,23 +1009,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.apigateway.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1056,6 +1051,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' gateways: @@ -1063,17 +1059,14 @@ components: name: gateways title: Gateways methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gateways/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.gateways - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1110,6 +1103,7 @@ components: - $ref: '#/components/x-stackQL-resources/gateways/methods/create' update: - $ref: '#/components/x-stackQL-resources/gateways/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/gateways/methods/delete' gateways_iam_policies: @@ -1124,17 +1118,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gateways~1{gatewaysId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -1148,23 +1139,23 @@ components: #/components/x-stackQL-resources/gateways_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/gateways_iam_policies/methods/set_iam_policy delete: [] apis: id: google.apigateway.apis name: apis title: Apis methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apis - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -1201,6 +1192,7 @@ components: - $ref: '#/components/x-stackQL-resources/apis/methods/create' update: - $ref: '#/components/x-stackQL-resources/apis/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/apis/methods/delete' apis_iam_policies: @@ -1215,17 +1207,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -1239,23 +1228,23 @@ components: #/components/x-stackQL-resources/apis_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/apis_iam_policies/methods/set_iam_policy delete: [] configs: id: google.apigateway.configs name: configs title: Configs methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1configs/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiConfigs - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: >- @@ -1292,6 +1281,7 @@ components: - $ref: '#/components/x-stackQL-resources/configs/methods/create' update: - $ref: '#/components/x-stackQL-resources/configs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/configs/methods/delete' configs_iam_policies: @@ -1306,17 +1296,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_15 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1configs~1{configsId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_15 - response: *ref_16 test_iam_permissions: operation: $ref: >- @@ -1330,10 +1317,13 @@ components: #/components/x-stackQL-resources/configs_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/configs_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_17 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1380,7 +1370,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about a location. operationId: apigateway.projects.locations.get @@ -1408,7 +1398,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1451,7 +1441,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1522,7 +1512,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1569,7 +1559,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gateways: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists Gateways in a given project and location. operationId: apigateway.projects.locations.gateways.list @@ -1649,7 +1639,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single Gateway. operationId: apigateway.projects.locations.gateways.get @@ -1754,7 +1744,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -1795,7 +1785,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -1835,7 +1825,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -1878,7 +1868,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists Apis in a given project and location. operationId: apigateway.projects.locations.apis.list @@ -1958,7 +1948,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single Api. operationId: apigateway.projects.locations.apis.get @@ -2063,7 +2053,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:setIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2104,7 +2094,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:getIamPolicy: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2144,7 +2134,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2187,7 +2177,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/configs: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists ApiConfigs in a given project and location. operationId: apigateway.projects.locations.apis.configs.list @@ -2277,7 +2267,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/configs/{configsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single ApiConfig. operationId: apigateway.projects.locations.apis.configs.get @@ -2401,7 +2391,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/configs/{configsId}:setIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2447,7 +2437,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/configs/{configsId}:getIamPolicy: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2492,7 +2482,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/configs/{configsId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml index 9b702194..1c14b3a0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigee.yaml @@ -12,8 +12,8 @@ info: more. Note: This product is available as a free trial for a time period of 60 days. version: v1 - x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/apigee-api-management/ servers: @@ -39,8691 +39,8693 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudApigeeV1DeveloperSubscription: - description: Structure of a DeveloperSubscription. + GoogleCloudApigeeV1CanaryEvaluationMetricLabels: + id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels + description: Labels that can be used to filter Apigee metrics. + type: object properties: - createdAt: - description: >- - Output only. Time when the API product subscription was created in - milliseconds since epoch. - readOnly: true - type: string - format: int64 - name: - readOnly: true - description: Output only. Name of the API product subscription. - type: string - startTime: - description: >- - Time when the API product subscription starts in milliseconds since - epoch. - format: int64 + instance_id: type: string - apiproduct: description: >- - Name of the API product for which the developer is purchasing a - subscription. + Required. The instance ID associated with the metrics. In Apigee + Hybrid, the value is configured during installation. + env: type: string - endTime: - format: int64 + description: The environment ID associated with the metrics. + location: type: string - description: >- - Time when the API product subscription ends in milliseconds since - epoch. - lastModifiedAt: + description: Required. The location associated with the metrics. + GoogleCloudApigeeV1TraceSamplingConfig: + id: GoogleCloudApigeeV1TraceSamplingConfig + type: object + description: >- + TraceSamplingConfig represents the detail settings of distributed + tracing. Only the fields that are defined in the distributed trace + configuration can be overridden using the distribute trace configuration + override APIs. + properties: + sampler: + enumDescriptions: + - Sampler unspecified. + - >- + OFF means distributed trace is disabled, or the sampling + probability is 0. + - >- + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + description: Sampler of distributed tracing. OFF is the default value. + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY type: string + samplingRate: + format: float + type: number description: >- - Output only. Time when the API product subscription was last - modified in milliseconds since epoch. - format: int64 - readOnly: true - id: GoogleCloudApigeeV1DeveloperSubscription - type: object - GoogleCloudApigeeV1KeyValueMap: - id: GoogleCloudApigeeV1KeyValueMap + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + GoogleCloudApigeeV1ReferenceConfig: type: object - description: Collection of key/value string pairs. properties: - encrypted: - type: boolean + resourceName: description: >- - Required. Flag that specifies whether entry values will be - encrypted. This field is retained for backward compatibility and the - value of encrypted will always be `true`. Apigee X and hybrid do not - support unencrypted key value maps. - name: - type: string - description: Required. ID of the key value map. - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: - properties: - environment: + Name of the referenced resource in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` Only + references to keystore resources are supported. type: string + name: description: >- - Destination environment. This will be empty if the route is not yet - reported. - basepath: - description: Base path in the routing table. - type: string - percentage: - format: int32 - description: Percentage of ingress replicas reporting this route. - type: integer - envgroup: - description: Environment group where this route is installed. + Name of the reference in the following format: + `organizations/{org}/environments/{env}/references/{reference}` type: string - description: Route deployed in the ingress routing table. - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + id: GoogleCloudApigeeV1ReferenceConfig + GoogleCloudApigeeV1DocumentationFile: + id: GoogleCloudApigeeV1DocumentationFile type: object - GoogleCloudApigeeV1GraphqlDocumentation: - id: GoogleCloudApigeeV1GraphqlDocumentation + description: Documentation file contents for a catalog item. properties: - endpointUri: + contents: type: string - description: >- - Required. The GraphQL endpoint URI to be queried by API consumers. - Max length is 2,083 characters. - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - description: Required. The documentation file contents for the GraphQL schema. - description: GraphQL documentation for a catalog item. - type: object - GoogleCloudApigeeV1SecurityReport: - id: GoogleCloudApigeeV1SecurityReport - properties: + description: Required. The file contents. The max size is 4 MB. + format: byte displayName: + description: >- + Required. A display name for the file, shown in the management UI. + Max length is 255 characters. type: string - description: Display Name specified by the user. - updated: - description: Output only. Last updated timestamp for the query. + GoogleCloudApigeeV1NatAddress: + properties: + state: readOnly: true type: string - created: - description: Creation time of the query. - type: string - error: - description: Error is set when query fails. - type: string - executionTime: + description: Output only. State of the nat address. + enum: + - STATE_UNSPECIFIED + - CREATING + - RESERVED + - ACTIVE + - DELETING + enumDescriptions: + - The resource is in an unspecified state. + - The NAT address is being created. + - The NAT address is reserved but not yet used for Internet egress. + - The NAT address is active and used for Internet egress. + - The NAT address is being deleted. + ipAddress: + readOnly: true type: string - description: ExecutionTime is available only after the query is completed. - envgroupHostname: - description: Hostname is available only when query is executed at host level. + description: Output only. The static IPV4 address. + name: type: string - resultFileSize: + description: Required. Resource ID of the NAT address. + id: GoogleCloudApigeeV1NatAddress + description: >- + Apigee NAT(network address translation) address. A NAT address is a + static external IP address used for Internet egress traffic. + type: object + GoogleCloudApigeeV1Organization: + properties: + lastModifiedAt: + description: >- + Output only. Time that the Apigee organization was last modified in + milliseconds since epoch. + readOnly: true + format: int64 type: string - description: ResultFileSize is available only after the query is completed. - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' - description: Result is available only after the query is completed. - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + subscriptionPlan: + readOnly: true + enumDescriptions: + - Subscription plan not specified. + - Traditional subscription plan. + - >- + New subscription plan that provides standard proxy and scaled + proxy implementation. + enum: + - SUBSCRIPTION_PLAN_UNSPECIFIED + - SUBSCRIPTION_2021 + - SUBSCRIPTION_2024 description: >- - Contains information like metrics, dimenstions etc of the Security - Report. - self: + Output only. Subscription plan that the customer has purchased. + Output only. type: string + portalDisabled: + type: boolean + description: Configuration for the Portals settings. + caCertificate: + readOnly: true description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - reportDefinitionId: + Output only. Base64-encoded public certificate for the root CA of + the Apigee organization. Valid only when [RuntimeType](#RuntimeType) + is `CLOUD`. + format: byte type: string - description: Report Definition ID. - state: + disableVpcPeering: + type: boolean description: >- - Query state could be "enqueued", "running", "completed", "expired" - and "failed". + Optional. Flag that specifies whether the VPC Peering through + Private Google Access should be disabled between the consumer + network and Apigee. Valid only when RuntimeType is set to CLOUD. + Required if an authorizedNetwork on the consumer project is not + provided, in which case the flag should be set to true. The value + must be set before the creation of any Apigee runtime instance and + can be updated only when there are no runtime instances. **Note:** + Apigee will be deprecating the vpc peering model that requires you + to provide 'authorizedNetwork', by making the non-peering model as + the default way of provisioning Apigee organization in future. So, + this will be a temporary flag to enable the transition. Not + supported for Apigee hybrid. + apiConsumerDataLocation: + description: >- + This field is needed only for customers using non-default data + residency regions. Apigee stores some control plane data only in + single region. This field determines which single region Apigee + should use. For example: "us-west1" when control plane is in US or + "europe-west2" when control plane is in EU. type: string - resultRows: - description: ResultRows is available only after the query is completed. - format: int64 + analyticsRegion: + deprecated: true type: string - type: object - description: >- - SecurityReport saves all the information about the created security - report. - GoogleCloudApigeeV1QueryTabularStatsRequest: - properties: - dimensions: - description: Required. List of dimension names to group the aggregations by. - items: - type: string - type: array - pageToken: - type: string - description: Identifies a sequence of rows. - filter: description: >- - Filter further on specific dimension values. Follows the same - grammar as custom report's filter expressions. Example, apiproxy eq - 'foobar'. - https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters + Required. DEPRECATED: This field will eventually be deprecated and + replaced with a differently-named field. Primary Google Cloud region + for analytics data storage. For valid values, see [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + billingType: type: string - metrics: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - description: Required. List of metrics and their aggregations. - timeRange: - description: Time range for the stats. - $ref: '#/components/schemas/GoogleTypeInterval' - pageSize: - description: Page size represents the number of rows. - format: int32 - type: integer - id: GoogleCloudApigeeV1QueryTabularStatsRequest - description: >- - Request payload representing the query to be run for fetching security - statistics as rows. - type: object - GoogleIamV1AuditConfig: - properties: - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - service: + enum: + - BILLING_TYPE_UNSPECIFIED + - SUBSCRIPTION + - EVALUATION + - PAYG description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. + Billing type of the Apigee organization. See [Apigee + pricing](https://cloud.google.com/apigee/pricing). + enumDescriptions: + - Billing type not specified. + - A pre-paid subscription to Apigee. + - Free and limited access to Apigee for evaluation purposes only. + - Access to Apigee using a Pay-As-You-Go plan. + authorizedNetwork: type: string - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - id: GoogleIamV1AuditConfig - type: object - GoogleCloudApigeeV1Attribute: - properties: - name: + description: >- + Compute Engine network used for Service Networking to be peered with + Apigee runtime instances. See [Getting started with the Service + Networking + API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). + Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The + value must be set before the creation of a runtime instance and can + be updated only when there are no runtime instances. For example: + `default`. Apigee also supports shared VPC (that is, the host + network project is not the same as the one that is peering with + Apigee). See [Shared VPC + overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a + shared VPC network, use the following format: + `projects/{host-project-id}/{region}/networks/{network-name}`. For + example: `projects/my-sharedvpc-host/global/networks/mynetwork` + **Note:** Not supported for Apigee hybrid. + controlPlaneEncryptionKeyName: + description: >- + Cloud KMS key name used for encrypting control plane data that is + stored in a multi region. Only used for the data residency region + "US" or "EU". If not specified or [BillingType](#BillingType) is + `EVALUATION`, a Google-Managed encryption key will be used. Format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*` type: string - description: API key of the attribute. - value: - description: Value of the attribute. + runtimeDatabaseEncryptionKeyName: + description: >- + Cloud KMS key name used for encrypting the data that is stored and + replicated across runtime instances. Update is not allowed after the + organization is created. If not specified or + [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption + key will be used. For example: + "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** + Not supported for Apigee hybrid. type: string - description: Key-value pair to store extra metadata. - id: GoogleCloudApigeeV1Attribute - type: object - GoogleCloudApigeeV1RuntimeTraceConfig: - description: >- - NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed - trace in an environment. - type: object - properties: - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - description: Trace configuration for all API proxies in an environment. - endpoint: + expiresAt: type: string - description: Endpoint of the exporter. - revisionCreateTime: + readOnly: true + description: >- + Output only. Time that the Apigee organization is scheduled for + deletion. + format: int64 + runtimeType: type: string - format: google-datetime - description: The timestamp that the revision was created or updated. - overrides: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' + enumDescriptions: + - Runtime type not specified. + - Google-managed Apigee runtime. + - User-managed Apigee hybrid runtime. + description: >- + Required. Runtime type of the Apigee organization based on the + Apigee subscription purchased. + enum: + - RUNTIME_TYPE_UNSPECIFIED + - CLOUD + - HYBRID + environments: type: array - description: List of trace configuration overrides for spicific API proxies. - name: + description: Output only. List of environments in the Apigee organization. + readOnly: true + items: + type: string + type: + description: Not used by Apigee. + enum: + - TYPE_UNSPECIFIED + - TYPE_TRIAL + - TYPE_PAID + - TYPE_INTERNAL type: string + enumDescriptions: + - Subscription type not specified. + - >- + Subscription to Apigee is free, limited, and used for evaluation + purposes only. + - >- + Full subscription to Apigee has been purchased. See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + - For internal users only. + displayName: description: >- - Name of the trace config in the following format: - `organizations/{org}/environment/{env}/traceConfig` - revisionId: + Display name for the Apigee organization. Unused, but reserved for + future use. type: string + apiConsumerDataEncryptionKeyName: description: >- - Revision number which can be used by the runtime to detect if the - trace config has changed between two versions. - exporter: - description: >- - Exporter that is used to view the distributed trace captured using - OpenCensus. An exporter sends traces to any backend that is capable - of consuming them. Recorded spans can be exported by registered - exporters. - enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE + Cloud KMS key name used for encrypting API consumer data. If not + specified or [BillingType](#BillingType) is `EVALUATION`, a + Google-Managed encryption key will be used. Format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*` type: string - id: GoogleCloudApigeeV1RuntimeTraceConfig - GoogleCloudApigeeV1AccessRemove: - properties: name: type: string - success: - type: boolean - description: >- - Remove action. For example, "Remove" : { "name" : "target.name", - "success" : true } - type: object - id: GoogleCloudApigeeV1AccessRemove - GoogleCloudApigeeV1IntegrationConfig: - type: object - id: GoogleCloudApigeeV1IntegrationConfig - description: Configuration for the Integration add-on. - properties: - enabled: - description: Flag that specifies whether the Integration add-on is enabled. - type: boolean - GoogleCloudApigeeV1KeyAliasReference: - type: object - properties: - reference: + description: Output only. Name of the Apigee organization. + readOnly: true + properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + description: Properties defined in the Apigee organization profile. + projectId: + readOnly: true type: string + description: Output only. Project ID associated with the Apigee organization. + description: + type: string + description: Description of the Apigee organization. + state: + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + readOnly: true + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING description: >- - Reference name in the following format: - `organizations/{org}/environments/{env}/references/{reference}` - aliasId: + Output only. State of the organization. Values other than ACTIVE + means the resource is not ready to use. type: string - description: Alias ID. Must exist in the keystore referred to by the reference. - id: GoogleCloudApigeeV1KeyAliasReference - GoogleCloudApigeeV1ApiSecurityRuntimeConfig: - type: object - id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig - description: >- - Response for - GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. - properties: - updateTime: + customerName: + description: Not used by Apigee. type: string - description: Time that the API Security Runtime configuration was updated. - format: google-datetime - uid: + apigeeProjectId: description: >- - Unique ID for the API Security Runtime configuration. The ID will - only change if the environment is deleted and recreated. + Output only. Apigee Project ID associated with the organization. Use + this project to allowlist Apigee in the Service Attachment when + using private service connect with Apigee. type: string - location: + readOnly: true + attributes: type: array items: type: string - description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. - revisionId: - description: >- - Revision ID of the API Security Runtime configuration. The higher - the value, the more recently the configuration was deployed. + description: Not used by Apigee. + subscriptionType: + deprecated: true + readOnly: true type: string - format: int64 - name: + enumDescriptions: + - Subscription type not specified. + - Full subscription to Apigee has been purchased. + - >- + Subscription to Apigee is free, limited, and used for evaluation + purposes only. + enum: + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAID + - TRIAL description: >- - Name of the environment API Security Runtime configuration resource. - Format: - `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` + Output only. DEPRECATED: This will eventually be replaced by + BillingType. Subscription type of the Apigee organization. Valid + values include trial (free, limited, and for evaluation purposes + only) or paid (full subscription has been purchased). See [Apigee + pricing](https://cloud.google.com/apigee/pricing/). + addonsConfig: + description: Addon configurations of the Apigee organization. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + createdAt: + description: >- + Output only. Time that the Apigee organization was created in + milliseconds since epoch. + format: int64 type: string - GoogleCloudApigeeV1Certificate: - type: object - properties: - certInfo: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' - type: array - description: Chain of certificates under this name. - id: GoogleCloudApigeeV1Certificate - GoogleCloudApigeeV1ProfileConfigAuthorization: + readOnly: true + id: GoogleCloudApigeeV1Organization type: object - properties: {} - id: GoogleCloudApigeeV1ProfileConfigAuthorization - description: >- - By default, following policies will be included: - JWS - JWT - OAuth - - BasicAuth - APIKey - GoogleCloudApigeeV1Operation: - id: GoogleCloudApigeeV1Operation + GoogleCloudApigeeV1Query: properties: - resource: - description: >- - Required. REST resource path associated with the API proxy or remote - service. - type: string - methods: + dimensions: type: array description: >- - methods refers to the REST verbs as in - https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none - specified, all verb types are allowed. + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions items: type: string - description: >- - Represents the pairing of REST resource path and the actions (verbs) - allowed on the resource path. - type: object - GoogleCloudApigeeV1SecurityActionDeny: - description: Message that should be set in case of a Deny Action. - type: object - id: GoogleCloudApigeeV1SecurityActionDeny - properties: - responseCode: - description: Optional. The HTTP response code if the Action = DENY. - format: int32 + limit: + description: Maximum number of rows that can be returned in the result. type: integer - GoogleCloudApigeeV1OrganizationProjectMapping: - id: GoogleCloudApigeeV1OrganizationProjectMapping - properties: - projectId: - description: Google Cloud project associated with the Apigee organization - type: string - organization: - description: Name of the Apigee organization. - type: string - projectIds: - type: array - deprecated: true - items: - type: string - description: >- - DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a - single project. - location: - description: >- - Output only. The Google Cloud region where control plane data is - located. For more information, see - https://cloud.google.com/about/locations/. + format: int32 + csvDelimiter: type: string - readOnly: true - type: object - GoogleCloudApigeeV1DebugSessionTransaction: - properties: - point: - type: array - description: >- - List of debug data collected by runtime plane at various defined - points in the flow. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Point' - completed: - description: Flag indicating whether a transaction is completed or not - type: boolean - type: object - description: >- - A transaction contains all of the debug information of the entire - message flow of an API call processed by the runtime plane. The - information is collected and recorded at critical points of the message - flow in the runtime apiproxy. - id: GoogleCloudApigeeV1DebugSessionTransaction - GoogleCloudApigeeV1DeveloperApp: - id: GoogleCloudApigeeV1DeveloperApp - properties: - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes for the developer app. - type: array - lastModifiedAt: - readOnly: true - format: int64 description: >- - Output only. Time the developer app was modified in milliseconds - since epoch. + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + envgroupHostname: type: string - scopes: - items: - type: string - type: array description: >- - Scopes to apply to the developer app. The specified scopes must - already exist for the API product that you associate with the - developer app. - developerId: + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostAsyncQuery where analytics data will be grouped by + organization and hostname. + filter: type: string - description: ID of the developer. - credentials: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' description: >- - Output only. Set of credentials for the developer app consisting of - the consumer key/secret pairs associated with the API products. - readOnly: true - status: + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax + outputFormat: type: string description: >- - Status of the credential. Valid values include `approved` or - `revoked`. + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. name: - description: Name of the developer app. - type: string - callbackUrl: type: string + description: Asynchronous Query Name. + timeRange: description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to developer apps. - apiProducts: + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + type: any + metrics: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' + description: A list of Metrics. type: array - description: List of API products associated with the developer app. - appFamily: - type: string - description: Developer app family. - appId: - description: ID of the developer app. - type: string - createdAt: - description: >- - Output only. Time the developer app was created in milliseconds - since epoch. - format: int64 + groupByTimeUnit: type: string - readOnly: true - keyExpiresIn: description: >- - Expiration time, in milliseconds, for the consumer key that is - generated for the developer app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. - format: int64 + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. + reportDefinitionId: type: string + description: Asynchronous Report ID. type: object - GoogleCloudApigeeV1OperationConfig: - id: GoogleCloudApigeeV1OperationConfig + id: GoogleCloudApigeeV1Query + GoogleCloudApigeeV1OperationGroup: description: >- - Binds the resources in an API proxy or remote service with the allowed - REST methods and associated quota enforcement. + List of operation configuration details associated with Apigee API + proxies or remote services. Remote services are non-Apigee proxies, such + as Istio-Envoy. + type: object properties: - quota: - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + operationConfigType: + type: string description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. - operations: + Flag that specifes whether the configuration is for Apigee API proxy + or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. + operationConfigs: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + type: array description: >- - List of resource/method pairs for the API proxy or remote service to - which quota will applied. **Note**: Currently, you can specify only - a single resource/method pair. The call will fail if more than one - resource/method pair is provided. + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. + id: GoogleCloudApigeeV1OperationGroup + GoogleCloudApigeeV1Score: + description: Represents Security Score. + id: GoogleCloudApigeeV1Score + type: object + properties: + component: + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + description: Component containing score, recommendations and actions. + subcomponents: type: array + description: List of all the drilldown score components. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' - apiSource: + $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + timeRange: + description: Start and end time for the score. + $ref: '#/components/schemas/GoogleTypeInterval' + GoogleCloudApigeeV1ScoreComponent: + type: object + properties: + scorePath: + description: >- + Path of the component. Example: + /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy type: string + score: + type: integer + format: int32 + description: Score for the component. + dataCaptureTime: + format: google-datetime description: >- - Required. Name of the API proxy or remote service with which the - resources, methods, and quota are associated. - attributes: - description: Custom attributes associated with the operation. + Time in the requested time period when data was last captured to + compute the score. + type: string + calculateTime: + type: string + description: Time when score was calculated. + format: google-datetime + recommendations: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation type: array - type: object - GoogleCloudApigeeV1ArchiveDeployment: + description: List of recommendations to improve API security. + drilldownPaths: + type: array + items: + type: string + description: List of paths for next components. + id: GoogleCloudApigeeV1ScoreComponent + description: Component is an individual security element that is scored. + GoogleCloudApigeeV1Attribute: properties: + value: + description: Value of the attribute. + type: string name: - description: >- - Name of the Archive Deployment in the following format: - `organizations/{org}/environments/{env}/archiveDeployments/{id}`. type: string - operation: - readOnly: true - description: >- - Output only. A reference to the LRO that created this Archive - Deployment in the following format: - `organizations/{org}/operations/{id}` + description: API key of the attribute. + description: Key-value pair to store extra metadata. + id: GoogleCloudApigeeV1Attribute + type: object + GoogleRpcPreconditionFailure: + properties: + violations: + type: array + items: + $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' + description: Describes all precondition violations. + type: object + description: >- + Describes what preconditions have failed. For example, if an RPC failed + because it required the Terms of Service to be acknowledged, it could + list the terms of service violation in the PreconditionFailure message. + id: GoogleRpcPreconditionFailure + GoogleCloudApigeeV1AsyncQuery: + properties: + error: type: string - labels: - additionalProperties: - type: string - description: >- - User-supplied key-value pairs used to organize ArchiveDeployments. - Label keys must be between 1 and 63 characters long, have a UTF-8 - encoding of maximum 128 bytes, and must conform to the following - PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be - between 1 and 63 characters long, have a UTF-8 encoding of maximum - 128 bytes, and must conform to the following PCRE regular - expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can - be associated with a given store. - type: object - updatedAt: - description: >- - Output only. The time at which the Archive Deployment was updated in - milliseconds since the epoch. + description: Error is set when query fails. + reportDefinitionId: type: string - readOnly: true - format: int64 - createdAt: + description: Asynchronous Report ID. + state: + type: string + description: Query state could be "enqueued", "running", "completed", "failed". + resultRows: + description: ResultRows is available only after the query is completed. format: int64 - readOnly: true + type: string + executionTime: + type: string + description: ExecutionTime is available only after the query is completed. + self: type: string description: >- - Output only. The time at which the Archive Deployment was created in - milliseconds since the epoch. - gcsUri: + Self link of the query. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + envgroupHostname: + type: string + description: Hostname is available only when query is executed at host level. + created: + type: string + description: Creation time of the query. + result: + description: Result is available only after the query is completed. + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' + queryParams: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' description: >- - Input only. The Google Cloud Storage signed URL returned from - GenerateUploadUrl and used to upload the Archive zip file. + Contains information like metrics, dimenstions etc of the + AsyncQuery. + name: type: string + description: Asynchronous Query Name. + resultFileSize: + description: ResultFileSize is available only after the query is completed. + type: string + updated: + description: Last updated timestamp for the query. + type: string + id: GoogleCloudApigeeV1AsyncQuery type: object - id: GoogleCloudApigeeV1ArchiveDeployment - description: Archive Deployment information. - GoogleCloudApigeeV1DebugMask: - type: object + GoogleCloudApigeeV1ExportRequest: + id: GoogleCloudApigeeV1ExportRequest + description: Request body for [CreateExportRequest] properties: - requestXPaths: - items: - type: string - type: array + csvDelimiter: + type: string description: >- - List of XPaths that specify the XML elements to be filtered from XML - request message payloads. - responseXPaths: + Optional. Delimiter used in the CSV file, if `outputFormat` is set + to `csv`. Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + name: + type: string + description: Required. Display name of the export job. + outputFormat: + type: string description: >- - List of XPaths that specify the XML elements to be filtered from XML - response message payloads. + Optional. Output format of the export. Valid values include: `csv` + or `json`. Defaults to `json`. Note: Configure the delimiter for CSV + output using the `csvDelimiter` property. + dateRange: + description: Required. Date range of the data to export. + $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' + datastoreName: + type: string + description: Required. Name of the preconfigured datastore. + description: + type: string + description: Optional. Description of the export job. + type: object + GoogleCloudApigeeV1ReportInstanceStatusRequest: + id: GoogleCloudApigeeV1ReportInstanceStatusRequest + description: Request for ReportInstanceStatus. + type: object + properties: + resources: + description: Status for config resources type: array items: - type: string - faultJSONPaths: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' + reportTime: description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON payloads in error flows. + The time the report was generated in the runtime. Used to prevent an + old status from overwriting a newer one. An instance should space + out it's status reports so that clock skew does not play a factor. + type: string + format: google-datetime + instanceUid: + type: string + description: >- + A unique ID for the instance which is guaranteed to be unique in + case the user installs multiple hybrid runtimes with the same + instance ID. + GoogleCloudApigeeV1QueryTabularStatsRequest: + description: >- + Request payload representing the query to be run for fetching security + statistics as rows. + type: object + id: GoogleCloudApigeeV1QueryTabularStatsRequest + properties: + dimensions: items: type: string type: array - requestJSONPaths: - type: array - items: - type: string - description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON request message payloads. - faultXPaths: + description: Required. List of dimension names to group the aggregations by. + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + description: Time range for the stats. + filter: + type: string description: >- - List of XPaths that specify the XML elements to be filtered from XML - payloads in error flows. + Filter further on specific dimension values. Follows the same + grammar as custom report's filter expressions. Example, apiproxy eq + 'foobar'. + https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters + pageSize: + format: int32 + type: integer + description: Page size represents the number of rows. + metrics: + description: Required. List of metrics and their aggregations. items: - type: string - type: array - variables: - description: List of variables that should be masked from the debug output. + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' type: array - items: - type: string - namespaces: - type: object - additionalProperties: - type: string - description: Map of namespaces to URIs. - name: - description: Name of the debug mask. + pageToken: + description: Identifies a sequence of rows. type: string - responseJSONPaths: - items: - type: string - description: >- - List of JSON paths that specify the JSON elements to be filtered - from JSON response message payloads. - type: array - id: GoogleCloudApigeeV1DebugMask - GoogleCloudApigeeV1TlsInfo: + GoogleCloudApigeeV1SecurityReportQuery: + type: object properties: - enabled: - type: boolean - description: >- - Required. Enables TLS. If false, neither one-way nor two-way TLS - will be enabled. - keyAlias: + reportDefinitionId: + type: string + description: Report Definition ID. + envgroupHostname: type: string description: >- - Required if `client_auth_enabled` is true. The resource ID for the - alias containing the private key and cert. - commonName: - description: The TLS Common Name of the certificate. - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' - ciphers: + Hostname needs to be specified if query intends to run at host + level. This field is only allowed when query is submitted by + CreateHostSecurityReport where analytics data will be grouped by + organization and hostname. + limit: + format: int32 + type: integer + description: Maximum number of rows that can be returned in the result. + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' + description: A list of Metrics. type: array + dimensions: description: >- - The SSL/TLS cipher suites to be used. For programmable proxies, it - must be one of the cipher suite names listed in: - http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. - For configurable proxies, it must follow the configuration specified - in: - https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. - This setting has no effect for configurable proxies when negotiating - TLS 1.3. + A list of dimensions. + https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + type: array items: type: string - trustStore: - description: The resource ID of the truststore. + groupByTimeUnit: type: string - enforce: - description: TLS is strictly enforced. - type: boolean - ignoreValidationErrors: - type: boolean description: >- - If true, Edge ignores TLS certificate errors. Valid when configuring - TLS for target servers and target endpoints, and when configuring - virtual hosts that use 2-way TLS. When used with a target - endpoint/target server, if the backend system uses SNI and returns a - cert with a subject Distinguished Name (DN) that does not match the - hostname, there is no way to ignore the error and the connection - fails. - keyStore: + Time unit used to group the result set. Valid values include: + second, minute, hour, day, week, or month. If a query includes + groupByTimeUnit, then the result is an aggregation based on the + specified time unit and the resultant timestamp does not include + milliseconds precision. If a query omits groupByTimeUnit, then the + resultant timestamp includes milliseconds precision. + mimeType: + type: string description: >- - Required if `client_auth_enabled` is true. The resource ID of the - keystore. + Valid values include: `csv` or `json`. Defaults to `json`. Note: + Configure the delimiter for CSV output using the csvDelimiter + property. + timeRange: + description: >- + Required. Time range for the query. Can use the following predefined + strings to specify the time range: `last60minutes` `last24hours` + `last7days` Or, specify the timeRange as a structure describing + start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. + Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": + "2018-08-01T00:18:00Z" } + type: any + csvDelimiter: type: string - clientAuthEnabled: - description: Optional. Enables two-way TLS. - type: boolean - protocols: - description: The TLS versioins to be used. - items: - type: string - type: array - description: TLS configuration information for virtual hosts and TargetServers. - type: object - id: GoogleCloudApigeeV1TlsInfo - GoogleCloudApigeeV1ListOrganizationsResponse: - type: object - id: GoogleCloudApigeeV1ListOrganizationsResponse - properties: - organizations: - description: List of Apigee organizations and associated Google Cloud projects. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' - type: array - GoogleCloudApigeeV1UpdateSecurityIncidentRequest: - type: object - description: Request for UpdateSecurityIncident. - id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest - properties: - updateMask: description: >- - Required. The list of fields to update. Allowed fields are: - LINT.IfChange(allowed_update_fields_comment) - observability - LINT.ThenChange() - format: google-fieldmask + Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + Defaults to the `,` (comma) character. Supported delimiter + characters include comma (`,`), pipe (`|`), and tab (`\t`). + filter: type: string - securityIncident: description: >- - Required. The security incident to update. Must contain all existing - populated fields of the current incident. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - GoogleCloudApigeeV1GetSyncAuthorizationRequest: - description: Request for GetSyncAuthorization. - type: object - id: GoogleCloudApigeeV1GetSyncAuthorizationRequest - properties: {} - GoogleCloudApigeeV1OASDocumentation: + Boolean expression that can be used to filter data. Filter + expressions can be combined using AND/OR terms and should be fully + parenthesized to avoid ambiguity. See Analytics metrics, dimensions, + and filters reference + https://docs.apigee.com/api-platform/analytics/analytics-reference + for more information on the fields available to filter on. For more + information on the tokens that you use to build filter expressions, + see Filter expression syntax. + https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax + displayName: + type: string + description: Security Report display name which users can specify. + id: GoogleCloudApigeeV1SecurityReportQuery + description: Body structure when user makes a request to create a security report. + GoogleCloudApigeeV1TestDatastoreResponse: properties: - format: - enum: - - FORMAT_UNSPECIFIED - - YAML - - JSON + error: readOnly: true - enumDescriptions: - - The format is not available. - - YAML format. - - JSON format. + description: Output only. Error message of test connection failure type: string - description: Output only. The format of the input specification file contents. - spec: - $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' - description: >- - Required. The documentation file contents for the OpenAPI - Specification. JSON and YAML file formats are supported. - description: OpenAPI Specification documentation for a catalog item. - id: GoogleCloudApigeeV1OASDocumentation + state: + type: string + description: Output only. It could be `completed` or `failed` + readOnly: true + id: GoogleCloudApigeeV1TestDatastoreResponse type: object - GoogleCloudApigeeV1OptimizedStatsResponse: - properties: - TimeUnit: - type: array - items: - type: string - format: int64 - description: >- - List of time unit values. Time unit refers to an epoch timestamp - value. - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - description: Metadata information about the query executed. - stats: - description: '`stats` results.' - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' - resultTruncated: - type: boolean - description: >- - Boolean flag that indicates whether the results were truncated based - on the limit parameter. - id: GoogleCloudApigeeV1OptimizedStatsResponse + description: The response for TestDatastore + GoogleCloudApigeeV1RuntimeTraceConfigOverride: + id: GoogleCloudApigeeV1RuntimeTraceConfigOverride + description: >- + NEXT ID: 7 Trace configuration override for a specific API proxy in an + environment. type: object - description: Encapsulates a response format for JavaScript Optimized Scenario. - GoogleCloudApigeeV1DateRange: - description: Date range of the data to export. - id: GoogleCloudApigeeV1DateRange properties: - end: + name: description: >- - Required. End date (exclusive) of the data to export in the format - `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- - which will not be in the output. + Name of the trace config override in the following format: + `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` type: string - start: + samplingConfig: description: >- - Required. Start date of the data to export in the format - `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start - date. + Trace configuration override for a specific API proxy in an + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + revisionCreateTime: + description: The timestamp that the revision was created or updated. + format: google-datetime type: string - type: object - GoogleCloudApigeeV1Session: - description: Session carries the debug session id and its creation time. - properties: - id: + revisionId: type: string - description: The debug session ID. - timestampMs: - format: int64 + description: >- + Revision number which can be used by the runtime to detect if the + trace config override has changed between two versions. + uid: type: string description: >- - The first transaction creation timestamp in millisecond, recorded by - UAP. - type: object - id: GoogleCloudApigeeV1Session - GoogleCloudApigeeV1QueryMetric: + Unique ID for the configuration override. The ID will only change if + the override is deleted and recreated. Corresponds to name's + "override" field. + apiProxy: + description: >- + Name of the API proxy that will have its trace configuration + overridden following format: `organizations/{org}/apis/{api}` + type: string + GoogleCloudApigeeV1AppGroupApp: + description: >- + Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], + [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and + [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] + id: GoogleCloudApigeeV1AppGroupApp properties: - function: - description: 'Aggregation function: avg, min, max, or sum.' + createdAt: + readOnly: true + format: int64 + description: >- + Output only. Time the AppGroup app was created in milliseconds since + epoch. type: string - value: + apiProducts: + type: array + description: List of API products associated with the AppGroup app. + items: + type: string + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + description: List of attributes for the AppGroup app. + keyExpiresIn: + format: int64 + description: >- + Immutable. Expiration time, in seconds, for the consumer key that is + generated for the AppGroup app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. + type: string + appGroup: + type: string + description: >- + Immutable. Name of the parent AppGroup whose resource name format is + of syntax (organizations/*/appgroups/*). + credentials: + description: >- + Output only. Set of credentials for the AppGroup app consisting of + the consumer key/secret pairs associated with the API products. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + readOnly: true + scopes: + items: + type: string + type: array + description: >- + Scopes to apply to the AppGroup app. The specified scopes must + already exist for the API product that you associate with the + AppGroup app. + status: + description: Status of the App. Valid values include `approved` or `revoked`. type: string - description: Operand value should be provided when operator is set. name: type: string - description: Required. Metric name. - operator: + description: >- + Immutable. Name of the AppGroup app whose resource name format is of + syntax (organizations/*/appgroups/*/apps/*). + lastModifiedAt: + readOnly: true + format: int64 + description: >- + Output only. Time the AppGroup app was modified in milliseconds + since epoch. type: string - description: One of `+`, `-`, `/`, `%`, `*`. - alias: + callbackUrl: description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to AppGroup apps. + type: string + appId: type: string + description: Immutable. ID of the AppGroup app. type: object - id: GoogleCloudApigeeV1QueryMetric - description: >- - More info about Metric: - https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + GoogleCloudApigeeV1SecurityActionDeny: + id: GoogleCloudApigeeV1SecurityActionDeny + description: Message that should be set in case of a Deny Action. properties: - text: - type: string - description: 'The text of the url. (ie: "Learn more")' - uri: - type: string - description: The link itself. + responseCode: + type: integer + description: Optional. The HTTP response code if the Action = DENY. + format: int32 + type: object + GoogleRpcStatus: type: object - description: The format for a link in the recommendation. - GoogleCloudApigeeV1GraphQLOperationGroup: - id: GoogleCloudApigeeV1GraphQLOperationGroup description: >- - List of graphQL operation configuration details associated with Apigee - API proxies or remote services. Remote services are non-Apigee proxies, - such as Istio-Envoy. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus properties: - operationConfigs: - type: array + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + message: + type: string description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. - operationConfigType: + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + GoogleCloudApigeeV1SecurityAssessmentResult: + properties: + createTime: type: string + format: google-datetime description: >- - Flag that specifies whether the configuration is for Apigee API - proxy or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. + The time of the assessment of this resource. This could lag behind + `assessment_time` due to caching within the backend. + resource: + description: The assessed resource. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The error status if scoring fails. + scoringResult: + description: The result of the assessment. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult type: object - GoogleCloudApigeeV1ListHybridIssuersResponse: + description: The security assessment result for one resource. + id: GoogleCloudApigeeV1SecurityAssessmentResult + GoogleCloudApigeeV1AnalyticsConfig: + description: Configuration for the Analytics add-on. + id: GoogleCloudApigeeV1AnalyticsConfig + properties: + updateTime: + description: Output only. The latest update time. + readOnly: true + format: google-datetime + type: string + state: + description: Output only. The state of the Analytics add-on. + readOnly: true + type: string + enum: + - ADDON_STATE_UNSPECIFIED + - ENABLING + - ENABLED + - DISABLING + - DISABLED + enumDescriptions: + - Default value. + - Add-on is in progress of enabling. + - Add-on is fully enabled and ready to use. + - Add-on is in progress of disabling. + - Add-on is fully disabled. + enabled: + description: Whether the Analytics add-on is enabled. + type: boolean + expireTimeMillis: + format: int64 + readOnly: true + type: string + description: >- + Output only. Time at which the Analytics add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. type: object + GoogleCloudApigeeV1ListHybridIssuersResponse: id: GoogleCloudApigeeV1ListHybridIssuersResponse properties: issuers: - description: Lists of hybrid services and its trusted issuer email ids. - type: array items: $ref: '#/components/schemas/GoogleCloudApigeeV1ServiceIssuersMapping' - GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: - properties: - documentationLink: - type: string - description: Documentation link for the action. - id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - type: object - description: Action context are all the relevant details for the action. - GoogleCloudApigeeV1EndpointAttachment: + description: Lists of hybrid services and its trusted issuer email ids. + type: array type: object + GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: + description: Request for AdjustDeveloperBalance. properties: - serviceAttachment: - description: 'Format: projects/*/regions/*/serviceAttachments/*' - type: string - state: - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - description: >- - Output only. State of the endpoint attachment. Values other than - `ACTIVE` mean the resource is not ready to use. - type: string - readOnly: true - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. - connectionState: + adjustment: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Output only. State of the endpoint attachment connection to the - service attachment. - enum: - - CONNECTION_STATE_UNSPECIFIED - - UNAVAILABLE - - PENDING - - ACCEPTED - - REJECTED - - CLOSED - - FROZEN - - NEEDS_ATTENTION + * A positive value of `adjustment` means that that the API provider + wants to adjust the balance for an under-charged developer i.e. the + balance of the developer will decrease. * A negative value of + `adjustment` means that that the API provider wants to adjust the + balance for an over-charged developer i.e. the balance of the + developer will increase. + id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + type: object + GoogleCloudApigeeV1ApiCategoryResponse: + description: The API category resource wrapped with response status, error_code, etc. + id: GoogleCloudApigeeV1ApiCategoryResponse + type: object + properties: + message: type: string - readOnly: true - enumDescriptions: - - The connection state has not been set. - - >- - The connection state is unavailable at this time, possibly because - the endpoint attachment is currently being provisioned. - - The connection is pending acceptance by the PSC producer. - - The connection has been accepted by the PSC producer. - - The connection has been rejected by the PSC producer. - - >- - The connection has been closed by the PSC producer and will not - serve traffic going forward. - - >- - The connection has been frozen by the PSC producer and will not - serve traffic. - - >- - The connection has been accepted by the PSC producer, but it is - not ready to serve the traffic due to producer side issues. - location: - description: Required. Location of the endpoint attachment. + description: Description of the operation. + status: type: string - host: - readOnly: true - description: >- - Output only. Host that can be used in either the HTTP target - endpoint directly or as the host in target server. + description: Status of the operation. + requestId: + description: Unique ID of the request. type: string - name: + data: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + description: The API category resource. + errorCode: type: string - description: >- - Name of the endpoint attachment. Use the following structure in your - request: - `organizations/{org}/endpointAttachments/{endpoint_attachment}` - id: GoogleCloudApigeeV1EndpointAttachment - description: >- - Apigee endpoint attachment. For more information, see [Southbound - networking patterns] - (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). - GoogleCloudApigeeV1ApiDoc: + description: Unique error code for the request, if any. + GoogleCloudApigeeV1ApiSecurityRuntimeConfig: description: >- - `ApiDoc` represents an API catalog item. Catalog items are used in two - ways in a portal: - Users can browse and interact with a visual - representation of the API documentation - The `api_product_name` field - provides a link to a backing [API product] - (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - Through this link, portal users can create and manage developer apps - linked to one or more API products. + Response for + GetApiSecurityRuntimeConfig[EnvironmentService.GetApiSecurityRuntimeConfig]. + id: GoogleCloudApigeeV1ApiSecurityRuntimeConfig type: object properties: - categoryIds: - items: - type: string - type: array - description: >- - Optional. The IDs of the API categories to which this catalog item - belongs. - title: - description: >- - Required. The user-facing name of the catalog item. `title` must be - a non-empty string with a max length of 255 characters. + updateTime: + description: Time that the API Security Runtime configuration was updated. type: string - graphqlEndpointUrl: - deprecated: true + format: google-datetime + revisionId: + format: int64 description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods + Revision ID of the API Security Runtime configuration. The higher + the value, the more recently the configuration was deployed. type: string - published: - type: boolean + uid: description: >- - Optional. Denotes whether the catalog item is published to the - portal or is in a draft state. When the parent portal is enrolled in - the [audience management - feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), - the visibility can be set to public on creation by setting the - anonAllowed flag to true or further managed in the management UI - (see [Manage the visibility of an API in your - portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) - before it can be visible to any users. If not enrolled in the - audience management feature, the visibility is managed by the - `anonAllowed` flag. - id: - format: int64 - description: Output only. The ID of the catalog item. - readOnly: true - type: string - specId: - deprecated: true - description: 'Optional. DEPRECATED: DO NOT USE' - type: string - graphqlSchemaDisplayName: + Unique ID for the API Security Runtime configuration. The ID will + only change if the environment is deleted and recreated. type: string - deprecated: true + name: description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods - siteId: - description: Output only. The ID of the parent portal. - readOnly: true + Name of the environment API Security Runtime configuration resource. + Format: + `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` type: string - visibility: - type: boolean - description: 'Optional. DEPRECATED: use the `published` field instead' - graphqlSchema: + location: + type: array + description: A list of up to 5 Cloud Storage Blobs that contain SecurityActions. + items: + type: string + GoogleCloudApigeeV1GenerateUploadUrlRequest: + type: object + properties: {} + description: Request for GenerateUploadUrl method. + id: GoogleCloudApigeeV1GenerateUploadUrlRequest + GoogleCloudApigeeV1ListEnvironmentGroupsResponse: + description: Response for ListEnvironmentGroups. + id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse + properties: + environmentGroups: + description: EnvironmentGroups in the specified organization. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + type: array + nextPageToken: description: >- - Optional. DEPRECATED: manage documentation through the - `getDocumentation` and `updateDocumentation` methods + Page token that you can include in a ListEnvironmentGroups request + to retrieve the next page. If omitted, no subsequent pages exist. type: string - deprecated: true - modified: + type: object + GoogleCloudApigeeV1ListAppsResponse: + type: object + properties: + totalSize: + format: int32 + type: integer + description: Total count of Apps. + nextPageToken: + type: string + description: >- + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + app: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1App' + type: array + id: GoogleCloudApigeeV1ListAppsResponse + GoogleCloudApigeeV1RevenueShareRange: + properties: + start: format: int64 type: string - readOnly: true description: >- - Output only. Time the catalog item was last modified in milliseconds - since epoch. - requireCallbackUrl: - type: boolean + Starting value of the range. Set to 0 or `null` for the initial + range of values. + sharePercentage: description: >- - Optional. Whether a callback URL is required when this catalog - item's API product is enabled in a developer app. When true, a - portal user will be required to input a URL when managing the app - (this is typically used for the app's OAuth flow). - apiProductName: + Percentage of the revenue to be shared with the developer. For + example, to share 21 percent of the total revenue with the + developer, set this value to 21. Specify a decimal number with a + maximum of two digits following the decimal point. + type: number + format: double + end: type: string description: >- - Required. Immutable. The `name` field of the associated [API - product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). - A portal may have only one catalog item associated with a given API - product. - description: - type: string + Ending value of the range. Set to 0 or `null` for the last range of + values. + format: int64 + id: GoogleCloudApigeeV1RevenueShareRange + type: object + description: >- + API call volume range and the percentage of revenue to share with the + developer when the total number of API calls is within the range. + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: + type: object + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest + description: Request for BatchComputeSecurityAssessmentResults. + properties: + scope: description: >- - Optional. Description of the catalog item. Max length is 10,000 - characters. - edgeAPIProductName: + Required. Scope of the resources for the computation. For Apigee, + the environment is the scope of the resources. type: string - description: >- - Optional. Immutable. DEPRECATED: use the `apiProductName` field - instead - anonAllowed: - description: >- - Optional. Boolean flag that manages user access to the catalog item. - When true, the catalog item has public visibility and can be viewed - anonymously; otherwise, only registered users may view it. Note: - when the parent portal is enrolled in the [audience management - feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), - and this flag is set to false, visibility is set to an indeterminate - state and must be explicitly specified in the management UI (see - [Manage the visibility of an API in your - portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). - Additionally, when enrolled in the audience management feature, - updates to this flag will be ignored as visibility permissions must - be updated in the management UI. - type: boolean - imageUrl: + profile: + description: Required. Name of the profile that is used for computation. + type: string + include: + description: Include only these resources. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + pageToken: type: string description: >- - Optional. Location of the image used for the catalog item in the - catalog. This can be either an image with an external URL or a file - path for [image files stored in the - portal](/apigee/docs/api-platform/publish/portal/portal-files"), for - example, `/files/book-tree.jpg`. When specifying the URL of an - external image, the image won't be uploaded to your assets; - additionally, loading the image in the integrated portal will be - subject to its availability, which may be blocked or restricted by - [content security - policies](/apigee/docs/api-platform/publish/portal/csp). Max length - of file path is 2,083 characters. - id: GoogleCloudApigeeV1ApiDoc - GoogleCloudApigeeV1ListInstanceAttachmentsResponse: - id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse - description: Response for ListInstanceAttachments. + Optional. A page token, received from a previous + `BatchComputeSecurityAssessmentResults` call. Provide this to + retrieve the subsequent page. + includeAllResources: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + description: Include all resources under the scope. + pageSize: + type: integer + format: int32 + description: >- + Optional. The maximum number of results to return. The service may + return fewer than this value. If unspecified, at most 50 results + will be returned. + GoogleCloudApigeeV1GenerateDownloadUrlRequest: + properties: {} + id: GoogleCloudApigeeV1GenerateDownloadUrlRequest + type: object + description: Request for GenerateDownloadUrl method. + GoogleCloudApigeeV1Point: properties: - attachments: + id: + type: string + description: Name of a step in the transaction. + results: type: array - description: Attachments for the instance. + description: List of results extracted from a given debug point. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' - nextPageToken: - description: >- - Page token that you can include in a ListInstanceAttachments request - to retrieve the next page of content. If omitted, no subsequent - pages exist. - type: string - type: object - GoogleCloudApigeeV1Result: - id: GoogleCloudApigeeV1Result + $ref: '#/components/schemas/GoogleCloudApigeeV1Result' type: object description: >- - Result is short for "action result", could be different types identified - by "action_result" field. Supported types: 1. DebugInfo : generic debug - info collected by runtime recorded as a list of properties. For example, - the contents could be virtual host info, state change result, or - execution metadata. Required fields : properties, timestamp 2. - RequestMessage: information of a http request. Contains headers, request - URI and http methods type.Required fields : headers, uri, verb 3. - ResponseMessage: information of a http response. Contains headers, - reason phrase and http status code. Required fields : headers, - reasonPhrase, statusCode 4. ErrorMessage: information of a http error - message. Contains detail error message, reason phrase and status code. - Required fields : content, headers, reasonPhrase, statusCode 5. - VariableAccess: a list of variable access actions, can be Get, Set and - Remove. Required fields : accessList + Point is a group of information collected by runtime plane at critical + points of the message flow of the processed API request. This is a list + of supported point IDs, categorized to three major buckets. For each + category, debug points that we are currently supporting are listed + below: - Flow status debug points: StateChange FlowInfo Condition + Execution DebugMask Error - Flow control debug points: FlowCallout + Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: + ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition + Oauth2ServicePoint RaiseFault NodeJS The detail information of the given + debug point is stored in a list of results. + id: GoogleCloudApigeeV1Point + GoogleIamV1TestIamPermissionsRequest: + id: GoogleIamV1TestIamPermissionsRequest + type: object properties: - verb: - type: string - description: HTTP method verb - timestamp: - type: string - description: >- - Timestamp of when the result is recorded. Its format is dd-mm-yy - hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` - reasonPhrase: - description: HTTP response phrase - type: string - content: - type: string - description: >- - Error message content. for example, "content" : - "{\"fault\":{\"faultstring\":\"API timed - out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" - ActionResult: - type: string - description: >- - Type of the action result. Can be one of the five: DebugInfo, - RequestMessage, ResponseMessage, ErrorMessage, VariableAccess - headers: + permissions: type: array + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + type: string + description: Request message for `TestIamPermissions` method. + GoogleCloudApigeeV1UpdateSecurityIncidentRequest: + type: object + description: Request for UpdateSecurityIncident. + properties: + securityIncident: description: >- - A list of HTTP headers. for example, '"headers" : [ { "name" : - "Content-Length", "value" : "83" }, { "name" : "Content-Type", - "value" : "application/json" } ]' - uRI: + Required. The security incident to update. Must contain all existing + populated fields of the current incident. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + updateMask: type: string description: >- - The relative path of the api proxy. for example, `"uRI" : - "/iloveapis"` - statusCode: - description: HTTP response code - type: string - properties: - description: Name value pairs used for DebugInfo ActionResult. - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - accessList: + Required. The list of fields to update. Allowed fields are: + LINT.IfChange(allowed_update_fields_comment) - observability + LINT.ThenChange() + format: google-fieldmask + id: GoogleCloudApigeeV1UpdateSecurityIncidentRequest + GoogleCloudApigeeV1DebugSessionTransaction: + properties: + completed: + type: boolean + description: Flag indicating whether a transaction is completed or not + point: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Access' - description: >- - A list of variable access actions agaist the api proxy. Supported - values: Get, Set, Remove. + $ref: '#/components/schemas/GoogleCloudApigeeV1Point' type: array - GoogleCloudApigeeV1TraceSamplingConfig: - type: object + description: >- + List of debug data collected by runtime plane at various defined + points in the flow. + id: GoogleCloudApigeeV1DebugSessionTransaction description: >- - TraceSamplingConfig represents the detail settings of distributed - tracing. Only the fields that are defined in the distributed trace - configuration can be overridden using the distribute trace configuration - override APIs. + A transaction contains all of the debug information of the entire + message flow of an API call processed by the runtime plane. The + information is collected and recorded at critical points of the message + flow in the runtime apiproxy. + type: object + GoogleCloudApigeeV1UpdateError: + description: Details on why a resource update failed in the runtime. + type: object + id: GoogleCloudApigeeV1UpdateError properties: - sampler: + code: enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY - type: string + - OK + - CANCELLED + - UNKNOWN + - INVALID_ARGUMENT + - DEADLINE_EXCEEDED + - NOT_FOUND + - ALREADY_EXISTS + - PERMISSION_DENIED + - UNAUTHENTICATED + - RESOURCE_EXHAUSTED + - FAILED_PRECONDITION + - ABORTED + - OUT_OF_RANGE + - UNIMPLEMENTED + - INTERNAL + - UNAVAILABLE + - DATA_LOSS enumDescriptions: - - Sampler unspecified. + - 'Not an error; returned on success. HTTP Mapping: 200 OK' - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. + The operation was cancelled, typically by the caller. HTTP + Mapping: 499 Client Closed Request - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. - description: Sampler of distributed tracing. OFF is the default value. - samplingRate: - description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - type: number - format: float - id: GoogleCloudApigeeV1TraceSamplingConfig - GoogleCloudApigeeV1ListApiDocsResponse: - id: GoogleCloudApigeeV1ListApiDocsResponse - properties: - message: - type: string - description: Description of the operation. - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - status: - description: Status of the operation. - type: string - data: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - type: array - description: The catalog item resources. - errorCode: + Unknown error. For example, this error may be returned when a + `Status` value received from another address space belongs to an + error space that is not known in this address space. Also errors + raised by APIs that do not return enough error information may be + converted to this error. HTTP Mapping: 500 Internal Server Error + - >- + The client specified an invalid argument. Note that this differs + from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments + that are problematic regardless of the state of the system (e.g., + a malformed file name). HTTP Mapping: 400 Bad Request + - >- + The deadline expired before the operation could complete. For + operations that change the state of the system, this error may be + returned even if the operation has completed successfully. For + example, a successful response from a server could have been + delayed long enough for the deadline to expire. HTTP Mapping: 504 + Gateway Timeout + - >- + Some requested entity (e.g., file or directory) was not found. + Note to server developers: if a request is denied for an entire + class of users, such as gradual feature rollout or undocumented + allowlist, `NOT_FOUND` may be used. If a request is denied for + some users within a class of users, such as user-based access + control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not + Found + - >- + The entity that a client attempted to create (e.g., file or + directory) already exists. HTTP Mapping: 409 Conflict + - >- + The caller does not have permission to execute the specified + operation. `PERMISSION_DENIED` must not be used for rejections + caused by exhausting some resource (use `RESOURCE_EXHAUSTED` + instead for those errors). `PERMISSION_DENIED` must not be used if + the caller can not be identified (use `UNAUTHENTICATED` instead + for those errors). This error code does not imply the request is + valid or the requested entity exists or satisfies other + pre-conditions. HTTP Mapping: 403 Forbidden + - >- + The request does not have valid authentication credentials for the + operation. HTTP Mapping: 401 Unauthorized + - >- + Some resource has been exhausted, perhaps a per-user quota, or + perhaps the entire file system is out of space. HTTP Mapping: 429 + Too Many Requests + - >- + The operation was rejected because the system is not in a state + required for the operation's execution. For example, the directory + to be deleted is non-empty, an rmdir operation is applied to a + non-directory, etc. Service implementors can use the following + guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and + `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just + the failing call. (b) Use `ABORTED` if the client should retry at + a higher level. For example, when a client-specified test-and-set + fails, indicating the client should restart a read-modify-write + sequence. (c) Use `FAILED_PRECONDITION` if the client should not + retry until the system state has been explicitly fixed. For + example, if an "rmdir" fails because the directory is non-empty, + `FAILED_PRECONDITION` should be returned since the client should + not retry unless the files are deleted from the directory. HTTP + Mapping: 400 Bad Request + - >- + The operation was aborted, typically due to a concurrency issue + such as a sequencer check failure or transaction abort. See the + guidelines above for deciding between `FAILED_PRECONDITION`, + `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict + - >- + The operation was attempted past the valid range. E.g., seeking or + reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error + indicates a problem that may be fixed if the system state changes. + For example, a 32-bit file system will generate `INVALID_ARGUMENT` + if asked to read at an offset that is not in the range [0,2^32-1], + but it will generate `OUT_OF_RANGE` if asked to read from an + offset past the current file size. There is a fair bit of overlap + between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend + using `OUT_OF_RANGE` (the more specific error) when it applies so + that callers who are iterating through a space can easily look for + an `OUT_OF_RANGE` error to detect when they are done. HTTP + Mapping: 400 Bad Request + - >- + The operation is not implemented or is not supported/enabled in + this service. HTTP Mapping: 501 Not Implemented + - >- + Internal errors. This means that some invariants expected by the + underlying system have been broken. This error code is reserved + for serious errors. HTTP Mapping: 500 Internal Server Error + - >- + The service is currently unavailable. This is most likely a + transient condition, which can be corrected by retrying with a + backoff. Note that it is not always safe to retry non-idempotent + operations. See the guidelines above for deciding between + `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: + 503 Service Unavailable + - >- + Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal + Server Error + type: string + description: Status code. + type: + type: string + description: >- + A string that uniquely identifies the type of error. This provides a + more reliable means to deduplicate errors across revisions and + instances. + resource: + description: >- + The sub resource specific to this error (e.g. a proxy deployed + within the EnvironmentConfig). If empty the error refers to the top + level resource. type: string + message: + type: string + description: User-friendly error message. + GoogleCloudApigeeV1ApiDocResponse: + id: GoogleCloudApigeeV1ApiDocResponse + type: object + description: The catalog item resource wrapped with response status, error_code, etc. + properties: + errorCode: description: Unique error code for the request, if any. + type: string requestId: + type: string description: Unique ID of the request. + message: type: string + description: Description of the operation. + data: + description: The catalog item resource. + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + status: + type: string + description: Status of the operation. + GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: + description: >- + Filter scores by component path. Used custom filter instead of AIP-160 + as the use cases are highly constrained and predictable. + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter type: object - GoogleCloudApigeeV1AliasRevisionConfig: - id: GoogleCloudApigeeV1AliasRevisionConfig properties: - location: - description: Location of the alias file. For example, a Google Cloud Storage URI. - type: string - name: + scorePath: type: string description: >- - Name of the alias revision included in the keystore in the following - format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` - type: + Optional. Return scores for this component. Example: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + GoogleCloudApigeeV1OperationMetadata: + properties: + progress: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' + description: Progress of the operation. + operationType: enumDescriptions: - - Alias type is not specified. - - Certificate. - - Key/certificate pair. + - '' + - '' + - '' + - '' enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT + - OPERATION_TYPE_UNSPECIFIED + - INSERT + - DELETE + - UPDATE type: string + state: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED + type: string + targetResourceName: + description: Name of the resource for which the operation is operating on. + type: string + warnings: + description: Warnings encountered while executing the operation. + items: + type: string + type: array type: object - GoogleProtobufEmpty: - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: GoogleProtobufEmpty - properties: {} - GoogleCloudApigeeV1InstanceDeploymentStatus: + description: Metadata describing an Operation. + id: GoogleCloudApigeeV1OperationMetadata + GoogleCloudApigeeV1IngressConfig: type: object - description: The status of a deployment as reported by a single instance. - id: GoogleCloudApigeeV1InstanceDeploymentStatus + id: GoogleCloudApigeeV1IngressConfig properties: - deployedRevisions: - description: Revisions currently deployed in MPs. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + environmentGroups: + description: List of environment groups in the organization. type: array - instance: - type: string - description: ID of the instance reporting the status. - deployedRoutes: items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute - type: array + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + name: description: >- - Current routes deployed in the ingress routing table. A route which - is missing will appear in `missing_routes`. - GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: - description: >- - Describes a potential routing change that may occur as a result of some - deployment operation. - properties: - environmentGroup: - description: Name of the environment group affected by this routing change. + Name of the resource in the following format: + `organizations/{org}/deployedIngressConfig`. type: string - shouldSequenceRollout: + revisionCreateTime: + description: Time at which the IngressConfig revision was created. + type: string + format: google-datetime + revisionId: + format: int64 description: >- - Set to `true` if using sequenced rollout would make this routing - change safer. **Note**: This does not necessarily imply that - automated sequenced rollout mode is supported for the operation. - type: boolean - description: + Revision id that defines the ordering on IngressConfig resources. + The higher the revision, the more recently the configuration was + deployed. type: string - description: Human-readable description of this routing change. - fromDeployment: - description: Base path/deployment that may stop receiving some traffic. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - toDeployment: + uid: description: >- - Base path/deployment that may start receiving that traffic. May be - null if no deployment is able to receive the traffic. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - type: object - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - GoogleCloudApigeeV1DimensionMetric: - id: GoogleCloudApigeeV1DimensionMetric - description: Encapsulates a metric grouped by dimension. + A unique id for the ingress config that will only change if the + organization is deleted and recreated. + type: string + GoogleCloudApigeeV1InstanceAttachment: + description: >- + InstanceAttachment represents the installation of an environment onto an + instance. properties: - metrics: - description: List of metrics. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - type: array name: - deprecated: true + type: string + readOnly: true + description: Output only. ID of the attachment. + createdAt: + format: int64 + type: string description: >- - Comma joined dimension names. E.g. "dim1_name,dim2_name". - Deprecated. If name already has comma before join, we may get wrong - splits. Please use individual_names. + Output only. Time the attachment was created in milliseconds since + epoch. + readOnly: true + environment: type: string - individualNames: - description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. - type: array - items: - type: string + description: ID of the attached environment. + id: GoogleCloudApigeeV1InstanceAttachment type: object - GoogleCloudApigeeV1SecurityIncident: + GoogleCloudApigeeV1Access: type: object - id: GoogleCloudApigeeV1SecurityIncident properties: + Remove: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' + Get: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' + Set: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' + id: GoogleCloudApigeeV1Access + GoogleCloudApigeeV1SecurityActionHttpHeader: + type: object + id: GoogleCloudApigeeV1SecurityActionHttpHeader + properties: + value: + type: string + description: The header value to be sent to the target. name: type: string + description: The header name to be sent to the target. + description: An HTTP header. + GoogleCloudApigeeV1DeveloperApp: + id: GoogleCloudApigeeV1DeveloperApp + properties: + scopes: description: >- - Immutable. Name of the security incident resource. Format: - organizations/{org}/environments/{environment}/securityIncidents/{incident} - Example: - organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 - trafficCount: - type: string + Scopes to apply to the developer app. The specified scopes must + already exist for the API product that you associate with the + developer app. + type: array + items: + type: string + createdAt: format: int64 - description: Total traffic detected as part of the incident. - firstDetectedTime: - format: google-datetime + description: >- + Output only. Time the developer app was created in milliseconds + since epoch. + type: string + readOnly: true + appFamily: + type: string + description: Developer app family. + appId: type: string + description: ID of the developer app. + credentials: + type: array description: >- - Output only. The time when events associated with the incident were - first detected. + Output only. Set of credentials for the developer app consisting of + the consumer key/secret pairs associated with the API products. readOnly: true - lastObservabilityChangeTime: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + keyExpiresIn: + format: int64 description: >- - Output only. The time when the incident observability was last - changed. - format: google-datetime + Expiration time, in milliseconds, for the consumer key that is + generated for the developer app. If not set or left to the default + value of `-1`, the API key never expires. The expiration time can't + be updated after it is set. type: string + callbackUrl: + type: string + description: >- + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to developer apps. + lastModifiedAt: readOnly: true - detectionTypes: - readOnly: true + format: int64 + type: string description: >- - Output only. Detection types which are part of the incident. - Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly - Detection. + Output only. Time the developer app was modified in milliseconds + since epoch. + developerId: + type: string + description: ID of the developer. + name: + type: string + description: Name of the developer app. + apiProducts: + description: List of API products associated with the developer app. + type: array items: type: string + attributes: + description: List of attributes for the developer app. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array - riskLevel: - enum: - - RISK_LEVEL_UNSPECIFIED - - LOW - - MODERATE - - SEVERE - enumDescriptions: - - Risk Level Unspecified. - - Risk level of the incident is low. - - Risk level of the incident is moderate. - - Risk level of the incident is severe. - readOnly: true + status: + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. type: string - description: Output only. Risk level of the incident. - observability: + type: object + GoogleCloudApigeeV1MetricAggregation: + id: GoogleCloudApigeeV1MetricAggregation + description: The optionally aggregated metric to query with its ordering. + properties: + name: + description: Name of the metric + type: string + aggregation: + type: string + description: Aggregation function associated with the metric. enum: - - OBSERVABILITY_UNSPECIFIED - - ACTIVE - - ARCHIVED - description: Optional. Indicates if the user archived this incident. + - AGGREGATION_FUNCTION_UNSPECIFIED + - AVG + - SUM + - MIN + - MAX + - COUNT_DISTINCT enumDescriptions: - - The incident observability is unspecified. - - >- - The incident is currently active. Can change to this status from - archived. - - >- - The incident is currently archived and was archived by the - customer. - type: string - displayName: + - Unspecified Aggregation function. + - Average. + - Summation. + - Min. + - Max. + - Count distinct + order: + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. type: string - description: Optional. Display name of the security incident. - lastDetectedTime: + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING description: >- - Output only. The time when events associated with the incident were - last detected. - type: string - format: google-datetime - readOnly: true - description: Represents an SecurityIncident resource. - GoogleCloudApigeeV1ListTraceConfigOverridesResponse: - id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse + Ordering for this aggregation in the result. For time series this is + ignored since the ordering of points depends only on the timestamp, + not the values. type: object - description: Response for ListTraceConfigOverrides. + GoogleCloudApigeeV1Certificate: properties: - nextPageToken: - description: >- - Token value that can be passed as `page_token` to retrieve the next - page of content. - type: string - traceConfigOverrides: - description: List all trace configuration overrides in an environment. + certInfo: + description: Chain of certificates under this name. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' - GoogleCloudApigeeV1SetAddonsRequest: + $ref: '#/components/schemas/GoogleCloudApigeeV1CertInfo' type: object - description: Request for SetAddons. + id: GoogleCloudApigeeV1Certificate + GoogleCloudApigeeV1ListSecurityActionsResponse: properties: - addonsConfig: - description: Required. Add-on configurations. - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - id: GoogleCloudApigeeV1SetAddonsRequest - GoogleIamV1TestIamPermissionsResponse: - description: Response message for `TestIamPermissions` method. - id: GoogleIamV1TestIamPermissionsResponse + securityActions: + type: array + description: The SecurityActions for the specified environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + id: GoogleCloudApigeeV1ListSecurityActionsResponse + description: >- + Contains a list of SecurityActions in response to a + ListSecurityActionRequest. + type: object + GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: + id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + description: Request for UpdateAppGroupAppKey type: object properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. + apiProducts: type: array items: type: string - GoogleCloudApigeeV1TlsInfoConfig: - id: GoogleCloudApigeeV1TlsInfoConfig - properties: - trustStore: - type: string description: >- - Name of the keystore or keystore reference containing trusted - certificates for the server in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` or - `organizations/{org}/environments/{env}/references/{reference}` - commonName: - description: Common name to validate the target server against. - $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' - clientAuthEnabled: - type: boolean + The list of API products that will be associated with the + credential. This list will be appended to the existing list of + associated API Products for this App Key. Duplicates will be + ignored. + appGroupAppKey: description: >- - Flag that specifies whether client-side authentication is enabled - for the target server. Enables two-way TLS. - keyAliasReference: - description: Reference name and alias pair to use for client-side authentication. - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' - keyAlias: + The new AppGroupKey to be amended. Note that the status can be + updated only via action. + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + action: description: >- - Name of the alias used for client-side authentication in the - following format: - `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` + Approve or revoke the consumer key by setting this value to + `approve` or `revoke` respectively. The `Content-Type` header, if + set, must be set to `application/octet-stream`, with empty body. type: string - enforce: - description: Flag that enforces TLS settings - type: boolean - ignoreValidationErrors: + GoogleCloudApigeeV1DebugSession: + id: GoogleCloudApigeeV1DebugSession + properties: + filter: description: >- - Flag that specifies whether to ignore TLS certificate validation - errors. Set to `true` to ignore errors. - type: boolean - protocols: - type: array - description: List of TLS protocols that are granted access. - items: - type: string - ciphers: - items: - type: string - description: List of ciphers that are granted access. - type: array - enabled: + Optional. A conditional statement which is evaluated against the + request message to determine if it should be traced. Syntax matches + that of on API Proxy bundle flow Condition. + type: string + createTime: + readOnly: true + format: google-datetime description: >- - Flag that specifies whether one-way TLS is enabled. Set to `true` to - enable one-way TLS. - type: boolean - type: object - GoogleCloudApigeeV1ApiCategoryResponse: - properties: - requestId: + Output only. The first transaction creation timestamp, recorded by + UAP. type: string - description: Unique ID of the request. - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' - description: The API category resource. - status: + timeout: type: string - description: Status of the operation. - message: + description: >- + Optional. The time in seconds after which this DebugSession should + end. This value will override the value in query param, if both are + provided. + format: int64 + count: + type: integer + format: int32 + description: >- + Optional. The number of request to be traced. Min = 1, Max = 15, + Default = 10. + validity: + type: integer + description: >- + Optional. The length of time, in seconds, that this debug session is + valid, starting from when it's received in the control plane. Min = + 1, Max = 15, Default = 10. + format: int32 + tracesize: + description: >- + Optional. The maximum number of bytes captured from the response + payload. Min = 0, Max = 5120, Default = 5120. + format: int32 + type: integer + name: + description: A unique ID for this DebugSession. type: string - description: Description of the operation. - errorCode: + type: object + GoogleCloudApigeeV1ListEnvironmentResourcesResponse: + type: object + id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse + properties: + resourceFile: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + description: List of resources files. + description: Response for ListEnvironmentResources + GoogleCloudApigeeV1GenerateUploadUrlResponse: + id: GoogleCloudApigeeV1GenerateUploadUrlResponse + properties: + uploadUri: + description: >- + The Google Cloud Storage signed URL that can be used to upload a new + Archive zip file. type: string - description: Unique error code for the request, if any. - id: GoogleCloudApigeeV1ApiCategoryResponse type: object - description: The API category resource wrapped with response status, error_code, etc. - GoogleCloudApigeeV1TraceConfigOverride: + description: Response for GenerateUploadUrl method. + GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: + description: Response for ListSecurityProfileRevisions. type: object properties: - samplingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' - description: Trace configuration to override. - apiProxy: + nextPageToken: type: string description: >- - ID of the API proxy that will have its trace configuration - overridden. - name: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + securityProfiles: + type: array description: >- - ID of the trace configuration override specified as a - system-generated UUID. + List of security profile revisions. The revisions may be attached or + unattached to any environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + GoogleCloudApigeeV1ListNatAddressesResponse: + properties: + nextPageToken: + description: >- + Page token that you can include in a ListNatAddresses request to + retrieve the next page of content. If omitted, no subsequent pages + exist. type: string - id: GoogleCloudApigeeV1TraceConfigOverride - description: A representation of a configuration override. - GoogleCloudApigeeV1Datastore: - id: GoogleCloudApigeeV1Datastore + natAddresses: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + description: List of NAT Addresses for the instance. + type: array + type: object + id: GoogleCloudApigeeV1ListNatAddressesResponse + description: Response for ListNatAddresses. + GoogleTypeExpr: description: >- - The data store defines the connection to export data repository (Cloud - Storage, BigQuery), including the credentials used to access the data - repository. + 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. + id: GoogleTypeExpr + type: object properties: - lastUpdateTime: - type: string - readOnly: true + description: description: >- - Output only. Datastore last update time, in milliseconds since the - epoch of 1970-01-01T00:00:00Z - format: int64 - displayName: - description: Required. Display name in UI - type: string - targetType: - description: Destination storage type. Supported types `gcs` or `bigquery`. - type: string - self: + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. type: string - readOnly: true + title: description: >- - Output only. Resource link of Datastore. Example: - `/organizations/{org}/analytics/datastores/{uuid}` - org: + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. type: string - readOnly: true - description: Output only. Organization that the datastore belongs to - datastoreConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' - description: Datastore Configurations. - createTime: + expression: type: string description: >- - Output only. Datastore create time, in milliseconds since the epoch - of 1970-01-01T00:00:00Z - readOnly: true - format: int64 - type: object - GoogleCloudApigeeV1Subscription: - description: Pub/Sub subscription of an environment. - type: object - id: GoogleCloudApigeeV1Subscription - properties: - name: + Textual representation of an expression in Common Expression + Language syntax. + location: description: >- - Full name of the Pub/Sub subcription. Use the following structure in - your request: `subscription "projects/foo/subscription/bar"` + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - GoogleCloudApigeeV1EnvironmentConfig: - id: GoogleCloudApigeeV1EnvironmentConfig + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision type: object properties: - featureFlags: - additionalProperties: - type: string - description: Feature flags inherited from the organization and environment. - type: object - arcConfigLocation: - type: string - description: >- - The location for the config blob of API Runtime Control, aka Envoy - Adapter, for op-based authentication as a URI, e.g. a Cloud Storage - URI. This is only used by Envoy-based gateways. - pubsubTopic: + percentage: + description: Percentage of MP replicas reporting this revision. + format: int32 + type: integer + revision: + description: API proxy revision reported as deployed. type: string - description: Name of the PubSub topic for the environment. - flowhooks: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' - type: array - description: List of flow hooks in the environment. - dataCollectors: - description: List of data collectors used by the deployments in the environment. + description: Revisions deployed in the MPs. + GoogleCloudApigeeV1ListTraceConfigOverridesResponse: + properties: + nextPageToken: + type: string + description: >- + Token value that can be passed as `page_token` to retrieve the next + page of content. + traceConfigOverrides: type: array + description: List all trace configuration overrides in an environment. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' - targets: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + type: object + description: Response for ListTraceConfigOverrides. + id: GoogleCloudApigeeV1ListTraceConfigOverridesResponse + GoogleCloudApigeeV1ProfileConfigCORS: + properties: {} + id: GoogleCloudApigeeV1ProfileConfigCORS + description: Checks to see if you have CORS policy in place. + type: object + GoogleCloudApigeeV1KeystoreConfig: + properties: + aliases: + description: Aliases in the keystore. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' - description: >- - List of target servers in the environment. Disabled target servers - are not displayed. + $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' type: array - sequenceNumber: - format: int64 - type: string - description: 'DEPRECATED: Use revision_id.' - provider: - type: string - description: >- - Used by the Control plane to add context information to help detect - the source of the document during diagnostics and debugging. - uid: + name: description: >- - Unique ID for the environment configuration. The ID will only change - if the environment is deleted and recreated. + Resource name in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` type: string - debugMask: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' - description: Debug mask that applies to all deployments in the environment. - keystores: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' - description: List of keystores in the environment. + type: object + id: GoogleCloudApigeeV1KeystoreConfig + GoogleCloudApigeeV1TlsInfo: + description: TLS configuration information for virtual hosts and TargetServers. + type: object + properties: + commonName: + description: The TLS Common Name of the certificate. + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoCommonName' + ciphers: type: array - forwardProxyUri: - type: string description: >- - The forward proxy's url to be used by the runtime. When set, runtime - will send requests to the target via the given forward proxy. This - is only used by programmable gateways. - deploymentGroups: - description: List of deployment groups in the environment. - type: array + The SSL/TLS cipher suites to be used. For programmable proxies, it + must be one of the cipher suite names listed in: + http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. + For configurable proxies, it must follow the configuration specified + in: + https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite-configuration. + This setting has no effect for configurable proxies when negotiating + TLS 1.3. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' - name: - type: string - description: >- - Name of the environment configuration in the following format: - `organizations/{org}/environments/{env}/configs/{config}` - envScopedRevisionId: + type: string + clientAuthEnabled: + description: Optional. Enables two-way TLS. + type: boolean + ignoreValidationErrors: + type: boolean description: >- - Revision ID for environment-scoped resources (e.g. target servers, - keystores) in this config. This ID will increment any time a - resource not scoped to a deployment group changes. - type: string - format: int64 - gatewayConfigLocation: + If true, Edge ignores TLS certificate errors. Valid when configuring + TLS for target servers and target endpoints, and when configuring + virtual hosts that use 2-way TLS. When used with a target + endpoint/target server, if the backend system uses SNI and returns a + cert with a subject Distinguished Name (DN) that does not match the + hostname, there is no way to ignore the error and the connection + fails. + enforce: + description: TLS is strictly enforced. + type: boolean + trustStore: type: string + description: The resource ID of the truststore. + enabled: description: >- - The location for the gateway config blob as a URI, e.g. a Cloud - Storage URI. This is only used by Envoy-based gateways. - addonsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' - description: The latest runtime configurations for add-ons. - revisionId: + Required. Enables TLS. If false, neither one-way nor two-way TLS + will be enabled. + type: boolean + keyAlias: type: string description: >- - Revision ID of the environment configuration. The higher the value, - the more recently the configuration was deployed. - format: int64 - resources: - type: array - description: List of resource versions in the environment. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' - createTime: + Required if `client_auth_enabled` is true. The resource ID for the + alias containing the private key and cert. + keyStore: type: string - format: google-datetime - description: Time that the environment configuration was created. - traceConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' description: >- - Trace configurations. Contains config for the environment and config - overrides for specific API proxies. - resourceReferences: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' - type: array - description: List of resource references in the environment. - deployments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' - type: array - description: List of deployments in the environment. - GoogleCloudApigeeV1ListDeveloperAppsResponse: - properties: - app: + Required if `client_auth_enabled` is true. The resource ID of the + keystore. + protocols: + description: The TLS versioins to be used. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' - description: List of developer apps and their credentials. - id: GoogleCloudApigeeV1ListDeveloperAppsResponse - type: object - GoogleCloudApigeeV1ListApiProxiesResponse: - properties: - proxies: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' - type: array + type: string + id: GoogleCloudApigeeV1TlsInfo + GoogleCloudApigeeV1ProfileConfigAuthorization: + properties: {} type: object description: >- - To change this message, in the same CL add a change log in - go/changing-api-proto-breaks-ui - id: GoogleCloudApigeeV1ListApiProxiesResponse - GoogleCloudApigeeV1Point: - description: >- - Point is a group of information collected by runtime plane at critical - points of the message flow of the processed API request. This is a list - of supported point IDs, categorized to three major buckets. For each - category, debug points that we are currently supporting are listed - below: - Flow status debug points: StateChange FlowInfo Condition - Execution DebugMask Error - Flow control debug points: FlowCallout - Paused Resumed FlowReturn BreakFlow Error - Runtime debug points: - ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition - Oauth2ServicePoint RaiseFault NodeJS The detail information of the given - debug point is stored in a list of results. - type: object + By default, following policies will be included: - JWS - JWT - OAuth - + BasicAuth - APIKey + id: GoogleCloudApigeeV1ProfileConfigAuthorization + GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: + id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation properties: - id: - description: Name of a step in the transaction. + securityProfileRevisionId: + format: int64 + description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' + deprecated: true type: string - results: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Result' - type: array - description: List of results extracted from a given debug point. - id: GoogleCloudApigeeV1Point - GoogleCloudApigeeV1SecurityActionHttpHeader: - properties: name: - description: The header name to be sent to the target. + description: Immutable. Name of the environment that the profile is attached to. type: string - value: + attachTime: + description: >- + Output only. The time when environment was attached to the security + profile. + format: google-datetime type: string - description: The header value to be sent to the target. + readOnly: true + description: Represents a SecurityProfileEnvironmentAssociation resource. type: object - id: GoogleCloudApigeeV1SecurityActionHttpHeader - description: An HTTP header. - GoogleCloudApigeeV1SchemaSchemaProperty: - description: Properties for the schema field. + GoogleCloudApigeeV1DeploymentChangeReport: + id: GoogleCloudApigeeV1DeploymentChangeReport + description: >- + Response for GenerateDeployChangeReport and + GenerateUndeployChangeReport. This report contains any validation + failures that would cause the deployment to be rejected, as well changes + and conflicts in routing that may occur due to the new deployment. The + existence of a routing warning does not necessarily imply that the + deployment request is bad, if the desired state of the deployment + request is to effect a routing change. The primary purposes of the + routing messages are: 1) To inform users of routing changes that may + have an effect on traffic currently being routed to other existing + deployments. 2) To warn users if some base path in the proxy will not + receive traffic due to an existing deployment having already claimed + that base path. The presence of routing conflicts/changes will not cause + non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. type: object properties: - type: - type: string - description: Data type of the field. - createTime: - type: string + validationErrors: + $ref: '#/components/schemas/GoogleRpcPreconditionFailure' description: >- - Time the field was created in RFC3339 string form. For example: - `2016-02-26T10:23:09.592Z`. - custom: - description: >- - Flag that specifies whether the field is standard in the dataset or - a custom field created by the customer. `true` indicates that it is - a custom field. - type: string - id: GoogleCloudApigeeV1SchemaSchemaProperty - GoogleCloudApigeeV1RateRange: - id: GoogleCloudApigeeV1RateRange - description: >- - API call volume range and the fees charged when the total number of API - calls is within the range. + Validation errors that would cause the deployment change request to + be rejected. + routingChanges: + description: All routing changes that may result from a deployment request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + routingConflicts: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + type: array + description: All base path conflicts detected for a deployment request. + GoogleCloudApigeeV1ActivateNatAddressRequest: + id: GoogleCloudApigeeV1ActivateNatAddressRequest + properties: {} + description: Request for ActivateNatAddressRequest. Activate the nat address request. type: object + GoogleCloudApigeeV1RevisionStatus: properties: - start: - format: int64 - description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. + revisionId: type: string - fee: - description: >- - Fee to charge when total number of API calls falls within this - range. - $ref: '#/components/schemas/GoogleTypeMoney' - end: - format: int64 + description: The revision of the resource. + replicas: + type: integer + description: The number of replicas that have successfully loaded this revision. + format: int32 + errors: + type: array + description: Errors reported when attempting to load this revision. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' + jsonSpec: type: string description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - GoogleCloudApigeeV1ListExportsResponse: - description: The response for ListExports - id: GoogleCloudApigeeV1ListExportsResponse - properties: - exports: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' - description: Details of the export jobs. - type: array - type: object - GoogleCloudApigeeV1ReportProperty: - id: GoogleCloudApigeeV1ReportProperty + The json content of the resource revision. Large specs should be + sent individually via the spec field to avoid hitting request size + limits. type: object + id: GoogleCloudApigeeV1RevisionStatus + description: The status of a specific resource revision. + GoogleCloudApigeeV1Property: + id: GoogleCloudApigeeV1Property properties: value: - type: array - description: property values - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - property: type: string - description: name of the property - GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter: - properties: - scorePath: - description: >- - Optional. Return scores for this component. Example: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + description: The property value + name: type: string + description: The property key + description: A single property entry in the Properties message. type: object - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + GoogleCloudApigeeV1StatsHostStats: description: >- - Filter scores by component path. Used custom filter instead of AIP-160 - as the use cases are highly constrained and predictable. - GoogleCloudApigeeV1ListApiProductsResponse: + Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { + "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": + "example.com" } ]``` properties: - apiProduct: - description: Lists all API product names defined for an organization. + name: + type: string + description: Hostname used in query. + dimensions: + type: array + description: List of metrics grouped under dimensions. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' type: array - id: GoogleCloudApigeeV1ListApiProductsResponse + description: >- + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only the top-level metrics are provided. If + dimensions are included, then there will be a top-level dimensions + field under hostnames which will contain metrics values and the + dimension name. Example: ``` "hosts": [ { "dimensions": [ { + "metrics": [ { "name": "sum(message_count)", "values": [ + "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" + } ]``` OR ```"hosts": [ { "metrics": [ { "name": + "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": + "example.com" } ]``` List of metric values. + id: GoogleCloudApigeeV1StatsHostStats type: object - GoogleCloudApigeeV1Metric: - id: GoogleCloudApigeeV1Metric - description: >- - Encapsulates the metric data point. For example: ```{ "name": - "sum(message_count)", "values" : [ { "timestamp": 1549004400000, - "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] - }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` + GoogleCloudApigeeV1ApiCategory: properties: + siteId: + type: string + description: Name of the portal. + id: + description: ID of the category (a UUID). + type: string name: type: string - description: Metric name. - values: - description: >- - List of metric values. Possible value formats include: - `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": - 1232434354} ]` - type: array - items: - type: any - type: object - GoogleCloudApigeeV1GraphQLOperation: - id: GoogleCloudApigeeV1GraphQLOperation + description: Name of the category. + updateTime: + format: int64 + type: string + description: Time the category was last modified in milliseconds since epoch. + id: GoogleCloudApigeeV1ApiCategory + description: >- + `ApiCategory` represents an API category. [Catalog + items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) + can be tagged with API categories; users viewing the API catalog in the + portal will have the option to browse the catalog by category. type: object + GoogleCloudApigeeV1OrganizationProjectMapping: + id: GoogleCloudApigeeV1OrganizationProjectMapping properties: - operation: + organization: type: string + description: Name of the Apigee organization. + projectId: + description: Google Cloud project associated with the Apigee organization + type: string + location: description: >- - GraphQL operation name. The name and operation type will be used to - apply quotas. If no name is specified, the quota will be applied to - all GraphQL operations irrespective of their operation names in the - payload. - operationTypes: - description: >- - Required. GraphQL operation types. Valid values include `query` or - `mutation`. **Note**: Apigee does not currently support - `subscription` types. + Output only. The Google Cloud region where control plane data is + located. For more information, see + https://cloud.google.com/about/locations/. + type: string + readOnly: true + projectIds: items: type: string + deprecated: true type: array - description: >- - Represents the pairing of GraphQL operation types and the GraphQL - operation name. - GoogleCloudApigeeV1Properties: + description: >- + DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a + single project. + type: object + GoogleIamV1TestIamPermissionsResponse: properties: - property: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Property' - description: List of all properties in the object - id: GoogleCloudApigeeV1Properties + type: string + id: GoogleIamV1TestIamPermissionsResponse type: object - description: >- - Message for compatibility with legacy Edge specification for Java - Properties object in JSON. - GoogleCloudApigeeV1ProvisionOrganizationRequest: + description: Response message for `TestIamPermissions` method. + GoogleCloudApigeeV1ListAsyncQueriesResponse: + id: GoogleCloudApigeeV1ListAsyncQueriesResponse + description: The response for ListAsyncQueries. properties: - authorizedNetwork: + queries: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + description: The asynchronous queries belong to requested resource name. + type: object + GoogleCloudApigeeV1OASDocumentation: + id: GoogleCloudApigeeV1OASDocumentation + type: object + properties: + format: + readOnly: true + enumDescriptions: + - The format is not available. + - YAML format. + - JSON format. + enum: + - FORMAT_UNSPECIFIED + - YAML + - JSON type: string + description: Output only. The format of the input specification file contents. + spec: description: >- - Compute Engine network used for Service Networking to be peered with - Apigee runtime instances. See [Getting started with the Service - Networking - API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Apigee also supports shared VPC (that is, the host network project - is not the same as the one that is peering with Apigee). See [Shared - VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use - a shared VPC network, use the following format: - `projects/{host-project-id}/{region}/networks/{network-name}`. For - example: `projects/my-sharedvpc-host/global/networks/mynetwork` - disableVpcPeering: - description: >- - Optional. Flag that specifies whether the VPC Peering through - Private Google Access should be disabled between the consumer - network and Apigee. Required if an authorizedNetwork on the consumer - project is not provided, in which case the flag should be set to - true. The value must be set before the creation of any Apigee - runtime instance and can be updated only when there are no runtime - instances. **Note:** Apigee will be deprecating the vpc peering - model that requires you to provide 'authorizedNetwork', by making - the non-peering model as the default way of provisioning Apigee - organization in future. So, this will be a temporary flag to enable - the transition. Not supported for Apigee hybrid. - type: boolean - analyticsRegion: - type: string - description: >- - Primary Cloud Platform region for analytics data storage. For valid - values, see [Create an - organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). - Defaults to `us-west1`. - runtimeLocation: - description: >- - Cloud Platform location for the runtime instance. Defaults to zone - `us-west1-a`. If a region is provided, `EVAL` organizations will use - the region for automatically selecting a zone for the runtime - instance. - type: string - description: Request for ProvisionOrganization. - id: GoogleCloudApigeeV1ProvisionOrganizationRequest - type: object - GoogleCloudApigeeV1GrpcOperationGroup: - description: >- - List of gRPC operation configuration details associated with Apigee API - proxies. - properties: - operationConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' - description: >- - Required. List of operation configurations for either Apigee API - proxies that are associated with this API product. - id: GoogleCloudApigeeV1GrpcOperationGroup + Required. The documentation file contents for the OpenAPI + Specification. JSON and YAML file formats are supported. + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + description: OpenAPI Specification documentation for a catalog item. + GoogleTypeMoney: + id: GoogleTypeMoney + description: Represents an amount of money with its currency type. type: object - GoogleCloudApigeeV1GenerateDownloadUrlResponse: - description: Response for GenerateDownloadUrl method. - id: GoogleCloudApigeeV1GenerateDownloadUrlResponse properties: - downloadUri: + nanos: description: >- - The Google Cloud Storage signed URL that can be used to download the - Archive zip file. - type: string - type: object - GoogleCloudApigeeV1Organization: - id: GoogleCloudApigeeV1Organization - properties: - runtimeDatabaseEncryptionKeyName: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + currencyCode: + description: The three-letter currency code defined in ISO 4217. type: string + units: description: >- - Cloud KMS key name used for encrypting the data that is stored and - replicated across runtime instances. Update is not allowed after the - organization is created. If not specified or - [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption - key will be used. For example: - "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** - Not supported for Apigee hybrid. - description: - type: string - description: Description of the Apigee organization. - controlPlaneEncryptionKeyName: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - description: >- - Cloud KMS key name used for encrypting control plane data that is - stored in a multi region. Only used for the data residency region - "US" or "EU". If not specified or [BillingType](#BillingType) is - `EVALUATION`, a Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` - createdAt: format: int64 - description: >- - Output only. Time that the Apigee organization was created in - milliseconds since epoch. - readOnly: true - type: string - addonsConfig: - description: Addon configurations of the Apigee organization. - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' - apiConsumerDataEncryptionKeyName: + GoogleCloudApigeeV1ProfileConfigThreat: + description: >- + By default, following policies will be included: - XMLThreatProtection - + JSONThreatProtection + type: object + id: GoogleCloudApigeeV1ProfileConfigThreat + properties: {} + GoogleCloudApigeeV1Export: + type: object + description: Details of an export job. + properties: + name: + description: Display name of the export job. type: string - description: >- - Cloud KMS key name used for encrypting API consumer data. If not - specified or [BillingType](#BillingType) is `EVALUATION`, a - Google-Managed encryption key will be used. Format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*` - state: + updated: readOnly: true type: string - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. + description: Output only. Time the export job was last updated. + self: description: >- - Output only. State of the organization. Values other than ACTIVE - means the resource is not ready to use. - projectId: - readOnly: true - type: string - description: Output only. Project ID associated with the Apigee organization. - name: - description: Output only. Name of the Apigee organization. - type: string + Output only. Self link of the export job. A URI that can be used to + retrieve the status of an export job. Example: + `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` readOnly: true - type: - description: Not used by Apigee. - enum: - - TYPE_UNSPECIFIED - - TYPE_TRIAL - - TYPE_PAID - - TYPE_INTERNAL type: string - enumDescriptions: - - Subscription type not specified. - - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - - >- - Full subscription to Apigee has been purchased. See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - - For internal users only. - lastModifiedAt: + executionTime: readOnly: true - format: int64 description: >- - Output only. Time that the Apigee organization was last modified in - milliseconds since epoch. - type: string - subscriptionType: + Output only. Execution time for this export job. If the job is still + in progress, it will be set to the amount of time that has elapsed + since`created`, in seconds. Else, it will set to (`updated` - + `created`), in seconds. type: string - description: >- - Output only. DEPRECATED: This will eventually be replaced by - BillingType. Subscription type of the Apigee organization. Valid - values include trial (free, limited, and for evaluation purposes - only) or paid (full subscription has been purchased). See [Apigee - pricing](https://cloud.google.com/apigee/pricing/). - enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAID - - TRIAL - deprecated: true - enumDescriptions: - - Subscription type not specified. - - Full subscription to Apigee has been purchased. - - >- - Subscription to Apigee is free, limited, and used for evaluation - purposes only. - readOnly: true - apigeeProjectId: - description: >- - Output only. Apigee Project ID associated with the organization. Use - this project to allowlist Apigee in the Service Attachment when - using private service connect with Apigee. + description: type: string + description: Description of the export job. + created: + description: Output only. Time the export job was created. readOnly: true - subscriptionPlan: type: string + error: + description: Output only. Error is set when export fails readOnly: true - description: >- - Output only. Subscription plan that the customer has purchased. - Output only. - enum: - - SUBSCRIPTION_PLAN_UNSPECIFIED - - SUBSCRIPTION_2021 - - SUBSCRIPTION_2024 - enumDescriptions: - - Subscription plan not specified. - - Traditional subscription plan. - - >- - New subscription plan that provides standard proxy and scaled - proxy implementation. - apiConsumerDataLocation: - description: >- - This field is needed only for customers using non-default data - residency regions. Apigee stores some control plane data only in - single region. This field determines which single region Apigee - should use. For example: "us-west1" when control plane is in US or - "europe-west2" when control plane is in EU. type: string - portalDisabled: - description: Configuration for the Portals settings. - type: boolean - caCertificate: + datastoreName: type: string description: >- - Output only. Base64-encoded public certificate for the root CA of - the Apigee organization. Valid only when [RuntimeType](#RuntimeType) - is `CLOUD`. - format: byte + Name of the datastore that is the destination of the export job + [datastore] + state: + description: >- + Output only. Status of the export job. Valid values include + `enqueued`, `running`, `completed`, and `failed`. readOnly: true - analyticsRegion: - deprecated: true type: string + id: GoogleCloudApigeeV1Export + GoogleCloudApigeeV1ListDebugSessionsResponse: + type: object + id: GoogleCloudApigeeV1ListDebugSessionsResponse + properties: + nextPageToken: description: >- - Required. DEPRECATED: This field will eventually be deprecated and - replaced with a differently-named field. Primary Google Cloud region - for analytics data storage. For valid values, see [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - displayName: + Page token that you can include in a ListDebugSessionsRequest to + retrieve the next page. If omitted, no subsequent pages exist. type: string + sessions: description: >- - Display name for the Apigee organization. Unused, but reserved for - future use. - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - description: Properties defined in the Apigee organization profile. - customerName: + Session info that includes debug session ID and the first + transaction creation timestamp. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Session' + type: array + GoogleCloudApigeeV1ListApiProxiesResponse: + id: GoogleCloudApigeeV1ListApiProxiesResponse + properties: + proxies: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + type: object + GoogleCloudApigeeV1ReportInstanceStatusResponse: + description: Placeholder for future enhancements to status reporting protocol + type: object + id: GoogleCloudApigeeV1ReportInstanceStatusResponse + properties: {} + GoogleCloudApigeeV1SecurityActionsConfig: + properties: + updateTime: + format: google-datetime type: string - description: Not used by Apigee. - disableVpcPeering: - description: >- - Optional. Flag that specifies whether the VPC Peering through - Private Google Access should be disabled between the consumer - network and Apigee. Valid only when RuntimeType is set to CLOUD. - Required if an authorizedNetwork on the consumer project is not - provided, in which case the flag should be set to true. The value - must be set before the creation of any Apigee runtime instance and - can be updated only when there are no runtime instances. **Note:** - Apigee will be deprecating the vpc peering model that requires you - to provide 'authorizedNetwork', by making the non-peering model as - the default way of provisioning Apigee organization in future. So, - this will be a temporary flag to enable the transition. Not - supported for Apigee hybrid. - type: boolean - expiresAt: - description: >- - Output only. Time that the Apigee organization is scheduled for - deletion. - format: int64 readOnly: true - type: string - authorizedNetwork: + description: Output only. The update time for configuration. + name: type: string description: >- - Compute Engine network used for Service Networking to be peered with - Apigee runtime instances. See [Getting started with the Service - Networking - API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). - Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The - value must be set before the creation of a runtime instance and can - be updated only when there are no runtime instances. For example: - `default`. Apigee also supports shared VPC (that is, the host - network project is not the same as the one that is peering with - Apigee). See [Shared VPC - overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a - shared VPC network, use the following format: - `projects/{host-project-id}/{region}/networks/{network-name}`. For - example: `projects/my-sharedvpc-host/global/networks/mynetwork` - **Note:** Not supported for Apigee hybrid. - environments: - description: Output only. List of environments in the Apigee organization. - readOnly: true - items: - type: string - type: array - billingType: + This is a singleton resource, the name will always be set by + SecurityActions and any user input will be ignored. The name is + always: + `organizations/{org}/environments/{env}/security_actions_config` + enabled: + type: boolean description: >- - Billing type of the Apigee organization. See [Apigee - pricing](https://cloud.google.com/apigee/pricing). - enum: - - BILLING_TYPE_UNSPECIFIED - - SUBSCRIPTION - - EVALUATION - - PAYG - type: string - enumDescriptions: - - Billing type not specified. - - A pre-paid subscription to Apigee. - - Free and limited access to Apigee for evaluation purposes only. - - Access to Apigee using a Pay-As-You-Go plan. - runtimeType: - enum: - - RUNTIME_TYPE_UNSPECIFIED - - CLOUD - - HYBRID - enumDescriptions: - - Runtime type not specified. - - Google-managed Apigee runtime. - - User-managed Apigee hybrid runtime. + The flag that controls whether this feature is enabled. This is + `unset` by default. When this flag is `false`, even if individual + rules are enabled, no SecurityActions will be enforced. + description: >- + SecurityActionsConfig reflects the current state of the SecurityActions + feature. This is a singleton resource: https://google.aip.dev/156 + type: object + id: GoogleCloudApigeeV1SecurityActionsConfig + GoogleIamV1Policy: + type: object + id: GoogleIamV1Policy + properties: + etag: description: >- - Required. Runtime type of the Apigee organization based on the - Apigee subscription purchased. + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + format: byte type: string - attributes: + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array items: - type: string - description: Not used by Apigee. + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + bindings: type: array - type: object + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + version: + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + format: int32 + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). GoogleCloudApigeeV1SecurityReportResultMetadata: id: GoogleCloudApigeeV1SecurityReportResultMetadata type: object + description: Contains informations about the security report results. properties: - self: - type: string - description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` expires: readOnly: true + type: string description: >- Output only. Expire_time is set to 7 days after report creation. Query result will be unaccessable after this time. Example: "2021-05-04T13:38:52-07:00" + self: + description: >- + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` type: string - description: Contains informations about the security report results. - GoogleCloudApigeeV1ScoreComponent: - type: object - id: GoogleCloudApigeeV1ScoreComponent - description: Component is an individual security element that is scored. + GoogleCloudApigeeV1AppGroupAppKey: + description: >- + AppGroupAppKey contains all the information associated with the + credentials. properties: - scorePath: - type: string - description: >- - Path of the component. Example: - /org@myorg/envgroup@myenvgroup/proxies/proxy@myproxy - drilldownPaths: - type: array - items: - type: string - description: List of paths for next components. - score: - description: Score for the component. - type: integer - format: int32 - recommendations: - description: List of recommendations to improve API security. + attributes: type: array + description: List of attributes associated with the credential. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendation - calculateTime: - type: string - format: google-datetime - description: Time when score was calculated. - dataCaptureTime: - format: google-datetime - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + expiresInSeconds: + format: int64 description: >- - Time in the requested time period when data was last captured to - compute the score. - GoogleCloudApigeeV1OperationMetadataProgress: - id: GoogleCloudApigeeV1OperationMetadataProgress - description: Information about operation progress. - properties: - details: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: The additional details of the progress. - state: - description: State of the operation. - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED + Immutable. Expiration time, in seconds, for the consumer key. If not + set or left to the default value of `-1`, the API key never expires. + The expiration time can't be updated after it is set. type: string - description: + issuedAt: + format: int64 + description: >- + Output only. Time the AppGroup app was created in milliseconds since + epoch. type: string - description: Description of the operation's progress. - percentDone: - type: integer - format: int32 - description: The percentage of the operation progress. + readOnly: true + consumerKey: + type: string + description: Immutable. Consumer key. + expiresAt: + type: string + readOnly: true + format: int64 + description: >- + Output only. Time the AppGroup app expires in milliseconds since + epoch. + apiProducts: + readOnly: true + type: array + description: >- + Output only. List of API products and its status for which the + credential can be used. **Note**: Use + UpdateAppGroupAppKeyApiProductRequest API to make the association + after the consumer key and secret are created. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' + consumerSecret: + description: Secret key. + type: string + status: + type: string + description: >- + Status of the credential. Valid values include `approved` or + `revoked`. + scopes: + description: >- + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + type: array + items: + type: string + id: GoogleCloudApigeeV1AppGroupAppKey + type: object + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: + description: Response for BatchUpdateSecurityIncident. + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse type: object - GoogleIamV1TestIamPermissionsRequest: properties: - permissions: + securityIncidents: + description: Output only. Updated security incidents + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + readOnly: true + type: array + GoogleCloudApigeeV1Subscription: + id: GoogleCloudApigeeV1Subscription + properties: + name: description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). + Full name of the Pub/Sub subcription. Use the following structure in + your request: `subscription "projects/foo/subscription/bar"` + type: string + type: object + description: Pub/Sub subscription of an environment. + GoogleCloudApigeeV1ResourceStatus: + properties: + totalReplicas: + type: integer + description: The total number of replicas that should have this resource. + format: int32 + revisions: + description: Revisions of the resource currently deployed in the instance. items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' type: array - description: Request message for `TestIamPermissions` method. + uid: + type: string + description: >- + The uid of the resource. In the unexpected case that the instance + has multiple uids for the same name, they should be reported under + separate ResourceStatuses. + resource: + type: string + description: >- + The resource name. Currently only two resources are supported: + EnvironmentGroup - organizations/{org}/envgroups/{envgroup} + EnvironmentConfig - + organizations/{org}/environments/{environment}/deployedConfig type: object - id: GoogleIamV1TestIamPermissionsRequest + id: GoogleCloudApigeeV1ResourceStatus + description: The status of a resource loaded in the runtime. GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict: description: >- Describes a routing conflict that may cause a deployment not to receive traffic at some base path. + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict properties: - conflictingDeployment: - description: Existing base path/deployment causing the conflict. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment description: description: Human-readable description of this conflict. type: string environmentGroup: type: string description: Name of the environment group in which this conflict exists. - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict + conflictingDeployment: + description: Existing base path/deployment causing the conflict. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment type: object - GoogleCloudApigeeV1Access: - id: GoogleCloudApigeeV1Access + GoogleCloudApigeeV1DeleteResponse: properties: - Get: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessGet' - Remove: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessRemove' - Set: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessSet' + status: + type: string + description: Status of the operation. + gcpResource: + type: string + description: Google Cloud name of deleted resource. + errorCode: + type: string + description: Unique error code for the request, if any. + requestId: + description: Unique ID of the request. + type: string + message: + description: Description of the operation. + type: string + id: GoogleCloudApigeeV1DeleteResponse + description: Response for certain delete operations. type: object - GoogleCloudApigeeV1FlowHookConfig: + GoogleCloudApigeeV1ListSharedFlowsResponse: type: object - id: GoogleCloudApigeeV1FlowHookConfig + id: GoogleCloudApigeeV1ListSharedFlowsResponse + properties: + sharedFlows: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + type: array + GoogleCloudApigeeV1ListExportsResponse: + description: The response for ListExports + properties: + exports: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + description: Details of the export jobs. + type: array + type: object + id: GoogleCloudApigeeV1ListExportsResponse + GoogleCloudApigeeV1Reference: + description: >- + A Reference configuration. References must refer to a keystore that also + exists in the parent environment. + id: GoogleCloudApigeeV1Reference properties: - sharedFlowName: - type: string - description: >- - Name of the shared flow to invoke in the following format: - `organizations/{org}/sharedflows/{sharedflow}` name: description: >- - Name of the flow hook in the following format: - `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid - `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, and `PostTargetFlowHook` + Required. The resource id of this reference. Values must match the + regular expression [\w\s\-.]+. type: string - continueOnError: - type: boolean - description: >- - Flag that specifies whether the flow should abort after an error in - the flow hook. Defaults to `true` (continue on error). - GoogleCloudApigeeV1AsyncQueryResultView: - properties: - state: + resourceType: type: string - description: State of retrieving ResultView. - metadata: - description: >- - Metadata contains information like metrics, dimenstions etc of the - AsyncQuery. - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' - rows: - items: - type: any description: >- - Rows of query result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - type: array - error: - description: Error message when there is a failure. + The type of resource referred to by this reference. Valid values are + 'KeyStore' or 'TrustStore'. + description: + description: Optional. A human-readable description of this reference. type: string - code: - type: integer - format: int32 - description: Error code when there is a failure. - id: GoogleCloudApigeeV1AsyncQueryResultView + refers: + type: string + description: >- + Required. The id of the resource to which this reference refers. + Must be the id of a resource that exists in the parent environment + and is of the given resource_type. type: object - GoogleCloudApigeeV1OperationMetadata: + GoogleCloudApigeeV1DataCollectorConfig: type: object - description: Metadata describing an Operation. properties: - state: - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - FINISHED - enumDescriptions: - - '' - - '' - - '' - - '' + name: type: string - progress: - description: Progress of the operation. - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationMetadataProgress' - operationType: - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - OPERATION_TYPE_UNSPECIFIED - - INSERT - - DELETE - - UPDATE + description: >- + Name of the data collector in the following format: + `organizations/{org}/datacollectors/{datacollector}` + type: type: string - targetResourceName: - description: Name of the resource for which the operation is operating on. + description: Data type accepted by the data collector. + enumDescriptions: + - For future compatibility. + - For integer values. + - For float values. + - For string values. + - For boolean values. + - For datetime values. + enum: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME + id: GoogleCloudApigeeV1DataCollectorConfig + description: Data collector and its configuration. + GoogleCloudApigeeV1QueryMetadata: + id: GoogleCloudApigeeV1QueryMetadata + type: object + properties: + outputFormat: type: string - warnings: + description: Output format. + dimensions: + description: Dimensions of the AsyncQuery. + items: + type: string type: array + startTimestamp: + description: Start timestamp of the query range. + type: string + timeUnit: + type: string + description: Query GroupBy time unit. + endTimestamp: + description: End timestamp of the query range. + type: string + metrics: items: type: string - description: Warnings encountered while executing the operation. - id: GoogleCloudApigeeV1OperationMetadata - GoogleCloudApigeeV1Alias: + type: array + description: >- + Metrics of the AsyncQuery. Example: + ["name:message_count,func:sum,alias:sum_message_count"] + GoogleCloudApigeeV1GrpcOperationGroup: + type: object properties: - alias: - type: string + operationConfigs: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationConfig' + type: array description: >- - Resource ID for this alias. Values must match the regular expression - `[^/]{1,255}`. + Required. List of operation configurations for either Apigee API + proxies that are associated with this API product. + description: >- + List of gRPC operation configuration details associated with Apigee API + proxies. + id: GoogleCloudApigeeV1GrpcOperationGroup + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: + properties: + urls: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + type: array + description: The list of Signed URLs generated by the CreateAsyncQuery request + type: object + description: The response for GetAsyncQueryResultUrl + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + GoogleCloudApigeeV1ResourceFile: + type: object + properties: + name: + description: ID of the resource file. + type: string type: - description: Type of alias. type: string - enumDescriptions: - - Alias type is not specified. - - Certificate. - - Key/certificate pair. - enum: - - ALIAS_TYPE_UNSPECIFIED - - CERT - - KEY_CERT - certsInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' - description: Chain of certificates under this alias. - description: Reference to a certificate or key/certificate pair. + description: Resource file type. {{ resource_file_type }} + id: GoogleCloudApigeeV1ResourceFile + description: Metadata about a resource file. + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: + id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse type: object - id: GoogleCloudApigeeV1Alias - GoogleCloudApigeeV1RatePlan: - description: Rate plan details. - id: GoogleCloudApigeeV1RatePlan properties: - startTime: - type: string - format: int64 - description: Time when the rate plan becomes active in milliseconds since epoch. - billingPeriod: - description: Frequency at which the customer will be billed. - enum: - - BILLING_PERIOD_UNSPECIFIED - - WEEKLY - - MONTHLY + assessmentTime: + format: google-datetime + description: The time of the assessment api call. type: string - enumDescriptions: - - Billing period not specified. - - >- - Weekly billing period. **Note**: Not supported by Apigee at this - time. - - Monthly billing period. - endTime: - format: int64 + nextPageToken: description: >- - Time when the rate plan will expire in milliseconds since epoch. Set - to 0 or `null` to indicate that the rate plan should never expire. + A token that can be sent as `page_token` to retrieve the next page. + If this field is blank, there are no subsequent pages. type: string - createdAt: + securityAssessmentResults: + description: Default sort order is by resource name in alphabetic order. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' + description: Response for BatchComputeSecurityAssessmentResults. + GoogleCloudApigeeV1DeleteCustomReportResponse: + type: object + properties: + message: + description: The response contains only a message field. + type: string + id: GoogleCloudApigeeV1DeleteCustomReportResponse + GoogleCloudApigeeV1DimensionMetric: + id: GoogleCloudApigeeV1DimensionMetric + description: Encapsulates a metric grouped by dimension. + type: object + properties: + individualNames: + type: array + items: + type: string + description: Individual dimension names. E.g. ["dim1_name", "dim2_name"]. + name: + type: string + deprecated: true description: >- - Output only. Time that the rate plan was created in milliseconds - since epoch. + Comma joined dimension names. E.g. "dim1_name,dim2_name". + Deprecated. If name already has comma before join, we may get wrong + splits. Please use individual_names. + metrics: + description: List of metrics. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' + type: array + GoogleCloudApigeeV1SecurityProfile: + id: GoogleCloudApigeeV1SecurityProfile + description: Represents a SecurityProfile resource. + type: object + properties: + name: + description: >- + Immutable. Name of the security profile resource. Format: + organizations/{org}/securityProfiles/{profile} type: string - readOnly: true - format: int64 - currencyCode: + maxScore: + type: integer description: >- - Currency to be used for billing. Consists of a three-letter code as - defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) - standard. + Output only. Maximum security score that can be generated by this + profile. + format: int32 + readOnly: true + revisionCreateTime: + description: Output only. The time when revision was created. type: string + format: google-datetime + readOnly: true displayName: - description: Display name of the rate plan. type: string - description: - type: string - description: Description of the rate plan. - lastModifiedAt: - format: int64 + description: 'DEPRECATED: DO NOT USE Display name of the security profile.' + deprecated: true + profileConfig: description: >- - Output only. Time the rate plan was last modified in milliseconds - since epoch. + Required. Customized profile configuration that computes the + security score. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' + environments: + type: array + description: List of environments attached to security profile. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' + revisionPublishTime: + deprecated: true + format: google-datetime + description: >- + Output only. DEPRECATED: DO NOT USE The time when revision was + published. Once published, the security profile revision cannot be + updated further and can be attached to environments. type: string readOnly: true - apiproduct: - type: string - description: Name of the API product that the rate plan is associated with. - fixedFeeFrequency: + minScore: format: int32 type: integer - description: Frequency at which the fixed fee is charged. - fixedRecurringFee: - $ref: '#/components/schemas/GoogleTypeMoney' + readOnly: true description: >- - Fixed amount that is charged at a defined interval and billed in - advance of use of the API product. The fee will be prorated for the - first billing period. - consumptionPricingType: - enum: - - CONSUMPTION_PRICING_TYPE_UNSPECIFIED - - FIXED_PER_UNIT - - BANDED - - TIERED - - STAIRSTEP - enumDescriptions: - - Pricing model not specified. This is the default. - - Fixed rate charged for each API call. - - >- - Variable rate charged for each API call based on price tiers. - Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 - per call * 201-300 calls cost $1 per call * Total price for 50 - calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x - $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + - 50 x $1 = $400. **Note**: Not supported by Apigee at this time. - - '**Note**: Not supported by Apigee at this time.' - - '**Note**: Not supported by Apigee at this time.' + Output only. Minimum security score that can be generated by this + profile. + description: type: string - description: Pricing model used for consumption-based charges. - setupFee: - $ref: '#/components/schemas/GoogleTypeMoney' - description: Initial, one-time fee paid when purchasing the API product. - revenueShareRates: - type: array + description: Description of the security profile. + scoringConfigs: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' - description: Details of the revenue sharing model. - name: - description: Output only. Name of the rate plan. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig + type: array + description: List of profile scoring configs in this revision. + revisionId: + format: int64 readOnly: true + description: Output only. Revision ID of the security profile. type: string - consumptionPricingRates: - type: array - description: >- - API call volume ranges and the fees charged when the total number of - API calls is within a given range. The method used to calculate the - final fee depends on the selected pricing model. For example, if the - pricing model is `STAIRSTEP` and the ranges are defined as follows: - ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": - 200, "fee": 100 }, } ``` Then the following fees would be charged - based on the total number of API calls (assuming the currency - selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 - calls cost $100 The number of API calls cannot exceed 200. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' - paymentFundingModel: + revisionUpdateTime: + description: Output only. The time when revision was updated. + type: string + format: google-datetime + readOnly: true + GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: + description: The result of the assessment. + properties: + dataUpdateTime: type: string - enum: - - PAYMENT_FUNDING_MODEL_UNSPECIFIED - - PREPAID - - POSTPAID - enumDescriptions: - - Billing account type not specified. - - >- - Prepaid billing account type. Developer pays in advance for the - use of your API products. Funds are deducted from their prepaid - account balance. **Note**: Not supported by Apigee at this time. - - >- - Postpaid billing account type. Developer is billed through an - invoice after using your API products. description: >- - DEPRECATED: This field is no longer supported and will eventually be - removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, - use the `billingType` field inside `DeveloperMonetizationConfig` - resource. Flag that specifies the billing account type, prepaid or - postpaid. - deprecated: true - revenueShareType: + The time when resource data was last fetched for this resource. This + time may be different than when the resource was actually updated + due to lag in data collection. + format: google-datetime + severity: enum: - - REVENUE_SHARE_TYPE_UNSPECIFIED - - FIXED - - VOLUME_BANDED - enumDescriptions: - - Revenue share type is not specified. - - >- - Fixed percentage of the total revenue will be shared. The - percentage to be shared can be configured by the API provider. - - >- - Amount of revenue shared depends on the number of API calls. The - API call volume ranges and the revenue share percentage for each - volume can be configured by the API provider. **Note**: Not - supported by Apigee at this time. - description: Method used to calculate the revenue that is shared with developers. + - SEVERITY_UNSPECIFIED + - LOW + - MEDIUM + - HIGH + - MINIMAL type: string - state: - description: Current state of the rate plan (draft or published). + description: The severity of the assessment. enumDescriptions: - - State of the rate plan is not specified. - - Rate plan is in draft mode and only visible to API providers. - - >- - Rate plan is published and will become visible to developers for - the configured duration (between `startTime` and `endTime`). - type: string - enum: - - STATE_UNSPECIFIED - - DRAFT - - PUBLISHED + - Severity is not defined. + - Severity is low. + - Severity is medium. + - Severity is high. + - Severity is minimal + failedAssessmentPerWeight: + additionalProperties: + format: int32 + type: integer + type: object + description: >- + The number of failed assessments grouped by its weight. Keys are one + of the following: "MAJOR", "MODERATE", "MINOR". + score: + description: The security score of the assessment. + format: int32 + type: integer + assessmentRecommendations: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + description: >- + The recommendations of the assessment. The key is the "name" of the + assessment (not display_name), and the value are the + recommendations. + type: object + id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult type: object - GoogleCloudApigeeV1SecurityReportQuery: - description: Body structure when user makes a request to create a security report. + GoogleCloudApigeeV1Developer: type: object - id: GoogleCloudApigeeV1SecurityReportQuery + id: GoogleCloudApigeeV1Developer properties: - timeRange: - type: any - description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - filter: + userName: + description: Required. User name of the developer. Not used by Apigee hybrid. type: string + lastModifiedAt: description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax - displayName: - description: Security Report display name which users can specify. + Output only. Time at which the developer was last modified in + milliseconds since epoch. type: string - limit: - description: Maximum number of rows that can be returned in the result. - type: integer - format: int32 - metrics: - type: array - description: A list of Metrics. + readOnly: true + format: int64 + apps: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQueryMetric' - csvDelimiter: - type: string - description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - groupByTimeUnit: - type: string - description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - dimensions: + type: string + description: List of apps associated with the developer. + type: array + companies: + description: List of companies associated with the developer. items: type: string type: array + developerId: description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions - mimeType: + ID of the developer. **Note**: IDs are generated internally by + Apigee and are not guaranteed to stay the same over time. type: string + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. - reportDefinitionId: - description: Report Definition ID. + Optional. Developer attributes (name/value pairs). The custom + attribute limit is 18. + type: array + lastName: type: string - envgroupHostname: - description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostSecurityReport where analytics data will be grouped by - organization and hostname. + description: Required. Last name of the developer. + firstName: type: string - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest: - description: Request for BatchComputeSecurityAssessmentResults. - properties: - pageToken: + description: Required. First name of the developer. + accessType: + description: Access type. type: string + status: + readOnly: true description: >- - Optional. A page token, received from a previous - `BatchComputeSecurityAssessmentResults` call. Provide this to - retrieve the subsequent page. - includeAllResources: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - description: Include all resources under the scope. - profile: - description: Required. Name of the profile that is used for computation. + Output only. Status of the developer. Valid values are `active` and + `inactive`. type: string - include: - description: Include only these resources. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - scope: - description: >- - Required. Scope of the resources for the computation. For Apigee, - the environment is the scope of the resources. + appFamily: type: string - pageSize: - format: int32 + description: Developer app family. + organizationName: description: >- - Optional. The maximum number of results to return. The service may - return fewer than this value. If unspecified, at most 50 results - will be returned. - type: integer - type: object - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest - GoogleCloudApigeeV1Metadata: - description: Encapsulates additional information about query execution. - properties: - errors: - items: - type: string - description: List of error messages as strings. - type: array - notices: - description: >- - List of additional information such as data source, if result was - truncated. For example: ``` "notices": [ "Source:Postgres", "PG - Host:uappg0rw.e2e.apigeeks.net", "query served - by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: - edge.api.uapgroup2.agg_api" ]``` - items: - type: string - type: array - id: GoogleCloudApigeeV1Metadata - type: object - GoogleCloudApigeeV1PodStatus: - properties: - statusCode: - type: string - description: Code associated with the deployment status. - podName: - type: string - description: Name of the pod which is reporting the status. - deploymentStatusTime: - format: int64 - type: string - description: Time the deployment status was reported in milliseconds since epoch. - appVersion: - description: Version of the application running in the pod. - type: string - statusCodeDetails: - description: Human-readable message associated with the status code. - type: string - podStatusTime: - description: Time the pod status was reported in milliseconds since epoch. - format: int64 + Output only. Name of the Apigee organization in which the developer + resides. type: string - deploymentStatus: + readOnly: true + email: type: string description: >- - Status of the deployment. Valid values include: - `deployed`: - Successful. - `error` : Failed. - `pending` : Pod has not yet - reported on the deployment. - deploymentTime: + Required. Email address of the developer. This value is used to + uniquely identify the developer in Apigee hybrid. Note that the + email address has to be in lowercase only. + createdAt: format: int64 - type: string - description: Time the proxy was deployed in milliseconds since epoch. - podStatus: + readOnly: true type: string description: >- - Overall status of the pod (not this specific deployment). Valid - values include: - `active`: Up to date. - `stale` : Recently out of - date. Pods that have not reported status in a long time are excluded - from the output. - id: GoogleCloudApigeeV1PodStatus - type: object - GoogleCloudApigeeV1ProfileConfigThreat: + Output only. Time at which the developer was created in milliseconds + since epoch. + GoogleCloudApigeeV1ScoreComponentRecommendation: type: object - description: >- - By default, following policies will be included: - XMLThreatProtection - - JSONThreatProtection - properties: {} - id: GoogleCloudApigeeV1ProfileConfigThreat - GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: - description: Response for ComputeEnvironmentScores. - id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + description: Recommendation based on security concerns and score. + id: GoogleCloudApigeeV1ScoreComponentRecommendation properties: - nextPageToken: + description: + description: Description of the recommendation. type: string - description: >- - A page token, received from a previous `ComputeScore` call. Provide - this to retrieve the subsequent page. - scores: - type: array - description: List of scores. One score per day. + title: + description: Title represents recommendation title. + type: string + actions: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Score' - type: object - GoogleCloudApigeeV1RuntimeTraceConfigOverride: - id: GoogleCloudApigeeV1RuntimeTraceConfigOverride + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction + type: array + description: Actions for the recommendation to improve the security score. + impact: + format: int32 + type: integer + description: >- + Potential impact of this recommendation on the overall score. This + denotes how important this recommendation is to improve the score. + GoogleCloudApigeeV1DeveloperAppKey: type: object + id: GoogleCloudApigeeV1DeveloperAppKey properties: - apiProxy: + consumerKey: type: string + description: Consumer key. + expiresInSeconds: description: >- - Name of the API proxy that will have its trace configuration - overridden following format: `organizations/{org}/apis/{api}` - samplingConfig: - description: >- - Trace configuration override for a specific API proxy in an - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' - uid: - description: >- - Unique ID for the configuration override. The ID will only change if - the override is deleted and recreated. Corresponds to name's - "override" field. + Input only. Expiration time, in seconds, for the consumer key. If + not set or left to the default value of `-1`, the API key never + expires. The expiration time can't be updated after it is set. type: string - revisionId: + format: int64 + consumerSecret: type: string + description: Secret key. + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes associated with the credential. + type: array + apiProducts: + items: + type: any description: >- - Revision number which can be used by the runtime to detect if the - trace config override has changed between two versions. - revisionCreateTime: - description: The timestamp that the revision was created or updated. - type: string - format: google-datetime - name: + List of API products for which the credential can be used. **Note**: + Do not specify the list of API products when creating a consumer key + and secret for a developer app. Instead, use the + UpdateDeveloperAppKey API to make the association after the consumer + key and secret are created. + type: array + status: description: >- - Name of the trace config override in the following format: - `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` - type: string - description: >- - NEXT ID: 7 Trace configuration override for a specific API proxy in an - environment. - GoogleCloudApigeeV1TestDatastoreResponse: - properties: - state: + Status of the credential. Valid values include `approved` or + `revoked`. type: string - description: Output only. It could be `completed` or `failed` - readOnly: true - error: + issuedAt: + description: Time the developer app was created in milliseconds since epoch. type: string - description: Output only. Error message of test connection failure - readOnly: true - description: The response for TestDatastore - type: object - id: GoogleCloudApigeeV1TestDatastoreResponse - GoogleCloudApigeeV1AsyncQuery: - properties: - resultRows: format: int64 - description: ResultRows is available only after the query is completed. - type: string - self: + scopes: + items: + type: string + type: array description: >- - Self link of the query. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - type: string - envgroupHostname: - description: Hostname is available only when query is executed at host level. - type: string - result: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResult' - description: Result is available only after the query is completed. - resultFileSize: - type: string - description: ResultFileSize is available only after the query is completed. - created: + Scopes to apply to the app. The specified scope names must already + be defined for the API product that you associate with the app. + expiresAt: type: string - description: Creation time of the query. - queryParams: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' - description: >- - Contains information like metrics, dimenstions etc of the - AsyncQuery. + description: Time the developer app expires in milliseconds since epoch. + format: int64 + GoogleCloudApigeeV1QueryMetric: + type: object + properties: name: type: string - description: Asynchronous Query Name. - state: - description: Query state could be "enqueued", "running", "completed", "failed". - type: string - reportDefinitionId: - description: Asynchronous Report ID. + description: Required. Metric name. + function: + description: 'Aggregation function: avg, min, max, or sum.' type: string - updated: + alias: type: string - description: Last updated timestamp for the query. - executionTime: + description: >- + Alias for the metric. Alias will be used to replace metric name in + query results. + value: + description: Operand value should be provided when operator is set. type: string - description: ExecutionTime is available only after the query is completed. - error: - description: Error is set when query fails. + operator: type: string - type: object - id: GoogleCloudApigeeV1AsyncQuery - GoogleCloudApigeeV1ListAsyncQueriesResponse: - type: object - id: GoogleCloudApigeeV1ListAsyncQueriesResponse + description: One of `+`, `-`, `/`, `%`, `*`. + description: >- + More info about Metric: + https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + id: GoogleCloudApigeeV1QueryMetric + GoogleCloudApigeeV1ListArchiveDeploymentsResponse: properties: - queries: + archiveDeployments: + description: Archive Deployments in the specified environment. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' - description: The asynchronous queries belong to requested resource name. - description: The response for ListAsyncQueries. - GoogleCloudApigeeV1DisableSecurityActionRequest: - description: Message to disable an enabled SecurityAction. - properties: {} - id: GoogleCloudApigeeV1DisableSecurityActionRequest - type: object - GoogleIamV1Binding: - properties: - members: - type: array - items: - type: string - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + nextPageToken: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - role: + Page token that you can include in a ListArchiveDeployments request + to retrieve the next page. If omitted, no subsequent pages exist. type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. + id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse type: object - GoogleLongrunningListOperationsResponse: + description: Response for ListArchiveDeployments method. + GoogleCloudApigeeV1ProfileConfigCategory: properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: + mtls: + description: Checks to see if you have configured mTLS for the target server. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' + threat: + description: Checks to see if you have a threat protection policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' + cors: + description: Checks to see if you have CORS policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' + mediation: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' + description: Checks to see if you have a mediation policy in place. + authorization: + description: Checks to see if you have an authorization policy in place. + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' + abuse: + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - id: GoogleLongrunningListOperationsResponse - description: The response message for Operations.ListOperations. + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + id: GoogleCloudApigeeV1ProfileConfigCategory type: object - GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: description: >- - Represents security stats result as a collection of time series - sequences. + Advanced API Security provides security profile that scores the + following categories. + GoogleCloudApigeeV1GraphQLOperation: + id: GoogleCloudApigeeV1GraphQLOperation type: object + description: >- + Represents the pairing of GraphQL operation types and the GraphQL + operation name. properties: - values: - description: Results of the query returned as a JSON array. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - columns: + operation: + type: string description: >- - Column names corresponding to the same order as the inner values in - the stats field. + GraphQL operation name. The name and operation type will be used to + apply quotas. If no name is specified, the quota will be applied to + all GraphQL operations irrespective of their operation names in the + payload. + operationTypes: + description: >- + Required. GraphQL operation types. Valid values include `query` or + `mutation`. **Note**: Apigee does not currently support + `subscription` types. items: type: string type: array - nextPageToken: - type: string - description: Next page token. - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse - GoogleCloudApigeeV1DeveloperBalanceWallet: - id: GoogleCloudApigeeV1DeveloperBalanceWallet - description: Wallet used to manage an account balance for a particular currency. + GoogleCloudApigeeV1StatsEnvironmentStats: + type: object + id: GoogleCloudApigeeV1StatsEnvironmentStats properties: - balance: - $ref: '#/components/schemas/GoogleTypeMoney' + metrics: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' description: >- - Current remaining balance of the developer for a particular - currency. - lastCreditTime: + In the final response, only one of the following fields will be + present based on the dimensions provided. If no dimensions are + provided, then only top-level metrics is provided. If dimensions are + included, then there will be a top-level dimensions field under + environments which will contain metrics values and the dimension + name. Example: ``` "environments": [ { "dimensions": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], + "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": + [ { "metrics": [ { "name": "sum(message_count)", "values": [ + "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. + dimensions: + type: array + description: List of metrics grouped under dimensions. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' + name: type: string - format: int64 - description: >- - Output only. Time at which the developer last added credit to the - account in milliseconds since epoch. - readOnly: true + description: Name of the environment. + description: >- + Encapsulates the environment wrapper: ``` "environments": [ { "metrics": + [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], + "name": "prod" } ]``` + GoogleCloudApigeeV1ListDeveloperAppsResponse: type: object - GoogleCloudApigeeV1CustomReport: + id: GoogleCloudApigeeV1ListDeveloperAppsResponse + properties: + app: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + description: List of developer apps and their credentials. + GoogleCloudApigeeV1KeyValueMap: type: object - id: GoogleCloudApigeeV1CustomReport properties: - sortByCols: - description: 'Legacy field: not used much. Contains the list of sort by columns' + name: + description: Required. ID of the key value map. + type: string + encrypted: + description: >- + Required. Flag that specifies whether entry values will be + encrypted. This field is retained for backward compatibility and the + value of encrypted will always be `true`. Apigee X and hybrid do not + support unencrypted key value maps. + type: boolean + id: GoogleCloudApigeeV1KeyValueMap + description: Collection of key/value string pairs. + GoogleCloudApigeeV1SyncAuthorization: + properties: + identities: + type: array items: type: string - type: array - sortOrder: description: >- - Legacy field: not used much. Contains the sort order for the sort - columns - type: string - limit: - type: string + Required. Array of service accounts to grant access to control plane + resources, each specified using the following format: + `serviceAccount:` service-account-name. The service-account-name is + formatted like an email address. For example: + `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` + You might specify multiple service accounts, for example, if you + have multiple environments and wish to assign a unique service + account to each one. The service accounts must have **Apigee + Synchronizer Manager** role. See also [Create service + accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). + etag: description: >- - Legacy field: not used This field contains the limit for the result - retrieved - timeUnit: + Entity tag (ETag) used for optimistic concurrency control as a way + to help prevent simultaneous updates from overwriting each other. + For example, when you call + [getSyncAuthorization](organizations/getSyncAuthorization) an ETag + is returned in the response. Pass that ETag when calling the + [setSyncAuthorization](organizations/setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the + ETag in the call to `setSyncAuthorization`, then the existing + authorization is overwritten indiscriminately. **Note**: We strongly + recommend that you use the ETag in the read-modify-write cycle to + avoid race conditions. type: string - description: This field contains the time unit of aggregation for the report - properties: - description: This field contains report properties such as ui metadata etc. + format: byte + type: object + id: GoogleCloudApigeeV1SyncAuthorization + GoogleCloudApigeeV1ListCustomReportsResponse: + type: object + id: GoogleCloudApigeeV1ListCustomReportsResponse + description: This message encapsulates a list of custom report definitions + properties: + qualifier: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' type: array - offset: + GoogleCloudApigeeV1Alias: + type: object + id: GoogleCloudApigeeV1Alias + properties: + type: + enumDescriptions: + - Alias type is not specified. + - Certificate. + - Key/certificate pair. + description: Type of alias. type: string - description: 'Legacy field: not used. This field contains the offset for the data' - lastViewedAt: - format: int64 + enum: + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT + alias: description: >- - Output only. Last viewed time of this entity as milliseconds since - epoch - readOnly: true + Resource ID for this alias. Values must match the regular expression + `[^/]{1,255}`. type: string - dimensions: - items: - type: string - description: This contains the list of dimensions for the report + certsInfo: + description: Chain of certificates under this alias. + $ref: '#/components/schemas/GoogleCloudApigeeV1Certificate' + description: Reference to a certificate or key/certificate pair. + GoogleCloudApigeeV1ProfileConfigMTLS: + description: Checks to see if you have configured mTLS for the target server. + id: GoogleCloudApigeeV1ProfileConfigMTLS + properties: {} + type: object + GoogleCloudApigeeV1ListOrganizationsResponse: + type: object + properties: + organizations: type: array - environment: - type: string - readOnly: true - description: Output only. Environment name + description: List of Apigee organizations and associated Google Cloud projects. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping' + id: GoogleCloudApigeeV1ListOrganizationsResponse + GoogleCloudApigeeV1CustomReport: + id: GoogleCloudApigeeV1CustomReport + type: object + properties: fromTime: - description: 'Legacy field: not used. Contains the from time for the report' - type: string - createdAt: - format: int64 - readOnly: true type: string - description: 'Output only. Unix time when the app was created json key: createdAt' - tags: + description: 'Legacy field: not used. Contains the from time for the report' + sortByCols: type: array + description: 'Legacy field: not used much. Contains the list of sort by columns' items: type: string - description: >- - Legacy field: not used. This field contains a list of tags - associated with custom report - chartType: + offset: + description: 'Legacy field: not used. This field contains the offset for the data' type: string - description: This field contains the chart type for the report - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' - description: Required. This contains the list of metrics - type: array + environment: + description: Output only. Environment name + readOnly: true + type: string + sortOrder: + type: string + description: >- + Legacy field: not used much. Contains the sort order for the sort + columns topk: type: string description: >- Legacy field: not used. This field contains the top k parameter value for restricting the result - displayName: - type: string - description: This is the display name for the report - organization: - type: string - description: Output only. Organization name - readOnly: true - toTime: - description: 'Legacy field: not used. Contains the end time for the report' - type: string - filter: - type: string - description: This field contains the filter expression name: description: >- Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id type: string + timeUnit: + type: string + description: This field contains the time unit of aggregation for the report + chartType: + type: string + description: This field contains the chart type for the report lastModifiedAt: - format: int64 - readOnly: true description: >- Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt + format: int64 type: string - comments: + readOnly: true + metrics: + description: Required. This contains the list of metrics type: array - description: >- - Legacy field: not used. This field contains a list of comments - associated with custom report items: - type: string - GoogleCloudApigeeV1SecurityProfileScoringConfig: - id: GoogleCloudApigeeV1SecurityProfileScoringConfig - properties: - description: - description: Description of the config. + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReportMetric' + filter: type: string - scorePath: - description: Path of the component config used for scoring. + description: This field contains the filter expression + createdAt: + readOnly: true type: string - title: - description: Title of the config. + description: 'Output only. Unix time when the app was created json key: createdAt' + format: int64 + properties: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReportProperty' + type: array + description: This field contains report properties such as ui metadata etc. + toTime: + description: 'Legacy field: not used. Contains the end time for the report' type: string - type: object - description: Security configurations to manage scoring. - GoogleApiHttpBody: - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - type: object - properties: - data: + displayName: type: string - format: byte - description: The HTTP request/response body as raw binary. - contentType: + description: This is the display name for the report + organization: type: string - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - extensions: + description: Output only. Organization name + readOnly: true + comments: type: array items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + type: string description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. - id: GoogleApiHttpBody - GoogleCloudApigeeV1QueryTabularStatsResponse: - properties: - nextPageToken: - description: Next page token. - type: string - values: - description: Resultant rows from the executed query. + Legacy field: not used. This field contains a list of comments + associated with custom report + tags: type: array items: - type: array - items: - type: any - columns: + type: string description: >- - Column names corresponding to the same order as the inner values in - the stats field. + Legacy field: not used. This field contains a list of tags + associated with custom report + lastViewedAt: + format: int64 + readOnly: true + type: string + description: >- + Output only. Last viewed time of this entity as milliseconds since + epoch + dimensions: + description: This contains the list of dimensions for the report + type: array items: type: string - type: array - id: GoogleCloudApigeeV1QueryTabularStatsResponse - description: >- - Encapsulates two kinds of stats that are results of the dimensions and - aggregations requested. - Tabular rows. - Time series data. Example of - tabular rows, Represents security stats results as a row of flat values. - type: object - GoogleRpcPreconditionFailure: - id: GoogleRpcPreconditionFailure - type: object + limit: + type: string + description: >- + Legacy field: not used This field contains the limit for the result + retrieved + GoogleCloudApigeeV1EndpointAttachment: properties: - violations: - items: - $ref: '#/components/schemas/GoogleRpcPreconditionFailureViolation' - description: Describes all precondition violations. - type: array - description: >- - Describes what preconditions have failed. For example, if an RPC failed - because it required the Terms of Service to be acknowledged, it could - list the terms of service violation in the PreconditionFailure message. - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: - description: The message format of a recommendation from the assessment. - type: object - properties: - verdict: - enum: - - VERDICT_UNSPECIFIED - - PASS - - FAIL - description: Verdict indicates the assessment result. - type: string - enumDescriptions: - - The verdict is unspecified. - - The assessment has passed. - - The assessment has failed. - recommendations: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - description: The recommended steps of the assessment. - weight: - description: The weight of the assessment which was set in the profile. - type: string - enum: - - WEIGHT_UNSPECIFIED - - MINOR - - MODERATE - - MAJOR - enumDescriptions: - - The weight is unspecified. - - The weight is minor. - - The weight is moderate. - - The weight is major. - scoreImpact: + name: description: >- - Score impact indicates the impact on the overall score if the - assessment were to pass. - format: int32 - type: integer - displayName: - description: The display name of the assessment. + Name of the endpoint attachment. Use the following structure in your + request: + `organizations/{org}/endpointAttachments/{endpoint_attachment}` type: string - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation - GoogleCloudApigeeV1ListSharedFlowsResponse: - id: GoogleCloudApigeeV1ListSharedFlowsResponse - description: >- - To change this message, in the same CL add a change log in - go/changing-api-proto-breaks-ui - properties: - sharedFlows: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' - type: object - GoogleCloudApigeeV1ProfileConfigAbuse: - properties: {} - id: GoogleCloudApigeeV1ProfileConfigAbuse - type: object - description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - GoogleCloudApigeeV1Instance: - type: object - id: GoogleCloudApigeeV1Instance - description: Apigee runtime instance. - properties: - diskEncryptionKeyName: + connectionState: description: >- - Customer Managed Encryption Key (CMEK) used for disk and volume - encryption. If not specified, a Google-Managed encryption key will - be used. Use the following format: - `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` + Output only. State of the endpoint attachment connection to the + service attachment. + enum: + - CONNECTION_STATE_UNSPECIFIED + - UNAVAILABLE + - PENDING + - ACCEPTED + - REJECTED + - CLOSED + - FROZEN + - NEEDS_ATTENTION + enumDescriptions: + - The connection state has not been set. + - >- + The connection state is unavailable at this time, possibly because + the endpoint attachment is currently being provisioned. + - The connection is pending acceptance by the PSC producer. + - The connection has been accepted by the PSC producer. + - The connection has been rejected by the PSC producer. + - >- + The connection has been closed by the PSC producer and will not + serve traffic going forward. + - >- + The connection has been frozen by the PSC producer and will not + serve traffic. + - >- + The connection has been accepted by the PSC producer, but it is + not ready to serve the traffic due to producer side issues. type: string - lastModifiedAt: readOnly: true - description: >- - Output only. Time the instance was last modified in milliseconds - since epoch. - type: string - format: int64 - accessLoggingConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' - description: >- - Optional. Access logging configuration enables the access logging - feature at the instance. Apigee customers can enable access logging - to ship the access logs to their own project's cloud logging. - displayName: - description: Optional. Display name for the instance. + serviceAttachment: type: string + description: 'Format: projects/*/regions/*/serviceAttachments/*' location: - description: Required. Compute Engine location where the instance resides. - type: string - host: - readOnly: true - description: >- - Output only. Internal hostname or IP address of the Apigee endpoint - used by clients to connect to the service. type: string - serviceAttachment: - type: string - description: >- - Output only. Resource name of the service attachment created for the - instance in the format: `projects/*/regions/*/serviceAttachments/*` - Apigee customers can privately forward traffic to this service - attachment using the PSC endpoints. - readOnly: true - port: - description: Output only. Port number of the exposed Apigee endpoint. + description: Required. Location of the endpoint attachment. + state: type: string - readOnly: true - runtimeVersion: description: >- - Output only. Version of the runtime system running in the instance. - The runtime system is the set of components that serve the API Proxy - traffic in your Environments. - type: string - readOnly: true - state: - readOnly: true + Output only. State of the endpoint attachment. Values other than + `ACTIVE` mean the resource is not ready to use. enumDescriptions: - Resource is in an unspecified state. - Resource is being created. - Resource is provisioned and ready to use. - The resource is being deleted. - The resource is being updated. + readOnly: true enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - UPDATING - description: >- - Output only. State of the instance. Values other than `ACTIVE` means - the resource is not ready to use. - type: string - ipRange: - type: string - description: >- - Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 - used to create the Apigee instance. Providing CIDR ranges is - optional. You can provide just /22 or /28 or both (or neither). - Ranges you provide should be freely available as part of a larger - named range you have allocated to the Service Networking peering. If - this parameter is not provided, Apigee automatically requests an - available /22 and /28 CIDR block from Service Networking. Use the - /22 CIDR block for configuring your firewall needs to allow traffic - from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or - `a.b.c.d/22,e.f.g.h/28` - name: + host: type: string description: >- - Required. Resource ID of the instance. Values must match the regular - expression `^a-z{0,30}[a-z\d]$`. - consumerAcceptList: - type: array - description: >- - Optional. Customer accept list represents the list of projects - (id/number) on customer side that can privately connect to the - service attachment. It is an optional field which the customers can - provide during the instance creation. By default, the customer - project associated with the Apigee organization will be included to - the list. - items: - type: string - createdAt: - description: >- - Output only. Time the instance was created in milliseconds since - epoch. - type: string - format: int64 + Output only. Host that can be used in either the HTTP target + endpoint directly or as the host in target server. readOnly: true - description: - type: string - description: Optional. Description of the instance. - peeringCidrRange: - type: string - deprecated: true - enum: - - CIDR_RANGE_UNSPECIFIED - - SLASH_16 - - SLASH_17 - - SLASH_18 - - SLASH_19 - - SLASH_20 - - SLASH_22 - - SLASH_23 - enumDescriptions: - - Range not specified. - - '`/16` CIDR range.' - - '`/17` CIDR range.' - - '`/18` CIDR range.' - - '`/19` CIDR range.' - - '`/20` CIDR range.' - - '`/22` CIDR range. Supported for evaluation only.' - - '`/23` CIDR range. Supported for evaluation only.' - description: >- - Optional. Size of the CIDR block range that will be reserved by the - instance. PAID organizations support `SLASH_16` to `SLASH_20` and - defaults to `SLASH_16`. Evaluation organizations support only - `SLASH_23`. - GoogleCloudApigeeV1DatastoreConfig: - properties: - datasetName: - description: BigQuery dataset name Required for `bigquery` target_type. - type: string - tablePrefix: - description: Prefix of BigQuery table Required for `bigquery` target_type. - type: string - projectId: - type: string - description: Required. GCP project in which the datastore exists - bucketName: - type: string - description: Name of the Cloud Storage bucket. Required for `gcs` target_type. - path: - type: string - description: Path of Cloud Storage bucket Required for `gcs` target_type. - description: Configuration detail for datastore type: object - id: GoogleCloudApigeeV1DatastoreConfig - GoogleCloudApigeeV1RevenueShareRange: + id: GoogleCloudApigeeV1EndpointAttachment description: >- - API call volume range and the percentage of revenue to share with the - developer when the total number of API calls is within the range. + Apigee endpoint attachment. For more information, see [Southbound + networking patterns] + (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints). + GoogleCloudApigeeV1TargetServerConfig: + id: GoogleCloudApigeeV1TargetServerConfig type: object - id: GoogleCloudApigeeV1RevenueShareRange properties: - sharePercentage: - description: >- - Percentage of the revenue to be shared with the developer. For - example, to share 21 percent of the total revenue with the - developer, set this value to 21. Specify a decimal number with a - maximum of two digits following the decimal point. - format: double - type: number - start: + tlsInfo: + description: TLS settings for the target server. + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' + port: + type: integer + description: Port number for the target server. + format: int32 + enabled: + type: boolean description: >- - Starting value of the range. Set to 0 or `null` for the initial - range of values. - format: int64 + Whether the target server is enabled. An empty/omitted value for + this field should be interpreted as true. + protocol: + enum: + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + enumDescriptions: + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. + - >- + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy type: string - end: + description: The protocol used by this target server. + name: type: string description: >- - Ending value of the range. Set to 0 or `null` for the last range of - values. - format: int64 - GoogleCloudApigeeV1ConnectorsPlatformConfig: + Target server revision name in the following format: + `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` + host: + description: Host name of the target server. + type: string + GoogleProtobufEmpty: + properties: {} + type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: GoogleProtobufEmpty + GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: + description: Tuple representing a base path and the deployment containing it. type: object - id: GoogleCloudApigeeV1ConnectorsPlatformConfig - description: Configuration for the Connectors Platform add-on. properties: - enabled: - description: >- - Flag that specifies whether the Connectors Platform add-on is - enabled. - type: boolean - expiresAt: - readOnly: true + revision: type: string - format: int64 - description: >- - Output only. Time at which the Connectors Platform add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - GoogleCloudApigeeV1FlowHook: - id: GoogleCloudApigeeV1FlowHook + description: Name of the deployed API proxy revision containing the base path. + basepath: + type: string + description: Base path receiving traffic. + environment: + type: string + description: Name of the environment in which the proxy is deployed. + apiProxy: + type: string + description: Name of the deployed API proxy revision containing the base path. + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + GoogleCloudApigeeV1AccessGet: + id: GoogleCloudApigeeV1AccessGet + description: >- + Get action. For example, "Get" : { "name" : "target.name", "value" : + "default" } type: object properties: - flowHookPoint: - description: >- - Output only. Where in the API call flow the flow hook is invoked. - Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, - `PreTargetFlowHook`, or `PostTargetFlowHook`. - readOnly: true + name: type: string - continueOnError: + value: + type: string + GoogleCloudApigeeV1Result: + description: >- + Result is short for "action result", could be different types identified + by "action_result" field. Supported types: 1. DebugInfo : generic debug + info collected by runtime recorded as a list of properties. For example, + the contents could be virtual host info, state change result, or + execution metadata. Required fields : properties, timestamp 2. + RequestMessage: information of a http request. Contains headers, request + URI and http methods type.Required fields : headers, uri, verb 3. + ResponseMessage: information of a http response. Contains headers, + reason phrase and http status code. Required fields : headers, + reasonPhrase, statusCode 4. ErrorMessage: information of a http error + message. Contains detail error message, reason phrase and status code. + Required fields : content, headers, reasonPhrase, statusCode 5. + VariableAccess: a list of variable access actions, can be Get, Set and + Remove. Required fields : accessList + id: GoogleCloudApigeeV1Result + type: object + properties: + statusCode: + description: HTTP response code + type: string + timestamp: description: >- - Optional. Flag that specifies whether execution should continue if - the flow hook throws an exception. Set to `true` to continue - execution. Set to `false` to stop execution if the flow hook throws - an exception. Defaults to `true`. - type: boolean - sharedFlow: + Timestamp of when the result is recorded. Its format is dd-mm-yy + hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` + type: string + uRI: type: string description: >- - Shared flow attached to this flow hook, or empty if there is none - attached. - description: + The relative path of the api proxy. for example, `"uRI" : + "/iloveapis"` + reasonPhrase: + description: HTTP response phrase type: string - description: Description of the flow hook. - GoogleCloudApigeeV1Property: - properties: - value: + verb: + description: HTTP method verb type: string - description: The property value - name: + content: type: string - description: The property key - description: A single property entry in the Properties message. - id: GoogleCloudApigeeV1Property - type: object - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray - description: An array of resource messages. + description: >- + Error message content. for example, "content" : + "{\"fault\":{\"faultstring\":\"API timed + out\",\"detail\":{\"errorcode\":\"flow.APITimedOut\"}}}" + ActionResult: + description: >- + Type of the action result. Can be one of the five: DebugInfo, + RequestMessage, ResponseMessage, ErrorMessage, VariableAccess + type: string + headers: + description: >- + A list of HTTP headers. for example, '"headers" : [ { "name" : + "Content-Length", "value" : "83" }, { "name" : "Content-Type", + "value" : "application/json" } ]' + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + properties: + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + description: Name value pairs used for DebugInfo ActionResult. + accessList: + type: array + description: >- + A list of variable access actions agaist the api proxy. Supported + values: Get, Set, Remove. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Access' + GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: type: object + description: Request for BatchUpdateSecurityIncident. properties: - resources: + requests: description: >- - Required. The array of resources. For Apigee, the proxies are - resources. + Optional. Required. The request message specifying the resources to + update. A maximum of 1000 can be modified in a batch. type: array items: $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource - GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision: + #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest + id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + GoogleCloudApigeeV1ApiDocDocumentation: + type: object + description: The documentation for a catalog item. + id: GoogleCloudApigeeV1ApiDocDocumentation properties: - percentage: - format: int32 - description: Percentage of MP replicas reporting this revision. - type: integer - revision: - type: string - description: API proxy revision reported as deployed. + graphqlDocumentation: + description: Optional. GraphQL documentation. + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' + oasDocumentation: + $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' + description: Optional. OpenAPI Specification documentation. + GoogleCloudApigeeV1Operation: type: object - description: Revisions deployed in the MPs. - id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision - GoogleCloudApigeeV1ApiProxyRevision: + id: GoogleCloudApigeeV1Operation + description: >- + Represents the pairing of REST resource path and the actions (verbs) + allowed on the resource path. properties: - resources: - type: array - description: >- - List of the resources included in the API proxy revision formatted - as "{type}://{name}". + methods: items: type: string - proxyEndpoints: + type: array description: >- - List of ProxyEndpoints in the `/proxies` directory of the API proxy. - Typically, this element is included only when the API proxy was - created using the Edge UI. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. + methods refers to the REST verbs as in + https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none + specified, all verb types are allowed. + resource: + type: string + description: >- + Required. REST resource path associated with the API proxy or remote + service. + GoogleCloudApigeeV1QueryTimeSeriesStatsResponse: + properties: + columns: type: array + description: >- + Column names corresponding to the same order as the inner values in + the stats field. items: type: string - targetServers: - type: array - description: >- - List of TargetServers referenced in any TargetEndpoint in the API - proxy. Typically, you will see this element only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. - items: - type: string - name: - description: Name of the API proxy. - type: string - archive: - type: string - readOnly: true - description: >- - Output only. The archive that generated this proxy revision. This - field is only present on proxy revisions that were generated by an - archive. Proxies generated by archives cannot be updated, deleted, - or deployed to other environments. Format: - `organizations/*/environments/*/archiveDeployments/*` - type: - description: >- - Type. Set to `Application`. Maintained for compatibility with the - Apigee Edge API. + nextPageToken: type: string - hasExtensiblePolicy: - readOnly: true - description: >- - Output only. This field will be marked as true if revision contains - any policies marked as extensible. - type: boolean - integrationEndpoints: - items: - type: string - type: array - description: >- - List of IntegrationEndpoints in the '/integration-endpoints' - directory of the API proxy. This is a 'manifest' setting designed to - provide visibility into the contents of the API proxy. - resourceFiles: - description: List of resource files included in the API proxy revision. - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - policies: + description: Next page token. + values: type: array items: - type: string - description: List of policy names included in the API proxy revision.. - teams: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence + description: Results of the query returned as a JSON array. + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + type: object + description: >- + Represents security stats result as a collection of time series + sequences. + GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: + properties: + pageSize: + format: int32 + description: >- + Optional. The maximum number of subcomponents to be returned in a + single page. The service may return fewer than this value. If + unspecified, at most 100 subcomponents will be returned in a single + page. + type: integer + filters: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + description: >- + Optional. Filters are used to filter scored components. Return all + the components if no filter is mentioned. Example: [{ "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + }, { "scorePath": + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", + }] This will return components with path: + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" + OR + "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" type: array - description: List of the teams included in the API proxy revision. - lastModifiedAt: + pageToken: type: string - format: int64 description: >- - Time that the API proxy revision was last modified in milliseconds - since epoch. - spec: + Optional. A token that can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. + timeRange: description: >- - OpenAPI Specification that is associated with the API proxy. The - value is set to a URL or to a path in the specification store. + Required. Time range for score calculation. At most 14 days of + scores will be returned, and both the start and end dates must be + within the last 90 days. + $ref: '#/components/schemas/GoogleTypeInterval' + type: object + description: Request for ComputeEnvironmentScores. + id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + GoogleCloudApigeeV1ListSecurityProfilesResponse: + description: Response for ListSecurityProfiles. + id: GoogleCloudApigeeV1ListSecurityProfilesResponse + type: object + properties: + nextPageToken: type: string - targetEndpoints: - items: - type: string description: >- - List of TargetEndpoints in the `/targets` directory of the API - proxy. Typically, this element is included only when the API proxy - was created using the Edge UI. This is a 'manifest' setting designed - to provide visibility into the contents of the API proxy. - type: array - description: - type: string - description: Description of the API proxy revision. - revision: - type: string - description: API proxy revision. - sharedFlows: - description: List of the shared flows included in the API proxy revision. - items: - type: string - type: array - basepaths: - items: - type: string - description: Base URL of the API proxy. - type: array - entityMetaDataAsProperties: - additionalProperties: - type: string - type: object - description: Metadata describing the API proxy revision as a key-value map. - proxies: + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + securityProfiles: type: array items: - type: string - description: List of proxy names included in the API proxy revision. - configurationVersion: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' - description: >- - Version of the API proxy configuration schema to which the API proxy - conforms. Currently, the only supported value is 4.0 - (`majorVersion.minorVersion`). This setting may be used in the - future to track the evolution of the API proxy format. - createdAt: - format: int64 + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' description: >- - Time that the API proxy revision was created in milliseconds since - epoch. - type: string - targets: - items: - type: string - description: List of the targets included in the API proxy revision. - type: array - contextInfo: - type: string - description: Revision number, app name, and organization for the API proxy. - displayName: + List of security profiles in the organization. The profiles may be + attached or unattached to any environment. This will return latest + revision of each profile. + GoogleCloudApigeeV1AccessRemove: + type: object + description: >- + Remove action. For example, "Remove" : { "name" : "target.name", + "success" : true } + properties: + name: type: string - description: Human-readable name of the API proxy. - id: GoogleCloudApigeeV1ApiProxyRevision + success: + type: boolean + id: GoogleCloudApigeeV1AccessRemove + GoogleCloudApigeeV1RuntimeAnalyticsConfig: type: object - description: API proxy revision. - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse: - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse - description: Response for BatchUpdateSecurityIncident. + description: Runtime configuration for the Analytics add-on. + id: GoogleCloudApigeeV1RuntimeAnalyticsConfig + properties: + billingPipelineEnabled: + description: If Runtime should send billing data to AX or not. + type: boolean + enabled: + type: boolean + description: If the Analytics is enabled or not. + GoogleCloudApigeeV1ReportProperty: type: object + id: GoogleCloudApigeeV1ReportProperty properties: - securityIncidents: - readOnly: true + value: + description: property values type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' - description: Output only. Updated security incidents - GoogleCloudApigeeV1ProfileConfig: - id: GoogleCloudApigeeV1ProfileConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + property: + description: name of the property + type: string + GoogleCloudApigeeV1RuntimeApiSecurityConfig: + properties: + enabled: + type: boolean + description: If the API Security is enabled or not. + type: object + description: Runtime configuration for the API Security add-on. + id: GoogleCloudApigeeV1RuntimeApiSecurityConfig + GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: + description: Response for ListEnvironmentGroupAttachments. type: object properties: - categories: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' + environmentGroupAttachments: type: array - description: List of categories of profile config. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' + description: EnvironmentGroupAttachments for the specified environment group. + nextPageToken: + description: >- + Page token that you can include in a ListEnvironmentGroupAttachments + request to retrieve the next page. If omitted, no subsequent pages + exist. + type: string + id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + GoogleCloudApigeeV1AccessSet: description: >- - ProfileConfig defines a set of categories and policies which will be - used to compute security score. - GoogleCloudApigeeV1RuntimeTraceSamplingConfig: + Set action. For example, "Set" : { "name" : "target.name", "success" : + true, "value" : "default" } + type: object properties: - sampler: - enumDescriptions: - - Sampler unspecified. - - >- - OFF means distributed trace is disabled, or the sampling - probability is 0. - - >- - PROBABILITY means traces are captured on a probability that - defined by sampling_rate. The sampling rate is limited to 0 to 0.5 - when this is set. + name: type: string - description: Sampler of distributed tracing. OFF is the default value. - enum: - - SAMPLER_UNSPECIFIED - - 'OFF' - - PROBABILITY - samplingRate: - format: float - type: number - description: >- - Field sampling rate. This value is only applicable when using the - PROBABILITY sampler. The supported values are > 0 and <= 0.5. - description: >- - NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of - distributed tracing. Only the fields that are defined in the distributed - trace configuration can be overridden using the distribute trace - configuration override APIs. - type: object - id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig - GoogleCloudApigeeV1SecurityAction: - id: GoogleCloudApigeeV1SecurityAction + success: + type: boolean + value: + type: string + id: GoogleCloudApigeeV1AccessSet + GoogleCloudApigeeV1ApiDocDocumentationResponse: type: object - description: >- - A SecurityAction is rule that can be enforced at an environment level. - The result is one of: - A denied API call - An explicitly allowed API - call - A flagged API call (HTTP headers added before the target receives - it) At least one condition is required to create a SecurityAction. properties: - description: - description: >- - Optional. An optional user provided description of the - SecurityAction. + message: + readOnly: true + description: Output only. Description of the operation. type: string - name: - description: >- - Immutable. This field is ignored during creation as per AIP-133. - Please set the `security_action_id` field in the - CreateSecurityActionRequest when creating a new SecurityAction. - Format: - organizations/{org}/environments/{env}/securityActions/{security_action} + errorCode: + description: Output only. Unique error code for the request, if any. type: string - conditionConfig: - description: >- - Required. A valid SecurityAction must contain at least one - condition. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig - flag: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' - description: Flag a request through if it matches this SecurityAction. - updateTime: - format: google-datetime - description: >- - Output only. The update time for this SecurityAction. This reflects - when this SecurityAction changed states. + readOnly: true + requestId: + description: Output only. Unique ID of the request. readOnly: true type: string - state: - description: >- - Required. Only an ENABLED SecurityAction is enforced. An ENABLED - SecurityAction past its expiration time will not be enforced. - enumDescriptions: - - >- - The default value. This only exists for forward compatibility. A - create request with this value will be rejected. - - >- - An ENABLED SecurityAction is actively enforced if the - `expiration_time` is in the future. - - A disabled SecurityAction is never enforced. + data: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + readOnly: true + description: Output only. The documentation resource. + status: type: string + readOnly: true + description: Output only. Status of the operation. + description: >- + The catalog item documentation wrapped with response status, error_code, + etc. + id: GoogleCloudApigeeV1ApiDocDocumentationResponse + GoogleCloudApigeeV1DataCollector: + properties: + type: + enumDescriptions: + - For future compatibility. + - For integer values. + - For float values. + - For string values. + - For boolean values. + - For datetime values. enum: - - STATE_UNSPECIFIED - - ENABLED - - DISABLED - createTime: + - TYPE_UNSPECIFIED + - INTEGER + - FLOAT + - STRING + - BOOLEAN + - DATETIME type: string - format: google-datetime + description: Immutable. The type of data this data collector will collect. + createdAt: + description: >- + Output only. The time at which the data collector was created in + milliseconds since the epoch. + format: int64 readOnly: true - description: Output only. The create time for this SecurityAction. - ttl: - description: Input only. The TTL for this SecurityAction. - format: google-duration type: string - expireTime: + description: type: string - description: The expiration for this SecurityAction. - format: google-datetime - allow: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' - description: Allow a request through if it matches this SecurityAction. - deny: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' - description: Deny a request through if it matches this SecurityAction. - GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse: - id: GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + description: A description of the data collector. + name: + type: string + description: ID of the data collector. Must begin with `dc_`. + lastModifiedAt: + format: int64 + readOnly: true + type: string + description: >- + Output only. The time at which the Data Collector was last updated + in milliseconds since the epoch. + description: Data collector configuration. + type: object + id: GoogleCloudApigeeV1DataCollector + GoogleCloudApigeeV1SecurityReportMetadata: + description: Metadata for the security report. type: object properties: - environmentGroupAttachments: + endTimestamp: + description: End timestamp of the query range. + format: google-datetime + type: string + startTimestamp: + type: string + description: Start timestamp of the query range. + format: google-datetime + mimeType: + description: MIME type / Output format. + type: string + metrics: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment' + type: string type: array - description: EnvironmentGroupAttachments for the specified environment group. - nextPageToken: - type: string description: >- - Page token that you can include in a ListEnvironmentGroupAttachments - request to retrieve the next page. If omitted, no subsequent pages - exist. - description: Response for ListEnvironmentGroupAttachments. - GoogleCloudApigeeV1KeystoreConfig: + Metrics of the SecurityReport. Example: + ["name:bot_count,func:sum,alias:sum_bot_count"] + timeUnit: + type: string + description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' + dimensions: + type: array + items: + type: string + description: Dimensions of the SecurityReport. + id: GoogleCloudApigeeV1SecurityReportMetadata + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: + properties: {} type: object - id: GoogleCloudApigeeV1KeystoreConfig + description: Message for include_all option. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll + GoogleCloudApigeeV1AliasRevisionConfig: + type: object + id: GoogleCloudApigeeV1AliasRevisionConfig properties: + location: + type: string + description: Location of the alias file. For example, a Google Cloud Storage URI. + type: + enumDescriptions: + - Alias type is not specified. + - Certificate. + - Key/certificate pair. + type: string + enum: + - ALIAS_TYPE_UNSPECIFIED + - CERT + - KEY_CERT name: description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` + Name of the alias revision included in the keystore in the following + format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}/revisions/{rev}` type: string - aliases: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AliasRevisionConfig' - description: Aliases in the keystore. - GoogleCloudApigeeV1DeleteResponse: - description: Response for certain delete operations. + GoogleCloudApigeeV1Environment: + id: GoogleCloudApigeeV1Environment properties: - gcpResource: - description: Google Cloud name of deleted resource. - type: string - requestId: + deploymentType: + enum: + - DEPLOYMENT_TYPE_UNSPECIFIED + - PROXY + - ARCHIVE type: string - description: Unique ID of the request. - message: - description: Description of the operation. + enumDescriptions: + - Deployment type not specified. + - >- + Proxy deployment enables you to develop and deploy API proxies + using Apigee on Google Cloud. This cannot currently be combined + with the CONFIGURABLE API proxy type. + - >- + Archive deployment enables you to develop API proxies locally then + deploy an archive of your API proxy configuration to an + environment in Apigee on Google Cloud. You will be prevented from + performing a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment. + description: >- + Optional. Deployment type supported by the environment. The + deployment type can be set when creating the environment and cannot + be changed. When you enable archive deployment, you will be + **prevented from performing** a [subset of + actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) + within the environment, including: * Managing the deployment of API + proxy or shared flow revisions * Creating, updating, or deleting + resource files * Creating, updating, or deleting target servers + forwardProxyUri: + description: >- + Optional. URI of the forward proxy to be applied to the runtime + instances in this environment. Must be in the format of + {scheme}://{hostname}:{port}. Note that the scheme must be one of + "http" or "https", and the port must be supplied. To remove a + forward proxy setting, update the field to an empty value. Note: At + this time, PUT operations to add forwardProxyUri to an existing + environment fail if the environment has nodeConfig set up. To + successfully add the forwardProxyUri setting in this case, include + the NodeConfig details with the request. type: string - status: - description: Status of the operation. + description: type: string - errorCode: + description: Optional. Description of the environment. + state: type: string - description: Unique error code for the request, if any. - type: object - id: GoogleCloudApigeeV1DeleteResponse - GoogleIamV1Policy: - type: object - id: GoogleIamV1Policy - properties: - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - type: string - format: byte - bindings: - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - type: array + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + readOnly: true description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - version: - format: int32 - type: integer + Output only. State of the environment. Values other than ACTIVE + means the resource is not ready to use. + nodeConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' + description: Optional. NodeConfig of the environment. + properties: description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - auditConfigs: - type: array - description: Specifies cloud audit logging configuration for this policy. - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - GoogleCloudApigeeV1CertInfo: - description: X.509 certificate as defined in RFC 5280. - type: object - properties: - expiryDate: - description: X.509 `notAfter` validity period in milliseconds since epoch. + Optional. Key-value pairs that may be used for customizing the + environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' + name: type: string + description: >- + Required. Name of the environment. Values must match the regular + expression `^[.\\p{Alnum}-_]{1,255}$` + createdAt: format: int64 - subjectAlternativeNames: - description: X.509 subject alternative names (SANs) extension. - items: - type: string - type: array - subject: - type: string - description: X.509 subject. - issuer: - description: X.509 issuer. type: string - version: - format: int32 - description: X.509 version. - type: integer - publicKey: - type: string - description: Public key component of the X.509 subject public key info. - sigAlgName: - type: string - description: X.509 signatureAlgorithm. - basicConstraints: - description: X.509 basic constraints extension. + readOnly: true + description: >- + Output only. Creation time of this environment as milliseconds since + epoch. + hasAttachedFlowHooks: + type: boolean + lastModifiedAt: type: string - serialNumber: + format: int64 + readOnly: true + description: >- + Output only. Last modification time of this environment as + milliseconds since epoch. + type: + enumDescriptions: + - Environment type not specified. + - >- + This is the default type. Base environment has limited capacity + and capabilities and are usually used when you are getting started + with Apigee or while experimenting. Refer to Apigee's public + documentation for more details. + - >- + Intermediate environment supports API management features and + higher capacity than Base environment. Refer to Apigee's public + documentation for more details. + - >- + Comprehensive environment supports advanced capabilites and even + higher capacity than Intermediate environment. Refer to Apigee's + public documentation for more details. + description: Optional. EnvironmentType selected for the environment. type: string - description: X.509 serial number. - isValid: + enum: + - ENVIRONMENT_TYPE_UNSPECIFIED + - BASE + - INTERMEDIATE + - COMPREHENSIVE + displayName: type: string + description: Optional. Display name for this environment. + apiProxyType: description: >- - Flag that specifies whether the certificate is valid. Flag is set to - `Yes` if the certificate is valid, `No` if expired, or `Not yet` if - not yet valid. - validFrom: - format: int64 - description: X.509 `notBefore` validity period in milliseconds since epoch. + Optional. API Proxy type supported by the environment. The type can + be set when creating the Environment and cannot be changed. type: string - id: GoogleCloudApigeeV1CertInfo - GoogleCloudApigeeV1AccessLoggingConfig: - id: GoogleCloudApigeeV1AccessLoggingConfig - description: >- - Access logging configuration enables customers to ship the access logs - from the tenant projects to their own project's cloud logging. The - feature is at the instance level ad disabled by default. It can be - enabled during CreateInstance or UpdateInstance. + enumDescriptions: + - API proxy type not specified. + - >- + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. + - >- + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + type: object + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray: properties: - enabled: + resources: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource + type: array description: >- - Optional. Boolean flag that specifies whether the customer access - log feature is enabled. - type: boolean - filter: + Required. The array of resources. For Apigee, the proxies are + resources. + description: An array of resource messages. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray + type: object + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: + description: The format of the assessment recommendation. + properties: + description: type: string - description: >- - Optional. Ship the access log entries that match the status_code - defined in the filter. The status_code is the only - expected/supported filter field. (Ex: status_code) The filter will - parse it to the Common Expression Language semantics for expression - evaluation to build the filter condition. (Ex: "filter": status_code - >= 200 && status_code < 300 ) + description: The description of the recommendation. + link: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + description: The link for the recommendation. type: object - GoogleCloudApigeeV1APIProductAssociation: + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + GoogleCloudApigeeV1DeploymentChangeReportRoutingChange: + description: >- + Describes a potential routing change that may occur as a result of some + deployment operation. type: object - id: GoogleCloudApigeeV1APIProductAssociation properties: - status: - type: string + shouldSequenceRollout: + type: boolean description: >- - The API product credential associated status. Valid values are - `approved` or `revoked`. - apiproduct: - description: API product to be associated with the credential. + Set to `true` if using sequenced rollout would make this routing + change safer. **Note**: This does not necessarily imply that + automated sequenced rollout mode is supported for the operation. + description: + description: Human-readable description of this routing change. type: string - description: >- - APIProductAssociation has the API product and its administrative state - association. - GoogleCloudApigeeV1ApiProductRef: + environmentGroup: + description: Name of the environment group affected by this routing change. + type: string + fromDeployment: + description: Base path/deployment that may stop receiving some traffic. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + toDeployment: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment + description: >- + Base path/deployment that may start receiving that traffic. May be + null if no deployment is able to receive the traffic. + id: GoogleCloudApigeeV1DeploymentChangeReportRoutingChange + GoogleCloudApigeeV1GraphqlDocumentation: + description: GraphQL documentation for a catalog item. + id: GoogleCloudApigeeV1GraphqlDocumentation type: object properties: - apiproduct: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DocumentationFile' + description: Required. The documentation file contents for the GraphQL schema. + endpointUri: + description: >- + Required. The GraphQL endpoint URI to be queried by API consumers. + Max length is 2,083 characters. type: string - description: Name of the API product. - status: + GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext: + properties: + documentationLink: type: string - description: Status of the API product. Valid values are `approved` or `revoked`. - id: GoogleCloudApigeeV1ApiProductRef - GoogleCloudApigeeV1EnableSecurityActionRequest: - properties: {} - id: GoogleCloudApigeeV1EnableSecurityActionRequest - description: Message to enable a disabled SecurityAction. + description: Documentation link for the action. + description: Action context are all the relevant details for the action. type: object - GoogleCloudApigeeV1StatsEnvironmentStats: + id: GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext + GoogleCloudApigeeV1FlowHook: type: object - id: GoogleCloudApigeeV1StatsEnvironmentStats - description: >- - Encapsulates the environment wrapper: ``` "environments": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], - "name": "prod" } ]``` properties: - dimensions: - description: List of metrics grouped under dimensions. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - name: + description: type: string - description: Name of the environment. - metrics: - type: array + description: Description of the flow hook. + continueOnError: description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only top-level metrics is provided. If dimensions are - included, then there will be a top-level dimensions field under - environments which will contain metrics values and the dimension - name. Example: ``` "environments": [ { "dimensions": [ { "metrics": - [ { "name": "sum(message_count)", "values": [ "2.14049521E8" ] } ], - "name": "nit_proxy" } ], "name": "prod" } ]``` or ```"environments": - [ { "metrics": [ { "name": "sum(message_count)", "values": [ - "2.19026331E8" ] } ], "name": "prod" } ]``` List of metric values. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - GoogleCloudApigeeV1AccessSet: - description: >- - Set action. For example, "Set" : { "name" : "target.name", "success" : - true, "value" : "default" } - type: object - properties: - name: + Optional. Flag that specifies whether execution should continue if + the flow hook throws an exception. Set to `true` to continue + execution. Set to `false` to stop execution if the flow hook throws + an exception. Defaults to `true`. + type: boolean + sharedFlow: type: string + description: >- + Shared flow attached to this flow hook, or empty if there is none + attached. + flowHookPoint: + description: >- + Output only. Where in the API call flow the flow hook is invoked. + Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, or `PostTargetFlowHook`. + type: string + readOnly: true + id: GoogleCloudApigeeV1FlowHook + GoogleCloudApigeeV1TlsInfoCommonName: + properties: value: + description: The TLS Common Name string of the certificate. type: string - success: + wildcardMatch: type: boolean - id: GoogleCloudApigeeV1AccessSet - GoogleCloudApigeeV1OptimizedStats: - properties: - Response: description: >- - Wraps the `stats` response for JavaScript Optimized Scenario with a - response key. For example: ```{ "Response": { "TimeUnit": [], - "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table - used: edge.api.aaxgroup001.agg_api", "PG - Host:ruappg08-ro.production.apigeeks.net", "query served - by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": - false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" - ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": - "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": - "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' + Indicates whether the cert should be matched against as a wildcard + cert. type: object - id: GoogleCloudApigeeV1OptimizedStats - GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest: + id: GoogleCloudApigeeV1TlsInfoCommonName + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink: + type: object + description: The format for a link in the recommendation. properties: - apiProducts: - items: - type: string - description: >- - The list of API products that will be associated with the - credential. This list will be appended to the existing list of - associated API Products for this App Key. Duplicates will be - ignored. - type: array - action: + text: type: string - description: >- - Approve or revoke the consumer key by setting this value to - `approve` or `revoke` respectively. The `Content-Type` header, if - set, must be set to `application/octet-stream`, with empty body. - appGroupAppKey: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' - description: >- - The new AppGroupKey to be amended. Note that the status can be - updated only via action. + description: 'The text of the url. (ie: "Learn more")' + uri: + type: string + description: The link itself. + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink + GoogleCloudApigeeV1OptimizedStatsResponse: type: object - description: Request for UpdateAppGroupAppKey - id: GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest - GoogleCloudApigeeV1GraphQLOperationConfig: - id: GoogleCloudApigeeV1GraphQLOperationConfig - description: >- - Binds the resources in a proxy or remote service with the GraphQL - operation and its associated quota enforcement. + description: Encapsulates a response format for JavaScript Optimized Scenario. properties: - quota: + resultTruncated: + type: boolean description: >- - Quota parameters to be enforced for the resources, methods, and API - source combination. If none are specified, quota enforcement will - not be done. - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - attributes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: Custom attributes associated with the operation. - operations: - type: array + Boolean flag that indicates whether the results were truncated based + on the limit parameter. + TimeUnit: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' - description: >- - Required. List of GraphQL name/operation type pairs for the proxy or - remote service to which quota will be applied. If only operation - types are specified, the quota will be applied to all GraphQL - requests irrespective of the GraphQL name. **Note**: Currently, you - can specify only a single GraphQLOperation. Specifying more than one - will cause the operation to fail. - apiSource: - type: string + format: int64 + type: string description: >- - Required. Name of the API proxy endpoint or remote service with - which the GraphQL operation and quota are associated. - type: object - GoogleCloudApigeeV1SecurityProfile: - description: Represents a SecurityProfile resource. + List of time unit values. Time unit refers to an epoch timestamp + value. + type: array + metaData: + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + description: Metadata information about the query executed. + stats: + description: '`stats` results.' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsNode' + id: GoogleCloudApigeeV1OptimizedStatsResponse + GoogleCloudApigeeV1NodeConfig: + description: >- + NodeConfig for setting the min/max number of nodes associated with the + environment. + id: GoogleCloudApigeeV1NodeConfig + type: object properties: - revisionId: - description: Output only. Revision ID of the security profile. + minNodeCount: format: int64 - type: string - readOnly: true - environments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironment' - type: array - description: List of environments attached to security profile. - revisionPublishTime: - format: google-datetime - type: string description: >- - Output only. DEPRECATED: DO NOT USE The time when revision was - published. Once published, the security profile revision cannot be - updated further and can be attached to environments. - deprecated: true - readOnly: true - revisionCreateTime: - format: google-datetime - description: Output only. The time when revision was created. + Optional. The minimum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended minimum + number of nodes for that gateway. type: string - readOnly: true - scoringConfigs: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileScoringConfig - description: List of profile scoring configs in this revision. - revisionUpdateTime: + maxNodeCount: type: string - readOnly: true - format: google-datetime - description: Output only. The time when revision was updated. - description: - description: Description of the security profile. + format: int64 + description: >- + Optional. The maximum total number of gateway nodes that the is + reserved for all instances that has the specified environment. If + not specified, the default is determined by the recommended maximum + number of nodes for that gateway. + currentAggregateNodeCount: type: string - maxScore: - type: integer - format: int32 readOnly: true + format: int64 description: >- - Output only. Maximum security score that can be generated by this - profile. - minScore: - type: integer + Output only. The current total number of gateway nodes that each + environment currently has across all instances. + GoogleCloudApigeeV1RuntimeTraceSamplingConfig: + id: GoogleCloudApigeeV1RuntimeTraceSamplingConfig + type: object + description: >- + NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of + distributed tracing. Only the fields that are defined in the distributed + trace configuration can be overridden using the distribute trace + configuration override APIs. + properties: + samplingRate: description: >- - Output only. Minimum security score that can be generated by this - profile. + Field sampling rate. This value is only applicable when using the + PROBABILITY sampler. The supported values are > 0 and <= 0.5. + format: float + type: number + sampler: + enum: + - SAMPLER_UNSPECIFIED + - 'OFF' + - PROBABILITY + enumDescriptions: + - Sampler unspecified. + - >- + OFF means distributed trace is disabled, or the sampling + probability is 0. + - >- + PROBABILITY means traces are captured on a probability that + defined by sampling_rate. The sampling rate is limited to 0 to 0.5 + when this is set. + type: string + description: Sampler of distributed tracing. OFF is the default value. + GoogleCloudApigeeV1OperationMetadataProgress: + properties: + percentDone: + type: integer + description: The percentage of the operation progress. format: int32 - readOnly: true - name: + details: + description: The additional details of the progress. + additionalProperties: + description: Properties of the object. + type: any + type: object + state: + enumDescriptions: + - '' + - '' + - '' + - '' + enum: + - STATE_UNSPECIFIED + - NOT_STARTED + - IN_PROGRESS + - FINISHED + description: State of the operation. type: string - description: >- - Immutable. Name of the security profile resource. Format: - organizations/{org}/securityProfiles/{profile} - displayName: - deprecated: true + description: type: string - description: 'DEPRECATED: DO NOT USE Display name of the security profile.' - profileConfig: - description: >- - Required. Customized profile configuration that computes the - security score. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfig' + description: Description of the operation's progress. type: object - id: GoogleCloudApigeeV1SecurityProfile - GoogleCloudApigeeV1ListKeyValueEntriesResponse: + description: Information about operation progress. + id: GoogleCloudApigeeV1OperationMetadataProgress + GoogleCloudApigeeV1ListSecurityIncidentsResponse: + description: Response for ListSecurityIncidents. properties: - keyValueEntries: - description: One or more key value map keys and values. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' - type: array nextPageToken: - type: string description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: object - id: GoogleCloudApigeeV1ListKeyValueEntriesResponse - description: >- - The request structure for listing key value map keys and its - corresponding values. - GoogleCloudApigeeV1AddonsConfig: - description: Add-on configurations for the Apigee organization. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. + type: string + securityIncidents: + description: List of security incidents in the organization + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' type: object - id: GoogleCloudApigeeV1AddonsConfig + id: GoogleCloudApigeeV1ListSecurityIncidentsResponse + GoogleCloudApigeeV1ScoreComponentRecommendationAction: + description: Action to improve security score. properties: - integrationConfig: - description: Configuration for the Integration add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' - apiSecurityConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' - description: Configuration for the API Security add-on. - analyticsConfig: - description: Configuration for the Analytics add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' - connectorsPlatformConfig: - description: Configuration for the Connectors Platform add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' - advancedApiOpsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' - description: Configuration for the Advanced API Ops add-on. - monetizationConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' - description: Configuration for the Monetization add-on. - GoogleCloudApigeeV1SecurityReportMetadata: + description: + type: string + description: Description of the action. + actionContext: + description: Action context for the action. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext type: object + id: GoogleCloudApigeeV1ScoreComponentRecommendationAction + GoogleCloudApigeeV1ApiProduct: properties: - dimensions: + displayName: + description: >- + Name displayed in the UI or developer portal to developers + registering for API access. + type: string + scopes: + description: >- + Comma-separated list of OAuth scopes that are validated at runtime. + Apigee validates that the scopes in any access token presented match + the scopes defined in the OAuth policy associated with the API + product. type: array - description: Dimensions of the SecurityReport. items: type: string - startTimestamp: - type: string - format: google-datetime - description: Start timestamp of the query range. - timeUnit: - description: 'Query GroupBy time unit. Example: "seconds", "minute", "hour"' - type: string - metrics: + apiResources: + description: >- + Comma-separated list of API resources to be bundled in the API + product. By default, the resource paths are mapped from the + `proxy.pathsuffix` variable. The proxy path suffix is defined as the + URI fragment following the ProxyEndpoint base path. For example, if + the `apiResources` element is defined to be `/forecastrss` and the + base path defined for the API proxy is `/weather`, then only + requests to `/weather/forecastrss` are permitted by the API product. + You can select a specific path, or you can select all subpaths with + the following wildcard: - `/**`: Indicates that all sub-URIs are + included. - `/*` : Indicates that only URIs one level down are + included. By default, / supports the same resources as /** as well + as the base path defined by the API proxy. For example, if the base + path of the API proxy is `/v1/weatherapikey`, then the API product + supports requests to `/v1/weatherapikey` and to any sub-URIs, such + as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, + and so on. For more information, see Managing API products. items: type: string type: array + quotaInterval: + type: string description: >- - Metrics of the SecurityReport. Example: - ["name:bot_count,func:sum,alias:sum_bot_count"] - endTimestamp: - description: End timestamp of the query range. + Time interval over which the number of request messages is + calculated. + proxies: + type: array + items: + type: string + description: >- + Comma-separated list of API proxy names to which this API product is + bound. By specifying API proxies, you can associate resources in the + API product with specific API proxies, preventing developers from + accessing those resources through other API proxies. Apigee rejects + requests to API proxies that are not listed. **Note:** The API proxy + names must already exist in the specified environment as they will + be validated upon creation. + createdAt: + description: >- + Response only. Creation time of this environment as milliseconds + since epoch. + format: int64 + type: string + approvalType: + description: >- + Flag that specifies how API keys are approved to access the APIs + defined by the API product. If set to `manual`, the consumer key is + generated and returned in "pending" state. In this case, the API + keys won't work until they have been explicitly approved. If set to + `auto`, the consumer key is generated and returned in "approved" + state and can be used immediately. **Note:** Typically, `auto` is + used to provide access to free or trial API products that provide + limited quota or capabilities. type: string - format: google-datetime - mimeType: + name: + description: >- + Internal name of the API product. Characters you can use in the name + are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name + cannot be edited when updating the API product. type: string - description: MIME type / Output format. - id: GoogleCloudApigeeV1SecurityReportMetadata - description: Metadata for the security report. - GoogleCloudApigeeV1DeveloperBalance: - description: Account balance for the developer. - properties: - wallets: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' - readOnly: true + attributes: + description: >- + Array of attributes that may be used to extend the default API + product profile with customer-specific metadata. You can specify a + maximum of 18 attributes. Use this property to specify the access + level of the API product as either `public`, `private`, or + `internal`. Only products marked `public` are available to + developers in the Apigee developer portal. For example, you can set + a product to `internal` while it is in development and then change + access to `public` when it is ready to release on the portal. API + products marked as `private` do not appear on the portal, but can be + accessed by external developers. type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + grpcOperationGroup: + $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' description: >- - Output only. List of all wallets. Each individual wallet stores the - account balance for a particular currency. - type: object - id: GoogleCloudApigeeV1DeveloperBalance - GoogleCloudApigeeV1DataCollector: - properties: + Optional. Configuration used to group Apigee proxies with gRPC + services and method names. This grouping allows us to set quota for + a particular proxy with the gRPC service name and method. If a + method name is not set, this implies quota and authorization are + applied to all gRPC methods implemented by that proxy for that + particular gRPC service. + quotaTimeUnit: + description: >- + Time unit defined for the `quotaInterval`. Valid values include + `minute`, `hour`, `day`, or `month`. + type: string description: type: string - description: A description of the data collector. - type: - description: Immutable. The type of data this data collector will collect. - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME - enumDescriptions: - - For future compatibility. - - For integer values. - - For float values. - - For string values. - - For boolean values. - - For datetime values. + description: >- + Description of the API product. Include key information about the + API product that is not captured by other fields. + quota: type: string + description: >- + Number of request messages permitted per app by this API product for + the specified `quotaInterval` and `quotaTimeUnit`. For example, a + `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of + hours means 50 requests are allowed every 12 hours. lastModifiedAt: - readOnly: true type: string description: >- - Output only. The time at which the Data Collector was last updated - in milliseconds since the epoch. - format: int64 - createdAt: - readOnly: true + Response only. Modified time of this environment as milliseconds + since epoch. format: int64 - type: string - description: >- - Output only. The time at which the data collector was created in - milliseconds since the epoch. - name: - description: ID of the data collector. Must begin with `dc_`. - type: string - description: Data collector configuration. - id: GoogleCloudApigeeV1DataCollector - type: object - GoogleCloudApigeeV1EndpointChainingRule: - properties: - proxyIds: - description: List of proxy ids which may be found in the given deployment group. + environments: + type: array items: type: string - type: array - deploymentGroup: - description: >- - The deployment group to target for cross-shard chaining calls to - these proxies. - type: string - id: GoogleCloudApigeeV1EndpointChainingRule - type: object - description: >- - EndpointChainingRule specifies the proxies contained in a particular - deployment group, so that other deployment groups can find them in - chaining calls. - GoogleCloudApigeeV1SecurityAssessmentResultScoringResult: - type: object - properties: - assessmentRecommendations: description: >- - The recommendations of the assessment. The key is the "name" of the - assessment (not display_name), and the value are the - recommendations. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation - type: object - failedAssessmentPerWeight: - type: object - additionalProperties: - type: integer - format: int32 + Comma-separated list of environment names to which the API product + is bound. Requests to environments that are not listed are rejected. + By specifying one or more environments, you can bind the resources + listed in the API product to a specific environment, preventing + developers from accessing those resources through API proxies + deployed in another environment. This setting is used, for example, + to prevent resources associated with API proxies in `prod` from + being accessed by API proxies deployed in `test`. + graphqlOperationGroup: description: >- - The number of failed assessments grouped by its weight. Keys are one - of the following: "MAJOR", "MODERATE", "MINOR". - dataUpdateTime: - format: google-datetime + Configuration used to group Apigee proxies or remote services with + graphQL operation name, graphQL operation type and quotas. This + grouping allows us to precisely set quota for a particular + combination of graphQL name and operation type for a particular + proxy request. If graphQL name is not set, this would imply quota + will be applied on all graphQL requests matching the operation type. + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' + operationGroup: + $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' description: >- - The time when resource data was last fetched for this resource. This - time may be different than when the resource was actually updated - due to lag in data collection. - type: string - severity: + Configuration used to group Apigee proxies or remote services with + resources, method types, and quotas. The resource refers to the + resource URI (excluding the base path). With this grouping, the API + product creator is able to fine-tune and give precise control over + which REST methods have access to specific resources and how many + calls can be made (using the `quota` setting). **Note:** The + `api_resources` setting cannot be specified for both the API product + and operation group; otherwise the call will fail. + quotaCounterScope: enum: - - SEVERITY_UNSPECIFIED - - LOW - - MEDIUM - - HIGH - - MINIMAL - description: The severity of the assessment. + - QUOTA_COUNTER_SCOPE_UNSPECIFIED + - PROXY + - OPERATION enumDescriptions: - - Severity is not defined. - - Severity is low. - - Severity is medium. - - Severity is high. - - Severity is minimal + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), set at product level will be used as a + global counter for quota evaluation by all the operations + associated with a particular proxy. + - >- + When quota is not explicitly defined for each + operation(REST/GraphQL), the limits set at product level will be + used as a local counter for quota evaluation by all the + operations, independent of proxy association. This behavior mimics + the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. + description: >- + Scope of the quota decides how the quota counter gets applied and + evaluate for quota violation. If the Scope is set as PROXY, then all + the operations defined for the APIproduct that are associated with + the same proxy will share the same quota counter set at the + APIproduct level, making it a global counter at a proxy level. If + the Scope is set as OPERATION, then each operations get the counter + set at the API product dedicated, making it a local counter. Note + that, the QuotaCounterScope applies only when an operation does not + have dedicated quota set for itself. type: string - score: - type: integer - format: int32 - description: The security score of the assessment. - id: GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - description: The result of the assessment. - GoogleTypeInterval: + type: object + id: GoogleCloudApigeeV1ApiProduct + GoogleCloudApigeeV1GraphQLOperationGroup: description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - id: GoogleTypeInterval + List of graphQL operation configuration details associated with Apigee + API proxies or remote services. Remote services are non-Apigee proxies, + such as Istio-Envoy. properties: - startTime: - type: string + operationConfigs: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationConfig' description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - format: google-datetime - endTime: + Required. List of operation configurations for either Apigee API + proxies or other remote services that are associated with this API + product. + type: array + operationConfigType: + type: string description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. + Flag that specifies whether the configuration is for Apigee API + proxy or a remote service. Valid values include `proxy` or + `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API + proxies are associated with the API product. Set to `remoteservice` + when non-Apigee proxies like Istio-Envoy are associated with the API + product. + id: GoogleCloudApigeeV1GraphQLOperationGroup + type: object + GoogleCloudApigeeV1ListSecurityReportsResponse: + properties: + nextPageToken: type: string - format: google-datetime + description: >- + If the number of security reports exceeded the page size requested, + the token can be used to fetch the next page in a subsequent call. + If the response is the last page and there are no more reports to + return this field is left empty. + securityReports: + description: The security reports belong to requested resource name. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' type: object - GoogleCloudApigeeV1TraceConfig: - description: >- - TraceConfig defines the configurations in an environment of distributed - trace. + description: The response for SecurityReports. + id: GoogleCloudApigeeV1ListSecurityReportsResponse + GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: + id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo + description: A Signed URL and the relevant metadata associated with it. properties: - samplingConfig: - description: >- - Distributed trace configuration for all API proxies in an - environment. You can also override the configuration for a specific - API proxy using the distributed trace configuration overrides API. - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' - exporter: + md5: + description: The MD5 Hash of the JSON data type: string - enumDescriptions: - - Exporter unspecified - - Jaeger exporter - - Cloudtrace exporter - description: >- - Required. Exporter that is used to view the distributed trace - captured using OpenCensus. An exporter sends traces to any backend - that is capable of consuming them. Recorded spans can be exported by - registered exporters. - enum: - - EXPORTER_UNSPECIFIED - - JAEGER - - CLOUD_TRACE - endpoint: - description: Required. Endpoint of the exporter. + sizeBytes: + type: string + format: int64 + description: The size of the returned file in bytes + uri: type: string + description: >- + The signed URL of the JSON data. Will be of the form + `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= + GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount + .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 + 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 + 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 + 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc + c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 + 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a + 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 + a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 + 2ea7abedc098d2eb14a7` + type: object + GoogleCloudApigeeV1IntegrationConfig: + properties: + enabled: + type: boolean + description: Flag that specifies whether the Integration add-on is enabled. + id: GoogleCloudApigeeV1IntegrationConfig + description: Configuration for the Integration add-on. type: object - id: GoogleCloudApigeeV1TraceConfig GoogleCloudApigeeV1Keystore: + type: object properties: - aliases: - description: Output only. Aliases in this keystore. - items: - type: string - readOnly: true - type: array name: type: string description: >- Required. Resource ID for this keystore. Values must match the regular expression `[\w[:space:].-]{1,255}`. + aliases: + readOnly: true + items: + type: string + description: Output only. Aliases in this keystore. + type: array description: Datastore for Certificates and Aliases. - type: object id: GoogleCloudApigeeV1Keystore - GoogleCloudApigeeV1TargetServerConfig: - id: GoogleCloudApigeeV1TargetServerConfig + GoogleCloudApigeeV1Metric: type: object properties: - enabled: - description: >- - Whether the target server is enabled. An empty/omitted value for - this field should be interpreted as true. - type: boolean - protocol: - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy - type: string - description: The protocol used by this target server. - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - tlsInfo: - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfoConfig' - description: TLS settings for the target server. - host: - description: Host name of the target server. - type: string - port: - format: int32 - type: integer - description: Port number for the target server. name: + description: Metric name. type: string + values: + items: + type: any + type: array description: >- - Target server revision name in the following format: - `organizations/{org}/environments/{env}/targetservers/{targetserver}/revisions/{rev}` - GoogleCloudApigeeV1SecurityActionAllow: - type: object - properties: {} - id: GoogleCloudApigeeV1SecurityActionAllow + List of metric values. Possible value formats include: + `"values":["39.0"]` or `"values":[ { "value": "39.0", "timestamp": + 1232434354} ]` + id: GoogleCloudApigeeV1Metric description: >- - Message that should be set in case of an Allow Action. This does not - have any fields. - GoogleCloudApigeeV1ProfileConfigMTLS: - id: GoogleCloudApigeeV1ProfileConfigMTLS - properties: {} - type: object - description: Checks to see if you have configured mTLS for the target server. - GoogleCloudApigeeV1ProfileConfigCORS: - properties: {} - id: GoogleCloudApigeeV1ProfileConfigCORS - description: Checks to see if you have CORS policy in place. + Encapsulates the metric data point. For example: ```{ "name": + "sum(message_count)", "values" : [ { "timestamp": 1549004400000, + "value": "39.0" }, { "timestamp" : 1548997200000, "value" : "0.0" } ] + }``` or ```{ "name": "sum(message_count)", "values" : ["39.0"] }``` + GoogleApiHttpBody: type: object - GoogleCloudApigeeV1ListRatePlansResponse: + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + id: GoogleApiHttpBody properties: - nextStartKey: - description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. + contentType: type: string - ratePlans: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + extensions: type: array - description: List of rate plans in an organization. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' - type: object - id: GoogleCloudApigeeV1ListRatePlansResponse - description: Response for ListRatePlans. - GoogleCloudApigeeV1ListSecurityProfilesResponse: - description: Response for ListSecurityProfiles. - id: GoogleCloudApigeeV1ListSecurityProfilesResponse - properties: - securityProfiles: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - List of security profiles in the organization. The profiles may be - attached or unattached to any environment. This will return latest - revision of each profile. - type: array - nextPageToken: + Application specific response metadata. Must be set in the first + response for streaming APIs. + data: + format: byte + description: The HTTP request/response body as raw binary. type: string - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: type: object - GoogleCloudApigeeV1RuntimeApiSecurityConfig: + description: Resource for which we are computing security assessment. + id: >- + GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource properties: - enabled: - type: boolean - description: If the API Security is enabled or not. - type: object - description: Runtime configuration for the API Security add-on. - id: GoogleCloudApigeeV1RuntimeApiSecurityConfig - GoogleCloudApigeeV1SecurityActionConditionConfig: + type: + description: Required. Type of this resource. + enum: + - RESOURCE_TYPE_UNSPECIFIED + - API_PROXY + type: string + enumDescriptions: + - ResourceType not specified. + - Resource is an Apigee Proxy. + name: + type: string + description: Required. Name of this resource. + GoogleCloudApigeeV1AppGroup: properties: - accessTokens: - type: array - description: Optional. A list of access_tokens. Limit 1000 per action. - items: - type: string - asns: + appGroupId: + readOnly: true + type: string + description: Output only. Internal identifier that cannot be edited + organization: + type: string + description: Immutable. the org the app group is created + channelId: + type: string + description: channel identifier identifies the owner maintaing this grouping. + status: description: >- - Optional. A list of ASN numbers to act on, e.g. 23. - https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses - int64 instead of uint32 because of - https://linter.aip.dev/141/forbidden-types. + Valid values are `active` or `inactive`. Note that the status of the + AppGroup should be updated via UpdateAppGroupRequest by setting the + action as `active` or `inactive`. + type: string + attributes: type: array items: - format: int64 - type: string - regionCodes: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: A list of attributes + name: + type: string description: >- - Optional. A list of countries/region codes to act on, e.g. US. This - follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. + Immutable. Name of the AppGroup. Characters you can use in the name + are restricted to: A-Z0-9._\-$ %. + channelUri: + type: string + description: A reference to the associated storefront/marketplace. + lastModifiedAt: + readOnly: true + type: string + format: int64 + description: Output only. Modified time as milliseconds since epoch. + displayName: + type: string + description: app group name displayed in the UI + createdAt: + format: int64 + description: Output only. Created time as milliseconds since epoch. + type: string + readOnly: true + id: GoogleCloudApigeeV1AppGroup + type: object + description: >- + AppGroup contains the request/response fields representing the logical + grouping of apps. Note that appgroup_id, create_time and update_time + cannot be changed by the user, and gets updated by the system. The name + and the organization once provided cannot be edited subsequently. + GoogleCloudApigeeV1DebugMask: + type: object + id: GoogleCloudApigeeV1DebugMask + properties: + faultJSONPaths: items: type: string type: array - ipAddressRanges: description: >- - Optional. A list of IP addresses. This could be either IPv4 or IPv6. - Limited to 100 per action. - items: - type: string - type: array - userAgents: - items: - type: string + List of JSON paths that specify the JSON elements to be filtered + from JSON payloads in error flows. + faultXPaths: description: >- - Optional. A list of user agents to deny. We look for exact matches. - Limit 50 per action. + List of XPaths that specify the XML elements to be filtered from XML + payloads in error flows. type: array - developers: items: type: string - type: array - description: Optional. A list of developers. Limit 1000 per action. - httpMethods: + requestJSONPaths: items: type: string - type: array description: >- - Optional. Act only on particular HTTP methods. E.g. A read-only API - can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, - POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. - apiProducts: - items: - type: string - description: Optional. A list of API Products. Limit 1000 per action. + List of JSON paths that specify the JSON elements to be filtered + from JSON request message payloads. type: array - apiKeys: - items: - type: string - description: Optional. A list of API keys. Limit 1000 per action. + variables: type: array - developerApps: + description: List of variables that should be masked from the debug output. items: type: string - description: Optional. A list of developer apps. Limit 1000 per action. - type: array - botReasons: + name: + type: string + description: Name of the debug mask. + responseJSONPaths: type: array items: type: string description: >- - Optional. A list of Bot Reasons. Current options: Flooder, Brute - Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, - TorListRule, Advanced Anomaly Detection, Advanced API Scraper, - Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public - Cloud Azure, and Public Cloud Google. - id: GoogleCloudApigeeV1SecurityActionConditionConfig - description: >- - The following are a list of conditions. A valid SecurityAction must - contain at least one condition. Within a condition, each element is - ORed. Across conditions elements are ANDed. For example if a - SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and - bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: - enforce the action if the incoming request has ((ip_address_ranges = - "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR - bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges - and bot_reasons cannot be ANDed. - type: object - GoogleCloudApigeeV1CanaryEvaluationMetricLabels: - type: object - id: GoogleCloudApigeeV1CanaryEvaluationMetricLabels - properties: - instance_id: - type: string + List of JSON paths that specify the JSON elements to be filtered + from JSON response message payloads. + requestXPaths: description: >- - Required. The instance ID associated with the metrics. In Apigee - Hybrid, the value is configured during installation. - env: - description: The environment ID associated with the metrics. - type: string - location: - type: string - description: Required. The location associated with the metrics. - description: Labels that can be used to filter Apigee metrics. - GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: - id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence - description: A sequence of time series. - properties: - points: + List of XPaths that specify the XML elements to be filtered from XML + request message payloads. type: array - description: List of points. First value of each inner list is a timestamp. items: - items: - type: any - type: array - dimensions: - description: >- - Map of dimensions and their values that uniquely identifies a time - series sequence. + type: string + namespaces: additionalProperties: type: string + description: Map of namespaces to URIs. type: object - type: object - GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: - description: Response for ListDeveloperSubscriptions. - type: object - id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse - properties: - developerSubscriptions: - description: List of all subscriptions. + responseXPaths: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + type: string type: array - nextStartKey: description: >- - Value that can be sent as `startKey` to retrieve the next page of - content. If this field is omitted, there are no subsequent pages. - type: string - GoogleCloudApigeeV1StatsHostStats: - type: object - description: >- - Encapsulates the hostname wrapper: ``` "hosts": [ { "metrics": [ { - "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": - "example.com" } ]``` + List of XPaths that specify the XML elements to be filtered from XML + response message payloads. + GoogleCloudApigeeV1SecurityAssessmentResultResource: + description: Resource for which we are computing security assessment. properties: name: type: string - description: Hostname used in query. - dimensions: - description: List of metrics grouped under dimensions. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DimensionMetric' - type: array - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Metric' - type: array + description: Required. Name of this resource. + resourceRevisionId: description: >- - In the final response, only one of the following fields will be - present based on the dimensions provided. If no dimensions are - provided, then only the top-level metrics are provided. If - dimensions are included, then there will be a top-level dimensions - field under hostnames which will contain metrics values and the - dimension name. Example: ``` "hosts": [ { "dimensions": [ { - "metrics": [ { "name": "sum(message_count)", "values": [ - "2.14049521E8" ] } ], "name": "nit_proxy" } ], "name": "example.com" - } ]``` OR ```"hosts": [ { "metrics": [ { "name": - "sum(message_count)", "values": [ "2.19026331E8" ] } ], "name": - "example.com" } ]``` List of metric values. - id: GoogleCloudApigeeV1StatsHostStats - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource: - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArrayResource - properties: - name: + The revision id for the resource. In case of Apigee, this is proxy + revision id. type: string - description: Required. Name of this resource. type: + type: string + description: Required. Type of this resource. enum: - RESOURCE_TYPE_UNSPECIFIED - API_PROXY - description: Required. Type of this resource. - type: string enumDescriptions: - ResourceType not specified. - Resource is an Apigee Proxy. + id: GoogleCloudApigeeV1SecurityAssessmentResultResource type: object - description: Resource for which we are computing security assessment. - GoogleCloudApigeeV1Stats: - properties: - metaData: - description: Metadata information. - $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' - environments: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' - description: List of query results on the environment level. - type: array - hosts: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' - description: List of query results grouped by host. - type: array - type: object - description: Encapsulates a `stats` response. - id: GoogleCloudApigeeV1Stats - GoogleCloudApigeeV1SecurityActionsConfig: - id: GoogleCloudApigeeV1SecurityActionsConfig - type: object - properties: - enabled: - description: >- - The flag that controls whether this feature is enabled. This is - `unset` by default. When this flag is `false`, even if individual - rules are enabled, no SecurityActions will be enforced. - type: boolean - name: - description: >- - This is a singleton resource, the name will always be set by - SecurityActions and any user input will be ignored. The name is - always: - `organizations/{org}/environments/{env}/security_actions_config` - type: string - updateTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The update time for configuration. - description: >- - SecurityActionsConfig reflects the current state of the SecurityActions - feature. This is a singleton resource: https://google.aip.dev/156 - GoogleIamV1SetIamPolicyRequest: - description: Request message for `SetIamPolicy` method. - id: GoogleIamV1SetIamPolicyRequest - type: object + GoogleCloudApigeeV1ListInstancesResponse: + id: GoogleCloudApigeeV1ListInstancesResponse + description: Response for ListInstances. properties: - updateMask: - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` + instances: + description: Instances in the specified organization. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + nextPageToken: type: string - format: google-fieldmask - policy: description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/GoogleIamV1Policy' - GoogleCloudApigeeV1DeploymentChangeReport: - description: >- - Response for GenerateDeployChangeReport and - GenerateUndeployChangeReport. This report contains any validation - failures that would cause the deployment to be rejected, as well changes - and conflicts in routing that may occur due to the new deployment. The - existence of a routing warning does not necessarily imply that the - deployment request is bad, if the desired state of the deployment - request is to effect a routing change. The primary purposes of the - routing messages are: 1) To inform users of routing changes that may - have an effect on traffic currently being routed to other existing - deployments. 2) To warn users if some base path in the proxy will not - receive traffic due to an existing deployment having already claimed - that base path. The presence of routing conflicts/changes will not cause - non-dry-run DeployApiProxy/UndeployApiProxy requests to be rejected. + Page token that you can include in a ListInstance request to + retrieve the next page of content. If omitted, no subsequent pages + exist. type: object - id: GoogleCloudApigeeV1DeploymentChangeReport + GoogleCloudApigeeV1RoutingRule: properties: - routingConflicts: - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - type: array - description: All base path conflicts detected for a deployment request. - validationErrors: - $ref: '#/components/schemas/GoogleRpcPreconditionFailure' + envGroupRevision: + format: int64 + type: string description: >- - Validation errors that would cause the deployment change request to - be rejected. - routingChanges: + The env group config revision_id when this rule was added or last + updated. This value is set when the rule is created and will only + update if the the environment_id changes. It is used to determine if + the runtime is up to date with respect to this rule. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. + otherTargets: type: array items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingChange - description: All routing changes that may result from a deployment request. - GoogleCloudApigeeV1MetricAggregation: - type: object - properties: - order: + type: string description: >- - Ordering for this aggregation in the result. For time series this is - ignored since the ordering of points depends only on the timestamp, - not the values. + Conflicting targets, which will be resource names specifying either + deployment groups or environments. + environment: type: string - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING - aggregation: + description: >- + Name of an environment bound to the environment group in the + following format: `organizations/{org}/environments/{env}`. Only one + of environment or deployment_group will be set. + updateTime: type: string - description: Aggregation function associated with the metric. - enumDescriptions: - - Unspecified Aggregation function. - - Average. - - Summation. - - Min. - - Max. - - Count distinct - enum: - - AGGREGATION_FUNCTION_UNSPECIFIED - - AVG - - SUM - - MIN - - MAX - - COUNT_DISTINCT - name: + description: >- + The unix timestamp when this rule was updated. This is updated + whenever env_group_revision is updated. This field is omitted from + the IngressConfig unless the GetDeployedIngressConfig API is called + with view=FULL. + format: google-datetime + receiver: + description: >- + The resource name of the proxy revision that is receiving this + basepath in the following format: + `organizations/{org}/apis/{api}/revisions/{rev}`. This field is + omitted from the IngressConfig unless the GetDeployedIngressConfig + API is called with view=FULL. + type: string + basepath: type: string - description: Name of the metric - id: GoogleCloudApigeeV1MetricAggregation - description: The optionally aggregated metric to query with its ordering. - GoogleCloudApigeeV1ProfileConfigCategory: - description: >- - Advanced API Security provides security profile that scores the - following categories. - properties: - abuse: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAbuse' description: >- - Checks for abuse, which includes any requests sent to the API for - purposes other than what it is intended for, such as high volumes of - requests, data scraping, and abuse related to authorization. - cors: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCORS' - description: Checks to see if you have CORS policy in place. - mtls: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMTLS' - description: Checks to see if you have configured mTLS for the target server. - authorization: - description: Checks to see if you have an authorization policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigAuthorization' - mediation: - description: Checks to see if you have a mediation policy in place. - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigMediation' - threat: - $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigThreat' - description: Checks to see if you have a threat protection policy in place. + URI path prefix used to route to the specified environment. May + contain one or more wildcards. For example, path segments consisting + of a single `*` character will match any string. + deploymentGroup: + description: >- + Name of a deployment group in an environment bound to the + environment group in the following format: + `organizations/{org}/environment/{env}/deploymentGroups/{group}` + Only one of environment or deployment_group will be set. + type: string type: object - id: GoogleCloudApigeeV1ProfileConfigCategory - GoogleCloudApigeeV1ScoreComponentRecommendation: + id: GoogleCloudApigeeV1RoutingRule + GoogleCloudApigeeV1ListInstanceAttachmentsResponse: + id: GoogleCloudApigeeV1ListInstanceAttachmentsResponse properties: - description: - type: string - description: Description of the recommendation. - impact: - description: >- - Potential impact of this recommendation on the overall score. This - denotes how important this recommendation is to improve the score. - format: int32 - type: integer - actions: - description: Actions for the recommendation to improve the security score. + attachments: type: array + description: Attachments for the instance. items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationAction - title: - description: Title represents recommendation title. + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + nextPageToken: type: string - description: Recommendation based on security concerns and score. - id: GoogleCloudApigeeV1ScoreComponentRecommendation + description: >- + Page token that you can include in a ListInstanceAttachments request + to retrieve the next page of content. If omitted, no subsequent + pages exist. type: object - GoogleCloudApigeeV1NatAddress: + description: Response for ListInstanceAttachments. + GoogleCloudApigeeV1ResourceConfig: properties: + location: + type: string + description: Location of the resource as a URI. name: type: string - description: Required. Resource ID of the NAT address. - ipAddress: + description: >- + Resource name in the following format: + `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` + Only environment-scoped resource files are supported. + type: object + id: GoogleCloudApigeeV1ResourceConfig + GoogleCloudApigeeV1CommonNameConfig: + properties: + matchWildCards: + type: boolean + name: type: string - description: Output only. The static IPV4 address. - readOnly: true - state: + type: object + id: GoogleCloudApigeeV1CommonNameConfig + GoogleCloudApigeeV1DeveloperMonetizationConfig: + id: GoogleCloudApigeeV1DeveloperMonetizationConfig + properties: + billingType: type: string - readOnly: true - description: Output only. State of the nat address. + description: Billing type. enumDescriptions: - - The resource is in an unspecified state. - - The NAT address is being created. - - The NAT address is reserved but not yet used for Internet egress. - - The NAT address is active and used for Internet egress. - - The NAT address is being deleted. + - The default/unset value. + - >- + Developer pays in advance for the use of APIs and the charged + amount is deducted from their account balance. + - >- + Developer does not maintain an account balance. The API provider + bills the developer for API usage. enum: - - STATE_UNSPECIFIED - - CREATING - - RESERVED - - ACTIVE - - DELETING + - BILLING_TYPE_UNSPECIFIED + - PREPAID + - POSTPAID + description: Monetization configuration for the developer. type: object + GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: + id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + properties: {} + type: object + description: Request for ExpireDeveloperSubscription. + GoogleCloudApigeeV1SecurityActionAllow: + id: GoogleCloudApigeeV1SecurityActionAllow + type: object + properties: {} description: >- - Apigee NAT(network address translation) address. A NAT address is a - static external IP address used for Internet egress traffic. - id: GoogleCloudApigeeV1NatAddress - GoogleCloudApigeeV1CustomReportMetric: - id: GoogleCloudApigeeV1CustomReportMetric - description: >- - This encapsulates a metric property of the form sum(message_count) where - name is message_count and function is sum + Message that should be set in case of an Allow Action. This does not + have any fields. + GoogleCloudApigeeV1ListEndpointAttachmentsResponse: + description: Response for ListEndpointAttachments method. + id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse + properties: + nextPageToken: + type: string + description: >- + Page token that you can include in an `ListEndpointAttachments` + request to retrieve the next page. If omitted, no subsequent pages + exist. + endpointAttachments: + description: Endpoint attachments in the specified organization. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' type: object + GoogleCloudApigeeV1SchemaSchemaProperty: properties: - name: + type: type: string - description: name of the metric - function: + description: Data type of the field. + custom: type: string - description: aggregate function - GoogleCloudApigeeV1EnvironmentGroupConfig: + description: >- + Flag that specifies whether the field is standard in the dataset or + a custom field created by the customer. `true` indicates that it is + a custom field. + createTime: + description: >- + Time the field was created in RFC3339 string form. For example: + `2016-02-26T10:23:09.592Z`. + type: string + description: Properties for the schema field. + id: GoogleCloudApigeeV1SchemaSchemaProperty + type: object + GoogleCloudApigeeV1ListRatePlansResponse: + type: object + description: Response for ListRatePlans. properties: - hostnames: + ratePlans: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + description: List of rate plans in an organization. type: array - description: Host names for the environment group. - uid: + nextStartKey: type: string description: >- - A unique id for the environment group config that will only change - if the environment group is deleted and recreated. - routingRules: + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. + id: GoogleCloudApigeeV1ListRatePlansResponse + GoogleCloudApigeeV1DisableSecurityActionRequest: + id: GoogleCloudApigeeV1DisableSecurityActionRequest + description: Message to disable an enabled SecurityAction. + properties: {} + type: object + GoogleCloudApigeeV1ListOfDevelopersResponse: + type: object + properties: + developer: + description: List of developers. type: array - description: >- - Ordered list of routing rules defining how traffic to this - environment group's hostnames should be routed to different - environments. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' - endpointChainingRules: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' - type: array - description: A list of proxies in each deployment group for proxy chaining calls. - location: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + id: GoogleCloudApigeeV1ListOfDevelopersResponse + GoogleLongrunningOperation: + properties: + metadata: description: >- - When this message appears in the top-level IngressConfig, this field - will be populated in lieu of the inlined routing_rules and hostnames - fields. Some URL for downloading the full EnvironmentGroupConfig for - this group. + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object name: - description: >- - Name of the environment group in the following format: - `organizations/{org}/envgroups/{envgroup}`. type: string - revisionId: description: >- - Revision id that defines the ordering of the EnvironmentGroupConfig - resource. The higher the revision, the more recently the - configuration was deployed. - type: string - format: int64 - type: object + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + type: object + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + done: + type: boolean + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + id: GoogleLongrunningOperation description: >- - EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup - and its associated routing rules. - id: GoogleCloudApigeeV1EnvironmentGroupConfig - GoogleCloudApigeeV1EnvironmentGroupAttachment: + This resource represents a long-running operation that is the result of + a network API call. + type: object + GoogleIamV1Binding: properties: - environment: - description: Required. ID of the attached environment. - type: string - name: - description: ID of the environment group attachment. - type: string - createdAt: - format: int64 - type: string + condition: + $ref: '#/components/schemas/GoogleTypeExpr' description: >- - Output only. The time at which the environment group attachment was - created as milliseconds since epoch. - readOnly: true - environmentGroupId: + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + role: type: string - readOnly: true - description: Output only. ID of the environment group. + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + members: + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + items: + type: string + type: array + id: GoogleIamV1Binding type: object - id: GoogleCloudApigeeV1EnvironmentGroupAttachment - description: >- - EnvironmentGroupAttachment is a resource which defines an attachment of - an environment to an environment group. - GoogleCloudApigeeV1Quota: + description: Associates `members`, or principals, with a `role`. + GoogleCloudApigeeV1ArchiveDeployment: + description: Archive Deployment information. properties: - limit: + createdAt: + format: int64 + description: >- + Output only. The time at which the Archive Deployment was created in + milliseconds since the epoch. + readOnly: true + type: string + gcsUri: + type: string description: >- - Required. Upper limit allowed for the time interval and time unit - specified. Requests exceeding this limit will be rejected. + Input only. The Google Cloud Storage signed URL returned from + GenerateUploadUrl and used to upload the Archive zip file. + name: type: string - interval: description: >- - Required. Time interval over which the number of request messages is - calculated. + Name of the Archive Deployment in the following format: + `organizations/{org}/environments/{env}/archiveDeployments/{id}`. + operation: type: string - timeUnit: + readOnly: true + description: >- + Output only. A reference to the LRO that created this Archive + Deployment in the following format: + `organizations/{org}/operations/{id}` + updatedAt: + readOnly: true + description: >- + Output only. The time at which the Archive Deployment was updated in + milliseconds since the epoch. + format: int64 type: string + labels: + additionalProperties: + type: string + type: object description: >- - Time unit defined for the `interval`. Valid values include `minute`, - `hour`, `day`, or `month`. If `limit` and `interval` are valid, the - default value is `hour`; otherwise, the default is null. + User-supplied key-value pairs used to organize ArchiveDeployments. + Label keys must be between 1 and 63 characters long, have a UTF-8 + encoding of maximum 128 bytes, and must conform to the following + PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be + between 1 and 63 characters long, have a UTF-8 encoding of maximum + 128 bytes, and must conform to the following PCRE regular + expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can + be associated with a given store. type: object - id: GoogleCloudApigeeV1Quota + id: GoogleCloudApigeeV1ArchiveDeployment + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig description: >- - Quota contains the essential parameters needed that can be applied on - the resources, methods, API source combination associated with this API - product. While Quota is optional, setting it prevents requests from - exceeding the provisioned parameters. - EdgeConfigstoreBundleBadBundle: - description: Describes why a bundle is invalid. Intended for use in error details. + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. type: object - id: EdgeConfigstoreBundleBadBundle properties: - violations: - description: Describes all precondition violations. - items: - $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' + auditLogConfigs: + description: The configuration for logging of each type of permission. type: array - GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment: - description: Tuple representing a base path and the deployment containing it. + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + service: + type: string + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + GoogleCloudApigeeV1SecurityReport: + id: GoogleCloudApigeeV1SecurityReport + description: >- + SecurityReport saves all the information about the created security + report. type: object properties: - revision: + error: type: string - description: Name of the deployed API proxy revision containing the base path. - environment: + description: Error is set when query fails. + created: type: string - description: Name of the environment in which the proxy is deployed. - basepath: - description: Base path receiving traffic. + description: Creation time of the query. + self: type: string - apiProxy: - description: Name of the deployed API proxy revision containing the base path. + description: >- + Self link of the query. Example: + `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + or following format if query is running at host level: + `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` + reportDefinitionId: + description: Report Definition ID. type: string - id: GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment - GoogleCloudApigeeV1Attributes: - properties: - attribute: - description: List of attributes. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - type: object - id: GoogleCloudApigeeV1Attributes - GoogleCloudApigeeV1ListSecurityActionsResponse: - properties: - securityActions: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' - type: array - description: The SecurityActions for the specified environment. - nextPageToken: + resultFileSize: type: string + description: ResultFileSize is available only after the query is completed. + displayName: + type: string + description: Display Name specified by the user. + queryParams: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: object - id: GoogleCloudApigeeV1ListSecurityActionsResponse - description: >- - Contains a list of SecurityActions in response to a - ListSecurityActionRequest. - GoogleCloudApigeeV1Score: - description: Represents Security Score. - id: GoogleCloudApigeeV1Score + Contains information like metrics, dimenstions etc of the Security + Report. + result: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportResultMetadata' + description: Result is available only after the query is completed. + envgroupHostname: + description: Hostname is available only when query is executed at host level. + type: string + executionTime: + type: string + description: ExecutionTime is available only after the query is completed. + state: + type: string + description: >- + Query state could be "enqueued", "running", "completed", "expired" + and "failed". + resultRows: + description: ResultRows is available only after the query is completed. + type: string + format: int64 + updated: + readOnly: true + description: Output only. Last updated timestamp for the query. + type: string + GoogleCloudApigeeV1SharedFlowRevision: + description: The metadata describing a shared flow revision. + id: GoogleCloudApigeeV1SharedFlowRevision type: object properties: - subcomponents: - description: List of all the drilldown score components. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' + sharedFlows: + description: >- + A list of the shared flow names included in this shared flow + revision. type: array - component: - description: Component containing score, recommendations and actions. - $ref: '#/components/schemas/GoogleCloudApigeeV1ScoreComponent' - timeRange: - description: Start and end time for the score. - $ref: '#/components/schemas/GoogleTypeInterval' - GoogleCloudApigeeV1OptimizedStatsNode: - properties: - data: items: - type: any - type: array - type: object - description: >- - Encapsulates a data node as represented below: ``` { "identifier": { - "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": - "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` - { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` - Depending on whether a dimension is present in the query or not the data - node type can be a simple metric value or dimension identifier with list - of metrics. - id: GoogleCloudApigeeV1OptimizedStatsNode - GoogleCloudApigeeV1ConfigVersion: - type: object - description: >- - Version of the API proxy configuration schema. Currently, only 4.0 is - supported. - id: GoogleCloudApigeeV1ConfigVersion - properties: - majorVersion: - format: int32 - type: integer - description: Major version of the API proxy configuration schema. - minorVersion: - format: int32 - type: integer - description: Minor version of the API proxy configuration schema. - GoogleCloudApigeeV1TargetServer: - description: >- - TargetServer configuration. TargetServers are used to decouple a proxy - TargetEndpoint HTTPTargetConnections from concrete URLs for backend - services. - type: object - id: GoogleCloudApigeeV1TargetServer - properties: - description: - description: Optional. A human-readable description of this TargetServer. - type: string - host: - description: >- - Required. The host name this target connects to. Value must be a - valid hostname as described by RFC-1123. - type: string - protocol: - enum: - - PROTOCOL_UNSPECIFIED - - HTTP - - HTTP2 - - GRPC_TARGET - - GRPC - - EXTERNAL_CALLOUT - description: Immutable. The protocol used by this TargetServer. - enumDescriptions: - - UNSPECIFIED defaults to HTTP for backwards compatibility. - - The TargetServer uses HTTP. - - The TargetSever uses HTTP2. - - The TargetServer uses GRPC. - - >- - GRPC TargetServer to be used in ExternalCallout Policy. Prefer to - use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once - EXTERNAL _CALLOUT generally available. - - The TargetServer is to be used in the ExternalCallout Policy + type: string + lastModifiedAt: + description: >- + Time at which this shared flow revision was most recently modified, + in milliseconds since epoch. + format: int64 + type: string + policies: + items: + type: string + type: array + description: A list of policy names included in this shared flow revision. + resourceFiles: + description: The resource files included in this shared flow revision. + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + type: + description: The string "Application" + type: string + revision: type: string + description: The resource ID of this revision. name: + description: The resource ID of the parent shared flow. type: string + displayName: + description: The human readable name of this shared flow. + type: string + resources: + items: + type: string description: >- - Required. The resource id of this target server. Values must match - the regular expression - isEnabled: - type: boolean - description: >- - Optional. Enabling/disabling a TargetServer is useful when - TargetServers are used in load balancing configurations, and one or - more TargetServers need to taken out of rotation periodically. - Defaults to true. - sSLInfo: + A list of the resources included in this shared flow revision + formatted as "{type}://{name}". + type: array + contextInfo: + description: A textual description of the shared flow revision. + type: string + configurationVersion: description: >- - Optional. Specifies TLS configuration info for this TargetServer. - The JSON name is `sSLInfo` for legacy/backwards compatibility - reasons -- Edge originally supported SSL, and the name is still used - for TLS configuration. - $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' - port: - type: integer + The version of the configuration schema to which this shared flow + conforms. The only supported value currently is majorVersion 4 and + minorVersion 0. This setting may be used in the future to enable + evolution of the shared flow format. + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' + description: + description: Description of the shared flow revision. + type: string + createdAt: description: >- - Required. The port number this target connects to on the given host. - Value must be between 1 and 65535, inclusive. - format: int32 - GoogleCloudApigeeV1RoutingRule: - id: GoogleCloudApigeeV1RoutingRule + Time at which this shared flow revision was created, in milliseconds + since epoch. + format: int64 + type: string + entityMetaDataAsProperties: + additionalProperties: + type: string + type: object + description: A Key-Value map of metadata about this shared flow revision. + GoogleCloudApigeeV1Datastore: + description: >- + The data store defines the connection to export data repository (Cloud + Storage, BigQuery), including the credentials used to access the data + repository. properties: - basepath: + datastoreConfig: + description: Datastore Configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1DatastoreConfig' + lastUpdateTime: + readOnly: true description: >- - URI path prefix used to route to the specified environment. May - contain one or more wildcards. For example, path segments consisting - of a single `*` character will match any string. + Output only. Datastore last update time, in milliseconds since the + epoch of 1970-01-01T00:00:00Z type: string - updateTime: - format: google-datetime + format: int64 + org: type: string - description: >- - The unix timestamp when this rule was updated. This is updated - whenever env_group_revision is updated. This field is omitted from - the IngressConfig unless the GetDeployedIngressConfig API is called - with view=FULL. - receiver: - description: >- - The resource name of the proxy revision that is receiving this - basepath in the following format: - `organizations/{org}/apis/{api}/revisions/{rev}`. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. + description: Output only. Organization that the datastore belongs to + readOnly: true + displayName: + description: Required. Display name in UI type: string - environment: - description: >- - Name of an environment bound to the environment group in the - following format: `organizations/{org}/environments/{env}`. Only one - of environment or deployment_group will be set. + self: + readOnly: true type: string - otherTargets: description: >- - Conflicting targets, which will be resource names specifying either - deployment groups or environments. - type: array - items: - type: string - deploymentGroup: + Output only. Resource link of Datastore. Example: + `/organizations/{org}/analytics/datastores/{uuid}` + targetType: + type: string + description: Destination storage type. Supported types `gcs` or `bigquery`. + createTime: type: string - description: >- - Name of a deployment group in an environment bound to the - environment group in the following format: - `organizations/{org}/environment/{env}/deploymentGroups/{group}` - Only one of environment or deployment_group will be set. - envGroupRevision: format: int64 description: >- - The env group config revision_id when this rule was added or last - updated. This value is set when the rule is created and will only - update if the the environment_id changes. It is used to determine if - the runtime is up to date with respect to this rule. This field is - omitted from the IngressConfig unless the GetDeployedIngressConfig - API is called with view=FULL. - type: string + Output only. Datastore create time, in milliseconds since the epoch + of 1970-01-01T00:00:00Z + readOnly: true type: object - GoogleCloudApigeeV1Deployment: - id: GoogleCloudApigeeV1Deployment + id: GoogleCloudApigeeV1Datastore + GoogleCloudApigeeV1KeyValueEntry: + id: GoogleCloudApigeeV1KeyValueEntry properties: - environment: + value: + description: >- + Required. Data or payload that is being retrieved and associated + with the unique key. type: string - description: Environment. - revision: - description: API proxy revision. + name: + description: >- + Resource URI that can be used to identify the scope of the key value + map entries. type: string - deployStartTime: + description: >- + Key value map pair where the value represents the data associated with + the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and + higher. + type: object + GoogleCloudApigeeV1SecurityReportResultView: + id: GoogleCloudApigeeV1SecurityReportResultView + type: object + description: The response for security report result view APIs. + properties: + error: + description: Error message when there is a failure. type: string - format: int64 + rows: + type: array description: >- - Time the API proxy was marked `deployed` in the control plane in - millisconds since epoch. - serviceAccount: + Rows of security report result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} + items: + type: any + code: + description: Error code when there is a failure. + format: int32 + type: integer + state: + description: State of retrieving ResultView. + type: string + metadata: description: >- - The full resource name of Cloud IAM Service Account that this - deployment is using, eg, `projects/-/serviceAccounts/{email}`. + Metadata contains information like metrics, dimenstions etc of the + security report. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' + GoogleCloudApigeeV1AsyncQueryResult: + properties: + expires: + type: string + description: Query result will be unaccessable after this time. + self: type: string - instances: description: >- - Status reported by each runtime instance. **Note**: This field is - displayed only when viewing deployment status. + Self link of the query results. Example: + `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + or following format if query is running at host level: + `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` + id: GoogleCloudApigeeV1AsyncQueryResult + type: object + GoogleCloudApigeeV1RatePlan: + properties: + consumptionPricingRates: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' + $ref: '#/components/schemas/GoogleCloudApigeeV1RateRange' type: array - state: + description: >- + API call volume ranges and the fees charged when the total number of + API calls is within a given range. The method used to calculate the + final fee depends on the selected pricing model. For example, if the + pricing model is `STAIRSTEP` and the ranges are defined as follows: + ``` { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": + 200, "fee": 100 }, } ``` Then the following fees would be charged + based on the total number of API calls (assuming the currency + selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 + calls cost $100 The number of API calls cannot exceed 200. + billingPeriod: + description: Frequency at which the customer will be billed. enumDescriptions: - - This value should never be returned. - - Runtime has loaded the deployment. - - Deployment is not fully ready in the runtime. + - Billing period not specified. - >- - Encountered an error with the deployment that requires - intervention. + Weekly billing period. **Note**: Not supported by Apigee at this + time. + - Monthly billing period. type: string enum: - - RUNTIME_STATE_UNSPECIFIED - - READY - - PROGRESSING - - ERROR - description: >- - Current state of the deployment. **Note**: This field is displayed - only when viewing deployment status. - errors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Errors reported for this deployment. Populated only when state == - ERROR. **Note**: This field is displayed only when viewing - deployment status. + - BILLING_PERIOD_UNSPECIFIED + - WEEKLY + - MONTHLY + revenueShareRates: + description: Details of the revenue sharing model. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1RevenueShareRange' type: array - proxyDeploymentType: + fixedRecurringFee: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Output only. The type of the deployment (standard or extensible) - Deployed proxy revision will be marked as extensible in following 2 - cases. 1. The deployed proxy revision uses extensible policies. 2. - If a environment supports flowhooks and flow hook is configured. + Fixed amount that is charged at a defined interval and billed in + advance of use of the API product. The fee will be prorated for the + first billing period. + state: + description: Current state of the rate plan (draft or published). enumDescriptions: + - State of the rate plan is not specified. + - Rate plan is in draft mode and only visible to API providers. - >- - Default value till public preview. After public preview this value - should not be returned. + Rate plan is published and will become visible to developers for + the configured duration (between `startTime` and `endTime`). + enum: + - STATE_UNSPECIFIED + - DRAFT + - PUBLISHED + type: string + revenueShareType: + type: string + enum: + - REVENUE_SHARE_TYPE_UNSPECIFIED + - FIXED + - VOLUME_BANDED + enumDescriptions: + - Revenue share type is not specified. - >- - Deployment will be of type Standard if only Standard proxies are - used + Fixed percentage of the total revenue will be shared. The + percentage to be shared can be configured by the API provider. - >- - Proxy will be of type Extensible if deployments uses one or more - Extensible proxies - readOnly: true - type: string + Amount of revenue shared depends on the number of API calls. The + API call volume ranges and the revenue share percentage for each + volume can be configured by the API provider. **Note**: Not + supported by Apigee at this time. + description: Method used to calculate the revenue that is shared with developers. + consumptionPricingType: + description: Pricing model used for consumption-based charges. enum: - - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE - apiProxy: + - CONSUMPTION_PRICING_TYPE_UNSPECIFIED + - FIXED_PER_UNIT + - BANDED + - TIERED + - STAIRSTEP type: string - description: API proxy. - routeConflicts: - type: array - description: >- - Conflicts in the desired state routing configuration. The presence - of conflicts does not cause the state to be `ERROR`, but it will - mean that some of the deployment's base paths are not routed to its - environment. If the conflicts change, the state will transition to - `PROGRESSING` until the latest configuration is rolled out to all - instances. **Note**: This field is displayed only when viewing - deployment status. - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict - pods: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' + enumDescriptions: + - Pricing model not specified. This is the default. + - Fixed rate charged for each API call. + - >- + Variable rate charged for each API call based on price tiers. + Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 + per call * 201-300 calls cost $1 per call * Total price for 50 + calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x + $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + + 50 x $1 = $400. **Note**: Not supported by Apigee at this time. + - '**Note**: Not supported by Apigee at this time.' + - '**Note**: Not supported by Apigee at this time.' + currencyCode: description: >- - Status reported by runtime pods. **Note**: **This field is - deprecated**. Runtime versions 1.3 and above report instance level - status rather than pod status. - type: object - GoogleCloudApigeeV1Developer: - id: GoogleCloudApigeeV1Developer - type: object - properties: - accessType: - description: Access type. + Currency to be used for billing. Consists of a three-letter code as + defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) + standard. type: string - status: - readOnly: true - description: >- - Output only. Status of the developer. Valid values are `active` and - `inactive`. + startTime: type: string - firstName: - description: Required. First name of the developer. + description: Time when the rate plan becomes active in milliseconds since epoch. + format: int64 + name: + description: Output only. Name of the rate plan. + readOnly: true type: string - organizationName: + setupFee: + description: Initial, one-time fee paid when purchasing the API product. + $ref: '#/components/schemas/GoogleTypeMoney' + lastModifiedAt: + format: int64 + readOnly: true description: >- - Output only. Name of the Apigee organization in which the developer - resides. + Output only. Time the rate plan was last modified in milliseconds + since epoch. + type: string + createdAt: + format: int64 type: string readOnly: true - attributes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' description: >- - Optional. Developer attributes (name/value pairs). The custom - attribute limit is 18. - email: + Output only. Time that the rate plan was created in milliseconds + since epoch. + displayName: + description: Display name of the rate plan. type: string - description: >- - Required. Email address of the developer. This value is used to - uniquely identify the developer in Apigee hybrid. Note that the - email address has to be in lowercase only. - developerId: + apiproduct: type: string - description: >- - ID of the developer. **Note**: IDs are generated internally by - Apigee and are not guaranteed to stay the same over time. - lastModifiedAt: + description: Name of the API product that the rate plan is associated with. + description: + description: Description of the rate plan. type: string - readOnly: true + endTime: format: int64 + type: string description: >- - Output only. Time at which the developer was last modified in - milliseconds since epoch. - createdAt: + Time when the rate plan will expire in milliseconds since epoch. Set + to 0 or `null` to indicate that the rate plan should never expire. + fixedFeeFrequency: + type: integer + format: int32 + description: Frequency at which the fixed fee is charged. + paymentFundingModel: + enum: + - PAYMENT_FUNDING_MODEL_UNSPECIFIED + - PREPAID + - POSTPAID + deprecated: true type: string + enumDescriptions: + - Billing account type not specified. + - >- + Prepaid billing account type. Developer pays in advance for the + use of your API products. Funds are deducted from their prepaid + account balance. **Note**: Not supported by Apigee at this time. + - >- + Postpaid billing account type. Developer is billed through an + invoice after using your API products. description: >- - Output only. Time at which the developer was created in milliseconds - since epoch. - readOnly: true - format: int64 - companies: - description: List of companies associated with the developer. - items: - type: string - type: array - apps: + DEPRECATED: This field is no longer supported and will eventually be + removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, + use the `billingType` field inside `DeveloperMonetizationConfig` + resource. Flag that specifies the billing account type, prepaid or + postpaid. + id: GoogleCloudApigeeV1RatePlan + description: Rate plan details. + type: object + GoogleCloudApigeeV1ListDatastoresResponse: + description: The response for ListDatastores + type: object + id: GoogleCloudApigeeV1ListDatastoresResponse + properties: + datastores: + description: A list of datastores items: - type: string - description: List of apps associated with the developer. + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' type: array - lastName: - description: Required. Last name of the developer. - type: string - appFamily: + GoogleCloudApigeeV1DateRange: + description: Date range of the data to export. + id: GoogleCloudApigeeV1DateRange + type: object + properties: + end: + description: >- + Required. End date (exclusive) of the data to export in the format + `yyyy-mm-dd`. The date range ends at 00:00:00 UTC on the end date- + which will not be in the output. type: string - description: Developer app family. - userName: - description: Required. User name of the developer. Not used by Apigee hybrid. + start: type: string - GoogleCloudApigeeV1ListCustomReportsResponse: - description: This message encapsulates a list of custom report definitions + description: >- + Required. Start date of the data to export in the format + `yyyy-mm-dd`. The date range begins at 00:00:00 UTC on the start + date. + GoogleCloudApigeeV1SecurityReportQueryMetric: type: object + id: GoogleCloudApigeeV1SecurityReportQueryMetric + description: Metric of the Query properties: - qualifier: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - id: GoogleCloudApigeeV1ListCustomReportsResponse - GoogleCloudApigeeV1ReportInstanceStatusResponse: - type: object - properties: {} - id: GoogleCloudApigeeV1ReportInstanceStatusResponse - description: Placeholder for future enhancements to status reporting protocol + operator: + type: string + description: One of `+`, `-`, `/`, `%`, `*`. + alias: + type: string + description: >- + Alias for the metric. Alias will be used to replace metric name in + query results. + name: + type: string + description: Required. Metric name. + aggregationFunction: + type: string + description: 'Aggregation function: avg, min, max, or sum.' + value: + type: string + description: Operand value should be provided when operator is set. EdgeConfigstoreBundleBadBundleViolation: + description: A message type used to describe a single bundle validation error. type: object properties: description: - description: A description of why the bundle is invalid and how to fix it. type: string + description: A description of why the bundle is invalid and how to fix it. filename: type: string description: >- The filename (including relative path from the bundle root) in which the error occurred. id: EdgeConfigstoreBundleBadBundleViolation - description: A message type used to describe a single bundle validation error. - GoogleCloudApigeeV1ListInstancesResponse: - id: GoogleCloudApigeeV1ListInstancesResponse - description: Response for ListInstances. - type: object + GoogleCloudApigeeV1Properties: properties: - nextPageToken: - description: >- - Page token that you can include in a ListInstance request to - retrieve the next page of content. If omitted, no subsequent pages - exist. - type: string - instances: + property: + description: List of all properties in the object + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1Property' + type: object + description: >- + Message for compatibility with legacy Edge specification for Java + Properties object in JSON. + id: GoogleCloudApigeeV1Properties + GoogleCloudApigeeV1OptimizedStatsNode: + properties: + data: type: array - description: Instances in the specified organization. - GoogleCloudApigeeV1UpdateError: + items: + type: any + id: GoogleCloudApigeeV1OptimizedStatsNode + type: object + description: >- + Encapsulates a data node as represented below: ``` { "identifier": { + "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": + "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` + { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` + Depending on whether a dimension is present in the query or not the data + node type can be a simple metric value or dimension identifier with list + of metrics. + GoogleCloudApigeeV1SetAddonsRequest: + id: GoogleCloudApigeeV1SetAddonsRequest + description: Request for SetAddons. + type: object + properties: + addonsConfig: + description: Required. Add-on configurations. + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + GoogleCloudApigeeV1AddonsConfig: + type: object + description: Add-on configurations for the Apigee organization. + id: GoogleCloudApigeeV1AddonsConfig + properties: + analyticsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1AnalyticsConfig' + description: >- + Configuration for the Analytics add-on. Only used in + organizations.environments.addonsConfig. + integrationConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1IntegrationConfig' + description: Configuration for the Integration add-on. + advancedApiOpsConfig: + description: Configuration for the Advanced API Ops add-on. + $ref: '#/components/schemas/GoogleCloudApigeeV1AdvancedApiOpsConfig' + monetizationConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1MonetizationConfig' + description: Configuration for the Monetization add-on. + connectorsPlatformConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1ConnectorsPlatformConfig' + description: Configuration for the Connectors Platform add-on. + apiSecurityConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiSecurityConfig' + description: Configuration for the API Security add-on. + GoogleCloudApigeeV1ListApiDocsResponse: + type: object properties: message: - description: User-friendly error message. type: string - type: - description: >- - A string that uniquely identifies the type of error. This provides a - more reliable means to deduplicate errors across revisions and - instances. + description: Description of the operation. + status: type: string - resource: + description: Status of the operation. + data: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + type: array + description: The catalog item resources. + requestId: + type: string + description: Unique ID of the request. + errorCode: type: string + description: Unique error code for the request, if any. + nextPageToken: description: >- - The sub resource specific to this error (e.g. a proxy deployed - within the EnvironmentConfig). If empty the error refers to the top - level resource. - code: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: Status code. - enum: - - OK - - CANCELLED - - UNKNOWN - - INVALID_ARGUMENT - - DEADLINE_EXCEEDED - - NOT_FOUND - - ALREADY_EXISTS - - PERMISSION_DENIED - - UNAUTHENTICATED - - RESOURCE_EXHAUSTED - - FAILED_PRECONDITION - - ABORTED - - OUT_OF_RANGE - - UNIMPLEMENTED - - INTERNAL - - UNAVAILABLE - - DATA_LOSS - enumDescriptions: - - 'Not an error; returned on success. HTTP Mapping: 200 OK' - - >- - The operation was cancelled, typically by the caller. HTTP - Mapping: 499 Client Closed Request - - >- - Unknown error. For example, this error may be returned when a - `Status` value received from another address space belongs to an - error space that is not known in this address space. Also errors - raised by APIs that do not return enough error information may be - converted to this error. HTTP Mapping: 500 Internal Server Error - - >- - The client specified an invalid argument. Note that this differs - from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments - that are problematic regardless of the state of the system (e.g., - a malformed file name). HTTP Mapping: 400 Bad Request - - >- - The deadline expired before the operation could complete. For - operations that change the state of the system, this error may be - returned even if the operation has completed successfully. For - example, a successful response from a server could have been - delayed long enough for the deadline to expire. HTTP Mapping: 504 - Gateway Timeout - - >- - Some requested entity (e.g., file or directory) was not found. - Note to server developers: if a request is denied for an entire - class of users, such as gradual feature rollout or undocumented - allowlist, `NOT_FOUND` may be used. If a request is denied for - some users within a class of users, such as user-based access - control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not - Found - - >- - The entity that a client attempted to create (e.g., file or - directory) already exists. HTTP Mapping: 409 Conflict - - >- - The caller does not have permission to execute the specified - operation. `PERMISSION_DENIED` must not be used for rejections - caused by exhausting some resource (use `RESOURCE_EXHAUSTED` - instead for those errors). `PERMISSION_DENIED` must not be used if - the caller can not be identified (use `UNAUTHENTICATED` instead - for those errors). This error code does not imply the request is - valid or the requested entity exists or satisfies other - pre-conditions. HTTP Mapping: 403 Forbidden - - >- - The request does not have valid authentication credentials for the - operation. HTTP Mapping: 401 Unauthorized - - >- - Some resource has been exhausted, perhaps a per-user quota, or - perhaps the entire file system is out of space. HTTP Mapping: 429 - Too Many Requests - - >- - The operation was rejected because the system is not in a state - required for the operation's execution. For example, the directory - to be deleted is non-empty, an rmdir operation is applied to a - non-directory, etc. Service implementors can use the following - guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and - `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just - the failing call. (b) Use `ABORTED` if the client should retry at - a higher level. For example, when a client-specified test-and-set - fails, indicating the client should restart a read-modify-write - sequence. (c) Use `FAILED_PRECONDITION` if the client should not - retry until the system state has been explicitly fixed. For - example, if an "rmdir" fails because the directory is non-empty, - `FAILED_PRECONDITION` should be returned since the client should - not retry unless the files are deleted from the directory. HTTP - Mapping: 400 Bad Request - - >- - The operation was aborted, typically due to a concurrency issue - such as a sequencer check failure or transaction abort. See the - guidelines above for deciding between `FAILED_PRECONDITION`, - `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict - - >- - The operation was attempted past the valid range. E.g., seeking or - reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error - indicates a problem that may be fixed if the system state changes. - For example, a 32-bit file system will generate `INVALID_ARGUMENT` - if asked to read at an offset that is not in the range [0,2^32-1], - but it will generate `OUT_OF_RANGE` if asked to read from an - offset past the current file size. There is a fair bit of overlap - between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend - using `OUT_OF_RANGE` (the more specific error) when it applies so - that callers who are iterating through a space can easily look for - an `OUT_OF_RANGE` error to detect when they are done. HTTP - Mapping: 400 Bad Request - - >- - The operation is not implemented or is not supported/enabled in - this service. HTTP Mapping: 501 Not Implemented - - >- - Internal errors. This means that some invariants expected by the - underlying system have been broken. This error code is reserved - for serious errors. HTTP Mapping: 500 Internal Server Error - - >- - The service is currently unavailable. This is most likely a - transient condition, which can be corrected by retrying with a - backoff. Note that it is not always safe to retry non-idempotent - operations. See the guidelines above for deciding between - `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: - 503 Service Unavailable - - >- - Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal - Server Error - id: GoogleCloudApigeeV1UpdateError - type: object - description: Details on why a resource update failed in the runtime. - GoogleCloudApigeeV1SharedFlow: + id: GoogleCloudApigeeV1ListApiDocsResponse + GoogleCloudApigeeV1Instance: + description: Apigee runtime instance. + id: GoogleCloudApigeeV1Instance type: object - id: GoogleCloudApigeeV1SharedFlow - description: The metadata describing a shared flow properties: - latestRevisionId: - description: The id of the most recently created revision for this shared flow. + serviceAttachment: + readOnly: true + type: string + description: >- + Output only. Resource name of the service attachment created for the + instance in the format: `projects/*/regions/*/serviceAttachments/*` + Apigee customers can privately forward traffic to this service + attachment using the PSC endpoints. + runtimeVersion: + description: >- + Output only. Version of the runtime system running in the instance. + The runtime system is the set of components that serve the API Proxy + traffic in your Environments. + type: string + readOnly: true + accessLoggingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1AccessLoggingConfig' + description: >- + Optional. Access logging configuration enables the access logging + feature at the instance. Apigee customers can enable access logging + to ship the access logs to their own project's cloud logging. + ipRange: + type: string + description: >- + Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 + used to create the Apigee instance. Providing CIDR ranges is + optional. You can provide just /22 or /28 or both (or neither). + Ranges you provide should be freely available as part of a larger + named range you have allocated to the Service Networking peering. If + this parameter is not provided, Apigee automatically requests an + available /22 and /28 CIDR block from Service Networking. Use the + /22 CIDR block for configuring your firewall needs to allow traffic + from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or + `a.b.c.d/22,e.f.g.h/28` + host: + readOnly: true + description: >- + Output only. Internal hostname or IP address of the Apigee endpoint + used by clients to connect to the service. + type: string + lastModifiedAt: + format: int64 + readOnly: true + description: >- + Output only. Time the instance was last modified in milliseconds + since epoch. type: string name: type: string - description: The ID of the shared flow. - revision: - items: - type: string - description: A list of revisions of this shared flow. - type: array - metaData: - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - description: Metadata describing the shared flow. - GoogleCloudApigeeV1SecurityReportResultView: - properties: - metadata: description: >- - Metadata contains information like metrics, dimenstions etc of the - security report. - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportMetadata' - error: + Required. Resource ID of the instance. Values must match the regular + expression `^a-z{0,30}[a-z\d]$`. + displayName: type: string - description: Error message when there is a failure. + description: Optional. Display name for the instance. + description: + type: string + description: Optional. Description of the instance. + location: + type: string + description: Required. Compute Engine location where the instance resides. + peeringCidrRange: + enum: + - CIDR_RANGE_UNSPECIFIED + - SLASH_16 + - SLASH_17 + - SLASH_18 + - SLASH_19 + - SLASH_20 + - SLASH_22 + - SLASH_23 + enumDescriptions: + - Range not specified. + - '`/16` CIDR range.' + - '`/17` CIDR range.' + - '`/18` CIDR range.' + - '`/19` CIDR range.' + - '`/20` CIDR range.' + - '`/22` CIDR range. Supported for evaluation only.' + - '`/23` CIDR range. Supported for evaluation only.' + deprecated: true + description: >- + Optional. Size of the CIDR block range that will be reserved by the + instance. PAID organizations support `SLASH_16` to `SLASH_20` and + defaults to `SLASH_16`. Evaluation organizations support only + `SLASH_23`. + type: string + port: + readOnly: true + type: string + description: Output only. Port number of the exposed Apigee endpoint. + diskEncryptionKeyName: + type: string + description: >- + Customer Managed Encryption Key (CMEK) used for disk and volume + encryption. If not specified, a Google-Managed encryption key will + be used. Use the following format: + `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` state: - description: State of retrieving ResultView. + readOnly: true type: string - rows: - items: - type: any + description: >- + Output only. State of the instance. Values other than `ACTIVE` means + the resource is not ready to use. + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + consumerAcceptList: type: array description: >- - Rows of security report result. Each row is a JSON object. Example: - {sum(message_count): 1, developer_app: "(not set)",…} - code: - description: Error code when there is a failure. - format: int32 - type: integer - id: GoogleCloudApigeeV1SecurityReportResultView - description: The response for security report result view APIs. - type: object - GoogleLongrunningOperation: - id: GoogleLongrunningOperation + Optional. Customer accept list represents the list of projects + (id/number) on customer side that can privately connect to the + service attachment. It is an optional field which the customers can + provide during the instance creation. By default, the customer + project associated with the Apigee organization will be included to + the list. + items: + type: string + createdAt: + type: string + description: >- + Output only. Time the instance was created in milliseconds since + epoch. + format: int64 + readOnly: true + GoogleCloudApigeeV1ConnectorsPlatformConfig: + id: GoogleCloudApigeeV1ConnectorsPlatformConfig type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. properties: - response: + expiresAt: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: + Output only. Time at which the Connectors Platform add-on expires in + milliseconds since epoch. If unspecified, the add-on will never + expire. + format: int64 + readOnly: true type: string + enabled: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Flag that specifies whether the Connectors Platform add-on is + enabled. + type: boolean + description: Configuration for the Connectors Platform add-on. + GoogleCloudApigeeV1EnvironmentGroup: + description: >- + EnvironmentGroup configuration. An environment group is used to group + one or more Apigee environments under a single host name. + properties: + lastModifiedAt: + type: string description: >- - The error result of the operation in case of failure or - cancellation. - done: + Output only. The time at which the environment group was last + updated as milliseconds since epoch. + format: int64 + readOnly: true + state: + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - UPDATING + type: string + readOnly: true + enumDescriptions: + - Resource is in an unspecified state. + - Resource is being created. + - Resource is provisioned and ready to use. + - The resource is being deleted. + - The resource is being updated. description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + Output only. State of the environment group. Values other than + ACTIVE means the resource is not ready to use. + name: + description: ID of the environment group. + type: string + hostnames: + type: array + items: + type: string + description: Required. Host names for this environment group. + createdAt: + readOnly: true + format: int64 description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - GoogleCloudApigeeV1IngressConfig: + Output only. The time at which the environment group was created as + milliseconds since epoch. + type: string + id: GoogleCloudApigeeV1EnvironmentGroup + type: object + GoogleCloudApigeeV1SharedFlow: + properties: + name: + type: string + description: The ID of the shared flow. + latestRevisionId: + type: string + description: The id of the most recently created revision for this shared flow. + metaData: + description: Metadata describing the shared flow. + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + revision: + type: array + description: A list of revisions of this shared flow. + items: + type: string + id: GoogleCloudApigeeV1SharedFlow type: object - id: GoogleCloudApigeeV1IngressConfig + description: The metadata describing a shared flow + GoogleCloudApigeeV1EndpointChainingRule: properties: - uid: + deploymentGroup: description: >- - A unique id for the ingress config that will only change if the - organization is deleted and recreated. - type: string - revisionCreateTime: + The deployment group to target for cross-shard chaining calls to + these proxies. type: string - format: google-datetime - description: Time at which the IngressConfig revision was created. - environmentGroups: + proxyIds: + description: List of proxy ids which may be found in the given deployment group. type: array - description: List of environment groups in the organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' - name: - description: >- - Name of the resource in the following format: - `organizations/{org}/deployedIngressConfig`. - type: string - revisionId: - description: >- - Revision id that defines the ordering on IngressConfig resources. - The higher the revision, the more recently the configuration was - deployed. - format: int64 - type: string - GoogleCloudApigeeV1DeploymentGroupConfig: + type: string + id: GoogleCloudApigeeV1EndpointChainingRule description: >- - DeploymentGroupConfig represents a deployment group that should be - present in a particular environment. + EndpointChainingRule specifies the proxies contained in a particular + deployment group, so that other deployment groups can find them in + chaining calls. + type: object + GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute: + type: object + id: GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + description: Route deployed in the ingress routing table. properties: - name: + percentage: + description: Percentage of ingress replicas reporting this route. + format: int32 + type: integer + envgroup: type: string - description: >- - Name of the deployment group in the following format: - `organizations/{org}/environments/{env}/deploymentGroups/{group}`. - revisionId: - format: int64 + description: Environment group where this route is installed. + basepath: type: string - description: >- - Revision number which can be used by the runtime to detect if the - deployment group has changed between two versions. - uid: - description: >- - Unique ID. The ID will only change if the deployment group is - deleted and recreated. + description: Base path in the routing table. + environment: type: string - deploymentGroupType: - enum: - - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED - - STANDARD - - EXTENSIBLE description: >- - Type of the deployment group, which will be either Standard or - Extensible. - type: string - enumDescriptions: - - Unspecified type - - Standard type - - Extensible Type - id: GoogleCloudApigeeV1DeploymentGroupConfig - type: object - GoogleCloudApigeeV1MonetizationConfig: - type: object - id: GoogleCloudApigeeV1MonetizationConfig - properties: - enabled: - description: Flag that specifies whether the Monetization add-on is enabled. - type: boolean - description: Configuration for the Monetization add-on. - GoogleCloudApigeeV1Schema: - id: GoogleCloudApigeeV1Schema + Destination environment. This will be empty if the route is not yet + reported. + GoogleCloudApigeeV1AsyncQueryResultView: properties: - dimensions: - description: List of schema fields grouped as dimensions. + rows: type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' - meta: description: >- - Additional metadata associated with schema. This is a legacy field - and usually consists of an empty array of strings. + Rows of query result. Each row is a JSON object. Example: + {sum(message_count): 1, developer_app: "(not set)",…} items: - type: string - type: array - metrics: - type: array + type: any + code: + description: Error code when there is a failure. + format: int32 + type: integer + state: + description: State of retrieving ResultView. + type: string + error: + description: Error message when there is a failure. + type: string + metadata: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetadata' description: >- - List of schema fields grouped as dimensions that can be used with an - aggregate function such as `sum`, `avg`, `min`, and `max`. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' - description: Response for Schema call - type: object - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation: + Metadata contains information like metrics, dimenstions etc of the + AsyncQuery. + id: GoogleCloudApigeeV1AsyncQueryResultView type: object - id: >- - GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation - description: The format of the assessment recommendation. - properties: - link: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendationLink - description: The link for the recommendation. - description: - type: string - description: The description of the recommendation. - GoogleCloudApigeeV1GenerateDownloadUrlRequest: - id: GoogleCloudApigeeV1GenerateDownloadUrlRequest - description: Request for GenerateDownloadUrl method. - properties: {} + GoogleCloudApigeeV1RuntimeAddonsConfig: type: object - GoogleCloudApigeeV1Reference: properties: - refers: + uid: type: string description: >- - Required. The id of the resource to which this reference refers. - Must be the id of a resource that exists in the parent environment - and is of the given resource_type. - description: - type: string - description: Optional. A human-readable description of this reference. + UID is to detect if config is recreated after deletion. The add-on + config will only be deleted when the environment itself gets + deleted, thus it will always be the same as the UID of + EnvironmentConfig. + apiSecurityConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' + description: Runtime configuration for API Security add-on. name: - description: >- - Required. The resource id of this reference. Values must match the - regular expression [\w\s\-.]+. type: string - resourceType: description: >- - The type of resource referred to by this reference. Valid values are - 'KeyStore' or 'TrustStore'. + Name of the addons config in the format: + `organizations/{org}/environments/{env}/addonsConfig` + revisionId: type: string - id: GoogleCloudApigeeV1Reference + description: Revision number used by the runtime to detect config changes. + analyticsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' + description: Runtime configuration for Analytics add-on. description: >- - A Reference configuration. References must refer to a keystore that also - exists in the parent environment. - type: object - GoogleCloudApigeeV1Credential: - id: GoogleCloudApigeeV1Credential + RuntimeAddonsConfig defines the runtime configurations for add-ons in an + environment. + id: GoogleCloudApigeeV1RuntimeAddonsConfig + GoogleCloudApigeeV1CertInfo: + description: X.509 certificate as defined in RFC 5280. properties: - scopes: - items: - type: string - type: array - description: >- - List of scopes to apply to the app. Specified scopes must already - exist on the API product that you associate with the app. - issuedAt: - description: Time the credential was issued in milliseconds since epoch. + issuer: type: string + description: X.509 issuer. + version: + description: X.509 version. + type: integer + format: int32 + validFrom: format: int64 - status: type: string - description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - apiProducts: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' - type: array - description: List of API products this credential can be used for. - attributes: + description: X.509 `notBefore` validity period in milliseconds since epoch. + subjectAlternativeNames: + description: X.509 subject alternative names (SANs) extension. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes associated with this credential. - consumerKey: + type: string + isValid: type: string - description: Consumer key. - expiresAt: - format: int64 + description: >- + Flag that specifies whether the certificate is valid. Flag is set to + `Yes` if the certificate is valid, `No` if expired, or `Not yet` if + not yet valid. + serialNumber: + description: X.509 serial number. type: string - description: Time the credential will expire in milliseconds since epoch. - consumerSecret: + expiryDate: type: string - description: Secret key. - type: object - GoogleCloudApigeeV1ResourceStatus: - properties: - revisions: - type: array - description: Revisions of the resource currently deployed in the instance. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1RevisionStatus' - resource: + description: X.509 `notAfter` validity period in milliseconds since epoch. + format: int64 + sigAlgName: type: string - description: >- - The resource name. Currently only two resources are supported: - EnvironmentGroup - organizations/{org}/envgroups/{envgroup} - EnvironmentConfig - - organizations/{org}/environments/{environment}/deployedConfig - totalReplicas: - type: integer - format: int32 - description: The total number of replicas that should have this resource. - uid: + description: X.509 signatureAlgorithm. + basicConstraints: type: string - description: >- - The uid of the resource. In the unexpected case that the instance - has multiple uids for the same name, they should be reported under - separate ResourceStatuses. - id: GoogleCloudApigeeV1ResourceStatus - type: object - description: The status of a resource loaded in the runtime. - GoogleCloudApigeeV1SecurityActionFlag: + description: X.509 basic constraints extension. + publicKey: + description: Public key component of the X.509 subject public key info. + type: string + subject: + description: X.509 subject. + type: string + id: GoogleCloudApigeeV1CertInfo type: object - id: GoogleCloudApigeeV1SecurityActionFlag - description: The message that should be set in the case of a Flag action. - properties: - headers: - description: >- - Optional. A list of HTTP headers to be sent to the target in case of - a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least - one is mandatory. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' - type: array - GoogleCloudApigeeV1ApiProduct: + GoogleCloudApigeeV1EnvironmentGroupConfig: properties: - apiResources: + endpointChainingRules: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointChainingRule' type: array + description: A list of proxies in each deployment group for proxy chaining calls. + name: description: >- - Comma-separated list of API resources to be bundled in the API - product. By default, the resource paths are mapped from the - `proxy.pathsuffix` variable. The proxy path suffix is defined as the - URI fragment following the ProxyEndpoint base path. For example, if - the `apiResources` element is defined to be `/forecastrss` and the - base path defined for the API proxy is `/weather`, then only - requests to `/weather/forecastrss` are permitted by the API product. - You can select a specific path, or you can select all subpaths with - the following wildcard: - `/**`: Indicates that all sub-URIs are - included. - `/*` : Indicates that only URIs one level down are - included. By default, / supports the same resources as /** as well - as the base path defined by the API proxy. For example, if the base - path of the API proxy is `/v1/weatherapikey`, then the API product - supports requests to `/v1/weatherapikey` and to any sub-URIs, such - as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, - and so on. For more information, see Managing API products. - description: + Name of the environment group in the following format: + `organizations/{org}/envgroups/{envgroup}`. type: string + routingRules: description: >- - Description of the API product. Include key information about the - API product that is not captured by other fields. - scopes: - description: >- - Comma-separated list of OAuth scopes that are validated at runtime. - Apigee validates that the scopes in any access token presented match - the scopes defined in the OAuth policy associated with the API - product. + Ordered list of routing rules defining how traffic to this + environment group's hostnames should be routed to different + environments. type: array items: - type: string - createdAt: - type: string - format: int64 - description: >- - Response only. Creation time of this environment as milliseconds - since epoch. - graphqlOperationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperationGroup' - description: >- - Configuration used to group Apigee proxies or remote services with - graphQL operation name, graphQL operation type and quotas. This - grouping allows us to precisely set quota for a particular - combination of graphQL name and operation type for a particular - proxy request. If graphQL name is not set, this would imply quota - will be applied on all graphQL requests matching the operation type. - quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1RoutingRule' + location: description: >- - Number of request messages permitted per app by this API product for - the specified `quotaInterval` and `quotaTimeUnit`. For example, a - `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of - hours means 50 requests are allowed every 12 hours. + When this message appears in the top-level IngressConfig, this field + will be populated in lieu of the inlined routing_rules and hostnames + fields. Some URL for downloading the full EnvironmentGroupConfig for + this group. type: string - quotaCounterScope: - description: >- - Scope of the quota decides how the quota counter gets applied and - evaluate for quota violation. If the Scope is set as PROXY, then all - the operations defined for the APIproduct that are associated with - the same proxy will share the same quota counter set at the - APIproduct level, making it a global counter at a proxy level. If - the Scope is set as OPERATION, then each operations get the counter - set at the API product dedicated, making it a local counter. Note - that, the QuotaCounterScope applies only when an operation does not - have dedicated quota set for itself. + uid: type: string - enumDescriptions: - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), set at product level will be used as a - global counter for quota evaluation by all the operations - associated with a particular proxy. - - >- - When quota is not explicitly defined for each - operation(REST/GraphQL), the limits set at product level will be - used as a local counter for quota evaluation by all the - operations, independent of proxy association. This behavior mimics - the same as QUOTA_COUNTER_SCOPE_UNSPECIFIED. - enum: - - QUOTA_COUNTER_SCOPE_UNSPECIFIED - - PROXY - - OPERATION - operationGroup: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationGroup' description: >- - Configuration used to group Apigee proxies or remote services with - resources, method types, and quotas. The resource refers to the - resource URI (excluding the base path). With this grouping, the API - product creator is able to fine-tune and give precise control over - which REST methods have access to specific resources and how many - calls can be made (using the `quota` setting). **Note:** The - `api_resources` setting cannot be specified for both the API product - and operation group; otherwise the call will fail. - name: + A unique id for the environment group config that will only change + if the environment group is deleted and recreated. + revisionId: type: string description: >- - Internal name of the API product. Characters you can use in the name - are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name - cannot be edited when updating the API product. - attributes: + Revision id that defines the ordering of the EnvironmentGroupConfig + resource. The higher the revision, the more recently the + configuration was deployed. + format: int64 + hostnames: + type: array + items: + type: string + description: Host names for the environment group. + description: >- + EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup + and its associated routing rules. + id: GoogleCloudApigeeV1EnvironmentGroupConfig + type: object + GoogleCloudApigeeV1GraphQLOperationConfig: + properties: + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' description: >- - Array of attributes that may be used to extend the default API - product profile with customer-specific metadata. You can specify a - maximum of 18 attributes. Use this property to specify the access - level of the API product as either `public`, `private`, or - `internal`. Only products marked `public` are available to - developers in the Apigee developer portal. For example, you can set - a product to `internal` while it is in development and then change - access to `public` when it is ready to release on the portal. API - products marked as `private` do not appear on the portal, but can be - accessed by external developers. + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. + attributes: items: $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: Custom attributes associated with the operation. type: array - proxies: + operations: type: array items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1GraphQLOperation' description: >- - Comma-separated list of API proxy names to which this API product is - bound. By specifying API proxies, you can associate resources in the - API product with specific API proxies, preventing developers from - accessing those resources through other API proxies. Apigee rejects - requests to API proxies that are not listed. **Note:** The API proxy - names must already exist in the specified environment as they will - be validated upon creation. - quotaTimeUnit: + Required. List of GraphQL name/operation type pairs for the proxy or + remote service to which quota will be applied. If only operation + types are specified, the quota will be applied to all GraphQL + requests irrespective of the GraphQL name. **Note**: Currently, you + can specify only a single GraphQLOperation. Specifying more than one + will cause the operation to fail. + apiSource: + description: >- + Required. Name of the API proxy endpoint or remote service with + which the GraphQL operation and quota are associated. + type: string + description: >- + Binds the resources in a proxy or remote service with the GraphQL + operation and its associated quota enforcement. + id: GoogleCloudApigeeV1GraphQLOperationConfig + type: object + GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse: + id: GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + properties: + nextStartKey: type: string description: >- - Time unit defined for the `quotaInterval`. Valid values include - `minute`, `hour`, `day`, or `month`. - environments: + Value that can be sent as `startKey` to retrieve the next page of + content. If this field is omitted, there are no subsequent pages. + developerSubscriptions: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + description: List of all subscriptions. type: array + description: Response for ListDeveloperSubscriptions. + type: object + GoogleCloudApigeeV1ListApiProductsResponse: + type: object + properties: + apiProduct: items: - type: string - description: >- - Comma-separated list of environment names to which the API product - is bound. Requests to environments that are not listed are rejected. - By specifying one or more environments, you can bind the resources - listed in the API product to a specific environment, preventing - developers from accessing those resources through API proxies - deployed in another environment. This setting is used, for example, - to prevent resources associated with API proxies in `prod` from - being accessed by API proxies deployed in `test`. - grpcOperationGroup: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + type: array + description: Lists all API product names defined for an organization. + id: GoogleCloudApigeeV1ListApiProductsResponse + GoogleCloudApigeeV1ApiSecurityConfig: + description: Configurations of the API Security add-on. + properties: + enabled: + type: boolean + description: Flag that specifies whether the API security add-on is enabled. + expiresAt: description: >- - Optional. Configuration used to group Apigee proxies with gRPC - services and method names. This grouping allows us to set quota for - a particular proxy with the gRPC service name and method. If a - method name is not set, this implies quota and authorization are - applied to all gRPC methods implemented by that proxy for that - particular gRPC service. - $ref: '#/components/schemas/GoogleCloudApigeeV1GrpcOperationGroup' - displayName: + Output only. Time at which the API Security add-on expires in in + milliseconds since epoch. If unspecified, the add-on will never + expire. + type: string + readOnly: true + format: int64 + type: object + id: GoogleCloudApigeeV1ApiSecurityConfig + GoogleCloudApigeeV1DeveloperSubscription: + properties: + apiproduct: type: string description: >- - Name displayed in the UI or developer portal to developers - registering for API access. + Name of the API product for which the developer is purchasing a + subscription. lastModifiedAt: + format: int64 description: >- - Response only. Modified time of this environment as milliseconds - since epoch. + Output only. Time when the API product subscription was last + modified in milliseconds since epoch. + readOnly: true type: string - format: int64 - approvalType: + createdAt: type: string + readOnly: true description: >- - Flag that specifies how API keys are approved to access the APIs - defined by the API product. If set to `manual`, the consumer key is - generated and returned in "pending" state. In this case, the API - keys won't work until they have been explicitly approved. If set to - `auto`, the consumer key is generated and returned in "approved" - state and can be used immediately. **Note:** Typically, `auto` is - used to provide access to free or trial API products that provide - limited quota or capabilities. - quotaInterval: + Output only. Time when the API product subscription was created in + milliseconds since epoch. + format: int64 + startTime: + format: int64 type: string description: >- - Time interval over which the number of request messages is - calculated. - type: object - id: GoogleCloudApigeeV1ApiProduct - GoogleCloudApigeeV1ReferenceConfig: - id: GoogleCloudApigeeV1ReferenceConfig - properties: + Time when the API product subscription starts in milliseconds since + epoch. name: type: string + description: Output only. Name of the API product subscription. + readOnly: true + endTime: + format: int64 description: >- - Name of the reference in the following format: - `organizations/{org}/environments/{env}/references/{reference}` - resourceName: + Time when the API product subscription ends in milliseconds since + epoch. type: string - description: >- - Name of the referenced resource in the following format: - `organizations/{org}/environments/{env}/keystores/{keystore}` Only - references to keystore resources are supported. - type: object - GoogleCloudApigeeV1ProfileConfigMediation: - properties: {} - description: >- - By default, following policies will be included: - OASValidation - - SOAPMessageValidation - id: GoogleCloudApigeeV1ProfileConfigMediation type: object - GoogleCloudApigeeV1AppGroup: - id: GoogleCloudApigeeV1AppGroup + id: GoogleCloudApigeeV1DeveloperSubscription + description: Structure of a DeveloperSubscription. + GoogleCloudApigeeV1SecurityIncident: + id: GoogleCloudApigeeV1SecurityIncident type: object - description: >- - AppGroup contains the request/response fields representing the logical - grouping of apps. Note that appgroup_id, create_time and update_time - cannot be changed by the user, and gets updated by the system. The name - and the organization once provided cannot be edited subsequently. properties: - attributes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: A list of attributes - lastModifiedAt: - description: Output only. Modified time as milliseconds since epoch. - readOnly: true - format: int64 - type: string - organization: - description: Immutable. the org the app group is created - type: string - appGroupId: - description: Output only. Internal identifier that cannot be edited - readOnly: true - type: string - channelUri: + observability: + enum: + - OBSERVABILITY_UNSPECIFIED + - ACTIVE + - ARCHIVED type: string - description: A reference to the associated storefront/marketplace. - name: + enumDescriptions: + - The incident observability is unspecified. + - >- + The incident is currently active. Can change to this status from + archived. + - >- + The incident is currently archived and was archived by the + customer. + description: Optional. Indicates if the user archived this incident. + lastObservabilityChangeTime: + format: google-datetime description: >- - Immutable. Name of the AppGroup. Characters you can use in the name - are restricted to: A-Z0-9._\-$ %. - type: string - channelId: + Output only. The time when the incident observability was last + changed. + readOnly: true type: string - description: channel identifier identifies the owner maintaing this grouping. displayName: type: string - description: app group name displayed in the UI - status: - type: string + description: Optional. Display name of the security incident. + firstDetectedTime: + format: google-datetime + readOnly: true description: >- - Valid values are `active` or `inactive`. Note that the status of the - AppGroup should be updated via UpdateAppGroupRequest by setting the - action as `active` or `inactive`. - createdAt: - description: Output only. Created time as milliseconds since epoch. + Output only. The time when events associated with the incident were + first detected. type: string + riskLevel: readOnly: true - format: int64 - GoogleCloudApigeeV1ApiDocDocumentation: - type: object - id: GoogleCloudApigeeV1ApiDocDocumentation - properties: - graphqlDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1GraphqlDocumentation' - description: Optional. GraphQL documentation. - oasDocumentation: - $ref: '#/components/schemas/GoogleCloudApigeeV1OASDocumentation' - description: Optional. OpenAPI Specification documentation. - description: The documentation for a catalog item. - GoogleCloudApigeeV1AppGroupAppKey: - description: >- - AppGroupAppKey contains all the information associated with the - credentials. - id: GoogleCloudApigeeV1AppGroupAppKey - type: object - properties: - attributes: - type: array - description: List of attributes associated with the credential. + description: Output only. Risk level of the incident. + enum: + - RISK_LEVEL_UNSPECIFIED + - LOW + - MODERATE + - SEVERE + enumDescriptions: + - Risk Level Unspecified. + - Risk level of the incident is low. + - Risk level of the incident is moderate. + - Risk level of the incident is severe. + type: string + detectionTypes: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - status: + type: string + type: array description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - type: string - issuedAt: + Output only. Detection types which are part of the incident. + Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly + Detection. readOnly: true + lastDetectedTime: + format: google-datetime description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. + Output only. The time when events associated with the incident were + last detected. type: string - format: int64 - expiresInSeconds: + readOnly: true + name: type: string - format: int64 description: >- - Immutable. Expiration time, in seconds, for the consumer key. If not - set or left to the default value of `-1`, the API key never expires. - The expiration time can't be updated after it is set. - consumerKey: - description: Immutable. Consumer key. + Immutable. Name of the security incident resource. Format: + organizations/{org}/environments/{environment}/securityIncidents/{incident} + Example: + organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 + trafficCount: + type: string + description: Total traffic detected as part of the incident. + format: int64 + description: Represents an SecurityIncident resource. + GoogleCloudApigeeV1App: + id: GoogleCloudApigeeV1App + type: object + properties: + developerEmail: type: string + description: Email of the developer. scopes: description: >- Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. + exist on the API product that you associate with the app. + type: array items: type: string + appGroup: + type: string + description: Name of the AppGroup + appId: + description: ID of the app. + type: string + developerId: + description: ID of the developer. + type: string + lastModifiedAt: + description: Output only. Last modified time as milliseconds since epoch. + type: string + readOnly: true + format: int64 + name: + description: Name of the app. + type: string + credentials: type: array - apiProducts: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' description: >- - Output only. List of API products and its status for which the - credential can be used. **Note**: Use - UpdateAppGroupAppKeyApiProductRequest API to make the association - after the consumer key and secret are created. + Output only. Set of credentials for the app. Credentials are API + key/secret pairs associated with API products. + readOnly: true + companyName: + type: string + description: Name of the company that owns the app. + callbackUrl: + type: string + description: >- + Callback URL used by OAuth 2.0 authorization servers to communicate + authorization codes back to apps. + createdAt: + format: int64 readOnly: true + type: string + description: Output only. Unix time when the app was created. + status: + description: Status of the credential. + type: string + apiProducts: + description: List of API products associated with the app. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1APIProductAssociation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' type: array - expiresAt: - readOnly: true + keyExpiresIn: format: int64 type: string description: >- - Output only. Time the AppGroup app expires in milliseconds since - epoch. - consumerSecret: - type: string - description: Secret key. - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse: + Duration, in milliseconds, of the consumer key that will be + generated for the app. The default value, -1, indicates an infinite + validity period. Once set, the expiration can't be updated. json + key: keyExpiresIn + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + type: array + description: List of attributes. + EdgeConfigstoreBundleBadBundle: type: object + id: EdgeConfigstoreBundleBadBundle properties: - securityAssessmentResults: - description: Default sort order is by resource name in alphabetic order. + violations: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResult' + $ref: '#/components/schemas/EdgeConfigstoreBundleBadBundleViolation' + description: Describes all precondition violations. type: array - nextPageToken: + description: Describes why a bundle is invalid. Intended for use in error details. + GoogleCloudApigeeV1ConfigVersion: + id: GoogleCloudApigeeV1ConfigVersion + properties: + minorVersion: + type: integer + description: Minor version of the API proxy configuration schema. + format: int32 + majorVersion: + type: integer + format: int32 + description: Major version of the API proxy configuration schema. + type: object + description: >- + Version of the API proxy configuration schema. Currently, only 4.0 is + supported. + GoogleCloudApigeeV1ApiProductRef: + id: GoogleCloudApigeeV1ApiProductRef + properties: + status: + description: Status of the API product. Valid values are `approved` or `revoked`. type: string - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is blank, there are no subsequent pages. - assessmentTime: - description: The time of the assessment api call. + apiproduct: type: string - format: google-datetime - id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse - description: Response for BatchComputeSecurityAssessmentResults. - GoogleCloudApigeeV1DeleteCustomReportResponse: - id: GoogleCloudApigeeV1DeleteCustomReportResponse + description: Name of the API product. + type: object + GoogleCloudApigeeV1AdvancedApiOpsConfig: + description: Configuration for the Advanced API Ops add-on. + id: GoogleCloudApigeeV1AdvancedApiOpsConfig type: object properties: - message: - type: string - description: The response contains only a message field. - GoogleRpcStatus: + enabled: + description: Flag that specifies whether the Advanced API Ops add-on is enabled. + type: boolean + GoogleCloudApigeeV1DeploymentGroupConfig: properties: - details: + deploymentGroupType: + type: string + enumDescriptions: + - Unspecified type + - Standard type + - Extensible Type description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - message: + Type of the deployment group, which will be either Standard or + Extensible. + enum: + - DEPLOYMENT_GROUP_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + uid: + description: >- + Unique ID. The ID will only change if the deployment group is + deleted and recreated. + type: string + name: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 + Name of the deployment group in the following format: + `organizations/{org}/environments/{env}/deploymentGroups/{group}`. + revisionId: + type: string + description: >- + Revision number which can be used by the runtime to detect if the + deployment group has changed between two versions. + format: int64 description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus + DeploymentGroupConfig represents a deployment group that should be + present in a particular environment. + id: GoogleCloudApigeeV1DeploymentGroupConfig type: object - GoogleCloudApigeeV1ScoreComponentRecommendationAction: - id: GoogleCloudApigeeV1ScoreComponentRecommendationAction - description: Action to improve security score. + GoogleCloudApigeeV1ListAppGroupsResponse: properties: - description: - description: Description of the action. + appGroups: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + description: List of AppGroups. + nextPageToken: type: string - actionContext: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ScoreComponentRecommendationActionActionContext - description: Action context for the action. + description: >- + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + totalSize: + description: Total count of AppGroups. + format: int32 + type: integer + id: GoogleCloudApigeeV1ListAppGroupsResponse + description: >- + ListAppGroupsResponse contains the 0 or more AppGroups, along with the + optional page token and the total count of apps. type: object - GoogleCloudApigeeV1ListSecurityIncidentsResponse: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse type: object properties: - securityIncidents: - description: List of security incidents in the organization + operations: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: >- + A list of operations that matches the specified filter in the + request. type: array nextPageToken: type: string - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - description: Response for ListSecurityIncidents. - id: GoogleCloudApigeeV1ListSecurityIncidentsResponse - GoogleCloudApigeeV1AsyncQueryResult: + description: The standard List next-page token. + description: The response message for Operations.ListOperations. + GoogleCloudApigeeV1PodStatus: + type: object properties: - self: + deploymentStatus: type: string description: >- - Self link of the query results. Example: - `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - or following format if query is running at host level: - `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` - expires: - description: Query result will be unaccessable after this time. + Status of the deployment. Valid values include: - `deployed`: + Successful. - `error` : Failed. - `pending` : Pod has not yet + reported on the deployment. + podStatus: type: string - id: GoogleCloudApigeeV1AsyncQueryResult - type: object - GoogleCloudApigeeV1ExportRequest: - type: object - description: Request body for [CreateExportRequest] - id: GoogleCloudApigeeV1ExportRequest - properties: - csvDelimiter: description: >- - Optional. Delimiter used in the CSV file, if `outputFormat` is set - to `csv`. Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). + Overall status of the pod (not this specific deployment). Valid + values include: - `active`: Up to date. - `stale` : Recently out of + date. Pods that have not reported status in a long time are excluded + from the output. + deploymentTime: type: string - outputFormat: + description: Time the proxy was deployed in milliseconds since epoch. + format: int64 + deploymentStatusTime: + type: string + format: int64 + description: Time the deployment status was reported in milliseconds since epoch. + podStatusTime: + description: Time the pod status was reported in milliseconds since epoch. + format: int64 + type: string + statusCode: + type: string + description: Code associated with the deployment status. + appVersion: + type: string + description: Version of the application running in the pod. + podName: + type: string + description: Name of the pod which is reporting the status. + statusCodeDetails: type: string + description: Human-readable message associated with the status code. + id: GoogleCloudApigeeV1PodStatus + GoogleCloudApigeeV1SchemaSchemaElement: + id: GoogleCloudApigeeV1SchemaSchemaElement + type: object + description: Message type for the schema element + properties: + properties: description: >- - Optional. Output format of the export. Valid values include: `csv` - or `json`. Defaults to `json`. Note: Configure the delimiter for CSV - output using the `csvDelimiter` property. - datastoreName: + Properties for the schema field. For example: { "createTime": + "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' + name: + description: Name of the field. + type: string + GoogleCloudApigeeV1CustomReportMetric: + description: >- + This encapsulates a metric property of the form sum(message_count) where + name is message_count and function is sum + id: GoogleCloudApigeeV1CustomReportMetric + type: object + properties: + function: type: string - description: Required. Name of the preconfigured datastore. + description: aggregate function name: - description: Required. Display name of the export job. - type: string - dateRange: - description: Required. Date range of the data to export. - $ref: '#/components/schemas/GoogleCloudApigeeV1DateRange' - description: - description: Optional. Description of the export job. type: string - GoogleCloudApigeeV1CreditDeveloperBalanceRequest: - id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest - type: object + description: name of the metric + GoogleCloudApigeeV1DeveloperBalanceWallet: properties: - transactionAmount: + balance: $ref: '#/components/schemas/GoogleTypeMoney' description: >- - The amount of money to be credited. The wallet corresponding to the - currency specified within `transaction_amount` will be updated. For - example, if you specified `currency_code` within - `transaction_amount` as "USD", then the amount would be added to the - wallet which has the "USD" currency or if no such wallet exists, a - new wallet will be created with the "USD" currency. - transactionId: - description: >- - Each transaction_id uniquely identifies a credit balance request. If - multiple requests are received with the same transaction_id, only - one of them will be considered. + Current remaining balance of the developer for a particular + currency. + lastCreditTime: + readOnly: true type: string - description: Request for CreditDeveloperBalance. - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse: - description: The response for GetAsyncQueryResultUrl - type: object - properties: - urls: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - description: The list of Signed URLs generated by the CreateAsyncQuery request - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse - GoogleCloudApigeeV1AdjustDeveloperBalanceRequest: - id: GoogleCloudApigeeV1AdjustDeveloperBalanceRequest - description: Request for AdjustDeveloperBalance. - properties: - adjustment: + format: int64 description: >- - * A positive value of `adjustment` means that that the API provider - wants to adjust the balance for an under-charged developer i.e. the - balance of the developer will decrease. * A negative value of - `adjustment` means that that the API provider wants to adjust the - balance for an over-charged developer i.e. the balance of the - developer will increase. - $ref: '#/components/schemas/GoogleTypeMoney' + Output only. Time at which the developer last added credit to the + account in milliseconds since epoch. + description: Wallet used to manage an account balance for a particular currency. + id: GoogleCloudApigeeV1DeveloperBalanceWallet type: object - GoogleCloudApigeeV1OperationGroup: + GoogleCloudApigeeV1Deployment: type: object - description: >- - List of operation configuration details associated with Apigee API - proxies or remote services. Remote services are non-Apigee proxies, such - as Istio-Envoy. properties: - operationConfigs: + apiProxy: + description: API proxy. + type: string + proxyDeploymentType: + readOnly: true + enum: + - PROXY_DEPLOYMENT_TYPE_UNSPECIFIED + - STANDARD + - EXTENSIBLE + enumDescriptions: + - >- + Default value till public preview. After public preview this value + should not be returned. + - >- + Deployment will be of type Standard if only Standard proxies are + used + - >- + Proxy will be of type Extensible if deployments uses one or more + Extensible proxies + type: string + description: >- + Output only. The type of the deployment (standard or extensible) + Deployed proxy revision will be marked as extensible in following 2 + cases. 1. The deployed proxy revision uses extensible policies. 2. + If a environment supports flowhooks and flow hook is configured. + pods: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1OperationConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1PodStatus' type: array description: >- - Required. List of operation configurations for either Apigee API - proxies or other remote services that are associated with this API - product. - operationConfigType: + Status reported by runtime pods. **Note**: **This field is + deprecated**. Runtime versions 1.3 and above report instance level + status rather than pod status. + deployStartTime: + format: int64 type: string description: >- - Flag that specifes whether the configuration is for Apigee API proxy - or a remote service. Valid values include `proxy` or - `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API - proxies are associated with the API product. Set to `remoteservice` - when non-Apigee proxies like Istio-Envoy are associated with the API - product. - id: GoogleCloudApigeeV1OperationGroup - GoogleCloudApigeeV1ComputeEnvironmentScoresRequest: - description: Request for ComputeEnvironmentScores. - properties: - pageSize: - format: int32 - type: integer - description: >- - Optional. The maximum number of subcomponents to be returned in a - single page. The service may return fewer than this value. If - unspecified, at most 100 subcomponents will be returned in a single - page. - pageToken: + Time the API proxy was marked `deployed` in the control plane in + millisconds since epoch. + environment: + type: string + description: Environment. + errors: + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Optional. A token that can be sent as `page_token` to retrieve the - next page. If this field is omitted, there are no subsequent pages. + Errors reported for this deployment. Populated only when state == + ERROR. **Note**: This field is displayed only when viewing + deployment status. + revision: type: string - timeRange: + description: API proxy revision. + instances: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatus' description: >- - Required. Time range for score calculation. At most 14 days of - scores will be returned, and both the start and end dates must be - within the last 90 days. - $ref: '#/components/schemas/GoogleTypeInterval' - filters: + Status reported by each runtime instance. **Note**: This field is + displayed only when viewing deployment status. type: array + serviceAccount: + type: string + description: >- + The full resource name of Cloud IAM Service Account that this + deployment is using, eg, `projects/-/serviceAccounts/{email}`. + state: + type: string + enumDescriptions: + - This value should never be returned. + - Runtime has loaded the deployment. + - Deployment is not fully ready in the runtime. + - >- + Encountered an error with the deployment that requires + intervention. + enum: + - RUNTIME_STATE_UNSPECIFIED + - READY + - PROGRESSING + - ERROR + description: >- + Current state of the deployment. **Note**: This field is displayed + only when viewing deployment status. + routeConflicts: items: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequestFilter + #/components/schemas/GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict description: >- - Optional. Filters are used to filter scored components. Return all - the components if no filter is mentioned. Example: [{ "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - }, { "scorePath": - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target", - }] This will return components with path: - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/source" - OR - "/org@myorg/envgroup@myenvgroup/env@myenv/proxies/proxy@myproxy/target" - type: object - id: GoogleCloudApigeeV1ComputeEnvironmentScoresRequest - GoogleCloudApigeeV1App: - id: GoogleCloudApigeeV1App + Conflicts in the desired state routing configuration. The presence + of conflicts does not cause the state to be `ERROR`, but it will + mean that some of the deployment's base paths are not routed to its + environment. If the conflicts change, the state will transition to + `PROGRESSING` until the latest configuration is rolled out to all + instances. **Note**: This field is displayed only when viewing + deployment status. + type: array + id: GoogleCloudApigeeV1Deployment + GoogleCloudApigeeV1TraceConfigOverride: + id: GoogleCloudApigeeV1TraceConfigOverride type: object + description: A representation of a configuration override. properties: - lastModifiedAt: - description: Output only. Last modified time as milliseconds since epoch. - type: string - format: int64 - readOnly: true - keyExpiresIn: - format: int64 + name: type: string description: >- - Duration, in milliseconds, of the consumer key that will be - generated for the app. The default value, -1, indicates an infinite - validity period. Once set, the expiration can't be updated. json - key: keyExpiresIn - developerEmail: + ID of the trace configuration override specified as a + system-generated UUID. + samplingConfig: + description: Trace configuration to override. + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + apiProxy: + description: >- + ID of the API proxy that will have its trace configuration + overridden. type: string - description: Email of the developer. - companyName: + GoogleCloudApigeeV1OperationConfig: + properties: + operations: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Operation' + type: array + description: >- + List of resource/method pairs for the API proxy or remote service to + which quota will applied. **Note**: Currently, you can specify only + a single resource/method pair. The call will fail if more than one + resource/method pair is provided. + apiSource: type: string - description: Name of the company that owns the app. - callbackUrl: + description: >- + Required. Name of the API proxy or remote service with which the + resources, methods, and quota are associated. + attributes: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: Custom attributes associated with the operation. + type: array + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + description: >- + Quota parameters to be enforced for the resources, methods, and API + source combination. If none are specified, quota enforcement will + not be done. + description: >- + Binds the resources in an API proxy or remote service with the allowed + REST methods and associated quota enforcement. + id: GoogleCloudApigeeV1OperationConfig + type: object + GoogleRpcPreconditionFailureViolation: + type: object + properties: + description: type: string description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to apps. - appGroup: - type: string - description: Name of the AppGroup - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes. - type: array - apiProducts: - description: List of API products associated with the app. - type: array - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' - name: + A description of how the precondition failed. Developers can use + this description to understand how to fix the failure. For example: + "Terms of service not accepted". + subject: type: string - description: Name of the app. - appId: - description: ID of the app. + description: >- + The subject, relative to the type, that failed. For example, + "google.com/cloud" relative to the "TOS" type would indicate which + terms of service is being referenced. + type: + description: >- + The type of PreconditionFailure. We recommend using a + service-specific enum type to define the supported precondition + violation subjects. For example, "TOS" for "Terms of Service + violation". type: string - credentials: - type: array - readOnly: true - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' + id: GoogleRpcPreconditionFailureViolation + description: A message type used to describe a single precondition failure. + GoogleCloudApigeeV1CreditDeveloperBalanceRequest: + id: GoogleCloudApigeeV1CreditDeveloperBalanceRequest + description: Request for CreditDeveloperBalance. + properties: + transactionAmount: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Output only. Set of credentials for the app. Credentials are API - key/secret pairs associated with API products. - developerId: + The amount of money to be credited. The wallet corresponding to the + currency specified within `transaction_amount` will be updated. For + example, if you specified `currency_code` within + `transaction_amount` as "USD", then the amount would be added to the + wallet which has the "USD" currency or if no such wallet exists, a + new wallet will be created with the "USD" currency. + transactionId: type: string - description: ID of the developer. - createdAt: - format: int64 + description: >- + Each transaction_id uniquely identifies a credit balance request. If + multiple requests are received with the same transaction_id, only + one of them will be considered. + type: object + GoogleCloudApigeeV1ListKeyValueEntriesResponse: + description: >- + The request structure for listing key value map keys and its + corresponding values. + id: GoogleCloudApigeeV1ListKeyValueEntriesResponse + type: object + properties: + nextPageToken: type: string - description: Output only. Unix time when the app was created. - readOnly: true - scopes: - items: - type: string description: >- - Scopes to apply to the app. The specified scope names must already - exist on the API product that you associate with the app. + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + keyValueEntries: type: array - status: - description: Status of the credential. - type: string - GoogleCloudApigeeV1ListArchiveDeploymentsResponse: - type: object + description: One or more key value map keys and values. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: properties: - archiveDeployments: + metrics: + description: Required. List of metrics and their aggregations. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' type: array - description: Archive Deployments in the specified environment. - nextPageToken: + filter: type: string description: >- - Page token that you can include in a ListArchiveDeployments request - to retrieve the next page. If omitted, no subsequent pages exist. - id: GoogleCloudApigeeV1ListArchiveDeploymentsResponse - description: Response for ListArchiveDeployments method. - GoogleCloudApigeeV1RuntimeAddonsConfig: - description: >- - RuntimeAddonsConfig defines the runtime configurations for add-ons in an - environment. - properties: - name: + Filter further on specific dimension values. Follows the same + grammar as custom report's filter expressions. Example, apiproxy eq + 'foobar'. + https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters + timestampOrder: + enum: + - ORDER_UNSPECIFIED + - ASCENDING + - DESCENDING + enumDescriptions: + - Unspecified order. Default is Descending. + - Ascending sort order. + - Descending sort order. description: >- - Name of the addons config in the format: - `organizations/{org}/environments/{env}/addonsConfig` + Order the sequences in increasing or decreasing order of timestamps. + Default is descending order of timestamps (latest first). type: string - uid: + pageSize: + format: int32 + type: integer description: >- - UID is to detect if config is recreated after deletion. The add-on - config will only be deleted when the environment itself gets - deleted, thus it will always be the same as the UID of - EnvironmentConfig. + Page size represents the number of time series sequences, one per + unique set of dimensions and their values. + windowSize: type: string - revisionId: - description: Revision number used by the runtime to detect config changes. + description: Time buckets to group the stats by. + enumDescriptions: + - Unspecified window size. Default is 1 hour. + - 1 Minute window + - 1 Hour window + - 1 Day window + - 1 Month window + enum: + - WINDOW_SIZE_UNSPECIFIED + - MINUTE + - HOUR + - DAY + - MONTH + timeRange: + description: Required. Time range for the stats. + $ref: '#/components/schemas/GoogleTypeInterval' + dimensions: + type: array + items: + type: string + description: >- + List of dimension names to group the aggregations by. If no + dimensions are passed, a single trend line representing the + requested metric aggregations grouped by environment is returned. + pageToken: type: string - analyticsConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAnalyticsConfig' - description: Runtime configuration for Analytics add-on. - apiSecurityConfig: - description: Runtime configuration for API Security add-on. - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeApiSecurityConfig' + description: >- + Page token stands for a specific collection of time series + sequences. + id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + description: >- + QueryTimeSeriesStatsRequest represents a query that returns a collection + of time series sequences grouped by their values. type: object - id: GoogleCloudApigeeV1RuntimeAddonsConfig - GoogleCloudApigeeV1ServiceIssuersMapping: + GoogleIamV1AuditLogConfig: + type: object + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + id: GoogleIamV1AuditLogConfig properties: - emailIds: + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. type: array items: type: string - description: List of trusted issuer email ids. - service: + logType: + description: The log type that this config enables. + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' type: string - description: String indicating the Apigee service name. - id: GoogleCloudApigeeV1ServiceIssuersMapping - type: object - GoogleTypeMoney: + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + GoogleCloudApigeeV1ProvisionOrganizationRequest: type: object - description: Represents an amount of money with its currency type. + id: GoogleCloudApigeeV1ProvisionOrganizationRequest + description: Request for ProvisionOrganization. properties: - currencyCode: - description: The three-letter currency code defined in ISO 4217. + authorizedNetwork: type: string - nanos: - format: int32 - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - units: description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 - type: string - id: GoogleTypeMoney - GoogleCloudApigeeV1RuntimeConfig: - id: GoogleCloudApigeeV1RuntimeConfig - properties: - name: + Compute Engine network used for Service Networking to be peered with + Apigee runtime instances. See [Getting started with the Service + Networking + API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). + Apigee also supports shared VPC (that is, the host network project + is not the same as the one that is peering with Apigee). See [Shared + VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use + a shared VPC network, use the following format: + `projects/{host-project-id}/{region}/networks/{network-name}`. For + example: `projects/my-sharedvpc-host/global/networks/mynetwork` + analyticsRegion: description: >- - Name of the resource in the following format: - `organizations/{org}/runtimeConfig`. + Primary Cloud Platform region for analytics data storage. For valid + values, see [Create an + organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). + Defaults to `us-west1`. type: string - tenantProjectId: + runtimeLocation: description: >- - Output only. Tenant project ID associated with the Apigee - organization. The tenant project is used to host Google-managed - resources that are dedicated to this Apigee organization. Clients - have limited access to resources within the tenant project used to - support Apigee runtime instances. Access to the tenant project is - managed using SetSyncAuthorization. It can be empty if the tenant - project hasn't been created yet. - readOnly: true - type: string - analyticsBucket: - type: string - description: Cloud Storage bucket used for uploading Analytics records. - traceBucket: - description: Cloud Storage bucket used for uploading Trace records. + Cloud Platform location for the runtime instance. Defaults to zone + `us-west1-a`. If a region is provided, `EVAL` organizations will use + the region for automatically selecting a zone for the runtime + instance. type: string + disableVpcPeering: + type: boolean + description: >- + Optional. Flag that specifies whether the VPC Peering through + Private Google Access should be disabled between the consumer + network and Apigee. Required if an authorizedNetwork on the consumer + project is not provided, in which case the flag should be set to + true. The value must be set before the creation of any Apigee + runtime instance and can be updated only when there are no runtime + instances. **Note:** Apigee will be deprecating the vpc peering + model that requires you to provide 'authorizedNetwork', by making + the non-peering model as the default way of provisioning Apigee + organization in future. So, this will be a temporary flag to enable + the transition. Not supported for Apigee hybrid. + GoogleCloudApigeeV1AccessLoggingConfig: + id: GoogleCloudApigeeV1AccessLoggingConfig description: >- - Runtime configuration for the organization. Response for - GetRuntimeConfig. - type: object - GoogleCloudApigeeV1DebugSession: + Access logging configuration enables customers to ship the access logs + from the tenant projects to their own project's cloud logging. The + feature is at the instance level ad disabled by default. It can be + enabled during CreateInstance or UpdateInstance. type: object properties: - validity: - type: integer - description: >- - Optional. The length of time, in seconds, that this debug session is - valid, starting from when it's received in the control plane. Min = - 1, Max = 15, Default = 10. - format: int32 - tracesize: - format: int32 - type: integer - description: >- - Optional. The maximum number of bytes captured from the response - payload. Min = 0, Max = 5120, Default = 5120. - count: - type: integer - format: int32 - description: >- - Optional. The number of request to be traced. Min = 1, Max = 15, - Default = 10. - createTime: - readOnly: true + enabled: description: >- - Output only. The first transaction creation timestamp, recorded by - UAP. - format: google-datetime - type: string - name: - description: A unique ID for this DebugSession. - type: string + Optional. Boolean flag that specifies whether the customer access + log feature is enabled. + type: boolean filter: description: >- - Optional. A conditional statement which is evaluated against the - request message to determine if it should be traced. Syntax matches - that of on API Proxy bundle flow Condition. + Optional. Ship the access log entries that match the status_code + defined in the filter. The status_code is the only + expected/supported filter field. (Ex: status_code) The filter will + parse it to the Common Expression Language semantics for expression + evaluation to build the filter condition. (Ex: "filter": status_code + >= 200 && status_code < 300 ) type: string - timeout: + GoogleCloudApigeeV1RateRange: + id: GoogleCloudApigeeV1RateRange + type: object + description: >- + API call volume range and the fees charged when the total number of API + calls is within the range. + properties: + end: + description: >- + Ending value of the range. Set to 0 or `null` for the last range of + values. + format: int64 type: string + fee: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Optional. The time in seconds after which this DebugSession should - end. This value will override the value in query param, if both are - provided. + Fee to charge when total number of API calls falls within this + range. + start: + description: >- + Starting value of the range. Set to 0 or `null` for the initial + range of values. format: int64 - id: GoogleCloudApigeeV1DebugSession - GoogleCloudApigeeV1ActivateNatAddressRequest: - id: GoogleCloudApigeeV1ActivateNatAddressRequest - properties: {} - description: Request for ActivateNatAddressRequest. Activate the nat address request. - type: object - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll: - properties: {} - type: object - id: >- - GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll - description: Message for include_all option. - GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation: + type: string + GoogleCloudApigeeV1APIProductAssociation: + id: GoogleCloudApigeeV1APIProductAssociation type: object - description: Represents a SecurityProfileEnvironmentAssociation resource. + description: >- + APIProductAssociation has the API product and its administrative state + association. properties: - attachTime: - format: google-datetime + status: description: >- - Output only. The time when environment was attached to the security - profile. - type: string - readOnly: true - name: + The API product credential associated status. Valid values are + `approved` or `revoked`. type: string - description: Immutable. Name of the environment that the profile is attached to. - securityProfileRevisionId: - description: 'DEPRECATED: DO NOT USE Revision ID of the security profile.' + apiproduct: type: string - format: int64 - deprecated: true - id: GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation - GoogleCloudApigeeV1GenerateUploadUrlResponse: + description: API product to be associated with the credential. + GoogleCloudApigeeV1Quota: type: object - id: GoogleCloudApigeeV1GenerateUploadUrlResponse - properties: - uploadUri: - type: string - description: >- - The Google Cloud Storage signed URL that can be used to upload a new - Archive zip file. - description: Response for GenerateUploadUrl method. - GoogleCloudApigeeV1SecurityAssessmentResult: - description: The security assessment result for one resource. properties: - createTime: + interval: description: >- - The time of the assessment of this resource. This could lag behind - `assessment_time` due to caching within the backend. + Required. Time interval over which the number of request messages is + calculated. type: string - format: google-datetime - error: - description: The error status if scoring fails. - $ref: '#/components/schemas/GoogleRpcStatus' - scoringResult: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResult - description: The result of the assessment. - resource: - description: The assessed resource. - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultResource - type: object - id: GoogleCloudApigeeV1SecurityAssessmentResult - GoogleCloudApigeeV1ApiCategory: - properties: - name: + limit: type: string - description: Name of the category. - id: + description: >- + Required. Upper limit allowed for the time interval and time unit + specified. Requests exceeding this limit will be rejected. + timeUnit: type: string - description: ID of the category (a UUID). - updateTime: - description: Time the category was last modified in milliseconds since epoch. - format: int64 + description: >- + Time unit defined for the `interval`. Valid values include `minute`, + `hour`, `day`, or `month`. If `limit` and `interval` are valid, the + default value is `hour`; otherwise, the default is null. + description: >- + Quota contains the essential parameters needed that can be applied on + the resources, methods, API source combination associated with this API + product. While Quota is optional, setting it prevents requests from + exceeding the provisioned parameters. + id: GoogleCloudApigeeV1Quota + GoogleCloudApigeeV1TraceConfig: + properties: + exporter: type: string - siteId: + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + description: >- + Required. Exporter that is used to view the distributed trace + captured using OpenCensus. An exporter sends traces to any backend + that is capable of consuming them. Recorded spans can be exported by + registered exporters. + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceSamplingConfig' + description: >- + Distributed trace configuration for all API proxies in an + environment. You can also override the configuration for a specific + API proxy using the distributed trace configuration overrides API. + endpoint: + description: Required. Endpoint of the exporter. type: string - description: Name of the portal. type: object + id: GoogleCloudApigeeV1TraceConfig description: >- - `ApiCategory` represents an API category. [Catalog - items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) - can be tagged with API categories; users viewing the API catalog in the - portal will have the option to browse the catalog by category. - id: GoogleCloudApigeeV1ApiCategory - GoogleCloudApigeeV1DeploymentConfig: + TraceConfig defines the configurations in an environment of distributed + trace. + GoogleCloudApigeeV1RuntimeTraceConfig: type: object - properties: - endpoints: - additionalProperties: - type: string - type: object - description: >- - A mapping from basepaths to proxy endpoint names in this proxy. Not - populated for shared flows. - location: + id: GoogleCloudApigeeV1RuntimeTraceConfig + description: >- + NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed + trace in an environment. + properties: + endpoint: type: string - description: Location of the API proxy bundle as a URI. - deploymentGroups: - description: >- - The list of deployment groups in which this proxy should be - deployed. Not currently populated for shared flows. + description: Endpoint of the exporter. + revisionCreateTime: + type: string + format: google-datetime + description: The timestamp that the revision was created or updated. + samplingConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceSamplingConfig' + description: Trace configuration for all API proxies in an environment. + overrides: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfigOverride' type: array - uid: - description: >- - Unique ID. The ID will only change if the deployment is deleted and - recreated. - type: string - serviceAccount: + description: List of trace configuration overrides for spicific API proxies. + name: type: string description: >- - The service account identity associated with this deployment. If - non-empty, will be in the following format: - `projects/-/serviceAccounts/{account_email}` - attributes: - type: object - additionalProperties: - type: string - description: Additional key-value metadata for the deployment. - proxyUid: - description: Unique ID of the API proxy revision. - type: string - basePath: - description: Base path where the application will be hosted. Defaults to "/". + Name of the trace config in the following format: + `organizations/{org}/environment/{env}/traceConfig` + revisionId: + description: >- + Revision number which can be used by the runtime to detect if the + trace config has changed between two versions. type: string - name: + exporter: description: >- - Name of the API or shared flow revision to be deployed in the - following format: `organizations/{org}/apis/{api}/revisions/{rev}` - or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` + Exporter that is used to view the distributed trace captured using + OpenCensus. An exporter sends traces to any backend that is capable + of consuming them. Recorded spans can be exported by registered + exporters. + enumDescriptions: + - Exporter unspecified + - Jaeger exporter + - Cloudtrace exporter + enum: + - EXPORTER_UNSPECIFIED + - JAEGER + - CLOUD_TRACE type: string - id: GoogleCloudApigeeV1DeploymentConfig - description: 'NEXT ID: 11' - GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest: + GoogleCloudApigeeV1SetAddonEnablementRequest: + description: Request for SetAddonEnablement. properties: - requests: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateSecurityIncidentRequest - description: >- - Optional. Required. The request message specifying the resources to - update. A maximum of 1000 can be modified in a batch. + analyticsEnabled: + type: boolean + description: If the Analytics should be enabled in the environment. + apiSecurityEnabled: + type: boolean + description: If the API Security should be enabled in the environment. type: object - description: Request for BatchUpdateSecurityIncident. - id: GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest - GoogleCloudApigeeV1SecurityProfileEnvironment: - id: GoogleCloudApigeeV1SecurityProfileEnvironment + id: GoogleCloudApigeeV1SetAddonEnablementRequest + GoogleCloudApigeeV1Stats: + description: Encapsulates a `stats` response. type: object - description: >- - Environment information of attached environments. Scoring an environment - is enabled only if it is attached to a security profile. properties: - attachTime: - readOnly: true - type: string - format: google-datetime + environments: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsEnvironmentStats' + type: array + description: List of query results on the environment level. + metaData: + description: Metadata information. + $ref: '#/components/schemas/GoogleCloudApigeeV1Metadata' + hosts: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1StatsHostStats' + description: List of query results grouped by host. + type: array + id: GoogleCloudApigeeV1Stats + GoogleCloudApigeeV1TargetServer: + properties: + sSLInfo: + $ref: '#/components/schemas/GoogleCloudApigeeV1TlsInfo' description: >- - Output only. Time at which environment was attached to the security - profile. - environment: - readOnly: true - description: Output only. Name of the environment. + Optional. Specifies TLS configuration info for this TargetServer. + The JSON name is `sSLInfo` for legacy/backwards compatibility + reasons -- Edge originally supported SSL, and the name is still used + for TLS configuration. + host: type: string - GoogleCloudApigeeV1RevisionStatus: - properties: - revisionId: - description: The revision of the resource. + description: >- + Required. The host name this target connects to. Value must be a + valid hostname as described by RFC-1123. + name: type: string - replicas: + description: >- + Required. The resource id of this target server. Values must match + the regular expression + isEnabled: + type: boolean + description: >- + Optional. Enabling/disabling a TargetServer is useful when + TargetServers are used in load balancing configurations, and one or + more TargetServers need to taken out of rotation periodically. + Defaults to true. + port: type: integer - description: The number of replicas that have successfully loaded this revision. format: int32 - errors: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1UpdateError' - description: Errors reported when attempting to load this revision. - type: array - jsonSpec: - type: string description: >- - The json content of the resource revision. Large specs should be - sent individually via the spec field to avoid hitting request size - limits. - type: object - id: GoogleCloudApigeeV1RevisionStatus - description: The status of a specific resource revision. - GoogleCloudApigeeV1Environment: - properties: - type: + Required. The port number this target connects to on the given host. + Value must be between 1 and 65535, inclusive. + description: type: string - enum: - - ENVIRONMENT_TYPE_UNSPECIFIED - - BASE - - INTERMEDIATE - - COMPREHENSIVE - description: Optional. EnvironmentType selected for the environment. + description: Optional. A human-readable description of this TargetServer. + protocol: + description: Immutable. The protocol used by this TargetServer. enumDescriptions: - - Environment type not specified. - - >- - This is the default type. Base environment has limited capacity - and capabilities and are usually used when you are getting started - with Apigee or while experimenting. Refer to Apigee's public - documentation for more details. - - >- - Intermediate environment supports API management features and - higher capacity than Base environment. Refer to Apigee's public - documentation for more details. + - UNSPECIFIED defaults to HTTP for backwards compatibility. + - The TargetServer uses HTTP. + - The TargetSever uses HTTP2. + - The TargetServer uses GRPC. - >- - Comprehensive environment supports advanced capabilites and even - higher capacity than Intermediate environment. Refer to Apigee's - public documentation for more details. - displayName: - description: Optional. Display name for this environment. - type: string - properties: - description: >- - Optional. Key-value pairs that may be used for customizing the - environment. - $ref: '#/components/schemas/GoogleCloudApigeeV1Properties' - deploymentType: - description: >- - Optional. Deployment type supported by the environment. The - deployment type can be set when creating the environment and cannot - be changed. When you enable archive deployment, you will be - **prevented from performing** a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment, including: * Managing the deployment of API - proxy or shared flow revisions * Creating, updating, or deleting - resource files * Creating, updating, or deleting target servers + GRPC TargetServer to be used in ExternalCallout Policy. Prefer to + use EXTERNAL_CALLOUT instead. TODO(b/266125112) deprecate once + EXTERNAL _CALLOUT generally available. + - The TargetServer is to be used in the ExternalCallout Policy type: string enum: - - DEPLOYMENT_TYPE_UNSPECIFIED - - PROXY - - ARCHIVE - enumDescriptions: - - Deployment type not specified. - - >- - Proxy deployment enables you to develop and deploy API proxies - using Apigee on Google Cloud. This cannot currently be combined - with the CONFIGURABLE API proxy type. - - >- - Archive deployment enables you to develop API proxies locally then - deploy an archive of your API proxy configuration to an - environment in Apigee on Google Cloud. You will be prevented from - performing a [subset of - actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) - within the environment. - name: - description: >- - Required. Name of the environment. Values must match the regular - expression `^[.\\p{Alnum}-_]{1,255}$` + - PROTOCOL_UNSPECIFIED + - HTTP + - HTTP2 + - GRPC_TARGET + - GRPC + - EXTERNAL_CALLOUT + description: >- + TargetServer configuration. TargetServers are used to decouple a proxy + TargetEndpoint HTTPTargetConnections from concrete URLs for backend + services. + id: GoogleCloudApigeeV1TargetServer + type: object + GoogleCloudApigeeV1DatastoreConfig: + type: object + properties: + datasetName: type: string - forwardProxyUri: + description: BigQuery dataset name Required for `bigquery` target_type. + tablePrefix: + description: Prefix of BigQuery table Required for `bigquery` target_type. + type: string + path: + description: Path of Cloud Storage bucket Required for `gcs` target_type. type: string - description: >- - Optional. URI of the forward proxy to be applied to the runtime - instances in this environment. Must be in the format of - {scheme}://{hostname}:{port}. Note that the scheme must be one of - "http" or "https", and the port must be supplied. To remove a - forward proxy setting, update the field to an empty value. Note: At - this time, PUT operations to add forwardProxyUri to an existing - environment fail if the environment has nodeConfig set up. To - successfully add the forwardProxyUri setting in this case, include - the NodeConfig details with the request. - description: + projectId: + description: Required. GCP project in which the datastore exists type: string - description: Optional. Description of the environment. - apiProxyType: + bucketName: + description: Name of the Cloud Storage bucket. Required for `gcs` target_type. type: string + id: GoogleCloudApigeeV1DatastoreConfig + description: Configuration detail for datastore + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation: + properties: + scoreImpact: description: >- - Optional. API Proxy type supported by the environment. The type can - be set when creating the Environment and cannot be changed. + Score impact indicates the impact on the overall score if the + assessment were to pass. + type: integer + format: int32 + verdict: enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. - - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE - nodeConfig: - $ref: '#/components/schemas/GoogleCloudApigeeV1NodeConfig' - description: Optional. NodeConfig of the environment. - state: + - The verdict is unspecified. + - The assessment has passed. + - The assessment has failed. type: string - description: >- - Output only. State of the environment. Values other than ACTIVE - means the resource is not ready to use. - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. + description: Verdict indicates the assessment result. enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - readOnly: true - createdAt: - readOnly: true - format: int64 - description: >- - Output only. Creation time of this environment as milliseconds since - epoch. + - VERDICT_UNSPECIFIED + - PASS + - FAIL + weight: + enum: + - WEIGHT_UNSPECIFIED + - MINOR + - MODERATE + - MAJOR + description: The weight of the assessment which was set in the profile. + enumDescriptions: + - The weight is unspecified. + - The weight is minor. + - The weight is moderate. + - The weight is major. type: string - hasAttachedFlowHooks: - type: boolean - lastModifiedAt: + recommendations: + description: The recommended steps of the assessment. + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendationRecommendation + type: array + displayName: type: string - description: >- - Output only. Last modification time of this environment as - milliseconds since epoch. - format: int64 - readOnly: true - id: GoogleCloudApigeeV1Environment + description: The display name of the assessment. type: object - GoogleCloudApigeeV1SchemaSchemaElement: + description: The message format of a recommendation from the assessment. + id: >- + GoogleCloudApigeeV1SecurityAssessmentResultScoringResultAssessmentRecommendation + GoogleCloudApigeeV1SecurityProfileScoringConfig: type: object - description: Message type for the schema element + id: GoogleCloudApigeeV1SecurityProfileScoringConfig properties: - properties: - $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaProperty' - description: >- - Properties for the schema field. For example: { "createTime": - "2016-02-26T10:23:09.592Z", "custom": "false", "type": "string" } - name: - description: Name of the field. + description: + description: Description of the config. type: string - id: GoogleCloudApigeeV1SchemaSchemaElement - GoogleCloudApigeeV1SetAddonEnablementRequest: - description: Request for SetAddonEnablement. - properties: - analyticsEnabled: - type: boolean - description: If the Analytics should be enabled in the environment. - apiSecurityEnabled: - type: boolean - description: If the API Security should be enabled in the environment. - id: GoogleCloudApigeeV1SetAddonEnablementRequest - type: object - GoogleCloudApigeeV1ListDebugSessionsResponse: - type: object - properties: - nextPageToken: + scorePath: + type: string + description: Path of the component config used for scoring. + title: + description: Title of the config. type: string + description: Security configurations to manage scoring. + GoogleCloudApigeeV1SecurityActionConditionConfig: + properties: + asns: + type: array description: >- - Page token that you can include in a ListDebugSessionsRequest to - retrieve the next page. If omitted, no subsequent pages exist. - sessions: + Optional. A list of ASN numbers to act on, e.g. 23. + https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses + int64 instead of uint32 because of + https://linter.aip.dev/141/forbidden-types. + items: + type: string + format: int64 + ipAddressRanges: type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Session' + type: string description: >- - Session info that includes debug session ID and the first - transaction creation timestamp. - id: GoogleCloudApigeeV1ListDebugSessionsResponse - GoogleCloudApigeeV1SharedFlowRevision: - properties: - resourceFiles: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' - description: The resource files included in this shared flow revision. - contextInfo: - type: string - description: A textual description of the shared flow revision. - createdAt: + Optional. A list of IP addresses. This could be either IPv4 or IPv6. + Limited to 100 per action. + botReasons: description: >- - Time at which this shared flow revision was created, in milliseconds - since epoch. - type: string - format: int64 - policies: + Optional. A list of Bot Reasons. Current options: Flooder, Brute + Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, + TorListRule, Advanced Anomaly Detection, Advanced API Scraper, + Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public + Cloud Azure, and Public Cloud Google. + items: + type: string + type: array + apiKeys: + description: Optional. A list of API keys. Limit 1000 per action. type: array - description: A list of policy names included in this shared flow revision. items: type: string - description: - type: string - description: Description of the shared flow revision. - revision: - description: The resource ID of this revision. + httpMethods: + items: + type: string + description: >- + Optional. Act only on particular HTTP methods. E.g. A read-only API + can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, + POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH. + type: array + accessTokens: + description: Optional. A list of access_tokens. Limit 1000 per action. + items: + type: string + type: array + developers: + items: + type: string + description: Optional. A list of developers. Limit 1000 per action. + type: array + regionCodes: + type: array + description: >- + Optional. A list of countries/region codes to act on, e.g. US. This + follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. + items: + type: string + apiProducts: + type: array + items: + type: string + description: Optional. A list of API Products. Limit 1000 per action. + developerApps: + items: + type: string + type: array + description: Optional. A list of developer apps. Limit 1000 per action. + userAgents: + items: + type: string + type: array + description: >- + Optional. A list of user agents to deny. We look for exact matches. + Limit 50 per action. + description: >- + The following are a list of conditions. A valid SecurityAction must + contain at least one condition. Within a condition, each element is + ORed. Across conditions elements are ANDed. For example if a + SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and + bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: + enforce the action if the incoming request has ((ip_address_ranges = + "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR + bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges + and bot_reasons cannot be ANDed. + type: object + id: GoogleCloudApigeeV1SecurityActionConditionConfig + GoogleCloudApigeeV1Session: + description: Session carries the debug session id and its creation time. + id: GoogleCloudApigeeV1Session + properties: + timestampMs: type: string - lastModifiedAt: description: >- - Time at which this shared flow revision was most recently modified, - in milliseconds since epoch. + The first transaction creation timestamp in millisecond, recorded by + UAP. format: int64 + id: + description: The debug session ID. type: string - name: - type: string - description: The resource ID of the parent shared flow. - resources: - description: >- - A list of the resources included in this shared flow revision - formatted as "{type}://{name}". - items: - type: string - type: array - type: - description: The string "Application" - type: string - sharedFlows: + type: object + GoogleCloudApigeeV1ProfileConfig: + type: object + description: >- + ProfileConfig defines a set of categories and policies which will be + used to compute security score. + properties: + categories: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1ProfileConfigCategory' type: array + description: List of categories of profile config. + id: GoogleCloudApigeeV1ProfileConfig + GoogleCloudApigeeV1SecuritySettings: + description: >- + SecuritySettings reflects the current state of the SecuritySettings + feature. + id: GoogleCloudApigeeV1SecuritySettings + type: object + properties: + mlRetrainingFeedbackEnabled: description: >- - A list of the shared flow names included in this shared flow - revision. - configurationVersion: - $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' + Optional. If true the user consents to the use of ML models for + Abuse detection. + type: boolean + name: description: >- - The version of the configuration schema to which this shared flow - conforms. The only supported value currently is majorVersion 4 and - minorVersion 0. This setting may be used in the future to enable - evolution of the shared flow format. - displayName: - description: The human readable name of this shared flow. + Identifier. Full resource name is always + `organizations/{org}/securitySettings`. type: string - entityMetaDataAsProperties: - additionalProperties: - type: string - description: A Key-Value map of metadata about this shared flow revision. - type: object + GoogleCloudApigeeV1GetSyncAuthorizationRequest: type: object - description: The metadata describing a shared flow revision. - id: GoogleCloudApigeeV1SharedFlowRevision - GoogleCloudApigeeV1QueryTimeSeriesStatsRequest: - id: GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + properties: {} + id: GoogleCloudApigeeV1GetSyncAuthorizationRequest + description: Request for GetSyncAuthorization. + GoogleCloudApigeeV1ResourceFiles: + description: List of resource files. + id: GoogleCloudApigeeV1ResourceFiles properties: - dimensions: - description: >- - List of dimension names to group the aggregations by. If no - dimensions are passed, a single trend line representing the - requested metric aggregations grouped by environment is returned. - type: array + resourceFile: items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + description: List of resource files. + type: array + type: object + GoogleCloudApigeeV1ApiProxy: + type: object + id: GoogleCloudApigeeV1ApiProxy + properties: + labels: + type: object + description: User labels applied to this API Proxy. + additionalProperties: type: string - pageToken: + apiProxyType: + enum: + - API_PROXY_TYPE_UNSPECIFIED + - PROGRAMMABLE + - CONFIGURABLE + description: Output only. The type of the API proxy. + readOnly: true + enumDescriptions: + - API proxy type not specified. + - >- + Programmable API Proxies enable you to develop APIs with highly + flexible behavior using bundled policy configuration and one or + more programming languages to describe complex sequential and/or + conditional flows of logic. + - >- + Configurable API Proxies enable you to develop efficient APIs + using simple configuration while complex execution control flow + logic is handled by Apigee. This type only works with the ARCHIVE + deployment type and cannot be combined with the PROXY deployment + type. type: string + latestRevisionId: description: >- - Page token stands for a specific collection of time series - sequences. - metrics: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1MetricAggregation' - type: array - description: Required. List of metrics and their aggregations. - pageSize: + Output only. The id of the most recently created revision for this + api proxy. + type: string + readOnly: true + readOnly: + type: boolean description: >- - Page size represents the number of time series sequences, one per - unique set of dimensions and their values. - format: int32 - type: integer - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Required. Time range for the stats. - timestampOrder: - enumDescriptions: - - Unspecified order. Default is Descending. - - Ascending sort order. - - Descending sort order. + Output only. Whether this proxy is read-only. A read-only proxy + cannot have new revisions created through calls to + CreateApiProxyRevision. A proxy is read-only if it was generated by + an archive. + readOnly: true + name: + readOnly: true + type: string + description: Output only. Name of the API proxy. + metaData: + readOnly: true + description: Output only. Metadata describing the API proxy. + $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' + revision: + type: array + items: + type: string + readOnly: true + description: Output only. List of revisions defined for the API proxy. + description: Metadata describing the API proxy + GoogleCloudApigeeV1EntityMetadata: + description: Metadata common to many entities in this API. + type: object + id: GoogleCloudApigeeV1EntityMetadata + properties: + lastModifiedAt: + format: int64 description: >- - Order the sequences in increasing or decreasing order of timestamps. - Default is descending order of timestamps (latest first). - enum: - - ORDER_UNSPECIFIED - - ASCENDING - - DESCENDING + Time at which the API proxy was most recently modified, in + milliseconds since epoch. type: string - filter: + subType: type: string + description: The type of entity described + createdAt: + format: int64 description: >- - Filter further on specific dimension values. Follows the same - grammar as custom report's filter expressions. Example, apiproxy eq - 'foobar'. - https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters - windowSize: - description: Time buckets to group the stats by. + Time at which the API proxy was created, in milliseconds since + epoch. type: string - enumDescriptions: - - Unspecified window size. Default is 1 hour. - - 1 Minute window - - 1 Hour window - - 1 Day window - - 1 Month window - enum: - - WINDOW_SIZE_UNSPECIFIED - - MINUTE - - HOUR - - DAY - - MONTH - description: >- - QueryTimeSeriesStatsRequest represents a query that returns a collection - of time series sequences grouped by their values. + GoogleCloudApigeeV1ListDeploymentsResponse: + id: GoogleCloudApigeeV1ListDeploymentsResponse type: object - GoogleCloudApigeeV1ReportInstanceStatusRequest: properties: - instanceUid: + deployments: + description: List of deployments. + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + GoogleCloudApigeeV1ProfileConfigAbuse: + type: object + properties: {} + id: GoogleCloudApigeeV1ProfileConfigAbuse + description: >- + Checks for abuse, which includes any requests sent to the API for + purposes other than what it is intended for, such as high volumes of + requests, data scraping, and abuse related to authorization. + GoogleIamV1SetIamPolicyRequest: + properties: + policy: description: >- - A unique ID for the instance which is guaranteed to be unique in - case the user installs multiple hybrid runtimes with the same - instance ID. - type: string - reportTime: - format: google-datetime + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/GoogleIamV1Policy' + updateMask: description: >- - The time the report was generated in the runtime. Used to prevent an - old status from overwriting a newer one. An instance should space - out it's status reports so that clock skew does not play a factor. + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + format: google-fieldmask type: string - resources: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceStatus' - type: array - description: Status for config resources - description: Request for ReportInstanceStatus. - id: GoogleCloudApigeeV1ReportInstanceStatusRequest + id: GoogleIamV1SetIamPolicyRequest type: object - GoogleCloudApigeeV1ListNatAddressesResponse: + description: Request message for `SetIamPolicy` method. + GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence: + description: A sequence of time series. + id: GoogleCloudApigeeV1QueryTimeSeriesStatsResponseSequence type: object properties: - nextPageToken: + dimensions: + additionalProperties: + type: string + type: object description: >- - Page token that you can include in a ListNatAddresses request to - retrieve the next page of content. If omitted, no subsequent pages - exist. - type: string - natAddresses: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' - description: List of NAT Addresses for the instance. + Map of dimensions and their values that uniquely identifies a time + series sequence. + points: + description: List of points. First value of each inner list is a timestamp. type: array - id: GoogleCloudApigeeV1ListNatAddressesResponse - description: Response for ListNatAddresses. - GoogleCloudApigeeV1ApiDocDocumentationResponse: + items: + items: + type: any + type: array + GoogleCloudApigeeV1ProfileConfigMediation: + type: object + properties: {} + id: GoogleCloudApigeeV1ProfileConfigMediation + description: >- + By default, following policies will be included: - OASValidation - + SOAPMessageValidation + GoogleCloudApigeeV1RuntimeConfig: properties: - requestId: + name: type: string - description: Output only. Unique ID of the request. - readOnly: true - status: - description: Output only. Status of the operation. - readOnly: true + description: >- + Name of the resource in the following format: + `organizations/{org}/runtimeConfig`. + traceBucket: + description: Cloud Storage bucket used for uploading Trace records. type: string - data: - description: Output only. The documentation resource. - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' - readOnly: true - message: - description: Output only. Description of the operation. + tenantProjectId: type: string + description: >- + Output only. Tenant project ID associated with the Apigee + organization. The tenant project is used to host Google-managed + resources that are dedicated to this Apigee organization. Clients + have limited access to resources within the tenant project used to + support Apigee runtime instances. Access to the tenant project is + managed using SetSyncAuthorization. It can be empty if the tenant + project hasn't been created yet. readOnly: true - errorCode: + analyticsBucket: + description: Cloud Storage bucket used for uploading Analytics records. type: string - readOnly: true - description: Output only. Unique error code for the request, if any. - id: GoogleCloudApigeeV1ApiDocDocumentationResponse description: >- - The catalog item documentation wrapped with response status, error_code, - etc. - type: object - GoogleCloudApigeeV1ResourceFiles: - id: GoogleCloudApigeeV1ResourceFiles - properties: - resourceFile: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' - description: List of resource files. - type: array - type: object - description: List of resource files. - GoogleCloudApigeeV1ListOfDevelopersResponse: + Runtime configuration for the organization. Response for + GetRuntimeConfig. + id: GoogleCloudApigeeV1RuntimeConfig type: object - id: GoogleCloudApigeeV1ListOfDevelopersResponse + GoogleCloudApigeeV1EnvironmentConfig: + id: GoogleCloudApigeeV1EnvironmentConfig properties: - developer: + resourceReferences: + description: List of resource references in the environment. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' - description: List of developers. - GoogleCloudApigeeV1RuntimeAnalyticsConfig: - description: Runtime configuration for the Analytics add-on. - type: object - properties: - billingPipelineEnabled: - description: If Runtime should send billing data to AX or not. - type: boolean - enabled: - type: boolean - description: If the Analytics is enabled or not. - id: GoogleCloudApigeeV1RuntimeAnalyticsConfig - GoogleCloudApigeeV1ApiSecurityConfig: - id: GoogleCloudApigeeV1ApiSecurityConfig - type: object - properties: - expiresAt: + $ref: '#/components/schemas/GoogleCloudApigeeV1ReferenceConfig' + deployments: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentConfig' + description: List of deployments in the environment. + type: array + pubsubTopic: type: string + description: Name of the PubSub topic for the environment. + sequenceNumber: format: int64 - readOnly: true - description: >- - Output only. Time at which the API Security add-on expires in in - milliseconds since epoch. If unspecified, the add-on will never - expire. - enabled: - type: boolean - description: Flag that specifies whether the API security add-on is enabled. - description: Configurations of the API Security add-on. - GoogleCloudApigeeV1CanaryEvaluation: - properties: - verdict: - readOnly: true - enumDescriptions: - - Verdict is not available yet. - - No verdict reached. - - Evaluation is not good. - - Evaluation is good. + description: 'DEPRECATED: Use revision_id.' type: string + resources: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceConfig' + type: array + description: List of resource versions in the environment. + deploymentGroups: + description: List of deployment groups in the environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentGroupConfig' + type: array + addonsConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeAddonsConfig' + description: The latest runtime configurations for add-ons. + featureFlags: + type: object + additionalProperties: + type: string + description: Feature flags inherited from the organization and environment. + targets: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServerConfig' description: >- - Output only. The resulting verdict of the canary evaluations: NONE, - PASS, or FAIL. - enum: - - VERDICT_UNSPECIFIED - - NONE - - FAIL - - PASS + List of target servers in the environment. Disabled target servers + are not displayed. + dataCollectors: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollectorConfig' + description: List of data collectors used by the deployments in the environment. + type: array createTime: - description: Output only. Create time of the canary evaluation. - type: string - readOnly: true format: google-datetime - startTime: + description: Time that the environment configuration was created. type: string - format: google-datetime - description: Required. Start time for the canary evaluation's analysis. - treatment: + uid: + description: >- + Unique ID for the environment configuration. The ID will only change + if the environment is deleted and recreated. type: string - description: Required. The newer version that is serving requests. - state: - enum: - - STATE_UNSPECIFIED - - RUNNING - - SUCCEEDED + gatewayConfigLocation: type: string - description: Output only. The current state of the canary evaluation. - enumDescriptions: - - No state has been specified. - - The canary evaluation is still in progress. - - The canary evaluation has finished. - readOnly: true - control: + description: >- + The location for the gateway config blob as a URI, e.g. a Cloud + Storage URI. This is only used by Envoy-based gateways. + arcConfigLocation: type: string - description: Required. The stable version that is serving requests. - endTime: + description: >- + The location for the config blob of API Runtime Control, aka Envoy + Adapter, for op-based authentication as a URI, e.g. a Cloud Storage + URI. This is only used by Envoy-based gateways. + traceConfig: + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeTraceConfig' + description: >- + Trace configurations. Contains config for the environment and config + overrides for specific API proxies. + debugMask: + description: Debug mask that applies to all deployments in the environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + revisionId: type: string - format: google-datetime - description: Required. End time for the evaluation's analysis. - name: + format: int64 + description: >- + Revision ID of the environment configuration. The higher the value, + the more recently the configuration was deployed. + provider: type: string - description: Output only. Name of the canary evalution. - readOnly: true - metricLabels: description: >- - Required. Labels used to filter the metrics used for a canary - evaluation. - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' - type: object - description: >- - CanaryEvaluation represents the canary analysis between two versions of - the runtime that is serving requests. - id: GoogleCloudApigeeV1CanaryEvaluation - GoogleCloudApigeeV1EntityMetadata: - description: Metadata common to many entities in this API. - type: object - properties: - createdAt: + Used by the Control plane to add context information to help detect + the source of the document during diagnostics and debugging. + envScopedRevisionId: format: int64 + description: >- + Revision ID for environment-scoped resources (e.g. target servers, + keystores) in this config. This ID will increment any time a + resource not scoped to a deployment group changes. + type: string + keystores: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeystoreConfig' + description: List of keystores in the environment. + type: array + flowhooks: + type: array + description: List of flow hooks in the environment. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHookConfig' + name: type: string description: >- - Time at which the API proxy was created, in milliseconds since - epoch. - subType: - type: string - description: The type of entity described - lastModifiedAt: + Name of the environment configuration in the following format: + `organizations/{org}/environments/{env}/configs/{config}` + forwardProxyUri: description: >- - Time at which the API proxy was most recently modified, in - milliseconds since epoch. - format: int64 + The forward proxy's url to be used by the runtime. When set, runtime + will send requests to the target via the given forward proxy. This + is only used by programmable gateways. type: string - id: GoogleCloudApigeeV1EntityMetadata - GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse: - description: Response for ListSecurityProfileRevisions. type: object + GoogleCloudApigeeV1ServiceIssuersMapping: properties: - nextPageToken: + emailIds: + items: + type: string + type: array + description: List of trusted issuer email ids. + service: + description: String indicating the Apigee service name. type: string - description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - securityProfiles: + id: GoogleCloudApigeeV1ServiceIssuersMapping + type: object + GoogleCloudApigeeV1ComputeEnvironmentScoresResponse: + type: object + id: GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + properties: + scores: + description: List of scores. One score per day. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Score' type: array + nextPageToken: description: >- - List of security profile revisions. The revisions may be attached or - unattached to any environment. + A page token, received from a previous `ComputeScore` call. Provide + this to retrieve the subsequent page. + type: string + description: Response for ComputeEnvironmentScores. + GoogleCloudApigeeV1DeveloperBalance: + properties: + wallets: + readOnly: true items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' - id: GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse - GoogleCloudApigeeV1SecurityAssessmentResultResource: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalanceWallet' + description: >- + Output only. List of all wallets. Each individual wallet stores the + account balance for a particular currency. + type: array + type: object + id: GoogleCloudApigeeV1DeveloperBalance + description: Account balance for the developer. + GoogleCloudApigeeV1SecurityProfileEnvironment: + type: object + description: >- + Environment information of attached environments. Scoring an environment + is enabled only if it is attached to a security profile. + id: GoogleCloudApigeeV1SecurityProfileEnvironment properties: - type: - type: string - enumDescriptions: - - ResourceType not specified. - - Resource is an Apigee Proxy. - description: Required. Type of this resource. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - API_PROXY - name: + attachTime: type: string - description: Required. Name of this resource. - resourceRevisionId: + format: google-datetime + readOnly: true description: >- - The revision id for the resource. In case of Apigee, this is proxy - revision id. + Output only. Time at which environment was attached to the security + profile. + environment: type: string - description: Resource for which we are computing security assessment. - id: GoogleCloudApigeeV1SecurityAssessmentResultResource - type: object - GoogleCloudApigeeV1TlsInfoCommonName: + description: Output only. Name of the environment. + readOnly: true + GoogleCloudApigeeV1FlowHookConfig: properties: - value: - type: string - description: The TLS Common Name string of the certificate. - wildcardMatch: + continueOnError: + description: >- + Flag that specifies whether the flow should abort after an error in + the flow hook. Defaults to `true` (continue on error). type: boolean + name: + type: string description: >- - Indicates whether the cert should be matched against as a wildcard - cert. - id: GoogleCloudApigeeV1TlsInfoCommonName + Name of the flow hook in the following format: + `organizations/{org}/environments/{env}/flowhooks/{point}`. Valid + `point` values include: `PreProxyFlowHook`, `PostProxyFlowHook`, + `PreTargetFlowHook`, and `PostTargetFlowHook` + sharedFlowName: + type: string + description: >- + Name of the shared flow to invoke in the following format: + `organizations/{org}/sharedflows/{sharedflow}` type: object - GoogleCloudApigeeV1DataCollectorConfig: - id: GoogleCloudApigeeV1DataCollectorConfig + id: GoogleCloudApigeeV1FlowHookConfig + GoogleCloudApigeeV1ApiDoc: + id: GoogleCloudApigeeV1ApiDoc type: object properties: - type: - description: Data type accepted by the data collector. - type: string - enumDescriptions: - - For future compatibility. - - For integer values. - - For float values. - - For string values. - - For boolean values. - - For datetime values. - enum: - - TYPE_UNSPECIFIED - - INTEGER - - FLOAT - - STRING - - BOOLEAN - - DATETIME - name: + graphqlEndpointUrl: type: string + deprecated: true description: >- - Name of the data collector in the following format: - `organizations/{org}/datacollectors/{datacollector}` - description: Data collector and its configuration. - GoogleCloudApigeeV1DeveloperAppKey: - properties: - expiresAt: - type: string - description: Time the developer app expires in milliseconds since epoch. - format: int64 - scopes: - items: - type: string - type: array + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + anonAllowed: + type: boolean description: >- - Scopes to apply to the app. The specified scope names must already - be defined for the API product that you associate with the app. - expiresInSeconds: + Optional. Boolean flag that manages user access to the catalog item. + When true, the catalog item has public visibility and can be viewed + anonymously; otherwise, only registered users may view it. Note: + when the parent portal is enrolled in the [audience management + feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), + and this flag is set to false, visibility is set to an indeterminate + state and must be explicitly specified in the management UI (see + [Manage the visibility of an API in your + portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). + Additionally, when enrolled in the audience management feature, + updates to this flag will be ignored as visibility permissions must + be updated in the management UI. + apiProductName: + description: >- + Required. Immutable. The `name` field of the associated [API + product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + A portal may have only one catalog item associated with a given API + product. type: string - format: int64 + requireCallbackUrl: description: >- - Input only. Expiration time, in seconds, for the consumer key. If - not set or left to the default value of `-1`, the API key never - expires. The expiration time can't be updated after it is set. - issuedAt: - description: Time the developer app was created in milliseconds since epoch. - format: int64 + Optional. Whether a callback URL is required when this catalog + item's API product is enabled in a developer app. When true, a + portal user will be required to input a URL when managing the app + (this is typically used for the app's OAuth flow). + type: boolean + siteId: + description: Output only. The ID of the parent portal. type: string - consumerKey: + readOnly: true + title: + description: >- + Required. The user-facing name of the catalog item. `title` must be + a non-empty string with a max length of 255 characters. type: string - description: Consumer key. - consumerSecret: + description: + description: >- + Optional. Description of the catalog item. Max length is 10,000 + characters. type: string - description: Secret key. - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - description: List of attributes associated with the credential. - type: array - status: + graphqlSchema: type: string description: >- - Status of the credential. Valid values include `approved` or - `revoked`. - apiProducts: - items: - type: any - type: array - description: >- - List of API products for which the credential can be used. **Note**: - Do not specify the list of API products when creating a consumer key - and secret for a developer app. Instead, use the - UpdateDeveloperAppKey API to make the association after the consumer - key and secret are created. - id: GoogleCloudApigeeV1DeveloperAppKey - type: object - GoogleCloudApigeeV1ListAppsResponse: - id: GoogleCloudApigeeV1ListAppsResponse - properties: - totalSize: - type: integer - description: Total count of Apps. - format: int32 - app: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' - type: array - nextPageToken: - description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - type: object - GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo: - type: object - id: GoogleCloudApigeeV1GetAsyncQueryResultUrlResponseURLInfo - properties: - uri: + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + deprecated: true + modified: description: >- - The signed URL of the JSON data. Will be of the form - `https://storage.googleapis.com/example-bucket/cat.jpeg?X-Goog-Algorithm= - GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount - .com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T18 - 1309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f16 - 9edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa849 - 6def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dc - c1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c2058 - 0e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a - 66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823 - a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b13344703 - 2ea7abedc098d2eb14a7` + Output only. Time the catalog item was last modified in milliseconds + since epoch. + readOnly: true + format: int64 type: string - md5: + graphqlSchemaDisplayName: type: string - description: The MD5 Hash of the JSON data - sizeBytes: - description: The size of the returned file in bytes + deprecated: true + description: >- + Optional. DEPRECATED: manage documentation through the + `getDocumentation` and `updateDocumentation` methods + published: + description: >- + Optional. Denotes whether the catalog item is published to the + portal or is in a draft state. When the parent portal is enrolled in + the [audience management + feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), + the visibility can be set to public on creation by setting the + anonAllowed flag to true or further managed in the management UI + (see [Manage the visibility of an API in your + portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) + before it can be visible to any users. If not enrolled in the + audience management feature, the visibility is managed by the + `anonAllowed` flag. + type: boolean + id: + description: Output only. The ID of the catalog item. format: int64 + readOnly: true type: string - description: A Signed URL and the relevant metadata associated with it. - GoogleCloudApigeeV1ResourceFile: - description: Metadata about a resource file. - properties: - name: + imageUrl: type: string - description: ID of the resource file. - type: - description: Resource file type. {{ resource_file_type }} + description: >- + Optional. Location of the image used for the catalog item in the + catalog. This can be either an image with an external URL or a file + path for [image files stored in the + portal](/apigee/docs/api-platform/publish/portal/portal-files"), for + example, `/files/book-tree.jpg`. When specifying the URL of an + external image, the image won't be uploaded to your assets; + additionally, loading the image in the integrated portal will be + subject to its availability, which may be blocked or restricted by + [content security + policies](/apigee/docs/api-platform/publish/portal/csp). Max length + of file path is 2,083 characters. + specId: + deprecated: true type: string - id: GoogleCloudApigeeV1ResourceFile - type: object - GoogleCloudApigeeV1ApiProxy: - type: object - description: Metadata describing the API proxy - id: GoogleCloudApigeeV1ApiProxy + description: 'Optional. DEPRECATED: DO NOT USE' + visibility: + description: 'Optional. DEPRECATED: use the `published` field instead' + type: boolean + edgeAPIProductName: + type: string + description: >- + Optional. Immutable. DEPRECATED: use the `apiProductName` field + instead + categoryIds: + items: + type: string + type: array + description: >- + Optional. The IDs of the API categories to which this catalog item + belongs. + description: >- + `ApiDoc` represents an API catalog item. Catalog items are used in two + ways in a portal: - Users can browse and interact with a visual + representation of the API documentation - The `api_product_name` field + provides a link to a backing [API product] + (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). + Through this link, portal users can create and manage developer apps + linked to one or more API products. + GoogleCloudApigeeV1TlsInfoConfig: properties: - metaData: - readOnly: true - description: Output only. Metadata describing the API proxy. - $ref: '#/components/schemas/GoogleCloudApigeeV1EntityMetadata' - revision: - readOnly: true + protocols: + type: array + items: + type: string + description: List of TLS protocols that are granted access. + ciphers: items: type: string + description: List of ciphers that are granted access. type: array - description: Output only. List of revisions defined for the API proxy. - name: - type: string - description: Output only. Name of the API proxy. - readOnly: true - latestRevisionId: - readOnly: true - type: string + clientAuthEnabled: + type: boolean description: >- - Output only. The id of the most recently created revision for this - api proxy. - readOnly: + Flag that specifies whether client-side authentication is enabled + for the target server. Enables two-way TLS. + enabled: type: boolean description: >- - Output only. Whether this proxy is read-only. A read-only proxy - cannot have new revisions created through calls to - CreateApiProxyRevision. A proxy is read-only if it was generated by - an archive. - readOnly: true - apiProxyType: - enumDescriptions: - - API proxy type not specified. - - >- - Programmable API Proxies enable you to develop APIs with highly - flexible behavior using bundled policy configuration and one or - more programming languages to describe complex sequential and/or - conditional flows of logic. - - >- - Configurable API Proxies enable you to develop efficient APIs - using simple configuration while complex execution control flow - logic is handled by Apigee. This type only works with the ARCHIVE - deployment type and cannot be combined with the PROXY deployment - type. - description: Output only. The type of the API proxy. + Flag that specifies whether one-way TLS is enabled. Set to `true` to + enable one-way TLS. + ignoreValidationErrors: + type: boolean + description: >- + Flag that specifies whether to ignore TLS certificate validation + errors. Set to `true` to ignore errors. + keyAlias: + description: >- + Name of the alias used for client-side authentication in the + following format: + `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}` type: string - enum: - - API_PROXY_TYPE_UNSPECIFIED - - PROGRAMMABLE - - CONFIGURABLE - readOnly: true - labels: - type: object - additionalProperties: - type: string - description: User labels applied to this API Proxy. - GoogleCloudApigeeV1DocumentationFile: - type: object - properties: - contents: + commonName: + $ref: '#/components/schemas/GoogleCloudApigeeV1CommonNameConfig' + description: Common name to validate the target server against. + keyAliasReference: + description: Reference name and alias pair to use for client-side authentication. + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyAliasReference' + enforce: + description: Flag that enforces TLS settings + type: boolean + trustStore: type: string - description: Required. The file contents. The max size is 4 MB. - format: byte - displayName: description: >- - Required. A display name for the file, shown in the management UI. - Max length is 255 characters. - type: string - description: Documentation file contents for a catalog item. - id: GoogleCloudApigeeV1DocumentationFile - GoogleCloudApigeeV1AppGroupApp: + Name of the keystore or keystore reference containing trusted + certificates for the server in the following format: + `organizations/{org}/environments/{env}/keystores/{keystore}` or + `organizations/{org}/environments/{env}/references/{reference}` type: object + id: GoogleCloudApigeeV1TlsInfoConfig + GoogleCloudApigeeV1GrpcOperationConfig: properties: - status: - description: Status of the App. Valid values include `approved` or `revoked`. - type: string - scopes: - type: array + methods: items: type: string + type: array description: >- - Scopes to apply to the AppGroup app. The specified scopes must - already exist for the API product that you associate with the - AppGroup app. - keyExpiresIn: + List of unqualified gRPC method names for the proxy to which quota + will be applied. If this field is empty, the Quota will apply to all + operations on the gRPC service defined on the proxy. Example: Given + a proxy that is configured to serve com.petstore.PetService, the + methods com.petstore.PetService.ListPets and + com.petstore.PetService.GetPet would be specified here as simply + ["ListPets", "GetPet"]. + apiSource: type: string - format: int64 description: >- - Immutable. Expiration time, in seconds, for the consumer key that is - generated for the AppGroup app. If not set or left to the default - value of `-1`, the API key never expires. The expiration time can't - be updated after it is set. - credentials: - readOnly: true + Required. Name of the API proxy with which the gRPC operation and + quota are associated. + quota: + $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' + description: >- + Quota parameters to be enforced for the methods and API source + combination. If none are specified, quota enforcement will not be + done. + attributes: type: array + description: Custom attributes associated with the operation. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + service: + type: string + description: >- + Required. gRPC Service name associated to be associated with the API + proxy, on which quota rules can be applied upon. + description: >- + Binds the resources in a proxy or remote service with the gRPC operation + and its associated quota enforcement. + id: GoogleCloudApigeeV1GrpcOperationConfig + type: object + GoogleCloudApigeeV1MonetizationConfig: + id: GoogleCloudApigeeV1MonetizationConfig + properties: + enabled: + type: boolean + description: Flag that specifies whether the Monetization add-on is enabled. + type: object + description: Configuration for the Monetization add-on. + GoogleCloudApigeeV1Attributes: + id: GoogleCloudApigeeV1Attributes + type: object + properties: + attribute: + description: List of attributes. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Credential' - description: >- - Output only. Set of credentials for the AppGroup app consisting of - the consumer key/secret pairs associated with the API products. - apiProducts: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' type: array - description: List of API products associated with the AppGroup app. - items: + GoogleCloudApigeeV1DeploymentConfig: + properties: + endpoints: + additionalProperties: type: string - createdAt: - readOnly: true - type: string description: >- - Output only. Time the AppGroup app was created in milliseconds since - epoch. - format: int64 - appGroup: + A mapping from basepaths to proxy endpoint names in this proxy. Not + populated for shared flows. + type: object + serviceAccount: + type: string description: >- - Immutable. Name of the parent AppGroup whose resource name format is - of syntax (organizations/*/appgroups/*). + The service account identity associated with this deployment. If + non-empty, will be in the following format: + `projects/-/serviceAccounts/{account_email}` + location: type: string + description: Location of the API proxy bundle as a URI. attributes: - description: List of attributes for the AppGroup app. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - lastModifiedAt: - readOnly: true + type: object + description: Additional key-value metadata for the deployment. + additionalProperties: + type: string + proxyUid: + type: string + description: Unique ID of the API proxy revision. + uid: type: string description: >- - Output only. Time the AppGroup app was modified in milliseconds - since epoch. - format: int64 + Unique ID. The ID will only change if the deployment is deleted and + recreated. name: description: >- - Immutable. Name of the AppGroup app whose resource name format is of - syntax (organizations/*/appgroups/*/apps/*). - type: string - appId: - type: string - description: Immutable. ID of the AppGroup app. - callbackUrl: + Name of the API or shared flow revision to be deployed in the + following format: `organizations/{org}/apis/{api}/revisions/{rev}` + or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` type: string + deploymentGroups: + items: + type: string description: >- - Callback URL used by OAuth 2.0 authorization servers to communicate - authorization codes back to AppGroup apps. - id: GoogleCloudApigeeV1AppGroupApp - description: >- - Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], - [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and - [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp] - GoogleCloudApigeeV1SecurityReportQueryMetric: + The list of deployment groups in which this proxy should be + deployed. Not currently populated for shared flows. + type: array + basePath: + description: Base path where the application will be hosted. Defaults to "/". + type: string + description: 'NEXT ID: 11' + id: GoogleCloudApigeeV1DeploymentConfig type: object - description: Metric of the Query + GoogleTypeInterval: properties: - alias: - type: string + startTime: description: >- - Alias for the metric. Alias will be used to replace metric name in - query results. - aggregationFunction: - type: string - description: 'Aggregation function: avg, min, max, or sum.' - value: - description: Operand value should be provided when operator is set. - type: string - operator: + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. + format: google-datetime type: string - description: One of `+`, `-`, `/`, `%`, `*`. - name: + endTime: type: string - description: Required. Metric name. - id: GoogleCloudApigeeV1SecurityReportQueryMetric - GoogleCloudApigeeV1DeveloperMonetizationConfig: + description: >- + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. + format: google-datetime + id: GoogleTypeInterval + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. type: object - description: Monetization configuration for the developer. - properties: - billingType: - enumDescriptions: - - The default/unset value. - - >- - Developer pays in advance for the use of APIs and the charged - amount is deducted from their account balance. - - >- - Developer does not maintain an account balance. The API provider - bills the developer for API usage. - enum: - - BILLING_TYPE_UNSPECIFIED - - PREPAID - - POSTPAID - type: string - description: Billing type. - id: GoogleCloudApigeeV1DeveloperMonetizationConfig - GoogleCloudApigeeV1ListAppGroupAppsResponse: - description: Response for ListAppGroupApps - id: GoogleCloudApigeeV1ListAppGroupAppsResponse + GoogleCloudApigeeV1QueryTabularStatsResponse: + id: GoogleCloudApigeeV1QueryTabularStatsResponse properties: nextPageToken: + description: Next page token. type: string - description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - appGroupApps: - description: List of AppGroup apps and their credentials. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + columns: type: array - type: object - GoogleIamV1AuditLogConfig: - id: GoogleIamV1AuditLogConfig - properties: - exemptedMembers: items: type: string description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. + Column names corresponding to the same order as the inner values in + the stats field. + values: + description: Resultant rows from the executed query. + items: + items: + type: any + type: array type: array - logType: - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - description: The log type that this config enables. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - type: string description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - type: object - GoogleCloudApigeeV1CommonNameConfig: - properties: - matchWildCards: - type: boolean - name: - type: string + Encapsulates two kinds of stats that are results of the dimensions and + aggregations requested. - Tabular rows. - Time series data. Example of + tabular rows, Represents security stats results as a row of flat values. type: object - id: GoogleCloudApigeeV1CommonNameConfig - GoogleCloudApigeeV1ListEnvironmentGroupsResponse: + GoogleCloudApigeeV1ApiProxyRevision: + id: GoogleCloudApigeeV1ApiProxyRevision type: object properties: - environmentGroups: - type: array - description: EnvironmentGroups in the specified organization. + targetServers: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' - nextPageToken: - type: string + type: string + type: array description: >- - Page token that you can include in a ListEnvironmentGroups request - to retrieve the next page. If omitted, no subsequent pages exist. - description: Response for ListEnvironmentGroups. - id: GoogleCloudApigeeV1ListEnvironmentGroupsResponse - GoogleCloudApigeeV1Export: - description: Details of an export job. - properties: - updated: - type: string - description: Output only. Time the export job was last updated. - readOnly: true - name: - description: Display name of the export job. - type: string - description: + List of TargetServers referenced in any TargetEndpoint in the API + proxy. Typically, you will see this element only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. + archive: type: string - description: Description of the export job. - executionTime: readOnly: true description: >- - Output only. Execution time for this export job. If the job is still - in progress, it will be set to the amount of time that has elapsed - since`created`, in seconds. Else, it will set to (`updated` - - `created`), in seconds. - type: string - datastoreName: - type: string + Output only. The archive that generated this proxy revision. This + field is only present on proxy revisions that were generated by an + archive. Proxies generated by archives cannot be updated, deleted, + or deployed to other environments. Format: + `organizations/*/environments/*/archiveDeployments/*` + proxyEndpoints: + type: array + description: >- + List of ProxyEndpoints in the `/proxies` directory of the API proxy. + Typically, this element is included only when the API proxy was + created using the Edge UI. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. + items: + type: string + sharedFlows: + description: List of the shared flows included in the API proxy revision. + items: + type: string + type: array + entityMetaDataAsProperties: + additionalProperties: + type: string + type: object + description: Metadata describing the API proxy revision as a key-value map. + targetEndpoints: description: >- - Name of the datastore that is the destination of the export job - [datastore] - error: - readOnly: true + List of TargetEndpoints in the `/targets` directory of the API + proxy. Typically, this element is included only when the API proxy + was created using the Edge UI. This is a 'manifest' setting designed + to provide visibility into the contents of the API proxy. + items: + type: string + type: array + targets: + items: + type: string + description: List of the targets included in the API proxy revision. + type: array + createdAt: + format: int64 type: string - description: Output only. Error is set when export fails - state: description: >- - Output only. Status of the export job. Valid values include - `enqueued`, `running`, `completed`, and `failed`. - readOnly: true - type: string - created: - description: Output only. Time the export job was created. + Time that the API proxy revision was created in milliseconds since + epoch. + lastModifiedAt: + format: int64 type: string - readOnly: true - self: description: >- - Output only. Self link of the export job. A URI that can be used to - retrieve the status of an export job. Example: - `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` - readOnly: true + Time that the API proxy revision was last modified in milliseconds + since epoch. + teams: + items: + type: string + description: List of the teams included in the API proxy revision. + type: array + name: + description: Name of the API proxy. type: string - type: object - id: GoogleCloudApigeeV1Export - GoogleCloudApigeeV1GenerateUploadUrlRequest: - id: GoogleCloudApigeeV1GenerateUploadUrlRequest - properties: {} - type: object - description: Request for GenerateUploadUrl method. - GoogleTypeExpr: - 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. - properties: - location: + resourceFiles: + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFiles' + description: List of resource files included in the API proxy revision. + type: description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - type: string - expression: + Type. Set to `Application`. Maintained for compatibility with the + Apigee Edge API. type: string + integrationEndpoints: + items: + type: string + type: array description: >- - Textual representation of an expression in Common Expression - Language syntax. - title: + List of IntegrationEndpoints in the '/integration-endpoints' + directory of the API proxy. This is a 'manifest' setting designed to + provide visibility into the contents of the API proxy. + contextInfo: + description: Revision number, app name, and organization for the API proxy. type: string - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + proxies: + description: List of proxy names included in the API proxy revision. + type: array + items: + type: string + revision: + description: API proxy revision. + type: string + basepaths: + description: Base URL of the API proxy. + type: array + items: + type: string description: + description: Description of the API proxy revision. type: string + configurationVersion: + $ref: '#/components/schemas/GoogleCloudApigeeV1ConfigVersion' description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: object - id: GoogleTypeExpr - GoogleCloudApigeeV1InstanceAttachment: - properties: - name: - readOnly: true - type: string - description: Output only. ID of the attachment. - environment: - type: string - description: ID of the attached environment. - createdAt: - format: int64 + Version of the API proxy configuration schema to which the API proxy + conforms. Currently, the only supported value is 4.0 + (`majorVersion.minorVersion`). This setting may be used in the + future to track the evolution of the API proxy format. + hasExtensiblePolicy: readOnly: true - type: string + type: boolean description: >- - Output only. Time the attachment was created in milliseconds since - epoch. - description: >- - InstanceAttachment represents the installation of an environment onto an - instance. - type: object - id: GoogleCloudApigeeV1InstanceAttachment - GoogleCloudApigeeV1AccessGet: - description: >- - Get action. For example, "Get" : { "name" : "target.name", "value" : - "default" } - type: object - id: GoogleCloudApigeeV1AccessGet - properties: - name: - type: string - value: - type: string - GoogleCloudApigeeV1ListSecurityReportsResponse: - type: object - id: GoogleCloudApigeeV1ListSecurityReportsResponse - properties: - securityReports: + Output only. This field will be marked as true if revision contains + any policies marked as extensible. + resources: type: array + description: >- + List of the resources included in the API proxy revision formatted + as "{type}://{name}". items: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' - description: The security reports belong to requested resource name. - nextPageToken: + type: string + displayName: + description: Human-readable name of the API proxy. + type: string + spec: description: >- - If the number of security reports exceeded the page size requested, - the token can be used to fetch the next page in a subsequent call. - If the response is the last page and there are no more reports to - return this field is left empty. + OpenAPI Specification that is associated with the API proxy. The + value is set to a URL or to a path in the specification store. type: string - description: The response for SecurityReports. - GoogleCloudApigeeV1ListEndpointAttachmentsResponse: + policies: + description: List of policy names included in the API proxy revision.. + items: + type: string + type: array + description: API proxy revision. + GoogleCloudApigeeV1EnableSecurityActionRequest: + properties: {} + description: Message to enable a disabled SecurityAction. + id: GoogleCloudApigeeV1EnableSecurityActionRequest type: object + GoogleCloudApigeeV1ListDataCollectorsResponse: properties: nextPageToken: type: string description: >- - Page token that you can include in an `ListEndpointAttachments` - request to retrieve the next page. If omitted, no subsequent pages - exist. - endpointAttachments: - description: Endpoint attachments in the specified organization. + Page token that you can include in a ListDataCollectors request to + retrieve the next page. If omitted, no subsequent pages exist. + dataCollectors: type: array + description: Data collectors in the specified organization. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' - id: GoogleCloudApigeeV1ListEndpointAttachmentsResponse - description: Response for ListEndpointAttachments method. - GoogleCloudApigeeV1NodeConfig: - description: >- - NodeConfig for setting the min/max number of nodes associated with the - environment. + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + description: Response for ListDataCollectors. + type: object + id: GoogleCloudApigeeV1ListDataCollectorsResponse + GoogleCloudApigeeV1OptimizedStats: type: object - id: GoogleCloudApigeeV1NodeConfig properties: - currentAggregateNodeCount: - readOnly: true - type: string - description: >- - Output only. The current total number of gateway nodes that each - environment currently has across all instances. - format: int64 - maxNodeCount: - format: int64 - type: string - description: >- - Optional. The maximum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended maximum - number of nodes for that gateway. - minNodeCount: - format: int64 - type: string + Response: + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStatsResponse' description: >- - Optional. The minimum total number of gateway nodes that the is - reserved for all instances that has the specified environment. If - not specified, the default is determined by the recommended minimum - number of nodes for that gateway. - GoogleCloudApigeeV1ListDatastoresResponse: - id: GoogleCloudApigeeV1ListDatastoresResponse + Wraps the `stats` response for JavaScript Optimized Scenario with a + response key. For example: ```{ "Response": { "TimeUnit": [], + "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table + used: edge.api.aaxgroup001.agg_api", "PG + Host:ruappg08-ro.production.apigeeks.net", "query served + by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": + false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" + ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": + "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": + "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }``` + id: GoogleCloudApigeeV1OptimizedStats + GoogleCloudApigeeV1Metadata: properties: - datastores: + notices: + description: >- + List of additional information such as data source, if result was + truncated. For example: ``` "notices": [ "Source:Postgres", "PG + Host:uappg0rw.e2e.apigeeks.net", "query served + by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: + edge.api.uapgroup2.agg_api" ]``` + type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' - description: A list of datastores + type: string + errors: + items: + type: string + description: List of error messages as strings. type: array type: object - description: The response for ListDatastores - GoogleRpcPreconditionFailureViolation: - id: GoogleRpcPreconditionFailureViolation - type: object - description: A message type used to describe a single precondition failure. + description: Encapsulates additional information about query execution. + id: GoogleCloudApigeeV1Metadata + GoogleCloudApigeeV1CanaryEvaluation: + id: GoogleCloudApigeeV1CanaryEvaluation + description: >- + CanaryEvaluation represents the canary analysis between two versions of + the runtime that is serving requests. properties: - type: - description: >- - The type of PreconditionFailure. We recommend using a - service-specific enum type to define the supported precondition - violation subjects. For example, "TOS" for "Terms of Service - violation". + startTime: type: string - subject: - description: >- - The subject, relative to the type, that failed. For example, - "google.com/cloud" relative to the "TOS" type would indicate which - terms of service is being referenced. + description: Required. Start time for the canary evaluation's analysis. + format: google-datetime + endTime: type: string - description: + description: Required. End time for the evaluation's analysis. + format: google-datetime + control: type: string + description: Required. The stable version that is serving requests. + metricLabels: + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluationMetricLabels' description: >- - A description of how the precondition failed. Developers can use - this description to understand how to fix the failure. For example: - "Terms of service not accepted". - GoogleCloudApigeeV1GrpcOperationConfig: - properties: - methods: - items: - type: string - type: array - description: >- - List of unqualified gRPC method names for the proxy to which quota - will be applied. If this field is empty, the Quota will apply to all - operations on the gRPC service defined on the proxy. Example: Given - a proxy that is configured to serve com.petstore.PetService, the - methods com.petstore.PetService.ListPets and - com.petstore.PetService.GetPet would be specified here as simply - ["ListPets", "GetPet"]. - attributes: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - type: array - description: Custom attributes associated with the operation. - quota: - description: >- - Quota parameters to be enforced for the methods and API source - combination. If none are specified, quota enforcement will not be - done. - $ref: '#/components/schemas/GoogleCloudApigeeV1Quota' - service: + Required. Labels used to filter the metrics used for a canary + evaluation. + createTime: + description: Output only. Create time of the canary evaluation. + format: google-datetime + readOnly: true type: string - description: >- - Required. gRPC Service name associated to be associated with the API - proxy, on which quota rules can be applied upon. - apiSource: + treatment: + description: Required. The newer version that is serving requests. + type: string + name: + type: string + readOnly: true + description: Output only. Name of the canary evalution. + verdict: type: string + enumDescriptions: + - Verdict is not available yet. + - No verdict reached. + - Evaluation is not good. + - Evaluation is good. description: >- - Required. Name of the API proxy with which the gRPC operation and - quota are associated. - id: GoogleCloudApigeeV1GrpcOperationConfig + Output only. The resulting verdict of the canary evaluations: NONE, + PASS, or FAIL. + enum: + - VERDICT_UNSPECIFIED + - NONE + - FAIL + - PASS + readOnly: true + state: + enum: + - STATE_UNSPECIFIED + - RUNNING + - SUCCEEDED + readOnly: true + type: string + enumDescriptions: + - No state has been specified. + - The canary evaluation is still in progress. + - The canary evaluation has finished. + description: Output only. The current state of the canary evaluation. type: object + GoogleCloudApigeeV1EnvironmentGroupAttachment: description: >- - Binds the resources in a proxy or remote service with the gRPC operation - and its associated quota enforcement. - GoogleCloudApigeeV1ApiDocResponse: - description: The catalog item resource wrapped with response status, error_code, etc. - id: GoogleCloudApigeeV1ApiDocResponse - type: object + EnvironmentGroupAttachment is a resource which defines an attachment of + an environment to an environment group. properties: - status: - description: Status of the operation. + createdAt: type: string - requestId: - description: Unique ID of the request. + readOnly: true + format: int64 + description: >- + Output only. The time at which the environment group attachment was + created as milliseconds since epoch. + environmentGroupId: type: string - errorCode: - description: Unique error code for the request, if any. + description: Output only. ID of the environment group. + readOnly: true + environment: type: string - data: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' - description: The catalog item resource. - message: + description: Required. ID of the attached environment. + name: type: string - description: Description of the operation. - GoogleCloudApigeeV1EnvironmentGroup: + description: ID of the environment group attachment. + type: object + id: GoogleCloudApigeeV1EnvironmentGroupAttachment + GoogleCloudApigeeV1SecurityAction: type: object - id: GoogleCloudApigeeV1EnvironmentGroup - description: >- - EnvironmentGroup configuration. An environment group is used to group - one or more Apigee environments under a single host name. properties: - name: - type: string - description: ID of the environment group. - hostnames: + apiProxies: + type: array items: type: string - type: array - description: Required. Host names for this environment group. - lastModifiedAt: description: >- - Output only. The time at which the environment group was last - updated as milliseconds since epoch. + Optional. If unset, this would apply to all proxies in the + environment. If set, this action is enforced only if at least one + proxy in the repeated list is deployed at the time of enforcement. + If set, several restrictions are enforced on SecurityActions. There + can be at most 100 enabled actions with proxies set in an env. + Several other restrictions apply on conditions and are detailed + later. + createTime: readOnly: true - format: int64 + description: Output only. The create time for this SecurityAction. + format: google-datetime type: string - createdAt: + updateTime: type: string - format: int64 - readOnly: true + format: google-datetime description: >- - Output only. The time at which the environment group was created as - milliseconds since epoch. - state: + Output only. The update time for this SecurityAction. This reflects + when this SecurityAction changed states. readOnly: true + name: description: >- - Output only. State of the environment group. Values other than - ACTIVE means the resource is not ready to use. + Immutable. This field is ignored during creation as per AIP-133. + Please set the `security_action_id` field in the + CreateSecurityActionRequest when creating a new SecurityAction. + Format: + organizations/{org}/environments/{env}/securityActions/{security_action} + type: string + description: + type: string + description: >- + Optional. An optional user provided description of the + SecurityAction. + conditionConfig: + description: >- + Required. A valid SecurityAction must contain at least one + condition. + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityActionConditionConfig + deny: + description: Deny a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionDeny' + state: + enumDescriptions: + - >- + The default value. This only exists for forward compatibility. A + create request with this value will be rejected. + - >- + An ENABLED SecurityAction is actively enforced if the + `expiration_time` is in the future. + - A disabled SecurityAction is never enforced. + type: string enum: - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - DELETING - - UPDATING - enumDescriptions: - - Resource is in an unspecified state. - - Resource is being created. - - Resource is provisioned and ready to use. - - The resource is being deleted. - - The resource is being updated. + - ENABLED + - DISABLED + description: >- + Required. Only an ENABLED SecurityAction is enforced. An ENABLED + SecurityAction past its expiration time will not be enforced. + ttl: + type: string + format: google-duration + description: Input only. The TTL for this SecurityAction. + allow: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionAllow' + description: Allow a request through if it matches this SecurityAction. + flag: + description: Flag a request through if it matches this SecurityAction. + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionFlag' + expireTime: + description: The expiration for this SecurityAction. + format: google-datetime type: string - GoogleCloudApigeeV1KeyValueEntry: description: >- - Key value map pair where the value represents the data associated with - the corresponding key. **Note**: Supported for Apigee hybrid 1.8.x and - higher. + A SecurityAction is rule that can be enforced at an environment level. + The result is one of: - A denied API call - An explicitly allowed API + call - A flagged API call (HTTP headers added before the target receives + it) At least one condition is required to create a SecurityAction. + id: GoogleCloudApigeeV1SecurityAction + GoogleCloudApigeeV1KeyAliasReference: properties: - name: + reference: description: >- - Resource URI that can be used to identify the scope of the key value - map entries. + Reference name in the following format: + `organizations/{org}/environments/{env}/references/{reference}` type: string - value: - description: >- - Required. Data or payload that is being retrieved and associated - with the unique key. + aliasId: + description: Alias ID. Must exist in the keystore referred to by the reference. type: string + id: GoogleCloudApigeeV1KeyAliasReference type: object - id: GoogleCloudApigeeV1KeyValueEntry - GoogleCloudApigeeV1ResourceConfig: - type: object - id: GoogleCloudApigeeV1ResourceConfig + GoogleCloudApigeeV1GenerateDownloadUrlResponse: + description: Response for GenerateDownloadUrl method. properties: - location: - type: string - description: Location of the resource as a URI. - name: - type: string + downloadUri: description: >- - Resource name in the following format: - `organizations/{org}/environments/{env}/resourcefiles/{type}/{file}/revisions/{rev}` - Only environment-scoped resource files are supported. - GoogleCloudApigeeV1AdvancedApiOpsConfig: - description: Configuration for the Advanced API Ops add-on. + The Google Cloud Storage signed URL that can be used to download the + Archive zip file. + type: string type: object + id: GoogleCloudApigeeV1GenerateDownloadUrlResponse + GoogleCloudApigeeV1ListAppGroupAppsResponse: + description: Response for ListAppGroupApps properties: - enabled: - description: Flag that specifies whether the Advanced API Ops add-on is enabled. - type: boolean - id: GoogleCloudApigeeV1AdvancedApiOpsConfig - GoogleCloudApigeeV1ListDeploymentsResponse: - properties: - deployments: - description: List of deployments. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + nextPageToken: + description: >- + Token that can be sent as `next_page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + appGroupApps: type: array - id: GoogleCloudApigeeV1ListDeploymentsResponse + description: List of AppGroup apps and their credentials. + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + id: GoogleCloudApigeeV1ListAppGroupAppsResponse type: object - GoogleCloudApigeeV1ListEnvironmentResourcesResponse: - id: GoogleCloudApigeeV1ListEnvironmentResourcesResponse + GoogleCloudApigeeV1InstanceDeploymentStatus: type: object properties: - resourceFile: + deployedRoutes: items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute + description: >- + Current routes deployed in the ingress routing table. A route which + is missing will appear in `missing_routes`. type: array - description: List of resources files. - description: Response for ListEnvironmentResources - GoogleCloudApigeeV1SecuritySettings: - id: GoogleCloudApigeeV1SecuritySettings - type: object - description: >- - SecuritySettings reflects the current state of the SecuritySettings - feature. - properties: - name: + instance: type: string - description: >- - Identifier. Full resource name is always - `organizations/{org}/securitySettings`. - mlRetrainingFeedbackEnabled: - type: boolean - description: >- - Optional. If true the user consents to the use of ML models for - Abuse detection. + description: ID of the instance reporting the status. + deployedRevisions: + items: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision + type: array + description: Revisions currently deployed in MPs. + id: GoogleCloudApigeeV1InstanceDeploymentStatus + description: The status of a deployment as reported by a single instance. GoogleCloudApigeeV1ListApiCategoriesResponse: + description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' properties: status: - type: string description: Status of the operation. - data: - type: array - description: The API category resources. - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + type: string + requestId: + description: Unique ID of the request. + type: string message: description: Description of the operation. type: string errorCode: - description: Unique error code for the request, if any. - type: string - requestId: - type: string - description: Unique ID of the request. - type: object - id: GoogleCloudApigeeV1ListApiCategoriesResponse - description: 'The response for `ListApiCategoriesRequest`. Next ID: 6' - GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest: - type: object - properties: {} - id: GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest - description: Request for ExpireDeveloperSubscription. - GoogleCloudApigeeV1ListAppGroupsResponse: - description: >- - ListAppGroupsResponse contains the 0 or more AppGroups, along with the - optional page token and the total count of apps. - properties: - nextPageToken: - description: >- - Token that can be sent as `next_page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. type: string - appGroups: - items: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' - description: List of AppGroups. - type: array - totalSize: - description: Total count of AppGroups. - type: integer - format: int32 - id: GoogleCloudApigeeV1ListAppGroupsResponse - type: object - GoogleCloudApigeeV1SyncAuthorization: - properties: - identities: + description: Unique error code for the request, if any. + data: items: - type: string + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + description: The API category resources. type: array - description: >- - Required. Array of service accounts to grant access to control plane - resources, each specified using the following format: - `serviceAccount:` service-account-name. The service-account-name is - formatted like an email address. For example: - `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` - You might specify multiple service accounts, for example, if you - have multiple environments and wish to assign a unique service - account to each one. The service accounts must have **Apigee - Synchronizer Manager** role. See also [Create service - accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). - etag: - type: string - format: byte - description: >- - Entity tag (ETag) used for optimistic concurrency control as a way - to help prevent simultaneous updates from overwriting each other. - For example, when you call - [getSyncAuthorization](organizations/getSyncAuthorization) an ETag - is returned in the response. Pass that ETag when calling the - [setSyncAuthorization](organizations/setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the - ETag in the call to `setSyncAuthorization`, then the existing - authorization is overwritten indiscriminately. **Note**: We strongly - recommend that you use the ETag in the read-modify-write cycle to - avoid race conditions. type: object - id: GoogleCloudApigeeV1SyncAuthorization - GoogleCloudApigeeV1QueryMetadata: + id: GoogleCloudApigeeV1ListApiCategoriesResponse + GoogleCloudApigeeV1Credential: type: object + id: GoogleCloudApigeeV1Credential properties: - dimensions: - items: - type: string - description: Dimensions of the AsyncQuery. - type: array - timeUnit: - type: string - description: Query GroupBy time unit. - startTimestamp: - type: string - description: Start timestamp of the query range. - endTimestamp: + consumerSecret: + description: Secret key. type: string - description: End timestamp of the query range. - outputFormat: - description: Output format. + consumerKey: type: string - metrics: - description: >- - Metrics of the AsyncQuery. Example: - ["name:message_count,func:sum,alias:sum_message_count"] + description: Consumer key. + apiProducts: type: array + description: List of API products this credential can be used for. items: - type: string - id: GoogleCloudApigeeV1QueryMetadata - GoogleCloudApigeeV1AnalyticsConfig: - properties: - updateTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The latest update time. - state: - enum: - - ADDON_STATE_UNSPECIFIED - - ENABLING - - ENABLED - - DISABLING - - DISABLED - type: string - enumDescriptions: - - Default value. - - Add-on is in progress of enabling. - - Add-on is fully enabled and ready to use. - - Add-on is in progress of disabling. - - Add-on is fully disabled. - readOnly: true - description: Output only. The state of the Analytics add-on. - expireTimeMillis: - format: int64 + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProductRef' + scopes: description: >- - Output only. Time at which the Analytics add-on expires in - milliseconds since epoch. If unspecified, the add-on will never - expire. - readOnly: true - type: string - enabled: - description: Whether the Analytics add-on is enabled. - type: boolean - description: Configuration for the Analytics add-on. - type: object - id: GoogleCloudApigeeV1AnalyticsConfig - GoogleCloudApigeeV1ListDataCollectorsResponse: - type: object - description: Response for ListDataCollectors. - id: GoogleCloudApigeeV1ListDataCollectorsResponse - properties: - dataCollectors: + List of scopes to apply to the app. Specified scopes must already + exist on the API product that you associate with the app. type: array items: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' - description: Data collectors in the specified organization. - nextPageToken: + type: string + status: type: string description: >- - Page token that you can include in a ListDataCollectors request to - retrieve the next page. If omitted, no subsequent pages exist. - GoogleCloudApigeeV1Query: - id: GoogleCloudApigeeV1Query - type: object - properties: - name: - type: string - description: Asynchronous Query Name. - reportDefinitionId: + Status of the credential. Valid values include `approved` or + `revoked`. + expiresAt: + description: Time the credential will expire in milliseconds since epoch. type: string - description: Asynchronous Report ID. - timeRange: - type: any - description: >- - Required. Time range for the query. Can use the following predefined - strings to specify the time range: `last60minutes` `last24hours` - `last7days` Or, specify the timeRange as a structure describing - start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": - "2018-08-01T00:18:00Z" } - outputFormat: - description: >- - Valid values include: `csv` or `json`. Defaults to `json`. Note: - Configure the delimiter for CSV output using the csvDelimiter - property. + format: int64 + issuedAt: + format: int64 + description: Time the credential was issued in milliseconds since epoch. type: string - csvDelimiter: + attributes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + description: List of attributes associated with this credential. + GoogleCloudApigeeV1SecurityActionFlag: + description: The message that should be set in the case of a Flag action. + id: GoogleCloudApigeeV1SecurityActionFlag + type: object + properties: + headers: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionHttpHeader' description: >- - Delimiter used in the CSV file, if `outputFormat` is set to `csv`. - Defaults to the `,` (comma) character. Supported delimiter - characters include comma (`,`), pipe (`|`), and tab (`\t`). - type: string - dimensions: + Optional. A list of HTTP headers to be sent to the target in case of + a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least + one is mandatory. + type: array + GoogleCloudApigeeV1Schema: + properties: + meta: type: array description: >- - A list of dimensions. - https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + Additional metadata associated with schema. This is a legacy field + and usually consists of an empty array of strings. items: type: string - metrics: + dimensions: + description: List of schema fields grouped as dimensions. items: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryMetric' - description: A list of Metrics. + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' type: array - groupByTimeUnit: - description: >- - Time unit used to group the result set. Valid values include: - second, minute, hour, day, week, or month. If a query includes - groupByTimeUnit, then the result is an aggregation based on the - specified time unit and the resultant timestamp does not include - milliseconds precision. If a query omits groupByTimeUnit, then the - resultant timestamp includes milliseconds precision. - type: string - limit: - description: Maximum number of rows that can be returned in the result. - format: int32 - type: integer - envgroupHostname: - description: >- - Hostname needs to be specified if query intends to run at host - level. This field is only allowed when query is submitted by - CreateHostAsyncQuery where analytics data will be grouped by - organization and hostname. - type: string - filter: + metrics: + items: + $ref: '#/components/schemas/GoogleCloudApigeeV1SchemaSchemaElement' description: >- - Boolean expression that can be used to filter data. Filter - expressions can be combined using AND/OR terms and should be fully - parenthesized to avoid ambiguity. See Analytics metrics, dimensions, - and filters reference - https://docs.apigee.com/api-platform/analytics/analytics-reference - for more information on the fields available to filter on. For more - information on the tokens that you use to build filter expressions, - see Filter expression syntax. - https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax - type: string + List of schema fields grouped as dimensions that can be used with an + aggregate function such as `sum`, `avg`, `min`, and `max`. + type: array + description: Response for Schema call + type: object + id: GoogleCloudApigeeV1Schema parameters: - callback: - description: JSONP - in: query - name: callback - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -8733,37 +8735,47 @@ components: name: key schema: type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + access_token: + description: OAuth access token. in: query - name: prettyPrint + name: access_token schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. + type: string + alt: + description: Data format for response. in: query - name: fields + name: alt schema: type: string - access_token: - description: OAuth access token. + enum: + - json + - media + - proto + callback: + description: JSONP in: query - name: access_token + name: callback schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: quotaUser + name: fields schema: type: string uploadType: @@ -8772,3081 +8784,3081 @@ components: name: uploadType schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - alt: - description: Data format for response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: alt + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser schema: type: string - enum: - - json - - media - - proto x-stackQL-resources: - apps: - id: google.apigee.apps - name: apps - title: Apps + organizations: + id: google.apigee.organizations + name: organizations + title: Organizations + methods: + organizations_create: + operation: + $ref: '#/paths/~1v1~1organizations/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_list: + operation: + $ref: '#/paths/~1v1~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_update: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_delete: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_get: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_set_sync_authorization: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_set_addons: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/organizations_get + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/organizations_list + insert: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/organizations_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/organizations_update + delete: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/organizations_delete + deployed_ingress_config: + id: google.apigee.deployed_ingress_config + name: deployed_ingress_config + title: Deployed_ingress_config methods: - _organizations_apps_list: - operation: &ref_1 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.app - organizations_apps_list: - operation: *ref_1 - response: *ref_2 - organizations_apps_get: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_apps_delete: + organizations_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_generate_key_pair_or_update_developer_app_status: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config + insert: [] + update: [] + replace: [] + delete: [] + security_settings: + id: google.apigee.security_settings + name: security_settings + title: Security_settings + methods: + organizations_get_security_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_update: + organizations_update_security_settings: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/security_settings/methods/organizations_update_security_settings + replace: [] + delete: [] + runtime_config: + id: google.apigee.runtime_config + name: runtime_config + title: Runtime_config + methods: + organizations_get_runtime_config: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_list: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config + insert: [] + update: [] + replace: [] + delete: [] + project_mapping: + id: google.apigee.project_mapping + name: project_mapping + title: Project_mapping + methods: + organizations_get_project_mapping: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get + #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping + insert: [] + update: [] + replace: [] + delete: [] + sync_authorization: + id: google.apigee.sync_authorization + name: sync_authorization + title: Sync_authorization + methods: + organizations_get_sync_authorization: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sync_authorization/methods/organizations_get_sync_authorization + insert: [] + update: [] + replace: [] + delete: [] + apicategories: + id: google.apigee.apicategories + name: apicategories + title: Apicategories + methods: + organizations_sites_apicategories_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_update: + organizations_sites_apicategories_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_get: + organizations_sites_apicategories_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_delete: + organizations_sites_apicategories_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_create: + organizations_sites_apicategories_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_appgroups_apps_list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.appGroupApps - organizations_appgroups_apps_list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_get - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_apps_list + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list insert: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create update: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete - - $ref: >- - #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete - deployments: - id: google.apigee.deployments - name: deployments - title: Deployments + #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete + apidocs: + id: google.apigee.apidocs + name: apidocs + title: Apidocs methods: - organizations_deployments_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_revisions_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_deployments_list: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_sharedflows_deployments_list: + organizations_sites_apidocs_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_deployments_list: + organizations_sites_apidocs_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_deployments_list: + organizations_sites_apidocs_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: + organizations_sites_apidocs_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deployments_generate_deploy_change_report: + organizations_sites_apidocs_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_deployments_list: + objectKey: $.data + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + delete: + - $ref: >- + #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete + apidocs_documentation: + id: google.apigee.apidocs_documentation + name: apidocs_documentation + title: Apidocs_documentation + methods: + organizations_sites_apidocs_get_documentation: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_deployments_list: + organizations_sites_apidocs_update_documentation: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_update_documentation + replace: [] delete: [] - attributes: - id: google.apigee.attributes - name: attributes - title: Attributes + environments: + id: google.apigee.environments + name: environments + title: Environments methods: - organizations_developers_attributes_delete: + organizations_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_get: + organizations_environments_modify_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_attributes_list: + organizations_environments_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_list: + organizations_environments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_delete: + organizations_environments_unsubscribe: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_attributes_get: + organizations_environments_subscribe: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_delete: + organizations_environments_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_security_profiles_environments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_get: + organizations_security_profiles_environments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes_list: + organizations_security_profiles_environments_compute_environment_scores: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_get - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_list - - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_get + #/components/x-stackQL-resources/environments/methods/organizations_environments_get + insert: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_list + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_list - insert: [] + #/components/x-stackQL-resources/environments/methods/organizations_environments_create update: [] - delete: + replace: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_delete + #/components/x-stackQL-resources/environments/methods/organizations_environments_update + delete: - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_delete + #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete - $ref: >- - #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_delete - attributes_developer_attribute: - id: google.apigee.attributes_developer_attribute - name: attributes_developer_attribute - title: Attributes_developer_attribute + #/components/x-stackQL-resources/environments/methods/organizations_environments_delete + environments_environment: + id: google.apigee.environments_environment + name: environments_environment + title: Environments_environment methods: - organizations_developers_attributes_update_developer_attribute: + organizations_environments_update_environment: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_environment/methods/organizations_environments_update_environment + replace: [] delete: [] - developers: - id: google.apigee.developers - name: developers - title: Developers + environments_debugmask: + id: google.apigee.environments_debugmask + name: environments_debugmask + title: Environments_debugmask methods: - organizations_developers_attributes: + organizations_environments_get_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_create: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_set_developer_status: + organizations_environments_update_debugmask: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_update: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_update_debugmask + replace: [] + delete: [] + environments_iam_policies: + id: google.apigee.environments_iam_policies + name: environments_iam_policies + title: Environments_iam_policies + methods: + organizations_environments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_get: + organizations_environments_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_delete: + objectKey: $.bindings + organizations_environments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_get - - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_list - insert: - - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_create - update: - - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_update - delete: + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy + insert: [] + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/developers/methods/organizations_developers_delete - subscriptions: - id: google.apigee.subscriptions - name: subscriptions - title: Subscriptions + #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_set_iam_policy + delete: [] + environments_addons_config: + id: google.apigee.environments_addons_config + name: environments_addons_config + title: Environments_addons_config methods: - organizations_developers_subscriptions_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_subscriptions_list: + organizations_environments_get_addons_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config + insert: [] + update: [] + replace: [] + delete: [] + environments_trace_config: + id: google.apigee.environments_trace_config + name: environments_trace_config + title: Environments_trace_config + methods: + organizations_environments_update_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_subscriptions_expire: + organizations_environments_get_trace_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get - - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list - insert: + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create - update: [] + #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_update_trace_config + replace: [] delete: [] - balance: - id: google.apigee.balance - name: balance - title: Balance + environments_deployed_config: + id: google.apigee.environments_deployed_config + name: environments_deployed_config + title: Environments_deployed_config methods: - organizations_developers_balance_credit: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_developers_balance_adjust: + organizations_environments_get_deployed_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config insert: [] update: [] + replace: [] delete: [] - attributes_developer_app_attribute: - id: google.apigee.attributes_developer_app_attribute - name: attributes_developer_app_attribute - title: Attributes_developer_app_attribute + environments_security_actions_config: + id: google.apigee.environments_security_actions_config + name: environments_security_actions_config + title: Environments_security_actions_config methods: - organizations_developers_apps_attributes_update_developer_app_attribute: + organizations_environments_get_security_actions_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_update_security_actions_config: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_update_security_actions_config + replace: [] delete: [] - apiproducts: - id: google.apigee.apiproducts - name: apiproducts - title: Apiproducts + environments_api_security_runtime_config: + id: google.apigee.environments_api_security_runtime_config + name: environments_api_security_runtime_config + title: Environments_api_security_runtime_config methods: - organizations_developers_apps_keys_apiproducts_delete: + organizations_environments_get_api_security_runtime_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_apiproducts_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config + insert: [] + update: [] + replace: [] + delete: [] + flowhooks: + id: google.apigee.flowhooks + name: flowhooks + title: Flowhooks + methods: + organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_attributes: + organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_update: + organizations_environments_flowhooks_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get + insert: [] + update: [] + replace: [] + delete: [] + targetservers: + id: google.apigee.targetservers + name: targetservers + title: Targetservers + methods: + organizations_environments_targetservers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_delete: + organizations_environments_targetservers_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_create: + organizations_environments_targetservers_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_list: + organizations_environments_targetservers_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get insert: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create - update: + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update delete: - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete - - $ref: >- - #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete - apiproducts_developer_app_key_api_product: - id: google.apigee.apiproducts_developer_app_key_api_product - name: apiproducts_developer_app_key_api_product - title: Apiproducts_developer_app_key_api_product - methods: - organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - create: - id: google.apigee.create - name: create - title: Create + #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete + keystores: + id: google.apigee.keystores + name: keystores + title: Keystores methods: - organizations_developers_apps_keys_create_create: + organizations_environments_keystores_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create - update: [] - delete: [] - keys: - id: google.apigee.keys - name: keys - title: Keys - methods: - organizations_developers_apps_keys_replace_developer_app_key: + organizations_environments_keystores_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_get: + organizations_environments_keystores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get + insert: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete + aliases: + id: google.apigee.aliases + name: aliases + title: Aliases + methods: + organizations_environments_keystores_aliases_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_apps_keys_create: + organizations_environments_keystores_aliases_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_create: + organizations_environments_keystores_aliases_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_delete: + organizations_environments_keystores_aliases_csr: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_apps_keys_get: + organizations_environments_keystores_aliases_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get insert: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create - - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create update: [] - delete: + replace: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update + delete: - $ref: >- - #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete - keys_developer_app_key: - id: google.apigee.keys_developer_app_key - name: keys_developer_app_key - title: Keys_developer_app_key + #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete + aliases_certificate: + id: google.apigee.aliases_certificate + name: aliases_certificate + title: Aliases_certificate methods: - organizations_developers_apps_keys_update_developer_app_key: + organizations_environments_keystores_aliases_get_certificate: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate insert: [] update: [] + replace: [] delete: [] - developers_monetization_config: - id: google.apigee.developers_monetization_config - name: developers_monetization_config - title: Developers_monetization_config + caches: + id: google.apigee.caches + name: caches + title: Caches methods: - organizations_developers_get_monetization_config: + organizations_environments_caches_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_developers_update_monetization_config: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete + stats: + id: google.apigee.stats + name: stats + title: Stats + methods: + organizations_environments_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config + #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get insert: [] update: [] + replace: [] delete: [] - developers_balance: - id: google.apigee.developers_balance - name: developers_balance - title: Developers_balance + deployments: + id: google.apigee.deployments + name: deployments + title: Deployments methods: - organizations_developers_get_balance: + organizations_environments_sharedflows_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_deployments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_deployments_generate_deploy_change_report: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateDeployChangeReport/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_deployments_generate_undeploy_change_report: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments:generateUndeployChangeReport/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance - insert: [] - update: [] - delete: [] - appgroups: - id: google.apigee.appgroups - name: appgroups - title: Appgroups - methods: - organizations_appgroups_update: + organizations_sharedflows_revisions_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_delete: + organizations_sharedflows_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_get: + organizations_deployments_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_appgroups_create: + organizations_apis_deployments_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_appgroups_list: - operation: &ref_5 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' - response: &ref_6 + organizations_apis_revisions_deployments_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.appGroups - organizations_appgroups_list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get + #/components/x-stackQL-resources/deployments/methods/organizations_environments_sharedflows_deployments_list - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list - insert: + #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_get - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create - update: + #/components/x-stackQL-resources/deployments/methods/organizations_environments_apis_deployments_list - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update - delete: + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_revisions_deployments_list - $ref: >- - #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete - keys_app_group_app_key: - id: google.apigee.keys_app_group_app_key - name: keys_app_group_app_key - title: Keys_app_group_app_key + #/components/x-stackQL-resources/deployments/methods/organizations_apis_revisions_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_environments_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_sharedflows_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_apis_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/organizations_deployments_list + insert: [] + update: [] + replace: [] + delete: [] + revisions: + id: google.apigee.revisions + name: revisions + title: Revisions methods: - organizations_appgroups_apps_keys_update_app_group_app_key: + organizations_environments_sharedflows_revisions_deploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - apiproducts_app_group_app_key_api_product: - id: google.apigee.apiproducts_app_group_app_key_api_product - name: apiproducts_app_group_app_key_api_product - title: Apiproducts_app_group_app_key_api_product - methods: - organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: + organizations_environments_sharedflows_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - host_queries_result: - id: google.apigee.host_queries_result - name: host_queries_result - title: Host_queries_result - methods: - organizations_host_queries_get_result: + organizations_environments_apis_revisions_undeploy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result - insert: [] - update: [] - delete: [] - host_queries: - id: google.apigee.host_queries - name: host_queries - title: Host_queries - methods: - organizations_host_queries_list: + organizations_environments_apis_revisions_deploy: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_create: + organizations_sharedflows_revisions_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_host_queries_get: + organizations_sharedflows_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get - - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list - insert: - - $ref: >- - #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create - update: [] - delete: [] - host_queries_result_view: - id: google.apigee.host_queries_result_view - name: host_queries_result_view - title: Host_queries_result_view - methods: - organizations_host_queries_get_result_view: + organizations_apis_revisions_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apis_revisions_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get insert: [] update: [] - delete: [] - host_stats: - id: google.apigee.host_stats - name: host_stats - title: Host_stats + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete + - $ref: >- + #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete + revisions_deployments: + id: google.apigee.revisions_deployments + name: revisions_deployments + title: Revisions_deployments methods: - organizations_host_stats_get: + organizations_environments_sharedflows_revisions_get_deployments: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_get_deployments: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments + - $ref: >- + #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments insert: [] update: [] + replace: [] delete: [] - entries: - id: google.apigee.entries - name: entries - title: Entries + exports: + id: google.apigee.exports + name: exports + title: Exports methods: - organizations_keyvaluemaps_entries_update: + organizations_environments_analytics_exports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_delete: + organizations_environments_analytics_exports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_entries_get: + organizations_environments_analytics_exports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_keyvaluemaps_entries_list: - operation: &ref_7 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get - response: &ref_8 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_keyvaluemaps_entries_list: - operation: *ref_7 - response: *ref_8 - organizations_keyvaluemaps_entries_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get + - $ref: >- + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create + update: [] + replace: [] + delete: [] + admin_schemav2: + id: google.apigee.admin_schemav2 + name: admin_schemav2 + title: Admin_schemav2 + methods: + organizations_environments_analytics_admin_get_schemav2: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 + insert: [] + update: [] + replace: [] + delete: [] + deployments_iam_policies: + id: google.apigee.deployments_iam_policies + name: deployments_iam_policies + title: Deployments_iam_policies + methods: + organizations_environments_deployments_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:testIamPermissions/post response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_apis_keyvaluemaps_entries_list: - operation: &ref_9 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_apis_keyvaluemaps_entries_list: - operation: *ref_9 - response: *ref_10 - organizations_apis_keyvaluemaps_entries_update: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_deployments_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_get: + organizations_environments_deployments_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployments~1{deploymentsId}:getIamPolicy/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_entries_delete: + objectKey: $.bindings + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/organizations_environments_deployments_set_iam_policy + delete: [] + keyvaluemaps: + id: google.apigee.keyvaluemaps + name: keyvaluemaps + title: Keyvaluemaps + methods: + organizations_environments_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_update: + organizations_environments_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_get: + organizations_keyvaluemaps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_delete: + organizations_keyvaluemaps_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_entries_create: + organizations_apis_keyvaluemaps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_keyvaluemaps_entries_list: - operation: &ref_11 + organizations_apis_keyvaluemaps_delete: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get - response: &ref_12 + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keyValueEntries - organizations_environments_keyvaluemaps_entries_list: - operation: *ref_11 - response: *ref_12 sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list + select: [] insert: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create - update: - - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create + update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete - $ref: >- - #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete - keyvaluemaps: - id: google.apigee.keyvaluemaps - name: keyvaluemaps - title: Keyvaluemaps + #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete + entries: + id: google.apigee.entries + name: entries + title: Entries methods: - organizations_keyvaluemaps_create: + organizations_environments_keyvaluemaps_entries_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_keyvaluemaps_delete: + organizations_environments_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_create: + organizations_environments_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_keyvaluemaps_delete: + organizations_environments_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_delete: + organizations_environments_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keyvaluemaps_create: + objectKey: $.keyValueEntries + organizations_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keyvaluemaps/post + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_create - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_create - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_create - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_apis_keyvaluemaps_delete - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_environments_keyvaluemaps_delete - - $ref: >- - #/components/x-stackQL-resources/keyvaluemaps/methods/organizations_keyvaluemaps_delete - attributes_api_product_attribute: - id: google.apigee.attributes_api_product_attribute - name: attributes_api_product_attribute - title: Attributes_api_product_attribute - methods: - organizations_apiproducts_attributes_update_api_product_attribute: + organizations_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - rateplans: - id: google.apigee.rateplans - name: rateplans - title: Rateplans - methods: - organizations_apiproducts_rateplans_create: + organizations_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_list: + organizations_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_get: + organizations_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_update: + objectKey: $.keyValueEntries + organizations_apis_keyvaluemaps_entries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apiproducts_rateplans_delete: + organizations_apis_keyvaluemaps_entries_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list - insert: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create - update: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update - delete: - - $ref: >- - #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete - endpoint_attachments: - id: google.apigee.endpoint_attachments - name: endpoint_attachments - title: Endpoint_attachments - methods: - organizations_endpoint_attachments_delete: + organizations_apis_keyvaluemaps_entries_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries~1{entriesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_endpoint_attachments_get: + organizations_apis_keyvaluemaps_entries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_endpoint_attachments_list: - operation: &ref_13 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get - response: &ref_14 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.endpointAttachments - organizations_endpoint_attachments_list: - operation: *ref_13 - response: *ref_14 - organizations_endpoint_attachments_create: + organizations_apis_keyvaluemaps_entries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1keyvaluemaps~1{keyvaluemapsId}~1entries/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.keyValueEntries sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_get - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_list + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_get + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_list + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_list insert: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_create + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_create update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_update + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_update delete: - $ref: >- - #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete - apis: - id: google.apigee.apis - name: apis - title: Apis + #/components/x-stackQL-resources/entries/methods/organizations_environments_keyvaluemaps_entries_delete + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_apis_keyvaluemaps_entries_delete + - $ref: >- + #/components/x-stackQL-resources/entries/methods/organizations_keyvaluemaps_entries_delete + references: + id: google.apigee.references + name: references + title: References methods: - organizations_apis_list: - operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_create: + organizations_environments_references_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_delete: + organizations_environments_references_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_get: + organizations_environments_references_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_apis_patch: + organizations_environments_references_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_get - - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_list + #/components/x-stackQL-resources/references/methods/organizations_environments_references_get insert: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_create - update: + #/components/x-stackQL-resources/references/methods/organizations_environments_references_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_patch + #/components/x-stackQL-resources/references/methods/organizations_environments_references_update delete: - $ref: >- - #/components/x-stackQL-resources/apis/methods/organizations_apis_delete - revisions: - id: google.apigee.revisions - name: revisions - title: Revisions + #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete + security_reports_result: + id: google.apigee.security_reports_result + name: security_reports_result + title: Security_reports_result methods: - organizations_apis_revisions_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_apis_revisions_delete: + organizations_environments_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_undeploy: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result + insert: [] + update: [] + replace: [] + delete: [] + security_reports: + id: google.apigee.security_reports + name: security_reports + title: Security_reports + methods: + organizations_environments_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_sharedflows_revisions_deploy: + organizations_environments_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_deploy: + organizations_environments_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_undeploy: + objectKey: $.securityReports + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create + update: [] + replace: [] + delete: [] + security_reports_result_view: + id: google.apigee.security_reports_result_view + name: security_reports_result_view + title: Security_reports_result_view + methods: + organizations_environments_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view + insert: [] + update: [] + replace: [] + delete: [] + data: + id: google.apigee.data + name: data + title: Data + methods: + organizations_environments_apis_revisions_debugsessions_data_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_revisions_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get + insert: [] + update: [] + replace: [] + delete: [] + debugsessions_data: + id: google.apigee.debugsessions_data + name: debugsessions_data + title: Debugsessions_data + methods: + organizations_environments_apis_revisions_debugsessions_delete_data: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_get - - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_get + select: [] insert: [] update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_apis_revisions_delete - - $ref: >- - #/components/x-stackQL-resources/revisions/methods/organizations_sharedflows_revisions_delete - revisions_api_proxy_revision: - id: google.apigee.revisions_api_proxy_revision - name: revisions_api_proxy_revision - title: Revisions_api_proxy_revision + #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data + debugsessions: + id: google.apigee.debugsessions + name: debugsessions + title: Debugsessions methods: - organizations_apis_revisions_update_api_proxy_revision: + organizations_environments_apis_revisions_debugsessions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + organizations_environments_apis_revisions_debugsessions_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_apis_revisions_debugsessions_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create update: [] + replace: [] delete: [] - reports: - id: google.apigee.reports - name: reports - title: Reports + resourcefiles: + id: google.apigee.resourcefiles + name: resourcefiles + title: Resourcefiles methods: - organizations_reports_update: + organizations_environments_resourcefiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_get: + organizations_environments_resourcefiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_delete: + organizations_environments_resourcefiles_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_create: + organizations_environments_resourcefiles_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post response: mediaType: application/json openAPIDocKey: '200' - organizations_reports_list: + organizations_environments_resourcefiles_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_get + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_get - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_list + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list insert: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_create - update: + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_update + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_update delete: - $ref: >- - #/components/x-stackQL-resources/reports/methods/organizations_reports_delete - security_profiles: - id: google.apigee.security_profiles - name: security_profiles - title: Security_profiles + #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_delete + resourcefiles_environment_resources: + id: google.apigee.resourcefiles_environment_resources + name: resourcefiles_environment_resources + title: Resourcefiles_environment_resources methods: - organizations_security_profiles_create: + organizations_environments_resourcefiles_list_environment_resources: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/resourcefiles_environment_resources/methods/organizations_environments_resourcefiles_list_environment_resources + insert: [] + update: [] + replace: [] + delete: [] + archive_deployments: + id: google.apigee.archive_deployments + name: archive_deployments + title: Archive_deployments + methods: + organizations_environments_archive_deployments_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_archive_deployments_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_archive_deployments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_security_profiles_list: - operation: &ref_15 + organizations_environments_archive_deployments_create: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get - response: &ref_16 + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles - organizations_security_profiles_list: - operation: *ref_15 - response: *ref_16 - organizations_security_profiles_delete: + organizations_environments_archive_deployments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_patch: + objectKey: $.archiveDeployments + organizations_environments_archive_deployments_generate_upload_url: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_get: + organizations_environments_archive_deployments_generate_download_url: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list insert: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create update: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_patch + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_delete - security_profiles_revisions: - id: google.apigee.security_profiles_revisions - name: security_profiles_revisions - title: Security_profiles_revisions + #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete + optimized_stats: + id: google.apigee.optimized_stats + name: optimized_stats + title: Optimized_stats methods: - _organizations_security_profiles_list_revisions: - operation: &ref_17 + organizations_environments_optimized_stats_get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get - response: &ref_18 + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1optimizedStats~1{optimizedStatsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityProfiles - organizations_security_profiles_list_revisions: - operation: *ref_17 - response: *ref_18 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions + #/components/x-stackQL-resources/optimized_stats/methods/organizations_environments_optimized_stats_get insert: [] update: [] + replace: [] delete: [] - environments: - id: google.apigee.environments - name: environments - title: Environments + overrides: + id: google.apigee.overrides + name: overrides + title: Overrides methods: - organizations_security_profiles_environments_delete: + organizations_environments_trace_config_overrides_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_compute_environment_scores: + organizations_environments_trace_config_overrides_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments~1{environmentsId}:computeEnvironmentScores/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_security_profiles_environments_create: + organizations_environments_trace_config_overrides_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}~1environments/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_modify_environment: + organizations_environments_trace_config_overrides_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update: + objectKey: $.traceConfigOverrides + organizations_environments_trace_config_overrides_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get + - $ref: >- + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list + insert: + - $ref: >- + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create + update: + - $ref: >- + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete + security_actions: + id: google.apigee.security_actions + name: security_actions + title: Security_actions + methods: + organizations_environments_security_actions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get: + objectKey: $.securityActions + organizations_environments_security_actions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_create: + organizations_environments_security_actions_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1environments/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_unsubscribe: + organizations_environments_security_actions_enable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:unsubscribe/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_subscribe: + organizations_environments_security_actions_disable: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:subscribe/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_get + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get + - $ref: >- + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list insert: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_create + #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create + update: [] + replace: [] + delete: [] + security_incidents: + id: google.apigee.security_incidents + name: security_incidents + title: Security_incidents + methods: + organizations_environments_security_incidents_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_security_incidents_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_environments_security_incidents_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.securityIncidents + organizations_environments_security_incidents_batch_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_create - update: + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_update - delete: + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_security_profiles_environments_delete + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch - $ref: >- - #/components/x-stackQL-resources/environments/methods/organizations_environments_delete - datastores: - id: google.apigee.datastores - name: datastores - title: Datastores + #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_batch_update + replace: [] + delete: [] + security_stats: + id: google.apigee.security_stats + name: security_stats + title: Security_stats methods: - organizations_analytics_datastores_test: + organizations_environments_security_stats_query_tabular_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_update: + organizations_environments_security_stats_query_time_series_stats: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_delete: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + queries_result: + id: google.apigee.queries_result + name: queries_result + title: Queries_result + methods: + organizations_environments_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result + insert: [] + update: [] + replace: [] + delete: [] + queries: + id: google.apigee.queries + name: queries + title: Queries + methods: + organizations_environments_queries_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_list: + organizations_environments_queries_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get response: mediaType: application/json openAPIDocKey: '200' - organizations_analytics_datastores_create: + organizations_environments_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_list insert: - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create - update: - - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_update - delete: - - $ref: >- - #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete - envgroups_deployed_ingress_config: - id: google.apigee.envgroups_deployed_ingress_config - name: envgroups_deployed_ingress_config - title: Envgroups_deployed_ingress_config + #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create + update: [] + replace: [] + delete: [] + queries_resulturl: + id: google.apigee.queries_resulturl + name: queries_resulturl + title: Queries_resulturl methods: - organizations_envgroups_get_deployed_ingress_config: + organizations_environments_queries_get_resulturl: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config + #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl insert: [] update: [] + replace: [] delete: [] - envgroups: - id: google.apigee.envgroups - name: envgroups - title: Envgroups + addons_config: + id: google.apigee.addons_config + name: addons_config + title: Addons_config methods: - organizations_envgroups_get: + organizations_environments_addons_config_set_addon_enablement: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_delete: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + endpoint_attachments: + id: google.apigee.endpoint_attachments + name: endpoint_attachments + title: Endpoint_attachments + methods: + organizations_endpoint_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_patch: + organizations_endpoint_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments~1{endpointAttachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_envgroups_list: - operation: &ref_19 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' - response: &ref_20 + organizations_endpoint_attachments_create: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.environmentGroups - organizations_envgroups_list: - operation: *ref_19 - response: *ref_20 - organizations_envgroups_create: + organizations_endpoint_attachments_list: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1endpointAttachments/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.endpointAttachments sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_get - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_list insert: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create - update: - - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_create + update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete - attachments: - id: google.apigee.attachments - name: attachments - title: Attachments + #/components/x-stackQL-resources/endpoint_attachments/methods/organizations_endpoint_attachments_delete + reports: + id: google.apigee.reports + name: reports + title: Reports methods: - organizations_envgroups_attachments_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_envgroups_attachments_delete: + organizations_reports_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_envgroups_attachments_create: + organizations_reports_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_envgroups_attachments_list: - operation: &ref_21 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.environmentGroupAttachments - organizations_envgroups_attachments_list: - operation: *ref_21 - response: *ref_22 - organizations_instances_attachments_get: + organizations_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1reports~1{reportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_attachments_delete: + organizations_reports_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/post' response: mediaType: application/json openAPIDocKey: '200' - _organizations_instances_attachments_list: - operation: &ref_23 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.attachments - organizations_instances_attachments_list: - operation: *ref_23 - response: *ref_24 - organizations_instances_attachments_create: + organizations_reports_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1reports/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list + #/components/x-stackQL-resources/reports/methods/organizations_reports_get - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list + #/components/x-stackQL-resources/reports/methods/organizations_reports_list insert: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create - - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create + #/components/x-stackQL-resources/reports/methods/organizations_reports_create update: [] - delete: + replace: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete + #/components/x-stackQL-resources/reports/methods/organizations_reports_update + delete: - $ref: >- - #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete - operations: - id: google.apigee.operations - name: operations - title: Operations + #/components/x-stackQL-resources/reports/methods/organizations_reports_delete + apps: + id: google.apigee.apps + name: apps + title: Apps methods: - _organizations_operations_list: - operation: &ref_25 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' - response: &ref_26 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - organizations_operations_list: - operation: *ref_25 - response: *ref_26 - organizations_operations_get: + organizations_apps_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/organizations_operations_list - insert: [] - update: [] - delete: [] - revisions_deployments: - id: google.apigee.revisions_deployments - name: revisions_deployments - title: Revisions_deployments - methods: - organizations_environments_sharedflows_revisions_get_deployments: + objectKey: $.app + organizations_apps_get: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}~1deployments/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apps~1{appsId}/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_get_deployments: + organizations_appgroups_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1deployments/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_sharedflows_revisions_get_deployments - - $ref: >- - #/components/x-stackQL-resources/revisions_deployments/methods/organizations_environments_apis_revisions_get_deployments - insert: [] - update: [] - delete: [] - archive_deployments: - id: google.apigee.archive_deployments - name: archive_deployments - title: Archive_deployments - methods: - organizations_environments_archive_deployments_get: + organizations_appgroups_apps_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_delete: + organizations_appgroups_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_patch: + organizations_appgroups_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_create: + objectKey: $.appGroupApps + organizations_appgroups_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_archive_deployments_list: - operation: &ref_27 + organizations_developers_apps_get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments/get - response: &ref_28 + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.archiveDeployments - organizations_environments_archive_deployments_list: - operation: *ref_27 - response: *ref_28 - organizations_environments_archive_deployments_generate_upload_url: + organizations_developers_apps_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments:generateUploadUrl/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_archive_deployments_generate_download_url: + organizations_developers_apps_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1archiveDeployments~1{archiveDeploymentsId}:generateDownloadUrl/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_get - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_list - insert: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_create - update: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/archive_deployments/methods/organizations_environments_archive_deployments_delete - references: - id: google.apigee.references - name: references - title: References - methods: - organizations_environments_references_get: + organizations_developers_apps_generate_key_pair_or_update_developer_app_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_delete: + organizations_developers_apps_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_update: + organizations_developers_apps_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references~1{referencesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_references_create: + organizations_developers_apps_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1references/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_get + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_get + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_get + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_apps_get + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_list + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_list + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_apps_list insert: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_create - update: + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_create - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_update + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_create + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_update + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_update delete: - $ref: >- - #/components/x-stackQL-resources/references/methods/organizations_environments_references_delete - admin_schemav2: - id: google.apigee.admin_schemav2 - name: admin_schemav2 - title: Admin_schemav2 + #/components/x-stackQL-resources/apps/methods/organizations_appgroups_apps_delete + - $ref: >- + #/components/x-stackQL-resources/apps/methods/organizations_developers_apps_delete + host_queries_result_view: + id: google.apigee.host_queries_result_view + name: host_queries_result_view + title: Host_queries_result_view methods: - organizations_environments_analytics_admin_get_schemav2: + organizations_host_queries_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1admin~1schemav2/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/admin_schemav2/methods/organizations_environments_analytics_admin_get_schemav2 + #/components/x-stackQL-resources/host_queries_result_view/methods/organizations_host_queries_get_result_view insert: [] update: [] + replace: [] delete: [] - exports: - id: google.apigee.exports - name: exports - title: Exports + host_queries: + id: google.apigee.host_queries + name: host_queries + title: Host_queries methods: - organizations_environments_analytics_exports_get: + organizations_host_queries_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports~1{exportsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_analytics_exports_list: + organizations_host_queries_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1hostQueries/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_analytics_exports_create: + organizations_host_queries_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1analytics~1exports/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_get + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_get - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_list + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_list insert: - $ref: >- - #/components/x-stackQL-resources/exports/methods/organizations_environments_analytics_exports_create + #/components/x-stackQL-resources/host_queries/methods/organizations_host_queries_create update: [] + replace: [] delete: [] - flowhooks: - id: google.apigee.flowhooks - name: flowhooks - title: Flowhooks + host_queries_result: + id: google.apigee.host_queries_result + name: host_queries_result + title: Host_queries_result methods: - organizations_environments_flowhooks_attach_shared_flow_to_flow_hook: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/put - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_flowhooks_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_flowhooks_detach_shared_flow_from_flow_hook: + organizations_host_queries_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1flowhooks~1{flowhooksId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1hostQueries~1{hostQueriesId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/flowhooks/methods/organizations_environments_flowhooks_get + #/components/x-stackQL-resources/host_queries_result/methods/organizations_host_queries_get_result insert: [] update: [] + replace: [] delete: [] - caches: - id: google.apigee.caches - name: caches - title: Caches + security_profiles: + id: google.apigee.security_profiles + name: security_profiles + title: Security_profiles methods: - organizations_environments_caches_delete: + organizations_security_profiles_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1caches~1{cachesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/caches/methods/organizations_environments_caches_delete - security_incidents: - id: google.apigee.security_incidents - name: security_incidents - title: Security_incidents - methods: - organizations_environments_security_incidents_get: + organizations_security_profiles_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_patch: + organizations_security_profiles_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents~1{securityIncidentsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_incidents_batch_update: + organizations_security_profiles_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents:batchUpdate/post + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_security_incidents_list: - operation: &ref_29 + organizations_security_profiles_list: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityIncidents/get - response: &ref_30 + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityIncidents - organizations_environments_security_incidents_list: - operation: *ref_29 - response: *ref_30 + objectKey: $.securityProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_get + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_get - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_list - insert: [] + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_list + insert: + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_create update: - $ref: >- - #/components/x-stackQL-resources/security_incidents/methods/organizations_environments_security_incidents_patch - delete: [] - optimized_stats: - id: google.apigee.optimized_stats - name: optimized_stats - title: Optimized_stats + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/security_profiles/methods/organizations_security_profiles_delete + security_profiles_revisions: + id: google.apigee.security_profiles_revisions + name: security_profiles_revisions + title: Security_profiles_revisions methods: - organizations_environments_optimized_stats_get: + organizations_security_profiles_list_revisions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1optimizedStats~1{optimizedStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityProfiles~1{securityProfilesId}:listRevisions/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.securityProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/optimized_stats/methods/organizations_environments_optimized_stats_get + #/components/x-stackQL-resources/security_profiles_revisions/methods/organizations_security_profiles_list_revisions insert: [] update: [] + replace: [] delete: [] - queries: - id: google.apigee.queries - name: queries - title: Queries + revisions_shared_flow_revision: + id: google.apigee.revisions_shared_flow_revision + name: revisions_shared_flow_revision + title: Revisions_shared_flow_revision methods: - organizations_environments_queries_list: + organizations_sharedflows_revisions_update_shared_flow_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_create: + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_shared_flow_revision/methods/organizations_sharedflows_revisions_update_shared_flow_revision + replace: [] + delete: [] + sharedflows: + id: google.apigee.sharedflows + name: sharedflows + title: Sharedflows + methods: + organizations_sharedflows_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries/post + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_queries_get: + organizations_sharedflows_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_sharedflows_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_get + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_list + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list insert: - $ref: >- - #/components/x-stackQL-resources/queries/methods/organizations_environments_queries_create + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create update: [] - delete: [] - queries_resulturl: - id: google.apigee.queries_resulturl - name: queries_resulturl - title: Queries_resulturl + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete + appgroups: + id: google.apigee.appgroups + name: appgroups + title: Appgroups methods: - organizations_environments_queries_get_resulturl: + organizations_appgroups_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1resulturl/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/queries_resulturl/methods/organizations_environments_queries_get_resulturl - insert: [] - update: [] - delete: [] - queries_result: - id: google.apigee.queries_result - name: queries_result - title: Queries_result - methods: - organizations_environments_queries_get_result: + organizations_appgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1queries~1{queriesId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/queries_result/methods/organizations_environments_queries_get_result - insert: [] - update: [] - delete: [] - security_reports: - id: google.apigee.security_reports - name: security_reports - title: Security_reports - methods: - organizations_environments_security_reports_get: + organizations_appgroups_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}/put response: mediaType: application/json openAPIDocKey: '200' - _organizations_environments_security_reports_list: - operation: &ref_31 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/get - response: &ref_32 + organizations_appgroups_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/post' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.securityReports - organizations_environments_security_reports_list: - operation: *ref_31 - response: *ref_32 - organizations_environments_security_reports_create: + organizations_appgroups_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1appgroups/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.appGroups sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_get + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_get - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_list + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_list insert: - $ref: >- - #/components/x-stackQL-resources/security_reports/methods/organizations_environments_security_reports_create + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_create update: [] - delete: [] - security_reports_result_view: - id: google.apigee.security_reports_result_view - name: security_reports_result_view - title: Security_reports_result_view + replace: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_update + delete: + - $ref: >- + #/components/x-stackQL-resources/appgroups/methods/organizations_appgroups_delete + keys: + id: google.apigee.keys + name: keys + title: Keys methods: - organizations_environments_security_reports_get_result_view: + organizations_appgroups_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result_view/methods/organizations_environments_security_reports_get_result_view - insert: [] - update: [] - delete: [] - security_reports_result: - id: google.apigee.security_reports_result - name: security_reports_result - title: Security_reports_result - methods: - organizations_environments_security_reports_get_result: + organizations_appgroups_apps_keys_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityReports~1{securityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_reports_result/methods/organizations_environments_security_reports_get_result - insert: [] - update: [] - delete: [] - addons_config: - id: google.apigee.addons_config - name: addons_config - title: Addons_config - methods: - organizations_environments_addons_config_set_addon_enablement: + organizations_appgroups_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig:setAddonEnablement/post + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - security_actions: - id: google.apigee.security_actions - name: security_actions - title: Security_actions - methods: - _organizations_environments_security_actions_list: - operation: &ref_33 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/get - response: &ref_34 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.securityActions - organizations_environments_security_actions_list: - operation: *ref_33 - response: *ref_34 - organizations_environments_security_actions_create: + organizations_developers_apps_keys_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_get: + organizations_developers_apps_keys_replace_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_disable: + organizations_developers_apps_keys_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:disable/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_actions_enable: + organizations_developers_apps_keys_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActions~1{securityActionsId}:enable/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_get + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_get - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_list + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_get insert: - $ref: >- - #/components/x-stackQL-resources/security_actions/methods/organizations_environments_security_actions_create + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_create + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_create update: [] - delete: [] - data: - id: google.apigee.data - name: data - title: Data + replace: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_replace_developer_app_key + delete: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_appgroups_apps_keys_delete + - $ref: >- + #/components/x-stackQL-resources/keys/methods/organizations_developers_apps_keys_delete + keys_app_group_app_key: + id: google.apigee.keys_app_group_app_key + name: keys_app_group_app_key + title: Keys_app_group_app_key methods: - organizations_environments_apis_revisions_debugsessions_data_get: + organizations_appgroups_apps_keys_update_app_group_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data~1{dataId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/data/methods/organizations_environments_apis_revisions_debugsessions_data_get + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/keys_app_group_app_key/methods/organizations_appgroups_apps_keys_update_app_group_app_key + replace: [] delete: [] - debugsessions_data: - id: google.apigee.debugsessions_data - name: debugsessions_data - title: Debugsessions_data + apiproducts: + id: google.apigee.apiproducts + name: apiproducts + title: Apiproducts methods: - organizations_environments_apis_revisions_debugsessions_delete_data: + organizations_appgroups_apps_keys_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}~1data/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/debugsessions_data/methods/organizations_environments_apis_revisions_debugsessions_delete_data - debugsessions: - id: google.apigee.debugsessions - name: debugsessions - title: Debugsessions - methods: - _organizations_environments_apis_revisions_debugsessions_list: - operation: &ref_35 + organizations_developers_apps_keys_apiproducts_delete: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/get - response: &ref_36 + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions - organizations_environments_apis_revisions_debugsessions_list: - operation: *ref_35 - response: *ref_36 - organizations_environments_apis_revisions_debugsessions_create: + organizations_apiproducts_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_apis_revisions_debugsessions_get: + organizations_apiproducts_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apis~1{apisId}~1revisions~1{revisionsId}~1debugsessions~1{debugsessionsId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_get - - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_list - insert: - - $ref: >- - #/components/x-stackQL-resources/debugsessions/methods/organizations_environments_apis_revisions_debugsessions_create - update: [] - delete: [] - targetservers: - id: google.apigee.targetservers - name: targetservers - title: Targetservers - methods: - organizations_environments_targetservers_create: + organizations_apiproducts_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apiproducts/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_get: + organizations_apiproducts_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_update: + organizations_apiproducts_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_targetservers_delete: + organizations_apiproducts_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1targetservers~1{targetserversId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_get + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_get + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_list insert: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_create - update: + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_update + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_update delete: - $ref: >- - #/components/x-stackQL-resources/targetservers/methods/organizations_environments_targetservers_delete - aliases: - id: google.apigee.aliases - name: aliases - title: Aliases + #/components/x-stackQL-resources/apiproducts/methods/organizations_appgroups_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_developers_apps_keys_apiproducts_delete + - $ref: >- + #/components/x-stackQL-resources/apiproducts/methods/organizations_apiproducts_delete + apiproducts_app_group_app_key_api_product: + id: google.apigee.apiproducts_app_group_app_key_api_product + name: apiproducts_app_group_app_key_api_product + title: Apiproducts_app_group_app_key_api_product methods: - organizations_environments_keystores_aliases_delete: + organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1appgroups~1{appgroupsId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/apiproducts_app_group_app_key_api_product/methods/organizations_appgroups_apps_keys_apiproducts_update_app_group_app_key_api_product + replace: [] + delete: [] + datacollectors: + id: google.apigee.datacollectors + name: datacollectors + title: Datacollectors + methods: + organizations_datacollectors_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_get: + objectKey: $.dataCollectors + organizations_datacollectors_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_update: + organizations_datacollectors_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_csr: + organizations_datacollectors_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1csr/get + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_keystores_aliases_create: + organizations_datacollectors_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases/post + #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_get + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get + - $ref: >- + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list insert: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_create + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create update: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_update + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/aliases/methods/organizations_environments_keystores_aliases_delete - aliases_certificate: - id: google.apigee.aliases_certificate - name: aliases_certificate - title: Aliases_certificate + #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete + host_security_reports_result: + id: google.apigee.host_security_reports_result + name: host_security_reports_result + title: Host_security_reports_result methods: - organizations_environments_keystores_aliases_get_certificate: + organizations_host_security_reports_get_result: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}~1aliases~1{aliasesId}~1certificate/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/aliases_certificate/methods/organizations_environments_keystores_aliases_get_certificate + #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result insert: [] update: [] + replace: [] delete: [] - keystores: - id: google.apigee.keystores - name: keystores - title: Keystores + host_security_reports_result_view: + id: google.apigee.host_security_reports_result_view + name: host_security_reports_result_view + title: Host_security_reports_result_view methods: - organizations_environments_keystores_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_keystores_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores~1{keystoresId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_keystores_create: + organizations_host_security_reports_get_result_view: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1keystores/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_get - insert: - - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_create + #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view + insert: [] update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/keystores/methods/organizations_environments_keystores_delete - security_stats: - id: google.apigee.security_stats - name: security_stats - title: Security_stats + replace: [] + delete: [] + host_security_reports: + id: google.apigee.host_security_reports + name: host_security_reports + title: Host_security_reports methods: - organizations_environments_security_stats_query_time_series_stats: + organizations_host_security_reports_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTimeSeriesStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_security_stats_query_tabular_stats: + organizations_host_security_reports_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityStats:queryTabularStats/post + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - stats: - id: google.apigee.stats - name: stats - title: Stats - methods: - organizations_environments_stats_get: + objectKey: $.securityReports + organizations_host_security_reports_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1stats~1{statsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/stats/methods/organizations_environments_stats_get - insert: [] + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get + - $ref: >- + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list + insert: + - $ref: >- + #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create update: [] + replace: [] delete: [] - overrides: - id: google.apigee.overrides - name: overrides - title: Overrides + operations: + id: google.apigee.operations + name: operations + title: Operations methods: - organizations_environments_trace_config_overrides_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/post - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_environments_trace_config_overrides_list: - operation: &ref_37 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides/get - response: &ref_38 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.traceConfigOverrides - organizations_environments_trace_config_overrides_list: - operation: *ref_37 - response: *ref_38 - organizations_environments_trace_config_overrides_delete: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_environments_trace_config_overrides_patch: + organizations_operations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_trace_config_overrides_get: + organizations_operations_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig~1overrides~1{overridesId}/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_get - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_list - insert: - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_create - update: - - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_patch - delete: + #/components/x-stackQL-resources/operations/methods/organizations_operations_get - $ref: >- - #/components/x-stackQL-resources/overrides/methods/organizations_environments_trace_config_overrides_delete - resourcefiles: - id: google.apigee.resourcefiles - name: resourcefiles - title: Resourcefiles + #/components/x-stackQL-resources/operations/methods/organizations_operations_list + insert: [] + update: [] + replace: [] + delete: [] + envgroups: + id: google.apigee.envgroups + name: envgroups + title: Envgroups methods: - organizations_environments_resourcefiles_update: + organizations_envgroups_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/put + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_get: + organizations_envgroups_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/patch response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_delete: + organizations_envgroups_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}~1{name}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_list: + organizations_envgroups_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/get + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_resourcefiles_create: + objectKey: $.environmentGroups + organizations_envgroups_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1envgroups/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_get + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_get - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_list + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_list insert: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_create + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_create update: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_update + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/resourcefiles/methods/organizations_environments_resourcefiles_delete - resourcefiles_environment_resources: - id: google.apigee.resourcefiles_environment_resources - name: resourcefiles_environment_resources - title: Resourcefiles_environment_resources - methods: - organizations_environments_resourcefiles_list_environment_resources: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1resourcefiles~1{type}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/resourcefiles_environment_resources/methods/organizations_environments_resourcefiles_list_environment_resources - insert: [] - update: [] - delete: [] - environments_environment: - id: google.apigee.environments_environment - name: environments_environment - title: Environments_environment - methods: - organizations_environments_update_environment: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - environments_iam_policies: - id: google.apigee.environments_iam_policies - name: environments_iam_policies - title: Environments_iam_policies + #/components/x-stackQL-resources/envgroups/methods/organizations_envgroups_delete + envgroups_deployed_ingress_config: + id: google.apigee.envgroups_deployed_ingress_config + name: envgroups_deployed_ingress_config + title: Envgroups_deployed_ingress_config methods: - organizations_environments_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_environments_get_iam_policy: - operation: &ref_39 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:getIamPolicy/get - response: &ref_40 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - organizations_environments_get_iam_policy: - operation: *ref_39 - response: *ref_40 - organizations_environments_set_iam_policy: + organizations_envgroups_get_deployed_ingress_config: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}:setIamPolicy/post + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1deployedIngressConfig/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_iam_policies/methods/organizations_environments_get_iam_policy + #/components/x-stackQL-resources/envgroups_deployed_ingress_config/methods/organizations_envgroups_get_deployed_ingress_config insert: [] update: [] + replace: [] delete: [] - environments_debugmask: - id: google.apigee.environments_debugmask - name: environments_debugmask - title: Environments_debugmask + attachments: + id: google.apigee.attachments + name: attachments + title: Attachments methods: - organizations_environments_get_debugmask: + organizations_envgroups_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update_debugmask: + objectKey: $.environmentGroupAttachments + organizations_envgroups_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1debugmask/patch + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_debugmask/methods/organizations_environments_get_debugmask - insert: [] - update: [] - delete: [] - environments_trace_config: - id: google.apigee.environments_trace_config - name: environments_trace_config - title: Environments_trace_config - methods: - organizations_environments_update_trace_config: + organizations_envgroups_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_get_trace_config: + organizations_envgroups_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1traceConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1envgroups~1{envgroupsId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_trace_config/methods/organizations_environments_get_trace_config - insert: [] - update: [] - delete: [] - environments_security_actions_config: - id: google.apigee.environments_security_actions_config - name: environments_security_actions_config - title: Environments_security_actions_config - methods: - organizations_environments_get_security_actions_config: + organizations_instances_attachments_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/post response: mediaType: application/json openAPIDocKey: '200' - organizations_environments_update_security_actions_config: + organizations_instances_attachments_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1securityActionsConfig/patch + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_security_actions_config/methods/organizations_environments_get_security_actions_config - insert: [] - update: [] - delete: [] - environments_api_security_runtime_config: - id: google.apigee.environments_api_security_runtime_config - name: environments_api_security_runtime_config - title: Environments_api_security_runtime_config - methods: - organizations_environments_get_api_security_runtime_config: + objectKey: $.attachments + organizations_instances_attachments_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1apiSecurityRuntimeConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_api_security_runtime_config/methods/organizations_environments_get_api_security_runtime_config - insert: [] - update: [] - delete: [] - environments_deployed_config: - id: google.apigee.environments_deployed_config - name: environments_deployed_config - title: Environments_deployed_config - methods: - organizations_environments_get_deployed_config: + organizations_instances_attachments_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1deployedConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1attachments~1{attachmentsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/environments_deployed_config/methods/organizations_environments_get_deployed_config - insert: [] + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_get + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_get + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_list + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_list + insert: + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_create + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_create update: [] - delete: [] - environments_addons_config: - id: google.apigee.environments_addons_config - name: environments_addons_config - title: Environments_addons_config + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_envgroups_attachments_delete + - $ref: >- + #/components/x-stackQL-resources/attachments/methods/organizations_instances_attachments_delete + balance: + id: google.apigee.balance + name: balance + title: Balance methods: - organizations_environments_get_addons_config: + organizations_developers_balance_adjust: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1environments~1{environmentsId}~1addonsConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:adjust/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/environments_addons_config/methods/organizations_environments_get_addons_config - insert: [] - update: [] - delete: [] - security_assessment_results: - id: google.apigee.security_assessment_results - name: security_assessment_results - title: Security_assessment_results - methods: - organizations_security_assessment_results_batch_compute: + organizations_developers_balance_credit: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance:credit/post response: mediaType: application/json openAPIDocKey: '200' @@ -11854,345 +11866,402 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] - apicategories: - id: google.apigee.apicategories - name: apicategories - title: Apicategories + subscriptions: + id: google.apigee.subscriptions + name: subscriptions + title: Subscriptions methods: - organizations_sites_apicategories_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_sites_apicategories_list: + organizations_developers_subscriptions_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_patch: + organizations_developers_subscriptions_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/post response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_delete: + organizations_developers_subscriptions_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apicategories_get: + organizations_developers_subscriptions_expire: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apicategories~1{apicategoriesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1subscriptions~1{subscriptionsId}:expire/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_get + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_get - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_list + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_list insert: - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_create - update: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/apicategories/methods/organizations_sites_apicategories_delete - apidocs_documentation: - id: google.apigee.apidocs_documentation - name: apidocs_documentation - title: Apidocs_documentation + #/components/x-stackQL-resources/subscriptions/methods/organizations_developers_subscriptions_create + update: [] + replace: [] + delete: [] + attributes: + id: google.apigee.attributes + name: attributes + title: Attributes methods: - organizations_sites_apidocs_get_documentation: + organizations_developers_apps_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_update_documentation: + organizations_developers_apps_attributes_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}~1documentation/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/apidocs_documentation/methods/organizations_sites_apidocs_get_documentation - insert: [] - update: [] - delete: [] - apidocs: - id: google.apigee.apidocs - name: apidocs - title: Apidocs - methods: - organizations_sites_apidocs_delete: + organizations_developers_apps_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_update: + organizations_developers_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/put + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sites_apidocs_get: + organizations_developers_attributes_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs~1{apidocsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_attributes_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_attributes_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_sites_apidocs_list: - operation: &ref_41 + organizations_apiproducts_attributes_get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/get - response: &ref_42 + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.data - organizations_sites_apidocs_list: - operation: *ref_41 - response: *ref_42 - organizations_sites_apidocs_create: + organizations_apiproducts_attributes_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sites~1{sitesId}~1apidocs/post + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_get + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_get - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_list - insert: + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_list - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_create - update: + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_get - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_update + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_get + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_list + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_list + insert: [] + update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/apidocs/methods/organizations_sites_apidocs_delete - host_security_reports_result_view: - id: google.apigee.host_security_reports_result_view - name: host_security_reports_result_view - title: Host_security_reports_result_view + #/components/x-stackQL-resources/attributes/methods/organizations_developers_apps_attributes_delete + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_developers_attributes_delete + - $ref: >- + #/components/x-stackQL-resources/attributes/methods/organizations_apiproducts_attributes_delete + attributes_developer_app_attribute: + id: google.apigee.attributes_developer_app_attribute + name: attributes_developer_app_attribute + title: Attributes_developer_app_attribute methods: - organizations_host_security_reports_get_result_view: + organizations_developers_apps_attributes_update_developer_app_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1resultView/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result_view/methods/organizations_host_security_reports_get_result_view + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attributes_developer_app_attribute/methods/organizations_developers_apps_attributes_update_developer_app_attribute + replace: [] delete: [] - host_security_reports: - id: google.apigee.host_security_reports - name: host_security_reports - title: Host_security_reports + create: + id: google.apigee.create + name: create + title: Create methods: - organizations_host_security_reports_get: + organizations_developers_apps_keys_create_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1create/post response: mediaType: application/json openAPIDocKey: '200' - organizations_host_security_reports_create: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/create/methods/organizations_developers_apps_keys_create_create + update: [] + replace: [] + delete: [] + apiproducts_developer_app_key_api_product: + id: google.apigee.apiproducts_developer_app_key_api_product + name: apiproducts_developer_app_key_api_product + title: Apiproducts_developer_app_key_api_product + methods: + organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}~1apiproducts~1{apiproductsId}/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_host_security_reports_list: - operation: &ref_43 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports/get - response: &ref_44 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.securityReports - organizations_host_security_reports_list: - operation: *ref_43 - response: *ref_44 sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_get - - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_list - insert: + select: [] + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/host_security_reports/methods/organizations_host_security_reports_create - update: [] + #/components/x-stackQL-resources/apiproducts_developer_app_key_api_product/methods/organizations_developers_apps_keys_apiproducts_update_developer_app_key_api_product + replace: [] delete: [] - host_security_reports_result: - id: google.apigee.host_security_reports_result - name: host_security_reports_result - title: Host_security_reports_result + keys_developer_app_key: + id: google.apigee.keys_developer_app_key + name: keys_developer_app_key + title: Keys_developer_app_key methods: - organizations_host_security_reports_get_result: + organizations_developers_apps_keys_update_developer_app_key: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1hostSecurityReports~1{hostSecurityReportsId}~1result/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1apps~1{appsId}~1keys~1{keysId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/host_security_reports_result/methods/organizations_host_security_reports_get_result + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/keys_developer_app_key/methods/organizations_developers_apps_keys_update_developer_app_key + replace: [] delete: [] - datacollectors: - id: google.apigee.datacollectors - name: datacollectors - title: Datacollectors + developers: + id: google.apigee.developers + name: developers + title: Developers methods: - organizations_datacollectors_get: + organizations_developers_attributes: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_patch: + organizations_developers_update: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_datacollectors_delete: + organizations_developers_set_developer_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors~1{datacollectorsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_datacollectors_list: - operation: &ref_45 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/get' - response: &ref_46 + organizations_developers_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.dataCollectors - organizations_datacollectors_list: - operation: *ref_45 - response: *ref_46 - organizations_datacollectors_create: + organizations_developers_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1datacollectors/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_developers_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1developers/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_get + #/components/x-stackQL-resources/developers/methods/organizations_developers_get - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_list + #/components/x-stackQL-resources/developers/methods/organizations_developers_list insert: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_create - update: + #/components/x-stackQL-resources/developers/methods/organizations_developers_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_patch + #/components/x-stackQL-resources/developers/methods/organizations_developers_update delete: - $ref: >- - #/components/x-stackQL-resources/datacollectors/methods/organizations_datacollectors_delete - revisions_shared_flow_revision: - id: google.apigee.revisions_shared_flow_revision - name: revisions_shared_flow_revision - title: Revisions_shared_flow_revision + #/components/x-stackQL-resources/developers/methods/organizations_developers_delete + attributes_developer_attribute: + id: google.apigee.attributes_developer_attribute + name: attributes_developer_attribute + title: Attributes_developer_attribute methods: - organizations_sharedflows_revisions_update_shared_flow_revision: + organizations_developers_attributes_update_developer_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}~1revisions~1{revisionsId}/post + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attributes_developer_attribute/methods/organizations_developers_attributes_update_developer_attribute + replace: [] delete: [] - sharedflows: - id: google.apigee.sharedflows - name: sharedflows - title: Sharedflows + developers_monetization_config: + id: google.apigee.developers_monetization_config + name: developers_monetization_config + title: Developers_monetization_config methods: - organizations_sharedflows_list: + organizations_developers_update_monetization_config: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/put response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_create: + organizations_developers_get_monetization_config: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sharedflows/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1monetizationConfig/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_get_monetization_config + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/developers_monetization_config/methods/organizations_developers_update_monetization_config + delete: [] + developers_balance: + id: google.apigee.developers_balance + name: developers_balance + title: Developers_balance + methods: + organizations_developers_get_balance: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1developers~1{developersId}~1balance/get response: mediaType: application/json openAPIDocKey: '200' - organizations_sharedflows_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/developers_balance/methods/organizations_developers_get_balance + insert: [] + update: [] + replace: [] + delete: [] + host_stats: + id: google.apigee.host_stats + name: host_stats + title: Host_stats + methods: + organizations_host_stats_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1sharedflows~1{sharedflowsId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1hostStats~1{hostStatsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_get - - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_list - insert: + #/components/x-stackQL-resources/host_stats/methods/organizations_host_stats_get + insert: [] + update: [] + replace: [] + delete: [] + optimized_host_stats: + id: google.apigee.optimized_host_stats + name: optimized_host_stats + title: Optimized_host_stats + methods: + organizations_optimized_host_stats_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_create + #/components/x-stackQL-resources/optimized_host_stats/methods/organizations_optimized_host_stats_get + insert: [] update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/sharedflows/methods/organizations_sharedflows_delete + replace: [] + delete: [] canaryevaluations: id: google.apigee.canaryevaluations name: canaryevaluations @@ -12220,48 +12289,46 @@ components: - $ref: >- #/components/x-stackQL-resources/canaryevaluations/methods/organizations_instances_canaryevaluations_create update: [] + replace: [] delete: [] nat_addresses: id: google.apigee.nat_addresses name: nat_addresses title: Nat_addresses methods: - organizations_instances_nat_addresses_delete: + organizations_instances_nat_addresses_activate: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_get: + organizations_instances_nat_addresses_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_nat_addresses_activate: + organizations_instances_nat_addresses_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}:activate/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_instances_nat_addresses_list: - operation: &ref_47 + objectKey: $.natAddresses + organizations_instances_nat_addresses_delete: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/get - response: &ref_48 + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.natAddresses - organizations_instances_nat_addresses_list: - operation: *ref_47 - response: *ref_48 - organizations_instances_nat_addresses_create: + organizations_instances_nat_addresses_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}~1natAddresses~1{natAddressesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -12275,6 +12342,7 @@ components: - $ref: >- #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/nat_addresses/methods/organizations_instances_nat_addresses_delete @@ -12283,47 +12351,44 @@ components: name: instances title: Instances methods: - organizations_instances_delete: + organizations_instances_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_patch: + objectKey: $.instances + organizations_instances_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_get: + organizations_instances_report_status: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_instances_list: - operation: &ref_49 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/get' - response: &ref_50 + organizations_instances_patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.instances - organizations_instances_list: - operation: *ref_49 - response: *ref_50 - organizations_instances_create: + organizations_instances_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1instances/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_instances_report_status: + organizations_instances_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}:reportStatus/post + #/paths/~1v1~1organizations~1{organizationsId}~1instances~1{instancesId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -12339,189 +12404,239 @@ components: update: - $ref: >- #/components/x-stackQL-resources/instances/methods/organizations_instances_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instances/methods/organizations_instances_delete - optimized_host_stats: - id: google.apigee.optimized_host_stats - name: optimized_host_stats - title: Optimized_host_stats + attributes_api_product_attribute: + id: google.apigee.attributes_api_product_attribute + name: attributes_api_product_attribute + title: Attributes_api_product_attribute methods: - organizations_optimized_host_stats_get: + organizations_apiproducts_attributes_update_api_product_attribute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1optimizedHostStats~1{optimizedHostStatsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1attributes~1{attributesId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/optimized_host_stats/methods/organizations_optimized_host_stats_get + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/attributes_api_product_attribute/methods/organizations_apiproducts_attributes_update_api_product_attribute + replace: [] delete: [] - runtime_config: - id: google.apigee.runtime_config - name: runtime_config - title: Runtime_config + rateplans: + id: google.apigee.rateplans + name: rateplans + title: Rateplans methods: - organizations_get_runtime_config: + organizations_apiproducts_rateplans_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1runtimeConfig/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_rateplans_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_rateplans_update: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_rateplans_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apiproducts_rateplans_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1apiproducts~1{apiproductsId}~1rateplans~1{rateplansId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/runtime_config/methods/organizations_get_runtime_config - insert: [] + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_get + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_list + insert: + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_create update: [] - delete: [] - organizations: - id: google.apigee.organizations - name: organizations - title: Organizations + replace: + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_update + delete: + - $ref: >- + #/components/x-stackQL-resources/rateplans/methods/organizations_apiproducts_rateplans_delete + datastores: + id: google.apigee.datastores + name: datastores + title: Datastores methods: - organizations_list: - operation: - $ref: '#/paths/~1v1~1organizations/get' - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_create: + organizations_analytics_datastores_list: operation: - $ref: '#/paths/~1v1~1organizations/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/get response: mediaType: application/json openAPIDocKey: '200' - organizations_set_sync_authorization: + organizations_analytics_datastores_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:setSyncAuthorization/post + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores/post response: mediaType: application/json openAPIDocKey: '200' - organizations_update: + organizations_analytics_datastores_get: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/put' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_get: + organizations_analytics_datastores_update: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/get' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/put response: mediaType: application/json openAPIDocKey: '200' - organizations_delete: + organizations_analytics_datastores_delete: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}/delete' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores~1{datastoresId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_set_addons: + organizations_analytics_datastores_test: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}:setAddons/post' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1analytics~1datastores:test/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_get + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_get - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_list + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_list insert: - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_create - update: + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_create + update: [] + replace: - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_update + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_update delete: - $ref: >- - #/components/x-stackQL-resources/organizations/methods/organizations_delete - deployed_ingress_config: - id: google.apigee.deployed_ingress_config - name: deployed_ingress_config - title: Deployed_ingress_config + #/components/x-stackQL-resources/datastores/methods/organizations_analytics_datastores_delete + revisions_api_proxy_revision: + id: google.apigee.revisions_api_proxy_revision + name: revisions_api_proxy_revision + title: Revisions_api_proxy_revision methods: - organizations_get_deployed_ingress_config: + organizations_apis_revisions_update_api_proxy_revision: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1deployedIngressConfig/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}~1revisions~1{revisionsId}/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/deployed_ingress_config/methods/organizations_get_deployed_ingress_config + select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/revisions_api_proxy_revision/methods/organizations_apis_revisions_update_api_proxy_revision + replace: [] delete: [] - security_settings: - id: google.apigee.security_settings - name: security_settings - title: Security_settings + apis: + id: google.apigee.apis + name: apis + title: Apis methods: - organizations_update_security_settings: + organizations_apis_delete: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/patch + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_get_security_settings: + organizations_apis_get: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apis_patch: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1securitySettings/get + #/paths/~1v1~1organizations~1{organizationsId}~1apis~1{apisId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/security_settings/methods/organizations_get_security_settings - insert: [] - update: [] - delete: [] - sync_authorization: - id: google.apigee.sync_authorization - name: sync_authorization - title: Sync_authorization - methods: - organizations_get_sync_authorization: + organizations_apis_create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/post' + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_apis_list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getSyncAuthorization/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1apis/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - project_mapping: - id: google.apigee.project_mapping - name: project_mapping - title: Project_mapping + select: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_get + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_list + insert: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_create + update: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/apis/methods/organizations_apis_delete + security_assessment_results: + id: google.apigee.security_assessment_results + name: security_assessment_results + title: Security_assessment_results methods: - organizations_get_project_mapping: + organizations_security_assessment_results_batch_compute: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}:getProjectMapping/get + #/paths/~1v1~1organizations~1{organizationsId}~1securityAssessmentResults:batchCompute/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/project_mapping/methods/organizations_get_project_mapping + select: [] insert: [] update: [] + replace: [] delete: [] issuers: id: google.apigee.issuers @@ -12540,6 +12655,7 @@ components: #/components/x-stackQL-resources/issuers/methods/hybrid_issuers_list insert: [] update: [] + replace: [] delete: [] projects: id: google.apigee.projects @@ -12556,27 +12672,32 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/apps: - parameters: &ref_51 - - $ref: '#/components/parameters/callback' + /v1/organizations: + parameters: &ref_1 - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - get: + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + post: description: >- - Lists IDs of apps within an organization that have the specified app - status (approved or revoked) or are of the specified app type (developer - or company). - operationId: apigee.organizations.apps.list + Creates an Apigee organization. See [Create an Apigee + organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). + operationId: apigee.organizations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12588,68 +12709,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: startKey - schema: - type: string - - in: query - name: includeCred - schema: - type: boolean - - in: query - name: ids - schema: - type: string - - in: query - name: rows - schema: - type: string - format: int64 - - in: query - name: expand - schema: - type: boolean - - in: query - name: filter - schema: - type: string - - in: query - name: apiProduct - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: apptype - schema: - type: string - in: query - name: keyStatus + name: parent schema: type: string - /v1/organizations/{organizationsId}/apps/{appsId}: - parameters: *ref_51 get: - description: Gets the app profile for the specified app ID. - operationId: apigee.organizations.apps.get + description: >- + Lists the Apigee organizations and associated Google Cloud projects that + you have permission to access. See [Understanding + organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). + operationId: apigee.organizations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12661,23 +12732,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1App' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/deployments: - parameters: *ref_51 + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse + parameters: [] + /v1/organizations/{organizationsId}/deployedIngressConfig: + parameters: *ref_1 get: - description: Lists all deployments of API proxies or shared flows. - operationId: apigee.organizations.deployments.list + description: Gets the deployed ingress configuration for an organization. + operationId: apigee.organizations.getDeployedIngressConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12689,8 +12751,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1IngressConfig' parameters: - in: path name: organizationsId @@ -12698,87 +12759,14 @@ paths: schema: type: string - in: query - name: sharedFlows - schema: - type: boolean - /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: - parameters: *ref_51 - delete: - description: Deletes a developer attribute. - operationId: apigee.organizations.developers.attributes.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: attributesId - required: true - schema: - type: string - post: - description: >- - Updates a developer attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (default). Any custom attributes associated - with these entities are cached for at least 180 seconds after the entity - is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: attributesId - required: true + name: view schema: type: string + /v1/organizations/{organizationsId}/securitySettings: + parameters: *ref_1 get: - description: Returns the value of the specified developer attribute. - operationId: apigee.organizations.developers.attributes.get + description: GetSecuritySettings gets the security settings for API Security. + operationId: apigee.organizations.getSecuritySettings security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12790,28 +12778,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: attributesId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/attributes: - parameters: *ref_51 - get: - description: Returns a list of all developer attributes. - operationId: apigee.organizations.developers.attributes.list + patch: + description: >- + UpdateSecuritySettings updates the current security settings for API + Security. + operationId: apigee.organizations.updateSecuritySettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12823,36 +12806,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true + - in: query + name: updateMask schema: type: string - post: + format: google-fieldmask + /v1/organizations/{organizationsId}: + parameters: *ref_1 + put: description: >- - Updates developer attributes. This API replaces the existing attributes - with those specified in the request. Add new attributes, and include or - exclude any existing attributes that you want to retain or remove, - respectively. The custom attribute limit is 18. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (default). Any custom - attributes associated with these entities are cached for at least 180 - seconds after the entity is accessed at runtime. Therefore, an - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.developers.attributes + Updates the properties for an Apigee organization. No other fields in + the organization profile will be updated. + operationId: apigee.organizations.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12864,23 +12841,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: - parameters: *ref_51 - get: - description: Gets details for an API product subscription. - operationId: apigee.organizations.developers.subscriptions.get + delete: + description: >- + Delete an Apigee organization. For organizations with BillingType + EVALUATION, an immediate deletion is performed. For paid organizations + (Subscription or Pay-as-you-go), a soft-deletion is performed. The + organization can be restored within the soft-deletion period, which is + specified using the `retention` field in the request or by filing a + support ticket with Apigee. During the data retention period specified + in the request, the Apigee organization cannot be recreated in the same + Google Cloud project. **IMPORTANT: The default data retention setting + for this operation is 7 days. To permanently delete the organization in + 24 hours, set the retention parameter to `MINIMUM`.** + operationId: apigee.organizations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12892,28 +12872,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: subscriptionsId - required: true + - in: query + name: retention schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: - parameters: *ref_51 get: - description: Lists all API product subscriptions for a developer. - operationId: apigee.organizations.developers.subscriptions.list + description: >- + Gets the profile for an Apigee organization. See [Understanding + organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). + operationId: apigee.organizations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12925,36 +12899,34 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: query - name: startKey - schema: - type: string - - in: query - name: count - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}:setSyncAuthorization: + parameters: *ref_1 post: - description: 'Creates a subscription to an API product. ' - operationId: apigee.organizations.developers.subscriptions.create + description: >- + Sets the permissions required to allow the Synchronizer to download + environment data from the control plane. You must call this API to + enable proper functioning of hybrid. Pass the ETag when calling + `setSyncAuthorization` to ensure that you are updating the correct + version. To get an ETag, call + [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag + in the call to `setSyncAuthorization`, then the existing authorization + is overwritten indiscriminately. For more information, see [Configure + the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.setSyncAuthorization requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12966,29 +12938,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: - parameters: *ref_51 + /v1/organizations/{organizationsId}:setAddons: + parameters: *ref_1 post: - description: Expires an API product subscription immediately. - operationId: apigee.organizations.developers.subscriptions.expire + description: >- + Configures the add-ons for the Apigee organization. The existing add-on + configuration will be fully replaced. + operationId: apigee.organizations.setAddons requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13000,34 +12968,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: subscriptionsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: - parameters: *ref_51 - post: - description: Credits the account balance for the developer. - operationId: apigee.organizations.developers.balance.credit - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest + /v1/organizations/{organizationsId}/runtimeConfig: + parameters: *ref_1 + get: + description: Get runtime config for an organization. + operationId: apigee.organizations.getRuntimeConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13039,31 +12991,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: - parameters: *ref_51 - post: - description: >- - Adjust the prepaid balance for the developer. This API will be used in - scenarios where the developer has been under-charged or over-charged. - operationId: apigee.organizations.developers.balance.adjust - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest + /v1/organizations/{organizationsId}:getProjectMapping: + parameters: *ref_1 + get: + description: Gets the project ID and region for an Apigee organization. + operationId: apigee.organizations.getProjectMapping security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13075,27 +13014,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: - parameters: *ref_51 - delete: + /v1/organizations/{organizationsId}:getSyncAuthorization: + parameters: *ref_1 + post: description: >- - Deletes a developer app. **Note**: The delete operation is asynchronous. - The developer app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.developers.apps.delete + Lists the service accounts with the permissions required to allow the + Synchronizer to download environment data from the control plane. An + ETag is returned in the response to `getSyncAuthorization`. Pass that + ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure + that you are updating the correct version. If you don't pass the ETag in + the call to `setSyncAuthorization`, then the existing authorization is + overwritten indiscriminately. For more information, see [Configure the + Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). + **Note**: Available to Apigee hybrid only. + operationId: apigee.organizations.getSyncAuthorization + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13107,57 +13053,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - post: - description: >- - Manages access to a developer app by enabling you to: * Approve or - revoke a developer app * Generate a new consumer key and secret for a - developer app To approve or revoke a developer app, set the `action` - query parameter to `approve` or `revoke`, respectively, and the - `Content-Type` header to `application/octet-stream`. If a developer app - is revoked, none of its API keys are valid for API calls even though the - keys are still approved. If successful, the API call returns the - following HTTP status code: `204 No Content` To generate a new consumer - key and secret for a developer app, pass the new key/secret details. - Rather than replace an existing key, this API generates a new key. In - this case, multiple key pairs may be associated with a single developer - app. Each key pair has an independent status (`approve` or `revoke`) and - expiration time. Any approved, non-expired key can be used in an API - call. For example, if you're using API key rotation, you can generate - new keys with expiration times that overlap keys that are going to - expire. You might also generate a new consumer key/secret if the - security of the original key/secret is compromised. The `keyExpiresIn` - property defines the expiration time for the API key in milliseconds. If - you don't set this property or set it to `-1`, the API key never - expires. **Notes**: * When generating a new key/secret, this API - replaces the existing attributes, notes, and callback URLs with those - specified in the request. Include or exclude any existing information - that you want to retain or delete, respectively. * To migrate existing - consumer keys and secrets to hybrid from another system, see the - CreateDeveloperAppKey API. - operationId: >- - apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: + parameters: *ref_1 + patch: + description: Updates an API category. + operationId: apigee.organizations.sites.apicategories.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13169,7 +13081,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -13177,37 +13089,18 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apicategoriesId required: true schema: type: string - - in: query - name: action - schema: - type: string - put: - description: >- - Updates the details for a developer app. In addition, you can add an API - product to a developer app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateDeveloperAppKey API. Using this API, you cannot update - the following: * App name as it is the primary key used to identify the - app and cannot be changed. * Scopes associated with the app. Instead, - use the ReplaceDeveloperAppKey API. This API replaces the existing - attributes with those specified in the request. Include or exclude any - existing attributes that you want to retain or delete, respectively. - operationId: apigee.organizations.developers.apps.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + get: + description: Gets an API category. + operationId: apigee.organizations.sites.apicategories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13219,7 +13112,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' parameters: - in: path name: organizationsId @@ -13227,18 +13120,18 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apicategoriesId required: true schema: type: string - get: - description: Returns the details for a developer app. - operationId: apigee.organizations.developers.apps.get + delete: + description: Deletes an API category. + operationId: apigee.organizations.sites.apicategories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13250,7 +13143,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -13258,33 +13151,51 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apicategoriesId required: true schema: type: string - - in: query - name: query + /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: + parameters: *ref_1 + post: + description: Creates a new API category. + operationId: apigee.organizations.sites.apicategories.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: entity + - in: path + name: sitesId + required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps: - parameters: *ref_51 get: - description: >- - Lists all apps created by a developer in an Apigee organization. - Optionally, you can request an expanded view of the developer apps. A - maximum of 100 developer apps are returned per API call. You can - paginate the list of deveoper apps returned using the `startKey` and - `count` query parameters. - operationId: apigee.organizations.developers.apps.list + description: Returns the API categories associated with a portal. + operationId: apigee.organizations.sites.apicategories.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13297,7 +13208,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse + #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse parameters: - in: path name: organizationsId @@ -13305,41 +13216,15 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - - in: query - name: shallowExpand - schema: - type: boolean - - in: query - name: count - schema: - type: string - format: int64 - - in: query - name: startKey - schema: - type: string - - in: query - name: expand - schema: - type: boolean - post: - description: >- - Creates an app associated with a developer. This API associates the - developer app with the specified API product and auto-generates an API - key for the app to use in calls to API proxies inside that API product. - The `name` is the unique ID of the app that you can use in API calls. - The `DisplayName` (set as an attribute) appears in the UI. If you don't - set the `DisplayName` attribute, the `name` appears in the UI. - operationId: apigee.organizations.developers.apps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: + parameters: *ref_1 + delete: + description: Deletes a catalog item. + operationId: apigee.organizations.sites.apidocs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13351,7 +13236,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' parameters: - in: path name: organizationsId @@ -13359,22 +13244,23 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: - parameters: *ref_51 - post: - description: >- - Updates attributes for a developer app. This API replaces the current - attributes with those specified in the request. - operationId: apigee.organizations.developers.apps.attributes + - in: path + name: apidocsId + required: true + schema: + type: string + put: + description: Updates a catalog item. + operationId: apigee.organizations.sites.apidocs.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13386,7 +13272,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -13394,18 +13280,18 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apidocsId required: true schema: type: string get: - description: Returns a list of all developer app attributes. - operationId: apigee.organizations.developers.apps.attributes.list + description: Gets a catalog item. + operationId: apigee.organizations.sites.apidocs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13417,7 +13303,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -13425,20 +13311,20 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string - in: path - name: appsId + name: apidocsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: - parameters: *ref_51 - delete: - description: Deletes a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.delete + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: + parameters: *ref_1 + get: + description: Gets the documentation for the specified catalog item. + operationId: apigee.organizations.sites.apidocs.getDocumentation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13450,7 +13336,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -13458,23 +13345,25 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: sitesId required: true schema: type: string - in: path - name: attributesId + name: apidocsId required: true schema: type: string - get: - description: Returns a developer app attribute. - operationId: apigee.organizations.developers.apps.attributes.get + patch: + description: >- + Updates the documentation for the specified catalog item. Note that the + documentation file contents will not be populated in the return message. + operationId: apigee.organizations.sites.apidocs.updateDocumentation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13486,7 +13375,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse parameters: - in: path name: organizationsId @@ -13494,36 +13384,25 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: sitesId required: true schema: type: string - in: path - name: attributesId + name: apidocsId required: true schema: type: string + /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: + parameters: *ref_1 post: - description: >- - Updates a developer app attribute. **Note**: OAuth access tokens and Key - Management Service (KMS) entities (apps, developers, and API products) - are cached for 180 seconds (current default). Any custom attributes - associated with these entities are cached for at least 180 seconds after - the entity is accessed at runtime. Therefore, an `ExpiresIn` element on - the OAuthV2 policy won't be able to expire an access token in less than - 180 seconds. - operationId: >- - apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute + description: Creates a new catalog item. + operationId: apigee.organizations.sites.apidocs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13535,7 +13414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' parameters: - in: path name: organizationsId @@ -13543,29 +13422,54 @@ paths: schema: type: string - in: path - name: developersId + name: sitesId required: true schema: type: string + get: + description: Returns the catalog items associated with a portal. + operationId: apigee.organizations.sites.apidocs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' + parameters: - in: path - name: appsId + name: organizationsId required: true schema: type: string - in: path - name: attributesId + name: sitesId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: - parameters: *ref_51 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}: + parameters: *ref_1 delete: description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.developers.apps.keys.apiproducts.delete + Deletes an environment from an organization. **Warning: You must delete + all key value maps and key value entries before you delete an + environment.** Otherwise, if you re-create the environment the key value + map entry operations will encounter encryption/decryption discrepancies. + operationId: apigee.organizations.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13577,7 +13481,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -13585,35 +13489,24 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string post: description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct + Updates an existing environment. When updating properties, you must pass + all existing properties to the API, even if they are not being changed. + If you omit properties from the payload, the properties are removed. To + get the current list of properties for the environment, use the [Get + Environment API](get). **Note**: Both `PUT` and `POST` methods are + supported for updating an existing environment. + operationId: apigee.organizations.environments.updateEnvironment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13625,7 +13518,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -13633,53 +13526,20 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId - required: true - schema: - type: string - - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - - in: query - name: action - schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: - parameters: *ref_51 - post: + patch: description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create.create + Updates properties for an Apigee environment with patch semantics using + a field mask. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.environments.modifyEnvironment requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13691,7 +13551,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -13699,31 +13559,29 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: - parameters: *ref_51 + format: google-fieldmask put: description: >- - Updates the scope of an app. This API replaces the existing scopes with - those specified in the request. Include or exclude any existing scopes - that you want to retain or delete, respectively. The specified scopes - must already be defined for the API products associated with the app. - This API sets the `scopes` element under the `apiProducts` element in - the attributes of the app. - operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey + Updates an existing environment. When updating properties, you must pass + all existing properties to the API, even if they are not being changed. + If you omit properties from the payload, the properties are removed. To + get the current list of properties for the environment, use the [Get + Environment API](get). **Note**: Both `PUT` and `POST` methods are + supported for updating an existing environment. + operationId: apigee.organizations.environments.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13735,7 +13593,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -13743,25 +13601,13 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId + name: environmentsId required: true schema: type: string get: - description: >- - Gets details for a consumer key for a developer app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.developers.apps.keys.get + description: Gets environment details. + operationId: apigee.organizations.environments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13773,7 +13619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' parameters: - in: path name: organizationsId @@ -13781,30 +13627,15 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId + name: environmentsId required: true schema: type: string - delete: - description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. **Note**: After you delete a consumer key, you may want - to: 1. Create a new consumer key and secret for the developer app using - the CreateDeveloperAppKey API, and subsequently add an API product to - the key using the UpdateDeveloperAppKey API. 2. Delete the developer - app, if it is no longer required. - operationId: apigee.organizations.developers.apps.keys.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: + parameters: *ref_1 + get: + description: Gets the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.getDebugmask security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13816,7 +13647,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -13824,35 +13655,18 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId - required: true - schema: - type: string - - in: path - name: keysId + name: environmentsId required: true schema: type: string - post: - description: >- - Adds an API product to a developer app key, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to a developer app key. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey + patch: + description: Updates the debug mask singleton resource for an environment. + operationId: apigee.organizations.environments.updateDebugmask requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13864,7 +13678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' parameters: - in: path name: organizationsId @@ -13872,48 +13686,68 @@ paths: schema: type: string - in: path - name: developersId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: updateMask schema: type: string + format: google-fieldmask - in: query - name: action + name: replaceRepeatedFields schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: - parameters: *ref_51 + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: + parameters: *ref_1 post: description: >- - Creates a custom consumer key and secret for a developer app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the UpdateDeveloperAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteDeveloperAppKey API. **Note**: All keys start out with - status=approved, even if status=revoked is passed when the key is - created. To revoke a key, use the UpdateDeveloperAppKey API. - operationId: apigee.organizations.developers.apps.keys.create + Sets the IAM policy on an environment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.environments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: environmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the IAM policy on an environment. For more information, see [Manage + users, roles, and permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.environments.getIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13925,7 +13759,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -13933,20 +13767,20 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: path - name: appsId - required: true + - in: query + name: options.requestedPolicyVersion schema: - type: string - /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: - parameters: *ref_51 + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: + parameters: *ref_1 get: - description: Gets the monetization configuration for the developer. - operationId: apigee.organizations.developers.getMonetizationConfig + description: Gets the add-ons config of an environment. + operationId: apigee.organizations.environments.getAddonsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13958,8 +13792,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' parameters: - in: path name: organizationsId @@ -13967,19 +13800,20 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - put: - description: Updates the monetization configuration for the developer. - operationId: apigee.organizations.developers.updateMonetizationConfig + /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: + parameters: *ref_1 + post: + description: Deletes a subscription for the environment's Pub/Sub topic. + operationId: apigee.organizations.environments.unsubscribe requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13991,8 +13825,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -14000,23 +13833,24 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers: - parameters: *ref_51 - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: + parameters: *ref_1 + patch: description: >- - Creates a developer. Once created, the developer can register an app and - obtain an API key. At creation time, a developer is set as `active`. To - change the developer status, use the SetDeveloperStatus API. - operationId: apigee.organizations.developers.create + Updates the trace configurations in an environment. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.updateTraceConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14028,22 +13862,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: >- - Lists all developers in an organization by email address. By default, - the response does not include company developers. Set the - `includeCompany` query parameter to `true` to include company - developers. **Note**: A maximum of 1000 developers are returned in the - response. You paginate the list of developers returned using the - `startKey` and `count` query parameters. - operationId: apigee.organizations.developers.list + description: Get distributed trace configuration in an environment. + operationId: apigee.organizations.environments.getTraceConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14055,53 +13893,53 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: count - schema: - type: string - format: int64 - - in: query - name: expand - schema: - type: boolean - - in: query - name: startKey + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: ids + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: + parameters: *ref_1 + get: + description: Gets the deployed configuration for an environment. + operationId: apigee.organizations.environments.getDeployedConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: includeCompany - schema: - type: boolean - - in: query - name: app + - in: path + name: environmentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}: - parameters: *ref_51 - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: + parameters: *ref_1 + get: description: >- - Sets the status of a developer. A developer is `active` by default. If - you set a developer's status to `inactive`, the API keys assigned to the - developer apps are no longer valid even though the API keys are set to - `approved`. Inactive developers can still sign in to the developer - portal and create apps; however, any new API keys generated during app - creation won't work. To set the status of a developer, set the `action` - query parameter to `active` or `inactive`, and the `Content-Type` header - to `application/octet-stream`. If successful, the API call returns the - following HTTP status code: `204 No Content` - operationId: apigee.organizations.developers.setDeveloperStatus + GetSecurityActionConfig returns the current SecurityActions + configuration. + operationId: apigee.organizations.environments.getSecurityActionsConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14113,7 +13951,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -14121,31 +13959,21 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: query - name: action - schema: - type: string - put: + patch: description: >- - Updates a developer. This API replaces the existing developer details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. The custom - attribute limit is 18. **Note**: OAuth access tokens and Key Management - Service (KMS) entities (apps, developers, and API products) are cached - for 180 seconds (current default). Any custom attributes associated with - these entities are cached for at least 180 seconds after the entity is - accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 - policy won't be able to expire an access token in less than 180 seconds. - operationId: apigee.organizations.developers.update + UpdateSecurityActionConfig updates the current SecurityActions + configuration. This method is used to enable/disable the feature at the + environment level. + operationId: apigee.organizations.environments.updateSecurityActionsConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14157,7 +13985,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' parameters: - in: path name: organizationsId @@ -14165,16 +13993,23 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - get: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: + parameters: *ref_1 + post: description: >- - Returns the developer details, including the developer's name, email - address, apps, and other information. **Note**: The response includes - only the first 100 developer apps. - operationId: apigee.organizations.developers.get + Creates a subscription for the environment's Pub/Sub topic. The server + will assign a random name for this subscription. The "name" and + "push_config" must *not* be specified. + operationId: apigee.organizations.environments.subscribe security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14186,7 +14021,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' parameters: - in: path name: organizationsId @@ -14194,25 +14029,18 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - - in: query - name: action - schema: - type: string - delete: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: + parameters: *ref_1 + get: description: >- - Deletes a developer. All apps and API keys associated with the developer - are also removed. **Warning**: This API will permanently delete the - developer and related artifacts. To avoid permanently deleting - developers and their artifacts, set the developer status to `inactive` - using the SetDeveloperStatus API. **Note**: The delete operation is - asynchronous. The developer app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.developers.delete + Gets the API Security runtime configuration for an environment. This + named ApiSecurityRuntimeConfig to prevent conflicts with + ApiSecurityConfig from addon config. + operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14224,7 +14052,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig parameters: - in: path name: organizationsId @@ -14232,15 +14061,24 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/developers/{developersId}/balance: - parameters: *ref_51 - get: - description: Gets the account balance for the developer. - operationId: apigee.organizations.developers.getBalance + /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Tests the permissions of a user on an environment, and returns a subset + of permissions that the user has on the environment. If the environment + does not exist, an empty permission set is returned (a NOT_FOUND error + is not returned). + operationId: apigee.organizations.environments.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14252,7 +14090,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -14260,25 +14098,20 @@ paths: schema: type: string - in: path - name: developersId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: - parameters: *ref_51 - put: - description: >- - Updates an AppGroup. This API replaces the existing AppGroup details - with those specified in the request. Include or exclude any existing - details that you want to retain or delete, respectively. Note that the - state of the AppGroup should be updated using `action`, and not via - AppGroup. - operationId: apigee.organizations.appgroups.update + /v1/organizations/{organizationsId}/environments: + parameters: *ref_1 + post: + description: Creates an environment in an organization. + operationId: apigee.organizations.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14290,31 +14123,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: appgroupsId - required: true - schema: - type: string - in: query - name: action + name: name schema: type: string - delete: - description: >- - Deletes an AppGroup. All app and API keys associations with the AppGroup - are also removed. **Warning**: This API will permanently delete the - AppGroup and related artifacts. **Note**: The delete operation is - asynchronous. The AppGroup app is deleted immediately, but its - associated resources, such as apps and API keys, may take anywhere from - a few seconds to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: + parameters: *ref_1 + put: + description: Attaches a shared flow to a flow hook. + operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14326,7 +14155,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -14334,15 +14163,18 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - get: - description: >- - Returns the AppGroup details for the provided AppGroup name in the - request URI. - operationId: apigee.organizations.appgroups.get + - in: path + name: flowhooksId + required: true + schema: + type: string + delete: + description: Detaches a shared flow from a flow hook. + operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14354,7 +14186,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId @@ -14362,47 +14194,21 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups: - parameters: *ref_51 - post: - description: >- - Creates an AppGroup. Once created, user can register apps under the - AppGroup to obtain secret key and password. At creation time, the - AppGroup's state is set as `active`. - operationId: apigee.organizations.appgroups.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' - parameters: - in: path - name: organizationsId + name: flowhooksId required: true schema: type: string get: description: >- - Lists all AppGroups in an organization. A maximum of 1000 AppGroups are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.list + Returns the name of the shared flow attached to the specified flow hook. + If there's no shared flow attached to the flow hook, the API does not + return an error; it simply does not return a name in the response. + operationId: apigee.organizations.environments.flowhooks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14414,45 +14220,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: flowhooksId + required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: - parameters: *ref_51 + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: + parameters: *ref_1 put: description: >- - Updates the details for an AppGroup app. In addition, you can add an API - product to an AppGroup app and automatically generate an API key for the - app to use when calling APIs in the API product. If you want to use an - existing API key for the API product, add the API product to the API key - using the UpdateAppGroupAppKey API. Using this API, you cannot update - the app name, as it is the primary key used to identify the app and - cannot be changed. This API replaces the existing attributes with those - specified in the request. Include or exclude any existing attributes - that you want to retain or delete, respectively. - operationId: apigee.organizations.appgroups.apps.update + Updates an existing TargetServer. Note that this operation has PUT + semantics; it will replace the entirety of the existing TargetServer + with the resource in the request body. + operationId: apigee.organizations.environments.targetservers.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14464,7 +14261,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -14472,22 +14269,18 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: targetserversId required: true schema: type: string - - in: query - name: action - schema: - type: string get: - description: Returns the details for an AppGroup app. - operationId: apigee.organizations.appgroups.apps.get + description: Gets a TargetServer resource. + operationId: apigee.organizations.environments.targetservers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14499,7 +14292,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -14507,22 +14300,20 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: targetserversId required: true schema: type: string delete: description: >- - Deletes an AppGroup app. **Note**: The delete operation is asynchronous. - The AppGroup app is deleted immediately, but its associated resources, - such as app keys or access tokens, may take anywhere from a few seconds - to a few minutes to be deleted. - operationId: apigee.organizations.appgroups.apps.delete + Deletes a TargetServer from an environment. Returns the deleted + TargetServer resource. + operationId: apigee.organizations.environments.targetservers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14534,7 +14325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -14542,61 +14333,25 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: targetserversId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: - parameters: *ref_51 + /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: + parameters: *ref_1 post: - description: >- - Creates an app and associates it with an AppGroup. This API associates - the AppGroup app with the specified API product and auto-generates an - API key for the app to use in calls to API proxies inside that API - product. The `name` is the unique ID of the app that you can use in API - calls. - operationId: apigee.organizations.appgroups.apps.create + description: Creates a TargetServer in the specified environment. + operationId: apigee.organizations.environments.targetservers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: appgroupsId - required: true - schema: - type: string - get: - description: >- - Lists all apps created by an AppGroup in an Apigee organization. - Optionally, you can request an expanded view of the AppGroup apps. Lists - all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are - returned in the response if PageSize is not specified, or if the - PageSize is greater than 1000. - operationId: apigee.organizations.appgroups.apps.list + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14608,8 +14363,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' parameters: - in: path name: organizationsId @@ -14617,41 +14371,19 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: name schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: - parameters: *ref_51 - post: - description: >- - Creates a custom consumer key and secret for a AppGroup app. This is - particularly useful if you want to migrate existing consumer keys and - secrets to Apigee from another system. Consumer keys and secrets can - contain letters, numbers, underscores, and hyphens. No other special - characters are allowed. To avoid service disruptions, a consumer key and - secret should not exceed 2 KBs each. **Note**: When creating the - consumer key and secret, an association to API products will not be - made. Therefore, you should not specify the associated API products in - your request. Instead, use the ProductizeAppGroupAppKey API to make the - association after the consumer key and secret are created. If a consumer - key and secret already exist, you can keep them or delete them using the - DeleteAppGroupAppKey API. - operationId: apigee.organizations.appgroups.apps.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: + parameters: *ref_1 + get: + description: Gets a keystore or truststore. + operationId: apigee.organizations.environments.keystores.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14663,7 +14395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -14671,23 +14403,18 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: keystoresId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: - parameters: *ref_51 delete: - description: >- - Deletes an app's consumer key and removes all API products associated - with the app. After the consumer key is deleted, it cannot be used to - access any APIs. - operationId: apigee.organizations.appgroups.apps.keys.delete + description: Deletes a keystore or truststore. + operationId: apigee.organizations.environments.keystores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14699,7 +14426,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -14707,25 +14434,30 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: keystoresId required: true schema: type: string - get: + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: + parameters: *ref_1 + post: description: >- - Gets details for a consumer key for a AppGroup app, including the key - and secret value, associated API products, and other information. - operationId: apigee.organizations.appgroups.apps.keys.get + Creates a keystore or truststore. - Keystore: Contains certificates and + their associated keys. - Truststore: Contains trusted certificates used + to validate a server's certificate. These certificates are typically + self-signed certificates or certificates that are not signed by a + trusted CA. + operationId: apigee.organizations.environments.keystores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14737,7 +14469,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' parameters: - in: path name: organizationsId @@ -14745,36 +14477,19 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: name schema: type: string - post: - description: >- - Adds an API product to an AppGroupAppKey, enabling the app that holds - the key to access the API resources bundled in the API product. In - addition, you can add attributes to the AppGroupAppKey. This API - replaces the existing attributes with those specified in the request. - Include or exclude any existing attributes that you want to retain or - delete, respectively. You can use the same key to access all API - products associated with the app. - operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: + parameters: *ref_1 + get: + description: Gets an alias. + operationId: apigee.organizations.environments.keystores.aliases.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14786,7 +14501,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -14794,29 +14509,23 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: keystoresId required: true schema: type: string - in: path - name: keysId + name: aliasesId required: true schema: type: string - /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: - parameters: *ref_51 delete: - description: >- - Removes an API product from an app's consumer key. After the API product - is removed, the app cannot access the API resources defined in that API - product. **Note**: The consumer key is not removed, only its association - with the API product. - operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete + description: Deletes an alias. + operationId: apigee.organizations.environments.keystores.aliases.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14828,7 +14537,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -14836,35 +14545,28 @@ paths: schema: type: string - in: path - name: appgroupsId - required: true - schema: - type: string - - in: path - name: appsId + name: environmentsId required: true schema: type: string - in: path - name: keysId + name: keystoresId required: true schema: type: string - in: path - name: apiproductsId + name: aliasesId required: true schema: type: string - post: - description: >- - Approves or revokes the consumer key for an API product. After a - consumer key is approved, the app can use it to access APIs. A consumer - key that is revoked or pending cannot be used to access an API. Any - access tokens associated with a revoked consumer key will remain active. - However, Apigee checks the status of the consumer key and if set to - `revoked` will not allow access to the API. - operationId: >- - apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct + put: + description: Updates the certificate in an alias. + operationId: apigee.organizations.environments.keystores.aliases.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14876,7 +14578,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId @@ -14884,39 +14586,35 @@ paths: schema: type: string - in: path - name: appgroupsId + name: environmentsId required: true schema: type: string - in: path - name: appsId + name: keystoresId required: true schema: type: string - in: path - name: keysId + name: aliasesId required: true schema: type: string - - in: path - name: apiproductsId - required: true + - in: query + name: ignoreNewlineValidation schema: - type: string + type: boolean - in: query - name: action + name: ignoreExpiryValidation schema: - type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: - parameters: *ref_51 + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: + parameters: *ref_1 get: description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostQueries.getResult + Generates a PKCS #10 Certificate Signing Request for the private key in + an alias. + operationId: apigee.organizations.environments.keystores.aliases.csr security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14936,15 +14634,42 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries: - parameters: *ref_51 - get: - description: Return a list of Asynchronous Queries at host level. - operationId: apigee.organizations.hostQueries.list + - in: path + name: keystoresId + required: true + schema: + type: string + - in: path + name: aliasesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: + parameters: *ref_1 + post: + description: >- + Creates an alias from a key/certificate pair. The structure of the + request is controlled by the `format` query parameter: - `keycertfile` - + Separate PEM-encoded key and certificate files are uploaded. Set + `Content-Type: multipart/form-data` and include the `keyFile`, + `certFile`, and `password` (if keys are encrypted) fields in the request + body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A + PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, + provide the file in the `file` field, and include the `password` field + if the file is encrypted in the request body. - `selfsignedcert` - A new + private key and certificate are generated. Set `Content-Type: + application/json` and include CertificateGenerationSpec in the request + body. + operationId: apigee.organizations.environments.keystores.aliases.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14956,54 +14681,48 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: to + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: submittedBy + - in: path + name: keystoresId + required: true schema: type: string - in: query - name: status + name: format schema: type: string - in: query - name: inclQueriesWithoutReport + name: alias schema: type: string - in: query - name: dataset + name: ignoreNewlineValidation schema: - type: string + type: boolean - in: query - name: envgroupHostname + name: _password schema: type: string - in: query - name: from + name: ignoreExpiryValidation schema: - type: string - post: - description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostQueries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: + parameters: *ref_1 + get: + description: Gets the certificate from an alias in PEM-encoded form. + operationId: apigee.organizations.environments.keystores.aliases.getCertificate security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15015,49 +14734,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: - parameters: *ref_51 - get: - description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostQueries.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' - parameters: - in: path - name: organizationsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: keystoresId required: true schema: type: string - in: path - name: hostQueriesId + name: aliasesId required: true schema: type: string - /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: - parameters: *ref_51 - get: - description: '' - operationId: apigee.organizations.hostQueries.getResultView + /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: + parameters: *ref_1 + delete: + description: Deletes a cache. + operationId: apigee.organizations.environments.caches.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15069,7 +14772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -15077,21 +14780,26 @@ paths: schema: type: string - in: path - name: hostQueriesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: - parameters: *ref_51 + - in: path + name: cachesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: + parameters: *ref_1 get: description: >- - Retrieve metrics grouped by dimensions in host level. The types of - metrics you can retrieve include traffic, message counts, API call - latency, response size, and cache hits and counts. Dimensions let you - view metrics in meaningful groups. You can optionally pass dimensions as - path parameters to the `stats` API. If dimensions are not specified, the - metrics are computed on the entire set of data for the given time range. - operationId: apigee.organizations.hostStats.get + Retrieve metrics grouped by dimensions. The types of metrics you can + retrieve include traffic, message counts, API call latency, response + size, and cache hits and counts. Dimensions let you view metrics in + meaningful groups. You can optionally pass dimensions as path parameters + to the `stats` API. If dimensions are not specified, the metrics are + computed on the entire set of data for the given time range. + operationId: apigee.organizations.environments.stats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15111,40 +14819,45 @@ paths: schema: type: string - in: path - name: hostStatsId + name: environmentsId required: true schema: type: string - - in: query - name: topk + - in: path + name: statsId + required: true schema: type: string - in: query - name: sort + name: timeRange schema: type: string - in: query - name: sortby + name: accuracy schema: type: string - in: query - name: select + name: timeUnit schema: type: string - in: query - name: filter + name: topk schema: type: string - in: query - name: offset + name: realtime schema: - type: string + type: boolean - in: query name: tzo schema: type: string - in: query - name: envgroupHostname + name: aggTable + schema: + type: string + - in: query + name: sort schema: type: string - in: query @@ -15152,11 +14865,11 @@ paths: schema: type: boolean - in: query - name: accuracy + name: sonar schema: - type: string + type: boolean - in: query - name: timeRange + name: sortby schema: type: string - in: query @@ -15164,25 +14877,22 @@ paths: schema: type: string - in: query - name: timeUnit + name: select schema: type: string - in: query - name: realtime + name: offset schema: - type: boolean - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: - parameters: *ref_51 - put: - description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of a shared flow in an environment. + operationId: apigee.organizations.environments.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15194,7 +14904,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -15202,23 +14913,30 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string - delete: + /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 + post: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.delete + Deploys a revision of a shared flow. If another revision of the same + shared flow is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot use a shared flow until it has been deployed to an + environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.deploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15230,7 +14948,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -15238,21 +14956,37 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string - get: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: override + schema: + type: boolean + - in: query + name: serviceAccount + schema: + type: string + delete: description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.keyvaluemaps.entries.get + Undeploys a shared flow revision from an environment. For a request path + `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.sharedflowrevisions.undeploy` on the resource + `organizations/{org}/sharedflows/{sf}/revisions/{rev}` + operationId: apigee.organizations.environments.sharedflows.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15264,7 +14998,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -15272,23 +15006,25 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId + required: true + schema: + type: string + - in: path + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: - parameters: *ref_51 get: description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.list + Gets the deployment of a shared flow revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15300,8 +15036,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -15309,30 +15044,27 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: sharedflowsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: revisionsId + required: true schema: - type: integer - format: int32 - post: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: + parameters: *ref_1 + get: description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.keyvaluemaps.entries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + Lists the details and status of all analytics export jobs belonging to + the parent organization and environment. + operationId: apigee.organizations.environments.analytics.exports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15344,7 +15076,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' parameters: - in: path name: organizationsId @@ -15352,43 +15084,22 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/keyvaluemaps: - parameters: *ref_51 post: - description: Creates a key value map in an organization. - operationId: apigee.organizations.keyvaluemaps.create + description: >- + Submit a data export job to be processed in the background. If the + request is successful, the API returns a 201 status, a URI that can be + used to retrieve the status of the export job, and the `state` value of + "enqueued". + operationId: apigee.organizations.environments.analytics.exports.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_51 - delete: - description: Deletes a key value map from an organization. - operationId: apigee.organizations.keyvaluemaps.delete + $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15400,7 +15111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -15408,15 +15119,19 @@ paths: schema: type: string - in: path - name: keyvaluemapsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: - parameters: *ref_51 - delete: - description: Deletes an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: + parameters: *ref_1 + get: + description: >- + Gets the details and status of an analytics export job. If the export + job is still in progress, its `state` is set to "running". After the + export job has completed successfully, its `state` is set to + "completed". If the export job fails, its `state` is set to `failed`. + operationId: apigee.organizations.environments.analytics.exports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15428,7 +15143,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1Export' parameters: - in: path name: organizationsId @@ -15436,30 +15151,24 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: exportsId required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: + parameters: *ref_1 + get: description: >- - Updates the value of an API product attribute. **Note**: OAuth access - tokens and Key Management Service (KMS) entities (apps, developers, and - API products) are cached for 180 seconds (current default). Any custom - attributes associated with entities also get cached for at least 180 - seconds after entity is accessed during runtime. In this case, the - `ExpiresIn` element on the OAuthV2 policy won't be able to expire an - access token in less than 180 seconds. - operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + Gets a list of metrics and dimensions that can be used to create + analytics queries and reports. Each schema element contains the name of + the field, its associated type, and a flag indicating whether it is a + standard or custom field. + operationId: apigee.organizations.environments.analytics.admin.getSchemav2 security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15471,7 +15180,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' parameters: - in: path name: organizationsId @@ -15479,18 +15188,32 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - - in: path - name: attributesId - required: true + - in: query + name: disableCache + schema: + type: boolean + - in: query + name: type schema: type: string - get: - description: Gets the value of an API product attribute. - operationId: apigee.organizations.apiproducts.attributes.get + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Tests the permissions of a user on a deployment, and returns a subset of + permissions that the user has on the deployment. If the deployment does + not exist, an empty permission set is returned (a NOT_FOUND error is not + returned). + operationId: apigee.organizations.environments.deployments.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15502,7 +15225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: organizationsId @@ -15510,20 +15233,22 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: attributesId + name: deploymentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: - parameters: *ref_51 + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}: + parameters: *ref_1 get: - description: Lists all API product attributes. - operationId: apigee.organizations.apiproducts.attributes.list + description: >- + Gets a particular deployment of Api proxy or a shared flow in an + environment + operationId: apigee.organizations.environments.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15535,7 +15260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId @@ -15543,29 +15268,31 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: deploymentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy: + parameters: *ref_1 post: description: >- - Updates or creates API product attributes. This API **replaces** the - current list of attributes with the attributes specified in the request - body. In this way, you can update existing attributes, add new - attributes, or delete existing attributes by omitting them from the - request body. **Note**: OAuth access tokens and Key Management Service - (KMS) entities (apps, developers, and API products) are cached for 180 - seconds (current default). Any custom attributes associated with - entities also get cached for at least 180 seconds after entity is - accessed during runtime. In this case, the `ExpiresIn` element on the - OAuthV2 policy won't be able to expire an access token in less than 180 - seconds. - operationId: apigee.organizations.apiproducts.attributes + Sets the IAM policy on a deployment, if the policy already exists it + will be replaced. For more information, see [Manage users, roles, and + permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.setIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15577,7 +15304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -15585,30 +15312,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: - parameters: *ref_51 - post: + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy: + parameters: *ref_1 + get: description: >- - Create a rate plan that is associated with an API product in an - organization. Using rate plans, API product owners can monetize their - API products by configuring one or more of the following: - Billing - frequency - Initial setup fees for using an API product - Payment - funding model (postpaid only) - Fixed recurring or consumption-based - charges for using an API product - Revenue sharing with developer - partners An API product can have multiple rate plans associated with it - but *only one* rate plan can be active at any point of time. **Note: - From the developer's perspective, they purchase API products not rate - plans. - operationId: apigee.organizations.apiproducts.rateplans.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + Gets the IAM policy on a deployment. For more information, see [Manage + users, roles, and permissions using the + API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). + You must have the `apigee.deployments.getIamPolicy` permission to call + this API. + operationId: apigee.organizations.environments.deployments.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15620,7 +15342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: organizationsId @@ -15628,13 +15350,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId + required: true + schema: + type: string + - in: path + name: deploymentsId required: true schema: type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: + parameters: *ref_1 get: - description: Lists all the rate plans for an API product. - operationId: apigee.organizations.apiproducts.rateplans.list + description: Lists all deployments of API proxies or shared flows in an environment. + operationId: apigee.organizations.environments.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15646,7 +15380,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -15654,36 +15389,19 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: query - name: expand + name: sharedFlows schema: type: boolean - - in: query - name: startKey - schema: - type: string - - in: query - name: state - schema: - type: string - - in: query - name: count - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: - parameters: *ref_51 - get: - description: Gets the details of a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.get + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an environment. + operationId: apigee.organizations.environments.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15695,7 +15413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -15703,23 +15421,25 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - in: path - name: rateplansId + name: keyvaluemapsId required: true schema: type: string - put: - description: Updates an existing rate plan. - operationId: apigee.organizations.apiproducts.rateplans.update + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: + parameters: *ref_1 + post: + description: Creates a key value map in an environment. + operationId: apigee.organizations.environments.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15731,7 +15451,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -15739,18 +15459,20 @@ paths: schema: type: string - in: path - name: apiproductsId - required: true - schema: - type: string - - in: path - name: rateplansId + name: environmentsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + parameters: *ref_1 delete: - description: Deletes a rate plan. - operationId: apigee.organizations.apiproducts.rateplans.delete + description: >- + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15762,7 +15484,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -15770,63 +15492,30 @@ paths: schema: type: string - in: path - name: apiproductsId - required: true - schema: - type: string - - in: path - name: rateplansId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: - parameters: *ref_51 - put: - description: >- - Updates an existing API product. You must include all required values, - whether or not you are updating them, as well as any optional values - that you are updating. The API product name required in the request URL - is the internal name of the product, not the display name. While they - may be the same, it depends on whether the API product was created via - UI or API. View the list of API products to identify their internal - names. - operationId: apigee.organizations.apiproducts.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' - parameters: - in: path - name: organizationsId + name: keyvaluemapsId required: true schema: type: string - in: path - name: apiproductsId + name: entriesId required: true schema: type: string - get: + put: description: >- - Gets configuration details for an API product. The API product name - required in the request URL is the internal name of the product, not the - display name. While they may be the same, it depends on whether the API - product was created via the UI or the API. View the list of API products - to verify the internal name. - operationId: apigee.organizations.apiproducts.get + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.environments.keyvaluemaps.entries.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15838,7 +15527,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -15846,21 +15535,26 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - delete: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + get: description: >- - Deletes an API product from an organization. Deleting an API product - causes app requests to the resource URIs defined in the API product to - fail. Ensure that you create a new API product to serve existing apps, - unless your intention is to disable access to the resources defined in - the API product. The API product name required in the request URL is the - internal name of the product, not the display name. While they may be - the same, it depends on whether the API product was created via the UI - or the API. View the list of API products to verify the internal name. - operationId: apigee.organizations.apiproducts.delete + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15872,7 +15566,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -15880,38 +15574,33 @@ paths: schema: type: string - in: path - name: apiproductsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/apiproducts: - parameters: *ref_51 + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: + parameters: *ref_1 post: description: >- - Creates an API product in an organization. You create API products after - you have proxied backend services using API proxies. An API product is a - collection of API resources combined with quota settings and metadata - that you can use to deliver customized and productized API bundles to - your developer community. This metadata can include: - Scope - - Environments - API proxies - Extensible profile API products enable you - repackage APIs on the fly, without having to do any additional coding or - configuration. Apigee recommends that you start with a simple API - product including only required elements. You then provision credentials - to apps to enable them to start testing your APIs. After you have - authentication and authorization working against a simple API product, - you can iterate to create finer-grained API products, defining different - sets of API resources for each API product. **WARNING:** - If you don't - specify an API proxy in the request body, *any* app associated with the - product can make calls to *any* API in your entire organization. - If - you don't specify an environment in the request body, the product allows - access to all environments. For more information, see What is an API - product? - operationId: apigee.organizations.apiproducts.create + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15923,20 +15612,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string get: description: >- - Lists all API product names for an organization. Filter the list by - passing an `attributename` and `attibutevalue`. The maximum number of - API products returned is 1000. You can paginate the list of API products - returned using the `startKey` and `count` query parameters. - operationId: apigee.organizations.apiproducts.list + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.environments.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15949,39 +15647,37 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: expand - schema: - type: boolean - - in: query - name: attributevalue + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: startKey + - in: path + name: keyvaluemapsId + required: true schema: type: string - in: query - name: count + name: pageSize schema: - type: string - format: int64 + type: integer + format: int32 - in: query - name: attributename + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: - parameters: *ref_51 - delete: - description: Deletes an endpoint attachment. - operationId: apigee.organizations.endpointAttachments.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: + parameters: *ref_1 + get: + description: Gets a Reference resource. + operationId: apigee.organizations.environments.references.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -15993,7 +15689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -16001,13 +15697,20 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: environmentsId required: true schema: type: string - get: - description: Gets the endpoint attachment. - operationId: apigee.organizations.endpointAttachments.get + - in: path + name: referencesId + required: true + schema: + type: string + delete: + description: >- + Deletes a Reference from an environment. Returns the deleted Reference + resource. + operationId: apigee.organizations.environments.references.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16019,7 +15722,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId @@ -16027,53 +15730,26 @@ paths: schema: type: string - in: path - name: endpointAttachmentsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/endpointAttachments: - parameters: *ref_51 - get: - description: Lists the endpoint attachments in an organization. - operationId: apigee.organizations.endpointAttachments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse - parameters: - in: path - name: organizationsId + name: referencesId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: + put: description: >- - Creates an endpoint attachment. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.endpointAttachments.create + Updates an existing Reference. Note that this operation has PUT + semantics; it will replace the entirety of the existing Reference with + the resource in the request body. + operationId: apigee.organizations.environments.references.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16085,25 +15761,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: endpointAttachmentId + - in: path + name: environmentsId + required: true schema: type: string - /v1/organizations/{organizationsId}/apis: - parameters: *ref_51 - get: - description: >- - Lists the names of all API proxies in an organization. The names - returned correspond to the names defined in the configuration files for - each API proxy. - operationId: apigee.organizations.apis.list + - in: path + name: referencesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/references: + parameters: *ref_1 + post: + description: Creates a Reference in the specified environment. + operationId: apigee.organizations.environments.references.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16115,44 +15799,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: includeRevisions - schema: - type: boolean - - in: query - name: includeMetaData + - in: path + name: environmentsId + required: true schema: - type: boolean - post: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: + parameters: *ref_1 + get: description: >- - Creates an API proxy. The API proxy created will not be accessible at - runtime until it is deployed to an environment. Create a new API proxy - by setting the `name` query parameter to the name of the API proxy. - Import an API proxy configuration bundle stored in zip format on your - local machine to your organization by doing the following: * Set the - `name` query parameter to the name of the API proxy. * Set the `action` - query parameter to `import`. * Set the `Content-Type` header to - `multipart/form-data`. * Pass as a file the name of API proxy - configuration bundle stored in zip format on your local machine using - the `file` form field. **Note**: To validate the API proxy configuration - bundle only without importing it, set the `action` query parameter to - `validate`. When importing an API proxy configuration bundle, if the API - proxy does not exist, it will be created. If the API proxy exists, then - a new revision is created. Invalid API proxy configurations are - rejected, and a list of validation errors is returned to the client. - operationId: apigee.organizations.apis.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + After the query is completed, use this API to retrieve the results as + file. If the request succeeds, and there is a non-zero result set, the + result is downloaded to the client as a zipped JSON file. The name of + the downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.securityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16164,33 +15832,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: action + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: name + - in: path + name: securityReportsId + required: true schema: type: string - - in: query - name: validate - schema: - type: boolean - /v1/organizations/{organizationsId}/apis/{apisId}: - parameters: *ref_51 - delete: + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: + parameters: *ref_1 + get: description: >- - Deletes an API proxy and all associated endpoints, policies, resources, - and revisions. The API proxy must be undeployed before you can delete - it. - operationId: apigee.organizations.apis.delete + Get security report status If the query is still in progress, the + `state` is set to "running" After the query has completed successfully, + `state` is set to "completed" + operationId: apigee.organizations.environments.securityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16202,7 +15868,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -16210,13 +15876,29 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - get: - description: Gets an API proxy including a list of existing revisions. - operationId: apigee.organizations.apis.get + - in: path + name: securityReportsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: + parameters: *ref_1 + post: + description: >- + Submit a report request to be processed in the background. If the + submission succeeds, the API returns a 200 status and an ID that refer + to the report request. In addition to the HTTP status 200, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.environments.securityReports.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16228,7 +15910,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -16236,18 +15918,13 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - patch: - description: Updates an existing API proxy. - operationId: apigee.organizations.apis.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + get: + description: Return a list of Security Reports + operationId: apigee.organizations.environments.securityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16259,7 +15936,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId @@ -16267,27 +15945,46 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: query - name: updateMask + name: from schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: - parameters: *ref_51 + - in: query + name: submittedBy + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: to + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: dataset + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: + parameters: *ref_1 get: description: >- - Gets an API proxy revision. To download the API proxy configuration - bundle for the specified revision as a zip file, set the `format` query - parameter to `bundle`. If you are using curl, specify `-o filename.zip` - to save the output to a file; otherwise, it displays to `stdout`. Then, - develop the API proxy configuration locally and upload the updated API - proxy configuration revision, as described in - [updateApiProxyRevision](updateApiProxyRevision). - operationId: apigee.organizations.apis.revisions.get + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.environments.securityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16299,7 +15996,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -16307,25 +16005,20 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: path - name: revisionsId + name: securityReportsId required: true schema: type: string - - in: query - name: format - schema: - type: string - delete: - description: >- - Deletes an API proxy revision and all policies, resources, endpoints, - and revisions associated with it. The API proxy revision must be - undeployed before you can delete it. - operationId: apigee.organizations.apis.revisions.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of an API proxy in an environment. + operationId: apigee.organizations.environments.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16337,7 +16030,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -16345,29 +16039,26 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: path - name: revisionsId + name: apisId required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 + delete: description: >- - Updates an existing API proxy revision by uploading the API proxy - configuration bundle as a zip file from your local machine. You can - update only API proxy revisions that have never been deployed. After - deployment, an API proxy revision becomes immutable, even if it is - undeployed. Set the `Content-Type` header to either - `multipart/form-data` or `application/octet-stream`. - operationId: apigee.organizations.apis.revisions.updateApiProxyRevision - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + Undeploys an API proxy revision from an environment. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: apigee.organizations.environments.apis.revisions.undeploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16379,13 +16070,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: path name: apisId required: true @@ -16397,14 +16093,14 @@ paths: schema: type: string - in: query - name: validate + name: sequencedRollout schema: type: boolean - /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: - parameters: *ref_51 get: - description: Lists all deployments of an API proxy revision. - operationId: apigee.organizations.apis.revisions.deployments.list + description: >- + Gets the deployment of an API proxy revision and actual state reported + by runtime pods. + operationId: apigee.organizations.environments.apis.revisions.getDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16416,14 +16112,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: path name: apisId required: true @@ -16434,11 +16134,21 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/deployments: - parameters: *ref_51 - get: - description: Lists all deployments of an API proxy. - operationId: apigee.organizations.apis.deployments.list + post: + description: >- + Deploys a revision of an API proxy. If another revision of the same API + proxy revision is currently deployed, set the `override` parameter to + `true` to have this revision replace the currently deployed revision. + You cannot invoke an API proxy until it has been deployed to an + environment. After you deploy an API proxy revision, you cannot edit it. + To edit the API proxy, you must create and deploy a new revision. For a + request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: apigee.organizations.environments.apis.revisions.deploy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16450,32 +16160,59 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: path name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: - parameters: *ref_51 + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: serviceAccount + schema: + type: string + - in: query + name: override + schema: + type: boolean + - in: query + name: sequencedRollout + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: + parameters: *ref_1 post: description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + Generates a report for a dry run analysis of a DeployApiProxy request + without committing the deployment. In addition to the standard + validations performed when adding deployments, additional analysis will + be done to detect possible traffic routing changes that would result + from this deployment being created. Any potential routing conflicts or + unsafe changes will be reported in the response. This routing analysis + is not performed for a non-dry-run DeployApiProxy request. For a request + path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, + two permissions are required: * `apigee.deployments.create` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.deploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: >- + apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16487,29 +16224,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: path name: apisId required: true schema: type: string - in: path - name: keyvaluemapsId + name: revisionsId required: true schema: type: string - get: + - in: query + name: override + schema: + type: boolean + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: + parameters: *ref_1 + post: description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.list + Generates a report for a dry run analysis of an UndeployApiProxy request + without committing the undeploy. In addition to the standard validations + performed when removing deployments, additional analysis will be done to + detect possible traffic routing changes that would result from this + deployment being removed. Any potential routing conflicts or unsafe + changes will be reported in the response. This routing analysis is not + performed for a non-dry-run UndeployApiProxy request. For a request path + `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, + two permissions are required: * `apigee.deployments.delete` on the + resource `organizations/{org}/environments/{env}` * + `apigee.proxyrevisions.undeploy` on the resource + `organizations/{org}/apis/{api}/revisions/{rev}` + operationId: >- + apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16521,8 +16279,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' parameters: - in: path name: organizationsId @@ -16530,36 +16287,25 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: apisId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: revisionsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: - parameters: *ref_51 - put: - description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.apis.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: + parameters: *ref_1 + get: + description: Gets the debug data from a transaction. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16571,34 +16317,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: path name: apisId required: true schema: type: string - in: path - name: keyvaluemapsId + name: revisionsId required: true schema: type: string - in: path - name: entriesId + name: debugsessionsId required: true schema: type: string - get: + - in: path + name: dataId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: + parameters: *ref_1 + delete: description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.get + Deletes the data from a debug session. This does not cancel the debug + session or prevent further data from being collected if the session is + still active in runtime pods. + operationId: >- + apigee.organizations.environments.apis.revisions.debugsessions.deleteData security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16610,36 +16370,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: path name: apisId required: true schema: type: string - in: path - name: keyvaluemapsId + name: revisionsId required: true schema: type: string - in: path - name: entriesId + name: debugsessionsId required: true schema: type: string - delete: + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: + parameters: *ref_1 + get: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.apis.keyvaluemaps.entries.delete + Lists debug sessions that are currently active in the given API Proxy + revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16651,7 +16415,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse parameters: - in: path name: organizationsId @@ -16659,30 +16424,37 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: apisId required: true schema: type: string - in: path - name: entriesId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: - parameters: *ref_51 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Creates a key value map in an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.create + description: Creates a debug session for a deployed API Proxy revision. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16694,23 +16466,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: path name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_51 - delete: - description: Deletes a key value map from an API proxy. - operationId: apigee.organizations.apis.keyvaluemaps.delete + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: timeout + schema: + type: string + format: int64 + /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: + parameters: *ref_1 + get: + description: Retrieves a debug session. + operationId: apigee.organizations.environments.apis.revisions.debugsessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16722,7 +16509,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' parameters: - in: path name: organizationsId @@ -16730,51 +16517,33 @@ paths: schema: type: string - in: path - name: apisId + name: environmentsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/reports/{reportsId}: - parameters: *ref_51 - put: - description: Update an existing custom report definition - operationId: apigee.organizations.reports.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' - parameters: - in: path - name: organizationsId + name: revisionsId required: true schema: type: string - in: path - name: reportsId + name: debugsessionsId required: true schema: type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: + parameters: *ref_1 get: - description: Retrieve a custom report definition. - operationId: apigee.organizations.reports.get + description: >- + Gets the contents of a resource file. For more information about + resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16786,7 +16555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -16794,54 +16563,26 @@ paths: schema: type: string - in: path - name: reportsId + name: environmentsId required: true schema: type: string - delete: - description: Deletes an existing custom report definition - operationId: apigee.organizations.reports.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse - parameters: - in: path - name: organizationsId + name: type required: true schema: type: string - in: path - name: reportsId + name: name required: true schema: type: string - /v1/organizations/{organizationsId}/reports: - parameters: *ref_51 - post: + delete: description: >- - Creates a Custom Report for an Organization. A Custom Report provides - Apigee Customers to create custom dashboards in addition to the standard - dashboards which are provided. The Custom Report in its simplest form - contains specifications about metrics, dimensions and filters. It is - important to note that the custom report by itself does not provide an - executable entity. The Edge UI converts the custom report definition - into an analytics query and displays the result in a chart. - operationId: apigee.organizations.reports.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + Deletes a resource file. For more information about resource files, see + [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16853,16 +16594,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId required: true schema: type: string - get: - description: Return a list of Custom Reports - operationId: apigee.organizations.reports.list + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: type + required: true + schema: + type: string + - in: path + name: name + required: true + schema: + type: string + put: + description: >- + Updates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16874,28 +16639,42 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: expand + - in: path + name: environmentsId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/securityProfiles: - parameters: *ref_51 + type: string + - in: path + name: type + required: true + schema: + type: string + - in: path + name: name + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: + parameters: *ref_1 post: - description: CreateSecurityProfile create a new custom security profile. - operationId: apigee.organizations.securityProfiles.create + description: >- + Creates a resource file. Specify the `Content-Type` as + `application/octet-stream` or `multipart/form-data`. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16907,22 +16686,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: query - name: securityProfileId + name: name + schema: + type: string + - in: query + name: type schema: type: string get: description: >- - ListSecurityProfiles lists all the security profiles associated with the - org including attached and unattached profiles. - operationId: apigee.organizations.securityProfiles.list + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16935,29 +16724,30 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: environmentsId + required: true schema: - type: integer - format: int32 + type: string - in: query - name: pageToken + name: type schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: - parameters: *ref_51 + /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: + parameters: *ref_1 get: description: >- - ListSecurityProfileRevisions lists all the revisions of the security - profile. - operationId: apigee.organizations.securityProfiles.listRevisions + Lists all resource files, optionally filtering by type. For more + information about resource files, see [Resource + files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). + operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16970,7 +16760,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse parameters: - in: path name: organizationsId @@ -16978,24 +16768,20 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: type + required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: - parameters: *ref_51 - delete: - description: DeleteSecurityProfile delete a profile with all its revisions. - operationId: apigee.organizations.securityProfiles.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: + parameters: *ref_1 + get: + description: Gets the specified ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17007,7 +16793,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId @@ -17015,18 +16801,25 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId + required: true + schema: + type: string + - in: path + name: archiveDeploymentsId required: true schema: type: string patch: - description: UpdateSecurityProfile update the metadata of security profile. - operationId: apigee.organizations.securityProfiles.patch + description: >- + Updates an existing ArchiveDeployment. Labels can modified but most of + the other fields are not modifiable. + operationId: apigee.organizations.environments.archiveDeployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17038,7 +16831,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' parameters: - in: path name: organizationsId @@ -17046,7 +16839,12 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId + required: true + schema: + type: string + - in: path + name: archiveDeploymentsId required: true schema: type: string @@ -17055,12 +16853,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: >- - GetSecurityProfile gets the specified security profile. Returns - NOT_FOUND if security profile is not present for the specified - organization. - operationId: apigee.organizations.securityProfiles.get + delete: + description: Deletes an archive deployment. + operationId: apigee.organizations.environments.archiveDeployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17072,7 +16867,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17080,17 +16875,25 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: - parameters: *ref_51 - delete: - description: >- - DeleteSecurityProfileEnvironmentAssociation removes profile environment - association i.e. detaches environment from security profile. - operationId: apigee.organizations.securityProfiles.environments.delete + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: + parameters: *ref_1 + post: + description: Creates a new ArchiveDeployment. + operationId: apigee.organizations.environments.archiveDeployments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17102,7 +16905,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -17110,7 +16913,29 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId + required: true + schema: + type: string + get: + description: Lists the ArchiveDeployments in the specified Environment. + operationId: apigee.organizations.environments.archiveDeployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse + parameters: + - in: path + name: organizationsId required: true schema: type: string @@ -17119,20 +16944,41 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: - parameters: *ref_51 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: + parameters: *ref_1 post: description: >- - ComputeEnvironmentScores calculates scores for requested time range for - the specified security profile and environment. - operationId: >- - apigee.organizations.securityProfiles.environments.computeEnvironmentScores + Generates a signed URL for uploading an Archive zip file to Google Cloud + Storage. Once the upload is complete, the signed URL should be passed to + CreateArchiveDeployment. When uploading to the generated signed URL, + please follow these restrictions: * Source file type should be a zip + file. * Source file size should not exceed 1GB limit. * No credentials + should be attached - the signed URLs provide access to the target bucket + using internal service identity; if credentials were attached, the + identity from the credentials would be used, but that identity does not + have permissions to upload files to the URL. When making a HTTP PUT + request, these two headers need to be specified: * `content-type: + application/zip` * `x-goog-content-length-range: 0,1073741824` And this + header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` + operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17145,15 +16991,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse + #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: securityProfilesId + name: organizationsId required: true schema: type: string @@ -17162,19 +17003,21 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: - parameters: *ref_51 + /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: + parameters: *ref_1 post: description: >- - CreateSecurityProfileEnvironmentAssociation creates profile environment - association i.e. attaches environment to security profile. - operationId: apigee.organizations.securityProfiles.environments.create + Generates a signed URL for downloading the original zip file used to + create an Archive Deployment. The URL is only valid for a limited period + and should be used within minutes after generation. Each call returns a + new upload URL. + operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17187,7 +17030,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation + #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse parameters: - in: path name: organizationsId @@ -17195,23 +17038,20 @@ paths: schema: type: string - in: path - name: securityProfilesId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores:test: - parameters: *ref_51 - post: - description: >- - Test if Datastore configuration is correct. This includes checking if - credentials provided by customer have required permissions in target - destination storage - operationId: apigee.organizations.analytics.datastores.test - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + - in: path + name: archiveDeploymentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: + parameters: *ref_1 + get: + description: Similar to GetStats except that the response is less verbose. + operationId: apigee.organizations.environments.optimizedStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17223,23 +17063,97 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: - parameters: *ref_51 - put: - description: Update a Datastore - operationId: apigee.organizations.analytics.datastores.update + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: optimizedStatsId + required: true + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: sonar + schema: + type: boolean + - in: query + name: realtime + schema: + type: boolean + - in: query + name: filter + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: aggTable + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: select + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: sort + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: + parameters: *ref_1 + patch: + description: >- + Updates a distributed trace configuration override. Note that the + repeated fields have replace semantics when included in the field mask + and that they will be overwritten by the value of the fields in the + request body. + operationId: apigee.organizations.environments.traceConfig.overrides.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17251,7 +17165,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -17259,13 +17173,23 @@ paths: schema: type: string - in: path - name: datastoresId + name: environmentsId required: true schema: type: string - delete: - description: Delete a Datastore from an org. - operationId: apigee.organizations.analytics.datastores.delete + - in: path + name: overridesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17277,7 +17201,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId @@ -17285,13 +17209,18 @@ paths: schema: type: string - in: path - name: datastoresId + name: environmentsId required: true schema: type: string - get: - description: Get a Datastore - operationId: apigee.organizations.analytics.datastores.get + - in: path + name: overridesId + required: true + schema: + type: string + delete: + description: Deletes a distributed trace configuration override. + operationId: apigee.organizations.environments.traceConfig.overrides.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17303,7 +17232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -17311,15 +17240,22 @@ paths: schema: type: string - in: path - name: datastoresId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/analytics/datastores: - parameters: *ref_51 + - in: path + name: overridesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: + parameters: *ref_1 get: - description: List Datastores - operationId: apigee.organizations.analytics.datastores.list + description: >- + Lists all of the distributed trace configuration overrides in an + environment. + operationId: apigee.organizations.environments.traceConfig.overrides.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17331,25 +17267,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string - in: query - name: targetType + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string post: - description: Create a Datastore for an org - operationId: apigee.organizations.analytics.datastores.create + description: >- + Creates a trace configuration override. The response contains a + system-generated UUID, that can be used to view, update, or delete the + configuration override. Use the List API to view the existing trace + configuration overrides. + operationId: apigee.organizations.environments.traceConfig.overrides.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17361,18 +17312,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: - parameters: *ref_51 + - in: path + name: environmentsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: + parameters: *ref_1 get: - description: Gets the deployed ingress configuration for an environment group. - operationId: apigee.organizations.envgroups.getDeployedIngressConfig + description: >- + Returns a list of SecurityActions. This returns both enabled and + disabled actions. + operationId: apigee.organizations.environments.securityActions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17384,7 +17342,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse parameters: - in: path name: organizationsId @@ -17392,19 +17351,31 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - in: query - name: view + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: - parameters: *ref_51 - get: - description: Gets an environment group. - operationId: apigee.organizations.envgroups.get + - in: query + name: filter + schema: + type: string + post: + description: CreateSecurityAction creates a SecurityAction. + operationId: apigee.organizations.environments.securityActions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17416,7 +17387,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -17424,13 +17395,19 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - delete: - description: Deletes an environment group. - operationId: apigee.organizations.envgroups.delete + - in: query + name: securityActionId + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: + parameters: *ref_1 + get: + description: Get a SecurityAction by name. + operationId: apigee.organizations.environments.securityActions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17442,7 +17419,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -17450,18 +17427,30 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - patch: - description: Updates an environment group. - operationId: apigee.organizations.envgroups.patch + - in: path + name: securityActionsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: + parameters: *ref_1 + post: + description: >- + Enable a SecurityAction. The `state` of the SecurityAction after + enabling is `ENABLED`. `EnableSecurityAction` can be called on + SecurityActions in the state `DISABLED`; SecurityActions in a different + state (including `ENABLED) return an error. + operationId: apigee.organizations.environments.securityActions.enable requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17473,7 +17462,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId @@ -17481,20 +17470,30 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: securityActionsId + required: true schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/envgroups: - parameters: *ref_51 - get: - description: Lists all environment groups. - operationId: apigee.organizations.envgroups.list + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: + parameters: *ref_1 + post: + description: >- + Disable a SecurityAction. The `state` of the SecurityAction after + disabling is `DISABLED`. `DisableSecurityAction` can be called on + SecurityActions in the state `ENABLED`; SecurityActions in a different + state (including `DISABLED`) return an error. + operationId: apigee.organizations.environments.securityActions.disable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17506,31 +17505,33 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: environmentsId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: securityActionsId + required: true schema: type: string - post: - description: Creates a new environment group. - operationId: apigee.organizations.envgroups.create + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: + parameters: *ref_1 + patch: + description: UpdateSecurityIncidents updates an existing security incident. + operationId: apigee.organizations.environments.securityIncidents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17542,22 +17543,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: environmentsId + required: true + schema: + type: string + - in: path + name: securityIncidentsId + required: true + schema: + type: string - in: query - name: name + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: - parameters: *ref_51 + format: google-fieldmask get: - description: Gets an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.get + description: >- + GetSecurityIncident gets the specified security incident. Returns + NOT_FOUND if security incident is not present for the specified + organization and environment. + operationId: apigee.organizations.environments.securityIncidents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17569,8 +17582,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' parameters: - in: path name: organizationsId @@ -17578,18 +17590,22 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - in: path - name: attachmentsId + name: securityIncidentsId required: true schema: type: string - delete: - description: Deletes an environment group attachment. - operationId: apigee.organizations.envgroups.attachments.delete + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: + parameters: *ref_1 + get: + description: >- + ListSecurityIncidents lists all the security incident associated with + the environment. + operationId: apigee.organizations.environments.securityIncidents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17601,7 +17617,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -17609,26 +17626,36 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: path - name: attachmentsId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: - parameters: *ref_51 + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: + parameters: *ref_1 post: - description: Creates a new attachment of an environment to an environment group. - operationId: apigee.organizations.envgroups.attachments.create + description: >- + BatchUpdateSecurityIncident updates multiple existing security + incidents. + operationId: apigee.organizations.environments.securityIncidents.batchUpdate requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17640,7 +17667,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse parameters: - in: path name: organizationsId @@ -17648,13 +17676,20 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - get: - description: Lists all attachments of an environment group. - operationId: apigee.organizations.envgroups.attachments.list + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: + parameters: *ref_1 + post: + description: Retrieve security statistics as tabular rows. + operationId: apigee.organizations.environments.securityStats.queryTabularStats + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17667,7 +17702,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse + #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse parameters: - in: path name: organizationsId @@ -17675,26 +17710,55 @@ paths: schema: type: string - in: path - name: envgroupsId + name: environmentsId required: true schema: type: string - - in: query - name: pageToken + /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: + parameters: *ref_1 + post: + description: Retrieve security statistics as a collection of time series. + operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: pageSize + - in: path + name: environmentsId + required: true schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/operations: - parameters: *ref_51 + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: + parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: apigee.organizations.operations.list + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.environments.queries.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17706,34 +17770,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: environmentsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: queriesId + required: true schema: type: string - /v1/organizations/{organizationsId}/operations/{operationsId}: - parameters: *ref_51 - get: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: apigee.organizations.operations.get + Submit a query to be processed in the background. If the submission of + the query succeeds, the API returns a 201 status and an ID that refer to + the query. In addition to the HTTP status 201, the `state` of "enqueued" + means that the request succeeded. + operationId: apigee.organizations.environments.queries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17745,7 +17812,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -17753,15 +17820,13 @@ paths: schema: type: string - in: path - name: operationsId + name: environmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/deployments: - parameters: *ref_51 get: - description: Lists all deployments of a shared flow in an environment. - operationId: apigee.organizations.environments.sharedflows.deployments.list + description: Return a list of Asynchronous Queries + operationId: apigee.organizations.environments.queries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17774,7 +17839,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId @@ -17786,22 +17851,38 @@ paths: required: true schema: type: string - - in: path - name: sharedflowsId - required: true + - in: query + name: to schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: - parameters: *ref_51 - delete: + - in: query + name: inclQueriesWithoutReport + schema: + type: string + - in: query + name: from + schema: + type: string + - in: query + name: status + schema: + type: string + - in: query + name: dataset + schema: + type: string + - in: query + name: submittedBy + schema: + type: string + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: + parameters: *ref_1 + get: description: >- - Undeploys a shared flow revision from an environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.undeploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.undeploy + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + sent to the client as a list of urls to JSON files. + operationId: apigee.organizations.environments.queries.getResulturl security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17813,7 +17894,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse parameters: - in: path name: organizationsId @@ -17826,28 +17908,18 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: queriesId required: true schema: type: string - post: + /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: + parameters: *ref_1 + get: description: >- - Deploys a revision of a shared flow. If another revision of the same - shared flow is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot use a shared flow until it has been deployed to an - environment. For a request path - `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.sharedflowrevisions.deploy` on the resource - `organizations/{org}/sharedflows/{sf}/revisions/{rev}` - operationId: apigee.organizations.environments.sharedflows.revisions.deploy + Get query status If the query is still in progress, the `state` is set + to "running" After the query has completed successfully, `state` is set + to "completed" + operationId: apigee.organizations.environments.queries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17859,7 +17931,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -17872,28 +17944,21 @@ paths: schema: type: string - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId + name: queriesId required: true schema: type: string - - in: query - name: serviceAccount - schema: - type: string - - in: query - name: override - schema: - type: boolean - get: - description: >- - Gets the deployment of a shared flow revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.sharedflows.revisions.getDeployments + /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: + parameters: *ref_1 + post: + description: Updates an add-on enablement status of an environment. + operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17905,7 +17970,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -17917,21 +17982,11 @@ paths: required: true schema: type: string - - in: path - name: sharedflowsId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}: - parameters: *ref_51 + /v1/organizations/{organizationsId}/endpointAttachments/{endpointAttachmentsId}: + parameters: *ref_1 get: - description: Gets the specified ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.get + description: Gets the endpoint attachment. + operationId: apigee.organizations.endpointAttachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17943,7 +17998,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' parameters: - in: path name: organizationsId @@ -17951,18 +18006,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: archiveDeploymentsId + name: endpointAttachmentsId required: true schema: type: string delete: - description: Deletes an archive deployment. - operationId: apigee.organizations.environments.archiveDeployments.delete + description: Deletes an endpoint attachment. + operationId: apigee.organizations.endpointAttachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17974,7 +18024,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -17982,25 +18032,22 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: archiveDeploymentsId + name: endpointAttachmentsId required: true schema: type: string - patch: + /v1/organizations/{organizationsId}/endpointAttachments: + parameters: *ref_1 + post: description: >- - Updates an existing ArchiveDeployment. Labels can modified but most of - the other fields are not modifiable. - operationId: apigee.organizations.environments.archiveDeployments.patch + Creates an endpoint attachment. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.endpointAttachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1EndpointAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18012,38 +18059,58 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: endpointAttachmentId schema: type: string + get: + description: Lists the endpoint attachments in an organization. + operationId: apigee.organizations.endpointAttachments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEndpointAttachmentsResponse + parameters: - in: path - name: archiveDeploymentsId + name: organizationsId required: true schema: type: string - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments: - parameters: *ref_51 - post: - description: Creates a new ArchiveDeployment. - operationId: apigee.organizations.environments.archiveDeployments.create + /v1/organizations/{organizationsId}/reports/{reportsId}: + parameters: *ref_1 + put: + description: Update an existing custom report definition + operationId: apigee.organizations.reports.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ArchiveDeployment' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18055,7 +18122,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId @@ -18063,13 +18130,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: reportsId required: true schema: type: string - get: - description: Lists the ArchiveDeployments in the specified Environment. - operationId: apigee.organizations.environments.archiveDeployments.list + delete: + description: Deletes an existing custom report definition + operationId: apigee.organizations.reports.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18082,7 +18149,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListArchiveDeploymentsResponse + #/components/schemas/GoogleCloudApigeeV1DeleteCustomReportResponse parameters: - in: path name: organizationsId @@ -18090,45 +18157,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: reportsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments:generateUploadUrl: - parameters: *ref_51 - post: - description: >- - Generates a signed URL for uploading an Archive zip file to Google Cloud - Storage. Once the upload is complete, the signed URL should be passed to - CreateArchiveDeployment. When uploading to the generated signed URL, - please follow these restrictions: * Source file type should be a zip - file. * Source file size should not exceed 1GB limit. * No credentials - should be attached - the signed URLs provide access to the target bucket - using internal service identity; if credentials were attached, the - identity from the credentials would be used, but that identity does not - have permissions to upload files to the URL. When making a HTTP PUT - request, these two headers need to be specified: * `content-type: - application/zip` * `x-goog-content-length-range: 0,1073741824` And this - header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` - operationId: apigee.organizations.environments.archiveDeployments.generateUploadUrl - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlRequest' + get: + description: Retrieve a custom report definition. + operationId: apigee.organizations.reports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18139,9 +18174,8 @@ paths: description: Successful response content: application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateUploadUrlResponse + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId @@ -18149,25 +18183,27 @@ paths: schema: type: string - in: path - name: environmentsId + name: reportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/archiveDeployments/{archiveDeploymentsId}:generateDownloadUrl: - parameters: *ref_51 + /v1/organizations/{organizationsId}/reports: + parameters: *ref_1 post: description: >- - Generates a signed URL for downloading the original zip file used to - create an Archive Deployment. The URL is only valid for a limited period - and should be used within minutes after generation. Each call returns a - new upload URL. - operationId: apigee.organizations.environments.archiveDeployments.generateDownloadUrl + Creates a Custom Report for an Organization. A Custom Report provides + Apigee Customers to create custom dashboards in addition to the standard + dashboards which are provided. The Custom Report in its simplest form + contains specifications about metrics, dimensions and filters. It is + important to note that the custom report by itself does not provide an + executable entity. The Edge UI converts the custom report definition + into an analytics query and displays the result in a chart. + operationId: apigee.organizations.reports.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18179,29 +18215,16 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GenerateDownloadUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1CustomReport' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: archiveDeploymentsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references/{referencesId}: - parameters: *ref_51 get: - description: Gets a Reference resource. - operationId: apigee.organizations.environments.references.get + description: Return a list of Custom Reports + operationId: apigee.organizations.reports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18213,28 +18236,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListCustomReportsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: referencesId - required: true + - in: query + name: expand schema: - type: string - delete: + type: boolean + /v1/organizations/{organizationsId}/apps: + parameters: *ref_1 + get: description: >- - Deletes a Reference from an environment. Returns the deleted Reference - resource. - operationId: apigee.organizations.environments.references.delete + Lists IDs of apps within an organization that have the specified app + status (approved or revoked) or are of the specified app type (developer + or company). + operationId: apigee.organizations.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18246,34 +18267,68 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: ids schema: type: string - - in: path - name: referencesId - required: true + - in: query + name: includeCred + schema: + type: boolean + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: status schema: type: string - put: - description: >- - Updates an existing Reference. Note that this operation has PUT - semantics; it will replace the entirety of the existing Reference with - the resource in the request body. - operationId: apigee.organizations.environments.references.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + - in: query + name: pageToken + schema: + type: string + - in: query + name: keyStatus + schema: + type: string + - in: query + name: rows + schema: + type: string + format: int64 + - in: query + name: expand + schema: + type: boolean + - in: query + name: apiProduct + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: startKey + schema: + type: string + - in: query + name: apptype + schema: + type: string + /v1/organizations/{organizationsId}/apps/{appsId}: + parameters: *ref_1 + get: + description: Gets the app profile for the specified app ID. + operationId: apigee.organizations.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18285,7 +18340,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1App' parameters: - in: path name: organizationsId @@ -18293,25 +18348,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: referencesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/references: - parameters: *ref_51 - post: - description: Creates a Reference in the specified environment. - operationId: apigee.organizations.environments.references.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/resultView: + parameters: *ref_1 + get: + description: '' + operationId: apigee.organizations.hostQueries.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18323,7 +18368,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Reference' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQueryResultView' parameters: - in: path name: organizationsId @@ -18331,19 +18376,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostQueriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/admin/schemav2: - parameters: *ref_51 + /v1/organizations/{organizationsId}/hostQueries: + parameters: *ref_1 get: - description: >- - Gets a list of metrics and dimensions that can be used to create - analytics queries and reports. Each schema element contains the name of - the field, its associated type, and a flag indicating whether it is a - standard or custom field. - operationId: apigee.organizations.environments.analytics.admin.getSchemav2 + description: Return a list of Asynchronous Queries at host level. + operationId: apigee.organizations.hostQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18355,35 +18396,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Schema' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: from schema: type: string - in: query - name: type + name: submittedBy schema: type: string - in: query - name: disableCache + name: dataset schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports/{exportsId}: - parameters: *ref_51 - get: + type: string + - in: query + name: to + schema: + type: string + - in: query + name: inclQueriesWithoutReport + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + - in: query + name: status + schema: + type: string + post: description: >- - Gets the details and status of an analytics export job. If the export - job is still in progress, its `state` is set to "running". After the - export job has completed successfully, its `state` is set to - "completed". If the export job fails, its `state` is set to `failed`. - operationId: apigee.organizations.environments.analytics.exports.get + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostQueries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Query' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18395,30 +18455,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}/result: + parameters: *ref_1 + get: + description: >- + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostQueries.getResult + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - in: path - name: exportsId + name: hostQueriesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/analytics/exports: - parameters: *ref_51 + /v1/organizations/{organizationsId}/hostQueries/{hostQueriesId}: + parameters: *ref_1 get: description: >- - Lists the details and status of all analytics export jobs belonging to - the parent organization and environment. - operationId: apigee.organizations.environments.analytics.exports.list + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostQueries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18430,7 +18514,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListExportsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' parameters: - in: path name: organizationsId @@ -18438,22 +18522,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostQueriesId required: true schema: type: string + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments: + parameters: *ref_1 post: description: >- - Submit a data export job to be processed in the background. If the - request is successful, the API returns a 201 status, a URI that can be - used to retrieve the status of the export job, and the `state` value of - "enqueued". - operationId: apigee.organizations.environments.analytics.exports.create + CreateSecurityProfileEnvironmentAssociation creates profile environment + association i.e. attaches environment to security profile. + operationId: apigee.organizations.securityProfiles.environments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ExportRequest' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18465,7 +18550,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Export' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1SecurityProfileEnvironmentAssociation parameters: - in: path name: organizationsId @@ -18473,20 +18559,17 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/flowhooks/{flowhooksId}: - parameters: *ref_51 - put: - description: Attaches a shared flow to a flow hook. - operationId: apigee.organizations.environments.flowhooks.attachSharedFlowToFlowHook - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}: + parameters: *ref_1 + delete: + description: >- + DeleteSecurityProfileEnvironmentAssociation removes profile environment + association i.e. detaches environment from security profile. + operationId: apigee.organizations.securityProfiles.environments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18498,7 +18581,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -18506,21 +18589,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - in: path - name: flowhooksId + name: environmentsId required: true schema: type: string - get: + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}/environments/{environmentsId}:computeEnvironmentScores: + parameters: *ref_1 + post: description: >- - Returns the name of the shared flow attached to the specified flow hook. - If there's no shared flow attached to the flow hook, the API does not - return an error; it simply does not return a name in the response. - operationId: apigee.organizations.environments.flowhooks.get + ComputeEnvironmentScores calculates scores for requested time range for + the specified security profile and environment. + operationId: >- + apigee.organizations.securityProfiles.environments.computeEnvironmentScores + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18532,7 +18623,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ComputeEnvironmentScoresResponse parameters: - in: path name: organizationsId @@ -18540,18 +18632,23 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - in: path - name: flowhooksId + name: environmentsId required: true schema: type: string - delete: - description: Detaches a shared flow from a flow hook. - operationId: apigee.organizations.environments.flowhooks.detachSharedFlowFromFlowHook + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}: + parameters: *ref_1 + get: + description: >- + GetSecurityProfile gets the specified security profile. Returns + NOT_FOUND if security profile is not present for the specified + organization. + operationId: apigee.organizations.securityProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18563,7 +18660,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1FlowHook' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -18571,20 +18668,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: flowhooksId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/caches/{cachesId}: - parameters: *ref_51 delete: - description: Deletes a cache. - operationId: apigee.organizations.environments.caches.delete + description: DeleteSecurityProfile delete a profile with all its revisions. + operationId: apigee.organizations.securityProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18604,23 +18694,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: cachesId + name: securityProfilesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents/{securityIncidentsId}: - parameters: *ref_51 - get: - description: >- - GetSecurityIncident gets the specified security incident. Returns - NOT_FOUND if security incident is not present for the specified - organization and environment. - operationId: apigee.organizations.environments.securityIncidents.get + patch: + description: UpdateSecurityProfile update the metadata of security profile. + operationId: apigee.organizations.securityProfiles.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18632,7 +18717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId @@ -18640,23 +18725,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - - in: path - name: securityIncidentsId - required: true + - in: query + name: updateMask schema: type: string - patch: - description: UpdateSecurityIncidents updates an existing security incident. - operationId: apigee.organizations.environments.securityIncidents.patch + format: google-fieldmask + /v1/organizations/{organizationsId}/securityProfiles: + parameters: *ref_1 + post: + description: CreateSecurityProfile create a new custom security profile. + operationId: apigee.organizations.securityProfiles.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18668,41 +18755,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityIncident' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityProfile' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityIncidentsId - required: true - schema: - type: string - in: query - name: updateMask + name: securityProfileId schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents:batchUpdate: - parameters: *ref_51 - post: + get: description: >- - BatchUpdateSecurityIncident updates multiple existing security - incidents. - operationId: apigee.organizations.environments.securityIncidents.batchUpdate - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsRequest + ListSecurityProfiles lists all the security profiles associated with the + org including attached and unattached profiles. + operationId: apigee.organizations.securityProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18715,25 +18783,29 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchUpdateSecurityIncidentsResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfilesResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityIncidents: - parameters: *ref_51 + /v1/organizations/{organizationsId}/securityProfiles/{securityProfilesId}:listRevisions: + parameters: *ref_1 get: description: >- - ListSecurityIncidents lists all the security incident associated with - the environment. - operationId: apigee.organizations.environments.securityIncidents.list + ListSecurityProfileRevisions lists all the revisions of the security + profile. + operationId: apigee.organizations.securityProfiles.listRevisions security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18746,7 +18818,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityIncidentsResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityProfileRevisionsResponse parameters: - in: path name: organizationsId @@ -18754,28 +18826,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: securityProfilesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: pageToken schema: type: string - in: query - name: filter + name: pageSize schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployments: - parameters: *ref_51 + type: integer + format: int32 + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 get: - description: Lists all deployments of API proxies or shared flows in an environment. - operationId: apigee.organizations.environments.deployments.list + description: Lists all deployments of a shared flow revision. + operationId: apigee.organizations.sharedflows.revisions.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18796,19 +18864,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - - in: query - name: sharedFlows + - in: path + name: revisionsId + required: true schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}: - parameters: *ref_51 - delete: - description: Deletes a key value map from an environment. - operationId: apigee.organizations.environments.keyvaluemaps.delete + type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: + parameters: *ref_1 + post: + description: >- + Updates a shared flow revision. This operation is only allowed on + revisions which have never been deployed. After deployment a revision + becomes immutable, even if it becomes undeployed. The payload is a + ZIP-formatted shared flow. Content type must be either + multipart/form-data or application/octet-stream. + operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18820,7 +18899,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -18828,25 +18907,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - in: path - name: keyvaluemapsId + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps: - parameters: *ref_51 - post: - description: Creates a key value map in an environment. - operationId: apigee.organizations.environments.keyvaluemaps.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + - in: query + name: validate + schema: + type: boolean + get: + description: >- + Gets a revision of a shared flow. To download the shared flow + configuration bundle for the specified revision as a zip file, set the + `format` query parameter to `bundle`. If you are using curl, specify `-o + filename.zip` to save the output to a file; otherwise, it displays to + `stdout`. Then, develop the shared flow configuration locally and upload + the updated sharedFlow configuration revision, as described in + [updateSharedFlowRevision](updateSharedFlowRevision). + operationId: apigee.organizations.sharedflows.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18858,7 +18941,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -18866,22 +18949,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: - parameters: *ref_51 - put: + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: format + schema: + type: string + delete: description: >- - Update key value entry scoped to an organization, environment, or API - proxy for an existing key. - operationId: apigee.organizations.environments.keyvaluemaps.entries.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + Deletes a shared flow and all associated policies, resources, and + revisions. You must undeploy the shared flow before deleting it. + operationId: apigee.organizations.sharedflows.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18893,7 +18978,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId @@ -18901,26 +18986,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId + name: sharedflowsId required: true schema: type: string - in: path - name: entriesId + name: revisionsId required: true schema: type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: + parameters: *ref_1 get: - description: >- - Get the key value entry value for a key value map scoped to an - organization, environment, or API proxy. **Note**: Supported for Apigee - hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.get + description: Lists all deployments of a shared flow. + operationId: apigee.organizations.sharedflows.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18932,7 +19011,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -18940,28 +19020,43 @@ paths: schema: type: string - in: path - name: environmentsId + name: sharedflowsId required: true schema: type: string + /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: + parameters: *ref_1 + get: + description: Gets a shared flow by name, including a list of its revisions. + operationId: apigee.organizations.sharedflows.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + parameters: - in: path - name: keyvaluemapsId + name: organizationsId required: true schema: type: string - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string delete: description: >- - Deletes a key value entry from a key value map scoped to an - organization, environment, or API proxy. **Notes:** * After you delete - the key value entry, the policy consuming the entry will continue to - function with its cached values for a few minutes. This is expected - behavior. * Supported for Apigee hybrid 1.8.x and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.delete + Deletes a shared flow and all it's revisions. The shared flow must be + undeployed before you can delete it. + operationId: apigee.organizations.sharedflows.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18973,7 +19068,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' parameters: - in: path name: organizationsId @@ -18981,33 +19076,25 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - - in: path - name: entriesId + name: sharedflowsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}/entries: - parameters: *ref_51 + /v1/organizations/{organizationsId}/sharedflows: + parameters: *ref_1 post: description: >- - Creates key value entries in a key value map scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.create + Uploads a ZIP-formatted shared flow configuration bundle to an + organization. If the shared flow already exists, this creates a new + revision of it. If the shared flow does not exist, this creates it. Once + imported, the shared flow revision must be deployed before it can be + accessed at runtime. The size limit of a shared flow bundle is 15 MB. + operationId: apigee.organizations.sharedflows.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19019,29 +19106,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' + $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: action schema: type: string - - in: path - name: keyvaluemapsId - required: true + - in: query + name: name schema: type: string get: - description: >- - Lists key value entries for key values maps scoped to an organization, - environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x - and higher. - operationId: apigee.organizations.environments.keyvaluemaps.entries.list + description: Lists all shared flows in the organization. + operationId: apigee.organizations.sharedflows.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19054,37 +19136,32 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse + #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keyvaluemapsId - required: true - schema: - type: string - in: query - name: pageSize + name: includeRevisions schema: - type: integer - format: int32 + type: boolean - in: query - name: pageToken + name: includeMetaData schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/optimizedStats/{optimizedStatsId}: - parameters: *ref_51 - get: - description: Similar to GetStats except that the response is less verbose. - operationId: apigee.organizations.environments.optimizedStats.get + type: boolean + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}: + parameters: *ref_1 + delete: + description: >- + Deletes an AppGroup. All app and API keys associations with the AppGroup + are also removed. **Warning**: This API will permanently delete the + AppGroup and related artifacts. **Note**: The delete operation is + asynchronous. The AppGroup app is deleted immediately, but its + associated resources, such as apps and API keys, may take anywhere from + a few seconds to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19096,7 +19173,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId @@ -19104,80 +19181,91 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string + get: + description: >- + Returns the AppGroup details for the provided AppGroup name in the + request URI. + operationId: apigee.organizations.appgroups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + parameters: - in: path - name: optimizedStatsId + name: organizationsId required: true schema: type: string - - in: query - name: offset - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: tzo - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: limit - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: timeUnit - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: sonar - schema: - type: boolean - - in: query - name: timeRange + - in: path + name: appgroupsId + required: true schema: type: string - - in: query - name: filter + put: + description: >- + Updates an AppGroup. This API replaces the existing AppGroup details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. Note that the + state of the AppGroup should be updated using `action`, and not via + AppGroup. + operationId: apigee.organizations.appgroups.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: select + - in: path + name: appgroupsId + required: true schema: type: string - in: query - name: aggTable + name: action schema: type: string - - in: query - name: realtime - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries: - parameters: *ref_51 - get: - description: Return a list of Asynchronous Queries - operationId: apigee.organizations.environments.queries.list + /v1/organizations/{organizationsId}/appgroups: + parameters: *ref_1 + post: + description: >- + Creates an AppGroup. Once created, user can register apps under the + AppGroup to obtain secret key and password. At creation time, the + AppGroup's state is set as `active`. + operationId: apigee.organizations.appgroups.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19189,55 +19277,107 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListAsyncQueriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroup' parameters: - in: path name: organizationsId required: true schema: type: string + get: + description: >- + Lists all AppGroups in an organization. A maximum of 1000 AppGroups are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListAppGroupsResponse' + parameters: - in: path - name: environmentsId + name: organizationsId required: true schema: type: string - in: query - name: from + name: pageToken schema: type: string - in: query - name: to + name: filter schema: type: string - in: query - name: inclQueriesWithoutReport + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}: + parameters: *ref_1 + delete: + description: >- + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. + operationId: apigee.organizations.appgroups.apps.keys.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - - in: query - name: dataset + - in: path + name: appgroupsId + required: true schema: type: string - - in: query - name: status + - in: path + name: appsId + required: true schema: type: string - - in: query - name: submittedBy + - in: path + name: keysId + required: true schema: type: string post: description: >- - Submit a query to be processed in the background. If the submission of - the query succeeds, the API returns a 201 status and an ID that refer to - the query. In addition to the HTTP status 201, the `state` of "enqueued" - means that the request succeeded. - operationId: apigee.organizations.environments.queries.create + Adds an API product to an AppGroupAppKey, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes to the AppGroupAppKey. This API + replaces the existing attributes with those specified in the request. + Include or exclude any existing attributes that you want to retain or + delete, respectively. You can use the same key to access all API + products associated with the app. + operationId: apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Query' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19249,7 +19389,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -19257,18 +19397,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}: - parameters: *ref_51 get: description: >- - Get query status If the query is still in progress, the `state` is set - to "running" After the query has completed successfully, `state` is set - to "completed" - operationId: apigee.organizations.environments.queries.get + Gets details for a consumer key for a AppGroup app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.appgroups.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19280,7 +19427,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AsyncQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -19288,23 +19435,42 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: queriesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resulturl: - parameters: *ref_51 - get: + - in: path + name: keysId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys: + parameters: *ref_1 + post: description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - sent to the client as a list of urls to JSON files. - operationId: apigee.organizations.environments.queries.getResulturl + Creates a custom consumer key and secret for a AppGroup app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the ProductizeAppGroupAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteAppGroupAppKey API. + operationId: apigee.organizations.appgroups.apps.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19316,8 +19482,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetAsyncQueryResultUrlResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -19325,25 +19490,24 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: queriesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/result: - parameters: *ref_51 - get: + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + parameters: *ref_1 + delete: description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.queries.getResult + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.appgroups.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19355,7 +19519,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupAppKey' parameters: - in: path name: organizationsId @@ -19363,23 +19527,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: queriesId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}: - parameters: *ref_51 - get: + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true + schema: + type: string + post: description: >- - Get security report status If the query is still in progress, the - `state` is set to "running" After the query has completed successfully, - `state` is set to "completed" - operationId: apigee.organizations.environments.securityReports.get + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19391,7 +19567,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -19399,22 +19575,38 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: securityReportsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/resultView: - parameters: *ref_51 - get: + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true + schema: + type: string + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}: + parameters: *ref_1 + delete: description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.environments.securityReports.getResultView + Deletes an AppGroup app. **Note**: The delete operation is asynchronous. + The AppGroup app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.appgroups.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19426,8 +19618,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -19435,20 +19626,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - in: path - name: securityReportsId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports: - parameters: *ref_51 get: - description: Return a list of Security Reports - operationId: apigee.organizations.environments.securityReports.list + description: Returns the details for an AppGroup app. + operationId: apigee.organizations.appgroups.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19460,8 +19649,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -19469,51 +19657,32 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - - in: query - name: from - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: submittedBy - schema: - type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: status - schema: - type: string - - in: query - name: to + - in: path + name: appsId + required: true schema: type: string - post: + put: description: >- - Submit a report request to be processed in the background. If the - submission succeeds, the API returns a 200 status and an ID that refer - to the report request. In addition to the HTTP status 200, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.environments.securityReports.create + Updates the details for an AppGroup app. In addition, you can add an API + product to an AppGroup app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateAppGroupAppKey API. Using this API, you cannot update + the app name, as it is the primary key used to identify the app and + cannot be changed. This API replaces the existing attributes with those + specified in the request. Include or exclude any existing attributes + that you want to retain or delete, respectively. + operationId: apigee.organizations.appgroups.apps.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19525,7 +19694,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -19533,20 +19702,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityReports/{securityReportsId}/result: - parameters: *ref_51 + - in: path + name: appsId + required: true + schema: + type: string + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps: + parameters: *ref_1 get: description: >- - After the query is completed, use this API to retrieve the results as - file. If the request succeeds, and there is a non-zero result set, the - result is downloaded to the client as a zipped JSON file. The name of - the downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.environments.securityReports.getResult + Lists all apps created by an AppGroup in an Apigee organization. + Optionally, you can request an expanded view of the AppGroup apps. Lists + all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are + returned in the response if PageSize is not specified, or if the + PageSize is greater than 1000. + operationId: apigee.organizations.appgroups.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19558,7 +19736,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListAppGroupAppsResponse parameters: - in: path name: organizationsId @@ -19566,26 +19745,32 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - - in: path - name: securityReportsId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement: - parameters: *ref_51 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Updates an add-on enablement status of an environment. - operationId: apigee.organizations.environments.addonsConfig.setAddonEnablement + description: >- + Creates an app and associates it with an AppGroup. This API associates + the AppGroup app with the specified API product and auto-generates an + API key for the app to use in calls to API proxies inside that API + product. The `name` is the unique ID of the app that you can use in API + calls. + operationId: apigee.organizations.appgroups.apps.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SetAddonEnablementRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19597,7 +19782,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1AppGroupApp' parameters: - in: path name: organizationsId @@ -19605,17 +19790,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: appgroupsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions: - parameters: *ref_51 + /v1/organizations/{organizationsId}/datacollectors: + parameters: *ref_1 get: - description: >- - Returns a list of SecurityActions. This returns both enabled and - disabled actions. - operationId: apigee.organizations.environments.securityActions.list + description: Lists all data collectors. + operationId: apigee.organizations.datacollectors.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19628,39 +19811,30 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityActionsResponse + #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: type: string post: - description: CreateSecurityAction creates a SecurityAction. - operationId: apigee.organizations.environments.securityActions.create + description: Creates a new data collector. + operationId: apigee.organizations.datacollectors.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19672,27 +19846,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - in: query - name: securityActionId + name: dataCollectorId schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}: - parameters: *ref_51 - get: - description: Get a SecurityAction by name. - operationId: apigee.organizations.environments.securityActions.get + /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: + parameters: *ref_1 + patch: + description: Updates a data collector. + operationId: apigee.organizations.datacollectors.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19704,7 +19878,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -19712,30 +19886,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: datacollectorsId required: true schema: type: string - - in: path - name: securityActionsId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable: - parameters: *ref_51 - post: - description: >- - Disable a SecurityAction. The `state` of the SecurityAction after - disabling is `DISABLED`. `DisableSecurityAction` can be called on - SecurityActions in the state `ENABLED`; SecurityActions in a different - state (including `DISABLED`) return an error. - operationId: apigee.organizations.environments.securityActions.disable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1DisableSecurityActionRequest + format: google-fieldmask + delete: + description: Deletes a data collector. + operationId: apigee.organizations.datacollectors.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19747,7 +19909,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -19755,30 +19917,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityActionsId + name: datacollectorsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable: - parameters: *ref_51 - post: - description: >- - Enable a SecurityAction. The `state` of the SecurityAction after - enabling is `ENABLED`. `EnableSecurityAction` can be called on - SecurityActions in the state `DISABLED`; SecurityActions in a different - state (including `ENABLED) return an error. - operationId: apigee.organizations.environments.securityActions.enable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1EnableSecurityActionRequest + get: + description: Gets a data collector. + operationId: apigee.organizations.datacollectors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19790,7 +19935,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityAction' + $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' parameters: - in: path name: organizationsId @@ -19798,20 +19943,20 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: securityActionsId + name: datacollectorsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/deployments: - parameters: *ref_51 + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: + parameters: *ref_1 get: - description: Lists all deployments of an API proxy in an environment. - operationId: apigee.organizations.environments.apis.deployments.list + description: >- + After the query is completed, use this API to retrieve the results. If + the request succeeds, and there is a non-zero result set, the result is + downloaded to the client as a zipped JSON file. The name of the + downloaded file will be: OfflineQueryResult-.zip Example: + `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + operationId: apigee.organizations.hostSecurityReports.getResult security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19823,8 +19968,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId @@ -19832,20 +19976,17 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data/{dataId}: - parameters: *ref_51 + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: + parameters: *ref_1 get: - description: Gets the debug data from a transaction. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.data.get + description: >- + After the query is completed, use this API to view the query result when + result size is small. + operationId: apigee.organizations.hostSecurityReports.getResultView security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19858,7 +19999,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1DebugSessionTransaction + #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView parameters: - in: path name: organizationsId @@ -19866,39 +20007,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId - required: true - schema: - type: string - - in: path - name: dataId + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}/data: - parameters: *ref_51 - delete: + /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: + parameters: *ref_1 + get: description: >- - Deletes the data from a debug session. This does not cancel the debug - session or prevent further data from being collected if the session is - still active in runtime pods. - operationId: >- - apigee.organizations.environments.apis.revisions.debugsessions.deleteData + Get status of a query submitted at host level. If the query is still in + progress, the `state` is set to "running" After the query has completed + successfully, `state` is set to "completed" + operationId: apigee.organizations.hostSecurityReports.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19910,7 +20030,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId @@ -19918,32 +20038,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId + name: hostSecurityReportsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions: - parameters: *ref_51 + /v1/organizations/{organizationsId}/hostSecurityReports: + parameters: *ref_1 get: - description: >- - Lists debug sessions that are currently active in the given API Proxy - revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.list + description: Return a list of Security Reports at host level. + operationId: apigee.organizations.hostSecurityReports.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -19956,26 +20059,31 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDebugSessionsResponse + #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: dataset schema: type: string - - in: path - name: apisId - required: true + - in: query + name: from schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: to + schema: + type: string + - in: query + name: submittedBy + schema: + type: string + - in: query + name: status schema: type: string - in: query @@ -19987,14 +20095,22 @@ paths: name: pageToken schema: type: string + - in: query + name: envgroupHostname + schema: + type: string post: - description: Creates a debug session for a deployed API Proxy revision. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.create + description: >- + Submit a query at host level to be processed in the background. If the + submission of the query succeeds, the API returns a 201 status and an ID + that refer to the query. In addition to the HTTP status 201, the `state` + of "enqueued" means that the request succeeded. + operationId: apigee.organizations.hostSecurityReports.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20006,38 +20122,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: query - name: timeout - schema: - type: string - format: int64 - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}: - parameters: *ref_51 + /v1/organizations/{organizationsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Retrieves a debug session. - operationId: apigee.organizations.environments.apis.revisions.debugsessions.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: apigee.organizations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20049,7 +20148,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugSession' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -20057,43 +20156,17 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true - schema: - type: string - - in: path - name: debugsessionsId + name: operationsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateUndeployChangeReport: - parameters: *ref_51 - post: + /v1/organizations/{organizationsId}/operations: + parameters: *ref_1 + get: description: >- - Generates a report for a dry run analysis of an UndeployApiProxy request - without committing the undeploy. In addition to the standard validations - performed when removing deployments, additional analysis will be done to - detect possible traffic routing changes that would result from this - deployment being removed. Any potential routing conflicts or unsafe - changes will be reported in the response. This routing analysis is not - performed for a non-dry-run UndeployApiProxy request. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateUndeployChangeReport + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: apigee.organizations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20105,47 +20178,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: apisId - required: true + - in: query + name: filter schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: pageSize schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments:generateDeployChangeReport: - parameters: *ref_51 - post: - description: >- - Generates a report for a dry run analysis of a DeployApiProxy request - without committing the deployment. In addition to the standard - validations performed when adding deployments, additional analysis will - be done to detect possible traffic routing changes that would result - from this deployment being created. Any potential routing conflicts or - unsafe changes will be reported in the response. This routing analysis - is not performed for a non-dry-run DeployApiProxy request. For a request - path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: >- - apigee.organizations.environments.apis.revisions.deployments.generateDeployChangeReport + type: integer + format: int32 + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}: + parameters: *ref_1 + get: + description: Gets an environment group. + operationId: apigee.organizations.envgroups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20157,7 +20214,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeploymentChangeReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' parameters: - in: path name: organizationsId @@ -20165,31 +20222,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId + name: envgroupsId required: true schema: type: string - - in: query - name: override - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/deployments: - parameters: *ref_51 - get: - description: >- - Gets the deployment of an API proxy revision and actual state reported - by runtime pods. - operationId: apigee.organizations.environments.apis.revisions.getDeployments + patch: + description: Updates an environment group. + operationId: apigee.organizations.envgroups.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20201,7 +20245,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -20209,35 +20253,18 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId + name: envgroupsId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: updateMask schema: type: string - post: - description: >- - Deploys a revision of an API proxy. If another revision of the same API - proxy revision is currently deployed, set the `override` parameter to - `true` to have this revision replace the currently deployed revision. - You cannot invoke an API proxy until it has been deployed to an - environment. After you deploy an API proxy revision, you cannot edit it. - To edit the API proxy, you must create and deploy a new revision. For a - request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.create` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.deploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.deploy + format: google-fieldmask + delete: + description: Deletes an environment group. + operationId: apigee.organizations.envgroups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20249,7 +20276,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Deployment' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -20257,41 +20284,47 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/deployedIngressConfig: + parameters: *ref_1 + get: + description: Gets the deployed ingress configuration for an environment group. + operationId: apigee.organizations.envgroups.getDeployedIngressConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroupConfig' + parameters: - in: path - name: apisId + name: organizationsId required: true schema: type: string - in: path - name: revisionsId + name: envgroupsId required: true schema: type: string - in: query - name: sequencedRollout - schema: - type: boolean - - in: query - name: serviceAccount + name: view schema: type: string - - in: query - name: override - schema: - type: boolean - delete: - description: >- - Undeploys an API proxy revision from an environment. For a request path - `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, - two permissions are required: * `apigee.deployments.delete` on the - resource `organizations/{org}/environments/{env}` * - `apigee.proxyrevisions.undeploy` on the resource - `organizations/{org}/apis/{api}/revisions/{rev}` - operationId: apigee.organizations.environments.apis.revisions.undeploy + /v1/organizations/{organizationsId}/envgroups: + parameters: *ref_1 + get: + description: Lists all environment groups. + operationId: apigee.organizations.envgroups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20303,42 +20336,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupsResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: apisId - required: true - schema: - type: string - - in: path - name: revisionsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: sequencedRollout + name: pageSize schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers: - parameters: *ref_51 + type: integer + format: int32 post: - description: Creates a TargetServer in the specified environment. - operationId: apigee.organizations.environments.targetservers.create + description: Creates a new environment group. + operationId: apigee.organizations.envgroups.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentGroup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20350,27 +20372,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - in: query name: name schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/targetservers/{targetserversId}: - parameters: *ref_51 + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments: + parameters: *ref_1 get: - description: Gets a TargetServer resource. - operationId: apigee.organizations.environments.targetservers.get + description: Lists all attachments of an environment group. + operationId: apigee.organizations.envgroups.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20382,7 +20399,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse parameters: - in: path name: organizationsId @@ -20390,26 +20408,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - - in: path - name: targetserversId - required: true + - in: query + name: pageToken schema: type: string - put: - description: >- - Updates an existing TargetServer. Note that this operation has PUT - semantics; it will replace the entirety of the existing TargetServer - with the resource in the request body. - operationId: apigee.organizations.environments.targetservers.update + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new attachment of an environment to an environment group. + operationId: apigee.organizations.envgroups.attachments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20421,7 +20441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -20429,20 +20449,15 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: targetserversId + name: envgroupsId required: true schema: type: string - delete: - description: >- - Deletes a TargetServer from an environment. Returns the deleted - TargetServer resource. - operationId: apigee.organizations.environments.targetservers.delete + /v1/organizations/{organizationsId}/envgroups/{envgroupsId}/attachments/{attachmentsId}: + parameters: *ref_1 + get: + description: Gets an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20454,7 +20469,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TargetServer' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1EnvironmentGroupAttachment parameters: - in: path name: organizationsId @@ -20462,20 +20478,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: envgroupsId required: true schema: type: string - in: path - name: targetserversId + name: attachmentsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}: - parameters: *ref_51 delete: - description: Deletes an alias. - operationId: apigee.organizations.environments.keystores.aliases.delete + description: Deletes an environment group attachment. + operationId: apigee.organizations.envgroups.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20487,7 +20501,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -20495,23 +20509,28 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: envgroupsId required: true schema: type: string - in: path - name: aliasesId + name: attachmentsId required: true schema: type: string - get: - description: Gets an alias. - operationId: apigee.organizations.environments.keystores.aliases.get + /v1/organizations/{organizationsId}/developers/{developersId}/balance:adjust: + parameters: *ref_1 + post: + description: >- + Adjust the prepaid balance for the developer. This API will be used in + scenarios where the developer has been under-charged or over-charged. + operationId: apigee.organizations.developers.balance.adjust + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1AdjustDeveloperBalanceRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20523,7 +20542,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -20531,28 +20550,49 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId - required: true - schema: - type: string - - in: path - name: aliasesId + name: developersId required: true schema: type: string - put: - description: Updates the certificate in an alias. - operationId: apigee.organizations.environments.keystores.aliases.update + /v1/organizations/{organizationsId}/developers/{developersId}/balance:credit: + parameters: *ref_1 + post: + description: Credits the account balance for the developer. + operationId: apigee.organizations.developers.balance.credit requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1CreditDeveloperBalanceRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: developersId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}: + parameters: *ref_1 + get: + description: Gets details for an API product subscription. + operationId: apigee.organizations.developers.subscriptions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20564,7 +20604,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -20572,33 +20612,25 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId + name: developersId required: true schema: type: string - in: path - name: aliasesId + name: subscriptionsId required: true schema: type: string - - in: query - name: ignoreNewlineValidation - schema: - type: boolean - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/certificate: - parameters: *ref_51 - get: - description: Gets the certificate from an alias in PEM-encoded form. - operationId: apigee.organizations.environments.keystores.aliases.getCertificate + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions: + parameters: *ref_1 + post: + description: 'Creates a subscription to an API product. ' + operationId: apigee.organizations.developers.subscriptions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20610,7 +20642,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -20618,27 +20650,13 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: keystoresId - required: true - schema: - type: string - - in: path - name: aliasesId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases/{aliasesId}/csr: - parameters: *ref_51 get: - description: >- - Generates a PKCS #10 Certificate Signing Request for the private key in - an alias. - operationId: apigee.organizations.environments.keystores.aliases.csr + description: Lists all API product subscriptions for a developer. + operationId: apigee.organizations.developers.subscriptions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20650,7 +20668,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse parameters: - in: path name: organizationsId @@ -20658,42 +20677,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: path - name: keystoresId - required: true + - in: query + name: startKey schema: type: string - - in: path - name: aliasesId - required: true + - in: query + name: count schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}/aliases: - parameters: *ref_51 + type: integer + format: int32 + /v1/organizations/{organizationsId}/developers/{developersId}/subscriptions/{subscriptionsId}:expire: + parameters: *ref_1 post: - description: >- - Creates an alias from a key/certificate pair. The structure of the - request is controlled by the `format` query parameter: - `keycertfile` - - Separate PEM-encoded key and certificate files are uploaded. Set - `Content-Type: multipart/form-data` and include the `keyFile`, - `certFile`, and `password` (if keys are encrypted) fields in the request - body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A - PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, - provide the file in the `file` field, and include the `password` field - if the file is encrypted in the request body. - `selfsignedcert` - A new - private key and certificate are generated. Set `Content-Type: - application/json` and include CertificateGenerationSpec in the request - body. - operationId: apigee.organizations.environments.keystores.aliases.create + description: Expires an API product subscription immediately. + operationId: apigee.organizations.developers.subscriptions.expire requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20705,7 +20712,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Alias' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperSubscription' parameters: - in: path name: organizationsId @@ -20713,40 +20720,20 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: subscriptionsId required: true schema: type: string - - in: query - name: ignoreNewlineValidation - schema: - type: boolean - - in: query - name: alias - schema: - type: string - - in: query - name: _password - schema: - type: string - - in: query - name: ignoreExpiryValidation - schema: - type: boolean - - in: query - name: format - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores/{keystoresId}: - parameters: *ref_51 + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}: + parameters: *ref_1 get: - description: Gets a keystore or truststore. - operationId: apigee.organizations.environments.keystores.get + description: Returns the details for a developer app. + operationId: apigee.organizations.developers.apps.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20758,7 +20745,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -20766,18 +20753,41 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - delete: - description: Deletes a keystore or truststore. - operationId: apigee.organizations.environments.keystores.delete + - in: query + name: query + schema: + type: string + - in: query + name: entity + schema: + type: string + put: + description: >- + Updates the details for a developer app. In addition, you can add an API + product to a developer app and automatically generate an API key for the + app to use when calling APIs in the API product. If you want to use an + existing API key for the API product, add the API product to the API key + using the UpdateDeveloperAppKey API. Using this API, you cannot update + the following: * App name as it is the primary key used to identify the + app and cannot be changed. * Scopes associated with the app. Instead, + use the ReplaceDeveloperAppKey API. This API replaces the existing + attributes with those specified in the request. Include or exclude any + existing attributes that you want to retain or delete, respectively. + operationId: apigee.organizations.developers.apps.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20789,7 +20799,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -20797,30 +20807,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: keystoresId + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/keystores: - parameters: *ref_51 - post: + delete: description: >- - Creates a keystore or truststore. - Keystore: Contains certificates and - their associated keys. - Truststore: Contains trusted certificates used - to validate a server's certificate. These certificates are typically - self-signed certificates or certificates that are not signed by a - trusted CA. - operationId: apigee.organizations.environments.keystores.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + Deletes a developer app. **Note**: The delete operation is asynchronous. + The developer app is deleted immediately, but its associated resources, + such as app keys or access tokens, may take anywhere from a few seconds + to a few minutes to be deleted. + operationId: apigee.organizations.developers.apps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20832,7 +20834,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Keystore' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -20840,25 +20842,49 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: name + - in: path + name: appsId + required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTimeSeriesStats: - parameters: *ref_51 post: - description: Retrieve security statistics as a collection of time series. - operationId: apigee.organizations.environments.securityStats.queryTimeSeriesStats + description: >- + Manages access to a developer app by enabling you to: * Approve or + revoke a developer app * Generate a new consumer key and secret for a + developer app To approve or revoke a developer app, set the `action` + query parameter to `approve` or `revoke`, respectively, and the + `Content-Type` header to `application/octet-stream`. If a developer app + is revoked, none of its API keys are valid for API calls even though the + keys are still approved. If successful, the API call returns the + following HTTP status code: `204 No Content` To generate a new consumer + key and secret for a developer app, pass the new key/secret details. + Rather than replace an existing key, this API generates a new key. In + this case, multiple key pairs may be associated with a single developer + app. Each key pair has an independent status (`approve` or `revoke`) and + expiration time. Any approved, non-expired key can be used in an API + call. For example, if you're using API key rotation, you can generate + new keys with expiration times that overlap keys that are going to + expire. You might also generate a new consumer key/secret if the + security of the original key/secret is compromised. The `keyExpiresIn` + property defines the expiration time for the API key in milliseconds. If + you don't set this property or set it to `-1`, the API key never + expires. **Notes**: * When generating a new key/secret, this API + replaces the existing attributes, notes, and callback URLs with those + specified in the request. Include or exclude any existing information + that you want to retain or delete, respectively. * To migrate existing + consumer keys and secrets to hybrid from another system, see the + CreateDeveloperAppKey API. + operationId: >- + apigee.organizations.developers.apps.generateKeyPairOrUpdateDeveloperAppStatus requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20870,8 +20896,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTimeSeriesStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -20879,20 +20904,31 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityStats:queryTabularStats: - parameters: *ref_51 - post: - description: Retrieve security statistics as tabular rows. - operationId: apigee.organizations.environments.securityStats.queryTabularStats + - in: path + name: appsId + required: true + schema: + type: string + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes: + parameters: *ref_1 + post: + description: >- + Updates attributes for a developer app. This API replaces the current + attributes with those specified in the request. + operationId: apigee.organizations.developers.apps.attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1QueryTabularStatsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20904,8 +20940,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1QueryTabularStatsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -20913,21 +20948,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/stats/{statsId}: - parameters: *ref_51 get: - description: >- - Retrieve metrics grouped by dimensions. The types of metrics you can - retrieve include traffic, message counts, API call latency, response - size, and cache hits and counts. Dimensions let you view metrics in - meaningful groups. You can optionally pass dimensions as path parameters - to the `stats` API. If dimensions are not specified, the metrics are - computed on the entire set of data for the given time range. - operationId: apigee.organizations.environments.stats.get + description: Returns a list of all developer app attributes. + operationId: apigee.organizations.developers.apps.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -20939,7 +20971,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -20947,89 +20979,31 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: statsId + name: appsId required: true schema: type: string - - in: query - name: topk - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: timeUnit - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: select - schema: - type: string - - in: query - name: sonar - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: aggTable - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides: - parameters: *ref_51 + /v1/organizations/{organizationsId}/developers/{developersId}/apps: + parameters: *ref_1 post: description: >- - Creates a trace configuration override. The response contains a - system-generated UUID, that can be used to view, update, or delete the - configuration override. Use the List API to view the existing trace - configuration overrides. - operationId: apigee.organizations.environments.traceConfig.overrides.create + Creates an app associated with a developer. This API associates the + developer app with the specified API product and auto-generates an API + key for the app to use in calls to API proxies inside that API product. + The `name` is the unique ID of the app that you can use in API calls. + The `DisplayName` (set as an attribute) appears in the UI. If you don't + set the `DisplayName` attribute, the `name` appears in the UI. + operationId: apigee.organizations.developers.apps.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21041,7 +21015,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperApp' parameters: - in: path name: organizationsId @@ -21049,15 +21023,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string get: description: >- - Lists all of the distributed trace configuration overrides in an - environment. - operationId: apigee.organizations.environments.traceConfig.overrides.list + Lists all apps created by a developer in an Apigee organization. + Optionally, you can request an expanded view of the developer apps. A + maximum of 100 developer apps are returned per API call. You can + paginate the list of deveoper apps returned using the `startKey` and + `count` query parameters. + operationId: apigee.organizations.developers.apps.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21070,7 +21047,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListTraceConfigOverridesResponse + #/components/schemas/GoogleCloudApigeeV1ListDeveloperAppsResponse parameters: - in: path name: organizationsId @@ -21078,24 +21055,32 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: query - name: pageToken + name: expand + schema: + type: boolean + - in: query + name: count schema: type: string + format: int64 - in: query - name: pageSize + name: startKey schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig/overrides/{overridesId}: - parameters: *ref_51 + type: string + - in: query + name: shallowExpand + schema: + type: boolean + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/attributes/{attributesId}: + parameters: *ref_1 delete: - description: Deletes a distributed trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.delete + description: Deletes a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21107,7 +21092,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -21115,27 +21100,36 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: overridesId + name: appsId required: true schema: type: string - patch: + - in: path + name: attributesId + required: true + schema: + type: string + post: description: >- - Updates a distributed trace configuration override. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.traceConfig.overrides.patch + Updates a developer app attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (current default). Any custom attributes + associated with these entities are cached for at least 180 seconds after + the entity is accessed at runtime. Therefore, an `ExpiresIn` element on + the OAuthV2 policy won't be able to expire an access token in less than + 180 seconds. + operationId: >- + apigee.organizations.developers.apps.attributes.updateDeveloperAppAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21147,7 +21141,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -21155,65 +21149,23 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: overridesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Gets a trace configuration override. - operationId: apigee.organizations.environments.traceConfig.overrides.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfigOverride' - parameters: - - in: path - name: organizationsId + name: developersId required: true schema: type: string - in: path - name: environmentsId + name: appsId required: true schema: type: string - in: path - name: overridesId + name: attributesId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}/{name}: - parameters: *ref_51 - put: - description: >- - Updates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + get: + description: Returns a developer app attribute. + operationId: apigee.organizations.developers.apps.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21225,7 +21177,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -21233,26 +21185,44 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: type + name: appsId required: true schema: type: string - in: path - name: name + name: attributesId required: true schema: type: string - get: + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/create: + parameters: *ref_1 + post: description: >- - Gets the contents of a resource file. For more information about - resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.get + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21264,7 +21234,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -21272,26 +21242,24 @@ paths: schema: type: string - in: path - name: environmentsId - required: true - schema: - type: string - - in: path - name: type + name: developersId required: true schema: type: string - in: path - name: name + name: appsId required: true schema: type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}: + parameters: *ref_1 delete: description: >- - Deletes a resource file. For more information about resource files, see - [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.delete + Removes an API product from an app's consumer key. After the API product + is removed, the app cannot access the API resources defined in that API + product. **Note**: The consumer key is not removed, only its association + with the API product. + operationId: apigee.organizations.developers.apps.keys.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21303,7 +21271,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -21311,28 +21279,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: type + name: appsId required: true schema: type: string - in: path - name: name + name: keysId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles/{type}: - parameters: *ref_51 - get: + - in: path + name: apiproductsId + required: true + schema: + type: string + post: description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.listEnvironmentResources + Approves or revokes the consumer key for an API product. After a + consumer key is approved, the app can use it to access APIs. A consumer + key that is revoked or pending cannot be used to access an API. Any + access tokens associated with a revoked consumer key will remain active. + However, Apigee checks the status of the consumer key and if set to + `revoked` will not allow access to the API. + operationId: >- + apigee.organizations.developers.apps.keys.apiproducts.updateDeveloperAppKeyApiProduct security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21344,8 +21319,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21353,23 +21327,36 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: path - name: type + name: appsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/resourcefiles: - parameters: *ref_51 + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: apiproductsId + required: true + schema: + type: string + - in: query + name: action + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}: + parameters: *ref_1 get: description: >- - Lists all resource files, optionally filtering by type. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.list + Gets details for a consumer key for a developer app, including the key + and secret value, associated API products, and other information. + operationId: apigee.organizations.developers.apps.keys.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21381,8 +21368,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListEnvironmentResourcesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -21390,26 +21376,35 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: type + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true schema: type: string post: description: >- - Creates a resource file. Specify the `Content-Type` as - `application/octet-stream` or `multipart/form-data`. For more - information about resource files, see [Resource - files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files). - operationId: apigee.organizations.environments.resourcefiles.create + Adds an API product to a developer app key, enabling the app that holds + the key to access the API resources bundled in the API product. In + addition, you can add attributes to a developer app key. This API + replaces the existing attributes with those specified in the request. + Include or exclude any existing attributes that you want to retain or + delete, respectively. You can use the same key to access all API + products associated with the app. + operationId: apigee.organizations.developers.apps.keys.updateDeveloperAppKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21421,7 +21416,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ResourceFile' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -21429,30 +21424,38 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: type + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId + required: true schema: type: string - in: query - name: name + name: action schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}: - parameters: *ref_51 - patch: + put: description: >- - Updates properties for an Apigee environment with patch semantics using - a field mask. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.environments.modifyEnvironment + Updates the scope of an app. This API replaces the existing scopes with + those specified in the request. Include or exclude any existing scopes + that you want to retain or delete, respectively. The specified scopes + must already be defined for the API products associated with the app. + This API sets the `scopes` element under the `apiProducts` element in + the attributes of the app. + operationId: apigee.organizations.developers.apps.keys.replaceDeveloperAppKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21464,7 +21467,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -21472,29 +21475,30 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: appsId + required: true schema: type: string - format: google-fieldmask - put: + - in: path + name: keysId + required: true + schema: + type: string + delete: description: >- - Updates an existing environment. When updating properties, you must pass - all existing properties to the API, even if they are not being changed. - If you omit properties from the payload, the properties are removed. To - get the current list of properties for the environment, use the [Get - Environment API](get). **Note**: Both `PUT` and `POST` methods are - supported for updating an existing environment. - operationId: apigee.organizations.environments.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + Deletes an app's consumer key and removes all API products associated + with the app. After the consumer key is deleted, it cannot be used to + access any APIs. **Note**: After you delete a consumer key, you may want + to: 1. Create a new consumer key and secret for the developer app using + the CreateDeveloperAppKey API, and subsequently add an API product to + the key using the UpdateDeveloperAppKey API. 2. Delete the developer + app, if it is no longer required. + operationId: apigee.organizations.developers.apps.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21506,7 +21510,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId @@ -21514,24 +21518,44 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId + required: true + schema: + type: string + - in: path + name: appsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string + /v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys: + parameters: *ref_1 post: description: >- - Updates an existing environment. When updating properties, you must pass - all existing properties to the API, even if they are not being changed. - If you omit properties from the payload, the properties are removed. To - get the current list of properties for the environment, use the [Get - Environment API](get). **Note**: Both `PUT` and `POST` methods are - supported for updating an existing environment. - operationId: apigee.organizations.environments.updateEnvironment + Creates a custom consumer key and secret for a developer app. This is + particularly useful if you want to migrate existing consumer keys and + secrets to Apigee from another system. Consumer keys and secrets can + contain letters, numbers, underscores, and hyphens. No other special + characters are allowed. To avoid service disruptions, a consumer key and + secret should not exceed 2 KBs each. **Note**: When creating the + consumer key and secret, an association to API products will not be + made. Therefore, you should not specify the associated API products in + your request. Instead, use the UpdateDeveloperAppKey API to make the + association after the consumer key and secret are created. If a consumer + key and secret already exist, you can keep them or delete them using the + DeleteDeveloperAppKey API. **Note**: All keys start out with + status=approved, even if status=revoked is passed when the key is + created. To revoke a key, use the UpdateDeveloperAppKey API. + operationId: apigee.organizations.developers.apps.keys.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21543,51 +21567,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperAppKey' parameters: - in: path name: organizationsId required: true schema: - type: string - - in: path - name: environmentsId - required: true - schema: - type: string - delete: - description: >- - Deletes an environment from an organization. **Warning: You must delete - all key value maps and key value entries before you delete an - environment.** Otherwise, if you re-create the environment the key value - map entry operations will encounter encryption/decryption discrepancies. - operationId: apigee.organizations.environments.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: + type: string - in: path - name: organizationsId + name: developersId required: true schema: type: string - in: path - name: environmentsId + name: appsId required: true schema: type: string + /v1/organizations/{organizationsId}/developers/{developersId}/attributes: + parameters: *ref_1 get: - description: Gets environment details. - operationId: apigee.organizations.environments.get + description: Returns a list of all developer attributes. + operationId: apigee.organizations.developers.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21599,7 +21600,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -21607,24 +21608,28 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:testIamPermissions: - parameters: *ref_51 post: description: >- - Tests the permissions of a user on an environment, and returns a subset - of permissions that the user has on the environment. If the environment - does not exist, an empty permission set is returned (a NOT_FOUND error - is not returned). - operationId: apigee.organizations.environments.testIamPermissions + Updates developer attributes. This API replaces the existing attributes + with those specified in the request. Add new attributes, and include or + exclude any existing attributes that you want to retain or remove, + respectively. The custom attribute limit is 18. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (default). Any custom + attributes associated with these entities are cached for at least 180 + seconds after the entity is accessed at runtime. Therefore, an + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21636,7 +21641,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -21644,15 +21649,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask: - parameters: *ref_51 + /v1/organizations/{organizationsId}/developers/{developersId}/attributes/{attributesId}: + parameters: *ref_1 get: - description: Gets the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.getDebugmask + description: Returns the value of the specified developer attribute. + operationId: apigee.organizations.developers.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21664,7 +21669,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -21672,18 +21677,29 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - patch: - description: Updates the debug mask singleton resource for an environment. - operationId: apigee.organizations.environments.updateDebugmask + - in: path + name: attributesId + required: true + schema: + type: string + post: + description: >- + Updates a developer attribute. **Note**: OAuth access tokens and Key + Management Service (KMS) entities (apps, developers, and API products) + are cached for 180 seconds (default). Any custom attributes associated + with these entities are cached for at least 180 seconds after the entity + is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.attributes.updateDeveloperAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21695,7 +21711,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DebugMask' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -21703,33 +21719,18 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: replaceRepeatedFields - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: attributesId + required: true schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig: - parameters: *ref_51 - patch: - description: >- - Updates the trace configurations in an environment. Note that the - repeated fields have replace semantics when included in the field mask - and that they will be overwritten by the value of the fields in the - request body. - operationId: apigee.organizations.environments.updateTraceConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + delete: + description: Deletes a developer attribute. + operationId: apigee.organizations.developers.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21741,7 +21742,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -21749,18 +21750,34 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: attributesId + required: true schema: type: string - format: google-fieldmask - get: - description: Get distributed trace configuration in an environment. - operationId: apigee.organizations.environments.getTraceConfig + /v1/organizations/{organizationsId}/developers/{developersId}: + parameters: *ref_1 + put: + description: >- + Updates a developer. This API replaces the existing developer details + with those specified in the request. Include or exclude any existing + details that you want to retain or delete, respectively. The custom + attribute limit is 18. **Note**: OAuth access tokens and Key Management + Service (KMS) entities (apps, developers, and API products) are cached + for 180 seconds (current default). Any custom attributes associated with + these entities are cached for at least 180 seconds after the entity is + accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 + policy won't be able to expire an access token in less than 180 seconds. + operationId: apigee.organizations.developers.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21772,7 +21789,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1TraceConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -21780,20 +21797,22 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:getIamPolicy: - parameters: *ref_51 - get: + post: description: >- - Gets the IAM policy on an environment. For more information, see [Manage - users, roles, and permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.environments.getIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.getIamPolicy + Sets the status of a developer. A developer is `active` by default. If + you set a developer's status to `inactive`, the API keys assigned to the + developer apps are no longer valid even though the API keys are set to + `approved`. Inactive developers can still sign in to the developer + portal and create apps; however, any new API keys generated during app + creation won't work. To set the status of a developer, set the `action` + query parameter to `active` or `inactive`, and the `Content-Type` header + to `application/octet-stream`. If successful, the API call returns the + following HTTP status code: `204 No Content` + operationId: apigee.organizations.developers.setDeveloperStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21805,7 +21824,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -21813,31 +21832,25 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: action schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/environments/{environmentsId}:setIamPolicy: - parameters: *ref_51 - post: + type: string + delete: description: >- - Sets the IAM policy on an environment, if the policy already exists it - will be replaced. For more information, see [Manage users, roles, and - permissions using the - API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). - You must have the `apigee.environments.setIamPolicy` permission to call - this API. - operationId: apigee.organizations.environments.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + Deletes a developer. All apps and API keys associated with the developer + are also removed. **Warning**: This API will permanently delete the + developer and related artifacts. To avoid permanently deleting + developers and their artifacts, set the developer status to `inactive` + using the SetDeveloperStatus API. **Note**: The delete operation is + asynchronous. The developer app is deleted immediately, but its + associated resources, such as apps and API keys, may take anywhere from + a few seconds to a few minutes to be deleted. + operationId: apigee.organizations.developers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21849,7 +21862,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId @@ -21857,20 +21870,16 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments: - parameters: *ref_51 - post: - description: Creates an environment in an organization. - operationId: apigee.organizations.environments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Environment' + get: + description: >- + Returns the developer details, including the developer's name, email + address, apps, and other information. **Note**: The response includes + only the first 100 developer apps. + operationId: apigee.organizations.developers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21882,24 +21891,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: developersId + required: true + schema: + type: string - in: query - name: name + name: action schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig: - parameters: *ref_51 - get: + /v1/organizations/{organizationsId}/developers: + parameters: *ref_1 + post: description: >- - GetSecurityActionConfig returns the current SecurityActions - configuration. - operationId: apigee.organizations.environments.getSecurityActionsConfig + Creates a developer. Once created, the developer can register an app and + obtain an API key. At creation time, a developer is set as `active`. To + change the developer status, use the SetDeveloperStatus API. + operationId: apigee.organizations.developers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21911,29 +21931,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Developer' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true - schema: - type: string - patch: + get: description: >- - UpdateSecurityActionConfig updates the current SecurityActions - configuration. This method is used to enable/disable the feature at the - environment level. - operationId: apigee.organizations.environments.updateSecurityActionsConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + Lists all developers in an organization by email address. By default, + the response does not include company developers. Set the + `includeCompany` query parameter to `true` to include company + developers. **Note**: A maximum of 1000 developers are returned in the + response. You paginate the list of developers returned using the + `startKey` and `count` query parameters. + operationId: apigee.organizations.developers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21945,33 +21958,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityActionsConfig' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListOfDevelopersResponse parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: environmentsId - required: true + - in: query + name: expand + schema: + type: boolean + - in: query + name: count + schema: + type: string + format: int64 + - in: query + name: includeCompany + schema: + type: boolean + - in: query + name: ids schema: type: string - in: query - name: updateMask + name: app schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/environments/{environmentsId}:unsubscribe: - parameters: *ref_51 - post: - description: Deletes a subscription for the environment's Pub/Sub topic. - operationId: apigee.organizations.environments.unsubscribe + - in: query + name: startKey + schema: + type: string + /v1/organizations/{organizationsId}/developers/{developersId}/monetizationConfig: + parameters: *ref_1 + put: + description: Updates the monetization configuration for the developer. + operationId: apigee.organizations.developers.updateMonetizationConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -21983,7 +22013,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -21991,18 +22022,13 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig: - parameters: *ref_51 get: - description: >- - Gets the API Security runtime configuration for an environment. This - named ApiSecurityRuntimeConfig to prevent conflicts with - ApiSecurityConfig from addon config. - operationId: apigee.organizations.environments.getApiSecurityRuntimeConfig + description: Gets the monetization configuration for the developer. + operationId: apigee.organizations.developers.getMonetizationConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22015,7 +22041,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiSecurityRuntimeConfig + #/components/schemas/GoogleCloudApigeeV1DeveloperMonetizationConfig parameters: - in: path name: organizationsId @@ -22023,18 +22049,15 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}:subscribe: - parameters: *ref_51 - post: - description: >- - Creates a subscription for the environment's Pub/Sub topic. The server - will assign a random name for this subscription. The "name" and - "push_config" must *not* be specified. - operationId: apigee.organizations.environments.subscribe + /v1/organizations/{organizationsId}/developers/{developersId}/balance: + parameters: *ref_1 + get: + description: Gets the account balance for the developer. + operationId: apigee.organizations.developers.getBalance security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22046,7 +22069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Subscription' + $ref: '#/components/schemas/GoogleCloudApigeeV1DeveloperBalance' parameters: - in: path name: organizationsId @@ -22054,15 +22077,21 @@ paths: schema: type: string - in: path - name: environmentsId + name: developersId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/deployedConfig: - parameters: *ref_51 + /v1/organizations/{organizationsId}/hostStats/{hostStatsId}: + parameters: *ref_1 get: - description: Gets the deployed configuration for an environment. - operationId: apigee.organizations.environments.getDeployedConfig + description: >- + Retrieve metrics grouped by dimensions in host level. The types of + metrics you can retrieve include traffic, message counts, API call + latency, response size, and cache hits and counts. Dimensions let you + view metrics in meaningful groups. You can optionally pass dimensions as + path parameters to the `stats` API. If dimensions are not specified, the + metrics are computed on the entire set of data for the given time range. + operationId: apigee.organizations.hostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22074,7 +22103,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1EnvironmentConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1Stats' parameters: - in: path name: organizationsId @@ -22082,15 +22111,71 @@ paths: schema: type: string - in: path - name: environmentsId + name: hostStatsId required: true schema: type: string - /v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig: - parameters: *ref_51 + - in: query + name: sort + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: limit + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: sortby + schema: + type: string + - in: query + name: select + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: envgroupHostname + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: tzo + schema: + type: string + /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: + parameters: *ref_1 get: - description: Gets the add-ons config of an environment. - operationId: apigee.organizations.environments.getAddonsConfig + description: Similar to GetHostStats except that the response is less verbose. + operationId: apigee.organizations.optimizedHostStats.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22102,7 +22187,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1AddonsConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' parameters: - in: path name: organizationsId @@ -22110,21 +22195,78 @@ paths: schema: type: string - in: path - name: environmentsId + name: optimizedHostStatsId required: true schema: type: string - /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: - parameters: *ref_51 + - in: query + name: limit + schema: + type: string + - in: query + name: tsAscending + schema: + type: boolean + - in: query + name: select + schema: + type: string + - in: query + name: realtime + schema: + type: boolean + - in: query + name: tzo + schema: + type: string + - in: query + name: sort + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: accuracy + schema: + type: string + - in: query + name: sortby + schema: + type: string + - in: query + name: topk + schema: + type: string + - in: query + name: timeUnit + schema: + type: string + - in: query + name: timeRange + schema: + type: string + - in: query + name: offset + schema: + type: string + - in: query + name: envgroupHostname + schema: + type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: + parameters: *ref_1 post: - description: Compute RAV2 security scores for a set of resources. - operationId: apigee.organizations.securityAssessmentResults.batchCompute + description: >- + Creates a new attachment of an environment to an instance. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22136,24 +22278,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories: - parameters: *ref_51 - post: - description: Creates a new API category. - operationId: apigee.organizations.sites.apicategories.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + - in: path + name: instancesId + required: true + schema: + type: string + get: + description: >- + Lists all attachments to an instance. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.attachments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22165,7 +22306,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse parameters: - in: path name: organizationsId @@ -22173,13 +22315,24 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - get: - description: Returns the API categories associated with a portal. - operationId: apigee.organizations.sites.apicategories.list + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: + parameters: *ref_1 + get: + description: Gets an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22191,8 +22344,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListApiCategoriesResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' parameters: - in: path name: organizationsId @@ -22200,20 +22352,18 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apicategories/{apicategoriesId}: - parameters: *ref_51 - patch: - description: Updates an API category. - operationId: apigee.organizations.sites.apicategories.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategory' + - in: path + name: attachmentsId + required: true + schema: + type: string + delete: + description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.attachments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22225,7 +22375,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22233,18 +22383,20 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - in: path - name: apicategoriesId + name: attachmentsId required: true schema: type: string - delete: - description: Deletes an API category. - operationId: apigee.organizations.sites.apicategories.delete + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: + parameters: *ref_1 + get: + description: Gets a CanaryEvaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22256,7 +22408,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' parameters: - in: path name: organizationsId @@ -22264,18 +22416,25 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - in: path - name: apicategoriesId + name: canaryevaluationsId required: true schema: type: string - get: - description: Gets an API category. - operationId: apigee.organizations.sites.apicategories.get + /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: + parameters: *ref_1 + post: + description: Creates a new canary evaluation for an organization. + operationId: apigee.organizations.instances.canaryevaluations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22287,7 +22446,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiCategoryResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22295,20 +22454,23 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apicategoriesId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}/documentation: - parameters: *ref_51 - get: - description: Gets the documentation for the specified catalog item. - operationId: apigee.organizations.sites.apidocs.getDocumentation + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: + parameters: *ref_1 + post: + description: >- + Activates the NAT address. The Apigee instance can now use this for + Internet egress traffic. **Note:** Not supported for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.activate + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22320,8 +22482,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22329,25 +22490,31 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - in: path - name: apidocsId + name: natAddressesId required: true schema: type: string - patch: + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: + parameters: *ref_1 + post: description: >- - Updates the documentation for the specified catalog item. Note that the - documentation file contents will not be populated in the return message. - operationId: apigee.organizations.sites.apidocs.updateDocumentation + Creates a NAT address. The address is created in the RESERVED state and + a static external IP address will be provisioned. At this time, the + instance will not use this IP address for Internet egress traffic. The + address can be activated for use once any required firewall IP + whitelisting has been completed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocDocumentation' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22359,8 +22526,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ApiDocDocumentationResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22368,20 +22534,15 @@ paths: schema: type: string - in: path - name: sitesId - required: true - schema: - type: string - - in: path - name: apidocsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs/{apidocsId}: - parameters: *ref_51 - delete: - description: Deletes a catalog item. - operationId: apigee.organizations.sites.apidocs.delete + get: + description: >- + Lists the NAT addresses for an Apigee instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.natAddresses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22393,7 +22554,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DeleteResponse' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse parameters: - in: path name: organizationsId @@ -22401,23 +22563,27 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - - in: path - name: apidocsId - required: true + - in: query + name: pageToken schema: type: string - put: - description: Updates a catalog item. - operationId: apigee.organizations.sites.apidocs.update - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: + parameters: *ref_1 + delete: + description: >- + Deletes the NAT address. Connections that are actively using the address + are drained before it is removed. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22429,7 +22595,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22437,18 +22603,20 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - in: path - name: apidocsId + name: natAddressesId required: true schema: type: string get: - description: Gets a catalog item. - operationId: apigee.organizations.sites.apidocs.get + description: >- + Gets the details of a NAT address. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.natAddresses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22460,7 +22628,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' parameters: - in: path name: organizationsId @@ -22468,20 +22636,22 @@ paths: schema: type: string - in: path - name: sitesId + name: instancesId required: true schema: type: string - in: path - name: apidocsId + name: natAddressesId required: true schema: type: string - /v1/organizations/{organizationsId}/sites/{sitesId}/apidocs: - parameters: *ref_51 + /v1/organizations/{organizationsId}/instances: + parameters: *ref_1 get: - description: Returns the catalog items associated with a portal. - operationId: apigee.organizations.sites.apidocs.list + description: >- + Lists all Apigee runtime instances for the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22493,18 +22663,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiDocsResponse' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sitesId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -22515,13 +22680,16 @@ paths: schema: type: string post: - description: Creates a new catalog item. - operationId: apigee.organizations.sites.apidocs.create + description: >- + Creates an Apigee runtime instance. The instance is accessible from the + authorized network configured on the organization. **Note:** Not + supported for Apigee hybrid. + operationId: apigee.organizations.instances.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDoc' + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22533,25 +22701,61 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ApiDocResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: + parameters: *ref_1 + post: + description: Reports the latest status for a runtime instance. + operationId: apigee.organizations.instances.reportStatus + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse + parameters: - in: path - name: sitesId + name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/resultView: - parameters: *ref_51 - get: + - in: path + name: instancesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/instances/{instancesId}: + parameters: *ref_1 + patch: description: >- - After the query is completed, use this API to view the query result when - result size is small. - operationId: apigee.organizations.hostSecurityReports.getResultView + Updates an Apigee runtime instance. You can update the fields described + in NodeConfig. No other fields will be updated. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22563,8 +22767,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1SecurityReportResultView + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22572,18 +22775,21 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}: - parameters: *ref_51 - get: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: description: >- - Get status of a query submitted at host level. If the query is still in - progress, the `state` is set to "running" After the query has completed - successfully, `state` is set to "completed" - operationId: apigee.organizations.hostSecurityReports.get + Deletes an Apigee runtime instance. The instance stops serving requests + and the runtime data is deleted. **Note:** Not supported for Apigee + hybrid. + operationId: apigee.organizations.instances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22595,7 +22801,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -22603,20 +22809,15 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports/{hostSecurityReportsId}/result: - parameters: *ref_51 get: description: >- - After the query is completed, use this API to retrieve the results. If - the request succeeds, and there is a non-zero result set, the result is - downloaded to the client as a zipped JSON file. The name of the - downloaded file will be: OfflineQueryResult-.zip Example: - `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` - operationId: apigee.organizations.hostSecurityReports.getResult + Gets the details for an Apigee runtime instance. **Note:** Not supported + for Apigee hybrid. + operationId: apigee.organizations.instances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22628,7 +22829,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' parameters: - in: path name: organizationsId @@ -22636,24 +22837,27 @@ paths: schema: type: string - in: path - name: hostSecurityReportsId + name: instancesId required: true schema: type: string - /v1/organizations/{organizationsId}/hostSecurityReports: - parameters: *ref_51 + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes/{attributesId}: + parameters: *ref_1 post: description: >- - Submit a query at host level to be processed in the background. If the - submission of the query succeeds, the API returns a 201 status and an ID - that refer to the query. In addition to the HTTP status 201, the `state` - of "enqueued" means that the request succeeded. - operationId: apigee.organizations.hostSecurityReports.create + Updates the value of an API product attribute. **Note**: OAuth access + tokens and Key Management Service (KMS) entities (apps, developers, and + API products) are cached for 180 seconds (current default). Any custom + attributes associated with entities also get cached for at least 180 + seconds after entity is accessed during runtime. In this case, the + `ExpiresIn` element on the OAuthV2 policy won't be able to expire an + access token in less than 180 seconds. + operationId: apigee.organizations.apiproducts.attributes.updateApiProductAttribute requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReportQuery' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22665,73 +22869,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecurityReport' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId required: true schema: type: string - get: - description: Return a list of Security Reports at host level. - operationId: apigee.organizations.hostSecurityReports.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSecurityReportsResponse - parameters: - in: path - name: organizationsId + name: apiproductsId required: true schema: type: string - - in: query - name: dataset - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: status - schema: - type: string - - in: query - name: to - schema: - type: string - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: submittedBy - schema: - type: string - - in: query - name: from - schema: - type: string - - in: query - name: pageToken + - in: path + name: attributesId + required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors/{datacollectorsId}: - parameters: *ref_51 - get: - description: Gets a data collector. - operationId: apigee.organizations.datacollectors.get + delete: + description: Deletes an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22743,7 +22900,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22751,18 +22908,18 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: apiproductsId required: true schema: type: string - patch: - description: Updates a data collector. - operationId: apigee.organizations.datacollectors.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + - in: path + name: attributesId + required: true + schema: + type: string + get: + description: Gets the value of an API product attribute. + operationId: apigee.organizations.apiproducts.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22774,7 +22931,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attribute' parameters: - in: path name: organizationsId @@ -22782,18 +22939,20 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: apiproductsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: attributesId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a data collector. - operationId: apigee.organizations.datacollectors.delete + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/attributes: + parameters: *ref_1 + get: + description: Lists all API product attributes. + operationId: apigee.organizations.apiproducts.attributes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22805,7 +22964,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId @@ -22813,15 +22972,29 @@ paths: schema: type: string - in: path - name: datacollectorsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/datacollectors: - parameters: *ref_51 - get: - description: Lists all data collectors. - operationId: apigee.organizations.datacollectors.list + post: + description: >- + Updates or creates API product attributes. This API **replaces** the + current list of attributes with the attributes specified in the request + body. In this way, you can update existing attributes, add new + attributes, or delete existing attributes by omitting them from the + request body. **Note**: OAuth access tokens and Key Management Service + (KMS) entities (apps, developers, and API products) are cached for 180 + seconds (current default). Any custom attributes associated with + entities also get cached for at least 180 seconds after entity is + accessed during runtime. In this case, the `ExpiresIn` element on the + OAuthV2 policy won't be able to expire an access token in less than 180 + seconds. + operationId: apigee.organizations.apiproducts.attributes + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22833,31 +23006,38 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDataCollectorsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1Attributes' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: apiproductsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans: + parameters: *ref_1 post: - description: Creates a new data collector. - operationId: apigee.organizations.datacollectors.create + description: >- + Create a rate plan that is associated with an API product in an + organization. Using rate plans, API product owners can monetize their + API products by configuring one or more of the following: - Billing + frequency - Initial setup fees for using an API product - Payment + funding model (postpaid only) - Fixed recurring or consumption-based + charges for using an API product - Revenue sharing with developer + partners An API product can have multiple rate plans associated with it + but *only one* rate plan can be active at any point of time. **Note: + From the developer's perspective, they purchase API products not rate + plans. + operationId: apigee.organizations.apiproducts.rateplans.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22869,22 +23049,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1DataCollector' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: dataCollectorId + - in: path + name: apiproductsId + required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}/deployments: - parameters: *ref_51 get: - description: Lists all deployments of a shared flow revision. - operationId: apigee.organizations.sharedflows.revisions.deployments.list + description: Lists all the rate plans for an API product. + operationId: apigee.organizations.apiproducts.rateplans.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22896,8 +23075,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ListRatePlansResponse' parameters: - in: path name: organizationsId @@ -22905,27 +23083,41 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - - in: path - name: revisionsId - required: true + - in: query + name: count + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/revisions/{revisionsId}: - parameters: *ref_51 - get: - description: >- - Gets a revision of a shared flow. To download the shared flow - configuration bundle for the specified revision as a zip file, set the - `format` query parameter to `bundle`. If you are using curl, specify `-o - filename.zip` to save the output to a file; otherwise, it displays to - `stdout`. Then, develop the shared flow configuration locally and upload - the updated sharedFlow configuration revision, as described in - [updateSharedFlowRevision](updateSharedFlowRevision). - operationId: apigee.organizations.sharedflows.revisions.get + - in: query + name: startKey + schema: + type: string + - in: query + name: expand + schema: + type: boolean + - in: query + name: state + schema: + type: string + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}/rateplans/{rateplansId}: + parameters: *ref_1 + put: + description: Updates an existing rate plan. + operationId: apigee.organizations.apiproducts.rateplans.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22937,7 +23129,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -22945,24 +23137,18 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - in: path - name: revisionsId + name: rateplansId required: true schema: type: string - - in: query - name: format - schema: - type: string delete: - description: >- - Deletes a shared flow and all associated policies, resources, and - revisions. You must undeploy the shared flow before deleting it. - operationId: apigee.organizations.sharedflows.revisions.delete + description: Deletes a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -22974,7 +23160,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -22982,28 +23168,18 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - in: path - name: revisionsId + name: rateplansId required: true schema: type: string - post: - description: >- - Updates a shared flow revision. This operation is only allowed on - revisions which have never been deployed. After deployment a revision - becomes immutable, even if it becomes undeployed. The payload is a - ZIP-formatted shared flow. Content type must be either - multipart/form-data or application/octet-stream. - operationId: apigee.organizations.sharedflows.revisions.updateSharedFlowRevision - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + get: + description: Gets the details of a rate plan. + operationId: apigee.organizations.apiproducts.rateplans.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23015,7 +23191,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1RatePlan' parameters: - in: path name: organizationsId @@ -23023,24 +23199,43 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - in: path - name: revisionsId + name: rateplansId required: true schema: type: string - - in: query - name: validate - schema: - type: boolean - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}/deployments: - parameters: *ref_51 - get: - description: Lists all deployments of a shared flow. - operationId: apigee.organizations.sharedflows.deployments.list + /v1/organizations/{organizationsId}/apiproducts: + parameters: *ref_1 + post: + description: >- + Creates an API product in an organization. You create API products after + you have proxied backend services using API proxies. An API product is a + collection of API resources combined with quota settings and metadata + that you can use to deliver customized and productized API bundles to + your developer community. This metadata can include: - Scope - + Environments - API proxies - Extensible profile API products enable you + repackage APIs on the fly, without having to do any additional coding or + configuration. Apigee recommends that you start with a simple API + product including only required elements. You then provision credentials + to apps to enable them to start testing your APIs. After you have + authentication and authorization working against a simple API product, + you can iterate to create finer-grained API products, defining different + sets of API resources for each API product. **WARNING:** - If you don't + specify an API proxy in the request body, *any* app associated with the + product can make calls to *any* API in your entire organization. - If + you don't specify an environment in the request body, the product allows + access to all environments. For more information, see What is an API + product? + operationId: apigee.organizations.apiproducts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23052,24 +23247,20 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId required: true schema: type: string - - in: path - name: sharedflowsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/sharedflows: - parameters: *ref_51 get: - description: Lists all shared flows in the organization. - operationId: apigee.organizations.sharedflows.list + description: >- + Lists all API product names for an organization. Filter the list by + passing an `attributename` and `attibutevalue`. The maximum number of + API products returned is 1000. You can paginate the list of API products + returned using the `startKey` and `count` query parameters. + operationId: apigee.organizations.apiproducts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23082,7 +23273,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListSharedFlowsResponse + #/components/schemas/GoogleCloudApigeeV1ListApiProductsResponse parameters: - in: path name: organizationsId @@ -23090,26 +23281,39 @@ paths: schema: type: string - in: query - name: includeMetaData + name: attributename schema: - type: boolean + type: string - in: query - name: includeRevisions + name: count + schema: + type: string + format: int64 + - in: query + name: startKey + schema: + type: string + - in: query + name: attributevalue + schema: + type: string + - in: query + name: expand schema: type: boolean - post: + /v1/organizations/{organizationsId}/apiproducts/{apiproductsId}: + parameters: *ref_1 + delete: description: >- - Uploads a ZIP-formatted shared flow configuration bundle to an - organization. If the shared flow already exists, this creates a new - revision of it. If the shared flow does not exist, this creates it. Once - imported, the shared flow revision must be deployed before it can be - accessed at runtime. The size limit of a shared flow bundle is 15 MB. - operationId: apigee.organizations.sharedflows.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiHttpBody' + Deletes an API product from an organization. Deleting an API product + causes app requests to the resource URIs defined in the API product to + fail. Ensure that you create a new API product to serve existing apps, + unless your intention is to disable access to the resources defined in + the API product. The API product name required in the request URL is the + internal name of the product, not the display name. While they may be + the same, it depends on whether the API product was created via the UI + or the API. View the list of API products to verify the internal name. + operationId: apigee.organizations.apiproducts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23121,26 +23325,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlowRevision' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: action - schema: - type: string - - in: query - name: name + - in: path + name: apiproductsId + required: true schema: type: string - /v1/organizations/{organizationsId}/sharedflows/{sharedflowsId}: - parameters: *ref_51 - get: - description: Gets a shared flow by name, including a list of its revisions. - operationId: apigee.organizations.sharedflows.get + put: + description: >- + Updates an existing API product. You must include all required values, + whether or not you are updating them, as well as any optional values + that you are updating. The API product name required in the request URL + is the internal name of the product, not the display name. While they + may be the same, it depends on whether the API product was created via + UI or API. View the list of API products to identify their internal + names. + operationId: apigee.organizations.apiproducts.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23152,7 +23363,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -23160,15 +23371,18 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - delete: + get: description: >- - Deletes a shared flow and all it's revisions. The shared flow must be - undeployed before you can delete it. - operationId: apigee.organizations.sharedflows.delete + Gets configuration details for an API product. The API product name + required in the request URL is the internal name of the product, not the + display name. While they may be the same, it depends on whether the API + product was created via the UI or the API. View the list of API products + to verify the internal name. + operationId: apigee.organizations.apiproducts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23180,7 +23394,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SharedFlow' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProduct' parameters: - in: path name: organizationsId @@ -23188,15 +23402,22 @@ paths: schema: type: string - in: path - name: sharedflowsId + name: apiproductsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations/{canaryevaluationsId}: - parameters: *ref_51 - get: - description: Gets a CanaryEvaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.get + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + parameters: *ref_1 + put: + description: >- + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.keyvaluemaps.entries.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23208,7 +23429,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23216,25 +23437,23 @@ paths: schema: type: string - in: path - name: instancesId + name: keyvaluemapsId required: true schema: type: string - in: path - name: canaryevaluationsId + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/canaryevaluations: - parameters: *ref_51 - post: - description: Creates a new canary evaluation for an organization. - operationId: apigee.organizations.instances.canaryevaluations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1CanaryEvaluation' + delete: + description: >- + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23246,7 +23465,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23254,15 +23473,21 @@ paths: schema: type: string - in: path - name: instancesId + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments/{attachmentsId}: - parameters: *ref_51 get: - description: Gets an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.get + description: >- + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23274,7 +23499,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23282,18 +23507,28 @@ paths: schema: type: string - in: path - name: instancesId + name: keyvaluemapsId required: true schema: type: string - in: path - name: attachmentsId + name: entriesId required: true schema: type: string - delete: - description: Deletes an attachment. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.delete + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}/entries: + parameters: *ref_1 + post: + description: >- + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.keyvaluemaps.entries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23305,7 +23540,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId @@ -23313,22 +23548,16 @@ paths: schema: type: string - in: path - name: instancesId - required: true - schema: - type: string - - in: path - name: attachmentsId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/attachments: - parameters: *ref_51 get: description: >- - Lists all attachments to an instance. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.attachments.list + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23341,7 +23570,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListInstanceAttachmentsResponse + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId @@ -23349,7 +23578,7 @@ paths: schema: type: string - in: path - name: instancesId + name: keyvaluemapsId required: true schema: type: string @@ -23362,16 +23591,11 @@ paths: name: pageToken schema: type: string - post: - description: >- - Creates a new attachment of an environment to an instance. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.attachments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1InstanceAttachment' + /v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an organization. + operationId: apigee.organizations.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23383,7 +23607,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -23391,18 +23615,20 @@ paths: schema: type: string - in: path - name: instancesId + name: keyvaluemapsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}: - parameters: *ref_51 - delete: - description: >- - Deletes the NAT address. Connections that are actively using the address - are drained before it is removed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.delete + /v1/organizations/{organizationsId}/keyvaluemaps: + parameters: *ref_1 + post: + description: Creates a key value map in an organization. + operationId: apigee.organizations.keyvaluemaps.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23414,28 +23640,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}/analytics/datastores: + parameters: *ref_1 + get: + description: List Datastores + operationId: apigee.organizations.analytics.datastores.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ListDatastoresResponse' + parameters: - in: path - name: instancesId + name: organizationsId required: true schema: type: string - - in: path - name: natAddressesId - required: true + - in: query + name: targetType schema: type: string - get: - description: >- - Gets the details of a NAT address. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.get + post: + description: Create a Datastore for an org + operationId: apigee.organizations.analytics.datastores.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23447,36 +23693,49 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}/analytics/datastores/{datastoresId}: + parameters: *ref_1 + get: + description: Get a Datastore + operationId: apigee.organizations.analytics.datastores.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' + parameters: - in: path - name: instancesId + name: organizationsId required: true schema: type: string - in: path - name: natAddressesId + name: datastoresId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses/{natAddressesId}:activate: - parameters: *ref_51 - post: - description: >- - Activates the NAT address. The Apigee instance can now use this for - Internet egress traffic. **Note:** Not supported for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.activate + put: + description: Update a Datastore + operationId: apigee.organizations.analytics.datastores.update requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ActivateNatAddressRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23488,7 +23747,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' parameters: - in: path name: organizationsId @@ -23496,22 +23755,13 @@ paths: schema: type: string - in: path - name: instancesId - required: true - schema: - type: string - - in: path - name: natAddressesId + name: datastoresId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}/natAddresses: - parameters: *ref_51 - get: - description: >- - Lists the NAT addresses for an Apigee instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.natAddresses.list + delete: + description: Delete a Datastore from an org. + operationId: apigee.organizations.analytics.datastores.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23523,8 +23773,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListNatAddressesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -23532,33 +23781,23 @@ paths: schema: type: string - in: path - name: instancesId + name: datastoresId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/organizations/{organizationsId}/analytics/datastores:test: + parameters: *ref_1 post: description: >- - Creates a NAT address. The address is created in the RESERVED state and - a static external IP address will be provisioned. At this time, the - instance will not use this IP address for Internet egress traffic. The - address can be activated for use once any required firewall IP - whitelisting has been completed. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.natAddresses.create + Test if Datastore configuration is correct. This includes checking if + credentials provided by customer have required permissions in target + destination storage + operationId: apigee.organizations.analytics.datastores.test requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1NatAddress' + $ref: '#/components/schemas/GoogleCloudApigeeV1Datastore' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23570,26 +23809,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1TestDatastoreResponse' parameters: - in: path name: organizationsId required: true schema: type: string + /v1/organizations/{organizationsId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of API proxies or shared flows. + operationId: apigee.organizations.deployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse + parameters: - in: path - name: instancesId + name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}: - parameters: *ref_51 - delete: - description: >- - Deletes an Apigee runtime instance. The instance stops serving requests - and the runtime data is deleted. **Note:** Not supported for Apigee - hybrid. - operationId: apigee.organizations.instances.delete + - in: query + name: sharedFlows + schema: + type: boolean + /v1/organizations/{organizationsId}/apis/{apisId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of an API proxy. + operationId: apigee.organizations.apis.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23601,7 +23860,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -23609,21 +23869,15 @@ paths: schema: type: string - in: path - name: instancesId + name: apisId required: true schema: type: string - patch: - description: >- - Updates an Apigee runtime instance. You can update the fields described - in NodeConfig. No other fields will be updated. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}/deployments: + parameters: *ref_1 + get: + description: Lists all deployments of an API proxy revision. + operationId: apigee.organizations.apis.revisions.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23635,7 +23889,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListDeploymentsResponse parameters: - in: path name: organizationsId @@ -23643,20 +23898,23 @@ paths: schema: type: string - in: path - name: instancesId + name: apisId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: revisionsId + required: true schema: - type: string - format: google-fieldmask - get: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/revisions/{revisionsId}: + parameters: *ref_1 + delete: description: >- - Gets the details for an Apigee runtime instance. **Note:** Not supported - for Apigee hybrid. - operationId: apigee.organizations.instances.get + Deletes an API proxy revision and all policies, resources, endpoints, + and revisions associated with it. The API proxy revision must be + undeployed before you can delete it. + operationId: apigee.organizations.apis.revisions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23668,7 +23926,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId @@ -23676,17 +23934,25 @@ paths: schema: type: string - in: path - name: instancesId + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances: - parameters: *ref_51 get: description: >- - Lists all Apigee runtime instances for the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.list + Gets an API proxy revision. To download the API proxy configuration + bundle for the specified revision as a zip file, set the `format` query + parameter to `bundle`. If you are using curl, specify `-o filename.zip` + to save the output to a file; otherwise, it displays to `stdout`. Then, + develop the API proxy configuration locally and upload the updated API + proxy configuration revision, as described in + [updateApiProxyRevision](updateApiProxyRevision). + operationId: apigee.organizations.apis.revisions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23698,33 +23964,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1ListInstancesResponse' + $ref: '#/components/schemas/GoogleApiHttpBody' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true schema: type: string - in: query - name: pageSize + name: format schema: - type: integer - format: int32 + type: string post: description: >- - Creates an Apigee runtime instance. The instance is accessible from the - authorized network configured on the organization. **Note:** Not - supported for Apigee hybrid. - operationId: apigee.organizations.instances.create + Updates an existing API proxy revision by uploading the API proxy + configuration bundle as a zip file from your local machine. You can + update only API proxy revisions that have never been deployed. After + deployment, an API proxy revision becomes immutable, even if it is + undeployed. Set the `Content-Type` header to either + `multipart/form-data` or `application/octet-stream`. + operationId: apigee.organizations.apis.revisions.updateApiProxyRevision requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Instance' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23736,24 +24010,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/instances/{instancesId}:reportStatus: - parameters: *ref_51 + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: revisionsId + required: true + schema: + type: string + - in: query + name: validate + schema: + type: boolean + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps: + parameters: *ref_1 post: - description: Reports the latest status for a runtime instance. - operationId: apigee.organizations.instances.reportStatus + description: Creates a key value map in an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusRequest + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23765,8 +24052,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ReportInstanceStatusResponse + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -23774,15 +24060,15 @@ paths: schema: type: string - in: path - name: instancesId + name: apisId required: true schema: type: string - /v1/organizations/{organizationsId}/optimizedHostStats/{optimizedHostStatsId}: - parameters: *ref_51 - get: - description: Similar to GetHostStats except that the response is less verbose. - operationId: apigee.organizations.optimizedHostStats.get + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}: + parameters: *ref_1 + delete: + description: Deletes a key value map from an API proxy. + operationId: apigee.organizations.apis.keyvaluemaps.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23794,7 +24080,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1OptimizedStats' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueMap' parameters: - in: path name: organizationsId @@ -23802,71 +24088,23 @@ paths: schema: type: string - in: path - name: optimizedHostStatsId + name: apisId required: true schema: type: string - - in: query - name: realtime - schema: - type: boolean - - in: query - name: tzo - schema: - type: string - - in: query - name: envgroupHostname - schema: - type: string - - in: query - name: offset - schema: - type: string - - in: query - name: tsAscending - schema: - type: boolean - - in: query - name: timeUnit - schema: - type: string - - in: query - name: accuracy - schema: - type: string - - in: query - name: sortby - schema: - type: string - - in: query - name: select - schema: - type: string - - in: query - name: topk - schema: - type: string - - in: query - name: timeRange - schema: - type: string - - in: query - name: limit - schema: - type: string - - in: query - name: sort - schema: - type: string - - in: query - name: filter + - in: path + name: keyvaluemapsId + required: true schema: type: string - /v1/organizations/{organizationsId}/runtimeConfig: - parameters: *ref_51 + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries/{entriesId}: + parameters: *ref_1 get: - description: Get runtime config for an organization. - operationId: apigee.organizations.getRuntimeConfig + description: >- + Get the key value entry value for a key value map scoped to an + organization, environment, or API proxy. **Note**: Supported for Apigee + hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23878,83 +24116,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1RuntimeConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations: - parameters: *ref_51 - get: - description: >- - Lists the Apigee organizations and associated Google Cloud projects that - you have permission to access. See [Understanding - organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). - operationId: apigee.organizations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1ListOrganizationsResponse - parameters: [] - post: - description: >- - Creates an Apigee organization. See [Create an Apigee - organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - operationId: apigee.organizations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: query - name: parent + - in: path + name: apisId + required: true schema: type: string - /v1/organizations/{organizationsId}:setSyncAuthorization: - parameters: *ref_51 - post: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + delete: description: >- - Sets the permissions required to allow the Synchronizer to download - environment data from the control plane. You must call this API to - enable proper functioning of hybrid. Pass the ETag when calling - `setSyncAuthorization` to ensure that you are updating the correct - version. To get an ETag, call - [getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag - in the call to `setSyncAuthorization`, then the existing authorization - is overwritten indiscriminately. For more information, see [Configure - the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.setSyncAuthorization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + Deletes a key value entry from a key value map scoped to an + organization, environment, or API proxy. **Notes:** * After you delete + the key value entry, the policy consuming the entry will continue to + function with its cached values for a few minutes. This is expected + behavior. * Supported for Apigee hybrid 1.8.x and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23966,18 +24157,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}/deployedIngressConfig: - parameters: *ref_51 - get: - description: Gets the deployed ingress configuration for an organization. - operationId: apigee.organizations.getDeployedIngressConfig + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + put: + description: >- + Update key value entry scoped to an organization, environment, or API + proxy for an existing key. + operationId: apigee.organizations.apis.keyvaluemaps.entries.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -23989,29 +24200,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1IngressConfig' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: view + - in: path + name: apisId + required: true schema: type: string - /v1/organizations/{organizationsId}: - parameters: *ref_51 - put: + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: path + name: entriesId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}/entries: + parameters: *ref_1 + post: description: >- - Updates the properties for an Apigee organization. No other fields in - the organization profile will be updated. - operationId: apigee.organizations.update + Creates key value entries in a key value map scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24023,18 +24246,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: '#/components/schemas/GoogleCloudApigeeV1KeyValueEntry' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string get: description: >- - Gets the profile for an Apigee organization. See [Understanding - organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure). - operationId: apigee.organizations.get + Lists key value entries for key values maps scoped to an organization, + environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x + and higher. + operationId: apigee.organizations.apis.keyvaluemaps.entries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24046,26 +24280,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1Organization' + $ref: >- + #/components/schemas/GoogleCloudApigeeV1ListKeyValueEntriesResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: apisId + required: true + schema: + type: string + - in: path + name: keyvaluemapsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/organizations/{organizationsId}/apis/{apisId}: + parameters: *ref_1 delete: description: >- - Delete an Apigee organization. For organizations with BillingType - EVALUATION, an immediate deletion is performed. For paid organizations - (Subscription or Pay-as-you-go), a soft-deletion is performed. The - organization can be restored within the soft-deletion period, which is - specified using the `retention` field in the request or by filing a - support ticket with Apigee. During the data retention period specified - in the request, the Apigee organization cannot be recreated in the same - Google Cloud project. **IMPORTANT: The default data retention setting - for this operation is 7 days. To permanently delete the organization in - 24 hours, set the retention parameter to `MINIMUM`.** - operationId: apigee.organizations.delete + Deletes an API proxy and all associated endpoints, policies, resources, + and revisions. The API proxy must be undeployed before you can delete + it. + operationId: apigee.organizations.apis.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24077,29 +24326,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: retention + - in: path + name: apisId + required: true schema: type: string - /v1/organizations/{organizationsId}/securitySettings: - parameters: *ref_51 - patch: - description: >- - UpdateSecuritySettings updates the current security settings for API - Security. - operationId: apigee.organizations.updateSecuritySettings - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + get: + description: Gets an API proxy including a list of existing revisions. + operationId: apigee.organizations.apis.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24111,21 +24352,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: apisId + required: true schema: type: string - format: google-fieldmask - get: - description: GetSecuritySettings gets the security settings for API Security. - operationId: apigee.organizations.getSecuritySettings + patch: + description: Updates an existing API proxy. + operationId: apigee.organizations.apis.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24137,25 +24383,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SecuritySettings' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxy' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:setAddons: - parameters: *ref_51 + - in: path + name: apisId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/organizations/{organizationsId}/apis: + parameters: *ref_1 post: description: >- - Configures the add-ons for the Apigee organization. The existing add-on - configuration will be fully replaced. - operationId: apigee.organizations.setAddons + Creates an API proxy. The API proxy created will not be accessible at + runtime until it is deployed to an environment. Create a new API proxy + by setting the `name` query parameter to the name of the API proxy. + Import an API proxy configuration bundle stored in zip format on your + local machine to your organization by doing the following: * Set the + `name` query parameter to the name of the API proxy. * Set the `action` + query parameter to `import`. * Set the `Content-Type` header to + `multipart/form-data`. * Pass as a file the name of API proxy + configuration bundle stored in zip format on your local machine using + the `file` form field. **Note**: To validate the API proxy configuration + bundle only without importing it, set the `action` query parameter to + `validate`. When importing an API proxy configuration bundle, if the API + proxy does not exist, it will be created. If the API proxy exists, then + a new revision is created. Invalid API proxy configurations are + rejected, and a list of validation errors is returned to the client. + operationId: apigee.organizations.apis.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SetAddonsRequest' + $ref: '#/components/schemas/GoogleApiHttpBody' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24167,33 +24436,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudApigeeV1ApiProxyRevision' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:getSyncAuthorization: - parameters: *ref_51 - post: + - in: query + name: action + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: validate + schema: + type: boolean + get: description: >- - Lists the service accounts with the permissions required to allow the - Synchronizer to download environment data from the control plane. An - ETag is returned in the response to `getSyncAuthorization`. Pass that - ETag when calling [setSyncAuthorization](setSyncAuthorization) to ensure - that you are updating the correct version. If you don't pass the ETag in - the call to `setSyncAuthorization`, then the existing authorization is - overwritten indiscriminately. For more information, see [Configure the - Synchronizer](https://cloud.google.com/apigee/docs/hybrid/latest/synchronizer-access). - **Note**: Available to Apigee hybrid only. - operationId: apigee.organizations.getSyncAuthorization - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudApigeeV1GetSyncAuthorizationRequest + Lists the names of all API proxies in an organization. The names + returned correspond to the names defined in the configuration files for + each API proxy. + operationId: apigee.organizations.apis.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24205,18 +24472,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudApigeeV1SyncAuthorization' + $ref: '#/components/schemas/GoogleCloudApigeeV1ListApiProxiesResponse' parameters: - in: path name: organizationsId required: true schema: type: string - /v1/organizations/{organizationsId}:getProjectMapping: - parameters: *ref_51 - get: - description: Gets the project ID and region for an Apigee organization. - operationId: apigee.organizations.getProjectMapping + - in: query + name: includeRevisions + schema: + type: boolean + - in: query + name: includeMetaData + schema: + type: boolean + /v1/organizations/{organizationsId}/securityAssessmentResults:batchCompute: + parameters: *ref_1 + post: + description: Compute RAV2 security scores for a set of resources. + operationId: apigee.organizations.securityAssessmentResults.batchCompute + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -24229,7 +24510,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudApigeeV1OrganizationProjectMapping + #/components/schemas/GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsResponse parameters: - in: path name: organizationsId @@ -24237,7 +24518,7 @@ paths: schema: type: string /v1/hybrid/issuers: - parameters: *ref_51 + parameters: *ref_1 get: description: >- Lists hybrid services and its trusted issuers service account ids. This @@ -24260,7 +24541,7 @@ paths: #/components/schemas/GoogleCloudApigeeV1ListHybridIssuersResponse parameters: [] /v1/projects/{projectsId}:provisionOrganization: - parameters: *ref_51 + parameters: *ref_1 post: description: >- Provisions a new Apigee organization with a functioning runtime. This is diff --git a/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml b/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml index cea62cd9..4b672d8c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apigeeregistry.yaml @@ -8,7 +8,7 @@ info: description: '' version: v1 x-discovery-doc-revision: '20231204' - x-generated-date: '2024-06-03' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub servers: @@ -1237,16 +1237,13 @@ components: name: locations title: Locations methods: - _projects_locations_list: - operation: &ref_1 + projects_locations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 projects_locations_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1261,23 +1258,21 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] operations: id: google.apigeeregistry.operations name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -1307,6 +1302,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete @@ -1344,6 +1340,7 @@ components: - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_locations_instances_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_locations_instances_delete @@ -1359,17 +1356,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_instances_get_iam_policy: - operation: &ref_5 + projects_locations_instances_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_instances_get_iam_policy: - operation: *ref_5 - response: *ref_6 projects_locations_instances_test_iam_permissions: operation: $ref: >- @@ -1383,23 +1377,23 @@ components: #/components/x-stackQL-resources/instances_iam_policies/methods/projects_locations_instances_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/projects_locations_instances_set_iam_policy delete: [] apis: id: google.apigeeregistry.apis name: apis title: Apis methods: - _projects_locations_apis_list: - operation: &ref_7 + projects_locations_apis_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apis - projects_locations_apis_list: - operation: *ref_7 - response: *ref_8 projects_locations_apis_create: operation: $ref: >- @@ -1440,6 +1434,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/apis/methods/projects_locations_apis_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/apis/methods/projects_locations_apis_delete @@ -1455,17 +1450,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_get_iam_policy: - operation: &ref_9 + projects_locations_apis_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}:getIamPolicy/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_apis_get_iam_policy: - operation: *ref_9 - response: *ref_10 projects_locations_apis_test_iam_permissions: operation: $ref: >- @@ -1479,23 +1471,23 @@ components: #/components/x-stackQL-resources/apis_iam_policies/methods/projects_locations_apis_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/apis_iam_policies/methods/projects_locations_apis_set_iam_policy delete: [] versions: id: google.apigeeregistry.versions name: versions title: Versions methods: - _projects_locations_apis_versions_list: - operation: &ref_11 + projects_locations_apis_versions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiVersions - projects_locations_apis_versions_list: - operation: *ref_11 - response: *ref_12 projects_locations_apis_versions_create: operation: $ref: >- @@ -1536,6 +1528,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_apis_versions_delete @@ -1551,17 +1544,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_versions_get_iam_policy: - operation: &ref_13 + projects_locations_apis_versions_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}:getIamPolicy/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_apis_versions_get_iam_policy: - operation: *ref_13 - response: *ref_14 projects_locations_apis_versions_test_iam_permissions: operation: $ref: >- @@ -1575,23 +1565,23 @@ components: #/components/x-stackQL-resources/versions_iam_policies/methods/projects_locations_apis_versions_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/versions_iam_policies/methods/projects_locations_apis_versions_set_iam_policy delete: [] specs: id: google.apigeeregistry.specs name: specs title: Specs methods: - _projects_locations_apis_versions_specs_list: - operation: &ref_15 + projects_locations_apis_versions_specs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiSpecs - projects_locations_apis_versions_specs_list: - operation: *ref_15 - response: *ref_16 projects_locations_apis_versions_specs_create: operation: $ref: >- @@ -1646,6 +1636,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/specs/methods/projects_locations_apis_versions_specs_delete @@ -1667,29 +1658,28 @@ components: #/components/x-stackQL-resources/specs_contents/methods/projects_locations_apis_versions_specs_get_contents insert: [] update: [] + replace: [] delete: [] specs_revisions: id: google.apigeeregistry.specs_revisions name: specs_revisions title: Specs_revisions methods: - _projects_locations_apis_versions_specs_list_revisions: - operation: &ref_17 + projects_locations_apis_versions_specs_list_revisions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}:listRevisions/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiSpecs - projects_locations_apis_versions_specs_list_revisions: - operation: *ref_17 - response: *ref_18 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/specs_revisions/methods/projects_locations_apis_versions_specs_list_revisions insert: [] update: [] + replace: [] delete: [] specs_revision: id: google.apigeeregistry.specs_revision @@ -1707,6 +1697,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/specs_revision/methods/projects_locations_apis_versions_specs_delete_revision @@ -1722,17 +1713,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_versions_specs_get_iam_policy: - operation: &ref_19 + projects_locations_apis_versions_specs_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_apis_versions_specs_get_iam_policy: - operation: *ref_19 - response: *ref_20 projects_locations_apis_versions_specs_test_iam_permissions: operation: $ref: >- @@ -1746,23 +1734,23 @@ components: #/components/x-stackQL-resources/specs_iam_policies/methods/projects_locations_apis_versions_specs_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/specs_iam_policies/methods/projects_locations_apis_versions_specs_set_iam_policy delete: [] artifacts: id: google.apigeeregistry.artifacts name: artifacts title: Artifacts methods: - _projects_locations_apis_versions_specs_artifacts_list: - operation: &ref_21 + projects_locations_apis_versions_specs_artifacts_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}~1artifacts/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.artifacts - projects_locations_apis_versions_specs_artifacts_list: - operation: *ref_21 - response: *ref_22 projects_locations_apis_versions_specs_artifacts_create: operation: $ref: >- @@ -1791,17 +1779,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_versions_artifacts_list: - operation: &ref_23 + projects_locations_apis_versions_artifacts_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1artifacts/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.artifacts - projects_locations_apis_versions_artifacts_list: - operation: *ref_23 - response: *ref_24 projects_locations_apis_versions_artifacts_create: operation: $ref: >- @@ -1830,17 +1815,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_deployments_artifacts_list: - operation: &ref_25 + projects_locations_apis_deployments_artifacts_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1deployments~1{deploymentsId}~1artifacts/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.artifacts - projects_locations_apis_deployments_artifacts_list: - operation: *ref_25 - response: *ref_26 projects_locations_apis_deployments_artifacts_create: operation: $ref: >- @@ -1869,17 +1851,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_artifacts_list: - operation: &ref_27 + projects_locations_apis_artifacts_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1artifacts/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.artifacts - projects_locations_apis_artifacts_list: - operation: *ref_27 - response: *ref_28 projects_locations_apis_artifacts_create: operation: $ref: >- @@ -1908,17 +1887,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_artifacts_list: - operation: &ref_29 + projects_locations_artifacts_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1artifacts/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.artifacts - projects_locations_artifacts_list: - operation: *ref_29 - response: *ref_30 projects_locations_artifacts_create: operation: $ref: >- @@ -1981,6 +1957,17 @@ components: - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_artifacts_create update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_specs_artifacts_replace_artifact + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_artifacts_replace_artifact + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_deployments_artifacts_replace_artifact + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_artifacts_replace_artifact + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/projects_locations_artifacts_replace_artifact delete: - $ref: >- #/components/x-stackQL-resources/artifacts/methods/projects_locations_apis_versions_specs_artifacts_delete @@ -2046,6 +2033,7 @@ components: #/components/x-stackQL-resources/artifacts_contents/methods/projects_locations_artifacts_get_contents insert: [] update: [] + replace: [] delete: [] artifacts_iam_policies: id: google.apigeeregistry.artifacts_iam_policies @@ -2059,17 +2047,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_versions_specs_artifacts_get_iam_policy: - operation: &ref_31 + projects_locations_apis_versions_specs_artifacts_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1specs~1{specsId}~1artifacts~1{artifactsId}:getIamPolicy/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_apis_versions_specs_artifacts_get_iam_policy: - operation: *ref_31 - response: *ref_32 projects_locations_apis_versions_specs_artifacts_test_iam_permissions: operation: $ref: >- @@ -2084,17 +2069,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_versions_artifacts_get_iam_policy: - operation: &ref_33 + projects_locations_apis_versions_artifacts_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1versions~1{versionsId}~1artifacts~1{artifactsId}:getIamPolicy/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_apis_versions_artifacts_get_iam_policy: - operation: *ref_33 - response: *ref_34 projects_locations_apis_versions_artifacts_test_iam_permissions: operation: $ref: >- @@ -2109,17 +2091,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_artifacts_get_iam_policy: - operation: &ref_35 + projects_locations_apis_artifacts_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1artifacts~1{artifactsId}:getIamPolicy/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_apis_artifacts_get_iam_policy: - operation: *ref_35 - response: *ref_36 projects_locations_apis_artifacts_test_iam_permissions: operation: $ref: >- @@ -2134,17 +2113,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_artifacts_get_iam_policy: - operation: &ref_37 + projects_locations_artifacts_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1artifacts~1{artifactsId}:getIamPolicy/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_artifacts_get_iam_policy: - operation: *ref_37 - response: *ref_38 projects_locations_artifacts_test_iam_permissions: operation: $ref: >- @@ -2164,23 +2140,29 @@ components: #/components/x-stackQL-resources/artifacts_iam_policies/methods/projects_locations_artifacts_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/artifacts_iam_policies/methods/projects_locations_apis_versions_specs_artifacts_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/artifacts_iam_policies/methods/projects_locations_apis_versions_artifacts_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/artifacts_iam_policies/methods/projects_locations_apis_artifacts_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/artifacts_iam_policies/methods/projects_locations_artifacts_set_iam_policy delete: [] deployments: id: google.apigeeregistry.deployments name: deployments title: Deployments methods: - _projects_locations_apis_deployments_list: - operation: &ref_39 + projects_locations_apis_deployments_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1deployments/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiDeployments - projects_locations_apis_deployments_list: - operation: *ref_39 - response: *ref_40 projects_locations_apis_deployments_create: operation: $ref: >- @@ -2235,6 +2217,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/deployments/methods/projects_locations_apis_deployments_delete @@ -2243,23 +2226,21 @@ components: name: deployments_revisions title: Deployments_revisions methods: - _projects_locations_apis_deployments_list_revisions: - operation: &ref_41 + projects_locations_apis_deployments_list_revisions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1deployments~1{deploymentsId}:listRevisions/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.apiDeployments - projects_locations_apis_deployments_list_revisions: - operation: *ref_41 - response: *ref_42 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/deployments_revisions/methods/projects_locations_apis_deployments_list_revisions insert: [] update: [] + replace: [] delete: [] deployments_revision: id: google.apigeeregistry.deployments_revision @@ -2277,6 +2258,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/deployments_revision/methods/projects_locations_apis_deployments_delete_revision @@ -2292,17 +2274,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_apis_deployments_get_iam_policy: - operation: &ref_43 + projects_locations_apis_deployments_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1apis~1{apisId}~1deployments~1{deploymentsId}:getIamPolicy/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_apis_deployments_get_iam_policy: - operation: *ref_43 - response: *ref_44 projects_locations_apis_deployments_test_iam_permissions: operation: $ref: >- @@ -2316,6 +2295,9 @@ components: #/components/x-stackQL-resources/deployments_iam_policies/methods/projects_locations_apis_deployments_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/projects_locations_apis_deployments_set_iam_policy delete: [] runtime_iam_policies: id: google.apigeeregistry.runtime_iam_policies @@ -2329,17 +2311,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_runtime_get_iam_policy: - operation: &ref_45 + projects_locations_runtime_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1runtime:getIamPolicy/get - response: &ref_46 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_runtime_get_iam_policy: - operation: *ref_45 - response: *ref_46 projects_locations_runtime_test_iam_permissions: operation: $ref: >- @@ -2353,6 +2332,9 @@ components: #/components/x-stackQL-resources/runtime_iam_policies/methods/projects_locations_runtime_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/runtime_iam_policies/methods/projects_locations_runtime_set_iam_policy delete: [] documents_iam_policies: id: google.apigeeregistry.documents_iam_policies @@ -2366,17 +2348,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_documents_get_iam_policy: - operation: &ref_47 + projects_locations_documents_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:getIamPolicy/get - response: &ref_48 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_documents_get_iam_policy: - operation: *ref_47 - response: *ref_48 projects_locations_documents_test_iam_permissions: operation: $ref: >- @@ -2390,10 +2369,13 @@ components: #/components/x-stackQL-resources/documents_iam_policies/methods/projects_locations_documents_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/documents_iam_policies/methods/projects_locations_documents_set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_49 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2440,7 +2422,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Gets information about a location. operationId: apigeeregistry.projects.locations.get @@ -2468,7 +2450,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2511,7 +2493,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2582,7 +2564,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2629,7 +2611,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_49 + parameters: *ref_1 post: description: Provisions instance resources for the Registry. operationId: apigeeregistry.projects.locations.instances.create @@ -2666,7 +2648,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_49 + parameters: *ref_1 delete: description: Deletes the Registry instance. operationId: apigeeregistry.projects.locations.instances.delete @@ -2730,7 +2712,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2771,7 +2753,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2811,7 +2793,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2854,7 +2836,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching APIs. operationId: apigeeregistry.projects.locations.apis.list @@ -2934,7 +2916,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified API. operationId: apigeeregistry.projects.locations.apis.get @@ -3047,7 +3029,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3088,7 +3070,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3128,7 +3110,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3171,7 +3153,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching versions. operationId: apigeeregistry.projects.locations.apis.versions.list @@ -3261,7 +3243,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified version. operationId: apigeeregistry.projects.locations.apis.versions.get @@ -3389,7 +3371,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3435,7 +3417,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3480,7 +3462,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3528,7 +3510,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching specs. operationId: apigeeregistry.projects.locations.apis.versions.specs.list @@ -3628,7 +3610,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified spec. operationId: apigeeregistry.projects.locations.apis.versions.specs.get @@ -3773,7 +3755,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getContents: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Returns the contents of a specified spec. If specs are stored with GZip @@ -3819,7 +3801,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:tagRevision: - parameters: *ref_49 + parameters: *ref_1 post: description: Adds a tag to a specified revision of a spec. operationId: apigeeregistry.projects.locations.apis.versions.specs.tagRevision @@ -3867,7 +3849,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:listRevisions: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Lists all revisions of a spec. Revisions are returned in descending @@ -3925,7 +3907,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:rollback: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the current revision to a specified prior revision. Note that this @@ -3975,7 +3957,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:deleteRevision: - parameters: *ref_49 + parameters: *ref_1 delete: description: Deletes a revision of a spec. operationId: apigeeregistry.projects.locations.apis.versions.specs.deleteRevision @@ -4018,7 +4000,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4069,7 +4051,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4119,7 +4101,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4172,7 +4154,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching artifacts. operationId: apigeeregistry.projects.locations.apis.versions.specs.artifacts.list @@ -4282,7 +4264,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified artifact. operationId: apigeeregistry.projects.locations.apis.versions.specs.artifacts.get @@ -4428,7 +4410,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getContents: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Returns the contents of a specified artifact. If artifacts are stored @@ -4481,7 +4463,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4538,7 +4520,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4594,7 +4576,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4653,7 +4635,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching artifacts. operationId: apigeeregistry.projects.locations.apis.versions.artifacts.list @@ -4753,7 +4735,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified artifact. operationId: apigeeregistry.projects.locations.apis.versions.artifacts.get @@ -4884,7 +4866,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getContents: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Returns the contents of a specified artifact. If artifacts are stored @@ -4931,7 +4913,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4982,7 +4964,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5032,7 +5014,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5086,7 +5068,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching deployments. operationId: apigeeregistry.projects.locations.apis.deployments.list @@ -5176,7 +5158,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified deployment. operationId: apigeeregistry.projects.locations.apis.deployments.get @@ -5306,7 +5288,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:tagRevision: - parameters: *ref_49 + parameters: *ref_1 post: description: Adds a tag to a specified revision of a deployment. operationId: apigeeregistry.projects.locations.apis.deployments.tagRevision @@ -5349,7 +5331,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:listRevisions: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Lists all revisions of a deployment. Revisions are returned in @@ -5402,7 +5384,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:rollback: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the current revision to a specified prior revision. Note that this @@ -5447,7 +5429,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:deleteRevision: - parameters: *ref_49 + parameters: *ref_1 delete: description: Deletes a revision of a deployment. operationId: apigeeregistry.projects.locations.apis.deployments.deleteRevision @@ -5485,7 +5467,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5531,7 +5513,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5576,7 +5558,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5624,7 +5606,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching artifacts. operationId: apigeeregistry.projects.locations.apis.deployments.artifacts.list @@ -5724,7 +5706,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified artifact. operationId: apigeeregistry.projects.locations.apis.deployments.artifacts.get @@ -5855,7 +5837,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}:getContents: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Returns the contents of a specified artifact. If artifacts are stored @@ -5902,7 +5884,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching artifacts. operationId: apigeeregistry.projects.locations.apis.artifacts.list @@ -5992,7 +5974,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified artifact. operationId: apigeeregistry.projects.locations.apis.artifacts.get @@ -6107,7 +6089,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getContents: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Returns the contents of a specified artifact. If artifacts are stored @@ -6149,7 +6131,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6195,7 +6177,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6240,7 +6222,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6288,7 +6270,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/artifacts: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns matching artifacts. operationId: apigeeregistry.projects.locations.artifacts.list @@ -6368,7 +6350,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}: - parameters: *ref_49 + parameters: *ref_1 get: description: Returns a specified artifact. operationId: apigeeregistry.projects.locations.artifacts.get @@ -6468,7 +6450,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getContents: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Returns the contents of a specified artifact. If artifacts are stored @@ -6505,7 +6487,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6546,7 +6528,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6586,7 +6568,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6629,7 +6611,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/runtime:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6665,7 +6647,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/runtime:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6700,7 +6682,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/runtime:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6738,7 +6720,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/documents:setIamPolicy: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6774,7 +6756,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/documents:getIamPolicy: - parameters: *ref_49 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6809,7 +6791,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/documents:testIamPermissions: - parameters: *ref_49 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml index 68207730..6a9b821d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apikeys.yaml @@ -7,8 +7,8 @@ info: title: API Keys API description: Manages the API keys associated with developer projects. version: v2 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/api-keys/docs servers: @@ -37,123 +37,40 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - V2UndeleteKeyRequest: + V2AndroidKeyRestrictions: + properties: + allowedApplications: + items: + $ref: '#/components/schemas/V2AndroidApplication' + type: array + description: >- + A list of Android applications that are allowed to make API calls + with this key. type: object + id: V2AndroidKeyRestrictions + description: The Android apps that are allowed to use the key. + V2UndeleteKeyRequest: description: Request message for `UndeleteKey` method. id: V2UndeleteKeyRequest properties: {} - Operation: - properties: - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - metadata: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object - id: Operation - V2ListKeysResponse: - id: V2ListKeysResponse - properties: - nextPageToken: - type: string - description: The pagination token for the next page of results. - keys: - description: A list of API keys. - type: array - items: - $ref: '#/components/schemas/V2Key' - description: Response message for `ListKeys` method. type: object V2LookupKeyResponse: - description: Response message for `LookupKey` method. + id: V2LookupKeyResponse properties: - name: - type: string - description: >- - The resource name of the API key. If the API key has been purged, - resource name is empty. parent: description: >- The project that owns the key with the value specified in the request. type: string - id: V2LookupKeyResponse - type: object - V2GetKeyStringResponse: - description: Response message for `GetKeyString` method. - properties: - keyString: - description: An encrypted and signed value of the key. - type: string - id: V2GetKeyStringResponse - type: object - V2ApiTarget: - description: >- - A restriction for a specific service and optionally one or multiple - specific methods. Both fields are case insensitive. - id: V2ApiTarget - type: object - properties: - service: + name: description: >- - The service for this restriction. It should be the canonical service - name, for example: `translate.googleapis.com`. You can use [`gcloud - services list`](/sdk/gcloud/reference/services/list) to get a list - of services that are enabled in the project. + The resource name of the API key. If the API key has been purged, + resource name is empty. type: string - methods: - items: - type: string - type: array - description: >- - Optional. List of one or more methods that can be called. If empty, - all methods for the service are allowed. A wildcard (*) can be used - as the last symbol. Valid examples: - `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` - `TranslateText` `Get*` `translate.googleapis.com.Get*` - V2BrowserKeyRestrictions: + description: Response message for `LookupKey` method. type: object + V2BrowserKeyRestrictions: + description: The HTTP referrers (websites) that are allowed to use the key. properties: allowedReferrers: items: @@ -162,126 +79,224 @@ components: A list of regular expressions for the referrer URLs that are allowed to make API calls with this key. type: array - description: The HTTP referrers (websites) that are allowed to use the key. id: V2BrowserKeyRestrictions - V2IosKeyRestrictions: - description: The iOS apps that are allowed to use the key. type: object - id: V2IosKeyRestrictions + V2AndroidApplication: + description: Identifier of an Android application for key use. + type: object + id: V2AndroidApplication properties: - allowedBundleIds: - items: - type: string - type: array + packageName: + description: The package name of the application. + type: string + sha1Fingerprint: + type: string description: >- - A list of bundle IDs that are allowed when making API calls with - this key. + The SHA1 fingerprint of the application. For example, both sha1 + formats are acceptable : + DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or + DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the + latter. V2Key: + type: object + id: V2Key properties: - updateTime: + name: type: string - format: google-datetime - description: >- - Output only. A timestamp identifying the time this key was last - updated. readOnly: true - deleteTime: - description: >- - Output only. A timestamp when this key was deleted. If the resource - is not deleted, this must be empty. - format: google-datetime - readOnly: true - type: string - displayName: - type: string - description: >- - Human-readable display name of this key that you can modify. The - maximum length is 63 characters. - name: description: >- Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. - type: string - readOnly: true - uid: - description: Output only. Unique id in UUID4 format. + etag: readOnly: true + description: >- + Output only. A checksum computed by the server based on the current + value of the Key resource. This may be sent on update and delete + requests to ensure the client has an up-to-date value before + proceeding. See https://google.aip.dev/154. type: string createTime: type: string + format: google-datetime description: >- Output only. A timestamp identifying the time this key was originally created. readOnly: true - format: google-datetime annotations: - additionalProperties: - type: string + type: object description: >- Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - type: object - etag: + additionalProperties: + type: string + uid: + type: string + description: Output only. Unique id in UUID4 format. readOnly: true + keyString: type: string + readOnly: true description: >- - Output only. A checksum computed by the server based on the current - value of the Key resource. This may be sent on update and delete - requests to ensure the client has an up-to-date value before - proceeding. See https://google.aip.dev/154. + Output only. An encrypted and signed value held by this key. This + field can be accessed only through the `GetKeyString` method. restrictions: description: Key restrictions. $ref: '#/components/schemas/V2Restrictions' - keyString: + displayName: + type: string description: >- - Output only. An encrypted and signed value held by this key. This - field can be accessed only through the `GetKeyString` method. + Human-readable display name of this key that you can modify. The + maximum length is 63 characters. + updateTime: + readOnly: true + type: string + description: >- + Output only. A timestamp identifying the time this key was last + updated. + format: google-datetime + deleteTime: type: string readOnly: true + description: >- + Output only. A timestamp when this key was deleted. If the resource + is not deleted, this must be empty. + format: google-datetime description: The representation of a key managed by the API Keys API. - id: V2Key + V2IosKeyRestrictions: + id: V2IosKeyRestrictions type: object + properties: + allowedBundleIds: + items: + type: string + description: >- + A list of bundle IDs that are allowed when making API calls with + this key. + type: array + description: The iOS apps that are allowed to use the key. V2ServerKeyRestrictions: type: object properties: allowedIps: - type: array + items: + type: string description: >- A list of the caller IP addresses that are allowed to make API calls with this key. - items: - type: string - id: V2ServerKeyRestrictions + type: array description: The IP addresses of callers that are allowed to use the key. - Status: + id: V2ServerKeyRestrictions + Operation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: Operation + properties: + response: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + error: + $ref: '#/components/schemas/Status' + description: >- + The error result of the operation in case of failure or + cancellation. type: object - id: Status + V2Restrictions: + id: V2Restrictions + properties: + serverKeyRestrictions: + description: The IP addresses of callers that are allowed to use the key. + $ref: '#/components/schemas/V2ServerKeyRestrictions' + apiTargets: + type: array + items: + $ref: '#/components/schemas/V2ApiTarget' + description: >- + A restriction for a specific service and optionally one or more + specific methods. Requests are allowed if they match any of these + restrictions. If no restrictions are specified, all targets are + allowed. + iosKeyRestrictions: + $ref: '#/components/schemas/V2IosKeyRestrictions' + description: The iOS apps that are allowed to use the key. + androidKeyRestrictions: + $ref: '#/components/schemas/V2AndroidKeyRestrictions' + description: The Android apps that are allowed to use the key. + browserKeyRestrictions: + description: The HTTP referrers (websites) that are allowed to use the key. + $ref: '#/components/schemas/V2BrowserKeyRestrictions' + description: Describes the restrictions on the key. + type: object + V2GetKeyStringResponse: + id: V2GetKeyStringResponse + type: object + description: Response message for `GetKeyString` method. + properties: + keyString: + type: string + description: An encrypted and signed value of the key. + Status: properties: code: - format: int32 type: integer + format: int32 description: The status code, which should be an enum value of google.rpc.Code. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. details: - type: array items: additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any type: object + type: array description: >- A list of messages that carry the error details. There is a common set of message types for APIs to use. - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -290,91 +305,47 @@ components: details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - V2AndroidApplication: - properties: - packageName: - type: string - description: The package name of the application. - sha1Fingerprint: - description: >- - The SHA1 fingerprint of the application. For example, both sha1 - formats are acceptable : - DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or - DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the - latter. - type: string - description: Identifier of an Android application for key use. - id: V2AndroidApplication type: object - V2AndroidKeyRestrictions: + id: Status + V2ListKeysResponse: properties: - allowedApplications: + nextPageToken: + description: The pagination token for the next page of results. + type: string + keys: items: - $ref: '#/components/schemas/V2AndroidApplication' + $ref: '#/components/schemas/V2Key' type: array - description: >- - A list of Android applications that are allowed to make API calls - with this key. - description: The Android apps that are allowed to use the key. + description: A list of API keys. type: object - id: V2AndroidKeyRestrictions - V2Restrictions: + id: V2ListKeysResponse + description: Response message for `ListKeys` method. + V2ApiTarget: + id: V2ApiTarget properties: - browserKeyRestrictions: - $ref: '#/components/schemas/V2BrowserKeyRestrictions' - description: The HTTP referrers (websites) that are allowed to use the key. - serverKeyRestrictions: - description: The IP addresses of callers that are allowed to use the key. - $ref: '#/components/schemas/V2ServerKeyRestrictions' - androidKeyRestrictions: - $ref: '#/components/schemas/V2AndroidKeyRestrictions' - description: The Android apps that are allowed to use the key. - apiTargets: + service: + type: string description: >- - A restriction for a specific service and optionally one or more - specific methods. Requests are allowed if they match any of these - restrictions. If no restrictions are specified, all targets are - allowed. - type: array + The service for this restriction. It should be the canonical service + name, for example: `translate.googleapis.com`. You can use [`gcloud + services + list`](https://cloud.google.com/sdk/gcloud/reference/services/list) + to get a list of services that are enabled in the project. + methods: items: - $ref: '#/components/schemas/V2ApiTarget' - iosKeyRestrictions: - $ref: '#/components/schemas/V2IosKeyRestrictions' - description: The iOS apps that are allowed to use the key. - id: V2Restrictions + type: string + description: >- + Optional. List of one or more methods that can be called. If empty, + all methods for the service are allowed. A wildcard (*) can be used + as the last symbol. Valid examples: + `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` + `TranslateText` `Get*` `translate.googleapis.com.Get*` + type: array type: object - description: Describes the restrictions on the key. - parameters: - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string + description: >- + A restriction for a specific service and optionally one or multiple + specific methods. Both fields are case insensitive. + parameters: alt: description: Data format for response. in: query @@ -385,22 +356,22 @@ components: - json - media - proto - callback: - description: JSONP - in: query - name: callback - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string uploadType: @@ -409,10 +380,28 @@ components: name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key schema: type: string quotaUser: @@ -424,23 +413,36 @@ components: name: quotaUser schema: type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string x-stackQL-resources: keys: id: google.apikeys.keys name: keys title: Keys methods: - patch: + list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.keys + create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post response: mediaType: application/json openAPIDocKey: '200' @@ -451,24 +453,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + patch: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys/get - response: &ref_2 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1keys~1{keysId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.keys - list: - operation: *ref_1 - response: *ref_2 undelete: operation: $ref: >- @@ -490,6 +488,7 @@ components: - $ref: '#/components/x-stackQL-resources/keys/methods/create' update: - $ref: '#/components/x-stackQL-resources/keys/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/keys/methods/delete' keys_key_string: @@ -510,6 +509,7 @@ components: #/components/x-stackQL-resources/keys_key_string/methods/get_key_string insert: [] update: [] + replace: [] delete: [] operations: id: google.apikeys.operations @@ -527,44 +527,44 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] + replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: - parameters: &ref_3 - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' + /v2/projects/{projectsId}/locations/{locationsId}/keys: + parameters: &ref_1 - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/quotaUser' - patch: + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' + get: description: >- - Patches the modifiable fields of an API key. The key string of the API - key isn't included in the response. NOTE: Key is a global resource; - hence the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2Key' + Lists the API keys owned by a project. The key string of the API key + isn't included in the response. NOTE: Key is a global resource; hence + the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2ListKeysResponse' parameters: - in: path name: projectsId @@ -576,23 +576,29 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: showDeleted schema: - type: string + type: boolean - in: query - name: updateMask + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - format: google-fieldmask - delete: + post: description: >- - Deletes an API key. Deleted key can be retrieved within 30 days of - deletion. Afterward, key will be purged from the project. NOTE: Key is a - global resource; hence the only supported value for location is - `global`. - operationId: apikeys.projects.locations.keys.delete + Creates a new API key. NOTE: Key is a global resource; hence the only + supported value for location is `global`. + operationId: apikeys.projects.locations.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -616,15 +622,12 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - in: query - name: etag + name: keyId schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}: + parameters: *ref_1 get: description: >- Gets the metadata for an API key. The key string of the API key isn't @@ -663,18 +666,13 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys: - parameters: *ref_3 - post: + delete: description: >- - Creates a new API key. NOTE: Key is a global resource; hence the only - supported value for location is `global`. - operationId: apikeys.projects.locations.keys.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2Key' + Deletes an API key. Deleted key can be retrieved within 30 days of + deletion. Afterward, key will be purged from the project. NOTE: Key is a + global resource; hence the only supported value for location is + `global`. + operationId: apikeys.projects.locations.keys.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -698,32 +696,38 @@ paths: required: true schema: type: string + - in: path + name: keysId + required: true + schema: + type: string - in: query - name: keyId + name: etag schema: type: string - get: + patch: description: >- - Lists the API keys owned by a project. The key string of the API key - isn't included in the response. NOTE: Key is a global resource; hence - the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.list + Patches the modifiable fields of an API key. The key string of the API + key isn't included in the response. NOTE: Key is a global resource; + hence the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/V2ListKeysResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -735,42 +739,41 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: showDeleted + - in: path + name: keysId + required: true schema: - type: boolean + type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: - parameters: *ref_3 - get: + format: google-fieldmask + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: + parameters: *ref_1 + post: description: >- - Get the key string for an API key. NOTE: Key is a global resource; hence - the only supported value for location is `global`. - operationId: apikeys.projects.locations.keys.getKeyString + Undeletes an API key which was deleted within 30 days. NOTE: Key is a + global resource; hence the only supported value for location is + `global`. + operationId: apikeys.projects.locations.keys.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/V2UndeleteKeyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/V2GetKeyStringResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -787,31 +790,29 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete: - parameters: *ref_3 - post: + /v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString: + parameters: *ref_1 + get: description: >- - Undeletes an API key which was deleted within 30 days. NOTE: Key is a - global resource; hence the only supported value for location is - `global`. - operationId: apikeys.projects.locations.keys.undelete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/V2UndeleteKeyRequest' + Get the key string for an API key. NOTE: Key is a global resource; hence + the only supported value for location is `global`. + operationId: apikeys.projects.locations.keys.getKeyString security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/V2GetKeyStringResponse' parameters: - in: path name: projectsId @@ -829,7 +830,7 @@ paths: schema: type: string /v2/operations/{operationsId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -859,7 +860,7 @@ paths: schema: type: string /v2/keys:lookupKey: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Find the parent project and resource name of the API key that matches diff --git a/providers/src/googleapis.com/v00.00.00000/services/apim.yaml b/providers/src/googleapis.com/v00.00.00000/services/apim.yaml new file mode 100644 index 00000000..1d285389 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/apim.yaml @@ -0,0 +1,1956 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: API Management API + description: >- + Enables users to discover shadow APIs in existing Google Cloud + infrastructure. + version: v1alpha + x-discovery-doc-revision: '20240731' + x-generated-date: '2024-09-13' +externalDocs: + url: https://cloud.google.com/apigee/ +servers: + - url: https://apim.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + ListOperationsResponse: + id: ListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Operation' + nextPageToken: + description: The standard List next-page token. + type: string + Operation: + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Status: + id: Status + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ObservationSource: + id: ObservationSource + description: Observation source configuration types + type: object + properties: + gclbObservationSource: + description: The GCLB observation source + $ref: '#/components/schemas/GclbObservationSource' + name: + description: >- + Identifier. name of resource For MVP, each region can only have 1 + source. + type: string + state: + description: Output only. The observation source state + readOnly: true + type: string + enumDescriptions: + - Unspecified state + - Source is in the creating state + - Source has been created and is ready to use + - Source is being deleted + - Source is in an error state + enum: + - STATE_UNSPECIFIED + - CREATING + - CREATED + - DELETING + - ERROR + createTime: + description: Output only. [Output only] Create time stamp + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. [Output only] Update time stamp + readOnly: true + type: string + format: google-datetime + GclbObservationSource: + id: GclbObservationSource + description: The GCLB observation source. + type: object + properties: + pscNetworkConfigs: + description: >- + Required. The VPC networks where traffic will be observed. All load + balancers within this network will be observed. Currently, this is + limited to only one network. + type: array + items: + $ref: '#/components/schemas/GclbObservationSourcePscNetworkConfig' + GclbObservationSourcePscNetworkConfig: + id: GclbObservationSourcePscNetworkConfig + description: Network information for setting up a PSC connection. + type: object + properties: + network: + description: >- + Required. The VPC network. Format: + `projects/{project_id}/global/networks/{network}` + type: string + subnetwork: + description: >- + Required. The subnetwork in the source region that will be used to + connect to the Cloud Load Balancers via PSC NEGs. Must belong to + `network`. Format: + projects/{project_id}/regions/{region}/subnetworks/{subnet} + type: string + ListObservationSourcesResponse: + id: ListObservationSourcesResponse + description: Message for response to listing ObservationSources + type: object + properties: + observationSources: + description: The ObservationSource from the specified project and location. + type: array + items: + $ref: '#/components/schemas/ObservationSource' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + ObservationJob: + id: ObservationJob + description: Message describing ObservationJob object + type: object + properties: + name: + description: >- + Identifier. name of resource Format: + projects/{project}/locations/{location}/observationJobs/{observation_job} + type: string + state: + description: Output only. The observation job state + readOnly: true + type: string + enumDescriptions: + - Unspecified state + - Job is in the creating state + - Job is in the enabling state + - Job is enabled + - Job is in the disabling state + - Job is disabled + - Job is being deleted + - Job is in an error state + enum: + - STATE_UNSPECIFIED + - CREATING + - ENABLING + - ENABLED + - DISABLING + - DISABLED + - DELETING + - ERROR + sources: + description: Optional. These should be of the same kind of source. + type: array + items: + type: string + createTime: + description: Output only. [Output only] Create time stamp + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. [Output only] Update time stamp + readOnly: true + type: string + format: google-datetime + ListObservationJobsResponse: + id: ListObservationJobsResponse + description: Message for response to listing ObservationJobs + type: object + properties: + observationJobs: + description: The ObservationJob from the specified project and location. + type: array + items: + $ref: '#/components/schemas/ObservationJob' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + EnableObservationJobRequest: + id: EnableObservationJobRequest + description: Message for enabling an ObservationJob + type: object + properties: {} + DisableObservationJobRequest: + id: DisableObservationJobRequest + description: Message for disabling an ObservationJob + type: object + properties: {} + ApiObservation: + id: ApiObservation + description: Message describing ApiObservation object + type: object + properties: + name: + description: Identifier. Name of resource + type: string + style: + description: Style of ApiObservation + type: string + enumDescriptions: + - Unknown style + - Style is Rest API + - Style is Grpc API + - Style is GraphQL API + enum: + - STYLE_UNSPECIFIED + - REST + - GRPC + - GRAPHQL + serverIps: + description: >- + The IP address (IPv4 or IPv6) of the origin server that the request + was sent to. This field can include port information. Examples: + `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`. + type: array + items: + type: string + hostname: + description: The hostname of requests processed for this Observation. + type: string + sourceLocations: + description: >- + Location of the Observation Source, for example "us-central1" or + "europe-west1." + type: array + items: + type: string + tags: + description: User-defined tags to organize and sort + type: array + items: + type: string + apiOperationCount: + description: The number of observed API Operations. + type: string + format: int64 + createTime: + description: Create time stamp + type: string + format: google-datetime + updateTime: + description: Update time stamp + type: string + format: google-datetime + lastEventDetectedTime: + description: Last event detected time stamp + type: string + format: google-datetime + ListApiObservationsResponse: + id: ListApiObservationsResponse + description: Message for response to listing ApiObservations + type: object + properties: + apiObservations: + description: >- + The ApiObservation from the specified project and location and + ObservationJobs. + type: array + items: + $ref: '#/components/schemas/ApiObservation' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + ApiOperation: + id: ApiOperation + description: Message describing ApiOperation object + type: object + properties: + httpOperation: + description: An HTTP Operation. + $ref: '#/components/schemas/HttpOperation' + name: + description: Identifier. Name of resource + type: string + firstSeenTime: + description: First seen time stamp + type: string + format: google-datetime + lastSeenTime: + description: Last seen time stamp + type: string + format: google-datetime + count: + description: The number of occurrences of this API Operation. + type: string + format: int64 + HttpOperation: + id: HttpOperation + description: An HTTP-based API Operation, sometimes called a "REST" Operation. + type: object + properties: + path: + description: Path of the HTTP request. + type: string + pathParams: + description: Path params of HttpOperation + type: array + items: + $ref: '#/components/schemas/HttpOperationPathParam' + queryParams: + description: Query params of HttpOperation + type: object + additionalProperties: + $ref: '#/components/schemas/HttpOperationQueryParam' + method: + description: HTTP Method. + type: string + enumDescriptions: + - Unspecified HTTP method + - GET HTTP method + - HEAD HTTP method + - POST HTTP method + - PUT HTTP method + - PATCH HTTP method + - DELETE HTTP method + - TRACE HTTP method + - OPTIONS HTTP method + - CONNECT HTTP method + enum: + - HTTP_METHOD_UNSPECIFIED + - GET + - HEAD + - POST + - PUT + - PATCH + - DELETE + - TRACE + - OPTIONS + - CONNECT + request: + description: Request metadata. + $ref: '#/components/schemas/HttpOperationHttpRequest' + response: + description: Response metadata. + $ref: '#/components/schemas/HttpOperationHttpResponse' + HttpOperationPathParam: + id: HttpOperationPathParam + description: HTTP Path parameter. + type: object + properties: + position: + description: Segment location in the path, 1-indexed + type: integer + format: int32 + dataType: + description: Data type of path param + type: string + enumDescriptions: + - Unspecified data type + - Boolean data type + - Integer data type + - Float data type + - String data type + - UUID data type + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - INTEGER + - FLOAT + - STRING + - UUID + HttpOperationQueryParam: + id: HttpOperationQueryParam + description: An aggregation of HTTP query parameter occurrences. + type: object + properties: + name: + description: Name of query param + type: string + count: + description: >- + The number of occurrences of this query parameter across + transactions. + type: string + format: int64 + dataType: + description: Data type of path param + type: string + enumDescriptions: + - Unspecified data type + - Boolean data type + - Integer data type + - Float data type + - String data type + - UUID data type + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - INTEGER + - FLOAT + - STRING + - UUID + HttpOperationHttpRequest: + id: HttpOperationHttpRequest + description: An aggregation of HTTP requests. + type: object + properties: + headers: + description: Unordered map from header name to header metadata + type: object + additionalProperties: + $ref: '#/components/schemas/HttpOperationHeader' + HttpOperationHeader: + id: HttpOperationHeader + description: An aggregation of HTTP header occurrences. + type: object + properties: + name: + description: Header name. + type: string + count: + description: The number of occurrences of this Header across transactions. + type: string + format: int64 + dataType: + description: Data type of header + type: string + enumDescriptions: + - Unspecified data type + - Boolean data type + - Integer data type + - Float data type + - String data type + - UUID data type + enum: + - DATA_TYPE_UNSPECIFIED + - BOOL + - INTEGER + - FLOAT + - STRING + - UUID + HttpOperationHttpResponse: + id: HttpOperationHttpResponse + description: An aggregation of HTTP responses. + type: object + properties: + headers: + description: Unordered map from header name to header metadata + type: object + additionalProperties: + $ref: '#/components/schemas/HttpOperationHeader' + responseCodes: + description: Map of status code to observed count + type: object + additionalProperties: + type: string + format: int64 + ListApiOperationsResponse: + id: ListApiOperationsResponse + description: Message for response to listing ApiOperations + type: object + properties: + apiOperations: + description: >- + The ApiOperations from the specified project and location and + ObservationJob and ApiObservation. + type: array + items: + $ref: '#/components/schemas/ApiOperation' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + BatchEditTagsApiObservationsRequest: + id: BatchEditTagsApiObservationsRequest + description: Message for requesting batch edit tags for ApiObservations + type: object + properties: + requests: + description: >- + Required. The request message specifying the resources to update. A + maximum of 1000 apiObservations can be modified in a batch. + type: array + items: + $ref: '#/components/schemas/EditTagsApiObservationsRequest' + EditTagsApiObservationsRequest: + id: EditTagsApiObservationsRequest + description: Message for requesting edit tags for ApiObservation + type: object + properties: + apiObservationId: + description: >- + Required. Identifier of ApiObservation need to be edit tags Format + example: "apigee.googleapis.com|us-west1|443" + type: string + tagActions: + description: Required. Tag actions to be applied + type: array + items: + $ref: '#/components/schemas/TagAction' + TagAction: + id: TagAction + description: Message for edit tag action + type: object + properties: + tag: + description: Required. Tag to be added or removed + type: string + action: + description: Required. Action to be applied + type: string + enumDescriptions: + - Unspecified. + - Addition of a Tag. + - Removal of a Tag. + enum: + - ACTION_UNSPECIFIED + - ADD + - REMOVE + BatchEditTagsApiObservationsResponse: + id: BatchEditTagsApiObservationsResponse + description: Message for response to edit Tags for ApiObservations + type: object + properties: + apiObservations: + description: ApiObservations that were changed + type: array + items: + $ref: '#/components/schemas/ApiObservation' + ListApiObservationTagsResponse: + id: ListApiObservationTagsResponse + description: Message for response to listing tags + type: object + properties: + apiObservationTags: + description: The tags from the specified project + type: array + items: + type: string + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + api_observation_tags: + id: google.apim.api_observation_tags + name: api_observation_tags + title: Api_observation_tags + methods: + list_api_observation_tags: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}:listApiObservationTags/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.apiObservationTags + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_observation_tags/methods/list_api_observation_tags + insert: [] + update: [] + replace: [] + delete: [] + locations: + id: google.apim.locations + name: locations + title: Locations + methods: + list: + operation: + $ref: '#/paths/~1v1alpha~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.apim.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + observation_sources: + id: google.apim.observation_sources + name: observation_sources + title: Observation_sources + methods: + create: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationSources/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationSources/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.observationSources + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationSources~1{observationSourcesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationSources~1{observationSourcesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/observation_sources/methods/get' + - $ref: '#/components/x-stackQL-resources/observation_sources/methods/list' + insert: + - $ref: >- + #/components/x-stackQL-resources/observation_sources/methods/create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/observation_sources/methods/delete + observation_jobs: + id: google.apim.observation_jobs + name: observation_jobs + title: Observation_jobs + methods: + create: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.observationJobs + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}:enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/observation_jobs/methods/get' + - $ref: '#/components/x-stackQL-resources/observation_jobs/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/observation_jobs/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/observation_jobs/methods/delete' + api_observations: + id: google.apim.api_observations + name: api_observations + title: Api_observations + methods: + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}~1apiObservations~1{apiObservationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}~1apiObservations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.apiObservations + batch_edit_tags: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}~1apiObservations:batchEditTags/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/api_observations/methods/get' + - $ref: '#/components/x-stackQL-resources/api_observations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + api_operations: + id: google.apim.api_operations + name: api_operations + title: Api_operations + methods: + get: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}~1apiObservations~1{apiObservationsId}~1apiOperations~1{apiOperationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1alpha~1projects~1{projectsId}~1locations~1{locationsId}~1observationJobs~1{observationJobsId}~1apiObservations~1{apiObservationsId}~1apiOperations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.apiOperations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/api_operations/methods/get' + - $ref: '#/components/x-stackQL-resources/api_operations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1alpha/projects/{projectsId}/locations/{locationsId}:listApiObservationTags: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + ListApiObservationTags lists all extant tags on any observation in the + given project. + operationId: apim.projects.locations.listApiObservationTags + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListApiObservationTagsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: apim.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: apim.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: apim.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: apim.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: apim.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: apim.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources: + parameters: *ref_1 + post: + description: >- + CreateObservationSource creates a new ObservationSource but does not + affect any deployed infrastructure. It is a configuration that can be + used in an Observation Job to collect data about APIs running in user's + dataplane. + operationId: apim.projects.locations.observationSources.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObservationSource' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: observationSourceId + schema: + type: string + - in: query + name: requestId + schema: + type: string + get: + description: >- + ListObservationSources gets all ObservationSources for a given project + and location. + operationId: apim.projects.locations.observationSources.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListObservationSourcesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources/{observationSourcesId}: + parameters: *ref_1 + get: + description: GetObservationSource retrieves a single ObservationSource by name. + operationId: apim.projects.locations.observationSources.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ObservationSource' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationSourcesId + required: true + schema: + type: string + delete: + description: >- + DeleteObservationSource deletes an observation source. This method will + fail if the observation source is currently being used by any + ObservationJob, even if not enabled. + operationId: apim.projects.locations.observationSources.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationSourcesId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs: + parameters: *ref_1 + post: + description: >- + CreateObservationJob creates a new ObservationJob but does not have any + effecton its own. It is a configuration that can be used in an + Observation Job to collect data about existing APIs. + operationId: apim.projects.locations.observationJobs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObservationJob' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: observationJobId + schema: + type: string + - in: query + name: requestId + schema: + type: string + get: + description: >- + ListObservationJobs gets all ObservationJobs for a given project and + location. + operationId: apim.projects.locations.observationJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListObservationJobsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}: + parameters: *ref_1 + get: + description: GetObservationJob retrieves a single ObservationJob by name. + operationId: apim.projects.locations.observationJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ObservationJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + delete: + description: >- + DeleteObservationJob deletes an ObservationJob. This method will fail if + the observation job is currently being used by any ObservationSource, + even if not enabled. + operationId: apim.projects.locations.observationJobs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}:enable: + parameters: *ref_1 + post: + description: Enables the given ObservationJob. + operationId: apim.projects.locations.observationJobs.enable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableObservationJobRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}:disable: + parameters: *ref_1 + post: + description: Disables the given ObservationJob. + operationId: apim.projects.locations.observationJobs.disable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableObservationJobRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}: + parameters: *ref_1 + get: + description: GetApiObservation retrieves a single ApiObservation by name. + operationId: apim.projects.locations.observationJobs.apiObservations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ApiObservation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + - in: path + name: apiObservationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations: + parameters: *ref_1 + get: + description: >- + ListApiObservations gets all ApiObservations for a given project and + location and ObservationJob. + operationId: apim.projects.locations.observationJobs.apiObservations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListApiObservationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations:batchEditTags: + parameters: *ref_1 + post: + description: BatchEditTagsApiObservations adds or removes Tags for ApiObservations. + operationId: apim.projects.locations.observationJobs.apiObservations.batchEditTags + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchEditTagsApiObservationsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BatchEditTagsApiObservationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations/{apiOperationsId}: + parameters: *ref_1 + get: + description: GetApiOperation retrieves a single ApiOperation by name. + operationId: >- + apim.projects.locations.observationJobs.apiObservations.apiOperations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ApiOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + - in: path + name: apiObservationsId + required: true + schema: + type: string + - in: path + name: apiOperationsId + required: true + schema: + type: string + /v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations: + parameters: *ref_1 + get: + description: >- + ListApiOperations gets all ApiOperations for a given project and + location and ObservationJob and ApiObservation. + operationId: >- + apim.projects.locations.observationJobs.apiObservations.apiOperations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListApiOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: observationJobsId + required: true + schema: + type: string + - in: path + name: apiObservationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml index 81b9a544..2f0ebb3f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/appengine.yaml @@ -7,8 +7,8 @@ info: title: App Engine Admin API description: Provisions and manages developers' App Engine applications. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/appengine/docs/admin-api/ servers: @@ -464,13 +464,15 @@ components: properties: name: description: >- - Full path to the Service resource in the API. Example: + Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + readOnly: true type: string id: description: >- - Relative name of the service within the application. Example: - default.@OutputOnly + Output only. Relative name of the service within the application. + Example: default.@OutputOnly + readOnly: true type: string split: description: >- @@ -595,8 +597,9 @@ components: properties: name: description: >- - Full path to the Version resource in the API. Example: + Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + readOnly: true type: string id: description: >- @@ -732,7 +735,10 @@ components: - SERVING - STOPPED createdBy: - description: Email address of the user who created this version.@OutputOnly + description: >- + Output only. Email address of the user who created this + version.@OutputOnly + readOnly: true type: string createTime: description: Time that this version was created.@OutputOnly @@ -740,8 +746,10 @@ components: format: google-datetime diskUsageBytes: description: >- - Total size in bytes of all the files that are included in this - version and currently hosted on the App Engine disk.@OutputOnly + Output only. Total size in bytes of all the files that are included + in this version and currently hosted on the App Engine + disk.@OutputOnly + readOnly: true type: string format: int64 runtimeApiVersion: @@ -842,8 +850,9 @@ components: $ref: '#/components/schemas/Deployment' versionUrl: description: >- - Serving URL for this version. Example: + Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + readOnly: true type: string endpointsApiService: description: >- @@ -2694,6 +2703,31 @@ components: - 'ON' - 'OFF' - DELETED + gceTag: + description: >- + The GCE tags associated with the consumer project and those + inherited due to their ancestry, if any. Not supported by CCFE. + type: array + items: + $ref: '#/components/schemas/GceTag' + GceTag: + id: GceTag + description: >- + For use only by GCE. GceTag is a wrapper around the GCE administrative + tag with parent info. + type: object + properties: + tag: + description: The administrative_tag name. + type: string + parent: + description: >- + The parents(s) of the tag. Eg. projects/123, folders/456 It usually + contains only one parent. But, in some corner cases, it can contain + multiple parents. Currently, organizations are not supported. + type: array + items: + type: string ContainerState: id: ContainerState description: >- @@ -3035,44 +3069,40 @@ components: - $ref: '#/components/x-stackQL-resources/apps/methods/create' update: - $ref: '#/components/x-stackQL-resources/apps/methods/patch' + replace: [] delete: [] apps_runtimes: id: google.appengine.apps_runtimes name: apps_runtimes title: Apps_runtimes methods: - _list_runtimes: - operation: &ref_1 + list_runtimes: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}:listRuntimes/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.runtimes - list_runtimes: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/apps_runtimes/methods/list_runtimes insert: [] update: [] + replace: [] delete: [] operations: id: google.appengine.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1operations/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1operations~1{operationsId}/get' @@ -3085,22 +3115,20 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] services: id: google.appengine.services name: services title: Services methods: - _list: - operation: &ref_5 + list: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1services/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1services~1{servicesId}/get' @@ -3126,6 +3154,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/services/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' versions: @@ -3133,16 +3162,13 @@ components: name: versions title: Versions methods: - _list: - operation: &ref_7 + list: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1services~1{servicesId}~1versions/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.versions - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -3179,6 +3205,7 @@ components: - $ref: '#/components/x-stackQL-resources/versions/methods/create' update: - $ref: '#/components/x-stackQL-resources/versions/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/versions/methods/delete' instances: @@ -3186,17 +3213,14 @@ components: name: instances title: Instances methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1apps~1{appsId}~1services~1{servicesId}~1versions~1{versionsId}~1instances/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -3224,6 +3248,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' ingress_rules: @@ -3231,16 +3256,13 @@ components: name: ingress_rules title: Ingress_rules methods: - _list: - operation: &ref_11 + list: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1firewall~1ingressRules/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.ingressRules - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1firewall~1ingressRules/post' @@ -3283,6 +3305,9 @@ components: - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/create' update: - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/ingress_rules/methods/batch_update + replace: [] delete: - $ref: '#/components/x-stackQL-resources/ingress_rules/methods/delete' authorized_domains: @@ -3290,39 +3315,33 @@ components: name: authorized_domains title: Authorized_domains methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1authorizedDomains/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.domains - list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/authorized_domains/methods/list' - - $ref: '#/components/x-stackQL-resources/authorized_domains/methods/list' insert: [] update: [] + replace: [] delete: [] authorized_certificates: id: google.appengine.authorized_certificates name: authorized_certificates title: Authorized_certificates methods: - _list: - operation: &ref_15 + list: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1authorizedCertificates/get' - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1authorizedCertificates/post' @@ -3362,6 +3381,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/authorized_certificates/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/authorized_certificates/methods/delete @@ -3370,16 +3390,13 @@ components: name: domain_mappings title: Domain_mappings methods: - _list: - operation: &ref_17 + list: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1domainMappings/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.domainMappings - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1domainMappings/post' @@ -3415,6 +3432,7 @@ components: - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/create' update: - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/domain_mappings/methods/delete' locations: @@ -3422,16 +3440,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_19 + list: + operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1locations/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_19 - response: *ref_20 get: operation: $ref: '#/paths/~1v1~1apps~1{appsId}~1locations~1{locationsId}/get' @@ -3444,10 +3459,11 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/apps/{appsId}: - parameters: &ref_21 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3529,7 +3545,7 @@ paths: type: string format: google-fieldmask /v1/apps: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Creates an App Engine application for a Google Cloud Platform project. @@ -3559,7 +3575,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: [] /v1/apps/{appsId}:repair: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Recreates the required App Engine features for the specified App Engine @@ -3597,7 +3613,7 @@ paths: schema: type: string /v1/apps/{appsId}:listRuntimes: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists all the available runtimes for the application. operationId: appengine.apps.listRuntimes @@ -3632,7 +3648,7 @@ paths: schema: type: string /v1/apps/{appsId}/operations: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3678,7 +3694,7 @@ paths: schema: type: string /v1/apps/{appsId}/operations/{operationsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3717,7 +3733,7 @@ paths: schema: type: string /v1/apps/{appsId}/services: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists all the services in the application. operationId: appengine.apps.services.list @@ -3757,7 +3773,7 @@ paths: schema: type: string /v1/apps/{appsId}/services/{servicesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets the current configuration of the specified service. operationId: appengine.apps.services.get @@ -3859,7 +3875,7 @@ paths: schema: type: string /v1/apps/{appsId}/services/{servicesId}/versions: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists the versions of a service. operationId: appengine.apps.services.versions.list @@ -3939,7 +3955,7 @@ paths: schema: type: string /v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Gets the specified Version resource. By default, only a BASIC_VIEW will @@ -4092,7 +4108,7 @@ paths: schema: type: string /v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Lists the instances of a version.Tip: To aggregate details about @@ -4145,7 +4161,7 @@ paths: schema: type: string /v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets instance information. operationId: appengine.apps.services.versions.instances.get @@ -4238,7 +4254,7 @@ paths: schema: type: string /v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Enables debugging on a VM instance. This allows you to use the SSH @@ -4288,7 +4304,7 @@ paths: schema: type: string /v1/apps/{appsId}/firewall/ingressRules: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists the firewall rules of an application. operationId: appengine.apps.firewall.ingressRules.list @@ -4358,7 +4374,7 @@ paths: schema: type: string /v1/apps/{appsId}/firewall/ingressRules:batchUpdate: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Replaces the entire firewall ruleset in one bulk operation. This @@ -4391,7 +4407,7 @@ paths: schema: type: string /v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets the specified firewall rule. operationId: appengine.apps.firewall.ingressRules.get @@ -4489,7 +4505,7 @@ paths: schema: type: string /v1/apps/{appsId}/authorizedDomains: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists all domains the user is authorized to administer. operationId: appengine.apps.authorizedDomains.list @@ -4529,7 +4545,7 @@ paths: schema: type: string /v1/apps/{appsId}/authorizedCertificates: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists all SSL certificates the user is authorized to administer. operationId: appengine.apps.authorizedCertificates.list @@ -4599,7 +4615,7 @@ paths: schema: type: string /v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets the specified SSL certificate. operationId: appengine.apps.authorizedCertificates.get @@ -4706,7 +4722,7 @@ paths: schema: type: string /v1/apps/{appsId}/domainMappings: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists the domain mappings on an application. operationId: appengine.apps.domainMappings.list @@ -4779,7 +4795,7 @@ paths: schema: type: string /v1/apps/{appsId}/domainMappings/{domainMappingsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets the specified domain mapping. operationId: appengine.apps.domainMappings.get @@ -4884,7 +4900,7 @@ paths: schema: type: string /v1/apps/{appsId}/locations: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: appengine.apps.locations.list @@ -4928,7 +4944,7 @@ paths: schema: type: string /v1/apps/{appsId}/locations/{locationsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets information about a location. operationId: appengine.apps.locations.get @@ -4964,7 +4980,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists all domains the user is authorized to administer. operationId: appengine.projects.locations.applications.authorizedDomains.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml b/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml index 48186775..14a1d4ef 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/apphub.yaml @@ -7,8 +7,8 @@ info: title: App Hub API description: '' version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240814' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/app-hub/docs/ servers: @@ -1321,16 +1321,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1343,23 +1340,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.apphub.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1387,6 +1382,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' service_project_attachments: @@ -1394,17 +1390,14 @@ components: name: service_project_attachments title: Service_project_attachments methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceProjectAttachments/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceProjectAttachments - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1436,6 +1429,7 @@ components: - $ref: >- #/components/x-stackQL-resources/service_project_attachments/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/service_project_attachments/methods/delete @@ -1444,17 +1438,14 @@ components: name: discovered_services title: Discovered_services methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveredServices/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.discoveredServices - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -1475,23 +1466,21 @@ components: - $ref: '#/components/x-stackQL-resources/discovered_services/methods/list' insert: [] update: [] + replace: [] delete: [] discovered_workloads: id: google.apphub.discovered_workloads name: discovered_workloads title: Discovered_workloads methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveredWorkloads/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.discoveredWorkloads - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -1512,23 +1501,21 @@ components: - $ref: '#/components/x-stackQL-resources/discovered_workloads/methods/list' insert: [] update: [] + replace: [] delete: [] applications: id: google.apphub.applications name: applications title: Applications methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.applications - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -1565,6 +1552,7 @@ components: - $ref: '#/components/x-stackQL-resources/applications/methods/create' update: - $ref: '#/components/x-stackQL-resources/applications/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/applications/methods/delete' applications_iam_policies: @@ -1579,17 +1567,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_13 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}:getIamPolicy/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_13 - response: *ref_14 test_iam_permissions: operation: $ref: >- @@ -1603,23 +1588,23 @@ components: #/components/x-stackQL-resources/applications_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/applications_iam_policies/methods/set_iam_policy delete: [] services: id: google.apphub.services name: services title: Services methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1services/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -1656,6 +1641,7 @@ components: - $ref: '#/components/x-stackQL-resources/services/methods/create' update: - $ref: '#/components/x-stackQL-resources/services/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' workloads: @@ -1663,17 +1649,14 @@ components: name: workloads title: Workloads methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1applications~1{applicationsId}~1workloads/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloads - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: >- @@ -1710,11 +1693,12 @@ components: - $ref: '#/components/x-stackQL-resources/workloads/methods/create' update: - $ref: '#/components/x-stackQL-resources/workloads/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/workloads/methods/delete' paths: /v1/projects/{projectsId}/locations/{locationsId}:lookupServiceProjectAttachment: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1756,7 +1740,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}:detachServiceProjectAttachment: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Detaches a service project from a host project. You can call this API @@ -1792,7 +1776,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: apphub.projects.locations.list @@ -1828,7 +1812,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets information about a location. operationId: apphub.projects.locations.get @@ -1856,7 +1840,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1899,7 +1883,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1970,7 +1954,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2017,7 +2001,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists service projects attached to the host project. operationId: apphub.projects.locations.serviceProjectAttachments.list @@ -2101,7 +2085,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceProjectAttachments/{serviceProjectAttachmentsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets a service project attachment. operationId: apphub.projects.locations.serviceProjectAttachments.get @@ -2169,7 +2153,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveredServices: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists Discovered Services that can be added to an Application in a host @@ -2216,7 +2200,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveredServices/{discoveredServicesId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets a Discovered Service in a host project and location. operationId: apphub.projects.locations.discoveredServices.get @@ -2249,7 +2233,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveredServices:lookup: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists a Discovered Service in a host project and location, with a given @@ -2283,7 +2267,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists Discovered Workloads that can be added to an Application in a host @@ -2330,7 +2314,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads/{discoveredWorkloadsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets a Discovered Workload in a host project and location. operationId: apphub.projects.locations.discoveredWorkloads.get @@ -2363,7 +2347,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveredWorkloads:lookup: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists a Discovered Workload in a host project and location, with a given @@ -2397,7 +2381,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists Applications in a host project and location. operationId: apphub.projects.locations.applications.list @@ -2481,7 +2465,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets an Application in a host project and location. operationId: apphub.projects.locations.applications.get @@ -2594,7 +2578,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2635,7 +2619,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2675,7 +2659,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2718,7 +2702,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists Services in an Application. operationId: apphub.projects.locations.applications.services.list @@ -2812,7 +2796,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets a Service in an Application. operationId: apphub.projects.locations.applications.services.get @@ -2940,7 +2924,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists Workloads in an Application. operationId: apphub.projects.locations.applications.workloads.list @@ -3034,7 +3018,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/workloads/{workloadsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets a Workload in an Application. operationId: apphub.projects.locations.applications.workloads.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml b/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml index 6e0dd37a..26e3fd39 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/artifactregistry.yaml @@ -9,8 +9,8 @@ info: Store and manage build artifacts in a scalable and integrated service built on Google infrastructure. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240903' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/artifacts/docs/ servers: @@ -460,10 +460,10 @@ components: packageId: description: >- The ID of the package of the generic artifact. If the package does - not exist, a new package will be created. The `package_id` must - start with a letter, end with a letter or number, only contain - letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot - exceed 256 characters. + not exist, a new package will be created. The `package_id` should + start and end with a letter or number, only contain letters, + numbers, hyphens, underscores, and periods, and not exceed 256 + characters. type: string versionId: description: >- @@ -786,6 +786,12 @@ components: yumRepository: description: Specific settings for a Yum remote repository. $ref: '#/components/schemas/YumRepository' + commonRepository: + description: >- + Common remote repository settings. Used as the RR upstream URL + instead of Predefined and Custom remote repositories. UI and Gcloud + will map all the new remote repositories to this field. + $ref: '#/components/schemas/CommonRemoteRepository' description: description: The description of the remote source. type: string @@ -1032,6 +1038,14 @@ components: An http/https uri reference to the upstream remote repository, for ex: "https://my.yum.registry/". type: string + CommonRemoteRepository: + id: CommonRemoteRepository + description: Common remote repository settings type. + type: object + properties: + uri: + description: Required. A common public repository base for Remote Repository. + type: string UpstreamCredentials: id: UpstreamCredentials description: The credentials to access the remote repository. @@ -1667,18 +1681,29 @@ components: Redirection is enabled, and has been finalized so cannot be reverted. - Redirection is enabled and missing images are copied from GCR + - >- + Redirection is partially enabled and missing images are copied + from GCR enumDeprecated: - false - false - false - true - false + - false enum: - REDIRECTION_STATE_UNSPECIFIED - REDIRECTION_FROM_GCR_IO_DISABLED - REDIRECTION_FROM_GCR_IO_ENABLED - REDIRECTION_FROM_GCR_IO_FINALIZED - REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING + - REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING + pullPercent: + description: >- + The percentage of pull traffic to redirect from GCR to AR when using + partial redirection. + type: integer + format: int32 VPCSCConfig: id: VPCSCConfig description: The Artifact Registry VPC SC config that apply to a Project. @@ -2088,6 +2113,11 @@ components: type: array items: type: string + PromoteArtifactMetadata: + id: PromoteArtifactMetadata + description: The metadata for promote artifact long running operation. + type: object + properties: {} parameters: access_token: description: OAuth access token. @@ -2191,7 +2221,10 @@ components: - $ref: >- #/components/x-stackQL-resources/project_settings/methods/get_project_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/project_settings/methods/update_project_settings + replace: [] delete: [] vpcsc_config: id: google.artifactregistry.vpcsc_config @@ -2217,23 +2250,23 @@ components: - $ref: >- #/components/x-stackQL-resources/vpcsc_config/methods/get_vpcsc_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/vpcsc_config/methods/update_vpcsc_config + replace: [] delete: [] locations: id: google.artifactregistry.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2246,6 +2279,7 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.artifactregistry.operations @@ -2264,23 +2298,21 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] + replace: [] delete: [] repositories: id: google.artifactregistry.repositories name: repositories title: Repositories methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.repositories - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: >- @@ -2317,6 +2349,7 @@ components: - $ref: '#/components/x-stackQL-resources/repositories/methods/create' update: - $ref: '#/components/x-stackQL-resources/repositories/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/repositories/methods/delete' repositories_iam_policies: @@ -2331,17 +2364,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: >- @@ -2355,23 +2385,23 @@ components: #/components/x-stackQL-resources/repositories_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/repositories_iam_policies/methods/set_iam_policy delete: [] docker_images: id: google.artifactregistry.docker_images name: docker_images title: Docker_images methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1dockerImages/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dockerImages - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -2385,23 +2415,21 @@ components: - $ref: '#/components/x-stackQL-resources/docker_images/methods/list' insert: [] update: [] + replace: [] delete: [] maven_artifacts: id: google.artifactregistry.maven_artifacts name: maven_artifacts title: Maven_artifacts methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1mavenArtifacts/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.mavenArtifacts - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -2415,23 +2443,21 @@ components: - $ref: '#/components/x-stackQL-resources/maven_artifacts/methods/list' insert: [] update: [] + replace: [] delete: [] npm_packages: id: google.artifactregistry.npm_packages name: npm_packages title: Npm_packages methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1npmPackages/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.npmPackages - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -2445,23 +2471,21 @@ components: - $ref: '#/components/x-stackQL-resources/npm_packages/methods/list' insert: [] update: [] + replace: [] delete: [] python_packages: id: google.artifactregistry.python_packages name: python_packages title: Python_packages methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1pythonPackages/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.pythonPackages - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -2475,6 +2499,7 @@ components: - $ref: '#/components/x-stackQL-resources/python_packages/methods/list' insert: [] update: [] + replace: [] delete: [] apt_artifacts: id: google.artifactregistry.apt_artifacts @@ -2499,6 +2524,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] yum_artifacts: id: google.artifactregistry.yum_artifacts @@ -2523,6 +2549,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] googet_artifacts: id: google.artifactregistry.googet_artifacts @@ -2547,6 +2574,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] generic_artifacts: id: google.artifactregistry.generic_artifacts @@ -2564,6 +2592,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] kfp_artifacts: id: google.artifactregistry.kfp_artifacts @@ -2581,6 +2610,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] go_modules: id: google.artifactregistry.go_modules @@ -2598,23 +2628,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] packages: id: google.artifactregistry.packages name: packages title: Packages methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1packages/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.packages - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -2643,6 +2671,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/packages/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/packages/methods/delete' versions: @@ -2650,17 +2679,14 @@ components: name: versions title: Versions methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1packages~1{packagesId}~1versions/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.versions - list: - operation: *ref_17 - response: *ref_18 get: operation: $ref: >- @@ -2688,24 +2714,23 @@ components: - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/versions/methods/delete' + - $ref: '#/components/x-stackQL-resources/versions/methods/batch_delete' tags: id: google.artifactregistry.tags name: tags title: Tags methods: - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1packages~1{packagesId}~1tags/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tags - list: - operation: *ref_19 - response: *ref_20 create: operation: $ref: >- @@ -2742,6 +2767,7 @@ components: - $ref: '#/components/x-stackQL-resources/tags/methods/create' update: - $ref: '#/components/x-stackQL-resources/tags/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tags/methods/delete' files: @@ -2749,17 +2775,14 @@ components: name: files title: Files methods: - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1files/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.files - list: - operation: *ref_21 - response: *ref_22 get: operation: $ref: >- @@ -2787,11 +2810,12 @@ components: - $ref: '#/components/x-stackQL-resources/files/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/files/methods/delete' paths: /v1/projects/{projectsId}/projectSettings: - parameters: &ref_23 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2860,7 +2884,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/vpcscConfig: - parameters: *ref_23 + parameters: *ref_1 get: description: Retrieves the VPCSC Config for the Project. operationId: artifactregistry.projects.locations.getVpcscConfig @@ -2928,7 +2952,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: artifactregistry.projects.locations.list @@ -2968,7 +2992,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets information about a location. operationId: artifactregistry.projects.locations.get @@ -3000,7 +3024,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3040,7 +3064,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists repositories. operationId: artifactregistry.projects.locations.repositories.list @@ -3080,6 +3104,14 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string post: description: >- Creates a repository. The returned Operation will finish once the @@ -3119,7 +3151,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a repository. operationId: artifactregistry.projects.locations.repositories.get @@ -3231,7 +3263,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: Updates the IAM policy for a given resource. operationId: artifactregistry.projects.locations.repositories.setIamPolicy @@ -3269,7 +3301,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets the IAM policy for a given resource. operationId: artifactregistry.projects.locations.repositories.getIamPolicy @@ -3311,7 +3343,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: Tests if the caller has a list of permissions on a resource. operationId: artifactregistry.projects.locations.repositories.testIamPermissions @@ -3353,7 +3385,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/dockerImages: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists docker images. operationId: artifactregistry.projects.locations.repositories.dockerImages.list @@ -3403,7 +3435,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/dockerImages/{dockerImagesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a docker image. operationId: artifactregistry.projects.locations.repositories.dockerImages.get @@ -3445,7 +3477,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/mavenArtifacts: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists maven artifacts. operationId: artifactregistry.projects.locations.repositories.mavenArtifacts.list @@ -3491,7 +3523,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/mavenArtifacts/{mavenArtifactsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a maven artifact. operationId: artifactregistry.projects.locations.repositories.mavenArtifacts.get @@ -3533,7 +3565,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/npmPackages: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists npm packages. operationId: artifactregistry.projects.locations.repositories.npmPackages.list @@ -3579,7 +3611,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/npmPackages/{npmPackagesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a npm package. operationId: artifactregistry.projects.locations.repositories.npmPackages.get @@ -3621,7 +3653,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pythonPackages: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists python packages. operationId: artifactregistry.projects.locations.repositories.pythonPackages.list @@ -3667,7 +3699,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/pythonPackages/{pythonPackagesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a python package. operationId: artifactregistry.projects.locations.repositories.pythonPackages.get @@ -3709,7 +3741,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/aptArtifacts:import: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Imports Apt artifacts. The returned Operation will complete once the @@ -3751,7 +3783,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/aptArtifacts:create: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Directly uploads an Apt artifact. The returned Operation will complete @@ -3793,7 +3825,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/yumArtifacts:import: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Imports Yum (RPM) artifacts. The returned Operation will complete once @@ -3835,7 +3867,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/yumArtifacts:create: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Directly uploads a Yum artifact. The returned Operation will complete @@ -3877,7 +3909,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/googetArtifacts:import: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Imports GooGet artifacts. The returned Operation will complete once the @@ -3919,7 +3951,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/googetArtifacts:create: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Directly uploads a GooGet artifact. The returned Operation will complete @@ -3961,7 +3993,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/genericArtifacts:create: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Directly uploads a Generic artifact. The returned operation will @@ -4004,7 +4036,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/kfpArtifacts:create: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Directly uploads a KFP artifact. The returned Operation will complete @@ -4046,7 +4078,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/goModules:create: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Directly uploads a Go module. The returned Operation will complete once @@ -4087,7 +4119,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists packages. operationId: artifactregistry.projects.locations.repositories.packages.list @@ -4132,8 +4164,16 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a package. operationId: artifactregistry.projects.locations.repositories.packages.get @@ -4259,7 +4299,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}/versions: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists versions. operationId: artifactregistry.projects.locations.repositories.packages.versions.list @@ -4317,8 +4357,12 @@ paths: name: orderBy schema: type: string + - in: query + name: filter + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}/versions/{versionsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a version operationId: artifactregistry.projects.locations.repositories.packages.versions.get @@ -4417,7 +4461,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}/versions:batchDelete: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Deletes multiple versions across a repository. The returned operation @@ -4463,7 +4507,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}/tags: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists tags. operationId: artifactregistry.projects.locations.repositories.packages.tags.list @@ -4563,7 +4607,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}/tags/{tagsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a tag. operationId: artifactregistry.projects.locations.repositories.packages.tags.get @@ -4702,7 +4746,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/files: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists files. operationId: artifactregistry.projects.locations.repositories.files.list @@ -4756,7 +4800,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/files/{filesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a file. operationId: artifactregistry.projects.locations.repositories.files.get @@ -4837,7 +4881,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/files/{filesId}:download: - parameters: *ref_23 + parameters: *ref_1 get: description: Download a file. operationId: artifactregistry.projects.locations.repositories.files.download diff --git a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml index 18d6ce3a..adea76e0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/assuredworkloads.yaml @@ -7,8 +7,8 @@ info: title: Assured Workloads API description: '' version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/learnmoreurl servers: @@ -34,152 +34,61 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleLongrunningListOperationsResponse: - properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: - description: >- - A list of operations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - description: The response message for Operations.ListOperations. - id: GoogleLongrunningListOperationsResponse - type: object - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: - description: Remediation instructions to resolve violation via gcloud cli - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - type: object - properties: - additionalLinks: - description: Additional urls for more information about steps - items: - type: string - type: array - gcloudCommands: - items: - type: string - description: Gcloud command to resolve violation - type: array - steps: - type: array - items: - type: string - description: Steps to resolve violation via gcloud cli - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: - description: Response for restricting the list of allowed resources. + GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: + id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo type: object - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse - properties: {} - GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: + description: Represent the resources that are children of this Workload. properties: - ekmProvisioningErrorDomain: - enum: - - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED - - UNSPECIFIED_ERROR - - GOOGLE_SERVER_ERROR - - EXTERNAL_USER_ERROR - - EXTERNAL_PARTNER_ERROR - - TIMEOUT_ERROR - enumDescriptions: - - No error domain - - Error but domain is unspecified. - - Internal logic breaks within provisioning code. - - >- - Error occurred with the customer not granting permission/creating - resource. - - Error occurred within the partner's provisioning cluster. - - Resource wasn't provisioned in the required 7 day time period - type: string - description: Indicates Ekm provisioning error if any. - ekmProvisioningState: - description: Indicates Ekm enrollment Provisioning of a given workload. - enumDescriptions: - - Default State for Ekm Provisioning - - Pending State for Ekm Provisioning - - Failed State for Ekm Provisioning - - Completed State for Ekm Provisioning - enum: - - EKM_PROVISIONING_STATE_UNSPECIFIED - - EKM_PROVISIONING_STATE_PENDING - - EKM_PROVISIONING_STATE_FAILED - - EKM_PROVISIONING_STATE_COMPLETED - type: string - ekmProvisioningErrorMapping: + resourceId: + description: Resource identifier. For a project this represents project_number. + format: int64 type: string - enumDescriptions: - - Error is unspecified. - - Service account is used is invalid. - - Iam permission monitoring.MetricsScopeAdmin wasn't applied. - - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. - description: Detailed error message if Ekm provisioning fails - enum: - - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED - - INVALID_SERVICE_ACCOUNT - - MISSING_METRICS_SCOPE_ADMIN_PERMISSION - - MISSING_EKM_CONNECTION_ADMIN_PERMISSION - id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - description: External key management systems(EKM) Provisioning response - type: object - GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: - description: >- - Request for restricting list of available resources in Workload - environment. - type: object - id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest - properties: - restrictionType: + resourceType: type: string - description: >- - Required. The type of restriction for using gcp products in the - Workload environment. + description: Indicates the type of resource. enumDescriptions: - - Unknown restriction type. - - >- - Allow the use all of all gcp products, irrespective of the - compliance posture. This effectively removes - gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. - - >- - Based on Workload's compliance regime, allowed list changes. See - - https://cloud.google.com/assured-workloads/docs/supported-products - for the list of supported resources. + - Unknown resource type. - >- - Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of - compliant resources to the existing list of compliant resources. - Effective org-policy of the Folder is considered to ensure there - is no disruption to the existing customer workflows. + Deprecated. Existing workloads will continue to support this, but + new CreateWorkloadRequests should not specify this as an input + value. + - Consumer Folder. + - Consumer project containing encryption keys. + - Keyring resource that hosts encryption keys. enum: - - RESTRICTION_TYPE_UNSPECIFIED - - ALLOW_ALL_GCP_RESOURCES - - ALLOW_COMPLIANT_RESOURCES - - APPEND_COMPLIANT_RESOURCES + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + enumDeprecated: + - false + - true + - false + - false + - false GoogleRpcStatus: - type: object - id: GoogleRpcStatus properties: details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. items: additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any type: object type: array - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. message: - type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + type: string + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -188,620 +97,479 @@ components: details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: + id: GoogleRpcStatus type: object - properties: {} - id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse - description: Response for EnableResourceMonitoring endpoint. - GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: + GoogleCloudAssuredworkloadsV1Violation: type: object properties: - resourceId: + updateTime: + type: string + description: Output only. The last time when the Violation record was updated. + format: google-datetime + readOnly: true + resourceName: + type: string description: >- - Resource identifier. For a project this represents project_id. If - the project is already taken, the workload creation will fail. For - KeyRing, this represents the keyring_id. For a folder, don't set - this value as folder_id is assigned by Google. + Optional. Output only. Name of the resource like + //storage.googleapis.com/myprojectxyz-testbucket. Empty for + org-policy violations. + readOnly: true + nonCompliantOrgPolicy: + description: >- + Output only. Immutable. Name of the OrgPolicy which was modified + with non-compliant change and resulted this violation. Format: + projects/{project_number}/policies/{constraint_name} + folders/{folder_id}/policies/{constraint_name} + organizations/{organization_id}/policies/{constraint_name} + type: string + readOnly: true + acknowledged: + description: A boolean that indicates if the violation is acknowledged + type: boolean + exceptionContexts: + readOnly: true + type: array + description: >- + Output only. List of all the exception detail added for the + violation. + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext + beginTime: + format: google-datetime + type: string + description: Output only. Time of the event which triggered the Violation. + readOnly: true + category: + description: >- + Output only. Category under which this violation is mapped. e.g. + Location, Service Usage, Access, Encryption, etc. + readOnly: true type: string resourceType: + type: string + readOnly: true description: >- - Indicates the type of resource. This field should be specified to - correspond the id to the right project type (CONSUMER_PROJECT or - ENCRYPTION_KEYS_PROJECT) - enumDeprecated: - - false - - true - - false - - false - - false + Optional. Output only. Type of the resource like + compute.googleapis.com/Disk, etc. Empty for org-policy violations. + name: + readOnly: true type: string - enumDescriptions: - - Unknown resource type. - - >- - Deprecated. Existing workloads will continue to support this, but - new CreateWorkloadRequests should not specify this as an input - value. - - Consumer Folder. - - Consumer project containing encryption keys. - - Keyring resource that hosts encryption keys. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - displayName: + description: >- + Output only. Immutable. Name of the Violation. Format: + organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} + description: + description: >- + Output only. Description for the Violation. e.g. OrgPolicy + gcp.resourceLocations has non compliant value. type: string + readOnly: true + exceptionAuditLogLink: description: >- - User-assigned resource display name. If not empty it will be used to - create a resource with the specified name. - description: Represent the custom settings for the resources to be created. - id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings - GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: - description: Represents the Compliance Status of this workload - properties: - activeResourceViolationCount: - description: Number of current resource violations which are acknowledged. - type: integer - format: int32 - activeViolationCount: - format: int32 - description: Number of current orgPolicy violations which are not acknowledged. - type: integer - acknowledgedResourceViolationCount: - type: integer - description: Number of current resource violations which are not acknowledged. - format: int32 - acknowledgedViolationCount: - description: Number of current orgPolicy violations which are acknowledged. - format: int32 - type: integer - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - GoogleCloudAssuredworkloadsV1MoveImpact: - description: Represents the impact of moving the asset to the target. - type: object - id: GoogleCloudAssuredworkloadsV1MoveImpact - properties: - detail: - description: Explanation of the impact. + Output only. Immutable. Audit Log link to find business + justification provided for violation exception. Format: + https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} type: string - GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: - type: object - properties: - analysisGroups: - description: List of eligible analyses performed for the asset. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - assetType: + readOnly: true + acknowledgementTime: + description: >- + Optional. Timestamp when this violation was acknowledged first. + Check exception_contexts to find the last time the violation was + acknowledged when there are more than one violations. This field + will be absent when acknowledged field is marked as false. + type: string + format: google-datetime + orgPolicyConstraint: type: string + deprecated: true description: >- - Type of the asset being analyzed. Possible values will be among the - ones listed - [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). - asset: + Output only. Immutable. The org-policy-constraint that was + incorrectly changed, which resulted in this violation. + readOnly: true + associatedOrgPolicyViolationId: + readOnly: true + type: string description: >- - The full resource name of the asset being analyzed. Example: - //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 + Optional. Output only. Violation Id of the org-policy violation due + to which the resource violation is caused. Empty for org-policy + violations. + state: + enumDescriptions: + - Unspecified state. + - Violation is resolved. + - Violation is Unresolved + - Violation is Exception type: string - description: Represents move analysis results for an asset. - id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: - properties: - nextPageToken: + readOnly: true + description: Output only. State of the violation + enum: + - STATE_UNSPECIFIED + - RESOLVED + - UNRESOLVED + - EXCEPTION + resolveTime: + format: google-datetime type: string - description: The next page token. Return empty if reached the last page. - workloads: - type: array - description: List of Workloads under a given parent. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' - id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse - description: Response of ListWorkloads endpoint. - type: object + description: >- + Output only. Time of the event which fixed the Violation. If the + violation is ACTIVE this will be empty. + readOnly: true + remediation: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation + description: Output only. Compliance violation remediation + parentProjectNumber: + readOnly: true + description: >- + Optional. Output only. Parent project number where resource is + present. Empty for org-policy violations. + type: string + auditLogLink: + readOnly: true + type: string + description: >- + Output only. Immutable. Audit Log Link for violated resource Format: + https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} + violationType: + description: Output only. Type of the violation + enum: + - VIOLATION_TYPE_UNSPECIFIED + - ORG_POLICY + - RESOURCE + readOnly: true + type: string + enumDescriptions: + - Unspecified type. + - Org Policy Violation. + - Resource Violation. + id: GoogleCloudAssuredworkloadsV1Violation + description: Workload monitoring Violation. GoogleCloudAssuredworkloadsV1MoveAnalysisResult: - type: object + id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult description: Represents the successful move analysis results for a group. + type: object properties: - warnings: + blockers: description: >- - List of warnings. These are risks that may or may not result in - compliance violations. + List of blockers. If not resolved, these will result in compliance + violations in the target. items: $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' type: array - blockers: + warnings: + type: array items: $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveImpact' description: >- - List of blockers. If not resolved, these will result in compliance - violations in the target. - type: array - id: GoogleCloudAssuredworkloadsV1MoveAnalysisResult - GoogleCloudAssuredworkloadsV1WorkloadResourceInfo: - properties: - resourceId: - description: Resource identifier. For a project this represents project_number. - type: string - format: int64 - resourceType: - enumDescriptions: - - Unknown resource type. - - >- - Deprecated. Existing workloads will continue to support this, but - new CreateWorkloadRequests should not specify this as an input - value. - - Consumer Folder. - - Consumer project containing encryption keys. - - Keyring resource that hosts encryption keys. - enum: - - RESOURCE_TYPE_UNSPECIFIED - - CONSUMER_PROJECT - - CONSUMER_FOLDER - - ENCRYPTION_KEYS_PROJECT - - KEYRING - enumDeprecated: - - false - - true - - false - - false - - false - description: Indicates the type of resource. - type: string - type: object - id: GoogleCloudAssuredworkloadsV1WorkloadResourceInfo - description: Represent the resources that are children of this Workload. - GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: - description: Request for acknowledging the violation - properties: - comment: - type: string - description: >- - Required. Business justification explaining the need for violation - acknowledgement - acknowledgeType: - type: string - enum: - - ACKNOWLEDGE_TYPE_UNSPECIFIED - - SINGLE_VIOLATION - - EXISTING_CHILD_RESOURCE_VIOLATIONS - description: Optional. Acknowledge type of specified violation. - enumDescriptions: - - Acknowledge type unspecified. - - Acknowledge only the specific violation. - - >- - Acknowledge specified orgPolicy violation and also associated - resource violations. - nonCompliantOrgPolicy: - deprecated: true - description: >- - Optional. This field is deprecated and will be removed in future - version of the API. Name of the OrgPolicy which was modified with - non-compliant change and resulted in this violation. Format: - projects/{project_number}/policies/{constraint_name} - folders/{folder_id}/policies/{constraint_name} - organizations/{organization_id}/policies/{constraint_name} - type: string - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest - type: object - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: + List of warnings. These are risks that may or may not result in + compliance violations. + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud: + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud properties: steps: type: array + description: Steps to resolve violation via gcloud cli items: type: string - description: Steps to resolve violation via cloud console - additionalLinks: + gcloudCommands: type: array + description: Gcloud command to resolve violation items: type: string - description: Additional urls for more information about steps - consoleUris: + additionalLinks: type: array + description: Additional urls for more information about steps items: type: string - description: Link to console page where violations can be resolved - description: Remediation instructions to resolve violation via cloud console - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole type: object - GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty + description: Remediation instructions to resolve violation via gcloud cli + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudAssuredworkloadsV1ListViolationsResponse: - description: Response of ListViolations endpoint. + description: Instructions to remediate violation properties: - violations: - description: List of Violations under a Workload. - items: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' - type: array - nextPageToken: - description: The next page token. Returns empty if reached the last page. - type: string - type: object - id: GoogleCloudAssuredworkloadsV1ListViolationsResponse - GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: - properties: - analysisResult: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' - description: Result of a successful analysis. - error: - description: Error details for a failed analysis. - $ref: '#/components/schemas/GoogleRpcStatus' - displayName: - description: Name of the analysis group. - type: string - id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup - description: >- - Represents a logical group of checks performed for an asset. If - successful, the group contains the analysis result, otherwise it - contains an error with the failure reason. - type: object - GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: - id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse - type: object - properties: - setupStatus: - type: string - description: Indicates SAA enrollment status of a given workload. - enumDescriptions: - - Unspecified. - - SAA enrollment pending. - - SAA enrollment comopleted. - enum: - - SETUP_STATE_UNSPECIFIED - - STATUS_PENDING - - STATUS_COMPLETE - setupErrors: - type: array - description: Indicates SAA enrollment setup error if any. - items: - enumDescriptions: - - Unspecified. - - >- - Invalid states for all customers, to be redirected to AA UI for - additional details. - - Returned when there is not an EKM key configured. - - >- - Returned when there are no enrolled services or the customer is - enrolled in CAA only for a subset of services. - - >- - Returned when exception was encountered during evaluation of - other criteria. - enum: - - SETUP_ERROR_UNSPECIFIED - - ERROR_INVALID_BASE_SETUP - - ERROR_MISSING_EXTERNAL_SIGNING_KEY - - ERROR_NOT_ALL_SERVICES_ENROLLED - - ERROR_SETUP_CHECK_FAILED - type: string - description: Signed Access Approvals (SAA) enrollment response. - GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: - id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest - description: Request for updating permission settings for a partner workload. - type: object - properties: - updateMask: - description: >- - Required. The list of fields to be updated. E.g. update_mask { - paths: "partner_permissions.data_logs_viewer"} - format: google-fieldmask - type: string - partnerPermissions: + gcloudInstructions: + description: Remediation instructions to resolve violation via gcloud cli $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - description: Required. The partner permissions to be updated. - etag: - type: string - description: >- - Optional. The etag of the workload. If this is provided, it must - match the server's etag. - GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: - description: Response for violation acknowledgement + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud + consoleInstructions: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + description: Remediation instructions to resolve violation via cloud console + GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata: type: object - properties: {} - id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse - GoogleCloudAssuredworkloadsV1Violation: + description: Operation metadata to give request details of CreateWorkload. + id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata properties: - acknowledged: - type: boolean - description: A boolean that indicates if the violation is acknowledged - parentProjectNumber: - type: string - description: >- - Optional. Output only. Parent project number where resource is - present. Empty for org-policy violations. - readOnly: true - nonCompliantOrgPolicy: - readOnly: true - description: >- - Output only. Immutable. Name of the OrgPolicy which was modified - with non-compliant change and resulted this violation. Format: - projects/{project_number}/policies/{constraint_name} - folders/{folder_id}/policies/{constraint_name} - organizations/{organization_id}/policies/{constraint_name} - type: string - auditLogLink: - readOnly: true - description: >- - Output only. Immutable. Audit Log Link for violated resource Format: - https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} + parent: + description: Optional. The parent of the workload. type: string - beginTime: - readOnly: true + displayName: + description: Optional. The display name of the workload. type: string - format: google-datetime - description: Output only. Time of the event which triggered the Violation. - violationType: - enum: - - VIOLATION_TYPE_UNSPECIFIED - - ORG_POLICY - - RESOURCE + complianceRegime: enumDescriptions: - - Unspecified type. - - Org Policy Violation. - - Resource Violation. - description: Output only. Type of the violation - readOnly: true - type: string - category: - readOnly: true - description: >- - Output only. Category under which this violation is mapped. e.g. - Location, Service Usage, Access, Encryption, etc. - type: string - orgPolicyConstraint: - readOnly: true - deprecated: true - description: >- - Output only. Immutable. The org-policy-constraint that was - incorrectly changed, which resulted in this violation. - type: string - updateTime: - description: Output only. The last time when the Violation record was updated. - type: string - readOnly: true - format: google-datetime - acknowledgementTime: - description: >- - Optional. Timestamp when this violation was acknowledged first. - Check exception_contexts to find the last time the violation was - acknowledged when there are more than one violations. This field - will be absent when acknowledged field is marked as false. + - Unknown compliance regime. + - Information protection as per DoD IL4 requirements. + - Criminal Justice Information Services (CJIS) Security policies. + - FedRAMP High data protection controls + - FedRAMP Moderate data protection controls + - Assured Workloads For US Regions data protection controls + - Health Insurance Portability and Accountability Act controls + - Health Information Trust Alliance controls + - Assured Workloads For EU Regions and Support controls + - Assured Workloads For Canada Regions and Support controls + - International Traffic in Arms Regulations + - Assured Workloads for Australia Regions and Support controls + - Assured Workloads for Partners; + - Assured Workloads for Israel Regions + - Assured Workloads for Israel Regions + - Assured Workloads for Canada Protected B regime + - Information protection as per DoD IL5 requirements. + - Information protection as per DoD IL2 requirements. + - Assured Workloads for Japan Regions + - Assured Workloads Sovereign Controls KSA + - Assured Workloads for Regional Controls + - Healthcare and Life Science Controls + - Healthcare and Life Science Controls with US Support type: string - format: google-datetime - state: - enumDescriptions: - - Unspecified state. - - Violation is resolved. - - Violation is Unresolved - - Violation is Exception enum: - - STATE_UNSPECIFIED - - RESOLVED - - UNRESOLVED - - EXCEPTION - type: string - description: Output only. State of the violation - readOnly: true - description: - readOnly: true + - COMPLIANCE_REGIME_UNSPECIFIED + - IL4 + - CJIS + - FEDRAMP_HIGH + - FEDRAMP_MODERATE + - US_REGIONAL_ACCESS + - HIPAA + - HITRUST + - EU_REGIONS_AND_SUPPORT + - CA_REGIONS_AND_SUPPORT + - ITAR + - AU_REGIONS_AND_US_SUPPORT + - ASSURED_WORKLOADS_FOR_PARTNERS + - ISR_REGIONS + - ISR_REGIONS_AND_SUPPORT + - CA_PROTECTED_B + - IL5 + - IL2 + - JP_REGIONS_AND_SUPPORT + - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS + - REGIONAL_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT description: >- - Output only. Description for the Violation. e.g. OrgPolicy - gcp.resourceLocations has non compliant value. - type: string - resourceType: - readOnly: true + Optional. Compliance controls that should be applied to the + resources managed by the workload. + createTime: type: string + description: Optional. Time when the operation was created. + format: google-datetime + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + type: object + properties: + metadata: description: >- - Optional. Output only. Type of the resource like - compute.googleapis.com/Disk, etc. Empty for org-policy violations. - remediation: - readOnly: true - description: Output only. Compliance violation remediation - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediation - exceptionContexts: - type: array - readOnly: true + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: description: >- - Output only. List of all the exception detail added for the - violation. - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationExceptionContext + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean name: description: >- - Output only. Immutable. Name of the Violation. Format: - organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} - readOnly: true - type: string - resourceName: - type: string - description: >- - Optional. Output only. Name of the resource like - //storage.googleapis.com/myprojectxyz-testbucket. Empty for - org-policy violations. - readOnly: true - resolveTime: - format: google-datetime - description: >- - Output only. Time of the event which fixed the Violation. If the - violation is ACTIVE this will be empty. - type: string - readOnly: true - exceptionAuditLogLink: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string - readOnly: true + error: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Immutable. Audit Log link to find business - justification provided for violation exception. Format: - https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} - associatedOrgPolicyViolationId: - type: string + The error result of the operation in case of failure or + cancellation. + response: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - Optional. Output only. Violation Id of the org-policy violation due - to which the resource violation is caused. Empty for org-policy - violations. - readOnly: true - id: GoogleCloudAssuredworkloadsV1Violation + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole: + type: object + id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole + description: Remediation instructions to resolve violation via cloud console + properties: + steps: + items: + type: string + type: array + description: Steps to resolve violation via cloud console + consoleUris: + description: Link to console page where violations can be resolved + type: array + items: + type: string + additionalLinks: + description: Additional urls for more information about steps + items: + type: string + type: array + GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse: type: object - description: Workload monitoring Violation. + description: Response for EnableResourceMonitoring endpoint. + id: GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse + properties: {} GoogleCloudAssuredworkloadsV1Workload: - id: GoogleCloudAssuredworkloadsV1Workload description: >- A Workload object for managing highly regulated workloads of cloud customers. + id: GoogleCloudAssuredworkloadsV1Workload + type: object properties: - complianceRegime: - enum: - - COMPLIANCE_REGIME_UNSPECIFIED - - IL4 - - CJIS - - FEDRAMP_HIGH - - FEDRAMP_MODERATE - - US_REGIONAL_ACCESS - - REGIONAL_CONTROLS_PREMIUM_US - - HIPAA - - HITRUST - - EU_REGIONS_AND_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_EU - - CA_REGIONS_AND_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_CA - - ITAR - - AU_REGIONS_AND_US_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_AU - - ASSURED_WORKLOADS_FOR_PARTNERS - - ISR_REGIONS - - REGIONAL_CONTROLS_PREMIUM_ISR - - ISR_REGIONS_AND_SUPPORT - - CA_PROTECTED_B - - IL5 - - IL2 - - JP_REGIONS_AND_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_JP - - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS - - REGIONAL_CONTROLS - - FREE_REGIONS + saaEnrollmentResponse: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse description: >- - Required. Immutable. Compliance Regime associated with this - workload. + Output only. Represents the SAA enrollment response of the given + workload. SAA enrollment response is queried during GetWorkload + call. In failure cases, user friendly error message is shown in SAA + details page. + resourceSettings: + description: >- + Input only. Resource properties that are used to customize workload + resources. These properties (such as custom project id) will be used + to create workload resources if possible. This field is optional. + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + type: array + partner: + enum: + - PARTNER_UNSPECIFIED + - LOCAL_CONTROLS_BY_S3NS + - SOVEREIGN_CONTROLS_BY_T_SYSTEMS + - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT + - SOVEREIGN_CONTROLS_BY_PSN + - SOVEREIGN_CONTROLS_BY_CNTXT + - SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM type: string + description: Optional. Partner regime associated with this workload. enumDescriptions: - - Unknown compliance regime. - - Information protection as per DoD IL4 requirements. - - Criminal Justice Information Services (CJIS) Security policies. - - FedRAMP High data protection controls - - FedRAMP Moderate data protection controls - - Assured Workloads For US Regions data protection controls - - Assured Workloads For US Regions data protection controls - - Health Insurance Portability and Accountability Act controls - - Health Information Trust Alliance controls - - Assured Workloads For EU Regions and Support controls - - Assured Workloads For EU Regions and Support controls - - Assured Workloads For Canada Regions and Support controls - - Assured Workloads For Canada Regions and Support controls - - International Traffic in Arms Regulations - - Assured Workloads for Australia Regions and Support controls - - Assured Workloads for Australia Regions and Support controls - - Assured Workloads for Partners; - - Assured Workloads for Israel Regions - - Assured Workloads for Israel - - Assured Workloads for Israel Regions - - Assured Workloads for Canada Protected B regime - - Information protection as per DoD IL5 requirements. - - Information protection as per DoD IL2 requirements. - - Assured Workloads for Japan Regions - - Assured Workloads for Japan Regions - - KSA R5 Controls. - - Assured Workloads for Regional Controls/Free Regions - - Assured Workloads for Regional Controls/Free Regions - displayName: + - '' + - Enum representing S3NS (Thales) partner. + - Enum representing T_SYSTEM (TSI) partner. + - Enum representing SIA_MINSAIT (Indra) partner. + - Enum representing PSN (TIM) partner. + - Enum representing CNTXT (Kingdom of Saudi Arabia) partner. + - >- + Enum representing CNTXT (Kingdom of Saudi Arabia) partner offering + without EKM. + createTime: + description: Output only. Immutable. The Workload creation timestamp. + readOnly: true + format: google-datetime type: string + resources: + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + description: >- + Output only. The resources associated with this workload. These + resources will be created when creating the workload. If any of the + projects already exist, the workload creation will fail. Always read + only. + type: array + readOnly: true + displayName: description: >- Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload + type: string kmsSettings: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + deprecated: true description: >- Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field. - deprecated: true - compliantButDisallowedServices: - items: - type: string - type: array - description: >- - Output only. Urls for services which are compliant for this Assured - Workload, but which are currently disallowed by the - ResourceUsageRestriction org policy. Invoke RestrictAllowedResources - endpoint to allow your project developers to use these services in - their environment. - readOnly: true - ekmProvisioningResponse: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + partnerServicesBillingAccount: + type: string description: >- - Output only. Represents the Ekm Provisioning State of the given - workload. - readOnly: true + Optional. Billing account necessary for purchasing services from + Sovereign Partners. This field is required for creating + SIA/PSN/CNTXT partner workloads. The caller should have + 'billing.resourceAssociations.create' IAM permission on this + billing-account. The format of this string is + billingAccounts/AAAAAA-BBBBBB-CCCCCC + complianceStatus: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse - createTime: - format: google-datetime + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus + description: Output only. Count of active Violations in the Workload. readOnly: true - description: Output only. Immutable. The Workload creation timestamp. - type: string - provisionedResourcesParent: + resourceMonitoringEnabled: + readOnly: true + type: boolean description: >- - Input only. The parent resource for the resources managed by this - Assured Workload. May be either empty or a folder resource which is - a child of the Workload parent. If not specified all resources are - created under the parent organization. Format: folders/{folder_id} - type: string - partner: - type: string - enumDescriptions: - - '' - - Enum representing S3NS (Thales) partner. - - Enum representing T_SYSTEM (TSI) partner. - - Enum representing SIA_MINSAIT (Indra) partner. - - Enum representing PSN (TIM) partner. - description: Optional. Partner regime associated with this workload. - enum: - - PARTNER_UNSPECIFIED - - LOCAL_CONTROLS_BY_S3NS - - SOVEREIGN_CONTROLS_BY_T_SYSTEMS - - SOVEREIGN_CONTROLS_BY_SIA_MINSAIT - - SOVEREIGN_CONTROLS_BY_PSN + Output only. Indicates whether resource monitoring is enabled for + workload or not. It is true when Resource feed is subscribed to AWM + topic and AWM Service Agent Role is binded to AW Service Account for + resource Assured workload. kajEnrollmentState: + enumDescriptions: + - Default State for KAJ Enrollment. + - Pending State for KAJ Enrollment. + - Complete State for KAJ Enrollment. + description: >- + Output only. Represents the KAJ enrollment state of the given + workload. readOnly: true type: string enum: - KAJ_ENROLLMENT_STATE_UNSPECIFIED - KAJ_ENROLLMENT_STATE_PENDING - KAJ_ENROLLMENT_STATE_COMPLETE + violationNotificationsEnabled: + type: boolean description: >- - Output only. Represents the KAJ enrollment state of the given - workload. - enumDescriptions: - - Default State for KAJ Enrollment. - - Pending State for KAJ Enrollment. - - Complete State for KAJ Enrollment. + Optional. Indicates whether the e-mail notification for a violation + is enabled for a workload. This value will be by default True, and + if not present will be considered as true. This should only be + updated via updateWorkload call. Any Changes to this field during + the createWorkload call will not be honored. This will always be + true while creating the workload. + enableSovereignControls: + type: boolean + description: >- + Optional. Indicates the sovereignty status of the given workload. + Currently meant to be used by Europe/Canada customers. billingAccount: - type: string description: >- Optional. The billing account used for the resources which are direct children of workload. This billing account is initially @@ -810,305 +578,442 @@ components: change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. - etag: type: string + etag: description: >- Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. - violationNotificationsEnabled: - type: boolean - description: >- - Optional. Indicates whether the e-mail notification for a violation - is enabled for a workload. This value will be by default True, and - if not present will be considered as true. This should only be - updated via updateWorkload call. Any Changes to this field during - the createWorkload call will not be honored. This will always be - true while creating the workload. - resourceSettings: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + type: string + complianceRegime: + enumDescriptions: + - Unknown compliance regime. + - Information protection as per DoD IL4 requirements. + - Criminal Justice Information Services (CJIS) Security policies. + - FedRAMP High data protection controls + - FedRAMP Moderate data protection controls + - Assured Workloads For US Regions data protection controls + - Health Insurance Portability and Accountability Act controls + - Health Information Trust Alliance controls + - Assured Workloads For EU Regions and Support controls + - Assured Workloads For Canada Regions and Support controls + - International Traffic in Arms Regulations + - Assured Workloads for Australia Regions and Support controls + - Assured Workloads for Partners; + - Assured Workloads for Israel Regions + - Assured Workloads for Israel Regions + - Assured Workloads for Canada Protected B regime + - Information protection as per DoD IL5 requirements. + - Information protection as per DoD IL2 requirements. + - Assured Workloads for Japan Regions + - Assured Workloads Sovereign Controls KSA + - Assured Workloads for Regional Controls + - Healthcare and Life Science Controls + - Healthcare and Life Science Controls with US Support + enum: + - COMPLIANCE_REGIME_UNSPECIFIED + - IL4 + - CJIS + - FEDRAMP_HIGH + - FEDRAMP_MODERATE + - US_REGIONAL_ACCESS + - HIPAA + - HITRUST + - EU_REGIONS_AND_SUPPORT + - CA_REGIONS_AND_SUPPORT + - ITAR + - AU_REGIONS_AND_US_SUPPORT + - ASSURED_WORKLOADS_FOR_PARTNERS + - ISR_REGIONS + - ISR_REGIONS_AND_SUPPORT + - CA_PROTECTED_B + - IL5 + - IL2 + - JP_REGIONS_AND_SUPPORT + - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS + - REGIONAL_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS + - HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT + type: string description: >- - Input only. Resource properties that are used to customize workload - resources. These properties (such as custom project id) will be used - to create workload resources if possible. This field is optional. + Required. Immutable. Compliance Regime associated with this + workload. partnerPermissions: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions description: >- Optional. Permissions granted to the AW Partner SA account for the customer workload - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions - saaEnrollmentResponse: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + compliantButDisallowedServices: + items: + type: string description: >- - Output only. Represents the SAA enrollment response of the given - workload. SAA enrollment response is queried during GetWorkload - call. In failure cases, user friendly error message is shown in SAA - details page. - resourceMonitoringEnabled: - type: boolean + Output only. Urls for services which are compliant for this Assured + Workload, but which are currently disallowed by the + ResourceUsageRestriction org policy. Invoke RestrictAllowedResources + endpoint to allow your project developers to use these services in + their environment. + type: array readOnly: true + provisionedResourcesParent: + type: string description: >- - Output only. Indicates whether resource monitoring is enabled for - workload or not. It is true when Resource feed is subscribed to AWM - topic and AWM Service Agent Role is binded to AW Service Account for - resource Assured workload. - enableSovereignControls: - description: >- - Optional. Indicates the sovereignty status of the given workload. - Currently meant to be used by Europe/Canada customers. - type: boolean - complianceStatus: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus - description: Output only. Count of active Violations in the Workload. + Input only. The parent resource for the resources managed by this + Assured Workload. May be either empty or a folder resource which is + a child of the Workload parent. If not specified all resources are + created under the parent organization. Format: folders/{folder_id} + labels: + type: object + description: Optional. Labels applied to the workload. + additionalProperties: + type: string + ekmProvisioningResponse: readOnly: true + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + description: >- + Output only. Represents the Ekm Provisioning State of the given + workload. name: description: >- Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. type: string - labels: - additionalProperties: + GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse: + description: Signed Access Approvals (SAA) enrollment response. + id: GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse + properties: + setupStatus: + description: Indicates SAA enrollment status of a given workload. + enumDescriptions: + - Unspecified. + - SAA enrollment pending. + - SAA enrollment comopleted. + enum: + - SETUP_STATE_UNSPECIFIED + - STATUS_PENDING + - STATUS_COMPLETE + type: string + setupErrors: + description: Indicates SAA enrollment setup error if any. + type: array + items: type: string - type: object - description: Optional. Labels applied to the workload. - resources: - readOnly: true + enum: + - SETUP_ERROR_UNSPECIFIED + - ERROR_INVALID_BASE_SETUP + - ERROR_MISSING_EXTERNAL_SIGNING_KEY + - ERROR_NOT_ALL_SERVICES_ENROLLED + - ERROR_SETUP_CHECK_FAILED + enumDescriptions: + - Unspecified. + - >- + Invalid states for all customers, to be redirected to AA UI for + additional details. + - Returned when there is not an EKM key configured. + - >- + Returned when there are no enrolled services or the customer is + enrolled in CAA only for a subset of services. + - >- + Returned when exception was encountered during evaluation of + other criteria. + type: object + GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: + description: Settings specific to the Key Management Service. + id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + deprecated: true + properties: + nextRotationTime: + description: >- + Required. Input only. Immutable. The time at which the Key + Management Service will automatically create a new version of the + crypto key and mark it as the primary. + format: google-datetime + type: string + rotationPeriod: + format: google-duration + description: >- + Required. Input only. Immutable. [next_rotation_time] will be + advanced by this period when the Key Management Service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. + type: string + type: object + GoogleCloudAssuredworkloadsV1WorkloadResourceSettings: + properties: + resourceId: + type: string + description: >- + Resource identifier. For a project this represents project_id. If + the project is already taken, the workload creation will fail. For + KeyRing, this represents the keyring_id. For a folder, don't set + this value as folder_id is assigned by Google. + displayName: + type: string + description: >- + User-assigned resource display name. If not empty it will be used to + create a resource with the specified name. + resourceType: + enum: + - RESOURCE_TYPE_UNSPECIFIED + - CONSUMER_PROJECT + - CONSUMER_FOLDER + - ENCRYPTION_KEYS_PROJECT + - KEYRING + enumDeprecated: + - false + - true + - false + - false + - false + type: string + enumDescriptions: + - Unknown resource type. + - >- + Deprecated. Existing workloads will continue to support this, but + new CreateWorkloadRequests should not specify this as an input + value. + - Consumer Folder. + - Consumer project containing encryption keys. + - Keyring resource that hosts encryption keys. + description: >- + Indicates the type of resource. This field should be specified to + correspond the id to the right project type (CONSUMER_PROJECT or + ENCRYPTION_KEYS_PROJECT) + id: GoogleCloudAssuredworkloadsV1WorkloadResourceSettings + type: object + description: Represent the custom settings for the resources to be created. + GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse: + type: object + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse + description: Response for violation acknowledgement + properties: {} + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest: + properties: + restrictionType: + description: >- + Required. The type of restriction for using gcp products in the + Workload environment. + type: string + enum: + - RESTRICTION_TYPE_UNSPECIFIED + - ALLOW_ALL_GCP_RESOURCES + - ALLOW_COMPLIANT_RESOURCES + - APPEND_COMPLIANT_RESOURCES + enumDescriptions: + - Unknown restriction type. + - >- + Allow the use all of all gcp products, irrespective of the + compliance posture. This effectively removes + gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder. + - >- + Based on Workload's compliance regime, allowed list changes. See - + https://cloud.google.com/assured-workloads/docs/supported-products + for the list of supported resources. + - >- + Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of + compliant resources to the existing list of compliant resources. + Effective org-policy of the Folder is considered to ensure there + is no disruption to the existing customer workflows. + type: object + description: >- + Request for restricting list of available resources in Workload + environment. + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest + GoogleCloudAssuredworkloadsV1ListViolationsResponse: + description: Response of ListViolations endpoint. + properties: + violations: + description: List of Violations under a Workload. + items: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Violation' + type: array + nextPageToken: + type: string + description: The next page token. Returns empty if reached the last page. + id: GoogleCloudAssuredworkloadsV1ListViolationsResponse + type: object + GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: + description: >- + Response containing the analysis results for the hypothetical resource + move. + properties: + nextPageToken: + description: The next page token. Is empty if the last page is reached. + type: string + assetMoveAnalyses: + description: List of analysis results for each asset in scope. + items: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis type: array + id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse + type: object + GoogleCloudAssuredworkloadsV1AssetMoveAnalysis: + description: Represents move analysis results for an asset. + properties: + asset: + type: string + description: >- + The full resource name of the asset being analyzed. Example: + //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1 + analysisGroups: items: $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadResourceInfo + #/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + description: List of eligible analyses performed for the asset. + type: array + assetType: description: >- - Output only. The resources associated with this workload. These - resources will be created when creating the workload. If any of the - projects already exist, the workload creation will fail. Always read - only. + Type of the asset being analyzed. Possible values will be among the + ones listed + [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). + type: string type: object + id: GoogleCloudAssuredworkloadsV1AssetMoveAnalysis GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions: - id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions properties: + assuredWorkloadsMonitoring: + type: boolean + description: Optional. Allow partner to view violation alerts. serviceAccessApprover: - description: Optional. Allow partner to view access approval logs. type: boolean + description: Optional. Allow partner to view access approval logs. dataLogsViewer: - type: boolean description: >- Allow the partner to view inspectability logs and monitoring violations. - assuredWorkloadsMonitoring: type: boolean - description: Optional. Allow partner to view violation alerts. - type: object + accessTransparencyLogsSupportCaseViewer: + type: boolean + description: Optional. Allow partner to view support case details for an AXT log description: >- Permissions granted to the AW Partner SA account for the customer workload - GoogleLongrunningOperation: + id: GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. + GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse: + id: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse + description: Response for restricting the list of allowed resources. + properties: {} + type: object + GoogleCloudAssuredworkloadsV1MoveImpact: properties: - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + detail: type: string - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - id: GoogleLongrunningOperation - GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata: - id: GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata + description: Explanation of the impact. + description: Represents the impact of moving the asset to the target. + id: GoogleCloudAssuredworkloadsV1MoveImpact + type: object + GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus: + type: object + description: Represents the Compliance Status of this workload + id: GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus properties: - complianceRegime: - enum: - - COMPLIANCE_REGIME_UNSPECIFIED - - IL4 - - CJIS - - FEDRAMP_HIGH - - FEDRAMP_MODERATE - - US_REGIONAL_ACCESS - - REGIONAL_CONTROLS_PREMIUM_US - - HIPAA - - HITRUST - - EU_REGIONS_AND_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_EU - - CA_REGIONS_AND_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_CA - - ITAR - - AU_REGIONS_AND_US_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_AU - - ASSURED_WORKLOADS_FOR_PARTNERS - - ISR_REGIONS - - REGIONAL_CONTROLS_PREMIUM_ISR - - ISR_REGIONS_AND_SUPPORT - - CA_PROTECTED_B - - IL5 - - IL2 - - JP_REGIONS_AND_SUPPORT - - REGIONAL_CONTROLS_PREMIUM_JP - - KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS - - REGIONAL_CONTROLS - - FREE_REGIONS - type: string + activeResourceViolationCount: + description: Number of current resource violations which are acknowledged. + type: integer + format: int32 + acknowledgedViolationCount: + format: int32 + description: Number of current orgPolicy violations which are acknowledged. + type: integer + activeViolationCount: + type: integer + description: Number of current orgPolicy violations which are not acknowledged. + format: int32 + acknowledgedResourceViolationCount: + format: int32 + type: integer + description: Number of current resource violations which are not acknowledged. + GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse: + properties: + ekmProvisioningErrorMapping: enumDescriptions: - - Unknown compliance regime. - - Information protection as per DoD IL4 requirements. - - Criminal Justice Information Services (CJIS) Security policies. - - FedRAMP High data protection controls - - FedRAMP Moderate data protection controls - - Assured Workloads For US Regions data protection controls - - Assured Workloads For US Regions data protection controls - - Health Insurance Portability and Accountability Act controls - - Health Information Trust Alliance controls - - Assured Workloads For EU Regions and Support controls - - Assured Workloads For EU Regions and Support controls - - Assured Workloads For Canada Regions and Support controls - - Assured Workloads For Canada Regions and Support controls - - International Traffic in Arms Regulations - - Assured Workloads for Australia Regions and Support controls - - Assured Workloads for Australia Regions and Support controls - - Assured Workloads for Partners; - - Assured Workloads for Israel Regions - - Assured Workloads for Israel - - Assured Workloads for Israel Regions - - Assured Workloads for Canada Protected B regime - - Information protection as per DoD IL5 requirements. - - Information protection as per DoD IL2 requirements. - - Assured Workloads for Japan Regions - - Assured Workloads for Japan Regions - - KSA R5 Controls. - - Assured Workloads for Regional Controls/Free Regions - - Assured Workloads for Regional Controls/Free Regions - description: >- - Optional. Compliance controls that should be applied to the - resources managed by the workload. - displayName: - description: Optional. The display name of the workload. + - Error is unspecified. + - Service account is used is invalid. + - Iam permission monitoring.MetricsScopeAdmin wasn't applied. + - Iam permission cloudkms.ekmConnectionsAdmin wasn't applied. type: string - parent: - description: Optional. The parent of the workload. + description: Detailed error message if Ekm provisioning fails + enum: + - EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED + - INVALID_SERVICE_ACCOUNT + - MISSING_METRICS_SCOPE_ADMIN_PERMISSION + - MISSING_EKM_CONNECTION_ADMIN_PERMISSION + ekmProvisioningState: + enum: + - EKM_PROVISIONING_STATE_UNSPECIFIED + - EKM_PROVISIONING_STATE_PENDING + - EKM_PROVISIONING_STATE_FAILED + - EKM_PROVISIONING_STATE_COMPLETED type: string - createTime: - format: google-datetime + description: Indicates Ekm enrollment Provisioning of a given workload. + enumDescriptions: + - Default State for Ekm Provisioning + - Pending State for Ekm Provisioning + - Failed State for Ekm Provisioning + - Completed State for Ekm Provisioning + ekmProvisioningErrorDomain: + enumDescriptions: + - No error domain + - Error but domain is unspecified. + - Internal logic breaks within provisioning code. + - >- + Error occurred with the customer not granting permission/creating + resource. + - Error occurred within the partner's provisioning cluster. + - Resource wasn't provisioned in the required 7 day time period + description: Indicates Ekm provisioning error if any. + enum: + - EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED + - UNSPECIFIED_ERROR + - GOOGLE_SERVER_ERROR + - EXTERNAL_USER_ERROR + - EXTERNAL_PARTNER_ERROR + - TIMEOUT_ERROR type: string - description: Optional. Time when the operation was created. - description: Operation metadata to give request details of CreateWorkload. - type: object - GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions: - id: GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - properties: - gcloudInstructions: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsGcloud - description: Remediation instructions to resolve violation via gcloud cli - consoleInstructions: - description: Remediation instructions to resolve violation via cloud console - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructionsConsole - description: Instructions to remediate violation type: object - GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse: - id: GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse + id: GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse + description: External key management systems(EKM) Provisioning response + GoogleCloudAssuredworkloadsV1ListWorkloadsResponse: + id: GoogleCloudAssuredworkloadsV1ListWorkloadsResponse type: object properties: nextPageToken: + description: The next page token. Return empty if reached the last page. type: string - description: The next page token. Is empty if the last page is reached. - assetMoveAnalyses: - type: array - description: List of analysis results for each asset in scope. + workloads: + description: List of Workloads under a given parent. items: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1AssetMoveAnalysis - description: >- - Response containing the analysis results for the hypothetical resource - move. - GoogleCloudAssuredworkloadsV1WorkloadKMSSettings: - deprecated: true + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + type: array + description: Response of ListWorkloads endpoint. + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse properties: - rotationPeriod: - format: google-duration - description: >- - Required. Input only. Immutable. [next_rotation_time] will be - advanced by this period when the Key Management Service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. + nextPageToken: type: string - nextRotationTime: + description: The standard List next-page token. + operations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + type: array description: >- - Required. Input only. Immutable. The time at which the Key - Management Service will automatically create a new version of the - crypto key and mark it as the primary. - format: google-datetime - type: string - description: Settings specific to the Key Management Service. - id: GoogleCloudAssuredworkloadsV1WorkloadKMSSettings + A list of operations that matches the specified filter in the + request. type: object + description: The response message for Operations.ListOperations. GoogleCloudAssuredworkloadsV1ViolationRemediation: properties: instructions: description: Required. Remediation instructions to resolve violations $ref: >- #/components/schemas/GoogleCloudAssuredworkloadsV1ViolationRemediationInstructions - compliantValues: - description: >- - Values that can resolve the violation For example: for list org - policy violations, this will either be the list of allowed or denied - values - items: - type: string - type: array remediationType: - type: string - enum: - - REMEDIATION_TYPE_UNSPECIFIED - - REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION - - REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION - - REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION - - REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION - - REMEDIATION_RESOURCE_VIOLATION - readOnly: true + description: >- + Output only. Reemediation type based on the type of org policy + values violated enumDescriptions: - Unspecified remediation type - Remediation type for boolean org policy @@ -1120,68 +1025,157 @@ components: the monitoring rule - Remediation type for gcp.restrictCmekCryptoKeyProjects - Remediation type for resource violation. + - >- + Remediation type for resource violation due to + gcp.restrictNonCmekServices + enum: + - REMEDIATION_TYPE_UNSPECIFIED + - REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION + - REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION + - REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION + - REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION + - REMEDIATION_RESOURCE_VIOLATION + - REMEDIATION_RESOURCE_VIOLATION_NON_CMEK_SERVICES + type: string + readOnly: true + compliantValues: description: >- - Output only. Reemediation type based on the type of org policy - values violated - type: object + Values that can resolve the violation For example: for list org + policy violations, this will either be the list of allowed or denied + values + items: + type: string + type: array id: GoogleCloudAssuredworkloadsV1ViolationRemediation + type: object description: >- Represents remediation guidance to resolve compliance violation for AssuredWorkload - GoogleCloudAssuredworkloadsV1ViolationExceptionContext: - id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext + GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest: type: object properties: - userName: + etag: + description: >- + Optional. The etag of the workload. If this is provided, it must + match the server's etag. + type: string + updateMask: type: string description: >- - Name of the user (or service account) who acknowledged the - violation. + Required. The list of fields to be updated. E.g. update_mask { + paths: "partner_permissions.data_logs_viewer"} + format: google-fieldmask + partnerPermissions: + description: Required. The partner permissions to be updated. + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions + id: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + description: Request for updating permission settings for a partner workload. + GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest: + properties: + acknowledgeType: + enum: + - ACKNOWLEDGE_TYPE_UNSPECIFIED + - SINGLE_VIOLATION + - EXISTING_CHILD_RESOURCE_VIOLATIONS + type: string + description: Optional. Acknowledge type of specified violation. + enumDescriptions: + - Acknowledge type unspecified. + - Acknowledge only the specific violation. + - >- + Acknowledge specified orgPolicy violation and also associated + resource violations. + comment: + type: string + description: >- + Required. Business justification explaining the need for violation + acknowledgement + nonCompliantOrgPolicy: + type: string + description: >- + Optional. This field is deprecated and will be removed in future + version of the API. Name of the OrgPolicy which was modified with + non-compliant change and resulted in this violation. Format: + projects/{project_number}/policies/{constraint_name} + folders/{folder_id}/policies/{constraint_name} + organizations/{organization_id}/policies/{constraint_name} + deprecated: true + description: Request for acknowledging the violation + id: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest + type: object + GoogleCloudAssuredworkloadsV1MoveAnalysisGroup: + type: object + properties: + analysisResult: + description: Result of a successful analysis. + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1MoveAnalysisResult' + displayName: + type: string + description: Name of the analysis group. + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Error details for a failed analysis. + id: GoogleCloudAssuredworkloadsV1MoveAnalysisGroup + description: >- + Represents a logical group of checks performed for an asset. If + successful, the group contains the analysis result, otherwise it + contains an error with the failure reason. + GoogleCloudAssuredworkloadsV1ViolationExceptionContext: + properties: comment: + type: string description: >- Business justification provided towards the acknowledgement of the violation. + userName: + description: >- + Name of the user (or service account) who acknowledged the + violation. type: string acknowledgementTime: + format: google-datetime description: Timestamp when the violation was acknowledged. type: string - format: google-datetime description: Violation exception detail. + type: object + id: GoogleCloudAssuredworkloadsV1ViolationExceptionContext + GoogleProtobufEmpty: + properties: {} + type: object + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } parameters: - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + alt: + description: Data format for response. in: query - name: fields + name: alt schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + enum: + - json + - media + - proto + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: oauth_token + name: upload_protocol schema: type: string callback: @@ -1190,22 +1184,15 @@ components: name: callback schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - alt: - description: Data format for response. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: alt + name: quotaUser schema: type: string - enum: - - json - - media - - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -1215,48 +1202,61 @@ components: name: key schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' x-stackQL-resources: operations: id: google.assuredworkloads.operations name: operations title: Operations methods: - get: + list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + objectKey: $.operations + get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] violations: id: google.assuredworkloads.violations @@ -1277,23 +1277,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}~1violations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.violations - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/violations/methods/get' - $ref: '#/components/x-stackQL-resources/violations/methods/list' insert: [] update: [] + replace: [] delete: [] workloads: id: google.assuredworkloads.workloads @@ -1307,6 +1305,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' delete: operation: $ref: >- @@ -1321,49 +1326,39 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: + create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.workloads list: - operation: *ref_5 - response: *ref_6 - create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads/get response: mediaType: application/json openAPIDocKey: '200' - mutate_partner_permissions: + objectKey: $.workloads + enable_resource_monitoring: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:mutatePartnerPermissions/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post response: mediaType: application/json openAPIDocKey: '200' - enable_resource_monitoring: + analyze_workload_move: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:enableResourceMonitoring/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:analyzeWorkloadMove/get response: mediaType: application/json openAPIDocKey: '200' - analyze_workload_move: + mutate_partner_permissions: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:analyzeWorkloadMove/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1workloads~1{workloadsId}:mutatePartnerPermissions/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1375,28 +1370,28 @@ components: - $ref: '#/components/x-stackQL-resources/workloads/methods/create' update: - $ref: '#/components/x-stackQL-resources/workloads/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/workloads/methods/delete' paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: - parameters: &ref_7 - - $ref: '#/components/parameters/_.xgafv' + /v1/organizations/{organizationsId}/locations/{locationsId}/operations: + parameters: &ref_1 - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: assuredworkloads.organizations.locations.operations.get + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: assuredworkloads.organizations.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1408,7 +1403,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId @@ -1420,18 +1415,27 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/operations: - parameters: *ref_7 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: assuredworkloads.organizations.locations.operations.list + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: assuredworkloads.organizations.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1443,7 +1447,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -1455,21 +1459,13 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Retrieves Assured Workload Violation based on ID. operationId: assuredworkloads.organizations.locations.workloads.violations.get @@ -1507,7 +1503,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Acknowledges an existing violation. By acknowledging a violation, users @@ -1557,7 +1553,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists the Violations in the AssuredWorkload Environment. Callers may @@ -1601,25 +1597,25 @@ paths: type: string format: google-datetime - in: query - name: pageToken + name: filter schema: type: string - in: query - name: interval.startTime + name: pageToken schema: type: string - format: google-datetime - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: interval.startTime schema: type: string + format: google-datetime /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Restrict the list of resources allowed in the Workload environment. The @@ -1666,16 +1662,18 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}: - parameters: *ref_7 - delete: + parameters: *ref_1 + patch: description: >- - Deletes the workload. Make sure that workload's direct children are - already in a deleted state, otherwise the request will fail with a - FAILED_PRECONDITION error. In addition to - assuredworkloads.workload.delete permission, the user should also have - orgpolicy.policy.set permission on the deleted folder to remove Assured - Workloads OrgPolicies. - operationId: assuredworkloads.organizations.locations.workloads.delete + Updates an existing workload. Currently allows updating of workload + display_name and labels. For force updates don't set etag field in the + Workload. Only one update operation per workload can be in progress. + operationId: assuredworkloads.organizations.locations.workloads.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1687,7 +1685,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1705,51 +1703,19 @@ paths: schema: type: string - in: query - name: etag - schema: - type: string - get: - description: Gets Assured Workload associated with a CRM Node - operationId: assuredworkloads.organizations.locations.workloads.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: workloadsId - required: true + name: updateMask schema: type: string - patch: + format: google-fieldmask + delete: description: >- - Updates an existing workload. Currently allows updating of workload - display_name and labels. For force updates don't set etag field in the - Workload. Only one update operation per workload can be in progress. - operationId: assuredworkloads.organizations.locations.workloads.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + Deletes the workload. Make sure that workload's direct children are + already in a deleted state, otherwise the request will fail with a + FAILED_PRECONDITION error. In addition to + assuredworkloads.workload.delete permission, the user should also have + orgpolicy.policy.set permission on the deleted folder to remove Assured + Workloads OrgPolicies. + operationId: assuredworkloads.organizations.locations.workloads.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1761,7 +1727,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -1779,15 +1745,12 @@ paths: schema: type: string - in: query - name: updateMask + name: etag schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads: - parameters: *ref_7 get: - description: Lists Assured Workloads under a CRM Node. - operationId: assuredworkloads.organizations.locations.workloads.list + description: Gets Assured Workload associated with a CRM Node + operationId: assuredworkloads.organizations.locations.workloads.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1799,8 +1762,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1ListWorkloadsResponse + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' parameters: - in: path name: organizationsId @@ -1812,19 +1774,13 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: workloadsId + required: true schema: type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads: + parameters: *ref_1 post: description: Creates Assured Workload. operationId: assuredworkloads.organizations.locations.workloads.create @@ -1860,21 +1816,9 @@ paths: name: externalId schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: - parameters: *ref_7 - patch: - description: >- - Update the permissions settings for an existing partner workload. For - force updates don't set etag field in the Workload. Only one update - operation per workload can be in progress. - operationId: >- - assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + get: + description: Lists Assured Workloads under a CRM Node. + operationId: assuredworkloads.organizations.locations.workloads.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1886,7 +1830,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1ListWorkloadsResponse parameters: - in: path name: organizationsId @@ -1898,13 +1843,21 @@ paths: required: true schema: type: string - - in: path - name: workloadsId - required: true + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring: - parameters: *ref_7 + parameters: *ref_1 post: description: Enable resource violation monitoring for a workload. operationId: >- @@ -1939,7 +1892,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Analyzes a hypothetical move of a source resource to a target workload @@ -1976,7 +1929,7 @@ paths: schema: type: string - in: query - name: assetTypes + name: project schema: type: string - in: query @@ -1985,10 +1938,53 @@ paths: type: integer format: int32 - in: query - name: project + name: assetTypes schema: type: string - in: query name: pageToken schema: type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions: + parameters: *ref_1 + patch: + description: >- + Update the permissions settings for an existing partner workload. For + force updates don't set etag field in the Workload. Only one update + operation per workload can be in progress. + operationId: >- + assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudAssuredworkloadsV1Workload' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml b/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml index 23253b96..fae80a6a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/backupdr.yaml @@ -7,8 +7,8 @@ info: title: Backup and DR Service API description: '' version: v1 - x-discovery-doc-revision: '20240522' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/backup-disaster-recovery servers: @@ -485,7 +485,7 @@ components: managementServers: description: >- The list of ManagementServer instances in the project for the - specified location. If the `{location}` value in the request is "-", + specified location. If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' @@ -599,7 +599,7 @@ components: description: >- Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the - value that should be provided in the ‘aud’ field of the OIDC ID + value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken). readOnly: true @@ -695,163 +695,2903 @@ components: Providers. readOnly: true type: string - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. + BackupVault: + id: BackupVault + description: Message describing a BackupVault object. type: object properties: - locations: + name: + description: Output only. Identifier. The resource name. + readOnly: true + type: string + description: description: >- - A list of locations that matches the specified filter in the - request. + Optional. The description of the BackupVault instance (2048 + characters or less). + type: string + labels: + description: >- + Optional. Resource labels to represent user provided metadata. No + labels currently defined: + type: object + additionalProperties: + type: string + createTime: + description: Output only. The time when the instance was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the instance was updated. + readOnly: true + type: string + format: google-datetime + backupMinimumEnforcedRetentionDuration: + description: >- + Required. The default and minimum enforced retention for each backup + within the backup vault. The enforced retention for each backup can + be extended. + type: string + format: google-duration + deletable: + description: >- + Output only. Set to true when there are no backups nested under this + resource. + readOnly: true + type: boolean + etag: + description: >- + Optional. Server specified ETag for the backup vault resource to + prevent simultaneous updates from overwiting each other. + type: string + state: + description: Output only. The BackupVault resource instance state. + readOnly: true + type: string + enumDescriptions: + - State not set. + - The backup vault is being created. + - The backup vault has been created and is fully usable. + - The backup vault is being deleted. + - The backup vault is experiencing an issue and might be unusable. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - ERROR + effectiveTime: + description: Optional. Time after which the BackupVault resource is locked. + type: string + format: google-datetime + backupCount: + description: Output only. The number of backups in this backup vault. + readOnly: true + type: string + format: int64 + serviceAccount: + description: >- + Output only. Service account used by the BackupVault Service for + this BackupVault. The user should grant this account permissions in + their workload project to enable the service to run backups and + restores there. + readOnly: true + type: string + totalStoredBytes: + description: Output only. Total size of the storage used by all backup resources. + readOnly: true + type: string + format: int64 + uid: + description: >- + Output only. Output only Immutable after resource creation until + resource deletion. + readOnly: true + type: string + annotations: + description: >- + Optional. User annotations. See + https://google.aip.dev/128#annotations Stores small amounts of + arbitrary data. + type: object + additionalProperties: + type: string + ListBackupVaultsResponse: + id: ListBackupVaultsResponse + description: Response message for listing BackupVaults. + type: object + properties: + backupVaults: + description: >- + The list of BackupVault instances in the project for the specified + location. If the '{location}' value in the request is "-", the + response contains a list of instances from all locations. In case + any location is unreachable, the response will only return backup + vaults in reachable locations and the 'unreachable' field will be + populated with a list of unreachable locations. type: array items: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/BackupVault' nextPageToken: - description: The standard List next-page token. + description: A token identifying a page of results the server should return. type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + FetchUsableBackupVaultsResponse: + id: FetchUsableBackupVaultsResponse + description: Response message for fetching usable BackupVaults. type: object properties: - name: + backupVaults: description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + The list of BackupVault instances in the project for the specified + location. If the '{location}' value in the request is "-", the + response contains a list of instances from all locations. In case + any location is unreachable, the response will only return backup + vaults in reachable locations and the 'unreachable' field will be + populated with a list of unreachable locations. + type: array + items: + $ref: '#/components/schemas/BackupVault' + nextPageToken: + description: A token identifying a page of results the server should return. type: string - displayName: + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + ListDataSourcesResponse: + id: ListDataSourcesResponse + description: Response message for listing DataSources. + type: object + properties: + dataSources: description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". + The list of DataSource instances in the project for the specified + location. If the '{location}' value in the request is "-", the + response contains a list of instances from all locations. In case + any location is unreachable, the response will only return data + sources in reachable locations and the 'unreachable' field will be + populated with a list of unreachable locations. + type: array + items: + $ref: '#/components/schemas/DataSource' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + DataSource: + id: DataSource + description: >- + Message describing a DataSource object. Datasource object used to + represent Datasource details for both admin and basic view. + type: object + properties: + name: + description: Output only. Identifier. The resource name. + readOnly: true + type: string + state: + description: Output only. The DataSource resource instance state. + readOnly: true type: string + enumDescriptions: + - State not set. + - The data source is being created. + - The data source has been created and is fully usable. + - The data source is being deleted. + - The data source is experiencing an issue and might be unusable. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - ERROR labels: description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} + Optional. Resource labels to represent user provided metadata. No + labels currently defined: type: object additionalProperties: type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of the long-running operation. - type: object - properties: createTime: - description: Output only. The time the operation was created. + description: Output only. The time when the instance was created. readOnly: true type: string format: google-datetime - endTime: - description: Output only. The time the operation finished running. + updateTime: + description: Output only. The time when the instance was updated. readOnly: true type: string format: google-datetime - target: + backupCount: + description: Number of backups in the data source. + type: string + format: int64 + etag: description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true + Server specified ETag for the ManagementServer resource to prevent + simultaneous updates from overwiting each other. type: string - verb: - description: Output only. Name of the verb executed by the operation. - readOnly: true + totalStoredBytes: + description: The number of bytes (metadata and data) stored in this datasource. type: string - statusMessage: - description: Output only. Human-readable status of the operation, if any. + format: int64 + configState: + description: Output only. The backup configuration state. readOnly: true type: string - requestedCancellation: + enumDescriptions: + - The possible states of backup configuration. Status not set. + - >- + The data source is actively protected (i.e. there is a + BackupPlanAssociation or Appliance SLA pointing to it) + - >- + The data source is no longer protected (but may have backups under + it) + enum: + - BACKUP_CONFIG_STATE_UNSPECIFIED + - ACTIVE + - PASSIVE + backupConfigInfo: + description: Output only. Details of how the resource is configured for backup. + readOnly: true + $ref: '#/components/schemas/BackupConfigInfo' + dataSourceGcpResource: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + The backed up resource is a Google Cloud resource. The word + 'DataSource' was included in the names to indicate that this is the + representation of the Google Cloud resource used within the + DataSource object. + $ref: '#/components/schemas/DataSourceGcpResource' + dataSourceBackupApplianceApplication: + description: The backed up resource is a backup appliance application. + $ref: '#/components/schemas/DataSourceBackupApplianceApplication' + BackupConfigInfo: + id: BackupConfigInfo + description: >- + BackupConfigInfo has information about how the resource is configured + for Backup and about the most recent backup to this vault. + type: object + properties: + lastBackupState: + description: Output only. The status of the last backup to this BackupVault readOnly: true - type: boolean - apiVersion: - description: Output only. API version used to start the operation. + type: string + enumDescriptions: + - Status not set. + - The first backup has not yet completed + - The most recent backup was successful + - The most recent backup failed + - >- + The most recent backup could not be run/failed because of the lack + of permissions + enum: + - LAST_BACKUP_STATE_UNSPECIFIED + - FIRST_BACKUP_PENDING + - SUCCEEDED + - FAILED + - PERMISSION_DENIED + lastSuccessfulBackupConsistencyTime: + description: >- + Output only. If the last backup were successful, this field has the + consistency date. readOnly: true type: string - additionalInfo: + format: google-datetime + lastBackupError: description: >- - Output only. AdditionalInfo contains additional Info related to - backup plan association resource. + Output only. If the last backup failed, this field has the error + message. readOnly: true - type: object - additionalProperties: + $ref: '#/components/schemas/Status' + gcpBackupConfig: + description: Configuration for a Google Cloud resource. + $ref: '#/components/schemas/GcpBackupConfig' + backupApplianceBackupConfig: + description: Configuration for an application backed up by a Backup Appliance. + $ref: '#/components/schemas/BackupApplianceBackupConfig' + GcpBackupConfig: + id: GcpBackupConfig + description: >- + GcpBackupConfig captures the Backup configuration details for Google + Cloud resources. All Google Cloud resources regardless of type are + protected with backup plan associations. + type: object + properties: + backupPlan: + description: The name of the backup plan. + type: string + backupPlanDescription: + description: The description of the backup plan. + type: string + backupPlanAssociation: + description: The name of the backup plan association. + type: string + backupPlanRules: + description: The names of the backup plan rules which point to this backupvault + type: array + items: type: string - parameters: - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - key: + BackupApplianceBackupConfig: + id: BackupApplianceBackupConfig description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - quotaUser: + BackupApplianceBackupConfig captures the backup configuration for + applications that are protected by Backup Appliances. + type: object + properties: + backupApplianceName: + description: The name of the backup appliance. + type: string + backupApplianceId: + description: The ID of the backup appliance. + type: string + format: int64 + slaId: + description: The ID of the SLA of this application. + type: string + format: int64 + applicationName: + description: The name of the application. + type: string + hostName: + description: The name of the host where the application is running. + type: string + sltName: + description: The name of the SLT associated with the application. + type: string + slpName: + description: The name of the SLP associated with the application. + type: string + DataSourceGcpResource: + id: DataSourceGcpResource description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string + DataSourceGcpResource is used for protected resources that are Google + Cloud Resources. This name is easeier to understand than + GcpResourceDataSource or GcpDataSourceResource + type: object + properties: + gcpResourcename: + description: >- + Output only. Full resource pathname URL of the source Google Cloud + resource. + readOnly: true + type: string + location: + description: 'Location of the resource: //"global"/"unspecified".' + type: string + type: + description: >- + The type of the Google Cloud resource. Use the Unified Resource + Type, eg. compute.googleapis.com/Instance. + type: string + computeInstanceDatasourceProperties: + description: >- + ComputeInstanceDataSourceProperties has a subset of Compute Instance + properties that are useful at the Datasource level. + $ref: '#/components/schemas/ComputeInstanceDataSourceProperties' + ComputeInstanceDataSourceProperties: + id: ComputeInstanceDataSourceProperties + description: >- + ComputeInstanceDataSourceProperties represents the properties of a + ComputeEngine resource that are stored in the DataSource. + type: object + properties: + name: + description: Name of the compute instance backed up by the datasource. + type: string + description: + description: The description of the Compute Engine instance. + type: string + machineType: + description: The machine type of the instance. + type: string + totalDiskCount: + description: The total number of disks attached to the Instance. + type: string + format: int64 + totalDiskSizeGb: + description: The sum of all the disk sizes. + type: string + format: int64 + DataSourceBackupApplianceApplication: + id: DataSourceBackupApplianceApplication + description: >- + BackupApplianceApplication describes a Source Resource when it is an + application backed up by a BackupAppliance. + type: object + properties: + applicationName: + description: The name of the Application as known to the Backup Appliance. + type: string + backupAppliance: + description: Appliance name. + type: string + applianceId: + description: Appliance Id of the Backup Appliance. + type: string + format: int64 + type: + description: The type of the application. e.g. VMBackup + type: string + applicationId: + description: The appid field of the application within the Backup Appliance. + type: string + format: int64 + hostname: + description: Hostname of the host where the application is running. + type: string + hostId: + description: Hostid of the application host. + type: string + format: int64 + RemoveDataSourceRequest: + id: RemoveDataSourceRequest + description: Message for deleting a DataSource. + type: object + properties: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + SetInternalStatusRequest: + id: SetInternalStatusRequest + description: Request message for SetStatusInternal method. + type: object + properties: + value: + description: >- + Required. The value required for this method to work. This field + must be the 32-byte SHA256 hash of the DataSourceID. The + DataSourceID used here is only the final piece of the fully + qualified resource path for this DataSource (i.e. the part after + '.../dataSources/'). This field exists to make this method difficult + to call since it is intended for use only by Backup Appliances. + type: string + format: byte + backupConfigState: + description: >- + Required. Output only. The new BackupConfigState to set for the + DataSource. + readOnly: true + type: string + enumDescriptions: + - The possible states of backup configuration. Status not set. + - >- + The data source is actively protected (i.e. there is a + BackupPlanAssociation or Appliance SLA pointing to it) + - >- + The data source is no longer protected (but may have backups under + it) + enum: + - BACKUP_CONFIG_STATE_UNSPECIFIED + - ACTIVE + - PASSIVE + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. The request ID must be a valid UUID with the + exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + InitiateBackupRequest: + id: InitiateBackupRequest + description: request message for InitiateBackup. + type: object + properties: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes since the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + backupId: + description: Required. Resource ID of the Backup resource. + type: string + InitiateBackupResponse: + id: InitiateBackupResponse + description: Response message for InitiateBackup. + type: object + properties: + backup: + description: The name of the backup that was created. + type: string + newBackupGenerationId: + description: The generation id of the new backup. + type: integer + format: int32 + baseBackupGenerationId: + description: >- + The generation id of the base backup. It is needed for the + incremental backups. + type: integer + format: int32 + AbandonBackupRequest: + id: AbandonBackupRequest + description: request message for AbandonBackup. + type: object + properties: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes since the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + FinalizeBackupRequest: + id: FinalizeBackupRequest + description: Message for finalizing a Backup. + type: object + properties: + description: + description: >- + This will be assigned to the description field of the newly created + Backup. + type: string + consistencyTime: + description: >- + The point in time when this backup was captured from the source. + This will be assigned to the consistency_time field of the newly + created Backup. + type: string + format: google-datetime + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + backupId: + description: >- + Required. Resource ID of the Backup resource to be finalized. This + must be the same backup_id that was used in the + InitiateBackupRequest. + type: string + recoveryRangeStartTime: + description: >- + The earliest timestamp of data available in this Backup. This will + set on the newly created Backup. + type: string + format: google-datetime + recoveryRangeEndTime: + description: >- + The latest timestamp of data available in this Backup. This will be + set on the newly created Backup. + type: string + format: google-datetime + retentionDuration: + description: >- + The ExpireTime on the backup will be set to FinalizeTime plus this + duration. If the resulting ExpireTime is less than + EnforcedRetentionEndTime, then ExpireTime is set to + EnforcedRetentionEndTime. + type: string + format: google-duration + FetchAccessTokenRequest: + id: FetchAccessTokenRequest + description: Request message for FetchAccessToken. + type: object + properties: + generationId: + description: Required. The generation of the backup to update. + type: integer + format: int32 + FetchAccessTokenResponse: + id: FetchAccessTokenResponse + description: Response message for FetchAccessToken. + type: object + properties: + readLocation: + description: The location in bucket that can be used for reading. + type: string + writeLocation: + description: The location in bucket that can be used for writing. + type: string + token: + description: The downscoped token that was created. + type: string + expireTime: + description: The token is valid until this time. + type: string + format: google-datetime + ListBackupsResponse: + id: ListBackupsResponse + description: Response message for listing Backups. + type: object + properties: + backups: + description: >- + The list of Backup instances in the project for the specified + location. If the '{location}' value in the request is "-", the + response contains a list of instances from all locations. In case + any location is unreachable, the response will only return data + sources in reachable locations and the 'unreachable' field will be + populated with a list of unreachable locations. + type: array + items: + $ref: '#/components/schemas/Backup' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + Backup: + id: Backup + description: Message describing a Backup object. + type: object + properties: + name: + description: Output only. Identifier. Name of the resource. + readOnly: true + type: string + description: + description: >- + Output only. The description of the Backup instance (2048 characters + or less). + readOnly: true + type: string + createTime: + description: Output only. The time when the instance was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the instance was updated. + readOnly: true + type: string + format: google-datetime + labels: + description: >- + Optional. Resource labels to represent user provided metadata. No + labels currently defined. + type: object + additionalProperties: + type: string + enforcedRetentionEndTime: + description: Optional. The backup can not be deleted before this time. + type: string + format: google-datetime + expireTime: + description: Optional. When this backup is automatically expired. + type: string + format: google-datetime + consistencyTime: + description: >- + Output only. The point in time when this backup was captured from + the source. + readOnly: true + type: string + format: google-datetime + etag: + description: >- + Optional. Server specified ETag to prevent updates from overwriting + each other. + type: string + state: + description: Output only. The Backup resource instance state. + readOnly: true + type: string + enumDescriptions: + - State not set. + - The backup is being created. + - The backup has been created and is fully usable. + - The backup is being deleted. + - The backup is experiencing an issue and might be unusable. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - ERROR + serviceLocks: + description: >- + Output only. The list of BackupLocks taken by the service to prevent + the deletion of the backup. + readOnly: true + type: array + items: + $ref: '#/components/schemas/BackupLock' + backupApplianceLocks: + description: >- + Optional. The list of BackupLocks taken by the accessor Backup + Appliance. + type: array + items: + $ref: '#/components/schemas/BackupLock' + computeInstanceBackupProperties: + description: Output only. Compute Engine specific backup properties. + readOnly: true + $ref: '#/components/schemas/ComputeInstanceBackupProperties' + backupApplianceBackupProperties: + description: Output only. Backup Appliance specific backup properties. + readOnly: true + $ref: '#/components/schemas/BackupApplianceBackupProperties' + backupType: + description: Output only. Type of the backup, unspecified, scheduled or ondemand. + readOnly: true + type: string + enumDescriptions: + - Backup type is unspecified. + - Scheduled backup. + - On demand backup. + enum: + - BACKUP_TYPE_UNSPECIFIED + - SCHEDULED + - ON_DEMAND + gcpBackupPlanInfo: + description: Output only. Configuration for a Google Cloud resource. + readOnly: true + $ref: '#/components/schemas/GCPBackupPlanInfo' + resourceSizeBytes: + description: >- + Output only. source resource size in bytes at the time of the + backup. + readOnly: true + type: string + format: int64 + BackupLock: + id: BackupLock + description: >- + BackupLock represents a single lock on a Backup resource. An unexpired + lock on a Backup prevents the Backup from being deleted. + type: object + properties: + lockUntilTime: + description: >- + Required. The time after which this lock is not considered valid and + will no longer protect the Backup from deletion. + type: string + format: google-datetime + backupApplianceLockInfo: + description: >- + If the client is a backup and recovery appliance, this contains + metadata about why the lock exists. + $ref: '#/components/schemas/BackupApplianceLockInfo' + serviceLockInfo: + description: >- + Output only. Contains metadata about the lock exist for Google Cloud + native backups. + readOnly: true + $ref: '#/components/schemas/ServiceLockInfo' + BackupApplianceLockInfo: + id: BackupApplianceLockInfo + description: >- + BackupApplianceLockInfo contains metadata about the backupappliance that + created the lock. + type: object + properties: + backupApplianceId: + description: >- + Required. The ID of the backup/recovery appliance that created this + lock. + type: string + format: int64 + backupApplianceName: + description: >- + Required. The name of the backup/recovery appliance that created + this lock. + type: string + lockReason: + description: >- + Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. + The value of this string is only meaningful to the client and it is + not interpreted by the BackupVault service. + type: string + jobName: + description: >- + The job name on the backup/recovery appliance that created this + lock. + type: string + backupImage: + description: The image name that depends on this Backup. + type: string + slaId: + description: The SLA on the backup/recovery appliance that owns the lock. + type: string + format: int64 + ServiceLockInfo: + id: ServiceLockInfo + description: >- + ServiceLockInfo represents the details of a lock taken by the service on + a Backup resource. + type: object + properties: + operation: + description: >- + Output only. The name of the operation that created this lock. The + lock will automatically be released when the operation completes. + readOnly: true + type: string + ComputeInstanceBackupProperties: + id: ComputeInstanceBackupProperties + description: >- + ComputeInstanceBackupProperties represents Compute Engine instance + backup properties. + type: object + properties: + description: + description: >- + An optional text description for the instances that are created from + these properties. + type: string + tags: + description: >- + A list of tags to apply to the instances that are created from these + properties. The tags identify valid sources or targets for network + firewalls. The setTags method can modify this list of tags. Each tag + within the list must comply with RFC1035 + (https://www.ietf.org/rfc/rfc1035.txt). + $ref: '#/components/schemas/Tags' + machineType: + description: >- + The machine type to use for instances that are created from these + properties. + type: string + canIpForward: + description: >- + Enables instances created based on these properties to send packets + with source IP addresses other than their own and receive packets + with destination IP addresses other than their own. If these + instances will be used as an IP gateway or it will be set as the + next-hop in a Route resource, specify `true`. If unsure, leave this + set to `false`. See the + https://cloud.google.com/vpc/docs/using-routes#canipforward + documentation for more information. + type: boolean + networkInterface: + description: An array of network access configurations for this interface. + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + disk: + description: >- + An array of disks that are associated with the instances that are + created from these properties. + type: array + items: + $ref: '#/components/schemas/AttachedDisk' + metadata: + description: >- + The metadata key/value pairs to assign to instances that are created + from these properties. These pairs can consist of custom metadata or + predefined keys. See + https://cloud.google.com/compute/docs/metadata/overview for more + information. + $ref: '#/components/schemas/Metadata' + serviceAccount: + description: >- + A list of service accounts with specified scopes. Access tokens for + these service accounts are available to the instances that are + created from these properties. Use metadata queries to obtain the + access tokens for these instances. + type: array + items: + $ref: '#/components/schemas/ServiceAccount' + scheduling: + description: >- + Specifies the scheduling options for the instances that are created + from these properties. + $ref: '#/components/schemas/Scheduling' + guestAccelerator: + description: >- + A list of guest accelerator cards' type and count to use for + instances created from these properties. + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + minCpuPlatform: + description: >- + Minimum cpu/platform to be used by instances. The instance may be + scheduled on the specified or newer cpu/platform. Applicable values + are the friendly names of CPU platforms, such as `minCpuPlatform: + Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more + information, read + https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + type: string + keyRevocationActionType: + description: >- + KeyRevocationActionType of the instance. Supported options are + "STOP" and "NONE". The default value is "NONE" if it is not + specified. + type: string + enumDescriptions: + - Default value. This value is unused. + - Indicates user chose no operation. + - Indicates user chose to opt for VM shutdown on key revocation. + enum: + - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED + - NONE + - STOP + sourceInstance: + description: >- + The source instance used to create this backup. This can be a + partial or full URL to the resource. For example, the following are + valid values: + -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance + -projects/project/zones/zone/instances/instance + type: string + labels: + description: Labels to apply to instances that are created from these properties. + type: object + additionalProperties: + type: string + Tags: + id: Tags + description: A set of instance tags. + type: object + properties: + items: + description: >- + Optional. An array of tags. Each tag must be 1-63 characters long, + and comply with RFC1035. + type: array + items: + type: string + NetworkInterface: + id: NetworkInterface + description: A network interface resource attached to an instance. s + type: object + properties: + network: + description: Optional. URL of the VPC network resource for this instance. + type: string + subnetwork: + description: Optional. The URL of the Subnetwork resource for this instance. + type: string + networkIP: + description: >- + Optional. An IPv4 internal IP address to assign to the instance for + this network interface. If not specified by the user, an unused + internal IP is assigned by the system. + type: string + ipv6Address: + description: >- + Optional. An IPv6 internal network address for this network + interface. To use a static internal IP address, it must be unused + and in the same region as the instance's zone. If not specified, + Google Cloud will automatically assign an internal IPv6 address from + the instance's subnetwork. + type: string + internalIpv6PrefixLength: + description: Optional. The prefix length of the primary internal IPv6 range. + type: integer + format: int32 + name: + description: >- + Output only. [Output Only] The name of the network interface, which + is generated by the server. + readOnly: true + type: string + accessConfigs: + description: >- + Optional. An array of configurations for this interface. Currently, + only one access config,ONE_TO_ONE_NAT is supported. If there are no + accessConfigs specified, then this instance will have no external + internet access. + type: array + items: + $ref: '#/components/schemas/AccessConfig' + ipv6AccessConfigs: + description: >- + Optional. An array of IPv6 access configurations for this interface. + Currently, only one IPv6 access config, DIRECT_IPV6, is supported. + If there is no ipv6AccessConfig specified, then this instance will + have no external IPv6 Internet access. + type: array + items: + $ref: '#/components/schemas/AccessConfig' + aliasIpRanges: + description: >- + Optional. An array of alias IP ranges for this network interface. + You can only specify this field for network interfaces in VPC + networks. + type: array + items: + $ref: '#/components/schemas/AliasIpRange' + stackType: + description: The stack type for this network interface. + type: string + enumDescriptions: + - Default should be STACK_TYPE_UNSPECIFIED. + - The network interface will be assigned IPv4 address. + - The network interface can have both IPv4 and IPv6 addresses. + enum: + - STACK_TYPE_UNSPECIFIED + - IPV4_ONLY + - IPV4_IPV6 + ipv6AccessType: + description: >- + Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate + whether the IP can be accessed from the Internet. This field is + always inherited from its subnetwork. + type: string + enumDescriptions: + - >- + IPv6 access type not set. Means this network interface hasn't been + turned on IPv6 yet. + - This network interface can have internal IPv6. + - This network interface can have external IPv6. + enum: + - UNSPECIFIED_IPV6_ACCESS_TYPE + - INTERNAL + - EXTERNAL + queueCount: + description: >- + Optional. The networking queue count that's specified by users for + the network interface. Both Rx and Tx queues will be set to this + number. It'll be empty if not specified by the users. + type: integer + format: int32 + nicType: + description: >- + Optional. The type of vNIC to be used on this interface. This may be + gVNIC or VirtioNet. + type: string + enumDescriptions: + - Default should be NIC_TYPE_UNSPECIFIED. + - VIRTIO + - GVNIC + enum: + - NIC_TYPE_UNSPECIFIED + - VIRTIO_NET + - GVNIC + networkAttachment: + description: >- + Optional. The URL of the network attachment that this interface + should connect to in the following format: + projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. + type: string + AccessConfig: + id: AccessConfig + description: >- + An access configuration attached to an instance's network interface. + Only one access config per instance is supported. + type: object + properties: + type: + description: >- + Optional. In accessConfigs (IPv4), the default and only option is + ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is + DIRECT_IPV6. + type: string + enumDescriptions: + - Default value. This value is unused. + - ONE_TO_ONE_NAT + - Direct IPv6 access. + enum: + - ACCESS_TYPE_UNSPECIFIED + - ONE_TO_ONE_NAT + - DIRECT_IPV6 + name: + description: Optional. The name of this access configuration. + type: string + natIP: + description: Optional. The external IP address of this access configuration. + type: string + externalIpv6: + description: Optional. The external IPv6 address of this access configuration. + type: string + externalIpv6PrefixLength: + description: Optional. The prefix length of the external IPv6 range. + type: integer + format: int32 + setPublicPtr: + description: >- + Optional. Specifies whether a public DNS 'PTR' record should be + created to map the external IP address of the instance to a DNS + domain name. + type: boolean + publicPtrDomainName: + description: Optional. The DNS domain name for the public PTR record. + type: string + networkTier: + description: >- + Optional. This signifies the networking tier used for configuring + this access + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + High quality, Google-grade network tier, support for all + networking products. + - >- + Public internet quality, only limited support for other networking + products. + enum: + - NETWORK_TIER_UNSPECIFIED + - PREMIUM + - STANDARD + AliasIpRange: + id: AliasIpRange + description: An alias IP range attached to an instance's network interface. + type: object + properties: + ipCidrRange: + description: Optional. The IP alias ranges to allocate for this interface. + type: string + subnetworkRangeName: + description: >- + Optional. The name of a subnetwork secondary IP range from which to + allocate an IP alias range. If not specified, the primary range of + the subnetwork is used. + type: string + AttachedDisk: + id: AttachedDisk + description: An instance-attached disk resource. + type: object + properties: + initializeParams: + description: Optional. Specifies the parameters to initialize this disk. + $ref: '#/components/schemas/InitializeParams' + deviceName: + description: >- + Optional. This is used as an identifier for the disks. This is the + unique name has to provided to modify disk parameters like disk_name + and replica_zones (in case of RePDs) + type: string + kind: + description: Optional. Type of the resource. + type: string + diskTypeDeprecated: + description: Specifies the type of the disk. + deprecated: true + type: string + enumDescriptions: + - Default value, which is unused. + - A scratch disk type. + - A persistent disk type. + enum: + - DISK_TYPE_UNSPECIFIED + - SCRATCH + - PERSISTENT + mode: + description: Optional. The mode in which to attach this disk. + type: string + enumDescriptions: + - Default value, which is unused. + - >- + Attaches this disk in read-write mode. Only one virtual machine at + a time can be attached to a disk in read-write mode. + - >- + Attaches this disk in read-only mode. Multiple virtual machines + can use a disk in read-only mode at a time. + - >- + The disk is locked for administrative reasons. Nobody else can use + the disk. This mode is used (for example) when taking a snapshot + of a disk to prevent mounting the disk while it is being + snapshotted. + enum: + - DISK_MODE_UNSPECIFIED + - READ_WRITE + - READ_ONLY + - LOCKED + source: + description: >- + Optional. Specifies a valid partial or full URL to an existing + Persistent Disk resource. + type: string + index: + description: >- + Optional. A zero-based index to this disk, where 0 is reserved for + the boot disk. + type: string + format: int64 + boot: + description: >- + Optional. Indicates that this is a boot disk. The virtual machine + will use the first partition of the disk for its root filesystem. + type: boolean + autoDelete: + description: >- + Optional. Specifies whether the disk will be auto-deleted when the + instance is deleted (but not when the disk is detached from the + instance). + type: boolean + license: + description: Optional. Any valid publicly visible licenses. + type: array + items: + type: string + diskInterface: + description: >- + Optional. Specifies the disk interface to use for attaching this + disk. + type: string + enumDescriptions: + - Default value, which is unused. + - SCSI Disk Interface. + - NVME Disk Interface. + - NVDIMM Disk Interface. + - ISCSI Disk Interface. + enum: + - DISK_INTERFACE_UNSPECIFIED + - SCSI + - NVME + - NVDIMM + - ISCSI + guestOsFeature: + description: >- + Optional. A list of features to enable on the guest operating + system. Applicable only for bootable images. + type: array + items: + $ref: '#/components/schemas/GuestOsFeature' + diskEncryptionKey: + description: >- + Optional. Encrypts or decrypts a disk using a customer-supplied + encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + diskSizeGb: + description: Optional. The size of the disk in GB. + type: string + format: int64 + savedState: + description: Optional. Output only. The state of the disk. + readOnly: true + type: string + enumDescriptions: + - Default Disk state has not been preserved. + - Disk state has been preserved. + enum: + - DISK_SAVED_STATE_UNSPECIFIED + - PRESERVED + diskType: + description: >- + Optional. Output only. The URI of the disk type resource. For + example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + readOnly: true + type: string + type: + description: Optional. Specifies the type of the disk. + type: string + enumDescriptions: + - Default value, which is unused. + - A scratch disk type. + - A persistent disk type. + enum: + - DISK_TYPE_UNSPECIFIED + - SCRATCH + - PERSISTENT + InitializeParams: + id: InitializeParams + description: Specifies the parameters to initialize this disk. + type: object + properties: + diskName: + description: >- + Optional. Specifies the disk name. If not specified, the default is + to use the name of the instance. + type: string + replicaZones: + description: >- + Optional. URL of the zone where the disk should be created. Required + for each regional disk associated with the instance. + type: array + items: + type: string + GuestOsFeature: + id: GuestOsFeature + description: Feature type of the Guest OS. + type: object + properties: + type: + description: The ID of a supported feature. + type: string + enumDescriptions: + - Default value, which is unused. + - VIRTIO_SCSI_MULTIQUEUE feature type. + - WINDOWS feature type. + - MULTI_IP_SUBNET feature type. + - UEFI_COMPATIBLE feature type. + - SECURE_BOOT feature type. + - GVNIC feature type. + - SEV_CAPABLE feature type. + - BARE_METAL_LINUX_COMPATIBLE feature type. + - SUSPEND_RESUME_COMPATIBLE feature type. + - SEV_LIVE_MIGRATABLE feature type. + - SEV_SNP_CAPABLE feature type. + - TDX_CAPABLE feature type. + - IDPF feature type. + - SEV_LIVE_MIGRATABLE_V2 feature type. + enum: + - FEATURE_TYPE_UNSPECIFIED + - VIRTIO_SCSI_MULTIQUEUE + - WINDOWS + - MULTI_IP_SUBNET + - UEFI_COMPATIBLE + - SECURE_BOOT + - GVNIC + - SEV_CAPABLE + - BARE_METAL_LINUX_COMPATIBLE + - SUSPEND_RESUME_COMPATIBLE + - SEV_LIVE_MIGRATABLE + - SEV_SNP_CAPABLE + - TDX_CAPABLE + - IDPF + - SEV_LIVE_MIGRATABLE_V2 + CustomerEncryptionKey: + id: CustomerEncryptionKey + description: A customer-supplied encryption key. + type: object + properties: + rawKey: + description: Optional. Specifies a 256-bit customer-supplied encryption key. + type: string + rsaEncryptedKey: + description: >- + Optional. RSA-wrapped 2048-bit customer-supplied encryption key to + either encrypt or decrypt this resource. + type: string + kmsKeyName: + description: >- + Optional. The name of the encryption key that is stored in Google + Cloud KMS. + type: string + kmsKeyServiceAccount: + description: >- + Optional. The service account being used for the encryption request + for the given KMS key. If absent, the Compute Engine default service + account is used. + type: string + Metadata: + id: Metadata + description: A metadata key/value entry. + type: object + properties: + items: + description: >- + Optional. Array of key/value pairs. The total size of all keys and + values must be less than 512 KB. + type: array + items: + $ref: '#/components/schemas/Entry' + Entry: + id: Entry + description: A key/value pair to be used for storing metadata. + type: object + properties: + key: + description: Optional. Key for the metadata entry. + type: string + value: + description: >- + Optional. Value for the metadata entry. These are free-form strings, + and only have meaning as interpreted by the image running in the + instance. The only restriction placed on values is that their size + must be less than or equal to 262144 bytes (256 KiB). + type: string + ServiceAccount: + id: ServiceAccount + description: A service account. + type: object + properties: + email: + description: Optional. Email address of the service account. + type: string + scopes: + description: >- + Optional. The list of scopes to be made available for this service + account. + type: array + items: + type: string + Scheduling: + id: Scheduling + description: Sets the scheduling options for an Instance. + type: object + properties: + onHostMaintenance: + description: Optional. Defines the maintenance behavior for this instance. + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + Tells Compute Engine to terminate and (optionally) restart the + instance away from the maintenance activity. + - >- + Default, Allows Compute Engine to automatically migrate instances + out of the way of maintenance events. + enum: + - ON_HOST_MAINTENANCE_UNSPECIFIED + - TERMINATE + - MIGRATE + automaticRestart: + description: >- + Optional. Specifies whether the instance should be automatically + restarted if it is terminated by Compute Engine (not terminated by a + user). + type: boolean + preemptible: + description: Optional. Defines whether the instance is preemptible. + type: boolean + nodeAffinities: + description: >- + Optional. A set of node affinity and anti-affinity configurations. + Overrides reservationAffinity. + type: array + items: + $ref: '#/components/schemas/NodeAffinity' + minNodeCpus: + description: >- + Optional. The minimum number of virtual CPUs this instance will + consume when running on a sole-tenant node. + type: integer + format: int32 + provisioningModel: + description: Optional. Specifies the provisioning model of the instance. + type: string + enumDescriptions: + - Default value. This value is not used. + - Standard provisioning with user controlled runtime, no discounts. + - Heavily discounted, no guaranteed runtime. + enum: + - PROVISIONING_MODEL_UNSPECIFIED + - STANDARD + - SPOT + instanceTerminationAction: + description: Optional. Specifies the termination action for the instance. + type: string + enumDescriptions: + - Default value. This value is unused. + - Delete the VM. + - Stop the VM without storing in-memory content. default action. + enum: + - INSTANCE_TERMINATION_ACTION_UNSPECIFIED + - DELETE + - STOP + localSsdRecoveryTimeout: + description: >- + Optional. Specifies the maximum amount of time a Local Ssd Vm should + wait while recovery of the Local Ssd state is attempted. Its value + should be in between 0 and 168 hours with hour granularity and the + default value being 1 hour. + $ref: '#/components/schemas/SchedulingDuration' + NodeAffinity: + id: NodeAffinity + description: >- + Node Affinity: the configuration of desired nodes onto which this + Instance could be scheduled. + type: object + properties: + key: + description: Optional. Corresponds to the label key of Node resource. + type: string + operator: + description: Optional. Defines the operation of node selection. + type: string + enumDescriptions: + - Default value. This value is unused. + - Requires Compute Engine to seek for matched nodes. + - Requires Compute Engine to avoid certain nodes. + enum: + - OPERATOR_UNSPECIFIED + - IN + - NOT_IN + values: + description: Optional. Corresponds to the label values of Node resource. + type: array + items: + type: string + SchedulingDuration: + id: SchedulingDuration + description: >- + A SchedulingDuration represents a fixed-length span of time represented + as a count of seconds and fractions of seconds at nanosecond resolution. + It is independent of any calendar and concepts like "day" or "month". + Range is approximately 10,000 years. + type: object + properties: + seconds: + description: Optional. Span of time at a resolution of a second. + type: string + format: int64 + nanos: + description: >- + Optional. Span of time that's a fraction of a second at nanosecond + resolution. + type: integer + format: int32 + AcceleratorConfig: + id: AcceleratorConfig + description: >- + A specification of the type and number of accelerator cards attached to + the instance. + type: object + properties: + acceleratorType: + description: >- + Optional. Full or partial URL of the accelerator type resource to + attach to this instance. + type: string + acceleratorCount: + description: >- + Optional. The number of the guest accelerator cards exposed to this + instance. + type: integer + format: int32 + BackupApplianceBackupProperties: + id: BackupApplianceBackupProperties + description: >- + BackupApplianceBackupProperties represents BackupDR backup appliance's + properties. + type: object + properties: + generationId: + description: >- + Output only. The numeric generation ID of the backup (monotonically + increasing). + readOnly: true + type: integer + format: int32 + finalizeTime: + description: >- + Output only. The time when this backup object was finalized (if + none, backup is not finalized). + readOnly: true + type: string + format: google-datetime + recoveryRangeStartTime: + description: Optional. The earliest timestamp of data available in this Backup. + type: string + format: google-datetime + recoveryRangeEndTime: + description: Optional. The latest timestamp of data available in this Backup. + type: string + format: google-datetime + GCPBackupPlanInfo: + id: GCPBackupPlanInfo + description: >- + GCPBackupPlanInfo captures the plan configuration details of Google + Cloud resources at the time of backup. + type: object + properties: + backupPlan: + description: >- + Resource name of backup plan by which workload is protected at the + time of the backup. Format: + projects/{project}/locations/{location}/backupPlans/{backupPlanId} + type: string + backupPlanRuleId: + description: >- + The rule id of the backup plan which triggered this backup in case + of scheduled backup or used for + type: string + RestoreBackupRequest: + id: RestoreBackupRequest + description: Request message for restoring from a Backup. + type: object + properties: + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + computeInstanceTargetEnvironment: + description: Compute Engine target environment to be used during restore. + $ref: '#/components/schemas/ComputeInstanceTargetEnvironment' + computeInstanceRestoreProperties: + description: Compute Engine instance properties to be overridden during restore. + $ref: '#/components/schemas/ComputeInstanceRestoreProperties' + ComputeInstanceTargetEnvironment: + id: ComputeInstanceTargetEnvironment + description: >- + ComputeInstanceTargetEnvironment represents Compute Engine target + environment to be used during restore. + type: object + properties: + project: + description: Required. Target project for the Compute Engine instance. + type: string + zone: + description: Required. The zone of the Compute Engine instance. + type: string + ComputeInstanceRestoreProperties: + id: ComputeInstanceRestoreProperties + description: >- + ComputeInstanceRestoreProperties represents Compute Engine instance + properties to be overridden during restore. + type: object + properties: + name: + description: Required. Name of the compute instance. + type: string + advancedMachineFeatures: + description: Optional. Controls for advanced machine-related behavior features. + $ref: '#/components/schemas/AdvancedMachineFeatures' + canIpForward: + description: >- + Optional. Allows this instance to send and receive packets with + non-matching destination or source IPs. + type: boolean + confidentialInstanceConfig: + description: Optional. Controls Confidential compute options on the instance + $ref: '#/components/schemas/ConfidentialInstanceConfig' + deletionProtection: + description: Optional. Whether the resource should be protected against deletion. + type: boolean + description: + description: >- + Optional. An optional description of this resource. Provide this + property when you create the resource. + type: string + disks: + description: >- + Optional. Array of disks associated with this instance. Persistent + disks must be created before you can assign them. + type: array + items: + $ref: '#/components/schemas/AttachedDisk' + displayDevice: + description: Optional. Enables display device for the instance. + $ref: '#/components/schemas/DisplayDevice' + guestAccelerators: + description: >- + Optional. A list of the type and count of accelerator cards attached + to the instance. + type: array + items: + $ref: '#/components/schemas/AcceleratorConfig' + hostname: + description: >- + Optional. Specifies the hostname of the instance. The specified + hostname must be RFC1035 compliant. If hostname is not specified, + the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when + using the global DNS, and + [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. + type: string + instanceEncryptionKey: + description: >- + Optional. Encrypts suspended data for an instance with a + customer-managed encryption key. + $ref: '#/components/schemas/CustomerEncryptionKey' + keyRevocationActionType: + description: Optional. KeyRevocationActionType of the instance. + type: string + enumDescriptions: + - Default value. This value is unused. + - Indicates user chose no operation. + - Indicates user chose to opt for VM shutdown on key revocation. + enum: + - KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED + - NONE + - STOP + labels: + description: Optional. Labels to apply to this instance. + type: object + additionalProperties: + type: string + machineType: + description: >- + Optional. Full or partial URL of the machine type resource to use + for this instance. + type: string + metadata: + description: Optional. This includes custom metadata and predefined keys. + $ref: '#/components/schemas/Metadata' + minCpuPlatform: + description: Optional. Minimum CPU platform to use for this instance. + type: string + networkInterfaces: + description: >- + Optional. An array of network configurations for this instance. + These specify how interfaces are configured to interact with other + network services, such as connecting to the internet. Multiple + interfaces are supported per instance. + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + networkPerformanceConfig: + description: >- + Optional. Configure network performance such as egress bandwidth + tier. + $ref: '#/components/schemas/NetworkPerformanceConfig' + params: + description: >- + Input only. Additional params passed with the request, but not + persisted as part of resource payload. + $ref: '#/components/schemas/InstanceParams' + privateIpv6GoogleAccess: + description: >- + Optional. The private IPv6 google access type for the VM. If not + specified, use INHERIT_FROM_SUBNETWORK as default. + type: string + enumDescriptions: + - Default value. This value is unused. + - >- + Each network interface inherits PrivateIpv6GoogleAccess from its + subnetwork. + - >- + Outbound private IPv6 access from VMs in this subnet to Google + services. If specified, the subnetwork who is attached to the + instance's default network interface will be assigned an internal + IPv6 prefix if it doesn't have before. + - >- + Bidirectional private IPv6 access to/from Google services. If + specified, the subnetwork who is attached to the instance's + default network interface will be assigned an internal IPv6 prefix + if it doesn't have before. + enum: + - INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED + - INHERIT_FROM_SUBNETWORK + - ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE + - ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE + reservationAffinity: + description: >- + Optional. Specifies the reservations that this instance can consume + from. + $ref: '#/components/schemas/AllocationAffinity' + resourcePolicies: + description: Optional. Resource policies applied to this instance. + type: array + items: + type: string + scheduling: + description: Optional. Sets the scheduling options for this instance. + $ref: '#/components/schemas/Scheduling' + serviceAccounts: + description: >- + Optional. A list of service accounts, with their specified scopes, + authorized for this instance. Only one service account per VM + instance is supported. + type: array + items: + $ref: '#/components/schemas/ServiceAccount' + tags: + description: >- + Optional. Tags to apply to this instance. Tags are used to identify + valid sources or targets for network firewalls and are specified by + the client during instance creation. + $ref: '#/components/schemas/Tags' + AdvancedMachineFeatures: + id: AdvancedMachineFeatures + description: Specifies options for controlling advanced machine features. + type: object + properties: + enableNestedVirtualization: + description: >- + Optional. Whether to enable nested virtualization or not (default is + false). + type: boolean + threadsPerCore: + description: >- + Optional. The number of threads per physical core. To disable + simultaneous multithreading (SMT) set this to 1. If unset, the + maximum number of threads supported per core by the underlying + processor is assumed. + type: integer + format: int32 + visibleCoreCount: + description: >- + Optional. The number of physical cores to expose to an instance. + Multiply by the number of threads per core to compute the total + number of virtual CPUs to expose to the instance. If unset, the + number of cores is inferred from the instance's nominal CPU count + and the underlying platform's SMT width. + type: integer + format: int32 + enableUefiNetworking: + description: Optional. Whether to enable UEFI networking for instance creation. + type: boolean + ConfidentialInstanceConfig: + id: ConfidentialInstanceConfig + description: A set of Confidential Instance options. + type: object + properties: + enableConfidentialCompute: + description: >- + Optional. Defines whether the instance should have confidential + compute enabled. + type: boolean + DisplayDevice: + id: DisplayDevice + description: A set of Display Device options + type: object + properties: + enableDisplay: + description: Optional. Enables display for the Compute Engine VM + type: boolean + NetworkPerformanceConfig: + id: NetworkPerformanceConfig + description: Network performance configuration. + type: object + properties: + totalEgressBandwidthTier: + description: Optional. The tier of the total egress bandwidth. + type: string + enumDescriptions: + - This value is unused. + - Default network performance config. + - Tier 1 network performance config. + enum: + - TIER_UNSPECIFIED + - DEFAULT + - TIER_1 + InstanceParams: + id: InstanceParams + description: Additional instance params. + type: object + properties: + resourceManagerTags: + description: Optional. Resource manager tags to be bound to the instance. + type: object + additionalProperties: + type: string + AllocationAffinity: + id: AllocationAffinity + description: Specifies the reservations that this instance can consume from. + type: object + properties: + consumeReservationType: + description: >- + Optional. Specifies the type of reservation from which this instance + can consume + type: string + enumDescriptions: + - Default value. This value is unused. + - Do not consume from any allocated capacity. + - Consume any allocation available. + - >- + Must consume from a specific reservation. Must specify key value + fields for specifying the reservations. + enum: + - TYPE_UNSPECIFIED + - NO_RESERVATION + - ANY_RESERVATION + - SPECIFIC_RESERVATION + key: + description: Optional. Corresponds to the label key of a reservation resource. + type: string + values: + description: Optional. Corresponds to the label values of a reservation resource. + type: array + items: + type: string + BackupPlan: + id: BackupPlan + description: >- + A `BackupPlan` specifies some common fields, such as `description` as + well as one or more `BackupRule` messages. Each `BackupRule` has a + retention policy and defines a schedule by which the system is to + perform backup workloads. + type: object + properties: + name: + description: >- + Output only. Identifier. The resource name of the `BackupPlan`. + Format: + `projects/{project}/locations/{location}/backupPlans/{backup_plan}` + readOnly: true + type: string + description: + description: >- + Optional. The description of the `BackupPlan` resource. The + description allows for additional details about `BackupPlan` and its + use cases to be provided. An example description is the following: + "This is a backup plan that performs a daily backup at 6pm and + retains data for 3 months". The description must be at most 2048 + characters. + type: string + labels: + description: >- + Optional. This collection of key/value pairs allows for custom + labels to be supplied by the user. Example, {"tag": "Weekly"}. + type: object + additionalProperties: + type: string + createTime: + description: Output only. When the `BackupPlan` was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. When the `BackupPlan` was last updated. + readOnly: true + type: string + format: google-datetime + backupRules: + description: >- + Required. The backup rules for this `BackupPlan`. There must be at + least one `BackupRule` message. + type: array + items: + $ref: '#/components/schemas/BackupRule' + state: + description: Output only. The `State` for the `BackupPlan`. + readOnly: true + type: string + enumDescriptions: + - State not set. + - The resource is being created. + - The resource has been created and is fully usable. + - The resource is being deleted. + - The resource has been created but is not usable. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - INACTIVE + resourceType: + description: >- + Required. The resource type to which the `BackupPlan` will be + applied. Examples include, "compute.googleapis.com/Instance" and + "storage.googleapis.com/Bucket". + type: string + etag: + description: >- + Optional. `etag` is returned from the service in the response. As a + user of the service, you may provide an etag value in this field to + prevent stale resources. + type: string + backupVault: + description: >- + Required. Resource name of backup vault which will be used as + storage location for backups. Format: + projects/{project}/locations/{location}/backupVaults/{backupvault} + type: string + backupVaultServiceAccount: + description: >- + Output only. The Google Cloud Platform Service Account to be used by + the BackupVault for taking backups. Specify the email address of the + Backup Vault Service Account. + readOnly: true + type: string + BackupRule: + id: BackupRule + description: '`BackupRule` binds the backup schedule to a retention policy.' + type: object + properties: + ruleId: + description: >- + Required. Immutable. The unique id of this `BackupRule`. The + `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a + lowercase letter followed by up to 62 lowercase letters, numbers, or + hyphens. Pattern, /a-z{,62}/. + type: string + backupRetentionDays: + description: >- + Required. Configures the duration for which backup data will be + kept. It is defined in “days”. The value should be greater than or + equal to minimum enforced retention of the backup vault. + type: integer + format: int32 + standardSchedule: + description: >- + Required. Defines a schedule that runs within the confines of a + defined window of time. + $ref: '#/components/schemas/StandardSchedule' + StandardSchedule: + id: StandardSchedule + description: >- + `StandardSchedule` defines a schedule that run within the confines of a + defined window of days. We can define recurrence type for schedule as + HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. + type: object + properties: + recurrenceType: + description: Required. Specifies the `RecurrenceType` for the schedule. + type: string + enumDescriptions: + - recurrence type not set + - The `BackupRule` is to be applied hourly. + - The `BackupRule` is to be applied daily. + - The `BackupRule` is to be applied weekly. + - The `BackupRule` is to be applied monthly. + - The `BackupRule` is to be applied yearly. + enum: + - RECURRENCE_TYPE_UNSPECIFIED + - HOURLY + - DAILY + - WEEKLY + - MONTHLY + - YEARLY + hourlyFrequency: + description: >- + Optional. Specifies frequency for hourly backups. A hourly frequency + of 2 means jobs will run every 2 hours from start time till end time + defined. This is required for `recurrence_type`, `HOURLY` and is not + applicable otherwise. A validation error will occur if a value is + supplied and `recurrence_type` is not `HOURLY`. Value of hourly + frequency should be between 6 and 23. Reason for limit : We found + that there is bandwidth limitation of 3GB/S for GMI while taking a + backup and 5GB/S while doing a restore. Given the amount of parallel + backups and restore we are targeting, this will potentially take the + backup time to mins and hours (in worst case scenario). + type: integer + format: int32 + daysOfWeek: + description: >- + Optional. Specifies days of week like, MONDAY or TUESDAY, on which + jobs will run. This is required for `recurrence_type`, `WEEKLY` and + is not applicable otherwise. A validation error will occur if a + value is supplied and `recurrence_type` is not `WEEKLY`. + type: array + items: + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + daysOfMonth: + description: >- + Optional. Specifies days of months like 1, 5, or 14 on which jobs + will run. Values for `days_of_month` are only applicable for + `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will + occur if other values are supplied. + type: array + items: + type: integer + format: int32 + weekDayOfMonth: + description: >- + Optional. Specifies a week day of the month like, FIRST SUNDAY or + LAST MONDAY, on which jobs will run. This will be specified by two + fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one + for the week, e.g. `LAST`. This field is only applicable for + `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will + occur if other values are supplied. + $ref: '#/components/schemas/WeekDayOfMonth' + months: + description: >- + Optional. Specifies the months of year, like `FEBRUARY` and/or + `MAY`, on which jobs will run. This field is only applicable when + `recurrence_type` is `YEARLY`. A validation error will occur if + other values are supplied. + type: array + items: + type: string + enumDescriptions: + - The unspecified month. + - The month of January. + - The month of February. + - The month of March. + - The month of April. + - The month of May. + - The month of June. + - The month of July. + - The month of August. + - The month of September. + - The month of October. + - The month of November. + - The month of December. + enum: + - MONTH_UNSPECIFIED + - JANUARY + - FEBRUARY + - MARCH + - APRIL + - MAY + - JUNE + - JULY + - AUGUST + - SEPTEMBER + - OCTOBER + - NOVEMBER + - DECEMBER + backupWindow: + description: >- + Required. A BackupWindow defines the window of day during which + backup jobs will run. Jobs are queued at the beginning of the window + and will be marked as `NOT_RUN` if they do not start by the end of + the window. Note: running jobs will not be cancelled at the end of + the window. + $ref: '#/components/schemas/BackupWindow' + timeZone: + description: >- + Required. The time zone to be used when interpreting the schedule. + The value of this field must be a time zone name from the IANA tz + database. See + https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the + list of valid timezone names. For e.g., Europe/Paris. + type: string + WeekDayOfMonth: + id: WeekDayOfMonth + description: >- + `WeekDayOfMonth` defines the week day of the month on which the backups + will run. The message combines a `WeekOfMonth` and `DayOfWeek` to + produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. + type: object + properties: + weekOfMonth: + description: Required. Specifies the week of the month. + type: string + enumDescriptions: + - The zero value. Do not use. + - The first week of the month. + - The second week of the month. + - The third week of the month. + - The fourth week of the month. + - The last week of the month. + enum: + - WEEK_OF_MONTH_UNSPECIFIED + - FIRST + - SECOND + - THIRD + - FOURTH + - LAST + dayOfWeek: + description: Required. Specifies the day of the week. + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + BackupWindow: + id: BackupWindow + description: >- + `BackupWindow` defines a window of the day during which backup jobs will + run. + type: object + properties: + startHourOfDay: + description: >- + Required. The hour of day (0-23) when the window starts for e.g. if + value of start hour of day is 6 that mean backup window start at + 6:00. + type: integer + format: int32 + endHourOfDay: + description: >- + Required. The hour of day (1-24) when the window end for e.g. if + value of end hour of day is 10 that mean backup window end time is + 10:00. End hour of day should be greater than start hour of day. 0 + <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not + include in backup window that mean if end_hour_of_day= 10 jobs + should start before 10:00. + type: integer + format: int32 + ListBackupPlansResponse: + id: ListBackupPlansResponse + description: The response message for getting a list of `BackupPlan`. + type: object + properties: + backupPlans: + description: >- + The list of `BackupPlans` in the project for the specified location. + If the `{location}` value in the request is "-", the response + contains a list of resources from all locations. In case any + location is unreachable, the response will only return backup plans + in reachable locations and the 'unreachable' field will be populated + with a list of unreachable locations. BackupPlan + type: array + items: + $ref: '#/components/schemas/BackupPlan' + nextPageToken: + description: >- + A token which may be sent as page_token in a subsequent + `ListBackupPlans` call to retrieve the next page of results. If this + field is omitted or empty, then there are no more results to return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + BackupPlanAssociation: + id: BackupPlanAssociation + description: >- + A BackupPlanAssociation represents a single BackupPlanAssociation which + contains details like workload, backup plan etc + type: object + properties: + name: + description: >- + Output only. Identifier. The resource name of BackupPlanAssociation + in below format Format : + projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId} + readOnly: true + type: string + resourceType: + description: >- + Output only. Output Only. Resource type of workload on which + backupplan is applied + readOnly: true + type: string + resource: + description: >- + Required. Immutable. Resource name of workload on which backupplan + is applied + type: string + backupPlan: + description: >- + Required. Resource name of backup plan which needs to be applied on + workload. Format: + projects/{project}/locations/{location}/backupPlans/{backupPlanId} + type: string + createTime: + description: Output only. The time when the instance was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the instance was updated. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. The BackupPlanAssociation resource state. + readOnly: true + type: string + enumDescriptions: + - State not set. + - The resource is being created. + - The resource has been created and is fully usable. + - The resource is being deleted. + - The resource has been created but is not usable. + enum: + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - DELETING + - INACTIVE + rulesConfigInfo: + description: Output only. The config info related to backup rules. + readOnly: true + type: array + items: + $ref: '#/components/schemas/RuleConfigInfo' + dataSource: + description: >- + Output only. Output Only. Resource name of data source which will be + used as storage location for backups taken. Format : + projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + readOnly: true + type: string + RuleConfigInfo: + id: RuleConfigInfo + description: Message for rules config info. + type: object + properties: + ruleId: + description: Output only. Output Only. Backup Rule id fetched from backup plan. + readOnly: true + type: string + lastBackupState: + description: Output only. The last backup state for rule. + readOnly: true + type: string + enumDescriptions: + - State not set. + - The first backup is pending. + - >- + The most recent backup could not be run/failed because of the lack + of permissions. + - The last backup operation succeeded. + - The last backup operation failed. + enum: + - LAST_BACKUP_STATE_UNSPECIFIED + - FIRST_BACKUP_PENDING + - PERMISSION_DENIED + - SUCCEEDED + - FAILED + lastBackupError: + description: >- + Output only. Output Only. google.rpc.Status object to store the last + backup error. + readOnly: true + $ref: '#/components/schemas/Status' + lastSuccessfulBackupConsistencyTime: + description: >- + Output only. The point in time when the last successful backup was + captured from the source. + readOnly: true + type: string + format: google-datetime + ListBackupPlanAssociationsResponse: + id: ListBackupPlanAssociationsResponse + description: Response message for List BackupPlanAssociation + type: object + properties: + backupPlanAssociations: + description: >- + The list of Backup Plan Associations in the project for the + specified location. If the `{location}` value in the request is "-", + the response contains a list of instances from all locations. In + case any location is unreachable, the response will only return + backup plan associations in reachable locations and the + 'unreachable' field will be populated with a list of unreachable + locations. + type: array + items: + $ref: '#/components/schemas/BackupPlanAssociation' + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string + TriggerBackupRequest: + id: TriggerBackupRequest + description: Request message for triggering a backup. + type: object + properties: + ruleId: + description: Required. backup rule_id for which a backup needs to be triggered. + type: string + requestId: + description: >- + Optional. An optional request ID to identify requests. Specify a + unique request ID so that if you must retry your request, the server + will know to ignore the request if it has already been completed. + The server will guarantee that for at least 60 minutes after the + first request. For example, consider a situation where you make an + initial request and the request times out. If you make the request + again with the same request ID, the server can check if original + operation with the same request ID was received, and if so, will + ignore the second request. This prevents clients from accidentally + creating duplicate commitments. The request ID must be a valid UUID + with the exception that zero UUID is not supported + (00000000-0000-0000-0000-000000000000). + type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to 'Code.CANCELLED'. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + additionalInfo: + description: >- + Output only. AdditionalInfo contains additional Info related to + backup plan association resource. + readOnly: true + type: object + additionalProperties: + type: string + AssetLocation: + id: AssetLocation + description: >- + Provides the mapping of a cloud asset to a direct physical location or + to a proxy that defines the location on its behalf. + type: object + properties: + expected: + description: >- + Defines the customer expectation around ZI/ZS for this asset and + ZI/ZS state of the region at the time of asset creation. + $ref: '#/components/schemas/IsolationExpectations' + locationData: + description: Contains all kinds of physical location definitions for this asset. + type: array + items: + $ref: '#/components/schemas/LocationData' + parentAsset: + description: >- + Defines parents assets if any in order to allow later generation of + child_asset_location data via child assets. + type: array + items: + $ref: '#/components/schemas/CloudAsset' + extraParameters: + description: Defines extra parameters required for specific asset types. + type: array + items: + $ref: '#/components/schemas/ExtraParameter' + ccfeRmsPath: + description: >- + Spanner path of the CCFE RMS database. It is only applicable for + CCFE tenants that use CCFE RMS for storing resource metadata. + type: string + IsolationExpectations: + id: IsolationExpectations + type: object + properties: + zoneIsolation: + description: >- + Deprecated: use zi_org_policy, zi_region_policy and zi_region_state + instead for setting ZI expectations as per + go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zoneSeparation: + description: >- + Deprecated: use zs_org_policy, and zs_region_stateinstead for + setting Zs expectations as per go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking of the asset ZS-bit is not available + - '' + - '' + enum: + - ZS_REGION_UNSPECIFIED + - ZS_REGION_UNKNOWN + - ZS_REGION_NOT_ENABLED + - ZS_REGION_ENABLED + ziOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + ziRegionPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_REGION_POLICY_UNSPECIFIED + - ZI_REGION_POLICY_UNKNOWN + - ZI_REGION_POLICY_NOT_SET + - ZI_REGION_POLICY_FAIL_OPEN + - ZI_REGION_POLICY_FAIL_CLOSED + ziRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZI_REGION_UNSPECIFIED + - ZI_REGION_UNKNOWN + - ZI_REGION_NOT_ENABLED + - ZI_REGION_ENABLED + requirementOverride: + description: >- + Explicit overrides for ZI and ZS requirements to be used for + resources that should be excluded from ZI/ZS verification logic. + $ref: '#/components/schemas/RequirementOverride' + RequirementOverride: + id: RequirementOverride + type: object + properties: + ziOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zsOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + LocationData: + id: LocationData + type: object + properties: + directLocation: + $ref: '#/components/schemas/DirectLocationAssignment' + spannerLocation: + $ref: '#/components/schemas/SpannerLocation' + childAssetLocation: + $ref: '#/components/schemas/CloudAssetComposition' + gcpProjectProxy: + $ref: '#/components/schemas/TenantProjectProxy' + blobstoreLocation: + $ref: '#/components/schemas/BlobstoreLocation' + placerLocation: + $ref: '#/components/schemas/PlacerLocation' + DirectLocationAssignment: + id: DirectLocationAssignment + type: object + properties: + location: + type: array + items: + $ref: '#/components/schemas/LocationAssignment' + LocationAssignment: + id: LocationAssignment + type: object + properties: + location: + type: string + locationType: + type: string + enumDescriptions: + - '' + - '1-10: Physical failure domains.' + - '' + - '11-20: Logical failure domains.' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - CLUSTER + - POP + - CLOUD_ZONE + - CLOUD_REGION + - MULTI_REGION_GEO + - MULTI_REGION_JURISDICTION + - GLOBAL + - OTHER + SpannerLocation: + id: SpannerLocation + type: object + properties: + dbName: + description: Set of databases used by the resource in format /span// + type: array + items: + type: string + backupName: + description: >- + Set of backups used by the resource with name in the same format as + what is available at http://table/spanner_automon.backup_metadata + type: array + items: + type: string + CloudAssetComposition: + id: CloudAssetComposition + type: object + properties: + childAsset: + type: array + items: + $ref: '#/components/schemas/CloudAsset' + CloudAsset: + id: CloudAsset + type: object + properties: + assetType: + type: string + assetName: + type: string + TenantProjectProxy: + id: TenantProjectProxy + type: object + properties: + projectNumbers: + type: array + items: + type: string + BlobstoreLocation: + id: BlobstoreLocation + description: >- + Policy ID that identified data placement in Blobstore as per + go/blobstore-user-guide#data-metadata-placement-and-failure-domains + type: object + properties: + policyId: + type: array + items: + type: string + PlacerLocation: + id: PlacerLocation + description: >- + Message describing that the location of the customer resource is tied to + placer allocations + type: object + properties: + placerConfig: + description: >- + Directory with a config related to it in placer (e.g. + "/placer/prod/home/my-root/my-dir") + type: string + ExtraParameter: + id: ExtraParameter + description: Defines parameters that should only be used for specific asset types. + type: object + properties: + regionalMigDistributionPolicy: + description: >- + Details about zones used by regional + compute.googleapis.com/InstanceGroupManager to create instances. + $ref: '#/components/schemas/RegionalMigDistributionPolicy' + RegionalMigDistributionPolicy: + id: RegionalMigDistributionPolicy + description: >- + To be used for specifying the intended distribution of regional + compute.googleapis.com/InstanceGroupManager instances + type: object + properties: + zones: + description: Cloud zones used by regional MIG to create instances. + type: array + items: + $ref: '#/components/schemas/ZoneConfiguration' + targetShape: + description: >- + The shape in which the group converges around distribution of + resources. Instance of proto2 enum + type: integer + format: int32 + ZoneConfiguration: + id: ZoneConfiguration + type: object + properties: + zone: + type: string + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query @@ -879,160 +3619,486 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/locations/methods/get' + - $ref: '#/components/x-stackQL-resources/locations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + management_servers_iam_policies: + id: google.backupdr.management_servers_iam_policies + name: management_servers_iam_policies + title: Management_servers_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/management_servers_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/management_servers_iam_policies/methods/set_iam_policy + delete: [] + management_servers: + id: google.backupdr.management_servers + name: management_servers + title: Management_servers + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.managementServers + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/management_servers/methods/get' + - $ref: '#/components/x-stackQL-resources/management_servers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/management_servers/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/management_servers/methods/delete' + operations: + id: google.backupdr.operations + name: operations + title: Operations + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + backup_vaults: + id: google.backupdr.backup_vaults + name: backup_vaults + title: Backup_vaults + methods: + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations list: - operation: *ref_1 - response: *ref_2 + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backupVaults get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/locations/methods/get' - - $ref: '#/components/x-stackQL-resources/locations/methods/list' + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/delete' + backup_vaults_usable: + id: google.backupdr.backup_vaults_usable + name: backup_vaults_usable + title: Backup_vaults_usable + methods: + fetch_usable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults:fetchUsable/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/backup_vaults_usable/methods/fetch_usable insert: [] update: [] + replace: [] delete: [] - management_servers_iam_policies: - id: google.backupdr.management_servers_iam_policies - name: management_servers_iam_policies - title: Management_servers_iam_policies + backup_vaults_iam_policies: + id: google.backupdr.backup_vaults_iam_policies + name: backup_vaults_iam_policies + title: Backup_vaults_iam_policies methods: - set_iam_policy: + test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + data_sources: + id: google.backupdr.data_sources + name: data_sources + title: Data_sources + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources/get response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_3 + objectKey: $.dataSources + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}:getIamPolicy/get - response: &ref_4 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_3 - response: *ref_4 - test_iam_permissions: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + remove: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}:remove/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_internal_status: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}:setInternalStatus/post + response: + mediaType: application/json + openAPIDocKey: '200' + initiate_backup: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}:initiateBackup/post + response: + mediaType: application/json + openAPIDocKey: '200' + abandon_backup: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}:abandonBackup/post + response: + mediaType: application/json + openAPIDocKey: '200' + finalize_backup: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}:finalizeBackup/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/get' + - $ref: '#/components/x-stackQL-resources/data_sources/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/remove' + data_sources_access_token: + id: google.backupdr.data_sources_access_token + name: data_sources_access_token + title: Data_sources_access_token + methods: + fetch_access_token: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}:fetchAccessToken/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/management_servers_iam_policies/methods/get_iam_policy + #/components/x-stackQL-resources/data_sources_access_token/methods/fetch_access_token insert: [] update: [] + replace: [] delete: [] - management_servers: - id: google.backupdr.management_servers - name: management_servers - title: Management_servers + backups: + id: google.backupdr.backups + name: backups + title: Backups methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers/get - response: &ref_6 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}~1backups/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.managementServers - list: - operation: *ref_5 - response: *ref_6 + objectKey: $.backups + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}~1backups~1{backupsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}~1backups~1{backupsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}~1backups~1{backupsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + restore: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupVaults~1{backupVaultsId}~1dataSources~1{dataSourcesId}~1backups~1{backupsId}:restore/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/backups/methods/get' + - $ref: '#/components/x-stackQL-resources/backups/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/backups/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/backups/methods/delete' + backup_plans: + id: google.backupdr.backup_plans + name: backup_plans + title: Backup_plans + methods: create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.backupPlans get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1managementServers~1{managementServersId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}/delete response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/management_servers/methods/get' - - $ref: '#/components/x-stackQL-resources/management_servers/methods/list' + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/get' + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/management_servers/methods/create' + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/create' update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/management_servers/methods/delete' - operations: - id: google.backupdr.operations - name: operations - title: Operations + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/delete' + backup_plan_associations: + id: google.backupdr.backup_plan_associations + name: backup_plan_associations + title: Backup_plan_associations methods: - _list: - operation: &ref_7 + create: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlanAssociations/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations list: - operation: *ref_7 - response: *ref_8 + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlanAssociations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backupPlanAssociations get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlanAssociations~1{backupPlanAssociationsId}/get response: mediaType: application/json openAPIDocKey: '200' delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlanAssociations~1{backupPlanAssociationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - cancel: + trigger_backup: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlanAssociations~1{backupPlanAssociationsId}:triggerBackup/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' - insert: [] + - $ref: >- + #/components/x-stackQL-resources/backup_plan_associations/methods/get + - $ref: >- + #/components/x-stackQL-resources/backup_plan_associations/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/backup_plan_associations/methods/create update: [] + replace: [] delete: - - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + - $ref: >- + #/components/x-stackQL-resources/backup_plan_associations/methods/delete paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1045,8 +4111,1227 @@ paths: - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' get: - description: Lists information about the supported locations for this service. - operationId: backupdr.projects.locations.list + description: Lists information about the supported locations for this service. + operationId: backupdr.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: backupdr.projects.locations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Location' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: backupdr.projects.locations.managementServers.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: backupdr.projects.locations.managementServers.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: backupdr.projects.locations.managementServers.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers: + parameters: *ref_1 + get: + description: Lists ManagementServers in a given project and location. + operationId: backupdr.projects.locations.managementServers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListManagementServersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + post: + description: Creates a new ManagementServer in a given project and location. + operationId: backupdr.projects.locations.managementServers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementServer' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: managementServerId + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}: + parameters: *ref_1 + get: + description: Gets details of a single ManagementServer. + operationId: backupdr.projects.locations.managementServers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementServer' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + delete: + description: Deletes a single ManagementServer. + operationId: backupdr.projects.locations.managementServers.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: managementServersId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: backupdr.projects.locations.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: backupdr.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: backupdr.projects.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: backupdr.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelOperationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults: + parameters: *ref_1 + post: + description: '' + operationId: backupdr.projects.locations.backupVaults.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupVault' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: backupVaultId + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists BackupVaults in a given project and location. + operationId: backupdr.projects.locations.backupVaults.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupVaultsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable: + parameters: *ref_1 + get: + description: >- + FetchUsableBackupVaults lists usable BackupVaults in a given project and + location. Usable BackupVault are the ones that user has + backupdr.backupVaults.get permission. + operationId: backupdr.projects.locations.backupVaults.fetchUsable + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FetchUsableBackupVaultsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}: + parameters: *ref_1 + get: + description: Gets details of a BackupVault. + operationId: backupdr.projects.locations.backupVaults.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupVault' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + patch: + description: Updates the settings of a BackupVault. + operationId: backupdr.projects.locations.backupVaults.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupVault' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: force + schema: + type: boolean + delete: + description: Deletes a BackupVault. + operationId: backupdr.projects.locations.backupVaults.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: force + schema: + type: boolean + - in: query + name: etag + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: allowMissing + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns the caller's permissions on a BackupVault resource. A caller is + not required to have Google IAM permission to make this request. + operationId: backupdr.projects.locations.backupVaults.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources: + parameters: *ref_1 + get: + description: Lists DataSources in a given project and location. + operationId: backupdr.projects.locations.backupVaults.dataSources.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListDataSourcesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}: + parameters: *ref_1 + get: + description: Gets details of a DataSource. + operationId: backupdr.projects.locations.backupVaults.dataSources.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DataSource' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + patch: + description: Updates the settings of a DataSource. + operationId: backupdr.projects.locations.backupVaults.dataSources.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DataSource' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove: + parameters: *ref_1 + post: + description: >- + Deletes a DataSource. This is a custom method instead of a standard + delete method because external clients will not delete DataSources + except for BackupDR backup appliances. + operationId: backupdr.projects.locations.backupVaults.dataSources.remove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveDataSourceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus: + parameters: *ref_1 + post: + description: Sets the internal status of a DataSource. + operationId: backupdr.projects.locations.backupVaults.dataSources.setInternalStatus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetInternalStatusRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup: + parameters: *ref_1 + post: + description: Internal only. Initiates a backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.initiateBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InitiateBackupRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InitiateBackupResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup: + parameters: *ref_1 + post: + description: Internal only. Abandons a backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.abandonBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AbandonBackupRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup: + parameters: *ref_1 + post: + description: >- + Internal only. Finalize a backup that was started by a call to + InitiateBackup. + operationId: backupdr.projects.locations.backupVaults.dataSources.finalizeBackup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FinalizeBackupRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken: + parameters: *ref_1 + post: + description: Internal only. Fetch access token for a given data source. + operationId: backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FetchAccessTokenRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FetchAccessTokenResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups: + parameters: *ref_1 + get: + description: Lists Backups in a given project and location. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1058,15 +5343,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListLocationsResponse' + $ref: '#/components/schemas/ListBackupsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true schema: type: string - in: query @@ -1078,11 +5374,19 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}: + parameters: *ref_1 get: - description: Gets information about a location. - operationId: backupdr.projects.locations.get + description: Gets details of a Backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1094,7 +5398,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/Backup' parameters: - in: path name: projectsId @@ -1106,19 +5410,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy: - parameters: *ref_9 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: backupdr.projects.locations.managementServers.setIamPolicy + - in: path + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + patch: + description: Updates the settings of a Backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/Backup' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1130,7 +5444,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -1143,17 +5457,32 @@ paths: schema: type: string - in: path - name: managementServersId + name: backupVaultsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy: - parameters: *ref_9 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: backupdr.projects.locations.managementServers.getIamPolicy + - in: path + name: dataSourcesId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: requestId + schema: + type: string + delete: + description: Deletes a Backup. + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1165,7 +5494,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -1178,30 +5507,34 @@ paths: schema: type: string - in: path - name: managementServersId + name: backupVaultsId + required: true + schema: + type: string + - in: path + name: dataSourcesId + required: true + schema: + type: string + - in: path + name: backupsId required: true schema: type: string - in: query - name: options.requestedPolicyVersion + name: requestId schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions: - parameters: *ref_9 + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}:restore: + parameters: *ref_1 post: - description: >- - 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. - operationId: backupdr.projects.locations.managementServers.testIamPermissions + description: Restore from a Backup + operationId: backupdr.projects.locations.backupVaults.dataSources.backups.restore requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/RestoreBackupRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1213,7 +5546,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -1226,15 +5559,64 @@ paths: schema: type: string - in: path - name: managementServersId + name: backupVaultsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers: - parameters: *ref_9 + - in: path + name: dataSourcesId + required: true + schema: + type: string + - in: path + name: backupsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupPlans: + parameters: *ref_1 + post: + description: Create a BackupPlan + operationId: backupdr.projects.locations.backupPlans.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupPlan' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: backupPlanId + schema: + type: string + - in: query + name: requestId + schema: + type: string get: - description: Lists ManagementServers in a given project and location. - operationId: backupdr.projects.locations.managementServers.list + description: Lists BackupPlans in a given project and location. + operationId: backupdr.projects.locations.backupPlans.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1246,7 +5628,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListManagementServersResponse' + $ref: '#/components/schemas/ListBackupPlansResponse' parameters: - in: path name: projectsId @@ -1275,14 +5657,11 @@ paths: name: orderBy schema: type: string - post: - description: Creates a new ManagementServer in a given project and location. - operationId: backupdr.projects.locations.managementServers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ManagementServer' + /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}: + parameters: *ref_1 + get: + description: Gets details of a single BackupPlan. + operationId: backupdr.projects.locations.backupPlans.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1294,7 +5673,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackupPlan' parameters: - in: path name: projectsId @@ -1306,19 +5685,14 @@ paths: required: true schema: type: string - - in: query - name: managementServerId - schema: - type: string - - in: query - name: requestId + - in: path + name: backupPlansId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}: - parameters: *ref_9 - get: - description: Gets details of a single ManagementServer. - operationId: backupdr.projects.locations.managementServers.get + delete: + description: Deletes a single BackupPlan. + operationId: backupdr.projects.locations.backupPlans.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1330,7 +5704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ManagementServer' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -1343,13 +5717,24 @@ paths: schema: type: string - in: path - name: managementServersId + name: backupPlansId required: true schema: type: string - delete: - description: Deletes a single ManagementServer. - operationId: backupdr.projects.locations.managementServers.delete + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations: + parameters: *ref_1 + post: + description: Create a BackupPlanAssociation + operationId: backupdr.projects.locations.backupPlanAssociations.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupPlanAssociation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1373,22 +5758,17 @@ paths: required: true schema: type: string - - in: path - name: managementServersId - required: true + - in: query + name: backupPlanAssociationId schema: type: string - in: query name: requestId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: backupdr.projects.locations.operations.list + description: Lists BackupPlanAssociations in a given project and location. + operationId: backupdr.projects.locations.backupPlanAssociations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1400,7 +5780,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOperationsResponse' + $ref: '#/components/schemas/ListBackupPlanAssociationsResponse' parameters: - in: path name: projectsId @@ -1412,10 +5792,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: @@ -1425,14 +5801,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}: + parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: backupdr.projects.locations.operations.get + description: Gets details of a single BackupPlanAssociation. + operationId: backupdr.projects.locations.backupPlanAssociations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1444,7 +5821,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/BackupPlanAssociation' parameters: - in: path name: projectsId @@ -1457,17 +5834,13 @@ paths: schema: type: string - in: path - name: operationsId + name: backupPlanAssociationsId required: true schema: type: string delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: backupdr.projects.locations.operations.delete + description: Deletes a single BackupPlanAssociation. + operationId: backupdr.projects.locations.backupPlanAssociations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1479,7 +5852,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -1492,29 +5865,24 @@ paths: schema: type: string - in: path - name: operationsId + name: backupPlanAssociationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_9 + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup: + parameters: *ref_1 post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: backupdr.projects.locations.operations.cancel + description: Triggers a new Backup. + operationId: backupdr.projects.locations.backupPlanAssociations.triggerBackup requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelOperationRequest' + $ref: '#/components/schemas/TriggerBackupRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1526,7 +5894,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -1539,7 +5907,7 @@ paths: schema: type: string - in: path - name: operationsId + name: backupPlanAssociationsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml b/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml index ac8246fd..aa2c11ed 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/baremetalsolution.yaml @@ -9,8 +9,8 @@ info: Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center. version: v2 - x-discovery-doc-revision: '20240513' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bare-metal servers: @@ -1673,10 +1673,17 @@ components: vlanAttachments: description: >- List of VLAN attachments. As of now there are always 2 attachments, - but it is going to change in the future (multi vlan). + but it is going to change in the future (multi vlan). Use only one + of vlan_attachments or vrf type: array items: $ref: '#/components/schemas/IntakeVlanAttachment' + vrf: + description: >- + Optional. The name of a pre-existing Vrf that the network should be + attached to. Format is `vrfs/{vrf}`. If vrf is specified, + vlan_attachments must be empty. + type: string cidr: description: CIDR range of the network. type: string @@ -2127,16 +2134,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2149,23 +2153,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] instances: id: google.baremetalsolution.instances name: instances title: Instances methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2264,23 +2266,21 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: [] ssh_keys: id: google.baremetalsolution.ssh_keys name: ssh_keys title: Ssh_keys methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1sshKeys/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sshKeys - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -2301,6 +2301,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/ssh_keys/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/ssh_keys/methods/delete' volumes: @@ -2308,17 +2309,14 @@ components: name: volumes title: Volumes methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1volumes/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.volumes - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -2361,6 +2359,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/volumes/methods/patch' + replace: [] delete: [] snapshots: id: google.baremetalsolution.snapshots @@ -2374,17 +2373,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1snapshots/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.volumeSnapshots - list: - operation: *ref_9 - response: *ref_10 restore_volume_snapshot: operation: $ref: >- @@ -2413,6 +2409,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/snapshots/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' luns: @@ -2427,17 +2424,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1volumes~1{volumesId}~1luns/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.luns - list: - operation: *ref_11 - response: *ref_12 evict: operation: $ref: >- @@ -2451,23 +2445,21 @@ components: - $ref: '#/components/x-stackQL-resources/luns/methods/list' insert: [] update: [] + replace: [] delete: [] networks: id: google.baremetalsolution.networks name: networks title: Networks methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1networks/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.networks - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -2496,6 +2488,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/networks/methods/patch' + replace: [] delete: [] networks_network_usage: id: google.baremetalsolution.networks_network_usage @@ -2515,6 +2508,7 @@ components: #/components/x-stackQL-resources/networks_network_usage/methods/list_network_usage insert: [] update: [] + replace: [] delete: [] nfs_shares: id: google.baremetalsolution.nfs_shares @@ -2542,17 +2536,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1nfsShares/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.nfsShares - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -2575,6 +2566,7 @@ components: - $ref: '#/components/x-stackQL-resources/nfs_shares/methods/create' update: - $ref: '#/components/x-stackQL-resources/nfs_shares/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/nfs_shares/methods/delete' provisioning_quotas: @@ -2582,22 +2574,20 @@ components: name: provisioning_quotas title: Provisioning_quotas methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1provisioningQuotas/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.provisioningQuotas - list: - operation: *ref_17 - response: *ref_18 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/provisioning_quotas/methods/list' insert: [] update: [] + replace: [] delete: [] provisioning_configs: id: google.baremetalsolution.provisioning_configs @@ -2641,6 +2631,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/provisioning_configs/methods/patch + replace: [] delete: [] operations: id: google.baremetalsolution.operations @@ -2659,23 +2650,21 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] + replace: [] delete: [] os_images: id: google.baremetalsolution.os_images name: os_images title: Os_images methods: - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1osImages/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.osImages - list: - operation: *ref_19 - response: *ref_20 get: operation: $ref: >- @@ -2689,10 +2678,11 @@ components: - $ref: '#/components/x-stackQL-resources/os_images/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v2/projects/{projectsId}/locations: - parameters: &ref_21 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2739,7 +2729,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets information about a location. operationId: baremetalsolution.projects.locations.get @@ -2767,7 +2757,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_21 + parameters: *ref_1 get: description: List servers in a given project and location. operationId: baremetalsolution.projects.locations.instances.list @@ -2808,7 +2798,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get details about a single server. operationId: baremetalsolution.projects.locations.instances.get @@ -2882,7 +2872,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:loadAuthInfo: - parameters: *ref_21 + parameters: *ref_1 get: description: Load auth info for a server. operationId: baremetalsolution.projects.locations.instances.loadAuthInfo @@ -2915,7 +2905,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reimage: - parameters: *ref_21 + parameters: *ref_1 post: description: Perform reimage operation on a single server. operationId: baremetalsolution.projects.locations.instances.reimage @@ -2953,7 +2943,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:enableHyperthreading: - parameters: *ref_21 + parameters: *ref_1 post: description: Perform enable hyperthreading operation on a single server. operationId: baremetalsolution.projects.locations.instances.enableHyperthreading @@ -2991,7 +2981,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:disableHyperthreading: - parameters: *ref_21 + parameters: *ref_1 post: description: Perform disable hyperthreading operation on a single server. operationId: baremetalsolution.projects.locations.instances.disableHyperthreading @@ -3029,7 +3019,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rename: - parameters: *ref_21 + parameters: *ref_1 post: description: >- RenameInstance sets a new name for an instance. Use with caution, @@ -3069,7 +3059,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Perform an ungraceful, hard reset on a server. Equivalent to shutting @@ -3109,7 +3099,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:start: - parameters: *ref_21 + parameters: *ref_1 post: description: Starts a server that was shutdown. operationId: baremetalsolution.projects.locations.instances.start @@ -3147,7 +3137,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:stop: - parameters: *ref_21 + parameters: *ref_1 post: description: Stop a running server. operationId: baremetalsolution.projects.locations.instances.stop @@ -3185,7 +3175,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:enableInteractiveSerialConsole: - parameters: *ref_21 + parameters: *ref_1 post: description: Enable the interactive serial console feature on an instance. operationId: >- @@ -3224,7 +3214,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:disableInteractiveSerialConsole: - parameters: *ref_21 + parameters: *ref_1 post: description: Disable the interactive serial console feature on an instance. operationId: >- @@ -3263,7 +3253,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:detachLun: - parameters: *ref_21 + parameters: *ref_1 post: description: Detach LUN from Instance. operationId: baremetalsolution.projects.locations.instances.detachLun @@ -3301,7 +3291,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/sshKeys: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Lists the public SSH keys registered for the specified project. These @@ -3377,7 +3367,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/sshKeys/{sshKeysId}: - parameters: *ref_21 + parameters: *ref_1 delete: description: Deletes a public SSH key registered in the specified project. operationId: baremetalsolution.projects.locations.sshKeys.delete @@ -3410,7 +3400,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes: - parameters: *ref_21 + parameters: *ref_1 get: description: List storage volumes in a given project and location. operationId: baremetalsolution.projects.locations.volumes.list @@ -3451,7 +3441,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get details of a single storage volume. operationId: baremetalsolution.projects.locations.volumes.get @@ -3525,7 +3515,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:rename: - parameters: *ref_21 + parameters: *ref_1 post: description: >- RenameVolume sets a new name for a volume. Use with caution, previous @@ -3565,7 +3555,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:evict: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Skips volume's cooloff and deletes it now. Volume must be in cooloff @@ -3605,7 +3595,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:resize: - parameters: *ref_21 + parameters: *ref_1 post: description: Emergency Volume resize. operationId: baremetalsolution.projects.locations.volumes.resize @@ -3643,7 +3633,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called @@ -3726,7 +3716,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}:restoreVolumeSnapshot: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Uses the specified snapshot to restore its parent volume. Returns @@ -3772,7 +3762,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/snapshots/{snapshotsId}: - parameters: *ref_21 + parameters: *ref_1 delete: description: >- Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a @@ -3850,7 +3840,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns/{lunsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get details of a single storage logical unit number(LUN). operationId: baremetalsolution.projects.locations.volumes.luns.get @@ -3888,7 +3878,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns: - parameters: *ref_21 + parameters: *ref_1 get: description: List storage volume luns for given storage volume. operationId: baremetalsolution.projects.locations.volumes.luns.list @@ -3930,7 +3920,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}/luns/{lunsId}:evict: - parameters: *ref_21 + parameters: *ref_1 post: description: Skips lun's cooloff and deletes it now. Lun must be in cooloff state. operationId: baremetalsolution.projects.locations.volumes.luns.evict @@ -3973,7 +3963,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/networks: - parameters: *ref_21 + parameters: *ref_1 get: description: List network in a given project and location. operationId: baremetalsolution.projects.locations.networks.list @@ -4014,7 +4004,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/networks:listNetworkUsage: - parameters: *ref_21 + parameters: *ref_1 get: description: >- List all Networks (and used IPs for each Network) in the vendor account @@ -4044,7 +4034,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get details of a single network. operationId: baremetalsolution.projects.locations.networks.get @@ -4118,7 +4108,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/networks/{networksId}:rename: - parameters: *ref_21 + parameters: *ref_1 post: description: >- RenameNetwork sets a new name for a network. Use with caution, previous @@ -4158,7 +4148,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/nfsShares/{nfsSharesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get details of a single NFS share. operationId: baremetalsolution.projects.locations.nfsShares.get @@ -4263,7 +4253,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/nfsShares: - parameters: *ref_21 + parameters: *ref_1 get: description: List NFS shares. operationId: baremetalsolution.projects.locations.nfsShares.list @@ -4335,7 +4325,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/nfsShares/{nfsSharesId}:rename: - parameters: *ref_21 + parameters: *ref_1 post: description: >- RenameNfsShare sets a new name for an nfsshare. Use with caution, @@ -4375,7 +4365,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/provisioningQuotas: - parameters: *ref_21 + parameters: *ref_1 get: description: List the budget details to provision resources on a given project. operationId: baremetalsolution.projects.locations.provisioningQuotas.list @@ -4412,7 +4402,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs:submit: - parameters: *ref_21 + parameters: *ref_1 post: description: Submit a provisiong configuration for a given project. operationId: baremetalsolution.projects.locations.provisioningConfigs.submit @@ -4445,7 +4435,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs/{provisioningConfigsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get ProvisioningConfig by name. operationId: baremetalsolution.projects.locations.provisioningConfigs.get @@ -4523,7 +4513,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/provisioningConfigs: - parameters: *ref_21 + parameters: *ref_1 post: description: Create new ProvisioningConfig. operationId: baremetalsolution.projects.locations.provisioningConfigs.create @@ -4560,7 +4550,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get details about an operation. operationId: baremetalsolution.projects.locations.operations.get @@ -4593,7 +4583,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/osImages: - parameters: *ref_21 + parameters: *ref_1 get: description: Retrieves the list of OS images which are currently approved. operationId: baremetalsolution.projects.locations.osImages.list @@ -4630,7 +4620,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/osImages/{osImagesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Get details of a single OS image. operationId: baremetalsolution.projects.locations.osImages.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/batch.yaml b/providers/src/googleapis.com/v00.00.00000/services/batch.yaml index 7d655563..e31257ed 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/batch.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/batch.yaml @@ -7,8 +7,8 @@ info: title: Batch API description: An API to manage the running of Batch resources on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240828' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/batch/ servers: @@ -303,15 +303,14 @@ components: properties: runnables: description: >- - The sequence of scripts or containers to run for this Task. Each - Task using this TaskSpec executes its list of runnables in order. - The Task succeeds if all of its runnables either exit with a zero - status or any that exit with a non-zero status have the - ignore_exit_status flag. Background runnables are killed - automatically (if they have not already exited) a short time after - all foreground runnables have completed. Even though this is likely - to result in a non-zero exit status for the background runnable, - these automatic kills are not treated as Task failures. + Required. The sequence of one or more runnables (executable scripts, + executable containers, and/or barriers) for each task in this task + group to run. Each task runs this list of runnables in order. For a + task to succeed, all of its script and container runnables each must + meet at least one of the following conditions: + The runnable exited + with a zero status. + The runnable didn't finish, but you enabled + its `background` subfield. + The runnable exited with a non-zero + status, but you enabled its `ignore_exit_status` subfield. type: array items: $ref: '#/components/schemas/Runnable' @@ -389,15 +388,24 @@ components: type: string ignoreExitStatus: description: >- - Normally, a non-zero exit status causes the Task to fail. This flag - allows execution of other Runnables to continue instead. + Normally, a runnable that returns a non-zero exit status fails and + causes the task to fail. However, you can set this field to `true` + to allow the task to continue executing its other runnables even if + this runnable fails. type: boolean background: description: >- - This flag allows a Runnable to continue running in the background - while the Task executes subsequent Runnables. This is useful to - provide services to other Runnables (or to provide debugging support - tools like SSH servers). + Normally, a runnable that doesn't exit causes its task to fail. + However, you can set this field to `true` to configure a background + runnable. Background runnables are allowed continue running in the + background while the task executes subsequent runnables. For + example, background runnables are useful for providing services to + other runnables or providing debugging-support tools like SSH + servers. Specifically, background runnables are killed automatically + (if they have not already exited) a short time after all foreground + runnables have completed. Even though this is likely to result in a + non-zero exit status for the background runnable, these automatic + kills are not treated as task failures. type: boolean alwaysRun: description: >- @@ -429,40 +437,44 @@ components: type: object properties: imageUri: - description: The URI to pull the container image from. + description: Required. The URI to pull the container image from. type: string commands: description: >- - Overrides the `CMD` specified in the container. If there is an - ENTRYPOINT (either in the container image or with the entrypoint - field below) then commands are appended as arguments to the - ENTRYPOINT. + Required for some container images. Overrides the `CMD` specified in + the container. If there is an `ENTRYPOINT` (either in the container + image or with the `entrypoint` field below) then these commands are + appended as arguments to the `ENTRYPOINT`. type: array items: type: string entrypoint: - description: Overrides the `ENTRYPOINT` specified in the container. + description: >- + Required for some container images. Overrides the `ENTRYPOINT` + specified in the container. type: string volumes: description: >- Volumes to mount (bind mount) from the host machine files or - directories into the container, formatted to match docker run's - --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the - `TaskSpec.Volumes` field is specified but this field is not, Batch - will mount each volume from the host machine to the container with - the same mount path by default. In this case, the default mount - option for containers will be read-only (ro) for existing persistent - disks and read-write (rw) for other volume types, regardless of the - original mount options specified in `TaskSpec.Volumes`. If you need - different mount settings, you can explicitly configure them in this - field. + directories into the container, formatted to match `--volume` option + for the `docker run` command—for example, `/foo:/bar` or + `/foo:/bar:ro`. If the `TaskSpec.Volumes` field is specified but + this field is not, Batch will mount each volume from the host + machine to the container with the same mount path by default. In + this case, the default mount option for containers will be read-only + (`ro`) for existing persistent disks and read-write (`rw`) for other + volume types, regardless of the original mount options specified in + `TaskSpec.Volumes`. If you need different mount settings, you can + explicitly configure them in this field. type: array items: type: string options: description: >- - Arbitrary additional options to include in the "docker run" command - when running this container, e.g. "--network host". + Required for some container images. Arbitrary additional options to + include in the `docker run` command when running this container—for + example, `--network host`. For the `--volume` option, use the + `volumes` field for the container. type: string blockExternalNetwork: description: >- @@ -524,26 +536,31 @@ components: properties: path: description: >- - Script file path on the host VM. To specify an interpreter, please - add a `#!`(also known as [shebang - line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first - line of the file.(For example, to execute the script using bash, - `#!/bin/bash` should be the first line of the file. To execute the - script using`Python3`, `#!/usr/bin/env python3` should be the first - line of the file.) Otherwise, the file will by default be executed - by `/bin/sh`. + The path to a script file that is accessible from the host VM(s). + Unless the script file supports the default `#!/bin/sh` shell + interpreter, you must specify an interpreter by including a [shebang + line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the first line + of the file. For example, to execute the script using bash, include + `#!/bin/bash` as the first line of the file. Alternatively, to + execute the script using Python3, include `#!/usr/bin/env python3` + as the first line of the file. type: string text: description: >- - Shell script text. To specify an interpreter, please add a `#!\n` at - the beginning of the text.(For example, to execute the script using - bash, `#!/bin/bash\n` should be added. To execute the script - using`Python3`, `#!/usr/bin/env python3\n` should be added.) - Otherwise, the script will by default be executed by `/bin/sh`. + The text for a script. Unless the script text supports the default + `#!/bin/sh` shell interpreter, you must specify an interpreter by + including a [shebang + line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the beginning + of the text. For example, to execute the script using bash, include + `#!/bin/bash\n` at the beginning of the text. Alternatively, to + execute the script using Python3, include `#!/usr/bin/env python3\n` + at the beginning of the text. type: string Barrier: id: Barrier - description: Barrier runnable blocks until all tasks in a taskgroup reach it. + description: >- + A barrier runnable automatically blocks the execution of subsequent + runnables until all the tasks in the task group reach the barrier. type: object properties: name: @@ -706,16 +723,16 @@ components: type: string mountOptions: description: >- - For Google Cloud Storage (GCS), mount options are the options - supported by the gcsfuse tool - (https://github.com/GoogleCloudPlatform/gcsfuse). For existing - persistent disks, mount options provided by the mount command - (https://man7.org/linux/man-pages/man8/mount.8.html) except writing - are supported. This is due to restrictions of multi-writer mode - (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). - For other attached disks and Network File System (NFS), mount - options are these supported by the mount command - (https://man7.org/linux/man-pages/man8/mount.8.html). + Mount options vary based on the type of storage volume: * For a + Cloud Storage bucket, all the mount options provided by the + [`gcsfuse` tool](https://cloud.google.com/storage/docs/gcsfuse-cli) + are supported. * For an existing persistent disk, all mount options + provided by the [`mount` + command](https://man7.org/linux/man-pages/man8/mount.8.html) except + writing are supported. This is due to restrictions of [multi-writer + mode](https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). + * For any other disk or a Network File System (NFS), all the mount + options provided by the `mount` command are supported. type: array items: type: string @@ -847,6 +864,27 @@ components: For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py. type: boolean + installOpsAgent: + description: >- + Optional. Set this field true if you want Batch to install Ops Agent + on your behalf. Default is false. + type: boolean + blockProjectSshKeys: + description: >- + Optional. Set this field to `true` if you want Batch to block + project-level SSH keys from accessing this job's VMs. Alternatively, + you can configure the job to specify a VM instance template that + blocks project-level SSH keys. In either case, Batch blocks + project-level SSH keys while creating the VMs for this job. Batch + allows project-level SSH keys for a job's VMs only if all the + following are true: + This field is undefined or set to `false`. + + The job's VM instance template (if any) doesn't block project-level + SSH keys. Notably, you can override this behavior by manually + updating a VM to block or allow project-level SSH keys. For more + information about blocking project-level SSH keys, see the Compute + Engine documentation: + https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keys + type: boolean InstancePolicy: id: InstancePolicy description: >- @@ -953,10 +991,8 @@ components: image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * `batch-debian`: use - Batch Debian images. * `batch-centos`: use Batch CentOS images. * - `batch-cos`: use Batch Container-Optimized images. * - `batch-hpc-centos`: use Batch HPC CentOS images. * - `batch-hpc-rocky`: use Batch HPC Rocky Linux images. + Batch Debian images. * `batch-cos`: use Batch Container-Optimized + images. * `batch-hpc-rocky`: use Batch HPC Rocky Linux images. type: string snapshot: description: >- @@ -967,7 +1003,10 @@ components: description: >- Disk type as shown in `gcloud compute disk-types list`. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use - "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard". + "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard". If not + specified, "pd-standard" will be used as the default type for + non-boot disks, "pd-balanced" will be used as the default type for + boot disks. type: string sizeGb: description: >- @@ -1144,7 +1183,7 @@ components: format: google-duration StatusEvent: id: StatusEvent - description: Status event + description: Status event. type: object properties: type: @@ -1158,10 +1197,12 @@ components: type: string format: google-datetime taskExecution: - description: Task Execution + description: >- + Task Execution. This field is only defined for task-level status + events where the task fails. $ref: '#/components/schemas/TaskExecution' taskState: - description: Task State + description: Task State. This field is only defined for task-level status events. type: string enumDescriptions: - Unknown state. @@ -1304,11 +1345,15 @@ components: properties: pubsubTopic: description: >- - The Pub/Sub topic where notifications like the job state changes - will be published. The topic must exist in the same project as the - job and billings will be charged to this project. If not specified, - no Pub/Sub messages will be sent. Topic format: - `projects/{project}/topics/{topic}`. + The Pub/Sub topic where notifications for the job, like state + changes, will be published. If undefined, no Pub/Sub notifications + are sent for this job. Specify the topic using the following format: + `projects/{project}/topics/{topic}`. Notably, if you want to specify + a Pub/Sub topic that is in a different project than the job, your + administrator must grant your project's Batch service agent + permission to publish to that topic. For more information about + configuring Pub/Sub notifications for a job, see + https://cloud.google.com/batch/docs/enable-notifications. type: string message: description: >- @@ -1419,11 +1464,11 @@ components: $ref: '#/components/schemas/TaskStatus' TaskStatus: id: TaskStatus - description: Status of a task + description: Status of a task. type: object properties: state: - description: Task state + description: Task state. type: string enumDescriptions: - Unknown state. @@ -1712,6 +1757,9 @@ components: User account on the VM to run the runnables in the agentTaskSpec. If not set, the runnable will be run under root user. $ref: '#/components/schemas/AgentTaskUserAccount' + loggingOption: + description: Logging option for the task. + $ref: '#/components/schemas/AgentTaskLoggingOption' AgentTaskRunnable: id: AgentTaskRunnable description: >- @@ -1873,6 +1921,18 @@ components: to the user account. type: string format: int64 + AgentTaskLoggingOption: + id: AgentTaskLoggingOption + description: AgentTaskLoggingOption contains the options for the logging of the task. + type: object + properties: + labels: + description: >- + Labels to be added to the log entry. Now only cloud logging is + supported. + type: object + additionalProperties: + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -2049,16 +2109,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2071,23 +2128,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.batch.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2115,6 +2170,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' jobs: @@ -2129,17 +2185,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -2161,6 +2214,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' tasks: @@ -2175,23 +2229,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}~1taskGroups~1{taskGroupsId}~1tasks/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tasks - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/tasks/methods/get' - $ref: '#/components/x-stackQL-resources/tasks/methods/list' insert: [] update: [] + replace: [] delete: [] state: id: google.batch.state @@ -2209,10 +2261,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2259,7 +2312,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: batch.projects.locations.get @@ -2287,7 +2340,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2330,7 +2383,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2401,7 +2454,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2448,7 +2501,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs: - parameters: *ref_9 + parameters: *ref_1 post: description: Create a Job. operationId: batch.projects.locations.jobs.create @@ -2532,7 +2585,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Get a Job specified by its resource name. operationId: batch.projects.locations.jobs.get @@ -2604,7 +2657,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/taskGroups/{taskGroupsId}/tasks/{tasksId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Return a single Task. operationId: batch.projects.locations.jobs.taskGroups.tasks.get @@ -2647,7 +2700,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/taskGroups/{taskGroupsId}/tasks: - parameters: *ref_9 + parameters: *ref_1 get: description: List Tasks associated with a job. operationId: batch.projects.locations.jobs.taskGroups.tasks.list @@ -2698,7 +2751,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/state:report: - parameters: *ref_9 + parameters: *ref_1 post: description: Report agent's state, e.g. agent status and tasks information operationId: batch.projects.locations.state.report diff --git a/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml b/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml index 62df341f..757b4530 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/beyondcorp.yaml @@ -11,8 +11,8 @@ info: Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions. version: v1 - x-discovery-doc-revision: '20240508' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/ servers: @@ -747,6 +747,14 @@ components: description: Required. The ingress port of an allocated connection type: integer format: int32 + ShouldThrottleResponse: + id: ShouldThrottleResponse + description: Response message for calling ShouldThrottle + type: object + properties: + shouldThrottle: + description: Whether the port should be throttled + type: boolean GoogleCloudLocationListLocationsResponse: id: GoogleCloudLocationListLocationsResponse description: The response message for Locations.ListLocations. @@ -1888,16 +1896,13 @@ components: name: locations title: Locations methods: - _projects_locations_list: - operation: &ref_1 + projects_locations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 projects_locations_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1912,23 +1917,21 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] operations: id: google.beyondcorp.operations name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -1950,17 +1953,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_operations_list: - operation: &ref_5 + organizations_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - organizations_locations_operations_list: - operation: *ref_5 - response: *ref_6 organizations_locations_operations_get: operation: $ref: >- @@ -1994,6 +1994,7 @@ components: #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete @@ -2004,17 +2005,14 @@ components: name: app_connections title: App_connections methods: - _projects_locations_app_connections_list: - operation: &ref_7 + projects_locations_app_connections_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appConnections/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.appConnections - projects_locations_app_connections_list: - operation: *ref_7 - response: *ref_8 projects_locations_app_connections_create: operation: $ref: >- @@ -2062,6 +2060,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/app_connections/methods/projects_locations_app_connections_delete @@ -2077,17 +2076,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_app_connections_get_iam_policy: - operation: &ref_9 + projects_locations_app_connections_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appConnections~1{appConnectionsId}:getIamPolicy/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_app_connections_get_iam_policy: - operation: *ref_9 - response: *ref_10 projects_locations_app_connections_test_iam_permissions: operation: $ref: >- @@ -2101,23 +2097,23 @@ components: #/components/x-stackQL-resources/app_connections_iam_policies/methods/projects_locations_app_connections_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/app_connections_iam_policies/methods/projects_locations_app_connections_set_iam_policy delete: [] app_connectors: id: google.beyondcorp.app_connectors name: app_connectors title: App_connectors methods: - _projects_locations_app_connectors_list: - operation: &ref_11 + projects_locations_app_connectors_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appConnectors/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.appConnectors - projects_locations_app_connectors_list: - operation: *ref_11 - response: *ref_12 projects_locations_app_connectors_create: operation: $ref: >- @@ -2172,6 +2168,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/app_connectors/methods/projects_locations_app_connectors_delete @@ -2187,17 +2184,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_app_connectors_get_iam_policy: - operation: &ref_13 + projects_locations_app_connectors_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appConnectors~1{appConnectorsId}:getIamPolicy/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_app_connectors_get_iam_policy: - operation: *ref_13 - response: *ref_14 projects_locations_app_connectors_test_iam_permissions: operation: $ref: >- @@ -2211,23 +2205,23 @@ components: #/components/x-stackQL-resources/app_connectors_iam_policies/methods/projects_locations_app_connectors_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/app_connectors_iam_policies/methods/projects_locations_app_connectors_set_iam_policy delete: [] app_gateways: id: google.beyondcorp.app_gateways name: app_gateways title: App_gateways methods: - _projects_locations_app_gateways_list: - operation: &ref_15 + projects_locations_app_gateways_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appGateways/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.appGateways - projects_locations_app_gateways_list: - operation: *ref_15 - response: *ref_16 projects_locations_app_gateways_create: operation: $ref: >- @@ -2235,6 +2229,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_app_gateways_should_throttle: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appGateways~1{appGatewaysId}:shouldThrottle/get + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_app_gateways_get: operation: $ref: >- @@ -2259,6 +2260,7 @@ components: - $ref: >- #/components/x-stackQL-resources/app_gateways/methods/projects_locations_app_gateways_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/app_gateways/methods/projects_locations_app_gateways_delete @@ -2274,17 +2276,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_app_gateways_get_iam_policy: - operation: &ref_17 + projects_locations_app_gateways_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appGateways~1{appGatewaysId}:getIamPolicy/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_app_gateways_get_iam_policy: - operation: *ref_17 - response: *ref_18 projects_locations_app_gateways_test_iam_permissions: operation: $ref: >- @@ -2298,6 +2297,9 @@ components: #/components/x-stackQL-resources/app_gateways_iam_policies/methods/projects_locations_app_gateways_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/app_gateways_iam_policies/methods/projects_locations_app_gateways_set_iam_policy delete: [] client_connector_services_iam_policies: id: google.beyondcorp.client_connector_services_iam_policies @@ -2311,17 +2313,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_client_connector_services_get_iam_policy: - operation: &ref_19 + projects_locations_client_connector_services_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientConnectorServices~1{clientConnectorServicesId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_client_connector_services_get_iam_policy: - operation: *ref_19 - response: *ref_20 projects_locations_client_connector_services_test_iam_permissions: operation: $ref: >- @@ -2335,6 +2334,9 @@ components: #/components/x-stackQL-resources/client_connector_services_iam_policies/methods/projects_locations_client_connector_services_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/client_connector_services_iam_policies/methods/projects_locations_client_connector_services_set_iam_policy delete: [] client_gateways_iam_policies: id: google.beyondcorp.client_gateways_iam_policies @@ -2348,17 +2350,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_client_gateways_get_iam_policy: - operation: &ref_21 + projects_locations_client_gateways_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientGateways~1{clientGatewaysId}:getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_client_gateways_get_iam_policy: - operation: *ref_21 - response: *ref_22 projects_locations_client_gateways_test_iam_permissions: operation: $ref: >- @@ -2372,6 +2371,9 @@ components: #/components/x-stackQL-resources/client_gateways_iam_policies/methods/projects_locations_client_gateways_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/client_gateways_iam_policies/methods/projects_locations_client_gateways_set_iam_policy delete: [] partner_tenants_iam_policies: id: google.beyondcorp.partner_tenants_iam_policies @@ -2385,17 +2387,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_global_partner_tenants_get_iam_policy: - operation: &ref_23 + organizations_locations_global_partner_tenants_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}:getIamPolicy/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - organizations_locations_global_partner_tenants_get_iam_policy: - operation: *ref_23 - response: *ref_24 organizations_locations_global_partner_tenants_test_iam_permissions: operation: $ref: >- @@ -2409,6 +2408,9 @@ components: #/components/x-stackQL-resources/partner_tenants_iam_policies/methods/organizations_locations_global_partner_tenants_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/partner_tenants_iam_policies/methods/organizations_locations_global_partner_tenants_set_iam_policy delete: [] proxy_configs_iam_policies: id: google.beyondcorp.proxy_configs_iam_policies @@ -2422,17 +2424,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_global_partner_tenants_proxy_configs_get_iam_policy: - operation: &ref_25 + organizations_locations_global_partner_tenants_proxy_configs_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1proxyConfigs~1{proxyConfigsId}:getIamPolicy/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - organizations_locations_global_partner_tenants_proxy_configs_get_iam_policy: - operation: *ref_25 - response: *ref_26 organizations_locations_global_partner_tenants_proxy_configs_test_iam_permissions: operation: $ref: >- @@ -2446,6 +2445,9 @@ components: #/components/x-stackQL-resources/proxy_configs_iam_policies/methods/organizations_locations_global_partner_tenants_proxy_configs_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/proxy_configs_iam_policies/methods/organizations_locations_global_partner_tenants_proxy_configs_set_iam_policy delete: [] browser_dlp_rules_iam_policies: id: google.beyondcorp.browser_dlp_rules_iam_policies @@ -2459,17 +2461,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_global_partner_tenants_browser_dlp_rules_get_iam_policy: - operation: &ref_27 + organizations_locations_global_partner_tenants_browser_dlp_rules_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1global~1partnerTenants~1{partnerTenantsId}~1browserDlpRules~1{browserDlpRulesId}:getIamPolicy/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - organizations_locations_global_partner_tenants_browser_dlp_rules_get_iam_policy: - operation: *ref_27 - response: *ref_28 organizations_locations_global_partner_tenants_browser_dlp_rules_test_iam_permissions: operation: $ref: >- @@ -2483,10 +2482,13 @@ components: #/components/x-stackQL-resources/browser_dlp_rules_iam_policies/methods/organizations_locations_global_partner_tenants_browser_dlp_rules_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/browser_dlp_rules_iam_policies/methods/organizations_locations_global_partner_tenants_browser_dlp_rules_set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_29 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2533,7 +2535,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Gets information about a location. operationId: beyondcorp.projects.locations.get @@ -2561,7 +2563,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2604,7 +2606,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2675,7 +2677,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2722,7 +2724,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appConnections: - parameters: *ref_29 + parameters: *ref_1 get: description: Lists AppConnections in a given project and location. operationId: beyondcorp.projects.locations.appConnections.list @@ -2812,7 +2814,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Gets details of a single AppConnection. operationId: beyondcorp.projects.locations.appConnections.get @@ -2939,7 +2941,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/appConnections:resolve: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Resolves AppConnections details for a given AppConnector. An internal @@ -2983,7 +2985,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3024,7 +3026,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3064,7 +3066,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3107,7 +3109,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appConnectors: - parameters: *ref_29 + parameters: *ref_1 get: description: Lists AppConnectors in a given project and location. operationId: beyondcorp.projects.locations.appConnectors.list @@ -3197,7 +3199,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Gets details of a single AppConnector. operationId: beyondcorp.projects.locations.appConnectors.get @@ -3320,7 +3322,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:resolveInstanceConfig: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets instance configuration for a given AppConnector. An internal method @@ -3356,7 +3358,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:reportStatus: - parameters: *ref_29 + parameters: *ref_1 post: description: Report status for a given connector. operationId: beyondcorp.projects.locations.appConnectors.reportStatus @@ -3395,7 +3397,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3436,7 +3438,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3476,7 +3478,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3519,7 +3521,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appGateways: - parameters: *ref_29 + parameters: *ref_1 get: description: Lists AppGateways in a given project and location. operationId: beyondcorp.projects.locations.appGateways.list @@ -3606,8 +3608,53 @@ paths: name: validateOnly schema: type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:shouldThrottle: + parameters: *ref_1 + get: + description: >- + Calls the Bouncer method ShouldThrottle to check if a request should be + throttled. + operationId: beyondcorp.projects.locations.appGateways.shouldThrottle + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ShouldThrottleResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: appGatewaysId + required: true + schema: + type: string + - in: query + name: port + schema: + type: integer + format: int32 + - in: query + name: requestedAmount + schema: + type: string + format: int64 /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Gets details of a single AppGateway. operationId: beyondcorp.projects.locations.appGateways.get @@ -3679,7 +3726,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3720,7 +3767,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3760,7 +3807,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3803,7 +3850,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3844,7 +3891,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3884,7 +3931,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3927,7 +3974,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3968,7 +4015,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4008,7 +4055,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4051,7 +4098,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/operations: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4094,7 +4141,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4165,7 +4212,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4212,7 +4259,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4248,7 +4295,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4283,7 +4330,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4322,7 +4369,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4364,7 +4411,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4405,7 +4452,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4449,7 +4496,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4491,7 +4538,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4532,7 +4579,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml b/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml index a61b9a39..41d3ebf2 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/biglake.yaml @@ -10,8 +10,8 @@ info: managed, and highly available metastore for open-source data that can be used for querying Apache Iceberg tables in BigQuery. version: v1 - x-discovery-doc-revision: '20240522' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240902' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -385,17 +385,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.catalogs - list: - operation: *ref_1 - response: *ref_2 delete: operation: $ref: >- @@ -417,6 +414,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/catalogs/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/catalogs/methods/delete' databases: @@ -431,17 +429,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1databases/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.databases - list: - operation: *ref_3 - response: *ref_4 delete: operation: $ref: >- @@ -471,6 +466,7 @@ components: - $ref: '#/components/x-stackQL-resources/databases/methods/create' update: - $ref: '#/components/x-stackQL-resources/databases/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/databases/methods/delete' tables: @@ -485,17 +481,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1databases~1{databasesId}~1tables/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tables - list: - operation: *ref_5 - response: *ref_6 delete: operation: $ref: >- @@ -532,11 +525,12 @@ components: - $ref: '#/components/x-stackQL-resources/tables/methods/create' update: - $ref: '#/components/x-stackQL-resources/tables/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tables/methods/delete' paths: /v1/projects/{projectsId}/locations/{locationsId}/catalogs: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -627,7 +621,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}: - parameters: *ref_7 + parameters: *ref_1 delete: description: Deletes an existing catalog specified by the catalog ID. operationId: biglake.projects.locations.catalogs.delete @@ -699,7 +693,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a new database. operationId: biglake.projects.locations.catalogs.databases.create @@ -789,7 +783,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}: - parameters: *ref_7 + parameters: *ref_1 delete: description: Deletes an existing database specified by the database ID. operationId: biglake.projects.locations.catalogs.databases.delete @@ -921,7 +915,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a new table. operationId: biglake.projects.locations.catalogs.databases.tables.create @@ -1025,7 +1019,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}: - parameters: *ref_7 + parameters: *ref_1 delete: description: Deletes an existing table specified by the table ID. operationId: biglake.projects.locations.catalogs.databases.tables.delete @@ -1172,7 +1166,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/databases/{databasesId}/tables/{tablesId}:rename: - parameters: *ref_7 + parameters: *ref_1 post: description: Renames an existing table specified by the table ID. operationId: biglake.projects.locations.catalogs.databases.tables.rename diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml index 61e54973..42db9c59 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquery.yaml @@ -7,8 +7,8 @@ info: title: BigQuery API description: A data platform for customers to create, manage, share and query data. version: v2 - x-discovery-doc-revision: '20240418' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240803' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -649,8 +649,8 @@ components: Required. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form - ".." or - "projects//locations//connections/". + `{project}.{location}.{connection_id}` or + `projects/{project}/locations/{location}/connections/{connection_id}". type: string fileFormat: description: Required. The file format the table data is stored in. @@ -666,7 +666,7 @@ components: Required. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format - "gs://bucket/path_to_table/" + `gs://bucket/path_to_table/` type: string tableFormat: description: >- @@ -721,8 +721,8 @@ components: qualifierEncoded: description: >- [Required] Qualifier of the column. Columns in the parent column - family that has this exact qualifier are exposed as . field. If the - qualifier is valid UTF-8 string, it can be specified in the + family that has this exact qualifier are exposed as `.` field. If + the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery @@ -753,8 +753,8 @@ components: Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be - accessed as .. Other columns can be accessed as a list through - .Column field. + accessed as `.`. Other columns can be accessed as a list through the + `.Column` field. items: $ref: '#/components/schemas/BigtableColumn' type: array @@ -1196,8 +1196,12 @@ components: the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration - Additional properties are allowed, but ignored. Specifying multiple - connection properties with the same key returns an error. + * **service_account**: indicates the service account to use to run a + continuous query. If set, the query job uses the service account to + access Google Cloud resources. Service account access is bounded by the + IAM permissions that you have granted to the service account. Additional + properties are allowed, but ignored. Specifying multiple connection + properties with the same key returns an error. id: ConnectionProperty properties: key: @@ -1312,6 +1316,18 @@ components: description: Whether any accessed data was protected by the data masking. type: boolean type: object + DataPolicyOption: + description: >- + Data policy option proto, it currently supports name only, will support + precedence later. + id: DataPolicyOption + properties: + name: + description: >- + Data policy resource name in the form of + projects/project_id/locations/location_id/dataPolicies/data_policy_id. + type: string + type: object DataSplitResult: description: >- Data split result. This contains references to the training and @@ -1329,6 +1345,7 @@ components: description: Table reference of the training data after split. type: object Dataset: + description: Represents a BigQuery dataset. id: Dataset properties: access: @@ -1341,7 +1358,10 @@ components: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset - creator email]; access.role: OWNER; + creator email]; access.role: OWNER; If you patch a dataset, then + this field is overwritten by the patched dataset's access field. To + add entities, you must supply the entire existing access array in + addition to any new entities that you want to add. items: description: An object that defines dataset access for an entity. properties: @@ -1375,9 +1395,10 @@ components: description: >- An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy - mappings will be applied: OWNER <=> roles/bigquery.dataOwner - WRITER <=> roles/bigquery.dataEditor READER <=> - roles/bigquery.dataViewer This field will accept any of the + mappings will be applied: * `OWNER`: + `roles/bigquery.dataOwner` * `WRITER`: + `roles/bigquery.dataEditor` * `READER`: + `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". @@ -1395,9 +1416,9 @@ components: specialGroup: description: >- [Pick one] A special group to grant access to. Possible values - include: projectOwners: Owners of the enclosing project. - projectReaders: Readers of the enclosing project. - projectWriters: Writers of the enclosing project. + include: * projectOwners: Owners of the enclosing project. * + projectReaders: Readers of the enclosing project. * + projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. type: string @@ -1443,10 +1464,10 @@ components: defaultEncryptionConfiguration: $ref: '#/components/schemas/EncryptionConfiguration' description: >- - The default encryption key for all tables in the dataset. Once this - property is set, all newly-created partitioned tables in the dataset - will have encryption key set to this value, unless table creation - request (or query) overrides the key. + The default encryption key for all tables in the dataset. After this + property is set, the encryption key of all newly-created tables in + the dataset is set to this value unless the table creation request + or query explicitly overrides the key. defaultPartitionExpirationMs: description: >- This default partition expiration, expressed in milliseconds. When @@ -1552,8 +1573,9 @@ components: description: >- The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when - inserting or updating a dataset. See Creating and Updating Dataset - Labels for more information. + inserting or updating a dataset. See [Creating and Updating Dataset + Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) + for more information. type: object lastModifiedTime: description: >- @@ -1588,6 +1610,19 @@ components: if this is not set. format: int64 type: string + resourceTags: + additionalProperties: + type: string + description: >- + Optional. The [tags](/bigquery/docs/tags) attached to this dataset. + Tag keys are globally unique. Tag key is expected to be in the + namespaced format, for example "123456789012/environment" where + 123456789012 is the ID of the parent organization or project + resource for this tag key. Tag value is expected to be the short + name, for example "Production". See [Tag + definitions](/iam/docs/tags-access-control#definitions) for more + details. + type: object restrictions: $ref: '#/components/schemas/RestrictionConfig' description: >- @@ -1623,7 +1658,10 @@ components: - Billing for physical bytes. type: string tags: - description: Output only. Tags for the Dataset. + deprecated: true + description: >- + Output only. Tags for the dataset. To provide tags as inputs, use + the `resourceTags` field. items: description: >- A global tag managed by Resource Manager. @@ -1756,6 +1794,7 @@ components: type: array type: object DatasetReference: + description: Identifier for a dataset. id: DatasetReference properties: datasetId: @@ -1962,6 +2001,7 @@ components: type: number type: object EncryptionConfiguration: + description: Configuration for Cloud KMS encryption settings. id: EncryptionConfiguration properties: kmsKeyName: @@ -2348,8 +2388,8 @@ components: Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form - ".." or - "projects//locations//connections/". + `{project_id}.{location_id};{connection_id}` or + `projects/{project_id}/locations/{location_id}/connections/{connection_id}`. type: string csvOptions: $ref: '#/components/schemas/CsvOptions' @@ -2630,6 +2670,20 @@ components: - Represents Hive data types. type: string type: object + ForeignViewDefinition: + description: >- + A view can be represented in multiple ways. Each representation has its + own dialect. This message stores the metadata required for these + representations. + id: ForeignViewDefinition + properties: + dialect: + description: Optional. Represents the dialect of the query. + type: string + query: + description: Required. The query that defines the view. + type: string + type: object GetIamPolicyRequest: description: Request message for `GetIamPolicy` method. id: GetIamPolicyRequest @@ -3335,7 +3389,11 @@ components: jobTimeoutMs: description: >- Optional. Job timeout in milliseconds. If this time limit is - exceeded, BigQuery might attempt to stop the job. + exceeded, BigQuery will attempt to stop a longer job, but may not + always succeed in canceling it before the job completes. For + example, a job that takes more than 60 seconds to complete has a + better chance of being stopped than a job that takes 10 seconds to + complete. format: int64 type: string jobType: @@ -3454,6 +3512,28 @@ components: clustering: $ref: '#/components/schemas/Clustering' description: Clustering specification for the destination table. + columnNameCharacterMap: + description: >- + Optional. Character map supported for column names in CSV/Parquet + loads. Defaults to STRICT and can be overridden by Project Config + Service. Using this option with unsupporting load formats will + result in an error. + enum: + - COLUMN_NAME_CHARACTER_MAP_UNSPECIFIED + - STRICT + - V1 + - V2 + enumDescriptions: + - Unspecified column name character map. + - Support flexible column name and reject invalid column names. + - >- + Support alphanumeric + underscore characters and names must start + with a letter or underscore. Invalid column names will be + normalized. + - >- + Support flexible column name. Invalid column names will be + normalized. + type: string connectionProperties: description: >- Optional. Connection properties which can modify the load job @@ -4229,6 +4309,22 @@ components: Output only. Statistics for data-masking. Present only for query and extract jobs. readOnly: true + edition: + description: >- + Output only. Name of edition corresponding to the reservation for + this job at the time of this update. + enum: + - RESERVATION_EDITION_UNSPECIFIED + - STANDARD + - ENTERPRISE + - ENTERPRISE_PLUS + enumDescriptions: + - Default value, which will be treated as ENTERPRISE. + - Standard edition. + - Enterprise edition. + - Enterprise plus edition. + readOnly: true + type: string endTime: description: >- Output only. End time of this job, in milliseconds since the epoch. @@ -5257,8 +5353,8 @@ components: - An imported TensorFlow Lite model. - An imported ONNX model. - >- - Model to capture the manual preprocessing logic in the transform - clause. + Model to capture the columns and logic in the TRANSFORM clause + along with statistics useful for ML analytic functions. readOnly: true type: string trainingType: @@ -5442,8 +5538,8 @@ components: - An imported TensorFlow Lite model. - An imported ONNX model. - >- - Model to capture the manual preprocessing logic in the transform - clause. + Model to capture the columns and logic in the TRANSFORM clause + along with statistics useful for ML analytic functions. readOnly: true type: string optimalTrialIds: @@ -5559,18 +5655,17 @@ components: STRING instead of BYTES by default. type: boolean mapTargetType: - description: Optional. Will indicate how to represent a parquet map if present. + description: Optional. Indicates how to represent a Parquet map if present. enum: - MAP_TARGET_TYPE_UNSPECIFIED - ARRAY_OF_STRUCT enumDescriptions: - >- - In this mode, we fall back to the default. Currently (3/24) we - represent the map as: struct map_field_name { repeated struct - key_value { key value } } + In this mode, the map will have the following schema: struct + map_field_name { repeated struct key_value { key value } }. - >- - In this mode, we omit parquet's key_value struct and represent the - map as: repeated struct map_field_name { key value } + In this mode, the map will have the following schema: repeated + struct map_field_name { key value }. type: string type: object PartitionSkew: @@ -5589,24 +5684,29 @@ components: id: PartitionedColumn properties: field: - description: Output only. The name of the partition column. - readOnly: true + description: Required. The name of the partition column. type: string type: object PartitioningDefinition: description: >- - The partitioning information, which includes managed table and external - table partition information. + The partitioning information, which includes managed table, external + table and metastore partitioned table partition information. id: PartitioningDefinition properties: partitionedColumn: description: >- - Output only. Details about each partitioning column. BigQuery native - tables only support 1 partitioning column. Other table types may - support 0, 1 or more partitioning columns. + Optional. Details about each partitioning column. This field is + output only for all partitioning types other than metastore + partitioned tables. BigQuery native tables only support 1 + partitioning column. Other table types may support 0, 1 or more + partitioning columns. For metastore partitioned tables, the order + must match the definition order in the Hive Metastore, where it must + match the physical layout of the table. For example, CREATE TABLE + a_table(id BIGINT, name STRING) PARTITIONED BY (city STRING, state + STRING). In this case the values must be ['city', 'state'] in that + order. items: $ref: '#/components/schemas/PartitionedColumn' - readOnly: true type: array type: object PerformanceInsights: @@ -6243,9 +6343,8 @@ components: properties: field: description: >- - Required. [Experimental] The table is partitioned by this field. The - field must be a top-level NULLABLE/REQUIRED field. The only - supported type is INTEGER/INT64. + Required. The name of the column to partition the table on. It must + be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. type: string range: description: '[Experimental] Defines the ranges for range partitioning.' @@ -7494,6 +7593,14 @@ components: format: int64 readOnly: true type: string + numCurrentPhysicalBytes: + description: >- + Output only. Number of physical bytes used by current live data + storage. This data is not kept in real time, and might be delayed by + a few seconds to a few minutes. + format: int64 + readOnly: true + type: string numLongTermBytes: description: >- Output only. The number of logical bytes in the table that are @@ -7562,10 +7669,11 @@ components: partitionDefinition: $ref: '#/components/schemas/PartitioningDefinition' description: >- - Output only. The partition information for all table formats, - including managed partitioned tables, hive partitioned tables, and - iceberg partitioned tables. - readOnly: true + Optional. The partition information for all table formats, including + managed partitioned tables, hive partitioned tables, iceberg + partitioned, and metastore partitioned tables. This field is only + populated for metastore partitioned tables. For other table formats, + this is an output only field. rangePartitioning: $ref: '#/components/schemas/RangePartitioning' description: If specified, configures range partitioning for this table. @@ -7844,6 +7952,11 @@ components: locale, case insensitive. * '': empty string. Default to case-sensitive behavior. type: string + dataPolicies: + description: Optional. Data policy options, will replace the data_policies. + items: + $ref: '#/components/schemas/DataPolicyOption' + type: array defaultValueExpression: description: >- Optional. A SQL expression to specify the [default value] @@ -8071,6 +8184,12 @@ components: Free form human-readable reason metadata caching was unused for the job. type: string + staleness: + description: >- + Duration since last refresh as of this job for managed tables + (indicates metadata cache staleness as seen by this job). + format: google-duration + type: string tableReference: $ref: '#/components/schemas/TableReference' description: Metadata caching eligible table referenced in the query. @@ -8138,8 +8257,9 @@ components: readOnly: true replicationIntervalMs: description: >- - Required. Specifies the interval at which the source table is polled - for updates. + Optional. Specifies the interval at which the source table is polled + for updates. It's Optional. If not specified, default replication + interval would be applied. format: int64 type: string replicationStatus: @@ -9279,6 +9399,7 @@ components: description: >- Optional. The exact time when the dataset was deleted. If not specified, the most recently deleted version is undeleted. + Undeleting a dataset using deletion time is not supported. format: google-datetime type: string type: object @@ -9339,6 +9460,11 @@ components: description: Describes the definition of a logical view. id: ViewDefinition properties: + foreignDefinitions: + description: Optional. Foreign view representations. + items: + $ref: '#/components/schemas/ForeignViewDefinition' + type: array privacyPolicy: $ref: '#/components/schemas/PrivacyPolicy' description: Optional. Specifices the privacy policy for the view. @@ -9489,16 +9615,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1projects~1{projectId}~1datasets/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.datasets - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/datasets/methods/get' @@ -9507,6 +9630,7 @@ components: - $ref: '#/components/x-stackQL-resources/datasets/methods/insert' update: - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/datasets/methods/update' delete: - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' @@ -9539,16 +9663,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1projects~1{projectId}~1jobs/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - list: - operation: *ref_3 - response: *ref_4 query: operation: $ref: '#/paths/~1projects~1{projectId}~1queries/post' @@ -9562,6 +9683,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' jobs_query_results: @@ -9581,6 +9703,7 @@ components: #/components/x-stackQL-resources/jobs_query_results/methods/get_query_results insert: [] update: [] + replace: [] delete: [] models: id: google.bigquery.models @@ -9608,17 +9731,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1models/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.models - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/models/methods/get' @@ -9626,6 +9746,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/models/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/models/methods/delete' service_account: @@ -9645,27 +9766,26 @@ components: #/components/x-stackQL-resources/service_account/methods/get_service_account insert: [] update: [] + replace: [] delete: [] projects: id: google.bigquery.projects name: projects title: Projects methods: - _list: - operation: &ref_7 + list: + operation: $ref: '#/paths/~1projects/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.projects - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/projects/methods/list' insert: [] update: [] + replace: [] delete: [] routines: id: google.bigquery.routines @@ -9700,24 +9820,22 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1routines/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.routines - list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/routines/methods/get' - $ref: '#/components/x-stackQL-resources/routines/methods/list' insert: - $ref: '#/components/x-stackQL-resources/routines/methods/insert' - update: + update: [] + replace: - $ref: '#/components/x-stackQL-resources/routines/methods/update' delete: - $ref: '#/components/x-stackQL-resources/routines/methods/delete' @@ -9736,28 +9854,27 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] row_access_policies: id: google.bigquery.row_access_policies name: row_access_policies title: Row_access_policies methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1tables~1{+tableId}~1rowAccessPolicies/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.rowAccessPolicies - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/row_access_policies/methods/list' insert: [] update: [] + replace: [] delete: [] tabledata: id: google.bigquery.tabledata @@ -9784,6 +9901,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/tabledata/methods/insert_all' update: [] + replace: [] delete: [] tables: id: google.bigquery.tables @@ -9825,17 +9943,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1projects~1{projectId}~1datasets~1{+datasetId}~1tables/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tables - list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/tables/methods/get' @@ -9844,12 +9959,13 @@ components: - $ref: '#/components/x-stackQL-resources/tables/methods/insert' update: - $ref: '#/components/x-stackQL-resources/tables/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/tables/methods/update' delete: - $ref: '#/components/x-stackQL-resources/tables/methods/delete' paths: /projects/{projectId}/datasets/{+datasetId}: - parameters: &ref_15 + parameters: &ref_1 - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' @@ -10049,7 +10165,7 @@ paths: schema: type: string /projects/{projectId}/datasets: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new empty dataset. operationId: bigquery.datasets.insert @@ -10129,7 +10245,7 @@ paths: schema: type: string /projects/{projectId}/jobs/{+jobId}/cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Requests that a job be cancelled. This call will return immediately, and @@ -10168,7 +10284,7 @@ paths: schema: type: string /projects/{projectId}/jobs/{+jobId}/delete: - parameters: *ref_15 + parameters: *ref_1 delete: description: >- Requests the deletion of the metadata of a job. This call returns when @@ -10202,7 +10318,7 @@ paths: schema: type: string /projects/{projectId}/jobs/{+jobId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Returns information about a specific job. Job information is available @@ -10245,7 +10361,7 @@ paths: schema: type: string /projects/{projectId}/queries/{+jobId}: - parameters: *ref_15 + parameters: *ref_1 get: description: RPC to get the results of a query job. operationId: bigquery.jobs.getQueryResults @@ -10308,7 +10424,7 @@ paths: type: integer format: uint32 /projects/{projectId}/jobs: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Starts a new asynchronous job. This API has two different kinds of @@ -10428,7 +10544,7 @@ paths: schema: type: string /projects/{projectId}/queries: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Runs a BigQuery SQL query synchronously and returns query results if the @@ -10466,7 +10582,7 @@ paths: schema: type: string /projects/{projectId}/datasets/{+datasetId}/models/{+modelId}: - parameters: *ref_15 + parameters: *ref_1 delete: description: Deletes the model specified by modelId from the dataset. operationId: bigquery.models.delete @@ -10578,7 +10694,7 @@ paths: schema: type: string /projects/{projectId}/datasets/{+datasetId}/models: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Lists all models in the specified dataset. Requires the READER dataset @@ -10626,7 +10742,7 @@ paths: schema: type: string /projects/{projectId}/serviceAccount: - parameters: *ref_15 + parameters: *ref_1 get: description: >- RPC to get the service account for a project used for interactions with @@ -10659,7 +10775,7 @@ paths: schema: type: string /projects: - parameters: *ref_15 + parameters: *ref_1 get: description: >- RPC to list projects to which the user has been granted any project @@ -10698,7 +10814,7 @@ paths: schema: type: string /projects/{projectId}/datasets/{+datasetId}/routines/{+routineId}: - parameters: *ref_15 + parameters: *ref_1 delete: description: Deletes the routine specified by routineId from the dataset. operationId: bigquery.routines.delete @@ -10817,7 +10933,7 @@ paths: schema: type: string /{resource}: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -10858,7 +10974,7 @@ paths: schema: type: string /projects/{projectId}/datasets/{+datasetId}/routines: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new routine in the dataset. operationId: bigquery.routines.insert @@ -10949,7 +11065,7 @@ paths: type: string format: google-fieldmask /projects/{projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists all row access policies on the specified table. operationId: bigquery.rowAccessPolicies.list @@ -10999,7 +11115,7 @@ paths: schema: type: string /projects/{projectId}/datasets/{+datasetId}/tables/{+tableId}/insertAll: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Streams data into BigQuery one record at a time without needing to run a @@ -11047,7 +11163,7 @@ paths: schema: type: string /projects/{projectId}/datasets/{+datasetId}/tables/{+tableId}/data: - parameters: *ref_15 + parameters: *ref_1 get: description: List the content of a table in rows. operationId: bigquery.tabledata.list @@ -11110,7 +11226,7 @@ paths: type: string format: uint64 /projects/{projectId}/datasets/{+datasetId}/tables/{+tableId}: - parameters: *ref_15 + parameters: *ref_1 delete: description: >- Deletes the table specified by tableId from the dataset. If the table @@ -11290,7 +11406,7 @@ paths: schema: type: boolean /projects/{projectId}/datasets/{+datasetId}/tables: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new, empty table in the dataset. operationId: bigquery.tables.insert diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml index 5bb22853..67c2257b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryconnection.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Connection API description: Allows users to manage BigQuery connections to external data sources. version: v1 - x-discovery-doc-revision: '20240418' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240803' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigquery/docs/connections-api-intro servers: @@ -99,7 +99,8 @@ components: type: boolean kmsKeyName: description: >- - Optional. The Cloud KMS key that is used for encryption. Example: + Optional. The Cloud KMS key that is used for credentials encryption. + If omitted, internal Google owned encryption keys are used. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` type: string CloudSqlProperties: @@ -368,7 +369,7 @@ components: description: Networking configuration. $ref: '#/components/schemas/ConnectorConfigurationNetwork' asset: - description: Optional. Data asset. + description: Data asset. $ref: '#/components/schemas/ConnectorConfigurationAsset' ConnectorConfigurationEndpoint: id: ConnectorConfigurationEndpoint @@ -389,6 +390,15 @@ components: usernamePassword: description: Username/password authentication. $ref: '#/components/schemas/ConnectorConfigurationUsernamePassword' + serviceAccount: + description: >- + Output only. Google-managed service account associated with this + connection, e.g., + `service-{project_number}@gcp-sa-bigqueryconnection.iam.gserviceaccount.com`. + BigQuery jobs using this connection will act as `service_account` + identity while connecting to the datasource. + readOnly: true + type: string ConnectorConfigurationUsernamePassword: id: ConnectorConfigurationUsernamePassword description: Username and Password authentication. @@ -446,7 +456,7 @@ components: type: object properties: database: - description: Optional. Name of the database. + description: Name of the database. type: string googleCloudResource: description: >- @@ -931,17 +941,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.connections - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -971,6 +978,7 @@ components: - $ref: '#/components/x-stackQL-resources/connections/methods/create' update: - $ref: '#/components/x-stackQL-resources/connections/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/connections/methods/delete' connections_iam_policies: @@ -978,17 +986,14 @@ components: name: connections_iam_policies title: Connections_iam_policies methods: - _get_iam_policy: - operation: &ref_3 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:getIamPolicy/post - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_3 - response: *ref_4 set_iam_policy: operation: $ref: >- @@ -1009,10 +1014,13 @@ components: #/components/x-stackQL-resources/connections_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/connections_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/connections: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1103,7 +1111,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Returns specified connection. operationId: bigqueryconnection.projects.locations.connections.get @@ -1222,7 +1230,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -1266,7 +1274,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -1311,7 +1319,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml index e390526f..b72dca78 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatapolicy.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Data Policy API description: Allows users to manage BigQuery data policies. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240829' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigquery/docs/column-data-masking servers: @@ -623,17 +623,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataPolicies/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataPolicies - list: - operation: *ref_1 - response: *ref_2 patch: operation: $ref: >- @@ -670,6 +667,7 @@ components: - $ref: '#/components/x-stackQL-resources/data_policies/methods/create' update: - $ref: '#/components/x-stackQL-resources/data_policies/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/data_policies/methods/delete' data_policies_iam_policies: @@ -677,17 +675,14 @@ components: name: data_policies_iam_policies title: Data_policies_iam_policies methods: - _get_iam_policy: - operation: &ref_3 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataPolicies~1{dataPoliciesId}:getIamPolicy/post - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_3 - response: *ref_4 set_iam_policy: operation: $ref: >- @@ -708,10 +703,13 @@ components: #/components/x-stackQL-resources/data_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/data_policies_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/dataPolicies: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -804,7 +802,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}: - parameters: *ref_5 + parameters: *ref_1 patch: description: >- Updates the metadata for an existing data policy. The target data policy @@ -852,6 +850,10 @@ paths: schema: type: string format: google-fieldmask + - in: query + name: allowMissing + schema: + type: boolean delete: description: Deletes the data policy specified by its resource name. operationId: bigquerydatapolicy.projects.locations.dataPolicies.delete @@ -887,6 +889,10 @@ paths: required: true schema: type: string + - in: query + name: force + schema: + type: boolean get: description: Gets the data policy specified by its resource name. operationId: bigquerydatapolicy.projects.locations.dataPolicies.get @@ -923,7 +929,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:rename: - parameters: *ref_5 + parameters: *ref_1 post: description: Renames the id (display name) of the specified data policy. operationId: bigquerydatapolicy.projects.locations.dataPolicies.rename @@ -965,7 +971,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:getIamPolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: Gets the IAM policy for the specified data policy. operationId: bigquerydatapolicy.projects.locations.dataPolicies.getIamPolicy @@ -1007,7 +1013,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:setIamPolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the IAM policy for the specified data policy. operationId: bigquerydatapolicy.projects.locations.dataPolicies.setIamPolicy @@ -1049,7 +1055,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataPolicies/{dataPoliciesId}:testIamPermissions: - parameters: *ref_5 + parameters: *ref_1 post: description: Returns the caller's permission on the specified data policy resource. operationId: bigquerydatapolicy.projects.locations.dataPolicies.testIamPermissions diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml index 966fea79..c53241f7 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigquerydatatransfer.yaml @@ -9,8 +9,8 @@ info: Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240831' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigquery-transfer/ servers: @@ -969,6 +969,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] data_sources: id: google.bigquerydatatransfer.data_sources @@ -982,16 +983,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_data_sources_list: - operation: &ref_1 + projects_data_sources_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1dataSources/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataSources - projects_data_sources_list: - operation: *ref_1 - response: *ref_2 projects_data_sources_check_valid_creds: operation: $ref: >- @@ -1006,17 +1004,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_sources_list: - operation: &ref_3 + projects_locations_data_sources_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataSources/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataSources - projects_locations_data_sources_list: - operation: *ref_3 - response: *ref_4 projects_locations_data_sources_check_valid_creds: operation: $ref: >- @@ -1036,6 +1031,7 @@ components: #/components/x-stackQL-resources/data_sources/methods/projects_data_sources_list insert: [] update: [] + replace: [] delete: [] transfer_configs: id: google.bigquerydatatransfer.transfer_configs @@ -1048,16 +1044,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_transfer_configs_list: - operation: &ref_5 + projects_transfer_configs_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1transferConfigs/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transferConfigs - projects_transfer_configs_list: - operation: *ref_5 - response: *ref_6 projects_transfer_configs_patch: operation: $ref: >- @@ -1100,17 +1093,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_transfer_configs_list: - operation: &ref_7 + projects_locations_transfer_configs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1transferConfigs/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transferConfigs - projects_locations_transfer_configs_list: - operation: *ref_7 - response: *ref_8 projects_locations_transfer_configs_patch: operation: $ref: >- @@ -1166,6 +1156,7 @@ components: #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_patch - $ref: >- #/components/x-stackQL-resources/transfer_configs/methods/projects_transfer_configs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/transfer_configs/methods/projects_locations_transfer_configs_delete @@ -1190,17 +1181,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_transfer_configs_runs_list: - operation: &ref_9 + projects_transfer_configs_runs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1transferConfigs~1{transferConfigsId}~1runs/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transferRuns - projects_transfer_configs_runs_list: - operation: *ref_9 - response: *ref_10 projects_locations_transfer_configs_runs_get: operation: $ref: >- @@ -1215,17 +1203,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_transfer_configs_runs_list: - operation: &ref_11 + projects_locations_transfer_configs_runs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1transferConfigs~1{transferConfigsId}~1runs/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transferRuns - projects_locations_transfer_configs_runs_list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: >- @@ -1238,6 +1223,7 @@ components: #/components/x-stackQL-resources/runs/methods/projects_transfer_configs_runs_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/runs/methods/projects_locations_transfer_configs_runs_delete @@ -1248,28 +1234,22 @@ components: name: transfer_logs title: Transfer_logs methods: - _projects_transfer_configs_runs_transfer_logs_list: - operation: &ref_13 + projects_transfer_configs_runs_transfer_logs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1transferConfigs~1{transferConfigsId}~1runs~1{runsId}~1transferLogs/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transferMessages - projects_transfer_configs_runs_transfer_logs_list: - operation: *ref_13 - response: *ref_14 - _projects_locations_transfer_configs_runs_transfer_logs_list: - operation: &ref_15 + projects_locations_transfer_configs_runs_transfer_logs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1transferConfigs~1{transferConfigsId}~1runs~1{runsId}~1transferLogs/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transferMessages - projects_locations_transfer_configs_runs_transfer_logs_list: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: >- @@ -1278,6 +1258,7 @@ components: #/components/x-stackQL-resources/transfer_logs/methods/projects_transfer_configs_runs_transfer_logs_list insert: [] update: [] + replace: [] delete: [] locations: id: google.bigquerydatatransfer.locations @@ -1298,16 +1279,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_list: - operation: &ref_17 + projects_locations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_17 - response: *ref_18 projects_locations_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1322,10 +1300,11 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}:enrollDataSources: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1376,7 +1355,7 @@ paths: schema: type: string /v1/projects/{projectsId}/dataSources/{dataSourcesId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Retrieves a supported data source and returns its settings. operationId: bigquerydatatransfer.projects.dataSources.get @@ -1412,7 +1391,7 @@ paths: schema: type: string /v1/projects/{projectsId}/dataSources: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists supported data sources and returns their settings. operationId: bigquerydatatransfer.projects.dataSources.list @@ -1452,7 +1431,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns true if valid credentials exist for the given data source and @@ -1495,7 +1474,7 @@ paths: schema: type: string /v1/projects/{projectsId}/transferConfigs: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a new data transfer configuration. operationId: bigquerydatatransfer.projects.transferConfigs.create @@ -1579,7 +1558,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/transferConfigs/{transferConfigsId}: - parameters: *ref_19 + parameters: *ref_1 patch: description: >- Updates a data transfer configuration. All fields must be set, even if @@ -1697,7 +1676,7 @@ paths: schema: type: string /v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Creates transfer runs for a time range [start_time, end_time]. For each @@ -1738,7 +1717,7 @@ paths: schema: type: string /v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Start manual transfer runs to be executed now with schedule_time equal @@ -1779,7 +1758,7 @@ paths: schema: type: string /v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns information about the particular transfer run. operationId: bigquerydatatransfer.projects.transferConfigs.runs.get @@ -1855,7 +1834,7 @@ paths: schema: type: string /v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns information about running and completed transfer runs. operationId: bigquerydatatransfer.projects.transferConfigs.runs.list @@ -1908,7 +1887,7 @@ paths: schema: type: string /v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns log messages for the transfer run. operationId: bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list @@ -1962,7 +1941,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}:enrollDataSources: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Enroll data sources in a user project. This allows users to create @@ -2007,7 +1986,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}:unenrollDataSources: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Unenroll data sources in a user project. This allows users to remove @@ -2049,7 +2028,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: bigquerydatatransfer.projects.locations.list @@ -2093,7 +2072,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets information about a location. operationId: bigquerydatatransfer.projects.locations.get @@ -2129,7 +2108,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Retrieves a supported data source and returns its settings. operationId: bigquerydatatransfer.projects.locations.dataSources.get @@ -2170,7 +2149,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataSources: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists supported data sources and returns their settings. operationId: bigquerydatatransfer.projects.locations.dataSources.list @@ -2215,7 +2194,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns true if valid credentials exist for the given data source and @@ -2263,7 +2242,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/transferConfigs: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a new data transfer configuration. operationId: bigquerydatatransfer.projects.locations.transferConfigs.create @@ -2357,7 +2336,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}: - parameters: *ref_19 + parameters: *ref_1 patch: description: >- Updates a data transfer configuration. All fields must be set, even if @@ -2490,7 +2469,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Creates transfer runs for a time range [start_time, end_time]. For each @@ -2536,7 +2515,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Start manual transfer runs to be executed now with schedule_time equal @@ -2582,7 +2561,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns information about the particular transfer run. operationId: bigquerydatatransfer.projects.locations.transferConfigs.runs.get @@ -2668,7 +2647,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns information about running and completed transfer runs. operationId: bigquerydatatransfer.projects.locations.transferConfigs.runs.list @@ -2726,7 +2705,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns log messages for the transfer run. operationId: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml index 0fa11387..cdc56fc0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigqueryreservation.yaml @@ -7,8 +7,8 @@ info: title: BigQuery Reservation API description: A service to modify your BigQuery flat-rate reservations. version: v1 - x-discovery-doc-revision: '20240518' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigquery/ servers: @@ -779,6 +779,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] bi_reservation: id: google.bigqueryreservation.bi_reservation @@ -804,7 +805,10 @@ components: - $ref: >- #/components/x-stackQL-resources/bi_reservation/methods/get_bi_reservation insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/bi_reservation/methods/update_bi_reservation + replace: [] delete: [] reservations: id: google.bigqueryreservation.reservations @@ -818,17 +822,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.reservations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -865,6 +866,7 @@ components: - $ref: '#/components/x-stackQL-resources/reservations/methods/create' update: - $ref: '#/components/x-stackQL-resources/reservations/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/reservations/methods/delete' assignments: @@ -879,17 +881,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}~1assignments/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.assignments - list: - operation: *ref_3 - response: *ref_4 delete: operation: $ref: >- @@ -918,6 +917,7 @@ components: - $ref: '#/components/x-stackQL-resources/assignments/methods/create' update: - $ref: '#/components/x-stackQL-resources/assignments/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/assignments/methods/delete' capacity_commitments: @@ -932,17 +932,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1capacityCommitments/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.capacityCommitments - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -988,12 +985,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/capacity_commitments/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/capacity_commitments/methods/delete paths: /v1/projects/{projectsId}/locations/{locationsId}:searchAssignments: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1063,7 +1061,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}:searchAllAssignments: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Looks up assignments for a specified resource for a particular region. @@ -1120,7 +1118,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/biReservation: - parameters: *ref_7 + parameters: *ref_1 get: description: Retrieves a BI reservation. operationId: bigqueryreservation.projects.locations.getBiReservation @@ -1197,7 +1195,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/reservations: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a new reservation resource. operationId: bigqueryreservation.projects.locations.reservations.create @@ -1277,7 +1275,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Returns information about the reservation. operationId: bigqueryreservation.projects.locations.reservations.get @@ -1396,7 +1394,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:failoverReservation: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Failover a reservation to the secondary location. The operation should @@ -1443,7 +1441,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Creates an assignment object which allows the given project to submit @@ -1566,7 +1564,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}: - parameters: *ref_7 + parameters: *ref_1 delete: description: >- Deletes a assignment. No expansion will happen. Example: * Organization @@ -1668,7 +1666,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}:move: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Moves an assignment under a new reservation. This differs from removing @@ -1719,7 +1717,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a new capacity commitment resource. operationId: bigqueryreservation.projects.locations.capacityCommitments.create @@ -1803,7 +1801,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Returns information about the capacity commitment. operationId: bigqueryreservation.projects.locations.capacityCommitments.get @@ -1932,7 +1930,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}:split: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Splits capacity commitment to two commitments of the same plan and @@ -1980,7 +1978,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments:merge: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Merges capacity commitments of the same plan into a single commitment. diff --git a/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml b/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml index cc94578e..cce9b4a9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/bigtableadmin.yaml @@ -7,8 +7,8 @@ info: title: Cloud Bigtable Admin API description: Administer your Cloud Bigtable tables and instances. version: v2 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240824' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/bigtable/ servers: @@ -1378,38 +1378,60 @@ components: 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. This might involve composing a series of steps into an - "encoding chain," for example to convert from INT64 -> STRING -> raw - bytes. In most cases, a "link" in the encoding chain will be based an on - existing GoogleSQL conversion function like `CAST`. Each link in the - encoding chain also defines the following properties: * Natural sort: - 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: STRING values sort in the same order - as their UTF-8 encodings. - Counterexample: Encoding INT64 to a - fixed-width STRING does *not* preserve sort order when dealing with - negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > - STRING("00001). - The overall encoding chain sorts naturally if *every* - link does. * 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. - The overall encoding chain is - self-delimiting if *any* link is. * Compatibility: Which other systems - have matching encoding schemes? For example, does this encoding have a - GoogleSQL equivalent? HBase? Java? + 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) > INT64(-1)`, but + `STRING("-00001") > 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? type: object properties: bytesType: description: Bytes $ref: '#/components/schemas/GoogleBigtableAdminV2TypeBytes' + stringType: + description: String + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeString' int64Type: description: Int64 $ref: '#/components/schemas/GoogleBigtableAdminV2TypeInt64' + float32Type: + description: Float32 + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeFloat32' + float64Type: + description: Float64 + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeFloat64' + boolType: + description: Bool + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeBool' + timestampType: + description: Timestamp + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeTimestamp' + dateType: + description: Date + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeDate' aggregateType: description: Aggregate $ref: '#/components/schemas/GoogleBigtableAdminV2TypeAggregate' + structType: + description: Struct + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeStruct' + arrayType: + description: Array + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeArray' + mapType: + description: Map + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeMap' GoogleBigtableAdminV2TypeBytes: id: GoogleBigtableAdminV2TypeBytes description: Bytes Values of type `Bytes` are stored in `Value.bytes_value`. @@ -1429,10 +1451,44 @@ components: GoogleBigtableAdminV2TypeBytesEncodingRaw: id: GoogleBigtableAdminV2TypeBytesEncodingRaw description: >- - Leaves the value "as-is" * Natural sort? Yes * Self-delimiting? No * + Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A type: object properties: {} + GoogleBigtableAdminV2TypeString: + id: GoogleBigtableAdminV2TypeString + description: String Values of type `String` are stored in `Value.string_value`. + type: object + properties: + encoding: + description: The encoding to use when converting to/from lower level types. + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeStringEncoding' + GoogleBigtableAdminV2TypeStringEncoding: + id: GoogleBigtableAdminV2TypeStringEncoding + description: Rules used to convert to/from lower level types. + type: object + properties: + utf8Raw: + description: 'Deprecated: if set, converts to an empty `utf8_bytes`.' + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeStringEncodingUtf8Raw' + utf8Bytes: + description: Use `Utf8Bytes` encoding. + $ref: >- + #/components/schemas/GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes + GoogleBigtableAdminV2TypeStringEncodingUtf8Raw: + id: GoogleBigtableAdminV2TypeStringEncodingUtf8Raw + description: 'Deprecated: prefer the equivalent `Utf8Bytes`.' + type: object + properties: {} + GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes: + id: GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes + 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)` + type: object + properties: {} GoogleBigtableAdminV2TypeInt64: id: GoogleBigtableAdminV2TypeInt64 description: Int64 Values of type `Int64` are stored in `Value.int_value`. @@ -1454,15 +1510,42 @@ components: id: GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes description: >- Encodes the value as an 8-byte big endian twos complement `Bytes` value. - * Natural sort? No (positive values only) * Self-delimiting? Yes * + * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` type: object properties: bytesType: - description: The underlying `Bytes` type, which may be able to encode further. + description: 'Deprecated: ignored if set.' $ref: '#/components/schemas/GoogleBigtableAdminV2TypeBytes' + GoogleBigtableAdminV2TypeFloat32: + id: GoogleBigtableAdminV2TypeFloat32 + description: Float32 Values of type `Float32` are stored in `Value.float_value`. + type: object + properties: {} + GoogleBigtableAdminV2TypeFloat64: + id: GoogleBigtableAdminV2TypeFloat64 + description: Float64 Values of type `Float64` are stored in `Value.float_value`. + type: object + properties: {} + GoogleBigtableAdminV2TypeBool: + id: GoogleBigtableAdminV2TypeBool + description: bool Values of type `Bool` are stored in `Value.bool_value`. + type: object + properties: {} + GoogleBigtableAdminV2TypeTimestamp: + id: GoogleBigtableAdminV2TypeTimestamp + description: >- + Timestamp Values of type `Timestamp` are stored in + `Value.timestamp_value`. + type: object + properties: {} + GoogleBigtableAdminV2TypeDate: + id: GoogleBigtableAdminV2TypeDate + description: Date Values of type `Date` are stored in `Value.date_value`. + type: object + properties: {} GoogleBigtableAdminV2TypeAggregate: id: GoogleBigtableAdminV2TypeAggregate description: >- @@ -1488,6 +1571,16 @@ components: sum: description: Sum aggregator. $ref: '#/components/schemas/GoogleBigtableAdminV2TypeAggregateSum' + hllppUniqueCount: + description: HyperLogLogPlusPlusUniqueCount aggregator. + $ref: >- + #/components/schemas/GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount + max: + description: Max aggregator. + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeAggregateMax' + min: + description: Min aggregator. + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeAggregateMin' GoogleBigtableAdminV2TypeAggregateSum: id: GoogleBigtableAdminV2TypeAggregateSum description: >- @@ -1495,6 +1588,86 @@ components: as input type: object properties: {} + GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount: + id: GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount + description: >- + Computes an approximate unique count over the input values. When using + raw data as input, be careful to use a consistent encoding. Otherwise + the same value encoded differently could count more than once, or two + distinct values could count as identical. Input: Any, or omit for Raw + State: TBD Special state conversions: `Int64` (the unique count + estimate) + type: object + properties: {} + GoogleBigtableAdminV2TypeAggregateMax: + id: GoogleBigtableAdminV2TypeAggregateMax + description: >- + Computes the max of the input values. Allowed input: `Int64` State: same + as input + type: object + properties: {} + GoogleBigtableAdminV2TypeAggregateMin: + id: GoogleBigtableAdminV2TypeAggregateMin + description: >- + Computes the min of the input values. Allowed input: `Int64` State: same + as input + type: object + properties: {} + GoogleBigtableAdminV2TypeStruct: + id: GoogleBigtableAdminV2TypeStruct + description: >- + A structured data value, consisting of fields which map to dynamically + typed values. Values of type `Struct` are stored in `Value.array_value` + where entries are in the same order and number as `field_types`. + type: object + properties: + fields: + description: The names and types of the fields in this struct. + type: array + items: + $ref: '#/components/schemas/GoogleBigtableAdminV2TypeStructField' + GoogleBigtableAdminV2TypeStructField: + id: GoogleBigtableAdminV2TypeStructField + description: A struct field and its type. + type: object + properties: + fieldName: + description: >- + The field name (optional). Fields without a `field_name` are + considered anonymous and cannot be referenced by name. + type: string + type: + description: The type of values in this field. + $ref: '#/components/schemas/Type' + GoogleBigtableAdminV2TypeArray: + id: GoogleBigtableAdminV2TypeArray + description: >- + An ordered list of elements of a given type. Values of type `Array` are + stored in `Value.array_value`. + type: object + properties: + elementType: + description: The type of the elements in the array. This must not be `Array`. + $ref: '#/components/schemas/Type' + GoogleBigtableAdminV2TypeMap: + id: GoogleBigtableAdminV2TypeMap + description: >- + A mapping of keys to values of a given type. Values of type `Map` are + stored in a `Value.array_value` where each entry is another + `Value.array_value` with two elements (the key and the value, in that + order). Normally encoded Map values won't have repeated keys, however, + clients are expected to handle the case in which they do. If the same + key appears multiple times, the _last_ value takes precedence. + type: object + properties: + keyType: + description: >- + The type of a map key. Only `Bytes`, `String`, and `Int64` are + allowed as key types. + $ref: '#/components/schemas/Type' + valueType: + description: The type of the values in a map. + $ref: '#/components/schemas/Type' RestoreInfo: id: RestoreInfo description: Information about a table restore. @@ -1915,11 +2088,10 @@ components: type: string expireTime: description: >- - Required. The expiration time of the backup, with microseconds - granularity that must be at least 6 hours and at most 90 days from - the time the request is received. Once the `expire_time` has passed, - Cloud Bigtable will delete the backup and free the resources used by - the backup. + Required. The expiration time of the backup. When creating a backup + or updating its `expire_time`, the value must be greater than the + backup creation time by: - At least 6 hours - At most 90 days Once + the `expire_time` has passed, Cloud Bigtable will delete the backup. type: string format: google-datetime startTime: @@ -2597,22 +2769,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2~1operations~1projects~1{projectsId}~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] instances: id: google.bigtableadmin.instances @@ -2625,16 +2795,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1instances/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}/get' @@ -2667,7 +2834,8 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/create' - update: + update: [] + replace: - $ref: '#/components/x-stackQL-resources/instances/methods/update' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' @@ -2676,17 +2844,14 @@ components: name: instances_iam_policies title: Instances_iam_policies methods: - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}:getIamPolicy/post - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 set_iam_policy: operation: $ref: >- @@ -2707,6 +2872,9 @@ components: #/components/x-stackQL-resources/instances_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/set_iam_policy delete: [] clusters: id: google.bigtableadmin.clusters @@ -2720,17 +2888,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1clusters/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clusters - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -2765,7 +2930,8 @@ components: - $ref: '#/components/x-stackQL-resources/clusters/methods/list' insert: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' - update: + update: [] + replace: - $ref: '#/components/x-stackQL-resources/clusters/methods/update' delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' @@ -2774,22 +2940,20 @@ components: name: hot_tablets title: Hot_tablets methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1clusters~1{clustersId}~1hotTablets/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.hotTablets - list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/hot_tablets/methods/list' insert: [] update: [] + replace: [] delete: [] backups: id: google.bigtableadmin.backups @@ -2803,17 +2967,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1clusters~1{clustersId}~1backups/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backups - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -2850,6 +3011,7 @@ components: - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: - $ref: '#/components/x-stackQL-resources/backups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_iam_policies: @@ -2857,17 +3019,14 @@ components: name: backups_iam_policies title: Backups_iam_policies methods: - _get_iam_policy: - operation: &ref_13 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1clusters~1{clustersId}~1backups~1{backupsId}:getIamPolicy/post - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_13 - response: *ref_14 set_iam_policy: operation: $ref: >- @@ -2888,6 +3047,9 @@ components: #/components/x-stackQL-resources/backups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backups_iam_policies/methods/set_iam_policy delete: [] app_profiles: id: google.bigtableadmin.app_profiles @@ -2901,17 +3063,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1appProfiles/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.appProfiles - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -2941,6 +3100,7 @@ components: - $ref: '#/components/x-stackQL-resources/app_profiles/methods/create' update: - $ref: '#/components/x-stackQL-resources/app_profiles/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/app_profiles/methods/delete' tables: @@ -2955,17 +3115,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tables - list: - operation: *ref_17 - response: *ref_18 get: operation: $ref: >- @@ -3037,6 +3194,7 @@ components: - $ref: '#/components/x-stackQL-resources/tables/methods/create' update: - $ref: '#/components/x-stackQL-resources/tables/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tables/methods/delete' tables_iam_policies: @@ -3044,17 +3202,14 @@ components: name: tables_iam_policies title: Tables_iam_policies methods: - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}:getIamPolicy/post - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 set_iam_policy: operation: $ref: >- @@ -3075,6 +3230,9 @@ components: #/components/x-stackQL-resources/tables_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/tables_iam_policies/methods/set_iam_policy delete: [] authorized_views: id: google.bigtableadmin.authorized_views @@ -3088,17 +3246,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1authorizedViews/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.authorizedViews - list: - operation: *ref_21 - response: *ref_22 get: operation: $ref: >- @@ -3128,6 +3283,7 @@ components: - $ref: '#/components/x-stackQL-resources/authorized_views/methods/create' update: - $ref: '#/components/x-stackQL-resources/authorized_views/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/authorized_views/methods/delete' authorized_views_iam_policies: @@ -3135,17 +3291,14 @@ components: name: authorized_views_iam_policies title: Authorized_views_iam_policies methods: - _get_iam_policy: - operation: &ref_23 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1instances~1{instancesId}~1tables~1{tablesId}~1authorizedViews~1{authorizedViewsId}:getIamPolicy/post - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_23 - response: *ref_24 set_iam_policy: operation: $ref: >- @@ -3166,31 +3319,32 @@ components: #/components/x-stackQL-resources/authorized_views_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/authorized_views_iam_policies/methods/set_iam_policy delete: [] locations: id: google.bigtableadmin.locations name: locations title: Locations methods: - _list: - operation: &ref_25 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_25 - response: *ref_26 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v2/operations/{operationsId}: - parameters: &ref_27 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3251,7 +3405,7 @@ paths: schema: type: string /v2/operations/projects/{projectsId}/operations: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3313,7 +3467,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Create an instance within a project. Note that exactly one of @@ -3416,7 +3570,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets information about an instance. operationId: bigtableadmin.projects.instances.get @@ -3627,7 +3781,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for an instance resource. Returns an @@ -3682,7 +3836,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on an instance resource. Replaces any @@ -3737,7 +3891,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified instance @@ -3792,7 +3946,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Creates a cluster within an instance. Note that exactly one of @@ -3909,7 +4063,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets information about a cluster. operationId: bigtableadmin.projects.instances.clusters.get @@ -4146,7 +4300,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/hotTablets: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists hot tablets in a cluster, within the time range provided. Hot @@ -4220,7 +4374,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Starts creating a new Cloud Bigtable Backup. The returned backup @@ -4349,7 +4503,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets metadata on a pending or completed Cloud Bigtable Backup. operationId: bigtableadmin.projects.instances.clusters.backups.get @@ -4517,7 +4671,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups:copy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Copy a Cloud Bigtable backup to a new backup in the destination cluster @@ -4573,7 +4727,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for a Bigtable resource. Returns an empty @@ -4634,7 +4788,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on a Bigtable resource. Replaces any @@ -4695,7 +4849,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified Bigtable @@ -4756,7 +4910,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/appProfiles: - parameters: *ref_27 + parameters: *ref_1 post: description: Creates an app profile within an instance. operationId: bigtableadmin.projects.instances.appProfiles.create @@ -4872,7 +5026,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/appProfiles/{appProfilesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets information about an app profile. operationId: bigtableadmin.projects.instances.appProfiles.get @@ -5049,7 +5203,7 @@ paths: schema: type: boolean /v2/projects/{projectsId}/instances/{instancesId}/tables: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Creates a new table in the specified instance. The table can be created @@ -5159,7 +5313,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets metadata information about the specified table. operationId: bigtableadmin.projects.instances.tables.get @@ -5320,7 +5474,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:undelete: - parameters: *ref_27 + parameters: *ref_1 post: description: Restores a specified table which was accidentally deleted. operationId: bigtableadmin.projects.instances.tables.undelete @@ -5374,7 +5528,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:modifyColumnFamilies: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Performs a series of column family modifications on the specified table. @@ -5432,7 +5586,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:dropRowRange: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Permanently drop/delete a row range from a specified table. The request @@ -5492,7 +5646,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:generateConsistencyToken: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Generates a consistency token for a Table, which can be used in @@ -5550,7 +5704,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:checkConsistency: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Checks replication consistency based on a consistency token, that is, if @@ -5607,7 +5761,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables:restore: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Create a new table by restoring from a completed backup. The returned @@ -5660,7 +5814,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for a Bigtable resource. Returns an empty @@ -5716,7 +5870,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on a Bigtable resource. Replaces any @@ -5772,7 +5926,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified Bigtable @@ -5828,7 +5982,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews: - parameters: *ref_27 + parameters: *ref_1 post: description: Creates a new AuthorizedView in a table. operationId: bigtableadmin.projects.instances.tables.authorizedViews.create @@ -5946,7 +6100,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets information from a specified AuthorizedView. operationId: bigtableadmin.projects.instances.tables.authorizedViews.get @@ -6126,7 +6280,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for a Bigtable resource. Returns an empty @@ -6187,7 +6341,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on a Bigtable resource. Replaces any @@ -6248,7 +6402,7 @@ paths: schema: type: string /v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}/authorizedViews/{authorizedViewsId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified Bigtable @@ -6310,7 +6464,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: bigtableadmin.projects.locations.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml index 8ee30d34..8dc2aa7d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/billingbudgets.yaml @@ -9,8 +9,8 @@ info: The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/billing/docs/how-to/budget-api-overview servers: @@ -37,9 +37,182 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudBillingBudgetsV1ThresholdRule: - id: GoogleCloudBillingBudgetsV1ThresholdRule + GoogleTypeDate: + properties: + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + type: integer + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + format: int32 + type: integer + day: + type: integer + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + type: object + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + GoogleCloudBillingBudgetsV1Filter: + description: A filter for a budget, limiting the scope of the cost to calculate. + id: GoogleCloudBillingBudgetsV1Filter + type: object + properties: + calendarPeriod: + type: string + enumDescriptions: + - >- + Calendar period is unset. This is the default if the budget is for + a custom time period (CustomPeriod). + - >- + A month. Month starts on the first day of each month, such as + January 1, February 1, March 1, and so on. + - >- + A quarter. Quarters start on dates January 1, April 1, July 1, and + October 1 of each year. + - A year. Year starts on January 1. + description: >- + Optional. Specifies to track usage for recurring calendar period. + For example, assume that CalendarPeriod.QUARTER is set. The budget + tracks usage from April 1 to June 30, when the current calendar + month is April, May, June. After that, it tracks usage from July 1 + to September 30 when the current calendar month is July, August, + September, so on. + enum: + - CALENDAR_PERIOD_UNSPECIFIED + - MONTH + - QUARTER + - YEAR + projects: + type: array + items: + type: string + description: >- + Optional. A set of projects of the form `projects/{project}`, + specifying that usage from only this set of projects should be + included in the budget. If omitted, the report includes all usage + for the billing account, regardless of which project the usage + occurred on. + labels: + type: object + additionalProperties: + type: array + items: + type: any + description: >- + Optional. A single label and value pair specifying that usage from + only this set of labeled resources should be included in the budget. + If omitted, the report includes all labeled and unlabeled usage. An + object containing a single `"key": value` pair. Example: `{ "name": + "wrench" }`. _Currently, multiple entries or multiple values per + entry are not allowed._ + creditTypesTreatment: + enumDescriptions: + - '' + - >- + All types of credit are subtracted from the gross cost to + determine the spend for threshold calculations. + - >- + All types of credit are added to the net cost to determine the + spend for threshold calculations. + - >- + [Credit + types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) + specified in the credit_types field are subtracted from the gross + cost to determine the spend for threshold calculations. + type: string + enum: + - CREDIT_TYPES_TREATMENT_UNSPECIFIED + - INCLUDE_ALL_CREDITS + - EXCLUDE_ALL_CREDITS + - INCLUDE_SPECIFIED_CREDITS + description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. + creditTypes: + type: array + description: >- + Optional. If Filter.credit_types_treatment is + INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be + subtracted from gross cost to determine the spend for threshold + calculations. See [a list of acceptable credit type + values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). + If Filter.credit_types_treatment is **not** + INCLUDE_SPECIFIED_CREDITS, this field must be empty. + items: + type: string + resourceAncestors: + description: >- + Optional. A set of folder and organization names of the form + `folders/{folderId}` or `organizations/{organizationId}`, specifying + that usage from only this set of folders and organizations should be + included in the budget. If omitted, the budget includes all usage + that the billing account pays for. If the folder or organization + contains projects that are paid for by a different Cloud Billing + account, the budget *doesn't* apply to those projects. + items: + type: string + type: array + subaccounts: + description: >- + Optional. A set of subaccounts of the form + `billingAccounts/{account_id}`, specifying that usage from only this + set of subaccounts should be included in the budget. If a subaccount + is set to the name of the parent account, usage from the parent + account is included. If the field is omitted, the report includes + usage from the parent account and all subaccounts, if they exist. + type: array + items: + type: string + services: + type: array + description: >- + Optional. A set of services of the form `services/{service_id}`, + specifying that usage from only this set of services should be + included in the budget. If omitted, the report includes usage for + all the services. The service names are available through the + Catalog API: + https://cloud.google.com/billing/v1/how-tos/catalog-api. + items: + type: string + customPeriod: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' + description: >- + Optional. Specifies to track usage from any start date (required) to + any end date (optional). This time period is static, it does not + recur. + GoogleCloudBillingBudgetsV1ListBudgetsResponse: + description: Response for ListBudgets + id: GoogleCloudBillingBudgetsV1ListBudgetsResponse type: object + properties: + nextPageToken: + description: >- + If not empty, indicates that there may be more budgets that match + the request; this value should be passed in a new + `ListBudgetsRequest`. + type: string + budgets: + items: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + description: List of the budgets owned by the requested billing account. + type: array + GoogleCloudBillingBudgetsV1ThresholdRule: description: >- ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification @@ -54,12 +227,19 @@ components: your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). + type: object properties: - spendBasis: + thresholdPercent: + type: number + format: double description: >- - Optional. The type of basis used to determine if spend has passed - the threshold. Behavior defaults to CURRENT_SPEND if not set. - type: string + Required. Send an alert when this threshold is exceeded. This is a + 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + spendBasis: + enum: + - BASIS_UNSPECIFIED + - CURRENT_SPEND + - FORECASTED_SPEND enumDescriptions: - Unspecified threshold basis. - >- @@ -70,141 +250,110 @@ components: against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. - enum: - - BASIS_UNSPECIFIED - - CURRENT_SPEND - - FORECASTED_SPEND - thresholdPercent: - format: double - type: number + type: string description: >- - Required. Send an alert when this threshold is exceeded. This is a - 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. - GoogleCloudBillingBudgetsV1BudgetAmount: - description: The budgeted amount for each usage period. - id: GoogleCloudBillingBudgetsV1BudgetAmount + Optional. The type of basis used to determine if spend has passed + the threshold. Behavior defaults to CURRENT_SPEND if not set. + id: GoogleCloudBillingBudgetsV1ThresholdRule + GoogleProtobufEmpty: + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + id: GoogleProtobufEmpty + GoogleCloudBillingBudgetsV1CustomPeriod: + description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). type: object properties: - specifiedAmount: - description: >- - A specified amount to use as the budget. `currency_code` is - optional. If specified when creating a budget, it must match the - currency of the billing account. If specified when updating a - budget, it must match the currency_code of the existing budget. The - `currency_code` is provided on output. - $ref: '#/components/schemas/GoogleTypeMoney' - lastPeriodAmount: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' + endDate: + $ref: '#/components/schemas/GoogleTypeDate' description: >- - Use the last period's actual spend as the budget for the present - period. LastPeriodAmount can only be set when the budget's time - period is a Filter.calendar_period. It cannot be set in combination - with Filter.custom_period. - GoogleCloudBillingBudgetsV1NotificationsRule: - type: object - id: GoogleCloudBillingBudgetsV1NotificationsRule - description: >- - NotificationsRule defines notifications that are sent based on budget - spend and thresholds. + Optional. The end date of the time period. Budgets with elapsed end + date won't be processed. If unset, specifies to track all usage + incurred since the start_date. + startDate: + description: Required. The start date must be after January 1, 2017. + $ref: '#/components/schemas/GoogleTypeDate' + id: GoogleCloudBillingBudgetsV1CustomPeriod + GoogleTypeMoney: + description: Represents an amount of money with its currency type. + id: GoogleTypeMoney properties: - pubsubTopic: + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + nanos: description: >- - Optional. The name of the Pub/Sub topic where budget-related - messages are published, in the form - `projects/{project_id}/topics/{topic_id}`. Updates are sent to the - topic at regular intervals; the timing of the updates is not - dependent on the [threshold rules](#thresholdrule) you've set. Note - that if you want your [Pub/Sub JSON - object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) - to contain data for `alertThresholdExceeded`, you need at least one - [alert threshold rule](#thresholdrule). When you set threshold - rules, you must also enable at least one of the email notification - options, either using the default IAM recipients or Cloud Monitoring - email notification channels. To use Pub/Sub topics with budgets, you - must do the following: 1. Create the Pub/Sub topic before connecting - it to your budget. For guidance, see [Manage programmatic budget - alert - notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). - 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission - on the Pub/Sub topic. If not set, the API call fails with - PERMISSION_DENIED. For additional details on Pub/Sub roles and - permissions, see [Permissions required for this - task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + units: type: string - enableProjectLevelRecipients: - type: boolean - description: >- - Optional. When set to true, and when the budget has a single project - configured, notifications will be sent to project level recipients - of that project. This field will be ignored if the budget has - multiple or no project configured. Currently, project level - recipients are the users with `Owner` role on a cloud project. - monitoringNotificationChannels: - type: array description: >- - Optional. Email targets to send notifications to when a threshold is - exceeded. This is in addition to the `DefaultIamRecipients` who - receive alert emails based on their billing account IAM role. The - value is the full REST resource name of a Cloud Monitoring email - notification channel with the form - `projects/{project_id}/notificationChannels/{channel_id}`. A maximum - of 5 email notifications are allowed. To customize budget alert - email recipients with monitoring notification channels, you _must - create the monitoring notification channels before you link them to - a budget_. For guidance on setting up notification channels to use - with budgets, see [Customize budget alert email - recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). - For Cloud Billing budget alerts, you _must use email notification - channels_. The other types of notification channels are _not_ - supported, such as Slack, SMS, or PagerDuty. If you want to [send - budget notifications to - Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), - use a pubsubTopic and configure [programmatic - notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). - items: - type: string - schemaVersion: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + format: int64 + type: object + GoogleCloudBillingBudgetsV1LastPeriodAmount: + description: >- + Describes a budget amount targeted to the last Filter.calendar_period + spend. At this time, the amount is automatically 100% of the last + calendar period's spend; that is, there are no other options yet. + LastPeriodAmount cannot be set for a budget configured with a + Filter.custom_period. + type: object + properties: {} + id: GoogleCloudBillingBudgetsV1LastPeriodAmount + GoogleCloudBillingBudgetsV1BudgetAmount: + properties: + specifiedAmount: + $ref: '#/components/schemas/GoogleTypeMoney' description: >- - Optional. Required when NotificationsRule.pubsub_topic is set. The - schema version of the notification sent to - NotificationsRule.pubsub_topic. Only "1.0" is accepted. It - represents the JSON schema as defined in - https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. - type: string - disableDefaultIamRecipients: + A specified amount to use as the budget. `currency_code` is + optional. If specified when creating a budget, it must match the + currency of the billing account. If specified when updating a + budget, it must match the currency_code of the existing budget. The + `currency_code` is provided on output. + lastPeriodAmount: description: >- - Optional. When set to true, disables default notifications sent when - a threshold is exceeded. Default notifications are sent to those - with Billing Account Administrator and Billing Account User IAM - roles for the target account. - type: boolean + Use the last period's actual spend as the budget for the present + period. LastPeriodAmount can only be set when the budget's time + period is a Filter.calendar_period. It cannot be set in combination + with Filter.custom_period. + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1LastPeriodAmount' + description: The budgeted amount for each usage period. + type: object + id: GoogleCloudBillingBudgetsV1BudgetAmount GoogleCloudBillingBudgetsV1Budget: - description: >- - A budget is a plan that describes what you expect to spend on Cloud - projects, plus the rules to execute as spend is tracked against that - plan, (for example, send an alert when 90% of the target spend is met). - The budget time period is configurable, with options such as month - (default), quarter, year, or custom time period. + id: GoogleCloudBillingBudgetsV1Budget + type: object properties: - name: - readOnly: true - description: >- - Output only. Resource name of the budget. The resource name implies - the scope of a budget. Values are of the form - `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - type: string - etag: + ownershipScope: type: string - description: >- - Optional. Etag to validate that the object is unchanged for a - read-modify-write operation. An empty etag causes an update to - overwrite other changes. - notificationsRule: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' - description: >- - Optional. Rules to apply to notifications sent based on budget spend - and thresholds. + enumDescriptions: + - Unspecified ownership scope, same as ALL_USERS. + - >- + Both billing account-level users and project-level users have full + access to the budget, if the users have the required IAM + permissions. + - >- + Only billing account-level users have full access to the budget. + Project-level users have read-only access, even if they have the + required IAM permissions. + enum: + - OWNERSHIP_SCOPE_UNSPECIFIED + - ALL_USERS + - BILLING_ACCOUNT thresholdRules: + type: array items: $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1ThresholdRule' description: >- @@ -212,7 +361,23 @@ components: being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. - type: array + notificationsRule: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1NotificationsRule' + description: >- + Optional. Rules to apply to notifications sent based on budget spend + and thresholds. + name: + type: string + description: >- + Output only. Resource name of the budget. The resource name implies + the scope of a budget. Values are of the form + `billingAccounts/{billingAccountId}/budgets/{budgetId}`. + readOnly: true + displayName: + description: >- + User data for display name in UI. The name must be less than or + equal to 60 characters. + type: string budgetFilter: description: >- Optional. Filters that define which resources are used to compute @@ -222,293 +387,101 @@ components: amount: description: Required. Budgeted amount. $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1BudgetAmount' - ownershipScope: - enum: - - OWNERSHIP_SCOPE_UNSPECIFIED - - ALL_USERS - - BILLING_ACCOUNT - enumDescriptions: - - Unspecified ownership scope, same as ALL_USERS. - - >- - Both billing account-level users and project-level users have full - access to the budget, if the users have the required IAM - permissions. - - >- - Only billing account-level users have full access to the budget. - Project-level users have read-only access, even if they have the - required IAM permissions. - type: string - displayName: + etag: description: >- - User data for display name in UI. The name must be less than or - equal to 60 characters. + Optional. Etag to validate that the object is unchanged for a + read-modify-write operation. An empty etag causes an update to + overwrite other changes. type: string - type: object - id: GoogleCloudBillingBudgetsV1Budget - GoogleCloudBillingBudgetsV1LastPeriodAmount: - type: object description: >- - Describes a budget amount targeted to the last Filter.calendar_period - spend. At this time, the amount is automatically 100% of the last - calendar period's spend; that is, there are no other options yet. - LastPeriodAmount cannot be set for a budget configured with a - Filter.custom_period. - id: GoogleCloudBillingBudgetsV1LastPeriodAmount - properties: {} - GoogleProtobufEmpty: - properties: {} - type: object + A budget is a plan that describes what you expect to spend on Cloud + projects, plus the rules to execute as spend is tracked against that + plan, (for example, send an alert when 90% of the target spend is met). + The budget time period is configurable, with options such as month + (default), quarter, year, or custom time period. + GoogleCloudBillingBudgetsV1NotificationsRule: description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: GoogleProtobufEmpty - GoogleCloudBillingBudgetsV1Filter: - description: A filter for a budget, limiting the scope of the cost to calculate. + NotificationsRule defines notifications that are sent based on budget + spend and thresholds. properties: - projects: - items: - type: string - type: array - description: >- - Optional. A set of projects of the form `projects/{project}`, - specifying that usage from only this set of projects should be - included in the budget. If omitted, the report includes all usage - for the billing account, regardless of which project the usage - occurred on. - labels: - description: >- - Optional. A single label and value pair specifying that usage from - only this set of labeled resources should be included in the budget. - If omitted, the report includes all labeled and unlabeled usage. An - object containing a single `"key": value` pair. Example: `{ "name": - "wrench" }`. _Currently, multiple entries or multiple values per - entry are not allowed._ - type: object - additionalProperties: - type: array - items: - type: any - calendarPeriod: - enum: - - CALENDAR_PERIOD_UNSPECIFIED - - MONTH - - QUARTER - - YEAR - type: string - enumDescriptions: - - >- - Calendar period is unset. This is the default if the budget is for - a custom time period (CustomPeriod). - - >- - A month. Month starts on the first day of each month, such as - January 1, February 1, March 1, and so on. - - >- - A quarter. Quarters start on dates January 1, April 1, July 1, and - October 1 of each year. - - A year. Year starts on January 1. - description: >- - Optional. Specifies to track usage for recurring calendar period. - For example, assume that CalendarPeriod.QUARTER is set. The budget - tracks usage from April 1 to June 30, when the current calendar - month is April, May, June. After that, it tracks usage from July 1 - to September 30 when the current calendar month is July, August, - September, so on. - creditTypes: - items: - type: string - type: array - description: >- - Optional. If Filter.credit_types_treatment is - INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be - subtracted from gross cost to determine the spend for threshold - calculations. See [a list of acceptable credit type - values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). - If Filter.credit_types_treatment is **not** - INCLUDE_SPECIFIED_CREDITS, this field must be empty. - customPeriod: - description: >- - Optional. Specifies to track usage from any start date (required) to - any end date (optional). This time period is static, it does not - recur. - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1CustomPeriod' - subaccounts: - type: array - description: >- - Optional. A set of subaccounts of the form - `billingAccounts/{account_id}`, specifying that usage from only this - set of subaccounts should be included in the budget. If a subaccount - is set to the name of the parent account, usage from the parent - account is included. If the field is omitted, the report includes - usage from the parent account and all subaccounts, if they exist. - items: - type: string - creditTypesTreatment: - enumDescriptions: - - '' - - >- - All types of credit are subtracted from the gross cost to - determine the spend for threshold calculations. - - >- - All types of credit are added to the net cost to determine the - spend for threshold calculations. - - >- - [Credit - types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) - specified in the credit_types field are subtracted from the gross - cost to determine the spend for threshold calculations. + pubsubTopic: type: string - description: Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - enum: - - CREDIT_TYPES_TREATMENT_UNSPECIFIED - - INCLUDE_ALL_CREDITS - - EXCLUDE_ALL_CREDITS - - INCLUDE_SPECIFIED_CREDITS - services: - items: - type: string - description: >- - Optional. A set of services of the form `services/{service_id}`, - specifying that usage from only this set of services should be - included in the budget. If omitted, the report includes usage for - all the services. The service names are available through the - Catalog API: - https://cloud.google.com/billing/v1/how-tos/catalog-api. - type: array - resourceAncestors: - items: - type: string - type: array - description: >- - Optional. A set of folder and organization names of the form - `folders/{folderId}` or `organizations/{organizationId}`, specifying - that usage from only this set of folders and organizations should be - included in the budget. If omitted, the budget includes all usage - that the billing account pays for. If the folder or organization - contains projects that are paid for by a different Cloud Billing - account, the budget *doesn't* apply to those projects. - type: object - id: GoogleCloudBillingBudgetsV1Filter - GoogleCloudBillingBudgetsV1CustomPeriod: - properties: - startDate: - description: Required. The start date must be after January 1, 2017. - $ref: '#/components/schemas/GoogleTypeDate' - endDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: >- - Optional. The end date of the time period. Budgets with elapsed end - date won't be processed. If unset, specifies to track all usage - incurred since the start_date. - type: object - description: All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). - id: GoogleCloudBillingBudgetsV1CustomPeriod - GoogleTypeDate: - id: GoogleTypeDate - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object - properties: - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - type: integer - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - month: - type: integer - format: int32 description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - GoogleTypeMoney: - description: Represents an amount of money with its currency type. - type: object - id: GoogleTypeMoney - properties: - nanos: - type: integer - format: int32 + Optional. The name of the Pub/Sub topic where budget-related + messages are published, in the form + `projects/{project_id}/topics/{topic_id}`. Updates are sent to the + topic at regular intervals; the timing of the updates is not + dependent on the [threshold rules](#thresholdrule) you've set. Note + that if you want your [Pub/Sub JSON + object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) + to contain data for `alertThresholdExceeded`, you need at least one + [alert threshold rule](#thresholdrule). When you set threshold + rules, you must also enable at least one of the email notification + options, either using the default IAM recipients or Cloud Monitoring + email notification channels. To use Pub/Sub topics with budgets, you + must do the following: 1. Create the Pub/Sub topic before connecting + it to your budget. For guidance, see [Manage programmatic budget + alert + notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission + on the Pub/Sub topic. If not set, the API call fails with + PERMISSION_DENIED. For additional details on Pub/Sub roles and + permissions, see [Permissions required for this + task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). + disableDefaultIamRecipients: description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - currencyCode: - description: The three-letter currency code defined in ISO 4217. - type: string - units: + Optional. When set to true, disables default notifications sent when + a threshold is exceeded. Default notifications are sent to those + with Billing Account Administrator and Billing Account User IAM + roles for the target account. + type: boolean + enableProjectLevelRecipients: + description: >- + Optional. When set to true, and when the budget has a single project + configured, notifications will be sent to project level recipients + of that project. This field will be ignored if the budget has + multiple or no project configured. Currently, project level + recipients are the users with `Owner` role on a cloud project. + type: boolean + schemaVersion: type: string - format: int64 description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - GoogleCloudBillingBudgetsV1ListBudgetsResponse: - description: Response for ListBudgets - properties: - nextPageToken: + Optional. Required when NotificationsRule.pubsub_topic is set. The + schema version of the notification sent to + NotificationsRule.pubsub_topic. Only "1.0" is accepted. It + represents the JSON schema as defined in + https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + monitoringNotificationChannels: description: >- - If not empty, indicates that there may be more budgets that match - the request; this value should be passed in a new - `ListBudgetsRequest`. - type: string - budgets: - description: List of the budgets owned by the requested billing account. - type: array + Optional. Email targets to send notifications to when a threshold is + exceeded. This is in addition to the `DefaultIamRecipients` who + receive alert emails based on their billing account IAM role. The + value is the full REST resource name of a Cloud Monitoring email + notification channel with the form + `projects/{project_id}/notificationChannels/{channel_id}`. A maximum + of 5 email notifications are allowed. To customize budget alert + email recipients with monitoring notification channels, you _must + create the monitoring notification channels before you link them to + a budget_. For guidance on setting up notification channels to use + with budgets, see [Customize budget alert email + recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). + For Cloud Billing budget alerts, you _must use email notification + channels_. The other types of notification channels are _not_ + supported, such as Slack, SMS, or PagerDuty. If you want to [send + budget notifications to + Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), + use a pubsubTopic and configure [programmatic + notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). items: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + type: string + type: array + id: GoogleCloudBillingBudgetsV1NotificationsRule type: object - id: GoogleCloudBillingBudgetsV1ListBudgetsResponse parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: key + name: uploadType schema: type: string _.xgafv: @@ -536,19 +509,10 @@ components: - json - media - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: uploadType + name: upload_protocol schema: type: string prettyPrint: @@ -557,6 +521,42 @@ components: name: prettyPrint schema: type: boolean + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string x-stackQL-resources: budgets: id: google.billingbudgets.budgets @@ -570,6 +570,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' delete: operation: $ref: >- @@ -577,29 +584,19 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets~1{budgetsId}/get + $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.budgets create: operation: $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/post' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1budgets/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.budgets - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/budgets/methods/get' @@ -608,22 +605,23 @@ components: - $ref: '#/components/x-stackQL-resources/budgets/methods/create' update: - $ref: '#/components/x-stackQL-resources/budgets/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/budgets/methods/delete' paths: /v1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}: - parameters: &ref_3 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/key' + parameters: &ref_1 + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' patch: description: >- Updates a budget and returns the updated budget. WARNING: There are some @@ -668,9 +666,13 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes a budget. Returns successfully if already deleted. - operationId: billingbudgets.billingAccounts.budgets.delete + get: + description: >- + Returns a budget. WARNING: There are some fields exposed on the Google + Cloud Console that aren't available on this API. When reading from the + API, you will not see these fields in the return value, though they may + have been set in the Cloud Console. + operationId: billingbudgets.billingAccounts.budgets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -686,7 +688,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' parameters: - in: path name: billingAccountsId @@ -698,13 +700,9 @@ paths: required: true schema: type: string - get: - description: >- - Returns a budget. WARNING: There are some fields exposed on the Google - Cloud Console that aren't available on this API. When reading from the - API, you will not see these fields in the return value, though they may - have been set in the Cloud Console. - operationId: billingbudgets.billingAccounts.budgets.get + delete: + description: Deletes a budget. Returns successfully if already deleted. + operationId: billingbudgets.billingAccounts.budgets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -720,7 +718,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: billingAccountsId @@ -733,18 +731,14 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}/budgets: - parameters: *ref_3 - post: + parameters: *ref_1 + get: description: >- - Creates a new budget. See [Quotas and - limits](https://cloud.google.com/billing/quotas) for more information on - the limits of the number of budgets you can create. - operationId: billingbudgets.billingAccounts.budgets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + Returns a list of budgets for a billing account. WARNING: There are some + fields exposed on the Google Cloud Console that aren't available on this + API. When reading from the API, you will not see these fields in the + return value, though they may have been set in the Cloud Console. + operationId: billingbudgets.billingAccounts.budgets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -760,20 +754,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' + $ref: >- + #/components/schemas/GoogleCloudBillingBudgetsV1ListBudgetsResponse parameters: - in: path name: billingAccountsId required: true schema: type: string - get: + - in: query + name: scope + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: description: >- - Returns a list of budgets for a billing account. WARNING: There are some - fields exposed on the Google Cloud Console that aren't available on this - API. When reading from the API, you will not see these fields in the - return value, though they may have been set in the Cloud Console. - operationId: billingbudgets.billingAccounts.budgets.list + Creates a new budget. See [Quotas and + limits](https://cloud.google.com/billing/quotas) for more information on + the limits of the number of budgets you can create. + operationId: billingbudgets.billingAccounts.budgets.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' security: - Oauth2: - https://www.googleapis.com/auth/cloud-billing @@ -789,24 +801,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudBillingBudgetsV1ListBudgetsResponse + $ref: '#/components/schemas/GoogleCloudBillingBudgetsV1Budget' parameters: - in: path name: billingAccountsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml b/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml index 0001f802..9c585f70 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/binaryauthorization.yaml @@ -11,8 +11,8 @@ info: Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/binary-authorization/ servers: @@ -285,6 +285,11 @@ components: readOnly: true type: string format: google-datetime + etag: + description: >- + Optional. Used to prevent updating the policy when another request + has updated it since it was retrieved. + type: string GkePolicy: id: GkePolicy description: >- @@ -569,15 +574,15 @@ components: description: >- Optional. The ID of this public key. Signatures verified by Binary Authorization must include the ID of the public key that can be used - to verify them, and that ID must match the contents of this field - exactly. This may be explicitly provided by the caller, but it MUST - be a valid RFC3986 URI. If `key_id` is left blank and this + to verify them. The ID must match exactly contents of the `key_id` + field exactly. The ID may be explicitly provided by the caller, but + it MUST be a valid RFC3986 URI. If `key_id` is left blank and this `PkixPublicKey` is not used in the context of a wrapper (see next paragraph), a default key ID will be computed based on the digest of the DER encoding of the public key. If this `PkixPublicKey` is used in the context of a wrapper that has its own notion of key ID (e.g. - `AttestorPublicKey`), then this field can either: * Match that value - exactly. * Or be left blank, in which case it behaves exactly as + `AttestorPublicKey`), then this field can either match that value + exactly, or be left blank, in which case it behaves exactly as though it is equal to that wrapper value. type: string TrustedDirectoryCheck: @@ -1677,6 +1682,8 @@ components: - $ref: '#/components/x-stackQL-resources/policy/methods/get_policy' insert: [] update: [] + replace: + - $ref: '#/components/x-stackQL-resources/policy/methods/update_policy' delete: [] policies: id: google.binaryauthorization.policies @@ -1697,17 +1704,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1platforms~1{platformsId}~1policies/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.platformPolicies - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -1736,6 +1740,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/policies/methods/create' update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/policies/methods/replace_platform_policy delete: - $ref: '#/components/x-stackQL-resources/policies/methods/delete' attestors: @@ -1749,16 +1756,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1attestors/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.attestors - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1attestors~1{attestorsId}/get' @@ -1791,7 +1795,8 @@ components: - $ref: '#/components/x-stackQL-resources/attestors/methods/list' insert: - $ref: '#/components/x-stackQL-resources/attestors/methods/create' - update: + update: [] + replace: - $ref: '#/components/x-stackQL-resources/attestors/methods/update' delete: - $ref: '#/components/x-stackQL-resources/attestors/methods/delete' @@ -1807,17 +1812,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1attestors~1{attestorsId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: >- @@ -1831,6 +1833,9 @@ components: #/components/x-stackQL-resources/attestors_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/attestors_iam_policies/methods/set_iam_policy delete: [] policy_iam_policies: id: google.binaryauthorization.policy_iam_policies @@ -1843,16 +1848,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1policy:getIamPolicy/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -1866,6 +1868,9 @@ components: #/components/x-stackQL-resources/policy_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/policy_iam_policies/methods/set_iam_policy delete: [] systempolicy_policy: id: google.binaryauthorization.systempolicy_policy @@ -1884,10 +1889,11 @@ components: #/components/x-stackQL-resources/systempolicy_policy/methods/get_policy insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/policy: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1957,7 +1963,7 @@ paths: schema: type: string /v1/projects/{projectsId}/platforms/gke/policies/{policiesId}:evaluate: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Evaluates a Kubernetes object versus a GKE platform policy. Returns @@ -1994,7 +2000,7 @@ paths: schema: type: string /v1/projects/{projectsId}/platforms/{platformsId}/policies: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates a platform policy, and returns a copy of it. Returns `NOT_FOUND` @@ -2073,7 +2079,7 @@ paths: schema: type: string /v1/projects/{projectsId}/platforms/{platformsId}/policies/{policiesId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets a platform policy. Returns `NOT_FOUND` if the policy doesn't exist. operationId: binaryauthorization.projects.platforms.policies.get @@ -2176,8 +2182,12 @@ paths: required: true schema: type: string + - in: query + name: etag + schema: + type: string /v1/projects/{projectsId}/attestors: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates an attestor, and returns a copy of the new attestor. Returns @@ -2244,7 +2254,7 @@ paths: schema: type: string /v1/projects/{projectsId}/attestors/{attestorsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets an attestor. Returns `NOT_FOUND` if the attestor does not exist. operationId: binaryauthorization.projects.attestors.get @@ -2329,7 +2339,7 @@ paths: schema: type: string /v1/projects/{projectsId}/attestors/{attestorsId}:validateAttestationOccurrence: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns whether the given `Attestation` for the given image URI was @@ -2364,7 +2374,7 @@ paths: schema: type: string /v1/projects/{projectsId}/attestors/{attestorsId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2400,7 +2410,7 @@ paths: schema: type: string /v1/projects/{projectsId}/attestors/{attestorsId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2435,7 +2445,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/attestors/{attestorsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2473,7 +2483,7 @@ paths: schema: type: string /v1/projects/{projectsId}/policy:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2504,7 +2514,7 @@ paths: schema: type: string /v1/projects/{projectsId}/policy:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2534,7 +2544,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/policy:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2567,7 +2577,7 @@ paths: schema: type: string /v1/locations/{locationsId}/policy: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the current system policy in the specified location. operationId: binaryauthorization.systempolicy.getPolicy diff --git a/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml index e7c22729..6b19130c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/blockchainnodeengine.yaml @@ -7,8 +7,8 @@ info: title: Blockchain Node Engine API description: '' version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/blockchain-node-engine servers: @@ -651,16 +651,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -673,23 +670,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.blockchainnodeengine.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -717,6 +712,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' blockchain_nodes: @@ -724,17 +720,14 @@ components: name: blockchain_nodes title: Blockchain_nodes methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1blockchainNodes/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.blockchainNodes - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -771,11 +764,12 @@ components: - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/create' update: - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/blockchain_nodes/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -822,7 +816,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets information about a location. operationId: blockchainnodeengine.projects.locations.get @@ -850,7 +844,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -893,7 +887,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -964,7 +958,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1011,7 +1005,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes: - parameters: *ref_7 + parameters: *ref_1 get: description: Lists blockchain nodes in a given project and location. operationId: blockchainnodeengine.projects.locations.blockchainNodes.list @@ -1095,7 +1089,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets details of a single blockchain node. operationId: blockchainnodeengine.projects.locations.blockchainNodes.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml index 9706b9d7..7e24294a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/certificatemanager.yaml @@ -7,8 +7,8 @@ info: title: Certificate Manager API description: '' version: v1 - x-discovery-doc-revision: '20240508' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240821' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/certificate-manager servers: @@ -174,12 +174,14 @@ components: properties: name: description: >- - A user-defined name of the certificate. Certificate names must be - unique globally and match pattern + Identifier. A user-defined name of the certificate. Certificate + names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. type: string description: - description: One or more paragraphs of text description of a certificate. + description: >- + Optional. One or more paragraphs of text description of a + certificate. type: string createTime: description: Output only. The creation timestamp of a Certificate. @@ -192,7 +194,7 @@ components: type: string format: google-datetime labels: - description: Set of labels associated with a Certificate. + description: Optional. Set of labels associated with a Certificate. type: object additionalProperties: type: string @@ -222,7 +224,7 @@ components: type: string format: google-datetime scope: - description: Immutable. The scope of the certificate. + description: Optional. Immutable. The scope of the certificate. type: string enumDescriptions: - >- @@ -250,11 +252,13 @@ components: properties: pemCertificate: description: >- - Input only. The PEM-encoded certificate chain. Leaf certificate - comes first, followed by intermediate ones if any. + Optional. Input only. The PEM-encoded certificate chain. Leaf + certificate comes first, followed by intermediate ones if any. type: string pemPrivateKey: - description: Input only. The PEM-encoded private key of the leaf certificate. + description: >- + Optional. Input only. The PEM-encoded private key of the leaf + certificate. type: string ManagedCertificate: id: ManagedCertificate @@ -266,26 +270,26 @@ components: properties: domains: description: >- - Immutable. The domains for which a managed SSL certificate will be - generated. Wildcard domains are only supported with DNS challenge - resolution. + Optional. Immutable. The domains for which a managed SSL certificate + will be generated. Wildcard domains are only supported with DNS + challenge resolution. type: array items: type: string dnsAuthorizations: description: >- - Immutable. Authorizations that will be used for performing domain - authorization. + Optional. Immutable. Authorizations that will be used for performing + domain authorization. type: array items: type: string issuanceConfig: description: >- - Immutable. The resource name for a CertificateIssuanceConfig used to - configure private PKI certificates in the format - `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field - is not set, the certificates will instead be publicly signed as - documented at + Optional. Immutable. The resource name for a + CertificateIssuanceConfig used to configure private PKI certificates + in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. + If this field is not set, the certificates will instead be publicly + signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. type: string state: @@ -362,7 +366,8 @@ components: type: object properties: domain: - description: Domain name of the authorization attempt. + description: Output only. Domain name of the authorization attempt. + readOnly: true type: string state: description: Output only. State of the domain for managed certificate issuance. @@ -443,12 +448,14 @@ components: properties: name: description: >- - A user-defined name of the Certificate Map. Certificate Map names - must be unique globally and match pattern + Identifier. A user-defined name of the Certificate Map. Certificate + Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. type: string description: - description: One or more paragraphs of text description of a certificate map. + description: >- + Optional. One or more paragraphs of text description of a + certificate map. type: string createTime: description: Output only. The creation timestamp of a Certificate Map. @@ -461,7 +468,7 @@ components: type: string format: google-datetime labels: - description: Set of labels associated with a Certificate Map. + description: Optional. Set of labels associated with a Certificate Map. type: object additionalProperties: type: string @@ -546,14 +553,15 @@ components: properties: name: description: >- - A user-defined name of the Certificate Map Entry. Certificate Map - Entry names must be unique globally and match pattern + Identifier. A user-defined name of the Certificate Map Entry. + Certificate Map Entry names must be unique globally and match + pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. type: string description: description: >- - One or more paragraphs of text description of a certificate map - entry. + Optional. One or more paragraphs of text description of a + certificate map entry. type: string createTime: description: Output only. The creation timestamp of a Certificate Map Entry. @@ -566,7 +574,7 @@ components: type: string format: google-datetime labels: - description: Set of labels associated with a Certificate Map Entry. + description: Optional. Set of labels associated with a Certificate Map Entry. type: object additionalProperties: type: string @@ -590,9 +598,9 @@ components: - PRIMARY certificates: description: >- - A set of Certificates defines for the given `hostname`. There can be - defined up to four certificates in each Certificate Map Entry. Each - certificate must match pattern + Optional. A set of Certificates defines for the given `hostname`. + There can be defined up to four certificates in each Certificate Map + Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`. type: array items: @@ -642,8 +650,8 @@ components: properties: name: description: >- - A user-defined name of the dns authorization. DnsAuthorization names - must be unique globally and match pattern + Identifier. A user-defined name of the dns authorization. + DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. type: string createTime: @@ -657,12 +665,14 @@ components: type: string format: google-datetime labels: - description: Set of labels associated with a DnsAuthorization. + description: Optional. Set of labels associated with a DnsAuthorization. type: object additionalProperties: type: string description: - description: One or more paragraphs of text description of a DnsAuthorization. + description: >- + Optional. One or more paragraphs of text description of a + DnsAuthorization. type: string domain: description: >- @@ -679,9 +689,9 @@ components: $ref: '#/components/schemas/DnsResourceRecord' type: description: >- - Immutable. Type of DnsAuthorization. If unset during resource - creation the following default will be used: - in location global: - FIXED_RECORD. + Optional. Immutable. Type of DnsAuthorization. If unset during + resource creation the following default will be used: - in location + `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. type: string enumDescriptions: - Type is unspecified. @@ -748,7 +758,7 @@ components: properties: name: description: >- - A user-defined name of the certificate issuance config. + Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. type: string @@ -765,13 +775,13 @@ components: type: string format: google-datetime labels: - description: Set of labels associated with a CertificateIssuanceConfig. + description: Optional. Set of labels associated with a CertificateIssuanceConfig. type: object additionalProperties: type: string description: description: >- - One or more paragraphs of text description of a + Optional. One or more paragraphs of text description of a CertificateIssuanceConfig. type: string certificateAuthorityConfig: @@ -851,8 +861,8 @@ components: properties: name: description: >- - A user-defined name of the trust config. TrustConfig names must be - unique globally and match pattern + Identifier. A user-defined name of the trust config. TrustConfig + names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`. type: string createTime: @@ -866,12 +876,14 @@ components: type: string format: google-datetime labels: - description: Set of labels associated with a TrustConfig. + description: Optional. Set of labels associated with a TrustConfig. type: object additionalProperties: type: string description: - description: One or more paragraphs of text description of a TrustConfig. + description: >- + Optional. One or more paragraphs of text description of a + TrustConfig. type: string etag: description: >- @@ -881,10 +893,10 @@ components: type: string trustStores: description: >- - Set of trust stores to perform validation against. This field is - supported when TrustConfig is configured with Load Balancers, - currently not supported for SPIFFE certificate validation. Only one - TrustStore specified is currently allowed. + Optional. Set of trust stores to perform validation against. This + field is supported when TrustConfig is configured with Load + Balancers, currently not supported for SPIFFE certificate + validation. Only one TrustStore specified is currently allowed. type: array items: $ref: '#/components/schemas/TrustStore' @@ -904,16 +916,17 @@ components: properties: trustAnchors: description: >- - List of Trust Anchors to be used while performing validation against - a given TrustStore. + Optional. List of Trust Anchors to be used while performing + validation against a given TrustStore. type: array items: $ref: '#/components/schemas/TrustAnchor' intermediateCas: description: >- - Set of intermediate CA certificates used for the path building phase - of chain validation. The field is currently not supported if - TrustConfig is used for the workload certificate feature. + Optional. Set of intermediate CA certificates used for the path + building phase of chain validation. The field is currently not + supported if TrustConfig is used for the workload certificate + feature. type: array items: $ref: '#/components/schemas/IntermediateCA' @@ -1115,16 +1128,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1137,23 +1147,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.certificatemanager.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1181,6 +1189,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' certificates: @@ -1188,17 +1197,14 @@ components: name: certificates title: Certificates methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1235,6 +1241,7 @@ components: - $ref: '#/components/x-stackQL-resources/certificates/methods/create' update: - $ref: '#/components/x-stackQL-resources/certificates/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/certificates/methods/delete' certificate_maps: @@ -1242,17 +1249,14 @@ components: name: certificate_maps title: Certificate_maps methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificateMaps/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificateMaps - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -1289,6 +1293,7 @@ components: - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/create' update: - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/certificate_maps/methods/delete' certificate_map_entries: @@ -1296,17 +1301,14 @@ components: name: certificate_map_entries title: Certificate_map_entries methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificateMaps~1{certificateMapsId}~1certificateMapEntries/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificateMapEntries - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -1347,6 +1349,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/certificate_map_entries/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/certificate_map_entries/methods/delete @@ -1355,17 +1358,14 @@ components: name: dns_authorizations title: Dns_authorizations methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dnsAuthorizations/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dnsAuthorizations - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -1402,6 +1402,7 @@ components: - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/create' update: - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/dns_authorizations/methods/delete' certificate_issuance_configs: @@ -1409,17 +1410,14 @@ components: name: certificate_issuance_configs title: Certificate_issuance_configs methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificateIssuanceConfigs/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificateIssuanceConfigs - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: >- @@ -1434,6 +1432,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificateIssuanceConfigs~1{certificateIssuanceConfigsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' delete: operation: $ref: >- @@ -1450,7 +1455,10 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/certificate_issuance_configs/methods/create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/certificate_issuance_configs/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/certificate_issuance_configs/methods/delete @@ -1459,17 +1467,14 @@ components: name: trust_configs title: Trust_configs methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1trustConfigs/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.trustConfigs - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -1506,11 +1511,12 @@ components: - $ref: '#/components/x-stackQL-resources/trust_configs/methods/create' update: - $ref: '#/components/x-stackQL-resources/trust_configs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/trust_configs/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_17 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1557,7 +1563,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about a location. operationId: certificatemanager.projects.locations.get @@ -1585,7 +1591,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1628,7 +1634,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1699,7 +1705,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1746,7 +1752,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificates: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists Certificates in a given project and location. operationId: certificatemanager.projects.locations.certificates.list @@ -1826,7 +1832,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single Certificate. operationId: certificatemanager.projects.locations.certificates.get @@ -1931,7 +1937,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateMaps: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists CertificateMaps in a given project and location. operationId: certificatemanager.projects.locations.certificateMaps.list @@ -2011,7 +2017,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single CertificateMap. operationId: certificatemanager.projects.locations.certificateMaps.get @@ -2119,7 +2125,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists CertificateMapEntries in a given project and location. operationId: >- @@ -2211,7 +2217,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateMaps/{certificateMapsId}/certificateMapEntries/{certificateMapEntriesId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single CertificateMapEntry. operationId: >- @@ -2334,7 +2340,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists DnsAuthorizations in a given project and location. operationId: certificatemanager.projects.locations.dnsAuthorizations.list @@ -2414,7 +2420,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dnsAuthorizations/{dnsAuthorizationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single DnsAuthorization. operationId: certificatemanager.projects.locations.dnsAuthorizations.get @@ -2519,7 +2525,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists CertificateIssuanceConfigs in a given project and location. operationId: certificatemanager.projects.locations.certificateIssuanceConfigs.list @@ -2599,7 +2605,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs/{certificateIssuanceConfigsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single CertificateIssuanceConfig. operationId: certificatemanager.projects.locations.certificateIssuanceConfigs.get @@ -2631,6 +2637,47 @@ paths: required: true schema: type: string + patch: + description: Updates a CertificateIssuanceConfig. + operationId: certificatemanager.projects.locations.certificateIssuanceConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateIssuanceConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: certificateIssuanceConfigsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: description: Deletes a single CertificateIssuanceConfig. operationId: certificatemanager.projects.locations.certificateIssuanceConfigs.delete @@ -2663,7 +2710,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/trustConfigs: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists TrustConfigs in a given project and location. operationId: certificatemanager.projects.locations.trustConfigs.list @@ -2743,7 +2790,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/trustConfigs/{trustConfigsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details of a single TrustConfig. operationId: certificatemanager.projects.locations.trustConfigs.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml index 44005775..a16864a3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudasset.yaml @@ -9,8 +9,8 @@ info: The Cloud Asset API manages the history and inventory of Google Cloud resources. version: v1 - x-discovery-doc-revision: '20240530' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/asset-inventory/docs/quickstart servers: @@ -1049,8 +1049,8 @@ components: properties: name: description: >- - Output only. Resource name of the `AccessPolicy`. Format: - `accessPolicies/{access_policy}` + Output only. Identifier. Resource name of the `AccessPolicy`. + Format: `accessPolicies/{access_policy}` type: string parent: description: >- @@ -1082,9 +1082,10 @@ components: description: >- Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, - meaning that two Access Polices will be identical if and only if + meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. + readOnly: true type: string GoogleIdentityAccesscontextmanagerV1AccessLevel: id: GoogleIdentityAccesscontextmanagerV1AccessLevel @@ -1096,7 +1097,7 @@ components: properties: name: description: >- - Resource name for the `AccessLevel`. Format: + Identifier. Resource name for the `AccessLevel`. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The `access_level` component must begin with a letter, followed by alphanumeric characters or `_`. Its maximum length is 50 characters. @@ -1391,7 +1392,7 @@ components: properties: name: description: >- - Resource name for the `ServicePerimeter`. Format: + Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a @@ -1581,9 +1582,10 @@ components: description: >- A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service - account, Google group, or third-party identity. The `v1` identities - that have the prefix `user`, `group`, `serviceAccount`, `principal`, - and `principalSet` in + account, Google group, or third-party identity. For third-party + identity, only single identities are supported and other identity + types are not supported. The `v1` identities that have the prefix + `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. type: array @@ -1744,9 +1746,11 @@ components: description: >- A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, - or third-party identity. The `v1` identities that have the prefix - `user`, `group`, `serviceAccount`, `principal`, and `principalSet` - in https://cloud.google.com/iam/docs/principal-identifiers#v1 are + or third-party identity. For third-party identity, only single + identities are supported and other identity types are not supported. + The `v1` identities that have the prefix `user`, `group`, + `serviceAccount`, and `principal` in + https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. type: array items: @@ -1955,7 +1959,7 @@ components: description: The specific type of inventory, correlating to its specific details. type: string enumDescriptions: - - Invalid. An type must be specified. + - Invalid. A type must be specified. - This represents a package that is installed on the VM. - This represents an update that is available for a package. enum: @@ -2537,9 +2541,7 @@ components: type: string ResourceSearchResult: id: ResourceSearchResult - description: >- - A result of Resource Search, containing information of a cloud resource. - Next ID: 34 + description: A result of Resource Search, containing information of a cloud resource. type: object properties: name: @@ -2612,8 +2614,8 @@ components: type: string labels: description: >- - Labels associated with this resource. See [Labelling and grouping - Google Cloud + User labels associated with this resource. See [Labelling and + grouping Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `labels`: * @@ -2836,6 +2838,21 @@ components: type: array items: $ref: '#/components/schemas/EffectiveTagDetails' + enrichments: + description: >- + Enrichments of the asset. Currently supported enrichment types with + SearchAllResources API: * RESOURCE_OWNERS The corresponding read + masks in order to get the enrichment: * enrichments.resource_owners + The corresponding required permissions: * + cloudasset.assets.searchEnrichmentResourceOwners Example query to + get resource owner enrichment: ``` scope: "projects/my-project" + query: "name: my-project" assetTypes: + "cloudresourcemanager.googleapis.com/Project" readMask: { paths: + "asset_type" paths: "name" paths: "enrichments.resource_owners" } + ``` + type: array + items: + $ref: '#/components/schemas/AssetEnrichment' parentAssetType: description: >- The type of this resource's immediate parent, if there is one. To @@ -2978,6 +2995,27 @@ components: type: array items: $ref: '#/components/schemas/Tag' + AssetEnrichment: + id: AssetEnrichment + description: The enhanced metadata information for a resource. + type: object + properties: + resourceOwners: + description: >- + The resource owners for a resource. Note that this field only + contains the members that have "roles/owner" role in the resource's + IAM Policy. + $ref: '#/components/schemas/ResourceOwners' + ResourceOwners: + id: ResourceOwners + description: The resource owners information. + type: object + properties: + resourceOwners: + description: List of resource owners. + type: array + items: + type: string SearchAllIamPoliciesResponse: id: SearchAllIamPoliciesResponse description: Search all IAM policies response. @@ -3929,9 +3967,10 @@ components: description: >- The query response, which can be either an `error` or a valid `response`. If `done` == `false` and the query result is being saved - in a output, the output_config field will be set. If `done` == + in an output, the output_config field will be set. If `done` == `true`, exactly one of `error`, `query_result` or `output_config` - will be set. + will be set. [done] is unset unless the [QueryAssetsResponse] + contains a [QueryAssetsResponse.job_reference]. type: boolean error: description: Error status. @@ -3941,8 +3980,8 @@ components: $ref: '#/components/schemas/QueryResult' outputConfig: description: >- - Output configuration which indicates instead of being returned in - API response on the fly, the query result will be saved in a + Output configuration, which indicates that instead of being returned + in an API response on the fly, the query result will be saved in a specific output. $ref: '#/components/schemas/QueryAssetsOutputConfig' QueryResult: @@ -4425,11 +4464,15 @@ components: - Constraint applied when creating the resource. - Constraint applied when updating the resource. - Constraint applied when deleting the resource. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. enum: - METHOD_TYPE_UNSPECIFIED - CREATE - UPDATE - DELETE + - REMOVE_GRANT + - GOVERN_TAGS condition: description: >- Organization Policy condition/expression. For example: @@ -5042,16 +5085,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1{parentType}~1{parent}~1savedQueries/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.savedQueries - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/saved_queries/methods/list' @@ -5060,6 +5100,7 @@ components: - $ref: '#/components/x-stackQL-resources/saved_queries/methods/create' update: - $ref: '#/components/x-stackQL-resources/saved_queries/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/saved_queries/methods/delete' cloudasset: @@ -5089,6 +5130,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] cloudasset_assets_history: id: google.cloudasset.cloudasset_assets_history @@ -5102,9 +5144,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/cloudasset_assets_history/methods/batch_get_assets_history insert: [] update: [] + replace: [] delete: [] cloudasset_iam_policies: id: google.cloudasset.cloudasset_iam_policies @@ -5121,27 +5166,26 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] assets: id: google.cloudasset.assets name: assets title: Assets methods: - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1{parentType}~1{parent}~1assets/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.assets - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/assets/methods/list' insert: [] update: [] + replace: [] delete: [] feeds: id: google.cloudasset.feeds @@ -5166,6 +5210,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/feeds/methods/create' update: [] + replace: [] delete: [] effective_iam_policies: id: google.cloudasset.effective_iam_policies @@ -5179,13 +5224,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/effective_iam_policies/methods/batch_get insert: [] update: [] + replace: [] delete: [] paths: /v1/{name}: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -5271,7 +5319,7 @@ paths: schema: type: string /v1/{parentType}/{parent}: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Issue a job that queries assets using a SQL statement compatible with @@ -5368,7 +5416,7 @@ paths: schema: type: string /v1/{scope}: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Analyzes organization policies governed assets (Google Cloud resources @@ -5489,7 +5537,7 @@ paths: schema: type: string /v1/{resource}: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Analyze moving a resource to a specified destination without kicking off @@ -5525,7 +5573,7 @@ paths: schema: type: string /v1/{parentType}/{parent}/assets: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Lists assets with time and resource types and returns paged results in @@ -5581,7 +5629,7 @@ paths: schema: type: string /v1/{parentType}/{parent}/feeds: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Creates a feed in a parent project/folder/organization to listen to its @@ -5642,7 +5690,7 @@ paths: schema: type: string /v1/{parentType}/{parent}/savedQueries: - parameters: *ref_5 + parameters: *ref_1 post: description: Creates a saved query in a parent project/folder/organization. operationId: cloudasset.savedQueries.create @@ -5718,7 +5766,7 @@ paths: schema: type: string /v1/{scope}/effectiveIamPolicies: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets effective IAM policies for a batch of resources. operationId: cloudasset.effectiveIamPolicies.batchGet diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml index d0ca82a1..35fc3c80 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbilling.yaml @@ -9,8 +9,8 @@ info: Allows developers to manage billing for their Google Cloud Platform projects programmatically. version: v1 - x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/billing/docs/apis servers: @@ -918,17 +918,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1billingAccounts/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.billingAccounts - list: - operation: *ref_1 - response: *ref_2 create: operation: $ref: >- @@ -947,29 +944,25 @@ components: select: - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/get' - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/list' - - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/list' insert: - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/create' - - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/create' update: - $ref: '#/components/x-stackQL-resources/billing_accounts/methods/patch' + replace: [] delete: [] billing_accounts_iam_policies: id: google.cloudbilling.billing_accounts_iam_policies name: billing_accounts_iam_policies title: Billing_accounts_iam_policies methods: - _get_iam_policy: - operation: &ref_3 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1billingAccounts~1{billingAccountsId}:getIamPolicy/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_3 - response: *ref_4 set_iam_policy: operation: $ref: >- @@ -990,23 +983,23 @@ components: #/components/x-stackQL-resources/billing_accounts_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/billing_accounts_iam_policies/methods/set_iam_policy delete: [] sub_accounts: id: google.cloudbilling.sub_accounts name: sub_accounts title: Sub_accounts methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1subAccounts/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.billingAccounts - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1020,27 +1013,26 @@ components: insert: - $ref: '#/components/x-stackQL-resources/sub_accounts/methods/create' update: [] + replace: [] delete: [] projects: id: google.cloudbilling.projects name: projects title: Projects methods: - _list: - operation: &ref_7 + list: + operation: $ref: '#/paths/~1v1~1billingAccounts~1{billingAccountsId}~1projects/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.projectBillingInfo - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/projects/methods/list' insert: [] update: [] + replace: [] delete: [] billing_info: id: google.cloudbilling.billing_info @@ -1065,52 +1057,51 @@ components: #/components/x-stackQL-resources/billing_info/methods/get_billing_info insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/billing_info/methods/update_billing_info delete: [] services: id: google.cloudbilling.services name: services title: Services methods: - _list: - operation: &ref_9 + list: + operation: $ref: '#/paths/~1v1~1services/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/services/methods/list' insert: [] update: [] + replace: [] delete: [] skus: id: google.cloudbilling.skus name: skus title: Skus methods: - _list: - operation: &ref_11 + list: + operation: $ref: '#/paths/~1v1~1services~1{servicesId}~1skus/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.skus - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/skus/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/billingAccounts/{billingAccountsId}: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1196,7 +1187,7 @@ paths: type: string format: google-fieldmask /v1/billingAccounts: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists the billing accounts that the current authenticated user has @@ -1283,7 +1274,7 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}:getIamPolicy: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the access control policy for a billing account. The caller must @@ -1323,7 +1314,7 @@ paths: type: integer format: int32 /v1/billingAccounts/{billingAccountsId}:setIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Sets the access control policy for a billing account. Replaces any @@ -1360,7 +1351,7 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}:testIamPermissions: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Tests the access control policy for a billing account. This method takes @@ -1399,7 +1390,7 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}:move: - parameters: *ref_13 + parameters: *ref_1 post: description: Changes which parent organization a billing account belongs to. operationId: cloudbilling.billingAccounts.move @@ -1431,7 +1422,7 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}/subAccounts: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists the billing accounts that the current authenticated user has @@ -1520,7 +1511,7 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}/projects: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists the projects associated with a billing account. The current @@ -1564,7 +1555,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/billingAccounts: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists the billing accounts that the current authenticated user has @@ -1653,7 +1644,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/billingAccounts/{billingAccountsId}:move: - parameters: *ref_13 + parameters: *ref_1 get: description: Changes which parent organization a billing account belongs to. operationId: cloudbilling.organizations.billingAccounts.move @@ -1685,7 +1676,7 @@ paths: schema: type: string /v1/projects/{projectsId}/billingInfo: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the billing information for a project. The current authenticated @@ -1778,7 +1769,7 @@ paths: schema: type: string /v1/services: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists all public cloud services. operationId: cloudbilling.services.list @@ -1813,7 +1804,7 @@ paths: schema: type: string /v1/services/{servicesId}/skus: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists all publicly available SKUs for a given cloud service. operationId: cloudbilling.services.skus.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml index 0290b5c4..b5bbc011 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudbuild.yaml @@ -7,8 +7,8 @@ info: title: Cloud Build API description: Creates and manages builds on Google Cloud Platform. version: v2 - x-discovery-doc-revision: '20240528' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240903' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/cloud-build/docs/ servers: @@ -34,187 +34,344 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SecretVolumeSource: + TimeoutFields: + type: object properties: - secretName: - description: Name of the secret referenced by the WorkspaceBinding. + finally: + description: Finally sets the maximum allowed duration of this pipeline's finally type: string - secretVersion: + format: google-duration + pipeline: type: string - readOnly: true description: >- - Output only. Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - description: Secret Volume Source. - id: SecretVolumeSource - type: object - EmbeddedTask: - id: EmbeddedTask - description: EmbeddedTask defines a Task that is embedded in a Pipeline. - properties: - annotations: - description: User annotations. See https://google.aip.dev/128#annotations - additionalProperties: - type: string - type: object - taskSpec: - description: Spec to instantiate this TaskRun. - $ref: '#/components/schemas/TaskSpec' - type: object - PipelineRunResult: - description: PipelineRunResult used to describe the results of a pipeline - id: PipelineRunResult - properties: - value: - $ref: '#/components/schemas/ResultValue' - description: Output only. Value of the result. - readOnly: true - name: + Pipeline sets the maximum allowed duration for execution of the + entire pipeline. The sum of individual timeouts for tasks and + finally must not exceed this value. + format: google-duration + tasks: type: string - readOnly: true - description: Output only. Name of the TaskRun - type: object - Probe: - type: object + format: google-duration + description: Tasks sets the maximum allowed duration of this pipeline's tasks + id: TimeoutFields description: >- - Probe describes a health check to be performed against a container to - determine whether it is alive or ready to receive traffic. - id: Probe - properties: - periodSeconds: - description: >- - Optional. How often (in seconds) to perform the probe. Default to 10 - seconds. Minimum value is 1. +optional - format: int32 - type: integer - exec: - description: Optional. Exec specifies the action to take. +optional - $ref: '#/components/schemas/ExecAction' - Status: + TimeoutFields allows granular specification of pipeline, task, and + finally timeouts + TaskRef: + type: object + id: TaskRef properties: - message: + resolver: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT type: string - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - details: - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + name: + type: string + description: Optional. Name of the task. + params: type: array + items: + $ref: '#/components/schemas/Param' description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - id: Status - type: object + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - FetchReadWriteTokenRequest: - properties: {} - description: Message for fetching SCM read/write token. - id: FetchReadWriteTokenRequest + TaskRef can be used to refer to a specific instance of a task. + PipelineRef can be used to refer to a specific instance of a Pipeline. + CreateRepositoryRequest: + description: Message for creating a Repository. type: object - FetchLinkableRepositoriesResponse: properties: - repositories: - items: - $ref: '#/components/schemas/Repository' - description: repositories ready to be created. - type: array - nextPageToken: + repositoryId: + description: >- + Required. The ID to use for the repository, which will become the + final component of the repository's resource name. This ID should be + unique in the connection. Allows alphanumeric characters and any of + -._~%!$&'()*+,;=@. type: string - description: A token identifying a page of results the server should return. - type: object - id: FetchLinkableRepositoriesResponse - description: Response message for FetchLinkableRepositories. - CreateRepositoryRequest: - properties: repository: - $ref: '#/components/schemas/Repository' description: Required. The repository to create. + $ref: '#/components/schemas/Repository' parent: + type: string description: >- Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there. + id: CreateRepositoryRequest + OAuthCredential: + properties: + username: type: string - repositoryId: + description: Output only. The username associated to this token. + readOnly: true + oauthTokenSecretVersion: description: >- - Required. The ID to use for the repository, which will become the - final component of the repository's resource name. This ID should be - unique in the connection. Allows alphanumeric characters and any of - -._~%!$&'()*+,;=@. + Optional. A SecretManager resource containing the OAuth token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. type: string + description: >- + Represents an OAuth token of the account that authorized the Connection, + and associated metadata. type: object - id: CreateRepositoryRequest - description: Message for creating a Repository. - Sidecar: - description: Sidecars run alongside the Task's step containers. - id: Sidecar + id: OAuthCredential + BitbucketCloudConfig: + id: BitbucketCloudConfig + properties: + authorizerCredential: + description: >- + Required. An access token with the `webhook`, `repository`, + `repository:admin` and `pullrequest` scope access. It can be either + a workspace, project or repository access token. It's recommended to + use a system account to generate these credentials. + $ref: '#/components/schemas/UserCredential' + webhookSecretSecretVersion: + type: string + description: >- + Required. SecretManager resource containing the webhook secret used + to verify webhook events, formatted as + `projects/*/secrets/*/versions/*`. + readAuthorizerCredential: + $ref: '#/components/schemas/UserCredential' + description: >- + Required. An access token with the `repository` access. It can be + either a workspace, project or repository access token. It's + recommended to use a system account to generate the credentials. + workspace: + type: string + description: >- + Required. The Bitbucket Cloud Workspace ID to be connected to Google + Cloud Platform. + description: Configuration for connections to Bitbucket Cloud. + type: object + ParamSpec: type: object + description: >- + ParamSpec defines parameters needed beyond typed inputs (such as + resources). Parameter values are provided by users as inputs on a + TaskRun or PipelineRun. properties: - image: + type: + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type. + - Object type. type: string - description: Docker image name. - script: - description: The contents of an executable file to execute. + description: Type of ParamSpec + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + default: + $ref: '#/components/schemas/ParamValue' + description: The default value a parameter takes if no input value is supplied + description: + description: Description of the ParamSpec type: string - command: - type: array - description: Entrypoint array. - items: - type: string name: - description: Name of the Sidecar. type: string - env: - type: array - description: List of environment variables to set in the container. + description: Name of the ParamSpec + id: ParamSpec + TestIamPermissionsRequest: + type: object + description: Request message for `TestIamPermissions` method. + properties: + permissions: items: - $ref: '#/components/schemas/EnvVar' - volumeMounts: + type: string type: array - items: - $ref: '#/components/schemas/VolumeMount' - description: Pod volumes to mount into the container's filesystem. - readinessProbe: description: >- - Optional. Periodic probe of Sidecar service readiness. Container - will be removed from service endpoints if the probe fails. Cannot be - updated. More info: - https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - +optional - $ref: '#/components/schemas/Probe' - workingDir: - description: Container's working directory. - type: string - securityContext: - description: Optional. Security options the container should be run with. - $ref: '#/components/schemas/SecurityContext' - args: - description: Arguments to the entrypoint. + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + id: TestIamPermissionsRequest + Capabilities: + properties: + add: type: array items: type: string + description: Optional. Added capabilities +optional + drop: + items: + type: string + type: array + description: Optional. Removed capabilities +optional + id: Capabilities + description: >- + Capabilities adds and removes POSIX capabilities from running + containers. + type: object + OperationMetadata: + properties: + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + createTime: + readOnly: true + description: Output only. The time the operation was created. + format: google-datetime + type: string + cancelRequested: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + type: boolean + readOnly: true + verb: + readOnly: true + type: string + description: Output only. Name of the verb executed by the operation. + statusDetail: + type: string + description: Output only. Human-readable status of the operation, if any. + readOnly: true + apiVersion: + readOnly: true + description: Output only. API version used to start the operation. + type: string + endTime: + readOnly: true + format: google-datetime + type: string + description: Output only. The time the operation finished running. + description: Represents the metadata of the long-running operation. + type: object + id: OperationMetadata + GitHubConfig: + id: GitHubConfig + description: Configuration for connections to github.com. + properties: + authorizerCredential: + $ref: '#/components/schemas/OAuthCredential' + description: >- + Optional. OAuth credential of the account that authorized the Cloud + Build GitHub App. It is recommended to use a robot account instead + of a human user account. The OAuth token must be tied to the Cloud + Build GitHub App. + appInstallationId: + type: string + description: Optional. GitHub App installation id. + format: int64 + type: object + PipelineWorkspaceDeclaration: + id: PipelineWorkspaceDeclaration + description: >- + Workspaces declares a set of named workspaces that are expected to be + provided by a PipelineRun. + type: object + properties: + name: + type: string + description: Name is the name of a workspace to be provided by a PipelineRun. + optional: + description: >- + Optional marks a Workspace as not being required in PipelineRuns. By + default this field is false and so declared workspaces are required. + type: boolean + description: + type: string + description: >- + Description is a human readable string describing how the workspace + will be used in the Pipeline. + Operation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. + properties: + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + type: object + id: Operation Provenance: description: Provenance configuration. - id: Provenance + type: object properties: + storage: + description: Optional. Where provenance is stored. + enumDescriptions: + - Default PREFER_ARTIFACT_PROJECT. + - >- + GCB will attempt to push provenance to the artifact project. If it + is not available, fallback to build project. + - Only push to artifact project. + - Only push to build project. + type: string + enum: + - STORAGE_UNSPECIFIED + - PREFER_ARTIFACT_PROJECT + - ARTIFACT_PROJECT_ONLY + - BUILD_PROJECT_ONLY enabled: - description: Optional. Provenance push mode. enumDescriptions: - Default to disabled (before AA regionalization), optimistic after - Provenance failures would fail the run @@ -222,29 +379,16 @@ components: GCB will attempt to push to artifact analaysis and build state would not be impacted by the push failures. - Disable the provenance push entirely. - type: string enum: - ENABLED_UNSPECIFIED - REQUIRED - OPTIMISTIC - DISABLED - storage: - enum: - - STORAGE_UNSPECIFIED - - PREFER_ARTIFACT_PROJECT - - ARTIFACT_PROJECT_ONLY - - BUILD_PROJECT_ONLY - description: Optional. Where provenance is stored. - enumDescriptions: - - Default PREFER_ARTIFACT_PROJECT. - - >- - GCB will attempt to push provenance to the artifact project. If it - is not available, fallback to build project. - - Only push to artifact project. - - Only push to build project. + description: Optional. Provenance push mode. type: string region: type: string + description: Optional. Provenance region. enumDescriptions: - >- The PipelineRun/TaskRun/Workflow will be rejected. Update this @@ -254,2217 +398,2085 @@ components: enum: - REGION_UNSPECIFIED - GLOBAL - description: Optional. Provenance region. - type: object - ListRepositoriesResponse: - type: object - properties: - nextPageToken: - type: string - description: A token identifying a page of results the server should return. - repositories: - description: The list of Repositories. - type: array - items: - $ref: '#/components/schemas/Repository' - description: Message for response to listing Repositories. - id: ListRepositoriesResponse - FetchReadTokenResponse: - description: Message for responding to get read token. - type: object - id: FetchReadTokenResponse - properties: - token: - description: The token content. - type: string - expirationTime: - type: string - format: google-datetime - description: Expiration timestamp. Can be empty if unknown or non-expiring. - SkippedTask: + id: Provenance + SecurityContext: type: object - description: >- - SkippedTask is used to describe the Tasks that were skipped due to their - When Expressions evaluating to False. - id: SkippedTask properties: - whenExpressions: - type: array - items: - $ref: '#/components/schemas/WhenExpression' + runAsUser: description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask - name: - type: string - description: Name is the Pipeline Task name - reason: - readOnly: true - description: Output only. Reason is the cause of the PipelineTask being skipped. + Optional. The UID to run the entrypoint of the container process. + Defaults to user specified in image metadata if unspecified. May + also be set in PodSecurityContext. If set in both SecurityContext + and PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional + format: int64 type: string - WhenExpression: - description: Conditions that need to be true for the task to run. - id: WhenExpression - properties: - input: + capabilities: description: >- - Input is the string for guard checking which can be a static input - or an output from a parent Task. - type: string - expressionOperator: - enum: - - EXPRESSION_OPERATOR_UNSPECIFIED - - IN - - NOT_IN - enumDescriptions: - - Default enum type; should not be used. - - Input is in values. - - Input is not in values. - type: string - description: Operator that represents an Input's relationship to the values - values: - description: >- - Values is an array of strings, which is compared against the input, - for guard checking. - items: - type: string - type: array - type: object - Policy: - type: object - properties: - auditConfigs: - items: - $ref: '#/components/schemas/AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - type: array - etag: - format: byte - type: string + Optional. Adds and removes POSIX capabilities from running + containers. + $ref: '#/components/schemas/Capabilities' + privileged: + type: boolean + description: Run container in privileged mode. + allowPrivilegeEscalation: description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - bindings: - items: - $ref: '#/components/schemas/Binding' - type: array + Optional. AllowPrivilegeEscalation controls whether a process can + gain more privileges than its parent process. This bool directly + controls if the no_new_privs flag will be set on the container + process. AllowPrivilegeEscalation is true always when the container + is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field + cannot be set when spec.os.name is windows. +optional + type: boolean + runAsGroup: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - version: + Optional. The GID to run the entrypoint of the container process. + Uses runtime default if unset. May also be set in + PodSecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes + precedence. Note that this field cannot be set when spec.os.name is + windows. +optional + format: int64 + type: string + runAsNonRoot: + type: boolean description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - format: int32 - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - PipelineRef: - description: PipelineRef can be used to refer to a specific instance of a Pipeline. + Optional. Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure + that it does not run as UID 0 (root) and fail to start the container + if it does. If unset or false, no such validation will be performed. + May also be set in PodSecurityContext. If set in both + SecurityContext and PodSecurityContext, the value specified in + SecurityContext takes precedence. +optional + id: SecurityContext + description: Security options the container should be run with. + GoogleDevtoolsCloudbuildV2Condition: + id: GoogleDevtoolsCloudbuildV2Condition type: object + description: Conditions defines a readiness condition for a Knative resource. properties: - params: - items: - $ref: '#/components/schemas/Param' - type: array - description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. - resolver: - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. + type: + description: Type of condition. + type: string + reason: type: string + description: The reason for the condition's last transition. + severity: enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT + - SEVERITY_UNSPECIFIED + - WARNING + - INFO + description: Severity with which to treat failures of this type of condition. enumDescriptions: - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - name: - description: Name of the Pipeline. + - Severity is warning. + - Severity is informational only. type: string - deprecated: true - id: PipelineRef - ParamSpec: - properties: - name: + message: + description: A human readable message indicating details about the transition. type: string - description: Name of the ParamSpec - description: + status: + enum: + - UNKNOWN + - 'TRUE' + - 'FALSE' + enumDescriptions: + - Default enum type indicating execution is still ongoing. + - Success + - Failure + description: Status of the condition. type: string - description: Description of the ParamSpec + lastTransitionTime: + format: google-datetime + type: string + description: >- + LastTransitionTime is the last time the condition transitioned from + one status to another. + TaskResult: + properties: + properties: + type: object + description: >- + When type is OBJECT, this map holds the names of fields inside that + object along with the type of data each field holds. + additionalProperties: + $ref: '#/components/schemas/PropertySpec' + value: + $ref: '#/components/schemas/ParamValue' + description: >- + Optional. Optionally used to initialize a Task's result with a + Step's result. type: + type: string + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type enum: - TYPE_UNSPECIFIED - STRING - ARRAY - description: Type of ParamSpec - enumDescriptions: - - Default enum type; should not be used. - - Default - - Arrary type. + - OBJECT + description: The type of data that the result holds. + name: + description: Name of the result. type: string - default: - $ref: '#/components/schemas/ParamValue' - description: The default value a parameter takes if no input value is supplied - id: ParamSpec - description: >- - ParamSpec defines parameters needed beyond typed inputs (such as - resources). Parameter values are provided by users as inputs on a - TaskRun or PipelineRun. - type: object - TaskSpec: - id: TaskSpec - properties: description: + description: Description of the result. type: string - description: Description of the task. - workspaces: - description: The volumes that this Task requires. - type: array - items: - $ref: '#/components/schemas/WorkspaceDeclaration' - results: - description: Values that this Task can output. + id: TaskResult + type: object + description: TaskResult is used to describe the results of a task. + FetchReadTokenResponse: + description: Message for responding to get read token. + id: FetchReadTokenResponse + type: object + properties: + token: + type: string + description: The token content. + expirationTime: + description: Expiration timestamp. Can be empty if unknown or non-expiring. + format: google-datetime + type: string + FetchLinkableRepositoriesResponse: + type: object + properties: + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + repositories: + description: repositories ready to be created. items: - $ref: '#/components/schemas/TaskResult' + $ref: '#/components/schemas/Repository' + type: array + description: Response message for FetchLinkableRepositories. + id: FetchLinkableRepositoriesResponse + ParamValue: + description: Parameter value. + properties: + stringVal: + description: Value of the parameter if type is string. + type: string + type: + type: string + description: Type of parameter. + enumDescriptions: + - Default enum type; should not be used. + - Default + - Array type + - Object type + enum: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT + arrayVal: type: array + items: + type: string + description: Value of the parameter if type is array. + objectVal: + description: Optional. Value of the parameter if type is object. + type: object + additionalProperties: + type: string + id: ParamValue + type: object + TaskSpec: + type: object + description: TaskSpec contains the Spec to instantiate a TaskRun. + properties: managedSidecars: + type: array + description: >- + Sidecars that run alongside the Task’s step containers that should + be added to this Task. items: enumDescriptions: - Default enum type; should not be used. - Sidecar for a privileged docker daemon. + type: string enum: - MANAGED_SIDECAR_UNSPECIFIED - PRIVILEGED_DOCKER_DAEMON - type: string + results: type: array - description: >- - Sidecars that run alongside the Task’s step containers that should - be added to this Task. - steps: - description: Steps of the task. + description: Values that this Task can output. + items: + $ref: '#/components/schemas/TaskResult' + description: + type: string + description: Description of the task. + workspaces: type: array + description: The volumes that this Task requires. items: - $ref: '#/components/schemas/Step' - params: + $ref: '#/components/schemas/WorkspaceDeclaration' + sidecars: type: array - description: List of parameters. + description: Sidecars that run alongside the Task's step containers. items: - $ref: '#/components/schemas/ParamSpec' + $ref: '#/components/schemas/Sidecar' stepTemplate: + $ref: '#/components/schemas/StepTemplate' description: >- Optional. StepTemplate can be used as the basis for all step containers within the Task, so that the steps inherit settings on the base container. - $ref: '#/components/schemas/StepTemplate' + steps: + type: array + items: + $ref: '#/components/schemas/Step' + description: Steps of the task. volumes: + items: + $ref: '#/components/schemas/VolumeSource' + type: array description: A collection of volumes that are available to mount into steps. + params: + items: + $ref: '#/components/schemas/ParamSpec' + type: array + description: List of parameters. + id: TaskSpec + TestIamPermissionsResponse: + properties: + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. type: array items: - $ref: '#/components/schemas/VolumeSource' - sidecars: + type: string + description: Response message for `TestIamPermissions` method. + type: object + id: TestIamPermissionsResponse + ListRepositoriesResponse: + description: Message for response to listing Repositories. + properties: + repositories: + description: The list of Repositories. items: - $ref: '#/components/schemas/Sidecar' + $ref: '#/components/schemas/Repository' type: array - description: Sidecars that run alongside the Task's step containers. + nextPageToken: + type: string + description: A token identifying a page of results the server should return. + id: ListRepositoriesResponse type: object - description: TaskSpec contains the Spec to instantiate a TaskRun. - TaskResult: - description: TaskResult is used to describe the results of a task. - id: TaskResult + GoogleDevtoolsCloudbuildV2OperationMetadata: + id: GoogleDevtoolsCloudbuildV2OperationMetadata + properties: + endTime: + format: google-datetime + description: Output only. The time the operation finished running. + readOnly: true + type: string + apiVersion: + type: string + description: Output only. API version used to start the operation. + readOnly: true + statusMessage: + type: string + readOnly: true + description: Output only. Human-readable status of the operation, if any. + target: + readOnly: true + type: string + description: >- + Output only. Server-defined resource path for the target of the + operation. + verb: + type: string + readOnly: true + description: Output only. Name of the verb executed by the operation. + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + requestedCancellation: + readOnly: true + type: boolean + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + type: object + description: Represents the metadata of the long-running operation. + StepRef: + description: A reference to a remote Step, i.e. a StepAction. + type: object + properties: + name: + description: Optional. Name of the step. + type: string + params: + type: array + items: + $ref: '#/components/schemas/Param' + description: Optional. Parameters used to control the resolution. + resolver: + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT + type: string + description: Optional. Type of the resolver. + id: StepRef + ExecAction: + properties: + command: + type: array + items: + type: string + description: >- + Optional. Command is the command line to execute inside the + container, the working directory for the command is root ('/') in + the container's filesystem. The command is simply exec'd, it is not + run inside a shell, so traditional shell instructions ('|', etc) + won't work. To use a shell, you need to explicitly call out to that + shell. Exit status of 0 is treated as live/healthy and non-zero is + unhealthy. +optional + type: object + description: ExecAction describes a "run in container" action. + id: ExecAction + CancelOperationRequest: type: object + properties: {} + description: The request message for Operations.CancelOperation. + id: CancelOperationRequest + PipelineResult: + description: A value produced by a Pipeline. properties: + name: + readOnly: true + description: Output only. Name of the result. + type: string + description: + readOnly: true + description: Output only. Description of the result. + type: string + value: + description: Output only. Value of the result. + $ref: '#/components/schemas/ResultValue' + readOnly: true type: - description: The type of data that the result holds. type: string enum: - TYPE_UNSPECIFIED - STRING - ARRAY - OBJECT + description: Output only. The type of data that the result holds. enumDescriptions: - Default enum type; should not be used. - Default - Array type - Object type - value: - $ref: '#/components/schemas/ParamValue' + readOnly: true + type: object + id: PipelineResult + AuditLogConfig: + type: object + properties: + exemptedMembers: + items: + type: string description: >- - Optional. Optionally used to initialize a Task's result with a - Step's result. - properties: - description: >- - When type is OBJECT, this map holds the names of fields inside that - object along with the type of data each field holds. - additionalProperties: - $ref: '#/components/schemas/PropertySpec' - type: object - name: - type: string - description: Name of the result. - description: - description: Description of the result. + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + logType: + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + description: The log type that this config enables. type: string + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + id: AuditLogConfig ListLocationsResponse: - id: ListLocationsResponse properties: - nextPageToken: - description: The standard List next-page token. - type: string locations: description: >- A list of locations that matches the specified filter in the request. - type: array items: $ref: '#/components/schemas/Location' - description: The response message for Locations.ListLocations. + type: array + nextPageToken: + type: string + description: The standard List next-page token. type: object - VolumeMount: - description: Pod volumes to mount into the container's filesystem. - id: VolumeMount + description: The response message for Locations.ListLocations. + id: ListLocationsResponse + BitbucketDataCenterConfig: + id: BitbucketDataCenterConfig properties: - readOnly: - type: boolean - description: >- - Mounted read-only if true, read-write otherwise (false or - unspecified). - subPath: - type: string + serviceDirectoryConfig: description: >- - Path within the volume from which the container's volume should be - mounted. Defaults to "" (volume's root). - subPathExpr: - type: string + Optional. Configuration for using Service Directory to privately + connect to a Bitbucket Data Center. This should only be set if the + Bitbucket Data Center is hosted on-premises and not reachable by + public internet. If this field is left empty, calls to the Bitbucket + Data Center will be made over the public internet. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + authorizerCredential: + $ref: '#/components/schemas/UserCredential' + description: Required. A http access token with the `REPO_ADMIN` scope access. + readAuthorizerCredential: + $ref: '#/components/schemas/UserCredential' + description: Required. A http access token with the `REPO_READ` access. + hostUri: description: >- - Expanded path within the volume from which the container's volume - should be mounted. Behaves similarly to SubPath but environment - variable references $(VAR_NAME) are expanded using the container's - environment. Defaults to "" (volume's root). - mountPath: + Required. The URI of the Bitbucket Data Center instance or cluster + this connection is for. type: string - description: >- - Path within the container at which the volume should be mounted. - Must not contain ':'. - name: + sslCa: type: string - description: Name of the volume. - type: object - BitbucketCloudConfig: - description: Configuration for connections to Bitbucket Cloud. - type: object - properties: - authorizerCredential: - $ref: '#/components/schemas/UserCredential' description: >- - Required. An access token with the `webhook`, `repository`, - `repository:admin` and `pullrequest` scope access. It can be either - a workspace, project or repository access token. It's recommended to - use a system account to generate these credentials. + Optional. SSL certificate to use for requests to the Bitbucket Data + Center. webhookSecretSecretVersion: type: string description: >- - Required. SecretManager resource containing the webhook secret used - to verify webhook events, formatted as + Required. Immutable. SecretManager resource containing the webhook + secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' + serverVersion: description: >- - Required. An access token with the `repository` access. It can be - either a workspace, project or repository access token. It's - recommended to use a system account to generate the credentials. - workspace: + Output only. Version of the Bitbucket Data Center running on the + `host_uri`. + readOnly: true type: string - description: >- - Required. The Bitbucket Cloud Workspace ID to be connected to Google - Cloud Platform. - id: BitbucketCloudConfig - BatchCreateRepositoriesResponse: type: object + description: Configuration for connections to Bitbucket Data Center. + BatchCreateRepositoriesResponse: + id: BatchCreateRepositoriesResponse description: Message for response of creating repositories in batch. properties: repositories: - description: Repository resources created. items: $ref: '#/components/schemas/Repository' + description: Repository resources created. type: array - id: BatchCreateRepositoriesResponse - FetchReadWriteTokenResponse: - id: FetchReadWriteTokenResponse type: object + WorkspaceBinding: + description: >- + WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used + to refer to a specific instance of a Pipeline. properties: - token: - description: The token content. + subPath: type: string - expirationTime: - format: google-datetime - description: Expiration timestamp. Can be empty if unknown or non-expiring. + description: >- + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional + secret: + description: Secret Volume Source. + $ref: '#/components/schemas/SecretVolumeSource' + name: type: string - description: Message for responding to get read/write token. - Empty: + description: Name of the workspace. type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: Empty - properties: {} - Security: - id: Security + id: WorkspaceBinding + ResultValue: + id: ResultValue type: object properties: - serviceAccount: + arrayVal: + items: + type: string + type: array + description: Value of the result if type is array. + type: type: string - description: IAM service account whose credentials will be used at runtime. - privilegeMode: enumDescriptions: - - Default to PRIVILEGED. - - Privileged mode. - - Unprivileged mode. + - Default enum type; should not be used. + - Default + - Array type + - Object type + description: Output only. The type of data that the result holds. enum: - - PRIVILEGE_MODE_UNSPECIFIED - - PRIVILEGED - - UNPRIVILEGED - description: Optional. Privilege mode. - type: string - description: Security configuration. - OAuthCredential: - description: >- - Represents an OAuth token of the account that authorized the Connection, - and associated metadata. - id: OAuthCredential - properties: - oauthTokenSecretVersion: - type: string - description: >- - Optional. A SecretManager resource containing the OAuth token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. - username: + - TYPE_UNSPECIFIED + - STRING + - ARRAY + - OBJECT readOnly: true + objectVal: + additionalProperties: + type: string + type: object + description: Value of the result if type is object. + stringVal: + description: Value of the result if type is string. type: string - description: Output only. The username associated to this token. - type: object - SecurityContext: + description: ResultValue holds different types of data for a single result. + SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. type: object properties: - allowPrivilegeEscalation: - description: >- - Optional. AllowPrivilegeEscalation controls whether a process can - gain more privileges than its parent process. This bool directly - controls if the no_new_privs flag will be set on the container - process. AllowPrivilegeEscalation is true always when the container - is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field - cannot be set when spec.os.name is windows. +optional - type: boolean - runAsGroup: - type: string + policy: + $ref: '#/components/schemas/Policy' description: >- - Optional. The GID to run the entrypoint of the container process. - Uses runtime default if unset. May also be set in - PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional - format: int64 - runAsUser: - format: int64 + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + updateMask: type: string description: >- - Optional. The UID to run the entrypoint of the container process. - Defaults to user specified in image metadata if unspecified. May - also be set in PodSecurityContext. If set in both SecurityContext - and PodSecurityContext, the value specified in SecurityContext takes - precedence. Note that this field cannot be set when spec.os.name is - windows. +optional - runAsNonRoot: - type: boolean - description: >- - Optional. Indicates that the container must run as a non-root user. - If true, the Kubelet will validate the image at runtime to ensure - that it does not run as UID 0 (root) and fail to start the container - if it does. If unset or false, no such validation will be performed. - May also be set in PodSecurityContext. If set in both - SecurityContext and PodSecurityContext, the value specified in - SecurityContext takes precedence. +optional - privileged: - type: boolean - description: Run container in privileged mode. - capabilities: - description: >- - Optional. Adds and removes POSIX capabilities from running - containers. - $ref: '#/components/schemas/Capabilities' - id: SecurityContext - description: Security options the container should be run with. - AuditConfig: - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + format: google-fieldmask + PipelineRun: properties: - service: + pipelineRef: + $ref: '#/components/schemas/PipelineRef' + description: PipelineRef refer to a specific instance of a Pipeline. + completionTime: + readOnly: true + description: Output only. Time the pipeline completed. type: string + format: google-datetime + workspaces: description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - auditLogConfigs: - items: - $ref: '#/components/schemas/AuditLogConfig' - description: The configuration for logging of each type of permission. - type: array - id: AuditConfig - type: object - WorkspacePipelineTaskBinding: - id: WorkspacePipelineTaskBinding - properties: - subPath: - description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional - type: string - workspace: - type: string - description: Name of the workspace declared by the pipeline. - name: - description: Name of the workspace as declared by the task. - type: string - type: object - description: >- - WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to - the workspaces declared in the Task. - StepTemplate: - description: >- - StepTemplate can be used as the basis for all step containers within the - Task, so that the steps inherit settings on the base container. - id: StepTemplate - properties: - volumeMounts: + Workspaces is a list of WorkspaceBindings from volumes to + workspaces. type: array - description: Optional. Pod volumes to mount into the container's filesystem. items: - $ref: '#/components/schemas/VolumeMount' - env: + $ref: '#/components/schemas/WorkspaceBinding' + gcbParams: + readOnly: true + type: object + description: Output only. GCB default params. + additionalProperties: + type: string + results: + readOnly: true description: >- - Optional. List of environment variables to set in the Step. Cannot - be updated. + Optional. Output only. List of results written out by the pipeline's + containers items: - $ref: '#/components/schemas/EnvVar' + $ref: '#/components/schemas/PipelineRunResult' type: array - type: object - ListConnectionsResponse: - type: object - id: ListConnectionsResponse - properties: - nextPageToken: - type: string - description: A token identifying a page of results the server should return. - connections: - description: The list of Connections. + timeouts: + $ref: '#/components/schemas/TimeoutFields' + description: >- + Time after which the Pipeline times out. Currently three keys are + accepted in the map pipeline, tasks and finally with + Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally + childReferences: items: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/ChildStatusReference' type: array - description: Message for response to listing Connections. - OperationMetadata: - description: Represents the metadata of the long-running operation. - properties: - statusDetail: + description: >- + Output only. List of TaskRun and Run names and PipelineTask names + for children of this PipelineRun. + readOnly: true + uid: + readOnly: true type: string - description: Output only. Human-readable status of the operation, if any. + description: Output only. A unique identifier for the `PipelineRun`. + etag: + type: string + description: Needed for declarative-friendly resources. + name: readOnly: true - target: type: string description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true - endTime: - readOnly: true + Output only. The `PipelineRun` name with format + `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` + serviceAccount: + deprecated: true + description: >- + Service account used in the Pipeline. Deprecated; please use + security.service_account instead. type: string + createTime: + description: >- + Output only. Time at which the request to create the `PipelineRun` + was received. format: google-datetime - description: Output only. The time the operation finished running. - verb: + type: string readOnly: true - description: Output only. Name of the verb executed by the operation. + skippedTasks: + description: >- + Output only. List of tasks that were skipped due to when expressions + evaluating to false. + items: + $ref: '#/components/schemas/SkippedTask' + type: array + readOnly: true + worker: + $ref: '#/components/schemas/Worker' + description: Optional. Worker configuration. + params: + type: array + items: + $ref: '#/components/schemas/Param' + description: Params is a list of parameter names and values. + pipelineRunStatus: + enum: + - PIPELINE_RUN_STATUS_UNSPECIFIED + - PIPELINE_RUN_CANCELLED + enumDescriptions: + - Default enum type; should not be used. + - Cancelled status. type: string - apiVersion: + description: Pipelinerun status the user can provide. Used for cancellation. + pipelineSpecYaml: readOnly: true - description: Output only. API version used to start the operation. + description: >- + Output only. Inline pipelineSpec yaml string, used by workflow run + requests. type: string - createTime: + startTime: + format: google-datetime + description: Output only. Time the pipeline is actually started. type: string readOnly: true - format: google-datetime - description: Output only. The time the operation was created. - cancelRequested: - type: boolean + updateTime: readOnly: true description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - id: OperationMetadata - type: object - Repository: - description: A repository associated to a parent connection. - properties: - updateTime: + Output only. Time at which the request to update the `PipelineRun` + was received. format: google-datetime type: string + record: readOnly: true + type: string description: >- - Output only. Server assigned timestamp for when the connection was - updated. + Output only. The `Record` of this `PipelineRun`. Format: + `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` + conditions: + description: >- + Output only. Kubernetes Conditions convention for PipelineRun status + and error. + type: array + items: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' + readOnly: true annotations: - description: Optional. Allows clients to store small amounts of arbitrary data. + description: User annotations. See https://google.aip.dev/128#annotations type: object additionalProperties: type: string - name: + workerPool: + readOnly: true + description: Output only. The WorkerPool used to run this PipelineRun. type: string - description: >- - Immutable. Resource name of the repository, in the format - `projects/*/locations/*/connections/*/repositories/*`. - webhookId: + workflow: type: string + description: Output only. The Workflow used to create this PipelineRun. readOnly: true - description: Output only. External ID of the webhook created for the repository. - etag: + security: + $ref: '#/components/schemas/Security' + description: Optional. Security configuration. + pipelineSpec: + description: PipelineSpec defines the desired state of Pipeline. + $ref: '#/components/schemas/PipelineSpec' + finallyStartTime: description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. + Output only. FinallyStartTime is when all non-finally tasks have + been completed and only finally tasks are being executed. +optional + readOnly: true type: string - createTime: format: google-datetime + provenance: + description: Optional. Provenance configuration. + $ref: '#/components/schemas/Provenance' + resolvedPipelineSpec: + description: Output only. The exact PipelineSpec used to instantiate the run. + $ref: '#/components/schemas/PipelineSpec' readOnly: true - type: string - description: >- - Output only. Server assigned timestamp for when the connection was - created. - remoteUri: - type: string - description: Required. Git Clone HTTPS URI. - id: Repository - type: object - Param: - id: Param - description: >- - Param defined with name and value. PipelineRef can be used to refer to a - specific instance of a Pipeline. - properties: - name: - type: string - description: Name of the parameter. - value: - description: Value of the parameter. - $ref: '#/components/schemas/ParamValue' - type: object - ParamValue: + description: Message describing PipelineRun object + id: PipelineRun type: object - id: ParamValue - description: Parameter value. + GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: properties: - stringVal: - description: Value of the parameter if type is string. + appSlug: type: string - arrayVal: - description: Value of the parameter if type is array. - items: - type: string - type: array - type: - description: Type of parameter. - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY + description: Optional. The URL-friendly name of the GitHub App. + serviceDirectoryConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + description: >- + Optional. Configuration for using Service Directory to privately + connect to a GitHub Enterprise server. This should only be set if + the GitHub Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitHub + Enterprise server will be made over the public internet. + sslCa: + description: Optional. SSL certificate to use for requests to GitHub Enterprise. type: string - FetchReadTokenRequest: - properties: {} - id: FetchReadTokenRequest - type: object - description: Message for fetching SCM read token. - Capabilities: - properties: - drop: - description: Optional. Removed capabilities +optional - type: array - items: - type: string - add: - type: array - items: - type: string - description: Optional. Added capabilities +optional - id: Capabilities - type: object - description: >- - Capabilities adds and removes POSIX capabilities from running - containers. - PropertySpec: - properties: - type: - enum: - - TYPE_UNSPECIFIED - - STRING - enumDescriptions: - - Default enum type; should not be used. - - Default - description: A type for the object. + apiKey: type: string - id: PropertySpec - description: PropertySpec holds information about a property in an object. - type: object - Worker: - type: object - id: Worker - description: Configuration for the worker. - properties: - machineType: + description: Required. API Key used for authentication of webhook events. + webhookSecretSecretVersion: type: string - description: Optional. Machine type of a worker, default is "e2-standard-2". - Expr: - properties: - title: description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + Optional. SecretManager resource containing the webhook secret of + the GitHub App, formatted as `projects/*/secrets/*/versions/*`. + appId: + format: int64 type: string - expression: + description: Optional. Id of the GitHub App created from the manifest. + serverVersion: type: string + readOnly: true + description: Output only. GitHub Enterprise version installed at the host_uri. + privateKeySecretVersion: description: >- - Textual representation of an expression in Common Expression - Language syntax. - location: + Optional. SecretManager resource containing the private key of the + GitHub App, formatted as `projects/*/secrets/*/versions/*`. type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - description: + appInstallationId: + format: int64 + description: Optional. ID of the installation of the GitHub App. type: string + hostUri: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - id: Expr + Required. The URI of the GitHub Enterprise host this connection is + for. + type: string type: object + id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + description: Configuration for connections to an instance of GitHub Enterprise. + HttpBody: 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. - GoogleDevtoolsCloudbuildV2OperationMetadata: - description: Represents the metadata of the long-running operation. + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + id: HttpBody type: object - id: GoogleDevtoolsCloudbuildV2OperationMetadata - properties: - requestedCancellation: - description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - type: boolean - readOnly: true - endTime: - format: google-datetime - type: string - readOnly: true - description: Output only. The time the operation finished running. - statusMessage: - type: string - description: Output only. Human-readable status of the operation, if any. - readOnly: true - target: - description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true - type: string - verb: - type: string - readOnly: true - description: Output only. Name of the verb executed by the operation. - apiVersion: - readOnly: true - type: string - description: Output only. API version used to start the operation. - createTime: - format: google-datetime - readOnly: true - type: string - description: Output only. The time the operation was created. - PipelineSpec: - id: PipelineSpec properties: - tasks: - type: array - description: List of Tasks that execute when this Pipeline is run. - items: - $ref: '#/components/schemas/PipelineTask' - params: - description: List of parameters. + extensions: type: array - items: - $ref: '#/components/schemas/ParamSpec' - results: description: >- - Optional. Output only. List of results written out by the pipeline's - containers - type: array + Application specific response metadata. Must be set in the first + response for streaming APIs. items: - $ref: '#/components/schemas/PipelineResult' - readOnly: true - finallyTasks: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + data: + type: string + description: The HTTP request/response body as raw binary. + format: byte + contentType: + type: string description: >- - List of Tasks that execute just before leaving the Pipeline i.e. - either after all Tasks are finished executing successfully or after - a failure which would result in ending the Pipeline. - items: - $ref: '#/components/schemas/PipelineTask' - type: array - generatedYaml: - description: >- - Output only. auto-generated yaml that is output only for display - purpose for workflows using pipeline_spec, used by UI/gcloud cli for - Workflows. - readOnly: true - type: string - workspaces: - description: >- - Workspaces declares a set of named workspaces that are expected to - be provided by a PipelineRun. - type: array - items: - $ref: '#/components/schemas/PipelineWorkspaceDeclaration' - type: object - description: PipelineSpec defines the desired state of Pipeline. - TaskRef: - type: object - id: TaskRef - properties: - params: - type: array - description: >- - Params contains the parameters used to identify the referenced - Tekton resource. Example entries might include "repo" or "path" but - the set of params ultimately depends on the chosen resolver. - items: - $ref: '#/components/schemas/Param' - resolver: - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - type: string - description: >- - Resolver is the name of the resolver that should perform resolution - of the referenced Tekton resource. - name: - description: Name of the task. - type: string - deprecated: true - description: >- - TaskRef can be used to refer to a specific instance of a task. - PipelineRef can be used to refer to a specific instance of a Pipeline. - GitHubConfig: - properties: - appInstallationId: - format: int64 - type: string - description: Optional. GitHub App installation id. - authorizerCredential: - $ref: '#/components/schemas/OAuthCredential' - description: >- - Optional. OAuth credential of the account that authorized the Cloud - Build GitHub App. It is recommended to use a robot account instead - of a human user account. The OAuth token must be tied to the Cloud - Build GitHub App. - description: Configuration for connections to github.com. - type: object - id: GitHubConfig - BatchCreateRepositoriesRequest: - type: object - properties: - requests: - type: array - description: >- - Required. The request messages specifying the repositories to - create. - items: - $ref: '#/components/schemas/CreateRepositoryRequest' - description: Message for creating repositoritories in batch. - id: BatchCreateRepositoriesRequest - GoogleDevtoolsCloudbuildV2GitLabConfig: - type: object - description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - id: GoogleDevtoolsCloudbuildV2GitLabConfig - properties: - sslCa: - type: string - description: Optional. SSL certificate to use for requests to GitLab Enterprise. - serviceDirectoryConfig: - description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitLab Enterprise server. This should only be set if - the GitLab Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitLab - Enterprise server will be made over the public internet. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - hostUri: - type: string - description: >- - Optional. The URI of the GitLab Enterprise host this connection is - for. If not specified, the default value is https://gitlab.com. - readAuthorizerCredential: - $ref: '#/components/schemas/UserCredential' - description: >- - Required. A GitLab personal access token with the minimum `read_api` - scope access. - webhookSecretSecretVersion: - description: >- - Required. Immutable. SecretManager resource containing the webhook - secret of a GitLab Enterprise project, formatted as - `projects/*/secrets/*/versions/*`. - type: string - authorizerCredential: - description: >- - Required. A GitLab personal access token with the `api` scope - access. - $ref: '#/components/schemas/UserCredential' - serverVersion: - readOnly: true - description: >- - Output only. Version of the GitLab Enterprise server running on the - `host_uri`. - type: string - Operation: - properties: - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - response: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - id: Operation - description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleDevtoolsCloudbuildV2Condition: - type: object - description: Conditions defines a readiness condition for a Knative resource. - id: GoogleDevtoolsCloudbuildV2Condition - properties: - type: - description: Type of condition. - type: string - message: - type: string - description: A human readable message indicating details about the transition. - status: - enumDescriptions: - - Default enum type indicating execution is still ongoing. - - Success - - Failure - type: string - enum: - - UNKNOWN - - 'TRUE' - - 'FALSE' - description: Status of the condition. - lastTransitionTime: - description: >- - LastTransitionTime is the last time the condition transitioned from - one status to another. - type: string - format: google-datetime - severity: - type: string - description: Severity with which to treat failures of this type of condition. - enum: - - SEVERITY_UNSPECIFIED - - WARNING - - INFO - enumDescriptions: - - Default enum type; should not be used. - - Severity is warning. - - Severity is informational only. - reason: - description: The reason for the condition's last transition. - type: string - TestIamPermissionsRequest: - type: object - properties: - permissions: - type: array - description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - items: - type: string - description: Request message for `TestIamPermissions` method. - id: TestIamPermissionsRequest - StepRef: - properties: - name: - description: Optional. Name of the step. - type: string - params: - description: Optional. Parameters used to control the resolution. - type: array - items: - $ref: '#/components/schemas/Param' - resolver: - description: Optional. Type of the resolver. - enum: - - RESOLVER_NAME_UNSPECIFIED - - BUNDLES - - GCB_REPO - - GIT - - DEVELOPER_CONNECT - type: string - enumDescriptions: - - Default enum type; should not be used. - - >- - Bundles resolver. - https://tekton.dev/docs/pipelines/bundle-resolver/ - - GCB repo resolver. - - >- - Simple Git resolver. - https://tekton.dev/docs/pipelines/git-resolver/ - - Developer Connect resolver. - id: StepRef - description: A reference to a remote Step, i.e. a StepAction. - type: object - WorkspaceDeclaration: - type: object - properties: - mountPath: - type: string - description: >- - MountPath overrides the directory that the volume will be made - available at. - optional: - description: >- - Optional. Optional marks a Workspace as not being required in - TaskRuns. By default this field is false and so declared workspaces - are required. - type: boolean - name: - description: Name is the name by which you can bind the volume at runtime. - type: string - readOnly: - type: boolean - description: ReadOnly dictates whether a mounted volume is writable. - description: - description: Description is a human readable description of this volume. - type: string - id: WorkspaceDeclaration - description: WorkspaceDeclaration is a declaration of a volume that a Task requires. - Binding: - id: Binding - properties: - members: - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - items: - type: string - type: array - role: - type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: - $ref: '#/components/schemas/Expr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: object - description: Associates `members`, or principals, with a `role`. - GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: - type: object - id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - description: >- - ServiceDirectoryConfig represents Service Directory configuration for a - connection. - properties: - service: - description: >- - Required. The Service Directory service name. Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. - type: string - PipelineWorkspaceDeclaration: + The HTTP Content-Type header value specifying the content type of + the body. + EmptyDirVolumeSource: + type: object + id: EmptyDirVolumeSource + properties: {} + description: Represents an empty Volume source. + WorkspaceDeclaration: + id: WorkspaceDeclaration type: object - description: >- - Workspaces declares a set of named workspaces that are expected to be - provided by a PipelineRun. properties: - description: - type: string + optional: + type: boolean description: >- - Description is a human readable string describing how the workspace - will be used in the Pipeline. + Optional. Optional marks a Workspace as not being required in + TaskRuns. By default this field is false and so declared workspaces + are required. name: - description: Name is the name of a workspace to be provided by a PipelineRun. type: string - optional: - description: >- - Optional marks a Workspace as not being required in PipelineRuns. By - default this field is false and so declared workspaces are required. + description: Name is the name by which you can bind the volume at runtime. + readOnly: + description: ReadOnly dictates whether a mounted volume is writable. type: boolean - id: PipelineWorkspaceDeclaration - InstallationState: - id: InstallationState - properties: - stage: - type: string - readOnly: true - enumDescriptions: - - No stage specified. - - >- - Only for GitHub Enterprise. An App creation has been requested. - The user needs to confirm the creation in their GitHub enterprise - host. - - User needs to authorize the GitHub (or Enterprise) App via OAuth. - - >- - User needs to follow the link to install the GitHub (or - Enterprise) App. - - Installation process has been completed. - description: Output only. Current step of the installation process. - enum: - - STAGE_UNSPECIFIED - - PENDING_CREATE_APP - - PENDING_USER_OAUTH - - PENDING_INSTALL_APP - - COMPLETE - message: - description: >- - Output only. Message of what the user should do next to continue the - installation. Empty string if the installation is already complete. + mountPath: type: string - readOnly: true - actionUri: description: >- - Output only. Link to follow for next action. Empty string if the - installation is already complete. + MountPath overrides the directory that the volume will be made + available at. + description: type: string - readOnly: true + description: Description is a human readable description of this volume. + description: WorkspaceDeclaration is a declaration of a volume that a Task requires. + GoogleDevtoolsCloudbuildV2GitLabConfig: + id: GoogleDevtoolsCloudbuildV2GitLabConfig description: >- - Describes stage and necessary actions to be taken by the user to - complete the installation. Used for GitHub and GitHub Enterprise based - connections. - type: object - SetIamPolicyRequest: - description: Request message for `SetIamPolicy` method. + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. type: object properties: - policy: + readAuthorizerCredential: + $ref: '#/components/schemas/UserCredential' description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - updateMask: - type: string - format: google-fieldmask + Required. A GitLab personal access token with the minimum `read_api` + scope access. + authorizerCredential: + $ref: '#/components/schemas/UserCredential' description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - id: SetIamPolicyRequest - PipelineTask: - id: PipelineTask - properties: - name: - description: Name of the task. + Required. A GitLab personal access token with the `api` scope + access. + webhookSecretSecretVersion: type: string - taskSpec: - description: Spec to instantiate this TaskRun. - $ref: '#/components/schemas/EmbeddedTask' - workspaces: - items: - $ref: '#/components/schemas/WorkspacePipelineTaskBinding' - type: array description: >- - Workspaces maps workspaces from the pipeline spec to the workspaces - declared in the Task. - retries: - format: int32 + Required. Immutable. SecretManager resource containing the webhook + secret of a GitLab Enterprise project, formatted as + `projects/*/secrets/*/versions/*`. + sslCa: + type: string + description: Optional. SSL certificate to use for requests to GitLab Enterprise. + serverVersion: + readOnly: true + type: string description: >- - Retries represents how many times this task should be retried in - case of task failure. - type: integer - params: - type: array - items: - $ref: '#/components/schemas/Param' - description: Params is a list of parameter names and values. - runAfter: - type: array + Output only. Version of the GitLab Enterprise server running on the + `host_uri`. + hostUri: description: >- - RunAfter is the list of PipelineTask names that should be executed - before this Task executes. (Used to force a specific ordering in - graph execution.) - items: - type: string - taskRef: - $ref: '#/components/schemas/TaskRef' - description: Reference to a specific instance of a task. - whenExpressions: - description: Conditions that need to be true for the task to run. - type: array - items: - $ref: '#/components/schemas/WhenExpression' - timeout: + Optional. The URI of the GitLab Enterprise host this connection is + for. If not specified, the default value is https://gitlab.com. type: string - format: google-duration + serviceDirectoryConfig: description: >- - Time after which the TaskRun times out. Defaults to 1 hour. - Specified TaskRun timeout should be less than 24h. - description: PipelineTask defines a task in a Pipeline. - type: object - AuditLogConfig: + Optional. Configuration for using Service Directory to privately + connect to a GitLab Enterprise server. This should only be set if + the GitLab Enterprise server is hosted on-premises and not reachable + by public internet. If this field is left empty, calls to the GitLab + Enterprise server will be made over the public internet. + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + PipelineSpec: + id: PipelineSpec + description: PipelineSpec defines the desired state of Pipeline. type: object - id: AuditLogConfig properties: - logType: - description: The log type that this config enables. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - type: string - exemptedMembers: + results: + items: + $ref: '#/components/schemas/PipelineResult' description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. + Optional. Output only. List of results written out by the pipeline's + containers + readOnly: true + type: array + workspaces: type: array items: - type: string - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - PipelineRun: - properties: - etag: - type: string - description: Needed for declarative-friendly resources. - pipelineSpecYaml: + $ref: '#/components/schemas/PipelineWorkspaceDeclaration' + description: >- + Workspaces declares a set of named workspaces that are expected to + be provided by a PipelineRun. + tasks: + items: + $ref: '#/components/schemas/PipelineTask' + type: array + description: List of Tasks that execute when this Pipeline is run. + generatedYaml: type: string readOnly: true description: >- - Output only. Inline pipelineSpec yaml string, used by workflow run - requests. - skippedTasks: - readOnly: true + Output only. auto-generated yaml that is output only for display + purpose for workflows using pipeline_spec, used by UI/gcloud cli for + Workflows. + params: + description: List of parameters. + items: + $ref: '#/components/schemas/ParamSpec' + type: array + finallyTasks: type: array - description: >- - Output only. List of tasks that were skipped due to when expressions - evaluating to false. items: - $ref: '#/components/schemas/SkippedTask' - worker: - description: Optional. Worker configuration. - $ref: '#/components/schemas/Worker' - workerPool: + $ref: '#/components/schemas/PipelineTask' + description: >- + List of Tasks that execute just before leaving the Pipeline i.e. + either after all Tasks are finished executing successfully or after + a failure which would result in ending the Pipeline. + InstallationState: + type: object + id: InstallationState + description: >- + Describes stage and necessary actions to be taken by the user to + complete the installation. Used for GitHub and GitHub Enterprise based + connections. + properties: + actionUri: + description: >- + Output only. Link to follow for next action. Empty string if the + installation is already complete. type: string - description: Output only. The WorkerPool used to run this PipelineRun. readOnly: true - completionTime: - description: Output only. Time the pipeline completed. + message: + readOnly: true + description: >- + Output only. Message of what the user should do next to continue the + installation. Empty string if the installation is already complete. type: string - format: google-datetime + stage: + type: string + description: Output only. Current step of the installation process. readOnly: true - pipelineRunStatus: - description: Pipelinerun status the user can provide. Used for cancellation. - enum: - - PIPELINE_RUN_STATUS_UNSPECIFIED - - PIPELINE_RUN_CANCELLED enumDescriptions: - - Default enum type; should not be used. - - Cancelled status. + - No stage specified. + - >- + Only for GitHub Enterprise. An App creation has been requested. + The user needs to confirm the creation in their GitHub enterprise + host. + - User needs to authorize the GitHub (or Enterprise) App via OAuth. + - >- + User needs to follow the link to install the GitHub (or + Enterprise) App. + - Installation process has been completed. + enum: + - STAGE_UNSPECIFIED + - PENDING_CREATE_APP + - PENDING_USER_OAUTH + - PENDING_INSTALL_APP + - COMPLETE + EnvVar: + type: object + id: EnvVar + properties: + name: + description: Name of the environment variable. type: string - timeouts: - description: >- - Time after which the Pipeline times out. Currently three keys are - accepted in the map pipeline, tasks and finally with - Timeouts.pipeline >= Timeouts.tasks + Timeouts.finally - $ref: '#/components/schemas/TimeoutFields' - resolvedPipelineSpec: - readOnly: true - description: Output only. The exact PipelineSpec used to instantiate the run. - $ref: '#/components/schemas/PipelineSpec' - workspaces: - items: - $ref: '#/components/schemas/WorkspaceBinding' - type: array - description: >- - Workspaces is a list of WorkspaceBindings from volumes to - workspaces. - security: - $ref: '#/components/schemas/Security' - description: Optional. Security configuration. - workflow: - description: Output only. The Workflow used to create this PipelineRun. + value: type: string + description: Value of the environment variable. + description: Environment variable. + Repository: + properties: + updateTime: readOnly: true - childReferences: - type: array + format: google-datetime description: >- - Output only. List of TaskRun and Run names and PipelineTask names - for children of this PipelineRun. - readOnly: true - items: - $ref: '#/components/schemas/ChildStatusReference' + Output only. Server assigned timestamp for when the connection was + updated. + type: string + annotations: + type: object + additionalProperties: + type: string + description: Optional. Allows clients to store small amounts of arbitrary data. name: type: string description: >- - Output only. The `PipelineRun` name with format - `projects/{project}/locations/{location}/pipelineRuns/{pipeline_run}` - readOnly: true - finallyStartTime: + Immutable. Resource name of the repository, in the format + `projects/*/locations/*/connections/*/repositories/*`. + etag: description: >- - Output only. FinallyStartTime is when all non-finally tasks have - been completed and only finally tasks are being executed. +optional + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. + type: string + webhookId: + description: Output only. External ID of the webhook created for the repository. + type: string + readOnly: true + remoteUri: type: string + description: Required. Git Clone HTTPS URI. + createTime: format: google-datetime + description: >- + Output only. Server assigned timestamp for when the connection was + created. readOnly: true - pipelineRef: - description: PipelineRef refer to a specific instance of a Pipeline. - $ref: '#/components/schemas/PipelineRef' - pipelineSpec: - $ref: '#/components/schemas/PipelineSpec' - description: PipelineSpec defines the desired state of Pipeline. - conditions: + type: string + description: A repository associated to a parent connection. + type: object + id: Repository + FetchReadTokenRequest: + type: object + properties: {} + id: FetchReadTokenRequest + description: Message for fetching SCM read token. + ChildStatusReference: + type: object + id: ChildStatusReference + description: >- + ChildStatusReference is used to point to the statuses of individual + TaskRuns and Runs within this PipelineRun. + properties: + type: + description: Output only. Type of the child reference. + enum: + - TYPE_UNSPECIFIED + - TASK_RUN readOnly: true + type: string + enumDescriptions: + - Default enum type; should not be used. + - TaskRun. + whenExpressions: type: array description: >- - Output only. Kubernetes Conditions convention for PipelineRun status - and error. + WhenExpressions is the list of checks guarding the execution of the + PipelineTask items: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2Condition' - gcbParams: - type: object - readOnly: true - additionalProperties: - type: string - description: Output only. GCB default params. - provenance: - $ref: '#/components/schemas/Provenance' - description: Optional. Provenance configuration. - startTime: + $ref: '#/components/schemas/WhenExpression' + name: + description: Name is the name of the TaskRun or Run this is referencing. type: string - readOnly: true - format: google-datetime - description: Output only. Time the pipeline is actually started. - createTime: - readOnly: true - format: google-datetime + pipelineTaskName: type: string description: >- - Output only. Time at which the request to create the `PipelineRun` - was received. - updateTime: + PipelineTaskName is the name of the PipelineTask this is + referencing. + AuditConfig: + description: >- + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + properties: + service: + type: string description: >- - Output only. Time at which the request to update the `PipelineRun` - was received. + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + auditLogConfigs: + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/AuditLogConfig' + type: array + type: object + id: AuditConfig + PipelineRef: + properties: + name: type: string - format: google-datetime - readOnly: true - serviceAccount: + description: Optional. Name of the Pipeline. + resolver: + enumDescriptions: + - Default enum type; should not be used. + - >- + Bundles resolver. + https://tekton.dev/docs/pipelines/bundle-resolver/ + - GCB repo resolver. + - >- + Simple Git resolver. + https://tekton.dev/docs/pipelines/git-resolver/ + - Developer Connect resolver. + - Default resolver. type: string description: >- - Service account used in the Pipeline. Deprecated; please use - security.service_account instead. - deprecated: true - results: - readOnly: true - description: >- - Optional. Output only. List of results written out by the pipeline's - containers - type: array + Resolver is the name of the resolver that should perform resolution + of the referenced Tekton resource. + enum: + - RESOLVER_NAME_UNSPECIFIED + - BUNDLES + - GCB_REPO + - GIT + - DEVELOPER_CONNECT + - DEFAULT + params: items: - $ref: '#/components/schemas/PipelineRunResult' + $ref: '#/components/schemas/Param' + type: array + description: >- + Params contains the parameters used to identify the referenced + Tekton resource. Example entries might include "repo" or "path" but + the set of params ultimately depends on the chosen resolver. + id: PipelineRef + description: PipelineRef can be used to refer to a specific instance of a Pipeline. + type: object + PipelineTask: + type: object + description: PipelineTask defines a task in a Pipeline. + properties: params: description: Params is a list of parameter names and values. items: $ref: '#/components/schemas/Param' type: array - annotations: - additionalProperties: - type: string - description: User annotations. See https://google.aip.dev/128#annotations - type: object - uid: - readOnly: true + taskSpec: + description: Spec to instantiate this TaskRun. + $ref: '#/components/schemas/EmbeddedTask' + name: + description: Name of the task. type: string - description: Output only. A unique identifier for the `PipelineRun`. - record: - readOnly: true + timeout: type: string description: >- - Output only. The `Record` of this `PipelineRun`. Format: - `projects/{project}/locations/{location}/results/{result_id}/records/{record_id}` - description: Message describing PipelineRun object - type: object - id: PipelineRun - Connection: - id: Connection - type: object - properties: - disabled: - type: boolean + Time after which the TaskRun times out. Defaults to 1 hour. + Specified TaskRun timeout should be less than 24h. + format: google-duration + whenExpressions: + description: Conditions that need to be true for the task to run. + items: + $ref: '#/components/schemas/WhenExpression' + type: array + retries: + type: integer description: >- - Optional. If disabled is set to true, functionality is disabled for - this connection. Repository based API methods and webhooks - processing for repositories in this connection will be disabled. - bitbucketCloudConfig: - $ref: '#/components/schemas/BitbucketCloudConfig' - description: Configuration for connections to Bitbucket Cloud. - reconciling: - readOnly: true + Retries represents how many times this task should be retried in + case of task failure. + format: int32 + runAfter: description: >- - Output only. Set to true when the connection is being set up or - updated in the background. - type: boolean - githubConfig: - description: Configuration for connections to github.com. - $ref: '#/components/schemas/GitHubConfig' - name: + RunAfter is the list of PipelineTask names that should be executed + before this Task executes. (Used to force a specific ordering in + graph execution.) + items: + type: string + type: array + workspaces: description: >- - Immutable. The resource name of the connection, in the format - `projects/{project}/locations/{location}/connections/{connection_id}`. + Workspaces maps workspaces from the pipeline spec to the workspaces + declared in the Task. + items: + $ref: '#/components/schemas/WorkspacePipelineTaskBinding' + type: array + taskRef: + $ref: '#/components/schemas/TaskRef' + description: Reference to a specific instance of a task. + id: PipelineTask + ListConnectionsResponse: + description: Message for response to listing Connections. + properties: + nextPageToken: type: string - gitlabConfig: - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' + description: A token identifying a page of results the server should return. + connections: + description: The list of Connections. + items: + $ref: '#/components/schemas/Connection' + type: array + type: object + id: ListConnectionsResponse + Location: + properties: + metadata: + type: object description: >- - Configuration for connections to gitlab.com or an instance of GitLab - Enterprise. - githubEnterpriseConfig: - description: Configuration for connections to an instance of GitHub Enterprise. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - installationState: - description: Output only. Installation state of the Connection. - $ref: '#/components/schemas/InstallationState' - readOnly: true - bitbucketDataCenterConfig: - description: Configuration for connections to Bitbucket Data Center. - $ref: '#/components/schemas/BitbucketDataCenterConfig' - annotations: - description: Optional. Allows clients to store small amounts of arbitrary data. + Service-specific metadata. For example the available capacity at the + given location. additionalProperties: - type: string - type: object - updateTime: - format: google-datetime - readOnly: true + type: any + description: Properties of the object. Contains field @type with type URL. + name: + type: string description: >- - Output only. Server assigned timestamp for when the connection was - updated. + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + locationId: type: string - createTime: - readOnly: true + description: 'The canonical id for this location. For example: `"us-east1"`.' + displayName: description: >- - Output only. Server assigned timestamp for when the connection was - created. - format: google-datetime + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". type: string - etag: + labels: + type: object + additionalProperties: + type: string description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + id: Location + type: object + description: A resource that represents a Google Cloud location. + GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig: + id: GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig + properties: + service: + description: >- + Required. The Service Directory service name. Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. type: string + type: object description: >- - A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data - Center, Bitbucket Cloud or GitLab. - FetchGitRefsResponse: - description: Response for fetching git refs + ServiceDirectoryConfig represents Service Directory configuration for a + connection. + WhenExpression: + description: Conditions that need to be true for the task to run. type: object - id: FetchGitRefsResponse + id: WhenExpression properties: - refNames: + expressionOperator: + description: Operator that represents an Input's relationship to the values + enum: + - EXPRESSION_OPERATOR_UNSPECIFIED + - IN + - NOT_IN + type: string + enumDescriptions: + - Default enum type; should not be used. + - Input is in values. + - Input is not in values. + input: + type: string + description: >- + Input is the string for guard checking which can be a static input + or an output from a parent Task. + values: + description: >- + Values is an array of strings, which is compared against the input, + for guard checking. items: type: string type: array - description: Name of the refs fetched. - nextPageToken: - type: string - description: A token identifying a page of results the server should return. - TimeoutFields: - id: TimeoutFields - type: object + UserCredential: + id: UserCredential properties: - tasks: - type: string - description: Tasks sets the maximum allowed duration of this pipeline's tasks - format: google-duration - finally: - format: google-duration - description: Finally sets the maximum allowed duration of this pipeline's finally - type: string - pipeline: + username: + readOnly: true + description: Output only. The username associated to this token. type: string + userTokenSecretVersion: description: >- - Pipeline sets the maximum allowed duration for execution of the - entire pipeline. The sum of individual timeouts for tasks and - finally must not exceed this value. - format: google-duration + Required. A SecretManager resource containing the user token that + authorizes the Cloud Build connection. Format: + `projects/*/secrets/*/versions/*`. + type: string description: >- - TimeoutFields allows granular specification of pipeline, task, and - finally timeouts - PipelineResult: + Represents a personal access token that authorized the Connection, and + associated metadata. type: object - description: A value produced by a Pipeline. + PropertySpec: properties: - name: - description: Output only. Name of the result. - readOnly: true - type: string - value: - readOnly: true - $ref: '#/components/schemas/ResultValue' - description: Output only. Value of the result. type: - readOnly: true + description: A type for the object. enum: - TYPE_UNSPECIFIED - STRING - - ARRAY - - OBJECT + type: string enumDescriptions: - Default enum type; should not be used. - Default - - Array type - - Object type - type: string - description: Output only. The type of data that the result holds. - description: - description: Output only. Description of the result. - readOnly: true - type: string - id: PipelineResult - UserCredential: + id: PropertySpec + type: object + description: PropertySpec holds information about a property in an object. + Step: description: >- - Represents a personal access token that authorized the Connection, and - associated metadata. - id: UserCredential + Step embeds the Container type, which allows it to include fields not + provided by Container. + id: Step type: object properties: - username: - readOnly: true - description: Output only. The username associated to this token. + timeout: + format: google-duration type: string - userTokenSecretVersion: - description: >- - Required. A SecretManager resource containing the user token that - authorizes the Cloud Build connection. Format: - `projects/*/secrets/*/versions/*`. + description: Time after which the Step times out. Defaults to never. + name: + description: Name of the container specified as a DNS_LABEL. type: string - ChildStatusReference: - id: ChildStatusReference - description: >- - ChildStatusReference is used to point to the statuses of individual - TaskRuns and Runs within this PipelineRun. - properties: - pipelineTaskName: + args: + description: Arguments to the entrypoint. + items: + type: string + type: array + params: + items: + $ref: '#/components/schemas/Param' + type: array + description: Optional. Optional parameters passed to the StepAction. + workingDir: + description: Container's working directory. type: string - description: >- - PipelineTaskName is the name of the PipelineTask this is - referencing. - name: + image: type: string - description: Name is the name of the TaskRun or Run this is referencing. - whenExpressions: - description: >- - WhenExpressions is the list of checks guarding the execution of the - PipelineTask + description: Docker image name. + env: + description: List of environment variables to set in the container. type: array items: - $ref: '#/components/schemas/WhenExpression' - type: - readOnly: true - enum: - - TYPE_UNSPECIFIED - - TASK_RUN + $ref: '#/components/schemas/EnvVar' + onError: type: string - description: Output only. Type of the child reference. + description: >- + Optional. OnError defines the exiting behavior on error can be set + to [ continue | stopAndFail ] enumDescriptions: - Default enum type; should not be used. - - TaskRun. - type: object - EnvVar: - type: object - id: EnvVar + - >- + StopAndFail indicates exit if the step/task exits with non-zero + exit code + - >- + Continue indicates continue executing the rest of the steps/tasks + irrespective of the exit code + enum: + - ON_ERROR_TYPE_UNSPECIFIED + - STOP_AND_FAIL + - CONTINUE + ref: + $ref: '#/components/schemas/StepRef' + description: Optional. Optional reference to a remote StepAction. + securityContext: + description: >- + Optional. SecurityContext defines the security options the Step + should be run with. If set, the fields of SecurityContext override + the equivalent fields of PodSecurityContext. More info: + https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + +optional + $ref: '#/components/schemas/SecurityContext' + script: + type: string + description: The contents of an executable file to execute. + volumeMounts: + items: + $ref: '#/components/schemas/VolumeMount' + type: array + description: Pod volumes to mount into the container's filesystem. + command: + items: + type: string + type: array + description: Entrypoint array. + Security: + description: Security configuration. properties: - value: + serviceAccount: type: string - description: Value of the environment variable. - name: + description: IAM service account whose credentials will be used at runtime. + privilegeMode: + deprecated: true + description: Optional. Privilege mode. + enumDescriptions: + - Default to PRIVILEGED. + - Privileged mode. + - Unprivileged mode. type: string - description: Name of the environment variable. - description: Environment variable. - RunWorkflowCustomOperationMetadata: - id: RunWorkflowCustomOperationMetadata + enum: + - PRIVILEGE_MODE_UNSPECIFIED + - PRIVILEGED + - UNPRIVILEGED + id: Security + type: object + Probe: + type: object + description: >- + Probe describes a health check to be performed against a container to + determine whether it is alive or ready to receive traffic. + id: Probe properties: - verb: - readOnly: true + exec: + $ref: '#/components/schemas/ExecAction' + description: Optional. Exec specifies the action to take. +optional + periodSeconds: + description: >- + Optional. How often (in seconds) to perform the probe. Default to 10 + seconds. Minimum value is 1. +optional + type: integer + format: int32 + Expr: + 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. + id: Expr + properties: + expression: type: string - description: Output only. Name of the verb executed by the operation. - apiVersion: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + location: type: string - readOnly: true - description: Output only. API version used to start the operation. - target: - readOnly: true + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. type: string + description: description: >- - Output only. Server-defined resource path for the target of the - operation. - createTime: - readOnly: true - description: Output only. The time the operation was created. + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. type: string - format: google-datetime - pipelineRunId: - readOnly: true + type: object + WorkspacePipelineTaskBinding: + id: WorkspacePipelineTaskBinding + properties: + subPath: type: string - description: Output only. ID of the pipeline run created by RunWorkflow. - requestedCancellation: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - readOnly: true - type: boolean - endTime: - readOnly: true + Optional. SubPath is optionally a directory on the volume which + should be used for this binding (i.e. the volume will be mounted at + this sub directory). +optional + name: type: string - format: google-datetime - description: Output only. The time the operation finished running. - description: >- - Represents the custom metadata of the RunWorkflow long-running - operation. + description: Name of the workspace as declared by the task. + workspace: + type: string + description: Name of the workspace declared by the pipeline. type: object - HttpBody: - id: HttpBody description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. + WorkspacePipelineTaskBinding maps workspaces from the PipelineSpec to + the workspaces declared in the Task. + Empty: + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + id: Empty + properties: {} + StepTemplate: type: object properties: - contentType: - type: string - description: >- - The HTTP Content-Type header value specifying the content type of - the body. - extensions: - description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. + env: items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + $ref: '#/components/schemas/EnvVar' + type: array + description: >- + Optional. List of environment variables to set in the Step. Cannot + be updated. + volumeMounts: + description: Optional. Pod volumes to mount into the container's filesystem. + items: + $ref: '#/components/schemas/VolumeMount' type: array - data: - description: The HTTP request/response body as raw binary. - format: byte - type: string + id: StepTemplate + description: >- + StepTemplate can be used as the basis for all step containers within the + Task, so that the steps inherit settings on the base container. VolumeSource: type: object - id: VolumeSource - description: Volumes available to mount. properties: + emptyDir: + $ref: '#/components/schemas/EmptyDirVolumeSource' + description: A temporary directory that shares a pod's lifetime. name: - type: string description: >- Name of the Volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - emptyDir: - $ref: '#/components/schemas/EmptyDirVolumeSource' - description: A temporary directory that shares a pod's lifetime. - BitbucketDataCenterConfig: + type: string + description: Volumes available to mount. + id: VolumeSource + BatchCreateRepositoriesRequest: + id: BatchCreateRepositoriesRequest + description: Message for creating repositoritories in batch. properties: - sslCa: + requests: description: >- - Optional. SSL certificate to use for requests to the Bitbucket Data - Center. - type: string - hostUri: - type: string + Required. The request messages specifying the repositories to + create. + type: array + items: + $ref: '#/components/schemas/CreateRepositoryRequest' + type: object + Binding: + type: object + description: Associates `members`, or principals, with a `role`. + properties: + condition: + $ref: '#/components/schemas/Expr' description: >- - Required. The URI of the Bitbucket Data Center instance or cluster - this connection is for. - serviceDirectoryConfig: + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + role: description: >- - Optional. Configuration for using Service Directory to privately - connect to a Bitbucket Data Center. This should only be set if the - Bitbucket Data Center is hosted on-premises and not reachable by - public internet. If this field is left empty, calls to the Bitbucket - Data Center will be made over the public internet. - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - readAuthorizerCredential: - description: Required. A http access token with the `REPO_READ` access. - $ref: '#/components/schemas/UserCredential' - webhookSecretSecretVersion: + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string + members: description: >- - Required. Immutable. SecretManager resource containing the webhook - secret used to verify webhook events, formatted as - `projects/*/secrets/*/versions/*`. - serverVersion: + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + items: + type: string + type: array + id: Binding + FetchReadWriteTokenResponse: + id: FetchReadWriteTokenResponse + description: Message for responding to get read/write token. + type: object + properties: + expirationTime: + description: Expiration timestamp. Can be empty if unknown or non-expiring. + format: google-datetime + type: string + token: + description: The token content. + type: string + PipelineRunResult: + type: object + description: PipelineRunResult used to describe the results of a pipeline + properties: + name: readOnly: true type: string - description: >- - Output only. Version of the Bitbucket Data Center running on the - `host_uri`. - authorizerCredential: - description: Required. A http access token with the `REPO_ADMIN` scope access. - $ref: '#/components/schemas/UserCredential' - description: Configuration for connections to Bitbucket Data Center. + description: Output only. Name of the TaskRun + value: + readOnly: true + description: Output only. Value of the result. + $ref: '#/components/schemas/ResultValue' + id: PipelineRunResult + FetchGitRefsResponse: + id: FetchGitRefsResponse type: object - id: BitbucketDataCenterConfig - ResultValue: properties: - objectVal: - description: Value of the result if type is object. + refNames: + type: array + items: + type: string + description: Name of the refs fetched. + nextPageToken: + description: A token identifying a page of results the server should return. + type: string + description: Response for fetching git refs + FetchReadWriteTokenRequest: + description: Message for fetching SCM read/write token. + type: object + id: FetchReadWriteTokenRequest + properties: {} + EmbeddedTask: + description: EmbeddedTask defines a Task that is embedded in a Pipeline. + properties: + taskSpec: + $ref: '#/components/schemas/TaskSpec' + description: Spec to instantiate this TaskRun. + annotations: + description: User annotations. See https://google.aip.dev/128#annotations additionalProperties: type: string type: object - stringVal: - description: Value of the result if type is string. + id: EmbeddedTask + type: object + Param: + properties: + value: + description: Value of the parameter. + $ref: '#/components/schemas/ParamValue' + name: type: string - type: - description: Output only. The type of data that the result holds. - enumDescriptions: - - Default enum type; should not be used. - - Default - - Array type - - Object type - readOnly: true - enum: - - TYPE_UNSPECIFIED - - STRING - - ARRAY - - OBJECT + description: Name of the parameter. + id: Param + type: object + description: >- + Param defined with name and value. PipelineRef can be used to refer to a + specific instance of a Pipeline. + Sidecar: + description: Sidecars run alongside the Task's step containers. + id: Sidecar + properties: + volumeMounts: + description: Pod volumes to mount into the container's filesystem. + type: array + items: + $ref: '#/components/schemas/VolumeMount' + image: + type: string + description: Docker image name. + env: + description: List of environment variables to set in the container. + items: + $ref: '#/components/schemas/EnvVar' + type: array + script: + type: string + description: The contents of an executable file to execute. + securityContext: + $ref: '#/components/schemas/SecurityContext' + description: Optional. Security options the container should be run with. + name: + type: string + description: Name of the Sidecar. + workingDir: type: string - arrayVal: + description: Container's working directory. + args: + items: + type: string type: array - description: Value of the result if type is array. + description: Arguments to the entrypoint. + command: items: type: string - description: ResultValue holds different types of data for a single result. - id: ResultValue - type: object - GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig: + description: Entrypoint array. + type: array + readinessProbe: + $ref: '#/components/schemas/Probe' + description: >- + Optional. Periodic probe of Sidecar service readiness. Container + will be removed from service endpoints if the probe fails. Cannot be + updated. More info: + https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +optional type: object + RunWorkflowCustomOperationMetadata: properties: - appSlug: + verb: type: string - description: Optional. The URL-friendly name of the GitHub App. - hostUri: + description: Output only. Name of the verb executed by the operation. + readOnly: true + endTime: type: string - description: >- - Required. The URI of the GitHub Enterprise host this connection is - for. - serviceDirectoryConfig: - $ref: >- - #/components/schemas/GoogleDevtoolsCloudbuildV2ServiceDirectoryConfig - description: >- - Optional. Configuration for using Service Directory to privately - connect to a GitHub Enterprise server. This should only be set if - the GitHub Enterprise server is hosted on-premises and not reachable - by public internet. If this field is left empty, calls to the GitHub - Enterprise server will be made over the public internet. - serverVersion: + readOnly: true + description: Output only. The time the operation finished running. + format: google-datetime + pipelineRunId: + readOnly: true type: string + description: Output only. ID of the pipeline run created by RunWorkflow. + apiVersion: readOnly: true - description: Output only. GitHub Enterprise version installed at the host_uri. - apiKey: - description: Required. API Key used for authentication of webhook events. type: string - appInstallationId: - format: int64 + description: Output only. API version used to start the operation. + requestedCancellation: + type: boolean + readOnly: true + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + createTime: + readOnly: true + format: google-datetime + description: Output only. The time the operation was created. type: string - description: Optional. ID of the installation of the GitHub App. - privateKeySecretVersion: + target: type: string description: >- - Optional. SecretManager resource containing the private key of the - GitHub App, formatted as `projects/*/secrets/*/versions/*`. - appId: - format: int64 - description: Optional. Id of the GitHub App created from the manifest. + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + id: RunWorkflowCustomOperationMetadata + description: >- + Represents the custom metadata of the RunWorkflow long-running + operation. + type: object + VolumeMount: + id: VolumeMount + description: Pod volumes to mount into the container's filesystem. + properties: + name: type: string - sslCa: + description: Name of the volume. + subPath: type: string - description: Optional. SSL certificate to use for requests to GitHub Enterprise. - webhookSecretSecretVersion: + description: >- + Path within the volume from which the container's volume should be + mounted. Defaults to "" (volume's root). + mountPath: + description: >- + Path within the container at which the volume should be mounted. + Must not contain ':'. type: string + readOnly: description: >- - Optional. SecretManager resource containing the webhook secret of - the GitHub App, formatted as `projects/*/secrets/*/versions/*`. - id: GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig - description: Configuration for connections to an instance of GitHub Enterprise. - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - properties: - permissions: - type: array + Mounted read-only if true, read-write otherwise (false or + unspecified). + type: boolean + subPathExpr: description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - items: - type: string - type: object - EmptyDirVolumeSource: - id: EmptyDirVolumeSource - description: Represents an empty Volume source. - properties: {} + Expanded path within the volume from which the container's volume + should be mounted. Behaves similarly to SubPath but environment + variable references $(VAR_NAME) are expanded using the container's + environment. Defaults to "" (volume's root). + type: string type: object - WorkspaceBinding: - id: WorkspaceBinding - description: >- - WorkspaceBinding maps a workspace to a Volume. PipelineRef can be used - to refer to a specific instance of a Pipeline. + SkippedTask: + id: SkippedTask type: object properties: + reason: + description: Output only. Reason is the cause of the PipelineTask being skipped. + readOnly: true + type: string name: - description: Name of the workspace. type: string - secret: - $ref: '#/components/schemas/SecretVolumeSource' - description: Secret Volume Source. - subPath: + description: Name is the Pipeline Task name + whenExpressions: + description: >- + WhenExpressions is the list of checks guarding the execution of the + PipelineTask + items: + $ref: '#/components/schemas/WhenExpression' + type: array + description: >- + SkippedTask is used to describe the Tasks that were skipped due to their + When Expressions evaluating to False. + Policy: + id: Policy + properties: + version: + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + format: int32 + type: integer + auditConfigs: + items: + $ref: '#/components/schemas/AuditConfig' + type: array + description: Specifies cloud audit logging configuration for this policy. + etag: + description: >- + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + format: byte type: string + bindings: description: >- - Optional. SubPath is optionally a directory on the volume which - should be used for this binding (i.e. the volume will be mounted at - this sub directory). +optional - CancelOperationRequest: - description: The request message for Operations.CancelOperation. - properties: {} - id: CancelOperationRequest + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/Binding' + type: array + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). type: object - Location: + Connection: + description: >- + A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data + Center, Bitbucket Cloud or GitLab. type: object properties: - labels: + updateTime: + type: string + format: google-datetime description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' + Output only. Server assigned timestamp for when the connection was + updated. + readOnly: true + githubConfig: + description: Configuration for connections to github.com. + $ref: '#/components/schemas/GitHubConfig' + etag: type: string - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any description: >- - Service-specific metadata. For example the available capacity at the - given location. + This checksum is computed by the server based on the value of other + fields, and may be sent on update and delete requests to ensure the + client has an up-to-date value before proceeding. + bitbucketDataCenterConfig: + description: Configuration for connections to Bitbucket Data Center. + $ref: '#/components/schemas/BitbucketDataCenterConfig' + gitlabConfig: + $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV2GitLabConfig' + description: >- + Configuration for connections to gitlab.com or an instance of GitLab + Enterprise. + annotations: + description: Optional. Allows clients to store small amounts of arbitrary data. + additionalProperties: + type: string type: object - displayName: + name: type: string description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - name: + Immutable. The resource name of the connection, in the format + `projects/{project}/locations/{location}/connections/{connection_id}`. + reconciling: + readOnly: true description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` + Output only. Set to true when the connection is being set up or + updated in the background. + type: boolean + githubEnterpriseConfig: + $ref: >- + #/components/schemas/GoogleDevtoolsCloudbuildV2GitHubEnterpriseConfig + description: Configuration for connections to an instance of GitHub Enterprise. + bitbucketCloudConfig: + $ref: '#/components/schemas/BitbucketCloudConfig' + description: Configuration for connections to Bitbucket Cloud. + createTime: + description: >- + Output only. Server assigned timestamp for when the connection was + created. + readOnly: true + format: google-datetime type: string - description: A resource that represents a Google Cloud location. - id: Location - ExecAction: - properties: - command: - type: array + installationState: + readOnly: true + description: Output only. Installation state of the Connection. + $ref: '#/components/schemas/InstallationState' + disabled: description: >- - Optional. Command is the command line to execute inside the - container, the working directory for the command is root ('/') in - the container's filesystem. The command is simply exec'd, it is not - run inside a shell, so traditional shell instructions ('|', etc) - won't work. To use a shell, you need to explicitly call out to that - shell. Exit status of 0 is treated as live/healthy and non-zero is - unhealthy. +optional - items: - type: string - id: ExecAction - description: ExecAction describes a "run in container" action. - type: object - Step: - id: Step + Optional. If disabled is set to true, functionality is disabled for + this connection. Repository based API methods and webhooks + processing for repositories in this connection will be disabled. + type: boolean + id: Connection + Worker: + description: Configuration for the worker. type: object - description: >- - Step embeds the Container type, which allows it to include fields not - provided by Container. properties: - workingDir: + machineType: + description: Optional. Machine type of a worker, default is "e2-standard-2". type: string - description: Container's working directory. - env: - type: array - items: - $ref: '#/components/schemas/EnvVar' - description: List of environment variables to set in the container. - command: - type: array - description: Entrypoint array. - items: - type: string - securityContext: - $ref: '#/components/schemas/SecurityContext' + id: Worker + Status: + id: Status + type: object + properties: + message: description: >- - Optional. SecurityContext defines the security options the Step - should be run with. If set, the fields of SecurityContext override - the equivalent fields of PodSecurityContext. More info: - https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - +optional - ref: - $ref: '#/components/schemas/StepRef' - description: Optional. Optional reference to a remote StepAction. - image: - description: Docker image name. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - params: + details: items: - $ref: '#/components/schemas/Param' + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. type: array - description: Optional. Optional parameters passed to the StepAction. - script: - type: string - description: The contents of an executable file to execute. - name: + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + SecretVolumeSource: + id: SecretVolumeSource + properties: + secretName: + description: Name of the secret referenced by the WorkspaceBinding. type: string - description: Name of the container specified as a DNS_LABEL. - args: - type: array - items: - type: string - description: Arguments to the entrypoint. - volumeMounts: - type: array - description: Pod volumes to mount into the container's filesystem. - items: - $ref: '#/components/schemas/VolumeMount' - timeout: + secretVersion: + description: >- + Optional. Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* type: string - description: Time after which the Step times out. Defaults to never. - format: google-duration + description: Secret Volume Source. + type: object parameters: - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: type: string + enum: + - '1' + - '2' alt: description: Data format for response. in: query @@ -2493,16 +2505,34 @@ components: name: key schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: uploadType + name: upload_protocol schema: type: string x-stackQL-resources: @@ -2511,17 +2541,17 @@ components: name: operations title: Operations methods: - projects_locations_operations_cancel: + projects_locations_operations_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_get: + projects_locations_operations_cancel: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post response: mediaType: application/json openAPIDocKey: '200' @@ -2531,54 +2561,34 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get insert: [] update: [] - delete: [] - repositories_git_refs: - id: google.cloudbuild.repositories_git_refs - name: repositories_git_refs - title: Repositories_git_refs - methods: - projects_locations_connections_repositories_fetch_git_refs: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:fetchGitRefs/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] + replace: [] delete: [] repositories: id: google.cloudbuild.repositories name: repositories title: Repositories methods: - projects_locations_connections_repositories_access_read_write_token: + projects_locations_connections_repositories_access_read_token: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_access_read_token: + projects_locations_connections_repositories_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadToken/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_connections_repositories_list: - operation: &ref_1 + projects_locations_connections_repositories_get: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get - response: &ref_2 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.repositories - projects_locations_connections_repositories_list: - operation: *ref_1 - response: *ref_2 projects_locations_connections_repositories_create: operation: $ref: >- @@ -2586,24 +2596,25 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_batch_create: + projects_locations_connections_repositories_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_delete: + objectKey: $.repositories + projects_locations_connections_repositories_access_read_write_token: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:accessReadWriteToken/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_repositories_get: + projects_locations_connections_repositories_batch_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories:batchCreate/post response: mediaType: application/json openAPIDocKey: '200' @@ -2616,15 +2627,45 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_create + - $ref: >- + #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_batch_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/repositories/methods/projects_locations_connections_repositories_delete + repositories_git_refs: + id: google.cloudbuild.repositories_git_refs + name: repositories_git_refs + title: Repositories_git_refs + methods: + projects_locations_connections_repositories_fetch_git_refs: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1repositories~1{repositoriesId}:fetchGitRefs/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repositories_git_refs/methods/projects_locations_connections_repositories_fetch_git_refs + insert: [] + update: [] + replace: [] + delete: [] connections: id: google.cloudbuild.connections name: connections title: Connections methods: + projects_locations_connections_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_connections_patch: operation: $ref: >- @@ -2639,38 +2680,28 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_get: + projects_locations_connections_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_process_webhook: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_connections_create: + objectKey: $.connections + projects_locations_connections_process_webhook: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:processWebhook/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_connections_list: - operation: &ref_3 - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: >- @@ -2683,21 +2714,35 @@ components: update: - $ref: >- #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - connections_iam_policies: - id: google.cloudbuild.connections_iam_policies - name: connections_iam_policies - title: Connections_iam_policies + connections_linkable_repositories: + id: google.cloudbuild.connections_linkable_repositories + name: connections_linkable_repositories + title: Connections_linkable_repositories methods: - projects_locations_connections_set_iam_policy: + projects_locations_connections_fetch_linkable_repositories: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:fetchLinkableRepositories/get response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections_linkable_repositories/methods/projects_locations_connections_fetch_linkable_repositories + insert: [] + update: [] + replace: [] + delete: [] + connections_iam_policies: + id: google.cloudbuild.connections_iam_policies + name: connections_iam_policies + title: Connections_iam_policies + methods: projects_locations_connections_test_iam_permissions: operation: $ref: >- @@ -2705,56 +2750,43 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_connections_get_iam_policy: - operation: &ref_5 + projects_locations_connections_get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_connections_get_iam_policy: - operation: *ref_5 - response: *ref_6 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_get_iam_policy - insert: [] - update: [] - delete: [] - connections_linkable_repositories: - id: google.cloudbuild.connections_linkable_repositories - name: connections_linkable_repositories - title: Connections_linkable_repositories - methods: - projects_locations_connections_fetch_linkable_repositories: + projects_locations_connections_set_iam_policy: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:fetchLinkableRepositories/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/connections_iam_policies/methods/projects_locations_connections_set_iam_policy delete: [] locations: id: google.cloudbuild.locations name: locations title: Locations methods: - _projects_locations_list: - operation: &ref_7 + projects_locations_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_7 - response: *ref_8 projects_locations_get: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2769,21 +2801,58 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] paths: - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: &ref_9 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: &ref_1 + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: cloudbuild.projects.locations.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2829,14 +2898,16 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: cloudbuild.projects.locations.operations.get + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: + parameters: *ref_1 + post: + description: Fetches read token of a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FetchReadTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2848,7 +2919,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchReadTokenResponse' parameters: - in: path name: projectsId @@ -2861,15 +2932,20 @@ paths: schema: type: string - in: path - name: operationsId + name: connectionsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: - parameters: *ref_9 - get: - description: Fetch the list of branches or tags for a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs + - in: path + name: repositoriesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: + parameters: *ref_1 + delete: + description: Deletes a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2881,7 +2957,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchGitRefsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -2904,29 +2980,16 @@ paths: schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: refType - schema: - type: string - - in: query - name: pageSize + name: validateOnly schema: - type: integer - format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: - parameters: *ref_9 - post: - description: Fetches read/write token of a given repository. - operationId: >- - cloudbuild.projects.locations.connections.repositories.accessReadWriteToken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FetchReadWriteTokenRequest' + type: boolean + - in: query + name: etag + schema: + type: string + get: + description: Gets details of a single repository. + operationId: cloudbuild.projects.locations.connections.repositories.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2938,7 +3001,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadWriteTokenResponse' + $ref: '#/components/schemas/Repository' parameters: - in: path name: projectsId @@ -2960,16 +3023,16 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadToken: - parameters: *ref_9 + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: + parameters: *ref_1 post: - description: Fetches read token of a given repository. - operationId: cloudbuild.projects.locations.connections.repositories.accessReadToken + description: Creates a Repository. + operationId: cloudbuild.projects.locations.connections.repositories.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenRequest' + $ref: '#/components/schemas/Repository' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2981,7 +3044,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FetchReadTokenResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -2998,13 +3061,10 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true + - in: query + name: repositoryId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories: - parameters: *ref_9 get: description: Lists Repositories in a given connection. operationId: cloudbuild.projects.locations.connections.repositories.list @@ -3049,14 +3109,17 @@ paths: schema: type: integer format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:accessReadWriteToken: + parameters: *ref_1 post: - description: Creates a Repository. - operationId: cloudbuild.projects.locations.connections.repositories.create + description: Fetches read/write token of a given repository. + operationId: >- + cloudbuild.projects.locations.connections.repositories.accessReadWriteToken requestBody: content: application/json: schema: - $ref: '#/components/schemas/Repository' + $ref: '#/components/schemas/FetchReadWriteTokenRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3068,7 +3131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchReadWriteTokenResponse' parameters: - in: path name: projectsId @@ -3085,20 +3148,16 @@ paths: required: true schema: type: string - - in: query - name: repositoryId + - in: path + name: repositoriesId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: - parameters: *ref_9 - post: - description: Creates multiple repositories inside a connection. - operationId: cloudbuild.projects.locations.connections.repositories.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateRepositoriesRequest' + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}:fetchGitRefs: + parameters: *ref_1 + get: + description: Fetch the list of branches or tags for a given repository. + operationId: cloudbuild.projects.locations.connections.repositories.fetchGitRefs security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3110,7 +3169,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/FetchGitRefsResponse' parameters: - in: path name: projectsId @@ -3127,11 +3186,34 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories/{repositoriesId}: - parameters: *ref_9 - delete: - description: Deletes a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.delete + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: refType + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/repositories:batchCreate: + parameters: *ref_1 + post: + description: Creates multiple repositories inside a connection. + operationId: cloudbuild.projects.locations.connections.repositories.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateRepositoriesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3160,22 +3242,11 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - - in: query - name: etag - schema: - type: string - - in: query - name: validateOnly - schema: - type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + parameters: *ref_1 get: - description: Gets details of a single repository. - operationId: cloudbuild.projects.locations.connections.repositories.get + description: Gets details of a single connection. + operationId: cloudbuild.projects.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3187,7 +3258,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Repository' + $ref: '#/components/schemas/Connection' parameters: - in: path name: projectsId @@ -3204,13 +3275,6 @@ paths: required: true schema: type: string - - in: path - name: repositoriesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_9 patch: description: Updates a single connection. operationId: cloudbuild.projects.locations.connections.patch @@ -3248,18 +3312,18 @@ paths: schema: type: string - in: query - name: updateMask + name: etag schema: type: string - format: google-fieldmask - in: query name: allowMissing schema: type: boolean - in: query - name: etag + name: updateMask schema: type: string + format: google-fieldmask delete: description: Deletes a single connection. operationId: cloudbuild.projects.locations.connections.delete @@ -3291,63 +3355,36 @@ paths: required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - in: query name: etag schema: type: string - get: - description: Gets details of a single connection. - operationId: cloudbuild.projects.locations.connections.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: connectionsId - required: true + - in: query + name: validateOnly schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: - parameters: *ref_9 + type: boolean + /v2/projects/{projectsId}/locations/{locationsId}/connections: + parameters: *ref_1 post: - description: ProcessWebhook is called by the external SCM for notifying of events. - operationId: cloudbuild.projects.locations.connections.processWebhook + description: Creates a Connection. + operationId: cloudbuild.projects.locations.connections.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/HttpBody' - security: [] + $ref: '#/components/schemas/Connection' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -3360,22 +3397,12 @@ paths: schema: type: string - in: query - name: webhookKey + name: connectionId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: - parameters: *ref_9 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: cloudbuild.projects.locations.connections.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + get: + description: Lists Connections in a given project and location. + operationId: cloudbuild.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3387,7 +3414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListConnectionsResponse' parameters: - in: path name: projectsId @@ -3399,13 +3426,17 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableRepositories: - parameters: *ref_9 + parameters: *ref_1 get: description: >- FetchLinkableRepositories get repositories from SCM that are accessible @@ -3449,7 +3480,7 @@ paths: type: integer format: int32 /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3491,28 +3522,24 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_9 + /v2/projects/{projectsId}/locations/{locationsId}/connections:processWebhook: + parameters: *ref_1 post: - description: Creates a Connection. - operationId: cloudbuild.projects.locations.connections.create + description: ProcessWebhook is called by the external SCM for notifying of events. + operationId: cloudbuild.projects.locations.connections.processWebhook requestBody: content: application/json: schema: - $ref: '#/components/schemas/Connection' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform + $ref: '#/components/schemas/HttpBody' + security: [] responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -3525,12 +3552,16 @@ paths: schema: type: string - in: query - name: connectionId + name: webhookKey schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: + parameters: *ref_1 get: - description: Lists Connections in a given project and location. - operationId: cloudbuild.projects.locations.connections.list + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: cloudbuild.projects.locations.connections.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3542,7 +3573,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -3554,22 +3585,29 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: connectionsId + required: true schema: type: string - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy: - parameters: *ref_9 - get: + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy: + parameters: *ref_1 + post: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: cloudbuild.projects.locations.connections.getIamPolicy + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: cloudbuild.projects.locations.connections.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3598,13 +3636,8 @@ paths: required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 /v2/projects/{projectsId}/locations: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: cloudbuild.projects.locations.list @@ -3640,7 +3673,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: cloudbuild.projects.locations.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml index 5ee66dee..8015539d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcommerceprocurement.yaml @@ -7,8 +7,8 @@ info: title: Cloud Commerce Partner Procurement API description: Partner API for the Cloud Commerce Procurement Service. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/marketplace/docs/partners/ servers: @@ -34,290 +34,222 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - RejectAccountRequest: - type: object - properties: - reason: - description: >- - Free form text string explaining the rejection reason. Max allowed - length: 256 bytes. Longer strings will be truncated. - type: string - approvalName: - type: string - description: >- - The name of the approval being rejected. If absent and there is only - one approval possible, that approval will be rejected. If absent and - there are many approvals possible, the request will fail with a 400 - Bad Request. Optional. - description: Request message for PartnerProcurementService.RejectAccount. - id: RejectAccountRequest - ApproveAccountRequest: - id: ApproveAccountRequest - type: object - properties: - approvalName: - type: string - description: >- - The name of the approval being approved. If absent and there is only - one approval possible, that approval will be granted. If absent and - there are many approvals possible, the request will fail with a 400 - Bad Request. Optional. - reason: - type: string - description: >- - Free form text string explaining the approval reason. Optional. Max - allowed length: 256 bytes. Longer strings will be truncated. - properties: - description: >- - Set of properties that should be associated with the account. - Optional. - additionalProperties: - type: string - type: object - description: Request message for PartnerProcurementService.ApproveAccount. - ApproveEntitlementPlanChangeRequest: - description: >- - Request message for - [PartnerProcurementService.ApproveEntitlementPlanChange[]. - id: ApproveEntitlementPlanChangeRequest - properties: - pendingPlanName: - description: Required. Name of the pending plan that is being approved. - type: string - type: object ResetAccountRequest: description: Request message for PartnerProcurementService.ResetAccount. properties: {} id: ResetAccountRequest type: object - SuspendEntitlementRequest: - description: >- - Request message for ParterProcurementService.SuspendEntitlement. This is - not yet supported. + Approval: type: object - properties: - reason: - description: >- - A free-form reason string, explaining the reason for suspension - request. - type: string - id: SuspendEntitlementRequest - Entitlement: + description: An approval for some action on an account. + id: Approval properties: state: type: string enumDescriptions: + - Sentinel value; do not use. - >- - Default state of the entitlement. It's only set to this value when - the entitlement is first created and has not been initialized. - - >- - Indicates that the entitlement is being created and the backend - has sent a notification to the provider for the activation - approval. If the provider approves, then the entitlement will - transition to the EntitlementState.ENTITLEMENT_ACTIVE state. - Otherwise, the entitlement will be removed. Plan changes are not - allowed in this state. Instead the entitlement is cancelled and - re-created with a new plan name. - - >- - Indicates that the entitlement is active. The procured item is now - usable and any associated billing events will start occurring. - Entitlements in this state WILL renew. The analogous state for an - unexpired but non-renewing entitlement is - ENTITLEMENT_PENDING_CANCELLATION. In this state, the customer can - decide to cancel the entitlement, which would change the state to - EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then - EntitlementState.ENTITLEMENT_CANCELLED. The user can also request - a change of plan, which will transition the state to - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to - EntitlementState.ENTITLEMENT_ACTIVE. - - >- - Indicates that the entitlement will expire at the end of its term. - This could mean the customer has elected not to renew this - entitlement or the customer elected to cancel an entitlement that - only expires at term end. The entitlement typically stays in this - state if the entitlement/plan allows use of the underlying - resource until the end of the current billing cycle. Once the - billing cycle completes, the resource will transition to - EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot - be modified during this state. - - >- - Indicates that the entitlement was cancelled. The entitlement can - now be deleted. - - >- - Indicates that the entitlement is currently active, but there is a - pending plan change that is requested by the customer. The - entitlement typically stays in this state, if the entitlement/plan - requires the completion of the current billing cycle before the - plan can be changed. Once the billing cycle completes, the - resource will transition to EntitlementState.ENTITLEMENT_ACTIVE, - with its plan changed. - - >- - Indicates that the entitlement is currently active, but there is a - plan change request pending provider approval. If the provider - approves the plan change, then the entitlement will transition - either to EntitlementState.ENTITLEMENT_ACTIVE or - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE depending on - whether current plan requires that the billing cycle completes. If - the provider rejects the plan change, then the pending plan change - request is removed and the entitlement stays in - EntitlementState.ENTITLEMENT_ACTIVE state with the old plan. + The approval is pending response from the provider. The approval + state can transition to Account.Approval.State.APPROVED or + Account.Approval.State.REJECTED. + - The approval has been granted by the provider. - >- - Indicates that the entitlement is suspended either by Google or - provider request. This can be triggered for various external - reasons (e.g. expiration of credit card on the billing account, - violation of terms-of-service of the provider etc.). As such, any - remediating action needs to be taken externally, before the - entitlement can be activated. This is not yet supported. - description: Output only. The state of the entitlement. + The approval has been rejected by the provider. A provider may + choose to approve a previously rejected approval, so is it + possible to transition to Account.Approval.State.APPROVED. + description: Output only. The state of the approval. enum: - - ENTITLEMENT_STATE_UNSPECIFIED - - ENTITLEMENT_ACTIVATION_REQUESTED - - ENTITLEMENT_ACTIVE - - ENTITLEMENT_PENDING_CANCELLATION - - ENTITLEMENT_CANCELLED - - ENTITLEMENT_PENDING_PLAN_CHANGE - - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL - - ENTITLEMENT_SUSPENDED - newPendingPlan: - description: >- - Output only. The identifier of the pending new plan. Required if the - product has plans and the entitlement has a pending plan change. + - STATE_UNSPECIFIED + - PENDING + - APPROVED + - REJECTED + name: type: string - cancellationReason: - readOnly: true - description: >- - Output only. The reason the entitlement was cancelled. If this - entitlement was not cancelled, this field will be empty. Possible - values include "unknown", "expired", "user-cancelled", - "account-closed", "billing-disabled" (if the customer has manually - disabled billing to their resources), "user-aborted", and "migrated" - (if the entitlement has migrated across products). + description: Output only. The name of the approval. + updateTime: + description: Optional. The last update timestamp of the approval. type: string - productExternalName: - description: Output only. The identifier of the product that was procured. + format: google-datetime + reason: type: string - readOnly: true - usageReportingId: + description: Output only. An explanation for the state of the approval. + SuspendEntitlementRequest: + properties: + reason: type: string description: >- - Output only. The consumerId to use when reporting usage through the - Service Control API. See the consumerId field at [Reporting - Metrics](https://cloud.google.com/service-control/reporting-metrics) - for more details. This field is present only if the product has - usage-based billing configured. - entitlementBenefitIds: - readOnly: true + A free-form reason string, explaining the reason for suspension + request. + description: >- + Request message for ParterProcurementService.SuspendEntitlement. This is + not yet supported. + type: object + id: SuspendEntitlementRequest + ListAccountsResponse: + properties: + nextPageToken: + type: string + description: The token for fetching the next page. + accounts: + description: The list of accounts in this response. items: - type: string - description: >- - Output only. The entitlement benefit IDs associated with the - purchase. + $ref: '#/components/schemas/Account' type: array - createTime: - description: Output only. The creation timestamp. + id: ListAccountsResponse + description: Response message for [PartnerProcurementService.ListAccounts[]. + type: object + Account: + id: Account + description: >- + Represents an account that was established by the customer on the + service provider's system. + type: object + properties: + name: type: string + description: >- + Output only. The resource name of the account. Account names have + the form `accounts/{account_id}`. + updateTime: + description: Output only. The last update timestamp. format: google-datetime - account: type: string + inputProperties: description: >- - Output only. The resource name of the account that this entitlement - is based on, if any. - orderId: + Output only. The custom properties that were collected from the user + to create this account. + type: object + deprecated: true + additionalProperties: + type: any + description: Properties of the object. + state: + enumDescriptions: + - >- + Default state of the account. It's only set to this value when the + account is first created and has not been initialized. + - >- + The customer has requested the creation of the account resource, + and the provider notification message is dispatched. This state + has been deprecated, as accounts now immediately transition to + AccountState.ACCOUNT_ACTIVE. + - >- + The account is active and ready for use. The next possible states + are: - Account getting deleted: After the user invokes delete from + another API. + enum: + - ACCOUNT_STATE_UNSPECIFIED + - ACCOUNT_ACTIVATION_REQUESTED + - ACCOUNT_ACTIVE description: >- - Output only. The order ID of this entitlement, without any `orders/` - resource name prefix. - readOnly: true + Output only. The state of the account. This is used to decide + whether the customer is in good standing with the provider and is + able to make purchases. An account might not be able to make a + purchase if the billing account is suspended, for example. type: string - plan: + createTime: type: string - description: >- - Output only. The identifier of the plan that was procured. Required - if the product has plans. - updateTime: format: google-datetime - description: Output only. The last update timestamp. - type: string + description: Output only. The creation timestamp. provider: type: string description: >- Output only. The identifier of the service provider that this - entitlement was created against. Each service provider is assigned a + account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. - newPendingOfferDuration: - readOnly: true + approvals: + items: + $ref: '#/components/schemas/Approval' + type: array description: >- - Output only. The offer duration of the new offer in ISO 8601 - duration format. This field is not populated for entitlements which - are not active yet, only for pending offer changes. If the offer was - created with a specified end date instead of a duration, this field - is empty. + Output only. The approvals for this account. These approvals are + used to track actions that are permitted or have been completed by a + customer within the context of the provider. This might include a + sign up flow or a provisioning step, for example, that the provider + can admit to having happened. + Consumer: + type: object + id: Consumer + properties: + project: type: string - offerDuration: - readOnly: true + description: A project name with format `projects/`. + description: A resource using (consuming) this entitlement. + ApproveEntitlementRequest: + description: Request message for [PartnerProcurementService.ApproveEntitlement[]. + properties: + entitlementMigrated: type: string description: >- - Output only. The offer duration of the current offer in ISO 8601 - duration format. Field is empty if entitlement was not made using an - offer. If the offer was created with a specified end date instead of - a duration, this field is empty. - name: + Optional. The resource name of the entitlement that was migrated, + with the format + `providers/{provider_id}/entitlements/{entitlement_id}`. Should only + be sent when resources have been migrated from entitlement_migrated + to the new entitlement. Optional. + properties: + type: object description: >- - Output only. The resource name of the entitlement. Entitlement names - have the form - `providers/{provider_id}/entitlements/{entitlement_id}`. - type: string - product: + Set of properties that should be associated with the entitlement. + Optional. + additionalProperties: + type: string deprecated: true + type: object + id: ApproveEntitlementRequest + Entitlement: + description: Represents a procured product of a customer. + properties: + provider: description: >- - Output only. The identifier of the entity that was purchased. This - may actually represent a product, quote, or offer. We strongly - recommend that you use the following more explicit fields: - productExternalName, quoteExternalName, or offer. + Output only. The identifier of the service provider that this + entitlement was created against. Each service provider is assigned a + unique provider value when they onboard with Cloud Commerce + platform. type: string - consumers: - items: - $ref: '#/components/schemas/Consumer' - type: array - description: Output only. The resources using this entitlement, if applicable. - newOfferEndTime: + offer: description: >- - Output only. The end time of the new offer. If the offer was created - with a term instead of a specified end date, this field is empty. - This field will be populated even if the entitlement is not active - yet. If there is no upcoming offer, the field will be empty. - format: google-datetime - readOnly: true + Output only. The name of the offer that was procured. Field is empty + if order was not made using an offer. Format: + 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR + 'projects/{project}/services/{service}/standardOffers/{offer-id}', + depending on whether the offer is private or public. The {service} + in the name is the listing service of the offer. It could be either + the product service that the offer is referencing, or a generic + private offer parent service. We recommend that you don't build your + integration to rely on the meaning of this {service} part. type: string - offerEndTime: readOnly: true - format: google-datetime - description: >- - Output only. End time for the Offer association corresponding to - this entitlement. The field is only populated if the entitlement is - currently associated with an Offer. - type: string - subscriptionEndTime: + orderId: description: >- - Output only. End time for the subscription corresponding to this - entitlement. - format: google-datetime + Output only. The order ID of this entitlement, without any `orders/` + resource name prefix. readOnly: true type: string inputProperties: - type: object deprecated: true + description: >- + Output only. The custom properties that were collected from the user + to create this entitlement. additionalProperties: type: any description: Properties of the object. + type: object + subscriptionEndTime: description: >- - Output only. The custom properties that were collected from the user - to create this entitlement. - offer: + Output only. End time for the subscription corresponding to this + entitlement. + format: google-datetime + type: string + readOnly: true + newPendingOffer: readOnly: true + type: string description: >- - Output only. The name of the offer that was procured. Field is empty - if order was not made using an offer. Format: + Output only. The name of the offer the entitlement is switching to + upon a pending plan change. Only exists if the pending plan change + is moving to an offer. This field isn't populated for entitlements + which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public. The {service} @@ -325,9 +257,15 @@ components: the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. + product: + deprecated: true type: string + description: >- + Output only. The identifier of the entity that was purchased. This + may actually represent a product, quote, or offer. We strongly + recommend that you use the following more explicit fields: + productExternalName, quoteExternalName, or offer. messageToUser: - type: string description: >- Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for @@ -336,160 +274,257 @@ components: EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes. - newOfferStartTime: + type: string + offerDuration: + description: >- + Output only. The offer duration of the current offer in ISO 8601 + duration format. Field is empty if entitlement was not made using an + offer. If the offer was created with a specified end date instead of + a duration, this field is empty. + readOnly: true + type: string + createTime: + type: string format: google-datetime + description: Output only. The creation timestamp. + offerEndTime: + readOnly: true + format: google-datetime + type: string + description: >- + Output only. End time for the Offer association corresponding to + this entitlement. The field is only populated if the entitlement is + currently associated with an Offer. + consumers: + type: array + items: + $ref: '#/components/schemas/Consumer' + description: Output only. The resources using this entitlement, if applicable. + plan: + description: >- + Output only. The identifier of the plan that was procured. Required + if the product has plans. + type: string + entitlementBenefitIds: + description: >- + Output only. The entitlement benefit IDs associated with the + purchase. + readOnly: true + items: + type: string + type: array + account: + type: string + description: >- + Output only. The resource name of the account that this entitlement + is based on, if any. + usageReportingId: + type: string + description: >- + Output only. The consumerId to use when reporting usage through the + Service Control API. See the consumerId field at [Reporting + Metrics](https://cloud.google.com/service-control/reporting-metrics) + for more details. This field is present only if the product has + usage-based billing configured. + cancellationReason: type: string - readOnly: true description: >- - Output only. The timestamp when the new offer will become effective. - This field will be populated even if the entitlement is not active - yet. If there is no upcoming offer, the field will be empty. - quoteExternalName: + Output only. The reason the entitlement was cancelled. If this + entitlement wasn't cancelled, this field is empty. Possible values + include "unknown", "expired", "user-cancelled", "account-closed", + "billing-disabled" (if the customer has manually disabled billing to + their resources), "user-aborted", and "migrated" (if the entitlement + has migrated across products). Values of this field are subject to + change, and we recommend that you don't build your technical + integration to rely on these fields. readOnly: true + newOfferEndTime: + format: google-datetime type: string description: >- - Output only. The identifier of the quote that was used to procure. - Empty if the order is not purchased using a quote. - newPendingOffer: + Output only. The end time of the new offer. If the offer was created + with a term instead of a specified end date, this field is empty. + This field is populated even if the entitlement isn't active yet. If + there's no upcoming offer, the field is be empty. readOnly: true - description: >- - Output only. The name of the offer the entitlement is switching to - upon a pending plan change. Only exists if the pending plan change - is moving to an offer. This field is not populated for entitlements - which are not active yet. Format: - 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR - 'projects/{project}/services/{service}/standardOffers/{offer-id}', - depending on whether the offer is private or public. The {service} - in the name is the listing service of the offer. It could be either - the product service that the offer is referencing, or a generic - private offer parent service. We recommend that you don't build your - integration to rely on the meaning of this {service} part. - type: string - description: Represents a procured product of a customer. - type: object - id: Entitlement - Approval: - type: object - id: Approval - properties: - name: - type: string - description: Output only. The name of the approval. - reason: - type: string - description: Output only. An explanation for the state of the approval. - updateTime: - description: Optional. The last update timestamp of the approval. - format: google-datetime + productExternalName: type: string + readOnly: true + description: Output only. The identifier of the product that was procured. state: - type: string - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - description: Output only. The state of the approval. + description: Output only. The state of the entitlement. enumDescriptions: - - Sentinel value; do not use. - >- - The approval is pending response from the provider. The approval - state can transition to Account.Approval.State.APPROVED or - Account.Approval.State.REJECTED. - - The approval has been granted by the provider. + Default state of the entitlement. It's only set to this value when + the entitlement is first created and has not been initialized. - >- - The approval has been rejected by the provider. A provider may - choose to approve a previously rejected approval, so is it - possible to transition to Account.Approval.State.APPROVED. - description: An approval for some action on an account. - Account: - description: >- - Represents an account that was established by the customer on the - service provider's system. - type: object - id: Account - properties: - createTime: - description: Output only. The creation timestamp. + Indicates that the entitlement is being created and the backend + has sent a notification to the provider for the activation + approval. If the provider approves, then the entitlement will + transition to the EntitlementState.ENTITLEMENT_ACTIVE state. + Otherwise, the entitlement will be removed. Plan changes are not + allowed in this state. Instead the entitlement is cancelled and + re-created with a new plan name. + - >- + Indicates that the entitlement is active. The procured item is now + usable and any associated billing events will start occurring. + Entitlements in this state WILL renew. The analogous state for an + unexpired but non-renewing entitlement is + ENTITLEMENT_PENDING_CANCELLATION. In this state, the customer can + decide to cancel the entitlement, which would change the state to + EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then + EntitlementState.ENTITLEMENT_CANCELLED. The user can also request + a change of plan, which will transition the state to + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to + EntitlementState.ENTITLEMENT_ACTIVE. + - >- + Indicates that the entitlement will expire at the end of its term. + This could mean the customer has elected not to renew this + entitlement or the customer elected to cancel an entitlement that + only expires at term end. The entitlement typically stays in this + state if the entitlement/plan allows use of the underlying + resource until the end of the current billing cycle. Once the + billing cycle completes, the resource will transition to + EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot + be modified during this state. + - >- + Indicates that the entitlement was cancelled. The entitlement can + now be deleted. + - >- + Indicates that the entitlement is currently active, but there is a + pending plan change that is requested by the customer. The + entitlement typically stays in this state, if the entitlement/plan + requires the completion of the current billing cycle before the + plan can be changed. Once the billing cycle completes, the + resource will transition to EntitlementState.ENTITLEMENT_ACTIVE, + with its plan changed. + - >- + Indicates that the entitlement is currently active, but there is a + plan change request pending provider approval. If the provider + approves the plan change, then the entitlement will transition + either to EntitlementState.ENTITLEMENT_ACTIVE or + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE depending on + whether current plan requires that the billing cycle completes. If + the provider rejects the plan change, then the pending plan change + request is removed and the entitlement stays in + EntitlementState.ENTITLEMENT_ACTIVE state with the old plan. + - >- + Indicates that the entitlement is suspended either by Google or + provider request. This can be triggered for various external + reasons (e.g. expiration of credit card on the billing account, + violation of terms-of-service of the provider etc.). As such, any + remediating action needs to be taken externally, before the + entitlement can be activated. This is not yet supported. type: string - format: google-datetime - inputProperties: - additionalProperties: - description: Properties of the object. - type: any + enum: + - ENTITLEMENT_STATE_UNSPECIFIED + - ENTITLEMENT_ACTIVATION_REQUESTED + - ENTITLEMENT_ACTIVE + - ENTITLEMENT_PENDING_CANCELLATION + - ENTITLEMENT_CANCELLED + - ENTITLEMENT_PENDING_PLAN_CHANGE + - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL + - ENTITLEMENT_SUSPENDED + newPendingOfferDuration: + type: string + readOnly: true description: >- - Output only. The custom properties that were collected from the user - to create this account. - type: object - deprecated: true - approvals: + Output only. The duration of the new offer, in ISO 8601 duration + format. This field isn't populated for entitlements which aren't + active yet, only for pending offer changes. If the offer was created + with a specified end date instead of a duration, this field is + empty. + quoteExternalName: description: >- - Output only. The approvals for this account. These approvals are - used to track actions that are permitted or have been completed by a - customer within the context of the provider. This might include a - sign up flow or a provisioning step, for example, that the provider - can admit to having happened. - type: array - items: - $ref: '#/components/schemas/Approval' - provider: + Output only. The identifier of the quote that was used to procure. + Empty if the order is not purchased using a quote. + readOnly: true type: string + newOfferStartTime: + readOnly: true description: >- - Output only. The identifier of the service provider that this - account was created against. Each service provider is assigned a - unique provider value when they onboard with Cloud Commerce - platform. - state: - enumDescriptions: - - >- - Default state of the account. It's only set to this value when the - account is first created and has not been initialized. - - >- - The customer has requested the creation of the account resource, - and the provider notification message is dispatched. This state - has been deprecated, as accounts now immediately transition to - AccountState.ACCOUNT_ACTIVE. - - >- - The account is active and ready for use. The next possible states - are: - Account getting deleted: After the user invokes delete from - another API. + Output only. The timestamp when the new offer becomes effective. + This field is populated even if the entitlement isn't active yet. If + there's no upcoming offer, the field is empty. type: string - description: >- - Output only. The state of the account. This is used to decide - whether the customer is in good standing with the provider and is - able to make purchases. An account might not be able to make a - purchase if the billing account is suspended, for example. - enum: - - ACCOUNT_STATE_UNSPECIFIED - - ACCOUNT_ACTIVATION_REQUESTED - - ACCOUNT_ACTIVE + format: google-datetime name: + description: >- + Output only. The resource name of the entitlement. Entitlement names + have the form + `providers/{provider_id}/entitlements/{entitlement_id}`. type: string + newPendingPlan: description: >- - Output only. The resource name of the account. Account names have - the form `accounts/{account_id}`. + Output only. The identifier of the pending new plan. Required if the + product has plans and the entitlement has a pending plan change. + type: string updateTime: description: Output only. The last update timestamp. format: google-datetime type: string + type: object + id: Entitlement + Empty: + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + properties: {} + id: Empty + type: object RejectEntitlementPlanChangeRequest: + id: RejectEntitlementPlanChangeRequest + type: object properties: + pendingPlanName: + description: Required. Name of the pending plan that is being rejected. + type: string reason: + type: string description: >- Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. - type: string - pendingPlanName: - type: string - description: Required. Name of the pending plan that is being rejected. - type: object description: >- Request message for PartnerProcurementService.RejectEntitlementPlanChange. - id: RejectEntitlementPlanChangeRequest + RejectEntitlementRequest: + properties: + reason: + type: string + description: >- + Free form text string explaining the rejection reason. Max allowed + length: 256 bytes. Longer strings will be truncated. + description: Request message for PartnerProcurementService.RejectEntitlement. + type: object + id: RejectEntitlementRequest + ApproveAccountRequest: + type: object + description: Request message for PartnerProcurementService.ApproveAccount. + properties: + properties: + additionalProperties: + type: string + description: >- + Set of properties that should be associated with the account. + Optional. + type: object + approvalName: + description: >- + The name of the approval being approved. If absent and there is only + one approval possible, that approval will be granted. If absent and + there are many approvals possible, the request will fail with a 400 + Bad Request. Optional. + type: string + reason: + type: string + description: >- + Free form text string explaining the approval reason. Optional. Max + allowed length: 256 bytes. Longer strings will be truncated. + id: ApproveAccountRequest ListEntitlementsResponse: type: object - description: Response message for PartnerProcurementService.ListEntitlements. properties: nextPageToken: description: The token for fetching the next page. @@ -500,81 +535,51 @@ components: $ref: '#/components/schemas/Entitlement' description: The list of entitlements in this response. id: ListEntitlementsResponse - RejectEntitlementRequest: + description: Response message for PartnerProcurementService.ListEntitlements. + RejectAccountRequest: + description: Request message for PartnerProcurementService.RejectAccount. type: object - description: Request message for PartnerProcurementService.RejectEntitlement. - id: RejectEntitlementRequest + id: RejectAccountRequest properties: reason: + type: string description: >- Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated. + approvalName: type: string - Empty: - type: object - id: Empty - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - Consumer: - description: A resource using (consuming) this entitlement. - type: object - id: Consumer - properties: - project: - description: A project name with format `projects/`. - type: string - ListAccountsResponse: - id: ListAccountsResponse - description: Response message for [PartnerProcurementService.ListAccounts[]. - type: object + description: >- + The name of the approval being rejected. If absent and there is only + one approval possible, that approval will be rejected. If absent and + there are many approvals possible, the request will fail with a 400 + Bad Request. Optional. + ApproveEntitlementPlanChangeRequest: properties: - accounts: - type: array - items: - $ref: '#/components/schemas/Account' - description: The list of accounts in this response. - nextPageToken: + pendingPlanName: type: string - description: The token for fetching the next page. - ApproveEntitlementRequest: + description: Required. Name of the pending plan that's being approved. type: object - id: ApproveEntitlementRequest - properties: - entitlementMigrated: - type: string - description: >- - Optional. The resource name of the entitlement that was migrated, - with the format - `providers/{provider_id}/entitlements/{entitlement_id}`. Should only - be sent when resources have been migrated from entitlement_migrated - to the new entitlement. Optional. - properties: - deprecated: true - additionalProperties: - type: string - type: object - description: >- - Set of properties that should be associated with the entitlement. - Optional. - description: Request message for [PartnerProcurementService.ApproveEntitlement[]. + description: >- + Request message for + [PartnerProcurementService.ApproveEntitlementPlanChange[]. + id: ApproveEntitlementPlanChangeRequest parameters: - _.xgafv: - description: V1 error format. + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token schema: type: string - enum: - - '1' - - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string key: @@ -586,22 +591,25 @@ components: name: key schema: type: string - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: type: string - access_token: - description: OAuth access token. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: access_token + name: quotaUser schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string alt: @@ -614,10 +622,10 @@ components: - json - media - proto - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string prettyPrint: @@ -626,87 +634,60 @@ components: name: prettyPrint schema: type: boolean - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. + _.xgafv: + description: V1 error format. in: query - name: fields + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - accounts: - id: google.cloudcommerceprocurement.accounts - name: accounts - title: Accounts + entitlements: + id: google.cloudcommerceprocurement.entitlements + name: entitlements + title: Entitlements methods: - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.accounts - list: - operation: *ref_1 - response: *ref_2 - approve: + reject: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:approve/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post response: mediaType: application/json openAPIDocKey: '200' - reset: + get: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reset/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get response: mediaType: application/json openAPIDocKey: '200' - reject: + patch: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reject/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/patch response: mediaType: application/json openAPIDocKey: '200' - get: + list: operation: - $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' + $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/accounts/methods/get' - - $ref: '#/components/x-stackQL-resources/accounts/methods/list' - insert: [] - update: [] - delete: [] - entitlements: - id: google.cloudcommerceprocurement.entitlements - name: entitlements - title: Entitlements - methods: - approve_plan_change: + objectKey: $.entitlements + reject_plan_change: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:rejectPlanChange/post response: mediaType: application/json openAPIDocKey: '200' - reject_plan_change: + approve: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:rejectPlanChange/post + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post response: mediaType: application/json openAPIDocKey: '200' @@ -717,69 +698,95 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: + approve_plan_change: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/patch + #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approvePlanChange/post response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/get' + - $ref: '#/components/x-stackQL-resources/entitlements/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/patch' + replace: [] + delete: [] + accounts: + id: google.cloudcommerceprocurement.accounts + name: accounts + title: Accounts + methods: + reject: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}/get + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reject/post response: mediaType: application/json openAPIDocKey: '200' - reject: + list: operation: - $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:reject/post + $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts/get' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 - $ref: '#/paths/~1v1~1providers~1{providersId}~1entitlements/get' - response: &ref_4 + objectKey: $.accounts + approve: + operation: + $ref: >- + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:approve/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.entitlements - list: - operation: *ref_3 - response: *ref_4 - approve: + reset: operation: $ref: >- - #/paths/~1v1~1providers~1{providersId}~1entitlements~1{entitlementsId}:approve/post + #/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}:reset/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1providers~1{providersId}~1accounts~1{accountsId}/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/entitlements/methods/get' - - $ref: '#/components/x-stackQL-resources/entitlements/methods/list' + - $ref: '#/components/x-stackQL-resources/accounts/methods/get' + - $ref: '#/components/x-stackQL-resources/accounts/methods/list' insert: [] - update: - - $ref: '#/components/x-stackQL-resources/entitlements/methods/patch' + update: [] + replace: [] delete: [] paths: - /v1/providers/{providersId}/accounts: - parameters: &ref_5 - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' + /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - get: - description: Lists Accounts that the provider has access to. - operationId: cloudcommerceprocurement.providers.accounts.list + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' + post: + description: >- + Rejects an entitlement that is in the + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is + invoked by the provider to reject the creation of the entitlement + resource. + operationId: cloudcommerceprocurement.providers.entitlements.reject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -791,32 +798,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAccountsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: entitlementsId + required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:approve: - parameters: *ref_5 - post: - description: Grants an approval on an Account. - operationId: cloudcommerceprocurement.providers.accounts.approve - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApproveAccountRequest' + /v1/providers/{providersId}/entitlements/{entitlementsId}: + parameters: *ref_1 + get: + description: Gets a requested Entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -828,7 +826,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Entitlement' parameters: - in: path name: providersId @@ -836,22 +834,18 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:reset: - parameters: *ref_5 - post: - description: >- - Resets an Account and cancels all associated Entitlements. Partner can - only reset accounts they own rather than customer accounts. - operationId: cloudcommerceprocurement.providers.accounts.reset + patch: + description: Updates an existing Entitlement. + operationId: cloudcommerceprocurement.providers.entitlements.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResetAccountRequest' + $ref: '#/components/schemas/Entitlement' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -863,7 +857,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Entitlement' parameters: - in: path name: providersId @@ -871,20 +865,20 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId required: true schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}:reject: - parameters: *ref_5 - post: - description: Rejects an approval on an Account. - operationId: cloudcommerceprocurement.providers.accounts.reject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RejectAccountRequest' + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/providers/{providersId}/entitlements: + parameters: *ref_1 + get: + description: Lists Entitlements for which the provider has read access. + operationId: cloudcommerceprocurement.providers.entitlements.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -896,23 +890,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListEntitlementsResponse' parameters: - in: path name: providersId required: true schema: type: string - - in: path - name: accountsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/providers/{providersId}/accounts/{accountsId}: - parameters: *ref_5 - get: - description: Gets a requested Account resource. - operationId: cloudcommerceprocurement.providers.accounts.get + - in: query + name: pageToken + schema: + type: string + /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: + parameters: *ref_1 + post: + description: >- + Rejects an entitlement plan change that is in the + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This + method is invoked by the provider to reject the plan change on the + entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.rejectPlanChange + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -924,7 +935,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Account' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -932,24 +943,24 @@ paths: schema: type: string - in: path - name: accountsId + name: entitlementsId required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: - parameters: *ref_5 + /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: + parameters: *ref_1 post: description: >- - Approves an entitlement plan change that is in the - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This - method is invoked by the provider to approve the plan change on the - entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.approvePlanChange + Approves an entitlement that is in the + EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is + invoked by the provider to approve the creation of the entitlement + resource. + operationId: cloudcommerceprocurement.providers.entitlements.approve requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApproveEntitlementPlanChangeRequest' + $ref: '#/components/schemas/ApproveEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -973,20 +984,16 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:rejectPlanChange: - parameters: *ref_5 + /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: + parameters: *ref_1 post: - description: >- - Rejects an entitlement plan change that is in the - EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This - method is invoked by the provider to reject the plan change on the - entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.rejectPlanChange + description: Requests suspension of an active Entitlement. This is not yet supported. + operationId: cloudcommerceprocurement.providers.entitlements.suspend requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectEntitlementPlanChangeRequest' + $ref: '#/components/schemas/SuspendEntitlementRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1010,16 +1017,20 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:suspend: - parameters: *ref_5 + /v1/providers/{providersId}/entitlements/{entitlementsId}:approvePlanChange: + parameters: *ref_1 post: - description: Requests suspension of an active Entitlement. This is not yet supported. - operationId: cloudcommerceprocurement.providers.entitlements.suspend + description: >- + Approves an entitlement plan change that is in the + EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state. This + method is invoked by the provider to approve the plan change on the + entitlement resource. + operationId: cloudcommerceprocurement.providers.entitlements.approvePlanChange requestBody: content: application/json: schema: - $ref: '#/components/schemas/SuspendEntitlementRequest' + $ref: '#/components/schemas/ApproveEntitlementPlanChangeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1043,16 +1054,16 @@ paths: required: true schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}: - parameters: *ref_5 - patch: - description: Updates an existing Entitlement. - operationId: cloudcommerceprocurement.providers.entitlements.patch + /v1/providers/{providersId}/accounts/{accountsId}:reject: + parameters: *ref_1 + post: + description: Rejects an approval on an Account. + operationId: cloudcommerceprocurement.providers.accounts.reject requestBody: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/RejectAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1064,7 +1075,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId @@ -1072,18 +1083,15 @@ paths: schema: type: string - in: path - name: entitlementsId + name: accountsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/providers/{providersId}/accounts: + parameters: *ref_1 get: - description: Gets a requested Entitlement resource. - operationId: cloudcommerceprocurement.providers.entitlements.get + description: Lists Accounts that the provider has access to. + operationId: cloudcommerceprocurement.providers.accounts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1095,32 +1103,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Entitlement' + $ref: '#/components/schemas/ListAccountsResponse' parameters: - in: path name: providersId required: true schema: type: string - - in: path - name: entitlementsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/providers/{providersId}/entitlements/{entitlementsId}:reject: - parameters: *ref_5 + /v1/providers/{providersId}/accounts/{accountsId}:approve: + parameters: *ref_1 post: - description: >- - Rejects an entitlement that is in the - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to reject the creation of the entitlement - resource. - operationId: cloudcommerceprocurement.providers.entitlements.reject + description: Grants an approval on an Account. + operationId: cloudcommerceprocurement.providers.accounts.approve requestBody: content: application/json: schema: - $ref: '#/components/schemas/RejectEntitlementRequest' + $ref: '#/components/schemas/ApproveAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1140,15 +1148,22 @@ paths: schema: type: string - in: path - name: entitlementsId + name: accountsId required: true schema: type: string - /v1/providers/{providersId}/entitlements: - parameters: *ref_5 - get: - description: Lists Entitlements for which the provider has read access. - operationId: cloudcommerceprocurement.providers.entitlements.list + /v1/providers/{providersId}/accounts/{accountsId}:reset: + parameters: *ref_1 + post: + description: >- + Resets an Account and cancels all associated Entitlements. Partner can + only reset accounts they own rather than customer accounts. + operationId: cloudcommerceprocurement.providers.accounts.reset + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResetAccountRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1160,40 +1175,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListEntitlementsResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: providersId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: accountsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/providers/{providersId}/entitlements/{entitlementsId}:approve: - parameters: *ref_5 - post: - description: >- - Approves an entitlement that is in the - EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state. This method is - invoked by the provider to approve the creation of the entitlement - resource. - operationId: cloudcommerceprocurement.providers.entitlements.approve - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ApproveEntitlementRequest' + /v1/providers/{providersId}/accounts/{accountsId}: + parameters: *ref_1 + get: + description: Gets a requested Account resource. + operationId: cloudcommerceprocurement.providers.accounts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1205,7 +1203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Account' parameters: - in: path name: providersId @@ -1213,7 +1211,7 @@ paths: schema: type: string - in: path - name: entitlementsId + name: accountsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml index 5e1e44bf..d19c2700 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudcontrolspartner.yaml @@ -9,8 +9,8 @@ info: Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering. version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: >- https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest @@ -178,13 +178,15 @@ components: `organizations/{organization}/locations/{location}/customers/{customer}` type: string displayName: - description: The customer organization's display name. E.g. "google.com". + description: Required. Display name for the customer type: string customerOnboardingState: - description: Container for customer onboarding steps + description: Output only. Container for customer onboarding steps + readOnly: true $ref: '#/components/schemas/CustomerOnboardingState' isOnboarded: - description: Indicates whether a customer is fully onboarded + description: Output only. Indicates whether a customer is fully onboarded + readOnly: true type: boolean CustomerOnboardingState: id: CustomerOnboardingState @@ -334,12 +336,16 @@ components: - Permission for Assured Workloads monitoring violations - Permission for Access Approval requests - Permission for External Key Manager connection status + - >- + Permission for support case details for Access Transparency log + entries enum: - PERMISSION_UNSPECIFIED - ACCESS_TRANSPARENCY_AND_EMERGENCY_ACCESS_LOGS - ASSURED_WORKLOADS_MONITORING - ACCESS_APPROVAL_REQUESTS - ASSURED_WORKLOADS_EKM_CONNECTION_STATUS + - ACCESS_TRANSPARENCY_LOGS_SUPPORT_CASE_VIEWER ListAccessApprovalRequestsResponse: id: ListAccessApprovalRequestsResponse description: Response message for list access requests. @@ -846,6 +852,7 @@ components: - $ref: '#/components/x-stackQL-resources/partner/methods/get_partner' insert: [] update: [] + replace: [] delete: [] customers: id: google.cloudcontrolspartner.customers @@ -859,23 +866,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1customers/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.customers - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/customers/methods/get' - $ref: '#/components/x-stackQL-resources/customers/methods/list' insert: [] update: [] + replace: [] delete: [] workloads: id: google.cloudcontrolspartner.workloads @@ -889,23 +894,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1customers~1{customersId}~1workloads/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloads - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/workloads/methods/get' - $ref: '#/components/x-stackQL-resources/workloads/methods/list' insert: [] update: [] + replace: [] delete: [] workloads_ekm_connections: id: google.cloudcontrolspartner.workloads_ekm_connections @@ -925,6 +928,7 @@ components: #/components/x-stackQL-resources/workloads_ekm_connections/methods/get_ekm_connections insert: [] update: [] + replace: [] delete: [] workloads_partner_permissions: id: google.cloudcontrolspartner.workloads_partner_permissions @@ -944,46 +948,42 @@ components: #/components/x-stackQL-resources/workloads_partner_permissions/methods/get_partner_permissions insert: [] update: [] + replace: [] delete: [] access_approval_requests: id: google.cloudcontrolspartner.access_approval_requests name: access_approval_requests title: Access_approval_requests methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1customers~1{customersId}~1workloads~1{workloadsId}~1accessApprovalRequests/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.accessApprovalRequests - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/access_approval_requests/methods/list insert: [] update: [] + replace: [] delete: [] violations: id: google.cloudcontrolspartner.violations name: violations title: Violations methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1customers~1{customersId}~1workloads~1{workloadsId}~1violations/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.violations - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -997,10 +997,11 @@ components: - $ref: '#/components/x-stackQL-resources/violations/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/organizations/{organizationsId}/locations/{locationsId}/partner: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1039,7 +1040,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a single customer operationId: cloudcontrolspartner.organizations.locations.customers.get @@ -1072,7 +1073,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists customers of a partner identified by its Google Cloud organization @@ -1119,7 +1120,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a single workload operationId: cloudcontrolspartner.organizations.locations.customers.workloads.get @@ -1157,7 +1158,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists customer workloads for a given customer org id operationId: cloudcontrolspartner.organizations.locations.customers.workloads.list @@ -1207,7 +1208,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/ekmConnections: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the EKM connections associated with a workload operationId: >- @@ -1246,7 +1247,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/partnerPermissions: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the partner permissions granted for a workload operationId: >- @@ -1285,9 +1286,11 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/accessApprovalRequests: - parameters: *ref_9 + parameters: *ref_1 get: - description: Lists access requests associated with a workload + description: >- + Deprecated: Only returns access approval requests directly associated + with an assured workload folder. operationId: >- cloudcontrolspartner.organizations.locations.customers.workloads.accessApprovalRequests.list security: @@ -1341,7 +1344,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/violations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists Violations for a workload Callers may also choose to read across @@ -1413,7 +1416,7 @@ paths: type: string format: google-datetime /v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/violations/{violationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a single Violation. operationId: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml b/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml index 09740c64..6b735f93 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/clouddeploy.yaml @@ -7,8 +7,8 @@ info: title: Cloud Deploy API description: '' version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240820' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/deploy/ servers: @@ -412,6 +412,12 @@ components: is no cutback time. type: string format: google-duration + podSelectorLabel: + description: >- + Optional. The label to use when selecting Pods for the Deployment + and Service resources. This label must already be present in both + resources. + type: string ServiceNetworking: id: ServiceNetworking description: Information about the Kubernetes Service networking configuration. @@ -432,6 +438,11 @@ components: of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster. type: boolean + podSelectorLabel: + description: >- + Optional. The label to use when selecting Pods for the Deployment + resource. This label must already be present in the Deployment. + type: string CloudRunConfig: id: CloudRunConfig description: CloudRunConfig contains the Cloud Run runtime configuration. @@ -474,7 +485,8 @@ components: description: >- Required. The percentage based deployments that will occur as a part of a `Rollout`. List is expected in ascending order and each integer - n is 0 <= n < 100. + n is 0 <= n < 100. If the GatewayServiceMesh is configured for + Kubernetes, then the range for n is 0 <= n <= 100. type: array items: type: integer @@ -777,6 +789,12 @@ components: specify this option when `cluster` is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/concepts/private-cluster-concept). type: boolean + proxyUrl: + description: >- + Optional. If set, used to configure a + [proxy](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#proxy) + to the Kubernetes server. + type: string AnthosCluster: id: AnthosCluster description: Information specifying an Anthos Cluster. @@ -1446,10 +1464,6 @@ components: type: array items: type: string - currentRepairAutomationRun: - description: Output only. The current AutomationRun repairing the rollout. - readOnly: true - type: string CustomMetadata: id: CustomMetadata description: CustomMetadata contains information from a user-defined operation. @@ -2768,9 +2782,8 @@ components: id: description: >- ID of the `Target`. The value of this field could be one of the - following: * The last segment of a target name. It only needs the ID - to determine which target is being referred to * "*", all targets in - a location. + following: * The last segment of a target name * "*", all targets in + a location type: string labels: description: Target labels. @@ -2800,7 +2813,7 @@ components: PromoteReleaseRule: id: PromoteReleaseRule description: >- - `PromoteRelease` rule will automatically promote a release from the + The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. type: object properties: @@ -2821,10 +2834,8 @@ components: Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the - following: * The last segment of a target name. It only needs the ID - to determine if the target is one of the stages in the promotion - sequence defined in the pipeline. * "@next", the next target in the - promotion sequence. + following: * The last segment of a target name * "@next", the next + target in the promotion sequence type: string condition: description: Output only. Information around the state of the Automation rule. @@ -2889,18 +2900,6 @@ components: resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. type: string - sourcePhases: - description: >- - Optional. Phases within which jobs are subject to automatic repair - actions on failure. Proceeds only after phase name matched any one - in the list, or for all phases if unspecified. This value must - consist of lower-case letters, numbers, and hyphens, start with a - letter and end with a letter or a number, and have a max length of - 63 characters. In other words, it must match the following regex: - `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. - type: array - items: - type: string jobs: description: >- Optional. Jobs to repair. Proceeds only after job name matched any @@ -2913,68 +2912,10 @@ components: type: array items: type: string - repairModes: - description: >- - Required. Defines the types of automatic repair actions for failed - jobs. - type: array - items: - $ref: '#/components/schemas/RepairMode' condition: description: Output only. Information around the state of the 'Automation' rule. readOnly: true $ref: '#/components/schemas/AutomationRuleCondition' - RepairMode: - id: RepairMode - description: Configuration of the repair action. - type: object - properties: - retry: - description: Optional. Retries a failed job. - $ref: '#/components/schemas/Retry' - rollback: - description: Optional. Rolls back a `Rollout`. - $ref: '#/components/schemas/Rollback' - Retry: - id: Retry - description: Retries the failed job. - type: object - properties: - attempts: - description: >- - Required. Total number of retries. Retry is skipped if set to 0; The - minimum value is 1, and the maximum value is 10. - type: string - format: int64 - wait: - description: >- - Optional. How long to wait for the first retry. Default is 0, and - the maximum value is 14d. - type: string - format: google-duration - backoffMode: - description: >- - Optional. The pattern of how wait time will be increased. Default is - linear. Backoff mode will be ignored if `wait` is 0. - type: string - enumDescriptions: - - No WaitMode is specified. - - Increases the wait time linearly. - - Increases the wait time exponentially. - enum: - - BACKOFF_MODE_UNSPECIFIED - - BACKOFF_MODE_LINEAR - - BACKOFF_MODE_EXPONENTIAL - Rollback: - id: Rollback - description: Rolls back a `Rollout`. - type: object - properties: - destinationPhase: - description: >- - Optional. The starting phase ID for the `Rollout`. If unspecified, - the `Rollout` will start in the stable phase. - type: string ListAutomationsResponse: id: ListAutomationsResponse description: The response object from `ListAutomations`. @@ -3171,13 +3112,6 @@ components: `AutomationRun`. readOnly: true type: string - currentRepairModeIndex: - description: >- - Output only. The index of the current repair action in the repair - sequence. - readOnly: true - type: string - format: int64 repairPhases: description: >- Output only. Records of the repair attempts. Each repair phase may @@ -3200,7 +3134,7 @@ components: id: RepairPhase description: >- RepairPhase tracks the repair attempts that have been made for each - `RepairMode` specified in the `Automation` resource. + `RepairPhaseConfig` specified in the `Automation` resource. type: object properties: retry: @@ -3237,18 +3171,6 @@ components: - BACKOFF_MODE_UNSPECIFIED - BACKOFF_MODE_LINEAR - BACKOFF_MODE_EXPONENTIAL - phaseId: - description: >- - Output only. The phase ID of the phase that includes the job being - retried. - readOnly: true - deprecated: true - type: string - jobId: - description: Output only. The job ID for the Job to retry. - readOnly: true - deprecated: true - type: string attempts: description: Output only. Detail of a retry action. readOnly: true @@ -3283,7 +3205,6 @@ components: - The `repair` action has failed. - The `repair` action is in progress. - The `repair` action is pending. - - The `repair` action was skipped. - The `repair` action was aborted. enum: - REPAIR_STATE_UNSPECIFIED @@ -3292,7 +3213,6 @@ components: - REPAIR_STATE_FAILED - REPAIR_STATE_IN_PROGRESS - REPAIR_STATE_PENDING - - REPAIR_STATE_SKIPPED - REPAIR_STATE_ABORTED stateDesc: description: Output only. Description of the state of the Retry. @@ -3324,7 +3244,6 @@ components: - The `repair` action has failed. - The `repair` action is in progress. - The `repair` action is pending. - - The `repair` action was skipped. - The `repair` action was aborted. enum: - REPAIR_STATE_UNSPECIFIED @@ -3333,7 +3252,6 @@ components: - REPAIR_STATE_FAILED - REPAIR_STATE_IN_PROGRESS - REPAIR_STATE_PENDING - - REPAIR_STATE_SKIPPED - REPAIR_STATE_ABORTED stateDesc: description: Output only. Description of the state of the Rollback. @@ -3791,6 +3709,56 @@ components: description: Output only. API version used to start the operation. readOnly: true type: string + CustomTargetTypeNotificationEvent: + id: CustomTargetTypeNotificationEvent + description: >- + Payload proto for + "clouddeploy.googleapis.com/customtargettype_notification" Platform Log + event that describes the failure to send a custom target type status + change Pub/Sub notification. + type: object + properties: + message: + description: Debug message for when a notification fails to send. + type: string + customTargetTypeUid: + description: Unique identifier of the `CustomTargetType`. + type: string + customTargetType: + description: The name of the `CustomTargetType`. + type: string + type: + description: Type of this notification, e.g. for a Pub/Sub failure. + type: string + enumDescriptions: + - Type is unspecified. + - A Pub/Sub notification failed to be sent. + - Resource state changed. + - A process aborted. + - Restriction check failed. + - Resource deleted. + - Rollout updated. + - >- + Deprecated: This field is never used. Use release_render log type + instead. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - false + - true + enum: + - TYPE_UNSPECIFIED + - TYPE_PUBSUB_NOTIFICATION_FAILURE + - TYPE_RESOURCE_STATE_CHANGE + - TYPE_PROCESS_ABORTED + - TYPE_RESTRICTION_VIOLATED + - TYPE_RESOURCE_DELETED + - TYPE_ROLLOUT_UPDATE + - TYPE_RENDER_STATUES_CHANGE DeliveryPipelineNotificationEvent: id: DeliveryPipelineNotificationEvent description: >- @@ -3820,12 +3788,62 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. enumDeprecated: - false + - false + - false + - false + - false + - false + - false + - true + enum: + - TYPE_UNSPECIFIED + - TYPE_PUBSUB_NOTIFICATION_FAILURE + - TYPE_RESOURCE_STATE_CHANGE + - TYPE_PROCESS_ABORTED + - TYPE_RESTRICTION_VIOLATED + - TYPE_RESOURCE_DELETED + - TYPE_ROLLOUT_UPDATE + - TYPE_RENDER_STATUES_CHANGE + DeployPolicyNotificationEvent: + id: DeployPolicyNotificationEvent + description: >- + Payload proto for + "clouddeploy.googleapis.com/deploypolicy_notification". Platform Log + event that describes the failure to send a pub/sub notification when + there is a DeployPolicy status change. + type: object + properties: + message: + description: >- + Debug message for when a deploy policy fails to send a pub/sub + notification. + type: string + deployPolicy: + description: The name of the `DeployPolicy`. + type: string + deployPolicyUid: + description: Unique identifier of the deploy policy. + type: string + type: + description: Type of this notification, e.g. for a Pub/Sub failure. + type: string + enumDescriptions: + - Type is unspecified. + - A Pub/Sub notification failed to be sent. + - Resource state changed. + - A process aborted. + - Restriction check failed. + - Resource deleted. + - Rollout updated. + - >- + Deprecated: This field is never used. Use release_render log type + instead. + enumDeprecated: - false - false - false @@ -3842,7 +3860,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE ReleaseNotificationEvent: id: ReleaseNotificationEvent @@ -3875,7 +3892,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -3887,7 +3903,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -3897,7 +3912,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE ReleaseRenderEvent: id: ReleaseRenderEvent @@ -3933,7 +3947,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -3945,7 +3958,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -3955,7 +3967,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE releaseRenderState: description: The state of the release render. @@ -4012,7 +4023,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -4024,7 +4034,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -4034,7 +4043,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE RolloutUpdateEvent: id: RolloutUpdateEvent @@ -4075,7 +4083,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -4087,7 +4094,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -4097,7 +4103,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE rolloutUpdateType: description: The type of the rollout update. @@ -4157,7 +4162,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -4169,7 +4173,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -4179,7 +4182,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE JobRunNotificationEvent: id: JobRunNotificationEvent @@ -4224,7 +4226,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -4236,7 +4237,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -4246,7 +4246,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE AutomationEvent: id: AutomationEvent @@ -4278,7 +4277,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -4290,7 +4288,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -4300,7 +4297,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE AutomationRunEvent: id: AutomationRunEvent @@ -4341,7 +4337,6 @@ components: - Restriction check failed. - Resource deleted. - Rollout updated. - - Deploy Policy evaluation. - >- Deprecated: This field is never used. Use release_render log type instead. @@ -4353,7 +4348,6 @@ components: - false - false - false - - false - true enum: - TYPE_UNSPECIFIED @@ -4363,7 +4357,6 @@ components: - TYPE_RESTRICTION_VIOLATED - TYPE_RESOURCE_DELETED - TYPE_ROLLOUT_UPDATE - - TYPE_DEPLOY_POLICY_EVALUATION - TYPE_RENDER_STATUES_CHANGE parameters: access_token: @@ -4463,22 +4456,20 @@ components: - $ref: '#/components/x-stackQL-resources/config/methods/get_config' insert: [] update: [] + replace: [] delete: [] locations: id: google.clouddeploy.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -4491,23 +4482,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.clouddeploy.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -4535,6 +4524,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' delivery_pipelines: @@ -4542,17 +4532,14 @@ components: name: delivery_pipelines title: Delivery_pipelines methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deliveryPipelines/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deliveryPipelines - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -4596,6 +4583,7 @@ components: - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/create' update: - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/delivery_pipelines/methods/delete' delivery_pipelines_iam_policies: @@ -4610,17 +4598,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deliveryPipelines~1{deliveryPipelinesId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -4634,23 +4619,23 @@ components: #/components/x-stackQL-resources/delivery_pipelines_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/delivery_pipelines_iam_policies/methods/set_iam_policy delete: [] releases: id: google.clouddeploy.releases name: releases title: Releases methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deliveryPipelines~1{deliveryPipelinesId}~1releases/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.releases - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -4679,6 +4664,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/releases/methods/create' update: [] + replace: [] delete: [] rollouts: id: google.clouddeploy.rollouts @@ -4706,17 +4692,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deliveryPipelines~1{deliveryPipelinesId}~1releases~1{releasesId}~1rollouts/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.rollouts - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -4752,23 +4735,21 @@ components: insert: - $ref: '#/components/x-stackQL-resources/rollouts/methods/create' update: [] + replace: [] delete: [] job_runs: id: google.clouddeploy.job_runs name: job_runs title: Job_runs methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deliveryPipelines~1{deliveryPipelinesId}~1releases~1{releasesId}~1rollouts~1{rolloutsId}~1jobRuns/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobRuns - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -4789,6 +4770,7 @@ components: - $ref: '#/components/x-stackQL-resources/job_runs/methods/list' insert: [] update: [] + replace: [] delete: [] automations: id: google.clouddeploy.automations @@ -4802,17 +4784,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deliveryPipelines~1{deliveryPipelinesId}~1automations/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.automations - list: - operation: *ref_15 - response: *ref_16 patch: operation: $ref: >- @@ -4842,6 +4821,7 @@ components: - $ref: '#/components/x-stackQL-resources/automations/methods/create' update: - $ref: '#/components/x-stackQL-resources/automations/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/automations/methods/delete' automation_runs: @@ -4856,17 +4836,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deliveryPipelines~1{deliveryPipelinesId}~1automationRuns/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.automationRuns - list: - operation: *ref_17 - response: *ref_18 cancel: operation: $ref: >- @@ -4880,23 +4857,21 @@ components: - $ref: '#/components/x-stackQL-resources/automation_runs/methods/list' insert: [] update: [] + replace: [] delete: [] targets: id: google.clouddeploy.targets name: targets title: Targets methods: - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1targets/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.targets - list: - operation: *ref_19 - response: *ref_20 create: operation: $ref: >- @@ -4933,6 +4908,7 @@ components: - $ref: '#/components/x-stackQL-resources/targets/methods/create' update: - $ref: '#/components/x-stackQL-resources/targets/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/targets/methods/delete' targets_iam_policies: @@ -4947,17 +4923,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_21 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1targets~1{targetsId}:getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_21 - response: *ref_22 test_iam_permissions: operation: $ref: >- @@ -4971,23 +4944,23 @@ components: #/components/x-stackQL-resources/targets_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/targets_iam_policies/methods/set_iam_policy delete: [] custom_target_types: id: google.clouddeploy.custom_target_types name: custom_target_types title: Custom_target_types methods: - _list: - operation: &ref_23 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customTargetTypes/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.customTargetTypes - list: - operation: *ref_23 - response: *ref_24 create: operation: $ref: >- @@ -5025,6 +4998,7 @@ components: #/components/x-stackQL-resources/custom_target_types/methods/create update: - $ref: '#/components/x-stackQL-resources/custom_target_types/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/custom_target_types/methods/delete @@ -5040,27 +5014,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_25 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customTargetTypes~1{customTargetTypesId}:getIamPolicy/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_25 - response: *ref_26 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/custom_target_types_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/custom_target_types_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/config: - parameters: &ref_27 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -5099,7 +5073,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: clouddeploy.projects.locations.list @@ -5135,7 +5109,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets information about a location. operationId: clouddeploy.projects.locations.get @@ -5163,7 +5137,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -5206,7 +5180,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5277,7 +5251,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5324,7 +5298,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists DeliveryPipelines in a given project and location. operationId: clouddeploy.projects.locations.deliveryPipelines.list @@ -5412,7 +5386,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single DeliveryPipeline. operationId: clouddeploy.projects.locations.deliveryPipelines.get @@ -5549,7 +5523,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:rollbackTarget: - parameters: *ref_27 + parameters: *ref_1 post: description: Creates a `Rollout` to roll back the specified target. operationId: clouddeploy.projects.locations.deliveryPipelines.rollbackTarget @@ -5587,7 +5561,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5628,7 +5602,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5668,7 +5642,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5711,7 +5685,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists Releases in a given project and location. operationId: clouddeploy.projects.locations.deliveryPipelines.releases.list @@ -5809,7 +5783,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single Release. operationId: clouddeploy.projects.locations.deliveryPipelines.releases.get @@ -5847,7 +5821,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}:abandon: - parameters: *ref_27 + parameters: *ref_1 post: description: Abandons a Release in the Delivery Pipeline. operationId: clouddeploy.projects.locations.deliveryPipelines.releases.abandon @@ -5890,7 +5864,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:approve: - parameters: *ref_27 + parameters: *ref_1 post: description: Approves a Rollout. operationId: >- @@ -5939,7 +5913,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:advance: - parameters: *ref_27 + parameters: *ref_1 post: description: Advances a Rollout in a given project and location. operationId: >- @@ -5988,7 +5962,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:cancel: - parameters: *ref_27 + parameters: *ref_1 post: description: Cancels a Rollout in a given project and location. operationId: >- @@ -6037,7 +6011,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists Rollouts in a given project and location. operationId: clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.list @@ -6150,7 +6124,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single Rollout. operationId: clouddeploy.projects.locations.deliveryPipelines.releases.rollouts.get @@ -6193,7 +6167,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:ignoreJob: - parameters: *ref_27 + parameters: *ref_1 post: description: Ignores the specified Job in a Rollout. operationId: >- @@ -6242,7 +6216,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}:retryJob: - parameters: *ref_27 + parameters: *ref_1 post: description: Retries the specified Job in a Rollout. operationId: >- @@ -6291,7 +6265,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists JobRuns in a given project and location. operationId: >- @@ -6352,7 +6326,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns/{jobRunsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single JobRun. operationId: >- @@ -6401,7 +6375,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/releases/{releasesId}/rollouts/{rolloutsId}/jobRuns/{jobRunsId}:terminate: - parameters: *ref_27 + parameters: *ref_1 post: description: Terminates a Job Run in a given project and location. operationId: >- @@ -6455,7 +6429,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations: - parameters: *ref_27 + parameters: *ref_1 post: description: Creates a new Automation in a given project and location. operationId: clouddeploy.projects.locations.deliveryPipelines.automations.create @@ -6553,7 +6527,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automations/{automationsId}: - parameters: *ref_27 + parameters: *ref_1 patch: description: Updates the parameters of a single Automation resource. operationId: clouddeploy.projects.locations.deliveryPipelines.automations.patch @@ -6701,7 +6675,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single AutomationRun. operationId: clouddeploy.projects.locations.deliveryPipelines.automationRuns.get @@ -6739,7 +6713,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists AutomationRuns in a given project and location. operationId: clouddeploy.projects.locations.deliveryPipelines.automationRuns.list @@ -6789,7 +6763,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deliveryPipelines/{deliveryPipelinesId}/automationRuns/{automationRunsId}:cancel: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Cancels an AutomationRun. The `state` of the `AutomationRun` after @@ -6836,7 +6810,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/targets: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists Targets in a given project and location. operationId: clouddeploy.projects.locations.targets.list @@ -6924,7 +6898,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single Target. operationId: clouddeploy.projects.locations.targets.get @@ -7057,7 +7031,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7098,7 +7072,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7138,7 +7112,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/targets/{targetsId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7181,7 +7155,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists CustomTargetTypes in a given project and location. operationId: clouddeploy.projects.locations.customTargetTypes.list @@ -7269,7 +7243,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single CustomTargetType. operationId: clouddeploy.projects.locations.customTargetTypes.get @@ -7402,7 +7376,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7443,7 +7417,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/customTargetTypes/{customTargetTypesId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy diff --git a/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml b/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml index a469568c..86c7f6d1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/clouderrorreporting.yaml @@ -10,8 +10,8 @@ info: reports new errors, and provides access to error groups and their associated errors. version: v1beta1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/error-reporting/ servers: @@ -45,13 +45,19 @@ components: name: description: >- The group resource name. Written as - `projects/{projectID}/groups/{group_id}`. Example: - `projects/my-project-123/groups/my-group` In the group resource - name, the `group_id` is a unique identifier for a particular error - group. The identifier is derived from key parts of the error-log - content and is treated as Service Data. For information about how - Service Data is handled, see [Google Cloud Privacy - Notice](https://cloud.google.com/terms/cloud-privacy-notice). + `projects/{projectID}/groups/{group_id}` or + `projects/{projectID}/locations/{location}/groups/{group_id}` + Examples: `projects/my-project-123/groups/my-group`, + `projects/my-project-123/locations/us-central1/groups/my-group` In + the group resource name, the `group_id` is a unique identifier for a + particular error group. The identifier is derived from key parts of + the error-log content and is treated as Service Data. For + information about how Service Data is handled, see [Google Cloud + Privacy + Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a + list of supported locations, see [Supported + Regions](https://cloud.google.com/logging/docs/region-support). + `global` is the default when unspecified. type: string groupId: description: >- @@ -450,7 +456,7 @@ components: error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of - [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). + [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack). type: string context: description: Optional. A description of the context in which the error occurred. @@ -550,20 +556,19 @@ components: methods: delete_events: operation: - $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1events/delete' + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1events/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1events/get' - response: &ref_2 + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1events/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.errorEvents - list: - operation: *ref_1 - response: *ref_2 report: operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1events:report/post' @@ -575,6 +580,7 @@ components: - $ref: '#/components/x-stackQL-resources/events/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/events/methods/delete_events' groups: @@ -584,13 +590,15 @@ components: methods: get: operation: - $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1groups~1{groupsId}/get' + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1groups~1{groupsId}/get response: mediaType: application/json openAPIDocKey: '200' update: operation: - $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1groups~1{groupsId}/put' + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1groups~1{groupsId}/put response: mediaType: application/json openAPIDocKey: '200' @@ -598,7 +606,8 @@ components: select: - $ref: '#/components/x-stackQL-resources/groups/methods/get' insert: [] - update: + update: [] + replace: - $ref: '#/components/x-stackQL-resources/groups/methods/update' delete: [] group_stats: @@ -606,25 +615,24 @@ components: name: group_stats title: Group_stats methods: - _list: - operation: &ref_3 - $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1groupStats/get' - response: &ref_4 + list: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1groupStats/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.errorGroupStats - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/group_stats/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1beta1/projects/{projectsId}/events: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -708,7 +716,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/groups/{groupsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Get the specified group. operationId: clouderrorreporting.projects.groups.get @@ -769,7 +777,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/groupStats: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists the specified groups. operationId: clouderrorreporting.projects.groupStats.list @@ -839,7 +847,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/events:report: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Report an individual error event and record the event to a log. This @@ -849,13 +857,12 @@ paths: a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) - is a global service built on Cloud Logging and can analyze log entries - when all of the following are true: * The log entries are stored in a - log bucket in the `global` location. * Customer-managed encryption keys - (CMEK) are disabled on the log bucket. * The log bucket satisfies one of - the following: * The log bucket is stored in the same project where the - logs originated. * The logs were routed to a project, and then that - project stored those logs in a log bucket that it owns. + is a service built on Cloud Logging and can analyze log entries when all + of the following are true: * Customer-managed encryption keys (CMEK) are + disabled on the log bucket. * The log bucket satisfies one of the + following: * The log bucket is stored in the same project where the logs + originated. * The logs were routed to a project, and then that project + stored those logs in a log bucket that it owns. operationId: clouderrorreporting.projects.events.report requestBody: content: @@ -880,3 +887,232 @@ paths: required: true schema: type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/events: + parameters: *ref_1 + delete: + description: Deletes all error events of a given project. + operationId: clouderrorreporting.projects.locations.deleteEvents + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteEventsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + get: + description: Lists the specified events. + operationId: clouderrorreporting.projects.locations.events.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListEventsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: groupId + schema: + type: string + - in: query + name: serviceFilter.service + schema: + type: string + - in: query + name: serviceFilter.version + schema: + type: string + - in: query + name: serviceFilter.resourceType + schema: + type: string + - in: query + name: timeRange.period + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}: + parameters: *ref_1 + get: + description: Get the specified group. + operationId: clouderrorreporting.projects.locations.groups.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: groupsId + required: true + schema: + type: string + put: + description: >- + Replace the data for the specified group. Fails if the group does not + exist. + operationId: clouderrorreporting.projects.locations.groups.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorGroup' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorGroup' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: groupsId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/groupStats: + parameters: *ref_1 + get: + description: Lists the specified groups. + operationId: clouderrorreporting.projects.locations.groupStats.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListGroupStatsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: groupId + schema: + type: string + - in: query + name: serviceFilter.service + schema: + type: string + - in: query + name: serviceFilter.version + schema: + type: string + - in: query + name: serviceFilter.resourceType + schema: + type: string + - in: query + name: timeRange.period + schema: + type: string + - in: query + name: timedCountDuration + schema: + type: string + format: google-duration + - in: query + name: alignment + schema: + type: string + - in: query + name: alignmentTime + schema: + type: string + format: google-datetime + - in: query + name: order + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml index 2bcaea34..0a99f6bf 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudfunctions.yaml @@ -7,8 +7,8 @@ info: title: Cloud Functions API description: Manages lightweight user-provided functions executed in response to events. version: v2 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/functions servers: @@ -552,9 +552,8 @@ components: type: string kmsKeyName: description: >- - [Preview] Resource name of a KMS crypto key (managed by the user) - used to encrypt/decrypt function resources. It must match the - pattern + Resource name of a KMS crypto key (managed by the user) used to + encrypt/decrypt function resources. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. type: string satisfiesPzs: @@ -663,7 +662,10 @@ components: repositories are not supported. Repository format must be 'DOCKER'. type: string serviceAccount: - description: '[Preview] Service account to be used for building the container' + description: >- + Service account to be used for building the container. The format of + this field is + `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`. type: string sourceToken: description: >- @@ -1274,12 +1276,12 @@ components: properties: kmsKeyName: description: >- - [Preview] Resource name of a KMS crypto key (managed by the user) - used to encrypt/decrypt function source code objects in intermediate - Cloud Storage buckets. When you generate an upload url and upload - your source code, it gets copied to an intermediate Cloud Storage - bucket. The source code is then copied to a versioned directory in - the sources bucket in the consumer project during the function + Resource name of a KMS crypto key (managed by the user) used to + encrypt/decrypt function source code objects in intermediate Cloud + Storage buckets. When you generate an upload url and upload your + source code, it gets copied to an intermediate Cloud Storage bucket. + The source code is then copied to a versioned directory in the + sources bucket in the consumer project during the function deployment. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. The Google Cloud Functions service account @@ -1539,302 +1541,6 @@ components: populated for Create and Update operations. `projects//locations//builds/`. type: string - GoogleCloudFunctionsV2alphaOperationMetadata: - id: GoogleCloudFunctionsV2alphaOperationMetadata - description: Represents the metadata of the long-running operation. - type: object - properties: - createTime: - description: The time the operation was created. - type: string - format: google-datetime - endTime: - description: The time the operation finished running. - type: string - format: google-datetime - target: - description: Server-defined resource path for the target of the operation. - type: string - verb: - description: Name of the verb executed by the operation. - type: string - statusDetail: - description: Human-readable status of the operation, if any. - type: string - cancelRequested: - description: >- - Identifies whether the user has requested cancellation of the - operation. Operations that have successfully been cancelled have - google.longrunning.Operation.error value with a - google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - type: boolean - apiVersion: - description: API version used to start the operation. - type: string - requestResource: - description: The original request that started the operation. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - stages: - description: Mechanism for reporting in-progress stages - type: array - items: - $ref: '#/components/schemas/GoogleCloudFunctionsV2alphaStage' - sourceToken: - description: >- - An identifier for Firebase function sources. Disclaimer: This field - is only supported for Firebase function deployments. - type: string - operationType: - description: The operation type. - type: string - enumDescriptions: - - Unspecified - - CreateFunction - - UpdateFunction - - DeleteFunction - - RedirectFunctionUpgradeTraffic - - RollbackFunctionUpgradeTraffic - - SetupFunctionUpgradeConfig - - AbortFunctionUpgrade - - CommitFunctionUpgrade - enum: - - OPERATIONTYPE_UNSPECIFIED - - CREATE_FUNCTION - - UPDATE_FUNCTION - - DELETE_FUNCTION - - REDIRECT_FUNCTION_UPGRADE_TRAFFIC - - ROLLBACK_FUNCTION_UPGRADE_TRAFFIC - - SETUP_FUNCTION_UPGRADE_CONFIG - - ABORT_FUNCTION_UPGRADE - - COMMIT_FUNCTION_UPGRADE - GoogleCloudFunctionsV2alphaStage: - id: GoogleCloudFunctionsV2alphaStage - description: Each Stage of the deployment process - type: object - properties: - name: - description: Name of the Stage. This will be unique for each Stage. - type: string - enumDescriptions: - - Not specified. Invalid name. - - Artifact Regsitry Stage - - Build Stage - - Service Stage - - Trigger Stage - - Service Rollback Stage - - Trigger Rollback Stage - enum: - - NAME_UNSPECIFIED - - ARTIFACT_REGISTRY - - BUILD - - SERVICE - - TRIGGER - - SERVICE_ROLLBACK - - TRIGGER_ROLLBACK - message: - description: Message describing the Stage - type: string - state: - description: Current state of the Stage - type: string - enumDescriptions: - - Not specified. Invalid state. - - Stage has not started. - - Stage is in progress. - - Stage has completed. - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - COMPLETE - resource: - description: Resource of the Stage - type: string - resourceUri: - description: Link to the current Stage resource - type: string - stateMessages: - description: State messages from the current Stage. - type: array - items: - $ref: '#/components/schemas/GoogleCloudFunctionsV2alphaStateMessage' - GoogleCloudFunctionsV2alphaStateMessage: - id: GoogleCloudFunctionsV2alphaStateMessage - description: >- - Informational messages about the state of the Cloud Function or - Operation. - type: object - properties: - severity: - description: Severity of the state message. - type: string - enumDescriptions: - - Not specified. Invalid severity. - - ERROR-level severity. - - WARNING-level severity. - - INFO-level severity. - enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARNING - - INFO - type: - description: One-word CamelCase type of the state message. - type: string - message: - description: The message. - type: string - GoogleCloudFunctionsV2betaOperationMetadata: - id: GoogleCloudFunctionsV2betaOperationMetadata - description: Represents the metadata of the long-running operation. - type: object - properties: - createTime: - description: The time the operation was created. - type: string - format: google-datetime - endTime: - description: The time the operation finished running. - type: string - format: google-datetime - target: - description: Server-defined resource path for the target of the operation. - type: string - verb: - description: Name of the verb executed by the operation. - type: string - statusDetail: - description: Human-readable status of the operation, if any. - type: string - cancelRequested: - description: >- - Identifies whether the user has requested cancellation of the - operation. Operations that have successfully been cancelled have - google.longrunning.Operation.error value with a - google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - type: boolean - apiVersion: - description: API version used to start the operation. - type: string - requestResource: - description: The original request that started the operation. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - stages: - description: Mechanism for reporting in-progress stages - type: array - items: - $ref: '#/components/schemas/GoogleCloudFunctionsV2betaStage' - sourceToken: - description: >- - An identifier for Firebase function sources. Disclaimer: This field - is only supported for Firebase function deployments. - type: string - operationType: - description: The operation type. - type: string - enumDescriptions: - - Unspecified - - CreateFunction - - UpdateFunction - - DeleteFunction - - RedirectFunctionUpgradeTraffic - - RollbackFunctionUpgradeTraffic - - SetupFunctionUpgradeConfig - - AbortFunctionUpgrade - - CommitFunctionUpgrade - enum: - - OPERATIONTYPE_UNSPECIFIED - - CREATE_FUNCTION - - UPDATE_FUNCTION - - DELETE_FUNCTION - - REDIRECT_FUNCTION_UPGRADE_TRAFFIC - - ROLLBACK_FUNCTION_UPGRADE_TRAFFIC - - SETUP_FUNCTION_UPGRADE_CONFIG - - ABORT_FUNCTION_UPGRADE - - COMMIT_FUNCTION_UPGRADE - GoogleCloudFunctionsV2betaStage: - id: GoogleCloudFunctionsV2betaStage - description: Each Stage of the deployment process - type: object - properties: - name: - description: Name of the Stage. This will be unique for each Stage. - type: string - enumDescriptions: - - Not specified. Invalid name. - - Artifact Regsitry Stage - - Build Stage - - Service Stage - - Trigger Stage - - Service Rollback Stage - - Trigger Rollback Stage - enum: - - NAME_UNSPECIFIED - - ARTIFACT_REGISTRY - - BUILD - - SERVICE - - TRIGGER - - SERVICE_ROLLBACK - - TRIGGER_ROLLBACK - message: - description: Message describing the Stage - type: string - state: - description: Current state of the Stage - type: string - enumDescriptions: - - Not specified. Invalid state. - - Stage has not started. - - Stage is in progress. - - Stage has completed. - enum: - - STATE_UNSPECIFIED - - NOT_STARTED - - IN_PROGRESS - - COMPLETE - resource: - description: Resource of the Stage - type: string - resourceUri: - description: Link to the current Stage resource - type: string - stateMessages: - description: State messages from the current Stage. - type: array - items: - $ref: '#/components/schemas/GoogleCloudFunctionsV2betaStateMessage' - GoogleCloudFunctionsV2betaStateMessage: - id: GoogleCloudFunctionsV2betaStateMessage - description: >- - Informational messages about the state of the Cloud Function or - Operation. - type: object - properties: - severity: - description: Severity of the state message. - type: string - enumDescriptions: - - Not specified. Invalid severity. - - ERROR-level severity. - - WARNING-level severity. - - INFO-level severity. - enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARNING - - INFO - type: - description: One-word CamelCase type of the state message. - type: string - message: - description: The message. - type: string GoogleCloudFunctionsV2OperationMetadata: id: GoogleCloudFunctionsV2OperationMetadata description: Represents the metadata of the long-running operation. @@ -1883,6 +1589,9 @@ components: An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. type: string + buildName: + description: The build name of the function for create and update operations. + type: string operationType: description: The operation type. type: string @@ -1957,42 +1666,6 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudFunctionsV2StateMessage' - GoogleCloudFunctionsV2alphaLocationMetadata: - id: GoogleCloudFunctionsV2alphaLocationMetadata - description: Extra GCF specific location information. - type: object - properties: - environments: - description: The Cloud Function environments this location supports. - type: array - items: - type: string - enumDescriptions: - - Unspecified - - Gen 1 - - Gen 2 - enum: - - ENVIRONMENT_UNSPECIFIED - - GEN_1 - - GEN_2 - GoogleCloudFunctionsV2betaLocationMetadata: - id: GoogleCloudFunctionsV2betaLocationMetadata - description: Extra GCF specific location information. - type: object - properties: - environments: - description: The Cloud Function environments this location supports. - type: array - items: - type: string - enumDescriptions: - - Unspecified - - Gen 1 - - Gen 2 - enum: - - ENVIRONMENT_UNSPECIFIED - - GEN_1 - - GEN_2 GoogleCloudFunctionsV2LocationMetadata: id: GoogleCloudFunctionsV2LocationMetadata description: Extra GCF specific location information. @@ -2097,38 +1770,33 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.cloudfunctions.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2142,6 +1810,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] functions_iam_policies: id: google.cloudfunctions.functions_iam_policies @@ -2155,17 +1824,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1functions~1{functionsId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: >- @@ -2179,6 +1845,9 @@ components: #/components/x-stackQL-resources/functions_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/functions_iam_policies/methods/set_iam_policy delete: [] functions: id: google.cloudfunctions.functions @@ -2206,17 +1875,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1functions/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.functions - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -2281,6 +1947,7 @@ components: - $ref: '#/components/x-stackQL-resources/functions/methods/create' update: - $ref: '#/components/x-stackQL-resources/functions/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/functions/methods/delete' runtimes: @@ -2300,10 +1967,11 @@ components: - $ref: '#/components/x-stackQL-resources/runtimes/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v2/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2350,7 +2018,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2393,7 +2061,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2429,7 +2097,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2470,7 +2138,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2510,7 +2178,7 @@ paths: type: integer format: int32 /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2553,7 +2221,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Returns a function with the given name from the requested project. operationId: cloudfunctions.projects.locations.functions.get @@ -2665,7 +2333,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions: - parameters: *ref_9 + parameters: *ref_1 get: description: Returns a list of functions that belong to the requested project. operationId: cloudfunctions.projects.locations.functions.list @@ -2748,7 +2416,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setupFunctionUpgradeConfig: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates a 2nd Gen copy of the function configuration based on the 1st @@ -2791,7 +2459,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:abortFunctionUpgrade: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Aborts generation upgrade process for a function with the given name @@ -2833,7 +2501,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:redirectFunctionUpgradeTraffic: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Changes the traffic target of a function from the original 1st Gen @@ -2876,7 +2544,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:rollbackFunctionUpgradeTraffic: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Reverts the traffic target of a function from the 2nd Gen copy to the @@ -2918,7 +2586,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:commitFunctionUpgrade: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Finalizes the upgrade after which function upgrade can not be rolled @@ -2960,7 +2628,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns a signed URL for uploading a function source code. For more @@ -3007,7 +2675,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns a signed URL for downloading deployed function source code. The @@ -3049,7 +2717,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/runtimes: - parameters: *ref_9 + parameters: *ref_1 get: description: Returns a list of runtimes that are supported for the requested project. operationId: cloudfunctions.projects.locations.runtimes.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml index ef7f9bc4..ed13e478 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudidentity.yaml @@ -7,8 +7,8 @@ info: title: Cloud Identity API description: API for provisioning and managing identity resources. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/identity/ servers: @@ -1361,6 +1361,7 @@ components: - Represents service account type. - Represents group type. - Represents Shared drive. + - Represents a CBCM-managed Chrome Browser type. - Represents other type. enum: - TYPE_UNSPECIFIED @@ -1368,6 +1369,7 @@ components: - SERVICE_ACCOUNT - GROUP - SHARED_DRIVE + - CBCM_BROWSER - OTHER deliverySetting: description: Output only. Delivery setting associated with the membership. @@ -2269,14 +2271,28 @@ components: LRO response metadata for InboundSamlSsoProfilesService.AddIdpCredential. type: object - properties: {} + properties: + state: + description: >- + State of this Operation Will be "awaiting-multi-party-approval" when + the operation is deferred due to the target customer having enabled + [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448). + type: string CreateInboundSamlSsoProfileOperationMetadata: id: CreateInboundSamlSsoProfileOperationMetadata description: >- LRO response metadata for InboundSamlSsoProfilesService.CreateInboundSamlSsoProfile. type: object - properties: {} + properties: + state: + description: >- + State of this Operation Will be "awaiting-multi-party-approval" when + the operation is deferred due to the target customer having enabled + [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448). + type: string DeleteIdpCredentialOperationMetadata: id: DeleteIdpCredentialOperationMetadata description: >- @@ -2297,7 +2313,14 @@ components: LRO response metadata for InboundSamlSsoProfilesService.UpdateInboundSamlSsoProfile. type: object - properties: {} + properties: + state: + description: >- + State of this Operation Will be "awaiting-multi-party-approval" when + the operation is deferred due to the target customer having enabled + [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448). + type: string CreateInboundSsoAssignmentOperationMetadata: id: CreateInboundSsoAssignmentOperationMetadata description: >- @@ -2411,16 +2434,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1devices/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1devices~1{devicesId}/get' @@ -2452,6 +2472,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/devices/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/devices/methods/delete' device_users: @@ -2473,16 +2494,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1devices~1{devicesId}~1deviceUsers/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deviceUsers - list: - operation: *ref_3 - response: *ref_4 lookup: operation: $ref: '#/paths/~1v1~1devices~1{devicesId}~1deviceUsers:lookup/get' @@ -2523,6 +2541,7 @@ components: - $ref: '#/components/x-stackQL-resources/device_users/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/device_users/methods/delete' client_states: @@ -2544,17 +2563,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1devices~1{devicesId}~1deviceUsers~1{deviceUsersId}~1clientStates/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clientStates - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/client_states/methods/get' @@ -2562,6 +2578,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/client_states/methods/patch' + replace: [] delete: [] groups: id: google.cloudidentity.groups @@ -2574,16 +2591,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: '#/paths/~1v1~1groups/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.groups - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: '#/paths/~1v1~1groups~1{groupsId}/get' @@ -2622,6 +2636,7 @@ components: - $ref: '#/components/x-stackQL-resources/groups/methods/create' update: - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/groups/methods/delete' groups_security_settings: @@ -2646,7 +2661,10 @@ components: - $ref: >- #/components/x-stackQL-resources/groups_security_settings/methods/get_security_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/groups_security_settings/methods/update_security_settings + replace: [] delete: [] memberships: id: google.cloudidentity.memberships @@ -2659,16 +2677,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: '#/paths/~1v1~1groups~1{groupsId}~1memberships/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.memberships - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: '#/paths/~1v1~1groups~1{groupsId}~1memberships~1{membershipsId}/get' @@ -2730,6 +2745,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/memberships/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/memberships/methods/delete' memberships_membership_graph: @@ -2750,6 +2766,7 @@ components: #/components/x-stackQL-resources/memberships_membership_graph/methods/get_membership_graph insert: [] update: [] + replace: [] delete: [] inbound_saml_sso_profiles: id: google.cloudidentity.inbound_saml_sso_profiles @@ -2762,16 +2779,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: '#/paths/~1v1~1inboundSamlSsoProfiles/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.inboundSamlSsoProfiles - list: - operation: *ref_11 - response: *ref_12 patch: operation: $ref: >- @@ -2805,6 +2819,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/inbound_saml_sso_profiles/methods/delete @@ -2827,17 +2842,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1inboundSamlSsoProfiles~1{inboundSamlSsoProfilesId}~1idpCredentials/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.idpCredentials - list: - operation: *ref_13 - response: *ref_14 add: operation: $ref: >- @@ -2849,8 +2861,10 @@ components: select: - $ref: '#/components/x-stackQL-resources/idp_credentials/methods/get' - $ref: '#/components/x-stackQL-resources/idp_credentials/methods/list' - insert: [] + insert: + - $ref: '#/components/x-stackQL-resources/idp_credentials/methods/add' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/idp_credentials/methods/delete' inbound_sso_assignments: @@ -2884,16 +2898,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: '#/paths/~1v1~1inboundSsoAssignments/get' - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.inboundSsoAssignments - list: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: >- @@ -2906,6 +2917,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/inbound_sso_assignments/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/inbound_sso_assignments/methods/delete @@ -2921,16 +2933,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: '#/paths/~1v1~1customers~1{customersId}~1userinvitations/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.userInvitations - list: - operation: *ref_17 - response: *ref_18 send: operation: $ref: >- @@ -2958,10 +2967,11 @@ components: - $ref: '#/components/x-stackQL-resources/userinvitations/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/devices: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3049,7 +3059,7 @@ paths: schema: type: string /v1/devices/{devicesId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Retrieves the specified device. operationId: cloudidentity.devices.get @@ -3105,7 +3115,7 @@ paths: schema: type: string /v1/devices/{devicesId}:wipe: - parameters: *ref_19 + parameters: *ref_1 post: description: Wipes all data on the specified device. operationId: cloudidentity.devices.wipe @@ -3134,7 +3144,7 @@ paths: schema: type: string /v1/devices/{devicesId}:cancelWipe: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Cancels an unfinished device wipe. This operation can be used to cancel @@ -3170,7 +3180,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers/{deviceUsersId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Retrieves the specified DeviceUser operationId: cloudidentity.devices.deviceUsers.get @@ -3239,7 +3249,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists/Searches DeviceUsers. operationId: cloudidentity.devices.deviceUsers.list @@ -3288,7 +3298,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers:lookup: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Looks up resource names of the DeviceUsers associated with the caller's @@ -3345,7 +3355,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers/{deviceUsersId}:approve: - parameters: *ref_19 + parameters: *ref_1 post: description: Approves device to access user data. operationId: cloudidentity.devices.deviceUsers.approve @@ -3379,7 +3389,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers/{deviceUsersId}:block: - parameters: *ref_19 + parameters: *ref_1 post: description: Blocks device from accessing user data operationId: cloudidentity.devices.deviceUsers.block @@ -3413,7 +3423,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers/{deviceUsersId}:wipe: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Wipes the user's account on a device. Other data on the device that is @@ -3454,7 +3464,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers/{deviceUsersId}:cancelWipe: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Cancels an unfinished user account wipe. This operation can be used to @@ -3491,7 +3501,7 @@ paths: schema: type: string /v1/devices/{devicesId}/deviceUsers/{deviceUsersId}/clientStates/{clientStatesId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets the client state for the device user operationId: cloudidentity.devices.deviceUsers.clientStates.get @@ -3582,7 +3592,7 @@ paths: type: string format: google-fieldmask /v1/devices/{devicesId}/deviceUsers/{deviceUsersId}/clientStates: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists the client states for the given search query. operationId: cloudidentity.devices.deviceUsers.clientStates.list @@ -3631,7 +3641,7 @@ paths: schema: type: string /v1/groups: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a Group. operationId: cloudidentity.groups.create @@ -3703,7 +3713,7 @@ paths: schema: type: string /v1/groups/{groupsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Retrieves a `Group`. operationId: cloudidentity.groups.get @@ -3794,7 +3804,7 @@ paths: schema: type: string /v1/groups/{groupsId}/securitySettings: - parameters: *ref_19 + parameters: *ref_1 get: description: Get Security Settings operationId: cloudidentity.groups.getSecuritySettings @@ -3865,7 +3875,7 @@ paths: type: string format: google-fieldmask /v1/groups:lookup: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Looks up the [resource @@ -3902,7 +3912,7 @@ paths: schema: type: string /v1/groups:search: - parameters: *ref_19 + parameters: *ref_1 get: description: Searches for `Group` resources matching a specified query. operationId: cloudidentity.groups.search @@ -3945,7 +3955,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a `Membership`. operationId: cloudidentity.groups.memberships.create @@ -4019,7 +4029,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships/{membershipsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Retrieves a `Membership`. operationId: cloudidentity.groups.memberships.get @@ -4085,7 +4095,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships:lookup: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Looks up the [resource @@ -4127,7 +4137,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships/{membershipsId}:modifyMembershipRoles: - parameters: *ref_19 + parameters: *ref_1 post: description: Modifies the `MembershipRole`s of a `Membership`. operationId: cloudidentity.groups.memberships.modifyMembershipRoles @@ -4164,7 +4174,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships:searchTransitiveMemberships: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Search transitive memberships of a group. **Note:** This feature is only @@ -4211,7 +4221,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships:searchTransitiveGroups: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Search transitive groups of a member. **Note:** This feature is only @@ -4262,7 +4272,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships:checkTransitiveMembership: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Check a potential member for membership in a group. **Note:** This @@ -4306,7 +4316,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships:getMembershipGraph: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Get a membership graph of just a member or both a member and a group. @@ -4349,7 +4359,7 @@ paths: schema: type: string /v1/groups/{groupsId}/memberships:searchDirectGroups: - parameters: *ref_19 + parameters: *ref_1 get: description: Searches direct groups of a member. operationId: cloudidentity.groups.memberships.searchDirectGroups @@ -4397,9 +4407,14 @@ paths: schema: type: string /v1/inboundSamlSsoProfiles: - parameters: *ref_19 + parameters: *ref_1 post: - description: Creates an InboundSamlSsoProfile for a customer. + description: >- + Creates an InboundSamlSsoProfile for a customer. When the target + customer has enabled [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448), the `Operation` + in the response will have `"done": false`, it will not have a response, + and the metadata will have `"state": "awaiting-multi-party-approval"`. operationId: cloudidentity.inboundSamlSsoProfiles.create requestBody: content: @@ -4449,9 +4464,14 @@ paths: schema: type: string /v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}: - parameters: *ref_19 + parameters: *ref_1 patch: - description: Updates an InboundSamlSsoProfile. + description: >- + Updates an InboundSamlSsoProfile. When the target customer has enabled + [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448), the `Operation` + in the response will have `"done": false`, it will not have a response, + and the metadata will have `"state": "awaiting-multi-party-approval"`. operationId: cloudidentity.inboundSamlSsoProfiles.patch requestBody: content: @@ -4524,7 +4544,7 @@ paths: schema: type: string /v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials/{idpCredentialsId}: - parameters: *ref_19 + parameters: *ref_1 delete: description: Deletes an IdpCredential. operationId: cloudidentity.inboundSamlSsoProfiles.idpCredentials.delete @@ -4578,7 +4598,7 @@ paths: schema: type: string /v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns a list of IdpCredentials in an InboundSamlSsoProfile. operationId: cloudidentity.inboundSamlSsoProfiles.idpCredentials.list @@ -4610,9 +4630,14 @@ paths: schema: type: string /v1/inboundSamlSsoProfiles/{inboundSamlSsoProfilesId}/idpCredentials:add: - parameters: *ref_19 + parameters: *ref_1 post: - description: Adds an IdpCredential. Up to 2 credentials are allowed. + description: >- + Adds an IdpCredential. Up to 2 credentials are allowed. When the target + customer has enabled [Multi-party approval for sensitive + actions](https://support.google.com/a/answer/13790448), the `Operation` + in the response will have `"done": false`, it will not have a response, + and the metadata will have `"state": "awaiting-multi-party-approval"`. operationId: cloudidentity.inboundSamlSsoProfiles.idpCredentials.add requestBody: content: @@ -4638,7 +4663,7 @@ paths: schema: type: string /v1/inboundSsoAssignments/{inboundSsoAssignmentsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets an InboundSsoAssignment. operationId: cloudidentity.inboundSsoAssignments.get @@ -4722,7 +4747,7 @@ paths: schema: type: string /v1/inboundSsoAssignments: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Creates an InboundSsoAssignment for users and devices in a `Customer` @@ -4776,7 +4801,7 @@ paths: schema: type: string /v1/customers/{customersId}/userinvitations/{userinvitationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Retrieves a UserInvitation resource. **Note:** New consumer accounts @@ -4804,7 +4829,7 @@ paths: schema: type: string /v1/customers/{customersId}/userinvitations: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Retrieves a list of UserInvitation resources. **Note:** New consumer @@ -4844,7 +4869,7 @@ paths: schema: type: string /v1/customers/{customersId}/userinvitations/{userinvitationsId}:send: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sends a UserInvitation to email. If the `UserInvitation` does not exist @@ -4879,7 +4904,7 @@ paths: schema: type: string /v1/customers/{customersId}/userinvitations/{userinvitationsId}:cancel: - parameters: *ref_19 + parameters: *ref_1 post: description: Cancels a UserInvitation that was already sent. operationId: cloudidentity.customers.userinvitations.cancel @@ -4908,7 +4933,7 @@ paths: schema: type: string /v1/customers/{customersId}/userinvitations/{userinvitationsId}:isInvitableUser: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Verifies whether a user account is eligible to receive a UserInvitation diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml index f4dcc552..3724fc8b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudkms.yaml @@ -9,8 +9,8 @@ info: Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications. version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240903' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/kms/ servers: @@ -62,6 +62,24 @@ components: permissions). A request with an empty key project field will clear the configuration. type: string + state: + description: Output only. The state for the AutokeyConfig. + readOnly: true + type: string + enumDescriptions: + - The state of the AutokeyConfig is unspecified. + - The AutokeyConfig is currently active. + - >- + A previously configured key project has been deleted and the + current AutokeyConfig is unusable. + - >- + The AutokeyConfig is not yet initialized or has been reset to its + default uninitialized state. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - KEY_PROJECT_DELETED + - UNINITIALIZED ShowEffectiveAutokeyConfigResponse: id: ShowEffectiveAutokeyConfigResponse description: Response message for ShowEffectiveAutokeyConfig. @@ -193,6 +211,12 @@ components: type: array items: $ref: '#/components/schemas/KeyHandle' + nextPageToken: + description: >- + A token to retrieve next page of results. Pass this value in + ListKeyHandlesRequest.page_token to retrieve the next page of + results. + type: string ListEkmConnectionsResponse: id: ListEkmConnectionsResponse description: Response message for EkmService.ListEkmConnections. @@ -235,9 +259,9 @@ components: format: google-datetime serviceResolvers: description: >- - A list of ServiceResolvers where the EKM can be reached. There - should be one ServiceResolver per EKM replica. Currently, only a - single ServiceResolver is supported. + Optional. A list of ServiceResolvers where the EKM can be reached. + There should be one ServiceResolver per EKM replica. Currently, only + a single ServiceResolver is supported. type: array items: $ref: '#/components/schemas/ServiceResolver' @@ -548,7 +572,7 @@ components: description: >- Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not - specified at creation time, the default duration is 24 hours. + specified at creation time, the default duration is 30 days. type: string format: google-duration cryptoKeyBackend: @@ -562,6 +586,18 @@ components: non-exhaustive and may apply to additional ProtectionLevels in the future. type: string + keyAccessJustificationsPolicy: + description: >- + Optional. The policy used for Key Access Justifications Policy + Enforcement. If this field is present and this key is enrolled in + Key Access Justifications Policy Enforcement, the policy will be + evaluated in encrypt, decrypt, and sign operations, and the + operation will fail if rejected by the policy. The policy is defined + by specifying zero or more allowed justification codes. + https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes + By default, this field is absent, and all justification codes are + allowed. + $ref: '#/components/schemas/KeyAccessJustificationsPolicy' CryptoKeyVersion: id: CryptoKeyVersion description: >- @@ -1026,6 +1062,82 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION + KeyAccessJustificationsPolicy: + id: KeyAccessJustificationsPolicy + description: >- + A KeyAccessJustificationsPolicy specifies zero or more allowed + AccessReason values for encrypt, decrypt, and sign operations on a + CryptoKey. + type: object + properties: + allowedAccessReasons: + description: >- + The list of allowed reasons for access to a CryptoKey. Zero allowed + access reasons means all encrypt, decrypt, and sign operations for + the CryptoKey associated with this policy will fail. + type: array + items: + type: string + enumDescriptions: + - Unspecified access reason. + - Customer-initiated support. + - >- + Google-initiated access for system management and + troubleshooting. + - >- + Google-initiated access in response to a legal request or legal + process. + - >- + Google-initiated access for security, fraud, abuse, or + compliance purposes. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer. + - No reason is expected for this key request. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes, and one of the following + is true: * A Google administrator has reset the root-access + account associated with the user's organization within the past + 7 days. * A Google-initiated emergency access operation has + interacted with a resource in the same project or folder as the + currently accessed resource within the past 7 days. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer, and one of the following is true: * A Google + administrator has reset the root-access account associated with + the user's organization within the past 7 days. * A + Google-initiated emergency access operation has interacted with + a resource in the same project or folder as the currently + accessed resource within the past 7 days. + - Google-initiated access to maintain system reliability. + - >- + One of the following operations is being executed while + simultaneously encountering an internal technical issue which + prevented a more precise justification code from being + generated: * Your account has been used to perform any access to + your own data which your IAM policy authorizes. * An automated + Google system operates on encrypted customer data which your IAM + policy authorizes. * Customer-initiated Google support access. * + Google-initiated support access to protect system reliability. + enum: + - REASON_UNSPECIFIED + - CUSTOMER_INITIATED_SUPPORT + - GOOGLE_INITIATED_SERVICE + - THIRD_PARTY_DATA_REQUEST + - GOOGLE_INITIATED_REVIEW + - CUSTOMER_INITIATED_ACCESS + - GOOGLE_INITIATED_SYSTEM_OPERATION + - REASON_NOT_EXPECTED + - MODIFIED_CUSTOMER_INITIATED_ACCESS + - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION + - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT + - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING ListCryptoKeyVersionsResponse: id: ListCryptoKeyVersionsResponse description: Response message for KeyManagementService.ListCryptoKeyVersions. @@ -3092,7 +3204,10 @@ components: - $ref: >- #/components/x-stackQL-resources/autokey_config/methods/get_autokey_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/autokey_config/methods/update_autokey_config + replace: [] delete: [] projects: id: google.cloudkms.projects @@ -3110,6 +3225,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] ekm_config: id: google.cloudkms.ekm_config @@ -3134,7 +3250,10 @@ components: select: - $ref: '#/components/x-stackQL-resources/ekm_config/methods/get_ekm_config' insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/ekm_config/methods/update_ekm_config + replace: [] delete: [] locations: id: google.cloudkms.locations @@ -3148,16 +3267,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3170,6 +3286,7 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.cloudkms.operations @@ -3188,6 +3305,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] + replace: [] delete: [] key_handles: id: google.cloudkms.key_handles @@ -3208,6 +3326,7 @@ components: response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.keyHandles get: operation: $ref: >- @@ -3222,23 +3341,21 @@ components: insert: - $ref: '#/components/x-stackQL-resources/key_handles/methods/create' update: [] + replace: [] delete: [] ekm_connections: id: google.cloudkms.ekm_connections name: ekm_connections title: Ekm_connections methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ekmConnections/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.ekmConnections - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: >- @@ -3275,6 +3392,7 @@ components: - $ref: '#/components/x-stackQL-resources/ekm_connections/methods/create' update: - $ref: '#/components/x-stackQL-resources/ekm_connections/methods/patch' + replace: [] delete: [] ekm_connections_iam_policies: id: google.cloudkms.ekm_connections_iam_policies @@ -3288,17 +3406,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ekmConnections~1{ekmConnectionsId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: >- @@ -3312,23 +3427,23 @@ components: #/components/x-stackQL-resources/ekm_connections_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/ekm_connections_iam_policies/methods/set_iam_policy delete: [] key_rings: id: google.cloudkms.key_rings name: key_rings title: Key_rings methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.keyRings - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -3350,6 +3465,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/key_rings/methods/create' update: [] + replace: [] delete: [] key_rings_iam_policies: id: google.cloudkms.key_rings_iam_policies @@ -3363,17 +3479,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_9 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}:getIamPolicy/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_9 - response: *ref_10 test_iam_permissions: operation: $ref: >- @@ -3387,23 +3500,23 @@ components: #/components/x-stackQL-resources/key_rings_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/key_rings_iam_policies/methods/set_iam_policy delete: [] crypto_keys: id: google.cloudkms.crypto_keys name: crypto_keys title: Crypto_keys methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1cryptoKeys/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.cryptoKeys - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -3447,6 +3560,7 @@ components: - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/create' update: - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/patch' + replace: [] delete: [] crypto_keys_primary_version: id: google.cloudkms.crypto_keys_primary_version @@ -3463,7 +3577,10 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/crypto_keys_primary_version/methods/update_primary_version + replace: [] delete: [] crypto_keys_iam_policies: id: google.cloudkms.crypto_keys_iam_policies @@ -3477,17 +3594,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_13 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1cryptoKeys~1{cryptoKeysId}:getIamPolicy/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_13 - response: *ref_14 test_iam_permissions: operation: $ref: >- @@ -3501,23 +3615,23 @@ components: #/components/x-stackQL-resources/crypto_keys_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/crypto_keys_iam_policies/methods/set_iam_policy delete: [] crypto_key_versions: id: google.cloudkms.crypto_key_versions name: crypto_key_versions title: Crypto_key_versions methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1cryptoKeys~1{cryptoKeysId}~1cryptoKeyVersions/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.cryptoKeyVersions - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -3611,7 +3725,10 @@ components: #/components/x-stackQL-resources/crypto_key_versions/methods/create update: - $ref: '#/components/x-stackQL-resources/crypto_key_versions/methods/patch' - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/crypto_key_versions/methods/destroy crypto_key_versions_public_key: id: google.cloudkms.crypto_key_versions_public_key name: crypto_key_versions_public_key @@ -3630,23 +3747,21 @@ components: #/components/x-stackQL-resources/crypto_key_versions_public_key/methods/get_public_key insert: [] update: [] + replace: [] delete: [] import_jobs: id: google.cloudkms.import_jobs name: import_jobs title: Import_jobs methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1importJobs/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.importJobs - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: >- @@ -3668,6 +3783,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/import_jobs/methods/create' update: [] + replace: [] delete: [] import_jobs_iam_policies: id: google.cloudkms.import_jobs_iam_policies @@ -3681,17 +3797,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1keyRings~1{keyRingsId}~1importJobs~1{importJobsId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 test_iam_permissions: operation: $ref: >- @@ -3705,6 +3818,9 @@ components: #/components/x-stackQL-resources/import_jobs_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/import_jobs_iam_policies/methods/set_iam_policy delete: [] ekm_config_iam_policies: id: google.cloudkms.ekm_config_iam_policies @@ -3718,17 +3834,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_21 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ekmConfig:getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_21 - response: *ref_22 test_iam_permissions: operation: $ref: >- @@ -3742,10 +3855,13 @@ components: #/components/x-stackQL-resources/ekm_config_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/ekm_config_iam_policies/methods/set_iam_policy delete: [] paths: /v1/folders/{foldersId}/autokeyConfig: - parameters: &ref_23 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3824,7 +3940,7 @@ paths: schema: type: string /v1/projects/{projectsId}:showEffectiveAutokeyConfig: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Returns the effective Cloud KMS Autokey configuration for a given @@ -3853,7 +3969,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ekmConfig: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Returns the EkmConfig singleton resource for a given project and @@ -3929,7 +4045,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}:generateRandomBytes: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Generate random bytes using the Cloud KMS randomness source in the @@ -3968,7 +4084,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: cloudkms.projects.locations.list @@ -4008,7 +4124,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets information about a location. operationId: cloudkms.projects.locations.get @@ -4040,7 +4156,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4080,7 +4196,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyHandles: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Creates a new KeyHandle, triggering the provisioning of a new CryptoKey @@ -4155,12 +4271,21 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyHandles/{keyHandlesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns the KeyHandle. operationId: cloudkms.projects.locations.keyHandles.get @@ -4197,7 +4322,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ekmConnections: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists EkmConnections. operationId: cloudkms.projects.locations.ekmConnections.list @@ -4285,7 +4410,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns metadata for a given EkmConnection. operationId: cloudkms.projects.locations.ekmConnections.get @@ -4367,7 +4492,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}:verifyConnectivity: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Verifies that Cloud KMS can successfully connect to the external key @@ -4409,7 +4534,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4454,7 +4579,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4498,7 +4623,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4545,7 +4670,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists KeyRings. operationId: cloudkms.projects.locations.keyRings.list @@ -4633,7 +4758,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns metadata for a given KeyRing. operationId: cloudkms.projects.locations.keyRings.get @@ -4670,7 +4795,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4715,7 +4840,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4759,7 +4884,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4806,7 +4931,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists CryptoKeys. operationId: cloudkms.projects.locations.keyRings.cryptoKeys.list @@ -4914,7 +5039,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Returns metadata for a given CryptoKey, as well as its primary @@ -5008,7 +5133,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Update the version of a CryptoKey that will be used in Encrypt. Returns @@ -5057,7 +5182,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Encrypts data, so that it can only be recovered by a call to Decrypt. @@ -5106,7 +5231,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Decrypts data that was protected by Encrypt. The CryptoKey.purpose must @@ -5155,7 +5280,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5205,7 +5330,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5254,7 +5379,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5306,7 +5431,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists CryptoKeyVersions. operationId: cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list @@ -5416,7 +5541,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns metadata for a given CryptoKeyVersion. operationId: cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get @@ -5521,7 +5646,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}/publicKey: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Returns the public key for the given CryptoKeyVersion. The @@ -5571,7 +5696,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions:import: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Import wrapped key material into a CryptoKeyVersion. All requests must @@ -5623,7 +5748,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Schedule a CryptoKeyVersion for destruction. Upon calling this method, @@ -5683,7 +5808,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon @@ -5739,7 +5864,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:rawEncrypt: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Encrypts data using portable cryptographic primitives. Most users should @@ -5795,7 +5920,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:rawDecrypt: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Decrypts data that was originally encrypted using a raw cryptographic @@ -5850,7 +5975,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:asymmetricSign: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Signs data using a CryptoKeyVersion with CryptoKey.purpose @@ -5906,7 +6031,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:asymmetricDecrypt: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Decrypts data that was encrypted with a public key retrieved from @@ -5962,7 +6087,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:macSign: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, @@ -6018,7 +6143,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:macVerify: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, @@ -6074,7 +6199,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists ImportJobs. operationId: cloudkms.projects.locations.keyRings.importJobs.list @@ -6174,7 +6299,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns metadata for a given ImportJob. operationId: cloudkms.projects.locations.keyRings.importJobs.get @@ -6216,7 +6341,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6266,7 +6391,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6315,7 +6440,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6367,7 +6492,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6407,7 +6532,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6446,7 +6571,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml index 842c2cfd..8e288b20 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudprofiler.yaml @@ -7,8 +7,8 @@ info: title: Cloud Profiler API description: Manages continuous profiling information. version: v2 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/profiler/ servers: @@ -314,16 +314,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1profiles/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.profiles - list: - operation: *ref_1 - response: *ref_2 patch: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1profiles~1{profilesId}/patch' @@ -337,6 +334,7 @@ components: - $ref: '#/components/x-stackQL-resources/profiles/methods/create' update: - $ref: '#/components/x-stackQL-resources/profiles/methods/patch' + replace: [] delete: [] profiles_offline: id: google.cloudprofiler.profiles_offline @@ -355,10 +353,11 @@ components: - $ref: >- #/components/x-stackQL-resources/profiles_offline/methods/create_offline update: [] + replace: [] delete: [] paths: /v2/projects/{projectsId}/profiles: - parameters: &ref_3 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -458,7 +457,7 @@ paths: schema: type: string /v2/projects/{projectsId}/profiles:createOffline: - parameters: *ref_3 + parameters: *ref_1 post: description: >- CreateOfflineProfile creates a new profile resource in the offline mode. @@ -500,7 +499,7 @@ paths: schema: type: string /v2/projects/{projectsId}/profiles/{profilesId}: - parameters: *ref_3 + parameters: *ref_1 patch: description: >- UpdateProfile updates the profile bytes and labels on the profile diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml index 8fc9b7c3..643c4b78 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudresourcemanager.yaml @@ -9,8 +9,8 @@ info: Creates, reads, and updates metadata for Google Cloud Platform resource containers. version: v3 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240829' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/resource-manager servers: @@ -1669,16 +1669,13 @@ components: name: liens title: Liens methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v3~1liens/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.liens - list: - operation: *ref_1 - response: *ref_2 create: operation: $ref: '#/paths/~1v3~1liens/post' @@ -1704,6 +1701,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/liens/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/liens/methods/delete' operations: @@ -1722,6 +1720,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] + replace: [] delete: [] folders: id: google.cloudresourcemanager.folders @@ -1746,16 +1745,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v3~1folders/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.folders - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: '#/paths/~1v3~1folders/post' @@ -1788,6 +1784,7 @@ components: - $ref: '#/components/x-stackQL-resources/folders/methods/create' update: - $ref: '#/components/x-stackQL-resources/folders/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/folders/methods/delete' folders_iam_policies: @@ -1795,16 +1792,13 @@ components: name: folders_iam_policies title: Folders_iam_policies methods: - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: '#/paths/~1v3~1folders~1{foldersId}:getIamPolicy/post' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 set_iam_policy: operation: $ref: '#/paths/~1v3~1folders~1{foldersId}:setIamPolicy/post' @@ -1823,6 +1817,9 @@ components: #/components/x-stackQL-resources/folders_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/folders_iam_policies/methods/set_iam_policy delete: [] organizations: id: google.cloudresourcemanager.organizations @@ -1846,22 +1843,20 @@ components: - $ref: '#/components/x-stackQL-resources/organizations/methods/get' insert: [] update: [] + replace: [] delete: [] organizations_iam_policies: id: google.cloudresourcemanager.organizations_iam_policies name: organizations_iam_policies title: Organizations_iam_policies methods: - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: '#/paths/~1v3~1organizations~1{organizationsId}:getIamPolicy/post' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 set_iam_policy: operation: $ref: '#/paths/~1v3~1organizations~1{organizationsId}:setIamPolicy/post' @@ -1881,6 +1876,9 @@ components: #/components/x-stackQL-resources/organizations_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/organizations_iam_policies/methods/set_iam_policy delete: [] projects: id: google.cloudresourcemanager.projects @@ -1905,16 +1903,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: '#/paths/~1v3~1projects/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.projects - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: '#/paths/~1v3~1projects/post' @@ -1947,6 +1942,7 @@ components: - $ref: '#/components/x-stackQL-resources/projects/methods/create' update: - $ref: '#/components/x-stackQL-resources/projects/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/projects/methods/delete' projects_iam_policies: @@ -1954,16 +1950,13 @@ components: name: projects_iam_policies title: Projects_iam_policies methods: - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}:getIamPolicy/post' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 set_iam_policy: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}:setIamPolicy/post' @@ -1982,22 +1975,22 @@ components: #/components/x-stackQL-resources/projects_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/projects_iam_policies/methods/set_iam_policy delete: [] tag_bindings: id: google.cloudresourcemanager.tag_bindings name: tag_bindings title: Tag_bindings methods: - _list: - operation: &ref_13 + list: + operation: $ref: '#/paths/~1v3~1tagBindings/get' - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tagBindings - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: '#/paths/~1v3~1tagBindings/post' @@ -2016,6 +2009,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/tag_bindings/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tag_bindings/methods/delete' effective_tags: @@ -2023,37 +2017,32 @@ components: name: effective_tags title: Effective_tags methods: - _list: - operation: &ref_15 + list: + operation: $ref: '#/paths/~1v3~1effectiveTags/get' - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.effectiveTags - list: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/effective_tags/methods/list' insert: [] update: [] + replace: [] delete: [] tag_keys: id: google.cloudresourcemanager.tag_keys name: tag_keys title: Tag_keys methods: - _list: - operation: &ref_17 + list: + operation: $ref: '#/paths/~1v3~1tagKeys/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tagKeys - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: '#/paths/~1v3~1tagKeys/post' @@ -2086,6 +2075,7 @@ components: - $ref: '#/components/x-stackQL-resources/tag_keys/methods/create' update: - $ref: '#/components/x-stackQL-resources/tag_keys/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tag_keys/methods/delete' tag_keys_namespaced: @@ -2105,22 +2095,20 @@ components: #/components/x-stackQL-resources/tag_keys_namespaced/methods/get_namespaced insert: [] update: [] + replace: [] delete: [] tag_keys_iam_policies: id: google.cloudresourcemanager.tag_keys_iam_policies name: tag_keys_iam_policies title: Tag_keys_iam_policies methods: - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: '#/paths/~1v3~1tagKeys~1{tagKeysId}:getIamPolicy/post' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 set_iam_policy: operation: $ref: '#/paths/~1v3~1tagKeys~1{tagKeysId}:setIamPolicy/post' @@ -2139,22 +2127,22 @@ components: #/components/x-stackQL-resources/tag_keys_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/tag_keys_iam_policies/methods/set_iam_policy delete: [] tag_values: id: google.cloudresourcemanager.tag_values name: tag_values title: Tag_values methods: - _list: - operation: &ref_21 + list: + operation: $ref: '#/paths/~1v3~1tagValues/get' - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tagValues - list: - operation: *ref_21 - response: *ref_22 create: operation: $ref: '#/paths/~1v3~1tagValues/post' @@ -2187,6 +2175,7 @@ components: - $ref: '#/components/x-stackQL-resources/tag_values/methods/create' update: - $ref: '#/components/x-stackQL-resources/tag_values/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tag_values/methods/delete' tag_values_namespaced: @@ -2206,22 +2195,20 @@ components: #/components/x-stackQL-resources/tag_values_namespaced/methods/get_namespaced insert: [] update: [] + replace: [] delete: [] tag_values_iam_policies: id: google.cloudresourcemanager.tag_values_iam_policies name: tag_values_iam_policies title: Tag_values_iam_policies methods: - _get_iam_policy: - operation: &ref_23 + get_iam_policy: + operation: $ref: '#/paths/~1v3~1tagValues~1{tagValuesId}:getIamPolicy/post' - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_23 - response: *ref_24 set_iam_policy: operation: $ref: '#/paths/~1v3~1tagValues~1{tagValuesId}:setIamPolicy/post' @@ -2240,6 +2227,9 @@ components: #/components/x-stackQL-resources/tag_values_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/tag_values_iam_policies/methods/set_iam_policy delete: [] tag_holds: id: google.cloudresourcemanager.tag_holds @@ -2252,16 +2242,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_25 + list: + operation: $ref: '#/paths/~1v3~1tagValues~1{tagValuesId}~1tagHolds/get' - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tagHolds - list: - operation: *ref_25 - response: *ref_26 delete: operation: $ref: >- @@ -2275,11 +2262,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/tag_holds/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tag_holds/methods/delete' paths: /v3/liens: - parameters: &ref_27 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2359,7 +2347,7 @@ paths: $ref: '#/components/schemas/Lien' parameters: [] /v3/liens/{liensId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Retrieve a Lien by `name`. Callers of this method will require @@ -2418,7 +2406,7 @@ paths: schema: type: string /v3/operations/{operationsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2448,7 +2436,7 @@ paths: schema: type: string /v3/folders/{foldersId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Retrieves a folder identified by the supplied resource name. Valid @@ -2549,7 +2537,7 @@ paths: schema: type: string /v3/folders: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists the folders that are direct descendants of supplied parent @@ -2634,7 +2622,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: [] /v3/folders:search: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Search for folders that match specific filter criteria. `search()` @@ -2674,7 +2662,7 @@ paths: schema: type: string /v3/folders/{foldersId}:move: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Moves a folder under a new resource parent. Returns an `Operation` which @@ -2715,7 +2703,7 @@ paths: schema: type: string /v3/folders/{foldersId}:undelete: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Cancels the deletion request for a folder. This method may be called on @@ -2750,7 +2738,7 @@ paths: schema: type: string /v3/folders/{foldersId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for a folder. The returned policy may be @@ -2787,7 +2775,7 @@ paths: schema: type: string /v3/folders/{foldersId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on a folder, replacing any existing @@ -2820,7 +2808,7 @@ paths: schema: type: string /v3/folders/{foldersId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified folder. The @@ -2852,7 +2840,7 @@ paths: schema: type: string /v3/organizations/{organizationsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Fetches an organization resource identified by the specified resource @@ -2881,7 +2869,7 @@ paths: schema: type: string /v3/organizations:search: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Searches organization resources that are visible to the user and satisfy @@ -2923,7 +2911,7 @@ paths: schema: type: string /v3/organizations/{organizationsId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for an organization resource. The policy @@ -2961,7 +2949,7 @@ paths: schema: type: string /v3/organizations/{organizationsId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on an organization resource. Replaces any @@ -2994,7 +2982,7 @@ paths: schema: type: string /v3/organizations/{organizationsId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns the permissions that a caller has on the specified organization. @@ -3030,7 +3018,7 @@ paths: schema: type: string /v3/projects/{projectsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Retrieves the project identified by the specified `name` (for example, @@ -3129,7 +3117,7 @@ paths: schema: type: string /v3/projects: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists projects that are direct children of the specified folder or @@ -3200,7 +3188,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: [] /v3/projects:search: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Search for projects that the caller has the @@ -3242,7 +3230,7 @@ paths: type: integer format: int32 /v3/projects/{projectsId}:move: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Move a project to another place in your resource hierarchy, under a new @@ -3279,7 +3267,7 @@ paths: schema: type: string /v3/projects/{projectsId}:undelete: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Restores the project identified by the specified `name` (for example, @@ -3312,7 +3300,7 @@ paths: schema: type: string /v3/projects/{projectsId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns the IAM access control policy for the specified project, in the @@ -3347,7 +3335,7 @@ paths: schema: type: string /v3/projects/{projectsId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the IAM access control policy for the specified project, in the @@ -3404,7 +3392,7 @@ paths: schema: type: string /v3/projects/{projectsId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified project, in the @@ -3438,7 +3426,7 @@ paths: schema: type: string /v3/tagBindings: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists the TagBindings for the given Google Cloud resource, as specified @@ -3502,7 +3490,7 @@ paths: schema: type: boolean /v3/tagBindings/{tagBindingsId}: - parameters: *ref_27 + parameters: *ref_1 delete: description: Deletes a TagBinding. operationId: cloudresourcemanager.tagBindings.delete @@ -3525,7 +3513,7 @@ paths: schema: type: string /v3/effectiveTags: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Return a list of effective tags for the given Google Cloud resource, as @@ -3562,7 +3550,7 @@ paths: schema: type: string /v3/tagKeys: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists all TagKeys for a parent resource. operationId: cloudresourcemanager.tagKeys.list @@ -3626,7 +3614,7 @@ paths: schema: type: boolean /v3/tagKeys/{tagKeysId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the @@ -3721,7 +3709,7 @@ paths: schema: type: string /v3/tagKeys/namespaced: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Retrieves a TagKey by its namespaced name. This method will return @@ -3750,7 +3738,7 @@ paths: schema: type: string /v3/tagKeys/{tagKeysId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for a TagKey. The returned policy may be @@ -3787,7 +3775,7 @@ paths: schema: type: string /v3/tagKeys/{tagKeysId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on a TagKey, replacing any existing @@ -3820,7 +3808,7 @@ paths: schema: type: string /v3/tagKeys/{tagKeysId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified TagKey. The @@ -3852,7 +3840,7 @@ paths: schema: type: string /v3/tagValues: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists all TagValues for a specific TagKey. operationId: cloudresourcemanager.tagValues.list @@ -3916,7 +3904,7 @@ paths: schema: type: boolean /v3/tagValues/{tagValuesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Retrieves a TagValue. This method will return `PERMISSION_DENIED` if the @@ -4011,7 +3999,7 @@ paths: schema: type: string /v3/tagValues/namespaced: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Retrieves a TagValue by its namespaced name. This method will return @@ -4040,7 +4028,7 @@ paths: schema: type: string /v3/tagValues/{tagValuesId}:getIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Gets the access control policy for a TagValue. The returned policy may @@ -4078,7 +4066,7 @@ paths: schema: type: string /v3/tagValues/{tagValuesId}:setIamPolicy: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Sets the access control policy on a TagValue, replacing any existing @@ -4111,7 +4099,7 @@ paths: schema: type: string /v3/tagValues/{tagValuesId}:testIamPermissions: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified TagValue. The @@ -4143,7 +4131,7 @@ paths: schema: type: string /v3/tagValues/{tagValuesId}/tagHolds: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same @@ -4215,7 +4203,7 @@ paths: schema: type: string /v3/tagValues/{tagValuesId}/tagHolds/{tagHoldsId}: - parameters: *ref_27 + parameters: *ref_1 delete: description: Deletes a TagHold. operationId: cloudresourcemanager.tagValues.tagHolds.delete diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml index 2cc257a4..d181ad22 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudscheduler.yaml @@ -7,8 +7,8 @@ info: title: Cloud Scheduler API description: Creates and manages jobs run on a regular recurring schedule. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240827' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/scheduler/ servers: @@ -808,16 +808,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -830,23 +827,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] jobs: id: google.cloudscheduler.jobs name: jobs title: Jobs methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: >- @@ -904,11 +899,12 @@ components: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' update: - $ref: '#/components/x-stackQL-resources/jobs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -955,7 +951,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets information about a location. operationId: cloudscheduler.projects.locations.get @@ -983,7 +979,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists jobs. operationId: cloudscheduler.projects.locations.jobs.list @@ -1051,7 +1047,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets a job. operationId: cloudscheduler.projects.locations.jobs.get @@ -1162,7 +1158,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:pause: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Pauses a job. If a job is paused then the system will stop executing the @@ -1204,7 +1200,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:resume: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Resume a job. This method reenables a job after it has been @@ -1246,7 +1242,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Forces a job to run now. When this method is called, Cloud Scheduler diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml index 4fa372b4..7ba4714f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudshell.yaml @@ -9,8 +9,8 @@ info: Allows users to start, configure, and connect to interactive shell sessions running in the cloud. version: v1 - x-discovery-doc-revision: '20240528' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/shell/docs/ servers: @@ -478,16 +478,13 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/get' @@ -512,6 +509,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' environments: @@ -544,6 +542,7 @@ components: - $ref: '#/components/x-stackQL-resources/environments/methods/get' insert: [] update: [] + replace: [] delete: [] environments_public_key: id: google.cloudshell.environments_public_key @@ -566,12 +565,17 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/environments_public_key/methods/add_public_key update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/environments_public_key/methods/remove_public_key paths: /v1/operations: - parameters: &ref_3 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -615,7 +619,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -666,7 +670,7 @@ paths: schema: type: string /v1/operations/{operationsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -703,7 +707,7 @@ paths: schema: type: string /v1/users/{usersId}/environments/{environmentsId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets an environment. Returns NOT_FOUND if the environment does not @@ -733,7 +737,7 @@ paths: schema: type: string /v1/users/{usersId}/environments/{environmentsId}:start: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts an existing environment, allowing clients to connect to it. The @@ -772,7 +776,7 @@ paths: schema: type: string /v1/users/{usersId}/environments/{environmentsId}:authorize: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Sends OAuth credentials to a running environment on behalf of a user. @@ -809,7 +813,7 @@ paths: schema: type: string /v1/users/{usersId}/environments/{environmentsId}:addPublicKey: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Adds a public SSH key to an environment, allowing clients with the @@ -846,7 +850,7 @@ paths: schema: type: string /v1/users/{usersId}/environments/{environmentsId}:removePublicKey: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Removes a public SSH key from an environment. Clients will no longer be diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml index 6887afd4..75ec494e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudsupport.yaml @@ -9,8 +9,8 @@ info: Manages Google Cloud technical support cases for Customer Care support offerings. version: v2 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/support/docs/apis servers: @@ -36,771 +36,802 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ContentTypeInfo: + WorkflowOperationMetadata: type: object properties: - bestGuess: - description: '# gdata.* are outside protos with mising documentation' + operationAction: type: string - fromBytes: - description: '# gdata.* are outside protos with mising documentation' + enumDescriptions: + - Operation action is not specified. + - Operation pertains to the creation of a new support account. + - Operation pertains to the updating of an existing support account. + - >- + Operation pertains to the purchasing of a support plan that may + either create or update a support account. + enum: + - OPERATION_ACTION_UNSPECIFIED + - CREATE_SUPPORT_ACCOUNT + - UPDATE_SUPPORT_ACCOUNT + - PURCHASE_SUPPORT_ACCOUNT + description: The type of action the operation is classified as. + namespace: + description: >- + The namespace that the job was scheduled in. Must be included in the + workflow metadata so the workflow status can be retrieved. type: string - fromHeader: + workflowOperationType: type: string - description: '# gdata.* are outside protos with mising documentation' - fromUrlPath: - description: '# gdata.* are outside protos with mising documentation' + description: Which version of the workflow service this operation came from. + enum: + - UNKNOWN_OPERATION_TYPE + - WORKFLOWS_V1 + - WORKFLOWS_V2 + enumDescriptions: + - Unknown version. + - Version 1. + - Version 2. + id: WorkflowOperationMetadata + description: Metadata about the operation. Used to lookup the current status. + CaseClassification: + id: CaseClassification + type: object + properties: + id: + description: >- + The unique ID for a classification. Must be specified for case + creation. To retrieve valid classification IDs for case creation, + use `caseClassifications.search`. Classification IDs returned by + `caseClassifications.search` are guaranteed to be valid for at least + 6 months. If a given classification is deactiveated, it will + immediately stop being returned. After 6 months, `case.create` + requests using the classification ID will fail. type: string - fromFileName: - description: '# gdata.* are outside protos with mising documentation' + displayName: type: string - description: '# gdata.* are outside protos with mising documentation' - id: ContentTypeInfo - DiffDownloadResponse: - description: '# gdata.* are outside protos with mising documentation' - id: DiffDownloadResponse + description: >- + A display name for the classification. The display name is not + static and can change. To uniquely and consistently identify + classifications, use the `CaseClassification.id` field. + description: >- + A Case Classification represents the topic that a case is about. It's + very important to use accurate classifications, because they're used to + route your cases to specialists who can help you. A classification + always has an ID that is its unique identifier. A valid ID is required + when creating a case. + DiffUploadResponse: type: object + description: '# gdata.* are outside protos with mising documentation' properties: - objectLocation: + originalObject: $ref: '#/components/schemas/CompositeMedia' description: '# gdata.* are outside protos with mising documentation' - CloseCaseRequest: - properties: {} - description: The request message for the CloseCase endpoint. + objectVersion: + description: '# gdata.* are outside protos with mising documentation' + type: string + id: DiffUploadResponse + DiffVersionResponse: type: object - id: CloseCaseRequest - DiffChecksumsResponse: + description: '# gdata.* are outside protos with mising documentation' properties: + objectVersion: + type: string + description: '# gdata.* are outside protos with mising documentation' objectSizeBytes: + format: int64 description: '# gdata.* are outside protos with mising documentation' type: string - format: int64 - objectLocation: - $ref: '#/components/schemas/CompositeMedia' + id: DiffVersionResponse + SearchCaseClassificationsResponse: + properties: + caseClassifications: + description: The classifications retrieved. + type: array + items: + $ref: '#/components/schemas/CaseClassification' + nextPageToken: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `caseClassifications.list` + requests. If unspecified, there are no more results to retrieve. + type: string + type: object + description: The response message for SearchCaseClassifications endpoint. + id: SearchCaseClassificationsResponse + CompositeMedia: + type: object + description: '# gdata.* are outside protos with mising documentation' + id: CompositeMedia + properties: + cosmoBinaryReference: + format: byte + type: string description: '# gdata.* are outside protos with mising documentation' - objectVersion: + objectId: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/ObjectId' + crc32cHash: + format: uint32 + description: '# gdata.* are outside protos with mising documentation' + type: integer + blobstore2Info: + $ref: '#/components/schemas/Blobstore2Info' description: '# gdata.* are outside protos with mising documentation' + path: type: string - chunkSizeBytes: description: '# gdata.* are outside protos with mising documentation' + blobRef: + type: string + deprecated: true + description: '# gdata.* are outside protos with mising documentation' + format: byte + sha1Hash: + description: '# gdata.* are outside protos with mising documentation' + format: byte + type: string + md5Hash: + type: string + format: byte + description: '# gdata.* are outside protos with mising documentation' + length: type: string format: int64 - checksumsLocation: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - id: DiffChecksumsResponse - description: '# gdata.* are outside protos with mising documentation' + inline: + type: string + description: '# gdata.* are outside protos with mising documentation' + format: byte + referenceType: + enum: + - PATH + - BLOB_REF + - INLINE + - BIGSTORE_REF + - COSMO_BINARY_REFERENCE + type: string + enumDescriptions: + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + description: '# gdata.* are outside protos with mising documentation' + CloseCaseRequest: + description: The request message for the CloseCase endpoint. type: object - CaseClassification: + properties: {} + id: CloseCaseRequest + ListCommentsResponse: + description: The response message for the ListComments endpoint. + properties: + comments: + description: List of the comments associated with the case. + items: + $ref: '#/components/schemas/Comment' + type: array + nextPageToken: + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.comments.list` requests. If + unspecified, there are no more results to retrieve. + type: string + id: ListCommentsResponse + type: object + Comment: type: object description: >- - A Case Classification represents the topic that a case is about. It's - very important to use accurate classifications, because they're used to - route your cases to specialists who can help you. A classification - always has an ID that is its unique identifier. A valid ID is required - when creating a case. - id: CaseClassification + A comment associated with a support case. Case comments are the primary + way for Google Support to communicate with a user who has opened a case. + When a user responds to Google Support, the user's responses also appear + as comments. properties: - displayName: + plainTextBody: type: string + readOnly: true description: >- - A display name for the classification. The display name is not - static and can change. To uniquely and consistently identify - classifications, use the `CaseClassification.id` field. - id: + Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` + field. This field is only present for legacy reasons. + deprecated: true + body: + description: The full comment body. Maximum of 12800 characters. + type: string + createTime: + format: google-datetime + description: Output only. The time when the comment was created. + readOnly: true type: string + name: + description: Output only. Identifier. The resource name of the comment. + type: string + readOnly: true + creator: + readOnly: true description: >- - The unique ID for a classification. Must be specified for case - creation. To retrieve valid classification IDs for case creation, - use `caseClassifications.search`. Classification IDs returned by - `caseClassifications.search` are guaranteed to be valid for at least - 6 months. If a given classification is deactiveated, it will - immediately stop being returned. After 6 months, `case.create` - requests using the classification ID will fail. + Output only. The user or Google Support agent who created the + comment. + $ref: '#/components/schemas/Actor' + id: Comment ListCasesResponse: - description: The response message for the ListCases endpoint. id: ListCasesResponse + type: object + description: The response message for the ListCases endpoint. properties: cases: - items: - $ref: '#/components/schemas/Case' type: array description: >- The list of cases associated with the parent after any filters have been applied. + items: + $ref: '#/components/schemas/Case' nextPageToken: - type: string description: >- A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.list` requests. If unspecified, there are no more results to retrieve. + type: string + EscalateCaseRequest: + id: EscalateCaseRequest type: object - Escalation: - id: Escalation - description: An escalation of a support case. - properties: - reason: - enum: - - REASON_UNSPECIFIED - - RESOLUTION_TIME - - TECHNICAL_EXPERTISE - - BUSINESS_IMPACT - type: string - enumDescriptions: - - >- - The escalation reason is in an unknown state or has not been - specified. - - The case is taking too long to resolve. - - >- - The support agent does not have the expertise required to - successfully resolve the issue. - - The issue is having a significant business impact. - description: Required. The reason why the Case is being escalated. - justification: - description: >- - Required. A free text description to accompany the `reason` field - above. Provides additional context on why the case is being - escalated. - type: string - type: object - EscalateCaseRequest: + description: The request message for the EscalateCase endpoint. properties: escalation: $ref: '#/components/schemas/Escalation' description: The escalation information to be sent with the escalation request. - description: The request message for the EscalateCase endpoint. + Actor: type: object - id: EscalateCaseRequest - SearchCaseClassificationsResponse: - description: The response message for SearchCaseClassifications endpoint. properties: - caseClassifications: - items: - $ref: '#/components/schemas/CaseClassification' - type: array - description: The classifications retrieved. - nextPageToken: - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `caseClassifications.list` - requests. If unspecified, there are no more results to retrieve. + email: + deprecated: true type: string - type: object - id: SearchCaseClassificationsResponse - Case: - description: >- - A Case is an object that contains the details of a support case. It - contains fields for the time it was created, its priority, its - classification, and more. Cases can also have comments and attachments - that get added over time. A case is parented by a Google Cloud - organization or project. Organizations are identified by a number, so - the name of a case parented by an organization would look like this: ``` - organizations/123/cases/456 ``` Projects have two unique identifiers, an - ID and a number, and they look like this: ``` projects/abc/cases/456 ``` - ``` projects/123/cases/456 ``` You can use either of them when calling - the API. To learn more about project identifiers, see - [AIP-2510](https://google.aip.dev/cloud/2510). - id: Case - properties: - classification: - $ref: '#/components/schemas/CaseClassification' - description: The issue classification applicable to this case. - testCase: description: >- - Whether this case was created for internal API testing and should - not be acted on by the support team. - type: boolean - state: - enum: - - STATE_UNSPECIFIED - - NEW - - IN_PROGRESS_GOOGLE_SUPPORT - - ACTION_REQUIRED - - SOLUTION_PROVIDED - - CLOSED - enumDescriptions: - - Case is in an unknown state. - - >- - The case has been created but no one is assigned to work on it - yet. - - The case is currently being handled by Google support. - - Google is waiting for a response. - - A solution has been offered for the case, but it isn't yet closed. - - The case has been resolved. - readOnly: true - description: Output only. The current status of the support case. - type: string - subscriberEmailAddresses: - description: The email addresses to receive updates on this case. - items: - type: string - type: array - name: - type: string - description: The resource name for the case. - updateTime: - description: Output only. The time this case was last updated. + The email address of the actor. If not provided, it is inferred from + the credentials supplied during case creation. When a name is + provided, an email must also be provided. If the user is a Google + Support agent, this is obfuscated. This field is deprecated. Use + **username** field instead. + googleSupport: readOnly: true - format: google-datetime - type: string - createTime: + type: boolean + description: Output only. Whether the actor is a Google support actor. + username: type: string readOnly: true - format: google-datetime - description: Output only. The time this case was created. - languageCode: - type: string description: >- - The language the user has requested to receive support in. This - should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, - `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported - language is specified, this field defaults to English (en). Language - selection during case creation may affect your available support - options. For a list of supported languages and their support working - hours, see: - https://cloud.google.com/support/docs/language-working-hours + Output only. The username of the actor. It may look like an email or + other format provided by the identity provider. If not provided, it + is inferred from the credentials supplied. When a name is provided, + a username must also be provided. If the user is a Google Support + agent, this will not be set. displayName: - type: string - description: The short summary of the issue reported in this case. - contactEmail: - type: string description: >- - A user-supplied email address to send case update notifications for. - This should only be used in BYOID flows, where we cannot infer the - user's email address directly from their EUCs. - priority: + The name to display for the actor. If not provided, it is inferred + from credentials supplied during case creation. When an email is + provided, a display name must also be provided. This will be + obfuscated if the user is a Google Support agent. type: string - description: The priority of this case. - enumDescriptions: - - Priority is undefined or has not been set yet. - - Extreme impact on a production service. Service is hard down. - - >- - Critical impact on a production service. Service is currently - unusable. - - >- - Severe impact on a production service. Service is usable but - greatly impaired. - - >- - Medium impact on a production service. Service is available, but - moderately impaired. - - >- - General questions or minor issues. Production service is fully - available. - enum: - - PRIORITY_UNSPECIFIED - - P0 - - P1 - - P2 - - P3 - - P4 - description: + description: >- + An Actor represents an entity that performed an action. For example, an + actor could be a user who posted a comment on a support case, a user who + uploaded an attachment, or a service account that created a support + case. + id: Actor + ObjectId: + description: '# gdata.* are outside protos with mising documentation' + id: ObjectId + type: object + properties: + objectName: + description: '# gdata.* are outside protos with mising documentation' type: string - description: A broad description of the issue. - creator: - $ref: '#/components/schemas/Actor' - description: >- - The user who created the case. Note: The name and email will be - obfuscated if the case was created by Google Support. - escalated: - type: boolean - description: Whether the case is currently escalated. - timeZone: - description: >- - The timezone of the user who created the support case. It should be - in a format IANA recognizes: https://www.iana.org/time-zones. There - is no additional validation done by the API. + generation: + description: '# gdata.* are outside protos with mising documentation' type: string + format: int64 + bucketName: + type: string + description: '# gdata.* are outside protos with mising documentation' + DiffUploadRequest: type: object - WorkflowOperationMetadata: - description: Metadata about the operation. Used to lookup the current status. - id: WorkflowOperationMetadata properties: - workflowOperationType: - description: Which version of the workflow service this operation came from. - enum: - - UNKNOWN_OPERATION_TYPE - - WORKFLOWS_V1 - - WORKFLOWS_V2 - enumDescriptions: - - Unknown version. - - Version 1. - - Version 2. + objectVersion: type: string - namespace: + description: '# gdata.* are outside protos with mising documentation' + objectInfo: + $ref: '#/components/schemas/CompositeMedia' + description: '# gdata.* are outside protos with mising documentation' + checksumsInfo: + $ref: '#/components/schemas/CompositeMedia' + description: '# gdata.* are outside protos with mising documentation' + id: DiffUploadRequest + description: '# gdata.* are outside protos with mising documentation' + SearchCasesResponse: + type: object + properties: + cases: + type: array description: >- - The namespace that the job was scheduled in. Must be included in the - workflow metadata so the workflow status can be retrieved. - type: string - operationAction: - enumDescriptions: - - Operation action is not specified. - - Operation pertains to the creation of a new support account. - - Operation pertains to the updating of an existing support account. - - >- - Operation pertains to the purchasing of a support plan that may - either create or update a support account. - description: The type of action the operation is classified as. + The list of cases associated with the parent after any filters have + been applied. + items: + $ref: '#/components/schemas/Case' + nextPageToken: type: string - enum: - - OPERATION_ACTION_UNSPECIFIED - - CREATE_SUPPORT_ACCOUNT - - UPDATE_SUPPORT_ACCOUNT - - PURCHASE_SUPPORT_ACCOUNT + description: >- + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.search` requests. If + unspecified, there are no more results to retrieve. + id: SearchCasesResponse + description: The response message for the SearchCases endpoint. + Media: type: object - CompositeMedia: description: '# gdata.* are outside protos with mising documentation' - type: object - id: CompositeMedia + id: Media properties: - cosmoBinaryReference: + algorithm: + deprecated: true + description: '# gdata.* are outside protos with mising documentation' + type: string + path: type: string - format: byte description: '# gdata.* are outside protos with mising documentation' - referenceType: + contentType: description: '# gdata.* are outside protos with mising documentation' - enumDescriptions: - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' type: string - enum: - - PATH - - BLOB_REF - - INLINE - - BIGSTORE_REF - - COSMO_BINARY_REFERENCE sha1Hash: - type: string - description: '# gdata.* are outside protos with mising documentation' format: byte - crc32cHash: - type: integer - format: uint32 - description: '# gdata.* are outside protos with mising documentation' - blobstore2Info: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/Blobstore2Info' - length: type: string + token: description: '# gdata.* are outside protos with mising documentation' - format: int64 - blobRef: - deprecated: true type: string - description: '# gdata.* are outside protos with mising documentation' - format: byte - objectId: - $ref: '#/components/schemas/ObjectId' - description: '# gdata.* are outside protos with mising documentation' md5Hash: type: string format: byte description: '# gdata.* are outside protos with mising documentation' - inline: + bigstoreObjectRef: format: byte description: '# gdata.* are outside protos with mising documentation' + deprecated: true type: string - path: - description: '# gdata.* are outside protos with mising documentation' - type: string - DiffUploadRequest: - type: object - id: DiffUploadRequest - description: '# gdata.* are outside protos with mising documentation' - properties: - checksumsInfo: - $ref: '#/components/schemas/CompositeMedia' + crc32cHash: + type: integer + format: uint32 description: '# gdata.* are outside protos with mising documentation' - objectInfo: - $ref: '#/components/schemas/CompositeMedia' + diffVersionResponse: description: '# gdata.* are outside protos with mising documentation' - objectVersion: + $ref: '#/components/schemas/DiffVersionResponse' + sha256Hash: + format: byte description: '# gdata.* are outside protos with mising documentation' type: string - SearchCasesResponse: - properties: - nextPageToken: - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.search` requests. If - unspecified, there are no more results to retrieve. - type: string - cases: - description: >- - The list of cases associated with the parent after any filters have - been applied. + compositeMedia: + description: '# gdata.* are outside protos with mising documentation' items: - $ref: '#/components/schemas/Case' + $ref: '#/components/schemas/CompositeMedia' type: array - description: The response message for the SearchCases endpoint. - type: object - id: SearchCasesResponse - Actor: - type: object - description: >- - An Actor represents an entity that performed an action. For example, an - actor could be a user who posted a comment on a support case, a user who - uploaded an attachment, or a service account that created a support - case. - properties: - email: - type: string - description: >- - The email address of the actor. If not provided, it is inferred from - the credentials supplied during case creation. When a name is - provided, an email must also be provided. If the user is a Google - Support agent, this is obfuscated. This field is deprecated. Use - **username** field instead. + blobRef: + description: '# gdata.* are outside protos with mising documentation' + format: byte deprecated: true - googleSupport: + type: string + diffUploadRequest: + $ref: '#/components/schemas/DiffUploadRequest' + description: '# gdata.* are outside protos with mising documentation' + hashVerified: type: boolean - readOnly: true - description: Output only. Whether the actor is a Google support actor. - username: - readOnly: true - description: >- - Output only. The username of the actor. It may look like an email or - other format provided by the identity provider. If not provided, it - is inferred from the credentials supplied. When a name is provided, - a username must also be provided. If the user is a Google Support - agent, this will not be set. + description: '# gdata.* are outside protos with mising documentation' + hash: type: string - displayName: + deprecated: true + description: '# gdata.* are outside protos with mising documentation' + mediaId: type: string - description: >- - The name to display for the actor. If not provided, it is inferred - from credentials supplied during case creation. When an email is - provided, a display name must also be provided. This will be - obfuscated if the user is a Google Support agent. - id: Actor - CreateAttachmentRequest: - description: The request message for the CreateAttachment endpoint. - id: CreateAttachmentRequest - properties: - attachment: - description: Required. The attachment to be created. - $ref: '#/components/schemas/Attachment' - type: object - DiffUploadResponse: - description: '# gdata.* are outside protos with mising documentation' - type: object - id: DiffUploadResponse - properties: - originalObject: + format: byte description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/CompositeMedia' - objectVersion: + diffDownloadResponse: + $ref: '#/components/schemas/DiffDownloadResponse' description: '# gdata.* are outside protos with mising documentation' + inline: + format: byte type: string - ListCommentsResponse: - type: object - properties: - nextPageToken: - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.comments.list` requests. If - unspecified, there are no more results to retrieve. + description: '# gdata.* are outside protos with mising documentation' + length: type: string - comments: - description: List of the comments associated with the case. - type: array - items: - $ref: '#/components/schemas/Comment' - description: The response message for the ListComments endpoint. - id: ListCommentsResponse - Blobstore2Info: - description: '# gdata.* are outside protos with mising documentation' - id: Blobstore2Info - properties: - blobGeneration: + description: '# gdata.* are outside protos with mising documentation' format: int64 + cosmoBinaryReference: + type: string + format: byte + description: '# gdata.* are outside protos with mising documentation' + referenceType: + type: string + enumDescriptions: + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + - '# gdata.* are outside protos with mising documentation' + enum: + - PATH + - BLOB_REF + - INLINE + - GET_MEDIA + - COMPOSITE_MEDIA + - BIGSTORE_REF + - DIFF_VERSION_RESPONSE + - DIFF_CHECKSUMS_RESPONSE + - DIFF_DOWNLOAD_RESPONSE + - DIFF_UPLOAD_REQUEST + - DIFF_UPLOAD_RESPONSE + - COSMO_BINARY_REFERENCE + - ARBITRARY_BYTES description: '# gdata.* are outside protos with mising documentation' - type: string - readToken: + downloadParameters: + $ref: '#/components/schemas/DownloadParameters' description: '# gdata.* are outside protos with mising documentation' + filename: type: string - blobId: + description: '# gdata.* are outside protos with mising documentation' + timestamp: type: string + format: uint64 description: '# gdata.* are outside protos with mising documentation' - downloadReadHandle: + blobstore2Info: + $ref: '#/components/schemas/Blobstore2Info' description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string - uploadMetadataContainer: - format: byte - type: string + diffChecksumsResponse: + description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/DiffChecksumsResponse' + isPotentialRetry: + description: '# gdata.* are outside protos with mising documentation' + type: boolean + objectId: + $ref: '#/components/schemas/ObjectId' + description: '# gdata.* are outside protos with mising documentation' + diffUploadResponse: + $ref: '#/components/schemas/DiffUploadResponse' description: '# gdata.* are outside protos with mising documentation' + contentTypeInfo: + $ref: '#/components/schemas/ContentTypeInfo' + description: '# gdata.* are outside protos with mising documentation' + Blobstore2Info: + id: Blobstore2Info + description: '# gdata.* are outside protos with mising documentation' type: object - ListAttachmentsResponse: properties: - attachments: - description: The list of attachments associated with a case. - items: - $ref: '#/components/schemas/Attachment' - type: array - nextPageToken: - description: >- - A token to retrieve the next page of results. Set this in the - `page_token` field of subsequent `cases.attachments.list` requests. - If unspecified, there are no more results to retrieve. + uploadMetadataContainer: + description: '# gdata.* are outside protos with mising documentation' type: string - id: ListAttachmentsResponse - description: The response message for the ListAttachments endpoint. - type: object - ObjectId: - id: ObjectId - properties: - generation: + format: byte + downloadReadHandle: + format: byte description: '# gdata.* are outside protos with mising documentation' - format: int64 type: string - bucketName: + blobId: description: '# gdata.* are outside protos with mising documentation' type: string - objectName: + blobGeneration: + format: int64 + description: '# gdata.* are outside protos with mising documentation' type: string + readToken: description: '# gdata.* are outside protos with mising documentation' - description: '# gdata.* are outside protos with mising documentation' + type: string + Case: type: object - Attachment: description: >- - An Attachment contains metadata about a file that was uploaded to a case - - it is NOT a file itself. That being said, the name of an Attachment - object can be used to download its accompanying file through the - `media.download` endpoint. While attachments can be uploaded in the - console at the same time as a comment, they're associated on a "case" - level, not a "comment" level. - type: object - id: Attachment + A Case is an object that contains the details of a support case. It + contains fields for the time it was created, its priority, its + classification, and more. Cases can also have comments and attachments + that get added over time. A case is parented by a Google Cloud + organization or project. Organizations are identified by a number, so + the name of a case parented by an organization would look like this: ``` + organizations/123/cases/456 ``` Projects have two unique identifiers, an + ID and a number, and they look like this: ``` projects/abc/cases/456 ``` + ``` projects/123/cases/456 ``` You can use either of them when calling + the API. To learn more about project identifiers, see + [AIP-2510](https://google.aip.dev/cloud/2510). + id: Case properties: - mimeType: - readOnly: true - description: Output only. The MIME type of the attachment (e.g. text/plain). - type: string - sizeBytes: - readOnly: true - type: string - format: int64 - description: Output only. The size of the attachment in bytes. - name: - description: Output only. The resource name of the attachment. - type: string - readOnly: true - filename: + timeZone: type: string - description: The filename of the attachment (e.g. `"graph.jpg"`). + description: >- + The timezone of the user who created the support case. It should be + in a format IANA recognizes: https://www.iana.org/time-zones. There + is no additional validation done by the API. + subscriberEmailAddresses: + description: The email addresses to receive updates on this case. + type: array + items: + type: string + creator: + $ref: '#/components/schemas/Actor' + description: >- + The user who created the case. Note: The name and email will be + obfuscated if the case was created by Google Support. createTime: - description: Output only. The time at which the attachment was created. - readOnly: true format: google-datetime type: string - creator: readOnly: true - description: >- - Output only. The user who uploaded the attachment. Note, the name - and email will be obfuscated if the attachment was uploaded by - Google support. - $ref: '#/components/schemas/Actor' - DownloadParameters: - type: object - id: DownloadParameters - description: '# gdata.* are outside protos with mising documentation' - properties: - ignoreRange: - description: '# gdata.* are outside protos with mising documentation' - type: boolean - allowGzipCompression: - type: boolean - description: '# gdata.* are outside protos with mising documentation' - Media: - id: Media - properties: - diffDownloadResponse: - $ref: '#/components/schemas/DiffDownloadResponse' - description: '# gdata.* are outside protos with mising documentation' - sha1Hash: - format: byte + description: Output only. The time this case was created. + name: + description: The resource name for the case. type: string - description: '# gdata.* are outside protos with mising documentation' - length: - format: int64 - description: '# gdata.* are outside protos with mising documentation' + languageCode: type: string - hash: - deprecated: true + description: >- + The language the user has requested to receive support in. This + should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, + `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported + language is specified, this field defaults to English (en). Language + selection during case creation may affect your available support + options. For a list of supported languages and their support working + hours, see: + https://cloud.google.com/support/docs/language-working-hours + testCase: + description: >- + Whether this case was created for internal API testing and should + not be acted on by the support team. + type: boolean + classification: + $ref: '#/components/schemas/CaseClassification' + description: The issue classification applicable to this case. + description: type: string - description: '# gdata.* are outside protos with mising documentation' - contentTypeInfo: - $ref: '#/components/schemas/ContentTypeInfo' - description: '# gdata.* are outside protos with mising documentation' - cosmoBinaryReference: - format: byte + description: A broad description of the issue. + priority: type: string - description: '# gdata.* are outside protos with mising documentation' - hashVerified: - description: '# gdata.* are outside protos with mising documentation' - type: boolean - compositeMedia: - description: '# gdata.* are outside protos with mising documentation' - items: - $ref: '#/components/schemas/CompositeMedia' - type: array - crc32cHash: - description: '# gdata.* are outside protos with mising documentation' - type: integer - format: uint32 - sha256Hash: + enumDescriptions: + - Priority is undefined or has not been set yet. + - Extreme impact on a production service. Service is hard down. + - >- + Critical impact on a production service. Service is currently + unusable. + - >- + Severe impact on a production service. Service is usable but + greatly impaired. + - >- + Medium impact on a production service. Service is available, but + moderately impaired. + - >- + General questions or minor issues. Production service is fully + available. + enum: + - PRIORITY_UNSPECIFIED + - P0 + - P1 + - P2 + - P3 + - P4 + description: The priority of this case. + state: + enum: + - STATE_UNSPECIFIED + - NEW + - IN_PROGRESS_GOOGLE_SUPPORT + - ACTION_REQUIRED + - SOLUTION_PROVIDED + - CLOSED + readOnly: true type: string - description: '# gdata.* are outside protos with mising documentation' - format: byte - objectId: - $ref: '#/components/schemas/ObjectId' - description: '# gdata.* are outside protos with mising documentation' - isPotentialRetry: - description: '# gdata.* are outside protos with mising documentation' + description: Output only. The current status of the support case. + enumDescriptions: + - Case is in an unknown state. + - >- + The case has been created but no one is assigned to work on it + yet. + - The case is currently being handled by Google support. + - Google is waiting for a response. + - A solution has been offered for the case, but it isn't yet closed. + - The case has been resolved. + escalated: type: boolean - mediaId: - description: '# gdata.* are outside protos with mising documentation' - format: byte - type: string - downloadParameters: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DownloadParameters' - diffChecksumsResponse: - $ref: '#/components/schemas/DiffChecksumsResponse' - description: '# gdata.* are outside protos with mising documentation' - filename: + description: Whether the case is currently escalated. + displayName: type: string - description: '# gdata.* are outside protos with mising documentation' - bigstoreObjectRef: - format: byte - description: '# gdata.* are outside protos with mising documentation' + description: The short summary of the issue reported in this case. + updateTime: type: string - deprecated: true - timestamp: + description: Output only. The time this case was last updated. + readOnly: true + format: google-datetime + contactEmail: type: string - format: uint64 - description: '# gdata.* are outside protos with mising documentation' - diffUploadResponse: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffUploadResponse' - referenceType: + description: >- + A user-supplied email address to send case update notifications for. + This should only be used in BYOID flows, where we cannot infer the + user's email address directly from their EUCs. + DiffChecksumsResponse: + properties: + objectLocation: description: '# gdata.* are outside protos with mising documentation' - enumDescriptions: - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' - - '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + chunkSizeBytes: type: string - enum: - - PATH - - BLOB_REF - - INLINE - - GET_MEDIA - - COMPOSITE_MEDIA - - BIGSTORE_REF - - DIFF_VERSION_RESPONSE - - DIFF_CHECKSUMS_RESPONSE - - DIFF_DOWNLOAD_RESPONSE - - DIFF_UPLOAD_REQUEST - - DIFF_UPLOAD_RESPONSE - - COSMO_BINARY_REFERENCE - - ARBITRARY_BYTES - inline: - format: byte description: '# gdata.* are outside protos with mising documentation' + format: int64 + objectSizeBytes: + format: int64 type: string - diffUploadRequest: - description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/DiffUploadRequest' - algorithm: description: '# gdata.* are outside protos with mising documentation' + objectVersion: type: string - deprecated: true - diffVersionResponse: - $ref: '#/components/schemas/DiffVersionResponse' - description: '# gdata.* are outside protos with mising documentation' - blobstore2Info: description: '# gdata.* are outside protos with mising documentation' - $ref: '#/components/schemas/Blobstore2Info' - path: - type: string + checksumsLocation: description: '# gdata.* are outside protos with mising documentation' - blobRef: + $ref: '#/components/schemas/CompositeMedia' + description: '# gdata.* are outside protos with mising documentation' + id: DiffChecksumsResponse + type: object + DiffDownloadResponse: + properties: + objectLocation: description: '# gdata.* are outside protos with mising documentation' + $ref: '#/components/schemas/CompositeMedia' + description: '# gdata.* are outside protos with mising documentation' + type: object + id: DiffDownloadResponse + CreateAttachmentRequest: + properties: + attachment: + $ref: '#/components/schemas/Attachment' + description: Required. The attachment to be created. + id: CreateAttachmentRequest + description: The request message for the CreateAttachment endpoint. + type: object + ContentTypeInfo: + description: '# gdata.* are outside protos with mising documentation' + properties: + fromBytes: type: string - deprecated: true - format: byte - token: description: '# gdata.* are outside protos with mising documentation' + fromHeader: type: string - md5Hash: - format: byte description: '# gdata.* are outside protos with mising documentation' + fromFileName: type: string - contentType: + description: '# gdata.* are outside protos with mising documentation' + fromUrlPath: type: string description: '# gdata.* are outside protos with mising documentation' - description: '# gdata.* are outside protos with mising documentation' + bestGuess: + description: '# gdata.* are outside protos with mising documentation' + type: string type: object - Comment: - id: Comment - description: >- - A comment associated with a support case. Case comments are the primary - way for Google Support to communicate with a user who has opened a case. - When a user responds to Google Support, the user's responses also appear - as comments. + id: ContentTypeInfo + ListAttachmentsResponse: properties: - creator: - readOnly: true + nextPageToken: + type: string description: >- - Output only. The user or Google Support agent who created the - comment. - $ref: '#/components/schemas/Actor' + A token to retrieve the next page of results. Set this in the + `page_token` field of subsequent `cases.attachments.list` requests. + If unspecified, there are no more results to retrieve. + attachments: + type: array + description: The list of attachments associated with a case. + items: + $ref: '#/components/schemas/Attachment' + description: The response message for the ListAttachments endpoint. + id: ListAttachmentsResponse + type: object + Attachment: + id: Attachment + properties: name: - type: string - description: Output only. Identifier. The resource name of the comment. readOnly: true - body: - description: The full comment body. Maximum of 12800 characters. type: string - plainTextBody: - description: >- - Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` - field. This field is only present for legacy reasons. + description: Output only. The resource name of the attachment. + filename: + type: string + description: The filename of the attachment (e.g. `"graph.jpg"`). + mimeType: readOnly: true + description: Output only. The MIME type of the attachment (e.g. text/plain). type: string - deprecated: true createTime: format: google-datetime - description: Output only. The time when the comment was created. + type: string + readOnly: true + description: Output only. The time at which the attachment was created. + creator: + $ref: '#/components/schemas/Actor' + readOnly: true + description: >- + Output only. The user who uploaded the attachment. Note, the name + and email will be obfuscated if the attachment was uploaded by + Google support. + sizeBytes: + format: int64 readOnly: true + description: Output only. The size of the attachment in bytes. type: string + description: >- + An Attachment contains metadata about a file that was uploaded to a case + - it is NOT a file itself. That being said, the name of an Attachment + object can be used to download its accompanying file through the + `media.download` endpoint. While attachments can be uploaded in the + console at the same time as a comment, they're associated on a "case" + level, not a "comment" level. type: object - DiffVersionResponse: - id: DiffVersionResponse + Escalation: properties: - objectVersion: - description: '# gdata.* are outside protos with mising documentation' + reason: + enumDescriptions: + - >- + The escalation reason is in an unknown state or has not been + specified. + - The case is taking too long to resolve. + - >- + The support agent does not have the expertise required to + successfully resolve the issue. + - The issue is having a significant business impact. + description: Required. The reason why the Case is being escalated. type: string - objectSizeBytes: + enum: + - REASON_UNSPECIFIED + - RESOLUTION_TIME + - TECHNICAL_EXPERTISE + - BUSINESS_IMPACT + justification: + description: >- + Required. A free text description to accompany the `reason` field + above. Provides additional context on why the case is being + escalated. type: string - format: int64 + id: Escalation + description: An escalation of a support case. + type: object + DownloadParameters: + id: DownloadParameters + properties: + allowGzipCompression: description: '# gdata.* are outside protos with mising documentation' + type: boolean + ignoreRange: + description: '# gdata.* are outside protos with mising documentation' + type: boolean description: '# gdata.* are outside protos with mising documentation' type: object parameters: + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -810,22 +841,16 @@ components: enum: - '1' - '2' - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string key: @@ -837,10 +862,10 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. + callback: + description: JSONP in: query - name: access_token + name: callback schema: type: string oauth_token: @@ -855,95 +880,21 @@ components: name: upload_protocol schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string x-stackQL-resources: - comments: - id: google.cloudsupport.comments - name: comments - title: Comments - methods: - _list: - operation: &ref_1 - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.comments - list: - operation: *ref_1 - response: *ref_2 - create: - operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/comments/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/comments/methods/create' - update: [] - delete: [] - attachments: - id: google.cloudsupport.attachments - name: attachments - title: Attachments - methods: - _list: - operation: &ref_3 - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/get' - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.attachments - list: - operation: *ref_3 - response: *ref_4 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/attachments/methods/list' - insert: [] - update: [] - delete: [] media: id: google.cloudsupport.media name: media title: Media methods: - upload: + download: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' + $ref: '#/paths/~1v2~1{name}/get' response: mediaType: application/json openAPIDocKey: '200' - download: + upload: operation: - $ref: '#/paths/~1v2~1{name}/get' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/post' response: mediaType: application/json openAPIDocKey: '200' @@ -951,37 +902,35 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] cases: id: google.cloudsupport.cases name: cases title: Cases methods: - _list: - operation: &ref_5 - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/get' - response: &ref_6 + patch: + operation: + $ref: '#/paths/~1v2~1{name}/patch' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.cases - list: - operation: *ref_5 - response: *ref_6 - create: + escalate: operation: - $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/post' + $ref: '#/paths/~1v2~1{name}/post' response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: - $ref: '#/paths/~1v2~1{name}/patch' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/get' response: mediaType: application/json openAPIDocKey: '200' - escalate: + objectKey: $.cases + create: operation: - $ref: '#/paths/~1v2~1{name}/post' + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1cases/post' response: mediaType: application/json openAPIDocKey: '200' @@ -992,6 +941,52 @@ components: - $ref: '#/components/x-stackQL-resources/cases/methods/create' update: - $ref: '#/components/x-stackQL-resources/cases/methods/patch' + replace: [] + delete: [] + attachments: + id: google.cloudsupport.attachments + name: attachments + title: Attachments + methods: + list: + operation: + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1attachments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attachments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/attachments/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + comments: + id: google.cloudsupport.comments + name: comments + title: Comments + methods: + create: + operation: + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v2~1{parentType}~1{parent}~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.comments + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/create' + update: [] + replace: [] delete: [] case_classifications: id: google.cloudsupport.case_classifications @@ -1008,89 +1003,39 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: - /v2/{parentType}/{parent}/comments: - parameters: &ref_7 - - $ref: '#/components/parameters/_.xgafv' + /v2/{name}: + parameters: &ref_1 + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' get: description: >- - List all the comments associated with a case. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43595344" curl \ --header - "Authorization: Bearer $(gcloud auth print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: - ```python import googleapiclient.discovery api_version = "v2" + Download a file attached to a case. Note: HTTP requests must append + "?alt=media" to the URL. EXAMPLES: cURL: ```shell + name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" + curl \ --header "Authorization: Bearer $(gcloud auth + print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` + Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = ( supportApiService.cases() .comments() - .list(parent="projects/some-project/cases/43595344") ) + ) request = supportApiService.media().download( + name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" + ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ``` - operationId: cloudsupport.cases.comments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListCommentsResponse' - parameters: - - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: >- - Add a new comment to a case. The comment must have the following fields - set: `body`. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43591344" curl \ --request POST \ - --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --header 'Content-Type: application/json' \ --data '{ "body": "This is a - test comment." }' \ - "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: - ```python import googleapiclient.discovery api_version = "v2" - supportApiService = googleapiclient.discovery.build( - serviceName="cloudsupport", version=api_version, - discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = ( supportApiService.cases() .comments() .create( - parent="projects/some-project/cases/43595344", body={"body": "This is a - test comment."}, ) ) print(request.execute()) ``` - operationId: cloudsupport.cases.comments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' + operationId: cloudsupport.media.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1100,36 +1045,35 @@ paths: '200': description: Successful response content: - application/json: - schema: - $ref: '#/components/schemas/Comment' - parameters: - - in: path - name: parentType - required: true - schema: - type: string + application/json: + schema: + $ref: '#/components/schemas/Media' + parameters: - in: path - name: parent + name: name required: true schema: type: string - /v2/{parentType}/{parent}/attachments: - parameters: *ref_7 - get: + patch: description: >- - List all the attachments associated with a support case. EXAMPLES: cURL: - ```shell case="projects/some-project/cases/23598314" curl \ --header - "Authorization: Bearer $(gcloud auth print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: - ```python import googleapiclient.discovery api_version = "v2" - supportApiService = googleapiclient.discovery.build( + Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43595344" curl \ --request PATCH \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + --header "Content-Type: application/json" \ --data '{ "priority": "P1" + }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" + ``` Python: ```python import googleapiclient.discovery api_version = + "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = ( supportApiService.cases() .attachments() - .list(parent="projects/some-project/cases/43595344") ) - print(request.execute()) ``` - operationId: cloudsupport.cases.attachments.list + ) request = supportApiService.cases().patch( + name="projects/some-project/cases/43112854", body={ "displayName": "This + is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` + operationId: cloudsupport.cases.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Case' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1141,53 +1085,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListAttachmentsResponse' + $ref: '#/components/schemas/Case' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: name required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + format: google-fieldmask post: description: >- - Create a file attachment on a case or Cloud resource. The attachment - must have the following fields set: `filename`. EXAMPLES: cURL: ```shell - echo "This text is in a file I'm uploading using CSAPI." \ > - "./example_file.txt" case="projects/some-project/cases/43594844" curl \ - --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --data-binary @"./example_file.txt" \ - "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" - ``` Python: ```python import googleapiclient.discovery api_version = - "v2" supportApiService = googleapiclient.discovery.build( + Escalate a case, starting the Google Cloud Support escalation management + process. This operation is only available for some support services. Go + to https://cloud.google.com/support and look for 'Technical support + escalations' in the feature list to find out which ones let you do that. + EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" + curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth + print-access-token)" \ --header "Content-Type: application/json" \ + --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": + "This is a test escalation." } }' \ + "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: + ```python import googleapiclient.discovery api_version = "v2" + supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) file_path = "./example_file.txt" with open(file_path, "w") as file: - file.write( "This text is inside a file I'm going to upload using the - Cloud Support API.", ) request = supportApiService.media().upload( - parent="projects/some-project/cases/43595344", media_body=file_path ) - request.uri = request.uri.split("?")[0] + - "?attachment.filename=uploaded_via_python.txt" print(request.execute()) - ``` - operationId: cloudsupport.media.upload + ) request = supportApiService.cases().escalate( + name="projects/some-project/cases/43595344", body={ "escalation": { + "reason": "BUSINESS_IMPACT", "justification": "This is a test + escalation.", }, }, ) print(request.execute()) ``` + operationId: cloudsupport.cases.escalate requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateAttachmentRequest' + $ref: '#/components/schemas/EscalateCaseRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1199,20 +1134,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/Case' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: name required: true schema: type: string /v2/{parentType}/{parent}/cases: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Retrieve all cases under a parent, but not its children. For example, @@ -1320,28 +1250,80 @@ paths: required: true schema: type: string - /v2/{name}: - parameters: *ref_7 - patch: + /v2/{parentType}/{parent}/attachments: + parameters: *ref_1 + get: description: >- - Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell - case="projects/some-project/cases/43595344" curl \ --request PATCH \ + List all the attachments associated with a support case. EXAMPLES: cURL: + ```shell case="projects/some-project/cases/23598314" curl \ --header + "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: + ```python import googleapiclient.discovery api_version = "v2" + supportApiService = googleapiclient.discovery.build( + serviceName="cloudsupport", version=api_version, + discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", + ) request = ( supportApiService.cases() .attachments() + .list(parent="projects/some-project/cases/43595344") ) + print(request.execute()) ``` + operationId: cloudsupport.cases.attachments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListAttachmentsResponse' + parameters: + - in: path + name: parentType + required: true + schema: + type: string + - in: path + name: parent + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Create a file attachment on a case or Cloud resource. The attachment + must have the following fields set: `filename`. EXAMPLES: cURL: ```shell + echo "This text is in a file I'm uploading using CSAPI." \ > + "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ - --header "Content-Type: application/json" \ --data '{ "priority": "P1" - }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" + --data-binary @"./example_file.txt" \ + "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.cases().patch( - name="projects/some-project/cases/43112854", body={ "displayName": "This - is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` - operationId: cloudsupport.cases.patch + ) file_path = "./example_file.txt" with open(file_path, "w") as file: + file.write( "This text is inside a file I'm going to upload using the + Cloud Support API.", ) request = supportApiService.media().upload( + parent="projects/some-project/cases/43595344", media_body=file_path ) + request.uri = request.uri.split("?")[0] + + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) + ``` + operationId: cloudsupport.media.upload requestBody: content: application/json: schema: - $ref: '#/components/schemas/Case' + $ref: '#/components/schemas/CreateAttachmentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1353,44 +1335,42 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Case' + $ref: '#/components/schemas/Attachment' parameters: - in: path - name: name + name: parentType required: true schema: type: string - - in: query - name: updateMask + - in: path + name: parent + required: true schema: type: string - format: google-fieldmask + /v2/{parentType}/{parent}/comments: + parameters: *ref_1 post: description: >- - Escalate a case, starting the Google Cloud Support escalation management - process. This operation is only available for some support services. Go - to https://cloud.google.com/support and look for 'Technical support - escalations' in the feature list to find out which ones let you do that. - EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" - curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth - print-access-token)" \ --header "Content-Type: application/json" \ - --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": - "This is a test escalation." } }' \ - "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: + Add a new comment to a case. The comment must have the following fields + set: `body`. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43591344" curl \ --request POST \ + --header "Authorization: Bearer $(gcloud auth print-access-token)" \ + --header 'Content-Type: application/json' \ --data '{ "body": "This is a + test comment." }' \ + "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.cases().escalate( - name="projects/some-project/cases/43595344", body={ "escalation": { - "reason": "BUSINESS_IMPACT", "justification": "This is a test - escalation.", }, }, ) print(request.execute()) ``` - operationId: cloudsupport.cases.escalate + ) request = ( supportApiService.cases() .comments() .create( + parent="projects/some-project/cases/43595344", body={"body": "This is a + test comment."}, ) ) print(request.execute()) ``` + operationId: cloudsupport.cases.comments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/EscalateCaseRequest' + $ref: '#/components/schemas/Comment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1402,30 +1382,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Case' + $ref: '#/components/schemas/Comment' parameters: - in: path - name: name + name: parentType + required: true + schema: + type: string + - in: path + name: parent required: true schema: type: string get: description: >- - Download a file attached to a case. Note: HTTP requests must append - "?alt=media" to the URL. EXAMPLES: cURL: ```shell - name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" - curl \ --header "Authorization: Bearer $(gcloud auth - print-access-token)" \ - "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` - Python: ```python import googleapiclient.discovery api_version = "v2" + List all the comments associated with a case. EXAMPLES: cURL: ```shell + case="projects/some-project/cases/43595344" curl \ --header + "Authorization: Bearer $(gcloud auth print-access-token)" \ + "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: + ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", - ) request = supportApiService.media().download( - name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" - ) request.uri = request.uri.split("?")[0] + "?alt=media" + ) request = ( supportApiService.cases() .comments() + .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ``` - operationId: cloudsupport.media.download + operationId: cloudsupport.cases.comments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1437,15 +1419,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Media' + $ref: '#/components/schemas/ListCommentsResponse' parameters: - in: path - name: name + name: parentType + required: true + schema: + type: string + - in: path + name: parent required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v2/caseClassifications:search: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Retrieve valid classifications to use when creating a support case. diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml index b25d1e9b..5ebac79b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudtasks.yaml @@ -7,8 +7,8 @@ info: title: Cloud Tasks API description: Manages the execution of large numbers of distributed requests. version: v2 - x-discovery-doc-revision: '20240412' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/tasks/ servers: @@ -343,19 +343,23 @@ components: oauthToken: description: >- If specified, an [OAuth - token](https://developers.google.com/identity/protocols/OAuth2) will - be generated and attached as the `Authorization` header in the HTTP - request. This type of authorization should generally only be used - when calling Google APIs hosted on *.googleapis.com. + token](https://developers.google.com/identity/protocols/OAuth2) is + generated and attached as the `Authorization` header in the HTTP + request. This type of authorization should generally be used only + when calling Google APIs hosted on *.googleapis.com. Note that both + the service account email and the scope MUST be specified when using + the queue-level authorization override. $ref: '#/components/schemas/OAuthToken' oidcToken: description: >- If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) - token will be generated and attached as an `Authorization` header in - the HTTP request. This type of authorization can be used for many + token is generated and attached as an `Authorization` header in the + HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you - intend to validate the token yourself. + intend to validate the token yourself. Note that both the service + account email and the audience MUST be specified when using the + queue-level authorization override. $ref: '#/components/schemas/OidcToken' UriOverride: id: UriOverride @@ -1650,16 +1654,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1672,6 +1673,7 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] cmek_config: id: google.cloudtasks.cmek_config @@ -1697,24 +1699,24 @@ components: - $ref: >- #/components/x-stackQL-resources/cmek_config/methods/get_cmek_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/cmek_config/methods/update_cmek_config + replace: [] delete: [] queues: id: google.cloudtasks.queues name: queues title: Queues methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1queues/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.queues - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: >- @@ -1772,6 +1774,7 @@ components: - $ref: '#/components/x-stackQL-resources/queues/methods/create' update: - $ref: '#/components/x-stackQL-resources/queues/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/queues/methods/delete' queues_iam_policies: @@ -1779,17 +1782,14 @@ components: name: queues_iam_policies title: Queues_iam_policies methods: - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1queues~1{queuesId}:getIamPolicy/post - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 set_iam_policy: operation: $ref: >- @@ -1810,23 +1810,23 @@ components: #/components/x-stackQL-resources/queues_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/queues_iam_policies/methods/set_iam_policy delete: [] tasks: id: google.cloudtasks.tasks name: tasks title: Tasks methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1queues~1{queuesId}~1tasks/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tasks - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -1869,11 +1869,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/tasks/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tasks/methods/delete' paths: /v2/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1920,7 +1921,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: cloudtasks.projects.locations.get @@ -1948,7 +1949,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/cmekConfig: - parameters: *ref_9 + parameters: *ref_1 patch: description: >- Creates or Updates a CMEK config. Updates the Customer Managed @@ -2019,7 +2020,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists queues. Queues are returned in lexicographical order. operationId: cloudtasks.projects.locations.queues.list @@ -2099,7 +2100,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets a queue. operationId: cloudtasks.projects.locations.queues.get @@ -2228,7 +2229,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Purges a queue by deleting all of its tasks. All tasks created before @@ -2270,7 +2271,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Pauses the queue. If a queue is paused then the system will stop @@ -2312,7 +2313,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Resume a queue. This method resumes a queue after it has been PAUSED or @@ -2357,7 +2358,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Gets the access control policy for a Queue. Returns an empty policy if @@ -2400,7 +2401,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy for a Queue. Replaces any existing @@ -2444,7 +2445,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on a Queue. If the resource does @@ -2487,7 +2488,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists the tasks in a queue. By default, only the BASIC view is retrieved @@ -2576,7 +2577,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets a task. operationId: cloudtasks.projects.locations.queues.tasks.get @@ -2657,7 +2658,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Forces a task to run now. When this method is called, Cloud Tasks will @@ -2713,7 +2714,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{taskId}:buffer: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates and buffers a new task without the need to explicitly define a diff --git a/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml b/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml index 35474020..76fc2ee1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/cloudtrace.yaml @@ -12,8 +12,8 @@ info: interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. version: v2 - x-discovery-doc-revision: '20240426' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/trace servers: @@ -601,6 +601,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] spans_span: id: google.cloudtrace.spans_span @@ -619,6 +620,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/spans_span/methods/create_span' update: [] + replace: [] delete: [] paths: /v2/projects/{projectsId}/traces:batchWrite: diff --git a/providers/src/googleapis.com/v00.00.00000/services/composer.yaml b/providers/src/googleapis.com/v00.00.00000/services/composer.yaml index 9ff82bc4..43666022 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/composer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/composer.yaml @@ -7,8 +7,8 @@ info: title: Cloud Composer API description: Manages Apache Airflow environments on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240831' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/composer/ servers: @@ -206,6 +206,10 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean storageConfig: description: Optional. Storage configuration for this environment. $ref: '#/components/schemas/StorageConfig' @@ -1873,17 +1877,14 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -1904,6 +1905,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' environments: @@ -1918,17 +1920,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1environments/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.environments - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2007,6 +2006,7 @@ components: - $ref: '#/components/x-stackQL-resources/environments/methods/create' update: - $ref: '#/components/x-stackQL-resources/environments/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/environments/methods/delete' environments_database_properties: @@ -2022,31 +2022,32 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/environments_database_properties/methods/fetch_database_properties insert: [] update: [] + replace: [] delete: [] workloads: id: google.composer.workloads name: workloads title: Workloads methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1environments~1{environmentsId}~1workloads/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workloads - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/workloads/methods/list' insert: [] update: [] + replace: [] delete: [] user_workloads_secrets: id: google.composer.user_workloads_secrets @@ -2060,17 +2061,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1environments~1{environmentsId}~1userWorkloadsSecrets/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.userWorkloadsSecrets - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -2101,7 +2099,8 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/user_workloads_secrets/methods/create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/user_workloads_secrets/methods/update delete: @@ -2119,17 +2118,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1environments~1{environmentsId}~1userWorkloadsConfigMaps/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.userWorkloadsConfigMaps - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -2160,7 +2156,8 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/user_workloads_config_maps/methods/create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/user_workloads_config_maps/methods/update delete: @@ -2171,26 +2168,24 @@ components: name: image_versions title: Image_versions methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1imageVersions/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.imageVersions - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/image_versions/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2244,7 +2239,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2315,7 +2310,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments: - parameters: *ref_13 + parameters: *ref_1 post: description: Create a new environment. operationId: composer.projects.locations.environments.create @@ -2383,7 +2378,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Get an existing environment. operationId: composer.projects.locations.environments.get @@ -2488,7 +2483,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand: - parameters: *ref_13 + parameters: *ref_1 post: description: Executes Airflow CLI command. operationId: composer.projects.locations.environments.executeAirflowCommand @@ -2526,7 +2521,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand: - parameters: *ref_13 + parameters: *ref_1 post: description: Stops Airflow CLI command execution. operationId: composer.projects.locations.environments.stopAirflowCommand @@ -2564,7 +2559,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand: - parameters: *ref_13 + parameters: *ref_1 post: description: Polls Airflow CLI command execution and fetches logs. operationId: composer.projects.locations.environments.pollAirflowCommand @@ -2602,7 +2597,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:checkUpgrade: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Check if an upgrade operation on the environment will succeed. In case @@ -2642,7 +2637,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:saveSnapshot: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a snapshots of a Cloud Composer environment. As a result of this @@ -2683,7 +2678,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:loadSnapshot: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Loads a snapshot of a Cloud Composer environment. As a result of this @@ -2724,7 +2719,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover: - parameters: *ref_13 + parameters: *ref_1 post: description: Triggers database failover (only for highly resilient environments). operationId: composer.projects.locations.environments.databaseFailover @@ -2762,7 +2757,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties: - parameters: *ref_13 + parameters: *ref_1 get: description: Fetches database properties. operationId: composer.projects.locations.environments.fetchDatabaseProperties @@ -2795,7 +2790,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists workloads in a Cloud Composer environment. Workload is a unit that @@ -2845,7 +2840,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a user workloads Secret. This method is supported for Cloud @@ -2929,7 +2924,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets/{userWorkloadsSecretsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets an existing user workloads Secret. Values of the "data" field in @@ -3053,7 +3048,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a user workloads ConfigMap. This method is supported for Cloud @@ -3137,7 +3132,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets an existing user workloads ConfigMap. This method is supported for @@ -3261,7 +3256,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/imageVersions: - parameters: *ref_13 + parameters: *ref_1 get: description: List ImageVersions for provided location. operationId: composer.projects.locations.imageVersions.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml index 530f4578..6dde7a82 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/compute.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/compute.yaml @@ -7,8 +7,8 @@ info: title: Compute Engine API description: 'Creates and runs virtual machines on Google Cloud Platform. ' version: v1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240903' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/compute/ servers: @@ -3361,6 +3361,7 @@ components: - '' - '' - '' + - '' enum: - FEATURE_TYPE_UNSPECIFIED - GVNIC @@ -3371,6 +3372,7 @@ components: - SEV_LIVE_MIGRATABLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE + - TDX_CAPABLE - UEFI_COMPATIBLE - VIRTIO_SCSI_MULTIQUEUE - WINDOWS @@ -6404,8 +6406,9 @@ components: properties: kind: description: >- - [Output only] Type of the resource. Always - compute#firewallPolicyRule for firewall policy rules + [Output only] Type of the resource. Returns + compute#firewallPolicyRule for firewall rules and + compute#packetMirroringRule for packet mirroring rules. default: compute#firewallPolicyRule type: string ruleName: @@ -6421,7 +6424,7 @@ components: An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest - priority and 2147483647 is the lowest prority. + priority and 2147483647 is the lowest priority. type: integer format: int32 match: @@ -6432,15 +6435,18 @@ components: action: description: >- The Action to perform when the client connection triggers the rule. - Valid actions are "allow", "deny" and "goto_next". + Valid actions for firewall rules are: "allow", "deny", + "apply_security_profile_group" and "goto_next". Valid actions for + packet mirroring rules are: "mirror", "do_not_mirror" and + "goto_next". type: string securityProfileGroup: description: >- A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group - Must be specified if action = 'apply_security_profile_group' and - cannot be specified for other actions. + Must be specified if action is one of 'apply_security_profile_group' + or 'mirror'. Cannot be specified for other actions. type: string tlsInspect: description: >- @@ -7786,6 +7792,51 @@ components: autoDeployExpirationSec: type: integer format: int32 + detectionLoadThreshold: + type: number + format: float + detectionAbsoluteQps: + type: number + format: float + detectionRelativeToBaselineQps: + type: number + format: float + trafficGranularityConfigs: + description: >- + Configuration options for enabling Adaptive Protection to operate on + specified granular traffic units. + type: array + items: + $ref: >- + #/components/schemas/SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig: + id: >- + SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig + description: >- + Configurations to specifc granular traffic units processed by Adaptive + Protection. + type: object + properties: + type: + description: Type of this configuration. + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - HTTP_HEADER_HOST + - HTTP_PATH + - UNSPECIFIED_TYPE + value: + description: Requests that match this value constitute a granular traffic unit. + type: string + enableEachUniqueValue: + description: >- + If enabled, traffic matching each unique value for the specified + type constitutes a separate traffic unit. It can only be set to true + if `value` is empty. + type: boolean SecurityPolicyDdosProtectionConfig: id: SecurityPolicyDdosProtectionConfig type: object @@ -9607,6 +9658,14 @@ components: resources. This field is for use by internal tools that use the public API. type: string + availabilityDomain: + description: >- + Specifies the availability domain to place the instance in. The + value must be a number between 1 and the number of availability + domains specified in the spread placement policy attached to the + instance. + type: integer + format: int32 provisioningModel: description: Specifies the provisioning model of the instance. type: string @@ -9627,6 +9686,20 @@ components: - DELETE - INSTANCE_TERMINATION_ACTION_UNSPECIFIED - STOP + maxRunDuration: + description: >- + Specifies the max run duration for the given instance. If specified, + the instance termination action will be performed at the end of the + run duration. + $ref: '#/components/schemas/Duration' + terminationTime: + description: >- + Specifies the timestamp, when the instance will be terminated, in + RFC3339 text format. If specified, the instance termination action + will be performed at the termination time. + type: string + onInstanceStopAction: + $ref: '#/components/schemas/SchedulingOnInstanceStopAction' localSsdRecoveryTimeout: description: >- Specifies the maximum amount of time a Local Ssd Vm should wait @@ -9686,6 +9759,19 @@ components: inclusive. type: integer format: int32 + SchedulingOnInstanceStopAction: + id: SchedulingOnInstanceStopAction + description: >- + Defines the behaviour for instances with the instance_termination_action + STOP. + type: object + properties: + discardLocalSsd: + description: >- + If true, the contents of any attached Local SSD disks will be + discarded else, the Local SSD data will be preserved when the + instance is stopped at the end of the run duration/termination time. + type: boolean InstanceParams: id: InstanceParams description: Additional instance params. @@ -9811,6 +9897,17 @@ components: Defines whether the instance should have confidential compute enabled. type: boolean + confidentialInstanceType: + description: Defines the type of technology used by the confidential instance. + type: string + enumDescriptions: + - No type specified. Do not use this value. + - AMD Secure Encrypted Virtualization. + - AMD Secure Encrypted Virtualization - Secure Nested Paging. + enum: + - CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED + - SEV + - SEV_SNP AdvancedMachineFeatures: id: AdvancedMachineFeatures description: >- @@ -9843,6 +9940,25 @@ components: enableUefiNetworking: description: Whether to enable UEFI networking for instance creation. type: boolean + performanceMonitoringUnit: + description: Type of Performance Monitoring Unit requested on instance. + type: string + enumDescriptions: + - Architecturally defined non-LLC events. + - Most documented core/L2 and LLC events. + - '' + - Most documented core/L2 events. + enum: + - ARCHITECTURAL + - ENHANCED + - PERFORMANCE_MONITORING_UNIT_UNSPECIFIED + - STANDARD + turboMode: + description: >- + Turbo frequency mode to use for the instance. Supported modes + include: * ALL_CORE_MAX Using empty string or not setting this field + will use the platform-specific default turbo mode. + type: string ResourceStatus: id: ResourceStatus description: >- @@ -9851,11 +9967,25 @@ components: (intent) in their instance CRUD calls. type: object properties: + scheduling: + $ref: '#/components/schemas/ResourceStatusScheduling' upcomingMaintenance: $ref: '#/components/schemas/UpcomingMaintenance' physicalHost: description: '[Output Only] An opaque ID of the host on which the VM is running.' type: string + ResourceStatusScheduling: + id: ResourceStatusScheduling + type: object + properties: + availabilityDomain: + description: >- + Specifies the availability domain to place the instance in. The + value must be a number between 1 and the number of availability + domains specified in the spread placement policy attached to the + instance. + type: integer + format: int32 UpcomingMaintenance: id: UpcomingMaintenance description: Upcoming Maintenance notification information. @@ -10894,11 +11024,11 @@ components: machineType: description: >- The machine type to use for instances that are created from these - properties. This field only accept machine types name. e.g. - n2-standard-4 and does not accept machine type full or partial url. - e.g. - projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4 - will throw INTERNAL_ERROR. + properties. This field only accepts a machine type name, for example + `n2-standard-4`. If you use the machine type full or partial URL, + for example + `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`, + the request will result in an `INTERNAL_ERROR`. annotations: required: - compute.instanceTemplates.insert @@ -11136,10 +11266,14 @@ components: - '' - '' - '' + - '' + - '' enum: - HIERARCHY - NETWORK - NETWORK_REGIONAL + - SYSTEM_GLOBAL + - SYSTEM_REGIONAL - UNSPECIFIED shortName: description: '[Output Only] The short name of the firewall policy.' @@ -11155,6 +11289,12 @@ components: type: array items: $ref: '#/components/schemas/FirewallPolicyRule' + priority: + description: >- + [Output only] Priority of firewall policy association. Not + applicable for type=HIERARCHY. + type: integer + format: int32 ReservationList: id: ReservationList type: object @@ -11564,9 +11704,13 @@ components: - '' - '' - '' + - '' + - '' enum: + - VM_FAMILY_CLOUD_TPU_DEVICE_CT3 - VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L - VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP + - VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P - VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P reservedResources: description: List of reserved resources (CPUs, memory, accelerators). @@ -13774,11 +13918,16 @@ components: type: string baseInstanceName: description: >- - The base instance name to use for instances in this group. The value - must be 1-58 characters long. Instances are named by appending a - hyphen and a random four-character string to the base instance name. - The base instance name must comply with RFC1035. - pattern: '[a-z][-a-z0-9]{0,57}' + The base instance name is a prefix that you want to attach to the + names of all VMs in a MIG. The maximum character length is 58 and + the name must comply with RFC1035 format. When a VM is created in + the group, the MIG appends a hyphen and a random four-character + string to the base instance name. If you want the MIG to assign + sequential numbers instead of a random string, then end the base + instance name with a hyphen followed by one or more hash symbols. + The hash symbols indicate the number of digits. For example, a base + instance name of "vm-###" results in "vm-001" as a VM name. @pattern + [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) type: string fingerprint: description: >- @@ -15802,7 +15951,8 @@ components: resizeBy: description: >- The number of instances to be created by this resize request. The - group's target size will be increased by this number. + group's target size will be increased by this number. This field + cannot be used together with 'instances'. type: integer format: int32 requestedRunDuration: @@ -18370,6 +18520,11 @@ components: enum: - AUTOMATIC - DISABLED + usedBy: + description: '[Output Only] List of resources referencing that backend bucket.' + type: array + items: + $ref: '#/components/schemas/BackendBucketUsedBy' BackendBucketCdnPolicy: id: BackendBucketCdnPolicy description: Message containing Cloud CDN configuration for a backend bucket. @@ -18590,6 +18745,15 @@ components: type: array items: type: string + BackendBucketUsedBy: + id: BackendBucketUsedBy + type: object + properties: + reference: + description: >- + [Output Only] Server-defined URL for UrlMaps referencing that + BackendBucket. + type: string SignedUrlKey: id: SignedUrlKey description: Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs @@ -19145,8 +19309,10 @@ components: INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not - NONE, and this field is not set to MAGLEV or RING_HASH, session - affinity settings will not take effect. Only ROUND_ROBIN and + configured—that is, if session affinity remains at the default value + of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. + If session affinity is set to a value other than NONE, then the + default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. @@ -19323,6 +19489,7 @@ components: additionalProperties: type: string usedBy: + description: '[Output Only] List of resources referencing given backend service.' type: array items: $ref: '#/components/schemas/BackendServiceUsedBy' @@ -20303,6 +20470,10 @@ components: type: object properties: reference: + description: >- + [Output Only] Server-defined URL for resources referencing given + BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and + ForwardingRule. type: string BackendServiceAggregatedList: id: BackendServiceAggregatedList @@ -21306,6 +21477,7 @@ components: - '' - '' - '' + - '' enum: - ACCELERATOR_OPTIMIZED - ACCELERATOR_OPTIMIZED_A3 @@ -21316,6 +21488,7 @@ components: - COMPUTE_OPTIMIZED_C3D - COMPUTE_OPTIMIZED_H3 - GENERAL_PURPOSE + - GENERAL_PURPOSE_C4 - GENERAL_PURPOSE_E2 - GENERAL_PURPOSE_N2 - GENERAL_PURPOSE_N2D @@ -23920,18 +24093,977 @@ components: type: array items: type: string - ForwardingRulesScopedList: - id: ForwardingRulesScopedList + ForwardingRulesScopedList: + id: ForwardingRulesScopedList + type: object + properties: + forwardingRules: + description: A list of forwarding rules contained in this scope. + type: array + items: + $ref: '#/components/schemas/ForwardingRule' + warning: + description: >- + Informational warning which replaces the list of forwarding rules + when the list is empty. + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + FutureReservation: + id: FutureReservation + type: object + properties: + kind: + description: >- + [Output Only] Type of the resource. Always compute#futureReservation + for future reservations. + default: compute#futureReservation + type: string + id: + description: >- + [Output Only] A unique identifier for this future reservation. The + server defines this identifier. + type: string + format: uint64 + creationTimestamp: + description: >- + [Output Only] The creation timestamp for this future reservation in + RFC3339 text format. + type: string + selfLink: + description: '[Output Only] Server-defined fully-qualified URL for this resource.' + type: string + selfLinkWithId: + description: >- + [Output Only] Server-defined URL for this resource with the resource + id. + type: string + zone: + description: '[Output Only] URL of the Zone where this future reservation resides.' + type: string + description: + description: >- + An optional description of this resource. Provide this property when + you create the future reservation. + type: string + name: + description: >- + The name of the resource, provided by the client when initially + creating the resource. The resource name must be 1-63 characters + long, and comply with RFC1035. Specifically, the name must be 1-63 + characters long and match the regular expression + `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be + a lowercase letter, and all following characters must be a dash, + lowercase letter, or digit, except the last character, which cannot + be a dash. + pattern: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?' + annotations: + required: + - compute.instances.insert + type: string + specificSkuProperties: + description: >- + Future Reservation configuration to indicate instance properties and + total count. + $ref: '#/components/schemas/FutureReservationSpecificSKUProperties' + timeWindow: + description: Time window for this Future Reservation. + $ref: '#/components/schemas/FutureReservationTimeWindow' + shareSettings: + description: List of Projects/Folders to share with. + $ref: '#/components/schemas/ShareSettings' + namePrefix: + description: >- + Name prefix for the reservations to be created at the time of + delivery. The name prefix must comply with RFC1035. Maximum allowed + length for name prefix is 20. Automatically created reservations + name format will be -date-####. + type: string + status: + description: '[Output only] Status of the Future Reservation' + $ref: '#/components/schemas/FutureReservationStatus' + planningStatus: + description: Planning state before being submitted for evaluation + type: string + enumDescriptions: + - Future Reservation is being drafted. + - '' + - Future Reservation has been submitted for evaluation by GCP. + enum: + - DRAFT + - PLANNING_STATUS_UNSPECIFIED + - SUBMITTED + autoCreatedReservationsDeleteTime: + description: >- + Future timestamp when the FR auto-created reservations will be + deleted by Compute Engine. Format of this field must be a valid + href="https://www.ietf.org/rfc/rfc3339.txt">RFC3339 value. + type: string + autoCreatedReservationsDuration: + description: >- + Specifies the duration of auto-created reservations. It represents + relative time to future reservation start_time when auto-created + reservations will be automatically deleted by Compute Engine. + Duration time unit is represented as a count of seconds and + fractions of seconds at nanosecond resolution. + $ref: '#/components/schemas/Duration' + autoDeleteAutoCreatedReservations: + description: >- + Setting for enabling or disabling automatic deletion for + auto-created reservation. If set to true, auto-created reservations + will be deleted at Future Reservation's end time (default) or at + user's defined timestamp if any of the + [auto_created_reservations_delete_time, + auto_created_reservations_duration] values is specified. For keeping + auto-created reservation indefinitely, this value should be set to + false. + type: boolean + FutureReservationSpecificSKUProperties: + id: FutureReservationSpecificSKUProperties + type: object + properties: + instanceProperties: + description: Properties of the SKU instances being reserved. + $ref: >- + #/components/schemas/AllocationSpecificSKUAllocationReservedInstanceProperties + totalCount: + description: >- + Total number of instances for which capacity assurance is requested + at a future time period. + type: string + format: int64 + sourceInstanceTemplate: + description: >- + The instance template that will be used to populate the + ReservedInstanceProperties of the future reservation + type: string + FutureReservationTimeWindow: + id: FutureReservationTimeWindow + type: object + properties: + startTime: + description: >- + Start time of the Future Reservation. The start_time is an RFC3339 + string. + type: string + endTime: + type: string + duration: + $ref: '#/components/schemas/Duration' + FutureReservationStatus: + id: FutureReservationStatus + description: '[Output only] Represents status related to the future reservation.' + type: object + properties: + procurementStatus: + description: Current state of this Future Reservation + type: string + enumDescriptions: + - Future reservation is approved by GCP. + - Future reservation is cancelled by the customer. + - Future reservation is committed by the customer. + - Future reservation is rejected by GCP. + - >- + Related status for PlanningStatus.Draft. Transitions to + PENDING_APPROVAL upon user submitting FR. + - >- + Future reservation failed. No additional reservations were + provided. + - >- + Future reservation is partially fulfilled. Additional reservations + were provided but did not reach total_count reserved instance + slots. + - Future reservation is fulfilled completely. + - >- + An Amendment to the Future Reservation has been requested. If the + Amendment is declined, the Future Reservation will be restored to + the last known good state. + - Future reservation is pending approval by GCP. + - '' + - >- + Future reservation is being procured by GCP. Beyond this point, + Future reservation is locked and no further modifications are + allowed. + - >- + Future reservation capacity is being provisioned. This state will + be entered after start_time, while reservations are being created + to provide total_count reserved instance slots. This state will + not persist past start_time + 24h. + enum: + - APPROVED + - CANCELLED + - COMMITTED + - DECLINED + - DRAFTING + - FAILED + - FAILED_PARTIALLY_FULFILLED + - FULFILLED + - PENDING_AMENDMENT_APPROVAL + - PENDING_APPROVAL + - PROCUREMENT_STATUS_UNSPECIFIED + - PROCURING + - PROVISIONING + lockTime: + description: >- + Time when Future Reservation would become LOCKED, after which no + modifications to Future Reservation will be allowed. Applicable only + after the Future Reservation is in the APPROVED state. The lock_time + is an RFC3339 string. The procurement_status will transition to + PROCURING state at this time. + type: string + autoCreatedReservations: + description: >- + Fully qualified urls of the automatically created reservations at + start_time. + type: array + items: + type: string + fulfilledCount: + description: >- + This count indicates the fulfilled capacity so far. This is set + during "PROVISIONING" state. This count also includes capacity + delivered as part of existing matching reservations. + type: string + format: int64 + specificSkuProperties: + $ref: '#/components/schemas/FutureReservationStatusSpecificSKUProperties' + amendmentStatus: + description: '[Output Only] The current status of the requested amendment.' + type: string + enumDescriptions: + - >- + The requested amendment to the Future Resevation has been approved + and applied by GCP. + - >- + The requested amendment to the Future Reservation has been + declined by GCP and the original state was restored. + - >- + The requested amendment to the Future Reservation is currently + being reviewd by GCP. + - '' + enum: + - AMENDMENT_APPROVED + - AMENDMENT_DECLINED + - AMENDMENT_IN_REVIEW + - AMENDMENT_STATUS_UNSPECIFIED + lastKnownGoodState: + description: >- + [Output Only] This field represents the future reservation before an + amendment was requested. If the amendment is declined, the Future + Reservation will be reverted to the last known good state. The last + known good state is not set when updating a future reservation whose + Procurement Status is DRAFTING. + $ref: '#/components/schemas/FutureReservationStatusLastKnownGoodState' + existingMatchingUsageInfo: + description: >- + [Output Only] Represents the existing matching usage for the future + reservation. + $ref: >- + #/components/schemas/FutureReservationStatusExistingMatchingUsageInfo + FutureReservationStatusSpecificSKUProperties: + id: FutureReservationStatusSpecificSKUProperties + description: Properties to be set for the Future Reservation. + type: object + properties: + sourceInstanceTemplateId: + description: >- + ID of the instance template used to populate the Future Reservation + properties. + type: string + FutureReservationStatusLastKnownGoodState: + id: FutureReservationStatusLastKnownGoodState + description: >- + The state that the future reservation will be reverted to should the + amendment be declined. + type: object + properties: + futureReservationSpecs: + $ref: >- + #/components/schemas/FutureReservationStatusLastKnownGoodStateFutureReservationSpecs + procurementStatus: + description: >- + [Output Only] The status of the last known good state for the Future + Reservation. + type: string + enumDescriptions: + - Future reservation is approved by GCP. + - Future reservation is cancelled by the customer. + - Future reservation is committed by the customer. + - Future reservation is rejected by GCP. + - >- + Related status for PlanningStatus.Draft. Transitions to + PENDING_APPROVAL upon user submitting FR. + - >- + Future reservation failed. No additional reservations were + provided. + - >- + Future reservation is partially fulfilled. Additional reservations + were provided but did not reach total_count reserved instance + slots. + - Future reservation is fulfilled completely. + - >- + An Amendment to the Future Reservation has been requested. If the + Amendment is declined, the Future Reservation will be restored to + the last known good state. + - Future reservation is pending approval by GCP. + - '' + - >- + Future reservation is being procured by GCP. Beyond this point, + Future reservation is locked and no further modifications are + allowed. + - >- + Future reservation capacity is being provisioned. This state will + be entered after start_time, while reservations are being created + to provide total_count reserved instance slots. This state will + not persist past start_time + 24h. + enum: + - APPROVED + - CANCELLED + - COMMITTED + - DECLINED + - DRAFTING + - FAILED + - FAILED_PARTIALLY_FULFILLED + - FULFILLED + - PENDING_AMENDMENT_APPROVAL + - PENDING_APPROVAL + - PROCUREMENT_STATUS_UNSPECIFIED + - PROCURING + - PROVISIONING + namePrefix: + description: >- + [Output Only] The name prefix of the Future Reservation before an + amendment was requested. + type: string + description: + description: >- + [Output Only] The description of the FutureReservation before an + amendment was requested. + type: string + lockTime: + description: >- + [Output Only] The lock time of the FutureReservation before an + amendment was requested. + type: string + existingMatchingUsageInfo: + description: >- + [Output Only] Represents the matching usage for the future + reservation before an amendment was requested. + $ref: >- + #/components/schemas/FutureReservationStatusExistingMatchingUsageInfo + FutureReservationStatusLastKnownGoodStateFutureReservationSpecs: + id: FutureReservationStatusLastKnownGoodStateFutureReservationSpecs + description: The properties of the last known good state for the Future Reservation. + type: object + properties: + specificSkuProperties: + description: >- + [Output Only] The previous instance related properties of the Future + Reservation. + $ref: '#/components/schemas/FutureReservationSpecificSKUProperties' + timeWindow: + description: '[Output Only] The previous time window of the Future Reservation.' + $ref: '#/components/schemas/FutureReservationTimeWindow' + shareSettings: + description: '[Output Only] The previous share settings of the Future Reservation.' + $ref: '#/components/schemas/ShareSettings' + FutureReservationStatusExistingMatchingUsageInfo: + id: FutureReservationStatusExistingMatchingUsageInfo + description: >- + [Output Only] Represents the existing matching usage for the future + reservation. + type: object + properties: + count: + description: >- + Count to represent min(FR total_count, + matching_reserved_capacity+matching_unreserved_instances) + type: string + format: int64 + timestamp: + description: Timestamp when the matching usage was calculated + type: string + FutureReservationsListResponse: + id: FutureReservationsListResponse + type: object + properties: + kind: + description: >- + [Output Only] Type of resource.Always + compute#FutureReservationsListResponse for lists of reservations + default: compute#futureReservationsListResponse + type: string + id: + description: >- + [Output Only] The unique identifier for the resource. This + identifier is defined by the server. + type: string + items: + description: '[Output Only] A list of future reservation resources.' + type: array + items: + $ref: '#/components/schemas/FutureReservation' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + etag: + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + FutureReservationsAggregatedListResponse: + id: FutureReservationsAggregatedListResponse + description: Contains a list of future reservations. + type: object + properties: + kind: + description: >- + [Output Only] Type of resource. Always + compute#futureReservationsAggregatedListResponse for future + resevation aggregated list response. + default: compute#futureReservationsAggregatedListResponse + type: string + id: + description: >- + [Output Only] Unique identifier for the resource; defined by the + server. + type: string + items: + description: A list of Future reservation resources. + type: object + additionalProperties: + description: Name of the scope containing this set of future reservations. + $ref: '#/components/schemas/FutureReservationsScopedList' + nextPageToken: + description: >- + [Output Only] This token allows you to get the next page of results + for list requests. If the number of results is larger than + maxResults, use the nextPageToken as a value for the query parameter + pageToken in the next list request. Subsequent list requests will + have their own nextPageToken to continue paging through the results. + type: string + selfLink: + description: '[Output Only] Server-defined URL for this resource.' + type: string + warning: + description: '[Output Only] Informational warning message.' + type: object + properties: + code: + description: >- + [Output Only] A warning code, if applicable. For example, + Compute Engine returns NO_RESULTS_ON_PAGE if there are no + results in the response. + type: string + enumDescriptions: + - >- + Warning about failed cleanup of transient changes made by a + failed operation. + - A link to a deprecated resource was created. + - >- + When deploying and at least one of the resources has a type + marked as deprecated + - The user created a boot disk that is larger than image size. + - >- + When deploying and at least one of the resources has a type + marked as experimental + - Warning that is present in an external api call + - >- + Warning that value of a field has been overridden. Deprecated + unused field. + - >- + The operation involved use of an injected kernel, which is + deprecated. + - >- + A WEIGHTED_MAGLEV backend service is associated with a health + check that is not of type HTTP/HTTPS/HTTP2. + - >- + When deploying a deployment with a exceedingly large number of + resources + - >- + Resource can't be retrieved due to list overhead quota exceed + which captures the amount of resources filtered out by + user-defined list filter. + - A resource depends on a missing type + - >- + The route's nextHopIp address is not assigned to an instance + on the network. + - The route's next hop instance cannot ip forward. + - >- + The route's nextHopInstance URL refers to an instance that + does not have an ipv6 interface on the same network as the + route. + - >- + The route's nextHopInstance URL refers to an instance that + does not exist. + - >- + The route's nextHopInstance URL refers to an instance that is + not on the same network as the route. + - >- + The route's next hop instance does not have a status of + RUNNING. + - >- + Error which is not critical. We decided to continue the + process despite the mentioned error. + - No results are present on a particular list page. + - >- + Success is reported, but some results may be missing due to + errors + - >- + The user attempted to use a resource that requires a TOS they + have not accepted. + - Warning that a resource is in use. + - >- + One or more of the resources set to auto-delete could not be + deleted because they were in use. + - When a resource schema validation is ignored. + - >- + Instance template used in instance group manager is valid as + such, but its application does not make a lot of sense, + because it allows only single instance in instance group. + - When undeclared properties in the schema are present + - A given scope cannot be reached. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + enum: + - CLEANUP_FAILED + - DEPRECATED_RESOURCE_USED + - DEPRECATED_TYPE_USED + - DISK_SIZE_LARGER_THAN_IMAGE_SIZE + - EXPERIMENTAL_TYPE_USED + - EXTERNAL_API_WARNING + - FIELD_VALUE_OVERRIDEN + - INJECTED_KERNELS_DEPRECATED + - INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB + - LARGE_DEPLOYMENT_WARNING + - LIST_OVERHEAD_QUOTA_EXCEED + - MISSING_TYPE_DEPENDENCY + - NEXT_HOP_ADDRESS_NOT_ASSIGNED + - NEXT_HOP_CANNOT_IP_FORWARD + - NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE + - NEXT_HOP_INSTANCE_NOT_FOUND + - NEXT_HOP_INSTANCE_NOT_ON_NETWORK + - NEXT_HOP_NOT_RUNNING + - NOT_CRITICAL_ERROR + - NO_RESULTS_ON_PAGE + - PARTIAL_SUCCESS + - REQUIRED_TOS_AGREEMENT + - RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING + - RESOURCE_NOT_DELETED + - SCHEMA_VALIDATION_IGNORED + - SINGLE_INSTANCE_PROPERTY_TEMPLATE + - UNDECLARED_PROPERTIES + - UNREACHABLE + message: + description: '[Output Only] A human-readable description of the warning code.' + type: string + data: + description: >- + [Output Only] Metadata about this warning in key: value format. + For example: "data": [ { "key": "scope", "value": + "zones/us-east1-d" } + type: array + items: + type: object + properties: + key: + description: >- + [Output Only] A key that provides more detail on the + warning being returned. For example, for warnings where + there are no results in a list request for a particular + zone, this key might be scope and the key value might be + the zone name. Other examples might be a key indicating a + deprecated resource and a suggested replacement, or a + warning about invalid network settings (for example, if an + instance attempts to perform IP forwarding but is not + enabled for IP forwarding). + type: string + value: + description: >- + [Output Only] A warning data value corresponding to the + key. + type: string + etag: + type: string + unreachables: + description: '[Output Only] Unreachable resources.' + type: array + items: + type: string + FutureReservationsScopedList: + id: FutureReservationsScopedList type: object properties: - forwardingRules: - description: A list of forwarding rules contained in this scope. + futureReservations: + description: A list of future reservations contained in this scope. type: array items: - $ref: '#/components/schemas/ForwardingRule' + $ref: '#/components/schemas/FutureReservation' warning: description: >- - Informational warning which replaces the list of forwarding rules + Informational warning which replaces the list of future reservations when the list is empty. type: object properties: @@ -24712,6 +25844,22 @@ components: $ref: '#/components/schemas/HTTP2HealthCheck' grpcHealthCheck: $ref: '#/components/schemas/GRPCHealthCheck' + sourceRegions: + description: >- + The list of cloud regions from which health checks are performed. If + any regions are specified, then exactly 3 regions should be + specified. The region names must be valid names of Google Cloud + regions. This can only be set for global health check. If this list + is non-empty, then there are restrictions on what other health check + fields are supported and what other resources can use this health + check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP + request field is not supported. - The proxyHeader field for HTTP, + HTTPS, and TCP is not supported. - The checkIntervalSec field must + be at least 30. - The health check cannot be used with + BackendService nor with managed instance group auto-healing. + type: array + items: + type: string selfLink: description: '[Output Only] Server-defined URL for the resource.' type: string @@ -31724,6 +32872,17 @@ components: description: Number of accelerator cards exposed to the guest. type: integer format: int32 + architecture: + description: '[Output Only] The architecture of the machine type.' + type: string + enumDescriptions: + - Default value indicating Architecture is not set. + - Machines with architecture ARM64 + - Machines with architecture X86_64 + enum: + - ARCHITECTURE_UNSPECIFIED + - ARM64 + - X86_64 MachineTypeAggregatedList: id: MachineTypeAggregatedList type: object @@ -33526,6 +34685,9 @@ components: enumDescriptions: - The network endpoint is represented by an IP address. - The network endpoint is represented by IP address and port pair. + - >- + The network endpoint is represented by an IP, Port and Client + Destination Port. - >- The network endpoint is represented by fully qualified domain name and port. @@ -33546,6 +34708,7 @@ components: enum: - GCE_VM_IP - GCE_VM_IP_PORT + - GCE_VM_IP_PORTMAP - INTERNET_FQDN_PORT - INTERNET_IP_PORT - NON_GCP_PRIVATE_IP_PORT @@ -33748,6 +34911,13 @@ components: - PENDING - REJECTED - STATUS_UNSPECIFIED + producerPort: + description: >- + The psc producer port is used to connect PSC NEG with specific port + on the PSC Producer side; should only be used for the + PRIVATE_SERVICE_CONNECT NEG type + type: integer + format: int32 NetworkEndpointGroupAggregatedList: id: NetworkEndpointGroupAggregatedList type: object @@ -34172,6 +35342,13 @@ components: can not be set for network endpoints of type GCE_VM_IP. type: integer format: int32 + clientDestinationPort: + description: >- + Represents the port number to which PSC consumer sends packets. Only + valid for network endpoint groups created with GCE_VM_IP_PORTMAP + endpoint type. + type: integer + format: int32 instance: description: >- The name or a URL of VM instance of this network endpoint. This @@ -35066,9 +36243,11 @@ components: - '' - '' - '' + - '' enum: - HIERARCHY - NETWORK + - SYSTEM - UNSPECIFIED shortName: description: '[Output Only] The short name of the firewall policy.' @@ -35084,6 +36263,12 @@ components: type: array items: $ref: '#/components/schemas/FirewallPolicyRule' + priority: + description: >- + [Output only] Priority of firewall policy association. Not + applicable for type=HIERARCHY. + type: integer + format: int32 ExchangedPeeringRoutesList: id: ExchangedPeeringRoutesList type: object @@ -42542,10 +43727,15 @@ components: The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - - regions/region/forwardingRules/forwardingRule + regions/region/forwardingRules/forwardingRule If an IP address is + provided, must specify an IPv4 address in dot-decimal notation or an + IPv6 address in RFC 4291 format. For example, the following are all + valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - + 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC + 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be + an IPv4-mapped IPv6 address. type: string warnings: description: >- @@ -43617,12 +44807,12 @@ components: CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid - match expressions for public NAT: "inIpRange(destination.ip, - '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')" - "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'" The + match expressions for public NAT: `inIpRange(destination.ip, + '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')` + `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` The following example is a valid match expression for private NAT: - "nexthop.hub == - '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'" + `nexthop.hub == + '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` type: string action: description: The action to be enforced for traffic that matches this rule. @@ -44279,12 +45469,22 @@ components: description: URI of the network to which this router belongs. type: string bestRoutes: - description: Best routes for this router's network. + description: >- + A list of the best dynamic routes for this Cloud Router's Virtual + Private Cloud (VPC) network in the same region as this Cloud Router. + Lists all of the best routes per prefix that are programmed into + this region's VPC data plane. When global dynamic routing mode is + turned on in the VPC network, this list can include cross-region + dynamic routes from Cloud Routers in other regions. type: array items: $ref: '#/components/schemas/Route' bestRoutesForRouter: - description: Best routes learned by this router. + description: >- + A list of the best BGP routes learned by this Cloud Router. It is + possible that routes listed might not be programmed into the data + plane, if the Google Cloud control plane finds a more optimal route + for a prefix than a route learned by this Cloud Router. type: array items: $ref: '#/components/schemas/Route' @@ -48536,7 +49736,13 @@ components: you create the resource. type: string poolProvisionedCapacityGb: - description: Size, in GiB, of the storage pool. + description: >- + Size, in GiB, of the storage pool. For more information about the + size limits, see + https://cloud.google.com/compute/docs/disks/storage-pools. + annotations: + required: + - compute.storagePools.insert type: string format: int64 poolProvisionedIops: @@ -48677,8 +49883,10 @@ components: format: int64 poolUsedIops: description: >- - Sum of all the disks' provisioned IOPS, minus some amount that is - allowed per disk that is not counted towards pool's IOPS capacity. + [Output Only] Sum of all the disks' provisioned IOPS, minus some + amount that is allowed per disk that is not counted towards pool's + IOPS capacity. For more information, see + https://cloud.google.com/compute/docs/disks/storage-pools. type: string format: int64 totalProvisionedDiskIops: @@ -49674,9 +50882,7 @@ components: description: The external IPv6 address range that is owned by this subnetwork. type: string internalIpv6Prefix: - description: >- - [Output Only] The internal IPv6 address range that is assigned to - this subnetwork. + description: The internal IPv6 address range that is owned by this subnetwork. type: string purpose: description: >- @@ -51653,9 +52859,21 @@ components: description: >- URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL - certificate must be specified. Currently, you may specify up to 15 - SSL certificates. sslCertificates do not apply when the load - balancing scheme is set to INTERNAL_SELF_MANAGED. + certificate must be specified. SslCertificates do not apply when the + load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs + should refer to a SSL Certificate resource or Certificate Manager + Certificate resource. Mixing Classic Certificates and Certificate + Manager Certificates is not allowed. Certificate Manager + Certificates must include the certificatemanager API. Certificate + Manager Certificates are not supported by Global external + Application Load Balancer or Classic Application Load Balancer, use + certificate_map instead. Currently, you may specify up to 15 Classic + SSL Certificates. Certificate Manager Certificates accepted formats + are: - + //certificatemanager.googleapis.com/projects/{project}/locations/{ + location}/certificates/{resourceName}. - + https://certificatemanager.googleapis.com/v1alpha1/projects/{project + }/locations/{location}/certificates/{resourceName}. type: array items: type: string @@ -51663,7 +52881,9 @@ components: description: >- URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set - for global target proxies. If set, sslCertificates will be ignored. + for Global external Application Load Balancer or Classic Application + Load Balancer. For other products use Certificate Manager + Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. @@ -55623,8 +56843,9 @@ components: defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction - cannot contain any weightedBackendServices. Conversely, if - routeAction specifies any weightedBackendServices, service must not + cannot contain any defaultRouteAction.weightedBackendServices. + Conversely, if defaultRouteAction specifies any + defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is @@ -55664,6 +56885,33 @@ components: is bound to a target gRPC proxy that has validateForProxyless field set to true. $ref: '#/components/schemas/HttpHeaderAction' + defaultCustomErrorResponsePolicy: + description: >- + defaultCustomErrorResponsePolicy specifies how the Load Balancer + returns error responses when BackendServiceor BackendBucket responds + with an error. This policy takes effect at the load balancer level + and applies only when no policy has been defined for the error code + at lower levels like PathMatcher, RouteRule and PathRule within this + UrlMap. For example, consider a UrlMap with the following + configuration: - defaultCustomErrorResponsePolicy containing + policies for responding to 5xx and 4xx errors - A PathMatcher + configured for *.example.com has defaultCustomErrorResponsePolicy + for 4xx. If a request for http://www.example.com/ encounters a 404, + the policy in pathMatcher.defaultCustomErrorResponsePolicy will be + enforced. When the request for http://www.example.com/ encounters a + 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be + enforced. When a request that does not match any host in + *.example.com such as http://www.myotherexample.com/, encounters a + 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used + in conjunction with defaultRouteAction.retryPolicy, retries take + precedence. Only once all retries are exhausted, the + defaultCustomErrorResponsePolicy is applied. While attempting a + retry, if load balancer is successful in reaching the service, the + defaultCustomErrorResponsePolicy is ignored and the response from + the service is returned to the client. + defaultCustomErrorResponsePolicy is supported only for global + external Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' fingerprint: description: >- Fingerprint of this resource. A hash of the contents stored in this @@ -55802,6 +57050,38 @@ components: Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. $ref: '#/components/schemas/HttpHeaderAction' + defaultCustomErrorResponsePolicy: + description: >- + defaultCustomErrorResponsePolicy specifies how the Load Balancer + returns error responses when BackendServiceor BackendBucket responds + with an error. This policy takes effect at the PathMatcher level and + applies only when no policy has been defined for the error code at + lower levels like RouteRule and PathRule within this PathMatcher. If + an error code does not have a policy defined in + defaultCustomErrorResponsePolicy, then a policy defined for the + error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. + For example, consider a UrlMap with the following configuration: - + UrlMap.defaultCustomErrorResponsePolicy is configured with policies + for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured + for the error code 404. If the request is for www.myotherdomain.com + and a 404 is encountered, the policy under + UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 + response is encountered for the request + www.example.com/current_events/, the pathMatcher's policy takes + effect. If however, the request for www.example.com/coming_soon/ + encounters a 404, the policy in RouteRule.customErrorResponsePolicy + takes effect. If any of the requests in this example encounter a 500 + error code, the policy at UrlMap.defaultCustomErrorResponsePolicy + takes effect. When used in conjunction with + pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. + Only once all retries are exhausted, the + defaultCustomErrorResponsePolicy is applied. While attempting a + retry, if load balancer is successful in reaching the service, the + defaultCustomErrorResponsePolicy is ignored and the response from + the service is returned to the client. + defaultCustomErrorResponsePolicy is supported only for global + external Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' HttpRouteAction: id: HttpRouteAction type: object @@ -55913,7 +57193,9 @@ components: for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity - policy. The value must be from 0 to 1000. + policy. Don't configure session affinity if you're using weighted + traffic splitting. If you do, the weighted traffic splitting + configuration takes precedence. The value must be from 0 to 1000. type: integer format: uint32 headerAction: @@ -56301,6 +57583,105 @@ components: type: array items: type: string + customErrorResponsePolicy: + description: >- + customErrorResponsePolicy specifies how the Load Balancer returns + error responses when BackendServiceor BackendBucket responds with an + error. If a policy for an error code is not configured for the + PathRule, a policy for the error code configured in + pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is + not specified in pathMatcher.defaultCustomErrorResponsePolicy, the + policy configured in UrlMap.defaultCustomErrorResponsePolicy takes + effect. For example, consider a UrlMap with the following + configuration: - UrlMap.defaultCustomErrorResponsePolicy are + configured with policies for 5xx and 4xx errors - A PathRule for + /coming_soon/ is configured for the error code 404. If the request + is for www.myotherdomain.com and a 404 is encountered, the policy + under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 + response is encountered for the request + www.example.com/current_events/, the pathMatcher's policy takes + effect. If however, the request for www.example.com/coming_soon/ + encounters a 404, the policy in PathRule.customErrorResponsePolicy + takes effect. If any of the requests in this example encounter a 500 + error code, the policy at UrlMap.defaultCustomErrorResponsePolicy + takes effect. customErrorResponsePolicy is supported only for global + external Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' + CustomErrorResponsePolicy: + id: CustomErrorResponsePolicy + description: >- + Specifies the custom error response policy that must be applied when the + backend service or backend bucket responds with an error. + type: object + properties: + errorResponseRules: + description: >- + Specifies rules for returning error responses. In a given policy, if + you specify rules for both a range of error codes as well as rules + for specific error codes then rules with specific error codes have a + higher priority. For example, assume that you configure a rule for + 401 (Un-authorized) code, and another for all 4 series error codes + (4XX). If the backend service returns a 401, then the rule for 401 + will be applied. However if the backend service returns a 403, the + rule for 4xx takes effect. + type: array + items: + $ref: >- + #/components/schemas/CustomErrorResponsePolicyCustomErrorResponseRule + errorService: + description: >- + The full or partial URL to the BackendBucket resource that contains + the custom error content. Examples are: - + https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket + - compute/v1/projects/project/global/backendBuckets/myBackendBucket + - global/backendBuckets/myBackendBucket If errorService is not + specified at lower levels like pathMatcher, pathRule and routeRule, + an errorService specified at a higher level in the UrlMap will be + used. If UrlMap.defaultCustomErrorResponsePolicy contains one or + more errorResponseRules[], it must specify errorService. If load + balancer cannot reach the backendBucket, a simple Not Found Error + will be returned, with the original response code (or + overrideResponseCode if configured). errorService is not supported + for internal or regional HTTP/HTTPS load balancers. + type: string + CustomErrorResponsePolicyCustomErrorResponseRule: + id: CustomErrorResponsePolicyCustomErrorResponseRule + description: >- + Specifies the mapping between the response code that will be returned + along with the custom error content and the response code returned by + the backend service. + type: object + properties: + matchResponseCodes: + description: >- + Valid values include: - A number between 400 and 599: For example + 401 or 503, in which case the load balancer applies the policy if + the error code exactly matches this value. - 5xx: Load Balancer will + apply the policy if the backend service responds with any response + code in the range of 500 to 599. - 4xx: Load Balancer will apply the + policy if the backend service responds with any response code in the + range of 400 to 499. Values must be unique within matchResponseCodes + and across all errorResponseRules of CustomErrorResponsePolicy. + type: array + items: + type: string + path: + description: >- + The full path to a file within backendBucket . For example: + /errors/defaultError.html path must start with a leading slash. path + cannot have trailing slashes. If the file is not available in + backendBucket or the load balancer cannot reach the BackendBucket, a + simple Not Found Error is returned to the client. The value must be + from 1 to 1024 characters + type: string + overrideResponseCode: + description: >- + The HTTP status code returned with the response containing the + custom error content. If overrideResponseCode is not supplied, the + same response code returned by the original backend bucket or + backend service is returned to the client. + type: integer + format: int32 HttpRouteRule: id: HttpRouteRule description: >- @@ -56384,6 +57765,36 @@ components: is bound to a target gRPC proxy that has validateForProxyless field set to true. $ref: '#/components/schemas/HttpHeaderAction' + customErrorResponsePolicy: + description: >- + customErrorResponsePolicy specifies how the Load Balancer returns + error responses when BackendServiceor BackendBucket responds with an + error. If a policy for an error code is not configured for the + RouteRule, a policy for the error code configured in + pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is + not specified in pathMatcher.defaultCustomErrorResponsePolicy, the + policy configured in UrlMap.defaultCustomErrorResponsePolicy takes + effect. For example, consider a UrlMap with the following + configuration: - UrlMap.defaultCustomErrorResponsePolicy are + configured with policies for 5xx and 4xx errors - A RouteRule for + /coming_soon/ is configured for the error code 404. If the request + is for www.myotherdomain.com and a 404 is encountered, the policy + under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 + response is encountered for the request + www.example.com/current_events/, the pathMatcher's policy takes + effect. If however, the request for www.example.com/coming_soon/ + encounters a 404, the policy in RouteRule.customErrorResponsePolicy + takes effect. If any of the requests in this example encounter a 500 + error code, the policy at UrlMap.defaultCustomErrorResponsePolicy + takes effect. When used in conjunction with + routeRules.routeAction.retryPolicy, retries take precedence. Only + once all retries are exhausted, the customErrorResponsePolicy is + applied. While attempting a retry, if load balancer is successful in + reaching the service, the customErrorResponsePolicy is ignored and + the response from the service is returned to the client. + customErrorResponsePolicy is supported only for global external + Application Load Balancers. + $ref: '#/components/schemas/CustomErrorResponsePolicy' HttpRouteRuleMatch: id: HttpRouteRuleMatch description: >- @@ -57451,8 +58862,9 @@ components: stackType: description: >- The stack type for this VPN gateway to identify the IP protocols - that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not - specified, IPV4_ONLY will be used. + that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, + IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP + version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. type: string enumDescriptions: - Enable VPN gateway with both IPv4 and IPv6 protocols. @@ -58240,6 +59652,7 @@ components: description: >- URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + This field can be set only for Classic VPN tunnels. type: string vpnGateway: description: >- @@ -58282,7 +59695,9 @@ components: description: URL of the router resource to be used for dynamic routing. type: string peerIp: - description: IP address of the peer VPN gateway. Only IPv4 is supported. + description: >- + IP address of the peer VPN gateway. Only IPv4 is supported. This + field can be set only for Classic VPN tunnels. type: string sharedSecret: description: >- @@ -58369,7 +59784,8 @@ components: Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 - is supported. + is supported for Classic VPN tunnels. This field is output only for + HA VPN tunnels. type: array items: type: string @@ -58378,7 +59794,8 @@ components: Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. - Only IPv4 is supported. + Only IPv4 is supported for Classic VPN tunnels. This field is output + only for HA VPN tunnels. type: array items: type: string @@ -58980,7 +60397,7 @@ components: description: >- Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone - us-east1-a is located in the us-east1 region. For more information, read + us-east1-b is located in the us-east1 region. For more information, read Regions and Zones. type: object properties: @@ -59165,16 +60582,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_1 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1acceleratorTypes/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].acceleratorTypes[*] - aggregated_list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -59190,6 +60604,7 @@ components: #/components/x-stackQL-resources/accelerator_types/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] global_operations: id: google.compute.global_operations @@ -59228,6 +60643,7 @@ components: - $ref: '#/components/x-stackQL-resources/global_operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/global_operations/methods/delete' global_operations_aggregated: @@ -59235,22 +60651,20 @@ components: name: global_operations_aggregated title: Global_operations_aggregated methods: - _aggregated_list: - operation: &ref_3 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1operations/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].operations[*] - aggregated_list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/global_operations_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] global_organization_operations: id: google.compute.global_organization_operations @@ -59283,6 +60697,7 @@ components: #/components/x-stackQL-resources/global_organization_operations/methods/list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/global_organization_operations/methods/delete @@ -59324,6 +60739,7 @@ components: - $ref: '#/components/x-stackQL-resources/zone_operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/zone_operations/methods/delete' region_operations: @@ -59364,6 +60780,7 @@ components: - $ref: '#/components/x-stackQL-resources/region_operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/region_operations/methods/delete' global_addresses: @@ -59416,6 +60833,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/global_addresses/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/global_addresses/methods/delete' addresses: @@ -59435,16 +60853,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_5 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1addresses/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].addresses[*] - aggregated_list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -59481,6 +60896,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/addresses/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/addresses/methods/delete' images: @@ -59540,6 +60956,7 @@ components: - $ref: '#/components/x-stackQL-resources/images/methods/insert' update: - $ref: '#/components/x-stackQL-resources/images/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/images/methods/delete' images_from_family: @@ -59560,23 +60977,21 @@ components: #/components/x-stackQL-resources/images_from_family/methods/get_from_family insert: [] update: [] + replace: [] delete: [] images_iam_policies: id: google.compute.images_iam_policies name: images_iam_policies title: Images_iam_policies methods: - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1images~1{resource}~1getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 set_iam_policy: operation: $ref: >- @@ -59597,6 +61012,9 @@ components: #/components/x-stackQL-resources/images_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/images_iam_policies/methods/set_iam_policy delete: [] image_family_views: id: google.compute.image_family_views @@ -59615,6 +61033,7 @@ components: - $ref: '#/components/x-stackQL-resources/image_family_views/methods/get' insert: [] update: [] + replace: [] delete: [] snapshots: id: google.compute.snapshots @@ -59660,6 +61079,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/snapshots/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' snapshots_iam_policies: @@ -59667,17 +61087,14 @@ components: name: snapshots_iam_policies title: Snapshots_iam_policies methods: - _get_iam_policy: - operation: &ref_9 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1snapshots~1{resource}~1getIamPolicy/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_9 - response: *ref_10 set_iam_policy: operation: $ref: >- @@ -59698,6 +61115,9 @@ components: #/components/x-stackQL-resources/snapshots_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/snapshots_iam_policies/methods/set_iam_policy delete: [] disks: id: google.compute.disks @@ -59716,16 +61136,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_11 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1disks/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].disks[*] - aggregated_list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: '#/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{disk}/get' @@ -59793,8 +61210,10 @@ components: - $ref: '#/components/x-stackQL-resources/disks/methods/aggregated_list' insert: - $ref: '#/components/x-stackQL-resources/disks/methods/insert' + - $ref: '#/components/x-stackQL-resources/disks/methods/bulk_insert' update: - $ref: '#/components/x-stackQL-resources/disks/methods/update' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/disks/methods/delete' disks_snapshot: @@ -59815,6 +61234,7 @@ components: - $ref: >- #/components/x-stackQL-resources/disks_snapshot/methods/create_snapshot update: [] + replace: [] delete: [] disks_resource_policies: id: google.compute.disks_resource_policies @@ -59837,25 +61257,27 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/disks_resource_policies/methods/add_resource_policies update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/disks_resource_policies/methods/remove_resource_policies disks_iam_policies: id: google.compute.disks_iam_policies name: disks_iam_policies title: Disks_iam_policies methods: - _get_iam_policy: - operation: &ref_13 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1zones~1{zone}~1disks~1{resource}~1getIamPolicy/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_13 - response: *ref_14 set_iam_policy: operation: $ref: >- @@ -59876,6 +61298,9 @@ components: #/components/x-stackQL-resources/disks_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/disks_iam_policies/methods/set_iam_policy delete: [] region_disks: id: google.compute.region_disks @@ -59963,8 +61388,10 @@ components: - $ref: '#/components/x-stackQL-resources/region_disks/methods/list' insert: - $ref: '#/components/x-stackQL-resources/region_disks/methods/insert' + - $ref: '#/components/x-stackQL-resources/region_disks/methods/bulk_insert' update: - $ref: '#/components/x-stackQL-resources/region_disks/methods/update' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/region_disks/methods/delete' region_disks_snapshot: @@ -59985,6 +61412,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_disks_snapshot/methods/create_snapshot update: [] + replace: [] delete: [] region_disks_resource_policies: id: google.compute.region_disks_resource_policies @@ -60007,25 +61435,27 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/region_disks_resource_policies/methods/add_resource_policies update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/region_disks_resource_policies/methods/remove_resource_policies region_disks_iam_policies: id: google.compute.region_disks_iam_policies name: region_disks_iam_policies title: Region_disks_iam_policies methods: - _get_iam_policy: - operation: &ref_15 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1disks~1{resource}~1getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_15 - response: *ref_16 set_iam_policy: operation: $ref: >- @@ -60046,6 +61476,9 @@ components: #/components/x-stackQL-resources/region_disks_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/region_disks_iam_policies/methods/set_iam_policy delete: [] firewalls: id: google.compute.firewalls @@ -60096,8 +61529,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/firewalls/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/firewalls/methods/update' - $ref: '#/components/x-stackQL-resources/firewalls/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/firewalls/methods/update' delete: - $ref: '#/components/x-stackQL-resources/firewalls/methods/delete' firewall_policies: @@ -60167,6 +61601,9 @@ components: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/insert' update: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/firewall_policies/methods/patch_rule + replace: [] delete: - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/delete' firewall_policies_rule: @@ -60199,9 +61636,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/firewall_policies_rule/methods/get_rule - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/firewall_policies_rule/methods/add_rule update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/firewall_policies_rule/methods/remove_rule firewall_policies_association: id: google.compute.firewall_policies_association name: firewall_policies_association @@ -60232,9 +61674,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/firewall_policies_association/methods/get_association - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/firewall_policies_association/methods/add_association update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/firewall_policies_association/methods/remove_association firewall_policies_associations: id: google.compute.firewall_policies_associations name: firewall_policies_associations @@ -60253,23 +61700,21 @@ components: #/components/x-stackQL-resources/firewall_policies_associations/methods/list_associations insert: [] update: [] + replace: [] delete: [] firewall_policies_iam_policies: id: google.compute.firewall_policies_iam_policies name: firewall_policies_iam_policies title: Firewall_policies_iam_policies methods: - _get_iam_policy: - operation: &ref_17 + get_iam_policy: + operation: $ref: >- #/paths/~1locations~1global~1firewallPolicies~1{resource}~1getIamPolicy/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_17 - response: *ref_18 set_iam_policy: operation: $ref: >- @@ -60290,6 +61735,9 @@ components: #/components/x-stackQL-resources/firewall_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/firewall_policies_iam_policies/methods/set_iam_policy delete: [] network_firewall_policies: id: google.compute.network_firewall_policies @@ -60355,6 +61803,9 @@ components: update: - $ref: >- #/components/x-stackQL-resources/network_firewall_policies/methods/patch + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies/methods/patch_rule + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/network_firewall_policies/methods/delete @@ -60388,25 +61839,27 @@ components: select: - $ref: >- #/components/x-stackQL-resources/network_firewall_policies_rule/methods/get_rule - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies_rule/methods/add_rule update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies_rule/methods/remove_rule network_firewall_policies_iam_policies: id: google.compute.network_firewall_policies_iam_policies name: network_firewall_policies_iam_policies title: Network_firewall_policies_iam_policies methods: - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1firewallPolicies~1{resource}~1getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 set_iam_policy: operation: $ref: >- @@ -60427,6 +61880,9 @@ components: #/components/x-stackQL-resources/network_firewall_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies_iam_policies/methods/set_iam_policy delete: [] network_firewall_policies_association: id: google.compute.network_firewall_policies_association @@ -60458,9 +61914,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/network_firewall_policies_association/methods/get_association - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies_association/methods/add_association update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/network_firewall_policies_association/methods/remove_association region_network_firewall_policies: id: google.compute.region_network_firewall_policies name: region_network_firewall_policies @@ -60527,6 +61988,9 @@ components: update: - $ref: >- #/components/x-stackQL-resources/region_network_firewall_policies/methods/patch + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies/methods/patch_rule + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_network_firewall_policies/methods/delete @@ -60560,9 +62024,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/region_network_firewall_policies_rule/methods/get_rule - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies_rule/methods/add_rule update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies_rule/methods/remove_rule region_network_firewall_policies_association: id: google.compute.region_network_firewall_policies_association name: region_network_firewall_policies_association @@ -60593,9 +62062,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/region_network_firewall_policies_association/methods/get_association - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies_association/methods/add_association update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies_association/methods/remove_association region_network_firewall_policies_effective_firewalls: id: google.compute.region_network_firewall_policies_effective_firewalls name: region_network_firewall_policies_effective_firewalls @@ -60614,23 +62088,21 @@ components: #/components/x-stackQL-resources/region_network_firewall_policies_effective_firewalls/methods/get_effective_firewalls insert: [] update: [] + replace: [] delete: [] region_network_firewall_policies_iam_policies: id: google.compute.region_network_firewall_policies_iam_policies name: region_network_firewall_policies_iam_policies title: Region_network_firewall_policies_iam_policies methods: - _get_iam_policy: - operation: &ref_21 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1firewallPolicies~1{resource}~1getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_21 - response: *ref_22 set_iam_policy: operation: $ref: >- @@ -60651,6 +62123,9 @@ components: #/components/x-stackQL-resources/region_network_firewall_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/region_network_firewall_policies_iam_policies/methods/set_iam_policy delete: [] security_policies: id: google.compute.security_policies @@ -60712,6 +62187,9 @@ components: - $ref: '#/components/x-stackQL-resources/security_policies/methods/insert' update: - $ref: '#/components/x-stackQL-resources/security_policies/methods/patch' + - $ref: >- + #/components/x-stackQL-resources/security_policies/methods/patch_rule + replace: [] delete: - $ref: '#/components/x-stackQL-resources/security_policies/methods/delete' security_policies_rule: @@ -60744,9 +62222,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/security_policies_rule/methods/get_rule - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/security_policies_rule/methods/add_rule update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/security_policies_rule/methods/remove_rule security_policies_preconfigured_expression_sets: id: google.compute.security_policies_preconfigured_expression_sets name: security_policies_preconfigured_expression_sets @@ -60765,28 +62248,27 @@ components: #/components/x-stackQL-resources/security_policies_preconfigured_expression_sets/methods/list_preconfigured_expression_sets insert: [] update: [] + replace: [] delete: [] security_policies_aggregated: id: google.compute.security_policies_aggregated name: security_policies_aggregated title: Security_policies_aggregated methods: - _aggregated_list: - operation: &ref_23 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1securityPolicies/get' - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].securityPolicies[*] - aggregated_list: - operation: *ref_23 - response: *ref_24 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/security_policies_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_security_policies: id: google.compute.region_security_policies @@ -60847,6 +62329,9 @@ components: update: - $ref: >- #/components/x-stackQL-resources/region_security_policies/methods/patch + - $ref: >- + #/components/x-stackQL-resources/region_security_policies/methods/patch_rule + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_security_policies/methods/delete @@ -60880,9 +62365,14 @@ components: select: - $ref: >- #/components/x-stackQL-resources/region_security_policies_rule/methods/get_rule - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/region_security_policies_rule/methods/add_rule update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/region_security_policies_rule/methods/remove_rule instances: id: google.compute.instances name: instances @@ -60900,16 +62390,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_25 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1instances/get' - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].instances[*] - aggregated_list: - operation: *ref_25 - response: *ref_26 get: operation: $ref: >- @@ -61113,7 +62600,9 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/aggregated_list' insert: - $ref: '#/components/x-stackQL-resources/instances/methods/insert' - update: + - $ref: '#/components/x-stackQL-resources/instances/methods/bulk_insert' + update: [] + replace: - $ref: '#/components/x-stackQL-resources/instances/methods/update' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' @@ -61135,6 +62624,7 @@ components: #/components/x-stackQL-resources/instances_referrers/methods/list_referrers insert: [] update: [] + replace: [] delete: [] instances_access_config: id: google.compute.instances_access_config @@ -61164,9 +62654,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] - update: [] - delete: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/instances_access_config/methods/add_access_config + update: + - $ref: >- + #/components/x-stackQL-resources/instances_access_config/methods/update_access_config + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/instances_access_config/methods/delete_access_config instances_network_interface: id: google.compute.instances_network_interface name: instances_network_interface @@ -61182,7 +62679,10 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instances_network_interface/methods/update_network_interface + replace: [] delete: [] instances_serial_port_output: id: google.compute.instances_serial_port_output @@ -61202,6 +62702,7 @@ components: #/components/x-stackQL-resources/instances_serial_port_output/methods/get_serial_port_output insert: [] update: [] + replace: [] delete: [] instances_screenshot: id: google.compute.instances_screenshot @@ -61221,6 +62722,7 @@ components: #/components/x-stackQL-resources/instances_screenshot/methods/get_screenshot insert: [] update: [] + replace: [] delete: [] instances_guest_attributes: id: google.compute.instances_guest_attributes @@ -61240,23 +62742,21 @@ components: #/components/x-stackQL-resources/instances_guest_attributes/methods/get_guest_attributes insert: [] update: [] + replace: [] delete: [] instances_iam_policies: id: google.compute.instances_iam_policies name: instances_iam_policies title: Instances_iam_policies methods: - _get_iam_policy: - operation: &ref_27 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1zones~1{zone}~1instances~1{resource}~1getIamPolicy/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_27 - response: *ref_28 set_iam_policy: operation: $ref: >- @@ -61277,6 +62777,9 @@ components: #/components/x-stackQL-resources/instances_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/set_iam_policy delete: [] instances_resource_policies: id: google.compute.instances_resource_policies @@ -61299,9 +62802,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/instances_resource_policies/methods/add_resource_policies update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/instances_resource_policies/methods/remove_resource_policies instances_shielded_instance_config: id: google.compute.instances_shielded_instance_config name: instances_shielded_instance_config @@ -61317,7 +62825,10 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instances_shielded_instance_config/methods/update_shielded_instance_config + replace: [] delete: [] instances_display_device: id: google.compute.instances_display_device @@ -61334,7 +62845,10 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instances_display_device/methods/update_display_device + replace: [] delete: [] instances_shielded_instance_identity: id: google.compute.instances_shielded_instance_identity @@ -61354,6 +62868,7 @@ components: #/components/x-stackQL-resources/instances_shielded_instance_identity/methods/get_shielded_instance_identity insert: [] update: [] + replace: [] delete: [] instances_effective_firewalls: id: google.compute.instances_effective_firewalls @@ -61373,6 +62888,7 @@ components: #/components/x-stackQL-resources/instances_effective_firewalls/methods/get_effective_firewalls insert: [] update: [] + replace: [] delete: [] region_instances: id: google.compute.region_instances @@ -61388,8 +62904,11 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/region_instances/methods/bulk_insert update: [] + replace: [] delete: [] reservations: id: google.compute.reservations @@ -61408,16 +62927,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_29 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1reservations/get' - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].reservations[*] - aggregated_list: - operation: *ref_29 - response: *ref_30 get: operation: $ref: >- @@ -61456,6 +62972,7 @@ components: - $ref: '#/components/x-stackQL-resources/reservations/methods/insert' update: - $ref: '#/components/x-stackQL-resources/reservations/methods/update' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/reservations/methods/delete' reservations_iam_policies: @@ -61463,17 +62980,14 @@ components: name: reservations_iam_policies title: Reservations_iam_policies methods: - _get_iam_policy: - operation: &ref_31 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1zones~1{zone}~1reservations~1{resource}~1getIamPolicy/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_31 - response: *ref_32 set_iam_policy: operation: $ref: >- @@ -61494,6 +63008,9 @@ components: #/components/x-stackQL-resources/reservations_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/reservations_iam_policies/methods/set_iam_policy delete: [] instance_groups: id: google.compute.instance_groups @@ -61512,16 +63029,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_33 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1instanceGroups/get' - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].instanceGroups[*] - aggregated_list: - operation: *ref_33 - response: *ref_34 get: operation: $ref: >- @@ -61552,6 +63066,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/instance_groups/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instance_groups/methods/delete' instance_groups_instances: @@ -61581,10 +63096,17 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instance_groups_instances/methods/list_instances + insert: + - $ref: >- + #/components/x-stackQL-resources/instance_groups_instances/methods/add_instances update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/instance_groups_instances/methods/remove_instances region_instance_groups: id: google.compute.region_instance_groups name: region_instance_groups @@ -61619,6 +63141,7 @@ components: #/components/x-stackQL-resources/region_instance_groups/methods/list insert: [] update: [] + replace: [] delete: [] region_instance_groups_instances: id: google.compute.region_instance_groups_instances @@ -61633,9 +63156,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/region_instance_groups_instances/methods/list_instances insert: [] update: [] + replace: [] delete: [] instance_group_managers: id: google.compute.instance_group_managers @@ -61656,17 +63182,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_35 + aggregated_list: + operation: $ref: >- #/paths/~1projects~1{project}~1aggregated~1instanceGroupManagers/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].instanceGroupManagers[*] - aggregated_list: - operation: *ref_35 - response: *ref_36 get: operation: $ref: >- @@ -61751,6 +63274,9 @@ components: update: - $ref: >- #/components/x-stackQL-resources/instance_group_managers/methods/patch + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers/methods/patch_per_instance_configs + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instance_group_managers/methods/delete @@ -61779,7 +63305,10 @@ components: - $ref: >- #/components/x-stackQL-resources/instance_group_managers_instances/methods/create_instances update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers_instances/methods/delete_instances instance_group_managers_managed_instances: id: google.compute.instance_group_managers_managed_instances name: instance_group_managers_managed_instances @@ -61793,9 +63322,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers_managed_instances/methods/list_managed_instances insert: [] update: [] + replace: [] delete: [] instance_group_managers_errors: id: google.compute.instance_group_managers_errors @@ -61815,6 +63347,7 @@ components: #/components/x-stackQL-resources/instance_group_managers_errors/methods/list_errors insert: [] update: [] + replace: [] delete: [] instance_group_managers_per_instance_configs: id: google.compute.instance_group_managers_per_instance_configs @@ -61843,10 +63376,17 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers_per_instance_configs/methods/list_per_instance_configs insert: [] - update: [] - delete: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers_per_instance_configs/methods/update_per_instance_configs + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/instance_group_managers_per_instance_configs/methods/delete_per_instance_configs instance_group_manager_resize_requests: id: google.compute.instance_group_manager_resize_requests name: instance_group_manager_resize_requests @@ -61897,6 +63437,7 @@ components: - $ref: >- #/components/x-stackQL-resources/instance_group_manager_resize_requests/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instance_group_manager_resize_requests/methods/delete @@ -62001,6 +63542,9 @@ components: update: - $ref: >- #/components/x-stackQL-resources/region_instance_group_managers/methods/patch + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers/methods/patch_per_instance_configs + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_instance_group_managers/methods/delete @@ -62029,7 +63573,10 @@ components: - $ref: >- #/components/x-stackQL-resources/region_instance_group_managers_instances/methods/create_instances update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers_instances/methods/delete_instances region_instance_group_managers_managed_instances: id: google.compute.region_instance_group_managers_managed_instances name: region_instance_group_managers_managed_instances @@ -62043,9 +63590,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers_managed_instances/methods/list_managed_instances insert: [] update: [] + replace: [] delete: [] region_instance_group_managers_errors: id: google.compute.region_instance_group_managers_errors @@ -62065,6 +63615,7 @@ components: #/components/x-stackQL-resources/region_instance_group_managers_errors/methods/list_errors insert: [] update: [] + replace: [] delete: [] region_instance_group_managers_per_instance_configs: id: google.compute.region_instance_group_managers_per_instance_configs @@ -62093,10 +63644,17 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers_per_instance_configs/methods/list_per_instance_configs insert: [] - update: [] - delete: [] + update: + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers_per_instance_configs/methods/update_per_instance_configs + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/region_instance_group_managers_per_instance_configs/methods/delete_per_instance_configs autoscalers: id: google.compute.autoscalers name: autoscalers @@ -62126,16 +63684,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_37 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1autoscalers/get' - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].autoscalers[*] - aggregated_list: - operation: *ref_37 - response: *ref_38 get: operation: $ref: >- @@ -62159,8 +63714,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/autoscalers/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/autoscalers/methods/update' - $ref: '#/components/x-stackQL-resources/autoscalers/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/autoscalers/methods/update' delete: - $ref: '#/components/x-stackQL-resources/autoscalers/methods/delete' region_autoscalers: @@ -62214,8 +63770,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/update' - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/update' delete: - $ref: '#/components/x-stackQL-resources/region_autoscalers/methods/delete' backend_buckets: @@ -62277,8 +63834,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/update' - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/update' delete: - $ref: '#/components/x-stackQL-resources/backend_buckets/methods/delete' backend_buckets_signed_url_key: @@ -62302,25 +63860,27 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/backend_buckets_signed_url_key/methods/add_signed_url_key update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/backend_buckets_signed_url_key/methods/delete_signed_url_key backend_buckets_iam_policies: id: google.compute.backend_buckets_iam_policies name: backend_buckets_iam_policies title: Backend_buckets_iam_policies methods: - _get_iam_policy: - operation: &ref_39 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1backendBuckets~1{resource}~1getIamPolicy/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_39 - response: *ref_40 set_iam_policy: operation: $ref: >- @@ -62341,6 +63901,9 @@ components: #/components/x-stackQL-resources/backend_buckets_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backend_buckets_iam_policies/methods/set_iam_policy delete: [] backend_services: id: google.compute.backend_services @@ -62408,8 +63971,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/backend_services/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/backend_services/methods/update' - $ref: '#/components/x-stackQL-resources/backend_services/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/backend_services/methods/update' delete: - $ref: '#/components/x-stackQL-resources/backend_services/methods/delete' backend_services_aggregated: @@ -62417,22 +63981,20 @@ components: name: backend_services_aggregated title: Backend_services_aggregated methods: - _aggregated_list: - operation: &ref_41 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1backendServices/get' - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].backendServices[*] - aggregated_list: - operation: *ref_41 - response: *ref_42 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/backend_services_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] backend_services_usable: id: google.compute.backend_services_usable @@ -62452,6 +64014,7 @@ components: #/components/x-stackQL-resources/backend_services_usable/methods/list_usable insert: [] update: [] + replace: [] delete: [] backend_services_signed_url_key: id: google.compute.backend_services_signed_url_key @@ -62474,9 +64037,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/backend_services_signed_url_key/methods/add_signed_url_key update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/backend_services_signed_url_key/methods/delete_signed_url_key backend_services_health: id: google.compute.backend_services_health name: backend_services_health @@ -62490,26 +64058,26 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/backend_services_health/methods/get_health insert: [] update: [] + replace: [] delete: [] backend_services_iam_policies: id: google.compute.backend_services_iam_policies name: backend_services_iam_policies title: Backend_services_iam_policies methods: - _get_iam_policy: - operation: &ref_43 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1backendServices~1{resource}~1getIamPolicy/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_43 - response: *ref_44 set_iam_policy: operation: $ref: >- @@ -62530,6 +64098,9 @@ components: #/components/x-stackQL-resources/backend_services_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backend_services_iam_policies/methods/set_iam_policy delete: [] region_backend_services: id: google.compute.region_backend_services @@ -62595,10 +64166,11 @@ components: - $ref: >- #/components/x-stackQL-resources/region_backend_services/methods/insert update: - - $ref: >- - #/components/x-stackQL-resources/region_backend_services/methods/update - $ref: >- #/components/x-stackQL-resources/region_backend_services/methods/patch + replace: + - $ref: >- + #/components/x-stackQL-resources/region_backend_services/methods/update delete: - $ref: >- #/components/x-stackQL-resources/region_backend_services/methods/delete @@ -62620,6 +64192,7 @@ components: #/components/x-stackQL-resources/region_backend_services_usable/methods/list_usable insert: [] update: [] + replace: [] delete: [] region_backend_services_health: id: google.compute.region_backend_services_health @@ -62634,26 +64207,26 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/region_backend_services_health/methods/get_health insert: [] update: [] + replace: [] delete: [] region_backend_services_iam_policies: id: google.compute.region_backend_services_iam_policies name: region_backend_services_iam_policies title: Region_backend_services_iam_policies methods: - _get_iam_policy: - operation: &ref_45 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1backendServices~1{resource}~1getIamPolicy/get - response: &ref_46 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_45 - response: *ref_46 set_iam_policy: operation: $ref: >- @@ -62674,6 +64247,9 @@ components: #/components/x-stackQL-resources/region_backend_services_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/region_backend_services_iam_policies/methods/set_iam_policy delete: [] region_commitments: id: google.compute.region_commitments @@ -62692,16 +64268,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_47 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1commitments/get' - response: &ref_48 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].commitments[*] - aggregated_list: - operation: *ref_47 - response: *ref_48 get: operation: $ref: >- @@ -62726,6 +64299,7 @@ components: - $ref: '#/components/x-stackQL-resources/region_commitments/methods/insert' update: - $ref: '#/components/x-stackQL-resources/region_commitments/methods/update' + replace: [] delete: [] disk_types: id: google.compute.disk_types @@ -62738,16 +64312,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_49 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1diskTypes/get' - response: &ref_50 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].diskTypes[*] - aggregated_list: - operation: *ref_49 - response: *ref_50 get: operation: $ref: >- @@ -62763,6 +64334,7 @@ components: #/components/x-stackQL-resources/disk_types/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_disk_types: id: google.compute.region_disk_types @@ -62788,6 +64360,7 @@ components: - $ref: '#/components/x-stackQL-resources/region_disk_types/methods/list' insert: [] update: [] + replace: [] delete: [] external_vpn_gateways: id: google.compute.external_vpn_gateways @@ -62836,6 +64409,7 @@ components: - $ref: >- #/components/x-stackQL-resources/external_vpn_gateways/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/external_vpn_gateways/methods/delete @@ -62855,6 +64429,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] global_forwarding_rules: id: google.compute.global_forwarding_rules @@ -62920,6 +64495,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/global_forwarding_rules/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/global_forwarding_rules/methods/delete @@ -62942,16 +64518,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_51 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1forwardingRules/get' - response: &ref_52 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].forwardingRules[*] - aggregated_list: - operation: *ref_51 - response: *ref_52 get: operation: $ref: >- @@ -62997,8 +64570,79 @@ components: - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/insert' update: - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/forwarding_rules/methods/delete' + future_reservations: + id: google.compute.future_reservations + name: future_reservations + title: Future_reservations + methods: + insert: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1futureReservations/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1futureReservations/get + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1futureReservations~1{futureReservation}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1futureReservations~1{futureReservation}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1futureReservations~1{futureReservation}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + aggregated_list: + operation: + $ref: '#/paths/~1projects~1{project}~1aggregated~1futureReservations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.items[*].futureReservations[*] + cancel: + operation: + $ref: >- + #/paths/~1projects~1{project}~1zones~1{zone}~1futureReservations~1{futureReservation}~1cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/future_reservations/methods/get' + - $ref: '#/components/x-stackQL-resources/future_reservations/methods/list' + - $ref: >- + #/components/x-stackQL-resources/future_reservations/methods/aggregated_list + insert: + - $ref: >- + #/components/x-stackQL-resources/future_reservations/methods/insert + update: + - $ref: >- + #/components/x-stackQL-resources/future_reservations/methods/update + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/future_reservations/methods/delete region_health_check_services: id: google.compute.region_health_check_services name: region_health_check_services @@ -63051,6 +64695,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/region_health_check_services/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_health_check_services/methods/delete @@ -63106,8 +64751,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/health_checks/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/update' - $ref: '#/components/x-stackQL-resources/health_checks/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/update' delete: - $ref: '#/components/x-stackQL-resources/health_checks/methods/delete' health_checks_aggregated: @@ -63115,22 +64761,20 @@ components: name: health_checks_aggregated title: Health_checks_aggregated methods: - _aggregated_list: - operation: &ref_53 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1healthChecks/get' - response: &ref_54 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].healthChecks[*] - aggregated_list: - operation: *ref_53 - response: *ref_54 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/health_checks_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_health_checks: id: google.compute.region_health_checks @@ -63186,10 +64830,11 @@ components: - $ref: >- #/components/x-stackQL-resources/region_health_checks/methods/insert update: - - $ref: >- - #/components/x-stackQL-resources/region_health_checks/methods/update - $ref: >- #/components/x-stackQL-resources/region_health_checks/methods/patch + replace: + - $ref: >- + #/components/x-stackQL-resources/region_health_checks/methods/update delete: - $ref: >- #/components/x-stackQL-resources/region_health_checks/methods/delete @@ -63245,8 +64890,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/update' - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/update' delete: - $ref: '#/components/x-stackQL-resources/http_health_checks/methods/delete' https_health_checks: @@ -63302,9 +64948,10 @@ components: - $ref: >- #/components/x-stackQL-resources/https_health_checks/methods/insert update: + - $ref: '#/components/x-stackQL-resources/https_health_checks/methods/patch' + replace: - $ref: >- #/components/x-stackQL-resources/https_health_checks/methods/update - - $ref: '#/components/x-stackQL-resources/https_health_checks/methods/patch' delete: - $ref: >- #/components/x-stackQL-resources/https_health_checks/methods/delete @@ -63346,6 +64993,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/instance_templates/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instance_templates/methods/delete' instance_templates_aggregated: @@ -63353,39 +65001,34 @@ components: name: instance_templates_aggregated title: Instance_templates_aggregated methods: - _aggregated_list: - operation: &ref_55 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1instanceTemplates/get' - response: &ref_56 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].instanceTemplates[*] - aggregated_list: - operation: *ref_55 - response: *ref_56 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/instance_templates_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] instance_templates_iam_policies: id: google.compute.instance_templates_iam_policies name: instance_templates_iam_policies title: Instance_templates_iam_policies methods: - _get_iam_policy: - operation: &ref_57 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1instanceTemplates~1{resource}~1getIamPolicy/get - response: &ref_58 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_57 - response: *ref_58 set_iam_policy: operation: $ref: >- @@ -63406,6 +65049,9 @@ components: #/components/x-stackQL-resources/instance_templates_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instance_templates_iam_policies/methods/set_iam_policy delete: [] region_instance_templates: id: google.compute.region_instance_templates @@ -63450,6 +65096,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_instance_templates/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_instance_templates/methods/delete @@ -63477,6 +65124,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/instance_settings/methods/patch' + replace: [] delete: [] instant_snapshots: id: google.compute.instant_snapshots @@ -63517,16 +65165,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_59 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1instantSnapshots/get' - response: &ref_60 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].instantSnapshots[*] - aggregated_list: - operation: *ref_59 - response: *ref_60 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/instant_snapshots/methods/get' @@ -63536,6 +65181,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/instant_snapshots/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instant_snapshots/methods/delete' instant_snapshots_iam_policies: @@ -63543,17 +65189,14 @@ components: name: instant_snapshots_iam_policies title: Instant_snapshots_iam_policies methods: - _get_iam_policy: - operation: &ref_61 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1zones~1{zone}~1instantSnapshots~1{resource}~1getIamPolicy/get - response: &ref_62 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_61 - response: *ref_62 set_iam_policy: operation: $ref: >- @@ -63574,6 +65217,9 @@ components: #/components/x-stackQL-resources/instant_snapshots_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instant_snapshots_iam_policies/methods/set_iam_policy delete: [] region_instant_snapshots: id: google.compute.region_instant_snapshots @@ -63625,6 +65271,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_instant_snapshots/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_instant_snapshots/methods/delete @@ -63633,17 +65280,14 @@ components: name: region_instant_snapshots_iam_policies title: Region_instant_snapshots_iam_policies methods: - _get_iam_policy: - operation: &ref_63 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1instantSnapshots~1{resource}~1getIamPolicy/get - response: &ref_64 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_63 - response: *ref_64 set_iam_policy: operation: $ref: >- @@ -63664,6 +65308,9 @@ components: #/components/x-stackQL-resources/region_instant_snapshots_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/region_instant_snapshots_iam_policies/methods/set_iam_policy delete: [] interconnect_attachments: id: google.compute.interconnect_attachments @@ -63684,17 +65331,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_65 + aggregated_list: + operation: $ref: >- #/paths/~1projects~1{project}~1aggregated~1interconnectAttachments/get - response: &ref_66 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].interconnectAttachments[*] - aggregated_list: - operation: *ref_65 - response: *ref_66 get: operation: $ref: >- @@ -63737,6 +65381,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/interconnect_attachments/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/interconnect_attachments/methods/delete @@ -63793,6 +65438,7 @@ components: - $ref: '#/components/x-stackQL-resources/interconnects/methods/insert' update: - $ref: '#/components/x-stackQL-resources/interconnects/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/interconnects/methods/delete' interconnects_diagnostics: @@ -63813,6 +65459,7 @@ components: #/components/x-stackQL-resources/interconnects_diagnostics/methods/get_diagnostics insert: [] update: [] + replace: [] delete: [] interconnects_macsec_config: id: google.compute.interconnects_macsec_config @@ -63832,6 +65479,7 @@ components: #/components/x-stackQL-resources/interconnects_macsec_config/methods/get_macsec_config insert: [] update: [] + replace: [] delete: [] interconnect_locations: id: google.compute.interconnect_locations @@ -63859,6 +65507,7 @@ components: #/components/x-stackQL-resources/interconnect_locations/methods/list insert: [] update: [] + replace: [] delete: [] interconnect_remote_locations: id: google.compute.interconnect_remote_locations @@ -63887,6 +65536,7 @@ components: #/components/x-stackQL-resources/interconnect_remote_locations/methods/list insert: [] update: [] + replace: [] delete: [] license_codes: id: google.compute.license_codes @@ -63905,6 +65555,7 @@ components: - $ref: '#/components/x-stackQL-resources/license_codes/methods/get' insert: [] update: [] + replace: [] delete: [] license_codes_iam_policies: id: google.compute.license_codes_iam_policies @@ -63922,6 +65573,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] licenses: id: google.compute.licenses @@ -63959,6 +65611,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/licenses/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/licenses/methods/delete' licenses_iam_policies: @@ -63966,17 +65619,14 @@ components: name: licenses_iam_policies title: Licenses_iam_policies methods: - _get_iam_policy: - operation: &ref_67 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1licenses~1{resource}~1getIamPolicy/get - response: &ref_68 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_67 - response: *ref_68 set_iam_policy: operation: $ref: >- @@ -63997,6 +65647,9 @@ components: #/components/x-stackQL-resources/licenses_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/licenses_iam_policies/methods/set_iam_policy delete: [] machine_images: id: google.compute.machine_images @@ -64036,6 +65689,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/machine_images/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/machine_images/methods/delete' machine_images_iam_policies: @@ -64043,17 +65697,14 @@ components: name: machine_images_iam_policies title: Machine_images_iam_policies methods: - _get_iam_policy: - operation: &ref_69 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1global~1machineImages~1{resource}~1getIamPolicy/get - response: &ref_70 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_69 - response: *ref_70 set_iam_policy: operation: $ref: >- @@ -64074,6 +65725,9 @@ components: #/components/x-stackQL-resources/machine_images_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/machine_images_iam_policies/methods/set_iam_policy delete: [] machine_types: id: google.compute.machine_types @@ -64086,16 +65740,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_71 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1machineTypes/get' - response: &ref_72 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].machineTypes[*] - aggregated_list: - operation: *ref_71 - response: *ref_72 get: operation: $ref: >- @@ -64111,22 +65762,20 @@ components: #/components/x-stackQL-resources/machine_types/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] network_attachments: id: google.compute.network_attachments name: network_attachments title: Network_attachments methods: - _aggregated_list: - operation: &ref_73 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1networkAttachments/get' - response: &ref_74 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].networkAttachments[*] - aggregated_list: - operation: *ref_73 - response: *ref_74 list: operation: $ref: >- @@ -64173,6 +65822,7 @@ components: #/components/x-stackQL-resources/network_attachments/methods/insert update: - $ref: '#/components/x-stackQL-resources/network_attachments/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/network_attachments/methods/delete @@ -64181,17 +65831,14 @@ components: name: network_attachments_iam_policies title: Network_attachments_iam_policies methods: - _get_iam_policy: - operation: &ref_75 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1networkAttachments~1{resource}~1getIamPolicy/get - response: &ref_76 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_75 - response: *ref_76 set_iam_policy: operation: $ref: >- @@ -64212,6 +65859,9 @@ components: #/components/x-stackQL-resources/network_attachments_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/network_attachments_iam_policies/methods/set_iam_policy delete: [] network_edge_security_services: id: google.compute.network_edge_security_services @@ -64246,17 +65896,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_77 + aggregated_list: + operation: $ref: >- #/paths/~1projects~1{project}~1aggregated~1networkEdgeSecurityServices/get - response: &ref_78 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].networkEdgeSecurityServices[*] - aggregated_list: - operation: *ref_77 - response: *ref_78 sqlVerbs: select: - $ref: >- @@ -64269,6 +65916,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/network_edge_security_services/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/network_edge_security_services/methods/delete @@ -64291,17 +65939,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_79 + aggregated_list: + operation: $ref: >- #/paths/~1projects~1{project}~1aggregated~1networkEndpointGroups/get - response: &ref_80 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].networkEndpointGroups[*] - aggregated_list: - operation: *ref_79 - response: *ref_80 get: operation: $ref: >- @@ -64342,6 +65987,7 @@ components: - $ref: >- #/components/x-stackQL-resources/network_endpoint_groups/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/network_endpoint_groups/methods/delete @@ -64358,9 +66004,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/network_endpoint_groups_network_endpoints/methods/list_network_endpoints insert: [] update: [] + replace: [] delete: [] network_endpoint_groups_iam_policies: id: google.compute.network_endpoint_groups_iam_policies @@ -64378,6 +66027,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] global_network_endpoint_groups: id: google.compute.global_network_endpoint_groups @@ -64434,6 +66084,7 @@ components: - $ref: >- #/components/x-stackQL-resources/global_network_endpoint_groups/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/global_network_endpoint_groups/methods/delete @@ -64450,9 +66101,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/global_network_endpoint_groups_network_endpoints/methods/list_network_endpoints insert: [] update: [] + replace: [] delete: [] region_network_endpoint_groups: id: google.compute.region_network_endpoint_groups @@ -64511,6 +66165,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_network_endpoint_groups/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_network_endpoint_groups/methods/delete @@ -64527,9 +66182,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/region_network_endpoint_groups_network_endpoints/methods/list_network_endpoints insert: [] update: [] + replace: [] delete: [] networks: id: google.compute.networks @@ -64581,6 +66239,7 @@ components: - $ref: '#/components/x-stackQL-resources/networks/methods/insert' update: - $ref: '#/components/x-stackQL-resources/networks/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/networks/methods/delete' networks_peering: @@ -64611,9 +66270,16 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] - update: [] - delete: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/networks_peering/methods/add_peering + update: + - $ref: >- + #/components/x-stackQL-resources/networks_peering/methods/update_peering + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/networks_peering/methods/remove_peering networks_effective_firewalls: id: google.compute.networks_effective_firewalls name: networks_effective_firewalls @@ -64632,6 +66298,7 @@ components: #/components/x-stackQL-resources/networks_effective_firewalls/methods/get_effective_firewalls insert: [] update: [] + replace: [] delete: [] networks_peering_routes: id: google.compute.networks_peering_routes @@ -64651,6 +66318,7 @@ components: #/components/x-stackQL-resources/networks_peering_routes/methods/list_peering_routes insert: [] update: [] + replace: [] delete: [] node_groups: id: google.compute.node_groups @@ -64669,16 +66337,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_81 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1nodeGroups/get' - response: &ref_82 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].nodeGroups[*] - aggregated_list: - operation: *ref_81 - response: *ref_82 get: operation: $ref: >- @@ -64731,6 +66396,7 @@ components: - $ref: '#/components/x-stackQL-resources/node_groups/methods/insert' update: - $ref: '#/components/x-stackQL-resources/node_groups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/node_groups/methods/delete' node_groups_nodes: @@ -64760,26 +66426,30 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] + select: + - $ref: >- + #/components/x-stackQL-resources/node_groups_nodes/methods/list_nodes + insert: + - $ref: >- + #/components/x-stackQL-resources/node_groups_nodes/methods/add_nodes update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/node_groups_nodes/methods/delete_nodes node_groups_iam_policies: id: google.compute.node_groups_iam_policies name: node_groups_iam_policies title: Node_groups_iam_policies methods: - _get_iam_policy: - operation: &ref_83 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1zones~1{zone}~1nodeGroups~1{resource}~1getIamPolicy/get - response: &ref_84 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_83 - response: *ref_84 set_iam_policy: operation: $ref: >- @@ -64800,6 +66470,9 @@ components: #/components/x-stackQL-resources/node_groups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/node_groups_iam_policies/methods/set_iam_policy delete: [] node_templates: id: google.compute.node_templates @@ -64820,16 +66493,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_85 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1nodeTemplates/get' - response: &ref_86 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].nodeTemplates[*] - aggregated_list: - operation: *ref_85 - response: *ref_86 get: operation: $ref: >- @@ -64853,6 +66523,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/node_templates/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/node_templates/methods/delete' node_templates_iam_policies: @@ -64860,17 +66531,14 @@ components: name: node_templates_iam_policies title: Node_templates_iam_policies methods: - _get_iam_policy: - operation: &ref_87 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1nodeTemplates~1{resource}~1getIamPolicy/get - response: &ref_88 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_87 - response: *ref_88 set_iam_policy: operation: $ref: >- @@ -64891,6 +66559,9 @@ components: #/components/x-stackQL-resources/node_templates_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/node_templates_iam_policies/methods/set_iam_policy delete: [] node_types: id: google.compute.node_types @@ -64903,16 +66574,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_89 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1nodeTypes/get' - response: &ref_90 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].nodeTypes[*] - aggregated_list: - operation: *ref_89 - response: *ref_90 get: operation: $ref: >- @@ -64928,6 +66596,7 @@ components: #/components/x-stackQL-resources/node_types/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_notification_endpoints: id: google.compute.region_notification_endpoints @@ -64972,6 +66641,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_notification_endpoints/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_notification_endpoints/methods/delete @@ -65015,16 +66685,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_91 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1packetMirrorings/get' - response: &ref_92 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].packetMirrorings[*] - aggregated_list: - operation: *ref_91 - response: *ref_92 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/packet_mirrorings/methods/get' @@ -65035,6 +66702,7 @@ components: - $ref: '#/components/x-stackQL-resources/packet_mirrorings/methods/insert' update: - $ref: '#/components/x-stackQL-resources/packet_mirrorings/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/packet_mirrorings/methods/delete' packet_mirrorings_iam_policies: @@ -65053,6 +66721,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] projects: id: google.compute.projects @@ -65130,6 +66799,7 @@ components: - $ref: '#/components/x-stackQL-resources/projects/methods/get' insert: [] update: [] + replace: [] delete: [] xpn_hosts: id: google.compute.xpn_hosts @@ -65143,9 +66813,11 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/xpn_hosts/methods/list_xpn_hosts' insert: [] update: [] + replace: [] delete: [] xpn_host: id: google.compute.xpn_host @@ -65163,28 +66835,27 @@ components: - $ref: '#/components/x-stackQL-resources/xpn_host/methods/get_xpn_host' insert: [] update: [] + replace: [] delete: [] xpn_resources: id: google.compute.xpn_resources name: xpn_resources title: Xpn_resources methods: - _get_xpn_resources: - operation: &ref_93 + get_xpn_resources: + operation: $ref: '#/paths/~1projects~1{project}~1getXpnResources/get' - response: &ref_94 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resources - get_xpn_resources: - operation: *ref_93 - response: *ref_94 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/xpn_resources/methods/get_xpn_resources insert: [] update: [] + replace: [] delete: [] public_advertised_prefixes: id: google.compute.public_advertised_prefixes @@ -65252,6 +66923,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/public_advertised_prefixes/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/public_advertised_prefixes/methods/delete @@ -65306,6 +66978,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/global_public_delegated_prefixes/methods/delete @@ -65363,17 +67036,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_95 + aggregated_list: + operation: $ref: >- #/paths/~1projects~1{project}~1aggregated~1publicDelegatedPrefixes/get - response: &ref_96 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].publicDelegatedPrefixes[*] - aggregated_list: - operation: *ref_95 - response: *ref_96 sqlVerbs: select: - $ref: >- @@ -65388,6 +67058,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/public_delegated_prefixes/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/public_delegated_prefixes/methods/delete @@ -65414,6 +67085,7 @@ components: - $ref: '#/components/x-stackQL-resources/regions/methods/list' insert: [] update: [] + replace: [] delete: [] resource_policies: id: google.compute.resource_policies @@ -65434,16 +67106,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_97 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1resourcePolicies/get' - response: &ref_98 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].resourcePolicies[*] - aggregated_list: - operation: *ref_97 - response: *ref_98 get: operation: $ref: >- @@ -65475,6 +67144,7 @@ components: - $ref: '#/components/x-stackQL-resources/resource_policies/methods/insert' update: - $ref: '#/components/x-stackQL-resources/resource_policies/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete' resource_policies_iam_policies: @@ -65482,17 +67152,14 @@ components: name: resource_policies_iam_policies title: Resource_policies_iam_policies methods: - _get_iam_policy: - operation: &ref_99 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1resourcePolicies~1{resource}~1getIamPolicy/get - response: &ref_100 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_99 - response: *ref_100 set_iam_policy: operation: $ref: >- @@ -65513,6 +67180,9 @@ components: #/components/x-stackQL-resources/resource_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/resource_policies_iam_policies/methods/set_iam_policy delete: [] routes: id: google.compute.routes @@ -65550,6 +67220,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/routes/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/routes/methods/delete' routers: @@ -65597,16 +67268,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_101 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1routers/get' - response: &ref_102 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].routers[*] - aggregated_list: - operation: *ref_101 - response: *ref_102 preview: operation: $ref: >- @@ -65622,8 +67290,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/routers/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/routers/methods/update' - $ref: '#/components/x-stackQL-resources/routers/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/routers/methods/update' delete: - $ref: '#/components/x-stackQL-resources/routers/methods/delete' routers_router_status: @@ -65644,29 +67313,28 @@ components: #/components/x-stackQL-resources/routers_router_status/methods/get_router_status insert: [] update: [] + replace: [] delete: [] routers_nat_mapping_info: id: google.compute.routers_nat_mapping_info name: routers_nat_mapping_info title: Routers_nat_mapping_info methods: - _get_nat_mapping_info: - operation: &ref_103 + get_nat_mapping_info: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1routers~1{router}~1getNatMappingInfo/get - response: &ref_104 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.result - get_nat_mapping_info: - operation: *ref_103 - response: *ref_104 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/routers_nat_mapping_info/methods/get_nat_mapping_info insert: [] update: [] + replace: [] delete: [] routers_nat_ip_info: id: google.compute.routers_nat_ip_info @@ -65686,22 +67354,20 @@ components: #/components/x-stackQL-resources/routers_nat_ip_info/methods/get_nat_ip_info insert: [] update: [] + replace: [] delete: [] service_attachments: id: google.compute.service_attachments name: service_attachments title: Service_attachments methods: - _aggregated_list: - operation: &ref_105 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1serviceAttachments/get' - response: &ref_106 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].serviceAttachments[*] - aggregated_list: - operation: *ref_105 - response: *ref_106 list: operation: $ref: >- @@ -65748,6 +67414,7 @@ components: #/components/x-stackQL-resources/service_attachments/methods/insert update: - $ref: '#/components/x-stackQL-resources/service_attachments/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/service_attachments/methods/delete @@ -65756,17 +67423,14 @@ components: name: service_attachments_iam_policies title: Service_attachments_iam_policies methods: - _get_iam_policy: - operation: &ref_107 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1serviceAttachments~1{resource}~1getIamPolicy/get - response: &ref_108 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_107 - response: *ref_108 set_iam_policy: operation: $ref: >- @@ -65787,6 +67451,9 @@ components: #/components/x-stackQL-resources/service_attachments_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/service_attachments_iam_policies/methods/set_iam_policy delete: [] snapshot_settings: id: google.compute.snapshot_settings @@ -65811,6 +67478,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/snapshot_settings/methods/patch' + replace: [] delete: [] ssl_certificates: id: google.compute.ssl_certificates @@ -65850,6 +67518,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/ssl_certificates/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/ssl_certificates/methods/delete' ssl_certificates_aggregated: @@ -65857,22 +67526,20 @@ components: name: ssl_certificates_aggregated title: Ssl_certificates_aggregated methods: - _aggregated_list: - operation: &ref_109 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1sslCertificates/get' - response: &ref_110 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].sslCertificates[*] - aggregated_list: - operation: *ref_109 - response: *ref_110 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/ssl_certificates_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_ssl_certificates: id: google.compute.region_ssl_certificates @@ -65917,6 +67584,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_ssl_certificates/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_ssl_certificates/methods/delete @@ -65966,6 +67634,7 @@ components: - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/insert' update: - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/ssl_policies/methods/delete' ssl_policies_available_features: @@ -65986,28 +67655,27 @@ components: #/components/x-stackQL-resources/ssl_policies_available_features/methods/list_available_features insert: [] update: [] + replace: [] delete: [] ssl_policies_aggregated: id: google.compute.ssl_policies_aggregated name: ssl_policies_aggregated title: Ssl_policies_aggregated methods: - _aggregated_list: - operation: &ref_111 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1sslPolicies/get' - response: &ref_112 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].sslPolicies[*] - aggregated_list: - operation: *ref_111 - response: *ref_112 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/ssl_policies_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_ssl_policies: id: google.compute.region_ssl_policies @@ -66056,6 +67724,7 @@ components: #/components/x-stackQL-resources/region_ssl_policies/methods/insert update: - $ref: '#/components/x-stackQL-resources/region_ssl_policies/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_ssl_policies/methods/delete @@ -66077,6 +67746,7 @@ components: #/components/x-stackQL-resources/region_ssl_policies_available_features/methods/list_available_features insert: [] update: [] + replace: [] delete: [] storage_pool_types: id: google.compute.storage_pool_types @@ -66089,16 +67759,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_113 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1storagePoolTypes/get' - response: &ref_114 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].storagePoolTypes[*] - aggregated_list: - operation: *ref_113 - response: *ref_114 get: operation: $ref: >- @@ -66114,6 +67781,7 @@ components: #/components/x-stackQL-resources/storage_pool_types/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] storage_pools: id: google.compute.storage_pools @@ -66132,16 +67800,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_115 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1storagePools/get' - response: &ref_116 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].storagePools[*] - aggregated_list: - operation: *ref_115 - response: *ref_116 get: operation: $ref: >- @@ -66173,6 +67838,7 @@ components: - $ref: '#/components/x-stackQL-resources/storage_pools/methods/insert' update: - $ref: '#/components/x-stackQL-resources/storage_pools/methods/update' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/storage_pools/methods/delete' storage_pools_iam_policies: @@ -66180,17 +67846,14 @@ components: name: storage_pools_iam_policies title: Storage_pools_iam_policies methods: - _get_iam_policy: - operation: &ref_117 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1zones~1{zone}~1storagePools~1{resource}~1getIamPolicy/get - response: &ref_118 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_117 - response: *ref_118 set_iam_policy: operation: $ref: >- @@ -66211,6 +67874,9 @@ components: #/components/x-stackQL-resources/storage_pools_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/storage_pools_iam_policies/methods/set_iam_policy delete: [] storage_pools_disks: id: google.compute.storage_pools_disks @@ -66230,6 +67896,7 @@ components: #/components/x-stackQL-resources/storage_pools_disks/methods/list_disks insert: [] update: [] + replace: [] delete: [] subnetworks: id: google.compute.subnetworks @@ -66248,16 +67915,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_119 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1subnetworks/get' - response: &ref_120 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].subnetworks[*] - aggregated_list: - operation: *ref_119 - response: *ref_120 get: operation: $ref: >- @@ -66303,6 +67967,7 @@ components: - $ref: '#/components/x-stackQL-resources/subnetworks/methods/insert' update: - $ref: '#/components/x-stackQL-resources/subnetworks/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/subnetworks/methods/delete' subnetworks_usable: @@ -66323,23 +67988,21 @@ components: #/components/x-stackQL-resources/subnetworks_usable/methods/list_usable insert: [] update: [] + replace: [] delete: [] subnetworks_iam_policies: id: google.compute.subnetworks_iam_policies name: subnetworks_iam_policies title: Subnetworks_iam_policies methods: - _get_iam_policy: - operation: &ref_121 + get_iam_policy: + operation: $ref: >- #/paths/~1projects~1{project}~1regions~1{region}~1subnetworks~1{resource}~1getIamPolicy/get - response: &ref_122 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_121 - response: *ref_122 set_iam_policy: operation: $ref: >- @@ -66360,6 +68023,9 @@ components: #/components/x-stackQL-resources/subnetworks_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/subnetworks_iam_policies/methods/set_iam_policy delete: [] target_grpc_proxies: id: google.compute.target_grpc_proxies @@ -66408,6 +68074,7 @@ components: #/components/x-stackQL-resources/target_grpc_proxies/methods/insert update: - $ref: '#/components/x-stackQL-resources/target_grpc_proxies/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/target_grpc_proxies/methods/delete @@ -66465,6 +68132,7 @@ components: #/components/x-stackQL-resources/target_http_proxies/methods/insert update: - $ref: '#/components/x-stackQL-resources/target_http_proxies/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/target_http_proxies/methods/delete @@ -66473,22 +68141,20 @@ components: name: target_http_proxies_aggregated title: Target_http_proxies_aggregated methods: - _aggregated_list: - operation: &ref_123 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1targetHttpProxies/get' - response: &ref_124 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].targetHttpProxies[*] - aggregated_list: - operation: *ref_123 - response: *ref_124 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/target_http_proxies_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_target_http_proxies: id: google.compute.region_target_http_proxies @@ -66540,6 +68206,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_target_http_proxies/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_target_http_proxies/methods/delete @@ -66626,6 +68293,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/target_https_proxies/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/target_https_proxies/methods/delete @@ -66634,22 +68302,20 @@ components: name: target_https_proxies_aggregated title: Target_https_proxies_aggregated methods: - _aggregated_list: - operation: &ref_125 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1targetHttpsProxies/get' - response: &ref_126 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].targetHttpsProxies[*] - aggregated_list: - operation: *ref_125 - response: *ref_126 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/target_https_proxies_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_target_https_proxies: id: google.compute.region_target_https_proxies @@ -66717,6 +68383,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/region_target_https_proxies/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_target_https_proxies/methods/delete @@ -66737,16 +68404,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_127 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1targetInstances/get' - response: &ref_128 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].targetInstances[*] - aggregated_list: - operation: *ref_127 - response: *ref_128 get: operation: $ref: >- @@ -66777,6 +68441,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/target_instances/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/target_instances/methods/delete' target_pools: @@ -66796,16 +68461,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_129 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1targetPools/get' - response: &ref_130 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].targetPools[*] - aggregated_list: - operation: *ref_129 - response: *ref_130 get: operation: $ref: >- @@ -66843,6 +68505,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/target_pools/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/target_pools/methods/delete' target_pools_health: @@ -66858,9 +68521,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/target_pools_health/methods/get_health insert: [] update: [] + replace: [] delete: [] target_pools_health_check: id: google.compute.target_pools_health_check @@ -66883,9 +68549,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/target_pools_health_check/methods/add_health_check update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/target_pools_health_check/methods/remove_health_check target_pools_instance: id: google.compute.target_pools_instance name: target_pools_instance @@ -66907,9 +68578,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/target_pools_instance/methods/add_instance update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/target_pools_instance/methods/remove_instance target_ssl_proxies: id: google.compute.target_ssl_proxies name: target_ssl_proxies @@ -66983,6 +68659,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/target_ssl_proxies/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/target_ssl_proxies/methods/delete' target_tcp_proxies: @@ -67037,6 +68714,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/target_tcp_proxies/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/target_tcp_proxies/methods/delete' target_tcp_proxies_aggregated: @@ -67044,22 +68722,20 @@ components: name: target_tcp_proxies_aggregated title: Target_tcp_proxies_aggregated methods: - _aggregated_list: - operation: &ref_131 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1targetTcpProxies/get' - response: &ref_132 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].targetTcpProxies[*] - aggregated_list: - operation: *ref_131 - response: *ref_132 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/target_tcp_proxies_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_target_tcp_proxies: id: google.compute.region_target_tcp_proxies @@ -67104,6 +68780,7 @@ components: - $ref: >- #/components/x-stackQL-resources/region_target_tcp_proxies/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/region_target_tcp_proxies/methods/delete @@ -67126,16 +68803,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_133 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1targetVpnGateways/get' - response: &ref_134 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].targetVpnGateways[*] - aggregated_list: - operation: *ref_133 - response: *ref_134 get: operation: $ref: >- @@ -67167,6 +68841,7 @@ components: - $ref: >- #/components/x-stackQL-resources/target_vpn_gateways/methods/insert update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/target_vpn_gateways/methods/delete @@ -67232,8 +68907,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/url_maps/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/url_maps/methods/update' - $ref: '#/components/x-stackQL-resources/url_maps/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/url_maps/methods/update' delete: - $ref: '#/components/x-stackQL-resources/url_maps/methods/delete' url_maps_aggregated: @@ -67241,22 +68917,20 @@ components: name: url_maps_aggregated title: Url_maps_aggregated methods: - _aggregated_list: - operation: &ref_135 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1urlMaps/get' - response: &ref_136 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].urlMaps[*] - aggregated_list: - operation: *ref_135 - response: *ref_136 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/url_maps_aggregated/methods/aggregated_list insert: [] update: [] + replace: [] delete: [] region_url_maps: id: google.compute.region_url_maps @@ -67317,8 +68991,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/update' - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/update' delete: - $ref: '#/components/x-stackQL-resources/region_url_maps/methods/delete' vpn_gateways: @@ -67338,16 +69013,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_137 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1vpnGateways/get' - response: &ref_138 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].vpnGateways[*] - aggregated_list: - operation: *ref_137 - response: *ref_138 get: operation: $ref: >- @@ -67378,6 +69050,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/delete' vpn_gateways_status: @@ -67398,6 +69071,7 @@ components: #/components/x-stackQL-resources/vpn_gateways_status/methods/get_status insert: [] update: [] + replace: [] delete: [] vpn_gateways_iam_policies: id: google.compute.vpn_gateways_iam_policies @@ -67415,6 +69089,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] vpn_tunnels: id: google.compute.vpn_tunnels @@ -67433,16 +69108,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _aggregated_list: - operation: &ref_139 + aggregated_list: + operation: $ref: '#/paths/~1projects~1{project}~1aggregated~1vpnTunnels/get' - response: &ref_140 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items[*].vpnTunnels[*] - aggregated_list: - operation: *ref_139 - response: *ref_140 get: operation: $ref: >- @@ -67473,6 +69145,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/vpn_tunnels/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/vpn_tunnels/methods/delete' zones: @@ -67498,6 +69171,7 @@ components: - $ref: '#/components/x-stackQL-resources/zones/methods/list' insert: [] update: [] + replace: [] delete: [] region_zones: id: google.compute.region_zones @@ -67515,10 +69189,11 @@ components: - $ref: '#/components/x-stackQL-resources/region_zones/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /projects/{project}/zones/{zone}/acceleratorTypes: - parameters: &ref_141 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -67589,7 +69264,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/acceleratorTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of accelerator types. To prevent failure, @@ -67653,7 +69328,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified accelerator type. operationId: compute.acceleratorTypes.get @@ -67694,7 +69369,7 @@ paths: schema: type: string /projects/{project}/global/operations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of Operation resources contained within the specified @@ -67748,7 +69423,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/operations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of all operations. To prevent failure, @@ -67812,7 +69487,7 @@ paths: type: string format: int64 /projects/{project}/global/operations/{operation}: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves the specified Operations resource. operationId: compute.globalOperations.get @@ -67874,7 +69549,7 @@ paths: schema: type: string /projects/{project}/global/operations/{operation}/wait: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Waits for the specified Operation resource to return as `DONE` or for @@ -67921,7 +69596,7 @@ paths: schema: type: string /locations/global/operations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of Operation resources contained within the specified @@ -67974,7 +69649,7 @@ paths: schema: type: boolean /locations/global/operations/{operation}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the specified Operations resource. Gets a list of operations @@ -68036,7 +69711,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/operations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of Operation resources contained within the specified @@ -68095,7 +69770,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/operations/{operation}: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves the specified zone-specific Operations resource. operationId: compute.zoneOperations.get @@ -68167,7 +69842,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/operations/{operation}/wait: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Waits for the specified Operation resource to return as `DONE` or for @@ -68218,7 +69893,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/operations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of Operation resources contained within the specified @@ -68277,7 +69952,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/operations/{operation}: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves the specified region-specific Operations resource. operationId: compute.regionOperations.get @@ -68349,7 +70024,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/operations/{operation}/wait: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Waits for the specified Operation resource to return as `DONE` or for @@ -68401,7 +70076,7 @@ paths: schema: type: string /projects/{project}/global/addresses: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of global addresses. operationId: compute.globalAddresses.list @@ -68489,7 +70164,7 @@ paths: schema: type: string /projects/{project}/global/addresses/{address}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified address resource. operationId: compute.globalAddresses.get @@ -68559,7 +70234,7 @@ paths: schema: type: string /projects/{project}/global/addresses/{address}/move: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Moves the specified address resource from one project to another @@ -68602,7 +70277,7 @@ paths: schema: type: string /projects/{project}/global/addresses/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a GlobalAddress. To learn more about labels, read the @@ -68641,7 +70316,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/addresses: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of addresses contained within the specified region. operationId: compute.addresses.list @@ -68739,7 +70414,7 @@ paths: schema: type: string /projects/{project}/aggregated/addresses: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of addresses. To prevent failure, Google @@ -68802,7 +70477,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/addresses/{address}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified address resource. operationId: compute.addresses.get @@ -68882,7 +70557,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/addresses/{address}/move: - parameters: *ref_141 + parameters: *ref_1 post: description: Moves the specified address resource. operationId: compute.addresses.move @@ -68928,7 +70603,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/addresses/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on an Address. To learn more about labels, read the @@ -68976,7 +70651,7 @@ paths: schema: type: string /projects/{project}/global/images: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of custom images available to the specified project. @@ -69086,7 +70761,7 @@ paths: schema: type: string /projects/{project}/global/images/{image}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified image. operationId: compute.images.get @@ -69198,7 +70873,7 @@ paths: schema: type: string /projects/{project}/global/images/family/{family}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the latest image that is part of an image family and is not @@ -69237,7 +70912,7 @@ paths: schema: type: string /projects/{project}/global/images/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on an image. To learn more about labels, read the @@ -69276,7 +70951,7 @@ paths: schema: type: string /projects/{project}/global/images/{image}/deprecate: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the deprecation status of an image. If an empty request body is @@ -69319,7 +70994,7 @@ paths: schema: type: string /projects/{project}/global/images/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -69362,7 +71037,7 @@ paths: type: integer format: int32 /projects/{project}/global/images/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -69401,7 +71076,7 @@ paths: schema: type: string /projects/{project}/global/images/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.images.testIamPermissions @@ -69442,7 +71117,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/imageFamilyViews/{family}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the latest image that is part of an image family, is not @@ -69485,7 +71160,7 @@ paths: schema: type: string /projects/{project}/global/snapshots: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of Snapshot resources contained within the specified @@ -69578,7 +71253,7 @@ paths: schema: type: string /projects/{project}/global/snapshots/{snapshot}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified Snapshot resource. operationId: compute.snapshots.get @@ -69653,7 +71328,7 @@ paths: schema: type: string /projects/{project}/global/snapshots/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a snapshot. To learn more about labels, read the @@ -69692,7 +71367,7 @@ paths: schema: type: string /projects/{project}/global/snapshots/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -69735,7 +71410,7 @@ paths: type: integer format: int32 /projects/{project}/global/snapshots/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -69774,7 +71449,7 @@ paths: schema: type: string /projects/{project}/global/snapshots/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.snapshots.testIamPermissions @@ -69815,7 +71490,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of persistent disks contained within the specified @@ -69922,7 +71597,7 @@ paths: schema: type: string /projects/{project}/aggregated/disks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of persistent disks. To prevent failure, @@ -69986,7 +71661,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/disks/{disk}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified persistent disk. operationId: compute.disks.get @@ -70126,7 +71801,7 @@ paths: type: string format: google-fieldmask /projects/{project}/zones/{zone}/disks/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a disk. To learn more about labels, read the Labeling @@ -70174,7 +71849,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates a snapshot of a specified persistent disk. For regular snapshot @@ -70228,7 +71903,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{disk}/resize: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Resizes the specified persistent disk. You can only increase the size of @@ -70276,7 +71951,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Adds existing resource policies to a disk. You can only add one policy @@ -70324,7 +71999,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes resource policies from a disk. operationId: compute.disks.removeResourcePolicies @@ -70370,7 +72045,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -70418,7 +72093,7 @@ paths: type: integer format: int32 /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -70462,7 +72137,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.disks.testIamPermissions @@ -70508,7 +72183,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication: - parameters: *ref_141 + parameters: *ref_1 post: description: Starts asynchronous replication. Must be invoked on the primary disk. operationId: compute.disks.startAsyncReplication @@ -70554,7 +72229,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Stops asynchronous replication. Can be invoked either on the primary or @@ -70597,7 +72272,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Stops asynchronous replication for a consistency group of disks. Can be @@ -70640,7 +72315,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/disks/bulkInsert: - parameters: *ref_141 + parameters: *ref_1 post: description: Bulk create a set of disks. operationId: compute.disks.bulkInsert @@ -70681,7 +72356,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of persistent disks contained within the specified @@ -70785,7 +72460,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{disk}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns a specified regional persistent disk. operationId: compute.regionDisks.get @@ -70925,7 +72600,7 @@ paths: type: string format: google-fieldmask /projects/{project}/regions/{region}/disks/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets the labels on the target regional disk. operationId: compute.regionDisks.setLabels @@ -70971,7 +72646,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{disk}/createSnapshot: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates a snapshot of a specified persistent disk. For regular snapshot @@ -71021,7 +72696,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{disk}/resize: - parameters: *ref_141 + parameters: *ref_1 post: description: Resizes the specified regional persistent disk. operationId: compute.regionDisks.resize @@ -71067,7 +72742,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Adds existing resource policies to a regional disk. You can only add one @@ -71116,7 +72791,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes resource policies from a regional disk. operationId: compute.regionDisks.removeResourcePolicies @@ -71162,7 +72837,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -71210,7 +72885,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/disks/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -71254,7 +72929,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.regionDisks.testIamPermissions @@ -71300,7 +72975,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication: - parameters: *ref_141 + parameters: *ref_1 post: description: Starts asynchronous replication. Must be invoked on the primary disk. operationId: compute.regionDisks.startAsyncReplication @@ -71346,7 +73021,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Stops asynchronous replication. Can be invoked either on the primary or @@ -71389,7 +73064,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/stopGroupAsyncReplication: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Stops asynchronous replication for a consistency group of disks. Can be @@ -71432,7 +73107,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/disks/bulkInsert: - parameters: *ref_141 + parameters: *ref_1 post: description: Bulk create a set of disks. operationId: compute.regionDisks.bulkInsert @@ -71473,7 +73148,7 @@ paths: schema: type: string /projects/{project}/global/firewalls: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves the list of firewall rules available to the specified project. operationId: compute.firewalls.list @@ -71561,7 +73236,7 @@ paths: schema: type: string /projects/{project}/global/firewalls/{firewall}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified firewall. operationId: compute.firewalls.get @@ -71716,7 +73391,7 @@ paths: schema: type: string /locations/global/firewallPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all the policies that have been configured for the specified @@ -71804,7 +73479,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified firewall policy. operationId: compute.firewallPolicies.get @@ -71898,7 +73573,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/getRule: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets a rule of the specified priority. operationId: compute.firewallPolicies.getRule @@ -71934,7 +73609,7 @@ paths: type: integer format: int32 /locations/global/firewallPolicies/{firewallPolicy}/addRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts a rule into a firewall policy. operationId: compute.firewallPolicies.addRule @@ -71970,7 +73645,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/removeRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Deletes a rule of the specified priority. operationId: compute.firewallPolicies.removeRule @@ -72006,7 +73681,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/patchRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Patches a rule of the specified priority. operationId: compute.firewallPolicies.patchRule @@ -72047,7 +73722,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/addAssociation: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts an association for the specified firewall policy. operationId: compute.firewallPolicies.addAssociation @@ -72087,7 +73762,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/removeAssociation: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes an association for the specified firewall policy. operationId: compute.firewallPolicies.removeAssociation @@ -72122,7 +73797,7 @@ paths: schema: type: string /locations/global/firewallPolicies/listAssociations: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists associations of a specified target, i.e., organization or folder. operationId: compute.firewallPolicies.listAssociations @@ -72152,7 +73827,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/getAssociation: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets an association with the specified name. operationId: compute.firewallPolicies.getAssociation @@ -72187,7 +73862,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/cloneRules: - parameters: *ref_141 + parameters: *ref_1 post: description: Copies rules to the specified firewall policy. operationId: compute.firewallPolicies.cloneRules @@ -72222,7 +73897,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{firewallPolicy}/move: - parameters: *ref_141 + parameters: *ref_1 post: description: Moves the specified firewall policy. operationId: compute.firewallPolicies.move @@ -72257,7 +73932,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -72295,7 +73970,7 @@ paths: type: integer format: int32 /locations/global/firewallPolicies/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -72329,7 +74004,7 @@ paths: schema: type: string /locations/global/firewallPolicies/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.firewallPolicies.testIamPermissions @@ -72365,7 +74040,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all the policies that have been configured for the specified @@ -72455,7 +74130,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified network firewall policy. operationId: compute.networkFirewallPolicies.get @@ -72564,7 +74239,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets a rule of the specified priority. operationId: compute.networkFirewallPolicies.getRule @@ -72605,7 +74280,7 @@ paths: type: integer format: int32 /projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts a rule into a firewall policy. operationId: compute.networkFirewallPolicies.addRule @@ -72656,7 +74331,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Deletes a rule of the specified priority. operationId: compute.networkFirewallPolicies.removeRule @@ -72697,7 +74372,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Patches a rule of the specified priority. operationId: compute.networkFirewallPolicies.patchRule @@ -72743,7 +74418,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -72786,7 +74461,7 @@ paths: type: integer format: int32 /projects/{project}/global/firewallPolicies/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -72825,7 +74500,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.networkFirewallPolicies.testIamPermissions @@ -72866,7 +74541,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts an association for the specified firewall policy. operationId: compute.networkFirewallPolicies.addAssociation @@ -72911,7 +74586,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes an association for the specified firewall policy. operationId: compute.networkFirewallPolicies.removeAssociation @@ -72951,7 +74626,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets an association with the specified name. operationId: compute.networkFirewallPolicies.getAssociation @@ -72991,7 +74666,7 @@ paths: schema: type: string /projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules: - parameters: *ref_141 + parameters: *ref_1 post: description: Copies rules to the specified firewall policy. operationId: compute.networkFirewallPolicies.cloneRules @@ -73031,7 +74706,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all the network firewall policies that have been configured for @@ -73131,7 +74806,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified network firewall policy. operationId: compute.regionNetworkFirewallPolicies.get @@ -73255,7 +74930,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets a rule of the specified priority. operationId: compute.regionNetworkFirewallPolicies.getRule @@ -73301,7 +74976,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts a rule into a network firewall policy. operationId: compute.regionNetworkFirewallPolicies.addRule @@ -73357,7 +75032,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Deletes a rule of the specified priority. operationId: compute.regionNetworkFirewallPolicies.removeRule @@ -73403,7 +75078,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Patches a rule of the specified priority. operationId: compute.regionNetworkFirewallPolicies.patchRule @@ -73454,7 +75129,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules: - parameters: *ref_141 + parameters: *ref_1 post: description: Copies rules to the specified network firewall policy. operationId: compute.regionNetworkFirewallPolicies.cloneRules @@ -73499,7 +75174,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets an association with the specified name. operationId: compute.regionNetworkFirewallPolicies.getAssociation @@ -73544,7 +75219,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts an association for the specified network firewall policy. operationId: compute.regionNetworkFirewallPolicies.addAssociation @@ -73594,7 +75269,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes an association for the specified network firewall policy. operationId: compute.regionNetworkFirewallPolicies.removeAssociation @@ -73639,7 +75314,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the effective firewalls on a given network. operationId: compute.regionNetworkFirewallPolicies.getEffectiveFirewalls @@ -73681,7 +75356,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -73729,7 +75404,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -73773,7 +75448,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.regionNetworkFirewallPolicies.testIamPermissions @@ -73819,7 +75494,7 @@ paths: schema: type: string /projects/{project}/global/securityPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- List all the policies that have been configured for the specified @@ -73913,7 +75588,7 @@ paths: schema: type: boolean /projects/{project}/global/securityPolicies/{securityPolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: List all of the ordered rules present in a single specified policy. operationId: compute.securityPolicies.get @@ -74032,7 +75707,7 @@ paths: type: string format: google-fieldmask /projects/{project}/global/securityPolicies/{securityPolicy}/getRule: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets a rule at the specified priority. operationId: compute.securityPolicies.getRule @@ -74073,7 +75748,7 @@ paths: type: integer format: int32 /projects/{project}/global/securityPolicies/{securityPolicy}/addRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts a rule into a security policy. operationId: compute.securityPolicies.addRule @@ -74114,7 +75789,7 @@ paths: schema: type: boolean /projects/{project}/global/securityPolicies/{securityPolicy}/removeRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Deletes a rule at the specified priority. operationId: compute.securityPolicies.removeRule @@ -74151,7 +75826,7 @@ paths: type: integer format: int32 /projects/{project}/global/securityPolicies/{securityPolicy}/patchRule: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Patches a rule at the specified priority. To clear fields in the rule, @@ -74204,7 +75879,7 @@ paths: schema: type: boolean /projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the current list of preconfigured Web Application Firewall (WAF) @@ -74259,7 +75934,7 @@ paths: schema: type: boolean /projects/{project}/global/securityPolicies/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a security policy. To learn more about labels, read @@ -74298,7 +75973,7 @@ paths: schema: type: string /projects/{project}/aggregated/securityPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all SecurityPolicy resources, regional and global, @@ -74362,7 +76037,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/securityPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- List all the policies that have been configured for the specified @@ -74466,7 +76141,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: List all of the ordered rules present in a single specified policy. operationId: compute.regionSecurityPolicies.get @@ -74600,7 +76275,7 @@ paths: type: string format: google-fieldmask /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets a rule at the specified priority. operationId: compute.regionSecurityPolicies.getRule @@ -74646,7 +76321,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Inserts a rule into a security policy. operationId: compute.regionSecurityPolicies.addRule @@ -74692,7 +76367,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule: - parameters: *ref_141 + parameters: *ref_1 post: description: Deletes a rule at the specified priority. operationId: compute.regionSecurityPolicies.removeRule @@ -74734,7 +76409,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Patches a rule at the specified priority. To clear fields in the rule, @@ -74792,7 +76467,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instances: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves the list of instances contained within the specified zone. operationId: compute.instances.list @@ -74898,7 +76573,7 @@ paths: schema: type: string /projects/{project}/aggregated/instances: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of all of the instances in your project @@ -74964,7 +76639,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/instances/{instance}/referrers: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of resources that refer to the VM instance specified in @@ -75030,7 +76705,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instances/{instance}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified Instance resource. operationId: compute.instances.get @@ -75167,7 +76842,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/reset: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Performs a reset on the instance. This is a hard reset. The VM does not @@ -75210,7 +76885,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Simulates a host maintenance event on a VM. For more information, see @@ -75257,7 +76932,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instances/{instance}/performMaintenance: - parameters: *ref_141 + parameters: *ref_1 post: description: Perform a manual maintenance on the instance. operationId: compute.instances.performMaintenance @@ -75298,7 +76973,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig: - parameters: *ref_141 + parameters: *ref_1 post: description: Adds an access config to an instance's network interface. operationId: compute.instances.addAccessConfig @@ -75349,7 +77024,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig: - parameters: *ref_141 + parameters: *ref_1 post: description: Deletes an access config from an instance's network interface. operationId: compute.instances.deleteAccessConfig @@ -75400,7 +77075,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Updates the specified access config from an instance's network interface @@ -75454,7 +77129,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface: - parameters: *ref_141 + parameters: *ref_1 patch: description: >- Updates an instance's network interface. This method can only update an @@ -75510,7 +77185,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setScheduling: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets an instance's scheduling options. You can only call this method on @@ -75561,7 +77236,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/serialPort: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the last 1 MB of serial port output from the specified instance. operationId: compute.instances.getSerialPortOutput @@ -75612,7 +77287,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/instances/{instance}/screenshot: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the screenshot from the specified instance. operationId: compute.instances.getScreenshot @@ -75653,7 +77328,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt: - parameters: *ref_141 + parameters: *ref_1 post: description: Sends diagnostic interrupt to the instance. operationId: compute.instances.sendDiagnosticInterrupt @@ -75686,7 +77361,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified guest attributes entry. operationId: compute.instances.getGuestAttributes @@ -75735,7 +77410,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/attachDisk: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Attaches an existing Disk resource to an instance. You must first create @@ -75789,7 +77464,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/detachDisk: - parameters: *ref_141 + parameters: *ref_1 post: description: Detaches a disk from an instance. operationId: compute.instances.detachDisk @@ -75835,7 +77510,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setMachineResources: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Changes the number and/or type of accelerator for a stopped instance to @@ -75883,7 +77558,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setMachineType: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Changes the machine type for a stopped instance to the machine type @@ -75931,7 +77606,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setMetadata: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets metadata for the specified instance to the data included in the @@ -75979,7 +77654,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Changes the minimum CPU platform that this instance should use. This @@ -76028,7 +77703,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setTags: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets network tags for the specified instance to the data included in the @@ -76076,7 +77751,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets labels on an instance. To learn more about labels, read the @@ -76124,7 +77799,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setName: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets name of an instance. operationId: compute.instances.setName @@ -76170,7 +77845,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets the auto-delete flag for a disk attached to an instance. operationId: compute.instances.setDiskAutoDelete @@ -76221,7 +77896,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/start: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Starts an instance that was stopped using the instances().stop method. @@ -76264,7 +77939,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Starts an instance that was stopped using the instances().stop method. @@ -76312,7 +77987,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/stop: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Stops a running instance, shutting it down cleanly, and allows you to @@ -76363,7 +78038,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -76411,7 +78086,7 @@ paths: type: integer format: int32 /projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -76455,7 +78130,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.instances.testIamPermissions @@ -76501,7 +78176,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the service account on the instance. For more information, read @@ -76549,7 +78224,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets deletion protection on the instance. operationId: compute.instances.setDeletionProtection @@ -76594,7 +78269,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/suspend: - parameters: *ref_141 + parameters: *ref_1 post: description: >- This method suspends a running instance, saving its state to persistent @@ -76647,7 +78322,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/resume: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Resumes an instance that was suspended using the instances().suspend @@ -76690,7 +78365,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Adds existing resource policies to an instance. You can only add one @@ -76739,7 +78414,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes resource policies from an instance. operationId: compute.instances.removeResourcePolicies @@ -76785,7 +78460,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig: - parameters: *ref_141 + parameters: *ref_1 patch: description: >- Updates the Shielded Instance config for an instance. You can only use @@ -76834,7 +78509,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice: - parameters: *ref_141 + parameters: *ref_1 patch: description: >- Updates the Display config for a VM instance. You can only use this @@ -76883,7 +78558,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy: - parameters: *ref_141 + parameters: *ref_1 patch: description: >- Sets the Shielded Instance integrity policy for an instance. You can @@ -76932,7 +78607,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the Google Cloud Armor security policy for the specified instance. @@ -76980,7 +78655,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the Shielded Instance Identity of an instance operationId: compute.instances.getShieldedInstanceIdentity @@ -77021,7 +78696,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/bulkInsert: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates multiple instances. Count specifies the number of instances to @@ -77064,7 +78739,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns effective firewalls applied to an interface of the instance. operationId: compute.instances.getEffectiveFirewalls @@ -77110,7 +78785,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instances/bulkInsert: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates multiple instances in a given region. Count specifies the number @@ -77153,7 +78828,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/reservations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- A list of all the reservations that have been configured for the @@ -77253,7 +78928,7 @@ paths: schema: type: string /projects/{project}/aggregated/reservations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of reservations. To prevent failure, Google @@ -77316,7 +78991,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/reservations/{reservation}: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves information about the specified reservation. operationId: compute.reservations.get @@ -77449,7 +79124,7 @@ paths: type: string format: google-fieldmask /projects/{project}/zones/{zone}/reservations/{reservation}/resize: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Resizes the reservation (applicable to standalone reservations only). @@ -77497,7 +79172,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -77545,7 +79220,7 @@ paths: type: integer format: int32 /projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -77589,7 +79264,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.reservations.testIamPermissions @@ -77635,7 +79310,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of zonal instance group resources contained within @@ -77736,7 +79411,7 @@ paths: schema: type: string /projects/{project}/aggregated/instanceGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of instance groups and sorts them by zone. To prevent @@ -77800,7 +79475,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified zonal instance group. Get a list of available @@ -77887,7 +79562,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Adds a list of instances to the specified instance group. All of the @@ -77936,7 +79611,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Removes one or more instances from the specified instance group, but @@ -77987,7 +79662,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Lists the instances in the specified instance group. The orderBy query @@ -78058,7 +79733,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets the named ports for the specified instance group. operationId: compute.instanceGroups.setNamedPorts @@ -78104,7 +79779,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of instance group resources contained within the @@ -78163,7 +79838,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified instance group resource. operationId: compute.regionInstanceGroups.get @@ -78204,7 +79879,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Lists the instances in the specified instance group and displays @@ -78275,7 +79950,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets the named ports for the specified regional instance group. operationId: compute.regionInstanceGroups.setNamedPorts @@ -78321,7 +79996,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of managed instance groups that are contained within @@ -78427,7 +80102,7 @@ paths: schema: type: string /projects/{project}/aggregated/instanceGroupManagers: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of managed instance groups and groups them by zone. @@ -78491,7 +80166,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns all of the details about the specified managed instance group. operationId: compute.instanceGroupManagers.get @@ -78629,7 +80304,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Flags the specified instances in the managed instance group for @@ -78686,7 +80361,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Flags the specified instances to be removed from the managed instance @@ -78746,7 +80421,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Flags the specified VM instances in the managed instance group to be @@ -78804,7 +80479,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Resizes the managed instance group. If you increase the size, the group @@ -78866,7 +80541,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Specifies the instance template to use when creating new instances in @@ -78917,7 +80592,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Modifies the target pools to which all instances in this managed @@ -78969,7 +80644,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Lists all of the instances in the managed instance group. Each instance @@ -79040,7 +80715,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all errors thrown by actions on instances for a given managed @@ -79105,7 +80780,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Lists all of the per-instance configurations defined for the managed @@ -79170,7 +80845,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Inserts or updates per-instance configurations for the managed instance @@ -79220,7 +80895,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Inserts or patches per-instance configurations for the managed instance @@ -79270,7 +80945,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Deletes selected per-instance configurations for the managed instance @@ -79315,7 +80990,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Applies changes to selected instances on the managed instance group. @@ -79359,7 +81034,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates instances with per-instance configurations in this managed @@ -79411,7 +81086,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns all of the details about the specified resize request. operationId: compute.instanceGroupManagerResizeRequests.get @@ -79504,7 +81179,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates a new resize request that starts provisioning VMs immediately or @@ -79615,7 +81290,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Cancels the specified resize request and removes it from the queue. @@ -79665,7 +81340,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of managed instance groups that are contained within @@ -79770,7 +81445,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns all of the details about the specified managed instance group. operationId: compute.regionInstanceGroupManagers.get @@ -79907,7 +81582,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Flags the specified instances in the managed instance group to be @@ -79966,7 +81641,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Flags the specified instances to be immediately removed from the managed @@ -80026,7 +81701,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Flags the specified VM instances in the managed instance group to be @@ -80083,7 +81758,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Changes the intended size of the managed instance group. If you increase @@ -80140,7 +81815,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the instance template to use when creating new instances or @@ -80189,7 +81864,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Modifies the target pools to which all new instances in this group are @@ -80238,7 +81913,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Lists the instances in the managed instance group and instances that are @@ -80306,7 +81981,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all errors thrown by actions on instances for a given regional @@ -80372,7 +82047,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Lists all of the per-instance configurations defined for the managed @@ -80437,7 +82112,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Inserts or updates per-instance configurations for the managed instance @@ -80487,7 +82162,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Inserts or patches per-instance configurations for the managed instance @@ -80537,7 +82212,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Deletes selected per-instance configurations for the managed instance @@ -80582,7 +82257,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: Apply updates to selected instances the managed instance group. operationId: compute.regionInstanceGroupManagers.applyUpdatesToInstances @@ -80625,7 +82300,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates instances with per-instance configurations in this regional @@ -80678,7 +82353,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/autoscalers: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of autoscalers contained within the specified zone. operationId: compute.autoscalers.list @@ -80867,7 +82542,7 @@ paths: schema: type: string /projects/{project}/aggregated/autoscalers: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of autoscalers. To prevent failure, Google @@ -80930,7 +82605,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/autoscalers/{autoscaler}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified autoscaler resource. operationId: compute.autoscalers.get @@ -81010,7 +82685,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/autoscalers: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of autoscalers contained within the specified region. operationId: compute.regionAutoscalers.list @@ -81199,7 +82874,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/autoscalers/{autoscaler}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified autoscaler. operationId: compute.regionAutoscalers.get @@ -81279,7 +82954,7 @@ paths: schema: type: string /projects/{project}/global/backendBuckets: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of BackendBucket resources available to the specified @@ -81369,7 +83044,7 @@ paths: schema: type: string /projects/{project}/global/backendBuckets/{backendBucket}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified BackendBucket resource. operationId: compute.backendBuckets.get @@ -81522,7 +83197,7 @@ paths: schema: type: string /projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Adds a key for validating requests with signed URLs for this backend @@ -81565,7 +83240,7 @@ paths: schema: type: string /projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Deletes a key for validating requests with signed URLs for this backend @@ -81608,7 +83283,7 @@ paths: schema: type: string /projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets the edge security policy for the specified backend bucket. operationId: compute.backendBuckets.setEdgeSecurityPolicy @@ -81649,7 +83324,7 @@ paths: schema: type: string /projects/{project}/global/backendBuckets/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -81692,7 +83367,7 @@ paths: type: integer format: int32 /projects/{project}/global/backendBuckets/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -81731,7 +83406,7 @@ paths: schema: type: string /projects/{project}/global/backendBuckets/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.backendBuckets.testIamPermissions @@ -81772,7 +83447,7 @@ paths: schema: type: string /projects/{project}/global/backendServices: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of BackendService resources available to the @@ -81863,7 +83538,7 @@ paths: schema: type: string /projects/{project}/aggregated/backendServices: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all BackendService resources, regional and global, @@ -81927,11 +83602,11 @@ paths: type: string format: int64 /projects/{project}/global/backendServices/listUsable: - parameters: *ref_141 + parameters: *ref_1 get: description: >- - Retrieves an aggregated list of all usable backend services in the - specified project. + Retrieves a list of all usable backend services in the specified + project. operationId: compute.backendServices.listUsable security: - Oauth2: @@ -81981,7 +83656,7 @@ paths: schema: type: boolean /projects/{project}/global/backendServices/{backendService}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified BackendService resource. operationId: compute.backendServices.get @@ -82135,7 +83810,7 @@ paths: schema: type: string /projects/{project}/global/backendServices/{backendService}/addSignedUrlKey: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Adds a key for validating requests with signed URLs for this backend @@ -82178,7 +83853,7 @@ paths: schema: type: string /projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Deletes a key for validating requests with signed URLs for this backend @@ -82221,7 +83896,7 @@ paths: schema: type: string /projects/{project}/global/backendServices/{backendService}/setSecurityPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the Google Cloud Armor security policy for the specified backend @@ -82264,7 +83939,7 @@ paths: schema: type: string /projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets the edge security policy for the specified backend service. operationId: compute.backendServices.setEdgeSecurityPolicy @@ -82305,7 +83980,7 @@ paths: schema: type: string /projects/{project}/global/backendServices/{backendService}/getHealth: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Gets the most recent health check results for this BackendService. @@ -82349,7 +84024,7 @@ paths: schema: type: string /projects/{project}/global/backendServices/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -82392,7 +84067,7 @@ paths: type: integer format: int32 /projects/{project}/global/backendServices/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -82431,7 +84106,7 @@ paths: schema: type: string /projects/{project}/global/backendServices/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.backendServices.testIamPermissions @@ -82472,7 +84147,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/backendServices: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of regional BackendService resources available to the @@ -82573,11 +84248,11 @@ paths: schema: type: string /projects/{project}/regions/{region}/backendServices/listUsable: - parameters: *ref_141 + parameters: *ref_1 get: description: >- - Retrieves an aggregated list of all usable backend services in the - specified project in the given region. + Retrieves a list of all usable backend services in the specified project + in the given region. operationId: compute.regionBackendServices.listUsable security: - Oauth2: @@ -82632,7 +84307,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/backendServices/{backendService}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified regional BackendService resource. operationId: compute.regionBackendServices.get @@ -82807,7 +84482,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the Google Cloud Armor security policy for the specified backend @@ -82855,7 +84530,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/backendServices/{backendService}/getHealth: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Gets the most recent health check results for this regional @@ -82903,7 +84578,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -82951,7 +84626,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -82995,7 +84670,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.regionBackendServices.testIamPermissions @@ -83041,7 +84716,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/commitments: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of commitments contained within the specified region. operationId: compute.regionCommitments.list @@ -83139,7 +84814,7 @@ paths: schema: type: string /projects/{project}/aggregated/commitments: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of commitments by region. To prevent @@ -83203,7 +84878,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/commitments/{commitment}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified commitment resource. operationId: compute.regionCommitments.get @@ -83300,7 +84975,7 @@ paths: type: string format: google-fieldmask /projects/{project}/zones/{zone}/diskTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of disk types available to the specified project. operationId: compute.diskTypes.list @@ -83357,7 +85032,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/diskTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of disk types. To prevent failure, Google @@ -83420,7 +85095,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/diskTypes/{diskType}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified disk type. operationId: compute.diskTypes.get @@ -83461,7 +85136,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/diskTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of regional disk types available to the specified @@ -83520,7 +85195,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/diskTypes/{diskType}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified regional disk type. operationId: compute.regionDiskTypes.get @@ -83561,7 +85236,7 @@ paths: schema: type: string /projects/{project}/global/externalVpnGateways: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates a ExternalVpnGateway in the specified project using the data @@ -83651,7 +85326,7 @@ paths: schema: type: boolean /projects/{project}/global/externalVpnGateways/{externalVpnGateway}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified externalVpnGateway. Get a list of available @@ -83723,7 +85398,7 @@ paths: schema: type: string /projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.externalVpnGateways.testIamPermissions @@ -83764,7 +85439,7 @@ paths: schema: type: string /projects/{project}/global/externalVpnGateways/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on an ExternalVpnGateway. To learn more about labels, @@ -83803,7 +85478,7 @@ paths: schema: type: string /projects/{project}/global/forwardingRules: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of GlobalForwardingRule resources available to the @@ -83893,7 +85568,7 @@ paths: schema: type: string /projects/{project}/global/forwardingRules/{forwardingRule}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified GlobalForwardingRule resource. Gets a list of @@ -84008,7 +85683,7 @@ paths: schema: type: string /projects/{project}/global/forwardingRules/{forwardingRule}/setTarget: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Changes target URL for the GlobalForwardingRule resource. The new target @@ -84051,7 +85726,7 @@ paths: schema: type: string /projects/{project}/global/forwardingRules/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on the specified resource. To learn more about labels, @@ -84090,7 +85765,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/forwardingRules: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of ForwardingRule resources available to the specified @@ -84190,7 +85865,7 @@ paths: schema: type: string /projects/{project}/aggregated/forwardingRules: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of forwarding rules. To prevent failure, @@ -84254,7 +85929,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified ForwardingRule resource. operationId: compute.forwardingRules.get @@ -84333,18 +86008,114 @@ paths: name: requestId schema: type: string - patch: + patch: + description: >- + Updates the specified forwarding rule with the data included in the + request. This method supports PATCH semantics and uses the JSON merge + patch format and processing rules. Currently, you can only patch the + network_tier field. + operationId: compute.forwardingRules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ForwardingRule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: forwardingRule + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget: + parameters: *ref_1 + post: + description: >- + Changes target URL for forwarding rule. The new target should be of the + same type as the old target. + operationId: compute.forwardingRules.setTarget + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetReference' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: region + required: true + schema: + type: string + - in: path + name: forwardingRule + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels: + parameters: *ref_1 + post: description: >- - Updates the specified forwarding rule with the data included in the - request. This method supports PATCH semantics and uses the JSON merge - patch format and processing rules. Currently, you can only patch the - network_tier field. - operationId: compute.forwardingRules.patch + Sets the labels on the specified resource. To learn more about labels, + read the Labeling Resources documentation. + operationId: compute.forwardingRules.setLabels requestBody: content: application/json: schema: - $ref: '#/components/schemas/ForwardingRule' + $ref: '#/components/schemas/RegionSetLabelsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84373,7 +86144,7 @@ paths: schema: type: string - in: path - name: forwardingRule + name: resource required: true schema: type: string @@ -84381,18 +86152,16 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget: - parameters: *ref_141 + /projects/{project}/zones/{zone}/futureReservations: + parameters: *ref_1 post: - description: >- - Changes target URL for forwarding rule. The new target should be of the - same type as the old target. - operationId: compute.forwardingRules.setTarget + description: Creates a new Future Reservation. + operationId: compute.futureReservations.insert requestBody: content: application/json: schema: - $ref: '#/components/schemas/TargetReference' + $ref: '#/components/schemas/FutureReservation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84416,12 +86185,144 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string + - in: query + name: requestId + schema: + type: string + get: + description: >- + A list of all the future reservations that have been configured for the + specified project in specified zone. + operationId: compute.futureReservations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FutureReservationsListResponse' + parameters: - in: path - name: forwardingRule + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + /projects/{project}/zones/{zone}/futureReservations/{futureReservation}: + parameters: *ref_1 + get: + description: Retrieves information about the specified future reservation. + operationId: compute.futureReservations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FutureReservation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: futureReservation + required: true + schema: + type: string + delete: + description: Deletes the specified future reservation. + operationId: compute.futureReservations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: futureReservation required: true schema: type: string @@ -84429,18 +86330,14 @@ paths: name: requestId schema: type: string - /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels: - parameters: *ref_141 - post: - description: >- - Sets the labels on the specified resource. To learn more about labels, - read the Labeling Resources documentation. - operationId: compute.forwardingRules.setLabels + patch: + description: Updates the specified future reservation. + operationId: compute.futureReservations.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/RegionSetLabelsRequest' + $ref: '#/components/schemas/FutureReservation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -84464,12 +86361,122 @@ paths: schema: type: string - in: path - name: region + name: zone required: true schema: type: string - in: path - name: resource + name: futureReservation + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /projects/{project}/aggregated/futureReservations: + parameters: *ref_1 + get: + description: >- + Retrieves an aggregated list of future reservations. To prevent failure, + Google recommends that you set the `returnPartialSuccess` parameter to + `true`. + operationId: compute.futureReservations.aggregatedList + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + - Oauth2: + - https://www.googleapis.com/auth/compute.readonly + Oauth2c: + - https://www.googleapis.com/auth/compute.readonly + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/FutureReservationsAggregatedListResponse' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: includeAllScopes + schema: + type: boolean + - in: query + name: maxResults + schema: + type: integer + format: uint32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: returnPartialSuccess + schema: + type: boolean + - in: query + name: serviceProjectNumber + schema: + type: string + format: int64 + /projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel: + parameters: *ref_1 + post: + description: Cancel the specified future reservation. + operationId: compute.futureReservations.cancel + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/compute + Oauth2c: + - https://www.googleapis.com/auth/compute + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: zone + required: true + schema: + type: string + - in: path + name: futureReservation required: true schema: type: string @@ -84478,7 +86485,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/healthCheckServices: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all the HealthCheckService resources that have been configured for @@ -84578,7 +86585,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified regional HealthCheckService resource. operationId: compute.regionHealthCheckServices.get @@ -84705,7 +86712,7 @@ paths: schema: type: string /projects/{project}/global/healthChecks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of HealthCheck resources available to the specified @@ -84795,7 +86802,7 @@ paths: schema: type: string /projects/{project}/aggregated/healthChecks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all HealthCheck resources, regional and global, @@ -84859,7 +86866,7 @@ paths: type: string format: int64 /projects/{project}/global/healthChecks/{healthCheck}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified HealthCheck resource. operationId: compute.healthChecks.get @@ -85012,7 +87019,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/healthChecks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of HealthCheck resources available to the specified @@ -85112,7 +87119,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/healthChecks/{healthCheck}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified HealthCheck resource. operationId: compute.regionHealthChecks.get @@ -85285,7 +87292,7 @@ paths: schema: type: string /projects/{project}/global/httpHealthChecks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of HttpHealthCheck resources available to the @@ -85375,7 +87382,7 @@ paths: schema: type: string /projects/{project}/global/httpHealthChecks/{httpHealthCheck}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified HttpHealthCheck resource. operationId: compute.httpHealthChecks.get @@ -85528,7 +87535,7 @@ paths: schema: type: string /projects/{project}/global/httpsHealthChecks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of HttpsHealthCheck resources available to the @@ -85618,7 +87625,7 @@ paths: schema: type: string /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified HttpsHealthCheck resource. operationId: compute.httpsHealthChecks.get @@ -85771,7 +87778,7 @@ paths: schema: type: string /projects/{project}/global/instanceTemplates: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of instance templates that are contained within the @@ -85864,7 +87871,7 @@ paths: schema: type: string /projects/{project}/global/instanceTemplates/{instanceTemplate}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified instance template. operationId: compute.instanceTemplates.get @@ -85937,7 +87944,7 @@ paths: schema: type: string /projects/{project}/aggregated/instanceTemplates: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all InstanceTemplates resources, regional and @@ -86001,7 +88008,7 @@ paths: type: string format: int64 /projects/{project}/global/instanceTemplates/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -86044,7 +88051,7 @@ paths: type: integer format: int32 /projects/{project}/global/instanceTemplates/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -86083,7 +88090,7 @@ paths: schema: type: string /projects/{project}/global/instanceTemplates/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.instanceTemplates.testIamPermissions @@ -86124,7 +88131,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceTemplates: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of instance templates that are contained within the @@ -86224,7 +88231,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified instance template. operationId: compute.regionInstanceTemplates.get @@ -86306,7 +88313,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instanceSettings: - parameters: *ref_141 + parameters: *ref_1 get: description: Get Instance settings. operationId: compute.instanceSettings.get @@ -86386,7 +88393,7 @@ paths: type: string format: google-fieldmask /projects/{project}/zones/{zone}/instantSnapshots: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of InstantSnapshot resources contained within the @@ -86484,7 +88491,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified InstantSnapshot resource in the specified zone. operationId: compute.instantSnapshots.get @@ -86570,7 +88577,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a instantSnapshot in the given zone. To learn more @@ -86618,7 +88625,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -86666,7 +88673,7 @@ paths: type: integer format: int32 /projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -86710,7 +88717,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.instantSnapshots.testIamPermissions @@ -86756,7 +88763,7 @@ paths: schema: type: string /projects/{project}/aggregated/instantSnapshots: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of instantSnapshots. To prevent failure, @@ -86820,7 +88827,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/instantSnapshots: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of InstantSnapshot resources contained within the @@ -86918,7 +88925,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified InstantSnapshot resource in the specified region. operationId: compute.regionInstantSnapshots.get @@ -87004,7 +89011,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a instantSnapshot in the given region. To learn more @@ -87052,7 +89059,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -87100,7 +89107,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -87144,7 +89151,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.regionInstantSnapshots.testIamPermissions @@ -87190,7 +89197,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/interconnectAttachments: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of interconnect attachments contained within the @@ -87294,7 +89301,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/interconnectAttachments: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of interconnect attachments. To prevent @@ -87358,7 +89365,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified interconnect attachment. operationId: compute.interconnectAttachments.get @@ -87485,7 +89492,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on an InterconnectAttachment. To learn more about @@ -87533,7 +89540,7 @@ paths: schema: type: string /projects/{project}/global/interconnects: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates an Interconnect in the specified project using the data included @@ -87621,7 +89628,7 @@ paths: schema: type: boolean /projects/{project}/global/interconnects/{interconnect}/getDiagnostics: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the interconnectDiagnostics for the specified Interconnect. In @@ -87662,7 +89669,7 @@ paths: schema: type: string /projects/{project}/global/interconnects/{interconnect}/getMacsecConfig: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the interconnectMacsecConfig for the specified Interconnect. operationId: compute.interconnects.getMacsecConfig @@ -87698,7 +89705,7 @@ paths: schema: type: string /projects/{project}/global/interconnects/{interconnect}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified Interconnect. Get a list of available @@ -87812,7 +89819,7 @@ paths: schema: type: string /projects/{project}/global/interconnects/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on an Interconnect. To learn more about labels, read the @@ -87851,7 +89858,7 @@ paths: schema: type: string /projects/{project}/global/interconnectLocations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of interconnect locations available to the specified @@ -87905,7 +89912,7 @@ paths: schema: type: boolean /projects/{project}/global/interconnectLocations/{interconnectLocation}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the details for the specified interconnect location. Gets a list @@ -87943,7 +89950,7 @@ paths: schema: type: string /projects/{project}/global/interconnectRemoteLocations: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of interconnect remote locations available to the @@ -87997,7 +90004,7 @@ paths: schema: type: boolean /projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the details for the specified interconnect remote location. Gets @@ -88036,7 +90043,7 @@ paths: schema: type: string /projects/{project}/global/licenseCodes/{licenseCode}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Return a specified license code. License codes are mirrored across all @@ -88076,7 +90083,7 @@ paths: schema: type: string /projects/{project}/global/licenseCodes/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. @@ -88120,7 +90127,7 @@ paths: schema: type: string /projects/{project}/global/licenses/{license}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified License resource. *Caution* This resource is @@ -88196,7 +90203,7 @@ paths: schema: type: string /projects/{project}/global/licenses: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of licenses available in the specified project. This @@ -88305,7 +90312,7 @@ paths: schema: type: string /projects/{project}/global/licenses/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -88349,7 +90356,7 @@ paths: type: integer format: int32 /projects/{project}/global/licenses/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -88389,7 +90396,7 @@ paths: schema: type: string /projects/{project}/global/licenses/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. @@ -88433,7 +90440,7 @@ paths: schema: type: string /projects/{project}/global/machineImages: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of machine images that are contained within the @@ -88529,7 +90536,7 @@ paths: schema: type: string /projects/{project}/global/machineImages/{machineImage}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified machine image. operationId: compute.machineImages.get @@ -88601,7 +90608,7 @@ paths: schema: type: string /projects/{project}/global/machineImages/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -88644,7 +90651,7 @@ paths: type: integer format: int32 /projects/{project}/global/machineImages/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -88683,7 +90690,7 @@ paths: schema: type: string /projects/{project}/global/machineImages/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.machineImages.testIamPermissions @@ -88724,7 +90731,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/machineTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of machine types available to the specified project. operationId: compute.machineTypes.list @@ -88781,7 +90788,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/machineTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of machine types. To prevent failure, @@ -88845,7 +90852,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/machineTypes/{machineType}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified machine type. operationId: compute.machineTypes.get @@ -88886,7 +90893,7 @@ paths: schema: type: string /projects/{project}/aggregated/networkAttachments: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all NetworkAttachment resources, regional and @@ -88950,7 +90957,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/networkAttachments: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the NetworkAttachments for a project in the given scope. operationId: compute.networkAttachments.list @@ -89048,7 +91055,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkAttachments/{networkAttachment}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified NetworkAttachment resource in the given scope. operationId: compute.networkAttachments.get @@ -89175,7 +91182,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -89223,7 +91230,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -89267,7 +91274,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.networkAttachments.testIamPermissions @@ -89313,7 +91320,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}: - parameters: *ref_141 + parameters: *ref_1 get: description: Gets a specified NetworkEdgeSecurityService. operationId: compute.networkEdgeSecurityServices.get @@ -89446,7 +91453,7 @@ paths: type: string format: google-fieldmask /projects/{project}/regions/{region}/networkEdgeSecurityServices: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates a new service in the specified project using the data included @@ -89493,7 +91500,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/networkEdgeSecurityServices: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all NetworkEdgeSecurityService resources available @@ -89557,7 +91564,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/networkEndpointGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of network endpoint groups that are located in the @@ -89657,7 +91664,7 @@ paths: schema: type: string /projects/{project}/aggregated/networkEndpointGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of network endpoint groups and sorts them by zone. To @@ -89721,7 +91728,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified network endpoint group. operationId: compute.networkEndpointGroups.get @@ -89805,7 +91812,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Attach a list of network endpoints to the specified network endpoint @@ -89853,7 +91860,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Detach a list of network endpoints from the specified network endpoint @@ -89901,7 +91908,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: Lists the network endpoints in the specified network endpoint group. operationId: compute.networkEndpointGroups.listNetworkEndpoints @@ -89968,7 +91975,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.networkEndpointGroups.testIamPermissions @@ -90014,7 +92021,7 @@ paths: schema: type: string /projects/{project}/global/networkEndpointGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of network endpoint groups that are located in the @@ -90104,7 +92111,7 @@ paths: schema: type: string /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified network endpoint group. operationId: compute.globalNetworkEndpointGroups.get @@ -90176,7 +92183,7 @@ paths: schema: type: string /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: Attach a network endpoint to the specified network endpoint group. operationId: compute.globalNetworkEndpointGroups.attachNetworkEndpoints @@ -90218,7 +92225,7 @@ paths: schema: type: string /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: Detach the network endpoint from the specified network endpoint group. operationId: compute.globalNetworkEndpointGroups.detachNetworkEndpoints @@ -90260,7 +92267,7 @@ paths: schema: type: string /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: Lists the network endpoints in the specified network endpoint group. operationId: compute.globalNetworkEndpointGroups.listNetworkEndpoints @@ -90317,7 +92324,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/networkEndpointGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of regional network endpoint groups available to the @@ -90417,7 +92424,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified network endpoint group. operationId: compute.regionNetworkEndpointGroups.get @@ -90499,7 +92506,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Attach a list of network endpoints to the specified network endpoint @@ -90548,7 +92555,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: Detach the network endpoint from the specified network endpoint group. operationId: compute.regionNetworkEndpointGroups.detachNetworkEndpoints @@ -90595,7 +92602,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints: - parameters: *ref_141 + parameters: *ref_1 post: description: Lists the network endpoints in the specified network endpoint group. operationId: compute.regionNetworkEndpointGroups.listNetworkEndpoints @@ -90657,7 +92664,7 @@ paths: schema: type: boolean /projects/{project}/global/networks: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves the list of networks available to the specified project. operationId: compute.networks.list @@ -90745,7 +92752,7 @@ paths: schema: type: string /projects/{project}/global/networks/{network}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified network. operationId: compute.networks.get @@ -90856,7 +92863,7 @@ paths: schema: type: string /projects/{project}/global/networks/{network}/updatePeering: - parameters: *ref_141 + parameters: *ref_1 patch: description: >- Updates the specified network peering with the data included in the @@ -90900,7 +92907,7 @@ paths: schema: type: string /projects/{project}/global/networks/{network}/addPeering: - parameters: *ref_141 + parameters: *ref_1 post: description: Adds a peering to the specified network. operationId: compute.networks.addPeering @@ -90941,7 +92948,7 @@ paths: schema: type: string /projects/{project}/global/networks/{network}/removePeering: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes a peering from the specified network. operationId: compute.networks.removePeering @@ -90982,7 +92989,7 @@ paths: schema: type: string /projects/{project}/global/networks/{network}/switchToCustomMode: - parameters: *ref_141 + parameters: *ref_1 post: description: Switches the network mode from auto subnet mode to custom subnet mode. operationId: compute.networks.switchToCustomMode @@ -91018,7 +93025,7 @@ paths: schema: type: string /projects/{project}/global/networks/{network}/getEffectiveFirewalls: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the effective firewalls on a given network. operationId: compute.networks.getEffectiveFirewalls @@ -91054,7 +93061,7 @@ paths: schema: type: string /projects/{project}/global/networks/{network}/listPeeringRoutes: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the peering routes exchanged over peering connection. operationId: compute.networks.listPeeringRoutes @@ -91123,7 +93130,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/nodeGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of node groups available to the specified project. @@ -91229,7 +93236,7 @@ paths: schema: type: string /projects/{project}/aggregated/nodeGroups: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of node groups. Note: use @@ -91294,7 +93301,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified NodeGroup. Get a list of available NodeGroups by @@ -91421,7 +93428,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes: - parameters: *ref_141 + parameters: *ref_1 post: description: Adds specified number of nodes to the node group. operationId: compute.nodeGroups.addNodes @@ -91467,7 +93474,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes: - parameters: *ref_141 + parameters: *ref_1 post: description: Deletes specified nodes from the node group. operationId: compute.nodeGroups.deleteNodes @@ -91513,7 +93520,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes: - parameters: *ref_141 + parameters: *ref_1 post: description: Lists nodes in the node group. operationId: compute.nodeGroups.listNodes @@ -91575,7 +93582,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate: - parameters: *ref_141 + parameters: *ref_1 post: description: Updates the node template of the node group. operationId: compute.nodeGroups.setNodeTemplate @@ -91621,7 +93628,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent: - parameters: *ref_141 + parameters: *ref_1 post: description: Simulates maintenance event on specified nodes from the node group. operationId: compute.nodeGroups.simulateMaintenanceEvent @@ -91667,7 +93674,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance: - parameters: *ref_141 + parameters: *ref_1 post: description: Perform maintenance on a subset of nodes in the node group. operationId: compute.nodeGroups.performMaintenance @@ -91713,7 +93720,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -91761,7 +93768,7 @@ paths: type: integer format: int32 /projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -91805,7 +93812,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.nodeGroups.testIamPermissions @@ -91851,7 +93858,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/nodeTemplates: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of node templates available to the specified project. operationId: compute.nodeTemplates.list @@ -91949,7 +93956,7 @@ paths: schema: type: string /projects/{project}/aggregated/nodeTemplates: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of node templates. To prevent failure, @@ -92013,7 +94020,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified node template. operationId: compute.nodeTemplates.get @@ -92093,7 +94100,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -92141,7 +94148,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -92185,7 +94192,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.nodeTemplates.testIamPermissions @@ -92231,7 +94238,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/nodeTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of node types available to the specified project. operationId: compute.nodeTypes.list @@ -92288,7 +94295,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/nodeTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of node types. To prevent failure, Google @@ -92351,7 +94358,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/nodeTypes/{nodeType}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified node type. operationId: compute.nodeTypes.get @@ -92392,7 +94399,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/notificationEndpoints: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the NotificationEndpoints for a project in the given region. operationId: compute.regionNotificationEndpoints.list @@ -92490,7 +94497,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified NotificationEndpoint resource in the given region. operationId: compute.regionNotificationEndpoints.get @@ -92570,7 +94577,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified PacketMirroring resource. operationId: compute.packetMirrorings.get @@ -92697,7 +94704,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/packetMirrorings: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates a PacketMirroring resource in the specified project and region @@ -92797,7 +94804,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/packetMirrorings: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of packetMirrorings. To prevent failure, @@ -92861,7 +94868,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.packetMirrorings.testIamPermissions @@ -92907,7 +94914,7 @@ paths: schema: type: string /projects/{project}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified Project resource. To decrease latency for this @@ -92946,7 +94953,7 @@ paths: schema: type: string /projects/{project}/setCommonInstanceMetadata: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets metadata common to all instances within the specified project using @@ -92984,7 +94991,7 @@ paths: schema: type: string /projects/{project}/setUsageExportBucket: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Enables the usage export feature and sets the usage export bucket where @@ -93035,7 +95042,7 @@ paths: schema: type: string /projects/{project}/moveInstance: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Moves an instance and its attached persistent disks from one zone to @@ -93077,7 +95084,7 @@ paths: schema: type: string /projects/{project}/moveDisk: - parameters: *ref_141 + parameters: *ref_1 post: description: Moves a persistent disk from one zone to another. operationId: compute.projects.moveDisk @@ -93113,7 +95120,7 @@ paths: schema: type: string /projects/{project}/listXpnHosts: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Lists all shared VPC host projects visible to the user in an @@ -93168,7 +95175,7 @@ paths: schema: type: boolean /projects/{project}/enableXpnHost: - parameters: *ref_141 + parameters: *ref_1 post: description: Enable this project as a shared VPC host project. operationId: compute.projects.enableXpnHost @@ -93199,7 +95206,7 @@ paths: schema: type: string /projects/{project}/disableXpnHost: - parameters: *ref_141 + parameters: *ref_1 post: description: Disable this project as a shared VPC host project. operationId: compute.projects.disableXpnHost @@ -93230,7 +95237,7 @@ paths: schema: type: string /projects/{project}/enableXpnResource: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Enable service resource (a.k.a service project) for a host project, so @@ -93269,7 +95276,7 @@ paths: schema: type: string /projects/{project}/disableXpnResource: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Disable a service resource (also known as service project) associated @@ -93307,7 +95314,7 @@ paths: schema: type: string /projects/{project}/getXpnHost: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the shared VPC host project that this project links to. May be @@ -93336,7 +95343,7 @@ paths: schema: type: string /projects/{project}/getXpnResources: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets service resources (a.k.a service project) associated with this host @@ -93386,7 +95393,7 @@ paths: schema: type: boolean /projects/{project}/setDefaultNetworkTier: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the default network tier of the project. The default network tier @@ -93425,7 +95432,7 @@ paths: schema: type: string /projects/{project}/setCloudArmorTier: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the @@ -93465,7 +95472,7 @@ paths: schema: type: string /projects/{project}/global/publicAdvertisedPrefixes: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the PublicAdvertisedPrefixes for a project. operationId: compute.publicAdvertisedPrefixes.list @@ -93553,7 +95560,7 @@ paths: schema: type: string /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified PublicAdvertisedPrefix resource. operationId: compute.publicAdvertisedPrefixes.get @@ -93665,7 +95672,7 @@ paths: schema: type: string /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce: - parameters: *ref_141 + parameters: *ref_1 post: description: Announces the specified PublicAdvertisedPrefix operationId: compute.publicAdvertisedPrefixes.announce @@ -93701,7 +95708,7 @@ paths: schema: type: string /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw: - parameters: *ref_141 + parameters: *ref_1 post: description: Withdraws the specified PublicAdvertisedPrefix operationId: compute.publicAdvertisedPrefixes.withdraw @@ -93737,7 +95744,7 @@ paths: schema: type: string /projects/{project}/global/publicDelegatedPrefixes: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the global PublicDelegatedPrefixes for a project. operationId: compute.globalPublicDelegatedPrefixes.list @@ -93825,7 +95832,7 @@ paths: schema: type: string /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified global PublicDelegatedPrefix resource. operationId: compute.globalPublicDelegatedPrefixes.get @@ -93937,7 +95944,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/publicDelegatedPrefixes: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the PublicDelegatedPrefixes for a project in the given region. operationId: compute.publicDelegatedPrefixes.list @@ -94035,7 +96042,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified PublicDelegatedPrefix resource in the given @@ -94164,7 +96171,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce: - parameters: *ref_141 + parameters: *ref_1 post: description: Announces the specified PublicDelegatedPrefix in the given region. operationId: compute.publicDelegatedPrefixes.announce @@ -94205,7 +96212,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw: - parameters: *ref_141 + parameters: *ref_1 post: description: Withdraws the specified PublicDelegatedPrefix in the given region. operationId: compute.publicDelegatedPrefixes.withdraw @@ -94246,7 +96253,7 @@ paths: schema: type: string /projects/{project}/aggregated/publicDelegatedPrefixes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all PublicDelegatedPrefix resources owned by the specific project @@ -94310,7 +96317,7 @@ paths: type: string format: int64 /projects/{project}/regions: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of region resources available to the specified @@ -94377,7 +96384,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified Region resource. To decrease latency for this @@ -94387,7 +96394,13 @@ paths: more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your - request. + request. This method fails if the quota information is unavailable for + the region and if the organization policy constraint + compute.requireBasicQuotaInResponse is enforced. This constraint, when + enforced, disables the fail-open behaviour when quota information (the + `items.quotas` field) is unavailable for the region. It is recommended + to use the default setting for the constraint unless your application + requires the fail-closed behaviour for this method. operationId: compute.regions.get security: - Oauth2: @@ -94421,7 +96434,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/resourcePolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- A list all the resource policies that have been configured for the @@ -94519,7 +96532,7 @@ paths: schema: type: string /projects/{project}/aggregated/resourcePolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of resource policies. To prevent failure, @@ -94583,7 +96596,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves all information of the specified resource policy. operationId: compute.resourcePolicies.get @@ -94712,7 +96725,7 @@ paths: type: string format: google-fieldmask /projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -94760,7 +96773,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -94804,7 +96817,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.resourcePolicies.testIamPermissions @@ -94850,7 +96863,7 @@ paths: schema: type: string /projects/{project}/global/routes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of Route resources available to the specified @@ -94940,7 +96953,7 @@ paths: schema: type: string /projects/{project}/global/routes/{route}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified Route resource. operationId: compute.routes.get @@ -95010,7 +97023,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/routers/{router}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified Router resource. operationId: compute.routers.get @@ -95185,7 +97198,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/routers: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Creates a Router resource in the specified project and region using the @@ -95283,7 +97296,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/routers: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of routers. To prevent failure, Google @@ -95346,7 +97359,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/routers/{router}/getRouterStatus: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves runtime information of the specified router. operationId: compute.routers.getRouterStatus @@ -95387,7 +97400,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves runtime Nat mapping information of VM endpoints. operationId: compute.routers.getNatMappingInfo @@ -95453,7 +97466,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/routers/{router}/getNatIpInfo: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves runtime NAT IP information. operationId: compute.routers.getNatIpInfo @@ -95498,7 +97511,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/routers/{router}/preview: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Preview fields auto-generated during router create and update @@ -95546,7 +97559,7 @@ paths: schema: type: string /projects/{project}/aggregated/serviceAttachments: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all ServiceAttachment resources, regional and @@ -95610,7 +97623,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/serviceAttachments: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the ServiceAttachments for a project in the given scope. operationId: compute.serviceAttachments.list @@ -95708,7 +97721,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified ServiceAttachment resource in the given scope. operationId: compute.serviceAttachments.get @@ -95835,7 +97848,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -95883,7 +97896,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -95927,7 +97940,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.serviceAttachments.testIamPermissions @@ -95973,7 +97986,7 @@ paths: schema: type: string /projects/{project}/global/snapshotSettings: - parameters: *ref_141 + parameters: *ref_1 get: description: Get snapshot settings. operationId: compute.snapshotSettings.get @@ -96043,7 +98056,7 @@ paths: type: string format: google-fieldmask /projects/{project}/global/sslCertificates: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of SslCertificate resources available to the @@ -96133,7 +98146,7 @@ paths: schema: type: string /projects/{project}/global/sslCertificates/{sslCertificate}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified SslCertificate resource. operationId: compute.sslCertificates.get @@ -96203,7 +98216,7 @@ paths: schema: type: string /projects/{project}/aggregated/sslCertificates: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all SslCertificate resources, regional and global, @@ -96267,7 +98280,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/sslCertificates: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of SslCertificate resources available to the @@ -96367,7 +98380,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/sslCertificates/{sslCertificate}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns the specified SslCertificate resource in the specified region. @@ -96449,7 +98462,7 @@ paths: schema: type: string /projects/{project}/global/sslPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all the SSL policies that have been configured for the specified @@ -96537,7 +98550,7 @@ paths: schema: type: string /projects/{project}/global/sslPolicies/{sslPolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists all of the ordered rules present in a single specified policy. operationId: compute.sslPolicies.get @@ -96649,7 +98662,7 @@ paths: schema: type: string /projects/{project}/global/sslPolicies/listAvailableFeatures: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all features that can be specified in the SSL policy when using @@ -96703,7 +98716,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/sslPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all SslPolicy resources, regional and global, @@ -96767,7 +98780,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/sslPolicies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all the SSL policies that have been configured for the specified @@ -96867,7 +98880,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/sslPolicies/{sslPolicy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists all of the ordered rules present in a single specified policy. operationId: compute.regionSslPolicies.get @@ -96994,7 +99007,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Lists all features that can be specified in the SSL policy when using @@ -97053,7 +99066,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}/storagePoolTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of storage pool types available to the specified @@ -97112,7 +99125,7 @@ paths: schema: type: boolean /projects/{project}/aggregated/storagePoolTypes: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of storage pool types. To prevent failure, @@ -97176,7 +99189,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified storage pool type. operationId: compute.storagePoolTypes.get @@ -97217,7 +99230,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/storagePools: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of storage pools contained within the specified zone. operationId: compute.storagePools.list @@ -97315,7 +99328,7 @@ paths: schema: type: string /projects/{project}/aggregated/storagePools: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of storage pools. To prevent failure, @@ -97379,7 +99392,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/storagePools/{storagePool}: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Returns a specified storage pool. Gets a list of available storage pools @@ -97468,8 +99481,9 @@ paths: description: >- Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of - update-mask. Only the following fields can be modified: size_tb and - provisioned_iops. + update-mask. Only the following fields can be modified: + pool_provisioned_capacity_gb, pool_provisioned_iops and + pool_provisioned_throughput. operationId: compute.storagePools.update requestBody: content: @@ -97518,7 +99532,7 @@ paths: type: string format: google-fieldmask /projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -97566,7 +99580,7 @@ paths: type: integer format: int32 /projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -97610,7 +99624,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.storagePools.testIamPermissions @@ -97656,7 +99670,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the disks in a specified storage pool. operationId: compute.storagePools.listDisks @@ -97718,7 +99732,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/subnetworks: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves a list of subnetworks available to the specified project. operationId: compute.subnetworks.list @@ -97816,7 +99830,7 @@ paths: schema: type: string /projects/{project}/aggregated/subnetworks: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of subnetworks. To prevent failure, Google @@ -97879,7 +99893,7 @@ paths: type: string format: int64 /projects/{project}/aggregated/subnetworks/listUsable: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves an aggregated list of all usable subnetworks in the project. operationId: compute.subnetworks.listUsable @@ -97931,7 +99945,7 @@ paths: schema: type: boolean /projects/{project}/regions/{region}/subnetworks/{subnetwork}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified subnetwork. operationId: compute.subnetworks.get @@ -98064,7 +100078,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange: - parameters: *ref_141 + parameters: *ref_1 post: description: Expands the IP CIDR range of the subnetwork to a specified value. operationId: compute.subnetworks.expandIpCidrRange @@ -98110,7 +100124,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -98158,7 +100172,7 @@ paths: type: integer format: int32 /projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -98202,7 +100216,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.subnetworks.testIamPermissions @@ -98248,7 +100262,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Set whether VMs in this subnet can access Google services without @@ -98296,7 +100310,7 @@ paths: schema: type: string /projects/{project}/global/targetGrpcProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: Lists the TargetGrpcProxies for a project in the given scope. operationId: compute.targetGrpcProxies.list @@ -98384,7 +100398,7 @@ paths: schema: type: string /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetGrpcProxy resource in the given scope. operationId: compute.targetGrpcProxies.get @@ -98496,7 +100510,7 @@ paths: schema: type: string /projects/{project}/global/targetHttpProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of TargetHttpProxy resources available to the @@ -98586,7 +100600,7 @@ paths: schema: type: string /projects/{project}/global/targetHttpProxies/{targetHttpProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetHttpProxy resource. operationId: compute.targetHttpProxies.get @@ -98698,7 +100712,7 @@ paths: schema: type: string /projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the URL map for TargetHttpProxy. operationId: compute.targetHttpProxies.setUrlMap @@ -98739,7 +100753,7 @@ paths: schema: type: string /projects/{project}/aggregated/targetHttpProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all TargetHttpProxy resources, regional and @@ -98803,7 +100817,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/targetHttpProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of TargetHttpProxy resources available to the @@ -98903,7 +100917,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetHttpProxy resource in the specified region. operationId: compute.regionTargetHttpProxies.get @@ -98983,7 +100997,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the URL map for TargetHttpProxy. operationId: compute.regionTargetHttpProxies.setUrlMap @@ -99029,7 +101043,7 @@ paths: schema: type: string /projects/{project}/global/targetHttpsProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of TargetHttpsProxy resources available to the @@ -99119,7 +101133,7 @@ paths: schema: type: string /projects/{project}/aggregated/targetHttpsProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all TargetHttpsProxy resources, regional and @@ -99183,7 +101197,7 @@ paths: type: string format: int64 /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetHttpsProxy resource. operationId: compute.targetHttpsProxies.get @@ -99295,7 +101309,7 @@ paths: schema: type: string /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the URL map for TargetHttpsProxy. operationId: compute.targetHttpsProxies.setUrlMap @@ -99336,7 +101350,7 @@ paths: schema: type: string /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates: - parameters: *ref_141 + parameters: *ref_1 post: description: Replaces SslCertificates for TargetHttpsProxy. operationId: compute.targetHttpsProxies.setSslCertificates @@ -99377,7 +101391,7 @@ paths: schema: type: string /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the Certificate Map for TargetHttpsProxy. operationId: compute.targetHttpsProxies.setCertificateMap @@ -99418,7 +101432,7 @@ paths: schema: type: string /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the @@ -99463,7 +101477,7 @@ paths: schema: type: string /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride: - parameters: *ref_141 + parameters: *ref_1 post: description: Sets the QUIC override policy for TargetHttpsProxy. operationId: compute.targetHttpsProxies.setQuicOverride @@ -99504,7 +101518,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetHttpsProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of TargetHttpsProxy resources available to the @@ -99604,7 +101618,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetHttpsProxy resource in the specified region. operationId: compute.regionTargetHttpsProxies.get @@ -99731,7 +101745,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the URL map for TargetHttpsProxy. operationId: compute.regionTargetHttpsProxies.setUrlMap @@ -99777,7 +101791,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates: - parameters: *ref_141 + parameters: *ref_1 post: description: Replaces SslCertificates for TargetHttpsProxy. operationId: compute.regionTargetHttpsProxies.setSslCertificates @@ -99824,7 +101838,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/targetInstances: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of TargetInstance resources available to the specified @@ -99924,7 +101938,7 @@ paths: schema: type: string /projects/{project}/aggregated/targetInstances: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of target instances. To prevent failure, @@ -99988,7 +102002,7 @@ paths: type: string format: int64 /projects/{project}/zones/{zone}/targetInstances/{targetInstance}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetInstance resource. operationId: compute.targetInstances.get @@ -100068,7 +102082,7 @@ paths: schema: type: string /projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the Google Cloud Armor security policy for the specified target @@ -100116,7 +102130,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of target pools available to the specified project and @@ -100216,7 +102230,7 @@ paths: schema: type: string /projects/{project}/aggregated/targetPools: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of target pools. To prevent failure, Google @@ -100279,7 +102293,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/targetPools/{targetPool}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified target pool. operationId: compute.targetPools.get @@ -100359,7 +102373,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Gets the most recent health check results for each IP for the instance @@ -100407,7 +102421,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck: - parameters: *ref_141 + parameters: *ref_1 post: description: Adds health check URLs to a target pool. operationId: compute.targetPools.addHealthCheck @@ -100453,7 +102467,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes health check URL from a target pool. operationId: compute.targetPools.removeHealthCheck @@ -100499,7 +102513,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance: - parameters: *ref_141 + parameters: *ref_1 post: description: Adds an instance to a target pool. operationId: compute.targetPools.addInstance @@ -100545,7 +102559,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance: - parameters: *ref_141 + parameters: *ref_1 post: description: Removes instance URL from a target pool. operationId: compute.targetPools.removeInstance @@ -100591,7 +102605,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes a backup target pool's configurations. operationId: compute.targetPools.setBackup @@ -100642,7 +102656,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the Google Cloud Armor security policy for the specified target @@ -100690,7 +102704,7 @@ paths: schema: type: string /projects/{project}/global/targetSslProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of TargetSslProxy resources available to the @@ -100780,7 +102794,7 @@ paths: schema: type: string /projects/{project}/global/targetSslProxies/{targetSslProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetSslProxy resource. operationId: compute.targetSslProxies.get @@ -100850,7 +102864,7 @@ paths: schema: type: string /projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the BackendService for TargetSslProxy. operationId: compute.targetSslProxies.setBackendService @@ -100891,7 +102905,7 @@ paths: schema: type: string /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes SslCertificates for TargetSslProxy. operationId: compute.targetSslProxies.setSslCertificates @@ -100932,7 +102946,7 @@ paths: schema: type: string /projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the Certificate Map for TargetSslProxy. operationId: compute.targetSslProxies.setCertificateMap @@ -100973,7 +102987,7 @@ paths: schema: type: string /projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the ProxyHeaderType for TargetSslProxy. operationId: compute.targetSslProxies.setProxyHeader @@ -101014,7 +103028,7 @@ paths: schema: type: string /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the SSL policy for TargetSslProxy. The SSL policy specifies the @@ -101059,7 +103073,7 @@ paths: schema: type: string /projects/{project}/global/targetTcpProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of TargetTcpProxy resources available to the @@ -101149,7 +103163,7 @@ paths: schema: type: string /projects/{project}/aggregated/targetTcpProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all TargetTcpProxy resources, regional and global, @@ -101213,7 +103227,7 @@ paths: type: string format: int64 /projects/{project}/global/targetTcpProxies/{targetTcpProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetTcpProxy resource. operationId: compute.targetTcpProxies.get @@ -101283,7 +103297,7 @@ paths: schema: type: string /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the BackendService for TargetTcpProxy. operationId: compute.targetTcpProxies.setBackendService @@ -101324,7 +103338,7 @@ paths: schema: type: string /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader: - parameters: *ref_141 + parameters: *ref_1 post: description: Changes the ProxyHeaderType for TargetTcpProxy. operationId: compute.targetTcpProxies.setProxyHeader @@ -101365,7 +103379,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetTcpProxies: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of TargetTcpProxy resources available to the specified @@ -101465,7 +103479,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified TargetTcpProxy resource. operationId: compute.regionTargetTcpProxies.get @@ -101545,7 +103559,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetVpnGateways: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of target VPN gateways available to the specified @@ -101645,7 +103659,7 @@ paths: schema: type: string /projects/{project}/aggregated/targetVpnGateways: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of target VPN gateways. To prevent failure, @@ -101709,7 +103723,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified target VPN gateway. operationId: compute.targetVpnGateways.get @@ -101789,7 +103803,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a TargetVpnGateway. To learn more about labels, read @@ -101837,7 +103851,7 @@ paths: schema: type: string /projects/{project}/global/urlMaps: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of UrlMap resources available to the specified @@ -101927,7 +103941,7 @@ paths: schema: type: string /projects/{project}/aggregated/urlMaps: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of all UrlMap resources, regional and global, @@ -101991,7 +104005,7 @@ paths: type: string format: int64 /projects/{project}/global/urlMaps/{urlMap}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified UrlMap resource. operationId: compute.urlMaps.get @@ -102144,7 +104158,7 @@ paths: schema: type: string /projects/{project}/global/urlMaps/{urlMap}/validate: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Runs static validation for the UrlMap. In particular, the tests of the @@ -102184,7 +104198,7 @@ paths: schema: type: string /projects/{project}/global/urlMaps/{urlMap}/invalidateCache: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Initiates a cache invalidation operation, invalidating the specified @@ -102228,7 +104242,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/urlMaps: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of UrlMap resources available to the specified @@ -102328,7 +104342,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/urlMaps/{urlMap}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified UrlMap resource. operationId: compute.regionUrlMaps.get @@ -102501,7 +104515,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/urlMaps/{urlMap}/validate: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Runs static validation for the UrlMap. In particular, the tests of the @@ -102546,7 +104560,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/vpnGateways: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of VPN gateways available to the specified project and @@ -102646,7 +104660,7 @@ paths: schema: type: string /projects/{project}/aggregated/vpnGateways: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of VPN gateways. To prevent failure, Google @@ -102709,7 +104723,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified VPN gateway. operationId: compute.vpnGateways.get @@ -102789,7 +104803,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the status for the specified VPN gateway. operationId: compute.vpnGateways.getStatus @@ -102830,7 +104844,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions: - parameters: *ref_141 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: compute.vpnGateways.testIamPermissions @@ -102876,7 +104890,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a VpnGateway. To learn more about labels, read the @@ -102924,7 +104938,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/vpnTunnels: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves a list of VpnTunnel resources contained in the specified @@ -103024,7 +105038,7 @@ paths: schema: type: string /projects/{project}/aggregated/vpnTunnels: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves an aggregated list of VPN tunnels. To prevent failure, Google @@ -103087,7 +105101,7 @@ paths: type: string format: int64 /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified VpnTunnel resource. operationId: compute.vpnTunnels.get @@ -103167,7 +105181,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels: - parameters: *ref_141 + parameters: *ref_1 post: description: >- Sets the labels on a VpnTunnel. To learn more about labels, read the @@ -103215,7 +105229,7 @@ paths: schema: type: string /projects/{project}/zones: - parameters: *ref_141 + parameters: *ref_1 get: description: Retrieves the list of Zone resources available to the specified project. operationId: compute.zones.list @@ -103267,7 +105281,7 @@ paths: schema: type: boolean /projects/{project}/zones/{zone}: - parameters: *ref_141 + parameters: *ref_1 get: description: Returns the specified Zone resource. operationId: compute.zones.get @@ -103303,7 +105317,7 @@ paths: schema: type: string /projects/{project}/regions/{region}/zones: - parameters: *ref_141 + parameters: *ref_1 get: description: >- Retrieves the list of Zone resources under the specific region available diff --git a/providers/src/googleapis.com/v00.00.00000/services/config.yaml b/providers/src/googleapis.com/v00.00.00000/services/config.yaml index 42f2cf8a..842b05ec 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/config.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/config.yaml @@ -7,8 +7,8 @@ info: title: Infrastructure Manager API description: Creates and manages Google Cloud Platform resources and infrastructure. version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240828' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/infrastructure-manager/docs servers: @@ -396,12 +396,12 @@ components: properties: gcsSource: description: >- - Required. URI of an object in Google Cloud Storage. Format: + URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` type: string gitSource: - description: Required. URI of a public Git repo. + description: URI of a public Git repo. $ref: '#/components/schemas/GitSource' inputValues: description: Input variable values for the Terraform blueprint. @@ -1815,16 +1815,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1837,23 +1834,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.config.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1881,6 +1876,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' deployments: @@ -1888,17 +1884,14 @@ components: name: deployments title: Deployments methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1970,6 +1963,7 @@ components: - $ref: '#/components/x-stackQL-resources/deployments/methods/create' update: - $ref: '#/components/x-stackQL-resources/deployments/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' deployments_state: @@ -1988,7 +1982,10 @@ components: select: [] insert: [] update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/deployments_state/methods/delete_state deployments_iam_policies: id: google.config.deployments_iam_policies name: deployments_iam_policies @@ -2001,17 +1998,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2025,23 +2019,23 @@ components: #/components/x-stackQL-resources/deployments_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/set_iam_policy delete: [] revisions: id: google.config.revisions name: revisions title: Revisions methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}~1revisions/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.revisions - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -2062,6 +2056,7 @@ components: - $ref: '#/components/x-stackQL-resources/revisions/methods/list' insert: [] update: [] + replace: [] delete: [] resources: id: google.config.resources @@ -2075,23 +2070,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1deployments~1{deploymentsId}~1revisions~1{revisionsId}~1resources/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resources - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/resources/methods/get' - $ref: '#/components/x-stackQL-resources/resources/methods/list' insert: [] update: [] + replace: [] delete: [] previews: id: google.config.previews @@ -2105,17 +2098,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1previews/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.previews - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -2144,6 +2134,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/previews/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/previews/methods/delete' terraform_versions: @@ -2151,17 +2142,14 @@ components: name: terraform_versions title: Terraform_versions methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1terraformVersions/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.terraformVersions - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -2175,10 +2163,11 @@ components: - $ref: '#/components/x-stackQL-resources/terraform_versions/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_17 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2225,7 +2214,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about a location. operationId: config.projects.locations.get @@ -2253,7 +2242,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2296,7 +2285,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2367,7 +2356,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2414,7 +2403,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists Deployments in a given project and location. operationId: config.projects.locations.deployments.list @@ -2498,7 +2487,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details about a Deployment. operationId: config.projects.locations.deployments.get @@ -2619,7 +2608,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:exportState: - parameters: *ref_17 + parameters: *ref_1 post: description: Exports Terraform state file from a given deployment. operationId: config.projects.locations.deployments.exportState @@ -2657,7 +2646,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:importState: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Imports Terraform state file in a given deployment. The state file does @@ -2697,7 +2686,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:deleteState: - parameters: *ref_17 + parameters: *ref_1 post: description: Deletes Terraform state file in a given deployment. operationId: config.projects.locations.deployments.deleteState @@ -2735,7 +2724,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:lock: - parameters: *ref_17 + parameters: *ref_1 post: description: Locks a deployment. operationId: config.projects.locations.deployments.lock @@ -2773,7 +2762,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:unlock: - parameters: *ref_17 + parameters: *ref_1 post: description: Unlocks a locked deployment. operationId: config.projects.locations.deployments.unlock @@ -2811,7 +2800,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:exportLock: - parameters: *ref_17 + parameters: *ref_1 get: description: Exports the lock info on a locked deployment. operationId: config.projects.locations.deployments.exportLock @@ -2844,7 +2833,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:setIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2885,7 +2874,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:getIamPolicy: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2925,7 +2914,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2968,7 +2957,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists Revisions of a deployment. operationId: config.projects.locations.deployments.revisions.list @@ -3018,7 +3007,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details about a Revision. operationId: config.projects.locations.deployments.revisions.get @@ -3056,7 +3045,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}:exportState: - parameters: *ref_17 + parameters: *ref_1 post: description: Exports Terraform state file from a given revision. operationId: config.projects.locations.deployments.revisions.exportState @@ -3099,7 +3088,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}/resources/{resourcesId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details about a Resource deployed by Infra Manager. operationId: config.projects.locations.deployments.revisions.resources.get @@ -3142,7 +3131,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}/resources: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists Resources in a given revision. operationId: config.projects.locations.deployments.revisions.resources.list @@ -3197,7 +3186,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/previews: - parameters: *ref_17 + parameters: *ref_1 post: description: Creates a Preview. operationId: config.projects.locations.previews.create @@ -3281,7 +3270,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details about a Preview. operationId: config.projects.locations.previews.get @@ -3349,7 +3338,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}:export: - parameters: *ref_17 + parameters: *ref_1 post: description: Export Preview results. operationId: config.projects.locations.previews.export @@ -3387,7 +3376,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/terraformVersions: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists TerraformVersions in a given project and location. operationId: config.projects.locations.terraformVersions.list @@ -3432,7 +3421,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/terraformVersions/{terraformVersionsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets details about a TerraformVersion. operationId: config.projects.locations.terraformVersions.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml b/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml index 22a7aea0..70017e98 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/connectors.yaml @@ -9,8 +9,8 @@ info: Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface. version: v2 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: >- https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors @@ -653,6 +653,14 @@ components: JsonSchema of the result, applicable only if parameter is of type `STRUCT` $ref: '#/components/schemas/JsonSchema' + nullable: + description: Specifies whether a null value is allowed. + type: boolean + defaultValue: + description: >- + The following field specifies the default value of the Parameter + provided by the external system if a value is not provided. + type: any CheckStatusResponse: id: CheckStatusResponse description: The status of the connector. @@ -696,9 +704,35 @@ components: type: string ExchangeAuthCodeRequest: id: ExchangeAuthCodeRequest - description: ExchangeAuthCodeRequest currently includes no fields. + description: ExchangeAuthCodeRequest currently includes the auth code data. type: object - properties: {} + properties: + authCodeData: + description: >- + Optional. AuthCodeData contains the data the runtime requires to + exchange for access and refresh tokens. If the data is not provided, + the runtime will read the data from the secret manager. + $ref: '#/components/schemas/AuthCodeData' + AuthCodeData: + id: AuthCodeData + description: >- + AuthCodeData contains the data the runtime plane will give the connector + backend in exchange for access and refresh tokens. + type: object + properties: + authCode: + description: OAuth authorization code. + type: string + pkceVerifier: + description: >- + OAuth PKCE verifier, needed if PKCE is enabled for this particular + connection. + type: string + redirectUri: + description: >- + OAuth redirect URI passed in during the auth code flow, required by + some OAuth backends. + type: string ExchangeAuthCodeResponse: id: ExchangeAuthCodeResponse description: >- @@ -727,9 +761,14 @@ components: format: google-duration RefreshAccessTokenRequest: id: RefreshAccessTokenRequest - description: RefreshAccessTokenRequest currently includes no fields. + description: RefreshAccessTokenRequest includes the refresh token. type: object - properties: {} + properties: + refreshToken: + description: >- + Optional. Refresh Token String. If the Refresh Token is not + provided, the runtime will read the data from the secret manager. + type: string RefreshAccessTokenResponse: id: RefreshAccessTokenResponse description: >- @@ -1989,6 +2028,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] actions: id: google.connectors.actions @@ -2002,17 +2042,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1actions/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.actions - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -2026,6 +2063,7 @@ components: - $ref: '#/components/x-stackQL-resources/actions/methods/list' insert: [] update: [] + replace: [] delete: [] entity_types: id: google.connectors.entity_types @@ -2039,40 +2077,35 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1entityTypes/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.types - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/entity_types/methods/get' - $ref: '#/components/x-stackQL-resources/entity_types/methods/list' insert: [] update: [] + replace: [] delete: [] entities: id: google.connectors.entities name: entities title: Entities methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1entityTypes~1{entityTypesId}~1entities/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entities - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -2109,6 +2142,7 @@ components: - $ref: '#/components/x-stackQL-resources/entities/methods/create' update: - $ref: '#/components/x-stackQL-resources/entities/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/entities/methods/delete' entities_entities_with_conditions: @@ -2133,11 +2167,16 @@ components: sqlVerbs: select: [] insert: [] - update: [] - delete: [] + update: + - $ref: >- + #/components/x-stackQL-resources/entities_entities_with_conditions/methods/update_entities_with_conditions + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/entities_entities_with_conditions/methods/delete_entities_with_conditions paths: /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkStatus: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2186,7 +2225,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkReadiness: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Reports readiness status of the connector. Similar logic to GetStatus @@ -2221,7 +2260,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:exchangeAuthCode: - parameters: *ref_7 + parameters: *ref_1 post: description: >- ExchangeAuthCode exchanges the OAuth authorization code (and other @@ -2261,7 +2300,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:refreshAccessToken: - parameters: *ref_7 + parameters: *ref_1 post: description: >- RefreshAccessToken exchanges the OAuth refresh token (and other @@ -2301,7 +2340,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:executeSqlQuery: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Executes a SQL statement specified in the body of the request. An @@ -2342,7 +2381,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}:execute: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Executes an action with the name specified in the request. The input @@ -2388,7 +2427,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets the schema of all the actions supported by the connector. operationId: connectors.projects.locations.connections.actions.list @@ -2434,7 +2473,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets the schema of the given action. operationId: connectors.projects.locations.connections.actions.get @@ -2472,7 +2511,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets metadata of given entity type operationId: connectors.projects.locations.connections.entityTypes.get @@ -2510,7 +2549,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists metadata related to all entity types present in the external @@ -2558,7 +2597,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists entity rows of a particular entity type contained in the request. @@ -2668,7 +2707,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets a single entity row matching the entity type and entity id @@ -2807,7 +2846,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:updateEntitiesWithConditions: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Updates entities based on conditions specified in the request and not on @@ -2857,7 +2896,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:deleteEntitiesWithConditions: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Deletes entities based on conditions specified in the request and not on diff --git a/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml b/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml index 25ec678e..1db30765 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenteraiplatform.yaml @@ -7,8 +7,8 @@ info: title: Contact Center AI Platform API description: '' version: v1alpha1 - x-discovery-doc-revision: '20240531' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/solutions/contact-center-ai-platform servers: @@ -262,13 +262,7 @@ components: (`ContactCenter`). type: string privateComponents: - description: >- - Output only. A list of UJET components that should be privately - accessed. This field is set by reading settings from the data plane. - For more information about the format of the component please refer - to go/ccaip-vpc-sc-org-policy. This field is must be fully populated - only for Create/Update resource operations. The main use case for - this field is OrgPolicy checks via CPE. + description: Output only. TODO(b/283407860) Deprecate this field. readOnly: true type: array items: @@ -530,6 +524,9 @@ components: type: array items: $ref: '#/components/schemas/Component' + pscSetting: + description: Private service connect settings. + $ref: '#/components/schemas/PscSetting' Component: id: Component description: >- @@ -541,27 +538,31 @@ components: name: description: Name of the component. type: string - serviceAttachments: - description: Associated service attachments. + serviceAttachmentNames: + description: >- + Associated service attachments. The service attachment names that + will be used for sending private traffic to the CCAIP tenant + project. Example service attachment name: + "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". type: array items: - $ref: '#/components/schemas/ServiceAttachment' - ServiceAttachment: - id: ServiceAttachment - description: Container for the VPC-SC networking configurations. + type: string + PscSetting: + id: PscSetting + description: Private service connect settings. type: object properties: - name: - description: >- - The service attachment name that will be used for sending private - traffic to the CCAIP tenant project. Example: - "projects/${TENANT_PROJECT_ID}/regions/${REGION}/serviceAttachments/ingress-default". - type: string - allowedProjectIds: + allowedConsumerProjectIds: description: >- The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress - service attachments. + components. + type: array + items: + type: string + producerProjectIds: + description: Output only. The CCAIP tenant project ids. + readOnly: true type: array items: type: string @@ -583,8 +584,8 @@ components: id: Critical description: >- Instances in this Channel will receive updates after all instances in - `Critical` were updated + 2 days. They also will only be updated outside - of their peak hours. + `Normal` were updated. They also will only be updated outside of their + peak hours. type: object properties: peakHours: @@ -960,16 +961,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1alpha1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -979,27 +977,27 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/query_contact_center_quota - $ref: '#/components/x-stackQL-resources/locations/methods/get' - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.contactcenteraiplatform.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1alpha1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1027,6 +1025,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' contact_centers: @@ -1034,17 +1033,14 @@ components: name: contact_centers title: Contact_centers methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1alpha1~1projects~1{projectsId}~1locations~1{locationsId}~1contactCenters/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.contactCenters - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1081,11 +1077,12 @@ components: - $ref: '#/components/x-stackQL-resources/contact_centers/methods/create' update: - $ref: '#/components/x-stackQL-resources/contact_centers/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/contact_centers/methods/delete' paths: /v1alpha1/projects/{projectsId}/locations/{locationsId}:queryContactCenterQuota: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1126,7 +1123,7 @@ paths: schema: type: string /v1alpha1/projects/{projectsId}/locations: - parameters: *ref_7 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: contactcenteraiplatform.projects.locations.list @@ -1162,7 +1159,7 @@ paths: schema: type: string /v1alpha1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets information about a location. operationId: contactcenteraiplatform.projects.locations.get @@ -1190,7 +1187,7 @@ paths: schema: type: string /v1alpha1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1233,7 +1230,7 @@ paths: schema: type: string /v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1304,7 +1301,7 @@ paths: schema: type: string /v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1351,7 +1348,7 @@ paths: schema: type: string /v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters: - parameters: *ref_7 + parameters: *ref_1 get: description: Lists ContactCenters in a given project and location. operationId: contactcenteraiplatform.projects.locations.contactCenters.list @@ -1435,7 +1432,7 @@ paths: schema: type: string /v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters/{contactCentersId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets details of a single ContactCenter. operationId: contactcenteraiplatform.projects.locations.contactCenters.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml index cbfaee57..805ef09e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contactcenterinsights.yaml @@ -7,8 +7,8 @@ info: title: Contact Center AI Insights API description: '' version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/contact-center/insights/docs servers: @@ -34,349 +34,355 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - description: The request to ingest conversations. - type: object + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: + description: The response for a bulk analyze conversations operation. properties: - sampleSize: + successfulAnalysisCount: + description: Count of successful analyses. + format: int32 type: integer + failedAnalysisCount: format: int32 + description: Count of failed analyses. + type: integer + type: object + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse + GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: + properties: + bucketUri: + type: string + description: Required. The Cloud Storage bucket containing source objects. + bucketObjectType: + enumDescriptions: + - The object type is unspecified and will default to `TRANSCRIPT`. + - The object is a transcript. + - The object is an audio file. + description: Optional. Specifies the type of the objects in `bucket_uri`. + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + type: string + customMetadataKeys: + type: array description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Note that conversations produced via sampling will - not be ingested by subsequent ingest requests unless they are first - deleted. - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - conversationConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig - description: Configuration that applies to all conversations. - speechConfig: + Optional. Custom keys to extract as conversation labels from + metadata files in `metadata_bucket_uri`. Keys not included in this + field will be ignored. Note that there is a limit of 20 labels per + conversation. + items: + type: string + metadataBucketUri: description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - parent: - description: Required. The parent resource for new conversations. + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. type: string - transcriptObjectConfig: - description: Configuration for when `source` contains conversation transcripts. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - redactionConfig: - description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource type: object - description: Metadata for deploying an issue model. + description: Configuration for Cloud Storage bucket sources. + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: properties: - endTime: - description: Output only. The time the operation finished running. + name: + description: Required. The issue model to deploy. type: string - format: google-datetime - readOnly: true - request: - description: The original request for deployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest - createTime: - description: Output only. The time the operation was created. + description: The request to deploy an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + type: object + GoogleCloudContactcenterinsightsV1PhraseMatcher: + id: GoogleCloudContactcenterinsightsV1PhraseMatcher + properties: + activationUpdateTime: + description: >- + Output only. The most recent time at which the activation status was + updated. format: google-datetime type: string readOnly: true - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata - GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: - type: object - description: The response of listing issue models. - id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse - properties: - issueModels: - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - type: array - description: The issue models that match the request. - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - properties: - customerChannel: - format: int32 + name: + type: string description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - type: integer - agentChannel: + The resource name of the phrase matcher. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + displayName: + description: The human-readable name of the phrase matcher. + type: string + revisionCreateTime: + readOnly: true + format: google-datetime description: >- - Optional. Indicates which of the channels, 1 or 2, contains the - agent. Note that this must be set for conversations to be properly - displayed and analyzed. - format: int32 - type: integer - agentId: + Output only. The timestamp of when the revision was created. It is + also the create time when a new matcher is added. + type: string + roleMatch: + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT type: string description: >- - Optional. An opaque, user-specified string representing a human - agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided via the - `metadata_bucket_uri`. - type: object - description: Configuration that applies to all conversations. - GoogleCloudContactcenterinsightsV1alpha1HoldData: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1HoldData - properties: {} - description: The data for a hold annotation. - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion: - properties: - applicableInstructions: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction - description: Optional. Instructions applicable based on the current context. - type: array - suggestionEval: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval - description: Self evaluation of the suggestion. - agentActionSuggestions: - description: Optional. Suggested actions for the agent to take. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion - sampleResponses: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse - description: Optional. Sample response for the Agent. - type: array - suggestionReasoning: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - description: Reasoning for the suggestion. - id: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion - description: Suggestion for coaching agents. - type: object - GoogleCloudContactcenterinsightsV1alpha1InterruptionData: - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData - type: object - description: The data for an interruption annotation. - GoogleCloudContactcenterinsightsV1ConversationTranscript: - id: GoogleCloudContactcenterinsightsV1ConversationTranscript - properties: - transcriptSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment - type: array + The role whose utterances the phrase matcher should be matched + against. If the role is ROLE_UNSPECIFIED it will be matched against + any utterances in the transcript. + updateTime: description: >- - A list of sequential transcript segments that comprise the - conversation. - description: A message representing the transcript of a conversation. - type: object - GoogleCloudContactcenterinsightsV1ListConversationsResponse: - type: object - properties: - conversations: - description: The conversations that match the request. + Output only. The most recent time at which the phrase matcher was + updated. + type: string + readOnly: true + format: google-datetime + phraseMatchRuleGroups: + type: array + description: A list of phase match rule groups that are included in this matcher. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation - type: array - nextPageToken: + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + revisionId: + readOnly: true description: >- - A token which can be sent as `page_token` to retrieve the next page. - If this field is set, it means there is another page available. If - it is not set, it means no other pages are available. + Output only. Immutable. The revision ID of the phrase matcher. A new + revision is committed whenever the matcher is changed, except when + it is activated or deactivated. A server generated random ID will be + used. Example: + locations/global/phraseMatchers/my-first-matcher@1234567 type: string - id: GoogleCloudContactcenterinsightsV1ListConversationsResponse - description: The response of listing conversations. - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource: - properties: - document: - description: >- - Indicates which Knowledge Document this answer was extracted from. - Format: `projects//knowledgeBases//documents/`. + active: + type: boolean + description: Applies the phrase matcher only when it is active. + type: type: string - question: + description: Required. The type of this phrase matcher. + enum: + - PHRASE_MATCHER_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + enumDescriptions: + - Unspecified. + - Must meet all phrase match rule groups or there is no match. + - If any of the phrase match rule groups are met, there is a match. + versionTag: + description: >- + The customized version tag to use for the phrase matcher. If not + specified, it will default to `revision_id`. type: string - description: The corresponding FAQ question. - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Details about source of FAQ answer. + description: The phrase matcher resource. type: object - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion: + GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: + description: Conversation metadata related to quality management. type: object - id: >- - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion - description: >- - Actions suggested for the agent. This is based on applicable - instructions. properties: - agentAction: + waitDuration: + format: google-duration + description: The amount of time the customer waited to connect with an agent. type: string - description: Optional. The suggested action for the agent. - GoogleCloudContactcenterinsightsV1alpha1SilenceData: - description: The data for a silence annotation. - properties: {} - type: object - id: GoogleCloudContactcenterinsightsV1alpha1SilenceData - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: - description: Request to export an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + agentInfo: + description: Information about agents involved in the call. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + menuPath: + type: string + description: >- + An arbitrary string value specifying the menu path the customer + took. + customerSatisfactionRating: + type: integer + format: int32 + description: >- + An arbitrary integer value indicating the customer's satisfaction + rating. + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + GoogleCloudContactcenterinsightsV1PhraseMatchRule: type: object + description: The data for a phrase match rule. + id: GoogleCloudContactcenterinsightsV1PhraseMatchRule properties: - name: - description: Required. The issue model to export + query: type: string - gcsDestination: - description: Google Cloud Storage URI to export the Issue Model to. + description: Required. The phrase to be matched. + negated: + description: >- + Specifies whether the phrase must be missing from the transcript + segment or present in the transcript segment. + type: boolean + config: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig + description: >- + Provides additional information about the rule that specifies how to + apply the rule. + GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + type: object + description: A message representing a rule in the phrase matcher. properties: - request: - description: The original request for undeployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - endTime: + type: + description: Required. The type of this phrase match rule group. type: string - readOnly: true - description: Output only. The time the operation finished running. + enum: + - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED + - ALL_OF + - ANY_OF + enumDescriptions: + - Unspecified. + - Must meet all phrase match rules or there is no match. + - If any of the phrase match rules are met, there is a match. + phraseMatchRules: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule + type: array + description: A list of phrase match rules that are included in this group. + GoogleCloudContactcenterinsightsV1Analysis: + type: object + properties: + requestTime: + description: Output only. The time at which the analysis was requested. format: google-datetime - createTime: - description: Output only. The time the operation was created. + type: string + readOnly: true + name: + type: string + description: >- + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} + analysisResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult + description: >- + Output only. The result of the analysis, which is populated when the + analysis finishes. readOnly: true + createTime: + description: >- + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. type: string + readOnly: true format: google-datetime - description: Metadata for undeploying an issue model. - type: object - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + description: The analysis resource. + id: GoogleCloudContactcenterinsightsV1Analysis GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest: - description: The request to undeploy an issue model. id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest type: object properties: name: type: string description: Required. The issue model to undeploy. - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: + description: The request to undeploy an issue model. + GoogleCloudContactcenterinsightsV1ArticleSuggestionData: + id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData properties: - parent: - description: Required. The parent resource of the issue model. + source: type: string - issueModel: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel - description: Required. The issue model to create. - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - description: The request to create an issue model. - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - type: object - description: Conversation summarization suggestion data. - properties: - textSections: description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. - additionalProperties: - type: string - type: object - text: - type: string - description: The summarization content that is concatenated into one string. - answerRecord: + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + confidenceScore: + format: float + description: >- + The system's confidence score that this article is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + type: number + queryRecord: type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - confidence: - format: float - description: The confidence score of the summarization. - type: number - conversationModel: - description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} + title: type: string + description: Article title. metadata: type: object - description: >- - A map that contains metadata about the summarization and the - document from which it originates. additionalProperties: type: string - GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource: - id: >- - GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource - description: The sources of the answers. - properties: - snippet: - description: The relevant snippet of the article. - type: string - title: - type: string - description: The title of the article. - document: description: >- - The document from which the snippet was extracted. Format: - `projects//knowledgeBases//documents/` - type: string + Map that contains metadata about the Article Suggestion and the + document that it originates from. uri: + description: Article URI. type: string - description: The URI of the article. type: object - GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: + description: Agent Assist Article Suggestion data. + GoogleCloudContactcenterinsightsV1AnnotationBoundary: + type: object + id: GoogleCloudContactcenterinsightsV1AnnotationBoundary properties: - name: - description: Required. The issue model to deploy. - type: string - description: The request to deploy an issue model. + wordIndex: + format: int32 + type: integer + description: >- + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + transcriptIndex: + type: integer + description: >- + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. + format: int32 + description: >- + A point in a conversation that marks the start or the end of an + annotation. + GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: + description: Response of querying an issue model's statistics. type: object - id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse properties: - filter: - description: Filter used to select the subset of conversations to delete. - type: string - parent: + currentStats: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} + The latest label statistics for the queried issue model. Includes + results on both training data and data labeled after deployment. + GoogleCloudContactcenterinsightsV1SpeechConfig: + id: GoogleCloudContactcenterinsightsV1SpeechConfig + description: >- + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. + type: object + properties: + speechRecognizer: type: string - maxDeleteCount: - description: Maximum number of conversations to delete. - format: int32 - type: integer - force: - type: boolean description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + GoogleCloudContactcenterinsightsV1ConversationTranscript: + properties: + transcriptSegments: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment + description: >- + A list of sequential transcript segments that comprise the + conversation. + type: array + description: A message representing the transcript of a conversation. type: object - description: The request to delete conversations in bulk. + id: GoogleCloudContactcenterinsightsV1ConversationTranscript GoogleCloudContactcenterinsightsV1DialogflowSource: - type: object - description: A Dialogflow source of conversation data. properties: audioUri: description: >- @@ -384,4537 +390,4146 @@ components: conversation audio. type: string dialogflowConversation: + readOnly: true type: string description: >- Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation} - readOnly: true id: GoogleCloudContactcenterinsightsV1DialogflowSource - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - description: Statistics for IngestConversations operation. type: object - properties: - duplicatesSkippedCount: - readOnly: true - format: int32 - description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - type: integer - successfulIngestCount: - readOnly: true + description: A Dialogflow source of conversation data. + GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse + properties: {} + description: The response to deploy an issue model. + type: object + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: + description: Google Cloud Storage Object URI to get the issue model file from. + properties: + objectUri: + type: string + description: 'Required. Format: `gs:///`' + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + type: object + GoogleCloudContactcenterinsightsV1RedactionConfig: + type: object + properties: + inspectTemplate: description: >- - Output only. The number of new conversations added during this - ingest operation. - type: integer - format: int32 - failedIngestCount: - format: int32 - readOnly: true - type: integer + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` + type: string + deidentifyTemplate: + type: string description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - processedObjectCount: - readOnly: true - type: integer - format: int32 + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` + description: >- + DLP resources used for redaction while ingesting conversations. DLP + settings are applied to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversation coming from CCAI Platform. They are not applied to + conversations ingested from the `CreateConversation` endpoint or the + Dialogflow / Agent Assist runtime integrations. When using Dialogflow / + Agent Assist runtime integrations, redaction should be performed in + Dialogflow / Agent Assist. + id: GoogleCloudContactcenterinsightsV1RedactionConfig + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: + description: Metadata from Dialogflow relating to the current transcript segment. + type: object + id: >- + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + properties: + smartReplyAllowlistCovered: + type: boolean description: >- - Output only. The number of objects processed during the ingest - operation. - GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + GoogleCloudContactcenterinsightsV1IntentMatchData: type: object + id: GoogleCloudContactcenterinsightsV1IntentMatchData + description: >- + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. properties: - createTime: - format: google-datetime - description: Output only. The time the operation was created. + intentUniqueId: + description: >- + The id of the matched intent. Can be used to retrieve the + corresponding intent information. type: string - readOnly: true - ingestConversationsStats: - description: Output only. Statistics for IngestConversations operation. - readOnly: true + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: + properties: + unclassifiedConversationsCount: + type: string + format: int64 + description: >- + Number of analyzed conversations for which no issue was applicable + at this point in time. + issueStats: + type: object + description: Statistics on each issue. Key is the issue's resource name. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + analyzedConversationsCount: + format: int64 + description: >- + Number of conversations the issue model has analyzed at this point + in time. + type: string + type: object + description: Aggregated statistics about an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse + description: Response from import issue model + properties: {} + type: object + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest: + type: object + properties: + conversationConfig: + description: Configuration that applies to all conversations. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - endTime: - format: google-datetime - readOnly: true - description: Output only. The time the operation finished running. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig + redactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. + transcriptObjectConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for when `source` contains conversation transcripts. + parent: type: string - request: - description: Output only. The original request for ingest. - readOnly: true + description: Required. The parent resource for new conversations. + speechConfig: + description: >- + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest - partialErrors: - type: array + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + gcsSource: description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata - description: The metadata for an IngestConversations operation. - GoogleCloudContactcenterinsightsV1Conversation: - description: The conversation resource. - type: object + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + sampleSize: + description: >- + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. + format: int32 + type: integer + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + description: The request to ingest conversations. + GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + description: The request to create an issue model. properties: - startTime: - description: The time at which the conversation started. + issueModel: + description: Required. The issue model to create. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + parent: + description: Required. The parent resource of the issue model. type: string - format: google-datetime + type: object + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: + type: object + properties: createTime: - description: Output only. The time at which the conversation was created. format: google-datetime - readOnly: true - type: string - duration: - readOnly: true - type: string - description: Output only. The duration of the conversation. - format: google-duration - qualityMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - description: Conversation metadata related to quality management. - obfuscatedUserId: - description: Obfuscated user ID which the customer sent to us. + description: The time the operation was created. type: string - transcript: - readOnly: true - description: Output only. The conversation transcript. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript - latestSummary: - description: Output only. Latest summary of the conversation. + request: + description: The original request for bulk delete. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - readOnly: true - medium: - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + partialErrors: + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. + Partial errors during bulk delete conversations operation that might + cause the operation output to be incomplete. + endTime: type: string - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - turnCount: - description: Output only. The number of turns in the conversation. - type: integer - format: int32 - readOnly: true - updateTime: + description: The time the operation finished running. + format: google-datetime + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata + description: The metadata for a bulk delete conversations operation. + GoogleCloudContactcenterinsightsV1alpha1Analysis: + description: The analysis resource. + id: GoogleCloudContactcenterinsightsV1alpha1Analysis + type: object + properties: + analysisResult: readOnly: true description: >- - Output only. The most recent time at which the conversation was - updated. - type: string + Output only. The result of the analysis, which is populated when the + analysis finishes. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + createTime: + readOnly: true format: google-datetime - agentId: type: string description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. + Output only. The time at which the analysis was created, which + occurs when the long-running operation completes. name: type: string description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} - dataSource: - description: The source of the audio and transcription for the conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource - ttl: - description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. - type: string - format: google-duration - latestAnalysis: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - description: Output only. The conversation's latest analysis, if one exists. - readOnly: true - dialogflowIntents: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent + Immutable. The resource name of the analysis. Format: + projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} + requestTime: + format: google-datetime readOnly: true + description: Output only. The time at which the analysis was requested. + type: string + annotatorSelector: description: >- - Output only. All the matched Dialogflow intents in the call. The key - corresponds to a Dialogflow intent, format: - projects/{project}/agent/{agent}/intents/{intent} - type: object - runtimeAnnotations: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + GoogleCloudContactcenterinsightsV1EncryptionSpec: + id: GoogleCloudContactcenterinsightsV1EncryptionSpec + type: object + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + properties: + kmsKey: + type: string description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - type: array - readOnly: true - languageCode: - description: A user-specified language code for the conversation. + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + name: type: string - callMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata - description: Call-specific metadata. - labels: description: >- - A map for the user to specify any custom fields. A maximum of 20 - labels per conversation is allowed, with a maximum of 256 characters - per entry. - type: object - additionalProperties: - type: string - expireTime: + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: + description: Configuration for summarization. + type: object + id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + properties: + summarizationModel: + enumDescriptions: + - Unspecified summarization model. + - The CCAI baseline model. + - The CCAI baseline model, V2.0. + type: string + description: Default summarization model to be used. + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + conversationProfile: type: string - format: google-datetime description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. - id: GoogleCloudContactcenterinsightsV1Conversation - GoogleCloudContactcenterinsightsV1IntentMatchData: - id: GoogleCloudContactcenterinsightsV1IntentMatchData + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + description: A BigQuery Table Reference. properties: - intentUniqueId: + projectId: + type: string description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. + table: type: string - description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. - type: object - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: - properties: - segmentParticipant: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant - description: The participant of this segment. - words: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo - type: array description: >- - A list of the word-specific information for each word in the - segment. - text: + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. + dataset: type: string - description: The text of this segment. - languageCode: + description: >- + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. + type: object + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse + properties: {} + description: Response from export issue model + type: object + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + properties: + startOffset: type: string + format: google-duration description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". + Time offset of the start of this word relative to the beginning of + the total conversation. confidence: type: number description: >- A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. + word. A default value of 0.0 indicates that the value is unset. format: float - dialogflowSegmentMetadata: - description: CCAI metadata relating to the current transcript segment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - sentiment: - description: The sentiment for this transcript segment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - messageTime: - description: The time that the message occurred, if provided. - format: google-datetime + endOffset: + format: google-duration type: string - channelTag: description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. - format: int32 - type: integer - type: object - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment - description: A segment of a full transcript. - GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: - type: object - id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + Time offset of the end of this word relative to the beginning of the + total conversation. + word: + description: The word itself. Includes punctuation marks that surround the word. + type: string + description: Word-level info for words in a transcript. + GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: properties: - trainingConversationsCount: + endTime: readOnly: true - description: Output only. Number of conversations used in training. Output only. type: string - format: int64 - medium: - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. + description: Output only. The time the operation finished running. + format: google-datetime + annotatorSelector: + readOnly: true + description: Output only. The annotator selector used for the analysis (if any). + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + conversation: + readOnly: true description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT + Output only. The Conversation that this Analysis Operation belongs + to. type: string - deprecated: true - filter: + createTime: + readOnly: true + format: google-datetime + description: Output only. The time the operation was created. type: string - description: >- - A filter to reduce the conversations used for training the model to - a specific subset. - description: Configs for the input data used to create the issue model. - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval: + id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata type: object - description: Self evaluations of the suggestion. + description: Metadata for a create analysis operation. + GoogleCloudContactcenterinsightsV1DialogflowInteractionData: + description: Dialogflow interaction data. + id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData properties: - actionActionSuggestionEval: - type: string - description: Optional. Eval for Agent action suggestion. - sampleResponseEval: + confidence: + description: >- + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + format: float + type: number + dialogflowIntentId: type: string - description: Optional. Eval for sample response. - id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionEval - GoogleCloudContactcenterinsightsV1ExactMatchConfig: + description: >- + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} type: object - description: Exact match configuration. - id: GoogleCloudContactcenterinsightsV1ExactMatchConfig + GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: + description: The request to delete an issue model. properties: - caseSensitive: - description: Whether to consider case sensitivity when performing an exact match. - type: boolean - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata + name: + type: string + description: Required. The name of the issue model to delete. type: object - description: The metadata for an IngestConversations operation. + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest + GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: properties: - ingestConversationsStats: - description: Output only. Statistics for IngestConversations operation. + endTime: readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats - partialErrors: - type: array - description: >- - Output only. Partial errors during ingest operation that might cause - the operation output to be incomplete. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - endTime: description: Output only. The time the operation finished running. + type: string + format: google-datetime + createTime: + description: Output only. The time the operation was created. format: google-datetime readOnly: true type: string request: - description: Output only. The original request for ingest. - readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest - createTime: - type: string - readOnly: true - description: Output only. The time the operation was created. - format: google-datetime - GoogleCloudContactcenterinsightsV1FaqAnswerData: - id: GoogleCloudContactcenterinsightsV1FaqAnswerData + #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest + description: The original request for deletion. + description: Metadata for deleting an issue model. + type: object + id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata + GoogleCloudContactcenterinsightsV1ListIssuesResponse: type: object + description: The response of listing issues. properties: - source: - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - type: string - question: - description: The corresponding FAQ question. + issues: + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + type: array + description: The issues that match the request. + id: GoogleCloudContactcenterinsightsV1ListIssuesResponse + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest: + description: Request to export an issue model. + properties: + name: type: string - queryRecord: + description: Required. The issue model to export. + gcsDestination: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + description: Google Cloud Storage URI to export the issue model to. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: + properties: + filter: type: string + description: Filter used to select the subset of conversations to delete. + parent: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - confidenceScore: - format: float - type: number - description: >- - The system's confidence score that this answer is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - answer: - description: The piece of text from the `source` knowledge base document. + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} type: string - metadata: - additionalProperties: - type: string + maxDeleteCount: + format: int32 + description: Maximum number of conversations to delete. + type: integer + force: description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - type: object - description: Agent Assist frequently-asked-question answer data. - GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: - description: Metadata for a create analysis operation. + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. + type: boolean + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest type: object - id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata + description: The request to delete conversations in bulk. + GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse + type: object + description: The response to undeploy an issue model. + properties: {} + GoogleCloudContactcenterinsightsV1ListAnalysesResponse: + description: The response to list analyses. properties: - conversation: - type: string + nextPageToken: description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - readOnly: true - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: Output only. The annotator selector used for the analysis (if any). - readOnly: true - createTime: - type: string - description: Output only. The time the operation was created. - format: google-datetime - readOnly: true - endTime: + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: Output only. The time the operation finished running. - format: google-datetime - readOnly: true - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: + analyses: + type: array + description: The analyses that match the request. + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource - description: Configuration for Cloud Storage bucket sources. + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: + type: object + description: Call-specific metadata created during analysis. properties: - bucketUri: - type: string - description: Required. The Cloud Storage bucket containing source objects. - customMetadataKeys: - description: >- - Optional. Custom keys to extract as conversation labels from - metadata files in `metadata_bucket_uri`. Keys not included in this - field will be ignored. Note that there is a limit of 20 labels per - conversation. + annotations: type: array + description: A list of call annotations that apply to this call. items: - type: string - bucketObjectType: - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO - type: string - enumDescriptions: - - The object type is unspecified and will default to `TRANSCRIPT`. - - The object is a transcript. - - The object is an audio file. - description: Optional. Specifies the type of the objects in `bucket_uri`. - metadataBucketUri: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + phraseMatchers: + description: All the matched phrase matchers in the call. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + type: object + intents: + description: All the matched intents in the call. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent + type: object + sentiments: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + type: array + description: Overall conversation-level sentiment for each channel of the call. + entities: + description: All the entities in the call. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity + type: object + issueModelResult: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + description: Overall conversation-level issue modeling result. + silence: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + description: Overall conversation-level silence during the call. + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: + description: Conversation-level silence data. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence + properties: + silencePercentage: + format: float + type: number + description: Percentage of the total conversation spent in silence. + silenceDuration: type: string - description: >- - Optional. The Cloud Storage path to the source object metadata. Note - that: [1] metadata files are expected to be in JSON format [2] - metadata and source objects must be in separate buckets [3] a source - object's metadata object must share the same name to be properly - ingested - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: - description: A time series representing conversations over time. + description: Amount of time calculated to be in silence. + format: google-duration type: object - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: + description: Conversation metadata related to quality management. properties: - points: + menuPath: + type: string description: >- - An ordered list of intervals from earliest to latest, where each - interval represents the number of conversations that transpired - during the time window. + An arbitrary string value specifying the menu path the customer + took. + agentInfo: type: array + description: Information about agents involved in the call. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval - intervalDuration: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + customerSatisfactionRating: + type: integer + format: int32 + description: >- + An arbitrary integer value indicating the customer's satisfaction + rating. + waitDuration: format: google-duration type: string - description: The duration of each interval. - GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: + description: The amount of time the customer waited to connect with an agent. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + type: object + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata type: object + description: Metadata for an export insights operation. properties: - trainingConversationsCount: - readOnly: true - format: int64 - description: Output only. Number of conversations used in training. Output only. + endTime: type: string - filter: + description: Output only. The time the operation finished running. + readOnly: true + format: google-datetime + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - A filter to reduce the conversations used for training the model to - a specific subset. - type: string - medium: - deprecated: true - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT + Partial errors during export operation that might cause the + operation output to be incomplete. + createTime: type: string - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: >- - Medium of conversations used in training data. This field is being - deprecated. To specify the medium to be used in training a new issue - model, set the `medium` field on `filter`. - description: Configs for the input data used to create the issue model. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - GoogleCloudContactcenterinsightsV1GeneratorSuggestion: - description: Suggestion generated using a Generator. - type: object - properties: - summarySuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SummarySuggestion - description: Optional. Suggested summary. - agentCoachingSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion - description: Optional. Suggestion to coach the agent. - freeFormSuggestion: - description: Optional. Free form suggestion. + description: Output only. The time the operation was created. + format: google-datetime + readOnly: true + request: + description: The original request for export. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1FreeFormSuggestion - id: GoogleCloudContactcenterinsightsV1GeneratorSuggestion - GoogleCloudContactcenterinsightsV1SilenceData: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest + GoogleCloudContactcenterinsightsV1IngestConversationsResponse: type: object - id: GoogleCloudContactcenterinsightsV1SilenceData - description: The data for a silence annotation. + description: The response to an IngestConversations operation. properties: {} - GoogleCloudContactcenterinsightsV1CallAnnotation: - properties: - silenceData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' - description: Data specifying silence. - sentimentData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - description: Data specifying sentiment. - holdData: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' - description: Data specifying a hold. - intentMatchData: - description: Data specifying an intent match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData - channelTag: - description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. - type: integer - format: int32 - annotationStartBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - description: >- - The boundary in the conversation where the annotation starts, - inclusive. - issueMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData - description: Data specifying an issue match. - annotationEndBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - description: >- - The boundary in the conversation where the annotation ends, - inclusive. - interruptionData: - description: Data specifying an interruption. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData - phraseMatchData: - description: Data specifying a phrase match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - entityMentionData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData - description: Data specifying an entity mention. - description: A piece of metadata that applies to a window of a call. - id: GoogleCloudContactcenterinsightsV1CallAnnotation - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: + id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse + GoogleCloudContactcenterinsightsV1AnswerFeedback: + description: >- + The feedback that the customer has about a certain answer in the + conversation. properties: - bigQueryDestination: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - writeDisposition: - enumDescriptions: - - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - - >- - If the table already exists, BigQuery will overwrite the table - data and use the schema from the load. - - >- - If the table already exists, BigQuery will append data to the - table. + correctnessLevel: enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - type: string - description: Options for what to do if the destination table already exists. - filter: - description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. - type: string - parent: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT + enumDescriptions: + - Correctness level unspecified. + - Answer is totally wrong. + - Answer is partially correct. + - Answer is fully correct. type: string - description: Required. The parent resource to export data from. - kmsKey: + description: The correctness level of an answer. + clicked: + type: boolean + description: Indicates whether an answer or item was clicked by the human agent. + displayed: description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} - type: string - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest - description: The request to export insights. - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. + type: boolean + id: GoogleCloudContactcenterinsightsV1AnswerFeedback type: object + GoogleCloudContactcenterinsightsV1alpha1SilenceData: properties: {} - description: The response to undeploy an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse - GoogleCloudContactcenterinsightsV1DialogflowInteractionData: - id: GoogleCloudContactcenterinsightsV1DialogflowInteractionData - properties: - confidence: - type: number - description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). - format: float - dialogflowIntentId: - type: string - description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} - description: Dialogflow interaction data. type: object - GoogleCloudContactcenterinsightsV1alpha1Intent: - id: GoogleCloudContactcenterinsightsV1alpha1Intent + id: GoogleCloudContactcenterinsightsV1alpha1SilenceData + description: The data for a silence annotation. + GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata type: object - description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. properties: - displayName: - type: string - description: The human-readable name of the intent. - id: + request: + description: The original import request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + endTime: + format: google-datetime type: string - description: The unique identifier of the intent. - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: - properties: - name: - description: Required. The name of the issue model to delete. + description: The time the operation finished running. + createTime: type: string - description: The request to delete an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - type: object - GoogleCloudContactcenterinsightsV1ConversationDataSource: - id: GoogleCloudContactcenterinsightsV1ConversationDataSource + format: google-datetime + description: The time the operation was created. + description: Metadata used for import issue model. + GoogleCloudContactcenterinsightsV1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1FaqAnswerData + description: Agent Assist frequently-asked-question answer data. type: object properties: - gcsSource: - description: A Cloud Storage location specification for the audio and transcript. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' - dialogflowSource: - description: The source when the conversation comes from Dialogflow. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource - description: The conversation source, which is a combination of transcript and audio. - GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: - id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - properties: - reply: - description: The content of the reply. - type: string metadata: + description: >- + Map that contains metadata about the FAQ answer and the document + that it originates from. additionalProperties: type: string - description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. type: object queryRecord: + type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string confidenceScore: - format: double + type: number description: >- - The system's confidence score that this reply is a good match for + The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). - type: number - description: Agent Assist Smart Reply data. - type: object - GoogleCloudContactcenterinsightsV1alpha1Analysis: - properties: - analysisResult: - readOnly: true + format: float + answer: + type: string + description: The piece of text from the `source` knowledge base document. + source: + type: string description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResult - name: + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + question: + description: The corresponding FAQ question. type: string + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: + properties: + runInterruptionAnnotator: + description: Whether to run the interruption annotator. + type: boolean + issueModels: + type: array + items: + type: string description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - createTime: - format: google-datetime + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + runSummarizationAnnotator: + description: Whether to run the summarization annotator. + type: boolean + runPhraseMatcherAnnotator: + description: Whether to run the active phrase matcher annotator(s). + type: boolean + runIntentAnnotator: + type: boolean + description: Whether to run the intent annotator. + runIssueModelAnnotator: + type: boolean description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. - readOnly: true - type: string - requestTime: - type: string - description: Output only. The time at which the analysis was requested. - format: google-datetime - readOnly: true - id: GoogleCloudContactcenterinsightsV1alpha1Analysis - type: object - description: The analysis resource. - GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: - properties: - confidenceScore: - format: double + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + summarizationConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + description: Configuration for the summarization annotator. + phraseMatchers: description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). - type: number - suggestion: - description: The content of the suggestion. - type: string - metadata: - additionalProperties: + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + type: array + items: type: string - type: object - description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - queryRecord: - type: string - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: object - id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion: - id: GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion + runEntityAnnotator: + description: Whether to run the entity annotator. + type: boolean + runSentimentAnnotator: + description: Whether to run the sentiment annotator. + type: boolean + runSilenceAnnotator: + type: boolean + description: Whether to run the silence annotator. + description: Selector of all available annotators and phrase matchers to run. type: object - properties: - agentCoachingSuggestion: - description: Optional. Suggestion to coach the agent. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestion - freeFormSuggestion: - description: Optional. Free form suggestion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion - summarySuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion - description: Optional. Suggested summary. - description: Suggestion generated using a Generator. + id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata description: The metadata for a bulk delete conversations operation. properties: - createTime: + endTime: format: google-datetime + type: string + description: The time the operation finished running. + createTime: type: string description: The time the operation was created. + format: google-datetime + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + description: The original request for bulk delete. partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- Partial errors during bulk delete conversations operation that might cause the operation output to be incomplete. - items: - $ref: '#/components/schemas/GoogleRpcStatus' type: array - request: + type: object + GoogleCloudContactcenterinsightsV1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1IssueMatchData + description: The data for an issue match annotation. + properties: + issueAssignment: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest - description: The original request for bulk delete. - endTime: - type: string - format: google-datetime - description: The time the operation finished running. + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + description: Information about the issue's assignment. + type: object + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: + type: object + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse + description: The response to deploy an issue model. + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: + description: A segment of a full transcript. type: object - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsMetadata - GoogleCloudContactcenterinsightsV1Analysis: - description: The analysis resource. properties: - annotatorSelector: + dialogflowSegmentMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - requestTime: - description: Output only. The time at which the analysis was requested. - readOnly: true + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + description: CCAI metadata relating to the current transcript segment. + text: + description: The text of this segment. type: string - format: google-datetime - analysisResult: - readOnly: true + sentiment: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResult - description: >- - Output only. The result of the analysis, which is populated when the - analysis finishes. - createTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: The sentiment for this transcript segment. + words: description: >- - Output only. The time at which the analysis was created, which - occurs when the long-running operation completes. + A list of the word-specific information for each word in the + segment. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + messageTime: + description: The time that the message occurred, if provided. + type: string format: google-datetime + languageCode: type: string - readOnly: true - name: description: >- - Immutable. The resource name of the analysis. Format: - projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - type: string - id: GoogleCloudContactcenterinsightsV1Analysis - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: - properties: - customerChannel: - type: integer - description: The audio channel that contains the customer. - format: int32 - agentChannel: - description: The audio channel that contains the agent. + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". + segmentParticipant: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant + description: The participant of this segment. + confidence: + format: float + type: number + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + channelTag: type: integer + description: >- + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. format: int32 - id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - description: Call-specific metadata. - type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: - description: Aggregated statistics about an issue. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment + GoogleCloudContactcenterinsightsV1IssueAssignment: + description: Information about the issue. + id: GoogleCloudContactcenterinsightsV1IssueAssignment properties: - labeledConversationsCount: - format: int64 - description: Number of conversations attached to the issue at this point in time. + displayName: type: string - issue: description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - type: string - displayName: - description: Display name of the issue. + Immutable. Display name of the assigned issue. This field is set at + time of analyis and immutable since then. + score: + format: double + description: >- + Score indicating the likelihood of the issue assignment. currently + bounded on [0,1]. + type: number + issue: + description: Resource name of the assigned issue. type: string - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsMetadata type: object - description: The metadata for a bulk delete conversations operation. + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: + type: object + description: The request to analyze conversations in bulk. + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest properties: - endTime: - type: string - format: google-datetime - description: The time the operation finished running. - createTime: - format: google-datetime - description: The time the operation was created. - type: string - partialErrors: + annotatorSelector: description: >- - Partial errors during bulk delete conversations operation that might - cause the operation output to be incomplete. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - request: - description: The original request for bulk delete. + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet: - properties: - document: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + analysisPercentage: + type: number + format: float + description: >- + Required. Percentage of selected conversation to analyze, between + [0, 100]. + parent: + description: Required. The parent resource to create analyses in. type: string + filter: description: >- - Indicates which Knowledge Document this snippet was extracted from. - Format: `projects//knowledgeBases//documents/`. - text: + Required. Filter used to select the subset of conversations to + analyze. type: string - description: text taken from that URI. - title: + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: + type: object + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata + description: Metadata for creating an issue model. + properties: + request: + description: The original request for creation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + createTime: + description: Output only. The time the operation was created. + readOnly: true + format: google-datetime type: string - description: Title of the document. - uri: + endTime: + readOnly: true + description: Output only. The time the operation finished running. type: string - description: URI the data is sourced from. + format: google-datetime + GoogleCloudContactcenterinsightsV1IssueModelResult: type: object - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet - description: Snippet Source for a Generative Prediction. - GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: + description: Issue Modeling result on a conversation. + id: GoogleCloudContactcenterinsightsV1IssueModelResult properties: - dialogflowParticipant: + issueModel: type: string description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - deprecated: true - obfuscatedExternalUserId: - description: Obfuscated user ID from Dialogflow. - type: string - dialogflowParticipantName: - type: string + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + issues: + description: All the matched issues. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment + GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: + description: A piece of metadata that applies to a window of a call. + properties: + annotationStartBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - role: - type: string - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - description: The role of the participant. - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - userId: - type: string - description: A user-specified ID representing the participant. - description: The call participant speaking for a given utterance. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - type: object - GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: + The boundary in the conversation where the annotation starts, + inclusive. + intentMatchData: + description: Data specifying an intent match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData + issueMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + description: Data specifying an issue match. + holdData: + description: Data specifying a hold. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData + sentimentData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Data specifying sentiment. + annotationEndBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + entityMentionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData + description: Data specifying an entity mention. + interruptionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData + description: Data specifying an interruption. + silenceData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData + description: Data specifying silence. + phraseMatchData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + description: Data specifying a phrase match. + channelTag: + description: >- + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. + format: int32 + type: integer type: object + id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation + GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: properties: - confidenceScore: - type: number - description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: float - title: - description: Article title. - type: string - uri: + objectUri: + description: 'Required. Format: `gs:///`' type: string - description: Article URI. + type: object + description: Google Cloud Storage Object URI to get the issue model file from. + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: + id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + description: Agent Assist frequently-asked-question answer data. + properties: metadata: description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. + Map that contains metadata about the FAQ answer and the document + that it originates from. + type: object additionalProperties: type: string - type: object - queryRecord: + answer: + description: The piece of text from the `source` knowledge base document. + type: string + question: + description: The corresponding FAQ question. type: string + queryRecord: description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - source: type: string + source: description: >- The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} - description: Agent Assist Article Suggestion data. - id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData - GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig - type: object - properties: - exactMatchConfig: - description: The configuration for the exact match rule. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig - description: Configuration information of a phrase match rule. - GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup: - description: A message representing a rule in the phrase matcher. + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. + type: string + confidenceScore: + format: float + type: number + description: >- + The system's confidence score that this answer is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). type: object - id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup + GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig: properties: - phraseMatchRules: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRule - type: array - description: A list of phrase match rules that are included in this group. - type: - description: Required. The type of this phrase match rule group. - enumDescriptions: - - Unspecified. - - Must meet all phrase match rules or there is no match. - - If any of the phrase match rules are met, there is a match. - type: string + medium: enum: - - PHRASE_MATCH_RULE_GROUP_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse: - description: >- - Response for Knowledge Assist. Contains suggested query and optionally - includes an answer for the query. - id: GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse - properties: - suggestedQueryAnswer: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. description: >- - The answer generated for the suggested query. Whether or not an - answer is generated depends on how confident we are about the - generated query. - suggestedQuery: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. + deprecated: true + type: string + trainingConversationsCount: + format: int64 + type: string + readOnly: true + description: Output only. Number of conversations used in training. Output only. + filter: description: >- - The query suggested based on the context. Suggestion is made only if - it is different from the previous suggestion. + A filter to reduce the conversations used for training the model to + a specific subset. + type: string + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + description: Configs for the input data used to create the issue model. type: object - GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: + GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: + id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo + type: object + description: Information about an agent involved in the conversation. properties: - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest - description: The original export request. - createTime: + displayName: type: string - description: The time the operation was created. - format: google-datetime - endTime: - format: google-datetime - description: The time the operation finished running. + description: The agent's name. + agentId: type: string - id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata - description: Metadata used for export issue model. - type: object - GoogleCloudContactcenterinsightsV1View: - id: GoogleCloudContactcenterinsightsV1View - description: The View resource. + description: A user-specified string representing the agent. + team: + type: string + description: A user-specified string representing the agent's team. + dispositionCode: + description: >- + A user-provided string indicating the outcome of the agent's segment + of the call. + type: string + GoogleCloudContactcenterinsightsV1Settings: type: object + description: >- + The CCAI Insights project wide settings. Use these settings to configure + the behavior of Insights. View these settings with + [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) + and change the settings with + [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings). + id: GoogleCloudContactcenterinsightsV1Settings properties: - displayName: - description: The human-readable display name of the view. - type: string - name: + analysisConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + description: Default analysis settings. + conversationTtl: + description: >- + The default TTL for newly-created conversations. If a conversation + has a specified expiration, that value will be used instead. + Changing this value will not change the expiration of existing + conversations. Conversations with no expire time persist until they + are deleted. type: string + format: google-duration + redactionConfig: description: >- - Immutable. The resource name of the view. Format: - projects/{project}/locations/{location}/views/{view} + Default DLP redaction resources to be applied while ingesting + conversations. This applies to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversations coming from CCAI Platform. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig updateTime: - readOnly: true format: google-datetime - description: Output only. The most recent time at which the view was updated. type: string - createTime: - description: Output only. The time at which this view was created. readOnly: true - type: string - format: google-datetime - value: - type: string - description: String with specific view properties, must be non-empty. - GoogleCloudContactcenterinsightsV1AnnotatorSelector: - type: object - id: GoogleCloudContactcenterinsightsV1AnnotatorSelector - properties: - runEntityAnnotator: - type: boolean - description: Whether to run the entity annotator. - runSummarizationAnnotator: - type: boolean - description: Whether to run the summarization annotator. - runSentimentAnnotator: - description: Whether to run the sentiment annotator. - type: boolean - runPhraseMatcherAnnotator: - type: boolean - description: Whether to run the active phrase matcher annotator(s). - phraseMatchers: + description: Output only. The time at which the settings were last updated. + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - items: - type: string - type: array - runSilenceAnnotator: - description: Whether to run the silence annotator. - type: boolean - issueModels: - items: + Optional. Default Speech-to-Text resources to use while ingesting + audio files. Optional, CCAI Insights will create a default if not + provided. This applies to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversations coming from CCAI Platform. + pubsubNotificationSettings: + additionalProperties: type: string + type: object description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - type: array - runInterruptionAnnotator: - description: Whether to run the interruption annotator. - type: boolean - runIntentAnnotator: - description: Whether to run the intent annotator. - type: boolean - runIssueModelAnnotator: - type: boolean + A map that maps a notification trigger to a Pub/Sub topic. Each time + a specified trigger occurs, Insights will notify the corresponding + Pub/Sub topic. Keys are notification triggers. Supported keys are: * + "all-triggers": Notify each time any of the supported triggers + occurs. * "create-analysis": Notify each time an analysis is + created. * "create-conversation": Notify each time a conversation is + created. * "export-insights-data": Notify each time an export is + complete. * "ingest-conversations": Notify each time an + IngestConversations LRO is complete. * "update-conversation": Notify + each time a conversation is updated via UpdateConversation. * + "upload-conversation": Notify when an UploadConversation LRO is + complete. Values are Pub/Sub topics. The format of each Pub/Sub + topic is: projects/{project}/topics/{topic} + languageCode: description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - summarizationConfig: - description: Configuration for the summarization annotator. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig - description: Selector of all available annotators and phrase matchers to run. - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction: - description: Agent Coaching instructions that customer can configure. - properties: - description: - description: Optional. The detailed description of this instruction. - type: string - displayName: - description: Optional. Display name for the instruction. + A language code to be applied to each transcript segment unless the + segment already specifies a language code. Language code defaults to + "en-US" if it is neither specified on the segment nor here. type: string - condition: + createTime: type: string + format: google-datetime + description: Output only. The time at which the settings was created. + readOnly: true + name: description: >- - Optional. The condition of the instruction. For example, "the - customer wants to cancel an order". If the users want the - instruction to be triggered unconditionally, the condition can be - empty. - metadata: - type: object - additionalProperties: - type: string - description: Optional. Additional information attached to this instruction. - agentAction: - description: >- - Optional. The action that human agent should take. For example, - "apologize for the slow shipping". If the users only want to use - agent coaching for intent detection, agent_action can be empty + Immutable. The resource name of the settings resource. Format: + projects/{project}/locations/{location}/settings type: string - systemAction: + GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. + type: object + properties: + displayName: + description: The human-readable name of the intent. type: string - description: >- - Optional. The action that system should take. For example, "call - GetOrderTime with order_number={order number provided by the - customer}". If the users don't have plugins or don't want to trigger - plugins, the system_action can be empty + GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: + description: Response for an export insights operation. + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse + properties: {} type: object - id: GoogleCloudContactcenterinsightsV1alpha1AgentCoachingInstruction - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer: - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswer + GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig: + id: GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig type: object - description: >- - Represents an answer from Knowledge. Cuurently supports FAQ and - Generative answers. + description: Configuration information of a phrase match rule. properties: - intentMatchingSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource - description: Populated if the prediction was from intent matching. - answerText: - description: >- - The piece of text from the `source` that answers this suggested - query. - type: string - matchConfidence: - type: number - description: >- - The system's confidence score that this answer is a good match for - this conversational query. The range is from 0.0 (completely - uncertain) to 1.0 (completely certain). - format: float - faqSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Populated if the prediction came from FAQ. - generativeSource: - description: Populated if the prediction was Generative. + exactMatchConfig: + description: The configuration for the exact match rule. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: - description: Metadata for deploying an issue model. - id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata + #/components/schemas/GoogleCloudContactcenterinsightsV1ExactMatchConfig + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: type: object + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata properties: endTime: - readOnly: true + format: google-datetime type: string + readOnly: true description: Output only. The time the operation finished running. - format: google-datetime createTime: - type: string format: google-datetime - description: Output only. The time the operation was created. + type: string readOnly: true + description: Output only. The time the operation was created. request: + description: The original request for deletion. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest - description: The original request for deployment. - GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: - description: The request to undeploy an issue model. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest + description: Metadata for deleting an issue model. + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: + description: >- + An annotation that was generated during the customer and agent + interaction. properties: - name: + endBoundary: + description: >- + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + faqAnswer: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData + description: Agent Assist FAQ answer data. + articleSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + userInput: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + annotationId: type: string - description: Required. The issue model to undeploy. - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - description: The conversation source, which is a combination of transcript and audio. - properties: - gcsSource: + description: >- + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + answerFeedback: + description: The feedback that the customer has about the answer in `data`. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource - description: A Cloud Storage location specification for the audio and transcript. - dialogflowSource: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + startBoundary: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource - description: The source when the conversation comes from Dialogflow. - type: object - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo: - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo - description: Word-level info for words in a transcript. - properties: - endOffset: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. + The boundary in the conversation where the annotation starts, + inclusive. + createTime: type: string - format: google-duration - startOffset: - format: google-duration - type: string - description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - confidence: - format: float - description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. - type: number - word: - description: The word itself. Includes punctuation marks that surround the word. - type: string - type: object - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse: + description: The time at which this annotation was created. + format: google-datetime + conversationSummarizationSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Conversation summarization suggestion data. + dialogflowInteraction: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + description: Dialogflow interaction data. + smartComposeSuggestion: + description: Agent Assist Smart Compose suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + smartReply: + description: Agent Assist Smart Reply data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelResponse - description: The response to deploy an issue model. - GoogleCloudContactcenterinsightsV1IssueAssignment: - id: GoogleCloudContactcenterinsightsV1IssueAssignment + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + GoogleCloudContactcenterinsightsV1Issue: type: object - description: Information about the issue. + description: The issue resource. properties: - displayName: - description: >- - Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. - type: string - issue: - description: Resource name of the assigned issue. + updateTime: + readOnly: true type: string - score: - format: double - description: >- - Score indicating the likelihood of the issue assignment. currently - bounded on [0,1]. - type: number - GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: - description: Issue Modeling result on a conversation. - properties: - issueModel: - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} + format: google-datetime + description: Output only. The most recent time that this issue was updated. + createTime: + readOnly: true + description: Output only. The time at which this issue was created. type: string - issues: - type: array - description: All the matched issues. + format: google-datetime + sampleUtterances: items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - GoogleCloudContactcenterinsightsV1IngestConversationsResponse: - properties: {} - description: The response to an IngestConversations operation. - type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsResponse - GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: - type: object - id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - properties: - metadata: - type: object - additionalProperties: type: string + type: array description: >- - Map that contains metadata about the Smart Compose suggestion and - the document from which it originates. - queryRecord: + Output only. Resource names of the sample representative utterances + that match to this issue. + readOnly: true + displayDescription: + type: string + description: Representative description of the issue. + name: + type: string description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} + Immutable. The resource name of the issue. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + displayName: + description: The representative name for the issue. type: string - suggestion: - description: The content of the suggestion. + id: GoogleCloudContactcenterinsightsV1Issue + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: + properties: + parent: type: string - confidenceScore: + description: Required. The parent resource to create analyses in. + analysisPercentage: description: >- - The system's confidence score that this suggestion is a good match - for this conversation, ranging from 0.0 (completely uncertain) to - 1.0 (completely certain). - format: double + Required. Percentage of selected conversation to analyze, between + [0, 100]. type: number - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: - properties: - conversationProfile: + format: float + annotatorSelector: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - type: string - summarizationModel: + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + filter: + description: >- + Required. Filter used to select the subset of conversations to + analyze. type: string - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - description: Default summarization model to be used. - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - description: Configuration for summarization. - GoogleCloudContactcenterinsightsV1PhraseMatchData: + description: The request to analyze conversations in bulk. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource: properties: - displayName: + metadataBucketUri: type: string - description: The human-readable name of the phrase matcher. - phraseMatcher: + description: >- + Optional. The Cloud Storage path to the conversation metadata. Note + that: [1] Metadata files are expected to be in JSON format. [2] + Metadata and source files (transcripts or audio) must be in separate + buckets. [3] A source file and its corresponding metadata file must + share the same name to be properly ingested, E.g. + `gs://bucket/audio/conversation1.mp3` and + `gs://bucket/metadata/conversation1.json`. + customMetadataKeys: + description: >- + Optional. Custom keys to extract as conversation labels from + metadata files in `metadata_bucket_uri`. Keys not included in this + field will be ignored. Note that there is a limit of 20 labels per + conversation. + items: + type: string + type: array + bucketObjectType: type: string - description: The unique identifier (the resource name) of the phrase matcher. - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. - id: GoogleCloudContactcenterinsightsV1PhraseMatchData + description: Optional. Specifies the type of the objects in `bucket_uri`. + enumDescriptions: + - The object type is unspecified and will default to `TRANSCRIPT`. + - The object is a transcript. + - The object is an audio file. + enum: + - BUCKET_OBJECT_TYPE_UNSPECIFIED + - TRANSCRIPT + - AUDIO + bucketUri: + type: string + description: Required. The Cloud Storage bucket containing source objects. + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestGcsSource + description: Configuration for Cloud Storage bucket sources. type: object - GoogleCloudContactcenterinsightsV1alpha1Entity: + GoogleCloudContactcenterinsightsV1Conversation: + id: GoogleCloudContactcenterinsightsV1Conversation + description: The conversation resource. type: object - id: GoogleCloudContactcenterinsightsV1alpha1Entity properties: - sentiment: - description: >- - The aggregate sentiment expressed for this entity in the - conversation. + transcript: + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - metadata: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscript + description: Output only. The conversation transcript. + latestSummary: + description: Output only. Latest summary of the conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + readOnly: true + expireTime: + format: google-datetime description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - additionalProperties: - type: string - type: object - displayName: + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. type: string - description: The representative name for the entity. - type: - description: The entity type. - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - enumDescriptions: - - Unspecified. - - Person. - - Location. - - Organization. - - Event. - - Artwork. - - Consumer product. - - Other types of entities. - - >- - Phone number. The metadata lists the phone number (formatted - according to local convention), plus whichever additional elements - appear in the text: * `number` - The actual number, broken down - into sections according to local convention. * `national_prefix` - - Country code, if detected. * `area_code` - Region or area code, if - detected. * `extension` - Phone extension (to be dialed after - connection), if detected. - - >- - Address. The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - Street number. * `locality` - City or town. * - `street_name` - Street/route name, if detected. * `postal_code` - - Postal code, if detected. * `country` - Country, if detected. * - `broad_region` - Administrative area, such as the state, if - detected. * `narrow_region` - Smaller administrative area, such as - county, if detected. * `sublocality` - Used in Asian addresses to - demark a district within a city, if detected. - - >- - Date. The metadata identifies the components of the date: * `year` - - Four digit year, if detected. * `month` - Two digit month - number, if detected. * `day` - Two digit day number, if detected. - - Number. The metadata is the number itself. - - Price. The metadata identifies the `value` and `currency`. + startTime: + format: google-datetime + description: The time at which the conversation started. type: string - salience: - type: number - description: >- - The salience score associated with the entity in the [0, 1.0] range. - The salience score for an entity provides information about the - importance or centrality of that entity to the entire document text. - Scores closer to 0 are less salient, while scores closer to 1.0 are - highly salient. - format: float - description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. - GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: - type: object - description: One channel of conversation-level sentiment data. - id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - properties: - sentimentData: - description: Data specifying sentiment. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - channelTag: - format: int32 - type: integer - description: The channel of the audio that the data applies to. - GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest: - properties: - name: - description: Required. The name of the issue model to delete. + updateTime: + format: google-datetime + readOnly: true type: string - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - type: object - description: The request to delete an issue model. - GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: - type: object - id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse - properties: {} - description: Response from export issue model - GoogleCloudContactcenterinsightsV1Settings: - id: GoogleCloudContactcenterinsightsV1Settings - properties: - redactionConfig: description: >- - Default DLP redaction resources to be applied while ingesting - conversations. This applies to conversations ingested from the - UploadConversation and IngestConversations endpoints, including - conversations coming from CCAI Platform. + Output only. The most recent time at which the conversation was + updated. + runtimeAnnotations: + type: array + description: >- + Output only. The annotations that were generated during the customer + and agent interaction. + readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotation + turnCount: + description: Output only. The number of turns in the conversation. + type: integer + readOnly: true + format: int32 + qualityMetadata: + description: Conversation metadata related to quality management. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - languageCode: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadata + duration: type: string + description: Output only. The duration of the conversation. + readOnly: true + format: google-duration + dataSource: + description: The source of the audio and transcription for the conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationDataSource + latestAnalysis: + description: Output only. The conversation's latest analysis, if one exists. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + readOnly: true + metadataJson: description: >- - A language code to be applied to each transcript segment unless the - segment already specifies a language code. Language code defaults to - "en-US" if it is neither specified on the segment nor here. - speechConfig: - description: >- - Optional. Default Speech-to-Text resources to be used while - ingesting audio files. Optional, CCAI Insights will create a default - if not provided. This applies to conversations ingested from the - UploadConversation and IngestConversations endpoints, including - conversations coming from CCAI Platform. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - createTime: + Input only. JSON Metadata encoded as a string. This field is + primarily used by Insights integrations with various telphony + systems and must be in one of Insights' supported formats. type: string - description: Output only. The time at which the settings was created. - readOnly: true - format: google-datetime name: - type: string - description: >- - Immutable. The resource name of the settings resource. Format: - projects/{project}/locations/{location}/settings - pubsubNotificationSettings: description: >- - A map that maps a notification trigger to a Pub/Sub topic. Each time - a specified trigger occurs, Insights will notify the corresponding - Pub/Sub topic. Keys are notification triggers. Supported keys are: * - "all-triggers": Notify each time any of the supported triggers - occurs. * "create-analysis": Notify each time an analysis is - created. * "create-conversation": Notify each time a conversation is - created. * "export-insights-data": Notify each time an export is - complete. * "ingest-conversations": Notify each time an - IngestConversations LRO completes. * "update-conversation": Notify - each time a conversation is updated via UpdateConversation. * - "upload-conversation": Notify when an UploadConversation LRO - completes. Values are Pub/Sub topics. The format of each Pub/Sub - topic is: projects/{project}/topics/{topic} + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + type: string + labels: type: object additionalProperties: type: string - updateTime: - description: Output only. The time at which the settings were last updated. + description: >- + A map for the user to specify any custom fields. A maximum of 20 + labels per conversation is allowed, with a maximum of 256 characters + per entry. + createTime: type: string - format: google-datetime readOnly: true - analysisConfig: - description: Default analysis settings. + description: Output only. The time at which the conversation was created. + format: google-datetime + callMetadata: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig - conversationTtl: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationCallMetadata + description: Call-specific metadata. + obfuscatedUserId: + description: Obfuscated user ID which the customer sent to us. type: string - description: >- - The default TTL for newly-created conversations. If a conversation - has a specified expiration, that value will be used instead. - Changing this value will not change the expiration of existing - conversations. Conversations with no expire time persist until they - are deleted. - format: google-duration - type: object - description: The settings resource. - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: - description: Information about an agent involved in the conversation. - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - properties: - displayName: + medium: + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT type: string - description: The agent's name. - dispositionCode: + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. + dialogflowIntents: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowIntent + readOnly: true + description: >- + Output only. All the matched Dialogflow intents in the call. The key + corresponds to a Dialogflow intent, format: + projects/{project}/agent/{agent}/intents/{intent} + type: object + languageCode: type: string - team: + description: A user-specified language code for the conversation. + ttl: + description: >- + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. type: string - description: A user-specified string representing the agent's team. + format: google-duration agentId: - type: string - description: A user-specified string representing the agent. - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest: - properties: - filter: - type: string - description: >- - Required. Filter used to select the subset of conversations to - analyze. - analysisPercentage: - type: number description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. - format: float - annotatorSelector: - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - parent: - description: Required. The parent resource to create analyses in. + An opaque, user-specified string representing the human agent who + handled the conversation. type: string - description: The request to analyze conversations in bulk. - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - type: object - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse: + GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: description: >- - Sample response that the agent can use. This could be based on - applicable instructions and ingested data from other systems. - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionSampleResponse - properties: - responseText: - type: string - description: Optional. Sample response for Agent in text. - GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource: - description: The sources of the answers. + A point in a conversation that marks the start or the end of an + annotation. properties: - document: + wordIndex: description: >- - The document from which the snippet was extracted. Format: - `projects//knowledgeBases//documents/` - type: string - snippet: - type: string - description: The relevant snippet of the article. - uri: - description: The URI of the article. - type: string - title: - description: The title of the article. - type: string - id: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource + The word index of this boundary with respect to the first word in + the transcript piece. This index starts at zero. + format: int32 + type: integer + transcriptIndex: + format: int32 + type: integer + description: >- + The index in the sequence of transcribed pieces of the conversation + where the boundary is located. This index starts at zero. type: object - GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: - description: Information about the issue. - id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: properties: - displayName: + processedObjectCount: description: >- - Immutable. Display name of the assigned issue. This field is set at - time of analyis and immutable since then. - type: string - score: - format: double + Output only. The number of objects processed during the ingest + operation. + format: int32 + type: integer + readOnly: true + successfulIngestCount: + format: int32 description: >- - Score indicating the likelihood of the issue assignment. currently - bounded on [0,1]. - type: number - issue: - type: string - description: Resource name of the assigned issue. + Output only. The number of new conversations added during this + ingest operation. + type: integer + readOnly: true + duplicatesSkippedCount: + format: int32 + description: >- + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + type: integer + readOnly: true + failedIngestCount: + format: int32 + readOnly: true + type: integer + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats type: object - GoogleCloudContactcenterinsightsV1UploadConversationMetadata: - id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata - description: The metadata for an UploadConversation operation. + description: Statistics for IngestConversations operation. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats: + type: object + description: Statistics for IngestConversations operation. + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats properties: - request: + failedIngestCount: readOnly: true - description: Output only. The original request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest - appliedRedactionConfig: + format: int32 + type: integer + description: >- + Output only. The number of objects which were unable to be ingested + due to errors. The errors are populated in the partial_errors field. + processedObjectCount: + type: integer readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + format: int32 description: >- - Output only. The redaction config applied to the uploaded - conversation. - analysisOperation: + Output only. The number of objects processed during the ingest + operation. + duplicatesSkippedCount: + description: >- + Output only. The number of objects skipped because another + conversation with the same transcript uri had already been ingested. + readOnly: true + type: integer + format: int32 + successfulIngestCount: + type: integer readOnly: true - type: string description: >- - Output only. The operation name for a successfully created analysis - operation, if any. + Output only. The number of new conversations added during this + ingest operation. + format: int32 + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: + type: object + description: Metadata used for export issue model. + id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata + properties: createTime: + description: The time the operation was created. format: google-datetime type: string - readOnly: true - description: Output only. The time the operation was created. + request: + description: The original export request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest endTime: - description: Output only. The time the operation finished running. - type: string format: google-datetime - readOnly: true + description: The time the operation finished running. + type: string + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest: type: object - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: - description: The request to export insights. - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest properties: - bigQueryDestination: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - description: Specified if sink is a BigQuery table. - writeDisposition: - enumDescriptions: - - Write disposition is not specified. Defaults to WRITE_TRUNCATE. - - >- - If the table already exists, BigQuery will overwrite the table - data and use the schema from the load. - - >- - If the table already exists, BigQuery will append data to the - table. - enum: - - WRITE_DISPOSITION_UNSPECIFIED - - WRITE_TRUNCATE - - WRITE_APPEND - description: Options for what to do if the destination table already exists. - type: string - kmsKey: - type: string - description: >- - A fully qualified KMS key name for BigQuery tables protected by - CMEK. Format: - projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} - parent: - type: string - description: Required. The parent resource to export data from. - filter: - type: string + encryptionSpec: description: >- - A filter to reduce results to a specific subset. Useful for - exporting conversations with specific properties. + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. + GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: type: object - GoogleCloudContactcenterinsightsV1IssueModel: - description: The issue model resource. - id: GoogleCloudContactcenterinsightsV1IssueModel + id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment + description: One channel of conversation-level sentiment data. properties: - inputDataConfig: + channelTag: + format: int32 + type: integer + description: The channel of the audio that the data applies to. + sentimentData: + description: Data specifying sentiment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig - description: Configs for the input data that used to create the issue model. - name: - type: string - description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} - displayName: - type: string - description: The representative name for the issue model. - languageCode: - type: string - description: Language of the model. - createTime: - readOnly: true - type: string - format: google-datetime - description: Output only. The time at which this issue model was created. - issueCount: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + GoogleCloudContactcenterinsightsV1SilenceData: + type: object + description: The data for a silence annotation. + properties: {} + id: GoogleCloudContactcenterinsightsV1SilenceData + GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig: + properties: + trainingConversationsCount: readOnly: true type: string + description: Output only. Number of conversations used in training. Output only. format: int64 - description: Output only. Number of issues in this issue model. - updateTime: + filter: type: string - format: google-datetime description: >- - Output only. The most recent time at which the issue model was - updated. - readOnly: true - state: - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING - description: Output only. State of the model. - readOnly: true + A filter to reduce the conversations used for training the model to + a specific subset. + medium: + deprecated: true enumDescriptions: - - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. - - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. - type: string - trainingStats: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. description: >- - Output only. Immutable. The issue model's label statistics on its - training data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats - readOnly: true - modelType: - description: Type of the model. - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 + Medium of conversations used in training data. This field is being + deprecated. To specify the medium to be used in training a new issue + model, set the `medium` field on `filter`. type: string + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + id: GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + description: Configs for the input data used to create the issue model. type: object - GoogleLongrunningListOperationsResponse: + GoogleLongrunningOperation: + type: object + id: GoogleLongrunningOperation properties: - nextPageToken: - description: The standard List next-page token. + name: type: string - operations: - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - A list of operations that matches the specified filter in the - request. - id: GoogleLongrunningListOperationsResponse - type: object - description: The response message for Operations.ListOperations. - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata - properties: - failedAnalysesCount: - format: int32 - description: The number of requested analyses that have failed so far. - type: integer - totalRequestedAnalysesCount: - format: int32 + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + response: + type: object description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. - type: integer - request: - description: The original request for bulk analyze. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest - completedAnalysesCount: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + error: description: >- - The number of requested analyses that have completed successfully so - far. - format: int32 - type: integer - createTime: - format: google-datetime - type: string - description: The time the operation was created. - partialErrors: + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + done: + type: boolean description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - endTime: - description: The time the operation finished running. - format: google-datetime - type: string - type: object - description: The metadata for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata - properties: - createTime: - description: The time the operation was created. - type: string - format: google-datetime - request: - description: The original import request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - endTime: - type: string - description: The time the operation finished running. - format: google-datetime - description: Metadata used for import issue model. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + metadata: + type: object + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + This resource represents a long-running operation that is the result of + a network API call. + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse: + description: The response to undeploy an issue model. + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelResponse type: object - GoogleCloudContactcenterinsightsV1HoldData: + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: type: object - description: The data for a hold annotation. - properties: {} - id: GoogleCloudContactcenterinsightsV1HoldData - GoogleCloudContactcenterinsightsV1AnswerFeedback: - description: >- - The feedback that the customer has about a certain answer in the - conversation. + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse + description: The response for a bulk analyze conversations operation. properties: - clicked: - description: Indicates whether an answer or item was clicked by the human agent. - type: boolean - displayed: - description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - type: boolean - correctnessLevel: - type: string - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - enumDescriptions: - - Correctness level unspecified. - - Answer is totally wrong. - - Answer is partially correct. - - Answer is fully correct. - description: The correctness level of an answer. - type: object - id: GoogleCloudContactcenterinsightsV1AnswerFeedback - GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse: + failedAnalysisCount: + format: int32 + description: Count of failed analyses. + type: integer + successfulAnalysisCount: + type: integer + format: int32 + description: Count of successful analyses. + GoogleCloudContactcenterinsightsV1InterruptionData: + id: GoogleCloudContactcenterinsightsV1InterruptionData properties: {} - id: GoogleCloudContactcenterinsightsV1UndeployIssueModelResponse - description: The response to undeploy an issue model. + description: The data for an interruption annotation. type: object - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: - description: Conversation summarization suggestion data. + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: id: >- - GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + type: object + description: Word-level info for words in a transcript. properties: - text: - type: string - description: The summarization content that is concatenated into one string. - metadata: - description: >- - A map that contains metadata about the summarization and the - document from which it originates. - type: object - additionalProperties: - type: string confidence: - description: The confidence score of the summarization. type: number format: float - answerRecord: + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + word. A default value of 0.0 indicates that the value is unset. + word: + type: string + description: The word itself. Includes punctuation marks that surround the word. + endOffset: + type: string + format: google-duration + description: >- + Time offset of the end of this word relative to the beginning of the + total conversation. + startOffset: + type: string + description: >- + Time offset of the start of this word relative to the beginning of + the total conversation. + format: google-duration + GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData: + id: GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData + type: object + description: Agent Assist Article Suggestion data. + properties: + queryRecord: type: string description: >- The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} - conversationModel: + confidenceScore: + type: number + format: float description: >- - The name of the model that generates this summary. Format: - projects/{project}/locations/{location}/conversationModels/{conversation_model} + The system's confidence score that this article is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + uri: + description: Article URI. type: string - textSections: + metadata: + type: object + description: >- + Map that contains metadata about the Article Suggestion and the + document that it originates from. additionalProperties: type: string + title: + type: string + description: Article title. + source: + type: string description: >- - The summarization content that is divided into sections. The key is - the section's name and the value is the section's content. There is - no specific format for the key or value. - type: object + The knowledge document that this answer was extracted from. Format: + projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} + GoogleCloudContactcenterinsightsV1DialogflowIntent: type: object - GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse: + id: GoogleCloudContactcenterinsightsV1DialogflowIntent + description: >- + The data for a Dialogflow intent. Represents a detected intent in the + conversation, e.g. MAKES_PROMISE. properties: - successfulAnalysisCount: - description: Count of successful analyses. - type: integer - format: int32 - failedAnalysisCount: + displayName: + type: string + description: The human-readable name of the intent. + GoogleCloudContactcenterinsightsV1IngestConversationsRequest: + properties: + sampleSize: type: integer - description: Count of failed analyses. format: int32 - id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsResponse - type: object - description: The response for a bulk analyze conversations operation. - GoogleCloudContactcenterinsightsV1UploadConversationRequest: - id: GoogleCloudContactcenterinsightsV1UploadConversationRequest - description: Request to upload a conversation. - type: object - properties: - parent: - description: Required. The parent resource of the conversation. - type: string - conversation: - description: Required. The conversation resource to create. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' - conversationId: description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - type: string + Optional. If set, this fields indicates the number of objects to + ingest from the Cloud Storage bucket. If empty, the entire bucket + will be ingested. Unless they are first deleted, conversations + produced through sampling won't be ingested by subsequent ingest + requests. speechConfig: $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. - redactionConfig: - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. + Optional. Default Speech-to-Text configuration. Optional, will + default to the config specified in Settings. + conversationConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig + description: Configuration that applies to all conversations. + redactionConfig: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - GoogleCloudContactcenterinsightsV1RedactionConfig: - properties: - deidentifyTemplate: - type: string description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` - inspectTemplate: + Optional. DLP settings for transcript redaction. Optional, will + default to the config specified in Settings. + transcriptObjectConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for when `source` contains conversation transcripts. + parent: + description: Required. The parent resource for new conversations. + type: string + gcsSource: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` + A cloud storage bucket source. Note that any previously ingested + objects from the source will be skipped to avoid duplication. + type: object + description: The request to ingest conversations. + id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: + properties: {} + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse + description: Response for an export insights operation. + type: object + GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: + id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata + properties: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest + description: The original request for creation. + endTime: + type: string + readOnly: true + format: google-datetime + description: Output only. The time the operation finished running. + createTime: + description: Output only. The time the operation was created. + format: google-datetime + readOnly: true type: string type: object - id: GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - DLP resources used for redaction while ingesting conversations. DLP - settings are applied to conversations ingested from the - UploadConversation and IngestConversations endpoints, including - conversation coming from CCAI Platform. They are not applied to - conversations ingested from the CreateConversation endpoint or the - Dialogflow / Agent Assist runtime integrations. When using Dialogflow / - Agent Assist runtime integrations redaction should be performed in - Dialogflow / Agent Assist. - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse: + description: Metadata for creating an issue model. + GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: + id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult + properties: + endTime: + description: The time at which the analysis ended. + format: google-datetime + type: string + callAnalysisMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata + description: Call-specific metadata created by the analysis. type: object - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsResponse - description: The response for a bulk analyze conversations operation. + description: The result of an analysis. + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: + description: A single interval in a time series. properties: - successfulAnalysisCount: - description: Count of successful analyses. - format: int32 - type: integer - failedAnalysisCount: - description: Count of failed analyses. + conversationCount: + description: The number of conversations created in this interval. type: integer format: int32 - GoogleCloudContactcenterinsightsV1Intent: - id: GoogleCloudContactcenterinsightsV1Intent + startTime: + type: string + format: google-datetime + description: The start time of this interval. + id: >- + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + type: object + GoogleCloudContactcenterinsightsV1EntityMentionData: + id: GoogleCloudContactcenterinsightsV1EntityMentionData type: object - description: >- - The data for an intent. Represents a detected intent in the - conversation, for example MAKES_PROMISE. properties: - displayName: + sentiment: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + description: Sentiment expressed for this mention of the entity. + type: + enum: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + description: The type of the entity mention. + enumDescriptions: + - Unspecified. + - Proper noun. + - Common noun (or noun compound). type: string - description: The human-readable name of the intent. - id: - description: The unique identifier of the intent. + entityUniqueId: + description: >- + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. type: string - GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: - id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse - properties: {} - description: The response for a bulk delete conversations operation. - type: object - GoogleCloudContactcenterinsightsV1GcsSource: + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. + GoogleCloudContactcenterinsightsV1alpha1IssueAssignment: + id: GoogleCloudContactcenterinsightsV1alpha1IssueAssignment type: object - id: GoogleCloudContactcenterinsightsV1GcsSource - description: A Cloud Storage source of conversation data. + description: Information about the issue. properties: - transcriptUri: + issue: type: string - description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - audioUri: + description: Resource name of the assigned issue. + displayName: type: string description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - GoogleCloudContactcenterinsightsV1IngestConversationsRequest: - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequest + Immutable. Display name of the assigned issue. This field is set at + time of analyis and immutable since then. + score: + type: number + description: >- + Score indicating the likelihood of the issue assignment. currently + bounded on [0,1]. + format: double + GoogleCloudContactcenterinsightsV1ConversationCallMetadata: + id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata type: object - description: The request to ingest conversations. + description: Call-specific metadata. properties: - transcriptObjectConfig: - description: Configuration for when `source` contains conversation transcripts. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - speechConfig: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' - description: >- - Optional. Default Speech-to-Text configuration. Optional, will - default to the config specified in Settings. - sampleSize: + agentChannel: format: int32 + description: The audio channel that contains the agent. type: integer - description: >- - Optional. If set, this fields indicates the number of objects to - ingest from the Cloud Storage bucket. If empty, the entire bucket - will be ingested. Note that conversations produced via sampling will - not be ingested by subsequent ingest requests unless they are first - deleted. - gcsSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - description: >- - A cloud storage bucket source. Note that any previously ingested - objects from the source will be skipped to avoid duplication. - parent: - description: Required. The parent resource for new conversations. - type: string - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Optional, will - default to the config specified in Settings. - conversationConfig: - description: Configuration that applies to all conversations. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig - GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation: + customerChannel: + format: int32 + type: integer + description: The audio channel that contains the customer. + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse: + properties: {} + type: object + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse + description: The response to initialize a location-level encryption specification. + GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest type: object - id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation properties: - knowledgeSearchResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer - description: The Knowledge Search result. - smartComposeSuggestion: + name: + type: string + description: Required. The issue model to export. + gcsDestination: + description: Google Cloud Storage URI to export the issue model to. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData - description: Agent Assist Smart Compose suggestion data. - createTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + description: Request to export an issue model. + GoogleCloudContactcenterinsightsV1Intent: + properties: + id: type: string - description: The time at which this annotation was created. - format: google-datetime - annotationId: + description: The unique identifier of the intent. + displayName: type: string - description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - answerFeedback: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. - generatorSuggestionResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse - description: The generator suggestion result. - faqAnswer: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - description: Agent Assist FAQ answer data. - knowledgeAssistResult: + description: The human-readable name of the intent. + type: object + description: >- + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. + id: GoogleCloudContactcenterinsightsV1Intent + GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource: + description: The conversation source, which is a combination of transcript and audio. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + properties: + gcsSource: + description: A Cloud Storage location specification for the audio and transcript. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponse - description: The Knowledge Assist result. - conversationSummarizationSuggestion: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GcsSource + dialogflowSource: + description: The source when the conversation comes from Dialogflow. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - description: Conversation summarization suggestion data. - startBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - description: >- - The boundary in the conversation where the annotation starts, - inclusive. - articleSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - smartReply: - description: Agent Assist Smart Reply data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SmartReplyData - endBoundary: - description: >- - The boundary in the conversation where the annotation ends, - inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - dialogflowInteraction: - description: Dialogflow interaction data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData - description: >- - An annotation that was generated during the customer and agent - interaction. - GoogleCloudContactcenterinsightsV1SmartReplyData: - id: GoogleCloudContactcenterinsightsV1SmartReplyData + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse type: object properties: - confidenceScore: - format: double - type: number + operations: description: >- - The system's confidence score that this reply is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - reply: + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + nextPageToken: type: string - description: The content of the reply. - metadata: - type: object - description: >- - Map that contains metadata about the Smart Reply and the document - from which it originates. - additionalProperties: - type: string - queryRecord: + description: The standard List next-page token. + description: The response message for Operations.ListOperations. + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig: + properties: + summarizationModel: + enumDescriptions: + - Unspecified summarization model. + - The CCAI baseline model. + - The CCAI baseline model, V2.0. + enum: + - SUMMARIZATION_MODEL_UNSPECIFIED + - BASELINE_MODEL + - BASELINE_MODEL_V2_0 + type: string + description: Default summarization model to be used. + conversationProfile: type: string description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - description: Agent Assist Smart Reply data. - GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: + Resource name of the Dialogflow conversation profile. Format: + projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} + type: object + id: >- + GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig + description: Configuration for summarization. + GoogleCloudContactcenterinsightsV1PhraseMatchData: + id: GoogleCloudContactcenterinsightsV1PhraseMatchData type: object + properties: + displayName: + type: string + description: The human-readable name of the phrase matcher. + phraseMatcher: + type: string + description: The unique identifier (the resource name) of the phrase matcher. description: >- - DLP resources used for redaction while ingesting conversations. DLP - settings are applied to conversations ingested from the - UploadConversation and IngestConversations endpoints, including - conversation coming from CCAI Platform. They are not applied to - conversations ingested from the CreateConversation endpoint or the - Dialogflow / Agent Assist runtime integrations. When using Dialogflow / - Agent Assist runtime integrations redaction should be performed in - Dialogflow / Agent Assist. + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. + GoogleCloudContactcenterinsightsV1ExportIssueModelResponse: + description: Response from export issue model + properties: {} + id: GoogleCloudContactcenterinsightsV1ExportIssueModelResponse + type: object + GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput: + id: GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + type: object properties: - inspectTemplate: + querySource: + enumDescriptions: + - Unknown query source. + - The query is from agents. + - >- + The query is a query from previous suggestions, e.g. from a + preceding SuggestKnowledgeAssist response. + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY + type: string + description: Query source for the answer. + generatorName: type: string description: >- - The fully-qualified DLP inspect template resource name. Format: - `projects/{project}/locations/{location}/inspectTemplates/{template}` - deidentifyTemplate: + The resource name of associated generator. Format: + `projects//locations//generators/` + query: description: >- - The fully-qualified DLP deidentify template resource name. Format: - `projects/{project}/deidentifyTemplates/{template}` + Query text. Article Search uses this to store the input query used + to generate the search results. type: string - id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - GoogleCloudContactcenterinsightsV1ListIssuesResponse: + GoogleCloudContactcenterinsightsV1Entity: + id: GoogleCloudContactcenterinsightsV1Entity type: object - description: The response of listing issues. - properties: - issues: - description: The issues that match the request. - type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' - id: GoogleCloudContactcenterinsightsV1ListIssuesResponse - GoogleCloudContactcenterinsightsV1ArticleSuggestionData: - id: GoogleCloudContactcenterinsightsV1ArticleSuggestionData + description: >- + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. properties: + sentiment: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + description: >- + The aggregate sentiment expressed for this entity in the + conversation. metadata: type: object + description: >- + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. additionalProperties: type: string - description: >- - Map that contains metadata about the Article Suggestion and the - document that it originates from. - title: - description: Article title. - type: string - queryRecord: + type: type: string + enum: + - TYPE_UNSPECIFIED + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + enumDescriptions: + - Unspecified. + - Person. + - Location. + - Organization. + - Event. + - Artwork. + - Consumer product. + - Other types of entities. + - >- + Phone number. The metadata lists the phone number (formatted + according to local convention), plus whichever additional elements + appear in the text: * `number` - The actual number, broken down + into sections according to local convention. * `national_prefix` - + Country code, if detected. * `area_code` - Region or area code, if + detected. * `extension` - Phone extension (to be dialed after + connection), if detected. + - >- + Address. The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - Street number. * `locality` - City or town. * + `street_name` - Street/route name, if detected. * `postal_code` - + Postal code, if detected. * `country` - Country, if detected. * + `broad_region` - Administrative area, such as the state, if + detected. * `narrow_region` - Smaller administrative area, such as + county, if detected. * `sublocality` - Used in Asian addresses to + demark a district within a city, if detected. + - >- + Date. The metadata identifies the components of the date: * `year` + - Four digit year, if detected. * `month` - Two digit month + number, if detected. * `day` - Two digit day number, if detected. + - Number. The metadata is the number itself. + - Price. The metadata identifies the `value` and `currency`. + description: The entity type. + salience: description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - confidenceScore: - description: >- - The system's confidence score that this article is a good match for - this conversation, ranging from 0.0 (completely uncertain) to 1.0 - (completely certain). - format: float + The salience score associated with the entity in the [0, 1.0] range. + The salience score for an entity provides information about the + importance or centrality of that entity to the entire document text. + Scores closer to 0 are less salient, while scores closer to 1.0 are + highly salient. type: number - uri: - type: string - description: Article URI. - source: + format: float + displayName: type: string - description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document} - description: Agent Assist Article Suggestion data. + description: The representative name for the entity. + GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: type: object - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource: + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata properties: - title: + endTime: + description: Output only. The time the operation finished running. type: string - description: Title of the document. - uri: + readOnly: true + format: google-datetime + appliedRedactionConfig: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + Output only. The redaction config applied to the uploaded + conversation. + createTime: type: string - description: URI the data is sourced from. - description: Details about source of Intent Matching answer. - type: object - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource - GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource: - description: Configuration for Cloud Storage bucket sources. - type: object - id: GoogleCloudContactcenterinsightsV1IngestConversationsRequestGcsSource - properties: - bucketUri: - description: Required. The Cloud Storage bucket containing source objects. + description: Output only. The time the operation was created. + readOnly: true + format: google-datetime + analysisOperation: + readOnly: true type: string - customMetadataKeys: - items: - type: string description: >- - Optional. Custom keys to extract as conversation labels from - metadata files in `metadata_bucket_uri`. Keys not included in this - field will be ignored. Note that there is a limit of 20 labels per - conversation. - type: array - metadataBucketUri: - description: >- - Optional. The Cloud Storage path to the source object metadata. Note - that: [1] metadata files are expected to be in JSON format [2] - metadata and source objects must be in separate buckets [3] a source - object's metadata object must share the same name to be properly - ingested - type: string - bucketObjectType: - enum: - - BUCKET_OBJECT_TYPE_UNSPECIFIED - - TRANSCRIPT - - AUDIO - description: Optional. Specifies the type of the objects in `bucket_uri`. - type: string - enumDescriptions: - - The object type is unspecified and will default to `TRANSCRIPT`. - - The object is a transcript. - - The object is an audio file. - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata: - description: Metadata used for export issue model. + Output only. The operation name for a successfully created analysis + operation, if any. + request: + readOnly: true + description: Output only. The original request. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest + description: The metadata for an `UploadConversation` operation. + GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelMetadata properties: + partialErrors: + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Partial errors during export operation that might cause the + operation output to be incomplete. createTime: - type: string format: google-datetime - description: The time the operation was created. - endTime: - description: The time the operation finished running. type: string - format: google-datetime + description: Output only. The time the operation was created. + readOnly: true request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequest - description: The original export request. - GoogleRpcStatus: - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: array - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + description: The original request for export. + endTime: + description: Output only. The time the operation finished running. + readOnly: true + format: google-datetime type: string - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer + description: Metadata for an export insights operation. + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata + GoogleCloudContactcenterinsightsV1HoldData: + description: The data for a hold annotation. + id: GoogleCloudContactcenterinsightsV1HoldData type: object - GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + properties: {} + GoogleCloudContactcenterinsightsV1alpha1Entity: type: object - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + description: >- + The data for an entity annotation. Represents a phrase in the + conversation that is a known entity, such as a person, an organization, + or location. + id: GoogleCloudContactcenterinsightsV1alpha1Entity properties: - confidence: + type: + enumDescriptions: + - Unspecified. + - Person. + - Location. + - Organization. + - Event. + - Artwork. + - Consumer product. + - Other types of entities. + - >- + Phone number. The metadata lists the phone number (formatted + according to local convention), plus whichever additional elements + appear in the text: * `number` - The actual number, broken down + into sections according to local convention. * `national_prefix` - + Country code, if detected. * `area_code` - Region or area code, if + detected. * `extension` - Phone extension (to be dialed after + connection), if detected. + - >- + Address. The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - Street number. * `locality` - City or town. * + `street_name` - Street/route name, if detected. * `postal_code` - + Postal code, if detected. * `country` - Country, if detected. * + `broad_region` - Administrative area, such as the state, if + detected. * `narrow_region` - Smaller administrative area, such as + county, if detected. * `sublocality` - Used in Asian addresses to + demark a district within a city, if detected. + - >- + Date. The metadata identifies the components of the date: * `year` + - Four digit year, if detected. * `month` - Two digit month + number, if detected. * `day` - Two digit day number, if detected. + - Number. The metadata is the number itself. + - Price. The metadata identifies the `value` and `currency`. + description: The entity type. + type: string + enum: + - TYPE_UNSPECIFIED + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + metadata: + additionalProperties: + type: string + type: object description: >- - The confidence of the match ranging from 0.0 (completely uncertain) - to 1.0 (completely certain). + Metadata associated with the entity. For most entity types, the + metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph + MID (`mid`), if they are available. For the metadata associated with + other entity types, see the Type table below. + sentiment: + description: >- + The aggregate sentiment expressed for this entity in the + conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + salience: type: number format: float - dialogflowIntentId: + description: >- + The salience score associated with the entity in the [0, 1.0] range. + The salience score for an entity provides information about the + importance or centrality of that entity to the entire document text. + Scores closer to 0 are less salient, while scores closer to 1.0 are + highly salient. + displayName: + description: The representative name for the entity. + type: string + GoogleCloudContactcenterinsightsV1alpha1RedactionConfig: + properties: + inspectTemplate: + description: >- + The fully-qualified DLP inspect template resource name. Format: + `projects/{project}/locations/{location}/inspectTemplates/{template}` type: string + deidentifyTemplate: description: >- - The Dialogflow intent resource path. Format: - projects/{project}/agent/{agent}/intents/{intent} - description: Dialogflow interaction data. + The fully-qualified DLP deidentify template resource name. Format: + `projects/{project}/deidentifyTemplates/{template}` + type: string + id: GoogleCloudContactcenterinsightsV1alpha1RedactionConfig + description: >- + DLP resources used for redaction while ingesting conversations. DLP + settings are applied to conversations ingested from the + `UploadConversation` and `IngestConversations` endpoints, including + conversation coming from CCAI Platform. They are not applied to + conversations ingested from the `CreateConversation` endpoint or the + Dialogflow / Agent Assist runtime integrations. When using Dialogflow / + Agent Assist runtime integrations, redaction should be performed in + Dialogflow / Agent Assist. + type: object + GoogleCloudContactcenterinsightsV1ExactMatchConfig: + type: object + description: Exact match configuration. + id: GoogleCloudContactcenterinsightsV1ExactMatchConfig + properties: + caseSensitive: + description: Whether to consider case sensitivity when performing an exact match. + type: boolean + GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: + id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination + type: object + description: Google Cloud Storage Object URI to save the issue model to. + properties: + objectUri: + type: string + description: 'Required. Format: `gs:///`' GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback: type: object - description: >- - The feedback that the customer has about a certain answer in the - conversation. - id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback properties: + displayed: + type: boolean + description: >- + Indicates whether an answer or item was displayed to the human agent + in the agent desktop UI. clicked: description: Indicates whether an answer or item was clicked by the human agent. type: boolean correctnessLevel: description: The correctness level of an answer. + enum: + - CORRECTNESS_LEVEL_UNSPECIFIED + - NOT_CORRECT + - PARTIALLY_CORRECT + - FULLY_CORRECT enumDescriptions: - Correctness level unspecified. - Answer is totally wrong. - Answer is partially correct. - Answer is fully correct. type: string - enum: - - CORRECTNESS_LEVEL_UNSPECIFIED - - NOT_CORRECT - - PARTIALLY_CORRECT - - FULLY_CORRECT - displayed: - description: >- - Indicates whether an answer or item was displayed to the human agent - in the agent desktop UI. - type: boolean - GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: - description: Call-specific metadata created during analysis. - id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + id: GoogleCloudContactcenterinsightsV1alpha1AnswerFeedback + description: >- + The feedback that the customer has about a certain answer in the + conversation. + GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: + type: object + description: Default configuration when creating Analyses in Insights. properties: - phraseMatchers: - description: All the matched phrase matchers in the call. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData - type: object - sentiments: - type: array - description: Overall conversation-level sentiment for each channel of the call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment - annotations: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation - description: A list of call annotations that apply to this call. - issueModelResult: + runtimeIntegrationAnalysisPercentage: + format: double + description: >- + Percentage of conversations created using Dialogflow runtime + integration to analyze automatically, between [0, 100]. + type: number + uploadConversationAnalysisPercentage: + type: number + format: double + description: >- + Percentage of conversations created using the UploadConversation + endpoint to analyze automatically, between [0, 100]. + annotatorSelector: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult - description: Overall conversation-level issue modeling result. - entities: - type: object + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + description: >- + To select the annotators to run and the phrase matchers to use (if + any). If not specified, all annotators will be run. + id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData: + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + type: object + properties: + answerRecord: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + type: string + textSections: additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' - description: All the entities in the call. - intents: + type: string type: object - description: All the matched intents in the call. + description: >- + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. + text: + description: The summarization content that is concatenated into one string. + type: string + confidence: + type: number + format: float + description: The confidence score of the summarization. + metadata: additionalProperties: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' - silence: - description: Overall conversation-level silence during the call. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence - type: object - GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata: + type: string + type: object + description: >- + A map that contains metadata about the summarization and the + document from which it originates. + conversationModel: + type: string + description: >- + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} + description: Conversation summarization suggestion data. + GoogleCloudContactcenterinsightsV1alpha1GcsSource: + description: A Cloud Storage source of conversation data. + id: GoogleCloudContactcenterinsightsV1alpha1GcsSource properties: - request: - description: The original request for deletion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeleteIssueModelRequest - createTime: - readOnly: true + audioUri: type: string - format: google-datetime - description: Output only. The time the operation was created. - endTime: - description: Output only. The time the operation finished running. - readOnly: true - format: google-datetime + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. + transcriptUri: type: string - description: Metadata for deleting an issue model. - id: GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata + description: >- + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. type: object - GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata: - description: Metadata for an export insights operation. + GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata: + type: object + id: GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata properties: - createTime: + partialErrors: + type: array + description: >- + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. + items: + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true - type: string - description: Output only. The time the operation was created. - format: google-datetime request: - description: The original request for export. + description: The original request for bulk analyze. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + failedAnalysesCount: + description: The number of requested analyses that have failed so far. + type: integer + format: int32 endTime: + description: The time the operation finished running. + format: google-datetime type: string + createTime: format: google-datetime - description: Output only. The time the operation finished running. - readOnly: true - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - type: array - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataMetadata - type: object - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: - type: object - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig - properties: - medium: - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - description: Required. The medium transcript objects represent. type: string - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - description: Configuration for processing transcript objects. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - description: Metadata from Dialogflow relating to the current transcript segment. - properties: - smartReplyAllowlistCovered: - type: boolean + description: The time the operation was created. + totalRequestedAnalysesCount: + format: int32 description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - type: object - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion: - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentActionSuggestion - properties: - agentAction: - type: string - description: Optional. The suggested action for the agent. - description: >- - Actions suggested for the agent. This is based on applicable - instructions. - GoogleCloudContactcenterinsightsV1ListViewsResponse: - id: GoogleCloudContactcenterinsightsV1ListViewsResponse - type: object - description: The response of listing views. - properties: - views: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' - description: The views that match the request. - nextPageToken: + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + type: integer + completedAnalysesCount: + format: int32 description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse: - id: GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse + The number of requested analyses that have completed successfully so + far. + type: integer + description: The metadata for a bulk analyze conversations operation. + GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData + description: The data for an issue match annotation. + type: object properties: - generatorSuggestion: - description: The suggestion generated from the Generator. + issueAssignment: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GeneratorSuggestion - description: Represents response from generators. - type: object - GoogleCloudContactcenterinsightsV1alpha1IssueModel: - id: GoogleCloudContactcenterinsightsV1alpha1IssueModel - description: The issue model resource. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + description: Information about the issue's assignment. + GoogleCloudContactcenterinsightsV1alpha1Conversation: type: object properties: - languageCode: - description: Language of the model. - type: string - inputDataConfig: - description: Configs for the input data that used to create the issue model. + turnCount: + format: int32 + type: integer + description: Output only. The number of turns in the conversation. + readOnly: true + latestAnalysis: + description: Output only. The conversation's latest analysis, if one exists. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig - displayName: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis + readOnly: true + agentId: type: string - description: The representative name for the issue model. - issueCount: + description: >- + An opaque, user-specified string representing the human agent who + handled the conversation. + obfuscatedUserId: type: string - format: int64 - description: Output only. Number of issues in this issue model. - readOnly: true - createTime: - format: google-datetime - description: Output only. The time at which this issue model was created. - readOnly: true + description: Obfuscated user ID which the customer sent to us. + languageCode: type: string + description: A user-specified language code for the conversation. updateTime: format: google-datetime + readOnly: true description: >- - Output only. The most recent time at which the issue model was + Output only. The most recent time at which the conversation was updated. type: string + latestSummary: readOnly: true - state: - readOnly: true - description: Output only. State of the model. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData + description: Output only. Latest summary of the conversation. + expireTime: + format: google-datetime + type: string + description: >- + The time at which this conversation should expire. After this time, + the conversation data and any associated analyses will be deleted. + medium: type: string - enum: - - STATE_UNSPECIFIED - - UNDEPLOYED - - DEPLOYING - - DEPLOYED - - UNDEPLOYING - - DELETING enumDescriptions: - - Unspecified. - - Model is not deployed but is ready to deploy. - - Model is being deployed. - - >- - Model is deployed and is ready to be used. A model can only be - used in analysis if it's in this state. - - Model is being undeployed. - - Model is being deleted. - name: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT description: >- - Immutable. The resource name of the issue model. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} + Immutable. The conversation medium, if unspecified will default to + PHONE_CALL. + callMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + description: Call-specific metadata. + metadataJson: type: string - trainingStats: description: >- - Output only. Immutable. The issue model's label statistics on its - training data. + Input only. JSON Metadata encoded as a string. This field is + primarily used by Insights integrations with various telphony + systems and must be in one of Insights' supported formats. + transcript: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript readOnly: true - modelType: - description: Type of the model. - enumDescriptions: - - Unspecified model type. - - Type V1. - - Type V2. - enum: - - MODEL_TYPE_UNSPECIFIED - - TYPE_V1 - - TYPE_V2 + description: Output only. The conversation transcript. + ttl: + format: google-duration type: string - GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse: - type: object - properties: - generatorSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GeneratorSuggestion - description: The suggestion generated from the Generator. - id: GoogleCloudContactcenterinsightsV1alpha1GetGeneratorSuggestionResponse - description: Represents response from generators. - GoogleCloudContactcenterinsightsV1IssueMatchData: - description: The data for an issue match annotation. - properties: - issueAssignment: + description: >- + Input only. The TTL for this resource. If specified, then this TTL + will be used to calculate the expire time. + duration: + readOnly: true + format: google-duration + type: string + description: Output only. The duration of the conversation. + dataSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - description: Information about the issue's assignment. - type: object - id: GoogleCloudContactcenterinsightsV1IssueMatchData - GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: - type: object - properties: - nextPageToken: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource + description: The source of the audio and transcription for the conversation. + createTime: + readOnly: true type: string + format: google-datetime + description: Output only. The time at which the conversation was created. + dialogflowIntents: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - phraseMatchers: + Output only. All the matched Dialogflow intents in the call. The key + corresponds to a Dialogflow intent, format: + projects/{project}/agent/{agent}/intents/{intent} + readOnly: true + labels: + type: object + additionalProperties: + type: string + description: >- + A map for the user to specify any custom fields. A maximum of 20 + labels per conversation is allowed, with a maximum of 256 characters + per entry. + runtimeAnnotations: + description: >- + Output only. The annotations that were generated during the customer + and agent interaction. + type: array items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher - type: array - description: The phrase matchers that match the request. - description: The response of listing phrase matchers. - id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse - GoogleCloudContactcenterinsightsV1alpha1CallAnnotation: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation + readOnly: true + qualityMetadata: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata + description: Conversation metadata related to quality management. + startTime: + description: The time at which the conversation started. + type: string + format: google-datetime + name: + type: string + description: >- + Immutable. The resource name of the conversation. Format: + projects/{project}/locations/{location}/conversations/{conversation} + id: GoogleCloudContactcenterinsightsV1alpha1Conversation + description: The conversation resource. + GoogleCloudContactcenterinsightsV1AnnotatorSelector: type: object properties: - annotationStartBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + runEntityAnnotator: + type: boolean + description: Whether to run the entity annotator. + issueModels: + type: array + items: + type: string description: >- - The boundary in the conversation where the annotation starts, - inclusive. - issueMatchData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: Data specifying an issue match. - sentimentData: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Data specifying sentiment. - annotationEndBoundary: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary + The issue model to run. If not provided, the most recently deployed + topic model will be used. The provided issue model will only be used + for inference if the issue model is deployed and if + run_issue_model_annotator is set to true. If more than one issue + model is provided, only the first provided issue model will be used + for inference. + runIssueModelAnnotator: + type: boolean description: >- - The boundary in the conversation where the annotation ends, - inclusive. - intentMatchData: - description: Data specifying an intent match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - interruptionData: - description: Data specifying an interruption. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InterruptionData - phraseMatchData: - description: Data specifying a phrase match. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - silenceData: + Whether to run the issue model annotator. A model should have + already been deployed for this to take effect. + runSummarizationAnnotator: + description: Whether to run the summarization annotator. + type: boolean + summarizationConfig: + description: Configuration for the summarization annotator. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SilenceData - description: Data specifying silence. - channelTag: - format: int32 - type: integer + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + runSentimentAnnotator: + type: boolean + description: Whether to run the sentiment annotator. + runInterruptionAnnotator: + type: boolean + description: Whether to run the interruption annotator. + runPhraseMatcherAnnotator: + description: Whether to run the active phrase matcher annotator(s). + type: boolean + runIntentAnnotator: + description: Whether to run the intent annotator. + type: boolean + phraseMatchers: + items: + type: string + type: array description: >- - The channel of the audio where the annotation occurs. For - single-channel audio, this field is not populated. - holdData: - description: Data specifying a hold. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1HoldData - entityMentionData: - description: Data specifying an entity mention. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EntityMentionData - description: A piece of metadata that applies to a window of a call. - id: GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet: - description: Snippet Source for a Generative Prediction. + The list of phrase matchers to run. If not provided, all active + phrase matchers will be used. If inactive phrase matchers are + provided, they will not be used. Phrase matchers will be run only if + run_phrase_matcher_annotator is set to true. Format: + projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} + runSilenceAnnotator: + type: boolean + description: Whether to run the silence annotator. + description: Selector of all available annotators and phrase matchers to run. + id: GoogleCloudContactcenterinsightsV1AnnotatorSelector + GoogleCloudContactcenterinsightsV1GcsSource: properties: - text: - description: text taken from that URI. - type: string - document: + audioUri: type: string description: >- - Indicates which Knowledge Document this snippet was extracted from. - Format: `projects//knowledgeBases//documents/`. - uri: - type: string - description: URI the data is sourced from. - title: - type: string - description: Title of the document. - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet - type: object - GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection: - properties: - section: - type: string - description: Required. Name of the section. - summary: + Cloud Storage URI that points to a file that contains the + conversation audio. + transcriptUri: type: string - description: Required. Summary text for the section. + description: >- + Immutable. Cloud Storage URI that points to a file that contains the + conversation transcript. + id: GoogleCloudContactcenterinsightsV1GcsSource type: object - description: A component of the generated summary. - id: GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection - GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: - id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig + description: A Cloud Storage source of conversation data. + GoogleCloudContactcenterinsightsV1alpha1SentimentData: + id: GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: The data for a sentiment annotation. properties: - runtimeIntegrationAnalysisPercentage: - type: number - description: >- - Percentage of conversations created using Dialogflow runtime - integration to analyze automatically, between [0, 100]. - format: double - uploadConversationAnalysisPercentage: + score: + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + format: float type: number - format: double - description: >- - Percentage of conversations created using the UploadConversation - endpoint to analyze automatically, between [0, 100]. - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector + magnitude: + type: number + format: float description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - description: Default configuration when creating Analyses in Insights. + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. type: object - GoogleLongrunningOperation: + GoogleCloudContactcenterinsightsV1CalculateStatsResponse: type: object - id: GoogleLongrunningOperation + description: The response for calculating conversation statistics. + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse properties: - name: + smartHighlighterMatches: + type: object + additionalProperties: + format: int32 + type: integer description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - done: - type: boolean + A map associating each smart highlighter display name with its + respective number of matches in the set of conversations. + customHighlighterMatches: + additionalProperties: + type: integer + format: int32 description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: + A map associating each custom highlighter resource name with its + respective number of matches in the set of conversations. + type: object + conversationCount: + format: int32 + description: The total number of conversations. + type: integer + issueMatchesStats: additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + description: >- + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` type: object + conversationCountTimeSeries: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - metadata: + A time series representing the count of conversations created over + time that match that requested filter criteria. + averageTurnCount: + format: int32 + description: The average number of turns per conversation. + type: integer + averageDuration: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. + The average duration of all conversations. The average is calculated + using only conversations that have a time duration. + type: string + format: google-duration + issueMatches: type: object additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - error: - $ref: '#/components/schemas/GoogleRpcStatus' + format: int32 + type: integer description: >- - The error result of the operation in case of failure or - cancellation. + A map associating each issue resource name with its respective + number of matches in the set of conversations. Key has the format: + `projects//locations//issueModels//issues/` Deprecated, use + `issue_matches_stats` field instead. + deprecated: true + GoogleProtobufEmpty: + type: object description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleCloudContactcenterinsightsV1SpeechConfig: + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + properties: {} + id: GoogleProtobufEmpty + GoogleCloudContactcenterinsightsV1alpha1IssueModelResult: type: object - id: GoogleCloudContactcenterinsightsV1SpeechConfig + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelResult + description: Issue Modeling result on a conversation. properties: - speechRecognizer: + issueModel: + description: >- + Issue model that generates the result. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} type: string + issues: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment + type: array + description: All the matched issues. + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: + id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript + description: A message representing the transcript of a conversation. + type: object + properties: + transcriptSegments: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` - description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the UploadConversation and - IngestConversations endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - CreateConversation endpoint. - GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata: + A list of sequential transcript segments that comprise the + conversation. + type: array + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata: + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. type: object properties: - createTime: + endTime: + description: Output only. The time the operation finished running. + readOnly: true format: google-datetime - description: The time the operation was created. type: string - endTime: + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Partial errors during initialising operation that might cause the + operation output to be incomplete. + type: array + createTime: type: string - description: The time the operation finished running. format: google-datetime + readOnly: true + description: Output only. The time the operation was created. request: - description: The original import request. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - description: Metadata used for import issue model. - id: GoogleCloudContactcenterinsightsV1ImportIssueModelMetadata - GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse: - type: object - properties: - currentStats: - description: >- - The latest label statistics for the queried issue model. Includes - results on both training data and data labeled after deployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats - id: GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse - description: Response of querying an issue model's statistics. - GoogleCloudContactcenterinsightsV1AgentCoachingInstruction: + #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest + readOnly: true + description: Output only. The original request for initialization. + GoogleCloudContactcenterinsightsV1View: type: object - description: Agent Coaching instructions that customer can configure. + id: GoogleCloudContactcenterinsightsV1View + description: The View resource. properties: - displayName: - description: Optional. Display name for the instruction. + value: type: string - systemAction: + description: String with specific view properties, must be non-empty. + name: description: >- - Optional. The action that system should take. For example, "call - GetOrderTime with order_number={order number provided by the - customer}". If the users don't have plugins or don't want to trigger - plugins, the system_action can be empty + Immutable. The resource name of the view. Format: + projects/{project}/locations/{location}/views/{view} type: string - condition: - description: >- - Optional. The condition of the instruction. For example, "the - customer wants to cancel an order". If the users want the - instruction to be triggered unconditionally, the condition can be - empty. + displayName: type: string - metadata: - type: object - description: Optional. Additional information attached to this instruction. - additionalProperties: - type: string - description: - description: Optional. The detailed description of this instruction. + description: The human-readable display name of the view. + createTime: + readOnly: true + description: Output only. The time at which this view was created. + format: google-datetime type: string - agentAction: + updateTime: type: string - description: >- - Optional. The action that human agent should take. For example, - "apologize for the slow shipping". If the users only want to use - agent coaching for intent detection, agent_action can be empty - id: GoogleCloudContactcenterinsightsV1AgentCoachingInstruction - GoogleCloudContactcenterinsightsV1SentimentData: - type: object - id: GoogleCloudContactcenterinsightsV1SentimentData + description: Output only. The most recent time at which the view was updated. + format: google-datetime + readOnly: true + GoogleCloudContactcenterinsightsV1CallAnnotation: properties: - magnitude: + issueMatchData: + description: Data specifying an issue match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueMatchData + silenceData: + description: Data specifying silence. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SilenceData' + channelTag: + type: integer + format: int32 description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. - format: float - type: number - score: - type: number - format: float - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - description: The data for a sentiment annotation. - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript: - properties: - transcriptSegments: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment - description: >- - A list of sequential transcript segments that comprise the - conversation. - type: object - description: A message representing the transcript of a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: - type: object - description: Metadata from Dialogflow relating to the current transcript segment. - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - properties: - smartReplyAllowlistCovered: - description: >- - Whether the transcript segment was covered under the configured - smart reply allowlist in Agent Assist. - type: boolean - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse: - description: Response for an export insights operation. - properties: {} - type: object - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse - GoogleCloudContactcenterinsightsV1RuntimeAnnotation: - description: >- - An annotation that was generated during the customer and agent - interaction. - id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation - properties: - articleSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData - description: Agent Assist Article Suggestion data. - faqAnswer: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' - description: Agent Assist FAQ answer data. - smartReply: - description: Agent Assist Smart Reply data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData - dialogflowInteraction: - description: Dialogflow interaction data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData - smartComposeSuggestion: - description: Agent Assist Smart Compose suggestion data. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData - conversationSummarizationSuggestion: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData - description: Conversation summarization suggestion data. - endBoundary: + The channel of the audio where the annotation occurs. For + single-channel audio, this field is not populated. + phraseMatchData: + description: Data specifying a phrase match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + annotationEndBoundary: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary description: >- The boundary in the conversation where the annotation ends, inclusive. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary - createTime: - format: google-datetime - description: The time at which this annotation was created. - type: string - knowledgeSearchResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer - description: The Knowledge Search result. - annotationId: - description: >- - The unique identifier of the annotation. Format: - projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} - type: string - answerFeedback: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback - description: The feedback that the customer has about the answer in `data`. - knowledgeAssistResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse - description: The Knowledge Assist result. - generatorSuggestionResult: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetGeneratorSuggestionResponse - description: The generator suggestion result. - startBoundary: + annotationStartBoundary: description: >- The boundary in the conversation where the annotation starts, inclusive. $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + entityMentionData: + description: Data specifying an entity mention. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EntityMentionData + holdData: + description: Data specifying a hold. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1HoldData' + interruptionData: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1InterruptionData + description: Data specifying an interruption. + sentimentData: + description: Data specifying sentiment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + intentMatchData: + description: Data specifying an intent match. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IntentMatchData + id: GoogleCloudContactcenterinsightsV1CallAnnotation + description: A piece of metadata that applies to a window of a call. type: object - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: - description: A BigQuery Table Reference. - type: object + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData: + description: Conversation summarization suggestion data. properties: - projectId: + answerRecord: type: string description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. - table: + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + textSections: + description: >- + The summarization content that is divided into sections. The key is + the section's name and the value is the section's content. There is + no specific format for the key or value. + type: object + additionalProperties: + type: string + text: type: string + description: The summarization content that is concatenated into one string. + confidence: + type: number + format: float + description: The confidence score of the summarization. + metadata: + additionalProperties: + type: string description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. - dataset: + A map that contains metadata about the summarization and the + document from which it originates. + type: object + conversationModel: description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. + The name of the model that generates this summary. Format: + projects/{project}/locations/{location}/conversationModels/{conversation_model} type: string id: >- - GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination - GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination: - properties: - objectUri: - type: string - description: 'Required. Format: `gs:///`' - description: Google Cloud Storage Object URI to save the issue model to. + GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData type: object - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - GoogleCloudContactcenterinsightsV1CreateIssueModelRequest: - description: The request to create an issue model. + GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata: + description: Metadata for deploying an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelMetadata type: object properties: - issueModel: - description: Required. The issue model to create. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' - parent: + createTime: + description: Output only. The time the operation was created. + format: google-datetime + readOnly: true type: string - description: Required. The parent resource of the issue model. - id: GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource: - properties: - snippets: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet - description: >- - All snippets used for this Generative Prediction, with their source - URI and data. - description: Details about source of Generative answer. - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - type: object - GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource: + request: + description: The original request for deployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + endTime: + type: string + format: google-datetime + readOnly: true + description: Output only. The time the operation finished running. + GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant: + description: The call participant speaking for a given utterance. + id: GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant type: object properties: - objectUri: - description: 'Required. Format: `gs:///`' + dialogflowParticipantName: type: string - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - description: Google Cloud Storage Object URI to get the issue model file from. - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse: - properties: - suggestedQueryAnswer: description: >- - The answer generated for the suggested query. Whether or not an - answer is generated depends on how confident we are about the - generated query. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer - suggestedQuery: + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + dialogflowParticipant: + deprecated: true + type: string description: >- - The query suggested based on the context. Suggestion is made only if - it is different from the previous suggestion. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery - description: >- - Response for Knowledge Assist. Contains suggested query and optionally - includes an answer for the query. - type: object - id: GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponse - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: - properties: {} + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + obfuscatedExternalUserId: + description: Obfuscated user ID from Dialogflow. + type: string + role: + type: string + description: The role of the participant. + enumDescriptions: + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + userId: + type: string + description: A user-specified ID representing the participant. + GoogleCloudContactcenterinsightsV1alpha1Intent: + id: GoogleCloudContactcenterinsightsV1alpha1Intent type: object - description: Response from import issue model - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse: description: >- - Sample response that the agent can use. This could be based on - applicable instructions and ingested data from other systems. + The data for an intent. Represents a detected intent in the + conversation, for example MAKES_PROMISE. properties: - responseText: + displayName: + description: The human-readable name of the intent. type: string - description: Optional. Sample response for Agent in text. - type: object - id: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery: - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseSuggestedQuery - description: Represents a suggested query. - type: object - properties: - score: - format: float - description: Suggested query score. - type: number - queryText: + id: type: string - description: Suggested query text. - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse - description: The response for a bulk delete conversations operation. - type: object - properties: {} - GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: + description: The unique identifier of the intent. + GoogleCloudContactcenterinsightsV1ConversationParticipant: properties: - sentiment: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Sentiment expressed for this mention of the entity. - type: + obfuscatedExternalUserId: type: string + description: Obfuscated user ID from Dialogflow. + role: enumDescriptions: - - Unspecified. - - Proper noun. - - Common noun (or noun compound). - description: The type of the entity mention. - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON - entityUniqueId: - type: string + - Participant's role is not set. + - Participant is a human agent. + - Participant is an automated agent. + - Participant is an end user who conversed with the contact center. + - Participant is either a human or automated agent. + description: The role of the participant. + type: string + enum: + - ROLE_UNSPECIFIED + - HUMAN_AGENT + - AUTOMATED_AGENT + - END_USER + - ANY_AGENT + userId: + description: A user-specified ID representing the participant. + type: string + dialogflowParticipant: + type: string + deprecated: true description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. + Deprecated. Use `dialogflow_participant_name` instead. The name of + the Dialogflow participant. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + dialogflowParticipantName: + type: string + description: >- + The name of the participant provided by Dialogflow. Format: + projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} + description: The call participant speaking for a given utterance. + id: GoogleCloudContactcenterinsightsV1ConversationParticipant type: object - id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - GoogleCloudContactcenterinsightsV1InterruptionData: - id: GoogleCloudContactcenterinsightsV1InterruptionData + GoogleCloudContactcenterinsightsV1alpha1HoldData: properties: {} + description: The data for a hold annotation. + id: GoogleCloudContactcenterinsightsV1alpha1HoldData type: object - description: The data for an interruption annotation. - GoogleCloudContactcenterinsightsV1alpha1AnalysisResult: - id: GoogleCloudContactcenterinsightsV1alpha1AnalysisResult - type: object - description: The result of an analysis. + GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec: properties: - callAnalysisMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - description: Call-specific metadata created by the analysis. - endTime: + kmsKey: + type: string + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + name: + description: >- + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec type: string - description: The time at which the analysis ended. - format: google-datetime - GoogleCloudContactcenterinsightsV1alpha1Conversation: type: object - id: GoogleCloudContactcenterinsightsV1alpha1Conversation + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + id: GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata: properties: + request: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest + description: The original import request. createTime: format: google-datetime - readOnly: true - type: string - description: Output only. The time at which the conversation was created. - latestAnalysis: - description: Output only. The conversation's latest analysis, if one exists. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Analysis - name: - type: string - description: >- - Immutable. The resource name of the conversation. Format: - projects/{project}/locations/{location}/conversations/{conversation} - transcript: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscript - description: Output only. The conversation transcript. - expireTime: type: string + description: The time the operation was created. + endTime: format: google-datetime - description: >- - The time at which this conversation should expire. After this time, - the conversation data and any associated analyses will be deleted. - dialogflowIntents: - readOnly: true - description: >- - Output only. All the matched Dialogflow intents in the call. The key - corresponds to a Dialogflow intent, format: - projects/{project}/agent/{agent}/intents/{intent} - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - type: object - duration: - type: string - format: google-duration - description: Output only. The duration of the conversation. - readOnly: true - languageCode: type: string - description: A user-specified language code for the conversation. - dataSource: + description: The time the operation finished running. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelMetadata + description: Metadata used for import issue model. + GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata: + type: object + description: Metadata used for export issue model. + properties: + request: + description: The original export request. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationDataSource - description: The source of the audio and transcription for the conversation. - obfuscatedUserId: + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + createTime: + description: The time the operation was created. type: string - description: Obfuscated user ID which the customer sent to us. - startTime: + format: google-datetime + endTime: type: string + description: The time the operation finished running. format: google-datetime - description: The time at which the conversation started. - latestSummary: - readOnly: true - description: Output only. Latest summary of the conversation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationSummarizationSuggestionData - labels: - type: object + id: GoogleCloudContactcenterinsightsV1ExportIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData: + type: object + properties: + metadata: description: >- - A map for the user to specify any custom fields. A maximum of 20 - labels per conversation is allowed, with a maximum of 256 characters - per entry. + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + type: object additionalProperties: type: string - turnCount: - type: integer - readOnly: true - description: Output only. The number of turns in the conversation. - format: int32 - runtimeAnnotations: - readOnly: true - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RuntimeAnnotation - type: array - description: >- - Output only. The annotations that were generated during the customer - and agent interaction. - updateTime: - description: >- - Output only. The most recent time at which the conversation was - updated. - readOnly: true + suggestion: type: string - format: google-datetime - callMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata - description: Call-specific metadata. - agentId: - description: >- - An opaque, user-specified string representing the human agent who - handled the conversation. + description: The content of the suggestion. + queryRecord: type: string - ttl: description: >- - Input only. The TTL for this resource. If specified, then this TTL - will be used to calculate the expire time. - format: google-duration - type: string - medium: - type: string - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + confidenceScore: + type: number description: >- - Immutable. The conversation medium, if unspecified will default to - PHONE_CALL. - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - qualityMetadata: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - description: Conversation metadata related to quality management. - description: The conversation resource. - GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadata - description: Conversation metadata related to quality management. + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + format: double + description: Agent Assist Smart Compose suggestion data. + id: GoogleCloudContactcenterinsightsV1alpha1SmartComposeSuggestionData + GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse: + description: The response to initialize a location-level encryption specification. + type: object + id: GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse + properties: {} + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse: + properties: {} + type: object + description: Response from import issue model + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse + GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput: + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + type: object properties: - customerSatisfactionRating: - type: integer - format: int32 + generatorName: description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - menuPath: + The resource name of associated generator. Format: + `projects//locations//generators/` + type: string + querySource: + description: Query source for the answer. + enumDescriptions: + - Unknown query source. + - The query is from agents. + - >- + The query is a query from previous suggestions, e.g. from a + preceding SuggestKnowledgeAssist response. + enum: + - QUERY_SOURCE_UNSPECIFIED + - AGENT_QUERY + - SUGGESTED_QUERY type: string + query: description: >- - An arbitrary string value specifying the menu path the customer - took. - waitDuration: - description: The amount of time the customer waited to connect with an agent. - format: google-duration + Query text. Article Search uses this to store the input query used + to generate the search results. type: string - agentInfo: - type: array - description: Information about agents involved in the call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo - type: object - GoogleCloudContactcenterinsightsV1IssueModelResult: + description: Explicit input used for generating the answer + GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest: type: object - description: Issue Modeling result on a conversation. - id: GoogleCloudContactcenterinsightsV1IssueModelResult + id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest properties: - issueModel: - description: >- - Issue model that generates the result. Format: - projects/{project}/locations/{location}/issueModels/{issue_model} + parent: type: string - issues: - type: array - description: All the matched issues. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueAssignment - GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats: - type: object - properties: - analyzedConversationsCount: - format: int64 + description: Required. The parent resource to export data from. + writeDisposition: + enumDescriptions: + - Write disposition is not specified. Defaults to WRITE_TRUNCATE. + - >- + If the table already exists, BigQuery will overwrite the table + data and use the schema from the load. + - >- + If the table already exists, BigQuery will append data to the + table. + type: string + enum: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND + description: Options for what to do if the destination table already exists. + bigQueryDestination: + description: Specified if sink is a BigQuery table. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + filter: type: string description: >- - Number of conversations the issue model has analyzed at this point - in time. - unclassifiedConversationsCount: + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. + kmsKey: type: string - format: int64 description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. - issueStats: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats - description: Statistics on each issue. Key is the issue's resource name. - type: object - description: Aggregated statistics about an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats - GoogleCloudContactcenterinsightsV1alpha1SentimentData: + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + description: The request to export insights. + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination: type: object - id: GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: The data for a sentiment annotation. + description: A BigQuery Table Reference. + id: >- + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination properties: - magnitude: + table: description: >- - A non-negative number from 0 to infinity which represents the - abolute magnitude of sentiment regardless of score. - format: float - type: number - score: - description: The sentiment score between -1.0 (negative) and 1.0 (positive). - format: float - type: number - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence: - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence - type: object + The BigQuery table name to which the insights data should be + written. If this table does not exist, the export call returns an + INVALID_ARGUMENT error. + type: string + projectId: + type: string + description: >- + A project ID or number. If specified, then export will attempt to + write data to this project instead of the resource project. + Otherwise, the resource project will be used. + dataset: + description: >- + Required. The name of the BigQuery dataset that the snapshot result + should be exported to. If this dataset does not exist, the export + call returns an INVALID_ARGUMENT error. + type: string + GoogleCloudContactcenterinsightsV1ConversationLevelSilence: description: Conversation-level silence data. + id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence properties: silenceDuration: - type: string - description: Amount of time calculated to be in silence. format: google-duration + description: Amount of time calculated to be in silence. + type: string silencePercentage: type: number description: Percentage of the total conversation spent in silence. format: float - GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: + type: object + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig: properties: - conversation: - description: Required. The conversation resource to create. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation - redactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: >- - Optional. DLP settings for transcript redaction. Will default to the - config specified in Settings. - parent: + medium: type: string - description: Required. The parent resource of the conversation. - conversationId: + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + description: Required. The medium transcript objects represent. + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. + type: object + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestTranscriptObjectConfig + description: Configuration for processing transcript objects. + GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: + type: object + description: Aggregated statistics about an issue. + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + properties: + labeledConversationsCount: + description: Number of conversations attached to the issue at this point in time. type: string + format: int64 + issue: description: >- - Optional. A unique ID for the new conversation. This ID will become - the final component of the conversation's resource name. If no ID is - specified, a server-generated ID will be used. This value should be - 4-64 characters and must match the regular expression - `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` - speechConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - description: >- - Optional. Speech-to-Text configuration. Will default to the config - specified in Settings. - description: Request to upload a conversation. - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - type: object - GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata: - description: Metadata for creating an issue model. + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + type: string + displayName: + description: Display name of the issue. + type: string + GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: + description: The metadata for a bulk analyze conversations operation. properties: + completedAnalysesCount: + type: integer + description: >- + The number of requested analyses that have completed successfully so + far. + format: int32 request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CreateIssueModelRequest - description: The original request for creation. - createTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest + description: The original request for bulk analyze. + partialErrors: readOnly: true + items: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + Output only. Partial errors during bulk analyze operation that might + cause the operation output to be incomplete. + type: array + failedAnalysesCount: + format: int32 + type: integer + description: The number of requested analyses that have failed so far. + createTime: format: google-datetime type: string - description: Output only. The time the operation was created. + description: The time the operation was created. endTime: + description: The time the operation finished running. type: string - readOnly: true - description: Output only. The time the operation finished running. format: google-datetime - type: object - id: GoogleCloudContactcenterinsightsV1CreateIssueModelMetadata - GoogleCloudContactcenterinsightsV1DeployIssueModelResponse: - properties: {} - id: GoogleCloudContactcenterinsightsV1DeployIssueModelResponse - type: object - description: The response to deploy an issue model. - GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: - description: >- - The data for an intent match. Represents an intent match for a text - segment in the conversation. A text segment can be part of a sentence, a - complete sentence, or an utterance with multiple sentences. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData - properties: - intentUniqueId: - type: string + totalRequestedAnalysesCount: + type: integer description: >- - The id of the matched intent. Can be used to retrieve the - corresponding intent information. - GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData: - id: GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData - description: Agent Assist frequently-asked-question answer data. + Total number of analyses requested. Computed by the number of + conversations returned by `filter` multiplied by + `analysis_percentage` in the request. + format: int32 + id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata + type: object + GoogleCloudContactcenterinsightsV1alpha1SmartReplyData: + id: GoogleCloudContactcenterinsightsV1alpha1SmartReplyData type: object properties: - metadata: - additionalProperties: - type: string + queryRecord: description: >- - Map that contains metadata about the FAQ answer and the document - that it originates from. - type: object - question: + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} type: string - description: The corresponding FAQ question. confidenceScore: - format: float type: number description: >- - The system's confidence score that this answer is a good match for + The system's confidence score that this reply is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain). - answer: - type: string - description: The piece of text from the `source` knowledge base document. - queryRecord: - description: >- - The name of the answer record. Format: - projects/{project}/locations/{location}/answerRecords/{answer_record} - type: string - source: + format: double + reply: + description: The content of the reply. type: string + metadata: + type: object description: >- - The knowledge document that this answer was extracted from. Format: - projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}. - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning: + Map that contains metadata about the Smart Reply and the document + from which it originates. + additionalProperties: + type: string + description: Agent Assist Smart Reply data. + GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: type: object + description: Request to import an issue model. + id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest properties: - issueSummary: - type: string - description: Optional. Summary of the issue. - agentActionTaken: - description: Optional. The actions that the agent has taken already. - type: string - id: >- - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - description: Reasoning for the suggestion. - GoogleCloudContactcenterinsightsV1ExportIssueModelRequest: - id: GoogleCloudContactcenterinsightsV1ExportIssueModelRequest - type: object - properties: - name: - description: Required. The issue model to export - type: string - gcsDestination: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequestGcsDestination - description: Google Cloud Storage URI to export the Issue Model to. - description: Request to export an issue model. - GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment: - description: One channel of conversation-level sentiment data. - properties: - sentimentData: + gcsSource: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - description: Data specifying sentiment. - channelTag: - description: The channel of the audio that the data applies to. - format: int32 - type: integer - id: GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - type: object - GoogleCloudContactcenterinsightsV1FreeFormSuggestion: - id: GoogleCloudContactcenterinsightsV1FreeFormSuggestion - description: Suggestion generated using free form generator. - type: object - properties: - labels: - type: array - description: Optional. Labels for the generator. - items: - type: string - response: + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource + description: Google Cloud Storage source message. + parent: type: string - description: Required. Free form suggestion. - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata: + description: Required. The parent resource of the issue model. + createNewModel: + type: boolean + description: >- + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. + GoogleCloudContactcenterinsightsV1IssueModel: properties: + languageCode: + type: string + description: Language of the model. createTime: readOnly: true - description: Output only. The time the operation was created. + description: Output only. The time at which this issue model was created. type: string format: google-datetime - endTime: - format: google-datetime + updateTime: type: string readOnly: true - description: Output only. The time the operation finished running. - partialErrors: + format: google-datetime description: >- - Partial errors during export operation that might cause the - operation output to be incomplete. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - request: - description: The original request for export. + Output only. The most recent time at which the issue model was + updated. + inputDataConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequest - id: GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataMetadata - type: object - description: Metadata for an export insights operation. - GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse: - type: object - id: GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse - description: Response for an export insights operation. - properties: {} - GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: - properties: - speechRecognizer: + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelInputDataConfig + description: Configs for the input data that used to create the issue model. + name: + type: string description: >- - The fully-qualified Speech Recognizer resource name. Format: - `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + issueCount: + format: int64 + readOnly: true + description: Output only. Number of issues in this issue model. type: string - type: object - id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig - description: >- - Speech-to-Text configuration. Speech-to-Text settings are applied to - conversations ingested from the UploadConversation and - IngestConversations endpoints, including conversation coming from CCAI - Platform. They are not applied to conversations ingested from the - CreateConversation endpoint. - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer: - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswer - type: object - properties: - intentMatchingSource: - description: Populated if the prediction was from intent matching. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource - generativeSource: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - description: Populated if the prediction was Generative. - faqSource: + state: + readOnly: true + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + type: string + enumDescriptions: + - Unspecified. + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. + description: Output only. State of the model. + trainingStats: + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Populated if the prediction came from FAQ. - answerText: + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStats description: >- - The piece of text from the `source` that answers this suggested - query. + Output only. Immutable. The issue model's label statistics on its + training data. + modelType: + description: Type of the model. + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 type: string - matchConfidence: - description: >- - The system's confidence score that this answer is a good match for - this conversational query. The range is from 0.0 (completely - uncertain) to 1.0 (completely certain). - type: number - format: float - description: >- - Represents an answer from Knowledge. Cuurently supports FAQ and - Generative answers. - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery: - description: Represents a suggested query. - type: object - properties: - score: - type: number - description: Suggested query score. - format: float - queryText: - description: Suggested query text. + displayName: + description: The representative name for the issue model. type: string - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseSuggestedQuery - GoogleProtobufEmpty: - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object - id: GoogleProtobufEmpty - GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata: + description: The issue model resource. + id: GoogleCloudContactcenterinsightsV1IssueModel + GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata: + type: object properties: - createTime: - readOnly: true - description: Output only. The time the operation was created. - format: google-datetime - type: string - analysisOperation: - readOnly: true + conversation: description: >- - Output only. The operation name for a successfully created analysis - operation, if any. + Output only. The Conversation that this Analysis Operation belongs + to. type: string - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest - readOnly: true - description: Output only. The original request. - appliedRedactionConfig: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig - description: >- - Output only. The redaction config applied to the uploaded - conversation. readOnly: true endTime: + readOnly: true + type: string format: google-datetime description: Output only. The time the operation finished running. + annotatorSelector: + readOnly: true + description: Output only. The annotator selector used for the analysis (if any). + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector + createTime: readOnly: true + description: Output only. The time the operation was created. + format: google-datetime type: string - description: The metadata for an UploadConversation operation. - id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationMetadata - type: object - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval: + description: Metadata for a create analysis operation. + id: GoogleCloudContactcenterinsightsV1alpha1CreateAnalysisOperationMetadata + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo: properties: - sampleResponseEval: + agentId: + type: string + description: A user-specified string representing the agent. + team: + type: string + description: A user-specified string representing the agent's team. + displayName: type: string - description: Optional. Eval for sample response. - actionActionSuggestionEval: + description: The agent's name. + dispositionCode: + description: >- + A user-provided string indicating the outcome of the agent's segment + of the call. type: string - description: Optional. Eval for Agent action suggestion. + type: object id: >- - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval + GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo + description: Information about an agent involved in the conversation. + GoogleCloudContactcenterinsightsV1ConversationLevelSentiment: + properties: + channelTag: + format: int32 + description: The channel of the audio that the data applies to. + type: integer + sentimentData: + description: Data specifying sentiment. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' + id: GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + description: One channel of conversation-level sentiment data. type: object - description: Self evaluations of the suggestion. - GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer: + GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest: type: object + description: Request to upload a conversation. + id: GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest properties: - answerSources: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswerAnswerSource - type: array - description: All sources used to generate the answer. - answerType: - enum: - - ANSWER_TYPE_UNSPECIFIED - - FAQ - - GENERATIVE - - INTENT - description: The type of the answer. - type: string - enumDescriptions: - - The answer has a unspecified type. - - The answer is from FAQ documents. - - The answer is from generative model. - - The answer is from intent matching. - answer: - type: string + redactionConfig: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1RedactionConfig description: >- - The piece of text from the knowledge base documents that answers the - search query - confidenceScore: - type: number - format: float - description: The confidence score in [0.0, 1.0] range. - answerRecord: + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + speechConfig: + description: >- + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + conversationId: type: string description: >- - The name of the answer record. Format: `projects//locations//answer - Records/` - id: GoogleCloudContactcenterinsightsV1alpha1SearchKnowledgeAnswer - description: Represents a SearchKnowledge answer. - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata: - description: The metadata for a bulk analyze conversations operation. - properties: - partialErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - readOnly: true - description: >- - Output only. Partial errors during bulk analyze operation that might - cause the operation output to be incomplete. - type: array - failedAnalysesCount: - description: The number of requested analyses that have failed so far. - format: int32 - type: integer - totalRequestedAnalysesCount: - type: integer - format: int32 - description: >- - Total number of analyses requested. Computed by the number of - conversations returned by `filter` multiplied by - `analysis_percentage` in the request. - request: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - description: The original request for bulk analyze. - completedAnalysesCount: - type: integer - format: int32 - description: >- - The number of requested analyses that have completed successfully so - far. - endTime: - format: google-datetime - description: The time the operation finished running. - type: string - createTime: - format: google-datetime - type: string - description: The time the operation was created. - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata - type: object - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: - type: object - properties: - gcsSource: + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` + conversation: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - description: Google Cloud Storage source message. + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Conversation + description: Required. The conversation resource to create. parent: + description: Required. The parent resource of the conversation. type: string - description: Required. The parent resource of the issue model. - createNewModel: - description: >- - Optional. If set to true, will create a new issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. - type: boolean - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest - description: Request to import an issue model. - GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelMetadata + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: type: object - description: Metadata for creating an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse + properties: {} + description: The response to an IngestConversations operation. + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata: properties: - request: - description: The original request for creation. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The time the operation was created. endTime: format: google-datetime - type: string readOnly: true description: Output only. The time the operation finished running. - GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata: - id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata - properties: - createTime: type: string - description: Output only. The time the operation was created. - readOnly: true - format: google-datetime request: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest - description: The original request for deletion. - endTime: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest readOnly: true - description: Output only. The time the operation finished running. - type: string - format: google-datetime - description: Metadata for deleting an issue model. - type: object - GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats: - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - description: Aggregated statistics about an issue. - properties: - labeledConversationsCount: - format: int64 - description: Number of conversations attached to the issue at this point in time. - type: string - displayName: - type: string - description: Display name of the issue. - issue: + description: Output only. The original request for initialization. + partialErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Issue resource. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} + Partial errors during initialising operation that might cause the + operation output to be incomplete. + type: array + createTime: type: string + description: Output only. The time the operation was created. + format: google-datetime + readOnly: true type: object - GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion: - id: GoogleCloudContactcenterinsightsV1AgentCoachingSuggestion - description: Suggestion for coaching agents. + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. + GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest: + description: The request to initialize a location-level encryption specification. properties: - agentActionSuggestions: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentActionSuggestion - type: array - description: Optional. Suggested actions for the agent to take. - sampleResponses: - description: Optional. Sample response for the Agent. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionSampleResponse - type: array - applicableInstructions: - description: Optional. Instructions applicable based on the current context. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingInstruction - type: array - suggestionReasoning: - description: Reasoning for the suggestion. + encryptionSpec: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - suggestionEval: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AgentCoachingSuggestionAgentCoachingSuggestionEval - description: Self evaluation of the suggestion. - type: object - GoogleCloudContactcenterinsightsV1ConversationQualityMetadata: + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. + id: GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest type: object - description: Conversation metadata related to quality management. + GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData: + description: Agent Assist Smart Compose suggestion data. properties: - agentInfo: - description: Information about agents involved in the call. - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - type: array - customerSatisfactionRating: - type: integer - format: int32 - description: >- - An arbitrary integer value indicating the customer's satisfaction - rating. - menuPath: + suggestion: type: string - description: >- - An arbitrary string value specifying the menu path the customer - took. - waitDuration: + description: The content of the suggestion. + queryRecord: type: string - description: The amount of time the customer waited to connect with an agent. - format: google-duration - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadata - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse: - id: GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse - properties: {} - description: Response from export issue model - type: object - GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion: - type: object - id: GoogleCloudContactcenterinsightsV1alpha1FreeFormSuggestion - description: Suggestion generated using free form generator. - properties: - labels: - items: + description: >- + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + confidenceScore: + format: double + type: number + description: >- + The system's confidence score that this suggestion is a good match + for this conversation, ranging from 0.0 (completely uncertain) to + 1.0 (completely certain). + metadata: + type: object + additionalProperties: type: string - type: array - description: Optional. Labels for the generator. - response: - description: Required. Free form suggestion. - type: string - GoogleCloudContactcenterinsightsV1PhraseMatcher: - description: The phrase matcher resource. - id: GoogleCloudContactcenterinsightsV1PhraseMatcher + description: >- + Map that contains metadata about the Smart Compose suggestion and + the document from which it originates. + id: GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + type: object + GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest: + id: GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + description: The request to export insights. type: object properties: - type: + kmsKey: type: string - description: Required. The type of this phrase matcher. + description: >- + A fully qualified KMS key name for BigQuery tables protected by + CMEK. Format: + projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version} + bigQueryDestination: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequestBigQueryDestination + description: Specified if sink is a BigQuery table. + writeDisposition: + description: Options for what to do if the destination table already exists. enumDescriptions: - - Unspecified. - - Must meet all phrase match rule groups or there is no match. - - If any of the phrase match rule groups are met, there is a match. + - Write disposition is not specified. Defaults to WRITE_TRUNCATE. + - >- + If the table already exists, BigQuery will overwrite the table + data and use the schema from the load. + - >- + If the table already exists, BigQuery will append data to the + table. enum: - - PHRASE_MATCHER_TYPE_UNSPECIFIED - - ALL_OF - - ANY_OF - versionTag: + - WRITE_DISPOSITION_UNSPECIFIED + - WRITE_TRUNCATE + - WRITE_APPEND type: string + parent: + type: string + description: Required. The parent resource to export data from. + filter: description: >- - The customized version tag to use for the phrase matcher. If not - specified, it will default to `revision_id`. - activationUpdateTime: - description: >- - Output only. The most recent time at which the activation status was - updated. - format: google-datetime - readOnly: true + A filter to reduce results to a specific subset. Useful for + exporting conversations with specific properties. type: string + GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest: + description: The request to undeploy an issue model. + properties: name: type: string - description: >- - The resource name of the phrase matcher. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - phraseMatchRuleGroups: - description: A list of phase match rule groups that are included in this matcher. + description: Required. The issue model to undeploy. + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + type: object + GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries: + properties: + points: items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleGroup - type: array - revisionCreateTime: - format: google-datetime - readOnly: true + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval description: >- - Output only. The timestamp of when the revision was created. It is - also the create time when a new matcher is added. - type: string - roleMatch: - description: >- - The role whose utterances the phrase matcher should be matched - against. If the role is ROLE_UNSPECIFIED it will be matched against - any utterances in the transcript. - type: string - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - updateTime: - readOnly: true - type: string - description: >- - Output only. The most recent time at which the phrase matcher was - updated. - format: google-datetime - active: - type: boolean - description: Applies the phrase matcher only when it is active. - displayName: - type: string - description: The human-readable name of the phrase matcher. - revisionId: - description: >- - Output only. Immutable. The revision ID of the phrase matcher. A new - revision is committed whenever the matcher is changed, except when - it is activated or deactivated. A server generated random ID will be - used. Example: - locations/global/phraseMatchers/my-first-matcher@1234567 + An ordered list of intervals from earliest to latest, where each + interval represents the number of conversations that transpired + during the time window. + type: array + intervalDuration: + description: The duration of each interval. + format: google-duration type: string - readOnly: true - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: + id: GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + description: A time series representing conversations over time. type: object + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: id: >- - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig - description: Configuration for processing transcript objects. + GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination + description: Google Cloud Storage Object URI to save the issue model to. properties: - medium: + objectUri: type: string - description: Required. The medium transcript objects represent. - enumDescriptions: - - Default value, if unspecified will default to PHONE_CALL. - - The format for conversations that took place over the phone. - - The format for conversations that took place over chat. - enum: - - MEDIUM_UNSPECIFIED - - PHONE_CALL - - CHAT - GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary: - type: object - description: >- - A point in a conversation that marks the start or the end of an - annotation. - id: GoogleCloudContactcenterinsightsV1alpha1AnnotationBoundary - properties: - transcriptIndex: - format: int32 - type: integer - description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. - wordIndex: - type: integer - format: int32 - description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: - description: A Dialogflow source of conversation data. + description: 'Required. Format: `gs:///`' type: object - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest: + description: The request to delete an issue model. properties: - dialogflowConversation: - description: >- - Output only. The name of the Dialogflow conversation that this - conversation resource is derived from. Format: - projects/{project}/locations/{location}/conversations/{conversation} - readOnly: true - type: string - audioUri: + name: + description: Required. The name of the issue model to delete. type: string - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - GoogleCloudContactcenterinsightsV1Issue: + id: GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelRequest type: object - id: GoogleCloudContactcenterinsightsV1Issue - description: The issue resource. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata: + description: The metadata for an IngestConversations operation. properties: - name: - type: string - description: >- - Immutable. The resource name of the issue. Format: - projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} - updateTime: - description: Output only. The most recent time that this issue was updated. - type: string - format: google-datetime - readOnly: true - createTime: + request: readOnly: true - description: Output only. The time at which this issue was created. - format: google-datetime - type: string - displayName: - type: string - description: The representative name for the issue. - sampleUtterances: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequest + description: Output only. The original request for ingest. + partialErrors: readOnly: true type: array items: - type: string + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Output only. Resource names of the sample representative utterances - that match to this issue. - GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: - id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - properties: - phraseMatcher: - description: The unique identifier (the resource name) of the phrase matcher. + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. + ingestConversationsStats: + readOnly: true + description: Output only. Statistics for IngestConversations operation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadataIngestConversationsStats + endTime: type: string - displayName: + readOnly: true + description: Output only. The time the operation finished running. + format: google-datetime + createTime: + readOnly: true type: string - description: The human-readable name of the phrase matcher. - description: >- - The data for a matched phrase matcher. Represents information - identifying a phrase matcher for a given match. + description: Output only. The time the operation was created. + format: google-datetime + id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata type: object - GoogleCloudContactcenterinsightsV1PhraseMatchRule: + GoogleCloudContactcenterinsightsV1alpha1IntentMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1IntentMatchData + description: >- + The data for an intent match. Represents an intent match for a text + segment in the conversation. A text segment can be part of a sentence, a + complete sentence, or an utterance with multiple sentences. properties: - query: - description: Required. The phrase to be matched. + intentUniqueId: type: string - config: - description: >- - Provides additional information about the rule that specifies how to - apply the rule. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchRuleConfig - negated: - type: boolean description: >- - Specifies whether the phrase must be missing from the transcript - segment or present in the transcript segment. + The id of the matched intent. Can be used to retrieve the + corresponding intent information. type: object - description: The data for a phrase match rule. - id: GoogleCloudContactcenterinsightsV1PhraseMatchRule - GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo: - description: Information about an agent involved in the conversation. + GoogleCloudContactcenterinsightsV1ListViewsResponse: properties: - team: - type: string - description: A user-specified string representing the agent's team. - agentId: - type: string - description: A user-specified string representing the agent. - dispositionCode: + nextPageToken: type: string description: >- - A user-provided string indicating the outcome of the agent's segment - of the call. - displayName: - type: string - description: The agent's name. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + views: + description: The views that match the request. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' type: object - id: GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo - GoogleCloudContactcenterinsightsV1ConversationCallMetadata: + id: GoogleCloudContactcenterinsightsV1ListViewsResponse + description: The response of listing views. + GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata: description: Call-specific metadata. - type: object - id: GoogleCloudContactcenterinsightsV1ConversationCallMetadata properties: agentChannel: type: integer - format: int32 description: The audio channel that contains the agent. + format: int32 customerChannel: - type: integer description: The audio channel that contains the customer. format: int32 - GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent: - id: GoogleCloudContactcenterinsightsV1alpha1DialogflowIntent - properties: - displayName: - description: The human-readable name of the intent. - type: string + type: integer type: object - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo: - id: >- - GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + id: GoogleCloudContactcenterinsightsV1alpha1ConversationCallMetadata + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsResponse + type: object + description: The response for a bulk delete conversations operation. + properties: {} + GoogleCloudContactcenterinsightsV1alpha1InterruptionData: + id: GoogleCloudContactcenterinsightsV1alpha1InterruptionData + type: object + description: The data for an interruption annotation. + properties: {} + GoogleCloudContactcenterinsightsV1UploadConversationMetadata: + id: GoogleCloudContactcenterinsightsV1UploadConversationMetadata + description: The metadata for an `UploadConversation` operation. type: object properties: - startOffset: - format: google-duration - type: string + request: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + description: Output only. The original request. + appliedRedactionConfig: + readOnly: true description: >- - Time offset of the start of this word relative to the beginning of - the total conversation. - endOffset: - format: google-duration + Output only. The redaction config applied to the uploaded + conversation. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + analysisOperation: description: >- - Time offset of the end of this word relative to the beginning of the - total conversation. - type: string - word: - description: The word itself. Includes punctuation marks that surround the word. + Output only. The operation name for a successfully created analysis + operation, if any. type: string - confidence: - type: number - format: float - description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - word. A default value of 0.0 indicates that the value is unset. - description: Word-level info for words in a transcript. - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats: - id: >- - GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats - description: Statistics for IngestConversations operation. - properties: - processedObjectCount: - type: integer - format: int32 - description: >- - Output only. The number of objects processed during the ingest - operation. readOnly: true - failedIngestCount: + endTime: + description: Output only. The time the operation finished running. readOnly: true - type: integer - description: >- - Output only. The number of objects which were unable to be ingested - due to errors. The errors are populated in the partial_errors field. - format: int32 - successfulIngestCount: + type: string + format: google-datetime + createTime: + type: string + description: Output only. The time the operation was created. readOnly: true - type: integer + format: google-datetime + GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData: + type: object + properties: + confidence: description: >- - Output only. The number of new conversations added during this - ingest operation. - format: int32 - duplicatesSkippedCount: - type: integer - readOnly: true + The confidence of the match ranging from 0.0 (completely uncertain) + to 1.0 (completely certain). + type: number + format: float + dialogflowIntentId: + type: string description: >- - Output only. The number of objects skipped because another - conversation with the same transcript uri had already been ingested. - format: int32 - type: object - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination: - description: A BigQuery Table Reference. - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataRequestBigQueryDestination + The Dialogflow intent resource path. Format: + projects/{project}/agent/{agent}/intents/{intent} + description: Dialogflow interaction data. + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowInteractionData + GoogleCloudContactcenterinsightsV1SmartReplyData: type: object properties: - projectId: + queryRecord: type: string description: >- - A project ID or number. If specified, then export will attempt to - write data to this project instead of the resource project. - Otherwise, the resource project will be used. - dataset: + The name of the answer record. Format: + projects/{project}/locations/{location}/answerRecords/{answer_record} + reply: + description: The content of the reply. + type: string + confidenceScore: description: >- - Required. The name of the BigQuery dataset that the snapshot result - should be exported to. If this dataset does not exist, the export - call returns an INVALID_ARGUMENT error. + The system's confidence score that this reply is a good match for + this conversation, ranging from 0.0 (completely uncertain) to 1.0 + (completely certain). + format: double + type: number + metadata: + description: >- + Map that contains metadata about the Smart Reply and the document + from which it originates. + type: object + additionalProperties: + type: string + id: GoogleCloudContactcenterinsightsV1SmartReplyData + description: Agent Assist Smart Reply data. + GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData: + id: GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData + properties: + displayName: type: string - table: + description: The human-readable name of the phrase matcher. + phraseMatcher: + description: The unique identifier (the resource name) of the phrase matcher. type: string - description: >- - The BigQuery table name to which the insights data should be - written. If this table does not exist, the export call returns an - INVALID_ARGUMENT error. - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination: + description: >- + The data for a matched phrase matcher. Represents information + identifying a phrase matcher for a given match. type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelRequestGcsDestination - description: Google Cloud Storage Object URI to save the issue model to. + GoogleCloudContactcenterinsightsV1ConversationDataSource: + description: The conversation source, which is a combination of transcript and audio. + id: GoogleCloudContactcenterinsightsV1ConversationDataSource properties: - objectUri: - description: 'Required. Format: `gs:///`' + dialogflowSource: + description: The source when the conversation comes from Dialogflow. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowSource + gcsSource: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1GcsSource' + description: A Cloud Storage location specification for the audio and transcript. + type: object + GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: + type: object + description: Metadata for undeploying an issue model. + properties: + endTime: + format: google-datetime type: string - GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest: - id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsRequest + readOnly: true + description: Output only. The time the operation finished running. + createTime: + format: google-datetime + description: Output only. The time the operation was created. + readOnly: true + type: string + request: + description: The original request for undeployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest + id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata + GoogleCloudContactcenterinsightsV1IssueModelLabelStats: properties: - parent: + analyzedConversationsCount: + format: int64 description: >- - Required. The parent resource to delete conversations from. Format: - projects/{project}/locations/{location} - type: string - maxDeleteCount: - format: int32 - description: Maximum number of conversations to delete. - type: integer - filter: + Number of conversations the issue model has analyzed at this point + in time. type: string - description: Filter used to select the subset of conversations to delete. - force: - type: boolean + unclassifiedConversationsCount: description: >- - If set to true, all of this conversation's analyses will also be - deleted. Otherwise, the request will only succeed if the - conversation has no analyses. - description: The request to delete conversations in bulk. - type: object - GoogleCloudContactcenterinsightsV1ConversationLevelSilence: - type: object - properties: - silenceDuration: + Number of analyzed conversations for which no issue was applicable + at this point in time. type: string - description: Amount of time calculated to be in silence. - format: google-duration - silencePercentage: - description: Percentage of the total conversation spent in silence. - type: number - format: float - id: GoogleCloudContactcenterinsightsV1ConversationLevelSilence - description: Conversation-level silence data. - GoogleCloudContactcenterinsightsV1CalculateStatsResponse: - id: GoogleCloudContactcenterinsightsV1CalculateStatsResponse - type: object - properties: - conversationCount: - type: integer - description: The total number of conversations. - format: int32 - issueMatchesStats: + format: int64 + issueStats: + description: Statistics on each issue. Key is the issue's resource name. type: object additionalProperties: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats + description: Aggregated statistics about an issue model. + id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats + type: object + GoogleCloudContactcenterinsightsV1alpha1IssueModel: + type: object + properties: + updateTime: + format: google-datetime + readOnly: true description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` - averageTurnCount: - type: integer - format: int32 - description: The average number of turns per conversation. - customHighlighterMatches: - additionalProperties: - format: int32 - type: integer - type: object - description: >- - A map associating each custom highlighter resource name with its - respective number of matches in the set of conversations. - averageDuration: - description: >- - The average duration of all conversations. The average is calculated - using only conversations that have a time duration. - format: google-duration + Output only. The most recent time at which the issue model was + updated. + type: string + languageCode: + type: string + description: Language of the model. + name: type: string - issueMatches: - additionalProperties: - format: int32 - type: integer description: >- - A map associating each issue resource name with its respective - number of matches in the set of conversations. Key has the format: - `projects//locations//issueModels//issues/` Deprecated, use - `issue_matches_stats` field instead. - type: object - deprecated: true - conversationCountTimeSeries: + Immutable. The resource name of the issue model. Format: + projects/{project}/locations/{location}/issueModels/{issue_model} + inputDataConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeries + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelInputDataConfig + description: Configs for the input data that used to create the issue model. + trainingStats: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStats description: >- - A time series representing the count of conversations created over - time that match that requested filter criteria. - smartHighlighterMatches: + Output only. Immutable. The issue model's label statistics on its + training data. + readOnly: true + issueCount: + type: string + format: int64 + description: Output only. Number of issues in this issue model. + readOnly: true + modelType: + type: string + enumDescriptions: + - Unspecified model type. + - Type V1. + - Type V2. + enum: + - MODEL_TYPE_UNSPECIFIED + - TYPE_V1 + - TYPE_V2 + description: Type of the model. + displayName: + type: string + description: The representative name for the issue model. + state: + enum: + - STATE_UNSPECIFIED + - UNDEPLOYED + - DEPLOYING + - DEPLOYED + - UNDEPLOYING + - DELETING + readOnly: true + type: string + enumDescriptions: + - Unspecified. + - Model is not deployed but is ready to deploy. + - Model is being deployed. + - >- + Model is deployed and is ready to be used. A model can only be + used in analysis if it's in this state. + - Model is being undeployed. + - Model is being deleted. + description: Output only. State of the model. + createTime: + readOnly: true + format: google-datetime + description: Output only. The time at which this issue model was created. + type: string + id: GoogleCloudContactcenterinsightsV1alpha1IssueModel + description: The issue model resource. + GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest: + type: object + description: The request to create an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1CreateIssueModelRequest + properties: + parent: + type: string + description: Required. The parent resource of the issue model. + issueModel: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModel + description: Required. The issue model to create. + GoogleCloudContactcenterinsightsV1ListIssueModelsResponse: + type: object + properties: + issueModels: + type: array + items: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel' + description: The issue models that match the request. + id: GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + description: The response of listing issue models. + GoogleCloudContactcenterinsightsV1alpha1SpeechConfig: + description: >- + Speech-to-Text configuration. Speech-to-Text settings are applied to + conversations ingested from the `UploadConversation` and + `IngestConversations` endpoints, including conversation coming from CCAI + Platform. They are not applied to conversations ingested from the + `CreateConversation` endpoint. + type: object + id: GoogleCloudContactcenterinsightsV1alpha1SpeechConfig + properties: + speechRecognizer: description: >- - A map associating each smart highlighter display name with its - respective number of matches in the set of conversations. - type: object - additionalProperties: - format: int32 - type: integer - description: The response for calculating conversation statistics. - GoogleCloudContactcenterinsightsV1AnnotationBoundary: + The fully-qualified Speech Recognizer resource name. Format: + `projects/{project_id}/locations/{location}/recognizer/{recognizer}` + type: string + GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse: + id: GoogleCloudContactcenterinsightsV1alpha1BulkDeleteConversationsResponse + properties: {} type: object + description: The response for a bulk delete conversations operation. + GoogleRpcStatus: + id: GoogleRpcStatus properties: - transcriptIndex: - format: int32 + details: description: >- - The index in the sequence of transcribed pieces of the conversation - where the boundary is located. This index starts at zero. - type: integer - wordIndex: - type: integer + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + code: + description: The status code, which should be an enum value of google.rpc.Code. format: int32 + type: integer + message: + type: string description: >- - The word index of this boundary with respect to the first word in - the transcript piece. This index starts at zero. - id: GoogleCloudContactcenterinsightsV1AnnotationBoundary + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. description: >- - A point in a conversation that marks the start or the end of an - annotation. - GoogleCloudContactcenterinsightsV1DialogflowIntent: - id: GoogleCloudContactcenterinsightsV1DialogflowIntent + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - properties: - displayName: - type: string - description: The human-readable name of the intent. - description: >- - The data for a Dialogflow intent. Represents a detected intent in the - conversation, e.g. MAKES_PROMISE. - GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest: - description: The request to deploy an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1DeployIssueModelRequest + GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse: + id: GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + description: The response of listing phrase matchers. type: object properties: - name: + phraseMatchers: + description: The phrase matchers that match the request. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. type: string - description: Required. The issue model to deploy. - GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata: + GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata: + type: object + id: GoogleCloudContactcenterinsightsV1DeployIssueModelMetadata + description: Metadata for deploying an issue model. properties: + request: + description: The original request for deployment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest createTime: - readOnly: true - format: google-datetime description: Output only. The time the operation was created. type: string - request: - description: The original request for undeployment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelRequest - endTime: readOnly: true - type: string + format: google-datetime + endTime: description: Output only. The time the operation finished running. + type: string + readOnly: true format: google-datetime - description: Metadata for undeploying an issue model. - id: GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata - type: object - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource: + GoogleCloudContactcenterinsightsV1RuntimeAnnotation: + description: >- + An annotation that was generated during the customer and agent + interaction. type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerFaqSource - description: Details about source of FAQ answer. + id: GoogleCloudContactcenterinsightsV1RuntimeAnnotation properties: - document: - type: string - description: >- - Indicates which Knowledge Document this answer was extracted from. - Format: `projects//knowledgeBases//documents/`. - question: + smartReply: + description: Agent Assist Smart Reply data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartReplyData + userInput: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1RuntimeAnnotationUserInput + description: Explicit input used for generating the answer + createTime: type: string - description: The corresponding FAQ question. - GoogleCloudContactcenterinsightsV1ListAnalysesResponse: - description: The response to list analyses. - id: GoogleCloudContactcenterinsightsV1ListAnalysesResponse - properties: - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + format: google-datetime + description: The time at which this annotation was created. + conversationSummarizationSuggestion: + description: Conversation summarization suggestion data. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationSummarizationSuggestionData + answerFeedback: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnswerFeedback + description: The feedback that the customer has about the answer in `data`. + articleSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ArticleSuggestionData + description: Agent Assist Article Suggestion data. + dialogflowInteraction: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DialogflowInteractionData + description: Dialogflow interaction data. + faqAnswer: + description: Agent Assist FAQ answer data. + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1FaqAnswerData' + annotationId: type: string - analyses: - items: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' - description: The analyses that match the request. - type: array - type: object - GoogleCloudContactcenterinsightsV1Entity: - properties: - metadata: - type: object - additionalProperties: - type: string description: >- - Metadata associated with the entity. For most entity types, the - metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph - MID (`mid`), if they are available. For the metadata associated with - other entity types, see the Type table below. - type: - enumDescriptions: - - Unspecified. - - Person. - - Location. - - Organization. - - Event. - - Artwork. - - Consumer product. - - Other types of entities. - - >- - Phone number. The metadata lists the phone number (formatted - according to local convention), plus whichever additional elements - appear in the text: * `number` - The actual number, broken down - into sections according to local convention. * `national_prefix` - - Country code, if detected. * `area_code` - Region or area code, if - detected. * `extension` - Phone extension (to be dialed after - connection), if detected. - - >- - Address. The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - Street number. * `locality` - City or town. * - `street_name` - Street/route name, if detected. * `postal_code` - - Postal code, if detected. * `country` - Country, if detected. * - `broad_region` - Administrative area, such as the state, if - detected. * `narrow_region` - Smaller administrative area, such as - county, if detected. * `sublocality` - Used in Asian addresses to - demark a district within a city, if detected. - - >- - Date. The metadata identifies the components of the date: * `year` - - Four digit year, if detected. * `month` - Two digit month - number, if detected. * `day` - Two digit day number, if detected. - - Number. The metadata is the number itself. - - Price. The metadata identifies the `value` and `currency`. - enum: - - TYPE_UNSPECIFIED - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE - type: string - description: The entity type. - displayName: - description: The representative name for the entity. - type: string - sentiment: + The unique identifier of the annotation. Format: + projects/{project}/locations/{location}/conversationDatasets/{dataset}/conversationDataItems/{data_item}/conversationAnnotations/{annotation} + endBoundary: description: >- - The aggregate sentiment expressed for this entity in the - conversation. - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - salience: - type: number + The boundary in the conversation where the annotation ends, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + smartComposeSuggestion: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1SmartComposeSuggestionData + description: Agent Assist Smart Compose suggestion data. + startBoundary: description: >- - The salience score associated with the entity in the [0, 1.0] range. - The salience score for an entity provides information about the - importance or centrality of that entity to the entire document text. - Scores closer to 0 are less salient, while scores closer to 1.0 are - highly salient. - format: float + The boundary in the conversation where the annotation starts, + inclusive. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotationBoundary + GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest: type: object - id: GoogleCloudContactcenterinsightsV1Entity - description: >- - The data for an entity annotation. Represents a phrase in the - conversation that is a known entity, such as a person, an organization, - or location. - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval: properties: - conversationCount: - description: The number of conversations created in this interval. - type: integer - format: int32 - startTime: - description: The start time of this interval. + gcsSource: + description: Google Cloud Storage source message. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource + createNewModel: + type: boolean + description: >- + Optional. If set to true, will create an issue model from the + imported file with randomly generated IDs for the issue model and + corresponding issues. Otherwise, replaces an existing model with the + same ID as the file. + parent: + description: Required. The parent resource of the issue model. type: string - format: google-datetime - type: object - description: A single interval in a time series. - id: >- - GoogleCloudContactcenterinsightsV1CalculateStatsResponseTimeSeriesInterval + description: Request to import an issue model. + id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequest GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig: - description: Configuration that applies to all conversations. type: object id: >- GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestConversationConfig @@ -4924,522 +4539,404 @@ components: description: >- Optional. An opaque, user-specified string representing a human agent who handled all conversations in the import. Note that this - will be overridden if per-conversation metadata is provided via the - `metadata_bucket_uri`. - customerChannel: - format: int32 + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. + agentChannel: + type: integer description: >- Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed. + format: int32 + customerChannel: + format: int32 type: integer - agentChannel: description: >- Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed. - type: integer - format: int32 - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning: - description: Reasoning for the suggestion. - properties: - issueSummary: - description: Optional. Summary of the issue. - type: string - agentActionTaken: - description: Optional. The actions that the agent has taken already. - type: string - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AgentCoachingSuggestionAgentCoachingSuggestionReasoning - GoogleCloudContactcenterinsightsV1alpha1GcsSource: - properties: - transcriptUri: - description: >- - Immutable. Cloud Storage URI that points to a file that contains the - conversation transcript. - type: string - audioUri: - description: >- - Cloud Storage URI that points to a file that contains the - conversation audio. - type: string - id: GoogleCloudContactcenterinsightsV1alpha1GcsSource - description: A Cloud Storage source of conversation data. - type: object - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource: - properties: - uri: - type: string - description: URI the data is sourced from. - title: - type: string - description: Title of the document. + description: Configuration that applies to all conversations. + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment: id: >- - GoogleCloudContactcenterinsightsV1alpha1GetKnowledgeAssistResponseKnowledgeAnswerIntentMatchingSource + GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegment type: object - description: Details about source of Intent Matching answer. - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata: + description: A segment of a full transcript. properties: - intents: - description: All the matched intents in the call. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Intent - type: object - phraseMatchers: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1PhraseMatchData - description: All the matched phrase matchers in the call. - type: object - entities: - description: All the entities in the call. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1Entity - annotations: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1CallAnnotation - type: array - description: A list of call annotations that apply to this call. - issueModelResult: - description: Overall conversation-level issue modeling result. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueModelResult - silence: - description: Overall conversation-level silence during the call. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSilence - sentiments: + words: + description: >- + A list of the word-specific information for each word in the + segment. type: array - description: Overall conversation-level sentiment for each channel of the call. items: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationLevelSentiment - description: Call-specific metadata created during analysis. - type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1AnalysisResultCallAnalysisMetadata - GoogleCloudContactcenterinsightsV1ImportIssueModelRequest: - description: Request to import an issue model. - type: object - properties: - parent: + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentWordInfo + confidence: + type: number + description: >- + A confidence estimate between 0.0 and 1.0 of the fidelity of this + segment. A default value of 0.0 indicates that the value is unset. + format: float + languageCode: + description: >- + The language code of this segment as a + [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + Example: "en-US". type: string - description: Required. The parent resource of the issue model. - gcsSource: - description: Google Cloud Storage source message. + messageTime: + description: The time that the message occurred, if provided. + type: string + format: google-datetime + dialogflowSegmentMetadata: + description: CCAI metadata relating to the current transcript segment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequestGcsSource - createNewModel: - type: boolean + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata + channelTag: + format: int32 description: >- - Optional. If set to true, will create a new issue model from the - imported file with randomly generated IDs for the issue model and - corresponding issues. Otherwise, replaces an existing model with the - same ID as the file. - id: GoogleCloudContactcenterinsightsV1ImportIssueModelRequest - GoogleCloudContactcenterinsightsV1EntityMentionData: - id: GoogleCloudContactcenterinsightsV1EntityMentionData - properties: - type: + For conversations derived from multi-channel audio, this is the + channel number corresponding to the audio from that channel. For + audioChannelCount = N, its output values can range from '1' to 'N'. + A channel tag of 0 indicates that the audio is mono. + type: integer + segmentParticipant: + description: The participant of this segment. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationParticipant + text: type: string - enumDescriptions: - - Unspecified. - - Proper noun. - - Common noun (or noun compound). - description: The type of the entity mention. - enum: - - MENTION_TYPE_UNSPECIFIED - - PROPER - - COMMON + description: The text of this segment. sentiment: - description: Sentiment expressed for this mention of the entity. $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SentimentData' - entityUniqueId: - description: >- - The key of this entity in conversation entities. Can be used to - retrieve the exact `Entity` this mention is attached to. - type: string - description: >- - The data for an entity mention annotation. This represents a mention of - an `Entity` in the conversation. - type: object - GoogleCloudContactcenterinsightsV1SummarySuggestion: - type: object - properties: - summarySections: - description: Required. All the parts of generated summary. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SummarySuggestionSummarySection - id: GoogleCloudContactcenterinsightsV1SummarySuggestion - description: Suggested summary of the conversation. - GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection: + description: The sentiment for this transcript segment. + GoogleCloudContactcenterinsightsV1IngestConversationsMetadata: properties: - summary: - type: string - description: Required. Summary text for the section. - section: + endTime: + format: google-datetime type: string - description: Required. Name of the section. - description: A component of the generated summary. - type: object - id: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection - GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector: - id: GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - properties: - runSilenceAnnotator: - type: boolean - description: Whether to run the silence annotator. - runPhraseMatcherAnnotator: - type: boolean - description: Whether to run the active phrase matcher annotator(s). - runIssueModelAnnotator: - type: boolean - description: >- - Whether to run the issue model annotator. A model should have - already been deployed for this to take effect. - runSummarizationAnnotator: - type: boolean - description: Whether to run the summarization annotator. - runIntentAnnotator: - description: Whether to run the intent annotator. - type: boolean - phraseMatchers: - description: >- - The list of phrase matchers to run. If not provided, all active - phrase matchers will be used. If inactive phrase matchers are - provided, they will not be used. Phrase matchers will be run only if - run_phrase_matcher_annotator is set to true. Format: - projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - type: array - items: - type: string - runSentimentAnnotator: - description: Whether to run the sentiment annotator. - type: boolean - issueModels: - items: - type: string - description: >- - The issue model to run. If not provided, the most recently deployed - topic model will be used. The provided issue model will only be used - for inference if the issue model is deployed and if - run_issue_model_annotator is set to true. If more than one issue - model is provided, only the first provided issue model will be used - for inference. - type: array - runEntityAnnotator: - description: Whether to run the entity annotator. - type: boolean - runInterruptionAnnotator: - description: Whether to run the interruption annotator. - type: boolean - summarizationConfig: - description: Configuration for the summarization annotator. + readOnly: true + description: Output only. The time the operation finished running. + request: + description: Output only. The original request for ingest. + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + readOnly: true + ingestConversationsStats: + readOnly: true $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelectorSummarizationConfig - type: object - description: Selector of all available annotators and phrase matchers to run. - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource: - properties: - snippets: + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsMetadataIngestConversationsStats + description: Output only. Statistics for IngestConversations operation. + createTime: + description: Output only. The time the operation was created. + type: string + readOnly: true + format: google-datetime + partialErrors: type: array + readOnly: true description: >- - All snippets used for this Generative Prediction, with their source - URI and data. + Output only. Partial errors during ingest operation that might cause + the operation output to be incomplete. items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSourceSnippet + $ref: '#/components/schemas/GoogleRpcStatus' type: object - description: Details about source of Generative answer. - id: >- - GoogleCloudContactcenterinsightsV1GetKnowledgeAssistResponseKnowledgeAnswerGenerativeSource - GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer: - description: Represents a SearchKnowledge answer. - id: GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswer + id: GoogleCloudContactcenterinsightsV1IngestConversationsMetadata + description: The metadata for an IngestConversations operation. + GoogleCloudContactcenterinsightsV1alpha1EntityMentionData: type: object + description: >- + The data for an entity mention annotation. This represents a mention of + an `Entity` in the conversation. properties: - answerRecord: - type: string - description: >- - The name of the answer record. Format: `projects//locations//answer - Records/` - answerType: - description: The type of the answer. - type: string - enumDescriptions: - - The answer has a unspecified type. - - The answer is from FAQ documents. - - The answer is from generative model. - - The answer is from intent matching. + type: enum: - - ANSWER_TYPE_UNSPECIFIED - - FAQ - - GENERATIVE - - INTENT - answerSources: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1SearchKnowledgeAnswerAnswerSource - description: All sources used to generate the answer. - answer: + - MENTION_TYPE_UNSPECIFIED + - PROPER + - COMMON + description: The type of the entity mention. + enumDescriptions: + - Unspecified. + - Proper noun. + - Common noun (or noun compound). + type: string + sentiment: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData + description: Sentiment expressed for this mention of the entity. + entityUniqueId: description: >- - The piece of text from the knowledge base documents that answers the - search query + The key of this entity in conversation entities. Can be used to + retrieve the exact `Entity` this mention is attached to. type: string - confidenceScore: - description: The confidence score in [0.0, 1.0] range. - format: float - type: number + id: GoogleCloudContactcenterinsightsV1alpha1EntityMentionData GoogleCloudContactcenterinsightsV1AnalysisResult: + id: GoogleCloudContactcenterinsightsV1AnalysisResult description: The result of an analysis. properties: + endTime: + format: google-datetime + description: The time at which the analysis ended. + type: string callAnalysisMetadata: $ref: >- #/components/schemas/GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata description: Call-specific metadata created by the analysis. - endTime: - format: google-datetime - type: string - description: The time at which the analysis ended. - type: object - id: GoogleCloudContactcenterinsightsV1AnalysisResult - GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: - description: Configuration for summarization. type: object - id: GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata: properties: - summarizationModel: - enumDescriptions: - - Unspecified summarization model. - - The CCAI baseline model. - - The CCAI baseline model, V2.0. - enum: - - SUMMARIZATION_MODEL_UNSPECIFIED - - BASELINE_MODEL - - BASELINE_MODEL_V2_0 - type: string - description: Default summarization model to be used. - conversationProfile: - type: string + smartReplyAllowlistCovered: description: >- - Resource name of the Dialogflow conversation profile. Format: - projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - GoogleCloudContactcenterinsightsV1ImportIssueModelResponse: + Whether the transcript segment was covered under the configured + smart reply allowlist in Agent Assist. + type: boolean + id: >- + GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata type: object - id: GoogleCloudContactcenterinsightsV1ImportIssueModelResponse - description: Response from import issue model - properties: {} - GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse: + description: Metadata from Dialogflow relating to the current transcript segment. + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig: type: object - properties: {} - id: GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse - description: The response to an IngestConversations operation. - GoogleCloudContactcenterinsightsV1IssueModelLabelStats: properties: - analyzedConversationsCount: - description: >- - Number of conversations the issue model has analyzed at this point - in time. - format: int64 - type: string - issueStats: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelLabelStatsIssueStats - description: Statistics on each issue. Key is the issue's resource name. - type: object - unclassifiedConversationsCount: - description: >- - Number of analyzed conversations for which no issue was applicable - at this point in time. - format: int64 + medium: + enumDescriptions: + - Default value, if unspecified will default to PHONE_CALL. + - The format for conversations that took place over the phone. + - The format for conversations that took place over chat. type: string - type: object - id: GoogleCloudContactcenterinsightsV1IssueModelLabelStats - description: Aggregated statistics about an issue model. - GoogleCloudContactcenterinsightsV1alpha1IssueMatchData: - id: GoogleCloudContactcenterinsightsV1alpha1IssueMatchData - description: The data for an issue match annotation. - properties: - issueAssignment: - description: Information about the issue's assignment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1IssueAssignment - type: object - GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest: - id: GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest - description: The request to analyze conversations in bulk. + description: Required. The medium transcript objects represent. + enum: + - MEDIUM_UNSPECIFIED + - PHONE_CALL + - CHAT + description: Configuration for processing transcript objects. + id: >- + GoogleCloudContactcenterinsightsV1alpha1IngestConversationsRequestTranscriptObjectConfig + GoogleCloudContactcenterinsightsV1ListConversationsResponse: + description: The response of listing conversations. + id: GoogleCloudContactcenterinsightsV1ListConversationsResponse type: object properties: - filter: + conversations: + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + description: The conversations that match the request. + type: array + nextPageToken: type: string description: >- - Required. Filter used to select the subset of conversations to - analyze. - annotatorSelector: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1AnnotatorSelector - description: >- - To select the annotators to run and the phrase matchers to use (if - any). If not specified, all annotators will be run. - analysisPercentage: + A token which can be sent as `page_token` to retrieve the next page. + If this field is set, it means there is another page available. If + it is not set, it means no other pages are available. + GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest: + id: GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + properties: + force: + type: boolean description: >- - Required. Percentage of selected conversation to analyze, between - [0, 100]. - type: number - format: float + If set to true, all of this conversation's analyses will also be + deleted. Otherwise, the request will only succeed if the + conversation has no analyses. + maxDeleteCount: + description: Maximum number of conversations to delete. + type: integer + format: int32 + filter: + type: string + description: Filter used to select the subset of conversations to delete. parent: type: string - description: Required. The parent resource to create analyses in. - GoogleCloudContactcenterinsightsV1ConversationParticipant: + description: >- + Required. The parent resource to delete conversations from. Format: + projects/{project}/locations/{location} type: object - id: GoogleCloudContactcenterinsightsV1ConversationParticipant + description: The request to delete conversations in bulk. + GoogleCloudContactcenterinsightsV1SentimentData: properties: - role: - description: The role of the participant. - enum: - - ROLE_UNSPECIFIED - - HUMAN_AGENT - - AUTOMATED_AGENT - - END_USER - - ANY_AGENT - type: string - enumDescriptions: - - Participant's role is not set. - - Participant is a human agent. - - Participant is an automated agent. - - Participant is an end user who conversed with the contact center. - - Participant is either a human or automated agent. - dialogflowParticipant: - description: >- - Deprecated. Use `dialogflow_participant_name` instead. The name of - the Dialogflow participant. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - type: string - deprecated: true - obfuscatedExternalUserId: - type: string - description: Obfuscated user ID from Dialogflow. - dialogflowParticipantName: - type: string + score: + description: The sentiment score between -1.0 (negative) and 1.0 (positive). + format: float + type: number + magnitude: description: >- - The name of the participant provided by Dialogflow. Format: - projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant} - userId: - type: string - description: A user-specified ID representing the participant. - description: The call participant speaking for a given utterance. - GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata: + A non-negative number from 0 to infinity which represents the + abolute magnitude of sentiment regardless of score. + format: float + type: number + description: The data for a sentiment annotation. type: object - description: Metadata for a create analysis operation. + id: GoogleCloudContactcenterinsightsV1SentimentData + GoogleCloudContactcenterinsightsV1alpha1DialogflowSource: properties: - endTime: - description: Output only. The time the operation finished running. + audioUri: + type: string + description: >- + Cloud Storage URI that points to a file that contains the + conversation audio. + dialogflowConversation: readOnly: true + description: >- + Output only. The name of the Dialogflow conversation that this + conversation resource is derived from. Format: + projects/{project}/locations/{location}/conversations/{conversation} type: string - format: google-datetime + type: object + description: A Dialogflow source of conversation data. + id: GoogleCloudContactcenterinsightsV1alpha1DialogflowSource + GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata: + properties: createTime: - format: google-datetime - description: Output only. The time the operation was created. - readOnly: true type: string - conversation: + description: Output only. The time the operation was created. + format: google-datetime readOnly: true - description: >- - Output only. The Conversation that this Analysis Operation belongs - to. - type: string - annotatorSelector: + request: + description: The original request for undeployment. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1AnnotatorSelector - description: Output only. The annotator selector used for the analysis (if any). + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + endTime: + format: google-datetime readOnly: true - id: GoogleCloudContactcenterinsightsV1CreateAnalysisOperationMetadata - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment: - description: A segment of a full transcript. + description: Output only. The time the operation finished running. + type: string + description: Metadata for undeploying an issue model. + id: GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata + type: object + GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: type: object - id: >- - GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegment properties: - channelTag: - format: int32 - description: >- - For conversations derived from multi-channel audio, this is the - channel number corresponding to the audio from that channel. For - audioChannelCount = N, its output values can range from '1' to 'N'. - A channel tag of 0 indicates that the audio is mono. - type: integer - segmentParticipant: - description: The participant of this segment. + issueModelResult: + description: Overall conversation-level issue modeling result. $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationParticipant - languageCode: + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModelResult + silence: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSilence + description: Overall conversation-level silence during the call. + sentiments: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ConversationLevelSentiment + description: Overall conversation-level sentiment for each channel of the call. + annotations: + description: A list of call annotations that apply to this call. + items: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CallAnnotation + type: array + phraseMatchers: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatchData + description: All the matched phrase matchers in the call. + type: object + entities: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Entity' + description: All the entities in the call. + intents: + type: object + description: All the matched intents in the call. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Intent' + description: Call-specific metadata created during analysis. + id: GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata + GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats: + description: Aggregated statistics about an issue. + type: object + properties: + displayName: + description: Display name of the issue. + type: string + labeledConversationsCount: + description: Number of conversations attached to the issue at this point in time. + format: int64 type: string + issue: description: >- - The language code of this segment as a - [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. - Example: "en-US". - messageTime: - format: google-datetime - description: The time that the message occurred, if provided. + Issue resource. Format: + projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} type: string - confidence: - format: float + id: GoogleCloudContactcenterinsightsV1alpha1IssueModelLabelStatsIssueStats + GoogleCloudContactcenterinsightsV1UploadConversationRequest: + description: Request to upload a conversation. + type: object + id: GoogleCloudContactcenterinsightsV1UploadConversationRequest + properties: + conversationId: description: >- - A confidence estimate between 0.0 and 1.0 of the fidelity of this - segment. A default value of 0.0 indicates that the value is unset. - type: number - dialogflowSegmentMetadata: - description: CCAI metadata relating to the current transcript segment. - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentDialogflowSegmentMetadata - text: - description: The text of this segment. + Optional. A unique ID for the new conversation. This ID will become + the final component of the conversation's resource name. If no ID is + specified, a server-generated ID will be used. This value should be + 4-64 characters and must match the regular expression + `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-` type: string - words: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1ConversationTranscriptTranscriptSegmentWordInfo + parent: + type: string + description: Required. The parent resource of the conversation. + speechConfig: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1SpeechConfig' description: >- - A list of the word-specific information for each word in the - segment. - sentiment: - description: The sentiment for this transcript segment. + Optional. Speech-to-Text configuration. Will default to the config + specified in Settings. + redactionConfig: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SentimentData - GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource: + #/components/schemas/GoogleCloudContactcenterinsightsV1RedactionConfig + description: >- + Optional. DLP settings for transcript redaction. Will default to the + config specified in Settings. + conversation: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Conversation' + description: Required. The conversation resource to create. + GoogleCloudContactcenterinsightsV1DeployIssueModelRequest: + description: The request to deploy an issue model. properties: - objectUri: + name: + description: Required. The issue model to deploy. type: string - description: 'Required. Format: `gs:///`' - id: GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelRequestGcsSource - description: Google Cloud Storage Object URI to get the issue model file from. + id: GoogleCloudContactcenterinsightsV1DeployIssueModelRequest type: object - GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion: + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig: + description: Configuration that applies to all conversations. type: object + id: >- + GoogleCloudContactcenterinsightsV1IngestConversationsRequestConversationConfig properties: - summarySections: - items: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1alpha1SummarySuggestionSummarySection - type: array - description: Required. All the parts of generated summary. - id: GoogleCloudContactcenterinsightsV1alpha1SummarySuggestion - description: Suggested summary of the conversation. + agentId: + description: >- + Optional. An opaque, user-specified string representing a human + agent who handled all conversations in the import. Note that this + will be overridden if per-conversation metadata is provided through + the `metadata_bucket_uri`. + type: string + agentChannel: + format: int32 + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. + type: integer + customerChannel: + type: integer + format: int32 + description: >- + Optional. Indicates which of the channels, 1 or 2, contains the + agent. Note that this must be set for conversations to be properly + displayed and analyzed. parameters: - access_token: - description: OAuth access token. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: access_token + name: quotaUser + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string upload_protocol: @@ -5448,28 +4945,16 @@ components: name: upload_protocol schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - _.xgafv: - description: V1 error format. + callback: + description: JSONP in: query - name: $.xgafv + name: callback schema: type: string - enum: - - '1' - - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: quotaUser + name: fields schema: type: string alt: @@ -5482,22 +4967,16 @@ components: - json - media - proto - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - callback: - description: JSONP + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: callback + name: prettyPrint schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + type: boolean + access_token: + description: OAuth access token. in: query - name: uploadType + name: access_token schema: type: string key: @@ -5509,71 +4988,118 @@ components: name: key schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' x-stackQL-resources: - conversations: - id: google.contactcenterinsights.conversations - name: conversations - title: Conversations + insightsdata: + id: google.contactcenterinsights.insightsdata + name: insightsdata + title: Insightsdata methods: - bulk_analyze: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsdata:export/post response: mediaType: application/json openAPIDocKey: '200' - upload: + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + phrase_matchers: + id: google.contactcenterinsights.phrase_matchers + name: phrase_matchers + title: Phrase_matchers + methods: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post response: mediaType: application/json openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.phraseMatchers delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete response: mediaType: application/json openAPIDocKey: '200' patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch response: mediaType: application/json openAPIDocKey: '200' get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get response: mediaType: application/json openAPIDocKey: '200' - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' + conversations: + id: google.contactcenterinsights.conversations + name: conversations + title: Conversations + methods: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/patch response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get - response: &ref_2 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.conversations - list: - operation: *ref_1 - response: *ref_2 calculate_stats: operation: $ref: >- @@ -5581,13 +5107,35 @@ components: response: mediaType: application/json openAPIDocKey: '200' - ingest: + bulk_analyze: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:bulkAnalyze/post + response: + mediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.conversations bulk_delete: operation: $ref: >- @@ -5595,6 +5143,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + ingest: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations:ingest/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/conversations/methods/get' @@ -5603,8 +5158,10 @@ components: - $ref: '#/components/x-stackQL-resources/conversations/methods/create' update: - $ref: '#/components/x-stackQL-resources/conversations/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/conversations/methods/delete' + - $ref: '#/components/x-stackQL-resources/conversations/methods/bulk_delete' analyses: id: google.contactcenterinsights.analyses name: analyses @@ -5624,17 +5181,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversations~1{conversationsId}~1analyses/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.analyses - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: >- @@ -5649,200 +5203,73 @@ components: insert: - $ref: '#/components/x-stackQL-resources/analyses/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/analyses/methods/delete' - views: - id: google.contactcenterinsights.views - name: views - title: Views - methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post - response: - mediaType: application/json - openAPIDocKey: '200' - _list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.views - list: - operation: *ref_5 - response: *ref_6 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/views/methods/get' - - $ref: '#/components/x-stackQL-resources/views/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/views/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/views/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/views/methods/delete' - operations: - id: google.contactcenterinsights.operations - name: operations - title: Operations + encryption_spec: + id: google.contactcenterinsights.encryption_spec + name: encryption_spec + title: Encryption_spec methods: - cancel: + initialize: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec:initialize/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_8 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_7 - response: *ref_8 - get: + get_encryption_spec: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1encryptionSpec/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - - $ref: '#/components/x-stackQL-resources/operations/methods/list' + - $ref: >- + #/components/x-stackQL-resources/encryption_spec/methods/get_encryption_spec insert: [] update: [] + replace: [] delete: [] - insightsdata: - id: google.contactcenterinsights.insightsdata - name: insightsdata - title: Insightsdata + issue_models: + id: google.contactcenterinsights.issue_models + name: issue_models + title: Issue_models methods: - export: + undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightsdata:export/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - phrase_matchers: - id: google.contactcenterinsights.phrase_matchers - name: phrase_matchers - title: Phrase_matchers - methods: create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.phraseMatchers list: - operation: *ref_9 - response: *ref_10 - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseMatchers~1{phraseMatchersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/get' - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/phrase_matchers/methods/delete' - issue_models: - id: google.contactcenterinsights.issue_models - name: issue_models - title: Issue_models - methods: - export: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post - response: - mediaType: application/json - openAPIDocKey: '200' - undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get response: mediaType: application/json openAPIDocKey: '200' - import: + export: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:export/post response: mediaType: application/json openAPIDocKey: '200' - get: + deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' @@ -5860,24 +5287,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/post - response: - mediaType: application/json - openAPIDocKey: '200' - list: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}/get response: mediaType: application/json openAPIDocKey: '200' - deploy: + import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels:import/post response: mediaType: application/json openAPIDocKey: '200' @@ -5896,6 +5316,7 @@ components: - $ref: '#/components/x-stackQL-resources/issue_models/methods/create' update: - $ref: '#/components/x-stackQL-resources/issue_models/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/issue_models/methods/delete' issues: @@ -5903,24 +5324,24 @@ components: name: issues title: Issues methods: - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1issueModels~1{issueModelsId}~1issues~1{issuesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -5938,8 +5359,96 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/issues/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/issues/methods/delete' + operations: + id: google.contactcenterinsights.operations + name: operations + title: Operations + methods: + cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + - $ref: '#/components/x-stackQL-resources/operations/methods/list' + insert: [] + update: [] + replace: [] + delete: [] + views: + id: google.contactcenterinsights.views + name: views + title: Views + methods: + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views~1{viewsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1views/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.views + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/views/methods/get' + - $ref: '#/components/x-stackQL-resources/views/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/views/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/views/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/views/methods/delete' settings: id: google.contactcenterinsights.settings name: settings @@ -5963,31 +5472,33 @@ components: select: - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' + replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: - parameters: &ref_11 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/_.xgafv' + /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: + parameters: &ref_1 - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' post: - description: Analyzes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze + description: Export insights data to a destination defined in the request body. + operationId: contactcenterinsights.projects.locations.insightsdata.export requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6011,20 +5522,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: - parameters: *ref_11 + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: + parameters: *ref_1 post: - description: >- - Create a longrunning conversation upload operation. This method differs - from CreateConversation by allowing audio transcription and optional DLP - redaction. - operationId: contactcenterinsights.projects.locations.conversations.upload + description: Creates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6036,7 +5544,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6048,11 +5557,51 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: - parameters: *ref_11 + get: + description: Lists phrase matchers. + operationId: contactcenterinsights.projects.locations.phraseMatchers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: + parameters: *ref_1 delete: - description: Deletes a conversation. - operationId: contactcenterinsights.projects.locations.conversations.delete + description: Deletes a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6077,23 +5626,19 @@ paths: schema: type: string - in: path - name: conversationsId + name: phraseMatchersId required: true schema: type: string - - in: query - name: force - schema: - type: boolean patch: - description: Updates a conversation. - operationId: contactcenterinsights.projects.locations.conversations.patch + description: Updates a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6106,7 +5651,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher parameters: - in: path name: projectsId @@ -6119,7 +5664,7 @@ paths: schema: type: string - in: path - name: conversationsId + name: phraseMatchersId required: true schema: type: string @@ -6129,8 +5674,48 @@ paths: type: string format: google-fieldmask get: - description: Gets a conversation. - operationId: contactcenterinsights.projects.locations.conversations.get + description: Gets a phrase matcher. + operationId: contactcenterinsights.projects.locations.phraseMatchers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: phraseMatchersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}: + parameters: *ref_1 + patch: + description: Updates a conversation. + operationId: contactcenterinsights.projects.locations.conversations.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6161,23 +5746,13 @@ paths: schema: type: string - in: query - name: view + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations: - parameters: *ref_11 - post: - description: >- - Creates a conversation. DEPRECATED: Use UploadConversation instead. - CreateConversation does not support audio transcription or DLP - redaction. - operationId: contactcenterinsights.projects.locations.conversations.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + format: google-fieldmask + delete: + description: Deletes a conversation. + operationId: contactcenterinsights.projects.locations.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6189,8 +5764,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6202,13 +5776,18 @@ paths: required: true schema: type: string - - in: query - name: conversationId + - in: path + name: conversationsId + required: true schema: type: string + - in: query + name: force + schema: + type: boolean get: - description: Lists conversations. - operationId: contactcenterinsights.projects.locations.conversations.list + description: Gets a conversation. + operationId: contactcenterinsights.projects.locations.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6221,7 +5800,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -6233,29 +5812,17 @@ paths: required: true schema: type: string - - in: query - name: view - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: conversationsId + required: true schema: type: string - in: query - name: orderBy + name: view schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversations:calculateStats: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets conversation statistics. operationId: contactcenterinsights.projects.locations.conversations.calculateStats @@ -6287,19 +5854,17 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: - parameters: *ref_11 + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkAnalyze: + parameters: *ref_1 post: - description: >- - Imports conversations and processes them according to the user's - configuration. - operationId: contactcenterinsights.projects.locations.conversations.ingest + description: Analyzes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkAnalyze requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6323,17 +5888,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: - parameters: *ref_11 + /v1/projects/{projectsId}/locations/{locationsId}/conversations:upload: + parameters: *ref_1 post: - description: Deletes multiple conversations in a single request. - operationId: contactcenterinsights.projects.locations.conversations.bulkDelete + description: >- + Create a long-running conversation upload operation. This method differs + from `CreateConversation` by allowing audio transcription and optional + DLP redaction. + operationId: contactcenterinsights.projects.locations.conversations.upload requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1UploadConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6357,11 +5925,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: - parameters: *ref_11 - get: - description: Gets an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.get + /v1/projects/{projectsId}/locations/{locationsId}/conversations: + parameters: *ref_1 + post: + description: >- + Creates a conversation. Does not support audio transcription or DLP + redaction. Use `conversations.upload` instead. + operationId: contactcenterinsights.projects.locations.conversations.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6374,43 +5950,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId - required: true - schema: - type: string - delete: - description: Deletes an analysis. - operationId: contactcenterinsights.projects.locations.conversations.analyses.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + #/components/schemas/GoogleCloudContactcenterinsightsV1Conversation parameters: - in: path name: projectsId @@ -6422,21 +5962,13 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - - in: path - name: analysesId - required: true + - in: query + name: conversationId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: - parameters: *ref_11 get: - description: Lists analyses. - operationId: contactcenterinsights.projects.locations.conversations.analyses.list + description: Lists conversations. + operationId: contactcenterinsights.projects.locations.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6449,7 +5981,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListConversationsResponse parameters: - in: path name: projectsId @@ -6461,9 +5993,8 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true + - in: query + name: pageToken schema: type: string - in: query @@ -6476,19 +6007,24 @@ paths: schema: type: string - in: query - name: pageToken + name: view + schema: + type: string + - in: query + name: orderBy schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations:bulkDelete: + parameters: *ref_1 post: - description: >- - Creates an analysis. The long running operation is done when the - analysis has completed. - operationId: contactcenterinsights.projects.locations.conversations.analyses.create + description: Deletes multiple conversations in a single request. + operationId: contactcenterinsights.projects.locations.conversations.bulkDelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6512,16 +6048,19 @@ paths: required: true schema: type: string - - in: path - name: conversationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: - parameters: *ref_11 - delete: - description: Deletes a view. - operationId: contactcenterinsights.projects.locations.views.delete + /v1/projects/{projectsId}/locations/{locationsId}/conversations:ingest: + parameters: *ref_1 + post: + description: >- + Imports conversations and processes them according to the user's + configuration. + operationId: contactcenterinsights.projects.locations.conversations.ingest + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IngestConversationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6533,7 +6072,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6545,14 +6084,11 @@ paths: required: true schema: type: string - - in: path - name: viewsId - required: true - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses/{analysesId}: + parameters: *ref_1 get: - description: Gets a view. - operationId: contactcenterinsights.projects.locations.views.get + description: Gets an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6564,7 +6100,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1Analysis parameters: - in: path name: projectsId @@ -6577,61 +6114,18 @@ paths: schema: type: string - in: path - name: viewsId - required: true - schema: - type: string - patch: - description: Updates a view. - operationId: contactcenterinsights.projects.locations.views.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId + name: conversationsId required: true schema: type: string - in: path - name: viewsId + name: analysesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/views: - parameters: *ref_11 - post: - description: Creates a view. - operationId: contactcenterinsights.projects.locations.views.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + delete: + description: Deletes an analysis. + operationId: contactcenterinsights.projects.locations.conversations.analyses.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6643,7 +6137,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6655,9 +6149,21 @@ paths: required: true schema: type: string + - in: path + name: conversationsId + required: true + schema: + type: string + - in: path + name: analysesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses: + parameters: *ref_1 get: - description: Lists views. - operationId: contactcenterinsights.projects.locations.views.list + description: Lists analyses. + operationId: contactcenterinsights.projects.locations.conversations.analyses.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6670,7 +6176,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListAnalysesResponse parameters: - in: path name: projectsId @@ -6682,6 +6188,11 @@ paths: required: true schema: type: string + - in: path + name: conversationsId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -6691,20 +6202,20 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_11 + - in: query + name: filter + schema: + type: string post: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: contactcenterinsights.projects.locations.operations.cancel + Creates an analysis. The long running operation is done when the + analysis has completed. + operationId: contactcenterinsights.projects.locations.conversations.analyses.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Analysis' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6716,7 +6227,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6729,17 +6240,26 @@ paths: schema: type: string - in: path - name: operationsId + name: conversationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_11 - get: + /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: contactcenterinsights.projects.locations.operations.list + Initializes a location-level encryption key specification. An error will + be thrown if the location has resources already created before the + initialization. Once the encryption specification is initialized at a + location, it is immutable and all newly created resources under the + location will be encrypted with the existing specification. + operationId: contactcenterinsights.projects.locations.encryptionSpec.initialize + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6751,7 +6271,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6763,27 +6283,19 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_11 - get: + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: + parameters: *ref_1 + post: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: contactcenterinsights.projects.locations.operations.get + Undeploys an issue model. An issue model can not be used in analysis + after it has been undeployed. + operationId: contactcenterinsights.projects.locations.issueModels.undeploy + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6808,21 +6320,21 @@ paths: schema: type: string - in: path - name: operationsId + name: issueModelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightsdata:export: - parameters: *ref_11 + /v1/projects/{projectsId}/locations/{locationsId}/issueModels: + parameters: *ref_1 post: - description: Export insights data to a destination defined in the request body. - operationId: contactcenterinsights.projects.locations.insightsdata.export + description: Creates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportInsightsDataRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6846,17 +6358,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers: - parameters: *ref_11 - post: - description: Creates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + get: + description: Lists issue models. + operationId: contactcenterinsights.projects.locations.issueModels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6869,7 +6373,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse parameters: - in: path name: projectsId @@ -6881,9 +6385,17 @@ paths: required: true schema: type: string - get: - description: Lists phrase matchers. - operationId: contactcenterinsights.projects.locations.phraseMatchers.list + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: + parameters: *ref_1 + post: + description: Exports an issue model to the provided destination. + operationId: contactcenterinsights.projects.locations.issueModels.export + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6895,8 +6407,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListPhraseMatchersResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6908,24 +6419,24 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: issueModelsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/phraseMatchers/{phraseMatchersId}: - parameters: *ref_11 - delete: - description: Deletes a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.delete + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: + parameters: *ref_1 + post: + description: >- + Deploys an issue model. Returns an error if a model is already deployed. + An issue model can only be used in analysis after it has been deployed. + operationId: contactcenterinsights.projects.locations.issueModels.deploy + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6937,7 +6448,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6950,19 +6461,21 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: issueModelsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: + parameters: *ref_1 patch: - description: Updates a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.patch + description: Updates an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6975,7 +6488,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -6988,7 +6501,7 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: issueModelsId required: true schema: type: string @@ -6997,9 +6510,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Gets a phrase matcher. - operationId: contactcenterinsights.projects.locations.phraseMatchers.get + delete: + description: Deletes an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7011,8 +6524,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1PhraseMatcher + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -7025,21 +6537,13 @@ paths: schema: type: string - in: path - name: phraseMatchersId + name: issueModelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:export: - parameters: *ref_11 - post: - description: Exports an issue model to the provided destination. - operationId: contactcenterinsights.projects.locations.issueModels.export - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ExportIssueModelRequest + get: + description: Gets an issue model. + operationId: contactcenterinsights.projects.locations.issueModels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7051,7 +6555,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel parameters: - in: path name: projectsId @@ -7068,19 +6573,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:undeploy: - parameters: *ref_11 + /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: + parameters: *ref_1 post: - description: >- - Undeploys an issue model. An issue model can not be used in analysis - after it has been undeployed. - operationId: contactcenterinsights.projects.locations.issueModels.undeploy + description: Imports an issue model from a Cloud Storage bucket. + operationId: contactcenterinsights.projects.locations.issueModels.import requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1UndeployIssueModelRequest + #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7104,22 +6607,51 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: + parameters: *ref_1 + get: + description: Gets an issue model's statistics. + operationId: >- + contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: issueModelsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels:import: - parameters: *ref_11 - post: - description: Imports an issue model from a Cloud Storage bucket. - operationId: contactcenterinsights.projects.locations.issueModels.import + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: + parameters: *ref_1 + patch: + description: Updates an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ImportIssueModelRequest + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7131,7 +6663,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' parameters: - in: path name: projectsId @@ -7143,11 +6675,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}: - parameters: *ref_11 + - in: path + name: issueModelsId + required: true + schema: + type: string + - in: path + name: issuesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Gets an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.get + description: Gets an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7159,8 +6704,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' parameters: - in: path name: projectsId @@ -7177,15 +6721,14 @@ paths: required: true schema: type: string - patch: - description: Updates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + - in: path + name: issuesId + required: true + schema: + type: string + delete: + description: Deletes an issue. + operationId: contactcenterinsights.projects.locations.issueModels.issues.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7197,8 +6740,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -7215,14 +6757,16 @@ paths: required: true schema: type: string - - in: query - name: updateMask + - in: path + name: issuesId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.delete + /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: + parameters: *ref_1 + get: + description: Lists issues. + operationId: contactcenterinsights.projects.locations.issueModels.issues.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7234,7 +6778,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse parameters: - in: path name: projectsId @@ -7251,17 +6796,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels: - parameters: *ref_11 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: - description: Creates an issue model. - operationId: contactcenterinsights.projects.locations.issueModels.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1IssueModel + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: contactcenterinsights.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7273,7 +6821,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -7285,9 +6833,19 @@ paths: required: true schema: type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Lists issue models. - operationId: contactcenterinsights.projects.locations.issueModels.list + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: contactcenterinsights.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7299,8 +6857,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssueModelsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -7312,19 +6869,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:deploy: - parameters: *ref_11 - post: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: description: >- - Deploys an issue model. Returns an error if a model is already deployed. - An issue model can only be used in analysis after it has been deployed. - operationId: contactcenterinsights.projects.locations.issueModels.deploy - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1DeployIssueModelRequest + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: contactcenterinsights.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7336,7 +6892,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -7348,17 +6904,24 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}:calculateIssueModelStats: - parameters: *ref_11 - get: - description: Gets an issue model's statistics. - operationId: >- - contactcenterinsights.projects.locations.issueModels.calculateIssueModelStats + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/views/{viewsId}: + parameters: *ref_1 + delete: + description: Deletes a view. + operationId: contactcenterinsights.projects.locations.views.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7370,8 +6933,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1CalculateIssueModelStatsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -7384,15 +6946,18 @@ paths: schema: type: string - in: path - name: issueModelsId + name: viewsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues/{issuesId}: - parameters: *ref_11 - get: - description: Gets an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.get + patch: + description: Updates a view. + operationId: contactcenterinsights.projects.locations.views.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7404,7 +6969,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -7417,18 +6982,18 @@ paths: schema: type: string - in: path - name: issueModelsId + name: viewsId required: true schema: type: string - - in: path - name: issuesId - required: true + - in: query + name: updateMask schema: type: string - delete: - description: Deletes an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.delete + format: google-fieldmask + get: + description: Gets a view. + operationId: contactcenterinsights.projects.locations.views.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7440,7 +7005,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -7453,23 +7018,20 @@ paths: schema: type: string - in: path - name: issueModelsId - required: true - schema: - type: string - - in: path - name: issuesId + name: viewsId required: true schema: type: string - patch: - description: Updates an issue. - operationId: contactcenterinsights.projects.locations.issueModels.issues.patch + /v1/projects/{projectsId}/locations/{locationsId}/views: + parameters: *ref_1 + post: + description: Creates a view. + operationId: contactcenterinsights.projects.locations.views.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7481,7 +7043,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1Issue' + $ref: '#/components/schemas/GoogleCloudContactcenterinsightsV1View' parameters: - in: path name: projectsId @@ -7493,26 +7055,9 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true - schema: - type: string - - in: path - name: issuesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/issueModels/{issueModelsId}/issues: - parameters: *ref_11 get: - description: Lists issues. - operationId: contactcenterinsights.projects.locations.issueModels.issues.list + description: Lists views. + operationId: contactcenterinsights.projects.locations.views.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7525,7 +7070,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContactcenterinsightsV1ListIssuesResponse + #/components/schemas/GoogleCloudContactcenterinsightsV1ListViewsResponse parameters: - in: path name: projectsId @@ -7537,13 +7082,17 @@ paths: required: true schema: type: string - - in: path - name: issueModelsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/settings: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets project-level settings. operationId: contactcenterinsights.projects.locations.getSettings @@ -7608,3 +7157,32 @@ paths: schema: type: string format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec: + parameters: *ref_1 + get: + description: Gets location-level encryption key specification. + operationId: contactcenterinsights.projects.locations.getEncryptionSpec + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContactcenterinsightsV1EncryptionSpec + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/container.yaml b/providers/src/googleapis.com/v00.00.00000/services/container.yaml index cb3f958f..af456040 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/container.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/container.yaml @@ -9,10 +9,10 @@ info: Builds and manages container-based applications, powered by the open source Kubernetes technology. version: v1 - x-discovery-doc-revision: '20240514' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240814' + x-generated-date: '2024-09-13' externalDocs: - url: https://cloud.google.com/container-engine/ + url: https://cloud.google.com/kubernetes-engine/docs/ servers: - url: https://container.googleapis.com components: @@ -280,22 +280,25 @@ components: description: Configuration for Identity Service component. $ref: '#/components/schemas/IdentityServiceConfig' selfLink: - description: '[Output only] Server-defined URL for the resource.' + description: Output only. Server-defined URL for the resource. + readOnly: true type: string zone: description: >- - [Output only] The name of the Google Compute Engine + Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + readOnly: true deprecated: true type: string endpoint: description: >- - [Output only] The IP address of this cluster's master endpoint. The + Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + readOnly: true type: string initialClusterVersion: description: >- @@ -312,25 +315,29 @@ components: version type: string currentMasterVersion: - description: '[Output only] The current software version of the master endpoint.' + description: Output only. The current software version of the master endpoint. + readOnly: true type: string currentNodeVersion: description: >- - [Output only] Deprecated, use + Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + readOnly: true deprecated: true type: string createTime: description: >- - [Output only] The time the cluster was created, in + Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + readOnly: true type: string status: - description: '[Output only] The current status of this cluster.' + description: Output only. The current status of this cluster. + readOnly: true type: string enumDescriptions: - Not set. @@ -361,62 +368,70 @@ components: - DEGRADED statusMessage: description: >- - [Output only] Deprecated. Use conditions instead. Additional + Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + readOnly: true deprecated: true type: string nodeIpv4CidrSize: description: >- - [Output only] The size of the address space on each node for hosting + Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + readOnly: true type: integer format: int32 servicesIpv4Cidr: description: >- - [Output only] The IP address range of the Kubernetes services in - this cluster, in + Output only. The IP address range of the Kubernetes services in this + cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + readOnly: true type: string instanceGroupUrls: - description: Deprecated. Use node_pools.instance_group_urls. + description: Output only. Deprecated. Use node_pools.instance_group_urls. + readOnly: true deprecated: true type: array items: type: string currentNodeCount: description: >- - [Output only] The number of nodes currently in the cluster. + Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + readOnly: true deprecated: true type: integer format: int32 expireTime: description: >- - [Output only] The time the cluster will be automatically deleted in + Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + readOnly: true type: string location: description: >- - [Output only] The name of the Google Compute Engine + Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + readOnly: true type: string enableTpu: description: Enable the ability to use Cloud TPUs in this cluster. type: boolean tpuIpv4CidrBlock: description: >- - [Output only] The IP address range of the Cloud TPUs in this - cluster, in + Output only. The IP address range of the Cloud TPUs in this cluster, + in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + readOnly: true type: string conditions: description: Which conditions caused the current cluster state. @@ -470,6 +485,12 @@ components: enterpriseConfig: description: GKE Enterprise Configuration. $ref: '#/components/schemas/EnterpriseConfig' + secretManagerConfig: + description: Secret CSI driver configuration. + $ref: '#/components/schemas/SecretManagerConfig' + compliancePostureConfig: + description: Enable/Disable Compliance Posture features for the cluster. + $ref: '#/components/schemas/CompliancePostureConfig' satisfiesPzs: description: Output only. Reserved for future use. readOnly: true @@ -478,6 +499,11 @@ components: description: Output only. Reserved for future use. readOnly: true type: boolean + rbacBindingConfig: + description: >- + RBACBindingConfig allows user to restrict ClusterRoleBindings an + RoleBindings that can be created. + $ref: '#/components/schemas/RBACBindingConfig' NodeConfig: id: NodeConfig description: >- @@ -714,6 +740,11 @@ components: type: array items: $ref: '#/components/schemas/SecondaryBootDisk' + storagePools: + description: List of Storage Pools where boot disks are provisioned. + type: array + items: + type: string secondaryBootDiskUpdateStrategy: description: Secondary boot disk update strategy. $ref: '#/components/schemas/SecondaryBootDiskUpdateStrategy' @@ -1338,18 +1369,22 @@ components: $ref: '#/components/schemas/ClientCertificateConfig' clusterCaCertificate: description: >- - [Output only] Base64-encoded public certificate that is the root of + Output only. Base64-encoded public certificate that is the root of trust for the cluster. + readOnly: true type: string clientCertificate: description: >- - [Output only] Base64-encoded public certificate used by clients to - authenticate to the cluster endpoint. + Output only. Base64-encoded public certificate used by clients to + authenticate to the cluster endpoint. Issued only if + client_certificate_config is set. + readOnly: true type: string clientKey: description: >- - [Output only] Base64-encoded private key used by clients to + Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + readOnly: true type: string ClientCertificateConfig: id: ClientCertificateConfig @@ -1421,6 +1456,9 @@ components: statefulHaConfig: description: Optional. Configuration for the StatefulHA add-on. $ref: '#/components/schemas/StatefulHAConfig' + rayOperatorConfig: + description: Optional. Configuration for Ray Operator addon. + $ref: '#/components/schemas/RayOperatorConfig' HttpLoadBalancing: id: HttpLoadBalancing description: >- @@ -1547,6 +1585,38 @@ components: enabled: description: Whether the Stateful HA add-on is enabled for this cluster. type: boolean + RayOperatorConfig: + id: RayOperatorConfig + description: Configuration options for the Ray Operator add-on. + type: object + properties: + enabled: + description: Whether the Ray Operator addon is enabled for this cluster. + type: boolean + rayClusterLoggingConfig: + description: Optional. Logging configuration for Ray clusters. + $ref: '#/components/schemas/RayClusterLoggingConfig' + rayClusterMonitoringConfig: + description: Optional. Monitoring configuration for Ray clusters. + $ref: '#/components/schemas/RayClusterMonitoringConfig' + RayClusterLoggingConfig: + id: RayClusterLoggingConfig + description: RayClusterLoggingConfig specifies configuration of Ray logging. + type: object + properties: + enabled: + description: Enable log collection for Ray clusters. + type: boolean + RayClusterMonitoringConfig: + id: RayClusterMonitoringConfig + description: >- + RayClusterMonitoringConfig specifies monitoring configuration for Ray + clusters. + type: object + properties: + enabled: + description: Enable metrics collection for Ray clusters. + type: boolean NodePool: id: NodePool description: >- @@ -1591,7 +1661,8 @@ components: overrides the cluster-level defaults. $ref: '#/components/schemas/NodeNetworkConfig' selfLink: - description: '[Output only] Server-defined URL for the resource.' + description: Output only. Server-defined URL for the resource. + readOnly: true type: string version: description: >- @@ -1601,15 +1672,17 @@ components: type: string instanceGroupUrls: description: >- - [Output only] The resource URLs of the [managed instance + Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + readOnly: true type: array items: type: string status: - description: '[Output only] The status of the nodes in this pool instance.' + description: Output only. The status of the nodes in this pool instance. + readOnly: true type: string enumDescriptions: - Not set. @@ -1640,9 +1713,10 @@ components: - ERROR statusMessage: description: >- - [Output only] Deprecated. Use conditions instead. Additional + Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + readOnly: true deprecated: true type: string autoscaling: @@ -1664,7 +1738,8 @@ components: items: $ref: '#/components/schemas/StatusCondition' podIpv4CidrSize: - description: '[Output only] The pod CIDR block size per node in this node pool.' + description: Output only. The pod CIDR block size per node in this node pool. + readOnly: true type: integer format: int32 upgradeSettings: @@ -1675,8 +1750,8 @@ components: $ref: '#/components/schemas/PlacementPolicy' updateInfo: description: >- - Output only. [Output only] Update info contains relevant information - during a node pool update. + Output only. Update info contains relevant information during a node + pool update. readOnly: true $ref: '#/components/schemas/UpdateInfo' etag: @@ -1762,9 +1837,9 @@ components: $ref: '#/components/schemas/AdditionalPodNetworkConfig' podIpv4RangeUtilization: description: >- - Output only. [Output only] The utilization of the IPv4 range for the - pod. The ratio is Usage/[Total number of IPs in the secondary - range], Usage=numNodes*numZones*podIPsPerNode. + Output only. The utilization of the IPv4 range for the pod. The + ratio is Usage/[Total number of IPs in the secondary range], + Usage=numNodes*numZones*podIPsPerNode. readOnly: true type: number format: double @@ -1813,15 +1888,15 @@ components: type: object properties: subnetwork: - description: Name of the subnetwork where the additional pod network belongs + description: Name of the subnetwork where the additional pod network belongs. type: string secondaryPodRange: description: >- The name of the secondary range on the subnet which provides IP - address for this pod range + address for this pod range. type: string maxPodsPerNode: - description: The maximum number of pods per node which use this pod network + description: The maximum number of pods per node which use this pod network. $ref: '#/components/schemas/MaxPodsConstraint' MaxPodsConstraint: id: MaxPodsConstraint @@ -1919,14 +1994,16 @@ components: properties: autoUpgradeStartTime: description: >- - [Output only] This field is set when upgrades are about to commence + Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + readOnly: true type: string description: description: >- - [Output only] This field is set when upgrades are about to commence + Output only. This field is set when upgrades are about to commence with the description of the upgrade. + readOnly: true type: string StatusCondition: id: StatusCondition @@ -2487,30 +2564,26 @@ components: (/27) when overprovisioning is disabled. $ref: '#/components/schemas/PodCIDROverprovisionConfig' subnetIpv6CidrBlock: - description: >- - Output only. [Output only] The subnet's IPv6 CIDR block used by - nodes and pods. + description: Output only. The subnet's IPv6 CIDR block used by nodes and pods. readOnly: true type: string servicesIpv6CidrBlock: - description: >- - Output only. [Output only] The services IPv6 CIDR block for the - cluster. + description: Output only. The services IPv6 CIDR block for the cluster. readOnly: true type: string additionalPodRangesConfig: description: >- - Output only. [Output only] The additional pod ranges that are added - to the cluster. These pod ranges can be used by new node pools to - allocate pod IPs automatically. Once the range is removed it will - not show up in IPAllocationPolicy. + Output only. The additional pod ranges that are added to the + cluster. These pod ranges can be used by new node pools to allocate + pod IPs automatically. Once the range is removed it will not show up + in IPAllocationPolicy. readOnly: true $ref: '#/components/schemas/AdditionalPodRangesConfig' defaultPodIpv4RangeUtilization: description: >- - Output only. [Output only] The utilization of the cluster default - IPv4 range for the pod. The ratio is Usage/[Total number of IPs in - the secondary range], Usage=numNodes*numZones*podIPsPerNode. + Output only. The utilization of the cluster default IPv4 range for + the pod. The ratio is Usage/[Total number of IPs in the secondary + range], Usage=numNodes*numZones*podIPsPerNode. readOnly: true type: number format: double @@ -2529,7 +2602,7 @@ components: items: type: string podRangeInfo: - description: Output only. [Output only] Information for additional pod range. + description: Output only. Information for additional pod range. readOnly: true type: array items: @@ -2542,11 +2615,11 @@ components: type: object properties: rangeName: - description: Output only. [Output only] Name of a range. + description: Output only. Name of a range. readOnly: true type: string utilization: - description: Output only. [Output only] The utilization of the range. + description: Output only. The utilization of the range. readOnly: true type: number format: double @@ -2645,9 +2718,10 @@ components: type: string duration: description: >- - [Output only] Duration of the time window, automatically chosen to - be smallest possible in the given scenario. Duration will be in + Output only. Duration of the time window, automatically chosen to be + smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + readOnly: true type: string RecurringTimeWindow: id: RecurringTimeWindow @@ -2895,6 +2969,7 @@ components: network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + readOnly: true type: string subnetwork: description: >- @@ -2902,6 +2977,7 @@ components: [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + readOnly: true type: string enableIntraNodeVisibility: description: >- @@ -3065,8 +3141,15 @@ components: enumDescriptions: - Default value. - Gateway API support is disabled - - Gateway API support is enabled, experimental CRDs are installed + - >- + Deprecated: use CHANNEL_STANDARD instead. Gateway API support is + enabled, experimental CRDs are installed - Gateway API support is enabled, standard CRDs are installed + enumDeprecated: + - false + - false + - true + - false enum: - CHANNEL_UNSPECIFIED - CHANNEL_DISABLED @@ -3169,16 +3252,19 @@ components: description: >- Output only. The internal IP address of this cluster's master endpoint. + readOnly: true type: string publicEndpoint: description: >- Output only. The external IP address of this cluster's master endpoint. + readOnly: true type: string peeringName: description: >- Output only. The peering name in the customer VPC used by this cluster. + readOnly: true type: string masterGlobalAccessConfig: description: Controls master global access settings. @@ -3330,11 +3416,16 @@ components: - >- Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production. + - >- + Clusters subscribed to EXTENDED receive extended support and + availability for versions which are known to be stable and + reliable in production. enum: - UNSPECIFIED - RAPID - REGULAR - STABLE + - EXTENDED WorkloadIdentityConfig: id: WorkloadIdentityConfig description: >- @@ -3568,6 +3659,7 @@ components: - Statefulset - CADVISOR - KUBELET + - NVIDIA Data Center GPU Manager (DCGM) enum: - COMPONENT_UNSPECIFIED - SYSTEM_COMPONENTS @@ -3582,6 +3674,7 @@ components: - STATEFULSET - CADVISOR - KUBELET + - DCGM ManagedPrometheusConfig: id: ManagedPrometheusConfig description: >- @@ -3668,14 +3761,16 @@ components: type: string membership: description: >- - [Output only] The full resource name of the registered fleet + Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + readOnly: true type: string preRegistered: description: >- - [Output only] Whether the cluster has been registered through the + Output only. Whether the cluster has been registered through the fleet API. + readOnly: true type: boolean SecurityPostureConfig: id: SecurityPostureConfig @@ -3731,8 +3826,8 @@ components: properties: clusterTier: description: >- - Output only. [Output only] cluster_tier specifies the premium tier - of the cluster. + Output only. cluster_tier indicates the effective tier of the + cluster. readOnly: true type: string enumDescriptions: @@ -3743,6 +3838,62 @@ components: - CLUSTER_TIER_UNSPECIFIED - STANDARD - ENTERPRISE + SecretManagerConfig: + id: SecretManagerConfig + description: SecretManagerConfig is config for secret manager enablement. + type: object + properties: + enabled: + description: Enable/Disable Secret Manager Config. + type: boolean + CompliancePostureConfig: + id: CompliancePostureConfig + description: >- + CompliancePostureConfig defines the settings needed to enable/disable + features for the Compliance Posture. + type: object + properties: + mode: + description: Defines the enablement mode for Compliance Posture. + type: string + enumDescriptions: + - Default value not specified. + - Disables Compliance Posture features on the cluster. + - Enables Compliance Posture features on the cluster. + enum: + - MODE_UNSPECIFIED + - DISABLED + - ENABLED + complianceStandards: + description: List of enabled compliance standards. + type: array + items: + $ref: '#/components/schemas/ComplianceStandard' + ComplianceStandard: + id: ComplianceStandard + description: Defines the details of a compliance standard. + type: object + properties: + standard: + description: Name of the compliance standard. + type: string + RBACBindingConfig: + id: RBACBindingConfig + description: >- + RBACBindingConfig allows user to restrict ClusterRoleBindings an + RoleBindings that can be created. + type: object + properties: + enableInsecureBindingSystemUnauthenticated: + description: >- + Setting this to true will allow any ClusterRoleBinding and + RoleBinding with subjets system:anonymous or system:unauthenticated. + type: boolean + enableInsecureBindingSystemAuthenticated: + description: >- + Setting this to true will allow any ClusterRoleBinding and + RoleBinding with subjects system:authenticated. + type: boolean CreateClusterRequest: id: CreateClusterRequest description: CreateClusterRequest creates a cluster. @@ -3781,18 +3932,21 @@ components: type: object properties: name: - description: The server-assigned ID for the operation. + description: Output only. The server-assigned ID for the operation. + readOnly: true type: string zone: description: >- - The name of the Google Compute Engine + Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + readOnly: true deprecated: true type: string operationType: - description: The operation type. + description: Output only. The operation type. + readOnly: true type: string enumDescriptions: - Not set. @@ -3920,7 +4074,8 @@ components: - RESIZE_CLUSTER - FLEET_FEATURE_UPGRADE status: - description: The current status of the operation. + description: Output only. The current status of the operation. + readOnly: true type: string enumDescriptions: - Not set. @@ -3935,7 +4090,8 @@ components: - DONE - ABORTING detail: - description: Detailed operation progress, if available. + description: Output only. Detailed operation progress, if available. + readOnly: true type: string statusMessage: description: >- @@ -3946,41 +4102,46 @@ components: type: string selfLink: description: >- - Server-defined URI for the operation. Example: + Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + readOnly: true type: string targetLink: description: >- - Server-defined URI for the target of the operation. The format of - this is a URI to the resource being modified (such as a cluster, - node pool, or node). For node pool repairs, there may be multiple - nodes being repaired, but only one will be the target. Examples: - - ## + Output only. Server-defined URI for the target of the operation. The + format of this is a URI to the resource being modified (such as a + cluster, node pool, or node). For node pool repairs, there may be + multiple nodes being repaired, but only one will be the target. + Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + readOnly: true type: string location: description: >- - [Output only] The name of the Google Compute Engine + Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + readOnly: true type: string startTime: description: >- - [Output only] The time the operation started, in + Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + readOnly: true type: string endTime: description: >- - [Output only] The time the operation completed, in + Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + readOnly: true type: string progress: - description: Output only. [Output only] Progress information for an operation. + description: Output only. Progress information for an operation. readOnly: true $ref: '#/components/schemas/OperationProgress' clusterConditions: @@ -4432,6 +4593,12 @@ components: desiredEnableCiliumClusterwideNetworkPolicy: description: Enable/Disable Cilium Clusterwide Network Policy for the cluster. type: boolean + desiredSecretManagerConfig: + description: Enable/Disable Secret Manager Config. + $ref: '#/components/schemas/SecretManagerConfig' + desiredCompliancePostureConfig: + description: Enable/Disable Compliance Posture features for the cluster. + $ref: '#/components/schemas/CompliancePostureConfig' desiredNodeKubeletConfig: description: The desired node kubelet config for the cluster. $ref: '#/components/schemas/NodeKubeletConfig' @@ -4440,6 +4607,11 @@ components: The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. $ref: '#/components/schemas/NodeKubeletConfig' + desiredRbacBindingConfig: + description: >- + RBACBindingConfig allows user to restrict ClusterRoleBindings an + RoleBindings that can be created. + $ref: '#/components/schemas/RBACBindingConfig' IntraNodeVisibilityConfig: id: IntraNodeVisibilityConfig description: >- @@ -4637,6 +4809,13 @@ components: queuedProvisioning: description: Specifies the configuration of queued provisioning. $ref: '#/components/schemas/QueuedProvisioning' + storagePools: + description: >- + List of Storage Pools where boot disks are provisioned. Existing + Storage Pools will be replaced with storage-pools. + type: array + items: + type: string NodeTaints: id: NodeTaints description: >- @@ -5085,11 +5264,16 @@ components: - >- Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production. + - >- + Clusters subscribed to EXTENDED receive extended support and + availability for versions which are known to be stable and + reliable in production. enum: - UNSPECIFIED - RAPID - REGULAR - STABLE + - EXTENDED defaultVersion: description: The default version for newly created clusters on the channel. type: string @@ -5988,23 +6172,21 @@ components: #/components/x-stackQL-resources/server_config/methods/projects_locations_get_server_config insert: [] update: [] + replace: [] delete: [] clusters: id: google.container.clusters name: clusters title: Clusters methods: - _projects_locations_clusters_list: - operation: &ref_1 + projects_locations_clusters_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clusters - projects_locations_clusters_list: - operation: *ref_1 - response: *ref_2 projects_locations_clusters_create: operation: $ref: >- @@ -6242,7 +6424,8 @@ components: #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_create - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_zones_clusters_create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_locations_clusters_update - $ref: >- @@ -6267,7 +6450,10 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/clusters_master/methods/projects_locations_clusters_update_master + replace: [] delete: [] clusters_jwks: id: google.container.clusters_jwks @@ -6287,6 +6473,7 @@ components: #/components/x-stackQL-resources/clusters_jwks/methods/projects_locations_clusters_get_jwks insert: [] update: [] + replace: [] delete: [] node_pools: id: google.container.node_pools @@ -6442,10 +6629,11 @@ components: - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_create update: - - $ref: >- - #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_update - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_zones_clusters_node_pools_update + replace: + - $ref: >- + #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_update delete: - $ref: >- #/components/x-stackQL-resources/node_pools/methods/projects_locations_clusters_node_pools_delete @@ -6469,6 +6657,7 @@ components: #/components/x-stackQL-resources/well_known_openid_configuration/methods/projects_locations_clusters_well-known_get_openid-configuration insert: [] update: [] + replace: [] delete: [] operations: id: google.container.operations @@ -6528,6 +6717,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_zones_operations_list insert: [] update: [] + replace: [] delete: [] zones_serverconfig: id: google.container.zones_serverconfig @@ -6547,6 +6737,7 @@ components: #/components/x-stackQL-resources/zones_serverconfig/methods/projects_zones_get_serverconfig insert: [] update: [] + replace: [] delete: [] clusters_ons: id: google.container.clusters_ons @@ -6562,35 +6753,36 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/clusters_ons/methods/projects_zones_clusters_addons update: [] + replace: [] delete: [] usable_subnetworks: id: google.container.usable_subnetworks name: usable_subnetworks title: Usable_subnetworks methods: - _projects_aggregated_usable_subnetworks_list: - operation: &ref_3 + projects_aggregated_usable_subnetworks_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1aggregated~1usableSubnetworks/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.subnetworks - projects_aggregated_usable_subnetworks_list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/usable_subnetworks/methods/projects_aggregated_usable_subnetworks_list insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/serverConfig: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -6637,7 +6829,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Lists all clusters owned by a project in either the specified zone or @@ -6715,7 +6907,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets the details of a specific cluster. operationId: container.projects.locations.clusters.get @@ -6844,7 +7036,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the logging service for a specific cluster. operationId: container.projects.locations.clusters.setLogging @@ -6882,7 +7074,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the monitoring service for a specific cluster. operationId: container.projects.locations.clusters.setMonitoring @@ -6920,7 +7112,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the addons for a specific cluster. operationId: container.projects.locations.clusters.setAddons @@ -6958,7 +7150,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Sets the locations for a specific cluster. Deprecated. Use @@ -6999,7 +7191,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster: - parameters: *ref_5 + parameters: *ref_1 post: description: Updates the master for a specific cluster. operationId: container.projects.locations.clusters.updateMaster @@ -7037,7 +7229,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Sets master auth materials. Currently supports changing the admin @@ -7078,7 +7270,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Gets the public component of the cluster signing keys in JSON Web Key @@ -7109,7 +7301,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets labels on a cluster. operationId: container.projects.locations.clusters.setResourceLabels @@ -7147,7 +7339,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac: - parameters: *ref_5 + parameters: *ref_1 post: description: Enables or disables the ABAC authorization mechanism on a cluster. operationId: container.projects.locations.clusters.setLegacyAbac @@ -7185,7 +7377,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation: - parameters: *ref_5 + parameters: *ref_1 post: description: Starts master IP rotation. operationId: container.projects.locations.clusters.startIpRotation @@ -7223,7 +7415,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation: - parameters: *ref_5 + parameters: *ref_1 post: description: Completes master IP rotation. operationId: container.projects.locations.clusters.completeIpRotation @@ -7261,7 +7453,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: Enables or disables Network Policy for a cluster. operationId: container.projects.locations.clusters.setNetworkPolicy @@ -7299,7 +7491,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the maintenance policy for a cluster. operationId: container.projects.locations.clusters.setMaintenancePolicy @@ -7337,7 +7529,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:checkAutopilotCompatibility: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Checks the cluster compatibility with Autopilot mode, and returns a list @@ -7372,7 +7564,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}: - parameters: *ref_5 + parameters: *ref_1 put: description: Updates the version and/or image type for the specified node pool. operationId: container.projects.locations.clusters.nodePools.update @@ -7519,7 +7711,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the autoscaling settings for the specified node pool. operationId: container.projects.locations.clusters.nodePools.setAutoscaling @@ -7562,7 +7754,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists the node pools for a cluster. operationId: container.projects.locations.clusters.nodePools.list @@ -7643,7 +7835,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:completeUpgrade: - parameters: *ref_5 + parameters: *ref_1 post: description: >- CompleteNodePoolUpgrade will signal an on-going node pool upgrade to @@ -7688,7 +7880,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Rolls back a previously Aborted or Failed NodePool upgrade. This makes @@ -7733,7 +7925,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the NodeManagement options for a node pool. operationId: container.projects.locations.clusters.nodePools.setManagement @@ -7776,7 +7968,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setSize: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Sets the size for a specific node pool. The new size will be used for @@ -7822,7 +8014,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Gets the OIDC discovery document for the cluster. See the [OpenID @@ -7855,7 +8047,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists all operations in a project in a specific zone or all zones. operationId: container.projects.locations.operations.list @@ -7891,7 +8083,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets the specified operation. operationId: container.projects.locations.operations.get @@ -7936,7 +8128,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_5 + parameters: *ref_1 post: description: Cancels the specified operation. operationId: container.projects.locations.operations.cancel @@ -7974,7 +8166,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/serverconfig: - parameters: *ref_5 + parameters: *ref_1 get: description: Returns configuration info about the Google Kubernetes Engine service. operationId: container.projects.zones.getServerconfig @@ -8006,7 +8198,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Lists all clusters owned by a project in either the specified zone or @@ -8080,7 +8272,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets the details of a specific cluster. operationId: container.projects.zones.clusters.get @@ -8193,7 +8385,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the logging service for a specific cluster. operationId: container.projects.zones.clusters.logging @@ -8231,7 +8423,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the monitoring service for a specific cluster. operationId: container.projects.zones.clusters.monitoring @@ -8269,7 +8461,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the addons for a specific cluster. operationId: container.projects.zones.clusters.addons @@ -8307,7 +8499,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Sets the locations for a specific cluster. Deprecated. Use @@ -8348,7 +8540,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master: - parameters: *ref_5 + parameters: *ref_1 post: description: Updates the master for a specific cluster. operationId: container.projects.zones.clusters.master @@ -8386,7 +8578,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Sets master auth materials. Currently supports changing the admin @@ -8427,7 +8619,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets labels on a cluster. operationId: container.projects.zones.clusters.resourceLabels @@ -8465,7 +8657,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac: - parameters: *ref_5 + parameters: *ref_1 post: description: Enables or disables the ABAC authorization mechanism on a cluster. operationId: container.projects.zones.clusters.legacyAbac @@ -8503,7 +8695,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation: - parameters: *ref_5 + parameters: *ref_1 post: description: Starts master IP rotation. operationId: container.projects.zones.clusters.startIpRotation @@ -8541,7 +8733,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation: - parameters: *ref_5 + parameters: *ref_1 post: description: Completes master IP rotation. operationId: container.projects.zones.clusters.completeIpRotation @@ -8579,7 +8771,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: Enables or disables Network Policy for a cluster. operationId: container.projects.zones.clusters.setNetworkPolicy @@ -8617,7 +8809,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the maintenance policy for a cluster. operationId: container.projects.zones.clusters.setMaintenancePolicy @@ -8655,7 +8847,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update: - parameters: *ref_5 + parameters: *ref_1 post: description: Updates the version and/or image type for the specified node pool. operationId: container.projects.zones.clusters.nodePools.update @@ -8698,7 +8890,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the autoscaling settings for the specified node pool. operationId: container.projects.zones.clusters.nodePools.autoscaling @@ -8741,7 +8933,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists the node pools for a cluster. operationId: container.projects.zones.clusters.nodePools.list @@ -8814,7 +9006,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Retrieves the requested node pool. operationId: container.projects.zones.clusters.nodePools.get @@ -8896,7 +9088,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Rolls back a previously Aborted or Failed NodePool upgrade. This makes @@ -8941,7 +9133,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement: - parameters: *ref_5 + parameters: *ref_1 post: description: Sets the NodeManagement options for a node pool. operationId: container.projects.zones.clusters.nodePools.setManagement @@ -8984,7 +9176,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Sets the size for a specific node pool. The new size will be used for @@ -9030,7 +9222,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/operations: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists all operations in a project in a specific zone or all zones. operationId: container.projects.zones.operations.list @@ -9062,7 +9254,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/operations/{operationId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets the specified operation. operationId: container.projects.zones.operations.get @@ -9099,7 +9291,7 @@ paths: schema: type: string /v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel: - parameters: *ref_5 + parameters: *ref_1 post: description: Cancels the specified operation. operationId: container.projects.zones.operations.cancel @@ -9137,7 +9329,7 @@ paths: schema: type: string /v1/projects/{projectsId}/aggregated/usableSubnetworks: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists subnetworks that are usable for creating clusters in a project. operationId: container.projects.aggregated.usableSubnetworks.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml index 7a5d6326..02ea576e 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/containeranalysis.yaml @@ -12,8 +12,8 @@ info: is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/container-analysis/api/reference/rest/ servers: @@ -39,221 +39,225 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - Category: - description: The category to which the update belongs. + SetIamPolicyRequest: + id: SetIamPolicyRequest type: object - id: Category properties: - categoryId: - type: string - description: The identifier of the category. - name: - description: The localized name of the category. - type: string - GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: - description: Other properties of the build. + policy: + $ref: '#/components/schemas/Policy' + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + description: Request message for `SetIamPolicy` method. + Envelope: + id: Envelope type: object properties: - reproducible: - type: boolean - completeness: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' - buildInvocationId: - type: string - buildFinishedOn: - format: google-datetime + signatures: + type: array + items: + $ref: '#/components/schemas/EnvelopeSignature' + payload: + format: byte type: string - buildStartedOn: - format: google-datetime + payloadType: type: string - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata - ExportSBOMRequest: - properties: - cloudStorageLocation: - $ref: '#/components/schemas/CloudStorageLocation' - description: >- - Empty placeholder to denote that this is a Google Cloud Storage - export request. - id: ExportSBOMRequest - type: object - description: >- - The request to generate and export SBOM. Target must be specified for - the request. - GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: description: >- - The collection of artifacts that influenced the build including sources, - dependencies, build tools, base images, and so on. - id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial + MUST match + https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. + An authenticated message of arbitrary type. + GetPolicyOptions: + description: Encapsulates settings provided to GetIamPolicy. properties: - digest: - additionalProperties: - type: string - type: object - uri: - type: string + requestedPolicyVersion: + format: int32 + type: integer + description: >- + Optional. The maximum policy version that will be used to format the + policy. Valid values are 0, 1, and 3. Requests specifying an invalid + value will be rejected. Requests for policies with any conditional + role bindings must specify version 3. Policies with no conditional + role bindings may specify any valid value or leave the field unset. + The policy in the response might use the policy version that you + specified, or it might use a lower policy version. For example, if + you specify version 3, but the policy has no conditional role + bindings, the response uses version 1. To learn which resources + support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + id: GetPolicyOptions type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage type: object description: >- - Location of the source in a 2nd-gen Google Cloud Build repository - resource. + Npm package to upload to Artifact Registry upon successful completion of + all build steps. properties: repository: - description: >- - Required. Name of the Google Cloud Build repository, formatted as - `projects/*/locations/*/connections/*/repositories/*`. - type: string - dir: type: string description: >- - Optional. Directory, relative to the source root, in which to run - the build. - revision: + Artifact Registry repository, in the form + "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in + the workspace specified by path will be zipped and uploaded to + Artifact Registry with this location as a prefix. + packagePath: + description: Path to the package.json. e.g. workspace/path/to/package type: string - description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - Source: - description: Source describes the location of the source used for the build. - id: Source + InTotoSlsaProvenanceV1: + id: InTotoSlsaProvenanceV1 type: object properties: - context: - $ref: '#/components/schemas/SourceContext' - description: >- - If provided, the source code used for the build came from this - location. - fileHashes: - description: >- - Hash(es) of the build source, which can be used to verify that the - original source integrity was maintained in the build. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (.tar.gz), the FileHash - will be for the single path to that file. - additionalProperties: - $ref: '#/components/schemas/FileHashes' - type: object - artifactStorageSourceUri: + _type: type: string description: >- - If provided, the input binary artifacts for the build came from this - location. - additionalContexts: - description: >- - If provided, some of the source code used for the build may be found - in these locations, in the case where the source repository had - multiple remotes or submodules. This list will not include the - context specified in the context field. + InToto spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement + predicate: + $ref: '#/components/schemas/SlsaProvenanceV1' + predicateType: + type: string + subject: + items: + $ref: '#/components/schemas/Subject' + type: array + DeploymentNote: + properties: + resourceUri: type: array + description: Required. Resource URI for the artifact being deployed. items: - $ref: '#/components/schemas/SourceContext' - FixableTotalByDigest: - id: FixableTotalByDigest - description: Per resource and severity counts of fixable and total vulnerabilities. + type: string + type: object + id: DeploymentNote + description: An artifact that can be deployed in some runtime. + TestIamPermissionsRequest: properties: - fixableCount: - description: The number of fixable vulnerabilities associated with this resource. - type: string - format: int64 - severity: - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - type: string + permissions: + type: array description: >- - The severity for this count. SEVERITY_UNSPECIFIED indicates total - across all severities. - resourceUri: - type: string - description: The affected resource. - totalCount: - format: int64 - description: The total number of vulnerabilities associated with this resource. - type: string + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). + items: + type: string + description: Request message for `TestIamPermissions` method. type: object - VulnerabilityOccurrence: + id: TestIamPermissionsRequest + SBOMStatus: + id: SBOMStatus type: object - description: An occurrence of a severity vulnerability on a resource. properties: - shortDescription: - description: Output only. A one sentence description of this vulnerability. - type: string - extraDetails: + error: type: string - description: Occurrence-specific extra details about the vulnerability. - vexAssessment: - $ref: '#/components/schemas/VexAssessment' - relatedUrls: - description: Output only. URLs related to this vulnerability. - type: array - items: - $ref: '#/components/schemas/RelatedUrl' - cvssVersion: + description: >- + If there was an error generating an SBOM, this will indicate what + that error was. + sbomState: + description: The progress of the SBOM generation. type: string enumDescriptions: - - '' - - '' - - '' - description: Output only. CVSS version used to populate cvss_score and severity. + - Default unknown state. + - SBOM scanning is pending. + - SBOM scanning has completed. enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 - longDescription: - description: Output only. A detailed description of this vulnerability. - type: string - severity: - type: string - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + - SBOM_STATE_UNSPECIFIED + - PENDING + - COMPLETE + description: The status of an SBOM generation. + VexAssessment: + properties: + state: + description: Provides the state of this Vulnerability assessment. enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION + enumDescriptions: + - No state is specified. + - This product is known to be affected by this vulnerability. + - This product is known to be not affected by this vulnerability. + - This product contains a fix for this vulnerability. + - >- + It is not known yet whether these versions are or are not affected + by the vulnerability. However, it is still under investigation. + type: string + cve: + type: string description: >- - Output only. The note provider assigned severity of this + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. + deprecated: true + relatedUris: + type: array + description: >- + Holds a list of references associated with this vulnerability item + and assessment. + items: + $ref: '#/components/schemas/RelatedUrl' + justification: + description: >- + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + $ref: '#/components/schemas/Justification' + impacts: + type: array + description: >- + Contains information about the impact of this vulnerability, this + will change with time. + items: + type: string + remediations: + items: + $ref: '#/components/schemas/Remediation' + type: array + description: >- + Specifies details on how to handle (and presumably, fix) a vulnerability. - type: + noteName: description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). + The VulnerabilityAssessment note from which this VexAssessment was + generated. This will be of the form: + `projects/[PROJECT_ID]/notes/[NOTE_ID]`. type: string - packageIssue: + vulnerabilityId: + description: >- + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. + type: string + type: object + description: >- + VexAssessment provides all publisher provided Vex information that is + related to this vulnerability. + id: VexAssessment + PackageIssue: + properties: + fixedVersion: + description: >- + Required. The version of the package this vulnerability was fixed + in. Setting this to VersionKind.MAXIMUM means no fix is yet + available. + $ref: '#/components/schemas/Version' + fileLocation: type: array items: - $ref: '#/components/schemas/PackageIssue' + $ref: '#/components/schemas/GrafeasV1FileLocation' + description: The location at which this package was found. + fixedCpeUri: + type: string description: >- - Required. The set of affected locations and their fixes (if - available) within the associated resource. + The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was fixed in. It is possible for this to be different + from the affected_cpe_uri. + fixAvailable: + description: Output only. Whether a fix is available for this package. + type: boolean effectiveSeverity: - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. enum: - SEVERITY_UNSPECIFIED - MINIMAL @@ -261,82 +265,120 @@ components: - MEDIUM - HIGH - CRITICAL + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + readOnly: true + type: string description: >- - The distro assigned severity for this vulnerability when it is - available, otherwise this is the note provider assigned severity. - When there are multiple PackageIssues for this vulnerability, they - can have different effective severities because some might be - provided by the distro while others are provided by the language - ecosystem for a language pack. For this reason, it is advised to use - the effective severity on the PackageIssue level. In the case where - multiple PackageIssues have differing effective severities, this - field should be the highest severity for any of the PackageIssues. + Output only. The distro or language system assigned severity for + this vulnerability when that is available and note provider assigned + severity when it is not available. + fixedPackage: type: string - fixAvailable: description: >- - Output only. Whether at least one of the affected packages has a fix - available. - type: boolean - cvssScore: + The package this vulnerability was fixed in. It is possible for this + to be different from the affected_package. + affectedCpeUri: description: >- - Output only. The CVSS score of this vulnerability. CVSS score is on - a scale of 0 - 10 where 0 indicates low severity and 10 indicates - high severity. - format: float - type: number - cvssv3: - $ref: '#/components/schemas/CVSS' - description: The cvss v3 score for the vulnerability. - cvssV2: - description: The cvss v2 score for the vulnerability. - $ref: '#/components/schemas/CVSS' - id: VulnerabilityOccurrence - Assessment: - id: Assessment + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability was found in. + type: string + packageType: + type: string + description: The type of package (e.g. OS, MAVEN, GO). + affectedVersion: + $ref: '#/components/schemas/Version' + description: >- + Required. The version of the package that is installed on the + resource affected by this vulnerability. + affectedPackage: + type: string + description: Required. The package this vulnerability was found in. + id: PackageIssue description: >- - Assessment provides all information that is related to a single - vulnerability for this product. + A detail for a distro and package this vulnerability occurrence was + found in and its associated fix (if one is available). + type: object + UpgradeNote: properties: - shortDescription: + windowsUpdate: + description: >- + Required for Windows OS. Represents the metadata about the Windows + update. + $ref: '#/components/schemas/WindowsUpdate' + package: type: string - description: A one sentence description of this Vex. - impacts: + description: Required for non-Windows OS. The package this Upgrade is for. + distributions: + items: + $ref: '#/components/schemas/UpgradeDistribution' type: array + description: Metadata about the upgrade for each specific operating system. + version: description: >- - Contains information about the impact of this vulnerability, this - will change with time. + Required for non-Windows OS. The version of the package in machine + + human readable form. + $ref: '#/components/schemas/Version' + type: object + id: UpgradeNote + description: >- + An Upgrade Note represents a potential upgrade of a package to a given + version. For each package version combination (i.e. bash 4.0, bash 4.1, + bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update + field represents the information related to the update. + Material: + type: object + properties: + uri: + type: string + digest: + additionalProperties: + type: string + type: object + id: Material + Assessment: + type: object + properties: + impacts: + type: array items: type: string - cve: - deprecated: true - description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. - type: string - vulnerabilityId: - description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. - type: string - justification: - $ref: '#/components/schemas/Justification' description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. + Contains information about the impact of this vulnerability, this + will change with time. relatedUris: items: $ref: '#/components/schemas/RelatedUrl' + type: array description: >- Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability. - type: array + longDescription: + type: string + description: A detailed description of this Vex. + cve: + deprecated: true + type: string + description: >- + Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) + tracking number for the vulnerability. Deprecated: Use + vulnerability_id instead to denote CVEs. state: type: string - description: Provides the state of this Vulnerability assessment. + enum: + - STATE_UNSPECIFIED + - AFFECTED + - NOT_AFFECTED + - FIXED + - UNDER_INVESTIGATION enumDescriptions: - No state is specified. - This product is known to be affected by this vulnerability. @@ -345,12 +387,10 @@ components: - >- It is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation. - enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION + description: Provides the state of this Vulnerability assessment. + shortDescription: + description: A one sentence description of this Vex. + type: string remediations: description: >- Specifies details on how to handle (and presumably, fix) a @@ -358,95 +398,133 @@ components: type: array items: $ref: '#/components/schemas/Remediation' - longDescription: - type: string - description: A detailed description of this Vex. - type: object - CloudRepoSourceContext: - type: object - properties: - repoId: - description: The ID of the repo. - $ref: '#/components/schemas/RepoId' - revisionId: - type: string - description: A revision ID. - aliasContext: - description: An alias, which may be a branch or tag. - $ref: '#/components/schemas/AliasContext' - description: >- - A CloudRepoSourceContext denotes a particular revision in a Google Cloud - Source Repo. - id: CloudRepoSourceContext - Jwt: - properties: - compactJwt: + justification: description: >- - The compact encoding of a JWS, which is always three base64 encoded - strings joined by periods. For details, see: - https://tools.ietf.org/html/rfc7515.html#section-3.1 + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. + $ref: '#/components/schemas/Justification' + vulnerabilityId: + description: >- + The vulnerability identifier for this Assessment. Will hold one of + common identifiers e.g. CVE, GHSA etc. type: string - type: object - id: Jwt - BatchCreateOccurrencesRequest: - id: BatchCreateOccurrencesRequest + id: Assessment + description: >- + Assessment provides all information that is related to a single + vulnerability for this product. + AnalysisCompleted: + description: >- + Indicates which analysis completed successfully. Multiple types of + analysis can be performed on a single resource. properties: - occurrences: - description: Required. The occurrences to create. Max allowed length is 1000. + analysisType: items: - $ref: '#/components/schemas/Occurrence' + type: string type: array type: object - description: Request to create occurrences in batch. - AttestationOccurrence: + id: AnalysisCompleted + Signature: type: object - description: >- - Occurrence that represents a single "attestation". The authenticity of - an attestation can be verified using the attached signature. If the - verifier trusts the public key of the signer, then verifying the - signature is sufficient to establish trust. In this circumstance, the - authority to which this attestation is attached is primarily useful for - lookup (how to find this attestation if you already know the authority - and artifact to be verified) and intent (for which authority this - attestation was intended to sign. - id: AttestationOccurrence + id: Signature properties: - serializedPayload: + signature: + type: string + description: >- + The content of the signature, an opaque bytestring. The payload that + this signature verifies MUST be unambiguously provided with the + Signature during verification. A wrapper message might provide the + payload explicitly. Alternatively, a message might have a canonical + serialization that can always be unambiguously computed to derive + the payload. format: byte + publicKeyId: + description: >- + The identifier for the public key that verifies this signature. * + The `public_key_id` is required. * The `public_key_id` SHOULD be an + RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD + be an immutable reference, such as a cryptographic digest. Examples + of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * + "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See + https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for + more details on this scheme. RFC6920 digest-named + SubjectPublicKeyInfo (digest of the DER serialization): * + "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * + "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" type: string + description: >- + Verifiers (e.g. Kritis implementations) MUST verify signatures with + respect to the trust anchors defined in policy (e.g. a Kritis policy). + Typically this means that the verifier has been configured with a map + from `public_key_id` to public key material (and any required + parameters, e.g. signing algorithm). In particular, verification + implementations MUST NOT treat the signature `public_key_id` as anything + more than a key lookup hint. The `public_key_id` DOES NOT validate or + authenticate a public key; it only provides a mechanism for quickly + selecting a public key ALREADY CONFIGURED on the verifier through a + trusted channel. Verification implementations MUST reject signatures in + any of the following circumstances: * The `public_key_id` is not + recognized by the verifier. * The public key that `public_key_id` refers + to does not verify the signature with respect to the payload. The + `signature` contents SHOULD NOT be "attached" (where the payload is + included with the serialized `signature` bytes). Verifiers MUST ignore + any "attached" payload and only verify signatures with respect to + explicitly provided payload (e.g. a `payload` field on the proto message + that holds this Signature, or the canonical serialization of the proto + message that holds this signature). + Expr: + 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. + type: object + properties: + title: description: >- - Required. The serialized payload that is verified by one or more - `signatures`. - signatures: + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + expression: description: >- - One or more signatures over `serialized_payload`. Verifier - implementations should consider this attestation message verified if - at least one `signature` verifies `serialized_payload`. See - `Signature` in common.proto for more details on signature structure - and verification. - items: - $ref: '#/components/schemas/Signature' - type: array - jwts: - items: - $ref: '#/components/schemas/Jwt' - type: array + Textual representation of an expression in Common Expression + Language syntax. + type: string + description: description: >- - One or more JWTs encoding a self-contained attestation. Each JWT - encodes the payload that it verifies within the JWT itself. Verifier - implementation SHOULD ignore the `serialized_payload` field when - verifying these JWTs. If only JWTs are present on this - AttestationOccurrence, then the `serialized_payload` SHOULD be left - empty. Each JWT SHOULD encode a claim specific to the `resource_uri` - of this Occurrence, but this is not validated by Grafeas metadata - API implementations. The JWT itself is opaque to Grafeas. + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + location: + type: string + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + id: Expr Product: type: object + id: Product description: >- Product contains information about a product and how to uniquely identify it. - id: Product properties: + genericUri: + description: >- + Contains a URI which is vendor-specific. Example: The artifact + repository URL of an image. + type: string id: description: >- Token that identifies a product so that it can be referred to from @@ -454,685 +532,818 @@ components: as it uniquely identifies a group in the context of the current document. type: string - genericUri: - description: >- - Contains a URI which is vendor-specific. Example: The artifact - repository URL of an image. - type: string name: type: string description: Name of the product. - VulnerabilityNote: - description: A security vulnerability that can be found in resources. + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: type: object - id: VulnerabilityNote properties: - cvssV3: - $ref: '#/components/schemas/CVSSv3' - description: The full description of the CVSSv3 for this vulnerability. - severity: - description: The note provider assigned severity of this vulnerability. - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + type: enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL + - FAILURE_TYPE_UNSPECIFIED + - PUSH_FAILED + - PUSH_IMAGE_NOT_FOUND + - PUSH_NOT_AUTHORIZED + - LOGGING_FAILURE + - USER_BUILD_STEP + - FETCH_SOURCE_FAILED + description: The name of the failure. type: string - cvssVersion: + enumDescriptions: + - Type unspecified + - Unable to push the image to the repository. + - Final image not found. + - Unauthorized push of the final image. + - Backend logging failures. Should retry. + - A build step has failed. + - The source fetching has failed. + detail: + type: string + description: Explains the failure issue in more detail using hard-coded text. + description: A fatal problem encountered during the execution of the build. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + SlsaBuilder: + type: object + id: SlsaBuilder + properties: + id: + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: + type: object + properties: + pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + image. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + name: + description: >- + Name used to push the container image to Google Container Registry, + as presented to `docker push`. + type: string + digest: + description: Docker Registry 2.0 digest. + type: string + description: An image built by the pipeline. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage + CVSSv3: + properties: + attackVector: enumDescriptions: - '' - '' - '' - description: CVSS version used to populate cvss_score and severity. + - '' + - '' enum: - - CVSS_VERSION_UNSPECIFIED - - CVSS_VERSION_2 - - CVSS_VERSION_3 + - ATTACK_VECTOR_UNSPECIFIED + - ATTACK_VECTOR_NETWORK + - ATTACK_VECTOR_ADJACENT + - ATTACK_VECTOR_LOCAL + - ATTACK_VECTOR_PHYSICAL type: string - windowsDetails: - type: array - description: >- - Windows details get their own format because the information format - and model don't match a normal detail. Specifically Windows updates - are done as patches, thus Windows vulnerabilities really are a - missing package, rather than a package being at an incorrect - version. - items: - $ref: '#/components/schemas/WindowsDetail' - cvssV2: - $ref: '#/components/schemas/CVSS' - description: The full description of the v2 CVSS for this vulnerability. - sourceUpdateTime: description: >- - The time this information was last changed at the source. This is an - upstream timestamp from the underlying information source - e.g. - Ubuntu security tracker. - format: google-datetime + Base Metrics Represents the intrinsic characteristics of a + vulnerability that are constant over time and across user + environments. + integrityImpact: + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + enumDescriptions: + - '' + - '' + - '' + - '' type: string - details: - items: - $ref: '#/components/schemas/Detail' - description: >- - Details of all known distros and packages affected by this - vulnerability. - type: array - cvssScore: - description: >- - The CVSS score of this vulnerability. CVSS score is on a scale of 0 - - 10 where 0 indicates low severity and 10 indicates high severity. + scope: + type: string + enumDescriptions: + - '' + - '' + - '' + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED + availabilityImpact: + enumDescriptions: + - '' + - '' + - '' + - '' + type: string + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + confidentialityImpact: + type: string + enum: + - IMPACT_UNSPECIFIED + - IMPACT_HIGH + - IMPACT_LOW + - IMPACT_NONE + enumDescriptions: + - '' + - '' + - '' + - '' + impactScore: + type: number + format: float + attackComplexity: + type: string + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + enumDescriptions: + - '' + - '' + - '' + privilegesRequired: + enumDescriptions: + - '' + - '' + - '' + - '' + type: string + enum: + - PRIVILEGES_REQUIRED_UNSPECIFIED + - PRIVILEGES_REQUIRED_NONE + - PRIVILEGES_REQUIRED_LOW + - PRIVILEGES_REQUIRED_HIGH + exploitabilityScore: format: float type: number - RepoId: - description: A unique identifier for a Cloud Repo. - id: RepoId - properties: - uid: + baseScore: + type: number + format: float + description: The base score is a function of the base metric scores. + userInteraction: + enumDescriptions: + - '' + - '' + - '' + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED type: string - description: A server-assigned, globally unique identifier. - projectRepoId: - $ref: '#/components/schemas/ProjectRepoId' - description: A combination of a project ID and a repo name. - type: object - FileHashes: - properties: - fileHash: - type: array - items: - $ref: '#/components/schemas/Hash' - description: Required. Collection of file hashes. - id: FileHashes + id: CVSSv3 type: object description: >- - Container message for hashes of byte content of files, used in source - messages to verify integrity of source input to the build. - UpgradeOccurrence: - id: UpgradeOccurrence - description: >- - An Upgrade Occurrence represents that a specific resource_url could - install a specific upgrade. This presence is supplied via local sources - (i.e. it is present in the mirror and the running system has noticed its - availability). For Windows, both distribution and windows_update contain - information for the Windows update. - properties: - distribution: - description: >- - Metadata about the upgrade for available for the specific operating - system for the resource_url. This allows efficient filtering, as - well as making it easier to use the occurrence. - $ref: '#/components/schemas/UpgradeDistribution' - parsedVersion: - description: >- - Required for non-Windows OS. The version of the package in a machine - + human readable form. - $ref: '#/components/schemas/Version' - package: - description: Required for non-Windows OS. The package this Upgrade is for. - type: string - windowsUpdate: - description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - $ref: '#/components/schemas/WindowsUpdate' - type: object - SlsaProvenance: - properties: - metadata: - $ref: '#/components/schemas/SlsaMetadata' - materials: - description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. - items: - $ref: '#/components/schemas/Material' - type: array - builder: - $ref: '#/components/schemas/SlsaBuilder' - description: required - recipe: - $ref: '#/components/schemas/SlsaRecipe' - description: >- - Identifies the configuration used for the build. When combined with - materials, this SHOULD fully describe the build, such that - re-running this recipe results in bit-for-bit identical output (if - the build is reproducible). required - type: object - id: SlsaProvenance - ImageNote: - id: ImageNote - type: object + Common Vulnerability Scoring System version 3. For details, see + https://www.first.org/cvss/specification-document + InTotoStatement: description: >- - Basis describes the base image portion (Note) of the DockerImage - relationship. Linked occurrences are derived from this or an equivalent - image via: FROM Or an equivalent reference, e.g., a tag of the - resource_url. + Spec defined at + https://github.com/in-toto/attestation/tree/main/spec#statement The + serialized InTotoStatement will be stored as Envelope.payload. + Envelope.payloadType is always "application/vnd.in-toto+json". properties: - resourceUrl: + predicateType: + description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' type: string - description: >- - Required. Immutable. The resource_url for the resource representing - the basis of associated occurrence images. - fingerprint: - description: Required. Immutable. The fingerprint of the base image. - $ref: '#/components/schemas/Fingerprint' - InTotoSlsaProvenanceV1: - id: InTotoSlsaProvenanceV1 - properties: - predicate: - $ref: '#/components/schemas/SlsaProvenanceV1' subject: items: $ref: '#/components/schemas/Subject' type: array - predicateType: - type: string _type: type: string - description: >- - InToto spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement + description: Always `https://in-toto.io/Statement/v0.1`. + slsaProvenanceZeroTwo: + $ref: '#/components/schemas/SlsaProvenanceZeroTwo' + slsaProvenance: + $ref: '#/components/schemas/SlsaProvenance' + provenance: + $ref: '#/components/schemas/InTotoProvenance' type: object - CloudStorageLocation: + id: InTotoStatement + SlsaCompleteness: description: >- - Empty placeholder to denote that this is a Google Cloud Storage export - request. - type: object - id: CloudStorageLocation - properties: {} - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: + Indicates that the builder claims certain fields in this message to be + complete. type: object + id: SlsaCompleteness properties: - priority: - type: string - description: The priority for this warning. - enumDescriptions: - - Should not be used. - - e.g. deprecation warnings and alternative feature highlights. - - e.g. automated detection of possible issues with the build. - - e.g. alerts that a feature used in the build is pending removal - enum: - - PRIORITY_UNSPECIFIED - - INFO - - WARNING - - ALERT - text: - type: string - description: Explanation of the warning generated. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning - description: A non-fatal problem encountered during the execution of the build. - AliasContext: - type: object - description: An alias to a repo revision. - id: AliasContext + arguments: + type: boolean + description: >- + If true, the builder claims that recipe.arguments is complete, + meaning that all external inputs are properly captured in the + recipe. + materials: + description: >- + If true, the builder claims that materials are complete, usually + through some controls to prevent network access. Sometimes called + "hermetic". + type: boolean + environment: + description: >- + If true, the builder claims that recipe.environment is claimed to be + complete. + type: boolean + ExportSBOMResponse: properties: - name: - description: The alias name. - type: string - kind: + discoveryOccurrence: type: string - enum: - - KIND_UNSPECIFIED - - FIXED - - MOVABLE - - OTHER - description: The alias kind. - enumDescriptions: - - Unknown. - - Git tag. - - Git branch. - - >- - Used to specify non-standard aliases. For example, if a Git repo - has a ref named "refs/foo/bar". - DSSEAttestationOccurrence: - id: DSSEAttestationOccurrence - properties: - statement: - $ref: '#/components/schemas/InTotoStatement' - envelope: - $ref: '#/components/schemas/Envelope' description: >- - If doing something security critical, make sure to verify the - signatures in this metadata. - description: >- - Deprecated. Prefer to use a regular Occurrence, and populate the - Envelope at the top level of the Occurrence. - type: object - Volume: + The name of the discovery occurrence in the form + "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to + track the progress of the SBOM export. type: object - id: Volume + id: ExportSBOMResponse + description: The response from a call to ExportSBOM. + GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: properties: - name: + createTime: + format: google-datetime + description: Output only. The time this operation was created. type: string + endTime: description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. - path: + Output only. The time that this operation was marked completed or + failed. type: string - description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. + format: google-datetime + id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata + type: object description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. Next ID: 3 - InTotoProvenance: + Metadata for all operations used and required for all operations that + created by Container Analysis Providers + AttestationOccurrence: + type: object + id: AttestationOccurrence + description: >- + Occurrence that represents a single "attestation". The authenticity of + an attestation can be verified using the attached signature. If the + verifier trusts the public key of the signer, then verifying the + signature is sufficient to establish trust. In this circumstance, the + authority to which this attestation is attached is primarily useful for + lookup (how to find this attestation if you already know the authority + and artifact to be verified) and intent (for which authority this + attestation was intended to sign. properties: - metadata: - $ref: '#/components/schemas/Metadata' - recipe: - $ref: '#/components/schemas/Recipe' - description: >- - Identifies the configuration used for the build. When combined with - materials, this SHOULD fully describe the build, such that - re-running this recipe results in bit-for-bit identical output (if - the build is reproducible). required - builderConfig: - $ref: '#/components/schemas/BuilderConfig' - description: required - materials: + jwts: type: array description: >- - The collection of artifacts that influenced the build including - sources, dependencies, build tools, base images, and so on. This is - considered to be incomplete unless metadata.completeness.materials - is true. Unset or null is equivalent to empty. + One or more JWTs encoding a self-contained attestation. Each JWT + encodes the payload that it verifies within the JWT itself. Verifier + implementation SHOULD ignore the `serialized_payload` field when + verifying these JWTs. If only JWTs are present on this + AttestationOccurrence, then the `serialized_payload` SHOULD be left + empty. Each JWT SHOULD encode a claim specific to the `resource_uri` + of this Occurrence, but this is not validated by Grafeas metadata + API implementations. The JWT itself is opaque to Grafeas. items: - type: string + $ref: '#/components/schemas/Jwt' + serializedPayload: + type: string + description: >- + Required. The serialized payload that is verified by one or more + `signatures`. + format: byte + signatures: + type: array + items: + $ref: '#/components/schemas/Signature' + description: >- + One or more signatures over `serialized_payload`. Verifier + implementations should consider this attestation message verified if + at least one `signature` verifies `serialized_payload`. See + `Signature` in common.proto for more details on signature structure + and verification. + BatchCreateNotesRequest: type: object - id: InTotoProvenance - ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret - description: >- - Pairs a set of secret environment variables mapped to encrypted values - with the Cloud KMS key to use to decrypt the value. + description: Request to create notes in batch. + id: BatchCreateNotesRequest properties: - envMap: + notes: additionalProperties: - format: byte - type: string + $ref: '#/components/schemas/Note' type: object - description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - kmsKeyName: - description: >- - Resource name of Cloud KMS crypto key to decrypt the encrypted - value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* - type: string + description: Required. The notes to create. Max allowed length is 1000. + VulnerabilityAssessmentNote: type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest properties: - object: - type: string - description: >- - Required. Cloud Storage object containing the source manifest. This - object must be a JSON file. - generation: - type: string - format: int64 - description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. - bucket: - description: >- - Required. Cloud Storage bucket containing the source manifest (see - [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + longDescription: type: string - type: object - description: >- - Location of the source manifest in Cloud Storage. This feature is in - Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - ComplianceVersion: - properties: - benchmarkDocument: + description: A detailed description of this Vex. + product: + $ref: '#/components/schemas/Product' + description: The product affected by this vex. + title: type: string + description: The title of the note. E.g. `Vex-Debian-11.4` + publisher: + description: Publisher details of this Note. + $ref: '#/components/schemas/Publisher' + languageCode: description: >- - The name of the document that defines this benchmark, e.g. "CIS - Container-Optimized OS". - version: + Identifies the language used by this document, corresponding to IETF + BCP 47 / RFC 5646. type: string - description: >- - The version of the benchmark. This is set to the version of the - OS-specific CIS document the benchmark is defined in. - cpeUri: - description: >- - The CPE URI (https://cpe.mitre.org/specification/) this benchmark is - applicable to. + shortDescription: + description: A one sentence description of this Vex. type: string + assessment: + description: Represents a vulnerability assessment for the product. + $ref: '#/components/schemas/Assessment' description: >- - Describes the CIS benchmark version that is applicable to a given OS and - os version. - id: ComplianceVersion + A single VulnerabilityAssessmentNote represents one particular product's + vulnerability assessment for one CVE. + id: VulnerabilityAssessmentNote + GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: type: object - BuildNote: - id: BuildNote + id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation + description: Identifies the event that kicked off the build. properties: - builderVersion: - type: string - description: >- - Required. Immutable. Version of the builder which produced this - build. - description: >- - Note holding the version of the provider's builder and the signature of - the provenance message in the build details occurrence. - type: object - Distribution: - type: object + environment: + type: object + additionalProperties: + description: Properties of the object. + type: any + configSource: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' + parameters: + type: object + additionalProperties: + type: any + description: Properties of the object. + Hint: + type: object + id: Hint properties: - url: - description: The distribution channel-specific homepage for this package. + humanReadableName: type: string - cpeUri: + description: >- + Required. The human readable name of this attestation authority, for + example "qa". + description: >- + This submessage provides human-readable hints about the purpose of the + authority. Because the name of a note acts as its resource reference, it + is important to disambiguate the canonical name of the Note (which might + be a UUID for security purposes) from "readable" names more suitable for + debug output. Note that these hints should not be used to look up + authorities in security sensitive contexts, such as when looking up + attestations to verify. + CloudStorageLocation: + type: object + description: >- + Empty placeholder to denote that this is a Google Cloud Storage export + request. + id: CloudStorageLocation + properties: {} + Hash: + properties: + value: type: string + format: byte + description: Required. The hash value. + type: + type: string + description: Required. The type of hash that was performed, e.g. "SHA-256". + description: Container message for hash values. + type: object + id: Hash + Empty: + id: Empty + type: object + properties: {} + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + Artifact: + id: Artifact + properties: + names: description: >- - Required. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. - latestVersion: - $ref: '#/components/schemas/Version' + Related artifact names. This may be the path to a binary or jar + file, or in the case of a container build, the name used to push the + container image to Google Container Registry, as presented to + `docker push`. Note that a single Artifact ID can have multiple + names, for example if two tags are applied to one image. + items: + type: string + type: array + id: + type: string description: >- - The latest available version of this package in this distribution - channel. - maintainer: + Artifact ID, if any; for container images, this will be a URL by + digest like `gcr.io/projectID/imagename@sha256:123456`. + checksum: type: string - description: A freeform string denoting the maintainer of this package. - architecture: description: >- - The CPU architecture for which packages in this distribution channel - were built. + Hash or checksum value of a binary, or Docker Registry 2.0 digest of + a container. + description: Artifact describes a build product. + type: object + Remediation: + description: >- + Specifies details on how to handle (and presumably, fix) a + vulnerability. + properties: + remediationType: + enum: + - REMEDIATION_TYPE_UNSPECIFIED + - MITIGATION + - NO_FIX_PLANNED + - NONE_AVAILABLE + - VENDOR_FIX + - WORKAROUND + description: The type of remediation that can be applied. type: string enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 - description: + - No remediation type specified. + - A MITIGATION is available. + - No fix is planned. + - Not available. + - A vendor fix is available. + - A workaround is available. + details: + description: >- + Contains a comprehensive human-readable discussion of the + remediation. type: string - description: The distribution channel-specific description of this package. - description: >- - This represents a particular channel of distribution for a given - package. E.g., Debian's jessie-backports dpkg mirror. - id: Distribution - Material: - id: Material + remediationUri: + description: Contains the URL where to obtain the remediation. + $ref: '#/components/schemas/RelatedUrl' + id: Remediation type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption properties: - digest: - type: object - additionalProperties: - type: string - uri: + name: + description: >- + The `WorkerPool` resource to execute the build on. You must have + `cloudbuild.workerpools.use` on the project hosting the WorkerPool. + Format + projects/{project}/locations/{location}/workerPools/{workerPoolId} type: string - BatchCreateNotesRequest: - type: object - description: Request to create notes in batch. - properties: - notes: - type: object - additionalProperties: - $ref: '#/components/schemas/Note' - description: Required. The notes to create. Max allowed length is 1000. - id: BatchCreateNotesRequest - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: description: >- - An npm package uploaded to Artifact Registry using the NpmPackage - directive. + Details about how a build should be executed on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. type: object + ImageOccurrence: properties: - pushTiming: - readOnly: true + distance: + format: int32 description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - fileHashes: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - description: Hash types and values of the npm package. - uri: + Output only. The number of layers by which this image differs from + the associated image basis. + type: integer + fingerprint: + description: Required. The fingerprint of the derived image. + $ref: '#/components/schemas/Fingerprint' + baseResourceUrl: type: string - description: URI of the uploaded npm package. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + description: >- + Output only. This contains the base image URL for the derived image + occurrence. + layerInfo: + description: >- + This contains layer-specific metadata, if populated it has length + "distance" and is ordered with [distance] being the layer + immediately following the base image and [1] being the final layer. + type: array + items: + $ref: '#/components/schemas/Layer' + type: object + description: >- + Details of the derived image portion of the DockerImage relationship. + This image would be produced from a Dockerfile with FROM . + id: ImageOccurrence + DSSEAttestationNote: + properties: + hint: + $ref: '#/components/schemas/DSSEHint' + description: DSSEHint hints at the purpose of the attestation authority. + id: DSSEAttestationNote + type: object GerritSourceContext: id: GerritSourceContext - type: object - description: A SourceContext referring to a Gerrit project. properties: - hostUri: - description: The URI of a running Gerrit instance. - type: string - revisionId: - type: string - description: A revision (commit) ID. gerritProject: + type: string description: >- The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. - type: string aliasContext: $ref: '#/components/schemas/AliasContext' description: An alias, which may be a branch or tag. - ListNotesResponse: - id: ListNotesResponse + hostUri: + type: string + description: The URI of a running Gerrit instance. + revisionId: + description: A revision (commit) ID. + type: string + description: A SourceContext referring to a Gerrit project. type: object + BuildMetadata: + type: object + id: BuildMetadata properties: - nextPageToken: + invocationId: type: string - description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. - notes: - items: - $ref: '#/components/schemas/Note' - type: array - description: The notes requested. - description: Response for listing notes. - InTotoStatement: - properties: - _type: + finishedOn: + format: google-datetime type: string - description: Always `https://in-toto.io/Statement/v0.1`. - subject: - items: - $ref: '#/components/schemas/Subject' - type: array - slsaProvenanceZeroTwo: - $ref: '#/components/schemas/SlsaProvenanceZeroTwo' - slsaProvenance: - $ref: '#/components/schemas/SlsaProvenance' - provenance: - $ref: '#/components/schemas/InTotoProvenance' - predicateType: + startedOn: + format: google-datetime type: string - description: '`https://slsa.dev/provenance/v0.1` for SlsaProvenance.' + ImageNote: + id: ImageNote + properties: + fingerprint: + description: Required. Immutable. The fingerprint of the base image. + $ref: '#/components/schemas/Fingerprint' + resourceUrl: + type: string + description: >- + Required. Immutable. The resource_url for the resource representing + the basis of associated occurrence images. description: >- - Spec defined at - https://github.com/in-toto/attestation/tree/main/spec#statement The - serialized InTotoStatement will be stored as Envelope.payload. - Envelope.payloadType is always "application/vnd.in-toto+json". - id: InTotoStatement + Basis describes the base image portion (Note) of the DockerImage + relationship. Linked occurrences are derived from this or an equivalent + image via: FROM Or an equivalent reference, e.g., a tag of the + resource_url. type: object - VulnerabilityOccurrencesSummary: - description: >- - A summary of how many vulnerability occurrences there are per resource - and severity type. + ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: type: object - id: VulnerabilityOccurrencesSummary + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret + description: >- + Pairs a secret environment variable with a SecretVersion in Secret + Manager. properties: - counts: + env: + type: string description: >- - A listing by resource of the number of fixable and total - vulnerabilities. - items: - $ref: '#/components/schemas/FixableTotalByDigest' - type: array - CisBenchmark: - description: A compliance check that is a CIS benchmark. + Environment variable name to associate with the secret. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. + versionName: + description: >- + Resource name of the SecretVersion. In format: + projects/*/secrets/*/versions/* + type: string + RelatedUrl: + type: object + id: RelatedUrl + description: Metadata for any related URL information. properties: - severity: + url: + description: Specific URL associated with the resource. type: string - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - profileLevel: - format: int32 - type: integer + label: + type: string + description: Label to describe usage of the URL. + ExportSBOMRequest: + properties: + cloudStorageLocation: + description: >- + Empty placeholder to denote that this is a Google Cloud Storage + export request. + $ref: '#/components/schemas/CloudStorageLocation' + description: >- + The request to generate and export SBOM. Target must be specified for + the request. + id: ExportSBOMRequest type: object - id: CisBenchmark - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: + ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + description: >- + Provenance of the source. Ways to find the original source, or verify + that some source was used for this build. properties: - dynamicSubstitutions: - type: boolean + resolvedStorageSource: description: >- - Option to specify whether or not to apply bash style string - operations to the substitutions. NOTE: this is always enabled for - triggered builds and cannot be overridden in the build configuration - file. - substitutionOption: - type: string + A copy of the build's `source.storage_source`, if exists, with any + generations resolved. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + fileHashes: + additionalProperties: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes description: >- - Option to specify behavior when there is an error in the - substitution checks. NOTE: this is always set to ALLOW_LOOSE for - triggered builds and cannot be overridden in the build configuration - file. - enumDescriptions: - - >- - Fails the build if error in substitutions checks, like missing a - substitution in the template or in the map. - - Do not fail the build if error in substitutions checks. - enum: - - MUST_MATCH - - ALLOW_LOOSE - secretEnv: - items: - type: string + Output only. Hash(es) of the build source, which can be used to + verify that the original source integrity was maintained in the + build. Note that `FileHashes` will only be populated if + `BuildOptions` has requested a `SourceProvenanceHash`. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` + will be for the single path to that file. + readOnly: true + type: object + resolvedGitSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource description: >- - A list of global environment variables, which are encrypted using a - Cloud Key Management Service crypto key. These values must be - specified in the build's `Secret`. These variables will be available - to all build steps in this build. - type: array - requestedVerifyOption: - description: Requested verifiability options. - enumDescriptions: - - Not a verifiable build (the default). - - Build must be verified. - type: string - enum: - - NOT_VERIFIED - - VERIFIED - workerPool: - deprecated: true - description: This field deprecated; please use `pool.name` instead. - type: string - diskSizeGb: + Output only. A copy of the build's `source.git_source`, if exists, + with any revisions resolved. + readOnly: true + resolvedConnectedRepository: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository description: >- - Requested disk size for the VM that runs the build. Note that this - is *NOT* "disk free"; some of the space will be used by the - operating system and build utilities. Also note that this is the - minimum disk size that will be allocated for the build -- the build - may run with a larger disk than requested. At present, the maximum - disk size is 4000GB; builds that request more than the maximum are - rejected with an error. + Output only. A copy of the build's `source.connected_repository`, if + exists, with any revisions resolved. + readOnly: true + resolvedRepoSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource + description: >- + A copy of the build's `source.repo_source`, if exists, with any + revisions resolved. + resolvedStorageSourceManifest: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + description: >- + A copy of the build's `source.storage_source_manifest`, if exists, + with any revisions resolved. This feature is in Preview. + GrafeasV1FileLocation: + type: object + description: Indicates the location at which a package was found. + id: GrafeasV1FileLocation + properties: + filePath: + description: >- + For jars that are contained inside .war files, this filepath can + indicate the path to war file combined with the path to jar file. type: string - format: int64 - machineType: - enum: - - UNSPECIFIED - - N1_HIGHCPU_8 - - N1_HIGHCPU_32 - - E2_HIGHCPU_8 - - E2_HIGHCPU_32 - - E2_MEDIUM - enumDescriptions: - - Standard machine type. - - Highcpu machine with 8 CPUs. - - Highcpu machine with 32 CPUs. - - Highcpu e2 machine with 8 CPUs. - - Highcpu e2 machine with 32 CPUs. - - E2 machine with 1 CPU. + SbomReferenceIntotoPredicate: + id: SbomReferenceIntotoPredicate + description: A predicate which describes the SBOM being referenced. + type: object + properties: + mimeType: type: string - enumDeprecated: - - false - - true - - true - - false - - false - - false - description: Compute Engine machine type on which to run the build. - env: - description: >- - A list of global environment variable definitions that will exist - for all build steps in this build. If a variable is defined in both - globally and in a build step, the variable will use the build step - value. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - type: array - items: + description: The mime type of the SBOM. + digest: + type: object + additionalProperties: type: string - logStreamingOption: - description: Option to define build log streaming behavior to Cloud Storage. + description: A map of algorithm to digest of the contents of the SBOM. + referrerId: + type: string + description: The person or system referring this predicate to the consumer. + location: + type: string + description: The location of the SBOM. + GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata + properties: + buildInvocationId: + type: string + reproducible: + type: boolean + buildFinishedOn: + type: string + format: google-datetime + buildStartedOn: + type: string + format: google-datetime + completeness: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness' + description: Other properties of the build. + type: object + RepoId: + type: object + properties: + projectRepoId: + $ref: '#/components/schemas/ProjectRepoId' + description: A combination of a project ID and a repo name. + uid: + description: A server-assigned, globally unique identifier. + type: string + description: A unique identifier for a Cloud Repo. + id: RepoId + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions: + properties: + volumes: + description: >- + Global list of volumes to mount for ALL build steps Each volume is + created as an empty volume prior to starting the build process. Upon + completion of the build, volumes and their contents are discarded. + Global volume names and paths cannot conflict with the volumes + defined a build step. Using a global volume in a build with only one + step is not valid as it is indicative of a build request with an + incorrect configuration. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + type: array + machineType: + enumDeprecated: + - false + - true + - true + - false + - false + - false + enumDescriptions: + - Standard machine type. + - Highcpu machine with 8 CPUs. + - Highcpu machine with 32 CPUs. + - Highcpu e2 machine with 8 CPUs. + - Highcpu e2 machine with 32 CPUs. + - E2 machine with 1 CPU. + description: Compute Engine machine type on which to run the build. + enum: + - UNSPECIFIED + - N1_HIGHCPU_8 + - N1_HIGHCPU_32 + - E2_HIGHCPU_8 + - E2_HIGHCPU_32 + - E2_MEDIUM + type: string + env: + type: array + description: >- + A list of global environment variable definitions that will exist + for all build steps in this build. If a variable is defined in both + globally and in a build step, the variable will use the build step + value. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + items: + type: string + diskSizeGb: + format: int64 + description: >- + Requested disk size for the VM that runs the build. Note that this + is *NOT* "disk free"; some of the space will be used by the + operating system and build utilities. Also note that this is the + minimum disk size that will be allocated for the build -- the build + may run with a larger disk than requested. At present, the maximum + disk size is 4000GB; builds that request more than the maximum are + rejected with an error. + type: string + dynamicSubstitutions: + description: >- + Option to specify whether or not to apply bash style string + operations to the substitutions. NOTE: this is always enabled for + triggered builds and cannot be overridden in the build configuration + file. + type: boolean + workerPool: + deprecated: true + description: This field deprecated; please use `pool.name` instead. type: string - enumDescriptions: - - Service may automatically determine build log streaming behavior. - - Build logs should be streamed to Cloud Storage. - - >- - Build logs should not be streamed to Cloud Storage; they will be - written when the build is completed. - enum: - - STREAM_DEFAULT - - STREAM_ON - - STREAM_OFF defaultLogsBucketBehavior: + type: string + description: Optional. Option to specify how default logs buckets are setup. + enum: + - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED + - REGIONAL_USER_OWNED_BUCKET enumDescriptions: - Unspecified. - >- Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project. + substitutionOption: + enumDescriptions: + - >- + Fails the build if error in substitutions checks, like missing a + substitution in the template or in the map. + - Do not fail the build if error in substitutions checks. type: string enum: - - DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED - - REGIONAL_USER_OWNED_BUCKET - description: Optional. Option to specify how default logs buckets are setup. + - MUST_MATCH + - ALLOW_LOOSE + description: >- + Option to specify behavior when there is an error in the + substitution checks. NOTE: this is always set to ALLOW_LOOSE for + triggered builds and cannot be overridden in the build configuration + file. + automapSubstitutions: + type: boolean + description: >- + Option to include built-in and custom substitutions as env variables + for all build steps. + pool: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption + description: >- + Optional. Specification for execution on a `WorkerPool`. See + [running builds in a private + pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) + for more information. logging: - type: string enum: - LOGGING_UNSPECIFIED - LEGACY @@ -1140,6 +1351,7 @@ components: - STACKDRIVER_ONLY - CLOUD_LOGGING_ONLY - NONE + type: string enumDescriptions: - >- The service determines the logging mode. The default is `LEGACY`. @@ -1163,684 +1375,753 @@ components: - true - false - false - automapSubstitutions: - description: >- - Option to include built-in and custom substitutions as env variables - for all build steps. - type: boolean - volumes: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - description: >- - Global list of volumes to mount for ALL build steps Each volume is - created as an empty volume prior to starting the build process. Upon - completion of the build, volumes and their contents are discarded. - Global volume names and paths cannot conflict with the volumes - defined a build step. Using a global volume in a build with only one - step is not valid as it is indicative of a build request with an - incorrect configuration. - type: array + requestedVerifyOption: + description: Requested verifiability options. + enumDescriptions: + - Not a verifiable build (the default). + - Build must be verified. + enum: + - NOT_VERIFIED + - VERIFIED + type: string sourceProvenanceHash: - type: array items: - enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. enum: - NONE - SHA256 - MD5 - SHA512 + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. type: string description: Requested hash for SourceProvenance. - pool: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption - description: >- - Optional. Specification for execution on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. - description: Optional arguments to enable specific features of builds. - UpgradeDistribution: - description: >- - The Upgrade Distribution represents metadata about the Upgrade for each - operating system (CPE). Some distributions have additional metadata - around updates, classifying them into various categories and severities. - id: UpgradeDistribution - properties: - cpeUri: - type: string - description: >- - Required - The specific operating system this metadata applies to. - See https://cpe.mitre.org/specification/. - severity: - description: The severity as specified by the upstream operating system. - type: string - classification: + type: array + logStreamingOption: + enumDescriptions: + - Service may automatically determine build log streaming behavior. + - Build logs should be streamed to Cloud Storage. + - >- + Build logs should not be streamed to Cloud Storage; they will be + written when the build is completed. type: string - description: >- - The operating system classification of this Upgrade, as specified by - the upstream operating system upgrade feed. For Windows the - classification is one of the category_ids listed at - https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) - cve: + description: Option to define build log streaming behavior to Cloud Storage. + enum: + - STREAM_DEFAULT + - STREAM_ON + - STREAM_OFF + secretEnv: type: array + description: >- + A list of global environment variables, which are encrypted using a + Cloud Key Management Service crypto key. These values must be + specified in the build's `Secret`. These variables will be available + to all build steps in this build. items: type: string - description: The cve tied to this Upgrade. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions type: object - Fingerprint: - description: A set of properties that uniquely identify a given Docker image. + description: Optional arguments to enable specific features of builds. + Justification: + description: >- + Justification provides the justification when the state of the + assessment if NOT_AFFECTED. properties: - v2Blob: - items: - type: string - type: array - description: Required. The ordered list of v2 blobs that represent a given image. - v1Name: - type: string - description: >- - Required. The layer ID of the final layer in the Docker image's v1 - representation. - v2Name: + justificationType: type: string - description: >- - Output only. The name of the image's v2 blobs computed via: [bottom] - := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the - name of the final blob is kept. - id: Fingerprint - type: object - Status: - id: Status + description: The justification type for this vulnerability. + enumDescriptions: + - JUSTIFICATION_TYPE_UNSPECIFIED. + - The vulnerable component is not present in the product. + - >- + The vulnerable code is not present. Typically this case occurs + when source code is configured or built in a way that excludes the + vulnerable code. + - >- + The vulnerable code can not be executed. Typically this case + occurs when the product includes the vulnerable code but does not + call or use the vulnerable code. + - >- + The vulnerable code cannot be controlled by an attacker to exploit + the vulnerability. + - >- + The product includes built-in protections or features that prevent + exploitation of the vulnerability. These built-in protections + cannot be subverted by the attacker and cannot be configured or + disabled by the user. These mitigations completely prevent + exploitation based on known attack vectors. + enum: + - JUSTIFICATION_TYPE_UNSPECIFIED + - COMPONENT_NOT_PRESENT + - VULNERABLE_CODE_NOT_PRESENT + - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH + - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY + - INLINE_MITIGATIONS_ALREADY_EXIST + details: + description: Additional details on why this justification was chosen. + type: string + id: Justification type: object + NonCompliantFile: properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + reason: type: string - details: - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: - properties: - startTime: - description: Start of time span. + description: Explains why a file is non compliant for a CIS check. + path: + description: Empty if `display_command` is set. type: string - format: google-datetime - endTime: - format: google-datetime - description: End of time span. + displayCommand: type: string + description: Command to display the non-compliant files. + description: >- + Details about files that caused a compliance check to fail. + display_command is a single command that can be used to display a list + of non compliant files. When there is no such command, we can also + iterate a list of non compliant file using 'path'. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: Start and end times for a build execution phase. - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: - description: HttpConfig is a configuration for HTTP related git operations. + id: NonCompliantFile + SourceContext: properties: - proxySslCaInfo: + gerrit: + $ref: '#/components/schemas/GerritSourceContext' + description: A SourceContext referring to a Gerrit project. + cloudRepo: description: >- - Optional. Cloud Storage object storing the certificate to use with - the HTTP proxy. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation - proxySecretVersionName: - type: string + A SourceContext referring to a revision in a Google Cloud Source + Repo. + $ref: '#/components/schemas/CloudRepoSourceContext' + labels: + description: Labels with user defined metadata. + additionalProperties: + type: string + type: object + git: description: >- - SecretVersion resource of the HTTP proxy URL. The proxy URL should - be in format protocol://@]proxyhost[:port]. + A SourceContext referring to any third party Git repo (e.g., + GitHub). + $ref: '#/components/schemas/GitSourceContext' + id: SourceContext + description: >- + A SourceContext is a reference to a tree of files. A SourceContext + together with a path point to a unique revision of a single file or + directory. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - GetPolicyOptions: - properties: - requestedPolicyVersion: - description: >- - Optional. The maximum policy version that will be used to format the - policy. Valid values are 0, 1, and 3. Requests specifying an invalid - value will be rejected. Requests for policies with any conditional - role bindings must specify version 3. Policies with no conditional - role bindings may specify any valid value or leave the field unset. - The policy in the response might use the policy version that you - specified, or it might use a lower policy version. For example, if - you specify version 3, but the policy has no conditional role - bindings, the response uses version 1. To learn which resources - support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - format: int32 - type: integer - description: Encapsulates settings provided to GetIamPolicy. + AttestationNote: + description: >- + Note kind that represents a logical attestation "role" or "authority". + For example, an organization might have one `Authority` for "QA" and one + for "build". This note is intended to act strictly as a grouping + mechanism for the attached occurrences (Attestations). This grouping + mechanism also provides a security boundary, since IAM ACLs gate the + ability for a principle to attach an occurrence to a given note. It also + provides a single point of lookup to find all attached attestation + occurrences, even if they don't all live in the same project. type: object - id: GetPolicyOptions - TimeSpan: + id: AttestationNote + properties: + hint: + description: Hint hints at the purpose of the attestation authority. + $ref: '#/components/schemas/Hint' + ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource type: object - id: TimeSpan - description: 'Start and end times for a build execution phase. Next ID: 3' + description: Location of the source in any accessible Git repository. properties: - endTime: - format: google-datetime + dir: + description: >- + Optional. Directory, relative to the source root, in which to run + the build. This must be a relative path. If a step's `dir` is + specified and is an absolute path, this value is ignored for that + step's execution. type: string - description: End of time span. - startTime: - description: Start of time span. + revision: + description: >- + Optional. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git + fetch` to fetch the revision from the Git repository; therefore make + sure that the string you provide for `revision` is parsable by the + command. For information on string values accepted by `git fetch`, + see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For + information on `git fetch`, see https://git-scm.com/docs/git-fetch. type: string - format: google-datetime - TestIamPermissionsRequest: - properties: - permissions: - type: array - items: - type: string + url: description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - type: object - description: Request message for `TestIamPermissions` method. - id: TestIamPermissionsRequest - ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: + Required. Location of the Git repo to build. This will be used as a + `git remote`, see https://git-scm.com/docs/git-remote. + type: string + PackageNote: type: object - description: GitConfig is a configuration for git operations. - properties: - http: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig - description: Configuration for HTTP related git operations. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - Version: properties: - epoch: - format: int32 - type: integer - description: Used to correct mistakes in the version numbering scheme. - inclusive: - description: >- - Whether this version is specifying part of an inclusive range. - Grafeas does not have the capability to specify version ranges; - instead we have fields that specify start version and end versions. - At times this is insufficient - we also need to specify whether the - version is included in the range or is excluded from the range. This - boolean is expected to be set to true when the version is included - in a range. - type: boolean - revision: + url: + description: The homepage for this package. type: string - description: The iteration of the package build from the above version. - kind: + license: + description: Licenses that have been declared by the authors of the package. + $ref: '#/components/schemas/License' + version: + $ref: '#/components/schemas/Version' + description: The version of the package. + digest: + type: array + items: + $ref: '#/components/schemas/Digest' + description: >- + Hash value, typically a file digest, that allows unique + identification a specific package. + architecture: enumDescriptions: - - Unknown. - - A standard package version. - - A special version representing negative infinity. - - A special version representing positive infinity. + - Unknown architecture. + - X86 architecture. + - X64 architecture. + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 description: >- - Required. Distinguishes between sentinel MIN/MAX versions and normal - versions. + The CPU architecture for which packages in this distribution channel + were built. Architecture will be blank for language packages. type: string - enum: - - VERSION_KIND_UNSPECIFIED - - NORMAL - - MINIMUM - - MAXIMUM name: + description: Required. Immutable. The name of the package. type: string - description: >- - Required only when version kind is NORMAL. The main part of the - version name. - fullName: + distribution: + description: Deprecated. The various channels by which a package is distributed. + type: array + items: + $ref: '#/components/schemas/Distribution' + maintainer: + type: string + description: A freeform text denoting the maintainer of this package. + packageType: type: string description: >- - Human readable version string. This string is of the form :- and is - only set when kind is NORMAL. + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + description: + description: The description of this package. + type: string + cpeUri: + type: string + description: >- + The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) + denoting the package manager version distributing a package. The + cpe_uri will be blank for language packages. + description: PackageNote represents a particular package version. + id: PackageNote + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest: type: object - description: Version contains structured information about the version of a package. - id: Version - PackageIssue: properties: - fixAvailable: - description: Output only. Whether a fix is available for this package. - type: boolean - affectedVersion: + object: description: >- - Required. The version of the package that is installed on the - resource affected by this vulnerability. - $ref: '#/components/schemas/Version' - effectiveSeverity: - readOnly: true + Required. Cloud Storage object containing the source manifest. This + object must be a JSON file. type: string - enumDescriptions: - - Unknown. - - Minimal severity. - - Low severity. - - Medium severity. - - High severity. - - Critical severity. + generation: description: >- - Output only. The distro or language system assigned severity for - this vulnerability when that is available and note provider assigned - severity when it is not available. - enum: - - SEVERITY_UNSPECIFIED - - MINIMAL - - LOW - - MEDIUM - - HIGH - - CRITICAL - packageType: - type: string - description: The type of package (e.g. OS, MAVEN, GO). - affectedPackage: - description: Required. The package this vulnerability was found in. + Cloud Storage generation for the object. If the generation is + omitted, the latest generation will be used. + format: int64 type: string - fixedPackage: + bucket: type: string description: >- - The package this vulnerability was fixed in. It is possible for this - to be different from the affected_package. - affectedCpeUri: + Required. Cloud Storage bucket containing the source manifest (see + [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + description: >- + Location of the source manifest in Cloud Storage. This feature is in + Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest + AliasContext: + description: An alias to a repo revision. + properties: + name: type: string - description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was found in. - fixedCpeUri: + description: The alias name. + kind: + type: string + enum: + - KIND_UNSPECIFIED + - FIXED + - MOVABLE + - OTHER + enumDescriptions: + - Unknown. + - Git tag. + - Git branch. + - >- + Used to specify non-standard aliases. For example, if a Git repo + has a ref named "refs/foo/bar". + description: The alias kind. + type: object + id: AliasContext + SBOMReferenceOccurrence: + description: >- + The occurrence representing an SBOM reference as applied to a specific + resource. The occurrence follows the DSSE specification. See + https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for + more details. + properties: + payloadType: type: string description: >- - The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability was fixed in. It is possible for this to be different - from the affected_cpe_uri. - fileLocation: - type: array - description: The location at which this package was found. + The kind of payload that SbomReferenceIntotoPayload takes. Since + it's in the intoto format, this value is expected to be + 'application/vnd.in-toto+json'. + payload: + $ref: '#/components/schemas/SbomReferenceIntotoPayload' + description: The actual payload that contains the SBOM reference data. + signatures: items: - $ref: '#/components/schemas/GrafeasV1FileLocation' - fixedVersion: - $ref: '#/components/schemas/Version' - description: >- - Required. The version of the package this vulnerability was fixed - in. Setting this to VersionKind.MAXIMUM means no fix is yet - available. - description: >- - A detail for a distro and package this vulnerability occurrence was - found in and its associated fix (if one is available). - id: PackageIssue + $ref: '#/components/schemas/EnvelopeSignature' + description: The signatures over the payload. + type: array type: object - SlsaBuilder: - id: SlsaBuilder + id: SBOMReferenceOccurrence + GitSourceContext: properties: - id: + revisionId: + description: Git commit hash. + type: string + url: + description: Git repository URL. type: string + id: GitSourceContext type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1Build: + description: >- + A GitSourceContext denotes a particular revision in a third party Git + repository (e.g., GitHub). + BatchCreateOccurrencesResponse: type: object + id: BatchCreateOccurrencesResponse properties: - serviceAccount: - type: string - description: >- - IAM service account whose credentials will be used at build runtime. - Must be of the format - `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be - email address or uniqueId of the service account. - approval: - description: >- - Output only. Describes this build's approval configuration, status, - and result. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - readOnly: true - projectId: - readOnly: true - description: Output only. ID of the project. - type: string - steps: + occurrences: type: array + description: The occurrences that were created. items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - description: Required. The operations to be performed on the workspace. - timing: + $ref: '#/components/schemas/Occurrence' + description: Response for creating occurrences in batch. + Detail: + properties: + source: + type: string + description: The source from which the information in this Detail was obtained. + fixedCpeUri: description: >- - Output only. Stores timing information for phases of the build. - Valid keys are: * BUILD: time to execute all build steps. * PUSH: - time to push all artifacts including docker images and non docker - artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time - to set up build. If the build does not specify source or images, - these keys will not be included. - additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - type: object - statusDetail: + The distro recommended [CPE + URI](https://cpe.mitre.org/specification/) to update to that + contains a fix for this vulnerability. It is possible for this to be + different from the affected_cpe_uri. type: string - description: Output only. Customer-readable message about the current status. - readOnly: true - createTime: + sourceUpdateTime: + type: string + description: >- + The time this information was last changed at the source. This is an + upstream timestamp from the underlying information source - e.g. + Ubuntu security tracker. format: google-datetime + affectedVersionEnd: + $ref: '#/components/schemas/Version' description: >- - Output only. Time at which the request to create the build was - received. - readOnly: true + The version number at the end of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + fixedVersion: + $ref: '#/components/schemas/Version' + description: >- + The distro recommended version to update to that contains a fix for + this vulnerability. Setting this to VersionKind.MAXIMUM means no + such version is yet available. + packageType: type: string - status: - description: Output only. Status of the build. - readOnly: true - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED + description: >- + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). + affectedPackage: + description: Required. The package this vulnerability affects. + type: string + fixedPackage: type: string - enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. - secrets: - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret description: >- - Secrets to decrypt using Cloud Key Management Service. Note: Secret - Manager is the recommended technique for managing sensitive data - with Cloud Build. Use `available_secrets` to configure builds to - access secrets from Secret Manager. For instructions, see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets - id: - description: Output only. Unique identifier of the build. - readOnly: true + The distro recommended package to update to that contains a fix for + this vulnerability. It is possible for this to be different from the + affected_package. + isObsolete: + type: boolean + description: >- + Whether this detail is obsolete. Occurrences are expected not to + point to obsolete details. + description: type: string - images: - items: - type: string - type: array + description: A vendor-specific description of this vulnerability. + affectedVersionStart: + $ref: '#/components/schemas/Version' description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images are pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the `Build` resource's results field. If any of the images - fail to be pushed, the build status is marked `FAILURE`. - sourceProvenance: - description: Output only. A permanent fixed identifier for source. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - readOnly: true - finishTime: + The version number at the start of an interval in which this + vulnerability exists. A vulnerability can affect a package between + version numbers that are disjoint sets of intervals (example: + [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will + be represented in its own Detail. If a specific affected version is + provided by a vulnerability database, affected_version_start and + affected_version_end will be the same in that Detail. + severityName: type: string + description: The distro assigned severity of this vulnerability. + affectedCpeUri: description: >- - Output only. Time at which execution of the build was finished. The - difference between finish_time and start_time is the duration of the - build's execution. - readOnly: true - format: google-datetime - failureInfo: + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + type: string + vendor: + type: string + description: The name of the vendor of the product. + description: >- + A detail for a distro and package affected by this vulnerability and its + associated fix (if one is available). + id: Detail + type: object + Publisher: + description: Publisher contains information about the publisher of this Note. + id: Publisher + type: object + properties: + publisherNamespace: description: >- - Output only. Contains information about the build when - status=FAILURE. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo - timeout: + The context or namespace. Contains a URL which is under control of + the issuing party and can be used as a globally unique identifier + for that issuing party. Example: https://csaf.io + type: string + name: + description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' + type: string + issuingAuthority: + type: string description: >- - Amount of time that this build should be allowed to run, to second - granularity. If this amount of time elapses, work on the build will - cease and the build status will be `TIMEOUT`. `timeout` starts - ticking from `startTime`. Default time is 60 minutes. + Provides information about the authority of the issuing party to + release the document, in particular, the party's constituency and + responsibilities or other obligations. + ContaineranalysisGoogleDevtoolsCloudbuildV1Build: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build + properties: + serviceAccount: type: string - format: google-duration - startTime: + description: >- + IAM service account whose credentials will be used at build runtime. + Must be of the format + `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be + email address or uniqueId of the service account. + statusDetail: + description: Output only. Customer-readable message about the current status. type: string - description: Output only. Time at which execution of the build was started. + readOnly: true + finishTime: format: google-datetime + type: string readOnly: true - source: - description: Optional. The location of the source files to build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source - gitConfig: - description: Optional. Configuration for git operations. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig - queueTtl: description: >- - TTL in queue for this build. If provided and the build is enqueued - longer than this value, the build will expire and the build status - will be `EXPIRED`. The TTL starts ticking from create_time. - format: google-duration + Output only. Time at which execution of the build was finished. The + difference between finish_time and start_time is the duration of the + build's execution. + logsBucket: type: string - tags: - type: array - items: - type: string - description: Tags for annotation of a `Build`. These are not docker tags. - warnings: description: >- - Output only. Non-fatal problems encountered during the execution of - the build. - readOnly: true + Cloud Storage bucket where logs should be written (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Logs file names will be of the format + `${logs_bucket}/log-${build_id}.txt`. + steps: + description: Required. The operations to be performed on the workspace. type: array items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning - options: - description: Special options for this build. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions - substitutions: - type: object - additionalProperties: - type: string - description: Substitutions data for `Build` resource. - name: - readOnly: true - description: >- - Output only. The 'Build' name with format: - `projects/{project}/locations/{location}/builds/{build}`, where - {build} is a unique identifier generated by the service. - type: string + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep availableSecrets: - description: Secrets and secret environment variables. $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - logUrl: - description: Output only. URL to logs for this build in Google Cloud Console. + description: Secrets and secret environment variables. + source: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Source + description: Optional. The location of the source files to build. + sourceProvenance: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance + description: Output only. A permanent fixed identifier for source. readOnly: true - type: string artifacts: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts description: >- Artifacts produced by the build that should be uploaded upon successful completion of all build steps. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - buildTriggerId: + warnings: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning readOnly: true - type: string description: >- - Output only. The ID of the `BuildTrigger` that triggered this build, - if it was triggered automatically. - results: + Output only. Non-fatal problems encountered during the execution of + the build. + type: array + timing: + additionalProperties: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: >- + Output only. Stores timing information for phases of the build. + Valid keys are: * BUILD: time to execute all build steps. * PUSH: + time to push all artifacts including docker images and non docker + artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time + to set up build. If the build does not specify source or images, + these keys will not be included. + type: object readOnly: true + images: + description: >- + A list of images to be pushed upon the successful completion of all + build steps. The images are pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the `Build` resource's results field. If any of the images + fail to be pushed, the build status is marked `FAILURE`. + items: + type: string + type: array + substitutions: + description: Substitutions data for `Build` resource. + additionalProperties: + type: string + type: object + results: description: Output only. Results of the build. $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Results - logsBucket: - description: >- - Cloud Storage bucket where logs should be written (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Logs file names will be of the format - `${logs_bucket}/log-${build_id}.txt`. + readOnly: true + startTime: type: string - description: >- - A build resource in the Cloud Build API. At a high level, a `Build` - describes where to find source code, how to build it (for example, the - builder image to run on the source), and where to store the built - artifacts. Fields can include the following variables, which will be - expanded when the build is created: - $PROJECT_ID: the project ID of the - build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: - the location/region of the build. - $BUILD_ID: the autogenerated ID of - the build. - $REPO_NAME: the source repository name specified by - RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or - $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the - specified branch or tag. - $SHORT_SHA: first 7 characters of - $REVISION_ID or $COMMIT_SHA. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Build - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - properties: - decision: - enum: - - DECISION_UNSPECIFIED - - APPROVED - - REJECTED - type: string - description: Required. The decision of this manual approval. + format: google-datetime + description: Output only. Time at which execution of the build was started. + readOnly: true + options: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions + description: Special options for this build. + status: enumDescriptions: - - Default enum type. This should not be used. - - Build is approved. - - Build is rejected. - url: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + type: string + description: Output only. Status of the build. + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + readOnly: true + gitConfig: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + description: Optional. Configuration for git operations. + approval: description: >- - Optional. An optional URL tied to this manual approval result. This - field is essentially the same as comment, except that it will be - rendered by the UI differently. An example use case is a link to an - external job that approved this Build. + Output only. Describes this build's approval configuration, status, + and result. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + readOnly: true + buildTriggerId: + readOnly: true type: string - approvalTime: + description: >- + Output only. The ID of the `BuildTrigger` that triggered this build, + if it was triggered automatically. + failureInfo: + readOnly: true + description: >- + Output only. Contains information about the build when + status=FAILURE. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + createTime: type: string + description: >- + Output only. Time at which the request to create the build was + received. + readOnly: true format: google-datetime + tags: + items: + type: string + description: Tags for annotation of a `Build`. These are not docker tags. + type: array + name: readOnly: true - description: Output only. The time when the approval decision was made. - comment: type: string - description: Optional. An optional comment for this manual approval result. - approverAccount: - readOnly: true description: >- - Output only. Email of the user that called the ApproveBuild API to - approve or reject a build at the time that the API was called. + Output only. The 'Build' name with format: + `projects/{project}/locations/{location}/builds/{build}`, where + {build} is a unique identifier generated by the service. + logUrl: + readOnly: true + description: Output only. URL to logs for this build in Google Cloud Console. type: string - description: >- - ApprovalResult describes the decision and associated metadata of a - manual approval of a build. - ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: - type: object - properties: - dir: + projectId: type: string - description: >- - Required. Directory, relative to the source root, in which to run - the build. - revision: + description: Output only. ID of the project. + readOnly: true + queueTtl: type: string description: >- - Required. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. - gitRepositoryLink: + TTL in queue for this build. If provided and the build is enqueued + longer than this value, the build will expire and the build status + will be `EXPIRED`. The TTL starts ticking from create_time. + format: google-duration + id: + type: string + readOnly: true + description: Output only. Unique identifier of the build. + timeout: + format: google-duration description: >- - Required. The Developer Connect Git repository link, formatted as - `projects/*/locations/*/connections/*/gitRepositoryLink/*`. + Amount of time that this build should be allowed to run, to second + granularity. If this amount of time elapses, work on the build will + cease and the build status will be `TIMEOUT`. `timeout` starts + ticking from `startTime`. Default time is 60 minutes. type: string - description: This config defines the location of a source through Developer Connect. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + secrets: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Secret + type: array + description: >- + Secrets to decrypt using Cloud Key Management Service. Note: Secret + Manager is the recommended technique for managing sensitive data + with Cloud Build. Use `available_secrets` to configure builds to + access secrets from Secret Manager. For instructions, see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets + description: >- + A build resource in the Cloud Build API. At a high level, a `Build` + describes where to find source code, how to build it (for example, the + builder image to run on the source), and where to store the built + artifacts. Fields can include the following variables, which will be + expanded when the build is created: - $PROJECT_ID: the project ID of the + build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: + the location/region of the build. - $BUILD_ID: the autogenerated ID of + the build. - $REPO_NAME: the source repository name specified by + RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - + $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or + $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the + specified branch or tag. - $SHORT_SHA: first 7 characters of + $REVISION_ID or $COMMIT_SHA. + TestIamPermissionsResponse: + id: TestIamPermissionsResponse type: object - description: Artifact uploaded using the PythonPackage directive. + description: Response message for `TestIamPermissions` method. properties: - pushTiming: + permissions: + items: + type: string + type: array description: >- - Output only. Stores timing information for pushing the specified - artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - readOnly: true - uri: - description: URI of the uploaded artifact. - type: string - fileHashes: - description: Hash types and values of the Python Artifact. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - RelatedUrl: - id: RelatedUrl + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. + WindowsUpdate: + id: WindowsUpdate + description: >- + Windows Update represents the metadata about the update for the Windows + operating system. The fields in this message come from the Windows + Update API documented at + https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. type: object - description: Metadata for any related URL information. properties: - url: - description: Specific URL associated with the resource. + title: type: string - label: + description: The localized title of the update. + categories: + description: The list of categories to which the update belongs. + items: + $ref: '#/components/schemas/Category' + type: array + identity: + description: Required - The unique identifier for the update. + $ref: '#/components/schemas/Identity' + description: + description: The localized description of the update. type: string - description: Label to describe usage of the URL. - Digest: - type: object - description: Digest information. - properties: - algo: - description: '`SHA1`, `SHA512` etc.' + kbArticleIds: + type: array + description: >- + The Microsoft Knowledge Base article IDs that are associated with + the update. + items: + type: string + lastPublishedTimestamp: + description: The last published timestamp of the update. + format: google-datetime type: string - digestBytes: - description: Value of the digest. - format: byte + supportUrl: + description: The hyperlink to the support information for the update. type: string - id: Digest - DiscoveryNote: - type: object - id: DiscoveryNote - description: >- - A note that indicates a type of analysis a provider would perform. This - note exists in a provider's project. A `Discovery` occurrence is created - in a consumer's project at the start of analysis. + Occurrence: + description: An instance of an analysis type that has been found on a resource. + id: Occurrence properties: - analysisKind: + resourceUri: description: >- - Required. Immutable. The kind of analysis that is handled by this - discovery. - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE + Required. Immutable. A URI that represents the resource for which + the occurrence applies. For example, + `https://gcr.io/project/image@sha256:123abc` for a Docker image. + type: string + discovery: + description: Describes when a resource was discovered. + $ref: '#/components/schemas/DiscoveryOccurrence' + image: + $ref: '#/components/schemas/ImageOccurrence' + description: >- + Describes how this resource derives from the basis in the associated + note. + vulnerability: + description: Describes a security vulnerability. + $ref: '#/components/schemas/VulnerabilityOccurrence' + package: + $ref: '#/components/schemas/PackageOccurrence' + description: Describes the installation of a package on the linked resource. + attestation: + $ref: '#/components/schemas/AttestationOccurrence' + description: Describes an attestation of an artifact. + build: + description: Describes a verifiable build. + $ref: '#/components/schemas/BuildOccurrence' + kind: + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE - DEPLOYMENT - DISCOVERY - ATTESTATION @@ -1849,7 +2130,6 @@ components: - DSSE_ATTESTATION - VULNERABILITY_ASSESSMENT - SBOM_REFERENCE - type: string enumDescriptions: - Default value. This value is unused. - The note and occurrence represent a package vulnerability. @@ -1866,2438 +2146,2675 @@ components: - This represents a DSSE attestation Note - This represents a Vulnerability Assessment. - This represents an SBOM Reference. - ListNoteOccurrencesResponse: - type: object - properties: - occurrences: - items: - $ref: '#/components/schemas/Occurrence' - type: array - description: The occurrences attached to the specified note. - nextPageToken: - description: Token to provide to skip to a particular spot in the list. - type: string - description: Response for listing occurrences for a note. - id: ListNoteOccurrencesResponse - Metadata: - id: Metadata - description: Other properties of the build. - properties: - buildFinishedOn: - format: google-datetime type: string - description: The timestamp of when the build completed. - completeness: - description: >- - Indicates that the builder claims certain fields in this message to - be complete. - $ref: '#/components/schemas/Completeness' - reproducible: - type: boolean description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - buildStartedOn: + Output only. This explicitly denotes which of the occurrence details + are specified. This field can be used as a filter in list requests. + updateTime: + format: google-datetime + description: Output only. The time this occurrence was last updated. type: string - description: The timestamp of when the build started. + createTime: format: google-datetime - buildInvocationId: + type: string + description: Output only. The time this occurrence was created. + compliance: + description: Describes a compliance violation on a linked resource. + $ref: '#/components/schemas/ComplianceOccurrence' + remediation: + type: string + description: A description of actions that can be taken to remedy the note. + sbomReference: + $ref: '#/components/schemas/SBOMReferenceOccurrence' + description: Describes a specific SBOM reference occurrences. + name: type: string description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. + Output only. The name of the occurrence in the form of + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + envelope: + description: https://github.com/secure-systems-lab/dsse + $ref: '#/components/schemas/Envelope' + upgrade: + description: Describes an available package upgrade on the linked resource. + $ref: '#/components/schemas/UpgradeOccurrence' + dsseAttestation: + description: Describes an attestation of an artifact using dsse. + $ref: '#/components/schemas/DSSEAttestationOccurrence' + deployment: + $ref: '#/components/schemas/DeploymentOccurrence' + description: Describes the deployment of an artifact on a runtime. + noteName: + description: >- + Required. Immutable. The analysis note associated with this + occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + This field can be used as a filter in list requests. + type: string type: object - KnowledgeBase: + Layer: type: object - id: KnowledgeBase + description: Layer holds metadata specific to a layer of a Docker image. properties: - url: + directive: type: string description: >- - A link to the KB in the [Windows update catalog] - (https://www.catalog.update.microsoft.com/). - name: + Required. The recovered Dockerfile directive used to construct this + layer. See https://docs.docker.com/engine/reference/builder/ for + more information. + arguments: type: string - description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: + description: The recovered arguments to the Dockerfile directive. + id: Layer + Note: + description: A type of analysis that can be done for a resource. + type: object properties: + longDescription: + type: string + description: A detailed description of this note. + vulnerability: + $ref: '#/components/schemas/VulnerabilityNote' + description: A note describing a package vulnerability. + vulnerabilityAssessment: + description: A note describing a vulnerability assessment. + $ref: '#/components/schemas/VulnerabilityAssessmentNote' + discovery: + description: A note describing the initial analysis of a resource. + $ref: '#/components/schemas/DiscoveryNote' + kind: + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE + description: >- + Output only. The type of analysis. This field can be used as a + filter in list requests. + type: string + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + dsseAttestation: + description: A note describing a dsse attestation note. + $ref: '#/components/schemas/DSSEAttestationNote' + shortDescription: + description: A one sentence description of this note. + type: string + build: + description: A note describing build provenance for a verifiable build. + $ref: '#/components/schemas/BuildNote' + updateTime: + type: string + format: google-datetime + description: >- + Output only. The time this note was last updated. This field can be + used as a filter in list requests. name: type: string description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. - timing: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + Output only. The name of the note in the form of + `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + createTime: + format: google-datetime description: >- - Output only. Stores timing information for executing this build - step. - args: + Output only. The time this note was created. This field can be used + as a filter in list requests. + type: string + relatedNoteNames: + description: Other notes related to this note. items: type: string type: array - description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. - waitFor: - description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. + compliance: + description: A note describing a compliance check. + $ref: '#/components/schemas/ComplianceNote' + sbomReference: + $ref: '#/components/schemas/SBOMReferenceNote' + description: A note describing an SBOM reference. + package: + description: A note describing a package hosted by various package managers. + $ref: '#/components/schemas/PackageNote' + upgrade: + $ref: '#/components/schemas/UpgradeNote' + description: A note describing available package upgrades. + image: + $ref: '#/components/schemas/ImageNote' + description: A note describing a base image. + attestation: + $ref: '#/components/schemas/AttestationNote' + description: A note describing an attestation role. + deployment: + $ref: '#/components/schemas/DeploymentNote' + description: A note describing something that can be deployed. + relatedUrl: + description: URLs associated with this note. items: - type: string + $ref: '#/components/schemas/RelatedUrl' type: array - exitCode: - readOnly: true - description: Output only. Return code from running the step. - type: integer - format: int32 - timeout: - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. + expirationTime: + format: google-datetime type: string - format: google-duration - allowFailure: - type: boolean - description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - id: - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. + description: Time of expiration for this note. Empty if note does not expire. + id: Note + GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: + properties: + uri: type: string - entrypoint: + entryPoint: + type: string + digest: + type: object + additionalProperties: + type: string + id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource + description: >- + Describes where the config file that kicked off the build came from. + This is effectively a pointer to the source where buildConfig came from. + type: object + ComplianceVersion: + description: >- + Describes the CIS benchmark version that is applicable to a given OS and + os version. + properties: + cpeUri: type: string description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. - volumes: - type: array + The CPE URI (https://cpe.mitre.org/specification/) this benchmark is + applicable to. + benchmarkDocument: description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - script: + The name of the document that defines this benchmark, e.g. "CIS + Container-Optimized OS". type: string - description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - dir: + version: type: string description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. - secretEnv: + The version of the benchmark. This is set to the version of the + OS-specific CIS document the benchmark is defined in. + id: ComplianceVersion + type: object + VulnerabilityOccurrencesSummary: + type: object + id: VulnerabilityOccurrencesSummary + properties: + counts: type: array items: - type: string - description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - allowExitCodes: - items: - format: int32 - type: integer - description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. - type: array - env: + $ref: '#/components/schemas/FixableTotalByDigest' description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". + A listing by resource of the number of fixable and total + vulnerabilities. + description: >- + A summary of how many vulnerability occurrences there are per resource + and severity type. + ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: + type: object + description: >- + Container message for hashes of byte content of files, used in + SourceProvenance messages to verify integrity of source input to the + build. + properties: + fileHash: + description: Collection of file hashes. type: array items: - type: string - automapSubstitutions: - description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - type: boolean - status: - description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: + description: >- + BuildApproval describes a build's approval configuration, state, and + result. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval + properties: + result: + description: Output only. Result of manual approval for this Build. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + state: enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. + - Default enum type. This should not be used. + - Build approval is pending. + - Build approval has been approved. + - Build approval has been rejected. + - Build was cancelled while it was still pending approval. type: string - readOnly: true enum: - - STATUS_UNKNOWN + - STATE_UNSPECIFIED - PENDING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT + - APPROVED + - REJECTED - CANCELLED - - EXPIRED - pullTiming: + description: Output only. The state of this build's approval. + readOnly: true + config: readOnly: true $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - description: A step in the build pipeline. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep - Policy: + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + description: Output only. Configuration for manual approval of this build. type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult: description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - id: Policy + ApprovalResult describes the decision and associated metadata of a + manual approval of a build. properties: - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. + comment: + type: string + description: Optional. An optional comment for this manual approval result. + approverAccount: type: string - format: byte - version: - format: int32 description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - bindings: - items: - $ref: '#/components/schemas/Binding' - type: array - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - ExportSBOMResponse: - description: The response from a call to ExportSBOM. - properties: - discoveryOccurrence: + Output only. Email of the user that called the ApproveBuild API to + approve or reject a build at the time that the API was called. + readOnly: true + decision: + description: Required. The decision of this manual approval. + enum: + - DECISION_UNSPECIFIED + - APPROVED + - REJECTED + type: string + enumDescriptions: + - Default enum type. This should not be used. + - Build is approved. + - Build is rejected. + url: + type: string description: >- - The name of the discovery occurrence in the form - "projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to - track the progress of the SBOM export. + Optional. An optional URL tied to this manual approval result. This + field is essentially the same as comment, except that it will be + rendered by the UI differently. An example use case is a link to an + external job that approved this Build. + approvalTime: + readOnly: true type: string - id: ExportSBOMResponse + format: google-datetime + description: Output only. The time when the approval decision was made. type: object - ImageOccurrence: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult + BatchCreateOccurrencesRequest: properties: - fingerprint: - description: Required. The fingerprint of the derived image. - $ref: '#/components/schemas/Fingerprint' - baseResourceUrl: - type: string - description: >- - Output only. This contains the base image URL for the derived image - occurrence. - distance: - format: int32 - description: >- - Output only. The number of layers by which this image differs from - the associated image basis. - type: integer - layerInfo: + occurrences: + description: Required. The occurrences to create. Max allowed length is 1000. + items: + $ref: '#/components/schemas/Occurrence' + type: array + description: Request to create occurrences in batch. + id: BatchCreateOccurrencesRequest + type: object + ListOccurrencesResponse: + type: object + properties: + occurrences: type: array items: - $ref: '#/components/schemas/Layer' + $ref: '#/components/schemas/Occurrence' + description: The occurrences requested. + nextPageToken: + type: string description: >- - This contains layer-specific metadata, if populated it has length - "distance" and is ordered with [distance] being the layer - immediately following the base image and [1] being the final layer. - id: ImageOccurrence - type: object - description: >- - Details of the derived image portion of the DockerImage relationship. - This image would be produced from a Dockerfile with FROM . - SourceContext: - id: SourceContext + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. + id: ListOccurrencesResponse + description: Response for listing occurrences. + ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: description: >- - A SourceContext is a reference to a tree of files. A SourceContext - together with a path point to a unique revision of a single file or - directory. + Pairs a set of secret environment variables containing encrypted values + with the Cloud KMS key to use to decrypt the value. Note: Use + `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with + `secret`. For instructions see: + https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret properties: - cloudRepo: - $ref: '#/components/schemas/CloudRepoSourceContext' + kmsKeyName: + type: string + description: Cloud KMS key name to use to decrypt these envs. + secretEnv: description: >- - A SourceContext referring to a revision in a Google Cloud Source - Repo. - gerrit: - description: A SourceContext referring to a Gerrit project. - $ref: '#/components/schemas/GerritSourceContext' - labels: - type: object + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. additionalProperties: type: string - description: Labels with user defined metadata. - git: - description: >- - A SourceContext referring to any third party Git repo (e.g., - GitHub). - $ref: '#/components/schemas/GitSourceContext' + format: byte + type: object + GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: + description: >- + Indicates that the builder claims certain fields in this message to be + complete. + properties: + parameters: + type: boolean + materials: + type: boolean + environment: + type: boolean type: object - Publisher: + id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness + License: + type: object + description: License information. + id: License properties: - name: - description: 'Name of the publisher. Examples: ''Google'', ''Google Cloud Platform''.' + comments: type: string - issuingAuthority: + description: Comments + expression: type: string description: >- - Provides information about the authority of the issuing party to - release the document, in particular, the party's constituency and - responsibilities or other obligations. - publisherNamespace: - description: >- - The context or namespace. Contains a URL which is under control of - the issuing party and can be used as a globally unique identifier - for that issuing party. Example: https://csaf.io - type: string - description: Publisher contains information about the publisher of this Note. - type: object - id: Publisher - DSSEAttestationNote: - properties: - hint: - description: DSSEHint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/DSSEHint' - type: object - id: DSSEAttestationNote - SlsaProvenanceZeroTwo: - type: object - description: See full explanation of fields at slsa.dev/provenance/v0.2. + Often a single license can be used to represent the licensing terms. + Sometimes it is necessary to include a choice of one or more + licenses or some combination of license identifiers. Examples: + "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later + WITH Bison-exception-2.2". + BuildStep: + id: BuildStep properties: - buildType: - type: string - invocation: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' - materials: - type: array + allowExitCodes: + description: >- + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. items: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' - buildConfig: - additionalProperties: - description: Properties of the object. - type: any - type: object - builder: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' - metadata: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' - id: SlsaProvenanceZeroTwo - Note: - id: Note - properties: - package: - $ref: '#/components/schemas/PackageNote' - description: A note describing a package hosted by various package managers. - vulnerabilityAssessment: - description: A note describing a vulnerability assessment. - $ref: '#/components/schemas/VulnerabilityAssessmentNote' - expirationTime: - type: string - description: Time of expiration for this note. Empty if note does not expire. - format: google-datetime - relatedNoteNames: - description: Other notes related to this note. + format: int32 + type: integer type: array + waitFor: + description: >- + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. items: type: string - image: - description: A note describing a base image. - $ref: '#/components/schemas/ImageNote' - name: - description: >- - Output only. The name of the note in the form of - `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - type: string - kind: - description: >- - Output only. The type of analysis. This field can be used as a - filter in list requests. + type: array + status: type: string enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. + - Status of the build is unknown. - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. + Build has been created and is pending execution and queuing. It + has not been queued. + - Build has been received and is being queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + description: >- + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE - attestation: - description: A note describing an attestation role. - $ref: '#/components/schemas/AttestationNote' - discovery: - $ref: '#/components/schemas/DiscoveryNote' - description: A note describing the initial analysis of a resource. - shortDescription: + - STATUS_UNKNOWN + - PENDING + - QUEUING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + volumes: + type: array + items: + $ref: '#/components/schemas/Volume' + description: >- + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + args: + type: array + description: >- + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. + items: + type: string + dir: type: string - description: A one sentence description of this note. - upgrade: - description: A note describing available package upgrades. - $ref: '#/components/schemas/UpgradeNote' - createTime: + description: >- + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. + automapSubstitutions: + description: >- + Option to include built-in and custom substitutions as env variables + for this build step. This option will override the global option in + BuildOption. + type: boolean + timeout: type: string + format: google-duration description: >- - Output only. The time this note was created. This field can be used - as a filter in list requests. - format: google-datetime - vulnerability: - description: A note describing a package vulnerability. - $ref: '#/components/schemas/VulnerabilityNote' - compliance: - description: A note describing a compliance check. - $ref: '#/components/schemas/ComplianceNote' - updateTime: + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. + entrypoint: + description: >- + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. type: string - format: google-datetime + allowFailure: description: >- - Output only. The time this note was last updated. This field can be - used as a filter in list requests. - relatedUrl: + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + type: boolean + id: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. + type: string + timing: + description: >- + Output only. Stores timing information for executing this build + step. + $ref: '#/components/schemas/TimeSpan' + secretEnv: items: - $ref: '#/components/schemas/RelatedUrl' - description: URLs associated with this note. + type: string type: array - sbomReference: - $ref: '#/components/schemas/SBOMReferenceNote' - description: A note describing an SBOM reference. - dsseAttestation: - $ref: '#/components/schemas/DSSEAttestationNote' - description: A note describing a dsse attestation note. - deployment: - description: A note describing something that can be deployed. - $ref: '#/components/schemas/DeploymentNote' - build: - $ref: '#/components/schemas/BuildNote' - description: A note describing build provenance for a verifiable build. - longDescription: - description: A detailed description of this note. - type: string - description: A type of analysis that can be done for a resource. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo: - properties: - detail: + description: >- + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. + exitCode: + description: Output only. Return code from running the step. + type: integer + format: int32 + script: type: string - description: Explains the failure issue in more detail using hard-coded text. - type: - enum: - - FAILURE_TYPE_UNSPECIFIED - - PUSH_FAILED - - PUSH_IMAGE_NOT_FOUND - - PUSH_NOT_AUTHORIZED - - LOGGING_FAILURE - - USER_BUILD_STEP - - FETCH_SOURCE_FAILED - description: The name of the failure. + description: >- + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. + env: + items: + type: string + description: >- + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". + type: array + pullTiming: + description: >- + Output only. Stores timing information for pulling this build step's + builder image only. + $ref: '#/components/schemas/TimeSpan' + name: type: string - enumDescriptions: - - Type unspecified - - Unable to push the image to the repository. - - Final image not found. - - Unauthorized push of the final image. - - Backend logging failures. Should retry. - - A build step has failed. - - The source fetching has failed. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo + description: >- + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. type: object - description: A fatal problem encountered during the execution of the build. - EnvelopeSignature: + description: 'A step in the build pipeline. Next ID: 21' + GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial: + description: >- + The collection of artifacts that influenced the build including sources, + dependencies, build tools, base images, and so on. properties: - sig: - type: string - format: byte - keyid: + uri: type: string + digest: + additionalProperties: + type: string + type: object type: object - id: EnvelopeSignature - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption - type: object + id: GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial + FileHashes: + id: FileHashes description: >- - Details about how a build should be executed on a `WorkerPool`. See - [running builds in a private - pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) - for more information. + Container message for hashes of byte content of files, used in source + messages to verify integrity of source input to the build. properties: - name: - type: string - description: >- - The `WorkerPool` resource to execute the build on. You must have - `cloudbuild.workerpools.use` on the project hosting the WorkerPool. - Format - projects/{project}/locations/{location}/workerPools/{workerPoolId} - ProjectRepoId: - description: >- - Selects a repo using a Google Cloud Platform project ID (e.g., - winged-cargo-31) and a repo name within that project. - id: ProjectRepoId + fileHash: + description: Required. Collection of file hashes. + items: + $ref: '#/components/schemas/Hash' + type: array type: object + ResourceDescriptor: properties: - projectId: + annotations: + additionalProperties: + type: any + type: object + mediaType: type: string - description: The ID of the project. - repoName: - description: The name of the repo. Leave empty for the default repo. + content: + format: byte type: string - PackageOccurrence: - description: Details on how a particular software package was installed on a system. - type: object - id: PackageOccurrence - properties: - name: - description: Required. Output only. The name of the installed package. - readOnly: true + downloadLocation: type: string - license: - $ref: '#/components/schemas/License' - description: Licenses that have been declared by the authors of the package. - architecture: - enum: - - ARCHITECTURE_UNSPECIFIED - - X86 - - X64 - enumDescriptions: - - Unknown architecture. - - X86 architecture. - - X64 architecture. - description: >- - Output only. The CPU architecture for which packages in this - distribution channel were built. Architecture will be blank for - language packages. + digest: + additionalProperties: + type: string + type: object + name: type: string - readOnly: true - packageType: - readOnly: true + uri: type: string + type: object + id: ResourceDescriptor + Source: + type: object + properties: + additionalContexts: + items: + $ref: '#/components/schemas/SourceContext' + type: array description: >- - Output only. The type of package; whether native or non native - (e.g., ruby gems, node.js packages, etc.). - version: - $ref: '#/components/schemas/Version' - description: Output only. The version of the package. - readOnly: true - cpeUri: - type: string - readOnly: true + If provided, some of the source code used for the build may be found + in these locations, in the case where the source repository had + multiple remotes or submodules. This list will not include the + context specified in the context field. + context: description: >- - Output only. The cpe_uri in [CPE - format](https://cpe.mitre.org/specification/) denoting the package - manager version distributing a package. The cpe_uri will be blank - for language packages. - location: + If provided, the source code used for the build came from this + location. + $ref: '#/components/schemas/SourceContext' + fileHashes: + type: object + additionalProperties: + $ref: '#/components/schemas/FileHashes' description: >- - All of the places within the filesystem versions of this package - have been found. - items: - $ref: '#/components/schemas/Location' - type: array - ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation - description: Represents a storage location in Cloud Storage - properties: - bucket: + Hash(es) of the build source, which can be used to verify that the + original source integrity was maintained in the build. The keys to + this map are file paths used as build source and the values contain + the hash values for those files. If the build source came in a + single package such as a gzipped tarfile (.tar.gz), the FileHash + will be for the single path to that file. + artifactStorageSourceUri: description: >- - Cloud Storage bucket. See - https://cloud.google.com/storage/docs/naming#requirements + If provided, the input binary artifacts for the build came from this + location. type: string - object: + description: Source describes the location of the source used for the build. + id: Source + ProvenanceBuilder: + type: object + properties: + version: + type: object + additionalProperties: + type: string + id: type: string + builderDependencies: + items: + $ref: '#/components/schemas/ResourceDescriptor' + type: array + id: ProvenanceBuilder + Subject: + properties: + digest: description: >- - Cloud Storage object. See - https://cloud.google.com/storage/docs/naming#objectnames - generation: + `"": ""` Algorithms can be e.g. sha256, sha512 See + https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet + type: object + additionalProperties: + type: string + name: type: string - format: int64 - description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. - BuildMetadata: - id: BuildMetadata type: object + id: Subject + Digest: properties: - invocationId: - type: string - startedOn: - format: google-datetime + digestBytes: + format: byte type: string - finishedOn: + description: Value of the digest. + algo: + description: '`SHA1`, `SHA512` etc.' type: string - format: google-datetime - ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: + id: Digest + description: Digest information. + type: object + Version: properties: - tagName: - description: >- - Regex matching tags to build. The syntax of the regular expressions - accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - type: string - dir: + kind: + enumDescriptions: + - Unknown. + - A standard package version. + - A special version representing negative infinity. + - A special version representing positive infinity. + enum: + - VERSION_KIND_UNSPECIFIED + - NORMAL + - MINIMUM + - MAXIMUM type: string description: >- - Optional. Directory, relative to the source root, in which to run - the build. This must be a relative path. If a step's `dir` is - specified and is an absolute path, this value is ignored for that - step's execution. - commitSha: - description: Explicit commit SHA to build. - type: string - projectId: + Required. Distinguishes between sentinel MIN/MAX versions and normal + versions. + fullName: description: >- - Optional. ID of the project that owns the Cloud Source Repository. - If omitted, the project ID requesting the build is assumed. + Human readable version string. This string is of the form :- and is + only set when kind is NORMAL. type: string - branchName: + revision: + description: The iteration of the package build from the above version. type: string + name: description: >- - Regex matching branches to build. The syntax of the regular - expressions accepted is the syntax accepted by RE2 and described at - https://github.com/google/re2/wiki/Syntax - repoName: + Required only when version kind is NORMAL. The main part of the + version name. type: string - description: Required. Name of the Cloud Source Repository. - invertRegex: + inclusive: description: >- - Optional. Only trigger a build if the revision regex does NOT match - the revision regex. + Whether this version is specifying part of an inclusive range. + Grafeas does not have the capability to specify version ranges; + instead we have fields that specify start version and end versions. + At times this is insufficient - we also need to specify whether the + version is included in the range or is excluded from the range. This + boolean is expected to be set to true when the version is included + in a range. type: boolean - substitutions: - description: >- - Optional. Substitutions to use in a triggered build. Should only be - used with RunBuildTrigger - additionalProperties: - type: string - type: object - description: Location of the source in a Google Cloud Source Repository. + epoch: + description: Used to correct mistakes in the version numbering scheme. + type: integer + format: int32 + id: Version + description: Version contains structured information about the version of a package. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - ContaineranalysisGoogleDevtoolsCloudbuildV1Secret: + BuildOccurrence: + id: BuildOccurrence type: object properties: - kmsKeyName: - type: string - description: Cloud KMS key name to use to decrypt these envs. - secretEnv: + inTotoSlsaProvenanceV1: + $ref: '#/components/schemas/InTotoSlsaProvenanceV1' description: >- - Map of environment variable name to its encrypted value. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. Values can be - at most 64 KB in size. There can be at most 100 secret values across - all of a build's secrets. - type: object - additionalProperties: - type: string - format: byte - description: >- - Pairs a set of secret environment variables containing encrypted values - with the Cloud KMS key to use to decrypt the value. Note: Use - `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with - `secret`. For instructions see: - https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secret - SlsaRecipe: + In-Toto Slsa Provenance V1 represents a slsa provenance meeting the + slsa spec, wrapped in an in-toto statement. This allows for direct + jsonification of a to-spec in-toto slsa statement with a to-spec + slsa provenance. + intotoStatement: + $ref: '#/components/schemas/InTotoStatement' + description: >- + In-toto Statement representation as defined in spec. The + intoto_statement can contain any type of provenance. The serialized + payload of the statement can be stored and signed in the + Occurrence's envelope. + intotoProvenance: + description: >- + Deprecated. See InTotoStatement for the replacement. In-toto + Provenance representation as defined in spec. + $ref: '#/components/schemas/InTotoProvenance' + provenance: + description: The actual provenance for the build. + $ref: '#/components/schemas/BuildProvenance' + provenanceBytes: + description: >- + Serialized JSON representation of the provenance, used in generating + the build signature in the corresponding build note. After verifying + the signature, `provenance_bytes` can be unmarshalled and compared + to the provenance to confirm that it is unchanged. A base64-encoded + string representation of the provenance bytes is used for the + signature in order to interoperate with openssl which expects this + format for signature verification. The serialized form is captured + both to avoid ambiguity in how the provenance is marshalled to json + as well to prevent incompatibilities with future changes. + type: string + description: Details of a build occurrence. + SlsaMetadata: + id: SlsaMetadata + description: Other properties of the build. type: object - id: SlsaRecipe properties: - entryPoint: - type: string - description: >- - String identifying the entry point into the build. This is often a - path to a configuration file and/or a target label within that file. - The syntax and meaning are defined by recipe.type. For example, if - the recipe type were "make", then this would reference the directory - in which to run make as well as which target to use. - arguments: - type: object + buildInvocationId: description: >- - Collection of all external inputs that influenced the build on top - of recipe.definedInMaterial and recipe.entryPoint. For example, if - the recipe type were "make", then this might be the flags passed to - make aside from the target, which is captured in recipe.entryPoint. - Depending on the recipe Type, the structure may be different. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. type: string + completeness: description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - definedInMaterial: + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/SlsaCompleteness' + reproducible: description: >- - Index in materials containing the recipe steps that are not implied - by recipe.type. For example, if the recipe type were "make", then - this would point to the source containing the Makefile, not the make - program itself. Set to -1 if the recipe doesn't come from a - material, as zero is default unset value for int64. - format: int64 + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + type: boolean + buildFinishedOn: type: string - environment: - description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Depending on the recipe Type, - the structure may be different. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. - DeploymentNote: - description: An artifact that can be deployed in some runtime. + description: The timestamp of when the build completed. + format: google-datetime + buildStartedOn: + description: The timestamp of when the build started. + format: google-datetime + type: string + SBOMReferenceNote: properties: - resourceUri: - items: - type: string - type: array - description: Required. Resource URI for the artifact being deployed. + format: + type: string + description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... + version: + type: string + description: >- + The version of the format that the SBOM takes. E.g. if the format is + spdx, the version may be 2.3. + id: SBOMReferenceNote + description: The note representing an SBOM reference. type: object - id: DeploymentNote - DSSEHint: + DiscoveryNote: + id: DiscoveryNote + description: >- + A note that indicates a type of analysis a provider would perform. This + note exists in a provider's project. A `Discovery` occurrence is created + in a consumer's project at the start of analysis. type: object properties: - humanReadableName: + analysisKind: description: >- - Required. The human readable name of this attestation authority, for - example "cloudbuild-prod". + Required. Immutable. The kind of analysis that is handled by this + discovery. + enumDescriptions: + - Default value. This value is unused. + - The note and occurrence represent a package vulnerability. + - The note and occurrence assert build provenance. + - This represents an image basis relationship. + - This represents a package installed via a package manager. + - The note and occurrence track deployment events. + - >- + The note and occurrence track the initial discovery status of a + resource. + - This represents a logical "role" that can attest to artifacts. + - This represents an available package upgrade. + - This represents a Compliance Note + - This represents a DSSE attestation Note + - This represents a Vulnerability Assessment. + - This represents an SBOM Reference. + enum: + - NOTE_KIND_UNSPECIFIED + - VULNERABILITY + - BUILD + - IMAGE + - PACKAGE + - DEPLOYMENT + - DISCOVERY + - ATTESTATION + - UPGRADE + - COMPLIANCE + - DSSE_ATTESTATION + - VULNERABILITY_ASSESSMENT + - SBOM_REFERENCE type: string - description: >- - This submessage provides human-readable hints about the purpose of the - authority. Because the name of a note acts as its resource reference, it - is important to disambiguate the canonical name of the Note (which might - be a UUID for security purposes) from "readable" names more suitable for - debug output. Note that these hints should not be used to look up - authorities in security sensitive contexts, such as when looking up - attestations to verify. - id: DSSEHint - ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: + InTotoProvenance: type: object - description: >- - Volume describes a Docker container volume which is mounted into build - steps in order to persist files across build step execution. + id: InTotoProvenance properties: - path: + materials: description: >- - Path at which to mount the volume. Paths must be absolute and cannot - conflict with other volume paths on the same build step or with - certain reserved volume paths. - type: string - name: + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. + items: + type: string + type: array + metadata: + $ref: '#/components/schemas/Metadata' + builderConfig: + description: required + $ref: '#/components/schemas/BuilderConfig' + recipe: description: >- - Name of the volume to mount. Volume names must be unique per build - step and must be valid names for Docker volumes. Each named volume - must be used by at least two build steps. + Identifies the configuration used for the build. When combined with + materials, this SHOULD fully describe the build, such that + re-running this recipe results in bit-for-bit identical output (if + the build is reproducible). required + $ref: '#/components/schemas/Recipe' + ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + description: Container message for hash values. + properties: + value: + type: string + format: byte + description: The hash value. + type: + enum: + - NONE + - SHA256 + - MD5 + - SHA512 + description: The type of hash that was performed. + enumDescriptions: + - No hash requested. + - Use a sha256 hash. + - Use a md5 hash. + - Use a sha512 hash. type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume - Detail: type: object - id: Detail + Category: + description: The category to which the update belongs. properties: - severityName: - description: The distro assigned severity of this vulnerability. - type: string - fixedPackage: - description: >- - The distro recommended package to update to that contains a fix for - this vulnerability. It is possible for this to be different from the - affected_package. + name: type: string - description: + description: The localized name of the category. + categoryId: + description: The identifier of the category. type: string - description: A vendor-specific description of this vulnerability. - isObsolete: - description: >- - Whether this detail is obsolete. Occurrences are expected not to - point to obsolete details. - type: boolean - affectedPackage: - description: Required. The package this vulnerability affects. + id: Category + type: object + BuildDefinition: + id: BuildDefinition + properties: + buildType: type: string - affectedCpeUri: + internalParameters: + additionalProperties: + type: any + description: Properties of the object. + type: object + externalParameters: + additionalProperties: + description: Properties of the object. + type: any + type: object + resolvedDependencies: + items: + $ref: '#/components/schemas/ResourceDescriptor' + type: array + type: object + SlsaProvenanceV1: + properties: + buildDefinition: + $ref: '#/components/schemas/BuildDefinition' + runDetails: + $ref: '#/components/schemas/RunDetails' + type: object + id: SlsaProvenanceV1 + description: >- + Keep in sync with schema at + https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto + Builder renamed to ProvenanceBuilder because of Java conflicts. + ComplianceOccurrence: + type: object + id: ComplianceOccurrence + description: >- + An indication that the compliance checks in the associated + ComplianceNote were not satisfied for particular resources or a + specified reason. + properties: + nonComplianceReason: type: string + version: + $ref: '#/components/schemas/ComplianceVersion' + description: The OS and config version the benchmark was run on. + nonCompliantFiles: + type: array + items: + $ref: '#/components/schemas/NonCompliantFile' + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep: + description: A step in the build pipeline. + properties: + waitFor: + type: array description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. - vendor: - description: The name of the vendor of the product. - type: string - fixedVersion: + The ID(s) of the step(s) that this build step depends on. This build + step will not start until all the build steps in `wait_for` have + completed successfully. If `wait_for` is empty, this build step will + start when all previous build steps in the `Build.Steps` list have + completed successfully. + items: + type: string + timing: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true description: >- - The distro recommended version to update to that contains a fix for - this vulnerability. Setting this to VersionKind.MAXIMUM means no - such version is yet available. - $ref: '#/components/schemas/Version' - fixedCpeUri: + Output only. Stores timing information for executing this build + step. + script: + description: >- + A shell script to be executed in the step. When script is provided, + the user cannot specify the entrypoint or args. type: string + dir: description: >- - The distro recommended [CPE - URI](https://cpe.mitre.org/specification/) to update to that - contains a fix for this vulnerability. It is possible for this to be - different from the affected_cpe_uri. - sourceUpdateTime: - format: google-datetime + Working directory to use when running this step's container. If this + value is a relative path, it is relative to the build's working + directory. If this value is absolute, it may be outside the build's + working directory, in which case the contents of the path may not be + persisted across build step executions, unless a `volume` for that + path is specified. If the build specifies a `RepoSource` with `dir` + and a step with a `dir`, which specifies an absolute path, the + `RepoSource` `dir` is ignored for the step's execution. type: string + exitCode: + readOnly: true + format: int32 + type: integer + description: Output only. Return code from running the step. + automapSubstitutions: description: >- - The time this information was last changed at the source. This is an - upstream timestamp from the underlying information source - e.g. - Ubuntu security tracker. - affectedVersionStart: - $ref: '#/components/schemas/Version' + Option to include built-in and custom substitutions as env variables + for this build step. This option will override the global option in + BuildOption. + type: boolean + allowExitCodes: description: >- - The version number at the start of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - source: - description: The source from which the information in this Detail was obtained. + Allow this build step to fail without failing the entire build if + and only if the exit code is one of the specified codes. If + allow_failure is also specified, this field will take precedence. + type: array + items: + format: int32 + type: integer + args: + description: >- + A list of arguments that will be presented to the step when it is + started. If the image used to run the step's container has an + entrypoint, the `args` are used as arguments to that entrypoint. If + the image does not define an entrypoint, the first element in args + is used as the entrypoint, and the remainder will be used as + arguments. + items: + type: string + type: array + entrypoint: type: string - affectedVersionEnd: description: >- - The version number at the end of an interval in which this - vulnerability exists. A vulnerability can affect a package between - version numbers that are disjoint sets of intervals (example: - [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will - be represented in its own Detail. If a specific affected version is - provided by a vulnerability database, affected_version_start and - affected_version_end will be the same in that Detail. - $ref: '#/components/schemas/Version' - packageType: + Entrypoint to be used instead of the build step image's default + entrypoint. If unset, the image's default entrypoint is used. + timeout: + format: google-duration + type: string description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). + Time limit for executing this build step. If not defined, the step + has no time limit and will be allowed to continue to run until + either it completes or the build itself times out. + id: + description: >- + Unique identifier for this build step, used in `wait_for` to + reference this build step as a dependency. type: string - description: >- - A detail for a distro and package affected by this vulnerability and its - associated fix (if one is available). - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: - properties: - timing: + pullTiming: $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan readOnly: true description: >- - Output only. Stores timing information for pushing all artifact - objects. - location: + Output only. Stores timing information for pulling this build step's + builder image only. + name: type: string description: >- - Cloud Storage bucket and optional object path, in the form - "gs://bucket/path/to/somewhere/". (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - Files in the workspace matching any path pattern will be uploaded to - Cloud Storage with this location as a prefix. - paths: + Required. The name of the container image that will run this + particular build step. If the image is available in the host's + Docker daemon's cache, it will be run directly. If not, the host + will attempt to pull the image first, using the builder service + account's credentials if necessary. The Docker daemon's cache will + already have the latest versions of all of the officially supported + build steps + ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). + The Docker daemon will also have cached many of the layers for some + popular images, like "ubuntu", "debian", but they will be refreshed + at the time you attempt to use them. If you built an image in a + previous build step, it will be stored in the host's Docker daemon's + cache and is available to use as the name for a later build step. + status: + enumDescriptions: + - Status of the build is unknown. + - >- + Build has been created and is pending execution and queuing. It + has not been queued. + - Build or step is queued; work has not yet begun. + - Build or step is being executed. + - Build or step finished successfully. + - Build or step failed to complete successfully. + - Build or step failed due to an internal cause. + - Build or step took longer than was allowed. + - Build or step was canceled by a user. + - Build was enqueued for longer than the value of `queue_ttl`. + enum: + - STATUS_UNKNOWN + - PENDING + - QUEUED + - WORKING + - SUCCESS + - FAILURE + - INTERNAL_ERROR + - TIMEOUT + - CANCELLED + - EXPIRED + readOnly: true + description: >- + Output only. Status of the build step. At this time, build step + status is only updated on build completion; step status is not + updated in real-time as the build progresses. + type: string + volumes: type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Volume + description: >- + List of volumes to mount into the build step. Each volume is created + as an empty volume prior to execution of the build step. Upon + completion of the build, volumes and their contents are discarded. + Using a named volume in only one step is not valid as it is + indicative of a build request with an incorrect configuration. + env: + type: array + description: >- + A list of environment variable definitions to be used when running a + step. The elements are of the form "KEY=VALUE" for the environment + variable "KEY" being given the value "VALUE". items: type: string - description: Path globs used to match files in the build's workspace. + secretEnv: + items: + type: string + description: >- + A list of environment variables which are encrypted using a Cloud + Key Management Service crypto key. These values must be specified in + the build's `Secret`. + type: array + allowFailure: + type: boolean + description: >- + Allow this build step to fail without failing the entire build. If + false, the entire build will fail if this step fails. Otherwise, the + build will succeed, but this step will still have a failure status. + Error information will be reported in the failure_detail field. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep type: object - description: >- - Files in the workspace to upload to Cloud Storage upon successful - completion of all build steps. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects - ContaineranalysisGoogleDevtoolsCloudbuildV1Hash: + DeploymentOccurrence: + id: DeploymentOccurrence properties: - value: - description: The hash value. - format: byte + config: type: string - type: + description: Configuration used to create this deployment. + platform: + description: Platform hosting this deployment. enum: - - NONE - - SHA256 - - MD5 - - SHA512 - type: string - description: The type of hash that was performed. + - PLATFORM_UNSPECIFIED + - GKE + - FLEX + - CUSTOM enumDescriptions: - - No hash requested. - - Use a sha256 hash. - - Use a md5 hash. - - Use a sha512 hash. - description: Container message for hash values. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Hash + - Unknown. + - Google Container Engine. + - 'Google App Engine: Flexible Environment.' + - Custom user-defined platform. + type: string + deployTime: + format: google-datetime + description: Required. Beginning of the lifetime of this deployment. + type: string + undeployTime: + type: string + format: google-datetime + description: End of the lifetime of this deployment. + address: + description: Address of the runtime element hosting this deployment. + type: string + resourceUri: + type: array + description: >- + Output only. Resource URI for the artifact being deployed taken from + the deployable field with the same name. + items: + type: string + userEmail: + description: Identity of the user that triggered this deployment. + type: string type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance: + description: The period during which some deployable was active in a runtime. + Distribution: properties: - resolvedConnectedRepository: - description: >- - Output only. A copy of the build's `source.connected_repository`, if - exists, with any revisions resolved. - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository - resolvedStorageSource: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - description: >- - A copy of the build's `source.storage_source`, if exists, with any - generations resolved. - resolvedRepoSource: - description: >- - A copy of the build's `source.repo_source`, if exists, with any - revisions resolved. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - resolvedGitSource: - readOnly: true - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + latestVersion: description: >- - Output only. A copy of the build's `source.git_source`, if exists, - with any revisions resolved. - resolvedStorageSourceManifest: + The latest available version of this package in this distribution + channel. + $ref: '#/components/schemas/Version' + url: + description: The distribution channel-specific homepage for this package. + type: string + description: + type: string + description: The distribution channel-specific description of this package. + cpeUri: description: >- - A copy of the build's `source.storage_source_manifest`, if exists, - with any revisions resolved. This feature is in Preview. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - fileHashes: - additionalProperties: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - readOnly: true - type: object + Required. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. + type: string + maintainer: + description: A freeform string denoting the maintainer of this package. + type: string + architecture: + type: string + enum: + - ARCHITECTURE_UNSPECIFIED + - X86 + - X64 + enumDescriptions: + - Unknown architecture. + - X86 architecture. + - X64 architecture. description: >- - Output only. Hash(es) of the build source, which can be used to - verify that the original source integrity was maintained in the - build. Note that `FileHashes` will only be populated if - `BuildOptions` has requested a `SourceProvenanceHash`. The keys to - this map are file paths used as build source and the values contain - the hash values for those files. If the build source came in a - single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` - will be for the single path to that file. + The CPU architecture for which packages in this distribution channel + were built. + id: Distribution description: >- - Provenance of the source. Ways to find the original source, or verify - that some source was used for this build. + This represents a particular channel of distribution for a given + package. E.g., Debian's jessie-backports dpkg mirror. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance - ProvenanceBuilder: - id: ProvenanceBuilder + ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret: + description: >- + Pairs a set of secret environment variables mapped to encrypted values + with the Cloud KMS key to use to decrypt the value. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret type: object properties: - id: + kmsKeyName: type: string - version: + description: >- + Resource name of Cloud KMS crypto key to decrypt the encrypted + value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/* + envMap: + description: >- + Map of environment variable name to its encrypted value. Secret + environment variables must be unique across all of a build's + secrets, and must be used by at least one build step. Values can be + at most 64 KB in size. There can be at most 100 secret values across + all of a build's secrets. additionalProperties: type: string + format: byte type: object - builderDependencies: - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: array - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage: + Recipe: + id: Recipe + description: >- + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. properties: - packagePath: + entryPoint: + description: >- + String identifying the entry point into the build. This is often a + path to a configuration file and/or a target label within that file. + The syntax and meaning are defined by recipe.type. For example, if + the recipe type were "make", then this would reference the directory + in which to run make as well as which target to use. type: string - description: Path to the package.json. e.g. workspace/path/to/package - repository: + definedInMaterial: type: string description: >- - Artifact Registry repository, in the form - "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in - the workspace specified by path will be zipped and uploaded to - Artifact Registry with this location as a prefix. - description: >- - Npm package to upload to Artifact Registry upon successful completion of - all build steps. + Index in materials containing the recipe steps that are not implied + by recipe.type. For example, if the recipe type were "make", then + this would point to the source containing the Makefile, not the make + program itself. Set to -1 if the recipe doesn't come from a + material, as zero is default unset value for int64. + format: int64 + environment: + type: array + description: >- + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Since the environment field can + greatly vary in structure, depending on the builder and recipe type, + this is of form "Any". + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: + description: >- + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. + type: string + arguments: + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array + description: >- + Collection of all external inputs that influenced the build on top + of recipe.definedInMaterial and recipe.entryPoint. For example, if + the recipe type were "make", then this might be the flags passed to + make aside from the target, which is captured in recipe.entryPoint. + Since the arguments field can greatly vary in structure, depending + on the builder and recipe type, this is of form "Any". type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - DiscoveryOccurrence: - id: DiscoveryOccurrence + Jwt: + type: object + id: Jwt properties: - sbomStatus: - $ref: '#/components/schemas/SBOMStatus' - description: The status of an SBOM generation. - lastScanTime: - type: string - format: google-datetime - description: The last time this resource was scanned. - cpe: + compactJwt: type: string - description: The CPE of the resource being scanned. - analysisStatus: + description: >- + The compact encoding of a JWS, which is always three base64 encoded + strings joined by periods. For details, see: + https://tools.ietf.org/html/rfc7515.html#section-3.1 + Volume: + properties: + name: type: string - description: The status of discovery for the resource. - enumDescriptions: - - Unknown. - - Resource is known but no action has been taken yet. - - Resource is being analyzed. - - Analysis has finished successfully. - - Analysis has completed. - - >- - Analysis has finished unsuccessfully, the analysis itself is in a - bad state. - - The resource is known not to be supported. - enum: - - ANALYSIS_STATUS_UNSPECIFIED - - PENDING - - SCANNING - - FINISHED_SUCCESS - - COMPLETE - - FINISHED_FAILED - - FINISHED_UNSUPPORTED - continuousAnalysis: - enumDescriptions: - - Unknown. - - The resource is continuously analyzed. - - The resource is ignored for continuous analysis. + description: >- + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. + path: + description: >- + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. + type: string + type: object + description: >- + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. Next ID: 3 + id: Volume + ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: + description: ApprovalConfig describes configuration for manual approval of a build. + type: object + properties: + approvalRequired: + type: boolean + description: >- + Whether or not approval is needed. If this is set on a build, it + will become pending when created, and will need to be explicitly + approved to start. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig + Identity: + id: Identity + properties: + revision: + format: int32 + description: The revision number of the update. + type: integer + updateId: + description: The revision independent identifier of the update. + type: string + type: object + description: The unique identifier of the update. + BatchCreateNotesResponse: + description: Response for creating notes in batch. + properties: + notes: + description: The notes that were created. + type: array + items: + $ref: '#/components/schemas/Note' + id: BatchCreateNotesResponse + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig: + description: This config defines the location of a source through Developer Connect. + properties: + gitRepositoryLink: + description: >- + Required. The Developer Connect Git repository link, formatted as + `projects/*/locations/*/connections/*/gitRepositoryLink/*`. + type: string + dir: + type: string + description: >- + Required. Directory, relative to the source root, in which to run + the build. + revision: + description: >- + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. type: string + id: ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + type: object + SlsaProvenance: + type: object + id: SlsaProvenance + properties: + metadata: + $ref: '#/components/schemas/SlsaMetadata' + materials: + items: + $ref: '#/components/schemas/Material' + description: >- + The collection of artifacts that influenced the build including + sources, dependencies, build tools, base images, and so on. This is + considered to be incomplete unless metadata.completeness.materials + is true. Unset or null is equivalent to empty. + type: array + recipe: + $ref: '#/components/schemas/SlsaRecipe' + description: >- + Identifies the configuration used for the build. When combined with + materials, this SHOULD fully describe the build, such that + re-running this recipe results in bit-for-bit identical output (if + the build is reproducible). required + builder: + description: required + $ref: '#/components/schemas/SlsaBuilder' + DiscoveryOccurrence: + id: DiscoveryOccurrence + type: object + properties: + sbomStatus: + description: The status of an SBOM generation. + $ref: '#/components/schemas/SBOMStatus' + continuousAnalysis: description: Whether the resource is continuously analyzed. + type: string enum: - CONTINUOUS_ANALYSIS_UNSPECIFIED - ACTIVE - INACTIVE - analysisError: - description: >- - Indicates any errors encountered during analysis of a resource. - There could be 0 or more of these errors. - items: - $ref: '#/components/schemas/Status' - type: array + enumDescriptions: + - Unknown. + - The resource is continuously analyzed. + - The resource is ignored for continuous analysis. + cpe: + description: The CPE of the resource being scanned. + type: string + analysisCompleted: + $ref: '#/components/schemas/AnalysisCompleted' analysisStatusError: + $ref: '#/components/schemas/Status' description: >- When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. - $ref: '#/components/schemas/Status' + analysisError: + items: + $ref: '#/components/schemas/Status' + type: array + description: >- + Indicates any errors encountered during analysis of a resource. + There could be 0 or more of these errors. archiveTime: format: google-datetime + type: string readOnly: true description: >- Output only. The time occurrences related to this discovery occurrence were archived. + analysisStatus: + enumDescriptions: + - Unknown. + - Resource is known but no action has been taken yet. + - Resource is being analyzed. + - Analysis has finished successfully. + - Analysis has completed. + - >- + Analysis has finished unsuccessfully, the analysis itself is in a + bad state. + - The resource is known not to be supported. + description: The status of discovery for the resource. + enum: + - ANALYSIS_STATUS_UNSPECIFIED + - PENDING + - SCANNING + - FINISHED_SUCCESS + - COMPLETE + - FINISHED_FAILED + - FINISHED_UNSUPPORTED + type: string + lastScanTime: + description: The last time this resource was scanned. + format: google-datetime type: string - analysisCompleted: - $ref: '#/components/schemas/AnalysisCompleted' - type: object description: Provides information about the analysis status of a discovered resource. - VexAssessment: + ContaineranalysisGoogleDevtoolsCloudbuildV1Volume: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Volume description: >- - VexAssessment provides all publisher provided Vex information that is - related to this vulnerability. - id: VexAssessment - type: object + Volume describes a Docker container volume which is mounted into build + steps in order to persist files across build step execution. properties: - remediations: - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - items: - $ref: '#/components/schemas/Remediation' - type: array - state: - description: Provides the state of this Vulnerability assessment. - type: string - enumDescriptions: - - No state is specified. - - This product is known to be affected by this vulnerability. - - This product is known to be not affected by this vulnerability. - - This product contains a fix for this vulnerability. - - >- - It is not known yet whether these versions are or are not affected - by the vulnerability. However, it is still under investigation. - enum: - - STATE_UNSPECIFIED - - AFFECTED - - NOT_AFFECTED - - FIXED - - UNDER_INVESTIGATION - impacts: - type: array - items: - type: string - description: >- - Contains information about the impact of this vulnerability, this - will change with time. - justification: - description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. - $ref: '#/components/schemas/Justification' - cve: + path: description: >- - Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) - tracking number for the vulnerability. Deprecated: Use - vulnerability_id instead to denote CVEs. - deprecated: true + Path at which to mount the volume. Paths must be absolute and cannot + conflict with other volume paths on the same build step or with + certain reserved volume paths. type: string - vulnerabilityId: + name: type: string description: >- - The vulnerability identifier for this Assessment. Will hold one of - common identifiers e.g. CVE, GHSA etc. - noteName: - description: >- - The VulnerabilityAssessment note from which this VexAssessment was - generated. This will be of the form: - `projects/[PROJECT_ID]/notes/[NOTE_ID]`. + Name of the volume to mount. Volume names must be unique per build + step and must be valid names for Docker volumes. Each named volume + must be used by at least two build steps. + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig: + description: HttpConfig is a configuration for HTTP related git operations. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + properties: + proxySecretVersionName: type: string - relatedUris: description: >- - Holds a list of references associated with this vulnerability item - and assessment. - type: array - items: - $ref: '#/components/schemas/RelatedUrl' - ResourceDescriptor: + SecretVersion resource of the HTTP proxy URL. The Service Account + used in the build (either the default Service Account or + user-specified Service Account) should have + `secretmanager.versions.access` permissions on this secret. The + proxy URL should be in format `protocol://@]proxyhost[:port]`. + type: object + Policy: type: object properties: - annotations: - type: object - additionalProperties: - type: any - uri: - type: string - downloadLocation: - type: string - content: - type: string - format: byte - mediaType: - type: string - digest: - additionalProperties: - type: string - type: object - name: - type: string - id: ResourceDescriptor - ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: - description: Location of the source in an archive file in Cloud Storage. - type: object - properties: - object: - description: >- - Required. Cloud Storage object containing the source. This object - must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) - containing source to build. - type: string - sourceFetcher: - type: string - enumDescriptions: - - Unspecified defaults to GSUTIL. - - Use the "gsutil" tool to download the source file. - - Use the Cloud Storage Fetcher tool to download the source file. - description: >- - Optional. Option to specify the tool to fetch the source file for - the build. - enum: - - SOURCE_FETCHER_UNSPECIFIED - - GSUTIL - - GCS_FETCHER - generation: - type: string - format: int64 - description: >- - Optional. Cloud Storage generation for the object. If the generation - is omitted, the latest generation will be used. - bucket: - description: >- - Cloud Storage bucket containing the source (see [Bucket Name - Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). - type: string - id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - SlsaMetadata: - id: SlsaMetadata - type: object - properties: - buildStartedOn: - format: google-datetime - description: The timestamp of when the build started. - type: string - reproducible: + version: + format: int32 + type: integer description: >- - If true, the builder claims that running the recipe on materials - will produce bit-for-bit identical output. - type: boolean - buildFinishedOn: - type: string - format: google-datetime - description: The timestamp of when the build completed. - buildInvocationId: + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + etag: description: >- - Identifies the particular build invocation, which can be useful for - finding associated logs or other ad-hoc analysis. The value SHOULD - be globally unique, per in-toto Provenance spec. + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + format: byte type: string - completeness: - description: >- - Indicates that the builder claims certain fields in this message to - be complete. - $ref: '#/components/schemas/SlsaCompleteness' - description: Other properties of the build. - Layer: - id: Layer - properties: - directive: + bindings: description: >- - Required. The recovered Dockerfile directive used to construct this - layer. See https://docs.docker.com/engine/reference/builder/ for - more information. - type: string - arguments: - type: string - description: The recovered arguments to the Dockerfile directive. + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + ContaineranalysisGoogleDevtoolsCloudbuildV1Results: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results + description: Artifacts created by the build pipeline. type: object - description: Layer holds metadata specific to a layer of a Docker image. - Command: - description: Command describes a step performed as part of the build pipeline. properties: - id: - description: >- - Optional unique identifier for this command, used in wait_for to - reference this command as a dependency. - type: string - args: + artifactTiming: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + description: Time to push all non-container artifacts to Cloud Storage. + images: + description: Container images that were built as a part of the build. items: - type: string + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage type: array - description: Command-line arguments used when executing this command. - env: - description: Environment variables set before running this command. + buildStepImages: type: array + description: >- + List of build step digests, in the order corresponding to build step + indices. items: type: string - waitFor: + mavenArtifacts: + description: >- + Maven artifacts uploaded to Artifact Registry at the end of the + build. items: - type: string - description: The ID(s) of the command(s) that this command depends on. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact type: array - dir: + numArtifacts: + format: int64 description: >- - Working directory (relative to project source root) used when - running this command. + Number of non-container artifacts uploaded to Cloud Storage. Only + populated when artifacts are uploaded to Cloud Storage. type: string - name: + artifactManifest: type: string description: >- - Required. Name of the command, as presented on the command line, or - if the command is packaged as a Docker container, as presented to - `docker pull`. - type: object - id: Command - BuildStep: - type: object - properties: - pullTiming: - $ref: '#/components/schemas/TimeSpan' + Path to the artifact manifest for non-container artifacts uploaded + to Cloud Storage. Only populated when artifacts are uploaded to + Cloud Storage. + npmPackages: + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + type: array + description: Npm packages uploaded to Artifact Registry at the end of the build. + pythonPackages: description: >- - Output only. Stores timing information for pulling this build step's - builder image only. - exitCode: - format: int32 - description: Output only. Return code from running the step. - type: integer - allowExitCodes: + Python artifacts uploaded to Artifact Registry at the end of the + build. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage type: array + buildStepOutputs: items: - format: int32 - type: integer + type: string + format: byte description: >- - Allow this build step to fail without failing the entire build if - and only if the exit code is one of the specified codes. If - allow_failure is also specified, this field will take precedence. - volumes: + List of build step outputs, produced by builder images, in the order + corresponding to build step indices. [Cloud + Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) + can produce this output by writing to `$BUILDER_OUTPUT/output`. Only + the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` + variable is read-only and can't be substituted. type: array + ProjectRepoId: + type: object + id: ProjectRepoId + properties: + repoName: + type: string + description: The name of the repo. Leave empty for the default repo. + projectId: + type: string + description: The ID of the project. + description: >- + Selects a repo using a Google Cloud Platform project ID (e.g., + winged-cargo-31) and a repo name within that project. + KnowledgeBase: + type: object + properties: + name: + description: The KB name (generally of the form KB[0-9]+ (e.g., KB123456)). + type: string + url: + type: string description: >- - List of volumes to mount into the build step. Each volume is created - as an empty volume prior to execution of the build step. Upon - completion of the build, volumes and their contents are discarded. - Using a named volume in only one step is not valid as it is - indicative of a build request with an incorrect configuration. - items: - $ref: '#/components/schemas/Volume' - env: + A link to the KB in the [Windows update catalog] + (https://www.catalog.update.microsoft.com/). + id: KnowledgeBase + GetIamPolicyRequest: + id: GetIamPolicyRequest + type: object + description: Request message for `GetIamPolicy` method. + properties: + options: description: >- - A list of environment variable definitions to be used when running a - step. The elements are of the form "KEY=VALUE" for the environment - variable "KEY" being given the value "VALUE". - items: - type: string - type: array - allowFailure: + OPTIONAL: A `GetPolicyOptions` object for specifying options to + `GetIamPolicy`. + $ref: '#/components/schemas/GetPolicyOptions' + UpgradeOccurrence: + type: object + id: UpgradeOccurrence + description: >- + An Upgrade Occurrence represents that a specific resource_url could + install a specific upgrade. This presence is supplied via local sources + (i.e. it is present in the mirror and the running system has noticed its + availability). For Windows, both distribution and windows_update contain + information for the Windows update. + properties: + windowsUpdate: description: >- - Allow this build step to fail without failing the entire build. If - false, the entire build will fail if this step fails. Otherwise, the - build will succeed, but this step will still have a failure status. - Error information will be reported in the failure_detail field. - type: boolean - name: + Required for Windows OS. Represents the metadata about the Windows + update. + $ref: '#/components/schemas/WindowsUpdate' + parsedVersion: + $ref: '#/components/schemas/Version' description: >- - Required. The name of the container image that will run this - particular build step. If the image is available in the host's - Docker daemon's cache, it will be run directly. If not, the host - will attempt to pull the image first, using the builder service - account's credentials if necessary. The Docker daemon's cache will - already have the latest versions of all of the officially supported - build steps - ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). - The Docker daemon will also have cached many of the layers for some - popular images, like "ubuntu", "debian", but they will be refreshed - at the time you attempt to use them. If you built an image in a - previous build step, it will be stored in the host's Docker daemon's - cache and is available to use as the name for a later build step. + Required for non-Windows OS. The version of the package in a machine + + human readable form. + package: type: string - status: + description: Required for non-Windows OS. The package this Upgrade is for. + distribution: + description: >- + Metadata about the upgrade for available for the specific operating + system for the resource_url. This allows efficient filtering, as + well as making it easier to use the occurrence. + $ref: '#/components/schemas/UpgradeDistribution' + BuildProvenance: + id: BuildProvenance + type: object + properties: + createTime: + description: Time at which the build was created. + type: string + format: google-datetime + endTime: + format: google-datetime + type: string + description: Time at which execution of the build was finished. + creator: type: string - enum: - - STATUS_UNKNOWN - - PENDING - - QUEUING - - QUEUED - - WORKING - - SUCCESS - - FAILURE - - INTERNAL_ERROR - - TIMEOUT - - CANCELLED - - EXPIRED - enumDescriptions: - - Status of the build is unknown. - - >- - Build has been created and is pending execution and queuing. It - has not been queued. - - Build has been received and is being queued. - - Build or step is queued; work has not yet begun. - - Build or step is being executed. - - Build or step finished successfully. - - Build or step failed to complete successfully. - - Build or step failed due to an internal cause. - - Build or step took longer than was allowed. - - Build or step was canceled by a user. - - Build was enqueued for longer than the value of `queue_ttl`. description: >- - Output only. Status of the build step. At this time, build step - status is only updated on build completion; step status is not - updated in real-time as the build progresses. + E-mail address of the user who initiated this build. Note that this + was the user's e-mail address at the time the build was initiated; + this address may not represent the same end-user for all time. id: - description: >- - Unique identifier for this build step, used in `wait_for` to - reference this build step as a dependency. type: string - timing: - $ref: '#/components/schemas/TimeSpan' - description: >- - Output only. Stores timing information for executing this build - step. - timeout: + description: Required. Unique identifier of the build. + projectId: + description: ID of the project. type: string - description: >- - Time limit for executing this build step. If not defined, the step - has no time limit and will be allowed to continue to run until - either it completes or the build itself times out. - format: google-duration - waitFor: + commands: items: - type: string + $ref: '#/components/schemas/Command' + type: array + description: Commands requested by the build. + startTime: + type: string + description: Time at which execution of the build was started. + format: google-datetime + builderVersion: + description: Version string of the builder at the time this build was executed. + type: string + logsUri: + type: string + description: URI where any logs for this provenance were written. + triggerId: + type: string description: >- - The ID(s) of the step(s) that this build step depends on. This build - step will not start until all the build steps in `wait_for` have - completed successfully. If `wait_for` is empty, this build step will - start when all previous build steps in the `Build.Steps` list have - completed successfully. + Trigger identifier if the build was triggered automatically; empty + if not. + buildOptions: + type: object + description: >- + Special options applied to this build. This is a catch-all field + where build providers can enter any desired additional details. + additionalProperties: + type: string + builtArtifacts: + description: Output of the build. type: array - secretEnv: + items: + $ref: '#/components/schemas/Artifact' + sourceProvenance: + $ref: '#/components/schemas/Source' + description: Details of the Source input to the build. + description: >- + Provenance of a build. Contains all information needed to verify the + full details about the build from source to completion. + Fingerprint: + description: A set of properties that uniquely identify a given Docker image. + type: object + properties: + v2Name: + type: string + description: >- + Output only. The name of the image's v2 blobs computed via: [bottom] + := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the + name of the final blob is kept. + v1Name: + description: >- + Required. The layer ID of the final layer in the Docker image's v1 + representation. + type: string + v2Blob: type: array + description: Required. The ordered list of v2 blobs that represent a given image. items: type: string + id: Fingerprint + SbomReferenceIntotoPayload: + description: >- + The actual payload that contains the SBOM Reference data. The payload + follows the intoto statement specification. See + https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md + for more details. + properties: + predicate: + $ref: '#/components/schemas/SbomReferenceIntotoPredicate' description: >- - A list of environment variables which are encrypted using a Cloud - Key Management Service crypto key. These values must be specified in - the build's `Secret`. - args: + Additional parameters of the Predicate. Includes the actual data + about the SBOM. + subject: items: - type: string + $ref: '#/components/schemas/Subject' description: >- - A list of arguments that will be presented to the step when it is - started. If the image used to run the step's container has an - entrypoint, the `args` are used as arguments to that entrypoint. If - the image does not define an entrypoint, the first element in args - is used as the entrypoint, and the remainder will be used as - arguments. + Set of software artifacts that the attestation applies to. Each + element represents a single software artifact. type: array - dir: + predicateType: type: string - description: >- - Working directory to use when running this step's container. If this - value is a relative path, it is relative to the build's working - directory. If this value is absolute, it may be outside the build's - working directory, in which case the contents of the path may not be - persisted across build step executions, unless a `volume` for that - path is specified. If the build specifies a `RepoSource` with `dir` - and a step with a `dir`, which specifies an absolute path, the - `RepoSource` `dir` is ignored for the step's execution. - script: - type: string - description: >- - A shell script to be executed in the step. When script is provided, - the user cannot specify the entrypoint or args. - entrypoint: - type: string - description: >- - Entrypoint to be used instead of the build step image's default - entrypoint. If unset, the image's default entrypoint is used. - automapSubstitutions: - type: boolean - description: >- - Option to include built-in and custom substitutions as env variables - for this build step. This option will override the global option in - BuildOption. - id: BuildStep - description: 'A step in the build pipeline. Next ID: 21' - ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes - type: object - description: >- - Container message for hashes of byte content of files, used in - SourceProvenance messages to verify integrity of source input to the - build. - properties: - fileHash: - description: Collection of file hashes. - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1Hash - GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder - properties: - id: - type: string - type: object - description: >- - Identifies the entity that executed the recipe, which is trusted to have - correctly performed the operation and populated this provenance. - SBOMStatus: - id: SBOMStatus - properties: - sbomState: - enum: - - SBOM_STATE_UNSPECIFIED - - PENDING - - COMPLETE - enumDescriptions: - - Default unknown state. - - SBOM scanning is pending. - - SBOM scanning has completed. - type: string - description: The progress of the SBOM generation. - error: - description: >- - If there was an error generating an SBOM, this will indicate what - that error was. - type: string - type: object - description: The status of an SBOM generation. - GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaCompleteness - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - type: object - properties: - parameters: - type: boolean - materials: - type: boolean - environment: - type: boolean - BuildDefinition: - properties: - internalParameters: - additionalProperties: - description: Properties of the object. - type: any - type: object - externalParameters: - additionalProperties: - type: any - description: Properties of the object. - type: object - buildType: - type: string - resolvedDependencies: - type: array - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: object - id: BuildDefinition - Remediation: - description: >- - Specifies details on how to handle (and presumably, fix) a - vulnerability. - type: object - properties: - details: - type: string - description: >- - Contains a comprehensive human-readable discussion of the - remediation. - remediationUri: - $ref: '#/components/schemas/RelatedUrl' - description: Contains the URL where to obtain the remediation. - remediationType: - description: The type of remediation that can be applied. - enum: - - REMEDIATION_TYPE_UNSPECIFIED - - MITIGATION - - NO_FIX_PLANNED - - NONE_AVAILABLE - - VENDOR_FIX - - WORKAROUND + description: URI identifying the type of the Predicate. + _type: type: string - enumDescriptions: - - No remediation type specified. - - A MITIGATION is available. - - No fix is planned. - - Not available. - - A vendor fix is available. - - A workaround is available. - id: Remediation - ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: + description: Identifier for the schema of the Statement. type: object - description: A Maven artifact uploaded using the MavenArtifact directive. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact + id: SbomReferenceIntotoPayload + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage + description: Artifact uploaded using the PythonPackage directive. properties: uri: description: URI of the uploaded artifact. type: string fileHashes: - description: Hash types and values of the Maven Artifact. $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: Hash types and values of the Python Artifact. pushTiming: + description: >- + Output only. Stores timing information for pushing the specified + artifact. $ref: >- #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan readOnly: true + type: object + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage + type: object + properties: + pushTiming: description: >- Output only. Stores timing information for pushing the specified artifact. - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: - properties: - repository: - description: >- - Artifact Registry repository, in the form - "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the - workspace matching any path pattern will be uploaded to Artifact - Registry with this location as a prefix. + readOnly: true + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + fileHashes: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: Hash types and values of the npm package. + uri: type: string - paths: - description: >- - Path globs used to match files in the build's workspace. For Python/ - Twine, this is usually `dist/*`, and sometimes additionally an - `.asc` file. - type: array - items: - type: string + description: URI of the uploaded npm package. description: >- - Python package to upload to Artifact Registry upon successful completion - of all build steps. A package can encapsulate multiple objects to be - uploaded to a single repository. - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage - ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: + An npm package uploaded to Artifact Registry using the NpmPackage + directive. + UpgradeDistribution: + description: >- + The Upgrade Distribution represents metadata about the Upgrade for each + operating system (CPE). Some distributions have additional metadata + around updates, classifying them into various categories and severities. + id: UpgradeDistribution type: object properties: - secretManager: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - type: array + cpeUri: + type: string description: >- - Secrets in Secret Manager and associated secret environment - variable. - inline: + Required - The specific operating system this metadata applies to. + See https://cpe.mitre.org/specification/. + classification: description: >- - Secrets encrypted with KMS key and the associated secret environment - variable. + The operating system classification of this Upgrade, as specified by + the upstream operating system upgrade feed. For Windows the + classification is one of the category_ids listed at + https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85) + type: string + cve: + description: The cve tied to this Upgrade. items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret + type: string type: array - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets - description: Secrets and secret environment variables. - SBOMReferenceNote: - type: object - properties: - version: - description: >- - The version of the format that the SBOM takes. E.g. if the format is - spdx, the version may be 2.3. - type: string - format: - description: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc... + severity: type: string - description: The note representing an SBOM reference. - id: SBOMReferenceNote - ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig: - type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - description: ApprovalConfig describes configuration for manual approval of a build. - properties: - approvalRequired: - description: >- - Whether or not approval is needed. If this is set on a build, it - will become pending when created, and will need to be explicitly - approved to start. - type: boolean - Location: - description: >- - An occurrence of a particular package installation found within a - system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. + description: The severity as specified by the upstream operating system. + DSSEHint: + id: DSSEHint properties: - version: - $ref: '#/components/schemas/Version' - description: Deprecated. The version installed at this location. - path: + humanReadableName: type: string description: >- - The path from which we gathered that this package/version is - installed. - cpeUri: - type: string - description: >- - Deprecated. The CPE URI in [CPE - format](https://cpe.mitre.org/specification/) - type: object - id: Location - BatchCreateOccurrencesResponse: - id: BatchCreateOccurrencesResponse - description: Response for creating occurrences in batch. + Required. The human readable name of this attestation authority, for + example "cloudbuild-prod". type: object - properties: - occurrences: - type: array - items: - $ref: '#/components/schemas/Occurrence' - description: The occurrences that were created. - Subject: - id: Subject + description: >- + This submessage provides human-readable hints about the purpose of the + authority. Because the name of a note acts as its resource reference, it + is important to disambiguate the canonical name of the Note (which might + be a UUID for security purposes) from "readable" names more suitable for + debug output. Note that these hints should not be used to look up + authorities in security sensitive contexts, such as when looking up + attestations to verify. + WindowsDetail: + id: WindowsDetail type: object properties: - digest: - type: object + description: + type: string + description: The description of this vulnerability. + cpeUri: + type: string description: >- - `"": ""` Algorithms can be e.g. sha256, sha512 See - https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet - additionalProperties: - type: string + Required. The [CPE URI](https://cpe.mitre.org/specification/) this + vulnerability affects. + fixingKbs: + description: >- + Required. The names of the KBs which have hotfixes to mitigate this + vulnerability. Note that there may be multiple hotfixes (and thus + multiple KBs) that mitigate a given vulnerability. Currently any + listed KBs presence is considered a fix. + items: + $ref: '#/components/schemas/KnowledgeBase' + type: array name: + description: Required. The name of this vulnerability. type: string - ComplianceOccurrence: - type: object + SlsaProvenanceZeroTwo: + id: SlsaProvenanceZeroTwo properties: - nonCompliantFiles: - type: array + builder: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder' + buildType: + type: string + invocation: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation' + buildConfig: + additionalProperties: + description: Properties of the object. + type: any + type: object + materials: items: - $ref: '#/components/schemas/NonCompliantFile' - version: - $ref: '#/components/schemas/ComplianceVersion' - description: The OS and config version the benchmark was run on. - nonComplianceReason: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMaterial' + type: array + metadata: + $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaMetadata' + description: See full explanation of fields at slsa.dev/provenance/v0.2. + type: object + CloudRepoSourceContext: + id: CloudRepoSourceContext + properties: + aliasContext: + description: An alias, which may be a branch or tag. + $ref: '#/components/schemas/AliasContext' + repoId: + $ref: '#/components/schemas/RepoId' + description: The ID of the repo. + revisionId: type: string - id: ComplianceOccurrence - description: >- - An indication that the compliance checks in the associated - ComplianceNote were not satisfied for particular resources or a - specified reason. - ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + description: A revision ID. type: object description: >- - A Maven artifact to upload to Artifact Registry upon successful - completion of all build steps. + A CloudRepoSourceContext denotes a particular revision in a Google Cloud + Source Repo. + VulnerabilityOccurrence: + description: An occurrence of a severity vulnerability on a resource. + type: object properties: - groupId: + vexAssessment: + $ref: '#/components/schemas/VexAssessment' + effectiveSeverity: + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL type: string description: >- - Maven `groupId` value used when uploading the artifact to Artifact - Registry. - repository: + The distro assigned severity for this vulnerability when it is + available, otherwise this is the note provider assigned severity. + When there are multiple PackageIssues for this vulnerability, they + can have different effective severities because some might be + provided by the distro while others are provided by the language + ecosystem for a language pack. For this reason, it is advised to use + the effective severity on the PackageIssue level. In the case where + multiple PackageIssues have differing effective severities, this + field should be the highest severity for any of the PackageIssues. + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + packageIssue: description: >- - Artifact Registry repository, in the form - "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the - workspace specified by path will be uploaded to Artifact Registry - with this location as a prefix. - type: string - path: + Required. The set of affected locations and their fixes (if + available) within the associated resource. + type: array + items: + $ref: '#/components/schemas/PackageIssue' + fixAvailable: + type: boolean description: >- - Path to an artifact in the build's workspace to be uploaded to - Artifact Registry. This can be either an absolute path, e.g. - /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path - from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + Output only. Whether at least one of the affected packages has a fix + available. + cvssScore: + format: float + description: >- + Output only. The CVSS score of this vulnerability. CVSS score is on + a scale of 0 - 10 where 0 indicates low severity and 10 indicates + high severity. + type: number + type: + description: >- + The type of package; whether native or non native (e.g., ruby gems, + node.js packages, etc.). type: string - artifactId: + relatedUrls: + items: + $ref: '#/components/schemas/RelatedUrl' + type: array + description: Output only. URLs related to this vulnerability. + cvssVersion: + enumDescriptions: + - '' + - '' + - '' + description: Output only. CVSS version used to populate cvss_score and severity. + enum: + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 type: string - description: >- - Maven `artifactId` value used when uploading the artifact to - Artifact Registry. - version: + severity: + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL type: string + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. description: >- - Maven `version` value used when uploading the artifact to Artifact - Registry. - SlsaCompleteness: + Output only. The note provider assigned severity of this + vulnerability. + shortDescription: + type: string + description: Output only. A one sentence description of this vulnerability. + longDescription: + description: Output only. A detailed description of this vulnerability. + type: string + cvssV2: + $ref: '#/components/schemas/CVSS' + description: The cvss v2 score for the vulnerability. + extraDetails: + type: string + description: Occurrence-specific extra details about the vulnerability. + cvssv3: + $ref: '#/components/schemas/CVSS' + description: The cvss v3 score for the vulnerability. + id: VulnerabilityOccurrence + VulnerabilityNote: + description: A security vulnerability that can be found in resources. + id: VulnerabilityNote + type: object properties: - environment: - description: >- - If true, the builder claims that recipe.environment is claimed to be - complete. - type: boolean - materials: - type: boolean + windowsDetails: + type: array + items: + $ref: '#/components/schemas/WindowsDetail' description: >- - If true, the builder claims that materials are complete, usually - through some controls to prevent network access. Sometimes called - "hermetic". - arguments: - type: boolean + Windows details get their own format because the information format + and model don't match a normal detail. Specifically Windows updates + are done as patches, thus Windows vulnerabilities really are a + missing package, rather than a package being at an incorrect + version. + details: + type: array description: >- - If true, the builder claims that recipe.arguments is complete, - meaning that all external inputs are properly captured in the - recipe. - type: object - description: >- - Indicates that the builder claims certain fields in this message to be - complete. - id: SlsaCompleteness - SlsaProvenanceV1: - type: object - id: SlsaProvenanceV1 - description: >- - Keep in sync with schema at - https://github.com/slsa-framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto - Builder renamed to ProvenanceBuilder because of Java conflicts. - properties: - runDetails: - $ref: '#/components/schemas/RunDetails' - buildDefinition: - $ref: '#/components/schemas/BuildDefinition' - ContaineranalysisGoogleDevtoolsCloudbuildV1Source: - type: object - description: Location of the source in a supported storage service. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source - properties: - gitSource: - description: If provided, get the source from this Git repository. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - repoSource: - description: >- - If provided, get the source from this location in a Cloud Source - Repository. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource - storageSource: - description: If provided, get the source from this location in Cloud Storage. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource - connectedRepository: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository + Details of all known distros and packages affected by this + vulnerability. + items: + $ref: '#/components/schemas/Detail' + cvssScore: description: >- - Optional. If provided, get the source from this 2nd-gen Google Cloud - Build repository resource. - storageSourceManifest: + The CVSS score of this vulnerability. CVSS score is on a scale of 0 + - 10 where 0 indicates low severity and 10 indicates high severity. + type: number + format: float + cvssVersion: + enumDescriptions: + - '' + - '' + - '' + type: string + enum: + - CVSS_VERSION_UNSPECIFIED + - CVSS_VERSION_2 + - CVSS_VERSION_3 + description: CVSS version used to populate cvss_score and severity. + cvssV2: + description: The full description of the v2 CVSS for this vulnerability. + $ref: '#/components/schemas/CVSS' + sourceUpdateTime: + type: string + format: google-datetime description: >- - If provided, get the source from this manifest in Cloud Storage. - This feature is in Preview; see description - [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest - developerConnectConfig: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig - description: If provided, get the source from this Developer Connect config. - WindowsUpdate: - description: >- - Windows Update represents the metadata about the update for the Windows - operating system. The fields in this message come from the Windows - Update API documented at - https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. - id: WindowsUpdate + The time this information was last changed at the source. This is an + upstream timestamp from the underlying information source - e.g. + Ubuntu security tracker. + cvssV3: + $ref: '#/components/schemas/CVSSv3' + description: The full description of the CVSSv3 for this vulnerability. + severity: + description: The note provider assigned severity of this vulnerability. + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts type: object properties: - identity: - description: Required - The unique identifier for the update. - $ref: '#/components/schemas/Identity' - kbArticleIds: + mavenArtifacts: + type: array + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact + description: >- + A list of Maven artifacts to be uploaded to Artifact Registry upon + successful completion of all build steps. Artifacts in the workspace + matching specified paths globs will be uploaded to the specified + Artifact Registry repository using the builder service account's + credentials. If any artifacts fail to be pushed, the build is marked + FAILURE. + images: + description: >- + A list of images to be pushed upon the successful completion of all + build steps. The images will be pushed using the builder service + account's credentials. The digests of the pushed images will be + stored in the Build resource's results field. If any of the images + fail to be pushed, the build is marked FAILURE. type: array items: type: string + npmPackages: description: >- - The Microsoft Knowledge Base article IDs that are associated with - the update. - categories: + A list of npm packages to be uploaded to Artifact Registry upon + successful completion of all build steps. Npm packages in the + specified paths will be uploaded to the specified Artifact Registry + repository using the builder service account's credentials. If any + packages fail to be pushed, the build is marked FAILURE. + items: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage type: array - description: The list of categories to which the update belongs. + pythonPackages: + type: array + description: >- + A list of Python packages to be uploaded to Artifact Registry upon + successful completion of all build steps. The build service account + credentials will be used to perform the upload. If any objects fail + to be pushed, the build is marked FAILURE. items: - $ref: '#/components/schemas/Category' - description: - description: The localized description of the update. - type: string - supportUrl: - type: string - description: The hyperlink to the support information for the update. - lastPublishedTimestamp: - type: string - description: The last published timestamp of the update. - format: google-datetime - title: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + objects: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + description: >- + A list of objects to be uploaded to Cloud Storage upon successful + completion of all build steps. Files in the workspace matching + specified paths globs will be uploaded to the specified Cloud + Storage location using the builder service account's credentials. + The location and generation of the uploaded objects will be stored + in the Build resource's results field. If any objects fail to be + pushed, the build is marked FAILURE. + description: >- + Artifacts produced by a build that should be uploaded upon successful + completion of all build steps. + CisBenchmark: + properties: + profileLevel: + type: integer + format: int32 + severity: + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL type: string - description: The localized title of the update. - RunDetails: type: object - id: RunDetails - properties: - byproducts: - items: - $ref: '#/components/schemas/ResourceDescriptor' - type: array - builder: - $ref: '#/components/schemas/ProvenanceBuilder' - metadata: - $ref: '#/components/schemas/BuildMetadata' - License: + id: CisBenchmark + description: A compliance check that is a CIS benchmark. + ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository: + description: >- + Location of the source in a 2nd-gen Google Cloud Build repository + resource. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository properties: - comments: - description: Comments + dir: type: string - expression: + description: >- + Optional. Directory, relative to the source root, in which to run + the build. + revision: type: string description: >- - Often a single license can be used to represent the licensing terms. - Sometimes it is necessary to include a choice of one or more - licenses or some combination of license identifiers. Examples: - "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later - WITH Bison-exception-2.2". - description: License information. - id: License + Required. The revision to fetch from the Git repository such as a + branch, a tag, a commit SHA, or any Git ref. + repository: + type: string + description: >- + Required. Name of the Google Cloud Build repository, formatted as + `projects/*/locations/*/connections/*/repositories/*`. type: object - Occurrence: + EnvelopeSignature: type: object properties: - createTime: - format: google-datetime + keyid: type: string - description: Output only. The time this occurrence was created. - vulnerability: - $ref: '#/components/schemas/VulnerabilityOccurrence' - description: Describes a security vulnerability. - noteName: + sig: + format: byte type: string - description: >- - Required. Immutable. The analysis note associated with this - occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - This field can be used as a filter in list requests. - remediation: - description: A description of actions that can be taken to remedy the note. - type: string - image: - $ref: '#/components/schemas/ImageOccurrence' - description: >- - Describes how this resource derives from the basis in the associated - note. - discovery: - $ref: '#/components/schemas/DiscoveryOccurrence' - description: Describes when a resource was discovered. - updateTime: - description: Output only. The time this occurrence was last updated. - type: string - format: google-datetime - dsseAttestation: - description: Describes an attestation of an artifact using dsse. - $ref: '#/components/schemas/DSSEAttestationOccurrence' - name: - type: string - description: >- - Output only. The name of the occurrence in the form of - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. - deployment: - $ref: '#/components/schemas/DeploymentOccurrence' - description: Describes the deployment of an artifact on a runtime. - resourceUri: - description: >- - Required. Immutable. A URI that represents the resource for which - the occurrence applies. For example, - `https://gcr.io/project/image@sha256:123abc` for a Docker image. - type: string - attestation: - description: Describes an attestation of an artifact. - $ref: '#/components/schemas/AttestationOccurrence' - kind: - enumDescriptions: - - Default value. This value is unused. - - The note and occurrence represent a package vulnerability. - - The note and occurrence assert build provenance. - - This represents an image basis relationship. - - This represents a package installed via a package manager. - - The note and occurrence track deployment events. - - >- - The note and occurrence track the initial discovery status of a - resource. - - This represents a logical "role" that can attest to artifacts. - - This represents an available package upgrade. - - This represents a Compliance Note - - This represents a DSSE attestation Note - - This represents a Vulnerability Assessment. - - This represents an SBOM Reference. - type: string - description: >- - Output only. This explicitly denotes which of the occurrence details - are specified. This field can be used as a filter in list requests. - enum: - - NOTE_KIND_UNSPECIFIED - - VULNERABILITY - - BUILD - - IMAGE - - PACKAGE - - DEPLOYMENT - - DISCOVERY - - ATTESTATION - - UPGRADE - - COMPLIANCE - - DSSE_ATTESTATION - - VULNERABILITY_ASSESSMENT - - SBOM_REFERENCE - compliance: - $ref: '#/components/schemas/ComplianceOccurrence' - description: Describes a compliance violation on a linked resource. - upgrade: - $ref: '#/components/schemas/UpgradeOccurrence' - description: Describes an available package upgrade on the linked resource. - package: - $ref: '#/components/schemas/PackageOccurrence' - description: Describes the installation of a package on the linked resource. - build: - $ref: '#/components/schemas/BuildOccurrence' - description: Describes a verifiable build. - envelope: - $ref: '#/components/schemas/Envelope' - description: https://github.com/secure-systems-lab/dsse - sbomReference: - description: Describes a specific SBOM reference occurrences. - $ref: '#/components/schemas/SBOMReferenceOccurrence' - description: An instance of an analysis type that has been found on a resource. - id: Occurrence - ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts - type: object + id: EnvelopeSignature + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects: description: >- - Artifacts produced by a build that should be uploaded upon successful + Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. properties: - pythonPackages: - type: array - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + timing: description: >- - A list of Python packages to be uploaded to Artifact Registry upon - successful completion of all build steps. The build service account - credentials will be used to perform the upload. If any objects fail - to be pushed, the build is marked FAILURE. - images: - type: array + Output only. Stores timing information for pushing all artifact + objects. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + location: + type: string description: >- - A list of images to be pushed upon the successful completion of all - build steps. The images will be pushed using the builder service - account's credentials. The digests of the pushed images will be - stored in the Build resource's results field. If any of the images - fail to be pushed, the build is marked FAILURE. + Cloud Storage bucket and optional object path, in the form + "gs://bucket/path/to/somewhere/". (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + Files in the workspace matching any path pattern will be uploaded to + Cloud Storage with this location as a prefix. + paths: items: type: string - npmPackages: + description: Path globs used to match files in the build's workspace. type: array - description: >- - A list of npm packages to be uploaded to Artifact Registry upon - successful completion of all build steps. Npm packages in the - specified paths will be uploaded to the specified Artifact Registry - repository using the builder service account's credentials. If any - packages fail to be pushed, the build is marked FAILURE. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage - objects: - description: >- - A list of objects to be uploaded to Cloud Storage upon successful - completion of all build steps. Files in the workspace matching - specified paths globs will be uploaded to the specified Cloud - Storage location using the builder service account's credentials. - The location and generation of the uploaded objects will be stored - in the Build resource's results field. If any objects fail to be - pushed, the build is marked FAILURE. + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects + ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig: + properties: + http: + description: Configuration for HTTP related git operations. $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects - mavenArtifacts: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact - type: array - description: >- - A list of Maven artifacts to be uploaded to Artifact Registry upon - successful completion of all build steps. Artifacts in the workspace - matching specified paths globs will be uploaded to the specified - Artifact Registry repository using the builder service account's - credentials. If any artifacts fail to be pushed, the build is marked - FAILURE. - GrafeasV1FileLocation: - description: Indicates the location at which a package was found. + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig + description: GitConfig is a configuration for git operations. type: object - id: GrafeasV1FileLocation + id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig + ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact properties: - filePath: + pushTiming: description: >- - For jars that are contained inside .war files, this filepath can - indicate the path to war file combined with the path to jar file. + Output only. Stores timing information for pushing the specified + artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + readOnly: true + uri: + description: URI of the uploaded artifact. type: string - CVSSv3: - description: >- - Common Vulnerability Scoring System version 3. For details, see - https://www.first.org/cvss/specification-document + fileHashes: + description: Hash types and values of the Maven Artifact. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes + description: A Maven artifact uploaded using the MavenArtifact directive. + type: object + ListNoteOccurrencesResponse: + id: ListNoteOccurrencesResponse + type: object properties: - confidentialityImpact: + occurrences: + items: + $ref: '#/components/schemas/Occurrence' + description: The occurrences attached to the specified note. + type: array + nextPageToken: type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - enumDescriptions: - - '' - - '' - - '' - - '' - exploitabilityScore: - type: number - format: float - integrityImpact: - enumDescriptions: - - '' - - '' - - '' - - '' + description: Token to provide to skip to a particular spot in the list. + description: Response for listing occurrences for a note. + ComplianceNote: + id: ComplianceNote + type: object + properties: + impact: type: string - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - userInteraction: + remediation: type: string - enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - enumDescriptions: - - '' - - '' - - '' - attackComplexity: - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH + description: A description of remediation steps if the compliance check fails. + rationale: + description: A rationale for the existence of this compliance check. type: string - enumDescriptions: - - '' - - '' - - '' - availabilityImpact: - enum: - - IMPACT_UNSPECIFIED - - IMPACT_HIGH - - IMPACT_LOW - - IMPACT_NONE - enumDescriptions: - - '' - - '' - - '' - - '' + cisBenchmark: + $ref: '#/components/schemas/CisBenchmark' + version: + items: + $ref: '#/components/schemas/ComplianceVersion' + description: The OS and config versions the benchmark applies to. + type: array + scanInstructions: type: string - impactScore: - format: float - type: number - privilegesRequired: - enumDescriptions: - - '' - - '' - - '' - - '' + format: byte + description: Serialized scan instructions with a predefined format. + title: type: string - enum: - - PRIVILEGES_REQUIRED_UNSPECIFIED - - PRIVILEGES_REQUIRED_NONE - - PRIVILEGES_REQUIRED_LOW - - PRIVILEGES_REQUIRED_HIGH - attackVector: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' + description: The title that identifies this compliance check. + description: + type: string + description: A description about this compliance check. + ListNotesResponse: + type: object + description: Response for listing notes. + id: ListNotesResponse + properties: + notes: + type: array + items: + $ref: '#/components/schemas/Note' + description: The notes requested. + nextPageToken: type: string description: >- - Base Metrics Represents the intrinsic characteristics of a - vulnerability that are constant over time and across user - environments. - enum: - - ATTACK_VECTOR_UNSPECIFIED - - ATTACK_VECTOR_NETWORK - - ATTACK_VECTOR_ADJACENT - - ATTACK_VECTOR_LOCAL - - ATTACK_VECTOR_PHYSICAL - baseScore: - type: number - description: The base score is a function of the base metric scores. - format: float - scope: + The next pagination token in the list response. It should be used as + `page_token` for the following request. An empty value means no more + results. + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage: + type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage + description: >- + Python package to upload to Artifact Registry upon successful completion + of all build steps. A package can encapsulate multiple objects to be + uploaded to a single repository. + properties: + repository: + description: >- + Artifact Registry repository, in the form + "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the + workspace matching any path pattern will be uploaded to Artifact + Registry with this location as a prefix. type: string - enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED - enumDescriptions: - - '' - - '' - - '' + paths: + type: array + description: >- + Path globs used to match files in the build's workspace. For Python/ + Twine, this is usually `dist/*`, and sometimes additionally an + `.asc` file. + items: + type: string + SlsaRecipe: + description: >- + Steps taken to build the artifact. For a TaskRun, typically each + container corresponds to one step in the recipe. + properties: + type: + description: >- + URI indicating what type of recipe was performed. It determines the + meaning of recipe.entryPoint, recipe.arguments, recipe.environment, + and materials. + type: string + arguments: + type: object + description: >- + Collection of all external inputs that influenced the build on top + of recipe.definedInMaterial and recipe.entryPoint. For example, if + the recipe type were "make", then this might be the flags passed to + make aside from the target, which is captured in recipe.entryPoint. + Depending on the recipe Type, the structure may be different. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + definedInMaterial: + description: >- + Index in materials containing the recipe steps that are not implied + by recipe.type. For example, if the recipe type were "make", then + this would point to the source containing the Makefile, not the make + program itself. Set to -1 if the recipe doesn't come from a + material, as zero is default unset value for int64. + type: string + format: int64 + entryPoint: + description: >- + String identifying the entry point into the build. This is often a + path to a configuration file and/or a target label within that file. + The syntax and meaning are defined by recipe.type. For example, if + the recipe type were "make", then this would reference the directory + in which to run make as well as which target to use. + type: string + environment: + description: >- + Any other builder-controlled inputs necessary for correctly + evaluating the recipe. Usually only needed for reproducing the build + but not evaluated as part of policy. Depending on the recipe Type, + the structure may be different. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: object - id: CVSSv3 - PackageNote: + id: SlsaRecipe + BuildNote: + type: object + id: BuildNote + description: >- + Note holding the version of the provider's builder and the signature of + the provenance message in the build details occurrence. properties: - license: - description: Licenses that have been declared by the authors of the package. - $ref: '#/components/schemas/License' - maintainer: - description: A freeform text denoting the maintainer of this package. + builderVersion: type: string - digest: + description: >- + Required. Immutable. Version of the builder which produced this + build. + PackageOccurrence: + description: Details on how a particular software package was installed on a system. + type: object + id: PackageOccurrence + properties: + location: items: - $ref: '#/components/schemas/Digest' + $ref: '#/components/schemas/Location' description: >- - Hash value, typically a file digest, that allows unique - identification a specific package. + All of the places within the filesystem versions of this package + have been found. type: array - description: - type: string - description: The description of this package. version: + description: Output only. The version of the package. + readOnly: true $ref: '#/components/schemas/Version' - description: The version of the package. + packageType: + readOnly: true + type: string + description: >- + Output only. The type of package; whether native or non native + (e.g., ruby gems, node.js packages, etc.). architecture: enum: - ARCHITECTURE_UNSPECIFIED - X86 - X64 - type: string description: >- - The CPU architecture for which packages in this distribution channel - were built. Architecture will be blank for language packages. + Output only. The CPU architecture for which packages in this + distribution channel were built. Architecture will be blank for + language packages. + type: string + readOnly: true enumDescriptions: - Unknown architecture. - X86 architecture. - X64 architecture. - distribution: - items: - $ref: '#/components/schemas/Distribution' - type: array - description: Deprecated. The various channels by which a package is distributed. cpeUri: - type: string description: >- - The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) - denoting the package manager version distributing a package. The - cpe_uri will be blank for language packages. + Output only. The cpe_uri in [CPE + format](https://cpe.mitre.org/specification/) denoting the package + manager version distributing a package. The cpe_uri will be blank + for language packages. + readOnly: true + type: string name: type: string - description: Required. Immutable. The name of the package. - packageType: - description: >- - The type of package; whether native or non native (e.g., ruby gems, - node.js packages, etc.). + description: Required. Output only. The name of the installed package. + readOnly: true + license: + description: Licenses that have been declared by the authors of the package. + $ref: '#/components/schemas/License' + ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan: + description: Start and end times for a build execution phase. + type: object + properties: + startTime: + format: google-datetime + description: Start of time span. type: string - url: - description: The homepage for this package. + endTime: + description: End of time span. type: string - id: PackageNote - type: object - description: PackageNote represents a particular package version. - Expr: - id: Expr + format: google-datetime + id: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource properties: - location: + generation: type: string description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - title: + Optional. Cloud Storage generation for the object. If the generation + is omitted, the latest generation will be used. + format: int64 + object: description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + Required. Cloud Storage object containing the source. This object + must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) + containing source to build. type: string - description: + bucket: type: string description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - 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. - type: object - ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval: - description: >- - BuildApproval describes a build's approval configuration, state, and - result. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval - properties: - config: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig - description: Output only. Configuration for manual approval of this build. - readOnly: true - state: - description: Output only. The state of this build's approval. - enum: - - STATE_UNSPECIFIED - - PENDING - - APPROVED - - REJECTED - - CANCELLED + Cloud Storage bucket containing the source (see [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + sourceFetcher: type: string - readOnly: true + enum: + - SOURCE_FETCHER_UNSPECIFIED + - GSUTIL + - GCS_FETCHER + description: >- + Optional. Option to specify the tool to fetch the source file for + the build. enumDescriptions: - - Default enum type. This should not be used. - - Build approval is pending. - - Build approval has been approved. - - Build approval has been rejected. - - Build was cancelled while it was still pending approval. - result: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult - description: Output only. Result of manual approval for this Build. - readOnly: true + - Unspecified defaults to GSUTIL. + - Use the "gsutil" tool to download the source file. + - Use the Cloud Storage Fetcher tool to download the source file. type: object - GitSourceContext: + description: Location of the source in an archive file in Cloud Storage. + ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource: type: object + description: Location of the source in a Google Cloud Source Repository. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource properties: - revisionId: - description: Git commit hash. + projectId: type: string - url: + description: >- + Optional. ID of the project that owns the Cloud Source Repository. + If omitted, the project ID requesting the build is assumed. + repoName: + description: Required. Name of the Cloud Source Repository. type: string - description: Git repository URL. - id: GitSourceContext - description: >- - A GitSourceContext denotes a particular revision in a third party Git - repository (e.g., GitHub). - ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource: - properties: + invertRegex: + type: boolean + description: >- + Optional. Only trigger a build if the revision regex does NOT match + the revision regex. + branchName: + type: string + description: >- + Regex matching branches to build. The syntax of the regular + expressions accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax dir: + type: string description: >- Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + commitSha: + description: Explicit commit SHA to build. type: string - url: - description: >- - Required. Location of the Git repo to build. This will be used as a - `git remote`, see https://git-scm.com/docs/git-remote. - type: string - revision: + tagName: type: string description: >- - Optional. The revision to fetch from the Git repository such as a - branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git - fetch` to fetch the revision from the Git repository; therefore make - sure that the string you provide for `revision` is parsable by the - command. For information on string values accepted by `git fetch`, - see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For - information on `git fetch`, see https://git-scm.com/docs/git-fetch. - description: Location of the source in any accessible Git repository. + Regex matching tags to build. The syntax of the regular expressions + accepted is the syntax accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax + substitutions: + description: >- + Optional. Substitutions to use in a triggered build. Should only be + used with RunBuildTrigger + type: object + additionalProperties: + type: string + ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning: + description: A non-fatal problem encountered during the execution of the build. type: object - id: ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource - GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata: + id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning + properties: + priority: + enum: + - PRIORITY_UNSPECIFIED + - INFO + - WARNING + - ALERT + type: string + description: The priority for this warning. + enumDescriptions: + - Should not be used. + - e.g. deprecation warnings and alternative feature highlights. + - e.g. automated detection of possible issues with the build. + - e.g. alerts that a feature used in the build is pending removal + text: + type: string + description: Explanation of the warning generated. + Status: type: object - id: GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata description: >- - Metadata for all operations used and required for all operations that - created by Container Analysis Providers + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - createTime: - type: string - format: google-datetime - description: Output only. The time this operation was created. - endTime: + details: + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: type: string description: >- - Output only. The time that this operation was marked completed or - failed. - format: google-datetime + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + id: Status Completeness: properties: arguments: @@ -4317,395 +4834,403 @@ components: description: >- If true, the builder claims that recipe.environment is claimed to be complete. - id: Completeness description: >- Indicates that the builder claims certain fields in this message to be complete. type: object - ComplianceNote: - type: object - properties: - rationale: - type: string - description: A rationale for the existence of this compliance check. - description: - description: A description about this compliance check. - type: string - cisBenchmark: - $ref: '#/components/schemas/CisBenchmark' - remediation: - description: A description of remediation steps if the compliance check fails. - type: string - scanInstructions: - type: string - description: Serialized scan instructions with a predefined format. - format: byte - title: - type: string - description: The title that identifies this compliance check. - impact: - type: string - version: - description: The OS and config versions the benchmark applies to. - items: - $ref: '#/components/schemas/ComplianceVersion' - type: array - id: ComplianceNote - Hint: + id: Completeness + ContaineranalysisGoogleDevtoolsCloudbuildV1Source: + description: Location of the source in a supported storage service. type: object properties: - humanReadableName: + storageSource: + description: If provided, get the source from this location in Cloud Storage. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource + repoSource: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource description: >- - Required. The human readable name of this attestation authority, for - example "qa". - type: string - id: Hint - description: >- - This submessage provides human-readable hints about the purpose of the - authority. Because the name of a note acts as its resource reference, it - is important to disambiguate the canonical name of the Note (which might - be a UUID for security purposes) from "readable" names more suitable for - debug output. Note that these hints should not be used to look up - authorities in security sensitive contexts, such as when looking up - attestations to verify. - ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret: - properties: - env: + If provided, get the source from this location in a Cloud Source + Repository. + gitSource: + description: If provided, get the source from this Git repository. + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource + developerConnectConfig: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfig + description: If provided, get the source from this Developer Connect config. + storageSourceManifest: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest description: >- - Environment variable name to associate with the secret. Secret - environment variables must be unique across all of a build's - secrets, and must be used by at least one build step. - type: string - versionName: - type: string + If provided, get the source from this manifest in Cloud Storage. + This feature is in Preview; see description + [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). + connectedRepository: + $ref: >- + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository description: >- - Resource name of the SecretVersion. In format: - projects/*/secrets/*/versions/* - type: object + Optional. If provided, get the source from this 2nd-gen Google Cloud + Build repository resource. + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Source + GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder: description: >- - Pairs a secret environment variable with a SecretVersion in Secret - Manager. - id: ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret - ListOccurrencesResponse: - description: Response for listing occurrences. - id: ListOccurrencesResponse - type: object - properties: - nextPageToken: - description: >- - The next pagination token in the list response. It should be used as - `page_token` for the following request. An empty value means no more - results. - type: string - occurrences: - items: - $ref: '#/components/schemas/Occurrence' - type: array - description: The occurrences requested. - TestIamPermissionsResponse: - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - items: - type: string - type: array - description: Response message for `TestIamPermissions` method. - type: object - id: TestIamPermissionsResponse - GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource: - id: GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource + Identifies the entity that executed the recipe, which is trusted to have + correctly performed the operation and populated this provenance. + id: GrafeasV1SlsaProvenanceZeroTwoSlsaBuilder properties: - entryPoint: - type: string - digest: - type: object - additionalProperties: - type: string - uri: + id: type: string type: object - description: >- - Describes where the config file that kicked off the build came from. - This is effectively a pointer to the source where buildConfig came from. - SbomReferenceIntotoPayload: + DSSEAttestationOccurrence: type: object - id: SbomReferenceIntotoPayload + id: DSSEAttestationOccurrence properties: - predicate: - $ref: '#/components/schemas/SbomReferenceIntotoPredicate' - description: >- - Additional parameters of the Predicate. Includes the actual data - about the SBOM. - subject: - type: array + statement: + $ref: '#/components/schemas/InTotoStatement' + envelope: description: >- - Set of software artifacts that the attestation applies to. Each - element represents a single software artifact. - items: - $ref: '#/components/schemas/Subject' - predicateType: - description: URI identifying the type of the Predicate. - type: string - _type: - description: Identifier for the schema of the Statement. - type: string + If doing something security critical, make sure to verify the + signatures in this metadata. + $ref: '#/components/schemas/Envelope' description: >- - The actual payload that contains the SBOM Reference data. The payload - follows the intoto statement specification. See - https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md - for more details. - Artifact: - description: Artifact describes a build product. - id: Artifact + Deprecated. Prefer to use a regular Occurrence, and populate the + Envelope at the top level of the Occurrence. + Command: properties: id: - description: >- - Artifact ID, if any; for container images, this will be a URL by - digest like `gcr.io/projectID/imagename@sha256:123456`. - type: string - checksum: type: string description: >- - Hash or checksum value of a binary, or Docker Registry 2.0 digest of - a container. - names: - type: array - description: >- - Related artifact names. This may be the path to a binary or jar - file, or in the case of a container build, the name used to push the - container image to Google Container Registry, as presented to - `docker push`. Note that a single Artifact ID can have multiple - names, for example if two tags are applied to one image. + Optional unique identifier for this command, used in wait_for to + reference this command as a dependency. + args: + description: Command-line arguments used when executing this command. items: type: string - type: object - SbomReferenceIntotoPredicate: - id: SbomReferenceIntotoPredicate - description: A predicate which describes the SBOM being referenced. - type: object - properties: - referrerId: - description: The person or system referring this predicate to the consumer. - type: string - location: - type: string - description: The location of the SBOM. - digest: - description: A map of algorithm to digest of the contents of the SBOM. - type: object - additionalProperties: - type: string - mimeType: - description: The mime type of the SBOM. - type: string - Recipe: - description: >- - Steps taken to build the artifact. For a TaskRun, typically each - container corresponds to one step in the recipe. - type: object - properties: - type: - type: string - description: >- - URI indicating what type of recipe was performed. It determines the - meaning of recipe.entryPoint, recipe.arguments, recipe.environment, - and materials. - environment: - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object type: array - description: >- - Any other builder-controlled inputs necessary for correctly - evaluating the recipe. Usually only needed for reproducing the build - but not evaluated as part of policy. Since the environment field can - greatly vary in structure, depending on the builder and recipe type, - this is of form "Any". - definedInMaterial: - format: int64 - description: >- - Index in materials containing the recipe steps that are not implied - by recipe.type. For example, if the recipe type were "make", then - this would point to the source containing the Makefile, not the make - program itself. Set to -1 if the recipe doesn't come from a - material, as zero is default unset value for int64. - type: string - arguments: + env: + description: Environment variables set before running this command. items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + type: string type: array + dir: description: >- - Collection of all external inputs that influenced the build on top - of recipe.definedInMaterial and recipe.entryPoint. For example, if - the recipe type were "make", then this might be the flags passed to - make aside from the target, which is captured in recipe.entryPoint. - Since the arguments field can greatly vary in structure, depending - on the builder and recipe type, this is of form "Any". - entryPoint: + Working directory (relative to project source root) used when + running this command. type: string + name: description: >- - String identifying the entry point into the build. This is often a - path to a configuration file and/or a target label within that file. - The syntax and meaning are defined by recipe.type. For example, if - the recipe type were "make", then this would reference the directory - in which to run make as well as which target to use. - id: Recipe - WindowsDetail: - id: WindowsDetail - properties: - description: - type: string - description: The description of this vulnerability. - cpeUri: + Required. Name of the command, as presented on the command line, or + if the command is packaged as a Docker container, as presented to + `docker pull`. type: string - description: >- - Required. The [CPE URI](https://cpe.mitre.org/specification/) this - vulnerability affects. - fixingKbs: + waitFor: + description: The ID(s) of the command(s) that this command depends on. type: array items: - $ref: '#/components/schemas/KnowledgeBase' - description: >- - Required. The names of the KBs which have hotfixes to mitigate this - vulnerability. Note that there may be multiple hotfixes (and thus - multiple KBs) that mitigate a given vulnerability. Currently any - listed KBs presence is considered a fix. - name: - description: Required. The name of this vulnerability. - type: string + type: string type: object - VulnerabilityAssessmentNote: - description: >- - A single VulnerabilityAssessmentNote represents one particular product's - vulnerability assessment for one CVE. - id: VulnerabilityAssessmentNote + description: Command describes a step performed as part of the build pipeline. + id: Command + BuilderConfig: type: object properties: - shortDescription: - description: A one sentence description of this Vex. + id: type: string - assessment: - description: Represents a vulnerability assessment for the product. - $ref: '#/components/schemas/Assessment' - publisher: - description: Publisher details of this Note. - $ref: '#/components/schemas/Publisher' - product: - description: The product affected by this vex. - $ref: '#/components/schemas/Product' - languageCode: + id: BuilderConfig + Binding: + type: object + description: Associates `members`, or principals, with a `role`. + properties: + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + members: + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + items: + type: string + type: array + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string + id: Binding + Metadata: + properties: + completeness: description: >- - Identifies the language used by this document, corresponding to IETF - BCP 47 / RFC 5646. - title: + Indicates that the builder claims certain fields in this message to + be complete. + $ref: '#/components/schemas/Completeness' + buildStartedOn: type: string - description: The title of the note. E.g. `Vex-Debian-11.4` - longDescription: + format: google-datetime + description: The timestamp of when the build started. + buildInvocationId: type: string - description: A detailed description of this Vex. - ContaineranalysisGoogleDevtoolsCloudbuildV1Results: - description: Artifacts created by the build pipeline. - properties: - images: - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - description: Container images that were built as a part of the build. - type: array - buildStepOutputs: - items: - type: string - format: byte description: >- - List of build step outputs, produced by builder images, in the order - corresponding to build step indices. [Cloud - Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) - can produce this output by writing to `$BUILDER_OUTPUT/output`. Only - the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` - variable is read-only and can't be substituted. - type: array - artifactTiming: - description: Time to push all non-container artifacts to Cloud Storage. - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - numArtifacts: + Identifies the particular build invocation, which can be useful for + finding associated logs or other ad-hoc analysis. The value SHOULD + be globally unique, per in-toto Provenance spec. + buildFinishedOn: + format: google-datetime + type: string + description: The timestamp of when the build completed. + reproducible: + type: boolean + description: >- + If true, the builder claims that running the recipe on materials + will produce bit-for-bit identical output. + type: object + description: Other properties of the build. + id: Metadata + FixableTotalByDigest: + description: Per resource and severity counts of fixable and total vulnerabilities. + type: object + properties: + fixableCount: + format: int64 + type: string + description: The number of fixable vulnerabilities associated with this resource. + resourceUri: + type: string + description: The affected resource. + totalCount: format: int64 + description: The total number of vulnerabilities associated with this resource. + type: string + severity: description: >- - Number of non-container artifacts uploaded to Cloud Storage. Only - populated when artifacts are uploaded to Cloud Storage. + The severity for this count. SEVERITY_UNSPECIFIED indicates total + across all severities. + enumDescriptions: + - Unknown. + - Minimal severity. + - Low severity. + - Medium severity. + - High severity. + - Critical severity. + enum: + - SEVERITY_UNSPECIFIED + - MINIMAL + - LOW + - MEDIUM + - HIGH + - CRITICAL type: string - npmPackages: + id: FixableTotalByDigest + TimeSpan: + description: 'Start and end times for a build execution phase. Next ID: 3' + properties: + startTime: + type: string + description: Start of time span. + format: google-datetime + endTime: + format: google-datetime + type: string + description: End of time span. + type: object + id: TimeSpan + ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets: + description: Secrets and secret environment variables. + type: object + properties: + secretManager: items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage - description: Npm packages uploaded to Artifact Registry at the end of the build. + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret type: array - artifactManifest: - type: string - description: >- - Path to the artifact manifest for non-container artifacts uploaded - to Cloud Storage. Only populated when artifacts are uploaded to - Cloud Storage. - buildStepImages: description: >- - List of build step digests, in the order corresponding to build step - indices. - type: array - items: - type: string - pythonPackages: + Secrets in Secret Manager and associated secret environment + variable. + inline: type: array description: >- - Python artifacts uploaded to Artifact Registry at the end of the - build. - items: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage - mavenArtifacts: - description: >- - Maven artifacts uploaded to Artifact Registry at the end of the - build. + Secrets encrypted with KMS key and the associated secret environment + variable. items: $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact - type: array - id: ContaineranalysisGoogleDevtoolsCloudbuildV1Results - type: object - CVSS: - id: CVSS + #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret + id: ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets + ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact: + description: >- + A Maven artifact to upload to Artifact Registry upon successful + completion of all build steps. type: object + id: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact properties: - attackComplexity: - enum: - - ATTACK_COMPLEXITY_UNSPECIFIED - - ATTACK_COMPLEXITY_LOW - - ATTACK_COMPLEXITY_HIGH - - ATTACK_COMPLEXITY_MEDIUM - type: string - enumDescriptions: + groupId: + description: >- + Maven `groupId` value used when uploading the artifact to Artifact + Registry. + type: string + path: + type: string + description: >- + Path to an artifact in the build's workspace to be uploaded to + Artifact Registry. This can be either an absolute path, e.g. + /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path + from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + repository: + type: string + description: >- + Artifact Registry repository, in the form + "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the + workspace specified by path will be uploaded to Artifact Registry + with this location as a prefix. + version: + description: >- + Maven `version` value used when uploading the artifact to Artifact + Registry. + type: string + artifactId: + description: >- + Maven `artifactId` value used when uploading the artifact to + Artifact Registry. + type: string + Location: + description: >- + An occurrence of a particular package installation found within a + system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`. + properties: + cpeUri: + type: string + description: >- + Deprecated. The CPE URI in [CPE + format](https://cpe.mitre.org/specification/) + version: + $ref: '#/components/schemas/Version' + description: Deprecated. The version installed at this location. + path: + type: string + description: >- + The path from which we gathered that this package/version is + installed. + id: Location + type: object + CVSS: + description: >- + Common Vulnerability Scoring System. For details, see + https://www.first.org/cvss/specification-document This is a message we + will try to use for storing various versions of CVSS rather than making + a separate proto for storing a specific version. + type: object + id: CVSS + properties: + baseScore: + description: The base score is a function of the base metric scores. + format: float + type: number + authentication: + enumDescriptions: - '' - '' - '' - '' - scope: + type: string enum: - - SCOPE_UNSPECIFIED - - SCOPE_UNCHANGED - - SCOPE_CHANGED + - AUTHENTICATION_UNSPECIFIED + - AUTHENTICATION_MULTIPLE + - AUTHENTICATION_SINGLE + - AUTHENTICATION_NONE + attackComplexity: type: string + enum: + - ATTACK_COMPLEXITY_UNSPECIFIED + - ATTACK_COMPLEXITY_LOW + - ATTACK_COMPLEXITY_HIGH + - ATTACK_COMPLEXITY_MEDIUM + enumDescriptions: + - '' + - '' + - '' + - '' + scope: enumDescriptions: - '' - '' - '' + type: string + enum: + - SCOPE_UNSPECIFIED + - SCOPE_UNCHANGED + - SCOPE_CHANGED attackVector: + type: string description: >- Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user @@ -4716,7 +5241,6 @@ components: - ATTACK_VECTOR_ADJACENT - ATTACK_VECTOR_LOCAL - ATTACK_VECTOR_PHYSICAL - type: string enumDescriptions: - '' - '' @@ -4726,7 +5250,15 @@ components: impactScore: format: float type: number - integrityImpact: + availabilityImpact: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + type: string enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH @@ -4734,27 +5266,33 @@ components: - IMPACT_NONE - IMPACT_PARTIAL - IMPACT_COMPLETE + privilegesRequired: type: string enumDescriptions: - '' - '' - '' - '' - - '' - - '' - privilegesRequired: enum: - PRIVILEGES_REQUIRED_UNSPECIFIED - PRIVILEGES_REQUIRED_NONE - PRIVILEGES_REQUIRED_LOW - PRIVILEGES_REQUIRED_HIGH + userInteraction: + enum: + - USER_INTERACTION_UNSPECIFIED + - USER_INTERACTION_NONE + - USER_INTERACTION_REQUIRED + type: string enumDescriptions: - '' - '' - '' - - '' + exploitabilityScore: + type: number + format: float + confidentialityImpact: type: string - availabilityImpact: enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH @@ -4762,7 +5300,6 @@ components: - IMPACT_NONE - IMPACT_PARTIAL - IMPACT_COMPLETE - type: string enumDescriptions: - '' - '' @@ -4770,24 +5307,7 @@ components: - '' - '' - '' - baseScore: - description: The base score is a function of the base metric scores. - format: float - type: number - userInteraction: - enumDescriptions: - - '' - - '' - - '' - type: string - enum: - - USER_INTERACTION_UNSPECIFIED - - USER_INTERACTION_NONE - - USER_INTERACTION_REQUIRED - exploitabilityScore: - format: float - type: number - confidentialityImpact: + integrityImpact: enum: - IMPACT_UNSPECIFIED - IMPACT_HIGH @@ -4795,7 +5315,6 @@ components: - IMPACT_NONE - IMPACT_PARTIAL - IMPACT_COMPLETE - type: string enumDescriptions: - '' - '' @@ -4803,572 +5322,41 @@ components: - '' - '' - '' - authentication: - enum: - - AUTHENTICATION_UNSPECIFIED - - AUTHENTICATION_MULTIPLE - - AUTHENTICATION_SINGLE - - AUTHENTICATION_NONE - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - description: >- - Common Vulnerability Scoring System. For details, see - https://www.first.org/cvss/specification-document This is a message we - will try to use for storing various versions of CVSS rather than making - a separate proto for storing a specific version. - Signature: - properties: - signature: - description: >- - The content of the signature, an opaque bytestring. The payload that - this signature verifies MUST be unambiguously provided with the - Signature during verification. A wrapper message might provide the - payload explicitly. Alternatively, a message might have a canonical - serialization that can always be unambiguously computed to derive - the payload. - format: byte - type: string - publicKeyId: - description: >- - The identifier for the public key that verifies this signature. * - The `public_key_id` is required. * The `public_key_id` SHOULD be an - RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD - be an immutable reference, such as a cryptographic digest. Examples - of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * - "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See - https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for - more details on this scheme. RFC6920 digest-named - SubjectPublicKeyInfo (digest of the DER serialization): * - "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * - "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5" type: string - id: Signature - type: object - description: >- - Verifiers (e.g. Kritis implementations) MUST verify signatures with - respect to the trust anchors defined in policy (e.g. a Kritis policy). - Typically this means that the verifier has been configured with a map - from `public_key_id` to public key material (and any required - parameters, e.g. signing algorithm). In particular, verification - implementations MUST NOT treat the signature `public_key_id` as anything - more than a key lookup hint. The `public_key_id` DOES NOT validate or - authenticate a public key; it only provides a mechanism for quickly - selecting a public key ALREADY CONFIGURED on the verifier through a - trusted channel. Verification implementations MUST reject signatures in - any of the following circumstances: * The `public_key_id` is not - recognized by the verifier. * The public key that `public_key_id` refers - to does not verify the signature with respect to the payload. The - `signature` contents SHOULD NOT be "attached" (where the payload is - included with the serialized `signature` bytes). Verifiers MUST ignore - any "attached" payload and only verify signatures with respect to - explicitly provided payload (e.g. a `payload` field on the proto message - that holds this Signature, or the canonical serialization of the proto - message that holds this signature). - GetIamPolicyRequest: - properties: - options: - description: >- - OPTIONAL: A `GetPolicyOptions` object for specifying options to - `GetIamPolicy`. - $ref: '#/components/schemas/GetPolicyOptions' - id: GetIamPolicyRequest - description: Request message for `GetIamPolicy` method. - type: object - Binding: - type: object - id: Binding + RunDetails: properties: - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: + byproducts: type: array items: - type: string - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - description: Associates `members`, or principals, with a `role`. - UpgradeNote: - id: UpgradeNote - description: >- - An Upgrade Note represents a potential upgrade of a package to a given - version. For each package version combination (i.e. bash 4.0, bash 4.1, - bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update - field represents the information related to the update. - properties: - windowsUpdate: - description: >- - Required for Windows OS. Represents the metadata about the Windows - update. - $ref: '#/components/schemas/WindowsUpdate' - version: - description: >- - Required for non-Windows OS. The version of the package in machine + - human readable form. - $ref: '#/components/schemas/Version' - distributions: - type: array - description: Metadata about the upgrade for each specific operating system. - items: - $ref: '#/components/schemas/UpgradeDistribution' - package: - type: string - description: Required for non-Windows OS. The package this Upgrade is for. - type: object - BuildOccurrence: - properties: - provenanceBytes: - type: string - description: >- - Serialized JSON representation of the provenance, used in generating - the build signature in the corresponding build note. After verifying - the signature, `provenance_bytes` can be unmarshalled and compared - to the provenance to confirm that it is unchanged. A base64-encoded - string representation of the provenance bytes is used for the - signature in order to interoperate with openssl which expects this - format for signature verification. The serialized form is captured - both to avoid ambiguity in how the provenance is marshalled to json - as well to prevent incompatibilities with future changes. - provenance: - $ref: '#/components/schemas/BuildProvenance' - description: The actual provenance for the build. - intotoStatement: - $ref: '#/components/schemas/InTotoStatement' - description: >- - In-toto Statement representation as defined in spec. The - intoto_statement can contain any type of provenance. The serialized - payload of the statement can be stored and signed in the - Occurrence's envelope. - intotoProvenance: - description: >- - Deprecated. See InTotoStatement for the replacement. In-toto - Provenance representation as defined in spec. - $ref: '#/components/schemas/InTotoProvenance' - inTotoSlsaProvenanceV1: - description: >- - In-Toto Slsa Provenance V1 represents a slsa provenance meeting the - slsa spec, wrapped in an in-toto statement. This allows for direct - jsonification of a to-spec in-toto slsa statement with a to-spec - slsa provenance. - $ref: '#/components/schemas/InTotoSlsaProvenanceV1' - description: Details of a build occurrence. - type: object - id: BuildOccurrence - DeploymentOccurrence: - id: DeploymentOccurrence - properties: - undeployTime: - type: string - description: End of the lifetime of this deployment. - format: google-datetime - deployTime: - format: google-datetime - type: string - description: Required. Beginning of the lifetime of this deployment. - config: - description: Configuration used to create this deployment. - type: string - userEmail: - type: string - description: Identity of the user that triggered this deployment. - resourceUri: - type: array - description: >- - Output only. Resource URI for the artifact being deployed taken from - the deployable field with the same name. - items: - type: string - platform: - description: Platform hosting this deployment. - type: string - enumDescriptions: - - Unknown. - - Google Container Engine. - - 'Google App Engine: Flexible Environment.' - - Custom user-defined platform. - enum: - - PLATFORM_UNSPECIFIED - - GKE - - FLEX - - CUSTOM - address: - description: Address of the runtime element hosting this deployment. - type: string - description: The period during which some deployable was active in a runtime. - type: object - SBOMReferenceOccurrence: - properties: - payload: - $ref: '#/components/schemas/SbomReferenceIntotoPayload' - description: The actual payload that contains the SBOM reference data. - signatures: - items: - $ref: '#/components/schemas/EnvelopeSignature' - description: The signatures over the payload. - type: array - payloadType: - description: >- - The kind of payload that SbomReferenceIntotoPayload takes. Since - it's in the intoto format, this value is expected to be - 'application/vnd.in-toto+json'. - type: string - type: object - id: SBOMReferenceOccurrence - description: >- - The occurrence representing an SBOM reference as applied to a specific - resource. The occurrence follows the DSSE specification. See - https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for - more details. - GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation: - description: Identifies the event that kicked off the build. - properties: - parameters: - type: object - additionalProperties: - type: any - description: Properties of the object. - configSource: - $ref: '#/components/schemas/GrafeasV1SlsaProvenanceZeroTwoSlsaConfigSource' - environment: - type: object - additionalProperties: - description: Properties of the object. - type: any - type: object - id: GrafeasV1SlsaProvenanceZeroTwoSlsaInvocation - BuildProvenance: - id: BuildProvenance - properties: - createTime: - format: google-datetime - description: Time at which the build was created. - type: string - endTime: - type: string - description: Time at which execution of the build was finished. - format: google-datetime - startTime: - description: Time at which execution of the build was started. - format: google-datetime - type: string - builderVersion: - description: Version string of the builder at the time this build was executed. - type: string - creator: - description: >- - E-mail address of the user who initiated this build. Note that this - was the user's e-mail address at the time the build was initiated; - this address may not represent the same end-user for all time. - type: string - projectId: - description: ID of the project. - type: string - builtArtifacts: - type: array - items: - $ref: '#/components/schemas/Artifact' - description: Output of the build. - id: - type: string - description: Required. Unique identifier of the build. - triggerId: - type: string - description: >- - Trigger identifier if the build was triggered automatically; empty - if not. - logsUri: - description: URI where any logs for this provenance were written. - type: string - commands: - type: array - items: - $ref: '#/components/schemas/Command' - description: Commands requested by the build. - buildOptions: - additionalProperties: - type: string - description: >- - Special options applied to this build. This is a catch-all field - where build providers can enter any desired additional details. - type: object - sourceProvenance: - $ref: '#/components/schemas/Source' - description: Details of the Source input to the build. - type: object - description: >- - Provenance of a build. Contains all information needed to verify the - full details about the build from source to completion. - BatchCreateNotesResponse: - type: object - description: Response for creating notes in batch. - properties: - notes: - description: The notes that were created. - type: array - items: - $ref: '#/components/schemas/Note' - id: BatchCreateNotesResponse - BuilderConfig: - id: BuilderConfig - properties: - id: - type: string - type: object - Hash: - properties: - type: - type: string - description: Required. The type of hash that was performed, e.g. "SHA-256". - value: - description: Required. The hash value. - type: string - format: byte - id: Hash - type: object - description: Container message for hash values. - AnalysisCompleted: - properties: - analysisType: - type: array - items: - type: string - type: object - id: AnalysisCompleted - description: >- - Indicates which analysis completed successfully. Multiple types of - analysis can be performed on a single resource. - ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage: - id: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage - type: object - properties: - pushTiming: - $ref: >- - #/components/schemas/ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan - description: >- - Output only. Stores timing information for pushing the specified - image. - readOnly: true - digest: - description: Docker Registry 2.0 digest. - type: string - name: - description: >- - Name used to push the container image to Google Container Registry, - as presented to `docker push`. - type: string - description: An image built by the pipeline. - AttestationNote: - id: AttestationNote - description: >- - Note kind that represents a logical attestation "role" or "authority". - For example, an organization might have one `Authority` for "QA" and one - for "build". This note is intended to act strictly as a grouping - mechanism for the attached occurrences (Attestations). This grouping - mechanism also provides a security boundary, since IAM ACLs gate the - ability for a principle to attach an occurrence to a given note. It also - provides a single point of lookup to find all attached attestation - occurrences, even if they don't all live in the same project. - properties: - hint: - description: Hint hints at the purpose of the attestation authority. - $ref: '#/components/schemas/Hint' - type: object - Empty: - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - id: Empty - NonCompliantFile: - properties: - displayCommand: - type: string - description: Command to display the non-compliant files. - path: - description: Empty if `display_command` is set. - type: string - reason: - type: string - description: Explains why a file is non compliant for a CIS check. - id: NonCompliantFile - type: object - description: >- - Details about files that caused a compliance check to fail. - display_command is a single command that can be used to display a list - of non compliant files. When there is no such command, we can also - iterate a list of non compliant file using 'path'. - SetIamPolicyRequest: - type: object - description: Request message for `SetIamPolicy` method. - id: SetIamPolicyRequest - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - Identity: - description: The unique identifier of the update. - properties: - revision: - type: integer - description: The revision number of the update. - format: int32 - updateId: - type: string - description: The revision independent identifier of the update. - type: object - id: Identity - Envelope: - description: >- - MUST match - https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. - An authenticated message of arbitrary type. - properties: - signatures: - items: - $ref: '#/components/schemas/EnvelopeSignature' - type: array - payload: - format: byte - type: string - payloadType: - type: string - id: Envelope - type: object - Justification: - id: Justification - properties: - details: - description: Additional details on why this justification was chosen. - type: string - justificationType: - enumDescriptions: - - JUSTIFICATION_TYPE_UNSPECIFIED. - - The vulnerable component is not present in the product. - - >- - The vulnerable code is not present. Typically this case occurs - when source code is configured or built in a way that excludes the - vulnerable code. - - >- - The vulnerable code can not be executed. Typically this case - occurs when the product includes the vulnerable code but does not - call or use the vulnerable code. - - >- - The vulnerable code cannot be controlled by an attacker to exploit - the vulnerability. - - >- - The product includes built-in protections or features that prevent - exploitation of the vulnerability. These built-in protections - cannot be subverted by the attacker and cannot be configured or - disabled by the user. These mitigations completely prevent - exploitation based on known attack vectors. - type: string - description: The justification type for this vulnerability. - enum: - - JUSTIFICATION_TYPE_UNSPECIFIED - - COMPONENT_NOT_PRESENT - - VULNERABLE_CODE_NOT_PRESENT - - VULNERABLE_CODE_NOT_IN_EXECUTE_PATH - - VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY - - INLINE_MITIGATIONS_ALREADY_EXIST - description: >- - Justification provides the justification when the state of the - assessment if NOT_AFFECTED. + $ref: '#/components/schemas/ResourceDescriptor' + builder: + $ref: '#/components/schemas/ProvenanceBuilder' + metadata: + $ref: '#/components/schemas/BuildMetadata' type: object + id: RunDetails parameters: - _.xgafv: - description: V1 error format. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean access_token: description: OAuth access token. in: query @@ -5381,18 +5369,12 @@ components: name: oauth_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -5402,16 +5384,19 @@ components: name: key schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: uploadType + name: $.xgafv schema: type: string - callback: - description: JSONP + enum: + - '1' + - '2' + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string alt: @@ -5424,19 +5409,10 @@ components: - json - media - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol schema: type: string x-stackQL-resources: @@ -5463,200 +5439,281 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] occurrences: id: google.containeranalysis.occurrences name: occurrences title: Occurrences methods: - _projects_locations_occurrences_list: - operation: &ref_1 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/get - response: &ref_2 + projects_occurrences_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_locations_occurrences_list: - operation: *ref_1 - response: *ref_2 - projects_locations_occurrences_get: + projects_occurrences_create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_occurrences_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_notes_occurrences_list: - operation: &ref_3 + projects_occurrences_patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get - response: &ref_4 + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.occurrences - projects_locations_notes_occurrences_list: - operation: *ref_3 - response: *ref_4 - projects_occurrences_create: + projects_occurrences_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_occurrences_list: - operation: &ref_5 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences/get' - response: &ref_6 + projects_occurrences_batch_create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences:batchCreate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_notes_occurrences_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}~1occurrences/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_occurrences_list: - operation: *ref_5 - response: *ref_6 - projects_occurrences_patch: + projects_locations_occurrences_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_delete: + projects_locations_occurrences_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get: + projects_locations_occurrences_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_batch_create: + projects_locations_occurrences_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1occurrences:batchCreate/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/post response: mediaType: application/json openAPIDocKey: '200' - _projects_notes_occurrences_list: - operation: &ref_7 + projects_locations_occurrences_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}~1occurrences/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.occurrences + projects_locations_occurrences_batch_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_notes_occurrences_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}~1occurrences/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - projects_notes_occurrences_list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_get - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_locations_notes_occurrences_list - - $ref: >- - #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_list - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_get - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_notes_occurrences_list + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_list - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_list insert: + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_create + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_batch_create - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_create + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_batch_create update: + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_patch - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_patch + replace: [] delete: + - $ref: >- + #/components/x-stackQL-resources/occurrences/methods/projects_locations_occurrences_delete - $ref: >- #/components/x-stackQL-resources/occurrences/methods/projects_occurrences_delete - occurrences_vulnerability_summary: - id: google.containeranalysis.occurrences_vulnerability_summary - name: occurrences_vulnerability_summary - title: Occurrences_vulnerability_summary + occurrences_iam_policies: + id: google.containeranalysis.occurrences_iam_policies + name: occurrences_iam_policies + title: Occurrences_iam_policies methods: - projects_locations_occurrences_get_vulnerability_summary: + projects_occurrences_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get_vulnerability_summary: + projects_occurrences_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_occurrences_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_occurrences_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_occurrences_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_occurrences_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_get_iam_policy - $ref: >- - #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_locations_occurrences_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_set_iam_policy delete: [] occurrences_notes: id: google.containeranalysis.occurrences_notes name: occurrences_notes title: Occurrences_notes methods: - projects_locations_occurrences_get_notes: + projects_occurrences_get_notes: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}~1notes/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_occurrences_get_notes: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}~1notes/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/occurrences_notes/methods/projects_locations_occurrences_get_notes + - $ref: >- + #/components/x-stackQL-resources/occurrences_notes/methods/projects_occurrences_get_notes + insert: [] + update: [] + replace: [] + delete: [] + occurrences_vulnerability_summary: + id: google.containeranalysis.occurrences_vulnerability_summary + name: occurrences_vulnerability_summary + title: Occurrences_vulnerability_summary + methods: + projects_occurrences_get_vulnerability_summary: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences~1{occurrencesId}~1notes/get + #/paths/~1v1~1projects~1{projectsId}~1occurrences:vulnerabilitySummary/get response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_get_notes: + projects_locations_occurrences_get_vulnerability_summary: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}~1notes/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1occurrences:vulnerabilitySummary/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/occurrences_notes/methods/projects_locations_occurrences_get_notes + #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_locations_occurrences_get_vulnerability_summary - $ref: >- - #/components/x-stackQL-resources/occurrences_notes/methods/projects_occurrences_get_notes + #/components/x-stackQL-resources/occurrences_vulnerability_summary/methods/projects_occurrences_get_vulnerability_summary insert: [] update: [] + replace: [] delete: [] notes: id: google.containeranalysis.notes name: notes title: Notes methods: - _projects_locations_notes_list: - operation: &ref_9 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.notes - projects_locations_notes_list: - operation: *ref_9 - response: *ref_10 - projects_locations_notes_get: + projects_notes_patch: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_notes_patch: + projects_notes_get: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/patch' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -5666,22 +5723,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_notes_get: + projects_notes_list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_notes_list: - operation: &ref_11 $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.notes - projects_notes_list: - operation: *ref_11 - response: *ref_12 projects_notes_create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1notes/post' @@ -5694,119 +5742,549 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_notes_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.notes + projects_locations_notes_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_notes_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_notes_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_notes_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_notes_batch_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes:batchCreate/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/notes/methods/projects_locations_notes_get + - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_get' - $ref: >- #/components/x-stackQL-resources/notes/methods/projects_locations_notes_list - - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_get' - $ref: '#/components/x-stackQL-resources/notes/methods/projects_notes_list' insert: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_create + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_batch_create - $ref: >- #/components/x-stackQL-resources/notes/methods/projects_notes_create + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_notes_batch_create update: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_patch - $ref: >- #/components/x-stackQL-resources/notes/methods/projects_notes_patch + replace: [] delete: + - $ref: >- + #/components/x-stackQL-resources/notes/methods/projects_locations_notes_delete - $ref: >- #/components/x-stackQL-resources/notes/methods/projects_notes_delete - occurrences_iam_policies: - id: google.containeranalysis.occurrences_iam_policies - name: occurrences_iam_policies - title: Occurrences_iam_policies + notes_iam_policies: + id: google.containeranalysis.notes_iam_policies + name: notes_iam_policies + title: Notes_iam_policies methods: - projects_occurrences_set_iam_policy: + projects_notes_set_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_occurrences_test_iam_permissions: + projects_notes_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' - _projects_occurrences_get_iam_policy: - operation: &ref_13 + projects_notes_get_iam_policy: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1occurrences~1{occurrencesId}:getIamPolicy/post - response: &ref_14 + #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_occurrences_get_iam_policy: - operation: *ref_13 - response: *ref_14 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/occurrences_iam_policies/methods/projects_occurrences_get_iam_policy - insert: [] - update: [] - delete: [] - notes_iam_policies: - id: google.containeranalysis.notes_iam_policies - name: notes_iam_policies - title: Notes_iam_policies - methods: - _projects_notes_get_iam_policy: - operation: &ref_15 + projects_locations_notes_set_iam_policy: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:getIamPolicy/post - response: &ref_16 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:setIamPolicy/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_notes_get_iam_policy: - operation: *ref_15 - response: *ref_16 - projects_notes_test_iam_permissions: + projects_locations_notes_get_iam_policy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:getIamPolicy/post response: mediaType: application/json openAPIDocKey: '200' - projects_notes_set_iam_policy: + objectKey: $.bindings + projects_locations_notes_test_iam_permissions: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1notes~1{notesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1notes~1{notesId}:testIamPermissions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_get_iam_policy - $ref: >- #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_locations_notes_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/notes_iam_policies/methods/projects_notes_set_iam_policy delete: [] paths: /v1/projects/{projectsId}/resources/{resourcesId}:exportSBOM: - parameters: &ref_17 - - $ref: '#/components/parameters/_.xgafv' + parameters: &ref_1 + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + post: + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.resources.exportSBOM + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportSBOMRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ExportSBOMResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: resourcesId + required: true + schema: + type: string + /v1/projects/{projectsId}/occurrences: + parameters: *ref_1 + get: + description: Lists occurrences for the specified project. + operationId: containeranalysis.projects.occurrences.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOccurrencesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new occurrence. + operationId: containeranalysis.projects.occurrences.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}: + parameters: *ref_1 + get: + description: Gets the specified occurrence. + operationId: containeranalysis.projects.occurrences.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + patch: + description: Updates the specified occurrence. + operationId: containeranalysis.projects.occurrences.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes the specified occurrence. For example, use this method to delete + an occurrence when the occurrence is no longer applicable for the given + resource. + operationId: containeranalysis.projects.occurrences.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: + parameters: *ref_1 post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.resources.exportSBOM + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMRequest' + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.occurrences.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: + parameters: *ref_1 + get: + description: >- + Gets the note attached to the specified occurrence. Consumer projects + can use this method to get a note that belongs to a provider project. + operationId: containeranalysis.projects.occurrences.getNotes + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: occurrencesId + required: true + schema: + type: string + /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: + parameters: *ref_1 + get: + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/occurrences:batchCreate: + parameters: *ref_1 + post: + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.occurrences.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/notes/{notesId}/occurrences: + parameters: *ref_1 + get: + description: >- + Lists occurrences referencing the specified note. Provider projects can + use this method to get all occurrences across consumer projects + referencing the specified note. + operationId: containeranalysis.projects.notes.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5818,7 +6296,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/ListNoteOccurrencesResponse' parameters: - in: path name: projectsId @@ -5826,20 +6304,33 @@ paths: schema: type: string - in: path - name: resourcesId + name: notesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: - parameters: *ref_17 - post: - description: Generates an SBOM for the given resource. - operationId: containeranalysis.projects.locations.resources.exportSBOM + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/notes/{notesId}: + parameters: *ref_1 + patch: + description: Updates the specified note. + operationId: containeranalysis.projects.notes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMRequest' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5851,7 +6342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExportSBOMResponse' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -5859,20 +6350,44 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets the specified note. + operationId: containeranalysis.projects.notes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + parameters: - in: path - name: resourcesId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences: - parameters: *ref_17 - get: - description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.locations.occurrences.list + - in: path + name: notesId + required: true + schema: + type: string + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5884,7 +6399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListOccurrencesResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -5892,7 +6407,30 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/notes: + parameters: *ref_1 + get: + description: Lists notes for the specified project. + operationId: containeranalysis.projects.notes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListNotesResponse' + parameters: + - in: path + name: projectsId required: true schema: type: string @@ -5900,20 +6438,55 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 + post: + description: Creates a new note. + operationId: containeranalysis.projects.notes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: query - name: pageToken + name: noteId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: - parameters: *ref_17 - get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary + /v1/projects/{projectsId}/notes:batchCreate: + parameters: *ref_1 + post: + description: Creates new notes in batch. + operationId: containeranalysis.projects.notes.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateNotesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5925,7 +6498,118 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/BatchCreateNotesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.notes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/notes/{notesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.notes.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.notes.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -5933,19 +6617,20 @@ paths: schema: type: string - in: path - name: locationsId + name: notesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: - parameters: *ref_17 - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.locations.occurrences.get + /v1/projects/{projectsId}/locations/{locationsId}/resources/{resourcesId}:exportSBOM: + parameters: *ref_1 + post: + description: Generates an SBOM for the given resource. + operationId: containeranalysis.projects.locations.resources.exportSBOM + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportSBOMRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5957,7 +6642,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/ExportSBOMResponse' parameters: - in: path name: projectsId @@ -5970,17 +6655,18 @@ paths: schema: type: string - in: path - name: occurrencesId + name: resourcesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: - parameters: *ref_17 - get: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}: + parameters: *ref_1 + delete: description: >- - Gets the note attached to the specified occurrence. Consumer projects - can use this method to get a note that belongs to a provider project. - operationId: containeranalysis.projects.locations.occurrences.getNotes + Deletes the specified occurrence. For example, use this method to delete + an occurrence when the occurrence is no longer applicable for the given + resource. + operationId: containeranalysis.projects.locations.occurrences.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5992,7 +6678,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -6009,11 +6695,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes: - parameters: *ref_17 - get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.locations.notes.list + patch: + description: Updates the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Occurrence' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6025,7 +6714,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6037,24 +6726,19 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: occurrencesId + required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: - parameters: *ref_17 + format: google-fieldmask get: - description: Gets the specified note. - operationId: containeranalysis.projects.locations.notes.get + description: Gets the specified occurrence. + operationId: containeranalysis.projects.locations.occurrences.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6066,7 +6750,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Occurrence' parameters: - in: path name: projectsId @@ -6079,18 +6763,15 @@ paths: schema: type: string - in: path - name: notesId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:vulnerabilitySummary: + parameters: *ref_1 get: - description: >- - Lists occurrences referencing the specified note. Provider projects can - use this method to get all occurrences across consumer projects - referencing the specified note. - operationId: containeranalysis.projects.locations.notes.occurrences.list + description: Gets a summary of the number and severity of occurrences. + operationId: containeranalysis.projects.locations.occurrences.getVulnerabilitySummary security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6102,7 +6783,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNoteOccurrencesResponse' + $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' parameters: - in: path name: projectsId @@ -6114,29 +6795,15 @@ paths: required: true schema: type: string - - in: path - name: notesId - required: true - schema: - type: string - in: query name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/occurrences: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/occurrences: + parameters: *ref_1 post: description: Creates a new occurrence. - operationId: containeranalysis.projects.occurrences.create + operationId: containeranalysis.projects.locations.occurrences.create requestBody: content: application/json: @@ -6160,9 +6827,14 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string get: description: Lists occurrences for the specified project. - operationId: containeranalysis.projects.occurrences.list + operationId: containeranalysis.projects.locations.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6181,6 +6853,11 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query name: filter schema: @@ -6194,16 +6871,22 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/occurrences/{occurrencesId}: - parameters: *ref_17 - patch: - description: Updates the specified occurrence. - operationId: containeranalysis.projects.occurrences.patch + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a note or an occurrence resource. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.getIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/GetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6215,7 +6898,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId @@ -6223,21 +6906,30 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: occurrencesId + required: true schema: type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions: + parameters: *ref_1 + post: description: >- - Deletes the specified occurrence. For example, use this method to delete - an occurrence when the occurrence is no longer applicable for the given - resource. - operationId: containeranalysis.projects.occurrences.delete + Returns the permissions that a caller has on the specified note or + occurrence. Requires list permission on the project (for example, + `containeranalysis.notes.list`). The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6249,21 +6941,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/TestIamPermissionsResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: occurrencesId required: true schema: type: string - get: - description: Gets the specified occurrence. - operationId: containeranalysis.projects.occurrences.get + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.occurrences.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6275,25 +6985,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Occurrence' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}/notes: - parameters: *ref_17 - get: - description: >- - Gets the note attached to the specified occurrence. Consumer projects - can use this method to get a note that belongs to a provider project. - operationId: containeranalysis.projects.occurrences.getNotes + /v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate: + parameters: *ref_1 + post: + description: Creates new occurrences in batch. + operationId: containeranalysis.projects.locations.occurrences.batchCreate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchCreateOccurrencesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6305,7 +7023,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/BatchCreateOccurrencesResponse' parameters: - in: path name: projectsId @@ -6313,15 +7031,17 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences:vulnerabilitySummary: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes: + parameters: *ref_1 get: - description: Gets a summary of the number and severity of occurrences. - operationId: containeranalysis.projects.occurrences.getVulnerabilitySummary + description: >- + Gets the note attached to the specified occurrence. Consumer projects + can use this method to get a note that belongs to a provider project. + operationId: containeranalysis.projects.locations.occurrences.getNotes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6333,61 +7053,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VulnerabilityOccurrencesSummary' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/occurrences:batchCreate: - parameters: *ref_17 - post: - description: Creates new occurrences in batch. - operationId: containeranalysis.projects.occurrences.batchCreate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateOccurrencesRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/BatchCreateOccurrencesResponse' - parameters: - in: path - name: projectsId + name: occurrencesId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy: - parameters: *ref_17 - post: + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}/occurrences: + parameters: *ref_1 + get: description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + Lists occurrences referencing the specified note. Provider projects can + use this method to get all occurrences across consumer projects + referencing the specified note. + operationId: containeranalysis.projects.locations.notes.occurrences.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6399,7 +7089,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListNoteOccurrencesResponse' parameters: - in: path name: projectsId @@ -6407,25 +7097,33 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions: - parameters: *ref_17 - post: - description: >- - Returns the permissions that a caller has on the specified note or - occurrence. Requires list permission on the project (for example, - `containeranalysis.notes.list`). The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + - in: path + name: notesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/notes: + parameters: *ref_1 + get: + description: Lists notes for the specified project. + operationId: containeranalysis.projects.locations.notes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6437,7 +7135,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/ListNotesResponse' parameters: - in: path name: projectsId @@ -6445,26 +7143,31 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy: - parameters: *ref_17 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: >- - Gets the access control policy for a note or an occurrence resource. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.occurrences.getIamPolicy + description: Creates a new note. + operationId: containeranalysis.projects.locations.notes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + $ref: '#/components/schemas/Note' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6476,7 +7179,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6484,15 +7187,19 @@ paths: schema: type: string - in: path - name: occurrencesId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}: - parameters: *ref_17 + - in: query + name: noteId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}: + parameters: *ref_1 patch: description: Updates the specified note. - operationId: containeranalysis.projects.notes.patch + operationId: containeranalysis.projects.locations.notes.patch requestBody: content: application/json: @@ -6516,6 +7223,11 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: notesId required: true @@ -6526,9 +7238,9 @@ paths: schema: type: string format: google-fieldmask - delete: - description: Deletes the specified note. - operationId: containeranalysis.projects.notes.delete + get: + description: Gets the specified note. + operationId: containeranalysis.projects.locations.notes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6540,7 +7252,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Note' parameters: - in: path name: projectsId @@ -6548,28 +7260,7 @@ paths: schema: type: string - in: path - name: notesId - required: true - schema: - type: string - get: - description: Gets the specified note. - operationId: containeranalysis.projects.notes.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Note' - parameters: - - in: path - name: projectsId + name: locationsId required: true schema: type: string @@ -6578,11 +7269,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/notes: - parameters: *ref_17 - get: - description: Lists notes for the specified project. - operationId: containeranalysis.projects.notes.list + delete: + description: Deletes the specified note. + operationId: containeranalysis.projects.locations.notes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6594,34 +7283,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListNotesResponse' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: notesId + required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy: + parameters: *ref_1 post: - description: Creates a new note. - operationId: containeranalysis.projects.notes.create + description: >- + Sets the access control policy on the specified note or occurrence. + Requires `containeranalysis.notes.setIamPolicy` or + `containeranalysis.occurrences.setIamPolicy` permission if the resource + is a note or an occurrence, respectively. The resource takes the format + `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and + `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + operationId: containeranalysis.projects.locations.notes.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6633,19 +7327,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Note' + $ref: '#/components/schemas/Policy' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: noteId + - in: path + name: locationsId + required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:getIamPolicy: - parameters: *ref_17 + - in: path + name: notesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy: + parameters: *ref_1 post: description: >- Gets the access control policy for a note or an occurrence resource. @@ -6654,7 +7354,7 @@ paths: is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.getIamPolicy + operationId: containeranalysis.projects.locations.notes.getIamPolicy requestBody: content: application/json: @@ -6678,16 +7378,21 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: notesId required: true schema: type: string - /v1/projects/{projectsId}/notes:batchCreate: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate: + parameters: *ref_1 post: description: Creates new notes in batch. - operationId: containeranalysis.projects.notes.batchCreate + operationId: containeranalysis.projects.locations.notes.batchCreate requestBody: content: application/json: @@ -6711,8 +7416,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/notes/{notesId}:testIamPermissions: - parameters: *ref_17 + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions: + parameters: *ref_1 post: description: >- Returns the permissions that a caller has on the specified note or @@ -6720,7 +7430,7 @@ paths: `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.testIamPermissions + operationId: containeranalysis.projects.locations.notes.testIamPermissions requestBody: content: application/json: @@ -6745,72 +7455,7 @@ paths: schema: type: string - in: path - name: notesId - required: true - schema: - type: string - /v1/projects/{projectsId}/notes/{notesId}:setIamPolicy: - parameters: *ref_17 - post: - description: >- - Sets the access control policy on the specified note or occurrence. - Requires `containeranalysis.notes.setIamPolicy` or - `containeranalysis.occurrences.setIamPolicy` permission if the resource - is a note or an occurrence, respectively. The resource takes the format - `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and - `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. - operationId: containeranalysis.projects.notes.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: notesId - required: true - schema: - type: string - /v1/projects/{projectsId}/notes/{notesId}/occurrences: - parameters: *ref_17 - get: - description: >- - Lists occurrences referencing the specified note. Provider projects can - use this method to get all occurrences across consumer projects - referencing the specified note. - operationId: containeranalysis.projects.notes.occurrences.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListNoteOccurrencesResponse' - parameters: - - in: path - name: projectsId + name: locationsId required: true schema: type: string @@ -6819,16 +7464,3 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml index 1207d21e..1eac2af9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/contentwarehouse.yaml @@ -7,8 +7,8 @@ info: title: Document AI Warehouse API description: '' version: v1 - x-discovery-doc-revision: '20240506' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240809' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/document-warehouse servers: @@ -34,802 +34,716 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - CloudAiPlatformTenantresourceTenantProjectResource: - id: CloudAiPlatformTenantresourceTenantProjectResource - description: 'The tenant project and tenant resources. Next ID: 10' + GoogleCloudContentwarehouseV1TimestampArray: + description: Timestamp values. properties: - tag: - type: string - description: >- - Input/Output [Required]. The tag that uniquely identifies a tenant - project within a tenancy unit. Note: for the same tenant project - tag, all tenant manager operations should be idempotent. - infraSpannerConfigs: + values: + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + description: List of timestamp values. type: array + id: GoogleCloudContentwarehouseV1TimestampArray + type: object + GoogleCloudDocumentaiV1DocumentPageToken: + type: object + properties: + detectedLanguages: + type: array + description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig - description: >- - The Infra Spanner databases that are provisioned under the tenant - project. Note: this is an experimental feature. - tenantProjectConfig: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + description: The history of this annotation. + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + layout: + description: Layout for Token. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + styleInfo: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig - description: The configurations of a tenant project. - gcsBuckets: - items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' - description: The GCS buckets that are provisioned under the tenant project. - type: array - tenantProjectNumber: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Text style attributes. + detectedBreak: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. + description: A detected token. + id: GoogleCloudDocumentaiV1DocumentPageToken + GoogleCloudContentwarehouseV1SearchDocumentsRequest: + id: GoogleCloudContentwarehouseV1SearchDocumentsRequest + properties: + totalResultSize: + enumDescriptions: + - Total number calculation will be skipped. + - >- + Estimate total number. The total result size will be accurated up + to 10,000. This option will add cost and latency to your request. + - It may adversely impact performance. The limit is 1000,000. + enum: + - TOTAL_RESULT_SIZE_UNSPECIFIED + - ESTIMATED_SIZE + - ACTUAL_SIZE + description: >- + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. type: string - format: int64 - description: Output only. The tenant project number that has been created. - cloudSqlInstances: - items: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + qaSizeLimit: + type: integer description: >- - The CloudSQL instances that are provisioned under the tenant - project. - type: array - iamPolicyBindings: + Experimental, do not use. The limit on the number of documents + returned for the question-answering feature. To enable the + question-answering feature, set [DocumentQuery].is_nl_query to true. + format: int32 + pageToken: + type: string description: >- - The dynamic IAM bindings that are granted under the tenant project. - Note: this should only add new bindings to the project if they don't - exist and the existing bindings won't be affected. - type: array + The token specifying the current offset within search results. See + SearchDocumentsResponse.next_page_token for an explanation of how to + obtain the next set of query results. + pageSize: + type: integer + format: int32 + description: >- + A limit on the number of documents returned in the search results. + Increasing this value above the default value of 10 can increase + search response time. The value can be between 1 and 100. + histogramQueries: + description: >- + An expression specifying a histogram request against matching + documents. Expression syntax is an aggregation function call with + histogram facets and other options. The following aggregation + functions are supported: * `count(string_histogram_facet)`: Count + the number of matching entities for each distinct attribute value. + Data types: * Histogram facet (aka filterable properties): Facet + names with format .. Facets will have the format + of: `a-zA-Z`. If the facet is a child facet, then the parent + hierarchy needs to be specified separated by dots in the prefix + after the schema id. Thus, the format for a multi- level facet is: + .. . Example: + schema123.root_parent_facet.middle_facet.child_facet * + DocumentSchemaId: (with no schema id prefix) to get histograms for + each document type (returns the schema id path, e.g. + projects/12345/locations/us-west/documentSchemas/abc123). Example + expression: * Document type counts: count('DocumentSchemaId') * For + schema id, abc123, get the counts for MORTGAGE_TYPE: + count('abc123.MORTGAGE_TYPE') items: - $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' - tenantProjectId: - description: Output only. The tenant project ID that has been created. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' + type: array + requestMetadata: + description: >- + The meta information collected about the end user, used to enforce + access control and improve the search quality of the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + requireTotalSize: + type: boolean + description: >- + Controls if the search document request requires the return of a + total size of matched documents. See + SearchDocumentsResponse.total_size. Enabling this flag may adversely + impact performance. Hint: If this is used with pagination, set this + flag on the initial query but set this to false on subsequent page + calls (keep the total count locally). Defaults to false. + offset: + format: int32 + description: >- + An integer that specifies the current offset (that is, starting + result location, amongst the documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. The maximum allowed value is 5000. Otherwise an + error is thrown. For example, 0 means to return results starting + from the first matching document, and 10 means to return from the + 11th document. This can be used for pagination, (for example, + pageSize = 10 and offset = 10 means to return from the second page). + type: integer + documentQuery: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' + description: Query used to search against documents (keyword, filters, etc.). + orderBy: type: string - tenantServiceAccounts: + description: >- + The criteria determining how search results are sorted. For + non-empty query, default is `"relevance desc"`. For empty query, + default is `"upload_date desc"`. Supported options are: * + `"relevance desc"`: By relevance descending, as determined by the + API algorithms. * `"upload_date desc"`: By upload date descending. * + `"upload_date"`: By upload date ascending. * `"update_date desc"`: + By last updated date descending. * `"update_date"`: By last updated + date ascending. * `"retrieval_importance desc"`: By retrieval + importance of properties descending. This feature is still under + development, please do not use unless otherwise instructed to do so. + description: Request message for DocumentService.SearchDocuments. + type: object + GoogleCloudDocumentaiV1DocumentPageVisualElement: + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. + id: GoogleCloudDocumentaiV1DocumentPageVisualElement + type: object + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for VisualElement. + type: + description: Type of the VisualElement. + type: string + detectedLanguages: items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity - description: >- - The service account identities (or enabled API service's P4SA) that - are expclicitly created under the tenant project (before JIT - provisioning during enabled API services). + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. type: array + GoogleCloudContentwarehouseV1MapTypeOptions: + properties: {} + id: GoogleCloudContentwarehouseV1MapTypeOptions type: object + description: Configurations for a Map property. GoogleCloudDocumentaiV1DocumentPageMatrix: - type: object id: GoogleCloudDocumentaiV1DocumentPageMatrix + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. properties: rows: + type: integer format: int32 description: Number of rows in the matrix. - type: integer cols: type: integer - description: Number of columns in the matrix. format: int32 - data: - description: The matrix data. - type: string - format: byte + description: Number of columns in the matrix. type: - type: integer description: >- This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + type: integer format: int32 - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - GoogleApiServiceconsumermanagementV1BillingConfig: - id: GoogleApiServiceconsumermanagementV1BillingConfig - description: Describes the billing configuration for a new tenant project. - properties: - billingAccount: - description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. + data: type: string + format: byte + description: The matrix data. type: object - GoogleCloudContentwarehouseV1WeightedSchemaProperty: - description: Specifies the schema property name. + GoogleCloudContentwarehouseV1SearchDocumentsResponse: + description: Response message for DocumentService.SearchDocuments. + type: object + id: GoogleCloudContentwarehouseV1SearchDocumentsResponse properties: - documentSchemaName: - description: The document schema name. + nextPageToken: + description: >- + The token that specifies the starting position of the next page of + results. This field is empty if there are no more results. type: string - propertyNames: + matchingDocuments: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument type: array - description: The property definition names in the schema. - id: GoogleCloudContentwarehouseV1WeightedSchemaProperty - type: object - GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: - id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline - description: >- - The configuration of the Cloud Storage Ingestion with DocAI Processors - pipeline. - properties: - splitClassifyProcessorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' description: >- - The split and classify processor information. The split and classify - result will be used to find a matched extract processor. - skipIngestedDocuments: - type: boolean - description: >- - The flag whether to skip ingested documents. If it is set to true, - documents in Cloud Storage contains key "status" with value - "status=ingested" in custom metadata will be skipped to ingest. - extractProcessorInfos: - description: >- - The extract processors information. One matched extract processor - will be used to process documents based on the classify processor - result. If no classify processor is specified, the first extract - processor will be used. + The document entities that match the specified + SearchDocumentsRequest. + histogramQueryResults: type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - inputPath: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult description: >- - The input Cloud Storage folder. All files under this folder will be - imported to Document Warehouse. Format: `gs:///`. - type: string - processorResultsFolderPath: - type: string + The histogram results that match with the specified + SearchDocumentsRequest.histogram_queries. + metadata: description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - pipelineConfig: + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + totalSize: + format: int32 + type: integer description: >- - Optional. The config for the Cloud Storage Ingestion with DocAI - Processors pipeline. It provides additional customization options to - run the pipeline and can be skipped if it is not applicable. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig + The total number of matched documents which is available only if the + client set SearchDocumentsRequest.require_total_size to `true` or + set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or + `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI + would handle this condition by displaying "of many", for example: + "Displaying 10 of many". + questionAnswer: + type: string + description: Experimental. Question answer from the query against the document. + GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: + description: Response message for DocumentLinkService.ListLinkedSources. + id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest properties: - documents: + pageSize: + type: integer description: >- - The input list of all the resource names of the documents to be - processed. - items: - type: string - type: array - processorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: The DocAI processor to process the documents with. - description: The metadata message for Process-with-DocAi pipeline. - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + The maximum number of document-links to return. The service may + return fewer than this value. If unspecified, at most 50 + document-links will be returned. The maximum value is 1000; values + above 1000 will be coerced to 1000. + format: int32 + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + pageToken: + type: string + description: >- + A page token, received from a previous `ListLinkedSources` call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to `ListLinkedSources` must match the call + that provided the page token. + CloudAiPlatformTenantresourceTenantResource: + description: A collection of tenant resources. + id: CloudAiPlatformTenantresourceTenantResource type: object - GoogleCloudContentwarehouseV1ListRuleSetsResponse: properties: - nextPageToken: - type: string + tenantProjectResources: + items: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - ruleSets: - description: The rule sets from the specified parent. + A list of tenant projects and tenant resources to provision or + deprovision. + type: array + p4ServiceAccounts: + description: A list of P4 service accounts (go/p4sa) to provision or deprovision. type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - id: GoogleCloudContentwarehouseV1ListRuleSetsResponse + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity + GoogleCloudDocumentaiV1DocumentPageImage: + description: Rendered image contents for this page. type: object - description: Response message for RuleSetService.ListRuleSets. - GoogleTypeDateTime: - description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. + id: GoogleCloudDocumentaiV1DocumentPageImage properties: - utcOffset: - description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. - type: string - format: google-duration - timeZone: - $ref: '#/components/schemas/GoogleTypeTimeZone' - description: Time zone. - year: - type: integer - description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - format: int32 - day: - description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. - format: int32 - type: integer - nanos: - description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - type: integer - format: int32 - seconds: - type: integer - format: int32 - description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - month: + width: + description: Width of the image in pixels. format: int32 type: integer - description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. - hours: - type: integer - format: int32 - description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - minutes: - description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. + content: + type: string + description: Raw byte content of the image. + format: byte + height: type: integer format: int32 - type: object - id: GoogleTypeDateTime - GoogleCloudContentwarehouseV1HistogramQuery: - description: The histogram request. - type: object - id: GoogleCloudContentwarehouseV1HistogramQuery - properties: - histogramQuery: + description: Height of the image in pixels. + mimeType: type: string description: >- - An expression specifies a histogram request against matching - documents for searches. See SearchDocumentsRequest.histogram_queries - for details about syntax. - filters: - description: >- - Optional. Filter the result of histogram query by the property - names. It only works with histogram query - count('FilterableProperties'). It is an optional. It will perform - histogram on all the property names for all the document schemas. - Setting this field will have a better performance. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - requirePreciseResultSize: - type: boolean - description: >- - Controls if the histogram query requires the return of a precise - count. Enable this flag may adversely impact performance. Defaults - to true. - CloudAiPlatformTenantresourceGcsBucketConfig: - id: CloudAiPlatformTenantresourceGcsBucketConfig + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + GoogleCloudContentwarehouseV1UpdateRuleSetRequest: + id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest + description: Request message for RuleSetService.UpdateRuleSet. type: object properties: - kmsKeyReference: + ruleSet: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + description: Required. The rule set to update. + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + properties: + type: description: >- - Input/Output [Optional]. The KMS key name or the KMS grant name used - for CMEK encryption. Only set this field when provisioning new GCS - bucket. For existing GCS bucket, this field will be ignored because - CMEK re-encryption is not supported. + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` type: string - viewers: - type: array - description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. - items: - type: string - admins: - items: - type: string - type: array - ttlDays: - type: integer - description: >- - Input/Output [Optional]. Only needed when the content in bucket need - to be garbage collected within some amount of days. - format: int32 - entityName: + confidence: description: >- - Input/Output [Optional]. Only needed for per-entity tenant GCP - resources. During Deprovision API, the on-demand deletion will only - cover the tenant GCP resources with the specified entity name. - type: string - bucketName: - description: >- - Input/Output [Optional]. The name of a GCS bucket with max length of - 63 chars. If not set, a random UUID will be generated as bucket - name. - type: string - description: The identity to configure a GCS bucket. - GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: - properties: - documents: - description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - items: - type: string - type: array - processorResultsFolderPath: - type: string - description: >- - The Cloud Storage folder path used to store the raw results from - processors. Format: `gs:///`. - processorInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' - description: The CDW processor information. - exportFolderPath: - description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. - type: string - id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + format: float + type: number type: object + description: Image Quality Defects + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + GoogleTypeColor: description: >- - The configuration of processing documents in Document Warehouse with - DocAi processors pipeline. - GoogleCloudContentwarehouseV1MapTypeOptions: - type: object - properties: {} - id: GoogleCloudContentwarehouseV1MapTypeOptions - description: Configurations for a Map property. - GoogleCloudContentwarehouseV1EnumTypeOptions: + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... properties: - validationCheckDisabled: - type: boolean + green: + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + type: number + alpha: + type: number description: >- - Make sure the Enum property value provided in the document is in the - possile value list during document creation. The validation check - runs by default. - possibleValues: - items: - type: string - description: Required. List of possible enum values. - type: array - description: Configurations for an enum/categorical property. - type: object - id: GoogleCloudContentwarehouseV1EnumTypeOptions - GoogleCloudContentwarehouseV1ListLinkedSourcesRequest: + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + format: float + red: + format: float + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + blue: + format: float + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + id: GoogleTypeColor type: object - description: Response message for DocumentLinkService.ListLinkedSources. - id: GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + GoogleCloudContentwarehouseV1UpdateDocumentRequest: properties: - pageToken: - type: string - description: >- - A page token, received from a previous `ListLinkedSources` call. - Provide this to retrieve the subsequent page. When paginating, all - other parameters provided to `ListLinkedSources` must match the call - that provided the page token. - pageSize: - type: integer + updateOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' + description: Options for the update operation. + cloudAiDocumentOption: description: >- - The maximum number of document-links to return. The service may - return fewer than this value. If unspecified, at most 50 - document-links will be returned. The maximum value is 1000; values - above 1000 will be coerced to 1000. - format: int32 + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption requestMetadata: - description: >- - The meta information collected about the document creator, used to - enforce access control for the service. $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - GoogleCloudContentwarehouseV1TextTypeOptions: - description: Configurations for a text property. - properties: {} - id: GoogleCloudContentwarehouseV1TextTypeOptions - type: object - GoogleCloudContentwarehouseV1PropertyArray: - id: GoogleCloudContentwarehouseV1PropertyArray - description: Property values. - properties: - properties: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - description: List of property values. + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Required. The document to update. type: object - GoogleCloudContentwarehouseV1InvalidRule: + id: GoogleCloudContentwarehouseV1UpdateDocumentRequest + description: Request message for DocumentService.UpdateDocument. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: type: object + description: Represents the page header associated with the chunk. properties: - error: + pageSpan: + description: Page span of the header. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + text: + description: Header in text format. type: string - description: Validation error on a parsed expression. - rule: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: Triggered rule. - id: GoogleCloudContentwarehouseV1InvalidRule - description: A triggered rule that failed the validation check(s) after parsing. - GoogleCloudContentwarehouseV1CustomWeightsMetadata: - description: To support the custom weighting across document schemas. - properties: - weightedSchemaProperties: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty - type: array - description: >- - List of schema and property name. Allows a maximum of 10 schemas to - be specified for relevance boosting. - type: object - id: GoogleCloudContentwarehouseV1CustomWeightsMetadata - GoogleCloudDocumentaiV1DocumentPageTable: - id: GoogleCloudDocumentaiV1DocumentPageTable - type: object - description: A table representation similar to HTML table structure. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + GoogleCloudDocumentaiV1DocumentPageBlock: properties: + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + deprecated: true + description: The history of this annotation. + layout: + description: Layout for Block. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' detectedLanguages: type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage description: A list of detected languages together with confidence. - bodyRows: - description: Body rows of the table. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Table. - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this table. - headerRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: Header rows of the table. - CloudAiPlatformTenantresourceTenantServiceAccountIdentity: + id: GoogleCloudDocumentaiV1DocumentPageBlock + type: object + description: >- + A block has a set of lines (collected into paragraphs) that have a + common line-spacing and orientation. + GoogleCloudContentwarehouseV1InitializeProjectResponse: properties: - serviceName: + message: type: string - description: >- - Input/Output [Required]. The service that the service account - belongs to. (e.g. cloudbuild.googleapis.com for GCB service - accounts) - serviceAccountEmail: - description: Output only. The email address of the generated service account. - type: string - id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity - description: >- - The identity of service accounts that have been explicitly created under - tenant projects. - type: object - GoogleCloudContentwarehouseV1RuleActionsPair: - type: object - id: GoogleCloudContentwarehouseV1RuleActionsPair - description: Represents a rule and outputs of associated actions. - properties: - rule: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: Represents the rule. - actionOutputs: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' - description: Outputs of executing the actions associated with the above rule. - type: array - GoogleRpcStatus: - properties: - message: + description: The message of the project initialization process. + state: + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING + enumDescriptions: + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. + description: The state of the project initialization process. type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - type: object - GoogleCloudDocumentaiV1DocumentPageLine: - id: GoogleCloudDocumentaiV1DocumentPageLine + description: Response message for projectService.InitializeProject + id: GoogleCloudContentwarehouseV1InitializeProjectResponse type: object - properties: - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this annotation. - layout: - description: Layout for Line. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - GoogleCloudDocumentaiV1DocumentPageDimension: - description: Dimension for the page. - properties: - height: - description: Page height. - format: float - type: number - width: - description: Page width. - type: number - format: float - unit: - type: string - description: Dimension unit. - id: GoogleCloudDocumentaiV1DocumentPageDimension + GoogleCloudContentwarehouseV1ListSynonymSetsResponse: + description: Response message for SynonymSetService.ListSynonymSets. type: object - GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: properties: - propertyNames: - items: - type: string - description: >- - It is optional. It will perform histogram for all the property names - if it is not set. The properties need to be defined with the - is_filterable flag set to true and the name of the property should - be in the format: "schemaId.propertyName". The property needs to be - defined in the schema. Example: the schema id is abc. Then the name - of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". + synonymSets: type: array - documentSchemas: + description: The synonymSets from the specified parent. items: - type: string - type: array - description: >- - This filter specifies the exact document schema(s) - Document.document_schema_name to run histogram query against. It is - optional. It will perform histogram for property names for all the - document schemas if it is not set. At most 10 document schema names - are allowed. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - yAxis: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + nextPageToken: description: >- - By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is - not set. - enum: - - HISTOGRAM_YAXIS_DOCUMENT - - HISTOGRAM_YAXIS_PROPERTY + A page token, received from a previous `ListSynonymSets` call. + Provide this to retrieve the subsequent page. type: string - enumDescriptions: - - Count the documents per property name. - - Count the properties per property name. - type: object - id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter - GoogleCloudContentwarehouseV1MapProperty: - description: >- - Map property value. Represents a structured entries of key value pairs, - consisting of field names which map to dynamically typed values. - properties: - fields: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' - description: Unordered map of dynamically typed values. - type: object - id: GoogleCloudContentwarehouseV1MapProperty - GoogleCloudContentwarehouseV1ActionExecutorOutput: - id: GoogleCloudContentwarehouseV1ActionExecutorOutput - type: object - properties: - ruleActionsPairs: - description: List of rule and corresponding actions result. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' - type: array - description: Represents the output of the Action Executor. + id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + description: Font and other text style attributes. properties: + strikeout: + type: boolean + description: >- + Whether the text is strikethrough. This feature is not supported + yet. + letterSpacing: + type: number + description: Letter spacing in points. + format: double superscript: description: >- Whether the text is a superscript. This feature is not supported yet. type: boolean - handwritten: + fontSize: + format: int32 + description: Font size in points (`1` point is `¹⁄₇₂` inches). + type: integer + textColor: + description: Color of the text. + $ref: '#/components/schemas/GoogleTypeColor' + smallcaps: + description: >- + Whether the text is in small caps. This feature is not supported + yet. type: boolean + handwritten: description: Whether the text is handwritten. + type: boolean fontWeight: - type: integer + format: int32 description: >- TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. - format: int32 - italic: + type: integer + underlined: + description: Whether the text is underlined. type: boolean + italic: description: Whether the text is italic. - underlined: type: boolean - description: Whether the text is underlined. + backgroundColor: + description: Color of the background. + $ref: '#/components/schemas/GoogleTypeColor' pixelFontSize: - format: double - type: number description: >- Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. - subscript: - type: boolean - description: Whether the text is a subscript. This feature is not supported yet. + type: number + format: double fontType: description: Name or style of the font. type: string - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - fontSize: - description: Font size in points (`1` point is `¹⁄₇₂` inches). - format: int32 - type: integer - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. bold: type: boolean description: >- Whether the text is bold (equivalent to font_weight is at least `700`). - strikeout: + subscript: type: boolean + description: Whether the text is a subscript. This feature is not supported yet. + type: object + GoogleCloudContentwarehouseV1TimestampValue: + properties: + textValue: description: >- - Whether the text is strikethrough. This feature is not supported - yet. - letterSpacing: - type: number - format: double - description: Letter spacing in points. - smallcaps: - description: >- - Whether the text is in small caps. This feature is not supported - yet. - type: boolean + The string must represent a valid instant in UTC and is parsed using + java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. + "2013-09-29T18:46:19Z" + type: string + timestampValue: + format: google-datetime + type: string + description: Timestamp value + description: Timestamp value type. type: object - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Font and other text style attributes. - GoogleCloudDocumentaiV1DocumentPageImage: + id: GoogleCloudContentwarehouseV1TimestampValue + GoogleCloudContentwarehouseV1MergeFieldsOptions: type: object - id: GoogleCloudDocumentaiV1DocumentPageImage properties: - mimeType: - type: string - description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - height: - format: int32 - type: integer - description: Height of the image in pixels. - width: - description: Width of the image in pixels. - format: int32 - type: integer - content: - type: string - description: Raw byte content of the image. - format: byte - description: Rendered image contents for this page. - GoogleCloudContentwarehouseV1ExportToCdwPipeline: - properties: - documents: - items: - type: string + replaceRepeatedFields: description: >- - The list of all the resource names of the documents to be processed. - Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - type: array - exportFolderPath: - type: string + When merging repeated fields, the default behavior is to append + entries from the source repeated field to the destination repeated + field. If you instead want to keep only the entries from the source + repeated field, set this flag to true. If you want to replace a + repeated field within a message field on the destination message, + you must set both replace_repeated_fields and replace_message_fields + to true, otherwise the repeated fields will be appended. + type: boolean + replaceMessageFields: description: >- - The Cloud Storage folder path used to store the exported documents - before being sent to CDW. Format: `gs:///`. - trainingSplitRatio: - format: float - type: number + When merging message fields, the default behavior is to merge the + content of two message fields together. If you instead want to use + the field from the source message to replace the corresponding field + in the destination message, set this flag to true. When this flag is + set, specified submessage fields that are missing in source will be + cleared in destination. + type: boolean + id: GoogleCloudContentwarehouseV1MergeFieldsOptions + description: Options for merging updated fields. + GoogleCloudContentwarehouseV1GetDocumentRequest: + description: Request message for DocumentService.GetDocument. + id: GoogleCloudContentwarehouseV1GetDocumentRequest + properties: + requestMetadata: description: >- - Ratio of training dataset split. When importing into Document AI - Workbench, documents will be automatically split into training and - test split category with the specified ratio. This field is required - if doc_ai_dataset is set. - docAiDataset: + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + type: object + GoogleCloudContentwarehouseV1InitializeProjectRequest: + id: GoogleCloudContentwarehouseV1InitializeProjectRequest + description: Request message for projectService.InitializeProject + properties: + enableCalUserEmailLogging: + type: boolean + description: Optional. Whether to enable CAL user email logging. + kmsKey: description: >- - Optional. The CDW dataset resource name. This field is optional. If - not set, the documents will be exported to Cloud Storage only. - Format: - projects/{project}/locations/{location}/processors/{processor}/dataset + Optional. The KMS key used for CMEK encryption. It is required that + the kms key is in the same region as the endpoint. The same key will + be used for all provisioned resources, if encryption is available. + If the kms_key is left empty, no encryption will be enforced. type: string - description: >- - The configuration of exporting documents from the Document Warehouse to - CDW pipeline. - id: GoogleCloudContentwarehouseV1ExportToCdwPipeline - type: object - GoogleCloudDocumentaiV1DocumentPageFormField: - id: GoogleCloudDocumentaiV1DocumentPageFormField - description: A form field detected on the page. + documentCreatorDefaultRole: + enumDescriptions: + - Unspecified, will be default to document admin role. + - >- + Document Admin, same as + contentwarehouse.googleapis.com/documentAdmin. + - >- + Document Editor, same as + contentwarehouse.googleapis.com/documentEditor. + - >- + Document Viewer, same as + contentwarehouse.googleapis.com/documentViewer. + type: string + enum: + - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED + - DOCUMENT_ADMIN + - DOCUMENT_EDITOR + - DOCUMENT_VIEWER + description: Optional. The default role for the person who create a document. + databaseType: + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + description: Required. The type of database used to store customer data + enumDeprecated: + - false + - false + - true + type: string + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + accessControlMode: + type: string + description: Required. The access control mode for accessing the customer data + enumDescriptions: + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI type: object + GoogleCloudContentwarehouseV1ActionOutput: properties: - fieldValue: - description: Layout for the FormField value. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - valueType: - description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` + actionId: type: string - correctedKeyText: + description: ID of the action. + outputMessage: type: string - description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. - fieldName: - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - nameDetectedLanguages: - description: A list of detected languages for name together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - correctedValueText: - description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. + description: Action execution output message. + actionState: type: string - valueDetectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages for value together with confidence. - GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: + enum: + - UNKNOWN + - ACTION_SUCCEEDED + - ACTION_FAILED + - ACTION_TIMED_OUT + - ACTION_PENDING + description: State of an action. + enumDescriptions: + - The unknown state. + - State indicating action executed successfully. + - State indicating action failed. + - State indicating action timed out. + - State indicating action is pending. + id: GoogleCloudContentwarehouseV1ActionOutput type: object - description: Response message for DocumentSchemaService.ListDocumentSchemas. + description: Represents the result of executing an action. + GoogleCloudContentwarehouseV1ListDocumentSchemasResponse: properties: nextPageToken: type: string @@ -837,4071 +751,4381 @@ components: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. documentSchemas: - description: The document schemas from the specified parent. type: array items: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + description: The document schemas from the specified parent. + description: Response message for DocumentSchemaService.ListDocumentSchemas. id: GoogleCloudContentwarehouseV1ListDocumentSchemasResponse - GoogleIamV1Policy: - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + type: object + CloudAiPlatformTenantresourceGcsBucketConfig: + id: CloudAiPlatformTenantresourceGcsBucketConfig + type: object properties: - version: + admins: + type: array + items: + type: string + viewers: + description: Input/Output [Required]. IAM roles (viewer/admin) put on the bucket. + type: array + items: + type: string + ttlDays: format: int32 - type: integer description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - etag: + Input/Output [Optional]. Only needed when the content in bucket need + to be garbage collected within some amount of days. + type: integer + kmsKeyReference: + type: string description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - format: byte + Input/Output [Optional]. The KMS key name or the KMS grant name used + for CMEK encryption. Only set this field when provisioning new GCS + bucket. For existing GCS bucket, this field will be ignored because + CMEK re-encryption is not supported. + bucketName: type: string - bindings: - type: array description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - auditConfigs: + Input/Output [Optional]. The name of a GCS bucket with max length of + 63 chars. If not set, a random UUID will be generated as bucket + name. + entityName: + type: string + description: >- + Input/Output [Optional]. Only needed for per-entity tenant GCP + resources. During Deprovision API, the on-demand deletion will only + cover the tenant GCP resources with the specified entity name. + description: The identity to configure a GCS bucket. + GoogleCloudContentwarehouseV1IntegerArray: + properties: + values: + description: List of integer values. items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' + format: int32 + type: integer type: array - description: Specifies cloud audit logging configuration for this policy. - id: GoogleIamV1Policy type: object - GoogleCloudDocumentaiV1DocumentStyleFontSize: - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - type: object - description: Font size with unit. + id: GoogleCloudContentwarehouseV1IntegerArray + description: Integer values. + GoogleCloudContentwarehouseV1EnumTypeOptions: + description: Configurations for an enum/categorical property. properties: - size: - format: float - type: number - description: Font size for the text. - unit: + possibleValues: + items: + type: string + type: array + description: Required. List of possible enum values. + validationCheckDisabled: + type: boolean description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - type: string - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: - description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset - type: object - properties: - startIndex: - type: string - format: int64 - description: TextSegment start UTF-8 char index in the Document.text. - endIndex: - format: int64 - description: TextSegment half open end UTF-8 char index in the Document.text. - type: string - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - GoogleCloudContentwarehouseV1RequestMetadata: - id: GoogleCloudContentwarehouseV1RequestMetadata + Make sure the Enum property value provided in the document is in the + possile value list during document creation. The validation check + runs by default. + id: GoogleCloudContentwarehouseV1EnumTypeOptions type: object - properties: - userInfo: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: Provides user unique identification and groups information. - description: Meta information is used to improve the performance of the service. - GoogleCloudDocumentaiV1DocumentEntityRelation: - id: GoogleCloudDocumentaiV1DocumentEntityRelation + CloudAiPlatformTenantresourceIamPolicyBinding: type: object properties: - relation: - description: Relationship description. + members: + description: >- + Input/Output [Required]. The member service accounts with the roles + above. Note: placeholders are same as the resource above. + items: + type: string + type: array + resource: type: string - objectId: + description: >- + Input/Output [Required]. The resource name that will be accessed by + members, which also depends on resource_type. Note: placeholders are + supported in resource names. For example, ${tpn} will be used when + the tenant project number is not ready. + role: type: string - description: Object entity id. - subjectId: + description: Input/Output [Required]. The role for members below. + resourceType: type: string - description: Subject entity id. - description: Relationship between Entities. - GoogleIamV1AuditLogConfig: - type: object - properties: - logType: + description: >- + Input/Output [Required]. Specifies the type of resource that will be + accessed by members. enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - description: The log type that this config enables. - type: string + - RESOURCE_TYPE_UNSPECIFIED + - PROJECT + - SERVICE_ACCOUNT + - GCS_BUCKET + - SERVICE_CONSUMER + - AR_REPO enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - exemptedMembers: - items: - type: string + - '' + - >- + The value of resource field is the ID or number of a project. + Format is + - >- + The value of resource field is the resource name of a service + account. Format is projects//serviceAccounts/ + - >- + The value of resource field is the name of a GCS bucket (not its + resource name). Format is . + - >- + The value of resource field is the resource name of a service + consumer. Format is services//consumers/ + - >- + The value of the resource field is the AR Image Uri which + identifies an AR REPO. Allowed formats are: /// ///: ///@ + id: CloudAiPlatformTenantresourceIamPolicyBinding + description: >- + The dynamic IAM bindings to be granted after tenant projects are + created. + GoogleCloudContentwarehouseV1QAResult: + id: GoogleCloudContentwarehouseV1QAResult + type: object + properties: + confidenceScore: description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. + The calibrated confidence score for this document, in the range [0., + 1.]. This represents the confidence level for whether the returned + document and snippet answers the user's query. + type: number + format: float + highlights: + description: Highlighted sections in the snippet. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight type: array - id: GoogleIamV1AuditLogConfig + description: Additional result info for the question-answering feature. + GoogleCloudContentwarehouseV1ResponseMetadata: description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: - id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse + Additional information returned to client, such as debugging + information. + properties: + requestId: + type: string + description: >- + A unique id associated with this call. This id is logged for + tracking purpose. + id: GoogleCloudContentwarehouseV1ResponseMetadata type: object - description: Response message for projectService.InitializeProject + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + type: object + description: Human Review information of the document. properties: - message: + stateMessage: + description: >- + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. type: string - description: The message of the project initialization process. state: - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. - description: The state of the project initialization process. type: string - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING - GoogleTypeTimeZone: - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + GoogleCloudContentwarehouseV1DocumentReference: properties: - version: - description: Optional. IANA Time Zone Database version number, e.g. "2019a". + documentIsFolder: + type: boolean + description: The document type of the document being referenced. + deleteTime: + readOnly: true + description: Output only. The time when the document is deleted. type: string - id: + format: google-datetime + updateTime: + readOnly: true type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - type: object - id: GoogleTypeTimeZone - GoogleCloudDocumentaiV1DocumentPageVisualElement: - id: GoogleCloudDocumentaiV1DocumentPageVisualElement - properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - layout: - description: Layout for VisualElement. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - type: - description: Type of the VisualElement. + description: Output only. The time when the document is last updated. + format: google-datetime + documentIsLegalHoldFolder: + description: Document is a folder with legal hold. + type: boolean + documentName: + description: Required. Name of the referenced document. + type: string + snippet: + type: string + description: >- + Stores the subset of the referenced document's content. This is + useful to allow user peek the information of the referenced + document. + createTime: + format: google-datetime + readOnly: true + description: Output only. The time when the document is created. + type: string + documentIsRetentionFolder: + description: Document is a folder with retention policy. + type: boolean + displayName: + description: >- + display_name of the referenced document; this name does not need to + be consistent to the display_name in the Document proto, depending + on the ACL constraint. type: string - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. type: object - GoogleCloudContentwarehouseV1CreateDocumentRequest: + id: GoogleCloudContentwarehouseV1DocumentReference + description: References to the documents. + GoogleCloudContentwarehouseV1ProcessorInfo: + description: The DocAI processor information. + type: object + id: GoogleCloudContentwarehouseV1ProcessorInfo properties: - cloudAiDocumentOption: + documentType: + description: The processor will process the documents with this document type. + type: string + schemaName: + type: string description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - document: - description: Required. The document to create. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + The Document schema resource name. All documents processed by this + processor will use this schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + processorName: + type: string + description: >- + The processor resource name. Format is + `projects/{project}/locations/{location}/processors/{processor}`, or + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + GoogleCloudContentwarehouseV1DeleteDocumentRequest: + properties: requestMetadata: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' description: >- The meta information collected about the end user, used to enforce access control for the service. - createMask: - format: google-fieldmask - description: >- - Field mask for creating Document fields. If mask path is empty, it - means all fields are masked. For the `FieldMask` definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. - type: string - policy: - description: >- - Default document policy during creation. This refers to an Identity - and Access (IAM) policy, which specifies access controls for the - Document. Conditions defined in the policy will be ignored. - $ref: '#/components/schemas/GoogleIamV1Policy' - description: Request message for DocumentService.CreateDocument. - id: GoogleCloudContentwarehouseV1CreateDocumentRequest - type: object - GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: - description: Request message for DocumentSchemaService.UpdateDocumentSchema. + description: Request message for DocumentService.DeleteDocument. + id: GoogleCloudContentwarehouseV1DeleteDocumentRequest type: object - properties: - documentSchema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' - description: Required. The document schema to update with. - id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest - GoogleCloudContentwarehouseV1HistogramQueryResult: - description: Histogram result that matches HistogramQuery specified in searches. + GoogleCloudContentwarehouseV1CloudAIDocumentOption: type: object - id: GoogleCloudContentwarehouseV1HistogramQueryResult + id: GoogleCloudContentwarehouseV1CloudAIDocumentOption + description: Request Option for processing Cloud AI Document in CW Document. properties: - histogramQuery: - type: string - description: Requested histogram expression. - histogram: + customizedEntitiesPropertiesConversions: + description: If set, only selected entities will be converted to properties. additionalProperties: - format: int64 type: string type: object - description: >- - A map from the values of the facet associated with distinct values - to the number of matching entries with corresponding value. The key - format is: * (for string histogram) string values stored in the - field. - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + enableEntitiesConversions: + description: Whether to convert all the entities to properties. + type: boolean + GoogleCloudContentwarehouseV1Action: properties: - confidence: - type: number - format: float - description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - page: - format: int64 - description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - type: string - layoutId: - type: string - deprecated: true - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - layoutType: - description: >- - Optional. The type of the layout element that is being referenced if - any. + dataValidation: + description: Action triggering data validation operations. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction + actionId: + description: ID of the action. Managed internally. type: string - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - boundingPoly: - description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + dataUpdate: + description: Action triggering data update operations. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' + removeFromFolderAction: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction + description: Action removing a document from a folder. + deleteDocumentAction: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction + description: Action deleting the document. + accessControl: + description: Action triggering access control operations. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction + addToFolder: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' + description: Action triggering create document link operation. + publishToPubSub: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' + description: Action publish to Pub/Sub operation. + description: Represents the action triggered by Rule Engine when the rule is true. + id: GoogleCloudContentwarehouseV1Action type: object - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - description: Represents a weak reference to a page element within a document. - GoogleCloudContentwarehouseV1IngestPipelineConfig: + GoogleTypeDate: + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp properties: - folder: - type: string + month: + type: integer + format: int32 description: >- - Optional. The name of the folder to which all ingested documents - will be linked during ingestion process. Format is - `projects/{project}/locations/{location}/documents/{folder_id}` - cloudFunction: - type: string + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + year: description: >- - The Cloud Function resource name. The Cloud Function needs to live - inside consumer project and is accessible to Document AI Warehouse - P4SA. Only Cloud Functions V2 is supported. Cloud function execution - should complete within 5 minutes or this file ingestion may fail due - to timeout. Format: - `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}` - The following keys are available the request json payload. * - display_name * properties * plain_text * reference_id * - document_schema_name * raw_document_path * raw_document_file_type - The following keys from the cloud function json response payload - will be ingested to the Document AI Warehouse as part of Document - proto content and/or related information. The original values will - be overridden if any key is present in the response. * display_name - * properties * plain_text * document_acl_policy * folder - enableDocumentTextExtraction: + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + type: integer + day: + type: integer description: >- - The document text extraction enabled flag. If the flag is set to - true, DWH will perform text extraction on the raw document. - type: boolean - documentAclPolicy: - $ref: '#/components/schemas/GoogleIamV1Policy' + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + id: GoogleTypeDate + type: object + GoogleCloudDocumentaiV1DocumentPage: + id: GoogleCloudDocumentaiV1DocumentPage + type: object + description: A page in a Document. + properties: + lines: description: >- - The document level acl policy config. This refers to an Identity and - Access (IAM) policy, which specifies access controls for all - documents ingested by the pipeline. The role and members under the - policy needs to be specified. The following roles are supported for - document level acl control: * roles/contentwarehouse.documentAdmin * - roles/contentwarehouse.documentEditor * - roles/contentwarehouse.documentViewer The following members are - supported for document level acl control: * - user:user-email@example.com * group:group-email@example.com Note - that for documents searched with LLM, only single level user or - group acl check is supported. - description: The ingestion pipeline config. + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + paragraphs: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' + type: array + description: >- + A list of visually detected text paragraphs on the page. A + collection of lines that a human would perceive as a paragraph. + blocks: + type: array + description: >- + A list of visually detected text blocks on the page. A block has a + set of lines (collected into paragraphs) that have a common + line-spacing and orientation. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + dimension: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + description: Physical dimension of the page. + pageNumber: + format: int32 + type: integer + description: >- + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. + formFields: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + description: A list of visually detected form fields on the page. + symbols: + type: array + description: A list of visually detected symbols on the page. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + tokens: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + description: A list of visually detected tokens on the page. + provenance: + deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this page. + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + visualElements: + type: array + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + imageQualityScores: + description: Image quality scores. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + detectedBarcodes: + type: array + description: A list of detected barcodes. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + tables: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + description: A list of visually detected tables on the page. + image: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + description: >- + Rendered image for this page. This image is preprocessed to remove + any skew, rotation, and distortions such that the annotation + bounding boxes can be upright and axis-aligned. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the page. + transforms: + description: >- + Transformation matrices that were applied to the original document + image to produce Page.image. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + GoogleCloudDocumentaiV1DocumentTextAnchor: + description: Text reference indexing into the Document.text. + id: GoogleCloudDocumentaiV1DocumentTextAnchor + properties: + textSegments: + type: array + description: The text segments from the Document.text. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + content: + description: >- + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. + type: string type: object - id: GoogleCloudContentwarehouseV1IngestPipelineConfig GoogleCloudDocumentaiV1DocumentPageImageQualityScores: - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + description: Image quality scores for the page image. + type: object properties: qualityScore: + type: number format: float description: >- The overall quality score. Range `[0, 1]` where `1` is perfect quality. - type: number detectedDefects: description: A list of detected defects. - type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + type: array + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: + properties: + pageEnd: + format: int32 + type: integer + description: Page where block ends in the document. + pageStart: + description: Page where block starts in the document. + type: integer + format: int32 type: object - description: Image quality scores for the page image. - GoogleCloudContentwarehouseV1Property: + description: Represents where the block starts and ends in the document. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig properties: - dateTimeValues: - description: >- - Date time property values. It is not supported by CMEK compliant - deployment. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' - floatValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' - description: Float property values. - mapProperty: - description: Map property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' - timestampValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' - description: >- - Timestamp property values. It is not supported by CMEK compliant - deployment. - name: + service: description: >- - Required. Must match the name of a PropertyDefinition in the - DocumentSchema. + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. type: string - integerValues: - description: Integer property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' - enumValues: - description: Enum property values. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' - propertyValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' - description: Nested structured data property values. - textValues: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' - description: String/text property values. - id: GoogleCloudContentwarehouseV1Property + auditLogConfigs: + type: array + description: The configuration for logging of each type of permission. + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' type: object - description: Property of a document. - GoogleCloudContentwarehouseV1Value: - id: GoogleCloudContentwarehouseV1Value description: >- - `Value` represents a dynamically typed value which can be either be a - float, a integer, a string, or a datetime value. A producer of value is - expected to set one of these variants. Absence of any variant indicates - an error. + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: properties: - booleanValue: - description: Represents a boolean value. - type: boolean - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: Represents a datetime value. - enumValue: - description: Represents an enum value. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' - floatValue: - type: number - description: Represents a float value. - format: float - stringValue: - type: string - description: Represents a string value. - timestampValue: - description: Represents a timestamp value. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - intValue: - type: integer - description: Represents a integer value. - format: int32 - type: object - GoogleCloudContentwarehouseV1CloudAIDocumentOption: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest type: object - description: Request Option for processing Cloud AI Document in CW Document. - id: GoogleCloudContentwarehouseV1CloudAIDocumentOption - properties: - enableEntitiesConversions: - type: boolean - description: Whether to convert all the entities to properties. - customizedEntitiesPropertiesConversions: - additionalProperties: - type: string - description: If set, only selected entities will be converted to properties. - type: object - GoogleCloudContentwarehouseV1Action: + description: Request message for DocumentLinkService.DeleteDocumentLink. + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: properties: - deleteDocumentAction: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentAction - description: Action deleting the document. - publishToPubSub: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PublishAction' - description: Action publish to Pub/Sub operation. - removeFromFolderAction: - description: Action removing a document from a folder. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RemoveFromFolderAction - actionId: + startIndex: type: string - description: ID of the action. Managed internally. - dataValidation: - description: Action triggering data validation operations. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DataValidationAction - addToFolder: - description: Action triggering create document link operation. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1AddToFolderAction' - accessControl: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1AccessControlAction - description: Action triggering access control operations. - dataUpdate: - description: Action triggering data update operations. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DataUpdateAction' + format: int64 + description: TextSegment start UTF-8 char index in the Document.text. + endIndex: + format: int64 + type: string + description: TextSegment half open end UTF-8 char index in the Document.text. + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + type: object + description: >- + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset + GoogleCloudDocumentaiV1DocumentRevision: + id: GoogleCloudDocumentaiV1DocumentRevision type: object - description: Represents the action triggered by Rule Engine when the rule is true. - id: GoogleCloudContentwarehouseV1Action - GoogleCloudContentwarehouseV1SearchDocumentsRequest: properties: - offset: - format: int32 + parent: + type: array + deprecated: true + items: + type: integer + format: int32 description: >- - An integer that specifies the current offset (that is, starting - result location, amongst the documents deemed by the API as - relevant) in search results. This field is only considered if - page_token is unset. The maximum allowed value is 5000. Otherwise an - error is thrown. For example, 0 means to return results starting - from the first matching document, and 10 means to return from the - 11th document. This can be used for pagination, (for example, - pageSize = 10 and offset = 10 means to return from the second page). - type: integer - pageToken: + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + id: description: >- - The token specifying the current offset within search results. See - SearchDocumentsResponse.next_page_token for an explanation of how to - obtain the next set of query results. + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. type: string - totalResultSize: + createTime: type: string - enumDescriptions: - - Total number calculation will be skipped. - - >- - Estimate total number. The total result size will be accurated up - to 10,000. This option will add cost and latency to your request. - - It may adversely impact performance. The limit is 1000,000. + format: google-datetime description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. - enum: - - TOTAL_RESULT_SIZE_UNSPECIFIED - - ESTIMATED_SIZE - - ACTUAL_SIZE - orderBy: + The time that the revision was created, internally generated by doc + proto storage at the time of create. + humanReview: + description: Human Review information of this revision. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + parentIds: + items: + type: string + description: >- + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. + type: array + processor: type: string description: >- - The criteria determining how search results are sorted. For - non-empty query, default is `"relevance desc"`. For empty query, - default is `"upload_date desc"`. Supported options are: * - `"relevance desc"`: By relevance descending, as determined by the - API algorithms. * `"upload_date desc"`: By upload date descending. * - `"upload_date"`: By upload date ascending. * `"update_date desc"`: - By last updated date descending. * `"update_date"`: By last updated - date ascending. * `"retrieval_importance desc"`: By retrieval - importance of properties descending. This feature is still under - development, please do not use unless otherwise instructed to do so. - requireTotalSize: - type: boolean + If the annotation was made by processor identify the processor by + its resource name. + agent: + type: string description: >- - Controls if the search document request requires the return of a - total size of matched documents. See - SearchDocumentsResponse.total_size. Enabling this flag may adversely - impact performance. Hint: If this is used with pagination, set this - flag on the initial query but set this to false on subsequent page - calls (keep the total count locally). Defaults to false. - requestMetadata: + If the change was made by a person specify the name or id of that + person. + description: Contains past or forward revisions of this document. + GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: + properties: {} + description: Metadata object for CreateDocument request (currently empty). + type: object + id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata + GoogleCloudContentwarehouseV1DateTimeTypeOptions: + id: GoogleCloudContentwarehouseV1DateTimeTypeOptions + description: Configurations for a date time property. + properties: {} + type: object + GoogleCloudContentwarehouseV1FetchAclResponse: + type: object + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: The IAM policy. + metadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- - The meta information collected about the end user, used to enforce - access control and improve the search quality of the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - qaSizeLimit: + Additional information for the API invocation, such as the request + tracking id. + description: Response message for DocumentService.FetchAcl. + id: GoogleCloudContentwarehouseV1FetchAclResponse + GoogleTypeMoney: + properties: + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + units: description: >- - Experimental, do not use. The limit on the number of documents - returned for the question-answering feature. To enable the - question-answering feature, set [DocumentQuery].is_nl_query to true. - format: int32 - type: integer - pageSize: - type: integer + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + type: string + format: int64 + nanos: description: >- - A limit on the number of documents returned in the search results. - Increasing this value above the default value of 10 can increase - search response time. The value can be between 1 and 100. + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer format: int32 - histogramQueries: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1HistogramQuery' - description: >- - An expression specifying a histogram request against matching - documents. Expression syntax is an aggregation function call with - histogram facets and other options. The following aggregation - functions are supported: * `count(string_histogram_facet)`: Count - the number of matching entities for each distinct attribute value. - Data types: * Histogram facet (aka filterable properties): Facet - names with format .. Facets will have the format - of: `a-zA-Z`. If the facet is a child facet, then the parent - hierarchy needs to be specified separated by dots in the prefix - after the schema id. Thus, the format for a multi- level facet is: - .. . Example: - schema123.root_parent_facet.middle_facet.child_facet * - DocumentSchemaId: (with no schema id prefix) to get histograms for - each document type (returns the schema id path, e.g. - projects/12345/locations/us-west/documentSchemas/abc123). Example - expression: * Document type counts: count('DocumentSchemaId') * For - schema id, abc123, get the counts for MORTGAGE_TYPE: - count('abc123.MORTGAGE_TYPE') - documentQuery: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentQuery' - description: Query used to search against documents (keyword, filters, etc.). - id: GoogleCloudContentwarehouseV1SearchDocumentsRequest - description: Request message for DocumentService.SearchDocuments. + description: Represents an amount of money with its currency type. + id: GoogleTypeMoney type: object - GoogleCloudContentwarehouseV1RunPipelineMetadata: + GoogleCloudContentwarehouseV1WeightedSchemaProperty: properties: - exportToCdwPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata - description: The pipeline metadata for Export-to-CDW pipeline. - individualDocumentStatuses: - description: The list of response details of each document. - type: array + documentSchemaName: + description: The document schema name. + type: string + propertyNames: + description: The property definition names in the schema. items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus - failedFileCount: - description: Number of files that have failed at some point in the pipeline. + type: string + type: array + type: object + id: GoogleCloudContentwarehouseV1WeightedSchemaProperty + description: Specifies the schema property name. + CloudAiPlatformTenantresourceTenantServiceAccountIdentity: + id: CloudAiPlatformTenantresourceTenantServiceAccountIdentity + properties: + serviceAccountEmail: + type: string + description: Output only. The email address of the generated service account. + serviceName: + description: >- + Input/Output [Required]. The service that the service account + belongs to. (e.g. cloudbuild.googleapis.com for GCB service + accounts) + type: string + type: object + description: >- + The identity of service accounts that have been explicitly created under + tenant projects. + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: + type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + properties: + pageEnd: type: integer + description: Page where chunk ends in the document. format: int32 - userInfo: - description: User unique identification and groups information. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - processWithDocAiPipelineMetadata: - description: The pipeline metadata for Process-with-DocAi pipeline. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata - gcsIngestPipelineMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata - description: The pipeline metadata for GcsIngest pipeline. - totalFileCount: - description: Number of files that were processed by the pipeline. + pageStart: type: integer + description: Page where chunk starts in the document. format: int32 - description: Metadata message of RunPipeline method. - type: object - id: GoogleCloudContentwarehouseV1RunPipelineMetadata - GoogleCloudContentwarehouseV1RuleEngineOutput: - id: GoogleCloudContentwarehouseV1RuleEngineOutput - description: >- - Records the output of Rule Engine including rule evaluation and actions - result. + description: Represents where the chunk starts and ends in the document. + GoogleCloudContentwarehouseV1DataUpdateAction: + id: GoogleCloudContentwarehouseV1DataUpdateAction + properties: + entries: + type: object + additionalProperties: + type: string + description: >- + Map of (K, V) -> (valid name of the field, new value of the field) + E.g., ("age", "60") entry triggers update of field age with a value + of 60. If the field is not present then new entry is added. During + update action execution, value strings will be casted to appropriate + types. + description: Represents the action responsible for properties update operations. type: object + GoogleIamV1Policy: properties: - documentName: - type: string + etag: + format: byte description: >- - Name of the document against which the rules and actions were - evaluated. - ruleEvaluatorOutput: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + type: string + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + version: + format: int32 + type: integer description: >- - Output from Rule Evaluator containing matched, unmatched and invalid - rules. - actionExecutorOutput: + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + bindings: + items: + $ref: '#/components/schemas/GoogleIamV1Binding' description: >- - Output from Action Executor containing rule and corresponding - actions execution result. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput - GoogleCloudContentwarehouseV1UpdateOptions: + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + id: GoogleIamV1Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + GoogleCloudContentwarehouseV1DataValidationAction: properties: - updateType: - enum: - - UPDATE_TYPE_UNSPECIFIED - - UPDATE_TYPE_REPLACE - - UPDATE_TYPE_MERGE - - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES - - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES - - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES - description: Type for update. - type: string - enumDescriptions: - - Defaults to full replace behavior, ie. FULL_REPLACE. - - >- - Fully replace all the fields (including previously linked raw - document). Any field masks will be ignored. - - Merge the fields into the existing entities. - - Inserts the properties by names. - - Replace the properties by names. - - Delete the properties by names. - - >- - For each of the property, replaces the property if the it exists, - otherwise inserts a new property. And for the rest of the fields, - merge them based on update mask and merge fields options. - updateMask: - format: google-fieldmask + conditions: + additionalProperties: + type: string description: >- - Field mask for merging Document fields. For the `FieldMask` - definition, see - https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - type: string - mergeFieldsOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' - description: Options for merging. - id: GoogleCloudContentwarehouseV1UpdateOptions - description: Options for Update operations. + Map of (K, V) -> (field, string condition to be evaluated on the + field) E.g., ("age", "age > 18 && age < 60") entry triggers + validation of field age with the given condition. Map entries will + be ANDed during validation. + type: object type: object - GoogleCloudContentwarehouseV1Document: + description: Represents the action responsible for data validation operations. + id: GoogleCloudContentwarehouseV1DataValidationAction + GoogleIamV1AuditLogConfig: type: object + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + id: GoogleIamV1AuditLogConfig properties: - plainText: - type: string - description: Other document format, such as PPTX, XLXS - inlineRawDocument: - description: Raw document content. - format: byte - type: string - rawDocumentPath: - description: Raw document file in Cloud Storage path. - type: string - textExtractionEnabled: - type: boolean - description: If true, text extraction will be performed. - updater: - type: string - description: The user who lastly updates the document. - contentCategory: + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + items: + type: string + type: array + logType: + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' enum: - - CONTENT_CATEGORY_UNSPECIFIED - - CONTENT_CATEGORY_IMAGE - - CONTENT_CATEGORY_AUDIO - - CONTENT_CATEGORY_VIDEO + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ type: string - enumDescriptions: - - No category is specified. - - Content is of image type. - - Content is of audio type. - - Content is of video type. + description: The log type that this config enables. + GoogleCloudContentwarehouseV1CreateDocumentRequest: + type: object + properties: + cloudAiDocumentOption: description: >- - Indicates the category (image, audio, video etc.) of the original - content. - cloudAiDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: Document AI format to save the structured content, including OCR. - dispositionTime: - format: google-datetime + Request Option for processing Cloud AI Document in Document + Warehouse. This field offers limited support for mapping entities + from Cloud AI Document to Warehouse Document. Please consult with + product team before using this field and other available options. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - Output only. If linked to a Collection with RetentionPolicy, the - date when the document becomes mutable. - readOnly: true - type: string - legalHold: - readOnly: true - description: Output only. Indicates if the document has a legal hold on it. - type: boolean - createTime: - description: Output only. The time when the document is created. - format: google-datetime - readOnly: true - type: string - updateTime: - readOnly: true - format: google-datetime - type: string - description: Output only. The time when the document is last updated. - displayName: - type: string + Default document policy during creation. This refers to an Identity + and Access (IAM) policy, which specifies access controls for the + Document. Conditions defined in the policy will be ignored. + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Required. The document to create. + requestMetadata: description: >- - Required. Display name of the document given by the user. This name - will be displayed in the UI. Customer can populate this field with - the name of the document. This differs from the 'title' field as - 'title' is optional and stores the top heading in the document. - title: + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + createMask: + format: google-fieldmask description: >- - Title that describes the document. This can be the top heading or - text that describes the document. - type: string - name: + Field mask for creating Document fields. If mask path is empty, it + means all fields are masked. For the `FieldMask` definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. type: string + description: Request message for DocumentService.CreateDocument. + id: GoogleCloudContentwarehouseV1CreateDocumentRequest + GoogleTypeInterval: + id: GoogleTypeInterval + type: object + properties: + endTime: + format: google-datetime description: >- - The resource name of the document. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - The name is ignored when creating a document. - documentSchemaName: - description: >- - The Document schema name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - type: string - displayUri: - description: Uri to display the document, for example, in the UI. + Optional. Exclusive end of the interval. If specified, a Timestamp + matching this interval will have to be before the end. type: string - properties: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' - type: array - description: List of values that are user supplied metadata. - textExtractionDisabled: - deprecated: true - type: boolean - description: If true, text extraction will not be performed. - referenceId: + startTime: type: string + format: google-datetime description: >- - The reference ID set by customers. Must be unique per project and - location. - creator: - type: string - description: The user who creates the document. - rawDocumentFileType: + Optional. Inclusive start of the interval. If specified, a Timestamp + matching this interval will have to be the same or after the start. + description: >- + Represents a time interval, encoded as a Timestamp start (inclusive) and + a Timestamp end (exclusive). The start must be less than or equal to the + end. When the start equals the end, the interval is empty (matches no + time). When both start and end are unspecified, the interval matches any + time. + GoogleCloudContentwarehouseV1AccessControlAction: + type: object + properties: + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' description: >- - This is used when DocAI was not used to load the document and - parsing/ extracting is needed for the inline_raw_document. For - example, if inline_raw_document is the byte representation of a PDF - file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. + Represents the new policy from which bindings are added, removed or + replaced based on the type of the operation. the policy is limited + to a few 10s of KB. + operationType: + enumDescriptions: + - The unknown operation type. + - Adds newly given policy bindings in the existing bindings list. + - >- + Removes newly given policy bindings from the existing bindings + list. + - >- + Replaces existing policy bindings with the given policy binding + list + description: Identifies the type of operation. type: string enum: - - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED - - RAW_DOCUMENT_FILE_TYPE_PDF - - RAW_DOCUMENT_FILE_TYPE_DOCX - - RAW_DOCUMENT_FILE_TYPE_XLSX - - RAW_DOCUMENT_FILE_TYPE_PPTX - - RAW_DOCUMENT_FILE_TYPE_TEXT - - RAW_DOCUMENT_FILE_TYPE_TIFF - enumDescriptions: - - No raw document specified or it is non-parsable - - Adobe PDF format - - Microsoft Word format - - Microsoft Excel format - - Microsoft Powerpoint format - - UTF-8 encoded text format - - TIFF or TIF image file format - id: GoogleCloudContentwarehouseV1Document - description: Defines the structure for content warehouse document proto. - CloudAiPlatformTenantresourceTenantProjectConfig: + - UNKNOWN + - ADD_POLICY_BINDING + - REMOVE_POLICY_BINDING + - REPLACE_POLICY_BINDING + description: >- + Represents the action responsible for access control list management + operations. + id: GoogleCloudContentwarehouseV1AccessControlAction + GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: + id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + properties: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + documentId: + type: string + description: Document identifier of an existing document. + description: The status of processing a document. + type: object + GoogleCloudDocumentaiV1DocumentPageTableTableRow: + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow type: object - id: CloudAiPlatformTenantresourceTenantProjectConfig - description: The identity to configure a tenant project. properties: - policyBindings: - description: >- - Input/Output [Required]. The policy bindings that are applied to the - tenant project during creation. At least one binding must have the - role `roles/owner` with either `user` or `group` type. + cells: type: array + description: Cells that make up this row. items: $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding - services: - description: >- - Input/Output [Required]. The API services that are enabled on the - tenant project during creation. + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A row of table cells. + GoogleCloudDocumentaiV1DocumentPageLine: + id: GoogleCloudDocumentaiV1DocumentPageLine + type: object + properties: + provenance: + deprecated: true + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + detectedLanguages: type: array items: - type: string - folder: - type: string - description: >- - Input/Output [Required]. The folder that holds tenant projects and - folder-level permissions will be automatically granted to all tenant - projects under the folder. Note: the valid folder format is - `folders/{folder_number}`. - billingConfig: - description: >- - Input/Output [Required]. The billing account properties to create - the tenant project. - $ref: >- - #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig - GoogleLongrunningOperation: - id: GoogleLongrunningOperation + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Line. + description: >- + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. + GoogleCloudContentwarehouseV1PropertyFilter: properties: - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' - response: + documentSchemaName: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: + The Document schema name Document.document_schema_name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. type: string + condition: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object - GoogleCloudDocumentaiV1DocumentPage: + The filter condition. The syntax for this expression is a subset of + SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + `>=`, and `~~` where the left of the operator is a property name and + the right of the operator is a number or a quoted string. You must + escape backslash (\\) and quote (\") characters. `~~` is the LIKE + operator. The right of the operator must be a string. The only + supported property data type for LIKE is text_values. It provides + semantic search functionality by parsing, stemming and doing + synonyms expansion against the input query. It matches if the + property contains semantic similar content to the query. It is not + regex matching or wildcard matching. For example, "property.company + ~~ \"google\"" will match records whose property `property.compnay` + have values like "Google Inc.", "Google LLC" or "Google Company". + Supported functions are `LOWER([property_name])` to perform a case + insensitive match and `EMPTY([property_name])` to filter on the + existence of a key. Boolean expressions (AND/OR/NOT) are supported + up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) + AND E"), a maximum of 100 comparisons or functions are allowed in + the expression. The expression must be < 6000 bytes in length. Only + properties that are marked filterable are allowed + (PropertyDefinition.is_filterable). Property names do not need to be + prefixed by the document schema id (as is the case with histograms), + however property names will need to be prefixed by its parent + hierarchy, if any. For example: top_property_name.sub_property_name. + Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` CMEK compliant + deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and + `>=`. * Boolean expressions: AND and OR. + type: string + id: GoogleCloudContentwarehouseV1PropertyFilter type: object - description: A page in a Document. + GoogleCloudContentwarehouseV1EnumArray: properties: - detectedBarcodes: - description: A list of detected barcodes. - type: array + values: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - tables: + type: string type: array - description: A list of visually detected tables on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - visualElements: + description: List of enum values. + description: Enum values. + type: object + id: GoogleCloudContentwarehouseV1EnumArray + GoogleProtobufEmpty: + properties: {} + type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: GoogleProtobufEmpty + GoogleApiServiceconsumermanagementV1PolicyBinding: + id: GoogleApiServiceconsumermanagementV1PolicyBinding + description: Translates to IAM Policy bindings (without auditing at this level) + properties: + members: type: array + description: >- + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + type: string + role: description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - pageNumber: - type: integer - format: int32 + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. + type: string + type: object + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + type: object + description: A detected barcode. + properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for DetectedBarcode. + barcode: + description: Detailed barcode information of the DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + GoogleCloudContentwarehouseV1Document: + properties: + displayUri: + type: string + description: Uri to display the document, for example, in the UI. + dispositionTime: + type: string + format: google-datetime description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - symbols: - type: array - description: A list of visually detected symbols on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - blocks: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + Output only. If linked to a Collection with RetentionPolicy, the + date when the document becomes mutable. + readOnly: true + displayName: + type: string description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. - formFields: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - description: A list of visually detected form fields on the page. - image: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + Required. Display name of the document given by the user. This name + will be displayed in the UI. Customer can populate this field with + the name of the document. This differs from the 'title' field as + 'title' is optional and stores the top heading in the document. + updater: + description: The user who lastly updates the document. + type: string + plainText: + description: Other document format, such as PPTX, XLXS + type: string + textExtractionEnabled: + type: boolean + description: If true, text extraction will be performed. + inlineRawDocument: + description: Raw document content. + format: byte + type: string + name: + type: string description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - lines: - type: array + The resource name of the document. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + The name is ignored when creating a document. + rawDocumentFileType: + enumDescriptions: + - No raw document specified or it is non-parsable + - Adobe PDF format + - Microsoft Word format + - Microsoft Excel format + - Microsoft Powerpoint format + - UTF-8 encoded text format + - TIFF or TIF image file format description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - imageQualityScores: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - description: Image quality scores. - transforms: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + This is used when DocAI was not used to load the document and + parsing/ extracting is needed for the inline_raw_document. For + example, if inline_raw_document is the byte representation of a PDF + file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF. + type: string + enum: + - RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED + - RAW_DOCUMENT_FILE_TYPE_PDF + - RAW_DOCUMENT_FILE_TYPE_DOCX + - RAW_DOCUMENT_FILE_TYPE_XLSX + - RAW_DOCUMENT_FILE_TYPE_PPTX + - RAW_DOCUMENT_FILE_TYPE_TEXT + - RAW_DOCUMENT_FILE_TYPE_TIFF + documentSchemaName: + type: string description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - tokens: - description: A list of visually detected tokens on the page. - type: array + The Document schema name. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + properties: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - paragraphs: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' type: array + description: List of values that are user supplied metadata. + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. The time when the document is created. + referenceId: + type: string description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. + The reference ID set by customers. Must be unique per project and + location. + cloudAiDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: Document AI format to save the structured content, including OCR. + rawDocumentPath: + type: string + description: Raw document file in Cloud Storage path. + contentCategory: + description: >- + Indicates the category (image, audio, video etc.) of the original + content. + type: string + enumDescriptions: + - No category is specified. + - Content is of image type. + - Content is of audio type. + - Content is of video type. + enum: + - CONTENT_CATEGORY_UNSPECIFIED + - CONTENT_CATEGORY_IMAGE + - CONTENT_CATEGORY_AUDIO + - CONTENT_CATEGORY_VIDEO + textExtractionDisabled: + type: boolean + description: If true, text extraction will not be performed. + deprecated: true + updateTime: + description: Output only. The time when the document is last updated. + readOnly: true + format: google-datetime + type: string + creator: + description: The user who creates the document. + type: string + legalHold: + readOnly: true + description: Output only. Indicates if the document has a legal hold on it. + type: boolean + title: + description: >- + Title that describes the document. This can be the top heading or + text that describes the document. + type: string + type: object + description: Defines the structure for content warehouse document proto. + id: GoogleCloudContentwarehouseV1Document + GoogleRpcStatus: + type: object + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus + properties: + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + GoogleCloudContentwarehouseV1FloatArray: + id: GoogleCloudContentwarehouseV1FloatArray + type: object + properties: + values: + description: List of float values. + items: + format: float + type: number + type: array + description: Float values. + GoogleCloudContentwarehouseV1FloatTypeOptions: + properties: {} + id: GoogleCloudContentwarehouseV1FloatTypeOptions + description: Configurations for a float property. + type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + properties: + listEntries: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + description: List entries that constitute a list block. + type: array + type: + type: string + description: >- + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. + type: object + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Represents a list type block. + GoogleCloudContentwarehouseV1FetchAclRequest: + properties: + projectOwner: + description: >- + For Get Project ACL only. Authorization check for end user will be + ignored when project_owner=true. + type: boolean + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + id: GoogleCloudContentwarehouseV1FetchAclRequest + description: Request message for DocumentService.FetchAcl + type: object + GoogleCloudContentwarehouseV1TextTypeOptions: + type: object + description: Configurations for a text property. + id: GoogleCloudContentwarehouseV1TextTypeOptions + properties: {} + GoogleCloudContentwarehouseV1EnumValue: + description: Represents the string value of the enum field. + id: GoogleCloudContentwarehouseV1EnumValue + type: object + properties: + value: + type: string + description: >- + String value of the enum field. This must match defined set of enums + in document schema using EnumTypeOptions. + GoogleCloudContentwarehouseV1HistogramQueryResult: + id: GoogleCloudContentwarehouseV1HistogramQueryResult + description: Histogram result that matches HistogramQuery specified in searches. + type: object + properties: + histogramQuery: + type: string + description: Requested histogram expression. + histogram: + description: >- + A map from the values of the facet associated with distinct values + to the number of matching entries with corresponding value. The key + format is: * (for string histogram) string values stored in the + field. + additionalProperties: + type: string + format: int64 + type: object + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + type: object + properties: + type: + type: string + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. + description: Detected break type. + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. + GoogleCloudContentwarehouseV1UpdateOptions: + properties: + updateMask: + description: >- + Field mask for merging Document fields. For the `FieldMask` + definition, see + https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + format: google-fieldmask + type: string + mergeFieldsOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MergeFieldsOptions' + description: Options for merging. + updateType: + type: string + description: Type for update. + enumDescriptions: + - Defaults to full replace behavior, ie. FULL_REPLACE. + - >- + Fully replace all the fields (including previously linked raw + document). Any field masks will be ignored. + - Merge the fields into the existing entities. + - Inserts the properties by names. + - Replace the properties by names. + - Delete the properties by names. + - >- + For each of the property, replaces the property if the it exists, + otherwise inserts a new property. And for the rest of the fields, + merge them based on update mask and merge fields options. + enum: + - UPDATE_TYPE_UNSPECIFIED + - UPDATE_TYPE_REPLACE + - UPDATE_TYPE_MERGE + - UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES + - UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES + - UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES + type: object + id: GoogleCloudContentwarehouseV1UpdateOptions + description: Options for Update operations. + GoogleCloudContentwarehouseV1DocumentLink: + id: GoogleCloudContentwarehouseV1DocumentLink + description: A document-link between source and target document. + properties: + name: + description: >- + Name of this document-link. It is required that the parent derived + form the name to be consistent with the source document reference. + Otherwise an exception will be thrown. Format: + projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. + type: string + sourceDocumentReference: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + description: Document references of the source document. + updateTime: + type: string + description: Output only. The time when the documentLink is last updated. + readOnly: true + format: google-datetime + targetDocumentReference: + description: Document references of the target document. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' + createTime: + type: string + readOnly: true + description: Output only. The time when the documentLink is created. + format: google-datetime + state: + enum: + - STATE_UNSPECIFIED + - ACTIVE + - SOFT_DELETED + enumDescriptions: + - Unknown state of documentlink. + - The documentlink has both source and target documents detected. + - >- + Target document is deleted, and mark the documentlink as + soft-deleted. + type: string + description: >- + The state of the documentlink. If target node has been deleted, the + link is marked as invalid. Removing a source node will result in + removal of all associated links. + description: + type: string + description: Description of this document-link. + type: object + GoogleCloudContentwarehouseV1DeleteDocumentAction: + description: Represents the action responsible for deleting the document. + type: object + properties: + enableHardDelete: + description: >- + Boolean field to select between hard vs soft delete options. Set + 'true' for 'hard delete' and 'false' for 'soft delete'. + type: boolean + id: GoogleCloudContentwarehouseV1DeleteDocumentAction + GoogleCloudDocumentaiV1DocumentShardInfo: + description: >- + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. + properties: + shardCount: + format: int64 + description: Total number of shards. + type: string + shardIndex: + type: string + description: The 0-based index of this shard. + format: int64 + textOffset: + format: int64 + type: string + description: >- + The index of the first character in Document.text in the overall + document global text. + type: object + id: GoogleCloudDocumentaiV1DocumentShardInfo + GoogleCloudDocumentaiV1DocumentProvenance: + properties: + revision: + deprecated: true + description: The index of the revision that produced this element. + format: int32 + type: integer + id: + deprecated: true + type: integer + format: int32 + description: >- + The Id of this operation. Needs to be unique within the scope of the + revision. + type: + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + type: string + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + description: The type of provenance operation. + enumDescriptions: + - >- + Operation type unspecified. If no operation is specified a + provenance entry is simply used to match against a `parent`. + - Add an element. + - Remove an element identified by `parent`. + - >- + Updates any fields within the given provenance scope of the + message. It overwrites the fields rather than replacing them. Use + this when you want to update a field value of an entity without + also updating all the child properties. + - Currently unused. Replace an element identified by `parent`. + - >- + Deprecated. Request human review for the element identified by + `parent`. + - >- + Deprecated. Element is reviewed and approved at human review, + confidence will be set to 1.0. + - Deprecated. Element is skipped in the validation process. + parents: + description: References to the original elements that are replaced. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - dimension: - description: Physical dimension of the page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for the page. - provenance: - description: The history of this page. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - id: GoogleCloudDocumentaiV1DocumentPage + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + type: array + type: object + id: GoogleCloudDocumentaiV1DocumentProvenance + description: >- + Structure to identify provenance relationships between annotations in + different revisions. GoogleCloudContentwarehouseV1RuleSet: + description: Represents a set of rules from a single customer. properties: - name: - description: >- - The resource name of the rule set. Managed internally. Format: - projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. - The name is ignored when creating a rule set. - type: string rules: + description: List of rules given by the customer. + type: array items: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - type: array - description: List of rules given by the customer. description: description: Short description of the rule-set. type: string + name: + type: string + description: >- + The resource name of the rule set. Managed internally. Format: + projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. + The name is ignored when creating a rule set. source: - description: Source of the rules i.e., customer name. type: string - description: Represents a set of rules from a single customer. - type: object + description: Source of the rules i.e., customer name. id: GoogleCloudContentwarehouseV1RuleSet - GoogleCloudContentwarehouseV1FileTypeFilter: + type: object + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + description: The metadata message for Export-to-CDW pipeline. properties: - fileType: - enumDescriptions: - - Default document type. If set, disables the filter. - - Returns all document types, including folders. - - Returns only folders. - - Returns only non-folder documents. - - Returns only root folders + documents: + type: array + description: >- + The input list of all the resource names of the documents to be + exported. + items: + type: string + outputPath: type: string - enum: - - FILE_TYPE_UNSPECIFIED - - ALL - - FOLDER - - DOCUMENT - - ROOT_FOLDER - description: The type of files to return. - id: GoogleCloudContentwarehouseV1FileTypeFilter - description: Filter for the specific types of documents returned. + description: The output Cloud Storage folder in this pipeline. + docAiDataset: + type: string + description: The output CDW dataset resource name. type: object - CloudAiPlatformTenantresourceInfraSpannerConfig: + GoogleCloudContentwarehouseV1LockDocumentRequest: type: object - id: CloudAiPlatformTenantresourceInfraSpannerConfig + description: Request message for DocumentService.LockDocument. + id: GoogleCloudContentwarehouseV1LockDocumentRequest properties: - spannerBorgServiceAccount: + collectionId: + description: The collection the document connects to. type: string + lockingUser: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: The user information who locks the document. + CloudAiPlatformTenantresourceServiceAccountIdentity: + properties: + tag: description: >- - Input [Optional]. The spanner borg service account for delegating - the kms key to. For example, - spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the - nonprod universe. - spannerLocalNamePrefix: + Input/Output [Optional]. The tag that configures the service + account, as defined in + google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. + Note: The default P4 service account has the empty tag. type: string - createDatabaseOptions: - $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions - description: >- - Input [Optional]. The options to create a spanner database. Note: - give the right options to ensure the right KMS key access audit - logging and AxT logging in expected logging category. - spannerUniverse: + serviceAccountEmail: type: string + description: Output only. The service account email that has been created. + id: CloudAiPlatformTenantresourceServiceAccountIdentity + type: object + description: The identity to configure a service account. + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + properties: + languageCode: description: >- - Input [Required]. Every database in Spanner can be identified by the - following path name: /span//: - sdlBundlePath: + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. type: string - description: Input [Required]. The file path to the spanner SDL bundle. - kmsKeyReference: + confidence: + description: Confidence of detected language. Range `[0, 1]`. + type: number + format: float + type: object + description: Detected language for a structural component. + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudDocumentaiV1DocumentEntity: + type: object + id: GoogleCloudDocumentaiV1DocumentEntity + description: >- + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. + properties: + mentionText: + type: string + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + pageAnchor: description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new Infra - Spanner databases. For existing Infra Spanner databases, this field - will be ignored because CMEK re-encryption is not supported. For - example, projects//locations//keyRings//cryptoKeys/ + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + id: + description: >- + Optional. Canonical id. This will be a unique value in the entity + list for this document. type: string - spannerNamespace: + mentionId: type: string - description: 'The configuration for a spanner database provisioning. Next ID: 8' - GoogleCloudContentwarehouseV1UpdateDocumentResponse: + description: Optional. Deprecated. Use `id` field instead. + normalizedValue: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + description: >- + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + redacted: + description: >- + Optional. Whether the entity will be redacted for de-identification + purposes. + type: boolean + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: Optional. The history of this annotation. + confidence: + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + format: float + type: number + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + type: + type: string + description: Required. Entity type from a schema e.g. `Address`. + properties: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + type: array + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + GoogleCloudDocumentaiV1BoundingPoly: properties: - metadata: + normalizedVertices: + description: The bounding polygon normalized vertices. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + type: array + vertices: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + description: The bounding polygon vertices. + type: array + description: A bounding polygon for the detected image annotation. + type: object + id: GoogleCloudDocumentaiV1BoundingPoly + GoogleCloudDocumentaiV1DocumentProvenanceParent: + id: GoogleCloudDocumentaiV1DocumentProvenanceParent + type: object + properties: + index: + type: integer description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - ruleEngineOutput: + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. + format: int32 + revision: + description: The index of the index into current revision's parent_ids list. + format: int32 + type: integer + id: + deprecated: true + description: The id of the parent provenance. + type: integer + format: int32 + description: >- + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. + GoogleCloudContentwarehouseV1RunPipelineRequest: + type: object + id: GoogleCloudContentwarehouseV1RunPipelineRequest + description: Request message for DocumentService.RunPipeline. + properties: + processWithDocAiPipeline: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + description: >- + Use a DocAI processor to process documents in Document Warehouse, + and re-ingest the updated results into Document Warehouse. + gcsIngestWithDocAiProcessorsPipeline: + description: >- + Use DocAI processors to process documents in Cloud Storage and + ingest them to Document Warehouse. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + exportCdwPipeline: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline + description: >- + Export docuemnts from Document Warehouse to CDW for training + purpose. + gcsIngestPipeline: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' + description: Cloud Storage ingestion pipeline. + requestMetadata: description: >- - Output from Rule Engine recording the rule evaluator and action - executor's output. Refer format in: - google/cloud/contentwarehouse/v1/rule_engine.proto - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Updated document after executing update request. - description: Response message for DocumentService.UpdateDocument. + The meta information collected about the end user, used to enforce + access control for the service. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + GoogleCloudContentwarehouseV1RuleEvaluatorOutput: + id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput + description: Represents the output of the Rule Evaluator. type: object - id: GoogleCloudContentwarehouseV1UpdateDocumentResponse - GoogleCloudDocumentaiV1Document: properties: - revisions: - description: Placeholder. Revision history of this document. + invalidRules: + description: >- + A subset of triggered rules that failed the validation check(s) + after parsing. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' type: array - error: - description: Any error that occurred while processing this document. - $ref: '#/components/schemas/GoogleRpcStatus' - text: - type: string - description: Optional. UTF-8 encoded text in reading order from the document. - pages: + matchedRules: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' type: array - description: Visual page layout for the Document. - textChanges: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. + A subset of triggered rules that are evaluated true for a given + request. + triggeredRules: type: array - entities: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - type: array + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - content: + List of rules fetched from database for the given request trigger + type. + GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline: + description: >- + The configuration of the Cloud Storage Ingestion with DocAI Processors + pipeline. + id: GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + properties: + splitClassifyProcessorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: >- + The split and classify processor information. The split and classify + result will be used to find a matched extract processor. + processorResultsFolderPath: type: string - format: byte description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - entityRelations: + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. + skipIngestedDocuments: + type: boolean + description: >- + The flag whether to skip ingested documents. If it is set to true, + documents in Cloud Storage contains key "status" with value + "status=ingested" in custom metadata will be skipped to ingest. + extractProcessorInfos: type: array - description: Placeholder. Relationship among Document.entities. + description: >- + The extract processors information. One matched extract processor + will be used to process documents based on the classify processor + result. If no classify processor is specified, the first extract + processor will be used. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - uri: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + pipelineConfig: + description: >- + Optional. The config for the Cloud Storage Ingestion with DocAI + Processors pipeline. It provides additional customization options to + run the pipeline and can be skipped if it is not applicable. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig + inputPath: type: string description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - textStyles: + The input Cloud Storage folder. All files under this folder will be + imported to Document Warehouse. Format: `gs:///`. + type: object + GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: + type: object + description: Document entry with metadata inside SearchDocumentsResponse + id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument + properties: + document: + description: >- + Document that matches the specified SearchDocumentsRequest. This + document only contains indexed metadata information. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + qaResult: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' + description: >- + Experimental. Additional result info if the question-answering + feature is enabled. + searchTextSnippet: + description: >- + Contains snippets of text from the document full raw text that most + closely match a search query's keywords, if available. All HTML tags + in the original fields are stripped when returned in this field, and + matching query keywords are enclosed in HTML bold tags. If the + question-answering feature is enabled, this field will instead + contain a snippet that answers the user's natural-language query. No + HTML bold tags will be present, and highlights in the answer snippet + can be found in QAResult.highlights. + type: string + matchedTokenPageIndices: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - description: Styles for the Document.text. + type: string + format: int64 type: array - deprecated: true - mimeType: - type: string description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - shardInfo: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' - description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. + Return the 1-based page indices where those pages have one or more + matched tokens. + GoogleCloudContentwarehouseV1IntegerTypeOptions: type: object - id: GoogleCloudDocumentaiV1Document + id: GoogleCloudContentwarehouseV1IntegerTypeOptions + properties: {} + description: Configurations for an integer property. + GoogleTypeTimeZone: + type: object + id: GoogleTypeTimeZone description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. - GoogleCloudContentwarehouseV1FetchAclRequest: + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). + properties: + version: + type: string + description: Optional. IANA Time Zone Database version number, e.g. "2019a". + id: + type: string + description: IANA Time Zone Database time zone, e.g. "America/New_York". + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: + properties: + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the footer. + text: + type: string + description: Footer in text format. + type: object + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + description: Represents the page footer associated with the chunk. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: type: object properties: - projectOwner: - description: >- - For Get Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - type: boolean - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - description: Request message for DocumentService.FetchAcl - id: GoogleCloudContentwarehouseV1FetchAclRequest - GoogleTypeDate: - id: GoogleTypeDate + bodyRows: + description: Body rows containing main table content. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + headerRows: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + type: array + description: Header rows at the top of the table. + caption: + type: string + description: Table caption/title. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + description: Represents a table type block. + GoogleCloudContentwarehouseV1ExportToCdwPipeline: + type: object description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + The configuration of exporting documents from the Document Warehouse to + CDW pipeline. properties: - month: - type: integer + docAiDataset: description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - year: + Optional. The CDW dataset resource name. This field is optional. If + not set, the documents will be exported to Cloud Storage only. + Format: + projects/{project}/locations/{location}/processors/{processor}/dataset + type: string + documents: + items: + type: string description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - format: int32 - type: integer - day: - type: integer - format: int32 + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + type: array + exportFolderPath: + type: string description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: object - GoogleCloudDocumentaiV1DocumentPageSymbol: - id: GoogleCloudDocumentaiV1DocumentPageSymbol + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + trainingSplitRatio: + description: >- + Ratio of training dataset split. When importing into Document AI + Workbench, documents will be automatically split into training and + test split category with the specified ratio. This field is required + if doc_ai_dataset is set. + type: number + format: float + id: GoogleCloudContentwarehouseV1ExportToCdwPipeline + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry properties: - layout: - description: Layout for Symbol. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedLanguages: + blocks: + description: >- + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock type: array - description: A list of detected languages together with confidence. + description: Represents an entry in the list. type: object - description: A detected symbol. GoogleCloudDocumentaiV1DocumentPageParagraph: - type: object id: GoogleCloudDocumentaiV1DocumentPageParagraph properties: detectedLanguages: + description: A list of detected languages together with confidence. + type: array items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - layout: - description: Layout for Paragraph. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' provenance: + deprecated: true description: The history of this annotation. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Paragraph. + type: object description: A collection of lines that a human would perceive as a paragraph. - GoogleCloudContentwarehouseV1PublishAction: + GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: + type: object + description: Metadata object for UpdateDocument request (currently empty). + properties: {} + id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata + CloudAiPlatformTenantresourceTenantProjectConfig: type: object + id: CloudAiPlatformTenantresourceTenantProjectConfig + description: The identity to configure a tenant project. properties: - messages: + billingConfig: + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1BillingConfig + description: >- + Input/Output [Required]. The billing account properties to create + the tenant project. + policyBindings: + type: array + description: >- + Input/Output [Required]. The policy bindings that are applied to the + tenant project during creation. At least one binding must have the + role `roles/owner` with either `user` or `group` type. + items: + $ref: >- + #/components/schemas/GoogleApiServiceconsumermanagementV1PolicyBinding + services: + description: >- + Input/Output [Required]. The API services that are enabled on the + tenant project during creation. type: array items: type: string - description: Messages to be published. - topicId: - type: string + folder: description: >- - The topic id in the Pub/Sub service for which messages will be - published to. - description: >- - Represents the action responsible for publishing messages to a Pub/Sub - topic. - id: GoogleCloudContentwarehouseV1PublishAction - GoogleCloudDocumentaiV1DocumentTextChange: - id: GoogleCloudDocumentaiV1DocumentTextChange + Input/Output [Required]. The folder that holds tenant projects and + folder-level permissions will be automatically granted to all tenant + projects under the folder. Note: the valid folder format is + `folders/{folder_number}`. + type: string + GoogleCloudContentwarehouseV1beta1InitializeProjectResponse: + description: Response message for projectService.InitializeProject + type: object properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - changedText: - description: The text that replaces the text identified in the `text_anchor`. + message: + description: The message of the project initialization process. type: string - provenance: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - type: array - description: This message is used for text changes aka. OCR corrections. + state: + enumDescriptions: + - Clients should never see this. + - Finished project initialization without error. + - Finished project initialization with an error. + - Client canceled the LRO. + - Ask the customer to check the operation for results. + enum: + - STATE_UNSPECIFIED + - SUCCEEDED + - FAILED + - CANCELLED + - RUNNING + description: The state of the project initialization process. + type: string + id: GoogleCloudContentwarehouseV1beta1InitializeProjectResponse + GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: + id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse type: object - GoogleCloudContentwarehouseV1QAResult: - description: Additional result info for the question-answering feature. + description: Response message for DocumentLinkService.ListLinkedSources. properties: - confidenceScore: - format: float - type: number + nextPageToken: + type: string description: >- - The calibrated confidence score for this document, in the range [0., - 1.]. This represents the confidence level for whether the returned - document and snippet answers the user's query. - highlights: - description: Highlighted sections in the snippet. - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1QAResultHighlight + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + documentLinks: type: array + description: Source document-links. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + GoogleCloudDocumentaiV1Barcode: type: object - id: GoogleCloudContentwarehouseV1QAResult - GoogleCloudContentwarehouseV1RuleEvaluatorOutput: - type: object - id: GoogleCloudContentwarehouseV1RuleEvaluatorOutput properties: - matchedRules: - type: array + format: + type: string description: >- - A subset of triggered rules that are evaluated true for a given - request. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - invalidRules: - type: array + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. + valueFormat: + type: string description: >- - A subset of triggered rules that failed the validation check(s) - after parsing. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1InvalidRule' - triggeredRules: - type: array + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. + rawValue: description: >- - List of rules fetched from database for the given request trigger - type. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' - description: Represents the output of the Rule Evaluator. - GoogleCloudDocumentaiV1DocumentRevision: + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + type: string + description: Encodes the detailed information of a barcode. + id: GoogleCloudDocumentaiV1Barcode + GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter: type: object - description: Contains past or forward revisions of this document. properties: - parent: - items: - type: integer - format: int32 - type: array - deprecated: true - description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - parentIds: - type: array + propertyNames: description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. + It is optional. It will perform histogram for all the property names + if it is not set. The properties need to be defined with the + is_filterable flag set to true and the name of the property should + be in the format: "schemaId.propertyName". The property needs to be + defined in the schema. Example: the schema id is abc. Then the name + of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE". items: type: string - agent: - type: string - description: >- - If the change was made by a person specify the name or id of that - person. - createTime: + type: array + yAxis: + enum: + - HISTOGRAM_YAXIS_DOCUMENT + - HISTOGRAM_YAXIS_PROPERTY + enumDescriptions: + - Count the documents per property name. + - Count the properties per property name. type: string description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - format: google-datetime - id: + By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is + not set. + documentSchemas: + items: + type: string description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. + This filter specifies the exact document schema(s) + Document.document_schema_name to run histogram query against. It is + optional. It will perform histogram for property names for all the + document schemas if it is not set. At most 10 document schema names + are allowed. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + type: array + id: GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + GoogleCloudContentwarehouseV1QAResultHighlight: + properties: + endIndex: + type: integer + description: End index of the highlight, exclusive. + format: int32 + startIndex: + type: integer + description: Start index of the highlight. + format: int32 + type: object + description: >- + A text span in the search text snippet that represents a highlighted + section (answer context, highly relevant sentence, etc.). + id: GoogleCloudContentwarehouseV1QAResultHighlight + GoogleCloudContentwarehouseV1RemoveFromFolderAction: + type: object + properties: + condition: type: string - humanReview: - description: Human Review information of this revision. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - processor: + description: Condition of the action to be executed. + folder: description: >- - If the annotation was made by processor identify the processor by - its resource name. + Name of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. type: string - id: GoogleCloudDocumentaiV1DocumentRevision - GoogleCloudContentwarehouseV1CreateDocumentMetadata: - type: object - description: Metadata object for CreateDocument request (currently empty). - properties: {} - id: GoogleCloudContentwarehouseV1CreateDocumentMetadata - GoogleProtobufEmpty: description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - id: GoogleProtobufEmpty - type: object - GoogleCloudContentwarehouseV1DateTimeTypeOptions: + Represents the action responsible for remove a document from a specific + folder. + id: GoogleCloudContentwarehouseV1RemoveFromFolderAction + GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: + properties: + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest type: object - id: GoogleCloudContentwarehouseV1DateTimeTypeOptions - description: Configurations for a date time property. - properties: {} - GoogleCloudDocumentaiV1NormalizedVertex: + description: Request message for DocumentLinkService.ListLinkedTargets. + GoogleCloudDocumentaiV1DocumentPageDimension: + description: Dimension for the page. type: object - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - id: GoogleCloudDocumentaiV1NormalizedVertex + id: GoogleCloudDocumentaiV1DocumentPageDimension properties: - x: + unit: + description: Dimension unit. + type: string + width: type: number - description: X coordinate. format: float - 'y': + description: Page width. + height: + description: Page height. type: number - description: Y coordinate (starts from the top of the image). format: float - GoogleCloudContentwarehouseV1SearchDocumentsResponse: + GoogleCloudContentwarehouseV1RequestMetadata: + description: Meta information is used to improve the performance of the service. + properties: + userInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: Provides user unique identification and groups information. + id: GoogleCloudContentwarehouseV1RequestMetadata type: object - id: GoogleCloudContentwarehouseV1SearchDocumentsResponse + GoogleCloudContentwarehouseV1PropertyArray: + type: object + id: GoogleCloudContentwarehouseV1PropertyArray + description: Property values. properties: - matchingDocuments: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument - description: >- - The document entities that match the specified - SearchDocumentsRequest. + properties: type: array - histogramQueryResults: - description: >- - The histogram results that match with the specified - SearchDocumentsRequest.histogram_queries. + description: List of property values. items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryResult + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Property' + GoogleCloudContentwarehouseV1CreateDocumentResponse: + description: Response message for DocumentService.CreateDocument. + type: object + id: GoogleCloudContentwarehouseV1CreateDocumentResponse + properties: + longRunningOperations: + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: post-processing LROs type: array - totalSize: - type: integer + ruleEngineOutput: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' description: >- - The total number of matched documents which is available only if the - client set SearchDocumentsRequest.require_total_size to `true` or - set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or - `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI - would handle this condition by displaying "of many", for example: - "Displaying 10 of many". - format: int32 + Output from Rule Engine recording the rule evaluator and action + executor's output. Refer format in: + google/cloud/contentwarehouse/v1/rule_engine.proto + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Document created after executing create request. metadata: $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- Additional information for the API invocation, such as the request tracking id. - questionAnswer: - type: string - description: Experimental. Question answer from the query against the document. - nextPageToken: - type: string - description: >- - The token that specifies the starting position of the next page of - results. This field is empty if there are no more results. - description: Response message for DocumentService.SearchDocuments. - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - type: object - description: A cell representation inside the table. + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + description: Parsed and normalized entity value. properties: - colSpan: - type: integer - description: How many columns this cell spans. - format: int32 - rowSpan: + moneyValue: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + addressValue: + description: >- + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' + datetimeValue: + description: >- + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + $ref: '#/components/schemas/GoogleTypeDateTime' + integerValue: format: int32 + description: Integer value. type: integer - description: How many rows this cell spans. - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: array - layout: - description: Layout for TableCell. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell - GoogleTypeColor: - type: object - id: GoogleTypeColor - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - properties: - red: - format: float - type: number - description: The amount of red in the color as a value in the interval [0, 1]. - alpha: - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - format: float - type: number - green: - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - format: float - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. + floatValue: format: float type: number - GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus: - properties: - documentId: + description: Float value. + dateValue: + $ref: '#/components/schemas/GoogleTypeDate' + description: >- + Date value. Includes year, month, day. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + text: type: string - description: Document identifier of an existing document. - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - description: The status of processing a document. - id: GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + description: >- + Optional. An optional field to store a normalized string. For some + entity types, one of respective `structured_value` fields may also + be populated. Also not all the types of `structured_value` will be + normalized. For example, some processors may not generate `float` or + `integer` normalized text by default. Below are sample formats + mapped to structured values. - Money/Currency type (`money_value`) + is in the ISO 4217 text format. - Date type (`date_value`) is in the + ISO 8601 text format. - Datetime type (`datetime_value`) is in the + ISO 8601 text format. + booleanValue: + description: >- + Boolean value. Can be used for entities with binary values, or for + checkboxes. + type: boolean + type: object + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + description: >- + Represents a block. A block could be one of the various types (text, + table, list) supported. + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock type: object - GoogleIamV1AuditConfig: properties: - auditLogConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - type: array - description: The configuration for logging of each type of permission. - service: + tableBlock: + description: Block consisting of table content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + textBlock: + description: Block consisting of text content. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + listBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Block consisting of list content/structure. + pageSpan: + description: Page span of the block. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + blockId: + description: ID of the block. + type: string + GoogleApiServiceconsumermanagementV1BillingConfig: + id: GoogleApiServiceconsumermanagementV1BillingConfig + properties: + billingAccount: type: string description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - id: GoogleIamV1AuditConfig - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - type: object - GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. type: object - description: Response message for DocumentLinkService.ListLinkedTargets. + description: Describes the billing configuration for a new tenant project. + GoogleCloudDocumentaiV1DocumentPageSymbol: properties: - documentLinks: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Symbol. + detectedLanguages: type: array items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - description: Target document-links. - nextPageToken: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + id: GoogleCloudDocumentaiV1DocumentPageSymbol + description: A detected symbol. + type: object + GoogleCloudContentwarehouseV1RuleEngineOutput: + id: GoogleCloudContentwarehouseV1RuleEngineOutput + type: object + description: >- + Records the output of Rule Engine including rule evaluation and actions + result. + properties: + actionExecutorOutput: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Output from Action Executor containing rule and corresponding + actions execution result. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ActionExecutorOutput + ruleEvaluatorOutput: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RuleEvaluatorOutput + description: >- + Output from Rule Evaluator containing matched, unmatched and invalid + rules. + documentName: type: string - id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse - GoogleCloudContentwarehouseV1ListSynonymSetsResponse: + description: >- + Name of the document against which the rules and actions were + evaluated. + GoogleCloudDocumentaiV1DocumentPageFormField: + type: object + description: A form field detected on the page. + id: GoogleCloudDocumentaiV1DocumentPageFormField properties: - nextPageToken: + correctedKeyText: type: string description: >- - A page token, received from a previous `ListSynonymSets` call. - Provide this to retrieve the subsequent page. - synonymSets: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + Created for Labeling UI to export key text. If corrections were made + to the text identified by the `field_name.text_anchor`, this field + will contain the correction. + valueDetectedLanguages: type: array - description: The synonymSets from the specified parent. - id: GoogleCloudContentwarehouseV1ListSynonymSetsResponse - type: object - description: Response message for SynonymSetService.ListSynonymSets. - CloudAiPlatformTenantresourceIamPolicyBinding: - properties: - resource: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for value together with confidence. + fieldName: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' description: >- - Input/Output [Required]. The resource name that will be accessed by - members, which also depends on resource_type. Note: placeholders are - supported in resource names. For example, ${tpn} will be used when - the tenant project number is not ready. + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. + fieldValue: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the FormField value. + provenance: + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + valueType: type: string - members: - items: - type: string - type: array description: >- - Input/Output [Required]. The member service accounts with the roles - above. Note: placeholders are same as the resource above. - role: - description: Input/Output [Required]. The role for members below. + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + correctedValueText: type: string - resourceType: - enum: - - RESOURCE_TYPE_UNSPECIFIED - - PROJECT - - SERVICE_ACCOUNT - - GCS_BUCKET - - SERVICE_CONSUMER - - AR_REPO + description: >- + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. + nameDetectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages for name together with confidence. + type: array + GoogleCloudContentwarehouseV1ListRuleSetsResponse: + properties: + nextPageToken: type: string description: >- - Input/Output [Required]. Specifies the type of resource that will be - accessed by members. - enumDescriptions: - - '' - - >- - The value of resource field is the ID or number of a project. - Format is - - >- - The value of resource field is the resource name of a service - account. Format is projects//serviceAccounts/ - - >- - The value of resource field is the name of a GCS bucket (not its - resource name). Format is . - - >- - The value of resource field is the resource name of a service - consumer. Format is services//consumers/ - - >- - The value of the resource field is the AR Image Uri which - identifies an AR REPO. Allowed formats are: /// ///: ///@ - id: CloudAiPlatformTenantresourceIamPolicyBinding - description: >- - The dynamic IAM bindings to be granted after tenant projects are - created. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + ruleSets: + description: The rule sets from the specified parent. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + id: GoogleCloudContentwarehouseV1ListRuleSetsResponse type: object - GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: - description: Request message for DocumentLinkService.CreateDocumentLink. + description: Response message for RuleSetService.ListRuleSets. + GoogleCloudContentwarehouseV1PropertyTypeOptions: + id: GoogleCloudContentwarehouseV1PropertyTypeOptions + description: Configurations for a nested structured data property. type: object - id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest properties: - documentLink: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - description: >- - Required. Document links associated with the source documents - (source_document_id). - requestMetadata: - description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - GoogleCloudContentwarehouseV1SynonymSet: + propertyDefinitions: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition + description: Required. List of property definitions. + GoogleCloudDocumentaiV1NormalizedVertex: + id: GoogleCloudDocumentaiV1NormalizedVertex + properties: + x: + format: float + description: X coordinate. + type: number + 'y': + format: float + type: number + description: Y coordinate (starts from the top of the image). + type: object + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. + GoogleCloudContentwarehouseV1TimestampTypeOptions: + id: GoogleCloudContentwarehouseV1TimestampTypeOptions + description: Configurations for a timestamp property. type: object + properties: {} + GoogleCloudDocumentaiV1DocumentDocumentLayout: properties: - synonyms: - description: List of Synonyms for the context. + blocks: type: array items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym - name: - description: >- - The resource name of the SynonymSet This is mandatory for - google.api.resource. Format: - projects/{project_number}/locations/{location}/synonymSets/{context}. - type: string - context: - description: >- - This is a freeform field. Example contexts can be "sales," - "engineering," "real estate," "accounting," etc. The context can be - supplied during search requests. - type: string - id: GoogleCloudContentwarehouseV1SynonymSet + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: List of blocks in the document. + id: GoogleCloudDocumentaiV1DocumentDocumentLayout + type: object description: >- - Represents a list of synonyms for a given context. For example a context - "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: - money, credit, finance, payment Synonym 3: shipping, freight, transport - Each SynonymSets should be disjoint + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. + GoogleCloudContentwarehouseV1UpdateDocumentMetadata: + type: object + properties: {} + description: Metadata object for UpdateDocument request (currently empty). + id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata + GoogleCloudContentwarehouseV1AddToFolderAction: + id: GoogleCloudContentwarehouseV1AddToFolderAction + description: Represents the action responsible for adding document under a folder. + properties: + folders: + type: array + description: >- + Names of the folder under which new document is to be added. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + items: + type: string + type: object GoogleCloudContentwarehouseV1GcsIngestPipeline: + description: The configuration of the Cloud Storage Ingestion pipeline. type: object + id: GoogleCloudContentwarehouseV1GcsIngestPipeline properties: - processorType: + schemaName: type: string description: >- - The Doc AI processor type name. Only used when the format of - ingested files is Doc AI Document proto format. - pipelineConfig: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig - description: >- - Optional. The config for the Cloud Storage Ingestion pipeline. It - provides additional customization options to run the pipeline and - can be skipped if it is not applicable. + The Document Warehouse schema resource name. All documents processed + by this pipeline will use this schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. skipIngestedDocuments: - type: boolean description: >- The flag whether to skip ingested documents. If it is set to true, documents in Cloud Storage contains key "status" with value "status=ingested" in custom metadata will be skipped to ingest. - schemaName: + type: boolean + pipelineConfig: description: >- - The Document Warehouse schema resource name. All documents processed - by this pipeline will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - type: string + Optional. The config for the Cloud Storage Ingestion pipeline. It + provides additional customization options to run the pipeline and + can be skipped if it is not applicable. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1IngestPipelineConfig inputPath: description: >- The input Cloud Storage folder. All files under this folder will be imported to Document Warehouse. Format: `gs:///`. type: string - description: The configuration of the Cloud Storage Ingestion pipeline. - id: GoogleCloudContentwarehouseV1GcsIngestPipeline - GoogleCloudContentwarehouseV1UpdateDocumentMetadata: - type: object - description: Metadata object for UpdateDocument request (currently empty). - properties: {} - id: GoogleCloudContentwarehouseV1UpdateDocumentMetadata - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - properties: - type: + processorType: type: string - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - description: Detected break type. - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - description: Detected break at the end of a Token. - type: object - GoogleCloudContentwarehouseV1TextArray: - id: GoogleCloudContentwarehouseV1TextArray - description: String/text values. - type: object - properties: - values: - description: List of text values. - items: - type: string - type: array + description: >- + The Doc AI processor type name. Only used when the format of + ingested files is Doc AI Document proto format. GoogleCloudDocumentaiV1DocumentStyle: - type: object + id: GoogleCloudDocumentaiV1DocumentStyle properties: - fontWeight: + textStyle: type: string description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - fontFamily: - description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - type: string - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. fontSize: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' description: Font size. - textDecoration: + backgroundColor: + description: Text background color. + $ref: '#/components/schemas/GoogleTypeColor' + fontFamily: type: string description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp color: description: Text color. $ref: '#/components/schemas/GoogleTypeColor' - textStyle: + textDecoration: type: string description: >- [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - id: GoogleCloudDocumentaiV1DocumentStyle - GoogleCloudContentwarehouseV1FloatArray: - description: Float values. - id: GoogleCloudContentwarehouseV1FloatArray - type: object - properties: - values: - type: array - items: - type: number - format: float - description: List of float values. - GoogleTypeMoney: - properties: - units: - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - format: int64 - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - nanos: - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - id: GoogleTypeMoney - type: object - description: Represents an amount of money with its currency type. - CloudAiPlatformTenantresourceCloudSqlInstanceConfig: - description: >- - The identity to configure a CloudSQL instance provisioned via SLM - Terraform. - type: object - id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig - properties: - cloudSqlInstanceConnectionName: - description: Output only. The CloudSQL instance connection name. - type: string - slmInstanceType: - description: Input [Required]. The SLM instance type to provision CloudSQL. - type: string - cloudSqlInstanceName: - type: string - description: >- - Input/Output [Optional]. The CloudSQL instance name within SLM - instance. If not set, a random UUIC will be generated as instance - name. - slmInstanceName: - type: string - description: Output only. The SLM instance's full resource name. - mdbRolesForCorpAccess: - type: array - description: Input [Optional]. MDB roles for corp access to CloudSQL instance. - items: - type: string - slmInstanceTemplate: - description: Input [Required]. The SLM instance template to provision CloudSQL. - type: string - kmsKeyReference: - description: >- - Input [Optional]. The KMS key name or the KMS grant name used for - CMEK encryption. Only set this field when provisioning new CloudSQL - instances. For existing CloudSQL instances, this field will be - ignored because CMEK re-encryption is not supported. - type: string - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata: - description: The metadata message for Export-to-CDW pipeline. - properties: - documents: - description: >- - The input list of all the resource names of the documents to be - exported. - type: array - items: - type: string - docAiDataset: - description: The output CDW dataset resource name. - type: string - outputPath: - type: string - description: The output Cloud Storage folder in this pipeline. - type: object - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata - GoogleCloudContentwarehouseV1ProcessorInfo: - id: GoogleCloudContentwarehouseV1ProcessorInfo - properties: - documentType: - type: string - description: The processor will process the documents with this document type. - processorName: - description: >- - The processor resource name. Format is - `projects/{project}/locations/{location}/processors/{processor}`, or - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - type: string - schemaName: - description: >- - The Document schema resource name. All documents processed by this - processor will use this schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + fontWeight: type: string + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. type: object - description: The DocAI processor information. - GoogleCloudContentwarehouseV1TimestampArray: + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. + GoogleCloudContentwarehouseV1FileTypeFilter: + properties: + fileType: + enum: + - FILE_TYPE_UNSPECIFIED + - ALL + - FOLDER + - DOCUMENT + - ROOT_FOLDER + type: string + description: The type of files to return. + enumDescriptions: + - Default document type. If set, disables the filter. + - Returns all document types, including folders. + - Returns only folders. + - Returns only non-folder documents. + - Returns only root folders type: object - description: Timestamp values. + id: GoogleCloudContentwarehouseV1FileTypeFilter + description: Filter for the specific types of documents returned. + GoogleCloudDocumentaiV1DocumentPageAnchor: + id: GoogleCloudDocumentaiV1DocumentPageAnchor + description: >- + Referencing the visual context of the entity in the Document.pages. Page + anchors can be cross-page, consist of multiple bounding polygons and + optionally reference specific layout element types. properties: - values: + pageRefs: + description: One or more references to visual page elements items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' - description: List of timestamp values. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef type: array - id: GoogleCloudContentwarehouseV1TimestampArray - GoogleCloudContentwarehouseV1PropertyDefinition: - id: GoogleCloudContentwarehouseV1PropertyDefinition type: object - description: Defines the metadata for a schema property. + GoogleCloudContentwarehouseV1DocumentQuery: + id: GoogleCloudContentwarehouseV1DocumentQuery + type: object properties: - schemaSources: + queryContext: + description: >- + For custom synonyms. Customers provide the synonyms based on + context. One customer can provide multiple set of synonyms based on + different context. The search query will be expanded based on the + custom synonyms of the query context set. By default, no custom + synonyms wll be applied if no query context is provided. It is not + supported for CMEK compliant deployment. items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + type: string type: array - description: >- - The mapping information between this property to another schema - source. - mapTypeOptions: - description: Map property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' - textTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' - description: Text/string property. - propertyTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions - description: Nested structured data property. - isMetadata: - description: >- - Whether the property is user supplied metadata. This out-of-the box - placeholder setting can be used to tag derived properties. Its value - and interpretation logic should be implemented by API user. - type: boolean - retrievalImportance: - enum: - - RETRIEVAL_IMPORTANCE_UNSPECIFIED - - HIGHEST - - HIGHER - - HIGH - - MEDIUM - - LOW - - LOWEST + customPropertyFilter: type: string - description: The retrieval importance of the property during search. - enumDescriptions: - - No importance specified. Default medium importance. - - Highest importance. - - Higher importance. - - High importance. - - Medium importance. - - Low importance (negative). - - Lowest importance (negative). - isRepeatable: - type: boolean - description: Whether the property can have multiple values. - dateTimeTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions - description: >- - Date time property. It is not supported by CMEK compliant - deployment. - timestampTypeOptions: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions + deprecated: true description: >- - Timestamp property. It is not supported by CMEK compliant - deployment. - floatTypeOptions: - description: Float property. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' - isFilterable: - type: boolean + This filter specifies a structured syntax to match against the + [PropertyDefinition].is_filterable marked as `true`. The syntax for + this expression is a subset of SQL syntax. Supported operators are: + `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator + is a property name and the right of the operator is a number or a + quoted string. You must escape backslash (\\) and quote (\") + characters. Supported functions are `LOWER([property_name])` to + perform a case insensitive match and `EMPTY([property_name])` to + filter on the existence of a key. Boolean expressions (AND/OR/NOT) + are supported up to 3 levels of nesting (for example, "((A AND B AND + C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are + allowed in the expression. The expression must be < 6000 bytes in + length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR + EMPTY(driving_license)) AND driving_years > 10` + fileTypeFilter: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' description: >- - Whether the property can be filtered. If this is a sub-property, all - the parent properties must be marked filterable. - isSearchable: - type: boolean - description: Indicates that the property should be included in a global search. - name: - type: string + This filter specifies the types of files to return: ALL, FOLDER, or + FILE. If FOLDER or FILE is specified, then only either folders or + files will be returned, respectively. If ALL is specified, both + folders and files will be returned. If no value is specified, ALL + files will be returned. + query: description: >- - Required. The name of the metadata property. Must be unique within a - document schema and is case insensitive. Names must be non-blank, - start with a letter, and can contain alphanumeric characters and: /, - :, -, _, and . - displayName: + The query string that matches against the full text of the document + and the searchable properties. The query partially supports [Google + AIP style syntax](https://google.aip.dev/160). Specifically, the + query supports literals, logical operators, negation operators, + comparison operators, and functions. Literals: A bare literal value + (examples: "42", "Hugo") is a value to be matched against. It + searches over the full text of the document and the searchable + properties. Logical operators: "AND", "and", "OR", and "or" are + binary logical operators (example: "engineer OR developer"). + Negation operators: "NOT" and "!" are negation operators (example: + "NOT software"). Comparison operators: support the binary comparison + operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. + Also support like operator `~~` for string. It provides semantic + search functionality by parsing, stemming and doing synonyms + expansion against the input query. To specify a property in the + query, the left hand side expression in the comparison must be the + property ID including the parent. The right hand side must be + literals. For example: "\"projects/123/locations/us\".property_a < + 1" matches results whose "property_a" is less than 1 in project 123 + and us location. The literals and comparison expression can be + connected in a single query (example: "software engineer + \"projects/123/locations/us\".salary > 100"). Functions: supported + functions are `LOWER([property_name])` to perform a case insensitive + match and `EMPTY([property_name])` to filter on the existence of a + key. Support nested expressions connected using parenthesis and + logical operators. The default logical operators is `AND` if there + is no operators between expressions. The query can be used with + other filters e.g. `time_filters` and `folder_name_filter`. They are + connected with `AND` operator under the hood. The maximum number of + allowed characters is 255. type: string - description: The display-name for the property, used for front-end. - enumTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' - description: Enum/categorical property. - integerTypeOptions: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' - description: Integer property. - isRequired: - type: boolean - description: >- - Whether the property is mandatory. Default is 'false', i.e. - populating property value can be skipped. If 'true' then user must - populate the value for this property. - GoogleCloudContentwarehouseV1FetchAclResponse: - description: Response message for DocumentService.FetchAcl. - type: object - properties: - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: The IAM policy. - metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + documentCreatorFilter: + type: array description: >- - Additional information for the API invocation, such as the request - tracking id. - id: GoogleCloudContentwarehouseV1FetchAclResponse - GoogleCloudDocumentaiV1DocumentProvenance: - type: object - description: >- - Structure to identify provenance relationships between annotations in - different revisions. - id: GoogleCloudDocumentaiV1DocumentProvenance - properties: - type: - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true + The exact creator(s) of the documents to search against. If a value + isn't specified, documents within the search results are associated + with any creator. If multiple values are specified, documents within + the search results may be associated with any of the specified + creators. + items: + type: string + folderNameFilter: type: string - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - description: The type of provenance operation. - id: - deprecated: true - type: integer - format: int32 description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - parents: - description: References to the original elements that are replaced. + Search all the documents under this specified folder. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. + propertyFilter: + description: >- + This filter specifies a structured syntax to match against the + PropertyDefinition.is_filterable marked as `true`. The relationship + between the PropertyFilters is OR. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' type: array - revision: - format: int32 - deprecated: true - type: integer - description: The index of the revision that produced this element. - GoogleCloudContentwarehouseV1FloatTypeOptions: - description: Configurations for a float property. - properties: {} - type: object - id: GoogleCloudContentwarehouseV1FloatTypeOptions - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: A row of table cells. - properties: - cells: + documentNameFilter: + description: >- + Search the documents in the list. Format: + projects/{project_number}/locations/{location}/documents/{document_id}. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - description: Cells that make up this row. + type: string type: array - GoogleCloudContentwarehouseV1QAResultHighlight: - description: >- - A text span in the search text snippet that represents a highlighted - section (answer context, highly relevant sentence, etc.). - type: object - properties: - endIndex: - description: End index of the highlight, exclusive. - type: integer - format: int32 - startIndex: - description: Start index of the highlight. - format: int32 - type: integer - id: GoogleCloudContentwarehouseV1QAResultHighlight - GoogleCloudContentwarehouseV1UpdateRuleSetRequest: - properties: - ruleSet: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' - description: Required. The rule set to update. - description: Request message for RuleSetService.UpdateRuleSet. - type: object - id: GoogleCloudContentwarehouseV1UpdateRuleSetRequest - GoogleCloudDocumentaiV1DocumentPageBlock: - properties: - detectedLanguages: + customWeightsMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata + description: >- + To support the custom weighting across document schemas, customers + need to provide the properties to be used to boost the ranking in + the search request. For a search query with CustomWeightsMetadata + specified, only the RetrievalImportance for the properties in the + CustomWeightsMetadata will be honored. + isNlQuery: + description: >- + Experimental, do not use. If the query is a natural language + question. False by default. If true, then the question-answering + feature will be used instead of search, and `result_count` in + SearchDocumentsRequest must be set. In addition, all other input + fields related to search (pagination, histograms, etc.) will be + ignored. + type: boolean + documentSchemaNames: type: array items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this annotation. - description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. - type: object - id: GoogleCloudDocumentaiV1DocumentPageBlock - GoogleCloudContentwarehouseV1EnumArray: - properties: - values: + type: string + description: >- + This filter specifies the exact document schema + Document.document_schema_name of the documents to search against. If + a value isn't specified, documents within the search results are + associated with any schema. If multiple values are specified, + documents within the search results may be associated with any of + the specified schemas. At most 20 document schema names are allowed. + timeFilters: + description: >- + Documents created/updated within a range specified by this filter + are searched against. type: array - description: List of enum values. items: - type: string - description: Enum values. - id: GoogleCloudContentwarehouseV1EnumArray - type: object - GoogleCloudDocumentaiV1DocumentPageToken: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' + GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest: + description: Request message for DocumentSchemaService.UpdateDocumentSchema. + properties: + documentSchema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + description: Required. The document schema to update with. type: object + id: GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + GoogleCloudContentwarehouseV1CustomWeightsMetadata: + description: To support the custom weighting across document schemas. properties: - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Text style attributes. - detectedLanguages: - description: A list of detected languages together with confidence. + weightedSchemaProperties: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudContentwarehouseV1WeightedSchemaProperty + description: >- + List of schema and property name. Allows a maximum of 10 schemas to + be specified for relevance boosting. type: array - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - detectedBreak: - description: Detected break at the end of a Token. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - id: GoogleCloudDocumentaiV1DocumentPageToken - description: A detected token. - CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: + type: object + id: GoogleCloudContentwarehouseV1CustomWeightsMetadata + GoogleCloudDocumentaiV1Document: description: >- - The options to create a spanner database. KMS key access audit logging - and AxT logging will be associated with the given resource name, - resource type and service name. Please ensure to give right options to - enable correct audit logging and AxT logging. + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. + id: GoogleCloudDocumentaiV1Document type: object properties: - cmekCloudResourceType: - description: >- - The cloud resource type for the CMEK encryption. For example, - contentwarehouse.googleapis.com/Location + content: type: string - cmekServiceName: description: >- - The service name for the CMEK encryption. For example, - contentwarehouse.googleapis.com + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. + format: byte + textStyles: + deprecated: true + description: Styles for the Document.text. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + shardInfo: + description: >- + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' + pages: + description: Visual page layout for the Document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + type: array + documentLayout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + description: Parsed layout of the document. + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + mimeType: type: string - cmekCloudResourceName: + description: >- + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + text: + description: Optional. UTF-8 encoded text in reading order from the document. type: string + entities: + type: array description: >- - The cloud resource name for the CMEK encryption. For example, - projects//locations/ - id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions - GoogleTypeExpr: - 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. - properties: - location: + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + revisions: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + type: array + description: Placeholder. Revision history of this document. + textChanges: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. + type: array + chunkedDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + description: Document chunked based on chunking config. + uri: type: string - title: description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - description: + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). + entityRelations: + description: Placeholder. Relationship among Document.entities. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + type: array + GoogleCloudContentwarehouseV1TimeFilter: + type: object + properties: + timeField: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - expression: + Specifies which time field to filter documents on. Defaults to + TimeField.UPLOAD_TIME. type: string - description: >- - Textual representation of an expression in Common Expression - Language syntax. - id: GoogleTypeExpr - type: object - GoogleCloudContentwarehouseV1CreateDocumentResponse: + enumDescriptions: + - Default value. + - Earliest document create time. + - Latest document update time. + - Time when document becomes mutable again. + enum: + - TIME_FIELD_UNSPECIFIED + - CREATE_TIME + - UPDATE_TIME + - DISPOSITION_TIME + timeRange: + $ref: '#/components/schemas/GoogleTypeInterval' + id: GoogleCloudContentwarehouseV1TimeFilter + description: Filter on create timestamp or update timestamp of documents. + GoogleCloudContentwarehouseV1UpdateDocumentResponse: + description: Response message for DocumentService.UpdateDocument. + id: GoogleCloudContentwarehouseV1UpdateDocumentResponse properties: + document: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + description: Updated document after executing update request. ruleEngineOutput: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' description: >- Output from Rule Engine recording the rule evaluator and action executor's output. Refer format in: google/cloud/contentwarehouse/v1/rule_engine.proto - longRunningOperations: - type: array - description: post-processing LROs - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - description: Document created after executing create request. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleEngineOutput' metadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' description: >- Additional information for the API invocation, such as the request tracking id. - id: GoogleCloudContentwarehouseV1CreateDocumentResponse - description: Response message for DocumentService.CreateDocument. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' type: object - GoogleCloudContentwarehouseV1GetDocumentRequest: - description: Request message for DocumentService.GetDocument. + GoogleCloudContentwarehouseV1SynonymSetSynonym: type: object - id: GoogleCloudContentwarehouseV1GetDocumentRequest - properties: - requestMetadata: - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - GoogleCloudContentwarehouseV1ListLinkedTargetsRequest: + id: GoogleCloudContentwarehouseV1SynonymSetSynonym properties: - requestMetadata: - description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - id: GoogleCloudContentwarehouseV1ListLinkedTargetsRequest - type: object - description: Request message for DocumentLinkService.ListLinkedTargets. - GoogleTypePostalAddress: + words: + type: array + description: 'For example: sale, invoice, bill, order' + items: + type: string description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 + Represents a list of words given by the customer All these words are + synonyms of each other. + GoogleCloudContentwarehouseV1ActionExecutorOutput: + description: Represents the output of the Action Executor. type: object properties: - languageCode: - type: string - description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - locality: - description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - type: string - sublocality: - description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - type: string - administrativeArea: - type: string - description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. - sortingCode: - type: string - description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). - postalCode: + ruleActionsPairs: + description: List of rule and corresponding actions result. + type: array + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleActionsPair' + id: GoogleCloudContentwarehouseV1ActionExecutorOutput + GoogleCloudContentwarehouseV1Value: + description: >- + `Value` represents a dynamically typed value which can be either be a + float, a integer, a string, or a datetime value. A producer of value is + expected to set one of these variants. Absence of any variant indicates + an error. + properties: + datetimeValue: + description: Represents a datetime value. + $ref: '#/components/schemas/GoogleTypeDateTime' + timestampValue: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampValue' + description: Represents a timestamp value. + intValue: + type: integer + description: Represents a integer value. + format: int32 + stringValue: + description: Represents a string value. type: string - description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - recipients: + floatValue: + type: number + description: Represents a float value. + format: float + enumValue: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumValue' + description: Represents an enum value. + booleanValue: + description: Represents a boolean value. + type: boolean + id: GoogleCloudContentwarehouseV1Value + type: object + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + description: Represents a chunk. + type: object + properties: + pageFooters: items: - type: string - description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter type: array - regionCode: + description: Page footers associated with the chunk. + chunkId: type: string - description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. - addressLines: + description: ID of the chunk. + pageHeaders: type: array items: - type: string - description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). - revision: - type: integer - description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - format: int32 - organization: - description: Optional. The name of the organization at the address. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + description: Page headers associated with the chunk. + content: type: string - id: GoogleTypePostalAddress - GoogleCloudDocumentaiV1BoundingPoly: - properties: - normalizedVertices: + description: Text content of the chunk. + sourceBlockIds: type: array items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - description: The bounding polygon normalized vertices. - vertices: + type: string + description: Unused. + pageSpan: + description: Page span of the chunk. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + GoogleCloudContentwarehouseV1DateTimeArray: + properties: + values: + items: + $ref: '#/components/schemas/GoogleTypeDateTime' type: array + description: >- + List of datetime values. Both OffsetDateTime and ZonedDateTime are + supported. + type: object + description: DateTime values. + id: GoogleCloudContentwarehouseV1DateTimeArray + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + properties: + cells: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - description: The bounding polygon vertices. - description: A bounding polygon for the detected image annotation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + type: array + description: A table row is a list of table cells. type: object - id: GoogleCloudDocumentaiV1BoundingPoly - GoogleCloudContentwarehouseV1DocumentSchema: - id: GoogleCloudContentwarehouseV1DocumentSchema - description: A document schema used to define document structure. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + description: Represents a row in a table. + GoogleTypeExpr: + id: GoogleTypeExpr type: object properties: - displayName: + title: + type: string description: >- - Required. Name of the schema given by the user. Must be unique per - project. + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + expression: type: string - documentIsFolder: - type: boolean description: >- - Document Type, true refers the document is a folder, otherwise it is - a typical document. + Textual representation of an expression in Common Expression + Language syntax. description: - type: string - description: Schema description. - createTime: - description: Output only. The time when the document schema is created. - type: string - readOnly: true - format: google-datetime - propertyDefinitions: - items: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition - description: Document details. - type: array - name: description: >- - The resource name of the document schema. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - The name is ignored when creating a document schema. + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. type: string - updateTime: + location: + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. type: string - readOnly: true - description: Output only. The time when the document schema is last updated. - format: google-datetime - GoogleCloudDocumentaiV1DocumentTextAnchor: + 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. + GoogleCloudContentwarehouseV1ListLinkedTargetsResponse: + type: object properties: - content: + nextPageToken: type: string description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. - textSegments: - description: The text segments from the Document.text. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + documentLinks: + description: Target document-links. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' type: array - id: GoogleCloudDocumentaiV1DocumentTextAnchor - description: Text reference indexing into the Document.text. - type: object - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + description: Response message for DocumentLinkService.ListLinkedTargets. + id: GoogleCloudContentwarehouseV1ListLinkedTargetsResponse + GoogleCloudContentwarehouseV1SetAclResponse: + id: GoogleCloudContentwarehouseV1SetAclResponse type: object + description: Response message for DocumentService.SetAcl. properties: - integerValue: - format: int32 - type: integer - description: Integer value. - dateValue: + metadata: description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - $ref: '#/components/schemas/GoogleTypeDate' - floatValue: - format: float - type: number - description: Float value. - text: + Additional information for the API invocation, such as the request + tracking id. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' + policy: + description: The policy will be attached to a resource (e.g. projecct, document). + $ref: '#/components/schemas/GoogleIamV1Policy' + GoogleCloudContentwarehouseV1PublishAction: + properties: + messages: + type: array + items: + type: string + description: Messages to be published. + topicId: type: string description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - booleanValue: - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - type: boolean - addressValue: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - moneyValue: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - description: Parsed and normalized entity value. - GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest: - id: GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest + The topic id in the Pub/Sub service for which messages will be + published to. + type: object + id: GoogleCloudContentwarehouseV1PublishAction + description: >- + Represents the action responsible for publishing messages to a Pub/Sub + topic. + GoogleCloudDocumentaiV1DocumentTextChange: type: object + description: This message is used for text changes aka. OCR corrections. properties: - requestMetadata: + provenance: + description: The history of this annotation. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + type: array + deprecated: true + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: >- - The meta information collected about the document creator, used to - enforce access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: Request message for DocumentLinkService.DeleteDocumentLink. - GoogleCloudContentwarehouseV1IntegerArray: + Provenance of the correction. Text anchor indexing into the + Document.text. There can only be a single `TextAnchor.text_segments` + element. If the start and end index of the text segment are the + same, the text change is inserted before that index. + changedText: + description: The text that replaces the text identified in the `text_anchor`. + type: string + id: GoogleCloudDocumentaiV1DocumentTextChange + GoogleCloudDocumentaiV1DocumentPageLayout: + properties: + confidence: + description: >- + Confidence of the current Layout within context of the object this + layout is for. e.g. confidence can be for a single token, a table, a + visual element, etc. depending on context. Range `[0, 1]`. + format: float + type: number + boundingPoly: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + description: The bounding polygon for the Layout. + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + orientation: + description: Detected orientation for the Layout. + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + enumDescriptions: + - Unspecified orientation. + - Orientation is aligned with page up. + - >- + Orientation is aligned with page right. Turn the head 90 degrees + clockwise from upright to read. + - >- + Orientation is aligned with page down. Turn the head 180 degrees + from upright to read. + - >- + Orientation is aligned with page left. Turn the head 90 degrees + counterclockwise from upright to read. + type: string + id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Visual element describing a layout unit on a page. type: object - description: Integer values. - id: GoogleCloudContentwarehouseV1IntegerArray + GoogleCloudContentwarehouseV1RuleActionsPair: properties: - values: + rule: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + description: Represents the rule. + actionOutputs: + description: Outputs of executing the actions associated with the above rule. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ActionOutput' type: array - items: - format: int32 - type: integer - description: List of integer values. - GoogleCloudContentwarehouseV1SetAclRequest: - id: GoogleCloudContentwarehouseV1SetAclRequest - properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - projectOwner: - type: boolean - description: >- - For Set Project ACL only. Authorization check for end user will be - ignored when project_owner=true. - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - Required. REQUIRED: The complete policy to be applied to the - `resource`. The size of the policy is limited to a few 10s of KB. - This refers to an Identity and Access (IAM) policy, which specifies - access controls for the Document. You can set ACL with condition for - projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - and `>=` where the left of the operator is `DocumentSchemaId` or - property name and the right of the operator is a number or a quoted - string. You must escape backslash (\\) and quote (\") characters. - Boolean expressions (AND/OR) are supported up to 3 levels of nesting - (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 - comparisons are allowed in the expression. The expression must be < - 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some - schema id\" OR SchemaId.floatPropertyName >= 10"` - description: Request message for DocumentService.SetAcl. + id: GoogleCloudContentwarehouseV1RuleActionsPair type: object - GoogleCloudContentwarehouseV1DocumentReference: + description: Represents a rule and outputs of associated actions. + GoogleCloudContentwarehouseV1Rule: properties: - createTime: - readOnly: true - format: google-datetime - description: Output only. The time when the document is created. + triggerType: + enum: + - UNKNOWN + - ON_CREATE + - ON_UPDATE + - ON_CREATE_LINK + - ON_DELETE_LINK + description: Identifies the trigger type for running the policy. type: string - displayName: - description: >- - display_name of the referenced document; this name does not need to - be consistent to the display_name in the Document proto, depending - on the ACL constraint. + enumDescriptions: + - Trigger for unknown action. + - Trigger for create document action. + - Trigger for update document action. + - Trigger for create link action. + - Trigger for delete link action. + actions: + type: array + description: List of actions that are executed when the rule is satisfied. + items: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' + description: + description: Short description of the rule and its context. type: string - snippet: + condition: type: string description: >- - Stores the subset of the referenced document's content. This is - useful to allow user peek the information of the referenced - document. - deleteTime: - format: google-datetime - description: Output only. The time when the document is deleted. - readOnly: true - type: string - documentName: - type: string - description: Required. Name of the referenced document. - updateTime: - description: Output only. The time when the document is last updated. + Represents the conditional expression to be evaluated. Expression + should evaluate to a boolean result. When the condition is true + actions are executed. Example: user_role = "hsbc_role_1" AND + doc.salary > 20000 + ruleId: + description: >- + ID of the rule. It has to be unique across all the examples. This is + managed internally. type: string - readOnly: true - format: google-datetime - documentIsRetentionFolder: - type: boolean - description: Document is a folder with retention policy. - documentIsFolder: - type: boolean - description: The document type of the document being referenced. - documentIsLegalHoldFolder: - description: Document is a folder with legal hold. - type: boolean - description: References to the documents. - type: object - id: GoogleCloudContentwarehouseV1DocumentReference - GoogleCloudContentwarehouseV1TimestampTypeOptions: + id: GoogleCloudContentwarehouseV1Rule + description: Represents the rule for a content warehouse trigger. type: object - description: Configurations for a timestamp property. - properties: {} - id: GoogleCloudContentwarehouseV1TimestampTypeOptions - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview - description: Human Review information of the document. + GoogleLongrunningOperation: type: object + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. properties: - state: - type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - stateMessage: - type: string + done: + type: boolean description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument: - description: Document entry with metadata inside SearchDocumentsResponse - type: object - id: GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument - properties: - document: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + response: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Document that matches the specified SearchDocumentsRequest. This - document only contains indexed metadata information. - searchTextSnippet: - type: string + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + error: description: >- - Contains snippets of text from the document full raw text that most - closely match a search query's keywords, if available. All HTML tags - in the original fields are stripped when returned in this field, and - matching query keywords are enclosed in HTML bold tags. If the - question-answering feature is enabled, this field will instead - contain a snippet that answers the user's natural-language query. No - HTML bold tags will be present, and highlights in the answer snippet - can be found in QAResult.highlights. - qaResult: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1QAResult' + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Experimental. Additional result info if the question-answering - feature is enabled. - matchedTokenPageIndices: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + name: + type: string description: >- - Return the 1-based page indices where those pages have one or more - matched tokens. + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + CloudAiPlatformTenantresourceTenantProjectResource: + properties: + gcsBuckets: + items: + $ref: '#/components/schemas/CloudAiPlatformTenantresourceGcsBucketConfig' + description: The GCS buckets that are provisioned under the tenant project. type: array + iamPolicyBindings: items: - format: int64 - type: string - GoogleCloudContentwarehouseV1AccessControlAction: - properties: - operationType: - type: string - description: Identifies the type of operation. - enumDescriptions: - - The unknown operation type. - - Adds newly given policy bindings in the existing bindings list. - - >- - Removes newly given policy bindings from the existing bindings - list. - - >- - Replaces existing policy bindings with the given policy binding - list - enum: - - UNKNOWN - - ADD_POLICY_BINDING - - REMOVE_POLICY_BINDING - - REPLACE_POLICY_BINDING - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/CloudAiPlatformTenantresourceIamPolicyBinding' + type: array description: >- - Represents the new policy from which bindings are added, removed or - replaced based on the type of the operation. the policy is limited - to a few 10s of KB. - description: >- - Represents the action responsible for access control list management - operations. - type: object - id: GoogleCloudContentwarehouseV1AccessControlAction - CloudAiPlatformTenantresourceTenantResource: - properties: - p4ServiceAccounts: + The dynamic IAM bindings that are granted under the tenant project. + Note: this should only add new bindings to the project if they don't + exist and the existing bindings won't be affected. + infraSpannerConfigs: + type: array items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceServiceAccountIdentity + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfig + description: >- + The Infra Spanner databases that are provisioned under the tenant + project. Note: this is an experimental feature. + tag: + type: string + description: >- + Input/Output [Required]. The tag that uniquely identifies a tenant + project within a tenancy unit. Note: for the same tenant project + tag, all tenant manager operations should be idempotent. + tenantProjectId: + type: string + description: Output only. The tenant project ID that has been created. + tenantProjectNumber: + type: string + description: Output only. The tenant project number that has been created. + format: int64 + tenantProjectConfig: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceTenantProjectConfig + description: The configurations of a tenant project. + tenantServiceAccounts: + description: >- + The service account identities (or enabled API service's P4SA) that + are expclicitly created under the tenant project (before JIT + provisioning during enabled API services). type: array - description: A list of P4 service accounts (go/p4sa) to provision or deprovision. - tenantProjectResources: items: $ref: >- - #/components/schemas/CloudAiPlatformTenantresourceTenantProjectResource - type: array - description: >- - A list of tenant projects and tenant resources to provision or - deprovision. - description: A collection of tenant resources. - type: object - id: CloudAiPlatformTenantresourceTenantResource - GoogleCloudContentwarehouseV1SynonymSetSynonym: - description: >- - Represents a list of words given by the customer All these words are - synonyms of each other. - id: GoogleCloudContentwarehouseV1SynonymSetSynonym - type: object - properties: - words: - description: 'For example: sale, invoice, bill, order' - items: - type: string - type: array - GoogleCloudContentwarehouseV1DeleteDocumentRequest: - properties: - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + #/components/schemas/CloudAiPlatformTenantresourceTenantServiceAccountIdentity + cloudSqlInstances: description: >- - The meta information collected about the end user, used to enforce - access control for the service. - type: object - description: Request message for DocumentService.DeleteDocument. - id: GoogleCloudContentwarehouseV1DeleteDocumentRequest - GoogleCloudContentwarehouseV1PropertyTypeOptions: - properties: - propertyDefinitions: - type: array + The CloudSQL instances that are provisioned under the tenant + project. items: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition - description: Required. List of property definitions. - description: Configurations for a nested structured data property. - type: object - id: GoogleCloudContentwarehouseV1PropertyTypeOptions - GoogleCloudDocumentaiV1Vertex: - properties: - 'y': - type: integer - format: int32 - description: Y coordinate (starts from the top of the image). - x: - description: X coordinate. - format: int32 - type: integer - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. + #/components/schemas/CloudAiPlatformTenantresourceCloudSqlInstanceConfig + type: array + id: CloudAiPlatformTenantresourceTenantProjectResource type: object - id: GoogleCloudDocumentaiV1Vertex + description: 'The tenant project and tenant resources. Next ID: 10' GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource: + type: object id: GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource description: The schema source information. properties: name: - description: The schema name in the source. type: string + description: The schema name in the source. processorType: - description: The Doc AI processor type name. type: string - type: object - GoogleCloudContentwarehouseV1DocumentQuery: - id: GoogleCloudContentwarehouseV1DocumentQuery - type: object + description: The Doc AI processor type name. + GoogleCloudContentwarehouseV1DocumentSchema: properties: - queryContext: - type: array - description: >- - For custom synonyms. Customers provide the synonyms based on - context. One customer can provide multiple set of synonyms based on - different context. The search query will be expanded based on the - custom synonyms of the query context set. By default, no custom - synonyms wll be applied if no query context is provided. It is not - supported for CMEK compliant deployment. - items: - type: string - timeFilters: - description: >- - Documents created/updated within a range specified by this filter - are searched against. - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimeFilter' - type: array - customWeightsMetadata: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CustomWeightsMetadata - description: >- - To support the custom weighting across document schemas, customers - need to provide the properties to be used to boost the ranking in - the search request. For a search query with CustomWeightsMetadata - specified, only the RetrievalImportance for the properties in the - CustomWeightsMetadata will be honored. - documentCreatorFilter: - items: - type: string - description: >- - The exact creator(s) of the documents to search against. If a value - isn't specified, documents within the search results are associated - with any creator. If multiple values are specified, documents within - the search results may be associated with any of the specified - creators. - type: array - folderNameFilter: + name: type: string description: >- - Search all the documents under this specified folder. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - propertyFilter: - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyFilter' - description: >- - This filter specifies a structured syntax to match against the - PropertyDefinition.is_filterable marked as `true`. The relationship - between the PropertyFilters is OR. - type: array - documentNameFilter: - description: >- - Search the documents in the list. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. + The resource name of the document schema. Format: + projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + The name is ignored when creating a document schema. + updateTime: + description: Output only. The time when the document schema is last updated. + readOnly: true + format: google-datetime + type: string + description: + description: Schema description. + type: string + createTime: + readOnly: true + description: Output only. The time when the document schema is created. + format: google-datetime + type: string + propertyDefinitions: items: - type: string + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinition type: array - isNlQuery: + description: Document details. + displayName: + type: string description: >- - Experimental, do not use. If the query is a natural language - question. False by default. If true, then the question-answering - feature will be used instead of search, and `result_count` in - SearchDocumentsRequest must be set. In addition, all other input - fields related to search (pagination, histograms, etc.) will be - ignored. + Required. Name of the schema given by the user. Must be unique per + project. + documentIsFolder: type: boolean - customPropertyFilter: description: >- - This filter specifies a structured syntax to match against the - [PropertyDefinition].is_filterable marked as `true`. The syntax for - this expression is a subset of SQL syntax. Supported operators are: - `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator - is a property name and the right of the operator is a number or a - quoted string. You must escape backslash (\\) and quote (\") - characters. Supported functions are `LOWER([property_name])` to - perform a case insensitive match and `EMPTY([property_name])` to - filter on the existence of a key. Boolean expressions (AND/OR/NOT) - are supported up to 3 levels of nesting (for example, "((A AND B AND - C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are - allowed in the expression. The expression must be < 6000 bytes in - length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` - deprecated: true + Document Type, true refers the document is a folder, otherwise it is + a typical document. + id: GoogleCloudContentwarehouseV1DocumentSchema + description: A document schema used to define document structure. + type: object + GoogleCloudContentwarehouseV1ProjectStatus: + id: GoogleCloudContentwarehouseV1ProjectStatus + type: object + description: >- + Status of a project, including the project state, dbType, aclMode and + etc. + properties: + state: + description: State of the project. + enum: + - PROJECT_STATE_UNSPECIFIED + - PROJECT_STATE_PENDING + - PROJECT_STATE_COMPLETED + - PROJECT_STATE_FAILED + - PROJECT_STATE_DELETING + - PROJECT_STATE_DELETING_FAILED + - PROJECT_STATE_DELETED + - PROJECT_STATE_NOT_FOUND + enumDescriptions: + - Default status, required by protobuf best practices. + - The project is in the middle of a provision process. + - All dependencies have been provisioned. + - A provision process was previously initiated, but failed. + - The project is in the middle of a deletion process. + - A deleting process was initiated, but failed. + - The project is deleted. + - The project is not found. type: string - documentSchemaNames: + accessControlMode: + type: string + enumDescriptions: + - This value is required by protobuf best practices + - 'Universal Access: No document level access control.' + - Document level access control with customer own Identity Service. + - Document level access control using Google Cloud Identity. + description: Access control mode. + enum: + - ACL_MODE_UNKNOWN + - ACL_MODE_UNIVERSAL_ACCESS + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID + - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI + documentCreatorDefaultRole: + description: The default role for the person who create a document. + type: string + qaEnabled: + description: If the qa is enabled on this project. + type: boolean + databaseType: + enum: + - DB_UNKNOWN + - DB_INFRA_SPANNER + - DB_CLOUD_SQL_POSTGRES + enumDescriptions: + - This value is required by protobuf best practices + - Internal Spanner + - Cloud Sql with a Postgres Sql instance + type: string + description: Database type. + enumDeprecated: + - false + - false + - true + location: + type: string + description: The location of the queried project. + GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline: + id: GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline + description: >- + The configuration of processing documents in Document Warehouse with + DocAi processors pipeline. + properties: + documents: description: >- - This filter specifies the exact document schema - Document.document_schema_name of the documents to search against. If - a value isn't specified, documents within the search results are - associated with any schema. If multiple values are specified, - documents within the search results may be associated with any of - the specified schemas. At most 20 document schema names are allowed. + The list of all the resource names of the documents to be processed. + Format: + projects/{project_number}/locations/{location}/documents/{document_id}. items: type: string type: array - query: + exportFolderPath: + type: string description: >- - The query string that matches against the full text of the document - and the searchable properties. The query partially supports [Google - AIP style syntax](https://google.aip.dev/160). Specifically, the - query supports literals, logical operators, negation operators, - comparison operators, and functions. Literals: A bare literal value - (examples: "42", "Hugo") is a value to be matched against. It - searches over the full text of the document and the searchable - properties. Logical operators: "AND", "and", "OR", and "or" are - binary logical operators (example: "engineer OR developer"). - Negation operators: "NOT" and "!" are negation operators (example: - "NOT software"). Comparison operators: support the binary comparison - operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. - Also support like operator `~~` for string. It provides semantic - search functionality by parsing, stemming and doing synonyms - expansion against the input query. To specify a property in the - query, the left hand side expression in the comparison must be the - property ID including the parent. The right hand side must be - literals. For example: "\"projects/123/locations/us\".property_a < - 1" matches results whose "property_a" is less than 1 in project 123 - and us location. The literals and comparison expression can be - connected in a single query (example: "software engineer - \"projects/123/locations/us\".salary > 100"). Functions: supported - functions are `LOWER([property_name])` to perform a case insensitive - match and `EMPTY([property_name])` to filter on the existence of a - key. Support nested expressions connected using parenthesis and - logical operators. The default logical operators is `AND` if there - is no operators between expressions. The query can be used with - other filters e.g. `time_filters` and `folder_name_filter`. They are - connected with `AND` operator under the hood. The maximum number of - allowed characters is 255. + The Cloud Storage folder path used to store the exported documents + before being sent to CDW. Format: `gs:///`. + processorResultsFolderPath: type: string - fileTypeFilter: description: >- - This filter specifies the types of files to return: ALL, FOLDER, or - FILE. If FOLDER or FILE is specified, then only either folders or - files will be returned, respectively. If ALL is specified, both - folders and files will be returned. If no value is specified, ALL - files will be returned. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FileTypeFilter' - GoogleCloudDocumentaiV1DocumentPageAnchor: + The Cloud Storage folder path used to store the raw results from + processors. Format: `gs:///`. + processorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The CDW processor information. + type: object + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + description: Represents a weak reference to a page element within a document. type: object properties: - pageRefs: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - description: One or more references to visual page elements - type: array - description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. - id: GoogleCloudDocumentaiV1DocumentPageAnchor - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: - properties: - languageCode: - description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. - type: string confidence: - format: float - description: Confidence of detected language. Range `[0, 1]`. type: number - type: object - description: Detected language for a structural component. - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - GoogleCloudContentwarehouseV1TimeFilter: - type: object - id: GoogleCloudContentwarehouseV1TimeFilter - properties: - timeField: + format: float + description: >- + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + layoutId: type: string + deprecated: true + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + page: + format: int64 description: >- - Specifies which time field to filter documents on. Defaults to - TimeField.UPLOAD_TIME. + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. + type: string + boundingPoly: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + description: >- + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + layoutType: + description: >- + Optional. The type of the layout element that is being referenced if + any. enumDescriptions: - - Default value. - - Earliest document create time. - - Latest document update time. - - Time when document becomes mutable again. + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. enum: - - TIME_FIELD_UNSPECIFIED - - CREATE_TIME - - UPDATE_TIME - - DISPOSITION_TIME - timeRange: - $ref: '#/components/schemas/GoogleTypeInterval' - description: Filter on create timestamp or update timestamp of documents. - GoogleCloudDocumentaiV1Barcode: - id: GoogleCloudDocumentaiV1Barcode + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD + type: string + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata: + type: object + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata properties: - valueFormat: + processorInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ProcessorInfo' + description: The DocAI processor to process the documents with. + documents: description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - type: string - format: + The input list of all the resource names of the documents to be + processed. + items: + type: string + type: array + description: The metadata message for Process-with-DocAi pipeline. + GoogleCloudContentwarehouseV1UserInfo: + description: The user information. + properties: + groupIds: + items: + type: string + description: >- + The unique group identifications which the user is belong to. The + format is "group:yyyy@example.com"; + type: array + id: type: string description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - rawValue: + A unique user identification string, as determined by the client. + The maximum number of allowed characters is 255. Allowed characters + include numbers 0 to 9, uppercase and lowercase letters, and + restricted special symbols (:, @, +, -, _, ~) The format is + "user:xxxx@example.com"; + id: GoogleCloudContentwarehouseV1UserInfo + type: object + GoogleCloudDocumentaiV1DocumentPageTable: + type: object + properties: + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + type: array + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this table. + deprecated: true + headerRows: + description: Header rows of the table. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + type: array + layout: + description: Layout for Table. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + bodyRows: + description: Body rows of the table. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: A table representation similar to HTML table structure. + id: GoogleCloudDocumentaiV1DocumentPageTable + GoogleIamV1Binding: + description: Associates `members`, or principals, with a `role`. + properties: + members: + type: array + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + items: + type: string + role: type: string description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - description: Encodes the detailed information of a barcode. - type: object - GoogleCloudContentwarehouseV1EnumValue: - properties: - value: + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + condition: description: >- - String value of the enum field. This must match defined set of enums - in document schema using EnumTypeOptions. - type: string - id: GoogleCloudContentwarehouseV1EnumValue - description: Represents the string value of the enum field. + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + id: GoogleIamV1Binding type: object - GoogleCloudContentwarehouseV1DeleteDocumentAction: - description: Represents the action responsible for deleting the document. - id: GoogleCloudContentwarehouseV1DeleteDocumentAction + GoogleCloudContentwarehouseV1CreateDocumentMetadata: + properties: {} + description: Metadata object for CreateDocument request (currently empty). + id: GoogleCloudContentwarehouseV1CreateDocumentMetadata type: object + CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions: properties: - enableHardDelete: - type: boolean + cmekCloudResourceName: description: >- - Boolean field to select between hard vs soft delete options. Set - 'true' for 'hard delete' and 'false' for 'soft delete'. - GoogleTypeInterval: - type: object - id: GoogleTypeInterval - properties: - endTime: + The cloud resource name for the CMEK encryption. For example, + projects//locations/ type: string + cmekCloudResourceType: description: >- - Optional. Exclusive end of the interval. If specified, a Timestamp - matching this interval will have to be before the end. - format: google-datetime - startTime: + The cloud resource type for the CMEK encryption. For example, + contentwarehouse.googleapis.com/Location + type: string + cmekServiceName: type: string description: >- - Optional. Inclusive start of the interval. If specified, a Timestamp - matching this interval will have to be the same or after the start. - format: google-datetime + The service name for the CMEK encryption. For example, + contentwarehouse.googleapis.com description: >- - Represents a time interval, encoded as a Timestamp start (inclusive) and - a Timestamp end (exclusive). The start must be less than or equal to the - end. When the start equals the end, the interval is empty (matches no - time). When both start and end are unspecified, the interval matches any - time. - CloudAiPlatformTenantresourceServiceAccountIdentity: - description: The identity to configure a service account. + The options to create a spanner database. KMS key access audit logging + and AxT logging will be associated with the given resource name, + resource type and service name. Please ensure to give right options to + enable correct audit logging and AxT logging. type: object - properties: - serviceAccountEmail: - type: string - description: Output only. The service account email that has been created. - tag: - type: string - description: >- - Input/Output [Optional]. The tag that configures the service - account, as defined in - google3/configs/production/cdpush/acl-zanzibar-cloud-prod/activation_grants/activation_grants.gcl. - Note: The default P4 service account has the empty tag. - id: CloudAiPlatformTenantresourceServiceAccountIdentity - GoogleCloudContentwarehouseV1UpdateDocumentRequest: - id: GoogleCloudContentwarehouseV1UpdateDocumentRequest - description: Request message for DocumentService.UpdateDocument. - properties: - updateOptions: - description: Options for the update operation. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UpdateOptions' - requestMetadata: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - description: >- - The meta information collected about the end user, used to enforce - access control for the service. - document: - description: Required. The document to update. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - cloudAiDocumentOption: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CloudAIDocumentOption - description: >- - Request Option for processing Cloud AI Document in Document - Warehouse. This field offers limited support for mapping entities - from Cloud AI Document to Warehouse Document. Please consult with - product team before using this field and other available options. + id: CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + GoogleCloudContentwarehouseV1IngestPipelineConfig: type: object - GoogleCloudContentwarehouseV1Rule: + id: GoogleCloudContentwarehouseV1IngestPipelineConfig properties: - actions: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Action' - description: List of actions that are executed when the rule is satisfied. - description: - type: string - description: Short description of the rule and its context. - ruleId: + enableDocumentTextExtraction: + type: boolean + description: >- + The document text extraction enabled flag. If the flag is set to + true, DWH will perform text extraction on the raw document. + folder: type: string description: >- - ID of the rule. It has to be unique across all the examples. This is - managed internally. - condition: + Optional. The name of the folder to which all ingested documents + will be linked during ingestion process. Format is + `projects/{project}/locations/{location}/documents/{folder_id}` + documentAclPolicy: description: >- - Represents the conditional expression to be evaluated. Expression - should evaluate to a boolean result. When the condition is true - actions are executed. Example: user_role = "hsbc_role_1" AND - doc.salary > 20000 - type: string - triggerType: - enumDescriptions: - - Trigger for unknown action. - - Trigger for create document action. - - Trigger for update document action. - - Trigger for create link action. - - Trigger for delete link action. - enum: - - UNKNOWN - - ON_CREATE - - ON_UPDATE - - ON_CREATE_LINK - - ON_DELETE_LINK - description: Identifies the trigger type for running the policy. - type: string - id: GoogleCloudContentwarehouseV1Rule - type: object - description: Represents the rule for a content warehouse trigger. - GoogleCloudContentwarehouseV1AddToFolderAction: - properties: - folders: - items: - type: string - type: array + The document level acl policy config. This refers to an Identity and + Access (IAM) policy, which specifies access controls for all + documents ingested by the pipeline. The role and members under the + policy needs to be specified. The following roles are supported for + document level acl control: * roles/contentwarehouse.documentAdmin * + roles/contentwarehouse.documentEditor * + roles/contentwarehouse.documentViewer The following members are + supported for document level acl control: * + user:user-email@example.com * group:group-email@example.com Note + that for documents searched with LLM, only single level user or + group acl check is supported. + $ref: '#/components/schemas/GoogleIamV1Policy' + cloudFunction: description: >- - Names of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - id: GoogleCloudContentwarehouseV1AddToFolderAction - description: Represents the action responsible for adding document under a folder. - type: object - GoogleCloudContentwarehouseV1DateTimeArray: - type: object - id: GoogleCloudContentwarehouseV1DateTimeArray - description: DateTime values. + The Cloud Function resource name. The Cloud Function needs to live + inside consumer project and is accessible to Document AI Warehouse + P4SA. Only Cloud Functions V2 is supported. Cloud function execution + should complete within 5 minutes or this file ingestion may fail due + to timeout. Format: + `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}` + The following keys are available the request json payload. * + display_name * properties * plain_text * reference_id * + document_schema_name * raw_document_path * raw_document_file_type + The following keys from the cloud function json response payload + will be ingested to the Document AI Warehouse as part of Document + proto content and/or related information. The original values will + be overridden if any key is present in the response. * display_name + * properties * plain_text * document_acl_policy * folder + type: string + description: The ingestion pipeline config. + GoogleCloudDocumentaiV1DocumentPageTableTableCell: properties: - values: - description: >- - List of datetime values. Both OffsetDateTime and ZonedDateTime are - supported. + colSpan: + description: How many columns this cell spans. + type: integer + format: int32 + rowSpan: + description: How many rows this cell spans. + type: integer + format: int32 + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for TableCell. + detectedLanguages: items: - $ref: '#/components/schemas/GoogleTypeDateTime' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. type: array - GoogleCloudContentwarehouseV1InitializeProjectRequest: + description: A cell representation inside the table. + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + type: object + GoogleCloudContentwarehouseV1SetAclRequest: + description: Request message for DocumentService.SetAcl. properties: - accessControlMode: - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - description: Required. The access control mode for accessing the customer data - type: string - enableCalUserEmailLogging: - description: Optional. Whether to enable CAL user email logging. + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + Required. REQUIRED: The complete policy to be applied to the + `resource`. The size of the policy is limited to a few 10s of KB. + This refers to an Identity and Access (IAM) policy, which specifies + access controls for the Document. You can set ACL with condition for + projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, + and `>=` where the left of the operator is `DocumentSchemaId` or + property name and the right of the operator is a number or a quoted + string. You must escape backslash (\\) and quote (\") characters. + Boolean expressions (AND/OR) are supported up to 3 levels of nesting + (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 + comparisons are allowed in the expression. The expression must be < + 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some + schema id\" OR SchemaId.floatPropertyName >= 10"` + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the end user, used to enforce + access control for the service. + projectOwner: type: boolean - kmsKey: - type: string description: >- - Optional. The KMS key used for CMEK encryption. It is required that - the kms key is in the same region as the endpoint. The same key will - be used for all provisioned resources, if encryption is available. - If the kms_key is left empty, no encryption will be enforced. - databaseType: - enumDeprecated: - - false - - false - - true - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - description: Required. The type of database used to store customer data - type: string - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - documentCreatorDefaultRole: - enumDescriptions: - - Unspecified, will be default to document admin role. - - >- - Document Admin, same as - contentwarehouse.googleapis.com/documentAdmin. - - >- - Document Editor, same as - contentwarehouse.googleapis.com/documentEditor. - - >- - Document Viewer, same as - contentwarehouse.googleapis.com/documentViewer. - description: Optional. The default role for the person who create a document. - enum: - - DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED - - DOCUMENT_ADMIN - - DOCUMENT_EDITOR - - DOCUMENT_VIEWER - type: string - description: Request message for projectService.InitializeProject + For Set Project ACL only. Authorization check for end user will be + ignored when project_owner=true. type: object - id: GoogleCloudContentwarehouseV1InitializeProjectRequest - GoogleCloudContentwarehouseV1ListLinkedSourcesResponse: - id: GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + id: GoogleCloudContentwarehouseV1SetAclRequest + GoogleCloudContentwarehouseV1HistogramQuery: + type: object + id: GoogleCloudContentwarehouseV1HistogramQuery + description: The histogram request. properties: - nextPageToken: + filters: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter + description: >- + Optional. Filter the result of histogram query by the property + names. It only works with histogram query + count('FilterableProperties'). It is an optional. It will perform + histogram on all the property names for all the document schemas. + Setting this field will have a better performance. + histogramQuery: + description: >- + An expression specifies a histogram request against matching + documents for searches. See SearchDocumentsRequest.histogram_queries + for details about syntax. type: string + requirePreciseResultSize: + type: boolean description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - documentLinks: - type: array - items: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' - description: Source document-links. - description: Response message for DocumentLinkService.ListLinkedSources. + Controls if the histogram query requires the return of a precise + count. Enable this flag may adversely impact performance. Defaults + to true. + GoogleCloudContentwarehouseV1MapProperty: + properties: + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Value' + description: Unordered map of dynamically typed values. + description: >- + Map property value. Represents a structured entries of key value pairs, + consisting of field names which map to dynamically typed values. type: object - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: + id: GoogleCloudContentwarehouseV1MapProperty + GoogleTypeDateTime: type: object - id: >- - GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + id: GoogleTypeDateTime + description: >- + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. properties: - inputPath: - description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' + utcOffset: + format: google-duration + description: >- + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. type: string - description: The metadata message for GcsIngest pipeline. - GoogleCloudContentwarehouseV1SetAclResponse: - properties: - policy: - description: The policy will be attached to a resource (e.g. projecct, document). - $ref: '#/components/schemas/GoogleIamV1Policy' - metadata: + hours: + format: int32 + type: integer description: >- - Additional information for the API invocation, such as the request - tracking id. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1ResponseMetadata' - description: Response message for DocumentService.SetAcl. - id: GoogleCloudContentwarehouseV1SetAclResponse - type: object - GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata: - description: Metadata object for CreateDocument request (currently empty). - properties: {} - id: GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata - type: object - GoogleApiServiceconsumermanagementV1PolicyBinding: - id: GoogleApiServiceconsumermanagementV1PolicyBinding + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + minutes: + type: integer + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + format: int32 + month: + description: >- + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + type: integer + format: int32 + day: + format: int32 + type: integer + description: >- + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + timeZone: + $ref: '#/components/schemas/GoogleTypeTimeZone' + description: Time zone. + year: + format: int32 + type: integer + description: >- + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + seconds: + format: int32 + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + type: integer + nanos: + format: int32 + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + type: integer + GoogleCloudContentwarehouseV1TextArray: + description: String/text values. type: object + id: GoogleCloudContentwarehouseV1TextArray properties: - members: + values: type: array items: type: string - description: >- - Uses the same format as in IAM policy. `member` must include both a - prefix and ID. For example, `user:{emailId}`, - `serviceAccount:{emailId}`, `group:{emailId}`. - role: - type: string - description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. - description: Translates to IAM Policy bindings (without auditing at this level) - GoogleCloudContentwarehouseV1InitializeProjectResponse: + description: List of text values. + GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentEntityRelation type: object - id: GoogleCloudContentwarehouseV1InitializeProjectResponse properties: - message: - type: string - description: The message of the project initialization process. - state: - enum: - - STATE_UNSPECIFIED - - SUCCEEDED - - FAILED - - CANCELLED - - RUNNING + subjectId: type: string - description: The state of the project initialization process. - enumDescriptions: - - Clients should never see this. - - Finished project initialization without error. - - Finished project initialization with an error. - - Client canceled the LRO. - - Ask the customer to check the operation for results. - description: Response message for projectService.InitializeProject - GoogleCloudContentwarehouseV1PropertyFilter: - properties: - documentSchemaName: - description: >- - The Document schema name Document.document_schema_name. Format: - projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. + description: Subject entity id. + relation: type: string - condition: + description: Relationship description. + objectId: + description: Object entity id. type: string - description: >- - The filter condition. The syntax for this expression is a subset of - SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, - `>=`, and `~~` where the left of the operator is a property name and - the right of the operator is a number or a quoted string. You must - escape backslash (\\) and quote (\") characters. `~~` is the LIKE - operator. The right of the operator must be a string. The only - supported property data type for LIKE is text_values. It provides - semantic search functionality by parsing, stemming and doing - synonyms expansion against the input query. It matches if the - property contains semantic similar content to the query. It is not - regex matching or wildcard matching. For example, "property.company - ~~ \"google\"" will match records whose property `property.compnay` - have values like "Google Inc.", "Google LLC" or "Google Company". - Supported functions are `LOWER([property_name])` to perform a case - insensitive match and `EMPTY([property_name])` to filter on the - existence of a key. Boolean expressions (AND/OR/NOT) are supported - up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) - AND E"), a maximum of 100 comparisons or functions are allowed in - the expression. The expression must be < 6000 bytes in length. Only - properties that are marked filterable are allowed - (PropertyDefinition.is_filterable). Property names do not need to be - prefixed by the document schema id (as is the case with histograms), - however property names will need to be prefixed by its parent - hierarchy, if any. For example: top_property_name.sub_property_name. - Sample Query: `(LOWER(driving_license)="class \"a\"" OR - EMPTY(driving_license)) AND driving_years > 10` CMEK compliant - deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and - `>=`. * Boolean expressions: AND and OR. - id: GoogleCloudContentwarehouseV1PropertyFilter - type: object - GoogleIamV1Binding: - description: Associates `members`, or principals, with a `role`. + description: Relationship between Entities. + GoogleCloudDocumentaiV1DocumentChunkedDocument: type: object - id: GoogleIamV1Binding properties: - role: + chunks: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + type: array + description: List of chunks. + id: GoogleCloudDocumentaiV1DocumentChunkedDocument + description: Represents the chunks that the document is divided into. + CloudAiPlatformTenantresourceCloudSqlInstanceConfig: + properties: + slmInstanceType: + description: Input [Required]. The SLM instance type to provision CloudSQL. type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - members: + slmInstanceTemplate: + type: string + description: Input [Required]. The SLM instance template to provision CloudSQL. + mdbRolesForCorpAccess: items: type: string - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. type: array - GoogleCloudContentwarehouseV1TimestampValue: - description: Timestamp value type. - properties: - textValue: + description: Input [Optional]. MDB roles for corp access to CloudSQL instance. + slmInstanceName: + type: string + description: Output only. The SLM instance's full resource name. + kmsKeyReference: description: >- - The string must represent a valid instant in UTC and is parsed using - java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. - "2013-09-29T18:46:19Z" + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new CloudSQL + instances. For existing CloudSQL instances, this field will be + ignored because CMEK re-encryption is not supported. type: string - timestampValue: - format: google-datetime - description: Timestamp value + cloudSqlInstanceName: type: string - id: GoogleCloudContentwarehouseV1TimestampValue - type: object - GoogleCloudDocumentaiV1DocumentPageLayout: - id: GoogleCloudDocumentaiV1DocumentPageLayout - type: object - description: Visual element describing a layout unit on a page. - properties: - confidence: - type: number - format: float description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - orientation: - enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. - - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. - - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - description: Detected orientation for the Layout. + Input/Output [Optional]. The CloudSQL instance name within SLM + instance. If not set, a random UUIC will be generated as instance + name. + cloudSqlInstanceConnectionName: + description: Output only. The CloudSQL instance connection name. type: string - GoogleCloudContentwarehouseV1LockDocumentRequest: + description: >- + The identity to configure a CloudSQL instance provisioned via SLM + Terraform. type: object + id: CloudAiPlatformTenantresourceCloudSqlInstanceConfig + CloudAiPlatformTenantresourceInfraSpannerConfig: properties: - lockingUser: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' - description: The user information who locks the document. - collectionId: + spannerBorgServiceAccount: type: string - description: The collection the document connects to. - id: GoogleCloudContentwarehouseV1LockDocumentRequest - description: Request message for DocumentService.LockDocument. - GoogleCloudContentwarehouseV1DataValidationAction: - id: GoogleCloudContentwarehouseV1DataValidationAction - description: Represents the action responsible for data validation operations. - properties: - conditions: - type: object description: >- - Map of (K, V) -> (field, string condition to be evaluated on the - field) E.g., ("age", "age > 18 && age < 60") entry triggers - validation of field age with the given condition. Map entries will - be ANDed during validation. - additionalProperties: - type: string - type: object - GoogleCloudDocumentaiV1DocumentShardInfo: - properties: - textOffset: + Input [Optional]. The spanner borg service account for delegating + the kms key to. For example, + spanner-infra-cmek-nonprod@system.gserviceaccount.com, for the + nonprod universe. + sdlBundlePath: + type: string + description: Input [Required]. The file path to the spanner SDL bundle. + kmsKeyReference: description: >- - The index of the first character in Document.text in the overall - document global text. + Input [Optional]. The KMS key name or the KMS grant name used for + CMEK encryption. Only set this field when provisioning new Infra + Spanner databases. For existing Infra Spanner databases, this field + will be ignored because CMEK re-encryption is not supported. For + example, projects//locations//keyRings//cryptoKeys/ type: string - format: int64 - shardCount: + spannerNamespace: type: string - description: Total number of shards. - format: int64 - shardIndex: - format: int64 - description: The 0-based index of this shard. + spannerLocalNamePrefix: type: string - id: GoogleCloudDocumentaiV1DocumentShardInfo - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. + createDatabaseOptions: + $ref: >- + #/components/schemas/CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions + description: >- + Input [Optional]. The options to create a spanner database. Note: + give the right options to ensure the right KMS key access audit + logging and AxT logging in expected logging category. + spannerUniverse: + type: string + description: >- + Input [Required]. Every database in Spanner can be identified by the + following path name: /span//: + id: CloudAiPlatformTenantresourceInfraSpannerConfig type: object - GoogleCloudDocumentaiV1DocumentProvenanceParent: + description: 'The configuration for a spanner database provisioning. Next ID: 8' + GoogleCloudContentwarehouseV1InvalidRule: properties: - revision: - description: The index of the index into current revision's parent_ids list. - format: int32 - type: integer - id: - deprecated: true - format: int32 - description: The id of the parent provenance. - type: integer - index: - type: integer - format: int32 - description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - id: GoogleCloudDocumentaiV1DocumentProvenanceParent + rule: + description: Triggered rule. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Rule' + error: + description: Validation error on a parsed expression. + type: string + id: GoogleCloudContentwarehouseV1InvalidRule + description: A triggered rule that failed the validation check(s) after parsing. type: object + GoogleTypePostalAddress: description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - GoogleCloudContentwarehouseV1MergeFieldsOptions: - id: GoogleCloudContentwarehouseV1MergeFieldsOptions - type: object + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + id: GoogleTypePostalAddress properties: - replaceRepeatedFields: + organization: + description: Optional. The name of the organization at the address. + type: string + sublocality: description: >- - When merging repeated fields, the default behavior is to append - entries from the source repeated field to the destination repeated - field. If you instead want to keep only the entries from the source - repeated field, set this flag to true. If you want to replace a - repeated field within a message field on the destination message, - you must set both replace_repeated_fields and replace_message_fields - to true, otherwise the repeated fields will be appended. - type: boolean - replaceMessageFields: - type: boolean + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + type: string + administrativeArea: description: >- - When merging message fields, the default behavior is to merge the - content of two message fields together. If you instead want to use - the field from the source message to replace the corresponding field - in the destination message, set this flag to true. When this flag is - set, specified submessage fields that are missing in source will be - cleared in destination. - description: Options for merging updated fields. - GoogleCloudContentwarehouseV1UserInfo: - properties: - id: + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (e.g. + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. E.g. in Switzerland this + should be left unpopulated. + type: string + revision: + format: int32 description: >- - A unique user identification string, as determined by the client. - The maximum number of allowed characters is 255. Allowed characters - include numbers 0 to 9, uppercase and lowercase letters, and - restricted special symbols (:, @, +, -, _, ~) The format is - "user:xxxx@example.com"; + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + type: integer + postalCode: + description: >- + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). type: string - groupIds: + addressLines: + items: + type: string type: array description: >- - The unique group identifications which the user is belong to. The - format is "group:yyyy@example.com"; + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for + large-to-small ordering and "ja-Latn" or "en" for small-to-large). + This way, the most specific line of an address can be selected based + on the language. The minimum permitted structural representation of + an address consists of a region_code with all remaining information + placed in the address_lines. It would be possible to format such an + address very approximately without geocoding, but no semantic + reasoning could be made about any of the address components until it + was at least partially resolved. Creating an address only containing + a region_code and address_lines, and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + recipients: items: type: string - description: The user information. - id: GoogleCloudContentwarehouseV1UserInfo - type: object - GoogleCloudContentwarehouseV1ActionOutput: - description: Represents the result of executing an action. - type: object - id: GoogleCloudContentwarehouseV1ActionOutput - properties: - actionState: - type: string - enumDescriptions: - - The unknown state. - - State indicating action executed successfully. - - State indicating action failed. - - State indicating action timed out. - - State indicating action is pending. - enum: - - UNKNOWN - - ACTION_SUCCEEDED - - ACTION_FAILED - - ACTION_TIMED_OUT - - ACTION_PENDING - description: State of an action. - outputMessage: - description: Action execution output message. - type: string - actionId: - description: ID of the action. + type: array + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. + sortingCode: type: string - GoogleCloudContentwarehouseV1RunPipelineRequest: - properties: - processWithDocAiPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline description: >- - Use a DocAI processor to process documents in Document Warehouse, - and re-ingest the updated results into Document Warehouse. - exportCdwPipeline: + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). + locality: description: >- - Export docuemnts from Document Warehouse to CDW for training - purpose. - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ExportToCdwPipeline - gcsIngestWithDocAiProcessorsPipeline: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. + type: string + languageCode: description: >- - Use DocAI processors to process documents in Cloud Storage and - ingest them to Document Warehouse. - requestMetadata: + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + type: string + regionCode: + type: string description: >- - The meta information collected about the end user, used to enforce - access control for the service. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' - gcsIngestPipeline: - description: Cloud Storage ingestion pipeline. - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1GcsIngestPipeline' - id: GoogleCloudContentwarehouseV1RunPipelineRequest - type: object - description: Request message for DocumentService.RunPipeline. - GoogleCloudContentwarehouseV1DataUpdateAction: - description: Represents the action responsible for properties update operations. + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + type: object + GoogleCloudContentwarehouseV1CreateDocumentLinkRequest: properties: - entries: + documentLink: description: >- - Map of (K, V) -> (valid name of the field, new value of the field) - E.g., ("age", "60") entry triggers update of field age with a value - of 60. If the field is not present then new entry is added. During - update action execution, value strings will be casted to appropriate - types. - additionalProperties: - type: string - type: object + Required. Document links associated with the source documents + (source_document_id). + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + requestMetadata: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RequestMetadata' + description: >- + The meta information collected about the document creator, used to + enforce access control for the service. + id: GoogleCloudContentwarehouseV1CreateDocumentLinkRequest type: object - id: GoogleCloudContentwarehouseV1DataUpdateAction - GoogleCloudContentwarehouseV1IntegerTypeOptions: - description: Configurations for an integer property. - properties: {} - id: GoogleCloudContentwarehouseV1IntegerTypeOptions + description: Request message for DocumentLinkService.CreateDocumentLink. + GoogleCloudDocumentaiV1Vertex: + description: >- + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + properties: + x: + type: integer + format: int32 + description: X coordinate. + 'y': + description: Y coordinate (starts from the top of the image). + format: int32 + type: integer type: object - GoogleCloudContentwarehouseV1DocumentLink: - id: GoogleCloudContentwarehouseV1DocumentLink + id: GoogleCloudDocumentaiV1Vertex + GoogleCloudContentwarehouseV1Property: properties: - state: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - SOFT_DELETED - type: string - enumDescriptions: - - Unknown state of documentlink. - - The documentlink has both source and target documents detected. - - >- - Target document is deleted, and mark the documentlink as - soft-deleted. + textValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextArray' + description: String/text property values. + enumValues: + description: Enum property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumArray' + integerValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerArray' + description: Integer property values. + dateTimeValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DateTimeArray' description: >- - The state of the documentlink. If target node has been deleted, the - link is marked as invalid. Removing a source node will result in - removal of all associated links. - targetDocumentReference: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - description: Document references of the target document. - description: - type: string - description: Description of this document-link. - updateTime: - description: Output only. The time when the documentLink is last updated. - type: string - readOnly: true - format: google-datetime + Date time property values. It is not supported by CMEK compliant + deployment. + mapProperty: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapProperty' + description: Map property values. + floatValues: + description: Float property values. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatArray' + timestampValues: + description: >- + Timestamp property values. It is not supported by CMEK compliant + deployment. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TimestampArray' name: type: string description: >- - Name of this document-link. It is required that the parent derived - form the name to be consistent with the source document reference. - Otherwise an exception will be thrown. Format: - projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. - createTime: - type: string - format: google-datetime - description: Output only. The time when the documentLink is created. - readOnly: true - sourceDocumentReference: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentReference' - description: Document references of the source document. - description: A document-link between source and target document. - type: object - GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata: - id: GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata - description: Metadata object for UpdateDocument request (currently empty). - properties: {} + Required. Must match the name of a PropertyDefinition in the + DocumentSchema. + propertyValues: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1PropertyArray' + description: Nested structured data property values. + description: Property of a document. type: object - GoogleCloudContentwarehouseV1ProjectStatus: + id: GoogleCloudContentwarehouseV1Property + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata: type: object - id: GoogleCloudContentwarehouseV1ProjectStatus - description: >- - Status of a project, including the project state, dbType, aclMode and - etc. + description: The metadata message for GcsIngest pipeline. + id: >- + GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata properties: - location: - type: string - description: The location of the queried project. - state: - type: string - enum: - - PROJECT_STATE_UNSPECIFIED - - PROJECT_STATE_PENDING - - PROJECT_STATE_COMPLETED - - PROJECT_STATE_FAILED - - PROJECT_STATE_DELETING - - PROJECT_STATE_DELETING_FAILED - - PROJECT_STATE_DELETED - - PROJECT_STATE_NOT_FOUND - enumDescriptions: - - Default status, required by protobuf best practices. - - The project is in the middle of a provision process. - - All dependencies have been provisioned. - - A provision process was previously initiated, but failed. - - The project is in the middle of a deletion process. - - A deleting process was initiated, but failed. - - The project is deleted. - - The project is not found. - description: State of the project. - databaseType: - enumDeprecated: - - false - - false - - true - type: string - enum: - - DB_UNKNOWN - - DB_INFRA_SPANNER - - DB_CLOUD_SQL_POSTGRES - description: Database type. - enumDescriptions: - - This value is required by protobuf best practices - - Internal Spanner - - Cloud Sql with a Postgres Sql instance - documentCreatorDefaultRole: - type: string - description: The default role for the person who create a document. - qaEnabled: - description: If the qa is enabled on this project. - type: boolean - accessControlMode: - enum: - - ACL_MODE_UNKNOWN - - ACL_MODE_UNIVERSAL_ACCESS - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID - - ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI - description: Access control mode. + inputPath: type: string - enumDescriptions: - - This value is required by protobuf best practices - - 'Universal Access: No document level access control.' - - Document level access control with customer own Identity Service. - - Document level access control using Google Cloud Identity. - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: - description: Image Quality Defects - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + description: 'The input Cloud Storage folder in this pipeline. Format: `gs:///`.' + GoogleCloudDocumentaiV1DocumentStyleFontSize: + id: GoogleCloudDocumentaiV1DocumentStyleFontSize properties: - confidence: - format: float - type: number - description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - type: + unit: type: string description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + size: + description: Font size for the text. + format: float + type: number + description: Font size with unit. type: object - GoogleCloudDocumentaiV1DocumentEntity: - id: GoogleCloudDocumentaiV1DocumentEntity + GoogleCloudContentwarehouseV1PropertyDefinition: properties: - confidence: - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - type: number - format: float - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + isSearchable: + type: boolean + description: Indicates that the property should be included in a global search. + propertyTypeOptions: + description: Nested structured data property. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyTypeOptions + schemaSources: + description: >- + The mapping information between this property to another schema + source. + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource + type: array + floatTypeOptions: + description: Float property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1FloatTypeOptions' + isRepeatable: + type: boolean + description: Whether the property can have multiple values. + isFilterable: + type: boolean + description: >- + Whether the property can be filtered. If this is a sub-property, all + the parent properties must be marked filterable. + retrievalImportance: + description: The retrieval importance of the property during search. + type: string + enumDescriptions: + - No importance specified. Default medium importance. + - Highest importance. + - Higher importance. + - High importance. + - Medium importance. + - Low importance (negative). + - Lowest importance (negative). + enum: + - RETRIEVAL_IMPORTANCE_UNSPECIFIED + - HIGHEST + - HIGHER + - HIGH + - MEDIUM + - LOW + - LOWEST + isMetadata: description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - properties: - type: array + Whether the property is user supplied metadata. This out-of-the box + placeholder setting can be used to tag derived properties. Its value + and interpretation logic should be implemented by API user. + type: boolean + enumTypeOptions: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1EnumTypeOptions' + description: Enum/categorical property. + displayName: + description: The display-name for the property, used for front-end. + type: string + mapTypeOptions: + description: Map property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1MapTypeOptions' + textTypeOptions: + description: Text/string property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1TextTypeOptions' + name: + type: string description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - normalizedValue: + Required. The name of the metadata property. Must be unique within a + document schema and is case insensitive. Names must be non-blank, + start with a letter, and can contain alphanumeric characters and: /, + :, -, _, and . + timestampTypeOptions: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + #/components/schemas/GoogleCloudContentwarehouseV1TimestampTypeOptions description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + Timestamp property. It is not supported by CMEK compliant + deployment. + dateTimeTypeOptions: description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - mentionText: - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - type: string - provenance: - description: Optional. The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - id: - type: string + Date time property. It is not supported by CMEK compliant + deployment. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DateTimeTypeOptions + isRequired: description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - redacted: + Whether the property is mandatory. Default is 'false', i.e. + populating property value can be skipped. If 'true' then user must + populate the value for this property. type: boolean - description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - mentionId: - description: Optional. Deprecated. Use `id` field instead. - type: string - type: - type: string - description: Required. Entity type from a schema e.g. `Address`. + integerTypeOptions: + description: Integer property. + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1IntegerTypeOptions' + id: GoogleCloudContentwarehouseV1PropertyDefinition + description: Defines the metadata for a schema property. + type: object + GoogleCloudContentwarehouseV1SynonymSet: type: object description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - GoogleCloudContentwarehouseV1RemoveFromFolderAction: + Represents a list of synonyms for a given context. For example a context + "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: + money, credit, finance, payment Synonym 3: shipping, freight, transport + Each SynonymSets should be disjoint + id: GoogleCloudContentwarehouseV1SynonymSet properties: - folder: + name: + description: >- + The resource name of the SynonymSet This is mandatory for + google.api.resource. Format: + projects/{project_number}/locations/{location}/synonymSets/{context}. type: string + synonyms: + description: List of Synonyms for the context. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SynonymSetSynonym + context: description: >- - Name of the folder under which new document is to be added. Format: - projects/{project_number}/locations/{location}/documents/{document_id}. - condition: - description: Condition of the action to be executed. + This is a freeform field. Example contexts can be "sales," + "engineering," "real estate," "accounting," etc. The context can be + supplied during search requests. type: string - id: GoogleCloudContentwarehouseV1RemoveFromFolderAction + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: + description: Represents a cell in a table row. type: object - description: >- - Represents the action responsible for remove a document from a specific - folder. - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: properties: - barcode: - description: Detailed barcode information of the DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - layout: - description: Layout for DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - description: A detected barcode. - type: object - GoogleCloudContentwarehouseV1ResponseMetadata: + rowSpan: + format: int32 + type: integer + description: How many rows this cell spans. + blocks: + description: >- + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + colSpan: + description: How many columns this cell spans. + type: integer + format: int32 + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: properties: - requestId: + blocks: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock description: >- - A unique id associated with this call. This id is logged for - tracking purpose. + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. + type: array + text: type: string - id: GoogleCloudContentwarehouseV1ResponseMetadata - description: >- - Additional information returned to client, such as debugging - information. + description: Text content stored in the block. + type: + type: string + description: >- + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. + description: Represents a text type block. + type: object + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + GoogleCloudContentwarehouseV1RunPipelineMetadata: + id: GoogleCloudContentwarehouseV1RunPipelineMetadata + properties: + processWithDocAiPipelineMetadata: + description: The pipeline metadata for Process-with-DocAi pipeline. + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata + individualDocumentStatuses: + items: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus + type: array + description: The list of response details of each document. + gcsIngestPipelineMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata + description: The pipeline metadata for GcsIngest pipeline. + failedFileCount: + format: int32 + description: Number of files that have failed at some point in the pipeline. + type: integer + userInfo: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1UserInfo' + description: User unique identification and groups information. + totalFileCount: + type: integer + format: int32 + description: Number of files that were processed by the pipeline. + exportToCdwPipelineMetadata: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata + description: The pipeline metadata for Export-to-CDW pipeline. + description: Metadata message of RunPipeline method. type: object parameters: - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - _.xgafv: - description: V1 error format. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: $.xgafv + name: upload_protocol schema: type: string - enum: - - '1' - - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - alt: - description: Data format for response. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: alt + name: fields schema: type: string - enum: - - json - - media - - proto uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string key: @@ -4913,55 +5137,126 @@ components: name: key schema: type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string x-stackQL-resources: - reference_id: - id: google.contentwarehouse.reference_id - name: reference_id - title: Reference_id + acl: + id: google.contentwarehouse.acl + name: acl + title: Acl methods: - get: + fetch_acl: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post + $ref: '#/paths/~1v1~1projects~1{projectsId}:fetchAcl/post' response: mediaType: application/json openAPIDocKey: '200' - patch: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/acl/methods/fetch_acl' + insert: [] + update: [] + replace: [] + delete: [] + projects: + id: google.contentwarehouse.projects + name: projects + title: Projects + methods: + set_acl: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}:setAcl/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + locations: + id: google.contentwarehouse.locations + name: locations + title: Locations + methods: + run_pipeline: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post response: mediaType: application/json openAPIDocKey: '200' - delete: + initialize: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: [] - update: - - $ref: '#/components/x-stackQL-resources/reference_id/methods/patch' + update: [] + replace: [] + delete: [] + status: + id: google.contentwarehouse.status + name: status + title: Status + methods: + get_status: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/status/methods/get_status' + insert: [] + update: [] + replace: [] delete: [] document_links: id: google.contentwarehouse.document_links name: document_links title: Document_links methods: - delete: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post response: mediaType: application/json openAPIDocKey: '200' - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1documentLinks~1{documentLinksId}:delete/post response: mediaType: application/json openAPIDocKey: '200' @@ -4970,44 +5265,72 @@ components: insert: - $ref: '#/components/x-stackQL-resources/document_links/methods/create' update: [] - delete: [] - documents: - id: google.contentwarehouse.documents - name: documents - title: Documents - methods: + replace: [] delete: + - $ref: '#/components/x-stackQL-resources/document_links/methods/delete' + reference_id: + id: google.contentwarehouse.reference_id + name: reference_id + title: Reference_id + methods: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:get/post response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - linked_sources: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1referenceId~1{referenceIdId}/patch response: mediaType: application/json openAPIDocKey: '200' - create: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reference_id/methods/get' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/reference_id/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/reference_id/methods/delete' + documents_acl: + id: google.contentwarehouse.documents_acl + name: documents_acl + title: Documents_acl + methods: + fetch_acl: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:fetchAcl/post response: mediaType: application/json openAPIDocKey: '200' - get: + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/documents_acl/methods/fetch_acl' + insert: [] + update: [] + replace: [] + delete: [] + documents: + id: google.contentwarehouse.documents + name: documents + title: Documents + methods: + lock: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:lock/post response: mediaType: application/json openAPIDocKey: '200' @@ -5018,88 +5341,78 @@ components: response: mediaType: application/json openAPIDocKey: '200' - search: + linked_sources: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedSources/post response: mediaType: application/json openAPIDocKey: '200' - linked_targets: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedTargets/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:get/post response: mediaType: application/json openAPIDocKey: '200' - lock: + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:lock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: - - $ref: '#/components/x-stackQL-resources/documents/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/documents/methods/patch' - delete: [] - documents_acl: - id: google.contentwarehouse.documents_acl - name: documents_acl - title: Documents_acl - methods: - fetch_acl: + linked_targets: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:fetchAcl/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}~1linkedTargets/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - synonym_sets: - id: google.contentwarehouse.synonym_sets - name: synonym_sets - title: Synonym_sets - methods: - get: + search: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents:search/post response: mediaType: application/json openAPIDocKey: '200' - delete: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - patch: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documents~1{documentsId}:delete/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/documents/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/documents/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/documents/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/documents/methods/delete' + synonym_sets: + id: google.contentwarehouse.synonym_sets + name: synonym_sets + title: Synonym_sets + methods: + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.synonymSets - list: - operation: *ref_1 - response: *ref_2 create: operation: $ref: >- @@ -5107,70 +5420,57 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' delete: - - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' - document_schemas: - id: google.contentwarehouse.document_schemas - name: document_schemas - title: Document_schemas - methods: - create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get - response: &ref_4 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.documentSchemas - list: - operation: *ref_3 - response: *ref_4 patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1synonymSets~1{synonymSetsId}/patch response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/get' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/patch' + replace: [] delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' + - $ref: '#/components/x-stackQL-resources/synonym_sets/methods/delete' + operations: + id: google.contentwarehouse.operations + name: operations + title: Operations + methods: get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + insert: [] + update: [] + replace: [] + delete: [] rule_sets: id: google.contentwarehouse.rule_sets name: rule_sets @@ -5183,28 +5483,25 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.ruleSets - list: - operation: *ref_5 - response: *ref_6 - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1ruleSets~1{ruleSetsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -5223,123 +5520,87 @@ components: - $ref: '#/components/x-stackQL-resources/rule_sets/methods/create' update: - $ref: '#/components/x-stackQL-resources/rule_sets/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/rule_sets/methods/delete' - operations: - id: google.contentwarehouse.operations - name: operations - title: Operations + document_schemas: + id: google.contentwarehouse.document_schemas + name: document_schemas + title: Document_schemas methods: - get: + patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - insert: [] - update: [] - delete: [] - status: - id: google.contentwarehouse.status - name: status - title: Status - methods: - get_status: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:getStatus/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/status/methods/get_status' - insert: [] - update: [] - delete: [] - locations: - id: google.contentwarehouse.locations - name: locations - title: Locations - methods: - initialize: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:initialize/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas~1{documentSchemasId}/delete response: mediaType: application/json openAPIDocKey: '200' - run_pipeline: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:runPipeline/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - acl: - id: google.contentwarehouse.acl - name: acl - title: Acl - methods: - fetch_acl: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:fetchAcl/post' + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - projects: - id: google.contentwarehouse.projects - name: projects - title: Projects - methods: - set_acl: + objectKey: $.documentSchemas + create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}:setAcl/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1documentSchemas/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] + select: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/get' + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/document_schemas/methods/delete' paths: - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: - parameters: &ref_7 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' + /v1/projects/{projectsId}:fetchAcl: + parameters: &ref_1 + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.get + description: >- + Gets the access control policy for a resource. Returns NOT_FOUND error + if the resource does not exist. Returns an empty policy if the resource + exists but does not have a policy set. + operationId: contentwarehouse.projects.fetchAcl requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5351,36 +5612,120 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse parameters: - in: path name: projectsId required: true schema: type: string + /v1/projects/{projectsId}:setAcl: + parameters: *ref_1 + post: + description: >- + Sets the access control policy for a resource. Replaces any existing + policy. + operationId: contentwarehouse.projects.setAcl + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + parameters: - in: path - name: locationsId + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: + parameters: *ref_1 + post: + description: Run a predefined pipeline. + operationId: contentwarehouse.projects.locations.runPipeline + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId required: true schema: type: string - in: path - name: referenceIdId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: - parameters: *ref_7 - patch: + /v1/projects/{projectsId}/locations/{locationsId}:initialize: + parameters: *ref_1 + post: description: >- - Updates a document. Returns INVALID_ARGUMENT if the name of the document - is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.referenceId.patch + Provisions resources for given tenant project. Returns a long running + operation. + operationId: contentwarehouse.projects.locations.initialize requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:getStatus: + parameters: *ref_1 + get: + description: Get the project status. + operationId: contentwarehouse.projects.locations.getStatus security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5393,7 +5738,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse + #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus parameters: - in: path name: projectsId @@ -5405,22 +5750,17 @@ paths: required: true schema: type: string - - in: path - name: referenceIdId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: + parameters: *ref_1 post: - description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.referenceId.delete + description: Create a link between a source document and a target document. + operationId: contentwarehouse.projects.locations.documents.documentLinks.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5432,7 +5772,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' parameters: - in: path name: projectsId @@ -5445,12 +5785,12 @@ paths: schema: type: string - in: path - name: referenceIdId + name: documentsId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks/{documentLinksId}:delete: - parameters: *ref_7 + parameters: *ref_1 post: description: Remove the link between the source and target documents. operationId: contentwarehouse.projects.locations.documents.documentLinks.delete @@ -5493,17 +5833,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/documentLinks: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:get: + parameters: *ref_1 post: - description: Create a link between a source document and a target document. - operationId: contentwarehouse.projects.locations.documents.documentLinks.create + description: Gets a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.referenceId.get requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentLinkRequest + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5515,7 +5855,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentLink' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -5528,15 +5868,15 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}:delete: + parameters: *ref_1 post: description: Deletes a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.delete + operationId: contentwarehouse.projects.locations.documents.referenceId.delete requestBody: content: application/json: @@ -5567,17 +5907,17 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/referenceId/{referenceIdId}: + parameters: *ref_1 patch: description: >- Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name. - operationId: contentwarehouse.projects.locations.documents.patch + operationId: contentwarehouse.projects.locations.documents.referenceId.patch requestBody: content: application/json: @@ -5609,21 +5949,24 @@ paths: schema: type: string - in: path - name: documentsId + name: referenceIdId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: + parameters: *ref_1 post: - description: Return all source document-links from the document. - operationId: contentwarehouse.projects.locations.documents.linkedSources + description: >- + Gets the access control policy for a resource. Returns NOT_FOUND error + if the resource does not exist. Returns an empty policy if the resource + exists but does not have a policy set. + operationId: contentwarehouse.projects.locations.documents.fetchAcl requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5636,7 +5979,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse + #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse parameters: - in: path name: projectsId @@ -5653,17 +5996,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: + parameters: *ref_1 post: - description: Creates a document. - operationId: contentwarehouse.projects.locations.documents.create + description: Lock the document so the document cannot be updated by other users. + operationId: contentwarehouse.projects.locations.documents.lock requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentRequest + #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5675,8 +6018,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -5688,17 +6030,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get: - parameters: *ref_7 + - in: path + name: documentsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: + parameters: *ref_1 post: - description: Gets a document. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.documents.get + description: >- + Sets the access control policy for a resource. Replaces any existing + policy. + operationId: contentwarehouse.projects.locations.documents.setAcl requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5710,7 +6058,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse parameters: - in: path name: projectsId @@ -5727,18 +6076,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:setAcl: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedSources: + parameters: *ref_1 post: - description: >- - Sets the access control policy for a resource. Replaces any existing - policy. - operationId: contentwarehouse.projects.locations.documents.setAcl + description: Return all source document-links from the document. + operationId: contentwarehouse.projects.locations.documents.linkedSources requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5751,7 +6099,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1ListLinkedSourcesResponse parameters: - in: path name: projectsId @@ -5768,20 +6116,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:fetchAcl: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:get: + parameters: *ref_1 post: - description: >- - Gets the access control policy for a resource. Returns NOT_FOUND error - if the resource does not exist. Returns an empty policy if the resource - exists but does not have a policy set. - operationId: contentwarehouse.projects.locations.documents.fetchAcl + description: Gets a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.get requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest + #/components/schemas/GoogleCloudContentwarehouseV1GetDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5793,8 +6138,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' parameters: - in: path name: projectsId @@ -5811,19 +6155,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents:search: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents: + parameters: *ref_1 post: - description: >- - Searches for documents using provided SearchDocumentsRequest. This call - only returns documents that the caller has permission to search against. - operationId: contentwarehouse.projects.locations.documents.search + description: Creates a document. + operationId: contentwarehouse.projects.locations.documents.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5836,7 +6178,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse + #/components/schemas/GoogleCloudContentwarehouseV1CreateDocumentResponse parameters: - in: path name: projectsId @@ -5849,7 +6191,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}/linkedTargets: - parameters: *ref_7 + parameters: *ref_1 post: description: Return all target document-links from the document. operationId: contentwarehouse.projects.locations.documents.linkedTargets @@ -5888,52 +6230,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:lock: - parameters: *ref_7 + /v1/projects/{projectsId}/locations/{locationsId}/documents:search: + parameters: *ref_1 post: - description: Lock the document so the document cannot be updated by other users. - operationId: contentwarehouse.projects.locations.documents.lock + description: >- + Searches for documents using provided SearchDocumentsRequest. This call + only returns documents that the caller has permission to search against. + operationId: contentwarehouse.projects.locations.documents.search requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1LockDocumentRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1Document' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: - parameters: *ref_7 - get: - description: >- - Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception - if the Synonymset does not exist - operationId: contentwarehouse.projects.locations.synonymSets.get + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5945,7 +6254,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1SearchDocumentsResponse parameters: - in: path name: projectsId @@ -5957,16 +6267,19 @@ paths: required: true schema: type: string - - in: path - name: synonymSetsId - required: true - schema: - type: string - delete: + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}: + parameters: *ref_1 + patch: description: >- - Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception - if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.delete + Updates a document. Returns INVALID_ARGUMENT if the name of the document + is non-empty and does not equal the existing name. + operationId: contentwarehouse.projects.locations.documents.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5978,7 +6291,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentResponse parameters: - in: path name: projectsId @@ -5991,20 +6305,21 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: documentsId required: true schema: type: string - patch: - description: >- - Remove the existing SynonymSet for the context and replaces it with a - new one. Throws a NOT_FOUND exception if the SynonymSet is not found. - operationId: contentwarehouse.projects.locations.synonymSets.patch + /v1/projects/{projectsId}/locations/{locationsId}/documents/{documentsId}:delete: + parameters: *ref_1 + post: + description: Deletes a document. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.documents.delete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DeleteDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6016,7 +6331,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6029,58 +6344,15 @@ paths: schema: type: string - in: path - name: synonymSetsId + name: documentsId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/synonymSets: - parameters: *ref_7 + parameters: *ref_1 get: - description: Returns all SynonymSets (for all contexts) for the specified location. - operationId: contentwarehouse.projects.locations.synonymSets.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: >- - Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS - exception if a synonymset already exists for the context. - operationId: contentwarehouse.projects.locations.synonymSets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + description: Returns all SynonymSets (for all contexts) for the specified location. + operationId: contentwarehouse.projects.locations.synonymSets.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6092,7 +6364,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListSynonymSetsResponse parameters: - in: path name: projectsId @@ -6104,16 +6377,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: - parameters: *ref_7 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: Creates a document schema. - operationId: contentwarehouse.projects.locations.documentSchemas.create + description: >- + Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS + exception if a synonymset already exists for the context. + operationId: contentwarehouse.projects.locations.synonymSets.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6125,8 +6407,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6138,9 +6419,13 @@ paths: required: true schema: type: string - get: - description: Lists document schemas. - operationId: contentwarehouse.projects.locations.documentSchemas.list + /v1/projects/{projectsId}/locations/{locationsId}/synonymSets/{synonymSetsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception + if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6152,8 +6437,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6165,32 +6449,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: synonymSetsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: - parameters: *ref_7 - patch: + get: description: >- - Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the - Document Schema is non-empty and does not equal the existing name. - Supports only appending new properties, adding new ENUM possible values, - and updating the EnumTypeOptions.validation_check_disabled flag for ENUM - possible values. Updating existing properties will result into - INVALID_ARGUMENT. - operationId: contentwarehouse.projects.locations.documentSchemas.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest + Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception + if the Synonymset does not exist + operationId: contentwarehouse.projects.locations.synonymSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6202,8 +6470,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6216,16 +6483,20 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: synonymSetsId required: true schema: type: string - delete: + patch: description: >- - Deletes a document schema. Returns NOT_FOUND if the document schema does - not exist. Returns BAD_REQUEST if the document schema has documents - depending on it. - operationId: contentwarehouse.projects.locations.documentSchemas.delete + Remove the existing SynonymSet for the context and replaces it with a + new one. Throws a NOT_FOUND exception if the SynonymSet is not found. + operationId: contentwarehouse.projects.locations.synonymSets.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6237,7 +6508,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SynonymSet' parameters: - in: path name: projectsId @@ -6250,15 +6521,18 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: synonymSetsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- - Gets a document schema. Returns NOT_FOUND if the document schema does - not exist. - operationId: contentwarehouse.projects.locations.documentSchemas.get + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: contentwarehouse.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6270,8 +6544,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -6284,12 +6557,12 @@ paths: schema: type: string - in: path - name: documentSchemasId + name: operationsId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/ruleSets: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a ruleset. operationId: contentwarehouse.projects.locations.ruleSets.create @@ -6348,20 +6621,20 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/ruleSets/{ruleSetsId}: - parameters: *ref_7 - delete: - description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.delete + parameters: *ref_1 + get: + description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6373,7 +6646,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' parameters: - in: path name: projectsId @@ -6390,9 +6663,9 @@ paths: required: true schema: type: string - get: - description: Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist. - operationId: contentwarehouse.projects.locations.ruleSets.get + delete: + description: Deletes a ruleset. Returns NOT_FOUND if the document does not exist. + operationId: contentwarehouse.projects.locations.ruleSets.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6404,7 +6677,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1RuleSet' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6460,14 +6733,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_7 - get: + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas/{documentSchemasId}: + parameters: *ref_1 + patch: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: contentwarehouse.projects.locations.operations.get + Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the + Document Schema is non-empty and does not equal the existing name. + Supports only appending new properties, adding new ENUM possible values, + and updating the EnumTypeOptions.validation_check_disabled flag for ENUM + possible values. Updating existing properties will result into + INVALID_ARGUMENT. + operationId: contentwarehouse.projects.locations.documentSchemas.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6479,7 +6761,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6492,15 +6775,15 @@ paths: schema: type: string - in: path - name: operationsId + name: documentSchemasId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:getStatus: - parameters: *ref_7 get: - description: Get the project status. - operationId: contentwarehouse.projects.locations.getStatus + description: >- + Gets a document schema. Returns NOT_FOUND if the document schema does + not exist. + operationId: contentwarehouse.projects.locations.documentSchemas.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6513,7 +6796,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1ProjectStatus + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId @@ -6525,19 +6808,17 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:initialize: - parameters: *ref_7 - post: + - in: path + name: documentSchemasId + required: true + schema: + type: string + delete: description: >- - Provisions resources for given tenant project. Returns a long running - operation. - operationId: contentwarehouse.projects.locations.initialize - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1InitializeProjectRequest + Deletes a document schema. Returns NOT_FOUND if the document schema does + not exist. Returns BAD_REQUEST if the document schema has documents + depending on it. + operationId: contentwarehouse.projects.locations.documentSchemas.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6549,7 +6830,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -6561,17 +6842,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}:runPipeline: - parameters: *ref_7 - post: - description: Run a predefined pipeline. - operationId: contentwarehouse.projects.locations.runPipeline - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1RunPipelineRequest + - in: path + name: documentSchemasId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/documentSchemas: + parameters: *ref_1 + get: + description: Lists document schemas. + operationId: contentwarehouse.projects.locations.documentSchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6583,7 +6863,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudContentwarehouseV1ListDocumentSchemasResponse parameters: - in: path name: projectsId @@ -6595,20 +6876,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}:fetchAcl: - parameters: *ref_7 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: >- - Gets the access control policy for a resource. Returns NOT_FOUND error - if the resource does not exist. Returns an empty policy if the resource - exists but does not have a policy set. - operationId: contentwarehouse.projects.fetchAcl + description: Creates a document schema. + operationId: contentwarehouse.projects.locations.documentSchemas.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclRequest + $ref: '#/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6621,41 +6905,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1FetchAclResponse + #/components/schemas/GoogleCloudContentwarehouseV1DocumentSchema parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}:setAcl: - parameters: *ref_7 - post: - description: >- - Sets the access control policy for a resource. Replaces any existing - policy. - operationId: contentwarehouse.projects.setAcl - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudContentwarehouseV1SetAclRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudContentwarehouseV1SetAclResponse - parameters: - in: path - name: projectsId + name: locationsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml b/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml index 9b0637c7..dc41ad7c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datacatalog.yaml @@ -9,8 +9,8 @@ info: A fully managed and highly scalable data discovery and metadata management service. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/data-catalog/docs/ servers: @@ -1849,7 +1849,12 @@ components: - >- TagTemplate and its tags are auto-copied to Dataplex service. Visible in both services. Editable in DataCatalog, read-only in - Dataplex. + Dataplex. Deprecated: Individual TagTemplate migration is + deprecated in favor of organization or project wide TagTemplate + migration opt-in. + enumDeprecated: + - false + - true enum: - DATAPLEX_TRANSFER_STATUS_UNSPECIFIED - MIGRATED @@ -2904,17 +2909,14 @@ components: name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_1 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_1 - response: *ref_2 projects_locations_operations_get: operation: $ref: >- @@ -2944,6 +2946,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete @@ -2959,17 +2962,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_list: - operation: &ref_3 + projects_locations_entry_groups_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entryGroups - projects_locations_entry_groups_list: - operation: *ref_3 - response: *ref_4 projects_locations_entry_groups_get: operation: $ref: >- @@ -3003,6 +3003,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_delete @@ -3018,17 +3019,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_get_iam_policy: - operation: &ref_5 + projects_locations_entry_groups_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:getIamPolicy/post - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_entry_groups_get_iam_policy: - operation: *ref_5 - response: *ref_6 projects_locations_entry_groups_test_iam_permissions: operation: $ref: >- @@ -3042,6 +3040,9 @@ components: #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_set_iam_policy delete: [] entries: id: google.datacatalog.entries @@ -3055,17 +3056,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_entries_list: - operation: &ref_7 + projects_locations_entry_groups_entries_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entries - projects_locations_entry_groups_entries_list: - operation: *ref_7 - response: *ref_8 projects_locations_entry_groups_entries_patch: operation: $ref: >- @@ -3140,6 +3138,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_delete @@ -3148,17 +3147,14 @@ components: name: entries_iam_policies title: Entries_iam_policies methods: - _projects_locations_entry_groups_entries_get_iam_policy: - operation: &ref_9 + projects_locations_entry_groups_entries_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}:getIamPolicy/post - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_entry_groups_entries_get_iam_policy: - operation: *ref_9 - response: *ref_10 projects_locations_entry_groups_entries_test_iam_permissions: operation: $ref: >- @@ -3172,6 +3168,7 @@ components: #/components/x-stackQL-resources/entries_iam_policies/methods/projects_locations_entry_groups_entries_get_iam_policy insert: [] update: [] + replace: [] delete: [] tags: id: google.datacatalog.tags @@ -3185,17 +3182,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_entries_tags_list: - operation: &ref_11 + projects_locations_entry_groups_entries_tags_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries~1{entriesId}~1tags/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tags - projects_locations_entry_groups_entries_tags_list: - operation: *ref_11 - response: *ref_12 projects_locations_entry_groups_entries_tags_patch: operation: $ref: >- @@ -3224,17 +3218,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_tags_list: - operation: &ref_13 + projects_locations_entry_groups_tags_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1tags/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tags - projects_locations_entry_groups_tags_list: - operation: *ref_13 - response: *ref_14 projects_locations_entry_groups_tags_patch: operation: $ref: >- @@ -3265,6 +3256,7 @@ components: #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_entries_tags_patch - $ref: >- #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_tags_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/tags/methods/projects_locations_entry_groups_entries_tags_delete @@ -3313,6 +3305,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/tag_templates/methods/projects_locations_tag_templates_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/tag_templates/methods/projects_locations_tag_templates_delete @@ -3328,17 +3321,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_tag_templates_get_iam_policy: - operation: &ref_15 + projects_locations_tag_templates_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tagTemplates~1{tagTemplatesId}:getIamPolicy/post - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_tag_templates_get_iam_policy: - operation: *ref_15 - response: *ref_16 projects_locations_tag_templates_test_iam_permissions: operation: $ref: >- @@ -3352,6 +3342,9 @@ components: #/components/x-stackQL-resources/tag_templates_iam_policies/methods/projects_locations_tag_templates_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/tag_templates_iam_policies/methods/projects_locations_tag_templates_set_iam_policy delete: [] fields: id: google.datacatalog.fields @@ -3394,6 +3387,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/fields/methods/projects_locations_tag_templates_fields_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/fields/methods/projects_locations_tag_templates_fields_delete @@ -3413,6 +3407,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] taxonomies: id: google.datacatalog.taxonomies @@ -3426,17 +3421,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_taxonomies_list: - operation: &ref_17 + projects_locations_taxonomies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1taxonomies/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.taxonomies - projects_locations_taxonomies_list: - operation: *ref_17 - response: *ref_18 projects_locations_taxonomies_delete: operation: $ref: >- @@ -3491,6 +3483,9 @@ components: update: - $ref: >- #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_patch + replace: + - $ref: >- + #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_replace delete: - $ref: >- #/components/x-stackQL-resources/taxonomies/methods/projects_locations_taxonomies_delete @@ -3499,17 +3494,14 @@ components: name: taxonomies_iam_policies title: Taxonomies_iam_policies methods: - _projects_locations_taxonomies_get_iam_policy: - operation: &ref_19 + projects_locations_taxonomies_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1taxonomies~1{taxonomiesId}:getIamPolicy/post - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_taxonomies_get_iam_policy: - operation: *ref_19 - response: *ref_20 projects_locations_taxonomies_set_iam_policy: operation: $ref: >- @@ -3530,6 +3522,9 @@ components: #/components/x-stackQL-resources/taxonomies_iam_policies/methods/projects_locations_taxonomies_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/taxonomies_iam_policies/methods/projects_locations_taxonomies_set_iam_policy delete: [] policy_tags: id: google.datacatalog.policy_tags @@ -3543,17 +3538,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_taxonomies_policy_tags_list: - operation: &ref_21 + projects_locations_taxonomies_policy_tags_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1taxonomies~1{taxonomiesId}~1policyTags/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policyTags - projects_locations_taxonomies_policy_tags_list: - operation: *ref_21 - response: *ref_22 projects_locations_taxonomies_policy_tags_delete: operation: $ref: >- @@ -3587,6 +3579,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/policy_tags/methods/projects_locations_taxonomies_policy_tags_delete @@ -3595,17 +3588,14 @@ components: name: policy_tags_iam_policies title: Policy_tags_iam_policies methods: - _projects_locations_taxonomies_policy_tags_get_iam_policy: - operation: &ref_23 + projects_locations_taxonomies_policy_tags_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1taxonomies~1{taxonomiesId}~1policyTags~1{policyTagsId}:getIamPolicy/post - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_taxonomies_policy_tags_get_iam_policy: - operation: *ref_23 - response: *ref_24 projects_locations_taxonomies_policy_tags_set_iam_policy: operation: $ref: >- @@ -3626,6 +3616,9 @@ components: #/components/x-stackQL-resources/policy_tags_iam_policies/methods/projects_locations_taxonomies_policy_tags_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/policy_tags_iam_policies/methods/projects_locations_taxonomies_policy_tags_set_iam_policy delete: [] catalog: id: google.datacatalog.catalog @@ -3642,10 +3635,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: &ref_25 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3699,7 +3693,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3770,7 +3764,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3812,7 +3806,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates an entry group. An entry group contains logically related @@ -3901,7 +3895,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets an entry group. operationId: datacatalog.projects.locations.entryGroups.get @@ -4023,7 +4017,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Sets an access control policy for a resource. Replaces any existing @@ -4070,7 +4064,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. May return: * @@ -4118,7 +4112,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Gets your permissions on a resource. Returns an empty set of permissions @@ -4163,7 +4157,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', @@ -4262,7 +4256,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}: - parameters: *ref_25 + parameters: *ref_1 patch: description: >- Updates an existing entry. You must enable the Data Catalog API in the @@ -4391,7 +4385,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryOverview: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Modifies entry overview, part of the business context of an Entry. To @@ -4438,7 +4432,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:modifyEntryContacts: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Modifies contacts, part of the business context of an Entry. To call @@ -4485,7 +4479,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:star: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Marks an Entry as starred by the current user. Starring information is @@ -4530,7 +4524,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:unstar: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Marks an Entry as NOT starred by the current user. Starring information @@ -4576,7 +4570,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:getIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. May return: * @@ -4629,7 +4623,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}:testIamPermissions: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Gets your permissions on a resource. Returns an empty set of permissions @@ -4679,7 +4673,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries:import: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Imports entries from a source, such as data previously dumped into a @@ -4727,7 +4721,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates a tag and assigns it to: * An Entry if the method name is @@ -4825,7 +4819,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags/{tagsId}: - parameters: *ref_25 + parameters: *ref_1 patch: description: Updates an existing tag. operationId: datacatalog.projects.locations.entryGroups.entries.tags.patch @@ -4919,7 +4913,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}/tags:reconcile: - parameters: *ref_25 + parameters: *ref_1 post: description: >- `ReconcileTags` creates or updates a list of tags on the entry. If the @@ -4969,7 +4963,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates a tag and assigns it to: * An Entry if the method name is @@ -5057,7 +5051,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/tags/{tagsId}: - parameters: *ref_25 + parameters: *ref_1 patch: description: Updates an existing tag. operationId: datacatalog.projects.locations.entryGroups.tags.patch @@ -5141,7 +5135,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates a tag template. You must enable the Data Catalog API in the @@ -5182,7 +5176,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets a tag template. operationId: datacatalog.projects.locations.tagTemplates.get @@ -5301,7 +5295,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:setIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Sets an access control policy for a resource. Replaces any existing @@ -5348,7 +5342,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:getIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. May return: * @@ -5396,7 +5390,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}:testIamPermissions: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Gets your permissions on a resource. Returns an empty set of permissions @@ -5441,7 +5435,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates a field in a tag template. You must enable the Data Catalog API @@ -5487,7 +5481,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}: - parameters: *ref_25 + parameters: *ref_1 patch: description: >- Updates a field in a tag template. You can't update the field type with @@ -5585,7 +5579,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}:rename: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Renames a field in a tag template. You must enable the Data Catalog API @@ -5633,7 +5627,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tagTemplates/{tagTemplatesId}/fields/{fieldsId}/enumValues/{enumValuesId}:rename: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Renames an enum value in a tag template. Within a single enum field, @@ -5684,7 +5678,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates a taxonomy in a specified project. The taxonomy is initially @@ -5761,7 +5755,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}: - parameters: *ref_25 + parameters: *ref_1 delete: description: >- Deletes a taxonomy, including all policy tags in this taxonomy, their @@ -5871,7 +5865,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:getIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: Gets the IAM policy for a policy tag or a taxonomy. operationId: datacatalog.projects.locations.taxonomies.getIamPolicy @@ -5909,7 +5903,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:setIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: Sets the IAM policy for a policy tag or a taxonomy. operationId: datacatalog.projects.locations.taxonomies.setIamPolicy @@ -5947,7 +5941,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:testIamPermissions: - parameters: *ref_25 + parameters: *ref_1 post: description: Returns your permissions on a specified policy tag or taxonomy. operationId: datacatalog.projects.locations.taxonomies.testIamPermissions @@ -5985,7 +5979,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}:replace: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Replaces (updates) a taxonomy and all its policy tags. The taxonomy and @@ -6031,7 +6025,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies:import: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Creates new taxonomies (including their policy tags) in a given project @@ -6071,7 +6065,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies:export: - parameters: *ref_25 + parameters: *ref_1 get: description: >- Exports taxonomies in the requested type and returns them, including @@ -6113,7 +6107,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags: - parameters: *ref_25 + parameters: *ref_1 post: description: Creates a policy tag in a taxonomy. operationId: datacatalog.projects.locations.taxonomies.policyTags.create @@ -6192,7 +6186,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}: - parameters: *ref_25 + parameters: *ref_1 delete: description: >- Deletes a policy tag together with the following: * All of its @@ -6318,7 +6312,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}:getIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: Gets the IAM policy for a policy tag or a taxonomy. operationId: datacatalog.projects.locations.taxonomies.policyTags.getIamPolicy @@ -6361,7 +6355,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}:setIamPolicy: - parameters: *ref_25 + parameters: *ref_1 post: description: Sets the IAM policy for a policy tag or a taxonomy. operationId: datacatalog.projects.locations.taxonomies.policyTags.setIamPolicy @@ -6404,7 +6398,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}/policyTags/{policyTagsId}:testIamPermissions: - parameters: *ref_25 + parameters: *ref_1 post: description: Returns your permissions on a specified policy tag or taxonomy. operationId: datacatalog.projects.locations.taxonomies.policyTags.testIamPermissions @@ -6447,7 +6441,7 @@ paths: schema: type: string /v1/catalog:search: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Searches Data Catalog for multiple resources like entries and tags that @@ -6483,7 +6477,7 @@ paths: #/components/schemas/GoogleCloudDatacatalogV1SearchCatalogResponse parameters: [] /v1/entries:lookup: - parameters: *ref_25 + parameters: *ref_1 get: description: >- Gets an entry by its target resource name. The resource name comes from diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml index 0a453be4..ceef8345 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataflow.yaml @@ -7,8 +7,8 @@ info: title: Dataflow API description: Manages Google Cloud Dataflow projects on Google Cloud Platform. version: v1b3 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dataflow servers: @@ -26,7 +26,6 @@ components: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/compute: View and manage your Google Compute Engine resources - https://www.googleapis.com/auth/compute.readonly: View your Google Compute Engine resources Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -440,8 +439,8 @@ components: type: string transformNameMapping: description: >- - The map of transform name prefixes of the job to be replaced to the - corresponding name prefixes of the new job. + Optional. The map of transform name prefixes of the job to be + replaced to the corresponding name prefixes of the new job. type: object additionalProperties: type: string @@ -484,7 +483,7 @@ components: type: string location: description: >- - The [regional endpoint] + Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. type: string @@ -541,6 +540,10 @@ components: requests. readOnly: true type: boolean + serviceResources: + description: Output only. Resources used by the Dataflow Service to run the job. + readOnly: true + $ref: '#/components/schemas/ServiceResources' Environment: id: Environment description: Describes the environment in which a Dataflow Job runs. @@ -584,8 +587,9 @@ components: type: string serviceKmsKeyName: description: >- - If set, contains the Cloud KMS key identifier used to encrypt data - at rest, AKA a Customer Managed Encryption Key (CMEK). Format: + Optional. If set, contains the Cloud KMS key identifier used to + encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). + Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY type: string workerPools: @@ -611,9 +615,9 @@ components: description: Properties of the object. dataset: description: >- - The dataset for the current project where various workflow related - tables are stored. The supported resource type is: Google BigQuery: - bigquery.googleapis.com/{dataset} + Optional. The dataset for the current project where various workflow + related tables are stored. The supported resource type is: Google + BigQuery: bigquery.googleapis.com/{dataset} type: string sdkPipelineOptions: description: >- @@ -633,11 +637,11 @@ components: description: Properties of the object. Contains field @type with type URL. serviceAccountEmail: description: >- - Identity to run virtual machines as. Defaults to the default - account. + Optional. Identity to run virtual machines as. Defaults to the + default account. type: string flexResourceSchedulingGoal: - description: Which Flexible Resource Scheduling mode to run in. + description: Optional. Which Flexible Resource Scheduling mode to run in. type: string enumDescriptions: - Run in the default mode. @@ -649,7 +653,7 @@ components: - FLEXRS_COST_OPTIMIZED workerRegion: description: >- - The Compute Engine region + Optional. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone @@ -657,7 +661,7 @@ components: type: string workerZone: description: >- - The Compute Engine zone + Optional. The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor @@ -677,7 +681,7 @@ components: - VM_BASED - SERVICE_BASED debugOptions: - description: Any debugging options to be supplied to the job. + description: Optional. Any debugging options to be supplied to the job. $ref: '#/components/schemas/DebugOptions' useStreamingEngineResourceBasedBilling: description: >- @@ -1113,8 +1117,8 @@ components: properties: enableHotKeyLogging: description: >- - When true, enables the logging of the literal hot key to the user's - Cloud Logging. + Optional. When true, enables the logging of the literal hot key to + the user's Cloud Logging. type: boolean dataSampling: description: Configuration options for sampling elements from a running pipeline. @@ -1798,6 +1802,19 @@ components: pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). type: number format: double + ServiceResources: + id: ServiceResources + description: Resources used by the Dataflow Service to run the job. + type: object + properties: + zones: + description: >- + Output only. List of Cloud Zones being used by the Dataflow Service + for this job. Example: us-central1-c + readOnly: true + type: array + items: + type: string ListJobsResponse: id: ListJobsResponse description: >- @@ -2219,10 +2236,40 @@ components: - The parameter specifies a boolean input. - The parameter specifies an enum input. - The parameter specifies a number input. + - Deprecated. Please use KAFKA_READ_TOPIC instead. - >- The parameter specifies the fully-qualified name of an Apache Kafka topic. This can be either a Google Managed Kafka topic or a non-managed Kafka topic. + - >- + The parameter specifies the fully-qualified name of an Apache + Kafka topic. This can be an existing Google Managed Kafka topic, + the name for a new Google Managed Kafka topic, or an existing + non-managed Kafka topic. + enumDeprecated: + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - true + - false + - false enum: - DEFAULT - TEXT @@ -2245,6 +2292,8 @@ components: - ENUM - NUMBER - KAFKA_TOPIC + - KAFKA_READ_TOPIC + - KAFKA_WRITE_TOPIC customMetadata: description: Optional. Additional metadata for describing this parameter. type: object @@ -3234,6 +3283,12 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + projectNumber: + description: >- + Optional. The project number of the project which owns the + WorkItem's job. + type: string + format: int64 WorkItemStatus: id: WorkItemStatus description: Conveys a worker's progress through the work described by a WorkItem. @@ -4253,6 +4308,10 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + projectNumber: + description: Optional. The project number of the project this worker belongs to. + type: string + format: int64 LeaseWorkItemResponse: id: LeaseWorkItemResponse description: Response to a request to lease WorkItems. @@ -5110,6 +5169,18 @@ components: Operational limits for the streaming job. Can be used by the worker to validate outputs sent to the backend. $ref: '#/components/schemas/StreamingOperationalLimits' + userWorkerRunnerV1Settings: + description: >- + Binary encoded proto to control runtime behavior of the java runner + v1 user worker. + type: string + format: byte + userWorkerRunnerV2Settings: + description: >- + Binary encoded proto to control runtime behavior of the runner v2 + user worker. + type: string + format: byte StreamingComputationConfig: id: StreamingComputationConfig description: Configuration information for a single streaming computation. @@ -5937,6 +6008,7 @@ components: #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/snapshots/methods/projects_locations_snapshots_delete @@ -5957,6 +6029,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] jobs: id: google.dataflow.jobs @@ -5969,16 +6042,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_jobs_list: - operation: &ref_1 + projects_jobs_list: + operation: $ref: '#/paths/~1v1b3~1projects~1{projectId}~1jobs/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - projects_jobs_list: - operation: *ref_1 - response: *ref_2 projects_jobs_get: operation: $ref: '#/paths/~1v1b3~1projects~1{projectId}~1jobs~1{jobId}/get' @@ -6010,17 +6080,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_jobs_list: - operation: &ref_3 + projects_locations_jobs_list: + operation: $ref: >- #/paths/~1v1b3~1projects~1{projectId}~1locations~1{location}~1jobs/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - projects_locations_jobs_list: - operation: *ref_3 - response: *ref_4 projects_locations_jobs_get: operation: $ref: >- @@ -6054,7 +6121,8 @@ components: - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_locations_jobs_create - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_create' - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_locations_jobs_update - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_update' @@ -6085,6 +6153,7 @@ components: #/components/x-stackQL-resources/jobs_metrics/methods/projects_jobs_get_metrics insert: [] update: [] + replace: [] delete: [] debug_config: id: google.dataflow.debug_config @@ -6106,9 +6175,14 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/debug_config/methods/projects_locations_jobs_debug_get_config + - $ref: >- + #/components/x-stackQL-resources/debug_config/methods/projects_jobs_debug_get_config insert: [] update: [] + replace: [] delete: [] debug: id: google.dataflow.debug @@ -6133,33 +6207,28 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] messages: id: google.dataflow.messages name: messages title: Messages methods: - _projects_jobs_messages_list: - operation: &ref_5 + projects_jobs_messages_list: + operation: $ref: '#/paths/~1v1b3~1projects~1{projectId}~1jobs~1{jobId}~1messages/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobMessages - projects_jobs_messages_list: - operation: *ref_5 - response: *ref_6 - _projects_locations_jobs_messages_list: - operation: &ref_7 + projects_locations_jobs_messages_list: + operation: $ref: >- #/paths/~1v1b3~1projects~1{projectId}~1locations~1{location}~1jobs~1{jobId}~1messages/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobMessages - projects_locations_jobs_messages_list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: >- @@ -6168,6 +6237,7 @@ components: #/components/x-stackQL-resources/messages/methods/projects_jobs_messages_list insert: [] update: [] + replace: [] delete: [] work_items: id: google.dataflow.work_items @@ -6206,6 +6276,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] templates: id: google.dataflow.templates @@ -6263,6 +6334,7 @@ components: - $ref: >- #/components/x-stackQL-resources/templates/methods/projects_templates_create update: [] + replace: [] delete: [] locations: id: google.dataflow.locations @@ -6280,52 +6352,49 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] jobs_execution_details: id: google.dataflow.jobs_execution_details name: jobs_execution_details title: Jobs_execution_details methods: - _projects_locations_jobs_get_execution_details: - operation: &ref_9 + projects_locations_jobs_get_execution_details: + operation: $ref: >- #/paths/~1v1b3~1projects~1{projectId}~1locations~1{location}~1jobs~1{jobId}~1executionDetails/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.stages - projects_locations_jobs_get_execution_details: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/jobs_execution_details/methods/projects_locations_jobs_get_execution_details insert: [] update: [] + replace: [] delete: [] stages_execution_details: id: google.dataflow.stages_execution_details name: stages_execution_details title: Stages_execution_details methods: - _projects_locations_jobs_stages_get_execution_details: - operation: &ref_11 + projects_locations_jobs_stages_get_execution_details: + operation: $ref: >- #/paths/~1v1b3~1projects~1{projectId}~1locations~1{location}~1jobs~1{jobId}~1stages~1{stageId}~1executionDetails/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workers - projects_locations_jobs_stages_get_execution_details: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/stages_execution_details/methods/projects_locations_jobs_stages_get_execution_details insert: [] update: [] + replace: [] delete: [] flex_templates: id: google.dataflow.flex_templates @@ -6343,10 +6412,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1b3/projects/{projectId}/snapshots: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -6370,10 +6440,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6407,10 +6473,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6433,7 +6495,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/WorkerMessages: - parameters: *ref_13 + parameters: *ref_1 post: description: Send a worker_message to the service. operationId: dataflow.projects.workerMessages @@ -6451,10 +6513,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6469,7 +6527,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/snapshots/{snapshotId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a snapshot. operationId: dataflow.projects.snapshots.get @@ -6482,10 +6540,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6509,7 +6563,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a Cloud Dataflow job. To create a job, we recommend using @@ -6533,10 +6587,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6584,10 +6634,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6627,7 +6673,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the state of the specified Cloud Dataflow job. To get the state of @@ -6646,10 +6692,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6699,10 +6741,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6731,7 +6769,7 @@ paths: type: string format: google-fieldmask /v1b3/projects/{projectId}/jobs:aggregated: - parameters: *ref_13 + parameters: *ref_1 get: description: >- List the jobs of a project across all regions. **Note:** This method @@ -6746,10 +6784,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6789,7 +6823,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}:snapshot: - parameters: *ref_13 + parameters: *ref_1 post: description: Snapshot the state of a streaming job. operationId: dataflow.projects.jobs.snapshot @@ -6807,10 +6841,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6830,7 +6860,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}/metrics: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Request the job status. To request the status of a job, we recommend @@ -6848,10 +6878,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6880,7 +6906,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig: - parameters: *ref_13 + parameters: *ref_1 post: description: Get encoded debug configuration for component. Not cacheable. operationId: dataflow.projects.jobs.debug.getConfig @@ -6898,10 +6924,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6921,7 +6943,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture: - parameters: *ref_13 + parameters: *ref_1 post: description: Send encoded debug capture data for component. operationId: dataflow.projects.jobs.debug.sendCapture @@ -6939,10 +6961,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -6962,7 +6980,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}/messages: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Request the job status. To request the status of a job, we recommend @@ -6980,10 +6998,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7030,7 +7044,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus: - parameters: *ref_13 + parameters: *ref_1 post: description: Reports the status of dataflow WorkItems leased by a worker. operationId: dataflow.projects.jobs.workItems.reportStatus @@ -7048,10 +7062,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7071,7 +7081,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease: - parameters: *ref_13 + parameters: *ref_1 post: description: Leases a dataflow WorkItem to run. operationId: dataflow.projects.jobs.workItems.lease @@ -7089,10 +7099,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7112,11 +7118,16 @@ paths: schema: type: string /v1b3/projects/{projectId}/templates: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a Cloud Dataflow job from a template. Do not enter confidential - information when you supply string values using the API. + information when you supply string values using the API. To create a + job, we recommend using `projects.locations.templates.create` with a + [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). + Using `projects.templates.create` is not recommended, because your job + will always start in `us-central1`. operationId: dataflow.projects.templates.create requestBody: content: @@ -7132,10 +7143,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7150,9 +7157,14 @@ paths: schema: type: string /v1b3/projects/{projectId}/templates:launch: - parameters: *ref_13 + parameters: *ref_1 post: - description: Launch a template. + description: >- + Launches a template. To launch a template, we recommend using + `projects.locations.templates.launch` with a [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). + Using `projects.templates.launch` is not recommended, because jobs + launched from the template will always start in `us-central1`. operationId: dataflow.projects.templates.launch requestBody: content: @@ -7168,10 +7180,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7206,9 +7214,15 @@ paths: schema: type: string /v1b3/projects/{projectId}/templates:get: - parameters: *ref_13 + parameters: *ref_1 get: - description: Get the template associated with a template. + description: >- + Get the template associated with a template. To get the template, we + recommend using `projects.locations.templates.get` with a [regional + endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). + Using `projects.templates.get` is not recommended, because only + templates that are running in `us-central1` are retrieved. operationId: dataflow.projects.templates.get security: - Oauth2: @@ -7219,10 +7233,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7249,7 +7259,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/WorkerMessages: - parameters: *ref_13 + parameters: *ref_1 post: description: Send a worker_message to the service. operationId: dataflow.projects.locations.workerMessages @@ -7267,10 +7277,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7290,7 +7296,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a snapshot. operationId: dataflow.projects.locations.snapshots.get @@ -7303,10 +7309,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7342,10 +7344,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7370,7 +7368,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/snapshots: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists snapshots. operationId: dataflow.projects.locations.snapshots.list @@ -7383,10 +7381,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7410,7 +7404,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a Cloud Dataflow job. To create a job, we recommend using @@ -7434,10 +7428,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7486,10 +7476,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7530,7 +7516,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the state of the specified Cloud Dataflow job. To get the state of @@ -7549,10 +7535,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7603,10 +7585,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7636,7 +7614,7 @@ paths: type: string format: google-fieldmask /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot: - parameters: *ref_13 + parameters: *ref_1 post: description: Snapshot the state of a streaming job. operationId: dataflow.projects.locations.jobs.snapshot @@ -7654,10 +7632,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7682,7 +7656,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Request the job status. To request the status of a job, we recommend @@ -7700,10 +7674,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7733,7 +7703,7 @@ paths: type: string format: google-datetime /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Request detailed information about the execution status of the job. @@ -7748,10 +7718,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7785,7 +7751,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig: - parameters: *ref_13 + parameters: *ref_1 post: description: Get encoded debug configuration for component. Not cacheable. operationId: dataflow.projects.locations.jobs.debug.getConfig @@ -7803,10 +7769,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7831,7 +7793,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture: - parameters: *ref_13 + parameters: *ref_1 post: description: Send encoded debug capture data for component. operationId: dataflow.projects.locations.jobs.debug.sendCapture @@ -7849,10 +7811,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7877,7 +7835,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists snapshots. operationId: dataflow.projects.locations.jobs.snapshots.list @@ -7890,10 +7848,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7918,7 +7872,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Request the job status. To request the status of a job, we recommend @@ -7936,10 +7890,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -7987,7 +7937,7 @@ paths: type: string format: google-datetime /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Request detailed information about the execution status of a stage of @@ -8003,10 +7953,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -8055,7 +8001,7 @@ paths: type: string format: google-datetime /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus: - parameters: *ref_13 + parameters: *ref_1 post: description: Reports the status of dataflow WorkItems leased by a worker. operationId: dataflow.projects.locations.jobs.workItems.reportStatus @@ -8073,10 +8019,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -8101,7 +8043,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease: - parameters: *ref_13 + parameters: *ref_1 post: description: Leases a dataflow WorkItem to run. operationId: dataflow.projects.locations.jobs.workItems.lease @@ -8119,10 +8061,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -8147,11 +8085,16 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/templates: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a Cloud Dataflow job from a template. Do not enter confidential - information when you supply string values using the API. + information when you supply string values using the API. To create a + job, we recommend using `projects.locations.templates.create` with a + [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). + Using `projects.templates.create` is not recommended, because your job + will always start in `us-central1`. operationId: dataflow.projects.locations.templates.create requestBody: content: @@ -8167,10 +8110,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -8190,9 +8129,14 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/templates:launch: - parameters: *ref_13 + parameters: *ref_1 post: - description: Launch a template. + description: >- + Launches a template. To launch a template, we recommend using + `projects.locations.templates.launch` with a [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). + Using `projects.templates.launch` is not recommended, because jobs + launched from the template will always start in `us-central1`. operationId: dataflow.projects.locations.templates.launch requestBody: content: @@ -8208,10 +8152,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -8247,9 +8187,15 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/templates:get: - parameters: *ref_13 + parameters: *ref_1 get: - description: Get the template associated with a template. + description: >- + Get the template associated with a template. To get the template, we + recommend using `projects.locations.templates.get` with a [regional + endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). + Using `projects.templates.get` is not recommended, because only + templates that are running in `us-central1` are retrieved. operationId: dataflow.projects.locations.templates.get security: - Oauth2: @@ -8260,10 +8206,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response @@ -8291,7 +8233,7 @@ paths: schema: type: string /v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch: - parameters: *ref_13 + parameters: *ref_1 post: description: Launch a job with a FlexTemplate. operationId: dataflow.projects.locations.flexTemplates.launch @@ -8309,10 +8251,6 @@ paths: - https://www.googleapis.com/auth/compute Oauth2c: - https://www.googleapis.com/auth/compute - - Oauth2: - - https://www.googleapis.com/auth/compute.readonly - Oauth2c: - - https://www.googleapis.com/auth/compute.readonly responses: '200': description: Successful response diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml index b1398840..1460ed49 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataform.yaml @@ -9,8 +9,8 @@ info: Service to develop, version control, and operationalize SQL pipelines in BigQuery. version: v1beta1 - x-discovery-doc-revision: '20240504' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240824' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dataform/docs servers: @@ -859,10 +859,6 @@ components: config. type: object properties: - releaseTime: - description: The timestamp of this release attempt. - type: string - format: google-datetime compilationResult: description: >- The name of the created compilation result, if one was successfully @@ -874,6 +870,10 @@ components: The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. $ref: '#/components/schemas/Status' + releaseTime: + description: The timestamp of this release attempt. + type: string + format: google-datetime Status: id: Status description: >- @@ -931,10 +931,6 @@ components: description: Represents the result of compiling a Dataform project. type: object properties: - name: - description: Output only. The compilation result's name. - readOnly: true - type: string gitCommitish: description: >- Immutable. Git commit/tag/branch name at which the repository should @@ -951,6 +947,10 @@ components: Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. type: string + name: + description: Output only. The compilation result's name. + readOnly: true + type: string codeCompilationConfig: description: >- Immutable. If set, fields of `code_compilation_config` override the @@ -979,6 +979,13 @@ components: description: Output only. Only set if the repository has a KMS Key. readOnly: true $ref: '#/components/schemas/DataEncryptionState' + createTime: + description: >- + Output only. The timestamp of when the compilation result was + created. + readOnly: true + type: string + format: google-datetime CompilationError: id: CompilationError description: An error encountered when attempting to compile a Dataform project. @@ -1040,19 +1047,6 @@ components: description: Represents a single Dataform action in a compilation result. type: object properties: - target: - description: This action's identifier. Unique within the compilation result. - $ref: '#/components/schemas/Target' - canonicalTarget: - description: >- - The action's identifier if the project had been compiled without any - overrides configured. Unique within the compilation result. - $ref: '#/components/schemas/Target' - filePath: - description: >- - The full path including filename in which this action is located, - relative to the workspace root. - type: string relation: description: The database relation created/updated by this action. $ref: '#/components/schemas/Relation' @@ -1068,6 +1062,22 @@ components: notebook: description: The notebook executed by this action. $ref: '#/components/schemas/Notebook' + dataPreparation: + description: The data preparation executed by this action. + $ref: '#/components/schemas/DataPreparation' + target: + description: This action's identifier. Unique within the compilation result. + $ref: '#/components/schemas/Target' + canonicalTarget: + description: >- + The action's identifier if the project had been compiled without any + overrides configured. Unique within the compilation result. + $ref: '#/components/schemas/Target' + filePath: + description: >- + The full path including filename in which this action is located, + relative to the workspace root. + type: string Relation: id: Relation description: Represents a database relation. @@ -1331,6 +1341,28 @@ components: type: array items: type: string + DataPreparation: + id: DataPreparation + description: Defines a compiled Data Preparation entity + type: object + properties: + dependencyTargets: + description: A list of actions that this action depends on. + type: array + items: + $ref: '#/components/schemas/Target' + disabled: + description: Whether this action is disabled (i.e. should not be run). + type: boolean + contents: + description: The data preparation definition, stored as a binary encoded proto. + type: string + format: byte + tags: + description: Arbitrary, user-defined tags on this action. + type: array + items: + type: string ListWorkflowConfigsResponse: id: ListWorkflowConfigsResponse description: '`ListWorkflowConfigs` response message.' @@ -1390,6 +1422,18 @@ components: type: array items: $ref: '#/components/schemas/ScheduledExecutionRecord' + createTime: + description: Output only. The timestamp of when the WorkflowConfig was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The timestamp of when the WorkflowConfig was last + updated. + readOnly: true + type: string + format: google-datetime InvocationConfig: id: InvocationConfig description: >- @@ -1433,10 +1477,6 @@ components: config. type: object properties: - executionTime: - description: The timestamp of this execution attempt. - type: string - format: google-datetime workflowInvocation: description: >- The name of the created workflow invocation, if one was successfully @@ -1448,6 +1488,10 @@ components: The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. $ref: '#/components/schemas/Status' + executionTime: + description: The timestamp of this execution attempt. + type: string + format: google-datetime ListWorkflowInvocationsResponse: id: ListWorkflowInvocationsResponse description: '`ListWorkflowInvocations` response message.' @@ -1473,10 +1517,6 @@ components: description: Represents a single invocation of a compilation result. type: object properties: - name: - description: Output only. The workflow invocation's name. - readOnly: true - type: string compilationResult: description: >- Immutable. The name of the compilation result to use for this @@ -1488,6 +1528,10 @@ components: Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`. type: string + name: + description: Output only. The workflow invocation's name. + readOnly: true + type: string invocationConfig: description: Immutable. If left unset, a default InvocationConfig will be used. $ref: '#/components/schemas/InvocationConfig' @@ -1573,6 +1617,14 @@ components: description: Represents a single action in a workflow invocation. type: object properties: + bigqueryAction: + description: Output only. The workflow action's bigquery action details. + readOnly: true + $ref: '#/components/schemas/BigQueryAction' + notebookAction: + description: Output only. The workflow action's notebook action details. + readOnly: true + $ref: '#/components/schemas/NotebookAction' target: description: >- Output only. This action's identifier. Unique within the workflow @@ -1624,14 +1676,6 @@ components: FAILED] state. readOnly: true $ref: '#/components/schemas/Interval' - bigqueryAction: - description: Output only. The workflow action's bigquery action details. - readOnly: true - $ref: '#/components/schemas/BigQueryAction' - notebookAction: - description: Output only. The workflow action's notebook action details. - readOnly: true - $ref: '#/components/schemas/NotebookAction' BigQueryAction: id: BigQueryAction description: Represents a workflow action that will run against BigQuery. @@ -1665,6 +1709,19 @@ components: buckets. Only set once the job has started to run. readOnly: true type: string + Config: + id: Config + description: Config for all repositories in a given project and location. + type: object + properties: + name: + description: Identifier. The config name. + type: string + defaultKmsKeyName: + description: >- + Optional. The default KMS key that is used if no encryption key is + provided when a repository is created. + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -2092,21 +2149,45 @@ components: - '1' - '2' x-stackQL-resources: + config: + id: google.dataform.config + name: config + title: Config + methods: + get_config: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1config/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_config: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1config/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/config/methods/get_config' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/config/methods/update_config' + replace: [] + delete: [] locations: id: google.dataform.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -2120,23 +2201,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] repositories: id: google.dataform.repositories name: repositories title: Repositories methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.repositories - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: >- @@ -2196,11 +2275,14 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/repositories/methods/get' + - $ref: >- + #/components/x-stackQL-resources/repositories/methods/query_directory_contents - $ref: '#/components/x-stackQL-resources/repositories/methods/list' insert: - $ref: '#/components/x-stackQL-resources/repositories/methods/create' update: - $ref: '#/components/x-stackQL-resources/repositories/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/repositories/methods/delete' repositories_history: @@ -2216,9 +2298,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/repositories_history/methods/fetch_history insert: [] update: [] + replace: [] delete: [] repositories_remote_branches: id: google.dataform.repositories_remote_branches @@ -2233,9 +2318,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/repositories_remote_branches/methods/fetch_remote_branches insert: [] update: [] + replace: [] delete: [] repositories_iam_policies: id: google.dataform.repositories_iam_policies @@ -2249,17 +2337,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: >- @@ -2273,23 +2358,23 @@ components: #/components/x-stackQL-resources/repositories_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/repositories_iam_policies/methods/set_iam_policy delete: [] workspaces: id: google.dataform.workspaces name: workspaces title: Workspaces methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workspaces - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -2398,10 +2483,13 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/workspaces/methods/get' + - $ref: >- + #/components/x-stackQL-resources/workspaces/methods/query_directory_contents - $ref: '#/components/x-stackQL-resources/workspaces/methods/list' insert: - $ref: '#/components/x-stackQL-resources/workspaces/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete' workspaces_file_git_statuses: @@ -2417,9 +2505,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/workspaces_file_git_statuses/methods/fetch_file_git_statuses insert: [] update: [] + replace: [] delete: [] workspaces_git_ahead_behind: id: google.dataform.workspaces_git_ahead_behind @@ -2434,9 +2525,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/workspaces_git_ahead_behind/methods/fetch_git_ahead_behind insert: [] update: [] + replace: [] delete: [] workspaces_file_diff: id: google.dataform.workspaces_file_diff @@ -2451,9 +2545,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/workspaces_file_diff/methods/fetch_file_diff insert: [] update: [] + replace: [] delete: [] workspaces_directory: id: google.dataform.workspaces_directory @@ -2471,7 +2568,10 @@ components: select: [] insert: [] update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/workspaces_directory/methods/remove_directory workspaces_file: id: google.dataform.workspaces_file name: workspaces_file @@ -2488,7 +2588,10 @@ components: select: [] insert: [] update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/workspaces_file/methods/remove_file workspaces_iam_policies: id: google.dataform.workspaces_iam_policies name: workspaces_iam_policies @@ -2501,17 +2604,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_9 + get_iam_policy: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workspaces~1{workspacesId}:getIamPolicy/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_9 - response: *ref_10 test_iam_permissions: operation: $ref: >- @@ -2525,23 +2625,23 @@ components: #/components/x-stackQL-resources/workspaces_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/workspaces_iam_policies/methods/set_iam_policy delete: [] release_configs: id: google.dataform.release_configs name: release_configs title: Release_configs methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1releaseConfigs/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.releaseConfigs - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -2578,6 +2678,7 @@ components: - $ref: '#/components/x-stackQL-resources/release_configs/methods/create' update: - $ref: '#/components/x-stackQL-resources/release_configs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/release_configs/methods/delete' compilation_results: @@ -2585,17 +2686,14 @@ components: name: compilation_results title: Compilation_results methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1compilationResults/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.compilationResults - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: >- @@ -2620,28 +2718,27 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/compilation_results/methods/get' + - $ref: '#/components/x-stackQL-resources/compilation_results/methods/query' - $ref: '#/components/x-stackQL-resources/compilation_results/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/compilation_results/methods/create update: [] + replace: [] delete: [] workflow_configs: id: google.dataform.workflow_configs name: workflow_configs title: Workflow_configs methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workflowConfigs/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workflowConfigs - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -2678,6 +2775,7 @@ components: - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/create' update: - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/workflow_configs/methods/delete' workflow_invocations: @@ -2685,17 +2783,14 @@ components: name: workflow_invocations title: Workflow_invocations methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1workflowInvocations/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workflowInvocations - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: >- @@ -2734,11 +2829,14 @@ components: sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/workflow_invocations/methods/get' + - $ref: >- + #/components/x-stackQL-resources/workflow_invocations/methods/query - $ref: '#/components/x-stackQL-resources/workflow_invocations/methods/list' insert: - $ref: >- #/components/x-stackQL-resources/workflow_invocations/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/workflow_invocations/methods/delete @@ -2754,23 +2852,53 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1commentThreads~1{commentThreadsId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/comment_threads_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/comment_threads_iam_policies/methods/set_iam_policy + delete: [] + comments_iam_policies: + id: google.dataform.comments_iam_policies + name: comments_iam_policies + title: Comments_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1commentThreads~1{commentThreadsId}~1comments~1{commentsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1repositories~1{repositoriesId}~1commentThreads~1{commentThreadsId}~1comments~1{commentsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/comments_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/comments_iam_policies/methods/set_iam_policy delete: [] collections_iam_policies: id: google.dataform.collections_iam_policies @@ -2784,17 +2912,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_21 + get_iam_policy: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}:getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_21 - response: *ref_22 test_iam_permissions: operation: $ref: >- @@ -2808,10 +2933,13 @@ components: #/components/x-stackQL-resources/collections_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/collections_iam_policies/methods/set_iam_policy delete: [] paths: - /v1beta1/projects/{projectsId}/locations: - parameters: &ref_23 + /v1beta1/projects/{projectsId}/locations/{locationsId}/config: + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2823,6 +2951,70 @@ paths: - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' + get: + description: Get default config for a given project and location. + operationId: dataform.projects.locations.getConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Config' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + patch: + description: Update default config for a given project and location. + operationId: dataform.projects.locations.updateConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Config' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Config' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1beta1/projects/{projectsId}/locations: + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: dataform.projects.locations.list @@ -2858,7 +3050,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets information about a location. operationId: dataform.projects.locations.get @@ -2886,7 +3078,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists Repositories in a given project and location. operationId: dataform.projects.locations.repositories.list @@ -2966,7 +3158,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches a single Repository. operationId: dataform.projects.locations.repositories.get @@ -3075,7 +3267,7 @@ paths: schema: type: boolean /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:commit: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Applies a Git commit to a Repository. The Repository must not have a @@ -3115,7 +3307,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:readFile: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Returns the contents of a file (inside a Repository). The Repository @@ -3158,7 +3350,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:queryDirectoryContents: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Returns the contents of a given Repository directory. The Repository @@ -3210,7 +3402,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchHistory: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Fetches a Repository's history of commits. The Repository must not have @@ -3254,7 +3446,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:computeAccessTokenStatus: - parameters: *ref_23 + parameters: *ref_1 get: description: Computes a Repository's Git access token status. operationId: dataform.projects.locations.repositories.computeAccessTokenStatus @@ -3288,7 +3480,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchRemoteBranches: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches a Repository's remote branches. operationId: dataform.projects.locations.repositories.fetchRemoteBranches @@ -3321,7 +3513,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3362,7 +3554,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3402,7 +3594,7 @@ paths: type: integer format: int32 /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3445,7 +3637,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists Workspaces in a given Repository. operationId: dataform.projects.locations.repositories.workspaces.list @@ -3535,7 +3727,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches a single Workspace. operationId: dataform.projects.locations.repositories.workspaces.get @@ -3609,7 +3801,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:installNpmPackages: - parameters: *ref_23 + parameters: *ref_1 post: description: Installs dependency NPM packages (inside a Workspace). operationId: dataform.projects.locations.repositories.workspaces.installNpmPackages @@ -3652,7 +3844,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:pull: - parameters: *ref_23 + parameters: *ref_1 post: description: Pulls Git commits from the Repository's remote into a Workspace. operationId: dataform.projects.locations.repositories.workspaces.pull @@ -3695,7 +3887,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:push: - parameters: *ref_23 + parameters: *ref_1 post: description: Pushes Git commits from a Workspace to the Repository's remote. operationId: dataform.projects.locations.repositories.workspaces.push @@ -3738,7 +3930,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileGitStatuses: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches Git statuses for the files in a Workspace. operationId: dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses @@ -3776,7 +3968,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchGitAheadBehind: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches Git ahead/behind against a remote branch. operationId: dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind @@ -3818,7 +4010,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:commit: - parameters: *ref_23 + parameters: *ref_1 post: description: Applies a Git commit for uncommitted files in a Workspace. operationId: dataform.projects.locations.repositories.workspaces.commit @@ -3861,7 +4053,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:reset: - parameters: *ref_23 + parameters: *ref_1 post: description: Performs a Git reset for uncommitted files in a Workspace. operationId: dataform.projects.locations.repositories.workspaces.reset @@ -3904,7 +4096,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileDiff: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches Git diff for an uncommitted file in a Workspace. operationId: dataform.projects.locations.repositories.workspaces.fetchFileDiff @@ -3946,7 +4138,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:queryDirectoryContents: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns the contents of a given Workspace directory. operationId: >- @@ -3998,7 +4190,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:searchFiles: - parameters: *ref_23 + parameters: *ref_1 get: description: Finds the contents of a given Workspace directory by filter. operationId: dataform.projects.locations.repositories.workspaces.searchFiles @@ -4049,7 +4241,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:makeDirectory: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates a directory inside a Workspace. operationId: dataform.projects.locations.repositories.workspaces.makeDirectory @@ -4092,7 +4284,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeDirectory: - parameters: *ref_23 + parameters: *ref_1 post: description: Deletes a directory (inside a Workspace) and all of its contents. operationId: dataform.projects.locations.repositories.workspaces.removeDirectory @@ -4135,7 +4327,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveDirectory: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Moves a directory (inside a Workspace), and all of its contents, to a @@ -4180,7 +4372,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:readFile: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns the contents of a file (inside a Workspace). operationId: dataform.projects.locations.repositories.workspaces.readFile @@ -4226,7 +4418,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeFile: - parameters: *ref_23 + parameters: *ref_1 post: description: Deletes a file (inside a Workspace). operationId: dataform.projects.locations.repositories.workspaces.removeFile @@ -4269,7 +4461,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveFile: - parameters: *ref_23 + parameters: *ref_1 post: description: Moves a file (inside a Workspace) to a new location. operationId: dataform.projects.locations.repositories.workspaces.moveFile @@ -4312,7 +4504,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile: - parameters: *ref_23 + parameters: *ref_1 post: description: Writes to a file (inside a Workspace). operationId: dataform.projects.locations.repositories.workspaces.writeFile @@ -4355,7 +4547,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4401,7 +4593,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4446,7 +4638,7 @@ paths: type: integer format: int32 /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4494,7 +4686,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists ReleaseConfigs in a given Repository. operationId: dataform.projects.locations.repositories.releaseConfigs.list @@ -4576,7 +4768,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches a single ReleaseConfig. operationId: dataform.projects.locations.repositories.releaseConfigs.get @@ -4696,7 +4888,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists CompilationResults in a given Repository. operationId: dataform.projects.locations.repositories.compilationResults.list @@ -4782,7 +4974,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches a single CompilationResult. operationId: dataform.projects.locations.repositories.compilationResults.get @@ -4820,7 +5012,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}:query: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns CompilationResultActions in a given CompilationResult. operationId: dataform.projects.locations.repositories.compilationResults.query @@ -4871,7 +5063,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists WorkflowConfigs in a given Repository. operationId: dataform.projects.locations.repositories.workflowConfigs.list @@ -4953,7 +5145,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches a single WorkflowConfig. operationId: dataform.projects.locations.repositories.workflowConfigs.get @@ -5073,7 +5265,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists WorkflowInvocations in a given Repository. operationId: dataform.projects.locations.repositories.workflowInvocations.list @@ -5159,7 +5351,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Fetches a single WorkflowInvocation. operationId: dataform.projects.locations.repositories.workflowInvocations.get @@ -5233,7 +5425,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:cancel: - parameters: *ref_23 + parameters: *ref_1 post: description: Requests cancellation of a running WorkflowInvocation. operationId: dataform.projects.locations.repositories.workflowInvocations.cancel @@ -5276,7 +5468,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:query: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns WorkflowInvocationActions in a given WorkflowInvocation. operationId: dataform.projects.locations.repositories.workflowInvocations.query @@ -5323,7 +5515,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5369,7 +5561,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5413,8 +5605,111 @@ paths: schema: type: integer format: int32 + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}/comments/{commentsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: >- + dataform.projects.locations.repositories.commentThreads.comments.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: commentThreadsId + required: true + schema: + type: string + - in: path + name: commentsId + required: true + schema: + type: string + /v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/commentThreads/{commentThreadsId}/comments/{commentsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: >- + dataform.projects.locations.repositories.commentThreads.comments.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: repositoriesId + required: true + schema: + type: string + - in: path + name: commentThreadsId + required: true + schema: + type: string + - in: path + name: commentsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 /v1beta1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5455,7 +5750,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5495,7 +5790,7 @@ paths: type: integer format: int32 /v1beta1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml b/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml index cd8d4e22..fdb08ddd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datafusion.yaml @@ -14,8 +14,8 @@ info: prepare, blend, transfer and transform data without having to wrestle with infrastructure. version: v1 - x-discovery-doc-revision: '20240111' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240703' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/data-fusion/docs servers: @@ -380,7 +380,7 @@ components: items: $ref: '#/components/schemas/Accelerator' p4ServiceAccount: - description: Output only. P4 service account for the customer project. + description: Output only. Service agent for the customer project. readOnly: true type: string tenantProjectId: @@ -440,6 +440,9 @@ components: dataplexDataLineageIntegrationEnabled: description: Optional. Option to enable the Dataplex Lineage Integration feature. type: boolean + maintenancePolicy: + description: Optional. Configure the maintenance policy for this instance. + $ref: '#/components/schemas/MaintenancePolicy' NetworkConfig: id: NetworkConfig description: >- @@ -455,8 +458,7 @@ components: network: description: >- Optional. Name of the network in the customer project with which the - Tenant Project will be peered for executing pipelines. This is - required only when using connection type VPC peering. In case of + Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}. This is only @@ -538,22 +540,17 @@ components: type: object properties: acceleratorType: - description: The type of an accelator for a CDF instance. + description: Optional. The type of an accelator for a Cloud Data Fusion instance. type: string enumDescriptions: - Default value, if unspecified. - - Change Data Capture accelerator for CDF. - - >- - Cloud Healthcare accelerator for CDF. This accelerator is to - enable Cloud Healthcare specific CDF plugins developed by - Healthcare team. + - Change Data Capture accelerator for Cloud Data Fusion. + - Reserved for internal use. - >- Contact Center AI Insights This accelerator is used to enable import and export pipelines custom built to streamline CCAI Insights processing. - - >- - Cloud search accelerator for CDF. This accelerator is to enable - Cloud search specific CDF plugins developed by Cloudsearch team. + - Reserved for internal use. enum: - ACCELERATOR_TYPE_UNSPECIFIED - CDC @@ -561,7 +558,8 @@ components: - CCAI_INSIGHTS - CLOUDSEARCH state: - description: The state of the accelerator. + description: Output only. The state of the accelerator. + readOnly: true type: string enumDescriptions: - Default value, do not use. @@ -603,6 +601,70 @@ components: Required. The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id} type: string + MaintenancePolicy: + id: MaintenancePolicy + description: Maintenance policy of the instance. + type: object + properties: + maintenanceWindow: + description: Optional. The maintenance window of the instance. + $ref: '#/components/schemas/MaintenanceWindow' + maintenanceExclusionWindow: + description: Optional. The maintenance exclusion window of the instance. + $ref: '#/components/schemas/TimeWindow' + MaintenanceWindow: + id: MaintenanceWindow + description: Maintenance window of the instance. + type: object + properties: + recurringTimeWindow: + description: Required. The recurring time window of the maintenance window. + $ref: '#/components/schemas/RecurringTimeWindow' + RecurringTimeWindow: + id: RecurringTimeWindow + description: Represents an arbitrary window of time that recurs. + type: object + properties: + window: + description: >- + Required. The window representing the start and end time of + recurrences. This field ignores the date components of the provided + timestamps. Only the time of day and duration between start and end + time are relevant. + $ref: '#/components/schemas/TimeWindow' + recurrence: + description: >- + Required. An RRULE with format + [RFC-5545](https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for + how this window reccurs. They go on for the span of time between the + start and end time. The only supported FREQ value is "WEEKLY". To + have something repeat every weekday, use: + "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR". This specifies how frequently + the window starts. To have a 9 am - 5 pm UTC-4 window every weekday, + use something like: ``` start time = 2019-01-01T09:00:00-0400 end + time = 2019-01-01T17:00:00-0400 recurrence = + FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` + type: string + TimeWindow: + id: TimeWindow + description: Represents an arbitrary window of time. + type: object + properties: + startTime: + description: >- + Required. The start time of the time window provided in [RFC + 3339](https://www.ietf.org/rfc/rfc3339.txt) format. Example: + "2024-01-01T12:04:06-04:00" + type: string + format: google-datetime + endTime: + description: >- + Required. The end time of the time window provided in [RFC + 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The end time + should take place after the start time. Example: + "2024-01-02T12:04:06-06:00" + type: string + format: google-datetime RestartInstanceRequest: id: RestartInstanceRequest description: Request message for restarting a Data Fusion instance. @@ -821,7 +883,11 @@ components: role: description: >- Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string members: description: >- @@ -1069,94 +1135,287 @@ components: type: object additionalProperties: type: string - DataResidencyAugmentedView: - id: DataResidencyAugmentedView - description: 'Next tag: 7' + AssetLocation: + id: AssetLocation + description: >- + Provides the mapping of a cloud asset to a direct physical location or + to a proxy that defines the location on its behalf. type: object properties: - tpIds: + expected: description: >- - The list of project_id's of the tenant projects in the 'google.com' - org which serve the Cloud Resource. See go/drz-mst-sig for more - details. + Defines the customer expectation around ZI/ZS for this asset and + ZI/ZS state of the region at the time of asset creation. + $ref: '#/components/schemas/IsolationExpectations' + locationData: + description: Contains all kinds of physical location definitions for this asset. type: array items: - type: string - serviceData: + $ref: '#/components/schemas/LocationData' + parentAsset: description: >- - Service-specific data. Only required for pre-determined services. - Generally used to bind a Cloud Resource to some a TI container that - uniquely specifies a customer. See milestone 2 of DRZ KR8 SIG for - more information. - $ref: '#/components/schemas/ServiceData' - crGopoGuris: + Defines parents assets if any in order to allow later generation of + child_asset_location data via child assets. + type: array + items: + $ref: '#/components/schemas/CloudAsset' + extraParameters: + description: Defines extra parameters required for specific asset types. + type: array + items: + $ref: '#/components/schemas/ExtraParameter' + IsolationExpectations: + id: IsolationExpectations + type: object + properties: + zoneIsolation: description: >- - Cloud resource to Google owned production object mapping in the form - of GURIs. The GURIs should be available in DG KB storage/cns tables. - This is the preferred way of providing cloud resource mappings. For - further details please read go/cloud-resource-monitoring_sig + Deprecated: use zi_org_policy, zi_region_policy and zi_region_state + instead for setting ZI expectations as per + go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zoneSeparation: + description: >- + Deprecated: use zs_org_policy, and zs_region_stateinstead for + setting Zs expectations as per go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking of the asset ZS-bit is not available + - '' + - '' + enum: + - ZS_REGION_UNSPECIFIED + - ZS_REGION_UNKNOWN + - ZS_REGION_NOT_ENABLED + - ZS_REGION_ENABLED + ziOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + ziRegionPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_REGION_POLICY_UNSPECIFIED + - ZI_REGION_POLICY_UNKNOWN + - ZI_REGION_POLICY_NOT_SET + - ZI_REGION_POLICY_FAIL_OPEN + - ZI_REGION_POLICY_FAIL_CLOSED + ziRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZI_REGION_UNSPECIFIED + - ZI_REGION_UNKNOWN + - ZI_REGION_NOT_ENABLED + - ZI_REGION_ENABLED + LocationData: + id: LocationData + type: object + properties: + directLocation: + $ref: '#/components/schemas/DirectLocationAssignment' + spannerLocation: + $ref: '#/components/schemas/SpannerLocation' + childAssetLocation: + $ref: '#/components/schemas/CloudAssetComposition' + gcpProjectProxy: + $ref: '#/components/schemas/TenantProjectProxy' + blobstoreLocation: + $ref: '#/components/schemas/BlobstoreLocation' + placerLocation: + $ref: '#/components/schemas/PlacerLocation' + DirectLocationAssignment: + id: DirectLocationAssignment + type: object + properties: + location: + type: array + items: + $ref: '#/components/schemas/LocationAssignment' + LocationAssignment: + id: LocationAssignment + type: object + properties: + location: + type: string + locationType: + type: string + enumDescriptions: + - '' + - '1-10: Physical failure domains.' + - '' + - '11-20: Logical failure domains.' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - CLUSTER + - POP + - CLOUD_ZONE + - CLOUD_REGION + - MULTI_REGION_GEO + - MULTI_REGION_JURISDICTION + - GLOBAL + - OTHER + SpannerLocation: + id: SpannerLocation + type: object + properties: + dbName: + description: Set of databases used by the resource in format /span// type: array items: type: string - crGopoPrefixes: + backupName: description: >- - Cloud resource to Google owned production object mapping in the form - of prefixes. These should be available in DG KB storage/cns tables. - The entity type, which is the part of the string before the first - colon in the GURI, must be completely specified in prefix. For - details about GURI please read go/guri. For further details about - the field please read go/cloud-resource-monitoring_sig. + Set of backups used by the resource with name in the same format as + what is available at http://table/spanner_automon.backup_metadata type: array items: type: string - ServiceData: - id: ServiceData - description: >- - This message defines service-specific data that certain service teams - must provide as part of the Data Residency Augmented View for a - resource. Next ID: 2 + CloudAssetComposition: + id: CloudAssetComposition type: object properties: - pd: - description: >- - Auxiliary data for the persistent disk pipeline provided to provide - the LSV Colossus Roots and GCS Buckets. - $ref: '#/components/schemas/PersistentDiskData' - PersistentDiskData: - id: PersistentDiskData + childAsset: + type: array + items: + $ref: '#/components/schemas/CloudAsset' + CloudAsset: + id: CloudAsset + type: object + properties: + assetType: + type: string + assetName: + type: string + TenantProjectProxy: + id: TenantProjectProxy + type: object + properties: + projectNumbers: + type: array + items: + type: string + BlobstoreLocation: + id: BlobstoreLocation description: >- - Persistent Disk service-specific Data. Contains information that may not - be appropriate for the generic DRZ Augmented View. This currently - includes LSV Colossus Roots and GCS Buckets. + Policy ID that identified data placement in Blobstore as per + go/blobstore-user-guide#data-metadata-placement-and-failure-domains type: object properties: - cfsRoots: - description: >- - Path to Colossus root for an LSV. NOTE: Unlike `cr_ti_guris` and - `cr_ti_prefixes`, the field `cfs_roots` below does not need to be a - GUri or GUri prefix. It can simply be any valid CFS or CFS2 Path. - The DRZ KR8 SIG has more details overall, but generally the - `cfs_roots` provided here should be scoped to an individual - Persistent Disk. An example for a PD Disk with a disk ID - 3277719120423414466, follows: * `cr_ti_guris` could be - ‘/cfs2/pj/pd-cloud-prod’ as this is a valid GUri present in the DG - KB and contains enough information to perform location monitoring - and scope ownership of the Production Object. * `cfs_roots` would - be: ‘/cfs2/pj/pd-cloud-staging/lsv000001234@/ - lsv/projects~773365403387~zones~2700~disks~3277719120423414466 - ~bank-blue-careful-3526-lsv00054DB1B7254BA3/’ as this allows us to - enumerate the files on CFS2 that belong to an individual Disk. + policyId: type: array items: type: string - gcsBucketNames: + PlacerLocation: + id: PlacerLocation + description: >- + Message describing that the location of the customer resource is tied to + placer allocations + type: object + properties: + placerConfig: + description: >- + Directory with a config related to it in placer (e.g. + "/placer/prod/home/my-root/my-dir") + type: string + ExtraParameter: + id: ExtraParameter + description: Defines parameters that should only be used for specific asset types. + type: object + properties: + regionalMigDistributionPolicy: description: >- - The GCS Buckets that back this snapshot or image. This is required - as `cr_ti_prefixes` and `cr_ti_guris` only accept TI resources. This - should be the globally unique bucket name. + Details about zones used by regional + compute.googleapis.com/InstanceGroupManager to create instances. + $ref: '#/components/schemas/RegionalMigDistributionPolicy' + RegionalMigDistributionPolicy: + id: RegionalMigDistributionPolicy + description: >- + To be used for specifying the intended distribution of regional + compute.googleapis.com/InstanceGroupManager instances + type: object + properties: + zones: + description: Cloud zones used by regional MIG to create instances. type: array items: - type: string + $ref: '#/components/schemas/ZoneConfiguration' + targetShape: + description: >- + The shape in which the group converges around distribution of + resources. Instance of proto2 enum + type: integer + format: int32 + ZoneConfiguration: + id: ZoneConfiguration + type: object + properties: + zone: + type: string parameters: access_token: description: OAuth access token. @@ -1243,16 +1502,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1265,23 +1521,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.datafusion.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1309,6 +1563,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' versions: @@ -1316,39 +1571,34 @@ components: name: versions title: Versions methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1versions/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.availableVersions - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: [] update: [] + replace: [] delete: [] instances: id: google.datafusion.instances name: instances title: Instances methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -1392,6 +1642,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_iam_policies: @@ -1406,17 +1657,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_9 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:getIamPolicy/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_9 - response: *ref_10 test_iam_permissions: operation: $ref: >- @@ -1430,6 +1678,9 @@ components: #/components/x-stackQL-resources/instances_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/set_iam_policy delete: [] dns_peerings: id: google.datafusion.dns_peerings @@ -1443,17 +1694,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1dnsPeerings/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dnsPeerings - list: - operation: *ref_11 - response: *ref_12 delete: operation: $ref: >- @@ -1467,11 +1715,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/dns_peerings/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/dns_peerings/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1508,10 +1757,6 @@ paths: name: filter schema: type: string - - in: query - name: includeUnrevealedLocations - schema: - type: boolean - in: query name: pageSize schema: @@ -1522,7 +1767,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a location. operationId: datafusion.projects.locations.get @@ -1550,7 +1795,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1593,7 +1838,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1664,7 +1909,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1711,7 +1956,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/versions: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists possible versions for Data Fusion instances in the specified @@ -1754,7 +1999,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists Data Fusion instances in the specified project and location. operationId: datafusion.projects.locations.instances.list @@ -1836,7 +2081,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets details of a single Data Fusion instance. operationId: datafusion.projects.locations.instances.get @@ -1941,7 +2186,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restart: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Restart a single Data Fusion instance. At the end of an operation @@ -1981,7 +2226,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2022,7 +2267,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2062,7 +2307,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2105,7 +2350,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/dnsPeerings: - parameters: *ref_13 + parameters: *ref_1 post: description: Creates DNS peering on the given resource. operationId: datafusion.projects.locations.instances.dnsPeerings.create @@ -2187,7 +2432,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/dnsPeerings/{dnsPeeringsId}: - parameters: *ref_13 + parameters: *ref_1 delete: description: Deletes DNS peering on the given resource. operationId: datafusion.projects.locations.instances.dnsPeerings.delete diff --git a/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml b/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml index ce5ee1be..201346a0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalabeling.yaml @@ -7,8 +7,8 @@ info: title: Data Labeling API description: Public API for Google Cloud AI Data Labeling Service. version: v1beta1 - x-discovery-doc-revision: '20240207' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240807' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/data-labeling/docs/ servers: @@ -4092,16 +4092,13 @@ components: name: operations title: Operations methods: - _projects_operations_list: - operation: &ref_1 + projects_operations_list: + operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_operations_list: - operation: *ref_1 - response: *ref_2 projects_operations_get: operation: $ref: >- @@ -4131,6 +4128,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_operations_delete @@ -4145,16 +4143,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_datasets_list: - operation: &ref_3 + projects_datasets_list: + operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1datasets/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.datasets - projects_datasets_list: - operation: *ref_3 - response: *ref_4 projects_datasets_get: operation: $ref: >- @@ -4193,6 +4188,7 @@ components: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_datasets_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_datasets_delete @@ -4208,17 +4204,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_datasets_data_items_list: - operation: &ref_5 + projects_datasets_data_items_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1dataItems/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataItems - projects_datasets_data_items_list: - operation: *ref_5 - response: *ref_6 projects_datasets_annotated_datasets_data_items_get: operation: $ref: >- @@ -4226,17 +4219,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_datasets_annotated_datasets_data_items_list: - operation: &ref_7 + projects_datasets_annotated_datasets_data_items_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1annotatedDatasets~1{annotatedDatasetsId}~1dataItems/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataItems - projects_datasets_annotated_datasets_data_items_list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: >- @@ -4249,6 +4239,7 @@ components: #/components/x-stackQL-resources/data_items/methods/projects_datasets_data_items_list insert: [] update: [] + replace: [] delete: [] annotated_datasets: id: google.datalabeling.annotated_datasets @@ -4269,17 +4260,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_datasets_annotated_datasets_list: - operation: &ref_9 + projects_datasets_annotated_datasets_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1annotatedDatasets/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.annotatedDatasets - projects_datasets_annotated_datasets_list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: >- @@ -4288,6 +4276,7 @@ components: #/components/x-stackQL-resources/annotated_datasets/methods/projects_datasets_annotated_datasets_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/annotated_datasets/methods/projects_datasets_annotated_datasets_delete @@ -4303,17 +4292,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_datasets_annotated_datasets_examples_list: - operation: &ref_11 + projects_datasets_annotated_datasets_examples_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1annotatedDatasets~1{annotatedDatasetsId}~1examples/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.examples - projects_datasets_annotated_datasets_examples_list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: >- @@ -4322,6 +4308,7 @@ components: #/components/x-stackQL-resources/examples/methods/projects_datasets_annotated_datasets_examples_list insert: [] update: [] + replace: [] delete: [] feedback_threads: id: google.datalabeling.feedback_threads @@ -4342,17 +4329,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_datasets_annotated_datasets_feedback_threads_list: - operation: &ref_13 + projects_datasets_annotated_datasets_feedback_threads_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1annotatedDatasets~1{annotatedDatasetsId}~1feedbackThreads/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.feedbackThreads - projects_datasets_annotated_datasets_feedback_threads_list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: >- @@ -4361,6 +4345,7 @@ components: #/components/x-stackQL-resources/feedback_threads/methods/projects_datasets_annotated_datasets_feedback_threads_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/feedback_threads/methods/projects_datasets_annotated_datasets_feedback_threads_delete @@ -4376,17 +4361,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list: - operation: &ref_15 + projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1datasets~1{datasetsId}~1annotatedDatasets~1{annotatedDatasetsId}~1feedbackThreads~1{feedbackThreadsId}~1feedbackMessages/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.feedbackMessages - projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list: - operation: *ref_15 - response: *ref_16 projects_datasets_annotated_datasets_feedback_threads_feedback_messages_get: operation: $ref: >- @@ -4411,6 +4393,7 @@ components: - $ref: >- #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/feedback_messages/methods/projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete @@ -4430,6 +4413,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] video: id: google.datalabeling.video @@ -4447,6 +4431,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] text: id: google.datalabeling.text @@ -4464,6 +4449,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] evaluations: id: google.datalabeling.evaluations @@ -4489,6 +4475,7 @@ components: #/components/x-stackQL-resources/evaluations/methods/projects_datasets_evaluations_get insert: [] update: [] + replace: [] delete: [] example_comparisons: id: google.datalabeling.example_comparisons @@ -4506,6 +4493,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] annotation_spec_sets: id: google.datalabeling.annotation_spec_sets @@ -4518,16 +4506,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_annotation_spec_sets_list: - operation: &ref_17 + projects_annotation_spec_sets_list: + operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1annotationSpecSets/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.annotationSpecSets - projects_annotation_spec_sets_list: - operation: *ref_17 - response: *ref_18 projects_annotation_spec_sets_get: operation: $ref: >- @@ -4552,6 +4537,7 @@ components: - $ref: >- #/components/x-stackQL-resources/annotation_spec_sets/methods/projects_annotation_spec_sets_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/annotation_spec_sets/methods/projects_annotation_spec_sets_delete @@ -4566,16 +4552,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instructions_list: - operation: &ref_19 + projects_instructions_list: + operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1instructions/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instructions - projects_instructions_list: - operation: *ref_19 - response: *ref_20 projects_instructions_get: operation: $ref: >- @@ -4600,6 +4583,7 @@ components: - $ref: >- #/components/x-stackQL-resources/instructions/methods/projects_instructions_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instructions/methods/projects_instructions_delete @@ -4614,16 +4598,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_evaluation_jobs_list: - operation: &ref_21 + projects_evaluation_jobs_list: + operation: $ref: '#/paths/~1v1beta1~1projects~1{projectsId}~1evaluationJobs/get' - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.evaluationJobs - projects_evaluation_jobs_list: - operation: *ref_21 - response: *ref_22 projects_evaluation_jobs_patch: operation: $ref: >- @@ -4671,12 +4652,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/evaluation_jobs/methods/projects_evaluation_jobs_delete paths: /v1beta1/projects/{projectsId}/operations: - parameters: &ref_23 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4725,7 +4707,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4786,7 +4768,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/operations/{operationsId}:cancel: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4823,7 +4805,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates dataset. If success return a Dataset resource. operationId: datalabeling.projects.datasets.create @@ -4887,7 +4869,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets dataset by resource name. operationId: datalabeling.projects.datasets.get @@ -4941,7 +4923,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}:importData: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Imports data into dataset based on source locations defined in request. @@ -4980,7 +4962,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}:exportData: - parameters: *ref_23 + parameters: *ref_1 post: description: Exports data and annotations from dataset. operationId: datalabeling.projects.datasets.exportData @@ -5014,7 +4996,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems/{dataItemsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets a data item in a dataset by resource name. This API can be called @@ -5049,7 +5031,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/dataItems: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Lists data items in a dataset. This API can be called after data are @@ -5093,7 +5075,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets an annotated dataset by resource name. operationId: datalabeling.projects.datasets.annotatedDatasets.get @@ -5158,7 +5140,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists annotated datasets for a dataset. Pagination is supported. operationId: datalabeling.projects.datasets.annotatedDatasets.list @@ -5200,7 +5182,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems/{dataItemsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets a data item in a dataset by resource name. This API can be called @@ -5240,7 +5222,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/dataItems: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Lists data items in a dataset. This API can be called after data are @@ -5289,7 +5271,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples/{examplesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets an example by resource name, including both data and annotation. operationId: datalabeling.projects.datasets.annotatedDatasets.examples.get @@ -5331,7 +5313,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/examples: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists examples in an annotated dataset. Pagination is supported. operationId: datalabeling.projects.datasets.annotatedDatasets.examples.list @@ -5378,7 +5360,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Get a FeedbackThread object. operationId: datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get @@ -5453,7 +5435,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads: - parameters: *ref_23 + parameters: *ref_1 get: description: List FeedbackThreads with pagination. operationId: datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list @@ -5496,7 +5478,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages: - parameters: *ref_23 + parameters: *ref_1 post: description: Create a FeedbackMessage object. operationId: >- @@ -5588,7 +5570,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/annotatedDatasets/{annotatedDatasetsId}/feedbackThreads/{feedbackThreadsId}/feedbackMessages/{feedbackMessagesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Get a FeedbackMessage object. operationId: >- @@ -5675,7 +5657,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/image:label: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Starts a labeling task for image. The type of image labeling task is @@ -5711,7 +5693,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/video:label: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Starts a labeling task for video. The type of video labeling task is @@ -5747,7 +5729,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/text:label: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Starts a labeling task for text. The type of text labeling task is @@ -5783,7 +5765,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets an evaluation by resource name (to search, use @@ -5818,7 +5800,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/datasets/{datasetsId}/evaluations/{evaluationsId}/exampleComparisons:search: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Searches example comparisons from an evaluation. The return format is a @@ -5861,7 +5843,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/annotationSpecSets: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates an annotation spec set by providing a set of labels. operationId: datalabeling.projects.annotationSpecSets.create @@ -5926,7 +5908,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/annotationSpecSets/{annotationSpecSetsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets an annotation spec set by resource name. operationId: datalabeling.projects.annotationSpecSets.get @@ -5981,7 +5963,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/instructions: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates an instruction for how data should be labeled. operationId: datalabeling.projects.instructions.create @@ -6045,7 +6027,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/instructions/{instructionsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets an instruction by resource name. operationId: datalabeling.projects.instructions.get @@ -6099,7 +6081,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/evaluations:search: - parameters: *ref_23 + parameters: *ref_1 get: description: Searches evaluations within a project. operationId: datalabeling.projects.evaluations.search @@ -6136,7 +6118,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/evaluationJobs: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates an evaluation job. operationId: datalabeling.projects.evaluationJobs.create @@ -6203,7 +6185,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}: - parameters: *ref_23 + parameters: *ref_1 patch: description: >- Updates an evaluation job. You can only update certain fields of the @@ -6300,7 +6282,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:pause: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Pauses an evaluation job. Pausing an evaluation job that is already in a @@ -6336,7 +6318,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/evaluationJobs/{evaluationJobsId}:resume: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Resumes a paused evaluation job. A deleted evaluation job can't be diff --git a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml index 2aefa751..a4b6f27f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datalineage.yaml @@ -7,8 +7,8 @@ info: title: Data Lineage API description: '' version: v1 - x-discovery-doc-revision: '20240517' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240902' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/data-catalog servers: @@ -34,152 +34,121 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDatacatalogLineageV1LineageEvent: - id: GoogleCloudDatacatalogLineageV1LineageEvent + GoogleCloudDatacatalogLineageV1EntityReference: + description: The soft reference to everything you can attach a lineage event to. properties: - name: - type: string - description: >- - Immutable. The resource name of the lineage event. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. - Can be specified or auto-assigned. {lineage_event} must be not - longer than 200 characters and only contain characters in a set: - `a-zA-Z0-9_-:.` - links: - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' - type: array - description: >- - Optional. List of source-target pairs. Can't contain more than 100 - tuples. - endTime: - type: string + fullyQualifiedName: description: >- - Optional. The end of the transformation which resulted in this - lineage event. For streaming scenarios, it should be the end of the - period from which the lineage is being reported. - format: google-datetime - startTime: + Required. [Fully Qualified Name + (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) + of the entity. type: string - format: google-datetime - description: >- - Required. The beginning of the transformation which resulted in this - lineage event. For streaming scenarios, it should be the beginning - of the period from which the lineage is being reported. - description: >- - A lineage event represents an operation on assets. Within the operation, - the data flows from the source to the target defined in the links field. - type: object - GoogleLongrunningCancelOperationRequest: - id: GoogleLongrunningCancelOperationRequest + id: GoogleCloudDatacatalogLineageV1EntityReference type: object - description: The request message for Operations.CancelOperation. - properties: {} GoogleCloudDatacatalogLineageV1SearchLinksRequest: type: object - id: GoogleCloudDatacatalogLineageV1SearchLinksRequest - description: Request message for SearchLinks. properties: - source: - description: >- - Optional. Send asset information in the **source** field to retrieve - all links that lead from the specified asset to downstream assets. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' pageSize: + type: integer description: >- Optional. The maximum number of links to return in a single page of the response. A page may contain fewer links than this value. If unspecified, at most 10 links are returned. Maximum value is 100; values greater than 100 are reduced to 100. - type: integer format: int32 target: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' description: >- Optional. Send asset information in the **target** field to retrieve all links that lead from upstream assets to the specified asset. - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' pageToken: + type: string description: >- Optional. The page token received from a previous `SearchLinksRequest` call. Use it to get the next page. When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request. - type: string - GoogleCloudDatacatalogLineageV1Process: + source: + description: >- + Optional. Send asset information in the **source** field to retrieve + all links that lead from the specified asset to downstream assets. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + id: GoogleCloudDatacatalogLineageV1SearchLinksRequest + description: Request message for SearchLinks. + GoogleCloudDatacatalogLineageV1Link: properties: name: - description: >- - Immutable. The resource name of the lineage process. Format: - `projects/{project}/locations/{location}/processes/{process}`. Can - be specified or auto-assigned. {process} must be not longer than 200 - characters and only contain characters in a set: `a-zA-Z0-9_-:.` type: string - origin: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' - description: >- - Optional. The origin of this process and its runs and lineage - events. - displayName: description: >- - Optional. A human-readable name you can set to display in a user - interface. Must be not longer than 200 characters and only contain - UTF-8 letters or numbers, spaces or characters like `_-:&.` + Output only. Immutable. The name of the link. Format: + `projects/{project}/locations/{location}/links/{link}`. + readOnly: true + source: + description: The pointer to the entity that is the **source** of this link. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + endTime: + type: string + format: google-datetime + description: The end of the last event establishing this link. + target: + description: The pointer to the entity that is the **target** of this link. + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + startTime: + description: The start of the first event establishing this link. + format: google-datetime type: string - attributes: - type: object - additionalProperties: - type: any - description: >- - Optional. The attributes of the process. Should only be used for the - purpose of non-semantic management (classifying, describing or - labeling the process). Up to 100 attributes are allowed. type: object - description: A process is the definition of a data transformation operation. - id: GoogleCloudDatacatalogLineageV1Process + description: >- + Links represent the data flow between **source** (upstream) and + **target** (downstream) assets in transformation pipelines. Links are + created when LineageEvents record data transformation between related + assets. + id: GoogleCloudDatacatalogLineageV1Link GoogleCloudDatacatalogLineageV1ProcessLinks: - description: Links associated with a specific process. type: object - id: GoogleCloudDatacatalogLineageV1ProcessLinks properties: links: - items: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo type: array description: >- An array containing link details objects of the links provided in the original request. A single process can result in creating multiple links. If any of the links you provide in the request are created by the same process, they all are included in this array. + items: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinkInfo process: - type: string description: >- The process name in the format of `projects/{project}/locations/{location}/processes/{process}`. - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + type: string + description: Links associated with a specific process. + id: GoogleCloudDatacatalogLineageV1ProcessLinks + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. properties: - processLinks: + operations: type: array + description: >- + A list of operations that matches the specified filter in the + request. items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' - description: An array of processes associated with the specified links. + $ref: '#/components/schemas/GoogleLongrunningOperation' nextPageToken: type: string - description: >- - The token to specify as `page_token` in the subsequent call to get - the next page. Omitted if there are no more pages in the response. + description: The standard List next-page token. type: object - description: Response message for BatchSearchLinkProcesses. GoogleCloudDatacatalogLineageV1Origin: + id: GoogleCloudDatacatalogLineageV1Origin properties: sourceType: - type: string description: >- Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice. + type: string enum: - SOURCE_TYPE_UNSPECIFIED - CUSTOM @@ -188,6 +157,7 @@ components: - COMPOSER - LOOKER_STUDIO - DATAPROC + - VERTEX_AI enumDescriptions: - Source is Unspecified - A custom source @@ -196,8 +166,8 @@ components: - Composer - Looker Studio - Dataproc + - Vertex AI name: - type: string description: >- If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project @@ -207,59 +177,62 @@ components: "projects/foo/locations/us/environments/bar"}` - `{source_type: BIGQUERY, name: "projects/foo/locations/eu"}` - `{source_type: CUSTOM, name: "myCustomIntegration"}` - type: object - description: Origin of a process. - id: GoogleCloudDatacatalogLineageV1Origin - GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: - properties: - lineageEvents: - description: Lineage events from the specified project and location. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' - nextPageToken: type: string - description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. - id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse - description: Response message for ListLineageEvents. - type: object - GoogleCloudDatacatalogLineageV1EventLink: - description: A lineage between source and target entities. - properties: - target: - description: Required. Reference to the target entity - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - source: - description: Required. Reference to the source entity - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - id: GoogleCloudDatacatalogLineageV1EventLink type: object - GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: + description: Origin of a process. + GoogleLongrunningOperation: type: object - id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse properties: - run: - type: string + metadata: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Created run name. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. - lineageEvents: - type: array - items: - type: string + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + error: description: >- - Created lineage event names. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. - process: + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + done: description: >- - Created process name. Format: - `projects/{project}/locations/{location}/processes/{process}`. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + name: type: string - description: Response message for ProcessOpenLineageRunEvent. + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: GoogleLongrunningOperation GoogleRpcStatus: type: object + id: GoogleRpcStatus description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -268,364 +241,387 @@ components: details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus properties: message: - type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. + type: string details: type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. items: + type: object additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any - type: object - GoogleCloudDatacatalogLineageV1ProcessLinkInfo: - properties: - startTime: - type: string - description: The start of the first event establishing this link-process tuple. - format: google-datetime - link: - type: string + description: Properties of the object. Contains field @type with type URL. description: >- - The name of the link in the format of - `projects/{project}/locations/{location}/links/{link}`. - endTime: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: + properties: + pageToken: + description: >- + The page token received from a previous `BatchSearchLinkProcesses` + call. Use it to get the next page. When requesting subsequent pages + of a response, remember that all parameters must match the values + you provided in the original request. type: string - format: google-datetime - description: The end of the last event establishing this link-process tuple. - description: Link details. - id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo + pageSize: + type: integer + format: int32 + description: >- + The maximum number of processes to return in a single page of the + response. A page may contain fewer results than this value. + links: + items: + type: string + description: >- + Required. An array of links to check for their associated + LineageProcesses. The maximum number of items in this array is 100. + If the request contains more than 100 links, it returns the + `INVALID_ARGUMENT` error. Format: + `projects/{project}/locations/{location}/links/{link}`. + type: array + description: Request message for BatchSearchLinkProcesses. + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest type: object - GoogleCloudDatacatalogLineageV1EntityReference: - id: GoogleCloudDatacatalogLineageV1EntityReference + GoogleProtobufEmpty: type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: GoogleProtobufEmpty + properties: {} + GoogleCloudDatacatalogLineageV1LineageEvent: + description: >- + A lineage event represents an operation on assets. Within the operation, + the data flows from the source to the target defined in the links field. properties: - fullyQualifiedName: + startTime: + format: google-datetime description: >- - Required. [Fully Qualified Name - (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) - of the entity. - type: string - description: The soft reference to everything you can attach a lineage event to. - GoogleCloudDatacatalogLineageV1ListProcessesResponse: - properties: - nextPageToken: + Required. The beginning of the transformation which resulted in this + lineage event. For streaming scenarios, it should be the beginning + of the period from which the lineage is being reported. type: string + links: description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. - processes: + Optional. List of source-target pairs. Can't contain more than 100 + tuples. type: array - description: The processes from the specified project and location. items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' - id: GoogleCloudDatacatalogLineageV1ListProcessesResponse - description: Response message for ListProcesses. - type: object - GoogleCloudDatacatalogLineageV1OperationMetadata: - description: Metadata describing the operation. - properties: - resourceUuid: - readOnly: true + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EventLink' + name: type: string - description: Output only. The UUID of the resource being operated on. - resource: description: >- - Output only. The [relative name] - (https://cloud.google.com//apis/design/resource_names#relative_resource_name) - of the resource being operated on. - readOnly: true - type: string + Immutable. The resource name of the lineage event. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + Can be specified or auto-assigned. {lineage_event} must be not + longer than 200 characters and only contain characters in a set: + `a-zA-Z0-9_-:.` endTime: - type: string - format: google-datetime - readOnly: true - description: >- - Output only. The timestamp of the operation termination, regardless - of its success. This field is unset if the operation is still - ongoing. - state: - type: string - readOnly: true - enumDescriptions: - - Unused. - - The operation has been created but is not yet started. - - The operation is underway. - - The operation completed successfully. - - The operation is no longer running and did not succeed. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - description: Output only. The current operation state. - createTime: - readOnly: true format: google-datetime description: >- - Output only. The timestamp of the operation submission to the - server. - type: string - operationType: - description: Output only. The type of the operation being performed. + Optional. The end of the transformation which resulted in this + lineage event. For streaming scenarios, it should be the end of the + period from which the lineage is being reported. type: string - enum: - - TYPE_UNSPECIFIED - - DELETE - - CREATE - enumDescriptions: - - Unused. - - The resource deletion operation. - - The resource creation operation. - readOnly: true + id: GoogleCloudDatacatalogLineageV1LineageEvent type: object - id: GoogleCloudDatacatalogLineageV1OperationMetadata - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse + GoogleCloudDatacatalogLineageV1EventLink: + description: A lineage between source and target entities. + id: GoogleCloudDatacatalogLineageV1EventLink type: object - description: The response message for Operations.ListOperations. + properties: + source: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + description: Required. Reference to the source entity + target: + description: Required. Reference to the target entity + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' + GoogleLongrunningCancelOperationRequest: + type: object + description: The request message for Operations.CancelOperation. + properties: {} + id: GoogleLongrunningCancelOperationRequest + GoogleCloudDatacatalogLineageV1ListRunsResponse: + description: Response message for ListRuns. properties: nextPageToken: - description: The standard List next-page token. - type: string - operations: description: >- - A list of operations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. + type: string + runs: type: array - GoogleCloudDatacatalogLineageV1SearchLinksResponse: - description: Response message for SearchLinks. + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' + description: The runs from the specified project and location. + id: GoogleCloudDatacatalogLineageV1ListRunsResponse type: object - id: GoogleCloudDatacatalogLineageV1SearchLinksResponse + GoogleCloudDatacatalogLineageV1ListProcessesResponse: properties: - links: - description: >- - The list of links for a given asset. Can be empty if the asset has - no relations of requested type (source or target). - items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' + processes: + description: The processes from the specified project and location. type: array + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' nextPageToken: description: >- - The token to specify as `page_token` in the subsequent call to get - the next page. Omitted if there are no more pages in the response. + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. type: string - GoogleLongrunningOperation: + description: Response message for ListProcesses. + id: GoogleCloudDatacatalogLineageV1ListProcessesResponse type: object - id: GoogleLongrunningOperation + GoogleCloudDatacatalogLineageV1Process: properties: name: type: string description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - metadata: + Immutable. The resource name of the lineage process. Format: + `projects/{project}/locations/{location}/processes/{process}`. Can + be specified or auto-assigned. {process} must be not longer than 200 + characters and only contain characters in a set: `a-zA-Z0-9_-:.` + displayName: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - error: - $ref: '#/components/schemas/GoogleRpcStatus' + Optional. A human-readable name you can set to display in a user + interface. Must be not longer than 200 characters and only contain + UTF-8 letters or numbers, spaces or characters like `_-:&.` + type: string + origin: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Origin' description: >- - The error result of the operation in case of failure or - cancellation. - response: + Optional. The origin of this process and its runs and lineage + events. + attributes: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. + Optional. The attributes of the process. Should only be used for the + purpose of non-semantic management (classifying, describing or + labeling the process). Up to 100 attributes are allowed. + type: object additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any - type: object - done: - type: boolean + description: A process is the definition of a data transformation operation. + type: object + id: GoogleCloudDatacatalogLineageV1Process + GoogleCloudDatacatalogLineageV1ProcessLinkInfo: + id: GoogleCloudDatacatalogLineageV1ProcessLinkInfo + description: Link details. + properties: + startTime: + type: string + format: google-datetime + description: The start of the first event establishing this link-process tuple. + link: + type: string description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - GoogleCloudDatacatalogLineageV1ListRunsResponse: - description: Response message for ListRuns. + The name of the link in the format of + `projects/{project}/locations/{location}/links/{link}`. + endTime: + type: string + description: The end of the last event establishing this link-process tuple. + format: google-datetime + type: object + GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse: + id: GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + type: object properties: - nextPageToken: + process: description: >- - The token to specify as `page_token` in the next call to get the - next page. If this field is omitted, there are no subsequent pages. + Created process name. Format: + `projects/{project}/locations/{location}/processes/{process}`. type: string - runs: + lineageEvents: items: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Run' - description: The runs from the specified project and location. + type: string type: array + description: >- + Created lineage event names. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. + run: + type: string + description: >- + Created run name. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. + description: Response message for ProcessOpenLineageRunEvent. + GoogleCloudDatacatalogLineageV1ListLineageEventsResponse: type: object - id: GoogleCloudDatacatalogLineageV1ListRunsResponse - GoogleCloudDatacatalogLineageV1Link: - type: object + id: GoogleCloudDatacatalogLineageV1ListLineageEventsResponse + properties: + lineageEvents: + type: array + description: Lineage events from the specified project and location. + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1LineageEvent' + nextPageToken: + type: string + description: >- + The token to specify as `page_token` in the next call to get the + next page. If this field is omitted, there are no subsequent pages. + description: Response message for ListLineageEvents. + GoogleCloudDatacatalogLineageV1Run: + id: GoogleCloudDatacatalogLineageV1Run description: >- - Links represent the data flow between **source** (upstream) and - **target** (downstream) assets in transformation pipelines. Links are - created when LineageEvents record data transformation between related - assets. + A lineage run represents an execution of a process that creates lineage + events. properties: - source: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: The pointer to the entity that is the **source** of this link. - target: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1EntityReference' - description: The pointer to the entity that is the **target** of this link. + attributes: + additionalProperties: + type: any + description: >- + Optional. The attributes of the run. Should only be used for the + purpose of non-semantic management (classifying, describing or + labeling the run). Up to 100 attributes are allowed. + type: object startTime: type: string - description: The start of the first event establishing this link. + description: Required. The timestamp of the start of the run. + format: google-datetime + endTime: + type: string + description: Optional. The timestamp of the end of the run. format: google-datetime name: type: string description: >- - Output only. Immutable. The name of the link. Format: - `projects/{project}/locations/{location}/links/{link}`. - readOnly: true - endTime: + Immutable. The resource name of the run. Format: + `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. + Can be specified or auto-assigned. {run} must be not longer than 200 + characters and only contain characters in a set: `a-zA-Z0-9_-:.` + state: + description: Required. The state of the run. + enum: + - UNKNOWN + - STARTED + - COMPLETED + - FAILED + - ABORTED + enumDescriptions: + - >- + The state is unknown. The true state may be any of the below or a + different state that is not supported here explicitly. + - The run is still executing. + - The run completed. + - The run failed. + - The run aborted. type: string - format: google-datetime - description: The end of the last event establishing this link. - id: GoogleCloudDatacatalogLineageV1Link - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest: + displayName: + type: string + description: >- + Optional. A human-readable name you can set to display in a user + interface. Must be not longer than 1024 characters and only contain + UTF-8 letters or numbers, spaces or characters like `_-:&.` type: object + GoogleCloudDatacatalogLineageV1OperationMetadata: + description: Metadata describing the operation. properties: - links: - type: array + endTime: + readOnly: true description: >- - Required. An array of links to check for their associated - LineageProcesses. The maximum number of items in this array is 100. - If the request contains more than 100 links, it returns the - `INVALID_ARGUMENT` error. Format: - `projects/{project}/locations/{location}/links/{link}`. - items: - type: string - pageSize: - format: int32 + Output only. The timestamp of the operation termination, regardless + of its success. This field is unset if the operation is still + ongoing. + format: google-datetime + type: string + resource: description: >- - The maximum number of processes to return in a single page of the - response. A page may contain fewer results than this value. - type: integer - pageToken: + Output only. The [relative name] + (https://cloud.google.com//apis/design/resource_names#relative_resource_name) + of the resource being operated on. + readOnly: true + type: string + operationType: + description: Output only. The type of the operation being performed. + type: string + enumDescriptions: + - Unused. + - The resource deletion operation. + - The resource creation operation. + readOnly: true + enum: + - TYPE_UNSPECIFIED + - DELETE + - CREATE + createTime: + type: string + readOnly: true description: >- - The page token received from a previous `BatchSearchLinkProcesses` - call. Use it to get the next page. When requesting subsequent pages - of a response, remember that all parameters must match the values - you provided in the original request. + Output only. The timestamp of the operation submission to the + server. + format: google-datetime + resourceUuid: + readOnly: true + description: Output only. The UUID of the resource being operated on. type: string - description: Request message for BatchSearchLinkProcesses. - id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest - GoogleCloudDatacatalogLineageV1Run: - properties: state: + description: Output only. The current operation state. + enumDescriptions: + - Unused. + - The operation has been created but is not yet started. + - The operation is underway. + - The operation completed successfully. + - The operation is no longer running and did not succeed. + type: string enum: - - UNKNOWN - - STARTED - - COMPLETED + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED - FAILED - - ABORTED - description: Required. The state of the run. - type: string - enumDescriptions: - - >- - The state is unknown. The true state may be any of the below or a - different state that is not supported here explicitly. - - The run is still executing. - - The run completed. - - The run failed. - - The run aborted. - attributes: + readOnly: true + type: object + id: GoogleCloudDatacatalogLineageV1OperationMetadata + GoogleCloudDatacatalogLineageV1SearchLinksResponse: + type: object + properties: + links: description: >- - Optional. The attributes of the run. Should only be used for the - purpose of non-semantic management (classifying, describing or - labeling the run). Up to 100 attributes are allowed. - type: object - additionalProperties: - type: any - endTime: + The list of links for a given asset. Can be empty if the asset has + no relations of requested type (source or target). + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Link' + type: array + nextPageToken: type: string - format: google-datetime - description: Optional. The timestamp of the end of the run. - name: description: >- - Immutable. The resource name of the run. Format: - `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. - Can be specified or auto-assigned. {run} must be not longer than 200 - characters and only contain characters in a set: `a-zA-Z0-9_-:.` - type: string - startTime: - description: Required. The timestamp of the start of the run. + The token to specify as `page_token` in the subsequent call to get + the next page. Omitted if there are no more pages in the response. + id: GoogleCloudDatacatalogLineageV1SearchLinksResponse + description: Response message for SearchLinks. + GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse: + description: Response message for BatchSearchLinkProcesses. + properties: + processLinks: + items: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1ProcessLinks' + type: array + description: An array of processes associated with the specified links. + nextPageToken: type: string - format: google-datetime - displayName: description: >- - Optional. A human-readable name you can set to display in a user - interface. Must be not longer than 1024 characters and only contain - UTF-8 letters or numbers, spaces or characters like `_-:&.` - type: string - id: GoogleCloudDatacatalogLineageV1Run - description: >- - A lineage run represents an execution of a process that creates lineage - events. + The token to specify as `page_token` in the subsequent call to get + the next page. Omitted if there are no more pages in the response. + id: GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse type: object parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType schema: type: string alt: @@ -638,10 +634,16 @@ components: - json - media - proto - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string quotaUser: @@ -653,24 +655,33 @@ components: name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + name: prettyPrint + schema: + type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: uploadType + name: $.xgafv schema: type: string + enum: + - '1' + - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -680,32 +691,23 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' x-stackQL-resources: locations: id: google.datalineage.locations name: locations title: Locations methods: - process_open_lineage_run_event: + batch_search_link_processes: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post response: mediaType: application/json openAPIDocKey: '200' - batch_search_link_processes: + process_open_lineage_run_event: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:batchSearchLinkProcesses/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:processOpenLineageRunEvent/post response: mediaType: application/json openAPIDocKey: '200' @@ -720,48 +722,46 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] processes: id: google.datalineage.processes name: processes title: Processes methods: - _list: - operation: &ref_1 + patch: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get - response: &ref_2 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processes - list: - operation: *ref_1 - response: *ref_2 - create: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/get response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/get response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.processes + create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes/post response: mediaType: application/json openAPIDocKey: '200' @@ -773,6 +773,7 @@ components: - $ref: '#/components/x-stackQL-resources/processes/methods/create' update: - $ref: '#/components/x-stackQL-resources/processes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/processes/methods/delete' runs: @@ -808,17 +809,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.runs - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/runs/methods/get' @@ -827,6 +825,7 @@ components: - $ref: '#/components/x-stackQL-resources/runs/methods/create' update: - $ref: '#/components/x-stackQL-resources/runs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/runs/methods/delete' lineage_events: @@ -855,17 +854,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processes~1{processesId}~1runs~1{runsId}~1lineageEvents/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.lineageEvents - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/lineage_events/methods/get' @@ -873,6 +869,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/lineage_events/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/lineage_events/methods/delete' operations: @@ -880,67 +877,76 @@ components: name: operations title: Operations methods: - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + cancel: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations list: - operation: *ref_7 - response: *ref_8 - cancel: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: - /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: - parameters: &ref_9 - - $ref: '#/components/parameters/prettyPrint' + /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: + parameters: &ref_1 - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' post: description: >- - Creates new lineage events together with their parents: process and run. - Updates the process and run if they already exist. Mapped from Open - Lineage specification: - https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. - operationId: datalineage.projects.locations.processOpenLineageRunEvent + Retrieve information about LineageProcesses associated with specific + links. LineageProcesses are transformation pipelines that result in data + flowing from **source** to **target** assets. Links between assets + represent this operation. If you have specific link names, you can use + this method to verify which LineageProcesses contribute to creating + those links. See the SearchLinks method for more information on how to + retrieve link name. You can retrieve the LineageProcess information in + every project where you have the `datalineage.events.get` permission. + The project provided in the URL is used for Billing and Quota. + operationId: datalineage.projects.locations.batchSearchLinkProcesses + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -953,7 +959,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse + #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse parameters: - in: path name: projectsId @@ -965,30 +971,15 @@ paths: required: true schema: type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses: - parameters: *ref_9 + /v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent: + parameters: *ref_1 post: description: >- - Retrieve information about LineageProcesses associated with specific - links. LineageProcesses are transformation pipelines that result in data - flowing from **source** to **target** assets. Links between assets - represent this operation. If you have specific link names, you can use - this method to verify which LineageProcesses contribute to creating - those links. See the SearchLinks method for more information on how to - retrieve link name. You can retrieve the LineageProcess information in - every project where you have the `datalineage.events.get` permission. - The project provided in the URL is used for Billing and Quota. - operationId: datalineage.projects.locations.batchSearchLinkProcesses - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest + Creates new lineage events together with their parents: process and run. + Updates the process and run if they already exist. Mapped from Open + Lineage specification: + https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. + operationId: datalineage.projects.locations.processOpenLineageRunEvent security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1001,7 +992,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse + #/components/schemas/GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse parameters: - in: path name: projectsId @@ -1013,8 +1004,12 @@ paths: required: true schema: type: string + - in: query + name: requestId + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}:searchLinks: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Retrieve a list of links connected to a specific asset. Links represent @@ -1054,13 +1049,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes: - parameters: *ref_9 - get: - description: >- - List processes in the given project and location. List order is - descending by insertion time. - operationId: datalineage.projects.locations.processes.list + /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: + parameters: *ref_1 + patch: + description: Updates a process. + operationId: datalineage.projects.locations.processes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1072,8 +1070,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1085,23 +1082,23 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: processesId + required: true schema: type: string - in: query - name: pageSize + name: allowMissing schema: - type: integer - format: int32 - post: - description: Creates a new process. - operationId: datalineage.projects.locations.processes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the process with the specified name. + operationId: datalineage.projects.locations.processes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1113,7 +1110,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1125,15 +1122,18 @@ paths: required: true schema: type: string - - in: query - name: requestId + - in: path + name: processesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}: - parameters: *ref_9 - delete: - description: Deletes the process with the specified name. - operationId: datalineage.projects.locations.processes.delete + - in: query + name: allowMissing + schema: + type: boolean + get: + description: Gets the details of the specified process. + operationId: datalineage.projects.locations.processes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1145,7 +1145,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' parameters: - in: path name: projectsId @@ -1162,18 +1162,13 @@ paths: required: true schema: type: string - - in: query - name: allowMissing - schema: - type: boolean - patch: - description: Updates a process. - operationId: datalineage.projects.locations.processes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + /v1/projects/{projectsId}/locations/{locationsId}/processes: + parameters: *ref_1 + get: + description: >- + List processes in the given project and location. List order is + descending by insertion time. + operationId: datalineage.projects.locations.processes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1185,7 +1180,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' + $ref: >- + #/components/schemas/GoogleCloudDatacatalogLineageV1ListProcessesResponse parameters: - in: path name: projectsId @@ -1197,23 +1193,23 @@ paths: required: true schema: type: string - - in: path - name: processesId - required: true - schema: - type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask + type: integer + format: int32 - in: query - name: allowMissing + name: pageToken schema: - type: boolean - get: - description: Gets the details of the specified process. - operationId: datalineage.projects.locations.processes.get + type: string + post: + description: Creates a new process. + operationId: datalineage.projects.locations.processes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatacatalogLineageV1Process' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1237,13 +1233,12 @@ paths: required: true schema: type: string - - in: path - name: processesId - required: true + - in: query + name: requestId schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}: - parameters: *ref_9 + parameters: *ref_1 delete: description: Deletes the run with the specified name. operationId: datalineage.projects.locations.processes.runs.delete @@ -1371,7 +1366,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs: - parameters: *ref_9 + parameters: *ref_1 post: description: Creates a new run. operationId: datalineage.projects.locations.processes.runs.create @@ -1456,7 +1451,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a specified lineage event. operationId: datalineage.projects.locations.processes.runs.lineageEvents.get @@ -1545,7 +1540,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents: - parameters: *ref_9 + parameters: *ref_1 post: description: Creates a new lineage event. operationId: datalineage.projects.locations.processes.runs.lineageEvents.create @@ -1641,14 +1636,13 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 - delete: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: datalineage.projects.locations.operations.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: datalineage.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1660,7 +1654,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -1677,12 +1671,13 @@ paths: required: true schema: type: string - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: datalineage.projects.locations.operations.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: datalineage.projects.locations.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1694,7 +1689,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1711,13 +1706,25 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 - get: + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: datalineage.projects.locations.operations.list + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: datalineage.projects.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1729,7 +1736,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1741,38 +1748,18 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: operationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_9 - post: + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: datalineage.projects.locations.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: datalineage.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1784,7 +1771,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -1796,8 +1783,16 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml index 67f61566..c6a24857 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datamigration.yaml @@ -7,8 +7,8 @@ info: title: Database Migration API description: Manage Cloud Database Migration Service resources on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240522' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240907' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/database-migration/ servers: @@ -457,7 +457,9 @@ components: description: The database provider. type: string enumDescriptions: - - Use this value for on-premise source database instances. + - >- + Use this value for on-premise source database instances and + ORACLE. - Cloud SQL is the source instance provider. - Amazon RDS is the source instance provider. - Amazon Aurora is the source instance provider. @@ -539,6 +541,9 @@ components: useDiffBackup: description: Optional. Enable differential backups. type: boolean + promoteWhenReady: + description: Optional. Promote databases when ready. + type: boolean SqlServerDatabaseBackup: id: SqlServerDatabaseBackup description: >- @@ -818,7 +823,9 @@ components: description: The database provider. type: string enumDescriptions: - - Use this value for on-premise source database instances. + - >- + Use this value for on-premise source database instances and + ORACLE. - Cloud SQL is the source instance provider. - Amazon RDS is the source instance provider. - Amazon Aurora is the source instance provider. @@ -1148,11 +1155,44 @@ components: privateConnectivity: description: Private connectivity. $ref: '#/components/schemas/PrivateConnectivity' + oracleAsmConfig: + description: Optional. Configuration for Oracle ASM connection. + $ref: '#/components/schemas/OracleAsmConfig' StaticServiceIpConnectivity: id: StaticServiceIpConnectivity description: Static IP address connectivity configured on service project. type: object properties: {} + OracleAsmConfig: + id: OracleAsmConfig + description: Configuration for Oracle Automatic Storage Management (ASM) connection. + type: object + properties: + hostname: + description: Required. Hostname for the Oracle ASM connection. + type: string + port: + description: Required. Port for the Oracle ASM connection. + type: integer + format: int32 + username: + description: Required. Username for the Oracle ASM connection. + type: string + password: + description: Required. Input only. Password for the Oracle ASM connection. + type: string + passwordSet: + description: >- + Output only. Indicates whether a new password is included in the + request. + readOnly: true + type: boolean + asmService: + description: Required. ASM service name for the Oracle ASM connection. + type: string + ssl: + description: Optional. SSL configuration for the Oracle connection. + $ref: '#/components/schemas/SslConfig' CloudSqlConnectionProfile: id: CloudSqlConnectionProfile description: >- @@ -1232,6 +1272,10 @@ components: - >- The database major version is MySQL 8.0 and the minor version is 36. + - >- + The database major version is MySQL 8.0 and the minor version is + 37. + - MySQL 8.4. - PostgreSQL 9.6. - PostgreSQL 11. - PostgreSQL 10. @@ -1256,6 +1300,8 @@ components: - MYSQL_8_0_34 - MYSQL_8_0_35 - MYSQL_8_0_36 + - MYSQL_8_0_37 + - MYSQL_8_4 - POSTGRES_9_6 - POSTGRES_11 - POSTGRES_10 @@ -1544,10 +1590,12 @@ components: - This is an unknown database version. - The database version is Postgres 14. - The database version is Postgres 15. + - The database version is Postgres 16. enum: - DATABASE_VERSION_UNSPECIFIED - POSTGRES_14 - POSTGRES_15 + - POSTGRES_16 UserPassword: id: UserPassword description: >- @@ -4317,25 +4365,25 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/static_ips/methods/fetch_static_ips insert: [] update: [] + replace: [] delete: [] locations: id: google.datamigration.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -4348,23 +4396,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.datamigration.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -4392,6 +4438,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' migration_jobs: @@ -4399,17 +4446,14 @@ components: name: migration_jobs title: Migration_jobs methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.migrationJobs - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -4509,6 +4553,7 @@ components: - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/create' update: - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/migration_jobs/methods/delete' migration_jobs_iam_policies: @@ -4523,17 +4568,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -4547,23 +4589,60 @@ components: #/components/x-stackQL-resources/migration_jobs_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/migration_jobs_iam_policies/methods/set_iam_policy + delete: [] + objects_iam_policies: + id: google.datamigration.objects_iam_policies + name: objects_iam_policies + title: Objects_iam_policies + methods: + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}~1objects~1{objectsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}~1objects~1{objectsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1migrationJobs~1{migrationJobsId}~1objects~1{objectsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/objects_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/objects_iam_policies/methods/set_iam_policy delete: [] connection_profiles: id: google.datamigration.connection_profiles name: connection_profiles title: Connection_profiles methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectionProfiles/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.connectionProfiles - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -4601,6 +4680,7 @@ components: #/components/x-stackQL-resources/connection_profiles/methods/create update: - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/connection_profiles/methods/delete @@ -4616,17 +4696,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectionProfiles~1{connectionProfilesId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -4640,6 +4717,9 @@ components: #/components/x-stackQL-resources/connection_profiles_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/connection_profiles_iam_policies/methods/set_iam_policy delete: [] private_connections: id: google.datamigration.private_connections @@ -4653,17 +4733,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateConnections/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.privateConnections - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -4686,6 +4763,7 @@ components: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/delete @@ -4701,17 +4779,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_15 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateConnections~1{privateConnectionsId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_15 - response: *ref_16 test_iam_permissions: operation: $ref: >- @@ -4725,6 +4800,9 @@ components: #/components/x-stackQL-resources/private_connections_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/private_connections_iam_policies/methods/set_iam_policy delete: [] conversion_workspaces: id: google.datamigration.conversion_workspaces @@ -4752,17 +4830,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversionWorkspaces/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.conversionWorkspaces - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: >- @@ -4837,6 +4912,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/conversion_workspaces/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/conversion_workspaces/methods/delete @@ -4852,17 +4928,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversionWorkspaces~1{conversionWorkspacesId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 test_iam_permissions: operation: $ref: >- @@ -4876,6 +4949,9 @@ components: #/components/x-stackQL-resources/conversion_workspaces_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/conversion_workspaces_iam_policies/methods/set_iam_policy delete: [] mapping_rules: id: google.datamigration.mapping_rules @@ -4889,17 +4965,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1conversionWorkspaces~1{conversionWorkspacesId}~1mappingRules/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.mappingRules - list: - operation: *ref_21 - response: *ref_22 delete: operation: $ref: >- @@ -4928,11 +5001,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/mapping_rules/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/mapping_rules/methods/delete' paths: /v1/projects/{projectsId}/locations/{locationsId}:fetchStaticIps: - parameters: &ref_23 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4982,7 +5056,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: datamigration.projects.locations.list @@ -5018,7 +5092,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets information about a location. operationId: datamigration.projects.locations.get @@ -5046,7 +5120,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -5089,7 +5163,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5160,7 +5234,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5207,7 +5281,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists migration jobs in a given project and location. operationId: datamigration.projects.locations.migrationJobs.list @@ -5291,7 +5365,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets details of a single migration job. operationId: datamigration.projects.locations.migrationJobs.get @@ -5408,7 +5482,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:start: - parameters: *ref_23 + parameters: *ref_1 post: description: Start an already created migration job. operationId: datamigration.projects.locations.migrationJobs.start @@ -5446,7 +5520,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:stop: - parameters: *ref_23 + parameters: *ref_1 post: description: Stops a running migration job. operationId: datamigration.projects.locations.migrationJobs.stop @@ -5484,7 +5558,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:resume: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Resume a migration job that is currently stopped and is resumable (was @@ -5524,7 +5598,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:promote: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Promote a migration job, stopping replication to the destination and @@ -5564,7 +5638,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:demoteDestination: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Demotes the destination database to become a read replica of the source. @@ -5606,7 +5680,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:verify: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Verify a migration job, making sure the destination can reach the source @@ -5646,7 +5720,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:restart: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Restart a stopped or failed migration job, resetting the destination @@ -5687,7 +5761,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:generateSshScript: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Generate a SSH configuration script to configure the reverse SSH @@ -5727,7 +5801,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:generateTcpProxyScript: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Generate a TCP Proxy configuration script to configure a cloud-hosted VM @@ -5767,7 +5841,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5808,7 +5882,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5848,7 +5922,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5890,8 +5964,148 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: datamigration.projects.locations.migrationJobs.objects.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migrationJobsId + required: true + schema: + type: string + - in: path + name: objectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: datamigration.projects.locations.migrationJobs.objects.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migrationJobsId + required: true + schema: + type: string + - in: path + name: objectsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: >- + datamigration.projects.locations.migrationJobs.objects.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: migrationJobsId + required: true + schema: + type: string + - in: path + name: objectsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Retrieves a list of all connection profiles in a given project and @@ -5985,7 +6199,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets details of a single connection profile. operationId: datamigration.projects.locations.connectionProfiles.get @@ -6113,7 +6327,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6154,7 +6368,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6194,7 +6408,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6237,7 +6451,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates a new private connection in a given project and location. operationId: datamigration.projects.locations.privateConnections.create @@ -6325,7 +6539,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets details of a single private connection. operationId: datamigration.projects.locations.privateConnections.get @@ -6393,7 +6607,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6434,7 +6648,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6474,7 +6688,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6517,7 +6731,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets details of a single conversion workspace. operationId: datamigration.projects.locations.conversionWorkspaces.get @@ -6634,7 +6848,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists conversion workspaces in a given project and location. operationId: datamigration.projects.locations.conversionWorkspaces.list @@ -6714,7 +6928,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:seed: - parameters: *ref_23 + parameters: *ref_1 post: description: Imports a snapshot of the source database into the conversion workspace. operationId: datamigration.projects.locations.conversionWorkspaces.seed @@ -6752,7 +6966,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:convert: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates a draft tree schema for the destination database. operationId: datamigration.projects.locations.conversionWorkspaces.convert @@ -6790,7 +7004,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:commit: - parameters: *ref_23 + parameters: *ref_1 post: description: Marks all the data in the conversion workspace as committed. operationId: datamigration.projects.locations.conversionWorkspaces.commit @@ -6828,7 +7042,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:rollback: - parameters: *ref_23 + parameters: *ref_1 post: description: Rolls back a conversion workspace to the last committed snapshot. operationId: datamigration.projects.locations.conversionWorkspaces.rollback @@ -6866,7 +7080,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:apply: - parameters: *ref_23 + parameters: *ref_1 post: description: Applies draft tree onto a specific destination database. operationId: datamigration.projects.locations.conversionWorkspaces.apply @@ -6904,7 +7118,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeDatabaseEntities: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Describes the database entities tree for a specific conversion workspace @@ -6972,7 +7186,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:searchBackgroundJobs: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Searches/lists the background jobs for a specific conversion workspace. @@ -7024,7 +7238,7 @@ paths: type: string format: google-datetime /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:describeConversionWorkspaceRevisions: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Retrieves a list of committed revisions of a specific conversion @@ -7065,7 +7279,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7106,7 +7320,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7146,7 +7360,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7189,7 +7403,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates a new mapping rule for a given conversion workspace. operationId: >- @@ -7276,7 +7490,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules/{mappingRulesId}: - parameters: *ref_23 + parameters: *ref_1 delete: description: Deletes a single mapping rule. operationId: >- @@ -7355,7 +7569,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/conversionWorkspaces/{conversionWorkspacesId}/mappingRules:import: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Imports the mapping rules for a given conversion workspace. Supports diff --git a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml index 84a0f7f3..e6f8227f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datapipelines.yaml @@ -9,8 +9,8 @@ info: Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240901' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dataflow/docs/guides/data-pipelines servers: @@ -36,35 +36,168 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: + GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: + type: object + id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + properties: + kmsKeyName: + type: string + description: >- + Name for the Cloud KMS key for the job. Key format is: + projects//locations//keyRings//cryptoKeys/ + network: + description: >- + Network to which VMs will be assigned. If empty or unspecified, the + service will use the network "default". + type: string + machineType: + description: >- + The machine type to use for the job. Defaults to the value from the + template if not specified. + type: string + ipConfiguration: + enumDescriptions: + - The configuration is unknown, or unspecified. + - Workers should have public IP addresses. + - Workers should have private IP addresses. + enum: + - WORKER_IP_UNSPECIFIED + - WORKER_IP_PUBLIC + - WORKER_IP_PRIVATE + type: string + description: Configuration for VM IPs. + subnetwork: + type: string + description: >- + Subnetwork to which VMs will be assigned, if desired. You can + specify a subnetwork using either a complete URL or an abbreviated + path. Expected to be of the form + "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" + or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is + located in a Shared VPC network, you must use the complete URL. + tempLocation: + type: string + description: >- + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. + numWorkers: + format: int32 + type: integer + description: The initial number of Compute Engine instances for the job. + workerZone: + type: string + description: >- + The Compute Engine zone + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1-a". Mutually + exclusive with worker_region. If neither worker_region nor + worker_zone is specified, a zone in the control plane region is + chosen based on available capacity. If both `worker_zone` and `zone` + are set, `worker_zone` takes precedence. + additionalUserLabels: + description: >- + Additional user labels to be specified for the job. Keys and values + must follow the restrictions specified in the [labeling + restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). + An object containing a list of key/value pairs. Example: `{ "name": + "wrench", "mass": "1kg", "count": "3" }`. + type: object + additionalProperties: + type: string + flexrsGoal: + type: string + enumDescriptions: + - Run in the default mode. + - Optimize for lower execution time. + - Optimize for lower cost. + enum: + - FLEXRS_UNSPECIFIED + - FLEXRS_SPEED_OPTIMIZED + - FLEXRS_COST_OPTIMIZED + description: >- + Set FlexRS goal for the job. + https://cloud.google.com/dataflow/docs/guides/flexrs + additionalExperiments: + items: + type: string + type: array + description: Additional experiment flags for the job. + serviceAccountEmail: + type: string + description: The email address of the service account to run the job as. + maxWorkers: + format: int32 + type: integer + description: >- + The maximum number of Compute Engine instances to be made available + to your pipeline during execution, from 1 to 1000. + workerRegion: + type: string + description: >- + The Compute Engine region + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1". Mutually + exclusive with worker_zone. If neither worker_region nor worker_zone + is specified, defaults to the control plane region. + enableStreamingEngine: + type: boolean + description: Whether to enable Streaming Engine for the job. + zone: + description: >- + The Compute Engine [availability + zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) + for launching worker instances to run your pipeline. In the future, + worker_zone will take precedence. + type: string + description: The environment values to be set at runtime for a Flex Template. GoogleCloudDatapipelinesV1RunPipelineRequest: - description: Request message for RunPipeline + properties: {} id: GoogleCloudDatapipelinesV1RunPipelineRequest + description: Request message for RunPipeline type: object - properties: {} - GoogleCloudDatapipelinesV1Job: + GoogleCloudDatapipelinesV1ScheduleSpec: type: object - id: GoogleCloudDatapipelinesV1Job + description: Details of the schedule the pipeline runs on. + id: GoogleCloudDatapipelinesV1ScheduleSpec properties: - name: - type: string - description: Required. The fully qualified resource name for the job. - endTime: - type: string - format: google-datetime + timeZone: description: >- - Output only. The time of job termination. This is absent if the job - is still running. - readOnly: true - id: + Timezone ID. This matches the timezone IDs used by the Cloud + Scheduler API. If empty, UTC time is assumed. type: string + nextJobTime: + description: Output only. When the next Scheduler job is going to run. readOnly: true - description: Output only. The internal ID for the job. + format: google-datetime + type: string + schedule: + type: string + description: >- + Unix-cron format of the schedule. This information is retrieved from + the linked Cloud Scheduler. + GoogleCloudDatapipelinesV1Job: + id: GoogleCloudDatapipelinesV1Job + type: object + description: >- + Definition of the job information maintained by the pipeline. Fields in + this entity are retrieved from the executor API (e.g. Dataflow API). + properties: status: $ref: '#/components/schemas/GoogleRpcStatus' description: >- Status capturing any error code or message related to job creation or execution. + dataflowJobDetails: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' + description: All the details that are specific to a Dataflow job. state: + enum: + - STATE_UNSPECIFIED + - STATE_PENDING + - STATE_RUNNING + - STATE_DONE + - STATE_FAILED + - STATE_CANCELLED enumDescriptions: - The job state isn't specified. - The job is waiting to start execution. @@ -72,51 +205,128 @@ components: - The job has finished execution successfully. - The job has finished execution with a failure. - The job has been terminated upon user request. - type: string description: The current state of the job. - enum: - - STATE_UNSPECIFIED - - STATE_PENDING - - STATE_RUNNING - - STATE_DONE - - STATE_FAILED - - STATE_CANCELLED + type: string + endTime: + format: google-datetime + type: string + readOnly: true + description: >- + Output only. The time of job termination. This is absent if the job + is still running. + name: + type: string + description: Required. The fully qualified resource name for the job. + id: + description: Output only. The internal ID for the job. + readOnly: true + type: string createTime: readOnly: true type: string format: google-datetime description: Output only. The time of job creation. - dataflowJobDetails: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1DataflowJobDetails' - description: All the details that are specific to a Dataflow job. - description: >- - Definition of the job information maintained by the pipeline. Fields in - this entity are retrieved from the executor API (e.g. Dataflow API). + GoogleCloudDatapipelinesV1LaunchTemplateRequest: + id: GoogleCloudDatapipelinesV1LaunchTemplateRequest + properties: + gcsPath: + description: >- + A Cloud Storage path to the template from which to create the job. + Must be a valid Cloud Storage URL, beginning with 'gs://'. + type: string + validateOnly: + type: boolean + description: >- + If true, the request is validated but not actually executed. + Defaults to false. + location: + type: string + description: >- + The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. + projectId: + type: string + description: >- + Required. The ID of the Cloud Platform project that the job belongs + to. + launchParameters: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters + description: >- + The parameters of the template to launch. This should be part of the + body of the POST request. + type: object + description: A request to launch a template. GoogleCloudDatapipelinesV1RunPipelineResponse: + description: Response message for RunPipeline + type: object properties: job: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' description: Job that was created as part of RunPipeline operation. - description: Response message for RunPipeline + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' id: GoogleCloudDatapipelinesV1RunPipelineResponse + GoogleCloudDatapipelinesV1ListJobsResponse: + properties: + nextPageToken: + type: string + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + jobs: + description: >- + Results that were accessible to the caller. Results are always in + descending order of job creation date. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + id: GoogleCloudDatapipelinesV1ListJobsResponse + description: Response message for ListJobs type: object - GoogleCloudDatapipelinesV1LaunchTemplateParameters: - description: Parameters to provide to the template being launched. + GoogleRpcStatus: type: object + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus properties: - jobName: + message: type: string - description: Required. The job name to use for the created job. + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + details: + type: array + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + GoogleCloudDatapipelinesV1StopPipelineRequest: + id: GoogleCloudDatapipelinesV1StopPipelineRequest + properties: {} + type: object + description: Request message for StopPipeline. + GoogleCloudDatapipelinesV1LaunchTemplateParameters: + type: object + description: Parameters to provide to the template being launched. + id: GoogleCloudDatapipelinesV1LaunchTemplateParameters + properties: parameters: - additionalProperties: - type: string - type: object description: The runtime parameters to pass to the job. - transformNameMapping: - description: >- - Map of transform name prefixes of the job to be replaced to the - corresponding name prefixes of the new job. Only applicable when - updating a pipeline. type: object additionalProperties: type: string @@ -126,98 +336,149 @@ components: If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state. environment: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' description: The runtime environment for the job. - id: GoogleCloudDatapipelinesV1LaunchTemplateParameters - GoogleCloudDatapipelinesV1SdkVersion: - id: GoogleCloudDatapipelinesV1SdkVersion + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1RuntimeEnvironment' + transformNameMapping: + description: >- + Map of transform name prefixes of the job to be replaced to the + corresponding name prefixes of the new job. Only applicable when + updating a pipeline. + additionalProperties: + type: string + type: object + jobName: + description: Required. The job name to use for the created job. + type: string + GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: + description: A request to launch a Dataflow job from a Flex Template. + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest type: object properties: - versionDisplayName: - description: A readable string describing the version of the SDK. - type: string - version: - description: The version of the SDK used to run the job. + projectId: type: string - sdkSupportStatus: + description: >- + Required. The ID of the Cloud Platform project that the job belongs + to. + location: + description: >- + Required. The [regional endpoint] + (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) + to which to direct the request. For example, `us-central1`, + `us-west1`. type: string - description: The support status for this SDK version. - enum: - - UNKNOWN - - SUPPORTED - - STALE - - DEPRECATED - - UNSUPPORTED - enumDescriptions: - - Dataflow is unaware of this version. - - This is a known version of an SDK, and is supported. - - A newer version of the SDK exists, and an update is recommended. - - >- - This version of the SDK is deprecated and will eventually be - unsupported. - - >- - Support for this SDK version has ended and it should no longer be - used. - description: The version of the SDK used to run the job. - GoogleCloudDatapipelinesV1StopPipelineRequest: - id: GoogleCloudDatapipelinesV1StopPipelineRequest - description: Request message for StopPipeline. + launchParameter: + description: Required. Parameter to launch a job from a Flex Template. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter + validateOnly: + description: >- + If true, the request is validated but not actually executed. + Defaults to false. + type: boolean + GoogleProtobufEmpty: + type: object + id: GoogleProtobufEmpty properties: {} + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + GoogleCloudDatapipelinesV1ListPipelinesResponse: + id: GoogleCloudDatapipelinesV1ListPipelinesResponse + description: Response message for ListPipelines. type: object + properties: + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + pipelines: + items: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + description: >- + Results that matched the filter criteria and were accessible to the + caller. Results are always in descending order of pipeline creation + date. + type: array GoogleCloudDatapipelinesV1Pipeline: + id: GoogleCloudDatapipelinesV1Pipeline + type: object + description: >- + The main pipeline entity and all the necessary metadata for launching + and managing linked jobs. properties: + pipelineSources: + description: >- + Immutable. The sources of the pipeline (for example, Dataplex). The + keys and values are set by the corresponding sources during pipeline + creation. + additionalProperties: + type: string + type: object createTime: - format: google-datetime type: string description: >- Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. readOnly: true - schedulerServiceAccountEmail: + format: google-datetime + displayName: type: string description: >- - Optional. A service account email to be used with the Cloud - Scheduler job. If not specified, the default compute engine service - account will be used. - pipelineSources: - type: object - additionalProperties: - type: string + Required. The display name of the pipeline. It can contain only + letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores + (_). + lastUpdateTime: + readOnly: true + type: string + format: google-datetime description: >- - Immutable. The sources of the pipeline (for example, Dataplex). The - keys and values are set by the corresponding sources during pipeline - creation. + Output only. Immutable. The timestamp when the pipeline was last + modified. Set by the Data Pipelines service. jobCount: - type: integer description: Output only. Number of jobs. - format: int32 readOnly: true - name: + format: int32 + type: integer + workload: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' + description: Workload information for creating new jobs. + type: + enumDescriptions: + - The pipeline type isn't specified. + - >- + A batch pipeline. It runs jobs on a specific schedule, and each + job will automatically terminate once execution is finished. + - >- + A streaming pipeline. The underlying job is continuously running + until it is manually terminated by the user. This type of pipeline + doesn't have a schedule to run on, and the linked job gets created + when the pipeline is created. description: >- - The pipeline name. For example: - `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * - `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), - hyphens (-), colons (:), and periods (.). For more information, see - [Identifying - projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). - * `LOCATION_ID` is the canonical ID for the pipeline's location. The - list of available locations can be obtained by calling - `google.cloud.location.Locations.ListLocations`. Note that the Data - Pipelines service is not available in all regions. It depends on - Cloud Scheduler, an App Engine application, so it's only available - in [App Engine - regions](https://cloud.google.com/about/locations#region). * - `PIPELINE_ID` is the ID of the pipeline. Must be unique for the - selected project and location. + Required. The type of the pipeline. This field affects the + scheduling of the pipeline and the type of metrics to show for the + pipeline. + enum: + - PIPELINE_TYPE_UNSPECIFIED + - PIPELINE_TYPE_BATCH + - PIPELINE_TYPE_STREAMING + type: string + scheduleInfo: + description: >- + Internal scheduling information for a pipeline. If this information + is provided, periodic jobs will be created per the schedule. If not, + users are responsible for creating jobs externally. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' + schedulerServiceAccountEmail: + description: >- + Optional. A service account email to be used with the Cloud + Scheduler job. If not specified, the default compute engine service + account will be used. type: string state: type: string - description: >- - Required. The state of the pipeline. When the pipeline is created, - the state is set to 'PIPELINE_STATE_ACTIVE' by default. State - changes can be requested by setting the state to stopping, paused, - or resuming. State cannot be changed through UpdatePipeline - requests. enumDescriptions: - The pipeline state isn't specified. - >- @@ -236,6 +497,12 @@ components: resumed later. For a batch pipeline, this means pausing the scheduler job. For a streaming pipeline, creating a job snapshot to resume from will give the same effect. + description: >- + Required. The state of the pipeline. When the pipeline is created, + the state is set to 'PIPELINE_STATE_ACTIVE' by default. State + changes can be requested by setting the state to stopping, paused, + or resuming. State cannot be changed through UpdatePipeline + requests. enum: - STATE_UNSPECIFIED - STATE_RESUMING @@ -243,66 +510,57 @@ components: - STATE_STOPPING - STATE_ARCHIVED - STATE_PAUSED - workload: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Workload' - description: Workload information for creating new jobs. - scheduleInfo: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1ScheduleSpec' + name: description: >- - Internal scheduling information for a pipeline. If this information - is provided, periodic jobs will be created per the schedule. If not, - users are responsible for creating jobs externally. - lastUpdateTime: + The pipeline name. For example: + `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * + `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + hyphens (-), colons (:), and periods (.). For more information, see + [Identifying + projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). + * `LOCATION_ID` is the canonical ID for the pipeline's location. The + list of available locations can be obtained by calling + `google.cloud.location.Locations.ListLocations`. Note that the Data + Pipelines service is not available in all regions. It depends on + Cloud Scheduler, an App Engine application, so it's only available + in [App Engine + regions](https://cloud.google.com/about/locations#region). * + `PIPELINE_ID` is the ID of the pipeline. Must be unique for the + selected project and location. type: string - readOnly: true - description: >- - Output only. Immutable. The timestamp when the pipeline was last - modified. Set by the Data Pipelines service. - format: google-datetime - displayName: - description: >- - Required. The display name of the pipeline. It can contain only - letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores - (_). + GoogleCloudDatapipelinesV1SdkVersion: + id: GoogleCloudDatapipelinesV1SdkVersion + description: The version of the SDK used to run the job. + type: object + properties: + version: + description: The version of the SDK used to run the job. type: string - type: - enum: - - PIPELINE_TYPE_UNSPECIFIED - - PIPELINE_TYPE_BATCH - - PIPELINE_TYPE_STREAMING - description: >- - Required. The type of the pipeline. This field affects the - scheduling of the pipeline and the type of metrics to show for the - pipeline. + sdkSupportStatus: + description: The support status for this SDK version. enumDescriptions: - - The pipeline type isn't specified. + - Dataflow is unaware of this version. + - This is a known version of an SDK, and is supported. + - A newer version of the SDK exists, and an update is recommended. - >- - A batch pipeline. It runs jobs on a specific schedule, and each - job will automatically terminate once execution is finished. + This version of the SDK is deprecated and will eventually be + unsupported. - >- - A streaming pipeline. The underlying job is continuously running - until it is manually terminated by the user. This type of pipeline - doesn't have a schedule to run on, and the linked job gets created - when the pipeline is created. + Support for this SDK version has ended and it should no longer be + used. + enum: + - UNKNOWN + - SUPPORTED + - STALE + - DEPRECATED + - UNSUPPORTED type: string - description: >- - The main pipeline entity and all the necessary metadata for launching - and managing linked jobs. - type: object - id: GoogleCloudDatapipelinesV1Pipeline + versionDisplayName: + type: string + description: A readable string describing the version of the SDK. GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter: - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - description: Launch Flex Template parameter. + type: object properties: - environment: - description: The runtime environment for the Flex Template job. - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment - parameters: - type: object - description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' - additionalProperties: - type: string transformNameMappings: description: >- Use this to pass transform name mappings for streaming update jobs. @@ -310,166 +568,86 @@ components: additionalProperties: type: string type: object - update: - type: boolean - description: >- - Set this to true if you are sending a request to update a running - streaming job. When set, the job name should be the same as the - running job. - launchOptions: + environment: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment + description: The runtime environment for the Flex Template job. + parameters: additionalProperties: type: string type: object - description: >- - Launch options for this Flex Template job. This is a common set of - options across languages and templates. This should not be used to - pass job parameters. - containerSpecGcsPath: - type: string - description: >- - Cloud Storage path to a file with a JSON-serialized ContainerSpec as - content. + description: 'The parameters for the Flex Template. Example: `{"num_workers":"5"}`' jobName: description: >- Required. The job name to use for the created job. For an update job request, the job name should be the same as the existing running job. type: string - type: object - GoogleCloudDatapipelinesV1Workload: - properties: - dataflowLaunchTemplateRequest: + launchOptions: + type: object description: >- - Template information and additional parameters needed to launch a - Dataflow job using the standard launch API. - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' - dataflowFlexTemplateRequest: + Launch options for this Flex Template job. This is a common set of + options across languages and templates. This should not be used to + pass job parameters. + additionalProperties: + type: string + update: + type: boolean description: >- - Template information and additional parameters needed to launch a - Dataflow job using the flex launch API. - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest - id: GoogleCloudDatapipelinesV1Workload - description: Workload details for creating the pipeline jobs. - type: object + Set this to true if you are sending a request to update a running + streaming job. When set, the job name should be the same as the + running job. + containerSpecGcsPath: + type: string + description: >- + Cloud Storage path to a file with a JSON-serialized ContainerSpec as + content. + description: Launch Flex Template parameter. + id: GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter GoogleCloudDatapipelinesV1DataflowJobDetails: - id: GoogleCloudDatapipelinesV1DataflowJobDetails - type: object properties: - sdkVersion: - description: Output only. The SDK version used to run the job. - readOnly: true - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' - currentWorkers: - readOnly: true - format: int32 - description: >- - Output only. The current number of workers used to run the jobs. - Only set to a value if the job is still running. - type: integer resourceInfo: + additionalProperties: + type: number + format: double description: >- Cached version of all the metrics of interest for the job. This value gets stored here when the job is terminated. As long as the job is running, this field is populated from the Dataflow API. - additionalProperties: - format: double - type: number type: object + currentWorkers: + description: >- + Output only. The current number of workers used to run the jobs. + Only set to a value if the job is still running. + readOnly: true + format: int32 + type: integer + sdkVersion: + description: Output only. The SDK version used to run the job. + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1SdkVersion' + readOnly: true description: >- Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately. - GoogleCloudDatapipelinesV1LaunchTemplateRequest: - properties: - launchParameters: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateParameters - description: >- - The parameters of the template to launch. This should be part of the - body of the POST request. - location: - description: >- - The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. - type: string - gcsPath: - type: string - description: >- - A Cloud Storage path to the template from which to create the job. - Must be a valid Cloud Storage URL, beginning with 'gs://'. - projectId: - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - type: string - validateOnly: - description: >- - If true, the request is validated but not actually executed. - Defaults to false. - type: boolean - description: A request to launch a template. - id: GoogleCloudDatapipelinesV1LaunchTemplateRequest - type: object - GoogleRpcStatus: - id: GoogleRpcStatus type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 + id: GoogleCloudDatapipelinesV1DataflowJobDetails GoogleCloudDatapipelinesV1RuntimeEnvironment: properties: - additionalExperiments: - type: array - description: Additional experiment flags for the job. - items: - type: string + numWorkers: + format: int32 + type: integer + description: The initial number of Compute Engine instances for the job. serviceAccountEmail: - type: string description: The email address of the service account to run the job as. - additionalUserLabels: - description: >- - Additional user labels to be specified for the job. Keys and values - should follow the restrictions specified in the [labeling - restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) - page. An object containing a list of key/value pairs. Example: { - "name": "wrench", "mass": "1kg", "count": "3" }. - type: object - additionalProperties: - type: string - kmsKeyName: type: string + kmsKeyName: description: >- Name for the Cloud KMS key for the job. The key format is: projects//locations//keyRings//cryptoKeys/ + type: string subnetwork: + type: string description: >- Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated @@ -477,39 +655,8 @@ components: "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. - type: string - maxWorkers: - format: int32 - description: >- - The maximum number of Compute Engine instances to be made available - to your pipeline during execution, from 1 to 1000. - type: integer - bypassTempDirValidation: - description: >- - Whether to bypass the safety checks for the job's temporary - directory. Use with caution. - type: boolean - enableStreamingEngine: - type: boolean - description: Whether to enable Streaming Engine for the job. - numWorkers: - type: integer - format: int32 - description: The initial number of Compute Engine instances for the job. - machineType: - type: string - description: >- - The machine type to use for the job. Defaults to the value from the - template if not specified. - workerRegion: - type: string - description: >- - The Compute Engine region - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1". Mutually - exclusive with worker_zone. If neither worker_region nor worker_zone - is specified, default to the control plane's region. workerZone: + type: string description: >- The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) @@ -518,250 +665,100 @@ components: worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both `worker_zone` and `zone` are set, `worker_zone` takes precedence. - type: string - tempLocation: - description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. - type: string + additionalExperiments: + type: array + items: + type: string + description: Additional experiment flags for the job. ipConfiguration: + type: string description: Configuration for VM IPs. - enum: - - WORKER_IP_UNSPECIFIED - - WORKER_IP_PUBLIC - - WORKER_IP_PRIVATE enumDescriptions: - The configuration is unknown, or unspecified. - Workers should have public IP addresses. - Workers should have private IP addresses. - type: string - network: - description: >- - Network to which VMs will be assigned. If empty or unspecified, the - service will use the network "default". - type: string - zone: - type: string - description: >- - The Compute Engine [availability - zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - for launching worker instances to run your pipeline. In the future, - worker_zone will take precedence. - description: The environment values to set at runtime. - type: object - id: GoogleCloudDatapipelinesV1RuntimeEnvironment - GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment: - id: GoogleCloudDatapipelinesV1FlexTemplateRuntimeEnvironment - type: object - description: The environment values to be set at runtime for a Flex Template. - properties: - enableStreamingEngine: - type: boolean - description: Whether to enable Streaming Engine for the job. - serviceAccountEmail: - type: string - description: The email address of the service account to run the job as. - numWorkers: - description: The initial number of Compute Engine instances for the job. - format: int32 - type: integer - tempLocation: - type: string - description: >- - The Cloud Storage path to use for temporary files. Must be a valid - Cloud Storage URL, beginning with `gs://`. - subnetwork: - type: string - description: >- - Subnetwork to which VMs will be assigned, if desired. You can - specify a subnetwork using either a complete URL or an abbreviated - path. Expected to be of the form - "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" - or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is - located in a Shared VPC network, you must use the complete URL. - flexrsGoal: - description: >- - Set FlexRS goal for the job. - https://cloud.google.com/dataflow/docs/guides/flexrs - enum: - - FLEXRS_UNSPECIFIED - - FLEXRS_SPEED_OPTIMIZED - - FLEXRS_COST_OPTIMIZED - enumDescriptions: - - Run in the default mode. - - Optimize for lower execution time. - - Optimize for lower cost. - type: string - zone: - type: string - description: >- - The Compute Engine [availability - zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) - for launching worker instances to run your pipeline. In the future, - worker_zone will take precedence. - ipConfiguration: enum: - WORKER_IP_UNSPECIFIED - WORKER_IP_PUBLIC - WORKER_IP_PRIVATE - enumDescriptions: - - The configuration is unknown, or unspecified. - - Workers should have public IP addresses. - - Workers should have private IP addresses. - type: string - description: Configuration for VM IPs. - kmsKeyName: + enableStreamingEngine: + description: Whether to enable Streaming Engine for the job. + type: boolean + workerRegion: description: >- - Name for the Cloud KMS key for the job. Key format is: - projects//locations//keyRings//cryptoKeys/ + The Compute Engine region + (https://cloud.google.com/compute/docs/regions-zones/regions-zones) + in which worker processing should occur, e.g. "us-west1". Mutually + exclusive with worker_zone. If neither worker_region nor worker_zone + is specified, default to the control plane's region. type: string machineType: - type: string description: >- The machine type to use for the job. Defaults to the value from the template if not specified. - workerZone: - description: >- - The Compute Engine zone - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1-a". Mutually - exclusive with worker_region. If neither worker_region nor - worker_zone is specified, a zone in the control plane region is - chosen based on available capacity. If both `worker_zone` and `zone` - are set, `worker_zone` takes precedence. type: string - additionalUserLabels: - type: object + zone: + type: string description: >- - Additional user labels to be specified for the job. Keys and values - must follow the restrictions specified in the [labeling - restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions). - An object containing a list of key/value pairs. Example: `{ "name": - "wrench", "mass": "1kg", "count": "3" }`. - additionalProperties: - type: string + The Compute Engine [availability + zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) + for launching worker instances to run your pipeline. In the future, + worker_zone will take precedence. maxWorkers: - format: int32 type: integer description: >- The maximum number of Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. - network: + format: int32 + tempLocation: type: string + description: >- + The Cloud Storage path to use for temporary files. Must be a valid + Cloud Storage URL, beginning with `gs://`. + network: description: >- Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - workerRegion: type: string - description: >- - The Compute Engine region - (https://cloud.google.com/compute/docs/regions-zones/regions-zones) - in which worker processing should occur, e.g. "us-west1". Mutually - exclusive with worker_zone. If neither worker_region nor worker_zone - is specified, defaults to the control plane region. - additionalExperiments: - description: Additional experiment flags for the job. - items: + additionalUserLabels: + additionalProperties: type: string - type: array - GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest: - properties: - launchParameter: - description: Required. Parameter to launch a job from a Flex Template. - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateParameter - location: - type: string + type: object description: >- - Required. The [regional endpoint] - (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) - to which to direct the request. For example, `us-central1`, - `us-west1`. - validateOnly: + Additional user labels to be specified for the job. Keys and values + should follow the restrictions specified in the [labeling + restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) + page. An object containing a list of key/value pairs. Example: { + "name": "wrench", "mass": "1kg", "count": "3" }. + bypassTempDirValidation: description: >- - If true, the request is validated but not actually executed. - Defaults to false. + Whether to bypass the safety checks for the job's temporary + directory. Use with caution. type: boolean - projectId: - description: >- - Required. The ID of the Cloud Platform project that the job belongs - to. - type: string - id: GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest - description: A request to launch a Dataflow job from a Flex Template. - type: object - GoogleCloudDatapipelinesV1ScheduleSpec: - id: GoogleCloudDatapipelinesV1ScheduleSpec - properties: - timeZone: - description: >- - Timezone ID. This matches the timezone IDs used by the Cloud - Scheduler API. If empty, UTC time is assumed. - type: string - nextJobTime: - description: Output only. When the next Scheduler job is going to run. - type: string - format: google-datetime - readOnly: true - schedule: - type: string - description: >- - Unix-cron format of the schedule. This information is retrieved from - the linked Cloud Scheduler. - description: Details of the schedule the pipeline runs on. - type: object - GoogleProtobufEmpty: - id: GoogleProtobufEmpty type: object - properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudDatapipelinesV1ListPipelinesResponse: + id: GoogleCloudDatapipelinesV1RuntimeEnvironment + description: The environment values to set at runtime. + GoogleCloudDatapipelinesV1Workload: + description: Workload details for creating the pipeline jobs. type: object - id: GoogleCloudDatapipelinesV1ListPipelinesResponse - properties: - nextPageToken: - type: string - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - pipelines: - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' - type: array - description: >- - Results that matched the filter criteria and were accessible to the - caller. Results are always in descending order of pipeline creation - date. - description: Response message for ListPipelines. - GoogleCloudDatapipelinesV1ListJobsResponse: - description: Response message for ListJobs - id: GoogleCloudDatapipelinesV1ListJobsResponse + id: GoogleCloudDatapipelinesV1Workload properties: - jobs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Job' + dataflowFlexTemplateRequest: description: >- - Results that were accessible to the caller. Results are always in - descending order of job creation date. - nextPageToken: - type: string + Template information and additional parameters needed to launch a + Dataflow job using the flex launch API. + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1LaunchFlexTemplateRequest + dataflowLaunchTemplateRequest: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1LaunchTemplateRequest' description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: object + Template information and additional parameters needed to launch a + Dataflow job using the standard launch API. parameters: - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: key + name: fields schema: type: string upload_protocol: @@ -770,18 +767,16 @@ components: name: upload_protocol schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + alt: + description: Data format for response. in: query - name: uploadType + name: alt schema: type: string + enum: + - json + - media + - proto oauth_token: description: OAuth 2.0 token for the current user. in: query @@ -797,18 +792,33 @@ components: name: quotaUser schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean _.xgafv: description: V1 error format. in: query @@ -818,78 +828,40 @@ components: enum: - '1' - '2' - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: callback + name: uploadType schema: type: string x-stackQL-resources: - jobs: - id: google.datapipelines.jobs - name: jobs - title: Jobs - methods: - _list: - operation: &ref_1 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - list: - operation: *ref_1 - response: *ref_2 - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/jobs/methods/list' - insert: [] - update: [] - delete: [] pipelines: id: google.datapipelines.pipelines name: pipelines title: Pipelines methods: - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: + run: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:run/post response: mediaType: application/json openAPIDocKey: '200' - delete: + stop: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post response: mediaType: application/json openAPIDocKey: '200' - run: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:run/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.pipelines create: operation: $ref: >- @@ -897,21 +869,24 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines/get - response: &ref_4 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.pipelines - list: - operation: *ref_3 - response: *ref_4 - stop: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}:stop/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -923,27 +898,58 @@ components: - $ref: '#/components/x-stackQL-resources/pipelines/methods/create' update: - $ref: '#/components/x-stackQL-resources/pipelines/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete' + jobs: + id: google.datapipelines.jobs + name: jobs + title: Jobs + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1pipelines~1{pipelinesId}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/jobs/methods/list' + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: - parameters: &ref_5 - - $ref: '#/components/parameters/key' + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: + parameters: &ref_1 + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - get: + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/uploadType' + post: description: >- - Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the - caller doesn't have permission to access it. - operationId: datapipelines.projects.locations.pipelines.jobs.list + Creates a job for the specified pipeline directly. You can use this + method when the internal scheduler is not configured and you want to + trigger the job directly or through an external system. Returns a + "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" + error if the user doesn't have permission to access the pipeline or run + jobs for the pipeline. + operationId: datapipelines.projects.locations.pipelines.run + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -956,7 +962,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse + #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse parameters: - in: path name: projectsId @@ -973,29 +979,20 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: - parameters: *ref_5 - patch: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: + parameters: *ref_1 + post: description: >- - Updates a pipeline. If successful, the updated Pipeline is returned. - Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline - does not return successfully, you can retry the UpdatePipeline request - until you receive a successful response. - operationId: datapipelines.projects.locations.pipelines.patch + Freezes pipeline execution permanently. If there's a corresponding + scheduler entry, it's deleted, and the pipeline state is changed to + "ARCHIVED". However, pipeline metadata is retained. + operationId: datapipelines.projects.locations.pipelines.stop requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1024,17 +1021,13 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/pipelines: + parameters: *ref_1 get: description: >- - Looks up a single pipeline. Returns a "NOT_FOUND" error if no such - pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have + Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. - operationId: datapipelines.projects.locations.pipelines.get + operationId: datapipelines.projects.locations.pipelines.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1046,7 +1039,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1ListPipelinesResponse parameters: - in: path name: projectsId @@ -1058,16 +1052,31 @@ paths: required: true schema: type: string - - in: path - name: pipelinesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - delete: + - in: query + name: pageToken + schema: + type: string + post: description: >- - Deletes a pipeline. If a scheduler job is attached to the pipeline, it - will be deleted. - operationId: datapipelines.projects.locations.pipelines.delete + Creates a pipeline. For a batch pipeline, you can pass scheduler + information. Data Pipelines uses the scheduler information to create an + internal scheduler that runs jobs periodically. If the internal + scheduler is not configured, you can use RunPipeline to run jobs. + operationId: datapipelines.projects.locations.pipelines.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1079,7 +1088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1091,28 +1100,13 @@ paths: required: true schema: type: string - - in: path - name: pipelinesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:run: - parameters: *ref_5 - post: + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}: + parameters: *ref_1 + delete: description: >- - Creates a job for the specified pipeline directly. You can use this - method when the internal scheduler is not configured and you want to - trigger the job directly or through an external system. Returns a - "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" - error if the user doesn't have permission to access the pipeline or run - jobs for the pipeline. - operationId: datapipelines.projects.locations.pipelines.run - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineRequest + Deletes a pipeline. If a scheduler job is attached to the pipeline, it + will be deleted. + operationId: datapipelines.projects.locations.pipelines.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1124,8 +1118,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1RunPipelineResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -1142,20 +1135,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/pipelines: - parameters: *ref_5 - post: + get: description: >- - Creates a pipeline. For a batch pipeline, you can pass scheduler - information. Data Pipelines uses the scheduler information to create an - internal scheduler that runs jobs periodically. If the internal - scheduler is not configured, you can use RunPipeline to run jobs. - operationId: datapipelines.projects.locations.pipelines.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + Looks up a single pipeline. Returns a "NOT_FOUND" error if no such + pipeline exists. Returns a "FORBIDDEN" error if the caller doesn't have + permission to access it. + operationId: datapipelines.projects.locations.pipelines.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1179,11 +1164,23 @@ paths: required: true schema: type: string - get: + - in: path + name: pipelinesId + required: true + schema: + type: string + patch: description: >- - Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have - permission to access it. - operationId: datapipelines.projects.locations.pipelines.list + Updates a pipeline. If successful, the updated Pipeline is returned. + Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline + does not return successfully, you can retry the UpdatePipeline request + until you receive a successful response. + operationId: datapipelines.projects.locations.pipelines.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1195,8 +1192,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1ListPipelinesResponse + $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' parameters: - in: path name: projectsId @@ -1208,33 +1204,23 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: pipelinesId + required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:stop: - parameters: *ref_5 - post: + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}/jobs: + parameters: *ref_1 + get: description: >- - Freezes pipeline execution permanently. If there's a corresponding - scheduler entry, it's deleted, and the pipeline state is changed to - "ARCHIVED". However, pipeline metadata is retained. - operationId: datapipelines.projects.locations.pipelines.stop - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDatapipelinesV1StopPipelineRequest + Lists jobs for a given pipeline. Throws a "FORBIDDEN" error if the + caller doesn't have permission to access it. + operationId: datapipelines.projects.locations.pipelines.jobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1246,7 +1232,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDatapipelinesV1Pipeline' + $ref: >- + #/components/schemas/GoogleCloudDatapipelinesV1ListJobsResponse parameters: - in: path name: projectsId @@ -1263,3 +1250,12 @@ paths: required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml index d9577083..256c2921 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataplex.yaml @@ -7,8 +7,8 @@ info: title: Cloud Dataplex API description: Dataplex API is used to manage the lifecycle of data lakes. version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dataplex/docs servers: @@ -186,13 +186,13 @@ components: type: string etag: description: >- - Optional. This checksum is computed by the server based on the value - of other fields, and may be sent on update and delete requests to - ensure the client has an up-to-date value before proceeding. + Optional. This checksum is computed by the service, and might be + sent on update and delete requests to ensure the client has an + up-to-date value before proceeding. type: string typeAliases: description: >- - Optional. Indicates the class this Entry Type belongs to, for + Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL. type: array items: @@ -233,11 +233,11 @@ components: type: string GoogleCloudDataplexV1ListEntryTypesResponse: id: GoogleCloudDataplexV1ListEntryTypesResponse - description: List EntryTypes response + description: List EntryTypes response. type: object properties: entryTypes: - description: ListEntryTypes under the given parent location. + description: EntryTypes under the given parent location. type: array items: $ref: '#/components/schemas/GoogleCloudDataplexV1EntryType' @@ -247,15 +247,15 @@ components: more results in the list. type: string unreachableLocations: - description: Locations that could not be reached. + description: Locations that the service couldn't reach. type: array items: type: string GoogleCloudDataplexV1AspectType: id: GoogleCloudDataplexV1AspectType description: >- - Aspect Type is a template for creating Aspects, and represents the - JSON-schema for a given Entry, e.g., BigQuery Table Schema. + AspectType is a template for creating Aspects, and represents the + JSON-schema for a given Entry, for example, BigQuery Table Schema. type: object properties: name: @@ -268,8 +268,8 @@ components: uid: description: >- Output only. System generated globally unique ID for the AspectType. - This ID will be different if the AspectType is deleted and - re-created with the same name. + If you delete and recreate the AspectType with the same name, then + this ID will be different. readOnly: true type: string createTime: @@ -295,51 +295,30 @@ components: type: string etag: description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. + The service computes this checksum. The client may send it on update + and delete requests to ensure it has an up-to-date value before + proceeding. type: string authorization: - description: Immutable. Authorization defined for this type. + description: Immutable. Defines the Authorization for this type. $ref: '#/components/schemas/GoogleCloudDataplexV1AspectTypeAuthorization' metadataTemplate: description: Required. MetadataTemplate of the aspect. $ref: '#/components/schemas/GoogleCloudDataplexV1AspectTypeMetadataTemplate' - transferStatus: - description: >- - Output only. Denotes the transfer status of the Aspect Type. It is - unspecified for Aspect Types created from Dataplex API. - readOnly: true - type: string - enumDescriptions: - - >- - The default value. It is set for resources that were not subject - for migration from Data Catalog service. - - >- - Indicates that a resource was migrated from Data Catalog service - but it hasn't been transferred yet. In particular the resource - cannot be updated from Dataplex API. - - >- - Indicates that a resource was transferred from Data Catalog - service. The resource can only be updated from Dataplex API. - enum: - - TRANSFER_STATUS_UNSPECIFIED - - TRANSFER_STATUS_MIGRATED - - TRANSFER_STATUS_TRANSFERRED GoogleCloudDataplexV1AspectTypeAuthorization: id: GoogleCloudDataplexV1AspectTypeAuthorization - description: Autorization for an Aspect Type. + description: Autorization for an AspectType. type: object properties: alternateUsePermission: description: >- - Immutable. The IAM permission grantable on the Entry Group to allow - access to instantiate Aspects of Dataplex owned Aspect Types, only + Immutable. The IAM permission grantable on the EntryGroup to allow + access to instantiate Aspects of Dataplex owned AspectTypes, only settable for Dataplex owned Types. type: string GoogleCloudDataplexV1AspectTypeMetadataTemplate: id: GoogleCloudDataplexV1AspectTypeMetadataTemplate - description: MetadataTemplate definition for AspectType + description: MetadataTemplate definition for an AspectType. type: object properties: index: @@ -359,56 +338,55 @@ components: type: description: >- Required. The datatype of this field. The following values are - supported: Primitive types (string, integer, boolean, double, - datetime); datetime must be of the format RFC3339 UTC "Zulu" - (Examples: "2014-10-02T15:01:23Z" and - "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, - record). + supported:Primitive types: string integer boolean double datetime. + Must be of the format RFC3339 UTC "Zulu" (Examples: + "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z").Complex + types: enum array map record type: string recordFields: description: >- - Optional. Field definition, needs to be specified if the type is - record. Defines the nested fields. + Optional. Field definition. You must specify it if the type is + record. It defines the nested fields. type: array items: $ref: >- #/components/schemas/GoogleCloudDataplexV1AspectTypeMetadataTemplate enumValues: description: >- - Optional. The list of values for an enum type. Needs to be defined - if the type is enum. + Optional. The list of values for an enum type. You must define it if + the type is enum. type: array items: $ref: >- #/components/schemas/GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue mapItems: description: >- - Optional. map_items needs to be set if the type is map. map_items - can refer to a primitive field or a complex (record only) field. To - specify a primitive field, just name and type needs to be set in the - nested MetadataTemplate. The recommended value for the name field is - item, as this is not used in the actual payload. + Optional. If the type is map, set map_items. map_items can refer to + a primitive field or a complex (record only) field. To specify a + primitive field, you only need to set name and type in the nested + MetadataTemplate. The recommended value for the name field is item, + as this isn't used in the actual payload. $ref: '#/components/schemas/GoogleCloudDataplexV1AspectTypeMetadataTemplate' arrayItems: description: >- - Optional. array_items needs to be set if the type is array. - array_items can refer to a primitive field or a complex (record - only) field. To specify a primitive field, just name and type needs - to be set in the nested MetadataTemplate. The recommended value for - the name field is item, as this is not used in the actual payload. + Optional. If the type is array, set array_items. array_items can + refer to a primitive field or a complex (record only) field. To + specify a primitive field, you only need to set name and type in the + nested MetadataTemplate. The recommended value for the name field is + item, as this isn't used in the actual payload. $ref: '#/components/schemas/GoogleCloudDataplexV1AspectTypeMetadataTemplate' typeId: description: >- - Optional. Id can be used if this definition of the field needs to be - reused later. Id needs to be unique across the entire template. Id - can only be specified if the field type is record. + Optional. You can use type id if this definition of the field needs + to be reused later. The type id must be unique across the entire + template. You can only specify it if the field type is record. type: string typeRef: description: >- - Optional. A reference to another field definition (instead of an - inline definition). The value must be equal to the value of an id - field defined elsewhere in the MetadataTemplate. Only fields with - type as record can refer to other fields. + Optional. A reference to another field definition (not an inline + definition). The value must be equal to the value of an id field + defined elsewhere in the MetadataTemplate. Only fields with record + type can refer to other fields. type: string constraints: description: Optional. Specifies the constraints on this field. @@ -420,75 +398,75 @@ components: #/components/schemas/GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue: id: GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue - description: Definition of Enumvalue (to be used by enum fields) + description: Definition of Enumvalue, to be used for enum fields. type: object properties: index: - description: Required. Index for the enum. Cannot be modified. + description: Required. Index for the enum value. It can't be modified. type: integer format: int32 name: description: >- Required. Name of the enumvalue. This is the actual value that the - aspect will contain. + aspect can contain. type: string deprecated: description: >- - Optional. Optional deprecation message to be set if an enum value - needs to be deprecated. + Optional. You can set this message if you need to deprecate an enum + value. type: string GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints: id: GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints - description: Definition of the constraints of a field + description: Definition of the constraints of a field. type: object properties: required: - description: Optional. Marks this as an optional/required field. + description: Optional. Marks this field as optional or required. type: boolean GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations: id: GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations - description: Definition of the annotations of a field + description: Definition of the annotations of a field. type: object properties: deprecated: description: >- - Optional. Marks a field as deprecated, a deprecation message can be - included. + Optional. Marks a field as deprecated. You can include a deprecation + message. type: string displayName: - description: Optional. Specify a displayname for a field. + description: Optional. Display name for a field. type: string description: - description: Optional. Specify a description for a field + description: Optional. Description for a field. type: string displayOrder: description: >- - Optional. Specify a display order for a field. Display order can be - used to reorder where a field is rendered + Optional. Display order for a field. You can use this to reorder + where a field is rendered. type: integer format: int32 stringType: description: >- - Optional. String Type annotations can be used to specify special + Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A - fully qualified url link. resource: A service qualified resource + fully qualified URL link. resource: A service qualified resource reference. type: string stringValues: description: >- - Optional. Suggested hints for string fields. These can be used to - suggest values to users, through an UI for example. + Optional. Suggested hints for string fields. You can use them to + suggest values to users through console. type: array items: type: string GoogleCloudDataplexV1ListAspectTypesResponse: id: GoogleCloudDataplexV1ListAspectTypesResponse - description: List AspectTypes response + description: List AspectTypes response. type: object properties: aspectTypes: - description: ListAspectTypes under the given parent location. + description: AspectTypes under the given parent location. type: array items: $ref: '#/components/schemas/GoogleCloudDataplexV1AspectType' @@ -498,7 +476,7 @@ components: more results in the list. type: string unreachableLocations: - description: Locations that could not be reached. + description: Locations that the service couldn't reach. type: array items: type: string @@ -509,16 +487,16 @@ components: properties: name: description: >- - Output only. The relative resource name of the EntryGroup, of the - form: - projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + Output only. The relative resource name of the EntryGroup, in the + format + projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. readOnly: true type: string uid: description: >- Output only. System generated globally unique ID for the EntryGroup. - This ID will be different if the EntryGroup is deleted and - re-created with the same name. + If you delete and recreate the EntryGroup with the same name, this + ID will be different. readOnly: true type: string createTime: @@ -544,38 +522,17 @@ components: type: string etag: description: >- - This checksum is computed by the server based on the value of other - fields, and may be sent on update and delete requests to ensure the - client has an up-to-date value before proceeding. - type: string - transferStatus: - description: >- - Output only. Denotes the transfer status of the Entry Group. It is - unspecified for Entry Group created from Dataplex API. - readOnly: true + This checksum is computed by the service, and might be sent on + update and delete requests to ensure the client has an up-to-date + value before proceeding. type: string - enumDescriptions: - - >- - The default value. It is set for resources that were not subject - for migration from Data Catalog service. - - >- - Indicates that a resource was migrated from Data Catalog service - but it hasn't been transferred yet. In particular the resource - cannot be updated from Dataplex API. - - >- - Indicates that a resource was transferred from Data Catalog - service. The resource can only be updated from Dataplex API. - enum: - - TRANSFER_STATUS_UNSPECIFIED - - TRANSFER_STATUS_MIGRATED - - TRANSFER_STATUS_TRANSFERRED GoogleCloudDataplexV1ListEntryGroupsResponse: id: GoogleCloudDataplexV1ListEntryGroupsResponse - description: List ListEntryGroups response. + description: List entry groups response. type: object properties: entryGroups: - description: ListEntryGroups under the given parent location. + description: Entry groups under the given parent location. type: array items: $ref: '#/components/schemas/GoogleCloudDataplexV1EntryGroup' @@ -585,45 +542,46 @@ components: more results in the list. type: string unreachableLocations: - description: Locations that could not be reached. + description: Locations that the service couldn't reach. type: array items: type: string GoogleCloudDataplexV1Entry: id: GoogleCloudDataplexV1Entry description: >- - An entry is a representation of a data asset which can be described by + An entry is a representation of a data resource that can be described by various metadata. type: object properties: name: description: >- - Identifier. The relative resource name of the Entry, of the form: - projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + Identifier. The relative resource name of the entry, in the format + projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. type: string entryType: description: >- - Required. Immutable. The resource name of the EntryType used to - create this Entry. + Required. Immutable. The relative resource name of the entry type + that was used to create this entry, in the format + projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. type: string createTime: - description: Output only. The time when the Entry was created. + description: Output only. The time when the entry was created in Dataplex. readOnly: true type: string format: google-datetime updateTime: - description: Output only. The time when the Entry was last updated. + description: Output only. The time when the entry was last updated in Dataplex. readOnly: true type: string format: google-datetime aspects: description: >- - Optional. The Aspects attached to the Entry. The format for the key - can be one of the following: 1. - {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached - directly to the entry) 2. - {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is - attached to an entry's path) + Optional. The aspects that are attached to the entry. Depending on + how the aspect is attached to the entry, the format of the aspect + key can be one of the following: If the aspect is attached directly + to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} + If the aspect is attached to an entry's path: + {project_id_or_number}.{location_id}.{aspect_type_id}@{path} type: object additionalProperties: $ref: '#/components/schemas/GoogleCloudDataplexV1Aspect' @@ -632,11 +590,15 @@ components: type: string fullyQualifiedName: description: >- - Optional. A name for the entry that can reference it in an external - system. The maximum size of the field is 4000 characters. + Optional. A name for the entry that can be referenced by an external + system. For more information, see Fully qualified names + (https://cloud.google.com/data-catalog/docs/fully-qualified-names). + The maximum size of the field is 4000 characters. type: string entrySource: - description: Optional. Source system related information for an entry. + description: >- + Optional. Information related to the source system of the data + resource that is represented by the entry. $ref: '#/components/schemas/GoogleCloudDataplexV1EntrySource' GoogleCloudDataplexV1Aspect: id: GoogleCloudDataplexV1Aspect @@ -668,55 +630,53 @@ components: data: description: >- Required. The content of the aspect, according to its aspect type - schema. This will replace content. The maximum size of the field is - 120KB (encoded as UTF-8). + schema. The maximum size of the field is 120KB (encoded as UTF-8). type: object additionalProperties: type: any description: Properties of the object. aspectSource: + description: Optional. Information related to the source system of the aspect. $ref: '#/components/schemas/GoogleCloudDataplexV1AspectSource' GoogleCloudDataplexV1AspectSource: id: GoogleCloudDataplexV1AspectSource - description: AspectSource contains source system related information for the aspect. + description: Information related to the source system of the aspect. type: object properties: createTime: - description: The create time of the aspect in the source system. + description: The time the aspect was created in the source system. type: string format: google-datetime updateTime: - description: The update time of the aspect in the source system. + description: The time the aspect was last updated in the source system. type: string format: google-datetime GoogleCloudDataplexV1EntrySource: id: GoogleCloudDataplexV1EntrySource - description: EntrySource contains source system related information for the entry. + description: >- + Information related to the source system of the data resource that is + represented by the entry. type: object properties: resource: description: >- - The name of the resource in the source system. The maximum size of - the field is 4000 characters. + The name of the resource in the source system. Maximum length is + 4,000 characters. type: string system: - description: >- - The name of the source system. The maximum size of the field is 64 - characters. + description: The name of the source system. Maximum length is 64 characters. type: string platform: description: >- - The platform containing the source system. The maximum size of the - field is 64 characters. + The platform containing the source system. Maximum length is 64 + characters. type: string displayName: - description: >- - User friendly display name. The maximum size of the field is 500 - characters. + description: A user-friendly display name. Maximum length is 500 characters. type: string description: description: >- - Description of the Entry. The maximum size of the field is 2000 + A description of the data resource. Maximum length is 2,000 characters. type: string labels: @@ -727,23 +687,38 @@ components: additionalProperties: type: string ancestors: - description: Immutable. The ancestors of the Entry in the source system. + description: >- + Immutable. The entries representing the ancestors of the data + resource in the source system. type: array items: $ref: '#/components/schemas/GoogleCloudDataplexV1EntrySourceAncestor' createTime: - description: The create time of the resource in the source system. + description: The time when the resource was created in the source system. type: string format: google-datetime updateTime: - description: The update time of the resource in the source system. + description: >- + The time when the resource was last updated in the source system. If + the entry exists in the system and its EntrySource has update_time + populated, further updates to the EntrySource of the entry must + provide incremental updates to its update_time. type: string format: google-datetime + location: + description: >- + Output only. Location of the resource in the source system. You can + search the entry by this location. By default, this should match the + location of the entry group containing this entry. A different value + allows capturing the source location for data external to Google + Cloud. + readOnly: true + type: string GoogleCloudDataplexV1EntrySourceAncestor: id: GoogleCloudDataplexV1EntrySourceAncestor description: >- - Ancestor contains information about individual items in the hierarchy of - an Entry. + Information about individual items in the hierarchy that is associated + with the data resource. type: object properties: name: @@ -754,15 +729,18 @@ components: type: string GoogleCloudDataplexV1ListEntriesResponse: id: GoogleCloudDataplexV1ListEntriesResponse + description: List Entries response. type: object properties: entries: - description: The list of entries. + description: The list of entries under the given parent location. type: array items: $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' nextPageToken: - description: Pagination token. + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string GoogleCloudDataplexV1SearchEntriesResponse: id: GoogleCloudDataplexV1SearchEntriesResponse @@ -775,17 +753,19 @@ components: $ref: '#/components/schemas/GoogleCloudDataplexV1SearchEntriesResult' totalSize: description: >- - The estimated total number of matching entries. Not guaranteed to be - accurate. + The estimated total number of matching entries. This number isn't + guaranteed to be accurate. type: integer format: int32 nextPageToken: - description: Pagination token. + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. type: string unreachable: description: >- - Unreachable locations. Search results don't include data from those - locations. + Locations that the service couldn't reach. Search results don't + include data from these locations. type: array items: type: string @@ -817,6 +797,315 @@ components: description: Entry deprecated: true $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + GoogleCloudDataplexV1MetadataJob: + id: GoogleCloudDataplexV1MetadataJob + description: A metadata job resource. + type: object + properties: + name: + description: >- + Output only. Identifier. The name of the resource that the + configuration is applied to, in the format + projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}. + readOnly: true + type: string + uid: + description: >- + Output only. A system-generated, globally unique ID for the metadata + job. If the metadata job is deleted and then re-created with the + same name, this ID is different. + readOnly: true + type: string + createTime: + description: Output only. The time when the metadata job was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the metadata job was updated. + readOnly: true + type: string + format: google-datetime + labels: + description: Optional. User-defined labels. + type: object + additionalProperties: + type: string + type: + description: Required. Metadata job type. + type: string + enumDescriptions: + - Unspecified. + - Import job. + enum: + - TYPE_UNSPECIFIED + - IMPORT + importSpec: + description: Import job specification. + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobImportJobSpec' + importResult: + description: Output only. Import job result. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobImportJobResult' + status: + description: Output only. Metadata job status. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJobStatus' + GoogleCloudDataplexV1MetadataJobImportJobSpec: + id: GoogleCloudDataplexV1MetadataJobImportJobSpec + description: Job specification for a metadata import job + type: object + properties: + sourceStorageUri: + description: >- + Optional. The URI of a Cloud Storage bucket or folder (beginning + with gs:// and ending with /) that contains the metadata import + files for this job.A metadata import file defines the values to set + for each of the entries and aspects in a metadata job. For more + information about how to create a metadata import file and the file + requirements, see Metadata import file + (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You + can provide multiple metadata import files in the same metadata job. + The bucket or folder must contain at least one metadata import file, + in JSON Lines format (either .json or .jsonl file extension).In FULL + entry sync mode, don't save the metadata import file in a folder + named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import + file contains no data, all entries and aspects that belong to the + job's scope are deleted. + type: string + sourceCreateTime: + description: >- + Optional. The time when the process that created the metadata import + files began. + type: string + format: google-datetime + scope: + description: >- + Required. A boundary on the scope of impact that the metadata import + job can have. + $ref: >- + #/components/schemas/GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope + entrySyncMode: + description: >- + Required. The sync mode for entries. Only FULL mode is supported for + entries. All entries in the job's scope are modified. If an entry + exists in Dataplex but isn't included in the metadata import file, + the entry is deleted when you run the metadata job. + type: string + enumDescriptions: + - Sync mode unspecified. + - >- + All resources in the job's scope are modified. If a resource + exists in Dataplex but isn't included in the metadata import file, + the resource is deleted when you run the metadata job. Use this + mode to perform a full sync of the set of entries in the job + scope. + - >- + Only the entries and aspects that are explicitly included in the + metadata import file are modified. Use this mode to modify a + subset of resources while leaving unreferenced resources + unchanged. + enum: + - SYNC_MODE_UNSPECIFIED + - FULL + - INCREMENTAL + aspectSyncMode: + description: >- + Required. The sync mode for aspects. Only INCREMENTAL mode is + supported for aspects. An aspect is modified only if the metadata + import file includes a reference to the aspect in the update_mask + field and the aspect_keys field. + type: string + enumDescriptions: + - Sync mode unspecified. + - >- + All resources in the job's scope are modified. If a resource + exists in Dataplex but isn't included in the metadata import file, + the resource is deleted when you run the metadata job. Use this + mode to perform a full sync of the set of entries in the job + scope. + - >- + Only the entries and aspects that are explicitly included in the + metadata import file are modified. Use this mode to modify a + subset of resources while leaving unreferenced resources + unchanged. + enum: + - SYNC_MODE_UNSPECIFIED + - FULL + - INCREMENTAL + logLevel: + description: >- + Optional. The level of logs to write to Cloud Logging for this + job.Debug-level logs provide highly-detailed information for + troubleshooting, but their increased verbosity could incur + additional costs (https://cloud.google.com/stackdriver/pricing) that + might not be merited for all jobs.If unspecified, defaults to INFO. + type: string + enumDescriptions: + - Log level unspecified. + - >- + Debug-level logging. Captures detailed logs for each import item. + Use debug-level logging to troubleshoot issues with specific + import items. For example, use debug-level logging to identify + resources that are missing from the job scope, entries or aspects + that don't conform to the associated entry type or aspect type, or + other misconfigurations with the metadata import file.Depending on + the size of your metadata job and the number of logs that are + generated, debug-level logging might incur additional costs + (https://cloud.google.com/stackdriver/pricing). + - >- + Info-level logging. Captures logs at the overall job level. + Includes aggregate logs about import items, but doesn't specify + which import item has an error. + enum: + - LOG_LEVEL_UNSPECIFIED + - DEBUG + - INFO + GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope: + id: GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope + description: A boundary on the scope of impact that the metadata import job can have. + type: object + properties: + entryGroups: + description: >- + Required. The entry group that is in scope for the import job, + specified as a relative resource name in the format + projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. + Only entries that belong to the specified entry group are affected + by the job.Must contain exactly one element. The entry group and the + job must be in the same location. + type: array + items: + type: string + entryTypes: + description: >- + Required. The entry types that are in scope for the import job, + specified as relative resource names in the format + projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. + The job modifies only the entries that belong to these entry + types.If the metadata import file attempts to modify an entry whose + type isn't included in this list, the import job is halted before + modifying any entries or aspects.The location of an entry type must + either match the location of the job, or the entry type must be + global. + type: array + items: + type: string + aspectTypes: + description: >- + Optional. The aspect types that are in scope for the import job, + specified as relative resource names in the format + projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. + The job modifies only the aspects that belong to these aspect + types.If the metadata import file attempts to modify an aspect whose + type isn't included in this list, the import job is halted before + modifying any entries or aspects.The location of an aspect type must + either match the location of the job, or the aspect type must be + global. + type: array + items: + type: string + GoogleCloudDataplexV1MetadataJobImportJobResult: + id: GoogleCloudDataplexV1MetadataJobImportJobResult + description: Results from a metadata import job. + type: object + properties: + deletedEntries: + description: Output only. The total number of entries that were deleted. + readOnly: true + type: string + format: int64 + updatedEntries: + description: Output only. The total number of entries that were updated. + readOnly: true + type: string + format: int64 + createdEntries: + description: Output only. The total number of entries that were created. + readOnly: true + type: string + format: int64 + unchangedEntries: + description: Output only. The total number of entries that were unchanged. + readOnly: true + type: string + format: int64 + recreatedEntries: + description: Output only. The total number of entries that were recreated. + readOnly: true + type: string + format: int64 + updateTime: + description: Output only. The time when the status was updated. + readOnly: true + type: string + format: google-datetime + GoogleCloudDataplexV1MetadataJobStatus: + id: GoogleCloudDataplexV1MetadataJobStatus + description: Metadata job status. + type: object + properties: + state: + description: Output only. State of the metadata job. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - The job is queued. + - The job is running. + - The job is being canceled. + - The job is canceled. + - The job succeeded. + - The job failed. + - The job completed with some errors. + enum: + - STATE_UNSPECIFIED + - QUEUED + - RUNNING + - CANCELING + - CANCELED + - SUCCEEDED + - FAILED + - SUCCEEDED_WITH_ERRORS + message: + description: Output only. Message relating to the progression of a metadata job. + readOnly: true + type: string + completionPercent: + description: Output only. Progress tracking. + readOnly: true + type: integer + format: int32 + updateTime: + description: Output only. The time when the status was updated. + readOnly: true + type: string + format: google-datetime + GoogleCloudDataplexV1ListMetadataJobsResponse: + id: GoogleCloudDataplexV1ListMetadataJobsResponse + description: List metadata jobs response. + type: object + properties: + metadataJobs: + description: Metadata jobs under the specified parent location. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJob' + nextPageToken: + description: >- + A token to retrieve the next page of results. If there are no more + results in the list, the value is empty. + type: string + unreachableLocations: + description: Locations that the service couldn't reach. + type: array + items: + type: string + GoogleCloudDataplexV1CancelMetadataJobRequest: + id: GoogleCloudDataplexV1CancelMetadataJobRequest + description: Cancel metadata job request. + type: object + properties: {} GoogleIamV1SetIamPolicyRequest: id: GoogleIamV1SetIamPolicyRequest description: Request message for SetIamPolicy method. @@ -1766,6 +2055,10 @@ components: description: The time when the latest DataScanJob ended. type: string format: google-datetime + latestJobCreateTime: + description: Optional. The time when the DataScanJob execution was created. + type: string + format: google-datetime GoogleCloudDataplexV1DataQualitySpec: id: GoogleCloudDataplexV1DataQualitySpec description: DataQualityScan related setting. @@ -1888,6 +2181,9 @@ components: Optional. Description of the rule. The maximum length is 1,024 characters. type: string + suspended: + description: Optional. Whether the Rule is active or suspended. Default is false. + type: boolean GoogleCloudDataplexV1DataQualityRuleRangeExpectation: id: GoogleCloudDataplexV1DataQualityRuleRangeExpectation description: Evaluates whether each column value lies between a specified range. @@ -2484,8 +2780,8 @@ components: distinctRatio: description: >- Ratio of rows with distinct values against total scanned rows. Not - available for complex non-groupable field type RECORD and fields - with REPEATABLE mode. + available for complex non-groupable field type, including RECORD, + ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. type: number format: double topNValues: @@ -2493,8 +2789,8 @@ components: The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available - for complex non-groupable field type RECORD and fields with - REPEATABLE mode. + for complex non-groupable field type, including RECORD, ARRAY, + GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. type: array items: $ref: >- @@ -2730,6 +3026,11 @@ components: DataScanJob. readOnly: true type: string + createTime: + description: Output only. The time when the DataScanJob was created. + readOnly: true + type: string + format: google-datetime startTime: description: Output only. The time when the DataScanJob was started. readOnly: true @@ -2809,16 +3110,18 @@ components: type: string GoogleCloudDataplexV1GenerateDataQualityRulesRequest: id: GoogleCloudDataplexV1GenerateDataQualityRulesRequest - description: Generate recommended DataQualityRules request. + description: Request details for generating data quality rule recommendations. type: object properties: {} GoogleCloudDataplexV1GenerateDataQualityRulesResponse: id: GoogleCloudDataplexV1GenerateDataQualityRulesResponse - description: Generate recommended DataQualityRules response. + description: Response details for data quality rule recommendations. type: object properties: rule: - description: Generated recommended {@link DataQualityRule}s. + description: >- + The data quality rules that Dataplex generates based on the results + of a data profiling scan. type: array items: $ref: '#/components/schemas/GoogleCloudDataplexV1DataQualityRule' @@ -5467,6 +5770,56 @@ components: description: The data processed by the query. type: string format: int64 + GoogleCloudDataplexV1ImportItem: + id: GoogleCloudDataplexV1ImportItem + description: >- + An object that describes the values that you want to set for an entry + and its attached aspects when you import metadata. Used when you run a + metadata import job. See CreateMetadataJob.You provide a collection of + import items in a metadata import file. For more information about how + to create a metadata import file, see Metadata import file + (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + type: object + properties: + entry: + description: Information about an entry and its attached aspects. + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + updateMask: + description: >- + The fields to update, in paths that are relative to the Entry + resource. Separate each field with a comma.In FULL entry sync mode, + Dataplex includes the paths of all of the fields for an entry that + can be modified, including aspects. This means that Dataplex + replaces the existing entry with the entry in the metadata import + file. All modifiable fields are updated, regardless of the fields + that are listed in the update mask, and regardless of whether a + field is present in the entry object.The update_mask field is + ignored when an entry is created or re-created.Dataplex also + determines which entries and aspects to modify by comparing the + values and timestamps that you provide in the metadata import file + with the values and timestamps that exist in your project. For more + information, see Comparison logic + (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + type: string + format: google-fieldmask + aspectKeys: + description: >- + The aspects to modify. Supports the following syntaxes: + {aspect_type_reference}: matches aspects that belong to the + specified aspect type and are attached directly to the entry. + {aspect_type_reference}@{path}: matches aspects that belong to the + specified aspect type and path. {aspect_type_reference}@*: matches + aspects that belong to the specified aspect type for all + paths.Replace {aspect_type_reference} with a reference to the aspect + type, in the format + {project_id_or_number}.{location_id}.{aspect_type_id}.If you leave + this field empty, it is treated as specifying exactly those aspects + that are present within the specified entry.In FULL entry sync mode, + Dataplex implicitly adds the keys for all of the required aspects of + an entry. + type: array + items: + type: string GoogleCloudDataplexV1DataScanEvent: id: GoogleCloudDataplexV1DataScanEvent description: >- @@ -5863,65 +6216,402 @@ components: - ENTITY_TYPE_UNSPECIFIED - TABLE - FILESET - parameters: - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - quotaUser: + CloudReliabilityZicyWs3DataplaneProtosAssetLocation: + id: CloudReliabilityZicyWs3DataplaneProtosAssetLocation description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string + Provides the mapping of a cloud asset to a direct physical location or + to a proxy that defines the location on its behalf. + type: object + properties: + expected: + description: >- + Defines the customer expectation around ZI/ZS for this asset and + ZI/ZS state of the region at the time of asset creation. + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations + locationData: + description: Contains all kinds of physical location definitions for this asset. + type: array + items: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosLocationData + parentAsset: + description: >- + Defines parents assets if any in order to allow later generation of + child_asset_location data via child assets. + type: array + items: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosCloudAsset + extraParameters: + description: Defines extra parameters required for specific asset types. + type: array + items: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosExtraParameter + ccfeRmsPath: + description: >- + Spanner path of the CCFE RMS database. It is only applicable for + CCFE tenants that use CCFE RMS for storing resource metadata. + type: string + CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations: + id: CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations + type: object + properties: + zoneIsolation: + description: >- + Deprecated: use zi_org_policy, zi_region_policy and zi_region_state + instead for setting ZI expectations as per + go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zoneSeparation: + description: >- + Deprecated: use zs_org_policy, and zs_region_stateinstead for + setting Zs expectations as per go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking of the asset ZS-bit is not available + - '' + - '' + enum: + - ZS_REGION_UNSPECIFIED + - ZS_REGION_UNKNOWN + - ZS_REGION_NOT_ENABLED + - ZS_REGION_ENABLED + ziOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + ziRegionPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_REGION_POLICY_UNSPECIFIED + - ZI_REGION_POLICY_UNKNOWN + - ZI_REGION_POLICY_NOT_SET + - ZI_REGION_POLICY_FAIL_OPEN + - ZI_REGION_POLICY_FAIL_CLOSED + ziRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZI_REGION_UNSPECIFIED + - ZI_REGION_UNKNOWN + - ZI_REGION_NOT_ENABLED + - ZI_REGION_ENABLED + requirementOverride: + description: >- + Explicit overrides for ZI and ZS requirements to be used for + resources that should be excluded from ZI/ZS verification logic. + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride + CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride: + id: >- + CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride + type: object + properties: + ziOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zsOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + CloudReliabilityZicyWs3DataplaneProtosLocationData: + id: CloudReliabilityZicyWs3DataplaneProtosLocationData + type: object + properties: + directLocation: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment + spannerLocation: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosSpannerLocation + childAssetLocation: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition + gcpProjectProxy: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy + blobstoreLocation: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation + placerLocation: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosPlacerLocation + CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment: + id: CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment + type: object + properties: + location: + type: array + items: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosLocationAssignment + CloudReliabilityZicyWs3DataplaneProtosLocationAssignment: + id: CloudReliabilityZicyWs3DataplaneProtosLocationAssignment + type: object + properties: + location: + type: string + locationType: + type: string + enumDescriptions: + - '' + - '1-10: Physical failure domains.' + - '' + - '11-20: Logical failure domains.' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - CLUSTER + - POP + - CLOUD_ZONE + - CLOUD_REGION + - MULTI_REGION_GEO + - MULTI_REGION_JURISDICTION + - GLOBAL + - OTHER + CloudReliabilityZicyWs3DataplaneProtosSpannerLocation: + id: CloudReliabilityZicyWs3DataplaneProtosSpannerLocation + type: object + properties: + dbName: + description: Set of databases used by the resource in format /span// + type: array + items: + type: string + backupName: + description: >- + Set of backups used by the resource with name in the same format as + what is available at http://table/spanner_automon.backup_metadata + type: array + items: + type: string + CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition: + id: CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition + type: object + properties: + childAsset: + type: array + items: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosCloudAsset + CloudReliabilityZicyWs3DataplaneProtosCloudAsset: + id: CloudReliabilityZicyWs3DataplaneProtosCloudAsset + type: object + properties: + assetType: + type: string + assetName: + type: string + CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy: + id: CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy + type: object + properties: + projectNumbers: + type: array + items: + type: string + CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation: + id: CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation + description: >- + Policy ID that identified data placement in Blobstore as per + go/blobstore-user-guide#data-metadata-placement-and-failure-domains + type: object + properties: + policyId: + type: array + items: + type: string + CloudReliabilityZicyWs3DataplaneProtosPlacerLocation: + id: CloudReliabilityZicyWs3DataplaneProtosPlacerLocation + description: >- + Message describing that the location of the customer resource is tied to + placer allocations + type: object + properties: + placerConfig: + description: >- + Directory with a config related to it in placer (e.g. + "/placer/prod/home/my-root/my-dir") + type: string + CloudReliabilityZicyWs3DataplaneProtosExtraParameter: + id: CloudReliabilityZicyWs3DataplaneProtosExtraParameter + description: Defines parameters that should only be used for specific asset types. + type: object + properties: + regionalMigDistributionPolicy: + description: >- + Details about zones used by regional + compute.googleapis.com/InstanceGroupManager to create instances. + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy + CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy: + id: CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy + description: >- + To be used for specifying the intended distribution of regional + compute.googleapis.com/InstanceGroupManager instances + type: object + properties: + zones: + description: Cloud zones used by regional MIG to create instances. + type: array + items: + $ref: >- + #/components/schemas/CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration + targetShape: + description: >- + The shape in which the group converges around distribution of + resources. Instance of proto2 enum + type: integer + format: int32 + CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration: + id: CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration + type: object + properties: + zone: + type: string + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query @@ -5963,16 +6653,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_list: - operation: &ref_1 + projects_locations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 projects_locations_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -5987,23 +6674,21 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] operations: id: google.dataplex.operations name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -6025,17 +6710,43 @@ components: response: mediaType: application/json openAPIDocKey: '200' + organizations_locations_operations_get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete + - $ref: >- + #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_delete entry_types: id: google.dataplex.entry_types name: entry_types @@ -6048,17 +6759,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_types_list: - operation: &ref_5 + projects_locations_entry_types_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entryTypes - projects_locations_entry_types_list: - operation: *ref_5 - response: *ref_6 projects_locations_entry_types_patch: operation: $ref: >- @@ -6092,6 +6800,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/entry_types/methods/projects_locations_entry_types_delete @@ -6107,17 +6816,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_types_get_iam_policy: - operation: &ref_7 + projects_locations_entry_types_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryTypes~1{entryTypesId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_entry_types_get_iam_policy: - operation: *ref_7 - response: *ref_8 projects_locations_entry_types_test_iam_permissions: operation: $ref: >- @@ -6131,6 +6837,9 @@ components: #/components/x-stackQL-resources/entry_types_iam_policies/methods/projects_locations_entry_types_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entry_types_iam_policies/methods/projects_locations_entry_types_set_iam_policy delete: [] aspect_types: id: google.dataplex.aspect_types @@ -6144,17 +6853,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_aspect_types_list: - operation: &ref_9 + projects_locations_aspect_types_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.aspectTypes - projects_locations_aspect_types_list: - operation: *ref_9 - response: *ref_10 projects_locations_aspect_types_patch: operation: $ref: >- @@ -6188,6 +6894,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/aspect_types/methods/projects_locations_aspect_types_delete @@ -6203,17 +6910,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_aspect_types_get_iam_policy: - operation: &ref_11 + projects_locations_aspect_types_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1aspectTypes~1{aspectTypesId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_aspect_types_get_iam_policy: - operation: *ref_11 - response: *ref_12 projects_locations_aspect_types_test_iam_permissions: operation: $ref: >- @@ -6227,6 +6931,9 @@ components: #/components/x-stackQL-resources/aspect_types_iam_policies/methods/projects_locations_aspect_types_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/aspect_types_iam_policies/methods/projects_locations_aspect_types_set_iam_policy delete: [] entry_groups: id: google.dataplex.entry_groups @@ -6240,17 +6947,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_list: - operation: &ref_13 + projects_locations_entry_groups_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entryGroups - projects_locations_entry_groups_list: - operation: *ref_13 - response: *ref_14 projects_locations_entry_groups_patch: operation: $ref: >- @@ -6284,6 +6988,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/entry_groups/methods/projects_locations_entry_groups_delete @@ -6299,17 +7004,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_get_iam_policy: - operation: &ref_15 + projects_locations_entry_groups_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_entry_groups_get_iam_policy: - operation: *ref_15 - response: *ref_16 projects_locations_entry_groups_test_iam_permissions: operation: $ref: >- @@ -6323,6 +7025,9 @@ components: #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entry_groups_iam_policies/methods/projects_locations_entry_groups_set_iam_policy delete: [] entries: id: google.dataplex.entries @@ -6336,17 +7041,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_entry_groups_entries_list: - operation: &ref_17 + projects_locations_entry_groups_entries_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryGroups~1{entryGroupsId}~1entries/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entries - projects_locations_entry_groups_entries_list: - operation: *ref_17 - response: *ref_18 projects_locations_entry_groups_entries_patch: operation: $ref: >- @@ -6380,45 +7082,92 @@ components: update: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/entries/methods/projects_locations_entry_groups_entries_delete - lakes_iam_policies: - id: google.dataplex.lakes_iam_policies - name: lakes_iam_policies - title: Lakes_iam_policies + metadata_jobs: + id: google.dataplex.metadata_jobs + name: metadata_jobs + title: Metadata_jobs methods: - projects_locations_lakes_set_iam_policy: + projects_locations_metadata_jobs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}:setIamPolicy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_get_iam_policy: - operation: &ref_19 + projects_locations_metadata_jobs_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}:getIamPolicy/get - response: &ref_20 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_lakes_get_iam_policy: - operation: *ref_19 - response: *ref_20 - projects_locations_lakes_test_iam_permissions: + objectKey: $.metadataJobs + projects_locations_metadata_jobs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}:testIamPermissions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs~1{metadataJobsId}/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: + projects_locations_metadata_jobs_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1metadataJobs~1{metadataJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_get + - $ref: >- + #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/metadata_jobs/methods/projects_locations_metadata_jobs_create + update: [] + replace: [] + delete: [] + lakes_iam_policies: + id: google.dataplex.lakes_iam_policies + name: lakes_iam_policies + title: Lakes_iam_policies + methods: + projects_locations_lakes_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_lakes_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_lakes_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/lakes_iam_policies/methods/projects_locations_lakes_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/lakes_iam_policies/methods/projects_locations_lakes_set_iam_policy delete: [] lakes: id: google.dataplex.lakes @@ -6432,17 +7181,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_list: - operation: &ref_21 + projects_locations_lakes_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.lakes - projects_locations_lakes_list: - operation: *ref_21 - response: *ref_22 projects_locations_lakes_patch: operation: $ref: >- @@ -6476,6 +7222,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/lakes/methods/projects_locations_lakes_delete @@ -6491,17 +7238,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_zones_get_iam_policy: - operation: &ref_23 + projects_locations_lakes_zones_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones~1{zonesId}:getIamPolicy/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_lakes_zones_get_iam_policy: - operation: *ref_23 - response: *ref_24 projects_locations_lakes_zones_test_iam_permissions: operation: $ref: >- @@ -6515,6 +7259,9 @@ components: #/components/x-stackQL-resources/zones_iam_policies/methods/projects_locations_lakes_zones_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/zones_iam_policies/methods/projects_locations_lakes_zones_set_iam_policy delete: [] zones: id: google.dataplex.zones @@ -6528,17 +7275,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_zones_list: - operation: &ref_25 + projects_locations_lakes_zones_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.zones - projects_locations_lakes_zones_list: - operation: *ref_25 - response: *ref_26 projects_locations_lakes_zones_patch: operation: $ref: >- @@ -6572,6 +7316,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/zones/methods/projects_locations_lakes_zones_delete @@ -6587,17 +7332,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_zones_assets_get_iam_policy: - operation: &ref_27 + projects_locations_lakes_zones_assets_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones~1{zonesId}~1assets~1{assetsId}:getIamPolicy/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_lakes_zones_assets_get_iam_policy: - operation: *ref_27 - response: *ref_28 projects_locations_lakes_zones_assets_test_iam_permissions: operation: $ref: >- @@ -6611,6 +7353,9 @@ components: #/components/x-stackQL-resources/assets_iam_policies/methods/projects_locations_lakes_zones_assets_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/assets_iam_policies/methods/projects_locations_lakes_zones_assets_set_iam_policy delete: [] assets: id: google.dataplex.assets @@ -6624,17 +7369,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_zones_assets_list: - operation: &ref_29 + projects_locations_lakes_zones_assets_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones~1{zonesId}~1assets/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.assets - projects_locations_lakes_zones_assets_list: - operation: *ref_29 - response: *ref_30 projects_locations_lakes_zones_assets_patch: operation: $ref: >- @@ -6668,6 +7410,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/assets/methods/projects_locations_lakes_zones_assets_delete @@ -6676,39 +7419,30 @@ components: name: actions title: Actions methods: - _projects_locations_lakes_zones_assets_actions_list: - operation: &ref_31 + projects_locations_lakes_zones_assets_actions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones~1{zonesId}~1assets~1{assetsId}~1actions/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.actions - projects_locations_lakes_zones_assets_actions_list: - operation: *ref_31 - response: *ref_32 - _projects_locations_lakes_zones_actions_list: - operation: &ref_33 + projects_locations_lakes_zones_actions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones~1{zonesId}~1actions/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.actions - projects_locations_lakes_zones_actions_list: - operation: *ref_33 - response: *ref_34 - _projects_locations_lakes_actions_list: - operation: &ref_35 + projects_locations_lakes_actions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1actions/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.actions - projects_locations_lakes_actions_list: - operation: *ref_35 - response: *ref_36 sqlVerbs: select: - $ref: >- @@ -6719,6 +7453,7 @@ components: #/components/x-stackQL-resources/actions/methods/projects_locations_lakes_actions_list insert: [] update: [] + replace: [] delete: [] entities: id: google.dataplex.entities @@ -6732,17 +7467,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_zones_entities_list: - operation: &ref_37 + projects_locations_lakes_zones_entities_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones~1{zonesId}~1entities/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entities - projects_locations_lakes_zones_entities_list: - operation: *ref_37 - response: *ref_38 projects_locations_lakes_zones_entities_update: operation: $ref: >- @@ -6773,7 +7505,8 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/entities/methods/projects_locations_lakes_zones_entities_update delete: @@ -6791,17 +7524,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_zones_entities_partitions_list: - operation: &ref_39 + projects_locations_lakes_zones_entities_partitions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1zones~1{zonesId}~1entities~1{entitiesId}~1partitions/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.partitions - projects_locations_lakes_zones_entities_partitions_list: - operation: *ref_39 - response: *ref_40 projects_locations_lakes_zones_entities_partitions_delete: operation: $ref: >- @@ -6826,6 +7556,7 @@ components: - $ref: >- #/components/x-stackQL-resources/partitions/methods/projects_locations_lakes_zones_entities_partitions_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/partitions/methods/projects_locations_lakes_zones_entities_partitions_delete @@ -6841,17 +7572,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_tasks_get_iam_policy: - operation: &ref_41 + projects_locations_lakes_tasks_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1tasks~1{tasksId}:getIamPolicy/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_lakes_tasks_get_iam_policy: - operation: *ref_41 - response: *ref_42 projects_locations_lakes_tasks_test_iam_permissions: operation: $ref: >- @@ -6865,6 +7593,9 @@ components: #/components/x-stackQL-resources/tasks_iam_policies/methods/projects_locations_lakes_tasks_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/tasks_iam_policies/methods/projects_locations_lakes_tasks_set_iam_policy delete: [] tasks: id: google.dataplex.tasks @@ -6878,17 +7609,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_tasks_list: - operation: &ref_43 + projects_locations_lakes_tasks_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1tasks/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tasks - projects_locations_lakes_tasks_list: - operation: *ref_43 - response: *ref_44 projects_locations_lakes_tasks_patch: operation: $ref: >- @@ -6929,6 +7657,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/tasks/methods/projects_locations_lakes_tasks_delete @@ -6937,17 +7666,14 @@ components: name: jobs title: Jobs methods: - _projects_locations_lakes_tasks_jobs_list: - operation: &ref_45 + projects_locations_lakes_tasks_jobs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1tasks~1{tasksId}~1jobs/get - response: &ref_46 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - projects_locations_lakes_tasks_jobs_list: - operation: *ref_45 - response: *ref_46 projects_locations_lakes_tasks_jobs_get: operation: $ref: >- @@ -6969,17 +7695,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_scans_jobs_list: - operation: &ref_47 + projects_locations_data_scans_jobs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataScans~1{dataScansId}~1jobs/get - response: &ref_48 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataScanJobs - projects_locations_data_scans_jobs_list: - operation: *ref_47 - response: *ref_48 projects_locations_data_scans_jobs_generate_data_quality_rules: operation: $ref: >- @@ -6999,6 +7722,7 @@ components: #/components/x-stackQL-resources/jobs/methods/projects_locations_data_scans_jobs_list insert: [] update: [] + replace: [] delete: [] environments_iam_policies: id: google.dataplex.environments_iam_policies @@ -7012,17 +7736,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_environments_get_iam_policy: - operation: &ref_49 + projects_locations_lakes_environments_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1environments~1{environmentsId}:getIamPolicy/get - response: &ref_50 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_lakes_environments_get_iam_policy: - operation: *ref_49 - response: *ref_50 projects_locations_lakes_environments_test_iam_permissions: operation: $ref: >- @@ -7036,6 +7757,9 @@ components: #/components/x-stackQL-resources/environments_iam_policies/methods/projects_locations_lakes_environments_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/environments_iam_policies/methods/projects_locations_lakes_environments_set_iam_policy delete: [] environments: id: google.dataplex.environments @@ -7049,17 +7773,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_environments_list: - operation: &ref_51 + projects_locations_lakes_environments_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1environments/get - response: &ref_52 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.environments - projects_locations_lakes_environments_list: - operation: *ref_51 - response: *ref_52 projects_locations_lakes_environments_patch: operation: $ref: >- @@ -7093,6 +7814,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_lakes_environments_delete @@ -7101,23 +7823,21 @@ components: name: sessions title: Sessions methods: - _projects_locations_lakes_environments_sessions_list: - operation: &ref_53 + projects_locations_lakes_environments_sessions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1environments~1{environmentsId}~1sessions/get - response: &ref_54 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sessions - projects_locations_lakes_environments_sessions_list: - operation: *ref_53 - response: *ref_54 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_lakes_environments_sessions_list insert: [] update: [] + replace: [] delete: [] contentitems: id: google.dataplex.contentitems @@ -7131,17 +7851,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_contentitems_list: - operation: &ref_55 + projects_locations_lakes_contentitems_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1contentitems/get - response: &ref_56 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.content - projects_locations_lakes_contentitems_list: - operation: *ref_55 - response: *ref_56 projects_locations_lakes_contentitems_patch: operation: $ref: >- @@ -7175,6 +7892,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/contentitems/methods/projects_locations_lakes_contentitems_delete @@ -7183,17 +7901,14 @@ components: name: contentitems_iam_policies title: Contentitems_iam_policies methods: - _projects_locations_lakes_contentitems_get_iam_policy: - operation: &ref_57 + projects_locations_lakes_contentitems_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1contentitems~1{contentitemsId}:getIamPolicy/get - response: &ref_58 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_lakes_contentitems_get_iam_policy: - operation: *ref_57 - response: *ref_58 projects_locations_lakes_contentitems_set_iam_policy: operation: $ref: >- @@ -7214,6 +7929,9 @@ components: #/components/x-stackQL-resources/contentitems_iam_policies/methods/projects_locations_lakes_contentitems_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/contentitems_iam_policies/methods/projects_locations_lakes_contentitems_set_iam_policy delete: [] content: id: google.dataplex.content @@ -7227,17 +7945,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_lakes_content_list: - operation: &ref_59 + projects_locations_lakes_content_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1content/get - response: &ref_60 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.content - projects_locations_lakes_content_list: - operation: *ref_59 - response: *ref_60 projects_locations_lakes_content_patch: operation: $ref: >- @@ -7271,6 +7986,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/content/methods/projects_locations_lakes_content_delete @@ -7279,17 +7995,14 @@ components: name: content_iam_policies title: Content_iam_policies methods: - _projects_locations_lakes_content_get_iam_policy: - operation: &ref_61 + projects_locations_lakes_content_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lakes~1{lakesId}~1content~1{contentId}:getIamPolicy/get - response: &ref_62 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_lakes_content_get_iam_policy: - operation: *ref_61 - response: *ref_62 projects_locations_lakes_content_set_iam_policy: operation: $ref: >- @@ -7310,6 +8023,9 @@ components: #/components/x-stackQL-resources/content_iam_policies/methods/projects_locations_lakes_content_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/content_iam_policies/methods/projects_locations_lakes_content_set_iam_policy delete: [] data_scans_iam_policies: id: google.dataplex.data_scans_iam_policies @@ -7323,17 +8039,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_scans_get_iam_policy: - operation: &ref_63 + projects_locations_data_scans_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataScans~1{dataScansId}:getIamPolicy/get - response: &ref_64 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_data_scans_get_iam_policy: - operation: *ref_63 - response: *ref_64 projects_locations_data_scans_test_iam_permissions: operation: $ref: >- @@ -7347,6 +8060,9 @@ components: #/components/x-stackQL-resources/data_scans_iam_policies/methods/projects_locations_data_scans_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/data_scans_iam_policies/methods/projects_locations_data_scans_set_iam_policy delete: [] data_scans: id: google.dataplex.data_scans @@ -7360,17 +8076,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_scans_list: - operation: &ref_65 + projects_locations_data_scans_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataScans/get - response: &ref_66 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataScans - projects_locations_data_scans_list: - operation: *ref_65 - response: *ref_66 projects_locations_data_scans_patch: operation: $ref: >- @@ -7418,6 +8131,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/data_scans/methods/projects_locations_data_scans_delete @@ -7433,17 +8147,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_taxonomies_get_iam_policy: - operation: &ref_67 + projects_locations_data_taxonomies_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataTaxonomies~1{dataTaxonomiesId}:getIamPolicy/get - response: &ref_68 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_data_taxonomies_get_iam_policy: - operation: *ref_67 - response: *ref_68 projects_locations_data_taxonomies_test_iam_permissions: operation: $ref: >- @@ -7457,6 +8168,9 @@ components: #/components/x-stackQL-resources/data_taxonomies_iam_policies/methods/projects_locations_data_taxonomies_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/data_taxonomies_iam_policies/methods/projects_locations_data_taxonomies_set_iam_policy delete: [] data_taxonomies: id: google.dataplex.data_taxonomies @@ -7470,17 +8184,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_taxonomies_list: - operation: &ref_69 + projects_locations_data_taxonomies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataTaxonomies/get - response: &ref_70 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataTaxonomies - projects_locations_data_taxonomies_list: - operation: *ref_69 - response: *ref_70 projects_locations_data_taxonomies_patch: operation: $ref: >- @@ -7514,6 +8225,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/data_taxonomies/methods/projects_locations_data_taxonomies_delete @@ -7529,17 +8241,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_taxonomies_attributes_get_iam_policy: - operation: &ref_71 + projects_locations_data_taxonomies_attributes_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataTaxonomies~1{dataTaxonomiesId}~1attributes~1{attributesId}:getIamPolicy/get - response: &ref_72 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_data_taxonomies_attributes_get_iam_policy: - operation: *ref_71 - response: *ref_72 projects_locations_data_taxonomies_attributes_test_iam_permissions: operation: $ref: >- @@ -7553,6 +8262,9 @@ components: #/components/x-stackQL-resources/attributes_iam_policies/methods/projects_locations_data_taxonomies_attributes_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/attributes_iam_policies/methods/projects_locations_data_taxonomies_attributes_set_iam_policy delete: [] attributes: id: google.dataplex.attributes @@ -7566,17 +8278,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_taxonomies_attributes_list: - operation: &ref_73 + projects_locations_data_taxonomies_attributes_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataTaxonomies~1{dataTaxonomiesId}~1attributes/get - response: &ref_74 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataAttributes - projects_locations_data_taxonomies_attributes_list: - operation: *ref_73 - response: *ref_74 projects_locations_data_taxonomies_attributes_patch: operation: $ref: >- @@ -7610,6 +8319,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/attributes/methods/projects_locations_data_taxonomies_attributes_delete @@ -7625,17 +8335,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_attribute_bindings_get_iam_policy: - operation: &ref_75 + projects_locations_data_attribute_bindings_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataAttributeBindings~1{dataAttributeBindingsId}:getIamPolicy/get - response: &ref_76 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_data_attribute_bindings_get_iam_policy: - operation: *ref_75 - response: *ref_76 projects_locations_data_attribute_bindings_test_iam_permissions: operation: $ref: >- @@ -7649,6 +8356,9 @@ components: #/components/x-stackQL-resources/data_attribute_bindings_iam_policies/methods/projects_locations_data_attribute_bindings_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/data_attribute_bindings_iam_policies/methods/projects_locations_data_attribute_bindings_set_iam_policy delete: [] data_attribute_bindings: id: google.dataplex.data_attribute_bindings @@ -7662,17 +8372,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_attribute_bindings_list: - operation: &ref_77 + projects_locations_data_attribute_bindings_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataAttributeBindings/get - response: &ref_78 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataAttributeBindings - projects_locations_data_attribute_bindings_list: - operation: *ref_77 - response: *ref_78 projects_locations_data_attribute_bindings_patch: operation: $ref: >- @@ -7706,9 +8413,47 @@ components: update: - $ref: >- #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/data_attribute_bindings/methods/projects_locations_data_attribute_bindings_delete + entry_link_types_iam_policies: + id: google.dataplex.entry_link_types_iam_policies + name: entry_link_types_iam_policies + title: Entry_link_types_iam_policies + methods: + projects_locations_entry_link_types_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryLinkTypes~1{entryLinkTypesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_entry_link_types_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryLinkTypes~1{entryLinkTypesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_entry_link_types_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1entryLinkTypes~1{entryLinkTypesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/entry_link_types_iam_policies/methods/projects_locations_entry_link_types_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/entry_link_types_iam_policies/methods/projects_locations_entry_link_types_set_iam_policy + delete: [] governance_rules_iam_policies: id: google.dataplex.governance_rules_iam_policies name: governance_rules_iam_policies @@ -7721,17 +8466,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_governance_rules_get_iam_policy: - operation: &ref_79 + projects_locations_governance_rules_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1governanceRules~1{governanceRulesId}:getIamPolicy/get - response: &ref_80 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_governance_rules_get_iam_policy: - operation: *ref_79 - response: *ref_80 projects_locations_governance_rules_test_iam_permissions: operation: $ref: >- @@ -7745,68 +8487,221 @@ components: #/components/x-stackQL-resources/governance_rules_iam_policies/methods/projects_locations_governance_rules_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/governance_rules_iam_policies/methods/projects_locations_governance_rules_set_iam_policy delete: [] -paths: - /v1/projects/{projectsId}/locations/{locationsId}:lookupEntry: - parameters: &ref_81 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - get: - description: Looks up a single entry. - operationId: dataplex.projects.locations.lookupEntry - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: aspectTypes - schema: - type: string - - in: query - name: paths - schema: - type: string - - in: query - name: entry - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}:searchEntries: - parameters: *ref_81 - post: - description: Searches for entries matching given query and scope. - operationId: dataplex.projects.locations.searchEntries + glossaries_iam_policies: + id: google.dataplex.glossaries_iam_policies + name: glossaries_iam_policies + title: Glossaries_iam_policies + methods: + projects_locations_glossaries_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_glossaries_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_glossaries_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/glossaries_iam_policies/methods/projects_locations_glossaries_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/glossaries_iam_policies/methods/projects_locations_glossaries_set_iam_policy + delete: [] + categories_iam_policies: + id: google.dataplex.categories_iam_policies + name: categories_iam_policies + title: Categories_iam_policies + methods: + projects_locations_glossaries_categories_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_glossaries_categories_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_glossaries_categories_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1categories~1{categoriesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/categories_iam_policies/methods/projects_locations_glossaries_categories_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/categories_iam_policies/methods/projects_locations_glossaries_categories_set_iam_policy + delete: [] + terms_iam_policies: + id: google.dataplex.terms_iam_policies + name: terms_iam_policies + title: Terms_iam_policies + methods: + projects_locations_glossaries_terms_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_glossaries_terms_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_glossaries_terms_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1terms~1{termsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/terms_iam_policies/methods/projects_locations_glossaries_terms_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/terms_iam_policies/methods/projects_locations_glossaries_terms_set_iam_policy + delete: [] + encryption_configs_iam_policies: + id: google.dataplex.encryption_configs_iam_policies + name: encryption_configs_iam_policies + title: Encryption_configs_iam_policies + methods: + organizations_locations_encryption_configs_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs~1{encryptionConfigsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_encryption_configs_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs~1{encryptionConfigsId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + organizations_locations_encryption_configs_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1encryptionConfigs~1{encryptionConfigsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/encryption_configs_iam_policies/methods/organizations_locations_encryption_configs_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/encryption_configs_iam_policies/methods/organizations_locations_encryption_configs_set_iam_policy + delete: [] +paths: + /v1/projects/{projectsId}/locations/{locationsId}:lookupEntry: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Looks up a single Entry by name using the permission on the source + system. + operationId: dataplex.projects.locations.lookupEntry + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1Entry' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: aspectTypes + schema: + type: string + - in: query + name: paths + schema: + type: string + - in: query + name: entry + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}:searchEntries: + parameters: *ref_1 + post: + description: Searches for Entries matching the given query and scope. + operationId: dataplex.projects.locations.searchEntries security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7853,7 +8748,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_81 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: dataplex.projects.locations.list @@ -7889,7 +8784,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_81 + parameters: *ref_1 get: description: Gets information about a location. operationId: dataplex.projects.locations.get @@ -7917,7 +8812,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -7960,7 +8855,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8031,7 +8926,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -8078,9 +8973,9 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryTypes: - parameters: *ref_81 + parameters: *ref_1 post: - description: Creates an EntryType + description: Creates an EntryType. operationId: dataplex.projects.locations.entryTypes.create requestBody: content: @@ -8163,9 +9058,9 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}: - parameters: *ref_81 + parameters: *ref_1 patch: - description: Updates a EntryType resource. + description: Updates an EntryType. operationId: dataplex.projects.locations.entryTypes.patch requestBody: content: @@ -8210,7 +9105,7 @@ paths: schema: type: boolean delete: - description: Deletes a EntryType resource. + description: Deletes an EntryType. operationId: dataplex.projects.locations.entryTypes.delete security: - Oauth2: @@ -8245,7 +9140,7 @@ paths: schema: type: string get: - description: Retrieves a EntryType resource. + description: Gets an EntryType. operationId: dataplex.projects.locations.entryTypes.get security: - Oauth2: @@ -8276,7 +9171,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8317,7 +9212,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -8357,7 +9252,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -8400,9 +9295,9 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes: - parameters: *ref_81 + parameters: *ref_1 post: - description: Creates an AspectType + description: Creates an AspectType. operationId: dataplex.projects.locations.aspectTypes.create requestBody: content: @@ -8485,9 +9380,9 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}: - parameters: *ref_81 + parameters: *ref_1 patch: - description: Updates a AspectType resource. + description: Updates an AspectType. operationId: dataplex.projects.locations.aspectTypes.patch requestBody: content: @@ -8532,7 +9427,7 @@ paths: schema: type: boolean delete: - description: Deletes a AspectType resource. + description: Deletes an AspectType. operationId: dataplex.projects.locations.aspectTypes.delete security: - Oauth2: @@ -8567,7 +9462,7 @@ paths: schema: type: string get: - description: Retrieves a AspectType resource. + description: Gets an AspectType. operationId: dataplex.projects.locations.aspectTypes.get security: - Oauth2: @@ -8598,7 +9493,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8639,7 +9534,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -8679,7 +9574,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -8722,9 +9617,9 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups: - parameters: *ref_81 + parameters: *ref_1 post: - description: Creates an EntryGroup + description: Creates an EntryGroup. operationId: dataplex.projects.locations.entryGroups.create requestBody: content: @@ -8807,9 +9702,9 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}: - parameters: *ref_81 + parameters: *ref_1 patch: - description: Updates a EntryGroup resource. + description: Updates an EntryGroup. operationId: dataplex.projects.locations.entryGroups.patch requestBody: content: @@ -8854,7 +9749,7 @@ paths: schema: type: boolean delete: - description: Deletes a EntryGroup resource. + description: Deletes an EntryGroup. operationId: dataplex.projects.locations.entryGroups.delete security: - Oauth2: @@ -8889,7 +9784,7 @@ paths: schema: type: string get: - description: Retrieves a EntryGroup resource. + description: Gets an EntryGroup. operationId: dataplex.projects.locations.entryGroups.get security: - Oauth2: @@ -8920,7 +9815,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8961,7 +9856,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -9001,7 +9896,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -9044,7 +9939,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries: - parameters: *ref_81 + parameters: *ref_1 post: description: Creates an Entry. operationId: dataplex.projects.locations.entryGroups.entries.create @@ -9086,7 +9981,7 @@ paths: schema: type: string get: - description: Lists entries within an entry group. + description: Lists Entries within an EntryGroup. operationId: dataplex.projects.locations.entryGroups.entries.list security: - Oauth2: @@ -9130,7 +10025,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Updates an Entry. operationId: dataplex.projects.locations.entryGroups.entries.patch @@ -9226,7 +10121,7 @@ paths: schema: type: string get: - description: Gets a single entry. + description: Gets an Entry. operationId: dataplex.projects.locations.entryGroups.entries.get security: - Oauth2: @@ -9273,19 +10168,19 @@ paths: name: paths schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:setIamPolicy: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs: + parameters: *ref_1 post: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.lakes.setIamPolicy + Creates a metadata job. For example, use a metadata job to import + Dataplex Catalog entries and aspects from a third-party system into + Dataplex. + operationId: dataplex.projects.locations.metadataJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJob' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9297,7 +10192,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -9309,18 +10204,13 @@ paths: required: true schema: type: string - - in: path - name: lakesId - required: true + - in: query + name: metadataJobId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:getIamPolicy: - parameters: *ref_81 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.lakes.getIamPolicy + description: Lists metadata jobs. + operationId: dataplex.projects.locations.metadataJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9332,7 +10222,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1Policy' + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListMetadataJobsResponse parameters: - in: path name: projectsId @@ -9344,31 +10235,28 @@ paths: required: true schema: type: string - - in: path - name: lakesId - required: true - schema: - type: string - in: query - name: options.requestedPolicyVersion + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:testIamPermissions: - parameters: *ref_81 - post: - description: >- - 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. - operationId: dataplex.projects.locations.lakes.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}: + parameters: *ref_1 + get: + description: Gets a metadata job. + operationId: dataplex.projects.locations.metadataJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9380,7 +10268,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + $ref: '#/components/schemas/GoogleCloudDataplexV1MetadataJob' parameters: - in: path name: projectsId @@ -9393,20 +10281,26 @@ paths: schema: type: string - in: path - name: lakesId + name: metadataJobsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/lakes: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel: + parameters: *ref_1 post: - description: Creates a lake resource. - operationId: dataplex.projects.locations.lakes.create + description: >- + Cancels a metadata job.If you cancel a metadata import job that is in + progress, the changes in the job might be partially applied. We + recommend that you reset the state of the entry groups in your project + by running another metadata job that reverts the changes from the + canceled job. + operationId: dataplex.projects.locations.metadataJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1Lake' + $ref: >- + #/components/schemas/GoogleCloudDataplexV1CancelMetadataJobRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9418,7 +10312,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -9430,17 +10324,24 @@ paths: required: true schema: type: string - - in: query - name: lakeId + - in: path + name: metadataJobsId + required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - get: - description: Lists lake resources in a project and location. - operationId: dataplex.projects.locations.lakes.list + /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.lakes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9452,7 +10353,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1ListLakesResponse' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -9464,17 +10365,172 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: lakesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.lakes.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: lakesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: dataplex.projects.locations.lakes.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: lakesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/lakes: + parameters: *ref_1 + post: + description: Creates a lake resource. + operationId: dataplex.projects.locations.lakes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1Lake' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: lakeId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists lake resources in a project and location. + operationId: dataplex.projects.locations.lakes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1ListLakesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string - in: query @@ -9482,7 +10538,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Updates a lake resource. operationId: dataplex.projects.locations.lakes.patch @@ -9593,7 +10649,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -9639,7 +10695,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -9684,7 +10740,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -9732,7 +10788,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones: - parameters: *ref_81 + parameters: *ref_1 post: description: Creates a zone resource within a lake. operationId: dataplex.projects.locations.lakes.zones.create @@ -9826,7 +10882,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Updates a zone resource. operationId: dataplex.projects.locations.lakes.zones.patch @@ -9952,7 +11008,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -10003,7 +11059,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -10053,7 +11109,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -10106,7 +11162,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets: - parameters: *ref_81 + parameters: *ref_1 post: description: Creates an asset resource. operationId: dataplex.projects.locations.lakes.zones.assets.create @@ -10210,7 +11266,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Updates an asset resource. operationId: dataplex.projects.locations.lakes.zones.assets.patch @@ -10351,7 +11407,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/assets/{assetsId}/actions: - parameters: *ref_81 + parameters: *ref_1 get: description: Lists action resources in an asset. operationId: dataplex.projects.locations.lakes.zones.assets.actions.list @@ -10403,7 +11459,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities: - parameters: *ref_81 + parameters: *ref_1 post: description: Create a metadata entity. operationId: dataplex.projects.locations.lakes.zones.entities.create @@ -10503,7 +11559,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}: - parameters: *ref_81 + parameters: *ref_1 put: description: Update a metadata entity. Only supports full resource update. operationId: dataplex.projects.locations.lakes.zones.entities.update @@ -10645,7 +11701,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions: - parameters: *ref_81 + parameters: *ref_1 post: description: Create a metadata partition. operationId: dataplex.projects.locations.lakes.zones.entities.partitions.create @@ -10752,7 +11808,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/entities/{entitiesId}/partitions/{partitionsId}: - parameters: *ref_81 + parameters: *ref_1 delete: description: Delete a metadata partition. operationId: dataplex.projects.locations.lakes.zones.entities.partitions.delete @@ -10850,7 +11906,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/zones/{zonesId}/actions: - parameters: *ref_81 + parameters: *ref_1 get: description: Lists action resources in a zone. operationId: dataplex.projects.locations.lakes.zones.actions.list @@ -10897,7 +11953,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -10943,7 +11999,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -10988,7 +12044,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -11036,7 +12092,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks: - parameters: *ref_81 + parameters: *ref_1 post: description: Creates a task resource within a lake. operationId: dataplex.projects.locations.lakes.tasks.create @@ -11130,7 +12186,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Update the task resource. operationId: dataplex.projects.locations.lakes.tasks.patch @@ -11254,7 +12310,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:run: - parameters: *ref_81 + parameters: *ref_1 post: description: Run an on demand execution of a Task. operationId: dataplex.projects.locations.lakes.tasks.run @@ -11297,7 +12353,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs: - parameters: *ref_81 + parameters: *ref_1 get: description: Lists Jobs under the given task. operationId: dataplex.projects.locations.lakes.tasks.jobs.list @@ -11344,7 +12400,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs/{jobsId}: - parameters: *ref_81 + parameters: *ref_1 get: description: Get job resource. operationId: dataplex.projects.locations.lakes.tasks.jobs.get @@ -11387,7 +12443,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}/jobs/{jobsId}:cancel: - parameters: *ref_81 + parameters: *ref_1 post: description: Cancel jobs running for the task resource. operationId: dataplex.projects.locations.lakes.tasks.jobs.cancel @@ -11435,7 +12491,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -11481,7 +12537,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -11526,7 +12582,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -11574,7 +12630,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments: - parameters: *ref_81 + parameters: *ref_1 post: description: Create an environment resource. operationId: dataplex.projects.locations.lakes.environments.create @@ -11669,7 +12725,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Update the environment resource. operationId: dataplex.projects.locations.lakes.environments.patch @@ -11795,7 +12851,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/environments/{environmentsId}/sessions: - parameters: *ref_81 + parameters: *ref_1 get: description: Lists session resources in an environment. operationId: dataplex.projects.locations.lakes.environments.sessions.list @@ -11846,7 +12902,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems: - parameters: *ref_81 + parameters: *ref_1 post: description: Create a content. operationId: dataplex.projects.locations.lakes.contentitems.create @@ -11932,7 +12988,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Update a content. Only supports full resource update. operationId: dataplex.projects.locations.lakes.contentitems.patch @@ -12060,7 +13116,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a contentitem resource. A NOT_FOUND @@ -12108,7 +13164,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified contentitem resource. @@ -12154,7 +13210,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/contentitems/{contentitemsId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns the caller's permissions on a resource. If the resource does not @@ -12203,7 +13259,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content: - parameters: *ref_81 + parameters: *ref_1 post: description: Create a content. operationId: dataplex.projects.locations.lakes.content.create @@ -12289,7 +13345,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Update a content. Only supports full resource update. operationId: dataplex.projects.locations.lakes.content.patch @@ -12417,7 +13473,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a contentitem resource. A NOT_FOUND @@ -12465,7 +13521,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified contentitem resource. @@ -12511,7 +13567,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/content/{contentId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns the caller's permissions on a resource. If the resource does not @@ -12560,7 +13616,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/actions: - parameters: *ref_81 + parameters: *ref_1 get: description: Lists action resources in a lake. operationId: dataplex.projects.locations.lakes.actions.list @@ -12602,7 +13658,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:setIamPolicy: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -12643,7 +13699,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:getIamPolicy: - parameters: *ref_81 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -12683,7 +13739,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:testIamPermissions: - parameters: *ref_81 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -12726,7 +13782,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataScans: - parameters: *ref_81 + parameters: *ref_1 post: description: Creates a DataScan resource. operationId: dataplex.projects.locations.dataScans.create @@ -12811,7 +13867,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}: - parameters: *ref_81 + parameters: *ref_1 patch: description: Updates a DataScan resource. operationId: dataplex.projects.locations.dataScans.patch @@ -12924,7 +13980,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:run: - parameters: *ref_81 + parameters: *ref_1 post: description: Runs an on-demand execution of a DataScan operationId: dataplex.projects.locations.dataScans.run @@ -12962,9 +14018,12 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:generateDataQualityRules: - parameters: *ref_81 + parameters: *ref_1 post: - description: Generates recommended DataQualityRule from a data profiling DataScan. + description: >- + Generates recommended data quality rules based on the results of a data + profiling scan.Use the recommendations to build rules for a data quality + scan. operationId: dataplex.projects.locations.dataScans.generateDataQualityRules requestBody: content: @@ -12984,7 +14043,685 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDataplexV1GenerateDataQualityRulesResponse + #/components/schemas/GoogleCloudDataplexV1GenerateDataQualityRulesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataScansId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}: + parameters: *ref_1 + get: + description: Gets a DataScanJob resource. + operationId: dataplex.projects.locations.dataScans.jobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataScansId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string + - in: query + name: view + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs: + parameters: *ref_1 + get: + description: Lists DataScanJobs under the given DataScan. + operationId: dataplex.projects.locations.dataScans.jobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListDataScanJobsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataScansId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules: + parameters: *ref_1 + post: + description: >- + Generates recommended data quality rules based on the results of a data + profiling scan.Use the recommendations to build rules for a data quality + scan. + operationId: dataplex.projects.locations.dataScans.jobs.generateDataQualityRules + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1GenerateDataQualityRulesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1GenerateDataQualityRulesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataScansId + required: true + schema: + type: string + - in: path + name: jobsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.dataTaxonomies.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.dataTaxonomies.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: dataplex.projects.locations.dataTaxonomies.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies: + parameters: *ref_1 + post: + description: Create a DataTaxonomy resource. + operationId: dataplex.projects.locations.dataTaxonomies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: dataTaxonomyId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists DataTaxonomy resources in a project and location. + operationId: dataplex.projects.locations.dataTaxonomies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListDataTaxonomiesResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}: + parameters: *ref_1 + patch: + description: Updates a DataTaxonomy resource. + operationId: dataplex.projects.locations.dataTaxonomies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + delete: + description: >- + Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy + must be deleted before the DataTaxonomy can be deleted. + operationId: dataplex.projects.locations.dataTaxonomies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + get: + description: Retrieves a DataTaxonomy resource. + operationId: dataplex.projects.locations.dataTaxonomies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + - in: path + name: attributesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes: + parameters: *ref_1 + post: + description: Create a DataAttribute resource. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataTaxonomiesId + required: true + schema: + type: string + - in: query + name: dataAttributeId + schema: + type: string + - in: query + name: validateOnly + schema: + type: boolean + get: + description: Lists Data Attribute resources in a DataTaxonomy. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDataplexV1ListDataAttributesResponse parameters: - in: path name: projectsId @@ -12997,15 +14734,37 @@ paths: schema: type: string - in: path - name: dataScansId + name: dataTaxonomiesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}: - parameters: *ref_81 - get: - description: Gets a DataScanJob resource. - operationId: dataplex.projects.locations.dataScans.jobs.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}: + parameters: *ref_1 + patch: + description: Updates a DataAttribute resource. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13017,7 +14776,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataScanJob' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -13030,24 +14789,27 @@ paths: schema: type: string - in: path - name: dataScansId + name: dataTaxonomiesId required: true schema: type: string - in: path - name: jobsId + name: attributesId required: true schema: type: string - in: query - name: view + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs: - parameters: *ref_81 - get: - description: Lists DataScanJobs under the given DataScan. - operationId: dataplex.projects.locations.dataScans.jobs.list + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + delete: + description: Deletes a Data Attribute resource. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13059,8 +14821,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListDataScanJobsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -13073,34 +14834,22 @@ paths: schema: type: string - in: path - name: dataScansId + name: dataTaxonomiesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: attributesId + required: true schema: type: string - in: query - name: filter + name: etag schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules: - parameters: *ref_81 - post: - description: Generates recommended DataQualityRule from a data profiling DataScan. - operationId: dataplex.projects.locations.dataScans.jobs.generateDataQualityRules - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1GenerateDataQualityRulesRequest + get: + description: Retrieves a Data Attribute resource. + operationId: dataplex.projects.locations.dataTaxonomies.attributes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13112,8 +14861,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1GenerateDataQualityRulesResponse + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' parameters: - in: path name: projectsId @@ -13126,23 +14874,23 @@ paths: schema: type: string - in: path - name: dataScansId + name: dataTaxonomiesId required: true schema: type: string - in: path - name: jobsId + name: attributesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:setIamPolicy: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:setIamPolicy: + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.dataTaxonomies.setIamPolicy + operationId: dataplex.projects.locations.dataAttributeBindings.setIamPolicy requestBody: content: application/json: @@ -13172,17 +14920,17 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: dataAttributeBindingsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:getIamPolicy: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:getIamPolicy: + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.dataTaxonomies.getIamPolicy + operationId: dataplex.projects.locations.dataAttributeBindings.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13207,7 +14955,7 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: dataAttributeBindingsId required: true schema: type: string @@ -13216,8 +14964,8 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:testIamPermissions: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:testIamPermissions: + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -13225,7 +14973,7 @@ paths: 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. - operationId: dataplex.projects.locations.dataTaxonomies.testIamPermissions + operationId: dataplex.projects.locations.dataAttributeBindings.testIamPermissions requestBody: content: application/json: @@ -13255,20 +15003,20 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: dataAttributeBindingsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings: + parameters: *ref_1 post: - description: Create a DataTaxonomy resource. - operationId: dataplex.projects.locations.dataTaxonomies.create + description: Create a DataAttributeBinding resource. + operationId: dataplex.projects.locations.dataAttributeBindings.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13293,7 +15041,7 @@ paths: schema: type: string - in: query - name: dataTaxonomyId + name: dataAttributeBindingId schema: type: string - in: query @@ -13301,8 +15049,8 @@ paths: schema: type: boolean get: - description: Lists DataTaxonomy resources in a project and location. - operationId: dataplex.projects.locations.dataTaxonomies.list + description: Lists DataAttributeBinding resources in a project and location. + operationId: dataplex.projects.locations.dataAttributeBindings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13315,7 +15063,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListDataTaxonomiesResponse + #/components/schemas/GoogleCloudDataplexV1ListDataAttributeBindingsResponse parameters: - in: path name: projectsId @@ -13344,16 +15092,16 @@ paths: name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}: + parameters: *ref_1 patch: - description: Updates a DataTaxonomy resource. - operationId: dataplex.projects.locations.dataTaxonomies.patch + description: Updates a DataAttributeBinding resource. + operationId: dataplex.projects.locations.dataAttributeBindings.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13378,7 +15126,7 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: dataAttributeBindingsId required: true schema: type: string @@ -13393,9 +15141,10 @@ paths: type: boolean delete: description: >- - Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy - must be deleted before the DataTaxonomy can be deleted. - operationId: dataplex.projects.locations.dataTaxonomies.delete + Deletes a DataAttributeBinding resource. All attributes within the + DataAttributeBinding must be deleted before the DataAttributeBinding can + be deleted. + operationId: dataplex.projects.locations.dataAttributeBindings.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13420,7 +15169,7 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: dataAttributeBindingsId required: true schema: type: string @@ -13429,8 +15178,8 @@ paths: schema: type: string get: - description: Retrieves a DataTaxonomy resource. - operationId: dataplex.projects.locations.dataTaxonomies.get + description: Retrieves a DataAttributeBinding resource. + operationId: dataplex.projects.locations.dataAttributeBindings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13442,7 +15191,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataTaxonomy' + $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' parameters: - in: path name: projectsId @@ -13455,18 +15204,18 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: dataAttributeBindingsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:setIamPolicy: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:setIamPolicy: + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.setIamPolicy + operationId: dataplex.projects.locations.entryLinkTypes.setIamPolicy requestBody: content: application/json: @@ -13496,22 +15245,17 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId - required: true - schema: - type: string - - in: path - name: attributesId + name: entryLinkTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:getIamPolicy: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:getIamPolicy: + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.getIamPolicy + operationId: dataplex.projects.locations.entryLinkTypes.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13536,12 +15280,7 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId - required: true - schema: - type: string - - in: path - name: attributesId + name: entryLinkTypesId required: true schema: type: string @@ -13550,8 +15289,8 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:testIamPermissions: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/entryLinkTypes/{entryLinkTypesId}:testIamPermissions: + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -13559,7 +15298,7 @@ paths: 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. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.testIamPermissions + operationId: dataplex.projects.locations.entryLinkTypes.testIamPermissions requestBody: content: application/json: @@ -13589,25 +15328,23 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId - required: true - schema: - type: string - - in: path - name: attributesId + name: entryLinkTypesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:setIamPolicy: + parameters: *ref_1 post: - description: Create a DataAttribute resource. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.create + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.governanceRules.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13619,7 +15356,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -13632,21 +15369,17 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: governanceRulesId required: true schema: type: string - - in: query - name: dataAttributeId - schema: - type: string - - in: query - name: validateOnly - schema: - type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:getIamPolicy: + parameters: *ref_1 get: - description: Lists Data Attribute resources in a DataTaxonomy. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.list + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.governanceRules.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13658,8 +15391,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListDataAttributesResponse + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -13672,37 +15404,71 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId + name: governanceRulesId required: true schema: type: string - in: query - name: pageSize + name: options.requestedPolicyVersion schema: type: integer format: int32 - - in: query - name: pageToken + /v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: dataplex.projects.locations.governanceRules.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: governanceRulesId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}: - parameters: *ref_81 - patch: - description: Updates a DataAttribute resource. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.patch + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.glossaries.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13714,7 +15480,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -13727,27 +15493,17 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId - required: true - schema: - type: string - - in: path - name: attributesId + name: glossariesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean - delete: - description: Deletes a Data Attribute resource. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.delete + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.glossaries.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13759,7 +15515,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -13772,22 +15528,30 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId - required: true - schema: - type: string - - in: path - name: attributesId + name: glossariesId required: true schema: type: string - in: query - name: etag + name: options.requestedPolicyVersion schema: - type: string - get: - description: Retrieves a Data Attribute resource. - operationId: dataplex.projects.locations.dataTaxonomies.attributes.get + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: dataplex.projects.locations.glossaries.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13799,7 +15563,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttribute' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -13812,23 +15576,18 @@ paths: schema: type: string - in: path - name: dataTaxonomiesId - required: true - schema: - type: string - - in: path - name: attributesId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:setIamPolicy: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:setIamPolicy: + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.dataAttributeBindings.setIamPolicy + operationId: dataplex.projects.locations.glossaries.categories.setIamPolicy requestBody: content: application/json: @@ -13858,17 +15617,22 @@ paths: schema: type: string - in: path - name: dataAttributeBindingsId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:getIamPolicy: - parameters: *ref_81 + - in: path + name: categoriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:getIamPolicy: + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.dataAttributeBindings.getIamPolicy + operationId: dataplex.projects.locations.glossaries.categories.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13893,7 +15657,12 @@ paths: schema: type: string - in: path - name: dataAttributeBindingsId + name: glossariesId + required: true + schema: + type: string + - in: path + name: categoriesId required: true schema: type: string @@ -13902,8 +15671,8 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:testIamPermissions: - parameters: *ref_81 + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/categories/{categoriesId}:testIamPermissions: + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -13911,7 +15680,7 @@ paths: 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. - operationId: dataplex.projects.locations.dataAttributeBindings.testIamPermissions + operationId: dataplex.projects.locations.glossaries.categories.testIamPermissions requestBody: content: application/json: @@ -13941,20 +15710,28 @@ paths: schema: type: string - in: path - name: dataAttributeBindingsId + name: glossariesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings: - parameters: *ref_81 + - in: path + name: categoriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:setIamPolicy: + parameters: *ref_1 post: - description: Create a DataAttributeBinding resource. - operationId: dataplex.projects.locations.dataAttributeBindings.create + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: dataplex.projects.locations.glossaries.terms.setIamPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13966,7 +15743,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -13978,17 +15755,23 @@ paths: required: true schema: type: string - - in: query - name: dataAttributeBindingId + - in: path + name: glossariesId + required: true schema: type: string - - in: query - name: validateOnly + - in: path + name: termsId + required: true schema: - type: boolean + type: string + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:getIamPolicy: + parameters: *ref_1 get: - description: Lists DataAttributeBinding resources in a project and location. - operationId: dataplex.projects.locations.dataAttributeBindings.list + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: dataplex.projects.locations.glossaries.terms.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14000,8 +15783,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDataplexV1ListDataAttributeBindingsResponse + $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path name: projectsId @@ -14013,33 +15795,36 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: glossariesId + required: true schema: type: string - - in: query - name: filter + - in: path + name: termsId + required: true schema: type: string - in: query - name: orderBy + name: options.requestedPolicyVersion schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}: - parameters: *ref_81 - patch: - description: Updates a DataAttributeBinding resource. - operationId: dataplex.projects.locations.dataAttributeBindings.patch + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/terms/{termsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: dataplex.projects.locations.glossaries.terms.testIamPermissions requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14051,7 +15836,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path name: projectsId @@ -14064,25 +15849,23 @@ paths: schema: type: string - in: path - name: dataAttributeBindingsId + name: glossariesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: termsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean - delete: + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a DataAttributeBinding resource. All attributes within the - DataAttributeBinding must be deleted before the DataAttributeBinding can - be deleted. - operationId: dataplex.projects.locations.dataAttributeBindings.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: dataplex.organizations.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14097,7 +15880,7 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -14107,17 +15890,64 @@ paths: schema: type: string - in: path - name: dataAttributeBindingsId + name: operationsId required: true schema: type: string - - in: query - name: etag + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + google.rpc.Code.UNIMPLEMENTED. + operationId: dataplex.organizations.locations.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: organizationsId + required: true schema: type: string - get: - description: Retrieves a DataAttributeBinding resource. - operationId: dataplex.projects.locations.dataAttributeBindings.get + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to Code.CANCELLED. + operationId: dataplex.organizations.locations.operations.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14129,10 +15959,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDataplexV1DataAttributeBinding' + $ref: '#/components/schemas/Empty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -14142,18 +15972,18 @@ paths: schema: type: string - in: path - name: dataAttributeBindingsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:setIamPolicy: - parameters: *ref_81 + /v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:setIamPolicy: + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - operationId: dataplex.projects.locations.governanceRules.setIamPolicy + operationId: dataplex.organizations.locations.encryptionConfigs.setIamPolicy requestBody: content: application/json: @@ -14173,7 +16003,7 @@ paths: $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -14183,17 +16013,17 @@ paths: schema: type: string - in: path - name: governanceRulesId + name: encryptionConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:getIamPolicy: - parameters: *ref_81 + /v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:getIamPolicy: + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - operationId: dataplex.projects.locations.governanceRules.getIamPolicy + operationId: dataplex.organizations.locations.encryptionConfigs.getIamPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14208,7 +16038,7 @@ paths: $ref: '#/components/schemas/GoogleIamV1Policy' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -14218,7 +16048,7 @@ paths: schema: type: string - in: path - name: governanceRulesId + name: encryptionConfigsId required: true schema: type: string @@ -14227,8 +16057,8 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/governanceRules/{governanceRulesId}:testIamPermissions: - parameters: *ref_81 + /v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:testIamPermissions: + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -14236,7 +16066,7 @@ paths: 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. - operationId: dataplex.projects.locations.governanceRules.testIamPermissions + operationId: dataplex.organizations.locations.encryptionConfigs.testIamPermissions requestBody: content: application/json: @@ -14256,7 +16086,7 @@ paths: $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -14266,7 +16096,7 @@ paths: schema: type: string - in: path - name: governanceRulesId + name: encryptionConfigsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml b/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml index b42b6bae..c7182131 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dataproc.yaml @@ -7,8 +7,8 @@ info: title: Cloud Dataproc API description: Manages Hadoop-based clusters and jobs on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240525' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dataproc/ servers: @@ -795,6 +795,14 @@ components: repositoryConfig: description: Optional. Dependency repository configuration. $ref: '#/components/schemas/RepositoryConfig' + autotuningConfig: + description: Optional. Autotuning configuration of the workload. + $ref: '#/components/schemas/AutotuningConfig' + cohort: + description: >- + Optional. Cohort identifier. Identifies families of the workloads + having the same shape, e.g. daily ETL jobs. + type: string RepositoryConfig: id: RepositoryConfig description: Configuration for dependency repositories @@ -811,6 +819,26 @@ components: pypiRepository: description: Optional. PyPi repository address type: string + AutotuningConfig: + id: AutotuningConfig + description: Autotuning configuration of the workload. + type: object + properties: + scenarios: + description: Optional. Scenarios for which tunings are applied. + type: array + items: + type: string + enumDescriptions: + - Default value. + - Scaling recommendations such as initialExecutors. + - Adding hints for potential relation broadcasts. + - Memory management for workloads. + enum: + - SCENARIO_UNSPECIFIED + - SCALING + - BROADCAST_HASH_JOIN + - MEMORY EnvironmentConfig: id: EnvironmentConfig description: Environment configuration for a workload. @@ -1250,9 +1278,9 @@ components: type: string tags: description: >- - The Compute Engine tags to add to all instances (see Tagging + The Compute Engine network tags to add to all instances (see Tagging instances - (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). + (https://cloud.google.com/vpc/docs/add-remove-network-tags)). type: array items: type: string @@ -1551,6 +1579,22 @@ components: (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance). type: string + bootDiskProvisionedIops: + description: >- + Optional. Indicates how many IOPS to provision for the disk. This + sets the number of I/O operations per second that the disk can + handle. Note: This field is only supported if boot_disk_type is + hyperdisk-balanced. + type: string + format: int64 + bootDiskProvisionedThroughput: + description: >- + Optional. Indicates how much throughput to provision for the disk. + This sets the number of throughput mb per second that the disk can + handle. Values must be greater than or equal to 1. Note: This field + is only supported if boot_disk_type is hyperdisk-balanced. + type: string + format: int64 ManagedGroupConfig: id: ManagedGroupConfig description: Specifies the resources used to actively manage an instance group. @@ -1683,7 +1727,7 @@ components: description: >- Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions - (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions), + (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported-dataproc-image-versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). @@ -1713,9 +1757,11 @@ components: Unspecified component. Specifying this will cause Cluster creation to fail. - >- - The Anaconda python distribution. The Anaconda component is not - supported in the Dataproc 2.0 image. The 2.0 image is - pre-installed with Miniconda. + The Anaconda component is no longer supported or applicable to + supported Dataproc on Compute Engine image versions + (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-version-clusters#supported-dataproc-image-versions). + It cannot be activated on clusters created with supported + Dataproc on Compute Engine image versions. - Docker - The Druid query engine. (alpha) - Flink @@ -3684,6 +3730,9 @@ components: jupyterSession: description: Optional. Jupyter session config. $ref: '#/components/schemas/JupyterConfig' + sparkConnectSession: + description: Optional. Spark connect session config. + $ref: '#/components/schemas/SparkConnectConfig' runtimeInfo: description: Output only. Runtime information about session execution. readOnly: true @@ -3776,6 +3825,11 @@ components: displayName: description: Optional. Display name, shown in the Jupyter kernelspec card. type: string + SparkConnectConfig: + id: SparkConnectConfig + description: Spark connect configuration for an interactive session. + type: object + properties: {} SessionStateHistory: id: SessionStateHistory description: Historical state information. @@ -3864,6 +3918,9 @@ components: jupyterSession: description: Optional. Jupyter session config. $ref: '#/components/schemas/JupyterConfig' + sparkConnectSession: + description: Optional. Spark connect session config. + $ref: '#/components/schemas/SparkConnectConfig' creator: description: Output only. The email address of the user who created the template. readOnly: true @@ -4959,6 +5016,8 @@ components: - Resize node group operation type. - Repair node group operation type. - Update node group label operation type. + - Start node group operation type. + - Stop node group operation type. enum: - NODE_GROUP_OPERATION_TYPE_UNSPECIFIED - CREATE @@ -4967,6 +5026,8 @@ components: - RESIZE - REPAIR - UPDATE_LABELS + - START + - STOP description: description: Output only. Short description of operation. readOnly: true @@ -5239,17 +5300,14 @@ components: name: operations title: Operations methods: - _projects_regions_operations_list: - operation: &ref_1 + projects_regions_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_regions_operations_list: - operation: *ref_1 - response: *ref_2 projects_regions_operations_get: operation: $ref: >- @@ -5271,17 +5329,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -5315,6 +5370,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_regions_operations_delete @@ -5332,17 +5388,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_operations_get_iam_policy: - operation: &ref_5 + projects_regions_operations_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1operations~1{operationsId}:getIamPolicy/post - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_regions_operations_get_iam_policy: - operation: *ref_5 - response: *ref_6 projects_regions_operations_test_iam_permissions: operation: $ref: >- @@ -5356,6 +5409,9 @@ components: #/components/x-stackQL-resources/operations_iam_policies/methods/projects_regions_operations_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/operations_iam_policies/methods/projects_regions_operations_set_iam_policy delete: [] autoscaling_policies: id: google.dataproc.autoscaling_policies @@ -5369,17 +5425,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_autoscaling_policies_list: - operation: &ref_7 + projects_regions_autoscaling_policies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1autoscalingPolicies/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - projects_regions_autoscaling_policies_list: - operation: *ref_7 - response: *ref_8 projects_regions_autoscaling_policies_update: operation: $ref: >- @@ -5408,17 +5461,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_autoscaling_policies_list: - operation: &ref_9 + projects_locations_autoscaling_policies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autoscalingPolicies/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - projects_locations_autoscaling_policies_list: - operation: *ref_9 - response: *ref_10 projects_locations_autoscaling_policies_update: operation: $ref: >- @@ -5455,7 +5505,8 @@ components: #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_create - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_locations_autoscaling_policies_create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/autoscaling_policies/methods/projects_regions_autoscaling_policies_update - $ref: >- @@ -5477,17 +5528,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_autoscaling_policies_get_iam_policy: - operation: &ref_11 + projects_regions_autoscaling_policies_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1autoscalingPolicies~1{autoscalingPoliciesId}:getIamPolicy/post - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_regions_autoscaling_policies_get_iam_policy: - operation: *ref_11 - response: *ref_12 projects_regions_autoscaling_policies_test_iam_permissions: operation: $ref: >- @@ -5502,17 +5550,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_autoscaling_policies_get_iam_policy: - operation: &ref_13 + projects_locations_autoscaling_policies_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1autoscalingPolicies~1{autoscalingPoliciesId}:getIamPolicy/post - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_autoscaling_policies_get_iam_policy: - operation: *ref_13 - response: *ref_14 projects_locations_autoscaling_policies_test_iam_permissions: operation: $ref: >- @@ -5528,6 +5573,11 @@ components: #/components/x-stackQL-resources/autoscaling_policies_iam_policies/methods/projects_locations_autoscaling_policies_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/autoscaling_policies_iam_policies/methods/projects_regions_autoscaling_policies_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/autoscaling_policies_iam_policies/methods/projects_locations_autoscaling_policies_set_iam_policy delete: [] clusters: id: google.dataproc.clusters @@ -5541,17 +5591,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_clusters_list: - operation: &ref_15 + projects_regions_clusters_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectId}~1regions~1{region}~1clusters/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clusters - projects_regions_clusters_list: - operation: *ref_15 - response: *ref_16 projects_regions_clusters_patch: operation: $ref: >- @@ -5620,6 +5667,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/clusters/methods/projects_regions_clusters_delete @@ -5635,17 +5683,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_clusters_get_iam_policy: - operation: &ref_17 + projects_regions_clusters_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1clusters~1{clustersId}:getIamPolicy/post - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_regions_clusters_get_iam_policy: - operation: *ref_17 - response: *ref_18 projects_regions_clusters_test_iam_permissions: operation: $ref: >- @@ -5659,6 +5704,9 @@ components: #/components/x-stackQL-resources/clusters_iam_policies/methods/projects_regions_clusters_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/clusters_iam_policies/methods/projects_regions_clusters_set_iam_policy delete: [] node_groups: id: google.dataproc.node_groups @@ -5701,6 +5749,7 @@ components: - $ref: >- #/components/x-stackQL-resources/node_groups/methods/projects_regions_clusters_node_groups_create update: [] + replace: [] delete: [] jobs: id: google.dataproc.jobs @@ -5742,16 +5791,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_jobs_list: - operation: &ref_19 + projects_regions_jobs_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectId}~1regions~1{region}~1jobs/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - projects_regions_jobs_list: - operation: *ref_19 - response: *ref_20 projects_regions_jobs_cancel: operation: $ref: >- @@ -5769,6 +5815,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_regions_jobs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/jobs/methods/projects_regions_jobs_delete @@ -5784,17 +5831,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_jobs_get_iam_policy: - operation: &ref_21 + projects_regions_jobs_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1jobs~1{jobsId}:getIamPolicy/post - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_regions_jobs_get_iam_policy: - operation: *ref_21 - response: *ref_22 projects_regions_jobs_test_iam_permissions: operation: $ref: >- @@ -5808,6 +5852,9 @@ components: #/components/x-stackQL-resources/jobs_iam_policies/methods/projects_regions_jobs_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/jobs_iam_policies/methods/projects_regions_jobs_set_iam_policy delete: [] workflow_templates: id: google.dataproc.workflow_templates @@ -5821,17 +5868,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_workflow_templates_list: - operation: &ref_23 + projects_regions_workflow_templates_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1workflowTemplates/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.templates - projects_regions_workflow_templates_list: - operation: *ref_23 - response: *ref_24 projects_regions_workflow_templates_get: operation: $ref: >- @@ -5874,17 +5918,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_workflow_templates_list: - operation: &ref_25 + projects_locations_workflow_templates_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflowTemplates/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.templates - projects_locations_workflow_templates_list: - operation: *ref_25 - response: *ref_26 projects_locations_workflow_templates_get: operation: $ref: >- @@ -5935,7 +5976,8 @@ components: #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_create - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_locations_workflow_templates_create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/workflow_templates/methods/projects_regions_workflow_templates_update - $ref: >- @@ -5957,17 +5999,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_regions_workflow_templates_get_iam_policy: - operation: &ref_27 + projects_regions_workflow_templates_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1regions~1{regionsId}~1workflowTemplates~1{workflowTemplatesId}:getIamPolicy/post - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_regions_workflow_templates_get_iam_policy: - operation: *ref_27 - response: *ref_28 projects_regions_workflow_templates_test_iam_permissions: operation: $ref: >- @@ -5982,17 +6021,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_workflow_templates_get_iam_policy: - operation: &ref_29 + projects_locations_workflow_templates_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflowTemplates~1{workflowTemplatesId}:getIamPolicy/post - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_workflow_templates_get_iam_policy: - operation: *ref_29 - response: *ref_30 projects_locations_workflow_templates_test_iam_permissions: operation: $ref: >- @@ -6008,6 +6044,11 @@ components: #/components/x-stackQL-resources/workflow_templates_iam_policies/methods/projects_locations_workflow_templates_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/workflow_templates_iam_policies/methods/projects_regions_workflow_templates_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/workflow_templates_iam_policies/methods/projects_locations_workflow_templates_set_iam_policy delete: [] batches: id: google.dataproc.batches @@ -6028,17 +6069,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_batches_list: - operation: &ref_31 + projects_locations_batches_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1batches/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.batches - projects_locations_batches_list: - operation: *ref_31 - response: *ref_32 projects_locations_batches_get: operation: $ref: >- @@ -6063,6 +6101,7 @@ components: - $ref: >- #/components/x-stackQL-resources/batches/methods/projects_locations_batches_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/batches/methods/projects_locations_batches_delete @@ -6078,17 +6117,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_sessions_list: - operation: &ref_33 + projects_locations_sessions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sessions/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sessions - projects_locations_sessions_list: - operation: *ref_33 - response: *ref_34 projects_locations_sessions_get: operation: $ref: >- @@ -6120,6 +6156,7 @@ components: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_sessions_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_locations_sessions_delete @@ -6135,17 +6172,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_session_templates_list: - operation: &ref_35 + projects_locations_session_templates_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sessionTemplates/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sessionTemplates - projects_locations_session_templates_list: - operation: *ref_35 - response: *ref_36 projects_locations_session_templates_patch: operation: $ref: >- @@ -6179,12 +6213,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/session_templates/methods/projects_locations_session_templates_delete paths: /v1/projects/{projectsId}/regions/{regionsId}/operations: - parameters: &ref_37 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -6238,7 +6273,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}: - parameters: *ref_37 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -6309,7 +6344,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -6351,7 +6386,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:setIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6392,7 +6427,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:getIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6432,7 +6467,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:testIamPermissions: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6475,7 +6510,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies: - parameters: *ref_37 + parameters: *ref_1 post: description: Creates new autoscaling policy. operationId: dataproc.projects.regions.autoscalingPolicies.create @@ -6543,7 +6578,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}: - parameters: *ref_37 + parameters: *ref_1 put: description: >- Updates (replaces) autoscaling policy.Disabled check for update_mask, @@ -6647,7 +6682,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6688,7 +6723,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6728,7 +6763,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6771,7 +6806,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/clusters: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Creates a cluster in a project. The returned Operation.metadata will be @@ -6854,7 +6889,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}: - parameters: *ref_37 + parameters: *ref_1 patch: description: >- Updates a cluster in a project. The returned Operation.metadata will be @@ -6988,7 +7023,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop: - parameters: *ref_37 + parameters: *ref_1 post: description: Stops a cluster in a project. operationId: dataproc.projects.regions.clusters.stop @@ -7026,7 +7061,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start: - parameters: *ref_37 + parameters: *ref_1 post: description: Starts a cluster in a project. operationId: dataproc.projects.regions.clusters.start @@ -7064,7 +7099,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:repair: - parameters: *ref_37 + parameters: *ref_1 post: description: Repairs a cluster. operationId: dataproc.projects.regions.clusters.repair @@ -7102,7 +7137,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets cluster diagnostic information. The returned Operation.metadata @@ -7146,7 +7181,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:injectCredentials: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Inject encrypted credentials into all of the VMs in a cluster.The target @@ -7187,7 +7222,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7228,7 +7263,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7268,7 +7303,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7311,7 +7346,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Creates a node group in a cluster. The returned Operation.metadata is @@ -7364,7 +7399,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}:resize: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Resizes a node group in a cluster. The returned Operation.metadata is @@ -7410,7 +7445,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}:repair: - parameters: *ref_37 + parameters: *ref_1 post: description: Repair nodes in a node group. operationId: dataproc.projects.regions.clusters.nodeGroups.repair @@ -7453,7 +7488,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}: - parameters: *ref_37 + parameters: *ref_1 get: description: Gets the resource representation for a node group in a cluster. operationId: dataproc.projects.regions.clusters.nodeGroups.get @@ -7491,7 +7526,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/jobs:submit: - parameters: *ref_37 + parameters: *ref_1 post: description: Submits a job to a cluster. operationId: dataproc.projects.regions.jobs.submit @@ -7524,7 +7559,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation: - parameters: *ref_37 + parameters: *ref_1 post: description: Submits job to a cluster. operationId: dataproc.projects.regions.jobs.submitAsOperation @@ -7557,7 +7592,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/jobs/{jobId}: - parameters: *ref_37 + parameters: *ref_1 get: description: Gets the resource representation for a job in a project. operationId: dataproc.projects.regions.jobs.get @@ -7664,7 +7699,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/jobs: - parameters: *ref_37 + parameters: *ref_1 get: description: Lists regions/{region}/jobs in a project. operationId: dataproc.projects.regions.jobs.list @@ -7713,7 +7748,7 @@ paths: schema: type: string /v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Starts a job cancellation request. To access the job resource after @@ -7756,7 +7791,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:setIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7797,7 +7832,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:getIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7837,7 +7872,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:testIamPermissions: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7880,7 +7915,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates: - parameters: *ref_37 + parameters: *ref_1 post: description: Creates new workflow template. operationId: dataproc.projects.regions.workflowTemplates.create @@ -7948,7 +7983,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}: - parameters: *ref_37 + parameters: *ref_1 get: description: >- Retrieves the latest workflow template.Can retrieve previously @@ -8062,7 +8097,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Instantiates a template and begins execution.The returned Operation can @@ -8110,7 +8145,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates:instantiateInline: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Instantiates a template and begins execution.This method is equivalent @@ -8159,7 +8194,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8200,7 +8235,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -8240,7 +8275,7 @@ paths: schema: type: string /v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -8283,7 +8318,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_37 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -8326,7 +8361,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_37 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8397,7 +8432,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -8439,7 +8474,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}:analyze: - parameters: *ref_37 + parameters: *ref_1 post: description: Analyze a Batch for possible recommendations and insights. operationId: dataproc.projects.locations.batches.analyze @@ -8477,7 +8512,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/batches: - parameters: *ref_37 + parameters: *ref_1 post: description: Creates a batch workload that executes asynchronously. operationId: dataproc.projects.locations.batches.create @@ -8561,7 +8596,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}: - parameters: *ref_37 + parameters: *ref_1 get: description: Gets the batch workload resource representation. operationId: dataproc.projects.locations.batches.get @@ -8628,7 +8663,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies: - parameters: *ref_37 + parameters: *ref_1 post: description: Creates new autoscaling policy. operationId: dataproc.projects.locations.autoscalingPolicies.create @@ -8696,7 +8731,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}: - parameters: *ref_37 + parameters: *ref_1 put: description: >- Updates (replaces) autoscaling policy.Disabled check for update_mask, @@ -8800,7 +8835,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8841,7 +8876,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -8881,7 +8916,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -8924,7 +8959,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sessions: - parameters: *ref_37 + parameters: *ref_1 post: description: Create an interactive session asynchronously. operationId: dataproc.projects.locations.sessions.create @@ -9004,7 +9039,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}: - parameters: *ref_37 + parameters: *ref_1 get: description: Gets the resource representation for an interactive session. operationId: dataproc.projects.locations.sessions.get @@ -9074,7 +9109,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}:terminate: - parameters: *ref_37 + parameters: *ref_1 post: description: Terminates the interactive session. operationId: dataproc.projects.locations.sessions.terminate @@ -9112,7 +9147,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates: - parameters: *ref_37 + parameters: *ref_1 post: description: Create a session template synchronously. operationId: dataproc.projects.locations.sessionTemplates.create @@ -9184,7 +9219,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}: - parameters: *ref_37 + parameters: *ref_1 patch: description: Updates the session template synchronously. operationId: dataproc.projects.locations.sessionTemplates.patch @@ -9284,7 +9319,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates: - parameters: *ref_37 + parameters: *ref_1 post: description: Creates new workflow template. operationId: dataproc.projects.locations.workflowTemplates.create @@ -9352,7 +9387,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}: - parameters: *ref_37 + parameters: *ref_1 get: description: >- Retrieves the latest workflow template.Can retrieve previously @@ -9466,7 +9501,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Instantiates a template and begins execution.The returned Operation can @@ -9514,7 +9549,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates:instantiateInline: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Instantiates a template and begins execution.This method is equivalent @@ -9563,7 +9598,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -9604,7 +9639,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -9644,7 +9679,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions: - parameters: *ref_37 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml b/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml index cad6dfef..622137d9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datastore.yaml @@ -9,8 +9,8 @@ info: Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. version: v1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/datastore/ servers: @@ -2311,22 +2311,20 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] operations: id: google.datastore.operations name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -2354,6 +2352,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' indexes: @@ -2367,16 +2366,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectId}~1indexes/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.indexes - list: - operation: *ref_3 - response: *ref_4 delete: operation: $ref: '#/paths/~1v1~1projects~1{projectId}~1indexes~1{indexId}/delete' @@ -2396,11 +2392,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/indexes/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' paths: /v1/projects/{projectId}:export: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2451,7 +2448,7 @@ paths: schema: type: string /v1/projects/{projectId}:import: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Imports entities into Google Cloud Datastore. Existing entities with the @@ -2488,7 +2485,7 @@ paths: schema: type: string /v1/projects/{projectId}:lookup: - parameters: *ref_5 + parameters: *ref_1 post: description: Looks up entities by key. operationId: datastore.projects.lookup @@ -2520,7 +2517,7 @@ paths: schema: type: string /v1/projects/{projectId}:runQuery: - parameters: *ref_5 + parameters: *ref_1 post: description: Queries for entities. operationId: datastore.projects.runQuery @@ -2552,7 +2549,7 @@ paths: schema: type: string /v1/projects/{projectId}:runAggregationQuery: - parameters: *ref_5 + parameters: *ref_1 post: description: Runs an aggregation query. operationId: datastore.projects.runAggregationQuery @@ -2584,7 +2581,7 @@ paths: schema: type: string /v1/projects/{projectId}:beginTransaction: - parameters: *ref_5 + parameters: *ref_1 post: description: Begins a new transaction. operationId: datastore.projects.beginTransaction @@ -2616,7 +2613,7 @@ paths: schema: type: string /v1/projects/{projectId}:commit: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Commits a transaction, optionally creating, deleting or modifying some @@ -2650,7 +2647,7 @@ paths: schema: type: string /v1/projects/{projectId}:rollback: - parameters: *ref_5 + parameters: *ref_1 post: description: Rolls back a transaction. operationId: datastore.projects.rollback @@ -2682,7 +2679,7 @@ paths: schema: type: string /v1/projects/{projectId}:allocateIds: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Allocates IDs for the given keys, which is useful for referencing an @@ -2716,7 +2713,7 @@ paths: schema: type: string /v1/projects/{projectId}:reserveIds: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Prevents the supplied keys' IDs from being auto-allocated by Cloud @@ -2750,7 +2747,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2792,7 +2789,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2861,7 +2858,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}:cancel: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2902,7 +2899,7 @@ paths: schema: type: string /v1/projects/{projectId}/indexes: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Creates the specified index. A newly created index's initial state is @@ -2983,7 +2980,7 @@ paths: schema: type: string /v1/projects/{projectId}/indexes/{indexId}: - parameters: *ref_5 + parameters: *ref_1 delete: description: >- Deletes an existing index. An index can only be deleted if it is in a diff --git a/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml b/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml index 9c3a6b2c..6e724ebb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/datastream.yaml @@ -7,8 +7,8 @@ info: title: Datastream API description: '' version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240826' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/datastream/ servers: @@ -450,6 +450,9 @@ components: postgresqlRdbms: description: PostgreSQL RDBMS to enrich with child data objects and metadata. $ref: '#/components/schemas/PostgresqlRdbms' + sqlServerRdbms: + description: SQLServer RDBMS to enrich with child data objects and metadata. + $ref: '#/components/schemas/SqlServerRdbms' OracleRdbms: id: OracleRdbms description: Oracle database structure. @@ -671,6 +674,77 @@ components: description: The ordinal position of the column in the table. type: integer format: int32 + SqlServerRdbms: + id: SqlServerRdbms + description: SQLServer database structure. + type: object + properties: + schemas: + description: SQLServer schemas in the database server. + type: array + items: + $ref: '#/components/schemas/SqlServerSchema' + SqlServerSchema: + id: SqlServerSchema + description: SQLServer schema. + type: object + properties: + schema: + description: Schema name. + type: string + tables: + description: Tables in the schema. + type: array + items: + $ref: '#/components/schemas/SqlServerTable' + SqlServerTable: + id: SqlServerTable + description: SQLServer table. + type: object + properties: + table: + description: Table name. + type: string + columns: + description: >- + SQLServer columns in the schema. When unspecified as part of + include/exclude objects, includes/excludes everything. + type: array + items: + $ref: '#/components/schemas/SqlServerColumn' + SqlServerColumn: + id: SqlServerColumn + description: SQLServer Column. + type: object + properties: + column: + description: Column name. + type: string + dataType: + description: The SQLServer data type. + type: string + length: + description: Column length. + type: integer + format: int32 + precision: + description: Column precision. + type: integer + format: int32 + scale: + description: Column scale. + type: integer + format: int32 + primaryKey: + description: Whether or not the column represents a primary key. + type: boolean + nullable: + description: Whether or not the column can accept a null value. + type: boolean + ordinalPosition: + description: The ordinal position of the column in the table. + type: integer + format: int32 DiscoverConnectionProfileResponse: id: DiscoverConnectionProfileResponse description: Response from a discover request. @@ -685,6 +759,9 @@ components: postgresqlRdbms: description: Enriched PostgreSQL RDBMS object. $ref: '#/components/schemas/PostgresqlRdbms' + sqlServerRdbms: + description: Enriched SQLServer RDBMS object. + $ref: '#/components/schemas/SqlServerRdbms' ListStreamsResponse: id: ListStreamsResponse description: Response message for listing streams. @@ -938,77 +1015,6 @@ components: changeTables: description: CDC reader reads from change tables. $ref: '#/components/schemas/SqlServerChangeTables' - SqlServerRdbms: - id: SqlServerRdbms - description: SQLServer database structure. - type: object - properties: - schemas: - description: SQLServer schemas in the database server. - type: array - items: - $ref: '#/components/schemas/SqlServerSchema' - SqlServerSchema: - id: SqlServerSchema - description: SQLServer schema. - type: object - properties: - schema: - description: Schema name. - type: string - tables: - description: Tables in the schema. - type: array - items: - $ref: '#/components/schemas/SqlServerTable' - SqlServerTable: - id: SqlServerTable - description: SQLServer table. - type: object - properties: - table: - description: Table name. - type: string - columns: - description: >- - SQLServer columns in the schema. When unspecified as part of - include/exclude objects, includes/excludes everything. - type: array - items: - $ref: '#/components/schemas/SqlServerColumn' - SqlServerColumn: - id: SqlServerColumn - description: SQLServer Column. - type: object - properties: - column: - description: Column name. - type: string - dataType: - description: The SQLServer data type. - type: string - length: - description: Column length. - type: integer - format: int32 - precision: - description: Column precision. - type: integer - format: int32 - scale: - description: Column scale. - type: integer - format: int32 - primaryKey: - description: Whether or not the column represents a primary key. - type: boolean - nullable: - description: Whether or not the column can accept a null value. - type: boolean - ordinalPosition: - description: The ordinal position of the column in the table. - type: integer - format: int32 SqlServerTransactionLogs: id: SqlServerTransactionLogs description: Configuration to use Transaction Logs CDC read method. @@ -1946,25 +1952,25 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/static_ips/methods/fetch_static_ips insert: [] update: [] + replace: [] delete: [] locations: id: google.datastream.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1977,23 +1983,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.datastream.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2021,6 +2025,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' connection_profiles: @@ -2028,17 +2033,14 @@ components: name: connection_profiles title: Connection_profiles methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectionProfiles/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.connectionProfiles - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -2083,6 +2085,7 @@ components: #/components/x-stackQL-resources/connection_profiles/methods/create update: - $ref: '#/components/x-stackQL-resources/connection_profiles/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/connection_profiles/methods/delete @@ -2091,17 +2094,14 @@ components: name: streams title: Streams methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1streams/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.streams - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -2145,6 +2145,7 @@ components: - $ref: '#/components/x-stackQL-resources/streams/methods/create' update: - $ref: '#/components/x-stackQL-resources/streams/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/streams/methods/delete' objects: @@ -2166,17 +2167,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1streams~1{streamsId}~1objects/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.streamObjects - list: - operation: *ref_9 - response: *ref_10 start_backfill_job: operation: $ref: >- @@ -2197,6 +2195,7 @@ components: - $ref: '#/components/x-stackQL-resources/objects/methods/list' insert: [] update: [] + replace: [] delete: [] private_connections: id: google.datastream.private_connections @@ -2210,17 +2209,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateConnections/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.privateConnections - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -2243,6 +2239,7 @@ components: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/delete @@ -2258,17 +2255,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateConnections~1{privateConnectionsId}~1routes/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.routes - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -2290,11 +2284,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/routes/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/routes/methods/delete' paths: /v1/projects/{projectsId}/locations/{locationsId}:fetchStaticIps: - parameters: &ref_15 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2344,7 +2339,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: datastream.projects.locations.list @@ -2380,7 +2375,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets information about a location. operationId: datastream.projects.locations.get @@ -2408,7 +2403,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2451,7 +2446,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2522,7 +2517,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2569,7 +2564,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Use this method to list connection profiles created in a project and @@ -2665,7 +2660,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Use this method to get details about a connection profile. operationId: datastream.projects.locations.connectionProfiles.get @@ -2786,7 +2781,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles:discover: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Use this method to discover a connection profile. The discover API call @@ -2823,7 +2818,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/streams: - parameters: *ref_15 + parameters: *ref_1 get: description: Use this method to list streams in a project and location. operationId: datastream.projects.locations.streams.list @@ -2915,7 +2910,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Use this method to get details about a stream. operationId: datastream.projects.locations.streams.get @@ -3036,11 +3031,11 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}:run: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Use this method to start, resume or recover a stream with a non default - CDC strategy. NOTE: This feature is currently experimental. + CDC strategy. operationId: datastream.projects.locations.streams.run requestBody: content: @@ -3076,7 +3071,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Use this method to get details about a stream object. operationId: datastream.projects.locations.streams.objects.get @@ -3114,7 +3109,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects:lookup: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Use this method to look up a stream object by its source object @@ -3154,7 +3149,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects: - parameters: *ref_15 + parameters: *ref_1 get: description: Use this method to list the objects of a specific stream. operationId: datastream.projects.locations.streams.objects.list @@ -3196,7 +3191,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:startBackfillJob: - parameters: *ref_15 + parameters: *ref_1 post: description: Use this method to start a backfill job for the specified stream object. operationId: datastream.projects.locations.streams.objects.startBackfillJob @@ -3239,7 +3234,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:stopBackfillJob: - parameters: *ref_15 + parameters: *ref_1 post: description: Use this method to stop a backfill job for the specified stream object. operationId: datastream.projects.locations.streams.objects.stopBackfillJob @@ -3282,7 +3277,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections: - parameters: *ref_15 + parameters: *ref_1 post: description: Use this method to create a private connectivity configuration. operationId: datastream.projects.locations.privateConnections.create @@ -3372,7 +3367,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Use this method to get details about a private connectivity @@ -3446,7 +3441,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Use this method to create a route for a private connectivity @@ -3544,7 +3539,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes/{routesId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Use this method to get details about a route. operationId: datastream.projects.locations.privateConnections.routes.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml index d1b1cf1f..da585df0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/deploymentmanager.yaml @@ -11,7 +11,7 @@ info: templates which specify deployments of Cloud resources. version: v2 x-discovery-doc-revision: '20240404' - x-generated-date: '2024-06-03' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/deployment-manager servers: @@ -1756,17 +1756,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1deploymentmanager~1v2~1projects~1{project}~1global~1deployments/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - list: - operation: *ref_1 - response: *ref_2 update: operation: $ref: >- @@ -1816,8 +1813,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/deployments/methods/insert' update: - - $ref: '#/components/x-stackQL-resources/deployments/methods/update' - $ref: '#/components/x-stackQL-resources/deployments/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/deployments/methods/update' delete: - $ref: '#/components/x-stackQL-resources/deployments/methods/delete' deployments_iam_policies: @@ -1825,17 +1823,14 @@ components: name: deployments_iam_policies title: Deployments_iam_policies methods: - _get_iam_policy: - operation: &ref_3 + get_iam_policy: + operation: $ref: >- #/paths/~1deploymentmanager~1v2~1projects~1{project}~1global~1deployments~1{resource}~1getIamPolicy/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_3 - response: *ref_4 set_iam_policy: operation: $ref: >- @@ -1856,6 +1851,9 @@ components: #/components/x-stackQL-resources/deployments_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/deployments_iam_policies/methods/set_iam_policy delete: [] manifests: id: google.deploymentmanager.manifests @@ -1869,23 +1867,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1deploymentmanager~1v2~1projects~1{project}~1global~1deployments~1{deployment}~1manifests/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.manifests - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/manifests/methods/get' - $ref: '#/components/x-stackQL-resources/manifests/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.deploymentmanager.operations @@ -1899,23 +1895,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1deploymentmanager~1v2~1projects~1{project}~1global~1operations/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] resources: id: google.deploymentmanager.resources @@ -1929,49 +1923,45 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1deploymentmanager~1v2~1projects~1{project}~1global~1deployments~1{deployment}~1resources/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resources - list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/resources/methods/get' - $ref: '#/components/x-stackQL-resources/resources/methods/list' insert: [] update: [] + replace: [] delete: [] types: id: google.deploymentmanager.types name: types title: Types methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1deploymentmanager~1v2~1projects~1{project}~1global~1types/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.types - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/types/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /deploymentmanager/v2/projects/{project}/global/deployments: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2074,7 +2064,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{deployment}: - parameters: *ref_13 + parameters: *ref_1 put: description: >- Updates a deployment and all of the resources described by the @@ -2246,7 +2236,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/cancelPreview: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Cancels and removes the preview currently associated with the @@ -2285,7 +2275,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/stop: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Stops an ongoing operation. This does not roll back any work that has @@ -2324,7 +2314,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{resource}/getIamPolicy: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. May be empty if no such @@ -2363,7 +2353,7 @@ paths: type: integer format: int32 /deploymentmanager/v2/projects/{project}/global/deployments/{resource}/setIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2402,7 +2392,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{resource}/testIamPermissions: - parameters: *ref_13 + parameters: *ref_1 post: description: Returns permissions that a caller has on the specified resource. operationId: deploymentmanager.deployments.testIamPermissions @@ -2439,7 +2429,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/manifests/{manifest}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a specific manifest. operationId: deploymentmanager.manifests.get @@ -2484,7 +2474,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/manifests: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists all manifests for a given deployment. operationId: deploymentmanager.manifests.list @@ -2541,7 +2531,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/operations/{operation}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a specific operation. operationId: deploymentmanager.operations.get @@ -2581,7 +2571,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/operations: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists all operations for a project. operationId: deploymentmanager.operations.list @@ -2633,7 +2623,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/resources/{resource}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a single resource. operationId: deploymentmanager.resources.get @@ -2678,7 +2668,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/resources: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists all resources in a given deployment. operationId: deploymentmanager.resources.list @@ -2735,7 +2725,7 @@ paths: schema: type: string /deploymentmanager/v2/projects/{project}/global/types: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists all resource types for Deployment Manager. operationId: deploymentmanager.types.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml b/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml index 0c8449b2..7c7b4a6a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/developerconnect.yaml @@ -7,8 +7,8 @@ info: title: Developer Connect API description: Connect third-party source code management to Google version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: http://cloud.google.com/developer-connect/docs/overview servers: @@ -681,16 +681,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -703,23 +700,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.developerconnect.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -747,6 +742,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' connections: @@ -754,17 +750,14 @@ components: name: connections title: Connections methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.connections - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -801,6 +794,7 @@ components: - $ref: '#/components/x-stackQL-resources/connections/methods/create' update: - $ref: '#/components/x-stackQL-resources/connections/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/connections/methods/delete' connections_linkable_git_repositories: @@ -816,9 +810,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/connections_linkable_git_repositories/methods/fetch_linkable_git_repositories insert: [] update: [] + replace: [] delete: [] connections_github_installations: id: google.developerconnect.connections_github_installations @@ -833,9 +830,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/connections_github_installations/methods/fetchgithub_installations insert: [] update: [] + replace: [] delete: [] git_repository_links: id: google.developerconnect.git_repository_links @@ -849,17 +849,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1gitRepositoryLinks/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.gitRepositoryLinks - list: - operation: *ref_7 - response: *ref_8 delete: operation: $ref: >- @@ -882,6 +879,7 @@ components: - $ref: >- #/components/x-stackQL-resources/git_repository_links/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/git_repository_links/methods/delete @@ -898,9 +896,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/git_repository_links_read_write_token/methods/fetch_read_write_token insert: [] update: [] + replace: [] delete: [] git_repository_links_read_token: id: google.developerconnect.git_repository_links_read_token @@ -915,9 +916,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/git_repository_links_read_token/methods/fetch_read_token insert: [] update: [] + replace: [] delete: [] git_repository_links_git_refs: id: google.developerconnect.git_repository_links_git_refs @@ -932,13 +936,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/git_repository_links_git_refs/methods/fetch_git_refs insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -985,7 +992,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: developerconnect.projects.locations.get @@ -1013,7 +1020,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1056,7 +1063,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1127,7 +1134,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1174,7 +1181,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists Connections in a given project and location. operationId: developerconnect.projects.locations.connections.list @@ -1262,7 +1269,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a single Connection. operationId: developerconnect.projects.locations.connections.get @@ -1391,7 +1398,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableGitRepositories: - parameters: *ref_9 + parameters: *ref_1 get: description: >- FetchLinkableGitRepositories returns a list of git repositories from an @@ -1436,7 +1443,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchGitHubInstallations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- FetchGitHubInstallations returns the list of GitHub Installations that @@ -1473,7 +1480,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates a GitRepositoryLink. Upon linking a Git Repository, Developer @@ -1577,7 +1584,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}: - parameters: *ref_9 + parameters: *ref_1 delete: description: Deletes a single GitRepositoryLink. operationId: >- @@ -1664,7 +1671,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:fetchReadWriteToken: - parameters: *ref_9 + parameters: *ref_1 post: description: Fetches read/write token of a given gitRepositoryLink. operationId: >- @@ -1708,7 +1715,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:fetchReadToken: - parameters: *ref_9 + parameters: *ref_1 post: description: Fetches read token of a given gitRepositoryLink. operationId: >- @@ -1752,7 +1759,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:fetchGitRefs: - parameters: *ref_9 + parameters: *ref_1 get: description: Fetch the list of branches or tags for a given repository. operationId: >- diff --git a/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml b/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml index b35ba09a..dabcc54d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dialogflow.yaml @@ -9,8 +9,8 @@ info: Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). version: v3 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dialogflow/ servers: @@ -426,7 +426,10 @@ components: type: object properties: text: - description: Required. A collection of text responses. + description: >- + Required. A collection of text response variants. If multiple + variants are defined, only one text response variant is returned at + runtime. type: array items: type: string @@ -763,10 +766,17 @@ components: type: object properties: enableStackdriverLogging: - description: If true, StackDriver logging is currently enabled. + description: Enables Google Cloud Logging. type: boolean enableInteractionLogging: - description: If true, DF Interaction logging is currently enabled. + description: Enables DF Interaction logging. + type: boolean + enableConsentBasedRedaction: + description: >- + Enables consent-based end-user input redaction, if true, a + pre-defined session parameter + `$session.params.conversation-redaction` will be used to determine + if the utterance should be redacted. type: boolean GoogleCloudDialogflowCxV3Form: id: GoogleCloudDialogflowCxV3Form @@ -909,6 +919,11 @@ components: The target flow to transition to. Format: `projects//locations//agents//flows/`. type: string + targetPlaybook: + description: >- + The target playbook to transition to. Format: + `projects//locations//agents//playbooks/`. + type: string GoogleCloudDialogflowCxV3TransitionRoute: id: GoogleCloudDialogflowCxV3TransitionRoute description: >- @@ -1092,9 +1107,9 @@ components: responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority - than those defined in the flow. - Format:`projects//locations//agents//flows//transitionRouteGroups/` - or `projects//locations//agents//transitionRouteGroups/` for + than those defined in the flow. Format: + `projects//locations//agents//flows//transitionRouteGroups/` or + `projects//locations//agents//transitionRouteGroups/` for agent-level groups. type: array items: @@ -1116,6 +1131,11 @@ components: description: Optional. Multi-lingual agent settings for this flow. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3FlowMultiLanguageSettings + locked: + description: >- + Indicates whether the flow is locked for changes. If the flow is + locked, modifications to the flow will be rejected. + type: boolean GoogleCloudDialogflowCxV3NluSettings: id: GoogleCloudDialogflowCxV3NluSettings description: Settings related to NLU. @@ -1140,7 +1160,8 @@ components: value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is - used. + used. You can set a separate classification threshold for the flow + in each language enabled for the agent. type: number format: float modelTrainingMode: @@ -1744,6 +1765,10 @@ components: description: Optional. Settings for end user personalization. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3AgentPersonalizationSettings + clientCertificateSettings: + description: Optional. Settings for custom client certificates. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3AgentClientCertificateSettings GoogleCloudDialogflowCxV3SpeechToTextSettings: id: GoogleCloudDialogflowCxV3SpeechToTextSettings description: Settings related to speech recognition. @@ -1923,6 +1948,29 @@ components: additionalProperties: type: any description: Properties of the object. + GoogleCloudDialogflowCxV3AgentClientCertificateSettings: + id: GoogleCloudDialogflowCxV3AgentClientCertificateSettings + description: Settings for custom client certificates. + type: object + properties: + sslCertificate: + description: >- + Required. The ssl certificate encoded in PEM format. This string + must include the begin header and end footer lines. + type: string + privateKey: + description: >- + Required. The name of the SecretManager secret version resource + storing the private key encoded in PEM format. Format: + `projects/{project}/secrets/{secret}/versions/{version}` + type: string + passphrase: + description: >- + Optional. The name of the SecretManager secret version resource + storing the passphrase. 'passphrase' should be left unset if the + private key is not encrypted. Format: + `projects/{project}/secrets/{secret}/versions/{version}` + type: string GoogleCloudDialogflowCxV3ExportAgentRequest: id: GoogleCloudDialogflowCxV3ExportAgentRequest description: The request message for Agents.ExportAgent. @@ -3130,6 +3178,96 @@ components: condition is ignored. type: number format: float + boostControlSpec: + description: >- + Optional. Complex specification for custom ranking based on customer + defined attribute value. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpec + GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpec: + id: GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. + type: object + properties: + fieldName: + description: >- + Optional. The name of the field whose value will be used to + determine the boost amount. + type: string + attributeType: + description: >- + Optional. The attribute type to be used to determine the boost + amount. The attribute value can be derived from the field value of + the specified field_name. In the case of numerical it is + straightforward i.e. attribute_value = numerical_field_value. In the + case of freshness however, attribute_value = (time.now() - + datetime_field_value). + type: string + enumDescriptions: + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. E.g. `5D`, + `3DT12H30M`, `T24H`. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: + description: >- + Optional. The interpolation type to be applied to connect the + control points listed below. + type: string + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + Optional. The control points used to define the curve. The monotonic + function (defined through the interpolation_type above) passes + through the control points listed here. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpecControlPoint + GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpecControlPoint: + id: >- + GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpecControlPoint + description: >- + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). + type: object + properties: + attributeValue: + description: >- + Optional. Can be one of: 1. The numerical field value. 2. The + duration spec for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. + type: string + boostAmount: + description: >- + Optional. The value between -1 to 1 by which to boost the score if + the attribute_value evaluates to the value specified above. + type: number + format: float GoogleCloudDialogflowCxV3FilterSpecs: id: GoogleCloudDialogflowCxV3FilterSpecs description: Filter specifications for data stores. @@ -3710,6 +3848,7 @@ components: - No match was found for the query. - Indicates an empty query. - The query directly triggered an event. + - The query was matched to a Knowledge Connector answer. - The query was handled by a `Playbook`. enum: - MATCH_TYPE_UNSPECIFIED @@ -3719,6 +3858,7 @@ components: - NO_MATCH - NO_INPUT - EVENT + - KNOWLEDGE_CONNECTOR - PLAYBOOK confidence: description: >- @@ -3818,6 +3958,12 @@ components: modelOutput: description: Output of the generative model. type: string + model: + description: >- + Name of the generative model. For example, "gemini-ultra", + "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the + model is unknown. + type: string GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet: id: GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet description: Search snippet details. @@ -3844,6 +3990,12 @@ components: modelOutput: description: Output of the generative model. type: string + model: + description: >- + Name of the generative model. For example, "gemini-ultra", + "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the + model is unknown. + type: string GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart: id: GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart description: Answer part with citation. @@ -4173,7 +4325,7 @@ components: description: >- The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: - `projects//locations//agents/ /testCases/`. + `projects//locations//agents//testCases/`. type: string tags: description: >- @@ -4227,18 +4379,16 @@ components: Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If - both are set, `page` takes precedence over `flow`. If neither is - set, the test case will start with start page on the default start - flow. + neither is set, the test case will start with start page on the + default start flow. type: string page: description: >- The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test - case. If both are set, `page` takes precedence over `flow`. If - neither is set, the test case will start with start page on the - default start flow. + case. If neither is set, the test case will start with start page on + the default start flow. type: string GoogleCloudDialogflowCxV3ConversationTurn: id: GoogleCloudDialogflowCxV3ConversationTurn @@ -4365,7 +4515,7 @@ components: name: description: >- The resource name for the test case result. Format: - `projects//locations//agents//testCases/ /results/`. + `projects//locations//agents//testCases//results/`. type: string environment: description: >- @@ -4401,8 +4551,8 @@ components: properties: names: description: >- - Required. Format of test case names: `projects//locations/ - /agents//testCases/`. + Required. Format of test case names: + `projects//locations//agents//testCases/`. type: array items: type: string @@ -4965,7 +5115,11 @@ components: type: object properties: version: - description: 'Required. Format: projects//locations//agents//flows//versions/.' + description: >- + Required. Both flow and playbook versions are supported. Format for + flow version: projects//locations//agents//flows//versions/. Format + for playbook version: + projects//locations//agents//playbooks//versions/. type: string GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig: id: GoogleCloudDialogflowCxV3EnvironmentTestCasesConfig @@ -4975,8 +5129,8 @@ components: testCases: description: >- A list of test case names to run. They should be under the same - agent. Format of each test case name: `projects//locations/ - /agents//testCases/` + agent. Format of each test case name: + `projects//locations//agents//testCases/` type: array items: type: string @@ -5082,7 +5236,7 @@ components: flowVersion: description: >- Required. The flow version to deploy. Format: - `projects//locations//agents// flows//versions/`. + `projects//locations//agents//flows//versions/`. type: string GoogleCloudDialogflowCxV3ListExperimentsResponse: id: GoogleCloudDialogflowCxV3ListExperimentsResponse @@ -5111,7 +5265,7 @@ components: name: description: >- The name of the experiment. Format: - projects//locations//agents//environments//experiments/.. + projects//locations//agents//environments//experiments/. type: string displayName: description: >- @@ -6339,80 +6493,6 @@ components: type: array items: type: string - GoogleCloudDialogflowCxV3ImportDocumentsResponse: - id: GoogleCloudDialogflowCxV3ImportDocumentsResponse - description: Response message for Documents.ImportDocuments. - type: object - properties: - warnings: - description: Includes details about skipped documents or any other warnings. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata - description: Metadata for CreateDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata: - id: GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata - description: Metadata in google::longrunning::Operation for Knowledge operations. - type: object - properties: - state: - description: Required. Output only. The current state of this operation. - readOnly: true - type: string - enumDescriptions: - - State unspecified. - - The operation has been created. - - The operation is currently running. - - The operation is done, either cancelled or completed. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata - description: Metadata for DeleteDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata: - id: GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata - description: Metadata for ImportDocuments operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata - description: Metadata for ReloadDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata - description: Metadata for UpdateDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata GoogleCloudDialogflowCxV3RunContinuousTestMetadata: id: GoogleCloudDialogflowCxV3RunContinuousTestMetadata description: >- @@ -6456,7 +6536,7 @@ components: deployment: description: >- The name of the flow version Deployment. Format: - `projects//locations//agents// environments//deployments/`. + `projects//locations//agents//environments//deployments/`. type: string GoogleCloudDialogflowCxV3ConversationSignals: id: GoogleCloudDialogflowCxV3ConversationSignals @@ -7060,6 +7140,11 @@ components: Dialogflow Messenger. $ref: >- #/components/schemas/GoogleCloudDialogflowCxV3beta1ResponseMessageKnowledgeInfoCard + toolCall: + description: >- + Returns the definition of a tool call that should be executed by the + client. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCall' channel: description: >- The channel which the response is associated with. Clients can @@ -7072,7 +7157,10 @@ components: type: object properties: text: - description: Required. A collection of text responses. + description: >- + Required. A collection of text response variants. If multiple + variants are defined, only one text response variant is returned at + runtime. type: array items: type: string @@ -7234,6 +7322,25 @@ components: skipped. type: object properties: {} + GoogleCloudDialogflowCxV3beta1ToolCall: + id: GoogleCloudDialogflowCxV3beta1ToolCall + description: Represents a call of a specific tool's action with the specified inputs. + type: object + properties: + tool: + description: >- + Required. The tool associated with this call. Format: + `projects//locations//agents//tools/`. + type: string + action: + description: Required. The name of the tool's action associated with this call. + type: string + inputParameters: + description: Optional. The action's input parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult: id: GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult description: Represents the result of sentiment analysis. @@ -7379,7 +7486,7 @@ components: name: description: >- The resource name for the test case result. Format: - `projects//locations//agents//testCases/ /results/`. + `projects//locations//agents//testCases//results/`. type: string environment: description: >- @@ -7474,6 +7581,9 @@ components: dtmf: description: The DTMF event to be handled. $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1DtmfInput' + toolCallResult: + description: The results of a tool executed by the client. + $ref: '#/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCallResult' languageCode: description: >- Required. The language of the input. See [Language @@ -7707,6 +7817,39 @@ components: finishDigit: description: The finish digit (if any). type: string + GoogleCloudDialogflowCxV3beta1ToolCallResult: + id: GoogleCloudDialogflowCxV3beta1ToolCallResult + description: >- + The result of calling a tool's action that has been executed by the + client. + type: object + properties: + tool: + description: >- + Required. The tool associated with this call. Format: + `projects//locations//agents//tools/`. + type: string + action: + description: Required. The name of the tool's action associated with this call. + type: string + error: + description: The tool call's error. + $ref: >- + #/components/schemas/GoogleCloudDialogflowCxV3beta1ToolCallResultError + outputParameters: + description: The tool call's output parameters. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowCxV3beta1ToolCallResultError: + id: GoogleCloudDialogflowCxV3beta1ToolCallResultError + description: An error produced by the tool call. + type: object + properties: + message: + description: Optional. The error message of the function. + type: string GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput: id: GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput description: The output from the virtual agent. @@ -8266,10 +8409,17 @@ components: type: object properties: enableStackdriverLogging: - description: If true, StackDriver logging is currently enabled. + description: Enables Google Cloud Logging. type: boolean enableInteractionLogging: - description: If true, DF Interaction logging is currently enabled. + description: Enables DF Interaction logging. + type: boolean + enableConsentBasedRedaction: + description: >- + Enables consent-based end-user input redaction, if true, a + pre-defined session parameter + `$session.params.conversation-redaction` will be used to determine + if the utterance should be redacted. type: boolean GoogleCloudDialogflowCxV3beta1Form: id: GoogleCloudDialogflowCxV3beta1Form @@ -8412,6 +8562,11 @@ components: The target flow to transition to. Format: `projects//locations//agents//flows/`. type: string + targetPlaybook: + description: >- + The target playbook to transition to. Format: + `projects//locations//agents//playbooks/`. + type: string GoogleCloudDialogflowCxV3beta1TransitionRoute: id: GoogleCloudDialogflowCxV3beta1TransitionRoute description: >- @@ -8599,7 +8754,7 @@ components: description: >- The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: - `projects//locations//agents/ /testCases/`. + `projects//locations//agents//testCases/`. type: string tags: description: >- @@ -8654,18 +8809,16 @@ components: Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If - both are set, `page` takes precedence over `flow`. If neither is - set, the test case will start with start page on the default start - flow. + neither is set, the test case will start with start page on the + default start flow. type: string page: description: >- The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test - case. If both are set, `page` takes precedence over `flow`. If - neither is set, the test case will start with start page on the - default start flow. + case. If neither is set, the test case will start with start page on + the default start flow. type: string GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse: id: GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse @@ -8679,80 +8832,6 @@ components: type: array items: type: string - GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse: - id: GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse - description: Response message for Documents.ImportDocuments. - type: object - properties: - warnings: - description: Includes details about skipped documents or any other warnings. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata - description: Metadata for CreateDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata: - id: GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata - description: Metadata in google::longrunning::Operation for Knowledge operations. - type: object - properties: - state: - description: Required. Output only. The current state of this operation. - readOnly: true - type: string - enumDescriptions: - - State unspecified. - - The operation has been created. - - The operation is currently running. - - The operation is done, either cancelled or completed. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata - description: Metadata for DeleteDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata: - id: GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata - description: Metadata for ImportDocuments operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata - description: Metadata for ReloadDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata: - id: GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata - description: Metadata for UpdateDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata: id: GoogleCloudDialogflowCxV3beta1RunContinuousTestMetadata description: >- @@ -8831,7 +8910,7 @@ components: deployment: description: >- The name of the flow version deployment. Format: - `projects//locations//agents// environments//deployments/`. + `projects//locations//agents//environments//deployments/`. type: string GoogleCloudDialogflowCxV3beta1Environment: id: GoogleCloudDialogflowCxV3beta1Environment @@ -8889,7 +8968,11 @@ components: type: object properties: version: - description: 'Required. Format: projects//locations//agents//flows//versions/.' + description: >- + Required. Both flow and playbook versions are supported. Format for + flow version: projects//locations//agents//flows//versions/. Format + for playbook version: + projects//locations//agents//playbooks//versions/. type: string GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig: id: GoogleCloudDialogflowCxV3beta1EnvironmentTestCasesConfig @@ -8899,8 +8982,8 @@ components: testCases: description: >- A list of test case names to run. They should be under the same - agent. Format of each test case name: `projects//locations/ - /agents//testCases/` + agent. Format of each test case name: + `projects//locations//agents//testCases/` type: array items: type: string @@ -10294,12 +10377,14 @@ components: - >- Run knowledge search with text input from agent or text generated query. + - Run knowledge assist with automatic query generation. enum: - TYPE_UNSPECIFIED - ARTICLE_SUGGESTION - FAQ - SMART_REPLY - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST createTime: description: >- Timestamp whe the request was created. The time is measured on @@ -10550,6 +10635,10 @@ components: suggestArticlesResponse: description: SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. $ref: '#/components/schemas/GoogleCloudDialogflowV2SuggestArticlesResponse' + suggestKnowledgeAssistResponse: + description: SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse suggestFaqAnswersResponse: description: SuggestFaqAnswersResponse if request is for FAQ_ANSWER. $ref: >- @@ -10617,6 +10706,117 @@ components: The name of answer record, in the format of "projects//locations//answerRecords/" type: string + GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse: + id: GoogleCloudDialogflowV2SuggestKnowledgeAssistResponse + description: The response message for Participants.SuggestKnowledgeAssist. + type: object + properties: + knowledgeAssistAnswer: + description: Output only. Knowledge Assist suggestion. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswer' + latestMessage: + description: >- + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. + type: string + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestKnowledgeAssistRequest.context_size field in the request if + there are fewer messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2KnowledgeAssistAnswer: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswer + description: Represents a Knowledge Assist answer. + type: object + properties: + suggestedQuery: + description: >- + The query suggested based on the context. Suggestion is made only if + it is different from the previous suggestion. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery + suggestedQueryAnswer: + description: >- + The answer generated for the suggested query. Whether or not an + answer is generated depends on how confident we are about the + generated query. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer + answerRecord: + description: >- + The name of the answer record. Format: `projects//locations//answer + Records/`. + type: string + GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswerSuggestedQuery + description: Represents a suggested query. + type: object + properties: + queryText: + description: Suggested query text. + type: string + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswer + description: >- + Represents an answer from Knowledge. Currently supports FAQ and + Generative answers. + type: object + properties: + answerText: + description: >- + The piece of text from the `source` that answers this suggested + query. + type: string + faqSource: + description: Populated if the prediction came from FAQ. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource + generativeSource: + description: Populated if the prediction was Generative. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource: + id: GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerFaqSource + description: Details about source of FAQ answer. + type: object + properties: + question: + description: The corresponding FAQ question. + type: string + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: + id: >- + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + description: Details about source of Generative answer. + type: object + properties: + snippets: + description: >- + All snippets used for this Generative Prediction, with their source + URI and data. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet: + id: >- + GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + description: Snippet Source for a Generative Prediction. + type: object + properties: + uri: + description: URI the data is sourced from. + type: string + text: + description: Text taken from that URI. + type: string + title: + description: Title of the document. + type: string GoogleCloudDialogflowV2SuggestFaqAnswersResponse: id: GoogleCloudDialogflowV2SuggestFaqAnswersResponse description: The request message for Participants.SuggestFaqAnswers. @@ -10852,12 +11052,14 @@ components: - >- Run knowledge search with text input from agent or text generated query. + - Run knowledge assist with automatic query generation. enum: - TYPE_UNSPECIFIED - ARTICLE_SUGGESTION - FAQ - SMART_REPLY - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST createTime: description: >- Timestamp whe the request was created. The time is measured on @@ -11234,12 +11436,57 @@ components: time is measured on server side. type: string format: google-datetime - GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata: - id: GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata - description: Metadata for ConversationDatasets. + GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata: + id: GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. type: object properties: - conversationDataset: + request: + description: Output only. The original request for initialization. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2InitializeEncryptionSpecRequest + GoogleCloudDialogflowV2InitializeEncryptionSpecRequest: + id: GoogleCloudDialogflowV2InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. + type: object + properties: + encryptionSpec: + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. + $ref: '#/components/schemas/GoogleCloudDialogflowV2EncryptionSpec' + GoogleCloudDialogflowV2EncryptionSpec: + id: GoogleCloudDialogflowV2EncryptionSpec + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + type: object + properties: + name: + description: >- + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + type: string + kmsKey: + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + type: string + GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata: + id: GoogleCloudDialogflowV2CreateConversationDatasetOperationMetadata + description: Metadata for ConversationDatasets. + type: object + properties: + conversationDataset: description: >- The resource name of the conversation dataset that will be created. Format: `projects//locations//conversationDatasets/` @@ -12929,6 +13176,7 @@ components: - >- Run knowledge search with text input from agent or text generated query. + - Run knowledge assist with automatic query generation. enum: - TYPE_UNSPECIFIED - ARTICLE_SUGGESTION @@ -12937,6 +13185,7 @@ components: - DIALOGFLOW_ASSIST - CONVERSATION_SUMMARIZATION - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST createTime: description: >- Timestamp whe the request was created. The time is measured on @@ -13009,6 +13258,11 @@ components: content: description: Required. The message content. type: string + responseMessages: + description: Optional. Automated agent responses. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessage' languageCode: description: >- Optional. The message language. This should be a @@ -13055,6 +13309,132 @@ components: readOnly: true $ref: >- #/components/schemas/GoogleCloudDialogflowV2beta1SentimentAnalysisResult + GoogleCloudDialogflowV2beta1ResponseMessage: + id: GoogleCloudDialogflowV2beta1ResponseMessage + description: Response messages from an automated agent. + type: object + properties: + text: + description: Returns a text response. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageText' + payload: + description: Returns a response containing a custom, platform-specific payload. + type: object + additionalProperties: + type: any + description: Properties of the object. + liveAgentHandoff: + description: Hands off conversation to a live agent. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff + endInteraction: + description: >- + A signal that indicates the interaction with the Dialogflow agent + has ended. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction + mixedAudio: + description: >- + An audio response message composed of both the synthesized + Dialogflow agent responses and the audios hosted in places known to + the client. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio + telephonyTransferCall: + description: >- + A signal that the client should transfer the phone call connected to + this agent to a third-party endpoint. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall + GoogleCloudDialogflowV2beta1ResponseMessageText: + id: GoogleCloudDialogflowV2beta1ResponseMessageText + description: The text response message. + type: object + properties: + text: + description: >- + A collection of text response variants. If multiple variants are + defined, only one text response variant is returned at runtime. + type: array + items: + type: string + GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff: + id: GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff + description: >- + Indicates that the conversation should be handed off to a human agent. + Dialogflow only uses this to determine which conversations were handed + off to a human agent for measurement purposes. What else to do with this + signal is up to you and your handoff procedures. You may set this, for + example: * In the entry fulfillment of a CX Page if entering the page + indicates something went extremely wrong in the conversation. * In a + webhook response when you determine that the customer issue can only be + handled by a human. + type: object + properties: + metadata: + description: >- + Custom metadata for your handoff procedure. Dialogflow doesn't + impose any structure on this. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction: + id: GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction + description: Indicates that interaction with the Dialogflow agent has ended. + type: object + properties: {} + GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio: + id: GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio + description: >- + Represents an audio message that is composed of both segments + synthesized from the Dialogflow agent prompts and ones hosted externally + at the specified URIs. + type: object + properties: + segments: + description: Segments this audio response is composed of. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment + GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment: + id: GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment + description: Represents one segment of audio. + type: object + properties: + audio: + description: >- + Raw audio synthesized from the Dialogflow agent's response using the + output config specified in the request. + type: string + format: byte + uri: + description: >- + Client-specific URI that points to an audio clip accessible to the + client. + type: string + allowPlaybackInterruption: + description: >- + Whether the playback of this segment can be interrupted by the end + user's speech and the client should then start the next Dialogflow + request. + type: boolean + GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall: + id: GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall + description: >- + Represents the signal that telles the client to transfer the phone call + connected to the agent to a third-party endpoint. + type: object + properties: + phoneNumber: + description: >- + Transfer the call to a phone number in [E.164 + format](https://en.wikipedia.org/wiki/E.164). + type: string + sipUri: + description: Transfer the call to a SIP endpoint. + type: string GoogleCloudDialogflowV2beta1MessageAnnotation: id: GoogleCloudDialogflowV2beta1MessageAnnotation description: Represents the result of annotation for the message. @@ -13196,6 +13576,10 @@ components: description: SuggestArticlesResponse if request is for ARTICLE_SUGGESTION. $ref: >- #/components/schemas/GoogleCloudDialogflowV2beta1SuggestArticlesResponse + suggestKnowledgeAssistResponse: + description: SuggestKnowledgeAssistResponse if request is for KNOWLEDGE_ASSIST. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse suggestFaqAnswersResponse: description: SuggestFaqAnswersResponse if request is for FAQ_ANSWER. $ref: >- @@ -13268,6 +13652,119 @@ components: The name of answer record, in the format of "projects//locations//answerRecords/" type: string + GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse: + id: GoogleCloudDialogflowV2beta1SuggestKnowledgeAssistResponse + description: The response message for Participants.SuggestKnowledgeAssist. + type: object + properties: + knowledgeAssistAnswer: + description: Output only. Knowledge Assist suggestion. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer + latestMessage: + description: >- + The name of the latest conversation message used to compile + suggestion for. Format: + `projects//locations//conversations//messages/`. + type: string + contextSize: + description: >- + Number of messages prior to and including latest_message to compile + the suggestion. It may be smaller than the + SuggestKnowledgeAssistRequest.context_size field in the request if + there are fewer messages in the conversation. + type: integer + format: int32 + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer: + id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswer + description: Represents a Knowledge Assist answer. + type: object + properties: + suggestedQuery: + description: >- + The query suggested based on the context. Suggestion is made only if + it is different from the previous suggestion. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery + suggestedQueryAnswer: + description: >- + The answer generated for the suggested query. Whether or not an + answer is generated depends on how confident we are about the + generated query. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer + answerRecord: + description: >- + The name of the answer record. Format: `projects//locations//answer + Records/`. + type: string + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery: + id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerSuggestedQuery + description: Represents a suggested query. + type: object + properties: + queryText: + description: Suggested query text. + type: string + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer: + id: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswer + description: >- + Represents an answer from Knowledge. Currently supports FAQ and + Generative answers. + type: object + properties: + answerText: + description: >- + The piece of text from the `source` that answers this suggested + query. + type: string + faqSource: + description: Populated if the prediction came from FAQ. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource + generativeSource: + description: Populated if the prediction was Generative. + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource: + id: >- + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerFaqSource + description: Details about source of FAQ answer. + type: object + properties: + question: + description: The corresponding FAQ question. + type: string + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource: + id: >- + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSource + description: Details about source of Generative answer. + type: object + properties: + snippets: + description: >- + All snippets used for this Generative Prediction, with their source + URI and data. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet: + id: >- + GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet + description: Snippet Source for a Generative Prediction. + type: object + properties: + uri: + description: URI the data is sourced from. + type: string + text: + description: Text taken from that URI. + type: string + title: + description: Title of the document. + type: string GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse: id: GoogleCloudDialogflowV2beta1SuggestFaqAnswersResponse description: The request message for Participants.SuggestFaqAnswers. @@ -13643,6 +14140,51 @@ components: type: array items: $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata: + id: GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata + description: Metadata for initializing a location-level encryption specification. + type: object + properties: + request: + description: Output only. The original request for initialization. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest + GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest: + id: GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest + description: The request to initialize a location-level encryption specification. + type: object + properties: + encryptionSpec: + description: >- + Required. The encryption spec used for CMEK encryption. It is + required that the kms key is in the same region as the endpoint. The + same key will be used for all provisioned resources, if encryption + is available. If the kms_key_name is left empty, no encryption will + be enforced. + $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EncryptionSpec' + GoogleCloudDialogflowV2beta1EncryptionSpec: + id: GoogleCloudDialogflowV2beta1EncryptionSpec + description: >- + A customer-managed encryption key specification that can be applied to + all created resources (e.g. Conversation). + type: object + properties: + name: + description: >- + Immutable. The resource name of the encryption key specification + resource. Format: + projects/{project}/locations/{location}/encryptionSpec + type: string + kmsKey: + description: >- + Required. The name of customer-managed encryption key that is used + to secure a resource and its sub-resources. If empty, the resource + is secured by the default Google encryption key. Only the key in the + same location as this resource is allowed to be used for encryption. + Format: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` + type: string GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata: id: GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata description: Metadata in google::longrunning::Operation for Knowledge operations. @@ -13766,6 +14308,7 @@ components: - >- Run knowledge search with text input from agent or text generated query. + - Run knowledge assist with automatic query generation. enum: - TYPE_UNSPECIFIED - ARTICLE_SUGGESTION @@ -13774,6 +14317,7 @@ components: - DIALOGFLOW_ASSIST - CONVERSATION_SUMMARIZATION - KNOWLEDGE_SEARCH + - KNOWLEDGE_ASSIST createTime: description: >- Timestamp whe the request was created. The time is measured on @@ -14000,80 +14544,6 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudDialogflowV2beta1EntityTypeEntity' - GoogleCloudDialogflowV3alpha1ImportDocumentsResponse: - id: GoogleCloudDialogflowV3alpha1ImportDocumentsResponse - description: Response message for Documents.ImportDocuments. - type: object - properties: - warnings: - description: Includes details about skipped documents or any other warnings. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata: - id: GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata - description: Metadata for CreateDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata: - id: GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata - description: Metadata in google::longrunning::Operation for Knowledge operations. - type: object - properties: - state: - description: Required. Output only. The current state of this operation. - readOnly: true - type: string - enumDescriptions: - - State unspecified. - - The operation has been created. - - The operation is currently running. - - The operation is done, either cancelled or completed. - enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata: - id: GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata - description: Metadata for DeleteDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata: - id: GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata - description: Metadata for ImportDocuments operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata: - id: GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata - description: Metadata for ReloadDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata - GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata: - id: GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata - description: Metadata for UpdateDocument operation. - type: object - properties: - genericMetadata: - description: The generic information of the operation. - $ref: >- - #/components/schemas/GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata GoogleCloudDialogflowV3alpha1ConversationSignals: id: GoogleCloudDialogflowV3alpha1ConversationSignals description: >- @@ -14232,16 +14702,13 @@ components: name: operations title: Operations methods: - _projects_operations_list: - operation: &ref_1 + projects_operations_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_operations_list: - operation: *ref_1 - response: *ref_2 projects_operations_get: operation: $ref: >- @@ -14256,17 +14723,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -14293,22 +14757,20 @@ components: #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] + replace: [] delete: [] locations: id: google.dialogflow.locations name: locations title: Locations methods: - _projects_locations_list: - operation: &ref_5 + projects_locations_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1locations/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_5 - response: *ref_6 projects_locations_get: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -14323,6 +14785,7 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] security_settings: id: google.dialogflow.security_settings @@ -14336,17 +14799,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_security_settings_list: - operation: &ref_7 + projects_locations_security_settings_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1securitySettings/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securitySettings - projects_locations_security_settings_list: - operation: *ref_7 - response: *ref_8 projects_locations_security_settings_get: operation: $ref: >- @@ -14380,6 +14840,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/security_settings/methods/projects_locations_security_settings_delete @@ -14388,17 +14849,14 @@ components: name: agents title: Agents methods: - _projects_locations_agents_list: - operation: &ref_9 + projects_locations_agents_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.agents - projects_locations_agents_list: - operation: *ref_9 - response: *ref_10 projects_locations_agents_create: operation: $ref: >- @@ -14460,6 +14918,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/agents/methods/projects_locations_agents_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/agents/methods/projects_locations_agents_delete @@ -14481,6 +14940,7 @@ components: #/components/x-stackQL-resources/agents_validation_result/methods/projects_locations_agents_get_validation_result insert: [] update: [] + replace: [] delete: [] agents_generative_settings: id: google.dialogflow.agents_generative_settings @@ -14506,7 +14966,10 @@ components: - $ref: >- #/components/x-stackQL-resources/agents_generative_settings/methods/projects_locations_agents_get_generative_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/agents_generative_settings/methods/projects_locations_agents_update_generative_settings + replace: [] delete: [] flows: id: google.dialogflow.flows @@ -14520,17 +14983,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_agents_flows_list: - operation: &ref_11 + projects_locations_agents_flows_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1flows/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.flows - projects_locations_agents_flows_list: - operation: *ref_11 - response: *ref_12 projects_locations_agents_flows_delete: operation: $ref: >- @@ -14592,6 +15052,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/flows/methods/projects_locations_agents_flows_delete @@ -14613,23 +15074,21 @@ components: #/components/x-stackQL-resources/flows_validation_result/methods/projects_locations_agents_flows_get_validation_result insert: [] update: [] + replace: [] delete: [] pages: id: google.dialogflow.pages name: pages title: Pages methods: - _projects_locations_agents_flows_pages_list: - operation: &ref_13 + projects_locations_agents_flows_pages_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1flows~1{flowsId}~1pages/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.pages - projects_locations_agents_flows_pages_list: - operation: *ref_13 - response: *ref_14 projects_locations_agents_flows_pages_create: operation: $ref: >- @@ -14670,6 +15129,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/pages/methods/projects_locations_agents_flows_pages_delete @@ -14678,17 +15138,14 @@ components: name: transition_route_groups title: Transition_route_groups methods: - _projects_locations_agents_flows_transition_route_groups_list: - operation: &ref_15 + projects_locations_agents_flows_transition_route_groups_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1flows~1{flowsId}~1transitionRouteGroups/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transitionRouteGroups - projects_locations_agents_flows_transition_route_groups_list: - operation: *ref_15 - response: *ref_16 projects_locations_agents_flows_transition_route_groups_create: operation: $ref: >- @@ -14717,17 +15174,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_agents_transition_route_groups_list: - operation: &ref_17 + projects_locations_agents_transition_route_groups_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1transitionRouteGroups/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transitionRouteGroups - projects_locations_agents_transition_route_groups_list: - operation: *ref_17 - response: *ref_18 projects_locations_agents_transition_route_groups_create: operation: $ref: >- @@ -14776,6 +15230,7 @@ components: #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_patch - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_transition_route_groups_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/transition_route_groups/methods/projects_locations_agents_flows_transition_route_groups_delete @@ -14786,17 +15241,14 @@ components: name: versions title: Versions methods: - _projects_locations_agents_flows_versions_list: - operation: &ref_19 + projects_locations_agents_flows_versions_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1flows~1{flowsId}~1versions/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.versions - projects_locations_agents_flows_versions_list: - operation: *ref_19 - response: *ref_20 projects_locations_agents_flows_versions_create: operation: $ref: >- @@ -14851,6 +15303,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_locations_agents_flows_versions_delete @@ -14859,17 +15312,14 @@ components: name: changelogs title: Changelogs methods: - _projects_locations_agents_changelogs_list: - operation: &ref_21 + projects_locations_agents_changelogs_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1changelogs/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.changelogs - projects_locations_agents_changelogs_list: - operation: *ref_21 - response: *ref_22 projects_locations_agents_changelogs_get: operation: $ref: >- @@ -14885,6 +15335,7 @@ components: #/components/x-stackQL-resources/changelogs/methods/projects_locations_agents_changelogs_list insert: [] update: [] + replace: [] delete: [] entity_types: id: google.dialogflow.entity_types @@ -14919,17 +15370,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_agents_entity_types_list: - operation: &ref_23 + projects_locations_agents_entity_types_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1entityTypes/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.entityTypes - projects_locations_agents_entity_types_list: - operation: *ref_23 - response: *ref_24 projects_locations_agents_entity_types_export: operation: $ref: >- @@ -14944,17 +15392,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_agents_sessions_entity_types_list: - operation: &ref_25 + projects_locations_agents_sessions_entity_types_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1sessions~1{sessionsId}~1entityTypes/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sessionEntityTypes - projects_locations_agents_sessions_entity_types_list: - operation: *ref_25 - response: *ref_26 projects_locations_agents_sessions_entity_types_create: operation: $ref: >- @@ -14983,17 +15428,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_agents_environments_sessions_entity_types_list: - operation: &ref_27 + projects_locations_agents_environments_sessions_entity_types_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1environments~1{environmentsId}~1sessions~1{sessionsId}~1entityTypes/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sessionEntityTypes - projects_locations_agents_environments_sessions_entity_types_list: - operation: *ref_27 - response: *ref_28 projects_locations_agents_environments_sessions_entity_types_create: operation: $ref: >- @@ -15050,6 +15492,7 @@ components: #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_sessions_entity_types_patch - $ref: >- #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_entity_types_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/entity_types/methods/projects_locations_agents_environments_sessions_entity_types_delete @@ -15062,17 +15505,14 @@ components: name: intents title: Intents methods: - _projects_locations_agents_intents_list: - operation: &ref_29 + projects_locations_agents_intents_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1intents/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.intents - projects_locations_agents_intents_list: - operation: *ref_29 - response: *ref_30 projects_locations_agents_intents_create: operation: $ref: >- @@ -15127,6 +15567,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/intents/methods/projects_locations_agents_intents_delete @@ -15202,23 +15643,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] test_cases: id: google.dialogflow.test_cases name: test_cases title: Test_cases methods: - _projects_locations_agents_test_cases_list: - operation: &ref_31 + projects_locations_agents_test_cases_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1testCases/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.testCases - projects_locations_agents_test_cases_list: - operation: *ref_31 - response: *ref_32 projects_locations_agents_test_cases_create: operation: $ref: >- @@ -15294,23 +15733,23 @@ components: update: - $ref: >- #/components/x-stackQL-resources/test_cases/methods/projects_locations_agents_test_cases_patch - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/test_cases/methods/projects_locations_agents_test_cases_batch_delete results: id: google.dialogflow.results name: results title: Results methods: - _projects_locations_agents_test_cases_results_list: - operation: &ref_33 + projects_locations_agents_test_cases_results_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1testCases~1{testCasesId}~1results/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.testCaseResults - projects_locations_agents_test_cases_results_list: - operation: *ref_33 - response: *ref_34 projects_locations_agents_test_cases_results_get: operation: $ref: >- @@ -15326,23 +15765,21 @@ components: #/components/x-stackQL-resources/results/methods/projects_locations_agents_test_cases_results_list insert: [] update: [] + replace: [] delete: [] webhooks: id: google.dialogflow.webhooks name: webhooks title: Webhooks methods: - _projects_locations_agents_webhooks_list: - operation: &ref_35 + projects_locations_agents_webhooks_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1webhooks/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.webhooks - projects_locations_agents_webhooks_list: - operation: *ref_35 - response: *ref_36 projects_locations_agents_webhooks_create: operation: $ref: >- @@ -15383,6 +15820,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/webhooks/methods/projects_locations_agents_webhooks_delete @@ -15391,17 +15829,14 @@ components: name: environments title: Environments methods: - _projects_locations_agents_environments_list: - operation: &ref_37 + projects_locations_agents_environments_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1environments/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.environments - projects_locations_agents_environments_list: - operation: *ref_37 - response: *ref_38 projects_locations_agents_environments_create: operation: $ref: >- @@ -15463,6 +15898,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/environments/methods/projects_locations_agents_environments_delete @@ -15471,17 +15907,14 @@ components: name: deployments title: Deployments methods: - _projects_locations_agents_environments_deployments_list: - operation: &ref_39 + projects_locations_agents_environments_deployments_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1environments~1{environmentsId}~1deployments/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - projects_locations_agents_environments_deployments_list: - operation: *ref_39 - response: *ref_40 projects_locations_agents_environments_deployments_get: operation: $ref: >- @@ -15497,46 +15930,42 @@ components: #/components/x-stackQL-resources/deployments/methods/projects_locations_agents_environments_deployments_list insert: [] update: [] + replace: [] delete: [] continuous_test_results: id: google.dialogflow.continuous_test_results name: continuous_test_results title: Continuous_test_results methods: - _projects_locations_agents_environments_continuous_test_results_list: - operation: &ref_41 + projects_locations_agents_environments_continuous_test_results_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1environments~1{environmentsId}~1continuousTestResults/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.continuousTestResults - projects_locations_agents_environments_continuous_test_results_list: - operation: *ref_41 - response: *ref_42 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/continuous_test_results/methods/projects_locations_agents_environments_continuous_test_results_list insert: [] update: [] + replace: [] delete: [] experiments: id: google.dialogflow.experiments name: experiments title: Experiments methods: - _projects_locations_agents_environments_experiments_list: - operation: &ref_43 + projects_locations_agents_environments_experiments_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1environments~1{environmentsId}~1experiments/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.experiments - projects_locations_agents_environments_experiments_list: - operation: *ref_43 - response: *ref_44 projects_locations_agents_environments_experiments_create: operation: $ref: >- @@ -15591,6 +16020,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/experiments/methods/projects_locations_agents_environments_experiments_delete @@ -15599,17 +16029,14 @@ components: name: generators title: Generators methods: - _projects_locations_agents_generators_list: - operation: &ref_45 + projects_locations_agents_generators_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1agents~1{agentsId}~1generators/get - response: &ref_46 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.generators - projects_locations_agents_generators_list: - operation: *ref_45 - response: *ref_46 projects_locations_agents_generators_create: operation: $ref: >- @@ -15650,12 +16077,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/generators/methods/projects_locations_agents_generators_delete paths: /v3/projects/{projectsId}/operations: - parameters: &ref_47 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -15708,7 +16136,7 @@ paths: schema: type: string /v3/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -15743,7 +16171,7 @@ paths: schema: type: string /v3/projects/{projectsId}/operations/{operationsId}:cancel: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -15784,7 +16212,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations: - parameters: *ref_47 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: dialogflow.projects.locations.list @@ -15824,7 +16252,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Gets information about a location. operationId: dialogflow.projects.locations.get @@ -15856,7 +16284,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_47 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -15903,7 +16331,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -15943,7 +16371,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -15989,7 +16417,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/securitySettings: - parameters: *ref_47 + parameters: *ref_1 post: description: Create security settings in the specified location. operationId: dialogflow.projects.locations.securitySettings.create @@ -16066,7 +16494,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: >- Retrieves the specified SecuritySettings. The returned settings may be @@ -16185,7 +16613,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all agents in the specified location. operationId: dialogflow.projects.locations.agents.list @@ -16265,7 +16693,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified agent. operationId: dialogflow.projects.locations.agents.get @@ -16385,7 +16813,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:export: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Exports the specified agent to a binary file. This method is a @@ -16434,7 +16862,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:restore: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Restores the specified agent from a binary file. Replaces the current @@ -16490,7 +16918,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:validate: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Validates the specified agent and creates or updates validation results. @@ -16537,7 +16965,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/validationResult: - parameters: *ref_47 + parameters: *ref_1 get: description: >- Gets the latest agent validation result. Agent validation is performed @@ -16581,7 +17009,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generativeSettings: - parameters: *ref_47 + parameters: *ref_1 get: description: Gets the generative settings for the agent. operationId: dialogflow.projects.locations.agents.getGenerativeSettings @@ -16669,7 +17097,7 @@ paths: type: string format: google-fieldmask /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Creates a flow in the specified agent. Note: You should always train a @@ -16767,7 +17195,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}: - parameters: *ref_47 + parameters: *ref_1 delete: description: Deletes a specified flow. operationId: dialogflow.projects.locations.agents.flows.delete @@ -16914,7 +17342,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:train: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Trains the specified flow. Note that only the flow in 'draft' @@ -16972,7 +17400,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:validate: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Validates the specified flow and creates or updates validation results. @@ -17024,7 +17452,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/validationResult: - parameters: *ref_47 + parameters: *ref_1 get: description: >- Gets the latest flow validation result. Flow validation is performed @@ -17073,7 +17501,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows:import: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Imports the specified flow to the specified agent from a binary file. @@ -17124,7 +17552,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}:export: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Exports the specified flow to a binary file. This method is a @@ -17179,7 +17607,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all pages in the specified flow. operationId: dialogflow.projects.locations.agents.flows.pages.list @@ -17287,7 +17715,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/pages/{pagesId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified page. operationId: dialogflow.projects.locations.agents.flows.pages.get @@ -17452,7 +17880,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all transition route groups in the specified flow. operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.list @@ -17562,7 +17990,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/transitionRouteGroups/{transitionRouteGroupsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified TransitionRouteGroup. operationId: dialogflow.projects.locations.agents.flows.transitionRouteGroups.get @@ -17730,7 +18158,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all versions in the specified Flow. operationId: dialogflow.projects.locations.agents.flows.versions.list @@ -17831,7 +18259,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified Version. operationId: dialogflow.projects.locations.agents.flows.versions.get @@ -17978,7 +18406,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:load: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Loads resources in the specified version to the draft flow. This method @@ -18038,7 +18466,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/flows/{flowsId}/versions/{versionsId}:compareVersions: - parameters: *ref_47 + parameters: *ref_1 post: description: Compares the specified base version with target version. operationId: dialogflow.projects.locations.agents.flows.versions.compareVersions @@ -18092,7 +18520,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/changelogs: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of Changelogs. operationId: dialogflow.projects.locations.agents.changelogs.list @@ -18143,7 +18571,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/changelogs/{changelogsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified Changelog. operationId: dialogflow.projects.locations.agents.changelogs.get @@ -18185,7 +18613,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes/{entityTypesId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified entity type. operationId: dialogflow.projects.locations.agents.entityTypes.get @@ -18335,7 +18763,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Creates an entity type in the specified agent. Note: You should always @@ -18433,7 +18861,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes:export: - parameters: *ref_47 + parameters: *ref_1 post: description: Exports the selected entity types. operationId: dialogflow.projects.locations.agents.entityTypes.export @@ -18476,7 +18904,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/entityTypes:import: - parameters: *ref_47 + parameters: *ref_1 post: description: Imports the specified entitytypes into the agent. operationId: dialogflow.projects.locations.agents.entityTypes.import @@ -18519,7 +18947,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all intents in the specified agent. operationId: dialogflow.projects.locations.agents.intents.list @@ -18621,7 +19049,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified intent. operationId: dialogflow.projects.locations.agents.intents.get @@ -18767,7 +19195,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:import: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Imports the specified intents into the agent. This method is a @@ -18815,7 +19243,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:export: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Exports the selected intents. This method is a [long-running @@ -18862,7 +19290,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:detectIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Processes a natural language query and returns structured, actionable @@ -18917,7 +19345,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:serverStreamingDetectIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Processes a natural language query and returns structured, actionable @@ -18972,7 +19400,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:matchIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Returns preliminary intent match results, doesn't change the session @@ -19022,7 +19450,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:fulfillIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Fulfills a matched intent returned by MatchIntent. Must be called after @@ -19074,7 +19502,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}:submitAnswerFeedback: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Updates the feedback received from the user for a single turn of the bot @@ -19124,7 +19552,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all session entity types in the specified session. operationId: dialogflow.projects.locations.agents.sessions.entityTypes.list @@ -19222,7 +19650,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified session entity type. operationId: dialogflow.projects.locations.agents.sessions.entityTypes.get @@ -19371,7 +19799,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all transition route groups in the specified flow. operationId: dialogflow.projects.locations.agents.transitionRouteGroups.list @@ -19471,7 +19899,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified TransitionRouteGroup. operationId: dialogflow.projects.locations.agents.transitionRouteGroups.get @@ -19624,7 +20052,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases: - parameters: *ref_47 + parameters: *ref_1 get: description: Fetches a list of test cases for a given agent. operationId: dialogflow.projects.locations.agents.testCases.list @@ -19715,7 +20143,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchDelete: - parameters: *ref_47 + parameters: *ref_1 post: description: Batch deletes test cases. operationId: dialogflow.projects.locations.agents.testCases.batchDelete @@ -19758,7 +20186,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Gets a test case. operationId: dialogflow.projects.locations.agents.testCases.get @@ -19850,7 +20278,7 @@ paths: type: string format: google-fieldmask /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}:run: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Kicks off a test case run. This method is a [long-running @@ -19901,7 +20329,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:batchRun: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Kicks off a batch run of test cases. This method is a [long-running @@ -19949,7 +20377,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:calculateCoverage: - parameters: *ref_47 + parameters: *ref_1 get: description: Calculates the test coverage for an agent. operationId: dialogflow.projects.locations.agents.testCases.calculateCoverage @@ -19991,7 +20419,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:import: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Imports the test cases from a Cloud Storage bucket or a local file. It @@ -20042,7 +20470,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:export: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Exports the test cases under the agent to a Cloud Storage bucket or a @@ -20092,7 +20520,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results: - parameters: *ref_47 + parameters: *ref_1 get: description: >- Fetches the list of run results for the given test case. A maximum of @@ -20150,7 +20578,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results/{resultsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Gets a test case result. operationId: dialogflow.projects.locations.agents.testCases.results.get @@ -20197,7 +20625,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all webhooks in the specified agent. operationId: dialogflow.projects.locations.agents.webhooks.list @@ -20284,7 +20712,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified webhook. operationId: dialogflow.projects.locations.agents.webhooks.get @@ -20420,7 +20848,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all environments in the specified Agent. operationId: dialogflow.projects.locations.agents.environments.list @@ -20514,7 +20942,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified Environment. operationId: dialogflow.projects.locations.agents.environments.get @@ -20652,7 +21080,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:lookupEnvironmentHistory: - parameters: *ref_47 + parameters: *ref_1 get: description: Looks up the history of the specified Environment. operationId: >- @@ -20705,7 +21133,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:runContinuousTest: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Kicks off a continuous test under the specified Environment. This method @@ -20759,7 +21187,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}:deployFlow: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Deploys a flow to the specified Environment. This method is a @@ -20811,7 +21239,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all deployments in the specified Environment. operationId: dialogflow.projects.locations.agents.environments.deployments.list @@ -20863,7 +21291,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/deployments/{deploymentsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified Deployment. operationId: dialogflow.projects.locations.agents.environments.deployments.get @@ -20910,7 +21338,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:detectIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Processes a natural language query and returns structured, actionable @@ -20970,7 +21398,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:serverStreamingDetectIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Processes a natural language query and returns structured, actionable @@ -21030,7 +21458,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:matchIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Returns preliminary intent match results, doesn't change the session @@ -21085,7 +21513,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}:fulfillIntent: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Fulfills a matched intent returned by MatchIntent. Must be called after @@ -21142,7 +21570,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all session entity types in the specified session. operationId: >- @@ -21252,7 +21680,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/sessions/{sessionsId}/entityTypes/{entityTypesId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified session entity type. operationId: >- @@ -21419,7 +21847,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/continuousTestResults: - parameters: *ref_47 + parameters: *ref_1 get: description: Fetches a list of continuous test results for a given environment. operationId: >- @@ -21472,7 +21900,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all experiments in the specified Environment. operationId: dialogflow.projects.locations.agents.environments.experiments.list @@ -21569,7 +21997,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified Experiment. operationId: dialogflow.projects.locations.agents.environments.experiments.get @@ -21716,7 +22144,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:start: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Starts the specified Experiment. This rpc only changes the state of @@ -21771,7 +22199,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/environments/{environmentsId}/experiments/{experimentsId}:stop: - parameters: *ref_47 + parameters: *ref_1 post: description: >- Stops the specified Experiment. This rpc only changes the state of @@ -21826,7 +22254,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators: - parameters: *ref_47 + parameters: *ref_1 get: description: Returns the list of all generators in the specified agent. operationId: dialogflow.projects.locations.agents.generators.list @@ -21921,7 +22349,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/generators/{generatorsId}: - parameters: *ref_47 + parameters: *ref_1 get: description: Retrieves the specified generator. operationId: dialogflow.projects.locations.agents.generators.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml index 07ab911a..c21116b1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/discoveryengine.yaml @@ -7,10 +7,10 @@ info: title: Discovery Engine API description: Discovery Engine API. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: - url: https://cloud.google.com/discovery-engine/docs + url: https://cloud.google.com/generative-ai-app-builder/docs/ servers: - url: https://discoveryengine.googleapis.com components: @@ -284,6 +284,171 @@ components: method. type: object properties: {} + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest: + id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest + description: >- + Request message for CompletionService.ImportCompletionSuggestions + method. + type: object + properties: + inlineSource: + description: The Inline source for suggestion entries. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource + gcsSource: + description: Cloud Storage location for the input content. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' + bigquerySource: + description: BigQuery input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigQuerySource' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource: + id: >- + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequestInlineSource + description: The inline source for CompletionSuggestions. + type: object + properties: + suggestions: + description: >- + Required. A list of all denylist entries to import. Max of 1000 + items. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1CompletionSuggestion + GoogleCloudDiscoveryengineV1CompletionSuggestion: + id: GoogleCloudDiscoveryengineV1CompletionSuggestion + description: Autocomplete suggestions that are imported from Customer. + type: object + properties: + globalScore: + description: >- + Global score of this suggestion. Control how this suggestion would + be scored / ranked. + type: number + format: double + frequency: + description: >- + Frequency of this suggestion. Will be used to rank suggestions when + score is not available. + type: string + format: int64 + suggestion: + description: Required. The suggestion text. + type: string + languageCode: + description: BCP-47 language code of this suggestion. + type: string + groupId: + description: >- + If two suggestions have the same groupId, they will not be returned + together. Instead the one ranked higher will be returned. This can + be used to deduplicate semantically identical suggestions. + type: string + groupScore: + description: The score of this suggestion within its group. + type: number + format: double + alternativePhrases: + description: Alternative matching phrases for this suggestion. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1BigQuerySource: + id: GoogleCloudDiscoveryengineV1BigQuerySource + description: BigQuery source import data from. + type: object + properties: + partitionDate: + description: >- + BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD + format. + $ref: '#/components/schemas/GoogleTypeDate' + projectId: + description: >- + The project ID or the project number that contains the BigQuery + source. Has a length limit of 128 characters. If not specified, + inherits the project ID from the parent request. + type: string + datasetId: + description: >- + Required. The BigQuery data set to copy the data from with a length + limit of 1,024 characters. + type: string + tableId: + description: >- + Required. The BigQuery table to copy the data from with a length + limit of 1,024 characters. + type: string + gcsStagingDir: + description: >- + Intermediate Cloud Storage directory used for the import with a + length limit of 2,000 characters. Can be specified if one wants to + have the BigQuery export to a specific Cloud Storage directory. + type: string + dataSchema: + description: >- + The schema to use when parsing the data from the source. Supported + values for user event imports: * `user_event` (default): One + UserEvent per row. Supported values for document imports: * + `document` (default): One Document format per row. Each document + must have a valid Document.id and one of Document.json_data or + Document.struct_data. * `custom`: One custom data per row in + arbitrary format that conforms to the defined Schema of the data + store. This can only be used by the GENERIC Data Store vertical. + type: string + GoogleTypeDate: + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + properties: + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + type: integer + format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + type: integer + format: int32 + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1ImportErrorConfig: + id: GoogleCloudDiscoveryengineV1ImportErrorConfig + description: Configuration of destination for Import related errors. + type: object + properties: + gcsPrefix: + description: >- + Cloud Storage prefix for import errors. This must be an empty, + existing Cloud Storage directory. Import errors are written to + sharded files in this directory, one per line, as a JSON-encoded + `google.rpc.Status` message. + type: string + GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest: + id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest + description: Request message for CompletionService.PurgeCompletionSuggestions method. + type: object + properties: {} GoogleCloudDiscoveryengineV1Control: id: GoogleCloudDiscoveryengineV1Control description: >- @@ -321,7 +486,7 @@ components: type: string associatedServingConfigIds: description: >- - Output only. List of all ServingConfig ids this control is attached + Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. readOnly: true type: array @@ -594,8 +759,12 @@ components: The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more - information on ordering for retail search, see - [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) + information on ordering the website search results, see [Order web + search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + For more information on ordering the healthcare search results, see + [Order healthcare search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. type: string userInfo: @@ -603,6 +772,15 @@ components: Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1UserInfo' + languageCode: + description: >- + The BCP-47 language code, such as "en-US" or "sr-Latn". For more + information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). This + field helps to better interpret the query. If a value isn't + specified, the query language code is automatically detected, which + may not be accurate. + type: string facetSpecs: description: >- Facet specifications for faceted search. If empty, no facets are @@ -684,6 +862,39 @@ components: type: object additionalProperties: type: string + searchAsYouTypeSpec: + description: >- + Search as you type configuration. Only supported for the + IndustryVertical.MEDIA vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec + session: + description: >- + The session resource name. Optional. Session allows users to do + multi-turn /search API calls or coordination between /search API + calls and /answer API calls. Example #1 (multi-turn /search API + calls): 1. Call /search API with the auto-session mode (see below). + 2. Call /search API with the session ID generated in the first call. + Here, the previous search query gets considered in query standing. + I.e., if the first query is "How did Alphabet do in 2022?" and the + current query is "How about 2023?", the current query will be + interpreted as "How did Alphabet do in 2023?". Example #2 + (coordination between /search API calls and /answer API calls): 1. + Call /search API with the auto-session mode (see below). 2. Call + /answer API with the session ID generated in the first call. Here, + the answer generation happens in the context of the search results + from the first search call. Auto-session mode: when + `projects/.../sessions/-` is used, a new session gets automatically + created. Otherwise, users can use the create-session API to create a + session manually. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we + launch this feature to public GA. Or ask for allowlisting through + Google Support team. + type: string + sessionSpec: + description: Session specification. Can be used only when `session` is set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestSessionSpec GoogleCloudDiscoveryengineV1SearchRequestImageQuery: id: GoogleCloudDiscoveryengineV1SearchRequestImageQuery description: Specifies the image query input. @@ -698,9 +909,8 @@ components: id: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec description: >- A struct to define data stores to filter on in a search call and - configurations for those data stores. A maximum of 1 DataStoreSpec per - data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is - returned. + configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` + error is returned. type: object properties: dataStore: @@ -745,8 +955,11 @@ components: description: >- Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. - Values above 300 are coerced to 300. If this field is negative, an - `INVALID_ARGUMENT` is returned. + Values above 300 are coerced to 300. For aggregation in healthcare + search, when the [FacetKey.key] is "healthcare_aggregation_key", the + limit will be overridden to 10,000 internally, regardless of the + value set here. If this field is negative, an `INVALID_ARGUMENT` is + returned. type: integer format: int32 excludedFilterKeys: @@ -932,6 +1145,96 @@ components: applied. type: number format: float + boostControlSpec: + description: >- + Complex specification for custom ranking based on customer defined + attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec: + id: >- + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. + type: object + properties: + fieldName: + description: >- + The name of the field whose value will be used to determine the + boost amount. + type: string + attributeType: + description: >- + The attribute type to be used to determine the boost amount. The + attribute value can be derived from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. + attribute_value = numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - datetime_field_value). + type: string + enumDescriptions: + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: + description: >- + The interpolation type to be applied to connect the control points + listed below. + type: string + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + The control points used to define the curve. The monotonic function + (defined through the interpolation_type above) passes through the + control points listed here. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + description: >- + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). + type: object + properties: + attributeValue: + description: >- + Can be one of: 1. The numerical field value. 2. The duration spec + for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. + type: string + boostAmount: + description: >- + The value between -1 to 1 by which to boost the score if the + attribute_value evaluates to the value specified above. + type: number + format: float GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec: id: GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec description: >- @@ -1010,6 +1313,28 @@ components: extractive answer in the search response. $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec + searchResultMode: + description: >- + Specifies the search result mode. If unspecified, the search result + mode defaults to `DOCUMENTS`. + type: string + enumDescriptions: + - Default value. + - Returns documents in the search result. + - >- + Returns chunks in the search result. Only available if the + DataStore.DocumentProcessingConfig.chunking_config is specified. + enum: + - SEARCH_RESULT_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + chunkSpec: + description: >- + Specifies the chunk spec to be returned from the search response. + Only available if the + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec: id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec description: A specification for configuring snippets in a search response. @@ -1088,6 +1413,26 @@ components: skip generating summaries for non-summary seeking queries and return fallback messages instead. type: boolean + ignoreLowRelevantContent: + description: >- + Specifies whether to filter out queries that have low relevance. The + default value is `false`. If this field is set to `false`, all + search results are used regardless of relevance to generate answers. + If set to `true`, only queries with high relevance search results + will generate answers. + type: boolean + ignoreJailBreakingQuery: + description: >- + Optional. Specifies whether to filter out jail-breaking queries. The + default value is `false`. Google employs search-query classification + to detect jail-breaking queries. No summary is returned if the + search query is classified as a jail-breaking query. A user might + add instructions to the query to change the tone, style, language, + content of the answer, or ask the model to act as a different + entity, e.g. "Reply in the tone of a competing company's CEO". If + this field is set to `true`, we skip generating summaries for + jail-breaking queries and return fallback messages instead. + type: boolean modelPromptSpec: description: >- If specified, the spec will be used to modify the prompt provided to @@ -1196,6 +1541,79 @@ components: segments. type: integer format: int32 + GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec + description: >- + Specifies the chunk spec to be returned from the search response. Only + available if the SearchRequest.ContentSearchSpec.search_result_mode is + set to CHUNKS + type: object + properties: + numPreviousChunks: + description: >- + The number of previous chunks to be returned of the current chunk. + The maximum allowed value is 3. If not specified, no previous chunks + will be returned. + type: integer + format: int32 + numNextChunks: + description: >- + The number of next chunks to be returned of the current chunk. The + maximum allowed value is 3. If not specified, no next chunks will be + returned. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec + description: Specification for search as you type in search requests. + type: object + properties: + condition: + description: >- + The condition under which search as you type should occur. Default + to Condition.DISABLED. + type: string + enumDescriptions: + - Server behavior defaults to Condition.DISABLED. + - Disables Search As You Type. + - Enables Search As You Type. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + GoogleCloudDiscoveryengineV1SearchRequestSessionSpec: + id: GoogleCloudDiscoveryengineV1SearchRequestSessionSpec + description: >- + Session specification. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we launch + this feature to public GA. Or ask for allowlisting through Google + Support team. + type: object + properties: + queryId: + description: >- + If set, the search result gets stored to the "turn" specified by + this query ID. Example: Let's say the session looks like this: + session { name: ".../sessions/xxx" turns { query { text: "What is + foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { + query { text: "How about bar then?" query_id: ".../questions/zzz" } + } } The user can call /search API with a request like this: session: + ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } + Then, the API stores the search result, associated with the last + turn. The stored search result can be used by a subsequent /answer + API call (with the session ID and the query ID specified). Also, it + is possible to call /search and /answer in parallel with the same + session ID & query ID. + type: string + searchResultPersistenceCount: + description: >- + The number of top search results to persist. The persisted search + results can be used for the subsequent /answer api call. This field + is simliar to the `summary_result_count` field in + SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At + most 10 results for documents mode, or 50 for chunks mode. + type: integer + format: int32 GoogleCloudDiscoveryengineV1SearchResponse: id: GoogleCloudDiscoveryengineV1SearchResponse description: Response message for SearchService.Search method. @@ -1224,7 +1642,8 @@ components: description: >- A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of - search model performance. + search model performance. This also helps to identify a request + during the customer support scenarios. type: string redirectUri: description: >- @@ -1253,6 +1672,12 @@ components: description: Query expansion information for the returned results. $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseQueryExpansionInfo + sessionInfo: + description: >- + Session information. Only set if SearchRequest.session is provided. + See its description for more details. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseSessionInfo GoogleCloudDiscoveryengineV1SearchResponseSearchResult: id: GoogleCloudDiscoveryengineV1SearchResponseSearchResult description: Represents the search results. @@ -1266,6 +1691,11 @@ components: The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + chunk: + description: >- + The chunk data in the search response if the + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' GoogleCloudDiscoveryengineV1Document: id: GoogleCloudDiscoveryengineV1Document description: >- @@ -1332,6 +1762,15 @@ components: readOnly: true type: string format: google-datetime + indexStatus: + description: >- + Output only. The index status of the document. * If document is + indexed successfully, the index_time field is populated. * + Otherwise, if document is not indexed due to errors, the + error_samples field is populated. * Otherwise, index_status is + unset. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DocumentIndexStatus' GoogleCloudDiscoveryengineV1DocumentContent: id: GoogleCloudDiscoveryengineV1DocumentContent description: Unstructured data linked to this document. @@ -1351,7 +1790,7 @@ components: description: >- The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file - size is 2.5 MB for text-based formats, 100 MB for other formats. + size is 2.5 MB for text-based formats, 200 MB for other formats. type: string mimeType: description: >- @@ -1363,42 +1802,166 @@ components: (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. type: string - GoogleCloudDiscoveryengineV1SearchResponseFacet: - id: GoogleCloudDiscoveryengineV1SearchResponseFacet - description: A facet result. + GoogleCloudDiscoveryengineV1DocumentIndexStatus: + id: GoogleCloudDiscoveryengineV1DocumentIndexStatus + description: Index status of the document. type: object properties: - key: + indexTime: description: >- - The key for this facet. For example, `"colors"` or `"price"`. It - matches SearchRequest.FacetSpec.FacetKey.key. + The time when the document was indexed. If this field is populated, + it means the document has been indexed. type: string - values: - description: The facet values for this field. + format: google-datetime + errorSamples: + description: >- + A sample of errors encountered while indexing the document. If this + field is populated, the document is not indexed due to errors. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue - dynamicFacet: - description: Whether the facet is dynamically generated. - type: boolean - GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue: - id: GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue - description: A facet value which contains value names and their count. + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1Chunk: + id: GoogleCloudDiscoveryengineV1Chunk + description: >- + Chunk captures all raw metadata information of items to be recommended + or searched in the chunk mode. type: object properties: - value: - description: Text value of a facet, such as "Black" for facet "colors". - type: string - interval: + name: description: >- - Interval value for a facet, such as 10, 20) for facet "price". It - matches [SearchRequest.FacetSpec.FacetKey.intervals. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Interval' - count: - description: Number of items that have this facet value. + The full resource name of the chunk. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - format: int64 + id: + description: Unique chunk ID of the current chunk. + type: string + content: + description: Content is a string from a document (parsed content). + type: string + relevanceScore: + description: >- + Output only. Represents the relevance score based on similarity. + Higher score indicates higher chunk relevance. The score is in range + [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + readOnly: true + type: number + format: double + documentMetadata: + description: Metadata of the document from the current chunk. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ChunkDocumentMetadata + derivedStructData: + description: >- + Output only. This field is OUTPUT_ONLY. It contains derived data + that are not in the original input document. + readOnly: true + type: object + additionalProperties: + type: any + description: Properties of the object. + pageSpan: + description: Page span of the chunk. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ChunkPageSpan' + chunkMetadata: + description: Output only. Metadata of the current chunk. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ChunkChunkMetadata' + GoogleCloudDiscoveryengineV1ChunkDocumentMetadata: + id: GoogleCloudDiscoveryengineV1ChunkDocumentMetadata + description: >- + Document metadata contains the information of the document of the + current chunk. + type: object + properties: + uri: + description: Uri of the document. + type: string + title: + description: Title of the document. + type: string + structData: + description: >- + Data representation. The structured JSON data for the document. It + should conform to the registered Schema or an `INVALID_ARGUMENT` + error is thrown. + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1ChunkPageSpan: + id: GoogleCloudDiscoveryengineV1ChunkPageSpan + description: Page span of the chunk. + type: object + properties: + pageStart: + description: The start page of the chunk. + type: integer + format: int32 + pageEnd: + description: The end page of the chunk. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1ChunkChunkMetadata: + id: GoogleCloudDiscoveryengineV1ChunkChunkMetadata + description: >- + Metadata of the current chunk. This field is only populated on + SearchService.Search API. + type: object + properties: + previousChunks: + description: >- + The previous chunks of the current chunk. The number is controlled + by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. + This field is only populated on SearchService.Search API. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' + nextChunks: + description: >- + The next chunks of the current chunk. The number is controlled by + SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This + field is only populated on SearchService.Search API. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Chunk' + GoogleCloudDiscoveryengineV1SearchResponseFacet: + id: GoogleCloudDiscoveryengineV1SearchResponseFacet + description: A facet result. + type: object + properties: + key: + description: >- + The key for this facet. For example, `"colors"` or `"price"`. It + matches SearchRequest.FacetSpec.FacetKey.key. + type: string + values: + description: The facet values for this field. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue + dynamicFacet: + description: Whether the facet is dynamically generated. + type: boolean + GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue: + id: GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue + description: A facet value which contains value names and their count. + type: object + properties: + value: + description: Text value of a facet, such as "Black" for facet "colors". + type: string + interval: + description: >- + Interval value for a facet, such as 10, 20) for facet "price". It + matches [SearchRequest.FacetSpec.FacetKey.intervals. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Interval' + count: + description: Number of items that have this facet value. + type: string + format: int64 GoogleCloudDiscoveryengineV1SearchResponseSummary: id: GoogleCloudDiscoveryengineV1SearchResponseSummary description: Summary of the top N search results specified by the summary spec. @@ -1417,10 +1980,11 @@ components: enumDescriptions: - Default value. The summary skipped reason is not specified. - >- - The adversarial query ignored case. Only populated when + The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`. - >- - The non-summary seeking query ignored case. Only populated when + The non-summary seeking query ignored case. Google skips the + summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`. - >- The out-of-domain query ignored case. Google skips the summary @@ -1434,6 +1998,23 @@ components: - >- The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled. + - >- + The no relevant content case. Google skips the summary if there + is no relevant content in the retrieved search results. + - >- + The jail-breaking query ignored case. For example, "Reply in the + tone of a competing company's CEO". Only used when + [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] + is set to `true`. + - >- + The customer policy violation case. Google skips the summary if + there is a customer policy violation detected. The policy is + defined by the customer. + - >- + The non-answer seeking query ignored case. Google skips the + summary if the query doesn't have clear intent. Only used when + [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] + is set to `true`. enum: - SUMMARY_SKIPPED_REASON_UNSPECIFIED - ADVERSARIAL_QUERY_IGNORED @@ -1441,6 +2022,10 @@ components: - OUT_OF_DOMAIN_QUERY_IGNORED - POTENTIAL_POLICY_VIOLATION - LLM_ADDON_NOT_ENABLED + - NO_RELEVANT_CONTENT + - JAIL_BREAKING_QUERY_IGNORED + - CUSTOMER_POLICY_VIOLATION + - NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 safetyAttributes: description: >- A collection of Safety Attribute categories and their associated @@ -1582,6 +2167,25 @@ components: is set to true. type: string format: int64 + GoogleCloudDiscoveryengineV1SearchResponseSessionInfo: + id: GoogleCloudDiscoveryengineV1SearchResponseSessionInfo + description: Information about the session. + type: object + properties: + name: + description: >- + Name of the session. If the auto-session mode is used (when + SearchRequest.session ends with "-"), this field holds the newly + generated session name. + type: string + queryId: + description: >- + Query ID that corresponds to this search API call. One session can + have multiple turns, each with a unique query ID. By specifying the + session name and this query ID in the Answer API call, the answer + generation happens in the context of the search results from this + search call. + type: string GoogleCloudDiscoveryengineV1ConverseConversationRequest: id: GoogleCloudDiscoveryengineV1ConverseConversationRequest description: >- @@ -1595,7 +2199,7 @@ components: servingConfig: description: >- The resource name of the Serving Config to use. Format: - `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used. type: string conversation: @@ -1819,11 +2423,13 @@ components: #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec asynchronousMode: description: >- - Asynchronous mode control. If enabled, the response will be returned - with answer/session resource name without final answer. The API - users need to do the polling to get the latest status of + Deprecated: This field is deprecated. Streaming Answer API will be + supported. Asynchronous mode control. If enabled, the response will + be returned with answer/session resource name without final answer. + The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. + deprecated: true type: boolean userPseudoId: description: >- @@ -1835,6 +2441,24 @@ components: must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. type: string + userLabels: + description: >- + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string GoogleCloudDiscoveryengineV1Query: id: GoogleCloudDiscoveryengineV1Query description: Defines a user inputed query. @@ -1915,6 +2539,18 @@ components: of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. type: boolean + ignoreJailBreakingQuery: + description: >- + Optional. Specifies whether to filter out jail-breaking queries. The + default value is `false`. Google employs search-query classification + to detect jail-breaking queries. No summary is returned if the + search query is classified as a jail-breaking query. A user might + add instructions to the query to change the tone, style, language, + content of the answer, or ask the model to act as a different + entity, e.g. "Reply in the tone of a competing company's CEO". If + this field is set to `true`, we skip generating summaries for + jail-breaking queries and return fallback messages instead. + type: boolean GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec: id: >- GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec @@ -1990,6 +2626,22 @@ components: [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. type: string + searchResultMode: + description: >- + Specifies the search result mode. If unspecified, the search result + mode defaults to `DOCUMENTS`. See [parse and chunk + documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + type: string + enumDescriptions: + - Default value. + - Returns documents in the search result. + - >- + Returns chunks in the search result. Only available if the + DataStore.DocumentProcessingConfig.chunking_config is specified. + enum: + - SEARCH_RESULT_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS dataStoreSpecs: description: >- Specs defining dataStores to filter on in a search call and @@ -2110,6 +2762,24 @@ components: content: description: Chunk textual content. type: string + documentMetadata: + description: Metadata of the document from the current chunk. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata: + id: >- + GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata + description: >- + Document metadata contains the information of the document of the + current chunk. + type: object + properties: + uri: + description: Uri of the document. + type: string + title: + description: Title of the document. + type: string GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec: id: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec description: Query understanding specification. @@ -2137,11 +2807,17 @@ components: enumDescriptions: - Unspecified query classification type. - Adversarial query classification type. - - Non-answer-seeking query classification type. + - Non-answer-seeking query classification type, for chit chat. + - Jail-breaking query classification type. + - >- + Non-answer-seeking query classification type, for no clear + intent. enum: - TYPE_UNSPECIFIED - ADVERSARIAL_QUERY - NON_ANSWER_SEEKING_QUERY + - JAIL_BREAKING_QUERY + - NON_ANSWER_SEEKING_QUERY_V2 GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec: id: >- GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec @@ -2151,6 +2827,12 @@ components: disable: description: Disable query rephraser. type: boolean + maxRephraseSteps: + description: >- + Max rephrase steps. The max number is 5 steps. If not set or set to + < 1, it will be set to 1 by default. + type: integer + format: int32 GoogleCloudDiscoveryengineV1AnswerQueryResponse: id: GoogleCloudDiscoveryengineV1AnswerQueryResponse description: Response message for ConversationalSearchService.AnswerQuery method. @@ -2159,8 +2841,8 @@ components: answer: description: >- Answer resource object. If - AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use - Answer.name to fetch answer information using + AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps + is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' session: @@ -2231,7 +2913,9 @@ components: enumDescriptions: - Default value. The answer skipped reason is not specified. - The adversarial query ignored case. - - The non-answer seeking query ignored case. + - >- + The non-answer seeking query ignored case Google skips the + answer if the query is chit chat. - >- The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results. @@ -2239,12 +2923,30 @@ components: The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic. + - >- + The no relevant content case. Google skips the answer if there + is no relevant content in the retrieved search results. + - >- + The jail-breaking query ignored case. For example, "Reply in the + tone of a competing company's CEO". Google skips the answer if + the query is classified as a jail-breaking query. + - >- + The customer policy violation case. Google skips the summary if + there is a customer policy violation detected. The policy is + defined by the customer. + - >- + The non-answer seeking query ignored case. Google skips the + answer if the query doesn't have clear intent. enum: - ANSWER_SKIPPED_REASON_UNSPECIFIED - ADVERSARIAL_QUERY_IGNORED - NON_ANSWER_SEEKING_QUERY_IGNORED - OUT_OF_DOMAIN_QUERY_IGNORED - POTENTIAL_POLICY_VIOLATION + - NO_RELEVANT_CONTENT + - JAIL_BREAKING_QUERY_IGNORED + - CUSTOMER_POLICY_VIOLATION + - NON_ANSWER_SEEKING_QUERY_IGNORED_V2 createTime: description: Output only. Answer creation timestamp. readOnly: true @@ -2297,6 +2999,10 @@ components: description: Chunk information. $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo + structuredDocumentInfo: + description: Structured document information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo: id: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo description: Unstructured document information. @@ -2337,6 +3043,15 @@ components: pageIdentifier: description: Page identifier. type: string + relevanceScore: + description: >- + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. + type: number + format: float GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo: id: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo description: Chunk information. @@ -2349,7 +3064,12 @@ components: description: Chunk textual content. type: string relevanceScore: - description: Relevance score. + description: >- + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. type: number format: float documentMetadata: @@ -2381,6 +3101,20 @@ components: additionalProperties: type: any description: Properties of the object. + GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo: + id: GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo + description: Structured search information. + type: object + properties: + document: + description: Document resource name. + type: string + structData: + description: Structured search data. + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudDiscoveryengineV1AnswerStep: id: GoogleCloudDiscoveryengineV1AnswerStep description: Step information. @@ -2473,6 +3207,15 @@ components: items: $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo + structData: + description: >- + Data representation. The structured JSON data for the document. It's + populated from the struct data from the Document, or the Chunk in + search result. . + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo: id: >- GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo @@ -2498,7 +3241,12 @@ components: description: Chunk textual content. type: string relevanceScore: - description: Relevance score. + description: >- + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. type: number format: float GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo: @@ -2524,11 +3272,15 @@ components: enumDescriptions: - Unspecified query classification type. - Adversarial query classification type. - - Non-answer-seeking query classification type. + - Non-answer-seeking query classification type, for chit chat. + - Jail-breaking query classification type. + - Non-answer-seeking query classification type, for no clear intent. enum: - TYPE_UNSPECIFIED - ADVERSARIAL_QUERY - NON_ANSWER_SEEKING_QUERY + - JAIL_BREAKING_QUERY + - NON_ANSWER_SEEKING_QUERY_V2 positive: description: Classification output. type: boolean @@ -2670,16 +3422,26 @@ components: - Only contains documents without any Document.content. - Only contains documents with Document.content. - The data store is used for public website search. + - >- + The data store is used for workspace search. Details of workspace + data store are specified in the WorkspaceConfig. enum: - CONTENT_CONFIG_UNSPECIFIED - NO_CONTENT - CONTENT_REQUIRED - PUBLIC_WEBSITE + - GOOGLE_WORKSPACE createTime: description: Output only. Timestamp the DataStore was created at. readOnly: true type: string format: google-datetime + workspaceConfig: + description: >- + Config to store data store type configuration for workspace data. + This must be set when DataStore.content_config is set as + DataStore.ContentConfig.GOOGLE_WORKSPACE. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1WorkspaceConfig' documentProcessingConfig: description: Configuration for Document understanding and enrichment. $ref: >- @@ -2696,6 +3458,39 @@ components: from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Schema' + servingConfigDataStore: + description: Optional. Stores serving config at DataStore level. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ServingConfigDataStore + GoogleCloudDiscoveryengineV1WorkspaceConfig: + id: GoogleCloudDiscoveryengineV1WorkspaceConfig + description: Config to store data store type configuration for workspace data + type: object + properties: + type: + description: The Google Workspace data source. + type: string + enumDescriptions: + - Defaults to an unspecified Workspace type. + - Workspace Data Store contains Drive data + - Workspace Data Store contains Mail data + - Workspace Data Store contains Sites data + - Workspace Data Store contains Calendar data + - Workspace Data Store contains Chat data + - Workspace Data Store contains Groups data + - Workspace Data Store contains Keep data + enum: + - TYPE_UNSPECIFIED + - GOOGLE_DRIVE + - GOOGLE_MAIL + - GOOGLE_SITES + - GOOGLE_CALENDAR + - GOOGLE_CHAT + - GOOGLE_GROUPS + - GOOGLE_KEEP + dasherCustomerId: + description: Obfuscated Dasher customer ID. + type: string GoogleCloudDiscoveryengineV1DocumentProcessingConfig: id: GoogleCloudDiscoveryengineV1DocumentProcessingConfig description: >- @@ -2710,6 +3505,10 @@ components: The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. type: string + chunkingConfig: + description: Whether chunking mode is enabled. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig defaultParsingConfig: description: >- Configurations for default Document parser. If not specified, we @@ -2724,13 +3523,45 @@ components: based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML - files, only digital parsing and or layout parsing are supported. * + files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing - and or layout parsing are supported. + and layout parsing are supported. * `pptx`: Override parsing config + for PPTX files, only digital parsing and layout parsing are + supported. * `xlsm`: Override parsing config for XLSM files, only + digital parsing and layout parsing are supported. * `xlsx`: Override + parsing config for XLSX files, only digital parsing and layout + parsing are supported. type: object additionalProperties: $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig + GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig: + id: GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig + description: Configuration for chunking config. + type: object + properties: + layoutBasedChunkingConfig: + description: Configuration for the layout based chunking. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: + id: >- + GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + description: Configuration for the layout based chunking. + type: object + properties: + chunkSize: + description: >- + The token size limit for each chunk. Supported values: 100-500 + (inclusive). Default value: 500. + type: integer + format: int32 + includeAncestorHeadings: + description: >- + Whether to include appending different levels of headings to chunks + from the middle of the document to prevent context loss. Default + value: False. + type: boolean GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig: id: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig description: Related configurations applied to a specific type of document parser. @@ -2746,6 +3577,10 @@ components: PDFs. $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig + layoutParsingConfig: + description: Configurations applied to layout parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig: id: >- GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig @@ -2772,6 +3607,12 @@ components: If true, will use native text instead of OCR text on pages containing native text. type: boolean + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig + description: The layout parsing configurations for documents. + type: object + properties: {} GoogleCloudDiscoveryengineV1Schema: id: GoogleCloudDiscoveryengineV1Schema description: Defines the structure and layout of a type of document data. @@ -2793,6 +3634,18 @@ components: This field must be a UTF-8 encoded string with a length limit of 1024 characters. type: string + GoogleCloudDiscoveryengineV1ServingConfigDataStore: + id: GoogleCloudDiscoveryengineV1ServingConfigDataStore + description: >- + Stores information regarding the serving configurations at DataStore + level. + type: object + properties: + disabledForServing: + description: >- + If set true, the DataStore will not be available for serving search + requests. + type: boolean GoogleCloudDiscoveryengineV1ListDataStoresResponse: id: GoogleCloudDiscoveryengineV1ListDataStoresResponse description: Response message for DataStoreService.ListDataStores method. @@ -2852,6 +3705,9 @@ components: firestoreSource: description: Firestore input source. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1FirestoreSource' + alloyDbSource: + description: AlloyDB input source. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1AlloyDbSource' bigtableSource: description: Cloud Bigtable input source. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1BigtableSource' @@ -2929,99 +3785,32 @@ components: type: array items: $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' - GoogleCloudDiscoveryengineV1BigQuerySource: - id: GoogleCloudDiscoveryengineV1BigQuerySource - description: BigQuery source import data from. + GoogleCloudDiscoveryengineV1FhirStoreSource: + id: GoogleCloudDiscoveryengineV1FhirStoreSource + description: Cloud FhirStore source import data from. type: object properties: - partitionDate: - description: >- - BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD - format. - $ref: '#/components/schemas/GoogleTypeDate' - projectId: - description: >- - The project ID (can be project # or ID) that the BigQuery source is - in with a length limit of 128 characters. If not specified, inherits - the project ID from the parent request. - type: string - datasetId: - description: >- - Required. The BigQuery data set to copy the data from with a length - limit of 1,024 characters. - type: string - tableId: + fhirStore: description: >- - Required. The BigQuery table to copy the data from with a length - limit of 1,024 characters. + Required. The full resource name of the FHIR store to import data + from, in the format of + `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`. type: string gcsStagingDir: description: >- Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to - have the BigQuery export to a specific Cloud Storage directory. + have the FhirStore export to a specific Cloud Storage directory. type: string - dataSchema: + resourceTypes: description: >- - The schema to use when parsing the data from the source. Supported - values for user event imports: * `user_event` (default): One - UserEvent per row. Supported values for document imports: * - `document` (default): One Document format per row. Each document - must have a valid Document.id and one of Document.json_data or - Document.struct_data. * `custom`: One custom data per row in - arbitrary format that conforms to the defined Schema of the data - store. This can only be used by the GENERIC Data Store vertical. - type: string - GoogleTypeDate: - id: GoogleTypeDate - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - type: object - properties: - year: - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - type: integer - format: int32 - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1FhirStoreSource: - id: GoogleCloudDiscoveryengineV1FhirStoreSource - description: Cloud FhirStore source import data from. - type: object - properties: - fhirStore: - description: >- - Required. The full resource name of the FHIR store to import data - from, in the format of - `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`. - type: string - gcsStagingDir: - description: >- - Intermediate Cloud Storage directory used for the import with a - length limit of 2,000 characters. Can be specified if one wants to - have the FhirStore export to a specific Cloud Storage directory. - type: string + The FHIR resource types to import. The resource types should be a + subset of all [supported FHIR resource + types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). + Default to all supported FHIR resource types if empty. + type: array + items: + type: string GoogleCloudDiscoveryengineV1SpannerSource: id: GoogleCloudDiscoveryengineV1SpannerSource description: The Spanner source for importing data @@ -3029,9 +3818,9 @@ components: properties: projectId: description: >- - The project ID that the Spanner source is in with a length limit of - 128 characters. If not specified, inherits the project ID from the - parent request. + The project ID that contains the Spanner source. Has a length limit + of 128 characters. If not specified, inherits the project ID from + the parent request. type: string instanceId: description: Required. The instance ID of the source Spanner table. @@ -3057,9 +3846,9 @@ components: properties: projectId: description: >- - The project ID that the Cloud SQL source is in with a length limit - of 128 characters. If not specified, inherits the project ID from - the parent request. + The project ID that contains the Cloud SQL source. Has a length + limit of 128 characters. If not specified, inherits the project ID + from the parent request. type: string instanceId: description: >- @@ -3121,6 +3910,46 @@ components: Storage Admin permissions to access the specified Cloud Storage directory. type: string + GoogleCloudDiscoveryengineV1AlloyDbSource: + id: GoogleCloudDiscoveryengineV1AlloyDbSource + description: AlloyDB source import data from. + type: object + properties: + projectId: + description: >- + The project ID that contains the AlloyDB source. Has a length limit + of 128 characters. If not specified, inherits the project ID from + the parent request. + type: string + locationId: + description: >- + Required. The AlloyDB location to copy the data from with a length + limit of 256 characters. + type: string + clusterId: + description: >- + Required. The AlloyDB cluster to copy the data from with a length + limit of 256 characters. + type: string + databaseId: + description: >- + Required. The AlloyDB database to copy the data from with a length + limit of 256 characters. + type: string + tableId: + description: >- + Required. The AlloyDB table to copy the data from with a length + limit of 256 characters. + type: string + gcsStagingDir: + description: >- + Intermediate Cloud Storage directory used for the import with a + length limit of 2,000 characters. Can be specified if one wants to + have the AlloyDB export to a specific Cloud Storage directory. + Ensure that the AlloyDB service account has the necessary Cloud + Storage Admin permissions to access the specified Cloud Storage + directory. + type: string GoogleCloudDiscoveryengineV1BigtableSource: id: GoogleCloudDiscoveryengineV1BigtableSource description: The Cloud Bigtable source for importing data. @@ -3128,9 +3957,9 @@ components: properties: projectId: description: >- - The project ID that the Bigtable source is in with a length limit of - 128 characters. If not specified, inherits the project ID from the - parent request. + The project ID that contains the Bigtable source. Has a length limit + of 128 characters. If not specified, inherits the project ID from + the parent request. type: string instanceId: description: >- @@ -3291,33 +4120,121 @@ components: - BIG_NUMERIC - BOOLEAN - JSON - GoogleCloudDiscoveryengineV1ImportErrorConfig: - id: GoogleCloudDiscoveryengineV1ImportErrorConfig - description: Configuration of destination for Import related errors. - type: object - properties: - gcsPrefix: - description: >- - Cloud Storage prefix for import errors. This must be an empty, - existing Cloud Storage directory. Import errors are written to - sharded files in this directory, one per line, as a JSON-encoded - `google.rpc.Status` message. - type: string GoogleCloudDiscoveryengineV1PurgeDocumentsRequest: id: GoogleCloudDiscoveryengineV1PurgeDocumentsRequest description: Request message for DocumentService.PurgeDocuments method. type: object properties: + gcsSource: + description: >- + Cloud Storage location for the input content. Supported + `data_schema`: * `document_id`: One valid Document.id per line. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1GcsSource' + inlineSource: + description: Inline source for the input content for purge. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource filter: description: >- Required. Filter matching documents to purge. Only currently supported value is `*` (all items). type: string + errorConfig: + description: The desired location of errors incurred during the purge. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1PurgeErrorConfig' force: description: >- Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. type: boolean + GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource: + id: GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource + description: >- + The inline source for the input config for + DocumentService.PurgeDocuments method. + type: object + properties: + documents: + description: >- + Required. A list of full resource name of documents to purge. In the + format + `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. + Recommended max of 100 items. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1PurgeErrorConfig: + id: GoogleCloudDiscoveryengineV1PurgeErrorConfig + description: Configuration of destination for Purge related errors. + type: object + properties: + gcsPrefix: + description: >- + Cloud Storage prefix for purge errors. This must be an empty, + existing Cloud Storage directory. Purge errors are written to + sharded files in this directory, one per line, as a JSON-encoded + `google.rpc.Status` message. + type: string + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse: + id: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse + description: Response message for DocumentService.BatchGetDocumentsMetadata method. + type: object + properties: + documentsMetadata: + description: The metadata of the Documents. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata: + id: >- + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata + description: The metadata of a Document. + type: object + properties: + matcherValue: + description: The value of the matcher that was used to match the Document. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue + state: + description: The state of the document. + type: string + enumDescriptions: + - Should never be set. + - The Document is indexed. + - >- + The Document is not indexed because its URI is not in the + TargetSite. + - The Document is not indexed. + enum: + - STATE_UNSPECIFIED + - INDEXED + - NOT_IN_TARGET_SITE + - NOT_IN_INDEX + lastRefreshedTime: + description: The timestamp of the last time the Document was last indexed. + type: string + format: google-datetime + dataIngestionSource: + description: >- + The data ingestion source of the Document. Allowed values are: * + `batch`: Data ingested via Batch API, e.g., ImportDocuments. * + `streaming` Data ingested via Streaming API, e.g., FHIR streaming. + type: string + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue: + id: >- + GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue + description: The value of the matcher that was used to match the Document. + type: object + properties: + uri: + description: If match by URI, the URI of the Document. + type: string + fhirResource: + description: >- + Required. Format: + projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} + type: string GoogleCloudDiscoveryengineV1Engine: id: GoogleCloudDiscoveryengineV1Engine description: >- @@ -3349,7 +4266,7 @@ components: Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: - `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. type: string @@ -3708,8 +4625,8 @@ components: Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was - done for the claim and therefore citation_indices, and - anti_citation_indices should not be returned. + done for the claim and therefore citation_indices, + anti_citation_indices, and score should not be returned. type: boolean GoogleCloudDiscoveryengineV1ProvisionProjectRequest: id: GoogleCloudDiscoveryengineV1ProvisionProjectRequest @@ -4146,7 +5063,7 @@ components: name: description: >- The Document resource full name, of the form: - `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` type: string uri: description: The Document URI - only allowed for website data stores. @@ -4166,6 +5083,12 @@ components: type: array items: type: string + joined: + description: >- + Output only. Whether the referenced Document can be found in the + data store. + readOnly: true + type: boolean GoogleCloudDiscoveryengineV1PanelInfo: id: GoogleCloudDiscoveryengineV1PanelInfo description: Detailed panel information associated with a user event. @@ -4393,6 +5316,132 @@ components: retrieve the next page. If this field is omitted, there are no subsequent pages. type: string + GoogleCloudDiscoveryengineV1TrainCustomModelRequest: + id: GoogleCloudDiscoveryengineV1TrainCustomModelRequest + description: Request message for SearchTuningService.TrainCustomModel method. + type: object + properties: + gcsTrainingInput: + description: Cloud Storage training input. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput + modelType: + description: >- + Model to be trained. Supported values are: * **search-tuning**: Fine + tuning the search system based on data provided. + type: string + errorConfig: + description: >- + The desired location of errors incurred during the data ingestion + and training. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + modelId: + description: If not provided, a UUID will be generated. + type: string + GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput: + id: GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput + description: Cloud Storage training data input. + type: object + properties: + corpusDataPath: + description: >- + The Cloud Storage corpus data which could be associated in train + data. The data path format is `gs:///`. A newline delimited + jsonl/ndjson file. For search-tuning model, each line should have + the _id, title and text. Example: `{"_id": "doc1", title: "relevant + doc", "text": "relevant text"}` + type: string + queryDataPath: + description: >- + The gcs query data which could be associated in train data. The data + path format is `gs:///`. A newline delimited jsonl/ndjson file. For + search-tuning model, each line should have the _id and text. + Example: {"_id": "query1", "text": "example query"} + type: string + trainDataPath: + description: >- + Cloud Storage training data path whose format should be `gs:///`. + The file should be in tsv format. Each line should have the doc_id + and query_id and score (number). For search-tuning model, it should + have the query-id corpus-id score as tsv file header. The score + should be a number in `[0, inf+)`. The larger the number is, the + more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * + `query1\tdoc1\t1` + type: string + testDataPath: + description: >- + Cloud Storage test data. Same format as train_data_path. If not + provided, a random 80/20 train/test split will be performed on + train_data_path. + type: string + GoogleCloudDiscoveryengineV1ListCustomModelsResponse: + id: GoogleCloudDiscoveryengineV1ListCustomModelsResponse + description: Response message for SearchTuningService.ListCustomModels method. + type: object + properties: + models: + description: List of custom tuning models. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1CustomTuningModel' + GoogleCloudDiscoveryengineV1CustomTuningModel: + id: GoogleCloudDiscoveryengineV1CustomTuningModel + description: Metadata that describes a custom tuned model. + type: object + properties: + name: + description: >- + Required. The fully qualified resource name of the model. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + Model must be an alpha-numerical string with limit of 40 characters. + type: string + displayName: + description: The display name of the model. + type: string + modelVersion: + description: The version of the model. + type: string + format: int64 + modelState: + description: >- + The state that the model is in (e.g.`TRAINING` or + `TRAINING_FAILED`). + type: string + enumDescriptions: + - Default value. + - The model is in a paused training state. + - The model is currently training. + - The model has successfully completed training. + - The model is ready for serving. + - The model training failed. + - >- + The model training finished successfully but metrics did not + improve. + - Input data validation failed. Model training didn't start. + enum: + - MODEL_STATE_UNSPECIFIED + - TRAINING_PAUSED + - TRAINING + - TRAINING_COMPLETE + - READY_FOR_SERVING + - TRAINING_FAILED + - NO_IMPROVEMENT + - INPUT_VALIDATION_FAILED + createTime: + description: Timestamp the Model was created at. + deprecated: true + type: string + format: google-datetime + trainingStartTime: + description: Timestamp the model training was initiated. + type: string + format: google-datetime + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double GoogleCloudDiscoveryengineV1SiteSearchEngine: id: GoogleCloudDiscoveryengineV1SiteSearchEngine description: >- @@ -4614,6 +5663,12 @@ components: type: array items: type: string + siteCredential: + description: >- + Optional. Full resource name of the SiteCredential, such as + `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. + Only set to crawl private URIs. + type: string GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest: id: GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest description: >- @@ -4686,6 +5741,35 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + GoogleCloudDiscoveryengineV1PurgeUserEventsRequest: + id: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + description: Request message for PurgeUserEvents method. + type: object + properties: + filter: + description: >- + Required. The filter string to specify the events to be deleted with + a length limit of 5,000 characters. The eligible fields for + filtering are: * `eventType`: Double quoted UserEvent.event_type + string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: + Double quoted string. Specifying this will delete all events + associated with a visitor. * `userId`: Double quoted string. + Specifying this will delete all events associated with a user. + Examples: * Deleting all events in a time range: `eventTime > + "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * + Deleting specific eventType: `eventType = "search"` * Deleting all + events for a specific visitor: `userPseudoId = "visitor1024"` * + Deleting all events inside a DataStore: `*` The filtering fields are + assumed to have an implicit AND. + type: string + force: + description: >- + The `force` field is currently not supported. Purge user event + requests will permanently delete all purgeable events. Once the + development is complete: If `force` is set to false, the method will + return the expected purge count without deleting any user events. + This field will default to false if not included in the request. + type: boolean GoogleCloudDiscoveryengineV1ImportUserEventsRequest: id: GoogleCloudDiscoveryengineV1ImportUserEventsRequest description: Request message for the ImportUserEvents request. @@ -5058,11 +6142,12 @@ components: method. type: object properties: {} - GoogleCloudDiscoveryengineV1ImportDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1ImportDocumentsMetadata + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata description: >- - Metadata related to the progress of the ImportDocuments operation. This - is returned by the google.longrunning.Operation.metadata field. + Metadata related to the progress of the ImportCompletionSuggestions + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: createTime: @@ -5076,23 +6161,19 @@ components: type: string format: google-datetime successCount: - description: Count of entries that were processed successfully. + description: Count of CompletionSuggestions successfully imported. type: string format: int64 failureCount: - description: Count of entries that encountered errors while processing. - type: string - format: int64 - totalCount: - description: Total count of entries that were processed. + description: Count of CompletionSuggestions that failed to be imported. type: string format: int64 - GoogleCloudDiscoveryengineV1ImportDocumentsResponse: - id: GoogleCloudDiscoveryengineV1ImportDocumentsResponse + GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse description: >- - Response of the ImportDocumentsRequest. If the long running operation is - done, then this message is returned by the - google.longrunning.Operations.response field if the operation was + Response of the CompletionService.ImportCompletionSuggestions method. If + the long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is successful. type: object properties: @@ -5102,11 +6183,57 @@ components: items: $ref: '#/components/schemas/GoogleRpcStatus' errorConfig: - description: >- - Echoes the destination for the complete errors in the request if - set. + description: The desired location of errors incurred during the Import. $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' - GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata: + GoogleCloudDiscoveryengineV1ImportDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1ImportDocumentsMetadata + description: >- + Metadata related to the progress of the ImportDocuments operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were processed successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + totalCount: + description: Total count of entries that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1ImportDocumentsResponse: + id: GoogleCloudDiscoveryengineV1ImportDocumentsResponse + description: >- + Response of the ImportDocumentsRequest. If the long running operation is + done, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors in the request if + set. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata: id: GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata description: >- Metadata related to the progress of the ImportSuggestionDenyListEntries @@ -5206,9 +6333,9 @@ components: name: description: >- Output only. Full resource name of the project, for example - `projects/{project_number}`. Note that when making requests, project - number and project id are both acceptable, but the server will - always respond in project number. + `projects/{project}`. Note that when making requests, project number + and project id are both acceptable, but the server will always + respond in project number. readOnly: true type: string createTime: @@ -5282,6 +6409,39 @@ components: description: Metadata associated with a project provision operation. type: object properties: {} + GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata + description: >- + Metadata related to the progress of the PurgeCompletionSuggestions + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse + description: >- + Response message for CompletionService.PurgeCompletionSuggestions + method. + type: object + properties: + purgeSucceeded: + description: Whether the completion suggestions were successfully purged. + type: boolean + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata: id: GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata description: >- @@ -5365,6 +6525,59 @@ components: type: array items: $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1TrainCustomModelMetadata: + id: GoogleCloudDiscoveryengineV1TrainCustomModelMetadata + description: >- + Metadata related to the progress of the TrainCustomModel operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1TrainCustomModelResponse: + id: GoogleCloudDiscoveryengineV1TrainCustomModelResponse + description: >- + Response of the TrainCustomModelRequest. This message is returned by the + google.longrunning.Operations.response field. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the data. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors in the request if + set. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1ImportErrorConfig' + modelStatus: + description: >- + The trained model status. Possible values are: * **bad-data**: The + training data quality is bad. * **no-improvement**: Tuning didn't + improve performance. Won't deploy. * **in-progress**: Model training + job creation is in progress. * **training**: Model is actively + training. * **evaluating**: The model is evaluating trained metrics. + * **indexing**: The model trained metrics are indexing. * **ready**: + The model is ready for serving. + type: string + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double + modelName: + description: Fully qualified name of the CustomTuningModel. + type: string GoogleCloudDiscoveryengineV1UpdateSchemaMetadata: id: GoogleCloudDiscoveryengineV1UpdateSchemaMetadata description: Metadata for UpdateSchema LRO. @@ -5504,7 +6717,9 @@ components: enumDescriptions: - Default value. The answer skipped reason is not specified. - The adversarial query ignored case. - - The non-answer seeking query ignored case. + - >- + The non-answer seeking query ignored case Google skips the + answer if the query is chit chat. - >- The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results. @@ -5512,12 +6727,30 @@ components: The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic. + - >- + The no relevant content case. Google skips the answer if there + is no relevant content in the retrieved search results. + - >- + The jail-breaking query ignored case. For example, "Reply in the + tone of a competing company's CEO". Google skips the answer if + the query is classified as a jail-breaking query. + - >- + The customer policy violation case. Google skips the summary if + there is a customer policy violation detected. The policy is + defined by the customer. + - >- + The non-answer seeking query ignored case. Google skips the + answer if the query doesn't have clear intent. enum: - ANSWER_SKIPPED_REASON_UNSPECIFIED - ADVERSARIAL_QUERY_IGNORED - NON_ANSWER_SEEKING_QUERY_IGNORED - OUT_OF_DOMAIN_QUERY_IGNORED - POTENTIAL_POLICY_VIOLATION + - NO_RELEVANT_CONTENT + - JAIL_BREAKING_QUERY_IGNORED + - CUSTOMER_POLICY_VIOLATION + - NON_ANSWER_SEEKING_QUERY_IGNORED_V2 createTime: description: Output only. Answer creation timestamp. readOnly: true @@ -5570,6 +6803,10 @@ components: description: Chunk information. $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo + structuredDocumentInfo: + description: Structured document information. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo: id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo description: Unstructured document information. @@ -5610,6 +6847,15 @@ components: pageIdentifier: description: Page identifier. type: string + relevanceScore: + description: >- + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. + type: number + format: float GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo: id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo description: Chunk information. @@ -5622,7 +6868,12 @@ components: description: Chunk textual content. type: string relevanceScore: - description: Relevance score. + description: >- + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. type: number format: float documentMetadata: @@ -5655,6 +6906,20 @@ components: additionalProperties: type: any description: Properties of the object. + GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo: + id: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo + description: Structured search information. + type: object + properties: + document: + description: Document resource name. + type: string + structData: + description: Structured search data. + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudDiscoveryengineV1alphaAnswerStep: id: GoogleCloudDiscoveryengineV1alphaAnswerStep description: Step information. @@ -5748,6 +7013,15 @@ components: items: $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo + structData: + description: >- + Data representation. The structured JSON data for the document. It's + populated from the struct data from the Document, or the Chunk in + search result. . + type: object + additionalProperties: + type: any + description: Properties of the object. GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo: id: >- GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo @@ -5773,7 +7047,12 @@ components: description: Chunk textual content. type: string relevanceScore: - description: Relevance score. + description: >- + The relevance of the chunk for a given query. Values range from 0.0 + (completely irrelevant) to 1.0 (completely relevant). This value is + for informational purpose only. It may change for the same query and + chunk at any time due to a model retraining or change in + implementation. type: number format: float GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo: @@ -5799,11 +7078,15 @@ components: enumDescriptions: - Unspecified query classification type. - Adversarial query classification type. - - Non-answer-seeking query classification type. + - Non-answer-seeking query classification type, for chit chat. + - Jail-breaking query classification type. + - Non-answer-seeking query classification type, for no clear intent. enum: - TYPE_UNSPECIFIED - ADVERSARIAL_QUERY - NON_ANSWER_SEEKING_QUERY + - JAIL_BREAKING_QUERY + - NON_ANSWER_SEEKING_QUERY_V2 positive: description: Classification output. type: boolean @@ -6009,7 +7292,7 @@ components: type: string associatedServingConfigIds: description: >- - Output only. List of all ServingConfig ids this control is attached + Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. readOnly: true type: array @@ -6217,6 +7500,11 @@ components: the finish time. type: string format: google-datetime + GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata: + id: GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata + description: Metadata for EvaluationService.CreateEvaluation method. + type: object + properties: {} GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata: id: GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata description: Metadata for Create Schema LRO. @@ -6323,16 +7611,27 @@ components: - Only contains documents without any Document.content. - Only contains documents with Document.content. - The data store is used for public website search. + - >- + The data store is used for workspace search. Details of workspace + data store are specified in the WorkspaceConfig. enum: - CONTENT_CONFIG_UNSPECIFIED - NO_CONTENT - CONTENT_REQUIRED - PUBLIC_WEBSITE + - GOOGLE_WORKSPACE createTime: description: Output only. Timestamp the DataStore was created at. readOnly: true type: string format: google-datetime + languageInfo: + description: Language info for DataStore. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaLanguageInfo' + naturalLanguageQueryUnderstandingConfig: + description: Optional. Configuration for Natural Language Query Understanding. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig idpConfig: description: Output only. Data store level identity provider config. readOnly: true @@ -6348,6 +7647,13 @@ components: `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. type: boolean + workspaceConfig: + description: >- + Config to store data store type configuration for workspace data. + This must be set when DataStore.content_config is set as + DataStore.ContentConfig.GOOGLE_WORKSPACE. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaWorkspaceConfig documentProcessingConfig: description: Configuration for Document understanding and enrichment. $ref: >- @@ -6364,6 +7670,85 @@ components: from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSchema' + servingConfigDataStore: + description: Optional. Stores serving config at DataStore level. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaServingConfigDataStore + GoogleCloudDiscoveryengineV1alphaLanguageInfo: + id: GoogleCloudDiscoveryengineV1alphaLanguageInfo + description: Language info for DataStore. + type: object + properties: + languageCode: + description: The language code for the DataStore. + type: string + normalizedLanguageCode: + description: >- + Output only. This is the normalized form of language_code. E.g.: + language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have + normalized_language_code of `en-GB`. + readOnly: true + type: string + language: + description: >- + Output only. Language part of normalized_language_code. E.g.: + `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. + readOnly: true + type: string + region: + description: >- + Output only. Region part of normalized_language_code, if present. + E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig: + id: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig + description: Configuration for Natural Language Query Understanding. + type: object + properties: + mode: + description: >- + Mode of Natural Language Query Understanding. If this field is + unset, the behavior defaults to + NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + type: string + enumDescriptions: + - Default value. + - Natural Language Query Understanding is disabled. + - Natural Language Query Understanding is enabled. + enum: + - MODE_UNSPECIFIED + - DISABLED + - ENABLED + GoogleCloudDiscoveryengineV1alphaWorkspaceConfig: + id: GoogleCloudDiscoveryengineV1alphaWorkspaceConfig + description: Config to store data store type configuration for workspace data + type: object + properties: + type: + description: The Google Workspace data source. + type: string + enumDescriptions: + - Defaults to an unspecified Workspace type. + - Workspace Data Store contains Drive data + - Workspace Data Store contains Mail data + - Workspace Data Store contains Sites data + - Workspace Data Store contains Calendar data + - Workspace Data Store contains Chat data + - Workspace Data Store contains Groups data + - Workspace Data Store contains Keep data + enum: + - TYPE_UNSPECIFIED + - GOOGLE_DRIVE + - GOOGLE_MAIL + - GOOGLE_SITES + - GOOGLE_CALENDAR + - GOOGLE_CHAT + - GOOGLE_GROUPS + - GOOGLE_KEEP + dasherCustomerId: + description: Obfuscated Dasher customer ID. + type: string GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig: id: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig description: >- @@ -6396,9 +7781,14 @@ components: based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML - files, only digital parsing and or layout parsing are supported. * + files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing - and or layout parsing are supported. + and layout parsing are supported. * `pptx`: Override parsing config + for PPTX files, only digital parsing and layout parsing are + supported. * `xlsm`: Override parsing config for XLSM files, only + digital parsing and layout parsing are supported. * `xlsx`: Override + parsing config for XLSX files, only digital parsing and layout + parsing are supported. type: object additionalProperties: $ref: >- @@ -6704,11 +8094,15 @@ components: - Value used when unset. - Retrieve value from meta tag. - Retrieve value from page map. + - >- + Retrieve value from the attributes set by + SiteSearchEngineService.SetUriPatternDocumentData API. - Retrieve value from schema.org data. enum: - ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED - METATAGS - PAGEMAP + - URI_PATTERN_MAPPING - SCHEMA_ORG schemaOrgPaths: description: >- @@ -6723,6 +8117,18 @@ components: type: array items: type: string + GoogleCloudDiscoveryengineV1alphaServingConfigDataStore: + id: GoogleCloudDiscoveryengineV1alphaServingConfigDataStore + description: >- + Stores information regarding the serving configurations at DataStore + level. + type: object + properties: + disabledForServing: + description: >- + If set true, the DataStore will not be available for serving search + requests. + type: boolean GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata: id: GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata description: >- @@ -6891,7 +8297,7 @@ components: Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: - `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. type: string @@ -7237,1663 +8643,4570 @@ components: description: Total number of documents. type: string format: int64 - GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata + GoogleCloudDiscoveryengineV1alphaEvaluation: + id: GoogleCloudDiscoveryengineV1alphaEvaluation description: >- - Metadata related to the progress of the ImportDocuments operation. This - is returned by the google.longrunning.Operation.metadata field. + An evaluation is a single execution (or run) of an evaluation process. + It encapsulates the state of the evaluation and the resulting data. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + name: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Identifier. The full resource name of the Evaluation, in the format + of + `projects/{project}/locations/{location}/evaluations/{evaluation}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. type: string - format: google-datetime - successCount: - description: Count of entries that were processed successfully. + evaluationSpec: + description: Required. The specification of the evaluation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec + qualityMetrics: + description: >- + Output only. The metrics produced by the evaluation, averaged across + all SampleQuerys in the SampleQuerySet. Only populated when the + evaluation's state is SUCCEEDED. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetrics' + state: + description: Output only. The state of the evaluation. + readOnly: true type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. + enumDescriptions: + - The evaluation is unspecified. + - The service is preparing to run the evaluation. + - The evaluation is in progress. + - The evaluation completed successfully. + - The evaluation failed. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + error: + description: >- + Output only. The error that occurred during evaluation. Only + populated when the evaluation's state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + createTime: + description: Output only. Timestamp the Evaluation was created at. + readOnly: true type: string - format: int64 - totalCount: - description: Total count of entries that were processed. + format: google-datetime + endTime: + description: Output only. Timestamp the Evaluation was completed at. + readOnly: true type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse: - id: GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse - description: >- - Response of the ImportDocumentsRequest. If the long running operation is - done, then this message is returned by the - google.longrunning.Operations.response field if the operation was - successful. - type: object - properties: + format: google-datetime errorSamples: - description: A sample of errors encountered while processing the request. + description: >- + Output only. A sample of errors encountered while processing the + request. + readOnly: true type: array items: $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: - description: >- - Echoes the destination for the complete errors in the request if - set. + GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec: + id: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec + description: Describes the specification of the evaluation. + type: object + properties: + searchRequest: + description: >- + Required. The search request that is used to perform the evaluation. + Only the following fields within SearchRequest are supported; if any + other fields are provided, an UNSUPPORTED error will be returned: * + SearchRequest.serving_config * SearchRequest.branch * + SearchRequest.canonical_filter * SearchRequest.query_expansion_spec + * SearchRequest.spell_correction_spec * + SearchRequest.content_search_spec * SearchRequest.user_pseudo_id + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequest' + querySetSpec: + description: Required. The specification of the query set. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - GoogleCloudDiscoveryengineV1alphaImportErrorConfig: - id: GoogleCloudDiscoveryengineV1alphaImportErrorConfig - description: Configuration of destination for Import related errors. + #/components/schemas/GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec + GoogleCloudDiscoveryengineV1alphaSearchRequest: + id: GoogleCloudDiscoveryengineV1alphaSearchRequest + description: Request message for SearchService.Search method. type: object properties: - gcsPrefix: + servingConfig: description: >- - Cloud Storage prefix for import errors. This must be an empty, - existing Cloud Storage directory. Import errors are written to - sharded files in this directory, one per line, as a JSON-encoded - `google.rpc.Status` message. - type: string - GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata - description: >- - Metadata related to the progress of the ImportSuggestionDenyListEntries - operation. This is returned by the google.longrunning.Operation.metadata - field. - type: object - properties: - createTime: - description: Operation create time. + Required. The resource name of the Search serving config, such as + `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + or + `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. + This field is used to identify the serving configuration name, set + of models used to make the search. type: string - format: google-datetime - updateTime: + branch: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse - description: >- - Response message for CompletionService.ImportSuggestionDenyListEntries - method. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - importedEntriesCount: - description: Count of deny list entries successfully imported. - type: string - format: int64 - failedEntriesCount: - description: Count of deny list entries that failed to be imported. + The branch resource name, such as + `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. + Use `default_branch` as the branch ID or leave this field empty, to + search documents under the default branch. type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: - id: GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata - description: >- - Metadata related to the progress of the Import operation. This is - returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + query: + description: Raw search query. type: string - format: google-datetime - updateTime: + imageQuery: + description: Raw image query. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery + pageSize: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were processed successfully. - type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse: - id: GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse - description: >- - Response of the ImportUserEventsRequest. If the long running operation - was successful, then this message is returned by the - google.longrunning.Operations.response field if the operation was - successful. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the request. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: + Maximum number of Documents to return. The maximum allowed value + depends on the data type. Values above the maximum value are coerced + to the maximum value. * Websites with basic indexing: Default `10`, + Maximum `25`. * Websites with advanced indexing: Default `25`, + Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is + negative, an `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + pageToken: description: >- - Echoes the destination for the complete errors if this field was set - in the request. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - joinedEventsCount: - description: Count of user events imported with complete existing Documents. + A page token received from a previous SearchService.Search call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to SearchService.Search must match the + call that provided the page token. Otherwise, an `INVALID_ARGUMENT` + error is returned. type: string - format: int64 - unjoinedEventsCount: + offset: description: >- - Count of user events imported, but with Document information not - found in the existing Branch. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse: - id: GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse - description: Response message for SearchTuningService.ListCustomModels method. - type: object - properties: - models: - description: List of custom tuning models. + A 0-indexed integer that specifies the current offset (that is, + starting result location, amongst the Documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. If this field is negative, an + `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + dataStoreSpecs: + description: >- + Specs defining dataStores to filter on in a search call and + configurations for those dataStores. This is only considered for + engines with multiple dataStores use case. For single dataStore + within an engine, they should use the specs at the top level. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaCustomTuningModel - GoogleCloudDiscoveryengineV1alphaCustomTuningModel: - id: GoogleCloudDiscoveryengineV1alphaCustomTuningModel - description: Metadata that describes a custom tuned model. - type: object - properties: - name: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec + filter: description: >- - Required. The fully qualified resource name of the model. Format: - `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` - model must be an alpha-numerical string with limit of 40 characters. - type: string - displayName: - description: The display name of the model. - type: string - modelVersion: - description: The version of the model. + The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. Filter expression is case-sensitive. If this field + is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in + Vertex AI Search is done by mapping the LHS filter key to a key + property defined in the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For example a media + customer might have a field 'name' in their schema. In this case the + filter would look like this: filter --> name:'ANY("king kong")' For + more information about filtering including syntax and filter + operators, see + [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) type: string - format: int64 - modelState: + canonicalFilter: description: >- - The state that the model is in (e.g.`TRAINING` or - `TRAINING_FAILED`). - type: string - enumDescriptions: - - Default value. - - The model is in a paused training state. - - The model is currently training. - - The model has successfully completed training. - - The model is ready for serving. - - The model training failed. - enum: - - MODEL_STATE_UNSPECIFIED - - TRAINING_PAUSED - - TRAINING - - TRAINING_COMPLETE - - READY_FOR_SERVING - - TRAINING_FAILED - createTime: - description: Timestamp the Model was created at. - type: string - format: google-datetime - trainingStartTime: - description: Timestamp the model training was initiated. + The default filter that is applied when a user performs a search + without checking any filters on the search page. The filter applied + to every search request when quality improvement such as query + expansion is needed. In the case a query does not have a sufficient + amount of results this filter will be used to determine whether or + not to enable the query expansion flow. The original filter will + still be used for the query expanded search. This field is strongly + recommended to achieve high search quality. For more information + about filter syntax, see SearchRequest.filter. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaProject: - id: GoogleCloudDiscoveryengineV1alphaProject - description: Metadata and configurations for a Google Cloud project in the service. - type: object - properties: - name: + orderBy: description: >- - Output only. Full resource name of the project, for example - `projects/{project_number}`. Note that when making requests, project - number and project id are both acceptable, but the server will - always respond in project number. - readOnly: true + The order in which documents are returned. Documents can be ordered + by a field in an Document object. Leave it unset if ordered by + relevance. `order_by` expression is case-sensitive. For more + information on ordering the website search results, see [Order web + search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + For more information on ordering the healthcare search results, see + [Order healthcare search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. type: string - createTime: - description: Output only. The timestamp when this project is created. - readOnly: true + userInfo: + description: >- + Information about the end user. Highly recommended for analytics. + UserInfo.user_agent is used to deduce `device_type` for analytics. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaUserInfo' + languageCode: + description: >- + The BCP-47 language code, such as "en-US" or "sr-Latn". For more + information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). This + field helps to better interpret the query. If a value isn't + specified, the query language code is automatically detected, which + may not be accurate. type: string - format: google-datetime - provisionCompletionTime: + regionCode: description: >- - Output only. The timestamp when this project is successfully - provisioned. Empty value means this project is still provisioning - and is not ready for use. - readOnly: true + The Unicode country/region code (CLDR) of a location, such as "US" + and "419". For more information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). If + set, then results will be boosted based on the region_code provided. type: string - format: google-datetime - serviceTermsMap: + facetSpecs: description: >- - Output only. A map of terms of services. The key is the `id` of - ServiceTerms. - readOnly: true - type: object - additionalProperties: + Facet specifications for faceted search. If empty, no facets are + returned. A maximum of 100 values are allowed. Otherwise, an + `INVALID_ARGUMENT` error is returned. + type: array + items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaProjectServiceTerms - GoogleCloudDiscoveryengineV1alphaProjectServiceTerms: - id: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms - description: Metadata about the terms of service. - type: object - properties: - id: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec + boostSpec: description: >- - The unique identifier of this terms of service. Available terms: * - `GA_DATA_USE_TERMS`: [Terms for data - use](https://cloud.google.com/retail/data-use-terms). When using - this as `id`, the acceptable version to provide is `2022-11-23`. - type: string - version: + Boost specification to boost certain documents. For more information + on boosting, see + [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec + params: description: >- - The version string of the terms of service. For acceptable values, - see the comments for id above. + Additional search parameters. For public website search only, + supported values are: * `user_country_code`: string. Default empty. + If set to non-empty, results are restricted or boosted based on the + location provided. For example, `user_country_code: "au"` For + available codes see [Country + Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * `search_type`: double. Default empty. Enables non-webpage + searching depending on the value. The only valid non-default value + is 1, which enables image searching. For example, `search_type: 1` + type: object + additionalProperties: + type: any + queryExpansionSpec: + description: >- + The query expansion specification that specifies the conditions + under which query expansion occurs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec + spellCorrectionSpec: + description: >- + The spell correction specification that specifies the mode under + which spell correction takes effect. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec + userPseudoId: + description: >- + A unique identifier for tracking visitors. For example, this could + be implemented with an HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This unique identifier should + not change if the visitor logs in or out of the website. This field + should NOT have a fixed value such as `unknown_visitor`. This should + be the same identifier as UserEvent.user_pseudo_id and + CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + `INVALID_ARGUMENT` error is returned. type: string - state: + contentSearchSpec: + description: A specification for configuring the behavior of content search. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec + embeddingSpec: + description: >- + Uses the provided embedding to do additional semantic document + retrieval. The retrieval is based on the dot product of + SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document + embedding that is provided in + SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If + SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not + provided, it will use ServingConfig.EmbeddingConfig.field_path. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec + rankingExpression: + description: >- + The ranking expression controls the customized ranking on retrieval + documents. This overrides ServingConfig.ranking_expression. The + ranking expression is a single function or multiple functions that + are joined by "+". * ranking_expression = function, { " + ", + function }; Supported functions: * double * relevance_score * double + * dotProduct(embedding_field_path) Function variables: * + `relevance_score`: pre-defined keywords, used for measure relevance + between query and document. * `embedding_field_path`: the document + embedding field used with query embedding vector. * `dotProduct`: + embedding function between embedding_field_path and query embedding + vector. Example ranking expression: If document has an embedding + field doc_embedding, the ranking expression could be `0.5 * + relevance_score + 0.3 * dotProduct(doc_embedding)`. + type: string + safeSearch: description: >- - Whether the project has accepted/rejected the service terms or it is - still pending. + Whether to turn on safe search. This is only supported for website + search. + type: boolean + userLabels: + description: >- + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: + type: string + naturalLanguageQueryUnderstandingSpec: + description: >- + If `naturalLanguageQueryUnderstandingSpec` is not specified, no + additional natural language query understanding will be done. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec + searchAsYouTypeSpec: + description: >- + Search as you type configuration. Only supported for the + IndustryVertical.MEDIA vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec + customFineTuningSpec: + description: >- + Custom fine tuning configs. If set, it has higher priority than the + configs set in ServingConfig.custom_fine_tuning_spec. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec + session: + description: >- + The session resource name. Optional. Session allows users to do + multi-turn /search API calls or coordination between /search API + calls and /answer API calls. Example #1 (multi-turn /search API + calls): 1. Call /search API with the auto-session mode (see below). + 2. Call /search API with the session ID generated in the first call. + Here, the previous search query gets considered in query standing. + I.e., if the first query is "How did Alphabet do in 2022?" and the + current query is "How about 2023?", the current query will be + interpreted as "How did Alphabet do in 2023?". Example #2 + (coordination between /search API calls and /answer API calls): 1. + Call /search API with the auto-session mode (see below). 2. Call + /answer API with the session ID generated in the first call. Here, + the answer generation happens in the context of the search results + from the first search call. Auto-session mode: when + `projects/.../sessions/-` is used, a new session gets automatically + created. Otherwise, users can use the create-session API to create a + session manually. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we + launch this feature to public GA. Or ask for allowlisting through + Google Support team. + type: string + sessionSpec: + description: Session specification. Can be used only when `session` is set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec + relevanceThreshold: + description: >- + The relevance threshold of the search results. Default to Google + defined threshold, leveraging a balance of precision and recall to + deliver both highly accurate results and comprehensive coverage of + relevant information. type: string enumDescriptions: - - The default value of the enum. This value is not actually used. - - The project has given consent to the terms of service. - - The project is pending to review and accept the terms of service. - >- - The project has declined or revoked the agreement to terms of - service. + Default value. In this case, server behavior defaults to Google + defined threshold. + - Lowest relevance threshold. + - Low relevance threshold. + - Medium relevance threshold. + - High relevance threshold. enum: - - STATE_UNSPECIFIED - - TERMS_ACCEPTED - - TERMS_PENDING - - TERMS_DECLINED - acceptTime: - description: The last time when the project agreed to the terms of service. - type: string - format: google-datetime - declineTime: + - RELEVANCE_THRESHOLD_UNSPECIFIED + - LOWEST + - LOW + - MEDIUM + - HIGH + GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery + description: Specifies the image query input. + type: object + properties: + imageBytes: description: >- - The last time when the project declined or revoked the agreement to - terms of service. + Base64 encoded image bytes. Supported image formats: JPEG, PNG, and + BMP. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata: - id: GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata - description: Metadata associated with a project provision operation. - type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata: - id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata + GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec description: >- - Metadata related to the progress of the PurgeDocuments operation. This - will be returned by the google.longrunning.Operation.metadata field. + A struct to define data stores to filter on in a search call and + configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` + error is returned. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + dataStore: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were deleted successfully. + Required. Full resource name of DataStore, such as + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. + GoogleCloudDiscoveryengineV1alphaUserInfo: + id: GoogleCloudDiscoveryengineV1alphaUserInfo + description: Information of an end user. + type: object + properties: + userId: + description: >- + Highly recommended for logged-in users. Unique identifier for + logged-in user, such as a user name. Don't set for anonymous users. + Always use a hashed value for this ID. Don't set the field to the + same fixed ID for different users. This mixes the event history of + those users together, which results in degraded model quality. The + field must be a UTF-8 encoded string with a length limit of 128 + characters. Otherwise, an `INVALID_ARGUMENT` error is returned. type: string - format: int64 - ignoredCount: - description: Count of entries that were ignored as entries were not found. + userAgent: + description: >- + User agent as included in the HTTP header. The field must be a UTF-8 + encoded string with a length limit of 1,000 characters. Otherwise, + an `INVALID_ARGUMENT` error is returned. This should not be set when + using the client side event reporting with GTM or JavaScript tag in + UserEventService.CollectUserEvent or if + UserEvent.direct_user_request is set. type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse: - id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse - description: >- - Response message for DocumentService.PurgeDocuments method. If the long - running operation is successfully done, then this message is returned by - the google.longrunning.Operations.response field. + GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec + description: A facet specification to perform faceted search. type: object properties: - purgeCount: - description: The total count of documents purged as a result of the operation. - type: string - format: int64 - purgeSample: + facetKey: + description: Required. The facet key specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey + limit: description: >- - A sample of document names that will be deleted. Only populated if - `force` is set to false. A max of 100 names will be returned and the - names are chosen at random. + Maximum facet values that are returned for this facet. If + unspecified, defaults to 20. The maximum allowed value is 300. + Values above 300 are coerced to 300. For aggregation in healthcare + search, when the [FacetKey.key] is "healthcare_aggregation_key", the + limit will be overridden to 10,000 internally, regardless of the + value set here. If this field is negative, an `INVALID_ARGUMENT` is + returned. + type: integer + format: int32 + excludedFilterKeys: + description: >- + List of keys to exclude when faceting. By default, FacetKey.key is + not excluded from the filter unless it is listed in this field. + Listing a facet key in this field allows its values to appear as + facet results, even when they are filtered out of search results. + Using this field does not affect what search results are returned. + For example, suppose there are 100 documents with the color facet + "Red" and 200 documents with the color facet "Blue". A query + containing the filter "color:ANY("Red")" and having "color" as + FacetKey.key would by default return only "Red" documents in the + search results, and also return "Red" with count 100 as the only + color facet. Although there are also blue documents available, + "Blue" would not be shown as an available facet value. If "color" is + listed in "excludedFilterKeys", then the query returns the facet + values "Red" with count 100 and "Blue" with count 200, because the + "color" key is now excluded from the filter. Because this field + doesn't affect search results, the search results are still + correctly filtered to return only "Red" documents. A maximum of 100 + values are allowed. Otherwise, an `INVALID_ARGUMENT` error is + returned. type: array items: type: string - GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata: - id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata - description: >- - Metadata related to the progress of the PurgeSuggestionDenyListEntries - operation. This is returned by the google.longrunning.Operation.metadata - field. + enableDynamicPosition: + description: >- + Enables dynamic position for this facet. If set to true, the + position of this facet among all facets in the response is + determined automatically. If dynamic facets are enabled, it is + ordered together. If set to false, the position of this facet in the + response is the same as in the request, and it is ranked before the + facets with dynamic position enable and all dynamic facets. For + example, you may always want to have rating facet returned in the + response, but it's not necessarily to always display the rating + facet at the top. In that case, you can set enable_dynamic_position + to true so that the position of rating facet in response is + determined automatically. Another example, assuming you have the + following facets in the request: * "rating", enable_dynamic_position + = true * "price", enable_dynamic_position = false * "brands", + enable_dynamic_position = false And also you have a dynamic facets + enabled, which generates a facet `gender`. Then the final order of + the facets in the response can be ("price", "brands", "rating", + "gender") or ("price", "brands", "gender", "rating") depends on how + API orders "gender" and "rating" facets. However, notice that + "price" and "brands" are always ranked at first and second position + because their enable_dynamic_position is false. + type: boolean + GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey + description: Specifies how a facet is computed. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + key: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + Required. Supported textual and numerical facet keys in Document + object, over which the facet values are computed. Facet key is + case-sensitive. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse: - id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse - description: >- - Response message for CompletionService.PurgeSuggestionDenyListEntries - method. - type: object - properties: - purgeCount: - description: Number of suggestion deny list entries purged. - type: string - format: int64 - errorSamples: - description: A sample of errors encountered while processing the request. + intervals: + description: >- + Set only if values should be bucketed into intervals. Must be set + for facets with numerical values. Must not be set for facet with + text values. Maximum number of intervals is 30. type: array items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata: - id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata - description: >- - Metadata related to the progress of the PurgeUserEvents operation. This - will be returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - successCount: - description: Count of entries that were deleted successfully. - type: string - format: int64 - failureCount: - description: Count of entries that encountered errors while processing. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse: - id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse - description: >- - Response of the PurgeUserEventsRequest. If the long running operation is - successfully done, then this message is returned by the - google.longrunning.Operations.response field. - type: object - properties: - purgeCount: - description: The total count of events purged as a result of the operation. - type: string - format: int64 - GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata: - id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.RecrawlUris operation. This will be returned by - the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - invalidUris: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaInterval' + restrictedValues: description: >- - Unique URIs in the request that don't match any TargetSite in the - DataStore, only match TargetSites that haven't been fully indexed, - or match a TargetSite with type EXCLUDE. + Only get facet for the given restricted values. Only supported on + textual fields. For example, suppose "category" has three values + "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set + "restricted_values" to "Action > 2022", the "category" facet only + contains "Action > 2022". Only supported on textual fields. Maximum + is 10. type: array items: type: string - validUrisCount: - description: >- - Total number of unique URIs in the request that are not in - invalid_uris. - type: integer - format: int32 - successCount: - description: Total number of URIs that have been crawled so far. - type: integer - format: int32 - pendingCount: - description: Total number of URIs that have yet to be crawled. - type: integer - format: int32 - quotaExceededCount: + prefixes: description: >- - Total number of URIs that were rejected due to insufficient indexing - resources. - type: integer - format: int32 - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse: - id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse - description: Response message for SiteSearchEngineService.RecrawlUris method. - type: object - properties: - failureSamples: - description: Details for a sample of up to 10 `failed_uris`. + Only get facet values that start with the given string prefix. For + example, suppose "category" has three values "Action > 2022", + "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", + the "category" facet only contains "Action > 2022" and "Action > + 2021". Only supported on textual fields. Maximum is 10. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo - failedUris: - description: URIs that were not crawled before the LRO terminated. + type: string + contains: + description: >- + Only get facet values that contain the given strings. For example, + suppose "category" has three values "Action > 2022", "Action > 2021" + and "Sci-Fi > 2022". If set "contains" to "2022", the "category" + facet only contains "Action > 2022" and "Sci-Fi > 2022". Only + supported on textual fields. Maximum is 10. type: array items: type: string - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo: - id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo - description: >- - Details about why a particular URI failed to be crawled. Each - FailureInfo contains one FailureReason per CorpusType. + caseInsensitive: + description: >- + True to make facet keys case insensitive when getting faceting + values with prefixes or contains; false otherwise. + type: boolean + orderBy: + description: >- + The order in which documents are returned. Allowed values are: * + "count desc", which means order by SearchResponse.Facet.values.count + descending. * "value desc", which means order by + SearchResponse.Facet.values.value descending. Only applies to + textual facets. If not set, textual values are sorted in [natural + order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical + intervals are sorted in the order given by + FacetSpec.FacetKey.intervals. + type: string + GoogleCloudDiscoveryengineV1alphaInterval: + id: GoogleCloudDiscoveryengineV1alphaInterval + description: A floating point interval. type: object properties: - uri: - description: URI that failed to be crawled. - type: string - failureReasons: - description: List of failure reasons by corpus type (e.g. desktop, mobile). + minimum: + description: Inclusive lower bound. + type: number + format: double + exclusiveMinimum: + description: Exclusive lower bound. + type: number + format: double + maximum: + description: Inclusive upper bound. + type: number + format: double + exclusiveMaximum: + description: Exclusive upper bound. + type: number + format: double + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec + description: Boost specification to boost certain documents. + type: object + properties: + conditionBoostSpecs: + description: >- + Condition boost specifications. If a document matches multiple + conditions in the specifictions, boost scores from these + specifications are all applied and combined in a non-linear way. + Maximum number of specifications is 20. type: array items: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason: + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec: id: >- - GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason - description: >- - Details about why crawling failed for a particular CorpusType, e.g., - DESKTOP and MOBILE crawling may fail for different reasons. + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec + description: Boost applies to documents which match a condition. type: object properties: - corpusType: - description: DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. - type: string - enumDescriptions: - - Default value. - - Denotes a crawling attempt for the desktop version of a page. - - Denotes a crawling attempt for the mobile version of a page. - enum: - - CORPUS_TYPE_UNSPECIFIED - - DESKTOP - - MOBILE - errorMessage: - description: Reason why the URI was not crawled. + condition: + description: >- + An expression which specifies a boost condition. The syntax and + supported fields are the same as a filter expression. See + SearchRequest.filter for detail syntax and limitations. Examples: * + To boost documents with document ID "doc_1" or "doc_2", and color + "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: + ANY("Red", "Blue"))` type: string - GoogleCloudDiscoveryengineV1alphaSession: - id: GoogleCloudDiscoveryengineV1alphaSession - description: External session proto definition. + boost: + description: >- + Strength of the condition boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0. Setting to 1.0 gives + the document a big promotion. However, it does not necessarily mean + that the boosted document will be the top result at all times, nor + that other documents will be excluded. Results could still be shown + even when none of them matches the condition. And results that are + significantly more relevant to the search query can still trump your + heavily favored but irrelevant documents. Setting to -1.0 gives the + document a big demotion. However, results that are deeply relevant + might still be shown. The document will have an upstream battle to + get a fairly high ranking, but it is not blocked out completely. + Setting to 0.0 means no boost applied. The boosting condition is + ignored. Only one of the (condition, boost) combination or the + boost_control_spec below are set. If both are set then the global + boost is ignored and the more fine-grained boost_control_spec is + applied. + type: number + format: float + boostControlSpec: + description: >- + Complex specification for custom ranking based on customer defined + attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. type: object properties: - name: + fieldName: description: >- - Immutable. Fully qualified name - `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` + The name of the field whose value will be used to determine the + boost amount. type: string - state: - description: The state of the session. + attributeType: + description: >- + The attribute type to be used to determine the boost amount. The + attribute value can be derived from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. + attribute_value = numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - datetime_field_value). type: string enumDescriptions: - - State is unspecified. - - The session is currently open. + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. enum: - - STATE_UNSPECIFIED - - IN_PROGRESS - userPseudoId: - description: A unique identifier for tracking users. + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: + description: >- + The interpolation type to be applied to connect the control points + listed below. type: string - turns: - description: Turns. + enumDescriptions: + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. + enum: + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + The control points used to define the curve. The monotonic function + (defined through the interpolation_type above) passes through the + control points listed here. type: array items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSessionTurn' - startTime: - description: Output only. The time the session started. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time the session finished. - readOnly: true - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaSessionTurn: - id: GoogleCloudDiscoveryengineV1alphaSessionTurn + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint description: >- - Represents a turn, including a query from the user and a answer from - service. + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). type: object properties: - query: - description: The user query. - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaQuery' - answer: + attributeValue: description: >- - The resource name of the answer to the user query. Only set if the - answer generation (/answer API call) happened in this turn. - type: string - GoogleCloudDiscoveryengineV1alphaQuery: - id: GoogleCloudDiscoveryengineV1alphaQuery - description: Defines a user inputed query. - type: object - properties: - text: - description: Plain text. - type: string - queryId: - description: Unique Id for the query. - type: string - GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata: - id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata - description: >- - Metadata related to the progress of the TrainCustomModel operation. This - is returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. + Can be one of: 1. The numerical field value. 2. The duration spec + for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. type: string - format: google-datetime - updateTime: + boostAmount: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse: - id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse + The value between -1 to 1 by which to boost the score if the + attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec description: >- - Response of the TrainCustomModelRequest. This message is returned by the - google.longrunning.Operations.response field. - type: object - properties: - errorSamples: - description: A sample of errors encountered while processing the data. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - errorConfig: - description: >- - Echoes the destination for the complete errors in the request if - set. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig - modelStatus: - description: >- - The trained model status. Possible values are: * **bad-data**: The - training data quality is bad. * **no-improvement**: Tuning didn't - improve performance. Won't deploy. * **in-progress**: Model training - job creation is in progress. * **training**: Model is actively - training. * **evaluating**: The model is evaluating trained metrics. - * **indexing**: The model trained metrics are indexing. * **ready**: - The model is ready for serving. - type: string - metrics: - description: The metrics of the trained model. - type: object - additionalProperties: - type: number - format: double - modelName: - description: Fully qualified name of the CustomTuningModel. - type: string - GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata: - id: GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata - description: Metadata associated with a tune operation. + Specification to determine under which conditions query expansion should + occur. type: object properties: - engine: + condition: description: >- - Required. The resource name of the engine that this tune applies to. - Format: - `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` - type: string - GoogleCloudDiscoveryengineV1alphaTuneEngineResponse: - id: GoogleCloudDiscoveryengineV1alphaTuneEngineResponse - description: Response associated with a tune operation. - type: object - properties: {} - GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata - description: Metadata for UpdateSchema LRO. - type: object - properties: - createTime: - description: Operation create time. + The condition under which query expansion should occur. Default to + Condition.DISABLED. type: string - format: google-datetime - updateTime: + enumDescriptions: + - >- + Unspecified query expansion condition. In this case, server + behavior defaults to Condition.DISABLED. + - >- + Disabled query expansion. Only the exact search query is used, + even if SearchResponse.total_size is zero. + - Automatic query expansion built by the Search API. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - AUTO + pinUnexpandedResults: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.UpdateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. + Whether to pin unexpanded results. If this field is set to true, + unexpanded products are always at the top of the search results, + followed by the expanded results. + type: boolean + GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec + description: The specification for query spell correction. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + mode: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The mode under which spell correction replaces the original search + query. Defaults to Mode.AUTO. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.BatchCreateTargetSites operation. This will be - returned by the google.longrunning.Operation.metadata field. + enumDescriptions: + - >- + Unspecified spell correction mode. In this case, server behavior + defaults to Mode.AUTO. + - >- + Search API tries to find a spelling suggestion. If a suggestion is + found, it is put in the SearchResponse.corrected_query. The + spelling suggestion won't be used as the search query. + - >- + Automatic spell correction built by the Search API. Search will be + based on the corrected query if found. + enum: + - MODE_UNSPECIFIED + - SUGGESTION_ONLY + - AUTO + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec + description: A specification for configuring the behavior of content search. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + snippetSpec: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse: - id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse - description: >- - Response message for SiteSearchEngineService.BatchCreateTargetSites - method. - type: object - properties: - targetSites: - description: TargetSites created. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSite' - GoogleCloudDiscoveryengineV1betaTargetSite: - id: GoogleCloudDiscoveryengineV1betaTargetSite - description: A target site for the SiteSearchEngine. - type: object - properties: - name: + If `snippetSpec` is not specified, snippets are not included in the + search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec + summarySpec: description: >- - Output only. The fully qualified resource name of the target site. - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` - The `target_site_id` is system-generated. - readOnly: true - type: string - providedUriPattern: + If `summarySpec` is not specified, summaries are not included in the + search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec + extractiveContentSpec: description: >- - Required. Input only. The user provided URI pattern from which the - `generated_uri_pattern` is generated. - type: string - type: + If there is no extractive_content_spec provided, there will be no + extractive answer in the search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec + searchResultMode: description: >- - The type of the target site, e.g., whether the site is to be - included or excluded. + Specifies the search result mode. If unspecified, the search result + mode defaults to `DOCUMENTS`. type: string enumDescriptions: + - Default value. + - Returns documents in the search result. - >- - This value is unused. In this case, server behavior defaults to - Type.INCLUDE. - - Include the target site. - - Exclude the target site. + Returns chunks in the search result. Only available if the + DataStore.DocumentProcessingConfig.chunking_config is specified. enum: - - TYPE_UNSPECIFIED - - INCLUDE - - EXCLUDE - exactMatch: + - SEARCH_RESULT_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + chunkSpec: + description: >- + Specifies the chunk spec to be returned from the search response. + Only available if the + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec + description: A specification for configuring snippets in a search response. + type: object + properties: + maxSnippetCount: description: >- - Input only. If set to false, a uri_pattern is generated to include - all pages whose address contains the provided_uri_pattern. If set to - true, an uri_pattern is generated to try to be an exact match of the - provided_uri_pattern or just the specific page if the - provided_uri_pattern is a specific one. provided_uri_pattern is - always normalized to generate the URI pattern to be used by the - search engine. - type: boolean - generatedUriPattern: + [DEPRECATED] This field is deprecated. To control snippet return, + use `return_snippet` field. For backwards compatibility, we will + return snippet if max_snippet_count > 0. + deprecated: true + type: integer + format: int32 + referenceOnly: description: >- - Output only. This is system-generated based on the - provided_uri_pattern. - readOnly: true + [DEPRECATED] This field is deprecated and will have no affect on the + snippet. + deprecated: true + type: boolean + returnSnippet: + description: >- + If `true`, then return snippet. If no snippet can be generated, we + return "No snippet is available for this page." A `snippet_status` + with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. + type: boolean + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec + description: A specification for configuring a summary returned in a search response. + type: object + properties: + summaryResultCount: + description: >- + The number of top results to generate the summary from. If the + number of results returned is less than `summaryResultCount`, the + summary is generated from all of the results. At most 10 results for + documents mode, or 50 for chunks mode, can be used to generate a + summary. The chunks mode is used when + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + type: integer + format: int32 + includeCitations: + description: >- + Specifies whether to include citations in the summary. The default + value is `false`. When this field is set to `true`, summaries + include in-line citation numbers. Example summary including + citations: BigQuery is Google Cloud's fully managed and completely + serverless enterprise data warehouse [1]. BigQuery supports all data + types, works across clouds, and has built-in machine learning and + business intelligence, all within a unified platform [2, 3]. The + citation numbers refer to the returned search results and are + 1-indexed. For example, [1] means that the sentence is attributed to + the first search result. [2, 3] means that the sentence is + attributed to both the second and third search results. + type: boolean + ignoreAdversarialQuery: + description: >- + Specifies whether to filter out adversarial queries. The default + value is `false`. Google employs search-query classification to + detect adversarial queries. No summary is returned if the search + query is classified as an adversarial query. For example, a user + might ask a question regarding negative comments about the company + or submit a query designed to generate unsafe, policy-violating + output. If this field is set to `true`, we skip generating summaries + for adversarial queries and return fallback messages instead. + type: boolean + ignoreNonSummarySeekingQuery: + description: >- + Specifies whether to filter out queries that are not + summary-seeking. The default value is `false`. Google employs + search-query classification to detect summary-seeking queries. No + summary is returned if the search query is classified as a + non-summary seeking query. For example, `why is the sky blue` and + `Who is the best soccer player in the world?` are summary-seeking + queries, but `SFO airport` and `world cup 2026` are not. They are + most likely navigational queries. If this field is set to `true`, we + skip generating summaries for non-summary seeking queries and return + fallback messages instead. + type: boolean + ignoreLowRelevantContent: + description: >- + Specifies whether to filter out queries that have low relevance. The + default value is `false`. If this field is set to `false`, all + search results are used regardless of relevance to generate answers. + If set to `true`, only queries with high relevance search results + will generate answers. + type: boolean + ignoreJailBreakingQuery: + description: >- + Optional. Specifies whether to filter out jail-breaking queries. The + default value is `false`. Google employs search-query classification + to detect jail-breaking queries. No summary is returned if the + search query is classified as a jail-breaking query. A user might + add instructions to the query to change the tone, style, language, + content of the answer, or ask the model to act as a different + entity, e.g. "Reply in the tone of a competing company's CEO". If + this field is set to `true`, we skip generating summaries for + jail-breaking queries and return fallback messages instead. + type: boolean + modelPromptSpec: + description: >- + If specified, the spec will be used to modify the prompt provided to + the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + languageCode: + description: >- + Language code for Summary. Use language tags defined by + [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is + an experimental feature. + type: string + modelSpec: + description: >- + If specified, the spec will be used to modify the model + specification provided to the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec + useSemanticChunks: + description: >- + If true, answer will be generated from most relevant chunks from top + search results. This feature will improve summary quality. Note that + with this feature enabled, not all top search results will be + referenced and included in the reference list, so the citation + source index only points to the search results listed in the + reference list. + type: boolean + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + description: Specification of the prompt to use with the model. + type: object + properties: + preamble: + description: >- + Text at the beginning of the prompt that instructs the assistant. + Examples are available in the user guide. + type: string + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec + description: Specification of the model. + type: object + properties: + version: + description: >- + The model version used to generate the summary. Supported values + are: * `stable`: string. Default value when no value is specified. + Uses a generally available, fine-tuned model. For more information, + see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * `preview`: string. (Public preview) Uses a preview model. For more + information, see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + type: string + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec + description: >- + A specification for configuring the extractive content in a search + response. + type: object + properties: + maxExtractiveAnswerCount: + description: >- + The maximum number of extractive answers returned in each search + result. An extractive answer is a verbatim answer extracted from the + original document, which provides a precise and contextually + relevant answer to the search query. If the number of matching + answers is less than the `max_extractive_answer_count`, return all + of the answers. Otherwise, return the `max_extractive_answer_count`. + At most five answers are returned for each SearchResult. + type: integer + format: int32 + maxExtractiveSegmentCount: + description: >- + The max number of extractive segments returned in each search + result. Only applied if the DataStore is set to + DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types + is SOLUTION_TYPE_CHAT. An extractive segment is a text segment + extracted from the original document that is relevant to the search + query, and, in general, more verbose than an extractive answer. The + segment could then be used as input for LLMs to generate summaries + and answers. If the number of matching segments is less than + `max_extractive_segment_count`, return all of the segments. + Otherwise, return the `max_extractive_segment_count`. + type: integer + format: int32 + returnExtractiveSegmentScore: + description: >- + Specifies whether to return the confidence score from the extractive + segments in each search result. This feature is available only for + new or allowlisted data stores. To allowlist your data store, + contact your Customer Engineer. The default value is `false`. + type: boolean + numPreviousSegments: + description: >- + Specifies whether to also include the adjacent from each selected + segments. Return at most `num_previous_segments` segments before + each selected segments. + type: integer + format: int32 + numNextSegments: + description: >- + Return at most `num_next_segments` segments after each selected + segments. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec + description: >- + Specifies the chunk spec to be returned from the search response. Only + available if the SearchRequest.ContentSearchSpec.search_result_mode is + set to CHUNKS + type: object + properties: + numPreviousChunks: + description: >- + The number of previous chunks to be returned of the current chunk. + The maximum allowed value is 3. If not specified, no previous chunks + will be returned. + type: integer + format: int32 + numNextChunks: + description: >- + The number of next chunks to be returned of the current chunk. The + maximum allowed value is 3. If not specified, no next chunks will be + returned. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec + description: >- + The specification that uses customized query embedding vector to do + semantic document retrieval. + type: object + properties: + embeddingVectors: + description: The embedding vector used for retrieval. Limit to 1. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector + GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector + description: Embedding vector. + type: object + properties: + fieldPath: + description: Embedding field path in schema. + type: string + vector: + description: Query embedding vector. + type: array + items: + type: number + format: float + GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec: + id: >- + GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec + description: >- + Specification to enable natural language understanding capabilities for + search requests. + type: object + properties: + filterExtractionCondition: + description: >- + The condition under which filter extraction should occur. Default to + Condition.DISABLED. + type: string + enumDescriptions: + - Server behavior defaults to Condition.DISABLED. + - Disables NL filter extraction. + - Enables NL filter extraction. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + geoSearchQueryDetectionFieldNames: + description: >- + Field names used for location-based filtering, where geolocation + filters are detected in natural language search queries. Only valid + when the FilterExtractionCondition is set to `ENABLED`. If this + field is set, it overrides the field names set in + ServingConfig.geo_search_query_detection_field_names. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec + description: Specification for search as you type in search requests. + type: object + properties: + condition: + description: >- + The condition under which search as you type should occur. Default + to Condition.DISABLED. + type: string + enumDescriptions: + - Server behavior defaults to Condition.DISABLED. + - Disables Search As You Type. + - Enables Search As You Type. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec: + id: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec + description: Defines custom fine tuning spec. + type: object + properties: + enableSearchAdaptor: + description: >- + Whether or not to enable and include custom fine tuned search + adaptor model. + type: boolean + GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec: + id: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec + description: >- + Session specification. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we launch + this feature to public GA. Or ask for allowlisting through Google + Support team. + type: object + properties: + queryId: + description: >- + If set, the search result gets stored to the "turn" specified by + this query ID. Example: Let's say the session looks like this: + session { name: ".../sessions/xxx" turns { query { text: "What is + foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { + query { text: "How about bar then?" query_id: ".../questions/zzz" } + } } The user can call /search API with a request like this: session: + ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } + Then, the API stores the search result, associated with the last + turn. The stored search result can be used by a subsequent /answer + API call (with the session ID and the query ID specified). Also, it + is possible to call /search and /answer in parallel with the same + session ID & query ID. + type: string + searchResultPersistenceCount: + description: >- + The number of top search results to persist. The persisted search + results can be used for the subsequent /answer api call. This field + is simliar to the `summary_result_count` field in + SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At + most 10 results for documents mode, or 50 for chunks mode. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec: + id: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec + description: Describes the specification of the query set. + type: object + properties: + sampleQuerySet: + description: >- + Required. The full resource name of the SampleQuerySet used for the + evaluation, in the format of + `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. + type: string + GoogleCloudDiscoveryengineV1alphaQualityMetrics: + id: GoogleCloudDiscoveryengineV1alphaQualityMetrics + description: Describes the metrics produced by the evaluation. + type: object + properties: + docRecall: + description: >- + Recall per document, at various top-k cutoff levels. Recall is the + fraction of relevant documents retrieved out of all relevant + documents. Example (top-5): * For a single SampleQuery, If 3 out of + 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = + 0.6 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics + docPrecision: + description: >- + Precision per document, at various top-k cutoff levels. Precision is + the fraction of retrieved documents that are relevant. Example + (top-5): * For a single SampleQuery, If 4 out of 5 retrieved + documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics + docNdcg: + description: >- + Normalized discounted cumulative gain (NDCG) per document, at + various top-k cutoff levels. NDCG measures the ranking quality, + giving higher relevance to top results. Example (top-3): Suppose + SampleQuery with three retrieved documents (D1, D2, D3) and binary + relevance judgements (1 for relevant, 0 for not relevant): + Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] + Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics + pageRecall: + description: >- + Recall per page, at various top-k cutoff levels. Recall is the + fraction of relevant pages retrieved out of all relevant pages. + Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant + pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics + pageNdcg: + description: >- + Normalized discounted cumulative gain (NDCG) per page, at various + top-k cutoff levels. NDCG measures the ranking quality, giving + higher relevance to top results. Example (top-3): Suppose + SampleQuery with three retrieved pages (P1, P2, P3) and binary + relevance judgements (1 for relevant, 0 for not relevant): + Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] + Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics + GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics: + id: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics + description: Stores the metric values at specific top-k levels. + type: object + properties: + top1: + description: The top-1 value. + type: number + format: double + top3: + description: The top-3 value. + type: number + format: double + top5: + description: The top-5 value. + type: number + format: double + top10: + description: The top-10 value. + type: number + format: double + GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse: + id: GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse + description: >- + Response message for SiteSearchEngineService.GetUriPatternDocumentData + method. + type: object + properties: + documentDataMap: + description: >- + Document data keyed by URI pattern. For example: document_data_map = + { "www.url1.com/*": { "Categories": ["category1", "category2"] }, + "www.url2.com/*": { "Categories": ["category3"] } } + type: object + additionalProperties: + type: object + additionalProperties: + type: any + description: Properties of the object. + GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata + description: >- + Metadata related to the progress of the ImportCompletionSuggestions + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of CompletionSuggestions successfully imported. + type: string + format: int64 + failureCount: + description: Count of CompletionSuggestions that failed to be imported. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse + description: >- + Response of the CompletionService.ImportCompletionSuggestions method. If + the long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + GoogleCloudDiscoveryengineV1alphaImportErrorConfig: + id: GoogleCloudDiscoveryengineV1alphaImportErrorConfig + description: Configuration of destination for Import related errors. + type: object + properties: + gcsPrefix: + description: >- + Cloud Storage prefix for import errors. This must be an empty, + existing Cloud Storage directory. Import errors are written to + sharded files in this directory, one per line, as a JSON-encoded + `google.rpc.Status` message. + type: string + GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata + description: >- + Metadata related to the progress of the ImportDocuments operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were processed successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + totalCount: + description: Total count of entries that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse: + id: GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse + description: >- + Response of the ImportDocumentsRequest. If the long running operation is + done, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors in the request if + set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata + description: >- + Metadata related to the progress of the ImportSampleQueries operation. + This will be returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: ImportSampleQueries operation create time. + type: string + format: google-datetime + updateTime: + description: >- + ImportSampleQueries operation last update time. If the operation is + done, this is also the finish time. + type: string + format: google-datetime + successCount: + description: Count of SampleQuerys successfully imported. + type: string + format: int64 + failureCount: + description: Count of SampleQuerys that failed to be imported. + type: string + format: int64 + totalCount: + description: Total count of SampleQuerys that were processed. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse: + id: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse + description: >- + Response of the SampleQueryService.ImportSampleQueries method. If the + long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata + description: >- + Metadata related to the progress of the ImportSuggestionDenyListEntries + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse + description: >- + Response message for CompletionService.ImportSuggestionDenyListEntries + method. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + importedEntriesCount: + description: Count of deny list entries successfully imported. + type: string + format: int64 + failedEntriesCount: + description: Count of deny list entries that failed to be imported. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: + id: GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata + description: >- + Metadata related to the progress of the Import operation. This is + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were processed successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse: + id: GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse + description: >- + Response of the ImportUserEventsRequest. If the long running operation + was successful, then this message is returned by the + google.longrunning.Operations.response field if the operation was + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors if this field was set + in the request. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + joinedEventsCount: + description: Count of user events imported with complete existing Documents. + type: string + format: int64 + unjoinedEventsCount: + description: >- + Count of user events imported, but with Document information not + found in the existing Branch. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse: + id: GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse + description: Response message for SearchTuningService.ListCustomModels method. + type: object + properties: + models: + description: List of custom tuning models. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaCustomTuningModel + GoogleCloudDiscoveryengineV1alphaCustomTuningModel: + id: GoogleCloudDiscoveryengineV1alphaCustomTuningModel + description: Metadata that describes a custom tuned model. + type: object + properties: + name: + description: >- + Required. The fully qualified resource name of the model. Format: + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + Model must be an alpha-numerical string with limit of 40 characters. + type: string + displayName: + description: The display name of the model. + type: string + modelVersion: + description: The version of the model. + type: string + format: int64 + modelState: + description: >- + The state that the model is in (e.g.`TRAINING` or + `TRAINING_FAILED`). + type: string + enumDescriptions: + - Default value. + - The model is in a paused training state. + - The model is currently training. + - The model has successfully completed training. + - The model is ready for serving. + - The model training failed. + - >- + The model training finished successfully but metrics did not + improve. + - Input data validation failed. Model training didn't start. + enum: + - MODEL_STATE_UNSPECIFIED + - TRAINING_PAUSED + - TRAINING + - TRAINING_COMPLETE + - READY_FOR_SERVING + - TRAINING_FAILED + - NO_IMPROVEMENT + - INPUT_VALIDATION_FAILED + createTime: + description: Timestamp the Model was created at. + deprecated: true + type: string + format: google-datetime + trainingStartTime: + description: Timestamp the model training was initiated. + type: string + format: google-datetime + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double + GoogleCloudDiscoveryengineV1alphaProject: + id: GoogleCloudDiscoveryengineV1alphaProject + description: Metadata and configurations for a Google Cloud project in the service. + type: object + properties: + name: + description: >- + Output only. Full resource name of the project, for example + `projects/{project}`. Note that when making requests, project number + and project id are both acceptable, but the server will always + respond in project number. + readOnly: true + type: string + createTime: + description: Output only. The timestamp when this project is created. + readOnly: true + type: string + format: google-datetime + provisionCompletionTime: + description: >- + Output only. The timestamp when this project is successfully + provisioned. Empty value means this project is still provisioning + and is not ready for use. + readOnly: true + type: string + format: google-datetime + serviceTermsMap: + description: >- + Output only. A map of terms of services. The key is the `id` of + ServiceTerms. + readOnly: true + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaProjectServiceTerms + GoogleCloudDiscoveryengineV1alphaProjectServiceTerms: + id: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms + description: Metadata about the terms of service. + type: object + properties: + id: + description: >- + The unique identifier of this terms of service. Available terms: * + `GA_DATA_USE_TERMS`: [Terms for data + use](https://cloud.google.com/retail/data-use-terms). When using + this as `id`, the acceptable version to provide is `2022-11-23`. + type: string + version: + description: >- + The version string of the terms of service. For acceptable values, + see the comments for id above. + type: string + state: + description: >- + Whether the project has accepted/rejected the service terms or it is + still pending. + type: string + enumDescriptions: + - The default value of the enum. This value is not actually used. + - The project has given consent to the terms of service. + - The project is pending to review and accept the terms of service. + - >- + The project has declined or revoked the agreement to terms of + service. + enum: + - STATE_UNSPECIFIED + - TERMS_ACCEPTED + - TERMS_PENDING + - TERMS_DECLINED + acceptTime: + description: The last time when the project agreed to the terms of service. + type: string + format: google-datetime + declineTime: + description: >- + The last time when the project declined or revoked the agreement to + terms of service. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata: + id: GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata + description: Metadata associated with a project provision operation. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata + description: >- + Metadata related to the progress of the PurgeCompletionSuggestions + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse + description: >- + Response message for CompletionService.PurgeCompletionSuggestions + method. + type: object + properties: + purgeSucceeded: + description: Whether the completion suggestions were successfully purged. + type: boolean + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata + description: >- + Metadata related to the progress of the PurgeDocuments operation. This + will be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were deleted successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + ignoredCount: + description: Count of entries that were ignored as entries were not found. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse + description: >- + Response message for DocumentService.PurgeDocuments method. If the long + running operation is successfully done, then this message is returned by + the google.longrunning.Operations.response field. + type: object + properties: + purgeCount: + description: The total count of documents purged as a result of the operation. + type: string + format: int64 + purgeSample: + description: >- + A sample of document names that will be deleted. Only populated if + `force` is set to false. A max of 100 names will be returned and the + names are chosen at random. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata + description: >- + Metadata related to the progress of the PurgeSuggestionDenyListEntries + operation. This is returned by the google.longrunning.Operation.metadata + field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse + description: >- + Response message for CompletionService.PurgeSuggestionDenyListEntries + method. + type: object + properties: + purgeCount: + description: Number of suggestion deny list entries purged. + type: string + format: int64 + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata: + id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata + description: >- + Metadata related to the progress of the PurgeUserEvents operation. This + will be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + successCount: + description: Count of entries that were deleted successfully. + type: string + format: int64 + failureCount: + description: Count of entries that encountered errors while processing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse: + id: GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse + description: >- + Response of the PurgeUserEventsRequest. If the long running operation is + successfully done, then this message is returned by the + google.longrunning.Operations.response field. + type: object + properties: + purgeCount: + description: The total count of events purged as a result of the operation. + type: string + format: int64 + GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata: + id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.RecrawlUris operation. This will be returned by + the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + invalidUris: + description: >- + Unique URIs in the request that don't match any TargetSite in the + DataStore, only match TargetSites that haven't been fully indexed, + or match a TargetSite with type EXCLUDE. + type: array + items: + type: string + validUrisCount: + description: >- + Total number of unique URIs in the request that are not in + invalid_uris. + type: integer + format: int32 + successCount: + description: Total number of URIs that have been crawled so far. + type: integer + format: int32 + pendingCount: + description: Total number of URIs that have yet to be crawled. + type: integer + format: int32 + quotaExceededCount: + description: >- + Total number of URIs that were rejected due to insufficient indexing + resources. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse: + id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse + description: Response message for SiteSearchEngineService.RecrawlUris method. + type: object + properties: + failureSamples: + description: Details for a sample of up to 10 `failed_uris`. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo + failedUris: + description: URIs that were not crawled before the LRO terminated. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo: + id: GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo + description: >- + Details about why a particular URI failed to be crawled. Each + FailureInfo contains one FailureReason per CorpusType. + type: object + properties: + uri: + description: URI that failed to be crawled. + type: string + failureReasons: + description: List of failure reasons by corpus type (e.g. desktop, mobile). + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason: + id: >- + GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason + description: >- + Details about why crawling failed for a particular CorpusType, e.g., + DESKTOP and MOBILE crawling may fail for different reasons. + type: object + properties: + corpusType: + description: DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. + type: string + enumDescriptions: + - Default value. + - Denotes a crawling attempt for the desktop version of a page. + - Denotes a crawling attempt for the mobile version of a page. + enum: + - CORPUS_TYPE_UNSPECIFIED + - DESKTOP + - MOBILE + errorMessage: + description: Reason why the URI was not crawled. + type: string + GoogleCloudDiscoveryengineV1alphaSession: + id: GoogleCloudDiscoveryengineV1alphaSession + description: External session proto definition. + type: object + properties: + name: + description: >- + Immutable. Fully qualified name + `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` + type: string + state: + description: The state of the session. + type: string + enumDescriptions: + - State is unspecified. + - The session is currently open. + enum: + - STATE_UNSPECIFIED + - IN_PROGRESS + userPseudoId: + description: A unique identifier for tracking users. + type: string + turns: + description: Turns. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaSessionTurn' + startTime: + description: Output only. The time the session started. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the session finished. + readOnly: true + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaSessionTurn: + id: GoogleCloudDiscoveryengineV1alphaSessionTurn + description: >- + Represents a turn, including a query from the user and a answer from + service. + type: object + properties: + query: + description: The user query. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1alphaQuery' + answer: + description: >- + The resource name of the answer to the user query. Only set if the + answer generation (/answer API call) happened in this turn. + type: string + GoogleCloudDiscoveryengineV1alphaQuery: + id: GoogleCloudDiscoveryengineV1alphaQuery + description: Defines a user inputed query. + type: object + properties: + text: + description: Plain text. + type: string + queryId: + description: Unique Id for the query. + type: string + GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata: + id: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.SetUriPatternDocumentData operation. This will + be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse: + id: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse + description: >- + Response message for SiteSearchEngineService.SetUriPatternDocumentData + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata: + id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata + description: >- + Metadata related to the progress of the TrainCustomModel operation. This + is returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse: + id: GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse + description: >- + Response of the TrainCustomModelRequest. This message is returned by the + google.longrunning.Operations.response field. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the data. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: >- + Echoes the destination for the complete errors in the request if + set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1alphaImportErrorConfig + modelStatus: + description: >- + The trained model status. Possible values are: * **bad-data**: The + training data quality is bad. * **no-improvement**: Tuning didn't + improve performance. Won't deploy. * **in-progress**: Model training + job creation is in progress. * **training**: Model is actively + training. * **evaluating**: The model is evaluating trained metrics. + * **indexing**: The model trained metrics are indexing. * **ready**: + The model is ready for serving. + type: string + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double + modelName: + description: Fully qualified name of the CustomTuningModel. + type: string + GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata: + id: GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata + description: Metadata associated with a tune operation. + type: object + properties: + engine: + description: >- + Required. The resource name of the engine that this tune applies to. + Format: + `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` + type: string + GoogleCloudDiscoveryengineV1alphaTuneEngineResponse: + id: GoogleCloudDiscoveryengineV1alphaTuneEngineResponse + description: Response associated with a tune operation. + type: object + properties: {} + GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata + description: Metadata for UpdateSchema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.UpdateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.BatchCreateTargetSites operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse: + id: GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse + description: >- + Response message for SiteSearchEngineService.BatchCreateTargetSites + method. + type: object + properties: + targetSites: + description: TargetSites created. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSite' + GoogleCloudDiscoveryengineV1betaTargetSite: + id: GoogleCloudDiscoveryengineV1betaTargetSite + description: A target site for the SiteSearchEngine. + type: object + properties: + name: + description: >- + Output only. The fully qualified resource name of the target site. + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` + The `target_site_id` is system-generated. + readOnly: true + type: string + providedUriPattern: + description: >- + Required. Input only. The user provided URI pattern from which the + `generated_uri_pattern` is generated. + type: string + type: + description: >- + The type of the target site, e.g., whether the site is to be + included or excluded. + type: string + enumDescriptions: + - >- + This value is unused. In this case, server behavior defaults to + Type.INCLUDE. + - Include the target site. + - Exclude the target site. + enum: + - TYPE_UNSPECIFIED + - INCLUDE + - EXCLUDE + exactMatch: + description: >- + Input only. If set to false, a uri_pattern is generated to include + all pages whose address contains the provided_uri_pattern. If set to + true, an uri_pattern is generated to try to be an exact match of the + provided_uri_pattern or just the specific page if the + provided_uri_pattern is a specific one. provided_uri_pattern is + always normalized to generate the URI pattern to be used by the + search engine. + type: boolean + generatedUriPattern: + description: >- + Output only. This is system-generated based on the + provided_uri_pattern. + readOnly: true + type: string + rootDomainUri: + description: Output only. Root domain of the provided_uri_pattern. + readOnly: true + type: string + siteVerificationInfo: + description: Output only. Site ownership and validity verification status. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSiteVerificationInfo + indexingStatus: + description: Output only. Indexing status. + readOnly: true + type: string + enumDescriptions: + - Defaults to SUCCEEDED. + - >- + The target site is in the update queue and will be picked up by + indexing pipeline. + - The target site fails to be indexed. + - The target site has been indexed. + - >- + The previously indexed target site has been marked to be deleted. + This is a transitioning state which will resulted in either: 1. + target site deleted if unindexing is successful; 2. state reverts + to SUCCEEDED if the unindexing fails. + enum: + - INDEXING_STATUS_UNSPECIFIED + - PENDING + - FAILED + - SUCCEEDED + - DELETING + updateTime: + description: Output only. The target site's last updated time. + readOnly: true + type: string + format: google-datetime + failureReason: + description: Output only. Failure reason. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason + GoogleCloudDiscoveryengineV1betaSiteVerificationInfo: + id: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo + description: Verification information for target sites in advanced site search. + type: object + properties: + siteVerificationState: + description: Site verification state indicating the ownership and validity. + type: string + enumDescriptions: + - Defaults to VERIFIED. + - Site ownership verified. + - Site ownership pending verification or verification failed. + - >- + Site exempt from verification, e.g., a public website that opens + to all. + enum: + - SITE_VERIFICATION_STATE_UNSPECIFIED + - VERIFIED + - UNVERIFIED + - EXEMPTED + verifyTime: + description: Latest site verification time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason: + id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason + description: Site search indexing failure reasons. + type: object + properties: + quotaFailure: + description: Failed due to insufficient quota. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure + GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure: + id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure + description: Failed due to insufficient quota. + type: object + properties: + totalRequiredQuota: + description: >- + This number is an estimation on how much total quota this project + needs to successfully complete indexing. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaControl: + id: GoogleCloudDiscoveryengineV1betaControl + description: >- + Defines a conditioned behavior to employ during serving. Must be + attached to a ServingConfig to be considered at serving time. Permitted + actions dependent on `SolutionType`. + type: object + properties: + boostAction: + description: Defines a boost-type control + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlBoostAction + filterAction: + description: >- + Defines a filter-type control Currently not supported by + Recommendation + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlFilterAction + redirectAction: + description: Defines a redirect-type control. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlRedirectAction + synonymsAction: + description: Treats a group of terms as synonyms of one another. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaControlSynonymsAction + name: + description: >- + Immutable. Fully qualified name + `projects/*/locations/global/dataStore/*/controls/*` + type: string + displayName: + description: >- + Required. Human readable name. The identifier used in UI views. Must + be UTF-8 encoded string. Length limit is 128 characters. Otherwise + an INVALID ARGUMENT error is thrown. + type: string + associatedServingConfigIds: + description: >- + Output only. List of all ServingConfig IDs this control is attached + to. May take up to 10 minutes to update after changes. + readOnly: true + type: array + items: + type: string + solutionType: + description: >- + Required. Immutable. What solution the control belongs to. Must be + compatible with vertical of resource. Otherwise an INVALID ARGUMENT + error is thrown. + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + useCases: + description: >- + Specifies the use case for the control. Affects what condition + fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently + only allow one use case per control. Must be set when solution_type + is SolutionType.SOLUTION_TYPE_SEARCH. + type: array + items: + type: string + enumDescriptions: + - Value used when unset. Will not occur in CSS. + - Search use case. Expects the traffic has a non-empty query. + - Browse use case. Expects the traffic has an empty query. + enum: + - SEARCH_USE_CASE_UNSPECIFIED + - SEARCH_USE_CASE_SEARCH + - SEARCH_USE_CASE_BROWSE + conditions: + description: >- + Determines when the associated action will trigger. Omit to always + apply the action. Currently only a single condition may be + specified. Otherwise an INVALID ARGUMENT error is thrown. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaCondition' + GoogleCloudDiscoveryengineV1betaControlBoostAction: + id: GoogleCloudDiscoveryengineV1betaControlBoostAction + description: Adjusts order of products in returned list. + type: object + properties: + boost: + description: >- + Required. Strength of the boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0 (No-op). + type: number + format: float + filter: + description: >- + Required. Specifies which products to apply the boost to. If no + filter is provided all products will be boosted (No-op). Syntax + documentation: https://cloud.google.com/retail/docs/filter-and-order + Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT + error is thrown. + type: string + dataStore: + description: >- + Required. Specifies which data store's documents can be boosted by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store + type: string + GoogleCloudDiscoveryengineV1betaControlFilterAction: + id: GoogleCloudDiscoveryengineV1betaControlFilterAction + description: >- + Specified which products may be included in results. Uses same filter as + boost. + type: object + properties: + filter: + description: >- + Required. A filter to apply on the matching condition results. + Required Syntax documentation: + https://cloud.google.com/retail/docs/filter-and-order Maximum length + is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + type: string + dataStore: + description: >- + Required. Specifies which data store's documents can be filtered by + this control. Full data store name e.g. + projects/123/locations/global/collections/default_collection/dataStores/default_data_store + type: string + GoogleCloudDiscoveryengineV1betaControlRedirectAction: + id: GoogleCloudDiscoveryengineV1betaControlRedirectAction + description: Redirects a shopper to the provided URI. + type: object + properties: + redirectUri: + description: >- + Required. The URI to which the shopper will be redirected. Required. + URI must have length equal or less than 2000 characters. Otherwise + an INVALID ARGUMENT error is thrown. + type: string + GoogleCloudDiscoveryengineV1betaControlSynonymsAction: + id: GoogleCloudDiscoveryengineV1betaControlSynonymsAction + description: >- + Creates a set of terms that will act as synonyms of one another. + Example: "happy" will also be considered as "glad", "glad" will also be + considered as "happy". + type: object + properties: + synonyms: + description: >- + Defines a set of synonyms. Can specify up to 100 synonyms. Must + specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is + thrown. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1betaCondition: + id: GoogleCloudDiscoveryengineV1betaCondition + description: Defines circumstances to be checked before allowing a behavior + type: object + properties: + queryTerms: + description: >- + Search only A list of terms to match the query on. Maximum of 10 + query terms. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionQueryTerm + activeTimeRange: + description: >- + Range of time(s) specifying when condition is active. Maximum of 10 + time ranges. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionTimeRange + GoogleCloudDiscoveryengineV1betaConditionQueryTerm: + id: GoogleCloudDiscoveryengineV1betaConditionQueryTerm + description: Matcher for search request query + type: object + properties: + value: + description: >- + The specific query value to match against Must be lowercase, must be + UTF-8. Can have at most 3 space separated terms if full_match is + true. Cannot be an empty string. Maximum length of 5000 characters. + type: string + fullMatch: + description: Whether the search query needs to exactly match the query term. + type: boolean + GoogleCloudDiscoveryengineV1betaConditionTimeRange: + id: GoogleCloudDiscoveryengineV1betaConditionTimeRange + description: Used for time-dependent conditions. + type: object + properties: + startTime: + description: Start of time range. Range is inclusive. + type: string + format: google-datetime + endTime: + description: End of time range. Range is inclusive. Must be in the future. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata + description: >- + Metadata related to the progress of the DataStoreService.CreateDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateEngineMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateEngineMetadata + description: >- + Metadata related to the progress of the EngineService.CreateEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata + description: Metadata for EvaluationService.CreateEvaluation method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata + description: Metadata for Create Schema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.CreateTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDataStore: + id: GoogleCloudDiscoveryengineV1betaDataStore + description: DataStore captures global settings and configs at the DataStore level. + type: object + properties: + name: + description: >- + Immutable. The full resource name of the data store. Format: + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + displayName: + description: >- + Required. The data store display name. This field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + INVALID_ARGUMENT error is returned. + type: string + industryVertical: + description: Immutable. The industry vertical that the data store registers. + type: string + enumDescriptions: + - Value used when unset. + - >- + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. + enum: + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + solutionTypes: + description: >- + The solutions that the data store enrolls. Available solutions for + each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` + and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` + is automatically enrolled. Other solutions cannot be enrolled. + type: array + items: + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's + used for Generative chat engine only, the associated data stores + must enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + defaultSchemaId: + description: >- + Output only. The id of the default Schema asscociated to this data + store. + readOnly: true + type: string + contentConfig: + description: >- + Immutable. The content config of the data store. If this field is + unset, the server behavior defaults to ContentConfig.NO_CONTENT. + type: string + enumDescriptions: + - Default value. + - Only contains documents without any Document.content. + - Only contains documents with Document.content. + - The data store is used for public website search. + - >- + The data store is used for workspace search. Details of workspace + data store are specified in the WorkspaceConfig. + enum: + - CONTENT_CONFIG_UNSPECIFIED + - NO_CONTENT + - CONTENT_REQUIRED + - PUBLIC_WEBSITE + - GOOGLE_WORKSPACE + createTime: + description: Output only. Timestamp the DataStore was created at. + readOnly: true + type: string + format: google-datetime + languageInfo: + description: Language info for DataStore. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaLanguageInfo' + naturalLanguageQueryUnderstandingConfig: + description: Optional. Configuration for Natural Language Query Understanding. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig + workspaceConfig: + description: >- + Config to store data store type configuration for workspace data. + This must be set when DataStore.content_config is set as + DataStore.ContentConfig.GOOGLE_WORKSPACE. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaWorkspaceConfig' + documentProcessingConfig: + description: Configuration for Document understanding and enrichment. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig + startingSchema: + description: >- + The start schema to use for this DataStore when provisioning it. If + unset, a default vertical specialized schema will be used. This + field is only used by CreateDataStore API, and will be ignored if + used in other APIs. This field will be omitted from all API + responses including CreateDataStore API. To retrieve a schema of a + DataStore, use SchemaService.GetSchema API instead. The provided + schema will be validated against certain rules on schema. Learn more + from [this + doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSchema' + servingConfigDataStore: + description: Optional. Stores serving config at DataStore level. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaServingConfigDataStore + GoogleCloudDiscoveryengineV1betaLanguageInfo: + id: GoogleCloudDiscoveryengineV1betaLanguageInfo + description: Language info for DataStore. + type: object + properties: + languageCode: + description: The language code for the DataStore. + type: string + normalizedLanguageCode: + description: >- + Output only. This is the normalized form of language_code. E.g.: + language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have + normalized_language_code of `en-GB`. + readOnly: true + type: string + language: + description: >- + Output only. Language part of normalized_language_code. E.g.: + `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. + readOnly: true + type: string + region: + description: >- + Output only. Region part of normalized_language_code, if present. + E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``. + readOnly: true + type: string + GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig: + id: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig + description: Configuration for Natural Language Query Understanding. + type: object + properties: + mode: + description: >- + Mode of Natural Language Query Understanding. If this field is + unset, the behavior defaults to + NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + type: string + enumDescriptions: + - Default value. + - Natural Language Query Understanding is disabled. + - Natural Language Query Understanding is enabled. + enum: + - MODE_UNSPECIFIED + - DISABLED + - ENABLED + GoogleCloudDiscoveryengineV1betaWorkspaceConfig: + id: GoogleCloudDiscoveryengineV1betaWorkspaceConfig + description: Config to store data store type configuration for workspace data + type: object + properties: + type: + description: The Google Workspace data source. + type: string + enumDescriptions: + - Defaults to an unspecified Workspace type. + - Workspace Data Store contains Drive data + - Workspace Data Store contains Mail data + - Workspace Data Store contains Sites data + - Workspace Data Store contains Calendar data + - Workspace Data Store contains Chat data + - Workspace Data Store contains Groups data + - Workspace Data Store contains Keep data + enum: + - TYPE_UNSPECIFIED + - GOOGLE_DRIVE + - GOOGLE_MAIL + - GOOGLE_SITES + - GOOGLE_CALENDAR + - GOOGLE_CHAT + - GOOGLE_GROUPS + - GOOGLE_KEEP + dasherCustomerId: + description: Obfuscated Dasher customer ID. + type: string + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig: + id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig + description: >- + A singleton resource of DataStore. It's empty when DataStore is created, + which defaults to digital parser. The first call to + DataStoreService.UpdateDocumentProcessingConfig method will initialize + the config. + type: object + properties: + name: + description: >- + The full resource name of the Document Processing Config. Format: + `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + type: string + chunkingConfig: + description: Whether chunking mode is enabled. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig + defaultParsingConfig: + description: >- + Configurations for default Document parser. If not specified, we + will configure it as default DigitalParsingConfig, and the default + parsing config will be applied to all file types for Document + parsing. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig + parsingConfigOverrides: + description: >- + Map from file type to override the default parsing configuration + based on the file type. Supported keys: * `pdf`: Override parsing + config for PDF files, either digital parsing, ocr parsing or layout + parsing is supported. * `html`: Override parsing config for HTML + files, only digital parsing and layout parsing are supported. * + `docx`: Override parsing config for DOCX files, only digital parsing + and layout parsing are supported. * `pptx`: Override parsing config + for PPTX files, only digital parsing and layout parsing are + supported. * `xlsm`: Override parsing config for XLSM files, only + digital parsing and layout parsing are supported. * `xlsx`: Override + parsing config for XLSX files, only digital parsing and layout + parsing are supported. + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig: + id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig + description: Configuration for chunking config. + type: object + properties: + layoutBasedChunkingConfig: + description: Configuration for the layout based chunking. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig + description: Configuration for the layout based chunking. + type: object + properties: + chunkSize: + description: >- + The token size limit for each chunk. Supported values: 100-500 + (inclusive). Default value: 500. + type: integer + format: int32 + includeAncestorHeadings: + description: >- + Whether to include appending different levels of headings to chunks + from the middle of the document to prevent context loss. Default + value: False. + type: boolean + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig: + id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig + description: Related configurations applied to a specific type of document parser. + type: object + properties: + digitalParsingConfig: + description: Configurations applied to digital parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig + ocrParsingConfig: + description: >- + Configurations applied to OCR parser. Currently it only applies to + PDFs. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig + layoutParsingConfig: + description: Configurations applied to layout parser. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig + description: The digital parsing configurations for documents. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig + description: The OCR parsing configurations for documents. + type: object + properties: + enhancedDocumentElements: + description: >- + [DEPRECATED] This field is deprecated. To use the additional + enhanced document elements processing, please switch to + `layout_parsing_config`. + deprecated: true + type: array + items: + type: string + useNativeText: + description: >- + If true, will use native text instead of OCR text on pages + containing native text. + type: boolean + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig: + id: >- + GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig + description: The layout parsing configurations for documents. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaSchema: + id: GoogleCloudDiscoveryengineV1betaSchema + description: Defines the structure and layout of a type of document data. + type: object + properties: + structSchema: + description: The structured representation of the schema. + type: object + additionalProperties: + type: any + description: Properties of the object. + jsonSchema: + description: The JSON representation of the schema. + type: string + name: + description: >- + Immutable. The full resource name of the schema, in the format of + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + GoogleCloudDiscoveryengineV1betaServingConfigDataStore: + id: GoogleCloudDiscoveryengineV1betaServingConfigDataStore + description: >- + Stores information regarding the serving configurations at DataStore + level. + type: object + properties: + disabledForServing: + description: >- + If set true, the DataStore will not be available for serving search + requests. + type: boolean + GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata + description: >- + Metadata related to the progress of the DataStoreService.DeleteDataStore + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata + description: >- + Metadata related to the progress of the EngineService.DeleteEngine + operation. This will be returned by the + google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata + description: Metadata for DeleteSchema LRO. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata: + id: GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DeleteTargetSite operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will + be returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse + description: >- + Response message for SiteSearchEngineService.DisableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata: + id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata + description: >- + Metadata related to the progress of the + SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be + returned by the google.longrunning.Operation.metadata field. + type: object + properties: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: + description: >- + Operation last update time. If the operation is done, this is also + the finish time. + type: string + format: google-datetime + GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse: + id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse + description: >- + Response message for SiteSearchEngineService.EnableAdvancedSiteSearch + method. + type: object + properties: {} + GoogleCloudDiscoveryengineV1betaEngine: + id: GoogleCloudDiscoveryengineV1betaEngine + description: >- + Metadata that describes the training and serving parameters of an + Engine. + type: object + properties: + chatEngineConfig: + description: >- + Configurations for the Chat Engine. Only applicable if solution_type + is SOLUTION_TYPE_CHAT. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig + searchEngineConfig: + description: >- + Configurations for the Search Engine. Only applicable if + solution_type is SOLUTION_TYPE_SEARCH. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig + chatEngineMetadata: + description: >- + Output only. Additional information of the Chat Engine. Only + applicable if solution_type is SOLUTION_TYPE_CHAT. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata + name: + description: >- + Immutable. The fully qualified resource name of the engine. This + field must be a UTF-8 encoded string with a length limit of 1024 + characters. Format: + `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + engine should be 1-63 characters, and valid characters are + /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. + type: string + displayName: + description: >- + Required. The display name of the engine. Should be human readable. + UTF-8 encoded string with limit of 1024 characters. + type: string + createTime: + description: Output only. Timestamp the Recommendation Engine was created at. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. Timestamp the Recommendation Engine was last updated. + readOnly: true + type: string + format: google-datetime + dataStoreIds: + description: >- + The data stores associated with this engine. For + SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of + engines, they can only associate with at most one data store. If + solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same + Collection can be associated here. Note that when used in + CreateEngineRequest, one DataStore id must be provided as the system + will use it for necessary initializations. + type: array + items: + type: string + solutionType: + description: Required. The solutions of the engine. + type: string + enumDescriptions: + - Default value. + - Used for Recommendations AI. + - Used for Discovery Search. + - Used for use cases related to the Generative AI agent. + - >- + Used for use cases related to the Generative Chat agent. It's used + for Generative chat engine only, the associated data stores must + enrolled with `SOLUTION_TYPE_CHAT` solution. + enum: + - SOLUTION_TYPE_UNSPECIFIED + - SOLUTION_TYPE_RECOMMENDATION + - SOLUTION_TYPE_SEARCH + - SOLUTION_TYPE_CHAT + - SOLUTION_TYPE_GENERATIVE_CHAT + industryVertical: + description: >- + The industry vertical that the engine registers. The restriction of + the Engine industry vertical is based on DataStore: If unspecified, + default to `GENERIC`. Vertical on Engine has to match vertical of + the DataStore linked to the engine. + type: string + enumDescriptions: + - Value used when unset. + - >- + The generic vertical for documents that are not specific to any + industry vertical. + - The media industry vertical. + - The healthcare FHIR vertical. + enum: + - INDUSTRY_VERTICAL_UNSPECIFIED + - GENERIC + - MEDIA + - HEALTHCARE_FHIR + commonConfig: + description: Common config spec that specifies the metadata of the engine. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineCommonConfig + GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig: + id: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig + description: Configurations for a Chat Engine. + type: object + properties: + agentCreationConfig: + description: >- + The configurationt generate the Dialogflow agent that is associated + to this Engine. Note that these configurations are one-time consumed + by and passed to Dialogflow service. It means they cannot be + retrieved using EngineService.GetEngine or EngineService.ListEngines + API after engine creation. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig + dialogflowAgentToLink: + description: >- + The resource name of an exist Dialogflow agent to link to this Chat + Engine. Customers can either provide `agent_creation_config` to + create agent or provide an agent name that links the agent with the + Chat engine. Format: `projects//locations//agents/`. Note that the + `dialogflow_agent_to_link` are one-time consumed by and passed to + Dialogflow service. It means they cannot be retrieved using + EngineService.GetEngine or EngineService.ListEngines API after + engine creation. Use ChatEngineMetadata.dialogflow_agent for actual + agent association after Engine is created. + type: string + GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig: + id: >- + GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig + description: >- + Configurations for generating a Dialogflow agent. Note that these + configurations are one-time consumed by and passed to Dialogflow + service. It means they cannot be retrieved using EngineService.GetEngine + or EngineService.ListEngines API after engine creation. + type: object + properties: + business: + description: >- + Name of the company, organization or other entity that the agent + represents. Used for knowledge connector LLM prompt and for + knowledge search. + type: string + defaultLanguageCode: + description: >- + Required. The default language of the agent as a language tag. See + [Language + Support](https://cloud.google.com/dialogflow/docs/reference/language) + for a list of the currently supported language codes. + type: string + timeZone: + description: >- + Required. The time zone of the agent from the [time zone + database](https://www.iana.org/time-zones), e.g., America/New_York, + Europe/Paris. + type: string + location: + description: >- + Agent location for Agent creation, supported values: global/us/eu. + If not provided, us Engine will create Agent using us-central-1 by + default; eu Engine will create Agent using eu-west-1 by default. + type: string + GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig: + id: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig + description: Configurations for a Search Engine. + type: object + properties: + searchTier: + description: >- + The search feature tier of this engine. Different tiers might have + different pricing. To learn more, check the pricing documentation. + Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + type: string + enumDescriptions: + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Standard tier. + - Enterprise tier. + enum: + - SEARCH_TIER_UNSPECIFIED + - SEARCH_TIER_STANDARD + - SEARCH_TIER_ENTERPRISE + searchAddOns: + description: The add-on that this search engine enables. + type: array + items: + type: string + enumDescriptions: + - >- + Default value when the enum is unspecified. This is invalid to + use. + - Large language model add-on. + enum: + - SEARCH_ADD_ON_UNSPECIFIED + - SEARCH_ADD_ON_LLM + GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata: + id: GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata + description: >- + Additional information of a Chat Engine. Fields in this message are + output only. + type: object + properties: + dialogflowAgent: + description: >- + The resource name of a Dialogflow agent, that this Chat Engine + refers to. Format: `projects//locations//agents/`. type: string - rootDomainUri: - description: Output only. Root domain of the provided_uri_pattern. - readOnly: true + GoogleCloudDiscoveryengineV1betaEngineCommonConfig: + id: GoogleCloudDiscoveryengineV1betaEngineCommonConfig + description: Common configurations for an Engine. + type: object + properties: + companyName: + description: >- + The name of the company, business or entity that is associated with + the engine. Setting this may help improve LLM related features. type: string - siteVerificationInfo: - description: Output only. Site ownership and validity verification status. - readOnly: true + GoogleCloudDiscoveryengineV1betaEvaluation: + id: GoogleCloudDiscoveryengineV1betaEvaluation + description: >- + An evaluation is a single execution (or run) of an evaluation process. + It encapsulates the state of the evaluation and the resulting data. + type: object + properties: + name: + description: >- + Identifier. The full resource name of the Evaluation, in the format + of + `projects/{project}/locations/{location}/evaluations/{evaluation}`. + This field must be a UTF-8 encoded string with a length limit of + 1024 characters. + type: string + evaluationSpec: + description: Required. The specification of the evaluation. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaSiteVerificationInfo - indexingStatus: - description: Output only. Indexing status. + #/components/schemas/GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec + qualityMetrics: + description: >- + Output only. The metrics produced by the evaluation, averaged across + all SampleQuerys in the SampleQuerySet. Only populated when the + evaluation's state is SUCCEEDED. + readOnly: true + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetrics' + state: + description: Output only. The state of the evaluation. readOnly: true type: string enumDescriptions: - - Defaults to SUCCEEDED. - - >- - The target site is in the update queue and will be picked up by - indexing pipeline. - - The target site fails to be indexed. - - The target site has been indexed. - - >- - The previously indexed target site has been marked to be deleted. - This is a transitioning state which will resulted in either: 1. - target site deleted if unindexing is successful; 2. state reverts - to SUCCEEDED if the unindexing fails. + - The evaluation is unspecified. + - The service is preparing to run the evaluation. + - The evaluation is in progress. + - The evaluation completed successfully. + - The evaluation failed. enum: - - INDEXING_STATUS_UNSPECIFIED + - STATE_UNSPECIFIED - PENDING - - FAILED + - RUNNING - SUCCEEDED - - DELETING - updateTime: - description: Output only. The target site's last updated time. + - FAILED + error: + description: >- + Output only. The error that occurred during evaluation. Only + populated when the evaluation's state is FAILED. + readOnly: true + $ref: '#/components/schemas/GoogleRpcStatus' + createTime: + description: Output only. Timestamp the Evaluation was created at. readOnly: true type: string format: google-datetime - failureReason: - description: Output only. Failure reason. + endTime: + description: Output only. Timestamp the Evaluation was completed at. + readOnly: true + type: string + format: google-datetime + errorSamples: + description: >- + Output only. A sample of errors encountered while processing the + request. readOnly: true + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec: + id: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec + description: Describes the specification of the evaluation. + type: object + properties: + searchRequest: + description: >- + Required. The search request that is used to perform the evaluation. + Only the following fields within SearchRequest are supported; if any + other fields are provided, an UNSUPPORTED error will be returned: * + SearchRequest.serving_config * SearchRequest.branch * + SearchRequest.canonical_filter * SearchRequest.query_expansion_spec + * SearchRequest.spell_correction_spec * + SearchRequest.content_search_spec * SearchRequest.user_pseudo_id + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequest' + querySetSpec: + description: Required. The specification of the query set. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason - GoogleCloudDiscoveryengineV1betaSiteVerificationInfo: - id: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo - description: Verification information for target sites in advanced site search. + #/components/schemas/GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec + GoogleCloudDiscoveryengineV1betaSearchRequest: + id: GoogleCloudDiscoveryengineV1betaSearchRequest + description: Request message for SearchService.Search method. type: object properties: - siteVerificationState: - description: Site verification state indicating the ownership and validity. + servingConfig: + description: >- + Required. The resource name of the Search serving config, such as + `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, + or + `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. + This field is used to identify the serving configuration name, set + of models used to make the search. type: string - enumDescriptions: - - Defaults to VERIFIED. - - Site ownership verified. - - Site ownership pending verification or verification failed. - - >- - Site exempt from verification, e.g., a public website that opens - to all. - enum: - - SITE_VERIFICATION_STATE_UNSPECIFIED - - VERIFIED - - UNVERIFIED - - EXEMPTED - verifyTime: - description: Latest site verification time. + branch: + description: >- + The branch resource name, such as + `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. + Use `default_branch` as the branch ID or leave this field empty, to + search documents under the default branch. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason: - id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason - description: Site search indexing failure reasons. - type: object - properties: - quotaFailure: - description: Failed due to insufficient quota. + query: + description: Raw search query. + type: string + imageQuery: + description: Raw image query. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure - GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure: - id: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure - description: Failed due to insufficient quota. - type: object - properties: - totalRequiredQuota: + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery + pageSize: description: >- - This number is an estimation on how much total quota this project - needs to successfully complete indexing. + Maximum number of Documents to return. The maximum allowed value + depends on the data type. Values above the maximum value are coerced + to the maximum value. * Websites with basic indexing: Default `10`, + Maximum `25`. * Websites with advanced indexing: Default `25`, + Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is + negative, an `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + pageToken: + description: >- + A page token received from a previous SearchService.Search call. + Provide this to retrieve the subsequent page. When paginating, all + other parameters provided to SearchService.Search must match the + call that provided the page token. Otherwise, an `INVALID_ARGUMENT` + error is returned. type: string - format: int64 - GoogleCloudDiscoveryengineV1betaControl: - id: GoogleCloudDiscoveryengineV1betaControl - description: >- - Defines a conditioned behavior to employ during serving. Must be - attached to a ServingConfig to be considered at serving time. Permitted - actions dependent on `SolutionType`. - type: object - properties: - boostAction: - description: Defines a boost-type control + offset: + description: >- + A 0-indexed integer that specifies the current offset (that is, + starting result location, amongst the Documents deemed by the API as + relevant) in search results. This field is only considered if + page_token is unset. If this field is negative, an + `INVALID_ARGUMENT` is returned. + type: integer + format: int32 + dataStoreSpecs: + description: >- + Specs defining dataStores to filter on in a search call and + configurations for those dataStores. This is only considered for + engines with multiple dataStores use case. For single dataStore + within an engine, they should use the specs at the top level. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec + filter: + description: >- + The filter syntax consists of an expression language for + constructing a predicate from one or more fields of the documents + being filtered. Filter expression is case-sensitive. If this field + is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in + Vertex AI Search is done by mapping the LHS filter key to a key + property defined in the Vertex AI Search backend -- this mapping is + defined by the customer in their schema. For example a media + customer might have a field 'name' in their schema. In this case the + filter would look like this: filter --> name:'ANY("king kong")' For + more information about filtering including syntax and filter + operators, see + [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + type: string + canonicalFilter: + description: >- + The default filter that is applied when a user performs a search + without checking any filters on the search page. The filter applied + to every search request when quality improvement such as query + expansion is needed. In the case a query does not have a sufficient + amount of results this filter will be used to determine whether or + not to enable the query expansion flow. The original filter will + still be used for the query expanded search. This field is strongly + recommended to achieve high search quality. For more information + about filter syntax, see SearchRequest.filter. + type: string + orderBy: + description: >- + The order in which documents are returned. Documents can be ordered + by a field in an Document object. Leave it unset if ordered by + relevance. `order_by` expression is case-sensitive. For more + information on ordering the website search results, see [Order web + search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + For more information on ordering the healthcare search results, see + [Order healthcare search + results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + type: string + userInfo: + description: >- + Information about the end user. Highly recommended for analytics. + UserInfo.user_agent is used to deduce `device_type` for analytics. + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaUserInfo' + languageCode: + description: >- + The BCP-47 language code, such as "en-US" or "sr-Latn". For more + information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). This + field helps to better interpret the query. If a value isn't + specified, the query language code is automatically detected, which + may not be accurate. + type: string + regionCode: + description: >- + The Unicode country/region code (CLDR) of a location, such as "US" + and "419". For more information, see [Standard + fields](https://cloud.google.com/apis/design/standard_fields). If + set, then results will be boosted based on the region_code provided. + type: string + facetSpecs: + description: >- + Facet specifications for faceted search. If empty, no facets are + returned. A maximum of 100 values are allowed. Otherwise, an + `INVALID_ARGUMENT` error is returned. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec + boostSpec: + description: >- + Boost specification to boost certain documents. For more information + on boosting, see + [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec + params: + description: >- + Additional search parameters. For public website search only, + supported values are: * `user_country_code`: string. Default empty. + If set to non-empty, results are restricted or boosted based on the + location provided. For example, `user_country_code: "au"` For + available codes see [Country + Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + * `search_type`: double. Default empty. Enables non-webpage + searching depending on the value. The only valid non-default value + is 1, which enables image searching. For example, `search_type: 1` + type: object + additionalProperties: + type: any + queryExpansionSpec: + description: >- + The query expansion specification that specifies the conditions + under which query expansion occurs. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlBoostAction - filterAction: + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec + spellCorrectionSpec: description: >- - Defines a filter-type control Currently not supported by - Recommendation + The spell correction specification that specifies the mode under + which spell correction takes effect. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlFilterAction - redirectAction: - description: Defines a redirect-type control. + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec + userPseudoId: + description: >- + A unique identifier for tracking visitors. For example, this could + be implemented with an HTTP cookie, which should be able to uniquely + identify a visitor on a single device. This unique identifier should + not change if the visitor logs in or out of the website. This field + should NOT have a fixed value such as `unknown_visitor`. This should + be the same identifier as UserEvent.user_pseudo_id and + CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 + encoded string with a length limit of 128 characters. Otherwise, an + `INVALID_ARGUMENT` error is returned. + type: string + contentSearchSpec: + description: A specification for configuring the behavior of content search. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlRedirectAction - synonymsAction: - description: Treats a group of terms as synonyms of one another. + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec + embeddingSpec: + description: >- + Uses the provided embedding to do additional semantic document + retrieval. The retrieval is based on the dot product of + SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document + embedding that is provided in + SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If + SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not + provided, it will use ServingConfig.EmbeddingConfig.field_path. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaControlSynonymsAction - name: - description: >- - Immutable. Fully qualified name - `projects/*/locations/global/dataStore/*/controls/*` + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec + rankingExpression: + description: >- + The ranking expression controls the customized ranking on retrieval + documents. This overrides ServingConfig.ranking_expression. The + ranking expression is a single function or multiple functions that + are joined by "+". * ranking_expression = function, { " + ", + function }; Supported functions: * double * relevance_score * double + * dotProduct(embedding_field_path) Function variables: * + `relevance_score`: pre-defined keywords, used for measure relevance + between query and document. * `embedding_field_path`: the document + embedding field used with query embedding vector. * `dotProduct`: + embedding function between embedding_field_path and query embedding + vector. Example ranking expression: If document has an embedding + field doc_embedding, the ranking expression could be `0.5 * + relevance_score + 0.3 * dotProduct(doc_embedding)`. type: string - displayName: + safeSearch: description: >- - Required. Human readable name. The identifier used in UI views. Must - be UTF-8 encoded string. Length limit is 128 characters. Otherwise - an INVALID ARGUMENT error is thrown. - type: string - associatedServingConfigIds: + Whether to turn on safe search. This is only supported for website + search. + type: boolean + userLabels: description: >- - Output only. List of all ServingConfig ids this control is attached - to. May take up to 10 minutes to update after changes. - readOnly: true - type: array - items: + The user labels applied to a resource must meet the following + requirements: * Each resource can have multiple labels, up to a + maximum of 64. * Each label must be a key-value pair. * Keys have a + minimum length of 1 character and a maximum length of 63 characters + and cannot be empty. Values can be empty and have a maximum length + of 63 characters. * Keys and values can contain only lowercase + letters, numeric characters, underscores, and dashes. All characters + must use UTF-8 encoding, and international characters are allowed. * + The key portion of a label must be unique. However, you can use the + same key with multiple resources. * Keys must start with a lowercase + letter or international character. See [Google Cloud + Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) + for more details. + type: object + additionalProperties: type: string - solutionType: + naturalLanguageQueryUnderstandingSpec: description: >- - Required. Immutable. What solution the control belongs to. Must be - compatible with vertical of resource. Otherwise an INVALID ARGUMENT - error is thrown. + If `naturalLanguageQueryUnderstandingSpec` is not specified, no + additional natural language query understanding will be done. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec + searchAsYouTypeSpec: + description: >- + Search as you type configuration. Only supported for the + IndustryVertical.MEDIA vertical. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec + session: + description: >- + The session resource name. Optional. Session allows users to do + multi-turn /search API calls or coordination between /search API + calls and /answer API calls. Example #1 (multi-turn /search API + calls): 1. Call /search API with the auto-session mode (see below). + 2. Call /search API with the session ID generated in the first call. + Here, the previous search query gets considered in query standing. + I.e., if the first query is "How did Alphabet do in 2022?" and the + current query is "How about 2023?", the current query will be + interpreted as "How did Alphabet do in 2023?". Example #2 + (coordination between /search API calls and /answer API calls): 1. + Call /search API with the auto-session mode (see below). 2. Call + /answer API with the session ID generated in the first call. Here, + the answer generation happens in the context of the search results + from the first search call. Auto-session mode: when + `projects/.../sessions/-` is used, a new session gets automatically + created. Otherwise, users can use the create-session API to create a + session manually. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we + launch this feature to public GA. Or ask for allowlisting through + Google Support team. + type: string + sessionSpec: + description: Session specification. Can be used only when `session` is set. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec + relevanceThreshold: + description: >- + The relevance threshold of the search results. Default to Google + defined threshold, leveraging a balance of precision and recall to + deliver both highly accurate results and comprehensive coverage of + relevant information. type: string enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. + Default value. In this case, server behavior defaults to Google + defined threshold. + - Lowest relevance threshold. + - Low relevance threshold. + - Medium relevance threshold. + - High relevance threshold. enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - useCases: - description: >- - Specifies the use case for the control. Affects what condition - fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently - only allow one use case per control. Must be set when solution_type - is SolutionType.SOLUTION_TYPE_SEARCH. - type: array - items: - type: string - enumDescriptions: - - Value used when unset. Will not occur in CSS. - - Search use case. Expects the traffic has a non-empty query. - - Browse use case. Expects the traffic has an empty query. - enum: - - SEARCH_USE_CASE_UNSPECIFIED - - SEARCH_USE_CASE_SEARCH - - SEARCH_USE_CASE_BROWSE - conditions: - description: >- - Determines when the associated action will trigger. Omit to always - apply the action. Currently only a single condition may be - specified. Otherwise an INVALID ARGUMENT error is thrown. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaCondition' - GoogleCloudDiscoveryengineV1betaControlBoostAction: - id: GoogleCloudDiscoveryengineV1betaControlBoostAction - description: Adjusts order of products in returned list. + - RELEVANCE_THRESHOLD_UNSPECIFIED + - LOWEST + - LOW + - MEDIUM + - HIGH + GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery: + id: GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery + description: Specifies the image query input. type: object properties: - boost: - description: >- - Required. Strength of the boost, which should be in [-1, 1]. - Negative boost means demotion. Default is 0.0 (No-op). - type: number - format: float - filter: + imageBytes: description: >- - Required. Specifies which products to apply the boost to. If no - filter is provided all products will be boosted (No-op). Syntax - documentation: https://cloud.google.com/retail/docs/filter-and-order - Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT - error is thrown. + Base64 encoded image bytes. Supported image formats: JPEG, PNG, and + BMP. type: string + GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec + description: >- + A struct to define data stores to filter on in a search call and + configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` + error is returned. + type: object + properties: dataStore: description: >- - Required. Specifies which data store's documents can be boosted by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store + Required. Full resource name of DataStore, such as + `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. type: string - GoogleCloudDiscoveryengineV1betaControlFilterAction: - id: GoogleCloudDiscoveryengineV1betaControlFilterAction - description: >- - Specified which products may be included in results. Uses same filter as - boost. + GoogleCloudDiscoveryengineV1betaUserInfo: + id: GoogleCloudDiscoveryengineV1betaUserInfo + description: Information of an end user. type: object properties: - filter: + userId: description: >- - Required. A filter to apply on the matching condition results. - Required Syntax documentation: - https://cloud.google.com/retail/docs/filter-and-order Maximum length - is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + Highly recommended for logged-in users. Unique identifier for + logged-in user, such as a user name. Don't set for anonymous users. + Always use a hashed value for this ID. Don't set the field to the + same fixed ID for different users. This mixes the event history of + those users together, which results in degraded model quality. The + field must be a UTF-8 encoded string with a length limit of 128 + characters. Otherwise, an `INVALID_ARGUMENT` error is returned. type: string - dataStore: + userAgent: description: >- - Required. Specifies which data store's documents can be filtered by - this control. Full data store name e.g. - projects/123/locations/global/collections/default_collection/dataStores/default_data_store + User agent as included in the HTTP header. The field must be a UTF-8 + encoded string with a length limit of 1,000 characters. Otherwise, + an `INVALID_ARGUMENT` error is returned. This should not be set when + using the client side event reporting with GTM or JavaScript tag in + UserEventService.CollectUserEvent or if + UserEvent.direct_user_request is set. type: string - GoogleCloudDiscoveryengineV1betaControlRedirectAction: - id: GoogleCloudDiscoveryengineV1betaControlRedirectAction - description: Redirects a shopper to the provided URI. + GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec + description: A facet specification to perform faceted search. type: object properties: - redirectUri: + facetKey: + description: Required. The facet key specification. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey + limit: description: >- - Required. The URI to which the shopper will be redirected. Required. - URI must have length equal or less than 2000 characters. Otherwise - an INVALID ARGUMENT error is thrown. - type: string - GoogleCloudDiscoveryengineV1betaControlSynonymsAction: - id: GoogleCloudDiscoveryengineV1betaControlSynonymsAction - description: >- - Creates a set of terms that will act as synonyms of one another. - Example: "happy" will also be considered as "glad", "glad" will also be - considered as "happy". + Maximum facet values that are returned for this facet. If + unspecified, defaults to 20. The maximum allowed value is 300. + Values above 300 are coerced to 300. For aggregation in healthcare + search, when the [FacetKey.key] is "healthcare_aggregation_key", the + limit will be overridden to 10,000 internally, regardless of the + value set here. If this field is negative, an `INVALID_ARGUMENT` is + returned. + type: integer + format: int32 + excludedFilterKeys: + description: >- + List of keys to exclude when faceting. By default, FacetKey.key is + not excluded from the filter unless it is listed in this field. + Listing a facet key in this field allows its values to appear as + facet results, even when they are filtered out of search results. + Using this field does not affect what search results are returned. + For example, suppose there are 100 documents with the color facet + "Red" and 200 documents with the color facet "Blue". A query + containing the filter "color:ANY("Red")" and having "color" as + FacetKey.key would by default return only "Red" documents in the + search results, and also return "Red" with count 100 as the only + color facet. Although there are also blue documents available, + "Blue" would not be shown as an available facet value. If "color" is + listed in "excludedFilterKeys", then the query returns the facet + values "Red" with count 100 and "Blue" with count 200, because the + "color" key is now excluded from the filter. Because this field + doesn't affect search results, the search results are still + correctly filtered to return only "Red" documents. A maximum of 100 + values are allowed. Otherwise, an `INVALID_ARGUMENT` error is + returned. + type: array + items: + type: string + enableDynamicPosition: + description: >- + Enables dynamic position for this facet. If set to true, the + position of this facet among all facets in the response is + determined automatically. If dynamic facets are enabled, it is + ordered together. If set to false, the position of this facet in the + response is the same as in the request, and it is ranked before the + facets with dynamic position enable and all dynamic facets. For + example, you may always want to have rating facet returned in the + response, but it's not necessarily to always display the rating + facet at the top. In that case, you can set enable_dynamic_position + to true so that the position of rating facet in response is + determined automatically. Another example, assuming you have the + following facets in the request: * "rating", enable_dynamic_position + = true * "price", enable_dynamic_position = false * "brands", + enable_dynamic_position = false And also you have a dynamic facets + enabled, which generates a facet `gender`. Then the final order of + the facets in the response can be ("price", "brands", "rating", + "gender") or ("price", "brands", "gender", "rating") depends on how + API orders "gender" and "rating" facets. However, notice that + "price" and "brands" are always ranked at first and second position + because their enable_dynamic_position is false. + type: boolean + GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey: + id: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey + description: Specifies how a facet is computed. type: object properties: - synonyms: + key: + description: >- + Required. Supported textual and numerical facet keys in Document + object, over which the facet values are computed. Facet key is + case-sensitive. + type: string + intervals: description: >- - Defines a set of synonyms. Can specify up to 100 synonyms. Must - specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is - thrown. + Set only if values should be bucketed into intervals. Must be set + for facets with numerical values. Must not be set for facet with + text values. Maximum number of intervals is 30. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaInterval' + restrictedValues: + description: >- + Only get facet for the given restricted values. Only supported on + textual fields. For example, suppose "category" has three values + "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set + "restricted_values" to "Action > 2022", the "category" facet only + contains "Action > 2022". Only supported on textual fields. Maximum + is 10. type: array items: type: string - GoogleCloudDiscoveryengineV1betaCondition: - id: GoogleCloudDiscoveryengineV1betaCondition - description: Defines circumstances to be checked before allowing a behavior - type: object - properties: - queryTerms: + prefixes: description: >- - Search only A list of terms to match the query on. Maximum of 10 - query terms. + Only get facet values that start with the given string prefix. For + example, suppose "category" has three values "Action > 2022", + "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", + the "category" facet only contains "Action > 2022" and "Action > + 2021". Only supported on textual fields. Maximum is 10. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionQueryTerm - activeTimeRange: + type: string + contains: description: >- - Range of time(s) specifying when condition is active. Maximum of 10 - time ranges. + Only get facet values that contain the given strings. For example, + suppose "category" has three values "Action > 2022", "Action > 2021" + and "Sci-Fi > 2022". If set "contains" to "2022", the "category" + facet only contains "Action > 2022" and "Sci-Fi > 2022". Only + supported on textual fields. Maximum is 10. type: array items: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaConditionTimeRange - GoogleCloudDiscoveryengineV1betaConditionQueryTerm: - id: GoogleCloudDiscoveryengineV1betaConditionQueryTerm - description: Matcher for search request query - type: object - properties: - value: + type: string + caseInsensitive: description: >- - The specific query value to match against Must be lowercase, must be - UTF-8. Can have at most 3 space separated terms if full_match is - true. Cannot be an empty string. Maximum length of 5000 characters. - type: string - fullMatch: - description: Whether the search query needs to exactly match the query term. + True to make facet keys case insensitive when getting faceting + values with prefixes or contains; false otherwise. type: boolean - GoogleCloudDiscoveryengineV1betaConditionTimeRange: - id: GoogleCloudDiscoveryengineV1betaConditionTimeRange - description: Used for time-dependent conditions. - type: object - properties: - startTime: - description: Start of time range. Range is inclusive. - type: string - format: google-datetime - endTime: - description: End of time range. Range is inclusive. Must be in the future. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata - description: >- - Metadata related to the progress of the DataStoreService.CreateDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + orderBy: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The order in which documents are returned. Allowed values are: * + "count desc", which means order by SearchResponse.Facet.values.count + descending. * "value desc", which means order by + SearchResponse.Facet.values.value descending. Only applies to + textual facets. If not set, textual values are sorted in [natural + order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical + intervals are sorted in the order given by + FacetSpec.FacetKey.intervals. type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateEngineMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateEngineMetadata - description: >- - Metadata related to the progress of the EngineService.CreateEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. + GoogleCloudDiscoveryengineV1betaInterval: + id: GoogleCloudDiscoveryengineV1betaInterval + description: A floating point interval. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata - description: Metadata for Create Schema LRO. + minimum: + description: Inclusive lower bound. + type: number + format: double + exclusiveMinimum: + description: Exclusive lower bound. + type: number + format: double + maximum: + description: Inclusive upper bound. + type: number + format: double + exclusiveMaximum: + description: Exclusive upper bound. + type: number + format: double + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec + description: Boost specification to boost certain documents. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + conditionBoostSpecs: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.CreateTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. + Condition boost specifications. If a document matches multiple + conditions in the specifictions, boost scores from these + specifications are all applied and combined in a non-linear way. + Maximum number of specifications is 20. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec + description: Boost applies to documents which match a condition. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + condition: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + An expression which specifies a boost condition. The syntax and + supported fields are the same as a filter expression. See + SearchRequest.filter for detail syntax and limitations. Examples: * + To boost documents with document ID "doc_1" or "doc_2", and color + "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: + ANY("Red", "Blue"))` type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDataStore: - id: GoogleCloudDiscoveryengineV1betaDataStore - description: DataStore captures global settings and configs at the DataStore level. - type: object - properties: - name: + boost: description: >- - Immutable. The full resource name of the data store. Format: - `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. - type: string - displayName: + Strength of the condition boost, which should be in [-1, 1]. + Negative boost means demotion. Default is 0.0. Setting to 1.0 gives + the document a big promotion. However, it does not necessarily mean + that the boosted document will be the top result at all times, nor + that other documents will be excluded. Results could still be shown + even when none of them matches the condition. And results that are + significantly more relevant to the search query can still trump your + heavily favored but irrelevant documents. Setting to -1.0 gives the + document a big demotion. However, results that are deeply relevant + might still be shown. The document will have an upstream battle to + get a fairly high ranking, but it is not blocked out completely. + Setting to 0.0 means no boost applied. The boosting condition is + ignored. Only one of the (condition, boost) combination or the + boost_control_spec below are set. If both are set then the global + boost is ignored and the more fine-grained boost_control_spec is + applied. + type: number + format: float + boostControlSpec: description: >- - Required. The data store display name. This field must be a UTF-8 - encoded string with a length limit of 128 characters. Otherwise, an - INVALID_ARGUMENT error is returned. - type: string - industryVertical: - description: Immutable. The industry vertical that the data store registers. - type: string - enumDescriptions: - - Value used when unset. - - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. - enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - solutionTypes: + Complex specification for custom ranking based on customer defined + attribute value. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec + description: >- + Specification for custom ranking based on customer specified attribute + value. It provides more controls for customized ranking than the simple + (condition, boost) combination above. + type: object + properties: + fieldName: description: >- - The solutions that the data store enrolls. Available solutions for - each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` - and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` - is automatically enrolled. Other solutions cannot be enrolled. - type: array - items: - type: string - enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's - used for Generative chat engine only, the associated data stores - must enrolled with `SOLUTION_TYPE_CHAT` solution. - enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - defaultSchemaId: + The name of the field whose value will be used to determine the + boost amount. + type: string + attributeType: description: >- - Output only. The id of the default Schema asscociated to this data - store. - readOnly: true + The attribute type to be used to determine the boost amount. The + attribute value can be derived from the field value of the specified + field_name. In the case of numerical it is straightforward i.e. + attribute_value = numerical_field_value. In the case of freshness + however, attribute_value = (time.now() - datetime_field_value). type: string - contentConfig: + enumDescriptions: + - Unspecified AttributeType. + - >- + The value of the numerical field will be used to dynamically + update the boost amount. In this case, the attribute_value (the x + value) of the control point will be the actual value of the + numerical field for which the boost_amount is specified. + - >- + For the freshness use case the attribute value will be the + duration between the current time and the date in the datetime + field specified. The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 + duration value). The pattern for this is: `nDnM]`. For example, + `5D`, `3DT12H30M`, `T24H`. + enum: + - ATTRIBUTE_TYPE_UNSPECIFIED + - NUMERICAL + - FRESHNESS + interpolationType: description: >- - Immutable. The content config of the data store. If this field is - unset, the server behavior defaults to ContentConfig.NO_CONTENT. + The interpolation type to be applied to connect the control points + listed below. type: string enumDescriptions: - - Default value. - - Only contains documents without any Document.content. - - Only contains documents with Document.content. - - The data store is used for public website search. + - >- + Interpolation type is unspecified. In this case, it defaults to + Linear. + - Piecewise linear interpolation will be applied. enum: - - CONTENT_CONFIG_UNSPECIFIED - - NO_CONTENT - - CONTENT_REQUIRED - - PUBLIC_WEBSITE - createTime: - description: Output only. Timestamp the DataStore was created at. - readOnly: true + - INTERPOLATION_TYPE_UNSPECIFIED + - LINEAR + controlPoints: + description: >- + The control points used to define the curve. The monotonic function + (defined through the interpolation_type above) passes through the + control points listed here. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint + description: >- + The control points used to define the curve. The curve defined through + these control points can only be monotonically increasing or + decreasing(constant values are acceptable). + type: object + properties: + attributeValue: + description: >- + Can be one of: 1. The numerical field value. 2. The duration spec + for freshness: The value must be formatted as an XSD + `dayTimeDuration` value (a restricted subset of an ISO 8601 duration + value). The pattern for this is: `nDnM]`. type: string - format: google-datetime - documentProcessingConfig: - description: Configuration for Document understanding and enrichment. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig - startingSchema: + boostAmount: description: >- - The start schema to use for this DataStore when provisioning it. If - unset, a default vertical specialized schema will be used. This - field is only used by CreateDataStore API, and will be ignored if - used in other APIs. This field will be omitted from all API - responses including CreateDataStore API. To retrieve a schema of a - DataStore, use SchemaService.GetSchema API instead. The provided - schema will be validated against certain rules on schema. Learn more - from [this - doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1betaSchema' - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig: - id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig + The value between -1 to 1 by which to boost the score if the + attribute_value evaluates to the value specified above. + type: number + format: float + GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec description: >- - A singleton resource of DataStore. It's empty when DataStore is created, - which defaults to digital parser. The first call to - DataStoreService.UpdateDocumentProcessingConfig method will initialize - the config. + Specification to determine under which conditions query expansion should + occur. type: object properties: - name: + condition: description: >- - The full resource name of the Document Processing Config. Format: - `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + The condition under which query expansion should occur. Default to + Condition.DISABLED. type: string - defaultParsingConfig: + enumDescriptions: + - >- + Unspecified query expansion condition. In this case, server + behavior defaults to Condition.DISABLED. + - >- + Disabled query expansion. Only the exact search query is used, + even if SearchResponse.total_size is zero. + - Automatic query expansion built by the Search API. + enum: + - CONDITION_UNSPECIFIED + - DISABLED + - AUTO + pinUnexpandedResults: description: >- - Configurations for default Document parser. If not specified, we - will configure it as default DigitalParsingConfig, and the default - parsing config will be applied to all file types for Document - parsing. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig - parsingConfigOverrides: + Whether to pin unexpanded results. If this field is set to true, + unexpanded products are always at the top of the search results, + followed by the expanded results. + type: boolean + GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec + description: The specification for query spell correction. + type: object + properties: + mode: description: >- - Map from file type to override the default parsing configuration - based on the file type. Supported keys: * `pdf`: Override parsing - config for PDF files, either digital parsing, ocr parsing or layout - parsing is supported. * `html`: Override parsing config for HTML - files, only digital parsing and or layout parsing are supported. * - `docx`: Override parsing config for DOCX files, only digital parsing - and or layout parsing are supported. - type: object - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig: - id: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig - description: Related configurations applied to a specific type of document parser. + The mode under which spell correction replaces the original search + query. Defaults to Mode.AUTO. + type: string + enumDescriptions: + - >- + Unspecified spell correction mode. In this case, server behavior + defaults to Mode.AUTO. + - >- + Search API tries to find a spelling suggestion. If a suggestion is + found, it is put in the SearchResponse.corrected_query. The + spelling suggestion won't be used as the search query. + - >- + Automatic spell correction built by the Search API. Search will be + based on the corrected query if found. + enum: + - MODE_UNSPECIFIED + - SUGGESTION_ONLY + - AUTO + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec + description: A specification for configuring the behavior of content search. type: object properties: - digitalParsingConfig: - description: Configurations applied to digital parser. + snippetSpec: + description: >- + If `snippetSpec` is not specified, snippets are not included in the + search response. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig - ocrParsingConfig: + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec + summarySpec: description: >- - Configurations applied to OCR parser. Currently it only applies to - PDFs. + If `summarySpec` is not specified, summaries are not included in the + search response. $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig: + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec + extractiveContentSpec: + description: >- + If there is no extractive_content_spec provided, there will be no + extractive answer in the search response. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec + searchResultMode: + description: >- + Specifies the search result mode. If unspecified, the search result + mode defaults to `DOCUMENTS`. + type: string + enumDescriptions: + - Default value. + - Returns documents in the search result. + - >- + Returns chunks in the search result. Only available if the + DataStore.DocumentProcessingConfig.chunking_config is specified. + enum: + - SEARCH_RESULT_MODE_UNSPECIFIED + - DOCUMENTS + - CHUNKS + chunkSpec: + description: >- + Specifies the chunk spec to be returned from the search response. + Only available if the + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec: id: >- - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig - description: The digital parsing configurations for documents. + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec + description: A specification for configuring snippets in a search response. type: object - properties: {} - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig: + properties: + maxSnippetCount: + description: >- + [DEPRECATED] This field is deprecated. To control snippet return, + use `return_snippet` field. For backwards compatibility, we will + return snippet if max_snippet_count > 0. + deprecated: true + type: integer + format: int32 + referenceOnly: + description: >- + [DEPRECATED] This field is deprecated and will have no affect on the + snippet. + deprecated: true + type: boolean + returnSnippet: + description: >- + If `true`, then return snippet. If no snippet can be generated, we + return "No snippet is available for this page." A `snippet_status` + with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. + type: boolean + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec: id: >- - GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig - description: The OCR parsing configurations for documents. + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec + description: A specification for configuring a summary returned in a search response. type: object properties: - enhancedDocumentElements: + summaryResultCount: description: >- - [DEPRECATED] This field is deprecated. To use the additional - enhanced document elements processing, please switch to - `layout_parsing_config`. - deprecated: true - type: array - items: - type: string - useNativeText: + The number of top results to generate the summary from. If the + number of results returned is less than `summaryResultCount`, the + summary is generated from all of the results. At most 10 results for + documents mode, or 50 for chunks mode, can be used to generate a + summary. The chunks mode is used when + SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + type: integer + format: int32 + includeCitations: + description: >- + Specifies whether to include citations in the summary. The default + value is `false`. When this field is set to `true`, summaries + include in-line citation numbers. Example summary including + citations: BigQuery is Google Cloud's fully managed and completely + serverless enterprise data warehouse [1]. BigQuery supports all data + types, works across clouds, and has built-in machine learning and + business intelligence, all within a unified platform [2, 3]. The + citation numbers refer to the returned search results and are + 1-indexed. For example, [1] means that the sentence is attributed to + the first search result. [2, 3] means that the sentence is + attributed to both the second and third search results. + type: boolean + ignoreAdversarialQuery: + description: >- + Specifies whether to filter out adversarial queries. The default + value is `false`. Google employs search-query classification to + detect adversarial queries. No summary is returned if the search + query is classified as an adversarial query. For example, a user + might ask a question regarding negative comments about the company + or submit a query designed to generate unsafe, policy-violating + output. If this field is set to `true`, we skip generating summaries + for adversarial queries and return fallback messages instead. + type: boolean + ignoreNonSummarySeekingQuery: + description: >- + Specifies whether to filter out queries that are not + summary-seeking. The default value is `false`. Google employs + search-query classification to detect summary-seeking queries. No + summary is returned if the search query is classified as a + non-summary seeking query. For example, `why is the sky blue` and + `Who is the best soccer player in the world?` are summary-seeking + queries, but `SFO airport` and `world cup 2026` are not. They are + most likely navigational queries. If this field is set to `true`, we + skip generating summaries for non-summary seeking queries and return + fallback messages instead. + type: boolean + ignoreLowRelevantContent: + description: >- + Specifies whether to filter out queries that have low relevance. The + default value is `false`. If this field is set to `false`, all + search results are used regardless of relevance to generate answers. + If set to `true`, only queries with high relevance search results + will generate answers. + type: boolean + ignoreJailBreakingQuery: + description: >- + Optional. Specifies whether to filter out jail-breaking queries. The + default value is `false`. Google employs search-query classification + to detect jail-breaking queries. No summary is returned if the + search query is classified as a jail-breaking query. A user might + add instructions to the query to change the tone, style, language, + content of the answer, or ask the model to act as a different + entity, e.g. "Reply in the tone of a competing company's CEO". If + this field is set to `true`, we skip generating summaries for + jail-breaking queries and return fallback messages instead. + type: boolean + modelPromptSpec: + description: >- + If specified, the spec will be used to modify the prompt provided to + the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + languageCode: + description: >- + Language code for Summary. Use language tags defined by + [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is + an experimental feature. + type: string + modelSpec: + description: >- + If specified, the spec will be used to modify the model + specification provided to the LLM. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec + useSemanticChunks: description: >- - If true, will use native text instead of OCR text on pages - containing native text. + If true, answer will be generated from most relevant chunks from top + search results. This feature will improve summary quality. Note that + with this feature enabled, not all top search results will be + referenced and included in the reference list, so the citation + source index only points to the search results listed in the + reference list. type: boolean - GoogleCloudDiscoveryengineV1betaSchema: - id: GoogleCloudDiscoveryengineV1betaSchema - description: Defines the structure and layout of a type of document data. + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec + description: Specification of the prompt to use with the model. type: object properties: - structSchema: - description: The structured representation of the schema. - type: object - additionalProperties: - type: any - description: Properties of the object. - jsonSchema: - description: The JSON representation of the schema. - type: string - name: + preamble: description: >- - Immutable. The full resource name of the schema, in the format of - `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. - This field must be a UTF-8 encoded string with a length limit of - 1024 characters. + Text at the beginning of the prompt that instructs the assistant. + Examples are available in the user guide. type: string - GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata - description: >- - Metadata related to the progress of the DataStoreService.DeleteDataStore - operation. This will be returned by the - google.longrunning.Operation.metadata field. + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec + description: Specification of the model. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + version: description: >- - Operation last update time. If the operation is done, this is also - the finish time. + The model version used to generate the summary. Supported values + are: * `stable`: string. Default value when no value is specified. + Uses a generally available, fine-tuned model. For more information, + see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * `preview`: string. (Public preview) Uses a preview model. For more + information, see [Answer generation model versions and + lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec description: >- - Metadata related to the progress of the EngineService.DeleteEngine - operation. This will be returned by the - google.longrunning.Operation.metadata field. + A specification for configuring the extractive content in a search + response. type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + maxExtractiveAnswerCount: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata - description: Metadata for DeleteSchema LRO. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + The maximum number of extractive answers returned in each search + result. An extractive answer is a verbatim answer extracted from the + original document, which provides a precise and contextually + relevant answer to the search query. If the number of matching + answers is less than the `max_extractive_answer_count`, return all + of the answers. Otherwise, return the `max_extractive_answer_count`. + At most five answers are returned for each SearchResult. + type: integer + format: int32 + maxExtractiveSegmentCount: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata: - id: GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.DeleteTargetSite operation. This will be - returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + The max number of extractive segments returned in each search + result. Only applied if the DataStore is set to + DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types + is SOLUTION_TYPE_CHAT. An extractive segment is a text segment + extracted from the original document that is relevant to the search + query, and, in general, more verbose than an extractive answer. The + segment could then be used as input for LLMs to generate summaries + and answers. If the number of matching segments is less than + `max_extractive_segment_count`, return all of the segments. + Otherwise, return the `max_extractive_segment_count`. + type: integer + format: int32 + returnExtractiveSegmentScore: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata - description: >- - Metadata related to the progress of the - SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will - be returned by the google.longrunning.Operation.metadata field. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + Specifies whether to return the confidence score from the extractive + segments in each search result. This feature is available only for + new or allowlisted data stores. To allowlist your data store, + contact your Customer Engineer. The default value is `false`. + type: boolean + numPreviousSegments: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse - description: >- - Response message for SiteSearchEngineService.DisableAdvancedSiteSearch - method. - type: object - properties: {} - GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata: - id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata + Specifies whether to also include the adjacent from each selected + segments. Return at most `num_previous_segments` segments before + each selected segments. + type: integer + format: int32 + numNextSegments: + description: >- + Return at most `num_next_segments` segments after each selected + segments. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec description: >- - Metadata related to the progress of the - SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be - returned by the google.longrunning.Operation.metadata field. + Specifies the chunk spec to be returned from the search response. Only + available if the SearchRequest.ContentSearchSpec.search_result_mode is + set to CHUNKS type: object properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: + numPreviousChunks: description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime - GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse: - id: GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse + The number of previous chunks to be returned of the current chunk. + The maximum allowed value is 3. If not specified, no previous chunks + will be returned. + type: integer + format: int32 + numNextChunks: + description: >- + The number of next chunks to be returned of the current chunk. The + maximum allowed value is 3. If not specified, no next chunks will be + returned. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec description: >- - Response message for SiteSearchEngineService.EnableAdvancedSiteSearch - method. + The specification that uses customized query embedding vector to do + semantic document retrieval. type: object - properties: {} - GoogleCloudDiscoveryengineV1betaEngine: - id: GoogleCloudDiscoveryengineV1betaEngine - description: >- - Metadata that describes the training and serving parameters of an - Engine. + properties: + embeddingVectors: + description: The embedding vector used for retrieval. Limit to 1. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector + GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector + description: Embedding vector. type: object properties: - chatEngineConfig: - description: >- - Configurations for the Chat Engine. Only applicable if solution_type - is SOLUTION_TYPE_CHAT. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig - searchEngineConfig: - description: >- - Configurations for the Search Engine. Only applicable if - solution_type is SOLUTION_TYPE_SEARCH. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig - chatEngineMetadata: - description: >- - Output only. Additional information of the Chat Engine. Only - applicable if solution_type is SOLUTION_TYPE_CHAT. - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata - name: - description: >- - Immutable. The fully qualified resource name of the engine. This - field must be a UTF-8 encoded string with a length limit of 1024 - characters. Format: - `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` - engine should be 1-63 characters, and valid characters are - /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. - type: string - displayName: - description: >- - Required. The display name of the engine. Should be human readable. - UTF-8 encoded string with limit of 1024 characters. - type: string - createTime: - description: Output only. Timestamp the Recommendation Engine was created at. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. Timestamp the Recommendation Engine was last updated. - readOnly: true - type: string - format: google-datetime - dataStoreIds: - description: >- - The data stores associated with this engine. For - SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of - engines, they can only associate with at most one data store. If - solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same - Collection can be associated here. Note that when used in - CreateEngineRequest, one DataStore id must be provided as the system - will use it for necessary initializations. + fieldPath: + description: Embedding field path in schema. + type: string + vector: + description: Query embedding vector. type: array items: - type: string - solutionType: - description: Required. The solutions of the engine. + type: number + format: float + GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec: + id: >- + GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec + description: >- + Specification to enable natural language understanding capabilities for + search requests. + type: object + properties: + filterExtractionCondition: + description: >- + The condition under which filter extraction should occur. Default to + Condition.DISABLED. type: string enumDescriptions: - - Default value. - - Used for Recommendations AI. - - Used for Discovery Search. - - Used for use cases related to the Generative AI agent. - - >- - Used for use cases related to the Generative Chat agent. It's used - for Generative chat engine only, the associated data stores must - enrolled with `SOLUTION_TYPE_CHAT` solution. + - Server behavior defaults to Condition.DISABLED. + - Disables NL filter extraction. + - Enables NL filter extraction. enum: - - SOLUTION_TYPE_UNSPECIFIED - - SOLUTION_TYPE_RECOMMENDATION - - SOLUTION_TYPE_SEARCH - - SOLUTION_TYPE_CHAT - - SOLUTION_TYPE_GENERATIVE_CHAT - industryVertical: + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + geoSearchQueryDetectionFieldNames: + description: >- + Field names used for location-based filtering, where geolocation + filters are detected in natural language search queries. Only valid + when the FilterExtractionCondition is set to `ENABLED`. If this + field is set, it overrides the field names set in + ServingConfig.geo_search_query_detection_field_names. + type: array + items: + type: string + GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec + description: Specification for search as you type in search requests. + type: object + properties: + condition: description: >- - The industry vertical that the engine registers. The restriction of - the Engine industry vertical is based on DataStore: If unspecified, - default to `GENERIC`. Vertical on Engine has to match vertical of - the DataStore linked to the engine. + The condition under which search as you type should occur. Default + to Condition.DISABLED. type: string enumDescriptions: - - Value used when unset. - - >- - The generic vertical for documents that are not specific to any - industry vertical. - - The media industry vertical. - - The healthcare FHIR vertical. + - Server behavior defaults to Condition.DISABLED. + - Disables Search As You Type. + - Enables Search As You Type. enum: - - INDUSTRY_VERTICAL_UNSPECIFIED - - GENERIC - - MEDIA - - HEALTHCARE_FHIR - commonConfig: - description: Common config spec that specifies the metadata of the engine. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineCommonConfig - GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig: - id: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig - description: Configurations for a Chat Engine. + - CONDITION_UNSPECIFIED + - DISABLED + - ENABLED + GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec: + id: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec + description: >- + Session specification. Multi-turn Search feature is currently at private + GA stage. Please use v1alpha or v1beta version instead before we launch + this feature to public GA. Or ask for allowlisting through Google + Support team. type: object properties: - agentCreationConfig: - description: >- - The configurationt generate the Dialogflow agent that is associated - to this Engine. Note that these configurations are one-time consumed - by and passed to Dialogflow service. It means they cannot be - retrieved using EngineService.GetEngine or EngineService.ListEngines - API after engine creation. - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig - dialogflowAgentToLink: + queryId: description: >- - The resource name of an exist Dialogflow agent to link to this Chat - Engine. Customers can either provide `agent_creation_config` to - create agent or provide an agent name that links the agent with the - Chat engine. Format: `projects//locations//agents/`. Note that the - `dialogflow_agent_to_link` are one-time consumed by and passed to - Dialogflow service. It means they cannot be retrieved using - EngineService.GetEngine or EngineService.ListEngines API after - engine creation. Use ChatEngineMetadata.dialogflow_agent for actual - agent association after Engine is created. - type: string - GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig: - id: >- - GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig - description: >- - Configurations for generating a Dialogflow agent. Note that these - configurations are one-time consumed by and passed to Dialogflow - service. It means they cannot be retrieved using EngineService.GetEngine - or EngineService.ListEngines API after engine creation. + If set, the search result gets stored to the "turn" specified by + this query ID. Example: Let's say the session looks like this: + session { name: ".../sessions/xxx" turns { query { text: "What is + foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { + query { text: "How about bar then?" query_id: ".../questions/zzz" } + } } The user can call /search API with a request like this: session: + ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } + Then, the API stores the search result, associated with the last + turn. The stored search result can be used by a subsequent /answer + API call (with the session ID and the query ID specified). Also, it + is possible to call /search and /answer in parallel with the same + session ID & query ID. + type: string + searchResultPersistenceCount: + description: >- + The number of top search results to persist. The persisted search + results can be used for the subsequent /answer api call. This field + is simliar to the `summary_result_count` field in + SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At + most 10 results for documents mode, or 50 for chunks mode. + type: integer + format: int32 + GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec: + id: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec + description: Describes the specification of the query set. type: object properties: - business: + sampleQuerySet: description: >- - Name of the company, organization or other entity that the agent - represents. Used for knowledge connector LLM prompt and for - knowledge search. + Required. The full resource name of the SampleQuerySet used for the + evaluation, in the format of + `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. type: string - defaultLanguageCode: + GoogleCloudDiscoveryengineV1betaQualityMetrics: + id: GoogleCloudDiscoveryengineV1betaQualityMetrics + description: Describes the metrics produced by the evaluation. + type: object + properties: + docRecall: description: >- - Required. The default language of the agent as a language tag. See - [Language - Support](https://cloud.google.com/dialogflow/docs/reference/language) - for a list of the currently supported language codes. - type: string - timeZone: + Recall per document, at various top-k cutoff levels. Recall is the + fraction of relevant documents retrieved out of all relevant + documents. Example (top-5): * For a single SampleQuery, If 3 out of + 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = + 0.6 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + docPrecision: description: >- - Required. The time zone of the agent from the [time zone - database](https://www.iana.org/time-zones), e.g., America/New_York, - Europe/Paris. - type: string - location: + Precision per document, at various top-k cutoff levels. Precision is + the fraction of retrieved documents that are relevant. Example + (top-5): * For a single SampleQuery, If 4 out of 5 retrieved + documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + docNdcg: + description: >- + Normalized discounted cumulative gain (NDCG) per document, at + various top-k cutoff levels. NDCG measures the ranking quality, + giving higher relevance to top results. Example (top-3): Suppose + SampleQuery with three retrieved documents (D1, D2, D3) and binary + relevance judgements (1 for relevant, 0 for not relevant): + Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] + Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + pageRecall: description: >- - Agent location for Agent creation, supported values: global/us/eu. - If not provided, us Engine will create Agent using us-central-1 by - default; eu Engine will create Agent using eu-west-1 by default. - type: string - GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig: - id: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig - description: Configurations for a Search Engine. + Recall per page, at various top-k cutoff levels. Recall is the + fraction of relevant pages retrieved out of all relevant pages. + Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant + pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + pageNdcg: + description: >- + Normalized discounted cumulative gain (NDCG) per page, at various + top-k cutoff levels. NDCG measures the ranking quality, giving + higher relevance to top results. Example (top-3): Suppose + SampleQuery with three retrieved pages (P1, P2, P3) and binary + relevance judgements (1 for relevant, 0 for not relevant): + Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] + Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics: + id: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics + description: Stores the metric values at specific top-k levels. type: object properties: - searchTier: - description: >- - The search feature tier of this engine. Different tiers might have - different pricing. To learn more, check the pricing documentation. - Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. - type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Standard tier. - - Enterprise tier. - enum: - - SEARCH_TIER_UNSPECIFIED - - SEARCH_TIER_STANDARD - - SEARCH_TIER_ENTERPRISE - searchAddOns: - description: The add-on that this search engine enables. - type: array - items: - type: string - enumDescriptions: - - >- - Default value when the enum is unspecified. This is invalid to - use. - - Large language model add-on. - enum: - - SEARCH_ADD_ON_UNSPECIFIED - - SEARCH_ADD_ON_LLM - GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata: - id: GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata + top1: + description: The top-1 value. + type: number + format: double + top3: + description: The top-3 value. + type: number + format: double + top5: + description: The top-5 value. + type: number + format: double + top10: + description: The top-10 value. + type: number + format: double + GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata: + id: GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata description: >- - Additional information of a Chat Engine. Fields in this message are - output only. + Metadata related to the progress of the ImportCompletionSuggestions + operation. This will be returned by the + google.longrunning.Operation.metadata field. type: object properties: - dialogflowAgent: + createTime: + description: Operation create time. + type: string + format: google-datetime + updateTime: description: >- - The resource name of a Dialogflow agent, that this Chat Engine - refers to. Format: `projects//locations//agents/`. + Operation last update time. If the operation is done, this is also + the finish time. type: string - GoogleCloudDiscoveryengineV1betaEngineCommonConfig: - id: GoogleCloudDiscoveryengineV1betaEngineCommonConfig - description: Common configurations for an Engine. + format: google-datetime + successCount: + description: Count of CompletionSuggestions successfully imported. + type: string + format: int64 + failureCount: + description: Count of CompletionSuggestions that failed to be imported. + type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse: + id: GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse + description: >- + Response of the CompletionService.ImportCompletionSuggestions method. If + the long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is + successful. type: object properties: - companyName: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig + GoogleCloudDiscoveryengineV1betaImportErrorConfig: + id: GoogleCloudDiscoveryengineV1betaImportErrorConfig + description: Configuration of destination for Import related errors. + type: object + properties: + gcsPrefix: description: >- - The name of the company, business or entity that is associated with - the engine. Setting this may help improve LLM related features. + Cloud Storage prefix for import errors. This must be an empty, + existing Cloud Storage directory. Import errors are written to + sharded files in this directory, one per line, as a JSON-encoded + `google.rpc.Status` message. type: string GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata: id: GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata @@ -8944,18 +13257,54 @@ components: set. $ref: >- #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig - GoogleCloudDiscoveryengineV1betaImportErrorConfig: - id: GoogleCloudDiscoveryengineV1betaImportErrorConfig - description: Configuration of destination for Import related errors. + GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata: + id: GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata + description: >- + Metadata related to the progress of the ImportSampleQueries operation. + This will be returned by the google.longrunning.Operation.metadata + field. type: object properties: - gcsPrefix: + createTime: + description: ImportSampleQueries operation create time. + type: string + format: google-datetime + updateTime: description: >- - Cloud Storage prefix for import errors. This must be an empty, - existing Cloud Storage directory. Import errors are written to - sharded files in this directory, one per line, as a JSON-encoded - `google.rpc.Status` message. + ImportSampleQueries operation last update time. If the operation is + done, this is also the finish time. + type: string + format: google-datetime + successCount: + description: Count of SampleQuerys successfully imported. + type: string + format: int64 + failureCount: + description: Count of SampleQuerys that failed to be imported. + type: string + format: int64 + totalCount: + description: Total count of SampleQuerys that were processed. type: string + format: int64 + GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse: + id: GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse + description: >- + Response of the SampleQueryService.ImportSampleQueries method. If the + long running operation is done, this message is returned by the + google.longrunning.Operations.response field if the operation is + successful. + type: object + properties: + errorSamples: + description: A sample of errors encountered while processing the request. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + errorConfig: + description: The desired location of errors incurred during the Import. + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1betaImportErrorConfig GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata: id: GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata description: >- @@ -9068,8 +13417,8 @@ components: name: description: >- Required. The fully qualified resource name of the model. Format: - `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` - model must be an alpha-numerical string with limit of 40 characters. + `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. + Model must be an alpha-numerical string with limit of 40 characters. type: string displayName: description: The display name of the model. @@ -9090,6 +13439,10 @@ components: - The model has successfully completed training. - The model is ready for serving. - The model training failed. + - >- + The model training finished successfully but metrics did not + improve. + - Input data validation failed. Model training didn't start. enum: - MODEL_STATE_UNSPECIFIED - TRAINING_PAUSED @@ -9097,14 +13450,23 @@ components: - TRAINING_COMPLETE - READY_FOR_SERVING - TRAINING_FAILED + - NO_IMPROVEMENT + - INPUT_VALIDATION_FAILED createTime: description: Timestamp the Model was created at. + deprecated: true type: string format: google-datetime trainingStartTime: description: Timestamp the model training was initiated. type: string format: google-datetime + metrics: + description: The metrics of the trained model. + type: object + additionalProperties: + type: number + format: double GoogleCloudDiscoveryengineV1betaProject: id: GoogleCloudDiscoveryengineV1betaProject description: Metadata and configurations for a Google Cloud project in the service. @@ -9113,9 +13475,9 @@ components: name: description: >- Output only. Full resource name of the project, for example - `projects/{project_number}`. Note that when making requests, project - number and project id are both acceptable, but the server will - always respond in project number. + `projects/{project}`. Note that when making requests, project number + and project id are both acceptable, but the server will always + respond in project number. readOnly: true type: string createTime: @@ -9335,7 +13697,7 @@ components: description: >- Required. The resource name of the engine that this tune applies to. Format: - `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` + `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` type: string GoogleCloudDiscoveryengineV1betaTuneEngineResponse: id: GoogleCloudDiscoveryengineV1betaTuneEngineResponse @@ -9471,22 +13833,20 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] operations: id: google.discoveryengine.operations name: operations title: Operations methods: - _projects_operations_list: - operation: &ref_1 + projects_operations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_operations_list: - operation: *ref_1 - response: *ref_2 projects_operations_get: operation: $ref: >- @@ -9501,17 +13861,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_connector_operations_list: - operation: &ref_3 + projects_locations_collections_data_connector_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataConnector~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_data_connector_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_collections_data_connector_operations_get: operation: $ref: >- @@ -9519,17 +13876,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_operations_list: - operation: &ref_5 + projects_locations_collections_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1operations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_operations_list: - operation: *ref_5 - response: *ref_6 projects_locations_collections_operations_get: operation: $ref: >- @@ -9537,71 +13891,59 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_branches_operations_list: - operation: &ref_7 + projects_locations_collections_data_stores_models_operations_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_data_stores_branches_operations_list: - operation: *ref_7 - response: *ref_8 - projects_locations_collections_data_stores_branches_operations_get: + projects_locations_collections_data_stores_models_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_collections_data_stores_branches_operations_cancel: + projects_locations_collections_data_stores_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_models_operations_list: - operation: &ref_9 + objectKey: $.operations + projects_locations_collections_data_stores_branches_operations_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations/get - response: &ref_10 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_data_stores_models_operations_list: - operation: *ref_9 - response: *ref_10 - projects_locations_collections_data_stores_models_operations_get: + projects_locations_collections_data_stores_branches_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_operations_list: - operation: &ref_11 + projects_locations_collections_data_stores_branches_operations_cancel: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1operations/get - response: &ref_12 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}:cancel/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - projects_locations_collections_data_stores_operations_list: - operation: *ref_11 - response: *ref_12 - _projects_locations_collections_data_stores_schemas_operations_list: - operation: &ref_13 + projects_locations_collections_data_stores_schemas_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1schemas~1{schemasId}~1operations/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_data_stores_schemas_operations_list: - operation: *ref_13 - response: *ref_14 projects_locations_collections_data_stores_schemas_operations_get: operation: $ref: >- @@ -9609,17 +13951,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_engines_operations_list: - operation: &ref_15 + projects_locations_collections_engines_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1operations/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_engines_operations_list: - operation: *ref_15 - response: *ref_16 projects_locations_collections_engines_operations_get: operation: $ref: >- @@ -9627,60 +13966,44 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_operations_list: - operation: &ref_17 + projects_locations_identity_mapping_stores_operations_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_18 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identity_mapping_stores~1{identity_mapping_storesId}~1operations/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_17 - response: *ref_18 - projects_locations_operations_get: + projects_locations_identity_mapping_stores_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1identity_mapping_stores~1{identity_mapping_storesId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_branches_operations_list: - operation: &ref_19 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations/get - response: &ref_20 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_data_stores_branches_operations_list: - operation: *ref_19 - response: *ref_20 - projects_locations_data_stores_branches_operations_get: + projects_locations_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_branches_operations_cancel: + objectKey: $.operations + projects_locations_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_models_operations_list: - operation: &ref_21 + projects_locations_data_stores_models_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1models~1{modelsId}~1operations/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_data_stores_models_operations_list: - operation: *ref_21 - response: *ref_22 projects_locations_data_stores_models_operations_get: operation: $ref: >- @@ -9688,17 +14011,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_operations_list: - operation: &ref_23 + projects_locations_data_stores_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1operations/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_data_stores_operations_list: - operation: *ref_23 - response: *ref_24 projects_locations_data_stores_operations_get: operation: $ref: >- @@ -9706,26 +14026,48 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_data_stores_branches_operations_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_data_stores_branches_operations_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_branches_operations_cancel: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_branches_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_models_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_schemas_operations_get + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_branches_operations_get - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_branches_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_schemas_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_models_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_branches_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_stores_schemas_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_engines_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_models_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_connector_operations_get - $ref: >- @@ -9735,15 +14077,19 @@ components: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_engines_operations_list - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_list + #/components/x-stackQL-resources/operations/methods/projects_locations_identity_mapping_stores_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_models_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_data_stores_branches_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_data_connector_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_collections_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_identity_mapping_stores_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - $ref: >- @@ -9756,6 +14102,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] + replace: [] delete: [] data_stores: id: google.discoveryengine.data_stores @@ -9776,17 +14123,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_list: - operation: &ref_25 + projects_locations_collections_data_stores_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataStores - projects_locations_collections_data_stores_list: - operation: *ref_25 - response: *ref_26 projects_locations_collections_data_stores_get: operation: $ref: >- @@ -9808,6 +14152,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_collections_data_stores_train_custom_model: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}:trainCustomModel/post + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_data_stores_complete_query: operation: $ref: >- @@ -9822,17 +14173,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_list: - operation: &ref_27 + projects_locations_data_stores_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dataStores - projects_locations_data_stores_list: - operation: *ref_27 - response: *ref_28 projects_locations_data_stores_get: operation: $ref: >- @@ -9874,6 +14222,7 @@ components: #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_patch - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_data_stores_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/data_stores/methods/projects_locations_collections_data_stores_delete @@ -9901,148 +14250,13 @@ components: sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/data_stores_site_search_engine/methods/projects_locations_collections_data_stores_get_site_search_engine - - $ref: >- - #/components/x-stackQL-resources/data_stores_site_search_engine/methods/projects_locations_data_stores_get_site_search_engine - insert: [] - update: [] - delete: [] - documents: - id: google.discoveryengine.documents - name: documents - title: Documents - methods: - projects_locations_collections_data_stores_branches_documents_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_branches_documents_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_branches_documents_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_collections_data_stores_branches_documents_list: - operation: &ref_29 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/get - response: &ref_30 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.documents - projects_locations_collections_data_stores_branches_documents_list: - operation: *ref_29 - response: *ref_30 - projects_locations_collections_data_stores_branches_documents_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_branches_documents_import: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:import/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_data_stores_branches_documents_purge: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:purge/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_branches_documents_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_branches_documents_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_branches_documents_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_data_stores_branches_documents_list: - operation: &ref_31 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/get - response: &ref_32 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.documents - projects_locations_data_stores_branches_documents_list: - operation: *ref_31 - response: *ref_32 - projects_locations_data_stores_branches_documents_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_branches_documents_import: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:import/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_branches_documents_purge: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:purge/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_get - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_list - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_get - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_list - insert: - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_create - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_create - update: - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_patch - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_delete + #/components/x-stackQL-resources/data_stores_site_search_engine/methods/projects_locations_collections_data_stores_get_site_search_engine - $ref: >- - #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_delete + #/components/x-stackQL-resources/data_stores_site_search_engine/methods/projects_locations_data_stores_get_site_search_engine + insert: [] + update: [] + replace: [] + delete: [] data_store_operations: id: google.discoveryengine.data_store_operations name: data_store_operations @@ -10061,6 +14275,7 @@ components: #/components/x-stackQL-resources/data_store_operations/methods/projects_locations_collections_data_stores_operations_get insert: [] update: [] + replace: [] delete: [] suggestion_deny_list_entries: id: google.discoveryengine.suggestion_deny_list_entries @@ -10099,6 +14314,46 @@ components: select: [] insert: [] update: [] + replace: [] + delete: [] + completion_suggestions: + id: google.discoveryengine.completion_suggestions + name: completion_suggestions + title: Completion_suggestions + methods: + projects_locations_collections_data_stores_completion_suggestions_import: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1completionSuggestions:import/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_completion_suggestions_purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1completionSuggestions:purge/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_completion_suggestions_import: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1completionSuggestions:import/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_completion_suggestions_purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1completionSuggestions:purge/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] delete: [] controls: id: google.discoveryengine.controls @@ -10112,17 +14367,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_controls_list: - operation: &ref_33 + projects_locations_collections_data_stores_controls_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1controls/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.controls - projects_locations_collections_data_stores_controls_list: - operation: *ref_33 - response: *ref_34 projects_locations_collections_data_stores_controls_delete: operation: $ref: >- @@ -10151,17 +14403,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_engines_controls_list: - operation: &ref_35 + projects_locations_collections_engines_controls_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1controls/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.controls - projects_locations_collections_engines_controls_list: - operation: *ref_35 - response: *ref_36 projects_locations_collections_engines_controls_delete: operation: $ref: >- @@ -10190,17 +14439,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_controls_list: - operation: &ref_37 + projects_locations_data_stores_controls_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1controls/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.controls - projects_locations_data_stores_controls_list: - operation: *ref_37 - response: *ref_38 projects_locations_data_stores_controls_delete: operation: $ref: >- @@ -10250,6 +14496,7 @@ components: #/components/x-stackQL-resources/controls/methods/projects_locations_collections_engines_controls_patch - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_data_stores_controls_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_collections_data_stores_controls_delete @@ -10329,6 +14576,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] conversations: id: google.discoveryengine.conversations @@ -10349,17 +14597,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_conversations_list: - operation: &ref_39 + projects_locations_collections_data_stores_conversations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1conversations/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.conversations - projects_locations_collections_data_stores_conversations_list: - operation: *ref_39 - response: *ref_40 projects_locations_collections_data_stores_conversations_delete: operation: $ref: >- @@ -10395,17 +14640,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_engines_conversations_list: - operation: &ref_41 + projects_locations_collections_engines_conversations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1conversations/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.conversations - projects_locations_collections_engines_conversations_list: - operation: *ref_41 - response: *ref_42 projects_locations_collections_engines_conversations_delete: operation: $ref: >- @@ -10441,17 +14683,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_conversations_list: - operation: &ref_43 + projects_locations_data_stores_conversations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1conversations/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.conversations - projects_locations_data_stores_conversations_list: - operation: *ref_43 - response: *ref_44 projects_locations_data_stores_conversations_delete: operation: $ref: >- @@ -10501,6 +14740,7 @@ components: #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_engines_conversations_patch - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_data_stores_conversations_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/conversations/methods/projects_locations_collections_data_stores_conversations_delete @@ -10520,17 +14760,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_sessions_list: - operation: &ref_45 + projects_locations_collections_data_stores_sessions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions/get - response: &ref_46 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sessions - projects_locations_collections_data_stores_sessions_list: - operation: *ref_45 - response: *ref_46 projects_locations_collections_data_stores_sessions_delete: operation: $ref: >- @@ -10545,163 +14782,319 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_collections_data_stores_sessions_get: + projects_locations_collections_data_stores_sessions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + projects_locations_collections_engines_sessions_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + projects_locations_data_stores_sessions_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_list + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_list + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_get + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_create + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_create + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_create + update: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_patch + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_patch + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_delete + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_delete + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_delete + answers: + id: google.discoveryengine.answers + name: answers + title: Answers + methods: + projects_locations_collections_data_stores_sessions_answers_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_engines_sessions_answers_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}~1answers~1{answersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_sessions_answers_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/answers/methods/projects_locations_collections_data_stores_sessions_answers_get + - $ref: >- + #/components/x-stackQL-resources/answers/methods/projects_locations_collections_engines_sessions_answers_get + - $ref: >- + #/components/x-stackQL-resources/answers/methods/projects_locations_data_stores_sessions_answers_get + insert: [] + update: [] + replace: [] + delete: [] + branches_documents_metadata: + id: google.discoveryengine.branches_documents_metadata + name: branches_documents_metadata + title: Branches_documents_metadata + methods: + projects_locations_collections_data_stores_branches_batch_get_documents_metadata: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1batchGetDocumentsMetadata/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_data_stores_branches_batch_get_documents_metadata: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1batchGetDocumentsMetadata/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/branches_documents_metadata/methods/projects_locations_collections_data_stores_branches_batch_get_documents_metadata + - $ref: >- + #/components/x-stackQL-resources/branches_documents_metadata/methods/projects_locations_data_stores_branches_batch_get_documents_metadata + insert: [] + update: [] + replace: [] + delete: [] + documents: + id: google.discoveryengine.documents + name: documents + title: Documents + methods: + projects_locations_collections_data_stores_branches_documents_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_branches_documents_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_branches_documents_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_collections_data_stores_branches_documents_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_collections_engines_sessions_create: + objectKey: $.documents + projects_locations_collections_data_stores_branches_documents_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_engines_sessions_list: - operation: &ref_47 + projects_locations_collections_data_stores_branches_documents_import: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions/get - response: &ref_48 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:import/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions - projects_locations_collections_engines_sessions_list: - operation: *ref_47 - response: *ref_48 - projects_locations_collections_engines_sessions_delete: + projects_locations_collections_data_stores_branches_documents_purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:purge/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_collections_engines_sessions_patch: + projects_locations_data_stores_branches_documents_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_collections_engines_sessions_get: + projects_locations_data_stores_branches_documents_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_sessions_create: + projects_locations_data_stores_branches_documents_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents~1{documentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_sessions_list: - operation: &ref_49 + projects_locations_data_stores_branches_documents_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions/get - response: &ref_50 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sessions - projects_locations_data_stores_sessions_list: - operation: *ref_49 - response: *ref_50 - projects_locations_data_stores_sessions_delete: + objectKey: $.documents + projects_locations_data_stores_branches_documents_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_sessions_patch: + projects_locations_data_stores_branches_documents_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:import/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_data_stores_sessions_get: + projects_locations_data_stores_branches_documents_purge: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1branches~1{branchesId}~1documents:purge/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_get - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_get - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_list + #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_get - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_list + #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_list - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_get + #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_get - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_list + #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_list insert: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_create - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_create + #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_create - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_create + #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_create update: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_patch - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_patch + #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_patch - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_patch + #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_data_stores_sessions_delete - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_collections_engines_sessions_delete - - $ref: >- - #/components/x-stackQL-resources/sessions/methods/projects_locations_data_stores_sessions_delete - answers: - id: google.discoveryengine.answers - name: answers - title: Answers - methods: - projects_locations_collections_data_stores_sessions_answers_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_collections_engines_sessions_answers_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines~1{enginesId}~1sessions~1{sessionsId}~1answers~1{answersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_data_stores_sessions_answers_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1sessions~1{sessionsId}~1answers~1{answersId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/answers/methods/projects_locations_collections_data_stores_sessions_answers_get - - $ref: >- - #/components/x-stackQL-resources/answers/methods/projects_locations_collections_engines_sessions_answers_get + #/components/x-stackQL-resources/documents/methods/projects_locations_collections_data_stores_branches_documents_delete - $ref: >- - #/components/x-stackQL-resources/answers/methods/projects_locations_data_stores_sessions_answers_get - insert: [] - update: [] - delete: [] + #/components/x-stackQL-resources/documents/methods/projects_locations_data_stores_branches_documents_delete schemas: id: google.discoveryengine.schemas name: schemas @@ -10728,17 +15121,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_schemas_list: - operation: &ref_51 + projects_locations_collections_data_stores_schemas_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1schemas/get - response: &ref_52 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.schemas - projects_locations_collections_data_stores_schemas_list: - operation: *ref_51 - response: *ref_52 projects_locations_collections_data_stores_schemas_create: operation: $ref: >- @@ -10767,17 +15157,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_schemas_list: - operation: &ref_53 + projects_locations_data_stores_schemas_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1schemas/get - response: &ref_54 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.schemas - projects_locations_data_stores_schemas_list: - operation: *ref_53 - response: *ref_54 projects_locations_data_stores_schemas_create: operation: $ref: >- @@ -10805,11 +15192,32 @@ components: #/components/x-stackQL-resources/schemas/methods/projects_locations_collections_data_stores_schemas_patch - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_locations_data_stores_schemas_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_locations_collections_data_stores_schemas_delete - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_locations_data_stores_schemas_delete + custom_models: + id: google.discoveryengine.custom_models + name: custom_models + title: Custom_models + methods: + projects_locations_collections_data_stores_custom_models_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1customModels/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_models/methods/projects_locations_collections_data_stores_custom_models_list + insert: [] + update: [] + replace: [] + delete: [] site_search_engine: id: google.discoveryengine.site_search_engine name: site_search_engine @@ -10868,6 +15276,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] site_search_engine_domain_verification_status: id: google.discoveryengine.site_search_engine_domain_verification_status @@ -10882,26 +15291,26 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/site_search_engine_domain_verification_status/methods/projects_locations_collections_data_stores_site_search_engine_fetch_domain_verification_status insert: [] update: [] + replace: [] delete: [] search_engine_operations: id: google.discoveryengine.search_engine_operations name: search_engine_operations title: Search_engine_operations methods: - _projects_locations_collections_data_stores_site_search_engine_operations_list: - operation: &ref_55 + projects_locations_collections_data_stores_site_search_engine_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1operations/get - response: &ref_56 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_data_stores_site_search_engine_operations_list: - operation: *ref_55 - response: *ref_56 projects_locations_collections_data_stores_site_search_engine_operations_get: operation: $ref: >- @@ -10917,6 +15326,7 @@ components: #/components/x-stackQL-resources/search_engine_operations/methods/projects_locations_collections_data_stores_site_search_engine_operations_list insert: [] update: [] + replace: [] delete: [] target_sites: id: google.discoveryengine.target_sites @@ -10930,17 +15340,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_data_stores_site_search_engine_target_sites_list: - operation: &ref_57 + projects_locations_collections_data_stores_site_search_engine_target_sites_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1targetSites/get - response: &ref_58 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.targetSites - projects_locations_collections_data_stores_site_search_engine_target_sites_list: - operation: *ref_57 - response: *ref_58 projects_locations_collections_data_stores_site_search_engine_target_sites_batch_create: operation: $ref: >- @@ -10976,17 +15383,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_data_stores_site_search_engine_target_sites_list: - operation: &ref_59 + projects_locations_data_stores_site_search_engine_target_sites_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1targetSites/get - response: &ref_60 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.targetSites - projects_locations_data_stores_site_search_engine_target_sites_list: - operation: *ref_59 - response: *ref_60 projects_locations_data_stores_site_search_engine_target_sites_batch_create: operation: $ref: >- @@ -11028,13 +15432,18 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_create + - $ref: >- + #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_batch_create - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_create + - $ref: >- + #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_batch_create update: - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_patch - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_data_stores_site_search_engine_target_sites_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/target_sites/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_delete @@ -11045,17 +15454,14 @@ components: name: target_site_operations title: Target_site_operations methods: - _projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list: - operation: &ref_61 + projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1siteSearchEngine~1targetSites~1operations/get - response: &ref_62 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list: - operation: *ref_61 - response: *ref_62 projects_locations_collections_data_stores_site_search_engine_target_sites_operations_get: operation: $ref: >- @@ -11071,6 +15477,7 @@ components: #/components/x-stackQL-resources/target_site_operations/methods/projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list insert: [] update: [] + replace: [] delete: [] user_events: id: google.discoveryengine.user_events @@ -11091,6 +15498,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_collections_data_stores_user_events_purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1dataStores~1{dataStoresId}~1userEvents:purge/post + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_collections_data_stores_user_events_import: operation: $ref: >- @@ -11112,6 +15526,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_data_stores_user_events_purge: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1dataStores~1{dataStoresId}~1userEvents:purge/post + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_data_stores_user_events_import: operation: $ref: >- @@ -11126,10 +15547,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_user_events_collect: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1userEvents:collect/get + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: [] insert: [] update: [] + replace: [] delete: [] engines: id: google.discoveryengine.engines @@ -11143,17 +15572,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_collections_engines_list: - operation: &ref_63 + projects_locations_collections_engines_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collections~1{collectionsId}~1engines/get - response: &ref_64 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.engines - projects_locations_collections_engines_list: - operation: *ref_63 - response: *ref_64 projects_locations_collections_engines_delete: operation: $ref: >- @@ -11187,6 +15613,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/engines/methods/projects_locations_collections_engines_delete @@ -11206,6 +15633,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] ranking_configs: id: google.discoveryengine.ranking_configs @@ -11223,10 +15651,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}:provision: - parameters: &ref_65 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -11270,7 +15699,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -11308,7 +15737,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -11339,7 +15768,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}:cancel: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -11381,7 +15810,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -11430,7 +15859,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -11472,7 +15901,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -11520,7 +15949,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -11561,7 +15990,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery: - parameters: *ref_65 + parameters: *ref_1 get: description: Completes the specified user input with keyword suggestions. operationId: discoveryengine.projects.locations.collections.dataStores.completeQuery @@ -11616,7 +16045,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Creates a DataStore. DataStore is for storing Documents. To serve these @@ -11664,6 +16093,10 @@ paths: name: createAdvancedSiteSearch schema: type: boolean + - in: query + name: skipDefaultSchemaCreation + schema: + type: boolean get: description: Lists all the DataStores associated with the project. operationId: discoveryengine.projects.locations.collections.dataStores.list @@ -11710,7 +16143,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a DataStore. operationId: discoveryengine.projects.locations.collections.dataStores.get @@ -11829,8 +16262,53 @@ paths: schema: type: string format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel: + parameters: *ref_1 + post: + description: Trains a custom model. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.trainCustomModel + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1TrainCustomModelRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets the SiteSearchEngine. operationId: >- @@ -11869,14 +16347,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.operations.list + discoveryengine.projects.locations.collections.dataStores.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11911,7 +16389,7 @@ paths: schema: type: string - in: path - name: branchesId + name: modelsId required: true schema: type: string @@ -11928,15 +16406,15 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.operations.get + discoveryengine.projects.locations.collections.dataStores.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11971,7 +16449,7 @@ paths: schema: type: string - in: path - name: branchesId + name: modelsId required: true schema: type: string @@ -11980,26 +16458,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: - parameters: *ref_65 - post: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12011,7 +16477,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -12033,22 +16499,27 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a Document. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.collections.dataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12060,7 +16531,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -12083,24 +16554,22 @@ paths: schema: type: string - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: documentsId + name: operationsId required: true schema: type: string - patch: - description: Updates a Document. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: + parameters: *ref_1 + post: + description: Imports all SuggestionDenyListEntry for a DataStore. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.patch + discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12112,7 +16581,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -12134,29 +16603,63 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: + parameters: *ref_1 + post: + description: Permanently deletes all SuggestionDenyListEntry for a DataStore. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: branchesId + name: projectsId required: true schema: type: string - in: path - name: documentsId + name: locationsId required: true schema: type: string - - in: query - name: allowMissing + - in: path + name: collectionsId + required: true schema: - type: boolean - - in: query - name: updateMask + type: string + - in: path + name: dataStoresId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a Document. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:import: + parameters: *ref_1 + post: + description: Imports CompletionSuggestions for a DataStore. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.delete + discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12168,7 +16671,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -12190,22 +16693,18 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: path - name: documentsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: - parameters: *ref_65 - get: - description: Gets a list of Documents. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionSuggestions:purge: + parameters: *ref_1 + post: + description: Permanently deletes all CompletionSuggestions for a DataStore. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.list + discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12217,8 +16716,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -12240,29 +16738,20 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls: + parameters: *ref_1 post: - description: Creates a Document. + description: >- + Creates a Control. By default 1000 controls are allowed for a data + store. A request can be submitted to adjust this limit. If the Control + to create already exists, an ALREADY_EXISTS error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.create + discoveryengine.projects.locations.collections.dataStores.controls.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12274,7 +16763,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -12296,30 +16785,13 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - in: query - name: documentId + name: controlId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: - parameters: *ref_65 - post: - description: >- - Bulk import of multiple Documents. Request processing may be - synchronous. Non-existing items are created. Note: It is possible for a - subset of the Documents to be successfully updated. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.import - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest + get: + description: Lists all Controls by their parent DataStore. + operationId: discoveryengine.projects.locations.collections.dataStores.controls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12331,7 +16803,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse parameters: - in: path name: projectsId @@ -12353,30 +16826,27 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: - parameters: *ref_65 - post: + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}: + parameters: *ref_1 + delete: description: >- - Permanently deletes all selected Documents in a branch. This process is - asynchronous. Depending on the number of Documents to be deleted, this - operation can take hours to complete. Before the delete operation - completes, some Documents might still be returned by - DocumentService.GetDocument or DocumentService.ListDocuments. To get a - list of the Documents to be deleted, set PurgeDocumentsRequest.force to - false. + Deletes a Control. If the Control to delete does not exist, a NOT_FOUND + error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataStores.branches.documents.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest + discoveryengine.projects.locations.collections.dataStores.controls.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12388,7 +16858,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12411,18 +16881,20 @@ paths: schema: type: string - in: path - name: branchesId + name: controlsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: - parameters: *ref_65 - get: + patch: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.models.operations.list + Updates a Control. Control action type cannot be changed. If the Control + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.collections.dataStores.controls.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12434,7 +16906,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -12457,32 +16929,18 @@ paths: schema: type: string - in: path - name: modelsId + name: controlsId required: true schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: - parameters: *ref_65 + format: google-fieldmask get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.models.operations.get + description: Gets a Control. + operationId: discoveryengine.projects.locations.collections.dataStores.controls.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12494,7 +16952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -12517,23 +16975,21 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId + name: controlsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations: - parameters: *ref_65 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: + parameters: *ref_1 + post: + description: Performs a search. operationId: >- - discoveryengine.projects.locations.collections.dataStores.operations.list + discoveryengine.projects.locations.collections.dataStores.servingConfigs.search + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12545,7 +17001,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse parameters: - in: path name: projectsId @@ -12567,27 +17024,23 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: servingConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/operations/{operationsId}: - parameters: *ref_65 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.collections.dataStores.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: + parameters: *ref_1 + post: + description: Answer query method. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12599,7 +17052,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse parameters: - in: path name: projectsId @@ -12622,22 +17076,22 @@ paths: schema: type: string - in: path - name: operationsId + name: servingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: + parameters: *ref_1 post: - description: Imports all SuggestionDenyListEntry for a DataStore. + description: Makes a recommendation, which requires a contextual user event. operationId: >- - discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import + discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12649,7 +17103,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse parameters: - in: path name: projectsId @@ -12671,18 +17126,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: - parameters: *ref_65 + - in: path + name: servingConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: + parameters: *ref_1 post: - description: Permanently deletes all SuggestionDenyListEntry for a DataStore. + description: Converses a conversation. operationId: >- - discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge + discoveryengine.projects.locations.collections.dataStores.conversations.converse requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12694,7 +17154,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse parameters: - in: path name: projectsId @@ -12716,20 +17177,24 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls: - parameters: *ref_65 + - in: path + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations: + parameters: *ref_1 post: description: >- - Creates a Control. By default 1000 controls are allowed for a data - store. A request can be submitted to adjust this limit. If the Control - to create already exists, an ALREADY_EXISTS error is returned. + Creates a Conversation. If the Conversation to create already exists, an + ALREADY_EXISTS error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataStores.controls.create + discoveryengine.projects.locations.collections.dataStores.conversations.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12741,7 +17206,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -12763,13 +17228,10 @@ paths: required: true schema: type: string - - in: query - name: controlId - schema: - type: string get: - description: Lists all Controls by their parent DataStore. - operationId: discoveryengine.projects.locations.collections.dataStores.controls.list + description: Lists all Conversations by their parent DataStore. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12782,7 +17244,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse parameters: - in: path name: projectsId @@ -12817,14 +17279,18 @@ paths: name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/controls/{controlsId}: - parameters: *ref_65 + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: + parameters: *ref_1 delete: description: >- - Deletes a Control. If the Control to delete does not exist, a NOT_FOUND - error is returned. + Deletes a Conversation. If the Conversation to delete does not exist, a + NOT_FOUND error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataStores.controls.delete + discoveryengine.projects.locations.collections.dataStores.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12859,20 +17325,22 @@ paths: schema: type: string - in: path - name: controlsId + name: conversationsId required: true schema: type: string patch: description: >- - Updates a Control. Control action type cannot be changed. If the Control - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.collections.dataStores.controls.patch + Updates a Conversation. Conversation action type cannot be changed. If + the Conversation to update does not exist, a NOT_FOUND error is + returned. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12884,7 +17352,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -12907,7 +17375,7 @@ paths: schema: type: string - in: path - name: controlsId + name: conversationsId required: true schema: type: string @@ -12917,8 +17385,9 @@ paths: type: string format: google-fieldmask get: - description: Gets a Control. - operationId: discoveryengine.projects.locations.collections.dataStores.controls.get + description: Gets a Conversation. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12930,7 +17399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -12953,21 +17422,118 @@ paths: schema: type: string - in: path - name: controlsId + name: conversationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions: + parameters: *ref_1 + post: + description: >- + Creates a Session. If the Session to create already exists, an + ALREADY_EXISTS error is returned. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.sessions.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + get: + description: Lists all Sessions by their parent DataStore. + operationId: discoveryengine.projects.locations.collections.dataStores.sessions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: - parameters: *ref_65 - post: - description: Performs a search. + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Session. If the Session to delete does not exist, a NOT_FOUND + error is returned. operationId: >- - discoveryengine.projects.locations.collections.dataStores.servingConfigs.search - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + discoveryengine.projects.locations.collections.dataStores.sessions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12979,8 +17545,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13003,22 +17568,20 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: - parameters: *ref_65 - post: - description: Answer query method. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer + patch: + description: >- + Updates a Session. Session action type cannot be changed. If the Session + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.collections.dataStores.sessions.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13030,8 +17593,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -13054,22 +17616,18 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: - parameters: *ref_65 - post: - description: Makes a recommendation, which requires a contextual user event. - operationId: >- - discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a Session. + operationId: discoveryengine.projects.locations.collections.dataStores.sessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13081,8 +17639,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -13105,22 +17662,16 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: - parameters: *ref_65 - post: - description: Converses a conversation. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: + parameters: *ref_1 + get: + description: Gets a Answer. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.converse - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest + discoveryengine.projects.locations.collections.dataStores.sessions.answers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13132,8 +17683,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' parameters: - in: path name: projectsId @@ -13156,23 +17706,23 @@ paths: schema: type: string - in: path - name: conversationsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations: - parameters: *ref_65 - post: + - in: path + name: answersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata: + parameters: *ref_1 + get: description: >- - Creates a Conversation. If the Conversation to create already exists, an - ALREADY_EXISTS error is returned. + Gets index freshness metadata for Documents. Supported for website + search only. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13184,7 +17734,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse parameters: - in: path name: projectsId @@ -13206,10 +17757,27 @@ paths: required: true schema: type: string + - in: path + name: branchesId + required: true + schema: + type: string + - in: query + name: matcher.urisMatcher.uris + schema: + type: string + - in: query + name: matcher.fhirMatcher.fhirResources + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: + parameters: *ref_1 get: - description: Lists all Conversations by their parent DataStore. + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.list + discoveryengine.projects.locations.collections.dataStores.branches.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13221,8 +17789,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -13244,13 +17811,9 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: branchesId + required: true schema: type: string - in: query @@ -13258,17 +17821,23 @@ paths: schema: type: string - in: query - name: orderBy + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: - parameters: *ref_65 - delete: + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a Conversation. If the Conversation to delete does not exist, a - NOT_FOUND error is returned. + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.delete + discoveryengine.projects.locations.collections.dataStores.branches.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13280,7 +17849,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -13303,22 +17872,35 @@ paths: schema: type: string - in: path - name: conversationsId + name: branchesId required: true schema: type: string - patch: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Updates a Conversation. Conversation action type cannot be changed. If - the Conversation to update does not exist, a NOT_FOUND error is - returned. + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.patch + discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13330,7 +17912,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13353,19 +17935,21 @@ paths: schema: type: string - in: path - name: conversationsId + name: branchesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: + parameters: *ref_1 get: - description: Gets a Conversation. + description: Gets a Document. operationId: >- - discoveryengine.projects.locations.collections.dataStores.conversations.get + discoveryengine.projects.locations.collections.dataStores.branches.documents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13377,7 +17961,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -13400,23 +17984,24 @@ paths: schema: type: string - in: path - name: conversationsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions: - parameters: *ref_65 - post: - description: >- - Creates a Session. If the Session to create already exists, an - ALREADY_EXISTS error is returned. + - in: path + name: documentsId + required: true + schema: + type: string + patch: + description: Updates a Document. operationId: >- - discoveryengine.projects.locations.collections.dataStores.sessions.create + discoveryengine.projects.locations.collections.dataStores.branches.documents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13428,7 +18013,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -13450,9 +18035,29 @@ paths: required: true schema: type: string - get: - description: Lists all Sessions by their parent DataStore. - operationId: discoveryengine.projects.locations.collections.dataStores.sessions.list + - in: path + name: branchesId + required: true + schema: + type: string + - in: path + name: documentsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Document. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.branches.documents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13464,8 +18069,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13487,31 +18091,22 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: branchesId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: documentsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}: - parameters: *ref_65 - delete: - description: >- - Deletes a Session. If the Session to delete does not exist, a NOT_FOUND - error is returned. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: + parameters: *ref_1 + get: + description: Gets a list of Documents. operationId: >- - discoveryengine.projects.locations.collections.dataStores.sessions.delete + discoveryengine.projects.locations.collections.dataStores.branches.documents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13523,7 +18118,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse parameters: - in: path name: projectsId @@ -13546,20 +18142,28 @@ paths: schema: type: string - in: path - name: sessionsId + name: branchesId required: true schema: type: string - patch: - description: >- - Updates a Session. Session action type cannot be changed. If the Session - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.collections.dataStores.sessions.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a Document. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.branches.documents.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13571,7 +18175,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -13594,18 +18198,29 @@ paths: schema: type: string - in: path - name: sessionsId + name: branchesId required: true schema: type: string - in: query - name: updateMask + name: documentId schema: type: string - format: google-fieldmask - get: - description: Gets a Session. - operationId: discoveryengine.projects.locations.collections.dataStores.sessions.get + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: + parameters: *ref_1 + post: + description: >- + Bulk import of multiple Documents. Request processing may be + synchronous. Non-existing items are created. Note: It is possible for a + subset of the Documents to be successfully updated. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.branches.documents.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13617,7 +18232,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -13640,16 +18255,29 @@ paths: schema: type: string - in: path - name: sessionsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: - parameters: *ref_65 - get: - description: Gets a Answer. + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: + parameters: *ref_1 + post: + description: >- + Permanently deletes all selected Documents in a branch. This process is + asynchronous. Depending on the number of Documents to be deleted, this + operation can take hours to complete. Before the delete operation + completes, some Documents might still be returned by + DocumentService.GetDocument or DocumentService.ListDocuments. To get a + list of the Documents to be deleted, set PurgeDocumentsRequest.force to + false. operationId: >- - discoveryengine.projects.locations.collections.dataStores.sessions.answers.get + discoveryengine.projects.locations.collections.dataStores.branches.documents.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13661,7 +18289,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -13684,17 +18312,12 @@ paths: schema: type: string - in: path - name: sessionsId - required: true - schema: - type: string - - in: path - name: answersId + name: branchesId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a Schema. operationId: discoveryengine.projects.locations.collections.dataStores.schemas.get @@ -13828,7 +18451,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a list of Schemas. operationId: discoveryengine.projects.locations.collections.dataStores.schemas.list @@ -13921,7 +18544,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -13980,7 +18603,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/schemas/{schemasId}/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -14031,8 +18654,48 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels: + parameters: *ref_1 + get: + description: Gets a list of all the custom models. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.customModels.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListCustomModelsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch: - parameters: *ref_65 + parameters: *ref_1 post: description: Upgrade from basic site search to advanced site search. operationId: >- @@ -14077,7 +18740,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch: - parameters: *ref_65 + parameters: *ref_1 post: description: Downgrade from advanced site search to basic site search. operationId: >- @@ -14122,7 +18785,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris: - parameters: *ref_65 + parameters: *ref_1 post: description: Request on-demand recrawl for a list of URIs. operationId: >- @@ -14167,7 +18830,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:batchVerifyTargetSites: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Verify target sites' ownership and validity. This API sends all the @@ -14214,7 +18877,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:fetchDomainVerificationStatus: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Returns list of target sites with its domain verification status. This @@ -14266,7 +18929,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -14320,7 +18983,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -14367,7 +19030,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites: - parameters: *ref_65 + parameters: *ref_1 post: description: Creates a TargetSite. operationId: >- @@ -14458,7 +19121,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate: - parameters: *ref_65 + parameters: *ref_1 post: description: Creates TargetSite in a batch. operationId: >- @@ -14503,7 +19166,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a TargetSite. operationId: >- @@ -14636,7 +19299,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -14690,7 +19353,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -14737,7 +19400,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write: - parameters: *ref_65 + parameters: *ref_1 post: description: Writes a single user event. operationId: >- @@ -14785,7 +19448,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Writes a single user event from the browser. This uses a GET request to @@ -14840,8 +19503,57 @@ paths: schema: type: string format: int64 + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge: + parameters: *ref_1 + post: + description: >- + Deletes permanently all user events specified by the filter provided. + Depending on the number of events specified by the filter, this + operation could take hours or days to complete. To test a filter, use + the list command first. + operationId: >- + discoveryengine.projects.locations.collections.dataStores.userEvents.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Bulk import of user events. Request processing might be synchronous. @@ -14891,7 +19603,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines: - parameters: *ref_65 + parameters: *ref_1 post: description: Creates a Engine. operationId: discoveryengine.projects.locations.collections.engines.create @@ -14978,7 +19690,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}: - parameters: *ref_65 + parameters: *ref_1 delete: description: Deletes a Engine. operationId: discoveryengine.projects.locations.collections.engines.delete @@ -15098,7 +19810,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -15151,7 +19863,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -15197,7 +19909,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Creates a Control. By default 1000 controls are allowed for a data @@ -15297,7 +20009,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/controls/{controlsId}: - parameters: *ref_65 + parameters: *ref_1 delete: description: >- Deletes a Control. If the Control to delete does not exist, a NOT_FOUND @@ -15436,7 +20148,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search: - parameters: *ref_65 + parameters: *ref_1 post: description: Performs a search. operationId: >- @@ -15486,7 +20198,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer: - parameters: *ref_65 + parameters: *ref_1 post: description: Answer query method. operationId: >- @@ -15537,7 +20249,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend: - parameters: *ref_65 + parameters: *ref_1 post: description: Makes a recommendation, which requires a contextual user event. operationId: >- @@ -15588,7 +20300,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}:converse: - parameters: *ref_65 + parameters: *ref_1 post: description: Converses a conversation. operationId: >- @@ -15639,7 +20351,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Creates a Conversation. If the Conversation to create already exists, an @@ -15740,7 +20452,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/conversations/{conversationsId}: - parameters: *ref_65 + parameters: *ref_1 delete: description: >- Deletes a Conversation. If the Conversation to delete does not exist, a @@ -15882,7 +20594,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Creates a Session. If the Session to create already exists, an @@ -15981,7 +20693,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}: - parameters: *ref_65 + parameters: *ref_1 delete: description: >- Deletes a Session. If the Session to delete does not exist, a NOT_FOUND @@ -16115,16 +20827,117 @@ paths: schema: type: string - in: path - name: sessionsId + name: sessionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}: + parameters: *ref_1 + get: + description: Gets a Answer. + operationId: >- + discoveryengine.projects.locations.collections.engines.sessions.answers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: collectionsId + required: true + schema: + type: string + - in: path + name: enginesId + required: true + schema: + type: string + - in: path + name: sessionsId + required: true + schema: + type: string + - in: path + name: answersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations: + parameters: *ref_1 + get: + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: >- + discoveryengine.projects.locations.identity_mapping_stores.operations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: identity_mapping_storesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}: - parameters: *ref_65 + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a Answer. + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. operationId: >- - discoveryengine.projects.locations.collections.engines.sessions.answers.get + discoveryengine.projects.locations.identity_mapping_stores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16136,7 +20949,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -16149,27 +20962,17 @@ paths: schema: type: string - in: path - name: collectionsId - required: true - schema: - type: string - - in: path - name: enginesId - required: true - schema: - type: string - - in: path - name: sessionsId + name: identity_mapping_storesId required: true schema: type: string - in: path - name: answersId + name: operationsId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -16212,7 +21015,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -16248,7 +21051,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery: - parameters: *ref_65 + parameters: *ref_1 get: description: Completes the specified user input with keyword suggestions. operationId: discoveryengine.projects.locations.dataStores.completeQuery @@ -16298,7 +21101,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/dataStores: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Creates a DataStore. DataStore is for storing Documents. To serve these @@ -16341,6 +21144,10 @@ paths: name: createAdvancedSiteSearch schema: type: boolean + - in: query + name: skipDefaultSchemaCreation + schema: + type: boolean get: description: Lists all the DataStores associated with the project. operationId: discoveryengine.projects.locations.dataStores.list @@ -16382,7 +21189,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a DataStore. operationId: discoveryengine.projects.locations.dataStores.get @@ -16487,7 +21294,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets the SiteSearchEngine. operationId: discoveryengine.projects.locations.dataStores.getSiteSearchEngine @@ -16520,13 +21327,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.dataStores.branches.operations.list + operationId: discoveryengine.projects.locations.dataStores.models.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16556,7 +21363,7 @@ paths: schema: type: string - in: path - name: branchesId + name: modelsId required: true schema: type: string @@ -16573,14 +21380,14 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: discoveryengine.projects.locations.dataStores.branches.operations.get + operationId: discoveryengine.projects.locations.dataStores.models.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16610,7 +21417,7 @@ paths: schema: type: string - in: path - name: branchesId + name: modelsId required: true schema: type: string @@ -16619,25 +21426,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: - parameters: *ref_65 - post: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: discoveryengine.projects.locations.dataStores.branches.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.dataStores.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16649,7 +21444,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -16666,21 +21461,27 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true + - in: query + name: filter schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.dataStores.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16692,7 +21493,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -16710,23 +21511,62 @@ paths: schema: type: string - in: path - name: branchesId + name: operationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: + parameters: *ref_1 + post: + description: Imports all SuggestionDenyListEntry for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: documentsId + name: projectsId required: true schema: type: string - patch: - description: Updates a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.patch + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: + parameters: *ref_1 + post: + description: Permanently deletes all SuggestionDenyListEntry for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16738,7 +21578,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -16755,28 +21595,58 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:import: + parameters: *ref_1 + post: + description: Imports CompletionSuggestions for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.completionSuggestions.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: - in: path - name: branchesId + name: projectsId required: true schema: type: string - in: path - name: documentsId + name: locationsId required: true schema: type: string - - in: query - name: allowMissing - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: dataStoresId + required: true schema: type: string - format: google-fieldmask - delete: - description: Deletes a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.delete + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionSuggestions:purge: + parameters: *ref_1 + post: + description: Permanently deletes all CompletionSuggestions for a DataStore. + operationId: >- + discoveryengine.projects.locations.dataStores.completionSuggestions.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16788,7 +21658,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -16805,21 +21675,54 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls: + parameters: *ref_1 + post: + description: >- + Creates a Control. By default 1000 controls are allowed for a data + store. A request can be submitted to adjust this limit. If the Control + to create already exists, an ALREADY_EXISTS error is returned. + operationId: discoveryengine.projects.locations.dataStores.controls.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + parameters: - in: path - name: branchesId + name: projectsId required: true schema: type: string - in: path - name: documentsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: - parameters: *ref_65 + - in: path + name: dataStoresId + required: true + schema: + type: string + - in: query + name: controlId + schema: + type: string get: - description: Gets a list of Documents. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.list + description: Lists all Controls by their parent DataStore. + operationId: discoveryengine.projects.locations.dataStores.controls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16832,7 +21735,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse + #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse parameters: - in: path name: projectsId @@ -16849,11 +21752,6 @@ paths: required: true schema: type: string - - in: path - name: branchesId - required: true - schema: - type: string - in: query name: pageSize schema: @@ -16863,14 +21761,17 @@ paths: name: pageToken schema: type: string - post: - description: Creates a Document. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Control. If the Control to delete does not exist, a NOT_FOUND + error is returned. + operationId: discoveryengine.projects.locations.dataStores.controls.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16882,7 +21783,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -16900,28 +21801,20 @@ paths: schema: type: string - in: path - name: branchesId + name: controlsId required: true schema: type: string - - in: query - name: documentId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: - parameters: *ref_65 - post: + patch: description: >- - Bulk import of multiple Documents. Request processing may be - synchronous. Non-existing items are created. Note: It is possible for a - subset of the Documents to be successfully updated. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.import + Updates a Control. Control action type cannot be changed. If the Control + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.dataStores.controls.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16933,7 +21826,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -16951,28 +21844,18 @@ paths: schema: type: string - in: path - name: branchesId + name: controlsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: - parameters: *ref_65 - post: - description: >- - Permanently deletes all selected Documents in a branch. This process is - asynchronous. Depending on the number of Documents to be deleted, this - operation can take hours to complete. Before the delete operation - completes, some Documents might still be returned by - DocumentService.GetDocument or DocumentService.ListDocuments. To get a - list of the Documents to be deleted, set PurgeDocumentsRequest.force to - false. - operationId: discoveryengine.projects.locations.dataStores.branches.documents.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a Control. + operationId: discoveryengine.projects.locations.dataStores.controls.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -16984,7 +21867,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' parameters: - in: path name: projectsId @@ -17002,17 +21885,20 @@ paths: schema: type: string - in: path - name: branchesId + name: controlsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations: - parameters: *ref_65 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.dataStores.models.operations.list + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: + parameters: *ref_1 + post: + description: Performs a search. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.search + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17024,7 +21910,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse parameters: - in: path name: projectsId @@ -17042,31 +21929,21 @@ paths: schema: type: string - in: path - name: modelsId + name: servingConfigsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}: - parameters: *ref_65 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.dataStores.models.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: + parameters: *ref_1 + post: + description: Answer query method. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.answer + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17078,7 +21955,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse parameters: - in: path name: projectsId @@ -17096,22 +21974,21 @@ paths: schema: type: string - in: path - name: modelsId - required: true - schema: - type: string - - in: path - name: operationsId + name: servingConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations: - parameters: *ref_65 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: discoveryengine.projects.locations.dataStores.operations.list + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: + parameters: *ref_1 + post: + description: Makes a recommendation, which requires a contextual user event. + operationId: discoveryengine.projects.locations.dataStores.servingConfigs.recommend + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17123,7 +22000,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse parameters: - in: path name: projectsId @@ -17140,27 +22018,22 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: servingConfigsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}: - parameters: *ref_65 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: discoveryengine.projects.locations.dataStores.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: + parameters: *ref_1 + post: + description: Converses a conversation. + operationId: discoveryengine.projects.locations.dataStores.conversations.converse + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17172,7 +22045,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse parameters: - in: path name: projectsId @@ -17190,22 +22064,22 @@ paths: schema: type: string - in: path - name: operationsId + name: conversationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:import: - parameters: *ref_65 + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations: + parameters: *ref_1 post: - description: Imports all SuggestionDenyListEntry for a DataStore. - operationId: >- - discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import + description: >- + Creates a Conversation. If the Conversation to create already exists, an + ALREADY_EXISTS error is returned. + operationId: discoveryengine.projects.locations.dataStores.conversations.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17217,7 +22091,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -17234,18 +22108,9 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/suggestionDenyListEntries:purge: - parameters: *ref_65 - post: - description: Permanently deletes all SuggestionDenyListEntry for a DataStore. - operationId: >- - discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesRequest + get: + description: Lists all Conversations by their parent DataStore. + operationId: discoveryengine.projects.locations.dataStores.conversations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17257,7 +22122,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse parameters: - in: path name: projectsId @@ -17274,19 +22140,30 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls: - parameters: *ref_65 - post: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: + parameters: *ref_1 + delete: description: >- - Creates a Control. By default 1000 controls are allowed for a data - store. A request can be submitted to adjust this limit. If the Control - to create already exists, an ALREADY_EXISTS error is returned. - operationId: discoveryengine.projects.locations.dataStores.controls.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + Deletes a Conversation. If the Conversation to delete does not exist, a + NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.dataStores.conversations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17298,7 +22175,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17315,13 +22192,22 @@ paths: required: true schema: type: string - - in: query - name: controlId + - in: path + name: conversationsId + required: true schema: type: string - get: - description: Lists all Controls by their parent DataStore. - operationId: discoveryengine.projects.locations.dataStores.controls.list + patch: + description: >- + Updates a Conversation. Conversation action type cannot be changed. If + the Conversation to update does not exist, a NOT_FOUND error is + returned. + operationId: discoveryengine.projects.locations.dataStores.conversations.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17333,8 +22219,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListControlsResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -17351,26 +22236,19 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: conversationsId + required: true schema: type: string - in: query - name: filter + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/controls/{controlsId}: - parameters: *ref_65 - delete: - description: >- - Deletes a Control. If the Control to delete does not exist, a NOT_FOUND - error is returned. - operationId: discoveryengine.projects.locations.dataStores.controls.delete + format: google-fieldmask + get: + description: Gets a Conversation. + operationId: discoveryengine.projects.locations.dataStores.conversations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17382,7 +22260,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' parameters: - in: path name: projectsId @@ -17400,20 +22278,22 @@ paths: schema: type: string - in: path - name: controlsId + name: conversationsId required: true schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions: + parameters: *ref_1 + post: description: >- - Updates a Control. Control action type cannot be changed. If the Control - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.dataStores.controls.patch + Creates a Session. If the Session to create already exists, an + ALREADY_EXISTS error is returned. + operationId: discoveryengine.projects.locations.dataStores.sessions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17425,7 +22305,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -17442,19 +22322,9 @@ paths: required: true schema: type: string - - in: path - name: controlsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask get: - description: Gets a Control. - operationId: discoveryengine.projects.locations.dataStores.controls.get + description: Lists all Sessions by their parent DataStore. + operationId: discoveryengine.projects.locations.dataStores.sessions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17466,7 +22336,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Control' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse parameters: - in: path name: projectsId @@ -17483,21 +22354,30 @@ paths: required: true schema: type: string - - in: path - name: controlsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:search: - parameters: *ref_65 - post: - description: Performs a search. - operationId: discoveryengine.projects.locations.dataStores.servingConfigs.search - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1SearchRequest' + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a Session. If the Session to delete does not exist, a NOT_FOUND + error is returned. + operationId: discoveryengine.projects.locations.dataStores.sessions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17509,8 +22389,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1SearchResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17528,21 +22407,20 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer: - parameters: *ref_65 - post: - description: Answer query method. - operationId: discoveryengine.projects.locations.dataStores.servingConfigs.answer + patch: + description: >- + Updates a Session. Session action type cannot be changed. If the Session + to update does not exist, a NOT_FOUND error is returned. + operationId: discoveryengine.projects.locations.dataStores.sessions.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryRequest + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17554,8 +22432,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1AnswerQueryResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -17573,21 +22450,18 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend: - parameters: *ref_65 - post: - description: Makes a recommendation, which requires a contextual user event. - operationId: discoveryengine.projects.locations.dataStores.servingConfigs.recommend - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendRequest + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: Gets a Session. + operationId: discoveryengine.projects.locations.dataStores.sessions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17599,8 +22473,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1RecommendResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' parameters: - in: path name: projectsId @@ -17618,21 +22491,15 @@ paths: schema: type: string - in: path - name: servingConfigsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}:converse: - parameters: *ref_65 - post: - description: Converses a conversation. - operationId: discoveryengine.projects.locations.dataStores.conversations.converse - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationRequest + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: + parameters: *ref_1 + get: + description: Gets a Answer. + operationId: discoveryengine.projects.locations.dataStores.sessions.answers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17644,8 +22511,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ConverseConversationResponse + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' parameters: - in: path name: projectsId @@ -17663,22 +22529,23 @@ paths: schema: type: string - in: path - name: conversationsId + name: sessionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations: - parameters: *ref_65 - post: + - in: path + name: answersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata: + parameters: *ref_1 + get: description: >- - Creates a Conversation. If the Conversation to create already exists, an - ALREADY_EXISTS error is returned. - operationId: discoveryengine.projects.locations.dataStores.conversations.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + Gets index freshness metadata for Documents. Supported for website + search only. + operationId: >- + discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17690,7 +22557,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse parameters: - in: path name: projectsId @@ -17707,9 +22575,26 @@ paths: required: true schema: type: string + - in: path + name: branchesId + required: true + schema: + type: string + - in: query + name: matcher.urisMatcher.uris + schema: + type: string + - in: query + name: matcher.fhirMatcher.fhirResources + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations: + parameters: *ref_1 get: - description: Lists all Conversations by their parent DataStore. - operationId: discoveryengine.projects.locations.dataStores.conversations.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: discoveryengine.projects.locations.dataStores.branches.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17721,8 +22606,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListConversationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -17739,13 +22623,9 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: branchesId + required: true schema: type: string - in: query @@ -17753,16 +22633,22 @@ paths: schema: type: string - in: query - name: orderBy + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/conversations/{conversationsId}: - parameters: *ref_65 - delete: + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Deletes a Conversation. If the Conversation to delete does not exist, a - NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.dataStores.conversations.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: discoveryengine.projects.locations.dataStores.branches.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17774,7 +22660,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -17792,21 +22678,34 @@ paths: schema: type: string - in: path - name: conversationsId + name: branchesId required: true schema: type: string - patch: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: description: >- - Updates a Conversation. Conversation action type cannot be changed. If - the Conversation to update does not exist, a NOT_FOUND error is - returned. - operationId: discoveryengine.projects.locations.dataStores.conversations.patch + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: discoveryengine.projects.locations.dataStores.branches.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleLongrunningCancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17818,7 +22717,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17836,18 +22735,20 @@ paths: schema: type: string - in: path - name: conversationsId + name: branchesId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: operationsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}: + parameters: *ref_1 get: - description: Gets a Conversation. - operationId: discoveryengine.projects.locations.dataStores.conversations.get + description: Gets a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17859,7 +22760,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Conversation' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -17877,22 +22778,23 @@ paths: schema: type: string - in: path - name: conversationsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions: - parameters: *ref_65 - post: - description: >- - Creates a Session. If the Session to create already exists, an - ALREADY_EXISTS error is returned. - operationId: discoveryengine.projects.locations.dataStores.sessions.create + - in: path + name: documentsId + required: true + schema: + type: string + patch: + description: Updates a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17904,7 +22806,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -17921,9 +22823,28 @@ paths: required: true schema: type: string - get: - description: Lists all Sessions by their parent DataStore. - operationId: discoveryengine.projects.locations.dataStores.sessions.list + - in: path + name: branchesId + required: true + schema: + type: string + - in: path + name: documentsId + required: true + schema: + type: string + - in: query + name: allowMissing + schema: + type: boolean + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17935,8 +22856,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDiscoveryengineV1ListSessionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -17953,30 +22873,21 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: branchesId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: documentsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}: - parameters: *ref_65 - delete: - description: >- - Deletes a Session. If the Session to delete does not exist, a NOT_FOUND - error is returned. - operationId: discoveryengine.projects.locations.dataStores.sessions.delete + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents: + parameters: *ref_1 + get: + description: Gets a list of Documents. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -17988,7 +22899,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ListDocumentsResponse parameters: - in: path name: projectsId @@ -18006,20 +22918,27 @@ paths: schema: type: string - in: path - name: sessionsId + name: branchesId required: true schema: type: string - patch: - description: >- - Updates a Session. Session action type cannot be changed. If the Session - to update does not exist, a NOT_FOUND error is returned. - operationId: discoveryengine.projects.locations.dataStores.sessions.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a Document. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18031,7 +22950,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Document' parameters: - in: path name: projectsId @@ -18049,18 +22968,28 @@ paths: schema: type: string - in: path - name: sessionsId + name: branchesId required: true schema: type: string - in: query - name: updateMask + name: documentId schema: type: string - format: google-fieldmask - get: - description: Gets a Session. - operationId: discoveryengine.projects.locations.dataStores.sessions.get + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import: + parameters: *ref_1 + post: + description: >- + Bulk import of multiple Documents. Request processing may be + synchronous. Non-existing items are created. Note: It is possible for a + subset of the Documents to be successfully updated. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.import + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1ImportDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18072,7 +23001,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Session' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18090,15 +23019,28 @@ paths: schema: type: string - in: path - name: sessionsId + name: branchesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}: - parameters: *ref_65 - get: - description: Gets a Answer. - operationId: discoveryengine.projects.locations.dataStores.sessions.answers.get + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge: + parameters: *ref_1 + post: + description: >- + Permanently deletes all selected Documents in a branch. This process is + asynchronous. Depending on the number of Documents to be deleted, this + operation can take hours to complete. Before the delete operation + completes, some Documents might still be returned by + DocumentService.GetDocument or DocumentService.ListDocuments. To get a + list of the Documents to be deleted, set PurgeDocumentsRequest.force to + false. + operationId: discoveryengine.projects.locations.dataStores.branches.documents.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeDocumentsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -18110,7 +23052,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1Answer' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -18128,17 +23070,12 @@ paths: schema: type: string - in: path - name: sessionsId - required: true - schema: - type: string - - in: path - name: answersId + name: branchesId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas/{schemasId}: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a Schema. operationId: discoveryengine.projects.locations.dataStores.schemas.get @@ -18257,7 +23194,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/schemas: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a list of Schemas. operationId: discoveryengine.projects.locations.dataStores.schemas.list @@ -18340,7 +23277,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch: - parameters: *ref_65 + parameters: *ref_1 post: description: Upgrade from basic site search to advanced site search. operationId: >- @@ -18380,7 +23317,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch: - parameters: *ref_65 + parameters: *ref_1 post: description: Downgrade from advanced site search to basic site search. operationId: >- @@ -18420,7 +23357,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris: - parameters: *ref_65 + parameters: *ref_1 post: description: Request on-demand recrawl for a list of URIs. operationId: >- @@ -18460,7 +23397,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites: - parameters: *ref_65 + parameters: *ref_1 post: description: Creates a TargetSite. operationId: >- @@ -18541,7 +23478,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate: - parameters: *ref_65 + parameters: *ref_1 post: description: Creates TargetSite in a batch. operationId: >- @@ -18581,7 +23518,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites/{targetSitesId}: - parameters: *ref_65 + parameters: *ref_1 get: description: Gets a TargetSite. operationId: >- @@ -18699,7 +23636,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write: - parameters: *ref_65 + parameters: *ref_1 post: description: Writes a single user event. operationId: discoveryengine.projects.locations.dataStores.userEvents.write @@ -18741,7 +23678,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect: - parameters: *ref_65 + parameters: *ref_1 get: description: >- Writes a single user event from the browser. This uses a GET request to @@ -18790,8 +23727,51 @@ paths: schema: type: string format: int64 + /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge: + parameters: *ref_1 + post: + description: >- + Deletes permanently all user events specified by the filter provided. + Depending on the number of events specified by the filter, this + operation could take hours or days to complete. To test a filter, use + the list command first. + operationId: discoveryengine.projects.locations.dataStores.userEvents.purge + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dataStoresId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import: - parameters: *ref_65 + parameters: *ref_1 post: description: >- Bulk import of user events. Request processing might be synchronous. @@ -18835,7 +23815,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check: - parameters: *ref_65 + parameters: *ref_1 post: description: Performs a grounding check. operationId: discoveryengine.projects.locations.groundingConfigs.check @@ -18875,7 +23855,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank: - parameters: *ref_65 + parameters: *ref_1 post: description: Ranks a list of text records based on the given input query. operationId: discoveryengine.projects.locations.rankingConfigs.rank @@ -18913,7 +23893,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/userEvents:write: - parameters: *ref_65 + parameters: *ref_1 post: description: Writes a single user event. operationId: discoveryengine.projects.locations.userEvents.write @@ -18949,3 +23929,48 @@ paths: name: writeAsync schema: type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/userEvents:collect: + parameters: *ref_1 + get: + description: >- + Writes a single user event from the browser. This uses a GET request to + due to browser restriction of POST-ing to a third-party domain. This + method is used only by the Discovery Engine API JavaScript pixel and + Google Tag Manager. Users should not call this method directly. + operationId: discoveryengine.projects.locations.userEvents.collect + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiHttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: userEvent + schema: + type: string + - in: query + name: uri + schema: + type: string + - in: query + name: ets + schema: + type: string + format: int64 diff --git a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml index 7187b6ed..976b62f5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dlp.yaml @@ -10,8 +10,8 @@ info: to help you discover, classify, and protect your valuable data assets with ease. version: v2 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240901' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/sensitive-data-protection/docs/ servers: @@ -37,849 +37,763 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GooglePrivacyDlpV2StoredInfoTypeVersion: + GooglePrivacyDlpV2StoredInfoTypeStats: + properties: + largeCustomDictionary: + description: >- + StoredInfoType where findings are defined by a dictionary of + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' + description: Statistics for a StoredInfoType. + type: object + id: GooglePrivacyDlpV2StoredInfoTypeStats + GooglePrivacyDlpV2DataProfilePubSubMessage: + id: GooglePrivacyDlpV2DataProfilePubSubMessage + type: object + properties: + profile: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + description: >- + If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. + Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and + `full_resource` will be populated. + event: + description: The event that caused the Pub/Sub message to be sent. + type: string + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED + enumDescriptions: + - Unused. + - New profile (not a re-profile). + - >- + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. + fileStoreProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + description: >- + If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully + populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only + `name` and `file_store_path` will be populated. description: >- - Version of a StoredInfoType, including the configuration used to build - it, create timestamp, and current state. - id: GooglePrivacyDlpV2StoredInfoTypeVersion + Pub/Sub topic message for a DataProfileAction.PubSubNotification event. + To receive a message of protocol buffer schema type, convert the message + data to an object of this proto class. + GooglePrivacyDlpV2ListFileStoreDataProfilesResponse: type: object properties: - config: - description: StoredInfoType configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - state: + nextPageToken: + type: string + description: The next page token. + fileStoreDataProfiles: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + description: List of data profiles. + id: GooglePrivacyDlpV2ListFileStoreDataProfilesResponse + description: >- + List of file store data profiles generated for a given organization or + project. + GooglePrivacyDlpV2TransformationResultStatus: + properties: + resultStatusType: description: >- - Stored info type version state. Read-only, updated by the system - during dictionary creation. + Transformation result status type, this will be either SUCCESS, or + it will be the reason for why the transformation was not completely + successful. + type: string + enum: + - STATE_TYPE_UNSPECIFIED + - INVALID_TRANSFORM + - BIGQUERY_MAX_ROW_SIZE_EXCEEDED + - METADATA_UNRETRIEVABLE + - SUCCESS enumDescriptions: - - Unused - - StoredInfoType version is being created. - - StoredInfoType version is ready for use. + - Unused. - >- - StoredInfoType creation failed. All relevant error messages are - returned in the `StoredInfoTypeVersion` message. + This will be set when a finding could not be transformed (i.e. + outside user set bucket range). - >- - StoredInfoType is no longer valid because artifacts stored in - user-controlled storage were modified. To fix an invalid - StoredInfoType, use the `UpdateStoredInfoType` method to create a - new version. - enum: - - STORED_INFO_TYPE_STATE_UNSPECIFIED - - PENDING - - READY - - FAILED - - INVALID - type: string - errors: + This will be set when a BigQuery transformation was successful but + could not be stored back in BigQuery because the transformed row + exceeds BigQuery's max row size. + - >- + This will be set when there is a finding in the custom metadata of + a file, but at the write time of the transformed file, this key / + value pair is unretrievable. + - >- + This will be set when the transformation and storing of it is + successful. + details: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Detailed error codes and messages + id: GooglePrivacyDlpV2TransformationResultStatus + description: The outcome of a transformation. + type: object + GooglePrivacyDlpV2InspectDataSourceDetails: + properties: + result: + description: A summary of the outcome of this inspection job. + $ref: '#/components/schemas/GooglePrivacyDlpV2Result' + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' + id: GooglePrivacyDlpV2InspectDataSourceDetails + description: The results of an inspect DataSource job. + type: object + GooglePrivacyDlpV2TableOptions: + type: object + id: GooglePrivacyDlpV2TableOptions + description: Instructions regarding the table content being inspected. + properties: + identifyingFields: + type: array description: >- - Errors that occurred when creating this storedInfoType version, or - anomalies detected in the storedInfoType data that render it - unusable. Only the five most recent errors will be displayed, with - the most recent error appearing first. For example, some of the data - for stored custom dictionaries is put in the user's Cloud Storage - bucket, and if this data is modified or deleted by the user or - another system, the dictionary becomes invalid. If any errors occur, - fix the problem indicated by the error message and use the - UpdateStoredInfoType API method to create another version of the - storedInfoType to continue using it, reusing the same `config` if it - was not the source of the error. + The columns that are the primary keys for table objects included in + ContentItem. A copy of this cell's value will stored alongside + alongside each finding so that the finding can be traced to the + specific row it came from. No more than 3 may be provided. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - type: array - stats: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' - description: Statistics about this storedInfoType version. - createTime: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2InfoTypeTransformation: + type: object + properties: + infoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - Create timestamp of the version. Read-only, determined by the system - when the version is created. - type: string - format: google-datetime - GooglePrivacyDlpV2ProfileStatus: + InfoTypes to apply the transformation to. An empty list will cause + this transformation to apply to all findings that correspond to + infoTypes that were requested in `InspectConfig`. + type: array + primitiveTransformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + description: Required. Primitive transformation to apply to the infoType. + description: >- + A transformation to apply to text that is identified as a specific + info_type. + id: GooglePrivacyDlpV2InfoTypeTransformation + GooglePrivacyDlpV2InspectContentRequest: type: object - description: Success or errors for the profile generation. - id: GooglePrivacyDlpV2ProfileStatus properties: - status: + inspectTemplateName: + type: string description: >- - Profiling status code and optional message. The `status.code` value - is 0 (default value) for OK. - $ref: '#/components/schemas/GoogleRpcStatus' - timestamp: + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + inspectConfig: + description: >- + Configuration for the inspector. What specified here will override + the template referenced by the inspect_template_name argument. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + item: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + locationId: + description: Deprecated. This field has no effect. type: string - format: google-datetime - description: Time when the profile generation status was updated - GooglePrivacyDlpV2HybridFindingDetails: + id: GooglePrivacyDlpV2InspectContentRequest + description: Request to search for potentially sensitive info in a ContentItem. + GooglePrivacyDlpV2KMapEstimationHistogramBucket: type: object - id: GooglePrivacyDlpV2HybridFindingDetails properties: - rowOffset: + bucketValueCount: + format: int64 + type: string description: >- - Offset of the row for tables. Populate if the row(s) being scanned - are part of a bigger dataset and you want to keep track of their - absolute position. + Total number of distinct quasi-identifier tuple values in this + bucket. + minAnonymity: + type: string format: int64 + description: Always positive. + maxAnonymity: + description: Always greater than or equal to min_anonymity. type: string - tableOptions: + format: int64 + bucketValues: description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. If not known - ahead of time, can also be set within each inspect hybrid call and - the two will be merged. Note that identifying_fields will only be - stored to BigQuery, and only if the BigQuery action has been - included. - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' - fileOffset: + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' + type: array + bucketSize: type: string format: int64 + description: Number of records within these anonymity bounds. + description: >- + A KMapEstimationHistogramBucket message with the following values: + min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 + records whose quasi-identifier values correspond to 3, 4 or 5 people in + the overlying population. An important particular case is when + min_anonymity = max_anonymity = 1: the frequency field then corresponds + to the number of uniquely identifiable records. + id: GooglePrivacyDlpV2KMapEstimationHistogramBucket + GooglePrivacyDlpV2CryptoDeterministicConfig: + properties: + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' description: >- - Offset in bytes of the line, from the beginning of the file, where - the finding is located. Populate if the item being scanned is only - part of a bigger item, such as a shard of a file and you want to - track the absolute position of the finding. - containerDetails: + The key used by the encryption function. For deterministic + encryption using AES-SIV, the provided key is internally expanded to + 64 bytes prior to use. + context: description: >- - Details about the container where the content being inspected is - from. - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - labels: - type: object - description: >- - Labels to represent user provided metadata about the data being - inspected. If configured by the job, some key values may be - required. The labels associated with `Finding`'s produced by hybrid - inspection. Label keys must be between 1 and 63 characters long and - must conform to the following regular expression: - `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 - characters long and must conform to the regular expression - `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be - associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` - additionalProperties: - type: string - description: Populate to associate additional data with each finding. - GooglePrivacyDlpV2FindingLimits: - id: GooglePrivacyDlpV2FindingLimits - properties: - maxFindingsPerRequest: - description: >- - Max number of findings that are returned per request or job. If you - set this field in an InspectContentRequest, the resulting maximum - value is the value that you set or 3,000, whichever is lower. This - value isn't a hard limit. If an inspection reaches this limit, the - inspection ends gradually, not abruptly. Therefore, the actual - number of findings that Cloud DLP returns can be multiple times - higher than this value. - format: int32 - type: integer - maxFindingsPerItem: - format: int32 + A context may be used for higher security and maintaining + referential integrity such that the same identifier in two different + contexts will be given a distinct surrogate. The context is appended + to plaintext value being encrypted. On decryption the provided + context is validated against the value used during encryption. If a + context was provided during encryption, same context must be + provided during decryption as well. If the context is not set, + plaintext would be used as is for encryption. If the context is set + but: 1. there is no record present when transforming a given value + or 2. the field is not present when transforming a given value, + plaintext would be used as is for encryption. Note that case (1) is + expected when an `InfoTypeTransformation` is applied to both + structured and unstructured `ContentItem`s. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + surrogateInfoType: description: >- - Max number of findings that are returned for each item scanned. When - set within an InspectContentRequest, this field is ignored. This - value isn't a hard limit. If the number of findings for an item - reaches this limit, the inspection of that item ends gradually, not - abruptly. Therefore, the actual number of findings that Cloud DLP - returns for the item can be multiple times higher than this value. - type: integer - maxFindingsPerInfoType: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' - description: Configuration of findings limit given for specified infoTypes. - type: array - description: >- - Configuration to control the number of findings returned for inspection. - This is not used for de-identification or data profiling. When redacting - sensitive data from images, finding limits don't apply. They can cause - unexpected or inconsistent results, where only some data is redacted. - Don't include finding limits in RedactImage requests. Otherwise, Cloud - DLP returns an error. - type: object - GooglePrivacyDlpV2QuasiIdField: + The custom info type to annotate the surrogate with. This annotation + will be applied to the surrogate by prefixing it with the name of + the custom info type followed by the number of characters comprising + the surrogate. The following scheme defines the format: {info type + name}({surrogate character count}):{surrogate} For example, if the + name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate + is 'abc', the full replacement value will be: + 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate + when inspecting content using the custom info type 'Surrogate'. This + facilitates reversal of the surrogate when it occurs in free text. + Note: For record transformations where the entire cell in a table is + being transformed, surrogates are not mandatory. Surrogates are used + to denote the location of the token and are necessary for + re-identification in free form text. In order for inspection to work + properly, the name of this info type must not occur naturally + anywhere in your data; otherwise, inspection may either - reverse a + surrogate that does not correspond to an actual identifier - be + unable to parse the surrogate and result in an error Therefore, + choose your custom info type name carefully after considering what + your data looks like. One way to select a name that has a high + chance of yielding reliable detection is to include one or more + unicode characters that are highly improbable to exist in your data. + For example, assuming your data is entered from a regular ASCII + keyboard, the symbol with the hex code point 29DD might be used like + so: ⧝MY_TOKEN_TYPE. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + id: GooglePrivacyDlpV2CryptoDeterministicConfig type: object - id: GooglePrivacyDlpV2QuasiIdField description: >- - A quasi-identifier column has a custom_tag, used to know which column in - the data corresponds to which column in the statistical model. + Pseudonymization method that generates deterministic encryption for the + given input. Outputs a base64 encoded representation of the encrypted + output. Uses AES-SIV based on the RFC + https://tools.ietf.org/html/rfc5297. + GooglePrivacyDlpV2KindExpression: + type: object + id: GooglePrivacyDlpV2KindExpression + description: A representation of a Datastore kind. properties: - customTag: + name: + description: The name of the kind. type: string - description: A auxiliary field. - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Identifies the column. - GooglePrivacyDlpV2RecordCondition: - type: object + GooglePrivacyDlpV2StorageConfig: properties: - expressions: - $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' - description: An expression. - description: >- - A condition for determining whether a transformation should be applied - to a field. - id: GooglePrivacyDlpV2RecordCondition - GooglePrivacyDlpV2InfoTypeTransformation: + hybridOptions: + description: Hybrid inspection options. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' + timespanConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' + description: Configuration of the timespan of the items to include in scanning. + datastoreOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' + description: Google Cloud Datastore options. + cloudStorageOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' + description: Cloud Storage options. + bigQueryOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' + description: BigQuery options. + description: Shared message indicating Cloud storage type. type: object + id: GooglePrivacyDlpV2StorageConfig + GooglePrivacyDlpV2LDiversityEquivalenceClass: + id: GooglePrivacyDlpV2LDiversityEquivalenceClass properties: - primitiveTransformation: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - description: Required. Primitive transformation to apply to the infoType. - infoTypes: + equivalenceClassSize: + description: Size of the k-anonymity equivalence class. + format: int64 + type: string + quasiIdsValues: description: >- - InfoTypes to apply the transformation to. An empty list will cause - this transformation to apply to all findings that correspond to - infoTypes that were requested in `InspectConfig`. + Quasi-identifier values defining the k-anonymity equivalence class. + The order is always the same as the original request. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' type: array - description: >- - A transformation to apply to text that is identified as a specific - info_type. - id: GooglePrivacyDlpV2InfoTypeTransformation - GooglePrivacyDlpV2RecordTransformation: - properties: - containerVersion: - type: string - description: Container version, if available ("generation" for Cloud Storage). - containerTimestamp: - description: Findings container modification timestamp, if applicable. + topSensitiveValues: + description: Estimated frequencies of top sensitive values. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' + type: array + numDistinctSensitiveValues: type: string - format: google-datetime - fieldId: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: For record transformations, provide a field. - type: object - id: GooglePrivacyDlpV2RecordTransformation - description: The field in a record to transform. - GooglePrivacyDlpV2HybridOptions: - id: GooglePrivacyDlpV2HybridOptions + format: int64 + description: Number of distinct sensitive values in this equivalence class. type: object + description: The set of columns' values that share the same ldiversity value. + GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence: properties: - description: + frequency: + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY description: >- - A short description of where the data is coming from. Will be stored - once in the job. 256 max length. + How frequently data profiles can be updated when the template is + modified. Defaults to never. + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. type: string - requiredFindingLabelKeys: - items: - type: string - description: >- - These are labels that each inspection request must include within - their 'finding_labels' map. Request may contain others, but any - missing one of these will be rejected. Label keys must be between 1 - and 63 characters long and must conform to the following regular - expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can - be required. - type: array - labels: - type: object - description: >- - To organize findings, these labels will be added to each finding. - Label keys must be between 1 and 63 characters long and must conform - to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. - Label values must be between 0 and 63 characters long and must - conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. - No more than 10 labels can be associated with a given finding. - Examples: * `"environment" : "production"` * `"pipeline" : "etl"` - additionalProperties: - type: string - tableOptions: - description: >- - If the container is a table, additional information to make findings - meaningful such as the columns that are primary keys. - $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' - description: >- - Configuration to control jobs where the content being inspected is - outside of Google Cloud Platform. - GooglePrivacyDlpV2LargeCustomDictionaryStats: - description: Summary statistics of a custom dictionary. - id: GooglePrivacyDlpV2LargeCustomDictionaryStats + id: GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence type: object - properties: - approxNumPhrases: - description: Approximate number of distinct phrases in the dictionary. - type: string - format: int64 - GooglePrivacyDlpV2ContentLocation: - id: GooglePrivacyDlpV2ContentLocation description: >- - Precise location of the finding within a document, record, image, or - metadata container. - type: object + The cadence at which to update data profiles when the inspection rules + defined by the `InspectTemplate` change. + GooglePrivacyDlpV2ProfileStatus: properties: - containerName: + status: + $ref: '#/components/schemas/GoogleRpcStatus' description: >- - Name of the container where the finding is located. The top level - name is the source file name or table name. Names of some common - storage containers are formatted as follows: * BigQuery tables: - `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: - `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested - names could be absent if the embedded object has no string - identifier (for example, an image contained within a document). - type: string - recordLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' - description: Location within a row or record of a database table. - imageLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' - description: Location within an image's pixels. - documentLocation: - description: Location data for document files. - $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' - containerVersion: - description: >- - Finding container version, if available ("generation" for Cloud - Storage). - type: string - metadataLocation: - description: Location within the metadata for inspected content. - $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' - containerTimestamp: + Profiling status code and optional message. The `status.code` value + is 0 (default value) for OK. + timestamp: format: google-datetime + description: Time when the profile generation status was updated type: string - description: >- - Finding container modification timestamp, if applicable. For Cloud - Storage, this field contains the last file modification timestamp. - For a BigQuery table, this field contains the last_modified_time - property. For Datastore, this field isn't populated. - GooglePrivacyDlpV2InspectContentRequest: - type: object - description: Request to search for potentially sensitive info in a ContentItem. - id: GooglePrivacyDlpV2InspectContentRequest - properties: - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - Configuration for the inspector. What specified here will override - the template referenced by the inspect_template_name argument. - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The item to inspect. - inspectTemplateName: - type: string - description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - locationId: - type: string - description: Deprecated. This field has no effect. - GooglePrivacyDlpV2ActivateJobTriggerRequest: - id: GooglePrivacyDlpV2ActivateJobTriggerRequest - properties: {} - type: object - description: Request message for ActivateJobTrigger. - GooglePrivacyDlpV2Color: - description: Represents a color in the RGB color space. - id: GooglePrivacyDlpV2Color - type: object - properties: - blue: - type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - green: - description: The amount of green in the color as a value in the interval [0, 1]. - format: float - type: number - red: - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - type: number - GooglePrivacyDlpV2RequestedRiskAnalysisOptions: - properties: - jobConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - description: The job config for the risk job. - type: object - description: Risk analysis options. - id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions - GooglePrivacyDlpV2Manual: - description: >- - Job trigger option for hybrid jobs. Jobs must be manually created and - finished. - type: object - properties: {} - id: GooglePrivacyDlpV2Manual - GooglePrivacyDlpV2CategoricalStatsResult: type: object + id: GooglePrivacyDlpV2ProfileStatus + description: Success or errors for the profile generation. + GooglePrivacyDlpV2DiscoveryCloudSqlConditions: + id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions properties: - valueFrequencyHistogramBuckets: + types: type: array - description: Histogram of value frequencies in the column. items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket - id: GooglePrivacyDlpV2CategoricalStatsResult - description: Result of the categorical stats computation. - GooglePrivacyDlpV2Location: - type: object - description: Specifies the location of the finding. - properties: - byteRange: - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' - description: >- - Zero-based byte offsets delimiting the finding. These are relative - to the finding's containing element. Note that when the content is - not textual, this references the UTF-8 encoded textual - representation of the content. Omitted if content is an image. - container: - description: >- - Information about the container where this finding occurred, if - available. - $ref: '#/components/schemas/GooglePrivacyDlpV2Container' - contentLocations: + type: string + enum: + - DATABASE_RESOURCE_TYPE_UNSPECIFIED + - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES + - DATABASE_RESOURCE_TYPE_TABLE + enumDescriptions: + - Unused. + - >- + Includes database resource types that become supported at a + later time. + - Tables. description: >- - List of nested objects pointing to the precise location of the - finding within the file or record. - type: array + Data profiles will only be generated for the database resource types + specified in this field. If not specified, defaults to + [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + databaseEngines: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' - codepointRange: - $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + type: string + enum: + - DATABASE_ENGINE_UNSPECIFIED + - ALL_SUPPORTED_DATABASE_ENGINES + - MYSQL + - POSTGRES + enumDescriptions: + - Unused. + - Include all supported database engines. + - MySQL database. + - PostgreSQL database. + type: array description: >- - Unicode character offsets delimiting the finding. These are relative - to the finding's containing element. Provided when the content is - text. - id: GooglePrivacyDlpV2Location - GooglePrivacyDlpV2BigQueryRegexes: + Optional. Database engines that should be profiled. Optional. + Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + description: >- + Requirements that must be true before a table is profiled for the first + time. + type: object + GooglePrivacyDlpV2ListDiscoveryConfigsResponse: properties: - patterns: + nextPageToken: + type: string description: >- - A single BigQuery regular expression pattern to match against one or - more tables, datasets, or projects that contain BigQuery tables. + If the next page is available then this value is the next page token + to be used in the following ListDiscoveryConfigs request. + discoveryConfigs: + description: List of configs, up to page_size in ListDiscoveryConfigsRequest. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' type: array - id: GooglePrivacyDlpV2BigQueryRegexes + id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse + description: Response message for ListDiscoveryConfigs. type: object - description: >- - A collection of regular expressions to determine what tables to match - against. - GooglePrivacyDlpV2DatabaseResourceCollection: + GooglePrivacyDlpV2UpdateConnectionRequest: type: object + id: GooglePrivacyDlpV2UpdateConnectionRequest + description: Request message for UpdateConnection. properties: - includeRegexes: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' - description: >- - A collection of regular expressions to match a database resource - against. - description: >- - Match database resources using regex filters. Examples of database - resources are tables, views, and stored procedures. - id: GooglePrivacyDlpV2DatabaseResourceCollection - GooglePrivacyDlpV2DiscoveryGenerationCadence: + updateMask: + description: Optional. Mask to control which fields get updated. + type: string + format: google-fieldmask + connection: + description: Required. The connection with new values for the relevant fields. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + GooglePrivacyDlpV2OtherInfoTypeSummary: + id: GooglePrivacyDlpV2OtherInfoTypeSummary properties: - tableModifiedCadence: - description: Governs when to update data profiles when a table is modified. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' - schemaModifiedCadence: - description: Governs when to update data profiles when a schema is modified. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - description: >- - What must take place for a profile to be updated and how frequently it - should occur. New tables are scanned as quickly as possible depending on - system capacity. + excludedFromAnalysis: + description: >- + Whether this infoType was excluded from sensitivity and risk + analysis due to factors such as low prevalence (subject to change). + type: boolean + infoType: + description: The other infoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + estimatedPrevalence: + description: >- + Approximate percentage of non-null rows that contained data detected + by this infotype. + type: integer + format: int32 + description: Infotype details for other infoTypes found within a column. type: object - id: GooglePrivacyDlpV2DiscoveryGenerationCadence - GooglePrivacyDlpV2LikelihoodAdjustment: + GooglePrivacyDlpV2DateTime: type: object - id: GooglePrivacyDlpV2LikelihoodAdjustment - description: >- - Message for specifying an adjustment to the likelihood of a finding as - part of a detection rule. + description: Message for a date time object. e.g. 2018-01-01, 5th August. properties: - relativeLikelihood: + date: description: >- - Increase or decrease the likelihood by the specified number of - levels. For example, if a finding would be `POSSIBLE` without the - detection rule and `relative_likelihood` is 1, then it is upgraded - to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. - Likelihood may never drop below `VERY_UNLIKELY` or exceed - `VERY_LIKELY`, so applying an adjustment of 1 followed by an - adjustment of -1 when base likelihood is `VERY_LIKELY` will result - in a final likelihood of `LIKELY`. - type: integer - format: int32 - fixedLikelihood: - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY + One or more of the following must be set. Must be a valid date or + time value. + $ref: '#/components/schemas/GoogleTypeDate' + timeZone: + description: Time zone + $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' + dayOfWeek: + description: Day of week type: string + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - description: Set the likelihood of a finding to a fixed value. - GooglePrivacyDlpV2ContentItem: - id: GooglePrivacyDlpV2ContentItem - type: object - description: Type of content to inspect. + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + time: + description: Time of day + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + id: GooglePrivacyDlpV2DateTime + GooglePrivacyDlpV2TransformationDetailsStorageConfig: properties: - value: - description: String data to inspect or redact. - type: string - byteItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - description: Content data to inspect or redact. Replaces `type` and `data`. table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' description: >- - Structured content for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table - to learn more. - $ref: '#/components/schemas/GooglePrivacyDlpV2Table' - GooglePrivacyDlpV2FileSet: - id: GooglePrivacyDlpV2FileSet - properties: - url: - type: string - description: >- - The Cloud Storage url of the file(s) to scan, in the format - `gs:///`. Trailing wildcard in the path is allowed. If the url ends - in a trailing slash, the bucket or directory represented by the url - will be scanned non-recursively (content in sub-directories will not - be scanned). This means that `gs://mybucket/` is equivalent to - `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to - `gs://mybucket/directory/*`. Exactly one of `url` or - `regex_file_set` must be set. - regexFileSet: - description: >- - The regex-filtered set of files to scan. Exactly one of `url` or - `regex_file_set` must be set. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' + The BigQuery table in which to store the output. This may be an + existing table or in a new table in an existing dataset. If table_id + is not set a new one will be generated for you with the following + format: + dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. + id: GooglePrivacyDlpV2TransformationDetailsStorageConfig type: object - description: Set of files to scan. - GooglePrivacyDlpV2TableOptions: - id: GooglePrivacyDlpV2TableOptions + description: Config for storing transformation details. + GooglePrivacyDlpV2CreateStoredInfoTypeRequest: + id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest + description: Request message for CreateStoredInfoType. type: object properties: - identifyingFields: - type: array + storedInfoTypeId: + type: string description: >- - The columns that are the primary keys for table objects included in - ContentItem. A copy of this cell's value will stored alongside - alongside each finding so that the finding can be traced to the - specific row it came from. No more than 3 may be provided. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Instructions regarding the table content being inspected. - GooglePrivacyDlpV2FieldTransformation: - id: GooglePrivacyDlpV2FieldTransformation + The storedInfoType ID can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + locationId: + description: Deprecated. This field has no effect. + type: string + config: + description: Required. Configuration of the storedInfoType to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + GooglePrivacyDlpV2FixedSizeBucketingConfig: + description: >- + Buckets values based on fixed size ranges. The Bucketing transformation + can provide all of this functionality, but requires more configuration. + This message is provided as a convenience to the user for simple + bucketing strategies. The transformed value will be a hyphenated string + of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and + upper_bound = 20, all values that are within this bucket will be + replaced with "10-20". This can be used on data of type: double, long. + If the bound Value type differs from the type of data being transformed, + we will first attempt converting the type of the data to be transformed + to match the type of the bound before comparing. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing + to learn more. type: object + id: GooglePrivacyDlpV2FixedSizeBucketingConfig properties: - primitiveTransformation: - description: Apply the transformation to the entire field. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - fields: + upperBound: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - Required. Input field(s) to apply the transformation to. When you - have columns that reference their position within a list, omit the - index from the FieldId. FieldId name matching ignores the index. For - example, instead of "contact.nums[0].type", use "contact.nums.type". - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - condition: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + Required. Upper bound value of buckets. All values greater than + upper_bound are grouped together into a single bucket; for example + if `upper_bound` = 89, then all values greater than 89 are replaced + with the value "89+". + lowerBound: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - Only apply the transformation if the condition evaluates to true for - the given `RecordCondition`. The conditions are allowed to reference - fields that are not used in the actual transformation. Example Use - Cases: - Apply a different bucket transformation to an age column if - the zip code column for the same record is within a specific range. - - Redact a field if the date of birth field is greater than 85. - infoTypeTransformations: + Required. Lower bound value of buckets. All values less than + `lower_bound` are grouped together into a single bucket; for example + if `lower_bound` = 10, then all values less than 10 are replaced + with the value "-10". + bucketSize: + type: number + format: double description: >- - Treat the contents of the field as free text, and selectively - transform content that matches an `InfoType`. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - description: The transformation to apply to the field. - GooglePrivacyDlpV2DataProfilePubSubMessage: + Required. Size of each bucket (except for minimum and maximum + buckets). So if `lower_bound` = 10, `upper_bound` = 89, and + `bucket_size` = 10, then the following buckets would be used: -10, + 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. + Precision up to 2 decimals works. + GooglePrivacyDlpV2CustomInfoType: properties: - event: - description: The event that caused the Pub/Sub message to be sent. + regex: + description: Regular expression based CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + CustomInfoType can either be a new infoType, or an extension of + built-in infoType, when the name matches one of existing infoTypes + and that infoType is specified in `InspectContent.info_types` field. + Specifying the latter adds findings to the one detected by the + system. If built-in info type is not specified in + `InspectContent.info_types` list then the name is treated as a + custom info type. + exclusionType: enumDescriptions: - - Unused. - - New profile (not a re-profile). - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. - type: string + A finding of this custom info type will not be excluded from + results. + - >- + A finding of this custom info type will be excluded from final + results, but can still affect rule execution. enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED - profile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - description: >- - If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. - Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and - `full_resource` will be populated. - description: >- - Pub/Sub topic message for a DataProfileAction.PubSubNotification event. - To receive a message of protocol buffer schema type, convert the message - data to an object of this proto class. - id: GooglePrivacyDlpV2DataProfilePubSubMessage - type: object - GooglePrivacyDlpV2EntityId: - properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Composite key indicating which field contains the entity identifier. - type: object - description: >- - An entity in a dataset is a field or set of fields that correspond to a - single person. For example, in medical records the `EntityId` might be a - patient identifier, or for financial records it might be an account - identifier. This message is used when generalizations or analysis must - take into account that multiple rows correspond to the same entity. - id: GooglePrivacyDlpV2EntityId - GooglePrivacyDlpV2Result: - description: >- - All result fields mentioned below are updated while the job is - processing. - id: GooglePrivacyDlpV2Result - type: object - properties: - processedBytes: - type: string - format: int64 - description: Total size in bytes that were processed. - numRowsProcessed: + - EXCLUSION_TYPE_UNSPECIFIED + - EXCLUSION_TYPE_EXCLUDE type: string - format: int64 description: >- - Number of rows scanned after sampling and time filtering (applicable - for row based stores such as BigQuery). - totalEstimatedBytes: + If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a + finding to be returned. It still can be used for rules matching. + likelihood: type: string - description: Estimate of the number of bytes to process. - format: int64 - infoTypeStats: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' - type: array + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. description: >- - Statistics of how many instances of each info type were found during - inspect job. - hybridStats: - description: Statistics related to the processing of hybrid inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' - GooglePrivacyDlpV2DiscoveryStartingLocation: - type: object - properties: - folderId: - type: string - format: int64 - description: The ID of the Folder within an organization to scan. - organizationId: - format: int64 - description: The ID of an organization to scan. - type: string - description: >- - The location to begin a discovery scan. Denotes an organization ID or - folder ID within an organization. - id: GooglePrivacyDlpV2DiscoveryStartingLocation - GooglePrivacyDlpV2TransformationResultStatus: - id: GooglePrivacyDlpV2TransformationResultStatus - type: object - properties: - details: - description: Detailed error codes and messages - $ref: '#/components/schemas/GoogleRpcStatus' - resultStatusType: + Likelihood to return for this CustomInfoType. This base value can be + altered by a detection rule if the finding meets the criteria + specified by the rule. Defaults to `VERY_LIKELY` if not specified. enum: - - STATE_TYPE_UNSPECIFIED - - INVALID_TRANSFORM - - BIGQUERY_MAX_ROW_SIZE_EXCEEDED - - METADATA_UNRETRIEVABLE - - SUCCESS - type: string + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' description: >- - Transformation result status type, this will be either SUCCESS, or - it will be the reason for why the transformation was not completely - successful. - enumDescriptions: - - Unused. - - >- - This will be set when a finding could not be transformed (i.e. - outside user set bucket range). - - >- - This will be set when a BigQuery transformation was successful but - could not be stored back in BigQuery because the transformed row - exceeds BigQuery's max row size. - - >- - This will be set when there is a finding in the custom metadata of - a file, but at the write time of the transformed file, this key / - value pair is unretrievable. - - >- - This will be set when the transformation and storing of it is - successful. - description: The outcome of a transformation. - GooglePrivacyDlpV2InfoTypeLimit: - description: >- - Max findings configuration per infoType, per content item or long - running DlpJob. - properties: - maxFindings: - description: Max findings limit for the given infoType. - type: integer - format: int32 - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + Sensitivity for this CustomInfoType. If this CustomInfoType extends + an existing InfoType, the sensitivity here will take precedence over + that of the original InfoType. If unset for a CustomInfoType, it + will default to HIGH. This only applies to data profiling. + dictionary: + description: A list of phrases to detect as a CustomInfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + surrogateType: description: >- - Type of information the findings limit applies to. Only one limit - per info_type should be provided. If InfoTypeLimit does not have an - info_type, the DLP API applies the limit against all info_types that - are found but not specified in another InfoTypeLimit. - id: GooglePrivacyDlpV2InfoTypeLimit - type: object - GooglePrivacyDlpV2Error: + Message for detecting output from deidentification transformations + that support reversing. + $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' + detectionRules: + description: >- + Set of detection rules to apply to all findings of this + CustomInfoType. Rules are applied in order that they are specified. + Not supported for the `surrogate_type` CustomInfoType. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' + storedType: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' + description: >- + Load an existing `StoredInfoType` resource for use in + `InspectDataSource`. Not currently supported in `InspectContent`. description: >- - Details information about an error encountered during job execution or - the results of an unsuccessful activation of the JobTrigger. + Custom information type provided by the user. Used to find + domain-specific sensitive information configurable to the data in + question. + id: GooglePrivacyDlpV2CustomInfoType + type: object + GooglePrivacyDlpV2SchemaModifiedCadence: properties: - details: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Detailed error codes and messages. - timestamps: + types: type: array description: >- - The times the error occurred. List includes the oldest timestamp and - the last 9 timestamps. + The types of schema modifications to consider. Defaults to + NEW_COLUMNS. items: + enum: + - SQL_SCHEMA_MODIFICATION_UNSPECIFIED + - NEW_COLUMNS + - REMOVED_COLUMNS + enumDescriptions: + - Unused. + - New columns have appeared. + - Columns have been removed from the table. type: string - format: google-datetime - id: GooglePrivacyDlpV2Error - type: object - GooglePrivacyDlpV2HybridInspectStatistics: - description: Statistics related to processing hybrid inspect requests. - id: GooglePrivacyDlpV2HybridInspectStatistics - properties: - pendingCount: - type: string - format: int64 - description: >- - The number of hybrid requests currently being processed. Only - populated when called via method `getDlpJob`. A burst of traffic may - cause hybrid inspect requests to be enqueued. Processing will take - place as quickly as possible, but resource limitations may impact - how long a request is enqueued for. - processedCount: + frequency: type: string - description: The number of hybrid inspection requests processed within this job. - format: int64 - abortedCount: description: >- - The number of hybrid inspection requests aborted because the job ran - out of quota or was ended before they could be processed. - type: string - format: int64 + Frequency to regenerate data profiles when the schema is modified. + Defaults to monthly. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + id: GooglePrivacyDlpV2SchemaModifiedCadence + description: >- + How frequently to modify the profile when the table's schema is + modified. + type: object + GooglePrivacyDlpV2DeltaPresenceEstimationResult: type: object - GooglePrivacyDlpV2CloudStorageRegexFileSet: description: >- - Message representing a set of files in a Cloud Storage bucket. Regular - expressions are used to allow fine-grained control over which files in - the bucket to include. Included files are those that match at least one - item in `include_regex` and do not match any items in `exclude_regex`. - Note that a file that matches items from both lists will _not_ be - included. For a match to occur, the entire file path (i.e., everything - in the url after the bucket name) must match the regular expression. For - example, given the input `{bucket_name: "mybucket", include_regex: - ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * - `gs://mybucket/directory1/myfile` will be included * - `gs://mybucket/directory1/directory2/myfile` will be included (`.*` - matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will - _not_ be included (the full path doesn't match any items in - `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be - included (the path matches an item in `exclude_regex`) If - `include_regex` is left empty, it will match all files by default (this - is equivalent to setting `include_regex: [".*"]`). Some other common use - cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will - include all files in `mybucket` except for .pdf files * `{bucket_name: - "mybucket", include_regex: ["directory/[^/]+"]}` will include all files - directly under `gs://mybucket/directory/`, without matching across `/` + Result of the δ-presence computation. Note that these results are an + estimation, not exact values. + id: GooglePrivacyDlpV2DeltaPresenceEstimationResult properties: - excludeRegex: - items: - type: string - description: >- - A list of regular expressions matching file paths to exclude. All - files in the bucket that match at least one of these regular - expressions will be excluded from the scan. Regular expressions use - RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can - be found under the google/re2 repository on GitHub. - type: array - bucketName: - description: The name of a Cloud Storage bucket. Required. - type: string - includeRegex: + deltaPresenceEstimationHistogram: type: array description: >- - A list of regular expressions matching file paths to include. All - files in the bucket that match at least one of these regular - expressions will be included in the set of files, except for those - that also match an item in `exclude_regex`. Leaving this field empty - will match all files by default (this is equivalent to including - `.*` in the list). Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. + The intervals [min_probability, max_probability) do not overlap. If + a value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_probability: 0, max_probability: 0.1, frequency: 17} + {min_probability: 0.2, max_probability: 0.3, frequency: 42} + {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean + that there are no record with an estimated probability in [0.1, 0.2) + nor larger or equal to 0.4. items: - type: string - id: GooglePrivacyDlpV2CloudStorageRegexFileSet - type: object - GooglePrivacyDlpV2TransformationDescription: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + GooglePrivacyDlpV2HybridContentItem: + id: GooglePrivacyDlpV2HybridContentItem description: >- - A flattened description of a `PrimitiveTransformation` or - `RecordSuppression`. + An individual hybrid item to inspect. Will be stored temporarily during + processing. type: object - id: GooglePrivacyDlpV2TransformationDescription properties: - condition: - type: string + item: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + findingDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' + description: Supplementary information that will be added to each finding. + GooglePrivacyDlpV2InspectResult: + properties: + findingsTruncated: + type: boolean description: >- - A human-readable string representation of the `RecordCondition` - corresponding to this transformation. Set if a `RecordCondition` was - used to determine whether or not to apply this transformation. - Examples: * (age_field > 85) * (age_field <= 18) * (zip_field - exists) * (zip_field == 01234) && (city_field != "Springville") * - (zip_field == 01234) && (age_field <= 18) && (city_field exists) + If true, then this item might have more findings than were returned, + and the findings returned are an arbitrary subset of all findings. + The findings list might be truncated because the input items were + too large, or because the server reached the maximum amount of + resources allowed for a single API call. For best results, divide + the input into smaller batches. + findings: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' + description: List of findings for an item. + type: array + description: All the findings for a single scanned item. + type: object + id: GooglePrivacyDlpV2InspectResult + GooglePrivacyDlpV2DiscoveryBigQueryFilter: + properties: + otherTables: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' + description: >- + Catch-all. This should always be the last filter in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. + tableReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' + description: >- + The table to scan. Discovery configurations including this can only + include one DiscoveryTarget (the DiscoveryTarget with this + TableReference). + tables: + description: >- + A specific set of tables for this filter to apply to. A table + collection must be specified in only one filter per config. If a + table id or dataset is empty, Cloud DLP assumes all tables in that + collection must be profiled. Must specify a project ID. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' + id: GooglePrivacyDlpV2DiscoveryBigQueryFilter + type: object + description: >- + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, dataset ID, and table ID. + GooglePrivacyDlpV2TransformationDescription: + type: object + properties: infoType: description: Set if the transformation was limited to a specific `InfoType`. $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' type: type: string - enumDescriptions: - - Unused - - Record suppression - - Replace value - - Replace value using a dictionary. - - Redact - - Character mask - - FFX-FPE - - Fixed size bucketing - - Bucketing - - Replace with info type - - Time part - - Crypto hash - - Date shift - - Deterministic crypto - - Redact image enum: - TRANSFORMATION_TYPE_UNSPECIFIED - RECORD_SUPPRESSION @@ -897,6 +811,22 @@ components: - CRYPTO_DETERMINISTIC_CONFIG - REDACT_IMAGE description: The transformation type. + enumDescriptions: + - Unused + - Record suppression + - Replace value + - Replace value using a dictionary. + - Redact + - Character mask + - FFX-FPE + - Fixed size bucketing + - Bucketing + - Replace with info type + - Time part + - Crypto hash + - Date shift + - Deterministic crypto + - Redact image description: type: string description: >- @@ -904,4326 +834,3788 @@ components: RECORD_SUPPRESSION, or is the output of calling toString() on the `PrimitiveTransformation` protocol buffer message for any other type of transformation. - GooglePrivacyDlpV2CloudStorageFileSet: - id: GooglePrivacyDlpV2CloudStorageFileSet - description: Message representing a set of files in Cloud Storage. + condition: + type: string + description: >- + A human-readable string representation of the `RecordCondition` + corresponding to this transformation. Set if a `RecordCondition` was + used to determine whether or not to apply this transformation. + Examples: * (age_field > 85) * (age_field <= 18) * (zip_field + exists) * (zip_field == 01234) && (city_field != "Springville") * + (zip_field == 01234) && (age_field <= 18) && (city_field exists) + id: GooglePrivacyDlpV2TransformationDescription + description: >- + A flattened description of a `PrimitiveTransformation` or + `RecordSuppression`. + GooglePrivacyDlpV2CharsToIgnore: + description: >- + Characters to skip when doing deidentification of a value. These will be + left alone and skipped. + type: object + id: GooglePrivacyDlpV2CharsToIgnore properties: - url: + commonCharactersToIgnore: + enumDescriptions: + - Unused. + - 0-9 + - A-Z + - a-z + - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ + - Whitespace character, one of [ \t\n\x0B\f\r] + enum: + - COMMON_CHARS_TO_IGNORE_UNSPECIFIED + - NUMERIC + - ALPHA_UPPER_CASE + - ALPHA_LOWER_CASE + - PUNCTUATION + - WHITESPACE description: >- - The url, in the format `gs:///`. Trailing wildcard in the path is - allowed. + Common characters to not transform when masking. Useful to avoid + removing punctuation. type: string - type: object - GooglePrivacyDlpV2ListColumnDataProfilesResponse: + charactersToSkip: + type: string + description: Characters to not transform when masking. + GooglePrivacyDlpV2CreateInspectTemplateRequest: + id: GooglePrivacyDlpV2CreateInspectTemplateRequest properties: - nextPageToken: + templateId: + description: >- + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - description: The next page token. - columnDataProfiles: - description: List of data profiles. + locationId: + type: string + description: Deprecated. This field has no effect. + inspectTemplate: + description: Required. The InspectTemplate to create. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + type: object + description: Request message for CreateInspectTemplate. + GooglePrivacyDlpV2ListInfoTypesResponse: + id: GooglePrivacyDlpV2ListInfoTypesResponse + properties: + infoTypes: type: array + description: Set of sensitive infoTypes. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - description: List of profiles generated for a given organization or project. - id: GooglePrivacyDlpV2ListColumnDataProfilesResponse - type: object - GooglePrivacyDlpV2AllOtherDatabaseResources: - description: Match database resources not covered by any other filter. - properties: {} - type: object - id: GooglePrivacyDlpV2AllOtherDatabaseResources - GooglePrivacyDlpV2DataProfileLocation: - id: GooglePrivacyDlpV2DataProfileLocation + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' + description: Response to the ListInfoTypes request. type: object - description: The data that will be profiled. + GooglePrivacyDlpV2ProjectDataProfile: properties: - organizationId: - description: The ID of an organization to scan. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The sensitivity score of this project. + tableDataProfileCount: type: string + description: The number of table data profiles generated for this project. format: int64 - folderId: + projectId: + type: string + description: Project ID or account that was profiled. + name: + description: The resource name of the profile. + type: string + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level of this project. + fileStoreDataProfileCount: format: int64 - description: The ID of the Folder within an organization to scan. type: string - GooglePrivacyDlpV2FinishDlpJobRequest: - description: The request message for finishing a DLP hybrid job. - properties: {} - id: GooglePrivacyDlpV2FinishDlpJobRequest + description: The number of file store data profiles generated for this project. + profileStatus: + description: Success or error status of the last attempt to profile the project. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + profileLastGenerated: + format: google-datetime + description: The last time the profile was generated. + type: string + description: >- + An aggregated profile for this project, based on the resources profiled + within it. type: object - GooglePrivacyDlpV2TableDataProfile: + id: GooglePrivacyDlpV2ProjectDataProfile + GooglePrivacyDlpV2LDiversityConfig: + id: GooglePrivacyDlpV2LDiversityConfig type: object - id: GooglePrivacyDlpV2TableDataProfile - description: The profile for a scanned table. + description: l-diversity metric, used for analysis of reidentification risk. properties: - tableId: - description: If the resource is BigQuery, the BigQuery table ID. - type: string - scannedColumnCount: - type: string - format: int64 - description: The number of columns profiled in the table. - datasetId: - type: string - description: If the resource is BigQuery, the dataset ID. - resourceLabels: - type: object - additionalProperties: - type: string + sensitiveAttribute: + description: Sensitive field for computing the l-value. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + quasiIds: description: >- - The labels applied to the resource at the time the profile was - generated. - predictedInfoTypes: + Set of quasi-identifiers indicating how equivalence classes are + defined for the l-diversity computation. When multiple fields are + specified, they are considered a single composite key. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - description: The infoTypes predicted from this table's data. - rowCount: - description: >- - Number of rows in the table when the profile was generated. This - will not be populated for BigLake tables. - type: string - format: int64 - resourceVisibility: - type: string + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2OutputStorageConfig: + description: Cloud repository for storing output. + id: GooglePrivacyDlpV2OutputStorageConfig + type: object + properties: + outputSchema: enum: - - RESOURCE_VISIBILITY_UNSPECIFIED - - RESOURCE_VISIBILITY_PUBLIC - - RESOURCE_VISIBILITY_INCONCLUSIVE - - RESOURCE_VISIBILITY_RESTRICTED - description: How broadly a resource has been shared. - enumDescriptions: - - Unused. - - Visible to any user. - - >- - May contain public items. For example, if a Cloud Storage bucket - has uniform bucket level access disabled, some objects inside it - may be public. - - Visible only to specific users. - lastModifiedTime: - format: google-datetime - description: The time when this table was last modified - type: string - profileLastGenerated: - description: The last time the profile was generated. - type: string - format: google-datetime - projectDataProfile: + - OUTPUT_SCHEMA_UNSPECIFIED + - BASIC_COLUMNS + - GCS_COLUMNS + - DATASTORE_COLUMNS + - BIG_QUERY_COLUMNS + - ALL_COLUMNS type: string - description: The resource name to the project data profile for this table. - encryptionStatus: - description: How the table is encrypted. + description: >- + Schema used for writing the findings for Inspect jobs. This field is + only used for Inspect and must be unspecified for Risk jobs. Columns + are derived from the `Finding` object. If appending to an existing + table, any columns from the predefined schema that are missing will + be added. No columns in the existing table will be deleted. If + unspecified, then all available columns will be used for a new table + or an (existing) table with no schema, and no changes will be made + to an existing table that has a schema. Only for use with external + storage. enumDescriptions: - Unused. - - Google manages server-side encryption keys on your behalf. - - Customer provides the key. - enum: - - ENCRYPTION_STATUS_UNSPECIFIED - - ENCRYPTION_GOOGLE_MANAGED - - ENCRYPTION_CUSTOMER_MANAGED - type: string - datasetProjectId: - type: string - description: The Google Cloud project ID that owns the resource. - name: - description: The name of the profile. - type: string - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - failedColumnCount: - format: int64 - description: The number of columns skipped in the table because of an error. - type: string - configSnapshot: - description: The snapshot of the configurations used to generate the profile. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' - sensitivityScore: - description: The sensitivity score of this table. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - tableSizeBytes: - format: int64 - type: string - description: The size of the table when the profile was generated. - fullResource: + - >- + Basic schema including only `info_type`, `quote`, `certainty`, and + `timestamp`. + - Schema tailored to findings from scanning Cloud Storage. + - Schema tailored to findings from scanning Google Datastore. + - Schema tailored to findings from scanning Google BigQuery. + - Schema containing all columns. + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' description: >- - The resource name of the resource profiled. - https://cloud.google.com/apis/design/resource_names#full_resource_name - type: string - dataSourceType: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' - description: The resource type that was profiled. - otherInfoTypes: + Store findings in an existing table or a new table in an existing + dataset. If table_id is not set a new one will be generated for you + with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. + Pacific time zone will be used for generating the date details. For + Inspect, each column in an existing output table must have the same + name, type, and mode of a field in the `Finding` object. For Risk, + an existing output table should be the output of a previous Risk + analysis job run on the same source table, with the same privacy + metric and quasi-identifiers. Risk jobs that analyze the same table + but compute a different privacy metric, or use different sets of + quasi-identifiers, cannot store their results in the same table. + GooglePrivacyDlpV2Table: + id: GooglePrivacyDlpV2Table + type: object + properties: + headers: + description: Headers of the table. type: array - description: Other infoTypes found in this table's data. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - expirationTime: - format: google-datetime - description: Optional. The time when this table expires. - type: string - createTime: - type: string - description: The time at which the table was created. - format: google-datetime - datasetLocation: - type: string - description: >- - If supported, the location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. - dataRiskLevel: - description: The data risk level of this table. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + rows: + description: Rows of the table. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Row' + type: array + description: >- + Structured content to inspect. Up to 50,000 `Value`s per request + allowed. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table + to learn more. + GooglePrivacyDlpV2StoredInfoTypeVersion: + description: >- + Version of a StoredInfoType, including the configuration used to build + it, create timestamp, and current state. + id: GooglePrivacyDlpV2StoredInfoTypeVersion + properties: state: + type: string enumDescriptions: - - Unused. + - Unused + - StoredInfoType version is being created. + - StoredInfoType version is ready for use. - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. + StoredInfoType creation failed. All relevant error messages are + returned in the `StoredInfoTypeVersion` message. - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. + StoredInfoType is no longer valid because artifacts stored in + user-controlled storage were modified. To fix an invalid + StoredInfoType, use the `UpdateStoredInfoType` method to create a + new version. enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE + - STORED_INFO_TYPE_STATE_UNSPECIFIED + - PENDING + - READY + - FAILED + - INVALID + description: >- + Stored info type version state. Read-only, updated by the system + during dictionary creation. + config: + description: StoredInfoType configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' + createTime: type: string - description: State of a profile. - GooglePrivacyDlpV2OtherInfoTypeSummary: - properties: - estimatedPrevalence: description: >- - Approximate percentage of non-null rows that contained data detected - by this infotype. - format: int32 - type: integer - excludedFromAnalysis: - type: boolean + Create timestamp of the version. Read-only, determined by the system + when the version is created. + format: google-datetime + stats: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeStats' + description: Statistics about this storedInfoType version. + errors: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' description: >- - Whether this infoType was excluded from sensitivity and risk - analysis due to factors such as low prevalence (subject to change). - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The other infoType. - id: GooglePrivacyDlpV2OtherInfoTypeSummary - description: Infotype details for other infoTypes found within a column. + Errors that occurred when creating this storedInfoType version, or + anomalies detected in the storedInfoType data that render it + unusable. Only the five most recent errors will be displayed, with + the most recent error appearing first. For example, some of the data + for stored custom dictionaries is put in the user's Cloud Storage + bucket, and if this data is modified or deleted by the user or + another system, the dictionary becomes invalid. If any errors occur, + fix the problem indicated by the error message and use the + UpdateStoredInfoType API method to create another version of the + storedInfoType to continue using it, reusing the same `config` if it + was not the source of the error. type: object - GooglePrivacyDlpV2StoredInfoTypeConfig: + GooglePrivacyDlpV2ExcludeInfoTypes: type: object + description: List of excluded infoTypes. properties: - description: - description: Description of the StoredInfoType (max 256 characters). - type: string - largeCustomDictionary: + infoTypes: + type: array description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' - regex: - description: Store regular expression-based StoredInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: Store dictionary-based CustomInfoType. - displayName: - type: string - description: Display name of the StoredInfoType (max 256 characters). - id: GooglePrivacyDlpV2StoredInfoTypeConfig - description: >- - Configuration for stored infoTypes. All fields and subfield are provided - by the user. For more information, see - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. - GooglePrivacyDlpV2UpdateJobTriggerRequest: - id: GooglePrivacyDlpV2UpdateJobTriggerRequest - type: object - description: Request message for UpdateJobTrigger. + InfoType list in ExclusionRule rule drops a finding when it overlaps + or contained within with a finding of an infoType from this list. + For example, for `InspectionRuleSet.info_types` containing + "PHONE_NUMBER"` and `exclusion_rule` containing + `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone + number findings are dropped if they overlap with EMAIL_ADDRESS + finding. That leads to "555-222-2222@example.org" to generate only a + single finding, namely email address. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + id: GooglePrivacyDlpV2ExcludeInfoTypes + GooglePrivacyDlpV2CloudSqlProperties: properties: - updateMask: - description: Mask to control which fields get updated. - format: google-fieldmask - type: string - jobTrigger: - description: New JobTrigger value. - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - GooglePrivacyDlpV2InspectDataSourceDetails: - type: object - properties: - result: - $ref: '#/components/schemas/GooglePrivacyDlpV2Result' - description: A summary of the outcome of this inspection job. - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedOptions' - description: The results of an inspect DataSource job. - id: GooglePrivacyDlpV2InspectDataSourceDetails - GooglePrivacyDlpV2ReidentifyContentRequest: - id: GooglePrivacyDlpV2ReidentifyContentRequest - description: Request to re-identify an item. - type: object - properties: - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - reidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - description: >- - Configuration for the re-identification of the content item. This - field shares the same proto message type that is used for - de-identification, however its usage here is for the reversal of the - previous de-identification. Re-identification is performed by - examining the transformations used to de-identify the items and - executing the reverse. This requires that only reversible - transformations be provided here. The reversible transformations - are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` - locationId: - description: Deprecated. This field has no effect. - type: string - inspectTemplateName: + connectionName: description: >- - Template to use. Any configuration directly specified in - `inspect_config` will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. + Optional. Immutable. The Cloud SQL instance for which the connection + is defined. Only one connection per instance is allowed. This can + only be set at creation time, and cannot be updated. It is an error + to use a connection_name from different project or region than the + one that holds the connection. For example, a Connection resource + for Cloud SQL connection_name `project-id:us-central1:sql-instance` + must be created under the parent + `projects/project-id/locations/us-central1` type: string - item: - description: The item to re-identify. Will be treated as text. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - reidentifyTemplateName: + usernamePassword: + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' + description: A username and password stored in Secret Manager. + cloudSqlIam: + description: Built-in IAM authentication (must be configured in Cloud SQL). + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' + maxConnections: description: >- - Template to use. References an instance of `DeidentifyTemplate`. Any - configuration directly specified in `reidentify_config` or - `inspect_config` will override those set in the template. The - `DeidentifyTemplate` used must include only reversible - transformations. Singular fields that are set in this request will - replace their corresponding fields in the template. Repeated fields - are appended. Singular sub-messages and groups are recursively - merged. + Required. DLP will limit its connections to max_connections. Must be + 2 or greater. + type: integer + format: int32 + databaseEngine: type: string - GooglePrivacyDlpV2CancelDlpJobRequest: - properties: {} - id: GooglePrivacyDlpV2CancelDlpJobRequest - description: The request message for canceling a DLP job. - type: object - GooglePrivacyDlpV2OrgConfig: - properties: - projectId: description: >- - The project that will run the scan. The DLP service account that - exists within this project must have access to all resources that - are profiled, and the Cloud DLP API must be enabled. - type: string - location: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' - description: 'The data to scan: folder, org, or project' - id: GooglePrivacyDlpV2OrgConfig - description: >- - Project and scan location information. Only set when the parent is an - org. - type: object - GooglePrivacyDlpV2ListDiscoveryConfigsResponse: + Required. The database engine used by the Cloud SQL instance that + this connection configures. + enum: + - DATABASE_ENGINE_UNKNOWN + - DATABASE_ENGINE_MYSQL + - DATABASE_ENGINE_POSTGRES + enumDescriptions: + - >- + An engine that is not currently supported by Sensitive Data + Protection. + - Cloud SQL for MySQL instance. + - Cloud SQL for PostgreSQL instance. type: object - id: GooglePrivacyDlpV2ListDiscoveryConfigsResponse - description: Response message for ListDiscoveryConfigs. + description: Cloud SQL connection properties. + id: GooglePrivacyDlpV2CloudSqlProperties + GooglePrivacyDlpV2LDiversityHistogramBucket: + id: GooglePrivacyDlpV2LDiversityHistogramBucket properties: - discoveryConfigs: - description: List of configs, up to page_size in ListDiscoveryConfigsRequest. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - nextPageToken: + bucketValueCount: type: string + format: int64 + description: Total number of distinct equivalence classes in this bucket. + sensitiveValueFrequencyUpperBound: + format: int64 description: >- - If the next page is available then this value is the next page token - to be used in the following ListDiscoveryConfigs request. - GooglePrivacyDlpV2DiscoveryBigQueryConditions: - description: >- - Requirements that must be true before a table is scanned in discovery - for the first time. There is an AND relationship between the top-level - attributes. Additionally, minimum conditions with an OR relationship - that must be met before Cloud DLP scans a table can be set (like a - minimum row count or a minimum table age). - id: GooglePrivacyDlpV2DiscoveryBigQueryConditions - properties: - types: - description: Restrict discovery to specific table types. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' - createdAfter: + Upper bound on the sensitive value frequencies of the equivalence + classes in this bucket. + type: string + sensitiveValueFrequencyLowerBound: + format: int64 description: >- - BigQuery table must have been created after this date. Used to avoid - backfilling. - format: google-datetime + Lower bound on the sensitive value frequencies of the equivalence + classes in this bucket. type: string - typeCollection: - enumDescriptions: - - Unused. - - >- - Automatically generate profiles for all tables, even if the table - type is not yet fully supported for analysis. Profiles for - unsupported tables will be generated with errors to indicate their - partial support. When full support is added, the tables will - automatically be profiled during the next scheduled run. - - >- - Only those types fully supported will be profiled. Will expand - automatically as Cloud DLP adds support for new table types. - Unsupported table types will not have partial profiles generated. - enum: - - BIG_QUERY_COLLECTION_UNSPECIFIED - - BIG_QUERY_COLLECTION_ALL_TYPES - - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES + bucketSize: + format: int64 + description: Total number of equivalence classes in this bucket. type: string - description: Restrict discovery to categories of table types. - orConditions: - $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' + bucketValues: description: >- - At least one of the conditions must be true for a table to be - scanned. - type: object - GooglePrivacyDlpV2ReplaceDictionaryConfig: - description: >- - Replace each input value with a value randomly selected from the - dictionary. + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' type: object + description: Histogram of l-diversity equivalence class sensitive value frequencies. + GooglePrivacyDlpV2InfoTypeCategory: properties: - wordList: - description: >- - A list of words to select from for random replacement. The - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' - id: GooglePrivacyDlpV2ReplaceDictionaryConfig - GooglePrivacyDlpV2PubSubCondition: - properties: - minimumSensitivityScore: + typeCategory: + description: The class of identifiers where this infoType belongs + type: string enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. + - Unused type + - >- + Personally identifiable information, for example, a name or phone + number + - >- + Personally identifiable information that is especially sensitive, + for example, a passport number. + - >- + Attributes that can partially identify someone, especially in + combination with other attributes, like age, height, and gender. + - Confidential or secret information, for example, a password. + - An identification document issued by a government. + - A document, for example, a resume or source code. + - >- + Information that is not sensitive on its own, but provides details + about the circumstances surrounding an entity or an event. enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH + - TYPE_UNSPECIFIED + - PII + - SPII + - DEMOGRAPHIC + - CREDENTIAL + - GOVERNMENT_ID + - DOCUMENT + - CONTEXTUAL_INFORMATION + locationCategory: type: string - description: The minimum sensitivity level that triggers the condition. - minimumRiskScore: - enum: - - PROFILE_SCORE_BUCKET_UNSPECIFIED - - HIGH - - MEDIUM_OR_HIGH enumDescriptions: - - Unused. - - High risk/sensitivity detected. - - Medium or high risk/sensitivity detected. - description: The minimum data risk score that triggers the condition. - type: string - type: object - id: GooglePrivacyDlpV2PubSubCondition - description: A condition consisting of a value. - GooglePrivacyDlpV2DiscoveryConfig: - properties: - orgConfig: - description: Only set when the parent is an org. - $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' - lastRunTime: - description: >- - Output only. The timestamp of the last time this config was - executed. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. The last update timestamp of a DiscoveryConfig. - type: string - format: google-datetime - readOnly: true - displayName: - description: Display name (max 100 chars) - type: string - errors: - readOnly: true - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + - Unused location + - >- + The infoType is not issued by or tied to a specific region, but is + used almost everywhere. + - The infoType is typically used in Argentina. + - The infoType is typically used in Armenia. + - The infoType is typically used in Australia. + - The infoType is typically used in Azerbaijan. + - The infoType is typically used in Belarus. + - The infoType is typically used in Belgium. + - The infoType is typically used in Brazil. + - The infoType is typically used in Canada. + - The infoType is typically used in Chile. + - The infoType is typically used in China. + - The infoType is typically used in Colombia. + - The infoType is typically used in Croatia. + - The infoType is typically used in Denmark. + - The infoType is typically used in France. + - The infoType is typically used in Finland. + - The infoType is typically used in Germany. + - The infoType is typically used in Hong Kong. + - The infoType is typically used in India. + - The infoType is typically used in Indonesia. + - The infoType is typically used in Ireland. + - The infoType is typically used in Israel. + - The infoType is typically used in Italy. + - The infoType is typically used in Japan. + - The infoType is typically used in Kazakhstan. + - The infoType is typically used in Korea. + - The infoType is typically used in Mexico. + - The infoType is typically used in the Netherlands. + - The infoType is typically used in New Zealand. + - The infoType is typically used in Norway. + - The infoType is typically used in Paraguay. + - The infoType is typically used in Peru. + - The infoType is typically used in Poland. + - The infoType is typically used in Portugal. + - The infoType is typically used in Russia. + - The infoType is typically used in Singapore. + - The infoType is typically used in South Africa. + - The infoType is typically used in Spain. + - The infoType is typically used in Sweden. + - The infoType is typically used in Switzerland. + - The infoType is typically used in Taiwan. + - The infoType is typically used in Thailand. + - The infoType is typically used in Turkey. + - The infoType is typically used in Ukraine. + - The infoType is typically used in the United Kingdom. + - The infoType is typically used in the United States. + - The infoType is typically used in Uruguay. + - The infoType is typically used in Uzbekistan. + - The infoType is typically used in Venezuela. + - The infoType is typically used in Google internally. description: >- - Output only. A stream of errors encountered when the config was - activated. Repeated errors may result in the config automatically - being paused. Output only field. Will return the last 100 errors. - Whenever the config is modified this list will be cleared. - actions: - type: array - description: Actions to execute at the completion of scanning. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - createTime: - format: google-datetime - description: Output only. The creation timestamp of a DiscoveryConfig. - type: string - readOnly: true - status: + The region or country that issued the ID or document represented by + the infoType. enum: - - STATUS_UNSPECIFIED - - RUNNING - - PAUSED + - LOCATION_UNSPECIFIED + - GLOBAL + - ARGENTINA + - ARMENIA + - AUSTRALIA + - AZERBAIJAN + - BELARUS + - BELGIUM + - BRAZIL + - CANADA + - CHILE + - CHINA + - COLOMBIA + - CROATIA + - DENMARK + - FRANCE + - FINLAND + - GERMANY + - HONG_KONG + - INDIA + - INDONESIA + - IRELAND + - ISRAEL + - ITALY + - JAPAN + - KAZAKHSTAN + - KOREA + - MEXICO + - THE_NETHERLANDS + - NEW_ZEALAND + - NORWAY + - PARAGUAY + - PERU + - POLAND + - PORTUGAL + - RUSSIA + - SINGAPORE + - SOUTH_AFRICA + - SPAIN + - SWEDEN + - SWITZERLAND + - TAIWAN + - THAILAND + - TURKEY + - UKRAINE + - UNITED_KINGDOM + - UNITED_STATES + - URUGUAY + - UZBEKISTAN + - VENEZUELA + - INTERNAL + industryCategory: enumDescriptions: - - Unused - - The discovery config is currently active. - - The discovery config is paused temporarily. + - Unused industry + - The infoType is typically used in the finance industry. + - The infoType is typically used in the health industry. + - The infoType is typically used in the telecommunications industry. + description: >- + The group of relevant businesses where this infoType is commonly + used type: string - description: Required. A status for this configuration. - targets: + enum: + - INDUSTRY_UNSPECIFIED + - FINANCE + - HEALTH + - TELECOMMUNICATIONS + id: GooglePrivacyDlpV2InfoTypeCategory + type: object + description: >- + Classification of infoTypes to organize them according to geographic + location, industry, and data type. + GooglePrivacyDlpV2InfoTypeSummary: + description: The infoType details for this column. + id: GooglePrivacyDlpV2InfoTypeSummary + properties: + estimatedPrevalence: + format: int32 + deprecated: true + description: Not populated for predicted infotypes. + type: integer + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: The infoType. + type: object + GooglePrivacyDlpV2FileStoreRegexes: + id: GooglePrivacyDlpV2FileStoreRegexes + description: >- + A collection of regular expressions to determine what file store to + match against. + type: object + properties: + patterns: type: array + description: >- + Required. The group of regular expression patterns to match against + one or more file stores. Maximum of 100 entries. The sum of all + regular expression's length can't exceed 10 KiB. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegex' + GooglePrivacyDlpV2DeidentifyConfig: + description: The configuration that controls how the data will change. + properties: + imageTransformations: + description: Treat the dataset as an image and redact. + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' + recordTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' description: >- - Target to match against for determining what to scan and how - frequently. - name: + Treat the dataset as structured. Transformations can be applied to + specific locations within structured datasets, such as transforming + a column within a table. + infoTypeTransformations: description: >- - Unique resource name for the DiscoveryConfig, assigned by the - service when the DiscoveryConfig is created, for example - `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. - type: string - inspectTemplates: - items: - type: string - type: array + Treat the dataset as free-form text and apply the same free text + transformation everywhere. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + transformationErrorHandling: description: >- - Detection logic for profile generation. Not all template features - are used by Discovery. FindingLimits, include_quote and - exclude_info_types have no impact on Discovery. Multiple templates - may be provided if there is data in multiple regions. At most one - template must be specified per-region (including "global"). Each - region is scanned using the applicable template. If no - region-specific template is specified, but a "global" template is - specified, it will be copied to that region and used instead. If no - global or region-specific template is provided for a region with - data, that region's data will not be scanned. For more information, - see - https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. - id: GooglePrivacyDlpV2DiscoveryConfig - description: >- - Configuration for discovery to scan resources for profile generation. - Only one discovery configuration may exist per organization, folder, or - project. The generated data profiles are retained according to the [data - retention policy] - (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). + Mode for handling transformation errors. If left unspecified, the + default mode is `TransformationErrorHandling.ThrowError`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' type: object - GooglePrivacyDlpV2ProjectDataProfile: + id: GooglePrivacyDlpV2DeidentifyConfig + GooglePrivacyDlpV2PublishToChronicle: + properties: {} + description: Message expressing intention to publish to Google Security Operations. type: object - description: >- - An aggregated profile for this project, based on the resources profiled - within it. - id: GooglePrivacyDlpV2ProjectDataProfile + id: GooglePrivacyDlpV2PublishToChronicle + GooglePrivacyDlpV2InspectTemplate: + id: GooglePrivacyDlpV2InspectTemplate properties: - sensitivityScore: - description: The sensitivity score of this project. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - name: - description: The resource name of the profile. + displayName: + description: Display name (max 256 chars). type: string - profileStatus: - description: Success or error status of the last attempt to profile the project. - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level of this project. - profileLastGenerated: - description: The last time the profile was generated. + createTime: type: string format: google-datetime - projectId: + readOnly: true + description: Output only. The creation timestamp of an inspectTemplate. + description: + description: Short description (max 256 chars). type: string - description: Project ID that was profiled. - GooglePrivacyDlpV2LeaveUntransformed: - description: >- - Skips the data without modifying it if the requested transformation - would cause an error. For example, if a `DateShift` transformation were - applied an an IP address, this mode would leave the IP address unchanged - in the response. - type: object - properties: {} - id: GooglePrivacyDlpV2LeaveUntransformed - GoogleRpcStatus: - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - properties: - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - code: - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - type: integer - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - id: GoogleRpcStatus - type: object - GooglePrivacyDlpV2RedactImageResponse: - type: object - id: GooglePrivacyDlpV2RedactImageResponse - properties: - inspectResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - The findings. Populated when include_findings in the request is - true. - redactedImage: + The core content of the template. Configuration of the scanning + process. + updateTime: + format: google-datetime type: string - description: The redacted image. The type will be the same as the original image. - format: byte - extractedText: + description: Output only. The last update timestamp of an inspectTemplate. + readOnly: true + name: description: >- - If an image was being inspected and the InspectConfig's - include_quote was set to true, then this field will include all - text, if any, that was found in the image. + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; type: string - description: Results of redacting an image. - GooglePrivacyDlpV2RiskAnalysisJobConfig: - id: GooglePrivacyDlpV2RiskAnalysisJobConfig + readOnly: true description: >- - Configuration for a risk analysis job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis + The inspectTemplate contains a configuration (set of types of sensitive + data to be detected) to be used anywhere you otherwise would normally + specify InspectConfig. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. type: object + GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: + id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails + description: Result of a risk analysis operation request. + type: object properties: - privacyMetric: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - description: Privacy metric to compute. - sourceTable: + requestedSourceTable: $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' description: Input dataset to compute metrics over. - actions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - description: >- - Actions to execute at the completion of the job. Are executed in the - order provided. - type: array - GooglePrivacyDlpV2KmsWrappedCryptoKey: + categoricalStatsResult: + description: Categorical stats result + $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' + kAnonymityResult: + description: K-anonymity result + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' + requestedPrivacyMetric: + description: Privacy metric to compute. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + numericalStatsResult: + description: Numerical stats result + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' + kMapEstimationResult: + description: K-map result + $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' + requestedOptions: + description: The configuration used for this job. + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' + lDiversityResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' + description: L-divesity result + deltaPresenceEstimationResult: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' + description: Delta-presence result + GooglePrivacyDlpV2InspectContentResponse: properties: - wrappedKey: - format: byte - type: string - description: Required. The wrapped data crypto key. - cryptoKeyName: - description: >- - Required. The resource name of the KMS CryptoKey to use for - unwrapping. - type: string + result: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + description: The findings. + id: GooglePrivacyDlpV2InspectContentResponse type: object - description: >- - Include to use an existing data crypto key wrapped by KMS. The wrapped - key must be a 128-, 192-, or 256-bit key. Authorization requires the - following IAM permissions when sending a request to perform a crypto - transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more - information, see [Creating a wrapped key] - (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). - Note: When you use Cloud KMS for cryptographic operations, [charges - apply](https://cloud.google.com/kms/pricing). - id: GooglePrivacyDlpV2KmsWrappedCryptoKey - GooglePrivacyDlpV2SecretManagerCredential: - description: >- - A credential consisting of a username and password, where the password - is stored in a Secret Manager resource. Note: Secret Manager [charges - apply](https://cloud.google.com/secret-manager/pricing). - id: GooglePrivacyDlpV2SecretManagerCredential + description: Results of inspecting an item. + GooglePrivacyDlpV2PrimitiveTransformation: + description: A rule for transforming a value. + type: object + id: GooglePrivacyDlpV2PrimitiveTransformation properties: - username: - type: string - description: Required. The username. - passwordSecretVersionName: - type: string + replaceDictionaryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' description: >- - Required. The name of the Secret Manager resource that stores the - password, in the form - `projects/project-id/secrets/secret-name/versions/version`. - type: object - GooglePrivacyDlpV2BigQueryTableTypes: - id: GooglePrivacyDlpV2BigQueryTableTypes - type: object + Replace with a value randomly drawn (with replacement) from a + dictionary. + cryptoDeterministicConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' + description: Deterministic Crypto + bucketingConfig: + description: Bucketing + $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' + replaceWithInfoTypeConfig: + description: Replace with infotype + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' + characterMaskConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' + description: Mask + timePartConfig: + description: Time extraction + $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' + cryptoHashConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' + description: Crypto + redactConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' + description: Redact + dateShiftConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' + description: Date Shift + fixedSizeBucketingConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' + description: Fixed size bucketing + replaceConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' + description: Replace with a specified value. + cryptoReplaceFfxFpeConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' + description: Ffx-Fpe + GooglePrivacyDlpV2DiscoveryCloudStorageConditions: properties: - types: + includedObjectAttributes: + description: >- + Required. Only objects with the specified attributes will be + scanned. If an object has one of the specified attributes but is + inside an excluded bucket, it will not be scanned. Defaults to + [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no + objects match the included_object_attributes. + items: + type: string + enum: + - CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_OBJECTS + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE + - REGIONAL + - MULTI_REGIONAL + - DURABLE_REDUCED_AVAILABILITY + enumDescriptions: + - Unused. + - Scan objects regardless of the attribute. + - Scan objects with the standard storage class. + - >- + Scan objects with the nearline storage class. This will incur + retrieval fees. + - >- + Scan objects with the coldline storage class. This will incur + retrieval fees. + - >- + Scan objects with the archive storage class. This will incur + retrieval fees. + - Scan objects with the regional storage class. + - Scan objects with the multi-regional storage class. + - >- + Scan objects with the dual-regional storage class. This will + incur retrieval fees. type: array + includedBucketAttributes: items: + enum: + - CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED + - ALL_SUPPORTED_BUCKETS + - AUTOCLASS_DISABLED + - AUTOCLASS_ENABLED enumDescriptions: - Unused. - - A normal BigQuery table. - - A table that references data stored in Cloud Storage. + - Scan buckets regardless of the attribute. + - >- + Buckets with autoclass disabled + (https://cloud.google.com/storage/docs/autoclass). Only one of + AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. + - >- + Buckets with autoclass enabled + (https://cloud.google.com/storage/docs/autoclass). Only one of + AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning + Autoclass-enabled buckets can affect object storage classes. type: string - enum: - - BIG_QUERY_TABLE_TYPE_UNSPECIFIED - - BIG_QUERY_TABLE_TYPE_TABLE - - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE - description: A set of BigQuery table types. - description: The types of BigQuery tables supported by Cloud DLP. - GooglePrivacyDlpV2DateTime: + type: array + description: >- + Required. Only objects with the specified attributes will be + scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. + id: GooglePrivacyDlpV2DiscoveryCloudStorageConditions + description: >- + Requirements that must be true before a Cloud Storage bucket or object + is scanned in discovery for the first time. There is an AND relationship + between the top-level attributes. + type: object + GooglePrivacyDlpV2Error: type: object + id: GooglePrivacyDlpV2Error + description: >- + Details information about an error encountered during job execution or + the results of an unsuccessful activation of the JobTrigger. properties: - time: - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - description: Time of day - dayOfWeek: + details: + $ref: '#/components/schemas/GoogleRpcStatus' + description: Detailed error codes and messages. + timestamps: + description: >- + The times the error occurred. List includes the oldest timestamp and + the last 9 timestamps. + items: + format: google-datetime + type: string + type: array + extraInfo: type: string - description: Day of week + enumDescriptions: + - Unused. + - Image scan is not available in the region. + - File store cluster is not supported for profile generation. + description: Additional information about the error. enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - timeZone: - $ref: '#/components/schemas/GooglePrivacyDlpV2TimeZone' - description: Time zone - date: - $ref: '#/components/schemas/GoogleTypeDate' - description: >- - One or more of the following must be set. Must be a valid date or - time value. - description: Message for a date time object. e.g. 2018-01-01, 5th August. - id: GooglePrivacyDlpV2DateTime - GooglePrivacyDlpV2ListInspectTemplatesResponse: - id: GooglePrivacyDlpV2ListInspectTemplatesResponse + - ERROR_INFO_UNSPECIFIED + - IMAGE_SCAN_UNAVAILABLE_IN_REGION + - FILE_STORE_CLUSTER_UNSUPPORTED + GooglePrivacyDlpV2DiscoveryCloudStorageFilter: type: object properties: - inspectTemplates: - description: >- - List of inspectTemplates, up to page_size in - ListInspectTemplatesRequest. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - nextPageToken: - type: string + others: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherResources' description: >- - If the next page is available then the next page token to be used in - the following ListInspectTemplates request. - description: Response message for ListInspectTemplates. - GooglePrivacyDlpV2CloudStorageOptions: + Optional. Catch-all. This should always be the last target in the + list because anything above it will apply first. Should only appear + once in a configuration. If none is specified, a default one will be + added automatically. + collection: + description: Optional. A specific set of buckets for this filter to apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreCollection' + cloudStorageResourceReference: + description: >- + Optional. The bucket to scan. Targets including this can only + include one target (the target with this bucket). This enables + profiling the contents of a single bucket, while the other options + allow for easy profiling of many bucets within a project or an + organization. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageResourceReference' + id: GooglePrivacyDlpV2DiscoveryCloudStorageFilter + description: >- + Determines which buckets will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID and bucket name. + GooglePrivacyDlpV2BigQueryTable: type: object - description: Options defining a file or a set of files within a Cloud Storage bucket. + id: GooglePrivacyDlpV2BigQueryTable properties: - bytesLimitPerFile: - type: string - format: int64 - description: >- - Max number of bytes to scan from a file. If a scanned file's size is - bigger than this value then the rest of the bytes are omitted. Only - one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can - be specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - filesLimitPercent: - type: integer - description: >- - Limits the number of files to scan to this percentage of the input - FileSet. Number of files scanned is rounded down. Must be between 0 - and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. - format: int32 - fileSet: - description: The set of one or more files to scan. - $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' - bytesLimitPerFilePercent: - format: int32 - type: integer - description: >- - Max percentage of bytes to scan from a file. The rest are omitted. - The number of bytes scanned is rounded down. Must be between 0 and - 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only - one of bytes_limit_per_file and bytes_limit_per_file_percent can be - specified. This field can't be set if de-identification is - requested. For certain file types, setting this field has no effect. - For more information, see [Limits on bytes scanned per - file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). - fileTypes: - items: - enumDescriptions: - - Includes all files. - - >- - Includes all file extensions not covered by another entry. - Binary scanning attempts to convert the content of the file to - utf_8 to scan the file. If you wish to avoid this fall back, - specify one or more of the other file types in your storage - scan. - - >- - Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, - cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, - go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, - mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, - rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, - xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, - md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, - xsd, yml, yaml. - - >- - Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting - bytes_limit_per_file or bytes_limit_per_file_percent has no - effect on image files. Image inspection is restricted to the - `global`, `us`, `asia`, and `europe` regions. - - >- - Microsoft Word files larger than 30 MB will be scanned as binary - files. Included file extensions: docx, dotx, docm, dotm. Setting - `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no - effect on Word files. - - >- - PDF files larger than 30 MB will be scanned as binary files. - Included file extensions: pdf. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PDF files. - - 'Included file extensions: avro' - - 'Included file extensions: csv' - - 'Included file extensions: tsv' - - >- - Microsoft PowerPoint files larger than 30 MB will be scanned as - binary files. Included file extensions: pptx, pptm, potx, potm, - pot. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PowerPoint - files. - - >- - Microsoft Excel files larger than 30 MB will be scanned as - binary files. Included file extensions: xlsx, xlsm, xltx, xltm. - Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` - has no effect on Excel files. - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL - type: string - type: array - description: >- - List of file type groups to include in the scan. If empty, all files - are scanned and available data format processors are applied. In - addition, the binary content of the selected files is always scanned - as well. Images are scanned only as binary if the specified region - does not support image inspection and no file_types were specified. - Image inspection is restricted to 'global', 'us', 'asia', and - 'europe'. - sampleMethod: + tableId: type: string - enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - enumDescriptions: - - No sampling. - - Scan from the top (default). - - >- - For each file larger than bytes_limit_per_file, randomly pick the - offset to start scanning. The scanned bytes are contiguous. - description: How to sample the data. - id: GooglePrivacyDlpV2CloudStorageOptions - GooglePrivacyDlpV2KindExpression: - properties: - name: - description: The name of the kind. + description: Name of the table. + projectId: type: string - type: object - description: A representation of a Datastore kind. - id: GooglePrivacyDlpV2KindExpression - GooglePrivacyDlpV2DeidentifyContentResponse: - description: Results of de-identifying a ContentItem. - id: GooglePrivacyDlpV2DeidentifyContentResponse - properties: - item: - description: The de-identified item. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - overview: - description: An overview of the changes that were made on the `item`. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - type: object - GooglePrivacyDlpV2DatabaseResourceRegexes: - properties: - patterns: description: >- - A group of regular expression patterns to match against one or more - database resources. Maximum of 100 entries. The sum of all regular - expression's length can't exceed 10 KiB. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' - type: array + The Google Cloud Platform project ID of the project containing the + table. If omitted, project ID is inferred from the API call. + datasetId: + description: Dataset ID of the table. + type: string description: >- - A collection of regular expressions to determine what database resources - to match against. + Message defining the location of a BigQuery table. A table is uniquely + identified by its project_id, dataset_id, and table_name. Within a query + a table is often referenced with a string in the format of: `:.` or + `..`. + GooglePrivacyDlpV2ListTableDataProfilesResponse: + id: GooglePrivacyDlpV2ListTableDataProfilesResponse type: object - id: GooglePrivacyDlpV2DatabaseResourceRegexes - GooglePrivacyDlpV2RecordTransformations: properties: - recordSuppressions: + tableDataProfiles: + description: List of data profiles. type: array - description: >- - Configuration defining which records get suppressed entirely. - Records that match any suppression rule are omitted from the output. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - fieldTransformations: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' - description: Transform the record by applying various field transformations. - type: array - type: object - id: GooglePrivacyDlpV2RecordTransformations - description: >- - A type of transformation that is applied over structured data such as a - table. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + nextPageToken: + type: string + description: The next page token. + description: List of profiles generated for a given organization or project. GooglePrivacyDlpV2TransformationDetails: - description: >- - Details about a single transformation. This object contains a - description of the transformation, information about whether the - transformation was successfully applied, and the precise location where - the transformation occurred. These details are stored in a - user-specified BigQuery table. + type: object + id: GooglePrivacyDlpV2TransformationDetails properties: - resourceName: - description: The name of the job that completed the transformation. - type: string - transformationLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' - description: >- - The precise location of the transformed content in the original - container. statusDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' description: >- Status of the transformation, if transformation was not successful, this will specify what caused it to fail, otherwise it will show that the transformation was successful. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationResultStatus' transformedBytes: - format: int64 description: >- The number of bytes that were transformed. If transformation was unsuccessful or did not take place because there was no content to transform, this will be zero. type: string - transformation: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' - type: array + format: int64 + resourceName: + type: string + description: The name of the job that completed the transformation. + transformationLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationLocation' + description: >- + The precise location of the transformed content in the original + container. + transformation: description: >- Description of transformation. This would only contain more than one element if there were multiple matching transformations and which one to apply was ambiguous. Not set for states that contain no transformation, currently only state that contains no transformation is TransformationResultStateType.METADATA_UNRETRIEVABLE. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationDescription' + type: array containerName: type: string description: >- The top level name of the container where the transformation is located (this will be the source file name or table name). + description: >- + Details about a single transformation. This object contains a + description of the transformation, information about whether the + transformation was successfully applied, and the precise location where + the transformation occurred. These details are stored in a + user-specified BigQuery table. + GooglePrivacyDlpV2LeaveUntransformed: type: object - id: GooglePrivacyDlpV2TransformationDetails - GooglePrivacyDlpV2ListTableDataProfilesResponse: + properties: {} + description: >- + Skips the data without modifying it if the requested transformation + would cause an error. For example, if a `DateShift` transformation were + applied an an IP address, this mode would leave the IP address unchanged + in the response. + id: GooglePrivacyDlpV2LeaveUntransformed + GooglePrivacyDlpV2Action: + description: >- + A task to execute on the completion of a job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-actions + to learn more. properties: - nextPageToken: - description: The next page token. - type: string - tableDataProfiles: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - type: array - description: List of data profiles. - description: List of profiles generated for a given organization or project. + publishSummaryToCscc: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' + description: Publish summary to Cloud Security Command Center (Alpha). + saveFindings: + $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' + description: Save resulting findings in a provided location. + jobNotificationEmails: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' + description: >- + Sends an email when the job completes. The email goes to IAM project + owners and technical [Essential + Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + publishFindingsToCloudDataCatalog: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + description: Publish findings to Cloud Datahub. + pubSub: + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' + description: Publish a notification to a Pub/Sub topic. + deidentify: + $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' + description: Create a de-identified copy of the input data. + publishToStackdriver: + description: Enable Stackdriver metric dlp.googleapis.com/finding_count. + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' + type: object + id: GooglePrivacyDlpV2Action + GooglePrivacyDlpV2AllOtherDatabaseResources: + description: Match database resources not covered by any other filter. + id: GooglePrivacyDlpV2AllOtherDatabaseResources + type: object + properties: {} + GooglePrivacyDlpV2CloudSqlDiscoveryTarget: + description: Target used to match against for discovery with Cloud SQL tables. + id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget type: object - id: GooglePrivacyDlpV2ListTableDataProfilesResponse - GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: - id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest properties: - config: + disabled: + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + description: Disable profiling for database resources that match this filter. + filter: description: >- - Updated configuration for the storedInfoType. If not provided, a new - version of the storedInfoType will be created with the existing - configuration. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - updateMask: - format: google-fieldmask - type: string - description: Mask to control which fields get updated. - description: Request message for UpdateStoredInfoType. - type: object - GooglePrivacyDlpV2BigQueryOptions: - description: Options defining BigQuery table and row identifiers. + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' + generationCadence: + description: >- + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' + description: >- + In addition to matching the filter, these conditions must be true + before a profile is generated. + GooglePrivacyDlpV2LDiversityResult: + id: GooglePrivacyDlpV2LDiversityResult + properties: + sensitiveValueFrequencyHistogramBuckets: + type: array + description: >- + Histogram of l-diversity equivalence class sensitive value + frequencies. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' + description: Result of the l-diversity computation. type: object + GooglePrivacyDlpV2Proximity: + description: >- + Message for specifying a window around a finding to apply a detection + rule. properties: - tableReference: - description: Complete BigQuery table reference. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - rowsLimitPercent: + windowAfter: + type: integer + format: int32 + description: Number of characters after the finding to consider. + windowBefore: format: int32 type: integer description: >- - Max percentage of rows to scan. The rest are omitted. The number of - rows scanned is rounded down. Must be between 0 and 100, - inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one - of rows_limit and rows_limit_percent can be specified. Cannot be - used in conjunction with TimespanConfig. Caution: A [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) - is causing the `rowsLimitPercent` field to behave unexpectedly. We - recommend using `rowsLimit` instead. - excludedFields: - description: >- - References to fields excluded from scanning. This allows you to skip - inspection of entire columns which you know have no findings. When - inspecting a table, we recommend that you inspect all columns. - Otherwise, findings might be affected because hints from excluded - columns will not be used. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - type: array - rowsLimit: - type: string + Number of characters before the finding to consider. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, set this to 1. For more information, see [Hotword example: + Set the match likelihood of a table column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + id: GooglePrivacyDlpV2Proximity + type: object + GooglePrivacyDlpV2LargeCustomDictionaryStats: + type: object + properties: + approxNumPhrases: format: int64 + description: Approximate number of distinct phrases in the dictionary. + type: string + description: Summary statistics of a custom dictionary. + id: GooglePrivacyDlpV2LargeCustomDictionaryStats + GooglePrivacyDlpV2KMapEstimationConfig: + description: >- + Reidentifiability metric. This corresponds to a risk model similar to + what is called "journalist risk" in the literature, except the attack + dataset is statistically modeled instead of being perfectly known. This + can be done using publicly available data (like the US Census), or using + a custom statistical model (indicated as one or several BigQuery + tables), or by extrapolating from the distribution of values in the + input dataset. + id: GooglePrivacyDlpV2KMapEstimationConfig + properties: + auxiliaryTables: description: >- - Max number of rows to scan. If the table has more rows than this - value, the rest of the rows are omitted. If not set, or if set to 0, - all rows will be scanned. Only one of rows_limit and - rows_limit_percent can be specified. Cannot be used in conjunction - with TimespanConfig. - identifyingFields: - description: >- - Table fields that may uniquely identify a row within the table. When - `actions.saveFindings.outputConfig.table` is specified, the values - of columns specified here are available in the output table under - `location.content_locations.record_location.record_key.id_values`. - Nested fields such as `person.birthdate.year` are allowed. + Several auxiliary tables can be used in the analysis. Each + custom_tag used to tag a quasi-identifiers column must appear in + exactly one column of one auxiliary table. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' type: array - sampleMethod: - enumDescriptions: - - No sampling. - - >- - Scan groups of rows in the order BigQuery provides (default). - Multiple groups of rows may be scanned in parallel, so results may - not appear in the same order the rows are read. - - Randomly pick groups of rows to scan. - description: How to sample the data. - enum: - - SAMPLE_METHOD_UNSPECIFIED - - TOP - - RANDOM_START - type: string - includedFields: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + quasiIds: description: >- - Limit scanning only to these fields. When inspecting a table, we - recommend that you inspect all columns. Otherwise, findings might be - affected because hints from excluded columns will not be used. + Required. Fields considered to be quasi-identifiers. No two columns + can have the same tag. type: array - id: GooglePrivacyDlpV2BigQueryOptions - GooglePrivacyDlpV2InfoTypeLikelihood: - description: >- - Configuration for setting a minimum likelihood per infotype. Used to - customize the minimum likelihood level for specific infotypes in the - request. For example, use this if you want to lower the precision for - PERSON_NAME without lowering the precision for the other infotypes in - the request. - properties: - minLikelihood: - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - description: >- - Only returns findings equal to or above this threshold. This field - is required or else the configuration fails. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' + regionCode: type: string - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. - infoType: description: >- - Type of information the likelihood threshold applies to. Only one - likelihood per info_type should be provided. If InfoTypeLikelihood - does not have an info_type, the configuration fails. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. type: object - id: GooglePrivacyDlpV2InfoTypeLikelihood - GooglePrivacyDlpV2HybridInspectDlpJobRequest: - description: Request to search for potentially sensitive info in a custom location. + GooglePrivacyDlpV2UpdateInspectTemplateRequest: + id: GooglePrivacyDlpV2UpdateInspectTemplateRequest + description: Request message for UpdateInspectTemplate. properties: - hybridItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - description: The item to inspect. - id: GooglePrivacyDlpV2HybridInspectDlpJobRequest - type: object - GooglePrivacyDlpV2StatisticalTable: - description: >- - An auxiliary table containing statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). + inspectTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + description: New InspectTemplate value. + updateMask: + format: google-fieldmask + description: Mask to control which fields get updated. + type: string type: object - id: GooglePrivacyDlpV2StatisticalTable + GooglePrivacyDlpV2QuasiId: properties: - relativeFrequency: + field: + description: Required. Identifies the column. $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + infoType: description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. - table: - description: Required. Auxiliary table location. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - quasiIds: - description: Required. Quasi-identifier columns. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' - GooglePrivacyDlpV2DiscoveryTarget: - description: Target used to match against for Discovery. - properties: - cloudSqlTarget: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' - description: >- - Cloud SQL target for Discovery. The first target to match a table - will be the one applied. - secretsTarget: + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + customTag: + type: string description: >- - Discovery target that looks for credentials and secrets stored in - cloud resource metadata and reports them as vulnerabilities to - Security Command Center. Only one target of this type is allowed. - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' - bigQueryTarget: + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). + inferred: description: >- - BigQuery target for Discovery. The first target to match a table - will be the one applied. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data + $ref: '#/components/schemas/GoogleProtobufEmpty' type: object - id: GooglePrivacyDlpV2DiscoveryTarget - GooglePrivacyDlpV2ByteContentItem: - description: Container for bytes to inspect or redact. - id: GooglePrivacyDlpV2ByteContentItem + description: A column with a semantic tag attached. + id: GooglePrivacyDlpV2QuasiId + GooglePrivacyDlpV2BigQueryRegexes: + type: object + description: >- + A collection of regular expressions to determine what tables to match + against. + id: GooglePrivacyDlpV2BigQueryRegexes properties: - type: - enum: - - BYTES_TYPE_UNSPECIFIED - - IMAGE - - IMAGE_JPEG - - IMAGE_BMP - - IMAGE_PNG - - IMAGE_SVG - - TEXT_UTF8 - - WORD_DOCUMENT - - PDF - - POWERPOINT_DOCUMENT - - EXCEL_DOCUMENT - - AVRO - - CSV - - TSV + patterns: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegex' + type: array description: >- - The type of data stored in the bytes string. Default will be - TEXT_UTF8. - type: string - enumDescriptions: - - Unused - - Any image type. - - jpeg - - bmp - - png - - svg - - plain text - - docx, docm, dotx, dotm - - pdf - - pptx, pptm, potx, potm, pot - - xlsx, xlsm, xltx, xltm - - avro - - csv - - tsv - data: - description: Content data to inspect or redact. - format: byte - type: string - type: object - GooglePrivacyDlpV2TransformationOverview: + A single BigQuery regular expression pattern to match against one or + more tables, datasets, or projects that contain BigQuery tables. + GooglePrivacyDlpV2FindingLimits: + id: GooglePrivacyDlpV2FindingLimits + description: >- + Configuration to control the number of findings returned for inspection. + This is not used for de-identification or data profiling. When redacting + sensitive data from images, finding limits don't apply. They can cause + unexpected or inconsistent results, where only some data is redacted. + Don't include finding limits in RedactImage requests. Otherwise, Cloud + DLP returns an error. type: object - id: GooglePrivacyDlpV2TransformationOverview - description: Overview of the modifications that occurred. properties: - transformationSummaries: - description: Transformations applied to the dataset. + maxFindingsPerItem: + type: integer + format: int32 + description: >- + Max number of findings that are returned for each item scanned. When + set within an InspectContentRequest, this field is ignored. This + value isn't a hard limit. If the number of findings for an item + reaches this limit, the inspection of that item ends gradually, not + abruptly. Therefore, the actual number of findings that Cloud DLP + returns for the item can be multiple times higher than this value. + maxFindingsPerRequest: + format: int32 + description: >- + Max number of findings that are returned per request or job. If you + set this field in an InspectContentRequest, the resulting maximum + value is the value that you set or 3,000, whichever is lower. This + value isn't a hard limit. If an inspection reaches this limit, the + inspection ends gradually, not abruptly. Therefore, the actual + number of findings that Cloud DLP returns can be multiple times + higher than this value. + type: integer + maxFindingsPerInfoType: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLimit' + description: Configuration of findings limit given for specified infoTypes. type: array - transformedBytes: - type: string - format: int64 - description: Total size in bytes that were transformed in some way. - GooglePrivacyDlpV2CreateInspectTemplateRequest: - description: Request message for CreateInspectTemplate. + GooglePrivacyDlpV2TransformationLocation: properties: - inspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - description: Required. The InspectTemplate to create. - locationId: + recordTransformation: + description: >- + For record transformations, provide a field and container + information. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' + containerType: type: string - description: Deprecated. This field has no effect. - templateId: + description: >- + Information about the functionality of the container where this + finding occurred, if available. + enumDescriptions: + - Unused. + - Body of a file. + - Metadata for a file. + - A table. + enum: + - TRANSFORM_UNKNOWN_CONTAINER + - TRANSFORM_BODY + - TRANSFORM_METADATA + - TRANSFORM_TABLE + findingId: type: string description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - id: GooglePrivacyDlpV2CreateInspectTemplateRequest - type: object - GooglePrivacyDlpV2LDiversityConfig: - id: GooglePrivacyDlpV2LDiversityConfig - description: l-diversity metric, used for analysis of reidentification risk. + For infotype transformations, link to the corresponding findings ID + so that location information does not need to be duplicated. Each + findings ID correlates to an entry in the findings output table, + this table only gets created when users specify to save findings + (add the save findings action to the request). + description: Specifies the location of a transformation. type: object + id: GooglePrivacyDlpV2TransformationLocation + GooglePrivacyDlpV2Row: properties: - sensitiveAttribute: - description: Sensitive field for computing the l-value. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - quasiIds: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Set of quasi-identifiers indicating how equivalence classes are - defined for the l-diversity computation. When multiple fields are - specified, they are considered a single composite key. + values: type: array - GooglePrivacyDlpV2RecordKey: - id: GooglePrivacyDlpV2RecordKey + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Individual cells. + id: GooglePrivacyDlpV2Row + description: Values of the row. type: object - description: Message for a unique key indicating a record that contains a finding. + GooglePrivacyDlpV2SelectedInfoTypes: + description: Apply transformation to the selected info_types. + id: GooglePrivacyDlpV2SelectedInfoTypes properties: - bigQueryKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' - description: Datastore key - idValues: + infoTypes: description: >- - Values of identifying columns in the given row. Order of values - matches the order of `identifying_fields` specified in the scanning - request. + Required. InfoTypes to apply the transformation to. Required. + Provided InfoType must be unique within the ImageTransformations + message. type: array items: - type: string - datastoreKey: - description: BigQuery key - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' - GooglePrivacyDlpV2ActionDetails: - description: The results of an Action. - type: object - properties: - deidentifyDetails: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' - description: Outcome of a de-identification action. - id: GooglePrivacyDlpV2ActionDetails - GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails: - id: GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails - properties: - requestedPrivacyMetric: - $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' - description: Privacy metric to compute. - categoricalStatsResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsResult' - description: Categorical stats result - requestedOptions: - description: The configuration used for this job. - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedRiskAnalysisOptions' - numericalStatsResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsResult' - description: Numerical stats result - kMapEstimationResult: - description: K-map result - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationResult' - deltaPresenceEstimationResult: - description: Delta-presence result - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationResult' - requestedSourceTable: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Input dataset to compute metrics over. - kAnonymityResult: - description: K-anonymity result - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityResult' - lDiversityResult: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityResult' - description: L-divesity result - description: Result of a risk analysis operation request. - type: object - GooglePrivacyDlpV2HybridInspectJobTriggerRequest: - description: Request to search for potentially sensitive info in a custom location. - properties: - hybridItem: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' - id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' type: object - GooglePrivacyDlpV2DateShiftConfig: + GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: type: object - id: GooglePrivacyDlpV2DateShiftConfig + description: The cadence at which to update data profiles when a schema is modified. properties: - context: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Points to the field that contains the context, for example, an - entity id. If set, must also set cryptoKey. If set, shift will be - consistent for the given context. - lowerBoundDays: - type: integer - format: int32 - description: >- - Required. For example, -5 means shift date to at most 5 days back in - the past. - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + types: description: >- - Causes the shift to be computed based on this key and the context. - This results in the same shift for the same context and crypto_key. - If set, must also set context. Can only be applied to table items. - upperBoundDays: - format: int32 + The type of events to consider when deciding if the table's schema + has been modified and should have the profile updated. Defaults to + NEW_COLUMNS. + type: array + items: + enum: + - SCHEMA_MODIFICATION_UNSPECIFIED + - SCHEMA_NEW_COLUMNS + - SCHEMA_REMOVED_COLUMNS + type: string + enumDescriptions: + - Unused + - >- + Profiles should be regenerated when new columns are added to the + table. Default. + - >- + Profiles should be regenerated when columns are removed from the + table. + frequency: + type: string + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. description: >- - Required. Range of shift in days. Actual shift will be selected at - random within this range (inclusive ends). Negative means shift to - earlier in time. Must not be more than 365250 days (1000 years) each - direction. For example, 3 means shift date to at most 3 days into - the future. - type: integer + How frequently profiles may be updated when schemas are modified. + Defaults to monthly. + id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + GooglePrivacyDlpV2Value: + type: object + properties: + timestampValue: + format: google-datetime + description: timestamp + type: string + dateValue: + description: date + $ref: '#/components/schemas/GoogleTypeDate' + dayOfWeekValue: + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + type: string + description: day of week + stringValue: + description: string + type: string + booleanValue: + description: boolean + type: boolean + timeValue: + $ref: '#/components/schemas/GoogleTypeTimeOfDay' + description: time of day + floatValue: + format: double + description: float + type: number + integerValue: + format: int64 + description: integer + type: string description: >- - Shifts dates by random number of days, with option to be consistent for - the same context. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting - to learn more. - GooglePrivacyDlpV2Trigger: + Set of primitive values supported by the system. Note that for the + purposes of inspection or transformation, the number of bytes considered + to comprise a 'Value' is based on its representation as a UTF-8 encoded + string. For example, if 'integer_value' is set to 123456789, the number + of bytes would be counted as 9, even though an int64 only holds up to 8 + bytes of data. + id: GooglePrivacyDlpV2Value + GooglePrivacyDlpV2CloudStorageRegex: + description: >- + A pattern to match against one or more file stores. At least one pattern + must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. properties: - schedule: - $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' - description: Create a job on a repeating basis based on the elapse of time. - manual: + bucketNameRegex: + type: string description: >- - For use with hybrid jobs. Jobs must be manually created and - finished. - $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' - id: GooglePrivacyDlpV2Trigger - description: What event needs to occur for a new job to be started. - type: object - GooglePrivacyDlpV2PublishSummaryToCscc: - properties: {} - description: >- - Publish the result summary of a DlpJob to [Security Command - Center](https://cloud.google.com/security-command-center). This action - is available for only projects that belong to an organization. This - action publishes the count of finding instances and their infoTypes. The - summary of findings are persisted in Security Command Center and are - governed by [service-specific policies for Security Command - Center](https://cloud.google.com/terms/service-terms). Only a single - instance of this action can be specified. Compatible with: Inspect + Optional. Regex to test the bucket name against. If empty, all + buckets match. Example: "marketing2021" or "(marketing)\d{4}" will + both match the bucket gs://marketing2021 + projectIdRegex: + type: string + description: Optional. For organizations, if unset, will match all projects. type: object - id: GooglePrivacyDlpV2PublishSummaryToCscc - GooglePrivacyDlpV2BigQueryDiscoveryTarget: - description: Target used to match against for discovery with BigQuery tables + id: GooglePrivacyDlpV2CloudStorageRegex + GooglePrivacyDlpV2Regex: properties: - filter: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' - description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - disabled: - description: Tables that match this filter will not have profiles created. - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - cadence: + pattern: + type: string description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' - conditions: + Pattern defining the regular expression. Its syntax + (https://github.com/google/re2/wiki/Syntax) can be found under the + google/re2 repository on GitHub. + groupIndexes: description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' - id: GooglePrivacyDlpV2BigQueryDiscoveryTarget + The index of the submatch to extract as findings. When not + specified, the entire match is returned. No more than 3 may be + included. + items: + type: integer + format: int32 + type: array + id: GooglePrivacyDlpV2Regex + description: Message defining a custom regular expression. type: object - GooglePrivacyDlpV2CharsToIgnore: + GooglePrivacyDlpV2DataProfileJobConfig: + description: >- + Configuration for setting up a job to scan resources for profile + generation. Only one data profile configuration may exist per + organization, folder, or project. The generated data profiles are + retained according to the [data retention policy] + (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). type: object + id: GooglePrivacyDlpV2DataProfileJobConfig properties: - charactersToSkip: - description: Characters to not transform when masking. - type: string - commonCharactersToIgnore: + inspectTemplates: description: >- - Common characters to not transform when masking. Useful to avoid - removing punctuation. - enumDescriptions: - - Unused. - - 0-9 - - A-Z - - a-z - - US Punctuation, one of !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ - - Whitespace character, one of [ \t\n\x0B\f\r] - type: string - enum: - - COMMON_CHARS_TO_IGNORE_UNSPECIFIED - - NUMERIC - - ALPHA_UPPER_CASE - - ALPHA_LOWER_CASE - - PUNCTUATION - - WHITESPACE - description: >- - Characters to skip when doing deidentification of a value. These will be - left alone and skipped. - id: GooglePrivacyDlpV2CharsToIgnore - GooglePrivacyDlpV2Deidentify: - type: object - properties: - cloudStorageOutput: - description: >- - Required. User settable Cloud Storage bucket and folders to store - de-identified files. This field must be set for cloud storage - deidentification. The output Cloud Storage bucket must be different - from the input bucket. De-identified files will overwrite files in - the output path. Form of: gs://bucket/folder/ or gs://bucket - type: string - transformationDetailsStorageConfig: - description: >- - Config for storing transformation details. This is separate from the - de-identified content, and contains metadata about the successful - transformations and/or failures that occurred while de-identifying. - This needs to be set in order for users to access information about - the status of each transformation (see TransformationDetails message - for more information about what is noted). - $ref: >- - #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig - fileTypesToTransform: - type: array + Detection logic for profile generation. Not all template features + are used by profiles. FindingLimits, include_quote and + exclude_info_types have no impact on data profiling. Multiple + templates may be provided if there is data in multiple regions. At + most one template must be specified per-region (including "global"). + Each region is scanned using the applicable template. If no + region-specific template is specified, but a "global" template is + specified, it will be copied to that region and used instead. If no + global or region-specific template is provided for a region with + data, that region's data will not be scanned. For more information, + see + https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. items: type: string - enum: - - FILE_TYPE_UNSPECIFIED - - BINARY_FILE - - TEXT_FILE - - IMAGE - - WORD - - PDF - - AVRO - - CSV - - TSV - - POWERPOINT - - EXCEL - enumDescriptions: - - Includes all files. - - >- - Includes all file extensions not covered by another entry. - Binary scanning attempts to convert the content of the file to - utf_8 to scan the file. If you wish to avoid this fall back, - specify one or more of the other file types in your storage - scan. - - >- - Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, - cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, - go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, - mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, - rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, - xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, - md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, - xsd, yml, yaml. - - >- - Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting - bytes_limit_per_file or bytes_limit_per_file_percent has no - effect on image files. Image inspection is restricted to the - `global`, `us`, `asia`, and `europe` regions. - - >- - Microsoft Word files larger than 30 MB will be scanned as binary - files. Included file extensions: docx, dotx, docm, dotm. Setting - `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no - effect on Word files. - - >- - PDF files larger than 30 MB will be scanned as binary files. - Included file extensions: pdf. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PDF files. - - 'Included file extensions: avro' - - 'Included file extensions: csv' - - 'Included file extensions: tsv' - - >- - Microsoft PowerPoint files larger than 30 MB will be scanned as - binary files. Included file extensions: pptx, pptm, potx, potm, - pot. Setting `bytes_limit_per_file` or - `bytes_limit_per_file_percent` has no effect on PowerPoint - files. - - >- - Microsoft Excel files larger than 30 MB will be scanned as - binary files. Included file extensions: xlsx, xlsm, xltx, xltm. - Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` - has no effect on Excel files. - description: >- - List of user-specified file type groups to transform. If specified, - only the files with these filetypes will be transformed. If empty, - all supported files will be transformed. Supported types may be - automatically added over time. If a file type is set in this field - that isn't supported by the Deidentify action then the job will fail - and will not be successfully created/started. Currently the only - filetypes supported are: IMAGES, TEXT_FILES, CSV, TSV. - transformationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' - description: >- - User specified deidentify templates and configs for structured, - unstructured, and image files. - id: GooglePrivacyDlpV2Deidentify - description: >- - Create a de-identified copy of the requested table or files. A - TransformationDetail will be created for each transformation. If any - rows in BigQuery are skipped during de-identification (transformation - errors or row size exceeds BigQuery insert API limits) they are placed - in the failure output table. If the original row exceeds the BigQuery - insert API limit it will be truncated when written to the failure output - table. The failure output table can be set in the - action.deidentify.output.big_query_output.deidentified_failure_output_table - field, if no table is set, a table will be automatically created in the - same project and dataset as the original table. Compatible with: Inspect - GooglePrivacyDlpV2SchemaModifiedCadence: - properties: - types: type: array + dataProfileActions: items: - enum: - - SQL_SCHEMA_MODIFICATION_UNSPECIFIED - - NEW_COLUMNS - - REMOVED_COLUMNS - type: string - enumDescriptions: - - Unused. - - New columns have appeared. - - Columns have been removed from the table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + type: array + description: Actions to execute at the completion of the job. + location: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' + description: The data to scan. + projectId: description: >- - The types of schema modifications to consider. Defaults to - NEW_COLUMNS. - frequency: - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY + The project that will run the scan. The DLP service account that + exists within this project must have access to all resources that + are profiled, and the Cloud DLP API must be enabled. type: string + GooglePrivacyDlpV2OrConditions: + id: GooglePrivacyDlpV2OrConditions + properties: + minRowCount: description: >- - Frequency to regenerate data profiles when the schema is modified. - Defaults to monthly. - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - description: >- - How frequently to modify the profile when the table's schema is - modified. + Minimum number of rows that should be present before Cloud DLP + profiles a table + format: int32 + type: integer + minAge: + type: string + format: google-duration + description: >- + Minimum age a table must have before Cloud DLP can profile it. Value + must be 1 hour or greater. type: object - id: GooglePrivacyDlpV2SchemaModifiedCadence - GooglePrivacyDlpV2KMapEstimationConfig: description: >- - Reidentifiability metric. This corresponds to a risk model similar to - what is called "journalist risk" in the literature, except the attack - dataset is statistically modeled instead of being perfectly known. This - can be done using publicly available data (like the US Census), or using - a custom statistical model (indicated as one or several BigQuery - tables), or by extrapolating from the distribution of values in the - input dataset. - id: GooglePrivacyDlpV2KMapEstimationConfig + There is an OR relationship between these attributes. They are used to + determine if a table should be scanned or not in Discovery. + GooglePrivacyDlpV2ListJobTriggersResponse: + id: GooglePrivacyDlpV2ListJobTriggersResponse + description: Response message for ListJobTriggers. type: object properties: - quasiIds: - description: >- - Required. Fields considered to be quasi-identifiers. No two columns - can have the same tag. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2TaggedField' - type: array - auxiliaryTables: - description: >- - Several auxiliary tables can be used in the analysis. Each - custom_tag used to tag a quasi-identifiers column must appear in - exactly one column of one auxiliary table. + jobTriggers: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2AuxiliaryTable' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' type: array - regionCode: + description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. + nextPageToken: type: string description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. - GooglePrivacyDlpV2JobTrigger: + If the next page is available then this value is the next page token + to be used in the following ListJobTriggers request. + GooglePrivacyDlpV2DeidentifyDataSourceDetails: + id: GooglePrivacyDlpV2DeidentifyDataSourceDetails + description: The results of a Deidentify action from an inspect job. + type: object properties: - updateTime: - format: google-datetime - type: string - readOnly: true - description: Output only. The last update timestamp of a triggeredJob. - triggers: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' - description: >- - A list of triggers which will be OR'ed together. Only one in the - list needs to trigger for a job to be started. The list may contain - only a single Schedule trigger and must have at least one object. - lastRunTime: - format: google-datetime - description: Output only. The timestamp of the last time this trigger executed. - type: string - readOnly: true - inspectJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: For inspect jobs, a snapshot of the configuration. - name: - type: string - description: >- - Unique resource name for the triggeredJob, assigned by the service - when the triggeredJob is created, for example - `projects/dlp-test-project/jobTriggers/53234423`. - createTime: - description: Output only. The creation timestamp of a triggeredJob. - type: string - readOnly: true - format: google-datetime - status: - enum: - - STATUS_UNSPECIFIED - - HEALTHY - - PAUSED - - CANCELLED - description: Required. A status for this trigger. - type: string - enumDescriptions: - - Unused. - - Trigger is healthy. - - Trigger is temporarily paused. - - Trigger is cancelled and can not be resumed. - displayName: - type: string - description: Display name (max 100 chars) - description: - description: User provided description (max 256 chars) - type: string - errors: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - description: >- - Output only. A stream of errors encountered when the trigger was - activated. Repeated errors may result in the JobTrigger - automatically being paused. Will return the last 100 errors. - Whenever the JobTrigger is modified this list will be cleared. - type: array - readOnly: true + requestedOptions: + $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' + description: De-identification config used for the request. + deidentifyStats: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' + description: Stats about the de-identification operation. + GoogleProtobufEmpty: description: >- - Contains a configuration to make API calls on a repeating basis. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers - to learn more. - id: GooglePrivacyDlpV2JobTrigger + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + id: GoogleProtobufEmpty + properties: {} + GooglePrivacyDlpV2PublishSummaryToCscc: + id: GooglePrivacyDlpV2PublishSummaryToCscc + properties: {} + description: >- + Publish the result summary of a DlpJob to [Security Command + Center](https://cloud.google.com/security-command-center). This action + is available for only projects that belong to an organization. This + action publishes the count of finding instances and their infoTypes. The + summary of findings are persisted in Security Command Center and are + governed by [service-specific policies for Security Command + Center](https://cloud.google.com/terms/service-terms). Only a single + instance of this action can be specified. Compatible with: Inspect + type: object + GooglePrivacyDlpV2PublishToSecurityCommandCenter: + properties: {} + type: object + id: GooglePrivacyDlpV2PublishToSecurityCommandCenter + description: >- + If set, a summary finding will be created/updated in SCC for each + profile. + GooglePrivacyDlpV2Schedule: type: object - GooglePrivacyDlpV2QuasiId: - id: GooglePrivacyDlpV2QuasiId - description: A column with a semantic tag attached. properties: - field: - description: Required. Identifies the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - customTag: - description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). + recurrencePeriodDuration: + format: google-duration type: string - inferred: - description: >- - If no semantic tag is indicated, we infer the statistical model from - the distribution of values in the input data - $ref: '#/components/schemas/GoogleProtobufEmpty' - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - A column can be tagged with a InfoType to use the relevant public - dataset as a statistical model of population, if available. We - currently support US ZIP codes, region codes, ages and genders. To - programmatically obtain the list of supported InfoTypes, use - ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + With this option a job is started on a regular periodic basis. For + example: every day (86400 seconds). A scheduled start time will be + skipped if the previous execution has not ended when its scheduled + time occurs. This value must be set to a time duration greater than + or equal to 1 day and can be no longer than 60 days. + description: Schedule for inspect job triggers. + id: GooglePrivacyDlpV2Schedule + GooglePrivacyDlpV2DataProfileAction: type: object - GooglePrivacyDlpV2VersionDescription: properties: - version: - description: Name of the version + tagResources: + description: Tags the profiled resources with the specified tag values. + $ref: '#/components/schemas/GooglePrivacyDlpV2TagResources' + pubSubNotification: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' + description: Publish a message into the Pub/Sub topic. + exportData: + $ref: '#/components/schemas/GooglePrivacyDlpV2Export' + description: Export data profiles into a provided location. + publishToScc: + description: Publishes findings to SCC for each data profile. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2PublishToSecurityCommandCenter + publishToChronicle: + description: >- + Publishes generated data profiles to Google Security Operations. For + more information, see [Use Sensitive Data Protection data in + context-aware + analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToChronicle' + description: A task to execute when a data profile has been generated. + id: GooglePrivacyDlpV2DataProfileAction + GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: + properties: + bucketValues: + type: array + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + description: >- + Sample of quasi-identifier tuple values in this bucket. The total + number of classes returned per bucket is capped at 20. + bucketSize: + format: int64 type: string - description: - description: Description of the version. + description: Number of records within these probability bounds. + maxProbability: + format: double + type: number + description: Always greater than or equal to min_probability. + bucketValueCount: type: string - id: GooglePrivacyDlpV2VersionDescription - description: Details about each available version for an infotype. - type: object - GooglePrivacyDlpV2TransformationErrorHandling: - properties: - leaveUntransformed: - description: Ignore errors - $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' - throwError: - description: Throw an error - $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' - type: object - id: GooglePrivacyDlpV2TransformationErrorHandling + format: int64 + description: >- + Total number of distinct quasi-identifier tuple values in this + bucket. + minProbability: + type: number + description: Between 0 and 1. + format: double + id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket description: >- - How to handle transformation errors during de-identification. A - transformation error occurs when the requested transformation is - incompatible with the data. For example, trying to de-identify an IP - address using a `DateShift` transformation would result in a - transformation error, since date info cannot be extracted from an IP - address. Information about any incompatible transformations, and how - they were handled, is returned in the response as part of the - `TransformationOverviews`. - GooglePrivacyDlpV2BucketingConfig: + A DeltaPresenceEstimationHistogramBucket message with the following + values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means + that there are 42 records for which δ is in [0.1, 0.2). An important + particular case is when min_probability = max_probability = 1: then, + every individual who shares this quasi-identifier combination is in the + dataset. type: object - id: GooglePrivacyDlpV2BucketingConfig - properties: - buckets: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' - type: array - description: Set of buckets. Ranges must be non-overlapping. - description: >- - Generalization function that buckets values based on ranges. The ranges - and replacement values are dynamically provided by the user for custom - behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be - used on data of type: number, long, string, timestamp. If the bound - `Value` type differs from the type of data being transformed, we will - first attempt converting the type of the data to be transformed to match - the type of the bound before comparing. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing - to learn more. - GooglePrivacyDlpV2DataProfileJobConfig: + GooglePrivacyDlpV2CloudStorageRegexFileSet: + id: GooglePrivacyDlpV2CloudStorageRegexFileSet type: object description: >- - Configuration for setting up a job to scan resources for profile - generation. Only one data profile configuration may exist per - organization, folder, or project. The generated data profiles are - retained according to the [data retention policy] - (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). - id: GooglePrivacyDlpV2DataProfileJobConfig + Message representing a set of files in a Cloud Storage bucket. Regular + expressions are used to allow fine-grained control over which files in + the bucket to include. Included files are those that match at least one + item in `include_regex` and do not match any items in `exclude_regex`. + Note that a file that matches items from both lists will _not_ be + included. For a match to occur, the entire file path (i.e., everything + in the url after the bucket name) must match the regular expression. For + example, given the input `{bucket_name: "mybucket", include_regex: + ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * + `gs://mybucket/directory1/myfile` will be included * + `gs://mybucket/directory1/directory2/myfile` will be included (`.*` + matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will + _not_ be included (the full path doesn't match any items in + `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be + included (the path matches an item in `exclude_regex`) If + `include_regex` is left empty, it will match all files by default (this + is equivalent to setting `include_regex: [".*"]`). Some other common use + cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will + include all files in `mybucket` except for .pdf files * `{bucket_name: + "mybucket", include_regex: ["directory/[^/]+"]}` will include all files + directly under `gs://mybucket/directory/`, without matching across `/` properties: - location: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileLocation' - description: The data to scan. - projectId: + excludeRegex: description: >- - The project that will run the scan. The DLP service account that - exists within this project must have access to all resources that - are profiled, and the Cloud DLP API must be enabled. - type: string - dataProfileActions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' - description: Actions to execute at the completion of the job. + A list of regular expressions matching file paths to exclude. All + files in the bucket that match at least one of these regular + expressions will be excluded from the scan. Regular expressions use + RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can + be found under the google/re2 repository on GitHub. type: array - inspectTemplates: items: type: string + includeRegex: description: >- - Detection logic for profile generation. Not all template features - are used by profiles. FindingLimits, include_quote and - exclude_info_types have no impact on data profiling. Multiple - templates may be provided if there is data in multiple regions. At - most one template must be specified per-region (including "global"). - Each region is scanned using the applicable template. If no - region-specific template is specified, but a "global" template is - specified, it will be copied to that region and used instead. If no - global or region-specific template is provided for a region with - data, that region's data will not be scanned. For more information, - see - https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. + A list of regular expressions matching file paths to include. All + files in the bucket that match at least one of these regular + expressions will be included in the set of files, except for those + that also match an item in `exclude_regex`. Leaving this field empty + will match all files by default (this is equivalent to including + `.*` in the list). Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. type: array - GooglePrivacyDlpV2BigQueryTable: - properties: - tableId: + items: + type: string + bucketName: type: string - description: Name of the table. - datasetId: - description: Dataset ID of the table. + description: The name of a Cloud Storage bucket. Required. + GooglePrivacyDlpV2StoredType: + id: GooglePrivacyDlpV2StoredType + type: object + properties: + createTime: + format: google-datetime type: string - projectId: + description: >- + Timestamp indicating when the version of the `StoredInfoType` used + for inspection was created. Output-only field, populated by the + system. + name: type: string description: >- - The Google Cloud Platform project ID of the project containing the - table. If omitted, project ID is inferred from the API call. + Resource name of the requested `StoredInfoType`, for example + `organizations/433245324/storedInfoTypes/432452342` or + `projects/project-id/storedInfoTypes/432452342`. + description: A reference to a StoredInfoType to use with scanning. + GooglePrivacyDlpV2JobNotificationEmails: description: >- - Message defining the location of a BigQuery table. A table is uniquely - identified by its project_id, dataset_id, and table_name. Within a query - a table is often referenced with a string in the format of: `:.` or - `..`. - type: object - id: GooglePrivacyDlpV2BigQueryTable - GooglePrivacyDlpV2ListConnectionsResponse: - id: GooglePrivacyDlpV2ListConnectionsResponse + Sends an email when the job completes. The email goes to IAM project + owners and technical [Essential + Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + id: GooglePrivacyDlpV2JobNotificationEmails type: object + properties: {} + GooglePrivacyDlpV2ImageLocation: + id: GooglePrivacyDlpV2ImageLocation + description: Location of the finding within an image. properties: - connections: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: List of connections. - type: array - nextPageToken: - type: string + boundingBoxes: description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. - description: Response message for ListConnections. - GooglePrivacyDlpV2InfoTypeTransformations: - type: object - properties: - transformations: + Bounding boxes locating the pixels within the image containing the + finding. type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' - description: >- - Required. Transformation for each infoType. Cannot specify more than - one for a given infoType. - description: >- - A type of transformation that will scan unstructured text and apply - various `PrimitiveTransformation`s to each finding, where the - transformation is applied to only values that were identified as a - specific info_type. - id: GooglePrivacyDlpV2InfoTypeTransformations - GooglePrivacyDlpV2Export: + $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' type: object - id: GooglePrivacyDlpV2Export - properties: - profileTable: - description: >- - Store all table and column profiles in an existing table or a new - table in an existing dataset. Each re-generation will result in new - rows in BigQuery. Data is inserted using [streaming - insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) - and so data may be in the buffer for a period of time after the - profile has finished. The Pub/Sub notification is sent before the - streaming buffer is guaranteed to be written, so data may not be - instantly visible to queries by the time your topic receives the - Pub/Sub notification. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + GooglePrivacyDlpV2TimespanConfig: description: >- - If set, the detailed data profiles will be persisted to the location of - your choice whenever updated. - GooglePrivacyDlpV2QuoteInfo: - properties: - dateTime: - $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' - description: The date time indicated by the quote. - description: Message for infoType-dependent details parsed from quote. - id: GooglePrivacyDlpV2QuoteInfo + Configuration of the timespan of the items to include in scanning. + Currently only supported when inspecting Cloud Storage and BigQuery. type: object - GooglePrivacyDlpV2SummaryResult: - id: GooglePrivacyDlpV2SummaryResult + id: GooglePrivacyDlpV2TimespanConfig properties: - details: - type: string + startTime: + format: google-datetime description: >- - A place for warnings or errors to show up if a transformation didn't - work as expected. - code: - enum: - - TRANSFORMATION_RESULT_CODE_UNSPECIFIED - - SUCCESS - - ERROR - enumDescriptions: - - Unused - - Transformation completed without an error. - - Transformation had an error. + Exclude files, tables, or rows older than this value. If not set, no + lower time limit is applied. type: string - description: Outcome of the transformation. - count: - format: int64 + timestampField: + description: >- + Specification of the field containing the timestamp of scanned + items. Used for data sources like Datastore and BigQuery. **For + BigQuery** If this value is not specified and the table was modified + between the given start and end times, the entire table will be + scanned. If this value is specified, then rows are filtered based on + the given start and end times. Rows with a `NULL` value in the + provided BigQuery column are skipped. Valid data types of the + provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and + `DATETIME`. If your BigQuery table is [partitioned at ingestion + time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), + you can use any of the following pseudo-columns as your timestamp + field. When used with Cloud DLP, these pseudo-column names are case + sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - + `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, + then entities are filtered based on the given start and end times. + If an entity does not contain the provided timestamp property or + contains empty or invalid values, then it is included. Valid data + types of the provided timestamp property are: `TIMESTAMP`. See the + [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) + related to this operation. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + endTime: type: string - description: Number of transformations counted by this result. - type: object - description: >- - A collection that informs the user the number of times a particular - `TransformationResultCode` and error details occurred. - GooglePrivacyDlpV2SensitivityScore: - description: >- - Score is calculated from of all elements in the data profile. A higher - level means the data is more sensitive. + format: google-datetime + description: >- + Exclude files, tables, or rows newer than this value. If not set, no + upper time limit is applied. + enableAutoPopulationOfTimespanConfig: + type: boolean + description: >- + When the job is started by a JobTrigger we will automatically figure + out a valid start_time to avoid scanning files that have not been + modified since the last time the JobTrigger executed. This will be + based on the time of the execution of the last run of the JobTrigger + or the timespan end_time used in the last run of the JobTrigger. + **For BigQuery** Inspect jobs triggered by automatic population will + scan data that is at least three hours old when the job starts. This + is because streaming buffer rows are not read during inspection and + reading up to the current timestamp will result in skipped rows. See + the [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) + related to this operation. + GooglePrivacyDlpV2Deidentify: type: object - id: GooglePrivacyDlpV2SensitivityScore - properties: - score: - description: The sensitivity score applied to the resource. - type: string - enumDescriptions: - - Unused. - - >- - No sensitive information detected. The resource isn't publicly - accessible. - - >- - Medium risk. Contains personally identifiable information (PII), - potentially sensitive data, or fields with free-text data that are - at a higher risk of having intermittent sensitive data. Consider - limiting access. - - >- - High risk. Sensitive personally identifiable information (SPII) - can be present. Exfiltration of data can lead to user data loss. - Re-identification of users might be possible. Consider limiting - usage and or removing SPII. - enum: - - SENSITIVITY_SCORE_UNSPECIFIED - - SENSITIVITY_LOW - - SENSITIVITY_MODERATE - - SENSITIVITY_HIGH - GooglePrivacyDlpV2InspectConfig: + id: GooglePrivacyDlpV2Deidentify properties: - minLikelihoodPerInfoType: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' - type: array + cloudStorageOutput: description: >- - Minimum likelihood per infotype. For each infotype, a user can - specify a minimum likelihood. The system only returns a finding if - its likelihood is above this threshold. If this field is not set, - the system uses the InspectConfig min_likelihood. - ruleSet: - type: array + Required. User settable Cloud Storage bucket and folders to store + de-identified files. This field must be set for Cloud Storage + deidentification. The output Cloud Storage bucket must be different + from the input bucket. De-identified files will overwrite files in + the output path. Form of: gs://bucket/folder/ or gs://bucket + type: string + transformationConfig: description: >- - Set of rules to apply to the findings for this InspectConfig. - Exclusion rules, contained in the set are executed in the end, other - rules are executed in the order they are specified for each info - type. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' - limits: + User specified deidentify templates and configs for structured, + unstructured, and image files. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationConfig' + transformationDetailsStorageConfig: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2TransformationDetailsStorageConfig description: >- - Configuration to control the number of findings returned. This is - not used for data profiling. When redacting sensitive data from - images, finding limits don't apply. They can cause unexpected or - inconsistent results, where only some data is redacted. Don't - include finding limits in RedactImage requests. Otherwise, Cloud DLP - returns an error. When set within an InspectJobConfig, the specified - maximum values aren't hard limits. If an inspection job reaches - these limits, the job ends gradually, not abruptly. Therefore, the - actual number of findings that Cloud DLP returns can be multiple - times higher than these maximum values. - $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' - customInfoTypes: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' + Config for storing transformation details. This is separate from the + de-identified content, and contains metadata about the successful + transformations and/or failures that occurred while de-identifying. + This needs to be set in order for users to access information about + the status of each transformation (see TransformationDetails message + for more information about what is noted). + fileTypesToTransform: type: array - description: >- - CustomInfoTypes provided by the user. See - https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes - to learn more. - includeQuote: - type: boolean - description: >- - When true, a contextual quote from the data that triggered a finding - is included in the response; see Finding.quote. This is not used for - data profiling. - contentOptions: - description: Deprecated and unused. items: enumDescriptions: - - Includes entire content of a file or a data stream. - - Text content within the data, excluding any metadata. - - Images found in the data. - enum: - - CONTENT_UNSPECIFIED - - CONTENT_TEXT - - CONTENT_IMAGE + - Includes all files. + - >- + Includes all file extensions not covered by another entry. + Binary scanning attempts to convert the content of the file to + utf_8 to scan the file. If you wish to avoid this fall back, + specify one or more of the other file types in your storage + scan. + - >- + Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, + cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, + go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, + mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, + rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, + xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, + md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, + xsd, yml, yaml. + - >- + Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting + bytes_limit_per_file or bytes_limit_per_file_percent has no + effect on image files. Image inspection is restricted to the + `global`, `us`, `asia`, and `europe` regions. + - >- + Microsoft Word files larger than 30 MB will be scanned as binary + files. Included file extensions: docx, dotx, docm, dotm. Setting + `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no + effect on Word files. + - >- + PDF files larger than 30 MB will be scanned as binary files. + Included file extensions: pdf. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PDF files. + - 'Included file extensions: avro' + - 'Included file extensions: csv' + - 'Included file extensions: tsv' + - >- + Microsoft PowerPoint files larger than 30 MB will be scanned as + binary files. Included file extensions: pptx, pptm, potx, potm, + pot. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PowerPoint + files. + - >- + Microsoft Excel files larger than 30 MB will be scanned as + binary files. Included file extensions: xlsx, xlsm, xltx, xltm. + Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` + has no effect on Excel files. type: string - type: array - infoTypes: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - Restricts what info_types to look for. The values must correspond to - InfoType values returned by ListInfoTypes or listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. - When no InfoTypes or CustomInfoTypes are specified in a request, the - system may automatically choose a default list of detectors to run, - which may change over time. If you need precise control and - predictability as to what detectors are run you should specify - specific InfoTypes listed in the reference, otherwise a default list - will be used, which may change over time. - excludeInfoTypes: - type: boolean - description: >- - When true, excludes type information of the findings. This is not - used for data profiling. - minLikelihood: - enumDescriptions: - - Default value; same as POSSIBLE. - - Highest chance of a false positive. - - High chance of a false positive. - - Some matching signals. The default value. - - Low chance of a false positive. - - Confidence level is high. Lowest chance of a false positive. + enum: + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL description: >- - Only returns findings equal to or above this threshold. The default - is POSSIBLE. In general, the highest likelihood setting yields the - fewest findings in results and the lowest chance of a false - positive. For more information, see [Match - likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY - type: string + List of user-specified file type groups to transform. If specified, + only the files with these file types will be transformed. If empty, + all supported files will be transformed. Supported types may be + automatically added over time. If a file type is set in this field + that isn't supported by the Deidentify action then the job will fail + and will not be successfully created/started. Currently the only + file types supported are: IMAGES, TEXT_FILES, CSV, TSV. description: >- - Configuration description of the scanning process. When used with - redactContent only info_types and min_likelihood are currently used. - type: object - id: GooglePrivacyDlpV2InspectConfig - GooglePrivacyDlpV2InspectTemplate: - type: object - id: GooglePrivacyDlpV2InspectTemplate + Create a de-identified copy of the requested table or files. A + TransformationDetail will be created for each transformation. If any + rows in BigQuery are skipped during de-identification (transformation + errors or row size exceeds BigQuery insert API limits) they are placed + in the failure output table. If the original row exceeds the BigQuery + insert API limit it will be truncated when written to the failure output + table. The failure output table can be set in the + action.deidentify.output.big_query_output.deidentified_failure_output_table + field, if no table is set, a table will be automatically created in the + same project and dataset as the original table. Compatible with: Inspect + GooglePrivacyDlpV2HotwordRule: properties: - displayName: - type: string - description: Display name (max 256 chars). - updateTime: - format: google-datetime - type: string - description: Output only. The last update timestamp of an inspectTemplate. - readOnly: true - description: - type: string - description: Short description (max 256 chars). - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: >- - The core content of the template. Configuration of the scanning - process. - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. The creation timestamp of an inspectTemplate. - name: + proximity: + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - readOnly: true - type: string - description: >- - The inspectTemplate contains a configuration (set of types of sensitive - data to be detected) to be used anywhere you otherwise would normally - specify InspectConfig. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - GooglePrivacyDlpV2Dictionary: + Range of characters within which the entire hotword must reside. The + total length of the window cannot exceed 1000 characters. The + finding itself will be included in the window, so that hotwords can + be used to match substrings of the finding itself. Suppose you want + Cloud DLP to promote the likelihood of the phone number regex + "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area + code of a company's office. In this case, use the hotword regex + "\(xxx\)", where "xxx" is the area code in question. For tabular + data, if you want to modify the likelihood of an entire column of + findngs, see [Hotword example: Set the match likelihood of a table + column] + (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + likelihoodAdjustment: + description: Likelihood adjustment to apply to all matching findings. + $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' + hotwordRegex: + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + description: Regular expression pattern defining what qualifies as a hotword. type: object - id: GooglePrivacyDlpV2Dictionary - properties: - cloudStoragePath: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' - description: >- - Newline-delimited file of words in Cloud Storage. Only a single file - is accepted. - wordList: - $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' - description: List of words or phrases to search for. description: >- - Custom information type based on a dictionary of words or phrases. This - can be used to match sensitive information specific to the data, such as - a list of employee IDs or job titles. Dictionary words are - case-insensitive and all characters other than letters and digits in the - unicode [Basic Multilingual - Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) - will be replaced with whitespace when scanning for matches, so the - dictionary phrase "Sam Johnson" will match all three phrases "sam - johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the - characters surrounding any match must be of a different type than the - adjacent characters within the word, so letters must be next to - non-letters and digits next to non-digits. For example, the dictionary - word "jen" will match the first three letters of the text "jen123" but - will return no matches for "jennifer". Dictionary words containing a - large number of characters that are not letters or digits may result in - unexpected findings because such characters are treated as whitespace. - The [limits](https://cloud.google.com/sensitive-data-protection/limits) - page contains details about the size limits of dictionaries. For - dictionaries that do not fit within these constraints, consider using - `LargeCustomDictionaryConfig` in the `StoredInfoType` API. - GooglePrivacyDlpV2BigQueryTableCollection: - description: Specifies a collection of BigQuery tables. Used for Discovery. - type: object + The rule that adjusts the likelihood of findings within a certain + proximity of hotwords. + id: GooglePrivacyDlpV2HotwordRule + GooglePrivacyDlpV2TagCondition: properties: - includeRegexes: + sensitivityScore: description: >- - A collection of regular expressions to match a BigQuery table - against. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' - id: GooglePrivacyDlpV2BigQueryTableCollection - GooglePrivacyDlpV2TimespanConfig: - description: >- - Configuration of the timespan of the items to include in scanning. - Currently only supported when inspecting Cloud Storage and BigQuery. + Conditions attaching the tag to a resource on its profile having + this sensitivity score. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + tag: + $ref: '#/components/schemas/GooglePrivacyDlpV2TagValue' + description: The tag value to attach to resources. type: object + id: GooglePrivacyDlpV2TagCondition + description: >- + The tag to attach to profiles matching the condition. At most one + `TagCondition` can be specified per sensitivity level. + GooglePrivacyDlpV2ListStoredInfoTypesResponse: + id: GooglePrivacyDlpV2ListStoredInfoTypesResponse properties: - endTime: - format: google-datetime - description: >- - Exclude files, tables, or rows newer than this value. If not set, no - upper time limit is applied. - type: string - startTime: + nextPageToken: type: string - format: google-datetime description: >- - Exclude files, tables, or rows older than this value. If not set, no - lower time limit is applied. - enableAutoPopulationOfTimespanConfig: + If the next page is available then the next page token to be used in + the following ListStoredInfoTypes request. + storedInfoTypes: + type: array description: >- - When the job is started by a JobTrigger we will automatically figure - out a valid start_time to avoid scanning files that have not been - modified since the last time the JobTrigger executed. This will be - based on the time of the execution of the last run of the JobTrigger - or the timespan end_time used in the last run of the JobTrigger. - **For BigQuery** Inspect jobs triggered by automatic population will - scan data that is at least three hours old when the job starts. This - is because streaming buffer rows are not read during inspection and - reading up to the current timestamp will result in skipped rows. See - the [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) - related to this operation. - type: boolean - timestampField: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Specification of the field containing the timestamp of scanned - items. Used for data sources like Datastore and BigQuery. *For - BigQuery* If this value is not specified and the table was modified - between the given start and end times, the entire table will be - scanned. If this value is specified, then rows are filtered based on - the given start and end times. Rows with a `NULL` value in the - provided BigQuery column are skipped. Valid data types of the - provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and - `DATETIME`. If your BigQuery table is [partitioned at ingestion - time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), - you can use any of the following pseudo-columns as your timestamp - field. When used with Cloud DLP, these pseudo-column names are case - sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME - *For Datastore* If this value is specified, then entities are - filtered based on the given start and end times. If an entity does - not contain the provided timestamp property or contains empty or - invalid values, then it is included. Valid data types of the - provided timestamp property are: `TIMESTAMP`. See the [known - issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) - related to this operation. - id: GooglePrivacyDlpV2TimespanConfig - GooglePrivacyDlpV2InfoTypeCategory: + List of storedInfoTypes, up to page_size in + ListStoredInfoTypesRequest. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + type: object + description: Response message for ListStoredInfoTypes. + GooglePrivacyDlpV2RedactConfig: + properties: {} type: object + id: GooglePrivacyDlpV2RedactConfig + description: >- + Redact a given value. For example, if used with an + `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone + number is 206-555-0123', the output would be 'My phone number is '. + GooglePrivacyDlpV2HybridInspectResponse: + description: Quota exceeded errors will be thrown once quota has been met. + id: GooglePrivacyDlpV2HybridInspectResponse + properties: {} + type: object + GooglePrivacyDlpV2TransformationOverview: + type: object + description: Overview of the modifications that occurred. properties: - locationCategory: - description: >- - The region or country that issued the ID or document represented by - the infoType. + transformedBytes: + description: Total size in bytes that were transformed in some way. + format: int64 type: string + transformationSummaries: + description: Transformations applied to the dataset. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationSummary' + id: GooglePrivacyDlpV2TransformationOverview + GooglePrivacyDlpV2PubSubExpressions: + description: An expression, consisting of an operator and conditions. + type: object + id: GooglePrivacyDlpV2PubSubExpressions + properties: + conditions: + type: array + description: Conditions to apply to the expression. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' + logicalOperator: enumDescriptions: - - Unused location - - >- - The infoType is not issued by or tied to a specific region, but is - used almost everywhere. - - The infoType is typically used in Argentina. - - The infoType is typically used in Australia. - - The infoType is typically used in Azerbaijan. - - The infoType is typically used in Belgium. - - The infoType is typically used in Brazil. - - The infoType is typically used in Canada. - - The infoType is typically used in Chile. - - The infoType is typically used in China. - - The infoType is typically used in Colombia. - - The infoType is typically used in Croatia. - - The infoType is typically used in Denmark. - - The infoType is typically used in France. - - The infoType is typically used in Finland. - - The infoType is typically used in Germany. - - The infoType is typically used in Hong Kong. - - The infoType is typically used in India. - - The infoType is typically used in Indonesia. - - The infoType is typically used in Ireland. - - The infoType is typically used in Israel. - - The infoType is typically used in Italy. - - The infoType is typically used in Japan. - - The infoType is typically used in Kazakhstan. - - The infoType is typically used in Korea. - - The infoType is typically used in Mexico. - - The infoType is typically used in the Netherlands. - - The infoType is typically used in New Zealand. - - The infoType is typically used in Norway. - - The infoType is typically used in Paraguay. - - The infoType is typically used in Peru. - - The infoType is typically used in Poland. - - The infoType is typically used in Portugal. - - The infoType is typically used in Russia. - - The infoType is typically used in Singapore. - - The infoType is typically used in South Africa. - - The infoType is typically used in Spain. - - The infoType is typically used in Sweden. - - The infoType is typically used in Switzerland. - - The infoType is typically used in Taiwan. - - The infoType is typically used in Thailand. - - The infoType is typically used in Turkey. - - The infoType is typically used in Ukraine. - - The infoType is typically used in the United Kingdom. - - The infoType is typically used in the United States. - - The infoType is typically used in Uruguay. - - The infoType is typically used in Uzbekistan. - - The infoType is typically used in Venezuela. - - The infoType is typically used in Google internally. + - Unused. + - Conditional OR. + - Conditional AND. enum: - - LOCATION_UNSPECIFIED - - GLOBAL - - ARGENTINA - - AUSTRALIA - - AZERBAIJAN - - BELGIUM - - BRAZIL - - CANADA - - CHILE - - CHINA - - COLOMBIA - - CROATIA - - DENMARK - - FRANCE - - FINLAND - - GERMANY - - HONG_KONG - - INDIA - - INDONESIA - - IRELAND - - ISRAEL - - ITALY - - JAPAN - - KAZAKHSTAN - - KOREA - - MEXICO - - THE_NETHERLANDS - - NEW_ZEALAND - - NORWAY - - PARAGUAY - - PERU - - POLAND - - PORTUGAL - - RUSSIA - - SINGAPORE - - SOUTH_AFRICA - - SPAIN - - SWEDEN - - SWITZERLAND - - TAIWAN - - THAILAND - - TURKEY - - UKRAINE - - UNITED_KINGDOM - - UNITED_STATES - - URUGUAY - - UZBEKISTAN - - VENEZUELA - - INTERNAL - industryCategory: - description: >- - The group of relevant businesses where this infoType is commonly - used - enumDescriptions: - - Unused industry - - The infoType is typically used in the finance industry. - - The infoType is typically used in the health industry. - - The infoType is typically used in the telecommunications industry. + - LOGICAL_OPERATOR_UNSPECIFIED + - OR + - AND type: string - enum: - - INDUSTRY_UNSPECIFIED - - FINANCE - - HEALTH - - TELECOMMUNICATIONS - typeCategory: + description: The operator to apply to the collection of conditions. + GooglePrivacyDlpV2FileStoreDataProfile: + properties: + projectId: + description: The Google Cloud project ID that owns the resource. type: string - description: The class of identifiers where this infoType belongs - enum: - - TYPE_UNSPECIFIED - - PII - - SPII - - DEMOGRAPHIC - - CREDENTIAL - - GOVERNMENT_ID - - DOCUMENT - - CONTEXTUAL_INFORMATION + projectDataProfile: + type: string + description: The resource name of the project data profile for this file store. + state: enumDescriptions: - - Unused type - - >- - Personally identifiable information, for example, a name or phone - number - - >- - Personally identifiable information that is especially sensitive, - for example, a passport number. + - Unused. - >- - Attributes that can partially identify someone, especially in - combination with other attributes, like age, height, and gender. - - Confidential or secret information, for example, a password. - - An identification document issued by a government. - - A document, for example, a resume or source code. + The profile is currently running. Once a profile has finished it + will transition to DONE. - >- - Information that is not sensitive on its own, but provides details - about the circumstances surrounding an entity or an event. - description: >- - Classification of infoTypes to organize them according to geographic - location, industry, and data type. - id: GooglePrivacyDlpV2InfoTypeCategory - GooglePrivacyDlpV2ImageTransformations: - type: object - id: GooglePrivacyDlpV2ImageTransformations - description: A type of transformation that is applied over images. - properties: - transforms: - description: List of transforms to make. - type: array + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + type: string + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + description: State of a profile. + fullResource: + type: string + description: >- + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name + configSnapshot: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + description: The snapshot of the configurations used to generate the profile. + dataStorageLocations: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' - GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: - description: >- - Replaces an identifier with a surrogate using Format Preserving - Encryption (FPE) with the FFX mode of operation; however when used in - the `ReidentifyContent` API method, it serves the opposite function by - reversing the surrogate back into the original identifier. The - identifier must be encoded as ASCII. For a given crypto key and context, - the same identifier will be replaced with the same surrogate. - Identifiers must be at least two characters long. In the case that the - identifier is the empty string, it will be skipped. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization - to learn more. Note: We recommend using CryptoDeterministicConfig for - all use cases which do not require preserving the input alphabet space - and size, plus warrant referential integrity. - type: object - id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig - properties: - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - description: Required. The key used by the encryption algorithm. - customAlphabet: + type: string description: >- - This is supported by mapping these to the alphanumeric characters - that the FFX mode natively supports. This happens before/after - encryption/decryption. Each character listed must appear only once. - Number of characters must be in the range [2, 95]. This must be - encoded as ASCII. The order of characters does not matter. The full - list of allowed characters is: - 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz - ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ - type: string - context: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + For resources that have multiple storage locations, these are those + regions. For Cloud Storage this is the list of regions chosen for + dual-region storage. `file_store_location` will normally be the + corresponding multi-region for the list of individual locations. The + first region is always picked as the processing and storage location + for the data profile. + type: array + profileStatus: description: >- - The 'tweak', a context may be used for higher security since the - same identifier in two different contexts won't be given the same - surrogate. If the context is not set, a default tweak will be used. - If the context is set but: 1. there is no record present when - transforming a given value or 1. the field is not present when - transforming a given value, a default tweak will be used. Note that - case (1) is expected when an `InfoTypeTransformation` is applied to - both structured and unstructured `ContentItem`s. Currently, the - referenced field may be of value type integer or string. The tweak - is constructed as a sequence of bytes in big endian byte order such - that: - a 64 bit integer is encoded followed by a single byte of - value 1 - a string is encoded in UTF-8 format followed by a single - byte of value 2 - radix: - type: integer - format: int32 - description: The native way to select the alphabet. Must be in the range [2, 95]. - surrogateInfoType: + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + resourceAttributes: description: >- - The custom infoType to annotate the surrogate with. This annotation - will be applied to the surrogate by prefixing it with the name of - the custom infoType followed by the number of characters comprising - the surrogate. The following scheme defines the format: - info_type_name(surrogate_character_count):surrogate For example, if - the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the - surrogate is 'abc', the full replacement value will be: - 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom infoType - [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). - This facilitates reversal of the surrogate when it occurs in free - text. In order for inspection to work properly, the name of this - infoType must not occur naturally anywhere in your data; otherwise, - inspection may find a surrogate that does not correspond to an - actual identifier. Therefore, choose your custom infoType name - carefully after considering what your data looks like. One way to - select a name that has a high chance of yielding reliable detection - is to include one or more unicode characters that are highly - improbable to exist in your data. For example, assuming your data is - entered from a regular ASCII keyboard, the symbol with the hex code - point 29DD might be used like so: ⧝MY_TOKEN_TYPE - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - commonAlphabet: - enumDescriptions: - - Unused. - - '`[0-9]` (radix of 10)' - - '`[0-9A-F]` (radix of 16)' - - '`[0-9A-Z]` (radix of 36)' - - '`[0-9A-Za-z]` (radix of 62)' + Attributes of the resource being profiled. Currently used + attributes: * customer_managed_encryption: boolean - true: the + resource is encrypted with a customer-managed key. - false: the + resource is encrypted with a provider-managed key. + type: object + additionalProperties: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + profileLastGenerated: type: string - description: Common alphabets. - enum: - - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED - - NUMERIC - - HEXADECIMAL - - UPPER_CASE_ALPHA_NUMERIC - - ALPHA_NUMERIC - GooglePrivacyDlpV2KMapEstimationResult: - description: >- - Result of the reidentifiability analysis. Note that these results are an - estimation, not exact values. - id: GooglePrivacyDlpV2KMapEstimationResult - properties: - kMapEstimationHistogram: - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + format: google-datetime + description: The last time the profile was generated. + fileStorePath: + type: string + description: 'The file store path. * Cloud Storage: `gs://{bucket}`' + createTime: + format: google-datetime + description: The time the file store was first created. + type: string + fileStoreLocation: description: >- - The intervals [min_anonymity, max_anonymity] do not overlap. If a - value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: - 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, - max_anonymity: 10, frequency: 99} mean that there are no record with - an estimated anonymity of 4, 5, or larger than 10. - type: array - type: object - GooglePrivacyDlpV2DocumentLocation: - id: GooglePrivacyDlpV2DocumentLocation - properties: - fileOffset: - format: int64 + The location of the file store. * Cloud Storage: + https://cloud.google.com/storage/docs/locations#available-locations type: string + dataSourceType: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + description: The resource type that was profiled. + resourceLabels: description: >- - Offset of the line, from the beginning of the file, where the - finding is located. - description: Location of a finding within a document. - type: object - GooglePrivacyDlpV2ReplaceValueConfig: - description: Replace each input value with a given `Value`. - properties: - newValue: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Value to replace it with. - type: object - id: GooglePrivacyDlpV2ReplaceValueConfig - GooglePrivacyDlpV2BigQueryRegex: - id: GooglePrivacyDlpV2BigQueryRegex - properties: - projectIdRegex: + The labels applied to the resource at the time the profile was + generated. + type: object + additionalProperties: + type: string + fileClusterSummaries: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterSummary' + description: FileClusterSummary per each cluster. + locationType: type: string description: >- - For organizations, if unset, will match all projects. Has no effect - for data profile configurations created within a project. - datasetIdRegex: + The location type of the bucket (region, dual-region, multi-region, + etc). If dual-region, expect data_storage_locations to be populated. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The sensitivity score of this resource. + dataRiskLevel: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + description: The data risk level of this resource. + lastModifiedTime: + description: The time the file store was last modified. type: string - description: If unset, this property matches all datasets. - tableIdRegex: - description: If unset, this property matches all tables. + format: google-datetime + fileStoreInfoTypeSummaries: + description: InfoTypes detected in this file store. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' + type: array + resourceVisibility: + description: How broadly a resource has been shared. + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED type: string - description: >- - A pattern to match against one or more tables, datasets, or projects - that contain BigQuery tables. At least one pattern must be specified. - Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. + enumDescriptions: + - Unused. + - Visible to any user. + - >- + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. + name: + type: string + description: The name of the profile. + fileStoreIsEmpty: + type: boolean + description: The file store does not have any files. + id: GooglePrivacyDlpV2FileStoreDataProfile + description: 'The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.' type: object - GooglePrivacyDlpV2UpdateConnectionRequest: - description: Request message for UpdateConnection. + GooglePrivacyDlpV2DataProfileLocation: + description: The data that will be profiled. type: object + id: GooglePrivacyDlpV2DataProfileLocation properties: - connection: - description: Required. The connection with new values for the relevant fields. - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - updateMask: + organizationId: + format: int64 type: string - description: Optional. Mask to control which fields get updated. - format: google-fieldmask - id: GooglePrivacyDlpV2UpdateConnectionRequest - GooglePrivacyDlpV2TimePartConfig: - properties: - partToExtract: - enum: - - TIME_PART_UNSPECIFIED - - YEAR - - MONTH - - DAY_OF_MONTH - - DAY_OF_WEEK - - WEEK_OF_YEAR - - HOUR_OF_DAY - enumDescriptions: - - Unused - - '[0-9999]' - - '[1-12]' - - '[1-31]' - - '[1-7]' - - '[1-53]' - - '[0-23]' + description: The ID of an organization to scan. + folderId: + description: The ID of the folder within an organization to scan. type: string - description: The part of the time to keep. - id: GooglePrivacyDlpV2TimePartConfig - description: >- - For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a - portion of the value. + format: int64 + GooglePrivacyDlpV2TransformationErrorHandling: type: object - GooglePrivacyDlpV2CryptoKey: - id: GooglePrivacyDlpV2CryptoKey + id: GooglePrivacyDlpV2TransformationErrorHandling description: >- - This is a data encryption key (DEK) (as opposed to a key encryption key - (KEK) stored by Cloud Key Management Service (Cloud KMS). When using - Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM - policy on the KEK to ensure an attacker cannot unwrap the DEK. + How to handle transformation errors during de-identification. A + transformation error occurs when the requested transformation is + incompatible with the data. For example, trying to de-identify an IP + address using a `DateShift` transformation would result in a + transformation error, since date info cannot be extracted from an IP + address. Information about any incompatible transformations, and how + they were handled, is returned in the response as part of the + `TransformationOverviews`. + properties: + leaveUntransformed: + $ref: '#/components/schemas/GooglePrivacyDlpV2LeaveUntransformed' + description: Ignore errors + throwError: + description: Throw an error + $ref: '#/components/schemas/GooglePrivacyDlpV2ThrowError' + GooglePrivacyDlpV2BigQueryKey: + id: GooglePrivacyDlpV2BigQueryKey + description: Row key for identifying a record in BigQuery table. type: object properties: - unwrapped: - description: Unwrapped crypto key - $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' - kmsWrapped: - $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' - description: Key wrapped using Cloud KMS - transient: - description: Transient crypto key - $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' - GooglePrivacyDlpV2LargeCustomDictionaryConfig: - properties: - outputPath: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' - description: >- - Location to store dictionary artifacts in Cloud Storage. These files - will only be accessible by project owners and the DLP API. If any of - these artifacts are modified, the dictionary is considered invalid - and can no longer be used. - cloudStorageFileSet: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' - description: >- - Set of files containing newline-delimited lists of dictionary - phrases. - bigQueryField: + rowNumber: description: >- - Field in a BigQuery table where each cell represents a dictionary - phrase. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' - description: >- - Configuration for a custom dictionary created from a data source of any - size up to the maximum size defined in the - [limits](https://cloud.google.com/sensitive-data-protection/limits) - page. The artifacts of dictionary creation are stored in the specified - Cloud Storage location. Consider using `CustomInfoType.Dictionary` for - smaller dictionaries that satisfy the size requirements. - type: object - id: GooglePrivacyDlpV2LargeCustomDictionaryConfig - GooglePrivacyDlpV2InfoTypeStats: - id: GooglePrivacyDlpV2InfoTypeStats - description: Statistics regarding a specific InfoType. - type: object - properties: - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The type of finding this stat is for. - count: - type: string - description: Number of findings for this infoType. + Row number inferred at the time the table was scanned. This value is + nondeterministic, cannot be queried, and may be null for inspection + jobs. To locate findings within a table, specify + `inspect_job.storage_config.big_query_options.identifying_fields` in + `CreateDlpJobRequest`. format: int64 - GooglePrivacyDlpV2InspectionRuleSet: - type: object - description: >- - Rule set for modifying a set of infoTypes to alter behavior under - certain circumstances, depending on the specific details of the rules - within the set. + type: string + tableReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Complete BigQuery table reference. + GooglePrivacyDlpV2DiscoveryTableModifiedCadence: properties: - infoTypes: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: List of infoTypes this rule set is applied to. - rules: + types: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' + enum: + - TABLE_MODIFICATION_UNSPECIFIED + - TABLE_MODIFIED_TIMESTAMP + enumDescriptions: + - Unused. + - >- + A table will be considered modified when the last_modified_time + from BigQuery has been updated. + type: string description: >- - Set of rules to be applied to infoTypes. The rules are applied in - order. + The type of events to consider when deciding if the table has been + modified and should have the profile updated. Defaults to + MODIFIED_TIMESTAMP. type: array - id: GooglePrivacyDlpV2InspectionRuleSet - GooglePrivacyDlpV2RedactConfig: - type: object - description: >- - Redact a given value. For example, if used with an - `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone - number is 206-555-0123', the output would be 'My phone number is '. - id: GooglePrivacyDlpV2RedactConfig - properties: {} - GooglePrivacyDlpV2ImageRedactionConfig: - properties: - redactAllText: - type: boolean - description: >- - If true, all text found in the image, regardless whether it matches - an info_type, is redacted. Only one should be provided. - redactionColor: - description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + frequency: description: >- - Only one per info_type should be provided per request. If not - specified, and redact_all_text is false, the DLP API will redact all - text that it matches against all info_types that are found, but not - specified in another ImageRedactionConfig. + How frequently data profiles can be updated when tables are + modified. Defaults to never. + enumDescriptions: + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + enum: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + type: string type: object - id: GooglePrivacyDlpV2ImageRedactionConfig - description: Configuration for determining how redaction of images should occur. - GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket: + id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence + description: The cadence at which to update data profiles when a table is modified. + GooglePrivacyDlpV2DeidentifyContentRequest: type: object - id: GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket - description: >- - A DeltaPresenceEstimationHistogramBucket message with the following - values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means - that there are 42 records for which δ is in [0.1, 0.2). An important - particular case is when min_probability = max_probability = 1: then, - every individual who shares this quasi-identifier combination is in the - dataset. + description: Request to de-identify a ContentItem. properties: - minProbability: - description: Between 0 and 1. - format: double - type: number - bucketSize: - description: Number of records within these probability bounds. - type: string - format: int64 - bucketValueCount: - format: int64 + item: + description: >- + The item to de-identify. Will be treated as text. This value must be + of type Table if your deidentify_config is a RecordTransformations + object. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + deidentifyTemplateName: type: string description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - bucketValues: - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + Template to use. Any configuration directly specified in + deidentify_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. - type: array - maxProbability: - type: number - format: double - description: Always greater than or equal to min_probability. - GooglePrivacyDlpV2DiscoveryCloudSqlFilter: - id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter - properties: - others: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' + Configuration for the inspector. Items specified here will override + the template referenced by the inspect_template_name argument. + deidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' description: >- - Catch-all. This should always be the last target in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. - collection: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' - description: A specific set of database resources for this filter to apply to. - databaseResourceReference: + Configuration for the de-identification of the content item. Items + specified here will override the template referenced by the + deidentify_template_name argument. + locationId: + type: string + description: Deprecated. This field has no effect. + inspectTemplateName: + type: string description: >- - The database resource to scan. Targets including this can only - include one target (the target with this database resource - reference). - $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' + Template to use. Any configuration directly specified in + inspect_config will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + id: GooglePrivacyDlpV2DeidentifyContentRequest + GooglePrivacyDlpV2RecordSuppression: type: object + properties: + condition: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' + description: >- + A condition that when it evaluates to true will result in the record + being evaluated to be suppressed from the transformed content. + id: GooglePrivacyDlpV2RecordSuppression description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, location, instance, database, and - database resource name. - GooglePrivacyDlpV2CryptoHashConfig: - id: GooglePrivacyDlpV2CryptoHashConfig - description: >- - Pseudonymization method that generates surrogates via cryptographic - hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. - Outputs a base64 encoded representation of the hashed output (for - example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only - string and integer values can be hashed. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization - to learn more. - type: object + Configuration to suppress records whose suppression conditions evaluate + to true. + GooglePrivacyDlpV2BigQueryField: properties: - cryptoKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' - description: The key used by the hash function. - GooglePrivacyDlpV2KMapEstimationQuasiIdValues: + field: + description: Designated field in the BigQuery table. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + table: + description: Source table of the field. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Message defining a field of a BigQuery table. + id: GooglePrivacyDlpV2BigQueryField + type: object + GooglePrivacyDlpV2ByteContentItem: + type: object + description: Container for bytes to inspect or redact. + id: GooglePrivacyDlpV2ByteContentItem properties: - estimatedAnonymity: - format: int64 - description: The estimated anonymity for these quasi-identifier values. + type: + enumDescriptions: + - Unused + - Any image type. + - jpeg + - bmp + - png + - svg + - plain text + - docx, docm, dotx, dotm + - pdf + - pptx, pptm, potx, potm, pot + - xlsx, xlsm, xltx, xltm + - avro + - csv + - tsv + - Audio file types. Only used for profiling. + - Video file types. Only used for profiling. + - Executable file types. Only used for profiling. + enum: + - BYTES_TYPE_UNSPECIFIED + - IMAGE + - IMAGE_JPEG + - IMAGE_BMP + - IMAGE_PNG + - IMAGE_SVG + - TEXT_UTF8 + - WORD_DOCUMENT + - PDF + - POWERPOINT_DOCUMENT + - EXCEL_DOCUMENT + - AVRO + - CSV + - TSV + - AUDIO + - VIDEO + - EXECUTABLE type: string - quasiIdsValues: - type: array - description: The quasi-identifier values. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: A tuple of values for the quasi-identifier columns. - id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues + description: >- + The type of data stored in the bytes string. Default will be + TEXT_UTF8. + data: + type: string + description: Content data to inspect or redact. + format: byte + GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: + id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig + properties: {} + description: Replace each matching finding with the name of the info_type. type: object - GooglePrivacyDlpV2TimeZone: + GooglePrivacyDlpV2OrgConfig: + description: >- + Project and scan location information. Only set when the parent is an + org. + id: GooglePrivacyDlpV2OrgConfig properties: - offsetMinutes: - format: int32 + projectId: + type: string description: >- - Set only if the offset can be determined. Positive for time ahead of - UTC. E.g. For "UTC-9", this value is -540. - type: integer + The project that will run the scan. The DLP service account that + exists within this project must have access to all resources that + are profiled, and the Cloud DLP API must be enabled. + location: + description: 'The data to scan: folder, org, or project' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryStartingLocation' type: object - id: GooglePrivacyDlpV2TimeZone - description: Time zone of the date time object. - GooglePrivacyDlpV2RedactImageRequest: + GooglePrivacyDlpV2CreateDiscoveryConfigRequest: + description: Request message for CreateDiscoveryConfig. + id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest type: object properties: - byteItem: - $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' - description: The content must be PNG, JPEG, SVG or BMP. - includeFindings: - type: boolean + configId: description: >- - Whether the response should include findings along with the redacted - image. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: Configuration for the inspector. - locationId: + The config ID can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. type: string - description: Deprecated. This field has no effect. - imageRedactionConfigs: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' - type: array - description: The configuration for specifying what content to redact from images. - id: GooglePrivacyDlpV2RedactImageRequest - description: >- - Request to search for potentially sensitive info in an image and redact - it by covering it with a colored rectangle. - GooglePrivacyDlpV2CategoricalStatsConfig: - type: object - properties: - field: - description: >- - Field to compute categorical stats on. All column types are - supported except for arrays and structs. However, it may be more - informative to use NumericalStats when the field type is supported, - depending on the data. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Compute numerical stats over an individual column, including number of - distinct values and value count distribution. - id: GooglePrivacyDlpV2CategoricalStatsConfig - GooglePrivacyDlpV2SecretsDiscoveryTarget: - id: GooglePrivacyDlpV2SecretsDiscoveryTarget + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: Required. The DiscoveryConfig to create. + GooglePrivacyDlpV2ActivateJobTriggerRequest: type: object + description: Request message for ActivateJobTrigger. + id: GooglePrivacyDlpV2ActivateJobTriggerRequest properties: {} - description: >- - Discovery target for credentials and secrets in cloud resource metadata. - This target does not include any filtering or frequency controls. Cloud - DLP will scan cloud resource metadata for secrets daily. No inspect - template should be included in the discovery config for a security - benchmarks scan. Instead, the built-in list of secrets and credentials - infoTypes will be used (see - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). - Credentials and secrets discovered will be reported as vulnerabilities - to Security Command Center. - GooglePrivacyDlpV2KAnonymityConfig: - type: object + GooglePrivacyDlpV2InspectConfig: properties: - quasiIds: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + limits: + $ref: '#/components/schemas/GooglePrivacyDlpV2FindingLimits' description: >- - Set of fields to compute k-anonymity over. When multiple fields are - specified, they are considered a single composite key. Structs and - repeated data types are not supported; however, nested fields are - supported so long as they are not structs themselves or nested - within a repeated field. + Configuration to control the number of findings returned. This is + not used for data profiling. When redacting sensitive data from + images, finding limits don't apply. They can cause unexpected or + inconsistent results, where only some data is redacted. Don't + include finding limits in RedactImage requests. Otherwise, Cloud DLP + returns an error. When set within an InspectJobConfig, the specified + maximum values aren't hard limits. If an inspection job reaches + these limits, the job ends gradually, not abruptly. Therefore, the + actual number of findings that Cloud DLP returns can be multiple + times higher than these maximum values. + contentOptions: + items: + enum: + - CONTENT_UNSPECIFIED + - CONTENT_TEXT + - CONTENT_IMAGE + type: string + enumDescriptions: + - Includes entire content of a file or a data stream. + - Text content within the data, excluding any metadata. + - Images found in the data. type: array - entityId: - description: >- - Message indicating that multiple rows might be associated to a - single individual. If the same entity_id is associated to multiple - quasi-identifier tuples over distinct rows, we consider the entire - collection of tuples as the composite quasi-identifier. This - collection is a multiset: the order in which the different tuples - appear in the dataset is ignored, but their frequency is taken into - account. Important note: a maximum of 1000 rows can be associated to - a single entity ID. If more rows are associated with the same entity - ID, some might be ignored. - $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' - id: GooglePrivacyDlpV2KAnonymityConfig - description: k-anonymity metric, used for analysis of reidentification risk. - GooglePrivacyDlpV2DeidentifyDataSourceDetails: - description: The results of a Deidentify action from an inspect job. - type: object - id: GooglePrivacyDlpV2DeidentifyDataSourceDetails - properties: - requestedOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2RequestedDeidentifyOptions' - description: De-identification config used for the request. - deidentifyStats: - description: Stats about the de-identification operation. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceStats' - GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: - description: A tuple of values for the quasi-identifier columns. - type: object - properties: - estimatedProbability: - type: number - format: double + description: Deprecated and unused. + includeQuote: description: >- - The estimated probability that a given individual sharing these - quasi-identifier values is in the dataset. This value, typically - called δ, is the ratio between the number of records in the dataset - with these quasi-identifier values, and the total number of - individuals (inside *and* outside the dataset) with these - quasi-identifier values. For example, if there are 15 individuals in - the dataset who share the same quasi-identifier values, and an - estimated 100 people in the entire population with these values, - then δ is 0.15. - quasiIdsValues: + When true, a contextual quote from the data that triggered a finding + is included in the response; see Finding.quote. This is not used for + data profiling. + type: boolean + customInfoTypes: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: The quasi-identifier values. + $ref: '#/components/schemas/GooglePrivacyDlpV2CustomInfoType' type: array - id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues - GooglePrivacyDlpV2DatastoreOptions: - description: Options defining a data set within Google Cloud Datastore. - type: object - id: GooglePrivacyDlpV2DatastoreOptions - properties: - partitionId: description: >- - A partition ID identifies a grouping of entities. The grouping is - always by project and namespace, however the namespace ID may be - empty. - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' - kind: - description: The kind to process. - $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' - GooglePrivacyDlpV2PubSubExpressions: - id: GooglePrivacyDlpV2PubSubExpressions - properties: - conditions: - type: array + CustomInfoTypes provided by the user. See + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes + to learn more. + minLikelihoodPerInfoType: items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubCondition' - description: Conditions to apply to the expression. - logicalOperator: - description: The operator to apply to the collection of conditions. - enumDescriptions: - - Unused. - - Conditional OR. - - Conditional AND. - type: string - enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - OR - - AND - description: An expression, consisting of an operator and conditions. - type: object - GooglePrivacyDlpV2LDiversityResult: - type: object - properties: - sensitiveValueFrequencyHistogramBuckets: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeLikelihood' description: >- - Histogram of l-diversity equivalence class sensitive value - frequencies. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityHistogramBucket' + Minimum likelihood per infotype. For each infotype, a user can + specify a minimum likelihood. The system only returns a finding if + its likelihood is above this threshold. If this field is not set, + the system uses the InspectConfig min_likelihood. type: array - description: Result of the l-diversity computation. - id: GooglePrivacyDlpV2LDiversityResult - GooglePrivacyDlpV2CloudStoragePath: - properties: - path: - type: string + infoTypes: description: >- - A URL representing a file or path (no wildcards) in Cloud Storage. - Example: `gs://[BUCKET_NAME]/dictionary.txt` - type: object - description: Message representing a single file or path in Cloud Storage. - id: GooglePrivacyDlpV2CloudStoragePath - GooglePrivacyDlpV2CloudSqlDiscoveryTarget: - type: object - description: Target used to match against for discovery with Cloud SQL tables. - properties: - generationCadence: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence + Restricts what info_types to look for. The values must correspond to + InfoType values returned by ListInfoTypes or listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. + When no InfoTypes or CustomInfoTypes are specified in a request, the + system may automatically choose a default list of detectors to run, + which may change over time. If you need precise control and + predictability as to what detectors are run you should specify + specific InfoTypes listed in the reference, otherwise a default list + will be used, which may change over time. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + minLikelihood: + type: string + enumDescriptions: + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY description: >- - How often and when to update profiles. New tables that match both - the filter and conditions are scanned as quickly as possible - depending on system capacity. - conditions: + Only returns findings equal to or above this threshold. The default + is POSSIBLE. In general, the highest likelihood setting yields the + fewest findings in results and the lowest chance of a false + positive. For more information, see [Match + likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood). + excludeInfoTypes: description: >- - In addition to matching the filter, these conditions must be true - before a profile is generated. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlConditions' - disabled: - description: Disable profiling for database resources that match this filter. - $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' - filter: + When true, excludes type information of the findings. This is not + used for data profiling. + type: boolean + ruleSet: description: >- - Required. The tables the discovery cadence applies to. The first - target with a matching filter will be the one to apply to a table. - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudSqlFilter' - id: GooglePrivacyDlpV2CloudSqlDiscoveryTarget - GooglePrivacyDlpV2Connection: + Set of rules to apply to the findings for this InspectConfig. + Exclusion rules, contained in the set are executed in the end, other + rules are executed in the order they are specified for each info + type. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRuleSet' + description: >- + Configuration description of the scanning process. When used with + redactContent only info_types and min_likelihood are currently used. type: object + id: GooglePrivacyDlpV2InspectConfig + GooglePrivacyDlpV2UnwrappedCryptoKey: properties: - name: - readOnly: true - type: string - description: >- - Output only. Name of the connection: - `projects/{project}/locations/{location}/connections/{name}`. - cloudSql: - description: Connect to a Cloud SQL instance. - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' - state: - enum: - - CONNECTION_STATE_UNSPECIFIED - - MISSING_CREDENTIALS - - AVAILABLE - - ERROR - enumDescriptions: - - Unused - - >- - DLP automatically created this connection during an initial scan, - and it is awaiting full configuration by a user. - - A configured connection that has not encountered any errors. - - >- - A configured connection that encountered errors during its last - use. It will not be used again until it is set to AVAILABLE. If - the resolution requires external action, then the client must send - a request to set the status to AVAILABLE when the connection is - ready for use. If the resolution doesn't require external action, - then any changes to the connection properties will automatically - mark it as AVAILABLE. + key: type: string - description: Required. The connection's state in its lifecycle. - errors: - description: >- - Output only. Set if status == ERROR, to provide additional details. - Will store the last 10 errors sorted with the most recent first. - type: array - readOnly: true - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - id: GooglePrivacyDlpV2Connection + description: Required. A 128/192/256 bit key. + format: byte + id: GooglePrivacyDlpV2UnwrappedCryptoKey + type: object description: >- - A data connection to allow DLP to profile data in locations that require - additional configuration. - GooglePrivacyDlpV2Row: - description: Values of the row. + Using raw keys is prone to security risks due to accidentally leaking + the key. Choose another type of key if possible. + GooglePrivacyDlpV2WordList: properties: - values: - description: Individual cells. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + words: + description: >- + Words or phrases defining the dictionary. The dictionary must + contain at least one phrase and every phrase must contain at least 2 + characters that are letters or digits. [required] type: array - id: GooglePrivacyDlpV2Row + items: + type: string + description: Message defining a list of words or phrases to search for in the data. type: object - GooglePrivacyDlpV2StoredInfoType: + id: GooglePrivacyDlpV2WordList + GooglePrivacyDlpV2FinishDlpJobRequest: + properties: {} + description: The request message for finishing a DLP hybrid job. + id: GooglePrivacyDlpV2FinishDlpJobRequest + type: object + GooglePrivacyDlpV2Conditions: + type: object + description: A collection of conditions. properties: - name: - type: string - description: Resource name. - currentVersion: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' - description: Current version of the stored info type. - pendingVersions: - description: >- - Pending versions of the stored info type. Empty if no versions are - pending. + conditions: type: array + description: A collection of conditions. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' + id: GooglePrivacyDlpV2Conditions + GooglePrivacyDlpV2StatisticalTable: + id: GooglePrivacyDlpV2StatisticalTable type: object - id: GooglePrivacyDlpV2StoredInfoType description: >- - StoredInfoType resource message that contains information about the - current version and any pending updates. - GooglePrivacyDlpV2DeltaPresenceEstimationResult: - type: object + An auxiliary table containing statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). properties: - deltaPresenceEstimationHistogram: + relativeFrequency: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - The intervals [min_probability, max_probability) do not overlap. If - a value doesn't correspond to any such interval, the associated - frequency is zero. For example, the following records: - {min_probability: 0, max_probability: 0.1, frequency: 17} - {min_probability: 0.2, max_probability: 0.3, frequency: 42} - {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean - that there are no record with an estimated probability in [0.1, 0.2) - nor larger or equal to 0.4. - items: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. + table: + description: Required. Auxiliary table location. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + quasiIds: type: array - description: >- - Result of the δ-presence computation. Note that these results are an - estimation, not exact values. - id: GooglePrivacyDlpV2DeltaPresenceEstimationResult - GooglePrivacyDlpV2Proximity: - description: >- - Message for specifying a window around a finding to apply a detection - rule. - id: GooglePrivacyDlpV2Proximity + description: Required. Quasi-identifier columns. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdentifierField' + GooglePrivacyDlpV2DiscoveryConfig: type: object + description: >- + Configuration for discovery to scan resources for profile generation. + Only one discovery configuration may exist per organization, folder, or + project. The generated data profiles are retained according to the [data + retention policy] + (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). properties: - windowBefore: + targets: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTarget' description: >- - Number of characters before the finding to consider. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, set this to 1. For more information, see [Hotword example: - Set the match likelihood of a table column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - type: integer - format: int32 - windowAfter: - format: int32 - type: integer - description: Number of characters after the finding to consider. - GooglePrivacyDlpV2Key: - properties: - path: + Target to match against for determining what to scan and how + frequently. + status: + description: Required. A status for this configuration. + enum: + - STATUS_UNSPECIFIED + - RUNNING + - PAUSED + enumDescriptions: + - Unused + - The discovery config is currently active. + - The discovery config is paused temporarily. + type: string + displayName: + type: string + description: Display name (max 100 chars) + updateTime: + description: Output only. The last update timestamp of a DiscoveryConfig. + type: string + format: google-datetime + readOnly: true + lastRunTime: description: >- - The entity path. An entity path consists of one or more elements - composed of a kind and a string or numerical identifier, which - identify entities. The first element identifies a _root entity_, the - second element identifies a _child_ of the root entity, the third - element identifies a child of the second entity, and so forth. The - entities identified by all prefixes of the path are called the - element's _ancestors_. A path can never be empty, and a path can - have at most 100 elements. + Output only. The timestamp of the last time this config was + executed. + readOnly: true + format: google-datetime + type: string + inspectTemplates: + type: array + description: >- + Detection logic for profile generation. Not all template features + are used by Discovery. FindingLimits, include_quote and + exclude_info_types have no impact on Discovery. Multiple templates + may be provided if there is data in multiple regions. At most one + template must be specified per-region (including "global"). Each + region is scanned using the applicable template. If no + region-specific template is specified, but a "global" template is + specified, it will be copied to that region and used instead. If no + global or region-specific template is provided for a region with + data, that region's data will not be scanned. For more information, + see + https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' + type: string + createTime: + format: google-datetime + type: string + readOnly: true + description: Output only. The creation timestamp of a DiscoveryConfig. + errors: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' type: array - partitionId: - $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' description: >- - Entities are partitioned into subsets, currently identified by a - project ID and namespace ID. Queries are scoped to a single - partition. - description: >- - A unique identifier for a Datastore entity. If a key's partition ID or - any of its path kinds or names are reserved/read-only, the key is - reserved/read-only. A reserved/read-only key is forbidden in certain - documented contexts. - id: GooglePrivacyDlpV2Key - type: object - GooglePrivacyDlpV2DataRiskLevel: - properties: - score: - enumDescriptions: - - Unused. - - >- - Low risk - Lower indication of sensitive data that appears to have - additional access restrictions in place or no indication of - sensitive data found. - - >- - Medium risk - Sensitive data may be present but additional access - or fine grain access restrictions appear to be present. Consider - limiting access even further or transform data to mask. - - >- - High risk – SPII may be present. Access controls may include - public ACLs. Exfiltration of data may lead to user data loss. - Re-identification of users may be possible. Consider limiting - usage and or removing SPII. + Output only. A stream of errors encountered when the config was + activated. Repeated errors may result in the config automatically + being paused. Output only field. Will return the last 100 errors. + Whenever the config is modified this list will be cleared. + readOnly: true + name: type: string - enum: - - RISK_SCORE_UNSPECIFIED - - RISK_LOW - - RISK_MODERATE - - RISK_HIGH - description: The score applied to the resource. - description: >- - Score is a summary of all elements in the data profile. A higher number - means more risk. - type: object - id: GooglePrivacyDlpV2DataRiskLevel - GooglePrivacyDlpV2AllOtherBigQueryTables: - id: GooglePrivacyDlpV2AllOtherBigQueryTables + description: >- + Unique resource name for the DiscoveryConfig, assigned by the + service when the DiscoveryConfig is created, for example + `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. + actions: + type: array + description: Actions to execute at the completion of scanning. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileAction' + orgConfig: + description: Only set when the parent is an org. + $ref: '#/components/schemas/GooglePrivacyDlpV2OrgConfig' + id: GooglePrivacyDlpV2DiscoveryConfig + GooglePrivacyDlpV2DeidentifyTemplate: description: >- - Catch-all for all other tables not specified by other filters. Should - always be last, except for single-table configurations, which will only - have a TableReference target. - properties: {} - type: object - GooglePrivacyDlpV2DeidentifyDataSourceStats: + DeidentifyTemplates contains instructions on how to de-identify content. + See + https://cloud.google.com/sensitive-data-protection/docs/concepts-templates + to learn more. + id: GooglePrivacyDlpV2DeidentifyTemplate properties: - transformationErrorCount: - description: Number of errors encountered while trying to apply transformations. - format: int64 + name: + readOnly: true + description: >- + Output only. The template name. The template will have one of the + following formats: + `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR + `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` type: string - transformationCount: - format: int64 + deidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + description: The core content of the template. + createTime: type: string - description: Number of successfully applied transformations. - transformedBytes: + format: google-datetime + description: Output only. The creation timestamp of an inspectTemplate. + readOnly: true + description: + description: Short description (max 256 chars). + type: string + updateTime: + format: google-datetime + readOnly: true + type: string + description: Output only. The last update timestamp of an inspectTemplate. + displayName: + description: Display name (max 256 chars). type: string - format: int64 - description: Total size in bytes that were transformed in some way. - id: GooglePrivacyDlpV2DeidentifyDataSourceStats - description: Summary of what was modified during a transformation. type: object - GooglePrivacyDlpV2ColumnDataProfile: - description: The profile for a scanned column within a table. - id: GooglePrivacyDlpV2ColumnDataProfile + GooglePrivacyDlpV2SecretManagerCredential: type: object + description: >- + A credential consisting of a username and password, where the password + is stored in a Secret Manager resource. Note: Secret Manager [charges + apply](https://cloud.google.com/secret-manager/pricing). properties: - datasetId: - type: string - description: The BigQuery dataset ID. - estimatedUniquenessScore: - enum: - - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED - - UNIQUENESS_SCORE_LOW - - UNIQUENESS_SCORE_MEDIUM - - UNIQUENESS_SCORE_HIGH - description: Approximate uniqueness of the column. - type: string - enumDescriptions: - - >- - Some columns do not have estimated uniqueness. Possible reasons - include having too few values. - - >- - Low uniqueness, possibly a boolean, enum or similiarly typed - column. - - Medium uniqueness. - - >- - High uniqueness, possibly a column of free text or unique - identifiers. - column: + passwordSecretVersionName: type: string - description: The name of the column. - freeTextScore: description: >- - The likelihood that this column contains free-form text. A value - close to 1 may indicate the column is likely to contain free-form or - natural language text. Range in 0-1. - type: number - format: double - policyState: - enumDescriptions: - - No policy tags. - - Column has policy tag applied. - description: Indicates if a policy tag has been applied to the column. - enum: - - COLUMN_POLICY_STATE_UNSPECIFIED - - COLUMN_POLICY_TAGGED + Required. The name of the Secret Manager resource that stores the + password, in the form + `projects/project-id/secrets/secret-name/versions/version`. + username: type: string - datasetLocation: + description: Required. The username. + id: GooglePrivacyDlpV2SecretManagerCredential + GooglePrivacyDlpV2DiscoveryCloudSqlFilter: + type: object + properties: + collection: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceCollection' + description: A specific set of database resources for this filter to apply to. + databaseResourceReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceReference' description: >- - The BigQuery location where the dataset's data is stored. See - https://cloud.google.com/bigquery/docs/locations for supported - locations. - type: string - profileStatus: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + The database resource to scan. Targets including this can only + include one target (the target with this database resource + reference). + others: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherDatabaseResources' description: >- - Success or error status from the most recent profile generation - attempt. May be empty if the profile is still being generated. - otherMatches: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' - description: Other types found within this column. List will be unordered. - datasetProjectId: - description: The Google Cloud project ID that owns the profiled resource. - type: string - profileLastGenerated: - format: google-datetime - type: string - description: The last time the profile was generated. - tableFullResource: - description: The resource name of the resource this column is within. - type: string - columnType: - type: string - description: The data type of a given column. - enumDescriptions: - - Invalid type. - - Encoded as a string in decimal format. - - Encoded as a boolean "false" or "true". - - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". - - Encoded as a string value. - - Encoded as a base64 string per RFC 4648, section 4. - - >- - Encoded as an RFC 3339 timestamp with mandatory "Z" time zone - string: 1985-04-12T23:20:50.52Z - - 'Encoded as RFC 3339 full-date format string: 1985-04-12' - - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' - - >- - Encoded as RFC 3339 full-date "T" partial-time: - 1985-04-12T23:20:50.52 - - Encoded as WKT - - Encoded as a decimal string. - - Container of ordered fields, each with a type and field name. - - Decimal type. - - Json type. - - Interval type. - - '`Range` type.' - - '`Range` type.' - - '`Range` type.' - enum: - - COLUMN_DATA_TYPE_UNSPECIFIED - - TYPE_INT64 - - TYPE_BOOL - - TYPE_FLOAT64 - - TYPE_STRING - - TYPE_BYTES - - TYPE_TIMESTAMP - - TYPE_DATE - - TYPE_TIME - - TYPE_DATETIME - - TYPE_GEOGRAPHY - - TYPE_NUMERIC - - TYPE_RECORD - - TYPE_BIGNUMERIC - - TYPE_JSON - - TYPE_INTERVAL - - TYPE_RANGE_DATE - - TYPE_RANGE_DATETIME - - TYPE_RANGE_TIMESTAMP - sensitivityScore: - description: The sensitivity of this column. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - dataRiskLevel: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' - description: The data risk level for this column. - name: - description: The name of the profile. - type: string - columnInfoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' - description: >- - If it's been determined this column can be identified as a single - type, this will be set. Otherwise the column either has - unidentifiable content or mixed types. - state: - description: State of a profile. - enumDescriptions: - - Unused. - - >- - The profile is currently running. Once a profile has finished it - will transition to DONE. - - >- - The profile is no longer generating. If profile_status.status.code - is 0, the profile succeeded, otherwise, it failed. - enum: - - STATE_UNSPECIFIED - - RUNNING - - DONE - type: string - estimatedNullPercentage: - enumDescriptions: - - Unused. - - Very few null entries. - - Some null entries. - - A few null entries. - - A lot of null entries. - description: Approximate percentage of entries being null in the column. - enum: - - NULL_PERCENTAGE_LEVEL_UNSPECIFIED - - NULL_PERCENTAGE_VERY_LOW - - NULL_PERCENTAGE_LOW - - NULL_PERCENTAGE_MEDIUM - - NULL_PERCENTAGE_HIGH - type: string - tableId: - type: string - description: The BigQuery table ID. - tableDataProfile: - type: string - description: The resource name of the table data profile. - GooglePrivacyDlpV2SurrogateType: - properties: {} - id: GooglePrivacyDlpV2SurrogateType - type: object + Catch-all. This should always be the last target in the list because + anything above it will apply first. Should only appear once in a + configuration. If none is specified, a default one will be added + automatically. description: >- - Message for detecting output from deidentification transformations such - as - [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). - These types of transformations are those that perform pseudonymization, - thereby producing a "surrogate" as output. This should be used in - conjunction with a field on the transformation such as - `surrogate_info_type`. This CustomInfoType does not support the use of - `detection_rules`. - GooglePrivacyDlpV2ListProjectDataProfilesResponse: - description: List of profiles generated for a given organization or project. - type: object - id: GooglePrivacyDlpV2ListProjectDataProfilesResponse - properties: - projectDataProfiles: + Determines what tables will have profiles generated within an + organization or project. Includes the ability to filter by regular + expression patterns on project ID, location, instance, database, and + database resource name. + id: GooglePrivacyDlpV2DiscoveryCloudSqlFilter + GooglePrivacyDlpV2TagResources: + description: >- + If set, attaches the [tags] + (https://cloud.google.com/resource-manager/docs/tags/tags-overview) + provided to profiled resources. Tags support [access + control](https://cloud.google.com/iam/docs/tags-access-control). You can + conditionally grant or deny access to a resource based on whether the + resource has a specific tag. + id: GooglePrivacyDlpV2TagResources + properties: + lowerDataRiskToLow: + description: >- + Whether applying a tag to a resource should lower the risk of the + profile for that resource. For example, in conjunction with an [IAM + deny policy](https://cloud.google.com/iam/docs/deny-overview), you + can deny all principals a permission if a tag value is present, + mitigating the risk of the resource. This also lowers the data risk + of resources at the lower levels of the resource hierarchy. For + example, reducing the data risk of a table data profile also reduces + the data risk of the constituent column data profiles. + type: boolean + tagConditions: type: array + description: The tags to associate with different conditions. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' - description: List of data profiles. - nextPageToken: - type: string - description: The next page token. - GooglePrivacyDlpV2TableLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TagCondition' + profileGenerationsToTag: + description: >- + The profile generations for which the tag should be attached to + resources. If you attach a tag to only new profiles, then if the + sensitivity score of a profile subsequently changes, its tag doesn't + change. By default, this field includes only new profiles. To + include both new and updated profiles for tagging, this field should + explicitly include both `PROFILE_GENERATION_NEW` and + `PROFILE_GENERATION_UPDATE`. + items: + enumDescriptions: + - Unused. + - The profile is the first profile for the resource. + - The profile is an update to a previous profile. + type: string + enum: + - PROFILE_GENERATION_UNSPECIFIED + - PROFILE_GENERATION_NEW + - PROFILE_GENERATION_UPDATE + type: array type: object - id: GooglePrivacyDlpV2TableLocation - description: Location of a finding within a table. + GooglePrivacyDlpV2DateShiftConfig: properties: - rowIndex: - type: string + context: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - The zero-based index of the row where the finding is located. Only - populated for resources that have a natural ordering, not BigQuery. - In BigQuery, to identify the row a finding came from, populate - BigQueryOptions.identifying_fields with your primary key column - names and when you store the findings the value of those columns - will be stored inside of Finding. - format: int64 - GooglePrivacyDlpV2Conditions: - properties: - conditions: - description: A collection of conditions. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Condition' - description: A collection of conditions. + Points to the field that contains the context, for example, an + entity id. If set, must also set cryptoKey. If set, shift will be + consistent for the given context. + lowerBoundDays: + type: integer + description: >- + Required. For example, -5 means shift date to at most 5 days back in + the past. + format: int32 + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + description: >- + Causes the shift to be computed based on this key and the context. + This results in the same shift for the same context and crypto_key. + If set, must also set context. Can only be applied to table items. + upperBoundDays: + format: int32 + type: integer + description: >- + Required. Range of shift in days. Actual shift will be selected at + random within this range (inclusive ends). Negative means shift to + earlier in time. Must not be more than 365250 days (1000 years) each + direction. For example, 3 means shift date to at most 3 days into + the future. + description: >- + Shifts dates by random number of days, with option to be consistent for + the same context. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting + to learn more. + id: GooglePrivacyDlpV2DateShiftConfig type: object - id: GooglePrivacyDlpV2Conditions - GooglePrivacyDlpV2KAnonymityHistogramBucket: - id: GooglePrivacyDlpV2KAnonymityHistogramBucket + GooglePrivacyDlpV2ActionDetails: properties: - equivalenceClassSizeLowerBound: - type: string - description: Lower bound on the size of the equivalence classes in this bucket. - format: int64 - equivalenceClassSizeUpperBound: - type: string - description: Upper bound on the size of the equivalence classes in this bucket. - format: int64 - bucketValueCount: - format: int64 - type: string - description: Total number of distinct equivalence classes in this bucket. - bucketSize: - description: Total number of equivalence classes in this bucket. - type: string - format: int64 - bucketValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' - type: array - description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. + deidentifyDetails: + description: Outcome of a de-identification action. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyDataSourceDetails' type: object - description: Histogram of k-anonymity equivalence classes. - GooglePrivacyDlpV2DataProfileAction: - id: GooglePrivacyDlpV2DataProfileAction - description: A task to execute when a data profile has been generated. + id: GooglePrivacyDlpV2ActionDetails + description: The results of an Action. + GooglePrivacyDlpV2HybridInspectJobTriggerRequest: + description: Request to search for potentially sensitive info in a custom location. properties: - pubSubNotification: - description: Publish a message into the Pub/Sub topic. - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubNotification' - exportData: - $ref: '#/components/schemas/GooglePrivacyDlpV2Export' - description: Export data profiles into a provided location. + hybridItem: + description: The item to inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + id: GooglePrivacyDlpV2HybridInspectJobTriggerRequest type: object - GooglePrivacyDlpV2JobNotificationEmails: - id: GooglePrivacyDlpV2JobNotificationEmails + GooglePrivacyDlpV2AllText: type: object - description: >- - Sends an email when the job completes. The email goes to IAM project - owners and technical [Essential - Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). + id: GooglePrivacyDlpV2AllText + description: Apply to all text. properties: {} - GooglePrivacyDlpV2ImageLocation: - description: Location of the finding within an image. + GooglePrivacyDlpV2Condition: + type: object + description: >- + The field type of `value` and `field` do not need to match to be + considered equal, but not all comparisons are possible. EQUAL_TO and + NOT_EQUAL_TO attempt to compare even with incompatible types, but all + other comparisons are invalid with incompatible types. A `value` of + type: - `string` can be compared against all other types - `boolean` can + only be compared against other booleans - `integer` can be compared + against doubles or a string if the string value can be parsed as an + integer. - `double` can be compared against integers or a string if the + string can be parsed as a double. - `Timestamp` can be compared against + strings in RFC 3339 date string format. - `TimeOfDay` can be compared + against timestamps and strings in the format of 'HH:mm:ss'. If we fail + to compare do to type mismatch, a warning will be given and the + condition will evaluate to false. properties: - boundingBoxes: - type: array + operator: + enumDescriptions: + - Unused + - Equal. Attempts to match even with incompatible types. + - Not equal to. Attempts to match even with incompatible types. + - Greater than. + - Less than. + - Greater than or equals. + - Less than or equals. + - Exists description: >- - Bounding boxes locating the pixels within the image containing the - finding. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2BoundingBox' - id: GooglePrivacyDlpV2ImageLocation + Required. Operator used to compare the field or infoType to the + value. + enum: + - RELATIONAL_OPERATOR_UNSPECIFIED + - EQUAL_TO + - NOT_EQUAL_TO + - GREATER_THAN + - LESS_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN_OR_EQUALS + - EXISTS + type: string + value: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Value to compare against. [Mandatory, except for `EXISTS` tests.] + field: + description: >- + Required. Field within the record this condition is evaluated + against. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + id: GooglePrivacyDlpV2Condition + GooglePrivacyDlpV2RequestedRiskAnalysisOptions: type: object - GooglePrivacyDlpV2NumericalStatsResult: + id: GooglePrivacyDlpV2RequestedRiskAnalysisOptions properties: - quantileValues: + jobConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + description: The job config for the risk job. + description: Risk analysis options. + GooglePrivacyDlpV2ListConnectionsResponse: + description: Response message for ListConnections. + id: GooglePrivacyDlpV2ListConnectionsResponse + type: object + properties: + nextPageToken: + type: string description: >- - List of 99 values that partition the set of field values into 100 - equal sized buckets. + Token to retrieve the next page of results. An empty value means + there are no more results. + connections: + description: List of connections. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' type: array + GooglePrivacyDlpV2DataProfileBigQueryRowSchema: + properties: + tableProfile: + description: Table data profile column + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + fileStoreProfile: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' + description: File store data profile column. + columnProfile: + description: Column data profile column + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + description: >- + The schema of data to be saved to the BigQuery table when the + `DataProfileAction` is enabled. + id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema + type: object + GooglePrivacyDlpV2NumericalStatsResult: + id: GooglePrivacyDlpV2NumericalStatsResult + type: object + description: Result of the numerical stats computation. + properties: maxValue: description: Maximum value appearing in the column. $ref: '#/components/schemas/GooglePrivacyDlpV2Value' minValue: - description: Minimum value appearing in the column. $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - id: GooglePrivacyDlpV2NumericalStatsResult + description: Minimum value appearing in the column. + quantileValues: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + type: array + description: >- + List of 99 values that partition the set of field values into 100 + equal sized buckets. + GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: + description: Request message for UpdateDeidentifyTemplate. + properties: + deidentifyTemplate: + description: New DeidentifyTemplate value. + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + updateMask: + format: google-fieldmask + description: Mask to control which fields get updated. + type: string + id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest type: object - description: Result of the numerical stats computation. - GooglePrivacyDlpV2TransientCryptoKey: - id: GooglePrivacyDlpV2TransientCryptoKey + GooglePrivacyDlpV2VersionDescription: type: object + properties: + description: + type: string + description: Description of the version. + version: + description: Name of the version + type: string + id: GooglePrivacyDlpV2VersionDescription + description: Details about each available version for an infotype. + GooglePrivacyDlpV2FieldId: properties: name: + description: Name describing the field. type: string - description: >- - Required. Name of the key. This is an arbitrary string used to - differentiate different keys. A unique key is generated per name: - two separate `TransientCryptoKey` protos share the same generated - key if their names are the same. When the data crypto key is - generated, this name is not used in any way (repeating the api call - will result in a different key being generated). - description: >- - Use this to have a random data crypto key generated. It will be - discarded after the request finishes. - GooglePrivacyDlpV2CharacterMaskConfig: - description: >- - Partially mask a string by replacing a given number of characters with a - fixed character. Masking can start from the beginning or end of the - string. This can be used on data of any type (numbers, longs, and so on) - and when de-identifying structured data we'll attempt to preserve the - original data's type. (This allows you to take a long like 123 and - modify it to a string like **3. - id: GooglePrivacyDlpV2CharacterMaskConfig type: object + id: GooglePrivacyDlpV2FieldId + description: General identifier of a data field in a storage service. + GooglePrivacyDlpV2DatabaseResourceRegexes: + type: object + id: GooglePrivacyDlpV2DatabaseResourceRegexes properties: - maskingCharacter: - description: >- - Character to use to mask the sensitive values—for example, `*` for - an alphabetic string such as a name, or `0` for a numeric string - such as ZIP code or credit card number. This string must have a - length of 1. If not supplied, this value defaults to `*` for - strings, and `0` for digits. - type: string - numberToMask: - type: integer - format: int32 - description: >- - Number of characters to mask. If not set, all matching chars will be - masked. Skipped characters do not count towards this tally. If - `number_to_mask` is negative, this denotes inverse masking. Cloud - DLP masks all but a number of characters. For example, suppose you - have the following values: - `masking_character` is `*` - - `number_to_mask` is `-4` - `reverse_order` is `false` - - `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` - The resulting de-identified string is `****-****-****-3456`. Cloud - DLP masks all but the last four characters. If `reverse_order` is - `true`, all but the first four characters are masked as - `1234-****-****-****`. - reverseOrder: - description: >- - Mask characters in reverse order. For example, if - `masking_character` is `0`, `number_to_mask` is `14`, and - `reverse_order` is `false`, then the input string - `1234-5678-9012-3456` is masked as `00000000000000-3456`. If - `masking_character` is `*`, `number_to_mask` is `3`, and - `reverse_order` is `true`, then the string `12345` is masked as - `12***`. - type: boolean - charactersToIgnore: + patterns: type: array description: >- - When masking a string, items in this list will be skipped when - replacing characters. For example, if the input string is - `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 - characters with `*`, Cloud DLP returns `***-**5-5555`. + A group of regular expression patterns to match against one or more + database resources. Maximum of 100 entries. The sum of all regular + expression's length can't exceed 10 KiB. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' - GooglePrivacyDlpV2ImageTransformation: - id: GooglePrivacyDlpV2ImageTransformation + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegex' + description: >- + A collection of regular expressions to determine what database resources + to match against. + GooglePrivacyDlpV2ContentItem: properties: - selectedInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' - description: Apply transformation to the selected info_types. - allInfoTypes: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' - description: >- - Apply transformation to all findings not specified in other - ImageTransformation's selected_info_types. Only one instance is - allowed within the ImageTransformations message. - allText: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' - description: >- - Apply transformation to all text that doesn't match an infoType. - Only one instance is allowed within the ImageTransformations - message. - redactionColor: + table: + $ref: '#/components/schemas/GooglePrivacyDlpV2Table' description: >- - The color to use when redacting content from an image. If not - specified, the default is black. - $ref: '#/components/schemas/GooglePrivacyDlpV2Color' - description: Configuration for determining how redaction of images should occur. + Structured content for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table + to learn more. + byteItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + description: Content data to inspect or redact. Replaces `type` and `data`. + value: + description: String data to inspect or redact. + type: string type: object - GooglePrivacyDlpV2InfoType: + id: GooglePrivacyDlpV2ContentItem + description: Type of content to inspect. + GooglePrivacyDlpV2BigQueryTableCollection: + description: Specifies a collection of BigQuery tables. Used for Discovery. + id: GooglePrivacyDlpV2BigQueryTableCollection type: object - description: Type of information detected by the API. properties: - version: - description: Optional version name for this InfoType. - type: string - sensitivityScore: - description: >- - Optional custom sensitivity for this InfoType. This only applies to - data profiling. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - name: - type: string + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryRegexes' description: >- - Name of the information type. Either a name of your choosing when - creating a CustomInfoType, or one of the names listed at - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference - when specifying a built-in type. When sending Cloud DLP results to - Data Catalog, infoType names should conform to the pattern - `[A-Za-z0-9$_-]{1,64}`. - id: GooglePrivacyDlpV2InfoType - GooglePrivacyDlpV2CategoricalStatsHistogramBucket: + A collection of regular expressions to match a BigQuery table + against. + GooglePrivacyDlpV2InspectJobConfig: + description: Controls what and how to inspect for findings. + id: GooglePrivacyDlpV2InspectJobConfig properties: - bucketValueCount: - type: string - description: Total number of distinct values in this bucket. - format: int64 - valueFrequencyLowerBound: - format: int64 - description: Lower bound on the value frequency of the values in this bucket. + storageConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' + description: The data to scan. + inspectTemplateName: type: string - bucketValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' description: >- - Sample of value frequencies in this bucket. The total number of - values returned per bucket is capped at 20. + If provided, will be used as the default for all values in + InspectConfig. `inspect_config` will be merged into the values + persisted as part of the template. + actions: type: array - valueFrequencyUpperBound: - description: Upper bound on the value frequency of the values in this bucket. - format: int64 - type: string - bucketSize: - description: Total number of values in this bucket. - format: int64 - type: string - id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket - description: Histogram of value frequencies in the column. + description: Actions to execute at the completion of the job. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: How and what to scan for. type: object - GooglePrivacyDlpV2DiscoverySchemaModifiedCadence: - description: The cadence at which to update data profiles when a schema is modified. + GooglePrivacyDlpV2NumericalStatsConfig: type: object + description: >- + Compute numerical stats over an individual column, including min, max, + and quantiles. + id: GooglePrivacyDlpV2NumericalStatsConfig properties: - frequency: - enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. - enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY - type: string + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - How frequently profiles may be updated when schemas are modified. - Defaults to monthly. - types: + Field to compute numerical stats on. Supported types are integer, + float, date, datetime, timestamp, time. + GooglePrivacyDlpV2RiskAnalysisJobConfig: + description: >- + Configuration for a risk analysis job. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis + to learn more. + properties: + sourceTable: + description: Input dataset to compute metrics over. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + privacyMetric: + description: Privacy metric to compute. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrivacyMetric' + actions: + description: >- + Actions to execute at the completion of the job. Are executed in the + order provided. type: array items: - type: string - enum: - - SCHEMA_MODIFICATION_UNSPECIFIED - - SCHEMA_NEW_COLUMNS - - SCHEMA_REMOVED_COLUMNS - enumDescriptions: - - Unused - - >- - Profiles should be regenerated when new columns are added to the - table. Default. - - >- - Profiles should be regenerated when columns are removed from the - table. - description: >- - The type of events to consider when deciding if the table's schema - has been modified and should have the profile updated. Defaults to - NEW_COLUMNS. - id: GooglePrivacyDlpV2DiscoverySchemaModifiedCadence - GooglePrivacyDlpV2Range: - properties: - start: - type: string - description: Index of the first character of the range (inclusive). - format: int64 - end: - format: int64 - type: string - description: Index of the last character of the range (exclusive). - id: GooglePrivacyDlpV2Range - description: Generic half-open interval [start, end) + $ref: '#/components/schemas/GooglePrivacyDlpV2Action' type: object - GooglePrivacyDlpV2AllText: - description: Apply to all text. + id: GooglePrivacyDlpV2RiskAnalysisJobConfig + GooglePrivacyDlpV2Disabled: properties: {} + description: Do not profile the tables. type: object - id: GooglePrivacyDlpV2AllText - GooglePrivacyDlpV2CloudSqlIamCredential: + id: GooglePrivacyDlpV2Disabled + GooglePrivacyDlpV2CloudStorageDiscoveryTarget: type: object - properties: {} - id: GooglePrivacyDlpV2CloudSqlIamCredential - description: >- - Use IAM authentication to connect. This requires the Cloud SQL IAM - feature to be enabled on the instance, which is not the default for - Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication - and https://cloud.google.com/sql/docs/mysql/authentication. - GooglePrivacyDlpV2LDiversityEquivalenceClass: - id: GooglePrivacyDlpV2LDiversityEquivalenceClass - description: The set of columns' values that share the same ldiversity value. properties: - equivalenceClassSize: - format: int64 - type: string - description: Size of the k-anonymity equivalence class. - topSensitiveValues: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' - description: Estimated frequencies of top sensitive values. - numDistinctSensitiveValues: - description: Number of distinct sensitive values in this equivalence class. - format: int64 - type: string - quasiIdsValues: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: array + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryFileStoreConditions' description: >- - Quasi-identifier values defining the k-anonymity equivalence class. - The order is always the same as the original request. - type: object - GooglePrivacyDlpV2RecordSuppression: - description: >- - Configuration to suppress records whose suppression conditions evaluate - to true. - properties: - condition: + Optional. In addition to matching the filter, these conditions must + be true before a profile is generated. + disabled: + description: Optional. Disable profiling for buckets that match this filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + filter: description: >- - A condition that when it evaluates to true will result in the record - being evaluated to be suppressed from the transformed content. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' - id: GooglePrivacyDlpV2RecordSuppression - type: object - GooglePrivacyDlpV2LDiversityHistogramBucket: - type: object - properties: - bucketValues: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityEquivalenceClass' + Required. The buckets the generation_cadence applies to. The first + target with a matching filter will be the one to apply to a bucket. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageFilter' + generationCadence: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence description: >- - Sample of equivalence classes in this bucket. The total number of - classes returned per bucket is capped at 20. - sensitiveValueFrequencyLowerBound: + Optional. How often and when to update profiles. New buckets that + match both the filter and conditions are scanned as quickly as + possible depending on system capacity. + id: GooglePrivacyDlpV2CloudStorageDiscoveryTarget + description: Target used to match against for discovery with Cloud Storage buckets. + GooglePrivacyDlpV2RedactImageResponse: + id: GooglePrivacyDlpV2RedactImageResponse + properties: + inspectResult: description: >- - Lower bound on the sensitive value frequencies of the equivalence - classes in this bucket. - type: string - format: int64 - bucketValueCount: - description: Total number of distinct equivalence classes in this bucket. - format: int64 - type: string - bucketSize: + The findings. Populated when include_findings in the request is + true. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' + redactedImage: type: string - description: Total number of equivalence classes in this bucket. - format: int64 - sensitiveValueFrequencyUpperBound: + description: The redacted image. The type will be the same as the original image. + format: byte + extractedText: description: >- - Upper bound on the sensitive value frequencies of the equivalence - classes in this bucket. + If an image was being inspected and the InspectConfig's + include_quote was set to true, then this field will include all + text, if any, that was found in the image. type: string - format: int64 - id: GooglePrivacyDlpV2LDiversityHistogramBucket - description: Histogram of l-diversity equivalence class sensitive value frequencies. - GooglePrivacyDlpV2SelectedInfoTypes: + type: object + description: Results of redacting an image. + GooglePrivacyDlpV2AuxiliaryTable: + id: GooglePrivacyDlpV2AuxiliaryTable + type: object + description: >- + An auxiliary table contains statistical information on the relative + frequency of different quasi-identifiers values. It has one or several + quasi-identifiers columns, and one column that indicates the relative + frequency of each quasi-identifier tuple. If a tuple is present in the + data but not in the auxiliary table, the corresponding relative + frequency is assumed to be zero (and thus, the tuple is highly + reidentifiable). properties: - infoTypes: + relativeFrequency: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' description: >- - Required. InfoTypes to apply the transformation to. Required. - Provided InfoType must be unique within the ImageTransformations - message. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + Required. The relative frequency column must contain a + floating-point number between 0 and 1 (inclusive). Null values are + assumed to be zero. + table: + description: Required. Auxiliary table location. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + quasiIds: + description: Required. Quasi-identifier columns. type: array - description: Apply transformation to the selected info_types. - id: GooglePrivacyDlpV2SelectedInfoTypes + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' + GooglePrivacyDlpV2CreateConnectionRequest: + id: GooglePrivacyDlpV2CreateConnectionRequest type: object - GooglePrivacyDlpV2TransformationLocation: properties: - recordTransformation: - description: >- - For record transformations, provide a field and container - information. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformation' - findingId: - type: string + connection: + description: Required. The connection resource. + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + description: Request message for CreateConnection. + GooglePrivacyDlpV2DiscoveryGenerationCadence: + type: object + properties: + inspectTemplateModifiedCadence: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence description: >- - For infotype transformations, link to the corresponding findings ID - so that location information does not need to be duplicated. Each - findings ID correlates to an entry in the findings output table, - this table only gets created when users specify to save findings - (add the save findings action to the request). - containerType: - type: string + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + schemaModifiedCadence: + description: Governs when to update data profiles when a schema is modified. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoverySchemaModifiedCadence + tableModifiedCadence: + description: Governs when to update data profiles when a table is modified. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryTableModifiedCadence' + refreshFrequency: enumDescriptions: - - Unused. - - Body of a file. - - Metadata for a file. - - A table. + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + type: string description: >- - Information about the functionality of the container where this - finding occurred, if available. + Frequency at which profiles should be updated, regardless of whether + the underlying resource has changed. Defaults to never. enum: - - TRANSFORM_UNKNOWN_CONTAINER - - TRANSFORM_BODY - - TRANSFORM_METADATA - - TRANSFORM_TABLE - description: Specifies the location of a transformation. - id: GooglePrivacyDlpV2TransformationLocation - type: object - GooglePrivacyDlpV2DetectionRule: - properties: - hotwordRule: - description: Hotword-based detection rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - type: object - description: >- - Deprecated; use `InspectionRuleSet` instead. Rule for modifying a - `CustomInfoType` to alter behavior under certain circumstances, - depending on the specific details of the rule. Not supported for the - `surrogate_type` custom infoType. - id: GooglePrivacyDlpV2DetectionRule - GoogleTypeDate: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY + id: GooglePrivacyDlpV2DiscoveryGenerationCadence description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - id: GoogleTypeDate + What must take place for a profile to be updated and how frequently it + should occur. New tables are scanned as quickly as possible depending on + system capacity. + GooglePrivacyDlpV2Location: + id: GooglePrivacyDlpV2Location type: object properties: - year: - format: int32 - type: integer - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - day: - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - type: integer - month: + codepointRange: + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - type: integer - GooglePrivacyDlpV2TransformationDetailsStorageConfig: - type: object - description: Config for storing transformation details. - id: GooglePrivacyDlpV2TransformationDetailsStorageConfig - properties: - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + Unicode character offsets delimiting the finding. These are relative + to the finding's containing element. Provided when the content is + text. + container: + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' description: >- - The BigQuery table in which to store the output. This may be an - existing table or in a new table in an existing dataset. If table_id - is not set a new one will be generated for you with the following - format: - dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. - GooglePrivacyDlpV2DataProfileConfigSnapshot: - properties: - inspectTemplateName: - type: string - description: Name of the inspection template used to generate this profile - dataProfileJob: + Information about the container where this finding occurred, if + available. + byteRange: description: >- - A copy of the configuration used to generate this profile. This is - deprecated, and the DiscoveryConfig field is preferred moving - forward. DataProfileJobConfig will still be written here for - Discovery in BigQuery for backwards compatibility, but will not be - updated with new fields, while DiscoveryConfig will. - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' - deprecated: true - inspectConfig: + Zero-based byte offsets delimiting the finding. These are relative + to the finding's containing element. Note that when the content is + not textual, this references the UTF-8 encoded textual + representation of the content. Omitted if content is an image. + $ref: '#/components/schemas/GooglePrivacyDlpV2Range' + contentLocations: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentLocation' + type: array description: >- - A copy of the inspection config used to generate this profile. This - is a copy of the inspect_template specified in - `DataProfileJobConfig`. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: A copy of the configuration used to generate this profile. - inspectTemplateModifiedTime: - description: Timestamp when the template was modified - type: string - format: google-datetime - id: GooglePrivacyDlpV2DataProfileConfigSnapshot - description: Snapshot of the configurations used to generate the profile. - type: object - GooglePrivacyDlpV2PubSubNotification: + List of nested objects pointing to the precise location of the + finding within the file or record. + description: Specifies the location of the finding. + GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence: properties: - topic: - type: string - description: >- - Cloud Pub/Sub topic to send notifications to. Format is - projects/{project}/topics/{topic}. - detailOfMessage: - description: >- - How much data to include in the Pub/Sub message. If the user wishes - to limit the size of the message, they can use resource_name and - fetch the profile fields they wish to. Per table profile (not per - column). + refreshFrequency: enum: - - DETAIL_LEVEL_UNSPECIFIED - - TABLE_PROFILE - - RESOURCE_NAME - type: string - enumDescriptions: - - Unused. - - The full table data profile. - - The name of the profiled resource. - event: + - UPDATE_FREQUENCY_UNSPECIFIED + - UPDATE_FREQUENCY_NEVER + - UPDATE_FREQUENCY_DAILY + - UPDATE_FREQUENCY_MONTHLY type: string description: >- - The type of event that triggers a Pub/Sub. At most one - `PubSubNotification` per EventType is permitted. - enum: - - EVENT_TYPE_UNSPECIFIED - - NEW_PROFILE - - CHANGED_PROFILE - - SCORE_INCREASED - - ERROR_CHANGED + Optional. Data changes in Cloud Storage can't trigger reprofiling. + If you set this field, profiles are refreshed at this frequency + regardless of whether the underlying buckets have changed. Defaults + to never. enumDescriptions: - - Unused. - - New profile (not a re-profile). - - >- - One of the following profile metrics changed: Data risk score, - Sensitivity score, Resource visibility, Encryption type, Predicted - infoTypes, Other infoTypes - - Table data risk score or sensitivity score increased. - - A user (non-internal) error occurred. - pubsubCondition: - $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' + - Unspecified. + - After the data profile is created, it will never be updated. + - The data profile can be updated up to once every 24 hours. + - The data profile can be updated up to once every 30 days. Default. + inspectTemplateModifiedCadence: description: >- - Conditions (e.g., data risk or sensitivity level) for triggering a - Pub/Sub. - id: GooglePrivacyDlpV2PubSubNotification + Optional. Governs when to update data profiles when the inspection + rules defined by the `InspectTemplate` change. If not set, changing + the template will not cause a data profile to update. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + id: GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence type: object description: >- - Send a Pub/Sub message into the given Pub/Sub topic to connect other - systems to data profile generation. The message payload data will be the - byte serialization of `DataProfilePubSubMessage`. - GooglePrivacyDlpV2BigQueryField: - id: GooglePrivacyDlpV2BigQueryField - properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Designated field in the BigQuery table. - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Source table of the field. + How often existing buckets should have their profiles refreshed. New + buckets are scanned as quickly as possible depending on system capacity. + GooglePrivacyDlpV2CharacterMaskConfig: type: object - description: Message defining a field of a BigQuery table. - GooglePrivacyDlpV2ExcludeInfoTypes: + id: GooglePrivacyDlpV2CharacterMaskConfig properties: - infoTypes: + numberToMask: + type: integer + format: int32 + description: >- + Number of characters to mask. If not set, all matching chars will be + masked. Skipped characters do not count towards this tally. If + `number_to_mask` is negative, this denotes inverse masking. Cloud + DLP masks all but a number of characters. For example, suppose you + have the following values: - `masking_character` is `*` - + `number_to_mask` is `-4` - `reverse_order` is `false` - + `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` + The resulting de-identified string is `****-****-****-3456`. Cloud + DLP masks all but the last four characters. If `reverse_order` is + `true`, all but the first four characters are masked as + `1234-****-****-****`. + charactersToIgnore: + description: >- + When masking a string, items in this list will be skipped when + replacing characters. For example, if the input string is + `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 + characters with `*`, Cloud DLP returns `***-**5-5555`. type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2CharsToIgnore' + reverseOrder: description: >- - InfoType list in ExclusionRule rule drops a finding when it overlaps - or contained within with a finding of an infoType from this list. - For example, for `InspectionRuleSet.info_types` containing - "PHONE_NUMBER"` and `exclusion_rule` containing - `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone - number findings are dropped if they overlap with EMAIL_ADDRESS - finding. That leads to "555-222-2222@example.org" to generate only a - single finding, namely email address. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - id: GooglePrivacyDlpV2ExcludeInfoTypes - description: List of excluded infoTypes. - type: object - GooglePrivacyDlpV2PathElement: - description: >- - A (kind, ID/name) pair used to construct a key path. If either name or - ID is set, the element is complete. If neither is set, the element is - incomplete. - properties: - id: - format: int64 - description: >- - The auto-allocated ID of the entity. Never equal to zero. Values - less than zero are discouraged and may not be supported in the - future. + Mask characters in reverse order. For example, if + `masking_character` is `0`, `number_to_mask` is `14`, and + `reverse_order` is `false`, then the input string + `1234-5678-9012-3456` is masked as `00000000000000-3456`. If + `masking_character` is `*`, `number_to_mask` is `3`, and + `reverse_order` is `true`, then the string `12345` is masked as + `12***`. + type: boolean + maskingCharacter: type: string - kind: description: >- - The kind of the entity. A kind matching regex `__.*__` is - reserved/read-only. A kind must not contain more than 1500 bytes - when UTF-8 encoded. Cannot be `""`. - type: string - name: - type: string + Character to use to mask the sensitive values—for example, `*` for + an alphabetic string such as a name, or `0` for a numeric string + such as ZIP code or credit card number. This string must have a + length of 1. If not supplied, this value defaults to `*` for + strings, and `0` for digits. + description: >- + Partially mask a string by replacing a given number of characters with a + fixed character. Masking can start from the beginning or end of the + string. This can be used on data of any type (numbers, longs, and so on) + and when de-identifying structured data we'll attempt to preserve the + original data's type. (This allows you to take a long like 123 and + modify it to a string like **3. + GooglePrivacyDlpV2RequestedOptions: + properties: + snapshotInspectTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' description: >- - The name of the entity. A name matching regex `__.*__` is - reserved/read-only. A name must not be more than 1500 bytes when - UTF-8 encoded. Cannot be `""`. + If run with an InspectTemplate, a snapshot of its state at the time + of this run. + jobConfig: + description: Inspect config. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' type: object - id: GooglePrivacyDlpV2PathElement - GooglePrivacyDlpV2UnwrappedCryptoKey: + id: GooglePrivacyDlpV2RequestedOptions + description: Snapshot of the inspection configuration. + GooglePrivacyDlpV2RecordCondition: type: object - properties: - key: - type: string - description: Required. A 128/192/256 bit key. - format: byte - id: GooglePrivacyDlpV2UnwrappedCryptoKey - description: >- - Using raw keys is prone to security risks due to accidentally leaking - the key. Choose another type of key if possible. - GooglePrivacyDlpV2CryptoDeterministicConfig: - id: GooglePrivacyDlpV2CryptoDeterministicConfig + id: GooglePrivacyDlpV2RecordCondition description: >- - Pseudonymization method that generates deterministic encryption for the - given input. Outputs a base64 encoded representation of the encrypted - output. Uses AES-SIV based on the RFC - https://tools.ietf.org/html/rfc5297. + A condition for determining whether a transformation should be applied + to a field. properties: - context: - description: >- - A context may be used for higher security and maintaining - referential integrity such that the same identifier in two different - contexts will be given a distinct surrogate. The context is appended - to plaintext value being encrypted. On decryption the provided - context is validated against the value used during encryption. If a - context was provided during encryption, same context must be - provided during decryption as well. If the context is not set, - plaintext would be used as is for encryption. If the context is set - but: 1. there is no record present when transforming a given value - or 2. the field is not present when transforming a given value, - plaintext would be used as is for encryption. Note that case (1) is - expected when an `InfoTypeTransformation` is applied to both - structured and unstructured `ContentItem`s. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + expressions: + description: An expression. + $ref: '#/components/schemas/GooglePrivacyDlpV2Expressions' + GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig: + properties: + commonAlphabet: + type: string + enumDescriptions: + - Unused. + - '`[0-9]` (radix of 10)' + - '`[0-9A-F]` (radix of 16)' + - '`[0-9A-Z]` (radix of 36)' + - '`[0-9A-Za-z]` (radix of 62)' + description: Common alphabets. + enum: + - FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED + - NUMERIC + - HEXADECIMAL + - UPPER_CASE_ALPHA_NUMERIC + - ALPHA_NUMERIC surrogateInfoType: description: >- - The custom info type to annotate the surrogate with. This annotation + The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of - the custom info type followed by the number of characters comprising - the surrogate. The following scheme defines the format: {info type - name}({surrogate character count}):{surrogate} For example, if the - name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate - is 'abc', the full replacement value will be: + the custom infoType followed by the number of characters comprising + the surrogate. The following scheme defines the format: + info_type_name(surrogate_character_count):surrogate For example, if + the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the + surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate - when inspecting content using the custom info type 'Surrogate'. This - facilitates reversal of the surrogate when it occurs in free text. - Note: For record transformations where the entire cell in a table is - being transformed, surrogates are not mandatory. Surrogates are used - to denote the location of the token and are necessary for - re-identification in free form text. In order for inspection to work - properly, the name of this info type must not occur naturally - anywhere in your data; otherwise, inspection may either - reverse a - surrogate that does not correspond to an actual identifier - be - unable to parse the surrogate and result in an error Therefore, - choose your custom info type name carefully after considering what - your data looks like. One way to select a name that has a high - chance of yielding reliable detection is to include one or more - unicode characters that are highly improbable to exist in your data. - For example, assuming your data is entered from a regular ASCII - keyboard, the symbol with the hex code point 29DD might be used like - so: ⧝MY_TOKEN_TYPE. + when inspecting content using the custom infoType + [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). + This facilitates reversal of the surrogate when it occurs in free + text. In order for inspection to work properly, the name of this + infoType must not occur naturally anywhere in your data; otherwise, + inspection may find a surrogate that does not correspond to an + actual identifier. Therefore, choose your custom infoType name + carefully after considering what your data looks like. One way to + select a name that has a high chance of yielding reliable detection + is to include one or more unicode characters that are highly + improbable to exist in your data. For example, assuming your data is + entered from a regular ASCII keyboard, the symbol with the hex code + point 29DD might be used like so: ⧝MY_TOKEN_TYPE $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' cryptoKey: + description: Required. The key used by the encryption algorithm. $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + context: description: >- - The key used by the encryption function. For deterministic - encryption using AES-SIV, the provided key is internally expanded to - 64 bytes prior to use. + The 'tweak', a context may be used for higher security since the + same identifier in two different contexts won't be given the same + surrogate. If the context is not set, a default tweak will be used. + If the context is set but: 1. there is no record present when + transforming a given value or 1. the field is not present when + transforming a given value, a default tweak will be used. Note that + case (1) is expected when an `InfoTypeTransformation` is applied to + both structured and unstructured `ContentItem`s. Currently, the + referenced field may be of value type integer or string. The tweak + is constructed as a sequence of bytes in big endian byte order such + that: - a 64 bit integer is encoded followed by a single byte of + value 1 - a string is encoded in UTF-8 format followed by a single + byte of value 2 + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + customAlphabet: + description: >- + This is supported by mapping these to the alphanumeric characters + that the FFX mode natively supports. This happens before/after + encryption/decryption. Each character listed must appear only once. + Number of characters must be in the range [2, 95]. This must be + encoded as ASCII. The order of characters does not matter. The full + list of allowed characters is: + ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` + type: string + radix: + format: int32 + type: integer + description: The native way to select the alphabet. Must be in the range [2, 95]. + id: GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig + description: >- + Replaces an identifier with a surrogate using Format Preserving + Encryption (FPE) with the FFX mode of operation; however when used in + the `ReidentifyContent` API method, it serves the opposite function by + reversing the surrogate back into the original identifier. The + identifier must be encoded as ASCII. For a given crypto key and context, + the same identifier will be replaced with the same surrogate. + Identifiers must be at least two characters long. In the case that the + identifier is the empty string, it will be skipped. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. Note: We recommend using CryptoDeterministicConfig for + all use cases which do not require preserving the input alphabet space + and size, plus warrant referential integrity. type: object - GooglePrivacyDlpV2ExcludeByHotword: - id: GooglePrivacyDlpV2ExcludeByHotword + GooglePrivacyDlpV2InfoTypeStats: type: object + description: Statistics regarding a specific InfoType. + id: GooglePrivacyDlpV2InfoTypeStats properties: - proximity: - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' - description: >- - Range of characters within which the entire hotword must reside. The - total length of the window cannot exceed 1000 characters. The - windowBefore property in proximity should be set to 1 if the hotword - needs to be included in a column header. - hotwordRegex: - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - description: Regular expression pattern defining what qualifies as a hotword. + count: + format: int64 + type: string + description: Number of findings for this infoType. + infoType: + description: The type of finding this stat is for. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + GooglePrivacyDlpV2CancelDlpJobRequest: + properties: {} + id: GooglePrivacyDlpV2CancelDlpJobRequest + description: The request message for canceling a DLP job. + type: object + GooglePrivacyDlpV2Manual: + properties: {} + id: GooglePrivacyDlpV2Manual + type: object description: >- - The rule to exclude findings based on a hotword. For record inspection - of tables, column names are considered hotwords. An example of this is - to exclude a finding if it belongs to a BigQuery column that matches a - specific pattern. - GooglePrivacyDlpV2ListJobTriggersResponse: - description: Response message for ListJobTriggers. + Job trigger option for hybrid jobs. Jobs must be manually created and + finished. + GooglePrivacyDlpV2BigQueryTableTypes: + id: GooglePrivacyDlpV2BigQueryTableTypes properties: - jobTriggers: + types: type: array - description: List of triggeredJobs, up to page_size in ListJobTriggersRequest. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - nextPageToken: - type: string - description: >- - If the next page is available then this value is the next page token - to be used in the following ListJobTriggers request. - type: object - id: GooglePrivacyDlpV2ListJobTriggersResponse - GooglePrivacyDlpV2ListDlpJobsResponse: - id: GooglePrivacyDlpV2ListDlpJobsResponse - properties: - jobs: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' - type: array - description: A list of DlpJobs that matches the specified filter in the request. - nextPageToken: - type: string - description: The standard List next-page token. - description: The response message for listing DLP jobs. + enum: + - BIG_QUERY_TABLE_TYPE_UNSPECIFIED + - BIG_QUERY_TABLE_TYPE_TABLE + - BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE + enumDescriptions: + - Unused. + - A normal BigQuery table. + - A table that references data stored in Cloud Storage. + type: string + description: A set of BigQuery table types. + description: The types of BigQuery tables supported by Cloud DLP. type: object - GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: - description: Request message for CreateDeidentifyTemplate. - id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + GooglePrivacyDlpV2SecretsDiscoveryTarget: + id: GooglePrivacyDlpV2SecretsDiscoveryTarget + properties: {} type: object + description: >- + Discovery target for credentials and secrets in cloud resource metadata. + This target does not include any filtering or frequency controls. Cloud + DLP will scan cloud resource metadata for secrets daily. No inspect + template should be included in the discovery config for a security + benchmarks scan. Instead, the built-in list of secrets and credentials + infoTypes will be used (see + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). + Credentials and secrets discovered will be reported as vulnerabilities + to Security Command Center. + GooglePrivacyDlpV2DiscoveryBigQueryConditions: properties: - templateId: - description: >- - The template id can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string - deidentifyTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - description: Required. The DeidentifyTemplate to create. - locationId: - description: Deprecated. This field has no effect. + createdAfter: type: string - GooglePrivacyDlpV2QuasiIdentifierField: - id: GooglePrivacyDlpV2QuasiIdentifierField - properties: - customTag: description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). + BigQuery table must have been created after this date. Used to avoid + backfilling. + format: google-datetime + orConditions: + description: >- + At least one of the conditions must be true for a table to be + scanned. + $ref: '#/components/schemas/GooglePrivacyDlpV2OrConditions' + typeCollection: + enum: + - BIG_QUERY_COLLECTION_UNSPECIFIED + - BIG_QUERY_COLLECTION_ALL_TYPES + - BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES type: string - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Identifies the column. + description: Restrict discovery to categories of table types. + enumDescriptions: + - Unused. + - >- + Automatically generate profiles for all tables, even if the table + type is not yet fully supported for analysis. Profiles for + unsupported tables will be generated with errors to indicate their + partial support. When full support is added, the tables will + automatically be profiled during the next scheduled run. + - >- + Only those types fully supported will be profiled. Will expand + automatically as Cloud DLP adds support for new table types. + Unsupported table types will not have partial profiles generated. + types: + description: Restrict discovery to specific table types. + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableTypes' + id: GooglePrivacyDlpV2DiscoveryBigQueryConditions + type: object description: >- - A quasi-identifier column has a custom_tag, used to know which column in - the data corresponds to which column in the statistical model. + Requirements that must be true before a table is scanned in discovery + for the first time. There is an AND relationship between the top-level + attributes. Additionally, minimum conditions with an OR relationship + that must be met before Cloud DLP scans a table can be set (like a + minimum row count or a minimum table age). + GooglePrivacyDlpV2ImageRedactionConfig: + description: Configuration for determining how redaction of images should occur. + properties: + redactionColor: + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + description: >- + The color to use when redacting content from an image. If not + specified, the default is black. + redactAllText: + type: boolean + description: >- + If true, all text found in the image, regardless whether it matches + an info_type, is redacted. Only one should be provided. + infoType: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + Only one per info_type should be provided per request. If not + specified, and redact_all_text is false, the DLP API will redact all + text that it matches against all info_types that are found, but not + specified in another ImageRedactionConfig. type: object - GooglePrivacyDlpV2PublishToStackdriver: - id: GooglePrivacyDlpV2PublishToStackdriver + id: GooglePrivacyDlpV2ImageRedactionConfig + GooglePrivacyDlpV2ImageTransformations: type: object - description: >- - Enable Stackdriver metric dlp.googleapis.com/finding_count. This will - publish a metric to stack driver on each infotype requested and how many - findings were found for it. CustomDetectors will be bucketed as 'Custom' - under the Stackdriver label 'info_type'. - properties: {} - GooglePrivacyDlpV2KAnonymityResult: properties: - equivalenceClassHistogramBuckets: - description: Histogram of k-anonymity equivalence classes. - type: array + transforms: + description: List of transforms to make. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformation' + type: array + id: GooglePrivacyDlpV2ImageTransformations + description: A type of transformation that is applied over images. + GooglePrivacyDlpV2DataProfilePubSubCondition: + description: A condition for determining whether a Pub/Sub should be triggered. type: object - id: GooglePrivacyDlpV2KAnonymityResult - description: Result of the k-anonymity computation. - GooglePrivacyDlpV2KMapEstimationHistogramBucket: properties: - bucketSize: - type: string - format: int64 - description: Number of records within these anonymity bounds. - bucketValues: - description: >- - Sample of quasi-identifier tuple values in this bucket. The total - number of classes returned per bucket is capped at 20. + expressions: + $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' + description: An expression. + id: GooglePrivacyDlpV2DataProfilePubSubCondition + GooglePrivacyDlpV2CategoricalStatsResult: + id: GooglePrivacyDlpV2CategoricalStatsResult + type: object + properties: + valueFrequencyHistogramBuckets: type: array + description: Histogram of value frequencies in the column. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationQuasiIdValues' - bucketValueCount: - type: string + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CategoricalStatsHistogramBucket + description: Result of the categorical stats computation. + GooglePrivacyDlpV2QuoteInfo: + id: GooglePrivacyDlpV2QuoteInfo + description: Message for infoType-dependent details parsed from quote. + type: object + properties: + dateTime: + $ref: '#/components/schemas/GooglePrivacyDlpV2DateTime' + description: The date time indicated by the quote. + GooglePrivacyDlpV2SummaryResult: + properties: + count: format: int64 - description: >- - Total number of distinct quasi-identifier tuple values in this - bucket. - maxAnonymity: - description: Always greater than or equal to min_anonymity. type: string - format: int64 - minAnonymity: - description: Always positive. + description: Number of transformations counted by this result. + code: + enum: + - TRANSFORMATION_RESULT_CODE_UNSPECIFIED + - SUCCESS + - ERROR + enumDescriptions: + - Unused + - Transformation completed without an error. + - Transformation had an error. + type: string + description: Outcome of the transformation. + details: + description: >- + A place for warnings or errors to show up if a transformation didn't + work as expected. type: string - format: int64 type: object - id: GooglePrivacyDlpV2KMapEstimationHistogramBucket + id: GooglePrivacyDlpV2SummaryResult description: >- - A KMapEstimationHistogramBucket message with the following values: - min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 - records whose quasi-identifier values correspond to 3, 4 or 5 people in - the overlying population. An important particular case is when - min_anonymity = max_anonymity = 1: the frequency field then corresponds - to the number of uniquely identifiable records. - GooglePrivacyDlpV2InspectJobConfig: + A collection that informs the user the number of times a particular + `TransformationResultCode` and error details occurred. + GooglePrivacyDlpV2TimeZone: + type: object + id: GooglePrivacyDlpV2TimeZone properties: - inspectTemplateName: - type: string + offsetMinutes: + type: integer description: >- - If provided, will be used as the default for all values in - InspectConfig. `inspect_config` will be merged into the values - persisted as part of the template. - actions: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Action' - type: array - description: Actions to execute at the completion of the job. - storageConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageConfig' - description: The data to scan. - inspectConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' - description: How and what to scan for. - id: GooglePrivacyDlpV2InspectJobConfig + Set only if the offset can be determined. Positive for time ahead of + UTC. E.g. For "UTC-9", this value is -540. + format: int32 + description: Time zone of the date time object. + GooglePrivacyDlpV2KAnonymityConfig: + id: GooglePrivacyDlpV2KAnonymityConfig type: object - description: Controls what and how to inspect for findings. - GooglePrivacyDlpV2DiscoveryBigQueryFilter: + description: k-anonymity metric, used for analysis of reidentification risk. properties: - tables: - description: >- - A specific set of tables for this filter to apply to. A table - collection must be specified in only one filter per config. If a - table id or dataset is empty, Cloud DLP assumes all tables in that - collection must be profiled. Must specify a project ID. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTableCollection' - otherTables: - $ref: '#/components/schemas/GooglePrivacyDlpV2AllOtherBigQueryTables' + entityId: + $ref: '#/components/schemas/GooglePrivacyDlpV2EntityId' description: >- - Catch-all. This should always be the last filter in the list because - anything above it will apply first. Should only appear once in a - configuration. If none is specified, a default one will be added - automatically. - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableReference' + Message indicating that multiple rows might be associated to a + single individual. If the same entity_id is associated to multiple + quasi-identifier tuples over distinct rows, we consider the entire + collection of tuples as the composite quasi-identifier. This + collection is a multiset: the order in which the different tuples + appear in the dataset is ignored, but their frequency is taken into + account. Important note: a maximum of 1000 rows can be associated to + a single entity ID. If more rows are associated with the same entity + ID, some might be ignored. + quasiIds: description: >- - The table to scan. Discovery configurations including this can only - include one DiscoveryTarget (the DiscoveryTarget with this - TableReference). - type: object - id: GooglePrivacyDlpV2DiscoveryBigQueryFilter - description: >- - Determines what tables will have profiles generated within an - organization or project. Includes the ability to filter by regular - expression patterns on project ID, dataset ID, and table ID. - GooglePrivacyDlpV2DatabaseResourceRegex: + Set of fields to compute k-anonymity over. When multiple fields are + specified, they are considered a single composite key. Structs and + repeated data types are not supported; however, nested fields are + supported so long as they are not structs themselves or nested + within a repeated field. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + type: array + GooglePrivacyDlpV2TagValue: properties: - projectIdRegex: + namespacedValue: type: string description: >- - For organizations, if unset, will match all projects. Has no effect - for configurations created within a project. - instanceRegex: + The namespaced name for the tag value to attach to resources. Must + be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, + for example, "123456/environment/prod". + description: A value of a tag. + id: GooglePrivacyDlpV2TagValue + type: object + GooglePrivacyDlpV2InfoTypeLimit: + id: GooglePrivacyDlpV2InfoTypeLimit + type: object + properties: + maxFindings: + format: int32 + description: Max findings limit for the given infoType. + type: integer + infoType: description: >- - Regex to test the instance name against. If empty, all instances - match. + Type of information the findings limit applies to. Only one limit + per info_type should be provided. If InfoTypeLimit does not have an + info_type, the DLP API applies the limit against all info_types that + are found but not specified in another InfoTypeLimit. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: >- + Max findings configuration per infoType, per content item or long + running DlpJob. + GooglePrivacyDlpV2DeidentifyDataSourceStats: + properties: + transformationErrorCount: + format: int64 + description: Number of errors encountered while trying to apply transformations. type: string - databaseRegex: - description: >- - Regex to test the database name against. If empty, all databases - match. + transformationCount: type: string - databaseResourceNameRegex: + description: Number of successfully applied transformations. + format: int64 + transformedBytes: type: string - description: >- - Regex to test the database resource's name against. An example of a - database resource name is a table's name. Other database resource - names like view names could be included in the future. If empty, all - database resources match. + description: Total size in bytes that were transformed in some way. + format: int64 + id: GooglePrivacyDlpV2DeidentifyDataSourceStats + description: Summary of what was modified during a transformation. + type: object + GooglePrivacyDlpV2EntityId: + type: object + properties: + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Composite key indicating which field contains the entity identifier. + id: GooglePrivacyDlpV2EntityId description: >- - A pattern to match against one or more database resources. At least one - pattern must be specified. Regular expressions use RE2 - [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be - found under the google/re2 repository on GitHub. + An entity in a dataset is a field or set of fields that correspond to a + single person. For example, in medical records the `EntityId` might be a + patient identifier, or for financial records it might be an account + identifier. This message is used when generalizations or analysis must + take into account that multiple rows correspond to the same entity. + GooglePrivacyDlpV2RequestedDeidentifyOptions: + id: GooglePrivacyDlpV2RequestedDeidentifyOptions + properties: + snapshotImageRedactTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + Snapshot of the state of the image transformation + `DeidentifyTemplate` from the `Deidentify` action at the time this + job was run. + snapshotDeidentifyTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + Snapshot of the state of the `DeidentifyTemplate` from the + Deidentify action at the time this job was run. + snapshotStructuredDeidentifyTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + Snapshot of the state of the structured `DeidentifyTemplate` from + the `Deidentify` action at the time this job was run. + description: De-identification options. type: object - id: GooglePrivacyDlpV2DatabaseResourceRegex - GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: - description: Request message for UpdateDiscoveryConfig. + GooglePrivacyDlpV2TransientCryptoKey: + id: GooglePrivacyDlpV2TransientCryptoKey type: object - id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + description: >- + Use this to have a random data crypto key generated. It will be + discarded after the request finishes. properties: - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: Required. New DiscoveryConfig value. - updateMask: - description: Mask to control which fields get updated. + name: type: string - format: google-fieldmask - GooglePrivacyDlpV2CreateDiscoveryConfigRequest: - description: Request message for CreateDiscoveryConfig. + description: >- + Required. Name of the key. This is an arbitrary string used to + differentiate different keys. A unique key is generated per name: + two separate `TransientCryptoKey` protos share the same generated + key if their names are the same. When the data crypto key is + generated, this name is not used in any way (repeating the api call + will result in a different key being generated). + GooglePrivacyDlpV2DatabaseResourceCollection: type: object - id: GooglePrivacyDlpV2CreateDiscoveryConfigRequest properties: - configId: - type: string + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2DatabaseResourceRegexes' description: >- - The config ID can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - discoveryConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' - description: Required. The DiscoveryConfig to create. - GooglePrivacyDlpV2Container: + A collection of regular expressions to match a database resource + against. + id: GooglePrivacyDlpV2DatabaseResourceCollection description: >- - Represents a container that may contain DLP findings. Examples of a - container include a file, table, or database record. - id: GooglePrivacyDlpV2Container + Match database resources using regex filters. Examples of database + resources are tables, views, and stored procedures. + GooglePrivacyDlpV2DataRiskLevel: + description: >- + Score is a summary of all elements in the data profile. A higher number + means more risk. type: object + id: GooglePrivacyDlpV2DataRiskLevel properties: - updateTime: - format: google-datetime + score: + description: The score applied to the resource. + enumDescriptions: + - Unused. + - >- + Low risk - Lower indication of sensitive data that appears to have + additional access restrictions in place or no indication of + sensitive data found. + - Unable to determine risk. + - >- + Medium risk - Sensitive data may be present but additional access + or fine grain access restrictions appear to be present. Consider + limiting access even further or transform data to mask. + - >- + High risk – SPII may be present. Access controls may include + public ACLs. Exfiltration of data may lead to user data loss. + Re-identification of users may be possible. Consider limiting + usage and or removing SPII. + enum: + - RISK_SCORE_UNSPECIFIED + - RISK_LOW + - RISK_UNKNOWN + - RISK_MODERATE + - RISK_HIGH + type: string + GooglePrivacyDlpV2Container: + properties: + projectId: type: string + description: >- + Project where the finding was found. Can be different from the + project that owns the finding. + relativePath: + type: string + description: >- + The rest of the path after the root. Examples: - For BigQuery table + `project_id:dataset_id.table_id`, the relative path is `table_id` - + For Cloud Storage file `gs://bucket/folder/filename.txt`, the + relative path is `folder/filename.txt` + fullPath: + type: string + description: >- + A string representation of the full container name. Examples: - + BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: + 'gs://Bucket/folders/filename.txt' + updateTime: description: >- Findings container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated. - type: - description: Container type, for example BigQuery or Cloud Storage. - type: string - version: + format: google-datetime type: string - description: >- - Findings container version, if available ("generation" for Cloud - Storage). rootPath: - type: string description: >- The root of the container. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the root is `dataset_id` - For Cloud Storage file `gs://bucket/folder/filename.txt`, the root is `gs://bucket` - projectId: type: string - description: >- - Project where the finding was found. Can be different from the - project that owns the finding. - fullPath: - description: >- - A string representation of the full container name. Examples: - - BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: - 'gs://Bucket/folders/filename.txt' + type: + description: Container type, for example BigQuery or Cloud Storage. type: string - relativePath: + version: type: string description: >- - The rest of the path after the root. Examples: - For BigQuery table - `project_id:dataset_id.table_id`, the relative path is `table_id` - - For Cloud Storage file `gs://bucket/folder/filename.txt`, the - relative path is `folder/filename.txt` - GooglePrivacyDlpV2RecordLocation: - id: GooglePrivacyDlpV2RecordLocation - description: Location of a finding within a row or record. - properties: - tableLocation: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' - description: Location within a `ContentItem.Table`. - fieldId: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Field id of the field containing the finding. - recordKey: - description: Key of the finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' + Findings container version, if available ("generation" for Cloud + Storage). type: object - GooglePrivacyDlpV2DiscoveryTableModifiedCadence: - id: GooglePrivacyDlpV2DiscoveryTableModifiedCadence + description: >- + Represents a container that may contain DLP findings. Examples of a + container include a file, table, or database record. + id: GooglePrivacyDlpV2Container + GooglePrivacyDlpV2HybridFindingDetails: + description: Populate to associate additional data with each finding. + properties: + tableOptions: + description: >- + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. If not known + ahead of time, can also be set within each inspect hybrid call and + the two will be merged. Note that identifying_fields will only be + stored to BigQuery, and only if the BigQuery action has been + included. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + rowOffset: + type: string + description: >- + Offset of the row for tables. Populate if the row(s) being scanned + are part of a bigger dataset and you want to keep track of their + absolute position. + format: int64 + fileOffset: + type: string + description: >- + Offset in bytes of the line, from the beginning of the file, where + the finding is located. Populate if the item being scanned is only + part of a bigger item, such as a shard of a file and you want to + track the absolute position of the finding. + format: int64 + containerDetails: + $ref: '#/components/schemas/GooglePrivacyDlpV2Container' + description: >- + Details about the container where the content being inspected is + from. + labels: + additionalProperties: + type: string + description: >- + Labels to represent user provided metadata about the data being + inspected. If configured by the job, some key values may be + required. The labels associated with `Finding`'s produced by hybrid + inspection. Label keys must be between 1 and 63 characters long and + must conform to the following regular expression: + `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 + characters long and must conform to the regular expression + `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be + associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + type: object + id: GooglePrivacyDlpV2HybridFindingDetails type: object - description: The cadence at which to update data profiles when a table is modified. + GooglePrivacyDlpV2KMapEstimationResult: + type: object + description: >- + Result of the reidentifiability analysis. Note that these results are an + estimation, not exact values. + id: GooglePrivacyDlpV2KMapEstimationResult properties: - frequency: + kMapEstimationHistogram: description: >- - How frequently data profiles can be updated when tables are - modified. Defaults to never. + The intervals [min_anonymity, max_anonymity] do not overlap. If a + value doesn't correspond to any such interval, the associated + frequency is zero. For example, the following records: + {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: + 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, + max_anonymity: 10, frequency: 99} mean that there are no record with + an estimated anonymity of 4, 5, or larger than 10. + items: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2KMapEstimationHistogramBucket + type: array + GooglePrivacyDlpV2SensitivityScore: + description: >- + Score is calculated from of all elements in the data profile. A higher + level means the data is more sensitive. + type: object + properties: + score: + enumDescriptions: + - Unused. + - >- + No sensitive information detected. The resource isn't publicly + accessible. + - Unable to determine sensitivity. + - >- + Medium risk. Contains personally identifiable information (PII), + potentially sensitive data, or fields with free-text data that are + at a higher risk of having intermittent sensitive data. Consider + limiting access. + - >- + High risk. Sensitive personally identifiable information (SPII) + can be present. Exfiltration of data can lead to user data loss. + Re-identification of users might be possible. Consider limiting + usage and or removing SPII. + enum: + - SENSITIVITY_SCORE_UNSPECIFIED + - SENSITIVITY_LOW + - SENSITIVITY_UNKNOWN + - SENSITIVITY_MODERATE + - SENSITIVITY_HIGH + description: The sensitivity score applied to the resource. + type: string + id: GooglePrivacyDlpV2SensitivityScore + GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: + properties: + schemaModifiedCadence: + $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' + description: When to reprofile if the schema has changed. + inspectTemplateModifiedCadence: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence + description: >- + Governs when to update data profiles when the inspection rules + defined by the `InspectTemplate` change. If not set, changing the + template will not cause a data profile to update. + refreshFrequency: enumDescriptions: - Unspecified. - After the data profile is created, it will never be updated. @@ -5234,348 +4626,361 @@ components: - UPDATE_FREQUENCY_NEVER - UPDATE_FREQUENCY_DAILY - UPDATE_FREQUENCY_MONTHLY - type: string - types: - items: - enumDescriptions: - - Unused. - - >- - A table will be considered modified when the last_modified_time - from BigQuery has been updated. - enum: - - TABLE_MODIFICATION_UNSPECIFIED - - TABLE_MODIFIED_TIMESTAMP - type: string - description: >- - The type of events to consider when deciding if the table has been - modified and should have the profile updated. Defaults to - MODIFIED_TIMESTAMP. - type: array - GooglePrivacyDlpV2Condition: - description: >- - The field type of `value` and `field` do not need to match to be - considered equal, but not all comparisons are possible. EQUAL_TO and - NOT_EQUAL_TO attempt to compare even with incompatible types, but all - other comparisons are invalid with incompatible types. A `value` of - type: - `string` can be compared against all other types - `boolean` can - only be compared against other booleans - `integer` can be compared - against doubles or a string if the string value can be parsed as an - integer. - `double` can be compared against integers or a string if the - string can be parsed as a double. - `Timestamp` can be compared against - strings in RFC 3339 date string format. - `TimeOfDay` can be compared - against timestamps and strings in the format of 'HH:mm:ss'. If we fail - to compare do to type mismatch, a warning will be given and the - condition will evaluate to false. - properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Required. Field within the record this condition is evaluated - against. - operator: description: >- - Required. Operator used to compare the field or infoType to the - value. - enum: - - RELATIONAL_OPERATOR_UNSPECIFIED - - EQUAL_TO - - NOT_EQUAL_TO - - GREATER_THAN - - LESS_THAN - - GREATER_THAN_OR_EQUALS - - LESS_THAN_OR_EQUALS - - EXISTS - enumDescriptions: - - Unused - - Equal. Attempts to match even with incompatible types. - - Not equal to. Attempts to match even with incompatible types. - - Greater than. - - Less than. - - Greater than or equals. - - Less than or equals. - - Exists + Data changes (non-schema changes) in Cloud SQL tables can't trigger + reprofiling. If you set this field, profiles are refreshed at this + frequency regardless of whether the underlying tables have changed. + Defaults to never. type: string - value: - description: Value to compare against. [Mandatory, except for `EXISTS` tests.] - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - type: object - id: GooglePrivacyDlpV2Condition - GooglePrivacyDlpV2Action: type: object - properties: - jobNotificationEmails: - description: >- - Sends an email when the job completes. The email goes to IAM project - owners and technical [Essential - Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts). - $ref: '#/components/schemas/GooglePrivacyDlpV2JobNotificationEmails' - saveFindings: - description: Save resulting findings in a provided location. - $ref: '#/components/schemas/GooglePrivacyDlpV2SaveFindings' - deidentify: - $ref: '#/components/schemas/GooglePrivacyDlpV2Deidentify' - description: Create a de-identified copy of the input data. - publishFindingsToCloudDataCatalog: - description: Publish findings to Cloud Datahub. - $ref: >- - #/components/schemas/GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - publishToStackdriver: - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToStackdriver' - description: Enable Stackdriver metric dlp.googleapis.com/finding_count. - publishSummaryToCscc: - description: Publish summary to Cloud Security Command Center (Alpha). - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishSummaryToCscc' - pubSub: - description: Publish a notification to a Pub/Sub topic. - $ref: '#/components/schemas/GooglePrivacyDlpV2PublishToPubSub' + id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence description: >- - A task to execute on the completion of a job. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-actions - to learn more. - id: GooglePrivacyDlpV2Action - GooglePrivacyDlpV2KAnonymityEquivalenceClass: + How often existing tables should have their profiles refreshed. New + tables are scanned as quickly as possible depending on system capacity. + GooglePrivacyDlpV2CategoricalStatsHistogramBucket: + description: Histogram of value frequencies in the column. + id: GooglePrivacyDlpV2CategoricalStatsHistogramBucket type: object - id: GooglePrivacyDlpV2KAnonymityEquivalenceClass - description: The set of columns' values that share the same ldiversity value properties: - quasiIdsValues: - description: >- - Set of values defining the equivalence class. One value per - quasi-identifier column in the original KAnonymity metric message. - The order is always the same as the original request. + valueFrequencyUpperBound: + description: Upper bound on the value frequency of the values in this bucket. + type: string + format: int64 + bucketValueCount: + type: string + format: int64 + description: Total number of distinct values in this bucket. + bucketSize: + type: string + format: int64 + description: Total number of values in this bucket. + bucketValues: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - equivalenceClassSize: + $ref: '#/components/schemas/GooglePrivacyDlpV2ValueFrequency' description: >- - Size of the equivalence class, for example number of rows with the - above set of values. - format: int64 + Sample of value frequencies in this bucket. The total number of + values returned per bucket is capped at 20. + valueFrequencyLowerBound: + description: Lower bound on the value frequency of the values in this bucket. + format: int64 type: string - GooglePrivacyDlpV2CreateDlpJobRequest: - id: GooglePrivacyDlpV2CreateDlpJobRequest + GooglePrivacyDlpV2ReplaceDictionaryConfig: properties: - riskJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' - description: >- - A risk analysis job calculates re-identification risk metrics for a - BigQuery table. - locationId: - type: string - description: Deprecated. This field has no effect. - inspectJob: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - description: An inspection job scans a storage repository for InfoTypes. - jobId: - type: string + wordList: + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' description: >- - The job id can contain uppercase and lowercase letters, numbers, and - hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: object + A list of words to select from for random replacement. The + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. description: >- - Request message for CreateDlpJobRequest. Used to initiate long running - jobs such as calculating risk metrics or inspecting Google Cloud - Storage. - GooglePrivacyDlpV2HybridInspectResponse: - properties: {} + Replace each input value with a value randomly selected from the + dictionary. + id: GooglePrivacyDlpV2ReplaceDictionaryConfig type: object - description: Quota exceeded errors will be thrown once quota has been met. - id: GooglePrivacyDlpV2HybridInspectResponse - GooglePrivacyDlpV2SearchConnectionsResponse: - description: Response message for SearchConnections. - id: GooglePrivacyDlpV2SearchConnectionsResponse + GooglePrivacyDlpV2StoredInfoTypeConfig: type: object + id: GooglePrivacyDlpV2StoredInfoTypeConfig + description: >- + Configuration for stored infoTypes. All fields and subfield are provided + by the user. For more information, see + https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes. properties: - nextPageToken: - type: string - description: >- - Token to retrieve the next page of results. An empty value means - there are no more results. - connections: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: >- - List of connections that match the search query. Note that only a - subset of the fields will be populated, and only "name" is - guaranteed to be set. For full details of a Connection, call - GetConnection with the name. - type: array - GooglePrivacyDlpV2PartitionId: - properties: - namespaceId: + dictionary: + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' + description: Store dictionary-based CustomInfoType. + description: type: string - description: If not empty, the ID of the namespace to which the entities belong. - projectId: - description: The ID of the project to which the entities belong. + description: Description of the StoredInfoType (max 256 characters). + regex: + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + description: Store regular expression-based StoredInfoType. + displayName: type: string + description: Display name of the StoredInfoType (max 256 characters). + largeCustomDictionary: + description: >- + StoredInfoType where findings are defined by a dictionary of + phrases. + $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryConfig' + GooglePrivacyDlpV2Range: + id: GooglePrivacyDlpV2Range type: object - id: GooglePrivacyDlpV2PartitionId - description: >- - Datastore partition ID. A partition ID identifies a grouping of - entities. The grouping is always by project and namespace, however the - namespace ID may be empty. A partition ID contains several dimensions: - project ID and namespace ID. - GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - GooglePrivacyDlpV2CreateConnectionRequest: - type: object - description: Request message for CreateConnection. - id: GooglePrivacyDlpV2CreateConnectionRequest - properties: - connection: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' - description: Required. The connection resource. - GooglePrivacyDlpV2UpdateInspectTemplateRequest: - type: object + description: Generic half-open interval [start, end) properties: - inspectTemplate: - description: New InspectTemplate value. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' - updateMask: - format: google-fieldmask + start: + type: string + description: Index of the first character of the range (inclusive). + format: int64 + end: + description: Index of the last character of the range (exclusive). + format: int64 type: string - description: Mask to control which fields get updated. - description: Request message for UpdateInspectTemplate. - id: GooglePrivacyDlpV2UpdateInspectTemplateRequest GooglePrivacyDlpV2ValueFrequency: + description: A value of a field, including its frequency. id: GooglePrivacyDlpV2ValueFrequency type: object properties: - count: - description: How many times the value is contained in the field. - type: string - format: int64 value: $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: A value contained in the field in question. - description: A value of a field, including its frequency. - GooglePrivacyDlpV2Schedule: - type: object - description: Schedule for inspect job triggers. - id: GooglePrivacyDlpV2Schedule - properties: - recurrencePeriodDuration: + count: + description: How many times the value is contained in the field. type: string - format: google-duration - description: >- - With this option a job is started on a regular periodic basis. For - example: every day (86400 seconds). A scheduled start time will be - skipped if the previous execution has not ended when its scheduled - time occurs. This value must be set to a time duration greater than - or equal to 1 day and can be no longer than 60 days. - GooglePrivacyDlpV2InspectionRule: - properties: - exclusionRule: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' - description: Exclusion rule. - hotwordRule: - description: Hotword-based detection rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' - description: >- - A single inspection rule to be applied to infoTypes, specified in - `InspectionRuleSet`. - id: GooglePrivacyDlpV2InspectionRule - type: object - GooglePrivacyDlpV2CreateJobTriggerRequest: + format: int64 + GooglePrivacyDlpV2JobTrigger: properties: - jobTrigger: - description: Required. The JobTrigger to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - locationId: - description: Deprecated. This field has no effect. + createTime: + format: google-datetime + description: Output only. The creation timestamp of a triggeredJob. + readOnly: true type: string - triggerId: + name: type: string description: >- - The trigger id can contain uppercase and lowercase letters, numbers, - and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - description: Request message for CreateJobTrigger. - type: object - id: GooglePrivacyDlpV2CreateJobTriggerRequest - GooglePrivacyDlpV2SaveFindings: - properties: - outputConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' - description: Location to store findings outside of DLP. - type: object - id: GooglePrivacyDlpV2SaveFindings - description: >- - If set, the detailed findings will be persisted to the specified - OutputStorageConfig. Only a single instance of this action can be - specified. Compatible with: Inspect, Risk - GooglePrivacyDlpV2DatabaseResourceReference: - description: Identifies a single database resource, like a table within a database. - id: GooglePrivacyDlpV2DatabaseResourceReference - properties: - projectId: - type: string + Unique resource name for the triggeredJob, assigned by the service + when the triggeredJob is created, for example + `projects/dlp-test-project/jobTriggers/53234423`. + errors: description: >- - Required. If within a project-level config, then this must match the - config's project ID. - databaseResource: + Output only. A stream of errors encountered when the trigger was + activated. Repeated errors may result in the JobTrigger + automatically being paused. Will return the last 100 errors. + Whenever the JobTrigger is modified this list will be cleared. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + type: array + readOnly: true + triggers: description: >- - Required. Name of a database resource, for example, a table within - the database. - type: string - database: + A list of triggers which will be OR'ed together. Only one in the + list needs to trigger for a job to be started. The list may contain + only a single Schedule trigger and must have at least one object. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Trigger' + lastRunTime: type: string - description: Required. Name of a database within the instance. - instance: + format: google-datetime + readOnly: true + description: Output only. The timestamp of the last time this trigger executed. + status: + enumDescriptions: + - Unused. + - Trigger is healthy. + - Trigger is temporarily paused. + - Trigger is cancelled and can not be resumed. + description: Required. A status for this trigger. type: string - description: >- - Required. The instance where this resource is located. For example: - Cloud SQL instance ID. - type: object - GooglePrivacyDlpV2TaggedField: - properties: - field: - description: Required. Identifies the column. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - customTag: + enum: + - STATUS_UNSPECIFIED + - HEALTHY + - PAUSED + - CANCELLED + displayName: type: string + description: Display name (max 100 chars) + description: + description: User provided description (max 256 chars) + type: string + inspectJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: For inspect jobs, a snapshot of the configuration. + updateTime: + description: Output only. The last update timestamp of a triggeredJob. + type: string + format: google-datetime + readOnly: true + description: >- + Contains a configuration to make API calls on a repeating basis. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers + to learn more. + type: object + id: GooglePrivacyDlpV2JobTrigger + GooglePrivacyDlpV2CategoricalStatsConfig: + description: >- + Compute numerical stats over an individual column, including number of + distinct values and value count distribution. + id: GooglePrivacyDlpV2CategoricalStatsConfig + type: object + properties: + field: description: >- - A column can be tagged with a custom tag. In this case, the user - must indicate an auxiliary table that contains statistical - information on the possible values of this column (below). - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - A column can be tagged with a InfoType to use the relevant public - dataset as a statistical model of population, if available. We - currently support US ZIP codes, region codes, ages and genders. To - programmatically obtain the list of supported InfoTypes, use - ListInfoTypes with the supported_by=RISK_ANALYSIS filter. - inferred: - $ref: '#/components/schemas/GoogleProtobufEmpty' + Field to compute categorical stats on. All column types are + supported except for arrays and structs. However, it may be more + informative to use NumericalStats when the field type is supported, + depending on the data. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2KmsWrappedCryptoKey: + properties: + cryptoKeyName: description: >- - If no semantic tag is indicated, we infer the statistical model from - the distribution of values in the input data - description: A column with a semantic tag attached. - id: GooglePrivacyDlpV2TaggedField + Required. The resource name of the KMS CryptoKey to use for + unwrapping. + type: string + wrappedKey: + format: byte + description: Required. The wrapped data crypto key. + type: string + description: >- + Include to use an existing data crypto key wrapped by KMS. The wrapped + key must be a 128-, 192-, or 256-bit key. Authorization requires the + following IAM permissions when sending a request to perform a crypto + transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more + information, see [Creating a wrapped key] + (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). + Note: When you use Cloud KMS for cryptographic operations, [charges + apply](https://cloud.google.com/kms/pricing). + id: GooglePrivacyDlpV2KmsWrappedCryptoKey type: object - GooglePrivacyDlpV2Finding: + GooglePrivacyDlpV2ListInspectTemplatesResponse: + properties: + nextPageToken: + type: string + description: >- + If the next page is available then the next page token to be used in + the following ListInspectTemplates request. + inspectTemplates: + description: >- + List of inspectTemplates, up to page_size in + ListInspectTemplatesRequest. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' type: object - id: GooglePrivacyDlpV2Finding - description: Represents a piece of potentially sensitive content. + id: GooglePrivacyDlpV2ListInspectTemplatesResponse + description: Response message for ListInspectTemplates. + GooglePrivacyDlpV2DlpJob: + type: object + id: GooglePrivacyDlpV2DlpJob properties: - resourceName: + endTime: + format: google-datetime type: string - description: The job that stored the finding. - location: - description: Where the content was found. - $ref: '#/components/schemas/GooglePrivacyDlpV2Location' - likelihood: + description: Time when the job finished. + actionDetails: + description: Events that should occur after the job has completed. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' + type: array + inspectDetails: + description: Results from inspecting a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' + lastModified: + description: Time when the job was last modified by the system. + type: string + format: google-datetime + name: + type: string + description: The server-assigned name. + type: + description: The type of job. + type: string + enumDescriptions: + - Defaults to INSPECT_JOB. + - The job inspected Google Cloud for sensitive data. + - The job executed a Risk Analysis computation. + enum: + - DLP_JOB_TYPE_UNSPECIFIED + - INSPECT_JOB + - RISK_ANALYSIS_JOB + jobTriggerName: + type: string + description: >- + If created by a job trigger, the resource name of the trigger that + instantiated the job. + state: + description: State of a job. + enum: + - JOB_STATE_UNSPECIFIED + - PENDING + - RUNNING + - DONE + - CANCELED + - FAILED + - ACTIVE + enumDescriptions: + - Unused. + - The job has not yet started. + - >- + The job is currently running. Once a job has finished it will + transition to FAILED or DONE. + - The job is no longer running. + - The job was canceled before it could be completed. + - The job had an error and did not complete. + - >- + The job is currently accepting findings via hybridInspect. A + hybrid job in ACTIVE state may continue to have findings added to + it through the calling of hybridInspect. After the job has + finished no more calls to hybridInspect may be made. ACTIVE jobs + can transition to DONE. + type: string + createTime: + type: string + format: google-datetime + description: Time when the job was created. + errors: + description: A stream of errors encountered running the job. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + riskDetails: + description: Results from analyzing risk of a data source. + $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' + startTime: + description: Time when the job started. + format: google-datetime + type: string + description: Combines all of the information about a DLP job. + GooglePrivacyDlpV2Connection: + description: >- + A data connection to allow DLP to profile data in locations that require + additional configuration. + type: object + properties: + state: + description: Required. The connection's state in its lifecycle. + enumDescriptions: + - Unused + - >- + DLP automatically created this connection during an initial scan, + and it is awaiting full configuration by a user. + - A configured connection that has not encountered any errors. + - >- + A configured connection that encountered errors during its last + use. It will not be used again until it is set to AVAILABLE. If + the resolution requires external action, then the client must send + a request to set the status to AVAILABLE when the connection is + ready for use. If the resolution doesn't require external action, + then any changes to the connection properties will automatically + mark it as AVAILABLE. + type: string + enum: + - CONNECTION_STATE_UNSPECIFIED + - MISSING_CREDENTIALS + - AVAILABLE + - ERROR + cloudSql: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlProperties' + description: Connect to a Cloud SQL instance. + errors: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' + type: array + readOnly: true + description: >- + Output only. Set if status == ERROR, to provide additional details. + Will store the last 10 errors sorted with the most recent first. + name: + readOnly: true + type: string + description: >- + Output only. Name of the connection: + `projects/{project}/locations/{location}/connections/{name}`. + id: GooglePrivacyDlpV2Connection + GooglePrivacyDlpV2InfoTypeLikelihood: + properties: + minLikelihood: enum: - LIKELIHOOD_UNSPECIFIED - VERY_UNLIKELY @@ -5583,8 +4988,6 @@ components: - POSSIBLE - LIKELY - VERY_LIKELY - description: Confidence of how likely it is that the `info_type` is correct. - type: string enumDescriptions: - Default value; same as POSSIBLE. - Highest chance of a false positive. @@ -5592,867 +4995,631 @@ components: - Some matching signals. The default value. - Low chance of a false positive. - Confidence level is high. Lowest chance of a false positive. - jobName: - description: The job that stored the finding. - type: string - triggerName: - type: string - description: Job trigger name, if applicable, for this finding. - findingId: - type: string - description: The unique finding id. - quoteInfo: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' - description: >- - Contains data parsed from quotes. Only populated if include_quote - was set to true and a supported infoType was requested. Currently - supported infoTypes: DATE, DATE_OF_BIRTH and TIME. - name: type: string description: >- - Resource name in format - projects/{project}/locations/{location}/findings/{finding} Populated - only when viewing persisted findings. + Only returns findings equal to or above this threshold. This field + is required or else the configuration fails. infoType: $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' description: >- - The type of content that might have been found. Provided if - `excluded_types` is false. - createTime: - type: string - format: google-datetime - description: Timestamp when finding was detected. - labels: - description: >- - The labels associated with this `Finding`. Label keys must be - between 1 and 63 characters long and must conform to the following - regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must - be between 0 and 63 characters long and must conform to the regular - expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels - can be associated with a given finding. Examples: * `"environment" : - "production"` * `"pipeline" : "etl"` - type: object - additionalProperties: - type: string - jobCreateTime: - format: google-datetime - type: string - description: Time the job started that produced this finding. - quote: - description: >- - The content that was found. Even if the content is not textual, it - may be converted to a textual representation here. Provided if - `include_quote` is true and the finding is less than or equal to - 4096 bytes long. If the finding exceeds 4096 bytes in length, the - quote may be omitted. - type: string - GooglePrivacyDlpV2ReplaceWithInfoTypeConfig: - description: Replace each matching finding with the name of the info_type. - type: object - id: GooglePrivacyDlpV2ReplaceWithInfoTypeConfig - properties: {} - GooglePrivacyDlpV2Regex: - description: Message defining a custom regular expression. - id: GooglePrivacyDlpV2Regex - properties: - groupIndexes: - description: >- - The index of the submatch to extract as findings. When not - specified, the entire match is returned. No more than 3 may be - included. - type: array - items: - format: int32 - type: integer - pattern: - type: string - description: >- - Pattern defining the regular expression. Its syntax - (https://github.com/google/re2/wiki/Syntax) can be found under the - google/re2 repository on GitHub. - type: object - GooglePrivacyDlpV2AllInfoTypes: - id: GooglePrivacyDlpV2AllInfoTypes - properties: {} - type: object - description: Apply transformation to all findings. - GooglePrivacyDlpV2DataSourceType: - id: GooglePrivacyDlpV2DataSourceType - properties: - dataSource: - type: string - description: >- - Output only. An identifying string to the type of resource being - profiled. Current values: google/bigquery/table, google/project - readOnly: true + Type of information the likelihood threshold applies to. Only one + likelihood per info_type should be provided. If InfoTypeLikelihood + does not have an info_type, the configuration fails. + id: GooglePrivacyDlpV2InfoTypeLikelihood type: object - description: Message used to identify the type of resource being profiled. - GooglePrivacyDlpV2HybridContentItem: - properties: - findingDetails: - description: Supplementary information that will be added to each finding. - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridFindingDetails' - item: - description: The item to inspect. - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' description: >- - An individual hybrid item to inspect. Will be stored temporarily during - processing. - type: object - id: GooglePrivacyDlpV2HybridContentItem - GooglePrivacyDlpV2PrimitiveTransformation: - properties: - cryptoDeterministicConfig: - description: Deterministic Crypto - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoDeterministicConfig' - bucketingConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2BucketingConfig' - description: Bucketing - fixedSizeBucketingConfig: - description: Fixed size bucketing - $ref: '#/components/schemas/GooglePrivacyDlpV2FixedSizeBucketingConfig' - cryptoReplaceFfxFpeConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig' - description: Ffx-Fpe - characterMaskConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2CharacterMaskConfig' - description: Mask - cryptoHashConfig: - description: Crypto - $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoHashConfig' - replaceDictionaryConfig: - description: >- - Replace with a value randomly drawn (with replacement) from a - dictionary. - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceDictionaryConfig' - replaceConfig: - description: Replace with a specified value. - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceValueConfig' - timePartConfig: - description: Time extraction - $ref: '#/components/schemas/GooglePrivacyDlpV2TimePartConfig' - redactConfig: - description: Redact - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactConfig' - dateShiftConfig: - description: Date Shift - $ref: '#/components/schemas/GooglePrivacyDlpV2DateShiftConfig' - replaceWithInfoTypeConfig: - description: Replace with infotype - $ref: '#/components/schemas/GooglePrivacyDlpV2ReplaceWithInfoTypeConfig' - description: A rule for transforming a value. - type: object - id: GooglePrivacyDlpV2PrimitiveTransformation - GooglePrivacyDlpV2DeidentifyContentRequest: + Configuration for setting a minimum likelihood per infotype. Used to + customize the minimum likelihood level for specific infotypes in the + request. For example, use this if you want to lower the precision for + PERSON_NAME without lowering the precision for the other infotypes in + the request. + GooglePrivacyDlpV2DataProfileConfigSnapshot: + id: GooglePrivacyDlpV2DataProfileConfigSnapshot type: object - id: GooglePrivacyDlpV2DeidentifyContentRequest properties: - inspectTemplateName: - type: string - description: >- - Template to use. Any configuration directly specified in - inspect_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: >- - The item to de-identify. Will be treated as text. This value must be - of type Table if your deidentify_config is a RecordTransformations - object. - deidentifyTemplateName: - description: >- - Template to use. Any configuration directly specified in - deidentify_config will override those set in the template. Singular - fields that are set in this request will replace their corresponding - fields in the template. Repeated fields are appended. Singular - sub-messages and groups are recursively merged. - type: string - deidentifyConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - description: >- - Configuration for the de-identification of the content item. Items - specified here will override the template referenced by the - deidentify_template_name argument. + discoveryConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + description: A copy of the configuration used to generate this profile. inspectConfig: $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' description: >- - Configuration for the inspector. Items specified here will override - the template referenced by the inspect_template_name argument. - locationId: + A copy of the inspection config used to generate this profile. This + is a copy of the inspect_template specified in + `DataProfileJobConfig`. + inspectTemplateName: + description: Name of the inspection template used to generate this profile type: string - description: Deprecated. This field has no effect. - description: Request to de-identify a ContentItem. - GooglePrivacyDlpV2InspectContentResponse: - properties: - result: - description: The findings. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectResult' - id: GooglePrivacyDlpV2InspectContentResponse - description: Results of inspecting an item. - type: object - GooglePrivacyDlpV2StoredType: - type: object - description: A reference to a StoredInfoType to use with scanning. - id: GooglePrivacyDlpV2StoredType - properties: - createTime: + dataProfileJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileJobConfig' + deprecated: true description: >- - Timestamp indicating when the version of the `StoredInfoType` used - for inspection was created. Output-only field, populated by the - system. + A copy of the configuration used to generate this profile. This is + deprecated, and the DiscoveryConfig field is preferred moving + forward. DataProfileJobConfig will still be written here for + Discovery in BigQuery for backwards compatibility, but will not be + updated with new fields, while DiscoveryConfig will. + inspectTemplateModifiedTime: + type: string format: google-datetime + description: Timestamp when the template was modified + description: Snapshot of the configurations used to generate the profile. + GooglePrivacyDlpV2TableDataProfile: + properties: + rowCount: type: string - name: description: >- - Resource name of the requested `StoredInfoType`, for example - `organizations/433245324/storedInfoTypes/432452342` or - `projects/project-id/storedInfoTypes/432452342`. - type: string - GooglePrivacyDlpV2DeidentifyTemplate: - type: object - id: GooglePrivacyDlpV2DeidentifyTemplate - properties: - deidentifyConfig: - description: The core content of the template. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' - displayName: + Number of rows in the table when the profile was generated. This + will not be populated for BigLake tables. + format: int64 + state: + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. type: string - description: Display name (max 256 chars). - description: + description: State of a profile. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + datasetId: type: string - description: Short description (max 256 chars). - createTime: - description: Output only. The creation timestamp of an inspectTemplate. + description: If the resource is BigQuery, the dataset ID. + predictedInfoTypes: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + description: The infoTypes predicted from this table's data. + configSnapshot: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfileConfigSnapshot' + description: The snapshot of the configurations used to generate the profile. + datasetLocation: type: string - readOnly: true - format: google-datetime - name: description: >- - Output only. The template name. The template will have one of the - following formats: - `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR - `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` - type: string - readOnly: true - updateTime: - readOnly: true - type: string + If supported, the location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. + fullResource: + description: >- + The resource name of the resource profiled. + https://cloud.google.com/apis/design/resource_names#full_resource_name + type: string + projectDataProfile: + description: The resource name of the project data profile for this table. + type: string + profileLastGenerated: + type: string + description: The last time the profile was generated. format: google-datetime - description: Output only. The last update timestamp of an inspectTemplate. - description: >- - DeidentifyTemplates contains instructions on how to de-identify content. - See - https://cloud.google.com/sensitive-data-protection/docs/concepts-templates - to learn more. - GooglePrivacyDlpV2OutputStorageConfig: - description: Cloud repository for storing output. - type: object - properties: - outputSchema: + profileStatus: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' description: >- - Schema used for writing the findings for Inspect jobs. This field is - only used for Inspect and must be unspecified for Risk jobs. Columns - are derived from the `Finding` object. If appending to an existing - table, any columns from the predefined schema that are missing will - be added. No columns in the existing table will be deleted. If - unspecified, then all available columns will be used for a new table - or an (existing) table with no schema, and no changes will be made - to an existing table that has a schema. Only for use with external - storage. - enum: - - OUTPUT_SCHEMA_UNSPECIFIED - - BASIC_COLUMNS - - GCS_COLUMNS - - DATASTORE_COLUMNS - - BIG_QUERY_COLUMNS - - ALL_COLUMNS + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + failedColumnCount: + format: int64 + type: string + description: The number of columns skipped in the table because of an error. + resourceVisibility: enumDescriptions: - Unused. + - Visible to any user. - >- - Basic schema including only `info_type`, `quote`, `certainty`, and - `timestamp`. - - Schema tailored to findings from scanning Cloud Storage. - - Schema tailored to findings from scanning Google Datastore. - - Schema tailored to findings from scanning Google BigQuery. - - Schema containing all columns. + May contain public items. For example, if a Cloud Storage bucket + has uniform bucket level access disabled, some objects inside it + may be public, but none are known yet. + - Visible only to specific users. type: string - table: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: How broadly a resource has been shared. + enum: + - RESOURCE_VISIBILITY_UNSPECIFIED + - RESOURCE_VISIBILITY_PUBLIC + - RESOURCE_VISIBILITY_INCONCLUSIVE + - RESOURCE_VISIBILITY_RESTRICTED + expirationTime: + format: google-datetime + description: Optional. The time when this table expires. + type: string + lastModifiedTime: + type: string + format: google-datetime + description: The time when this table was last modified + createTime: + description: The time at which the table was created. + type: string + format: google-datetime + dataRiskLevel: + description: The data risk level of this table. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + sensitivityScore: + description: The sensitivity score of this table. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + scannedColumnCount: + type: string + description: The number of columns profiled in the table. + format: int64 + resourceLabels: + type: object description: >- - Store findings in an existing table or a new table in an existing - dataset. If table_id is not set a new one will be generated for you - with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. - Pacific time zone will be used for generating the date details. For - Inspect, each column in an existing output table must have the same - name, type, and mode of a field in the `Finding` object. For Risk, - an existing output table should be the output of a previous Risk - analysis job run on the same source table, with the same privacy - metric and quasi-identifiers. Risk jobs that analyze the same table - but compute a different privacy metric, or use different sets of - quasi-identifiers, cannot store their results in the same table. - id: GooglePrivacyDlpV2OutputStorageConfig - GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest: - description: Request message for UpdateDeidentifyTemplate. - id: GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest - properties: - deidentifyTemplate: - description: New DeidentifyTemplate value. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - updateMask: - format: google-fieldmask - description: Mask to control which fields get updated. + The labels applied to the resource at the time the profile was + generated. + additionalProperties: + type: string + encryptionStatus: + type: string + description: How the table is encrypted. + enum: + - ENCRYPTION_STATUS_UNSPECIFIED + - ENCRYPTION_GOOGLE_MANAGED + - ENCRYPTION_CUSTOMER_MANAGED + enumDescriptions: + - Unused. + - Google manages server-side encryption keys on your behalf. + - Customer provides the key. + dataSourceType: + $ref: '#/components/schemas/GooglePrivacyDlpV2DataSourceType' + description: The resource type that was profiled. + otherInfoTypes: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + description: Other infoTypes found in this table's data. + type: array + tableSizeBytes: + format: int64 + type: string + description: The size of the table when the profile was generated. + datasetProjectId: + type: string + description: The Google Cloud project ID that owns the resource. + name: + description: The name of the profile. + type: string + tableId: type: string + description: If the resource is BigQuery, the BigQuery table ID. + id: GooglePrivacyDlpV2TableDataProfile + description: The profile for a scanned table. type: object - GooglePrivacyDlpV2TransformationConfig: + GooglePrivacyDlpV2DiscoveryStartingLocation: description: >- - User specified templates and configs for how to deidentify structured, - unstructures, and image files. User must provide either a unstructured - deidentify template or at least one redact image config. - id: GooglePrivacyDlpV2TransformationConfig - type: object + The location to begin a discovery scan. Denotes an organization ID or + folder ID within an organization. + id: GooglePrivacyDlpV2DiscoveryStartingLocation properties: - imageRedactTemplate: - type: string - description: >- - Image redact template. If this template is specified, it will serve - as the de-identify template for images. If this template is not set, - all findings in the image will be redacted with a black box. - deidentifyTemplate: + folderId: + format: int64 type: string - description: >- - De-identify template. If this template is specified, it will serve - as the default de-identify template. This template cannot contain - `record_transformations` since it can be used for unstructured - content such as free-form text files. If this template is not set, a - default `ReplaceWithInfoTypeConfig` will be used to de-identify - unstructured content. - structuredDeidentifyTemplate: - description: >- - Structured de-identify template. If this template is specified, it - will serve as the de-identify template for structured content such - as delimited files and tables. If this template is not set but the - `deidentify_template` is set, then `deidentify_template` will also - apply to the structured content. If neither template is set, a - default `ReplaceWithInfoTypeConfig` will be used to de-identify - structured content. + description: The ID of the folder within an organization to be scanned. + organizationId: type: string - GooglePrivacyDlpV2TransformationSummary: + format: int64 + description: The ID of an organization to scan. + type: object + GooglePrivacyDlpV2CryptoKey: type: object + properties: + unwrapped: + $ref: '#/components/schemas/GooglePrivacyDlpV2UnwrappedCryptoKey' + description: Unwrapped crypto key + transient: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransientCryptoKey' + description: Transient crypto key + kmsWrapped: + description: Key wrapped using Cloud KMS + $ref: '#/components/schemas/GooglePrivacyDlpV2KmsWrappedCryptoKey' + id: GooglePrivacyDlpV2CryptoKey description: >- - Summary of a single transformation. Only one of 'transformation', - 'field_transformation', or 'record_suppress' will be set. + This is a data encryption key (DEK) (as opposed to a key encryption key + (KEK) stored by Cloud Key Management Service (Cloud KMS). When using + Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM + policy on the KEK to ensure an attacker cannot unwrap the DEK. + GooglePrivacyDlpV2CloudStoragePath: + id: GooglePrivacyDlpV2CloudStoragePath + description: Message representing a single file or path in Cloud Storage. properties: - transformedBytes: + path: + description: >- + A URL representing a file or path (no wildcards) in Cloud Storage. + Example: `gs://[BUCKET_NAME]/dictionary.txt` type: string - description: Total size in bytes that were transformed in some way. + type: object + GooglePrivacyDlpV2KAnonymityEquivalenceClass: + description: The set of columns' values that share the same ldiversity value + properties: + equivalenceClassSize: format: int64 - transformation: - description: The specific transformation these stats apply to. - $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' - recordSuppress: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' - description: The specific suppression option these stats apply to. - fieldTransformations: - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' description: >- - The field transformation that was applied. If multiple field - transformations are requested for a single field, this list will - contain all of them; otherwise, only one is supplied. - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: Set if the transformation was limited to a specific InfoType. - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: Set if the transformation was limited to a specific FieldId. - results: - description: Collection of all transformations that took place or had an error. + Size of the equivalence class, for example number of rows with the + above set of values. + type: string + quasiIdsValues: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' - id: GooglePrivacyDlpV2TransformationSummary - GooglePrivacyDlpV2MetadataLocation: - properties: - type: - description: Type of metadata containing the finding. - enumDescriptions: - - Unused - - General file metadata provided by Cloud Storage. - type: string - enum: - - METADATATYPE_UNSPECIFIED - - STORAGE_METADATA - storageLabel: - description: Storage metadata. - $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' - description: Metadata Location - id: GooglePrivacyDlpV2MetadataLocation - type: object - GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: - properties: - nextPageToken: - type: string - description: >- - If the next page is available then the next page token to be used in - the following ListDeidentifyTemplates request. - deidentifyTemplates: - description: >- - List of deidentify templates, up to page_size in - ListDeidentifyTemplatesRequest. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - type: object - description: Response message for ListDeidentifyTemplates. - id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse - GooglePrivacyDlpV2ExclusionRule: - properties: - regex: - description: Regular expression which defines the rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - excludeByHotword: - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' description: >- - Drop if the hotword rule is contained in the proximate context. For - tabular data, the context includes the column name. - dictionary: - description: Dictionary which defines the rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - matchingType: - enumDescriptions: - - Invalid. - - >- - Full match. - Dictionary: join of Dictionary results matched - complete finding quote - Regex: all regex matches fill a finding - quote start to end - Exclude info type: completely inside - affecting info types findings - - >- - Partial match. - Dictionary: at least one of the tokens in the - finding matches - Regex: substring of the finding matches - - Exclude info type: intersects with affecting info types findings - - >- - Inverse match. - Dictionary: no tokens in the finding match the - dictionary - Regex: finding doesn't match the regex - Exclude info - type: no intersection with affecting info types findings - description: How the rule is applied, see MatchingType documentation for details. - enum: - - MATCHING_TYPE_UNSPECIFIED - - MATCHING_TYPE_FULL_MATCH - - MATCHING_TYPE_PARTIAL_MATCH - - MATCHING_TYPE_INVERSE_MATCH - type: string - excludeInfoTypes: - description: Set of infoTypes for which findings would affect this rule. - $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' + Set of values defining the equivalence class. One value per + quasi-identifier column in the original KAnonymity metric message. + The order is always the same as the original request. type: object - id: GooglePrivacyDlpV2ExclusionRule - description: >- - The rule that specifies conditions when findings of infoTypes specified - in `InspectionRuleSet` are removed from results. - GooglePrivacyDlpV2FixedSizeBucketingConfig: + id: GooglePrivacyDlpV2KAnonymityEquivalenceClass + GooglePrivacyDlpV2ReplaceValueConfig: + id: GooglePrivacyDlpV2ReplaceValueConfig type: object - description: >- - Buckets values based on fixed size ranges. The Bucketing transformation - can provide all of this functionality, but requires more configuration. - This message is provided as a convenience to the user for simple - bucketing strategies. The transformed value will be a hyphenated string - of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and - upper_bound = 20, all values that are within this bucket will be - replaced with "10-20". This can be used on data of type: double, long. - If the bound Value type differs from the type of data being transformed, - we will first attempt converting the type of the data to be transformed - to match the type of the bound before comparing. See - https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing - to learn more. properties: - lowerBound: - description: >- - Required. Lower bound value of buckets. All values less than - `lower_bound` are grouped together into a single bucket; for example - if `lower_bound` = 10, then all values less than 10 are replaced - with the value "-10". - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - bucketSize: - type: number - format: double - description: >- - Required. Size of each bucket (except for minimum and maximum - buckets). So if `lower_bound` = 10, `upper_bound` = 89, and - `bucket_size` = 10, then the following buckets would be used: -10, - 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. - Precision up to 2 decimals works. - upperBound: + newValue: + description: Value to replace it with. $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - Required. Upper bound value of buckets. All values greater than - upper_bound are grouped together into a single bucket; for example - if `upper_bound` = 89, then all values greater than 89 are replaced - with the value "89+". - id: GooglePrivacyDlpV2FixedSizeBucketingConfig - GooglePrivacyDlpV2StorageConfig: - type: object - id: GooglePrivacyDlpV2StorageConfig - description: Shared message indicating Cloud storage type. + description: Replace each input value with a given `Value`. + GooglePrivacyDlpV2PublishToPubSub: properties: - cloudStorageOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageOptions' - description: Cloud Storage options. - hybridOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridOptions' - description: Hybrid inspection options. - datastoreOptions: - $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreOptions' - description: Google Cloud Datastore options. - bigQueryOptions: - description: BigQuery options. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryOptions' - timespanConfig: - description: Configuration of the timespan of the items to include in scanning. - $ref: '#/components/schemas/GooglePrivacyDlpV2TimespanConfig' - GooglePrivacyDlpV2AuxiliaryTable: + topic: + description: >- + Cloud Pub/Sub topic to send notifications to. The topic must have + given publishing access rights to the DLP API service account + executing the long running DlpJob sending the notifications. Format + is projects/{project}/topics/{topic}. + type: string type: object - id: GooglePrivacyDlpV2AuxiliaryTable + id: GooglePrivacyDlpV2PublishToPubSub description: >- - An auxiliary table contains statistical information on the relative - frequency of different quasi-identifiers values. It has one or several - quasi-identifiers columns, and one column that indicates the relative - frequency of each quasi-identifier tuple. If a tuple is present in the - data but not in the auxiliary table, the corresponding relative - frequency is assumed to be zero (and thus, the tuple is highly - reidentifiable). - properties: - relativeFrequency: - description: >- - Required. The relative frequency column must contain a - floating-point number between 0 and 1 (inclusive). Null values are - assumed to be zero. - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - table: - description: Required. Auxiliary table location. - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - quasiIds: - type: array - description: Required. Quasi-identifier columns. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2QuasiIdField' + Publish a message into a given Pub/Sub topic when DlpJob has completed. + The message contains a single field, `DlpJobName`, which is equal to the + finished job's + [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). + Compatible with: Inspect, Risk + GooglePrivacyDlpV2ThrowError: + type: object + id: GooglePrivacyDlpV2ThrowError + description: Throw an error and fail the request when a transformation error occurs. + properties: {} GooglePrivacyDlpV2PrivacyMetric: + description: Privacy metric to compute for reidentification risk analysis. + id: GooglePrivacyDlpV2PrivacyMetric type: object properties: kMapEstimationConfig: description: k-map $ref: '#/components/schemas/GooglePrivacyDlpV2KMapEstimationConfig' + lDiversityConfig: + description: l-diversity + $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' + numericalStatsConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' + description: Numerical stats + deltaPresenceEstimationConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' + description: delta-presence kAnonymityConfig: $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityConfig' description: K-anonymity categoricalStatsConfig: $ref: '#/components/schemas/GooglePrivacyDlpV2CategoricalStatsConfig' description: Categorical stats - deltaPresenceEstimationConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeltaPresenceEstimationConfig' - description: delta-presence - numericalStatsConfig: - $ref: '#/components/schemas/GooglePrivacyDlpV2NumericalStatsConfig' - description: Numerical stats - lDiversityConfig: - description: l-diversity - $ref: '#/components/schemas/GooglePrivacyDlpV2LDiversityConfig' - description: Privacy metric to compute for reidentification risk analysis. - id: GooglePrivacyDlpV2PrivacyMetric - GooglePrivacyDlpV2NumericalStatsConfig: - description: >- - Compute numerical stats over an individual column, including min, max, - and quantiles. + GooglePrivacyDlpV2ListDlpJobsResponse: + id: GooglePrivacyDlpV2ListDlpJobsResponse + properties: + nextPageToken: + type: string + description: The standard List next-page token. + jobs: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + type: array + description: A list of DlpJobs that matches the specified filter in the request. + type: object + description: The response message for listing DLP jobs. + GooglePrivacyDlpV2TransformationConfig: + id: GooglePrivacyDlpV2TransformationConfig type: object + description: >- + User specified templates and configs for how to deidentify structured, + unstructures, and image files. User must provide either a unstructured + deidentify template or at least one redact image config. properties: - field: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + structuredDeidentifyTemplate: + type: string description: >- - Field to compute numerical stats on. Supported types are integer, - float, date, datetime, timestamp, time. - id: GooglePrivacyDlpV2NumericalStatsConfig - GooglePrivacyDlpV2CloudSqlProperties: - properties: - databaseEngine: + Structured de-identify template. If this template is specified, it + will serve as the de-identify template for structured content such + as delimited files and tables. If this template is not set but the + `deidentify_template` is set, then `deidentify_template` will also + apply to the structured content. If neither template is set, a + default `ReplaceWithInfoTypeConfig` will be used to de-identify + structured content. + imageRedactTemplate: type: string - enumDescriptions: - - >- - An engine that is not currently supported by Sensitive Data - Protection. - - Cloud SQL for MySQL instance. - - Cloud SQL for PostgreSQL instance. description: >- - Required. The database engine used by the Cloud SQL instance that - this connection configures. - enum: - - DATABASE_ENGINE_UNKNOWN - - DATABASE_ENGINE_MYSQL - - DATABASE_ENGINE_POSTGRES - usernamePassword: - description: A username and password stored in Secret Manager. - $ref: '#/components/schemas/GooglePrivacyDlpV2SecretManagerCredential' - connectionName: - type: string + Image redact template. If this template is specified, it will serve + as the de-identify template for images. If this template is not set, + all findings in the image will be redacted with a black box. + deidentifyTemplate: description: >- - Optional. Immutable. The Cloud SQL instance for which the connection - is defined. Only one connection per instance is allowed. This can - only be set at creation time, and cannot be updated. It is an error - to use a connection_name from different project or region than the - one that holds the connection. For example, a Connection resource - for Cloud SQL connection_name `project-id:us-central1:sql-instance` - must be created under the parent - `projects/project-id/locations/us-central1` - cloudSqlIam: - $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlIamCredential' - description: Built-in IAM authentication (must be configured in Cloud SQL). - maxConnections: - type: integer + De-identify template. If this template is specified, it will serve + as the default de-identify template. This template cannot contain + `record_transformations` since it can be used for unstructured + content such as free-form text files. If this template is not set, a + default `ReplaceWithInfoTypeConfig` will be used to de-identify + unstructured content. + type: string + GooglePrivacyDlpV2UpdateStoredInfoTypeRequest: + id: GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + description: Request message for UpdateStoredInfoType. + properties: + updateMask: + type: string + description: Mask to control which fields get updated. + format: google-fieldmask + config: description: >- - Required. DLP will limit its connections to max_connections. Must be - 2 or greater. - format: int32 - id: GooglePrivacyDlpV2CloudSqlProperties + Updated configuration for the storedInfoType. If not provided, a new + version of the storedInfoType will be created with the existing + configuration. + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' type: object - description: Cloud SQL connection properties. - GooglePrivacyDlpV2InfoTypeSummary: + GooglePrivacyDlpV2KMapEstimationQuasiIdValues: type: object - description: The infoType details for this column. - properties: - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: The infoType. - estimatedPrevalence: - type: integer - format: int32 - description: Not populated for predicted infotypes. - deprecated: true - id: GooglePrivacyDlpV2InfoTypeSummary - GooglePrivacyDlpV2OrConditions: properties: - minRowCount: - description: >- - Minimum number of rows that should be present before Cloud DLP - profiles a table - format: int32 - type: integer - minAge: - description: >- - Minimum age a table must have before Cloud DLP can profile it. Value - must be 1 hour or greater. + quasiIdsValues: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: The quasi-identifier values. + type: array + estimatedAnonymity: + description: The estimated anonymity for these quasi-identifier values. type: string - format: google-duration - id: GooglePrivacyDlpV2OrConditions - description: >- - There is an OR relationship between these attributes. They are used to - determine if a table should be scanned or not in Discovery. - type: object - GooglePrivacyDlpV2DatastoreKey: - id: GooglePrivacyDlpV2DatastoreKey - type: object + format: int64 + description: A tuple of values for the quasi-identifier columns. + id: GooglePrivacyDlpV2KMapEstimationQuasiIdValues + GooglePrivacyDlpV2Color: properties: - entityKey: - $ref: '#/components/schemas/GooglePrivacyDlpV2Key' - description: Datastore entity key. - description: Record key for a finding in Cloud Datastore. - GooglePrivacyDlpV2PublishToPubSub: - description: >- - Publish a message into a given Pub/Sub topic when DlpJob has completed. - The message contains a single field, `DlpJobName`, which is equal to the - finished job's - [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). - Compatible with: Inspect, Risk + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + red: + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + green: + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + type: number type: object - id: GooglePrivacyDlpV2PublishToPubSub + id: GooglePrivacyDlpV2Color + description: Represents a color in the RGB color space. + GooglePrivacyDlpV2SearchConnectionsResponse: + description: Response message for SearchConnections. + id: GooglePrivacyDlpV2SearchConnectionsResponse properties: - topic: + nextPageToken: + description: >- + Token to retrieve the next page of results. An empty value means + there are no more results. type: string + connections: + type: array description: >- - Cloud Pub/Sub topic to send notifications to. The topic must have - given publishing access rights to the DLP API service account - executing the long running DlpJob sending the notifications. Format - is projects/{project}/topics/{topic}. - GoogleTypeTimeOfDay: + List of connections that match the search query. Note that only a + subset of the fields will be populated, and only "name" is + guaranteed to be set. For full details of a Connection, call + GetConnection with the name. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' type: object - id: GoogleTypeTimeOfDay - description: >- - Represents a time of day. The date and time zone are either not - significant or are specified elsewhere. An API may choose to allow leap - seconds. Related types are google.type.Date and - `google.protobuf.Timestamp`. + GooglePrivacyDlpV2BoundingBox: properties: - hours: - format: int32 - description: >- - Hours of day in 24 hour format. Should be from 0 to 23. An API may - choose to allow the value "24:00:00" for scenarios like business - closing time. - type: integer - minutes: + width: + description: Width of the bounding box in pixels. type: integer - description: Minutes of hour of day. Must be from 0 to 59. format: int32 - seconds: + height: + description: Height of the bounding box in pixels. format: int32 - description: >- - Seconds of minutes of the time. Must normally be from 0 to 59. An - API may allow the value 60 if it allows leap-seconds. type: integer - nanos: + top: + type: integer format: int32 - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + description: Top coordinate of the bounding box. (0,0) is upper left. + left: + format: int32 + description: Left coordinate of the bounding box. (0,0) is upper left. type: integer - GooglePrivacyDlpV2HotwordRule: - id: GooglePrivacyDlpV2HotwordRule + type: object + id: GooglePrivacyDlpV2BoundingBox + description: Bounding box encompassing detected text within an image. + GooglePrivacyDlpV2BigQueryDiscoveryTarget: + id: GooglePrivacyDlpV2BigQueryDiscoveryTarget + description: Target used to match against for discovery with BigQuery tables + type: object properties: - likelihoodAdjustment: - description: Likelihood adjustment to apply to all matching findings. - $ref: '#/components/schemas/GooglePrivacyDlpV2LikelihoodAdjustment' - hotwordRegex: - description: Regular expression pattern defining what qualifies as a hotword. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - proximity: + filter: + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryFilter' description: >- - Range of characters within which the entire hotword must reside. The - total length of the window cannot exceed 1000 characters. The - finding itself will be included in the window, so that hotwords can - be used to match substrings of the finding itself. Suppose you want - Cloud DLP to promote the likelihood of the phone number regex - "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area - code of a company's office. In this case, use the hotword regex - "\(xxx\)", where "xxx" is the area code in question. For tabular - data, if you want to modify the likelihood of an entire column of - findngs, see [Hotword example: Set the match likelihood of a table - column] - (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + Required. The tables the discovery cadence applies to. The first + target with a matching filter will be the one to apply to a table. + disabled: + $ref: '#/components/schemas/GooglePrivacyDlpV2Disabled' + description: Tables that match this filter will not have profiles created. + conditions: + description: >- + In addition to matching the filter, these conditions must be true + before a profile is generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryBigQueryConditions' + cadence: + description: >- + How often and when to update profiles. New tables that match both + the filter and conditions are scanned as quickly as possible + depending on system capacity. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryGenerationCadence' + GooglePrivacyDlpV2InfoTypeTransformations: description: >- - The rule that adjusts the likelihood of findings within a certain - proximity of hotwords. - type: object - GooglePrivacyDlpV2RequestedOptions: + A type of transformation that will scan unstructured text and apply + various `PrimitiveTransformation`s to each finding, where the + transformation is applied to only values that were identified as a + specific info_type. + id: GooglePrivacyDlpV2InfoTypeTransformations + properties: + transformations: + description: >- + Required. Transformation for each infoType. Cannot specify more than + one for a given infoType. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformation' + type: array type: object - id: GooglePrivacyDlpV2RequestedOptions + GooglePrivacyDlpV2CloudStorageFileSet: + id: GooglePrivacyDlpV2CloudStorageFileSet properties: - jobConfig: - description: Inspect config. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' - snapshotInspectTemplate: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + url: description: >- - If run with an InspectTemplate, a snapshot of its state at the time - of this run. - description: Snapshot of the inspection configuration. - GooglePrivacyDlpV2DeidentifyConfig: + The url, in the format `gs:///`. Trailing wildcard in the path is + allowed. + type: string + type: object + description: Message representing a set of files in Cloud Storage. + GooglePrivacyDlpV2FileClusterSummary: + description: The file cluster summary. properties: - recordTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2RecordTransformations' + errors: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Error' description: >- - Treat the dataset as structured. Transformations can be applied to - specific locations within structured datasets, such as transforming - a column within a table. - infoTypeTransformations: + A list of errors detected while scanning this cluster. The list is + truncated to 10 per cluster. + type: array + fileClusterType: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileClusterType' + description: The file cluster type. + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' description: >- - Treat the dataset as free-form text and apply the same free text - transformation everywhere. - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' - transformationErrorHandling: - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationErrorHandling' + The sensitivity score of this cluster. The score will be + SENSITIVITY_LOW if nothing has been scanned. + fileExtensionsSeen: description: >- - Mode for handling transformation errors. If left unspecified, the - default mode is `TransformationErrorHandling.ThrowError`. - imageTransformations: - $ref: '#/components/schemas/GooglePrivacyDlpV2ImageTransformations' - description: Treat the dataset as an image and redact. - id: GooglePrivacyDlpV2DeidentifyConfig - type: object - description: The configuration that controls how the data will change. - GooglePrivacyDlpV2ListStoredInfoTypesResponse: - description: Response message for ListStoredInfoTypes. - id: GooglePrivacyDlpV2ListStoredInfoTypesResponse - properties: - nextPageToken: - type: string + A sample of file types seen in this cluster. Empty if no files were + seen. File extensions can be derived from the file name or the file + content. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' + noFilesExist: + type: boolean description: >- - If the next page is available then the next page token to be used in - the following ListStoredInfoTypes request. - storedInfoTypes: + True if no files exist in this cluster. If the bucket had more files + than could be listed, this will be false even if no files for this + cluster were seen and file_extensions_seen is empty. + fileStoreInfoTypeSummaries: + description: InfoTypes detected in this cluster. + type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreInfoTypeSummary' + fileExtensionsScanned: type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileExtensionInfo' description: >- - List of storedInfoTypes, up to page_size in - ListStoredInfoTypesRequest. - type: object - GooglePrivacyDlpV2DataProfilePubSubCondition: - id: GooglePrivacyDlpV2DataProfilePubSubCondition - description: A condition for determining whether a Pub/Sub should be triggered. - properties: - expressions: - $ref: '#/components/schemas/GooglePrivacyDlpV2PubSubExpressions' - description: An expression. + A sample of file types scanned in this cluster. Empty if no files + were scanned. File extensions can be derived from the file name or + the file content. + dataRiskLevel: + description: >- + The data risk level of this cluster. RISK_LOW if nothing has been + scanned. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + id: GooglePrivacyDlpV2FileClusterSummary type: object - GooglePrivacyDlpV2DiscoveryCloudSqlConditions: + GooglePrivacyDlpV2CloudStorageResourceReference: + id: GooglePrivacyDlpV2CloudStorageResourceReference type: object - id: GooglePrivacyDlpV2DiscoveryCloudSqlConditions properties: - databaseEngines: + projectId: description: >- - Optional. Database engines that should be profiled. Optional. - Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + Required. If within a project-level config, then this must match the + config's project id. + type: string + bucketName: + description: Required. The bucket to scan. + type: string + description: Identifies a single Cloud Storage bucket. + GooglePrivacyDlpV2RecordKey: + type: object + id: GooglePrivacyDlpV2RecordKey + properties: + idValues: type: array + description: >- + Values of identifying columns in the given row. Order of values + matches the order of `identifying_fields` specified in the scanning + request. items: - enum: - - DATABASE_ENGINE_UNSPECIFIED - - ALL_SUPPORTED_DATABASE_ENGINES - - MYSQL - - POSTGRES - enumDescriptions: - - Unused. - - Include all supported database engines. - - MySQL database. - - PostgreSQL database. - type: string - types: - items: - enum: - - DATABASE_RESOURCE_TYPE_UNSPECIFIED - - DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES - - DATABASE_RESOURCE_TYPE_TABLE - enumDescriptions: - - Unused. - - >- - Includes database resource types that become supported at a - later time. - - Tables. type: string - description: >- - Data profiles will only be generated for the database resource types - specified in this field. If not specified, defaults to - [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. - type: array - description: >- - Requirements that must be true before a table is profiled for the first - time. - GooglePrivacyDlpV2Bucket: - id: GooglePrivacyDlpV2Bucket - description: Bucket is represented as a range, along with replacement values. + bigQueryKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryKey' + description: Datastore key + datastoreKey: + description: BigQuery key + $ref: '#/components/schemas/GooglePrivacyDlpV2DatastoreKey' + description: Message for a unique key indicating a record that contains a finding. + GooglePrivacyDlpV2PubSubCondition: properties: - max: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: Upper bound of the range, exclusive; type must match min. - replacementValue: - description: Required. Replacement value for this bucket. - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - min: - $ref: '#/components/schemas/GooglePrivacyDlpV2Value' - description: >- - Lower bound of the range, inclusive. Type should be the same as max - if used. + minimumSensitivityScore: + description: The minimum sensitivity level that triggers the condition. + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + type: string + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + minimumRiskScore: + type: string + enum: + - PROFILE_SCORE_BUCKET_UNSPECIFIED + - HIGH + - MEDIUM_OR_HIGH + description: The minimum data risk score that triggers the condition. + enumDescriptions: + - Unused. + - High risk/sensitivity detected. + - Medium or high risk/sensitivity detected. + type: object + id: GooglePrivacyDlpV2PubSubCondition + description: A condition consisting of a value. + GooglePrivacyDlpV2SurrogateType: + properties: {} + description: >- + Message for detecting output from deidentification transformations such + as + [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). + These types of transformations are those that perform pseudonymization, + thereby producing a "surrogate" as output. This should be used in + conjunction with a field on the transformation such as + `surrogate_info_type`. This CustomInfoType does not support the use of + `detection_rules`. + id: GooglePrivacyDlpV2SurrogateType type: object GooglePrivacyDlpV2DeltaPresenceEstimationConfig: + type: object + description: >- + δ-presence metric, used to estimate how likely it is for an attacker to + figure out that one given individual appears in a de-identified dataset. + Similarly to the k-map metric, we cannot compute δ-presence exactly + without knowing the attack dataset, so we use a statistical model + instead. properties: + regionCode: + type: string + description: >- + ISO 3166-1 alpha-2 region code to use in the statistical modeling. + Set if no column is tagged with a region-specific InfoType (like + US_ZIP_5) or a region code. quasiIds: type: array items: @@ -6460,12 +5627,6 @@ components: description: >- Required. Fields considered to be quasi-identifiers. No two fields can have the same tag. - regionCode: - description: >- - ISO 3166-1 alpha-2 region code to use in the statistical modeling. - Set if no column is tagged with a region-specific InfoType (like - US_ZIP_5) or a region code. - type: string auxiliaryTables: items: $ref: '#/components/schemas/GooglePrivacyDlpV2StatisticalTable' @@ -6474,145 +5635,68 @@ components: Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table. - description: >- - δ-presence metric, used to estimate how likely it is for an attacker to - figure out that one given individual appears in a de-identified dataset. - Similarly to the k-map metric, we cannot compute δ-presence exactly - without knowing the attack dataset, so we use a statistical model - instead. id: GooglePrivacyDlpV2DeltaPresenceEstimationConfig - type: object - GooglePrivacyDlpV2BigQueryKey: - description: Row key for identifying a record in BigQuery table. - id: GooglePrivacyDlpV2BigQueryKey - type: object + GooglePrivacyDlpV2ExclusionRule: + id: GooglePrivacyDlpV2ExclusionRule properties: - tableReference: - $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' - description: Complete BigQuery table reference. - rowNumber: - description: >- - Row number inferred at the time the table was scanned. This value is - nondeterministic, cannot be queried, and may be null for inspection - jobs. To locate findings within a table, specify - `inspect_job.storage_config.big_query_options.identifying_fields` in - `CreateDlpJobRequest`. - format: int64 + excludeInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeInfoTypes' + description: Set of infoTypes for which findings would affect this rule. + matchingType: + description: How the rule is applied, see MatchingType documentation for details. + enumDescriptions: + - Invalid. + - >- + Full match. - Dictionary: join of Dictionary results matched + complete finding quote - Regex: all regex matches fill a finding + quote start to end - Exclude info type: completely inside + affecting info types findings + - >- + Partial match. - Dictionary: at least one of the tokens in the + finding matches - Regex: substring of the finding matches - + Exclude info type: intersects with affecting info types findings + - >- + Inverse match. - Dictionary: no tokens in the finding match the + dictionary - Regex: finding doesn't match the regex - Exclude info + type: no intersection with affecting info types findings type: string - GooglePrivacyDlpV2StoredInfoTypeStats: - description: Statistics for a StoredInfoType. - properties: - largeCustomDictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2LargeCustomDictionaryStats' + enum: + - MATCHING_TYPE_UNSPECIFIED + - MATCHING_TYPE_FULL_MATCH + - MATCHING_TYPE_PARTIAL_MATCH + - MATCHING_TYPE_INVERSE_MATCH + regex: + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + description: Regular expression which defines the rule. + excludeByHotword: + $ref: '#/components/schemas/GooglePrivacyDlpV2ExcludeByHotword' description: >- - StoredInfoType where findings are defined by a dictionary of - phrases. - id: GooglePrivacyDlpV2StoredInfoTypeStats + Drop if the hotword rule is contained in the proximate context. For + tabular data, the context includes the column name. + dictionary: + description: Dictionary which defines the rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' type: object - GooglePrivacyDlpV2CreateStoredInfoTypeRequest: - description: Request message for CreateStoredInfoType. + description: >- + The rule that specifies conditions when findings of infoTypes specified + in `InspectionRuleSet` are removed from results. + GooglePrivacyDlpV2LikelihoodAdjustment: + id: GooglePrivacyDlpV2LikelihoodAdjustment type: object - id: GooglePrivacyDlpV2CreateStoredInfoTypeRequest properties: - locationId: - description: Deprecated. This field has no effect. - type: string - config: - description: Required. Configuration of the storedInfoType to create. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeConfig' - storedInfoTypeId: - description: >- - The storedInfoType ID can contain uppercase and lowercase letters, - numbers, and hyphens; that is, it must match the regular expression: - `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty - to allow the system to generate one. - type: string - GooglePrivacyDlpV2Table: - properties: - rows: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Row' - description: Rows of the table. - type: array - headers: - type: array - description: Headers of the table. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' - description: >- - Structured content to inspect. Up to 50,000 `Value`s per request - allowed. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table - to learn more. - id: GooglePrivacyDlpV2Table - type: object - GooglePrivacyDlpV2CustomInfoType: - type: object - properties: - surrogateType: - $ref: '#/components/schemas/GooglePrivacyDlpV2SurrogateType' - description: >- - Message for detecting output from deidentification transformations - that support reversing. - exclusionType: - type: string - enumDescriptions: - - >- - A finding of this custom info type will not be excluded from - results. - - >- - A finding of this custom info type will be excluded from final - results, but can still affect rule execution. - enum: - - EXCLUSION_TYPE_UNSPECIFIED - - EXCLUSION_TYPE_EXCLUDE - description: >- - If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a - finding to be returned. It still can be used for rules matching. - storedType: - description: >- - Load an existing `StoredInfoType` resource for use in - `InspectDataSource`. Not currently supported in `InspectContent`. - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredType' - infoType: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' - description: >- - CustomInfoType can either be a new infoType, or an extension of - built-in infoType, when the name matches one of existing infoTypes - and that infoType is specified in `InspectContent.info_types` field. - Specifying the latter adds findings to the one detected by the - system. If built-in info type is not specified in - `InspectContent.info_types` list then the name is treated as a - custom info type. - regex: - description: Regular expression based CustomInfoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' - detectionRules: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2DetectionRule' - description: >- - Set of detection rules to apply to all findings of this - CustomInfoType. Rules are applied in order that they are specified. - Not supported for the `surrogate_type` CustomInfoType. - type: array - dictionary: - $ref: '#/components/schemas/GooglePrivacyDlpV2Dictionary' - description: A list of phrases to detect as a CustomInfoType. - sensitivityScore: + relativeLikelihood: description: >- - Sensitivity for this CustomInfoType. If this CustomInfoType extends - an existing InfoType, the sensitivity here will take precedence over - that of the original InfoType. If unset for a CustomInfoType, it - will default to HIGH. This only applies to data profiling. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - likelihood: - enum: - - LIKELIHOOD_UNSPECIFIED - - VERY_UNLIKELY - - UNLIKELY - - POSSIBLE - - LIKELY - - VERY_LIKELY + Increase or decrease the likelihood by the specified number of + levels. For example, if a finding would be `POSSIBLE` without the + detection rule and `relative_likelihood` is 1, then it is upgraded + to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. + Likelihood may never drop below `VERY_UNLIKELY` or exceed + `VERY_LIKELY`, so applying an adjustment of 1 followed by an + adjustment of -1 when base likelihood is `VERY_LIKELY` will result + in a final likelihood of `LIKELY`. + type: integer + format: int32 + fixedLikelihood: enumDescriptions: - Default value; same as POSSIBLE. - Highest chance of a false positive. @@ -6621,457 +5705,2051 @@ components: - Low chance of a false positive. - Confidence level is high. Lowest chance of a false positive. type: string - description: >- - Likelihood to return for this CustomInfoType. This base value can be - altered by a detection rule if the finding meets the criteria - specified by the rule. Defaults to `VERY_LIKELY` if not specified. - id: GooglePrivacyDlpV2CustomInfoType - description: >- - Custom information type provided by the user. Used to find - domain-specific sensitive information configurable to the data in - question. - GooglePrivacyDlpV2StorageMetadataLabel: - type: object - properties: - key: - type: string - description: Label name. + description: Set the likelihood of a finding to a fixed value. + enum: + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY description: >- - Storage metadata label to indicate which metadata entry contains - findings. - id: GooglePrivacyDlpV2StorageMetadataLabel - GooglePrivacyDlpV2ThrowError: + Message for specifying an adjustment to the likelihood of a finding as + part of a detection rule. + GooglePrivacyDlpV2FieldTransformation: + description: The transformation to apply to the field. + id: GooglePrivacyDlpV2FieldTransformation type: object - id: GooglePrivacyDlpV2ThrowError - properties: {} - description: Throw an error and fail the request when a transformation error occurs. - GooglePrivacyDlpV2WordList: - id: GooglePrivacyDlpV2WordList properties: - words: - items: - type: string + condition: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordCondition' description: >- - Words or phrases defining the dictionary. The dictionary must - contain at least one phrase and every phrase must contain at least 2 - characters that are letters or digits. [required] + Only apply the transformation if the condition evaluates to true for + the given `RecordCondition`. The conditions are allowed to reference + fields that are not used in the actual transformation. Example Use + Cases: - Apply a different bucket transformation to an age column if + the zip code column for the same record is within a specific range. + - Redact a field if the date of birth field is greater than 85. + primitiveTransformation: + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + description: Apply the transformation to the entire field. + infoTypeTransformations: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeTransformations' + description: >- + Treat the contents of the field as free text, and selectively + transform content that matches an `InfoType`. + fields: type: array + description: >- + Required. Input field(s) to apply the transformation to. When you + have columns that reference their position within a list, omit the + index from the FieldId. FieldId name matching ignores the index. For + example, instead of "contact.nums[0].type", use "contact.nums.type". + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + GooglePrivacyDlpV2FileStoreCollection: + properties: + includeRegexes: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreRegexes' + description: >- + Optional. A collection of regular expressions to match a file store + against. type: object - description: Message defining a list of words or phrases to search for in the data. - GooglePrivacyDlpV2DlpJob: - id: GooglePrivacyDlpV2DlpJob - description: Combines all of the information about a DLP job. + description: Match file stores (e.g. buckets) using regex filters. + id: GooglePrivacyDlpV2FileStoreCollection + GooglePrivacyDlpV2BigQueryOptions: type: object properties: - inspectDetails: - description: Results from inspecting a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectDataSourceDetails' - startTime: - description: Time when the job started. - format: google-datetime - type: string - actionDetails: - description: Events that should occur after the job has completed. + includedFields: type: array items: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActionDetails' - riskDetails: - description: Results from analyzing risk of a data source. - $ref: '#/components/schemas/GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails' - createTime: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + Limit scanning only to these fields. When inspecting a table, we + recommend that you inspect all columns. Otherwise, findings might be + affected because hints from excluded columns will not be used. + identifyingFields: + description: >- + Table fields that may uniquely identify a row within the table. When + `actions.saveFindings.outputConfig.table` is specified, the values + of columns specified here are available in the output table under + `location.content_locations.record_location.record_key.id_values`. + Nested fields such as `person.birthdate.year` are allowed. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + tableReference: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: Complete BigQuery table reference. + excludedFields: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + type: array + description: >- + References to fields excluded from scanning. This allows you to skip + inspection of entire columns which you know have no findings. When + inspecting a table, we recommend that you inspect all columns. + Otherwise, findings might be affected because hints from excluded + columns will not be used. + rowsLimitPercent: + format: int32 + description: >- + Max percentage of rows to scan. The rest are omitted. The number of + rows scanned is rounded down. Must be between 0 and 100, + inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one + of rows_limit and rows_limit_percent can be specified. Cannot be + used in conjunction with TimespanConfig. Caution: A [known + issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) + is causing the `rowsLimitPercent` field to behave unexpectedly. We + recommend using `rowsLimit` instead. + type: integer + rowsLimit: + format: int64 + description: >- + Max number of rows to scan. If the table has more rows than this + value, the rest of the rows are omitted. If not set, or if set to 0, + all rows will be scanned. Only one of rows_limit and + rows_limit_percent can be specified. Cannot be used in conjunction + with TimespanConfig. type: string - description: Time when the job was created. - format: google-datetime - state: + sampleMethod: type: string enumDescriptions: - - Unused. - - The job has not yet started. + - No sampling. - >- - The job is currently running. Once a job has finished it will - transition to FAILED or DONE. - - The job is no longer running. - - The job was canceled before it could be completed. - - The job had an error and did not complete. - - >- - The job is currently accepting findings via hybridInspect. A - hybrid job in ACTIVE state may continue to have findings added to - it through the calling of hybridInspect. After the job has - finished no more calls to hybridInspect may be made. ACTIVE jobs - can transition to DONE. + Scan groups of rows in the order BigQuery provides (default). + Multiple groups of rows may be scanned in parallel, so results may + not appear in the same order the rows are read. + - Randomly pick groups of rows to scan. + description: How to sample the data. enum: - - JOB_STATE_UNSPECIFIED - - PENDING - - RUNNING - - DONE - - CANCELED - - FAILED - - ACTIVE - description: State of a job. - name: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + description: Options defining BigQuery table and row identifiers. + id: GooglePrivacyDlpV2BigQueryOptions + GooglePrivacyDlpV2FileClusterType: + properties: + cluster: + enumDescriptions: + - Unused. + - Unsupported files. + - Plain text. + - Structured data like CSV, TSV etc. + - Source code. + - Rich document like docx, xlsx etc. + - Images like jpeg, bmp. + - Archives and containers like .zip, .tar etc. + - Multimedia like .mp4, .avi etc. + - Executable files like .exe, .class, .apk etc. type: string - description: The server-assigned name. - type: enum: - - DLP_JOB_TYPE_UNSPECIFIED - - INSPECT_JOB - - RISK_ANALYSIS_JOB - description: The type of job. - enumDescriptions: - - Defaults to INSPECT_JOB. - - The job inspected Google Cloud for sensitive data. - - The job executed a Risk Analysis computation. + - CLUSTER_UNSPECIFIED + - CLUSTER_UNKNOWN + - CLUSTER_TEXT + - CLUSTER_STRUCTURED_DATA + - CLUSTER_SOURCE_CODE + - CLUSTER_RICH_DOCUMENT + - CLUSTER_IMAGE + - CLUSTER_ARCHIVE + - CLUSTER_MULTIMEDIA + - CLUSTER_EXECUTABLE + description: Cluster type. + id: GooglePrivacyDlpV2FileClusterType + description: Message used to identify file cluster type being profiled. + type: object + GooglePrivacyDlpV2FileExtensionInfo: + type: object + description: Information regarding the discovered file extension. + id: GooglePrivacyDlpV2FileExtensionInfo + properties: + fileExtension: + description: The file extension if set. (aka .pdf, .jpg, .txt) type: string - errors: - description: A stream of errors encountered running the job. - type: array - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Error' - lastModified: - format: google-datetime + GooglePrivacyDlpV2KAnonymityHistogramBucket: + properties: + bucketValueCount: + description: Total number of distinct equivalence classes in this bucket. + format: int64 type: string - description: Time when the job was last modified by the system. - jobTriggerName: + bucketSize: + description: Total number of equivalence classes in this bucket. + format: int64 type: string - description: >- - If created by a job trigger, the resource name of the trigger that - instantiated the job. - endTime: + equivalenceClassSizeLowerBound: type: string - description: Time when the job finished. - format: google-datetime - GooglePrivacyDlpV2DataProfileBigQueryRowSchema: - id: GooglePrivacyDlpV2DataProfileBigQueryRowSchema - properties: - columnProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' - description: Column data profile column - tableProfile: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' - description: Table data profile column + description: Lower bound on the size of the equivalence classes in this bucket. + format: int64 + equivalenceClassSizeUpperBound: + description: Upper bound on the size of the equivalence classes in this bucket. + type: string + format: int64 + bucketValues: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityEquivalenceClass' + description: >- + Sample of equivalence classes in this bucket. The total number of + classes returned per bucket is capped at 20. type: object - description: >- - The schema of data to be saved to the BigQuery table when the - `DataProfileAction` is enabled. - GooglePrivacyDlpV2TableReference: - description: >- - Message defining the location of a BigQuery table with the projectId - inferred from the parent project. + description: Histogram of k-anonymity equivalence classes. + id: GooglePrivacyDlpV2KAnonymityHistogramBucket + GooglePrivacyDlpV2Finding: type: object - id: GooglePrivacyDlpV2TableReference + description: Represents a piece of potentially sensitive content. properties: - datasetId: - description: Dataset ID of the table. + quote: + description: >- + The content that was found. Even if the content is not textual, it + may be converted to a textual representation here. Provided if + `include_quote` is true and the finding is less than or equal to + 4096 bytes long. If the finding exceeds 4096 bytes in length, the + quote may be omitted. type: string - tableId: + location: + $ref: '#/components/schemas/GooglePrivacyDlpV2Location' + description: Where the content was found. + triggerName: + description: Job trigger name, if applicable, for this finding. type: string - description: Name of the table. - GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence: - type: object - id: GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence - description: >- - How often existing tables should have their profiles refreshed. New - tables are scanned as quickly as possible depending on system capacity. - properties: - schemaModifiedCadence: - $ref: '#/components/schemas/GooglePrivacyDlpV2SchemaModifiedCadence' - description: When to reprofile if the schema has changed. - refreshFrequency: + name: + type: string + description: >- + Resource name in format + projects/{project}/locations/{location}/findings/{finding} Populated + only when viewing persisted findings. + jobCreateTime: + description: Time the job started that produced this finding. + type: string + format: google-datetime + labels: + type: object + additionalProperties: + type: string + description: >- + The labels associated with this `Finding`. Label keys must be + between 1 and 63 characters long and must conform to the following + regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must + be between 0 and 63 characters long and must conform to the regular + expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels + can be associated with a given finding. Examples: * `"environment" : + "production"` * `"pipeline" : "etl"` + quoteInfo: + description: >- + Contains data parsed from quotes. Only populated if include_quote + was set to true and a supported infoType was requested. Currently + supported infoTypes: DATE, DATE_OF_BIRTH and TIME. + $ref: '#/components/schemas/GooglePrivacyDlpV2QuoteInfo' + infoType: + description: >- + The type of content that might have been found. Provided if + `excluded_types` is false. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + findingId: + description: The unique finding id. + type: string + likelihood: enumDescriptions: - - Unspecified. - - After the data profile is created, it will never be updated. - - The data profile can be updated up to once every 24 hours. - - The data profile can be updated up to once every 30 days. Default. + - Default value; same as POSSIBLE. + - Highest chance of a false positive. + - High chance of a false positive. + - Some matching signals. The default value. + - Low chance of a false positive. + - Confidence level is high. Lowest chance of a false positive. enum: - - UPDATE_FREQUENCY_UNSPECIFIED - - UPDATE_FREQUENCY_NEVER - - UPDATE_FREQUENCY_DAILY - - UPDATE_FREQUENCY_MONTHLY + - LIKELIHOOD_UNSPECIFIED + - VERY_UNLIKELY + - UNLIKELY + - POSSIBLE + - LIKELY + - VERY_LIKELY type: string - description: >- - Data changes (non-schema changes) in Cloud SQL tables can't trigger - reprofiling. If you set this field, profiles are refreshed at this - frequency regardless of whether the underlying tables have changed. - Defaults to never. - GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: + description: Confidence of how likely it is that the `info_type` is correct. + resourceName: + description: The job that stored the finding. + type: string + createTime: + format: google-datetime + type: string + description: Timestamp when finding was detected. + jobName: + description: The job that stored the finding. + type: string + id: GooglePrivacyDlpV2Finding + GooglePrivacyDlpV2CreateDlpJobRequest: type: object - id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog - properties: {} description: >- - Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag - templates are applied to the resource that Cloud DLP scanned. Data - Catalog tag templates are stored in the same project and region where - the BigQuery table exists. For Cloud DLP to create and apply the tag - template, the Cloud DLP service agent must have the - `roles/datacatalog.tagTemplateOwner` permission on the project. The tag - template contains fields summarizing the results of the DlpJob. Any - field values previously written by another DlpJob are deleted. InfoType - naming patterns are strictly enforced when using this feature. Findings - are persisted in Data Catalog storage and are governed by - service-specific policies for Data Catalog. For more information, see - [Service Specific Terms](https://cloud.google.com/terms/service-terms). - Only a single instance of this action can be specified. This action is - allowed only if all resources being scanned are BigQuery tables. - Compatible with: Inspect - GooglePrivacyDlpV2InfoTypeDescription: + Request message for CreateDlpJobRequest. Used to initiate long running + jobs such as calculating risk metrics or inspecting Google Cloud + Storage. + id: GooglePrivacyDlpV2CreateDlpJobRequest properties: - description: - description: >- - Description of the infotype. Translated when language is provided in - the request. + jobId: type: string - name: - description: Internal name of the infoType. + description: >- + The job id can contain uppercase and lowercase letters, numbers, and + hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + inspectJob: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectJobConfig' + description: An inspection job scans a storage repository for InfoTypes. + locationId: type: string - categories: + description: Deprecated. This field has no effect. + riskJob: + description: >- + A risk analysis job calculates re-identification risk metrics for a + BigQuery table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RiskAnalysisJobConfig' + GooglePrivacyDlpV2StoredInfoType: + properties: + currentVersion: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + description: Current version of the stored info type. + pendingVersions: type: array - description: The category of the infoType. + description: >- + Pending versions of the stored info type. Empty if no versions are + pending. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' - versions: - description: A list of available versions for the infotype. - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' - type: array - supportedBy: - type: array - description: Which parts of the API supports this InfoType. - items: - enum: - - ENUM_TYPE_UNSPECIFIED - - INSPECT - - RISK_ANALYSIS - enumDescriptions: - - Unused. - - Supported by the inspect operations. - - Supported by the risk analysis operations. - type: string - sensitivityScore: - description: The default sensitivity of the infoType. - $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' - displayName: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoTypeVersion' + name: type: string - description: Human readable form of the infoType name. - type: object - id: GooglePrivacyDlpV2InfoTypeDescription - description: InfoType description. - GooglePrivacyDlpV2InspectResult: - description: All the findings for a single scanned item. + description: Resource name. + id: GooglePrivacyDlpV2StoredInfoType + description: >- + StoredInfoType resource message that contains information about the + current version and any pending updates. type: object - id: GooglePrivacyDlpV2InspectResult + GooglePrivacyDlpV2DatabaseResourceRegex: properties: - findingsTruncated: + instanceRegex: + type: string description: >- - If true, then this item might have more findings than were returned, - and the findings returned are an arbitrary subset of all findings. - The findings list might be truncated because the input items were - too large, or because the server reached the maximum amount of - resources allowed for a single API call. For best results, divide - the input into smaller batches. - type: boolean - findings: - items: - $ref: '#/components/schemas/GooglePrivacyDlpV2Finding' - type: array - description: List of findings for an item. - GooglePrivacyDlpV2Expressions: - description: An expression, consisting of an operator and conditions. - id: GooglePrivacyDlpV2Expressions + Regex to test the instance name against. If empty, all instances + match. + databaseRegex: + description: >- + Regex to test the database name against. If empty, all databases + match. + type: string + projectIdRegex: + description: >- + For organizations, if unset, will match all projects. Has no effect + for configurations created within a project. + type: string + databaseResourceNameRegex: + type: string + description: >- + Regex to test the database resource's name against. An example of a + database resource name is a table's name. Other database resource + names like view names could be included in the future. If empty, all + database resources match. + description: >- + A pattern to match against one or more database resources. At least one + pattern must be specified. Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + type: object + id: GooglePrivacyDlpV2DatabaseResourceRegex + GooglePrivacyDlpV2DeidentifyContentResponse: + type: object + id: GooglePrivacyDlpV2DeidentifyContentResponse + description: Results of de-identifying a ContentItem. properties: - conditions: - description: Conditions to apply to the expression. - $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' - logicalOperator: + item: + description: The de-identified item. + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + overview: + description: An overview of the changes that were made on the `item`. + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' + GooglePrivacyDlpV2TimePartConfig: + type: object + id: GooglePrivacyDlpV2TimePartConfig + description: >- + For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a + portion of the value. + properties: + partToExtract: enumDescriptions: - Unused - - Conditional AND - description: >- - The operator to apply to the result of conditions. Default and - currently only supported value is `AND`. + - '[0-9999]' + - '[1-12]' + - '[1-31]' + - '[1-7]' + - '[1-53]' + - '[0-23]' type: string enum: - - LOGICAL_OPERATOR_UNSPECIFIED - - AND - type: object - GooglePrivacyDlpV2ListInfoTypesResponse: - description: Response to the ListInfoTypes request. - id: GooglePrivacyDlpV2ListInfoTypesResponse + - TIME_PART_UNSPECIFIED + - YEAR + - MONTH + - DAY_OF_MONTH + - DAY_OF_WEEK + - WEEK_OF_YEAR + - HOUR_OF_DAY + description: The part of the time to keep. + GooglePrivacyDlpV2InspectionRuleSet: properties: infoTypes: type: array - description: Set of sensitive infoTypes. items: - $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeDescription' + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + description: List of infoTypes this rule set is applied to. + rules: + type: array + description: >- + Set of rules to be applied to infoTypes. The rules are applied in + order. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectionRule' type: object - GooglePrivacyDlpV2Disabled: - properties: {} + id: GooglePrivacyDlpV2InspectionRuleSet + description: >- + Rule set for modifying a set of infoTypes to alter behavior under + certain circumstances, depending on the specific details of the rules + within the set. + GooglePrivacyDlpV2Bucket: + properties: + min: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: >- + Lower bound of the range, inclusive. Type should be the same as max + if used. + replacementValue: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Required. Replacement value for this bucket. + max: + description: Upper bound of the range, exclusive; type must match min. + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + description: Bucket is represented as a range, along with replacement values. type: object - id: GooglePrivacyDlpV2Disabled - description: Do not profile the tables. - GooglePrivacyDlpV2BoundingBox: + id: GooglePrivacyDlpV2Bucket + GooglePrivacyDlpV2Trigger: + description: What event needs to occur for a new job to be started. + properties: + schedule: + $ref: '#/components/schemas/GooglePrivacyDlpV2Schedule' + description: Create a job on a repeating basis based on the elapse of time. + manual: + $ref: '#/components/schemas/GooglePrivacyDlpV2Manual' + description: >- + For use with hybrid jobs. Jobs must be manually created and + finished. + id: GooglePrivacyDlpV2Trigger type: object - description: Bounding box encompassing detected text within an image. - id: GooglePrivacyDlpV2BoundingBox + GoogleTypeTimeOfDay: + description: >- + Represents a time of day. The date and time zone are either not + significant or are specified elsewhere. An API may choose to allow leap + seconds. Related types are google.type.Date and + `google.protobuf.Timestamp`. properties: - width: + nanos: + description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. format: int32 type: integer - description: Width of the bounding box in pixels. - height: - description: Height of the bounding box in pixels. + minutes: type: integer format: int32 - top: - description: Top coordinate of the bounding box. (0,0) is upper left. + description: Minutes of hour of day. Must be from 0 to 59. + seconds: type: integer format: int32 - left: + description: >- + Seconds of minutes of the time. Must normally be from 0 to 59. An + API may allow the value 60 if it allows leap-seconds. + hours: format: int32 - description: Left coordinate of the bounding box. (0,0) is upper left. + description: >- + Hours of day in 24 hour format. Should be from 0 to 23. An API may + choose to allow the value "24:00:00" for scenarios like business + closing time. type: integer - GooglePrivacyDlpV2Value: - description: >- - Set of primitive values supported by the system. Note that for the - purposes of inspection or transformation, the number of bytes considered - to comprise a 'Value' is based on its representation as a UTF-8 encoded - string. For example, if 'integer_value' is set to 123456789, the number - of bytes would be counted as 9, even though an int64 only holds up to 8 - bytes of data. - id: GooglePrivacyDlpV2Value + id: GoogleTypeTimeOfDay type: object + GooglePrivacyDlpV2ListProjectDataProfilesResponse: + id: GooglePrivacyDlpV2ListProjectDataProfilesResponse properties: - timeValue: - description: time of day - $ref: '#/components/schemas/GoogleTypeTimeOfDay' - booleanValue: - type: boolean - description: boolean - dateValue: - $ref: '#/components/schemas/GoogleTypeDate' - description: date - timestampValue: - format: google-datetime - description: timestamp - type: string - stringValue: - type: string - description: string - dayOfWeekValue: - enumDescriptions: - - The day of the week is unspecified. - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - enum: - - DAY_OF_WEEK_UNSPECIFIED - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY + nextPageToken: type: string - description: day of week - integerValue: - format: int64 - description: integer - type: string - floatValue: - description: float - type: number - format: double - GooglePrivacyDlpV2ReidentifyContentResponse: - description: Results of re-identifying an item. + description: The next page token. + projectDataProfiles: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + description: List of data profiles. + type: array + description: List of profiles generated for a given organization or project. type: object + GooglePrivacyDlpV2Dictionary: properties: - item: - $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' - description: The re-identified item. - overview: - description: An overview of the changes that were made to the `item`. - $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' - id: GooglePrivacyDlpV2ReidentifyContentResponse - GooglePrivacyDlpV2RequestedDeidentifyOptions: - description: De-identification options. - id: GooglePrivacyDlpV2RequestedDeidentifyOptions + cloudStoragePath: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + description: >- + Newline-delimited file of words in Cloud Storage. Only a single file + is accepted. + wordList: + description: List of words or phrases to search for. + $ref: '#/components/schemas/GooglePrivacyDlpV2WordList' + description: >- + Custom information type based on a dictionary of words or phrases. This + can be used to match sensitive information specific to the data, such as + a list of employee IDs or job titles. Dictionary words are + case-insensitive and all characters other than letters and digits in the + unicode [Basic Multilingual + Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) + will be replaced with whitespace when scanning for matches, so the + dictionary phrase "Sam Johnson" will match all three phrases "sam + johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the + characters surrounding any match must be of a different type than the + adjacent characters within the word, so letters must be next to + non-letters and digits next to non-digits. For example, the dictionary + word "jen" will match the first three letters of the text "jen123" but + will return no matches for "jennifer". Dictionary words containing a + large number of characters that are not letters or digits may result in + unexpected findings because such characters are treated as whitespace. + The [limits](https://cloud.google.com/sensitive-data-protection/limits) + page contains details about the size limits of dictionaries. For + dictionaries that do not fit within these constraints, consider using + `LargeCustomDictionaryConfig` in the `StoredInfoType` API. + id: GooglePrivacyDlpV2Dictionary type: object + GooglePrivacyDlpV2StorageMetadataLabel: properties: - snapshotStructuredDeidentifyTemplate: + key: + type: string + description: Label name. + description: >- + Storage metadata label to indicate which metadata entry contains + findings. + id: GooglePrivacyDlpV2StorageMetadataLabel + type: object + GooglePrivacyDlpV2CloudStorageOptions: + properties: + bytesLimitPerFilePercent: description: >- - Snapshot of the state of the structured `DeidentifyTemplate` from - the `Deidentify` action at the time this job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - snapshotDeidentifyTemplate: + Max percentage of bytes to scan from a file. The rest are omitted. + The number of bytes scanned is rounded down. Must be between 0 and + 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only + one of bytes_limit_per_file and bytes_limit_per_file_percent can be + specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + format: int32 + type: integer + filesLimitPercent: description: >- - Snapshot of the state of the `DeidentifyTemplate` from the - Deidentify action at the time this job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - snapshotImageRedactTemplate: + Limits the number of files to scan to this percentage of the input + FileSet. Number of files scanned is rounded down. Must be between 0 + and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. + type: integer + format: int32 + fileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2FileSet' + description: The set of one or more files to scan. + bytesLimitPerFile: + type: string + format: int64 description: >- - Snapshot of the state of the image transformation - `DeidentifyTemplate` from the `Deidentify` action at the time this - job was run. - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' - GooglePrivacyDlpV2FieldId: - description: General identifier of a data field in a storage service. + Max number of bytes to scan from a file. If a scanned file's size is + bigger than this value then the rest of the bytes are omitted. Only + one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can + be specified. This field can't be set if de-identification is + requested. For certain file types, setting this field has no effect. + For more information, see [Limits on bytes scanned per + file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file). + fileTypes: + description: >- + List of file type groups to include in the scan. If empty, all files + are scanned and available data format processors are applied. In + addition, the binary content of the selected files is always scanned + as well. Images are scanned only as binary if the specified region + does not support image inspection and no file_types were specified. + Image inspection is restricted to 'global', 'us', 'asia', and + 'europe'. + type: array + items: + enumDescriptions: + - Includes all files. + - >- + Includes all file extensions not covered by another entry. + Binary scanning attempts to convert the content of the file to + utf_8 to scan the file. If you wish to avoid this fall back, + specify one or more of the other file types in your storage + scan. + - >- + Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, + cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, + go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, + mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, + rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, + xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, + md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, + xsd, yml, yaml. + - >- + Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting + bytes_limit_per_file or bytes_limit_per_file_percent has no + effect on image files. Image inspection is restricted to the + `global`, `us`, `asia`, and `europe` regions. + - >- + Microsoft Word files larger than 30 MB will be scanned as binary + files. Included file extensions: docx, dotx, docm, dotm. Setting + `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no + effect on Word files. + - >- + PDF files larger than 30 MB will be scanned as binary files. + Included file extensions: pdf. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PDF files. + - 'Included file extensions: avro' + - 'Included file extensions: csv' + - 'Included file extensions: tsv' + - >- + Microsoft PowerPoint files larger than 30 MB will be scanned as + binary files. Included file extensions: pptx, pptm, potx, potm, + pot. Setting `bytes_limit_per_file` or + `bytes_limit_per_file_percent` has no effect on PowerPoint + files. + - >- + Microsoft Excel files larger than 30 MB will be scanned as + binary files. Included file extensions: xlsx, xlsm, xltx, xltm. + Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` + has no effect on Excel files. + enum: + - FILE_TYPE_UNSPECIFIED + - BINARY_FILE + - TEXT_FILE + - IMAGE + - WORD + - PDF + - AVRO + - CSV + - TSV + - POWERPOINT + - EXCEL + type: string + sampleMethod: + enum: + - SAMPLE_METHOD_UNSPECIFIED + - TOP + - RANDOM_START + description: How to sample the data. + type: string + enumDescriptions: + - No sampling. + - Scan from the top (default). + - >- + For each file larger than bytes_limit_per_file, randomly pick the + offset to start scanning. The scanned bytes are contiguous. + description: Options defining a file or a set of files within a Cloud Storage bucket. type: object - id: GooglePrivacyDlpV2FieldId + id: GooglePrivacyDlpV2CloudStorageOptions + GooglePrivacyDlpV2SaveFindings: properties: - name: - type: string - description: Name describing the field. - parameters: - quotaUser: + outputConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2OutputStorageConfig' + description: Location to store findings outside of DLP. + type: object + id: GooglePrivacyDlpV2SaveFindings description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - key: + If set, the detailed findings will be persisted to the specified + OutputStorageConfig. Only a single instance of this action can be + specified. Compatible with: Inspect, Risk + GooglePrivacyDlpV2TableReference: + properties: + tableId: + description: Name of the table. + type: string + datasetId: + description: Dataset ID of the table. + type: string description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: + Message defining the location of a BigQuery table with the projectId + inferred from the parent project. + type: object + id: GooglePrivacyDlpV2TableReference + GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues: + description: A tuple of values for the quasi-identifier columns. + properties: + quasiIdsValues: + type: array + description: The quasi-identifier values. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Value' + estimatedProbability: + type: number + description: >- + The estimated probability that a given individual sharing these + quasi-identifier values is in the dataset. This value, typically + called δ, is the ratio between the number of records in the dataset + with these quasi-identifier values, and the total number of + individuals (inside *and* outside the dataset) with these + quasi-identifier values. For example, if there are 15 individuals in + the dataset who share the same quasi-identifier values, and an + estimated 100 people in the entire population with these values, + then δ is 0.15. + format: double + type: object + id: GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues + GooglePrivacyDlpV2CloudSqlIamCredential: + type: object + description: >- + Use IAM authentication to connect. This requires the Cloud SQL IAM + feature to be enabled on the instance, which is not the default for + Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication + and https://cloud.google.com/sql/docs/mysql/authentication. + properties: {} + id: GooglePrivacyDlpV2CloudSqlIamCredential + GooglePrivacyDlpV2DocumentLocation: + type: object + description: Location of a finding within a document. + properties: + fileOffset: + description: >- + Offset of the line, from the beginning of the file, where the + finding is located. + format: int64 + type: string + id: GooglePrivacyDlpV2DocumentLocation + GooglePrivacyDlpV2PubSubNotification: + description: >- + Send a Pub/Sub message into the given Pub/Sub topic to connect other + systems to data profile generation. The message payload data will be the + byte serialization of `DataProfilePubSubMessage`. + id: GooglePrivacyDlpV2PubSubNotification + type: object + properties: + detailOfMessage: + enum: + - DETAIL_LEVEL_UNSPECIFIED + - TABLE_PROFILE + - RESOURCE_NAME + - FILE_STORE_PROFILE + enumDescriptions: + - Unused. + - The full table data profile. + - The name of the profiled resource. + - The full file store data profile. + type: string + description: >- + How much data to include in the Pub/Sub message. If the user wishes + to limit the size of the message, they can use resource_name and + fetch the profile fields they wish to. Per table profile (not per + column). + event: + type: string + description: >- + The type of event that triggers a Pub/Sub. At most one + `PubSubNotification` per EventType is permitted. + enumDescriptions: + - Unused. + - New profile (not a re-profile). + - >- + One of the following profile metrics changed: Data risk score, + Sensitivity score, Resource visibility, Encryption type, Predicted + infoTypes, Other infoTypes + - Table data risk score or sensitivity score increased. + - A user (non-internal) error occurred. + enum: + - EVENT_TYPE_UNSPECIFIED + - NEW_PROFILE + - CHANGED_PROFILE + - SCORE_INCREASED + - ERROR_CHANGED + pubsubCondition: + description: >- + Conditions (e.g., data risk or sensitivity level) for triggering a + Pub/Sub. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataProfilePubSubCondition' + topic: + description: >- + Cloud Pub/Sub topic to send notifications to. Format is + projects/{project}/topics/{topic}. + type: string + GooglePrivacyDlpV2InfoTypeDescription: + description: InfoType description. + type: object + properties: + categories: + description: The category of the infoType. + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeCategory' + name: + description: Internal name of the infoType. + type: string + versions: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2VersionDescription' + description: A list of available versions for the infotype. + description: + type: string + description: >- + Description of the infotype. Translated when language is provided in + the request. + displayName: + description: Human readable form of the infoType name. + type: string + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: The default sensitivity of the infoType. + supportedBy: + description: Which parts of the API supports this InfoType. + items: + type: string + enum: + - ENUM_TYPE_UNSPECIFIED + - INSPECT + - RISK_ANALYSIS + enumDescriptions: + - Unused. + - Supported by the inspect operations. + - Supported by the risk analysis operations. + type: array + id: GooglePrivacyDlpV2InfoTypeDescription + GooglePrivacyDlpV2ExcludeByHotword: + description: >- + The rule to exclude findings based on a hotword. For record inspection + of tables, column names are considered hotwords. An example of this is + to exclude a finding if it belongs to a BigQuery column that matches a + specific pattern. + type: object + id: GooglePrivacyDlpV2ExcludeByHotword + properties: + proximity: + description: >- + Range of characters within which the entire hotword must reside. The + total length of the window cannot exceed 1000 characters. The + windowBefore property in proximity should be set to 1 if the hotword + needs to be included in a column header. + $ref: '#/components/schemas/GooglePrivacyDlpV2Proximity' + hotwordRegex: + description: Regular expression pattern defining what qualifies as a hotword. + $ref: '#/components/schemas/GooglePrivacyDlpV2Regex' + GooglePrivacyDlpV2CreateJobTriggerRequest: + type: object + id: GooglePrivacyDlpV2CreateJobTriggerRequest + description: Request message for CreateJobTrigger. + properties: + jobTrigger: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + description: Required. The JobTrigger to create. + triggerId: + type: string + description: >- + The trigger id can contain uppercase and lowercase letters, numbers, + and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + locationId: + type: string + description: Deprecated. This field has no effect. + GooglePrivacyDlpV2PublishToStackdriver: + id: GooglePrivacyDlpV2PublishToStackdriver + description: >- + Enable Stackdriver metric dlp.googleapis.com/finding_count. This will + publish a metric to stack driver on each infotype requested and how many + findings were found for it. CustomDetectors will be bucketed as 'Custom' + under the Stackdriver label 'info_type'. + type: object + properties: {} + GooglePrivacyDlpV2UpdateJobTriggerRequest: + description: Request message for UpdateJobTrigger. + type: object + id: GooglePrivacyDlpV2UpdateJobTriggerRequest + properties: + updateMask: + format: google-fieldmask + type: string + description: Mask to control which fields get updated. + jobTrigger: + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + description: New JobTrigger value. + GooglePrivacyDlpV2FileStoreRegex: + properties: + cloudStorageRegex: + description: Optional. Regex for Cloud Storage. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegex' + id: GooglePrivacyDlpV2FileStoreRegex + description: A pattern to match against one or more file stores. + type: object + GooglePrivacyDlpV2KAnonymityResult: + id: GooglePrivacyDlpV2KAnonymityResult + description: Result of the k-anonymity computation. + properties: + equivalenceClassHistogramBuckets: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2KAnonymityHistogramBucket' + description: Histogram of k-anonymity equivalence classes. + type: object + GooglePrivacyDlpV2HybridInspectStatistics: + type: object + id: GooglePrivacyDlpV2HybridInspectStatistics + properties: + abortedCount: + description: >- + The number of hybrid inspection requests aborted because the job ran + out of quota or was ended before they could be processed. + type: string + format: int64 + processedCount: + description: The number of hybrid inspection requests processed within this job. + format: int64 + type: string + pendingCount: + description: >- + The number of hybrid requests currently being processed. Only + populated when called via method `getDlpJob`. A burst of traffic may + cause hybrid inspect requests to be enqueued. Processing will take + place as quickly as possible, but resource limitations may impact + how long a request is enqueued for. + type: string + format: int64 + description: Statistics related to processing hybrid inspect requests. + GooglePrivacyDlpV2AllInfoTypes: + id: GooglePrivacyDlpV2AllInfoTypes + type: object + description: Apply transformation to all findings. + properties: {} + GooglePrivacyDlpV2RecordLocation: + type: object + description: Location of a finding within a row or record. + id: GooglePrivacyDlpV2RecordLocation + properties: + fieldId: + description: Field id of the field containing the finding. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + recordKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordKey' + description: Key of the finding. + tableLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2TableLocation' + description: Location within a `ContentItem.Table`. + GooglePrivacyDlpV2Result: + description: >- + All result fields mentioned below are updated while the job is + processing. + type: object + properties: + infoTypeStats: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeStats' + description: >- + Statistics of how many instances of each info type were found during + inspect job. + type: array + hybridStats: + description: Statistics related to the processing of hybrid inspect. + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectStatistics' + numRowsProcessed: + format: int64 + description: >- + Number of rows scanned after sampling and time filtering (applicable + for row based stores such as BigQuery). + type: string + totalEstimatedBytes: + type: string + description: Estimate of the number of bytes to process. + format: int64 + processedBytes: + format: int64 + description: Total size in bytes that were processed. + type: string + id: GooglePrivacyDlpV2Result + GooglePrivacyDlpV2CryptoHashConfig: + id: GooglePrivacyDlpV2CryptoHashConfig + properties: + cryptoKey: + $ref: '#/components/schemas/GooglePrivacyDlpV2CryptoKey' + description: The key used by the hash function. + description: >- + Pseudonymization method that generates surrogates via cryptographic + hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. + Outputs a base64 encoded representation of the hashed output (for + example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only + string and integer values can be hashed. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization + to learn more. + type: object + GooglePrivacyDlpV2ImageTransformation: + type: object + properties: + allInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2AllInfoTypes' + description: >- + Apply transformation to all findings not specified in other + ImageTransformation's selected_info_types. Only one instance is + allowed within the ImageTransformations message. + selectedInfoTypes: + $ref: '#/components/schemas/GooglePrivacyDlpV2SelectedInfoTypes' + description: Apply transformation to the selected info_types. + redactionColor: + description: >- + The color to use when redacting content from an image. If not + specified, the default is black. + $ref: '#/components/schemas/GooglePrivacyDlpV2Color' + allText: + description: >- + Apply transformation to all text that doesn't match an infoType. + Only one instance is allowed within the ImageTransformations + message. + $ref: '#/components/schemas/GooglePrivacyDlpV2AllText' + description: Configuration for determining how redaction of images should occur. + id: GooglePrivacyDlpV2ImageTransformation + GooglePrivacyDlpV2QuasiIdField: + properties: + customTag: + description: A auxiliary field. + type: string + field: + description: Identifies the column. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: >- + A quasi-identifier column has a custom_tag, used to know which column in + the data corresponds to which column in the statistical model. + id: GooglePrivacyDlpV2QuasiIdField + type: object + GooglePrivacyDlpV2UpdateDiscoveryConfigRequest: + description: Request message for UpdateDiscoveryConfig. + id: GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + properties: + updateMask: + format: google-fieldmask + description: Mask to control which fields get updated. + type: string + discoveryConfig: + description: Required. New DiscoveryConfig value. + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + type: object + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + properties: + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + details: + type: array + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: object + id: GoogleRpcStatus + GooglePrivacyDlpV2PartitionId: + properties: + namespaceId: + type: string + description: If not empty, the ID of the namespace to which the entities belong. + projectId: + description: The ID of the project to which the entities belong. + type: string + type: object + id: GooglePrivacyDlpV2PartitionId + description: >- + Datastore partition ID. A partition ID identifies a grouping of + entities. The grouping is always by project and namespace, however the + namespace ID may be empty. A partition ID contains several dimensions: + project ID and namespace ID. + GooglePrivacyDlpV2DetectionRule: + id: GooglePrivacyDlpV2DetectionRule + type: object + description: >- + Deprecated; use `InspectionRuleSet` instead. Rule for modifying a + `CustomInfoType` to alter behavior under certain circumstances, + depending on the specific details of the rule. Not supported for the + `surrogate_type` custom infoType. + properties: + hotwordRule: + description: Hotword-based detection rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + GooglePrivacyDlpV2Expressions: + type: object + id: GooglePrivacyDlpV2Expressions + description: An expression, consisting of an operator and conditions. + properties: + logicalOperator: + enumDescriptions: + - Unused + - Conditional AND + type: string + description: >- + The operator to apply to the result of conditions. Default and + currently only supported value is `AND`. + enum: + - LOGICAL_OPERATOR_UNSPECIFIED + - AND + conditions: + $ref: '#/components/schemas/GooglePrivacyDlpV2Conditions' + description: Conditions to apply to the expression. + GooglePrivacyDlpV2RecordTransformations: + id: GooglePrivacyDlpV2RecordTransformations + type: object + properties: + fieldTransformations: + type: array + description: Transform the record by applying various field transformations. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + recordSuppressions: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + description: >- + Configuration defining which records get suppressed entirely. + Records that match any suppression rule are omitted from the output. + type: array + description: >- + A type of transformation that is applied over structured data such as a + table. + GooglePrivacyDlpV2HybridOptions: + description: >- + Configuration to control jobs where the content being inspected is + outside of Google Cloud Platform. + type: object + properties: + requiredFindingLabelKeys: + type: array + items: + type: string + description: >- + These are labels that each inspection request must include within + their 'finding_labels' map. Request may contain others, but any + missing one of these will be rejected. Label keys must be between 1 + and 63 characters long and must conform to the following regular + expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can + be required. + labels: + description: >- + To organize findings, these labels will be added to each finding. + Label keys must be between 1 and 63 characters long and must conform + to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. + Label values must be between 0 and 63 characters long and must + conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. + No more than 10 labels can be associated with a given finding. + Examples: * `"environment" : "production"` * `"pipeline" : "etl"` + additionalProperties: + type: string + type: object + description: + type: string + description: >- + A short description of where the data is coming from. Will be stored + once in the job. 256 max length. + tableOptions: + description: >- + If the container is a table, additional information to make findings + meaningful such as the columns that are primary keys. + $ref: '#/components/schemas/GooglePrivacyDlpV2TableOptions' + id: GooglePrivacyDlpV2HybridOptions + GooglePrivacyDlpV2TransformationSummary: + id: GooglePrivacyDlpV2TransformationSummary + properties: + infoType: + description: Set if the transformation was limited to a specific InfoType. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + fieldTransformations: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldTransformation' + type: array + description: >- + The field transformation that was applied. If multiple field + transformations are requested for a single field, this list will + contain all of them; otherwise, only one is supplied. + transformation: + description: The specific transformation these stats apply to. + $ref: '#/components/schemas/GooglePrivacyDlpV2PrimitiveTransformation' + results: + type: array + description: Collection of all transformations that took place or had an error. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2SummaryResult' + recordSuppress: + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordSuppression' + description: The specific suppression option these stats apply to. + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Set if the transformation was limited to a specific FieldId. + transformedBytes: + description: Total size in bytes that were transformed in some way. + type: string + format: int64 + description: >- + Summary of a single transformation. Only one of 'transformation', + 'field_transformation', or 'record_suppress' will be set. + type: object + GooglePrivacyDlpV2Export: + description: >- + If set, the detailed data profiles will be persisted to the location of + your choice whenever updated. + type: object + properties: + profileTable: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryTable' + description: >- + Store all table and column profiles in an existing table or a new + table in an existing dataset. Each re-generation will result in new + rows in BigQuery. Data is inserted using [streaming + insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) + and so data may be in the buffer for a period of time after the + profile has finished. The Pub/Sub notification is sent before the + streaming buffer is guaranteed to be written, so data may not be + instantly visible to queries by the time your topic receives the + Pub/Sub notification. + id: GooglePrivacyDlpV2Export + GooglePrivacyDlpV2FileSet: + properties: + regexFileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageRegexFileSet' + description: >- + The regex-filtered set of files to scan. Exactly one of `url` or + `regex_file_set` must be set. + url: + description: >- + The Cloud Storage url of the file(s) to scan, in the format + `gs:///`. Trailing wildcard in the path is allowed. If the url ends + in a trailing slash, the bucket or directory represented by the url + will be scanned non-recursively (content in sub-directories will not + be scanned). This means that `gs://mybucket/` is equivalent to + `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to + `gs://mybucket/directory/*`. Exactly one of `url` or + `regex_file_set` must be set. + type: string + id: GooglePrivacyDlpV2FileSet + description: Set of files to scan. + type: object + GooglePrivacyDlpV2HybridInspectDlpJobRequest: + description: Request to search for potentially sensitive info in a custom location. + id: GooglePrivacyDlpV2HybridInspectDlpJobRequest + type: object + properties: + hybridItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridContentItem' + description: The item to inspect. + GooglePrivacyDlpV2CreateDeidentifyTemplateRequest: + type: object + properties: + locationId: + description: Deprecated. This field has no effect. + type: string + deidentifyTemplate: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: Required. The DeidentifyTemplate to create. + templateId: + type: string + description: >- + The template id can contain uppercase and lowercase letters, + numbers, and hyphens; that is, it must match the regular expression: + `[a-zA-Z\d-_]+`. The maximum length is 100 characters. Can be empty + to allow the system to generate one. + id: GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + description: Request message for CreateDeidentifyTemplate. + GooglePrivacyDlpV2InspectionRule: + type: object + description: >- + A single inspection rule to be applied to infoTypes, specified in + `InspectionRuleSet`. + id: GooglePrivacyDlpV2InspectionRule + properties: + exclusionRule: + description: Exclusion rule. + $ref: '#/components/schemas/GooglePrivacyDlpV2ExclusionRule' + hotwordRule: + $ref: '#/components/schemas/GooglePrivacyDlpV2HotwordRule' + description: Hotword-based detection rule. + GooglePrivacyDlpV2TableLocation: + type: object + id: GooglePrivacyDlpV2TableLocation + description: Location of a finding within a table. + properties: + rowIndex: + type: string + description: >- + The zero-based index of the row where the finding is located. Only + populated for resources that have a natural ordering, not BigQuery. + In BigQuery, to identify the row a finding came from, populate + BigQueryOptions.identifying_fields with your primary key column + names and when you store the findings the value of those columns + will be stored inside of Finding. + format: int64 + GooglePrivacyDlpV2ReidentifyContentResponse: + id: GooglePrivacyDlpV2ReidentifyContentResponse + properties: + overview: + $ref: '#/components/schemas/GooglePrivacyDlpV2TransformationOverview' + description: An overview of the changes that were made to the `item`. + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The re-identified item. + type: object + description: Results of re-identifying an item. + GooglePrivacyDlpV2TaggedField: + properties: + customTag: + description: >- + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). + type: string + infoType: + description: >- + A column can be tagged with a InfoType to use the relevant public + dataset as a statistical model of population, if available. We + currently support US ZIP codes, region codes, ages and genders. To + programmatically obtain the list of supported InfoTypes, use + ListInfoTypes with the supported_by=RISK_ANALYSIS filter. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + inferred: + description: >- + If no semantic tag is indicated, we infer the statistical model from + the distribution of values in the input data + $ref: '#/components/schemas/GoogleProtobufEmpty' + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Required. Identifies the column. + description: A column with a semantic tag attached. + id: GooglePrivacyDlpV2TaggedField + type: object + GooglePrivacyDlpV2BigQueryRegex: + description: >- + A pattern to match against one or more tables, datasets, or projects + that contain BigQuery tables. At least one pattern must be specified. + Regular expressions use RE2 + [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be + found under the google/re2 repository on GitHub. + properties: + tableIdRegex: + description: If unset, this property matches all tables. + type: string + projectIdRegex: + type: string + description: >- + For organizations, if unset, will match all projects. Has no effect + for data profile configurations created within a project. + datasetIdRegex: + type: string + description: If unset, this property matches all datasets. + id: GooglePrivacyDlpV2BigQueryRegex + type: object + GooglePrivacyDlpV2MetadataLocation: + type: object + properties: + type: + enum: + - METADATATYPE_UNSPECIFIED + - STORAGE_METADATA + enumDescriptions: + - Unused + - General file metadata provided by Cloud Storage. + description: Type of metadata containing the finding. + type: string + storageLabel: + description: Storage metadata. + $ref: '#/components/schemas/GooglePrivacyDlpV2StorageMetadataLabel' + id: GooglePrivacyDlpV2MetadataLocation + description: Metadata Location + GooglePrivacyDlpV2DiscoveryTarget: + properties: + secretsTarget: + description: >- + Discovery target that looks for credentials and secrets stored in + cloud resource metadata and reports them as vulnerabilities to + Security Command Center. Only one target of this type is allowed. + $ref: '#/components/schemas/GooglePrivacyDlpV2SecretsDiscoveryTarget' + cloudStorageTarget: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageDiscoveryTarget' + description: >- + Cloud Storage target for Discovery. The first target to match a + table will be the one applied. + cloudSqlTarget: + description: >- + Cloud SQL target for Discovery. The first target to match a table + will be the one applied. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudSqlDiscoveryTarget' + bigQueryTarget: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryDiscoveryTarget' + description: >- + BigQuery target for Discovery. The first target to match a table + will be the one applied. + type: object + description: Target used to match against for Discovery. + id: GooglePrivacyDlpV2DiscoveryTarget + GooglePrivacyDlpV2DataSourceType: + id: GooglePrivacyDlpV2DataSourceType + type: object + description: Message used to identify the type of resource being profiled. + properties: + dataSource: + description: >- + Output only. An identifying string to the type of resource being + profiled. Current values: * google/bigquery/table * google/project * + google/sql/table * google/gcs/bucket + type: string + readOnly: true + GooglePrivacyDlpV2QuasiIdentifierField: + type: object + properties: + customTag: + type: string + description: >- + A column can be tagged with a custom tag. In this case, the user + must indicate an auxiliary table that contains statistical + information on the possible values of this column (below). + field: + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + description: Identifies the column. + description: >- + A quasi-identifier column has a custom_tag, used to know which column in + the data corresponds to which column in the statistical model. + id: GooglePrivacyDlpV2QuasiIdentifierField + GoogleTypeDate: + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + id: GoogleTypeDate + properties: + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + format: int32 + type: integer + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + type: integer + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + format: int32 + type: integer + GooglePrivacyDlpV2LargeCustomDictionaryConfig: + properties: + cloudStorageFileSet: + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStorageFileSet' + description: >- + Set of files containing newline-delimited lists of dictionary + phrases. + outputPath: + description: >- + Location to store dictionary artifacts in Cloud Storage. These files + will only be accessible by project owners and the DLP API. If any of + these artifacts are modified, the dictionary is considered invalid + and can no longer be used. + $ref: '#/components/schemas/GooglePrivacyDlpV2CloudStoragePath' + bigQueryField: + $ref: '#/components/schemas/GooglePrivacyDlpV2BigQueryField' + description: >- + Field in a BigQuery table where each cell represents a dictionary + phrase. + type: object + id: GooglePrivacyDlpV2LargeCustomDictionaryConfig + description: >- + Configuration for a custom dictionary created from a data source of any + size up to the maximum size defined in the + [limits](https://cloud.google.com/sensitive-data-protection/limits) + page. The artifacts of dictionary creation are stored in the specified + Cloud Storage location. Consider using `CustomInfoType.Dictionary` for + smaller dictionaries that satisfy the size requirements. + GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog: + type: object + properties: {} + id: GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog + description: >- + Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag + templates are applied to the resource that Cloud DLP scanned. Data + Catalog tag templates are stored in the same project and region where + the BigQuery table exists. For Cloud DLP to create and apply the tag + template, the Cloud DLP service agent must have the + `roles/datacatalog.tagTemplateOwner` permission on the project. The tag + template contains fields summarizing the results of the DlpJob. Any + field values previously written by another DlpJob are deleted. InfoType + naming patterns are strictly enforced when using this feature. Findings + are persisted in Data Catalog storage and are governed by + service-specific policies for Data Catalog. For more information, see + [Service Specific Terms](https://cloud.google.com/terms/service-terms). + Only a single instance of this action can be specified. This action is + allowed only if all resources being scanned are BigQuery tables. + Compatible with: Inspect + GooglePrivacyDlpV2DatastoreKey: + type: object + properties: + entityKey: + description: Datastore entity key. + $ref: '#/components/schemas/GooglePrivacyDlpV2Key' + description: Record key for a finding in Cloud Datastore. + id: GooglePrivacyDlpV2DatastoreKey + GooglePrivacyDlpV2AllOtherResources: + type: object + properties: {} + id: GooglePrivacyDlpV2AllOtherResources + description: Match discovery resources not covered by any other filter. + GooglePrivacyDlpV2BucketingConfig: + id: GooglePrivacyDlpV2BucketingConfig + description: >- + Generalization function that buckets values based on ranges. The ranges + and replacement values are dynamically provided by the user for custom + behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can + be used on data of type: number, long, string, timestamp. If the bound + `Value` type differs from the type of data being transformed, we will + first attempt converting the type of the data to be transformed to match + the type of the bound before comparing. See + https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing + to learn more. + type: object + properties: + buckets: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2Bucket' + description: Set of buckets. Ranges must be non-overlapping. + type: array + GooglePrivacyDlpV2ContentLocation: + id: GooglePrivacyDlpV2ContentLocation + description: >- + Precise location of the finding within a document, record, image, or + metadata container. + properties: + containerVersion: + description: >- + Finding container version, if available ("generation" for Cloud + Storage). + type: string + containerName: + description: >- + Name of the container where the finding is located. The top level + name is the source file name or table name. Names of some common + storage containers are formatted as follows: * BigQuery tables: + `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: + `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested + names could be absent if the embedded object has no string + identifier (for example, an image contained within a document). + type: string + recordLocation: + description: Location within a row or record of a database table. + $ref: '#/components/schemas/GooglePrivacyDlpV2RecordLocation' + imageLocation: + description: Location within an image's pixels. + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageLocation' + containerTimestamp: + type: string + description: >- + Finding container modification timestamp, if applicable. For Cloud + Storage, this field contains the last file modification timestamp. + For a BigQuery table, this field contains the last_modified_time + property. For Datastore, this field isn't populated. + format: google-datetime + documentLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2DocumentLocation' + description: Location data for document files. + metadataLocation: + $ref: '#/components/schemas/GooglePrivacyDlpV2MetadataLocation' + description: Location within the metadata for inspected content. + type: object + GooglePrivacyDlpV2ReidentifyContentRequest: + description: Request to re-identify an item. + id: GooglePrivacyDlpV2ReidentifyContentRequest + type: object + properties: + inspectConfig: + description: Configuration for the inspector. + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + reidentifyTemplateName: + type: string + description: >- + Template to use. References an instance of `DeidentifyTemplate`. Any + configuration directly specified in `reidentify_config` or + `inspect_config` will override those set in the template. The + `DeidentifyTemplate` used must include only reversible + transformations. Singular fields that are set in this request will + replace their corresponding fields in the template. Repeated fields + are appended. Singular sub-messages and groups are recursively + merged. + item: + $ref: '#/components/schemas/GooglePrivacyDlpV2ContentItem' + description: The item to re-identify. Will be treated as text. + inspectTemplateName: + type: string + description: >- + Template to use. Any configuration directly specified in + `inspect_config` will override those set in the template. Singular + fields that are set in this request will replace their corresponding + fields in the template. Repeated fields are appended. Singular + sub-messages and groups are recursively merged. + reidentifyConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyConfig' + description: >- + Configuration for the re-identification of the content item. This + field shares the same proto message type that is used for + de-identification, however its usage here is for the reversal of the + previous de-identification. Re-identification is performed by + examining the transformations used to de-identify the items and + executing the reverse. This requires that only reversible + transformations be provided here. The reversible transformations + are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig` + locationId: + description: Deprecated. This field has no effect. + type: string + GooglePrivacyDlpV2DiscoveryFileStoreConditions: + description: >- + Requirements that must be true before a file store is scanned in + discovery for the first time. There is an AND relationship between the + top-level attributes. + id: GooglePrivacyDlpV2DiscoveryFileStoreConditions + type: object + properties: + createdAfter: + description: >- + Optional. File store must have been created after this date. Used to + avoid backfilling. + format: google-datetime + type: string + cloudStorageConditions: + description: Optional. Cloud Storage conditions. + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DiscoveryCloudStorageConditions + minAge: + description: >- + Optional. Minimum age a file store must have. If set, the value must + be 1 hour or greater. + type: string + format: google-duration + GooglePrivacyDlpV2Key: + id: GooglePrivacyDlpV2Key + type: object + description: >- + A unique identifier for a Datastore entity. If a key's partition ID or + any of its path kinds or names are reserved/read-only, the key is + reserved/read-only. A reserved/read-only key is forbidden in certain + documented contexts. + properties: + path: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2PathElement' + type: array + description: >- + The entity path. An entity path consists of one or more elements + composed of a kind and a string or numerical identifier, which + identify entities. The first element identifies a _root entity_, the + second element identifies a _child_ of the root entity, the third + element identifies a child of the second entity, and so forth. The + entities identified by all prefixes of the path are called the + element's _ancestors_. A path can never be empty, and a path can + have at most 100 elements. + partitionId: + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' + description: >- + Entities are partitioned into subsets, currently identified by a + project ID and namespace ID. Queries are scoped to a single + partition. + GooglePrivacyDlpV2ListColumnDataProfilesResponse: + properties: + nextPageToken: + type: string + description: The next page token. + columnDataProfiles: + type: array + description: List of data profiles. + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + description: List of profiles generated for a given organization or project. + type: object + id: GooglePrivacyDlpV2ListColumnDataProfilesResponse + GooglePrivacyDlpV2FileStoreInfoTypeSummary: + description: Information regarding the discovered InfoType. + type: object + properties: + infoType: + description: The InfoType seen. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoType' + id: GooglePrivacyDlpV2FileStoreInfoTypeSummary + GooglePrivacyDlpV2ColumnDataProfile: + id: GooglePrivacyDlpV2ColumnDataProfile + type: object + description: The profile for a scanned column within a table. + properties: + state: + enumDescriptions: + - Unused. + - >- + The profile is currently running. Once a profile has finished it + will transition to DONE. + - >- + The profile is no longer generating. If profile_status.status.code + is 0, the profile succeeded, otherwise, it failed. + description: State of a profile. + enum: + - STATE_UNSPECIFIED + - RUNNING + - DONE + type: string + profileStatus: + description: >- + Success or error status from the most recent profile generation + attempt. May be empty if the profile is still being generated. + $ref: '#/components/schemas/GooglePrivacyDlpV2ProfileStatus' + datasetId: + description: The BigQuery dataset ID. + type: string + column: + description: The name of the column. + type: string + tableDataProfile: + type: string + description: The resource name of the table data profile. + tableFullResource: + type: string + description: The resource name of the resource this column is within. + columnType: + description: The data type of a given column. + enumDescriptions: + - Invalid type. + - Encoded as a string in decimal format. + - Encoded as a boolean "false" or "true". + - Encoded as a number, or string "NaN", "Infinity" or "-Infinity". + - Encoded as a string value. + - Encoded as a base64 string per RFC 4648, section 4. + - >- + Encoded as an RFC 3339 timestamp with mandatory "Z" time zone + string: 1985-04-12T23:20:50.52Z + - 'Encoded as RFC 3339 full-date format string: 1985-04-12' + - 'Encoded as RFC 3339 partial-time format string: 23:20:50.52' + - >- + Encoded as RFC 3339 full-date "T" partial-time: + 1985-04-12T23:20:50.52 + - Encoded as WKT + - Encoded as a decimal string. + - Container of ordered fields, each with a type and field name. + - Decimal type. + - Json type. + - Interval type. + - '`Range` type.' + - '`Range` type.' + - '`Range` type.' + enum: + - COLUMN_DATA_TYPE_UNSPECIFIED + - TYPE_INT64 + - TYPE_BOOL + - TYPE_FLOAT64 + - TYPE_STRING + - TYPE_BYTES + - TYPE_TIMESTAMP + - TYPE_DATE + - TYPE_TIME + - TYPE_DATETIME + - TYPE_GEOGRAPHY + - TYPE_NUMERIC + - TYPE_RECORD + - TYPE_BIGNUMERIC + - TYPE_JSON + - TYPE_INTERVAL + - TYPE_RANGE_DATE + - TYPE_RANGE_DATETIME + - TYPE_RANGE_TIMESTAMP + type: string + datasetLocation: + type: string + description: >- + The BigQuery location where the dataset's data is stored. See + https://cloud.google.com/bigquery/docs/locations for supported + locations. + columnInfoType: + description: >- + If it's been determined this column can be identified as a single + type, this will be set. Otherwise the column either has + unidentifiable content or mixed types. + $ref: '#/components/schemas/GooglePrivacyDlpV2InfoTypeSummary' + otherMatches: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2OtherInfoTypeSummary' + description: Other types found within this column. List will be unordered. + type: array + datasetProjectId: + description: The Google Cloud project ID that owns the profiled resource. + type: string + estimatedUniquenessScore: + enumDescriptions: + - >- + Some columns do not have estimated uniqueness. Possible reasons + include having too few values. + - >- + Low uniqueness, possibly a boolean, enum or similiarly typed + column. + - Medium uniqueness. + - >- + High uniqueness, possibly a column of free text or unique + identifiers. + enum: + - UNIQUENESS_SCORE_LEVEL_UNSPECIFIED + - UNIQUENESS_SCORE_LOW + - UNIQUENESS_SCORE_MEDIUM + - UNIQUENESS_SCORE_HIGH + type: string + description: Approximate uniqueness of the column. + dataRiskLevel: + description: The data risk level for this column. + $ref: '#/components/schemas/GooglePrivacyDlpV2DataRiskLevel' + policyState: + enum: + - COLUMN_POLICY_STATE_UNSPECIFIED + - COLUMN_POLICY_TAGGED + enumDescriptions: + - No policy tags. + - Column has policy tag applied. + type: string + description: Indicates if a policy tag has been applied to the column. + profileLastGenerated: + description: The last time the profile was generated. + type: string + format: google-datetime + estimatedNullPercentage: + enum: + - NULL_PERCENTAGE_LEVEL_UNSPECIFIED + - NULL_PERCENTAGE_VERY_LOW + - NULL_PERCENTAGE_LOW + - NULL_PERCENTAGE_MEDIUM + - NULL_PERCENTAGE_HIGH + type: string + enumDescriptions: + - Unused. + - Very few null entries. + - Some null entries. + - A few null entries. + - A lot of null entries. + description: Approximate percentage of entries being null in the column. + tableId: + description: The BigQuery table ID. + type: string + freeTextScore: + type: number + format: double + description: >- + The likelihood that this column contains free-form text. A value + close to 1 may indicate the column is likely to contain free-form or + natural language text. Range in 0-1. + name: + type: string + description: The name of the profile. + sensitivityScore: + description: The sensitivity of this column. + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + GooglePrivacyDlpV2DatabaseResourceReference: + type: object + properties: + databaseResource: + type: string + description: >- + Required. Name of a database resource, for example, a table within + the database. + projectId: + type: string + description: >- + Required. If within a project-level config, then this must match the + config's project ID. + database: + type: string + description: Required. Name of a database within the instance. + instance: + type: string + description: >- + Required. The instance where this resource is located. For example: + Cloud SQL instance ID. + id: GooglePrivacyDlpV2DatabaseResourceReference + description: Identifies a single database resource, like a table within a database. + GooglePrivacyDlpV2ListDeidentifyTemplatesResponse: + properties: + nextPageToken: + type: string + description: >- + If the next page is available then the next page token to be used in + the following ListDeidentifyTemplates request. + deidentifyTemplates: + type: array + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + description: >- + List of deidentify templates, up to page_size in + ListDeidentifyTemplatesRequest. + type: object + id: GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + description: Response message for ListDeidentifyTemplates. + GooglePrivacyDlpV2AllOtherBigQueryTables: + type: object + properties: {} + description: >- + Catch-all for all other tables not specified by other filters. Should + always be last, except for single-table configurations, which will only + have a TableReference target. + id: GooglePrivacyDlpV2AllOtherBigQueryTables + GooglePrivacyDlpV2DatastoreOptions: + description: Options defining a data set within Google Cloud Datastore. + type: object + properties: + kind: + $ref: '#/components/schemas/GooglePrivacyDlpV2KindExpression' + description: The kind to process. + partitionId: + description: >- + A partition ID identifies a grouping of entities. The grouping is + always by project and namespace, however the namespace ID may be + empty. + $ref: '#/components/schemas/GooglePrivacyDlpV2PartitionId' + id: GooglePrivacyDlpV2DatastoreOptions + GooglePrivacyDlpV2PathElement: + properties: + id: + type: string + format: int64 + description: >- + The auto-allocated ID of the entity. Never equal to zero. Values + less than zero are discouraged and may not be supported in the + future. + name: + type: string + description: >- + The name of the entity. A name matching regex `__.*__` is + reserved/read-only. A name must not be more than 1500 bytes when + UTF-8 encoded. Cannot be `""`. + kind: + description: >- + The kind of the entity. A kind matching regex `__.*__` is + reserved/read-only. A kind must not contain more than 1500 bytes + when UTF-8 encoded. Cannot be `""`. + type: string + id: GooglePrivacyDlpV2PathElement + description: >- + A (kind, ID/name) pair used to construct a key path. If either name or + ID is set, the element is complete. If neither is set, the element is + incomplete. + type: object + GooglePrivacyDlpV2InfoType: + properties: + version: + description: Optional version name for this InfoType. + type: string + name: + description: >- + Name of the information type. Either a name of your choosing when + creating a CustomInfoType, or one of the names listed at + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + when specifying a built-in type. When sending Cloud DLP results to + Data Catalog, infoType names should conform to the pattern + `[A-Za-z0-9$_-]{1,64}`. + type: string + sensitivityScore: + $ref: '#/components/schemas/GooglePrivacyDlpV2SensitivityScore' + description: >- + Optional custom sensitivity for this InfoType. This only applies to + data profiling. + type: object + description: Type of information detected by the API. + id: GooglePrivacyDlpV2InfoType + GooglePrivacyDlpV2RedactImageRequest: + type: object + description: >- + Request to search for potentially sensitive info in an image and redact + it by covering it with a colored rectangle. + properties: + imageRedactionConfigs: + items: + $ref: '#/components/schemas/GooglePrivacyDlpV2ImageRedactionConfig' + description: The configuration for specifying what content to redact from images. + type: array + locationId: + description: Deprecated. This field has no effect. + type: string + byteItem: + $ref: '#/components/schemas/GooglePrivacyDlpV2ByteContentItem' + description: The content must be PNG, JPEG, SVG or BMP. + includeFindings: + type: boolean + description: >- + Whether the response should include findings along with the redacted + image. + inspectConfig: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectConfig' + description: Configuration for the inspector. + id: GooglePrivacyDlpV2RedactImageRequest + GooglePrivacyDlpV2RecordTransformation: + id: GooglePrivacyDlpV2RecordTransformation + properties: + containerVersion: + type: string + description: Container version, if available ("generation" for Cloud Storage). + fieldId: + description: For record transformations, provide a field. + $ref: '#/components/schemas/GooglePrivacyDlpV2FieldId' + containerTimestamp: + format: google-datetime + type: string + description: Findings container modification timestamp, if applicable. + description: The field in a record to transform. + type: object + parameters: + alt: + description: Data format for response. + in: query + name: alt + schema: type: string enum: - json - media - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string _.xgafv: description: V1 error format. in: query @@ -7081,10 +7759,19 @@ components: enum: - '1' - '2' - fields: - description: Selector specifying which fields to include in a partial response. + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: fields + name: uploadType schema: type: string access_token: @@ -7093,16 +7780,19 @@ components: name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: prettyPrint + name: quotaUser schema: - type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + type: string + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string x-stackQL-resources: @@ -7111,15 +7801,15 @@ components: name: info_types title: Info_types methods: - locations_info_types_list: + info_types_list: operation: - $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' + $ref: '#/paths/~1v2~1infoTypes/get' response: mediaType: application/json openAPIDocKey: '200' - info_types_list: + locations_info_types_list: operation: - $ref: '#/paths/~1v2~1infoTypes/get' + $ref: '#/paths/~1v2~1locations~1{locationsId}~1infoTypes/get' response: mediaType: application/json openAPIDocKey: '200' @@ -7131,387 +7821,602 @@ components: #/components/x-stackQL-resources/info_types/methods/info_types_list insert: [] update: [] + replace: [] delete: [] - content: - id: google.dlp.content - name: content - title: Content + connections: + id: google.dlp.connections + name: connections + title: Connections + methods: + projects_locations_connections_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_connections_patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_connections_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_connections_search: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_connections_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + projects_locations_connections_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.connections + organizations_locations_connections_create: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_connections_search: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_get + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_list + insert: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_create + update: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete + - $ref: >- + #/components/x-stackQL-resources/connections/methods/organizations_locations_connections_delete + dlp_jobs: + id: google.dlp.dlp_jobs + name: dlp_jobs + title: Dlp_jobs + methods: + projects_locations_dlp_jobs_hybrid_inspect: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + projects_locations_dlp_jobs_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_cancel: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_dlp_jobs_finish: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_get: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_delete: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_cancel: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_create: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_dlp_jobs_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + organizations_locations_dlp_jobs_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.jobs + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_get + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_get + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/organizations_locations_dlp_jobs_list + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_create + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete + - $ref: >- + #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete + job_triggers: + id: google.dlp.job_triggers + name: job_triggers + title: Job_triggers methods: - projects_content_inspect: + projects_locations_job_triggers_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - projects_content_reidentify: + projects_locations_job_triggers_list: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get response: mediaType: application/json openAPIDocKey: '200' - projects_content_deidentify: + objectKey: $.jobTriggers + projects_locations_job_triggers_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_inspect: + projects_locations_job_triggers_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_deidentify: + projects_locations_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_content_reidentify: + projects_locations_job_triggers_hybrid_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - dlp_jobs: - id: google.dlp.dlp_jobs - name: dlp_jobs - title: Dlp_jobs - methods: - projects_dlp_jobs_get: + projects_locations_job_triggers_activate: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/get' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - projects_dlp_jobs_delete: + projects_job_triggers_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}/delete' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_dlp_jobs_list: - operation: &ref_1 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.jobs - projects_dlp_jobs_list: - operation: *ref_1 - response: *ref_2 - projects_dlp_jobs_create: + projects_job_triggers_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1dlpJobs/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_dlp_jobs_cancel: + projects_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1dlpJobs~1{dlpJobsId}:cancel/post + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_hybrid_inspect: + projects_job_triggers_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:hybridInspect/post + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_delete: + projects_job_triggers_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_get: + objectKey: $.jobTriggers + projects_job_triggers_activate: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}/get + #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_finish: + organizations_locations_job_triggers_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:finish/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_dlp_jobs_create: + organizations_locations_job_triggers_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_dlp_jobs_list: - operation: &ref_3 + organizations_locations_job_triggers_get: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs/get - response: &ref_4 + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobs - projects_locations_dlp_jobs_list: - operation: *ref_3 - response: *ref_4 - projects_locations_dlp_jobs_cancel: + organizations_locations_job_triggers_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1dlpJobs~1{dlpJobsId}:cancel/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_dlp_jobs_list: - operation: &ref_5 + organizations_locations_job_triggers_list: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1dlpJobs/get - response: &ref_6 + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobs - organizations_locations_dlp_jobs_list: - operation: *ref_5 - response: *ref_6 + objectKey: $.jobTriggers sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_get + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_get + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_list + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_list - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/organizations_locations_dlp_jobs_list + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_get - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_list + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_list + - $ref: >- + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_list insert: - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_create + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_create - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_create - update: [] + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_create + - $ref: >- + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_create + update: + - $ref: >- + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_patch + - $ref: >- + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_patch + - $ref: >- + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_locations_dlp_jobs_delete + #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_delete - $ref: >- - #/components/x-stackQL-resources/dlp_jobs/methods/projects_dlp_jobs_delete - project_data_profiles: - id: google.dlp.project_data_profiles - name: project_data_profiles - title: Project_data_profiles + #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete + - $ref: >- + #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete + discovery_configs: + id: google.dlp.discovery_configs + name: discovery_configs + title: Discovery_configs methods: - _projects_locations_project_data_profiles_list: - operation: &ref_7 + projects_locations_discovery_configs_list: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get - response: &ref_8 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.projectDataProfiles - projects_locations_project_data_profiles_list: - operation: *ref_7 - response: *ref_8 - projects_locations_project_data_profiles_get: + objectKey: $.discoveryConfigs + projects_locations_discovery_configs_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_project_data_profiles_get: + projects_locations_discovery_configs_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_project_data_profiles_list: - operation: &ref_9 + projects_locations_discovery_configs_patch: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles/get - response: &ref_10 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.projectDataProfiles - organizations_locations_project_data_profiles_list: - operation: *ref_9 - response: *ref_10 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_list - - $ref: >- - #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_list - insert: [] - update: [] - delete: [] - table_data_profiles: - id: google.dlp.table_data_profiles - name: table_data_profiles - title: Table_data_profiles - methods: - projects_locations_table_data_profiles_delete: + projects_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_table_data_profiles_get: + organizations_locations_discovery_configs_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_table_data_profiles_list: - operation: &ref_11 + organizations_locations_discovery_configs_list: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get - response: &ref_12 + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles - projects_locations_table_data_profiles_list: - operation: *ref_11 - response: *ref_12 - organizations_locations_table_data_profiles_get: + objectKey: $.discoveryConfigs + organizations_locations_discovery_configs_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_table_data_profiles_delete: + organizations_locations_discovery_configs_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_table_data_profiles_list: - operation: &ref_13 + organizations_locations_discovery_configs_get: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get - response: &ref_14 + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tableDataProfiles - organizations_locations_table_data_profiles_list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list - insert: [] - update: [] + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch + - $ref: >- + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete + #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete - $ref: >- - #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete + #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete deidentify_templates: id: google.dlp.deidentify_templates name: deidentify_templates title: Deidentify_templates methods: - projects_locations_deidentify_templates_create: + projects_locations_deidentify_templates_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_deidentify_templates_patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_deidentify_templates_list: - operation: &ref_15 + projects_locations_deidentify_templates_create: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get - response: &ref_16 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deidentifyTemplates projects_locations_deidentify_templates_list: - operation: *ref_15 - response: *ref_16 - projects_locations_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_patch: + objectKey: $.deidentifyTemplates + projects_deidentify_templates_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_deidentify_templates_delete: + projects_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_create: + projects_deidentify_templates_delete: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_deidentify_templates_list: - operation: &ref_17 + projects_deidentify_templates_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deidentifyTemplates - projects_deidentify_templates_list: - operation: *ref_17 - response: *ref_18 - projects_deidentify_templates_delete: + projects_deidentify_templates_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_get: + organizations_locations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' - projects_deidentify_templates_patch: + objectKey: $.deidentifyTemplates + organizations_locations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' @@ -7536,42 +8441,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_deidentify_templates_create: + organizations_deidentify_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_deidentify_templates_list: - operation: &ref_19 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1deidentifyTemplates/get - response: &ref_20 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - organizations_locations_deidentify_templates_list: - operation: *ref_19 - response: *ref_20 - organizations_deidentify_templates_create: + organizations_deidentify_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _organizations_deidentify_templates_list: - operation: &ref_21 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deidentifyTemplates - organizations_deidentify_templates_list: - operation: *ref_21 - response: *ref_22 organizations_deidentify_templates_get: operation: $ref: >- @@ -7579,20 +8462,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_delete: + organizations_deidentify_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_deidentify_templates_patch: + organizations_deidentify_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates~1{deidentifyTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1deidentifyTemplates/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.deidentifyTemplates sqlVerbs: select: - $ref: >- @@ -7629,6 +8513,7 @@ components: #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_patch - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/projects_locations_deidentify_templates_delete @@ -7638,36 +8523,35 @@ components: #/components/x-stackQL-resources/deidentify_templates/methods/projects_deidentify_templates_delete - $ref: >- #/components/x-stackQL-resources/deidentify_templates/methods/organizations_deidentify_templates_delete - inspect_templates: - id: google.dlp.inspect_templates - name: inspect_templates - title: Inspect_templates + image: + id: google.dlp.image + name: image + title: Image methods: - projects_locations_inspect_templates_create: + projects_locations_image_redact: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_inspect_templates_list: - operation: &ref_23 - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.inspectTemplates - projects_locations_inspect_templates_list: - operation: *ref_23 - response: *ref_24 - projects_locations_inspect_templates_delete: + projects_image_redact: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + inspect_templates: + id: google.dlp.inspect_templates + name: inspect_templates + title: Inspect_templates + methods: projects_locations_inspect_templates_patch: operation: $ref: >- @@ -7682,65 +8566,59 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_delete: + projects_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_patch: + projects_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - projects_inspect_templates_get: + projects_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.inspectTemplates projects_inspect_templates_create: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_inspect_templates_list: - operation: &ref_25 + projects_inspect_templates_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1inspectTemplates/get' - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.inspectTemplates - projects_inspect_templates_list: - operation: *ref_25 - response: *ref_26 - _organizations_locations_inspect_templates_list: - operation: &ref_27 + projects_inspect_templates_get: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get - response: &ref_28 + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_locations_inspect_templates_list: - operation: *ref_27 - response: *ref_28 - organizations_locations_inspect_templates_create: + projects_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_inspect_templates_delete: + projects_inspect_templates_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1inspectTemplates~1{inspectTemplatesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -7758,27 +8636,36 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_patch: + organizations_locations_inspect_templates_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates~1{inspectTemplatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_get: + organizations_locations_inspect_templates_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/post response: mediaType: application/json openAPIDocKey: '200' - organizations_inspect_templates_delete: + organizations_locations_inspect_templates_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1inspectTemplates/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.inspectTemplates + organizations_inspect_templates_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.inspectTemplates organizations_inspect_templates_create: operation: $ref: >- @@ -7786,17 +8673,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_inspect_templates_list: - operation: &ref_29 + organizations_inspect_templates_get: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates/get - response: &ref_30 + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_inspect_templates_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_inspect_templates_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1inspectTemplates~1{inspectTemplatesId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.inspectTemplates - organizations_inspect_templates_list: - operation: *ref_29 - response: *ref_30 sqlVerbs: select: - $ref: >- @@ -7833,6 +8730,7 @@ components: #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_patch - $ref: >- #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/inspect_templates/methods/projects_locations_inspect_templates_delete @@ -7842,179 +8740,75 @@ components: #/components/x-stackQL-resources/inspect_templates/methods/projects_inspect_templates_delete - $ref: >- #/components/x-stackQL-resources/inspect_templates/methods/organizations_inspect_templates_delete - connections: - id: google.dlp.connections - name: connections - title: Connections - methods: - projects_locations_connections_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_connections_list: - operation: &ref_31 - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: &ref_32 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_list: - operation: *ref_31 - response: *ref_32 - projects_locations_connections_patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_connections_search: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1connections:search/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_connections_search: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1connections:search/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_get - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - insert: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_create - update: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_delete - image: - id: google.dlp.image - name: image - title: Image + content: + id: google.dlp.content + name: content + title: Content methods: - projects_locations_image_redact: + projects_locations_content_inspect: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1image:redact/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:inspect/post response: mediaType: application/json openAPIDocKey: '200' - projects_image_redact: + projects_locations_content_deidentify: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1image:redact/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:deidentify/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - column_data_profiles: - id: google.dlp.column_data_profiles - name: column_data_profiles - title: Column_data_profiles - methods: - _projects_locations_column_data_profiles_list: - operation: &ref_33 + projects_locations_content_reidentify: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get - response: &ref_34 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1content:reidentify/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.columnDataProfiles - projects_locations_column_data_profiles_list: - operation: *ref_33 - response: *ref_34 - projects_locations_column_data_profiles_get: + projects_content_deidentify: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:deidentify/post' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_column_data_profiles_get: + projects_content_reidentify: operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:reidentify/post' response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_column_data_profiles_list: - operation: &ref_35 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get - response: &ref_36 + projects_content_inspect: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1content:inspect/post' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.columnDataProfiles - organizations_locations_column_data_profiles_list: - operation: *ref_35 - response: *ref_36 sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_get - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_list - - $ref: >- - #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_list + select: [] insert: [] update: [] + replace: [] delete: [] stored_info_types: id: google.dlp.stored_info_types name: stored_info_types title: Stored_info_types methods: - projects_locations_stored_info_types_create: + projects_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_stored_info_types_list: - operation: &ref_37 + projects_locations_stored_info_types_delete: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get - response: &ref_38 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_locations_stored_info_types_list: - operation: *ref_37 - response: *ref_38 projects_locations_stored_info_types_get: operation: $ref: >- @@ -8022,36 +8816,35 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_patch: + projects_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_stored_info_types_delete: + objectKey: $.storedInfoTypes + projects_locations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_create: + projects_stored_info_types_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_stored_info_types_list: - operation: &ref_39 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' - response: &ref_40 + projects_stored_info_types_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - projects_stored_info_types_list: - operation: *ref_39 - response: *ref_40 projects_stored_info_types_patch: operation: $ref: >- @@ -8059,98 +8852,91 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_delete: + projects_stored_info_types_create: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/post' response: mediaType: application/json openAPIDocKey: '200' - projects_stored_info_types_get: + projects_stored_info_types_list: operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes~1{storedInfoTypesId}/get + $ref: '#/paths/~1v2~1projects~1{projectsId}~1storedInfoTypes/get' response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_create: + objectKey: $.storedInfoTypes + organizations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_stored_info_types_list: - operation: &ref_41 + organizations_stored_info_types_get: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get - response: &ref_42 + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_locations_stored_info_types_list: - operation: *ref_41 - response: *ref_42 - organizations_locations_stored_info_types_patch: + organizations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_get: + organizations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_stored_info_types_delete: + objectKey: $.storedInfoTypes + organizations_stored_info_types_create: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_patch: + organizations_locations_stored_info_types_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_delete: + organizations_locations_stored_info_types_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_stored_info_types_get: + organizations_locations_stored_info_types_patch: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes~1{storedInfoTypesId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes~1{storedInfoTypesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _organizations_stored_info_types_list: - operation: &ref_43 + organizations_locations_stored_info_types_create: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/get - response: &ref_44 + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.storedInfoTypes - organizations_stored_info_types_list: - operation: *ref_43 - response: *ref_44 - organizations_stored_info_types_create: + organizations_locations_stored_info_types_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1storedInfoTypes/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1storedInfoTypes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.storedInfoTypes sqlVerbs: select: - $ref: >- @@ -8161,10 +8947,10 @@ components: #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_list - $ref: >- #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_get - - $ref: >- - #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list - $ref: >- #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_get + - $ref: >- + #/components/x-stackQL-resources/stored_info_types/methods/organizations_locations_stored_info_types_list - $ref: >- #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_list - $ref: >- @@ -8187,6 +8973,7 @@ components: #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_patch - $ref: >- #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/stored_info_types/methods/projects_locations_stored_info_types_delete @@ -8196,311 +8983,594 @@ components: #/components/x-stackQL-resources/stored_info_types/methods/projects_stored_info_types_delete - $ref: >- #/components/x-stackQL-resources/stored_info_types/methods/organizations_stored_info_types_delete - discovery_configs: - id: google.dlp.discovery_configs - name: discovery_configs - title: Discovery_configs + project_data_profiles: + id: google.dlp.project_data_profiles + name: project_data_profiles + title: Project_data_profiles methods: - projects_locations_discovery_configs_get: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_discovery_configs_delete: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_discovery_configs_patch: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_discovery_configs_list: - operation: &ref_45 - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/get - response: &ref_46 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.discoveryConfigs - projects_locations_discovery_configs_list: - operation: *ref_45 - response: *ref_46 - projects_locations_discovery_configs_create: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryConfigs/post - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_discovery_configs_delete: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_discovery_configs_patch: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_discovery_configs_get: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs~1{discoveryConfigsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_discovery_configs_create: + projects_locations_project_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_discovery_configs_list: - operation: &ref_47 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1discoveryConfigs/get - response: &ref_48 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.discoveryConfigs - organizations_locations_discovery_configs_list: - operation: *ref_47 - response: *ref_48 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_get - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_get - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_list - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_create - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_create - update: - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_patch - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/projects_locations_discovery_configs_delete - - $ref: >- - #/components/x-stackQL-resources/discovery_configs/methods/organizations_locations_discovery_configs_delete - job_triggers: - id: google.dlp.job_triggers - name: job_triggers - title: Job_triggers - methods: - projects_locations_job_triggers_patch: + objectKey: $.projectDataProfiles + projects_locations_project_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_get: + organizations_locations_project_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles~1{projectDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_delete: + organizations_locations_project_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1projectDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_activate: + objectKey: $.projectDataProfiles + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/projects_locations_project_data_profiles_list + - $ref: >- + #/components/x-stackQL-resources/project_data_profiles/methods/organizations_locations_project_data_profiles_list + insert: [] + update: [] + replace: [] + delete: [] + file_store_data_profiles: + id: google.dlp.file_store_data_profiles + name: file_store_data_profiles + title: File_store_data_profiles + methods: + projects_locations_file_store_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:activate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_job_triggers_hybrid_inspect: + objectKey: $.fileStoreDataProfiles + projects_locations_file_store_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}:hybridInspect/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_job_triggers_list: - operation: &ref_49 + projects_locations_file_store_data_profiles_delete: + operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/get - response: &ref_50 + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_locations_job_triggers_list: - operation: *ref_49 - response: *ref_50 - projects_locations_job_triggers_create: + organizations_locations_file_store_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobTriggers/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_delete: + objectKey: $.fileStoreDataProfiles + organizations_locations_file_store_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_get: + organizations_locations_file_store_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1fileStoreDataProfiles~1{fileStoreDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_list + - $ref: >- + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_list + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/file_store_data_profiles/methods/projects_locations_file_store_data_profiles_delete + - $ref: >- + #/components/x-stackQL-resources/file_store_data_profiles/methods/organizations_locations_file_store_data_profiles_delete + column_data_profiles: + id: google.dlp.column_data_profiles + name: column_data_profiles + title: Column_data_profiles + methods: + projects_locations_column_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_activate: + projects_locations_column_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1jobTriggers~1{jobTriggersId}:activate/post + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1columnDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - projects_job_triggers_create: + objectKey: $.columnDataProfiles + organizations_locations_column_data_profiles_get: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/post' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles~1{columnDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_job_triggers_list: - operation: &ref_51 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1jobTriggers/get' - response: &ref_52 + organizations_locations_column_data_profiles_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1columnDataProfiles/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - projects_job_triggers_list: - operation: *ref_51 - response: *ref_52 - organizations_locations_job_triggers_patch: + objectKey: $.columnDataProfiles + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_get + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/projects_locations_column_data_profiles_list + - $ref: >- + #/components/x-stackQL-resources/column_data_profiles/methods/organizations_locations_column_data_profiles_list + insert: [] + update: [] + replace: [] + delete: [] + table_data_profiles: + id: google.dlp.table_data_profiles + name: table_data_profiles + title: Table_data_profiles + methods: + projects_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/patch + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_get: + projects_locations_table_data_profiles_delete: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/get + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_delete: + projects_locations_table_data_profiles_list: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers~1{jobTriggersId}/delete + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1tableDataProfiles/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_job_triggers_create: + objectKey: $.tableDataProfiles + organizations_locations_table_data_profiles_get: operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/post + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_job_triggers_list: - operation: &ref_53 + organizations_locations_table_data_profiles_delete: + operation: $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1jobTriggers/get - response: &ref_54 + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles~1{tableDataProfilesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.jobTriggers - organizations_locations_job_triggers_list: - operation: *ref_53 - response: *ref_54 + organizations_locations_table_data_profiles_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1tableDataProfiles/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.tableDataProfiles sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_get - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_get - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_list - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_get - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_list - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_list - insert: - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_create - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_create - update: + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_patch + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_get - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_patch + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_list - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_patch + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_list + insert: [] + update: [] + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_locations_job_triggers_delete - - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/organizations_locations_job_triggers_delete + #/components/x-stackQL-resources/table_data_profiles/methods/projects_locations_table_data_profiles_delete - $ref: >- - #/components/x-stackQL-resources/job_triggers/methods/projects_job_triggers_delete + #/components/x-stackQL-resources/table_data_profiles/methods/organizations_locations_table_data_profiles_delete paths: - /v2/locations/{locationsId}/infoTypes: - parameters: &ref_55 - - $ref: '#/components/parameters/quotaUser' + /v2/infoTypes: + parameters: &ref_1 + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + get: + description: >- + Returns a list of the sensitive information types that DLP API supports. + See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + to learn more. + operationId: dlp.infoTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + parameters: + - in: query + name: filter + schema: + type: string + - in: query + name: parent + schema: + type: string + - in: query + name: languageCode + schema: + type: string + - in: query + name: locationId + schema: + type: string + /v2/locations/{locationsId}/infoTypes: + parameters: *ref_1 + get: + description: >- + Returns a list of the sensitive information types that DLP API supports. + See + https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + to learn more. + operationId: dlp.locations.infoTypes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: languageCode + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: + parameters: *ref_1 + delete: + description: Delete a Connection. + operationId: dlp.projects.locations.connections.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + patch: + description: Update a Connection. + operationId: dlp.projects.locations.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + get: + description: Get a Connection by name. + operationId: dlp.projects.locations.connections.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections:search: + parameters: *ref_1 + get: + description: Searches for Connections in a parent. + operationId: dlp.projects.locations.connections.search + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/connections: + parameters: *ref_1 get: description: >- - Returns a list of the sensitive information types that DLP API supports. - See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.projects.locations.connections.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Create a Connection to an external data source. + operationId: dlp.projects.locations.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: + parameters: *ref_1 + post: + description: >- + Inspect hybrid content and store findings to a job. To review the + findings, inspect the job. Inspection will occur asynchronously. + operationId: dlp.projects.locations.dlpJobs.hybridInspect + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: dlpJobsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: + parameters: *ref_1 + get: + description: >- + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.locations.infoTypes.list + operationId: dlp.projects.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8512,13 +9582,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path name: locationsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: filter schema: @@ -8528,28 +9608,33 @@ paths: schema: type: string - in: query - name: languageCode + name: type + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken schema: type: string - /v2/projects/{projectsId}/content:inspect: - parameters: *ref_55 post: description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + Creates a new job to inspect storage or calculate risk metrics. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.content.inspect + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. When no InfoTypes or CustomInfoTypes are specified in + inspect jobs, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.dlpJobs.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8561,26 +9646,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:reidentify: - parameters: *ref_55 - post: + - in: path + name: locationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: + parameters: *ref_1 + delete: description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.content.reidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + operationId: dlp.projects.locations.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8592,52 +9681,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/content:deidentify: - parameters: *ref_55 - post: - description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.content.deidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse - parameters: - in: path - name: projectsId + name: locationsId + required: true + schema: + type: string + - in: path + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: - parameters: *ref_55 get: description: >- Gets the latest state of a long-running DlpJob. See @@ -8645,7 +9705,7 @@ paths: and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.dlpJobs.get + operationId: dlp.projects.locations.dlpJobs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8664,21 +9724,33 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: dlpJobsId required: true schema: type: string - delete: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: + parameters: *ref_1 + post: description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See + Starts asynchronous cancellation on a long-running DlpJob. The server + makes a best effort to cancel the DlpJob, but success is not guaranteed. + See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.dlpJobs.delete + operationId: dlp.projects.locations.dlpJobs.cancel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8697,21 +9769,28 @@ paths: required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: path name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs: - parameters: *ref_55 - get: + /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: + parameters: *ref_1 + post: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.dlpJobs.list + Finish a running hybrid DlpJob. Triggers the finalization steps and + running of any enabled actions that have not yet run. + operationId: dlp.projects.locations.dlpJobs.finish + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8723,54 +9802,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: type + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: dlpJobsId + required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: + parameters: *ref_1 post: description: >- - Creates a new job to inspect storage or calculate risk metrics. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. When no InfoTypes or CustomInfoTypes are specified in - inspect jobs, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.dlpJobs.create + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.locations.jobTriggers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8782,30 +9844,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_55 - post: + - in: path + name: locationsId + required: true + schema: + type: string + get: description: >- - Starts asynchronous cancellation on a long-running DlpJob. The server - makes a best effort to cancel the DlpJob, but success is not guaranteed. - See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.dlpJobs.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' + operationId: dlp.projects.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8817,7 +9873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId @@ -8825,29 +9881,43 @@ paths: schema: type: string - in: path - name: dlpJobsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: - parameters: *ref_55 - post: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_1 + delete: description: >- - Finds potentially sensitive info in content. This method has limits on - input size, processing time, and output size. When no InfoTypes or - CustomInfoTypes are specified in this request, the system will - automatically choose what detectors to run. By default this may be all - types, but may change over time as detectors are updated. For how to - guides, see - https://cloud.google.com/sensitive-data-protection/docs/inspecting-images - and - https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, - operationId: dlp.projects.locations.content.inspect - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8859,7 +9929,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -8871,23 +9941,17 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: - parameters: *ref_55 - post: + - in: path + name: jobTriggersId + required: true + schema: + type: string + get: description: >- - De-identifies potentially sensitive info from a ContentItem. This method - has limits on input size and output size. See - https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.content.deidentify - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.locations.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8899,8 +9963,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -8912,19 +9975,22 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: - parameters: *ref_55 - post: + - in: path + name: jobTriggersId + required: true + schema: + type: string + patch: description: >- - Re-identifies content that has been de-identified. See - https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.content.reidentify + operationId: dlp.projects.locations.jobTriggers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8936,8 +10002,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -8949,11 +10014,25 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: - parameters: *ref_55 - get: - description: Lists project data profiles for an organization. - operationId: dlp.projects.locations.projectDataProfiles.list + - in: path + name: jobTriggersId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: + parameters: *ref_1 + post: + description: >- + Inspect hybrid content and store findings to a trigger. The inspection + will be processed asynchronously. To review the findings monitor the + jobs within the trigger. + operationId: dlp.projects.locations.jobTriggers.hybridInspect + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2HybridInspectJobTriggerRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8965,8 +10044,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' parameters: - in: path name: projectsId @@ -8978,28 +10056,23 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter + - in: path + name: jobTriggersId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: - parameters: *ref_55 - get: - description: Gets a project data profile. - operationId: dlp.projects.locations.projectDataProfiles.get + /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: + parameters: *ref_1 + post: + description: >- + Activate a job trigger. Causes the immediate execute of a trigger + instead of waiting on the trigger event to occur. + operationId: dlp.projects.locations.jobTriggers.activate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9011,7 +10084,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -9024,17 +10097,15 @@ paths: schema: type: string - in: path - name: projectDataProfilesId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: - parameters: *ref_55 - delete: - description: >- - Delete a TableDataProfile. Will not prevent the profile from being - regenerated if the table is still included in a discovery configuration. - operationId: dlp.projects.locations.tableDataProfiles.delete + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: + parameters: *ref_1 + get: + description: Lists discovery configurations. + operationId: dlp.projects.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9046,7 +10117,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path name: projectsId @@ -9058,14 +10130,28 @@ paths: required: true schema: type: string - - in: path - name: tableDataProfilesId - required: true + - in: query + name: pageToken schema: type: string - get: - description: Gets a table data profile. - operationId: dlp.projects.locations.tableDataProfiles.get + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.projects.locations.discoveryConfigs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9077,7 +10163,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -9089,16 +10175,11 @@ paths: required: true schema: type: string - - in: path - name: tableDataProfilesId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: - parameters: *ref_55 + /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + parameters: *ref_1 get: - description: Lists table data profiles for an organization. - operationId: dlp.projects.locations.tableDataProfiles.list + description: Gets a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9110,8 +10191,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -9123,38 +10203,20 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: discoveryConfigsId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: - parameters: *ref_55 - post: - description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.create + patch: + description: Updates a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9166,7 +10228,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: projectsId @@ -9178,12 +10240,14 @@ paths: required: true schema: type: string - get: - description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.projects.locations.deidentifyTemplates.list + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + delete: + description: Deletes a discovery configuration. + operationId: dlp.projects.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9195,8 +10259,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9208,25 +10271,13 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize + - in: path + name: discoveryConfigsId + required: true schema: - type: integer - format: int32 + type: string /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: - parameters: *ref_55 + parameters: *ref_1 get: description: >- Gets a DeidentifyTemplate. See @@ -9335,21 +10386,21 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: - parameters: *ref_55 + /v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates: + parameters: *ref_1 post: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.inspectTemplates.create + operationId: dlp.projects.locations.deidentifyTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9361,7 +10412,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId @@ -9375,10 +10426,10 @@ paths: type: string get: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.locations.inspectTemplates.list + operationId: dlp.projects.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9391,7 +10442,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: projectsId @@ -9403,10 +10454,6 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: orderBy schema: @@ -9420,14 +10467,27 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: - parameters: *ref_55 - delete: + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/image:redact: + parameters: *ref_1 + post: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.locations.inspectTemplates.delete + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.image.redact + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9439,7 +10499,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' parameters: - in: path name: projectsId @@ -9451,11 +10511,8 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true - schema: - type: string + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + parameters: *ref_1 patch: description: >- Updates the InspectTemplate. See @@ -9530,16 +10587,12 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_55 - post: - description: Create a Connection to an external data source. - operationId: dlp.projects.locations.connections.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' + delete: + description: >- + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9551,7 +10604,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9563,55 +10616,26 @@ paths: required: true schema: type: string - get: - description: Lists Connections in a parent. - operationId: dlp.projects.locations.connections.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - in: path - name: locationsId + name: inspectTemplatesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: - parameters: *ref_55 - patch: - description: Update a Connection. - operationId: dlp.projects.locations.connections.patch + /v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates: + parameters: *ref_1 + post: + description: >- + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9623,7 +10647,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId @@ -9635,14 +10659,12 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - delete: - description: Delete a Connection. - operationId: dlp.projects.locations.connections.delete + get: + description: >- + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9654,7 +10676,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - in: path name: projectsId @@ -9666,14 +10689,42 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true + - in: query + name: locationId schema: type: string - get: - description: Get a Connection by name. - operationId: dlp.projects.locations.connections.get + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/content:inspect: + parameters: *ref_1 + post: + description: >- + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.locations.content.inspect + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9685,7 +10736,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId @@ -9697,16 +10748,23 @@ paths: required: true schema: type: string - - in: path - name: connectionsId - required: true - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/connections:search: - parameters: *ref_55 - get: - description: Searches for Connections in a parent. - operationId: dlp.projects.locations.connections.search + /v2/projects/{projectsId}/locations/{locationsId}/content:deidentify: + parameters: *ref_1 + post: + description: >- + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.locations.content.deidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9719,7 +10777,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId @@ -9731,36 +10789,19 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v2/projects/{projectsId}/locations/{locationsId}/image:redact: - parameters: *ref_55 + /v2/projects/{projectsId}/locations/{locationsId}/content:reidentify: + parameters: *ref_1 post: description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.image.redact + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + to learn more. + operationId: dlp.projects.locations.content.reidentify requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9772,7 +10813,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse parameters: - in: path name: projectsId @@ -9784,11 +10826,21 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: - parameters: *ref_55 - get: - description: Lists column data profiles for an organization. - operationId: dlp.projects.locations.columnDataProfiles.list + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_1 + patch: + description: >- + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9800,8 +10852,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -9813,28 +10864,17 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: storedInfoTypesId + required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: - parameters: *ref_55 - get: - description: Gets a column data profile. - operationId: dlp.projects.locations.columnDataProfiles.get + delete: + description: >- + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.locations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9846,7 +10886,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -9859,24 +10899,16 @@ paths: schema: type: string - in: path - name: columnDataProfilesId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: - parameters: *ref_55 - post: + get: description: >- - Creates a pre-built stored infoType to be used for inspection. See + Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.storedInfoTypes.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + operationId: dlp.projects.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9900,6 +10932,13 @@ paths: required: true schema: type: string + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes: + parameters: *ref_1 get: description: >- Lists stored infoTypes. See @@ -9930,10 +10969,6 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - in: query name: locationId schema: @@ -9947,14 +10982,22 @@ paths: schema: type: integer format: int32 - /v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_55 - get: + - in: query + name: orderBy + schema: + type: string + post: description: >- - Gets a stored infoType. See + Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.locations.storedInfoTypes.get + operationId: dlp.projects.locations.storedInfoTypes.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9978,24 +11021,11 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true - schema: - type: string - patch: - description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_1 + get: + description: Lists project data profiles for an organization. + operationId: dlp.projects.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10007,7 +11037,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: projectsId @@ -10019,17 +11050,28 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - delete: - description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.projects.locations.storedInfoTypes.delete + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a project data profile. + operationId: dlp.projects.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10041,7 +11083,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path name: projectsId @@ -10054,15 +11096,15 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: projectDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: - parameters: *ref_55 + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles: + parameters: *ref_1 get: - description: Gets a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.get + description: Lists file store data profiles for an organization. + operationId: dlp.projects.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10074,7 +11116,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: projectsId @@ -10086,14 +11129,28 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: pageToken schema: type: string - delete: - description: Deletes a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.delete + - in: query + name: orderBy + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a file store data profile. + operationId: dlp.projects.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10105,7 +11162,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: projectsId @@ -10118,19 +11175,16 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: fileStoreDataProfilesId required: true schema: type: string - patch: - description: Updates a discovery configuration. - operationId: dlp.projects.locations.discoveryConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + delete: + description: >- + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.projects.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10142,7 +11196,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10155,15 +11209,15 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: fileStoreDataProfilesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs: - parameters: *ref_55 + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + parameters: *ref_1 get: - description: Lists discovery configurations. - operationId: dlp.projects.locations.discoveryConfigs.list + description: Gets a column data profile. + operationId: dlp.projects.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10175,8 +11229,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path name: projectsId @@ -10188,28 +11241,16 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy + - in: path + name: columnDataProfilesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.projects.locations.discoveryConfigs.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + /v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles: + parameters: *ref_1 + get: + description: Lists column data profiles for an organization. + operationId: dlp.projects.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10221,7 +11262,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: projectsId @@ -10233,19 +11275,28 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: - parameters: *ref_55 - patch: - description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a table data profile. + operationId: dlp.projects.locations.tableDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10257,7 +11308,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2TableDataProfile' parameters: - in: path name: projectsId @@ -10270,16 +11321,15 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: tableDataProfilesId required: true schema: type: string - get: + delete: description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.get + Delete a TableDataProfile. Will not prevent the profile from being + regenerated if the table is still included in a discovery configuration. + operationId: dlp.projects.locations.tableDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10291,7 +11341,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10304,16 +11354,15 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: tableDataProfilesId required: true schema: type: string - delete: - description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.projects.locations.jobTriggers.delete + /v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles: + parameters: *ref_1 + get: + description: Lists table data profiles for an organization. + operationId: dlp.projects.locations.tableDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10325,7 +11374,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListTableDataProfilesResponse parameters: - in: path name: projectsId @@ -10337,23 +11387,40 @@ paths: required: true schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: pageToken schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate: - parameters: *ref_55 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v2/projects/{projectsId}/content:deidentify: + parameters: *ref_1 post: description: >- - Activate a job trigger. Causes the immediate execute of a trigger - instead of waiting on the trigger event to occur. - operationId: dlp.projects.locations.jobTriggers.activate + De-identifies potentially sensitive info from a ContentItem. This method + has limits on input size and output size. See + https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.content.deidentify requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10365,37 +11432,65 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2DeidentifyContentResponse parameters: - in: path name: projectsId required: true schema: type: string + /v2/projects/{projectsId}/content:reidentify: + parameters: *ref_1 + post: + description: >- + Re-identifies content that has been de-identified. See + https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example + to learn more. + operationId: dlp.projects.content.reidentify + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ReidentifyContentRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ReidentifyContentResponse + parameters: - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: jobTriggersId + name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect: - parameters: *ref_55 + /v2/projects/{projectsId}/content:inspect: + parameters: *ref_1 post: description: >- - Inspect hybrid content and store findings to a trigger. The inspection - will be processed asynchronously. To review the findings monitor the - jobs within the trigger. - operationId: dlp.projects.locations.jobTriggers.hybridInspect + Finds potentially sensitive info in content. This method has limits on + input size, processing time, and output size. When no InfoTypes or + CustomInfoTypes are specified in this request, the system will + automatically choose what detectors to run. By default this may be all + types, but may change over time as detectors are updated. For how to + guides, see + https://cloud.google.com/sensitive-data-protection/docs/inspecting-images + and + https://cloud.google.com/sensitive-data-protection/docs/inspecting-text, + operationId: dlp.projects.content.inspect requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2HybridInspectJobTriggerRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10407,31 +11502,56 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectContentResponse' parameters: - in: path name: projectsId required: true schema: type: string + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running DlpJob. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + parameters: - in: path - name: locationsId + name: projectsId required: true schema: type: string - in: path - name: jobTriggersId + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/jobTriggers: - parameters: *ref_55 - get: + delete: description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Deletes a long-running DlpJob. This method indicates that the client is + no longer interested in the DlpJob result. The job will be canceled if + possible. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.jobTriggers.list + operationId: dlp.projects.dlpJobs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10443,7 +11563,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10451,47 +11571,27 @@ paths: schema: type: string - in: path - name: locationsId + name: dlpJobsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: type - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId - schema: - type: string + /v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel: + parameters: *ref_1 post: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Starts asynchronous cancellation on a long-running DlpJob. The server + makes a best effort to cancel the DlpJob, but success is not guaranteed. + See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.projects.locations.jobTriggers.create + operationId: dlp.projects.dlpJobs.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10503,7 +11603,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10511,23 +11611,28 @@ paths: schema: type: string - in: path - name: locationsId + name: dlpJobsId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect: - parameters: *ref_55 + /v2/projects/{projectsId}/dlpJobs: + parameters: *ref_1 post: description: >- - Inspect hybrid content and store findings to a job. To review the - findings, inspect the job. Inspection will occur asynchronously. - operationId: dlp.projects.locations.dlpJobs.hybridInspect + Creates a new job to inspect storage or calculate risk metrics. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. When no InfoTypes or CustomInfoTypes are specified in + inspect jobs, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.dlpJobs.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2HybridInspectDlpJobRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10539,35 +11644,72 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2HybridInspectResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + get: + description: >- + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + to learn more. + operationId: dlp.projects.dlpJobs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: locationId + schema: + type: string + - in: query + name: filter schema: type: string - - in: path - name: dlpJobsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: type schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}: - parameters: *ref_55 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: + parameters: *ref_1 delete: description: >- - Deletes a long-running DlpJob. This method indicates that the client is - no longer interested in the DlpJob result. The job will be canceled if - possible. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.dlpJobs.delete + operationId: dlp.projects.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10587,23 +11729,16 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: jobTriggersId required: true schema: type: string get: description: >- - Gets the latest state of a long-running DlpJob. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.dlpJobs.get + operationId: dlp.projects.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10615,7 +11750,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -10623,27 +11758,21 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish: - parameters: *ref_55 - post: + patch: description: >- - Finish a running hybrid DlpJob. Triggers the finalization steps and - running of any enabled actions that have not yet run. - operationId: dlp.projects.locations.dlpJobs.finish + Updates a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2FinishDlpJobRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10655,7 +11784,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId @@ -10663,33 +11792,24 @@ paths: schema: type: string - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: dlpJobsId + name: jobTriggersId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs: - parameters: *ref_55 + /v2/projects/{projectsId}/jobTriggers: + parameters: *ref_1 post: description: >- - Creates a new job to inspect storage or calculate risk metrics. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. When no InfoTypes or CustomInfoTypes are specified in - inspect jobs, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.locations.dlpJobs.create + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.projects.jobTriggers.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateDlpJobRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10701,26 +11821,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string get: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.projects.locations.dlpJobs.list + operationId: dlp.projects.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10732,60 +11845,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: query - name: pageSize + name: orderBy schema: - type: integer - format: int32 + type: string - in: query name: pageToken schema: type: string - in: query - name: locationId + name: type schema: type: string - in: query - name: type + name: pageSize schema: - type: string + type: integer + format: int32 - in: query - name: filter + name: locationId schema: type: string - in: query - name: orderBy + name: filter schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel: - parameters: *ref_55 + /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: + parameters: *ref_1 post: description: >- - Starts asynchronous cancellation on a long-running DlpJob. The server - makes a best effort to cancel the DlpJob, but success is not guaranteed. - See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis - to learn more. - operationId: dlp.projects.locations.dlpJobs.cancel + Activate a job trigger. Causes the immediate execute of a trigger + instead of waiting on the trigger event to occur. + operationId: dlp.projects.jobTriggers.activate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CancelDlpJobRequest' + $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10797,7 +11900,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' parameters: - in: path name: projectsId @@ -10805,23 +11908,60 @@ paths: schema: type: string - in: path - name: locationsId + name: jobTriggersId required: true schema: type: string + /v2/projects/{projectsId}/image:redact: + parameters: *ref_1 + post: + description: >- + Redacts potentially sensitive info from an image. This method has limits + on input size, processing time, and output size. See + https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images + to learn more. When no InfoTypes or CustomInfoTypes are specified in + this request, the system will automatically choose what detectors to + run. By default this may be all types, but may change over time as + detectors are updated. + operationId: dlp.projects.image.redact + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + parameters: - in: path - name: dlpJobsId + name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: - parameters: *ref_55 - delete: + /v2/projects/{projectsId}/inspectTemplates: + parameters: *ref_1 + post: description: >- - Deletes an InspectTemplate. See + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.inspectTemplates.delete + operationId: dlp.projects.inspectTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10833,30 +11973,63 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: projectsId required: true schema: type: string + get: + description: >- + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.inspectTemplates.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + parameters: - in: path - name: inspectTemplatesId + name: projectsId required: true schema: type: string - patch: + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: locationId + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}: + parameters: *ref_1 + get: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.projects.inspectTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.projects.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10880,12 +12053,12 @@ paths: required: true schema: type: string - get: + delete: description: >- - Gets an InspectTemplate. See + Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.inspectTemplates.get + operationId: dlp.projects.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10897,7 +12070,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10909,21 +12082,18 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/inspectTemplates: - parameters: *ref_55 - post: + patch: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See + Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.inspectTemplates.create + operationId: dlp.projects.inspectTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10942,12 +12112,19 @@ paths: required: true schema: type: string + - in: path + name: inspectTemplatesId + required: true + schema: + type: string + /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_1 get: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.inspectTemplates.list + operationId: dlp.projects.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10959,48 +12136,30 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/image:redact: - parameters: *ref_55 - post: + patch: description: >- - Redacts potentially sensitive info from an image. This method has limits - on input size, processing time, and output size. See - https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images - to learn more. When no InfoTypes or CustomInfoTypes are specified in - this request, the system will automatically choose what detectors to - run. By default this may be all types, but may change over time as - detectors are updated. - operationId: dlp.projects.image.redact + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.projects.deidentifyTemplates.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11012,21 +12171,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2RedactImageResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}: - parameters: *ref_55 + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string delete: description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.jobTriggers.delete + operationId: dlp.projects.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11046,16 +12208,18 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: deidentifyTemplatesId required: true schema: type: string + /v2/projects/{projectsId}/deidentifyTemplates: + parameters: *ref_1 get: description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.jobTriggers.get + operationId: dlp.projects.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11067,29 +12231,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: jobTriggersId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - patch: + - in: query + name: orderBy + schema: + type: string + - in: query + name: locationId + schema: + type: string + post: description: >- - Updates a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.projects.jobTriggers.patch + operationId: dlp.projects.deidentifyTemplates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateJobTriggerRequest' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11101,30 +12280,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: jobTriggersId - required: true - schema: - type: string - /v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate: - parameters: *ref_55 - post: + /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_1 + get: description: >- - Activate a job trigger. Causes the immediate execute of a trigger - instead of waiting on the trigger event to occur. - operationId: dlp.projects.jobTriggers.activate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ActivateJobTriggerRequest' + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.projects.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11136,7 +12306,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DlpJob' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId @@ -11144,24 +12314,16 @@ paths: schema: type: string - in: path - name: jobTriggersId + name: storedInfoTypesId required: true schema: type: string - /v2/projects/{projectsId}/jobTriggers: - parameters: *ref_55 - post: + delete: description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.jobTriggers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' + operationId: dlp.projects.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11173,19 +12335,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId required: true schema: type: string - get: + - in: path + name: storedInfoTypesId + required: true + schema: + type: string + patch: description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.jobTriggers.list + operationId: dlp.projects.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11197,40 +12371,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: type - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId + - in: path + name: storedInfoTypesId + required: true schema: type: string /v2/projects/{projectsId}/storedInfoTypes: - parameters: *ref_55 + parameters: *ref_1 post: description: >- Creates a pre-built stored infoType to be used for inspection. See @@ -11286,11 +12440,6 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - in: query name: locationId schema: @@ -11299,25 +12448,59 @@ paths: name: pageToken schema: type: string - - in: query - name: orderBy + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_1 + patch: + description: >- + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + to learn more. + operationId: dlp.organizations.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: storedInfoTypesId + required: true schema: type: string - /v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_55 - patch: + get: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See + Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + operationId: dlp.organizations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11332,7 +12515,7 @@ paths: $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11346,7 +12529,7 @@ paths: Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.storedInfoTypes.delete + operationId: dlp.organizations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11361,7 +12544,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -11370,12 +12553,14 @@ paths: required: true schema: type: string + /v2/organizations/{organizationsId}/storedInfoTypes: + parameters: *ref_1 get: description: >- - Gets a stored infoType. See + Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.storedInfoTypes.get + operationId: dlp.organizations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11387,33 +12572,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: orderBy schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates: - parameters: *ref_55 + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.projects.deidentifyTemplates.create + operationId: dlp.organizations.storedInfoTypes.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11425,19 +12620,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - get: + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: + parameters: *ref_1 + patch: description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.list + operationId: dlp.organizations.locations.inspectTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11449,39 +12652,29 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: locationId + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: inspectTemplatesId + required: true schema: type: string - /v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}: - parameters: *ref_55 - delete: + get: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.delete + operationId: dlp.organizations.locations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11493,24 +12686,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - get: + - in: path + name: inspectTemplatesId + required: true + schema: + type: string + delete: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.get + operationId: dlp.organizations.locations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11522,30 +12720,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - patch: + - in: path + name: inspectTemplatesId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: + parameters: *ref_1 + post: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.projects.deidentifyTemplates.patch + operationId: dlp.organizations.locations.inspectTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11557,27 +12763,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: deidentifyTemplatesId + name: locationsId required: true schema: type: string - /v2/infoTypes: - parameters: *ref_55 get: description: >- - Returns a list of the sensitive information types that DLP API supports. - See - https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.infoTypes.list + operationId: dlp.organizations.locations.inspectTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11589,32 +12792,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListInfoTypesResponse' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse parameters: - - in: query - name: filter + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true schema: type: string - in: query - name: languageCode + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - in: query - name: locationId + name: pageToken schema: type: string - in: query - name: parent + name: locationId schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates: - parameters: *ref_55 + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: + parameters: *ref_1 get: description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Gets a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.list + operationId: dlp.organizations.locations.storedInfoTypes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11626,8 +12841,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -11639,36 +12853,17 @@ paths: required: true schema: type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: storedInfoTypesId + required: true schema: type: string - post: + delete: description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a stored infoType. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + operationId: dlp.organizations.locations.storedInfoTypes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11680,26 +12875,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string - in: path - name: locationsId + name: storedInfoTypesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}: - parameters: *ref_55 - delete: + patch: description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Updates the stored infoType by creating a new version. The existing + version will continue to be used until the new version is ready. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.delete + operationId: dlp.organizations.locations.storedInfoTypes.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11711,7 +12916,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -11724,22 +12929,24 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: storedInfoTypesId required: true schema: type: string - patch: + /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: + parameters: *ref_1 + post: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Creates a pre-built stored infoType to be used for inspection. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.patch + operationId: dlp.organizations.locations.storedInfoTypes.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11751,7 +12958,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' parameters: - in: path name: organizationsId @@ -11763,17 +12970,12 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true - schema: - type: string get: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Lists stored infoTypes. See + https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more. - operationId: dlp.organizations.locations.inspectTemplates.get + operationId: dlp.organizations.locations.storedInfoTypes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11785,7 +12987,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse parameters: - in: path name: organizationsId @@ -11797,13 +13000,25 @@ paths: required: true schema: type: string - - in: path - name: inspectTemplatesId - required: true + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}: - parameters: *ref_55 + parameters: *ref_1 get: description: Gets a table data profile. operationId: dlp.organizations.locations.tableDataProfiles.get @@ -11869,7 +13084,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles: - parameters: *ref_55 + parameters: *ref_1 get: description: Lists table data profiles for an organization. operationId: dlp.organizations.locations.tableDataProfiles.list @@ -11897,28 +13112,28 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - in: query name: orderBy schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: - parameters: *ref_55 + - in: query + name: filter + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: + parameters: *ref_1 get: - description: Gets a column data profile. - operationId: dlp.organizations.locations.columnDataProfiles.get + description: Gets a project data profile. + operationId: dlp.organizations.locations.projectDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11930,7 +13145,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' + $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' parameters: - in: path name: organizationsId @@ -11943,15 +13158,15 @@ paths: schema: type: string - in: path - name: columnDataProfilesId + name: projectDataProfilesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: - parameters: *ref_55 + /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: + parameters: *ref_1 get: - description: Lists column data profiles for an organization. - operationId: dlp.organizations.locations.columnDataProfiles.list + description: Lists project data profiles for an organization. + operationId: dlp.organizations.locations.projectDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11964,7 +13179,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse + #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse parameters: - in: path name: organizationsId @@ -11977,15 +13192,15 @@ paths: schema: type: string - in: query - name: filter + name: orderBy schema: type: string - in: query - name: pageToken + name: filter schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query @@ -11994,7 +13209,7 @@ paths: type: integer format: int32 /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}: - parameters: *ref_55 + parameters: *ref_1 patch: description: >- Updates a job trigger. See @@ -12034,175 +13249,12 @@ paths: required: true schema: type: string - get: - description: >- - Gets a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: jobTriggersId - required: true - schema: - type: string - delete: - description: >- - Deletes a job trigger. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: jobTriggersId - required: true - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: - parameters: *ref_55 - post: - description: >- - Creates a job trigger to run DLP actions such as scanning storage for - sensitive information on a set schedule. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - get: - description: >- - Lists job triggers. See - https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers - to learn more. - operationId: dlp.organizations.locations.jobTriggers.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: - parameters: *ref_55 - get: + delete: description: >- - Lists DlpJobs that match the specified filter in the request. See - https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage - and - https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis + Deletes a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.dlpJobs.list + operationId: dlp.organizations.locations.jobTriggers.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12214,7 +13266,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -12226,36 +13278,17 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: jobTriggersId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: - parameters: *ref_55 get: - description: Searches for Connections in a parent. - operationId: dlp.organizations.locations.connections.search + description: >- + Gets a job trigger. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers + to learn more. + operationId: dlp.organizations.locations.jobTriggers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12267,8 +13300,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -12280,33 +13312,25 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: jobTriggersId + required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes: - parameters: *ref_55 + /v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers: + parameters: *ref_1 post: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Creates a job trigger to run DLP actions such as scanning storage for + sensitive information on a set schedule. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.create + operationId: dlp.organizations.locations.jobTriggers.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateJobTriggerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12318,7 +13342,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2JobTrigger' parameters: - in: path name: organizationsId @@ -12332,10 +13356,10 @@ paths: type: string get: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists job triggers. See + https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.list + operationId: dlp.organizations.locations.jobTriggers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12347,8 +13371,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListJobTriggersResponse' parameters: - in: path name: organizationsId @@ -12365,7 +13388,16 @@ paths: schema: type: string - in: query - name: pageToken + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: type schema: type: string - in: query @@ -12373,25 +13405,19 @@ paths: schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_55 - patch: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs: + parameters: *ref_1 + get: description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Lists DlpJobs that match the specified filter in the request. See + https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage + and + https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + operationId: dlp.organizations.locations.dlpJobs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12403,7 +13429,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2ListDlpJobsResponse' parameters: - in: path name: organizationsId @@ -12415,17 +13441,36 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: locationId + schema: + type: string + - in: query + name: type + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles: + parameters: *ref_1 get: - description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.get + description: Lists file store data profiles for an organization. + operationId: dlp.organizations.locations.fileStoreDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12437,7 +13482,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListFileStoreDataProfilesResponse parameters: - in: path name: organizationsId @@ -12449,17 +13495,28 @@ paths: required: true schema: type: string - - in: path - name: storedInfoTypesId - required: true + - in: query + name: filter schema: type: string - delete: - description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.locations.storedInfoTypes.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: orderBy + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a file store data profile. + operationId: dlp.organizations.locations.fileStoreDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12471,7 +13528,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2FileStoreDataProfile' parameters: - in: path name: organizationsId @@ -12484,15 +13541,16 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: fileStoreDataProfilesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}: - parameters: *ref_55 - get: - description: Gets a project data profile. - operationId: dlp.organizations.locations.projectDataProfiles.get + delete: + description: >- + Delete a FileStoreDataProfile. Will not prevent the profile from being + regenerated if the resource is still included in a discovery + configuration. + operationId: dlp.organizations.locations.fileStoreDataProfiles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12504,7 +13562,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2ProjectDataProfile' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -12517,15 +13575,17 @@ paths: schema: type: string - in: path - name: projectDataProfilesId + name: fileStoreDataProfilesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles: - parameters: *ref_55 + /v2/organizations/{organizationsId}/locations/{locationsId}/connections: + parameters: *ref_1 get: - description: Lists project data profiles for an organization. - operationId: dlp.organizations.locations.projectDataProfiles.list + description: >- + Lists Connections in a parent. Use SearchConnections to see all + connections within an organization. + operationId: dlp.organizations.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12537,8 +13597,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListProjectDataProfilesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2ListConnectionsResponse' parameters: - in: path name: organizationsId @@ -12551,7 +13610,7 @@ paths: schema: type: string - in: query - name: orderBy + name: pageToken schema: type: string - in: query @@ -12563,18 +13622,14 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: - parameters: *ref_55 - get: - description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.get + post: + description: Create a Connection to an external data source. + operationId: dlp.organizations.locations.connections.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2CreateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12586,7 +13641,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -12598,17 +13653,11 @@ paths: required: true schema: type: string - - in: path - name: deidentifyTemplatesId - required: true - schema: - type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}: + parameters: *ref_1 delete: - description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.delete + description: Delete a Connection. + operationId: dlp.organizations.locations.connections.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12633,22 +13682,13 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: connectionsId required: true schema: type: string - patch: - description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + get: + description: Get a Connection by name. + operationId: dlp.organizations.locations.connections.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12660,7 +13700,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -12673,25 +13713,18 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: connectionsId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: - parameters: *ref_55 - post: - description: >- - Creates a DeidentifyTemplate for reusing frequently used configuration - for de-identifying content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.create + patch: + description: Update a Connection. + operationId: dlp.organizations.locations.connections.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest + $ref: '#/components/schemas/GooglePrivacyDlpV2UpdateConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12703,7 +13736,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2Connection' parameters: - in: path name: organizationsId @@ -12715,12 +13748,16 @@ paths: required: true schema: type: string + - in: path + name: connectionsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/connections:search: + parameters: *ref_1 get: - description: >- - Lists DeidentifyTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid - to learn more. - operationId: dlp.organizations.locations.deidentifyTemplates.list + description: Searches for Connections in a parent. + operationId: dlp.organizations.locations.connections.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12733,7 +13770,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse + #/components/schemas/GooglePrivacyDlpV2SearchConnectionsResponse parameters: - in: path name: organizationsId @@ -12746,27 +13783,23 @@ paths: schema: type: string - in: query - name: orderBy + name: filter schema: type: string - in: query - name: locationId + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: - parameters: *ref_55 - delete: - description: Deletes a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.delete + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}: + parameters: *ref_1 + get: + description: Gets a column data profile. + operationId: dlp.organizations.locations.columnDataProfiles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12778,7 +13811,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2ColumnDataProfile' parameters: - in: path name: organizationsId @@ -12791,19 +13824,15 @@ paths: schema: type: string - in: path - name: discoveryConfigsId + name: columnDataProfilesId required: true schema: type: string - patch: - description: Updates a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest + /v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles: + parameters: *ref_1 + get: + description: Lists column data profiles for an organization. + operationId: dlp.organizations.locations.columnDataProfiles.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12815,7 +13844,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListColumnDataProfilesResponse parameters: - in: path name: organizationsId @@ -12827,14 +13857,31 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates: + parameters: *ref_1 get: - description: Gets a discovery configuration. - operationId: dlp.organizations.locations.discoveryConfigs.get + description: >- + Lists DeidentifyTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12846,7 +13893,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDeidentifyTemplatesResponse parameters: - in: path name: organizationsId @@ -12858,22 +13906,36 @@ paths: required: true schema: type: string - - in: path - name: discoveryConfigsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: locationId + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: - parameters: *ref_55 post: - description: Creates a config for discovery to scan and profile storage. - operationId: dlp.organizations.locations.discoveryConfigs.create + description: >- + Creates a DeidentifyTemplate for reusing frequently used configuration + for de-identifying content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest + #/components/schemas/GooglePrivacyDlpV2CreateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12885,7 +13947,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -12897,9 +13959,14 @@ paths: required: true schema: type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_1 get: - description: Lists discovery configurations. - operationId: dlp.organizations.locations.discoveryConfigs.list + description: >- + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + to learn more. + operationId: dlp.organizations.locations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12911,8 +13978,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -12924,33 +13990,17 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: - parameters: *ref_55 - patch: + delete: description: >- - Updates the InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest + operationId: dlp.organizations.locations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12962,7 +14012,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -12970,16 +14020,27 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - get: + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string + patch: description: >- - Gets an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.inspectTemplates.get + operationId: dlp.organizations.locations.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12991,7 +14052,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId @@ -12999,16 +14060,26 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - delete: - description: >- - Deletes an InspectTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.inspectTemplates.delete + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs: + parameters: *ref_1 + post: + description: Creates a config for discovery to scan and profile storage. + operationId: dlp.organizations.locations.discoveryConfigs.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13020,7 +14091,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13028,25 +14099,13 @@ paths: schema: type: string - in: path - name: inspectTemplatesId + name: locationsId required: true schema: type: string - /v2/organizations/{organizationsId}/inspectTemplates: - parameters: *ref_55 - post: - description: >- - Creates an InspectTemplate for reusing frequently used configuration for - inspecting content, images, and storage. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.inspectTemplates.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + get: + description: Lists discovery configurations. + operationId: dlp.organizations.locations.discoveryConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13058,19 +14117,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListDiscoveryConfigsResponse parameters: - in: path name: organizationsId required: true schema: type: string - get: - description: >- - Lists InspectTemplates. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates - to learn more. - operationId: dlp.organizations.inspectTemplates.list + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}: + parameters: *ref_1 + delete: + description: Deletes a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13082,46 +14159,32 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: discoveryConfigsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}: - parameters: *ref_55 patch: - description: >- - Updates the stored infoType by creating a new version. The existing - version will continue to be used until the new version is ready. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.patch + description: Updates a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateStoredInfoTypeRequest + #/components/schemas/GooglePrivacyDlpV2UpdateDiscoveryConfigRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13133,7 +14196,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13141,16 +14204,18 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: locationsId required: true schema: type: string - delete: - description: >- - Deletes a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes - to learn more. - operationId: dlp.organizations.storedInfoTypes.delete + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + get: + description: Gets a discovery configuration. + operationId: dlp.organizations.locations.discoveryConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13162,7 +14227,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GooglePrivacyDlpV2DiscoveryConfig' parameters: - in: path name: organizationsId @@ -13170,16 +14235,23 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: locationsId required: true schema: type: string - get: + - in: path + name: discoveryConfigsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: + parameters: *ref_1 + delete: description: >- - Gets a stored infoType. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Deletes a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.storedInfoTypes.get + operationId: dlp.organizations.deidentifyTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13191,7 +14263,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: organizationsId @@ -13199,18 +14271,22 @@ paths: schema: type: string - in: path - name: storedInfoTypesId + name: deidentifyTemplatesId required: true schema: type: string - /v2/organizations/{organizationsId}/storedInfoTypes: - parameters: *ref_55 - get: + patch: description: >- - Lists stored infoTypes. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Updates the DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.storedInfoTypes.list + operationId: dlp.organizations.deidentifyTemplates.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13222,43 +14298,24 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2ListStoredInfoTypesResponse + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: locationId - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken + - in: path + name: deidentifyTemplatesId + required: true schema: type: string - post: + get: description: >- - Creates a pre-built stored infoType to be used for inspection. See - https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes + Gets a DeidentifyTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more. - operationId: dlp.organizations.storedInfoTypes.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GooglePrivacyDlpV2CreateStoredInfoTypeRequest + operationId: dlp.organizations.deidentifyTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13270,15 +14327,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2StoredInfoType' + $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: deidentifyTemplatesId + required: true + schema: + type: string /v2/organizations/{organizationsId}/deidentifyTemplates: - parameters: *ref_55 + parameters: *ref_1 post: description: >- Creates a DeidentifyTemplate for reusing frequently used configuration @@ -13335,13 +14397,48 @@ paths: required: true schema: type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: locationId + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: orderBy + /v2/organizations/{organizationsId}/inspectTemplates: + parameters: *ref_1 + get: + description: >- + Lists InspectTemplates. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.inspectTemplates.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2ListInspectTemplatesResponse + parameters: + - in: path + name: organizationsId + required: true schema: type: string - in: query @@ -13352,14 +14449,54 @@ paths: name: locationId schema: type: string - /v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}: - parameters: *ref_55 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + post: + description: >- + Creates an InspectTemplate for reusing frequently used configuration for + inspecting content, images, and storage. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates + to learn more. + operationId: dlp.organizations.inspectTemplates.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GooglePrivacyDlpV2CreateInspectTemplateRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}: + parameters: *ref_1 get: description: >- - Gets a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Gets an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.get + operationId: dlp.organizations.inspectTemplates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13371,7 +14508,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -13379,16 +14516,16 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string delete: description: >- - Deletes a DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Deletes an InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.delete + operationId: dlp.organizations.inspectTemplates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13408,22 +14545,22 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string patch: description: >- - Updates the DeidentifyTemplate. See - https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid + Updates the InspectTemplate. See + https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. - operationId: dlp.organizations.deidentifyTemplates.patch + operationId: dlp.organizations.inspectTemplates.patch requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest + #/components/schemas/GooglePrivacyDlpV2UpdateInspectTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13435,7 +14572,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GooglePrivacyDlpV2DeidentifyTemplate' + $ref: '#/components/schemas/GooglePrivacyDlpV2InspectTemplate' parameters: - in: path name: organizationsId @@ -13443,7 +14580,7 @@ paths: schema: type: string - in: path - name: deidentifyTemplatesId + name: inspectTemplatesId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/dns.yaml b/providers/src/googleapis.com/v00.00.00000/services/dns.yaml index 36e4e191..e75567bc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/dns.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/dns.yaml @@ -7,8 +7,8 @@ info: title: Cloud DNS API description: '' version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dns/docs servers: @@ -43,8 +43,6 @@ components: id: ResourceRecordSetsListResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' rrsets: description: The resource record set resources. type: array @@ -52,13 +50,13 @@ components: $ref: '#/components/schemas/ResourceRecordSet' nextPageToken: description: >- - The presence of this field indicates that there exist more results - following your last page of results in pagination order. To fetch - them, make another list request using this value as your pagination - token. This lets you retrieve the complete contents of even larger - collections, one page at a time. However, if the collection changes - between paginated list requests, the set of elements returned is an - inconsistent view of the collection. You cannot retrieve a + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a consistent snapshot of a collection larger than the maximum page size. type: string @@ -66,17 +64,6 @@ components: description: Type of resource. default: dns#resourceRecordSetsListResponse type: string - ResponseHeader: - id: ResponseHeader - description: Elements common to every response. - type: object - properties: - operationId: - description: >- - For mutating operation requests that completed successfully. This is - the client_operation_id if the client specified it, otherwise it is - generated by the server (output only). - type: string ResourceRecordSet: id: ResourceRecordSet description: A unit of data that is returned by the DNS servers. @@ -92,7 +79,7 @@ components: type: string ttl: description: >- - Number of seconds that this ResourceRecordSet can be cached by + Number of seconds that this `ResourceRecordSet` can be cached by resolvers. type: integer format: int32 @@ -112,8 +99,8 @@ components: description: >- Configures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. - A valid ResourceRecordSet contains only rrdata (for static - resolution) or a routing_policy (for dynamic resolution). + A valid `ResourceRecordSet` contains only `rrdata` (for static + resolution) or a `routing_policy` (for dynamic resolution). $ref: '#/components/schemas/RRSetRoutingPolicy' kind: default: dns#resourceRecordSet @@ -132,14 +119,20 @@ components: $ref: '#/components/schemas/RRSetRoutingPolicyWrrPolicy' primaryBackup: $ref: '#/components/schemas/RRSetRoutingPolicyPrimaryBackupPolicy' + healthCheck: + description: >- + The selfLink attribute of the HealthCheck resource to use for this + RRSetRoutingPolicy. + https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks + type: string kind: default: dns#rRSetRoutingPolicy type: string RRSetRoutingPolicyGeoPolicy: id: RRSetRoutingPolicyGeoPolicy description: >- - Configures a RRSetRoutingPolicy that routes based on the geo location of - the querying user. + Configures a `RRSetRoutingPolicy` that routes based on the geo location + of the querying user. type: object properties: items: @@ -179,8 +172,8 @@ components: type: string signatureRrdatas: description: >- - DNSSEC generated signatures for all the rrdata within this item. If - health checked targets are provided for DNSSEC enabled zones, + DNSSEC generated signatures for all the `rrdata` within this item. + If health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. type: array items: @@ -188,7 +181,7 @@ components: healthCheckedTargets: description: >- For A and AAAA types only. Endpoints to return in the query result - only if they are healthy. These can be specified along with rrdata + only if they are healthy. These can be specified along with `rrdata` within this item. $ref: '#/components/schemas/RRSetRoutingPolicyHealthCheckTargets' kind: @@ -199,8 +192,7 @@ components: description: >- HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included - in the response. Only one of internal_load_balancer and - external_endpoints should be set. + in the response. type: object properties: internalLoadBalancers: @@ -208,6 +200,14 @@ components: type: array items: $ref: '#/components/schemas/RRSetRoutingPolicyLoadBalancerTarget' + externalEndpoints: + description: >- + The Internet IP addresses to be health checked. The format matches + the format of ResourceRecordSet.rrdata as defined in RFC 1035 + (section 5) and RFC 1034 (section 3.6.1) + type: array + items: + type: string RRSetRoutingPolicyLoadBalancerTarget: id: RRSetRoutingPolicyLoadBalancerTarget description: The configuration for an individual load balancer to health check. @@ -225,9 +225,15 @@ components: type: string enumDescriptions: - '' - - '' - - '' - - '' + - >- + Indicates the load balancer is a Cross-Region Application Load + Balancer. + - >- + Indicates the load balancer is a Regional Network Passthrough Load + Balancer. + - >- + Indicates the load balancer is a Regional Application Load + Balancer. enum: - none - globalL7ilb @@ -244,8 +250,8 @@ components: type: string enumDescriptions: - '' - - '' - - '' + - Indicates the load balancer is accessible via TCP. + - Indicates the load balancer is accessible via UDP. enum: - undefined - tcp @@ -254,8 +260,7 @@ components: description: >- The fully qualified URL of the network that the load balancer is attached to. This should be formatted like - https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} - . + `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. type: string project: description: The project ID in which the load balancer is located. @@ -287,11 +292,11 @@ components: properties: weight: description: >- - The weight corresponding to this WrrPolicyItem object. When multiple - WrrPolicyItem objects are configured, the probability of returning - an WrrPolicyItem object's data is proportional to its weight - relative to the sum of weights configured for all items. This weight - must be non-negative. + The weight corresponding to this `WrrPolicyItem` object. When + multiple `WrrPolicyItem` objects are configured, the probability of + returning an `WrrPolicyItem` object's data is proportional to its + weight relative to the sum of weights configured for all items. This + weight must be non-negative. type: number format: double rrdatas: @@ -300,7 +305,7 @@ components: type: string signatureRrdatas: description: >- - DNSSEC generated signatures for all the rrdata within this item. + DNSSEC generated signatures for all the `rrdata` within this item. Note that if health checked targets are provided for DNSSEC enabled zones, there's a restriction of 1 IP address per item. type: array @@ -312,8 +317,8 @@ components: decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If - DNSSEC is enabled for this zone, only one of rrdata or - health_checked_targets can be set. + DNSSEC is enabled for this zone, only one of `rrdata` or + `health_checked_targets` can be set. $ref: '#/components/schemas/RRSetRoutingPolicyHealthCheckTargets' kind: default: dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem @@ -331,17 +336,17 @@ components: Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the - backup_geo_targets. + `backup_geo_targets`. $ref: '#/components/schemas/RRSetRoutingPolicyHealthCheckTargets' backupGeoTargets: description: >- Backup targets provide a regional failover policy for the otherwise - global primary targets. If serving state is set to BACKUP, this + global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. $ref: '#/components/schemas/RRSetRoutingPolicyGeoPolicy' trickleTraffic: description: >- - When serving state is PRIMARY, this field provides the option of + When serving state is `PRIMARY`, this field provides the option of sending a small percentage of the traffic to the backup targets. type: number format: double @@ -355,13 +360,13 @@ components: Change: id: Change description: >- - A Change represents a set of ResourceRecordSet additions and deletions + A Change represents a set of `ResourceRecordSet` additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past - modifications to the ResourceRecordSets in a ManagedZone. The current - state of the ManagedZone is the sum effect of applying all Change - elements in the Changes collection in sequence. + modifications to the `ResourceRecordSets` in a `ManagedZone`. The + current state of the `ManagedZone` is the sum effect of applying all + `Change` elements in the `Changes` collection in sequence. type: object properties: additions: @@ -411,8 +416,6 @@ components: collection. type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' changes: description: The requested changes. type: array @@ -420,15 +423,15 @@ components: $ref: '#/components/schemas/Change' nextPageToken: description: >- - The presence of this field indicates that there exist more results - following your last page of results in pagination order. To fetch - them, make another list request using this value as your pagination - token. This lets you retrieve the complete contents of even very - large collections one page at a time. However, if the contents of - the collection change between the first and last paginated list - request, the set of all elements returned are an inconsistent view - of the collection. You cannot retrieve a "snapshot" of collections - larger than the maximum page size. + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a + consistent snapshot of a collection larger than the maximum page + size. type: string kind: description: Type of resource. @@ -548,8 +551,6 @@ components: description: The response to a request to enumerate DnsKeys in a ManagedZone. type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' dnsKeys: description: The requested resources. type: array @@ -557,15 +558,15 @@ components: $ref: '#/components/schemas/DnsKey' nextPageToken: description: >- - The presence of this field indicates that there exist more results - following your last page of results in pagination order. To fetch - them, make another list request using this value as your pagination - token. In this way you can retrieve the complete contents of even - very large collections one page at a time. However, if the contents - of the collection change between the first and last paginated list - request, the set of all elements returned are an inconsistent view - of the collection. There is no way to retrieve a "snapshot" of - collections larger than the maximum page size. + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a + consistent snapshot of a collection larger than the maximum page + size. type: string kind: description: Type of resource. @@ -576,7 +577,7 @@ components: description: >- A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the - APIs console. Next tag: 7. + APIs console. type: object properties: number: @@ -718,6 +719,9 @@ components: description: Maximum allowed number of items per routing policy. type: integer format: int32 + internetHealthChecksPerManagedZone: + type: integer + format: int32 kind: default: dns#quota type: string @@ -891,8 +895,13 @@ components: resources. type: string enumDescriptions: - - '' - - '' + - >- + Indicates that records in this zone can be queried from the public + internet. + - >- + Indicates that records in this zone cannot be queried from the + public internet. Access to private zones depends on the zone + configuration. enum: - public - private @@ -963,8 +972,14 @@ components: responses. Can only be changed while the state is OFF. type: string enumDescriptions: - - '' - - '' + - >- + Indicates that Cloud DNS will sign records in the managed zone + according to RFC 4034 and respond with NSEC records for names that + do not exist. + - >- + Indicates that Cloud DNS will sign records in the managed zone + according to RFC 5155 and respond with NSEC3 records for names + that do not exist. enum: - nsec - nsec3 @@ -998,7 +1013,7 @@ components: description: >- The fully qualified URL of the VPC network to bind to. Format this URL like - https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` type: string kind: default: dns#managedZonePrivateVisibilityConfigNetwork @@ -1082,7 +1097,7 @@ components: description: >- The fully qualified URL of the VPC network to forward queries to. This should be formatted like - https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` type: string deactivateTime: description: >- @@ -1121,7 +1136,7 @@ components: description: >- The fully qualified URL of the namespace associated with the zone. Format must be - https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace} + `https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}` type: string deletionTime: description: >- @@ -1159,8 +1174,6 @@ components: id: ManagedZoneOperationsListResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' operations: description: The operation resources. type: array @@ -1168,15 +1181,15 @@ components: $ref: '#/components/schemas/Operation' nextPageToken: description: >- - The presence of this field indicates that there exist more results - following your last page of results in pagination order. To fetch - them, make another list request using this value as your page token. - This lets you retrieve the complete contents of even very large - collections one page at a time. However, if the contents of the - collection change between the first and last paginated list request, - the set of all elements returned are an inconsistent view of the - collection. You cannot retrieve a consistent snapshot of a - collection larger than the maximum page size. + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a + consistent snapshot of a collection larger than the maximum page + size. type: string kind: description: Type of resource. @@ -1186,8 +1199,6 @@ components: id: ManagedZonesListResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' managedZones: description: The managed zone resources. type: array @@ -1195,15 +1206,15 @@ components: $ref: '#/components/schemas/ManagedZone' nextPageToken: description: >- - The presence of this field indicates that there exist more results - following your last page of results in pagination order. To fetch - them, make another list request using this value as your page token. - This lets you the complete contents of even very large collections - one page at a time. However, if the contents of the collection - change between the first and last paginated list request, the set of - all elements returned are an inconsistent view of the collection. - You cannot retrieve a consistent snapshot of a collection larger - than the maximum page size. + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a + consistent snapshot of a collection larger than the maximum page + size. type: string kind: description: Type of resource. @@ -1689,8 +1700,6 @@ components: id: PoliciesListResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' policies: description: The policy resources. type: array @@ -1698,15 +1707,15 @@ components: $ref: '#/components/schemas/Policy' nextPageToken: description: >- - The presence of this field indicates that there exist more results - following your last page of results in pagination order. To fetch - them, make another list request using this value as your page token. - This lets you the complete contents of even very large collections - one page at a time. However, if the contents of the collection - change between the first and last paginated list request, the set of - all elements returned are an inconsistent view of the collection. - You cannot retrieve a consistent snapshot of a collection larger - than the maximum page size. + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a + consistent snapshot of a collection larger than the maximum page + size. type: string kind: description: Type of resource. @@ -1716,16 +1725,12 @@ components: id: PoliciesPatchResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' policy: $ref: '#/components/schemas/Policy' PoliciesUpdateResponse: id: PoliciesUpdateResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' policy: $ref: '#/components/schemas/Policy' ResponsePolicy: @@ -1777,7 +1782,7 @@ components: description: >- The fully qualified URL of the VPC network to bind to. This should be formatted like - https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` type: string kind: default: dns#responsePolicyNetwork @@ -1801,8 +1806,6 @@ components: id: ResponsePoliciesListResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' responsePolicies: description: The Response Policy resources. type: array @@ -1810,30 +1813,26 @@ components: $ref: '#/components/schemas/ResponsePolicy' nextPageToken: description: >- - The presence of this field indicates that more results exist - following your last page of results in pagination order. To fetch - them, make another list request by using this value as your page - token. This lets you view the complete contents of even very large - collections one page at a time. However, if the contents of the - collection change between the first and last paginated list request, - the set of all elements returned are an inconsistent view of the - collection. You cannot retrieve a consistent snapshot of a - collection larger than the maximum page size. + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a + consistent snapshot of a collection larger than the maximum page + size. type: string ResponsePoliciesPatchResponse: id: ResponsePoliciesPatchResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' responsePolicy: $ref: '#/components/schemas/ResponsePolicy' ResponsePoliciesUpdateResponse: id: ResponsePoliciesUpdateResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' responsePolicy: $ref: '#/components/schemas/ResponsePolicy' ResponsePolicyRule: @@ -1867,19 +1866,20 @@ components: enumDescriptions: - '' - >- - Skip a less-specific ResponsePolicyRule and continue normal query - logic. This can be used with a less-specific wildcard selector to - exempt a subset of the wildcard ResponsePolicyRule from the - ResponsePolicy behavior and query the public Internet instead. For - instance, if these rules exist: *.example.com -> LocalData 1.2.3.4 - foo.example.com -> Behavior 'bypassResponsePolicy' Then a query - for 'foo.example.com' skips the wildcard. This additionally - functions to facilitate the allowlist feature. RPZs can be applied - to multiple levels in the (eventually org, folder, project, - network) hierarchy. If a rule is applied at a higher level of the - hierarchy, adding a passthru rule at a lower level will supersede - that, and a query from an affected vm to that domain will be - exempt from the RPZ and proceed to normal resolution behavior. + Skip a less-specific Response Policy Rule and let the query logic + continue. This mechanism, when used with wildcard selectors, lets + you exempt specific subdomains from a broader Response Policy Rule + and direct the queries to the public internet instead. For + example, if the following rules exist: ``` *.example.com -> + LocalData 1.2.3.4 foo.example.com -> Behavior 'passthrough' ``` A + query for foo.example.com skips the wildcard rule. This + functionality also facilitates allowlisting. Response Policy Zones + (RPZs) can be applied at multiple levels within the hierarchy: for + example, an organization, a folder, a project, or a VPC network. + If an RPZ rule is applied at a higher level, adding a + `passthrough` rule at a lower level will override it. Queries from + affected virtual machines (VMs) to that domain bypass the RPZ and + proceed with normal resolution. enum: - behaviorUnspecified - bypassResponsePolicy @@ -1901,8 +1901,6 @@ components: id: ResponsePolicyRulesListResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' responsePolicyRules: description: The Response Policy Rule resources. type: array @@ -1910,30 +1908,26 @@ components: $ref: '#/components/schemas/ResponsePolicyRule' nextPageToken: description: >- - The presence of this field indicates that there exist more results - following your last page of results in pagination order. To fetch - them, make another list request using this value as your page token. - This lets you the complete contents of even very large collections - one page at a time. However, if the contents of the collection - change between the first and last paginated list request, the set of - all elements returned are an inconsistent view of the collection. - You cannot retrieve a consistent snapshot of a collection larger - than the maximum page size. + This field indicates that more results are available beyond the last + page displayed. To fetch the results, make another list request and + use this value as your page token. This lets you retrieve the + complete contents of a very large collection one page at a time. + However, if the contents of the collection change between the first + and last paginated list request, the set of all elements returned + are an inconsistent view of the collection. You can't retrieve a + consistent snapshot of a collection larger than the maximum page + size. type: string ResponsePolicyRulesPatchResponse: id: ResponsePolicyRulesPatchResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' responsePolicyRule: $ref: '#/components/schemas/ResponsePolicyRule' ResponsePolicyRulesUpdateResponse: id: ResponsePolicyRulesUpdateResponse type: object properties: - header: - $ref: '#/components/schemas/ResponseHeader' responsePolicyRule: $ref: '#/components/schemas/ResponsePolicyRule' parameters: @@ -2022,17 +2016,14 @@ components: name: resource_record_sets title: Resource_record_sets methods: - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1dns~1v1~1projects~1{project}~1managedZones~1{managedZone}~1rrsets/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.rrsets - list: - operation: *ref_1 - response: *ref_2 create: operation: $ref: >- @@ -2071,6 +2062,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/resource_record_sets/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/resource_record_sets/methods/delete @@ -2086,17 +2078,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1dns~1v1~1projects~1{project}~1managedZones~1{managedZone}~1changes/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.changes - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2111,6 +2100,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/changes/methods/create' update: [] + replace: [] delete: [] dns_keys: id: google.dns.dns_keys @@ -2124,23 +2114,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1dns~1v1~1projects~1{project}~1managedZones~1{managedZone}~1dnsKeys/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dnsKeys - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/dns_keys/methods/get' - $ref: '#/components/x-stackQL-resources/dns_keys/methods/list' insert: [] update: [] + replace: [] delete: [] projects: id: google.dns.projects @@ -2158,6 +2146,7 @@ components: - $ref: '#/components/x-stackQL-resources/projects/methods/get' insert: [] update: [] + replace: [] delete: [] managed_zone_operations: id: google.dns.managed_zone_operations @@ -2171,17 +2160,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1dns~1v1~1projects~1{project}~1managedZones~1{managedZone}~1operations/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: >- @@ -2190,6 +2176,7 @@ components: #/components/x-stackQL-resources/managed_zone_operations/methods/list insert: [] update: [] + replace: [] delete: [] managed_zones: id: google.dns.managed_zones @@ -2202,16 +2189,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: '#/paths/~1dns~1v1~1projects~1{project}~1managedZones/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.managedZones - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -2248,6 +2232,7 @@ components: - $ref: '#/components/x-stackQL-resources/managed_zones/methods/create' update: - $ref: '#/components/x-stackQL-resources/managed_zones/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/managed_zones/methods/update' delete: - $ref: '#/components/x-stackQL-resources/managed_zones/methods/delete' @@ -2263,17 +2248,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1dns~1v1~1projects~1{projectsId}~1managedZones~1{managedZonesId}:getIamPolicy/post - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -2287,6 +2269,9 @@ components: #/components/x-stackQL-resources/managed_zones_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/managed_zones_iam_policies/methods/set_iam_policy delete: [] policies: id: google.dns.policies @@ -2299,16 +2284,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: '#/paths/~1dns~1v1~1projects~1{project}~1policies/get' - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: '#/paths/~1dns~1v1~1projects~1{project}~1policies~1{policy}/get' @@ -2341,6 +2323,7 @@ components: - $ref: '#/components/x-stackQL-resources/policies/methods/create' update: - $ref: '#/components/x-stackQL-resources/policies/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/policies/methods/update' delete: - $ref: '#/components/x-stackQL-resources/policies/methods/delete' @@ -2355,16 +2338,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: '#/paths/~1dns~1v1~1projects~1{project}~1responsePolicies/get' - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.responsePolicies - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -2401,6 +2381,7 @@ components: - $ref: '#/components/x-stackQL-resources/response_policies/methods/create' update: - $ref: '#/components/x-stackQL-resources/response_policies/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/response_policies/methods/update' delete: - $ref: '#/components/x-stackQL-resources/response_policies/methods/delete' @@ -2416,17 +2397,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1dns~1v1~1projects~1{project}~1responsePolicies~1{responsePolicy}~1rules/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.responsePolicyRules - list: - operation: *ref_17 - response: *ref_18 get: operation: $ref: >- @@ -2466,6 +2444,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/response_policy_rules/methods/patch + replace: - $ref: >- #/components/x-stackQL-resources/response_policy_rules/methods/update delete: @@ -2473,7 +2452,7 @@ components: #/components/x-stackQL-resources/response_policy_rules/methods/delete paths: /dns/v1/projects/{project}/managedZones/{managedZone}/rrsets: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2580,7 +2559,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}/rrsets/{name}/{type}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing ResourceRecordSet. operationId: dns.resourceRecordSets.get @@ -2727,7 +2706,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}/changes: - parameters: *ref_19 + parameters: *ref_1 post: description: Atomically updates the ResourceRecordSet collection. operationId: dns.changes.create @@ -2823,7 +2802,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}/changes/{changeId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing Change. operationId: dns.changes.get @@ -2872,7 +2851,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing DnsKey. operationId: dns.dnsKeys.get @@ -2925,7 +2904,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}/dnsKeys: - parameters: *ref_19 + parameters: *ref_1 get: description: Enumerates DnsKeys to a ResourceRecordSet collection. operationId: dns.dnsKeys.list @@ -2978,7 +2957,7 @@ paths: schema: type: string /dns/v1/projects/{project}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing Project. operationId: dns.projects.get @@ -3017,7 +2996,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}/operations/{operation}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing Operation. operationId: dns.managedZoneOperations.get @@ -3066,7 +3045,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}/operations: - parameters: *ref_19 + parameters: *ref_1 get: description: Enumerates Operations for the given ManagedZone. operationId: dns.managedZoneOperations.list @@ -3119,7 +3098,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a new ManagedZone. operationId: dns.managedZones.create @@ -3201,7 +3180,7 @@ paths: schema: type: string /dns/v1/projects/{project}/managedZones/{managedZone}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing ManagedZone. operationId: dns.managedZones.get @@ -3353,7 +3332,7 @@ paths: schema: type: string /dns/v1/projects/{projectsId}/managedZones/{managedZonesId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3393,7 +3372,7 @@ paths: schema: type: string /dns/v1/projects/{projectsId}/managedZones/{managedZonesId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3440,7 +3419,7 @@ paths: schema: type: string /dns/v1/projects/{projectsId}/managedZones/{managedZonesId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3490,7 +3469,7 @@ paths: schema: type: string /dns/v1/projects/{project}/policies: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a new Policy. operationId: dns.policies.create @@ -3568,7 +3547,7 @@ paths: schema: type: string /dns/v1/projects/{project}/policies/{policy}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing Policy. operationId: dns.policies.get @@ -3722,7 +3701,7 @@ paths: schema: type: string /dns/v1/projects/{project}/responsePolicies: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a new Response Policy operationId: dns.responsePolicies.create @@ -3800,7 +3779,7 @@ paths: schema: type: string /dns/v1/projects/{project}/responsePolicies/{responsePolicy}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing Response Policy. operationId: dns.responsePolicies.get @@ -3954,7 +3933,7 @@ paths: schema: type: string /dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a new Response Policy Rule. operationId: dns.responsePolicyRules.create @@ -4042,7 +4021,7 @@ paths: schema: type: string /dns/v1/projects/{project}/responsePolicies/{responsePolicy}/rules/{responsePolicyRule}: - parameters: *ref_19 + parameters: *ref_1 get: description: Fetches the representation of an existing Response Policy Rule. operationId: dns.responsePolicyRules.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml index 67cfcca3..191b7df3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/documentai.yaml @@ -10,8 +10,8 @@ info: documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML. version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240911' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/document-ai/docs/ servers: @@ -37,218 +37,54 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudDocumentaiV1GcsDocument: - type: object - description: Specifies a document stored on Cloud Storage. - properties: - gcsUri: - type: string - description: The Cloud Storage object uri. - mimeType: - type: string - description: An IANA MIME type (RFC6838) of the content. - id: GoogleCloudDocumentaiV1GcsDocument - GoogleCloudDocumentaiV1beta1GcsSource: - type: object - properties: - uri: - type: string - description: >- - The Google Cloud Storage location where the input file will be read - from. - id: GoogleCloudDocumentaiV1beta1GcsSource - GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: - description: The long-running operation metadata for the DeleteProcessor method. + GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: properties: commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata - type: object - GoogleCloudDocumentaiV1beta1DocumentPageAnchor: - properties: - pageRefs: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef - type: array - description: One or more references to visual page elements - type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageAnchor - description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. - GoogleCloudDocumentaiV1beta2DocumentTextAnchor: - type: object - id: GoogleCloudDocumentaiV1beta2DocumentTextAnchor - description: Text reference indexing into the Document.text. - properties: - textSegments: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment - type: array - description: The text segments from the Document.text. - content: - description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. + questionId: + description: The Crowd Compute question ID. type: string - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: - type: object - description: Response message for the UndeployProcessorVersion method. - properties: {} - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse - GoogleCloudDocumentaiV1EvaluationMetrics: - type: object - id: GoogleCloudDocumentaiV1EvaluationMetrics - properties: - precision: - type: number - format: float - description: The calculated precision. - groundTruthOccurrencesCount: - description: The amount of occurrences in ground truth documents. - type: integer - format: int32 - truePositivesCount: - type: integer - description: The amount of true positives. - format: int32 - f1Score: - description: The calculated f1 score. - format: float - type: number - predictedOccurrencesCount: - type: integer - format: int32 - description: The amount of occurrences in predicted documents. - groundTruthDocumentCount: - type: integer - format: int32 - description: The amount of documents with a ground truth occurrence. - falseNegativesCount: - format: int32 - description: The amount of false negatives. - type: integer - falsePositivesCount: - format: int32 - description: The amount of false positives. - type: integer - recall: - format: float - type: number - description: The calculated recall. - predictedDocumentCount: - type: integer - format: int32 - description: The amount of documents with a predicted occurrence. - totalDocumentsCount: - description: The amount of documents that had an occurrence of this label. - format: int32 - type: integer - description: Evaluation metrics, either in aggregate or about a specific entity. - GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse: - properties: - responses: - type: array - description: Responses for each individual document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1ProcessDocumentResponse - type: object - id: GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse - description: >- - Response to an batch document processing request. This is returned in - the LRO Operation after the operation is complete. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: - type: object - description: Response of the import document operation. - properties: {} - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse - GoogleCloudDocumentaiV1EnableProcessorResponse: + id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata type: object - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. - properties: {} - id: GoogleCloudDocumentaiV1EnableProcessorResponse - GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef: - id: GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef + description: The long-running operation metadata for the ReviewDocument method. + GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: + description: Parsed and normalized entity value. type: object - description: Represents a weak reference to a page element within a document. properties: - page: - format: int64 - description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - type: string - confidence: - description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - type: number - format: float - boundingPoly: + moneyValue: description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1BoundingPoly' - layoutType: - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. + Money value. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + $ref: '#/components/schemas/GoogleTypeMoney' + addressValue: description: >- - Optional. The type of the layout element that is being referenced if - any. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - type: string - layoutId: - type: string - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - deprecated: true - GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview: - properties: - stateMessage: + Postal address. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + $ref: '#/components/schemas/GoogleTypePostalAddress' + booleanValue: description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - type: string - state: - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - type: string - description: Human Review information of the document. - id: GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview - type: object - GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue: - properties: + Boolean value. Can be used for entities with binary values, or for + checkboxes. + type: boolean dateValue: $ref: '#/components/schemas/GoogleTypeDate' description: >- Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + floatValue: + description: Float value. + type: number + format: float + datetimeValue: + description: >- + DateTime value. Includes date, time, and timezone. See also: + https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + $ref: '#/components/schemas/GoogleTypeDateTime' + integerValue: + type: integer + format: int32 + description: Integer value. text: type: string description: >- @@ -261,1310 +97,1149 @@ components: is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. - booleanValue: - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - type: boolean - datetimeValue: - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - $ref: '#/components/schemas/GoogleTypeDateTime' - integerValue: - format: int32 - type: integer - description: Integer value. - floatValue: - type: number - description: Float value. - format: float - moneyValue: - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - $ref: '#/components/schemas/GoogleTypeMoney' - addressValue: - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: Parsed and normalized entity value. + id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + GoogleCloudDocumentaiV1DocumentOutputConfig: type: object - id: GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue - GoogleCloudDocumentaiV1ReviewDocumentResponse: - properties: - gcsDestination: - description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - type: string - rejectionReason: - type: string - description: The reason why the review is rejected by reviewer. - state: - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - type: string - description: The state of the review operation. - type: object - id: GoogleCloudDocumentaiV1ReviewDocumentResponse - description: Response message for the ReviewDocument method. - GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The long-running operation metadata for the DeleteProcessor method. - GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: - description: The location information about where the processor is available. - type: object - id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - properties: - locationId: - type: string - description: >- - The location ID. For supported locations, refer to [regional and - multi-regional support](/document-ai/docs/regions). - GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment: - description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset - id: GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment - type: object - properties: - endIndex: - format: int64 - description: TextSegment half open end UTF-8 char index in the Document.text. - type: string - startIndex: - format: int64 - description: TextSegment start UTF-8 char index in the Document.text. - type: string - GoogleCloudDocumentaiV1DocumentOutputConfig: - id: GoogleCloudDocumentaiV1DocumentOutputConfig - description: >- - Config that controls the output of documents. All documents will be - written as a JSON file. properties: gcsOutputConfig: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig description: Output config to write the results to Cloud Storage. - type: object - GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + Config that controls the output of documents. All documents will be + written as a JSON file. + id: GoogleCloudDocumentaiV1DocumentOutputConfig + GoogleCloudDocumentaiV1DocumentChunkedDocument: + description: Represents the chunks that the document is divided into. type: object - GoogleCloudDocumentaiV1ListEvaluationsResponse: - description: The response from `ListEvaluations`. - id: GoogleCloudDocumentaiV1ListEvaluationsResponse + id: GoogleCloudDocumentaiV1DocumentChunkedDocument properties: - nextPageToken: - type: string + chunks: + description: List of chunks. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + type: array + GoogleCloudDocumentaiV1DocumentPage: + description: A page in a Document. + properties: + blocks: + type: array description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - evaluations: + A list of visually detected text blocks on the page. A block has a + set of lines (collected into paragraphs) that have a common + line-spacing and orientation. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' + image: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' + description: >- + Rendered image for this page. This image is preprocessed to remove + any skew, rotation, and distortions such that the annotation + bounding boxes can be upright and axis-aligned. + tokens: type: array - description: The evaluations requested. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' + description: A list of visually detected tokens on the page. + imageQualityScores: + description: Image quality scores. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores + detectedBarcodes: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + description: A list of detected barcodes. + dimension: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' + description: Physical dimension of the page. + lines: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' + type: array + description: >- + A list of visually detected text lines on the page. A collection of + tokens that a human would perceive as a line. + formFields: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' + type: array + description: A list of visually detected form fields on the page. + detectedLanguages: + type: array + description: A list of detected languages together with confidence. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + symbols: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' + description: A list of visually detected symbols on the page. + visualElements: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement + description: >- + A list of detected non-text visual elements e.g. checkbox, signature + etc. on the page. + pageNumber: + description: >- + 1-based index for current Page in a parent Document. Useful when a + page is taken out of a Document for individual processing. + format: int32 + type: integer + provenance: + deprecated: true + description: The history of this page. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + paragraphs: + type: array + description: >- + A list of visually detected text paragraphs on the page. A + collection of lines that a human would perceive as a paragraph. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for the page. + tables: + description: A list of visually detected tables on the page. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' + transforms: + description: >- + Transformation matrices that were applied to the original document + image to produce Page.image. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' + id: GoogleCloudDocumentaiV1DocumentPage type: object - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: type: object - id: >- - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus properties: - documentInconsistencyType: - enumDescriptions: - - Default value. - - The document proto is invalid. - - Indexed docproto metadata is mismatched. - - The page image or thumbnails are missing. - description: The type of document inconsistency. - enum: - - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED - - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO - - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA - - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE - type: string status: - description: >- - The status of resyncing the document with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. + description: The status of the exporting of the document. $ref: '#/components/schemas/GoogleRpcStatus' + outputGcsDestination: + description: >- + The output_gcs_destination of the exported document if it was + successful, otherwise empty. + type: string documentId: - description: The document identifier. + description: The path to source docproto of the document. $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: Resync status for each document per inconsistency type. - GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: + description: The status of each individual document in the export process. + id: >- + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: properties: + trainingDatasetValidation: + description: The training dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. + testDatasetValidation: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata type: object - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - GoogleCloudDocumentaiV1beta3BatchProcessResponse: - description: Response message for BatchProcessDocuments. + description: The metadata that represents a processor version being created. + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: + type: object + description: Response message for the SetDefaultProcessorVersion method. properties: {} - id: GoogleCloudDocumentaiV1beta3BatchProcessResponse + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse + GoogleCloudDocumentaiV1DeployProcessorVersionResponse: + properties: {} + description: Response message for the DeployProcessorVersion method. + id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse type: object - GoogleCloudDocumentaiV1beta1Vertex: + GoogleCloudDocumentaiV1BoundingPoly: + id: GoogleCloudDocumentaiV1BoundingPoly + description: A bounding polygon for the detected image annotation. type: object properties: - x: - format: int32 - type: integer - description: X coordinate. - 'y': - format: int32 - type: integer - description: Y coordinate (starts from the top of the image). - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. - id: GoogleCloudDocumentaiV1beta1Vertex - GoogleCloudDocumentaiV1beta1DocumentPageDimension: - id: GoogleCloudDocumentaiV1beta1DocumentPageDimension + normalizedVertices: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' + description: The bounding polygon normalized vertices. + type: array + vertices: + description: The bounding polygon vertices. + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: properties: - height: - format: float - type: number - description: Page height. - unit: - type: string - description: Dimension unit. - width: - format: float - type: number - description: Page width. - description: Dimension for the page. + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. type: object - GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode: + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: + description: Metadata of the import document operation. type: object - description: A detected barcode. - id: GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode + id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata properties: - barcode: - description: Detailed barcode information of the DetectedBarcode. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1Barcode' + importConfigValidationResults: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + description: Validation statuses of the batch documents import config. + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + totalDocumentCount: + type: integer + description: Total number of the documents that are qualified for importing. + format: int32 + individualImportStatuses: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus + description: The list of response details of each document. + GoogleCloudDocumentaiV1DisableProcessorRequest: + description: Request message for the DisableProcessor method. + properties: {} + id: GoogleCloudDocumentaiV1DisableProcessorRequest + type: object + GoogleCloudDocumentaiV1DocumentPageToken: + type: object + id: GoogleCloudDocumentaiV1DocumentPageToken + description: A detected token. + properties: + styleInfo: + description: Text style attributes. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo + provenance: + deprecated: true + description: The history of this annotation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for DetectedBarcode. - GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak: + description: Layout for Token. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedBreak: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. + detectedLanguages: + description: A list of detected languages together with confidence. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudDocumentaiV1BatchProcessRequest: + type: object + description: Request message for BatchProcessDocuments. + id: GoogleCloudDocumentaiV1BatchProcessRequest properties: - type: - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - type: string - description: Detected break type. - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - id: GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak + documentOutputConfig: + description: The output configuration for the BatchProcessDocuments method. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' + labels: + description: >- + Optional. The labels with user-defined metadata for the request. + Label keys and values can be no longer than 63 characters (Unicode + codepoints) and can only contain lowercase letters, numeric + characters, underscores, and dashes. International characters are + allowed. Label values are optional. Label keys must start with a + letter. + additionalProperties: + type: string + type: object + skipHumanReview: + type: boolean + description: >- + Whether human review should be skipped for this request. Default to + `false`. + processOptions: + description: Inference-time options for the process API + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + inputDocuments: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The input documents for the BatchProcessDocuments method. + GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: + id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. type: object - description: Detected break at the end of a Token. - GoogleCloudDocumentaiV1beta2DocumentPageLayout: properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - confidence: - type: number + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1beta3RevisionRef: + description: The revision reference specifies which revision on the document to read. + properties: + latestProcessorVersion: description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. - format: float - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2BoundingPoly' - orientation: + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + type: string + revisionCase: type: string - enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. - - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. - - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - description: Detected orientation for the Layout. enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION + enumDescriptions: + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. + description: Reads the revision by the predefined case. + revisionId: + description: Reads the revision given by the id. + type: string type: object - description: Visual element describing a layout unit on a page. - id: GoogleCloudDocumentaiV1beta2DocumentPageLayout - GoogleCloudDocumentaiV1DocumentStyle: + id: GoogleCloudDocumentaiV1beta3RevisionRef + GoogleCloudDocumentaiV1beta3BatchProcessMetadata: + type: object + description: The long-running operation metadata for BatchProcessDocuments. + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata properties: - textDecoration: + updateTime: + description: The last update time of the operation. + format: google-datetime type: string - description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text color. - fontSize: - description: Font size. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - textStyle: + createTime: + format: google-datetime + description: The creation time of the operation. type: string - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - fontFamily: + stateMessage: type: string description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - fontWeight: - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + individualProcessStatuses: + description: The list of response details of each document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + type: array + state: type: string - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. - type: object - id: GoogleCloudDocumentaiV1DocumentStyle - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. + enum: + - STATE_UNSPECIFIED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLING + - CANCELLED + - FAILED + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was being cancelled. + - The batch processing was cancelled. + - The batch processing has failed. + description: The state of the current batch processing. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock: properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. - type: object - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - description: The document id of the document. - status: - description: The status of deleting the document in storage. - $ref: '#/components/schemas/GoogleRpcStatus' - id: >- - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - type: object - description: The status of each individual document in the batch delete process. - GoogleCloudDocumentaiV1beta2DocumentProvenance: - id: GoogleCloudDocumentaiV1beta2DocumentProvenance - properties: - id: - type: integer - deprecated: true - format: int32 - description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - parents: + blocks: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenanceParent + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: >- + A text block could further have child blocks. Repeated blocks + support further hierarchies and nested blocks. type: array - description: References to the original elements that are replaced. - revision: - description: The index of the revision that produced this element. - format: int32 - deprecated: true - type: integer + text: + type: string + description: Text content stored in the block. type: - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true type: string - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - description: The type of provenance operation. - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. + description: >- + Type of the text in the block. Available options are: `paragraph`, + `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, + `heading-5`, `header`, `footer`. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + description: Represents a text type block. type: object + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: description: >- - Structure to identify provenance relationships between annotations in - different revisions. - GoogleCloudDocumentaiV1beta3DisableProcessorResponse: + The long-running operation metadata for the UndeployProcessorVersion + method. + type: object + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata + GoogleCloudDocumentaiV1BatchProcessResponse: + id: GoogleCloudDocumentaiV1BatchProcessResponse + description: Response message for BatchProcessDocuments. type: object - id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. properties: {} - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: + GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: + description: The long-running operation metadata for the ReviewDocument method. type: object - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig + id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata properties: - fieldMask: + stateMessage: type: string - format: google-fieldmask description: >- - Specifies which fields to include in the output documents. Only - supports top level document and pages field so it must be in the - form of `{document_field_name}` or `pages.{page_field_name}`. - gcsUri: + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + createTime: + description: The creation time of the operation. type: string - description: The Cloud Storage uri (a directory) of the output. - shardingConfig: - description: Specifies the sharding config for the output document. + format: google-datetime + updateTime: + type: string + description: The last update time of the operation. + format: google-datetime + questionId: + type: string + description: The Crowd Compute question ID. + commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - description: The configuration used when outputting documents. - GoogleCloudDocumentaiV1beta3GcsPrefix: - id: GoogleCloudDocumentaiV1beta3GcsPrefix - description: Specifies all documents on Cloud Storage with a common prefix. - properties: - gcsUriPrefix: - description: The URI prefix. + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + state: + description: Used only when Operation.done is false. type: string - type: object - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: - type: object + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + GoogleCloudDocumentaiV1Vertex: description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. - id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + A vertex represents a 2D point in the image. NOTE: the vertex + coordinates are in the same scale as the original image. + id: GoogleCloudDocumentaiV1Vertex properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The validation status of import config. - inputGcsSource: - description: The source Cloud Storage URI specified in the import config. + x: + type: integer + format: int32 + description: X coordinate. + 'y': + description: Y coordinate (starts from the top of the image). + type: integer + format: int32 + type: object + GoogleCloudDocumentaiV1ListProcessorTypesResponse: + properties: + processorTypes: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + description: The processor types. + nextPageToken: + description: Points to the next page, otherwise empty. type: string - GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: + id: GoogleCloudDocumentaiV1ListProcessorTypesResponse + description: Response message for the ListProcessorTypes method. type: object + GoogleCloudDocumentaiV1Evaluation: + type: object + id: GoogleCloudDocumentaiV1Evaluation properties: - inputGcsSource: - description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. + allEntitiesMetrics: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + description: Metrics for all the entities in aggregate. + documentCounters: + description: Counters for the documents used in the evaluation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' + entityMetrics: + description: Metrics across confidence levels, for different entities. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + type: object + createTime: + description: The time that the evaluation was created. type: string - outputGcsDestination: + format: google-datetime + kmsKeyName: type: string + description: The KMS key name used for encryption. + name: description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. - status: - description: The status processing the document. - $ref: '#/components/schemas/GoogleRpcStatus' - humanReviewStatus: - description: The status of human review on the processed document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' - id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - description: The status of a each individual document in the batch process. - GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef: + The resource name of the evaluation. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` + type: string + kmsKeyVersionName: + description: The KMS key version with which data is encrypted. + type: string + description: An evaluation of a ProcessorVersion's performance. + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: type: object - description: Represents a weak reference to a page element within a document. - id: GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef + description: Options to control foundation model tuning of the processor. + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions properties: - layoutType: - type: string + learningRateMultiplier: description: >- - Optional. The type of the layout element that is being referenced if - any. - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2BoundingPoly' - description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - layoutId: - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - deprecated: true - type: string - confidence: - description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - type: number + Optional. The multiplier to apply to the recommended learning rate. + Valid values are between 0.1 and 10. If not provided, recommended + learning rate will be used. format: float - page: - type: string - description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - format: int64 - GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: - description: Metadata of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata - properties: - commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: The basic metadata of the long-running operation. - type: object - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: - type: object - description: >- - The validation status of each import config. Status is set to an error - if there are no documents to import in the `import_config`, or `OK` if - the operation will try to proceed with at least one document. - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - properties: - status: - description: The validation status of import config. - $ref: '#/components/schemas/GoogleRpcStatus' - inputGcsSource: - description: The source Cloud Storage URI specified in the import config. - type: string - GoogleRpcStatus: - properties: - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - type: object - GoogleCloudDocumentaiV1beta1DocumentPageImage: - description: Rendered image contents for this page. - type: object - properties: - mimeType: - type: string + type: number + trainSteps: description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - width: - description: Width of the image in pixels. - format: int32 - type: integer - height: + Optional. The number of steps to run for model tuning. Valid values + are between 1 and 400. If not provided, recommended steps will be + used. type: integer - description: Height of the image in pixels. format: int32 - content: - description: Raw byte content of the image. - format: byte - type: string - id: GoogleCloudDocumentaiV1beta1DocumentPageImage - GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: - description: Information about the upcoming deprecation of this processor version. - id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: + id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig type: object properties: - replacementProcessorVersion: - description: If set, the processor version that will be used as a replacement. - type: string - deprecationTime: - format: google-datetime - description: The time at which this processor version will be deprecated. + schema: + description: >- + Output only. The schema in Document AI Warehouse associated with the + dataset. type: string - GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores: - type: object - description: Image quality scores for the page image. - id: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores - properties: - qualityScore: + readOnly: true + collection: description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - type: number - format: float - detectedDefects: - description: A list of detected defects. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect - GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: - description: The response message for the ImportProcessorVersion method. - type: object - properties: - processorVersion: + Output only. The collection in Document AI Warehouse associated with + the dataset. + readOnly: true type: string - description: The destination processor version name. - id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse - GoogleProtobufEmpty: - properties: {} description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + Configuration specific to the Document AI Warehouse-based + implementation. + GoogleCloudDocumentaiV1beta3DocumentId: type: object - id: GoogleProtobufEmpty - GoogleCloudDocumentaiV1beta1DocumentPageToken: - id: GoogleCloudDocumentaiV1beta1DocumentPageToken + id: GoogleCloudDocumentaiV1beta3DocumentId properties: - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - type: array - detectedBreak: + unmanagedDocId: + description: A document id within unmanaged dataset. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - deprecated: true - styleInfo: - description: Text style attributes. + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + gcsManagedDocId: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo - description: A detected token. - type: object - GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow: - id: GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow - type: object - description: A row of table cells. - properties: - cells: - type: array - description: Cells that make up this row. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell - GoogleCloudDocumentaiV1beta3EnableProcessorResponse: - description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. - id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse - type: object - properties: {} - GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument + #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + description: A document id within user-managed Cloud Storage. + revisionRef: + description: Points to a specific revision of the document if set. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' + description: Document Identifier. + GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: type: object + id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId properties: - documentId: - description: An internal identifier for document. - type: string - GoogleCloudDocumentaiV1beta1DocumentShardInfo: - id: GoogleCloudDocumentaiV1beta1DocumentShardInfo - properties: - shardIndex: - format: int64 - type: string - description: The 0-based index of this shard. - shardCount: - type: string - description: Total number of shards. - format: int64 - textOffset: + docId: + description: Required. The id of the document. type: string - format: int64 - description: >- - The index of the first character in Document.text in the overall - document global text. description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - type: object - GoogleCloudDocumentaiV1DocumentPageTable: - id: GoogleCloudDocumentaiV1DocumentPageTable - description: A table representation similar to HTML table structure. - type: object + Identifies a document uniquely within the scope of a dataset in + unmanaged option. + GoogleCloudDocumentaiV1DocumentPageVisualElement: + description: >- + Detected non-text visual elements e.g. checkbox, signature etc. on the + page. properties: layout: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Table. - bodyRows: - description: Body rows of the table. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + description: Layout for VisualElement. detectedLanguages: description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage type: array - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this table. - headerRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow - description: Header rows of the table. - GoogleCloudDocumentaiV1beta1InputConfig: - type: object - description: The desired input location and metadata. - id: GoogleCloudDocumentaiV1beta1InputConfig + type: + description: Type of the VisualElement. + type: string + id: GoogleCloudDocumentaiV1DocumentPageVisualElement + type: object + GoogleTypePostalAddress: + description: >- + Represents a postal address, e.g. for postal delivery or payments + addresses. Given a postal address, a postal service can deliver items to + a premise, P.O. Box or similar. It is not intended to model geographical + locations (roads, towns, mountains). In typical usage an address would + be created via user input or from importing existing data, depending on + the type of process. Advice on address input / editing: - Use an + internationalization-ready address widget such as + https://github.com/google/libaddressinput) - Users should not be + presented with UI elements for input or editing of fields outside + countries where that field is used. For more guidance on how to use this + schema, please see: https://support.google.com/business/answer/6397478 + type: object properties: - gcsSource: + languageCode: + type: string description: >- - The Google Cloud Storage location to read the input from. This must - be a single file. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1GcsSource' - mimeType: + Optional. BCP-47 language code of the contents of this address (if + known). This is often the UI language of the input form or is + expected to match one of the languages used in the address' + country/region, or their transliterated equivalents. This can affect + formatting in certain countries, but is not critical to the + correctness of the data and will never affect any validation or + other non-formatting related operations. If this value is not known, + it should be omitted (rather than specifying a possibly incorrect + default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + revision: + type: integer + description: >- + The schema revision of the `PostalAddress`. This must be set to 0, + which is the latest revision. All new revisions **must** be backward + compatible with old revisions. + format: int32 + sortingCode: description: >- - Required. Mimetype of the input. Current supported mimetypes are - application/pdf, image/tiff, and image/gif. In addition, - application/json type is supported for requests with - ProcessDocumentRequest.automl_params field set. The JSON file needs - to be in Document format. + Optional. Additional, country-specific, sorting code. This is not + used in most regions. Where it is used, the value is either a string + like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or + just a number alone, representing the "sector code" (Jamaica), + "delivery area indicator" (Malawi) or "post office indicator" (e.g. + Côte d'Ivoire). type: string - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: - description: Metadata of the batch export documents operation. - type: object - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata - properties: - individualExportStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus - description: The list of response details of each document. + regionCode: + description: >- + Required. CLDR region code of the country/region of the address. + This is never inferred and it is up to the user to ensure the value + is correct. See https://cldr.unicode.org/ and + https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + for details. Example: "CH" for Switzerland. + type: string + locality: + type: string + description: >- + Optional. Generally refers to the city/town portion of the address. + Examples: US city, IT comune, UK post town. In regions of the world + where localities are not well defined or do not fit into this + structure well, leave locality empty and use address_lines. + recipients: + description: >- + Optional. The recipient at the address. This field may, under + certain circumstances, contain multiline information. For example, + it might contain "care of" information. type: array - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - splitExportStats: items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + type: string + organization: + type: string + description: Optional. The name of the organization at the address. + administrativeArea: + type: string + description: >- + Optional. Highest administrative subdivision which is used for + postal addresses of a country or region. For example, this can be a + state, a province, an oblast, or a prefecture. Specifically, for + Spain this is the province and not the autonomous community (e.g. + "Barcelona" and not "Catalonia"). Many countries don't use an + administrative area in postal addresses. E.g. in Switzerland this + should be left unpopulated. + addressLines: type: array - description: The list of statistics for each dataset split type. - GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: - description: The long-running operation metadata for the EnableProcessor method. - type: object - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + items: + type: string + description: >- + Unstructured address lines describing the lower levels of an + address. Because values in address_lines do not have type + information and may sometimes contain multiple values in a single + field (e.g. "Austin, TX"), it is important that the line order is + clear. The order of address lines should be "envelope order" for the + country/region of the address. In places where this can vary (e.g. + Japan), address_language is used to make it explicit (e.g. "ja" for + large-to-small ordering and "ja-Latn" or "en" for small-to-large). + This way, the most specific line of an address can be selected based + on the language. The minimum permitted structural representation of + an address consists of a region_code with all remaining information + placed in the address_lines. It would be possible to format such an + address very approximately without geocoding, but no semantic + reasoning could be made about any of the address components until it + was at least partially resolved. Creating an address only containing + a region_code and address_lines, and then geocoding is the + recommended way to handle completely unstructured addresses (as + opposed to guessing which parts of the address should be localities + or administrative areas). + sublocality: + type: string + description: >- + Optional. Sublocality of the address. For example, this can be + neighborhoods, boroughs, districts. + postalCode: + type: string + description: >- + Optional. Postal code of the address. Not all countries use or + require postal codes to be present, but where they are used, they + may trigger additional validation with other parts of the address + (e.g. state/zip validation in the U.S.A.). + id: GoogleTypePostalAddress + GoogleCloudDocumentaiV1DocumentPageImage: + id: GoogleCloudDocumentaiV1DocumentPageImage + description: Rendered image contents for this page. properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1NormalizedVertex: + height: + type: integer + format: int32 + description: Height of the image in pixels. + width: + type: integer + format: int32 + description: Width of the image in pixels. + mimeType: + description: >- + Encoding [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml) + for the image. + type: string + content: + type: string + format: byte + description: Raw byte content of the image. type: object - properties: - 'y': - type: number - format: float - description: Y coordinate (starts from the top of the image). - x: - type: number - description: X coordinate. - format: float + GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: + id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - id: GoogleCloudDocumentaiV1NormalizedVertex - GoogleCloudDocumentaiV1DisableProcessorMetadata: - type: object - description: The long-running operation metadata for the DisableProcessor method. - id: GoogleCloudDocumentaiV1DisableProcessorMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: - description: The response for TrainProcessorVersion. + A text segment in the Document.text. The indices may be out of bounds + which indicate that the text extends into another document shard for + large sharded documents. See ShardInfo.text_offset type: object properties: - processorVersion: - description: The resource name of the processor version produced by training. + endIndex: + format: int64 + description: TextSegment half open end UTF-8 char index in the Document.text. type: string - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: + startIndex: + type: string + format: int64 + description: TextSegment start UTF-8 char index in the Document.text. + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig: + description: Serving config for chunking. properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' + includeAncestorHeadings: + type: boolean description: >- - The status of resyncing the dataset with regards to the detected - inconsistency. Empty if ResyncDatasetRequest.validate_only is - `true`. - datasetInconsistencyType: - description: The type of the inconsistency of the dataset. - enumDescriptions: - - Default value. - - The marker file under the dataset folder is not found. - enum: - - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED - - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER - type: string - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - description: Resync status against inconsistency types on the dataset level. + Optional. Whether or not to include ancestor headings when + splitting. + chunkSize: + description: >- + Optional. The chunk sizes to use when splitting documents, in order + of level. + type: integer + format: int32 type: object - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig + GoogleCloudDocumentaiV1GcsDocuments: + id: GoogleCloudDocumentaiV1GcsDocuments properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' + documents: type: array - description: >- - A list of operations that matches the specified filter in the - request. - description: The response message for Operations.ListOperations. + description: The list of documents. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + type: object + description: Specifies a set of documents on Cloud Storage. + GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: + properties: {} + description: Response message for the SetDefaultProcessorVersion method. + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse + type: object + GoogleCloudDocumentaiV1DocumentRevision: + id: GoogleCloudDocumentaiV1DocumentRevision type: object - GoogleCloudDocumentaiV1beta1OperationMetadata: - id: GoogleCloudDocumentaiV1beta1OperationMetadata - description: Contains metadata for the BatchProcessDocuments operation. properties: - state: + id: type: string - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request is received. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was cancelled. - - The batch processing has failed. - description: The state of the current batch processing. - enum: - - STATE_UNSPECIFIED - - ACCEPTED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLED - - FAILED - updateTime: - format: google-datetime + description: >- + Id of the revision, internally generated by doc proto storage. + Unique within the context of the document. + processor: + description: >- + If the annotation was made by processor identify the processor by + its resource name. type: string - description: The last update time of the operation. - stateMessage: + agent: type: string description: >- - A message providing more details about the current state of - processing. + If the change was made by a person specify the name or id of that + person. + parentIds: + items: + type: string + description: >- + The revisions that this revision is based on. Must include all the + ids that have anything to do with this revision - eg. there are + `provenance.parent.revision` fields that index into this field. + type: array createTime: - type: string - description: The creation time of the operation. + description: >- + The time that the revision was created, internally generated by doc + proto storage at the time of create. format: google-datetime + type: string + parent: + type: array + items: + format: int32 + type: integer + description: >- + The revisions that this revision is based on. This can include one + or more parent (when documents are merged.) This field represents + the index into the `revisions` field. + deprecated: true + humanReview: + description: Human Review information of this revision. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview + description: Contains past or forward revisions of this document. + GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata type: object - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse - description: Response message associated with the ExportProcessorVersion operation. + GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak + description: Detected break at the end of a Token. type: object properties: - gcsUri: + type: + description: Detected break type. + enum: + - TYPE_UNSPECIFIED + - SPACE + - WIDE_SPACE + - HYPHEN + enumDescriptions: + - Unspecified break type. + - A single whitespace. + - A wider whitespace. + - A hyphen that indicates that a token has been split across lines. type: string - description: The Cloud Storage URI containing the output artifacts. - GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: - type: object - description: The response message for the ImportProcessorVersion method. + GoogleCloudDocumentaiV1GcsDocument: properties: - processorVersion: - description: The destination processor version name. + mimeType: type: string - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse - GoogleCloudDocumentaiV1beta1GcsDestination: - description: >- - The Google Cloud Storage location where the output file will be written - to. - properties: - uri: + description: An IANA MIME type (RFC6838) of the content. + gcsUri: + description: The Cloud Storage object uri. type: string - id: GoogleCloudDocumentaiV1beta1GcsDestination + description: Specifies a document stored on Cloud Storage. + id: GoogleCloudDocumentaiV1GcsDocument + type: object + GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: + properties: {} type: object - GoogleCloudDocumentaiV1beta2Document: + id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse + description: Response of the import document operation. + GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. - id: GoogleCloudDocumentaiV1beta2Document + The long-running operation metadata for updating the human review + configuration. + id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + type: object + GoogleCloudDocumentaiV1ListEvaluationsResponse: type: object + id: GoogleCloudDocumentaiV1ListEvaluationsResponse properties: - uri: - type: string - description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - text: + nextPageToken: type: string - description: Optional. UTF-8 encoded text in reading order from the document. - entities: - type: array description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + evaluations: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntity' - textChanges: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + description: The evaluations requested. type: array - description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextChange - content: - format: byte - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. + description: The response from `ListEvaluations`. + GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentEntityRelation + description: Relationship between Entities. + type: object + properties: + subjectId: + description: Subject entity id. type: string - pages: - description: Visual page layout for the Document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPage' - type: array - entityRelations: - type: array - description: Placeholder. Relationship among Document.entities. + objectId: + type: string + description: Object entity id. + relation: + description: Relationship description. + type: string + GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata + type: object + description: Metadata of the EvaluateProcessorVersion method. + properties: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: + properties: + totalDocumentCount: + format: int32 + description: Total number of the documents that are qualified for importing. + type: integer + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + individualImportStatuses: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntityRelation - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Any error that occurred while processing this document. - labels: - description: Labels for this document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentLabel' + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + description: The list of response details of each document. type: array - shardInfo: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentShardInfo' - description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - mimeType: - type: string - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - textStyles: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentStyle' + importConfigValidationResults: type: array - description: Styles for the Document.text. - deprecated: true - revisions: - description: Placeholder. Revision history of this document. + description: Validation statuses of the batch documents import config. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentRevision' - type: array - GoogleCloudDocumentaiV1EvaluationReference: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata + description: Metadata of the import document operation. type: object - id: GoogleCloudDocumentaiV1EvaluationReference + GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: properties: - aggregateMetrics: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching on. - evaluation: - description: The resource name of the evaluation. - type: string - operation: - description: The resource name of the Long Running Operation for the evaluation. - type: string - aggregateMetricsExact: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - description: >- - An aggregate of the statistics for the evaluation with fuzzy - matching off. - description: >- - Gives a short summary of an evaluation, and links to the evaluation - itself. - GoogleCloudDocumentaiV1beta1DocumentEntityRelation: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for DetectedBarcode. + barcode: + description: Detailed barcode information of the DetectedBarcode. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' + description: A detected barcode. type: object + id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode + GoogleCloudDocumentaiV1ReviewDocumentResponse: + description: Response message for the ReviewDocument method. properties: - objectId: + state: type: string - description: Object entity id. - subjectId: + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. + description: The state of the review operation. + enum: + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + rejectionReason: type: string - description: Subject entity id. - relation: + description: The reason why the review is rejected by reviewer. + gcsDestination: type: string - description: Relationship description. - description: Relationship between Entities. - id: GoogleCloudDocumentaiV1beta1DocumentEntityRelation - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: - properties: {} + description: >- + The Cloud Storage uri for the human reviewed document if the review + is succeeded. + id: GoogleCloudDocumentaiV1ReviewDocumentResponse type: object - description: Response of the delete documents operation. - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse - GoogleCloudDocumentaiV1HumanReviewStatus: - description: The status of human review on a processed document. + GoogleCloudDocumentaiV1ProcessorVersionAlias: + type: object + description: Contains the alias and the aliased resource name of processor version. properties: - humanReviewOperation: - description: >- - The name of the operation triggered by the processed document. This - field is populated only when the state is - `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and - metadata as the long-running operation returned by ReviewDocument. - type: string - state: - description: The state of human review on the processing request. - enumDescriptions: - - >- - Human review state is unspecified. Most likely due to an internal - error. - - >- - Human review is skipped for the document. This can happen because - human review isn't enabled on the processor or the processing - request has been set to skip this document. - - >- - Human review validation is triggered and passed, so no review is - needed. - - >- - Human review validation is triggered and the document is under - review. - - >- - Some error happened during triggering human review, see the - state_message for details. + processorVersion: type: string - enum: - - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR - stateMessage: - description: A message providing more details about the human review state. + description: The resource name of aliased processor version. + alias: type: string + description: The alias in the form of `processor_version` resource name. + id: GoogleCloudDocumentaiV1ProcessorVersionAlias + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + description: The status of each individual document in the batch delete process. + properties: + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of deleting the document in storage. + id: >- + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus type: object - id: GoogleCloudDocumentaiV1HumanReviewStatus - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: + GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: type: object - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse - properties: {} - description: Response of the batch update documents operation. - GoogleCloudDocumentaiV1beta1Barcode: + description: Metadata of the sample documents operation. + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata properties: - rawValue: - type: string + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata + description: The metadata proto of `ResyncDataset` method. + type: object + properties: + individualDocumentResyncStatuses: description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - format: - type: string + The list of document resync statuses. The same document could have + multiple `individual_document_resync_statuses` if it has multiple + inconsistencies. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + datasetResyncStatuses: description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - valueFormat: + The list of dataset resync statuses. Not checked when + ResyncDatasetRequest.dataset_documents is specified. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1BatchDocumentsInputConfig: + id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig + properties: + gcsPrefix: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - type: string + The set of documents that match the specified Cloud Storage + `gcs_prefix`. + gcsDocuments: + description: The set of documents individually specified on Cloud Storage. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' type: object - id: GoogleCloudDocumentaiV1beta1Barcode - description: Encodes the detailed information of a barcode. - GoogleCloudDocumentaiV1DocumentPageLine: - id: GoogleCloudDocumentaiV1DocumentPageLine + description: The common config to specify a set of documents used as input. + GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: type: object + description: The long-running operation metadata for UpdateLabelerPool. + id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1DocumentPageParagraph: + description: A collection of lines that a human would perceive as a paragraph. + id: GoogleCloudDocumentaiV1DocumentPageParagraph properties: provenance: + description: The history of this annotation. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' deprecated: true - description: The history of this annotation. + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Paragraph. detectedLanguages: + type: array + description: A list of detected languages together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Line. - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak: - description: Detected break at the end of a Token. - id: GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak + type: object + GoogleCloudDocumentaiV1beta3BatchProcessResponse: + properties: {} + description: Response message for BatchProcessDocuments. + id: GoogleCloudDocumentaiV1beta3BatchProcessResponse + type: object + GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig: + type: object properties: - type: + chunkingConfig: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig + description: Optional. Config for chunking in layout parser processor. + description: Serving config for layout parser processor. + id: GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig + GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse + type: object + description: The response proto of ResyncDataset method. + properties: {} + GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata: + description: The long-running operation metadata for the DeleteProcessor method. + type: object + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata + GoogleCloudDocumentaiUiv1beta3DocumentId: + properties: + unmanagedDocId: + description: A document id within unmanaged dataset. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + gcsManagedDocId: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId + description: A document id within user-managed Cloud Storage. + revisionRef: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' + description: Points to a specific revision of the document if set. + type: object + id: GoogleCloudDocumentaiUiv1beta3DocumentId + description: Document Identifier. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse + type: object + description: Response of the import document operation. + properties: {} + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo: + id: >- + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + properties: + baseProcessorVersionId: + description: The base processor version ID for the custom model. + type: string + customModelType: type: string - description: Detected break type. enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. + - The model type is unspecified. + - The model is a versioned foundation model. + - The model is a finetuned foundation model. + description: The type of custom model created by the user. enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN - type: object - GoogleCloudDocumentaiV1DocumentEntityNormalizedValue: - properties: - text: - description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - type: string - addressValue: - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - $ref: '#/components/schemas/GoogleTypePostalAddress' - floatValue: - format: float - type: number - description: Float value. - moneyValue: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - dateValue: - description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - $ref: '#/components/schemas/GoogleTypeDate' - integerValue: - format: int32 - type: integer - description: Integer value. - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - booleanValue: - type: boolean - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - description: Parsed and normalized entity value. - type: object - id: GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - GoogleCloudDocumentaiV1beta2DocumentRevision: - description: Contains past or forward revisions of this document. - properties: - parent: - items: - format: int32 - type: integer - type: array - description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - deprecated: true - agent: - type: string - description: >- - If the change was made by a person specify the name or id of that - person. - id: - type: string - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - humanReview: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview - description: Human Review information of this revision. - parentIds: - description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. - type: array - items: - type: string - processor: - description: >- - If the annotation was made by processor identify the processor by - its resource name. - type: string - createTime: - type: string - format: google-datetime - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - type: object - id: GoogleCloudDocumentaiV1beta2DocumentRevision - GoogleCloudDocumentaiV1DocumentPageParagraph: - description: A collection of lines that a human would perceive as a paragraph. - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for Paragraph. - detectedLanguages: - description: A list of detected languages together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - deprecated: true - description: The history of this annotation. - id: GoogleCloudDocumentaiV1DocumentPageParagraph - type: object - GoogleCloudDocumentaiV1beta2DocumentProvenanceParent: - properties: - revision: - type: integer - format: int32 - description: The index of the index into current revision's parent_ids list. - id: - format: int32 - deprecated: true - type: integer - description: The id of the parent provenance. - index: - format: int32 - type: integer - description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - id: GoogleCloudDocumentaiV1beta2DocumentProvenanceParent - type: object - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: + - CUSTOM_MODEL_TYPE_UNSPECIFIED + - VERSIONED_FOUNDATION + - FINE_TUNED + description: >- + Information for a custom Generative AI model created by the user. These + are created with `Create New Version` in either the `Call foundation + model` or `Fine tuning` tabs. + type: object + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata + description: The metadata that represents a processor version being created. type: object properties: commonMetadata: @@ -1579,1436 +1254,1205 @@ components: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation description: The training dataset validation information. - id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata - description: The metadata that represents a processor version being created. - GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect: + GoogleCloudDocumentaiV1DeployProcessorVersionRequest: + type: object + id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest + description: Request message for the DeployProcessorVersion method. + properties: {} + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell: properties: - type: - description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` - type: string - confidence: - type: number - format: float + rowSpan: + type: integer + format: int32 + description: How many rows this cell spans. + colSpan: + description: How many columns this cell spans. + format: int32 + type: integer + blocks: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: array description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. + A table cell is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. type: object - description: Image Quality Defects - id: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect - GoogleCloudDocumentaiV1DocumentTextAnchor: - id: GoogleCloudDocumentaiV1DocumentTextAnchor + description: Represents a cell in a table row. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + GoogleCloudDocumentaiV1DocumentTextChange: type: object + id: GoogleCloudDocumentaiV1DocumentTextChange + description: This message is used for text changes aka. OCR corrections. properties: - content: - type: string + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. - textSegments: + Provenance of the correction. Text anchor indexing into the + Document.text. There can only be a single `TextAnchor.text_segments` + element. If the start and end index of the text segment are the + same, the text change is inserted before that index. + provenance: + deprecated: true items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - description: The text segments from the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. type: array - description: Text reference indexing into the Document.text. - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata: + changedText: + type: string + description: The text that replaces the text identified in the `text_anchor`. + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata + id: GoogleRpcStatus + properties: + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + code: + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + details: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata: properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata: - description: The long-running operation metadata for the ReviewDocument method. + description: The long-running operation metadata for the EnableProcessor method. + type: object + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata + GoogleCloudDocumentaiV1DeleteProcessorMetadata: + type: object properties: - questionId: - type: string - description: The Crowd Compute question ID. commonMetadata: - description: The basic metadata of the long-running operation. $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1DeleteProcessorMetadata + description: The long-running operation metadata for the DeleteProcessor method. + GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: + id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata type: object - id: GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: properties: commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - trainingDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: The training dataset validation information. - testDatasetValidation: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1EnableProcessorResponse: + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. type: object - description: The metadata that represents a processor version being created. - GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: - type: object - description: Metrics across multiple confidence levels. - id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + properties: {} + id: GoogleCloudDocumentaiV1EnableProcessorResponse + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock: properties: - metricsType: - type: string - enumDescriptions: - - >- - The metrics type is unspecified. By default, metrics without a - particular specification are for leaf entity types (i.e., - top-level entity types without child types, or child types which - are not parent types themselves). - - >- - Indicates whether metrics for this particular label type represent - an aggregate of metrics for other types instead of being based on - actual TP/FP/FN values for the label type. Metrics for parent - (i.e., non-leaf) entity types are an aggregate of metrics for - their children. - enum: - - METRICS_TYPE_UNSPECIFIED - - AGGREGATE - description: The metrics type for the label. - auprcExact: - description: >- - The AUPRC for metrics with fuzzy matching disabled, i.e., exact - matching only. - type: number - format: float - confidenceLevelMetrics: - description: Metrics across confidence levels with fuzzy matching enabled. + bodyRows: type: array + description: Body rows containing main table content. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - estimatedCalibrationError: - description: >- - The Estimated Calibration Error (ECE) of the confidence of the - predicted entities. - format: float - type: number - confidenceLevelMetricsExact: - type: array - description: Metrics across confidence levels with only exact matching. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + caption: + description: Table caption/title. + type: string + headerRows: + description: Header rows at the top of the table. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - auprc: - type: number - description: >- - The calculated area under the precision recall curve (AUPRC), - computed by integrating over all confidence thresholds. - format: float - estimatedCalibrationErrorExact: - format: float - description: >- - The ECE for the predicted entities with fuzzy matching disabled, - i.e., exact matching only. - type: number - GoogleCloudDocumentaiV1DocumentSchemaEntityType: - properties: - enumValues: - description: >- - If specified, lists all the possible values for this entity. This - should not be more than a handful of values. If the number of values - is >10 or could change frequently use the - `EntityType.value_ontology` field and specify a list of all possible - values in a value ontology file. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - baseTypes: - items: - type: string - description: >- - The entity type that this type is derived from. For now, one and - only one should be set. - type: array - properties: - description: Description the nested structure, or composition of an entity. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - name: + type: object + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + description: Represents a table type block. + GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: + type: object + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + description: Request message for the SetDefaultProcessorVersion method. + properties: + defaultProcessorVersion: type: string description: >- - Name of the type. It must be unique within the schema file and - cannot be a "Common Type". The following naming conventions are - used: - Use `snake_casing`. - Name matching is case-sensitive. - - Maximum 64 characters. - Must start with a letter. - Allowed - characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility - internal infrastructure and tooling can handle any ascii character.) - - The `/` is sometimes used to denote a property of a type. For - example `line_item/amount`. This convention is deprecated, but will - still be honored for backward compatibility. - displayName: + Required. The resource name of child ProcessorVersion to use as + default. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader: + description: Represents the page header associated with the chunk. + properties: + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the header. + text: + description: Header in text format. type: string - description: User defined name for the type. - type: object - description: >- - EntityType is the wrapper of a label of the corresponding model with - detailed attributes and limitations for entity-based processors. - Multiple types can also compose a dependency tree to represent nested - types. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityType - GoogleCloudDocumentaiV1BatchProcessResponse: - id: GoogleCloudDocumentaiV1BatchProcessResponse type: object - properties: {} - description: Response message for BatchProcessDocuments. - GoogleCloudDocumentaiV1DocumentEntityRelation: + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse: + description: Response message associated with the ExportProcessorVersion operation. + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse type: object properties: - objectId: - description: Object entity id. - type: string - subjectId: - type: string - description: Subject entity id. - relation: + gcsUri: + description: The Cloud Storage URI containing the output artifacts. type: string - description: Relationship description. - description: Relationship between Entities. - id: GoogleCloudDocumentaiV1DocumentEntityRelation - GoogleCloudDocumentaiV1BatchProcessMetadata: + GoogleLongrunningListOperationsResponse: + description: The response message for Operations.ListOperations. + type: object properties: - state: + nextPageToken: type: string - description: The state of the current batch processing. - enum: - - STATE_UNSPECIFIED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLING - - CANCELLED - - FAILED - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was being cancelled. - - The batch processing was cancelled. - - The batch processing has failed. - stateMessage: + description: The standard List next-page token. + operations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - type: string - updateTime: - description: The last update time of the operation. - format: google-datetime - type: string - individualProcessStatuses: + A list of operations that matches the specified filter in the + request. + id: GoogleLongrunningListOperationsResponse + GoogleCloudDocumentaiV1FetchProcessorTypesResponse: + type: object + description: Response message for the FetchProcessorTypes method. + id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse + properties: + processorTypes: type: array + description: The list of processor types. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus - description: The list of response details of each document. - createTime: - format: google-datetime - type: string - description: The creation time of the operation. - id: GoogleCloudDocumentaiV1BatchProcessMetadata + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' + GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. + type: object + properties: {} + GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: type: object - description: The long-running operation metadata for BatchProcessDocuments. - GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata: properties: commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata - type: object - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: - type: object description: >- - The long-running operation metadata for the SetDefaultProcessorVersion + The long-running operation metadata for the DeleteProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata + id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata: properties: + splitExportStats: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + type: array + description: The list of statistics for each dataset split type. + individualExportStatuses: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + description: The list of response details of each document. commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1BoundingPoly: + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata type: object - id: GoogleCloudDocumentaiV1BoundingPoly - description: A bounding polygon for the detected image annotation. + description: Metadata of the batch export documents operation. + GoogleCloudDocumentaiV1DocumentSchema: properties: - normalizedVertices: + entityTypes: type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1NormalizedVertex' - description: The bounding polygon normalized vertices. - vertices: - description: The bounding polygon vertices. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Vertex' - type: array - GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage: - description: Detected language for a structural component. - properties: - confidence: - description: Confidence of detected language. Range `[0, 1]`. - type: number - format: float - languageCode: - description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. - type: string - id: GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - type: object - GoogleCloudDocumentaiV1beta2DocumentPageTable: - type: object - id: GoogleCloudDocumentaiV1beta2DocumentPageTable - description: A table representation similar to HTML table structure. - properties: - headerRows: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow - description: Header rows of the table. - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - description: The history of this table. - layout: - description: Layout for Table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - bodyRows: - type: array - description: Body rows of the table. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - type: array - GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata: - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata - type: object - GoogleCloudDocumentaiV1DocumentStyleFontSize: + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType + description: Entity types of the schema. + displayName: + type: string + description: Display name to show to users. + description: + type: string + description: Description of the schema. + metadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' + description: Metadata of the schema. + description: The schema defines the output of the processed document by a processor. + id: GoogleCloudDocumentaiV1DocumentSchema type: object + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult: + description: >- + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. properties: - size: - type: number - description: Font size for the text. - format: float - unit: - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). + status: + description: The validation status of import config. + $ref: '#/components/schemas/GoogleRpcStatus' + inputGcsSource: + description: The source Cloud Storage URI specified in the import config. type: string - description: Font size with unit. - id: GoogleCloudDocumentaiV1DocumentStyleFontSize - GoogleCloudDocumentaiV1beta3CommonOperationMetadata: - id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The common metadata for long running operations. type: object + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult + GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata properties: - createTime: - type: string - description: The creation time of the operation. - format: google-datetime - resource: - type: string - description: A related resource to this operation. - updateTime: - type: string - format: google-datetime - description: The last update time of the operation. - state: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + type: object + description: >- + The long-running operation metadata for the DeleteProcessorVersion + method. + GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus: + properties: + humanReviewStatus: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + description: The status of human review on the processed document. + status: + description: The status processing the document. + $ref: '#/components/schemas/GoogleRpcStatus' + outputGcsDestination: type: string - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - description: The state of the operation. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - stateMessage: description: >- - A message providing more details about the current state of - processing. - type: string - GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage: - id: GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - properties: - confidence: - type: number - format: float - description: Confidence of detected language. Range `[0, 1]`. - languageCode: + The Cloud Storage output destination (in the request as + DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed + document if it was successful, otherwise empty. + inputGcsSource: description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. + The source of the document, same as the input_gcs_source field in + the request when the batch process started. type: string + id: GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + description: The status of a each individual document in the batch process. type: object - description: Detected language for a structural component. - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: - description: Response of the EvaluateProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: + properties: {} + type: object + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse + description: The response proto of AutoLabelDocuments method. + GoogleCloudDocumentaiV1ListProcessorVersionsResponse: properties: - evaluation: - description: The resource name of the created evaluation. + processorVersions: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + description: The list of processors. + type: array + nextPageToken: type: string + description: Points to the next processor, otherwise empty. + description: Response message for the ListProcessorVersions method. + id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse type: object - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse - GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect: - id: GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect - description: Image Quality Defects + GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: + properties: + pages: + description: Optional. Indices of the pages (starting from 1). + items: + format: int32 + type: integer + type: array type: object + description: A list of individual page numbers. + id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: + description: Defines the a list of enum values. + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues properties: - confidence: - description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - format: float - type: number - type: - type: string - description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` - GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: - properties: {} - description: The response proto of ExportDocuments method. + values: + type: array + description: The individual values that this enum values type can include. + items: + type: string type: object - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse - GoogleCloudDocumentaiV1beta1DocumentPageSymbol: - description: A detected symbol. + GoogleCloudDocumentaiV1DocumentPageSymbol: type: object + id: GoogleCloudDocumentaiV1DocumentPageSymbol + description: A detected symbol. properties: layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' description: Layout for Symbol. detectedLanguages: description: A list of detected languages together with confidence. - type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - id: GoogleCloudDocumentaiV1beta1DocumentPageSymbol - GoogleTypePostalAddress: - type: object - description: >- - Represents a postal address, e.g. for postal delivery or payments - addresses. Given a postal address, a postal service can deliver items to - a premise, P.O. Box or similar. It is not intended to model geographical - locations (roads, towns, mountains). In typical usage an address would - be created via user input or from importing existing data, depending on - the type of process. Advice on address input / editing: - Use an - internationalization-ready address widget such as - https://github.com/google/libaddressinput) - Users should not be - presented with UI elements for input or editing of fields outside - countries where that field is used. For more guidance on how to use this - schema, please see: https://support.google.com/business/answer/6397478 - id: GoogleTypePostalAddress + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk: properties: - organization: - type: string - description: Optional. The name of the organization at the address. - sortingCode: + chunkId: + description: ID of the chunk. type: string - description: >- - Optional. Additional, country-specific, sorting code. This is not - used in most regions. Where it is used, the value is either a string - like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or - just a number alone, representing the "sector code" (Jamaica), - "delivery area indicator" (Malawi) or "post office indicator" (e.g. - Côte d'Ivoire). - administrativeArea: - description: >- - Optional. Highest administrative subdivision which is used for - postal addresses of a country or region. For example, this can be a - state, a province, an oblast, or a prefecture. Specifically, for - Spain this is the province and not the autonomous community (e.g. - "Barcelona" and not "Catalonia"). Many countries don't use an - administrative area in postal addresses. E.g. in Switzerland this - should be left unpopulated. + sourceBlockIds: + items: + type: string + type: array + description: Unused. + content: type: string - addressLines: + description: Text content of the chunk. + pageFooters: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter + description: Page footers associated with the chunk. type: array - description: >- - Unstructured address lines describing the lower levels of an - address. Because values in address_lines do not have type - information and may sometimes contain multiple values in a single - field (e.g. "Austin, TX"), it is important that the line order is - clear. The order of address lines should be "envelope order" for the - country/region of the address. In places where this can vary (e.g. - Japan), address_language is used to make it explicit (e.g. "ja" for - large-to-small ordering and "ja-Latn" or "en" for small-to-large). - This way, the most specific line of an address can be selected based - on the language. The minimum permitted structural representation of - an address consists of a region_code with all remaining information - placed in the address_lines. It would be possible to format such an - address very approximately without geocoding, but no semantic - reasoning could be made about any of the address components until it - was at least partially resolved. Creating an address only containing - a region_code and address_lines, and then geocoding is the - recommended way to handle completely unstructured addresses (as - opposed to guessing which parts of the address should be localities - or administrative areas). + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Page span of the chunk. + pageHeaders: items: - type: string - locality: - description: >- - Optional. Generally refers to the city/town portion of the address. - Examples: US city, IT comune, UK post town. In regions of the world - where localities are not well defined or do not fit into this - structure well, leave locality empty and use address_lines. - type: string - revision: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader + type: array + description: Page headers associated with the chunk. + type: object + description: Represents a chunk. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk + GoogleCloudDocumentaiV1DocumentPageTableTableCell: + id: GoogleCloudDocumentaiV1DocumentPageTableTableCell + description: A cell representation inside the table. + properties: + detectedLanguages: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + description: A list of detected languages together with confidence. + colSpan: + type: integer + description: How many columns this cell spans. + format: int32 + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for TableCell. + rowSpan: format: int32 type: integer + description: How many rows this cell spans. + type: object + GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: + id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + type: object + description: Evaluations metrics, at a specific confidence level. + properties: + metrics: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + description: The metrics at the specific confidence level. + confidenceLevel: + format: float + type: number + description: The confidence level. + GoogleCloudDocumentaiV1DocumentSchemaEntityType: + properties: + enumValues: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues description: >- - The schema revision of the `PostalAddress`. This must be set to 0, - which is the latest revision. All new revisions **must** be backward - compatible with old revisions. - recipients: - description: >- - Optional. The recipient at the address. This field may, under - certain circumstances, contain multiline information. For example, - it might contain "care of" information. + If specified, lists all the possible values for this entity. This + should not be more than a handful of values. If the number of values + is >10 or could change frequently use the + `EntityType.value_ontology` field and specify a list of all possible + values in a value ontology file. + properties: type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + description: Description the nested structure, or composition of an entity. + baseTypes: items: type: string - regionCode: + type: array description: >- - Required. CLDR region code of the country/region of the address. - This is never inferred and it is up to the user to ensure the value - is correct. See https://cldr.unicode.org/ and - https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - for details. Example: "CH" for Switzerland. + The entity type that this type is derived from. For now, one and + only one should be set. + displayName: + description: User defined name for the type. type: string - languageCode: + name: type: string description: >- - Optional. BCP-47 language code of the contents of this address (if - known). This is often the UI language of the input form or is - expected to match one of the languages used in the address' - country/region, or their transliterated equivalents. This can affect - formatting in certain countries, but is not critical to the - correctness of the data and will never affect any validation or - other non-formatting related operations. If this value is not known, - it should be omitted (rather than specifying a possibly incorrect - default). Examples: "zh-Hant", "ja", "ja-Latn", "en". - sublocality: - type: string + Name of the type. It must be unique within the schema file and + cannot be a "Common Type". The following naming conventions are + used: - Use `snake_casing`. - Name matching is case-sensitive. - + Maximum 64 characters. - Must start with a letter. - Allowed + characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility + internal infrastructure and tooling can handle any ascii character.) + - The `/` is sometimes used to denote a property of a type. For + example `line_item/amount`. This convention is deprecated, but will + still be honored for backward compatibility. + id: GoogleCloudDocumentaiV1DocumentSchemaEntityType + type: object + description: >- + EntityType is the wrapper of a label of the corresponding model with + detailed attributes and limitations for entity-based processors. + Multiple types can also compose a dependency tree to represent nested + types. + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse: + type: object + properties: {} + description: Response message for the UndeployProcessorVersion method. + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse + GoogleCloudDocumentaiV1ReviewDocumentRequest: + type: object + description: Request message for the ReviewDocument method. + id: GoogleCloudDocumentaiV1ReviewDocumentRequest + properties: + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: The document schema of the human review task. + enableSchemaValidation: + type: boolean description: >- - Optional. Sublocality of the address. For example, this can be - neighborhoods, boroughs, districts. - postalCode: + Whether the validation should be performed on the ad-hoc review + request. + priority: + description: The priority of the human review task. type: string - description: >- - Optional. Postal code of the address. Not all countries use or - require postal codes to be present, but where they are used, they - may trigger additional validation with other parts of the address - (e.g. state/zip validation in the U.S.A.). - GoogleCloudDocumentaiV1beta1DocumentPageParagraph: + enumDescriptions: + - The default priority level. + - >- + The urgent priority level. The labeling manager should allocate + labeler resource to the urgent task queue to respect this priority + level. + enum: + - DEFAULT + - URGENT + inlineDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' + description: An inline document proto. + GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. + id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata + properties: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + type: object + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse: + properties: {} + description: Response of the batch update documents operation. + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsResponse + type: object + GoogleCloudDocumentaiV1GcsPrefix: + description: Specifies all documents on Cloud Storage with a common prefix. + id: GoogleCloudDocumentaiV1GcsPrefix + properties: + gcsUriPrefix: + type: string + description: The URI prefix. + type: object + GoogleCloudDocumentaiV1DocumentPageTable: type: object - description: A collection of lines that a human would perceive as a paragraph. properties: + layout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + description: Layout for Table. detectedLanguages: + type: array description: A list of detected languages together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + bodyRows: type: array - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Paragraph. + description: Body rows of the table. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this table. deprecated: true - id: GoogleCloudDocumentaiV1beta1DocumentPageParagraph - GoogleCloudDocumentaiV1beta2NormalizedVertex: - properties: - x: - format: float - description: X coordinate. - type: number - 'y': - type: number - format: float - description: Y coordinate (starts from the top of the image). + headerRows: + type: array + description: Header rows of the table. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableRow + id: GoogleCloudDocumentaiV1DocumentPageTable + description: A table representation similar to HTML table structure. + GoogleTypeDate: + id: GoogleTypeDate type: object description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - id: GoogleCloudDocumentaiV1beta2NormalizedVertex - GoogleCloudDocumentaiV1DocumentSchemaMetadata: - id: GoogleCloudDocumentaiV1DocumentSchemaMetadata - type: object + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp properties: - documentSplitter: - type: boolean - description: >- - If true, a `document` entity type can be applied to subdocument - (splitting). Otherwise, it can only be applied to the entire - document (classification). - skipNamingValidation: + day: + format: int32 + type: integer description: >- - If set, we will skip the naming format validation in the schema. So - the string values in `DocumentSchema.EntityType.name` and - `DocumentSchema.EntityType.Property.name` will not be checked. - type: boolean - prefixedNamingOnProperties: - description: If set, all the nested entities must be prefixed with the parents. - type: boolean - documentAllowMultipleLabels: - type: boolean + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + year: + type: integer + format: int32 description: >- - If true, on a given page, there can be multiple `document` - annotations covering it. - description: Metadata for global schema behavior. - GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: - id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The long-running operation metadata for DeleteLabelerPool. - GoogleCloudDocumentaiV1DocumentProvenance: - type: object - properties: - revision: - type: integer - deprecated: true - description: The index of the revision that produced this element. - format: int32 - type: - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - description: The type of provenance operation. - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - type: string - id: + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + month: format: int32 - deprecated: true - description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. type: integer - parents: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent - description: References to the original elements that are replaced. - id: GoogleCloudDocumentaiV1DocumentProvenance - description: >- - Structure to identify provenance relationships between annotations in - different revisions. - GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: - description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. - type: object - id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - properties: - cwDocId: - description: Id of the document (indexed) managed by Content Warehouse. - deprecated: true - type: string - gcsUri: - description: Required. The Cloud Storage URI where the actual document is stored. - type: string - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: - type: object - description: Response message for the SetDefaultProcessorVersion method. - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse - properties: {} - GoogleCloudDocumentaiV1beta2DocumentEntity: - description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - id: GoogleCloudDocumentaiV1beta2DocumentEntity - type: object - properties: - mentionText: - type: string - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - mentionId: - type: string - description: Optional. Deprecated. Use `id` field instead. - textAnchor: - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - redacted: - type: boolean - description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - normalizedValue: - description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue - type: - type: string - description: Required. Entity type from a schema e.g. `Address`. - confidence: - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - format: float - type: number - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageAnchor' - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - properties: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentEntity' - description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - type: array - id: description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - type: string - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - description: Optional. The history of this annotation. - GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata: - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - type: object - description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - id: GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata - GoogleCloudDocumentaiV1DeployProcessorVersionResponse: - properties: {} - id: GoogleCloudDocumentaiV1DeployProcessorVersionResponse - type: object - description: Response message for the DeployProcessorVersion method. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: - description: The status of each individual document in the batch move process. - type: object - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of moving the document. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan: id: >- - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - GoogleCloudDocumentaiV1DocumentPageImage: + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + description: Represents where the block starts and ends in the document. + type: object properties: - height: - format: int32 - description: Height of the image in pixels. - type: integer - content: - description: Raw byte content of the image. - format: byte - type: string - mimeType: - type: string - description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - width: - description: Width of the image in pixels. + pageEnd: type: integer format: int32 - description: Rendered image contents for this page. - id: GoogleCloudDocumentaiV1DocumentPageImage - type: object + description: Page where block ends in the document. + pageStart: + description: Page where block starts in the document. + format: int32 + type: integer GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse: id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse - description: Response of the sample documents operation. + type: object properties: sampleTrainingStatus: + $ref: '#/components/schemas/GoogleRpcStatus' description: The status of sampling documents in training split. + sampleTestStatus: $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of sampling documents in test split. selectedDocuments: type: array description: The result of the sampling process. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument - sampleTestStatus: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of sampling documents in test split. + description: Response of the sample documents operation. + GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: type: object - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: + description: Response message for the UndeployProcessorVersion method. + id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse + properties: {} + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: type: object - id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata properties: - errorDocumentCount: - type: integer - description: Total number of documents that failed to be deleted in storage. - format: int32 - totalDocumentCount: - format: int32 - description: Total number of documents deleting from dataset. - type: integer commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata + properties: + commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - individualBatchDeleteStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - description: The list of response details of each document. - GoogleCloudDocumentaiV1beta1DocumentPageTable: + description: The basic metadata for the long-running operation. + type: object + description: >- + The long-running operation metadata for the ImportProcessorVersion + method. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock: + description: >- + Represents a block. A block could be one of the various types (text, + table, list) supported. + id: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock properties: - layout: - description: Layout for Table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - type: array - provenance: - description: The history of this table. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - deprecated: true - bodyRows: - type: array - description: Body rows of the table. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow - headerRows: - description: Header rows of the table. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow - type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageTable - description: A table representation similar to HTML table structure. - GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment: - description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset - type: object - id: GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment - properties: - startIndex: - format: int64 - description: TextSegment start UTF-8 char index in the Document.text. - type: string - endIndex: - description: TextSegment half open end UTF-8 char index in the Document.text. - format: int64 + tableBlock: + description: Block consisting of table content/structure. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock + textBlock: + description: Block consisting of text content. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock + listBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + description: Block consisting of list content/structure. + pageSpan: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan + description: Page span of the block. + blockId: type: string - GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: + description: ID of the block. type: object - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. + GoogleCloudDocumentaiV1ProcessResponse: + type: object + description: Response message for the ProcessDocument method. properties: - datasetErrors: - description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - documentErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' + humanReviewStatus: + description: The status of human review on the processed document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' + document: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - type: array - documentErrorCount: - type: integer - description: The total number of document errors. - format: int32 - datasetErrorCount: - type: integer - format: int32 - description: The total number of dataset errors. - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - GoogleCloudDocumentaiV1Evaluation: + The document payload, will populate fields based on the processor's + behavior. + id: GoogleCloudDocumentaiV1ProcessResponse + GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo: + description: Information about the upcoming deprecation of this processor version. + type: object + id: GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo properties: - createTime: + replacementProcessorVersion: type: string - description: The time that the evaluation was created. + description: If set, the processor version that will be used as a replacement. + deprecationTime: format: google-datetime - allEntitiesMetrics: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - description: Metrics for all the entities in aggregate. - entityMetrics: - type: object - description: Metrics across confidence levels, for different entities. - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics - documentCounters: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationCounters' - description: Counters for the documents used in the evaluation. - kmsKeyVersionName: - type: string - description: The KMS key version with which data is encrypted. - kmsKeyName: - description: The KMS key name used for encryption. + description: The time at which this processor version will be deprecated. type: string - name: + GoogleCloudDocumentaiV1beta3HumanReviewStatus: + properties: + humanReviewOperation: description: >- - The resource name of the evaluation. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` + The name of the operation triggered by the processed document. This + field is populated only when the state is + `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + metadata as the long-running operation returned by ReviewDocument. type: string - description: An evaluation of a ProcessorVersion's performance. - id: GoogleCloudDocumentaiV1Evaluation - type: object - GoogleCloudDocumentaiV1DocumentPageVisualElement: - id: GoogleCloudDocumentaiV1DocumentPageVisualElement - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - properties: - type: - description: Type of the VisualElement. + stateMessage: + description: A message providing more details about the human review state. type: string - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for VisualElement. - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array + state: + enumDescriptions: + - >- + Human review state is unspecified. Most likely due to an internal + error. + - >- + Human review is skipped for the document. This can happen because + human review isn't enabled on the processor or the processing + request has been set to skip this document. + - >- + Human review validation is triggered and passed, so no review is + needed. + - >- + Human review validation is triggered and the document is under + review. + - >- + Some error happened during triggering human review, see the + state_message for details. + enum: + - STATE_UNSPECIFIED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR + description: The state of human review on the processing request. + type: string + description: The status of human review on a processed document. + id: GoogleCloudDocumentaiV1beta3HumanReviewStatus type: object - GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: + GoogleCloudDocumentaiV1beta3Dataset: type: object description: >- - The long-running operation metadata for the UndeployProcessorVersion - method. - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata - GoogleCloudDocumentaiV1beta1DocumentPage: - description: A page in a Document. - id: GoogleCloudDocumentaiV1beta1DocumentPage + A singleton resource under a Processor which configures a collection of + documents. + id: GoogleCloudDocumentaiV1beta3Dataset properties: - visualElements: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageVisualElement + name: description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - image: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImage' + Dataset resource name. Format: + `projects/{project}/locations/{location}/processors/{processor}/dataset` + type: string + state: + enumDescriptions: + - Default unspecified enum, should not be used. + - Dataset has not been initialized. + - Dataset is being initialized. + - Dataset has been initialized. + enum: + - STATE_UNSPECIFIED + - UNINITIALIZED + - INITIALIZING + - INITIALIZED + description: Required. State of the dataset. Ignored when updating dataset. + type: string + spannerIndexingConfig: description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - imageQualityScores: - description: Image quality scores. + Optional. A lightweight indexing source with low latency and high + reliability, but lacking advanced features like CMEK and + content-based search. $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores - formFields: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageFormField - type: array - description: A list of visually detected form fields on the page. - tokens: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageToken' - description: A list of visually detected tokens on the page. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for the page. - tables: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTable' - description: A list of visually detected tables on the page. - symbols: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageSymbol - description: A list of visually detected symbols on the page. - type: array - pageNumber: + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig + satisfiesPzi: + description: Output only. Reserved for future use. + readOnly: true + type: boolean + documentWarehouseConfig: + deprecated: true + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - format: int32 - type: integer - dimension: - description: Physical dimension of the page. + Optional. Deprecated. Warehouse-based dataset configuration is not + supported. + satisfiesPzs: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + unmanagedDatasetConfig: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDimension - paragraphs: + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageParagraph - type: array - transforms: + Optional. Unmanaged dataset configuration. Use this configuration if + the dataset documents are managed by the document service internally + (not user-managed). + gcsManagedConfig: description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageMatrix - type: array - detectedBarcodes: - type: array - description: A list of detected barcodes. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode - lines: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLine' - type: array + Optional. User-managed Cloud Storage dataset configuration. Use this + configuration if the dataset documents are stored under a + user-managed Cloud Storage location. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + GoogleCloudLocationLocation: + description: A resource that represents a Google Cloud location. + id: GoogleCloudLocationLocation + properties: + displayName: + type: string description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - description: The history of this page. - blocks: + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + locationId: + type: string + description: 'The canonical id for this location. For example: `"us-east1"`.' + metadata: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageBlock' - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - type: array - type: object - GoogleCloudDocumentaiV1FetchProcessorTypesResponse: - properties: - processorTypes: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - description: The list of processor types. - id: GoogleCloudDocumentaiV1FetchProcessorTypesResponse - description: Response message for the FetchProcessorTypes method. - type: object - GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode: - type: object - description: A detected barcode. - id: GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode - properties: - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2Barcode' - description: Detailed barcode information of the DetectedBarcode. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for DetectedBarcode. - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: + Service-specific metadata. For example the available capacity at the + given location. + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + labels: + additionalProperties: + type: string + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object type: object - description: Response message for the DeployProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse - properties: {} - GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow: - description: A row of table cells. - id: GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig: + description: The configuration used when outputting documents. + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig properties: - cells: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell - description: Cells that make up this row. - type: array + shardingConfig: + description: Specifies the sharding config for the output document. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + gcsUri: + description: The Cloud Storage uri (a directory) of the output. + type: string + fieldMask: + description: >- + Specifies which fields to include in the output documents. Only + supports top level document and pages field so it must be in the + form of `{document_field_name}` or `pages.{page_field_name}`. + format: google-fieldmask + type: string type: object - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus: - description: The status of each individual document in the export process. + GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: type: object - id: >- - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataIndividualExportStatus + id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + description: Response message for the ReviewDocument method. properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the exporting of the document. - outputGcsDestination: + gcsDestination: + type: string description: >- - The output_gcs_destination of the exported document if it was - successful, otherwise empty. + The Cloud Storage uri for the human reviewed document if the review + is succeeded. + state: + description: The state of the review operation. type: string - documentId: - description: The path to source docproto of the document. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: + enumDescriptions: + - The default value. This value is used if the state is omitted. + - The review operation is rejected by the reviewer. + - The review operation is succeeded. + enum: + - STATE_UNSPECIFIED + - REJECTED + - SUCCEEDED + rejectionReason: + type: string + description: The reason why the review is rejected by reviewer. + GoogleCloudDocumentaiV1EnableProcessorMetadata: + description: The long-running operation metadata for the EnableProcessor method. + type: object properties: commonMetadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata - description: >- - The long-running operation metadata for the SetDefaultProcessorVersion - method. - type: object - GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: - description: >- - Identifies a document uniquely within the scope of a dataset in the - user-managed Cloud Storage option. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + id: GoogleCloudDocumentaiV1EnableProcessorMetadata + GoogleCloudDocumentaiV1DisableProcessorMetadata: properties: - cwDocId: - deprecated: true - description: Id of the document (indexed) managed by Content Warehouse. - type: string - gcsUri: - type: string - description: Required. The Cloud Storage URI where the actual document is stored. - id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - type: object - GoogleCloudDocumentaiV1beta3DocumentId: - description: Document Identifier. - id: GoogleCloudDocumentaiV1beta3DocumentId + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' type: object + id: GoogleCloudDocumentaiV1DisableProcessorMetadata + description: The long-running operation metadata for the DisableProcessor method. + GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + description: The input data used to train a new ProcessorVersion. properties: - revisionRef: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3RevisionRef' - description: Points to a specific revision of the document if set. - unmanagedDocId: - description: A document id within unmanaged dataset. + testDocuments: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId - gcsManagedDocId: - description: A document id within user-managed Cloud Storage. + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The documents used for testing the trained version. + trainingDocuments: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId - GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector: - properties: - pages: - items: - format: int32 - type: integer - type: array - description: Optional. Indices of the pages (starting from 1). - id: GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector - type: object - description: A list of individual page numbers. - GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse: - properties: {} - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig + description: The documents used for training the new version. type: object - description: The response proto of ResyncDataset method. - GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo: - id: GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo + GoogleLongrunningOperation: type: object + description: >- + This resource represents a long-running operation that is the result of + a network API call. properties: - subscript: - type: boolean - description: Whether the text is a subscript. This feature is not supported yet. - smallcaps: - type: boolean - description: >- - Whether the text is in small caps. This feature is not supported - yet. - superscript: - type: boolean + response: description: >- - Whether the text is a superscript. This feature is not supported - yet. - letterSpacing: - description: Letter spacing in points. - format: double - type: number - handwritten: - type: boolean - description: Whether the text is handwritten. - underlined: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + done: type: boolean - description: Whether the text is underlined. - fontType: - description: Name or style of the font. - type: string - fontWeight: - type: integer - format: int32 description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - strikeout: - type: boolean + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + metadata: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - Whether the text is strikethrough. This feature is not supported - yet. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - fontSize: - type: integer - format: int32 - description: Font size in points (`1` point is `¹⁄₇₂` inches). - bold: - type: boolean + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + name: description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - italic: - type: boolean - description: Whether the text is italic. - pixelFontSize: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + error: description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - format: double - type: number - description: Font and other text style attributes. - GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak: + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + id: GoogleLongrunningOperation + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter: properties: - type: - description: Detected break type. - enum: - - TYPE_UNSPECIFIED - - SPACE - - WIDE_SPACE - - HYPHEN + text: + description: Footer in text format. type: string - enumDescriptions: - - Unspecified break type. - - A single whitespace. - - A wider whitespace. - - A hyphen that indicates that a token has been split across lines. - description: Detected break at the end of a Token. + pageSpan: + description: Page span of the footer. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + description: Represents the page footer associated with the chunk. + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter type: object - id: GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - GoogleCloudDocumentaiV1DocumentProvenanceParent: - id: GoogleCloudDocumentaiV1DocumentProvenanceParent - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. + GoogleCloudDocumentaiV1DocumentProvenance: type: object + id: GoogleCloudDocumentaiV1DocumentProvenance + description: >- + Structure to identify provenance relationships between annotations in + different revisions. properties: - index: - type: integer + id: + deprecated: true format: int32 description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent + The Id of this operation. Needs to be unique within the scope of the revision. + type: integer + type: + enumDescriptions: + - >- + Operation type unspecified. If no operation is specified a + provenance entry is simply used to match against a `parent`. + - Add an element. + - Remove an element identified by `parent`. + - >- + Updates any fields within the given provenance scope of the + message. It overwrites the fields rather than replacing them. Use + this when you want to update a field value of an entity without + also updating all the child properties. + - Currently unused. Replace an element identified by `parent`. + - >- + Deprecated. Request human review for the element identified by + `parent`. + - >- + Deprecated. Element is reviewed and approved at human review, + confidence will be set to 1.0. + - Deprecated. Element is skipped in the validation process. + enumDeprecated: + - false + - false + - false + - false + - false + - true + - true + - true + description: The type of provenance operation. + enum: + - OPERATION_TYPE_UNSPECIFIED + - ADD + - REMOVE + - UPDATE + - REPLACE + - EVAL_REQUESTED + - EVAL_APPROVED + - EVAL_SKIPPED + type: string revision: + description: The index of the revision that produced this element. format: int32 type: integer - description: The index of the index into current revision's parent_ids list. - id: - type: integer - format: int32 - description: The id of the parent provenance. deprecated: true - GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata - description: Metadata of the sample documents operation. - type: object - GoogleCloudDocumentaiV1DocumentPageMatrix: + parents: + type: array + description: References to the original elements that are replaced. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentProvenanceParent + GoogleCloudDocumentaiV1TrainProcessorVersionRequest: + description: Request message for the TrainProcessorVersion method. properties: - cols: - format: int32 - type: integer - description: Number of columns in the matrix. - type: - format: int32 - type: integer - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - data: + processorVersion: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + description: Required. The processor version to be created. + baseProcessorVersion: type: string - description: The matrix data. - format: byte - rows: - format: int32 - description: Number of rows in the matrix. - type: integer - id: GoogleCloudDocumentaiV1DocumentPageMatrix - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. + description: >- + Optional. The processor version to use as a base for training. This + processor version must be a child of `parent`. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. + inputData: + description: Optional. The input data used to train the ProcessorVersion. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData + customDocumentExtractionOptions: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + description: Options to control Custom Document Extraction (CDE) Processor. + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: Optional. The schema the processor version will be trained with. + foundationModelTuningOptions: + description: Options to control foundation model tuning of a processor. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions type: object - GoogleCloudDocumentaiV1beta2InputConfig: + id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest + GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: + description: Configuration specific to an unmanaged dataset. type: object + id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig + properties: {} + GoogleCloudDocumentaiV1Processor: + id: GoogleCloudDocumentaiV1Processor properties: - contents: - format: byte + state: + enumDescriptions: + - The processor is in an unspecified state. + - >- + The processor is enabled, i.e., has an enabled version which can + currently serve processing requests and all the feature + dependencies have been successfully initialized. + - The processor is disabled. + - >- + The processor is being enabled, will become `ENABLED` if + successful. + - >- + The processor is being disabled, will become `DISABLED` if + successful. + - >- + The processor is being created, will become either `ENABLED` (for + successful creation) or `FAILED` (for failed ones). Once a + processor is in this state, it can then be used for document + processing, but the feature dependencies of the processor might + not be fully created yet. + - >- + The processor failed during creation or initialization of feature + dependencies. The user should delete the processor and recreate + one as all the functionalities of the processor are disabled. + - The processor is being deleted, will be removed if successful. + readOnly: true + description: Output only. The state of the processor. + enum: + - STATE_UNSPECIFIED + - ENABLED + - DISABLED + - ENABLING + - DISABLING + - CREATING + - FAILED + - DELETING type: string - description: >- - Content in bytes, represented as a stream of bytes. Note: As with - all `bytes` fields, proto buffer messages use a pure binary - representation, whereas JSON representations use base64. This field - only works for synchronous ProcessDocument method. - gcsSource: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2GcsSource' - description: >- - The Google Cloud Storage location to read the input from. This must - be a single file. - mimeType: + createTime: + description: The time the processor was created. + format: google-datetime type: string - description: >- - Required. Mimetype of the input. Current supported mimetypes are - application/pdf, image/tiff, and image/gif. In addition, - application/json type is supported for requests with - ProcessDocumentRequest.automl_params field set. The JSON file needs - to be in Document format. - description: The desired input location and metadata. - id: GoogleCloudDocumentaiV1beta2InputConfig - GoogleCloudDocumentaiV1beta3RevisionRef: - properties: - revisionCase: - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION + defaultProcessorVersion: + description: The default processor version. type: string - enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. - description: Reads the revision by the predefined case. - latestProcessorVersion: + processorVersionAliases: + description: Output only. The processor version aliases. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' + readOnly: true + type: array + satisfiesPzs: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + displayName: + description: The display name of the processor. type: string + processEndpoint: + readOnly: true description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - revisionId: - description: Reads the revision given by the id. + Output only. Immutable. The http endpoint that can be called to + invoke processing. type: string - id: GoogleCloudDocumentaiV1beta3RevisionRef - description: The revision reference specifies which revision on the document to read. + kmsKeyName: + type: string + description: >- + The [KMS key](https://cloud.google.com/security-key-management) used + for encryption and decryption in CMEK scenarios. + satisfiesPzi: + description: Output only. Reserved for future use. + type: boolean + readOnly: true + name: + readOnly: true + description: >- + Output only. Immutable. The resource name of the processor. Format: + `projects/{project}/locations/{location}/processors/{processor}` + type: string + type: + type: string + description: >- + The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + To get a list of processor types, see FetchProcessorTypes. + description: >- + The first-class citizen for Document AI. Each processor defines how to + extract structural information from a document. type: object - GoogleCloudDocumentaiV1ProcessRequest: + GoogleCloudDocumentaiV1CommonOperationMetadata: properties: - fieldMask: - format: google-fieldmask - description: >- - Specifies which fields to include in the ProcessResponse.document - output. Only supports top-level document and pages field, so it must - be in the form of `{document_field_name}` or - `pages.{page_field_name}`. + resource: + description: A related resource to this operation. + type: string + state: + type: string + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + description: The state of the operation. + stateMessage: type: string - skipHumanReview: - type: boolean description: >- - Whether human review should be skipped for this request. Default to - `false`. - rawDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' - description: A raw document content (bytes). + A message providing more details about the current state of + processing. + createTime: + format: google-datetime + type: string + description: The creation time of the operation. + updateTime: + format: google-datetime + description: The last update time of the operation. + type: string + type: object + id: GoogleCloudDocumentaiV1CommonOperationMetadata + description: The common metadata for long running operations. + GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata + type: object + description: >- + The long-running operation metadata for the SetDefaultProcessorVersion + method. + properties: + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiV1ProcessRequest: + properties: labels: + type: object description: >- Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode @@ -3018,4384 +2462,2606 @@ components: letter. additionalProperties: type: string - type: object - processOptions: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - description: Inference-time options for the process API inlineDocument: $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' description: An inline document proto. + skipHumanReview: + description: >- + Whether human review should be skipped for this request. Default to + `false`. + type: boolean + fieldMask: + description: >- + Specifies which fields to include in the ProcessResponse.document + output. Only supports top-level document and pages field, so it must + be in the form of `{document_field_name}` or + `pages.{page_field_name}`. + type: string + format: google-fieldmask + rawDocument: + description: A raw document content (bytes). + $ref: '#/components/schemas/GoogleCloudDocumentaiV1RawDocument' gcsDocument: $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' description: A raw document on Google Cloud Storage. + processOptions: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' + description: Inference-time options for the process API + imagelessMode: + type: boolean + description: Optional. Option to remove images from the document. id: GoogleCloudDocumentaiV1ProcessRequest description: Request message for the ProcessDocument method. type: object - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: + GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata: + description: The long-running operation metadata for DeleteLabelerPool. + id: GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata type: object - description: Response of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse properties: - evaluation: - type: string - description: The resource name of the created evaluation. - GoogleCloudDocumentaiV1ProcessResponse: - id: GoogleCloudDocumentaiV1ProcessResponse - type: object + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo: properties: - humanReviewStatus: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1HumanReviewStatus' - description: The status of human review on the processed document. - document: + finetuningAllowed: + type: boolean + description: Whether finetuning is allowed for this base processor version. + minTrainLabeledDocuments: description: >- - The document payload, will populate fields based on the processor's - behavior. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: Response message for the ProcessDocument method. - GoogleTypeMoney: - properties: - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - nanos: - type: integer + The minimum number of labeled documents in the training dataset + required for finetuning. format: int32 - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - units: - type: string - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - format: int64 + type: integer + id: >- + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + description: Information for a pretrained Google-managed foundation model. type: object - description: Represents an amount of money with its currency type. - id: GoogleTypeMoney - GoogleCloudDocumentaiV1Barcode: - description: Encodes the detailed information of a barcode. - id: GoogleCloudDocumentaiV1Barcode + GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: + description: >- + The long-running operation metadata for the DeployProcessorVersion + method. properties: - rawValue: - type: string - description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - valueFormat: - description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - type: string - format: - type: string - description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. + commonMetadata: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata + type: object + GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: + description: The sharding config for the output document. type: object - GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse: properties: - responses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2ProcessDocumentResponse - type: array - description: Responses for each individual document. - id: GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse + pagesPerShard: + type: integer + format: int32 + description: The number of pages per shard. + pagesOverlap: + type: integer + format: int32 + description: The number of overlapping pages between consecutive shards. + id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig + GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument: + properties: + documentId: + description: An internal identifier for document. + type: string + id: GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument type: object - description: >- - Response to an batch document processing request. This is returned in - the LRO Operation after the operation is complete. - GoogleCloudDocumentaiV1beta1DocumentEntity: + GoogleCloudDocumentaiV1DocumentProvenanceParent: + id: GoogleCloudDocumentaiV1DocumentProvenanceParent type: object description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - id: GoogleCloudDocumentaiV1beta1DocumentEntity + The parent element the current element is based on. Used for + referencing/aligning, removal and replacement operations. properties: - redacted: - description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - type: boolean - normalizedValue: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue - description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. id: + deprecated: true + format: int32 + description: The id of the parent provenance. + type: integer + index: + format: int32 + type: integer description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. + The index of the parent item in the corresponding item list (eg. + list of entities, properties within entities, etc.) in the parent + revision. + revision: + type: integer + description: The index of the index into current revision's parent_ids list. + format: int32 + GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: + properties: + layoutType: + enumDescriptions: + - Layout Unspecified. + - References a Page.blocks element. + - References a Page.paragraphs element. + - References a Page.lines element. + - References a Page.tokens element. + - References a Page.visual_elements element. + - Refrrences a Page.tables element. + - References a Page.form_fields element. + description: >- + Optional. The type of the layout element that is being referenced if + any. + type: string + enum: + - LAYOUT_TYPE_UNSPECIFIED + - BLOCK + - PARAGRAPH + - LINE + - TOKEN + - VISUAL_ELEMENT + - TABLE + - FORM_FIELD + boundingPoly: + description: >- + Optional. Identifies the bounding polygon of a layout element on the + page. If `layout_type` is set, the bounding polygon must be exactly + the same to the layout element it's referring to. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + layoutId: + description: Optional. Deprecated. Use PageRef.bounding_poly instead. + type: string + deprecated: true + page: + format: int64 type: string + description: >- + Required. Index into the Document.pages element, for example using + `Document.pages` to locate the related page element. This field is + skipped when its value is the default `0`. See + https://developers.google.com/protocol-buffers/docs/proto3#json. confidence: type: number - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. format: float - type: - description: Required. Entity type from a schema e.g. `Address`. - type: string - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - mentionId: - description: Optional. Deprecated. Use `id` field instead. + Optional. Confidence of detected page element, if applicable. Range + `[0, 1]`. + type: object + description: Represents a weak reference to a page element within a document. + id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: + type: object + description: >- + Identifies a document uniquely within the scope of a dataset in + unmanaged option. + id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId + properties: + docId: + description: Required. The id of the document. type: string - properties: - type: array + GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics: + properties: + auprcExact: + format: float description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. + The AUPRC for metrics with fuzzy matching disabled, i.e., exact + matching only. + type: number + confidenceLevelMetricsExact: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntity' - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageAnchor' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + description: Metrics across confidence levels with only exact matching. + type: array + confidenceLevelMetrics: + description: Metrics across confidence levels with fuzzy matching enabled. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics + type: array + metricsType: + enumDescriptions: + - >- + The metrics type is unspecified. By default, metrics without a + particular specification are for leaf entity types (i.e., + top-level entity types without child types, or child types which + are not parent types themselves). + - >- + Indicates whether metrics for this particular label type represent + an aggregate of metrics for other types instead of being based on + actual TP/FP/FN values for the label type. Metrics for parent + (i.e., non-leaf) entity types are an aggregate of metrics for + their children. + description: The metrics type for the label. + type: string + enum: + - METRICS_TYPE_UNSPECIFIED + - AGGREGATE + auprc: + format: float description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - mentionText: - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + The calculated area under the precision recall curve (AUPRC), + computed by integrating over all confidence thresholds. + type: number + estimatedCalibrationErrorExact: + description: >- + The ECE for the predicted entities with fuzzy matching disabled, + i.e., exact matching only. + type: number + format: float + estimatedCalibrationError: + type: number + format: float + description: >- + The Estimated Calibration Error (ECE) of the confidence of the + predicted entities. + description: Metrics across multiple confidence levels. + id: GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics + type: object + GoogleCloudDocumentaiUiv1beta3RevisionRef: + description: The revision reference specifies which revision on the document to read. + id: GoogleCloudDocumentaiUiv1beta3RevisionRef + type: object + properties: + revisionId: type: string - provenance: - description: Optional. The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata: - description: >- - The long-running operation metadata for updating the human review - configuration. + description: Reads the revision given by the id. + latestProcessorVersion: + description: >- + Reads the revision generated by the processor version. The format + takes the full resource name of processor version. + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` + type: string + revisionCase: + type: string + description: Reads the revision by the predefined case. + enumDescriptions: + - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. + - The latest revision made by a human. + - The latest revision based on timestamp. + - The first (OCR) revision. + enum: + - REVISION_CASE_UNSPECIFIED + - LATEST_HUMAN_REVIEW + - LATEST_TIMESTAMP + - BASE_OCR_REVISION + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata: properties: + testDatasetValidation: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + description: The test dataset validation information. commonMetadata: description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - id: GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata + trainingDatasetValidation: + description: The training dataset validation information. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation type: object - GoogleCloudLocationLocation: - id: GoogleCloudLocationLocation + description: The metadata that represents a processor version being created. + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata + GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse + properties: {} type: object + description: Response message for the SetDefaultProcessorVersion method. + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus properties: - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - locationId: - type: string - description: 'The canonical id for this location. For example: `"us-east1"`.' - name: + inputGcsSource: type: string + description: The source Cloud Storage URI of the document. + status: + description: The status of the importing of the document. + $ref: '#/components/schemas/GoogleRpcStatus' + outputDocumentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - labels: - additionalProperties: - type: string - type: object - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - description: A resource that represents a Google Cloud location. - GoogleCloudDocumentaiV1beta1DocumentRevision: + The document id of imported document if it was successful, otherwise + empty. + description: The status of each individual document in the import process. + type: object + GoogleCloudDocumentaiV1beta3EnableProcessorResponse: + properties: {} + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + id: GoogleCloudDocumentaiV1beta3EnableProcessorResponse + type: object + GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: + type: object + description: Font and other text style attributes. + id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo properties: - parentIds: - type: array - items: - type: string + strikeout: + type: boolean description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. - processor: + Whether the text is strikethrough. This feature is not supported + yet. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Color of the background. + bold: + type: boolean description: >- - If the annotation was made by processor identify the processor by - its resource name. - type: string - parent: - items: - type: integer - format: int32 + Whether the text is bold (equivalent to font_weight is at least + `700`). + superscript: description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - type: array - deprecated: true - humanReview: - description: Human Review information of this revision. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview - agent: + Whether the text is a superscript. This feature is not supported + yet. + type: boolean + fontSize: + type: integer + format: int32 + description: Font size in points (`1` point is `¹⁄₇₂` inches). + letterSpacing: + type: number + description: Letter spacing in points. + format: double + textColor: + description: Color of the text. + $ref: '#/components/schemas/GoogleTypeColor' + fontWeight: + type: integer description: >- - If the change was made by a person specify the name or id of that - person. + TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). + Normal is `400`, bold is `700`. + format: int32 + smallcaps: + description: >- + Whether the text is in small caps. This feature is not supported + yet. + type: boolean + underlined: + description: Whether the text is underlined. + type: boolean + fontType: type: string - id: + description: Name or style of the font. + handwritten: + description: Whether the text is handwritten. + type: boolean + subscript: + type: boolean + description: Whether the text is a subscript. This feature is not supported yet. + pixelFontSize: + type: number + format: double description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. + Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ + `72.0`. + italic: + type: boolean + description: Whether the text is italic. + GoogleCloudDocumentaiV1HumanReviewStatus: + properties: + state: type: string - createTime: - format: google-datetime + description: The state of human review on the processing request. + enumDescriptions: + - >- + Human review state is unspecified. Most likely due to an internal + error. + - >- + Human review is skipped for the document. This can happen because + human review isn't enabled on the processor or the processing + request has been set to skip this document. + - >- + Human review validation is triggered and passed, so no review is + needed. + - >- + Human review validation is triggered and the document is under + review. + - >- + Some error happened during triggering human review, see the + state_message for details. + enum: + - STATE_UNSPECIFIED + - SKIPPED + - VALIDATION_PASSED + - IN_PROGRESS + - ERROR + stateMessage: + description: A message providing more details about the human review state. + type: string + humanReviewOperation: type: string description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - description: Contains past or forward revisions of this document. - id: GoogleCloudDocumentaiV1beta1DocumentRevision + The name of the operation triggered by the processed document. This + field is populated only when the state is + `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and + metadata as the long-running operation returned by ReviewDocument. + description: The status of human review on a processed document. + id: GoogleCloudDocumentaiV1HumanReviewStatus type: object - GoogleCloudDocumentaiV1GcsDocuments: + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: properties: - documents: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + totalDocumentCount: + format: int32 + type: integer + description: Total number of the auto-labeling documents. + individualAutoLabelStatuses: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocument' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus type: array - description: The list of documents. - id: GoogleCloudDocumentaiV1GcsDocuments - description: Specifies a set of documents on Cloud Storage. - type: object - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: - properties: - status: - description: The status of updating the document in storage. - $ref: '#/components/schemas/GoogleRpcStatus' - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. - id: >- - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus - type: object - description: The status of each individual document in the batch update process. - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: - description: >- - Options to control the training of the Custom Document Extraction (CDE) - Processor. - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + description: >- + The list of individual auto-labeling statuses of the dataset + documents. type: object - properties: - trainingMethod: - enumDescriptions: - - '' - - '' - - '' - type: string - description: Training method to use for CDE training. - enum: - - TRAINING_METHOD_UNSPECIFIED - - MODEL_BASED - - TEMPLATE_BASED - GoogleCloudDocumentaiV1beta2DocumentPageAnchor: + description: Metadata of the auto-labeling documents operation. + id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata + GoogleCloudDocumentaiV1DocumentPageAnchor: properties: pageRefs: type: array description: One or more references to visual page elements items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef + type: object description: >- Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - type: object - id: GoogleCloudDocumentaiV1beta2DocumentPageAnchor - GoogleCloudDocumentaiV1beta3Dataset: + id: GoogleCloudDocumentaiV1DocumentPageAnchor + GoogleTypeMoney: properties: - documentWarehouseConfig: - deprecated: true - description: >- - Optional. Deprecated. Warehouse-based dataset configuration is not - supported. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - unmanagedDatasetConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - description: >- - Optional. Unmanaged dataset configuration. Use this configuration if - the dataset documents are managed by the document service internally - (not user-managed). - spannerIndexingConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig + units: + format: int64 description: >- - Optional. A lightweight indexing source with low latency and high - reliability, but lacking advanced features like CMEK and - content-based search. - state: - description: Required. State of the dataset. Ignored when updating dataset. + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - enumDescriptions: - - Default unspecified enum, should not be used. - - Dataset has not been initialized. - - Dataset is being initialized. - - Dataset has been initialized. - enum: - - STATE_UNSPECIFIED - - UNINITIALIZED - - INITIALIZING - - INITIALIZED - gcsManagedConfig: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + nanos: + format: int32 + type: integer description: >- - Optional. User-managed Cloud Storage dataset configuration. Use this - configuration if the dataset documents are stored under a - user-managed Cloud Storage location. - name: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + currencyCode: + description: The three-letter currency code defined in ISO 4217. type: string - description: >- - Dataset resource name. Format: - `projects/{project}/locations/{location}/processors/{processor}/dataset` + description: Represents an amount of money with its currency type. type: object - description: >- - A singleton resource under a Processor which configures a collection of - documents. - id: GoogleCloudDocumentaiV1beta3Dataset - GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: - description: Configuration specific to the Cloud Storage-based implementation. + id: GoogleTypeMoney + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: + description: The status of each individual document in the batch delete process. type: object properties: - gcsPrefix: - description: >- - Required. The Cloud Storage URI (a directory) where the documents - belonging to the dataset must be stored. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' - id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig - GoogleCloudDocumentaiV1Document: - id: GoogleCloudDocumentaiV1Document + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of deleting the document in storage. + documentId: + description: The document id of the document. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' + id: >- + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse + description: Response of the delete documents operation. + properties: {} + type: object + GoogleCloudDocumentaiV1DocumentPageDimension: + type: object + id: GoogleCloudDocumentaiV1DocumentPageDimension + description: Dimension for the page. properties: - pages: - description: Visual page layout for the Document. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' - revisions: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' - type: array - description: Placeholder. Revision history of this document. - entities: - type: array + height: + description: Page height. + format: float + type: number + unit: + type: string + description: Dimension unit. + width: + format: float + description: Page width. + type: number + GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: + properties: + confidence: + description: Confidence of detected language. Range `[0, 1]`. + format: float + type: number + languageCode: description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - textStyles: - deprecated: true + The [BCP-47 language + code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), + such as `en-US` or `sr-Latn`. + type: string + description: Detected language for a structural component. + type: object + id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + GoogleCloudDocumentaiV1ListProcessorsResponse: + properties: + nextPageToken: + description: Points to the next processor, otherwise empty. + type: string + processors: + description: The list of processors. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' - description: Styles for the Document.text. - type: array - shardInfo: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' - description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - textChanges: - description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' type: array + id: GoogleCloudDocumentaiV1ListProcessorsResponse + description: Response message for the ListProcessors method. + type: object + GoogleCloudDocumentaiV1DocumentPageTableTableRow: + description: A row of table cells. + type: object + id: GoogleCloudDocumentaiV1DocumentPageTableTableRow + properties: + cells: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Any error that occurred while processing this document. - content: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell + type: array + description: Cells that make up this row. + GoogleCloudDocumentaiV1beta3CommonOperationMetadata: + id: GoogleCloudDocumentaiV1beta3CommonOperationMetadata + properties: + resource: + description: A related resource to this operation. type: string - format: byte - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - mimeType: - description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + state: type: string - entityRelations: - type: array - description: Placeholder. Relationship among Document.entities. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' - uri: + description: The state of the operation. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + createTime: + description: The creation time of the operation. + type: string + format: google-datetime + stateMessage: type: string description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). - text: + A message providing more details about the current state of + processing. + updateTime: + format: google-datetime type: string - description: Optional. UTF-8 encoded text in reading order from the document. - description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. + description: The last update time of the operation. type: object - GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata: + description: The common metadata for long running operations. + GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: + id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. + resource: + type: string + description: A related resource to this operation. + updateTime: + format: google-datetime + description: The last update time of the operation. + type: string + createTime: + description: The creation time of the operation. + format: google-datetime + type: string + state: + description: The state of the operation. + enum: + - STATE_UNSPECIFIED + - RUNNING + - CANCELLING + - SUCCEEDED + - FAILED + - CANCELLED + enumDescriptions: + - Unspecified state. + - Operation is still running. + - Operation is being cancelled. + - Operation succeeded. + - Operation failed. + - Operation is cancelled. + type: string + stateMessage: + description: >- + A message providing more details about the current state of + processing. + type: string + type: object + description: The common metadata for long running operations. + GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata: + type: object + id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata description: >- The long-running operation metadata for the SetDefaultProcessorVersion method. - type: object - id: GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse: - type: object - description: The response proto of AutoLabelDocuments method. + properties: + commonMetadata: + description: The basic metadata of the long-running operation. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + GoogleProtobufEmpty: properties: {} - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsResponse - GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview: - id: GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview - description: Human Review information of the document. + id: GoogleProtobufEmpty + type: object + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: type: object + id: >- + GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus properties: - stateMessage: - type: string + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. - state: - type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - GoogleCloudDocumentaiV1Vertex: - description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. + The document id of the auto-labeled document. This will replace the + gcs_uri. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the document auto-labeling. + description: The status of individual documents in the auto-labeling process. + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: type: object properties: - x: - format: int32 - description: X coordinate. - type: integer - 'y': - type: integer - description: Y coordinate (starts from the top of the image). - format: int32 - id: GoogleCloudDocumentaiV1Vertex - GoogleCloudDocumentaiV1ProcessorType: - properties: - type: - type: string - description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' - allowCreation: - type: boolean - description: >- - Whether the processor type allows creation. If true, users can - create a processor of this processor type. Otherwise, users need to - request access. - availableLocations: - description: The locations in which this processor is available. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo - sampleDocumentUris: - type: array - description: A set of Cloud Storage URIs of sample documents for this processor. - items: - type: string - category: - description: The processor category, used by UI to group processor types. - type: string - launchStage: + destDatasetType: + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + deprecated: true + description: The destination dataset split type. type: string + destSplitType: + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Launch stage of the processor type - name: - description: >- - The resource name of the processor type. Format: - `projects/{project}/processorTypes/{processor_type}` - type: string - type: object - id: GoogleCloudDocumentaiV1ProcessorType - description: >- - A processor type is responsible for performing a certain document - understanding task on a certain type of document. - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues: - properties: - values: - type: array - items: - type: string - description: The individual values that this enum values type can include. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues - type: object - description: Defines the a list of enum values. - GoogleCloudDocumentaiV1beta2DocumentPageImage: - id: GoogleCloudDocumentaiV1beta2DocumentPageImage - description: Rendered image contents for this page. - type: object - properties: - content: - format: byte - type: string - description: Raw byte content of the image. - mimeType: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED type: string - description: >- - Encoding [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml) - for the image. - height: - type: integer - description: Height of the image in pixels. - format: int32 - width: - description: Width of the image in pixels. - type: integer - format: int32 - GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: - type: object - description: The long-running operation metadata for the EnableProcessor method. - properties: + description: The destination dataset split type. commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata - GoogleCloudDocumentaiV1ListProcessorTypesResponse: - type: object - properties: - nextPageToken: - type: string - description: Points to the next page, otherwise empty. - processorTypes: - description: The processor types. - type: array + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + individualBatchMoveStatuses: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorType' - description: Response message for the ListProcessorTypes method. - id: GoogleCloudDocumentaiV1ListProcessorTypesResponse - GoogleCloudDocumentaiV1ReviewDocumentRequest: - properties: - priority: - description: The priority of the human review task. - enumDescriptions: - - The default priority level. - - >- - The urgent priority level. The labeling manager should allocate - labeler resource to the urgent task queue to respect this priority - level. - type: string - enum: - - DEFAULT - - URGENT - enableSchemaValidation: - type: boolean - description: >- - Whether the validation should be performed on the ad-hoc review - request. - inlineDocument: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Document' - description: An inline document proto. - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: The document schema of the human review task. - type: object - description: Request message for the ReviewDocument method. - id: GoogleCloudDocumentaiV1ReviewDocumentRequest - GoogleCloudDocumentaiV1beta2DocumentPageBlock: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + type: array + description: The list of response details of each document. + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata + GoogleCloudDocumentaiV1DocumentPageBlock: description: >- A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. + type: object properties: - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. provenance: - deprecated: true + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' + deprecated: true layout: description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - id: GoogleCloudDocumentaiV1beta2DocumentPageBlock - type: object - GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + type: array + description: A list of detected languages together with confidence. + id: GoogleCloudDocumentaiV1DocumentPageBlock + GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: + description: Response message for the DeployProcessorVersion method. type: object properties: {} - id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest - description: Request message for the UndeployProcessorVersion method. - GoogleCloudDocumentaiV1beta2Barcode: - id: GoogleCloudDocumentaiV1beta2Barcode + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: type: object properties: - valueFormat: - description: >- - Value format describes the format of the value that a barcode - encodes. The supported formats are: - `CONTACT_INFO`: Contact - information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi - information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar - event. - `DRIVER_LICENSE`: Driver's license. - type: string - rawValue: - type: string + documentErrors: + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array description: >- - Raw value encoded in the barcode. For example: - `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - format: + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + datasetErrorCount: + type: integer + format: int32 + description: The total number of dataset errors. + datasetErrors: description: >- - Format of a barcode. The supported formats are: - `CODE_128`: Code - 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E - type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - - `DATABAR`: GS1 DataBar code type. - type: string - description: Encodes the detailed information of a barcode. - GoogleCloudDocumentaiV1beta3BatchProcessMetadata: - type: object - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadata - description: The long-running operation metadata for BatchProcessDocuments. - properties: - individualProcessStatuses: - description: The list of response details of each document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - type: array - stateMessage: - type: string - description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - updateTime: - type: string - description: The last update time of the operation. - format: google-datetime - state: - description: The state of the current batch processing. - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was being cancelled. - - The batch processing was cancelled. - - The batch processing has failed. - enum: - - STATE_UNSPECIFIED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLING - - CANCELLED - - FAILED - type: string - createTime: - description: The creation time of the operation. - type: string - format: google-datetime - GoogleCloudDocumentaiV1DocumentPageDetectedBarcode: - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: Layout for DetectedBarcode. - barcode: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Barcode' - description: Detailed barcode information of the DetectedBarcode. - type: object - description: A detected barcode. - id: GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - GoogleCloudDocumentaiV1beta1NormalizedVertex: - id: GoogleCloudDocumentaiV1beta1NormalizedVertex - type: object - properties: - 'y': - format: float - description: Y coordinate (starts from the top of the image). - type: number - x: - description: X coordinate. - type: number - format: float - description: >- - A vertex represents a 2D point in the image. NOTE: the normalized vertex - coordinates are relative to the original image and range from 0 to 1. - GoogleCloudDocumentaiV1DocumentSchema: - type: object - properties: - metadata: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaMetadata' - description: Metadata of the schema. - displayName: - description: Display name to show to users. - type: string - entityTypes: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentSchemaEntityType - type: array - description: Entity types of the schema. - description: - description: Description of the schema. - type: string - description: The schema defines the output of the processed document by a processor. - id: GoogleCloudDocumentaiV1DocumentSchema - GoogleCloudDocumentaiV1TrainProcessorVersionRequest: - properties: - processorVersion: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - description: Required. The processor version to be created. - baseProcessorVersion: - type: string - description: >- - Optional. The processor version to use as a base for training. This - processor version must be a child of `parent`. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. - customDocumentExtractionOptions: - description: Options to control Custom Document Extraction (CDE) Processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions - foundationModelTuningOptions: - description: Options to control foundation model tuning of a processor. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - documentSchema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - description: Optional. The schema the processor version will be trained with. - inputData: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - description: Optional. The input data used to train the ProcessorVersion. - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequest - description: Request message for the TrainProcessorVersion method. - type: object - GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse: - id: GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse - properties: {} - description: Response message for the UndeployProcessorVersion method. - type: object - GoogleCloudDocumentaiV1beta3DisableProcessorMetadata: - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - type: object - description: The long-running operation metadata for the DisableProcessor method. - id: GoogleCloudDocumentaiV1beta3DisableProcessorMetadata - GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: - description: Image Quality Defects - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - properties: - type: - description: >- - Name of the defect type. Supported values are: - - `quality/defect_blurry` - `quality/defect_noisy` - - `quality/defect_dark` - `quality/defect_faint` - - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - - `quality/defect_text_cutoff` - `quality/defect_glare` - type: string - confidence: - format: float - description: >- - Confidence of detected defect. Range `[0, 1]` where `1` indicates - strong confidence that the defect exists. - type: number - type: object - GoogleCloudDocumentaiV1ProcessorVersionAlias: - properties: - processorVersion: - type: string - description: The resource name of aliased processor version. - alias: - type: string - description: The alias in the form of `processor_version` resource name. - id: GoogleCloudDocumentaiV1ProcessorVersionAlias - type: object - description: Contains the alias and the aliased resource name of processor version. - GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: - type: object - description: >- - The long-running operation metadata for the ImportProcessorVersion - method. - id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata for the long-running operation. - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: - type: object - id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse - description: The response for TrainProcessorVersion. - properties: - processorVersion: - type: string - description: The resource name of the processor version produced by training. - GoogleCloudDocumentaiV1DocumentPageToken: - id: GoogleCloudDocumentaiV1DocumentPageToken - properties: - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Text style attributes. - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - deprecated: true - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - type: object - description: A detected token. - GoogleCloudDocumentaiV1beta2ProcessDocumentResponse: - properties: - outputConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2OutputConfig' - description: >- - The output location of the parsed responses. The responses are - written to this location as JSON-serialized `Document` objects. - inputConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2InputConfig' - description: >- - Information about the input file. This is the same as the - corresponding input config in the request. - type: object - id: GoogleCloudDocumentaiV1beta2ProcessDocumentResponse - description: Response to a single document processing request. - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata: - properties: - destDatasetType: - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - type: string - deprecated: true - description: The destination dataset split type. - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - individualBatchMoveStatuses: - type: array - description: The list of response details of each document. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus - destSplitType: - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - type: string - description: The destination dataset split type. - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - type: object - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadata - GoogleCloudDocumentaiV1beta2OperationMetadata: - id: GoogleCloudDocumentaiV1beta2OperationMetadata - properties: - updateTime: - type: string - description: The last update time of the operation. - format: google-datetime - stateMessage: - description: >- - A message providing more details about the current state of - processing. - type: string - state: - enumDescriptions: - - The default value. This value is used if the state is omitted. - - Request is received. - - Request operation is waiting for scheduling. - - Request is being processed. - - The batch processing completed successfully. - - The batch processing was cancelled. - - The batch processing has failed. - description: The state of the current batch processing. - type: string - enum: - - STATE_UNSPECIFIED - - ACCEPTED - - WAITING - - RUNNING - - SUCCEEDED - - CANCELLED - - FAILED - createTime: - type: string - format: google-datetime - description: The creation time of the operation. - type: object - description: Contains metadata for the BatchProcessDocuments operation. - GoogleCloudDocumentaiV1beta2DocumentPageSymbol: - type: object - description: A detected symbol. - properties: - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for Symbol. - id: GoogleCloudDocumentaiV1beta2DocumentPageSymbol - GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: - properties: - inputGcsSource: - description: >- - The source of the document, same as the input_gcs_source field in - the request when the batch process started. - type: string - humanReviewOperation: - description: >- - The name of the operation triggered by the processed document. If - the human review process isn't triggered, this field will be empty. - It has the same response type and metadata as the long-running - operation returned by the ReviewDocument method. - deprecated: true - type: string - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status processing the document. - humanReviewStatus: - description: The status of human review on the processed document. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' - outputGcsDestination: - description: >- - The Cloud Storage output destination (in the request as - DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed - document if it was successful, otherwise empty. - type: string - id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus - description: The status of a each individual document in the batch process. - type: object - GoogleCloudDocumentaiV1TrainProcessorVersionResponse: - properties: - processorVersion: - type: string - description: The resource name of the processor version produced by training. - description: The response for TrainProcessorVersion. - type: object - id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse - GoogleCloudDocumentaiV1beta2DocumentPageLine: - id: GoogleCloudDocumentaiV1beta2DocumentPageLine - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - type: object - properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for Line. - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - GoogleCloudDocumentaiV1beta2DocumentPageDimension: - id: GoogleCloudDocumentaiV1beta2DocumentPageDimension - properties: - height: - format: float - description: Page height. - type: number - width: - description: Page width. - format: float - type: number - unit: - description: Dimension unit. - type: string - description: Dimension for the page. - type: object - GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData: - type: object - description: The input data used to train a new ProcessorVersion. - id: GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData - properties: - testDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The documents used for testing the trained version. - trainingDocuments: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - description: The documents used for training the new version. - GoogleCloudDocumentaiV1Processor: - id: GoogleCloudDocumentaiV1Processor - type: object - properties: - displayName: - description: The display name of the processor. - type: string - defaultProcessorVersion: - description: The default processor version. - type: string - type: - type: string - description: >- - The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. - To get a list of processor types, see FetchProcessorTypes. - name: - readOnly: true - type: string - description: >- - Output only. Immutable. The resource name of the processor. Format: - `projects/{project}/locations/{location}/processors/{processor}` - createTime: - format: google-datetime - type: string - description: The time the processor was created. - kmsKeyName: - type: string - description: >- - The [KMS key](https://cloud.google.com/security-key-management) used - for encryption and decryption in CMEK scenarios. - processorVersionAliases: - description: Output only. The processor version aliases. - readOnly: true - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionAlias' - state: - enumDescriptions: - - The processor is in an unspecified state. - - >- - The processor is enabled, i.e., has an enabled version which can - currently serve processing requests and all the feature - dependencies have been successfully initialized. - - The processor is disabled. - - >- - The processor is being enabled, will become `ENABLED` if - successful. - - >- - The processor is being disabled, will become `DISABLED` if - successful. - - >- - The processor is being created, will become either `ENABLED` (for - successful creation) or `FAILED` (for failed ones). Once a - processor is in this state, it can then be used for document - processing, but the feature dependencies of the processor might - not be fully created yet. - - >- - The processor failed during creation or initialization of feature - dependencies. The user should delete the processor and recreate - one as all the functionalities of the processor are disabled. - - The processor is being deleted, will be removed if successful. - description: Output only. The state of the processor. - readOnly: true - enum: - - STATE_UNSPECIFIED - - ENABLED - - DISABLED - - ENABLING - - DISABLING - - CREATING - - FAILED - - DELETING - type: string - processEndpoint: - description: >- - Output only. Immutable. The http endpoint that can be called to - invoke processing. - type: string - readOnly: true - description: >- - The first-class citizen for Document AI. Each processor defines how to - extract structural information from a document. - GoogleCloudDocumentaiV1DisableProcessorRequest: - properties: {} - type: object - id: GoogleCloudDocumentaiV1DisableProcessorRequest - description: Request message for the DisableProcessor method. - GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse: - properties: {} - type: object - id: GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse - description: Response message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiV1beta3ImportDocumentsResponse: - type: object - id: GoogleCloudDocumentaiV1beta3ImportDocumentsResponse - properties: {} - description: Response of the import document operation. - GoogleCloudDocumentaiV1DeleteProcessorMetadata: - type: object - id: GoogleCloudDocumentaiV1DeleteProcessorMetadata - description: The long-running operation metadata for the DeleteProcessor method. - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell: - type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell - properties: - detectedLanguages: - description: A list of detected languages together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - colSpan: - type: integer - description: How many columns this cell spans. - format: int32 - layout: - description: Layout for TableCell. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - rowSpan: - format: int32 - description: How many rows this cell spans. - type: integer - description: A cell representation inside the table. - GoogleTypeTimeZone: - id: GoogleTypeTimeZone - properties: - version: - description: Optional. IANA Time Zone Database version number, e.g. "2019a". - type: string - id: - type: string - description: IANA Time Zone Database time zone, e.g. "America/New_York". - type: object - description: >- - Represents a time zone from the [IANA Time Zone - Database](https://www.iana.org/time-zones). - GoogleCloudDocumentaiV1beta2DocumentShardInfo: - id: GoogleCloudDocumentaiV1beta2DocumentShardInfo - type: object - properties: - shardIndex: - description: The 0-based index of this shard. - format: int64 - type: string - shardCount: - type: string - format: int64 - description: Total number of shards. - textOffset: - type: string - description: >- - The index of the first character in Document.text in the overall - document global text. - format: int64 - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - GoogleCloudDocumentaiV1DocumentPageDimension: - type: object - properties: - width: - format: float - description: Page width. - type: number - height: - format: float - type: number - description: Page height. - unit: - type: string - description: Dimension unit. - id: GoogleCloudDocumentaiV1DocumentPageDimension - description: Dimension for the page. - GoogleCloudDocumentaiV1DocumentEntity: - type: object - id: GoogleCloudDocumentaiV1DocumentEntity - description: >- - An entity that could be a phrase in the text or a property that belongs - to the document. It is a known entity type, such as a person, an - organization, or location. - properties: - redacted: - type: boolean - description: >- - Optional. Whether the entity will be redacted for de-identification - purposes. - mentionText: - description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - type: string - normalizedValue: - description: >- - Optional. Normalized entity value. Absent if the extracted value - could not be converted or the type (e.g. address) is not supported - for certain parsers. This field is also only populated for certain - supported document types. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue - mentionId: - type: string - description: Optional. Deprecated. Use `id` field instead. - pageAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' - description: >- - Optional. Represents the provenance of this entity wrt. the location - on the page where it was found. - id: - description: >- - Optional. Canonical id. This will be a unique value in the entity - list for this document. - type: string - textAnchor: - description: >- - Optional. Provenance of the entity. Text anchor indexing into the - Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - type: - description: Required. Entity type from a schema e.g. `Address`. - type: string - properties: - description: >- - Optional. Entities can be nested to form a hierarchical data - structure representing the content in the document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' - type: array - provenance: - description: Optional. The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - confidence: - format: float - description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. - type: number - GoogleCloudDocumentaiV1beta1DocumentStyleFontSize: - properties: - size: - format: float - type: number - description: Font size for the text. - unit: - description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - type: string - description: Font size with unit. - type: object - id: GoogleCloudDocumentaiV1beta1DocumentStyleFontSize - GoogleCloudDocumentaiV1beta2DocumentEntityRelation: - type: object - properties: - relation: - description: Relationship description. - type: string - subjectId: - type: string - description: Subject entity id. - objectId: - type: string - description: Object entity id. - id: GoogleCloudDocumentaiV1beta2DocumentEntityRelation - description: Relationship between Entities. - GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse: - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorResponse - properties: {} - type: object - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - GoogleCloudDocumentaiV1EvaluationCounters: - type: object - description: Evaluation counters for the documents that were used. - id: GoogleCloudDocumentaiV1EvaluationCounters - properties: - invalidDocumentsCount: - type: integer - format: int32 - description: >- - How many documents were not included in the evaluation as they - didn't pass validation. - failedDocumentsCount: - type: integer - format: int32 - description: >- - How many documents were not included in the evaluation as Document - AI failed to process them. - inputDocumentsCount: - format: int32 - description: How many documents were sent for evaluation. - type: integer - evaluatedDocumentsCount: - format: int32 - description: How many documents were used in the evaluation. - type: integer - GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig: - type: object - id: GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig - properties: {} - description: Configuration specific to an unmanaged dataset. - GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores: - description: Image quality scores for the page image. - type: object - properties: - detectedDefects: - type: array - description: A list of detected defects. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect - qualityScore: - format: float - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - type: number - id: GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores - GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: - description: Configuration specific to spanner-based indexing. - type: object - id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig - properties: {} - GoogleCloudDocumentaiV1beta2DocumentTextChange: - description: This message is used for text changes aka. OCR corrections. - id: GoogleCloudDocumentaiV1beta2DocumentTextChange - type: object - properties: - changedText: - type: string - description: The text that replaces the text identified in the `text_anchor`. - provenance: - description: The history of this annotation. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance - type: array - deprecated: true - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - GoogleCloudDocumentaiV1ListProcessorsResponse: - description: Response message for the ListProcessors method. - type: object - id: GoogleCloudDocumentaiV1ListProcessorsResponse - properties: - nextPageToken: - type: string - description: Points to the next processor, otherwise empty. - processors: - type: array - description: The list of processors. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' - GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: - id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse - properties: {} - type: object - description: Response message for the UndeployProcessorVersion method. - GoogleCloudDocumentaiV1beta1DocumentProvenanceParent: - type: object - properties: - revision: - description: The index of the index into current revision's parent_ids list. - type: integer - format: int32 - id: - deprecated: true - type: integer - description: The id of the parent provenance. - format: int32 - index: - type: integer - description: >- - The index of the parent item in the corresponding item list (eg. - list of entities, properties within entities, etc.) in the parent - revision. - format: int32 - id: GoogleCloudDocumentaiV1beta1DocumentProvenanceParent - description: >- - The parent element the current element is based on. Used for - referencing/aligning, removal and replacement operations. - GoogleCloudDocumentaiV1beta2DocumentPageMatrix: - type: object - properties: - cols: - format: int32 - description: Number of columns in the matrix. - type: integer - data: - format: byte - type: string - description: The matrix data. - type: - format: int32 - type: integer - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - rows: - format: int32 - type: integer - description: Number of rows in the matrix. - description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - id: GoogleCloudDocumentaiV1beta2DocumentPageMatrix - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata: - properties: - totalDocumentCount: - type: integer - format: int32 - description: Total number of the documents that are qualified for importing. - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - individualImportStatuses: - description: The list of response details of each document. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - importConfigValidationResults: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult - description: Validation statuses of the batch documents import config. - type: object - description: Metadata of the import document operation. - id: GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata - GoogleCloudDocumentaiV1beta1DocumentProvenance: - id: GoogleCloudDocumentaiV1beta1DocumentProvenance - description: >- - Structure to identify provenance relationships between annotations in - different revisions. - properties: - revision: - type: integer - deprecated: true - description: The index of the revision that produced this element. - format: int32 - id: - format: int32 - deprecated: true - description: >- - The Id of this operation. Needs to be unique within the scope of the - revision. - type: integer - type: - enumDescriptions: - - >- - Operation type unspecified. If no operation is specified a - provenance entry is simply used to match against a `parent`. - - Add an element. - - Remove an element identified by `parent`. - - >- - Updates any fields within the given provenance scope of the - message. It overwrites the fields rather than replacing them. Use - this when you want to update a field value of an entity without - also updating all the child properties. - - Currently unused. Replace an element identified by `parent`. - - >- - Deprecated. Request human review for the element identified by - `parent`. - - >- - Deprecated. Element is reviewed and approved at human review, - confidence will be set to 1.0. - - Deprecated. Element is skipped in the validation process. - type: string - enumDeprecated: - - false - - false - - false - - false - - false - - true - - true - - true - description: The type of provenance operation. - enum: - - OPERATION_TYPE_UNSPECIFIED - - ADD - - REMOVE - - UPDATE - - REPLACE - - EVAL_REQUESTED - - EVAL_APPROVED - - EVAL_SKIPPED - parents: - type: array - description: References to the original elements that are replaced. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenanceParent - type: object - GoogleCloudDocumentaiV1beta2DocumentPageToken: - type: object - properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - deprecated: true - description: The history of this annotation. - layout: - description: Layout for Token. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - styleInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo - description: Text style attributes. - detectedBreak: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak - description: Detected break at the end of a Token. - id: GoogleCloudDocumentaiV1beta2DocumentPageToken - description: A detected token. - GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - type: object - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata - GoogleCloudDocumentaiV1beta2BoundingPoly: - type: object - properties: - vertices: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2Vertex' - description: The bounding polygon vertices. - type: array - normalizedVertices: - description: The bounding polygon normalized vertices. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2NormalizedVertex' - id: GoogleCloudDocumentaiV1beta2BoundingPoly - description: A bounding polygon for the detected image annotation. - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus: - properties: - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: >- - The document id of the auto-labeled document. This will replace the - gcs_uri. - status: - description: The status of the document auto-labeling. - $ref: '#/components/schemas/GoogleRpcStatus' - id: >- - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - type: object - description: The status of individual documents in the auto-labeling process. - GoogleCloudDocumentaiV1EnableProcessorRequest: - properties: {} - type: object - description: Request message for the EnableProcessor method. - id: GoogleCloudDocumentaiV1EnableProcessorRequest - GoogleCloudDocumentaiV1beta1OutputConfig: - properties: - pagesPerShard: - format: int32 - type: integer - description: >- - The max number of pages to include into each output Document shard - JSON on Google Cloud Storage. The valid range is [1, 100]. If not - specified, the default value is 20. For example, for one pdf file - with 100 pages, 100 parsed pages will be produced. If - `pages_per_shard` = 20, then 5 Document shard JSON files each - containing 20 parsed pages will be written under the prefix - OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where - x and y are 1-indexed page numbers. Example GCS outputs with 157 - pages and pages_per_shard = 50: pages-001-to-050.json - pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - gcsDestination: - description: The Google Cloud Storage location to write the output to. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1GcsDestination' - type: object - id: GoogleCloudDocumentaiV1beta1OutputConfig - description: The desired output location and metadata. - GoogleCloudDocumentaiV1beta1DocumentPageLayout: - description: Visual element describing a layout unit on a page. - properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - confidence: - format: float - description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. - type: number - orientation: - description: Detected orientation for the Layout. - enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. - - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. - - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - type: string - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1BoundingPoly' - type: object - id: GoogleCloudDocumentaiV1beta1DocumentPageLayout - GoogleCloudDocumentaiV1DocumentPageAnchor: - id: GoogleCloudDocumentaiV1DocumentPageAnchor - type: object - description: >- - Referencing the visual context of the entity in the Document.pages. Page - anchors can be cross-page, consist of multiple bounding polygons and - optionally reference specific layout element types. - properties: - pageRefs: - description: One or more references to visual page elements - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - type: array - GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - individualBatchUpdateStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus - description: The list of response details of each document. - type: array - id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata - GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell: - description: A cell representation inside the table. - properties: - detectedLanguages: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - type: array - description: A list of detected languages together with confidence. - rowSpan: - format: int32 - type: integer - description: How many rows this cell spans. - colSpan: - format: int32 - description: How many columns this cell spans. - type: integer - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for TableCell. - type: object - id: GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell - GoogleCloudDocumentaiV1ProcessorVersion: - id: GoogleCloudDocumentaiV1ProcessorVersion - description: >- - A processor version is an implementation of a processor. Each processor - can have multiple versions, pretrained by Google internally or uptrained - by the customer. A processor can only have one default version at a - time. Its document-processing behavior is defined by that version. - properties: - documentSchema: - description: The schema of the processor version. Describes the output. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' - kmsKeyName: - type: string - description: The KMS key name used for encryption. - displayName: - type: string - description: The display name of the processor version. - state: - type: string - enum: - - STATE_UNSPECIFIED - - DEPLOYED - - DEPLOYING - - UNDEPLOYED - - UNDEPLOYING - - CREATING - - DELETING - - FAILED - - IMPORTING - enumDescriptions: - - The processor version is in an unspecified state. - - The processor version is deployed and can be used for processing. - - The processor version is being deployed. - - >- - The processor version is not deployed and cannot be used for - processing. - - The processor version is being undeployed. - - The processor version is being created. - - The processor version is being deleted. - - The processor version failed and is in an indeterminate state. - - The processor version is being imported. - description: Output only. The state of the processor version. - readOnly: true - kmsKeyVersionName: - type: string - description: The KMS key version with which data is encrypted. - googleManaged: - description: >- - Output only. Denotes that this `ProcessorVersion` is managed by - Google. - readOnly: true - type: boolean - modelType: - type: string - enumDescriptions: - - The processor version has unspecified model type. - - The processor version has generative model type. - - The processor version has custom model type. - enum: - - MODEL_TYPE_UNSPECIFIED - - MODEL_TYPE_GENERATIVE - - MODEL_TYPE_CUSTOM - readOnly: true - description: Output only. The model type of this processor version. - deprecationInfo: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo - description: If set, information about the eventual deprecation of this version. - latestEvaluation: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' - description: The most recently invoked evaluation for the processor version. - name: - type: string - description: >- - Identifier. The resource name of the processor version. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - createTime: - format: google-datetime - description: The time the processor version was created. - type: string - type: object - GoogleCloudDocumentaiV1beta3HumanReviewStatus: - id: GoogleCloudDocumentaiV1beta3HumanReviewStatus - type: object - description: The status of human review on a processed document. - properties: - stateMessage: - description: A message providing more details about the human review state. - type: string - humanReviewOperation: - type: string - description: >- - The name of the operation triggered by the processed document. This - field is populated only when the state is - `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and - metadata as the long-running operation returned by ReviewDocument. - state: - description: The state of human review on the processing request. - enum: - - STATE_UNSPECIFIED - - SKIPPED - - VALIDATION_PASSED - - IN_PROGRESS - - ERROR - enumDescriptions: - - >- - Human review state is unspecified. Most likely due to an internal - error. - - >- - Human review is skipped for the document. This can happen because - human review isn't enabled on the processor or the processing - request has been set to skip this document. - - >- - Human review validation is triggered and passed, so no review is - needed. - - >- - Human review validation is triggered and the document is under - review. - - >- - Some error happened during triggering human review, see the - state_message for details. - type: string - GoogleCloudDocumentaiV1beta1BoundingPoly: - id: GoogleCloudDocumentaiV1beta1BoundingPoly - properties: - normalizedVertices: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1NormalizedVertex' - type: array - description: The bounding polygon normalized vertices. - vertices: - type: array - description: The bounding polygon vertices. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1Vertex' - description: A bounding polygon for the detected image annotation. - type: object - GoogleCloudDocumentaiV1OcrConfig: - id: GoogleCloudDocumentaiV1OcrConfig - type: object - description: Config for Document OCR. - properties: - enableNativePdfParsing: - type: boolean - description: >- - Enables special handling for PDFs with existing text information. - Results in better text extraction quality in such PDF inputs. - enableSymbol: - description: Includes symbol level OCR information if set to true. - type: boolean - disableCharacterBoxesDetection: - type: boolean - description: >- - Turn off character box detector in OCR engine. Character box - detection is enabled by default in OCR 2.0 (and later) processors. - computeStyleInfo: - deprecated: true - type: boolean - description: >- - Turn on font identification model and return font style information. - Deprecated, use PremiumFeatures.compute_style_info instead. - premiumFeatures: - description: Configurations for premium OCR features. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' - enableImageQualityScores: - type: boolean - description: >- - Enables intelligent document quality scores after OCR. Can help with - diagnosing why OCR responses are of poor quality for a given input. - Adds additional latency comparable to regular OCR to the process - call. - advancedOcrOptions: - description: >- - A list of advanced OCR options to further fine-tune OCR behavior. - Current valid values are: - `legacy_layout`: a heuristics layout - detection algorithm, which serves as an alternative to the current - ML-based layout detection algorithm. Customers can choose the best - suitable layout algorithm based on their situation. - type: array - items: - type: string - hints: - description: Hints for the OCR model. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' - GoogleCloudDocumentaiV1beta1DocumentPageLine: - type: object - properties: - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Line. - detectedLanguages: - type: array - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - description: >- - A collection of tokens that a human would perceive as a line. Does not - cross column boundaries, can be horizontal, vertical, etc. - id: GoogleCloudDocumentaiV1beta1DocumentPageLine - GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig: - id: GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig - description: >- - Configuration specific to the Document AI Warehouse-based - implementation. - type: object - properties: - schema: - type: string - readOnly: true - description: >- - Output only. The schema in Document AI Warehouse associated with the - dataset. - collection: - type: string - description: >- - Output only. The collection in Document AI Warehouse associated with - the dataset. - readOnly: true - GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata: - id: GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata - type: object - description: The long-running operation metadata for UpdateLabelerPool. - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata: - id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata - type: object - description: The metadata proto of `ResyncDataset` method. - properties: - individualDocumentResyncStatuses: - description: >- - The list of document resync statuses. The same document could have - multiple `individual_document_resync_statuses` if it has multiple - inconsistencies. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus - type: array - datasetResyncStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus - type: array - description: >- - The list of dataset resync statuses. Not checked when - ResyncDatasetRequest.dataset_documents is specified. - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1BatchProcessRequest: - type: object - id: GoogleCloudDocumentaiV1BatchProcessRequest - description: Request message for BatchProcessDocuments. - properties: - labels: - description: >- - Optional. The labels with user-defined metadata for the request. - Label keys and values can be no longer than 63 characters (Unicode - codepoints) and can only contain lowercase letters, numeric - characters, underscores, and dashes. International characters are - allowed. Label values are optional. Label keys must start with a - letter. - type: object - additionalProperties: - type: string - documentOutputConfig: - description: The output configuration for the BatchProcessDocuments method. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentOutputConfig' - processOptions: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessOptions' - description: Inference-time options for the process API - skipHumanReview: - type: boolean - description: >- - Whether human review should be skipped for this request. Default to - `false`. - inputDocuments: - description: The input documents for the BatchProcessDocuments method. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus: - id: >- - GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus - description: The status of each individual document in the import process. - properties: - status: - description: The status of the importing of the document. - $ref: '#/components/schemas/GoogleRpcStatus' - outputDocumentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3DocumentId' - description: >- - The document id of imported document if it was successful, otherwise - empty. - inputGcsSource: - type: string - description: The source Cloud Storage URI of the document. - type: object - GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: - type: object - properties: {} - id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse - description: Response of the batch move documents operation. - GoogleCloudDocumentaiV1DocumentPageSymbol: - type: object - properties: - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - layout: - description: Layout for Symbol. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: A detected symbol. - id: GoogleCloudDocumentaiV1DocumentPageSymbol - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus: - description: The status of each individual document in the batch delete process. - id: >- - GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - type: object - properties: - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of deleting the document in storage. - documentId: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - description: The document id of the document. - GoogleCloudDocumentaiV1DeployProcessorVersionMetadata: - id: GoogleCloudDocumentaiV1DeployProcessorVersionMetadata - description: >- - The long-running operation metadata for the DeployProcessorVersion - method. - type: object - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo: - type: object - id: GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo - description: Font and other text style attributes. - properties: - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - underlined: - type: boolean - description: Whether the text is underlined. - handwritten: - description: Whether the text is handwritten. - type: boolean - letterSpacing: - type: number - description: Letter spacing in points. - format: double - bold: - type: boolean - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - italic: - type: boolean - description: Whether the text is italic. - strikeout: - type: boolean - description: >- - Whether the text is strikethrough. This feature is not supported - yet. - fontSize: - type: integer - description: Font size in points (`1` point is `¹⁄₇₂` inches). - format: int32 - superscript: - type: boolean - description: >- - Whether the text is a superscript. This feature is not supported - yet. - fontWeight: - description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - type: integer - format: int32 - subscript: - description: Whether the text is a subscript. This feature is not supported yet. - type: boolean - pixelFontSize: - format: double - type: number - description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - smallcaps: - description: >- - Whether the text is in small caps. This feature is not supported - yet. - type: boolean - fontType: - description: Name or style of the font. - type: string - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - GoogleCloudDocumentaiV1beta2DocumentPageFormField: - id: GoogleCloudDocumentaiV1beta2DocumentPageFormField - description: A form field detected on the page. - type: object - properties: - valueType: - description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - type: string - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - description: The history of this annotation. - nameDetectedLanguages: - description: A list of detected languages for name together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - type: array - fieldValue: - description: Layout for the FormField value. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - correctedKeyText: - description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. - type: string - fieldName: - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - correctedValueText: - type: string - description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. - valueDetectedLanguages: - type: array - description: A list of detected languages for value together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue: - id: GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue - properties: - text: - type: string - description: >- - Optional. An optional field to store a normalized string. For some - entity types, one of respective `structured_value` fields may also - be populated. Also not all the types of `structured_value` will be - normalized. For example, some processors may not generate `float` or - `integer` normalized text by default. Below are sample formats - mapped to structured values. - Money/Currency type (`money_value`) - is in the ISO 4217 text format. - Date type (`date_value`) is in the - ISO 8601 text format. - Datetime type (`datetime_value`) is in the - ISO 8601 text format. - datetimeValue: - $ref: '#/components/schemas/GoogleTypeDateTime' - description: >- - DateTime value. Includes date, time, and timezone. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - integerValue: - description: Integer value. - type: integer - format: int32 - floatValue: - format: float - description: Float value. - type: number - booleanValue: - type: boolean - description: >- - Boolean value. Can be used for entities with binary values, or for - checkboxes. - moneyValue: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Money value. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - dateValue: - description: >- - Date value. Includes year, month, day. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - $ref: '#/components/schemas/GoogleTypeDate' - addressValue: - $ref: '#/components/schemas/GoogleTypePostalAddress' - description: >- - Postal address. See also: - https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - description: Parsed and normalized entity value. - type: object - GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: - properties: - evaluationDocuments: - description: >- - Optional. The documents used in the evaluation. If unspecified, use - the processor's dataset as evaluation input. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest - description: Evaluates the given ProcessorVersion against the supplied documents. - type: object - GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: - type: object - description: Defines properties that can be part of the entity type. - id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty - properties: - occurrenceType: - type: string - enum: - - OCCURRENCE_TYPE_UNSPECIFIED - - OPTIONAL_ONCE - - OPTIONAL_MULTIPLE - - REQUIRED_ONCE - - REQUIRED_MULTIPLE - enumDescriptions: - - Unspecified occurrence type. - - >- - There will be zero or one instance of this entity type. The same - entity instance may be mentioned multiple times. - - The entity type will appear zero or multiple times. - - >- - The entity type will only appear exactly once. The same entity - instance may be mentioned multiple times. - - The entity type will appear once or more times. - description: >- - Occurrence type limits the number of instances an entity type - appears in the document. - displayName: - type: string - description: User defined name for the property. - valueType: - type: string - description: >- - A reference to the value type of the property. This type is subject - to the same conventions as the `Entity.base_types` field. - name: - description: >- - The name of the property. Follows the same guidelines as the - EntityType name. - type: string - GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata: - type: object - id: GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata - properties: - totalDocumentCount: - description: Total number of the auto-labeling documents. - type: integer - format: int32 - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - individualAutoLabelStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadataIndividualAutoLabelStatus - type: array - description: >- - The list of individual auto-labeling statuses of the dataset - documents. - description: Metadata of the auto-labeling documents operation. - GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: - id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata - description: The long-running operation metadata for the CreateLabelerPool method. - type: object - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1ListProcessorVersionsResponse: - type: object - properties: - processorVersions: - type: array - description: The list of processors. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' - nextPageToken: - description: Points to the next processor, otherwise empty. - type: string - id: GoogleCloudDocumentaiV1ListProcessorVersionsResponse - description: Response message for the ListProcessorVersions method. - GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: - description: Metadata of the EvaluateProcessorVersion method. - type: object - id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleTypeColor: - type: object - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - id: GoogleTypeColor - properties: - blue: - description: The amount of blue in the color as a value in the interval [0, 1]. - format: float - type: number - green: - description: The amount of green in the color as a value in the interval [0, 1]. - type: number - format: float - red: - description: The amount of red in the color as a value in the interval [0, 1]. - format: float - type: number - alpha: - format: float - type: number - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - GoogleCloudDocumentaiV1beta1ProcessDocumentResponse: - properties: - outputConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1OutputConfig' - description: >- - The output location of the parsed responses. The responses are - written to this location as JSON-serialized `Document` objects. - inputConfig: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1InputConfig' - description: >- - Information about the input file. This is the same as the - corresponding input config in the request. - id: GoogleCloudDocumentaiV1beta1ProcessDocumentResponse - description: Response to a single document processing request. - type: object - GoogleCloudDocumentaiV1beta2GcsSource: - type: object - properties: - uri: - type: string - id: GoogleCloudDocumentaiV1beta2GcsSource - description: >- - The Google Cloud Storage location where the input file will be read - from. - GoogleCloudDocumentaiV1beta1DocumentPageVisualElement: - type: object - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. - id: GoogleCloudDocumentaiV1beta1DocumentPageVisualElement - properties: - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - type: - type: string - description: Type of the VisualElement. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for VisualElement. - GoogleCloudDocumentaiUiv1beta3RevisionRef: - id: GoogleCloudDocumentaiUiv1beta3RevisionRef - description: The revision reference specifies which revision on the document to read. - type: object - properties: - latestProcessorVersion: - type: string - description: >- - Reads the revision generated by the processor version. The format - takes the full resource name of processor version. - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` - revisionCase: - type: string - description: Reads the revision by the predefined case. - enum: - - REVISION_CASE_UNSPECIFIED - - LATEST_HUMAN_REVIEW - - LATEST_TIMESTAMP - - BASE_OCR_REVISION - enumDescriptions: - - Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`. - - The latest revision made by a human. - - The latest revision based on timestamp. - - The first (OCR) revision. - revisionId: - type: string - description: Reads the revision given by the id. - GoogleCloudDocumentaiV1OcrConfigHints: - description: Hints for OCR Engine - type: object - properties: - languageHints: - type: array - items: - type: string - description: >- - List of BCP-47 language codes to use for OCR. In most cases, not - specifying it yields the best results since it enables automatic - language detection. For languages based on the Latin alphabet, - setting hints is not needed. In rare cases, when the language of the - text in the image is known, setting a hint will help get better - results (although it will be a significant hindrance if the hint is - wrong). - id: GoogleCloudDocumentaiV1OcrConfigHints - GoogleCloudDocumentaiV1beta1DocumentTextAnchor: - id: GoogleCloudDocumentaiV1beta1DocumentTextAnchor - type: object - properties: - textSegments: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment - description: The text segments from the Document.text. - content: - type: string - description: >- - Contains the content of the text span so that users do not have to - look it up in the text_segments. It is always populated for - formFields. - description: Text reference indexing into the Document.text. - GoogleCloudDocumentaiV1GcsPrefix: - type: object - description: Specifies all documents on Cloud Storage with a common prefix. - id: GoogleCloudDocumentaiV1GcsPrefix - properties: - gcsUriPrefix: - description: The URI prefix. - type: string - GoogleCloudDocumentaiV1beta2DocumentLabel: - properties: - automlModel: - type: string - description: >- - Label is generated AutoML model. This field stores the full resource - name of the AutoML model. Format: - `projects/{project-id}/locations/{location-id}/models/{model-id}` - confidence: - type: number - format: float - description: Confidence score between 0 and 1 for label assignment. - name: - description: >- - Name of the label. When the label is generated from AutoML Text - Classification model, this field represents the name of the - category. - type: string - description: >- - Label attaches schema information and/or other metadata to segments - within a Document. Multiple Labels on a single field can denote either - different labels, different instances of the same label created at - different times, or some combination of both. - type: object - id: GoogleCloudDocumentaiV1beta2DocumentLabel - GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata: - type: object - id: GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - description: >- - The long-running operation metadata for the DeleteProcessorVersion - method. - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: - properties: - errorDocumentCount: - format: int32 - description: Total number of documents that failed to be deleted in storage. - type: integer - totalDocumentCount: - format: int32 - description: Total number of documents deleting from dataset. - type: integer - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - individualBatchDeleteStatuses: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus - description: The list of response details of each document. - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata - type: object - GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse: - description: Response of the delete documents operation. - type: object - properties: {} - id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions: - type: object - properties: - trainSteps: - format: int32 - type: integer - description: >- - Optional. The number of steps to run for model tuning. Valid values - are between 1 and 400. If not provided, recommended steps will be - used. - learningRateMultiplier: - description: >- - Optional. The multiplier to apply to the recommended learning rate. - Valid values are between 0.1 and 10. If not provided, recommended - learning rate will be used. - type: number - format: float - id: >- - GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions - description: Options to control foundation model tuning of the processor. - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: - id: >- - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus - type: object - properties: - outputDocumentId: - description: >- - The document id of imported document if it was successful, otherwise - empty. - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' - outputGcsDestination: - type: string - description: >- - The output_gcs_destination of the processed document if it was - successful, otherwise empty. - inputGcsSource: - description: The source Cloud Storage URI of the document. - type: string - status: - $ref: '#/components/schemas/GoogleRpcStatus' - description: The status of the importing of the document. - description: The status of each individual document in the import process. - GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: - description: Response of the EvaluateProcessorVersion method. - id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse - type: object - properties: - evaluation: - type: string - description: The resource name of the created evaluation. - GoogleCloudDocumentaiV1DocumentShardInfo: - type: object - properties: - textOffset: - format: int64 - description: >- - The index of the first character in Document.text in the overall - document global text. - type: string - shardIndex: - description: The 0-based index of this shard. - format: int64 - type: string - shardCount: - description: Total number of shards. - format: int64 - type: string - id: GoogleCloudDocumentaiV1DocumentShardInfo - description: >- - For a large document, sharding may be performed to produce several - document shards. Each document shard contains this field to detail which - shard it is. - GoogleCloudDocumentaiV1DocumentPageTableTableRow: - description: A row of table cells. - properties: - cells: - description: Cells that make up this row. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageTableTableCell - type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableRow - GoogleCloudDocumentaiV1beta2DocumentPage: - type: object - description: A page in a Document. - properties: - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - transforms: - description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageMatrix - paragraphs: - type: array - description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageParagraph - symbols: - description: A list of visually detected symbols on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageSymbol - type: array - tokens: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageToken' - type: array - description: A list of visually detected tokens on the page. - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for the page. - pageNumber: - format: int32 - description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - type: integer - imageQualityScores: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores - description: Image quality scores. - dimension: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDimension - description: Physical dimension of the page. - visualElements: - type: array - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageVisualElement - detectedBarcodes: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode - type: array - description: A list of detected barcodes. - formFields: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageFormField - description: A list of visually detected form fields on the page. - type: array - blocks: - description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageBlock' - image: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageImage' - description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - lines: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLine' - description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. - provenance: - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - description: The history of this page. - tables: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageTable' - description: A list of visually detected tables on the page. - id: GoogleCloudDocumentaiV1beta2DocumentPage - GoogleCloudDocumentaiV1DocumentRevision: - description: Contains past or forward revisions of this document. - type: object - properties: - processor: - description: >- - If the annotation was made by processor identify the processor by - its resource name. - type: string - id: - description: >- - Id of the revision, internally generated by doc proto storage. - Unique within the context of the document. - type: string - humanReview: - description: Human Review information of this revision. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentRevisionHumanReview - createTime: - format: google-datetime - type: string - description: >- - The time that the revision was created, internally generated by doc - proto storage at the time of create. - parent: - items: - format: int32 - type: integer - description: >- - The revisions that this revision is based on. This can include one - or more parent (when documents are merged.) This field represents - the index into the `revisions` field. - deprecated: true - type: array - agent: - type: string - description: >- - If the change was made by a person specify the name or id of that - person. - parentIds: - items: - type: string - description: >- - The revisions that this revision is based on. Must include all the - ids that have anything to do with this revision - eg. there are - `provenance.parent.revision` fields that index into this field. - type: array - id: GoogleCloudDocumentaiV1DocumentRevision - GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo: - properties: - pixelFontSize: - description: >- - Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ - `72.0`. - type: number - format: double - italic: - description: Whether the text is italic. - type: boolean - textColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the text. - fontType: - description: Name or style of the font. - type: string - letterSpacing: - description: Letter spacing in points. - format: double - type: number - superscript: - type: boolean - description: >- - Whether the text is a superscript. This feature is not supported - yet. - strikeout: - type: boolean - description: >- - Whether the text is strikethrough. This feature is not supported - yet. - bold: - type: boolean - description: >- - Whether the text is bold (equivalent to font_weight is at least - `700`). - smallcaps: - type: boolean - description: >- - Whether the text is in small caps. This feature is not supported - yet. - subscript: - description: Whether the text is a subscript. This feature is not supported yet. - type: boolean - fontWeight: - description: >- - TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). - Normal is `400`, bold is `700`. - type: integer + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + documentErrorCount: format: int32 - fontSize: - description: Font size in points (`1` point is `¹⁄₇₂` inches). + description: The total number of document errors. type: integer - format: int32 - underlined: - description: Whether the text is underlined. - type: boolean - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Color of the background. - handwritten: - description: Whether the text is handwritten. - type: boolean - description: Font and other text style attributes. - id: GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo - type: object - GoogleCloudDocumentaiV1EnableProcessorMetadata: - properties: - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - id: GoogleCloudDocumentaiV1EnableProcessorMetadata - description: The long-running operation metadata for the EnableProcessor method. + id: >- + GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse: type: object - GoogleCloudDocumentaiV1beta3ReviewDocumentResponse: - id: GoogleCloudDocumentaiV1beta3ReviewDocumentResponse + description: Response of the EvaluateProcessorVersion method. + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse properties: - gcsDestination: - description: >- - The Cloud Storage uri for the human reviewed document if the review - is succeeded. - type: string - state: - type: string - enum: - - STATE_UNSPECIFIED - - REJECTED - - SUCCEEDED - enumDescriptions: - - The default value. This value is used if the state is omitted. - - The review operation is rejected by the reviewer. - - The review operation is succeeded. - description: The state of the review operation. - rejectionReason: - description: The reason why the review is rejected by reviewer. + evaluation: + description: The resource name of the created evaluation. type: string + GoogleCloudDocumentaiV1DocumentDocumentLayout: + description: >- + Represents the parsed layout of a document as a collection of blocks + that the document is divided into. + properties: + blocks: + description: List of blocks in the document. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + type: array + id: GoogleCloudDocumentaiV1DocumentDocumentLayout type: object - description: Response message for the ReviewDocument method. - GoogleCloudDocumentaiV1beta1DocumentPageMatrix: - type: object + GoogleCloudDocumentaiV1EvaluationMetrics: properties: - cols: - description: Number of columns in the matrix. + groundTruthOccurrencesCount: + type: integer + description: The amount of occurrences in ground truth documents. format: int32 + predictedOccurrencesCount: type: integer - type: + description: The amount of occurrences in predicted documents. + format: int32 + truePositivesCount: type: integer format: int32 - description: >- - This encodes information about what data type the matrix uses. For - example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of - OpenCV primitive data types, please refer to - https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - data: - format: byte - type: string - description: The matrix data. - rows: - description: Number of rows in the matrix. + description: The amount of true positives. + groundTruthDocumentCount: + type: integer + description: The amount of documents with a ground truth occurrence. + format: int32 + totalDocumentsCount: + type: integer + description: The amount of documents that had an occurrence of this label. format: int32 + recall: + type: number + format: float + description: The calculated recall. + falseNegativesCount: + format: int32 + type: integer + description: The amount of false negatives. + f1Score: + description: The calculated f1 score. + format: float + type: number + falsePositivesCount: + format: int32 + type: integer + description: The amount of false positives. + precision: + description: The calculated precision. + type: number + format: float + predictedDocumentCount: + description: The amount of documents with a predicted occurrence. type: integer - id: GoogleCloudDocumentaiV1beta1DocumentPageMatrix + format: int32 + type: object + description: Evaluation metrics, either in aggregate or about a specific entity. + id: GoogleCloudDocumentaiV1EvaluationMetrics + GoogleCloudDocumentaiV1ProcessorType: + type: object + id: GoogleCloudDocumentaiV1ProcessorType description: >- - Representation for transformation matrix, intended to be compatible and - used with OpenCV format for image manipulation. - GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata: + A processor type is responsible for performing a certain document + understanding task on a certain type of document. + properties: + sampleDocumentUris: + items: + type: string + description: A set of Cloud Storage URIs of sample documents for this processor. + type: array + category: + description: The processor category, used by UI to group processor types. + type: string + availableLocations: + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorTypeLocationInfo + type: array + description: The locations in which this processor is available. + name: + type: string + description: >- + The resource name of the processor type. Format: + `projects/{project}/processorTypes/{processor_type}` + allowCreation: + type: boolean + description: >- + Whether the processor type allows creation. If true, users can + create a processor of this processor type. Otherwise, users need to + request access. + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Launch stage of the processor type + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + type: + type: string + description: 'The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.' + GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata: description: >- - The long-running operation metadata for the DeleteProcessorVersion + The long-running operation metadata for the ImportProcessorVersion method. + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata type: object - id: GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata properties: commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + description: The basic metadata for the long-running operation. + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata: + properties: + totalDocumentCount: + description: Total number of documents deleting from dataset. + format: int32 + type: integer + individualBatchDeleteStatuses: + description: The list of response details of each document. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + errorDocumentCount: + type: integer + description: Total number of documents that failed to be deleted in storage. + format: int32 + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata type: object + GoogleCloudDocumentaiV1DocumentPageLine: properties: - qualityScore: - description: >- - The overall quality score. Range `[0, 1]` where `1` is perfect - quality. - type: number - format: float - detectedDefects: + layout: + description: Layout for Line. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + detectedLanguages: + description: A list of detected languages together with confidence. type: array items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect - description: A list of detected defects. - description: Image quality scores for the page image. - id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores - GoogleCloudDocumentaiV1beta2Vertex: - id: GoogleCloudDocumentaiV1beta2Vertex + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + deprecated: true + id: GoogleCloudDocumentaiV1DocumentPageLine type: object description: >- - A vertex represents a 2D point in the image. NOTE: the vertex - coordinates are in the same scale as the original image. + A collection of tokens that a human would perceive as a line. Does not + cross column boundaries, can be horizontal, vertical, etc. + GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo: + description: Information about Generative AI model-based processor versions. properties: - x: - type: integer - description: X coordinate. - format: int32 - 'y': - type: integer - description: Y coordinate (starts from the top of the image). - format: int32 - GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse: - description: Response message for the DeployProcessorVersion method. - properties: {} - id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse + foundationGenAiModelInfo: + description: Information for a pretrained Google-managed foundation model. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo + customGenAiModelInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo + description: Information for a custom Generative AI model created by the user. + id: GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo type: object - GoogleCloudDocumentaiV1beta2DocumentPageVisualElement: - id: GoogleCloudDocumentaiV1beta2DocumentPageVisualElement - description: >- - Detected non-text visual elements e.g. checkbox, signature etc. on the - page. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry type: object + description: Represents an entry in the list. properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - description: Layout for VisualElement. - detectedLanguages: + blocks: items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + description: >- + A list entry is a list of blocks. Repeated blocks support further + hierarchies and nested blocks. type: array - type: - type: string - description: Type of the VisualElement. - GoogleCloudDocumentaiV1beta1DocumentStyle: - description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse: + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse type: object - id: GoogleCloudDocumentaiV1beta1DocumentStyle + description: Response of the EvaluateProcessorVersion method. properties: - fontFamily: - type: string - description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - textStyle: + evaluation: type: string - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - fontWeight: + description: The resource name of the created evaluation. + GoogleCloudDocumentaiV1DocumentShardInfo: + id: GoogleCloudDocumentaiV1DocumentShardInfo + description: >- + For a large document, sharding may be performed to produce several + document shards. Each document shard contains this field to detail which + shard it is. + properties: + shardCount: + format: int64 + description: Total number of shards. type: string - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - textDecoration: + shardIndex: type: string - description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - fontSize: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentStyleFontSize - description: Font size. - textAnchor: - description: Text anchor indexing into the Document.text. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' - color: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text color. - GoogleTypeDateTime: - properties: - seconds: - description: >- - Optional. Seconds of minutes of the time. Must normally be from 0 to - 59, defaults to 0. An API may allow the value 60 if it allows - leap-seconds. - type: integer - format: int32 - minutes: - description: >- - Optional. Minutes of hour of day. Must be from 0 to 59, defaults to - 0. - type: integer - format: int32 - utcOffset: + description: The 0-based index of this shard. + format: int64 + textOffset: type: string description: >- - UTC offset. Must be whole seconds, between -18 hours and +18 hours. - For example, a UTC offset of -4:00 would be represented as { - seconds: -14400 }. - format: google-duration - year: - format: int32 - description: >- - Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a - datetime without a year. - type: integer - month: - type: integer - format: int32 - description: >- - Optional. Month of year. Must be from 1 to 12, or 0 if specifying a - datetime without a month. - timeZone: - description: Time zone. - $ref: '#/components/schemas/GoogleTypeTimeZone' - day: - type: integer - description: >- - Optional. Day of month. Must be from 1 to 31 and valid for the year - and month, or 0 if specifying a datetime without a day. - format: int32 - nanos: - type: integer - description: >- - Optional. Fractions of seconds in nanoseconds. Must be from 0 to - 999,999,999, defaults to 0. - format: int32 - hours: - description: >- - Optional. Hours of day in 24 hour format. Should be from 0 to 23, - defaults to 0 (midnight). An API may choose to allow the value - "24:00:00" for scenarios like business closing time. - format: int32 - type: integer - id: GoogleTypeDateTime + The index of the first character in Document.text in the overall + document global text. + format: int64 type: object - description: >- - Represents civil time (or occasionally physical time). This type can - represent a civil time in one of a few possible ways: * When utc_offset - is set and time_zone is unset: a civil time on a calendar day with a - particular offset from UTC. * When time_zone is set and utc_offset is - unset: a civil time on a calendar day in a particular time zone. * When - neither time_zone nor utc_offset is set: a civil time on a calendar day - in local time. The date is relative to the Proleptic Gregorian Calendar. - If year, month, or day are 0, the DateTime is considered not to have a - specific year, month, or day respectively. This type may also be used to - represent a physical time if all the date and time fields are set and - either case of the `time_offset` oneof is set. Consider using - `Timestamp` message for physical time instead. If your use case also - would like to store the user's timezone, that can be done in another - field. This type is more flexible than some applications may want. Make - sure to document and validate your application's limitations. - GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId: - properties: - docId: - type: string - description: Required. The id of the document. - id: GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. + GoogleCloudDocumentaiV1Document: type: object - GoogleLongrunningOperation: - id: GoogleLongrunningOperation properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + text: + description: Optional. UTF-8 encoded text in reading order from the document. + type: string + textStyles: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyle' + deprecated: true + type: array + description: Styles for the Document.text. + uri: type: string - metadata: description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - done: - type: boolean + Optional. Currently supports Google Cloud Storage URI of the form + `gs://bucket_name/object_name`. Object versioning is not supported. + For more information, refer to [Google Cloud Storage Request + URIs](https://cloud.google.com/storage/docs/reference-uris). + textChanges: + type: array + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextChange' description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object + Placeholder. A list of text corrections made to Document.text. This + is usually used for annotating corrections to OCR mistakes. Text + changes for a given revision may not overlap with each other. + revisions: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentRevision' + type: array + description: Placeholder. Revision history of this document. + pages: + type: array + description: Visual page layout for the Document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPage' + shardInfo: description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object - GoogleCloudDocumentaiV1DocumentRevisionHumanReview: - id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview - properties: - state: + Information about the sharding if this document is sharded part of a + larger document. If the document is not sharded, this message is not + specified. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentShardInfo' + mimeType: type: string - description: Human review state. e.g. `requested`, `succeeded`, `rejected`. - stateMessage: + description: >- + An IANA published [media type (MIME + type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + documentLayout: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayout' + description: Parsed layout of the document. + content: type: string + format: byte description: >- - A message providing more details about the current state of - processing. For example, the rejection reason when the state is - `rejected`. + Optional. Inline document content, represented as a stream of bytes. + Note: As with all `bytes` fields, protobuffers use a pure binary + representation, whereas JSON representations use base64. + error: + description: Any error that occurred while processing this document. + $ref: '#/components/schemas/GoogleRpcStatus' + entityRelations: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntityRelation' + type: array + description: Placeholder. Relationship among Document.entities. + chunkedDocument: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentChunkedDocument' + description: Document chunked based on chunking config. + entities: + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + type: array + description: >- + A list of entities detected on Document.text. For document shards, + entities in this list may cross shard boundaries. + id: GoogleCloudDocumentaiV1Document + description: >- + Document represents the canonical document resource in Document AI. It + is an interchange format that provides insights into documents and + allows for collaboration between users and Document AI to iterate and + optimize for quality. + GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata: + id: GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata type: object - description: Human Review information of the document. - GoogleCloudDocumentaiV1beta2OutputConfig: - description: The desired output location and metadata. - id: GoogleCloudDocumentaiV1beta2OutputConfig properties: - pagesPerShard: - format: int32 + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: >- + The long-running operation metadata for the UndeployProcessorVersion + method. + GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation: + id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation + properties: + documentErrorCount: type: integer + format: int32 + description: The total number of document errors. + documentErrors: + type: array description: >- - The max number of pages to include into each output Document shard - JSON on Google Cloud Storage. The valid range is [1, 100]. If not - specified, the default value is 20. For example, for one pdf file - with 100 pages, 100 parsed pages will be produced. If - `pages_per_shard` = 20, then 5 Document shard JSON files each - containing 20 parsed pages will be written under the prefix - OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where - x and y are 1-indexed page numbers. Example GCS outputs with 157 - pages and pages_per_shard = 50: pages-001-to-050.json - pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - gcsDestination: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2GcsDestination' - description: The Google Cloud Storage location to write the output to. - type: object - GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + datasetErrors: + description: >- + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + datasetErrorCount: + format: int32 + type: integer + description: The total number of dataset errors. type: object - description: The statistic representing a dataset split type for this export. - id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + GoogleCloudDocumentaiV1RawDocument: + description: Payload message of raw document content (bytes). + id: GoogleCloudDocumentaiV1RawDocument properties: - totalDocumentCount: + displayName: + type: string description: >- - Total number of documents with the given dataset split type to be - exported. - type: integer - format: int32 - splitType: + The display name of the document, it supports all Unicode characters + except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, + `,` `~`, `=` and `:` are reserved. If not specified, a default ID is + generated. + mimeType: + description: >- + An IANA MIME type (RFC6838) indicating the nature and format of the + content. type: string - description: The dataset split type. - enumDescriptions: - - Default value if the enum is not set. - - Identifies the train documents. - - Identifies the test documents. - - Identifies the unassigned documents. - enum: - - DATASET_SPLIT_TYPE_UNSPECIFIED - - DATASET_SPLIT_TRAIN - - DATASET_SPLIT_TEST - - DATASET_SPLIT_UNASSIGNED - GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: - description: Metadata of the EvaluateProcessorVersion method. + content: + description: Inline document content. + format: byte + type: string + type: object + GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata: type: object + description: The long-running operation metadata for the CreateLabelerPool method. properties: commonMetadata: + description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata - GoogleCloudDocumentaiV1beta1DocumentTextChange: - id: GoogleCloudDocumentaiV1beta1DocumentTextChange + id: GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata + GoogleCloudDocumentaiV1NormalizedVertex: properties: - textAnchor: + 'y': + description: Y coordinate (starts from the top of the image). + format: float + type: number + x: + format: float + description: X coordinate. + type: number + id: GoogleCloudDocumentaiV1NormalizedVertex + type: object + description: >- + A vertex represents a 2D point in the image. NOTE: the normalized vertex + coordinates are relative to the original image and range from 0 to 1. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock: + properties: + type: + type: string description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextAnchor' - provenance: - deprecated: true + Type of the list_entries (if exist). Available options are `ordered` + and `unordered`. + listEntries: type: array - description: The history of this annotation. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance - changedText: - type: string - description: The text that replaces the text identified in the `text_anchor`. - description: This message is used for text changes aka. OCR corrections. + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry + description: List entries that constitute a list block. + type: object + description: Represents a list type block. + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock + GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig: + type: object + properties: {} + description: Configuration specific to spanner-based indexing. + id: GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig + GoogleCloudLocationListLocationsResponse: type: object - GoogleCloudDocumentaiV1beta2DocumentStyleFontSize: - description: Font size with unit. - id: GoogleCloudDocumentaiV1beta2DocumentStyleFontSize properties: - unit: + nextPageToken: + description: The standard List next-page token. type: string + locations: + type: array description: >- - Unit for the font size. Follows CSS naming (such as `in`, `px`, and - `pt`). - size: - description: Font size for the text. - format: float - type: number + A list of locations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/GoogleCloudLocationLocation' + description: The response message for Locations.ListLocations. + id: GoogleCloudLocationListLocationsResponse + GoogleCloudDocumentaiV1beta3GcsPrefix: type: object - GoogleTypeDate: + id: GoogleCloudDocumentaiV1beta3GcsPrefix + description: Specifies all documents on Cloud Storage with a common prefix. properties: - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - type: integer - day: + gcsUriPrefix: + type: string + description: The URI prefix. + GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata + description: The long-running operation metadata for the DeleteProcessor method. + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + type: object + GoogleCloudDocumentaiV1ProcessorTypeLocationInfo: + description: The location information about where the processor is available. + properties: + locationId: + type: string description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - format: int32 - type: integer - year: + The location ID. For supported locations, refer to [regional and + multi-regional support](/document-ai/docs/regions). + type: object + id: GoogleCloudDocumentaiV1ProcessorTypeLocationInfo + GoogleCloudDocumentaiV1DocumentRevisionHumanReview: + description: Human Review information of the document. + type: object + id: GoogleCloudDocumentaiV1DocumentRevisionHumanReview + properties: + stateMessage: + type: string description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - type: integer - format: int32 + A message providing more details about the current state of + processing. For example, the rejection reason when the state is + `rejected`. + state: + type: string + description: Human review state. e.g. `requested`, `succeeded`, `rejected`. + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow: + id: >- + GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow + type: object + properties: + cells: + type: array + description: A table row is a list of table cells. + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell + description: Represents a row in a table. + GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId: description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp - id: GoogleTypeDate + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. type: object + properties: + gcsUri: + description: Required. The Cloud Storage URI where the actual document is stored. + type: string + cwDocId: + type: string + description: Id of the document (indexed) managed by Content Warehouse. + deprecated: true + id: GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId GoogleCloudDocumentaiV1ProcessOptions: - description: Options for Process API - type: object - id: GoogleCloudDocumentaiV1ProcessOptions properties: fromEnd: type: integer format: int32 description: Only process certain pages from the end, same as above. + layoutConfig: + description: >- + Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns + error if set on other processor types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig fromStart: + type: integer format: int32 description: >- Only process certain pages from the start. Process all if the document has fewer pages. - type: integer schemaOverride: $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' description: >- Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. + individualPageSelector: + description: Which pages to process (1-indexed). + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector ocrConfig: $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfig' description: >- Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types. - individualPageSelector: - description: Which pages to process (1-indexed). + type: object + description: Options for Process API + id: GoogleCloudDocumentaiV1ProcessOptions + GoogleCloudDocumentaiV1DocumentStyleFontSize: + type: object + properties: + unit: + type: string + description: >- + Unit for the font size. Follows CSS naming (such as `in`, `px`, and + `pt`). + size: + type: number + description: Font size for the text. + format: float + id: GoogleCloudDocumentaiV1DocumentStyleFontSize + description: Font size with unit. + GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: + id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse + type: object + description: >- + Response message for the EnableProcessor method. Intentionally empty + proto for adding fields in future. + properties: {} + GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: + type: object + description: Metadata message associated with the ExportProcessorVersion operation. + id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + properties: + commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector - GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The common metadata about the operation. + GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse type: object - id: GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig - description: The sharding config for the output document. + description: The response message for the ImportProcessorVersion method. properties: - pagesOverlap: - format: int32 - description: The number of overlapping pages between consecutive shards. - type: integer - pagesPerShard: - type: integer - description: The number of pages per shard. - format: int32 - GoogleCloudDocumentaiV1CommonOperationMetadata: - id: GoogleCloudDocumentaiV1CommonOperationMetadata + processorVersion: + description: The destination processor version name. + type: string + GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId: + properties: + gcsUri: + type: string + description: Required. The Cloud Storage URI where the actual document is stored. + cwDocId: + deprecated: true + type: string + description: Id of the document (indexed) managed by Content Warehouse. + id: GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId + description: >- + Identifies a document uniquely within the scope of a dataset in the + user-managed Cloud Storage option. type: object + GoogleCloudDocumentaiV1DocumentEntity: properties: - updateTime: + normalizedValue: + description: >- + Optional. Normalized entity value. Absent if the extracted value + could not be converted or the type (e.g. address) is not supported + for certain parsers. This field is also only populated for certain + supported document types. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentEntityNormalizedValue + pageAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageAnchor' + description: >- + Optional. Represents the provenance of this entity wrt. the location + on the page where it was found. + id: type: string - format: google-datetime - description: The last update time of the operation. - resource: - description: A related resource to this operation. + description: >- + Optional. Canonical id. This will be a unique value in the entity + list for this document. + confidence: + format: float + description: Optional. Confidence of detected Schema entity. Range `[0, 1]`. + type: number + type: type: string - createTime: - description: The creation time of the operation. + description: Required. Entity type from a schema e.g. `Address`. + textAnchor: + description: >- + Optional. Provenance of the entity. Text anchor indexing into the + Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + properties: + type: array + description: >- + Optional. Entities can be nested to form a hierarchical data + structure representing the content in the document. + items: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentEntity' + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: Optional. The history of this annotation. + mentionId: type: string - format: google-datetime - state: + description: Optional. Deprecated. Use `id` field instead. + mentionText: + description: Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + type: string + redacted: + description: >- + Optional. Whether the entity will be redacted for de-identification + purposes. + type: boolean + type: object + id: GoogleCloudDocumentaiV1DocumentEntity + description: >- + An entity that could be a phrase in the text or a property that belongs + to the document. It is a known entity type, such as a person, an + organization, or location. + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult: + properties: + inputGcsSource: + type: string + description: The source Cloud Storage URI specified in the import config. + status: + description: The validation status of import config. + $ref: '#/components/schemas/GoogleRpcStatus' + id: >- + GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult + type: object + description: >- + The validation status of each import config. Status is set to an error + if there are no documents to import in the `import_config`, or `OK` if + the operation will try to proceed with at least one document. + GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: + description: The long-running operation metadata for the DisableProcessor method. + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + type: object + id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata + GoogleCloudDocumentaiV1beta3EnableProcessorMetadata: + description: The long-running operation metadata for the EnableProcessor method. + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1beta3EnableProcessorMetadata + type: object + GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse: + properties: {} + description: The response proto of ExportDocuments method. + type: object + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse + GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect: + type: object + description: Image Quality Defects + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect + properties: + type: + description: >- + Name of the defect type. Supported values are: - + `quality/defect_blurry` - `quality/defect_noisy` - + `quality/defect_dark` - `quality/defect_faint` - + `quality/defect_text_too_small` - `quality/defect_document_cutoff` - + `quality/defect_text_cutoff` - `quality/defect_glare` + type: string + confidence: + format: float + description: >- + Confidence of detected defect. Range `[0, 1]` where `1` indicates + strong confidence that the defect exists. + type: number + GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat: + type: object + properties: + splitType: + enum: + - DATASET_SPLIT_TYPE_UNSPECIFIED + - DATASET_SPLIT_TRAIN + - DATASET_SPLIT_TEST + - DATASET_SPLIT_UNASSIGNED + description: The dataset split type. + type: string + enumDescriptions: + - Default value if the enum is not set. + - Identifies the train documents. + - Identifies the test documents. + - Identifies the unassigned documents. + totalDocumentCount: + description: >- + Total number of documents with the given dataset split type to be + exported. + format: int32 + type: integer + id: GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadataSplitExportStat + description: The statistic representing a dataset split type for this export. + GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: + type: object + id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures + properties: + enableMathOcr: + description: Turn on the model that can extract LaTeX math formulas. + type: boolean + computeStyleInfo: + description: Turn on font identification model and return font style information. + type: boolean + enableSelectionMarkDetection: + type: boolean + description: >- + Turn on selection mark detector in OCR engine. Only available in OCR + 2.0 (and later) processors. + description: Configurations for premium OCR features. + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus: + id: GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus + properties: + status: + description: >- + The status of resyncing the dataset with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + datasetInconsistencyType: + description: The type of the inconsistency of the dataset. type: string - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - description: The state of the operation. enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - stateMessage: - type: string - description: >- - A message providing more details about the current state of - processing. - description: The common metadata for long running operations. - GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse: - properties: {} + - Default value. + - The marker file under the dataset folder is not found. + enum: + - DATASET_INCONSISTENCY_TYPE_UNSPECIFIED + - DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER + description: Resync status against inconsistency types on the dataset level. type: object - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse - description: Response message for the SetDefaultProcessorVersion method. - GoogleCloudDocumentaiUiv1beta3DocumentId: - id: GoogleCloudDocumentaiUiv1beta3DocumentId - description: Document Identifier. + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata: + id: GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadata type: object properties: - unmanagedDocId: - description: A document id within unmanaged dataset. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId - gcsManagedDocId: - description: A document id within user-managed Cloud Storage. + commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId - revisionRef: - $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3RevisionRef' - description: Points to a specific revision of the document if set. - GoogleCloudDocumentaiV1RawDocument: - id: GoogleCloudDocumentaiV1RawDocument - type: object - description: Payload message of raw document content (bytes). + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + individualBatchUpdateStatuses: + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + description: The list of response details of each document. + GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus: properties: - displayName: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status processing the document. + outputGcsDestination: + type: string description: >- - The display name of the document, it supports all Unicode characters - except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, - `,` `~`, `=` and `:` are reserved. If not specified, a default ID is - generated. + The Cloud Storage output destination (in the request as + DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed + document if it was successful, otherwise empty. + humanReviewStatus: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3HumanReviewStatus' + description: The status of human review on the processed document. + inputGcsSource: type: string - content: - description: Inline document content. - format: byte + description: >- + The source of the document, same as the input_gcs_source field in + the request when the batch process started. + humanReviewOperation: + deprecated: true + description: >- + The name of the operation triggered by the processed document. If + the human review process isn't triggered, this field will be empty. + It has the same response type and metadata as the long-running + operation returned by the ReviewDocument method. type: string - mimeType: + description: The status of a each individual document in the batch process. + type: object + id: GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus + GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse: + description: The response for TrainProcessorVersion. + id: GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse + type: object + properties: + processorVersion: + description: The resource name of the processor version produced by training. type: string - description: >- - An IANA MIME type (RFC6838) indicating the nature and format of the - content. - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus: + type: object + properties: + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of updating the document in storage. + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + description: The status of each individual document in the batch update process. id: >- - GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. + GoogleCloudDocumentaiUiv1beta3BatchUpdateDocumentsMetadataIndividualBatchUpdateStatus + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus: + properties: + documentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + description: The document id of the document. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of moving the document. + id: >- + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsMetadataIndividualBatchMoveStatus + type: object + description: The status of each individual document in the batch move process. + GoogleCloudDocumentaiV1UndeployProcessorVersionResponse: + description: Response message for the UndeployProcessorVersion method. + id: GoogleCloudDocumentaiV1UndeployProcessorVersionResponse type: object + properties: {} + GoogleCloudDocumentaiV1DocumentPageMatrix: + description: >- + Representation for transformation matrix, intended to be compatible and + used with OpenCV format for image manipulation. properties: - documentErrorCount: - description: The total number of document errors. - type: integer + data: + format: byte + description: The matrix data. + type: string + type: format: int32 - datasetErrors: - description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - documentErrors: + type: integer description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' - datasetErrorCount: - description: The total number of dataset errors. + This encodes information about what data type the matrix uses. For + example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of + OpenCV primitive data types, please refer to + https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + rows: + type: integer + format: int32 + description: Number of rows in the matrix. + cols: + description: Number of columns in the matrix. format: int32 type: integer - GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata: - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The common metadata about the operation. - id: GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata + id: GoogleCloudDocumentaiV1DocumentPageMatrix type: object - description: Metadata message associated with the ExportProcessorVersion operation. - GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest: - description: Request message for the SetDefaultProcessorVersion method. - id: GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse properties: - defaultProcessorVersion: - description: >- - Required. The resource name of child ProcessorVersion to use as - default. Format: - `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}` + processorVersion: type: string + description: The resource name of the processor version produced by training. type: object - GoogleCloudDocumentaiV1DocumentPageTableTableCell: - description: A cell representation inside the table. + description: The response for TrainProcessorVersion. + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse type: object - id: GoogleCloudDocumentaiV1DocumentPageTableTableCell properties: - colSpan: - type: integer - description: How many columns this cell spans. - format: int32 - detectedLanguages: - type: array - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - rowSpan: - description: How many rows this cell spans. - format: int32 - type: integer - layout: - description: Layout for TableCell. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata: + evaluation: + description: The resource name of the created evaluation. + type: string + description: Response of the EvaluateProcessorVersion method. + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus: + description: The status of each individual document in the import process. type: object - id: GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata - description: The long-running operation metadata for the DisableProcessor method. - properties: - commonMetadata: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - description: The basic metadata of the long-running operation. - GoogleCloudDocumentaiV1beta1DocumentPageFormField: properties: - fieldValue: - description: Layout for the FormField value. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - valueDetectedLanguages: - type: array - description: A list of detected languages for value together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - nameDetectedLanguages: - type: array - description: A list of detected languages for name together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - description: The history of this annotation. - valueType: - type: string + outputDocumentId: + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - correctedValueText: + The document id of imported document if it was successful, otherwise + empty. + status: + $ref: '#/components/schemas/GoogleRpcStatus' + description: The status of the importing of the document. + outputGcsDestination: description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. + The output_gcs_destination of the processed document if it was + successful, otherwise empty. type: string - correctedKeyText: - description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. + inputGcsSource: + description: The source Cloud Storage URI of the document. type: string - fieldName: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - description: A form field detected on the page. - id: GoogleCloudDocumentaiV1beta1DocumentPageFormField - type: object - GoogleCloudDocumentaiV1beta1DocumentPageBlock: - description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. + id: >- + GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus + GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan: type: object + description: Represents where the chunk starts and ends in the document. properties: - layout: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageLayout' - description: Layout for Block. - detectedLanguages: - description: A list of detected languages together with confidence. + pageStart: + type: integer + description: Page where chunk starts in the document. + format: int32 + pageEnd: + description: Page where chunk ends in the document. + format: int32 + type: integer + id: GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan + GoogleCloudDocumentaiV1OcrConfig: + id: GoogleCloudDocumentaiV1OcrConfig + properties: + disableCharacterBoxesDetection: + type: boolean + description: >- + Turn off character box detector in OCR engine. Character box + detection is enabled by default in OCR 2.0 (and later) processors. + computeStyleInfo: + type: boolean + deprecated: true + description: >- + Turn on font identification model and return font style information. + Deprecated, use PremiumFeatures.compute_style_info instead. + enableSymbol: + type: boolean + description: Includes symbol level OCR information if set to true. + hints: + description: Hints for the OCR model. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigHints' + enableNativePdfParsing: + type: boolean + description: >- + Enables special handling for PDFs with existing text information. + Results in better text extraction quality in such PDF inputs. + premiumFeatures: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1OcrConfigPremiumFeatures' + description: Configurations for premium OCR features. + enableImageQualityScores: + description: >- + Enables intelligent document quality scores after OCR. Can help with + diagnosing why OCR responses are of poor quality for a given input. + Adds additional latency comparable to regular OCR to the process + call. + type: boolean + advancedOcrOptions: + description: >- + A list of advanced OCR options to further fine-tune OCR behavior. + Current valid values are: - `legacy_layout`: a heuristics layout + detection algorithm, which serves as an alternative to the current + ML-based layout detection algorithm. Customers can choose the best + suitable layout algorithm based on their situation. items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage + type: string type: array - provenance: - deprecated: true - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentProvenance' - id: GoogleCloudDocumentaiV1beta1DocumentPageBlock - GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId: type: object - description: >- - Identifies a document uniquely within the scope of a dataset in - unmanaged option. - id: GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId + description: Config for Document OCR. + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus: properties: - docId: - description: Required. The id of the document. + documentId: + description: The document identifier. + $ref: '#/components/schemas/GoogleCloudDocumentaiUiv1beta3DocumentId' + documentInconsistencyType: + enum: + - DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED + - DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO + - DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA + - DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE + description: The type of document inconsistency. type: string - GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment: + enumDescriptions: + - Default value. + - The document proto is invalid. + - Indexed docproto metadata is mismatched. + - The page image or thumbnails are missing. + status: + description: >- + The status of resyncing the document with regards to the detected + inconsistency. Empty if ResyncDatasetRequest.validate_only is + `true`. + $ref: '#/components/schemas/GoogleRpcStatus' + id: >- + GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus + description: Resync status for each document per inconsistency type. + type: object + GoogleTypeTimeZone: + id: GoogleTypeTimeZone + description: >- + Represents a time zone from the [IANA Time Zone + Database](https://www.iana.org/time-zones). type: object - id: GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment properties: - endIndex: - description: TextSegment half open end UTF-8 char index in the Document.text. - format: int64 + id: type: string - startIndex: - format: int64 + description: IANA Time Zone Database time zone, e.g. "America/New_York". + version: type: string - description: TextSegment start UTF-8 char index in the Document.text. - description: >- - A text segment in the Document.text. The indices may be out of bounds - which indicate that the text extends into another document shard for - large sharded documents. See ShardInfo.text_offset - GoogleCloudDocumentaiV1beta2DocumentPageParagraph: - id: GoogleCloudDocumentaiV1beta2DocumentPageParagraph + description: Optional. IANA Time Zone Database version number, e.g. "2019a". + GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse: + properties: {} + description: Response of the batch move documents operation. + id: GoogleCloudDocumentaiUiv1beta3BatchMoveDocumentsResponse + type: object + GoogleCloudDocumentaiV1TrainProcessorVersionResponse: type: object - description: A collection of lines that a human would perceive as a paragraph. properties: - provenance: - description: The history of this annotation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentProvenance' - deprecated: true - detectedLanguages: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. - layout: - description: Layout for Paragraph. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentPageLayout' - GoogleCloudDocumentaiV1DocumentPageBlock: + processorVersion: + description: The resource name of the processor version produced by training. + type: string + description: The response for TrainProcessorVersion. + id: GoogleCloudDocumentaiV1TrainProcessorVersionResponse + GoogleTypeColor: description: >- - A block has a set of lines (collected into paragraphs) that have a - common line-spacing and orientation. - id: GoogleCloudDocumentaiV1DocumentPageBlock + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + type: object + id: GoogleTypeColor properties: - detectedLanguages: - description: A list of detected languages together with confidence. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - type: array - provenance: - description: The history of this annotation. - deprecated: true - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - layout: - description: Layout for Block. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + alpha: + type: number + format: float + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + blue: + format: float + type: number + description: The amount of blue in the color as a value in the interval [0, 1]. + red: + type: number + description: The amount of red in the color as a value in the interval [0, 1]. + format: float + green: + type: number + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + GoogleCloudDocumentaiV1DocumentPageFormField: type: object - GoogleCloudDocumentaiV1DocumentPage: properties: - formFields: - description: A list of visually detected form fields on the page. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageFormField' - type: array - paragraphs: - description: >- - A list of visually detected text paragraphs on the page. A - collection of lines that a human would perceive as a paragraph. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageParagraph' - type: array - tables: - description: A list of visually detected tables on the page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageTable' - pageNumber: + fieldName: description: >- - 1-based index for current Page in a parent Document. Useful when a - page is taken out of a Document for individual processing. - format: int32 - type: integer - layout: - description: Layout for the page. + Layout for the FormField name. e.g. `Address`, `Email`, `Grand + total`, `Phone number`, etc. $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - lines: + correctedKeyText: description: >- - A list of visually detected text lines on the page. A collection of - tokens that a human would perceive as a line. + Created for Labeling UI to export key text. If corrections were made + to the text identified by the `field_name.text_anchor`, this field + will contain the correction. + type: string + nameDetectedLanguages: type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLine' - visualElements: - description: >- - A list of detected non-text visual elements e.g. checkbox, signature - etc. on the page. + description: A list of detected languages for name together with confidence. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageVisualElement - type: array - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this page. - deprecated: true - tokens: - description: A list of visually detected tokens on the page. - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageToken' - blocks: - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageBlock' - type: array - description: >- - A list of visually detected text blocks on the page. A block has a - set of lines (collected into paragraphs) that have a common - line-spacing and orientation. - detectedLanguages: + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + valueDetectedLanguages: + description: A list of detected languages for value together with confidence. items: $ref: >- #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - description: A list of detected languages together with confidence. type: array - transforms: - type: array - description: >- - Transformation matrices that were applied to the original document - image to produce Page.image. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageMatrix' - dimension: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageDimension' - description: Physical dimension of the page. - image: + valueType: description: >- - Rendered image for this page. This image is preprocessed to remove - any skew, rotation, and distortions such that the annotation - bounding boxes can be upright and axis-aligned. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageImage' - detectedBarcodes: - type: array - description: A list of detected barcodes. - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedBarcode - symbols: - type: array - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageSymbol' - description: A list of visually detected symbols on the page. - imageQualityScores: - description: Image quality scores. - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScores - type: object - id: GoogleCloudDocumentaiV1DocumentPage - description: A page in a Document. - GoogleCloudDocumentaiV1OcrConfigPremiumFeatures: - id: GoogleCloudDocumentaiV1OcrConfigPremiumFeatures - type: object - properties: - computeStyleInfo: - description: Turn on font identification model and return font style information. - type: boolean - enableMathOcr: - type: boolean - description: Turn on the model that can extract LaTeX math formulas. - enableSelectionMarkDetection: - type: boolean + If the value is non-textual, this field represents the type. Current + valid values are: - blank (this indicates the `field_value` is + normal text) - `unfilled_checkbox` - `filled_checkbox` + type: string + provenance: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + description: The history of this annotation. + fieldValue: + description: Layout for the FormField value. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' + correctedValueText: + type: string description: >- - Turn on selection mark detector in OCR engine. Only available in OCR - 2.0 (and later) processors. - description: Configurations for premium OCR features. - GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics: - description: Evaluations metrics, at a specific confidence level. + Created for Labeling UI to export value text. If corrections were + made to the text identified by the `field_value.text_anchor`, this + field will contain the correction. + description: A form field detected on the page. + id: GoogleCloudDocumentaiV1DocumentPageFormField + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions: + id: >- + GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions + description: >- + Options to control the training of the Custom Document Extraction (CDE) + Processor. type: object - id: GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics - properties: - metrics: - description: The metrics at the specific confidence level. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' - confidenceLevel: - format: float - type: number - description: The confidence level. - GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata: properties: - state: - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED - description: The state of the operation. - type: string + trainingMethod: enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. - updateTime: - description: The last update time of the operation. - type: string - format: google-datetime - resource: - type: string - description: A related resource to this operation. - stateMessage: + - '' + - '' + - '' + description: Training method to use for CDE training. + enum: + - TRAINING_METHOD_UNSPECIFIED + - MODEL_BASED + - TEMPLATE_BASED type: string + GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig: + properties: + gcsPrefix: description: >- - A message providing more details about the current state of - processing. - createTime: - description: The creation time of the operation. - format: google-datetime - type: string - description: The common metadata for long running operations. + Required. The Cloud Storage URI (a directory) where the documents + belonging to the dataset must be stored. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta3GcsPrefix' + type: object + id: GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig + description: Configuration specific to the Cloud Storage-based implementation. + GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata: + id: GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata type: object - id: GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata - GoogleCloudDocumentaiV1beta2DocumentStyle: description: >- - Annotation for common text style attributes. This adheres to CSS - conventions as much as possible. + The long-running operation metadata for the DeleteProcessorVersion + method. properties: - fontWeight: - type: string - description: >- - [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). - Possible values are `normal`, `bold`, `bolder`, and `lighter`. - textDecoration: - description: >- - [Text - decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). - Follows CSS standard. - type: string - textStyle: - type: string - description: >- - [Text - style](https://www.w3schools.com/cssref/pr_font_font-style.asp). - Possible values are `normal`, `italic`, and `oblique`. - fontSize: + commonMetadata: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta2DocumentStyleFontSize - description: Font size. - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta2DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - backgroundColor: - $ref: '#/components/schemas/GoogleTypeColor' - description: Text background color. - fontFamily: + #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation: + id: >- + GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation + properties: + documentErrors: + description: >- + Error information pertaining to specific documents. A maximum of 10 + document errors will be returned. Any document with errors will not + be used throughout training. + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: array + documentErrorCount: + type: integer + format: int32 + description: The total number of document errors. + datasetErrorCount: + description: The total number of dataset errors. + type: integer + format: int32 + datasetErrors: description: >- - Font family such as `Arial`, `Times New Roman`. - https://www.w3schools.com/cssref/pr_font_font-family.asp - type: string - color: - description: Text color. - $ref: '#/components/schemas/GoogleTypeColor' - type: object - id: GoogleCloudDocumentaiV1beta2DocumentStyle - GoogleCloudDocumentaiV1DocumentPageAnchorPageRef: - description: Represents a weak reference to a page element within a document. + Error information for the dataset as a whole. A maximum of 10 + dataset errors will be returned. A single dataset error is terminal + for training. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' type: object + description: >- + The dataset validation information. This includes any and all errors + with documents and the dataset. + GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest: + description: Evaluates the given ProcessorVersion against the supplied documents. properties: - boundingPoly: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + evaluationDocuments: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1BatchDocumentsInputConfig description: >- - Optional. Identifies the bounding polygon of a layout element on the - page. If `layout_type` is set, the bounding polygon must be exactly - the same to the layout element it's referring to. - layoutType: - enum: - - LAYOUT_TYPE_UNSPECIFIED - - BLOCK - - PARAGRAPH - - LINE - - TOKEN - - VISUAL_ELEMENT - - TABLE - - FORM_FIELD - enumDescriptions: - - Layout Unspecified. - - References a Page.blocks element. - - References a Page.paragraphs element. - - References a Page.lines element. - - References a Page.tokens element. - - References a Page.visual_elements element. - - Refrrences a Page.tables element. - - References a Page.form_fields element. + Optional. The documents used in the evaluation. If unspecified, use + the processor's dataset as evaluation input. + id: GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + type: object + GoogleCloudDocumentaiV1Barcode: + properties: + format: type: string description: >- - Optional. The type of the layout element that is being referenced if - any. - page: - format: int64 + Format of a barcode. The supported formats are: - `CODE_128`: Code + 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - + `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - + `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - + `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E + type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - + `DATABAR`: GS1 DataBar code type. + valueFormat: type: string description: >- - Required. Index into the Document.pages element, for example using - `Document.pages` to locate the related page element. This field is - skipped when its value is the default `0`. See - https://developers.google.com/protocol-buffers/docs/proto3#json. - confidence: - format: float + Value format describes the format of the value that a barcode + encodes. The supported formats are: - `CONTACT_INFO`: Contact + information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - + `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - + `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi + information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar + event. - `DRIVER_LICENSE`: Driver's license. + rawValue: description: >- - Optional. Confidence of detected page element, if applicable. Range - `[0, 1]`. - type: number - layoutId: - deprecated: true - type: string - description: Optional. Deprecated. Use PageRef.bounding_poly instead. - id: GoogleCloudDocumentaiV1DocumentPageAnchorPageRef - GoogleCloudDocumentaiV1beta2GcsDestination: - properties: - uri: + Raw value encoded in the barcode. For example: + `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. type: string - description: >- - The Google Cloud Storage location where the output file will be written - to. - id: GoogleCloudDocumentaiV1beta2GcsDestination type: object - GoogleCloudDocumentaiV1DocumentPageLayout: - id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Encodes the detailed information of a barcode. + id: GoogleCloudDocumentaiV1Barcode + GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata: + properties: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + description: Metadata of the EvaluateProcessorVersion method. type: object + id: GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata + GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty: properties: - confidence: + displayName: + type: string + description: User defined name for the property. + valueType: description: >- - Confidence of the current Layout within context of the object this - layout is for. e.g. confidence can be for a single token, a table, a - visual element, etc. depending on context. Range `[0, 1]`. - type: number - format: float - boundingPoly: - description: The bounding polygon for the Layout. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' - orientation: + A reference to the value type of the property. This type is subject + to the same conventions as the `Entity.base_types` field. + type: string + name: + type: string + description: >- + The name of the property. Follows the same guidelines as the + EntityType name. + occurrenceType: enumDescriptions: - - Unspecified orientation. - - Orientation is aligned with page up. - - >- - Orientation is aligned with page right. Turn the head 90 degrees - clockwise from upright to read. + - Unspecified occurrence type. - >- - Orientation is aligned with page down. Turn the head 180 degrees - from upright to read. + There will be zero or one instance of this entity type. The same + entity instance may be mentioned multiple times. + - The entity type will appear zero or multiple times. - >- - Orientation is aligned with page left. Turn the head 90 degrees - counterclockwise from upright to read. - enum: - - ORIENTATION_UNSPECIFIED - - PAGE_UP - - PAGE_RIGHT - - PAGE_DOWN - - PAGE_LEFT - description: Detected orientation for the Layout. + The entity type will only appear exactly once. The same entity + instance may be mentioned multiple times. + - The entity type will appear once or more times. type: string - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' - description: Text anchor indexing into the Document.text. - description: Visual element describing a layout unit on a page. - GoogleCloudDocumentaiV1DisableProcessorResponse: - id: GoogleCloudDocumentaiV1DisableProcessorResponse + description: >- + Occurrence type limits the number of instances an entity type + appears in the document. + enum: + - OCCURRENCE_TYPE_UNSPECIFIED + - OPTIONAL_ONCE + - OPTIONAL_MULTIPLE + - REQUIRED_ONCE + - REQUIRED_MULTIPLE + id: GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty + type: object + description: Defines properties that can be part of the entity type. + GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse: + id: GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsResponse + description: Response of the delete documents operation. type: object properties: {} - description: >- - Response message for the DisableProcessor method. Intentionally empty - proto for adding fields in future. - GoogleCloudDocumentaiV1beta1Document: - id: GoogleCloudDocumentaiV1beta1Document + GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse: + properties: + processorVersion: + description: The destination processor version name. + type: string + id: GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse + type: object + description: The response message for the ImportProcessorVersion method. + GoogleCloudDocumentaiV1BatchProcessMetadata: + id: GoogleCloudDocumentaiV1BatchProcessMetadata type: object - description: >- - Document represents the canonical document resource in Document AI. It - is an interchange format that provides insights into documents and - allows for collaboration between users and Document AI to iterate and - optimize for quality. properties: - shardInfo: - description: >- - Information about the sharding if this document is sharded part of a - larger document. If the document is not sharded, this message is not - specified. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentShardInfo' - textStyles: - description: Styles for the Document.text. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentStyle' - type: array - deprecated: true - content: - format: byte + updateTime: + description: The last update time of the operation. type: string - description: >- - Optional. Inline document content, represented as a stream of bytes. - Note: As with all `bytes` fields, protobuffers use a pure binary - representation, whereas JSON representations use base64. - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: Any error that occurred while processing this document. - mimeType: + format: google-datetime + state: + description: The state of the current batch processing. + enum: + - STATE_UNSPECIFIED + - WAITING + - RUNNING + - SUCCEEDED + - CANCELLING + - CANCELLED + - FAILED type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Request operation is waiting for scheduling. + - Request is being processed. + - The batch processing completed successfully. + - The batch processing was being cancelled. + - The batch processing was cancelled. + - The batch processing has failed. + stateMessage: description: >- - An IANA published [media type (MIME - type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - pages: - type: array - description: Visual page layout for the Document. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentPage' - entityRelations: - description: Placeholder. Relationship among Document.entities. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntityRelation - textChanges: + A message providing more details about the current state of + processing. For example, the error message if the operation is + failed. + type: string + individualProcessStatuses: type: array - description: >- - Placeholder. A list of text corrections made to Document.text. This - is usually used for annotating corrections to OCR mistakes. Text - changes for a given revision may not overlap with each other. + description: The list of response details of each document. items: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1beta1DocumentTextChange - text: - description: Optional. UTF-8 encoded text in reading order from the document. + #/components/schemas/GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus + createTime: + description: The creation time of the operation. type: string - entities: - description: >- - A list of entities detected on Document.text. For document shards, - entities in this list may cross shard boundaries. - items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentEntity' - type: array - uri: + format: google-datetime + description: The long-running operation metadata for BatchProcessDocuments. + GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse: + id: GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse + description: Response message for the DeployProcessorVersion method. + type: object + properties: {} + GoogleCloudDocumentaiV1DocumentTextAnchor: + type: object + properties: + content: description: >- - Optional. Currently supports Google Cloud Storage URI of the form - `gs://bucket_name/object_name`. Object versioning is not supported. - For more information, refer to [Google Cloud Storage Request - URIs](https://cloud.google.com/storage/docs/reference-uris). + Contains the content of the text span so that users do not have to + look it up in the text_segments. It is always populated for + formFields. type: string - revisions: - description: Placeholder. Revision history of this document. + textSegments: type: array + description: The text segments from the Document.text. items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1beta1DocumentRevision' - GoogleCloudDocumentaiV1DocumentTextChange: - description: This message is used for text changes aka. OCR corrections. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment + description: Text reference indexing into the Document.text. + id: GoogleCloudDocumentaiV1DocumentTextAnchor + GoogleCloudDocumentaiV1UndeployProcessorVersionRequest: + properties: {} + id: GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + description: Request message for the UndeployProcessorVersion method. + type: object + GoogleCloudDocumentaiV1DocumentPageImageQualityScores: + id: GoogleCloudDocumentaiV1DocumentPageImageQualityScores + type: object properties: - textAnchor: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + qualityScore: + format: float + type: number description: >- - Provenance of the correction. Text anchor indexing into the - Document.text. There can only be a single `TextAnchor.text_segments` - element. If the start and end index of the text segment are the - same, the text change is inserted before that index. - provenance: + The overall quality score. Range `[0, 1]` where `1` is perfect + quality. + detectedDefects: items: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect type: array - description: The history of this annotation. - deprecated: true - changedText: - description: The text that replaces the text identified in the `text_anchor`. + description: A list of detected defects. + description: Image quality scores for the page image. + GoogleCloudDocumentaiV1EvaluationReference: + id: GoogleCloudDocumentaiV1EvaluationReference + type: object + properties: + operation: type: string - id: GoogleCloudDocumentaiV1DocumentTextChange + description: The resource name of the Long Running Operation for the evaluation. + evaluation: + type: string + description: The resource name of the evaluation. + aggregateMetrics: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + description: >- + An aggregate of the statistics for the evaluation with fuzzy + matching on. + aggregateMetricsExact: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationMetrics' + description: >- + An aggregate of the statistics for the evaluation with fuzzy + matching off. + description: >- + Gives a short summary of an evaluation, and links to the evaluation + itself. + GoogleCloudDocumentaiV1ProcessorVersion: + description: >- + A processor version is an implementation of a processor. Each processor + can have multiple versions, pretrained by Google internally or uptrained + by the customer. A processor can only have one default version at a + time. Its document-processing behavior is defined by that version. type: object - GoogleCloudDocumentaiV1DeployProcessorVersionRequest: - id: GoogleCloudDocumentaiV1DeployProcessorVersionRequest - description: Request message for the DeployProcessorVersion method. + id: GoogleCloudDocumentaiV1ProcessorVersion + properties: + satisfiesPzs: + readOnly: true + type: boolean + description: Output only. Reserved for future use. + genAiModelInfo: + description: >- + Output only. Information about Generative AI model-based processor + versions. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo + readOnly: true + documentSchema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentSchema' + description: The schema of the processor version. Describes the output. + satisfiesPzi: + readOnly: true + description: Output only. Reserved for future use. + type: boolean + modelType: + enumDescriptions: + - The processor version has unspecified model type. + - The processor version has generative model type. + - The processor version has custom model type. + readOnly: true + description: Output only. The model type of this processor version. + type: string + enum: + - MODEL_TYPE_UNSPECIFIED + - MODEL_TYPE_GENERATIVE + - MODEL_TYPE_CUSTOM + kmsKeyName: + type: string + description: The KMS key name used for encryption. + googleManaged: + readOnly: true + type: boolean + description: >- + Output only. Denotes that this `ProcessorVersion` is managed by + Google. + createTime: + format: google-datetime + description: The time the processor version was created. + type: string + displayName: + description: The display name of the processor version. + type: string + deprecationInfo: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo + description: If set, information about the eventual deprecation of this version. + kmsKeyVersionName: + description: The KMS key version with which data is encrypted. + type: string + state: + enum: + - STATE_UNSPECIFIED + - DEPLOYED + - DEPLOYING + - UNDEPLOYED + - UNDEPLOYING + - CREATING + - DELETING + - FAILED + - IMPORTING + readOnly: true + description: Output only. The state of the processor version. + type: string + enumDescriptions: + - The processor version is in an unspecified state. + - The processor version is deployed and can be used for processing. + - The processor version is being deployed. + - >- + The processor version is not deployed and cannot be used for + processing. + - The processor version is being undeployed. + - The processor version is being created. + - The processor version is being deleted. + - The processor version failed and is in an indeterminate state. + - The processor version is being imported. + latestEvaluation: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1EvaluationReference' + description: The most recently invoked evaluation for the processor version. + name: + description: >- + Identifier. The resource name of the processor version. Format: + `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + type: string + GoogleCloudDocumentaiV1DisableProcessorResponse: + id: GoogleCloudDocumentaiV1DisableProcessorResponse type: object + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. properties: {} - GoogleCloudDocumentaiV1BatchDocumentsInputConfig: - description: The common config to specify a set of documents used as input. - type: object + GoogleCloudDocumentaiV1EvaluationCounters: properties: - gcsDocuments: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsDocuments' - description: The set of documents individually specified on Cloud Storage. - gcsPrefix: + failedDocumentsCount: description: >- - The set of documents that match the specified Cloud Storage - `gcs_prefix`. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1GcsPrefix' - id: GoogleCloudDocumentaiV1BatchDocumentsInputConfig - GoogleCloudDocumentaiV1TrainProcessorVersionMetadata: + How many documents were not included in the evaluation as Document + AI failed to process them. + type: integer + format: int32 + inputDocumentsCount: + type: integer + format: int32 + description: How many documents were sent for evaluation. + evaluatedDocumentsCount: + type: integer + format: int32 + description: How many documents were used in the evaluation. + invalidDocumentsCount: + type: integer + description: >- + How many documents were not included in the evaluation as they + didn't pass validation. + format: int32 + description: Evaluation counters for the documents that were used. + id: GoogleCloudDocumentaiV1EvaluationCounters type: object + GoogleCloudDocumentaiV1OcrConfigHints: + id: GoogleCloudDocumentaiV1OcrConfigHints + description: Hints for OCR Engine properties: - testDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The test dataset validation information. - trainingDatasetValidation: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation - description: The training dataset validation information. - commonMetadata: - description: The basic metadata of the long-running operation. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1CommonOperationMetadata' - id: GoogleCloudDocumentaiV1TrainProcessorVersionMetadata - description: The metadata that represents a processor version being created. - GoogleCloudLocationListLocationsResponse: - description: The response message for Locations.ListLocations. + languageHints: + description: >- + List of BCP-47 language codes to use for OCR. In most cases, not + specifying it yields the best results since it enables automatic + language detection. For languages based on the Latin alphabet, + setting hints is not needed. In rare cases, when the language of the + text in the image is known, setting a hint will help get better + results (although it will be a significant hindrance if the hint is + wrong). + type: array + items: + type: string + type: object + GoogleTypeDateTime: + id: GoogleTypeDateTime + description: >- + Represents civil time (or occasionally physical time). This type can + represent a civil time in one of a few possible ways: * When utc_offset + is set and time_zone is unset: a civil time on a calendar day with a + particular offset from UTC. * When time_zone is set and utc_offset is + unset: a civil time on a calendar day in a particular time zone. * When + neither time_zone nor utc_offset is set: a civil time on a calendar day + in local time. The date is relative to the Proleptic Gregorian Calendar. + If year, month, or day are 0, the DateTime is considered not to have a + specific year, month, or day respectively. This type may also be used to + represent a physical time if all the date and time fields are set and + either case of the `time_offset` oneof is set. Consider using + `Timestamp` message for physical time instead. If your use case also + would like to store the user's timezone, that can be done in another + field. This type is more flexible than some applications may want. Make + sure to document and validate your application's limitations. type: object - id: GoogleCloudLocationListLocationsResponse properties: - nextPageToken: + minutes: + description: >- + Optional. Minutes of hour of day. Must be from 0 to 59, defaults to + 0. + type: integer + format: int32 + year: + type: integer + format: int32 + description: >- + Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a + datetime without a year. + nanos: + type: integer + description: >- + Optional. Fractions of seconds in nanoseconds. Must be from 0 to + 999,999,999, defaults to 0. + format: int32 + utcOffset: type: string - description: The standard List next-page token. - locations: + format: google-duration description: >- - A list of locations that matches the specified filter in the - request. - items: - $ref: '#/components/schemas/GoogleCloudLocationLocation' - type: array - GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata: - id: GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata - properties: - importConfigValidationResults: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult - description: Validation statuses of the batch documents import config. - type: array - totalDocumentCount: + UTC offset. Must be whole seconds, between -18 hours and +18 hours. + For example, a UTC offset of -4:00 would be represented as { + seconds: -14400 }. + seconds: + format: int32 + type: integer + description: >- + Optional. Seconds of minutes of the time. Must normally be from 0 to + 59, defaults to 0. An API may allow the value 60 if it allows + leap-seconds. + timeZone: + $ref: '#/components/schemas/GoogleTypeTimeZone' + description: Time zone. + hours: + format: int32 + description: >- + Optional. Hours of day in 24 hour format. Should be from 0 to 23, + defaults to 0 (midnight). An API may choose to allow the value + "24:00:00" for scenarios like business closing time. + type: integer + day: + format: int32 + description: >- + Optional. Day of month. Must be from 1 to 31 and valid for the year + and month, or 0 if specifying a datetime without a day. + type: integer + month: format: int32 - description: Total number of the documents that are qualified for importing. type: integer + description: >- + Optional. Month of year. Must be from 1 to 12, or 0 if specifying a + datetime without a month. + GoogleCloudDocumentaiV1EnableProcessorRequest: + id: GoogleCloudDocumentaiV1EnableProcessorRequest + type: object + description: Request message for the EnableProcessor method. + properties: {} + GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata: + type: object + properties: commonMetadata: $ref: >- #/components/schemas/GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata description: The basic metadata of the long-running operation. - individualImportStatuses: - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus - type: array - description: The list of response details of each document. - type: object - description: Metadata of the import document operation. - GoogleCloudDocumentaiV1DocumentPageFormField: + id: GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata + description: Metadata of the EvaluateProcessorVersion method. + GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata: type: object properties: - provenance: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentProvenance' - description: The history of this annotation. - valueType: - description: >- - If the value is non-textual, this field represents the type. Current - valid values are: - blank (this indicates the `field_value` is - normal text) - `unfilled_checkbox` - `filled_checkbox` - type: string - nameDetectedLanguages: - description: A list of detected languages for name together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - correctedKeyText: - type: string - description: >- - Created for Labeling UI to export key text. If corrections were made - to the text identified by the `field_name.text_anchor`, this field - will contain the correction. - valueDetectedLanguages: - description: A list of detected languages for value together with confidence. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DocumentPageDetectedLanguage - fieldName: - description: >- - Layout for the FormField name. e.g. `Address`, `Email`, `Grand - total`, `Phone number`, etc. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - correctedValueText: - description: >- - Created for Labeling UI to export value text. If corrections were - made to the text identified by the `field_value.text_anchor`, this - field will contain the correction. - type: string - fieldValue: - description: Layout for the FormField value. - $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentPageLayout' - description: A form field detected on the page. - id: GoogleCloudDocumentaiV1DocumentPageFormField - GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse: + commonMetadata: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata + description: The basic metadata of the long-running operation. + id: GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata description: >- - Response message for the EnableProcessor method. Intentionally empty - proto for adding fields in future. - properties: {} + The long-running operation metadata for the DeployProcessorVersion + method. + GoogleCloudDocumentaiV1DocumentPageLayout: type: object - id: GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse - GoogleCloudDocumentaiV1DocumentPageDetectedLanguage: - description: Detected language for a structural component. + id: GoogleCloudDocumentaiV1DocumentPageLayout + description: Visual element describing a layout unit on a page. properties: + textAnchor: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + description: Text anchor indexing into the Document.text. + boundingPoly: + description: The bounding polygon for the Layout. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BoundingPoly' + orientation: + enum: + - ORIENTATION_UNSPECIFIED + - PAGE_UP + - PAGE_RIGHT + - PAGE_DOWN + - PAGE_LEFT + description: Detected orientation for the Layout. + type: string + enumDescriptions: + - Unspecified orientation. + - Orientation is aligned with page up. + - >- + Orientation is aligned with page right. Turn the head 90 degrees + clockwise from upright to read. + - >- + Orientation is aligned with page down. Turn the head 180 degrees + from upright to read. + - >- + Orientation is aligned with page left. Turn the head 90 degrees + counterclockwise from upright to read. confidence: + description: >- + Confidence of the current Layout within context of the object this + layout is for. e.g. confidence can be for a single token, a table, a + visual element, etc. depending on context. Range `[0, 1]`. type: number format: float - description: Confidence of detected language. Range `[0, 1]`. - languageCode: - type: string + GoogleCloudDocumentaiV1DocumentSchemaMetadata: + properties: + documentAllowMultipleLabels: description: >- - The [BCP-47 language - code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), - such as `en-US` or `sr-Latn`. - id: GoogleCloudDocumentaiV1DocumentPageDetectedLanguage + If true, on a given page, there can be multiple `document` + annotations covering it. + type: boolean + documentSplitter: + type: boolean + description: >- + If true, a `document` entity type can be applied to subdocument + (splitting). Otherwise, it can only be applied to the entire + document (classification). + skipNamingValidation: + description: >- + If set, we will skip the naming format validation in the schema. So + the string values in `DocumentSchema.EntityType.name` and + `DocumentSchema.EntityType.Property.name` will not be checked. + type: boolean + prefixedNamingOnProperties: + type: boolean + description: If set, all the nested entities must be prefixed with the parents. type: object - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation: - description: >- - The dataset validation information. This includes any and all errors - with documents and the dataset. + description: Metadata for global schema behavior. + id: GoogleCloudDocumentaiV1DocumentSchemaMetadata + GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata: + id: GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata properties: - documentErrors: - description: >- - Error information pertaining to specific documents. A maximum of 10 - document errors will be returned. Any document with errors will not - be used throughout training. + individualBatchDeleteStatuses: type: array + description: The list of response details of each document. items: - $ref: '#/components/schemas/GoogleRpcStatus' - datasetErrors: - items: - $ref: '#/components/schemas/GoogleRpcStatus' - type: array - description: >- - Error information for the dataset as a whole. A maximum of 10 - dataset errors will be returned. A single dataset error is terminal - for training. - datasetErrorCount: - description: The total number of dataset errors. - type: integer - format: int32 - documentErrorCount: - description: The total number of document errors. + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus + totalDocumentCount: + type: integer format: int32 + description: Total number of documents deleting from dataset. + errorDocumentCount: type: integer - type: object - id: >- - GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation - GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata: - id: GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata - description: The long-running operation metadata for the ReviewDocument method. - properties: - questionId: - description: The Crowd Compute question ID. - type: string - updateTime: - description: The last update time of the operation. - type: string - format: google-datetime + description: Total number of documents that failed to be deleted in storage. + format: int32 commonMetadata: - description: The basic metadata of the long-running operation. $ref: >- #/components/schemas/GoogleCloudDocumentaiV1beta3CommonOperationMetadata - stateMessage: + description: The basic metadata of the long-running operation. + type: object + GoogleCloudDocumentaiV1DocumentStyle: + id: GoogleCloudDocumentaiV1DocumentStyle + properties: + fontSize: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentStyleFontSize' + description: Font size. + textDecoration: type: string description: >- - A message providing more details about the current state of - processing. For example, the error message if the operation is - failed. - createTime: + [Text + decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). + Follows CSS standard. + color: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text color. + fontWeight: + description: >- + [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). + Possible values are `normal`, `bold`, `bolder`, and `lighter`. type: string - description: The creation time of the operation. - format: google-datetime - state: - enumDescriptions: - - Unspecified state. - - Operation is still running. - - Operation is being cancelled. - - Operation succeeded. - - Operation failed. - - Operation is cancelled. + backgroundColor: + $ref: '#/components/schemas/GoogleTypeColor' + description: Text background color. + fontFamily: + description: >- + Font family such as `Arial`, `Times New Roman`. + https://www.w3schools.com/cssref/pr_font_font-family.asp type: string - description: Used only when Operation.done is false. - enum: - - STATE_UNSPECIFIED - - RUNNING - - CANCELLING - - SUCCEEDED - - FAILED - - CANCELLED + textStyle: + type: string + description: >- + [Text + style](https://www.w3schools.com/cssref/pr_font_font-style.asp). + Possible values are `normal`, `italic`, and `oblique`. + textAnchor: + description: Text anchor indexing into the Document.text. + $ref: '#/components/schemas/GoogleCloudDocumentaiV1DocumentTextAnchor' + type: object + description: >- + Annotation for common text style attributes. This adheres to CSS + conventions as much as possible. + GoogleCloudDocumentaiV1beta3DisableProcessorResponse: type: object + properties: {} + id: GoogleCloudDocumentaiV1beta3DisableProcessorResponse + description: >- + Response message for the DisableProcessor method. Intentionally empty + proto for adding fields in future. parameters: prettyPrint: description: Returns response with indentations and line breaks. @@ -7403,22 +5069,27 @@ components: name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. + _.xgafv: + description: V1 error format. in: query - name: access_token + name: $.xgafv schema: type: string - alt: - description: Data format for response. + enum: + - '1' + - '2' + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: alt + name: upload_protocol + schema: + type: string + callback: + description: JSONP + in: query + name: callback schema: type: string - enum: - - json - - media - - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -7428,54 +5099,49 @@ components: name: key schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: oauth_token + name: fields schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: quotaUser + name: oauth_token schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + alt: + description: Data format for response. in: query - name: fields + name: alt schema: type: string + enum: + - json + - media + - proto uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - callback: - description: JSONP + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: callback + name: quotaUser schema: type: string - _.xgafv: - description: V1 error format. + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token schema: type: string - enum: - - '1' - - '2' x-stackQL-resources: operations: id: google.documentai.operations @@ -7488,24 +5154,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_operations_cancel: + projects_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_operations_list: - operation: &ref_1 + projects_locations_operations_cancel: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations - projects_locations_operations_list: - operation: *ref_1 - response: *ref_2 projects_locations_operations_get: operation: $ref: >- @@ -7513,150 +5175,95 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_operations_get: + projects_locations_operations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_delete - processor_types: - id: google.documentai.processor_types - name: processor_types - title: Processor_types + locations: + id: google.documentai.locations + name: locations + title: Locations methods: - projects_locations_processor_types_get: + projects_locations_get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes~1{processorTypesId}/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_processor_types_list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.processorTypes - projects_locations_processor_types_list: - operation: *ref_3 - response: *ref_4 - projects_locations_fetch_processor_types: + projects_locations_list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:fetchProcessorTypes/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.locations sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_get + #/components/x-stackQL-resources/locations/methods/projects_locations_get - $ref: >- - #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_list + #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] - processors: - id: google.documentai.processors - name: processors - title: Processors - methods: - projects_locations_processors_batch_process: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processors_enable: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processors_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processors_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processors_process: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_processors_create: + processor_types: + id: google.documentai.processor_types + name: processor_types + title: Processor_types + methods: + projects_locations_fetch_processor_types: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}:fetchProcessorTypes/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_processors_list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.processors - projects_locations_processors_list: - operation: *ref_5 - response: *ref_6 - projects_locations_processors_set_default_processor_version: + projects_locations_processor_types_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes~1{processorTypesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_disable: + projects_locations_processor_types_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processorTypes/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.processorTypes sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_get + #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_get - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_list - insert: + #/components/x-stackQL-resources/processor_types/methods/projects_locations_fetch_processor_types - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_create + #/components/x-stackQL-resources/processor_types/methods/projects_locations_processor_types_list + insert: [] update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete + replace: [] + delete: [] human_review_config: id: google.documentai.human_review_config name: human_review_config @@ -7673,30 +5280,28 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] evaluations: id: google.documentai.evaluations name: evaluations title: Evaluations methods: - _projects_locations_processors_processor_versions_evaluations_list: - operation: &ref_7 + projects_locations_processors_processor_versions_evaluations_get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.evaluations projects_locations_processors_processor_versions_evaluations_list: - operation: *ref_7 - response: *ref_8 - projects_locations_processors_processor_versions_evaluations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations~1{evaluationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}~1evaluations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.evaluations sqlVerbs: select: - $ref: >- @@ -7705,76 +5310,74 @@ components: #/components/x-stackQL-resources/evaluations/methods/projects_locations_processors_processor_versions_evaluations_list insert: [] update: [] + replace: [] delete: [] processor_versions: id: google.documentai.processor_versions name: processor_versions title: Processor_versions methods: - projects_locations_processors_processor_versions_evaluate_processor_version: + projects_locations_processors_processor_versions_batch_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_process: + projects_locations_processors_processor_versions_deploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_delete: + projects_locations_processors_processor_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_get: + projects_locations_processors_processor_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_batch_process: + projects_locations_processors_processor_versions_undeploy: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:batchProcess/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_train: + projects_locations_processors_processor_versions_process: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:process/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_processors_processor_versions_undeploy: + projects_locations_processors_processor_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:undeploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_processors_processor_versions_list: - operation: &ref_9 + objectKey: $.processorVersions + projects_locations_processors_processor_versions_evaluate_processor_version: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions/get - response: &ref_10 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:evaluateProcessorVersion/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.processorVersions - projects_locations_processors_processor_versions_list: - operation: *ref_9 - response: *ref_10 - projects_locations_processors_processor_versions_deploy: + projects_locations_processors_processor_versions_train: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions~1{processorVersionsId}:deploy/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}~1processorVersions:train/post response: mediaType: application/json openAPIDocKey: '200' @@ -7786,53 +5389,107 @@ components: #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/processor_versions/methods/projects_locations_processors_processor_versions_delete - locations: - id: google.documentai.locations - name: locations - title: Locations + processors: + id: google.documentai.processors + name: processors + title: Processors methods: - projects_locations_get: + projects_locations_processors_list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_list: - operation: &ref_11 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_12 + objectKey: $.processors + projects_locations_processors_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_enable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_set_default_processor_version: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:setDefaultProcessorVersion/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_batch_process: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:batchProcess/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_disable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_processors_process: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1processors~1{processorsId}:process/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.locations - projects_locations_list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_get - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - insert: [] + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_list + insert: + - $ref: >- + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_create update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/processors/methods/projects_locations_processors_delete paths: /v1/operations/{operationsId}: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/access_token' delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -7858,20 +5515,14 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_13 - post: + /v1/projects/{projectsId}/operations/{operationsId}: + parameters: *ref_1 + get: description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: documentai.projects.locations.operations.cancel + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: documentai.projects.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7883,30 +5534,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: path name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: documentai.projects.locations.operations.list + description: Gets information about a location. + operationId: documentai.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7918,7 +5562,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleCloudLocationLocation' parameters: - in: path name: projectsId @@ -7930,8 +5574,31 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations: + parameters: *ref_1 + get: + description: Lists information about the supported locations for this service. + operationId: documentai.projects.locations.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: query - name: pageToken + name: filter schema: type: string - in: query @@ -7940,17 +5607,16 @@ paths: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: + parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: documentai.projects.locations.operations.get + Fetches processor types. Note that we don't use ListProcessorTypes here, + because it isn't paginated. + operationId: documentai.projects.locations.fetchProcessorTypes security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7962,7 +5628,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse parameters: - in: path name: projectsId @@ -7974,13 +5641,8 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/processorTypes/{processorTypesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a processor type detail. operationId: documentai.projects.locations.processorTypes.get @@ -8013,7 +5675,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/processorTypes: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists the processor types that exist. operationId: documentai.projects.locations.processorTypes.list @@ -8050,18 +5712,20 @@ paths: name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 post: description: >- - LRO endpoint to batch process many documents. The output is written to - Cloud Storage as JSON in the [Document] format. - operationId: documentai.projects.locations.processors.batchProcess - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: documentai.projects.locations.operations.cancel security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8073,7 +5737,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -8086,21 +5750,18 @@ paths: schema: type: string - in: path - name: processorsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: - parameters: *ref_13 - post: - description: Enables a processor - operationId: documentai.projects.locations.processors.enable - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest + /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: documentai.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8125,17 +5786,17 @@ paths: schema: type: string - in: path - name: processorsId + name: operationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: - parameters: *ref_13 - delete: + /v1/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 + get: description: >- - Deletes the processor, unloads all deployed model artifacts if it was - enabled and then deletes all artifacts associated with this processor. - operationId: documentai.projects.locations.processors.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: documentai.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8147,7 +5808,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -8159,14 +5820,33 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true + - in: query + name: pageToken schema: type: string - get: - description: Gets a processor detail. - operationId: documentai.projects.locations.processors.get + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: + parameters: *ref_1 + post: + description: >- + Send a document for Human Review. The input document should be processed + by the specified processor. + operationId: >- + documentai.projects.locations.processors.humanReviewConfig.reviewDocument + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8178,7 +5858,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8195,16 +5875,12 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: - parameters: *ref_13 - post: - description: Processes a single document. - operationId: documentai.projects.locations.processors.process - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}: + parameters: *ref_1 + get: + description: Retrieves a specific evaluation. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8216,7 +5892,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' parameters: - in: path name: projectsId @@ -8233,44 +5909,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors: - parameters: *ref_13 - post: - description: >- - Creates a processor from the ProcessorType provided. The processor will - be at `ENABLED` state by default after its creation. - operationId: documentai.projects.locations.processors.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' - parameters: - in: path - name: projectsId + name: processorVersionsId required: true schema: type: string - in: path - name: locationsId + name: evaluationsId required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: + parameters: *ref_1 get: - description: Lists all processors which belong to this project. - operationId: documentai.projects.locations.processors.list + description: Retrieves a set of evaluations for a given processor version. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8283,7 +5937,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse + #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse parameters: - in: path name: projectsId @@ -8295,67 +5949,37 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: - parameters: *ref_13 - post: - description: >- - Set the default (active) version of a Processor that will be used in - ProcessDocument and BatchProcessDocuments. - operationId: documentai.projects.locations.processors.setDefaultProcessorVersion - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - in: path - name: projectsId + name: processorsId required: true schema: type: string - in: path - name: locationsId + name: processorVersionsId required: true schema: type: string - - in: path - name: processorsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: - parameters: *ref_13 + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: + parameters: *ref_1 post: - description: Disables a processor - operationId: documentai.projects.locations.processors.disable + description: >- + LRO endpoint to batch process many documents. The output is written to + Cloud Storage as JSON in the [Document] format. + operationId: documentai.projects.locations.processors.processorVersions.batchProcess requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8384,20 +6008,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/humanReviewConfig:reviewDocument: - parameters: *ref_13 + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy: + parameters: *ref_1 post: - description: >- - Send a document for Human Review. The input document should be processed - by the specified processor. - operationId: >- - documentai.projects.locations.processors.humanReviewConfig.reviewDocument + description: Deploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.deploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ReviewDocumentRequest + #/components/schemas/GoogleCloudDocumentaiV1DeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8426,12 +6052,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations: - parameters: *ref_13 + - in: path + name: processorVersionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}: + parameters: *ref_1 get: - description: Retrieves a set of evaluations for a given processor version. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.list + description: Gets a processor version detail. + operationId: documentai.projects.locations.processors.processorVersions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8443,8 +6073,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListEvaluationsResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' parameters: - in: path name: projectsId @@ -8466,21 +6095,11 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}/evaluations/{evaluationsId}: - parameters: *ref_13 - get: - description: Retrieves a specific evaluation. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluations.get + delete: + description: >- + Deletes the processor version, all artifacts under the processor version + will be deleted. + operationId: documentai.projects.locations.processors.processorVersions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8492,7 +6111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1Evaluation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8514,25 +6133,17 @@ paths: required: true schema: type: string - - in: path - name: evaluationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: + parameters: *ref_1 post: - description: >- - Evaluates a ProcessorVersion against annotated documents, producing an - Evaluation. - operationId: >- - documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion + description: Undeploys the processor version. + operationId: documentai.projects.locations.processors.processorVersions.undeploy requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8567,7 +6178,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:process: - parameters: *ref_13 + parameters: *ref_1 post: description: Processes a single document. operationId: documentai.projects.locations.processors.processorVersions.process @@ -8609,13 +6220,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}: - parameters: *ref_13 - delete: - description: >- - Deletes the processor version, all artifacts under the processor version - will be deleted. - operationId: documentai.projects.locations.processors.processorVersions.delete + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: + parameters: *ref_1 + get: + description: Lists all versions of a processor. + operationId: documentai.projects.locations.processors.processorVersions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8627,7 +6236,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse parameters: - in: path name: projectsId @@ -8644,14 +6254,29 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - get: - description: Gets a processor version detail. - operationId: documentai.projects.locations.processors.processorVersions.get + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:evaluateProcessorVersion: + parameters: *ref_1 + post: + description: >- + Evaluates a ProcessorVersion against annotated documents, producing an + Evaluation. + operationId: >- + documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8663,7 +6288,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessorVersion' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8685,18 +6310,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:batchProcess: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: + parameters: *ref_1 post: description: >- - LRO endpoint to batch process many documents. The output is written to - Cloud Storage as JSON in the [Document] format. - operationId: documentai.projects.locations.processors.processorVersions.batchProcess + Trains a new processor version. Operation metadata is returned as + TrainProcessorVersionMetadata. + operationId: documentai.projects.locations.processors.processorVersions.train requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8725,24 +6351,58 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors: + parameters: *ref_1 + get: + description: Lists all processors which belong to this project. + operationId: documentai.projects.locations.processors.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1ListProcessorsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: path - name: processorVersionsId + name: locationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions:train: - parameters: *ref_13 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: description: >- - Trains a new processor version. Operation metadata is returned as - TrainProcessorVersionMetadata. - operationId: documentai.projects.locations.processors.processorVersions.train + Creates a processor from the ProcessorType provided. The processor will + be at `ENABLED` state by default after its creation. Note that this + method requires the `documentai.processors.create` permission on the + project, which is highly privileged. A user or service account with this + permission can create new processors that can interact with any gcs + bucket in your project. + operationId: documentai.projects.locations.processors.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1TrainProcessorVersionRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8754,7 +6414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -8766,22 +6426,17 @@ paths: required: true schema: type: string - - in: path - name: processorsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:undeploy: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:enable: + parameters: *ref_1 post: - description: Undeploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.undeploy + description: Enables a processor + operationId: documentai.projects.locations.processors.enable requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1UndeployProcessorVersionRequest + #/components/schemas/GoogleCloudDocumentaiV1EnableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8810,16 +6465,19 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions: - parameters: *ref_13 - get: - description: Lists all versions of a processor. - operationId: documentai.projects.locations.processors.processorVersions.list + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:setDefaultProcessorVersion: + parameters: *ref_1 + post: + description: >- + Set the default (active) version of a Processor that will be used in + ProcessDocument and BatchProcessDocuments. + operationId: documentai.projects.locations.processors.setDefaultProcessorVersion + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8831,8 +6489,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1ListProcessorVersionsResponse + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8849,26 +6506,18 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/processorVersions/{processorVersionsId}:deploy: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:batchProcess: + parameters: *ref_1 post: - description: Deploys the processor version. - operationId: documentai.projects.locations.processors.processorVersions.deploy + description: >- + LRO endpoint to batch process many documents. The output is written to + Cloud Storage as JSON in the [Document] format. + operationId: documentai.projects.locations.processors.batchProcess requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1DeployProcessorVersionRequest + $ref: '#/components/schemas/GoogleCloudDocumentaiV1BatchProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8897,18 +6546,11 @@ paths: required: true schema: type: string - - in: path - name: processorVersionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}:fetchProcessorTypes: - parameters: *ref_13 + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}: + parameters: *ref_1 get: - description: >- - Fetches processor types. Note that we don't use ListProcessorTypes here, - because it isn't paginated. - operationId: documentai.projects.locations.fetchProcessorTypes + description: Gets a processor detail. + operationId: documentai.projects.locations.processors.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8920,8 +6562,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudDocumentaiV1FetchProcessorTypesResponse + $ref: '#/components/schemas/GoogleCloudDocumentaiV1Processor' parameters: - in: path name: projectsId @@ -8933,11 +6574,16 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_13 - get: - description: Gets information about a location. - operationId: documentai.projects.locations.get + - in: path + name: processorsId + required: true + schema: + type: string + delete: + description: >- + Deletes the processor, unloads all deployed model artifacts if it was + enabled and then deletes all artifacts associated with this processor. + operationId: documentai.projects.locations.processors.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8949,7 +6595,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationLocation' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -8961,11 +6607,22 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations: - parameters: *ref_13 - get: - description: Lists information about the supported locations for this service. - operationId: documentai.projects.locations.list + - in: path + name: processorsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:disable: + parameters: *ref_1 + post: + description: Disables a processor + operationId: documentai.projects.locations.processors.disable + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudDocumentaiV1DisableProcessorRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8977,34 +6634,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudLocationListLocationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: filter + - in: path + name: processorsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_13 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: documentai.projects.operations.get + /v1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}:process: + parameters: *ref_1 + post: + description: Processes a single document. + operationId: documentai.projects.locations.processors.process + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -9016,7 +6672,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudDocumentaiV1ProcessResponse' parameters: - in: path name: projectsId @@ -9024,7 +6680,12 @@ paths: schema: type: string - in: path - name: operationsId + name: locationsId + required: true + schema: + type: string + - in: path + name: processorsId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/domains.yaml b/providers/src/googleapis.com/v00.00.00000/services/domains.yaml index f2e84886..1a93dfb8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/domains.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/domains.yaml @@ -7,8 +7,8 @@ info: title: Cloud Domains API description: Enables management and configuration of domain names. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240821' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/domains/ servers: @@ -450,11 +450,21 @@ components: The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account. + - >- + The registry failed to validate your DNS configuration and + activate your domain. The failure might happen for the following + reasons: * You recently registered the domain (wait up to 72 + hours). * You provided invalid name servers or name servers that + correspond to a newly created DNS zone. Verify your DNS + configuration. If the configuration is incorrect, you must fix + it. If the configuration is correct, either wait or call the + ConfigureDnsSettings method to retry the registry validation. enum: - ISSUE_UNSPECIFIED - CONTACT_SUPPORT - UNVERIFIED_EMAIL - PROBLEM_WITH_BILLING + - DNS_NOT_ACTIVATED labels: description: Set of labels associated with the `Registration`. type: object @@ -595,6 +605,33 @@ components: - INVALID_REGISTRANT_EMAIL_ADDRESS - DOMAIN_NOT_ELIGIBLE_FOR_TRANSFER - TRANSFER_ALREADY_PENDING + domainProperties: + description: Output only. Special properties of the domain. + readOnly: true + type: array + items: + type: string + enumDescriptions: + - The property is undefined. + - >- + The domain does not support transfer locks due to restrictions + of the registry. Such domains are effectively always unlocked + and any change made to `management_settings.transfer_lock_state` + is ignored. + - >- + The domain uses an alternative `Push Transfer` process to + transfer the domain to another registrar. There are two + important consequences: * Cloud Domains does not supply the + authorization codes. * To initiate the process to transfer the + domain to another registrar, you must provide a tag of the + registrar you want to transfer to. You can do this by using the + `InitiatePushTransfer` method. For more information, see + [Transfer a registered domain to another + registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar). + enum: + - DOMAIN_PROPERTY_UNSPECIFIED + - TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY + - REQUIRE_PUSH_TRANSFER ManagementSettings: id: ManagementSettings description: Defines renewal, billing, and transfer settings for a `Registration`. @@ -672,7 +709,29 @@ components: description: >- This is the desired transfer lock state for this `Registration`. A transfer lock controls whether the domain can be transferred to - another registrar. + another registrar. The transfer lock state of the domain is returned + in the `effective_transfer_lock_state` property. The transfer lock + state values might be different for the following reasons: * + `transfer_lock_state` was updated only a short time ago. * Domains + with the `TRANSFER_LOCK_UNSUPPORTED_BY_REGISTRY` state are in the + list of `domain_properties`. These domains are always in the + `UNLOCKED` state. + type: string + enumDescriptions: + - The state is unspecified. + - >- + The domain is unlocked and can be transferred to another + registrar. + - >- + The domain is locked and cannot be transferred to another + registrar. + enum: + - TRANSFER_LOCK_STATE_UNSPECIFIED + - UNLOCKED + - LOCKED + effectiveTransferLockState: + description: Output only. The actual transfer lock state for this `Registration`. + readOnly: true type: string enumDescriptions: - The state is unspecified. @@ -709,6 +768,20 @@ components: type: array items: $ref: '#/components/schemas/GlueRecord' + googleDomainsRedirectsDataAvailable: + description: >- + Output only. Indicates if this `Registration` has configured one of + the following deprecated Google Domains DNS features: * Domain + forwarding (HTTP `301` and `302` response status codes), * Email + forwarding. See + https://cloud.google.com/domains/docs/deprecations/feature-deprecations + for more details. If any of these features is enabled call the + `RetrieveGoogleDomainsForwardingConfig` method to get details about + the feature's configuration. A forwarding configuration might not + work correctly if required DNS records are not present in the + domain's authoritative DNS Zone. + readOnly: true + type: boolean CustomDns: id: CustomDns description: Configuration for an arbitrary DNS provider. @@ -1373,6 +1446,371 @@ components: validateOnly: description: Validate the request without actually updating the DNS settings. type: boolean + RetrieveGoogleDomainsDnsRecordsResponse: + id: RetrieveGoogleDomainsDnsRecordsResponse + description: Response for the `RetrieveGoogleDomainsDnsRecords` method. + type: object + properties: + rrset: + description: The resource record set resources (DNS Zone records). + type: array + items: + $ref: '#/components/schemas/ResourceRecordSet' + nextPageToken: + description: >- + When present, there are more results to retrieve. Set `page_token` + to this value on a subsequent call to get the next page of results. + type: string + ResourceRecordSet: + id: ResourceRecordSet + description: A unit of data that is returned by the DNS servers. + type: object + properties: + name: + description: For example, www.example.com. + type: string + type: + description: >- + The identifier of a supported record type. See the list of Supported + DNS record types. + type: string + ttl: + description: >- + Number of seconds that this `ResourceRecordSet` can be cached by + resolvers. + type: integer + format: int32 + rrdata: + description: >- + As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- + see examples. + type: array + items: + type: string + signatureRrdata: + description: As defined in RFC 4034 (section 3.2). + type: array + items: + type: string + routingPolicy: + description: >- + Configures dynamic query responses based on either the geo location + of the querying user or a weighted round robin based routing policy. + A valid `ResourceRecordSet` contains only `rrdata` (for static + resolution) or a `routing_policy` (for dynamic resolution). + $ref: '#/components/schemas/RRSetRoutingPolicy' + RRSetRoutingPolicy: + id: RRSetRoutingPolicy + description: >- + A RRSetRoutingPolicy represents ResourceRecordSet data that is returned + dynamically with the response varying based on configured properties + such as geolocation or by weighted random selection. + type: object + properties: + geoPolicy: + deprecated: true + $ref: '#/components/schemas/GeoPolicy' + wrrPolicy: + deprecated: true + $ref: '#/components/schemas/WrrPolicy' + geo: + $ref: '#/components/schemas/GeoPolicy' + wrr: + $ref: '#/components/schemas/WrrPolicy' + primaryBackup: + $ref: '#/components/schemas/PrimaryBackupPolicy' + healthCheck: + description: >- + The selfLink attribute of the HealthCheck resource to use for this + RRSetRoutingPolicy. + https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks + type: string + GeoPolicy: + id: GeoPolicy + description: >- + Configures a `RRSetRoutingPolicy` that routes based on the geo location + of the querying user. + type: object + properties: + item: + description: >- + The primary geo routing configuration. If there are multiple items + with the same location, an error is returned instead. + type: array + items: + $ref: '#/components/schemas/GeoPolicyItem' + enableFencing: + description: >- + Without fencing, if health check fails for all configured items in + the current geo bucket, we failover to the next nearest geo bucket. + With fencing, if health checking is enabled, as long as some targets + in the current geo bucket are healthy, we return only the healthy + targets. However, if all targets are unhealthy, we don't failover to + the next nearest bucket; instead, we return all the items in the + current bucket even when all targets are unhealthy. + type: boolean + GeoPolicyItem: + id: GeoPolicyItem + description: ResourceRecordSet data for one geo location. + type: object + properties: + location: + description: >- + The geo-location granularity is a GCP region. This location string + should correspond to a GCP region. e.g. "us-east1", + "southamerica-east1", "asia-east1", etc. + type: string + rrdata: + type: array + items: + type: string + signatureRrdata: + description: >- + DNSSEC generated signatures for all the `rrdata` within this item. + If health checked targets are provided for DNSSEC enabled zones, + there's a restriction of 1 IP address per item. + type: array + items: + type: string + healthCheckedTargets: + description: >- + For A and AAAA types only. Endpoints to return in the query result + only if they are healthy. These can be specified along with `rrdata` + within this item. + $ref: '#/components/schemas/HealthCheckTargets' + HealthCheckTargets: + id: HealthCheckTargets + description: >- + HealthCheckTargets describes endpoints to health-check when responding + to Routing Policy queries. Only the healthy endpoints will be included + in the response. + type: object + properties: + internalLoadBalancer: + description: Configuration for internal load balancers to be health checked. + type: array + items: + $ref: '#/components/schemas/LoadBalancerTarget' + externalEndpoints: + description: >- + The Internet IP addresses to be health checked. The format matches + the format of ResourceRecordSet.rrdata as defined in RFC 1035 + (section 5) and RFC 1034 (section 3.6.1) + type: array + items: + type: string + LoadBalancerTarget: + id: LoadBalancerTarget + description: The configuration for an individual load balancer to health check. + type: object + properties: + loadBalancerType: + description: >- + The type of load balancer specified by this target. This value must + match the configuration of the load balancer located at the + LoadBalancerTarget's IP address, port, and region. Use the + following: - *regionalL4ilb*: for a regional internal passthrough + Network Load Balancer. - *regionalL7ilb*: for a regional internal + Application Load Balancer. - *globalL7ilb*: for a global internal + Application Load Balancer. + type: string + enumDescriptions: + - '' + - >- + Indicates the load balancer is a Cross-Region Application Load + Balancer. + - >- + Indicates the load balancer is a Regional Network Passthrough Load + Balancer. + - >- + Indicates the load balancer is a Regional Application Load + Balancer. + enum: + - NONE + - GLOBAL_L7ILB + - REGIONAL_L4ILB + - REGIONAL_L7ILB + ipAddress: + description: The frontend IP address of the load balancer to health check. + type: string + port: + description: The configured port of the load balancer. + type: string + ipProtocol: + description: The protocol of the load balancer to health check. + type: string + enumDescriptions: + - '' + - Indicates the load balancer is accessible via TCP. + - Indicates the load balancer is accessible via UDP. + enum: + - UNDEFINED + - TCP + - UDP + networkUrl: + description: >- + The fully qualified URL of the network that the load balancer is + attached to. This should be formatted like + `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`. + type: string + project: + description: The project ID in which the load balancer is located. + type: string + region: + description: The region in which the load balancer is located. + type: string + WrrPolicy: + id: WrrPolicy + description: >- + Configures a RRSetRoutingPolicy that routes in a weighted round robin + fashion. + type: object + properties: + item: + type: array + items: + $ref: '#/components/schemas/WrrPolicyItem' + WrrPolicyItem: + id: WrrPolicyItem + description: A routing block which contains the routing information for one WRR item. + type: object + properties: + weight: + description: >- + The weight corresponding to this `WrrPolicyItem` object. When + multiple `WrrPolicyItem` objects are configured, the probability of + returning an `WrrPolicyItem` object's data is proportional to its + weight relative to the sum of weights configured for all items. This + weight must be non-negative. + type: number + format: double + rrdata: + type: array + items: + type: string + signatureRrdata: + description: >- + DNSSEC generated signatures for all the `rrdata` within this item. + Note that if health checked targets are provided for DNSSEC enabled + zones, there's a restriction of 1 IP address per item. + type: array + items: + type: string + healthCheckedTargets: + description: >- + Endpoints that are health checked before making the routing + decision. The unhealthy endpoints are omitted from the result. If + all endpoints within a bucket are unhealthy, we choose a different + bucket (sampled with respect to its weight) for responding. If + DNSSEC is enabled for this zone, only one of `rrdata` or + `health_checked_targets` can be set. + $ref: '#/components/schemas/HealthCheckTargets' + PrimaryBackupPolicy: + id: PrimaryBackupPolicy + description: >- + Configures a RRSetRoutingPolicy such that all queries are responded with + the primary_targets if they are healthy. And if all of them are + unhealthy, then we fallback to a geo localized policy. + type: object + properties: + primaryTargets: + description: >- + Endpoints that are health checked before making the routing + decision. Unhealthy endpoints are omitted from the results. If all + endpoints are unhealthy, we serve a response based on the + `backup_geo_targets`. + $ref: '#/components/schemas/HealthCheckTargets' + backupGeoTargets: + description: >- + Backup targets provide a regional failover policy for the otherwise + global primary targets. If serving state is set to `BACKUP`, this + policy essentially becomes a geo routing policy. + $ref: '#/components/schemas/GeoPolicy' + trickleTraffic: + description: >- + When serving state is `PRIMARY`, this field provides the option of + sending a small percentage of the traffic to the backup targets. + type: number + format: double + RetrieveGoogleDomainsForwardingConfigResponse: + id: RetrieveGoogleDomainsForwardingConfigResponse + description: Response for the `RetrieveGoogleDomainsForwardingConfig` method. + type: object + properties: + domainForwardings: + description: >- + The list of domain forwarding configurations. A forwarding + configuration might not work correctly if the required DNS records + are not present in the domain's authoritative DNS zone. + type: array + items: + $ref: '#/components/schemas/DomainForwarding' + emailForwardings: + description: >- + The list of email forwarding configurations. A forwarding + configuration might not work correctly if the required DNS records + are not present in the domain's authoritative DNS zone. + type: array + items: + $ref: '#/components/schemas/EmailForwarding' + DomainForwarding: + id: DomainForwarding + description: Domain forwarding configuration. + type: object + properties: + subdomain: + description: >- + The subdomain of the registered domain that is being forwarded. E.g. + `www.example.com`, `example.com` (i.e. the registered domain itself) + or `*.example.com` (i.e. all subdomains). + type: string + targetUri: + description: >- + The target of the domain forwarding, i.e. the path to redirect the + `subdomain` to. + type: string + redirectType: + description: The redirect type. + type: string + enumDescriptions: + - Redirect Type is unspecified. + - >- + 301 redirect. Allows to propagate changes to the forwarding + address quickly. + - >- + 302 redirect. Allows browsers to cache the forwarding address. + This may help the address resolve more quickly. Changes may take + longer to propagate + enum: + - REDIRECT_TYPE_UNSPECIFIED + - TEMPORARY + - PERMANENT + pathForwarding: + description: >- + If true, forwards the path after the domain name to the same path at + the new address. + type: boolean + sslEnabled: + description: If true, the forwarding works also over HTTPS. + type: boolean + pemCertificate: + description: The PEM-encoded certificate chain. + type: string + EmailForwarding: + id: EmailForwarding + description: Email forwarding configuration. + type: object + properties: + alias: + description: >- + An alias recipient email that forwards emails to the + `target_email_address`. For example, `admin@example.com` or + `*@example.com` (wildcard alias forwards all the emails under the + registered domain). + type: string + targetEmailAddress: + description: Target email that receives emails sent to the `alias`. + type: string ConfigureContactSettingsRequest: id: ConfigureContactSettingsRequest description: Request for the `ConfigureContactSettings` method. @@ -1421,55 +1859,34 @@ components: description: Request for the `ResetAuthorizationCode` method. type: object properties: {} - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. + InitiatePushTransferRequest: + id: InitiatePushTransferRequest + description: Request for the `InitiatePushTransfer` method. type: object properties: - locations: + tag: description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. + Required. The Tag of the new registrar. Can be found at [List of + registrars](https://nominet.uk/registrar-list/). type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. + RenewDomainRequest: + id: RenewDomainRequest + description: Request for the `RenewDomain` method. type: object properties: - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: + yearlyPrice: description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: + Required. Acknowledgement of the price to renew the domain for one + year. To get the price, see [Cloud Domains + pricing](https://cloud.google.com/domains/pricing). If not provided, + the expected price is returned in the error message. + $ref: '#/components/schemas/Money' + validateOnly: description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. + Optional. When true, only validation is performed, without actually + renewing the domain. For more information, see [Request + validation](https://cloud.google.com/apis/design/design_patterns#request_validation) + type: boolean SetIamPolicyRequest: id: SetIamPolicyRequest description: Request message for `SetIamPolicy` method. @@ -1802,6 +2219,55 @@ components: type: array items: type: string + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. + type: object + properties: + locations: + description: >- + A list of locations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/Location' + nextPageToken: + description: The standard List next-page token. + type: string + Location: + id: Location + description: A resource that represents a Google Cloud location. + type: object + properties: + name: + description: >- + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` + type: string + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' + type: string + displayName: + description: >- + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". + type: string + labels: + description: >- + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} + type: object + additionalProperties: + type: string + metadata: + description: >- + Service-specific metadata. For example the available capacity at the + given location. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. OperationMetadata: id: OperationMetadata description: Represents the metadata of the long-running operation. Output only. @@ -1913,16 +2379,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1935,23 +2398,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.domains.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1965,6 +2426,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] registrations: id: google.domains.registrations @@ -1999,17 +2461,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1registrations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.registrations - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -2066,6 +2525,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + initiate_push_transfer: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1registrations~1{registrationsId}:initiatePushTransfer/post + response: + mediaType: application/json + openAPIDocKey: '200' + renew_domain: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1registrations~1{registrationsId}:renewDomain/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/registrations/methods/get' @@ -2073,6 +2546,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/registrations/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/registrations/methods/delete' registrations_register_parameters: @@ -2088,9 +2562,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/registrations_register_parameters/methods/retrieve_register_parameters insert: [] update: [] + replace: [] delete: [] registrations_transfer_parameters: id: google.domains.registrations_transfer_parameters @@ -2105,9 +2582,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/registrations_transfer_parameters/methods/retrieve_transfer_parameters insert: [] update: [] + replace: [] delete: [] registrations_importable_domains: id: google.domains.registrations_importable_domains @@ -2122,9 +2602,52 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/registrations_importable_domains/methods/retrieve_importable_domains insert: [] update: [] + replace: [] + delete: [] + registrations_google_domains_dns_records: + id: google.domains.registrations_google_domains_dns_records + name: registrations_google_domains_dns_records + title: Registrations_google_domains_dns_records + methods: + retrieve_google_domains_dns_records: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1registrations~1{registrationsId}:retrieveGoogleDomainsDnsRecords/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/registrations_google_domains_dns_records/methods/retrieve_google_domains_dns_records + insert: [] + update: [] + replace: [] + delete: [] + registrations_google_domains_forwarding_config: + id: google.domains.registrations_google_domains_forwarding_config + name: registrations_google_domains_forwarding_config + title: Registrations_google_domains_forwarding_config + methods: + retrieve_google_domains_forwarding_config: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1registrations~1{registrationsId}:retrieveGoogleDomainsForwardingConfig/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/registrations_google_domains_forwarding_config/methods/retrieve_google_domains_forwarding_config + insert: [] + update: [] + replace: [] delete: [] registrations_authorization_code: id: google.domains.registrations_authorization_code @@ -2139,9 +2662,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/registrations_authorization_code/methods/retrieve_authorization_code insert: [] update: [] + replace: [] delete: [] registrations_iam_policies: id: google.domains.registrations_iam_policies @@ -2155,17 +2681,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1registrations~1{registrationsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2179,10 +2702,13 @@ components: #/components/x-stackQL-resources/registrations_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/registrations_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2229,7 +2755,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: domains.projects.locations.get @@ -2257,7 +2783,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2300,7 +2826,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2336,7 +2862,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations:searchDomains: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Searches for available domain names similar to the provided query. @@ -2372,7 +2898,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveRegisterParameters: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets parameters needed to register a new domain name, including price @@ -2407,7 +2933,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations:register: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Registers a new domain name and creates a corresponding `Registration` @@ -2450,7 +2976,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveTransferParameters: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Deprecated: For more information, see [Cloud Domains feature @@ -2488,7 +3014,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations:transfer: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Deprecated: For more information, see [Cloud Domains feature @@ -2540,7 +3066,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations:retrieveImportableDomains: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Deprecated: For more information, see [Cloud Domains feature @@ -2584,7 +3110,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations:import: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Deprecated: For more information, see [Cloud Domains feature @@ -2624,7 +3150,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists the `Registration` resources in a project. operationId: domains.projects.locations.registrations.list @@ -2665,7 +3191,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the details of a `Registration` resource. operationId: domains.projects.locations.registrations.get @@ -2790,7 +3316,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:configureManagementSettings: - parameters: *ref_9 + parameters: *ref_1 post: description: Updates a `Registration`'s management settings. operationId: domains.projects.locations.registrations.configureManagementSettings @@ -2828,7 +3354,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:configureDnsSettings: - parameters: *ref_9 + parameters: *ref_1 post: description: Updates a `Registration`'s DNS settings. operationId: domains.projects.locations.registrations.configureDnsSettings @@ -2865,8 +3391,94 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsDnsRecords: + parameters: *ref_1 + get: + description: >- + Lists the DNS records from the Google Domains DNS zone for domains that + use the deprecated `google_domains_dns` in the `Registration`'s + `dns_settings`. + operationId: domains.projects.locations.registrations.retrieveGoogleDomainsDnsRecords + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/RetrieveGoogleDomainsDnsRecordsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: registrationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsForwardingConfig: + parameters: *ref_1 + get: + description: >- + Lists the deprecated domain and email forwarding configurations you set + up in the deprecated Google Domains UI. The configuration is present + only for domains with the `google_domains_redirects_data_available` set + to `true` in the `Registration`'s `dns_settings`. A forwarding + configuration might not work correctly if required DNS records are not + present in the domain's authoritative DNS Zone. + operationId: >- + domains.projects.locations.registrations.retrieveGoogleDomainsForwardingConfig + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/RetrieveGoogleDomainsForwardingConfigResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: registrationsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:configureContactSettings: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Updates a `Registration`'s contact settings. Some changes require @@ -2916,7 +3528,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:export: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Deprecated: For more information, see [Cloud Domains feature @@ -2963,12 +3575,16 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveAuthorizationCode: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration. + Domains that have the `REQUIRE_PUSH_TRANSFER` property in the list of + `domain_properties` don't support authorization codes and must use the + `InitiatePushTransfer` method to initiate the process to transfer the + domain to a different registrar. operationId: domains.projects.locations.registrations.retrieveAuthorizationCode security: - Oauth2: @@ -2999,12 +3615,16 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:resetAuthorizationCode: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since - the initial domain registration. + the initial domain registration. Domains that have the + `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties` + don't support authorization codes and must use the + `InitiatePushTransfer` method to initiate the process to transfer the + domain to a different registrar. operationId: domains.projects.locations.registrations.resetAuthorizationCode requestBody: content: @@ -3039,8 +3659,98 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:initiatePushTransfer: + parameters: *ref_1 + post: + description: >- + Initiates the `Push Transfer` process to transfer the domain to another + registrar. The process might complete instantly or might require + confirmation or additional work. Check the emails sent to the email + address of the registrant. The process is aborted after a timeout if + it's not completed. This method is only supported for domains that have + the `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. + The domain must also be unlocked before it can be transferred to a + different registrar. For more information, see [Transfer a registered + domain to another + registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar). + operationId: domains.projects.locations.registrations.initiatePushTransfer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InitiatePushTransferRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: registrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:renewDomain: + parameters: *ref_1 + post: + description: >- + Renews a recently expired domain. This method can only be called on + domains that expired in the previous 30 days. After the renewal, the new + expiration time of the domain is one year after the old expiration time + and you are charged a `yearly_price` for the renewal. + operationId: domains.projects.locations.registrations.renewDomain + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RenewDomainRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: registrationsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3081,7 +3791,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3121,7 +3831,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml index 9dd1eedc..e015d1b9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/essentialcontacts.yaml @@ -7,8 +7,8 @@ info: title: Essential Contacts API description: '' version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/essentialcontacts/docs/ servers: @@ -34,69 +34,24 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudEssentialcontactsV1SendTestMessageRequest: - properties: - contacts: - type: array - description: >- - Required. The list of names of the contacts to send a test message - to. Format: organizations/{organization_id}/contacts/{contact_id}, - folders/{folder_id}/contacts/{contact_id} or - projects/{project_id}/contacts/{contact_id} - items: - type: string - notificationCategory: - enum: - - NOTIFICATION_CATEGORY_UNSPECIFIED - - ALL - - SUSPENSION - - SECURITY - - TECHNICAL - - BILLING - - LEGAL - - PRODUCT_UPDATES - - TECHNICAL_INCIDENTS - description: >- - Required. The notification category to send the test message for. - All contacts must be subscribed to this category. - type: string - enumDescriptions: - - Notification category is unrecognized or unspecified. - - >- - All notifications related to the resource, including notifications - pertaining to categories added in the future. - - Notifications related to imminent account suspension. - - >- - Notifications related to security/privacy incidents, - notifications, and vulnerabilities. - - >- - Notifications related to technical events and issues such as - outages, errors, or bugs. - - >- - Notifications related to billing and payments notifications, price - updates, errors, or credits. - - >- - Notifications related to enforcement actions, regulatory - compliance, or government notices. - - >- - Notifications related to new versions, product terms updates, or - deprecations. - - >- - Child category of TECHNICAL. If assigned, technical incident - notifications will go to these contacts instead of TECHNICAL. - type: object - description: Request message for the SendTestMessage method. - id: GoogleCloudEssentialcontactsV1SendTestMessageRequest GoogleCloudEssentialcontactsV1Contact: id: GoogleCloudEssentialcontactsV1Contact properties: - email: + validateTime: + description: >- + The last time the validation_state was updated, either manually or + automatically. A contact is considered stale if its validation state + was updated more than 1 year ago. + type: string + format: google-datetime + languageTag: type: string description: >- - Required. The email address to send notifications to. The email - address does not need to be a Google Account. + Required. The preferred language for notifications, as a ISO 639-1 + language code. See [Supported + languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) + for a list of supported languages. notificationCategorySubscriptions: - type: array description: >- Required. The categories of notifications that the contact will receive communications for. @@ -136,20 +91,22 @@ components: - LEGAL - PRODUCT_UPDATES - TECHNICAL_INCIDENTS - name: + type: array + email: description: >- - Output only. The identifier for the contact. Format: - {resource_type}/{resource_id}/contacts/{contact_id} + Required. The email address to send notifications to. The email + address does not need to be a Google Account. type: string + validationState: readOnly: true - languageTag: description: >- - Required. The preferred language for notifications, as a ISO 639-1 - language code. See [Supported - languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) - for a list of supported languages. - type: string - validationState: + Output only. The validity of the contact. A contact is considered + valid if it is the correct recipient for notifications for a + particular resource. + enum: + - VALIDATION_STATE_UNSPECIFIED + - VALID + - INVALID type: string enumDescriptions: - The validation state is unknown or unspecified. @@ -159,38 +116,27 @@ components: - >- The contact is considered invalid. This may become the state if the contact's email is found to be unreachable. - enum: - - VALIDATION_STATE_UNSPECIFIED - - VALID - - INVALID + name: description: >- - The validity of the contact. A contact is considered valid if it is - the correct recipient for notifications for a particular resource. - validateTime: + Output only. The identifier for the contact. Format: + {resource_type}/{resource_id}/contacts/{contact_id} type: string - description: >- - The last time the validation_state was updated, either manually or - automatically. A contact is considered stale if its validation state - was updated more than 1 year ago. - format: google-datetime - description: A contact that will receive notifications from Google Cloud. + readOnly: true type: object - GoogleProtobufEmpty: - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: GoogleProtobufEmpty - properties: {} + description: A contact that will receive notifications from Google Cloud. + GoogleCloudEssentialcontactsV1ComputeContactsResponse: type: object - GoogleCloudEssentialcontactsV1ListContactsResponse: + description: Response message for the ComputeContacts method. + id: GoogleCloudEssentialcontactsV1ComputeContactsResponse properties: contacts: items: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + description: >- + All contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any + parent resources. type: array - description: The contacts for the specified resource. nextPageToken: type: string description: >- @@ -199,72 +145,121 @@ components: call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. - description: Response message for the ListContacts method. + GoogleProtobufEmpty: + properties: {} type: object - id: GoogleCloudEssentialcontactsV1ListContactsResponse - GoogleCloudEssentialcontactsV1ComputeContactsResponse: + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + GoogleCloudEssentialcontactsV1SendTestMessageRequest: + type: object + id: GoogleCloudEssentialcontactsV1SendTestMessageRequest properties: contacts: + items: + type: string + description: >- + Required. The list of names of the contacts to send a test message + to. Format: organizations/{organization_id}/contacts/{contact_id}, + folders/{folder_id}/contacts/{contact_id} or + projects/{project_id}/contacts/{contact_id} type: array + notificationCategory: description: >- - All contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any - parent resources. + Required. The notification category to send the test message for. + All contacts must be subscribed to this category. + type: string + enum: + - NOTIFICATION_CATEGORY_UNSPECIFIED + - ALL + - SUSPENSION + - SECURITY + - TECHNICAL + - BILLING + - LEGAL + - PRODUCT_UPDATES + - TECHNICAL_INCIDENTS + enumDescriptions: + - Notification category is unrecognized or unspecified. + - >- + All notifications related to the resource, including notifications + pertaining to categories added in the future. + - Notifications related to imminent account suspension. + - >- + Notifications related to security/privacy incidents, + notifications, and vulnerabilities. + - >- + Notifications related to technical events and issues such as + outages, errors, or bugs. + - >- + Notifications related to billing and payments notifications, price + updates, errors, or credits. + - >- + Notifications related to enforcement actions, regulatory + compliance, or government notices. + - >- + Notifications related to new versions, product terms updates, or + deprecations. + - >- + Child category of TECHNICAL. If assigned, technical incident + notifications will go to these contacts instead of TECHNICAL. + description: Request message for the SendTestMessage method. + GoogleCloudEssentialcontactsV1ListContactsResponse: + id: GoogleCloudEssentialcontactsV1ListContactsResponse + description: Response message for the ListContacts method. + type: object + properties: + contacts: + type: array items: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + description: The contacts for the specified resource. nextPageToken: + type: string description: >- If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. - type: string - id: GoogleCloudEssentialcontactsV1ComputeContactsResponse - description: Response message for the ComputeContacts method. - type: object parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + access_token: + description: OAuth access token. in: query - name: upload_protocol + name: access_token schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback schema: type: string - alt: - description: Data format for response. + _.xgafv: + description: V1 error format. in: query - name: alt + name: $.xgafv schema: type: string enum: - - json - - media - - proto + - '1' + - '2' uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - callback: - description: JSONP + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. in: query - name: callback + name: key schema: type: string prettyPrint: @@ -273,34 +268,41 @@ components: name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. + alt: + description: Data format for response. in: query - name: access_token + name: alt schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + enum: + - json + - media + - proto + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: oauth_token + name: upload_protocol schema: type: string - _.xgafv: - description: V1 error format. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: $.xgafv + name: quotaUser schema: type: string - enum: - - '1' - - '2' - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: key + name: fields + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string x-stackQL-resources: @@ -309,72 +311,48 @@ components: name: contacts title: Contacts methods: - folders_contacts_patch: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - folders_contacts_delete: - operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - folders_contacts_get: + projects_contacts_send_test_message: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_send_test_message: + projects_contacts_get: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - _folders_contacts_list: - operation: &ref_1 - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.contacts - folders_contacts_list: - operation: *ref_1 - response: *ref_2 - folders_contacts_create: + projects_contacts_delete: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete response: mediaType: application/json openAPIDocKey: '200' - folders_contacts_compute: + projects_contacts_patch: operation: - $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_create: + projects_contacts_create: operation: - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - _organizations_contacts_list: - operation: &ref_3 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' - response: &ref_4 + projects_contacts_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.contacts - organizations_contacts_list: - operation: *ref_3 - response: *ref_4 - organizations_contacts_delete: + projects_contacts_compute: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' @@ -385,6 +363,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + organizations_contacts_delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts~1{contactsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' organizations_contacts_get: operation: $ref: >- @@ -392,13 +377,19 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_contacts_send_test_message: + organizations_contacts_create: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' + organizations_contacts_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1contacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.contacts organizations_contacts_compute: operation: $ref: >- @@ -406,142 +397,117 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_patch: + organizations_contacts_send_test_message: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/patch' + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1contacts:sendTestMessage/post response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_get: + folders_contacts_patch: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/patch' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_delete: + folders_contacts_get: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts~1{contactsId}/delete + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/get' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_compute: + folders_contacts_delete: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts:compute/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts~1{contactsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - _projects_contacts_list: - operation: &ref_5 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/get' - response: &ref_6 + folders_contacts_list: + operation: + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.contacts - projects_contacts_list: - operation: *ref_5 - response: *ref_6 - projects_contacts_create: + folders_contacts_create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1contacts/post' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts/post' response: mediaType: application/json openAPIDocKey: '200' - projects_contacts_send_test_message: + folders_contacts_send_test_message: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1contacts:sendTestMessage/post + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:sendTestMessage/post' + response: + mediaType: application/json + openAPIDocKey: '200' + folders_contacts_compute: + operation: + $ref: '#/paths/~1v1~1folders~1{foldersId}~1contacts:compute/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/folders_contacts_get + #/components/x-stackQL-resources/contacts/methods/projects_contacts_get - $ref: >- #/components/x-stackQL-resources/contacts/methods/organizations_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_get + #/components/x-stackQL-resources/contacts/methods/folders_contacts_get - $ref: >- - #/components/x-stackQL-resources/contacts/methods/folders_contacts_list + #/components/x-stackQL-resources/contacts/methods/projects_contacts_list - $ref: >- #/components/x-stackQL-resources/contacts/methods/organizations_contacts_list - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_list + #/components/x-stackQL-resources/contacts/methods/folders_contacts_list insert: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/folders_contacts_create + #/components/x-stackQL-resources/contacts/methods/projects_contacts_create - $ref: >- #/components/x-stackQL-resources/contacts/methods/organizations_contacts_create - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_create + #/components/x-stackQL-resources/contacts/methods/folders_contacts_create update: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/folders_contacts_patch + #/components/x-stackQL-resources/contacts/methods/projects_contacts_patch - $ref: >- #/components/x-stackQL-resources/contacts/methods/organizations_contacts_patch - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_patch + #/components/x-stackQL-resources/contacts/methods/folders_contacts_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/contacts/methods/folders_contacts_delete + #/components/x-stackQL-resources/contacts/methods/projects_contacts_delete - $ref: >- #/components/x-stackQL-resources/contacts/methods/organizations_contacts_delete - $ref: >- - #/components/x-stackQL-resources/contacts/methods/projects_contacts_delete + #/components/x-stackQL-resources/contacts/methods/folders_contacts_delete paths: - /v1/folders/{foldersId}/contacts/{contactsId}: - parameters: &ref_7 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' + /v1/projects/{projectsId}/contacts:sendTestMessage: + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/key' - patch: - description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.folders.contacts.patch + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + post: + description: >- + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.projects.contacts.sendTestMessage requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: contactsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a contact. - operationId: essentialcontacts.folders.contacts.delete + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -556,18 +522,15 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: contactsId + name: projectsId required: true schema: type: string + /v1/projects/{projectsId}/contacts/{contactsId}: + parameters: *ref_1 get: description: Gets a single contact. - operationId: essentialcontacts.folders.contacts.get + operationId: essentialcontacts.projects.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -582,7 +545,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -591,19 +554,9 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/contacts:sendTestMessage: - parameters: *ref_7 - post: - description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.folders.contacts.sendTestMessage - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + delete: + description: Deletes a contact. + operationId: essentialcontacts.projects.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -618,46 +571,18 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - /v1/folders/{foldersId}/contacts: - parameters: *ref_7 - get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.folders.contacts.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse - parameters: - in: path - name: foldersId + name: contactsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.folders.contacts.create + patch: + description: 'Updates a contact. Note: A contact''s email address cannot be changed.' + operationId: essentialcontacts.projects.contacts.patch requestBody: content: application/json: @@ -677,55 +602,25 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string - /v1/folders/{foldersId}/contacts:compute: - parameters: *ref_7 - get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.folders.contacts.compute - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse - parameters: - in: path - name: foldersId + name: contactsId required: true schema: type: string - in: query - name: pageToken - schema: - type: string - - in: query - name: notificationCategories - schema: - type: string - - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/contacts: - parameters: *ref_7 + type: string + format: google-fieldmask + /v1/projects/{projectsId}/contacts: + parameters: *ref_1 post: description: Adds a new contact for a resource. - operationId: essentialcontacts.organizations.contacts.create + operationId: essentialcontacts.projects.contacts.create requestBody: content: application/json: @@ -745,13 +640,13 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string get: description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.organizations.contacts.list + operationId: essentialcontacts.projects.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -767,7 +662,7 @@ paths: #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -780,11 +675,14 @@ paths: name: pageToken schema: type: string - /v1/organizations/{organizationsId}/contacts/{contactsId}: - parameters: *ref_7 - delete: - description: Deletes a contact. - operationId: essentialcontacts.organizations.contacts.delete + /v1/projects/{projectsId}/contacts:compute: + parameters: *ref_1 + get: + description: >- + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.projects.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -796,18 +694,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - - in: path - name: contactsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: notificationCategories + schema: + type: string + - in: query + name: pageToken schema: type: string + /v1/organizations/{organizationsId}/contacts/{contactsId}: + parameters: *ref_1 patch: description: 'Updates a contact. Note: A contact''s email address cannot be changed.' operationId: essentialcontacts.organizations.contacts.patch @@ -844,6 +753,32 @@ paths: schema: type: string format: google-fieldmask + delete: + description: Deletes a contact. + operationId: essentialcontacts.organizations.contacts.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: contactsId + required: true + schema: + type: string get: description: Gets a single contact. operationId: essentialcontacts.organizations.contacts.get @@ -870,19 +805,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/contacts:sendTestMessage: - parameters: *ref_7 + /v1/organizations/{organizationsId}/contacts: + parameters: *ref_1 post: - description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.organizations.contacts.sendTestMessage + description: Adds a new contact for a resource. + operationId: essentialcontacts.organizations.contacts.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -894,15 +826,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + get: + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.organizations.contacts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path name: organizationsId required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/organizations/{organizationsId}/contacts:compute: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists all contacts for the resource that are subscribed to the specified @@ -929,11 +892,11 @@ paths: schema: type: string - in: query - name: notificationCategories + name: pageToken schema: type: string - in: query - name: pageToken + name: notificationCategories schema: type: string - in: query @@ -941,11 +904,42 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/contacts/{contactsId}: - parameters: *ref_7 + /v1/organizations/{organizationsId}/contacts:sendTestMessage: + parameters: *ref_1 + post: + description: >- + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.organizations.contacts.sendTestMessage + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/contacts/{contactsId}: + parameters: *ref_1 patch: description: 'Updates a contact. Note: A contact''s email address cannot be changed.' - operationId: essentialcontacts.projects.contacts.patch + operationId: essentialcontacts.folders.contacts.patch requestBody: content: application/json: @@ -965,7 +959,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -981,7 +975,7 @@ paths: format: google-fieldmask get: description: Gets a single contact. - operationId: essentialcontacts.projects.contacts.get + operationId: essentialcontacts.folders.contacts.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -996,7 +990,7 @@ paths: $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1007,7 +1001,7 @@ paths: type: string delete: description: Deletes a contact. - operationId: essentialcontacts.projects.contacts.delete + operationId: essentialcontacts.folders.contacts.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1022,7 +1016,7 @@ paths: $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1031,14 +1025,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/contacts:compute: - parameters: *ref_7 + /v1/folders/{foldersId}/contacts: + parameters: *ref_1 get: - description: >- - Lists all contacts for the resource that are subscribed to the specified - notification categories, including contacts inherited from any parent - resources. - operationId: essentialcontacts.projects.contacts.compute + description: Lists the contacts that have been set on a resource. + operationId: essentialcontacts.folders.contacts.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1051,10 +1042,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse + #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -1067,15 +1058,14 @@ paths: schema: type: integer format: int32 - - in: query - name: notificationCategories - schema: - type: string - /v1/projects/{projectsId}/contacts: - parameters: *ref_7 - get: - description: Lists the contacts that have been set on a resource. - operationId: essentialcontacts.projects.contacts.list + post: + description: Adds a new contact for a resource. + operationId: essentialcontacts.folders.contacts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1087,31 +1077,26 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1ListContactsResponse + $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1/folders/{foldersId}/contacts:sendTestMessage: + parameters: *ref_1 post: - description: Adds a new contact for a resource. - operationId: essentialcontacts.projects.contacts.create + description: >- + Allows a contact admin to send a test message to contact to verify that + it has been configured correctly. + operationId: essentialcontacts.folders.contacts.sendTestMessage requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1123,26 +1108,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudEssentialcontactsV1Contact' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string - /v1/projects/{projectsId}/contacts:sendTestMessage: - parameters: *ref_7 - post: + /v1/folders/{foldersId}/contacts:compute: + parameters: *ref_1 + get: description: >- - Allows a contact admin to send a test message to contact to verify that - it has been configured correctly. - operationId: essentialcontacts.projects.contacts.sendTestMessage - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudEssentialcontactsV1SendTestMessageRequest + Lists all contacts for the resource that are subscribed to the specified + notification categories, including contacts inherited from any parent + resources. + operationId: essentialcontacts.folders.contacts.compute security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1154,10 +1134,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudEssentialcontactsV1ComputeContactsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string + - in: query + name: notificationCategories + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml b/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml index fd5b737f..39988559 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/eventarc.yaml @@ -7,8 +7,8 @@ info: title: Eventarc API description: Build event-driven applications on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/eventarc servers: @@ -1400,23 +1400,23 @@ components: - $ref: >- #/components/x-stackQL-resources/google_channel_config/methods/get_google_channel_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/google_channel_config/methods/update_google_channel_config + replace: [] delete: [] locations: id: google.eventarc.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1429,23 +1429,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.eventarc.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1473,6 +1471,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' triggers: @@ -1501,17 +1500,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1triggers/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.triggers - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1527,6 +1523,7 @@ components: - $ref: '#/components/x-stackQL-resources/triggers/methods/create' update: - $ref: '#/components/x-stackQL-resources/triggers/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/triggers/methods/delete' triggers_iam_policies: @@ -1541,17 +1538,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1triggers~1{triggersId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -1565,6 +1559,9 @@ components: #/components/x-stackQL-resources/triggers_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/triggers_iam_policies/methods/set_iam_policy delete: [] channels: id: google.eventarc.channels @@ -1592,17 +1589,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1channels/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.channels - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -1618,6 +1612,7 @@ components: - $ref: '#/components/x-stackQL-resources/channels/methods/create' update: - $ref: '#/components/x-stackQL-resources/channels/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/channels/methods/delete' channels_iam_policies: @@ -1632,17 +1627,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1channels~1{channelsId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -1656,6 +1648,9 @@ components: #/components/x-stackQL-resources/channels_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/channels_iam_policies/methods/set_iam_policy delete: [] providers: id: google.eventarc.providers @@ -1669,23 +1664,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1providers/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.providers - list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/providers/methods/get' - $ref: '#/components/x-stackQL-resources/providers/methods/list' insert: [] update: [] + replace: [] delete: [] channel_connections: id: google.eventarc.channel_connections @@ -1706,17 +1699,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1channelConnections/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.channelConnections - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -1732,6 +1722,7 @@ components: - $ref: >- #/components/x-stackQL-resources/channel_connections/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/channel_connections/methods/delete @@ -1747,17 +1738,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_17 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1channelConnections~1{channelConnectionsId}:getIamPolicy/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_17 - response: *ref_18 test_iam_permissions: operation: $ref: >- @@ -1771,10 +1759,13 @@ components: #/components/x-stackQL-resources/channel_connections_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/channel_connections_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/googleChannelConfig: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1849,7 +1840,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: eventarc.projects.locations.list @@ -1885,7 +1876,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets information about a location. operationId: eventarc.projects.locations.get @@ -1913,7 +1904,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1956,7 +1947,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2027,7 +2018,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2074,7 +2065,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Get a single trigger. operationId: eventarc.projects.locations.triggers.get @@ -2199,7 +2190,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/triggers: - parameters: *ref_19 + parameters: *ref_1 get: description: List triggers. operationId: eventarc.projects.locations.triggers.list @@ -2283,7 +2274,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2324,7 +2315,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2364,7 +2355,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/triggers/{triggersId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2407,7 +2398,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/channels/{channelsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Get a single Channel. operationId: eventarc.projects.locations.channels.get @@ -2520,7 +2511,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/channels: - parameters: *ref_19 + parameters: *ref_1 get: description: List channels. operationId: eventarc.projects.locations.channels.list @@ -2600,7 +2591,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/channels/{channelsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2641,7 +2632,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/channels/{channelsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2681,7 +2672,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/channels/{channelsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2724,7 +2715,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Get a single Provider. operationId: eventarc.projects.locations.providers.get @@ -2757,7 +2748,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/providers: - parameters: *ref_19 + parameters: *ref_1 get: description: List providers. operationId: eventarc.projects.locations.providers.list @@ -2802,7 +2793,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/channelConnections/{channelConnectionsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Get a single ChannelConnection. operationId: eventarc.projects.locations.channelConnections.get @@ -2866,7 +2857,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/channelConnections: - parameters: *ref_19 + parameters: *ref_1 get: description: List channel connections. operationId: eventarc.projects.locations.channelConnections.list @@ -2938,7 +2929,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/channelConnections/{channelConnectionsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2979,7 +2970,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/channelConnections/{channelConnectionsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3019,7 +3010,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/channelConnections/{channelConnectionsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/file.yaml b/providers/src/googleapis.com/v00.00.00000/services/file.yaml index 6d0b552e..f03f68a4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/file.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/file.yaml @@ -9,8 +9,8 @@ info: The Cloud Filestore API is used for creating and managing cloud file servers. version: v1 - x-discovery-doc-revision: '20240511' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/filestore/ servers: @@ -212,6 +212,7 @@ components: - The instance is in the process of becoming suspended. - The instance is in the process of becoming active. - The instance is reverting to a snapshot. + - The replica instance is being promoted. enum: - STATE_UNSPECIFIED - CREATING @@ -224,6 +225,7 @@ components: - SUSPENDING - RESUMING - REVERTING + - PROMOTING statusMessage: description: >- Output only. Additional information about the instance state, if @@ -324,8 +326,54 @@ components: - SUSPENSION_REASON_UNSPECIFIED - KMS_KEY_ISSUE replication: - description: Optional. Replicaition configuration. + description: Optional. Replication configuration. $ref: '#/components/schemas/Replication' + tags: + description: >- + Optional. Input only. Immutable. Tag key-value pairs are bound to + this resource. For example: "123/environment": "production", + "123/costCenter": "marketing" + type: object + additionalProperties: + type: string + protocol: + description: >- + Immutable. The protocol indicates the access protocol for all shares + in the instance. This field is immutable and it cannot be changed + after the instance has been created. Default value: `NFS_V3`. + type: string + enumDescriptions: + - >- + FILE_PROTOCOL_UNSPECIFIED serves a "not set" default value when a + FileProtocol is a separate field in a message. + - NFS 3.0. + - NFS 4.1. + enum: + - FILE_PROTOCOL_UNSPECIFIED + - NFS_V3 + - NFS_V4_1 + configurablePerformanceEnabled: + description: >- + Output only. Indicates whether this instance's performance is + configurable. If enabled, adjust it using the 'performance_config' + field. + readOnly: true + type: boolean + performanceConfig: + description: Optional. Used to configure performance. + $ref: '#/components/schemas/PerformanceConfig' + performanceLimits: + description: Output only. Used for getting performance limits. + readOnly: true + $ref: '#/components/schemas/PerformanceLimits' + deletionProtectionEnabled: + description: >- + Optional. Indicates whether the instance is protected against + deletion. + type: boolean + deletionProtectionReason: + description: Optional. The reason for enabling deletion protection. + type: string FileShareConfig: id: FileShareConfig description: File share configuration for the instance. @@ -498,10 +546,10 @@ components: enumDescriptions: - Role not set. - >- - The instance is a Active replication member, functions as the + The instance is the `ACTIVE` replication member, functions as the replication source instance. - >- - The instance is a Standby replication member, functions as the + The instance is the `STANDBY` replication member, functions as the replication destination instance. enum: - ROLE_UNSPECIFIED @@ -509,8 +557,8 @@ components: - STANDBY replicas: description: >- - Optional. Replicas configuration on the instance. For now, only a - single replica config is supported. + Optional. Replication configuration for the replica instance + associated with this instance. Only a single replica is supported. type: array items: $ref: '#/components/schemas/ReplicaConfig' @@ -562,6 +610,87 @@ components: readOnly: true type: string format: google-datetime + PerformanceConfig: + id: PerformanceConfig + description: >- + Used for setting the performance configuration. If the user doesn't + specify PerformanceConfig, automatically provision the default + performance settings as described in + https://cloud.google.com/filestore/docs/performance. Larger instances + will be linearly set to more IOPS. If the instance's capacity is + increased or decreased, its performance will be automatically adjusted + upwards or downwards accordingly (respectively). + type: object + properties: + fixedIops: + description: >- + Choose a fixed provisioned IOPS value for the instance, which will + remain constant regardless of instance capacity. Value must be a + multiple of 1000. If the chosen value is outside the supported range + for the instance's capacity during instance creation, instance + creation will fail with an `InvalidArgument` error. Similarly, if an + instance capacity update would result in a value outside the + supported range, the update will fail with an `InvalidArgument` + error. + $ref: '#/components/schemas/FixedIOPS' + iopsPerTb: + description: >- + Provision IOPS dynamically based on the capacity of the instance. + Provisioned read IOPS will be calculated by multiplying the capacity + of the instance in TiB by the `iops_per_tb` value. For example, for + a 2 TiB instance with an `iops_per_tb` value of 17000 the + provisioned read IOPS will be 34000. If the calculated value is + outside the supported range for the instance's capacity during + instance creation, instance creation will fail with an + `InvalidArgument` error. Similarly, if an instance capacity update + would result in a value outside the supported range, the update will + fail with an `InvalidArgument` error. + $ref: '#/components/schemas/IOPSPerTB' + FixedIOPS: + id: FixedIOPS + description: Fixed IOPS (input/output operations per second) parameters. + type: object + properties: + maxReadIops: + description: Required. Maximum raw read IOPS. + type: string + format: int64 + IOPSPerTB: + id: IOPSPerTB + description: IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). + type: object + properties: + maxReadIopsPerTb: + description: Required. Maximum read IOPS per TiB. + type: string + format: int64 + PerformanceLimits: + id: PerformanceLimits + description: >- + The enforced performance limits, calculated from the instance's + performance configuration. + type: object + properties: + maxReadIops: + description: Output only. The max read IOPS. + readOnly: true + type: string + format: int64 + maxWriteIops: + description: Output only. The max write IOPS. + readOnly: true + type: string + format: int64 + maxReadThroughputBps: + description: Output only. The max read throughput in bytes per second. + readOnly: true + type: string + format: int64 + maxWriteThroughputBps: + description: Output only. The max write throughput in bytes per second. + readOnly: true + type: string + format: int64 RestoreInstanceRequest: id: RestoreInstanceRequest description: >- @@ -655,6 +784,14 @@ components: readOnly: true type: string format: int64 + tags: + description: >- + Optional. Input only. Immutable. Tag key-value pairs are bound to + this resource. For example: "123/environment": "production", + "123/costCenter": "marketing" + type: object + additionalProperties: + type: string ListBackupsResponse: id: ListBackupsResponse description: ListBackupsResponse is the result of ListBackupsRequest. @@ -815,6 +952,35 @@ components: kmsKey: description: Immutable. KMS key name used for data encryption. type: string + tags: + description: >- + Optional. Input only. Immutable. Tag key-value pairs are bound to + this resource. For example: "123/environment": "production", + "123/costCenter": "marketing" + type: object + additionalProperties: + type: string + fileSystemProtocol: + description: >- + Output only. The file system protocol of the source Filestore + instance that this backup is created from. + readOnly: true + type: string + enumDescriptions: + - >- + FILE_PROTOCOL_UNSPECIFIED serves a "not set" default value when a + FileProtocol is a separate field in a message. + - NFS 3.0. + - NFS 4.1. + enum: + - FILE_PROTOCOL_UNSPECIFIED + - NFS_V3 + - NFS_V4_1 + PromoteReplicaRequest: + id: PromoteReplicaRequest + description: PromoteReplicaRequest promotes a Filestore standby instance (replica). + type: object + properties: {} ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -1612,16 +1778,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1634,23 +1797,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.file.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1678,6 +1839,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: @@ -1685,17 +1847,14 @@ components: name: instances title: Instances methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1738,6 +1897,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + promote_replica: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:promoteReplica/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/instances/methods/get' @@ -1746,6 +1912,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' snapshots: @@ -1753,17 +1920,14 @@ components: name: snapshots title: Snapshots methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1snapshots/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.snapshots - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -1800,6 +1964,7 @@ components: - $ref: '#/components/x-stackQL-resources/snapshots/methods/create' update: - $ref: '#/components/x-stackQL-resources/snapshots/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/snapshots/methods/delete' backups: @@ -1807,17 +1972,14 @@ components: name: backups title: Backups methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backups/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backups - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -1854,11 +2016,12 @@ components: - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: - $ref: '#/components/x-stackQL-resources/backups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_11 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1909,7 +2072,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets information about a location. operationId: file.projects.locations.get @@ -1937,7 +2100,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1980,7 +2143,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2051,7 +2214,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2098,7 +2261,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Lists all instances in a project for either a specified location or for @@ -2184,7 +2347,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets the details of a specific instance. operationId: file.projects.locations.instances.get @@ -2293,7 +2456,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Restores an existing instance's file share from a backup. The capacity @@ -2335,7 +2498,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:revert: - parameters: *ref_11 + parameters: *ref_1 post: description: Revert an existing instance's file system to a specified snapshot. operationId: file.projects.locations.instances.revert @@ -2372,8 +2535,46 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:promoteReplica: + parameters: *ref_1 + post: + description: Promote the standby instance (replica). + operationId: file.projects.locations.instances.promoteReplica + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromoteReplicaRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/snapshots: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Lists all snapshots in a project for either a specified location or for @@ -2465,7 +2666,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/snapshots/{snapshotsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets the details of a specific snapshot. operationId: file.projects.locations.instances.snapshots.get @@ -2585,7 +2786,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/backups: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Lists all backups in a project for either a specified location or for @@ -2667,7 +2868,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets the details of a specific backup. operationId: file.projects.locations.backups.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml b/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml index ff94841b..a7fa022b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/firestore.yaml @@ -9,8 +9,8 @@ info: Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. version: v1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/firestore servers: @@ -215,10 +215,10 @@ components: description: >- Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, - specified at query time, and that has the same collection id. + specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, - specified at query time, and that have the same collection id as + specified at query time, and that have the same collection ID as this index. type: string enumDescriptions: @@ -226,11 +226,11 @@ components: - >- Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, - specified at query time, and that has the collection id specified + specified at query time, and that has the collection ID specified by the index. - >- Indexes with a collection group query scope specified allow - queries against all collections that has the collection id + queries against all collections that has the collection ID specified by the index. - >- Include all the collections's ancestor in the index. Only @@ -375,27 +375,26 @@ components: description: >- Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with - the same id. + the same ID. type: object properties: name: description: >- - Required. A field name of the form + Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` - A field path may be a simple field name, e.g. `address` or a path to - fields within map_value , e.g. `address.city`, or a special field + A field path can be a simple field name, e.g. `address` or a path to + fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any - field. Field paths may be quoted using ` (backtick). The only - character that needs to be escaped within a quoted field path is the + field. Field paths can be quoted using `` ` `` (backtick). The only + character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special - characters in field paths that must be quoted include: `*`, `.`, ``` - (backtick), `[`, `]`, as well as any ascii symbolic characters. - Examples: (Note: Comments here are written in markdown syntax, so - there is an additional layer of backticks to represent a code block) - `\`address.city\`` represents a field named `address.city`, not the - map key `city` in the field `address`. `\`*\`` represents a field - named `*`, not any field. A special `Field` contains the default - indexing settings for all fields. This field's resource name is: + characters in field paths that must be quoted include: `*`, `.`, `` + ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. + Examples: `` `address.city` `` represents a field named + `address.city`, not the map key `city` in the field `address`. `` + `*` `` represents a field named `*`, not any field. A special + `Field` contains the default indexing settings for all fields. This + field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. @@ -499,8 +498,8 @@ components: properties: collectionIds: description: >- - Which collection ids to export. Unspecified means all collections. - Each collection id in this list must be unique. + Which collection IDs to export. Unspecified means all collections. + Each collection ID in this list must be unique. type: array items: type: string @@ -542,8 +541,8 @@ components: properties: collectionIds: description: >- - Which collection ids to import. Unspecified means all collections - included in the import. Each collection id in this list must be + Which collection IDs to import. Unspecified means all collections + included in the import. Each collection ID in this list must be unique. type: array items: @@ -565,6 +564,35 @@ components: type: array items: type: string + GoogleFirestoreAdminV1BulkDeleteDocumentsRequest: + id: GoogleFirestoreAdminV1BulkDeleteDocumentsRequest + description: >- + The request for FirestoreAdmin.BulkDeleteDocuments. When both + collection_ids and namespace_ids are set, only documents satisfying both + conditions will be deleted. Requests with namespace_ids and + collection_ids both empty will be rejected. Please use + FirestoreAdmin.DeleteDatabase instead. + type: object + properties: + collectionIds: + description: >- + Optional. IDs of the collection groups to delete. Unspecified means + all collection groups. Each collection group in this list must be + unique. + type: array + items: + type: string + namespaceIds: + description: >- + Optional. Namespaces to delete. An empty list means all namespaces. + This is the recommended usage for databases that don't use + namespaces. An empty string element represents the default + namespace. This should be used if the database has data in + non-default namespaces, but doesn't want to delete from them. Each + namespace in this list must be unique. + type: array + items: + type: string GoogleFirestoreAdminV1Database: id: GoogleFirestoreAdminV1Database description: A Cloud Firestore Database. @@ -613,9 +641,7 @@ components: information about how to choose. type: string enumDescriptions: - - >- - The default value. This value is used if the database type is - omitted. + - Not used. - Firestore Native Mode - Firestore in Datastore Mode. enum: @@ -706,8 +732,8 @@ components: keyPrefix: description: >- Output only. The key_prefix for this database. This key_prefix is - used, in combination with the project id ("~") to construct the - application id that is returned from the Cloud Datastore APIs in + used, in combination with the project ID ("~") to construct the + application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). @@ -733,6 +759,10 @@ components: is only populated for deleted databases. readOnly: true type: string + sourceInfo: + description: Output only. Information about the provenance of this database. + readOnly: true + $ref: '#/components/schemas/GoogleFirestoreAdminV1SourceInfo' etag: description: >- This checksum is computed by the server based on the value of other @@ -769,6 +799,33 @@ components: type: array items: type: string + GoogleFirestoreAdminV1SourceInfo: + id: GoogleFirestoreAdminV1SourceInfo + description: Information about the provenance of this database. + type: object + properties: + backup: + description: >- + If set, this database was restored from the specified backup (or a + snapshot thereof). + $ref: '#/components/schemas/GoogleFirestoreAdminV1BackupSource' + operation: + description: >- + The associated long-running operation. This field may not be set + after the operation has completed. Format: + `projects/{project}/databases/{database}/operations/{operation}`. + type: string + GoogleFirestoreAdminV1BackupSource: + id: GoogleFirestoreAdminV1BackupSource + description: Information about a backup that was used to restore a database. + type: object + properties: + backup: + description: >- + The resource name of the backup that was used to restore this + database. Format: + `projects/{project}/locations/{location}/backups/{backup}`. + type: string GoogleFirestoreAdminV1ListDatabasesResponse: id: GoogleFirestoreAdminV1ListDatabasesResponse description: The list of databases for a project. @@ -905,41 +962,75 @@ components: databaseId: description: >- Required. The ID to use for the database, which will become the - final component of the database's resource name. This database id + final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like - /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id + /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid. type: string backup: description: >- - Backup to restore from. Must be from the same project as the parent. - Format is: + Required. Backup to restore from. Must be from the same project as + the parent. The restored database will be created in the same + location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}` type: string - databaseSnapshot: + encryptionConfig: description: >- - Database snapshot to restore from. The source database must exist - and have enabled PITR. The restored database will be created in the - same location as the source database. - $ref: '#/components/schemas/GoogleFirestoreAdminV1DatabaseSnapshot' - GoogleFirestoreAdminV1DatabaseSnapshot: - id: GoogleFirestoreAdminV1DatabaseSnapshot - description: A consistent snapshot of a database at a specific point in time. + Optional. Encryption configuration for the restored database. If + this field is not specified, the restored database will use the same + encryption configuration as the backup, namely + use_source_encryption. + $ref: '#/components/schemas/GoogleFirestoreAdminV1EncryptionConfig' + GoogleFirestoreAdminV1EncryptionConfig: + id: GoogleFirestoreAdminV1EncryptionConfig + description: >- + Encryption configuration for a new database being created from another + source. The source could be a Backup . type: object properties: - database: - description: >- - Required. A name of the form - `projects/{project_id}/databases/{database_id}` - type: string - snapshotTime: + googleDefaultEncryption: + description: Use Google default encryption. + $ref: >- + #/components/schemas/GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions + useSourceEncryption: + description: >- + The database will use the same encryption configuration as the + source. + $ref: '#/components/schemas/GoogleFirestoreAdminV1SourceEncryptionOptions' + customerManagedEncryption: + description: Use Customer Managed Encryption Keys (CMEK) for encryption. + $ref: >- + #/components/schemas/GoogleFirestoreAdminV1CustomerManagedEncryptionOptions + GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions: + id: GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions + description: The configuration options for using Google default encryption. + type: object + properties: {} + GoogleFirestoreAdminV1SourceEncryptionOptions: + id: GoogleFirestoreAdminV1SourceEncryptionOptions + description: >- + The configuration options for using the same encryption method as the + source. + type: object + properties: {} + GoogleFirestoreAdminV1CustomerManagedEncryptionOptions: + id: GoogleFirestoreAdminV1CustomerManagedEncryptionOptions + description: >- + The configuration options for using CMEK (Customer Managed Encryption + Key) encryption. + type: object + properties: + kmsKeyName: description: >- - Required. The timestamp at which the database snapshot is taken. The - requested timestamp must be a whole minute within the PITR window. + Required. Only keys in the same location as the database are allowed + to be used for encryption. For Firestore's nam5 multi-region, this + corresponds to Cloud KMS multi-region us. For Firestore's eur3 + multi-region, this corresponds to Cloud KMS multi-region europe. See + https://cloud.google.com/kms/docs/locations. The expected format is + `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. type: string - format: google-datetime GoogleFirestoreAdminV1BackupSchedule: id: GoogleFirestoreAdminV1BackupSchedule description: >- @@ -975,7 +1066,8 @@ components: retention: description: >- At what relative time in the future, compared to its creation time, - the backup should be deleted, e.g. keep backups for 7 days. + the backup should be deleted, e.g. keep backups for 7 days. The + maximum supported retention period is 14 weeks. type: string format: google-duration dailyRecurrence: @@ -990,43 +1082,7 @@ components: Represents a recurring schedule that runs every day. The time zone is UTC. type: object - properties: - time: - description: >- - Time of the day. The first run scheduled will be either on the same - day if schedule creation time precedes time_of_day or the next day - otherwise. - $ref: '#/components/schemas/TimeOfDay' - TimeOfDay: - id: TimeOfDay - description: >- - Represents a time of day. The date and time zone are either not - significant or are specified elsewhere. An API may choose to allow leap - seconds. Related types are google.type.Date and - `google.protobuf.Timestamp`. - type: object - properties: - hours: - description: >- - Hours of day in 24 hour format. Should be from 0 to 23. An API may - choose to allow the value "24:00:00" for scenarios like business - closing time. - type: integer - format: int32 - minutes: - description: Minutes of hour of day. Must be from 0 to 59. - type: integer - format: int32 - seconds: - description: >- - Seconds of minutes of the time. Must normally be from 0 to 59. An - API may allow the value 60 if it allows leap-seconds. - type: integer - format: int32 - nanos: - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - type: integer - format: int32 + properties: {} GoogleFirestoreAdminV1WeeklyRecurrence: id: GoogleFirestoreAdminV1WeeklyRecurrence description: >- @@ -1034,12 +1090,6 @@ components: week. The time zone is UTC. type: object properties: - time: - description: >- - Time of the day. If day is today, the first run will happen today if - schedule creation time precedes time_of_day, and the next week - otherwise. - $ref: '#/components/schemas/TimeOfDay' day: description: The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. type: string @@ -1920,7 +1970,11 @@ components: type: boolean FindNearest: id: FindNearest - description: Nearest Neighbors search config. + description: >- + Nearest Neighbors search config. The ordering provided by FindNearest + supersedes the order_by stage. If multiple documents have the same + vector distance, the returned document order is not guaranteed to be + stable between queries. type: object properties: vectorField: @@ -1942,19 +1996,23 @@ components: - >- Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to - learn more + learn more. The resulting distance decreases the more similar two + vectors are. - >- - Compares vectors based on the angle between them, which allows you - to measure similarity that isn't based on the vectors magnitude. - We recommend using DOT_PRODUCT with unit normalized vectors - instead of COSINE distance, which is mathematically equivalent - with better performance. See [Cosine + COSINE distance compares vectors based on the angle between them, + which allows you to measure similarity that isn't based on the + vectors magnitude. We recommend using DOT_PRODUCT with unit + normalized vectors instead of COSINE distance, which is + mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to - learn more. + learn more about COSINE similarity and COSINE distance. The + resulting COSINE distance decreases the more similar two vectors + are. - >- Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to - learn more. + learn more. The resulting distance increases the more similar two + vectors are. enum: - DISTANCE_MEASURE_UNSPECIFIED - EUCLIDEAN @@ -1966,6 +2024,23 @@ components: positive integer of no more than 1000. type: integer format: int32 + distanceResultField: + description: >- + Optional. Optional name of the field to output the result of the + vector distance calculation. Must conform to document field name + limitations. + type: string + distanceThreshold: + description: >- + Optional. Option to specify a threshold for which no less similar + documents will be returned. The behavior of the specified + `distance_measure` will affect the meaning of the distance + threshold. Since DOT_PRODUCT distances increase when the vectors are + more similar, the comparison is inverted. For EUCLIDEAN, COSINE: + WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance + >= distance_threshold + type: number + format: double ExplainOptions: id: ExplainOptions description: Explain options for the query. @@ -2607,11 +2682,7 @@ components: A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical - change, if multiple targets are affected. For PipelineQueryTargets, - `document` will be in the new pipeline format, For a Listen stream with - both QueryTargets and PipelineQueryTargets present, if a document - matches both types of queries, then a separate DocumentChange messages - will be sent out one for each set. + change, if multiple targets are affected. type: object properties: document: @@ -3056,7 +3127,7 @@ components: description: The progress, in bytes, of this operation. $ref: '#/components/schemas/GoogleFirestoreAdminV1Progress' collectionIds: - description: Which collection ids are being exported. + description: Which collection IDs are being exported. type: array items: type: string @@ -3064,7 +3135,7 @@ components: description: Where the documents are being exported to. type: string namespaceIds: - description: Which namespace ids are being exported. + description: Which namespace IDs are being exported. type: array items: type: string @@ -3075,6 +3146,72 @@ components: consistency of the documents being exported. type: string format: google-datetime + GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata: + id: GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata + description: >- + Metadata for google.longrunning.Operation results from + FirestoreAdmin.BulkDeleteDocuments. + type: object + properties: + startTime: + description: The time this operation started. + type: string + format: google-datetime + endTime: + description: >- + The time this operation completed. Will be unset if operation still + in progress. + type: string + format: google-datetime + operationState: + description: The state of the operation. + type: string + enumDescriptions: + - Unspecified. + - Request is being prepared for processing. + - Request is actively being processed. + - >- + Request is in the process of being cancelled after user called + google.longrunning.Operations.CancelOperation on the operation. + - Request has been processed and is in its finalization stage. + - Request has completed successfully. + - Request has finished being processed, but encountered an error. + - >- + Request has finished being cancelled after user called + google.longrunning.Operations.CancelOperation. + enum: + - OPERATION_STATE_UNSPECIFIED + - INITIALIZING + - PROCESSING + - CANCELLING + - FINALIZING + - SUCCESSFUL + - FAILED + - CANCELLED + progressDocuments: + description: The progress, in documents, of this operation. + $ref: '#/components/schemas/GoogleFirestoreAdminV1Progress' + progressBytes: + description: The progress, in bytes, of this operation. + $ref: '#/components/schemas/GoogleFirestoreAdminV1Progress' + collectionIds: + description: The IDs of the collection groups that are being deleted. + type: array + items: + type: string + namespaceIds: + description: Which namespace IDs are being deleted. + type: array + items: + type: string + snapshotTime: + description: >- + The timestamp that corresponds to the version of the database that + is being read to get the list of documents to delete. This time can + also be used as the timestamp of PITR in case of disaster recovery + (subject to PITR window limit). + type: string + format: google-datetime GoogleFirestoreAdminV1ImportDocumentsMetadata: id: GoogleFirestoreAdminV1ImportDocumentsMetadata description: >- @@ -3124,7 +3261,7 @@ components: description: The progress, in bytes, of this operation. $ref: '#/components/schemas/GoogleFirestoreAdminV1Progress' collectionIds: - description: Which collection ids are being imported. + description: Which collection IDs are being imported. type: array items: type: string @@ -3132,7 +3269,7 @@ components: description: The location of the documents being imported. type: string namespaceIds: - description: Which namespace ids are being imported. + description: Which namespace IDs are being imported. type: array items: type: string @@ -3299,16 +3436,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3321,6 +3455,7 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] backups: id: google.firestore.backups @@ -3354,6 +3489,7 @@ components: - $ref: '#/components/x-stackQL-resources/backups/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' databases: @@ -3375,6 +3511,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + bulk_delete_documents: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}:bulkDeleteDocuments/post + response: + mediaType: application/json + openAPIDocKey: '200' create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1databases/post' @@ -3421,24 +3564,24 @@ components: - $ref: '#/components/x-stackQL-resources/databases/methods/create' update: - $ref: '#/components/x-stackQL-resources/databases/methods/patch' + replace: [] delete: + - $ref: >- + #/components/x-stackQL-resources/databases/methods/bulk_delete_documents - $ref: '#/components/x-stackQL-resources/databases/methods/delete' operations: id: google.firestore.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -3466,6 +3609,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' indexes: @@ -3480,17 +3624,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1collectionGroups~1{collectionGroupsId}~1indexes/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.indexes - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -3512,6 +3653,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/indexes/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/indexes/methods/delete' fields: @@ -3533,17 +3675,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1collectionGroups~1{collectionGroupsId}~1fields/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.fields - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/fields/methods/get' @@ -3551,6 +3690,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/fields/methods/patch' + replace: [] delete: [] backup_schedules: id: google.firestore.backup_schedules @@ -3600,6 +3740,7 @@ components: - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/create' update: - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backup_schedules/methods/delete' documents: @@ -3628,28 +3769,22 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1documents~1{documentsId}~1{documentsId1}~1{collectionId}/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.documents - list: - operation: *ref_9 - response: *ref_10 - _list_documents: - operation: &ref_11 + list_documents: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1databases~1{databasesId}~1documents~1{collectionId}/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.documents - list_documents: - operation: *ref_11 - response: *ref_12 batch_get: operation: $ref: >- @@ -3732,10 +3867,12 @@ components: - $ref: '#/components/x-stackQL-resources/documents/methods/list' - $ref: '#/components/x-stackQL-resources/documents/methods/get' - $ref: '#/components/x-stackQL-resources/documents/methods/list_documents' + - $ref: '#/components/x-stackQL-resources/documents/methods/listen' insert: - $ref: '#/components/x-stackQL-resources/documents/methods/create_document' update: - $ref: '#/components/x-stackQL-resources/documents/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/documents/methods/delete' documents_collection_ids: @@ -3751,13 +3888,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/documents_collection_ids/methods/list_collection_ids insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3808,7 +3948,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a location. operationId: firestore.projects.locations.get @@ -3840,7 +3980,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a backup. operationId: firestore.projects.locations.backups.get @@ -3912,7 +4052,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backups: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists all the backups. operationId: firestore.projects.locations.backups.list @@ -3943,8 +4083,12 @@ paths: required: true schema: type: string + - in: query + name: filter + schema: + type: string /v1/projects/{projectsId}/databases/{databasesId}:exportDocuments: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Exports a copy of all or a subset of documents from Google Cloud @@ -3992,7 +4136,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}:importDocuments: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Imports documents into Google Cloud Firestore. Existing documents with @@ -4035,8 +4179,53 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/databases/{databasesId}:bulkDeleteDocuments: + parameters: *ref_1 + post: + description: >- + Bulk deletes a subset of documents from Google Cloud Firestore. + Documents created or updated after the underlying system starts to + process the request will not be deleted. The bulk delete occurs in the + background and its progress can be monitored and managed via the + Operation resource that is created. For more details on bulk delete + behavior, refer to: + https://cloud.google.com/firestore/docs/manage-data/bulk-delete + operationId: firestore.projects.databases.bulkDeleteDocuments + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleFirestoreAdminV1BulkDeleteDocumentsRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/datastore + Oauth2c: + - https://www.googleapis.com/auth/datastore + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string /v1/projects/{projectsId}/databases: - parameters: *ref_13 + parameters: *ref_1 post: description: Create a database. operationId: firestore.projects.databases.create @@ -4102,7 +4291,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/databases/{databasesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a database. operationId: firestore.projects.databases.get @@ -4208,7 +4397,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases:restore: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a new database by restoring from an existing backup. The new @@ -4251,7 +4440,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/operations: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4298,7 +4487,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/operations/{operationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4377,7 +4566,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/operations/{operationsId}:cancel: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4428,7 +4617,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a composite index. This returns a google.longrunning.Operation @@ -4521,7 +4710,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a composite index. operationId: firestore.projects.databases.collectionGroups.indexes.get @@ -4603,7 +4792,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields/{fieldsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets the metadata and configuration for a Field. operationId: firestore.projects.databases.collectionGroups.fields.get @@ -4705,7 +4894,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists the field configuration and metadata for this database. Currently, @@ -4760,7 +4949,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/backupSchedules: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a backup schedule on a database. At most two backup schedules @@ -4831,7 +5020,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a backup schedule. operationId: firestore.projects.databases.backupSchedules.get @@ -4948,7 +5137,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a single document. operationId: firestore.projects.databases.documents.get @@ -5115,7 +5304,7 @@ paths: type: string format: google-datetime /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists documents. operationId: firestore.projects.databases.documents.list @@ -5193,7 +5382,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/databases/{databasesId}/documents/{collectionId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists documents. operationId: firestore.projects.databases.documents.listDocuments @@ -5261,7 +5450,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/databases/{databasesId}/documents:batchGet: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Gets multiple documents. Documents returned by this method are not @@ -5300,7 +5489,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction: - parameters: *ref_13 + parameters: *ref_1 post: description: Starts a new transaction. operationId: firestore.projects.databases.documents.beginTransaction @@ -5337,7 +5526,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents:commit: - parameters: *ref_13 + parameters: *ref_1 post: description: Commits a transaction, while optionally updating documents. operationId: firestore.projects.databases.documents.commit @@ -5374,7 +5563,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents:rollback: - parameters: *ref_13 + parameters: *ref_1 post: description: Rolls back a transaction. operationId: firestore.projects.databases.documents.rollback @@ -5411,7 +5600,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery: - parameters: *ref_13 + parameters: *ref_1 post: description: Runs a query. operationId: firestore.projects.databases.documents.runQuery @@ -5458,7 +5647,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runAggregationQuery: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Runs an aggregation query. Rather than producing Document results like @@ -5510,7 +5699,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:partitionQuery: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Partitions a query by returning partition cursors that can be used to @@ -5561,7 +5750,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents:write: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Streams batches of document updates and deletes, in order. This method @@ -5600,7 +5789,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents:listen: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Listens to changes. This method is only available via gRPC or WebChannel @@ -5639,7 +5828,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds: - parameters: *ref_13 + parameters: *ref_1 post: description: Lists all the collection IDs underneath a document. operationId: firestore.projects.databases.documents.listCollectionIds @@ -5686,7 +5875,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents:batchWrite: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Applies a batch of write operations. The BatchWrite method does not @@ -5729,7 +5918,7 @@ paths: schema: type: string /v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}: - parameters: *ref_13 + parameters: *ref_1 post: description: Creates a new document. operationId: firestore.projects.databases.documents.createDocument diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml index 318845aa..c8e53838 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkebackup.yaml @@ -9,8 +9,8 @@ info: Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters. version: v1 - x-discovery-doc-revision: '20240518' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240902' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke servers: @@ -560,11 +560,11 @@ components: type: boolean Namespaces: id: Namespaces - description: A list of Kubernetes Namespaces + description: A list of Kubernetes Namespaces. type: object properties: namespaces: - description: Optional. A list of Kubernetes Namespaces + description: Optional. A list of Kubernetes Namespaces. type: array items: type: string @@ -1361,7 +1361,7 @@ components: description: >- Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty - string for core API group + string for core API group. type: string resourceKind: description: >- @@ -1792,7 +1792,7 @@ components: description: >- Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined - in the `RestorePlan`. If this is specified, and no resources are + in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set @@ -2568,16 +2568,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2590,23 +2587,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.gkebackup.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2634,6 +2629,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' backup_plans: @@ -2648,17 +2644,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backupPlans - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -2688,6 +2681,7 @@ components: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/create' update: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backup_plans/methods/delete' backup_plans_iam_policies: @@ -2702,17 +2696,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2726,6 +2717,9 @@ components: #/components/x-stackQL-resources/backup_plans_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backup_plans_iam_policies/methods/set_iam_policy delete: [] backups: id: google.gkebackup.backups @@ -2739,17 +2733,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}~1backups/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backups - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -2779,6 +2770,7 @@ components: - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: - $ref: '#/components/x-stackQL-resources/backups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_backup_index_download_url: @@ -2799,6 +2791,7 @@ components: #/components/x-stackQL-resources/backups_backup_index_download_url/methods/get_backup_index_download_url insert: [] update: [] + replace: [] delete: [] backups_iam_policies: id: google.gkebackup.backups_iam_policies @@ -2812,17 +2805,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}~1backups~1{backupsId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -2836,23 +2826,23 @@ components: #/components/x-stackQL-resources/backups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backups_iam_policies/methods/set_iam_policy delete: [] volume_backups: id: google.gkebackup.volume_backups name: volume_backups title: Volume_backups methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}~1backups~1{backupsId}~1volumeBackups/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.volumeBackups - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -2866,6 +2856,7 @@ components: - $ref: '#/components/x-stackQL-resources/volume_backups/methods/list' insert: [] update: [] + replace: [] delete: [] volume_backups_iam_policies: id: google.gkebackup.volume_backups_iam_policies @@ -2879,17 +2870,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_15 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1backupPlans~1{backupPlansId}~1backups~1{backupsId}~1volumeBackups~1{volumeBackupsId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_15 - response: *ref_16 test_iam_permissions: operation: $ref: >- @@ -2903,6 +2891,9 @@ components: #/components/x-stackQL-resources/volume_backups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/volume_backups_iam_policies/methods/set_iam_policy delete: [] restore_plans: id: google.gkebackup.restore_plans @@ -2916,17 +2907,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restorePlans/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.restorePlans - list: - operation: *ref_17 - response: *ref_18 get: operation: $ref: >- @@ -2956,6 +2944,7 @@ components: - $ref: '#/components/x-stackQL-resources/restore_plans/methods/create' update: - $ref: '#/components/x-stackQL-resources/restore_plans/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/restore_plans/methods/delete' restore_plans_iam_policies: @@ -2970,17 +2959,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restorePlans~1{restorePlansId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 test_iam_permissions: operation: $ref: >- @@ -2994,6 +2980,9 @@ components: #/components/x-stackQL-resources/restore_plans_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/restore_plans_iam_policies/methods/set_iam_policy delete: [] restores: id: google.gkebackup.restores @@ -3007,17 +2996,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restorePlans~1{restorePlansId}~1restores/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.restores - list: - operation: *ref_21 - response: *ref_22 get: operation: $ref: >- @@ -3047,6 +3033,7 @@ components: - $ref: '#/components/x-stackQL-resources/restores/methods/create' update: - $ref: '#/components/x-stackQL-resources/restores/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/restores/methods/delete' restores_iam_policies: @@ -3061,17 +3048,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_23 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restorePlans~1{restorePlansId}~1restores~1{restoresId}:getIamPolicy/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_23 - response: *ref_24 test_iam_permissions: operation: $ref: >- @@ -3085,23 +3069,23 @@ components: #/components/x-stackQL-resources/restores_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/restores_iam_policies/methods/set_iam_policy delete: [] volume_restores: id: google.gkebackup.volume_restores name: volume_restores title: Volume_restores methods: - _list: - operation: &ref_25 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restorePlans~1{restorePlansId}~1restores~1{restoresId}~1volumeRestores/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.volumeRestores - list: - operation: *ref_25 - response: *ref_26 get: operation: $ref: >- @@ -3115,6 +3099,7 @@ components: - $ref: '#/components/x-stackQL-resources/volume_restores/methods/list' insert: [] update: [] + replace: [] delete: [] volume_restores_iam_policies: id: google.gkebackup.volume_restores_iam_policies @@ -3128,17 +3113,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_27 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1restorePlans~1{restorePlansId}~1restores~1{restoresId}~1volumeRestores~1{volumeRestoresId}:getIamPolicy/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_27 - response: *ref_28 test_iam_permissions: operation: $ref: >- @@ -3152,10 +3134,13 @@ components: #/components/x-stackQL-resources/volume_restores_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/volume_restores_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_29 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3202,7 +3187,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Gets information about a location. operationId: gkebackup.projects.locations.get @@ -3230,7 +3215,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3273,7 +3258,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3344,7 +3329,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3391,7 +3376,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans: - parameters: *ref_29 + parameters: *ref_1 post: description: Creates a new BackupPlan in a given location. operationId: gkebackup.projects.locations.backupPlans.create @@ -3471,7 +3456,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Retrieve the details of a single BackupPlan. operationId: gkebackup.projects.locations.backupPlans.get @@ -3580,7 +3565,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3621,7 +3606,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3661,7 +3646,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3704,7 +3689,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups: - parameters: *ref_29 + parameters: *ref_1 post: description: Creates a Backup for the given BackupPlan. operationId: gkebackup.projects.locations.backupPlans.backups.create @@ -3794,7 +3779,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Retrieve the details of a single Backup. operationId: gkebackup.projects.locations.backupPlans.backups.get @@ -3922,7 +3907,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:getBackupIndexDownloadUrl: - parameters: *ref_29 + parameters: *ref_1 get: description: Retrieve the link to the backupIndex. operationId: >- @@ -3961,7 +3946,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4007,7 +3992,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4052,7 +4037,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4100,7 +4085,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups: - parameters: *ref_29 + parameters: *ref_1 get: description: Lists the VolumeBackups for a given Backup. operationId: gkebackup.projects.locations.backupPlans.backups.volumeBackups.list @@ -4155,7 +4140,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Retrieve the details of a single VolumeBackup. operationId: gkebackup.projects.locations.backupPlans.backups.volumeBackups.get @@ -4198,7 +4183,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4250,7 +4235,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4301,7 +4286,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4355,7 +4340,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans: - parameters: *ref_29 + parameters: *ref_1 post: description: Creates a new RestorePlan in a given location. operationId: gkebackup.projects.locations.restorePlans.create @@ -4435,7 +4420,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Retrieve the details of a single RestorePlan. operationId: gkebackup.projects.locations.restorePlans.get @@ -4548,7 +4533,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4589,7 +4574,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4629,7 +4614,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4672,7 +4657,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores: - parameters: *ref_29 + parameters: *ref_1 post: description: Creates a new Restore for the given RestorePlan. operationId: gkebackup.projects.locations.restorePlans.restores.create @@ -4762,7 +4747,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Retrieves the details of a single Restore. operationId: gkebackup.projects.locations.restorePlans.restores.get @@ -4890,7 +4875,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4936,7 +4921,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4981,7 +4966,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5029,7 +5014,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores: - parameters: *ref_29 + parameters: *ref_1 get: description: Lists the VolumeRestores for a given Restore. operationId: gkebackup.projects.locations.restorePlans.restores.volumeRestores.list @@ -5084,7 +5069,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}: - parameters: *ref_29 + parameters: *ref_1 get: description: Retrieve the details of a single VolumeRestore. operationId: gkebackup.projects.locations.restorePlans.restores.volumeRestores.get @@ -5127,7 +5112,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:setIamPolicy: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5179,7 +5164,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:getIamPolicy: - parameters: *ref_29 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5230,7 +5215,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:testIamPermissions: - parameters: *ref_29 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml index dbcacd7e..dfe4d611 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkehub.yaml @@ -6,9 +6,9 @@ info: email: info@stackql.io title: GKE Hub API description: '' - version: v1 - x-discovery-doc-revision: '20240519' - x-generated-date: '2024-06-03' + version: v2 + x-discovery-doc-revision: '20240902' + x-generated-date: '2024-09-13' externalDocs: url: >- https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster @@ -132,6 +132,11 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} Empty: id: Empty description: >- @@ -141,6670 +146,218 @@ components: { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object properties: {} - CancelOperationRequest: - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. - type: object - properties: {} - ListMembershipsResponse: - id: ListMembershipsResponse - description: Response message for the `GkeHub.ListMemberships` method. + ListLocationsResponse: + id: ListLocationsResponse + description: The response message for Locations.ListLocations. type: object properties: - resources: - description: The list of matching Memberships. + locations: + description: >- + A list of locations that matches the specified filter in the + request. type: array items: - $ref: '#/components/schemas/Membership' + $ref: '#/components/schemas/Location' nextPageToken: - description: >- - A token to request the next page of resources from the - `ListMemberships` method. The value of an empty string means that - there are no more resources to return. + description: The standard List next-page token. type: string - unreachable: - description: >- - List of locations that could not be reached while fetching this - list. - type: array - items: - type: string - Membership: - id: Membership - description: Membership contains information about a member cluster. + Location: + id: Location + description: A resource that represents a Google Cloud location. type: object properties: - endpoint: - description: Optional. Endpoint information to reach this member. - $ref: '#/components/schemas/MembershipEndpoint' name: description: >- - Output only. The full, unique name of this Membership resource in - the format `projects/*/locations/*/memberships/{membership_id}`, set - during creation. `membership_id` must be a valid RFC 1123 compliant - DNS label: 1. At most 63 characters in length 2. It must consist of - lower case alphanumeric characters or `-` 3. It must start and end - with an alphanumeric character Which can be expressed as the regex: - `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 - characters. - readOnly: true - type: string - labels: - description: Optional. Labels for this membership. - type: object - additionalProperties: - type: string - description: - description: >- - Output only. Description of this membership, limited to 63 - characters. Must match the regex: `a-zA-Z0-9*` This field is present - for legacy purposes. - readOnly: true - type: string - state: - description: Output only. State of the Membership resource. - readOnly: true - $ref: '#/components/schemas/MembershipState' - createTime: - description: Output only. When the Membership was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. When the Membership was last updated. - readOnly: true - type: string - format: google-datetime - deleteTime: - description: Output only. When the Membership was deleted. - readOnly: true - type: string - format: google-datetime - externalId: - description: >- - Optional. An externally-generated and managed ID for this - Membership. This ID may be modified after creation, but this is not - recommended. The ID must match the regex: `a-zA-Z0-9*` If this - Membership represents a Kubernetes cluster, this value should be set - to the UID of the `kube-system` namespace object. - type: string - lastConnectionTime: - description: >- - Output only. For clusters using Connect, the timestamp of the most - recent connection established with Google Cloud. This time is - updated every several minutes, not continuously. For clusters that - do not use GKE Connect, or that have never connected successfully, - this field will be unset. - readOnly: true - type: string - format: google-datetime - uniqueId: - description: >- - Output only. Google-generated UUID for this resource. This is unique - across all Membership resources. If a Membership resource is deleted - and another resource with the same name is created, it gets a - different unique_id. - readOnly: true - type: string - authority: - description: >- - Optional. How to identify workloads from this Membership. See the - documentation on Workload Identity for more details: - https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity - $ref: '#/components/schemas/Authority' - monitoringConfig: - description: Optional. The monitoring config information for this membership. - $ref: '#/components/schemas/MonitoringConfig' - MembershipEndpoint: - id: MembershipEndpoint - description: >- - MembershipEndpoint contains information needed to contact a Kubernetes - API, endpoint and any additional Kubernetes metadata. - type: object - properties: - gkeCluster: - description: Optional. Specific information for a GKE-on-GCP cluster. - $ref: '#/components/schemas/GkeCluster' - onPremCluster: - description: >- - Optional. Specific information for a GKE On-Prem cluster. An onprem - user-cluster who has no resourceLink is not allowed to use this - field, it should have a nil "type" instead. - $ref: '#/components/schemas/OnPremCluster' - multiCloudCluster: - description: Optional. Specific information for a GKE Multi-Cloud cluster. - $ref: '#/components/schemas/MultiCloudCluster' - edgeCluster: - description: Optional. Specific information for a Google Edge cluster. - $ref: '#/components/schemas/EdgeCluster' - applianceCluster: - description: Optional. Specific information for a GDC Edge Appliance cluster. - $ref: '#/components/schemas/ApplianceCluster' - kubernetesMetadata: - description: Output only. Useful Kubernetes-specific metadata. - readOnly: true - $ref: '#/components/schemas/KubernetesMetadata' - kubernetesResource: - description: >- - Optional. The in-cluster Kubernetes Resources that should be applied - for a correctly registered cluster, in the steady state. These - resources: * Ensure that the cluster is exclusively registered to - one and only one Hub Membership. * Propagate Workload Pool - Information available in the Membership Authority field. * Ensure - proper initial configuration of default Hub Features. - $ref: '#/components/schemas/KubernetesResource' - googleManaged: - description: >- - Output only. Whether the lifecycle of this membership is managed by - a google cluster platform service. - readOnly: true - type: boolean - GkeCluster: - id: GkeCluster - description: GkeCluster contains information specific to GKE clusters. - type: object - properties: - resourceLink: - description: >- - Immutable. Self-link of the Google Cloud resource for the GKE - cluster. For example: - //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster - Zonal clusters are also supported. - type: string - clusterMissing: - description: >- - Output only. If cluster_missing is set then it denotes that the GKE - cluster no longer exists in the GKE Control Plane. - readOnly: true - type: boolean - OnPremCluster: - id: OnPremCluster - description: OnPremCluster contains information specific to GKE On-Prem clusters. - type: object - properties: - resourceLink: - description: >- - Immutable. Self-link of the Google Cloud resource for the GKE - On-Prem cluster. For example: - //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster - //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster - type: string - clusterMissing: - description: >- - Output only. If cluster_missing is set then it denotes that - API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster - no longer exists. - readOnly: true - type: boolean - adminCluster: - description: Immutable. Whether the cluster is an admin cluster. - type: boolean - clusterType: - description: Immutable. The on prem cluster's type. - type: string - enumDescriptions: - - The ClusterType is not set. - - The ClusterType is bootstrap cluster. - - The ClusterType is baremetal hybrid cluster. - - The ClusterType is baremetal standalone cluster. - - The ClusterType is user cluster. - enum: - - CLUSTERTYPE_UNSPECIFIED - - BOOTSTRAP - - HYBRID - - STANDALONE - - USER - MultiCloudCluster: - id: MultiCloudCluster - description: >- - MultiCloudCluster contains information specific to GKE Multi-Cloud - clusters. - type: object - properties: - resourceLink: - description: >- - Immutable. Self-link of the Google Cloud resource for the GKE - Multi-Cloud cluster. For example: - //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster - //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster - //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster - type: string - clusterMissing: - description: >- - Output only. If cluster_missing is set then it denotes that - API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud - cluster no longer exists. - readOnly: true - type: boolean - EdgeCluster: - id: EdgeCluster - description: EdgeCluster contains information specific to Google Edge Clusters. - type: object - properties: - resourceLink: - description: >- - Immutable. Self-link of the Google Cloud resource for the Edge - Cluster. For example: - //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster - type: string - ApplianceCluster: - id: ApplianceCluster - description: >- - ApplianceCluster contains information specific to GDC Edge Appliance - Clusters. - type: object - properties: - resourceLink: - description: >- - Immutable. Self-link of the Google Cloud resource for the Appliance - Cluster. For example: - //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance - type: string - KubernetesMetadata: - id: KubernetesMetadata - description: >- - KubernetesMetadata provides informational metadata for Memberships - representing Kubernetes clusters. - type: object - properties: - kubernetesApiServerVersion: - description: >- - Output only. Kubernetes API server version string as reported by - `/version`. - readOnly: true - type: string - nodeProviderId: - description: >- - Output only. Node providerID as reported by the first node in the - list of nodes on the Kubernetes endpoint. On Kubernetes platforms - that support zero-node clusters (like GKE-on-GCP), the node_count - will be zero and the node_provider_id will be empty. - readOnly: true - type: string - nodeCount: - description: Output only. Node count as reported by Kubernetes nodes resources. - readOnly: true - type: integer - format: int32 - vcpuCount: - description: Output only. vCPU count as reported by Kubernetes nodes resources. - readOnly: true - type: integer - format: int32 - memoryMb: - description: >- - Output only. The total memory capacity as reported by the sum of all - Kubernetes nodes resources, defined in MB. - readOnly: true - type: integer - format: int32 - updateTime: - description: >- - Output only. The time at which these details were last updated. This - update_time is different from the Membership-level update_time since - EndpointDetails are updated internally for API consumers. - readOnly: true - type: string - format: google-datetime - KubernetesResource: - id: KubernetesResource - description: >- - KubernetesResource contains the YAML manifests and configuration for - Membership Kubernetes resources in the cluster. After CreateMembership - or UpdateMembership, these resources should be re-applied in the - cluster. - type: object - properties: - membershipCrManifest: - description: >- - Input only. The YAML representation of the Membership CR. This field - is ignored for GKE clusters where Hub can read the CR directly. - Callers should provide the CR that is currently present in the - cluster during CreateMembership or UpdateMembership, or leave this - field empty if none exists. The CR manifest is used to validate the - cluster has not been registered with another Membership. - type: string - membershipResources: - description: >- - Output only. Additional Kubernetes resources that need to be applied - to the cluster after Membership creation, and after every update. - This field is only populated in the Membership returned from a - successful long-running operation from CreateMembership or - UpdateMembership. It is not populated during normal GetMembership or - ListMemberships requests. To get the resource manifest after the - initial registration, the caller should make a UpdateMembership call - with an empty field mask. - readOnly: true - type: array - items: - $ref: '#/components/schemas/ResourceManifest' - connectResources: - description: >- - Output only. The Kubernetes resources for installing the GKE Connect - agent This field is only populated in the Membership returned from a - successful long-running operation from CreateMembership or - UpdateMembership. It is not populated during normal GetMembership or - ListMemberships requests. To get the resource manifest after the - initial registration, the caller should make a UpdateMembership call - with an empty field mask. - readOnly: true - type: array - items: - $ref: '#/components/schemas/ResourceManifest' - resourceOptions: - description: Optional. Options for Kubernetes resource generation. - $ref: '#/components/schemas/ResourceOptions' - ResourceManifest: - id: ResourceManifest - description: >- - ResourceManifest represents a single Kubernetes resource to be applied - to the cluster. - type: object - properties: - manifest: - description: YAML manifest of the resource. - type: string - clusterScoped: - description: >- - Whether the resource provided in the manifest is `cluster_scoped`. - If unset, the manifest is assumed to be namespace scoped. This field - is used for REST mapping when applying the resource in a cluster. - type: boolean - ResourceOptions: - id: ResourceOptions - description: ResourceOptions represent options for Kubernetes resource generation. - type: object - properties: - connectVersion: - description: >- - Optional. The Connect agent version to use for connect_resources. - Defaults to the latest GKE Connect version. The version must be a - currently supported version, obsolete versions will be rejected. - type: string - v1beta1Crd: - description: >- - Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` - for CustomResourceDefinition resources. This option should be set - for clusters with Kubernetes apiserver versions <1.16. - type: boolean - k8sVersion: - description: >- - Optional. Major version of the Kubernetes cluster. This is only used - to determine which version to use for the CustomResourceDefinition - resources, `apiextensions/v1beta1` or`apiextensions/v1`. - type: string - MembershipState: - id: MembershipState - description: MembershipState describes the state of a Membership resource. - type: object - properties: - code: - description: Output only. The current state of the Membership resource. - readOnly: true - type: string - enumDescriptions: - - The code is not set. - - The cluster is being registered. - - The cluster is registered. - - The cluster is being unregistered. - - The Membership is being updated. - - The Membership is being updated by the Hub Service. - enum: - - CODE_UNSPECIFIED - - CREATING - - READY - - DELETING - - UPDATING - - SERVICE_UPDATING - Authority: - id: Authority - description: >- - Authority encodes how Google will recognize identities from this - Membership. See the workload identity documentation for more details: - https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity - type: object - properties: - issuer: - description: >- - Optional. A JSON Web Token (JWT) issuer URI. `issuer` must start - with `https://` and be a valid URL with length <2000 characters, it - must use `location` rather than `zone` for GKE clusters. If set, - then Google will allow valid OIDC tokens from this issuer to - authenticate within the workload_identity_pool. OIDC discovery will - be performed on this URI to validate tokens from the issuer. - Clearing `issuer` disables Workload Identity. `issuer` cannot be - directly modified; it must be cleared (and Workload Identity - disabled) before using a new issuer (and re-enabling Workload - Identity). - type: string - workloadIdentityPool: - description: >- - Output only. The name of the workload identity pool in which - `issuer` will be recognized. There is a single Workload Identity - Pool per Hub that is shared between all Memberships that belong to - that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format - is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in - newer versions of this API. - readOnly: true - type: string - identityProvider: - description: >- - Output only. An identity provider that reflects the `issuer` in the - workload identity pool. - readOnly: true - type: string - oidcJwks: - description: >- - Optional. OIDC verification keys for this Membership in JWKS format - (RFC 7517). When this field is set, OIDC discovery will NOT be - performed on `issuer`, and instead OIDC tokens will be validated - using this field. - type: string - format: byte - MonitoringConfig: - id: MonitoringConfig - description: >- - MonitoringConfig informs Fleet-based applications/services/UIs how the - metrics for the underlying cluster is reported to cloud monitoring - services. It can be set from empty to non-empty, but can't be mutated - directly to prevent accidentally breaking the constinousty of metrics. - type: object - properties: - projectId: - description: Optional. Project used to report Metrics - type: string - location: - description: Optional. Location used to report Metrics - type: string - cluster: - description: >- - Optional. Cluster name used to report metrics. For Anthos on - VMWare/Baremetal/MultiCloud clusters, it would be in format - {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". - type: string - kubernetesMetricsPrefix: - description: >- - Optional. Kubernetes system metrics, if available, are written to - this prefix. This defaults to kubernetes.io for GKE, and - kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud - will have kubernetes.io prefix today but will migration to be under - kubernetes.io/anthos. - type: string - clusterHash: - description: >- - Optional. For GKE and Multicloud clusters, this is the UUID of the - cluster resource. For VMWare and Baremetal clusters, this is the - kube-system UID. - type: string - ListBoundMembershipsResponse: - id: ListBoundMembershipsResponse - description: List of Memberships bound to a Scope. - type: object - properties: - memberships: - description: The list of Memberships bound to the given Scope. - type: array - items: - $ref: '#/components/schemas/Membership' - unreachable: - description: >- - List of locations that could not be reached while fetching this - list. - type: array - items: - type: string - nextPageToken: - description: >- - A token to request the next page of resources from the - `ListBoundMemberships` method. The value of an empty string means - that there are no more resources to return. + Resource name for the location, which may vary between + implementations. For example: + `"projects/example-project/locations/us-east1"` type: string - ListFeaturesResponse: - id: ListFeaturesResponse - description: Response message for the `GkeHub.ListFeatures` method. - type: object - properties: - resources: - description: The list of matching Features - type: array - items: - $ref: '#/components/schemas/Feature' - nextPageToken: - description: >- - A token to request the next page of resources from the - `ListFeatures` method. The value of an empty string means that there - are no more resources to return. + locationId: + description: 'The canonical id for this location. For example: `"us-east1"`.' type: string - Feature: - id: Feature - description: Feature represents the settings and status of any Hub Feature. - type: object - properties: - name: + displayName: description: >- - Output only. The full, unique name of this Feature resource in the - format `projects/*/locations/*/features/*`. - readOnly: true + The friendly name for this location, typically a nearby city name. + For example, "Tokyo". type: string labels: - description: Labels for this Feature. - type: object - additionalProperties: - type: string - resourceState: - description: Output only. State of the Feature resource itself. - readOnly: true - $ref: '#/components/schemas/FeatureResourceState' - spec: - description: >- - Optional. Hub-wide Feature configuration. If this Feature does not - support any Hub-wide configuration, this field may be unused. - $ref: '#/components/schemas/CommonFeatureSpec' - membershipSpecs: - description: >- - Optional. Membership-specific configuration for this Feature. If - this Feature does not support any per-Membership configuration, this - field may be unused. The keys indicate which Membership the - configuration is for, in the form: - `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the - project, {l} is a valid location and {m} is a valid Membership in - this project at that location. {p} WILL match the Feature's project. - {p} will always be returned as the project number, but the project - ID is also accepted during input. If the same Membership is - specified in the map twice (using the project ID form, and the - project number form), exactly ONE of the entries will be saved, with - no guarantees as to which. For this reason, it is recommended the - same format be used for all entries when mutating a Feature. - type: object - additionalProperties: - $ref: '#/components/schemas/MembershipFeatureSpec' - state: - description: Output only. The Hub-wide Feature state. - readOnly: true - $ref: '#/components/schemas/CommonFeatureState' - membershipStates: - description: >- - Output only. Membership-specific Feature status. If this Feature - does report any per-Membership status, this field may be unused. The - keys indicate which Membership the state is for, in the form: - `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the - project number, {l} is a valid location and {m} is a valid - Membership in this project at that location. {p} MUST match the - Feature's project number. - readOnly: true - type: object - additionalProperties: - $ref: '#/components/schemas/MembershipFeatureState' - createTime: - description: Output only. When the Feature resource was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. When the Feature resource was last updated. - readOnly: true - type: string - format: google-datetime - deleteTime: - description: Output only. When the Feature resource was deleted. - readOnly: true - type: string - format: google-datetime - fleetDefaultMemberConfig: description: >- - Optional. Feature configuration applicable to all memberships of the - fleet. - $ref: '#/components/schemas/CommonFleetDefaultMemberConfigSpec' - scopeSpecs: - description: >- - Optional. Scope-specific configuration for this Feature. If this - Feature does not support any per-Scope configuration, this field may - be unused. The keys indicate which Scope the configuration is for, - in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is - the project, {s} is a valid Scope in this project. {p} WILL match - the Feature's project. {p} will always be returned as the project - number, but the project ID is also accepted during input. If the - same Scope is specified in the map twice (using the project ID form, - and the project number form), exactly ONE of the entries will be - saved, with no guarantees as to which. For this reason, it is - recommended the same format be used for all entries when mutating a - Feature. + Cross-service attributes for the location. For example + {"cloud.googleapis.com/region": "us-east1"} type: object additionalProperties: - $ref: '#/components/schemas/ScopeFeatureSpec' - scopeStates: + type: string + metadata: description: >- - Output only. Scope-specific Feature status. If this Feature does - report any per-Scope status, this field may be unused. The keys - indicate which Scope the state is for, in the form: - `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, - {s} is a valid Scope in this project. {p} WILL match the Feature's - project. - readOnly: true + Service-specific metadata. For example the available capacity at the + given location. type: object additionalProperties: - $ref: '#/components/schemas/ScopeFeatureState' - FeatureResourceState: - id: FeatureResourceState + type: any + description: Properties of the object. Contains field @type with type URL. + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: description: >- - FeatureResourceState describes the state of a Feature *resource* in the - GkeHub API. See `FeatureState` for the "running state" of the Feature in - the Hub and across Memberships. - type: object - properties: - state: - description: The current state of the Feature resource in the Hub API. - type: string - enumDescriptions: - - State is unknown or not set. - - >- - The Feature is being enabled, and the Feature resource is being - created. Once complete, the corresponding Feature will be enabled - in this Hub. - - >- - The Feature is enabled in this Hub, and the Feature resource is - fully available. - - >- - The Feature is being disabled in this Hub, and the Feature - resource is being deleted. - - The Feature resource is being updated. - - The Feature resource is being updated by the Hub Service. - enum: - - STATE_UNSPECIFIED - - ENABLING - - ACTIVE - - DISABLING - - UPDATING - - SERVICE_UPDATING - CommonFeatureSpec: - id: CommonFeatureSpec - description: CommonFeatureSpec contains Hub-wide configuration information - type: object - properties: - multiclusteringress: - description: Multicluster Ingress-specific spec. - $ref: '#/components/schemas/MultiClusterIngressFeatureSpec' - appdevexperience: - description: Appdevexperience specific spec. - $ref: '#/components/schemas/AppDevExperienceFeatureSpec' - fleetobservability: - description: FleetObservability feature spec. - $ref: '#/components/schemas/FleetObservabilityFeatureSpec' - clusterupgrade: - description: ClusterUpgrade (fleet-based) feature spec. - $ref: '#/components/schemas/ClusterUpgradeFleetSpec' - dataplanev2: - description: DataplaneV2 feature spec. - $ref: '#/components/schemas/DataplaneV2FeatureSpec' - MultiClusterIngressFeatureSpec: - id: MultiClusterIngressFeatureSpec + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: description: >- - **Multi-cluster Ingress**: The configuration for the MultiClusterIngress - feature. - type: object - properties: - configMembership: - description: >- - Fully-qualified Membership name which hosts the MultiClusterIngress - CRD. Example: `projects/foo-proj/locations/global/memberships/bar` - type: string - AppDevExperienceFeatureSpec: - id: AppDevExperienceFeatureSpec - description: Spec for App Dev Experience Feature. - type: object - properties: {} - FleetObservabilityFeatureSpec: - id: FleetObservabilityFeatureSpec - description: >- - **Fleet Observability**: The Hub-wide input for the FleetObservability - feature. - type: object - properties: - loggingConfig: - description: >- - Specified if fleet logging feature is enabled for the entire fleet. - If UNSPECIFIED, fleet logging feature is disabled for the entire - fleet. - $ref: '#/components/schemas/FleetObservabilityLoggingConfig' - FleetObservabilityLoggingConfig: - id: FleetObservabilityLoggingConfig - description: LoggingConfig defines the configuration for different types of logs. - type: object - properties: - defaultConfig: - description: >- - Specified if applying the default routing config to logs not - specified in other configs. - $ref: '#/components/schemas/FleetObservabilityRoutingConfig' - fleetScopeLogsConfig: - description: >- - Specified if applying the routing config to all logs for all fleet - scopes. - $ref: '#/components/schemas/FleetObservabilityRoutingConfig' - FleetObservabilityRoutingConfig: - id: FleetObservabilityRoutingConfig - description: RoutingConfig configures the behaviour of fleet logging feature. - type: object - properties: - mode: - description: mode configures the logs routing mode. - type: string - enumDescriptions: - - If UNSPECIFIED, fleet logging feature is disabled. - - logs will be copied to the destination project. - - logs will be moved to the destination project. - enum: - - MODE_UNSPECIFIED - - COPY - - MOVE - ClusterUpgradeFleetSpec: - id: ClusterUpgradeFleetSpec - description: >- - **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade - feature. - type: object - properties: - upstreamFleets: - description: >- - This fleet consumes upgrades that have COMPLETE status code in the - upstream fleets. See UpgradeStatus.Code for code definitions. The - fleet name should be either fleet project number or id. This is - defined as repeated for future proof reasons. Initial implementation - will enforce at most one upstream fleet. - type: array - items: - type: string - postConditions: - description: >- - Required. Post conditions to evaluate to mark an upgrade COMPLETE. - Required. - $ref: '#/components/schemas/ClusterUpgradePostConditions' - gkeUpgradeOverrides: - description: Allow users to override some properties of each GKE upgrade. - type: array - items: - $ref: '#/components/schemas/ClusterUpgradeGKEUpgradeOverride' - ClusterUpgradePostConditions: - id: ClusterUpgradePostConditions - description: >- - Post conditional checks after an upgrade has been applied on all - eligible clusters. - type: object - properties: - soaking: - description: >- - Required. Amount of time to "soak" after a rollout has been finished - before marking it COMPLETE. Cannot exceed 30 days. Required. - type: string - format: google-duration - ClusterUpgradeGKEUpgradeOverride: - id: ClusterUpgradeGKEUpgradeOverride - description: >- - Properties of a GKE upgrade that can be overridden by the user. For - example, a user can skip soaking by overriding the soaking to 0. - type: object - properties: - upgrade: - description: Required. Which upgrade to override. Required. - $ref: '#/components/schemas/ClusterUpgradeGKEUpgrade' - postConditions: - description: >- - Required. Post conditions to override for the specified upgrade - (name + version). Required. - $ref: '#/components/schemas/ClusterUpgradePostConditions' - ClusterUpgradeGKEUpgrade: - id: ClusterUpgradeGKEUpgrade - description: >- - GKEUpgrade represents a GKE provided upgrade, e.g., control plane - upgrade. - type: object - properties: - name: - description: >- - Name of the upgrade, e.g., "k8s_control_plane". It should be a valid - upgrade name. It must not exceet 99 characters. - type: string - version: - description: >- - Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid - version. It must not exceet 99 characters. - type: string - DataplaneV2FeatureSpec: - id: DataplaneV2FeatureSpec - description: '**Dataplane V2**: Spec' - type: object - properties: - enableEncryption: - description: Enable dataplane-v2 based encryption for multiple clusters. - type: boolean - MembershipFeatureSpec: - id: MembershipFeatureSpec - description: >- - MembershipFeatureSpec contains configuration information for a single - Membership. NOTE: Please use snake case in your feature name. - type: object - properties: - configmanagement: - description: Config Management-specific spec. - $ref: '#/components/schemas/ConfigManagementMembershipSpec' - identityservice: - description: Identity Service-specific spec. - $ref: '#/components/schemas/IdentityServiceMembershipSpec' - mesh: - description: Anthos Service Mesh-specific spec - $ref: '#/components/schemas/ServiceMeshMembershipSpec' - policycontroller: - description: Policy Controller spec. - $ref: '#/components/schemas/PolicyControllerMembershipSpec' - fleetobservability: - description: Fleet observability membership spec - $ref: '#/components/schemas/FleetObservabilityMembershipSpec' - origin: - description: >- - Whether this per-Membership spec was inherited from a fleet-level - default. This field can be updated by users by either overriding a - Membership config (updated to USER implicitly) or setting to FLEET - explicitly. - $ref: '#/components/schemas/Origin' - ConfigManagementMembershipSpec: - id: ConfigManagementMembershipSpec - description: >- - **Anthos Config Management**: Configuration for a single cluster. - Intended to parallel the ConfigManagement CR. - type: object - properties: - configSync: - description: Config Sync configuration for the cluster. - $ref: '#/components/schemas/ConfigManagementConfigSync' - policyController: - description: Policy Controller configuration for the cluster. - $ref: '#/components/schemas/ConfigManagementPolicyController' - hierarchyController: - description: Hierarchy Controller configuration for the cluster. - $ref: '#/components/schemas/ConfigManagementHierarchyControllerConfig' - version: - description: Version of ACM installed. - type: string - cluster: - description: >- - The user-specified cluster name used by Config Sync - cluster-name-selector annotation or ClusterSelector, for applying - configs to only a subset of clusters. Omit this field if the - cluster's fleet membership name is used by Config Sync - cluster-name-selector annotation or ClusterSelector. Set this field - if a name different from the cluster's fleet membership name is used - by Config Sync cluster-name-selector annotation or ClusterSelector. - type: string - management: - description: Enables automatic Feature management. - type: string - enumDescriptions: - - Unspecified - - Google will manage the Feature for the cluster. - - User will manually manage the Feature for the cluster. - enum: - - MANAGEMENT_UNSPECIFIED - - MANAGEMENT_AUTOMATIC - - MANAGEMENT_MANUAL - ConfigManagementConfigSync: - id: ConfigManagementConfigSync - description: Configuration for Config Sync - type: object - properties: - git: - description: Git repo configuration for the cluster. - $ref: '#/components/schemas/ConfigManagementGitConfig' - sourceFormat: - description: >- - Specifies whether the Config Sync Repo is in "hierarchical" or - "unstructured" mode. - type: string - enabled: - description: >- - Enables the installation of ConfigSync. If set to true, ConfigSync - resources will be created and the other ConfigSync fields will be - applied if exist. If set to false, all other ConfigSync fields will - be ignored, ConfigSync resources will be deleted. If omitted, - ConfigSync resources will be managed depends on the presence of the - git or oci field. - type: boolean - preventDrift: - description: >- - Set to true to enable the Config Sync admission webhook to prevent - drifts. If set to `false`, disables the Config Sync admission - webhook and does not prevent drifts. - type: boolean - oci: - description: OCI repo configuration for the cluster - $ref: '#/components/schemas/ConfigManagementOciConfig' - allowVerticalScale: - description: >- - Set to true to allow the vertical scaling. Defaults to false which - disallows vertical scaling. This field is deprecated. - deprecated: true - type: boolean - metricsGcpServiceAccountEmail: - description: >- - The Email of the Google Cloud Service Account (GSA) used for - exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch - when Workload Identity is enabled. The GSA should have the - Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. - The Kubernetes ServiceAccount `default` in the namespace - `config-management-monitoring` should be bound to the GSA. - type: string - ConfigManagementGitConfig: - id: ConfigManagementGitConfig - description: Git repo configuration for a single cluster. - type: object - properties: - syncRepo: - description: The URL of the Git repository to use as the source of truth. - type: string - syncBranch: - description: 'The branch of the repository to sync from. Default: master.' - type: string - policyDir: - description: >- - The path within the Git repository that represents the top level of - the repo to sync. Default: the root directory of the repository. - type: string - syncWaitSecs: - description: 'Period in seconds between consecutive syncs. Default: 15.' - type: string - format: int64 - syncRev: - description: Git revision (tag or hash) to check out. Default HEAD. - type: string - secretType: - description: >- - Type of secret configured for access to the Git repo. Must be one of - ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The - validation of this is case-sensitive. Required. - type: string - httpsProxy: - description: >- - URL for the HTTPS proxy to be used when communicating with the Git - repo. - type: string - gcpServiceAccountEmail: - description: >- - The Google Cloud Service Account Email used for auth when - secret_type is gcpServiceAccount. - type: string - ConfigManagementOciConfig: - id: ConfigManagementOciConfig - description: OCI repo configuration for a single cluster - type: object - properties: - syncRepo: - description: >- - The OCI image repository URL for the package to sync from. e.g. - `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`. - type: string - policyDir: - description: >- - The absolute path of the directory that contains the local - resources. Default: the root directory of the image. - type: string - syncWaitSecs: - description: 'Period in seconds between consecutive syncs. Default: 15.' - type: string - format: int64 - secretType: - description: Type of secret configured for access to the Git repo. - type: string - gcpServiceAccountEmail: - description: >- - The Google Cloud Service Account Email used for auth when - secret_type is gcpServiceAccount. - type: string - ConfigManagementPolicyController: - id: ConfigManagementPolicyController - description: Configuration for Policy Controller - type: object - properties: - enabled: - description: >- - Enables the installation of Policy Controller. If false, the rest of - PolicyController fields take no effect. - type: boolean - templateLibraryInstalled: - description: Installs the default template library along with Policy Controller. - type: boolean - auditIntervalSeconds: - description: >- - Sets the interval for Policy Controller Audit Scans (in seconds). - When set to 0, this disables audit functionality altogether. - type: string - format: int64 - exemptableNamespaces: - description: >- - The set of namespaces that are excluded from Policy Controller - checks. Namespaces do not need to currently exist on the cluster. - type: array - items: - type: string - referentialRulesEnabled: - description: >- - Enables the ability to use Constraint Templates that reference to - objects other than the object currently being evaluated. - type: boolean - logDeniesEnabled: - description: Logs all denies and dry run failures. - type: boolean - mutationEnabled: - description: >- - Enable or disable mutation in policy controller. If true, mutation - CRDs, webhook and controller deployment will be deployed to the - cluster. - type: boolean - monitoring: - description: Monitoring specifies the configuration of monitoring. - $ref: '#/components/schemas/ConfigManagementPolicyControllerMonitoring' - updateTime: - description: Output only. Last time this membership spec was updated. - readOnly: true - type: string - format: google-datetime - ConfigManagementPolicyControllerMonitoring: - id: ConfigManagementPolicyControllerMonitoring - description: >- - PolicyControllerMonitoring specifies the backends Policy Controller - should export metrics to. For example, to specify metrics should be - exported to Cloud Monitoring and Prometheus, specify backends: - ["cloudmonitoring", "prometheus"] - type: object - properties: - backends: - description: >- - Specifies the list of backends Policy Controller will export to. An - empty list would effectively disable metrics export. - type: array - items: - type: string - enumDescriptions: - - Backend cannot be determined - - Prometheus backend for monitoring - - Stackdriver/Cloud Monitoring backend for monitoring - enum: - - MONITORING_BACKEND_UNSPECIFIED - - PROMETHEUS - - CLOUD_MONITORING - ConfigManagementHierarchyControllerConfig: - id: ConfigManagementHierarchyControllerConfig - description: Configuration for Hierarchy Controller - type: object - properties: - enabled: - description: Whether Hierarchy Controller is enabled in this cluster. - type: boolean - enablePodTreeLabels: - description: Whether pod tree labels are enabled in this cluster. - type: boolean - enableHierarchicalResourceQuota: - description: Whether hierarchical resource quota is enabled in this cluster. - type: boolean - IdentityServiceMembershipSpec: - id: IdentityServiceMembershipSpec - description: '**Anthos Identity Service**: Configuration for a single Membership.' - type: object - properties: - authMethods: - description: A member may support multiple auth methods. - type: array - items: - $ref: '#/components/schemas/IdentityServiceAuthMethod' - identityServiceOptions: - description: Optional. non-protocol-related configuration options. - $ref: '#/components/schemas/IdentityServiceIdentityServiceOptions' - IdentityServiceAuthMethod: - id: IdentityServiceAuthMethod - description: >- - Configuration of an auth method for a member/cluster. Only one - authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. - type: object - properties: - oidcConfig: - description: OIDC specific configuration. - $ref: '#/components/schemas/IdentityServiceOidcConfig' - azureadConfig: - description: AzureAD specific Configuration. - $ref: '#/components/schemas/IdentityServiceAzureADConfig' - googleConfig: - description: GoogleConfig specific configuration. - $ref: '#/components/schemas/IdentityServiceGoogleConfig' - samlConfig: - description: SAML specific configuration. - $ref: '#/components/schemas/IdentityServiceSamlConfig' - ldapConfig: - description: LDAP specific configuration. - $ref: '#/components/schemas/IdentityServiceLdapConfig' - name: - description: Identifier for auth config. - type: string - proxy: - description: Proxy server address to use for auth method. - type: string - IdentityServiceOidcConfig: - id: IdentityServiceOidcConfig - description: Configuration for OIDC Auth flow. - type: object - properties: - clientId: - description: ID for OIDC client application. - type: string - certificateAuthorityData: - description: PEM-encoded CA for OIDC provider. - type: string - issuerUri: - description: >- - URI for the OIDC provider. This should point to the level below - .well-known/openid-configuration. - type: string - kubectlRedirectUri: - description: >- - Registered redirect uri to redirect users going through OAuth flow - using kubectl plugin. - type: string - scopes: - description: Comma-separated list of identifiers. - type: string - extraParams: - description: Comma-separated list of key-value pairs. - type: string - userClaim: - description: Claim in OIDC ID token that holds username. - type: string - userPrefix: - description: Prefix to prepend to user name. - type: string - groupsClaim: - description: Claim in OIDC ID token that holds group information. - type: string - groupPrefix: - description: Prefix to prepend to group name. - type: string - deployCloudConsoleProxy: - description: >- - Flag to denote if reverse proxy is used to connect to auth provider. - This flag should be set to true when provider is not reachable by - Google Cloud Console. - type: boolean - clientSecret: - description: >- - Input only. Unencrypted OIDC client secret will be passed to the GKE - Hub CLH. - type: string - encryptedClientSecret: - description: Output only. Encrypted OIDC Client secret - readOnly: true - type: string - format: byte - enableAccessToken: - description: Enable access token. - type: boolean - IdentityServiceAzureADConfig: - id: IdentityServiceAzureADConfig - description: Configuration for the AzureAD Auth flow. - type: object - properties: - clientId: - description: >- - ID for the registered client application that makes authentication - requests to the Azure AD identity provider. - type: string - tenant: - description: >- - Kind of Azure AD account to be authenticated. Supported values are - or for accounts belonging to a specific tenant. - type: string - kubectlRedirectUri: - description: The redirect URL that kubectl uses for authorization. - type: string - clientSecret: - description: >- - Input only. Unencrypted AzureAD client secret will be passed to the - GKE Hub CLH. - type: string - encryptedClientSecret: - description: Output only. Encrypted AzureAD client secret. - readOnly: true - type: string - format: byte - userClaim: - description: Optional. Claim in the AzureAD ID Token that holds the user details. - type: string - groupFormat: - description: >- - Optional. Format of the AzureAD groups that the client wants for - auth. - type: string - IdentityServiceGoogleConfig: - id: IdentityServiceGoogleConfig - description: Configuration for the Google Plugin Auth flow. - type: object - properties: - disable: - description: >- - Disable automatic configuration of Google Plugin on supported - platforms. - type: boolean - IdentityServiceSamlConfig: - id: IdentityServiceSamlConfig - description: Configuration for the SAML Auth flow. - type: object - properties: - identityProviderId: - description: Required. The entity ID of the SAML IdP. - type: string - identityProviderSsoUri: - description: Required. The URI where the SAML IdP exposes the SSO service. - type: string - identityProviderCertificates: - description: >- - Required. The list of IdP certificates to validate the SAML response - against. - type: array - items: - type: string - userAttribute: - description: >- - Optional. The SAML attribute to read username from. If unspecified, - the username will be read from the NameID element of the assertion - in SAML response. This value is expected to be a string and will be - passed along as-is (with the option of being prefixed by the - `user_prefix`). - type: string - groupsAttribute: - description: >- - Optional. The SAML attribute to read groups from. This value is - expected to be a string and will be passed along as-is (with the - option of being prefixed by the `group_prefix`). - type: string - userPrefix: - description: Optional. Prefix to prepend to user name. - type: string - groupPrefix: - description: Optional. Prefix to prepend to group name. - type: string - attributeMapping: - description: >- - Optional. The mapping of additional user attributes like nickname, - birthday and address etc.. `key` is the name of this additional - attribute. `value` is a string presenting as CEL(common expression - language, go/cel) used for getting the value from the resources. - Take nickname as an example, in this case, `key` is - "attribute.nickname" and `value` is "assertion.nickname". - type: object - additionalProperties: - type: string - IdentityServiceLdapConfig: - id: IdentityServiceLdapConfig - description: Configuration for the LDAP Auth flow. - type: object - properties: - server: - description: Required. Server settings for the external LDAP server. - $ref: '#/components/schemas/IdentityServiceServerConfig' - user: - description: Required. Defines where users exist in the LDAP directory. - $ref: '#/components/schemas/IdentityServiceUserConfig' - group: - description: >- - Optional. Contains the properties for locating and authenticating - groups in the directory. - $ref: '#/components/schemas/IdentityServiceGroupConfig' - serviceAccount: - description: >- - Required. Contains the credentials of the service account which is - authorized to perform the LDAP search in the directory. The - credentials can be supplied by the combination of the DN and - password or the client certificate. - $ref: '#/components/schemas/IdentityServiceServiceAccountConfig' - IdentityServiceServerConfig: - id: IdentityServiceServerConfig - description: Server settings for the external LDAP server. - type: object - properties: - host: - description: >- - Required. Defines the hostname or IP of the LDAP server. Port is - optional and will default to 389, if unspecified. For example, - "ldap.server.example" or "10.10.10.10:389". - type: string - connectionType: - description: >- - Optional. Defines the connection type to communicate with the LDAP - server. If `starttls` or `ldaps` is specified, the - certificate_authority_data should not be empty. - type: string - certificateAuthorityData: - description: >- - Optional. Contains a Base64 encoded, PEM formatted certificate - authority certificate for the LDAP server. This must be provided for - the "ldaps" and "startTLS" connections. - type: string - format: byte - IdentityServiceUserConfig: - id: IdentityServiceUserConfig - description: Defines where users exist in the LDAP directory. - type: object - properties: - baseDn: - description: >- - Required. The location of the subtree in the LDAP directory to - search for user entries. - type: string - loginAttribute: - description: >- - Optional. The name of the attribute which matches against the input - username. This is used to find the user in the LDAP database e.g. - "(=)" and is combined with the optional filter field. This defaults - to "userPrincipalName". - type: string - idAttribute: - description: >- - Optional. Determines which attribute to use as the user's identity - after they are authenticated. This is distinct from the - loginAttribute field to allow users to login with a username, but - then have their actual identifier be an email address or full - Distinguished Name (DN). For example, setting loginAttribute to - "sAMAccountName" and identifierAttribute to "userPrincipalName" - would allow a user to login as "bsmith", but actual RBAC policies - for the user would be written as "bsmith@example.com". Using - "userPrincipalName" is recommended since this will be unique for - each user. This defaults to "userPrincipalName". - type: string - filter: - description: >- - Optional. Filter to apply when searching for the user. This can be - used to further restrict the user accounts which are allowed to - login. This defaults to "(objectClass=User)". - type: string - IdentityServiceGroupConfig: - id: IdentityServiceGroupConfig - description: >- - Contains the properties for locating and authenticating groups in the - directory. - type: object - properties: - baseDn: - description: >- - Required. The location of the subtree in the LDAP directory to - search for group entries. - type: string - idAttribute: - description: >- - Optional. The identifying name of each group a user belongs to. For - example, if this is set to "distinguishedName" then RBACs and other - group expectations should be written as full DNs. This defaults to - "distinguishedName". - type: string - filter: - description: >- - Optional. Optional filter to be used when searching for groups a - user belongs to. This can be used to explicitly match only certain - groups in order to reduce the amount of groups returned for each - user. This defaults to "(objectClass=Group)". - type: string - IdentityServiceServiceAccountConfig: - id: IdentityServiceServiceAccountConfig - description: >- - Contains the credentials of the service account which is authorized to - perform the LDAP search in the directory. The credentials can be - supplied by the combination of the DN and password or the client - certificate. - type: object - properties: - simpleBindCredentials: - description: Credentials for basic auth. - $ref: '#/components/schemas/IdentityServiceSimpleBindCredentials' - IdentityServiceSimpleBindCredentials: - id: IdentityServiceSimpleBindCredentials - description: The structure holds the LDAP simple binding credential. - type: object - properties: - dn: - description: >- - Required. The distinguished name(DN) of the service account - object/user. - type: string - password: - description: >- - Required. Input only. The password of the service account - object/user. - type: string - encryptedPassword: - description: >- - Output only. The encrypted password of the service account - object/user. - readOnly: true - type: string - format: byte - IdentityServiceIdentityServiceOptions: - id: IdentityServiceIdentityServiceOptions - description: Holds non-protocol-related configuration options. - type: object - properties: - sessionDuration: - description: >- - Optional. Determines the lifespan of STS tokens issued by Anthos - Identity Service. - type: string - format: google-duration - ServiceMeshMembershipSpec: - id: ServiceMeshMembershipSpec - description: >- - **Service Mesh**: Spec for a single Membership for the servicemesh - feature - type: object - properties: - controlPlane: - description: >- - Deprecated: use `management` instead Enables automatic control plane - management. - deprecated: true - type: string - enumDescriptions: - - Unspecified - - >- - Google should provision a control plane revision and make it - available in the cluster. Google will enroll this revision in a - release channel and keep it up to date. The control plane revision - may be a managed service, or a managed install. - - >- - User will manually configure the control plane (e.g. via CLI, or - via the ControlPlaneRevision KRM API) - enum: - - CONTROL_PLANE_MANAGEMENT_UNSPECIFIED - - AUTOMATIC - - MANUAL - management: - description: Enables automatic Service Mesh management. - type: string - enumDescriptions: - - Unspecified - - Google should manage my Service Mesh for the cluster. - - User will manually configure their service mesh components. - enum: - - MANAGEMENT_UNSPECIFIED - - MANAGEMENT_AUTOMATIC - - MANAGEMENT_MANUAL - PolicyControllerMembershipSpec: - id: PolicyControllerMembershipSpec - description: >- - **Policy Controller**: Configuration for a single cluster. Intended to - parallel the PolicyController CR. - type: object - properties: - policyControllerHubConfig: - description: Policy Controller configuration for the cluster. - $ref: '#/components/schemas/PolicyControllerHubConfig' - version: - description: Version of Policy Controller installed. - type: string - PolicyControllerHubConfig: - id: PolicyControllerHubConfig - description: Configuration for Policy Controller - type: object - properties: - installSpec: - description: >- - The install_spec represents the intended state specified by the - latest request that mutated install_spec in the feature spec, not - the lifecycle state of the feature observed by the Hub feature - controller that is reported in the feature state. - type: string - enumDescriptions: - - Spec is unknown. - - Request to uninstall Policy Controller. - - Request to install and enable Policy Controller. - - >- - Request to suspend Policy Controller i.e. its webhooks. If Policy - Controller is not installed, it will be installed but suspended. - - >- - Request to stop all reconciliation actions by PoCo Hub controller. - This is a breakglass mechanism to stop PoCo Hub from affecting - cluster resources. - enum: - - INSTALL_SPEC_UNSPECIFIED - - INSTALL_SPEC_NOT_INSTALLED - - INSTALL_SPEC_ENABLED - - INSTALL_SPEC_SUSPENDED - - INSTALL_SPEC_DETACHED - auditIntervalSeconds: - description: >- - Sets the interval for Policy Controller Audit Scans (in seconds). - When set to 0, this disables audit functionality altogether. - type: string - format: int64 - exemptableNamespaces: - description: >- - The set of namespaces that are excluded from Policy Controller - checks. Namespaces do not need to currently exist on the cluster. - type: array - items: - type: string - referentialRulesEnabled: - description: >- - Enables the ability to use Constraint Templates that reference to - objects other than the object currently being evaluated. - type: boolean - logDeniesEnabled: - description: Logs all denies and dry run failures. - type: boolean - mutationEnabled: - description: Enables the ability to mutate resources using Policy Controller. - type: boolean - monitoring: - description: Monitoring specifies the configuration of monitoring. - $ref: '#/components/schemas/PolicyControllerMonitoringConfig' - policyContent: - description: Specifies the desired policy content on the cluster - $ref: '#/components/schemas/PolicyControllerPolicyContentSpec' - constraintViolationLimit: - description: >- - The maximum number of audit violations to be stored in a constraint. - If not set, the internal default (currently 20) will be used. - type: string - format: int64 - deploymentConfigs: - description: >- - Map of deployment configs to deployments ("admission", "audit", - "mutation'). - type: object - additionalProperties: - $ref: >- - #/components/schemas/PolicyControllerPolicyControllerDeploymentConfig - PolicyControllerMonitoringConfig: - id: PolicyControllerMonitoringConfig - description: >- - MonitoringConfig specifies the backends Policy Controller should export - metrics to. For example, to specify metrics should be exported to Cloud - Monitoring and Prometheus, specify backends: ["cloudmonitoring", - "prometheus"] - type: object - properties: - backends: - description: >- - Specifies the list of backends Policy Controller will export to. An - empty list would effectively disable metrics export. - type: array - items: - type: string - enumDescriptions: - - Backend cannot be determined - - Prometheus backend for monitoring - - Stackdriver/Cloud Monitoring backend for monitoring - enum: - - MONITORING_BACKEND_UNSPECIFIED - - PROMETHEUS - - CLOUD_MONITORING - PolicyControllerPolicyContentSpec: - id: PolicyControllerPolicyContentSpec - description: >- - PolicyContentSpec defines the user's desired content configuration on - the cluster. - type: object - properties: - bundles: - description: >- - map of bundle name to BundleInstallSpec. The bundle name maps to the - `bundleName` key in the `policycontroller.gke.io/constraintData` - annotation on a constraint. - type: object - additionalProperties: - $ref: '#/components/schemas/PolicyControllerBundleInstallSpec' - templateLibrary: - description: Configures the installation of the Template Library. - $ref: '#/components/schemas/PolicyControllerTemplateLibraryConfig' - PolicyControllerBundleInstallSpec: - id: PolicyControllerBundleInstallSpec - description: >- - BundleInstallSpec is the specification configuration for a single - managed bundle. - type: object - properties: - exemptedNamespaces: - description: The set of namespaces to be exempted from the bundle. - type: array - items: - type: string - PolicyControllerTemplateLibraryConfig: - id: PolicyControllerTemplateLibraryConfig - description: The config specifying which default library templates to install. - type: object - properties: - installation: - description: >- - Configures the manner in which the template library is installed on - the cluster. - type: string - enumDescriptions: - - No installation strategy has been specified. - - Do not install the template library. - - Install the entire template library. - enum: - - INSTALLATION_UNSPECIFIED - - NOT_INSTALLED - - ALL - PolicyControllerPolicyControllerDeploymentConfig: - id: PolicyControllerPolicyControllerDeploymentConfig - description: Deployment-specific configuration. - type: object - properties: - replicaCount: - description: Pod replica count. - type: string - format: int64 - containerResources: - description: Container resource requirements. - $ref: '#/components/schemas/PolicyControllerResourceRequirements' - podAntiAffinity: - description: >- - Pod anti-affinity enablement. Deprecated: use `pod_affinity` - instead. - deprecated: true - type: boolean - podTolerations: - description: Pod tolerations of node taints. - type: array - items: - $ref: '#/components/schemas/PolicyControllerToleration' - podAffinity: - description: Pod affinity configuration. - type: string - enumDescriptions: - - No affinity configuration has been specified. - - Affinity configurations will be removed from the deployment. - - >- - Anti-affinity configuration will be applied to this deployment. - Default for admissions deployment. - enum: - - AFFINITY_UNSPECIFIED - - NO_AFFINITY - - ANTI_AFFINITY - PolicyControllerResourceRequirements: - id: PolicyControllerResourceRequirements - description: ResourceRequirements describes the compute resource requirements. - type: object - properties: - limits: - description: >- - Limits describes the maximum amount of compute resources allowed for - use by the running container. - $ref: '#/components/schemas/PolicyControllerResourceList' - requests: - description: >- - Requests describes the amount of compute resources reserved for the - container by the kube-scheduler. - $ref: '#/components/schemas/PolicyControllerResourceList' - PolicyControllerResourceList: - id: PolicyControllerResourceList - description: ResourceList contains container resource requirements. - type: object - properties: - memory: - description: Memory requirement expressed in Kubernetes resource units. - type: string - cpu: - description: CPU requirement expressed in Kubernetes resource units. - type: string - PolicyControllerToleration: - id: PolicyControllerToleration - description: Toleration of a node taint. - type: object - properties: - key: - description: Matches a taint key (not necessarily unique). - type: string - operator: - description: Matches a taint operator. - type: string - value: - description: Matches a taint value. - type: string - effect: - description: Matches a taint effect. - type: string - FleetObservabilityMembershipSpec: - id: FleetObservabilityMembershipSpec - description: >- - **FleetObservability**: The membership-specific input for - FleetObservability feature. - type: object - properties: {} - Origin: - id: Origin - description: Origin defines where this MembershipFeatureSpec originated from. - type: object - properties: - type: - description: Type specifies which type of origin is set. - type: string - enumDescriptions: - - Type is unknown or not set. - - Per-Membership spec was inherited from the fleet-level default. - - >- - Per-Membership spec was inherited from the fleet-level default but - is now out of sync with the current default. - - Per-Membership spec was inherited from a user specification. - enum: - - TYPE_UNSPECIFIED - - FLEET - - FLEET_OUT_OF_SYNC - - USER - CommonFeatureState: - id: CommonFeatureState - description: CommonFeatureState contains Hub-wide Feature status information. - type: object - properties: - appdevexperience: - description: Appdevexperience specific state. - $ref: '#/components/schemas/AppDevExperienceFeatureState' - fleetobservability: - description: FleetObservability feature state. - $ref: '#/components/schemas/FleetObservabilityFeatureState' - clusterupgrade: - description: ClusterUpgrade fleet-level state. - $ref: '#/components/schemas/ClusterUpgradeFleetState' - state: - description: Output only. The "running state" of the Feature in this Hub. - readOnly: true - $ref: '#/components/schemas/FeatureState' - AppDevExperienceFeatureState: - id: AppDevExperienceFeatureState - description: State for App Dev Exp Feature. - type: object - properties: - networkingInstallSucceeded: - description: >- - Status of subcomponent that detects configured Service Mesh - resources. - $ref: '#/components/schemas/Status' - Status: - id: Status - description: Status specifies state for the subcomponent. - type: object - properties: - code: - description: Code specifies AppDevExperienceFeature's subcomponent ready state. - type: string - enumDescriptions: - - Not set. - - AppDevExperienceFeature's specified subcomponent is ready. - - >- - AppDevExperienceFeature's specified subcomponent ready state is - false. This means AppDevExperienceFeature has encountered an issue - that blocks all, or a portion, of its normal operation. See the - `description` for more details. - - >- - AppDevExperienceFeature's specified subcomponent has a pending or - unknown state. - enum: - - CODE_UNSPECIFIED - - OK - - FAILED - - UNKNOWN - description: - description: >- - Description is populated if Code is Failed, explaining why it has - failed. - type: string - FleetObservabilityFeatureState: - id: FleetObservabilityFeatureState - description: >- - **FleetObservability**: Hub-wide Feature for FleetObservability feature. - state. - type: object - properties: - logging: - description: The feature state of default logging. - $ref: >- - #/components/schemas/FleetObservabilityFleetObservabilityLoggingState - monitoring: - description: The feature state of fleet monitoring. - $ref: >- - #/components/schemas/FleetObservabilityFleetObservabilityMonitoringState - FleetObservabilityFleetObservabilityLoggingState: - id: FleetObservabilityFleetObservabilityLoggingState - description: Feature state for logging feature. - type: object - properties: - defaultLog: - description: The base feature state of fleet default log. - $ref: >- - #/components/schemas/FleetObservabilityFleetObservabilityBaseFeatureState - scopeLog: - description: The base feature state of fleet scope log. - $ref: >- - #/components/schemas/FleetObservabilityFleetObservabilityBaseFeatureState - FleetObservabilityFleetObservabilityBaseFeatureState: - id: FleetObservabilityFleetObservabilityBaseFeatureState - description: Base state for fleet observability feature. - type: object - properties: - code: - description: The high-level, machine-readable status of this Feature. - type: string - enumDescriptions: - - Unknown or not set. - - The Feature is operating normally. - - >- - The Feature is encountering errors in the reconciliation. The - Feature may need intervention to return to normal operation. See - the description and any associated Feature-specific details for - more information. - enum: - - CODE_UNSPECIFIED - - OK - - ERROR - errors: - description: >- - Errors after reconciling the monitoring and logging feature if the - code is not OK. - type: array - items: - $ref: '#/components/schemas/FleetObservabilityFeatureError' - FleetObservabilityFeatureError: - id: FleetObservabilityFeatureError - description: All error details of the fleet observability feature. - type: object - properties: - code: - description: The code of the error. - type: string - description: - description: A human-readable description of the current status. - type: string - FleetObservabilityFleetObservabilityMonitoringState: - id: FleetObservabilityFleetObservabilityMonitoringState - description: Feature state for monitoring feature. - type: object - properties: - state: - description: The base feature state of fleet monitoring feature. - $ref: >- - #/components/schemas/FleetObservabilityFleetObservabilityBaseFeatureState - ClusterUpgradeFleetState: - id: ClusterUpgradeFleetState - description: >- - **ClusterUpgrade**: The state for the fleet-level ClusterUpgrade - feature. - type: object - properties: - downstreamFleets: - description: >- - This fleets whose upstream_fleets contain the current fleet. The - fleet name should be either fleet project number or id. - type: array - items: - type: string - ignored: - description: >- - A list of memberships ignored by the feature. For example, manually - upgraded clusters can be ignored if they are newer than the default - versions of its release channel. The membership resource is in the - format: `projects/{p}/locations/{l}/membership/{m}`. - type: object - additionalProperties: - $ref: '#/components/schemas/ClusterUpgradeIgnoredMembership' - gkeState: - description: Feature state for GKE clusters. - $ref: '#/components/schemas/ClusterUpgradeGKEUpgradeFeatureState' - ClusterUpgradeIgnoredMembership: - id: ClusterUpgradeIgnoredMembership - description: >- - IgnoredMembership represents a membership ignored by the feature. A - membership can be ignored because it was manually upgraded to a newer - version than RC default. - type: object - properties: - reason: - description: Reason why the membership is ignored. - type: string - ignoredTime: - description: Time when the membership was first set to ignored. - type: string - format: google-datetime - ClusterUpgradeGKEUpgradeFeatureState: - id: ClusterUpgradeGKEUpgradeFeatureState - description: >- - GKEUpgradeFeatureState contains feature states for GKE clusters in the - scope. - type: object - properties: - upgradeState: - description: Upgrade state. It will eventually replace `state`. - type: array - items: - $ref: '#/components/schemas/ClusterUpgradeGKEUpgradeState' - conditions: - description: Current conditions of the feature. - type: array - items: - $ref: '#/components/schemas/ClusterUpgradeGKEUpgradeFeatureCondition' - ClusterUpgradeGKEUpgradeState: - id: ClusterUpgradeGKEUpgradeState - description: >- - GKEUpgradeState is a GKEUpgrade and its state at the scope and fleet - level. - type: object - properties: - upgrade: - description: Which upgrade to track the state. - $ref: '#/components/schemas/ClusterUpgradeGKEUpgrade' - status: - description: Status of the upgrade. - $ref: '#/components/schemas/ClusterUpgradeUpgradeStatus' - stats: - description: Number of GKE clusters in each status code. - type: object - additionalProperties: - type: string - format: int64 - ClusterUpgradeUpgradeStatus: - id: ClusterUpgradeUpgradeStatus - description: UpgradeStatus provides status information for each upgrade. - type: object - properties: - code: - description: Status code of the upgrade. - type: string - enumDescriptions: - - Required by https://linter.aip.dev/126/unspecified. - - >- - The upgrade is ineligible. At the scope level, this means the - upgrade is ineligible for all the clusters in the scope. - - >- - The upgrade is pending. At the scope level, this means the upgrade - is pending for all the clusters in the scope. - - >- - The upgrade is in progress. At the scope level, this means the - upgrade is in progress for at least one cluster in the scope. - - >- - The upgrade has finished and is soaking until the soaking time is - up. At the scope level, this means at least one cluster is in - soaking while the rest are either soaking or complete. - - >- - A cluster will be forced to enter soaking if an upgrade doesn't - finish within a certain limit, despite it's actual status. - - >- - The upgrade has passed all post conditions (soaking). At the scope - level, this means all eligible clusters are in COMPLETE status. - enum: - - CODE_UNSPECIFIED - - INELIGIBLE - - PENDING - - IN_PROGRESS - - SOAKING - - FORCED_SOAKING - - COMPLETE - reason: - description: Reason for this status. - type: string - updateTime: - description: Last timestamp the status was updated. - type: string - format: google-datetime - ClusterUpgradeGKEUpgradeFeatureCondition: - id: ClusterUpgradeGKEUpgradeFeatureCondition - description: >- - GKEUpgradeFeatureCondition describes the condition of the feature for - GKE clusters at a certain point of time. - type: object - properties: - type: - description: Type of the condition, for example, "ready". - type: string - status: - description: Status of the condition, one of True, False, Unknown. - type: string - reason: - description: Reason why the feature is in this status. - type: string - updateTime: - description: Last timestamp the condition was updated. - type: string - format: google-datetime - FeatureState: - id: FeatureState - description: >- - FeatureState describes the high-level state of a Feature. It may be used - to describe a Feature's state at the environ-level, or per-membershop, - depending on the context. - type: object - properties: - code: - description: The high-level, machine-readable status of this Feature. - type: string - enumDescriptions: - - Unknown or not set. - - The Feature is operating normally. - - >- - The Feature has encountered an issue, and is operating in a - degraded state. The Feature may need intervention to return to - normal operation. See the description and any associated - Feature-specific details for more information. - - >- - The Feature is not operating or is in a severely degraded state. - The Feature may need intervention to return to normal operation. - See the description and any associated Feature-specific details - for more information. - enum: - - CODE_UNSPECIFIED - - OK - - WARNING - - ERROR - description: - description: A human-readable description of the current status. - type: string - updateTime: - description: >- - The time this status and any related Feature-specific details were - updated. - type: string - format: google-datetime - MembershipFeatureState: - id: MembershipFeatureState - description: >- - MembershipFeatureState contains Feature status information for a single - Membership. - type: object - properties: - servicemesh: - description: Service Mesh-specific state. - $ref: '#/components/schemas/ServiceMeshMembershipState' - configmanagement: - description: Config Management-specific state. - $ref: '#/components/schemas/ConfigManagementMembershipState' - identityservice: - description: Identity Service-specific state. - $ref: '#/components/schemas/IdentityServiceMembershipState' - appdevexperience: - description: Appdevexperience specific state. - $ref: '#/components/schemas/AppDevExperienceFeatureState' - policycontroller: - description: Policycontroller-specific state. - $ref: '#/components/schemas/PolicyControllerMembershipState' - clusterupgrade: - description: ClusterUpgrade state. - $ref: '#/components/schemas/ClusterUpgradeMembershipState' - fleetobservability: - description: Fleet observability membership state. - $ref: '#/components/schemas/FleetObservabilityMembershipState' - state: - description: The high-level state of this Feature for a single membership. - $ref: '#/components/schemas/FeatureState' - ServiceMeshMembershipState: - id: ServiceMeshMembershipState - description: >- - **Service Mesh**: State for a single Membership, as analyzed by the - Service Mesh Hub Controller. - type: object - properties: - controlPlaneManagement: - description: Output only. Status of control plane management - readOnly: true - $ref: '#/components/schemas/ServiceMeshControlPlaneManagement' - dataPlaneManagement: - description: Output only. Status of data plane management. - readOnly: true - $ref: '#/components/schemas/ServiceMeshDataPlaneManagement' - conditions: - description: Output only. List of conditions reported for this membership. - readOnly: true - type: array - items: - $ref: '#/components/schemas/ServiceMeshCondition' - ServiceMeshControlPlaneManagement: - id: ServiceMeshControlPlaneManagement - description: Status of control plane management. - type: object - properties: - details: - description: Explanation of state. - type: array - items: - $ref: '#/components/schemas/ServiceMeshStatusDetails' - state: - description: LifecycleState of control plane management. - type: string - enumDescriptions: - - Unspecified - - DISABLED means that the component is not enabled. - - >- - FAILED_PRECONDITION means that provisioning cannot proceed because - of some characteristic of the member cluster. - - PROVISIONING means that provisioning is in progress. - - ACTIVE means that the component is ready for use. - - STALLED means that provisioning could not be done. - - >- - NEEDS_ATTENTION means that the component is ready, but some user - intervention is required. (For example that the user should - migrate workloads to a new control plane revision.) - - >- - DEGRADED means that the component is ready, but operating in a - degraded state. - enum: - - LIFECYCLE_STATE_UNSPECIFIED - - DISABLED - - FAILED_PRECONDITION - - PROVISIONING - - ACTIVE - - STALLED - - NEEDS_ATTENTION - - DEGRADED - implementation: - description: Output only. Implementation of managed control plane. - readOnly: true - type: string - enumDescriptions: - - Unspecified - - A Google build of istiod is used for the managed control plane. - - Traffic director is used for the managed control plane. - - The control plane implementation is being updated. - enum: - - IMPLEMENTATION_UNSPECIFIED - - ISTIOD - - TRAFFIC_DIRECTOR - - UPDATING - ServiceMeshStatusDetails: - id: ServiceMeshStatusDetails - description: Structured and human-readable details for a status. - type: object - properties: - code: - description: A machine-readable code that further describes a broad status. - type: string - details: - description: Human-readable explanation of code. - type: string - ServiceMeshDataPlaneManagement: - id: ServiceMeshDataPlaneManagement - description: Status of data plane management. Only reported per-member. - type: object - properties: - state: - description: Lifecycle status of data plane management. - type: string - enumDescriptions: - - Unspecified - - DISABLED means that the component is not enabled. - - >- - FAILED_PRECONDITION means that provisioning cannot proceed because - of some characteristic of the member cluster. - - PROVISIONING means that provisioning is in progress. - - ACTIVE means that the component is ready for use. - - STALLED means that provisioning could not be done. - - >- - NEEDS_ATTENTION means that the component is ready, but some user - intervention is required. (For example that the user should - migrate workloads to a new control plane revision.) - - >- - DEGRADED means that the component is ready, but operating in a - degraded state. - enum: - - LIFECYCLE_STATE_UNSPECIFIED - - DISABLED - - FAILED_PRECONDITION - - PROVISIONING - - ACTIVE - - STALLED - - NEEDS_ATTENTION - - DEGRADED - details: - description: Explanation of the status. - type: array - items: - $ref: '#/components/schemas/ServiceMeshStatusDetails' - ServiceMeshCondition: - id: ServiceMeshCondition - description: Condition being reported. - type: object - properties: - code: - description: >- - Unique identifier of the condition which describes the condition - recognizable to the user. - type: string - enumDescriptions: - - Default Unspecified code - - Mesh IAM permission denied error code - - CNI config unsupported error code - - GKE sandbox unsupported error code - - Nodepool workload identity federation required error code - - CNI installation failed error code - - CNI pod unschedulable error code - - Multiple control planes unsupported error code - - VPC-SC GA is supported for this control plane. - - >- - Configuration (Istio/k8s resources) failed to apply due to - internal error. - - Configuration failed to be applied due to being invalid. - - >- - Encountered configuration(s) with possible unintended behavior or - invalid configuration. These configs may not have been applied. - - BackendService quota exceeded error code. - - HealthCheck quota exceeded error code. - - HTTPRoute quota exceeded error code. - - TCPRoute quota exceeded error code. - - TLS routes quota exceeded error code. - - TrafficPolicy quota exceeded error code. - - EndpointPolicy quota exceeded error code. - - Gateway quota exceeded error code. - - Mesh quota exceeded error code. - - ServerTLSPolicy quota exceeded error code. - - ClientTLSPolicy quota exceeded error code. - - ServiceLBPolicy quota exceeded error code. - - HTTPFilter quota exceeded error code. - - TCPFilter quota exceeded error code. - - NetworkEndpointGroup quota exceeded error code. - enum: - - CODE_UNSPECIFIED - - MESH_IAM_PERMISSION_DENIED - - CNI_CONFIG_UNSUPPORTED - - GKE_SANDBOX_UNSUPPORTED - - NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED - - CNI_INSTALLATION_FAILED - - CNI_POD_UNSCHEDULABLE - - UNSUPPORTED_MULTIPLE_CONTROL_PLANES - - VPCSC_GA_SUPPORTED - - CONFIG_APPLY_INTERNAL_ERROR - - CONFIG_VALIDATION_ERROR - - CONFIG_VALIDATION_WARNING - - QUOTA_EXCEEDED_BACKEND_SERVICES - - QUOTA_EXCEEDED_HEALTH_CHECKS - - QUOTA_EXCEEDED_HTTP_ROUTES - - QUOTA_EXCEEDED_TCP_ROUTES - - QUOTA_EXCEEDED_TLS_ROUTES - - QUOTA_EXCEEDED_TRAFFIC_POLICIES - - QUOTA_EXCEEDED_ENDPOINT_POLICIES - - QUOTA_EXCEEDED_GATEWAYS - - QUOTA_EXCEEDED_MESHES - - QUOTA_EXCEEDED_SERVER_TLS_POLICIES - - QUOTA_EXCEEDED_CLIENT_TLS_POLICIES - - QUOTA_EXCEEDED_SERVICE_LB_POLICIES - - QUOTA_EXCEEDED_HTTP_FILTERS - - QUOTA_EXCEEDED_TCP_FILTERS - - QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS - documentationLink: - description: Links contains actionable information. - type: string - details: - description: A short summary about the issue. - type: string - severity: - description: Severity level of the condition. - type: string - enumDescriptions: - - Unspecified severity - - Indicates an issue that prevents the mesh from operating correctly - - >- - Indicates a setting is likely wrong, but the mesh is still able to - operate - - An informational message, not requiring any action - enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARNING - - INFO - ConfigManagementMembershipState: - id: ConfigManagementMembershipState - description: '**Anthos Config Management**: State for a single cluster.' - type: object - properties: - clusterName: - description: >- - This field is set to the `cluster_name` field of the Membership Spec - if it is not empty. Otherwise, it is set to the cluster's fleet - membership name. - type: string - membershipSpec: - description: >- - Membership configuration in the cluster. This represents the actual - state in the cluster, while the MembershipSpec in the FeatureSpec - represents the intended state - $ref: '#/components/schemas/ConfigManagementMembershipSpec' - operatorState: - description: Current install status of ACM's Operator - $ref: '#/components/schemas/ConfigManagementOperatorState' - configSyncState: - description: Current sync status - $ref: '#/components/schemas/ConfigManagementConfigSyncState' - policyControllerState: - description: PolicyController status - $ref: '#/components/schemas/ConfigManagementPolicyControllerState' - hierarchyControllerState: - description: Hierarchy Controller status - $ref: '#/components/schemas/ConfigManagementHierarchyControllerState' - ConfigManagementOperatorState: - id: ConfigManagementOperatorState - description: State information for an ACM's Operator - type: object - properties: - version: - description: The semenatic version number of the operator - type: string - deploymentState: - description: The state of the Operator's deployment - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - errors: - description: Install errors. - type: array - items: - $ref: '#/components/schemas/ConfigManagementInstallError' - ConfigManagementInstallError: - id: ConfigManagementInstallError - description: Errors pertaining to the installation of ACM - type: object - properties: - errorMessage: - description: A string representing the user facing error message - type: string - ConfigManagementConfigSyncState: - id: ConfigManagementConfigSyncState - description: State information for ConfigSync - type: object - properties: - version: - description: The version of ConfigSync deployed - $ref: '#/components/schemas/ConfigManagementConfigSyncVersion' - deploymentState: - description: >- - Information about the deployment of ConfigSync, including the - version of the various Pods deployed - $ref: '#/components/schemas/ConfigManagementConfigSyncDeploymentState' - syncState: - description: The state of ConfigSync's process to sync configs to a cluster - $ref: '#/components/schemas/ConfigManagementSyncState' - errors: - description: Errors pertaining to the installation of Config Sync. - type: array - items: - $ref: '#/components/schemas/ConfigManagementConfigSyncError' - rootsyncCrd: - description: The state of the RootSync CRD - type: string - enumDescriptions: - - CRD's state cannot be determined - - CRD is not installed - - CRD is installed - - CRD is terminating (i.e., it has been deleted and is cleaning up) - - CRD is installing - enum: - - CRD_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - TERMINATING - - INSTALLING - reposyncCrd: - description: The state of the Reposync CRD - type: string - enumDescriptions: - - CRD's state cannot be determined - - CRD is not installed - - CRD is installed - - CRD is terminating (i.e., it has been deleted and is cleaning up) - - CRD is installing - enum: - - CRD_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - TERMINATING - - INSTALLING - state: - description: >- - The state of CS This field summarizes the other fields in this - message. - type: string - enumDescriptions: - - CS's state cannot be determined. - - CS is not installed. - - The expected CS version is installed successfully. - - CS encounters errors. - - CS is installing or terminating. - enum: - - STATE_UNSPECIFIED - - CONFIG_SYNC_NOT_INSTALLED - - CONFIG_SYNC_INSTALLED - - CONFIG_SYNC_ERROR - - CONFIG_SYNC_PENDING - ConfigManagementConfigSyncVersion: - id: ConfigManagementConfigSyncVersion - description: Specific versioning information pertaining to ConfigSync's Pods - type: object - properties: - importer: - description: Version of the deployed importer pod - type: string - syncer: - description: Version of the deployed syncer pod - type: string - gitSync: - description: Version of the deployed git-sync pod - type: string - monitor: - description: Version of the deployed monitor pod - type: string - reconcilerManager: - description: Version of the deployed reconciler-manager pod - type: string - rootReconciler: - description: Version of the deployed reconciler container in root-reconciler pod - type: string - admissionWebhook: - description: Version of the deployed admission_webhook pod - type: string - ConfigManagementConfigSyncDeploymentState: - id: ConfigManagementConfigSyncDeploymentState - description: The state of ConfigSync's deployment on a cluster - type: object - properties: - importer: - description: Deployment state of the importer pod - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - syncer: - description: Deployment state of the syncer pod - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - gitSync: - description: Deployment state of the git-sync pod - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - monitor: - description: Deployment state of the monitor pod - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - reconcilerManager: - description: Deployment state of reconciler-manager pod - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - rootReconciler: - description: Deployment state of root-reconciler - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - admissionWebhook: - description: Deployment state of admission-webhook - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - ConfigManagementSyncState: - id: ConfigManagementSyncState - description: State indicating an ACM's progress syncing configurations to a cluster - type: object - properties: - sourceToken: - description: Token indicating the state of the repo. - type: string - importToken: - description: Token indicating the state of the importer. - type: string - syncToken: - description: Token indicating the state of the syncer. - type: string - lastSync: - description: >- - Deprecated: use last_sync_time instead. Timestamp of when ACM last - successfully synced the repo The time format is specified in - https://golang.org/pkg/time/#Time.String - deprecated: true - type: string - lastSyncTime: - description: Timestamp type of when ACM last successfully synced the repo - type: string - format: google-datetime - code: - description: Sync status code - type: string - enumDescriptions: - - Config Sync cannot determine a sync code - - Config Sync successfully synced the git Repo with the cluster - - Config Sync is in the progress of syncing a new change - - >- - Indicates an error configuring Config Sync, and user action is - required - - Config Sync has been installed but not configured - - Config Sync has not been installed - - Error authorizing with the cluster - - Cluster could not be reached - enum: - - SYNC_CODE_UNSPECIFIED - - SYNCED - - PENDING - - ERROR - - NOT_CONFIGURED - - NOT_INSTALLED - - UNAUTHORIZED - - UNREACHABLE - errors: - description: >- - A list of errors resulting from problematic configs. This list will - be truncated after 100 errors, although it is unlikely for that many - errors to simultaneously exist. - type: array - items: - $ref: '#/components/schemas/ConfigManagementSyncError' - ConfigManagementSyncError: - id: ConfigManagementSyncError - description: An ACM created error representing a problem syncing configurations - type: object - properties: - code: - description: An ACM defined error code - type: string - errorMessage: - description: A description of the error - type: string - errorResources: - description: A list of config(s) associated with the error, if any - type: array - items: - $ref: '#/components/schemas/ConfigManagementErrorResource' - ConfigManagementErrorResource: - id: ConfigManagementErrorResource - description: Model for a config file in the git repo with an associated Sync error - type: object - properties: - sourcePath: - description: Path in the git repo of the erroneous config - type: string - resourceName: - description: Metadata name of the resource that is causing an error - type: string - resourceNamespace: - description: Namespace of the resource that is causing an error - type: string - resourceGvk: - description: Group/version/kind of the resource that is causing an error - $ref: '#/components/schemas/ConfigManagementGroupVersionKind' - ConfigManagementGroupVersionKind: - id: ConfigManagementGroupVersionKind - description: A Kubernetes object's GVK - type: object - properties: - group: - description: Kubernetes Group - type: string - version: - description: Kubernetes Version - type: string - kind: - description: Kubernetes Kind - type: string - ConfigManagementConfigSyncError: - id: ConfigManagementConfigSyncError - description: Errors pertaining to the installation of Config Sync - type: object - properties: - errorMessage: - description: A string representing the user facing error message - type: string - ConfigManagementPolicyControllerState: - id: ConfigManagementPolicyControllerState - description: State for PolicyControllerState. - type: object - properties: - version: - description: The version of Gatekeeper Policy Controller deployed. - $ref: '#/components/schemas/ConfigManagementPolicyControllerVersion' - deploymentState: - description: The state about the policy controller installation. - $ref: '#/components/schemas/ConfigManagementGatekeeperDeploymentState' - migration: - description: Record state of ACM -> PoCo Hub migration for this feature. - $ref: '#/components/schemas/ConfigManagementPolicyControllerMigration' - ConfigManagementPolicyControllerVersion: - id: ConfigManagementPolicyControllerVersion - description: The build version of Gatekeeper Policy Controller is using. - type: object - properties: - version: - description: >- - The gatekeeper image tag that is composed of ACM version, git tag, - build number. - type: string - ConfigManagementGatekeeperDeploymentState: - id: ConfigManagementGatekeeperDeploymentState - description: State of Policy Controller installation. - type: object - properties: - gatekeeperControllerManagerState: - description: Status of gatekeeper-controller-manager pod. - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - gatekeeperAudit: - description: Status of gatekeeper-audit deployment. - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - gatekeeperMutation: - description: Status of the pod serving the mutation webhook. - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - ConfigManagementPolicyControllerMigration: - id: ConfigManagementPolicyControllerMigration - description: State for the migration of PolicyController from ACM -> PoCo Hub. - type: object - properties: - stage: - description: Stage of the migration. - type: string - enumDescriptions: - - Unknown state of migration. - - >- - ACM Hub/Operator manages policycontroller. No migration yet - completed. - - >- - All migrations steps complete; Poco Hub now manages - policycontroller. - enum: - - STAGE_UNSPECIFIED - - ACM_MANAGED - - POCO_MANAGED - copyTime: - description: Last time this membership spec was copied to PoCo feature. - type: string - format: google-datetime - ConfigManagementHierarchyControllerState: - id: ConfigManagementHierarchyControllerState - description: State for Hierarchy Controller - type: object - properties: - version: - description: The version for Hierarchy Controller - $ref: '#/components/schemas/ConfigManagementHierarchyControllerVersion' - state: - description: The deployment state for Hierarchy Controller - $ref: >- - #/components/schemas/ConfigManagementHierarchyControllerDeploymentState - ConfigManagementHierarchyControllerVersion: - id: ConfigManagementHierarchyControllerVersion - description: Version for Hierarchy Controller - type: object - properties: - hnc: - description: Version for open source HNC - type: string - extension: - description: Version for Hierarchy Controller extension - type: string - ConfigManagementHierarchyControllerDeploymentState: - id: ConfigManagementHierarchyControllerDeploymentState - description: Deployment state for Hierarchy Controller - type: object - properties: - hnc: - description: The deployment state for open source HNC (e.g. v0.7.0-hc.0) - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - extension: - description: >- - The deployment state for Hierarchy Controller extension (e.g. - v0.7.0-hc.1) - type: string - enumDescriptions: - - Deployment's state cannot be determined - - Deployment is not installed - - Deployment is installed - - Deployment was attempted to be installed, but has errors - - Deployment is installing or terminating - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLED - - ERROR - - PENDING - IdentityServiceMembershipState: - id: IdentityServiceMembershipState - description: '**Anthos Identity Service**: State for a single Membership.' - type: object - properties: - installedVersion: - description: >- - Installed AIS version. This is the AIS version installed on this - member. The values makes sense iff state is OK. - type: string - state: - description: Deployment state on this member - type: string - enumDescriptions: - - Unspecified state - - deployment succeeds - - Failure with error. - enum: - - DEPLOYMENT_STATE_UNSPECIFIED - - OK - - ERROR - failureReason: - description: The reason of the failure. - type: string - memberConfig: - description: Last reconciled membership configuration - $ref: '#/components/schemas/IdentityServiceMembershipSpec' - PolicyControllerMembershipState: - id: PolicyControllerMembershipState - description: '**Policy Controller**: State for a single cluster.' - type: object - properties: - componentStates: - description: >- - Currently these include (also serving as map keys): 1. "admission" - 2. "audit" 3. "mutation" - type: object - additionalProperties: - $ref: '#/components/schemas/PolicyControllerOnClusterState' - state: - description: >- - The overall Policy Controller lifecycle state observed by the Hub - Feature controller. - type: string - enumDescriptions: - - The lifecycle state is unspecified. - - >- - The PC does not exist on the given cluster, and no k8s resources - of any type that are associated with the PC should exist there. - The cluster does not possess a membership with the PCH. - - >- - The PCH possesses a Membership, however the PC is not fully - installed on the cluster. In this state the hub can be expected to - be taking actions to install the PC on the cluster. - - >- - The PC is fully installed on the cluster and in an operational - mode. In this state PCH will be reconciling state with the PC, and - the PC will be performing it's operational tasks per that - software. Entering a READY state requires that the hub has - confirmed the PC is installed and its pods are operational with - the version of the PC the PCH expects. - - >- - The PC is fully installed, but in the process of changing the - configuration (including changing the version of PC either up and - down, or modifying the manifests of PC) of the resources running - on the cluster. The PCH has a Membership, is aware of the version - the cluster should be running in, but has not confirmed for itself - that the PC is running with that version. - - >- - The PC may have resources on the cluster, but the PCH wishes to - remove the Membership. The Membership still exists. - - >- - The PC is not operational, and the PCH is unable to act to make it - operational. Entering a CLUSTER_ERROR state happens automatically - when the PCH determines that a PC installed on the cluster is - non-operative or that the cluster does not meet requirements set - for the PCH to administer the cluster but has nevertheless been - given an instruction to do so (such as 'install'). - - >- - In this state, the PC may still be operational, and only the PCH - is unable to act. The hub should not issue instructions to change - the PC state, or otherwise interfere with the on-cluster - resources. Entering a HUB_ERROR state happens automatically when - the PCH determines the hub is in an unhealthy state and it wishes - to 'take hands off' to avoid corrupting the PC or other data. - - >- - Policy Controller (PC) is installed but suspended. This means that - the policies are not enforced, but violations are still recorded - (through audit). - - >- - PoCo Hub is not taking any action to reconcile cluster objects. - Changes to those objects will not be overwritten by PoCo Hub. - enum: - - LIFECYCLE_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLING - - ACTIVE - - UPDATING - - DECOMMISSIONING - - CLUSTER_ERROR - - HUB_ERROR - - SUSPENDED - - DETACHED - policyContentState: - description: The overall content state observed by the Hub Feature controller. - $ref: '#/components/schemas/PolicyControllerPolicyContentState' - PolicyControllerOnClusterState: - id: PolicyControllerOnClusterState - description: >- - OnClusterState represents the state of a sub-component of Policy - Controller. - type: object - properties: - state: - description: The lifecycle state of this component. - type: string - enumDescriptions: - - The lifecycle state is unspecified. - - >- - The PC does not exist on the given cluster, and no k8s resources - of any type that are associated with the PC should exist there. - The cluster does not possess a membership with the PCH. - - >- - The PCH possesses a Membership, however the PC is not fully - installed on the cluster. In this state the hub can be expected to - be taking actions to install the PC on the cluster. - - >- - The PC is fully installed on the cluster and in an operational - mode. In this state PCH will be reconciling state with the PC, and - the PC will be performing it's operational tasks per that - software. Entering a READY state requires that the hub has - confirmed the PC is installed and its pods are operational with - the version of the PC the PCH expects. - - >- - The PC is fully installed, but in the process of changing the - configuration (including changing the version of PC either up and - down, or modifying the manifests of PC) of the resources running - on the cluster. The PCH has a Membership, is aware of the version - the cluster should be running in, but has not confirmed for itself - that the PC is running with that version. - - >- - The PC may have resources on the cluster, but the PCH wishes to - remove the Membership. The Membership still exists. - - >- - The PC is not operational, and the PCH is unable to act to make it - operational. Entering a CLUSTER_ERROR state happens automatically - when the PCH determines that a PC installed on the cluster is - non-operative or that the cluster does not meet requirements set - for the PCH to administer the cluster but has nevertheless been - given an instruction to do so (such as 'install'). - - >- - In this state, the PC may still be operational, and only the PCH - is unable to act. The hub should not issue instructions to change - the PC state, or otherwise interfere with the on-cluster - resources. Entering a HUB_ERROR state happens automatically when - the PCH determines the hub is in an unhealthy state and it wishes - to 'take hands off' to avoid corrupting the PC or other data. - - >- - Policy Controller (PC) is installed but suspended. This means that - the policies are not enforced, but violations are still recorded - (through audit). - - >- - PoCo Hub is not taking any action to reconcile cluster objects. - Changes to those objects will not be overwritten by PoCo Hub. - enum: - - LIFECYCLE_STATE_UNSPECIFIED - - NOT_INSTALLED - - INSTALLING - - ACTIVE - - UPDATING - - DECOMMISSIONING - - CLUSTER_ERROR - - HUB_ERROR - - SUSPENDED - - DETACHED - details: - description: Surface potential errors or information logs. - type: string - PolicyControllerPolicyContentState: - id: PolicyControllerPolicyContentState - description: The state of the policy controller policy content - type: object - properties: - templateLibraryState: - description: The state of the template library - $ref: '#/components/schemas/PolicyControllerOnClusterState' - bundleStates: - description: >- - The state of the any bundles included in the chosen version of the - manifest - type: object - additionalProperties: - $ref: '#/components/schemas/PolicyControllerOnClusterState' - referentialSyncConfigState: - description: >- - The state of the referential data sync configuration. This could - represent the state of either the syncSet object(s) or the config - object, depending on the version of PoCo configured by the user. - $ref: '#/components/schemas/PolicyControllerOnClusterState' - ClusterUpgradeMembershipState: - id: ClusterUpgradeMembershipState - description: Per-membership state for this feature. - type: object - properties: - ignored: - description: >- - Whether this membership is ignored by the feature. For example, - manually upgraded clusters can be ignored if they are newer than the - default versions of its release channel. - $ref: '#/components/schemas/ClusterUpgradeIgnoredMembership' - upgrades: - description: Actual upgrade state against desired. - type: array - items: - $ref: '#/components/schemas/ClusterUpgradeMembershipGKEUpgradeState' - ClusterUpgradeMembershipGKEUpgradeState: - id: ClusterUpgradeMembershipGKEUpgradeState - description: ScopeGKEUpgradeState is a GKEUpgrade and its state per-membership. - type: object - properties: - upgrade: - description: Which upgrade to track the state. - $ref: '#/components/schemas/ClusterUpgradeGKEUpgrade' - status: - description: Status of the upgrade. - $ref: '#/components/schemas/ClusterUpgradeUpgradeStatus' - FleetObservabilityMembershipState: - id: FleetObservabilityMembershipState - description: >- - **FleetObservability**: Membership-specific Feature state for - fleetobservability. - type: object - properties: {} - CommonFleetDefaultMemberConfigSpec: - id: CommonFleetDefaultMemberConfigSpec - description: >- - CommonFleetDefaultMemberConfigSpec contains default configuration - information for memberships of a fleet - type: object - properties: - mesh: - description: Anthos Service Mesh-specific spec - $ref: '#/components/schemas/ServiceMeshMembershipSpec' - configmanagement: - description: Config Management-specific spec. - $ref: '#/components/schemas/ConfigManagementMembershipSpec' - identityservice: - description: Identity Service-specific spec. - $ref: '#/components/schemas/IdentityServiceMembershipSpec' - policycontroller: - description: Policy Controller spec. - $ref: '#/components/schemas/PolicyControllerMembershipSpec' - ScopeFeatureSpec: - id: ScopeFeatureSpec - description: ScopeFeatureSpec contains feature specs for a fleet scope. - type: object - properties: {} - ScopeFeatureState: - id: ScopeFeatureState - description: ScopeFeatureState contains Scope-wide Feature status information. - type: object - properties: - state: - description: Output only. The "running state" of the Feature in this Scope. - readOnly: true - $ref: '#/components/schemas/FeatureState' - GenerateConnectManifestResponse: - id: GenerateConnectManifestResponse - description: >- - GenerateConnectManifestResponse contains manifest information for - installing/upgrading a Connect agent. - type: object - properties: - manifest: - description: >- - The ordered list of Kubernetes resources that need to be applied to - the cluster for GKE Connect agent installation/upgrade. - type: array - items: - $ref: '#/components/schemas/ConnectAgentResource' - ConnectAgentResource: - id: ConnectAgentResource - description: >- - ConnectAgentResource represents a Kubernetes resource manifest for - Connect Agent deployment. - type: object - properties: - type: - description: Kubernetes type of the resource. - $ref: '#/components/schemas/TypeMeta' - manifest: - description: YAML manifest of the resource. - type: string - TypeMeta: - id: TypeMeta - description: >- - TypeMeta is the type information needed for content unmarshalling of - Kubernetes resources in the manifest. - type: object - properties: - kind: - description: Kind of the resource (e.g. Deployment). - type: string - apiVersion: - description: APIVersion of the resource (e.g. v1). - type: string - Fleet: - id: Fleet - description: Fleet contains the Fleet-wide metadata and configuration. - type: object - properties: - name: - description: >- - Output only. The full, unique resource name of this fleet in the - format of `projects/{project}/locations/{location}/fleets/{fleet}`. - Each Google Cloud project can have at most one fleet resource, named - "default". - readOnly: true - type: string - displayName: - description: >- - Optional. A user-assigned display name of the Fleet. When present, - it must be between 4 to 30 characters. Allowed characters are: - lowercase and uppercase letters, numbers, hyphen, single-quote, - double-quote, space, and exclamation point. Example: `Production - Fleet` - type: string - createTime: - description: Output only. When the Fleet was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. When the Fleet was last updated. - readOnly: true - type: string - format: google-datetime - deleteTime: - description: Output only. When the Fleet was deleted. - readOnly: true - type: string - format: google-datetime - uid: - description: >- - Output only. Google-generated UUID for this resource. This is unique - across all Fleet resources. If a Fleet resource is deleted and - another resource with the same name is created, it gets a different - uid. - readOnly: true - type: string - state: - description: Output only. State of the namespace resource. - readOnly: true - $ref: '#/components/schemas/FleetLifecycleState' - defaultClusterConfig: - description: >- - Optional. The default cluster configurations to apply across the - fleet. - $ref: '#/components/schemas/DefaultClusterConfig' - labels: - description: Optional. Labels for this Fleet. - type: object - additionalProperties: - type: string - FleetLifecycleState: - id: FleetLifecycleState - description: FleetLifecycleState describes the state of a Fleet resource. - type: object - properties: - code: - description: Output only. The current state of the Fleet resource. - readOnly: true - type: string - enumDescriptions: - - The code is not set. - - The fleet is being created. - - The fleet active. - - The fleet is being deleted. - - The fleet is being updated. - enum: - - CODE_UNSPECIFIED - - CREATING - - READY - - DELETING - - UPDATING - DefaultClusterConfig: - id: DefaultClusterConfig - description: >- - DefaultClusterConfig describes the default cluster configurations to be - applied to all clusters born-in-fleet. - type: object - properties: - securityPostureConfig: - description: Enable/Disable Security Posture features for the cluster. - $ref: '#/components/schemas/SecurityPostureConfig' - binaryAuthorizationConfig: - description: >- - Optional. Enable/Disable binary authorization features for the - cluster. - $ref: '#/components/schemas/BinaryAuthorizationConfig' - SecurityPostureConfig: - id: SecurityPostureConfig - description: >- - SecurityPostureConfig defines the flags needed to enable/disable - features for the Security Posture API. - type: object - properties: - mode: - description: Sets which mode to use for Security Posture features. - type: string - enumDescriptions: - - Default value not specified. - - Disables Security Posture features on the cluster. - - Applies Security Posture features on the cluster. - - >- - Applies the Security Posture off cluster Enterprise level - features. - enum: - - MODE_UNSPECIFIED - - DISABLED - - BASIC - - ENTERPRISE - vulnerabilityMode: - description: Sets which mode to use for vulnerability scanning. - type: string - enumDescriptions: - - Default value not specified. - - Disables vulnerability scanning on the cluster. - - Applies basic vulnerability scanning on the cluster. - - >- - Applies the Security Posture's vulnerability on cluster Enterprise - level features. - enum: - - VULNERABILITY_MODE_UNSPECIFIED - - VULNERABILITY_DISABLED - - VULNERABILITY_BASIC - - VULNERABILITY_ENTERPRISE - BinaryAuthorizationConfig: - id: BinaryAuthorizationConfig - description: >- - BinaryAuthorizationConfig defines the fleet level configuration of - binary authorization feature. - type: object - properties: - evaluationMode: - description: Optional. Mode of operation for binauthz policy evaluation. - type: string - enumDescriptions: - - Default value - - Disable BinaryAuthorization - - >- - Use Binary Authorization with the policies specified in - policy_bindings. - enum: - - EVALUATION_MODE_UNSPECIFIED - - DISABLED - - POLICY_BINDINGS - policyBindings: - description: Optional. Binauthz policies that apply to this cluster. - type: array - items: - $ref: '#/components/schemas/PolicyBinding' - PolicyBinding: - id: PolicyBinding - description: Binauthz policy that applies to this cluster. - type: object - properties: - name: - description: >- - The relative resource name of the binauthz platform policy to audit. - GKE platform policies have the following format: - `projects/{project_number}/platforms/gke/policies/{policy_id}`. - type: string - ListFleetsResponse: - id: ListFleetsResponse - description: Response message for the `GkeHub.ListFleetsResponse` method. - type: object - properties: - fleets: - description: The list of matching fleets. - type: array - items: - $ref: '#/components/schemas/Fleet' - nextPageToken: - description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. The - token is only valid for 1h. - type: string - Namespace: - id: Namespace - description: Namespace represents a namespace across the Fleet - type: object - properties: - name: - description: >- - The resource name for the namespace - `projects/{project}/locations/{location}/namespaces/{namespace}` - type: string - uid: - description: >- - Output only. Google-generated UUID for this resource. This is unique - across all namespace resources. If a namespace resource is deleted - and another resource with the same name is created, it gets a - different uid. - readOnly: true - type: string - createTime: - description: Output only. When the namespace was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. When the namespace was last updated. - readOnly: true - type: string - format: google-datetime - deleteTime: - description: Output only. When the namespace was deleted. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. State of the namespace resource. - readOnly: true - $ref: '#/components/schemas/NamespaceLifecycleState' - scope: - description: Required. Scope associated with the namespace - type: string - namespaceLabels: - description: >- - Optional. Namespace-level cluster namespace labels. These labels are - applied to the related namespace of the member clusters bound to the - parent Scope. Scope-level labels (`namespace_labels` in the Fleet - Scope resource) take precedence over Namespace-level labels if they - share a key. Keys and values must be Kubernetes-conformant. - type: object - additionalProperties: - type: string - labels: - description: Optional. Labels for this Namespace. - type: object - additionalProperties: - type: string - NamespaceLifecycleState: - id: NamespaceLifecycleState - description: NamespaceLifecycleState describes the state of a Namespace resource. - type: object - properties: - code: - description: Output only. The current state of the Namespace resource. - readOnly: true - type: string - enumDescriptions: - - The code is not set. - - The namespace is being created. - - The namespace active. - - The namespace is being deleted. - - The namespace is being updated. - enum: - - CODE_UNSPECIFIED - - CREATING - - READY - - DELETING - - UPDATING - ListScopeNamespacesResponse: - id: ListScopeNamespacesResponse - description: List of fleet namespaces. - type: object - properties: - scopeNamespaces: - description: The list of fleet namespaces - type: array - items: - $ref: '#/components/schemas/Namespace' - nextPageToken: - description: >- - A token to request the next page of resources from the - `ListNamespaces` method. The value of an empty string means that - there are no more resources to return. - type: string - RBACRoleBinding: - id: RBACRoleBinding - description: RBACRoleBinding represents a rbacrolebinding across the Fleet - type: object - properties: - user: - description: >- - user is the name of the user as seen by the kubernetes cluster, - example "alice" or "alice@domain.tld" - type: string - group: - description: group is the group, as seen by the kubernetes cluster. - type: string - name: - description: >- - The resource name for the rbacrolebinding - `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` - or - `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}` - type: string - uid: - description: >- - Output only. Google-generated UUID for this resource. This is unique - across all rbacrolebinding resources. If a rbacrolebinding resource - is deleted and another resource with the same name is created, it - gets a different uid. - readOnly: true - type: string - createTime: - description: Output only. When the rbacrolebinding was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. When the rbacrolebinding was last updated. - readOnly: true - type: string - format: google-datetime - deleteTime: - description: Output only. When the rbacrolebinding was deleted. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. State of the rbacrolebinding resource. - readOnly: true - $ref: '#/components/schemas/RBACRoleBindingLifecycleState' - role: - description: Required. Role to bind to the principal - $ref: '#/components/schemas/Role' - labels: - description: Optional. Labels for this RBACRolebinding. - type: object - additionalProperties: - type: string - RBACRoleBindingLifecycleState: - id: RBACRoleBindingLifecycleState - description: >- - RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding - resource. - type: object - properties: - code: - description: Output only. The current state of the rbacrolebinding resource. - readOnly: true - type: string - enumDescriptions: - - The code is not set. - - The rbacrolebinding is being created. - - The rbacrolebinding active. - - The rbacrolebinding is being deleted. - - The rbacrolebinding is being updated. - enum: - - CODE_UNSPECIFIED - - CREATING - - READY - - DELETING - - UPDATING - Role: - id: Role - description: Role is the type for Kubernetes roles - type: object - properties: - predefinedRole: - description: predefined_role is the Kubernetes default role to use - type: string - enumDescriptions: - - UNKNOWN - - ADMIN has EDIT and RBAC permissions - - EDIT can edit all resources except RBAC - - VIEW can only read resources - - >- - ANTHOS_SUPPORT gives Google Support read-only access to a number - of cluster resources. - enum: - - UNKNOWN - - ADMIN - - EDIT - - VIEW - - ANTHOS_SUPPORT - ListScopeRBACRoleBindingsResponse: - id: ListScopeRBACRoleBindingsResponse - description: List of Scope RBACRoleBindings. - type: object - properties: - rbacrolebindings: - description: The list of Scope RBACRoleBindings. - type: array - items: - $ref: '#/components/schemas/RBACRoleBinding' - nextPageToken: - description: >- - A token to request the next page of resources from the - `ListScopeRBACRoleBindings` method. The value of an empty string - means that there are no more resources to return. - type: string - Scope: - id: Scope - description: Scope represents a Scope in a Fleet. - type: object - properties: - name: - description: >- - The resource name for the scope - `projects/{project}/locations/{location}/scopes/{scope}` - type: string - uid: - description: >- - Output only. Google-generated UUID for this resource. This is unique - across all scope resources. If a scope resource is deleted and - another resource with the same name is created, it gets a different - uid. - readOnly: true - type: string - createTime: - description: Output only. When the scope was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. When the scope was last updated. - readOnly: true - type: string - format: google-datetime - deleteTime: - description: Output only. When the scope was deleted. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. State of the scope resource. - readOnly: true - $ref: '#/components/schemas/ScopeLifecycleState' - namespaceLabels: - description: >- - Optional. Scope-level cluster namespace labels. For the member - clusters bound to the Scope, these labels are applied to each - namespace under the Scope. Scope-level labels take precedence over - Namespace-level labels (`namespace_labels` in the Fleet Namespace - resource) if they share a key. Keys and values must be - Kubernetes-conformant. - type: object - additionalProperties: - type: string - labels: - description: Optional. Labels for this Scope. - type: object - additionalProperties: - type: string - ScopeLifecycleState: - id: ScopeLifecycleState - description: ScopeLifecycleState describes the state of a Scope resource. - type: object - properties: - code: - description: Output only. The current state of the scope resource. - readOnly: true - type: string - enumDescriptions: - - The code is not set. - - The scope is being created. - - The scope active. - - The scope is being deleted. - - The scope is being updated. - enum: - - CODE_UNSPECIFIED - - CREATING - - READY - - DELETING - - UPDATING - ListScopesResponse: - id: ListScopesResponse - description: List of Scopes. - type: object - properties: - scopes: - description: The list of Scopes - type: array - items: - $ref: '#/components/schemas/Scope' - nextPageToken: - description: >- - A token to request the next page of resources from the `ListScopes` - method. The value of an empty string means that there are no more - resources to return. - type: string - ListPermittedScopesResponse: - id: ListPermittedScopesResponse - description: List of permitted Scopes. - type: object - properties: - scopes: - description: The list of permitted Scopes - type: array - items: - $ref: '#/components/schemas/Scope' - nextPageToken: - description: >- - A token to request the next page of resources from the - `ListPermittedScopes` method. The value of an empty string means - that there are no more resources to return. - type: string - MembershipBinding: - id: MembershipBinding - description: >- - MembershipBinding is a subresource of a Membership, representing what - Fleet Scopes (or other, future Fleet resources) a Membership is bound - to. - type: object - properties: - scope: - description: >- - A Scope resource name in the format - `projects/*/locations/*/scopes/*`. - type: string - name: - description: >- - The resource name for the membershipbinding itself - `projects/{project}/locations/{location}/memberships/{membership}/bindings/{membershipbinding}` - type: string - uid: - description: >- - Output only. Google-generated UUID for this resource. This is unique - across all membershipbinding resources. If a membershipbinding - resource is deleted and another resource with the same name is - created, it gets a different uid. - readOnly: true - type: string - createTime: - description: Output only. When the membership binding was created. - readOnly: true - type: string - format: google-datetime - updateTime: - description: Output only. When the membership binding was last updated. - readOnly: true - type: string - format: google-datetime - deleteTime: - description: Output only. When the membership binding was deleted. - readOnly: true - type: string - format: google-datetime - state: - description: Output only. State of the membership binding resource. - readOnly: true - $ref: '#/components/schemas/MembershipBindingLifecycleState' - labels: - description: Optional. Labels for this MembershipBinding. - type: object - additionalProperties: - type: string - MembershipBindingLifecycleState: - id: MembershipBindingLifecycleState - description: >- - MembershipBindingLifecycleState describes the state of a Binding - resource. - type: object - properties: - code: - description: Output only. The current state of the MembershipBinding resource. - readOnly: true - type: string - enumDescriptions: - - The code is not set. - - The membershipbinding is being created. - - The membershipbinding active. - - The membershipbinding is being deleted. - - The membershipbinding is being updated. - enum: - - CODE_UNSPECIFIED - - CREATING - - READY - - DELETING - - UPDATING - ListMembershipBindingsResponse: - id: ListMembershipBindingsResponse - description: List of MembershipBindings. - type: object - properties: - membershipBindings: - description: The list of membership_bindings - type: array - items: - $ref: '#/components/schemas/MembershipBinding' - nextPageToken: - description: >- - A token to request the next page of resources from the - `ListMembershipBindings` method. The value of an empty string means - that there are no more resources to return. - type: string - unreachable: - description: >- - List of locations that could not be reached while fetching this - list. - type: array - items: - type: string - ListLocationsResponse: - id: ListLocationsResponse - description: The response message for Locations.ListLocations. - type: object - properties: - locations: - description: >- - A list of locations that matches the specified filter in the - request. - type: array - items: - $ref: '#/components/schemas/Location' - nextPageToken: - description: The standard List next-page token. - type: string - Location: - id: Location - description: A resource that represents a Google Cloud location. - type: object - properties: - name: - description: >- - Resource name for the location, which may vary between - implementations. For example: - `"projects/example-project/locations/us-east1"` - type: string - locationId: - description: 'The canonical id for this location. For example: `"us-east1"`.' - type: string - displayName: - description: >- - The friendly name for this location, typically a nearby city name. - For example, "Tokyo". - type: string - labels: - description: >- - Cross-service attributes for the location. For example - {"cloud.googleapis.com/region": "us-east1"} - type: object - additionalProperties: - type: string - metadata: - description: >- - Service-specific metadata. For example the available capacity at the - given location. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - SetIamPolicyRequest: - id: SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. - type: object - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - updateMask: - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - type: string - format: google-fieldmask - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - properties: - version: - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/AuditConfig' - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - type: string - format: byte - Binding: - id: Binding - description: Associates `members`, or principals, with a `role`. - type: object - properties: - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: Expr - 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. - type: object - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - description: - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - location: - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - type: string - AuditConfig: - id: AuditConfig - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - type: object - properties: - service: - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - type: string - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - AuditLogConfig: - id: AuditLogConfig - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - type: object - properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - type: array - items: - type: string - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string - OperationMetadata: - id: OperationMetadata - description: Represents the metadata of the long-running operation. - type: object - properties: - createTime: - description: Output only. The time the operation was created. - readOnly: true - type: string - format: google-datetime - endTime: - description: Output only. The time the operation finished running. - readOnly: true - type: string - format: google-datetime - target: - description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true - type: string - verb: - description: Output only. Name of the verb executed by the operation. - readOnly: true - type: string - statusDetail: - description: Output only. Human-readable status of the operation, if any. - readOnly: true - type: string - cancelRequested: - description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have successfully been cancelled - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. - readOnly: true - type: boolean - apiVersion: - description: Output only. API version used to start the operation. - readOnly: true - type: string - parameters: - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - locations: - id: google.gkehub.locations - name: locations - title: Locations - methods: - _projects_locations_list: - operation: &ref_1 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 - projects_locations_get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_get - - $ref: >- - #/components/x-stackQL-resources/locations/methods/projects_locations_list - insert: [] - update: [] - delete: [] - operations: - id: google.gkehub.operations - name: operations - title: Operations - methods: - _projects_locations_operations_list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 - projects_locations_operations_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_operations_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_operations_cancel: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list - insert: [] - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete - memberships: - id: google.gkehub.memberships - name: memberships - title: Memberships - methods: - _projects_locations_memberships_list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.resources - projects_locations_memberships_list: - operation: *ref_5 - response: *ref_6 - projects_locations_memberships_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_memberships_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_memberships_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_memberships_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_memberships_generate_connect_manifest: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}:generateConnectManifest/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_get - - $ref: >- - #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_list - insert: - - $ref: >- - #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_create - update: - - $ref: >- - #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/memberships/methods/projects_locations_memberships_delete - memberships_iam_policies: - id: google.gkehub.memberships_iam_policies - name: memberships_iam_policies - title: Memberships_iam_policies - methods: - projects_locations_memberships_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_memberships_get_iam_policy: - operation: &ref_7 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}:getIamPolicy/get - response: &ref_8 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_memberships_get_iam_policy: - operation: *ref_7 - response: *ref_8 - projects_locations_memberships_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/memberships_iam_policies/methods/projects_locations_memberships_get_iam_policy - insert: [] - update: [] - delete: [] - bindings: - id: google.gkehub.bindings - name: bindings - title: Bindings - methods: - projects_locations_memberships_bindings_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}~1bindings~1{bindingsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_memberships_bindings_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}~1bindings~1{bindingsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_memberships_bindings_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}~1bindings~1{bindingsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_memberships_bindings_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}~1bindings/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_memberships_bindings_list: - operation: &ref_9 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1memberships~1{membershipsId}~1bindings/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.membershipBindings - projects_locations_memberships_bindings_list: - operation: *ref_9 - response: *ref_10 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_get - - $ref: >- - #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_list - insert: - - $ref: >- - #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_create - update: - - $ref: >- - #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/bindings/methods/projects_locations_memberships_bindings_delete - scopes_memberships: - id: google.gkehub.scopes_memberships - name: scopes_memberships - title: Scopes_memberships - methods: - _projects_locations_scopes_list_memberships: - operation: &ref_11 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}:listMemberships/get - response: &ref_12 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.memberships - projects_locations_scopes_list_memberships: - operation: *ref_11 - response: *ref_12 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/scopes_memberships/methods/projects_locations_scopes_list_memberships - insert: [] - update: [] - delete: [] - scopes: - id: google.gkehub.scopes - name: scopes - title: Scopes - methods: - projects_locations_scopes_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_scopes_list: - operation: &ref_13 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes/get - response: &ref_14 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.scopes - projects_locations_scopes_list: - operation: *ref_13 - response: *ref_14 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_get - - $ref: >- - #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_list - insert: - - $ref: >- - #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_create - update: - - $ref: >- - #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/scopes/methods/projects_locations_scopes_delete - scopes_permitted: - id: google.gkehub.scopes_permitted - name: scopes_permitted - title: Scopes_permitted - methods: - _projects_locations_scopes_list_permitted: - operation: &ref_15 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes:listPermitted/get - response: &ref_16 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.scopes - projects_locations_scopes_list_permitted: - operation: *ref_15 - response: *ref_16 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/scopes_permitted/methods/projects_locations_scopes_list_permitted - insert: [] - update: [] - delete: [] - scopes_iam_policies: - id: google.gkehub.scopes_iam_policies - name: scopes_iam_policies - title: Scopes_iam_policies - methods: - projects_locations_scopes_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_scopes_get_iam_policy: - operation: &ref_17 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}:getIamPolicy/get - response: &ref_18 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_scopes_get_iam_policy: - operation: *ref_17 - response: *ref_18 - projects_locations_scopes_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/scopes_iam_policies/methods/projects_locations_scopes_get_iam_policy - insert: [] - update: [] - delete: [] - namespaces: - id: google.gkehub.namespaces - name: namespaces - title: Namespaces - methods: - projects_locations_scopes_namespaces_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1namespaces~1{namespacesId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_namespaces_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1namespaces~1{namespacesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_namespaces_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1namespaces~1{namespacesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_namespaces_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1namespaces/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_scopes_namespaces_list: - operation: &ref_19 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1namespaces/get - response: &ref_20 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.scopeNamespaces - projects_locations_scopes_namespaces_list: - operation: *ref_19 - response: *ref_20 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_get - - $ref: >- - #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_list - insert: - - $ref: >- - #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_create - update: - - $ref: >- - #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/namespaces/methods/projects_locations_scopes_namespaces_delete - rbacrolebindings: - id: google.gkehub.rbacrolebindings - name: rbacrolebindings - title: Rbacrolebindings - methods: - projects_locations_scopes_rbacrolebindings_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1rbacrolebindings~1{rbacrolebindingsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_rbacrolebindings_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1rbacrolebindings~1{rbacrolebindingsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_rbacrolebindings_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1rbacrolebindings~1{rbacrolebindingsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_scopes_rbacrolebindings_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1rbacrolebindings/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_scopes_rbacrolebindings_list: - operation: &ref_21 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scopes~1{scopesId}~1rbacrolebindings/get - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.rbacrolebindings - projects_locations_scopes_rbacrolebindings_list: - operation: *ref_21 - response: *ref_22 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_get - - $ref: >- - #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_list - insert: - - $ref: >- - #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_create - update: - - $ref: >- - #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/rbacrolebindings/methods/projects_locations_scopes_rbacrolebindings_delete - features: - id: google.gkehub.features - name: features - title: Features - methods: - _projects_locations_features_list: - operation: &ref_23 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features/get - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.resources - projects_locations_features_list: - operation: *ref_23 - response: *ref_24 - projects_locations_features_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_features_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features~1{featuresId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_features_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features~1{featuresId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_features_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features~1{featuresId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/features/methods/projects_locations_features_get - - $ref: >- - #/components/x-stackQL-resources/features/methods/projects_locations_features_list - insert: - - $ref: >- - #/components/x-stackQL-resources/features/methods/projects_locations_features_create - update: - - $ref: >- - #/components/x-stackQL-resources/features/methods/projects_locations_features_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/features/methods/projects_locations_features_delete - features_iam_policies: - id: google.gkehub.features_iam_policies - name: features_iam_policies - title: Features_iam_policies - methods: - projects_locations_features_set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features~1{featuresId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_features_get_iam_policy: - operation: &ref_25 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features~1{featuresId}:getIamPolicy/get - response: &ref_26 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - projects_locations_features_get_iam_policy: - operation: *ref_25 - response: *ref_26 - projects_locations_features_test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1features~1{featuresId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/features_iam_policies/methods/projects_locations_features_get_iam_policy - insert: [] - update: [] - delete: [] - fleets: - id: google.gkehub.fleets - name: fleets - title: Fleets - methods: - projects_locations_fleets_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1fleets/post - response: - mediaType: application/json - openAPIDocKey: '200' - _projects_locations_fleets_list: - operation: &ref_27 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1fleets/get - response: &ref_28 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.fleets - projects_locations_fleets_list: - operation: *ref_27 - response: *ref_28 - projects_locations_fleets_get: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1fleets~1{fleetsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_fleets_patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1fleets~1{fleetsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_fleets_delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1fleets~1{fleetsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_locations_fleets_list: - operation: &ref_29 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1fleets/get - response: &ref_30 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.fleets - organizations_locations_fleets_list: - operation: *ref_29 - response: *ref_30 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_get - - $ref: >- - #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_list - - $ref: >- - #/components/x-stackQL-resources/fleets/methods/organizations_locations_fleets_list - insert: - - $ref: >- - #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_create - update: - - $ref: >- - #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/fleets/methods/projects_locations_fleets_delete -paths: - /v1/projects/{projectsId}/locations: - parameters: &ref_31 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - get: - description: Lists information about the supported locations for this service. - operationId: gkehub.projects.locations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListLocationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_31 - get: - description: Gets information about a location. - operationId: gkehub.projects.locations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Location' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_31 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: gkehub.projects.locations.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_31 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: gkehub.projects.locations.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - delete: - description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: gkehub.projects.locations.operations.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_31 - post: - description: >- - Starts asynchronous cancellation on a long-running operation. The server - makes a best effort to cancel the operation, but success is not - guaranteed. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation - or other methods to check whether the cancellation succeeded or whether - the operation completed despite cancellation. On successful - cancellation, the operation is not deleted; instead, it becomes an - operation with an Operation.error value with a google.rpc.Status.code of - 1, corresponding to `Code.CANCELLED`. - operationId: gkehub.projects.locations.operations.cancel - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CancelOperationRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/memberships: - parameters: *ref_31 - get: - description: Lists Memberships in a given project and location. - operationId: gkehub.projects.locations.memberships.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListMembershipsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - post: - description: >- - Creates a new Membership. **This is currently only supported for GKE - clusters on Google Cloud**. To register other clusters, follow the - instructions at - https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster. - operationId: gkehub.projects.locations.memberships.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Membership' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: membershipId - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}: - parameters: *ref_31 - get: - description: Gets the details of a Membership. - operationId: gkehub.projects.locations.memberships.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Membership' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - delete: - description: >- - Removes a Membership. **This is currently only supported for GKE - clusters on Google Cloud**. To unregister other clusters, follow the - instructions at - https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster. - operationId: gkehub.projects.locations.memberships.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: query - name: requestId - schema: - type: string - - in: query - name: force - schema: - type: boolean - patch: - description: Updates an existing Membership. - operationId: gkehub.projects.locations.memberships.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Membership' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateConnectManifest: - parameters: *ref_31 - get: - description: >- - Generates the manifest for deployment of the GKE connect agent. **This - method is used internally by Google-provided libraries.** Most clients - should not need to call this method directly. - operationId: gkehub.projects.locations.memberships.generateConnectManifest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GenerateConnectManifestResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: query - name: namespace - schema: - type: string - - in: query - name: proxy - schema: - type: string - format: byte - - in: query - name: version - schema: - type: string - - in: query - name: isUpgrade - schema: - type: boolean - - in: query - name: registry - schema: - type: string - - in: query - name: imagePullSecretContent - schema: - type: string - format: byte - /v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:setIamPolicy: - parameters: *ref_31 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: gkehub.projects.locations.memberships.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:getIamPolicy: - parameters: *ref_31 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: gkehub.projects.locations.memberships.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:testIamPermissions: - parameters: *ref_31 - post: - description: >- - 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. - operationId: gkehub.projects.locations.memberships.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/bindings/{bindingsId}: - parameters: *ref_31 - get: - description: Returns the details of a MembershipBinding. - operationId: gkehub.projects.locations.memberships.bindings.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/MembershipBinding' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: path - name: bindingsId - required: true - schema: - type: string - patch: - description: Updates a MembershipBinding. - operationId: gkehub.projects.locations.memberships.bindings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MembershipBinding' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: path - name: bindingsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a MembershipBinding. - operationId: gkehub.projects.locations.memberships.bindings.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: path - name: bindingsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/bindings: - parameters: *ref_31 - post: - description: Creates a MembershipBinding. - operationId: gkehub.projects.locations.memberships.bindings.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MembershipBinding' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: query - name: membershipBindingId - schema: - type: string - get: - description: Lists MembershipBindings. - operationId: gkehub.projects.locations.memberships.bindings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListMembershipBindingsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: membershipsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:listMemberships: - parameters: *ref_31 - get: - description: >- - Lists Memberships bound to a Scope. The response includes relevant - Memberships from all regions. - operationId: gkehub.projects.locations.scopes.listMemberships - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListBoundMembershipsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}: - parameters: *ref_31 - get: - description: Returns the details of a Scope. - operationId: gkehub.projects.locations.scopes.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Scope' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - patch: - description: Updates a scopes. - operationId: gkehub.projects.locations.scopes.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Scope' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a Scope. - operationId: gkehub.projects.locations.scopes.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes: - parameters: *ref_31 - post: - description: Creates a Scope. - operationId: gkehub.projects.locations.scopes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Scope' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: scopeId - schema: - type: string - get: - description: Lists Scopes. - operationId: gkehub.projects.locations.scopes.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListScopesResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes:listPermitted: - parameters: *ref_31 - get: - description: Lists permitted Scopes. - operationId: gkehub.projects.locations.scopes.listPermitted - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListPermittedScopesResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:setIamPolicy: - parameters: *ref_31 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: gkehub.projects.locations.scopes.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:getIamPolicy: - parameters: *ref_31 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: gkehub.projects.locations.scopes.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}:testIamPermissions: - parameters: *ref_31 - post: - description: >- - 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. - operationId: gkehub.projects.locations.scopes.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}/namespaces/{namespacesId}: - parameters: *ref_31 - get: - description: Returns the details of a fleet namespace. - operationId: gkehub.projects.locations.scopes.namespaces.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Namespace' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: path - name: namespacesId - required: true - schema: - type: string - patch: - description: Updates a fleet namespace. - operationId: gkehub.projects.locations.scopes.namespaces.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Namespace' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: path - name: namespacesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a fleet namespace. - operationId: gkehub.projects.locations.scopes.namespaces.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: path - name: namespacesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}/namespaces: - parameters: *ref_31 - post: - description: Creates a fleet namespace. - operationId: gkehub.projects.locations.scopes.namespaces.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Namespace' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: query - name: scopeNamespaceId - schema: - type: string - get: - description: Lists fleet namespaces. - operationId: gkehub.projects.locations.scopes.namespaces.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListScopeNamespacesResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}/rbacrolebindings/{rbacrolebindingsId}: - parameters: *ref_31 - get: - description: Returns the details of a Scope RBACRoleBinding. - operationId: gkehub.projects.locations.scopes.rbacrolebindings.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/RBACRoleBinding' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: path - name: rbacrolebindingsId - required: true - schema: - type: string - patch: - description: Updates a Scope RBACRoleBinding. - operationId: gkehub.projects.locations.scopes.rbacrolebindings.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RBACRoleBinding' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: path - name: rbacrolebindingsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a Scope RBACRoleBinding. - operationId: gkehub.projects.locations.scopes.rbacrolebindings.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: path - name: rbacrolebindingsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/scopes/{scopesId}/rbacrolebindings: - parameters: *ref_31 - post: - description: Creates a Scope RBACRoleBinding. - operationId: gkehub.projects.locations.scopes.rbacrolebindings.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RBACRoleBinding' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: query - name: rbacrolebindingId - schema: - type: string - get: - description: Lists all Scope RBACRoleBindings. - operationId: gkehub.projects.locations.scopes.rbacrolebindings.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListScopeRBACRoleBindingsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: scopesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/features: - parameters: *ref_31 - get: - description: Lists Features in a given project and location. - operationId: gkehub.projects.locations.features.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListFeaturesResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: orderBy - schema: - type: string - post: - description: Adds a new Feature. - operationId: gkehub.projects.locations.features.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Feature' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: featureId - schema: - type: string - - in: query - name: requestId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/features/{featuresId}: - parameters: *ref_31 - get: - description: Gets details of a single Feature. - operationId: gkehub.projects.locations.features.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Feature' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - delete: - description: Removes a Feature. - operationId: gkehub.projects.locations.features.delete + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + locations: + id: google.gkehub.locations + name: locations + title: Locations + methods: + projects_locations_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.locations + projects_locations_get: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_get + - $ref: >- + #/components/x-stackQL-resources/locations/methods/projects_locations_list + insert: [] + update: [] + replace: [] + delete: [] + operations: + id: google.gkehub.operations + name: operations + title: Operations + methods: + projects_locations_operations_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations + projects_locations_operations_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_operations_cancel: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations~1{operationsId}:cancel/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2/projects/{projectsId}/locations: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: Lists information about the supported locations for this service. + operationId: gkehub.projects.locations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6816,89 +369,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListLocationsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - in: query - name: force - schema: - type: boolean - - in: query - name: requestId - schema: - type: string - patch: - description: Updates an existing Feature. - operationId: gkehub.projects.locations.features.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Feature' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true + name: filter schema: type: string - in: query - name: updateMask + name: pageSize schema: - type: string - format: google-fieldmask + type: integer + format: int32 - in: query - name: requestId + name: pageToken schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/features/{featuresId}:setIamPolicy: - parameters: *ref_31 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: gkehub.projects.locations.features.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + /v2/projects/{projectsId}/locations/{locationsId}: + parameters: *ref_1 + get: + description: Gets information about a location. + operationId: gkehub.projects.locations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6910,7 +405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Location' parameters: - in: path name: projectsId @@ -6922,18 +417,13 @@ paths: required: true schema: type: string - - in: path - name: featuresId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/features/{featuresId}:getIamPolicy: - parameters: *ref_31 + /v2/projects/{projectsId}/locations/{locationsId}/operations: + parameters: *ref_1 get: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: gkehub.projects.locations.features.getIamPolicy + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: gkehub.projects.locations.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -6945,7 +435,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - in: path name: projectsId @@ -6957,134 +447,27 @@ paths: required: true schema: type: string - - in: path - name: featuresId - required: true + - in: query + name: filter schema: type: string - in: query - name: options.requestedPolicyVersion + name: pageSize schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/features/{featuresId}:testIamPermissions: - parameters: *ref_31 - post: - description: >- - 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. - operationId: gkehub.projects.locations.features.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: featuresId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/fleets: - parameters: *ref_31 - post: - description: Creates a fleet. - operationId: gkehub.projects.locations.fleets.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Fleet' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - get: - description: >- - Returns all fleets within an organization or a project that the caller - has access to. - operationId: gkehub.projects.locations.fleets.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListFleetsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/fleets/{fleetsId}: - parameters: *ref_31 + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Returns the details of a fleet. - operationId: gkehub.projects.locations.fleets.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: gkehub.projects.locations.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7096,7 +479,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Fleet' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -7109,54 +492,29 @@ paths: schema: type: string - in: path - name: fleetsId + name: operationsId required: true schema: type: string - patch: - description: Updates a fleet. - operationId: gkehub.projects.locations.fleets.patch + /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: + parameters: *ref_1 + post: + description: >- + Starts asynchronous cancellation on a long-running operation. The server + makes a best effort to cancel the operation, but success is not + guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation + or other methods to check whether the cancellation succeeded or whether + the operation completed despite cancellation. On successful + cancellation, the operation is not deleted; instead, it becomes an + operation with an Operation.error value with a google.rpc.Status.code of + 1, corresponding to `Code.CANCELLED`. + operationId: gkehub.projects.locations.operations.cancel requestBody: content: application/json: schema: - $ref: '#/components/schemas/Fleet' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: fleetsId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Removes a Fleet. There must be no memberships remaining in the Fleet. - operationId: gkehub.projects.locations.fleets.delete + $ref: '#/components/schemas/CancelOperationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -7168,7 +526,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -7181,46 +539,7 @@ paths: schema: type: string - in: path - name: fleetsId - required: true - schema: - type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/fleets: - parameters: *ref_31 - get: - description: >- - Returns all fleets within an organization or a project that the caller - has access to. - operationId: gkehub.organizations.locations.fleets.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListFleetsResponse' - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: locationsId + name: operationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml b/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml index f66a1543..4a5e9950 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/gkeonprem.yaml @@ -4,11 +4,11 @@ info: name: StackQL Studios url: https://github.com/stackql/google-discovery-to-openapi email: info@stackql.io - title: Anthos On-Prem API + title: GDC Virtual API description: '' version: v1 - x-discovery-doc-revision: '20240228' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240814' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/anthos/clusters/docs/on-prem/ servers: @@ -884,6 +884,14 @@ components: type: array items: $ref: '#/components/schemas/ResourceCondition' + version: + description: Reflect current version of the resource. + type: string + versions: + description: >- + Shows the mapping of a given version to the number of machines under + this version. + $ref: '#/components/schemas/Versions' ResourceCondition: id: ResourceCondition description: >- @@ -921,6 +929,34 @@ components: - STATE_TRUE - STATE_FALSE - STATE_UNKNOWN + Versions: + id: Versions + description: >- + Versions describes the mapping of a given version to the number of + machines under this version. + type: object + properties: + versions: + description: >- + Shows the mapping of a given version to the number of machines under + this version. + type: array + items: + $ref: '#/components/schemas/Version' + Version: + id: Version + description: >- + Version describes the number of nodes at a given version under a + resource. + type: object + properties: + version: + description: Resource version. + type: string + count: + description: Number of machines under the above version. + type: string + format: int64 ValidationCheck: id: ValidationCheck description: ValidationCheck represents the result of preflight check. @@ -1133,6 +1169,12 @@ components: - NODE_POOL_POLICY_UNSPECIFIED - SERIAL - CONCURRENT + pause: + description: >- + Output only. Pause is used to show the upgrade pause status. It's + view only for now. + readOnly: true + type: boolean EnrollBareMetalClusterRequest: id: EnrollBareMetalClusterRequest description: >- @@ -2506,6 +2548,12 @@ components: authorization: description: The VMware admin cluster authorization configuration. $ref: '#/components/schemas/VmwareAdminAuthorizationConfig' + validationCheck: + description: >- + Output only. ValidationCheck represents the result of the preflight + check job. + readOnly: true + $ref: '#/components/schemas/ValidationCheck' VmwareAdminVCenterConfig: id: VmwareAdminVCenterConfig description: >- @@ -3971,16 +4019,13 @@ components: name: locations title: Locations methods: - _projects_locations_list: - operation: &ref_1 + projects_locations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 projects_locations_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3995,23 +4040,21 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] operations: id: google.gkeonprem.operations name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -4033,17 +4076,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_clusters_operations_list: - operation: &ref_5 + projects_locations_bare_metal_clusters_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalClusters~1{bareMetalClustersId}~1operations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_bare_metal_clusters_operations_list: - operation: *ref_5 - response: *ref_6 projects_locations_bare_metal_clusters_operations_get: operation: $ref: >- @@ -4051,17 +4091,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list: - operation: &ref_7 + projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalClusters~1{bareMetalClustersId}~1bareMetalNodePools~1{bareMetalNodePoolsId}~1operations/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list: - operation: *ref_7 - response: *ref_8 projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get: operation: $ref: >- @@ -4069,17 +4106,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_clusters_operations_list: - operation: &ref_9 + projects_locations_vmware_clusters_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareClusters~1{vmwareClustersId}~1operations/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_vmware_clusters_operations_list: - operation: *ref_9 - response: *ref_10 projects_locations_vmware_clusters_operations_get: operation: $ref: >- @@ -4087,17 +4121,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_clusters_vmware_node_pools_operations_list: - operation: &ref_11 + projects_locations_vmware_clusters_vmware_node_pools_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareClusters~1{vmwareClustersId}~1vmwareNodePools~1{vmwareNodePoolsId}~1operations/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_vmware_clusters_vmware_node_pools_operations_list: - operation: *ref_11 - response: *ref_12 projects_locations_vmware_clusters_vmware_node_pools_operations_get: operation: $ref: >- @@ -4105,17 +4136,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_admin_clusters_operations_list: - operation: &ref_13 + projects_locations_vmware_admin_clusters_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareAdminClusters~1{vmwareAdminClustersId}~1operations/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_vmware_admin_clusters_operations_list: - operation: *ref_13 - response: *ref_14 projects_locations_vmware_admin_clusters_operations_get: operation: $ref: >- @@ -4123,17 +4151,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_admin_clusters_operations_list: - operation: &ref_15 + projects_locations_bare_metal_admin_clusters_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalAdminClusters~1{bareMetalAdminClustersId}~1operations/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_bare_metal_admin_clusters_operations_list: - operation: *ref_15 - response: *ref_16 projects_locations_bare_metal_admin_clusters_operations_get: operation: $ref: >- @@ -4173,6 +4198,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete @@ -4188,17 +4214,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_clusters_list: - operation: &ref_17 + projects_locations_bare_metal_clusters_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalClusters/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bareMetalClusters - projects_locations_bare_metal_clusters_list: - operation: *ref_17 - response: *ref_18 projects_locations_bare_metal_clusters_delete: operation: $ref: >- @@ -4253,6 +4276,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/bare_metal_clusters/methods/projects_locations_bare_metal_clusters_delete @@ -4268,17 +4292,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_clusters_get_iam_policy: - operation: &ref_19 + projects_locations_bare_metal_clusters_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalClusters~1{bareMetalClustersId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_bare_metal_clusters_get_iam_policy: - operation: *ref_19 - response: *ref_20 projects_locations_bare_metal_clusters_test_iam_permissions: operation: $ref: >- @@ -4292,6 +4313,9 @@ components: #/components/x-stackQL-resources/bare_metal_clusters_iam_policies/methods/projects_locations_bare_metal_clusters_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/bare_metal_clusters_iam_policies/methods/projects_locations_bare_metal_clusters_set_iam_policy delete: [] bare_metal_node_pools: id: google.gkeonprem.bare_metal_node_pools @@ -4305,17 +4329,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_clusters_bare_metal_node_pools_list: - operation: &ref_21 + projects_locations_bare_metal_clusters_bare_metal_node_pools_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalClusters~1{bareMetalClustersId}~1bareMetalNodePools/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bareMetalNodePools - projects_locations_bare_metal_clusters_bare_metal_node_pools_list: - operation: *ref_21 - response: *ref_22 projects_locations_bare_metal_clusters_bare_metal_node_pools_delete: operation: $ref: >- @@ -4363,6 +4384,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/bare_metal_node_pools/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_delete @@ -4378,17 +4400,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_clusters_bare_metal_node_pools_get_iam_policy: - operation: &ref_23 + projects_locations_bare_metal_clusters_bare_metal_node_pools_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalClusters~1{bareMetalClustersId}~1bareMetalNodePools~1{bareMetalNodePoolsId}:getIamPolicy/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_bare_metal_clusters_bare_metal_node_pools_get_iam_policy: - operation: *ref_23 - response: *ref_24 projects_locations_bare_metal_clusters_bare_metal_node_pools_test_iam_permissions: operation: $ref: >- @@ -4402,6 +4421,9 @@ components: #/components/x-stackQL-resources/bare_metal_node_pools_iam_policies/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/bare_metal_node_pools_iam_policies/methods/projects_locations_bare_metal_clusters_bare_metal_node_pools_set_iam_policy delete: [] vmware_clusters: id: google.gkeonprem.vmware_clusters @@ -4429,17 +4451,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_clusters_list: - operation: &ref_25 + projects_locations_vmware_clusters_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareClusters/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.vmwareClusters - projects_locations_vmware_clusters_list: - operation: *ref_25 - response: *ref_26 projects_locations_vmware_clusters_delete: operation: $ref: >- @@ -4480,6 +4499,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/vmware_clusters/methods/projects_locations_vmware_clusters_delete @@ -4495,17 +4515,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_clusters_get_iam_policy: - operation: &ref_27 + projects_locations_vmware_clusters_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareClusters~1{vmwareClustersId}:getIamPolicy/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_vmware_clusters_get_iam_policy: - operation: *ref_27 - response: *ref_28 projects_locations_vmware_clusters_test_iam_permissions: operation: $ref: >- @@ -4519,6 +4536,9 @@ components: #/components/x-stackQL-resources/vmware_clusters_iam_policies/methods/projects_locations_vmware_clusters_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/vmware_clusters_iam_policies/methods/projects_locations_vmware_clusters_set_iam_policy delete: [] vmware_node_pools: id: google.gkeonprem.vmware_node_pools @@ -4532,17 +4552,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_clusters_vmware_node_pools_list: - operation: &ref_29 + projects_locations_vmware_clusters_vmware_node_pools_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareClusters~1{vmwareClustersId}~1vmwareNodePools/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.vmwareNodePools - projects_locations_vmware_clusters_vmware_node_pools_list: - operation: *ref_29 - response: *ref_30 projects_locations_vmware_clusters_vmware_node_pools_delete: operation: $ref: >- @@ -4590,6 +4607,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/vmware_node_pools/methods/projects_locations_vmware_clusters_vmware_node_pools_delete @@ -4605,17 +4623,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_clusters_vmware_node_pools_get_iam_policy: - operation: &ref_31 + projects_locations_vmware_clusters_vmware_node_pools_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareClusters~1{vmwareClustersId}~1vmwareNodePools~1{vmwareNodePoolsId}:getIamPolicy/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_vmware_clusters_vmware_node_pools_get_iam_policy: - operation: *ref_31 - response: *ref_32 projects_locations_vmware_clusters_vmware_node_pools_test_iam_permissions: operation: $ref: >- @@ -4629,23 +4644,23 @@ components: #/components/x-stackQL-resources/vmware_node_pools_iam_policies/methods/projects_locations_vmware_clusters_vmware_node_pools_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/vmware_node_pools_iam_policies/methods/projects_locations_vmware_clusters_vmware_node_pools_set_iam_policy delete: [] vmware_admin_clusters: id: google.gkeonprem.vmware_admin_clusters name: vmware_admin_clusters title: Vmware_admin_clusters methods: - _projects_locations_vmware_admin_clusters_list: - operation: &ref_33 + projects_locations_vmware_admin_clusters_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareAdminClusters/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.vmwareAdminClusters - projects_locations_vmware_admin_clusters_list: - operation: *ref_33 - response: *ref_34 projects_locations_vmware_admin_clusters_get: operation: $ref: >- @@ -4684,6 +4699,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/vmware_admin_clusters/methods/projects_locations_vmware_admin_clusters_patch + replace: [] delete: [] vmware_admin_clusters_iam_policies: id: google.gkeonprem.vmware_admin_clusters_iam_policies @@ -4697,17 +4713,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_vmware_admin_clusters_get_iam_policy: - operation: &ref_35 + projects_locations_vmware_admin_clusters_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareAdminClusters~1{vmwareAdminClustersId}:getIamPolicy/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_vmware_admin_clusters_get_iam_policy: - operation: *ref_35 - response: *ref_36 projects_locations_vmware_admin_clusters_test_iam_permissions: operation: $ref: >- @@ -4721,6 +4734,9 @@ components: #/components/x-stackQL-resources/vmware_admin_clusters_iam_policies/methods/projects_locations_vmware_admin_clusters_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/vmware_admin_clusters_iam_policies/methods/projects_locations_vmware_admin_clusters_set_iam_policy delete: [] bare_metal_admin_clusters: id: google.gkeonprem.bare_metal_admin_clusters @@ -4734,17 +4750,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_admin_clusters_list: - operation: &ref_37 + projects_locations_bare_metal_admin_clusters_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalAdminClusters/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bareMetalAdminClusters - projects_locations_bare_metal_admin_clusters_list: - operation: *ref_37 - response: *ref_38 projects_locations_bare_metal_admin_clusters_get: operation: $ref: >- @@ -4792,6 +4805,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/bare_metal_admin_clusters/methods/projects_locations_bare_metal_admin_clusters_patch + replace: [] delete: [] bare_metal_admin_clusters_iam_policies: id: google.gkeonprem.bare_metal_admin_clusters_iam_policies @@ -4805,17 +4819,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_bare_metal_admin_clusters_get_iam_policy: - operation: &ref_39 + projects_locations_bare_metal_admin_clusters_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1bareMetalAdminClusters~1{bareMetalAdminClustersId}:getIamPolicy/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_bare_metal_admin_clusters_get_iam_policy: - operation: *ref_39 - response: *ref_40 projects_locations_bare_metal_admin_clusters_test_iam_permissions: operation: $ref: >- @@ -4829,10 +4840,13 @@ components: #/components/x-stackQL-resources/bare_metal_admin_clusters_iam_policies/methods/projects_locations_bare_metal_admin_clusters_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/bare_metal_admin_clusters_iam_policies/methods/projects_locations_bare_metal_admin_clusters_set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_41 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4879,7 +4893,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets information about a location. operationId: gkeonprem.projects.locations.get @@ -4907,7 +4921,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4950,7 +4964,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5021,7 +5035,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5068,7 +5082,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters: - parameters: *ref_41 + parameters: *ref_1 post: description: Creates a new bare metal cluster in a given project and location. operationId: gkeonprem.projects.locations.bareMetalClusters.create @@ -5108,6 +5122,10 @@ paths: name: validateOnly schema: type: boolean + - in: query + name: allowPreflightFailure + schema: + type: boolean get: description: Lists bare metal clusters in a given project and location. operationId: gkeonprem.projects.locations.bareMetalClusters.list @@ -5151,8 +5169,12 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}: - parameters: *ref_41 + parameters: *ref_1 delete: description: Deletes a single bare metal Cluster. operationId: gkeonprem.projects.locations.bareMetalClusters.delete @@ -5239,6 +5261,10 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean patch: description: Updates the parameters of a single bare metal Cluster. operationId: gkeonprem.projects.locations.bareMetalClusters.patch @@ -5289,7 +5315,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters:enroll: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Enrolls an existing bare metal user cluster and its node pools to the @@ -5328,7 +5354,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:unenroll: - parameters: *ref_41 + parameters: *ref_1 delete: description: >- Unenrolls an existing bare metal user cluster and its node pools from @@ -5383,7 +5409,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters:queryVersionConfig: - parameters: *ref_41 + parameters: *ref_1 post: description: Queries the bare metal user cluster version config. operationId: gkeonprem.projects.locations.bareMetalClusters.queryVersionConfig @@ -5423,7 +5449,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5464,7 +5490,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5504,7 +5530,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5547,7 +5573,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -5595,7 +5621,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5636,7 +5662,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Creates a new bare metal node pool in a given project, location and Bare @@ -5730,7 +5756,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}: - parameters: *ref_41 + parameters: *ref_1 delete: description: Deletes a single bare metal node pool. operationId: gkeonprem.projects.locations.bareMetalClusters.bareMetalNodePools.delete @@ -5878,7 +5904,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools:enroll: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Enrolls an existing bare metal node pool to the Anthos On-Prem API @@ -5920,7 +5946,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:unenroll: - parameters: *ref_41 + parameters: *ref_1 delete: description: Unenrolls a bare metal node pool from Anthos On-Prem API. operationId: >- @@ -5971,7 +5997,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6018,7 +6044,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6064,7 +6090,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6113,7 +6139,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -6167,7 +6193,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalClusters/{bareMetalClustersId}/bareMetalNodePools/{bareMetalNodePoolsId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -6214,7 +6240,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters:enroll: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Enrolls an existing VMware user cluster and its node pools to the Anthos @@ -6253,7 +6279,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:unenroll: - parameters: *ref_41 + parameters: *ref_1 delete: description: >- Unenrolls an existing VMware user cluster and its node pools from the @@ -6308,7 +6334,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters: - parameters: *ref_41 + parameters: *ref_1 post: description: Creates a new VMware user cluster in a given project and location. operationId: gkeonprem.projects.locations.vmwareClusters.create @@ -6348,6 +6374,10 @@ paths: name: validateOnly schema: type: boolean + - in: query + name: allowPreflightFailure + schema: + type: boolean get: description: Lists VMware Clusters in a given project and location. operationId: gkeonprem.projects.locations.vmwareClusters.list @@ -6391,8 +6421,12 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}: - parameters: *ref_41 + parameters: *ref_1 delete: description: Deletes a single VMware Cluster. operationId: gkeonprem.projects.locations.vmwareClusters.delete @@ -6479,6 +6513,10 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean patch: description: Updates the parameters of a single VMware cluster. operationId: gkeonprem.projects.locations.vmwareClusters.patch @@ -6525,7 +6563,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters:queryVersionConfig: - parameters: *ref_41 + parameters: *ref_1 post: description: Queries the VMware user cluster version config. operationId: gkeonprem.projects.locations.vmwareClusters.queryVersionConfig @@ -6565,7 +6603,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6606,7 +6644,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6646,7 +6684,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6689,7 +6727,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -6737,7 +6775,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -6778,7 +6816,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Creates a new VMware node pool in a given project, location and VMWare @@ -6870,7 +6908,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}: - parameters: *ref_41 + parameters: *ref_1 delete: description: Deletes a single VMware node pool. operationId: gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.delete @@ -7014,7 +7052,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools:enroll: - parameters: *ref_41 + parameters: *ref_1 post: description: Enrolls a VMware node pool to Anthos On-Prem API operationId: gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.enroll @@ -7052,7 +7090,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:unenroll: - parameters: *ref_41 + parameters: *ref_1 delete: description: Unenrolls a VMware node pool to Anthos On-Prem API operationId: gkeonprem.projects.locations.vmwareClusters.vmwareNodePools.unenroll @@ -7102,7 +7140,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7148,7 +7186,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7193,7 +7231,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7242,7 +7280,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -7296,7 +7334,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareClusters/{vmwareClustersId}/vmwareNodePools/{vmwareNodePoolsId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -7343,7 +7381,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists VMware admin clusters in a given project and location. operationId: gkeonprem.projects.locations.vmwareAdminClusters.list @@ -7383,8 +7421,12 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a single VMware admin cluster. operationId: gkeonprem.projects.locations.vmwareAdminClusters.get @@ -7420,6 +7462,10 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean patch: description: Updates the parameters of a single VMware admin cluster. operationId: gkeonprem.projects.locations.vmwareAdminClusters.patch @@ -7466,7 +7512,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters:enroll: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Enrolls an existing VMware admin cluster to the Anthos On-Prem API @@ -7504,7 +7550,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:unenroll: - parameters: *ref_41 + parameters: *ref_1 delete: description: >- Unenrolls an existing VMware admin cluster from the Anthos On-Prem API @@ -7554,7 +7600,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7595,7 +7641,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7635,7 +7681,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7678,7 +7724,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -7726,7 +7772,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareAdminClusters/{vmwareAdminClustersId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -7767,7 +7813,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Creates a new bare metal admin cluster in a given project and location. @@ -7811,6 +7857,10 @@ paths: name: validateOnly schema: type: boolean + - in: query + name: allowPreflightFailure + schema: + type: boolean get: description: Lists bare metal admin clusters in a given project and location. operationId: gkeonprem.projects.locations.bareMetalAdminClusters.list @@ -7850,8 +7900,12 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a single bare metal admin cluster. operationId: gkeonprem.projects.locations.bareMetalAdminClusters.get @@ -7887,6 +7941,10 @@ paths: name: view schema: type: string + - in: query + name: allowMissing + schema: + type: boolean patch: description: Updates the parameters of a single bare metal admin cluster. operationId: gkeonprem.projects.locations.bareMetalAdminClusters.patch @@ -7933,7 +7991,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters:enroll: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Enrolls an existing bare metal admin cluster to the Anthos On-Prem API @@ -7971,7 +8029,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:unenroll: - parameters: *ref_41 + parameters: *ref_1 delete: description: >- Unenrolls an existing bare metal admin cluster from the Anthos On-Prem @@ -8025,7 +8083,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters:queryVersionConfig: - parameters: *ref_41 + parameters: *ref_1 post: description: Queries the bare metal admin cluster version config. operationId: gkeonprem.projects.locations.bareMetalAdminClusters.queryVersionConfig @@ -8057,7 +8115,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8098,7 +8156,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -8138,7 +8196,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -8181,7 +8239,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -8229,7 +8287,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/bareMetalAdminClusters/{bareMetalAdminClustersId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this diff --git a/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml b/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml index af0cefcc..093ee0cb 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/healthcare.yaml @@ -7,8 +7,8 @@ info: title: Cloud Healthcare API description: Manage, store, and access healthcare data in Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240828' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/healthcare servers: @@ -1373,11 +1373,11 @@ components: useRegionalDataProcessing: description: >- Ensures in-flight data remains in the region of origin during - de-identification. Using this option results in a significant - reduction of throughput, and is not compatible with `LOCATION` or - `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within - TextConfig, and must also be excluded within ImageConfig if image - redaction is required. + de-identification. The default value is false. Using this option + results in a significant reduction of throughput, and is not + compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. + `LOCATION` must be excluded within TextConfig, and must also be + excluded within ImageConfig if image redaction is required. type: boolean DicomConfig: id: DicomConfig @@ -1747,10 +1747,33 @@ components: type: string timeZone: description: >- - The default timezone used by this dataset. Must be a either a valid - IANA time zone name such as "America/New_York" or empty, which - defaults to UTC. This is used for parsing times in resources, such - as HL7 messages, where no explicit timezone is specified. + Optional. The default timezone used by this dataset. Must be a + either a valid IANA time zone name such as "America/New_York" or + empty, which defaults to UTC. This is used for parsing times in + resources, such as HL7 messages, where no explicit timezone is + specified. + type: string + encryptionSpec: + description: >- + Optional. Customer-managed encryption key spec for a Dataset. If + set, this Dataset and all of its sub-resources will be secured by + this key. If empty, the Dataset is secured by the default Google + encryption key. + $ref: '#/components/schemas/EncryptionSpec' + EncryptionSpec: + id: EncryptionSpec + description: >- + Represents a customer-managed encryption key spec that can be applied to + a resource. + type: object + properties: + kmsKeyName: + description: >- + Required. The resource name of customer-managed encryption key that + is used to secure a resource and its sub-resources. Only the key in + the same location as this Dataset is allowed to be used for + encryption. Format is: + `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` type: string ListDatasetsResponse: id: ListDatasetsResponse @@ -1795,6 +1818,125 @@ components: project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. type: string + StorageInfo: + id: StorageInfo + description: StorageInfo encapsulates all the storage info of a resource. + type: object + properties: + referencedResource: + description: >- + The resource whose storage info is returned. For example: + `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}` + type: string + structuredStorageInfo: + description: Info about the data stored in structured storage for the resource. + $ref: '#/components/schemas/StructuredStorageInfo' + blobStorageInfo: + description: Info about the data stored in blob storage for the resource. + $ref: '#/components/schemas/BlobStorageInfo' + StructuredStorageInfo: + id: StructuredStorageInfo + description: >- + StructuredStorageInfo contains details about the data stored in + Structured Storage for the referenced resource. + type: object + properties: + sizeBytes: + description: Size in bytes of data stored in structured storage. + type: string + format: int64 + BlobStorageInfo: + id: BlobStorageInfo + description: >- + BlobStorageInfo contains details about the data stored in Blob Storage + for the referenced resource. Note: Storage class is only valid for DICOM + and hence will only be populated for DICOM resources. + type: object + properties: + sizeBytes: + description: Size in bytes of data stored in Blob Storage. + type: string + format: int64 + storageClass: + description: The storage class in which the Blob data is stored. + type: string + enumDescriptions: + - >- + If unspecified in CreateDataset, the StorageClass defaults to + STANDARD. If unspecified in UpdateDataset and the StorageClass is + set in the field mask, an InvalidRequest error is thrown. + - >- + This stores the Object in Blob Standard Storage: + https://cloud.google.com/storage/docs/storage-classes#standard + - >- + This stores the Object in Blob Nearline Storage: + https://cloud.google.com/storage/docs/storage-classes#nearline + - >- + This stores the Object in Blob Coldline Storage: + https://cloud.google.com/storage/docs/storage-classes#coldline + - >- + This stores the Object in Blob Archive Storage: + https://cloud.google.com/storage/docs/storage-classes#archive + enum: + - BLOB_STORAGE_CLASS_UNSPECIFIED + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE + storageClassUpdateTime: + description: >- + The time at which the storage class was updated. This is used to + compute early deletion fees of the resource. + type: string + format: google-datetime + SetBlobStorageSettingsRequest: + id: SetBlobStorageSettingsRequest + description: Request message for `SetBlobStorageSettings` method. + type: object + properties: + filterConfig: + description: >- + Optional. A filter configuration. If `filter_config` is specified, + set the value of `resource` to the resource name of a DICOM store in + the format + `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`. + $ref: '#/components/schemas/DicomFilterConfig' + blobStorageSettings: + description: >- + The blob storage settings to update for the specified resources. + Only fields listed in `update_mask` are applied. + $ref: '#/components/schemas/BlobStorageSettings' + BlobStorageSettings: + id: BlobStorageSettings + description: Settings for data stored in Blob storage. + type: object + properties: + blobStorageClass: + description: The Storage class in which the Blob data is stored. + type: string + enumDescriptions: + - >- + If unspecified in CreateDataset, the StorageClass defaults to + STANDARD. If unspecified in UpdateDataset and the StorageClass is + set in the field mask, an InvalidRequest error is thrown. + - >- + This stores the Object in Blob Standard Storage: + https://cloud.google.com/storage/docs/storage-classes#standard + - >- + This stores the Object in Blob Nearline Storage: + https://cloud.google.com/storage/docs/storage-classes#nearline + - >- + This stores the Object in Blob Coldline Storage: + https://cloud.google.com/storage/docs/storage-classes#coldline + - >- + This stores the Object in Blob Archive Storage: + https://cloud.google.com/storage/docs/storage-classes#archive + enum: + - BLOB_STORAGE_CLASS_UNSPECIFIED + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE DicomStore: id: DicomStore description: Represents a DICOM store. @@ -1967,6 +2109,11 @@ components: `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage location. $ref: '#/components/schemas/GoogleCloudHealthcareV1DicomGcsSource' + blobStorageSettings: + description: >- + Optional. The blob storage settings for the data imported by this + operation. + $ref: '#/components/schemas/BlobStorageSettings' GoogleCloudHealthcareV1DicomGcsSource: id: GoogleCloudHealthcareV1DicomGcsSource description: Specifies the configuration for importing data from Cloud Storage. @@ -2622,7 +2769,6 @@ components: description: >- Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. - Assigned by the server. readOnly: true type: string data: @@ -2637,19 +2783,25 @@ components: type: string format: google-datetime sendFacility: - description: The hospital that this message came from. MSH-4. + description: Output only. The hospital that this message came from. MSH-4. + readOnly: true type: string sendTime: - description: The datetime the sending application sent this message. MSH-7. + description: >- + Output only. The datetime the sending application sent this message. + MSH-7. + readOnly: true type: string format: google-datetime messageType: - description: The message type for this message. MSH-9.1. + description: Output only. The message type for this message. MSH-9.1. + readOnly: true type: string patientIds: description: >- - All patient IDs listed in the PID-2, PID-3, and PID-4 segments of - this message. + Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 + segments of this message. + readOnly: true type: array items: $ref: '#/components/schemas/PatientId' @@ -2672,8 +2824,9 @@ components: $ref: '#/components/schemas/ParsedData' schematizedData: description: >- - The parsed version of the raw message data schematized according to - this store's schemas and type definitions. + Output only. The parsed version of the raw message data schematized + according to this store's schemas and type definitions. + readOnly: true $ref: '#/components/schemas/SchematizedData' PatientId: id: PatientId @@ -3004,6 +3157,64 @@ components: this message type in the store. type: string format: int64 + RollbackHl7V2MessagesRequest: + id: RollbackHl7V2MessagesRequest + description: Point in time recovery rollback request. + type: object + properties: + rollbackTime: + description: Required. Times point to rollback to. + type: string + format: google-datetime + force: + description: >- + Optional. When enabled, changes will be reverted without explicit + confirmation. + type: boolean + changeType: + description: >- + Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a + certain type. + type: string + enumDescriptions: + - When unspecified, revert all transactions + - All transactions + - Revert only CREATE transactions + - Revert only Update transactions + - Revert only Delete transactions + enum: + - CHANGE_TYPE_UNSPECIFIED + - ALL + - CREATE + - UPDATE + - DELETE + resultGcsBucket: + description: Required. Bucket to deposit result + type: string + inputGcsObject: + description: >- + Optional. Cloud storage object containing list of {resourceId} + lines, identifying resources to be reverted + type: string + excludeRollbacks: + description: Optional. Specifies whether to exclude earlier rollbacks. + type: boolean + filteringFields: + description: Optional. Parameters for filtering. + $ref: '#/components/schemas/RollbackHL7MessagesFilteringFields' + RollbackHL7MessagesFilteringFields: + id: RollbackHL7MessagesFilteringFields + description: >- + Filtering fields for an HL7v2 rollback. Currently only supports a list + of operation ids to roll back. + type: object + properties: + operationIds: + description: Optional. A list of operation IDs to roll back. + type: array + items: + type: string + format: uint64 SearchResourcesRequest: id: SearchResourcesRequest description: Request to search the resources in the specified FHIR store. @@ -3040,7 +3251,7 @@ components: client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields - within other resources. + within other resources. Defaults to false. type: boolean notificationConfig: description: >- @@ -3066,12 +3277,11 @@ components: description: >- Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR - store. If set to false, which is the default behavior, all write - operations cause historical versions to be recorded automatically. - The historical versions can be fetched through the history APIs, but - cannot be updated. If set to true, no historical versions are kept. - The server sends errors for attempts to read the historical - versions. + store. If set to false, all write operations cause historical + versions to be recorded automatically. The historical versions can + be fetched through the history APIs, but cannot be updated. If set + to true, no historical versions are kept. The server sends errors + for attempts to read the historical versions. Defaults to false. type: boolean labels: description: >- @@ -3137,7 +3347,7 @@ components: `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or - `Prefer: handling=lenient`. + `Prefer: handling=lenient`. Defaults to false. type: boolean complexDataTypeReferenceParsing: description: >- @@ -3253,12 +3463,13 @@ components: $ref: '#/components/schemas/SchemaConfig' force: description: >- - If this flag is `TRUE`, all tables are deleted from the dataset - before the new exported tables are written. If the flag is not set - and the destination dataset contains tables, the export call returns - an error. If `write_disposition` is specified, this parameter is - ignored. force=false is equivalent to write_disposition=WRITE_EMPTY - and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + The default value is false. If this flag is `TRUE`, all tables are + deleted from the dataset before the new exported tables are written. + If the flag is not set and the destination dataset contains tables, + the export call returns an error. If `write_disposition` is + specified, this parameter is ignored. force=false is equivalent to + write_disposition=WRITE_EMPTY and force=true is equivalent to + write_disposition=WRITE_TRUNCATE. type: boolean writeDisposition: description: >- @@ -3379,9 +3590,10 @@ components: properties: disableProfileValidation: description: >- - Whether to disable profile validation for this FHIR store. Set this - to true to disable checking incoming resources for conformance - against structure definitions in this FHIR store. + Whether to disable profile validation for this FHIR store. The + default value is false. Set this to true to disable checking + incoming resources for conformance against structure definitions in + this FHIR store. type: boolean enabledImplementationGuides: description: >- @@ -3406,29 +3618,31 @@ components: disableRequiredFieldValidation: description: >- Whether to disable required fields validation for incoming - resources. Set this to true to disable checking incoming resources - for conformance against required fields requirement defined in the - FHIR specification. This property only affects resource types that - do not have profiles configured for them, any rules in enabled - implementation guides will still be enforced. + resources. The default value is false. Set this to true to disable + checking incoming resources for conformance against required fields + requirement defined in the FHIR specification. This property only + affects resource types that do not have profiles configured for + them, any rules in enabled implementation guides will still be + enforced. type: boolean disableReferenceTypeValidation: description: >- Whether to disable reference type validation for incoming resources. - Set this to true to disable checking incoming resources for - conformance against reference type requirement defined in the FHIR - specification. This property only affects resource types that do not - have profiles configured for them, any rules in enabled - implementation guides will still be enforced. + The default value is false. Set this to true to disable checking + incoming resources for conformance against reference type + requirement defined in the FHIR specification. This property only + affects resource types that do not have profiles configured for + them, any rules in enabled implementation guides will still be + enforced. type: boolean disableFhirpathValidation: description: >- - Whether to disable FHIRPath validation for incoming resources. Set - this to true to disable checking incoming resources for conformance - against FHIRPath requirement defined in the FHIR specification. This - property only affects resource types that do not have profiles - configured for them, any rules in enabled implementation guides will - still be enforced. + Whether to disable FHIRPath validation for incoming resources. The + default value is false. Set this to true to disable checking + incoming resources for conformance against FHIRPath requirement + defined in the FHIR specification. This property only affects + resource types that do not have profiles configured for them, any + rules in enabled implementation guides will still be enforced. type: boolean FhirNotificationConfig: id: FhirNotificationConfig @@ -3459,18 +3673,20 @@ components: Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). type: string sendFullResource: - description: Whether to send full FHIR resource to this Pub/Sub topic. + description: >- + Whether to send full FHIR resource to this Pub/Sub topic. The + default value is false. type: boolean sendPreviousResourceOnDelete: description: >- Whether to send full FHIR resource to this Pub/Sub topic for - deleting FHIR resource. Note that setting this to true does not - guarantee that all previous resources will be sent in the format of - full FHIR resource. When a resource change is too large or during - heavy traffic, only the resource name will be sent. Clients should - always check the "payloadType" label from a Pub/Sub message to - determine whether it needs to fetch the full previous resource as a - separate operation. + deleting FHIR resource. The default value is false. Note that + setting this to true does not guarantee that all previous resources + will be sent in the format of full FHIR resource. When a resource + change is too large or during heavy traffic, only the resource name + will be sent. Clients should always check the "payloadType" label + from a Pub/Sub message to determine whether it needs to fetch the + full previous resource as a separate operation. type: boolean ListFhirStoresResponse: id: ListFhirStoresResponse @@ -4048,6 +4264,24 @@ components: operation finishes successfully. type: object properties: {} + RollbackHl7V2MessagesResponse: + id: RollbackHl7V2MessagesResponse + description: Final response of rollback HL7v2 messages request. + type: object + properties: + hl7v2Store: + description: >- + The name of the HL7v2 store to rollback, in the format of + "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} + /hl7v2Stores/{hl7v2_store_id}". + type: string + SetBlobStorageSettingsResponse: + id: SetBlobStorageSettingsResponse + description: >- + Returns additional info in regards to a completed set blob storage + settings API. + type: object + properties: {} parameters: access_token: description: OAuth access token. @@ -4134,16 +4368,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -4156,6 +4387,7 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] datasets_iam_policies: id: google.healthcare.datasets_iam_policies @@ -4169,17 +4401,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_3 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}:getIamPolicy/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_3 - response: *ref_4 test_iam_permissions: operation: $ref: >- @@ -4193,6 +4422,9 @@ components: #/components/x-stackQL-resources/datasets_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/datasets_iam_policies/methods/set_iam_policy delete: [] datasets: id: google.healthcare.datasets @@ -4206,17 +4438,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.datasets - list: - operation: *ref_5 - response: *ref_6 delete: operation: $ref: >- @@ -4253,6 +4482,7 @@ components: - $ref: '#/components/x-stackQL-resources/datasets/methods/create' update: - $ref: '#/components/x-stackQL-resources/datasets/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/datasets/methods/delete' consent_stores_iam_policies: @@ -4267,17 +4497,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1consentStores~1{consentStoresId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -4291,6 +4518,9 @@ components: #/components/x-stackQL-resources/consent_stores_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/consent_stores_iam_policies/methods/set_iam_policy delete: [] consent_stores: id: google.healthcare.consent_stores @@ -4304,17 +4534,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1consentStores/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.consentStores - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -4365,6 +4592,7 @@ components: - $ref: '#/components/x-stackQL-resources/consent_stores/methods/create' update: - $ref: '#/components/x-stackQL-resources/consent_stores/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/consent_stores/methods/delete' attribute_definitions: @@ -4379,17 +4607,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1consentStores~1{consentStoresId}~1attributeDefinitions/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.attributeDefinitions - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -4422,6 +4647,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/attribute_definitions/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/attribute_definitions/methods/delete @@ -4437,17 +4663,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1consentStores~1{consentStoresId}~1consentArtifacts/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.consentArtifacts - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -4469,6 +4692,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/consent_artifacts/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/consent_artifacts/methods/delete' consents: @@ -4483,17 +4707,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1consentStores~1{consentStoresId}~1consents/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.consents - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -4544,6 +4765,7 @@ components: - $ref: '#/components/x-stackQL-resources/consents/methods/create' update: - $ref: '#/components/x-stackQL-resources/consents/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/consents/methods/delete' consents_revision: @@ -4562,6 +4784,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/consents_revision/methods/delete_revision @@ -4570,23 +4793,21 @@ components: name: consents_revisions title: Consents_revisions methods: - _list_revisions: - operation: &ref_17 + list_revisions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1consentStores~1{consentStoresId}~1consents~1{consentsId}:listRevisions/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.consents - list_revisions: - operation: *ref_17 - response: *ref_18 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/consents_revisions/methods/list_revisions insert: [] update: [] + replace: [] delete: [] user_data_mappings: id: google.healthcare.user_data_mappings @@ -4600,17 +4821,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1consentStores~1{consentStoresId}~1userDataMappings/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.userDataMappings - list: - operation: *ref_19 - response: *ref_20 get: operation: $ref: >- @@ -4647,6 +4865,7 @@ components: - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/create' update: - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/user_data_mappings/methods/delete' data_mapper_workspaces_iam_policies: @@ -4661,17 +4880,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_21 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dataMapperWorkspaces~1{dataMapperWorkspacesId}:getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_21 - response: *ref_22 test_iam_permissions: operation: $ref: >- @@ -4685,6 +4901,9 @@ components: #/components/x-stackQL-resources/data_mapper_workspaces_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/data_mapper_workspaces_iam_policies/methods/set_iam_policy delete: [] dicom_stores_iam_policies: id: google.healthcare.dicom_stores_iam_policies @@ -4698,17 +4917,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_23 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}:getIamPolicy/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_23 - response: *ref_24 test_iam_permissions: operation: $ref: >- @@ -4722,6 +4938,9 @@ components: #/components/x-stackQL-resources/dicom_stores_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/dicom_stores_iam_policies/methods/set_iam_policy delete: [] dicom_stores: id: google.healthcare.dicom_stores @@ -4735,6 +4954,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + set_blob_storage_settings: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}:setBlobStorageSettings/post + response: + mediaType: application/json + openAPIDocKey: '200' create: operation: $ref: >- @@ -4742,17 +4968,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_25 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.dicomStores - list: - operation: *ref_25 - response: *ref_26 get: operation: $ref: >- @@ -4824,6 +5047,7 @@ components: - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/create' update: - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/dicom_stores/methods/delete' dicom_stores_dicomstore_metrics: @@ -4844,29 +5068,20 @@ components: #/components/x-stackQL-resources/dicom_stores_dicomstore_metrics/methods/get_dicomstore_metrics insert: [] update: [] + replace: [] delete: [] - studies_study: - id: google.healthcare.studies_study - name: studies_study - title: Studies_study + studies: + id: google.healthcare.studies + name: studies + title: Studies methods: - retrieve_study: + set_blob_storage_settings: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}:setBlobStorageSettings/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - studies: - id: google.healthcare.studies - name: studies - title: Studies - methods: delete: operation: $ref: >- @@ -4899,83 +5114,174 @@ components: select: [] insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/studies/methods/delete' - studies_metadata: - id: google.healthcare.studies_metadata - name: studies_metadata - title: Studies_metadata + studies_study_metrics: + id: google.healthcare.studies_study_metrics + name: studies_study_metrics + title: Studies_study_metrics methods: - retrieve_metadata: + get_study_metrics: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1metadata/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}:getStudyMetrics/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/studies_study_metrics/methods/get_study_metrics insert: [] update: [] + replace: [] delete: [] - series_series: - id: google.healthcare.series_series - name: series_series - title: Series_series + series_series_metrics: + id: google.healthcare.series_series_metrics + name: series_series_metrics + title: Series_series_metrics methods: - retrieve_series: + get_series_metrics: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}:getSeriesMetrics/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/series_series_metrics/methods/get_series_metrics insert: [] update: [] + replace: [] delete: [] - series: - id: google.healthcare.series - name: series - title: Series + instances_storage_info: + id: google.healthcare.instances_storage_info + name: instances_storage_info + title: Instances_storage_info methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - search_for_instances: + get_storage_info: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances~1{instancesId}:getStorageInfo/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instances_storage_info/methods/get_storage_info insert: [] update: [] - delete: - - $ref: '#/components/x-stackQL-resources/series/methods/delete' - series_metadata: - id: google.healthcare.series_metadata - name: series_metadata - title: Series_metadata + replace: [] + delete: [] + studies_study: + id: google.healthcare.studies_study + name: studies_study + title: Studies_study methods: - retrieve_metadata: + retrieve_study: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1metadata/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/studies_study/methods/retrieve_study + insert: [] + update: [] + replace: [] + delete: [] + studies_metadata: + id: google.healthcare.studies_metadata + name: studies_metadata + title: Studies_metadata + methods: + retrieve_metadata: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1metadata/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/studies_metadata/methods/retrieve_metadata + insert: [] + update: [] + replace: [] + delete: [] + series_series: + id: google.healthcare.series_series + name: series_series + title: Series_series + methods: + retrieve_series: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/series_series/methods/retrieve_series + insert: [] + update: [] + replace: [] + delete: [] + series: + id: google.healthcare.series + name: series + title: Series + methods: + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + search_for_instances: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1instances/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/series/methods/delete' + series_metadata: + id: google.healthcare.series_metadata + name: series_metadata + title: Series_metadata + methods: + retrieve_metadata: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}~1metadata/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/series_metadata/methods/retrieve_metadata insert: [] update: [] + replace: [] delete: [] instances_instance: id: google.healthcare.instances_instance @@ -4990,9 +5296,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instances_instance/methods/retrieve_instance insert: [] update: [] + replace: [] delete: [] instances: id: google.healthcare.instances @@ -5010,6 +5319,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_rendered: @@ -5025,9 +5335,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instances_rendered/methods/retrieve_rendered insert: [] update: [] + replace: [] delete: [] instances_metadata: id: google.healthcare.instances_metadata @@ -5042,9 +5355,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/instances_metadata/methods/retrieve_metadata insert: [] update: [] + replace: [] delete: [] frames_frames: id: google.healthcare.frames_frames @@ -5059,9 +5375,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/frames_frames/methods/retrieve_frames insert: [] update: [] + replace: [] delete: [] frames_rendered: id: google.healthcare.frames_rendered @@ -5075,48 +5394,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - studies_study_metrics: - id: google.healthcare.studies_study_metrics - name: studies_study_metrics - title: Studies_study_metrics - methods: - get_study_metrics: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}:getStudyMetrics/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/studies_study_metrics/methods/get_study_metrics - insert: [] - update: [] - delete: [] - series_series_metrics: - id: google.healthcare.series_series_metrics - name: series_series_metrics - title: Series_series_metrics - methods: - get_series_metrics: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1dicomStores~1{dicomStoresId}~1dicomWeb~1studies~1{studiesId}~1series~1{seriesId}:getSeriesMetrics/get - response: - mediaType: application/json - openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/series_series_metrics/methods/get_series_metrics + #/components/x-stackQL-resources/frames_rendered/methods/retrieve_rendered insert: [] update: [] + replace: [] delete: [] hl7_v2_stores_iam_policies: id: google.healthcare.hl7_v2_stores_iam_policies @@ -5130,17 +5414,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_27 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1hl7V2Stores~1{hl7V2StoresId}:getIamPolicy/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_27 - response: *ref_28 test_iam_permissions: operation: $ref: >- @@ -5154,6 +5435,9 @@ components: #/components/x-stackQL-resources/hl7_v2_stores_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/hl7_v2_stores_iam_policies/methods/set_iam_policy delete: [] hl7_v2_stores: id: google.healthcare.hl7_v2_stores @@ -5167,17 +5451,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_29 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1hl7V2Stores/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.hl7V2Stores - list: - operation: *ref_29 - response: *ref_30 get: operation: $ref: >- @@ -5213,6 +5494,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + rollback: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1hl7V2Stores~1{hl7V2StoresId}:rollback/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/get' @@ -5221,6 +5509,7 @@ components: - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/create' update: - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/hl7_v2_stores/methods/delete' hl7_v2_stores_hl7v2_store_metrics: @@ -5241,6 +5530,7 @@ components: #/components/x-stackQL-resources/hl7_v2_stores_hl7v2_store_metrics/methods/get_hl7v2_store_metrics insert: [] update: [] + replace: [] delete: [] messages: id: google.healthcare.messages @@ -5261,17 +5551,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_31 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1hl7V2Stores~1{hl7V2StoresId}~1messages/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.hl7V2Messages - list: - operation: *ref_31 - response: *ref_32 get: operation: $ref: >- @@ -5301,6 +5588,7 @@ components: - $ref: '#/components/x-stackQL-resources/messages/methods/create' update: - $ref: '#/components/x-stackQL-resources/messages/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/messages/methods/delete' fhir_stores_iam_policies: @@ -5315,17 +5603,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_33 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}:getIamPolicy/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_33 - response: *ref_34 test_iam_permissions: operation: $ref: >- @@ -5339,6 +5624,9 @@ components: #/components/x-stackQL-resources/fhir_stores_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/fhir_stores_iam_policies/methods/set_iam_policy delete: [] fhir_stores: id: google.healthcare.fhir_stores @@ -5359,17 +5647,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_35 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.fhirStores - list: - operation: *ref_35 - response: *ref_36 get: operation: $ref: >- @@ -5420,6 +5705,7 @@ components: - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/create' update: - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/fhir_stores/methods/delete' fhir_stores_fhirstore_metrics: @@ -5440,6 +5726,7 @@ components: #/components/x-stackQL-resources/fhir_stores_fhirstore_metrics/methods/get_fhirstore_metrics insert: [] update: [] + replace: [] delete: [] fhir: id: google.healthcare.fhir @@ -5474,6 +5761,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + binary-create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1Binary/post + response: + mediaType: application/json + openAPIDocKey: '200' read: operation: $ref: >- @@ -5502,6 +5796,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + binary-read: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1Binary~1{BinaryId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + binary-update: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1Binary~1{BinaryId}/put + response: + mediaType: application/json + openAPIDocKey: '200' vread: operation: $ref: >- @@ -5509,6 +5817,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + binary-vread: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1fhirStores~1{fhirStoresId}~1fhir~1Binary~1{BinaryId}~1_history~1{_historyId}/get + response: + mediaType: application/json + openAPIDocKey: '200' search: operation: $ref: >- @@ -5570,8 +5885,9 @@ components: insert: - $ref: '#/components/x-stackQL-resources/fhir/methods/create' update: - - $ref: '#/components/x-stackQL-resources/fhir/methods/update' - $ref: '#/components/x-stackQL-resources/fhir/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/fhir/methods/update' delete: - $ref: '#/components/x-stackQL-resources/fhir/methods/delete' operations: @@ -5579,17 +5895,14 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_37 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1operations/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_37 - response: *ref_38 get: operation: $ref: >- @@ -5610,6 +5923,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] nlp: id: google.healthcare.nlp @@ -5627,10 +5941,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_39 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -5681,7 +5996,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets information about a location. operationId: healthcare.projects.locations.get @@ -5713,7 +6028,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:setIamPolicy: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5758,7 +6073,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:getIamPolicy: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5802,7 +6117,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:testIamPermissions: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5849,7 +6164,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Creates a new health dataset. Results are returned through the Operation @@ -5933,7 +6248,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: - parameters: *ref_39 + parameters: *ref_1 delete: description: >- Deletes the specified health dataset and all data contained in the @@ -6053,7 +6368,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:deidentify: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Creates a new dataset containing de-identified data from the source @@ -6104,7 +6419,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}:setIamPolicy: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6154,7 +6469,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}:getIamPolicy: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6203,7 +6518,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}:testIamPermissions: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6255,7 +6570,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Creates a new consent store in the parent dataset. Attempting to create @@ -6352,7 +6667,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets the specified consent store. operationId: healthcare.projects.locations.datasets.consentStores.get @@ -6486,7 +6801,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}:checkDataAccess: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Checks if a particular data_id of a User data mapping in the specified @@ -6535,7 +6850,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}:queryAccessibleData: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Queries all data_ids that are consented for a specified use in the given @@ -6610,7 +6925,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}:evaluateUserConsents: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Evaluates the user's Consents for all matching User data mappings. Note: @@ -6662,7 +6977,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/attributeDefinitions: - parameters: *ref_39 + parameters: *ref_1 post: description: Creates a new Attribute definition in the parent consent store. operationId: >- @@ -6768,7 +7083,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/attributeDefinitions/{attributeDefinitionsId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets the specified Attribute definition. operationId: >- @@ -6921,7 +7236,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consentArtifacts: - parameters: *ref_39 + parameters: *ref_1 post: description: Creates a new Consent artifact in the parent consent store. operationId: >- @@ -7023,7 +7338,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consentArtifacts/{consentArtifactsId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets the specified Consent artifact. operationId: >- @@ -7119,7 +7434,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consents: - parameters: *ref_39 + parameters: *ref_1 post: description: Creates a new Consent in the parent consent store. operationId: healthcare.projects.locations.datasets.consentStores.consents.create @@ -7221,7 +7536,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consents/{consentsId}: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the specified revision of a Consent, or the latest revision if @@ -7378,7 +7693,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consents/{consentsId}:deleteRevision: - parameters: *ref_39 + parameters: *ref_1 delete: description: >- Deletes the specified revision of a Consent. An INVALID_ARGUMENT error @@ -7428,7 +7743,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consents/{consentsId}:activate: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Activates the latest revision of the specified Consent by committing a @@ -7485,7 +7800,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consents/{consentsId}:reject: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Rejects the latest revision of the specified Consent by committing a new @@ -7542,7 +7857,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consents/{consentsId}:listRevisions: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Lists the revisions of the specified Consent in reverse chronological @@ -7605,7 +7920,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/consents/{consentsId}:revoke: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Revokes the latest revision of the specified Consent by committing a new @@ -7662,7 +7977,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/userDataMappings: - parameters: *ref_39 + parameters: *ref_1 post: description: Creates a new User data mapping in the parent consent store. operationId: >- @@ -7764,7 +8079,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/userDataMappings/{userDataMappingsId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets the specified User data mapping. operationId: >- @@ -7914,7 +8229,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/consentStores/{consentStoresId}/userDataMappings/{userDataMappingsId}:archive: - parameters: *ref_39 + parameters: *ref_1 post: description: Archives the specified User data mapping. operationId: >- @@ -7967,7 +8282,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:setIamPolicy: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8017,7 +8332,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:getIamPolicy: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -8066,7 +8381,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataMapperWorkspaces/{dataMapperWorkspacesId}:testIamPermissions: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -8119,7 +8434,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -8169,7 +8484,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getIamPolicy: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -8218,7 +8533,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:testIamPermissions: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -8270,7 +8585,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:deidentify: - parameters: *ref_39 + parameters: *ref_1 post: description: >- De-identifies data from the source store and writes it to the @@ -8326,8 +8641,58 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setBlobStorageSettings: + parameters: *ref_1 + post: + description: >- + SetBlobStorageSettings sets the blob storage settings of the specified + resources. + operationId: >- + healthcare.projects.locations.datasets.dicomStores.setBlobStorageSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetBlobStorageSettingsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: dicomStoresId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores: - parameters: *ref_39 + parameters: *ref_1 post: description: Creates a new DICOM store within the parent dataset. operationId: healthcare.projects.locations.datasets.dicomStores.create @@ -8421,7 +8786,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets the specified DICOM store. operationId: healthcare.projects.locations.datasets.dicomStores.get @@ -8555,7 +8920,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:import: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Imports data into the DICOM store by copying it from the specified @@ -8607,7 +8972,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:export: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Exports data to the specified destination by copying it from the DICOM @@ -8659,7 +9024,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getDICOMStoreMetrics: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets metrics associated with the DICOM store. operationId: healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics @@ -8701,7 +9066,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies: - parameters: *ref_39 + parameters: *ref_1 get: description: >- SearchForStudies returns a list of matching studies. See [Search @@ -8804,7 +9169,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series: - parameters: *ref_39 + parameters: *ref_1 get: description: >- SearchForSeries returns a list of matching series. See [Search @@ -8854,7 +9219,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances: - parameters: *ref_39 + parameters: *ref_1 get: description: >- SearchForInstances returns a list of matching instances. See [Search @@ -8903,19 +9268,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}: - parameters: *ref_39 - get: + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:setBlobStorageSettings: + parameters: *ref_1 + post: description: >- - RetrieveStudy returns all instances within the given study. See - [RetrieveTransaction] - (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). - For details on the implementation of RetrieveStudy, see [DICOM - study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) - in the Cloud Healthcare API conformance statement. For samples that show - how to call RetrieveStudy, see [Retrieve DICOM - data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). - operationId: healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy + SetBlobStorageSettings sets the blob storage settings of the specified + resources. + operationId: >- + healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetBlobStorageSettingsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare @@ -8931,7 +9296,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/HttpBody' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -8958,15 +9323,229 @@ paths: required: true schema: type: string - delete: - description: >- - DeleteStudy deletes all instances within the given study. Delete - requests are equivalent to the GET requests specified in the Retrieve - transaction. The method returns an Operation which will be marked - successful when the deletion is complete. Warning: Instances cannot be - inserted into a study that is being deleted by an operation until the - operation completes. For samples that show how to call DeleteStudy, see - [Delete a study, series, or + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:getStudyMetrics: + parameters: *ref_1 + get: + description: GetStudyMetrics returns metrics for a study. + operationId: >- + healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/StudyMetrics' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: dicomStoresId + required: true + schema: + type: string + - in: path + name: studiesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}:getSeriesMetrics: + parameters: *ref_1 + get: + description: GetSeriesMetrics returns metrics for a series. + operationId: >- + healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SeriesMetrics' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: dicomStoresId + required: true + schema: + type: string + - in: path + name: studiesId + required: true + schema: + type: string + - in: path + name: seriesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}:getStorageInfo: + parameters: *ref_1 + get: + description: GetStorageInfo returns the storage info of the specified resource. + operationId: >- + healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/StorageInfo' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: dicomStoresId + required: true + schema: + type: string + - in: path + name: studiesId + required: true + schema: + type: string + - in: path + name: seriesId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}: + parameters: *ref_1 + get: + description: >- + RetrieveStudy returns all instances within the given study. See + [RetrieveTransaction] + (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + For details on the implementation of RetrieveStudy, see [DICOM + study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) + in the Cloud Healthcare API conformance statement. For samples that show + how to call RetrieveStudy, see [Retrieve DICOM + data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). + operationId: healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: dicomStoresId + required: true + schema: + type: string + - in: path + name: studiesId + required: true + schema: + type: string + delete: + description: >- + DeleteStudy deletes all instances within the given study. Delete + requests are equivalent to the GET requests specified in the Retrieve + transaction. The method returns an Operation which will be marked + successful when the deletion is complete. Warning: Instances cannot be + inserted into a study that is being deleted by an operation until the + operation completes. For samples that show how to call DeleteStudy, see + [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). operationId: healthcare.projects.locations.datasets.dicomStores.studies.delete security: @@ -9071,7 +9650,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveStudyMetadata returns instance associated with the given study @@ -9129,7 +9708,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series: - parameters: *ref_39 + parameters: *ref_1 get: description: >- SearchForSeries returns a list of matching series. See [Search @@ -9185,7 +9764,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances: - parameters: *ref_39 + parameters: *ref_1 get: description: >- SearchForInstances returns a list of matching instances. See [Search @@ -9241,7 +9820,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveSeries returns all instances within the given study and series. @@ -9360,7 +9939,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveSeriesMetadata returns instance associated with the given study @@ -9423,7 +10002,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances: - parameters: *ref_39 + parameters: *ref_1 get: description: >- SearchForInstances returns a list of matching instances. See [Search @@ -9484,7 +10063,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveInstance returns instance associated with the given study, @@ -9615,7 +10194,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveRenderedInstance returns instance associated with the given @@ -9683,7 +10262,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveInstanceMetadata returns instance associated with the given @@ -9751,7 +10330,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveFrames returns instances associated with the given study, @@ -9822,132 +10401,21 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered: - parameters: *ref_39 + parameters: *ref_1 get: description: >- RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable - Rendered Media Type. See [RetrieveTransaction] - (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). - For details on the implementation of RetrieveRenderedFrames, see - [Rendered - resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) - in the Cloud Healthcare API conformance statement. For samples that show - how to call RetrieveRenderedFrames, see [Retrieve consumer image - formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). - operationId: >- - healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-healthcare - Oauth2c: - - https://www.googleapis.com/auth/cloud-healthcare - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/HttpBody' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dicomStoresId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - - in: path - name: seriesId - required: true - schema: - type: string - - in: path - name: instancesId - required: true - schema: - type: string - - in: path - name: framesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:getStudyMetrics: - parameters: *ref_39 - get: - description: GetStudyMetrics returns metrics for a study. - operationId: >- - healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-healthcare - Oauth2c: - - https://www.googleapis.com/auth/cloud-healthcare - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/StudyMetrics' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: datasetsId - required: true - schema: - type: string - - in: path - name: dicomStoresId - required: true - schema: - type: string - - in: path - name: studiesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}:getSeriesMetrics: - parameters: *ref_39 - get: - description: GetSeriesMetrics returns metrics for a series. + Rendered Media Type. See [RetrieveTransaction] + (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + For details on the implementation of RetrieveRenderedFrames, see + [Rendered + resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) + in the Cloud Healthcare API conformance statement. For samples that show + how to call RetrieveRenderedFrames, see [Retrieve consumer image + formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). operationId: >- - healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics + healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered security: - Oauth2: - https://www.googleapis.com/auth/cloud-healthcare @@ -9963,7 +10431,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SeriesMetrics' + $ref: '#/components/schemas/HttpBody' parameters: - in: path name: projectsId @@ -9995,8 +10463,18 @@ paths: required: true schema: type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: framesId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:setIamPolicy: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -10046,7 +10524,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getIamPolicy: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -10095,7 +10573,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:testIamPermissions: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -10147,7 +10625,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores: - parameters: *ref_39 + parameters: *ref_1 post: description: Creates a new HL7v2 store within the parent dataset. operationId: healthcare.projects.locations.datasets.hl7V2Stores.create @@ -10241,7 +10719,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets the specified HL7v2 store. operationId: healthcare.projects.locations.datasets.hl7V2Stores.get @@ -10375,7 +10853,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:export: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Exports the messages to a destination. To filter messages to be @@ -10430,7 +10908,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:import: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Import messages to the HL7v2 store by loading data from the specified @@ -10503,7 +10981,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets metrics associated with the HL7v2 store. operationId: healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics @@ -10544,8 +11022,64 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:rollback: + parameters: *ref_1 + post: + description: >- + Rolls back messages from the HL7v2 store to the specified time. This + method returns an Operation that can be used to track the status of the + rollback by calling GetOperation. Immediate fatal errors appear in the + error field, errors are also logged to Cloud Logging (see [Viewing error + logs in Cloud + Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + Otherwise, when the operation finishes, a detailed response of type + RollbackHl7V2MessagesResponse is returned in the response field. The + metadata field type for this operation is OperationMetadata. + operationId: healthcare.projects.locations.datasets.hl7V2Stores.rollback + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RollbackHl7V2MessagesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: hl7V2StoresId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}/messages:ingest: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Parses and stores an HL7v2 message. This method triggers an asynchronous @@ -10602,7 +11136,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}/messages: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Parses and stores an HL7v2 message. This method triggers an asynchronous @@ -10719,7 +11253,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}/messages/{messagesId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets an HL7v2 message. operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.get @@ -10875,7 +11409,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:setIamPolicy: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -10925,7 +11459,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getIamPolicy: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -10974,7 +11508,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:testIamPermissions: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -11026,7 +11560,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:deidentify: - parameters: *ref_39 + parameters: *ref_1 post: description: >- De-identifies data from the source store and writes it to the @@ -11079,7 +11613,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores: - parameters: *ref_39 + parameters: *ref_1 post: description: Creates a new FHIR store within the parent dataset. operationId: healthcare.projects.locations.datasets.fhirStores.create @@ -11173,7 +11707,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets the configuration of the specified FHIR store. operationId: healthcare.projects.locations.datasets.fhirStores.get @@ -11305,7 +11839,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:import: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Imports resources to the FHIR store by loading data from the specified @@ -11410,7 +11944,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:export: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Export resources from the FHIR store to the specified destination. This @@ -11466,7 +12000,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:getFHIRStoreMetrics: - parameters: *ref_39 + parameters: *ref_1 get: description: Gets metrics associated with the FHIR store. operationId: healthcare.projects.locations.datasets.fhirStores.getFHIRStoreMetrics @@ -11508,7 +12042,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:rollback: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Rolls back resources from the FHIR store to the specified time. This @@ -11564,7 +12098,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Creates a FHIR resource. Implements the FHIR standard create interaction @@ -11846,8 +12380,86 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary: + parameters: *ref_1 + post: + description: >- + Creates a FHIR Binary resource. This method can be used to create a + Binary resource either by using one of the accepted FHIR JSON content + types, or as a raw data stream. If a resource is created with this + method using the FHIR content type this method's behavior is the same as + [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). + If a resource type other than Binary is used in the request it's treated + in the same way as non-FHIR data (e.g., images, zip archives, pdf files, + documents). When a non-FHIR content type is used in the request, a + Binary resource will be generated, and the uploaded data will be stored + in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). + The Binary resource's `contentType` will be filled in using the value of + the `Content-Type` header, and the `securityContext` field (not present + in `DSTU2`) will be populated from the `X-Security-Context` header if it + exists. At this time `securityContext` has no special behavior in the + Cloud Healthcare API. Note: the limit on data ingested through this + method is 2 GB. For best performance, use a non-FHIR data type instead + of wrapping the data in a Binary resource. Some of the Healthcare API + features, such as [exporting to + BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) + or [Pub/Sub + notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) + with full resource content, do not support Binary resources that are + larger than 10 MB. In these cases the resource's `data` field will be + omitted. Instead, the + "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension + will be present to indicate that including the data is `unsupported`. On + success, an empty `201 Created` response is returned. The newly created + resource's ID and version are returned in the Location header. Using + `Prefer: representation=resource` is not allowed for this method. The + definition of the Binary REST API can be found at + https://hl7.org/fhir/binary.html#rest. + operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the contents of a FHIR resource. Implements the FHIR standard read @@ -12126,8 +12738,151 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}: + parameters: *ref_1 + get: + description: >- + Gets the contents of a FHIR Binary resource. This method can be used to + retrieve a Binary resource either by using the FHIR JSON mimetype as the + value for the Accept header, or as a raw data stream. If the FHIR Accept + type is used this method will return a Binary resource with the data + base64-encoded, regardless of how the resource was created. The resource + data can be retrieved in base64-decoded form if the Accept type of the + request matches the value of the resource's `contentType` field. The + definition of the Binary REST API can be found at + https://hl7.org/fhir/binary.html#rest. + operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: BinaryId + required: true + schema: + type: string + put: + description: >- + Updates the entire contents of a Binary resource. If the specified + resource does not exist and the FHIR store has enable_update_create set, + creates the resource with the client-specified ID. It is strongly + advised not to include or encode any sensitive data such as patient + identifiers in client-specified resource IDs. Those IDs are part of the + FHIR resource path recorded in Cloud Audit Logs and Pub/Sub + notifications. Those IDs can also be contained in reference fields + within other resources. This method can be used to update a Binary + resource either by using one of the accepted FHIR JSON content types, or + as a raw data stream. If a resource is updated with this method using + the FHIR content type this method's behavior is the same as `update`. If + a resource type other than Binary is used in the request it will be + treated in the same way as non-FHIR data. When a non-FHIR content type + is used in the request, a Binary resource will be generated using the ID + from the resource path, and the uploaded data will be stored in the + `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The + Binary resource's `contentType` will be filled in using the value of the + `Content-Type` header, and the `securityContext` field (not present in + `DSTU2`) will be populated from the `X-Security-Context` header if it + exists. At this time `securityContext` has no special behavior in the + Cloud Healthcare API. Note: the limit on data ingested through this + method is 2 GB. For best performance, use a non-FHIR data type instead + of wrapping the data in a Binary resource. Some of the Healthcare API + features, such as [exporting to + BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) + or [Pub/Sub + notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) + with full resource content, do not support Binary resources that are + larger than 10 MB. In these cases the resource's `data` field will be + omitted. Instead, the + "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension + will be present to indicate that including the data is `unsupported`. On + success, an empty 200 OK response will be returned, or a 201 Created if + the resource did not exit. The resource's ID and version are returned in + the Location header. Using `Prefer: representation=resource` is not + allowed for this method. The definition of the Binary REST API can be + found at https://hl7.org/fhir/binary.html#rest. + operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: BinaryId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history/{_historyId}: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the contents of a version (current or historical) of a FHIR @@ -12195,8 +12950,70 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}: + parameters: *ref_1 + get: + description: >- + Gets the contents of a version (current or historical) of a FHIR Binary + resource by version ID. This method can be used to retrieve a Binary + resource version either by using the FHIR JSON mimetype as the value for + the Accept header, or as a raw data stream. If the FHIR Accept type is + used this method will return a Binary resource with the data + base64-encoded, regardless of how the resource version was created. The + resource data can be retrieved in base64-decoded form if the Accept type + of the request matches the value of the resource version's `contentType` + field. The definition of the Binary REST API can be found at + https://hl7.org/fhir/binary.html#rest. + operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-healthcare + Oauth2c: + - https://www.googleapis.com/auth/cloud-healthcare + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: datasetsId + required: true + schema: + type: string + - in: path + name: fhirStoresId + required: true + schema: + type: string + - in: path + name: BinaryId + required: true + schema: + type: string + - in: path + name: _historyId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Searches for resources in the given FHIR store according to criteria @@ -12312,7 +13129,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Searches for resources in the given FHIR store according to criteria @@ -12433,7 +13250,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Retrieves a Patient resource and resources related to that patient. @@ -12529,7 +13346,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the FHIR capability statement @@ -12585,7 +13402,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Executes all the requests in the given Bundle. Implements the FHIR @@ -12669,7 +13486,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Lists all the versions of a resource (including the current version and @@ -12752,7 +13569,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/$purge: - parameters: *ref_39 + parameters: *ref_1 delete: description: >- Deletes all the historical versions of a resource (excluding the current @@ -12810,7 +13627,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Validates an input FHIR resource's conformance to its profiles and the @@ -12882,7 +13699,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -12934,7 +13751,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}: - parameters: *ref_39 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -12979,7 +13796,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -13035,7 +13852,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/nlp:analyzeEntities: - parameters: *ref_39 + parameters: *ref_1 post: description: >- Analyze heathcare entity in a document. Its response includes the diff --git a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml index 66d319ce..9c5f2c68 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iam.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iam.yaml @@ -11,9 +11,9 @@ info: Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API. - version: v2 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + version: v1 + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -39,8 +39,8 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleLongrunningOperation: - id: GoogleLongrunningOperation + Operation: + id: Operation description: >- This resource represents a long-running operation that is the result of a network API call. @@ -74,7 +74,7 @@ components: description: >- The error result of the operation in case of failure or cancellation. - $ref: '#/components/schemas/GoogleRpcStatus' + $ref: '#/components/schemas/Status' response: description: >- The normal, successful response of the operation. If the original @@ -89,8 +89,8 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. - GoogleRpcStatus: - id: GoogleRpcStatus + Status: + id: Status description: >- The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It @@ -121,131 +121,628 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. - GoogleIamV2ListPoliciesResponse: - id: GoogleIamV2ListPoliciesResponse - description: Response message for `ListPolicies`. + ListServiceAccountsResponse: + id: ListServiceAccountsResponse + description: The service account list response. type: object properties: - policies: - description: Metadata for the policies that are attached to the resource. + accounts: + description: The list of matching service accounts. type: array items: - $ref: '#/components/schemas/GoogleIamV2Policy' + $ref: '#/components/schemas/ServiceAccount' nextPageToken: description: >- - A page token that you can use in a ListPoliciesRequest to retrieve - the next page. If this field is omitted, there are no additional - pages. + To retrieve the next page of results, set + ListServiceAccountsRequest.page_token to this value. type: string - GoogleIamV2Policy: - id: GoogleIamV2Policy - description: Data for an IAM policy. + ServiceAccount: + id: ServiceAccount + description: >- + An IAM service account. A service account is an account for an + application or a virtual machine (VM) instance, not a person. You can + use a service account to call Google APIs. To learn more, read the + [overview of service + accounts](https://cloud.google.com/iam/help/service-accounts/overview). + When you create a service account, you specify the project ID that owns + the service account, as well as a name that must be unique within the + project. IAM uses these values to create an email address that + identifies the service account. // type: object properties: name: description: >- - Immutable. The resource name of the `Policy`, which must be unique. - Format: `policies/{attachment_point}/denypolicies/{policy_id}` The - attachment point is identified by its URL-encoded full resource - name, which means that the forward-slash character, `/`, must be - written as `%2F`. For example, - `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. - For organizations and folders, use the numeric ID in the full - resource name. For projects, requests can use the alphanumeric or - the numeric ID. Responses always contain the numeric ID. + The resource name of the service account. Use one of the following + formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * + `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an + alternative, you can use the `-` wildcard character instead of the + project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * + `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using + the `-` wildcard character, because it can cause response messages + to contain misleading error codes. For example, if you try to access + the service account `projects/-/serviceAccounts/fake@example.com`, + which does not exist, the response contains an HTTP `403 Forbidden` + error instead of a `404 Not Found` error. type: string - uid: - description: >- - Immutable. The globally unique ID of the `Policy`. Assigned - automatically when the `Policy` is created. + projectId: + description: Output only. The ID of the project that owns the service account. + readOnly: true type: string - kind: + uniqueId: description: >- - Output only. The kind of the `Policy`. Always contains the value - `DenyPolicy`. + Output only. The unique, stable numeric ID for the service account. + Each service account retains its unique ID even if you delete the + service account. For example, if you delete a service account, then + create a new service account with the same name, the new service + account has a different unique ID than the deleted service account. + readOnly: true + type: string + email: + description: Output only. The email address of the service account. readOnly: true type: string displayName: description: >- - A user-specified description of the `Policy`. This value can be up - to 63 characters. + Optional. A user-specified, human-readable name for the service + account. The maximum length is 100 UTF-8 bytes. type: string - annotations: - description: >- - A key-value map to store arbitrary metadata for the `Policy`. Keys - can be up to 63 characters. Values can be up to 255 characters. - type: object - additionalProperties: - type: string etag: + description: Deprecated. Do not use. + deprecated: true + type: string + format: byte + description: description: >- - An opaque tag that identifies the current version of the `Policy`. - IAM uses this value to help manage concurrent updates, so they do - not cause one update to be overwritten by another. If this field is - present in a CreatePolicyRequest, the value is ignored. + Optional. A user-specified, human-readable description of the + service account. The maximum length is 256 UTF-8 bytes. type: string - createTime: - description: Output only. The time when the `Policy` was created. + oauth2ClientId: + description: Output only. The OAuth 2.0 client ID for the service account. readOnly: true type: string - format: google-datetime - updateTime: - description: Output only. The time when the `Policy` was last updated. + disabled: + description: Output only. Whether the service account is disabled. readOnly: true + type: boolean + CreateServiceAccountRequest: + id: CreateServiceAccountRequest + description: The service account create request. + type: object + properties: + accountId: + description: >- + Required. The account id that is used to generate the service + account email address and a stable unique id. It is unique within a + project, must be 6-30 characters long, and match the regular + expression `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. + type: string + serviceAccount: + description: >- + The ServiceAccount resource to create. Currently, only the following + values are user assignable: `display_name` and `description`. + $ref: '#/components/schemas/ServiceAccount' + PatchServiceAccountRequest: + id: PatchServiceAccountRequest + description: >- + The service account patch request. You can patch only the `display_name` + and `description` fields. You must use the `update_mask` field to + specify which of these fields you want to patch. Only the fields + specified in the request are guaranteed to be returned in the response. + Other fields may be empty in the response. + type: object + properties: + serviceAccount: + $ref: '#/components/schemas/ServiceAccount' + updateMask: + type: string + format: google-fieldmask + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} + UndeleteServiceAccountRequest: + id: UndeleteServiceAccountRequest + description: The service account undelete request. + type: object + properties: {} + UndeleteServiceAccountResponse: + id: UndeleteServiceAccountResponse + type: object + properties: + restoredAccount: + description: Metadata for the restored service account. + $ref: '#/components/schemas/ServiceAccount' + EnableServiceAccountRequest: + id: EnableServiceAccountRequest + description: The service account enable request. + type: object + properties: {} + DisableServiceAccountRequest: + id: DisableServiceAccountRequest + description: The service account disable request. + type: object + properties: {} + ListServiceAccountKeysResponse: + id: ListServiceAccountKeysResponse + description: The service account keys list response. + type: object + properties: + keys: + description: The public keys for the service account. + type: array + items: + $ref: '#/components/schemas/ServiceAccountKey' + ServiceAccountKey: + id: ServiceAccountKey + description: >- + Represents a service account key. A service account has two sets of + key-pairs: user-managed, and system-managed. User-managed key-pairs can + be created and deleted by users. Users are responsible for rotating + these keys periodically to ensure security of their service accounts. + Users retain the private key of these key-pairs, and Google retains ONLY + the public key. System-managed keys are automatically rotated by Google, + and are used for signing for a maximum of two weeks. The rotation + process is probabilistic, and usage of the new key will gradually ramp + up and down over the key's lifetime. If you cache the public key set for + a service account, we recommend that you update the cache every 15 + minutes. User-managed keys can be added and removed at any time, so it + is important to update the cache frequently. For Google-managed keys, + Google will publish a key at least 6 hours before it is first used for + signing and will keep publishing it for at least 6 hours after it was + last used for signing. Public keys for all service accounts are also + published at the OAuth2 Service Account API. + type: object + properties: + name: + description: >- + The resource name of the service account key in the following format + `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. + type: string + privateKeyType: + description: >- + The output format for the private key. Only provided in + `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` + or `ListServiceAccountKey` responses. Google never exposes + system-managed private keys, and never retains user-managed private + keys. + type: string + enumDescriptions: + - Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`. + - >- + PKCS12 format. The password for the PKCS12 file is `notasecret`. + For more information, see https://tools.ietf.org/html/rfc7292. + - Google Credentials File format. + enum: + - TYPE_UNSPECIFIED + - TYPE_PKCS12_FILE + - TYPE_GOOGLE_CREDENTIALS_FILE + keyAlgorithm: + description: Specifies the algorithm (and possibly key size) for the key. + type: string + enumDescriptions: + - An unspecified key algorithm. + - 1k RSA Key. + - 2k RSA Key. + enum: + - KEY_ALG_UNSPECIFIED + - KEY_ALG_RSA_1024 + - KEY_ALG_RSA_2048 + privateKeyData: + description: >- + The private key data. Only provided in `CreateServiceAccountKey` + responses. Make sure to keep the private key data secure because it + allows for the assertion of the service account identity. When + base64 decoded, the private key data can be used to authenticate + with Google API client libraries and with gcloud auth + activate-service-account. + type: string + format: byte + publicKeyData: + description: >- + The public key data. Only provided in `GetServiceAccountKey` + responses. + type: string + format: byte + validAfterTime: + description: The key can be used after this timestamp. type: string format: google-datetime - deleteTime: + validBeforeTime: description: >- - Output only. The time when the `Policy` was deleted. Empty if the - policy is not deleted. - readOnly: true + The key can be used before this timestamp. For system-managed key + pairs, this timestamp is the end time for the private key signing + operation. The public key could still be used for verification for a + few hours after this time. type: string format: google-datetime - rules: + keyOrigin: + description: The key origin. + type: string + enumDescriptions: + - Unspecified key origin. + - Key is provided by user. + - Key is provided by Google. + enum: + - ORIGIN_UNSPECIFIED + - USER_PROVIDED + - GOOGLE_PROVIDED + keyType: + description: The key type. + type: string + enumDescriptions: + - >- + Unspecified key type. The presence of this in the message will + immediately result in an error. + - User-managed keys (managed and rotated by the user). + - System-managed keys (managed and rotated by Google). + enum: + - KEY_TYPE_UNSPECIFIED + - USER_MANAGED + - SYSTEM_MANAGED + disabled: + description: The key status. + type: boolean + disableReason: + description: >- + Output only. optional. If the key is disabled, it may have a + DisableReason describing why it was disabled. + readOnly: true + type: string + enumDescriptions: + - Unspecified disable reason + - Disabled by the user + - >- + Google detected this Service Account external key's private key + data as exposed, typically in a public repository on GitHub or + similar. + - >- + This service account external key was detected as compromised and + used by an attacker. + enum: + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_UNSPECIFIED + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_EXPOSED + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_COMPROMISE_DETECTED + extendedStatus: description: >- - A list of rules that specify the behavior of the `Policy`. All of - the rules should be of the `kind` specified in the `Policy`. + Output only. Extended Status provides permanent information about a + service account key. For example, if this key was detected as + exposed or compromised, that information will remain for the + lifetime of the key in the extended_status. + readOnly: true type: array items: - $ref: '#/components/schemas/GoogleIamV2PolicyRule' - GoogleIamV2PolicyRule: - id: GoogleIamV2PolicyRule - description: A single rule in a `Policy`. + $ref: '#/components/schemas/ExtendedStatus' + ExtendedStatus: + id: ExtendedStatus + description: >- + Extended status can store additional metadata. For example, for keys + disabled due to their private key data being expoesed we may include a + message with more information about the exposure. type: object properties: - denyRule: - description: A rule for a deny policy. - $ref: '#/components/schemas/GoogleIamV2DenyRule' - description: + key: + description: The key for this extended status. + type: string + enumDescriptions: + - Unspecified extended status, should not be used. + - >- + This key has been detected as exposed. extended_status_value may + contain information about the exposure (public GitHub repo, open + internet, etc.) + - >- + This key was implicated in a compromise or other attack. + extended_status_value may contain information about the abuse + perpetrated. + enum: + - SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_UNSPECIFIED + - SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_EXPOSED + - SERVICE_ACCOUNT_KEY_EXTENDED_STATUS_KEY_COMPROMISE_DETECTED + value: + description: The value for the extended status. + type: string + CreateServiceAccountKeyRequest: + id: CreateServiceAccountKeyRequest + description: The service account key create request. + type: object + properties: + privateKeyType: + description: >- + The output format of the private key. The default value is + `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File + format. + type: string + enumDescriptions: + - Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`. + - >- + PKCS12 format. The password for the PKCS12 file is `notasecret`. + For more information, see https://tools.ietf.org/html/rfc7292. + - Google Credentials File format. + enum: + - TYPE_UNSPECIFIED + - TYPE_PKCS12_FILE + - TYPE_GOOGLE_CREDENTIALS_FILE + keyAlgorithm: description: >- - A user-specified description of the rule. This value can be up to - 256 characters. + Which type of key and algorithm to use for the key. The default is + currently a 2K RSA key. However this may change in the future. type: string - GoogleIamV2DenyRule: - id: GoogleIamV2DenyRule - description: A deny rule in an IAM deny policy. + enumDescriptions: + - An unspecified key algorithm. + - 1k RSA Key. + - 2k RSA Key. + enum: + - KEY_ALG_UNSPECIFIED + - KEY_ALG_RSA_1024 + - KEY_ALG_RSA_2048 + UploadServiceAccountKeyRequest: + id: UploadServiceAccountKeyRequest + description: The service account key upload request. type: object properties: - deniedPrincipals: + publicKeyData: description: >- - The identities that are prevented from using one or more permissions - on Google Cloud resources. This field can contain the following - values: * `principal://goog/subject/{email_id}`: A specific Google - Account. Includes Gmail, Cloud Identity, and Google Workspace user - accounts. For example, `principal://goog/subject/alice@example.com`. - * - `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: - A Google Cloud service account. For example, - `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. - * `principalSet://goog/group/{group_id}`: A Google group. For - example, `principalSet://goog/group/admins@example.com`. * - `principalSet://goog/public:all`: A special identifier that - represents any principal that is on the internet, even if they do - not have a Google Account or are not logged in. * - `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of - the principals associated with the specified Google Workspace or - Cloud Identity customer ID. For example, - `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * + The public key to associate with the service account. Must be an RSA + public key that is wrapped in an X.509 v3 certificate. Include the + first line, `-----BEGIN CERTIFICATE-----`, and the last line, + `-----END CERTIFICATE-----`. + type: string + format: byte + DisableServiceAccountKeyRequest: + id: DisableServiceAccountKeyRequest + description: The service account key disable request. + type: object + properties: + serviceAccountKeyDisableReason: + description: >- + Optional. Describes the reason this key is being disabled. If + unspecified, the default value of + SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED will be used. + type: string + enumDescriptions: + - Unspecified disable reason + - Disabled by the user + - >- + Google detected this Service Account external key's private key + data as exposed, typically in a public repository on GitHub or + similar. + - >- + This service account external key was detected as compromised and + used by an attacker. + enum: + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_UNSPECIFIED + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_USER_INITIATED + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_EXPOSED + - SERVICE_ACCOUNT_KEY_DISABLE_REASON_COMPROMISE_DETECTED + extendedStatusMessage: + description: >- + Optional. Usable by internal google services only. An + extended_status_message can be used to include additional + information about the key, such as its private key data being + exposed on a public repository like GitHub. + type: string + EnableServiceAccountKeyRequest: + id: EnableServiceAccountKeyRequest + description: The service account key enable request. + type: object + properties: {} + SignBlobRequest: + id: SignBlobRequest + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + service account sign blob request. + type: object + properties: + bytesToSign: + description: >- + Required. Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + bytes to sign. + deprecated: true + type: string + format: byte + SignBlobResponse: + id: SignBlobResponse + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + service account sign blob response. + type: object + properties: + keyId: + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + id of the key used to sign the blob. + deprecated: true + type: string + signature: + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + signed blob. + deprecated: true + type: string + format: byte + SignJwtRequest: + id: SignJwtRequest + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + service account sign JWT request. + type: object + properties: + payload: + description: >- + Required. Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + JWT payload to sign. Must be a serialized JSON object that contains + a JWT Claims Set. For example: `{"sub": "user@example.com", "iat": + 313435}` If the JWT Claims Set contains an expiration time (`exp`) + claim, it must be an integer timestamp that is not in the past and + no more than 12 hours in the future. If the JWT Claims Set does not + contain an expiration time (`exp`) claim, this claim is added + automatically, with a timestamp that is 1 hour in the future. + deprecated: true + type: string + SignJwtResponse: + id: SignJwtResponse + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + service account sign JWT response. + type: object + properties: + keyId: + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + id of the key used to sign the JWT. + deprecated: true + type: string + signedJwt: + description: >- + Deprecated. [Migrate to Service Account Credentials + API](https://cloud.google.com/iam/help/credentials/migrate-api). The + signed JWT. + deprecated: true + type: string + Policy: + id: Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + properties: + version: + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + format: int32 + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + type: array + items: + $ref: '#/components/schemas/Binding' + auditConfigs: + description: Specifies cloud audit logging configuration for this policy. + type: array + items: + $ref: '#/components/schemas/AuditConfig' + etag: + description: >- + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + type: string + format: byte + Binding: + id: Binding + description: Associates `members`, or principals, with a `role`. + type: object + properties: + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + members: + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: @@ -263,72 +760,42 @@ components: * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * - `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific - Google Account that was deleted recently. For example, - `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. - If the Google Account is recovered, this identifier reverts to the - standard identifier for a Google Account. * - `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google - group that was deleted recently. For example, - `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. - If the Google group is restored, this identifier reverts to the - standard identifier for a Google group. * - `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: - A Google Cloud service account that was deleted recently. For - example, - `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. - If the service account is undeleted, this identifier reverts to the - standard identifier for a service account. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. type: array items: type: string - exceptionPrincipals: - description: >- - The identities that are excluded from the deny rule, even if they - are listed in the `denied_principals`. For example, you could add a - Google group to the `denied_principals`, then exclude specific users - who belong to that group. This field can contain the same values as - the `denied_principals` field, excluding - `principalSet://goog/public:all`, which represents all users on the - internet. - type: array - items: - type: string - deniedPermissions: - description: >- - The permissions that are explicitly denied by this rule. Each - permission uses the format `{service_fqdn}/{resource}.{verb}`, where - `{service_fqdn}` is the fully qualified domain name for the service. - For example, `iam.googleapis.com/roles.list`. - type: array - items: - type: string - exceptionPermissions: - description: >- - Specifies the permissions that this rule excludes from the set of - denied permissions given by `denied_permissions`. If a permission - appears in `denied_permissions` _and_ in `exception_permissions` - then it will _not_ be denied. The excluded permissions can be - specified using the same syntax as `denied_permissions`. - type: array - items: - type: string - denialCondition: + condition: description: >- - The condition that determines whether this deny rule applies to a - request. If the condition expression evaluates to `true`, then the - deny rule is applied; otherwise, the deny rule is not applied. Each - deny rule is evaluated independently. If this deny rule does not - apply to a request, other deny rules might still apply. The - condition can use CEL functions that evaluate [resource - tags](https://cloud.google.com/iam/help/conditions/resource-tags). - Other functions and operators are not supported. - $ref: '#/components/schemas/GoogleTypeExpr' - GoogleTypeExpr: - id: GoogleTypeExpr + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/Expr' + Expr: + id: Expr description: >- Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of @@ -369,204 +836,1793 @@ components: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. type: string - GoogleIamAdminV1AuditData: - id: GoogleIamAdminV1AuditData + AuditConfig: + id: AuditConfig description: >- - Audit log information specific to Cloud IAM admin APIs. This message is - serialized as an `Any` type in the `ServiceData` message of an - `AuditLog` message. + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. type: object properties: - permissionDelta: - description: The permission_delta when when creating or updating a Role. - $ref: '#/components/schemas/GoogleIamAdminV1AuditDataPermissionDelta' - GoogleIamAdminV1AuditDataPermissionDelta: - id: GoogleIamAdminV1AuditDataPermissionDelta + service: + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + type: string + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/AuditLogConfig' + AuditLogConfig: + id: AuditLogConfig description: >- - A PermissionDelta message to record the added_permissions and - removed_permissions inside a role. + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. type: object properties: - addedPermissions: - description: Added permissions. + logType: + description: The log type that this config enables. + type: string + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + exemptedMembers: + description: >- + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. type: array items: type: string - removedPermissions: - description: Removed permissions. + SetIamPolicyRequest: + id: SetIamPolicyRequest + description: Request message for `SetIamPolicy` method. + type: object + properties: + policy: + description: >- + REQUIRED: The complete policy to be applied to the `resource`. The + size of the policy is limited to a few 10s of KB. An empty policy is + a valid policy but certain Google Cloud services (such as Projects) + might reject them. + $ref: '#/components/schemas/Policy' + updateMask: + description: >- + OPTIONAL: A FieldMask specifying which fields of the policy to + modify. Only the fields in the mask will be modified. If no mask is + provided, the following default mask is used: `paths: "bindings, + etag"` + type: string + format: google-fieldmask + TestIamPermissionsRequest: + id: TestIamPermissionsRequest + description: Request message for `TestIamPermissions` method. + type: object + properties: + permissions: + description: >- + The set of permissions to check for the `resource`. Permissions with + wildcards (such as `*` or `storage.*`) are not allowed. For more + information see [IAM + Overview](https://cloud.google.com/iam/docs/overview#permissions). type: array items: type: string - GoogleIamV1LoggingAuditData: - id: GoogleIamV1LoggingAuditData - description: >- - Audit log information specific to Cloud IAM. This message is serialized - as an `Any` type in the `ServiceData` message of an `AuditLog` message. - type: object - properties: - policyDelta: - description: Policy delta between the original policy and the newly set policy. - $ref: '#/components/schemas/GoogleIamV1PolicyDelta' - GoogleIamV1PolicyDelta: - id: GoogleIamV1PolicyDelta - description: The difference delta between two policies. + TestIamPermissionsResponse: + id: TestIamPermissionsResponse + description: Response message for `TestIamPermissions` method. type: object properties: - bindingDeltas: - description: The delta for Bindings between two policies. + permissions: + description: >- + A subset of `TestPermissionsRequest.permissions` that the caller is + allowed. type: array items: - $ref: '#/components/schemas/GoogleIamV1BindingDelta' - GoogleIamV1BindingDelta: - id: GoogleIamV1BindingDelta - description: >- - One delta entry for Binding. Each individual change (only one member in - each entry) to a binding will be a separate entry. + type: string + QueryGrantableRolesRequest: + id: QueryGrantableRolesRequest + description: The grantable role query request. type: object properties: - action: - description: The action that was performed on a Binding. Required + fullResourceName: + description: >- + Required. The full resource name to query from the list of grantable + roles. The name follows the Google Cloud Platform resource format. + For example, a Cloud Platform project with id `my-project` will be + named `//cloudresourcemanager.googleapis.com/projects/my-project`. + type: string + view: type: string enumDescriptions: - - Unspecified. - - Addition of a Binding. - - Removal of a Binding. + - Omits the `included_permissions` field. This is the default value. + - Returns all fields. enum: - - ACTION_UNSPECIFIED - - ADD - - REMOVE - role: + - BASIC + - FULL + pageSize: description: >- - Role that is assigned to `members`. For example, `roles/viewer`, - `roles/editor`, or `roles/owner`. Required - type: string - member: + Optional limit on the number of roles to include in the response. + The default is 300, and the maximum is 2,000. + type: integer + format: int32 + pageToken: description: >- - A single identity requesting access for a Google Cloud resource. - Follows the same format of Binding.members. Required + Optional pagination token returned in an earlier + QueryGrantableRolesResponse. type: string - condition: - description: The condition that is associated with this binding. - $ref: '#/components/schemas/GoogleTypeExpr' - GoogleIamV2PolicyOperationMetadata: - id: GoogleIamV2PolicyOperationMetadata - description: Metadata for long-running `Policy` operations. + QueryGrantableRolesResponse: + id: QueryGrantableRolesResponse + description: The grantable role query response. type: object properties: - createTime: - description: Timestamp when the `google.longrunning.Operation` was created. + roles: + description: The list of matching roles. + type: array + items: + $ref: '#/components/schemas/Role' + nextPageToken: + description: >- + To retrieve the next page of results, set + `QueryGrantableRolesRequest.page_token` to this value. type: string - format: google-datetime - GoogleIamV1betaWorkloadIdentityPoolOperationMetadata: - id: GoogleIamV1betaWorkloadIdentityPoolOperationMetadata - description: Metadata for long-running WorkloadIdentityPool operations. - type: object - properties: {} - GoogleCloudCommonOperationMetadata: - id: GoogleCloudCommonOperationMetadata - description: Represents the metadata of the long-running operation. + Role: + id: Role + description: A role in the Identity and Access Management API. type: object properties: - createTime: - description: Output only. The time the operation was created. - readOnly: true + name: + description: >- + The name of the role. When `Role` is used in `CreateRole`, the role + name must not be set. When `Role` is used in output and other input + such as `UpdateRole`, the role name is the complete path. For + example, `roles/logging.viewer` for predefined roles, + `organizations/{ORGANIZATION_ID}/roles/myRole` for + organization-level custom roles, and + `projects/{PROJECT_ID}/roles/myRole` for project-level custom roles. type: string - format: google-datetime - endTime: - description: Output only. The time the operation finished running. - readOnly: true + title: + description: >- + Optional. A human-readable title for the role. Typically this is + limited to 100 UTF-8 bytes. type: string - format: google-datetime - target: + description: + description: Optional. A human-readable description for the role. + type: string + includedPermissions: description: >- - Output only. Server-defined resource path for the target of the - operation. - readOnly: true + The names of the permissions this role grants when bound in an IAM + policy. + type: array + items: + type: string + stage: + description: >- + The current launch stage of the role. If the `ALPHA` launch stage + has been selected for a role, the `stage` field will not be included + in the returned definition for the role. type: string - verb: - description: Output only. Name of the verb executed by the operation. + enumDescriptions: + - >- + The user has indicated this role is currently in an Alpha phase. + If this launch stage is selected, the `stage` field will not be + included when requesting the definition for a given role. + - The user has indicated this role is currently in a Beta phase. + - The user has indicated this role is generally available. + - The user has indicated this role is being deprecated. + - >- + This role is disabled and will not contribute permissions to any + principals it is granted to in policies. + - The user has indicated this role is currently in an EAP phase. + enum: + - ALPHA + - BETA + - GA + - DEPRECATED + - DISABLED + - EAP + etag: + description: Used to perform a consistent read-modify-write. + type: string + format: byte + deleted: + description: >- + The current deleted state of the role. This field is read only. It + will be ignored in calls to CreateRole and UpdateRole. + type: boolean + ListRolesResponse: + id: ListRolesResponse + description: The response containing the roles defined under a resource. + type: object + properties: + roles: + description: The Roles defined on this resource. + type: array + items: + $ref: '#/components/schemas/Role' + nextPageToken: + description: >- + To retrieve the next page of results, set + `ListRolesRequest.page_token` to this value. + type: string + CreateRoleRequest: + id: CreateRoleRequest + description: The request to create a new role. + type: object + properties: + roleId: + description: >- + The role ID to use for this role. A role ID may contain alphanumeric + characters, underscores (`_`), and periods (`.`). It must contain a + minimum of 3 characters and a maximum of 64 characters. + type: string + role: + description: The Role resource to create. + $ref: '#/components/schemas/Role' + UndeleteRoleRequest: + id: UndeleteRoleRequest + description: The request to undelete an existing role. + type: object + properties: + etag: + description: Used to perform a consistent read-modify-write. + type: string + format: byte + QueryTestablePermissionsRequest: + id: QueryTestablePermissionsRequest + description: A request to get permissions which can be tested on a resource. + type: object + properties: + fullResourceName: + description: >- + Required. The full resource name to query from the list of testable + permissions. The name follows the Google Cloud Platform resource + format. For example, a Cloud Platform project with id `my-project` + will be named + `//cloudresourcemanager.googleapis.com/projects/my-project`. + type: string + pageSize: + description: >- + Optional limit on the number of permissions to include in the + response. The default is 100, and the maximum is 1,000. + type: integer + format: int32 + pageToken: + description: >- + Optional pagination token returned in an earlier + QueryTestablePermissionsRequest. + type: string + QueryTestablePermissionsResponse: + id: QueryTestablePermissionsResponse + description: The response containing permissions which can be tested on a resource. + type: object + properties: + permissions: + description: The Permissions testable on the requested resource. + type: array + items: + $ref: '#/components/schemas/Permission' + nextPageToken: + description: >- + To retrieve the next page of results, set + `QueryTestableRolesRequest.page_token` to this value. + type: string + Permission: + id: Permission + description: A permission which can be included by a role. + type: object + properties: + name: + description: The name of this Permission. + type: string + title: + description: The title of this Permission. + type: string + description: + description: >- + A brief description of what this Permission is used for. This + permission can ONLY be used in predefined roles. + type: string + onlyInPredefinedRoles: + deprecated: true + type: boolean + stage: + description: The current launch stage of the permission. + type: string + enumDescriptions: + - The permission is currently in an alpha phase. + - The permission is currently in a beta phase. + - The permission is generally available. + - The permission is being deprecated. + enum: + - ALPHA + - BETA + - GA + - DEPRECATED + customRolesSupportLevel: + description: The current custom role support level. + type: string + enumDescriptions: + - Default state. Permission is fully supported for custom role use. + - Permission is being tested to check custom role compatibility. + - Permission is not supported for custom role use. + enum: + - SUPPORTED + - TESTING + - NOT_SUPPORTED + apiDisabled: + description: The service API associated with the permission is not enabled. + type: boolean + primaryPermission: + description: >- + The preferred name for this permission. If present, then this + permission is an alias of, and equivalent to, the listed + primary_permission. + type: string + QueryAuditableServicesRequest: + id: QueryAuditableServicesRequest + description: A request to get the list of auditable services for a resource. + type: object + properties: + fullResourceName: + description: >- + Required. The full resource name to query from the list of auditable + services. The name follows the Google Cloud Platform resource + format. For example, a Cloud Platform project with id `my-project` + will be named + `//cloudresourcemanager.googleapis.com/projects/my-project`. + type: string + QueryAuditableServicesResponse: + id: QueryAuditableServicesResponse + description: A response containing a list of auditable services for a resource. + type: object + properties: + services: + description: The auditable services for a resource. + type: array + items: + $ref: '#/components/schemas/AuditableService' + AuditableService: + id: AuditableService + description: Contains information about an auditable service. + type: object + properties: + name: + description: >- + Public name of the service. For example, the service name for IAM is + 'iam.googleapis.com'. + type: string + LintPolicyRequest: + id: LintPolicyRequest + description: The request to lint an IAM policy object. + type: object + properties: + fullResourceName: + description: >- + The full resource name of the policy this lint request is about. The + name follows the Google Cloud format for full resource names. For + example, a Google Cloud project with ID `my-project` will be named + `//cloudresourcemanager.googleapis.com/projects/my-project`. The + resource name is not used to read a policy from IAM. Only the data + in the request object is linted. + type: string + condition: + description: google.iam.v1.Binding.condition object to be linted. + $ref: '#/components/schemas/Expr' + LintPolicyResponse: + id: LintPolicyResponse + description: >- + The response of a lint operation. An empty response indicates the + operation was able to fully execute and no lint issue was found. + type: object + properties: + lintResults: + description: List of lint results sorted by `severity` in descending order. + type: array + items: + $ref: '#/components/schemas/LintResult' + LintResult: + id: LintResult + description: Structured response of a single validation unit. + type: object + properties: + level: + description: The validation unit level. + type: string + enumDescriptions: + - Level is unspecified. + - >- + A validation unit which operates on an individual condition within + a binding. + enum: + - LEVEL_UNSPECIFIED + - CONDITION + validationUnitName: + description: >- + The validation unit name, for instance + "lintValidationUnits/ConditionComplexityCheck". + type: string + severity: + description: The validation unit severity. + type: string + enumDescriptions: + - Severity is unspecified. + - >- + A validation unit returns an error only for critical issues. If an + attempt is made to set the problematic policy without rectifying + the critical issue, it causes the `setPolicy` operation to fail. + - >- + Any issue which is severe enough but does not cause an error. For + example, suspicious constructs in the input object will not + necessarily fail `setPolicy`, but there is a high likelihood that + they won't behave as expected during policy evaluation in + `checkPolicy`. This includes the following common scenarios: - + Unsatisfiable condition: Expired timestamp in date/time condition. + - Ineffective condition: Condition on a pair which is granted + unconditionally in another binding of the same policy. + - >- + Reserved for the issues that are not severe as `ERROR`/`WARNING`, + but need special handling. For instance, messages about skipped + validation units are issued as `NOTICE`. + - >- + Any informative statement which is not severe enough to raise + `ERROR`/`WARNING`/`NOTICE`, like auto-correction recommendations + on the input content. Note that current version of the linter does + not utilize `INFO`. + - Deprecated severity level. + enum: + - SEVERITY_UNSPECIFIED + - ERROR + - WARNING + - NOTICE + - INFO + - DEPRECATED + fieldName: + description: >- + The name of the field for which this lint result is about. For + nested messages `field_name` consists of names of the embedded + fields separated by period character. The top-level qualifier is the + input object to lint in the request. For example, the `field_name` + value `condition.expression` identifies a lint result for the + `expression` field of the provided condition. + type: string + locationOffset: + description: >- + 0-based character position of problematic construct within the + object identified by `field_name`. Currently, this is populated only + for condition expression. + type: integer + format: int32 + debugMessage: + description: Human readable debug message associated with the issue. + type: string + ListOauthClientsResponse: + id: ListOauthClientsResponse + description: Response message for ListOauthClients. + type: object + properties: + oauthClients: + description: A list of OauthClients. + type: array + items: + $ref: '#/components/schemas/OauthClient' + nextPageToken: + description: >- + Optional. A token, which can be sent as `page_token` to retrieve the + next page. If this field is omitted, there are no subsequent pages. + type: string + OauthClient: + id: OauthClient + description: >- + Represents an OauthClient. Used to access Google Cloud resources on + behalf of a Workforce Identity Federation user by using OAuth 2.0 + Protocol to obtain an access token from Google Cloud. + type: object + properties: + name: + description: >- + Immutable. The resource name of the OauthClient. + Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`. + type: string + state: + description: Output only. The state of the OauthClient. readOnly: true type: string - statusDetail: - description: Output only. Human-readable status of the operation, if any. + enumDescriptions: + - Default value. This value is unused. + - The OauthClient is active. + - >- + The OauthClient is soft-deleted. Soft-deleted OauthClient is + permanently deleted after approximately 30 days unless restored + via `UndeleteOauthClient`. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + disabled: + description: >- + Optional. Whether the OauthClient is disabled. You cannot use a + disabled OAuth client. + type: boolean + clientId: + description: Output only. The system-generated OauthClient id. readOnly: true type: string - cancelRequested: + displayName: description: >- - Output only. Identifies whether the user has requested cancellation - of the operation. Operations that have been cancelled successfully - have Operation.error value with a google.rpc.Status.code of 1, - corresponding to `Code.CANCELLED`. + Optional. A user-specified display name of the OauthClient. Cannot + exceed 32 characters. + type: string + description: + description: >- + Optional. A user-specified description of the OauthClient. Cannot + exceed 256 characters. + type: string + clientType: + description: >- + Immutable. The type of OauthClient. Either public or private. For + private clients, the client secret can be managed using the + dedicated OauthClientCredential resource. + type: string + enumDescriptions: + - Should not be used. + - Public client has no secret. + - Private client. + enum: + - CLIENT_TYPE_UNSPECIFIED + - PUBLIC_CLIENT + - CONFIDENTIAL_CLIENT + allowedGrantTypes: + description: >- + Required. The list of OAuth grant types is allowed for the + OauthClient. + type: array + items: + type: string + enumDescriptions: + - Should not be used. + - Authorization code grant. + - Refresh token grant. + enum: + - GRANT_TYPE_UNSPECIFIED + - AUTHORIZATION_CODE_GRANT + - REFRESH_TOKEN_GRANT + allowedScopes: + description: >- + Required. The list of scopes that the OauthClient is allowed to + request during OAuth flows. The following scopes are supported: * + `https://www.googleapis.com/auth/cloud-platform`: See, edit, + configure, and delete your Google Cloud data and see the email + address for your Google Account. + type: array + items: + type: string + allowedRedirectUris: + description: >- + Required. The list of redirect uris that is allowed to redirect back + when authorization process is completed. + type: array + items: + type: string + expireTime: + description: >- + Output only. Time after which the OauthClient will be permanently + purged and cannot be recovered. readOnly: true + type: string + format: google-datetime + UndeleteOauthClientRequest: + id: UndeleteOauthClientRequest + description: Request message for UndeleteOauthClient. + type: object + properties: {} + ListOauthClientCredentialsResponse: + id: ListOauthClientCredentialsResponse + description: Response message for ListOauthClientCredentials. + type: object + properties: + oauthClientCredentials: + description: A list of OauthClientCredentials. + type: array + items: + $ref: '#/components/schemas/OauthClientCredential' + OauthClientCredential: + id: OauthClientCredential + description: >- + Represents an OauthClientCredential. Used to authenticate an OauthClient + while accessing Google Cloud resources on behalf of a user by using + OAuth 2.0 Protocol. + type: object + properties: + name: + description: >- + Immutable. The resource name of the OauthClientCredential. Format: + `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}` + type: string + disabled: + description: >- + Optional. Whether the OauthClientCredential is disabled. You cannot + use a disabled OauthClientCredential. type: boolean - apiVersion: - description: Output only. API version used to start the operation. + clientSecret: + description: >- + Output only. The system-generated OAuth client secret. The client + secret must be stored securely. If the client secret is leaked, you + must delete and re-create the client credential. To learn more, see + [OAuth client and credential security risks and + mitigations](https://cloud.google.com/iam/docs/workforce-oauth-app#security) readOnly: true type: string - CloudControl2SharedOperationsReconciliationOperationMetadata: - id: CloudControl2SharedOperationsReconciliationOperationMetadata + displayName: + description: >- + Optional. A user-specified display name of the + OauthClientCredential. Cannot exceed 32 characters. + type: string + ListWorkforcePoolsResponse: + id: ListWorkforcePoolsResponse + description: Response message for ListWorkforcePools. + type: object + properties: + workforcePools: + description: A list of pools. + type: array + items: + $ref: '#/components/schemas/WorkforcePool' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkforcePool: + id: WorkforcePool description: >- - Operation metadata returned by the CLH during resource state - reconciliation. + Represents a collection of external workforces. Provides namespaces for + federated users that can be referenced in IAM policies. type: object properties: - deleteResource: - description: DEPRECATED. Use exclusive_action instead. - deprecated: true - type: boolean - exclusiveAction: - description: Excluisive action returned by the CLH. + name: + description: >- + Output only. The resource name of the pool. Format: + `locations/{location}/workforcePools/{workforce_pool_id}` + readOnly: true + type: string + parent: + description: >- + Immutable. The resource name of the parent. Format: + `organizations/{org-id}`. + type: string + displayName: + description: >- + A user-specified display name of the pool in Google Cloud Console. + Cannot exceed 32 characters. + type: string + description: + description: >- + A user-specified description of the pool. Cannot exceed 256 + characters. + type: string + state: + description: Output only. The state of the pool. + readOnly: true type: string enumDescriptions: - - Unknown repair action. - - >- - The resource has to be deleted. When using this bit, the CLH - should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE - OperationSignal in SideChannel. + - State unspecified. + - The pool is active and may be used in Google Cloud policies. - >- - This resource could not be repaired but the repair should be tried - again at a later time. This can happen if there is a dependency - that needs to be resolved first- e.g. if a parent resource must be - repaired before a child resource. - enumDeprecated: - - false - - true - - false + The pool is soft-deleted. Soft-deleted pools are permanently + deleted after approximately 30 days. You can restore a + soft-deleted pool using UndeleteWorkforcePool. You cannot reuse + the ID of a soft-deleted pool until it is permanently deleted. + While a pool is deleted, you cannot use it to exchange tokens, or + use existing tokens to access resources. If the pool is undeleted, + existing tokens grant access again. enum: - - UNKNOWN_REPAIR_ACTION - - DELETE - - RETRY - parameters: - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - key: - description: >- + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + disabled: + description: >- + Disables the workforce pool. You cannot use a disabled pool to + exchange tokens, or use existing tokens to access resources. If the + pool is re-enabled, existing tokens grant access again. + type: boolean + sessionDuration: + description: >- + Duration that the Google Cloud access tokens, console sign-in + sessions, and `gcloud` sign-in sessions from this pool are valid. + Must be greater than 15 minutes (900s) and less than 12 hours + (43200s). If `session_duration` is not configured, minted + credentials have a default duration of one hour (3600s). For SAML + providers, the lifetime of the token is the minimum of the + `session_duration` and the `SessionNotOnOrAfter` claim in the SAML + assertion. + type: string + format: google-duration + expireTime: + description: >- + Output only. Time after which the workforce pool will be permanently + purged and cannot be recovered. + readOnly: true + type: string + format: google-datetime + accessRestrictions: + description: >- + Optional. Configure access restrictions on the workforce pool users. + This is an optional field. If specified web sign-in can be + restricted to given set of services or programmatic sign-in can be + disabled for pool users. + $ref: '#/components/schemas/AccessRestrictions' + AccessRestrictions: + id: AccessRestrictions + description: Access related restrictions on the workforce pool. + type: object + properties: + allowedServices: + description: >- + Optional. Immutable. Services allowed for web sign-in with the + workforce pool. If not set by default there are no restrictions. + type: array + items: + $ref: '#/components/schemas/ServiceConfig' + disableProgrammaticSignin: + description: >- + Optional. Disable programmatic sign-in by disabling token issue via + the Security Token API endpoint. See [Security Token Service API] + (https://cloud.google.com/iam/docs/reference/sts/rest). + type: boolean + ServiceConfig: + id: ServiceConfig + description: Configuration for a service. + type: object + properties: + domain: + description: 'Optional. Domain name of the service. Example: console.cloud.google' + type: string + UndeleteWorkforcePoolRequest: + id: UndeleteWorkforcePoolRequest + description: Request message for UndeleteWorkforcePool. + type: object + properties: {} + GetIamPolicyRequest: + id: GetIamPolicyRequest + description: Request message for `GetIamPolicy` method. + type: object + properties: + options: + description: >- + OPTIONAL: A `GetPolicyOptions` object for specifying options to + `GetIamPolicy`. + $ref: '#/components/schemas/GetPolicyOptions' + GetPolicyOptions: + id: GetPolicyOptions + description: Encapsulates settings provided to GetIamPolicy. + type: object + properties: + requestedPolicyVersion: + description: >- + Optional. The maximum policy version that will be used to format the + policy. Valid values are 0, 1, and 3. Requests specifying an invalid + value will be rejected. Requests for policies with any conditional + role bindings must specify version 3. Policies with no conditional + role bindings may specify any valid value or leave the field unset. + The policy in the response might use the policy version that you + specified, or it might use a lower policy version. For example, if + you specify version 3, but the policy has no conditional role + bindings, the response uses version 1. To learn which resources + support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + type: integer + format: int32 + ListWorkforcePoolProvidersResponse: + id: ListWorkforcePoolProvidersResponse + description: Response message for ListWorkforcePoolProviders. + type: object + properties: + workforcePoolProviders: + description: A list of providers. + type: array + items: + $ref: '#/components/schemas/WorkforcePoolProvider' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkforcePoolProvider: + id: WorkforcePoolProvider + description: A configuration for an external identity provider. + type: object + properties: + name: + description: >- + Output only. The resource name of the provider. Format: + `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}` + readOnly: true + type: string + displayName: + description: >- + A user-specified display name for the provider. Cannot exceed 32 + characters. + type: string + description: + description: >- + A user-specified description of the provider. Cannot exceed 256 + characters. + type: string + state: + description: Output only. The state of the provider. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - >- + The provider is active and may be used to validate authentication + credentials. + - >- + The provider is soft-deleted. Soft-deleted providers are + permanently deleted after approximately 30 days. You can restore a + soft-deleted provider using UndeleteWorkforcePoolProvider. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + disabled: + description: >- + Disables the workforce pool provider. You cannot use a disabled + provider to exchange tokens. However, existing tokens still grant + access. + type: boolean + attributeMapping: + description: >- + Required. Maps attributes from the authentication credentials issued + by an external identity provider to Google Cloud attributes, such as + `subject` and `segment`. Each key must be a string specifying the + Google Cloud IAM attribute to map to. The following keys are + supported: * `google.subject`: The principal IAM is authenticating. + You can reference this value in IAM bindings. This is also the + subject that appears in Cloud Logging logs. This is a required field + and the mapped subject cannot exceed 127 bytes. * `google.groups`: + Groups the authenticating user belongs to. You can grant groups + access to resources using an IAM `principalSet` binding; access + applies to all members of the group. * `google.display_name`: The + name of the authenticated user. This is an optional field and the + mapped display name cannot exceed 100 bytes. If not set, + `google.subject` will be displayed instead. This attribute cannot be + referenced in IAM bindings. * `google.profile_photo`: The URL that + specifies the authenticated user's thumbnail photo. This is an + optional field. When set, the image will be visible as the user's + profile picture. If not set, a generic user icon will be displayed + instead. This attribute cannot be referenced in IAM bindings. * + `google.posix_username`: The Linux username used by OS Login. This + is an optional field and the mapped POSIX username cannot exceed 32 + characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This + attribute cannot be referenced in IAM bindings. You can also provide + custom attributes by specifying `attribute.{custom_attribute}`, + where {custom_attribute} is the name of the custom attribute to be + mapped. You can define a maximum of 50 custom attributes. The + maximum length of a mapped attribute key is 100 characters, and the + key may only contain the characters [a-z0-9_]. You can reference + these attributes in IAM policies to define fine-grained access for a + workforce pool to Google Cloud resources. For example: * + `google.subject`: + `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` + * `google.groups`: + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` + * `attribute.{custom_attribute}`: + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` + Each value must be a [Common Expression Language] + (https://opensource.google/projects/cel) function that maps an + identity provider credential to the normalized attribute specified + by the corresponding map key. You can use the `assertion` keyword in + the expression to access a JSON representation of the authentication + credential issued by the provider. The maximum length of an + attribute mapping expression is 2048 characters. When evaluated, the + total size of all mapped attributes must not exceed 4KB. For OIDC + providers, you must supply a custom mapping that includes the + `google.subject` attribute. For example, the following maps the + `sub` claim of the incoming credential to the `subject` attribute on + a Google token: ``` {"google.subject": "assertion.sub"} ``` + type: object + additionalProperties: + type: string + attributeCondition: + description: >- + A [Common Expression + Language](https://opensource.google/projects/cel) expression, in + plain text, to restrict what otherwise valid authentication + credentials issued by the provider should not be accepted. The + expression must output a boolean representing whether to allow the + federation. The following keywords may be referenced in the + expressions: * `assertion`: JSON representing the authentication + credential issued by the provider. * `google`: The Google attributes + mapped from the assertion in the `attribute_mappings`. + `google.profile_photo`, `google.display_name` and + `google.posix_username` are not supported. * `attribute`: The custom + attributes mapped from the assertion in the `attribute_mappings`. + The maximum length of the attribute condition expression is 4096 + characters. If unspecified, all valid authentication credentials + will be accepted. The following example shows how to only allow + credentials with a mapped `google.groups` value of `admins`: ``` + "'admins' in google.groups" ``` + type: string + saml: + description: A SAML identity provider configuration. + $ref: '#/components/schemas/GoogleIamAdminV1WorkforcePoolProviderSaml' + oidc: + description: An OpenId Connect 1.0 identity provider configuration. + $ref: '#/components/schemas/GoogleIamAdminV1WorkforcePoolProviderOidc' + expireTime: + description: >- + Output only. Time after which the workload pool provider will be + permanently purged and cannot be recovered. + readOnly: true + type: string + format: google-datetime + extraAttributesOauth2Client: + description: >- + Optional. The configuration for OAuth 2.0 client used to get the + additional user attributes. This should be used when users can't get + the desired claims in authentication credentials. Currently this + configuration is only supported with OIDC protocol. + $ref: >- + #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client + GoogleIamAdminV1WorkforcePoolProviderSaml: + id: GoogleIamAdminV1WorkforcePoolProviderSaml + description: Represents a SAML identity provider. + type: object + properties: + idpMetadataXml: + description: >- + Required. SAML Identity provider configuration metadata xml doc. The + xml document should comply with [SAML 2.0 + specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). + The max size of the acceptable xml document will be bounded to 128k + characters. The metadata xml document should satisfy the following + constraints: 1) Must contain an Identity Provider Entity ID. 2) Must + contain at least one non-expired signing key certificate. 3) For + each signing key: a) Valid from should be no more than 7 days from + now. b) Valid to should be no more than 20 years in the future. 4) + Up to 3 IdP signing keys are allowed in the metadata xml. When + updating the provider's metadata xml, at least one non-expired + signing key must overlap with the existing metadata. This + requirement is skipped if there are no non-expired signing keys + present in the existing metadata. + type: string + GoogleIamAdminV1WorkforcePoolProviderOidc: + id: GoogleIamAdminV1WorkforcePoolProviderOidc + description: Represents an OpenId Connect 1.0 identity provider. + type: object + properties: + issuerUri: + description: >- + Required. The OIDC issuer URI. Must be a valid URI using the `https` + scheme. + type: string + clientId: + description: >- + Required. The client ID. Must match the audience claim of the JWT + issued by the identity provider. + type: string + clientSecret: + description: >- + The optional client secret. Required to enable Authorization Code + flow for web sign-in. + $ref: >- + #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret + webSsoConfig: + description: >- + Required. Configuration for web single sign-on for the OIDC + provider. Here, web sign-in refers to console sign-in and gcloud + sign-in through the browser. + $ref: >- + #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig + jwksJson: + description: >- + OIDC JWKs in JSON String format. For details on the definition of a + JWK, see https://tools.ietf.org/html/rfc7517. If not set, the + `jwks_uri` from the discovery document(fetched from the .well-known + path of the `issuer_uri`) will be used. Currently, RSA and EC + asymmetric keys are supported. The JWK must use following format and + include only the following fields: { "keys": [ { "kty": "RSA/EC", + "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": "", "y": + "", "crv": "" } ] } + type: string + GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret: + id: GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret + description: Representation of a client secret configured for the OIDC provider. + type: object + properties: + value: + description: The value of the client secret. + $ref: >- + #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue + GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue: + id: GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue + description: Representation of the value of the client secret. + type: object + properties: + plainText: + description: >- + Input only. The plain text of the client secret value. For security + reasons, this field is only used for input and will never be + populated in any response. + type: string + thumbprint: + description: >- + Output only. A thumbprint to represent the current client secret + value. + readOnly: true + type: string + GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig: + id: GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig + description: Configuration for web single sign-on for the OIDC provider. + type: object + properties: + responseType: + description: >- + Required. The Response Type to request for in the OIDC Authorization + Request for web sign-in. The `CODE` Response Type is recommended to + avoid the Implicit Flow, for security reasons. + type: string + enumDescriptions: + - No Response Type specified. + - >- + The `response_type=code` selection uses the Authorization Code + Flow for web sign-in. Requires a configured client secret. + - >- + The `response_type=id_token` selection uses the Implicit Flow for + web sign-in. + enum: + - RESPONSE_TYPE_UNSPECIFIED + - CODE + - ID_TOKEN + assertionClaimsBehavior: + description: >- + Required. The behavior for how OIDC Claims are included in the + `assertion` object used for attribute mapping and attribute + condition. + type: string + enumDescriptions: + - No assertion claims behavior specified. + - >- + Merge the UserInfo Endpoint Claims with ID Token Claims, + preferring UserInfo Claim Values for the same Claim Name. This + option is available only for the Authorization Code Flow. + - Only include ID Token Claims. + enum: + - ASSERTION_CLAIMS_BEHAVIOR_UNSPECIFIED + - MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS + - ONLY_ID_TOKEN_CLAIMS + additionalScopes: + description: >- + Additional scopes to request for in the OIDC authentication request + on top of scopes requested by default. By default, the `openid`, + `profile` and `email` scopes that are supported by the identity + provider are requested. Each additional scope may be at most 256 + characters. A maximum of 10 additional scopes may be configured. + type: array + items: + type: string + GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client: + id: GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client + description: >- + Represents the OAuth 2.0 client credential configuration for retrieving + additional user attributes that are not present in the initial + authentication credentials from the identity provider, e.g. groups. See + https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more + details on client credentials grant flow. + type: object + properties: + issuerUri: + description: >- + Required. The OIDC identity provider's issuer URI. Must be a valid + URI using the `https` scheme. Required to get the OIDC discovery + document. + type: string + clientId: + description: >- + Required. The OAuth 2.0 client ID for retrieving extra attributes + from the identity provider. Required to get the Access Token using + client credentials grant flow. + type: string + clientSecret: + description: >- + Required. The OAuth 2.0 client secret for retrieving extra + attributes from the identity provider. Required to get the Access + Token using client credentials grant flow. + $ref: >- + #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret + attributesType: + description: >- + Required. Represents the IdP and type of claims that should be + fetched. + type: string + enumDescriptions: + - No AttributesType specified. + - >- + Used to get the user's group claims from the Azure AD identity + provider using configuration provided in + ExtraAttributesOAuth2Client and `mail` property of the + `microsoft.graph.group` object is used for claim mapping. See + https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties + for more details on `microsoft.graph.group` properties. The + attributes obtained from idntity provider are mapped to + `assertion.groups`. + enum: + - ATTRIBUTES_TYPE_UNSPECIFIED + - AZURE_AD_GROUPS_MAIL + queryParameters: + description: >- + Optional. Represents the parameters to control which claims are + fetched from an IdP. + $ref: >- + #/components/schemas/GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters + GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters: + id: >- + GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters + description: >- + Represents the parameters to control which claims are fetched from an + IdP. + type: object + properties: + filter: + description: >- + Optional. The filter used to request specific records from IdP. In + case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the + filter used to request specific groups for users from IdP. By + default, all of the groups associated with the user are fetched. The + groups should be mail enabled and security enabled. See + https://learn.microsoft.com/en-us/graph/search-query-parameter for + more details. + type: string + UndeleteWorkforcePoolProviderRequest: + id: UndeleteWorkforcePoolProviderRequest + description: Request message for UndeleteWorkforcePoolProvider. + type: object + properties: {} + ListWorkforcePoolProviderKeysResponse: + id: ListWorkforcePoolProviderKeysResponse + description: Response message for ListWorkforcePoolProviderKeys. + type: object + properties: + workforcePoolProviderKeys: + description: A list of WorkforcePoolProviderKeys. + type: array + items: + $ref: '#/components/schemas/WorkforcePoolProviderKey' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkforcePoolProviderKey: + id: WorkforcePoolProviderKey + description: >- + Represents a public key configuration for a Workforce Pool Provider. The + key can be configured in your identity provider to encrypt SAML + assertions. Google holds the corresponding private key, which it uses to + decrypt encrypted tokens. + type: object + properties: + name: + description: Output only. The resource name of the key. + readOnly: true + type: string + keyData: + description: Immutable. Public half of the asymmetric key. + $ref: '#/components/schemas/KeyData' + state: + description: Output only. The state of the key. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - The key is active. + - >- + The key is soft-deleted. Soft-deleted keys are permanently deleted + after approximately 30 days. You can restore a soft-deleted key + using UndeleteWorkforcePoolProviderKey. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + use: + description: Required. The purpose of the key. + type: string + enumDescriptions: + - KeyUse unspecified. + - The key is used for encryption. + enum: + - KEY_USE_UNSPECIFIED + - ENCRYPTION + expireTime: + description: >- + Output only. The time after which the key will be permanently + deleted and cannot be recovered. Note that the key may get purged + before this time if the total limit of keys per provider is + exceeded. + readOnly: true + type: string + format: google-datetime + KeyData: + id: KeyData + description: Represents a public key data along with its format. + type: object + properties: + format: + description: Output only. The format of the key. + readOnly: true + type: string + enumDescriptions: + - >- + No format has been specified. This is an invalid format and must + not be used. + - >- + A RSA public key wrapped in an X.509v3 certificate ([RFC5280] ( + https://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and + wrapped in [public certificate + label](https://datatracker.ietf.org/doc/html/rfc7468#section-5.1). + enum: + - KEY_FORMAT_UNSPECIFIED + - RSA_X509_PEM + notBeforeTime: + description: >- + Output only. Earliest timestamp when this key is valid. Attempts to + use this key before this time will fail. Only present if the key + data represents a X.509 certificate. + readOnly: true + type: string + format: google-datetime + notAfterTime: + description: >- + Output only. Latest timestamp when this key is valid. Attempts to + use this key after this time will fail. Only present if the key data + represents a X.509 certificate. + readOnly: true + type: string + format: google-datetime + key: + description: >- + Output only. The key data. The format of the key is represented by + the format field. + readOnly: true + type: string + keySpec: + description: Required. The specifications for the key. + type: string + enumDescriptions: + - No key specification specified. + - A 2048 bit RSA key. + - A 3072 bit RSA key. + - A 4096 bit RSA key. + enum: + - KEY_SPEC_UNSPECIFIED + - RSA_2048 + - RSA_3072 + - RSA_4096 + UndeleteWorkforcePoolProviderKeyRequest: + id: UndeleteWorkforcePoolProviderKeyRequest + description: Request message for UndeleteWorkforcePoolProviderKey. + type: object + properties: {} + UndeleteWorkforcePoolSubjectRequest: + id: UndeleteWorkforcePoolSubjectRequest + description: Request message for UndeleteWorkforcePoolSubject. + type: object + properties: {} + ListWorkloadIdentityPoolsResponse: + id: ListWorkloadIdentityPoolsResponse + description: Response message for ListWorkloadIdentityPools. + type: object + properties: + workloadIdentityPools: + description: A list of pools. + type: array + items: + $ref: '#/components/schemas/WorkloadIdentityPool' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkloadIdentityPool: + id: WorkloadIdentityPool + description: >- + Represents a collection of workload identities. You can define IAM + policies to grant these identities access to Google Cloud resources. + type: object + properties: + name: + description: Output only. The resource name of the pool. + readOnly: true + type: string + displayName: + description: A display name for the pool. Cannot exceed 32 characters. + type: string + description: + description: A description of the pool. Cannot exceed 256 characters. + type: string + state: + description: Output only. The state of the pool. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - The pool is active, and may be used in Google Cloud policies. + - >- + The pool is soft-deleted. Soft-deleted pools are permanently + deleted after approximately 30 days. You can restore a + soft-deleted pool using UndeleteWorkloadIdentityPool. You cannot + reuse the ID of a soft-deleted pool until it is permanently + deleted. While a pool is deleted, you cannot use it to exchange + tokens, or use existing tokens to access resources. If the pool is + undeleted, existing tokens grant access again. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + disabled: + description: >- + Whether the pool is disabled. You cannot use a disabled pool to + exchange tokens, or use existing tokens to access resources. If the + pool is re-enabled, existing tokens grant access again. + type: boolean + expireTime: + description: >- + Output only. Time after which the workload identity pool will be + permanently purged and cannot be recovered. + readOnly: true + type: string + format: google-datetime + UndeleteWorkloadIdentityPoolRequest: + id: UndeleteWorkloadIdentityPoolRequest + description: Request message for UndeleteWorkloadIdentityPool. + type: object + properties: {} + ListWorkloadIdentityPoolProvidersResponse: + id: ListWorkloadIdentityPoolProvidersResponse + description: Response message for ListWorkloadIdentityPoolProviders. + type: object + properties: + workloadIdentityPoolProviders: + description: A list of providers. + type: array + items: + $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkloadIdentityPoolProvider: + id: WorkloadIdentityPoolProvider + description: A configuration for an external identity provider. + type: object + properties: + name: + description: Output only. The resource name of the provider. + readOnly: true + type: string + displayName: + description: A display name for the provider. Cannot exceed 32 characters. + type: string + description: + description: A description for the provider. Cannot exceed 256 characters. + type: string + state: + description: Output only. The state of the provider. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - >- + The provider is active, and may be used to validate authentication + credentials. + - >- + The provider is soft-deleted. Soft-deleted providers are + permanently deleted after approximately 30 days. You can restore a + soft-deleted provider using UndeleteWorkloadIdentityPoolProvider. + You cannot reuse the ID of a soft-deleted provider until it is + permanently deleted. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + disabled: + description: >- + Whether the provider is disabled. You cannot use a disabled provider + to exchange tokens. However, existing tokens still grant access. + type: boolean + attributeMapping: + description: ' Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains(''assumed-role'')" " ? assertion.arn.extract(''{account_arn}assumed-role/'')" " + ''assumed-role/''" " + assertion.arn.extract(''assumed-role/{role_name}/'')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```' + type: object + additionalProperties: + type: string + attributeCondition: + description: >- + [A Common Expression + Language](https://opensource.google/projects/cel) expression, in + plain text, to restrict what otherwise valid authentication + credentials issued by the provider should not be accepted. The + expression must output a boolean representing whether to allow the + federation. The following keywords may be referenced in the + expressions: * `assertion`: JSON representing the authentication + credential issued by the provider. * `google`: The Google attributes + mapped from the assertion in the `attribute_mappings`. * + `attribute`: The custom attributes mapped from the assertion in the + `attribute_mappings`. The maximum length of the attribute condition + expression is 4096 characters. If unspecified, all valid + authentication credential are accepted. The following example shows + how to only allow credentials with a mapped `google.groups` value of + `admins`: ``` "'admins' in google.groups" ``` + type: string + aws: + description: An Amazon Web Services identity provider. + $ref: '#/components/schemas/Aws' + oidc: + description: An OpenId Connect 1.0 identity provider. + $ref: '#/components/schemas/Oidc' + saml: + description: An SAML 2.0 identity provider. + $ref: '#/components/schemas/Saml' + expireTime: + description: >- + Output only. Time after which the workload identity pool provider + will be permanently purged and cannot be recovered. + readOnly: true + type: string + format: google-datetime + Aws: + id: Aws + description: Represents an Amazon Web Services identity provider. + type: object + properties: + accountId: + description: Required. The AWS account ID. + type: string + Oidc: + id: Oidc + description: Represents an OpenId Connect 1.0 identity provider. + type: object + properties: + issuerUri: + description: Required. The OIDC issuer URL. Must be an HTTPS endpoint. + type: string + allowedAudiences: + description: >- + Acceptable values for the `aud` field (audience) in the OIDC token. + Token exchange requests are rejected if the token audience does not + match one of the configured values. Each audience may be at most 256 + characters. A maximum of 10 audiences may be configured. If this + list is empty, the OIDC token audience must be equal to the full + canonical resource name of the WorkloadIdentityPoolProvider, with or + without the HTTPS prefix. For example: ``` + //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ + https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ + ``` + type: array + items: + type: string + jwksJson: + description: >- + Optional. OIDC JWKs in JSON String format. For details on the + definition of a JWK, see https://tools.ietf.org/html/rfc7517. If not + set, the `jwks_uri` from the discovery document(fetched from the + .well-known path of the `issuer_uri`) will be used. Currently, RSA + and EC asymmetric keys are supported. The JWK must use following + format and include only the following fields: { "keys": [ { "kty": + "RSA/EC", "alg": "", "use": "sig", "kid": "", "n": "", "e": "", "x": + "", "y": "", "crv": "" } ] } + type: string + Saml: + id: Saml + description: Represents an SAML 2.0 identity provider. + type: object + properties: + idpMetadataXml: + description: >- + Required. SAML identity provider (IdP) configuration metadata XML + doc. The XML document must comply with the [SAML 2.0 + specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). + The maximum size of an acceptable XML document is 128K characters. + The SAML metadata XML document must satisfy the following + constraints: * Must contain an IdP Entity ID. * Must contain at + least one non-expired signing certificate. * For each signing + certificate, the expiration must be: * From no more than 7 days in + the future. * To no more than 20 years in the future. * Up to three + IdP signing keys are allowed. When updating the provider's metadata + XML, at least one non-expired signing key must overlap with the + existing metadata. This requirement is skipped if there are no + non-expired signing keys present in the existing metadata. + type: string + UndeleteWorkloadIdentityPoolProviderRequest: + id: UndeleteWorkloadIdentityPoolProviderRequest + description: Request message for UndeleteWorkloadIdentityPoolProvider. + type: object + properties: {} + ListWorkloadIdentityPoolProviderKeysResponse: + id: ListWorkloadIdentityPoolProviderKeysResponse + description: Response message for ListWorkloadIdentityPoolProviderKeys. + type: object + properties: + workloadIdentityPoolProviderKeys: + description: A list of WorkloadIdentityPoolProviderKey + type: array + items: + $ref: '#/components/schemas/WorkloadIdentityPoolProviderKey' + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + WorkloadIdentityPoolProviderKey: + id: WorkloadIdentityPoolProviderKey + description: >- + Represents a public key configuration for your workload identity pool + provider. The key can be configured in your identity provider to encrypt + the SAML assertions. Google holds the corresponding private key which it + uses to decrypt encrypted tokens. + type: object + properties: + name: + description: Output only. The resource name of the key. + readOnly: true + type: string + keyData: + description: Immutable. Public half of the asymmetric key. + $ref: '#/components/schemas/KeyData' + state: + description: Output only. The state of the key. + readOnly: true + type: string + enumDescriptions: + - State unspecified. + - The key is active. + - >- + The key is soft-deleted. Soft-deleted keys are permanently deleted + after approximately 30 days. You can restore a soft-deleted key + using UndeleteWorkloadIdentityPoolProviderKey. While a key is + deleted, you cannot use it during the federation. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - DELETED + use: + description: Required. The purpose of the key. + type: string + enumDescriptions: + - The key use is not known. + - The public key is used for encryption purposes. + enum: + - KEY_USE_UNSPECIFIED + - ENCRYPTION + expireTime: + description: >- + Output only. Time after which the key will be permanently purged and + cannot be recovered. Note that the key may get purged before this + timestamp if the total limit of keys per provider is crossed. + readOnly: true + type: string + format: google-datetime + UndeleteWorkloadIdentityPoolProviderKeyRequest: + id: UndeleteWorkloadIdentityPoolProviderKeyRequest + description: Request message for UndeleteWorkloadIdentityPoolProviderKey. + type: object + properties: {} + AdminAuditData: + id: AdminAuditData + description: >- + Audit log information specific to Cloud IAM admin APIs. This message is + serialized as an `Any` type in the `ServiceData` message of an + `AuditLog` message. + type: object + properties: + permissionDelta: + description: The permission_delta when when creating or updating a Role. + $ref: '#/components/schemas/PermissionDelta' + PermissionDelta: + id: PermissionDelta + description: >- + A PermissionDelta message to record the added_permissions and + removed_permissions inside a role. + type: object + properties: + addedPermissions: + description: Added permissions. + type: array + items: + type: string + removedPermissions: + description: Removed permissions. + type: array + items: + type: string + AuditData: + id: AuditData + description: >- + Audit log information specific to Cloud IAM. This message is serialized + as an `Any` type in the `ServiceData` message of an `AuditLog` message. + type: object + properties: + policyDelta: + description: Policy delta between the original policy and the newly set policy. + $ref: '#/components/schemas/PolicyDelta' + PolicyDelta: + id: PolicyDelta + description: The difference delta between two policies. + type: object + properties: + bindingDeltas: + description: The delta for Bindings between two policies. + type: array + items: + $ref: '#/components/schemas/BindingDelta' + BindingDelta: + id: BindingDelta + description: >- + One delta entry for Binding. Each individual change (only one member in + each entry) to a binding will be a separate entry. + type: object + properties: + action: + description: The action that was performed on a Binding. Required + type: string + enumDescriptions: + - Unspecified. + - Addition of a Binding. + - Removal of a Binding. + enum: + - ACTION_UNSPECIFIED + - ADD + - REMOVE + role: + description: >- + Role that is assigned to `members`. For example, `roles/viewer`, + `roles/editor`, or `roles/owner`. Required + type: string + member: + description: >- + A single identity requesting access for a Google Cloud resource. + Follows the same format of Binding.members. Required + type: string + condition: + description: The condition that is associated with this binding. + $ref: '#/components/schemas/Expr' + WorkloadIdentityPoolOperationMetadata: + id: WorkloadIdentityPoolOperationMetadata + description: Metadata for long-running WorkloadIdentityPool operations. + type: object + properties: {} + OperationMetadata: + id: OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusDetail: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + cancelRequested: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + ReconciliationOperationMetadata: + id: ReconciliationOperationMetadata + description: >- + Operation metadata returned by the CLH during resource state + reconciliation. + type: object + properties: + deleteResource: + description: DEPRECATED. Use exclusive_action instead. + deprecated: true + type: boolean + exclusiveAction: + description: Excluisive action returned by the CLH. + type: string + enumDescriptions: + - Unknown repair action. + - >- + The resource has to be deleted. When using this bit, the CLH + should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE + OperationSignal in SideChannel. + - >- + This resource could not be repaired but the repair should be tried + again at a later time. This can happen if there is a dependency + that needs to be resolved first- e.g. if a parent resource must be + repaired before a child resource. + enumDeprecated: + - false + - true + - false + enum: + - UNKNOWN_REPAIR_ACTION + - DELETE + - RETRY + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @@ -588,125 +2644,3982 @@ components: type: boolean quotaUser: description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - policies: - id: google.iam.policies - name: policies - title: Policies - methods: - _list_policies: - operation: &ref_1 - $ref: '#/paths/~1v2~1policies~1{policiesId}~1{policiesId1}/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.policies - list_policies: - operation: *ref_1 - response: *ref_2 - create_policy: - operation: - $ref: '#/paths/~1v2~1policies~1{policiesId}~1{policiesId1}/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: >- - #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/get - response: - mediaType: application/json - openAPIDocKey: '200' - update: - operation: - $ref: >- - #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/put - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: >- - #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/get' - - $ref: '#/components/x-stackQL-resources/policies/methods/list_policies' - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/create_policy' - update: - - $ref: '#/components/x-stackQL-resources/policies/methods/update' - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/delete' - operations: - id: google.iam.operations - name: operations - title: Operations - methods: - get: - operation: - $ref: >- - #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}~1operations~1{operationsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/operations/methods/get' - insert: [] - update: [] - delete: [] -paths: - /v2/policies/{policiesId}/{policiesId1}: - parameters: &ref_3 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + oauth_clients: + id: google.iam.oauth_clients + name: oauth_clients + title: Oauth_clients + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.oauthClients + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/get' + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/oauth_clients/methods/delete' + credentials: + id: google.iam.credentials + name: credentials + title: Credentials + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1oauthClients~1{oauthClientsId}~1credentials~1{credentialsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/credentials/methods/get' + - $ref: '#/components/x-stackQL-resources/credentials/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/credentials/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/credentials/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/credentials/methods/delete' + workload_identity_pools: + id: google.iam.workload_identity_pools + name: workload_identity_pools + title: Workload_identity_pools + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workloadIdentityPools + create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workloadIdentityPools~1{workloadIdentityPoolsId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workload_identity_pools/methods/get + - $ref: >- + #/components/x-stackQL-resources/workload_identity_pools/methods/list + insert: + - $ref: >- + #/components/x-stackQL-resources/workload_identity_pools/methods/create + update: + - $ref: >- + #/components/x-stackQL-resources/workload_identity_pools/methods/patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/workload_identity_pools/methods/delete + operations: + id: google.iam.operations + name: operations + title: Operations + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + insert: [] + update: [] + replace: [] + delete: [] + providers: + id: google.iam.providers + name: providers + title: Providers + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePoolProviders + create: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/providers/methods/get' + - $ref: '#/components/x-stackQL-resources/providers/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/providers/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/providers/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/providers/methods/delete' + keys: + id: google.iam.keys + name: keys + title: Keys + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePoolProviderKeys + create: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys/post + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1providers~1{providersId}~1keys~1{keysId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + upload: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys:upload/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}~1keys~1{keysId}:enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys/methods/get' + - $ref: '#/components/x-stackQL-resources/keys/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete' + service_accounts: + id: google.iam.service_accounts + name: service_accounts + title: Service_accounts + methods: + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1serviceAccounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.accounts + create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1serviceAccounts/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/put + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + enable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:enable/post + response: + mediaType: application/json + openAPIDocKey: '200' + disable: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:disable/post + response: + mediaType: application/json + openAPIDocKey: '200' + sign_blob: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:signBlob/post + response: + mediaType: application/json + openAPIDocKey: '200' + sign_jwt: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:signJwt/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/get' + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/patch' + replace: + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/service_accounts/methods/delete' + service_accounts_iam_policies: + id: google.iam.service_accounts_iam_policies + name: service_accounts_iam_policies + title: Service_accounts_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1serviceAccounts~1{serviceAccountsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/service_accounts_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/service_accounts_iam_policies/methods/set_iam_policy + delete: [] + roles: + id: google.iam.roles + name: roles + title: Roles + methods: + list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1roles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.roles + create: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1roles/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1roles~1{rolesId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + query_grantable_roles: + operation: + $ref: '#/paths/~1v1~1roles:queryGrantableRoles/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/roles/methods/get' + - $ref: '#/components/x-stackQL-resources/roles/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/roles/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/roles/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/roles/methods/delete' + workforce_pools: + id: google.iam.workforce_pools + name: workforce_pools + title: Workforce_pools + methods: + list: + operation: + $ref: '#/paths/~1v1~1locations~1{locationsId}~1workforcePools/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workforcePools + create: + operation: + $ref: '#/paths/~1v1~1locations~1{locationsId}~1workforcePools/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/get' + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/workforce_pools/methods/delete' + workforce_pools_iam_policies: + id: google.iam.workforce_pools_iam_policies + name: workforce_pools_iam_policies + title: Workforce_pools_iam_policies + methods: + get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/workforce_pools_iam_policies/methods/set_iam_policy + delete: [] + subjects: + id: google.iam.subjects + name: subjects + title: Subjects + methods: + delete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + undelete: + operation: + $ref: >- + #/paths/~1v1~1locations~1{locationsId}~1workforcePools~1{workforcePoolsId}~1subjects~1{subjectsId}:undelete/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/subjects/methods/delete' + permissions: + id: google.iam.permissions + name: permissions + title: Permissions + methods: + query_testable_permissions: + operation: + $ref: '#/paths/~1v1~1permissions:queryTestablePermissions/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + iam_policies: + id: google.iam.iam_policies + name: iam_policies + title: Iam_policies + methods: + query_auditable_services: + operation: + $ref: '#/paths/~1v1~1iamPolicies:queryAuditableServices/post' + response: + mediaType: application/json + openAPIDocKey: '200' + lint_policy: + operation: + $ref: '#/paths/~1v1~1iamPolicies:lintPolicy/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1/projects/{projectsId}/locations/{locationsId}/oauthClients: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Lists all non-deleted OauthClients in a project. If `show_deleted` is + set to `true`, then deleted OauthClients are also listed. + operationId: iam.projects.locations.oauthClients.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOauthClientsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Creates a new OauthClient. You cannot reuse the name of a deleted + OauthClient until 30 days after deletion. + operationId: iam.projects.locations.oauthClients.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClient' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClient' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: oauthClientId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}: + parameters: *ref_1 + get: + description: Gets an individual OauthClient. + operationId: iam.projects.locations.oauthClients.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClient' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + patch: + description: Updates an existing OauthClient. + operationId: iam.projects.locations.oauthClients.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClient' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClient' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes an OauthClient. You cannot use a deleted OauthClient. However, + deletion does not revoke access tokens that have already been issued. + They continue to grant access. Deletion does revoke refresh tokens that + have already been issued. They cannot be used to renew an access token. + If the OauthClient is undeleted, and the refresh tokens are not expired, + they are valid for token exchange again. You can undelete an OauthClient + for 30 days. After 30 days, deletion is permanent. You cannot update + deleted OauthClients. However, you can view and list them. + operationId: iam.projects.locations.oauthClients.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClient' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes an OauthClient, as long as it was deleted fewer than 30 days + ago. + operationId: iam.projects.locations.oauthClients.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteOauthClientRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClient' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials: + parameters: *ref_1 + get: + description: Lists all OauthClientCredentials in an OauthClient. + operationId: iam.projects.locations.oauthClients.credentials.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListOauthClientCredentialsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + post: + description: Creates a new OauthClientCredential. + operationId: iam.projects.locations.oauthClients.credentials.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClientCredential' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClientCredential' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + - in: query + name: oauthClientCredentialId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials/{credentialsId}: + parameters: *ref_1 + get: + description: Gets an individual OauthClientCredential. + operationId: iam.projects.locations.oauthClients.credentials.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClientCredential' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + - in: path + name: credentialsId + required: true + schema: + type: string + patch: + description: Updates an existing OauthClientCredential. + operationId: iam.projects.locations.oauthClients.credentials.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClientCredential' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/OauthClientCredential' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + - in: path + name: credentialsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes an OauthClientCredential. Before deleting an + OauthClientCredential, it should first be disabled. + operationId: iam.projects.locations.oauthClients.credentials.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: oauthClientsId + required: true + schema: + type: string + - in: path + name: credentialsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkloadIdentityPools in a project. If + `show_deleted` is set to `true`, then deleted pools are also listed. + operationId: iam.projects.locations.workloadIdentityPools.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkloadIdentityPoolsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Creates a new WorkloadIdentityPool. You cannot reuse the name of a + deleted pool until 30 days after deletion. + operationId: iam.projects.locations.workloadIdentityPools.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPool' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: workloadIdentityPoolId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}: + parameters: *ref_1 + get: + description: Gets an individual WorkloadIdentityPool. + operationId: iam.projects.locations.workloadIdentityPools.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPool' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + patch: + description: Updates an existing WorkloadIdentityPool. + operationId: iam.projects.locations.workloadIdentityPools.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPool' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a WorkloadIdentityPool. You cannot use a deleted pool to + exchange external credentials for Google Cloud credentials. However, + deletion does not revoke credentials that have already been issued. + Credentials issued for a deleted pool do not grant access to resources. + If the pool is undeleted, and the credentials are not expired, they + grant access again. You can undelete a pool for 30 days. After 30 days, + deletion is permanent. You cannot update deleted pools. However, you can + view and list them. + operationId: iam.projects.locations.workloadIdentityPools.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than + 30 days ago. + operationId: iam.projects.locations.workloadIdentityPools.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteWorkloadIdentityPoolRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.projects.locations.workloadIdentityPools.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.projects.locations.workloadIdentityPools.namespaces.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/workloadSources/{workloadSourcesId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.workloadSources.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: namespacesId + required: true + schema: + type: string + - in: path + name: managedIdentitiesId + required: true + schema: + type: string + - in: path + name: workloadSourcesId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkloadIdentityPoolProviders in a + WorkloadIdentityPool. If `show_deleted` is set to `true`, then deleted + providers are also listed. + operationId: iam.projects.locations.workloadIdentityPools.providers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkloadIdentityPoolProvidersResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Creates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. + You cannot reuse the name of a deleted provider until 30 days after + deletion. + operationId: iam.projects.locations.workloadIdentityPools.providers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: query + name: workloadIdentityPoolProviderId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}: + parameters: *ref_1 + get: + description: Gets an individual WorkloadIdentityPoolProvider. + operationId: iam.projects.locations.workloadIdentityPools.providers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + patch: + description: Updates an existing WorkloadIdentityPoolProvider. + operationId: iam.projects.locations.workloadIdentityPools.providers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProvider' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a WorkloadIdentityPoolProvider. Deleting a provider does not + revoke credentials that have already been issued; they continue to grant + access. You can undelete a provider for 30 days. After 30 days, deletion + is permanent. You cannot update deleted providers. However, you can view + and list them. + operationId: iam.projects.locations.workloadIdentityPools.providers.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes a WorkloadIdentityPoolProvider, as long as it was deleted + fewer than 30 days ago. + operationId: iam.projects.locations.workloadIdentityPools.providers.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteWorkloadIdentityPoolProviderRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.projects.locations.workloadIdentityPools.providers.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkloadIdentityPoolProviderKeys in a project. If + show_deleted is set to `true`, then deleted pools are also listed. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/ListWorkloadIdentityPoolProviderKeysResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Create a new WorkloadIdentityPoolProviderKey in a + WorkloadIdentityPoolProvider. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProviderKey' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: workloadIdentityPoolProviderKeyId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}: + parameters: *ref_1 + get: + description: Gets an individual WorkloadIdentityPoolProviderKey. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkloadIdentityPoolProviderKey' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + delete: + description: >- + Deletes an WorkloadIdentityPoolProviderKey. You can undelete a key for + 30 days. After 30 days, deletion is permanent. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes an WorkloadIdentityPoolProviderKey, as long as it was deleted + fewer than 30 days ago. + operationId: iam.projects.locations.workloadIdentityPools.providers.keys.undelete + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/UndeleteWorkloadIdentityPoolProviderKeyRequest + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + iam.projects.locations.workloadIdentityPools.providers.keys.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workloadIdentityPoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts: + parameters: *ref_1 + get: + description: Lists every ServiceAccount that belongs to a specific project. + operationId: iam.projects.serviceAccounts.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListServiceAccountsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a ServiceAccount. + operationId: iam.projects.serviceAccounts.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}: + parameters: *ref_1 + get: + description: Gets a ServiceAccount. + operationId: iam.projects.serviceAccounts.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + put: + description: >- + **Note:** We are in the process of deprecating this method. Use + PatchServiceAccount instead. Updates a ServiceAccount. You can update + only the `display_name` field. + operationId: iam.projects.serviceAccounts.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + patch: + description: Patches a ServiceAccount. + operationId: iam.projects.serviceAccounts.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccount' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + delete: + description: >- + Deletes a ServiceAccount. **Warning:** After you delete a service + account, you might not be able to undelete it. If you know that you need + to re-enable the service account in the future, use + DisableServiceAccount instead. If you delete a service account, IAM + permanently removes the service account 30 days later. Google Cloud + cannot recover the service account after it is permanently removed, even + if you file a support request. To help avoid unplanned outages, we + recommend that you disable the service account before you delete it. Use + DisableServiceAccount to disable the service account, then wait at least + 24 hours and watch for unintended consequences. If there are no + unintended consequences, you can delete the service account. + operationId: iam.projects.serviceAccounts.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:undelete: + parameters: *ref_1 + post: + description: >- + Restores a deleted ServiceAccount. **Important:** It is not always + possible to restore a deleted service account. Use this method only as a + last resort. After you delete a service account, IAM permanently removes + the service account 30 days later. There is no way to restore a deleted + service account that has been permanently removed. + operationId: iam.projects.serviceAccounts.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteServiceAccountResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:enable: + parameters: *ref_1 + post: + description: >- + Enables a ServiceAccount that was disabled by DisableServiceAccount. If + the service account is already enabled, then this method has no effect. + If the service account was disabled by other means—for example, if + Google disabled the service account because it was compromised—you + cannot use this method to enable the service account. + operationId: iam.projects.serviceAccounts.enable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:disable: + parameters: *ref_1 + post: + description: >- + Disables a ServiceAccount immediately. If an application uses the + service account to authenticate, that application can no longer call + Google APIs or access Google Cloud resources. Existing access tokens for + the service account are rejected, and requests for new access tokens + will fail. To re-enable the service account, use EnableServiceAccount. + After you re-enable the service account, its existing access tokens will + be accepted, and you can request new access tokens. To help avoid + unplanned outages, we recommend that you disable the service account + before you delete it. Use this method to disable the service account, + then wait at least 24 hours and watch for unintended consequences. If + there are no unintended consequences, you can delete the service account + with DeleteServiceAccount. + operationId: iam.projects.serviceAccounts.disable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableServiceAccountRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob: + parameters: *ref_1 + post: + description: >- + **Note:** This method is deprecated. Use the + [signBlob](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) + method in the IAM Service Account Credentials API instead. If you + currently use this method, see the [migration + guide](https://cloud.google.com/iam/help/credentials/migrate-api) for + instructions. Signs a blob using the system-managed private key for a + ServiceAccount. + operationId: iam.projects.serviceAccounts.signBlob + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignBlobRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SignBlobResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt: + parameters: *ref_1 + post: + description: >- + **Note:** This method is deprecated. Use the + [signJwt](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) + method in the IAM Service Account Credentials API instead. If you + currently use this method, see the [migration + guide](https://cloud.google.com/iam/help/credentials/migrate-api) for + instructions. Signs a JSON Web Token (JWT) using the system-managed + private key for a ServiceAccount. + operationId: iam.projects.serviceAccounts.signJwt + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignJwtRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SignJwtResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the IAM policy that is attached to a ServiceAccount. This IAM + policy specifies which principals have access to the service account. + This method does not tell you whether the service account has been + granted any roles on other resources. To check whether a service account + has role grants on a resource, use the `getIamPolicy` method for that + resource. For example, to view the role grants for a project, call the + Resource Manager API's + [projects.getIamPolicy](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) + method. + operationId: iam.projects.serviceAccounts.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the IAM policy that is attached to a ServiceAccount. Use this + method to grant or revoke access to the service account. For example, + you could grant a principal the ability to impersonate the service + account. This method does not enable the service account to access other + resources. To grant roles to a service account on a resource, follow + these steps: 1. Call the resource's `getIamPolicy` method to get its + current IAM policy. 2. Edit the policy so that it binds the service + account to an IAM role for the resource. 3. Call the resource's + `setIamPolicy` method to update its IAM policy. For detailed + instructions, see [Manage access to project, folders, and + organizations](https://cloud.google.com/iam/help/service-accounts/granting-access-to-service-accounts) + or [Manage access to other + resources](https://cloud.google.com/iam/help/access/manage-other-resources). + operationId: iam.projects.serviceAccounts.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Tests whether the caller has the specified permissions on a + ServiceAccount. + operationId: iam.projects.serviceAccounts.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys: + parameters: *ref_1 + get: + description: Lists every ServiceAccountKey for a service account. + operationId: iam.projects.serviceAccounts.keys.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListServiceAccountKeysResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: query + name: keyTypes + schema: + type: string + post: + description: Creates a ServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateServiceAccountKeyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccountKey' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}: + parameters: *ref_1 + get: + description: Gets a ServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccountKey' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: query + name: publicKeyType + schema: + type: string + delete: + description: >- + Deletes a ServiceAccountKey. Deleting a service account key does not + revoke short-lived credentials that have been issued based on the + service account key. + operationId: iam.projects.serviceAccounts.keys.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys:upload: + parameters: *ref_1 + post: + description: >- + Uploads the public key portion of a key pair that you manage, and + associates the public key with a ServiceAccount. After you upload the + public key, you can use the private key from the key pair as a service + account key. + operationId: iam.projects.serviceAccounts.keys.upload + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UploadServiceAccountKeyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAccountKey' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:disable: + parameters: *ref_1 + post: + description: >- + Disable a ServiceAccountKey. A disabled service account key can be + re-enabled with EnableServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.disable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableServiceAccountKeyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:enable: + parameters: *ref_1 + post: + description: Enable a ServiceAccountKey. + operationId: iam.projects.serviceAccounts.keys.enable + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnableServiceAccountKeyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: serviceAccountsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/roles: + parameters: *ref_1 + get: + description: >- + Lists every predefined Role that IAM supports, or every custom role that + is defined for an organization or project. + operationId: iam.projects.roles.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: Creates a new custom Role. + operationId: iam.projects.roles.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRoleRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/roles/{rolesId}: + parameters: *ref_1 + get: + description: Gets the definition of a Role. + operationId: iam.projects.roles.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: rolesId + required: true + schema: + type: string + patch: + description: Updates the definition of a custom Role. + operationId: iam.projects.roles.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: rolesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a custom Role. When you delete a custom role, the following + changes occur immediately: * You cannot bind a principal to the custom + role in an IAM Policy. * Existing bindings to the custom role are not + changed, but they have no effect. * By default, the response from + ListRoles does not include the custom role. A deleted custom role still + counts toward the [custom role + limit](https://cloud.google.com/iam/help/limits) until it is permanently + deleted. You have 7 days to undelete the custom role. After 7 days, the + following changes occur: * The custom role is permanently deleted and + cannot be recovered. * If an IAM policy contains a binding to the custom + role, the binding is permanently removed. * The custom role no longer + counts toward your custom role limit. + operationId: iam.projects.roles.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: rolesId + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + format: byte + /v1/projects/{projectsId}/roles/{rolesId}:undelete: + parameters: *ref_1 + post: + description: Undeletes a custom Role. + operationId: iam.projects.roles.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteRoleRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: rolesId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkforcePools under the specified parent. If + `show_deleted` is set to `true`, then deleted pools are also listed. + operationId: iam.locations.workforcePools.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkforcePoolsResponse' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: parent + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Creates a new WorkforcePool. You cannot reuse the name of a deleted pool + until 30 days after deletion. + operationId: iam.locations.workforcePools.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePool' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: workforcePoolId + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}: + parameters: *ref_1 + get: + description: Gets an individual WorkforcePool. + operationId: iam.locations.workforcePools.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePool' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + patch: + description: Updates an existing WorkforcePool. + operationId: iam.locations.workforcePools.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePool' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a WorkforcePool. You cannot use a deleted WorkforcePool to + exchange external credentials for Google Cloud credentials. However, + deletion does not revoke credentials that have already been issued. + Credentials issued for a deleted pool do not grant access to resources. + If the pool is undeleted, and the credentials are not expired, they + grant access again. You can undelete a pool for 30 days. After 30 days, + deletion is permanent. You cannot update deleted pools. However, you can + view and list them. + operationId: iam.locations.workforcePools.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes a WorkforcePool, as long as it was deleted fewer than 30 days + ago. + operationId: iam.locations.workforcePools.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteWorkforcePoolRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:getIamPolicy: + parameters: *ref_1 + post: + description: Gets IAM policies on a WorkforcePool. + operationId: iam.locations.workforcePools.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:setIamPolicy: + parameters: *ref_1 + post: + description: Sets IAM policies on a WorkforcePool. + operationId: iam.locations.workforcePools.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns the caller's permissions on the WorkforcePool. If the pool + doesn't exist, this call returns an empty set of permissions. It doesn't + return a `NOT_FOUND` error. + operationId: iam.locations.workforcePools.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.locations.workforcePools.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkforcePoolProviders in a WorkforcePool. If + `show_deleted` is set to `true`, then deleted providers are also listed. + operationId: iam.locations.workforcePools.providers.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkforcePoolProvidersResponse' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: >- + Creates a new WorkforcePoolProvider in a WorkforcePool. You cannot reuse + the name of a deleted provider until 30 days after deletion. + operationId: iam.locations.workforcePools.providers.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProvider' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: query + name: workforcePoolProviderId + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}: + parameters: *ref_1 + get: + description: Gets an individual WorkforcePoolProvider. + operationId: iam.locations.workforcePools.providers.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProvider' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + patch: + description: Updates an existing WorkforcePoolProvider. + operationId: iam.locations.workforcePools.providers.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProvider' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: >- + Deletes a WorkforcePoolProvider. Deleting a provider does not revoke + credentials that have already been issued; they continue to grant + access. You can undelete a provider for 30 days. After 30 days, deletion + is permanent. You cannot update deleted providers. However, you can view + and list them. + operationId: iam.locations.workforcePools.providers.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes a WorkforcePoolProvider, as long as it was deleted fewer than + 30 days ago. + operationId: iam.locations.workforcePools.providers.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteWorkforcePoolProviderRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.locations.workforcePools.providers.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys: + parameters: *ref_1 + get: + description: >- + Lists all non-deleted WorkforcePoolProviderKeys in a + WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted + keys are also listed. + operationId: iam.locations.workforcePools.providers.keys.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListWorkforcePoolProviderKeysResponse' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider. + operationId: iam.locations.workforcePools.providers.keys.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProviderKey' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: query + name: workforcePoolProviderKeyId + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}: + parameters: *ref_1 + get: + description: Gets a WorkforcePoolProviderKey. + operationId: iam.locations.workforcePools.providers.keys.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/WorkforcePoolProviderKey' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + delete: + description: >- + Deletes a WorkforcePoolProviderKey. You can undelete a key for 30 days. + After 30 days, deletion is permanent. + operationId: iam.locations.workforcePools.providers.keys.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes a WorkforcePoolProviderKey, as long as it was deleted fewer + than 30 days ago. + operationId: iam.locations.workforcePools.providers.keys.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteWorkforcePoolProviderKeyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true + schema: + type: string + - in: path + name: providersId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- - Retrieves the policies of the specified kind that are attached to a - resource. The response lists only policy metadata. In particular, policy - rules are omitted. - operationId: iam.policies.listPolicies + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.locations.workforcePools.providers.keys.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -718,35 +6631,91 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV2ListPoliciesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: policiesId + name: locationsId required: true schema: type: string - in: path - name: policiesId1 + name: workforcePoolsId required: true schema: type: string - - in: query - name: pageSize + - in: path + name: providersId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: keysId + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/subjects/{subjectsId}: + parameters: *ref_1 + delete: + description: >- + Deletes a WorkforcePoolSubject. Subject must not already be in a deleted + state. A WorkforcePoolSubject is automatically created the first time an + external credential is exchanged for a Google Cloud credential using a + mapped `google.subject` attribute. There is no endpoint to manually + create a WorkforcePoolSubject. For 30 days after a WorkforcePoolSubject + is deleted, using the same `google.subject` attribute in token exchanges + with Google Cloud STS fails. Call UndeleteWorkforcePoolSubject to + undelete a WorkforcePoolSubject that has been deleted, within within 30 + days of deleting it. After 30 days, the WorkforcePoolSubject is + permanently deleted. At this point, a token exchange with Google Cloud + STS that uses the same mapped `google.subject` attribute automatically + creates a new WorkforcePoolSubject that is unrelated to the previously + deleted WorkforcePoolSubject but has the same `google.subject` value. + operationId: iam.locations.workforcePools.subjects.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workforcePoolsId + required: true schema: type: string + - in: path + name: subjectsId + required: true + schema: + type: string + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/subjects/{subjectsId}:undelete: + parameters: *ref_1 post: - description: Creates a policy. - operationId: iam.policies.createPolicy + description: >- + Undeletes a WorkforcePoolSubject, as long as it was deleted fewer than + 30 days ago. + operationId: iam.locations.workforcePools.subjects.undelete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV2Policy' + $ref: '#/components/schemas/UndeleteWorkforcePoolSubjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -758,27 +6727,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: policiesId + name: locationsId required: true schema: type: string - in: path - name: policiesId1 + name: workforcePoolsId required: true schema: type: string - - in: query - name: policyId + - in: path + name: subjectsId + required: true schema: type: string - /v2/policies/{policiesId}/{policiesId1}/{policiesId2}: - parameters: *ref_3 + /v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/subjects/{subjectsId}/operations/{operationsId}: + parameters: *ref_1 get: - description: Gets a policy. - operationId: iam.policies.get + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.locations.workforcePools.subjects.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -790,37 +6763,100 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV2Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path - name: policiesId + name: locationsId required: true schema: type: string - in: path - name: policiesId1 + name: workforcePoolsId required: true schema: type: string - in: path - name: policiesId2 + name: subjectsId required: true schema: type: string - put: + - in: path + name: operationsId + required: true + schema: + type: string + /v1/roles:queryGrantableRoles: + parameters: *ref_1 + post: description: >- - Updates the specified policy. You can update only the rules and the - display name for the policy. To update a policy, you should use a - read-modify-write loop: 1. Use GetPolicy to read the current version of - the policy. 2. Modify the policy as needed. 3. Use `UpdatePolicy` to - write the updated policy. This pattern helps prevent conflicts between - concurrent updates. - operationId: iam.policies.update + Lists roles that can be granted on a Google Cloud resource. A role is + grantable if the IAM policy for the resource can contain bindings to the + role. + operationId: iam.roles.queryGrantableRoles requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleIamV2Policy' + $ref: '#/components/schemas/QueryGrantableRolesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryGrantableRolesResponse' + parameters: [] + /v1/roles: + parameters: *ref_1 + get: + description: >- + Lists every predefined Role that IAM supports, or every custom role that + is defined for an organization or project. + operationId: iam.roles.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolesResponse' + parameters: + - in: query + name: parent + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + /v1/roles/{rolesId}: + parameters: *ref_1 + get: + description: Gets the definition of a Role. + operationId: iam.roles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -832,26 +6868,86 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/Role' parameters: - in: path - name: policiesId + name: rolesId required: true schema: type: string + /v1/organizations/{organizationsId}/roles: + parameters: *ref_1 + get: + description: >- + Lists every predefined Role that IAM supports, or every custom role that + is defined for an organization or project. + operationId: iam.organizations.roles.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolesResponse' + parameters: - in: path - name: policiesId1 + name: organizationsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: view + schema: + type: string + - in: query + name: showDeleted + schema: + type: boolean + post: + description: Creates a new custom Role. + operationId: iam.organizations.roles.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRoleRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: - in: path - name: policiesId2 + name: organizationsId required: true schema: type: string - delete: - description: Deletes a policy. This action is permanent. - operationId: iam.policies.delete + /v1/organizations/{organizationsId}/roles/{rolesId}: + parameters: *ref_1 + get: + description: Gets the definition of a Role. + operationId: iam.organizations.roles.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -863,35 +6959,69 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/Role' parameters: - in: path - name: policiesId + name: organizationsId + required: true + schema: + type: string + - in: path + name: rolesId required: true schema: type: string + patch: + description: Updates the definition of a custom Role. + operationId: iam.organizations.roles.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: - in: path - name: policiesId1 + name: organizationsId required: true schema: type: string - in: path - name: policiesId2 + name: rolesId required: true schema: type: string - in: query - name: etag + name: updateMask schema: type: string - /v2/policies/{policiesId}/{policiesId1}/{policiesId2}/operations/{operationsId}: - parameters: *ref_3 - get: + format: google-fieldmask + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: iam.policies.operations.get + Deletes a custom Role. When you delete a custom role, the following + changes occur immediately: * You cannot bind a principal to the custom + role in an IAM Policy. * Existing bindings to the custom role are not + changed, but they have no effect. * By default, the response from + ListRoles does not include the custom role. A deleted custom role still + counts toward the [custom role + limit](https://cloud.google.com/iam/help/limits) until it is permanently + deleted. You have 7 days to undelete the custom role. After 7 days, the + following changes occur: * The custom role is permanently deleted and + cannot be recovered. * If an IAM policy contains a binding to the custom + role, the binding is permanently removed. * The custom role no longer + counts toward your custom role limit. + operationId: iam.organizations.roles.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -903,25 +7033,133 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/Role' parameters: - in: path - name: policiesId + name: organizationsId required: true schema: type: string - in: path - name: policiesId1 + name: rolesId required: true schema: type: string + - in: query + name: etag + schema: + type: string + format: byte + /v1/organizations/{organizationsId}/roles/{rolesId}:undelete: + parameters: *ref_1 + post: + description: Undeletes a custom Role. + operationId: iam.organizations.roles.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteRoleRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + parameters: - in: path - name: policiesId2 + name: organizationsId required: true schema: type: string - in: path - name: operationsId + name: rolesId required: true schema: type: string + /v1/permissions:queryTestablePermissions: + parameters: *ref_1 + post: + description: >- + Lists every permission that you can test on a resource. A permission is + testable if you can check whether a principal has that permission on the + resource. + operationId: iam.permissions.queryTestablePermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTestablePermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryTestablePermissionsResponse' + parameters: [] + /v1/iamPolicies:queryAuditableServices: + parameters: *ref_1 + post: + description: >- + Returns a list of services that allow you to opt into audit logs that + are not generated by default. To learn more about audit logs, see the + [Logging documentation](https://cloud.google.com/logging/docs/audit). + operationId: iam.iamPolicies.queryAuditableServices + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryAuditableServicesRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/QueryAuditableServicesResponse' + parameters: [] + /v1/iamPolicies:lintPolicy: + parameters: *ref_1 + post: + description: >- + Lints, or validates, an IAM policy. Currently checks the + google.iam.v1.Binding.condition field, which contains a condition + expression for a role binding. Successful calls to this method always + return an HTTP `200 OK` status code, even if the linter detects an issue + in the IAM policy. + operationId: iam.iamPolicies.lintPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LintPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LintPolicyResponse' + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml index a8014b84..9b5c10da 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iamcredentials.yaml @@ -10,8 +10,8 @@ info: Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API. version: v1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: >- https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials @@ -351,6 +351,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:generateAccessToken: diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml new file mode 100644 index 00000000..1eac222c --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/iamv2.yaml @@ -0,0 +1,1106 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Identity and Access Management (IAM) API + description: >- + Manages identity and access control for Google Cloud resources, including + the creation of service accounts, which you can use to authenticate to + Google and make API calls. Enabling this API also enables the IAM Service + Account Credentials API (iamcredentials.googleapis.com). However, disabling + this API doesn't disable the IAM Service Account Credentials API. + version: v2 + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' +externalDocs: + url: https://cloud.google.com/iam/ +servers: + - url: https://iam.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleIamV2ListPoliciesResponse: + id: GoogleIamV2ListPoliciesResponse + description: Response message for `ListPolicies`. + type: object + properties: + policies: + description: Metadata for the policies that are attached to the resource. + type: array + items: + $ref: '#/components/schemas/GoogleIamV2Policy' + nextPageToken: + description: >- + A page token that you can use in a ListPoliciesRequest to retrieve + the next page. If this field is omitted, there are no additional + pages. + type: string + GoogleIamV2Policy: + id: GoogleIamV2Policy + description: Data for an IAM policy. + type: object + properties: + name: + description: >- + Immutable. The resource name of the `Policy`, which must be unique. + Format: `policies/{attachment_point}/denypolicies/{policy_id}` The + attachment point is identified by its URL-encoded full resource + name, which means that the forward-slash character, `/`, must be + written as `%2F`. For example, + `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. + For organizations and folders, use the numeric ID in the full + resource name. For projects, requests can use the alphanumeric or + the numeric ID. Responses always contain the numeric ID. + type: string + uid: + description: >- + Immutable. The globally unique ID of the `Policy`. Assigned + automatically when the `Policy` is created. + type: string + kind: + description: >- + Output only. The kind of the `Policy`. Always contains the value + `DenyPolicy`. + readOnly: true + type: string + displayName: + description: >- + A user-specified description of the `Policy`. This value can be up + to 63 characters. + type: string + annotations: + description: >- + A key-value map to store arbitrary metadata for the `Policy`. Keys + can be up to 63 characters. Values can be up to 255 characters. + type: object + additionalProperties: + type: string + etag: + description: >- + An opaque tag that identifies the current version of the `Policy`. + IAM uses this value to help manage concurrent updates, so they do + not cause one update to be overwritten by another. If this field is + present in a CreatePolicyRequest, the value is ignored. + type: string + createTime: + description: Output only. The time when the `Policy` was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the `Policy` was last updated. + readOnly: true + type: string + format: google-datetime + deleteTime: + description: >- + Output only. The time when the `Policy` was deleted. Empty if the + policy is not deleted. + readOnly: true + type: string + format: google-datetime + rules: + description: >- + A list of rules that specify the behavior of the `Policy`. All of + the rules should be of the `kind` specified in the `Policy`. + type: array + items: + $ref: '#/components/schemas/GoogleIamV2PolicyRule' + GoogleIamV2PolicyRule: + id: GoogleIamV2PolicyRule + description: A single rule in a `Policy`. + type: object + properties: + denyRule: + description: A rule for a deny policy. + $ref: '#/components/schemas/GoogleIamV2DenyRule' + description: + description: >- + A user-specified description of the rule. This value can be up to + 256 characters. + type: string + GoogleIamV2DenyRule: + id: GoogleIamV2DenyRule + description: A deny rule in an IAM deny policy. + type: object + properties: + deniedPrincipals: + description: >- + The identities that are prevented from using one or more permissions + on Google Cloud resources. This field can contain the following + values: * `principal://goog/subject/{email_id}`: A specific Google + Account. Includes Gmail, Cloud Identity, and Google Workspace user + accounts. For example, `principal://goog/subject/alice@example.com`. + * + `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: + A Google Cloud service account. For example, + `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. + * `principalSet://goog/group/{group_id}`: A Google group. For + example, `principalSet://goog/group/admins@example.com`. * + `principalSet://goog/public:all`: A special identifier that + represents any principal that is on the internet, even if they do + not have a Google Account or are not logged in. * + `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of + the principals associated with the specified Google Workspace or + Cloud Identity customer ID. For example, + `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific + Google Account that was deleted recently. For example, + `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. + If the Google Account is recovered, this identifier reverts to the + standard identifier for a Google Account. * + `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google + group that was deleted recently. For example, + `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. + If the Google group is restored, this identifier reverts to the + standard identifier for a Google group. * + `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: + A Google Cloud service account that was deleted recently. For + example, + `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. + If the service account is undeleted, this identifier reverts to the + standard identifier for a service account. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + exceptionPrincipals: + description: >- + The identities that are excluded from the deny rule, even if they + are listed in the `denied_principals`. For example, you could add a + Google group to the `denied_principals`, then exclude specific users + who belong to that group. This field can contain the same values as + the `denied_principals` field, excluding + `principalSet://goog/public:all`, which represents all users on the + internet. + type: array + items: + type: string + deniedPermissions: + description: >- + The permissions that are explicitly denied by this rule. Each + permission uses the format `{service_fqdn}/{resource}.{verb}`, where + `{service_fqdn}` is the fully qualified domain name for the service. + For example, `iam.googleapis.com/roles.list`. + type: array + items: + type: string + exceptionPermissions: + description: >- + Specifies the permissions that this rule excludes from the set of + denied permissions given by `denied_permissions`. If a permission + appears in `denied_permissions` _and_ in `exception_permissions` + then it will _not_ be denied. The excluded permissions can be + specified using the same syntax as `denied_permissions`. + type: array + items: + type: string + denialCondition: + description: >- + The condition that determines whether this deny rule applies to a + request. If the condition expression evaluates to `true`, then the + deny rule is applied; otherwise, the deny rule is not applied. Each + deny rule is evaluated independently. If this deny rule does not + apply to a request, other deny rules might still apply. The + condition can use CEL functions that evaluate [resource + tags](https://cloud.google.com/iam/help/conditions/resource-tags). + Other functions and operators are not supported. + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleTypeExpr: + id: GoogleTypeExpr + 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + type: string + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + description: + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + location: + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + type: string + GoogleIamAdminV1AuditData: + id: GoogleIamAdminV1AuditData + description: >- + Audit log information specific to Cloud IAM admin APIs. This message is + serialized as an `Any` type in the `ServiceData` message of an + `AuditLog` message. + type: object + properties: + permissionDelta: + description: The permission_delta when when creating or updating a Role. + $ref: '#/components/schemas/GoogleIamAdminV1AuditDataPermissionDelta' + GoogleIamAdminV1AuditDataPermissionDelta: + id: GoogleIamAdminV1AuditDataPermissionDelta + description: >- + A PermissionDelta message to record the added_permissions and + removed_permissions inside a role. + type: object + properties: + addedPermissions: + description: Added permissions. + type: array + items: + type: string + removedPermissions: + description: Removed permissions. + type: array + items: + type: string + GoogleIamV1LoggingAuditData: + id: GoogleIamV1LoggingAuditData + description: >- + Audit log information specific to Cloud IAM. This message is serialized + as an `Any` type in the `ServiceData` message of an `AuditLog` message. + type: object + properties: + policyDelta: + description: Policy delta between the original policy and the newly set policy. + $ref: '#/components/schemas/GoogleIamV1PolicyDelta' + GoogleIamV1PolicyDelta: + id: GoogleIamV1PolicyDelta + description: The difference delta between two policies. + type: object + properties: + bindingDeltas: + description: The delta for Bindings between two policies. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1BindingDelta' + GoogleIamV1BindingDelta: + id: GoogleIamV1BindingDelta + description: >- + One delta entry for Binding. Each individual change (only one member in + each entry) to a binding will be a separate entry. + type: object + properties: + action: + description: The action that was performed on a Binding. Required + type: string + enumDescriptions: + - Unspecified. + - Addition of a Binding. + - Removal of a Binding. + enum: + - ACTION_UNSPECIFIED + - ADD + - REMOVE + role: + description: >- + Role that is assigned to `members`. For example, `roles/viewer`, + `roles/editor`, or `roles/owner`. Required + type: string + member: + description: >- + A single identity requesting access for a Google Cloud resource. + Follows the same format of Binding.members. Required + type: string + condition: + description: The condition that is associated with this binding. + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleIamV2PolicyOperationMetadata: + id: GoogleIamV2PolicyOperationMetadata + description: Metadata for long-running `Policy` operations. + type: object + properties: + createTime: + description: Timestamp when the `google.longrunning.Operation` was created. + type: string + format: google-datetime + GoogleIamV1betaWorkloadIdentityPoolOperationMetadata: + id: GoogleIamV1betaWorkloadIdentityPoolOperationMetadata + description: Metadata for long-running WorkloadIdentityPool operations. + type: object + properties: {} + GoogleCloudCommonOperationMetadata: + id: GoogleCloudCommonOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusDetail: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + cancelRequested: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3mainOperationMetadata: + id: GoogleIamV3mainOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3alphaOperationMetadata: + id: GoogleIamV3alphaOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3betaOperationMetadata: + id: GoogleIamV3betaOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3OperationMetadata: + id: GoogleIamV3OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + CloudControl2SharedOperationsReconciliationOperationMetadata: + id: CloudControl2SharedOperationsReconciliationOperationMetadata + description: >- + Operation metadata returned by the CLH during resource state + reconciliation. + type: object + properties: + deleteResource: + description: DEPRECATED. Use exclusive_action instead. + deprecated: true + type: boolean + exclusiveAction: + description: Excluisive action returned by the CLH. + type: string + enumDescriptions: + - Unknown repair action. + - >- + The resource has to be deleted. When using this bit, the CLH + should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE + OperationSignal in SideChannel. + - >- + This resource could not be repaired but the repair should be tried + again at a later time. This can happen if there is a dependency + that needs to be resolved first- e.g. if a parent resource must be + repaired before a child resource. + enumDeprecated: + - false + - true + - false + enum: + - UNKNOWN_REPAIR_ACTION + - DELETE + - RETRY + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + policies_policies: + id: google.iamv2.policies_policies + name: policies_policies + title: Policies_policies + methods: + list_policies: + operation: + $ref: '#/paths/~1v2~1policies~1{policiesId}~1{policiesId1}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/policies_policies/methods/list_policies + insert: [] + update: [] + replace: [] + delete: [] + policies_policy: + id: google.iamv2.policies_policy + name: policies_policy + title: Policies_policy + methods: + create_policy: + operation: + $ref: '#/paths/~1v2~1policies~1{policiesId}~1{policiesId1}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/policies_policy/methods/create_policy + update: [] + replace: [] + delete: [] + policies: + id: google.iamv2.policies + name: policies + title: Policies + methods: + get: + operation: + $ref: >- + #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/policies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete' + operations: + id: google.iamv2.operations + name: operations + title: Operations + methods: + get: + operation: + $ref: >- + #/paths/~1v2~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2/policies/{policiesId}/{policiesId1}: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Retrieves the policies of the specified kind that are attached to a + resource. The response lists only policy metadata. In particular, policy + rules are omitted. + operationId: iam.policies.listPolicies + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2ListPoliciesResponse' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a policy. + operationId: iam.policies.createPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2Policy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: query + name: policyId + schema: + type: string + /v2/policies/{policiesId}/{policiesId1}/{policiesId2}: + parameters: *ref_1 + get: + description: Gets a policy. + operationId: iam.policies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2Policy' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + put: + description: >- + Updates the specified policy. You can update only the rules and the + display name for the policy. To update a policy, you should use a + read-modify-write loop: 1. Use GetPolicy to read the current version of + the policy. 2. Modify the policy as needed. 3. Use `UpdatePolicy` to + write the updated policy. This pattern helps prevent conflicts between + concurrent updates. + operationId: iam.policies.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2Policy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + delete: + description: Deletes a policy. This action is permanent. + operationId: iam.policies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v2/policies/{policiesId}/{policiesId1}/{policiesId2}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.policies.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml b/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml new file mode 100644 index 00000000..e4269d19 --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/iamv2beta.yaml @@ -0,0 +1,1106 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Identity and Access Management (IAM) API + description: >- + Manages identity and access control for Google Cloud resources, including + the creation of service accounts, which you can use to authenticate to + Google and make API calls. Enabling this API also enables the IAM Service + Account Credentials API (iamcredentials.googleapis.com). However, disabling + this API doesn't disable the IAM Service Account Credentials API. + version: v2beta + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' +externalDocs: + url: https://cloud.google.com/iam/ +servers: + - url: https://iam.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object + properties: + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleRpcStatus: + id: GoogleRpcStatus + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + type: object + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleIamV2betaListPoliciesResponse: + id: GoogleIamV2betaListPoliciesResponse + description: Response message for `ListPolicies`. + type: object + properties: + policies: + description: Metadata for the policies that are attached to the resource. + type: array + items: + $ref: '#/components/schemas/GoogleIamV2betaPolicy' + nextPageToken: + description: >- + A page token that you can use in a ListPoliciesRequest to retrieve + the next page. If this field is omitted, there are no additional + pages. + type: string + GoogleIamV2betaPolicy: + id: GoogleIamV2betaPolicy + description: Data for an IAM policy. + type: object + properties: + name: + description: >- + Immutable. The resource name of the `Policy`, which must be unique. + Format: `policies/{attachment_point}/denypolicies/{policy_id}` The + attachment point is identified by its URL-encoded full resource + name, which means that the forward-slash character, `/`, must be + written as `%2F`. For example, + `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. + For organizations and folders, use the numeric ID in the full + resource name. For projects, requests can use the alphanumeric or + the numeric ID. Responses always contain the numeric ID. + type: string + uid: + description: >- + Immutable. The globally unique ID of the `Policy`. Assigned + automatically when the `Policy` is created. + type: string + kind: + description: >- + Output only. The kind of the `Policy`. Always contains the value + `DenyPolicy`. + readOnly: true + type: string + displayName: + description: >- + A user-specified description of the `Policy`. This value can be up + to 63 characters. + type: string + annotations: + description: >- + A key-value map to store arbitrary metadata for the `Policy`. Keys + can be up to 63 characters. Values can be up to 255 characters. + type: object + additionalProperties: + type: string + etag: + description: >- + An opaque tag that identifies the current version of the `Policy`. + IAM uses this value to help manage concurrent updates, so they do + not cause one update to be overwritten by another. If this field is + present in a CreatePolicyRequest, the value is ignored. + type: string + createTime: + description: Output only. The time when the `Policy` was created. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The time when the `Policy` was last updated. + readOnly: true + type: string + format: google-datetime + deleteTime: + description: >- + Output only. The time when the `Policy` was deleted. Empty if the + policy is not deleted. + readOnly: true + type: string + format: google-datetime + rules: + description: >- + A list of rules that specify the behavior of the `Policy`. All of + the rules should be of the `kind` specified in the `Policy`. + type: array + items: + $ref: '#/components/schemas/GoogleIamV2betaPolicyRule' + GoogleIamV2betaPolicyRule: + id: GoogleIamV2betaPolicyRule + description: A single rule in a `Policy`. + type: object + properties: + denyRule: + description: A rule for a deny policy. + $ref: '#/components/schemas/GoogleIamV2betaDenyRule' + description: + description: >- + A user-specified description of the rule. This value can be up to + 256 characters. + type: string + GoogleIamV2betaDenyRule: + id: GoogleIamV2betaDenyRule + description: A deny rule in an IAM deny policy. + type: object + properties: + deniedPrincipals: + description: >- + The identities that are prevented from using one or more permissions + on Google Cloud resources. This field can contain the following + values: * `principal://goog/subject/{email_id}`: A specific Google + Account. Includes Gmail, Cloud Identity, and Google Workspace user + accounts. For example, `principal://goog/subject/alice@example.com`. + * + `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: + A Google Cloud service account. For example, + `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. + * `principalSet://goog/group/{group_id}`: A Google group. For + example, `principalSet://goog/group/admins@example.com`. * + `principalSet://goog/public:all`: A special identifier that + represents any principal that is on the internet, even if they do + not have a Google Account or are not logged in. * + `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of + the principals associated with the specified Google Workspace or + Cloud Identity customer ID. For example, + `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific + Google Account that was deleted recently. For example, + `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. + If the Google Account is recovered, this identifier reverts to the + standard identifier for a Google Account. * + `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google + group that was deleted recently. For example, + `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. + If the Google group is restored, this identifier reverts to the + standard identifier for a Google group. * + `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: + A Google Cloud service account that was deleted recently. For + example, + `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. + If the service account is undeleted, this identifier reverts to the + standard identifier for a service account. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string + exceptionPrincipals: + description: >- + The identities that are excluded from the deny rule, even if they + are listed in the `denied_principals`. For example, you could add a + Google group to the `denied_principals`, then exclude specific users + who belong to that group. This field can contain the same values as + the `denied_principals` field, excluding + `principalSet://goog/public:all`, which represents all users on the + internet. + type: array + items: + type: string + deniedPermissions: + description: >- + The permissions that are explicitly denied by this rule. Each + permission uses the format `{service_fqdn}/{resource}.{verb}`, where + `{service_fqdn}` is the fully qualified domain name for the service. + For example, `iam.googleapis.com/roles.list`. + type: array + items: + type: string + exceptionPermissions: + description: >- + Specifies the permissions that this rule excludes from the set of + denied permissions given by `denied_permissions`. If a permission + appears in `denied_permissions` _and_ in `exception_permissions` + then it will _not_ be denied. The excluded permissions can be + specified using the same syntax as `denied_permissions`. + type: array + items: + type: string + denialCondition: + description: >- + The condition that determines whether this deny rule applies to a + request. If the condition expression evaluates to `true`, then the + deny rule is applied; otherwise, the deny rule is not applied. Each + deny rule is evaluated independently. If this deny rule does not + apply to a request, other deny rules might still apply. The + condition can use CEL functions that evaluate [resource + tags](https://cloud.google.com/iam/help/conditions/resource-tags). + Other functions and operators are not supported. + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleTypeExpr: + id: GoogleTypeExpr + 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. + type: object + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + type: string + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + description: + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + type: string + location: + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + type: string + GoogleIamAdminV1AuditData: + id: GoogleIamAdminV1AuditData + description: >- + Audit log information specific to Cloud IAM admin APIs. This message is + serialized as an `Any` type in the `ServiceData` message of an + `AuditLog` message. + type: object + properties: + permissionDelta: + description: The permission_delta when when creating or updating a Role. + $ref: '#/components/schemas/GoogleIamAdminV1AuditDataPermissionDelta' + GoogleIamAdminV1AuditDataPermissionDelta: + id: GoogleIamAdminV1AuditDataPermissionDelta + description: >- + A PermissionDelta message to record the added_permissions and + removed_permissions inside a role. + type: object + properties: + addedPermissions: + description: Added permissions. + type: array + items: + type: string + removedPermissions: + description: Removed permissions. + type: array + items: + type: string + GoogleIamV1LoggingAuditData: + id: GoogleIamV1LoggingAuditData + description: >- + Audit log information specific to Cloud IAM. This message is serialized + as an `Any` type in the `ServiceData` message of an `AuditLog` message. + type: object + properties: + policyDelta: + description: Policy delta between the original policy and the newly set policy. + $ref: '#/components/schemas/GoogleIamV1PolicyDelta' + GoogleIamV1PolicyDelta: + id: GoogleIamV1PolicyDelta + description: The difference delta between two policies. + type: object + properties: + bindingDeltas: + description: The delta for Bindings between two policies. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1BindingDelta' + GoogleIamV1BindingDelta: + id: GoogleIamV1BindingDelta + description: >- + One delta entry for Binding. Each individual change (only one member in + each entry) to a binding will be a separate entry. + type: object + properties: + action: + description: The action that was performed on a Binding. Required + type: string + enumDescriptions: + - Unspecified. + - Addition of a Binding. + - Removal of a Binding. + enum: + - ACTION_UNSPECIFIED + - ADD + - REMOVE + role: + description: >- + Role that is assigned to `members`. For example, `roles/viewer`, + `roles/editor`, or `roles/owner`. Required + type: string + member: + description: >- + A single identity requesting access for a Google Cloud resource. + Follows the same format of Binding.members. Required + type: string + condition: + description: The condition that is associated with this binding. + $ref: '#/components/schemas/GoogleTypeExpr' + GoogleIamV2betaPolicyOperationMetadata: + id: GoogleIamV2betaPolicyOperationMetadata + description: Metadata for long-running `Policy` operations. + type: object + properties: + createTime: + description: Timestamp when the `google.longrunning.Operation` was created. + type: string + format: google-datetime + GoogleIamV1betaWorkloadIdentityPoolOperationMetadata: + id: GoogleIamV1betaWorkloadIdentityPoolOperationMetadata + description: Metadata for long-running WorkloadIdentityPool operations. + type: object + properties: {} + GoogleCloudCommonOperationMetadata: + id: GoogleCloudCommonOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: >- + Output only. Server-defined resource path for the target of the + operation. + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusDetail: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + cancelRequested: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have been cancelled successfully + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3mainOperationMetadata: + id: GoogleIamV3mainOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3alphaOperationMetadata: + id: GoogleIamV3alphaOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3betaOperationMetadata: + id: GoogleIamV3betaOperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + GoogleIamV3OperationMetadata: + id: GoogleIamV3OperationMetadata + description: Represents the metadata of the long-running operation. + type: object + properties: + createTime: + description: Output only. The time the operation was created. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time the operation finished running. + readOnly: true + type: string + format: google-datetime + target: + description: Output only. Server-defined resource path for the target of the + readOnly: true + type: string + verb: + description: Output only. Name of the verb executed by the operation. + readOnly: true + type: string + statusMessage: + description: Output only. Human-readable status of the operation, if any. + readOnly: true + type: string + requestedCancellation: + description: >- + Output only. Identifies whether the user has requested cancellation + of the operation. Operations that have successfully been cancelled + have Operation.error value with a google.rpc.Status.code of 1, + corresponding to `Code.CANCELLED`. + readOnly: true + type: boolean + apiVersion: + description: Output only. API version used to start the operation. + readOnly: true + type: string + CloudControl2SharedOperationsReconciliationOperationMetadata: + id: CloudControl2SharedOperationsReconciliationOperationMetadata + description: >- + Operation metadata returned by the CLH during resource state + reconciliation. + type: object + properties: + deleteResource: + description: DEPRECATED. Use exclusive_action instead. + deprecated: true + type: boolean + exclusiveAction: + description: Excluisive action returned by the CLH. + type: string + enumDescriptions: + - Unknown repair action. + - >- + The resource has to be deleted. When using this bit, the CLH + should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE + OperationSignal in SideChannel. + - >- + This resource could not be repaired but the repair should be tried + again at a later time. This can happen if there is a dependency + that needs to be resolved first- e.g. if a parent resource must be + repaired before a child resource. + enumDeprecated: + - false + - true + - false + enum: + - UNKNOWN_REPAIR_ACTION + - DELETE + - RETRY + parameters: + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + callback: + description: JSONP + in: query + name: callback + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + x-stackQL-resources: + policies_policies: + id: google.iamv2beta.policies_policies + name: policies_policies + title: Policies_policies + methods: + list_policies: + operation: + $ref: '#/paths/~1v2beta~1policies~1{policiesId}~1{policiesId1}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.policies + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/policies_policies/methods/list_policies + insert: [] + update: [] + replace: [] + delete: [] + policies_policy: + id: google.iamv2beta.policies_policy + name: policies_policy + title: Policies_policy + methods: + create_policy: + operation: + $ref: '#/paths/~1v2beta~1policies~1{policiesId}~1{policiesId1}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/policies_policy/methods/create_policy + update: [] + replace: [] + delete: [] + policies: + id: google.iamv2beta.policies + name: policies + title: Policies + methods: + get: + operation: + $ref: >- + #/paths/~1v2beta~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: >- + #/paths/~1v2beta~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v2beta~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + insert: [] + update: [] + replace: + - $ref: '#/components/x-stackQL-resources/policies/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete' + operations: + id: google.iamv2beta.operations + name: operations + title: Operations + methods: + get: + operation: + $ref: >- + #/paths/~1v2beta~1policies~1{policiesId}~1{policiesId1}~1{policiesId2}~1operations~1{operationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/operations/methods/get' + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v2beta/policies/{policiesId}/{policiesId1}: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/_.xgafv' + get: + description: >- + Retrieves the policies of the specified kind that are attached to a + resource. The response lists only policy metadata. In particular, policy + rules are omitted. + operationId: iam.policies.listPolicies + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2betaListPoliciesResponse' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a policy. + operationId: iam.policies.createPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2betaPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: query + name: policyId + schema: + type: string + /v2beta/policies/{policiesId}/{policiesId1}/{policiesId2}: + parameters: *ref_1 + get: + description: Gets a policy. + operationId: iam.policies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2betaPolicy' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + put: + description: >- + Updates the specified policy. You can update only the rules and the + display name for the policy. To update a policy, you should use a + read-modify-write loop: 1. Use GetPolicy to read the current version of + the policy. 2. Modify the policy as needed. 3. Use `UpdatePolicy` to + write the updated policy. This pattern helps prevent conflicts between + concurrent updates. + operationId: iam.policies.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV2betaPolicy' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + delete: + description: Deletes a policy. This action is permanent. + operationId: iam.policies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + - in: query + name: etag + schema: + type: string + /v2beta/policies/{policiesId}/{policiesId1}/{policiesId2}/operations/{operationsId}: + parameters: *ref_1 + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: iam.policies.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleLongrunningOperation' + parameters: + - in: path + name: policiesId + required: true + schema: + type: string + - in: path + name: policiesId1 + required: true + schema: + type: string + - in: path + name: policiesId2 + required: true + schema: + type: string + - in: path + name: operationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml index 90ac1723..f30cd85c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/iap.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/iap.yaml @@ -7,8 +7,8 @@ info: title: Cloud Identity-Aware Proxy API description: Controls access to cloud applications running on Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/iap servers: @@ -354,8 +354,8 @@ components: $ref: '#/components/schemas/OAuthSettings' policyDelegationSettings: description: >- - Optional. Settings to configure Policy delegation for apps hosted in - tenant projects. INTERNAL_ONLY. + Optional. Settings to allow google-internal teams to use IAP for + apps hosted in a tenant project. $ref: '#/components/schemas/PolicyDelegationSettings' reauthSettings: description: Optional. Settings to configure reauthentication policies in IAP. @@ -553,6 +553,84 @@ components: additionalProperties: type: any description: Properties of the object. Contains field @type with type URL. + nextStateOfTags: + description: >- + Used for calculating the next state of tags on the resource being + passed for Custom Org Policy enforcement. NOTE: Only one of the tags + representations (i.e. numeric or namespaced) should be populated. + The input tags will be converted to the same representation before + the calculation. This behavior intentionally may differ from other + tags related fields in CheckPolicy request, which may require both + formats to be passed in. IMPORTANT: If tags are unchanged, this + field should not be set. + $ref: '#/components/schemas/NextStateOfTags' + NextStateOfTags: + id: NextStateOfTags + description: >- + Used for calculating the next state of tags on the resource being passed + for the CheckCustomConstraints RPC call. The detail evaluation of each + field is described in go/op-create-update-time-tags and + go/tags-in-orgpolicy-requests. + type: object + properties: + tagsFullState: + $ref: '#/components/schemas/TagsFullState' + tagsPartialState: + $ref: '#/components/schemas/TagsPartialState' + tagsFullStateForChildResource: + $ref: '#/components/schemas/TagsFullStateForChildResource' + TagsFullState: + id: TagsFullState + type: object + properties: + tags: + description: >- + If TagsFullState is initialized, the values in this field fully + represent all the tags in the next state (the current tag values are + not used). If tags.size() == 0, the next state of tags would be no + tags for evaluation purposes. Only one type of tags reference + (numeric or namespace) is required to be passed. + type: object + additionalProperties: + type: string + TagsPartialState: + id: TagsPartialState + type: object + properties: + tagsToUpsert: + description: >- + Tags that’ll be updated or added to the current state of tags for + evaluation purposes. If a key exists in both "tags_to_upsert" and + "tag_keys_to_remove", the one in "tag_keys_to_remove" is ignored. + Only one type of tags reference (numeric or namespace) is required + to be passed. + type: object + additionalProperties: + type: string + tagKeysToRemove: + description: >- + Keys of the tags that should be removed for evaluation purposes. + IMPORTANT: Currently only numeric references are supported. Once + support for namespace references is added, both the tag references + (numeric and namespace) will be removed. + type: array + items: + type: string + TagsFullStateForChildResource: + id: TagsFullStateForChildResource + type: object + properties: + tags: + description: >- + If TagsFullStateForChildResource is initialized, the values in this + field represent all the tags in the next state for the child + resource. Only one type of tags reference (numeric or namespace) is + required to be passed. IMPORTANT: This field should only be used + when the target resource IAM policy name is UNKNOWN and the + resource's parent IAM policy name is being passed in the request. + type: object + additionalProperties: + type: string PolicyName: id: PolicyName description: >- @@ -588,7 +666,7 @@ components: type: object properties: method: - description: Reauth method requested. + description: Optional. Reauth method requested. type: string enumDescriptions: - Reauthentication disabled. @@ -1011,16 +1089,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_1 + get_iam_policy: + operation: $ref: '#/paths/~1v1~1{v1Id}:getIamPolicy/post' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_1 - response: *ref_2 test_iam_permissions: operation: $ref: '#/paths/~1v1~1{v1Id}:testIamPermissions/post' @@ -1033,6 +1108,9 @@ components: #/components/x-stackQL-resources/iap_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/iap_iam_policies/methods/set_iam_policy delete: [] iap_iap_settings: id: google.iap.iap_iap_settings @@ -1056,7 +1134,10 @@ components: - $ref: >- #/components/x-stackQL-resources/iap_iap_settings/methods/get_iap_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/iap_iap_settings/methods/update_iap_settings + replace: [] delete: [] iap: id: google.iap.iap @@ -1073,23 +1154,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] dest_groups: id: google.iap.dest_groups name: dest_groups title: Dest_groups methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1iap_tunnel~1locations~1{locationsId}~1destGroups/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tunnelDestGroups - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: >- @@ -1126,6 +1205,7 @@ components: - $ref: '#/components/x-stackQL-resources/dest_groups/methods/create' update: - $ref: '#/components/x-stackQL-resources/dest_groups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/dest_groups/methods/delete' brands: @@ -1158,6 +1238,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/brands/methods/create' update: [] + replace: [] delete: [] identity_aware_proxy_clients: id: google.iap.identity_aware_proxy_clients @@ -1171,17 +1252,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1brands~1{brandsId}~1identityAwareProxyClients/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.identityAwareProxyClients - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -1213,12 +1291,13 @@ components: - $ref: >- #/components/x-stackQL-resources/identity_aware_proxy_clients/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/identity_aware_proxy_clients/methods/delete paths: /v1/{v1Id}:setIamPolicy: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1261,7 +1340,7 @@ paths: schema: type: string /v1/{v1Id}:getIamPolicy: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Gets the access control policy for an Identity-Aware Proxy protected @@ -1293,7 +1372,7 @@ paths: schema: type: string /v1/{v1Id}:testIamPermissions: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the Identity-Aware Proxy @@ -1325,7 +1404,7 @@ paths: schema: type: string /v1/{v1Id}:iapSettings: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets the IAP settings on a particular IAP protected resource. operationId: iap.getIapSettings @@ -1381,7 +1460,7 @@ paths: type: string format: google-fieldmask /v1/{v1Id}:validateAttributeExpression: - parameters: *ref_7 + parameters: *ref_1 post: description: Validates that a given CEL expression conforms to IAP restrictions. operationId: iap.validateAttributeExpression @@ -1408,7 +1487,7 @@ paths: schema: type: string /v1/projects/{projectsId}/iap_tunnel/locations/{locationsId}/destGroups: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists the existing TunnelDestGroups. To group across all locations, use @@ -1483,7 +1562,7 @@ paths: schema: type: string /v1/projects/{projectsId}/iap_tunnel/locations/{locationsId}/destGroups/{destGroupsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Retrieves an existing TunnelDestGroup. operationId: iap.projects.iap_tunnel.locations.destGroups.get @@ -1588,7 +1667,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/brands: - parameters: *ref_7 + parameters: *ref_1 get: description: Lists the existing brands for the project. operationId: iap.projects.brands.list @@ -1645,7 +1724,7 @@ paths: schema: type: string /v1/projects/{projectsId}/brands/{brandsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Retrieves the OAuth brand of the project. operationId: iap.projects.brands.get @@ -1673,7 +1752,7 @@ paths: schema: type: string /v1/projects/{projectsId}/brands/{brandsId}/identityAwareProxyClients: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned @@ -1744,7 +1823,7 @@ paths: schema: type: string /v1/projects/{projectsId}/brands/{brandsId}/identityAwareProxyClients/{identityAwareProxyClientsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the @@ -1813,7 +1892,7 @@ paths: schema: type: string /v1/projects/{projectsId}/brands/{brandsId}/identityAwareProxyClients/{identityAwareProxyClientsId}:resetSecret: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the diff --git a/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml b/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml index 6f9ba624..49b611c4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/identitytoolkit.yaml @@ -8,7 +8,7 @@ info: description: Help the third party sites to implement federated login. version: v3 x-discovery-doc-revision: '20180723' - x-generated-date: '2024-06-03' + x-generated-date: '2024-09-13' externalDocs: url: https://developers.google.com/identity-toolkit/v3/ servers: @@ -1540,6 +1540,7 @@ components: - $ref: >- #/components/x-stackQL-resources/relyingparty_auth_uri/methods/create_auth_uri update: [] + replace: [] delete: [] relyingparty_account: id: google.identitytoolkit.relyingparty_account @@ -1556,7 +1557,10 @@ components: select: [] insert: [] update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/relyingparty_account/methods/delete_account relyingparty: id: google.identitytoolkit.relyingparty name: relyingparty @@ -1644,6 +1648,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] relyingparty_account_info: id: google.identitytoolkit.relyingparty_account_info @@ -1657,9 +1662,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/relyingparty_account_info/methods/get_account_info insert: [] update: [] + replace: [] delete: [] relyingparty_oob_confirmation_code: id: google.identitytoolkit.relyingparty_oob_confirmation_code @@ -1673,9 +1681,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/relyingparty_oob_confirmation_code/methods/get_oob_confirmation_code insert: [] update: [] + replace: [] delete: [] relyingparty_project_config: id: google.identitytoolkit.relyingparty_project_config @@ -1694,6 +1705,7 @@ components: #/components/x-stackQL-resources/relyingparty_project_config/methods/get_project_config insert: [] update: [] + replace: [] delete: [] relyingparty_public_keys: id: google.identitytoolkit.relyingparty_public_keys @@ -1710,6 +1722,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] relyingparty_recaptcha_param: id: google.identitytoolkit.relyingparty_recaptcha_param @@ -1728,6 +1741,7 @@ components: #/components/x-stackQL-resources/relyingparty_recaptcha_param/methods/get_recaptcha_param insert: [] update: [] + replace: [] delete: [] paths: /createAuthUri: diff --git a/providers/src/googleapis.com/v00.00.00000/services/ids.yaml b/providers/src/googleapis.com/v00.00.00000/services/ids.yaml index 05c0eb2f..aacb7bf0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ids.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ids.yaml @@ -12,8 +12,8 @@ info: When you use this product, your organization name and consumption levels will be shared with Palo Alto Networks. version: v1 - x-discovery-doc-revision: '20240514' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240815' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/ servers: @@ -772,16 +772,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -794,23 +791,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.ids.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -838,6 +833,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' endpoints: @@ -845,17 +841,14 @@ components: name: endpoints title: Endpoints methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.endpoints - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -892,6 +885,7 @@ components: - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' update: - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' endpoints_iam_policies: @@ -906,17 +900,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpoints~1{endpointsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -930,10 +921,13 @@ components: #/components/x-stackQL-resources/endpoints_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/endpoints_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -980,7 +974,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: ids.projects.locations.get @@ -1008,7 +1002,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1051,7 +1045,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1122,7 +1116,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1169,7 +1163,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/endpoints: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists Endpoints in a given project and location. operationId: ids.projects.locations.endpoints.list @@ -1253,7 +1247,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a single Endpoint. operationId: ids.projects.locations.endpoints.get @@ -1366,7 +1360,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -1407,7 +1401,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -1447,7 +1441,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml index 6920f1bf..5e15f2ca 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/integrations.yaml @@ -7,8 +7,8 @@ info: title: Application Integration API description: '' version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240902' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/application-integration servers: @@ -34,62 +34,74 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - EnterpriseCrmEventbusProtoEventParameters: - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see - id: EnterpriseCrmEventbusProtoEventParameters - properties: - parameters: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - type: object - GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: - type: object - id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse - properties: - content: - description: String representation of the requested file. - type: string - files: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' - description: List containing String represendation for multiple file with type. - type: array - description: Response for DownloadIntegrationVersion. - EnterpriseCrmEventbusProtoParameterMap: + CrmlogErrorCode: + id: CrmlogErrorCode type: object properties: - entries: - type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' - keyType: - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + commonErrorCode: + enumDeprecated: + - false + - true + - false + - false + - true + - true + - true + - false + - false + - true + - false + - false + - false + - false + - true + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false + - false enumDescriptions: - '' - '' @@ -105,19 +117,9 @@ components: - '' - '' - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - '' - '' - '' - type: string - description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. - valueType: - enumDescriptions: - '' - '' - '' @@ -132,71 +134,269 @@ components: - '' - '' - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. + ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use + only. This error will be counted as server availability error. + - '' + - '' - '' - '' - '' - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE type: string - id: EnterpriseCrmEventbusProtoParameterMap + enum: + - COMMON_ERROR_CODE_UNSPECIFIED + - INVALID_CREDENTIALS + - REQUIRED_FIELDS_MISSING + - INVALID_FIELDS + - BACKEND + - GENERAL + - INTERNAL + - IO_ERROR + - NOT_FOUND + - EVENT_BUS + - ALREADY_EXISTS + - CONCORD + - CONVERSION + - FLUME + - PERMISSION + - SALES_FORCE + - SPANNER + - UNIMPLEMENTED + - RELTIO + - WORKFLOW_NOT_FOUND + - QUOTA_THROTTLED + - QUOTA_ENQUEUED + - INVALID_QUOTA_CONFIGURATION + - TASK_NOT_FOUND + - EXECUTION_TIMEOUT + - INVALID_EVENT_EXECUTION_STATE + - INVALID_ATTRIBUTE + - MISSING_ATTRIBUTE + - CLIENT_UNAUTHORIZED_FOR_WORKFLOW + - INVALID_PARAMETER + - MISSING_PARAMETER + - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION + - FAILED_PRECONDITION + - INVALID_CLIENT + - MISSING_CLIENT + - INVALID_WORKFLOW + - MISSING_QUOTA_CONFIGURATION + - UNHANDLED_TASK_ERROR + - SCRIPT_TASK_RUNTIME_ERROR + - RPC + - INVALID_PROTO + - UNHANDLED_EVENTBUS_ERROR + - INVALID_TASK_STATE + - TYPED_TASK_INVALID_INPUT_OPERATION + - TYPED_TASK_INVALID_OUTPUT_OPERATION + - VALIDATION_ERROR + - RESUME_ERROR + - APPS_SCRIPT_EXECUTION_ERROR + - INVALID_VECTOR_USER + - INFORMATICA + - RETRYABLE_TASK_ERROR + - INVALID_TENANT + - WRONG_TENANT + - INFORMATICA_BACKEND_UNAVAILABLE + - RPC_PERMISSION_DENIED + - SYNC_EVENTBUS_EXECUTION_TIMEOUT + - ASYNC_EVENTBUS_EXECUTION_TIMEOUT + - NOT_SUPPORTED_DATA_TYPE + - UNSANITIZED_USER_INPUT + - TRANSFORM_EXPRESSION_EVALUATION_ERROR + - HTTP_EXCEPTION + - EXECUTION_CANCELLED description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - GoogleCloudIntegrationsV1alphaCoordinate: - id: GoogleCloudIntegrationsV1alphaCoordinate + Registered ids for errors, as "oneof" enums. Each task or logical + grouping of tasks may share the same enum. + GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: + description: The response for executing an integration. + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + type: object properties: - 'y': - format: int32 - type: integer - description: Required. Y axis of the coordinate - x: - format: int32 - type: integer - description: Required. X axis of the coordinate - description: Configuration detail of coordinate, it used for UI + executionInfoIds: + items: + type: string + type: array + description: The execution info id for the executed integrations. + GoogleCloudIntegrationsV1alphaGenerateTokenResponse: + id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse type: object - GoogleCloudIntegrationsV1alphaUsernameAndPassword: properties: - password: + message: type: string - description: Password to be used - username: - description: Username to be used + description: The message that notifies the user if the request succeeded or not. + description: Returns success or error message + EnterpriseCrmEventbusProtoParameterValueType: + type: object + id: EnterpriseCrmEventbusProtoParameterValueType + properties: + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' + booleanValue: + type: boolean + stringValue: type: string - id: GoogleCloudIntegrationsV1alphaUsernameAndPassword + protoArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter + intValue: + type: string + format: int64 + protoValue: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + doubleValue: + type: number + format: double + booleanArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' + description: >- + LINT.IfChange To support various types of parameter values. Next + available id: 14 + GoogleCloudIntegrationsV1alphaDownloadTemplateResponse: + id: GoogleCloudIntegrationsV1alphaDownloadTemplateResponse + properties: + content: + type: string + description: String representation of the template. + type: object + description: Response for DownloadTemplate. + EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: + id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + type: object + properties: + objectValue: + format: byte + type: string + GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: + description: 'The request for scheduling an integration. Next available id: 11' + properties: + userGeneratedExecutionId: + type: string + description: >- + Optional. This is a unique id provided by the method caller. If + provided this will be used as the execution_id when a new execution + info is created. This is a string representation of a UUID. Must + have no more than 36 characters and contain only alphanumeric + characters and hyphens. + inputParameters: + description: Optional. Input parameters used by integration execution. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + parameters: + description: Passed in as parameters to each integration execution. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + deprecated: true + triggerId: + description: >- + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) + type: string + requestId: + type: string + description: >- + This is used to de-dup incoming request: if the duplicate request + was detected, the response from the previous execution is returned. + scheduleTime: + type: string + format: google-datetime + description: >- + The time that the integration should be executed. If the time is + less or equal to the current time, the integration is executed + immediately. + parameterEntries: + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + type: array + deprecated: true + id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + type: object + EnterpriseCrmFrontendsEventbusProtoEventParameters: + properties: + parameters: + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same workflow + execution. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + id: EnterpriseCrmFrontendsEventbusProtoEventParameters type: object - description: Username and password pair. - EnterpriseCrmEventbusProtoCloudLoggingDetails: - id: EnterpriseCrmEventbusProtoCloudLoggingDetails description: >- - Cloud Logging details, selected by the user for the integration version - (workflow). This message field will be also used in ExecutionInfo, to - indicate the CloudLoggingDetails config at the time of workflow - (integration version) execution, since this field value can be changed - for an unpublished workflow. + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged: + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + description: >- + Parameters to support Oauth 2.0 Auth Code Grant Authentication using + Google Provided OAuth Client. See + https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. + properties: + scopes: + items: + type: string + type: array + description: >- + Required. Scopes the connection will request when the user performs + the auth code flow. + authCode: + type: string + description: >- + Optional. Authorization code to be exchanged for access and refresh + tokens. + redirectUri: + description: Optional. Redirect URI to be provided during the auth code exchange. + type: string + type: object + GoogleCloudIntegrationsV1alphaCloudLoggingDetails: + type: object + description: Cloud Logging details for execution info properties: cloudLoggingSeverity: + type: string enumDescriptions: - Unspecified - >- @@ -211,551 +411,770 @@ components: If Severity selected is `WARNING`, then only the following Integration Execution States (`ERROR`, `CANCELLED`) will be sent to Cloud Logging. + description: >- + Optional. Severity selected by the customer for the logs to be sent + to Cloud Logging, for the integration version getting executed. enum: - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - INFO - ERROR - WARNING - type: string - description: >- - Severity selected by the customer for the logs to be sent to Cloud - Logging, for the integration version getting executed. enableCloudLogging: + type: boolean description: >- - Status of whether Cloud Logging is enabled or not for the + Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed. - type: boolean + id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails + EnterpriseCrmEventbusProtoStringArrayFunction: + id: EnterpriseCrmEventbusProtoStringArrayFunction type: object - EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: properties: - gaiaId: - type: string - format: int64 - emailAddress: + functionName: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: type: object - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - GoogleCloudIntegrationsV1alphaIntegrationParameter: + description: Request for PublishIntegrationVersion. properties: - jsonSchema: + configParameters: + additionalProperties: + type: any + description: Properties of the object. + type: object + description: Optional. Config parameters used during integration execution. + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + EnterpriseCrmEventbusProtoWorkflowAlertConfig: + type: object + properties: + playbookUrl: type: string description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - inputOutputType: + Link to a playbook for resolving the issue that triggered this + alert. + aggregationPeriod: type: string + description: >- + For an EXPECTED_MIN threshold, this aggregation_period must be + lesser than 24 hours. + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + thresholdType: enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT - description: Specifies the input/output type for the parameter. + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX enumDescriptions: - - Default. - - >- - Input parameters for the integration. EventBus validates that - these parameters exist in the integrations before execution. - - >- - Output Parameters for the integration. EventBus will only return - the integration parameters tagged with OUT in the response back. + - '' - >- - Input and Output Parameters. These can be used as both input and - output. EventBus will validate for the existence of these - parameters before execution and will also return this parameter - back in the response. - isTransient: - type: boolean - description: Whether this parameter is a transient parameter. - masked: - description: True if this parameter should be masked in the logs - type: boolean - key: + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. + - '' type: string description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - producer: + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. + alertDisabled: + type: boolean description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + thresholdValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + description: >- + The metric value, above or below which the alert should be + triggered. + durationThresholdMs: type: string - searchable: - type: boolean - description: Searchable in the execution log or not. - containsLargeData: + format: int64 + description: >- + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. + metricType: + type: string + enumDescriptions: + - >- + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. + - >- + Specifies alerting on the rate of errors for the enclosing + workflow. + - >- + Specifies alerting on the rate of warnings for the enclosing + workflow. Warnings use the same enum values as errors. + - >- + Specifies alerting on the rate of errors for any task in the + enclosing workflow. + - >- + Specifies alerting on the rate of warnings for any task in the + enclosing workflow. + - >- + Specifies alerting on the rate of executions over all tasks in the + enclosing workflow. + - >- + Specifies alerting on the number of events executed in the given + aggregation_period. + - >- + Specifies alerting on the average duration of executions for this + workflow. + - >- + Specifies alerting on the duration value of a particular + percentile of workflow executions. E.g. If 10% or more of the + workflow executions have durations above 5 seconds, alert. + - >- + Specifies alerting on the average duration of any task in the + enclosing workflow, + - >- + Specifies alerting on the duration value of a particular + percentile of any task executions within the enclosing workflow. + E.g. If 10% or more of the task executions in the workflow have + durations above 5 seconds, alert. + enum: + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + onlyFinalAttempt: type: boolean description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - displayName: + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + alertName: description: >- - The name (without prefix) to be displayed in the UI for this - parameter. E.g. if the key is "foo.bar.myName", then the name would - be "myName". + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique within the scope of the + workflow. type: string - dataType: - description: Type of the parameter. + numAggregationPeriods: + type: integer + description: >- + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + format: int32 + clientId: + description: Client associated with this alert configuration. + type: string + id: EnterpriseCrmEventbusProtoWorkflowAlertConfig + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. + GoogleCloudConnectorsV1ConnectionStatus: + id: GoogleCloudConnectorsV1ConnectionStatus + properties: + status: + description: Status provides detailed information for the state. + type: string + state: + description: State. + type: string + enumDescriptions: + - Connection does not have a state yet. + - Connection is being created. + - Connection is running and ready for requests. + - Connection is stopped. + - Connection is being deleted. + - Connection is being updated. + - Connection is not running due to an error. + - >- + Connection is not running because the authorization configuration + is not complete. enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STATE_UNSPECIFIED + - CREATING + - ACTIVE + - INACTIVE + - DELETING + - UPDATING + - ERROR + - AUTHORIZATION_REQUIRED + description: + type: string + description: Description. + type: object + description: ConnectionStatus indicates the state of the connection. + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: + properties: + content: + type: string + description: The textproto of the integration_version. + fileFormat: + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + type: string + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + description: File format for upload request. + type: object + description: Request for UploadIntegrationVersion. + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + GoogleCloudIntegrationsV1alphaUploadTemplateResponse: + description: Response for UploadTemplate. + properties: + template: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + description: The uploaded Template + id: GoogleCloudIntegrationsV1alphaUploadTemplateResponse + type: object + EnterpriseCrmEventbusProtoParameterMap: + properties: + entries: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapEntry' + keyType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + enum: + - DATA_TYPE_UNSPECIFIED - STRING_VALUE - INT_VALUE - DOUBLE_VALUE - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE - STRING_ARRAY - INT_ARRAY - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT - JSON_VALUE + type: string + description: >- + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. + valueType: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY - PROTO_ARRAY - type: string + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - defaultValue: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - type: object - id: GoogleCloudIntegrationsV1alphaIntegrationParameter + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + type: string description: >- - Integration Parameter is defined in the integration config and are used - to provide information about data types of the expected parameters and - provide any default values if needed. They can also be used to add - custom attributes. These are static in nature and should not be used for - dynamic event definition. - GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. + type: object + id: EnterpriseCrmEventbusProtoParameterMap + GoogleCloudIntegrationsV1alphaProjectProperties: + id: GoogleCloudIntegrationsV1alphaProjectProperties type: object + description: Metadata information for the given project properties: - name: - readOnly: true - description: Output only. Name of the Webhook + ipEnablementState: + enum: + - IP_ENABLEMENT_STATE_UNSPECIFIED + - IP_ENABLEMENT_STATE_STANDALONE + - IP_ENABLEMENT_STATE_APIGEE + - IP_ENABLEMENT_STATE_APIGEE_ENTITLED + description: An enum value of what the enablement state is for the given project + enumDescriptions: + - The client enablement status is unspecified + - The client is enabled on Standalone IP + - The client is enabled on Apigee + - The client is entitled for Apigee but not enabled type: string - nextRefreshTime: + billingType: + enumDescriptions: + - '' + - A trial org provisioned through Apigee Provisioning Wizard + - >- + Subscription based on concurrency model for Apigee and Application + Integration users. + - Consumption based users of IP + - >- + Argentum subscription for Application Integration users. To be + used in the future. + - >- + Special billing type to avoid any billing to clients (eg: trusted + tester program). This should not be used without consulting with + the leads. + enum: + - BILLING_TYPE_UNSPECIFIED + - APIGEE_TRIALS + - APIGEE_SUBSCRIPTION + - PAYG + - SUBSCRIPTION + - NO_BILLING + description: 'Required. Required: The client billing type that was requested' type: string - format: google-datetime - readOnly: true - description: >- - Output only. Next webhook refresh time. Will be null if refresh is - not supported. - additionalVariables: - type: array - readOnly: true + provisionedRegions: items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - description: Output only. Additional webhook related field values. - id: - description: Output only. ID to uniquely identify webhook. - readOnly: true + type: string + type: array + description: A list of provisioned regions on the current project + EnterpriseCrmEventbusProtoAddress: + properties: + name: type: string - createTime: - readOnly: true + email: type: string + description: Required. + tokens: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' + type: array + description: >- + Email address along with optional name and tokens. These tokens will be + substituted for the variables in the form of [{var_name}], where + var_name could be any string of no more than 32 bytes. + type: object + id: EnterpriseCrmEventbusProtoAddress + GoogleCloudIntegrationsV1alphaSuspension: + id: GoogleCloudIntegrationsV1alphaSuspension + properties: + approvalConfig: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + description: >- + Controls the notifications and approval permissions for this + suspension. + createTime: format: google-datetime - description: Output only. Timestamp when the webhook was created. - updateTime: type: string - format: google-datetime + description: Output only. Auto-generated. readOnly: true - description: Output only. Timestamp when the webhook was last updated. - id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - description: WebhookData has details of webhook configuration. - GoogleCloudIntegrationsV1alphaExecutionDetails: - id: GoogleCloudIntegrationsV1alphaExecutionDetails - properties: - eventExecutionSnapshotsSize: + integration: + description: Required. The name of the originating integration. type: string - format: int64 - description: Total size of all event_execution_snapshots for an execution - executionSnapshots: - type: array - description: List of snapshots taken during the execution. - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot - attemptStats: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - description: List of Start and end time of the execution attempts. + eventExecutionInfoId: + description: Required. ID of the associated execution. + type: string + name: + type: string + description: Resource name for suspensions suspension/{suspension_id} + taskId: + type: string + description: Required. Task id of the associated SuspensionTask. state: + type: string + description: >- + Required. State of this suspension, indicating what action a + resolver has taken. enumDescriptions: - - Default. - - Execution is scheduled and awaiting to be triggered. - - Execution is processing. - - >- - Execution successfully finished. There's no more change after this - state. - - Execution failed. There's no more change after this state. - - >- - Execution canceled by user. There's no more change after this - state. - - Execution failed and waiting for retry. - - Execution suspended and waiting for manual intervention. - description: Status of the execution. + - Unset state. + - The suspension has not yet been resolved. + - The resolver has rejected the suspension. + - The resolver has lifted the suspension. enum: - - STATE_UNSPECIFIED + - RESOLUTION_STATE_UNSPECIFIED - PENDING - - PROCESSING - - SUCCEEDED - - FAILED - - CANCELLED - - RETRY_ON_HOLD - - SUSPENDED + - REJECTED + - LIFTED + suspensionConfig: + deprecated: true + description: >- + Controls the notifications and resolver permissions for this + suspension. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + lastModifyTime: type: string - description: >- - Contains the details of the execution info: this includes the tasks - execution details plus the event execution statistics. + description: Output only. Auto-generated. + readOnly: true + format: google-datetime + audit: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' + description: Metadata pertaining to the resolution of this suspension. + description: A record representing a suspension. type: object - EnterpriseCrmEventbusProtoAddress: + EnterpriseCrmEventbusProtoValueType: type: object description: >- - Email address along with optional name and tokens. These tokens will be - substituted for the variables in the form of [{var_name}], where - var_name could be any string of no more than 32 bytes. - id: EnterpriseCrmEventbusProtoAddress + Used for define type for values. Currently supported value types include + int, string, double, array, and any proto message. properties: - tokens: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoToken' - type: array - name: + protoValue: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + doubleArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' + doubleValue: + format: double + type: number + stringArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' + intArray: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' + stringValue: type: string - email: - description: Required. + intValue: + format: int64 type: string - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: + booleanValue: + type: boolean + id: EnterpriseCrmEventbusProtoValueType + EnterpriseCrmEventbusProtoFailurePolicy: + id: EnterpriseCrmEventbusProtoFailurePolicy properties: - authConfigId: + retryCondition: description: >- - The auth config id necessary to fetch the necessary credentials to - create the project for external clients + Optional. The retry condition that will be evaluated for this + failure policy with the corresponding retry strategy. type: string - appsScriptProject: + retryStrategy: type: string - description: The name of the Apps Script project to be created. - description: Request for CreateAppsScriptProject rpc call. - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest - type: object - EnterpriseCrmEventbusProtoProtoParameterArray: - id: EnterpriseCrmEventbusProtoProtoParameterArray - type: object - properties: - protoValues: - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - type: array - EnterpriseCrmEventbusProtoProtoArrayFunction: - type: object - properties: - functionName: + description: Defines what happens to the task upon failure. enumDescriptions: - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: string + - >- + Ignores the failure of this task. The rest of the workflow will be + executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the workflow. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. + Max_num_retries and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. Max_num_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_num_retries` and `interval_in_seconds` must be specified. + - >- + The entire workflow will be restarted with the initial parameters + that were set when the event was fired. A max-retry count is + required to be specified with this strategy. `max_num_retries` and + `interval_in_seconds` must be specified. enum: - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - id: EnterpriseCrmEventbusProtoProtoArrayFunction - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_WORKFLOW_WITH_BACKOFF + intervalInSeconds: + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the initial interval for backoff. + type: string + format: int64 + maxNumRetries: + type: integer + format: int32 + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. + description: >- + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). + type: object + GoogleCloudIntegrationsV1alphaRuntimeActionSchema: type: object properties: - scriptId: + action: + description: Name of the action. type: string - description: The id of the linked Apps Script project. - description: Response for LinkAppsScriptProject rpc call. - EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + outputSchema: + description: Output parameter schema for the action. + type: string + inputSchema: + type: string + description: Input parameter schema for the action. + id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema + description: Metadata of an action, including schemas for its inputs and outputs. + EnterpriseCrmEventbusProtoExternalTraffic: + type: object + id: EnterpriseCrmEventbusProtoExternalTraffic + description: Represents external traffic type and id. properties: - snapshotTime: - format: int64 - description: Indicates when this snapshot is taken. + retryRequestForQuota: + description: Enqueue the execution request due to quota issue + type: boolean + gcpProjectNumber: type: string - conditionResults: - description: All of the computed conditions that been calculated. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - type: array - checkpointTaskNumber: - description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. + description: User’s GCP project number the traffic is referring to. + location: + description: Location for the user's request. type: string - eventParams: - description: The parameters in Event object. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - taskExecutionDetails: - description: All of the task execution details at the given point of time. - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - type: array - eventExecutionSnapshotId: + gcpProjectId: type: string - description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - diffParams: - description: The parameters in Event object that differs from last snapshot. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - taskName: - description: The task name associated with this snapshot. Could be empty. + description: User’s GCP project id the traffic is referring to. + source: type: string - deprecated: true - eventExecutionSnapshotMetadata: + enum: + - SOURCE_UNSPECIFIED + - APIGEE + - SECURITY + enumDescriptions: + - '' + - '' + - '' + enableInternalIp: + type: boolean + description: >- + Indicates the client enables internal IP feature, this is applicable + for internal clients only. + GoogleCloudConnectorsV1EventingConfig: + properties: + deadLetterConfig: + description: Optional. Dead letter configuration for eventing of a connection. $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - eventExecutionInfoId: - description: Points to the event execution info this snapshot belongs to. + #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + proxyDestinationConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + description: Optional. Proxy for Eventing auto-registration. + authConfig: + description: Auth details for the webhook adapter. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + eventsListenerIngressEndpoint: type: string + description: >- + Optional. Ingress endpoint of the event listener. This is used only + when private connectivity is enabled. + enrichmentEnabled: + type: boolean + description: Enrichment Enabled. + additionalVariables: + description: Additional eventing related field values + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + type: array + registrationDestinationConfig: + description: Registration endpoint for auto registration. + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + privateConnectivityEnabled: + description: Optional. Private Connectivity Enabled. + type: boolean + listenerAuthConfig: + description: Optional. Auth details for the event listener. + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + id: GoogleCloudConnectorsV1EventingConfig + description: Eventing Configuration of a connection type: object - GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: - id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: + id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse properties: - scriptId: + nextPageToken: type: string - description: The id of the Apps Script project to be linked. - description: Request for LinkAppsScriptProject rpc call. - type: object - GoogleCloudIntegrationsV1alphaExecution: + description: The token used to retrieve the next page of results. + sfdcInstances: + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + type: array + description: The list of SfdcInstances retrieved. + description: Response to list SfdcInstances. type: object - description: >- - The Execution resource contains detailed information of an individual - integration execution. + EnterpriseCrmEventbusProtoTransformExpression: properties: - responseParams: + transformationFunctions: + description: Transformations to be applied sequentially. + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' type: array + initialValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' + description: Initial value upon which to perform transformations. + id: EnterpriseCrmEventbusProtoTransformExpression + type: object + EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + properties: + doubleValues: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: Event parameters come out as part of the response. - deprecated: true - integrationVersionState: - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT - description: Output only. State of the integration version - readOnly: true - type: string - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - name: - type: string - description: Auto-generated primary key. - requestParams: - description: Event parameters come in as part of the request. - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: array - executionDetails: - description: Detailed info of this execution. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' - triggerId: - type: string - description: >- - The trigger id of the integration trigger config. If both trigger_id - and client_id is present, the integration is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. - replayInfo: - description: Output only. Replay info for the execution - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo - directSubExecutions: - description: Direct sub executions of the following Execution. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + type: number + format: double type: array - updateTime: - description: Output only. Last modified time of the execution. - readOnly: true - type: string - format: google-datetime - createTime: - type: string - description: Output only. Created time of the execution. - readOnly: true - format: google-datetime - responseParameters: - type: object - description: Event parameters returned as part of the response. - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - executionMethod: - type: string - description: The ways user posts this event. - enum: - - EXECUTION_METHOD_UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - enumDescriptions: - - Default value. - - Sync post. - - Async post. - - Async post with schedule time. - requestParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Event parameters come in as part of the request. - type: object - eventExecutionDetails: - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' - description: The execution info about this event. - cloudLoggingDetails: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - description: Cloud Logging details for the integration version - snapshotNumber: - format: int64 - type: string - readOnly: true - description: >- - Output only. An increasing sequence that is set when a new snapshot - is created - id: GoogleCloudIntegrationsV1alphaExecution - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: - description: Range used to validate longs and ints. - properties: - max: - type: string - format: int64 - description: The inclusive maximum of the acceptable range. - min: - format: int64 - description: The inclusive minimum of the acceptable range. - type: string - type: object - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - EnterpriseCrmEventbusProtoStringParameterArray: type: object - id: EnterpriseCrmEventbusProtoStringParameterArray + GoogleCloudIntegrationsV1alphaIntParameterArray: + id: GoogleCloudIntegrationsV1alphaIntParameterArray properties: - stringValues: - type: array + intValues: + description: Integer array. items: type: string - GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: + format: int64 + type: array + description: This message only contains a field of integer array. + type: object + EnterpriseCrmEventbusProtoParamSpecEntryConfig: + id: EnterpriseCrmEventbusProtoParamSpecEntryConfig properties: - clientId: - description: The client's id. + descriptivePhrase: type: string - applyReauthPolicy: - description: >- - Indicates if the user has opted in Google Reauth Policy. If opted - in, the refresh token will be valid for 20 hours, after which time - users must re-authenticate in order to obtain a new one. - type: boolean - accessToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - description: The access token received from the token endpoint. - authCode: - description: The Auth Code that is used to initially retrieve the access token. + description: A short phrase to describe what this parameter contains. + label: type: string - clientSecret: - description: The client's secret. + description: A user-friendly label for the parameter. + inputDisplayOption: type: string - requestType: enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. + A single-line input for strings, a numeric input box for numbers, + or a checkbox for booleans. + - A multi-line input box for longer strings/string templates. + - >- + A slider to select a numerical value. The default range is [0, + 100]. + - A toggle button for boolean parameters. enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - type: string - description: Represent how to pass parameters to fetch access token - scope: + - DEFAULT + - STRING_MULTI_LINE + - NUMBER_SLIDER + - BOOLEAN_TOGGLE + hideDefaultValue: + type: boolean + description: Whether the default value is hidden in the UI. + subSectionLabel: type: string - description: A space-delimited list of requested scope permissions. - tokenParams: - description: The token parameters sent along with the token request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - authEndpoint: - description: The auth url endpoint to send the auth code request to. + description: >- + A user-friendly label for subSection under which the parameter will + be displayed. + helpText: type: string - tokenEndpoint: - description: The token url endpoint to send the token request to. + description: >- + Detailed help text for this parameter containing information not + provided elsewhere. For example, instructions on how to migrate from + a deprecated parameter. + uiPlaceholderText: + description: >- + Placeholder text which will appear in the UI input form for this + parameter. type: string - authParams: - description: The auth parameters sent along with the auth code request. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: >- - The OAuth Type where the client sends request with the client id and - requested scopes to auth endpoint. User sees a consent screen and auth - code is received at specified redirect url afterwards. The auth code is - then combined with the client id and secret and sent to the token - endpoint in exchange for the access and refresh token. The refresh token - can be used to fetch new access tokens. - id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - type: object - EnterpriseCrmEventbusProtoParamSpecEntryConfig: - id: EnterpriseCrmEventbusProtoParamSpecEntryConfig - properties: + isHidden: + type: boolean + description: Whether this field is hidden in the UI. parameterNameOption: - type: string enum: - DEFAULT_NOT_PARAMETER_NAME - IS_PARAMETER_NAME - KEY_IS_PARAMETER_NAME - VALUE_IS_PARAMETER_NAME + type: string enumDescriptions: - This field is not a parameter name. - >- @@ -771,1208 +1190,752 @@ components: If this field is a ParameterMap and this option is selected, the map's values will be interpreted as parameter names. Ignored if this field is not a ParameterMap. - helpText: - description: >- - Detailed help text for this parameter containing information not - provided elsewhere. For example, instructions on how to migrate from - a deprecated parameter. - type: string - hideDefaultValue: - type: boolean - description: Whether the default value is hidden in the UI. - descriptivePhrase: - description: A short phrase to describe what this parameter contains. - type: string - uiPlaceholderText: + type: object + GoogleCloudConnectorsV1ConfigVariable: + type: object + id: GoogleCloudConnectorsV1ConfigVariable + properties: + intValue: type: string - description: >- - Placeholder text which will appear in the UI input form for this - parameter. - subSectionLabel: + description: Value is an integer + format: int64 + encryptionKeyValue: + $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' + description: Value is a Encryption Key. + key: + description: Key of the config variable. type: string - description: >- - A user-friendly label for subSection under which the parameter will - be displayed. - inputDisplayOption: + stringValue: + description: Value is a string. type: string - enum: - - DEFAULT - - STRING_MULTI_LINE - - NUMBER_SLIDER - - BOOLEAN_TOGGLE - enumDescriptions: - - >- - A single-line input for strings, a numeric input box for numbers, - or a checkbox for booleans. - - A multi-line input box for longer strings/string templates. - - >- - A slider to select a numerical value. The default range is [0, - 100]. - - A toggle button for boolean parameters. - isHidden: - description: Whether this field is hidden in the UI. + secretValue: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Value is a secret. + boolValue: + description: Value is a bool. type: boolean - label: - description: A user-friendly label for the parameter. - type: string - type: object - EnterpriseCrmFrontendsEventbusProtoParameterMap: description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. - type: object - id: EnterpriseCrmFrontendsEventbusProtoParameterMap + ConfigVariable represents a configuration variable present in a + Connection. or AuthConfig. + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: properties: - valueType: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' + taskName: + description: the task name associated with this snapshot. Could be empty. type: string - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - entries: + ancestorIterationNumbers: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + type: string type: array - keyType: + description: >- + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') + taskLabel: + description: the task label associated with this snapshot. Could be empty. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' + ancestorTaskNumbers: + type: array description: >- - Option to specify key value type for all entries of the map. If - provided then field types for all entries must conform to this. - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + items: + type: string + integrationName: + type: string + description: >- + The direct integration which the event execution snapshots belongs + to + eventAttemptNum: + description: the event attempt number this snapshot belongs to. + format: int32 + type: integer + taskNumber: + type: string + description: The task number associated with this snapshot. Could be empty. + taskAttemptNum: + description: the task attempt number this snapshot belongs to. Could be empty. + type: integer + format: int32 type: object - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + id: >- + EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + GoogleCloudIntegrationsV1alphaErrorCatcherConfig: properties: - children: - description: >- - Child parameters nested within this parameter. This field only - applies to protobuf parameters + startErrorTasks: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' type: array - jsonSchema: - type: string description: >- - This schema will be used to validate runtime JSON-typed values of - this parameter. - isTransient: - description: Whether this parameter is a transient parameter. - type: boolean - key: + Required. The set of start tasks that are to be executed for the + error catch flow + position: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + description: type: string description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. - defaultValue: + Optional. User-provided description intended to give more business + context about the error catcher config. + label: + type: string description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - inOutType: - description: Specifies the input/output type for the parameter. - enum: - - IN_OUT_TYPE_UNSPECIFIED - - IN - - OUT - - IN_OUT + Optional. The user created label for a particular error catcher. + Optional. + errorCatcherNumber: type: string - enumDescriptions: - - '' - - >- - Input parameters for the workflow. EventBus validates that these - parameters exist in the workflows before execution. - - >- - Output Parameters for the workflow. EventBus will only return the - workflow parameters tagged with OUT in the response back. - - >- - Input or Output Parameters. These can be used as both input and - output. EventBus will validate for the existence of these - parameters before execution and will also return this parameter - back in the response. - description: + description: >- + Required. A number to uniquely identify each error catcher config + within the workflow on UI. + errorCatcherId: type: string - description: Optional. The description about the parameter - protoDefPath: + description: >- + Required. An error catcher id is string representation for the error + catcher config. Within a workflow, error_catcher_id uniquely + identifies an error catcher config among all error catcher configs + for the workflow + type: object + id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig + description: Configuration detail of a error catch task + GoogleCloudIntegrationsV1alphaAccessToken: + properties: + accessToken: type: string description: >- - If the data type is of type proto or proto array, this field needs - to be populated with the fully qualified proto name. This message, - for example, would be - "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". - name: + The access token encapsulating the security identity of a process or + thread. + refreshTokenExpireTime: + format: google-datetime + description: The approximate time until the refresh token retrieved is valid. + type: string + tokenType: + type: string description: >- - The name (without prefix) to be displayed in the UI for this - parameter. E.g. if the key is "foo.bar.myName", then the name would - be "myName". + Only support "bearer" token in v1 as bearer token is the predominant + type used with OAuth 2.0. + refreshToken: type: string - required: - type: boolean - containsLargeData: - type: boolean description: >- - Indicates whether this variable contains large data and need to be - uploaded to Cloud Storage. - dataType: - description: The data type of the parameter. - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - producer: + If the access token will expire, use the refresh token to obtain + another access token. + accessTokenExpireTime: + format: google-datetime type: string - attributes: - description: Metadata information about the parameters. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' - protoDefName: description: >- - The name of the protobuf type if the parameter has a protobuf data - type. + Required. The approximate time until the access token retrieved is + valid. + id: GoogleCloudIntegrationsV1alphaAccessToken + description: >- + The access token represents the authorization of a specific application + to access specific parts of a user’s data. + type: object + GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: + id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + description: Metadata of an entity, including a schema for its properties. + properties: + entity: + description: Name of the entity. + type: string + fieldSchema: + type: string + description: List of fields in the entity. + arrayFieldSchema: + description: The above schema, but for an array of the associated entity. type: string - producedBy: - description: >- - The identifier of the node (TaskConfig/TriggerConfig) this parameter - was produced by, if it is a transient param or a copy of an input - param. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' - EnterpriseCrmFrontendsEventbusProtoParameterEntry: type: object + GoogleCloudIntegrationsV1alphaFailurePolicy: properties: - value: + maxRetries: + type: integer description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - key: + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the number of times the task will be retried if failed. + format: int32 + condition: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the workflow definition. + Optional. The string condition that will be evaluated to determine + if the task should be retried with this failure policy. + type: string + retryStrategy: + description: Defines what happens to the task upon failure. + enum: + - RETRY_STRATEGY_UNSPECIFIED + - IGNORE + - NONE + - FATAL + - FIXED_INTERVAL + - LINEAR_BACKOFF + - EXPONENTIAL_BACKOFF + - RESTART_INTEGRATION_WITH_BACKOFF type: string - dataType: enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + - UNSPECIFIED. - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE - description: Explicitly getting the type of the parameter. + Ignores the failure of this task. The rest of the integration will + be executed Assuming this task succeeded. + - >- + Causes a permanent failure of the task. However, if the last + task(s) of event was successfully completed despite the failure of + this task, it has no impact on the integration. + - >- + Causes a permanent failure of the event. It is different from NONE + because this will mark the event as FAILED by shutting down the + event execution. + - >- + The task will be retried from the failed task onwards after a + fixed delay. A max-retry count is required to be specified with + this strategy. A jitter is added to each exponential interval so + that concurrently failing tasks of the same type do not end up + retrying after the exact same exponential interval. max_retries + and interval_in_seconds must be specified. + - >- + The task will be retried from the failed task onwards after a + fixed delay that linearly increases with each retry attempt. A + jitter is added to each exponential interval so that concurrently + failing tasks of the same type do not end up retrying after the + exact same exponential interval. A max-retry count is required to + be specified with this strategy. max_retries and + interval_in_seconds must be specified. + - >- + The task will be retried after an exponentially increasing period + of time with each failure. A jitter is added to each exponential + interval so that concurrently failing tasks of the same type do + not end up retrying after the exact same exponential interval. A + max-retry count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. + - >- + The entire integration will be restarted with the initial + parameters that were set when the event was fired. A max-retry + count is required to be specified with this strategy. + `max_retries` and `interval_in_seconds` must be specified. + intervalTime: + format: google-datetime + description: >- + Required if retry_strategy is FIXED_INTERVAL or + LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines + the initial interval in seconds for backoff. type: string - masked: - type: boolean - description: True if this parameter should be masked in the logs - id: EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: Key-value pair of EventBus parameters. - EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: + description: >- + Policy that defines the task retry logic and failure type. If no + FailurePolicy is defined for a task, all its dependent tasks will not be + executed (i.e, a `retry_strategy` of NONE will be applied). type: object + id: GoogleCloudIntegrationsV1alphaFailurePolicy + GoogleCloudIntegrationsV1alphaExecuteEventResponse: + id: GoogleCloudIntegrationsV1alphaExecuteEventResponse properties: - dataType: - description: The data type of the parameter. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - enum: - - DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - - JSON_VALUE + executionId: + description: The id of the execution corresponding to this run of integration. type: string - protoDef: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - description: Populated if this represents a proto or proto array. - config: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' - description: Optional fields, such as help text and other useful info. - key: - type: string - description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given task. These parameters must be - predefined in the workflow definition. - validationRule: + description: The response for executing an integration. + type: object + GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: + properties: + triggerId: description: >- - Rule used to validate inputs (individual values and collection - elements) for this parameter. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - jsonSchema: - description: If the data_type is JSON_VALUE, then this will define its schema. + Required. Matched against all {@link TriggerConfig}s across all + integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The + trigger_id is in the format of `api_trigger/TRIGGER_NAME`. type: string - className: + executionId: + type: string + description: Optional. The id of the ON_HOLD execution to be resumed. + inputParameters: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Optional. Input parameters used by integration execution. + requestId: type: string description: >- - The FQCN of the Java object this represents. A string, for example, - would be "java.lang.String". If this is "java.lang.Object", the - parameter can be of any type. - isDeprecated: - description: >- - If set, this entry is deprecated, so further use of this parameter - should be prohibited. - type: boolean - isOutput: - type: boolean - collectionElementClassName: + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. + parameters: + deprecated: true description: >- - If it is a collection of objects, this would be the FCQN of every - individual element in the collection. If this is "java.lang.Object", - the parameter is a collection of any type. - type: string - required: - description: If set, the user must provide an input value for this parameter. - type: boolean - defaultValue: + Optional. Passed in as parameters to each integration execution. + Redacted $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + doNotPropagateError: description: >- - Default values for the defined keys. Each value can either be - string, int, double or any proto message or a serialized object. - description: 'Key-value pair of EventBus task parameters. Next id: 13' - id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: - type: object - id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse - description: Response for listing RuntimeActionSchemas for a specific Connection. - properties: - nextPageToken: - type: string - description: Next page token. - runtimeActionSchemas: + Optional. Flag to determine how to should propagate errors. If this + flag is set to be true, it will not throw an exception. Instead, it + will return a {@link ExecuteIntegrationsResponse} with an execution + id and error messages as PostWithTriggerIdExecutionException in + {@link EventParameters}. The flag is set to be false by default. + type: boolean + parameterEntries: + deprecated: true + type: array items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema - description: Runtime action schemas. - type: array - GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse: - description: The response for executing an integration. + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: >- + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest type: object - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse - properties: - executionInfoIds: - description: The execution info id for the executed integrations. - type: array - items: - type: string - GoogleCloudIntegrationsV1alphaCertificate: + description: The request for executing an integration. + EnterpriseCrmEventbusProtoTaskAlertConfig: + description: >- + Message to be used to configure alerting in the {@code TaskConfig} + protos for tasks in an event. properties: - certificateStatus: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - EXPIRED - enumDescriptions: - - Unspecified certificate status - - Certificate in active state will be able to use - - Certificate in expired state needs to be updated - type: string - description: Status of the certificate - validEndTime: - description: Output only. The timestamp after which certificate will expire - format: google-datetime - readOnly: true - type: string - requestorId: - type: string + alertDisabled: + type: boolean description: >- - Immutable. Requestor ID to be used to register certificate with - trawler - name: - type: string - readOnly: true - description: Output only. Auto generated primary key - validStartTime: - format: google-datetime - readOnly: true - type: string - description: Output only. The timestamp after which certificate will be valid - displayName: + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this workflow alert. + clientId: type: string - description: Required. Name of the certificate - rawCertificate: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' description: >- - Input only. Raw client certificate which would be registered with - trawler - description: + Client associated with this alert configuration. Must be a client + enabled in one of the containing workflow's triggers. + warningEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + errorEnumList: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + thresholdType: + enumDescriptions: + - '' + - >- + Note that this field will only trigger alerts if the workflow + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. + - '' + enum: + - UNSPECIFIED_THRESHOLD_TYPE + - EXPECTED_MIN + - EXPECTED_MAX + description: >- + The threshold type for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. type: string - description: Description of the certificate - credentialId: + onlyFinalAttempt: + description: Only count final task attempts, not retries. + type: boolean + playbookUrl: type: string description: >- - Immutable. Credential id that will be used to register with trawler - INTERNAL_ONLY - type: object - id: GoogleCloudIntegrationsV1alphaCertificate - description: The certificate definition - EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: - id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition - type: object - properties: - fullName: + Link to a playbook for resolving the issue that triggered this + alert. + numAggregationPeriods: + type: integer description: >- - The fully-qualified proto name. This message, for example, would be - "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + format: int32 + alertName: + description: >- + A name to identify this alert. This will be displayed in the alert + subject. If set, this name should be unique in within the scope of + the containing workflow. type: string - path: + aggregationPeriod: type: string - description: Path to the proto file that contains the message type's definition. - GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: - description: >- - Parameters to support Oauth 2.0 Client Credentials Grant Authentication. - See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. - properties: - clientSecret: - description: Secret version reference containing the client secret. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - clientId: + description: >- + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). + thresholdValue: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + description: >- + The metric value, above or below which the alert should be + triggered. + metricType: type: string - description: The client identifier. - type: object - id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - GoogleCloudIntegrationsV1alphaProjectProperties: - type: object - properties: - billingType: enumDescriptions: - - '' - - A trial org provisioned through Apigee Provisioning Wizard - >- - Subscription based on concurrency model for Apigee and Application - Integration users. - - Consumption based users of IP + The default value. Metric type should always be set to one of the + other non-default values, otherwise it will result in an + INVALID_ARGUMENT error. - >- - Argentum subscription for Application Integration users. To be - used in the future. + Specifies alerting on the rate of errors (potentially for a + specific set of enum values) for the enclosing TaskConfig. - >- - Special billing type to avoid any billing to clients (eg: trusted - tester program). This should not be used without consulting with - the leads. - type: string - enum: - - BILLING_TYPE_UNSPECIFIED - - APIGEE_TRIALS - - APIGEE_SUBSCRIPTION - - PAYG - - SUBSCRIPTION - - NO_BILLING - description: 'Required. Required: The client billing type that was requested' - ipEnablementState: - enumDescriptions: - - The client enablement status is unspecified - - The client is enabled on Standalone IP - - The client is enabled on Apigee - - The client is entitled for Apigee but not enabled - description: An enum value of what the enablement state is for the given project + Specifies alerting on the rate of warnings (potentially for a + specific set of enum values) for the enclosing TaskConfig. + Warnings use the same enum values as errors. + - >- + Specifies alerting on the number of instances for the enclosing + TaskConfig executed in the given aggregation_period. + - >- + Specifies alerting on the average duration of execution for the + enclosing task. + - >- + Specifies alerting on the duration of a particular percentile of + task executions. E.g. If 10% or more of the task executions have + durations above 5 seconds, alert. enum: - - IP_ENABLEMENT_STATE_UNSPECIFIED - - IP_ENABLEMENT_STATE_STANDALONE - - IP_ENABLEMENT_STATE_APIGEE - - IP_ENABLEMENT_STATE_APIGEE_ENTITLED - type: string - provisionedRegions: - description: A list of provisioned regions on the current project - items: - type: string - type: array - description: Metadata information for the given project - id: GoogleCloudIntegrationsV1alphaProjectProperties - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: - description: >- - Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 - Authorization Grant based authentication. See - https://tools.ietf.org/html/rfc7523 for more details. - properties: - jwtClaims: - description: JwtClaims providers fields to generate the token. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims - clientKey: - description: >- - Secret version reference containing a PKCS#8 PEM-encoded private key - associated with the Client Certificate. This private key will be - used to sign JWTs used for the jwt-bearer authorization grant. - Specified in the form as: `projects/*/secrets/*/versions/*`. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - type: object - GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: - properties: - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - description: >- - Required. REQUIRED: Cloud KMS config for AuthModule to - encrypt/decrypt credentials. - type: object - id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest - description: Request for the SwitchEncryption rpc - GoogleCloudIntegrationsV1alphaAttemptStats: - properties: - endTime: - format: google-datetime - type: string - description: The end time of the integration execution for current attempt. - startTime: - format: google-datetime + - METRIC_TYPE_UNSPECIFIED + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION + durationThresholdMs: + format: int64 type: string description: >- - The start time of the integration execution for current attempt. - This could be in the future if it's been scheduled. - id: GoogleCloudIntegrationsV1alphaAttemptStats - description: Status for the execution attempt. - type: object - GoogleCloudIntegrationsV1alphaGenerateTokenResponse: + Should be specified only for TASK_AVERAGE_DURATION and + TASK_PERCENTILE_DURATION metrics. This member should be used to + specify what duration value the metrics should exceed for the alert + to trigger. + id: EnterpriseCrmEventbusProtoTaskAlertConfig type: object - properties: - message: - type: string - description: The message that notifies the user if the request succeeded or not. - id: GoogleCloudIntegrationsV1alphaGenerateTokenResponse - description: Returns success or error message - GoogleCloudIntegrationsV1alphaAuthConfig: - description: The AuthConfig resource use to hold channels and connection config data. + GoogleCloudIntegrationsV1alphaSerializedFile: type: object - id: GoogleCloudIntegrationsV1alphaAuthConfig properties: - state: + file: enumDescriptions: - - Status not specified. - - Valid Auth config. - - >- - General invalidity, if it doesn't fits in the detailed issue - below. - - Auth config soft deleted. - - Auth config expired. - - Auth config unauthorized. - - Auth config not supported. - description: The status of the auth config. + - Default value. + - Integration file. + - Integration Config variables. enum: - - STATE_UNSPECIFIED - - VALID - - INVALID - - SOFT_DELETED - - EXPIRED - - UNAUTHORIZED - - UNSUPPORTED + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES + description: >- + File information like Integration version, Integration Config + variables etc. type: string - displayName: + content: type: string - description: Required. The name of the auth config. - createTime: - readOnly: true - description: Output only. The timestamp when the auth config is created. + description: String representation of the file content. + description: To store string representation of Integration file. + id: GoogleCloudIntegrationsV1alphaSerializedFile + EnterpriseCrmEventbusProtoSuspensionAuthPermissions: + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions + type: object + properties: + googleGroup: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + gaiaIdentity: + description: Represents a Gaia identity for a person or service account. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity + loasRole: type: string - format: google-datetime - updateTime: - format: google-datetime - readOnly: true + mdbGroup: type: string - description: Output only. The timestamp when the auth config is modified. - reason: + description: LINT.IfChange + GoogleCloudIntegrationsV1alphaTemplate: + id: GoogleCloudIntegrationsV1alphaTemplate + properties: + usageInfo: type: string - description: The reason / details of the current status. - creatorEmail: description: >- - The creator's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. - type: string - overrideValidTime: + Optional. Information on how to use the template. This should + contain detailed information about usage of the template. + templateBundle: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplateBundle' description: >- - User provided expiry time to override. For the example of - Salesforce, username/password credentials can be valid for 6 months - depending on the instance settings. - format: google-datetime + Required. Bundle which is part of the templates. The template + entities in the bundle would be converted to an actual entity. + docLink: type: string - decryptedCredential: - description: Raw auth credentials. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' - encryptedCredential: + description: Optional. Link to template documentation. + name: + type: string + description: Identifier. Resource name of the template. + lastUsedTime: + description: Optional. Time the template was last used. + format: google-datetime type: string + components: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTemplateComponent description: >- - Auth credential encrypted by Cloud KMS. Can be decrypted as - Credential with proper KMS key. - format: byte - expiryNotificationDuration: + Optional. Components being used in the template. This could be used + to categorize and filter. + type: array + sharedWith: items: type: string - format: google-duration type: array description: >- - User can define the time to receive notification after which the - auth config becomes invalid. Support up to 30 days. Support - granularity in hours. - certificateId: - description: Certificate id for client certificate + Required. Resource names with which the template is shared for + example ProjectNumber/Ord id + author: type: string - description: - description: A description of the auth config. - type: string - validTime: - description: >- - The time until the auth config is valid. Empty or max value is - considered the auth config won't expire. + description: Optional. Creator of the template. + updateTime: type: string + description: Output only. Auto-generated format: google-datetime - lastModifierEmail: - description: >- - The last modifier's email address. Generated based on the End User - Credentials/LOAS role of the user making the call. + readOnly: true + categories: + type: array + items: + type: string + enumDescriptions: + - Category is unspecified + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATAABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS + enum: + - CATEGORY_UNSPECIFIED + - AI_MACHINE_LEARNING + - BUSINESS_INTELLIGENCE + - COLLABORATION + - CUSTOMER_SERVICE + - DATABASES + - DEVOPS_IT + - CONTENT_AND_FILES + - FINANCE_AND_ACCOUNTING + - HUMAN_RESOURCES + - OPERATIONS + - PRODUCT_PROJECT_MANAGEMENT + - PRODUCTIVITY + - SALES_AND_MARKETING + - UNIVERSAL_CONNECTORS + - UTILITY + - OTHERS + description: >- + Required. Categories associated with the Template. The categories + listed below will be utilized for the Template listing. + description: type: string + description: >- + Optional. Description of the template. The length should not be more + than 255 characters visibility: - type: string - description: The visibility of the auth config. - enumDescriptions: - - Visibility not specified. - - Profile visible to the creator only. - - Profile visible within the client. enum: - - AUTH_CONFIG_VISIBILITY_UNSPECIFIED + - VISIBILITY_UNSPECIFIED - PRIVATE - - CLIENT_VISIBLE - credentialType: + - SHARED + - PUBLIC + type: string enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - description: Credential type of the encrypted credential. + - Visibility is unspecified + - Visibility is private + - Visibility is shared + - Visibility is public + description: Required. Visibility of the template. + displayName: type: string - name: + description: Required. The name of the template + tags: description: >- - Resource name of the auth config. For more information, see Manage - authentication profiles. - projects/{project}/locations/{location}/authConfigs/{authConfig}. + Required. Tags which are used to identify templates. These tags + could be for business use case, connectors etc. + type: array + items: + type: string + usageCount: type: string - EnterpriseCrmFrontendsEventbusProtoTaskEntity: + description: Optional. Number of template usages. + format: int64 + createTime: + readOnly: true + format: google-datetime + type: string + description: Output only. Auto-generated. + description: Defines the template for Application Integration + type: object + EnterpriseCrmEventbusProtoNextTeardownTask: properties: - taskType: + name: + description: Required. Name of the next teardown task. type: string - description: Defines the type of the task - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE - disabledForVpcSc: - description: True if the task has conflict with vpcsc - type: boolean - uiConfig: - description: >- - UI configuration for this task Also associated with the METADATA - mask. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' - metadata: - description: Metadata inclueds the task name, author and so on. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' - paramSpecs: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage - description: >- - Declarations for inputs/outputs for a TypedTask. This is also - associated with the METADATA mask. - stats: - description: Deprecated - statistics from the Monarch query. - $ref: '#/components/schemas/EnterpriseCrmEventbusStats' - deprecated: true - id: EnterpriseCrmFrontendsEventbusProtoTaskEntity - description: >- - Contains a task's metadata and associated information. Next available - id: 7 type: object - EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 11 - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + The teardown task that is next in line to be executed. We support only + sequential execution of teardown tasks (i.e. no branching). + id: EnterpriseCrmEventbusProtoNextTeardownTask + EnterpriseCrmEventbusProtoErrorDetail: + id: EnterpriseCrmEventbusProtoErrorDetail + type: object properties: - eventAttemptStats: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - type: array - eventExecutionSnapshot: + errorMessage: description: >- - After snapshot migration, this field will no longer be populated, - but old execution snapshots will still be accessible. - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot - type: array - eventExecutionState: - description: The execution state of this event. + The full text of the error message, including any parameters that + were thrown along with the exception. type: string - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED + taskNumber: + format: int32 + type: integer + description: >- + The task try-number, in which, the error occurred. If zero, the + error happened at the event level. + severity: + description: 'The severity of the error: ERROR|WARN|INFO.' enumDescriptions: - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. - logFilePath: + - '' + - '' + - '' type: string - description: The log file path (aka. cns address) for this event. - ryeLockUnheldCount: - type: integer - format: int32 - description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - eventExecutionSnapshotsSize: - format: int64 + enum: + - SEVERITY_UNSPECIFIED + - ERROR + - WARN + - INFO + errorCode: + description: The associated error-code, which can be a common or internal code. + $ref: '#/components/schemas/CrmlogErrorCode' + description: An error, warning, or information message associated with a workflow. + EnterpriseCrmEventbusProtoToken: + type: object + id: EnterpriseCrmEventbusProtoToken + properties: + value: type: string - description: Total size of all event_execution_snapshots for an execution - networkAddress: + name: type: string - description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - nextExecutionTime: + GoogleCloudIntegrationsV1alphaValueType: + properties: + stringValue: + type: string + description: String. + doubleValue: + description: Double Number. + type: number + format: double + jsonValue: type: string + description: Json. + booleanArray: + description: Boolean Array. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray + booleanValue: + type: boolean + description: Boolean. + intValue: format: int64 - description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - eventRetriesFromBeginningCount: - type: integer - format: int32 - description: >- - Indicates the number of times the execution has restarted from the - beginning. + type: string + description: Integer. + stringArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray + description: String Array. + intArray: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' + description: Integer Array. + doubleArray: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray + description: Double Number Array. + description: The type of the parameter. type: object - EnterpriseCrmEventbusProtoScatterResponse: + id: GoogleCloudIntegrationsV1alphaValueType + GoogleCloudIntegrationsV1alphaListConnectionsResponse: + id: GoogleCloudIntegrationsV1alphaListConnectionsResponse + description: Response containing Connections listed by region. type: object properties: - scatterElement: - description: The element that was scattered for this execution. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - responseParams: + nextPageToken: + type: string + description: Next page token. + connections: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' + description: Connections. type: array + EnterpriseCrmEventbusProtoCloudKmsConfig: + id: EnterpriseCrmEventbusProtoCloudKmsConfig + type: object + properties: + gcpProjectId: + type: string description: >- - A list of all the response parameters in the aggregtorMap stored - with the remapped key. - isSuccessful: + Optional. The id of GCP project where the KMS key is stored. If not + provided, assume the key is stored in the same GCP project defined + in Client (tag 14). + keyVersionName: + type: string description: >- - If execution is sync, this is true if the execution passed and false - if it failed. If the execution is async, this is true if the WF was - fired off successfully, and false if it failed to execute. The - success or failure of the subworkflows executed are not captured. - type: boolean - executionIds: - items: - type: string - type: array - description: The execution ids of each Subworkflow fired by this scatter. - errorMsg: - description: The error message of the failure if applicable. + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. + keyName: type: string - id: EnterpriseCrmEventbusProtoScatterResponse - EnterpriseCrmLoggingGwsFieldLimits: - description: >- - Describes string and array limits when writing to logs. When a limit is - exceeded the *shortener_type* describes how to shorten the field. - next_id: 6 - properties: - maxStringLength: - format: int32 description: >- - maximum string length. If the field exceeds this amount the field is - shortened. - type: integer - logAction: - enum: - - LOG_ACTION_UNSPECIFIED - - DONT_LOG - - LOG + A Cloud KMS key is a named object containing one or more key + versions, along with metadata for the key. A key exists on exactly + one key ring tied to a specific location. + serviceAccount: type: string - enumDescriptions: - - '' - - '' - - '' - maxArraySize: - format: int32 - type: integer description: >- - maximum array size. If the array exceds this size, the field (list) - is truncated. - shortenerType: + Optional. The service account used for authentication of this KMS + key. If this is not provided, the service account in + Client.clientSource will be used. + locationName: + description: Location name of the key ring, e.g. "us-west1". type: string - enumDescriptions: - - '' - - String is shortened to max_string_length. - - String is replaced by its hex-string hash. - - >- - String is replaced by a combination of string shortening and a - hex-string hash. - - >- - String shortening for email addresses. Shortening may be done on - the user and/or domain portion of the email address. - - >- - String is replaced by a combination of string shortening and a - hex-string hash for an email address. - - Shortens a domain name (e.g., as part of an email address or URL). - enum: - - SHORTENER_TYPE_UNSPECIFIED - - SHORTEN - - HASH - - SHORTEN_WITH_HASH - - SHORTEN_EMAIL - - SHORTEN_EMAIL_WITH_HASH - - SHORTEN_DOMAIN - logType: - items: - enum: - - LOG_TYPE_UNSPECIFIED - - GWS - - GTS - - ALL - enumDescriptions: - - '' - - Limits apply when log detail records are written to GWS. - - >- - Limits apply when log detail records are written to GTS (e.g., - RecordIO files). - - Limits apply to *all* output log types. - type: string - description: To which type(s) of logs the limits apply. - type: array - id: EnterpriseCrmLoggingGwsFieldLimits - type: object - GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: - id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse - description: The response for testing an integration. - properties: - eventParameters: - deprecated: true - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Details for the integration that were executed. - parameterEntries: - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - type: array - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - parameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. - type: object - executionFailed: - description: Is true if any execution in the integration failed. False otherwise. - type: boolean - executionId: - description: The id of the execution corresponding to this run of integration. - type: string - type: object - GoogleProtobufEmpty: - id: GoogleProtobufEmpty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - type: object - GoogleCloudIntegrationsV1alphaFile: - properties: - type: + keyRingName: type: string - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - description: >- - File information like Integration version, Integration Config - variables etc. - integrationConfig: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: Integration version config file - integrationVersion: - description: Integration version - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: >- - To store Integration version related file i.e. Integration Version, - Config variable etc. - id: GoogleCloudIntegrationsV1alphaFile - type: object - EnterpriseCrmEventbusProtoConditionalFailurePolicies: - properties: - failurePolicies: - type: array - description: >- - The list of failure policies that will be applied to the task in - order. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - defaultFailurePolicy: description: >- - The default failure policy to be applied if no conditional failure - policy matches - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - id: EnterpriseCrmEventbusProtoConditionalFailurePolicies + A key ring organizes keys in a specific Google Cloud location and + allows you to manage access control on groups of keys. A key ring's + name does not need to be unique across a Google Cloud project, but + must be unique within a given location. + GoogleCloudConnectorsV1EventingRuntimeDataWebhookData: + id: GoogleCloudConnectorsV1EventingRuntimeDataWebhookData type: object - GoogleCloudIntegrationsV1alphaIntegration: - description: The integration definition. + description: WebhookData has details of webhook configuration. properties: - lastModifierEmail: - type: string - description: Required. The last modifier of this integration - createTime: - description: Required. Output only. Auto-generated. + updateTime: type: string format: google-datetime readOnly: true - name: - description: Required. The resource name of the integration. - type: string - active: - description: Required. If any integration version is published. - type: boolean - updateTime: + description: Output only. Timestamp when the webhook was last updated. + createTime: + description: Output only. Timestamp when the webhook was created. readOnly: true - type: string format: google-datetime - description: Output only. Auto-generated. - creatorEmail: - type: string - description: >- - Output only. The creator's email address. Generated based on the End - User Credentials/LOAS role of the user making the call. - readOnly: true - description: - type: string - description: Optional. - type: object - id: GoogleCloudIntegrationsV1alphaIntegration - GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: - description: Response of lift Suspense - id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse - type: object - properties: - eventExecutionInfoId: type: string - description: Execution Id that will be returned - EnterpriseCrmEventbusProtoSuspensionConfig: - id: EnterpriseCrmEventbusProtoSuspensionConfig - type: object - properties: - notifications: + additionalVariables: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' - type: array - suspensionExpiration: - description: >- - Indicates the next steps when no external actions happen on the - suspension. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' - whoMayResolve: - description: Identities able to resolve this suspension. + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + description: Output only. Additional webhook related field values. + readOnly: true type: array - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions - customMessage: + nextRefreshTime: + format: google-datetime + readOnly: true description: >- - Optional information to provide recipients of the suspension in - addition to the resolution URL, typically containing relevant - parameter values from the originating workflow. + Output only. Next webhook refresh time. Will be null if refresh is + not supported. type: string - GoogleCloudIntegrationsV1alphaReplayExecutionRequest: - type: object - id: GoogleCloudIntegrationsV1alphaReplayExecutionRequest - properties: - replayReason: - description: Optional. The user provided reason for replaying the execution. + name: type: string - description: 'Request for replaying an execution Next ID: 3' - GoogleCloudConnectorsV1EventingConfig: - description: Eventing Configuration of a connection - properties: - additionalVariables: - description: Additional eventing related field values - type: array - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - enrichmentEnabled: - type: boolean - description: Enrichment Enabled. - privateConnectivityEnabled: - type: boolean - description: Optional. Private Connectivity Enabled. - eventsListenerIngressEndpoint: - description: >- - Optional. Ingress endpoint of the event listener. This is used only - when private connectivity is enabled. + readOnly: true + description: Output only. Name of the Webhook + id: + readOnly: true + description: Output only. ID to uniquely identify webhook. type: string - deadLetterConfig: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - description: Optional. Dead letter configuration for eventing of a connection. - proxyDestinationConfig: - description: Optional. Proxy for Eventing auto-registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - registrationDestinationConfig: - description: Registration endpoint for auto registration. - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - listenerAuthConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - description: Optional. Auth details for the event listener. - authConfig: - description: Auth details for the webhook adapter. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - id: GoogleCloudConnectorsV1EventingConfig - type: object - EnterpriseCrmEventbusProtoDoubleFunction: + EnterpriseCrmEventbusProtoStringFunction: type: object - id: EnterpriseCrmEventbusProtoDoubleFunction properties: functionName: enumDescriptions: @@ -1993,463 +1956,455 @@ components: - '' - '' - '' - type: string + - '' enum: - UNSPECIFIED + - CONCAT + - TO_UPPERCASE + - TO_LOWERCASE + - CONTAINS + - SPLIT + - LENGTH + - EQUALS + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_BASE_64 - TO_JSON + - EQUALS_IGNORE_CASE + - REPLACE_ALL + - SUBSTRING + - RESOLVE_TEMPLATE + - DECODE_BASE64_STRING + type: string + id: EnterpriseCrmEventbusProtoStringFunction + EnterpriseCrmEventbusProtoJsonFunction: + properties: + functionName: + enum: + - UNSPECIFIED + - GET_PROPERTY + - GET_ELEMENT + - APPEND_ELEMENT + - SIZE + - SET_PROPERTY + - FLATTEN + - FLATTEN_ONCE + - MERGE - TO_STRING - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - ROUND - - FLOOR - - CEIL - - GREATER_THAN - - LESS_THAN + - TO_INT + - TO_DOUBLE + - TO_BOOLEAN + - TO_PROTO + - TO_STRING_ARRAY + - TO_INT_ARRAY + - TO_DOUBLE_ARRAY + - TO_PROTO_ARRAY + - TO_BOOLEAN_ARRAY + - REMOVE_PROPERTY + - RESOLVE_TEMPLATE - EQUALS - - GREATER_THAN_EQUALS - - LESS_THAN_EQUALS - - MOD - GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: - id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - type: object - description: >- - For client credentials grant, the client sends a POST request with - grant_type as 'client_credentials' to the authorization server. The - authorization server will respond with a JSON object containing the - access token. - properties: - scope: - type: string - description: A space-delimited list of requested scope permissions. - tokenEndpoint: - type: string - description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - tokenParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: Token parameters for the auth request. - clientId: - description: The client's ID. - type: string - accessToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - description: Access token fetched from the authorization server. - clientSecret: - description: The client's secret. + - FOR_EACH + - FILTER_ELEMENTS type: string - requestType: enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. - type: string - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - description: Represent how to pass parameters to fetch access token - GoogleCloudIntegrationsV1alphaParameterMapField: - id: GoogleCloudIntegrationsV1alphaParameterMapField - properties: - referenceKey: - type: string - description: Referencing one of the Integration variables. - literalValue: - description: Passing a literal value. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - description: Field represents either the key or value in an entry. - GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: object - id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse - description: Response for ListIntegrationVersions. + id: EnterpriseCrmEventbusProtoJsonFunction + GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: + description: Conditional task failur retry strategies + id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies properties: - noPermission: - description: Whether the user has no permission on the version or not. - type: boolean - nextPageToken: + failurePolicies: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - type: string - integrationVersions: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + The list of failure policies that will be applied to the task in + order. type: array - description: The integrations which match the request. - GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: - properties: {} - description: Request for TakeoverEditLock. - type: object - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest - GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: - id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse - type: object - description: Response for Suspensions.ResolveSuspensions. - properties: {} - EnterpriseCrmEventbusProtoIntArray: - id: EnterpriseCrmEventbusProtoIntArray - type: object - properties: - values: items: - format: int64 - type: string - type: array - GoogleCloudIntegrationsV1alphaJwt: - description: >- - Represents JSON web token(JWT), which is a compact, URL-safe means of - representing claims to be transferred between two parties, enabling the - claims to be digitally signed or integrity protected. - id: GoogleCloudIntegrationsV1alphaJwt + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + defaultFailurePolicy: + description: >- + The default failure policy to be applied if no conditional failure + policy matches. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' type: object + GoogleCloudConnectorsV1Destination: + type: object + id: GoogleCloudConnectorsV1Destination properties: - secret: - type: string - description: User's pre-shared secret to sign the token. - jwtHeader: - type: string - description: Identifies which algorithm is used to generate the signature. - jwt: + host: type: string - description: The token calculated by the header, payload and signature. - jwtPayload: + description: For publicly routable host. + serviceAttachment: description: >- - Contains a set of claims. The JWT specification defines seven - Registered Claim Names which are the standard fields commonly - included in tokens. Custom claims are usually also included, - depending on the purpose of the token. + PSC service attachments. Format: + projects/*/regions/*/serviceAttachments/* type: string - EnterpriseCrmEventbusProtoCombinedCondition: - deprecated: true - id: EnterpriseCrmEventbusProtoCombinedCondition - description: >- - This message recursively combines constituent conditions using logical - AND. - type: object + deprecated: true + port: + description: >- + The port is the target port number that is accepted by the + destination. + format: int32 + type: integer + EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot: properties: - conditions: - description: A set of individual constituent conditions. + eventExecutionSnapshotMetadata: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + eventExecutionInfoId: + description: Points to the event execution info this snapshot belongs to. + type: string + conditionResults: + type: array + description: All of the computed conditions that been calculated. items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + eventParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: The parameters in Event object. + taskExecutionDetails: type: array - EnterpriseCrmEventbusProtoConditionResult: - description: Contains the combined condition calculation results. - properties: - result: - type: boolean + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + description: All of the task execution details at the given point of time. + checkpointTaskNumber: description: >- - the result comes out after evaluate the combined condition. True if - there's no combined condition specified. - nextTaskNumber: + Indicates "right after which checkpoint task's execution" this + snapshot is taken. type: string - description: the next task number. - currentTaskNumber: - description: the current task number. + snapshotTime: type: string - id: EnterpriseCrmEventbusProtoConditionResult - type: object - EnterpriseCrmEventbusStats: + description: Indicates when this snapshot is taken. + format: int64 + eventExecutionSnapshotId: + description: >- + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + type: string + taskName: + description: The task name associated with this snapshot. Could be empty. + type: string + deprecated: true + diffParams: + description: The parameters in Event object that differs from last snapshot. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters type: object + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + EnterpriseCrmEventbusProtoSuspensionConfig: properties: - durationInSeconds: - type: number - format: double - description: Average duration in seconds. - qps: - description: Queries per second. - format: double - type: number - warningRate: - format: double - description: Average warning rate. - type: number - errorRate: - format: double - type: number - description: Average error rate. - dimensions: - $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' - description: Dimensions that these stats have been aggregated on. - id: EnterpriseCrmEventbusStats - description: >- - Stats for the requested dimensions: QPS, duration, and error/warning - rate - GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: - type: object - properties: - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Version after the lock is acquired by the new user. - id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse - description: Response for TakeoverEditLock. - GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: - id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse - type: object - properties: - regions: + whoMayResolve: + type: array items: - type: string - description: All regions where Connector Platform is provisioned. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissions + description: Identities able to resolve this suspension. + customMessage: + description: >- + Optional information to provide recipients of the suspension in + addition to the resolution URL, typically containing relevant + parameter values from the originating workflow. + type: string + suspensionExpiration: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionExpiration' + description: >- + Indicates the next steps when no external actions happen on the + suspension. + notifications: type: array - description: Response containing all provisioned regions for Connector Platform. - GoogleCloudConnectorsV1LockConfig: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNotification' type: object + id: EnterpriseCrmEventbusProtoSuspensionConfig + GoogleCloudIntegrationsV1alphaTaskConfig: properties: - locked: - description: Indicates whether or not the connection is locked. - type: boolean - reason: + synchronousCallFailurePolicy: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + successPolicy: + description: >- + Optional. Determines what action to take upon successful task + completion. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' + conditionalFailurePolicies: + description: >- + Optional. The list of conditional failure policies that will be + applied to the task in order. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies + displayName: type: string - description: Describes why a connection is locked. - description: >- - Determines whether or no a connection is locked. If locked, a reason - must be specified. - id: GoogleCloudConnectorsV1LockConfig - EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: - description: 'Next available id: 4' - properties: - rollbackTaskImplementationClassName: + description: >- + Optional. User-provided label that is attached to this TaskConfig in + the UI. + jsonValidationOption: + enum: + - JSON_VALIDATION_OPTION_UNSPECIFIED + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION + description: >- + Optional. If set, overrides the option configured in the Task + implementation class. + enumDescriptions: + - >- + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. + - >- + Validate all potential input JSON parameters against schemas + specified in IntegrationParameter. + - >- + Validate all potential output JSON parameters against schemas + specified in IntegrationParameter. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. type: string + nextTasksExecutionPolicy: description: >- - Required. This is the name of the task that needs to be executed - upon rollback of this task. + Optional. The policy dictating the execution of the next set of + tasks for the current task. + enumDescriptions: + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + enum: + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + type: string + taskExecutionStrategy: + enum: + - TASK_EXECUTION_STRATEGY_UNSPECIFIED + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED + description: Optional. The policy dictating the execution strategy of this task. + type: string + enumDescriptions: + - >- + Default. If the strategy is not set explicitly, it will default to + `WHEN_ALL_SUCCEED`. + - >- + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. + - >- + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). + - >- + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. + failurePolicy: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' parameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters description: Optional. The customized parameters the user can pass to this task. - taskNumbersToRollback: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' + type: object + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + task: + type: string + description: Optional. The name for the task. + nextTasks: items: - type: string - type: array + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' description: >- - Required. These are the tasks numbers of the tasks whose - `rollback_strategy.rollback_task_implementation_class_name` needs to - be executed upon failure of this task. - id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy - type: object - GoogleCloudIntegrationsV1alphaGetClientResponse: - type: object - properties: - client: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' - description: 'Required. Required: The client configuration that was requested' - description: Response for the GetClient rpc - id: GoogleCloudIntegrationsV1alphaGetClientResponse - EnterpriseCrmEventbusProtoCloudKmsConfig: - type: object - id: EnterpriseCrmEventbusProtoCloudKmsConfig - properties: - keyRingName: + Optional. The set of tasks that are next in line to be executed as + per the execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. + type: array + taskId: description: >- - A key ring organizes keys in a specific Google Cloud location and - allows you to manage access control on groups of keys. A key ring's - name does not need to be unique across a Google Cloud project, but - must be unique within a given location. + Required. The identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_id`). type: string - locationName: + externalTaskType: + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows + enum: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK type: string - description: Location name of the key ring, e.g. "us-west1". - gcpProjectId: + description: Optional. External task type of the task + taskTemplate: description: >- - Optional. The id of GCP project where the KMS key is stored. If not - provided, assume the key is stored in the same GCP project defined - in Client (tag 14). + Optional. Used to define task-template name if task is of type + task-template type: string - keyVersionName: + description: type: string description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. - serviceAccount: + Optional. User-provided description intended to give additional + business context about the task. + errorCatcherId: description: >- - Optional. The service account used for authentication of this KMS - key. If this is not provided, the service account in - Client.clientSource will be used. - type: string - keyName: + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task type: string - description: >- - A Cloud KMS key is a named object containing one or more key - versions, along with metadata for the key. A key exists on exactly - one key ring tied to a specific location. - GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest: + id: GoogleCloudIntegrationsV1alphaTaskConfig + type: object + description: >- + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + GoogleProtobufEmpty: + properties: {} + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } type: object + id: GoogleProtobufEmpty + GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails: + description: Sub Integration which would be created via templates. + id: GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails properties: - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - description: Optional. Input parameters used by integration execution. - triggerId: + integration: type: string description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id) - parameterEntries: + Required. Name of the sub integration which would be created via + templates. + integrationDescription: + type: string description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same integration - execution. - deprecated: true + Optional. Description of the sub integration which would be created + via templates. + type: object + GoogleCloudIntegrationsV1alphaUseTemplateResponse: + id: GoogleCloudIntegrationsV1alphaUseTemplateResponse + type: object + description: Response for use template + properties: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: IntegrationVersion which is created. + subIntegrationVersions: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + type: array + description: Sub integration versions which are created. + GoogleCloudIntegrationsV1alphaImportTemplateResponse: + id: GoogleCloudIntegrationsV1alphaImportTemplateResponse + description: Response for import template + properties: + subIntegrationVersions: type: array + description: Sub integration versions which are imported. items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - scheduleTime: - description: >- - The time that the integration should be executed. If the time is - less or equal to the current time, the integration is executed - immediately. - format: google-datetime - type: string - parameters: - description: Passed in as parameters to each integration execution. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: IntegrationVersion after the import. + type: object + EnterpriseCrmEventbusProtoEventExecutionSnapshot: + type: object + properties: + taskExecutionDetails: + description: All of the task execution details at the given point of time. + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails + type: array + taskName: deprecated: true - userGeneratedExecutionId: - description: >- - Optional. This is a unique id provided by the method caller. If - provided this will be used as the execution_id when a new execution - info is created. This is a string representation of a UUID. Must - have no more than 36 characters and contain only alphanumeric - characters and hyphens. + description: The task name associated with this snapshot. Could be empty. type: string - requestId: - description: >- - This is used to de-dup incoming request: if the duplicate request - was detected, the response from the previous execution is returned. + workflowName: type: string - description: 'The request for scheduling an integration. Next available id: 11' - id: GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest - EnterpriseCrmEventbusProtoParameterEntry: - id: EnterpriseCrmEventbusProtoParameterEntry - properties: - masked: - type: boolean - description: True if this parameter should be masked in the logs - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - key: + description: Name of the workflow this event execution snapshot belongs to. + eventExecutionInfoId: type: string + description: Points to the event execution info this snapshot belongs to. + checkpointTaskNumber: description: >- - Key is used to retrieve the corresponding parameter value. This - should be unique for a given fired event. These parameters must be - predefined in the integration definition. - type: object - description: Key-value pair of EventBus parameters. - GoogleCloudIntegrationsV1alphaCredential: - description: Defines parameters for a single, canonical credential. - id: GoogleCloudIntegrationsV1alphaCredential - properties: - credentialType: - description: Credential type associated with auth config. - enumDescriptions: - - Unspecified credential type - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN + Indicates "right after which checkpoint task's execution" this + snapshot is taken. + type: string + clientId: + description: Client that the execution snapshot is associated to. + type: string + eventExecutionSnapshotId: type: string - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials - description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials - oauth2ResourceOwnerCredentials: - description: OAuth2 resource owner credentials - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials - usernameAndPassword: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword - description: Username and password credential - authToken: - description: Auth token credential - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' - oidcToken: - description: Google OIDC ID Token - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' - oauth2AuthorizationCode: description: >- - The api_key and oauth2_implicit are not covered in v1 and will be - picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 - authorization code credential - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode - jwt: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' - description: JWT credential - serviceAccountCredentials: + Auto-generated. Used as primary key for EventExecutionSnapshots + table. + eventExecutionSnapshotMetadata: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials - description: Service account credential - type: object - EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: - id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - type: object - properties: - endTime: - format: int64 - type: string - description: The end time of the event execution for current attempt. - startTime: + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata + snapshotTime: + description: Indicates when this snapshot is taken. format: int64 type: string - description: >- - The start time of the event execution for current attempt. This - could be in the future if it's been scheduled. - GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse: - id: GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse - type: object - description: Response to list SfdcInstances. - properties: - sfdcInstances: - type: array - description: The list of SfdcInstances retrieved. + diffParams: + description: The parameters in Event object that differs from last snapshot. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + exceedMaxSize: + type: boolean + description: indicate whether snapshot exceeded maximum size before clean up + eventParams: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters in Event object. + conditionResults: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' - nextPageToken: - description: The token used to retrieve the next page of results. - type: string - EnterpriseCrmEventbusProtoIntFunction: - id: EnterpriseCrmEventbusProtoIntFunction + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' + type: array + description: All of the computed conditions that been calculated. + description: >- + Contains the snapshot of the event execution for a given checkpoint. + Next available id: 15 + id: EnterpriseCrmEventbusProtoEventExecutionSnapshot + EnterpriseCrmEventbusProtoBooleanArrayFunction: + id: EnterpriseCrmEventbusProtoBooleanArrayFunction + type: object properties: functionName: enumDescriptions: @@ -2466,567 +2421,319 @@ components: - '' - '' - '' - - '' - - '' - - '' - type: string enum: - UNSPECIFIED - - ADD - - SUBTRACT - - MULTIPLY - - DIVIDE - - EXPONENT - - GREATER_THAN_EQUAL_TO - - GREATER_THAN - - LESS_THAN_EQUAL_TO - - LESS_THAN - - TO_DOUBLE - - TO_STRING - - EQUALS + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL - TO_JSON - - MOD - - EPOCH_TO_HUMAN_READABLE_TIME - type: object - EnterpriseCrmEventbusProtoExternalTraffic: - type: object + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + type: string + GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: properties: - gcpProjectId: + task: + description: the task name associated with this snapshot. type: string - description: User’s GCP project id the traffic is referring to. - retryRequestForQuota: - description: Enqueue the execution request due to quota issue - type: boolean - source: - enumDescriptions: - - '' - - '' - - '' - type: string - description: >- - LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, - //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product) - enum: - - SOURCE_UNSPECIFIED - - APIGEE - - SECURITY - gcpProjectNumber: - description: User’s GCP project number the traffic is referring to. - type: string - location: - type: string - description: Location for the user's request. - description: Represents external traffic type and id. - id: EnterpriseCrmEventbusProtoExternalTraffic - EnterpriseCrmEventbusProtoParameterValueType: - description: >- - LINT.IfChange To support various types of parameter values. Next - available id: 14 - properties: - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringParameterArray' - intValue: - format: int64 - type: string - booleanValue: - type: boolean - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleParameterArray' - protoArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoParameterArray' - booleanArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanParameterArray' - doubleValue: - type: number - format: double - protoValue: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - stringValue: - type: string - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntParameterArray' - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSerializedObjectParameter - id: EnterpriseCrmEventbusProtoParameterValueType - type: object - GoogleCloudIntegrationsV1alphaIntegrationVersion: - id: GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The integration version definition. - properties: - state: - readOnly: true - enumDescriptions: - - Default. - - Draft. - - Active. - - Archived. - - Snapshot. - enum: - - INTEGRATION_STATE_UNSPECIFIED - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT + taskLabel: + description: the task label associated with this snapshot. Could be empty. type: string - description: Output only. User should not set it as an input. - createdFromTemplate: + taskNumber: type: string + description: The task number associated with this snapshot. + ancestorIterationNumbers: + type: array description: >- - Optional. Optional. The resource name of the template from which the - integration is created. - lastModifierEmail: - type: string + Ancestor iteration number for the task(it will only be non-empty if + the task is under 'private workflow') + items: + type: string + ancestorTaskNumbers: description: >- - Optional. The last modifier's email address. Generated based on the - End User Credentials/LOAS role of the user making the call. - userLabel: - type: string + Ancestor task number for the task(it will only be non-empty if the + task is under 'private workflow') + type: array + items: + type: string + executionAttempt: + type: integer + description: the execution attempt number this snapshot belongs to. + format: int32 + integrationName: description: >- - Optional. A user-defined label that annotates an integration - version. Typically, this is only set when the integration version is - created. - cloudLoggingDetails: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails - description: Optional. Cloud Logging details for the integration version - description: + The direct integration which the event execution snapshots belongs + to type: string - description: Optional. The integration description. - enableVariableMasking: - description: >- - Optional. True if variable masking feature should be turned on for - this version - type: boolean - triggerConfigs: + taskAttempt: + type: integer + description: the task attempt number this snapshot belongs to. + format: int32 + description: Metadata of the execution snapshot. + id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + type: object + GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: + description: Response for listing RuntimeEntitySchemas for a specific Connection. + id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + type: object + properties: + nextPageToken: + description: Next page token. + type: string + runtimeEntitySchemas: type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' - description: Optional. Trigger configurations. - integrationParameters: + description: Runtime entity schemas. items: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema + GoogleCloudIntegrationsV1alphaCloudKmsConfig: + properties: + kmsRing: description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. - type: array - parentTemplateId: + Required. A key ring organizes keys in a specific Google Cloud + location and allows you to manage access control on groups of keys. + A key ring's name does not need to be unique across a Google Cloud + project, but must be unique within a given location. type: string + keyVersion: description: >- - Optional. The id of the template which was used to create this - integration_version. - createTime: - description: Output only. Auto-generated. - readOnly: true + Optional. Each version of a key contains key material used for + encryption or signing. A key's version is represented by an integer, + starting at 1. To decrypt data or verify a signature, you must use + the same key version that was used to encrypt or sign the data. type: string - format: google-datetime - databasePersistencePolicy: + kmsProjectId: type: string description: >- - Optional. Flag to disable database persistence for execution data, - including event execution info, execution export info, execution - metadata index and execution param index. - enumDescriptions: - - Enables persistence for all execution data. - - Disables persistence for all execution data. - - Asynchronously persist all execution data. - enum: - - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED - - DATABASE_PERSISTENCE_DISABLED - - DATABASE_PERSISTENCE_ASYNC - origin: + Optional. The gcp project id of the project where the kms key + stored. If empty, the kms key is stored at the same project as + customer's project and ecrypted with CMEK, otherwise, the kms key is + stored in the tenant project and encrypted with GMEK + kmsLocation: + description: Required. Location name of the key ring, e.g. "us-west1". + type: string + key: + type: string description: >- - Optional. The origin that indicates where this integration is coming - from. - deprecated: true + Required. A Cloud KMS key is a named object containing one or more + key versions, along with metadata for the key. A key exists on + exactly one key ring tied to a specific location. + description: Configuration information for Client's Cloud KMS information + id: GoogleCloudIntegrationsV1alphaCloudKmsConfig + type: object + EnterpriseCrmEventbusProtoBaseFunction: + type: object + id: EnterpriseCrmEventbusProtoBaseFunction + properties: + functionName: enum: - UNSPECIFIED - - UI - - PIPER_V2 - - PIPER_V3 - - APPLICATION_IP_PROVISIONING - - TEST_CASE - enumDeprecated: - - false - - false - - true - - false - - false - - false + - NOW_IN_MILLIS + - INT_LIST + - ENVIRONMENT + - GET_EXECUTION_ID + - GET_INTEGRATION_NAME + - GET_REGION + - GET_UUID + - GET_PROJECT_ID enumDescriptions: - '' - - Workflow is being created via event bus UI. - - >- - User checked in this workflow in Piper as v2 textproto format and - we synced it into spanner. - - >- - User checked in this workflow in piper as v3 textproto format and - we synced it into spanner. - - Workflow is being created via Standalone IP Provisioning - - Workflow is being created via Test Case. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - errorCatcherConfigs: + EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: + type: object + properties: + protoValues: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object type: array - description: >- - Optional. Error Catch Task configuration for the integration. It's - optional. - taskConfigsInternal: - items: - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' - deprecated: true - description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - type: array - triggerConfigsInternal: - description: Optional. Trigger configurations. - type: array - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig - snapshotNumber: - format: int64 - description: >- - Optional. An increasing sequence that is set when a new snapshot is - created. The last created snapshot can be identified by - [workflow_name, org_id latest(snapshot_number)]. However, last - created snapshot need not be same as the HEAD. So users should - always use "HEAD" tag to identify the head. - type: string - integrationConfigParameters: + id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + EnterpriseCrmEventbusProtoEventBusProperties: + description: >- + LINT.IfChange This message is used for storing key value pair properties + for each Event / Task in the EventBus. + id: EnterpriseCrmEventbusProtoEventBusProperties + properties: + properties: type: array items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - description: >- - Optional. Config Parameters that are expected to be passed to the - integration when an integration is published. This consists of all - the parameters that are expected to provide configuration in the - integration execution. This gives the user the ability to provide - default values, value, add information like connection url, project - based configuration value and also provide data types of each - parameter. - runAsServiceAccount: - description: >- - Optional. The run-as service account email, if set and auth config - is not configured, that will be used to generate auth token to be - used in Connector task, Rest caller task and Cloud function task. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' + description: An unordered list of property entries. + type: object + GoogleCloudIntegrationsV1alphaIntegration: + type: object + description: The integration definition. + properties: + active: + type: boolean + description: Required. If any integration version is published. + description: type: string - taskConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' - description: >- - Optional. Task configuration for the integration. It's optional, but - the integration doesn't do anything without task_configs. - lockHolder: - description: >- - Optional. The edit lock holder's email address. Generated based on - the End User Credentials/LOAS role of the user making the call. + description: Optional. + createTime: + description: Required. Output only. Auto-generated. type: string - name: - description: Output only. Auto-generated primary key. + format: google-datetime readOnly: true + name: + description: Required. The resource name of the integration. type: string - teardown: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' - description: >- - Optional. Contains a graph of tasks that will be executed before - putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), - regardless of success or failure, similar to "finally" in code. - deprecated: true - integrationParametersInternal: - description: >- - Optional. Parameters that are expected to be passed to the - integration when an event is triggered. This consists of all the - parameters that are expected in the integration execution. This - gives the user the ability to provide default values, add - information like PII and also provide data types of each parameter. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - deprecated: true - status: - enum: - - UNKNOWN - - DRAFT - - ACTIVE - - ARCHIVED - - SNAPSHOT + creatorEmail: + readOnly: true description: >- - Output only. Generated by eventbus. User should not set it as an - input. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - deprecated: true + Output only. The creator's email address. Generated based on the End + User Credentials/LOAS role of the user making the call. type: string - readOnly: true updateTime: - format: google-datetime - description: Output only. Auto-generated. type: string readOnly: true + description: Output only. Auto-generated. + format: google-datetime + lastModifierEmail: + type: string + description: Required. The last modifier of this integration + id: GoogleCloudIntegrationsV1alphaIntegration + GoogleCloudIntegrationsV1alphaListSuspensionsResponse: + id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse + description: Response for Suspensions.ListSuspensions. type: object - EnterpriseCrmEventbusProtoSuccessPolicy: - description: >- - Policy that dictates the behavior for the task after it completes - successfully. + properties: + nextPageToken: + type: string + description: Token to retrieve the next page of results. + suspensions: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + description: >- + The suspensions for the relevant execution which the caller has + permissions to view and resolve. + GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate: + properties: + key: + type: string + description: Required. Unique Key of the IntegrationVersion. + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Required. Templatized version of integration. + id: GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + description: Define the template of IntegrationVersion. + type: object + EnterpriseCrmEventbusProtoCoordinate: + description: Represents two-dimensional positions. + id: EnterpriseCrmEventbusProtoCoordinate type: object - id: EnterpriseCrmEventbusProtoSuccessPolicy properties: - finalState: + x: + type: integer + format: int32 + 'y': + format: int32 + type: integer + EnterpriseCrmEventbusProtoBaseValue: + properties: + baseFunction: description: >- - State to which the execution snapshot status will be set if the task - succeeds. + Start with a function that does not build on existing values. Eg. + CurrentTime, Min, Max, Exists, etc. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + referenceValue: type: string - enum: - - UNSPECIFIED - - SUCCEEDED - - SUSPENDED - enumDescriptions: - - '' - - >- - The default behavior, where successful tasks will be marked as - SUCCEEDED. - - >- - Sets the state to SUSPENDED after executing. This is required for - SuspensionTask; event execution will continue once the user calls - ResolveSuspensions with the event_execution_info_id and the task - number. - EnterpriseCrmEventbusProtoTaskAlertConfig: - id: EnterpriseCrmEventbusProtoTaskAlertConfig + description: Start with a reference value to dereference. + literalValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Start with a literal value. + type: object + id: EnterpriseCrmEventbusProtoBaseValue + GoogleCloudIntegrationsV1alphaClientConfig: + description: The configuration information for the Client + id: GoogleCloudIntegrationsV1alphaClientConfig type: object - description: >- - Message to be used to configure alerting in the {@code TaskConfig} - protos for tasks in an event. properties: - alertName: + clientState: + type: string + description: Indicates the activity state the client + enumDescriptions: + - The client state is unspecified + - The client is active and able to make calls to the IP APIs + - The client is disabled and will soon be deleted + enum: + - CLIENT_STATE_UNSPECIFIED + - CLIENT_STATE_ACTIVE + - CLIENT_STATE_DISABLED + cloudKmsConfig: + description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + id: + type: string + description: Globally unique ID (project_id + region) + p4ServiceAccount: + type: string + description: The service agent associated with this client + runAsServiceAccount: type: string description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique in within the scope of - the containing workflow. - onlyFinalAttempt: + Default run-as service account email, set up during project + provision time, that will be used to generate auth token to be used + in Connector task, Rest caller task, Cloud function task and + Subworkflows. + projectId: + type: string + description: The GCP project id of the client associated with + isGmek: type: boolean - description: Only count final task attempts, not retries. - playbookUrl: - description: >- - Link to a playbook for resolving the issue that triggered this - alert. + description: Optional. Indicates the client is provisioned with CMEK or GMEK. + createTime: + format: google-datetime type: string - durationThresholdMs: + description: The timestamp when the client was first created. + region: + description: The region the client is linked to. type: string + enableVariableMasking: description: >- - Should be specified only for TASK_AVERAGE_DURATION and - TASK_PERCENTILE_DURATION metrics. This member should be used to - specify what duration value the metrics should exceed for the alert - to trigger. - format: int64 - numAggregationPeriods: - format: int32 - type: integer + Optional. True if variable masking feature should be turned on for + this region + type: boolean + enableInternalIp: + type: boolean description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - clientId: + Optional. Indicates the client enables internal IP feature, this is + applicable for internal clients only. + billingType: type: string - description: >- - Client associated with this alert configuration. Must be a client - enabled in one of the containing workflow's triggers. - metricType: enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors (potentially for a - specific set of enum values) for the enclosing TaskConfig. - - >- - Specifies alerting on the rate of warnings (potentially for a - specific set of enum values) for the enclosing TaskConfig. - Warnings use the same enum values as errors. - - >- - Specifies alerting on the number of instances for the enclosing - TaskConfig executed in the given aggregation_period. - - >- - Specifies alerting on the average duration of execution for the - enclosing task. - - >- - Specifies alerting on the duration of a particular percentile of - task executions. E.g. If 10% or more of the task executions have - durations above 5 seconds, alert. - enum: - - METRIC_TYPE_UNSPECIFIED - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - type: string - alertDisabled: - type: boolean - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - thresholdType: + - Unspecified billing type + - A trial org provisioned through Apigee Provisioning Wizard + - Subscription based users of Apigee + - Consumption based users of IP + description: Indicates the billing type of the client enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX - description: >- - The threshold type for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - type: string - enumDescriptions: - - '' - - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. - - '' - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - aggregationPeriod: - type: string - description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). - thresholdValue: - description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - GoogleCloudIntegrationsV1alphaClientCertificate: - id: GoogleCloudIntegrationsV1alphaClientCertificate - type: object - description: Contains client certificate information - properties: - passphrase: - description: >- - 'passphrase' should be left unset if private key is not encrypted. - Note that 'passphrase' is not the password for web server, but an - extra layer of security to protected private key. - type: string - encryptedPrivateKey: - type: string - description: >- - The ssl certificate encoded in PEM format. This string must include - the begin header and end footer lines. For example, -----BEGIN - CERTIFICATE----- - MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV - BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw - MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET - MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA - vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 - JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB - xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P - AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB - Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey - Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW - JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr - 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H - wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - sslCertificate: - type: string - description: >- - The ssl certificate encoded in PEM format. This string must include - the begin header and end footer lines. For example, -----BEGIN - CERTIFICATE----- - MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV - BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw - MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET - MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA - vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 - JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB - xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P - AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB - Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey - Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW - JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr - 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H - wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- - GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata: - properties: - ancestorIterationNumbers: - type: array - items: - type: string - description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - taskLabel: - description: the task label associated with this snapshot. Could be empty. - type: string - taskAttempt: - type: integer - format: int32 - description: the task attempt number this snapshot belongs to. - task: - type: string - description: the task name associated with this snapshot. - ancestorTaskNumbers: - items: - type: string - description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - type: array - taskNumber: - type: string - description: The task number associated with this snapshot. - integrationName: - description: >- - The direct integration which the event execution snapshots belongs - to - type: string - executionAttempt: - format: int32 - description: the execution attempt number this snapshot belongs to. - type: integer - type: object - description: Metadata of the execution snapshot. - id: GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: - properties: - suspensionResult: + - BILLING_TYPE_UNSPECIFIED + - BILLING_TYPE_APIGEE_TRIALS + - BILLING_TYPE_APIGEE_SUBSCRIPTION + - BILLING_TYPE_PAYG + description: + description: Description of what the client is used for type: string - description: >- - User passed in suspension result and will be used to control - workflow execution branching behavior by setting up corresponnding - edge condition with suspension result. For example, if you want to - lift the suspension, you can pass "Approved", or if you want to - reject the suspension and terminate workfloe execution, you can pass - "Rejected" and terminate the workflow execution with configuring the - edge condition. + EnterpriseCrmEventbusProtoProtoFunction: type: object - description: Request for lift Suspension - id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest - EnterpriseCrmEventbusProtoBaseFunction: properties: functionName: enumDescriptions: @@ -3039,1292 +2746,1140 @@ components: - '' - '' - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - UNSPECIFIED - - NOW_IN_MILLIS - - INT_LIST - - ENVIRONMENT - - GET_EXECUTION_ID - - GET_INTEGRATION_NAME - - GET_REGION - - GET_UUID - - GET_PROJECT_ID + - GET_STRING_SUBFIELD + - GET_INT_SUBFIELD + - GET_DOUBLE_SUBFIELD + - GET_BOOLEAN_SUBFIELD + - GET_STRING_ARRAY_SUBFIELD + - GET_INT_ARRAY_SUBFIELD + - GET_DOUBLE_ARRAY_SUBFIELD + - GET_BOOLEAN_ARRAY_SUBFIELD + - GET_PROTO_ARRAY_SUBFIELD + - GET_PROTO_SUBFIELD + - TO_JSON + - GET_BYTES_SUBFIELD_AS_UTF_8_STRING + - GET_BYTES_SUBFIELD_AS_PROTO + - EQUALS type: string + id: EnterpriseCrmEventbusProtoProtoFunction + GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: + id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + description: Request for the Deprovision rpc + properties: {} type: object - id: EnterpriseCrmEventbusProtoBaseFunction - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: - properties: - min: - type: number - description: The inclusive minimum of the acceptable range. - format: double - max: - format: double - type: number - description: The inclusive maximum of the acceptable range. - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + GoogleCloudIntegrationsV1alphaTemplateComponent: + description: Define the components that are present in a template. type: object - description: Range used to validate doubles and floats. - GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: properties: - location: - description: >- - Required. The location where associated cloud scheduler job will be - created - type: string - serviceAccountEmail: - description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time + type: type: string - cronTab: - description: Required. The cron tab of cloud scheduler trigger. + enumDescriptions: + - Component type is unspecified + - Trigger component + - Task component + - Connector component + enum: + - TYPE_UNSPECIFIED + - TRIGGER + - TASK + - CONNECTOR + description: Optional. Type of the component. + name: + description: Optional. Name of the component. type: string - errorMessage: + id: GoogleCloudIntegrationsV1alphaTemplateComponent + GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: + description: Request for Creating Cloud Function rpc call. + properties: + projectId: type: string description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - type: object - description: Cloud Scheduler Trigger configuration - GoogleCloudConnectorsV1AuthConfigSshPublicKey: - properties: - sshClientCertPass: - description: Password (passphrase) for ssh client certificate if it has one. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - certType: + Indicates the id of the GCP project that the function will be + created in. + functionRegion: + description: The function region of CF to be created type: string - description: Format of SSH Client cert. - sshClientCert: - description: SSH Client Cert. It should contain both public and private key. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - username: - description: The user account used to authenticate. + functionName: + description: The function name of CF to be created type: string + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest type: object - id: GoogleCloudConnectorsV1AuthConfigSshPublicKey - description: Parameters to support Ssh public key Authentication. - GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: - id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse - description: Response for DownloadJsonPackage. - properties: - files: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' - description: List containing JSON for multiple file with type information. - type: array - type: object - GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: + GoogleCloudIntegrationsV1alphaIntegrationVersion: type: object properties: - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message or a serialized object. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - parameter: + integrationParametersInternal: + deprecated: true description: >- - Optional. Integration Parameter to provide the default value, data - type and attributes required for the Integration config variables. + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter - description: >- - Integration Config Parameter is defined in the integration config and - are used to provide external configuration for integration. It provide - information about data types of the expected parameters and provide any - default values or value. They can also be used to add custom attributes. - id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter - GoogleCloudIntegrationsV1alphaReplayExecutionResponse: - type: object - properties: - outputParameters: - type: object - description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. The parameters would only be present in case of - synchrounous execution Note: Name of the system generated parameters - are wrapped by backtick(`) to distinguish them from the user defined - parameters. - additionalProperties: - type: any - description: Properties of the object. - executionId: - type: string - description: The id of the execution corresponding to this run of integration. - replayedExecutionId: + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + runAsServiceAccount: type: string - description: The execution id which is replayed - id: GoogleCloudIntegrationsV1alphaReplayExecutionResponse - description: 'Response for replaying an execution Next ID: 4' - GoogleCloudIntegrationsV1alphaServiceAccountCredentials: - description: >- - Represents the service account which can be used to generate access - token for authenticating the service call. - properties: - serviceAccount: description: >- - Name of the service account that has the permission to make the - request. - type: string - scope: - description: A space-delimited list of requested scope permissions. - type: string - type: object - id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials - EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - type: object - properties: - resolvedBy: - type: string - resolvedByCpi: + Optional. The run-as service account email, if set and auth config + is not configured, that will be used to generate auth token to be + used in Connector task, Rest caller task and Cloud function task. + userLabel: type: string - timestamp: + description: >- + Optional. A user-defined label that annotates an integration + version. Typically, this is only set when the integration version is + created. + cloudLoggingDetails: + description: Optional. Cloud Logging details for the integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + integrationParameters: + description: >- + Optional. Parameters that are expected to be passed to the + integration when an event is triggered. This consists of all the + parameters that are expected in the integration execution. This + gives the user the ability to provide default values, add + information like PII and also provide data types of each parameter. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter + integrationConfigParameters: + type: array + description: >- + Optional. Config Parameters that are expected to be passed to the + integration when an integration is published. This consists of all + the parameters that are expected to provide configuration in the + integration execution. This gives the user the ability to provide + default values, value, add information like connection url, project + based configuration value and also provide data types of each + parameter. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationConfigParameter + teardown: + description: >- + Optional. Contains a graph of tasks that will be executed before + putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), + regardless of success or failure, similar to "finally" in code. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardown' + deprecated: true + state: + readOnly: true + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + description: Output only. User should not set it as an input. + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT type: string - format: google-datetime - EnterpriseCrmEventbusProtoNextTeardownTask: - description: >- - The teardown task that is next in line to be executed. We support only - sequential execution of teardown tasks (i.e. no branching). - id: EnterpriseCrmEventbusProtoNextTeardownTask - properties: - name: + taskConfigsInternal: + type: array + description: >- + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + deprecated: true + items: + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskConfig' + triggerConfigsInternal: + deprecated: true + description: Optional. Trigger configurations. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoTriggerConfig + triggerConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTriggerConfig' + description: Optional. Trigger configurations. + lockHolder: type: string - description: Required. Name of the next teardown task. - type: object - GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: - id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse - properties: - projectId: + description: >- + Optional. The edit lock holder's email address. Generated based on + the End User Credentials/LOAS role of the user making the call. + createdFromTemplate: type: string - description: The created AppsScriptProject ID. - type: object - description: Response for CreateAppsScriptProject rpc call. - EnterpriseCrmEventbusProtoDoubleArrayFunction: - type: object - properties: - functionName: + description: >- + Optional. Optional. The resource name of the template from which the + integration is created. + status: enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + - UNKNOWN + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + type: string + readOnly: true + description: >- + Output only. Generated by eventbus. User should not set it as an + input. + deprecated: true enumDescriptions: - '' - '' - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: string - id: EnterpriseCrmEventbusProtoDoubleArrayFunction - EnterpriseCrmEventbusProtoTaskMetadata: - description: >- - TaskMetadata are attributes that are associated to every common Task we - have. - type: object - id: EnterpriseCrmEventbusProtoTaskMetadata - properties: - externalDocLink: - type: string - description: Doc link for external-facing documentation (separate from g3doc). - g3DocLink: - type: string - description: URL to the associated G3 Doc for the task if available - standaloneExternalDocHtml: - description: >- - External-facing documention for standalone IP in pantheon embedded - in the RHP for this task. Non null only if different from - external_doc_html - type: string - tags: + errorCatcherConfigs: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaErrorCatcherConfig type: array description: >- - A set of tags that pertain to a particular task. This can be used to - improve the searchability of tasks with several names ("REST Caller" - vs. "Call REST Endpoint") or to help users find tasks based on - related words. - items: - type: string - defaultSpec: + Optional. Error Catch Task configuration for the integration. It's + optional. + lastModifierEmail: description: >- - Contains the initial configuration of the task with default values - set. For now, The string should be compatible to an ASCII-proto - format. + Optional. The last modifier's email address. Generated based on the + End User Credentials/LOAS role of the user making the call. type: string - name: + enableVariableMasking: + type: boolean description: >- - The actual class name or the annotated name of the task. Task Author - should initialize this field with value from the getName() method of - the Task class. + Optional. True if variable masking feature should be turned on for + this version + updateTime: + format: google-datetime + description: Output only. Auto-generated. type: string - status: + readOnly: true + taskConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTaskConfig' + description: >- + Optional. Task configuration for the integration. It's optional, but + the integration doesn't do anything without task_configs. + origin: + enumDeprecated: + - false + - false + - true + - false + - false + - false + deprecated: true enumDescriptions: + - '' + - Workflow is being created via event bus UI. - >- - Default value. Actual Task Status should always be set to either - INACTIVE or ACTIVE. If none is specified at runtime, it will be - set to INACTIVE. - - Still in-progress or incomplete, and not intended for use. - - Available for use. - enum: - - UNSPECIFIED_STATUS - - DEFAULT_INACTIVE - - ACTIVE + User checked in this workflow in Piper as v2 textproto format and + we synced it into spanner. + - >- + User checked in this workflow in piper as v3 textproto format and + we synced it into spanner. + - Workflow is being created via Standalone IP Provisioning + - Workflow is being created via Test Case. type: string description: >- - Allows author to indicate if the task is ready to use or not. If not - set, then it will default to INACTIVE. - system: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' + Optional. The origin that indicates where this integration is coming + from. enum: - - UNSPECIFIED_SYSTEM - - GENERIC - - BUGANIZER - - SALESFORCE - - CLOUD_SQL - - PLX - - SHEETS - - GOOGLE_GROUPS - - EMAIL - - SPANNER - - DATA_BRIDGE - type: string - isDeprecated: - type: boolean - description: The deprecation status of the current task. Default value is false; - externalDocHtml: + - UNSPECIFIED + - UI + - PIPER_V2 + - PIPER_V3 + - APPLICATION_IP_PROVISIONING + - TEST_CASE + createTime: type: string - description: External-facing documention embedded in the RHP for this task. - activeTaskName: + format: google-datetime + description: Output only. Auto-generated. + readOnly: true + description: type: string - description: >- - The new task name to replace the current task if it is deprecated. - Otherwise, it is the same as the current task name. - externalCategory: - enumDescriptions: - - '' - - '' - - '' - - HTTP tasks, e.g. rest api call task - - Integration services, e.g. connector task - - Customer ations, e.g. email task - - Flow control, e.g. while loop task - - Workspace tasks, e.g. list drive task - - Security, e.g. kms related tasks - - Database operation tasks, e.g. read firestore info tasks - - Analytics tasks, e.g. dataflow creattion tasks - - BYOC tasks - - BYOT tasks - - AI related tasks. - - Data manipulation related tasks, e.g. data mapping task + description: Optional. The integration description. + name: type: string + description: Output only. Auto-generated primary key. + readOnly: true + databasePersistencePolicy: enum: - - UNSPECIFIED_EXTERNAL_CATEGORY - - CORE - - CONNECTORS - - EXTERNAL_HTTP - - EXTERNAL_INTEGRATION_SERVICES - - EXTERNAL_CUSTOMER_ACTIONS - - EXTERNAL_FLOW_CONTROL - - EXTERNAL_WORKSPACE - - EXTERNAL_SECURITY - - EXTERNAL_DATABASES - - EXTERNAL_ANALYTICS - - EXTERNAL_BYOC - - EXTERNAL_BYOT - - EXTERNAL_ARTIFICIAL_INTELIGENCE - - EXTERNAL_DATA_MANIPULATION - admins: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' - type: array - externalCategorySequence: - type: integer - format: int32 - description: >- - Sequence with which the task in specific category to be displayed in - task discovery panel for external users. - codeSearchLink: + - DATABASE_PERSISTENCE_POLICY_UNSPECIFIED + - DATABASE_PERSISTENCE_DISABLED + - DATABASE_PERSISTENCE_ASYNC type: string - description: The Code Search link to the Task Java file. - defaultJsonValidationOption: - enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION description: >- - Controls whether JSON workflow parameters are validated against - provided schemas before and/or after this task's execution. - type: string + Optional. Flag to disable database persistence for execution data, + including event execution info, execution export info, execution + metadata index and execution param index. enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. - docMarkdown: - type: string - description: Snippet of markdown documentation to embed in the RHP for this task. - description: - description: In a few sentences, describe the purpose and usage of the task. - type: string - descriptiveName: + - Enables persistence for all execution data. + - Disables persistence for all execution data. + - Asynchronously persist all execution data. + parentTemplateId: type: string description: >- - The string name to show on the task list on the Workflow editor - screen. This should be a very short, one to two words name for the - task. (e.g. "Send Mail") - externalDocMarkdown: - description: 'DEPRECATED: Use external_doc_html.' - type: string - category: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - Internal IP tasks that should not be available in the UI. - - Tasks that are relevant to cloud systems teams and typically - - >- - include connecting to Vector salesforce, CRM Hub Spanner etc. Task - entities that derive from a custom task template. - - Category to show task recommendations - enum: - - UNSPECIFIED_CATEGORY - - CUSTOM - - FLOW_CONTROL - - DATA_MANIPULATION - - SCRIPTING - - CONNECTOR - - HIDDEN - - CLOUD_SYSTEMS - - CUSTOM_TASK_TEMPLATE - - TASK_RECOMMENDATIONS - type: string - iconLink: - type: string + Optional. The id of the template which was used to create this + integration_version. + snapshotNumber: description: >- - URL to gstatic image icon for this task. This icon shows up on the - task list panel along with the task name in the Workflow Editor - screen. Use the 24p, 2x, gray color icon image format. - EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: - type: object - properties: - endTime: - description: The end time of the task execution for current attempt. + Optional. An increasing sequence that is set when a new snapshot is + created. The last created snapshot can be identified by + [workflow_name, org_id latest(snapshot_number)]. However, last + created snapshot need not be same as the HEAD. So users should + always use "HEAD" tag to identify the head. format: int64 type: string - startTime: - format: int64 + description: The integration version definition. + id: GoogleCloudIntegrationsV1alphaIntegrationVersion + EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: + id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam + type: object + properties: + allowedCredentialTypes: description: >- - The start time of the task execution for current attempt. This could - be in the future if it's been scheduled. + Defines the credential types to be supported as Task may restrict + specific types to use, e.g. Cloud SQL Task will use + username/password type only. + items: + enumDescriptions: + - '' + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + type: string + type: array + authConfigId: + description: UUID of the AuthConfig. type: string - id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats - EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: - description: List of error enums for alerts. - properties: - filterType: - enumDescriptions: - - '' - - '' - enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE + scope: + description: A space-delimited list of requested scope permissions. type: string - enumStrings: + useServiceAccountInContext: + type: boolean + allowedServiceAccountInContext: + type: boolean + EnterpriseCrmEventbusProtoStringArray: + type: object + id: EnterpriseCrmEventbusProtoStringArray + properties: + values: items: type: string type: array - id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - type: object - EnterpriseCrmEventbusProtoBuganizerNotification: - type: object - id: EnterpriseCrmEventbusProtoBuganizerNotification + EnterpriseCrmEventbusProtoConditionResult: properties: - assigneeEmailAddress: + currentTaskNumber: + description: the current task number. type: string - description: Whom to assign the new bug. Optional. - templateId: - format: int64 + result: + description: >- + the result comes out after evaluate the combined condition. True if + there's no combined condition specified. + type: boolean + nextTaskNumber: type: string - description: ID of the buganizer template to use. Optional. - componentId: + description: the next task number. + description: Contains the combined condition calculation results. + id: EnterpriseCrmEventbusProtoConditionResult + type: object + GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse: + properties: + nextPageToken: + type: string + description: Next page token. + runtimeActionSchemas: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeActionSchema + description: Runtime action schemas. + type: array + description: Response for listing RuntimeActionSchemas for a specific Connection. + type: object + id: GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange: + properties: + min: + format: double + description: The inclusive minimum of the acceptable range. + type: number + max: + description: The inclusive maximum of the acceptable range. + type: number + format: double + type: object + description: Range used to validate doubles and floats. + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + GoogleCloudConnectorsV1EncryptionKey: + description: Encryption Key value. + id: GoogleCloudConnectorsV1EncryptionKey + properties: + kmsKeyName: type: string - format: int64 description: >- - ID of the buganizer component within which to create a new issue. - Required. - title: - description: Title of the issue to be created. Required. + The [KMS key name] with which the content of the Operation is + encrypted. The expected format: + `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty + string if google managed. + type: + enumDescriptions: + - Value type is not specified. + - Google Managed. + - Customer Managed. type: string - GoogleCloudIntegrationsV1alphaProvisionClientRequest: + description: Type. + enum: + - TYPE_UNSPECIFIED + - GOOGLE_MANAGED + - CUSTOMER_MANAGED type: object - description: Request for the Provision rpc - id: GoogleCloudIntegrationsV1alphaProvisionClientRequest + EnterpriseCrmEventbusProtoDoubleArray: + properties: + values: + items: + format: double + type: number + type: array + type: object + id: EnterpriseCrmEventbusProtoDoubleArray + GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest: properties: cloudKmsConfig: $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' description: >- - Optional. OPTIONAL: Cloud KMS config for AuthModule to + Required. REQUIRED: Cloud KMS config for AuthModule to encrypt/decrypt credentials. - runAsServiceAccount: - type: string - description: >- - Optional. User input run-as service account, if empty, will bring up - a new default service account - createSampleWorkflows: - type: boolean + description: Request for the SwitchEncryption rpc + type: object + id: GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + EnterpriseCrmEventbusProtoNextTask: + properties: + combinedConditions: description: >- - Optional. Indicates if sample workflow should be created along with - provisioning - provisionGmek: + Combined condition for this task to become an eligible next task. + Each of these combined_conditions are joined with logical OR. + DEPRECATED: use `condition` + type: array deprecated: true + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' + condition: + type: string description: >- - Optional. Deprecated. Indicates provision with GMEK or CMEK. This - field is deprecated and the provision would always be GMEK if - cloud_kms_config is not present in the request. - type: boolean - skipCpProvision: - type: boolean - description: Optional. Indicates if skip CP provision or not - GoogleCloudIntegrationsV1alphaFailurePolicy: - id: GoogleCloudIntegrationsV1alphaFailurePolicy + Standard filter expression for this task to become an eligible next + task. + label: + description: User-provided label that is attached to this edge in the UI. + type: string + description: + description: >- + User-provided description intended to give more business context + about the next task edge or condition. + type: string + taskConfigId: + description: ID of the next task. + type: string + taskNumber: + type: string + description: Task number of the next task. + type: object + description: >- + The task that is next in line to be executed, if the condition specified + evaluated to true. + id: EnterpriseCrmEventbusProtoNextTask + GoogleCloudIntegrationsV1alphaExecution: + description: >- + The Execution resource contains detailed information of an individual + integration execution. + id: GoogleCloudIntegrationsV1alphaExecution type: object properties: - maxRetries: - format: int32 - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - type: integer - retryStrategy: - description: Defines what happens to the task upon failure. + responseParams: + description: Event parameters come out as part of the response. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + deprecated: true + cloudLoggingDetails: + description: Cloud Logging details for the integration version + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudLoggingDetails + executionMethod: + description: The ways user posts this event. + enum: + - EXECUTION_METHOD_UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + type: string enumDescriptions: - - UNSPECIFIED. - - >- - Ignores the failure of this task. The rest of the integration will - be executed Assuming this task succeeded. - - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the integration. - - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. - - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. max_retries - and interval_in_seconds must be specified. - - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. max_retries and - interval_in_seconds must be specified. - - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. - - >- - The entire integration will be restarted with the initial - parameters that were set when the event was fired. A max-retry - count is required to be specified with this strategy. - `max_retries` and `interval_in_seconds` must be specified. + - Default value. + - Sync post. + - Async post. + - Async post with schedule time. + createTime: type: string - enum: - - RETRY_STRATEGY_UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_INTEGRATION_WITH_BACKOFF - condition: + description: Output only. Created time of the execution. + readOnly: true + format: google-datetime + executionDetails: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecutionDetails' + description: Detailed info of this execution. + directSubExecutions: + description: Direct sub executions of the following Execution. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + requestParameters: + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Event parameters come in as part of the request. + name: type: string + description: Auto-generated primary key. + triggerId: description: >- - Optional. The string condition that will be evaluated to determine - if the task should be retried with this failure policy. - intervalTime: + The trigger id of the integration trigger config. If both trigger_id + and client_id is present, the integration is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. type: string - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines - the initial interval in seconds for backoff. + updateTime: format: google-datetime - description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). - EnterpriseCrmFrontendsEventbusProtoParameterValueType: - id: EnterpriseCrmFrontendsEventbusProtoParameterValueType - description: 'To support various types of parameter values. Next available id: 14' - type: object - properties: - intArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray - protoArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - booleanArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray - protoValue: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - stringValue: type: string - stringArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray - serializedObjectValue: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - doubleValue: - format: double - type: number - booleanValue: - type: boolean - jsonValue: + description: Output only. Last modified time of the execution. + readOnly: true + integrationVersionState: + readOnly: true + description: Output only. State of the integration version type: string - intValue: + enumDescriptions: + - Default. + - Draft. + - Active. + - Archived. + - Snapshot. + enum: + - INTEGRATION_STATE_UNSPECIFIED + - DRAFT + - ACTIVE + - ARCHIVED + - SNAPSHOT + responseParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: Event parameters returned as part of the response. + eventExecutionDetails: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetails' + description: The execution info about this event. + deprecated: true + replayInfo: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionReplayInfo + description: Output only. Replay info for the execution + readOnly: true + requestParams: + deprecated: true + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + description: Event parameters come in as part of the request. + snapshotNumber: + description: >- + Output only. An increasing sequence that is set when a new snapshot + is created + readOnly: true format: int64 type: string - doubleArray: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray - EnterpriseCrmEventbusProtoProtoFunction: - id: EnterpriseCrmEventbusProtoProtoFunction - type: object + GoogleCloudIntegrationsV1alphaIntegrationParameter: properties: - functionName: + isTransient: + type: boolean + description: Whether this parameter is a transient parameter. + description: type: string + description: Optional. Description of the parameter. + containsLargeData: + description: >- + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + type: boolean + inputOutputType: enum: - - UNSPECIFIED - - GET_STRING_SUBFIELD - - GET_INT_SUBFIELD - - GET_DOUBLE_SUBFIELD - - GET_BOOLEAN_SUBFIELD - - GET_STRING_ARRAY_SUBFIELD - - GET_INT_ARRAY_SUBFIELD - - GET_DOUBLE_ARRAY_SUBFIELD - - GET_BOOLEAN_ARRAY_SUBFIELD - - GET_PROTO_ARRAY_SUBFIELD - - GET_PROTO_SUBFIELD - - TO_JSON - - GET_BYTES_SUBFIELD_AS_UTF_8_STRING - - GET_BYTES_SUBFIELD_AS_PROTO - - EQUALS + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: - description: Request to enable/disable variable masking for a provisioned client - properties: - enableVariableMasking: + - Default. + - >- + Input parameters for the integration. EventBus validates that + these parameters exist in the integrations before execution. + - >- + Output Parameters for the integration. EventBus will only return + the integration parameters tagged with OUT in the response back. + - >- + Input and Output Parameters. These can be used as both input and + output. EventBus will validate for the existence of these + parameters before execution and will also return this parameter + back in the response. + description: Specifies the input/output type for the parameter. + type: string + producer: + type: string + description: >- + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. + masked: type: boolean + description: True if this parameter should be masked in the logs + defaultValue: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' description: >- - Required. REQUIRED: True if variable masking feature should be - turned on for this region - type: object - id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest - EnterpriseCrmEventbusProtoSerializedObjectParameter: - id: EnterpriseCrmEventbusProtoSerializedObjectParameter - properties: - objectValue: - format: byte - type: string - type: object - GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: - id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata - type: object - properties: - actions: - type: array - description: List of actions. - items: - type: string - entities: - items: - type: string - type: array - description: List of entity names. - description: Metadata of runtime connection schema. - EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule - type: object - properties: - stringRegex: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex - intRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange - doubleRange: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange - EnterpriseCrmEventbusProtoBooleanFunction: - properties: - functionName: - type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - UNSPECIFIED - - TO_JSON - - NOT - - AND - - NAND - - OR - - XOR - - NOR - - XNOR - - TO_STRING - - EQUALS - type: object - id: EnterpriseCrmEventbusProtoBooleanFunction - GoogleCloudIntegrationsV1alphaDoubleParameterArray: - properties: - doubleValues: - description: Double number array. - type: array - items: - format: double - type: number - id: GoogleCloudIntegrationsV1alphaDoubleParameterArray - type: object - description: This message only contains a field of double number array. - GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: - type: object - properties: - nextPageToken: - type: string - description: The token used to retrieve the next page of results. - sfdcChannels: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' - description: The list of SfdcChannels retrieved. - description: Response to list SfdcChannels. - id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse - EnterpriseCrmEventbusProtoField: - properties: - transformExpression: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - description: >- - This is the transform expression to fetch the input field value. for - e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can - have a transform expression. 2. If a transform expression is - provided, reference_key will be ignored. 3. If no value is returned - after evaluation of transform expression, default_value can be - mapped if provided. 4. The field_type should be the type of the - final object returned after the transform expression is evaluated. - Scrubs the transform expression before logging as value provided by - user so may or may not contain PII or SPII data. - defaultValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: >- - This holds the default values for the fields. This value is supplied - by user so may or may not contain PII or SPII data. - referenceKey: + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + jsonSchema: type: string description: >- - This holds the reference key of the workflow or task parameter. 1. - Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input - or output parameter, for e.g. $task1_param1$. 3. Any workflow or - task parameters with subfield references, for e.g., - $task1_param1.employee.id$ - fieldType: + This schema will be used to validate runtime JSON-typed values of + this parameter. + dataType: type: string + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + description: Type of the parameter. enum: - - DATA_TYPE_UNSPECIFIED + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - STRING_VALUE - INT_VALUE - DOUBLE_VALUE - BOOLEAN_VALUE - - PROTO_VALUE - - SERIALIZED_OBJECT_VALUE - STRING_ARRAY - INT_ARRAY - DOUBLE_ARRAY - - PROTO_ARRAY - - PROTO_ENUM - BOOLEAN_ARRAY - - PROTO_ENUM_ARRAY - - BYTES - - BYTES_ARRAY - - NON_SERIALIZABLE_OBJECT - JSON_VALUE - description: Specifies the data type of the field. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - >- - BYTES and BYTES_ARRAY data types are not allowed for top-level - params. They're only meant to support protobufs with BYTES - (sub)fields. - - '' - - '' - - '' - protoDefPath: - description: >- - Optional. The fully qualified proto name (e.g. - enterprise.crm.storage.Account). Required for output field of type - PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES - and output field_type is PROTO_VALUE, then fully qualified proto - type url should be provided to parse the input bytes. If field_type - is *_ARRAY, then all the converted protos are of the same type. + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + key: type: string - cardinality: + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. + displayName: type: string - enum: - - UNSPECIFIED - - OPTIONAL - enumDescriptions: - - For fields with unspecified cardinality. - - >- - If field cardinality is set to optional, ignore errors if input - field value is null or the reference_key is not found. description: >- - By default, if the cardinality is unspecified the field is - considered required while mapping. - description: Information about the value and type of the field. - id: EnterpriseCrmEventbusProtoField + The name (without prefix) to be displayed in the UI for this + parameter. E.g. if the key is "foo.bar.myName", then the name would + be "myName". + searchable: + description: Searchable in the execution log or not. + type: boolean + id: GoogleCloudIntegrationsV1alphaIntegrationParameter type: object - GoogleCloudIntegrationsV1alphaIntParameterArray: - description: This message only contains a field of integer array. - id: GoogleCloudIntegrationsV1alphaIntParameterArray + description: >- + Integration Parameter is defined in the integration config and are used + to provide information about data types of the expected parameters and + provide any default values if needed. They can also be used to add + custom attributes. These are static in nature and should not be used for + dynamic event definition. + EnterpriseCrmEventbusProtoSerializedObjectParameter: type: object properties: - intValues: - type: array - items: - type: string - format: int64 - description: Integer array. - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata: - properties: - ancestorIterationNumbers: - items: - type: string - type: array - description: >- - Ancestor iteration number for the task(it will only be non-empty if - the task is under 'private workflow') - eventAttemptNum: - description: the event attempt number this snapshot belongs to. - format: int32 - type: integer - taskName: - description: the task name associated with this snapshot. Could be empty. - type: string - taskAttemptNum: - format: int32 - type: integer - description: the task attempt number this snapshot belongs to. Could be empty. - taskNumber: - type: string - description: The task number associated with this snapshot. Could be empty. - taskLabel: - description: the task label associated with this snapshot. Could be empty. - type: string - ancestorTaskNumbers: - items: - type: string - description: >- - Ancestor task number for the task(it will only be non-empty if the - task is under 'private workflow') - type: array - integrationName: - description: >- - The direct integration which the event execution snapshots belongs - to + objectValue: + format: byte type: string - id: >- - EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - type: object - EnterpriseCrmEventbusProtoCloudSchedulerConfig: + id: EnterpriseCrmEventbusProtoSerializedObjectParameter + GoogleCloudIntegrationsV1alphaCredential: + id: GoogleCloudIntegrationsV1alphaCredential + description: Defines parameters for a single, canonical credential. properties: - errorMessage: - type: string - description: >- - Optional. When the job was deleted from Pantheon UI, error_message - will be populated when Get/List integrations - cronTab: - type: string - description: Required. The cron tab of cloud scheduler trigger. - location: - description: >- - Required. The location where associated cloud scheduler job will be - created - type: string - serviceAccountEmail: + credentialType: + enumDescriptions: + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN type: string + description: Credential type associated with auth config. + serviceAccountCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaServiceAccountCredentials + description: Service account credential + authToken: + description: Auth token credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthToken' + oauth2ClientCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + description: OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials + oauth2AuthorizationCode: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode description: >- - Required. Service account used by Cloud Scheduler to trigger the - integration at scheduled time - id: EnterpriseCrmEventbusProtoCloudSchedulerConfig - description: Cloud Scheduler Trigger configuration + The api_key and oauth2_implicit are not covered in v1 and will be + picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 + authorization code credential + jwt: + description: JWT credential + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaJwt' + oidcToken: + description: Google OIDC ID Token + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaOidcToken' + oauth2ResourceOwnerCredentials: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + description: OAuth2 resource owner credentials + usernameAndPassword: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUsernameAndPassword + description: Username and password credential type: object - EnterpriseCrmEventbusProtoFunctionType: - id: EnterpriseCrmEventbusProtoFunctionType - properties: - booleanFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' - stringFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' - protoFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' - jsonFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' - description: >- - LINT.ThenChange(//depot/google3/alkali/apps/integrationplatform/client/workflow_editor/utils/transform_function.ts) - baseFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' - description: LINT.IfChange - intArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' - protoArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' - stringArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' - intFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' - booleanArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' - doubleFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' - doubleArrayFunction: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' + GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: type: object - EnterpriseCrmEventbusProtoTeardownTaskConfig: properties: - teardownTaskImplementationClassName: - description: Required. Implementation class name. + absolute: type: string - properties: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters the user can pass to this task. - creatorEmail: - description: The creator's email address. + description: Absolute value threshold. + format: int64 + percentage: + format: int32 + description: Percentage threshold. + type: integer + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue + description: >- + The threshold value of the metric, above or below which the alert should + be triggered. See EventAlertConfig or TaskAlertConfig for the different + alert metric types in each case. For the *RATE metrics, one or both of + these fields may be set. Zero is the default value and can be left at + that. For *PERCENTILE_DURATION metrics, one or both of these fields may + be set, and also, the duration threshold value should be specified in + the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, + these fields should not be set at all. A different member, + threshold_duration_ms, must be set in the EventAlertConfig or the + TaskAlertConfig. + GoogleCloudIntegrationsV1alphaLiftSuspensionResponse: + description: Response of lift Suspense + id: GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + type: object + properties: + eventExecutionInfoId: type: string - nextTeardownTask: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' - name: + description: Execution Id that will be returned + EnterpriseCrmFrontendsEventbusProtoTaskEntity: + description: >- + Contains a task's metadata and associated information. Next available + id: 7 + properties: + stats: + description: Deprecated - statistics from the Monarch query. + deprecated: true + $ref: '#/components/schemas/EnterpriseCrmEventbusStats' + metadata: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadata' + description: Metadata inclueds the task name, author and so on. + disabledForVpcSc: + type: boolean + description: True if the task has conflict with vpcsc + uiConfig: description: >- - Required. Unique identifier of the teardown task within this Config. - We use this field as the identifier to find next teardown tasks. + UI configuration for this task Also associated with the METADATA + mask. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiConfig' + taskType: + description: Defines the type of the task + enumDescriptions: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task + enum: + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE type: string + paramSpecs: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + description: >- + Declarations for inputs/outputs for a TypedTask. This is also + associated with the METADATA mask. type: object - id: EnterpriseCrmEventbusProtoTeardownTaskConfig - GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: + id: EnterpriseCrmFrontendsEventbusProtoTaskEntity + GoogleCloudIntegrationsV1alphaSuccessPolicy: type: object - id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse - properties: - properties: - description: 'Required. Required: The client configuration that was requested' - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' - description: Response for the GetClientMetadata rpc - EnterpriseCrmEventbusStatsDimensions: - id: EnterpriseCrmEventbusStatsDimensions + description: >- + Policy that dictates the behavior for the task after it completes + successfully. properties: - clientId: - type: string - workflowName: - type: string - warningEnumString: - type: string - workflowId: + finalState: type: string - retryAttempt: - enum: - - UNSPECIFIED - - FINAL - - RETRYABLE - - CANCELED enumDescriptions: - - '' + - UNSPECIFIED. - >- - Task has completed successfully or has depleted all retry - attempts. - - Task has failed but may be retried. - - Task has been deliberately canceled. - type: string - taskName: - type: string - enumFilterType: - description: Whether to include or exclude the enums matching the regex. - type: string + The default behavior, where successful tasks will be marked as + SUCCEEDED. + - >- + Sets the state to SUSPENDED after executing. This is required for + SuspensionTask; event execution will continue once the user calls + ResolveSuspensions with the event_execution_info_id and the task + number. enum: - - DEFAULT_INCLUSIVE - - EXCLUSIVE - enumDescriptions: - - '' - - '' - errorEnumString: - type: string - triggerId: - type: string + - FINAL_STATE_UNSPECIFIED + - SUCCEEDED + - SUSPENDED description: >- - Stats have been or will be aggregated on set fields for any - semantically-meaningful combination. - taskNumber: - type: string - type: object - EnterpriseCrmFrontendsEventbusProtoParameterMapField: - id: EnterpriseCrmFrontendsEventbusProtoParameterMapField - properties: - literalValue: - description: Passing a literal value. - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType - referenceKey: - type: string - description: Referencing one of the WF variables. - description: Field represents either the key or value in an entry. - type: object - GoogleCloudIntegrationsV1alphaListCertificatesResponse: + State to which the execution snapshot status will be set if the task + succeeds. + id: GoogleCloudIntegrationsV1alphaSuccessPolicy + GoogleCloudConnectorsV1ResourceRequests: + description: Resource requests defined for connection pods of a given connector type. + id: GoogleCloudConnectorsV1ResourceRequests type: object - description: Response to list Certificates. - id: GoogleCloudIntegrationsV1alphaListCertificatesResponse properties: - certificates: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' - type: array - description: The list of Certificates retrieved. - nextPageToken: - description: The token used to retrieve the next page of results. + cpu: + description: Output only. CPU request. + readOnly: true type: string - EnterpriseCrmEventbusProtoStringArray: + memory: + readOnly: true + type: string + description: Output only. Memory request. + GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse: + type: object + id: GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse properties: - values: + regions: + description: All regions where Connector Platform is provisioned. type: array items: type: string - type: object - id: EnterpriseCrmEventbusProtoStringArray - EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: - id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters - type: object + description: Response containing all provisioned regions for Connector Platform. + GoogleCloudIntegrationsV1alphaParameterMap: description: >- - LINT.IfChange This is the frontend version of WorkflowParameters. It's - exactly like the backend version except that instead of flattening - protobuf parameters and treating every field and subfield of a protobuf - parameter as a separate parameter, the fields/subfields of a protobuf - parameter will be nested as "children" (see 'children' field below) - parameters of the parent parameter. Please refer to - enterprise/crm/eventbus/proto/workflow_parameters.proto for more - information about WorkflowParameters. + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. + type: object + id: GoogleCloudIntegrationsV1alphaParameterMap properties: - parameters: - description: >- - Parameters are a part of Event and can be used to communiticate - between different tasks that are part of the same workflow - execution. + entries: items: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry + description: A list of parameter map entries. type: array - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest: - properties: - fileFormat: - enumDescriptions: - - Unspecified file format - - JSON File Format - - YAML File Format - description: File format for upload request. + keyType: type: string + description: >- + Option to specify key type for all entries of the map. If provided + then field types for all entries must conform to this. enum: - - FILE_FORMAT_UNSPECIFIED - - JSON - - YAML - content: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + valueType: + enumDescriptions: + - Unspecified. + - String. + - Integer. + - Double Number. + - Boolean. + - String Array. + - Integer Array. + - Double Number Array. + - Boolean Array. + - Json. + - Proto Value (Internal use only). + - Proto Array (Internal use only). + - // Non-serializable object (Internal use only). + enum: + - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - BOOLEAN_ARRAY + - JSON_VALUE + - PROTO_VALUE + - PROTO_ARRAY + - NON_SERIALIZABLE_OBJECT + description: >- + Option to specify value type for all entries of the map. If provided + then field types for all entries must conform to this. type: string - description: The textproto of the integration_version. - description: Request for UploadIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest - type: object - EnterpriseCrmEventbusProtoDoubleParameterArray: - id: EnterpriseCrmEventbusProtoDoubleParameterArray + EnterpriseCrmEventbusProtoCloudLoggingDetails: type: object + id: EnterpriseCrmEventbusProtoCloudLoggingDetails properties: - doubleValues: + cloudLoggingSeverity: + description: >- + Severity selected by the customer for the logs to be sent to Cloud + Logging, for the integration version getting executed. + enum: + - CLOUD_LOGGING_SEVERITY_UNSPECIFIED + - INFO + - ERROR + - WARNING + enumDescriptions: + - Unspecified + - >- + If Severity selected is `INFO`, then all the Integration Execution + States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, + `ERROR`, `CANCELLED`) will be sent to Cloud Logging. + - >- + If Severity selected is `ERROR`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + - >- + If Severity selected is `WARNING`, then only the following + Integration Execution States (`ERROR`, `CANCELLED`) will be sent + to Cloud Logging. + type: string + enableCloudLogging: + description: >- + Status of whether Cloud Logging is enabled or not for the + integration version getting executed. + type: boolean + description: >- + Cloud Logging details, selected by the user for the integration version + (workflow). This message field will be also used in ExecutionInfo, to + indicate the CloudLoggingDetails config at the time of workflow + (integration version) execution, since this field value can be changed + for an unpublished workflow. + EnterpriseCrmFrontendsEventbusProtoRollbackStrategy: + properties: + rollbackTaskImplementationClassName: + type: string + description: >- + Required. This is the name of the task that needs to be executed + upon rollback of this task. + taskNumbersToRollback: type: array + description: >- + Required. These are the tasks numbers of the tasks whose + `rollback_strategy.rollback_task_implementation_class_name` needs to + be executed upon failure of this task. items: - format: double - type: number - GoogleCloudIntegrationsV1alphaSuspensionAudit: - id: GoogleCloudIntegrationsV1alphaSuspensionAudit + type: string + parameters: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Optional. The customized parameters the user can pass to this task. type: object - description: Contains when and by whom the suspension was resolved. - properties: - resolver: - description: Email address of the person who resolved this suspension. - type: string - resolveTime: - description: Time at which this suspension was resolved. - type: string - format: google-datetime - GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. + id: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + description: 'Next available id: 4' + EnterpriseCrmEventbusProtoScatterResponse: + type: object + id: EnterpriseCrmEventbusProtoScatterResponse properties: - disableAlert: + isSuccessful: type: boolean description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this integration alert. - thresholdType: + If execution is sync, this is true if the execution passed and false + if it failed. If the execution is async, this is true if the WF was + fired off successfully, and false if it failed to execute. The + success or failure of the subworkflows executed are not captured. + executionIds: + description: The execution ids of each Subworkflow fired by this scatter. + type: array + items: + type: string + scatterElement: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: The element that was scattered for this execution. + errorMsg: + type: string + description: The error message of the failure if applicable. + responseParams: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + type: array description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - enum: - - THRESHOLD_TYPE_UNSPECIFIED - - EXPECTED_MIN - - EXPECTED_MAX - enumDescriptions: - - Default. - - >- - Note that this field will only trigger alerts if the integration - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. Min value threshold. - - Max value threshold. - type: string - metricType: - enumDescriptions: - - >- - The default value. Metric type should always be set to one of the - other non-default values, otherwise it will result in an - INVALID_ARGUMENT error. - - >- - Specifies alerting on the rate of errors for the enclosing - integration. - - >- - Specifies alerting on the rate of warnings for the enclosing - integration. Warnings use the same enum values as errors. - - >- - Specifies alerting on the rate of errors for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of warnings for any task in the - enclosing integration. - - >- - Specifies alerting on the rate of executions over all tasks in the - enclosing integration. - - >- - Specifies alerting on the number of events executed in the given - aggregation_period. - - >- - Specifies alerting on the average duration of executions for this - integration. - - >- - Specifies alerting on the duration value of a particular - percentile of integration executions. E.g. If 10% or more of the - integration executions have durations above 5 seconds, alert. - - >- - Specifies alerting on the average duration of any task in the - enclosing integration, - - >- - Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing - integration. E.g. If 10% or more of the task executions in the - integration have durations above 5 seconds, alert. - description: The type of metric. - enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION - type: string - onlyFinalAttempt: - description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - type: boolean - displayName: - description: >- - Name of the alert. This will be displayed in the alert subject. If - set, this name should be unique within the scope of the integration. - type: string - durationThreshold: - description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. - format: google-duration - type: string - aggregationPeriod: - description: >- - The period over which the metric value should be aggregated and - evaluated. Format is , where integer should be a positive integer - and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, - day, week). For an EXPECTED_MIN threshold, this aggregation_period - must be lesser than 24 hours. - type: string - thresholdValue: - description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue - alertThreshold: - type: integer - format: int32 - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. + A list of all the response parameters in the aggregtorMap stored + with the remapped key. + GoogleCloudIntegrationsV1alphaListCertificatesResponse: type: object - EnterpriseCrmEventbusProtoMappedField: - description: Mapped field is a pair of input field and output field. + description: Response to list Certificates. + id: GoogleCloudIntegrationsV1alphaListCertificatesResponse + properties: + certificates: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + description: The list of Certificates retrieved. + nextPageToken: + description: The token used to retrieve the next page of results. + type: string + GoogleCloudIntegrationsV1alphaGetClientResponse: type: object + description: Response for the GetClient rpc + id: GoogleCloudIntegrationsV1alphaGetClientResponse properties: - outputField: - description: The output field being mapped to. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - inputField: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' - description: The input field being mapped from. - id: EnterpriseCrmEventbusProtoMappedField - EnterpriseCrmFrontendsEventbusProtoStringParameterArray: + client: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientConfig' + description: 'Required. Required: The client configuration that was requested' + EnterpriseCrmEventbusProtoFunction: + id: EnterpriseCrmEventbusProtoFunction properties: - stringValues: + parameters: + description: List of parameters required for the transformation. items: - type: string + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' type: array - id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray + functionType: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' + description: The name of the function to perform. type: object - GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse: + GoogleCloudConnectorsV1DestinationConfig: + type: object + description: Define the Connectors target endpoint. properties: - nextPageToken: - description: Next page token. + key: + description: >- + The key is the destination identifier that is supported by the + Connector. type: string - runtimeEntitySchemas: + destinations: + description: The destinations for the key. items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - description: Runtime entity schemas. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' type: array - description: Response for listing RuntimeEntitySchemas for a specific Connection. + id: GoogleCloudConnectorsV1DestinationConfig + EnterpriseCrmEventbusProtoCustomSuspensionRequest: + id: EnterpriseCrmEventbusProtoCustomSuspensionRequest type: object - id: GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse - EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: properties: - connection: - description: User-selected connection. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' - operation: + postToQueueWithTriggerIdRequest: + $ref: >- + #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest + description: Request to fire an event containing the SuspensionInfo message. + suspensionInfoEventParameterKey: + description: >- + In the fired event, set the SuspensionInfo message as the value for + this key. + type: string + EnterpriseCrmEventbusProtoDoubleFunction: + type: object + properties: + functionName: + type: string + enum: + - UNSPECIFIED + - TO_JSON + - TO_STRING + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - ROUND + - FLOOR + - CEIL + - GREATER_THAN + - LESS_THAN + - EQUALS + - GREATER_THAN_EQUALS + - LESS_THAN_EQUALS + - MOD enumDescriptions: - '' - '' @@ -4334,220 +3889,49 @@ components: - '' - '' - '' - type: string - enum: - - OPERATION_UNSPECIFIED - - EXECUTE_ACTION - - LIST_ENTITIES - - GET_ENTITY - - CREATE_ENTITY - - UPDATE_ENTITY - - DELETE_ENTITY - - EXECUTE_QUERY - description: Operation to perform using the configured connection. - type: object - id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig - GoogleCloudIntegrationsV1alphaSfdcChannel: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + id: EnterpriseCrmEventbusProtoDoubleFunction + GoogleCloudConnectorsV1LockConfig: + description: >- + Determines whether or no a connection is locked. If locked, a reason + must be specified. type: object - id: GoogleCloudIntegrationsV1alphaSfdcChannel - description: The SfdcChannel that points to a CDC or Platform Event Channel. properties: - isActive: - description: >- - Indicated if a channel has any active integrations referencing it. - Set to false when the channel is created, and set to true if there - is any integration published with the channel configured in it. + locked: + description: Indicates whether or not the connection is locked. type: boolean - name: - type: string - description: >- - Resource name of the SFDC channel - projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. - description: - description: The description for this channel + reason: type: string - channelTopic: + description: Describes why a connection is locked. + id: GoogleCloudConnectorsV1LockConfig + GoogleCloudIntegrationsV1alphaUseTemplateRequest: + type: object + properties: + integrationRegion: type: string - description: The Channel topic defined by salesforce once an channel is opened - updateTime: - description: Output only. Time when the channel was last updated - format: google-datetime - readOnly: true - type: string - createTime: - description: Output only. Time when the channel is created - format: google-datetime - type: string - readOnly: true - deleteTime: - readOnly: true - type: string - format: google-datetime - description: >- - Output only. Time when the channel was deleted. Empty if not - deleted. - lastReplayId: - description: Last sfdc messsage replay id for channel - type: string - displayName: - description: Client level unique name/alias to easily reference a channel. - type: string - GoogleCloudConnectorsV1BillingConfig: - id: GoogleCloudConnectorsV1BillingConfig - type: object - description: Billing config for the connection. - properties: - billingCategory: - type: string - enumDescriptions: - - Billing category is not specified. - - GCP/Technical connector. - - Non-GCP connector. - readOnly: true - enum: - - BILLING_CATEGORY_UNSPECIFIED - - GCP_AND_TECHNICAL_CONNECTOR - - NON_GCP_CONNECTOR - description: Output only. Billing category for the connector. - GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: - type: object - description: >- - LINT.IfChange Use this request to post all workflows associated with a - given trigger id. Next available id: 13 - id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - properties: - triggerId: - type: string - description: >- - Matched against all {@link TriggerConfig}s across all workflows. - i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. - resourceName: - type: string - description: >- - This field is only required when using Admin Access. The resource - name of target, or the parent resource name. For example: - "projects/*/locations/*/integrations/*" - clientId: - description: >- - Optional. If the client id is provided, then the combination of - trigger id and client id is matched across all the workflows. If the - client id is not provided, then workflows with matching trigger id - are executed for each client id in the {@link TriggerConfig}. For - Api Trigger, the client id is required and will be validated against - the allowed clients. - type: string - requestId: - description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. Must have no more than 36 characters and contain only - alphanumeric characters and hyphens. - type: string - userGeneratedExecutionId: - type: string - description: >- - This is a unique id provided by the method caller. If provided this - will be used as the execution_id when a new execution info is - created. This is a string representation of a UUID. Must have no - more than 36 characters and contain only alphanumeric characters and - hyphens. - ignoreErrorIfNoActiveWorkflow: - description: >- - Optional. Flag to determine whether clients would suppress a warning - when no ACTIVE workflows are not found. If this flag is set to be - true, an error will not be thrown if the requested trigger_id or - client_id is not found in any ACTIVE workflow. Otherwise, the error - is always thrown. The flag is set to be false by default. - type: boolean - priority: - description: >- - The request priority this request should be processed at. For - internal users: - type: string - enumDescriptions: - - Unspecified - - >- - Frequent partial and occasional full unavailability is expected - and not pageable. * Requests to this band will be shed before all - other requests. * This is the default for async calls sent from - batch jobs. - - >- - Partial unavailability is expected and is not necessarily - pageable. * Requests to this band will be shed before any critical - traffic. * This is the default for async calls sent from - production jobs. - - >- - Any outage is a pageable event. * During a production outage - requests in this band will only be shed before CRITICAL_PLUS. * - This is the default for sync calls sent from production jobs. - - >- - Any outage is a pageable event. * The guideline is for < 10% of - requests to a service to be in this band. * During a production - outage requests in this band will be prioritized above all others. - * Opt-in to CRITICAL_PLUS when your workflow triggers by human. - enum: - - UNSPCIFIED - - SHEDDABLE - - SHEDDABLE_PLUS - - CRITICAL - - CRITICAL_PLUS - testMode: - type: boolean - description: >- - Optional. Sets test mode in {@link - enterprise/crm/eventbus/event_message.proto}. - scheduledTime: - type: string - format: int64 - description: >- - Optional. Time in milliseconds since epoch when the given event - would be scheduled. - quotaRetryCount: - type: integer - format: int32 - description: >- - Optional. This is a field to see the quota retry count for - integration execution - workflowName: - description: >- - Optional. If provided, the workflow_name is used to filter all the - matched workflows having same trigger_id+client_id. A combination of - trigger_id, client_id and workflow_name identifies a unique - workflow. - type: string - parameters: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: Passed in as parameters to each workflow execution. Optional. - GoogleCloudConnectorsV1DestinationConfig: - description: Define the Connectors target endpoint. - id: GoogleCloudConnectorsV1DestinationConfig - type: object - properties: - destinations: - type: array - description: The destinations for the key. - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Destination' - key: - description: >- - The key is the destination identifier that is supported by the - Connector. - type: string - GoogleCloudIntegrationsV1alphaListConnectionsResponse: - type: object - description: Response containing Connections listed by region. - properties: - nextPageToken: - type: string - description: Next page token. - connections: - description: Connections. - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Connection' - type: array - id: GoogleCloudIntegrationsV1alphaListConnectionsResponse - EnterpriseCrmEventbusProtoIntArrayFunction: - id: EnterpriseCrmEventbusProtoIntArrayFunction + description: Required. The region of the Integration to be created. + integrationDetails: + description: Required. Integration details which would be created via templates. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + subIntegrations: + description: Optional. Sub Integration which would be created via templates. + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + type: object + id: GoogleCloudIntegrationsV1alphaUseTemplateRequest + description: Request to Use template + EnterpriseCrmEventbusProtoBooleanFunction: + id: EnterpriseCrmEventbusProtoBooleanFunction properties: functionName: enumDescriptions: @@ -4562,193 +3946,365 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' enum: - UNSPECIFIED - - GET - - APPEND - - SIZE - - SUM - - AVG - - MAX - - MIN - - TO_SET - - APPEND_ALL - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + - NOT + - AND + - NAND + - OR + - XOR + - NOR + - XNOR + - TO_STRING + - EQUALS type: string type: object - GoogleCloudIntegrationsV1alphaAuthToken: - description: >- - The credentials to authenticate a user agent with a server that is put - in HTTP Authorization request header. - id: GoogleCloudIntegrationsV1alphaAuthToken + EnterpriseCrmEventbusProtoNotification: + id: EnterpriseCrmEventbusProtoNotification type: object properties: - token: - description: The token for the auth type. - type: string - type: + escalatorQueue: type: string - description: Authentication type, e.g. "Basic", "Bearer", etc. - EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter: - type: object - id: EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter - properties: - objectValue: + pubsubTopic: type: string - format: byte - GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse - properties: - executionFailed: - deprecated: true - description: Is true if any execution in the integration failed. False otherwise. - type: boolean - outputParameters: - type: object + request: description: >- - OUTPUT parameters in format of Map. Where Key is the name of the - parameter. Note: Name of the system generated parameters are wrapped - by backtick(`) to distinguish them from the user defined parameters. - additionalProperties: - description: Properties of the object. - type: any - executionId: - type: string - description: The id of the execution corresponding to this run of integration. - parameterEntries: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: array + If the out-of-the-box email/pubsub notifications are not suitable + and custom logic is required, fire a workflow containing all info + needed to notify users to resume execution. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest + buganizerNotification: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' + emailAddress: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' + EnterpriseCrmEventbusStats: + id: EnterpriseCrmEventbusStats + description: >- + Stats for the requested dimensions: QPS, duration, and error/warning + rate + properties: + durationInSeconds: + type: number + description: Average duration in seconds. + format: double + qps: + description: Queries per second. + format: double + type: number + dimensions: + $ref: '#/components/schemas/EnterpriseCrmEventbusStatsDimensions' + description: Dimensions that these stats have been aggregated on. + warningRate: + format: double + description: Average warning rate. + type: number + errorRate: + description: Average error rate. + type: number + format: double + type: object + GoogleCloudIntegrationsV1alphaTestIntegrationsResponse: + id: GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + properties: + executionFailed: + type: boolean + description: Is true if any execution in the integration failed. False otherwise. + parameterEntries: + type: array description: >- Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution. deprecated: true + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry eventParameters: - description: Details for the integration that were executed. - deprecated: true $ref: >- #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + deprecated: true + description: Details for the integration that were executed. + executionId: + description: The id of the execution corresponding to this run of integration. + type: string + parameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + type: object + description: >- + Optional. Parameters are a part of Event and can be used to + communicate between different tasks that are part of the same + integration execution. type: object - description: The response for executing an integration. - GoogleCloudConnectorsV1EventingStatus: + description: The response for testing an integration. + EnterpriseCrmEventbusProtoBooleanParameterArray: + id: EnterpriseCrmEventbusProtoBooleanParameterArray properties: - state: - type: string - description: Output only. State. - readOnly: true - enum: - - STATE_UNSPECIFIED - - ACTIVE - - ERROR - - INGRESS_ENDPOINT_REQUIRED + booleanValues: + type: array + items: + type: boolean + type: object + EnterpriseCrmEventbusProtoTaskUiModuleConfig: + id: EnterpriseCrmEventbusProtoTaskUiModuleConfig + properties: + moduleId: enumDescriptions: - - Default state. - - Eventing is enabled and ready to receive events. - - Eventing is not active due to an error. - - Ingress endpoint required. - description: - readOnly: true - description: Output only. Description of error if State is set to "ERROR". + - Default + - Supports editing label of a task config. + - Supports editing error handling settings such as retry strategy. + - >- + Supports adding, removing and editing task parameter values in a + table with little assistance or restriction. + - >- + Supports editing values of declared input parameters of a task. + Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. + - Supports editing preconditions of a task config. + - >- + Supports adding, editing, and deleting the scripts associated with + a script task, as well as modifying the input/output parameters. + - >- + Supports editing task parameters associated with an RPC/stubby + task. + - >- + Contains readonly task information, including input/output type + info. + - Configures a SuspensionTask. + - Configures a GenericStubbyTypedTask. + - Configures a SubWorkflowExecutorTask. + - Supports navigating to Apps Script editor + - Configures a SubWorkflowForEachLoopTask. + - Configures a FieldMappingTask. + - Contains embedded in-product documentation for a task. + - UI widget for the rest caller task. + - Configures a SubWorkflowScatterGatherTask. + - Configures a CloudSql Task. + - Configure a GenericConnectorTask. + description: ID of the config module. + enum: + - UNSPECIFIED_TASK_MODULE + - LABEL + - ERROR_HANDLING + - TASK_PARAM_TABLE + - TASK_PARAM_FORM + - PRECONDITION + - SCRIPT_EDITOR + - RPC + - TASK_SUMMARY + - SUSPENSION + - RPC_TYPED + - SUB_WORKFLOW + - APPS_SCRIPT_NAVIGATOR + - SUB_WORKFLOW_FOR_EACH_LOOP + - FIELD_MAPPING + - README + - REST_CALLER + - SUB_WORKFLOW_SCATTER_GATHER + - CLOUD_SQL + - GENERIC_CONNECTOR_TASK type: string - id: GoogleCloudConnectorsV1EventingStatus - description: EventingStatus indicates the state of eventing. type: object - GoogleCloudConnectorsV1ResourceLimits: + description: Task author would use this type to configure a config module. + EnterpriseCrmEventbusProtoProtoParameterArray: + id: EnterpriseCrmEventbusProtoProtoParameterArray type: object properties: - memory: - type: string - description: Output only. Memory limit. - readOnly: true - cpu: - type: string - description: Output only. CPU limit. - readOnly: true - id: GoogleCloudConnectorsV1ResourceLimits - description: Resource limits defined for connection pods of a given connector type. - GoogleCloudConnectorsV1LogConfig: - id: GoogleCloudConnectorsV1LogConfig - type: object + protoValues: + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: + id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials properties: - level: - enumDescriptions: - - Log level unspecified. - - Only error logs are enabled. - - Info and error logs are enabled. - - Debug and high verbosity logs are enabled. + scope: type: string + description: A space-delimited list of requested scope permissions. + requestType: enum: - - LOG_LEVEL_UNSPECIFIED - - ERROR - - INFO - - DEBUG - description: Optional. Log configuration level. - enabled: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + type: string + description: Represent how to pass parameters to fetch access token + clientId: + type: string + description: The client's ID. + username: + type: string + description: The user's username. + password: + type: string + description: The user's password. + clientSecret: + description: The client's secret. + type: string + tokenEndpoint: + type: string description: >- - Enabled represents whether logging is enabled or not for a - connection. - type: boolean - description: Log configuration for the connection. - GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. + tokenParams: + description: Token parameters for the auth request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + accessToken: + description: Access token fetched from the authorization server. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' type: object - description: Expiration configs for the approval request. + description: >- + For resource owner credentials grant, the client will ask the user for + their authorization credentials (ususally a username and password) and + send a POST request to the authorization server. The authorization + server will respond with a JSON object containing the access token. + GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: properties: - expireTime: - format: google-datetime - description: >- - Output only. Time after which the suspension expires, if no action - taken. + integrationVersion: + description: The uploaded integration. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + type: object + description: Response for UploadIntegrationVersion. + EnterpriseCrmEventbusProtoBuganizerNotification: + properties: + title: + description: Title of the issue to be created. Required. type: string - readOnly: true - remindTime: - description: >- - Time after the previous suspension action reminder, if any, is sent - using the selected notification option, for a suspension which is - still PENDING_UNSPECIFIED. + componentId: type: string - format: google-datetime - liftWhenExpired: + format: int64 description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. - type: boolean - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - EnterpriseCrmEventbusProtoStringFunction: + ID of the buganizer component within which to create a new issue. + Required. + templateId: + format: int64 + description: ID of the buganizer template to use. Optional. + type: string + assigneeEmailAddress: + type: string + description: Whom to assign the new bug. Optional. + id: EnterpriseCrmEventbusProtoBuganizerNotification + type: object + GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest: + type: object + properties: {} + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + description: Request for TakeoverEditLock. + EnterpriseCrmFrontendsEventbusProtoTriggerConfig: + id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig properties: - functionName: + enabledClients: + description: >- + Required. The list of client ids which are enabled to execute the + workflow using this trigger. In other words, these clients have the + workflow execution privledges for this trigger. For API trigger, the + client id in the incoming request is validated against the list of + enabled clients. For non-API triggers, one workflow execution is + triggered on behalf of each enabled client. + items: + type: string + type: array + alertConfig: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' + type: array + description: >- + An alert threshold configuration for the [trigger + client + + workflow] tuple. If these values are not specified in the trigger + config, default values will be populated by the system. Note that + there must be exactly one alert threshold configured per [client + + trigger + workflow] when published. + triggerNumber: + description: >- + Required. A number to uniquely identify each trigger config within + the workflow on UI. + type: string + errorCatcherId: + type: string + description: >- + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task + nextTasksExecutionPolicy: + description: Dictates how next tasks will be executed. + type: string enum: - UNSPECIFIED - - CONCAT - - TO_UPPERCASE - - TO_LOWERCASE - - CONTAINS - - SPLIT - - LENGTH - - EQUALS - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_BASE_64 - - TO_JSON - - EQUALS_IGNORE_CASE - - REPLACE_ALL - - SUBSTRING - - RESOLVE_TEMPLATE - - DECODE_BASE64_STRING + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + enumDescriptions: + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + triggerName: + type: string + description: >- + Optional. Name of the trigger This is added to identify the type of + trigger. This is avoid the logic on triggerId to identify the + trigger_type and push the same to monitoring. + pauseWorkflowExecutions: + type: boolean + description: >- + Optional. If set to true, any upcoming requests for this trigger + config will be paused and the executions will be resumed later when + the flag is reset. The workflow to which this trigger config belongs + has to be in ACTIVE status for the executions to be paused or + resumed. + properties: + additionalProperties: + type: string + description: >- + Configurable properties of the trigger, not to be confused with + workflow parameters. E.g. "name" is a property for API triggers and + "subscription" is a property for Cloud Pubsub triggers. + type: object + cloudSchedulerConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' + description: + type: string + description: >- + User-provided description intended to give more business context + about the task. + triggerCriteria: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' + description: >- + Optional. When set, Eventbus will run the task specified in the + trigger_criteria and validate the result using the + trigger_criteria.condition, and only execute the workflow when + result is true. + label: + description: The user created label for a particular trigger. + type: string + position: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + description: >- + Optional. Informs the front-end application where to draw this + trigger config on the UI. + startTasks: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + type: array + description: >- + Set of tasks numbers from where the workflow execution is started by + this trigger. If this is empty, then workflow is executed with + default start tasks. In the list of start tasks, none of two tasks + can have direct ancestor-descendant relationships (i.e. in a same + workflow execution graph). + triggerId: + type: string + description: The backend trigger ID. + triggerType: enumDescriptions: - '' - '' @@ -4765,252 +4321,205 @@ components: - '' - '' - '' - - '' - - '' - - '' + enum: + - UNKNOWN + - CLOUD_PUBSUB + - GOOPS + - SFDC_SYNC + - CRON + - API + - MANIFOLD_TRIGGER + - DATALAYER_DATA_CHANGE + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - SFDC_PLATFORM_EVENTS_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER type: string - id: EnterpriseCrmEventbusProtoStringFunction - type: object - EnterpriseCrmEventbusProtoDoubleArray: - properties: - values: - type: array - items: - type: number - format: double + description: 'Configuration detail of a trigger. Next available id: 20' type: object - id: EnterpriseCrmEventbusProtoDoubleArray - GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: - description: >- - Parameters to support Oauth 2.0 Auth Code Grant Authentication. See - https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. + EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats: type: object + id: EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats properties: - authUri: + startTime: + format: int64 + description: >- + The start time of the event execution for current attempt. This + could be in the future if it's been scheduled. type: string - description: Auth URL for Authorization Code Flow - clientId: + endTime: + description: The end time of the event execution for current attempt. type: string - description: Client ID for user-provided OAuth app. - redirectUri: - description: Redirect URI to be provided during the auth code exchange. + format: int64 + GoogleCloudIntegrationsV1alphaSfdcChannel: + description: The SfdcChannel that points to a CDC or Platform Event Channel. + id: GoogleCloudIntegrationsV1alphaSfdcChannel + properties: + name: + description: >- + Resource name of the SFDC channel + projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. type: string - pkceVerifier: - description: PKCE verifier to be used during the auth code exchange. + updateTime: type: string - authCode: - description: Authorization code to be exchanged for access and refresh tokens. + description: Output only. Time when the channel was last updated + readOnly: true + format: google-datetime + description: + description: The description for this channel type: string - scopes: - items: - type: string + deleteTime: description: >- - Scopes the connection will request when the user performs the auth - code flow. - type: array - enablePkce: - type: boolean - description: Whether to enable PKCE when the user performs the auth code flow. - clientSecret: - description: Client secret for user-provided OAuth app. - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - EnterpriseCrmEventbusProtoSuspensionResolutionInfo: - type: object - id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo - properties: - clientId: - description: The event data user sends as request. + Output only. Time when the channel was deleted. Empty if not + deleted. + format: google-datetime type: string - lastModifiedTimestamp: + readOnly: true + displayName: + description: Client level unique name/alias to easily reference a channel. type: string - description: Auto-generated. + createTime: + description: Output only. Time when the channel is created + type: string + readOnly: true format: google-datetime - product: - enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY - enumDescriptions: - - '' - - '' - - '' - - '' + lastReplayId: type: string - description: >- - Which Google product the suspension belongs to. If not set, the - suspension belongs to Integration Platform by default. - status: - enumDescriptions: - - '' - - '' - - '' - - '' - enum: - - PENDING_UNSPECIFIED - - REJECTED - - LIFTED - - CANCELED - type: string - eventExecutionInfoId: - type: string - description: Required. ID of the associated execution. - cloudKmsConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' - description: KMS info, used by cmek/gmek integration - suspensionId: - type: string - description: Primary key for the SuspensionResolutionInfoTable. - suspensionConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - audit: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit - encryptedSuspensionResolutionInfo: - type: string - description: Encrypted SuspensionResolutionInfo - format: byte - wrappedDek: - description: Wrapped dek - format: byte - type: string - externalTraffic: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' - description: The origin of the suspension for periodic notifications. - taskNumber: - description: Required. Task number of the associated SuspensionTask. - type: string - workflowName: - type: string - description: Required. The name of the originating workflow. - createdTimestamp: - format: google-datetime + description: Last sfdc messsage replay id for channel + channelTopic: + description: The Channel topic defined by salesforce once an channel is opened type: string - description: Auto-generated. - GoogleCloudIntegrationsV1alphaRuntimeActionSchema: - description: Metadata of an action, including schemas for its inputs and outputs. + isActive: + description: >- + Indicated if a channel has any active integrations referencing it. + Set to false when the channel is created, and set to true if there + is any integration published with the channel configured in it. + type: boolean type: object + GoogleCloudIntegrationsV1alphaExecutionReplayInfo: + description: >- + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship properties: - outputSchema: - description: Output parameter schema for the action. - type: string - inputSchema: + replayReason: type: string - description: Input parameter schema for the action. - action: + description: reason for replay + originalExecutionInfoId: type: string - description: Name of the action. - id: GoogleCloudIntegrationsV1alphaRuntimeActionSchema - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: - type: object - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - properties: + description: >- + If this execution is a replay of another execution, then this field + contains the original execution id. replayedExecutionInfoIds: - items: - type: string type: array description: >- If this execution has been replayed, then this field contains the execution ids of the replayed executions. - originalExecutionInfoId: - type: string - description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. - replayReason: - type: string - description: reason for replay - description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship - EnterpriseCrmEventbusProtoTaskMetadataAdmin: - description: >- - Admins are owners of a Task, and have all permissions on a particular - task identified by the task name. By default, Eventbus periodically - scans all task metadata and syncs (adds) any new admins defined here to - Zanzibar. - id: EnterpriseCrmEventbusProtoTaskMetadataAdmin + items: + type: string + id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo + type: object + GoogleCloudConnectorsV1ResourceLimits: + type: object + description: Resource limits defined for connection pods of a given connector type. properties: - googleGroupEmail: + cpu: type: string - userEmail: + description: Output only. CPU limit. + readOnly: true + memory: + description: Output only. Memory limit. type: string + readOnly: true + id: GoogleCloudConnectorsV1ResourceLimits + EnterpriseCrmEventbusProtoIntArray: + id: EnterpriseCrmEventbusProtoIntArray type: object - GoogleCloudIntegrationsV1alphaExecutionSnapshot: - description: Contains the snapshot of the execution for a given checkpoint. - type: object - id: GoogleCloudIntegrationsV1alphaExecutionSnapshot properties: - executionSnapshotMetadata: - description: Metadata of the execution snapshot. - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata - params: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - description: Parameters used during the execution. - taskExecutionDetails: - type: array - description: All of the task execution details at the given point of time. + values: items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails - checkpointTaskNumber: - type: string - description: >- - Indicates "after which checkpoint task's execution" this snapshot is - taken. - EnterpriseCrmEventbusProtoCustomSuspensionRequest: + type: string + format: int64 + type: array + GoogleCloudIntegrationsV1alphaListTemplatesResponse: + type: object + id: GoogleCloudIntegrationsV1alphaListTemplatesResponse properties: - postToQueueWithTriggerIdRequest: - description: Request to fire an event containing the SuspensionInfo message. - $ref: >- - #/components/schemas/GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest - suspensionInfoEventParameterKey: - description: >- - In the fired event, set the SuspensionInfo message as the value for - this key. + nextPageToken: + description: The token used to retrieve the next page results. type: string - id: EnterpriseCrmEventbusProtoCustomSuspensionRequest + templates: + description: List of templates retrieved. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + type: array + description: Response for a request to list templates + GoogleCloudIntegrationsV1alphaTaskExecutionDetails: + description: Contains the details of the execution of this task. + id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails type: object - EnterpriseCrmEventbusProtoBooleanArrayFunction: - id: EnterpriseCrmEventbusProtoBooleanArrayFunction properties: - functionName: + taskNumber: + description: Pointer to the task config it used for execution. + type: string + taskAttemptStats: + description: Status for the current task execution attempt. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + taskExecutionState: + description: The execution state of this task. type: string enum: - - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL - - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER + - TASK_EXECUTION_STATE_UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELLED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: object - EnterpriseCrmEventbusProtoStringArrayFunction: + - Default value. + - >- + Task is waiting for its precondition tasks to finish to start the + execution. + - Task is under processing. + - >- + Task execution successfully finished. There's no more change after + this state. + - Task execution failed. There's no more change after this state. + - >- + Task execution failed and cause the whole integration execution to + fail immediately. There's no more change after this state. + - Task execution failed and waiting for retry. + - >- + Task execution skipped. This happens when its precondition wasn't + met, or the integration execution been canceled before reach to + the task. There's no more changes after this state. + - >- + Task execution canceled when in progress. This happens when + integration execution been canceled or any other task fall in + fatal state. + - >- + Task is waiting for its dependency tasks' rollback to finish to + start its rollback. + - Task is rolling back. + - >- + Task is rolled back. This is the state we will set regardless of + rollback succeeding or failing. + - >- + Task is a SuspensionTask which has executed once, creating a + pending suspension. + EnterpriseCrmEventbusProtoIntFunction: properties: functionName: enumDescriptions: @@ -5027,304 +4536,257 @@ components: - '' - '' - '' - type: string + - '' + - '' + - '' enum: - UNSPECIFIED - - GET - - APPEND - - SIZE - - TO_SET - - APPEND_ALL + - ADD + - SUBTRACT + - MULTIPLY + - DIVIDE + - EXPONENT + - GREATER_THAN_EQUAL_TO + - GREATER_THAN + - LESS_THAN_EQUAL_TO + - LESS_THAN + - TO_DOUBLE + - TO_STRING + - EQUALS - TO_JSON - - SET - - REMOVE - - REMOVE_AT - - CONTAINS - - FOR_EACH - - FILTER - id: EnterpriseCrmEventbusProtoStringArrayFunction + - MOD + - EPOCH_TO_HUMAN_READABLE_TIME + type: string type: object - GoogleCloudConnectorsV1ResourceRequests: + id: EnterpriseCrmEventbusProtoIntFunction + GoogleCloudConnectorsV1AuthConfigUserPassword: + description: Parameters to support Username and Password Authentication. properties: - cpu: - type: string - readOnly: true - description: Output only. CPU request. - memory: - readOnly: true - description: Output only. Memory request. + password: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret version reference containing the password. + username: type: string - id: GoogleCloudConnectorsV1ResourceRequests - description: Resource requests defined for connection pods of a given connector type. + description: Username. type: object - GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue: + id: GoogleCloudConnectorsV1AuthConfigUserPassword + EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails: + type: object + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails properties: - percentage: - format: int32 - type: integer - description: Percentage threshold. - absolute: + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution + format: int64 type: string + nextExecutionTime: format: int64 - description: Absolute value threshold. - type: object - description: >- - The threshold value of the metric, above or below which the alert should - be triggered. See EventAlertConfig or TaskAlertConfig for the different - alert metric types in each case. For the *RATE metrics, one or both of - these fields may be set. Zero is the default value and can be left at - that. For *PERCENTILE_DURATION metrics, one or both of these fields may - be set, and also, the duration threshold value should be specified in - the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, - these fields should not be set at all. A different member, - threshold_duration_ms, must be set in the EventAlertConfig or the - TaskAlertConfig. - id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue - GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: - properties: - emailAddresses: - description: Email addresses to send approval request to. + description: >- + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + type: string + eventRetriesFromBeginningCount: + type: integer + description: >- + Indicates the number of times the execution has restarted from the + beginning. + format: int32 + cancelReason: + type: string + description: >- + If the execution is manually canceled, this field will contain the + reason for cancellation. + networkAddress: + type: string + description: >- + The network address (aka. bns address) that indicates where the + event executor is running. + logFilePath: + type: string + description: The log file path (aka. cns address) for this event. + ryeLockUnheldCount: + format: int32 + type: integer + description: >- + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ + eventAttemptStats: type: array items: - type: string - expiration: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration - description: >- - Indicates the next steps when no external actions happen on the - suspension. - customMessage: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + eventExecutionState: + enum: + - UNSPECIFIED + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + enumDescriptions: + - '' + - >- + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. + - >- + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. + - >- + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. type: string - description: Information to provide for recipients. - description: Configurations for approving the Suspension. - id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - type: object - GoogleCloudIntegrationsV1alphaClientConfig: + description: The execution state of this event. + eventExecutionSnapshot: + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot + type: array + description: >- + After snapshot migration, this field will no longer be populated, + but old execution snapshots will still be accessible. + description: >- + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 + EnterpriseCrmEventbusStatsDimensions: + id: EnterpriseCrmEventbusStatsDimensions type: object - description: The configuration information for the Client properties: - p4ServiceAccount: - description: The service agent associated with this client + warningEnumString: type: string - description: + retryAttempt: + enum: + - UNSPECIFIED + - FINAL + - RETRYABLE + - CANCELED type: string - description: Description of what the client is used for - billingType: enumDescriptions: - - Unspecified billing type - - A trial org provisioned through Apigee Provisioning Wizard - - Subscription based users of Apigee - - Consumption based users of IP - enum: - - BILLING_TYPE_UNSPECIFIED - - BILLING_TYPE_APIGEE_TRIALS - - BILLING_TYPE_APIGEE_SUBSCRIPTION - - BILLING_TYPE_PAYG + - '' + - >- + Task has completed successfully or has depleted all retry + attempts. + - Task has failed but may be retried. + - Task has been deliberately canceled. + clientId: type: string - description: Indicates the billing type of the client - enableVariableMasking: - description: >- - Optional. True if variable masking feature should be turned on for - this region - type: boolean - region: - description: The region the client is linked to. + taskNumber: type: string - id: + errorEnumString: type: string - description: Globally unique ID (project_id + region) - clientState: + workflowName: + type: string + taskName: + type: string + enumFilterType: enum: - - CLIENT_STATE_UNSPECIFIED - - CLIENT_STATE_ACTIVE - - CLIENT_STATE_DISABLED + - DEFAULT_INCLUSIVE + - EXCLUSIVE + description: Whether to include or exclude the enums matching the regex. type: string enumDescriptions: - - The client state is unspecified - - The client is active and able to make calls to the IP APIs - - The client is disabled and will soon be deleted - description: Indicates the activity state the client - runAsServiceAccount: - description: >- - Default run-as service account email, set up during project - provision time, that will be used to generate auth token to be used - in Connector task, Rest caller task, Cloud function task and - Subworkflows. - type: string - createTime: + - '' + - '' + triggerId: type: string - description: The timestamp when the client was first created. - format: google-datetime - projectId: - description: The GCP project id of the client associated with + description: >- + Stats have been or will be aggregated on set fields for any + semantically-meaningful combination. + workflowId: type: string - cloudKmsConfig: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' - description: Cloud KMS config for Auth Module to encrypt/decrypt credentials. - isGmek: - description: Optional. Indicates the client is provisioned with CMEK or GMEK. - type: boolean - id: GoogleCloudIntegrationsV1alphaClientConfig - GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest: - id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials: + id: GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + description: >- + Parameters to support Oauth 2.0 Client Credentials Grant Authentication. + See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. properties: - requestId: + clientSecret: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Secret version reference containing the client secret. + clientId: + description: The client identifier. type: string - description: >- - Optional. This is used to de-dup incoming request: if the duplicate - request was detected, the response from the previous execution is - returned. - parameterEntries: - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - type: array - description: >- - Optional. Parameters are a part of Event and can be used to - communicate between different tasks that are part of the same - integration execution. - doNotPropagateError: - description: >- - Optional. Flag to determine how to should propagate errors. If this - flag is set to be true, it will not throw an exception. Instead, it - will return a {@link ExecuteIntegrationsResponse} with an execution - id and error messages as PostWithTriggerIdExecutionException in - {@link EventParameters}. The flag is set to be false by default. - type: boolean - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - type: object - description: Optional. Input parameters used by integration execution. - parameters: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: >- - Optional. Passed in as parameters to each integration execution. - Redacted - deprecated: true - triggerId: - description: >- - Required. Matched against all {@link TriggerConfig}s across all - integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The - trigger_id is in the format of `api_trigger/TRIGGER_NAME`. - type: string - executionId: - type: string - description: Optional. The id of the ON_HOLD execution to be resumed. - type: object - description: The request for executing an integration. - GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: - id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest - properties: {} - type: object - description: Request for UnpublishIntegrationVersion. - EnterpriseCrmEventbusProtoTeardown: - id: EnterpriseCrmEventbusProtoTeardown - properties: - teardownTaskConfigs: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' - type: array - description: Required. type: object - EnterpriseCrmEventbusProtoSuspensionExpiration: + GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: type: object - id: EnterpriseCrmEventbusProtoSuspensionExpiration + id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse properties: - expireAfterMs: - description: Milliseconds after which the suspension expires, if no action taken. - type: integer - format: int32 - remindAfterMs: - type: integer - description: >- - Milliseconds after which the previous suspension action reminder, if - any, is sent using the selected notification option, for a - suspension which is still PENDING_UNSPECIFIED. - format: int32 - liftWhenExpired: - type: boolean - description: >- - Whether the suspension will be REJECTED or LIFTED upon expiration. - REJECTED is the default behavior. - GoogleCloudIntegrationsV1alphaCloudKmsConfig: + triggerUrl: + type: string + description: The trigger url that will be returned + description: Response for Creating Cloud Function rpc call. + GoogleCloudIntegrationsV1alphaIntegrationAlertConfig: type: object - id: GoogleCloudIntegrationsV1alphaCloudKmsConfig - description: Configuration information for Client's Cloud KMS information properties: - kmsProjectId: - type: string + thresholdValue: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue description: >- - Optional. The gcp project id of the project where the kms key - stored. If empty, the kms key is stored at the same project as - customer's project and ecrypted with CMEK, otherwise, the kms key is - stored in the tenant project and encrypted with GMEK - kmsLocation: + The metric value, above or below which the alert should be + triggered. + aggregationPeriod: type: string - description: Required. Location name of the key ring, e.g. "us-west1". - keyVersion: description: >- - Optional. Each version of a key contains key material used for - encryption or signing. A key's version is represented by an integer, - starting at 1. To decrypt data or verify a signature, you must use - the same key version that was used to encrypt or sign the data. - type: string - key: + The period over which the metric value should be aggregated and + evaluated. Format is , where integer should be a positive integer + and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, + day, week). For an EXPECTED_MIN threshold, this aggregation_period + must be lesser than 24 hours. + onlyFinalAttempt: + type: boolean description: >- - Required. A Cloud KMS key is a named object containing one or more - key versions, along with metadata for the key. A key exists on - exactly one key ring tied to a specific location. - type: string - kmsRing: - type: string + For either events or tasks, depending on the type of alert, count + only final attempts, not retries. + displayName: description: >- - Required. A key ring organizes keys in a specific Google Cloud - location and allows you to manage access control on groups of keys. - A key ring's name does not need to be unique across a Google Cloud - project, but must be unique within a given location. - EnterpriseCrmEventbusProtoNotification: - type: object - properties: - emailAddress: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAddress' - escalatorQueue: + Name of the alert. This will be displayed in the alert subject. If + set, this name should be unique within the scope of the integration. type: string - request: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoCustomSuspensionRequest + thresholdType: description: >- - If the out-of-the-box email/pubsub notifications are not suitable - and custom logic is required, fire a workflow containing all info - needed to notify users to resume execution. - pubsubTopic: - type: string - buganizerNotification: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBuganizerNotification' - id: EnterpriseCrmEventbusProtoNotification - EnterpriseCrmEventbusProtoWorkflowAlertConfig: - description: >- - Message to be used to configure custom alerting in the {@code - EventConfig} protos for an event. - id: EnterpriseCrmEventbusProtoWorkflowAlertConfig - type: object - properties: - clientId: + The threshold type, whether lower(expected_min) or + upper(expected_max), for which this alert is being configured. If + value falls below expected_min or exceeds expected_max, an alert + will be fired. + enumDescriptions: + - Default. + - >- + Note that this field will only trigger alerts if the integration + specifying it runs at least once in 24 hours (which is our + in-memory retention period for monarch streams). Also note that + `aggregation_period` for this alert configuration must be less + than 24 hours. Min value threshold. + - Max value threshold. type: string - description: Client associated with this alert configuration. - alertDisabled: - type: boolean - description: >- - Set to false by default. When set to true, the metrics are not - aggregated or pushed to Monarch for this workflow alert. - thresholdValue: + enum: + - THRESHOLD_TYPE_UNSPECIFIED + - EXPECTED_MIN + - EXPECTED_MAX + alertThreshold: + type: integer description: >- - The metric value, above or below which the alert should be - triggered. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue + For how many contiguous aggregation periods should the expected min + or max be violated for the alert to be fired. + format: int32 metricType: + enum: + - METRIC_TYPE_UNSPECIFIED + - EVENT_ERROR_RATE + - EVENT_WARNING_RATE + - TASK_ERROR_RATE + - TASK_WARNING_RATE + - TASK_RATE + - EVENT_RATE + - EVENT_AVERAGE_DURATION + - EVENT_PERCENTILE_DURATION + - TASK_AVERAGE_DURATION + - TASK_PERCENTILE_DURATION enumDescriptions: - >- The default value. Metric type should always be set to one of the @@ -5332,1192 +4794,1050 @@ components: INVALID_ARGUMENT error. - >- Specifies alerting on the rate of errors for the enclosing - workflow. + integration. - >- Specifies alerting on the rate of warnings for the enclosing - workflow. Warnings use the same enum values as errors. + integration. Warnings use the same enum values as errors. - >- Specifies alerting on the rate of errors for any task in the - enclosing workflow. + enclosing integration. - >- Specifies alerting on the rate of warnings for any task in the - enclosing workflow. + enclosing integration. - >- Specifies alerting on the rate of executions over all tasks in the - enclosing workflow. + enclosing integration. - >- Specifies alerting on the number of events executed in the given aggregation_period. - >- Specifies alerting on the average duration of executions for this - workflow. + integration. - >- Specifies alerting on the duration value of a particular - percentile of workflow executions. E.g. If 10% or more of the - workflow executions have durations above 5 seconds, alert. + percentile of integration executions. E.g. If 10% or more of the + integration executions have durations above 5 seconds, alert. - >- Specifies alerting on the average duration of any task in the - enclosing workflow, + enclosing integration, - >- Specifies alerting on the duration value of a particular - percentile of any task executions within the enclosing workflow. - E.g. If 10% or more of the task executions in the workflow have - durations above 5 seconds, alert. - enum: - - METRIC_TYPE_UNSPECIFIED - - EVENT_ERROR_RATE - - EVENT_WARNING_RATE - - TASK_ERROR_RATE - - TASK_WARNING_RATE - - TASK_RATE - - EVENT_RATE - - EVENT_AVERAGE_DURATION - - EVENT_PERCENTILE_DURATION - - TASK_AVERAGE_DURATION - - TASK_PERCENTILE_DURATION + percentile of any task executions within the enclosing + integration. E.g. If 10% or more of the task executions in the + integration have durations above 5 seconds, alert. type: string - aggregationPeriod: - description: >- - For an EXPECTED_MIN threshold, this aggregation_period must be - lesser than 24 hours. + description: The type of metric. + durationThreshold: type: string - onlyFinalAttempt: + format: google-duration description: >- - For either events or tasks, depending on the type of alert, count - only final attempts, not retries. - type: boolean - alertName: - type: string + Should be specified only for *AVERAGE_DURATION and + *PERCENTILE_DURATION metrics. This member should be used to specify + what duration value the metrics should exceed for the alert to + trigger. + disableAlert: description: >- - A name to identify this alert. This will be displayed in the alert - subject. If set, this name should be unique within the scope of the - workflow. - thresholdType: - type: string - enumDescriptions: - - '' - - >- - Note that this field will only trigger alerts if the workflow - specifying it runs at least once in 24 hours (which is our - in-memory retention period for monarch streams). Also note that - `aggregation_period` for this alert configuration must be less - than 24 hours. - - '' - description: >- - The threshold type, whether lower(expected_min) or - upper(expected_max), for which this alert is being configured. If - value falls below expected_min or exceeds expected_max, an alert - will be fired. - enum: - - UNSPECIFIED_THRESHOLD_TYPE - - EXPECTED_MIN - - EXPECTED_MAX - warningEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - errorEnumList: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList - numAggregationPeriods: - description: >- - For how many contiguous aggregation periods should the expected min - or max be violated for the alert to be fired. - format: int32 - type: integer - playbookUrl: - description: >- - Link to a playbook for resolving the issue that triggered this - alert. + Set to false by default. When set to true, the metrics are not + aggregated or pushed to Monarch for this integration alert. + type: boolean + description: >- + Message to be used to configure custom alerting in the {@code + EventConfig} protos for an event. + id: GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + EnterpriseCrmEventbusProtoParameterMapField: + id: EnterpriseCrmEventbusProtoParameterMapField + properties: + referenceKey: + description: Referencing one of the WF variables. type: string - durationThresholdMs: + literalValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: Passing a literal value. + description: Field represents either the key or value in an entry. + type: object + GoogleCloudConnectorsV1HPAConfig: + description: Autoscaling config for connector deployment system metrics. + type: object + id: GoogleCloudConnectorsV1HPAConfig + properties: + cpuUtilizationThreshold: + readOnly: true format: int64 type: string + description: Output only. Percent CPU utilization where HPA triggers autoscaling. + memoryUtilizationThreshold: description: >- - Should be specified only for *AVERAGE_DURATION and - *PERCENTILE_DURATION metrics. This member should be used to specify - what duration value the metrics should exceed for the alert to - trigger. - EnterpriseCrmFrontendsEventbusProtoTaskConfig: - id: EnterpriseCrmFrontendsEventbusProtoTaskConfig - properties: - taskName: - description: The name for the task. - type: string - label: - description: User-provided label that is attached to this TaskConfig in the UI. - type: string - nextTasksExecutionPolicy: - enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. + Output only. Percent Memory utilization where HPA triggers + autoscaling. + format: int64 + readOnly: true type: string + EnterpriseCrmFrontendsEventbusProtoParameterMap: + properties: + keyType: description: >- - The policy dictating the execution of the next set of tasks for the - current task. + Option to specify key value type for all entries of the map. If + provided then field types for all entries must conform to this. enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - position: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' - description: >- - Optional. Informs the front-end application where to draw this task - config on the UI. - description: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' type: string - description: >- - User-provided description intended to give more business context - about the task. - errorCatcherId: + valueType: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE type: string - description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - nextTasks: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + entries: type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' - description: >- - The set of tasks that are next in line to be executed as per the - execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. - successPolicy: - description: Determines what action to take upon successful task completion. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' - lastModifiedTime: - description: Auto-generated. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + description: >- + A generic multi-map that holds key value pairs. They keys and values can + be of any type, unless specified. + type: object + id: EnterpriseCrmFrontendsEventbusProtoParameterMap + GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: + id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + properties: + authConfigs: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + description: The list of AuthConfigs retrieved. + nextPageToken: type: string - format: google-datetime - alertConfigs: - description: >- - Alert configurations on error rate, warning rate, number of runs, - durations, etc. + description: The token used to retrieve the next page of results. + type: object + description: Response to list AuthConfigs. + EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: + properties: + parameters: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry type: array - taskNumber: - type: string + id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage + type: object + GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: + type: object + properties: + inputParameters: + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Optional. Input parameters used during integration execution. + type: object + testMode: + type: boolean description: >- - REQUIRED: the identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_number`). - taskTemplateName: - description: Used to define task-template name if task is of type task-template - type: string - incomingEdgeCount: - description: The number of edges leading into this TaskConfig. - type: integer - format: int32 - externalTaskType: - type: string - enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows - enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK - creatorEmail: + Optional. Can be specified in the event request, otherwise false + (default). If true, enables tasks with condition "test_mode = true". + If false, disables tasks with condition "test_mode = true" if global + test mode (set by platform) is also false {@link EventBusConfig}. + clientId: + description: >- + Required. This is used to identify the client on whose behalf the + event will be executed. type: string - description: The creator's email address. Auto-generated from the user's email. - taskExecutionStrategy: - enumDescriptions: - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). - - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. - description: The policy dictating the execution strategy of this task. + integrationVersion: + description: Required. integration config to execute the workflow + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + triggerId: type: string - enum: - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - disableStrictTypeValidation: description: >- - If this config contains a TypedTask, allow validation to succeed if - an input is read from the output of another TypedTask whose output - type is declared as a superclass of the requested input type. For - instance, if the previous task declares an output of type Message, - any task with this flag enabled will pass validation when attempting - to read any proto Message type from the resultant Event parameter. - type: boolean - conditionalFailurePolicies: + Required. The trigger id of the integration trigger config. If both + trigger_id and client_id is present, the integration is executed + from the start tasks provided by the matching trigger config + otherwise it is executed from the default start tasks. + configParameters: + additionalProperties: + type: any + description: Properties of the object. + description: Optional. Config parameters used during integration execution. + type: object + deadlineSecondsTime: + type: string + format: google-datetime + description: Optional. custom deadline of the rpc + parameters: + description: Optional. Passed in as parameters to each integration execution. + deprecated: true $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + description: The request for testing an integration. + GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse: + type: object + description: The response for executing an integration. + id: GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + properties: + executionId: + description: The id of the execution corresponding to this run of integration. + type: string + outputParameters: description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - parameters: + OUTPUT parameters in format of Map. Where Key is the name of the + parameter. Note: Name of the system generated parameters are wrapped + by backtick(`) to distinguish them from the user defined parameters. + type: object additionalProperties: + description: Properties of the object. + type: any + parameterEntries: + deprecated: true + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + items: $ref: >- #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: The customized parameters the user can pass to this task. + type: array + executionFailed: + description: Is true if any execution in the integration failed. False otherwise. + deprecated: true + type: boolean + eventParameters: + description: Details for the integration that were executed. + deprecated: true + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + GoogleCloudIntegrationsV1alphaExecutionSnapshot: + id: GoogleCloudIntegrationsV1alphaExecutionSnapshot + properties: + taskExecutionDetails: + description: All of the task execution details at the given point of time. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTaskExecutionDetails + type: array + params: + description: Parameters used during the execution. + additionalProperties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' type: object - rollbackStrategy: + executionSnapshotMetadata: + description: Metadata of the execution snapshot. $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata + checkpointTaskNumber: description: >- - Optional. Contains information about what needs to be done upon - failure (either a permanent error or after it has been retried too - many times). - taskSpec: + Indicates "after which checkpoint task's execution" this snapshot is + taken. type: string + description: Contains the snapshot of the execution for a given checkpoint. + type: object + GoogleCloudIntegrationsV1alphaShareTemplateRequest: + type: object + id: GoogleCloudIntegrationsV1alphaShareTemplateRequest + properties: + resourceNames: + items: + type: string + type: array description: >- - A string template that allows user to configure task parameters - (with either literal default values or tokens which will be resolved - at execution time) for the task. It will eventually replace the old - "parameters" field. - taskEntity: - $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' - description: Copy of the task entity that this task config is an instance of. - synchronousCallFailurePolicy: - description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' - jsonValidationOption: + Optional. Project name resources to share the template. The project + names is expected in resource format Ex: projects/{project-number} + or organization/{org-id} + description: Request to Share template + GoogleCloudIntegrationsV1alphaCloudSchedulerConfig: + properties: + location: type: string - enumDescriptions: - - >- - As per the default behavior, no validation will be run. Will not - override any option set in a Task. - - Do not run any validation against JSON schemas. - - >- - Validate all potential input JSON parameters against schemas - specified in WorkflowParameters. - - >- - Validate all potential output JSON parameters against schemas - specified in WorkflowParameters. - - Perform both PRE_EXECUTION and POST_EXECUTION validations. - enum: - - UNSPECIFIED_JSON_VALIDATION_OPTION - - SKIP - - PRE_EXECUTION - - POST_EXECUTION - - PRE_POST_EXECUTION description: >- - If set, overrides the option configured in the Task implementation - class. - taskType: + Required. The location where associated cloud scheduler job will be + created + cronTab: + description: Required. The cron tab of cloud scheduler trigger. type: string - description: Defines the type of the task - enumDescriptions: - - Normal IP task - - Task is of As-Is Template type - - Task is of I/O template type with a different underlying task - enum: - - TASK - - ASIS_TEMPLATE - - IO_TEMPLATE - preconditionLabel: + serviceAccountEmail: description: >- - Optional. User-provided label that is attached to precondition in - the UI. + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time type: string - failurePolicy: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + errorMessage: description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - createTime: - format: google-datetime - description: Auto-generated. + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations type: string - precondition: + description: Cloud Scheduler Trigger configuration + type: object + id: GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + GoogleCloudIntegrationsV1alphaLiftSuspensionRequest: + id: GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + type: object + description: Request for lift Suspension + properties: + suspensionResult: type: string description: >- - Optional. Standard filter expression evaluated before execution. - Independent of other conditions and tasks. Can be used to enable - rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to - task. + User passed in suspension result and will be used to control + workflow execution branching behavior by setting up corresponnding + edge condition with suspension result. For example, if you want to + lift the suspension, you can pass "Approved", or if you want to + reject the suspension and terminate workfloe execution, you can pass + "Rejected" and terminate the workflow execution with configuring the + edge condition. + GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse: + description: Response for DownloadJsonPackage. type: object - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. - GoogleCloudIntegrationsV1alphaSuspension: - id: GoogleCloudIntegrationsV1alphaSuspension + id: GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse properties: - suspensionConfig: - deprecated: true - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' - description: >- - Controls the notifications and resolver permissions for this - suspension. - approvalConfig: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig - description: >- - Controls the notifications and approval permissions for this - suspension. - state: - description: >- - Required. State of this suspension, indicating what action a - resolver has taken. - enum: - - RESOLUTION_STATE_UNSPECIFIED - - PENDING - - REJECTED - - LIFTED - type: string - enumDescriptions: - - Unset state. - - The suspension has not yet been resolved. - - The resolver has rejected the suspension. - - The resolver has lifted the suspension. - eventExecutionInfoId: - type: string - description: Required. ID of the associated execution. - createTime: - description: Output only. Auto-generated. - readOnly: true - format: google-datetime - type: string - audit: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionAudit' - description: Metadata pertaining to the resolution of this suspension. - lastModifyTime: - readOnly: true - description: Output only. Auto-generated. - format: google-datetime - type: string - integration: - description: Required. The name of the originating integration. - type: string - taskId: - description: Required. Task id of the associated SuspensionTask. - type: string - name: - type: string - description: Resource name for suspensions suspension/{suspension_id} - type: object - description: A record representing a suspension. - EnterpriseCrmEventbusProtoBooleanParameterArray: - properties: - booleanValues: + files: + description: List containing JSON for multiple file with type information. type: array items: - type: boolean - id: EnterpriseCrmEventbusProtoBooleanParameterArray + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFile' + GoogleCloudConnectorsV1NodeConfig: + id: GoogleCloudConnectorsV1NodeConfig type: object - EnterpriseCrmFrontendsEventbusProtoEventParameters: - description: >- - LINT.IfChange This message is used for processing and persisting (when - applicable) key value pair parameters for each event in the event bus. - Please see + description: Node configuration for the connection. properties: - parameters: + maxNodeCount: + description: Maximum number of nodes in the runtime nodes. + type: integer + format: int32 + minNodeCount: + type: integer + description: Minimum number of nodes in the runtime nodes. + format: int32 + GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata: + properties: + entities: items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry - description: >- - Parameters are a part of Event and can be used to communicate - between different tasks that are part of the same workflow - execution. + type: string type: array - type: object - id: EnterpriseCrmFrontendsEventbusProtoEventParameters - EnterpriseCrmEventbusProtoTaskUiConfig: - id: EnterpriseCrmEventbusProtoTaskUiConfig - type: object - properties: - taskUiModuleConfigs: - description: Configurations of included config modules. + description: List of entity names. + actions: type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' - description: >- - Task authors would use this type to configure the UI for a particular - task by specifying what UI config modules should be included to compose - the UI. Learn more about config module framework: - GoogleCloudIntegrationsV1alphaSfdcInstance: + type: string + description: List of actions. + id: GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + description: Metadata of runtime connection schema. + type: object + GoogleCloudIntegrationsV1alphaEventParameter: properties: - createTime: - readOnly: true - description: Output only. Time when the instance is created - format: google-datetime - type: string - description: - type: string - description: A description of the sfdc instance. - sfdcOrgId: - type: string - description: The SFDC Org Id. This is defined in salesforce. - updateTime: - description: Output only. Time when the instance was last updated - readOnly: true - type: string - format: google-datetime - name: - description: >- - Resource name of the SFDC instance - projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. - type: string - serviceAuthority: - type: string + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' description: >- - URL used for API calls after authentication (the login authority is - configured within the referenced AuthConfig). - deleteTime: - format: google-datetime - type: string - readOnly: true + Values for the defined keys. Each value can either be string, int, + double or any proto message. + key: description: >- - Output only. Time when the instance was deleted. Empty if not - deleted. - displayName: + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the integration definition. type: string - description: User selected unique name/alias to easily reference an instance. - authConfigId: - items: - type: string - description: A list of AuthConfigs that can be tried to open the channel to SFDC - type: array - id: GoogleCloudIntegrationsV1alphaSfdcInstance - description: >- - The SfdcInstance resource use to hold channels and connection config - data. + masked: + description: True if this parameter should be masked in the logs + type: boolean + id: GoogleCloudIntegrationsV1alphaEventParameter type: object - EnterpriseCrmEventbusProtoValueType: + description: >- + This message is used for processing and persisting (when applicable) key + value pair parameters for each event in the event bus. Next available + id: 4 + GoogleCloudIntegrationsV1alphaParameterMapField: properties: - intArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArray' - booleanValue: - type: boolean - doubleArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArray' - stringValue: - type: string - stringArray: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArray' - protoValue: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - intValue: - format: int64 + literalValue: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: Passing a literal value. + referenceKey: type: string - doubleValue: - type: number - format: double - description: >- - Used for define type for values. Currently supported value types include - int, string, double, array, and any proto message. - id: EnterpriseCrmEventbusProtoValueType + description: Referencing one of the Integration variables. + description: Field represents either the key or value in an entry. + id: GoogleCloudIntegrationsV1alphaParameterMapField type: object - GoogleCloudIntegrationsV1alphaCancelExecutionRequest: - description: Request for cancelling an execution. - id: GoogleCloudIntegrationsV1alphaCancelExecutionRequest + GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest: type: object + description: Request for UnpublishIntegrationVersion. + id: GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest properties: {} - EnterpriseCrmEventbusProtoEventBusProperties: - type: object - properties: - properties: - description: An unordered list of property entries. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoPropertyEntry' - type: array - id: EnterpriseCrmEventbusProtoEventBusProperties + GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow: description: >- - LINT.IfChange This message is used for storing key value pair properties - for each Event / Task in the EventBus. - EnterpriseCrmFrontendsEventbusProtoIntParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray + Parameters to support Oauth 2.0 Auth Code Grant Authentication. See + https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. properties: - intValues: + authUri: + description: Auth URL for Authorization Code Flow + type: string + scopes: + description: >- + Scopes the connection will request when the user performs the auth + code flow. type: array items: - format: int64 type: string - type: object - GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials: - properties: - password: - description: The user's password. - type: string - requestType: - enumDescriptions: - - Unspecified request type - - To pass all the parameters in post body. - - To pass all the parameters as a part of query parameter. - - >- - To pass client id and client secret as base 64 encoding of - client_id:client_password and rest parameters in post body. - type: string - description: Represent how to pass parameters to fetch access token - enum: - - REQUEST_TYPE_UNSPECIFIED - - REQUEST_BODY - - QUERY_PARAMETERS - - ENCODED_HEADER - clientSecret: + enablePkce: + type: boolean + description: Whether to enable PKCE when the user performs the auth code flow. + authCode: type: string - description: The client's secret. - tokenParams: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' - description: Token parameters for the auth request. - accessToken: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' - description: Access token fetched from the authorization server. + description: Authorization code to be exchanged for access and refresh tokens. clientId: + description: Client ID for user-provided OAuth app. type: string - description: The client's ID. - scope: - description: A space-delimited list of requested scope permissions. - type: string - tokenEndpoint: + redirectUri: + description: Redirect URI to be provided during the auth code exchange. type: string - description: >- - The token endpoint is used by the client to obtain an access token - by presenting its authorization grant or refresh token. - username: - description: The user's username. + clientSecret: + description: Client secret for user-provided OAuth app. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + pkceVerifier: type: string - id: GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials + description: PKCE verifier to be used during the auth code exchange. type: object + id: GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + EnterpriseCrmFrontendsEventbusProtoTaskConfig: description: >- - For resource owner credentials grant, the client will ask the user for - their authorization credentials (ususally a username and password) and - send a POST request to the authorization server. The authorization - server will respond with a JSON object containing the access token. - GoogleCloudIntegrationsV1alphaTaskExecutionDetails: - id: GoogleCloudIntegrationsV1alphaTaskExecutionDetails + The task configuration details. This is not the implementation of Task. + There might be multiple TaskConfigs for the same Task. + type: object properties: - taskNumber: + taskSpec: type: string - description: Pointer to the task config it used for execution. - taskAttemptStats: - type: array - description: Status for the current task execution attempt. - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' - taskExecutionState: + description: >- + A string template that allows user to configure task parameters + (with either literal default values or tokens which will be resolved + at execution time) for the task. It will eventually replace the old + "parameters" field. + taskType: + description: Defines the type of the task + enumDescriptions: + - Normal IP task + - Task is of As-Is Template type + - Task is of I/O template type with a different underlying task enum: - - TASK_EXECUTION_STATE_UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELLED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED - description: The execution state of this task. + - TASK + - ASIS_TEMPLATE + - IO_TEMPLATE + type: string + jsonValidationOption: + description: >- + If set, overrides the option configured in the Task implementation + class. + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION + - SKIP + - PRE_EXECUTION + - POST_EXECUTION + - PRE_POST_EXECUTION enumDescriptions: - - Default value. - - >- - Task is waiting for its precondition tasks to finish to start the - execution. - - Task is under processing. - - >- - Task execution successfully finished. There's no more change after - this state. - - Task execution failed. There's no more change after this state. - - >- - Task execution failed and cause the whole integration execution to - fail immediately. There's no more change after this state. - - Task execution failed and waiting for retry. - - >- - Task execution skipped. This happens when its precondition wasn't - met, or the integration execution been canceled before reach to - the task. There's no more changes after this state. - - >- - Task execution canceled when in progress. This happens when - integration execution been canceled or any other task fall in - fatal state. - >- - Task is waiting for its dependency tasks' rollback to finish to - start its rollback. - - Task is rolling back. + As per the default behavior, no validation will be run. Will not + override any option set in a Task. + - Do not run any validation against JSON schemas. - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. + Validate all potential input JSON parameters against schemas + specified in WorkflowParameters. - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. + Validate all potential output JSON parameters against schemas + specified in WorkflowParameters. + - Perform both PRE_EXECUTION and POST_EXECUTION validations. type: string - description: Contains the details of the execution of this task. - type: object - GoogleCloudIntegrationsV1alphaListAuthConfigsResponse: - id: GoogleCloudIntegrationsV1alphaListAuthConfigsResponse - properties: - nextPageToken: + taskName: + description: The name for the task. type: string - description: The token used to retrieve the next page of results. - authConfigs: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' - description: The list of AuthConfigs retrieved. - type: array - type: object - description: Response to list AuthConfigs. - EnterpriseCrmEventbusProtoLogSettings: - properties: - shorteningLimits: + disableStrictTypeValidation: description: >- - Contains the field limits for shortening, such as max string length - and max array length. - $ref: '#/components/schemas/EnterpriseCrmLoggingGwsFieldLimits' - seedPeriod: + If this config contains a TypedTask, allow validation to succeed if + an input is read from the output of another TypedTask whose output + type is declared as a superclass of the requested input type. For + instance, if the previous task declares an output of type Message, + any task with this flag enabled will pass validation when attempting + to read any proto Message type from the resultant Event parameter. + type: boolean + parameters: + additionalProperties: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: object + description: The customized parameters the user can pass to this task. + preconditionLabel: type: string - enumDescriptions: - - '' - - Sanitized values remain constant for the day of the event. - - >- - Sanitized values remain constant for the week of the event; may - cross month boundaries. - - Sanitized values remain constant for the month of the event. - enum: - - SEED_PERIOD_UNSPECIFIED - - DAY - - WEEK - - MONTH - seedScope: - enum: - - SEED_SCOPE_UNSPECIFIED - - EVENT_NAME - - TIME_PERIOD - - PARAM_NAME + description: >- + Optional. User-provided label that is attached to precondition in + the UI. + synchronousCallFailurePolicy: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + rollbackStrategy: + description: >- + Optional. Contains information about what needs to be done upon + failure (either a permanent error or after it has been retried too + many times). + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoRollbackStrategy + errorCatcherId: type: string - enumDescriptions: - - '' - - Hash computations include the event name. - - Hash computations include a time period. - - Hash computations include the param name. - logFieldName: + description: >- + Optional Error catcher id of the error catch flow which will be + executed when execution error happens in the task + successPolicy: + description: Determines what action to take upon successful task completion. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuccessPolicy' + taskTemplateName: + type: string + description: Used to define task-template name if task is of type task-template + creatorEmail: + description: The creator's email address. Auto-generated from the user's email. type: string + externalTaskType: + type: string + enum: + - EXTERNAL_TASK_TYPE_UNSPECIFIED + - NORMAL_TASK + - ERROR_TASK + enumDescriptions: + - Default value. External task type is not specified + - Tasks belongs to the normal task flows + - Task belongs to the error catch task flows + failurePolicy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' description: >- - The name of corresponding logging field of the event property. If - omitted, assumes the same name as the event property key. - sanitizeOptions: - $ref: '#/components/schemas/EnterpriseCrmLoggingGwsSanitizeOptions' + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). + position: description: >- - Contains the scrubbing options, such as whether to scrub, obfuscate, - etc. - type: object - id: EnterpriseCrmEventbusProtoLogSettings - description: >- - The LogSettings define the logging attributes for an event property. - These attributes are used to map the property to the parameter in the - log proto. Also used to define scrubbing/truncation behavior and PII - information. - CrmlogErrorCode: - type: object - description: >- - Registered ids for errors, as "oneof" enums. Each task or logical - grouping of tasks may share the same enum. - properties: - commonErrorCode: + Optional. Informs the front-end application where to draw this task + config on the UI. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' + conditionalFailurePolicies: + description: >- + Optional. Determines the number of times the task will be retried on + failure and with what retry strategy. This is applicable for + synchronous calls to Eventbus alone (Post). + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoConditionalFailurePolicies + lastModifiedTime: + description: Auto-generated. + type: string + format: google-datetime + taskNumber: + description: >- + REQUIRED: the identifier of this task within its parent event + config, specified by the client. This should be unique among all the + tasks belong to the same event config. We use this field as the + identifier to find next tasks (via field `next_tasks.task_number`). + type: string + nextTasksExecutionPolicy: + type: string enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. - - >- - ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use - only. This error will be counted as server availability error. - - '' - - '' - - '' - - '' - - '' - enumDeprecated: - - false - - true - - false - - false - - true - - true - - true - - false - - false - - true - - false - - false - - false - - false - - true - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false - - false + - Default + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. + description: >- + The policy dictating the execution of the next set of tasks for the + current task. + enum: + - UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + taskExecutionStrategy: type: string + description: The policy dictating the execution strategy of this task. enum: - - COMMON_ERROR_CODE_UNSPECIFIED - - INVALID_CREDENTIALS - - REQUIRED_FIELDS_MISSING - - INVALID_FIELDS - - BACKEND - - GENERAL - - INTERNAL - - IO_ERROR - - NOT_FOUND - - EVENT_BUS - - ALREADY_EXISTS - - CONCORD - - CONVERSION - - FLUME - - PERMISSION - - SALES_FORCE - - SPANNER - - UNIMPLEMENTED - - RELTIO - - WORKFLOW_NOT_FOUND - - QUOTA_THROTTLED - - QUOTA_ENQUEUED - - INVALID_QUOTA_CONFIGURATION - - TASK_NOT_FOUND - - EXECUTION_TIMEOUT - - INVALID_EVENT_EXECUTION_STATE - - INVALID_ATTRIBUTE - - MISSING_ATTRIBUTE - - CLIENT_UNAUTHORIZED_FOR_WORKFLOW - - INVALID_PARAMETER - - MISSING_PARAMETER - - UNAUTHROIZED_WORKFLOW_EDITOR_ACTION - - FAILED_PRECONDITION - - INVALID_CLIENT - - MISSING_CLIENT - - INVALID_WORKFLOW - - MISSING_QUOTA_CONFIGURATION - - UNHANDLED_TASK_ERROR - - SCRIPT_TASK_RUNTIME_ERROR - - RPC - - INVALID_PROTO - - UNHANDLED_EVENTBUS_ERROR - - INVALID_TASK_STATE - - TYPED_TASK_INVALID_INPUT_OPERATION - - TYPED_TASK_INVALID_OUTPUT_OPERATION - - VALIDATION_ERROR - - RESUME_ERROR - - APPS_SCRIPT_EXECUTION_ERROR - - INVALID_VECTOR_USER - - INFORMATICA - - RETRYABLE_TASK_ERROR - - INVALID_TENANT - - WRONG_TENANT - - INFORMATICA_BACKEND_UNAVAILABLE - - RPC_PERMISSION_DENIED - - SYNC_EVENTBUS_EXECUTION_TIMEOUT - - ASYNC_EVENTBUS_EXECUTION_TIMEOUT - - NOT_SUPPORTED_DATA_TYPE - - UNSANITIZED_USER_INPUT - - TRANSFORM_EXPRESSION_EVALUATION_ERROR - - HTTP_EXCEPTION - - EXECUTION_CANCELLED - id: CrmlogErrorCode - EnterpriseCrmEventbusProtoTaskUiModuleConfig: - id: EnterpriseCrmEventbusProtoTaskUiModuleConfig - description: Task author would use this type to configure a config module. - properties: - moduleId: + - WHEN_ALL_SUCCEED + - WHEN_ANY_SUCCEED + - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED enumDescriptions: - - Default - - Supports editing label of a task config. - - Supports editing error handling settings such as retry strategy. - - >- - Supports adding, removing and editing task parameter values in a - table with little assistance or restriction. - - >- - Supports editing values of declared input parameters of a task. - Think of it as a "strongly typed" upgrade to the TASK_PARAM_TABLE. - - Supports editing preconditions of a task config. - >- - Supports adding, editing, and deleting the scripts associated with - a script task, as well as modifying the input/output parameters. + Wait until all of its previous tasks finished execution, then + verify at least one of the edge conditions is met, and execute if + possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - >- - Supports editing task parameters associated with an RPC/stubby - task. + Start execution as long as any of its previous tasks finished + execution and the corresponding edge condition is met (since we + will execute if only that succeeding edge condition is met). - >- - Contains readonly task information, including input/output type - info. - - Configures a SuspensionTask. - - Configures a GenericStubbyTypedTask. - - Configures a SubWorkflowExecutorTask. - - Supports navigating to Apps Script editor - - Configures a SubWorkflowForEachLoopTask. - - Configures a FieldMappingTask. - - Contains embedded in-product documentation for a task. - - UI widget for the rest caller task. - - Configures a SubWorkflowScatterGatherTask. - - Configures a CloudSql Task. - - Configure a GenericConnectorTask. + Wait until all of its previous tasks finished execution, then + verify the all edge conditions are met and execute if possible. + label: + description: User-provided label that is attached to this TaskConfig in the UI. type: string - enum: - - UNSPECIFIED_TASK_MODULE - - LABEL - - ERROR_HANDLING - - TASK_PARAM_TABLE - - TASK_PARAM_FORM - - PRECONDITION - - SCRIPT_EDITOR - - RPC - - TASK_SUMMARY - - SUSPENSION - - RPC_TYPED - - SUB_WORKFLOW - - APPS_SCRIPT_NAVIGATOR - - SUB_WORKFLOW_FOR_EACH_LOOP - - FIELD_MAPPING - - README - - REST_CALLER - - SUB_WORKFLOW_SCATTER_GATHER - - CLOUD_SQL - - GENERIC_CONNECTOR_TASK - description: ID of the config module. - type: object - GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest: - description: Request for Creating Cloud Function rpc call. - properties: - projectId: + nextTasks: + description: >- + The set of tasks that are next in line to be executed as per the + execution graph defined for the parent event, specified by + `event_config_id`. Each of these next tasks are executed only if the + condition associated with them evaluates to true. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' + createTime: type: string + description: Auto-generated. + format: google-datetime + taskEntity: + description: Copy of the task entity that this task config is an instance of. + $ref: '#/components/schemas/EnterpriseCrmFrontendsEventbusProtoTaskEntity' + alertConfigs: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskAlertConfig' description: >- - Indicates the id of the GCP project that the function will be - created in. - functionRegion: - description: The function region of CF to be created + Alert configurations on error rate, warning rate, number of runs, + durations, etc. + type: array + precondition: + description: >- + Optional. Standard filter expression evaluated before execution. + Independent of other conditions and tasks. Can be used to enable + rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to + task. type: string - functionName: + description: type: string - description: The function name of CF to be created + description: >- + User-provided description intended to give more business context + about the task. + incomingEdgeCount: + type: integer + format: int32 + description: The number of edges leading into this TaskConfig. + id: EnterpriseCrmFrontendsEventbusProtoTaskConfig + EnterpriseCrmFrontendsEventbusProtoStringParameterArray: + id: EnterpriseCrmFrontendsEventbusProtoStringParameterArray type: object - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest - GoogleCloudIntegrationsV1alphaSuccessPolicy: properties: - finalState: - type: string - description: >- - State to which the execution snapshot status will be set if the task - succeeds. - enumDescriptions: - - UNSPECIFIED. - - >- - The default behavior, where successful tasks will be marked as - SUCCEEDED. - - >- - Sets the state to SUSPENDED after executing. This is required for - SuspensionTask; event execution will continue once the user calls - ResolveSuspensions with the event_execution_info_id and the task - number. - enum: - - FINAL_STATE_UNSPECIFIED - - SUCCEEDED - - SUSPENDED - description: >- - Policy that dictates the behavior for the task after it completes - successfully. - id: GoogleCloudIntegrationsV1alphaSuccessPolicy + stringValues: + type: array + items: + type: string + EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit: type: object - GoogleCloudConnectorsV1Secret: - description: Secret provides a reference to entries in Secret Manager. + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit properties: - secretVersion: - description: >- - The resource name of the secret version in the format, format as: - `projects/*/secrets/*/versions/*`. + resolvedByCpi: type: string - id: GoogleCloudConnectorsV1Secret - type: object - EnterpriseCrmEventbusProtoConnectorsConnection: + timestamp: + format: google-datetime + type: string + resolvedBy: + type: string + GoogleCloudIntegrationsV1alphaListIntegrationsResponse: type: object - id: EnterpriseCrmEventbusProtoConnectorsConnection + description: Response for ListIntegrations. + id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse properties: - connectionName: + integrations: + type: array + description: The integrations which match the request. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' + nextPageToken: type: string - description: >- - Connection name Format: - projects/{project}/locations/{location}/connections/{connection} - connectorVersion: + description: The next page token for the response. + GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode: + properties: + authParams: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + description: The auth parameters sent along with the auth code request. + authCode: type: string + description: The Auth Code that is used to initially retrieve the access token. + tokenParams: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + description: The token parameters sent along with the token request. + clientId: + description: The client's id. + type: string + scope: + type: string + description: A space-delimited list of requested scope permissions. + clientSecret: + description: The client's secret. + type: string + applyReauthPolicy: description: >- - Connector version Format: - projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} - serviceName: - description: >- - Service name Format: - projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} + Indicates if the user has opted in Google Reauth Policy. If opted + in, the refresh token will be valid for 20 hours, after which time + users must re-authenticate in order to obtain a new one. + type: boolean + authEndpoint: type: string - GoogleCloudConnectorsV1NodeConfig: + description: The auth url endpoint to send the auth code request to. + accessToken: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + description: The access token received from the token endpoint. + tokenEndpoint: + type: string + description: The token url endpoint to send the token request to. + requestType: + description: Represent how to pass parameters to fetch access token + enumDescriptions: + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. + - >- + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + type: string + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + type: object + id: GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode + description: >- + The OAuth Type where the client sends request with the client id and + requested scopes to auth endpoint. User sees a consent screen and auth + code is received at specified redirect url afterwards. The auth code is + then combined with the client id and secret and sent to the token + endpoint in exchange for the access and refresh token. The refresh token + can be used to fetch new access tokens. + EnterpriseCrmEventbusProtoSuspensionExpiration: properties: - minNodeCount: - description: Minimum number of nodes in the runtime nodes. - format: int32 + expireAfterMs: + description: Milliseconds after which the suspension expires, if no action taken. type: integer - maxNodeCount: format: int32 - description: Maximum number of nodes in the runtime nodes. + liftWhenExpired: + description: >- + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. + type: boolean + remindAfterMs: + format: int32 + description: >- + Milliseconds after which the previous suspension action reminder, if + any, is sent using the selected notification option, for a + suspension which is still PENDING_UNSPECIFIED. type: integer - id: GoogleCloudConnectorsV1NodeConfig + id: EnterpriseCrmEventbusProtoSuspensionExpiration type: object - description: Node configuration for the connection. - EnterpriseCrmLoggingGwsSanitizeOptions: + GoogleCloudConnectorsV1ConnectorVersionInfraConfig: description: >- - Identifies whether a field contains, or may contain, PII or sensitive - data, and how to sanitize the field if it does. If a field's privacy - type cannot be determined then it is sanitized (e.g., scrubbed). The - specific sanitizer implementation is determined by run-time - configuration and environment options (e.g., prod vs. qa). next_id: 5 + This cofiguration provides infra configs like rate limit threshold which + need to be configurable for every connector version properties: - sanitizeType: + resourceRequests: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' + readOnly: true + description: Output only. System resource requests. + deploymentModelMigrationState: type: string - enum: - - SANITIZE_TYPE_UNSPECIFIED - - SCRUB - - ANONYMIZE - - ANONYMIZE_LIMITED_REPEATABLE - - OBFUSCATE - - ENCRYPT - - DO_NOT_SANITIZE + readOnly: true + description: Output only. Status of the deployment model migration. enumDescriptions: - - '' - - Replace value with a scrubbed value (usu. a constant). - - >- - Transform a value so that it cannot be tracked across events. - However, a given value, is transformed to the same value *within* - an event. E.g., "foo.com" is transformed to "0xabcdef" for event - 1001, and to "0xfedcba" for event 1002. - - >- - Transform values as with ANONYMIZER, but the same transformation - is repeated for a limited time (e.g., 1 day). - - >- - The value is transformed using a well-defined obfuscator (e.g., - D3_CUSTOMER_ID). - - The value is encrypted. - - No sanitization is required. - privacy: + - Deployment model migration state is not specified. + - Deployment model migration is in progress. + - Deployment model migration is completed. + - Deployment model migration rolledback. + - Deployment model migration rollback in progress. enum: - - PRIVACY_TYPE_UNSPECIFIED - - NOT_PII - - PII - - SPII - - UNSURE - enumDescriptions: - - '' - - Field does *NOT* contain PII or sensitive data. - - Field contains PII. - - Field contains Sensitive PII. - - Unsure if field contains PII. + - DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED + - IN_PROGRESS + - COMPLETED + - ROLLEDBACK + - ROLLBACK_IN_PROGRESS + internalclientRatelimitThreshold: type: string - logType: - items: - enum: - - LOG_TYPE_UNSPECIFIED - - GWS - - GTS - - ALL - type: string - enumDescriptions: - - '' - - Limits apply when log detail records are written to GWS. - - >- - Limits apply when log detail records are written to GTS (e.g., - RecordIO files). - - Limits apply to *all* output log types. - type: array - description: To which type(s) of logs the sanitize options apply. - isAlreadySanitized: - type: boolean + readOnly: true description: >- - If true, the value has already been sanitized and needs no further - sanitization. For instance, a D3 customer id is already an - obfuscated entity and *might not* need further sanitization. - type: object - id: EnterpriseCrmLoggingGwsSanitizeOptions - GoogleCloudIntegrationsV1alphaExecuteEventResponse: - id: GoogleCloudIntegrationsV1alphaExecuteEventResponse - properties: - executionId: + Output only. Max QPS supported for internal requests originating + from Connd. + format: int64 + ratelimitThreshold: type: string - description: The id of the execution corresponding to this run of integration. - description: The response for executing an integration. - type: object - GoogleCloudConnectorsV1HPAConfig: - type: object - description: Autoscaling config for connector deployment system metrics. - properties: - memoryUtilizationThreshold: description: >- - Output only. Percent Memory utilization where HPA triggers - autoscaling. + Output only. Max QPS supported by the connector version before + throttling of requests. readOnly: true format: int64 + deploymentModel: type: string - cpuUtilizationThreshold: - type: string - description: Output only. Percent CPU utilization where HPA triggers autoscaling. - format: int64 - readOnly: true - id: GoogleCloudConnectorsV1HPAConfig - EnterpriseCrmFrontendsEventbusProtoTriggerConfig: - properties: - cloudSchedulerConfig: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudSchedulerConfig' - triggerName: + enumDescriptions: + - Deployment model is not specified. + - Default model gke mst. + - Cloud run mst. + description: Optional. Indicates whether connector is deployed on GKE/CloudRun + enum: + - DEPLOYMENT_MODEL_UNSPECIFIED + - GKE_MST + - CLOUD_RUN_MST + sharedDeployment: + description: Output only. The name of shared connector deployment. + type: string + readOnly: true + maxInstanceRequestConcurrency: + description: Output only. Max instance request concurrency. + type: integer + readOnly: true + format: int32 + hpaConfig: + readOnly: true + description: Output only. HPA autoscaling config. + $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' + connectionRatelimitWindowSeconds: + format: int64 + type: string + readOnly: true description: >- - Optional. Name of the trigger This is added to identify the type of - trigger. This is avoid the logic on triggerId to identify the - trigger_type and push the same to monitoring. + Output only. The window used for ratelimiting runtime requests to + connections. + resourceLimits: + description: Output only. System resource limits. + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' + id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig + type: object + GoogleCloudIntegrationsV1alphaImportTemplateRequest: + id: GoogleCloudIntegrationsV1alphaImportTemplateRequest + properties: + integration: type: string - errorCatcherId: + description: >- + Required. Name of the integration where template needs to be + imported. + integrationRegion: + type: string + description: Required. The region of the Integration to be created. + subIntegrations: + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails + description: Optional. Sub Integration which would be created via templates. + description: Request to Import template + type: object + EnterpriseCrmFrontendsEventbusProtoParameterMapField: + id: EnterpriseCrmFrontendsEventbusProtoParameterMapField + type: object + description: Field represents either the key or value in an entry. + properties: + literalValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + description: Passing a literal value. + referenceKey: + type: string + description: Referencing one of the WF variables. + GoogleCloudIntegrationsV1alphaCoordinate: + description: Configuration detail of coordinate, it used for UI + properties: + x: + description: Required. X axis of the coordinate + format: int32 + type: integer + 'y': + type: integer + description: Required. Y axis of the coordinate + format: int32 + type: object + id: GoogleCloudIntegrationsV1alphaCoordinate + GoogleCloudIntegrationsV1alphaStringParameterArray: + description: This message only contains a field of string array. + type: object + id: GoogleCloudIntegrationsV1alphaStringParameterArray + properties: + stringValues: + items: + type: string + description: String array. + type: array + EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: + properties: + booleanValues: + items: + type: boolean + type: array + id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + type: object + EnterpriseCrmEventbusProtoEventExecutionDetails: + description: >- + Contains the details of the execution info of this event: this includes + the tasks execution details plus the event execution statistics. Next + available id: 12 + id: EnterpriseCrmEventbusProtoEventExecutionDetails + type: object + properties: + cancelReason: + description: >- + If the execution is manually canceled, this field will contain the + reason for cancellation. type: string + ryeLockUnheldCount: description: >- - Optional Error catcher id of the error catch flow which will be - executed when execution error happens in the task - position: + Used internally and shouldn't be exposed to users. A counter for the + cron job to record how many times this event is in in_process state + but don't have a lock consecutively/ + type: integer + format: int32 + networkAddress: description: >- - Optional. Informs the front-end application where to draw this - trigger config on the UI. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCoordinate' - startTasks: + The network address (aka. bns address) that indicates where the + event executor is running. + type: string + eventRetriesFromBeginningCount: + format: int32 + type: integer description: >- - Set of tasks numbers from where the workflow execution is started by - this trigger. If this is empty, then workflow is executed with - default start tasks. In the list of start tasks, none of two tasks - can have direct ancestor-descendant relationships (i.e. in a same - workflow execution graph). + Indicates the number of times the execution has restarted from the + beginning. + eventExecutionSnapshot: type: array items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTask' - triggerCriteria: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot + logFilePath: + type: string + description: The log file path (aka. cns address) for this event. + eventAttemptStats: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats + nextExecutionTime: description: >- - Optional. When set, Eventbus will run the task specified in the - trigger_criteria and validate the result using the - trigger_criteria.condition, and only execute the workflow when - result is true. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTriggerCriteria' - triggerType: - enum: - - UNKNOWN - - CLOUD_PUBSUB - - GOOPS - - SFDC_SYNC - - CRON - - API - - MANIFOLD_TRIGGER - - DATALAYER_DATA_CHANGE - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - SFDC_PLATFORM_EVENTS_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER + Next scheduled execution time in case the execution status was + RETRY_ON_HOLD. + type: string + format: int64 + eventExecutionSnapshotsSize: + format: int64 + type: string + description: Total size of all event_execution_snapshots for an execution + eventExecutionState: enumDescriptions: - '' + - >- + Event is received and waiting for the execution. This happens when + firing the event via "postToQueue" or "schedule". + - Event is under processing. + - >- + Event execution successfully finished. There's no more change + after this state. + - Event execution failed. There's no more change after this state. + - >- + Event execution canceled by user. There's no more change after + this state. + - Event execution failed and waiting for retry. + - Event execution suspended and waiting for manual intervention. + enum: + - UNSPECIFIED + - ON_HOLD + - IN_PROCESS + - SUCCEEDED + - FAILED + - CANCELED + - RETRY_ON_HOLD + - SUSPENDED + type: string + EnterpriseCrmEventbusProtoTeardown: + id: EnterpriseCrmEventbusProtoTeardown + type: object + properties: + teardownTaskConfigs: + description: Required. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTeardownTaskConfig' + EnterpriseCrmEventbusProtoTaskUiConfig: + id: EnterpriseCrmEventbusProtoTaskUiConfig + description: >- + Task authors would use this type to configure the UI for a particular + task by specifying what UI config modules should be included to compose + the UI. Learn more about config module framework: + properties: + taskUiModuleConfigs: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskUiModuleConfig' + type: array + description: Configurations of included config modules. + type: object + EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig: + id: EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig + type: object + properties: + connection: + description: User-selected connection. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConnectorsConnection' + operation: + type: string + enumDescriptions: - '' - '' - '' @@ -6526,278 +5846,574 @@ components: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - type: string - enabledClients: - description: >- - Required. The list of client ids which are enabled to execute the - workflow using this trigger. In other words, these clients have the - workflow execution privledges for this trigger. For API trigger, the - client id in the incoming request is validated against the list of - enabled clients. For non-API triggers, one workflow execution is - triggered on behalf of each enabled client. - items: - type: string - type: array - triggerId: - type: string - description: The backend trigger ID. - nextTasksExecutionPolicy: - enumDescriptions: - - Default - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - type: string + description: Operation to perform using the configured connection. enum: - - UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - description: Dictates how next tasks will be executed. - label: - type: string - description: The user created label for a particular trigger. + - OPERATION_UNSPECIFIED + - EXECUTE_ACTION + - LIST_ENTITIES + - GET_ENTITY + - CREATE_ENTITY + - UPDATE_ENTITY + - DELETE_ENTITY + - EXECUTE_QUERY + GoogleCloudIntegrationsV1alphaSfdcInstance: + description: >- + The SfdcInstance resource use to hold channels and connection config + data. + type: object + properties: + authConfigId: + type: array + description: A list of AuthConfigs that can be tried to open the channel to SFDC + items: + type: string description: + type: string + description: A description of the sfdc instance. + serviceAuthority: type: string description: >- - User-provided description intended to give more business context - about the task. + URL used for API calls after authentication (the login authority is + configured within the referenced AuthConfig). + displayName: + type: string + description: User selected unique name/alias to easily reference an instance. + sfdcOrgId: + type: string + description: The SFDC Org Id. This is defined in salesforce. + deleteTime: + format: google-datetime + readOnly: true + type: string + description: >- + Output only. Time when the instance was deleted. Empty if not + deleted. + name: + description: >- + Resource name of the SFDC instance + projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. + type: string + createTime: + format: google-datetime + readOnly: true + type: string + description: Output only. Time when the instance is created + updateTime: + readOnly: true + format: google-datetime + description: Output only. Time when the instance was last updated + type: string + id: GoogleCloudIntegrationsV1alphaSfdcInstance + EnterpriseCrmFrontendsEventbusProtoWorkflowParameters: + properties: + parameters: + description: >- + Parameters are a part of Event and can be used to communiticate + between different tasks that are part of the same workflow + execution. + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameters + description: >- + LINT.IfChange This is the frontend version of WorkflowParameters. It's + exactly like the backend version except that instead of flattening + protobuf parameters and treating every field and subfield of a protobuf + parameter as a separate parameter, the fields/subfields of a protobuf + parameter will be nested as "children" (see 'children' field below) + parameters of the parent parameter. Please refer to + enterprise/crm/eventbus/proto/workflow_parameters.proto for more + information about WorkflowParameters. + type: object + GoogleCloudIntegrationsV1alphaTriggerConfig: + id: GoogleCloudIntegrationsV1alphaTriggerConfig + properties: + triggerId: + type: string + description: >- + Optional. Auto-generated trigger ID. The ID is based on the + properties that you define in the trigger config. For example, for + an API trigger, the trigger ID follows the format: + api_trigger/TRIGGER_NAME Where trigger config has properties with + value {"Trigger name": TRIGGER_NAME} triggerNumber: type: string description: >- Required. A number to uniquely identify each trigger config within - the workflow on UI. - alertConfig: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoWorkflowAlertConfig' + the integration on UI. + label: + type: string + description: Optional. The user created label for a particular trigger. + cloudSchedulerConfig: + description: Optional. Cloud Scheduler Trigger related metadata + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig + startTasks: type: array description: >- - An alert threshold configuration for the [trigger + client + - workflow] tuple. If these values are not specified in the trigger - config, default values will be populated by the system. Note that - there must be exactly one alert threshold configured per [client + - trigger + workflow] when published. - pauseWorkflowExecutions: + Optional. Set of tasks numbers from where the integration execution + is started by this trigger. If this is empty, then integration is + executed with default start tasks. In the list of start tasks, none + of two tasks can have direct ancestor-descendant relationships (i.e. + in a same integration execution graph). + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + triggerType: + enumDescriptions: + - Unknown. + - Trigger by scheduled time. + - Trigger by API call. + - Trigger by Salesforce Channel. + - Trigger by Pub/Sub external. + - SFDC Channel Trigger for CDC. + - Trigger by Cloud Scheduler job. + - Trigger by Connector Event + - Trigger for private workflow + description: Optional. Type of trigger + enum: + - TRIGGER_TYPE_UNSPECIFIED + - CRON + - API + - SFDC_CHANNEL + - CLOUD_PUBSUB_EXTERNAL + - SFDC_CDC_CHANNEL + - CLOUD_SCHEDULER + - INTEGRATION_CONNECTOR_TRIGGER + - PRIVATE_TRIGGER + type: string + trigger: description: >- - Optional. If set to true, any upcoming requests for this trigger - config will be paused and the executions will be resumed later when - the flag is reset. The workflow to which this trigger config belongs - has to be in ACTIVE status for the executions to be paused or - resumed. - type: boolean + Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub + Sub Trigger" When set will be sent out to monitoring dashabord for + tracking purpose. + type: string + errorCatcherId: + description: >- + Optional. Optional Error catcher id of the error catch flow which + will be executed when execution error happens in the task + type: string properties: additionalProperties: type: string + description: >- + Optional. Configurable properties of the trigger, not to be confused + with integration parameters. E.g. "name" is a property for API + triggers and "subscription" is a property for Pub/sub triggers. type: object + alertConfig: + type: array description: >- - Configurable properties of the trigger, not to be confused with - workflow parameters. E.g. "name" is a property for API triggers and - "subscription" is a property for Cloud Pubsub triggers. - description: 'Configuration detail of a trigger. Next available id: 20' - id: EnterpriseCrmFrontendsEventbusProtoTriggerConfig + Optional. An alert threshold configuration for the [trigger + client + + integration] tuple. If these values are not specified in the + trigger config, default values will be populated by the system. Note + that there must be exactly one alert threshold configured per + [client + trigger + integration] when published. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig + position: + description: >- + Optional. Informs the front-end application where to draw this error + catcher config on the UI. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + description: + description: >- + Optional. User-provided description intended to give additional + business context about the task. + type: string + nextTasksExecutionPolicy: + type: string + description: Optional. Dictates how next tasks will be executed. + enum: + - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED + - RUN_ALL_MATCH + - RUN_FIRST_MATCH + enumDescriptions: + - Default. + - Execute all the tasks that satisfy their associated condition. + - Execute the first task that satisfies the associated condition. type: object - GoogleCloudIntegrationsV1alphaParameterMapEntry: + description: Configuration detail of a trigger. + EnterpriseCrmEventbusProtoDoubleParameterArray: + id: EnterpriseCrmEventbusProtoDoubleParameterArray + properties: + doubleValues: + items: + format: double + type: number + type: array type: object - id: GoogleCloudIntegrationsV1alphaParameterMapEntry + GoogleCloudIntegrationsV1alphaGetClientMetadataResponse: + type: object + id: GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + description: Response for the GetClientMetadata rpc properties: - key: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Key of the map entry. - value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' - description: Value of the map entry. - description: Entry is a pair of key and value. - EnterpriseCrmEventbusProtoNodeIdentifier: - description: 'Represents a node identifier (type + id). Next highest id: 3' + properties: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaProjectProperties' + description: 'Required. Required: The client configuration that was requested' + GoogleCloudIntegrationsV1alphaDoubleParameterArray: + properties: + doubleValues: + type: array + items: + format: double + type: number + description: Double number array. type: object + id: GoogleCloudIntegrationsV1alphaDoubleParameterArray + description: This message only contains a field of double number array. + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse: + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + description: Response for LinkAppsScriptProject rpc call. properties: - elementType: - description: Destination node where the edge ends. It can only be a task config. - enum: - - UNKNOWN_TYPE - - TASK_CONFIG - - TRIGGER_CONFIG - enumDescriptions: - - '' - - '' - - '' - type: string - elementIdentifier: + scriptId: type: string - description: Configuration of the edge. - id: EnterpriseCrmEventbusProtoNodeIdentifier - EnterpriseCrmEventbusProtoAttributes: + description: The id of the linked Apps Script project. + type: object + GoogleCloudIntegrationsV1alphaProvisionClientRequest: + type: object + id: GoogleCloudIntegrationsV1alphaProvisionClientRequest + description: Request for the Provision rpc properties: - isRequired: - description: >- - Required for event execution. The validation will be done by the - event bus when the event is triggered. - type: boolean - isSearchable: - type: boolean + provisionGmek: deprecated: true + type: boolean description: >- - Used to indicate if a ParameterEntry should be converted to - ParamIndexes for ST-Spanner full-text search. DEPRECATED: use - searchable. - readOnly: - description: Used to indicate if the ParameterEntry is a read only field or not. + Optional. Deprecated. Indicates provision with GMEK or CMEK. This + field is deprecated and the provision would always be GMEK if + cloud_kms_config is not present in the request. + skipCpProvision: type: boolean - dataType: - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - >- - Domain is a web url string with one top-level private domain and a - suffix (for example: google.com, walmart.com) - type: string + description: Optional. Indicates if skip CP provision or not + runAsServiceAccount: description: >- - Things like URL, Email, Currency, Timestamp (rather than string, - int64...) - enum: - - DATA_TYPE_UNSPECIFIED - - EMAIL - - URL - - CURRENCY - - TIMESTAMP - - DOMAIN_NAME - logSettings: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' - description: See - searchable: - enumDescriptions: - - '' - - >- - If yes, the parameter key and value will be full-text indexed. In - a proto, this value will propagate to all children whose - searchable is unspecified. - - >- - If no, the parameter key and value will not be full-text indexed. - In a proto, this value will propagate to all children whose - searchable is unspecified. + Optional. User input run-as service account, if empty, will bring up + a new default service account type: string - enum: - - UNSPECIFIED - - 'YES' - - 'NO' - defaultValue: - description: Used to define defaults. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - taskVisibility: - items: - type: string - type: array - description: List of tasks that can view this property, if empty then all. - masked: + createSampleWorkflows: + description: >- + Optional. Indicates if sample workflow should be created along with + provisioning type: boolean - description: True if this workflow parameter should be masked in the logs + cloudKmsConfig: + description: >- + Optional. OPTIONAL: Cloud KMS config for AuthModule to + encrypt/decrypt credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCloudKmsConfig' + GoogleCloudIntegrationsV1alphaServiceAccountCredentials: + id: GoogleCloudIntegrationsV1alphaServiceAccountCredentials description: >- - Attributes are additional options that can be associated with each event - property. For more information, see - id: EnterpriseCrmEventbusProtoAttributes - type: object - EnterpriseCrmEventbusProtoParameterMapEntry: - description: Entry is a pair of key and value. - id: EnterpriseCrmEventbusProtoParameterMapEntry + Represents the service account which can be used to generate access + token for authenticating the service call. type: object properties: - value: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - key: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest: - description: Request for PublishIntegrationVersion. - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest - properties: - configParameters: - additionalProperties: - description: Properties of the object. - type: any - type: object - description: Optional. Config parameters used during integration execution. - type: object - EnterpriseCrmEventbusProtoJsonFunction: + serviceAccount: + description: >- + Name of the service account that has the permission to make the + request. + type: string + scope: + type: string + description: A space-delimited list of requested scope permissions. + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: type: object properties: - functionName: + createTime: + description: Auto-generated. + format: int64 + type: string + workflowName: + type: string + description: Name of the workflow. + integrationVersionUserLabel: + type: string + description: User-defined label that annotates the executed integration version. + errorCode: + description: Final error-code if event failed. + $ref: '#/components/schemas/CrmlogErrorCode' + requestParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Event parameters come in as part of the request. + lastModifiedTime: + format: int64 + type: string + description: Auto-generated. + workflowId: + description: Required. Pointer to the workflow it is executing. + type: string + workflowRetryBackoffIntervalSeconds: + format: int64 + type: string + description: >- + Time interval in seconds to schedule retry of workflow in manifold + when workflow is already running + snapshotNumber: + description: Workflow snapshot number. + type: string + format: int64 + responseParams: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters + description: Event parameters come out as part of the response. + tenant: + description: >- + Tenant this event is created. Used to reschedule the event to + correct tenant. + type: string + requestId: + description: Optional. This is used to de-dup incoming request. + type: string + product: + enum: + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY + description: >- + Which Google product the execution_info belongs to. If not set, the + execution_info belongs to Integration Platform by default. enumDescriptions: - '' - '' - '' - '' + type: string + cloudLoggingDetails: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' + description: Cloud Logging details for execution info + clientId: + type: string + description: The event data user sends as request. + triggerId: + type: string + description: >- + The trigger id of the workflow trigger config. If both trigger_id + and client_id is present, the workflow is executed from the start + tasks provided by the matching trigger config otherwise it is + executed from the default start tasks. + executionTraceInfo: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' + description: Execution trace info to aggregate parent-child executions. + errors: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' + type: array + description: >- + Errors, warnings, and informationals associated with the + workflow/task. The order in which the errors were added by the + workflow/task is maintained. + replayInfo: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + description: Replay info for the execution + eventExecutionInfoId: + type: string + description: Auto-generated primary key. + eventExecutionDetails: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails + description: The execution info about this event. + postMethod: + description: The ways user posts this event. + enumDescriptions: - '' - '' - '' - '' - '' - '' + enum: + - UNSPECIFIED + - POST + - POST_TO_QUEUE + - SCHEDULE + - POST_BY_EVENT_CONFIG_ID + - POST_WITH_EVENT_DETAILS + type: string + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + description: >- + Contains all the execution details for a workflow instance. Next + available id: 27 + GoogleCloudIntegrationsV1alphaUploadTemplateRequest: + properties: + fileFormat: + type: string + enumDescriptions: + - Unspecified file format + - JSON File Format + - YAML File Format + description: Required. File format for upload request. + enum: + - FILE_FORMAT_UNSPECIFIED + - JSON + - YAML + content: + type: string + description: Required. The textproto of the template. + id: GoogleCloudIntegrationsV1alphaUploadTemplateRequest + description: Request for UploadTemplate. + type: object + EnterpriseCrmEventbusProtoNodeIdentifier: + properties: + elementType: + enum: + - UNKNOWN_TYPE + - TASK_CONFIG + - TRIGGER_CONFIG + enumDescriptions: - '' - '' - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - 'next id: 24' type: string - enum: - - UNSPECIFIED - - GET_PROPERTY - - GET_ELEMENT - - APPEND_ELEMENT - - SIZE - - SET_PROPERTY - - FLATTEN - - FLATTEN_ONCE - - MERGE - - TO_STRING - - TO_INT - - TO_DOUBLE - - TO_BOOLEAN - - TO_PROTO - - TO_STRING_ARRAY - - TO_INT_ARRAY - - TO_DOUBLE_ARRAY - - TO_PROTO_ARRAY - - TO_BOOLEAN_ARRAY - - REMOVE_PROPERTY - - RESOLVE_TEMPLATE - - EQUALS - - FOR_EACH - - FILTER_ELEMENTS - id: EnterpriseCrmEventbusProtoJsonFunction - EnterpriseCrmEventbusProtoCondition: - deprecated: true - description: Condition that uses `operator` to evaluate the key against the value. - id: EnterpriseCrmEventbusProtoCondition + description: Destination node where the edge ends. It can only be a task config. + elementIdentifier: + type: string + description: Configuration of the edge. + id: EnterpriseCrmEventbusProtoNodeIdentifier + description: 'Represents a node identifier (type + id). Next highest id: 3' + type: object + EnterpriseCrmEventbusProtoStringParameterArray: + properties: + stringValues: + items: + type: string + type: array + type: object + id: EnterpriseCrmEventbusProtoStringParameterArray + EnterpriseCrmFrontendsEventbusProtoIntParameterArray: + type: object + properties: + intValues: + items: + type: string + format: int64 + type: array + id: EnterpriseCrmFrontendsEventbusProtoIntParameterArray + EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo: + description: >- + Contains the details of the execution info: this includes the replay + reason and replay tree connecting executions in a parent-child + relationship + type: object + properties: + originalExecutionInfoId: + type: string + description: >- + If this execution is a replay of another execution, then this field + contains the original execution id. + replayedExecutionInfoIds: + items: + type: string + description: >- + If this execution has been replayed, then this field contains the + execution ids of the replayed executions. + type: array + replayReason: + type: string + description: reason for replay + id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo + GoogleCloudIntegrationsV1alphaExecutionDetails: + properties: + eventExecutionSnapshotsSize: + description: Total size of all event_execution_snapshots for an execution + format: int64 + type: string + state: + type: string + enum: + - STATE_UNSPECIFIED + - PENDING + - PROCESSING + - SUCCEEDED + - FAILED + - CANCELLED + - RETRY_ON_HOLD + - SUSPENDED + description: Status of the execution. + enumDescriptions: + - Default. + - Execution is scheduled and awaiting to be triggered. + - Execution is processing. + - >- + Execution successfully finished. There's no more change after this + state. + - Execution failed. There's no more change after this state. + - >- + Execution canceled by user. There's no more change after this + state. + - Execution failed and waiting for retry. + - Execution suspended and waiting for manual intervention. + attemptStats: + type: array + description: List of Start and end time of the execution attempts. + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAttemptStats' + executionSnapshots: + description: List of snapshots taken during the execution. + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecutionSnapshot + type: array + id: GoogleCloudIntegrationsV1alphaExecutionDetails + description: >- + Contains the details of the execution info: this includes the tasks + execution details plus the event execution statistics. + type: object + GoogleCloudIntegrationsV1alphaUnshareTemplateRequest: + type: object + properties: + resourceNames: + type: array + description: >- + Optional. Project name resources to unshare the template. The + project names is expected in resource format Ex: + projects/{project-number} + items: + type: string + id: GoogleCloudIntegrationsV1alphaUnshareTemplateRequest + description: Request to Unshare template + EnterpriseCrmEventbusProtoPropertyEntry: + id: EnterpriseCrmEventbusProtoPropertyEntry + description: Key-value pair of EventBus property. + type: object properties: + key: + description: >- + Key is used to retrieve the corresponding property value. This + should be unique for a given fired event. The Tasks should be aware + of the keys used while firing the events for them to be able to + retrieve the values. + type: string value: $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - description: Value that's checked for the key. - operator: + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message. + GoogleCloudConnectorsV1BillingConfig: + description: Billing config for the connection. + type: object + id: GoogleCloudConnectorsV1BillingConfig + properties: + billingCategory: + readOnly: true enum: - - UNSET - - EQUALS - - CONTAINS - - LESS_THAN - - GREATER_THAN - - EXISTS - - DOES_NOT_EXIST - - IS_EMPTY - - IS_NOT_EMPTY + - BILLING_CATEGORY_UNSPECIFIED + - GCP_AND_TECHNICAL_CONNECTOR + - NON_GCP_CONNECTOR + description: Output only. Billing category for the connector. + enumDescriptions: + - Billing category is not specified. + - GCP/Technical connector. + - Non-GCP connector. + type: string + EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry: + type: object + id: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + properties: + dataType: + type: string enumDescriptions: - '' - '' @@ -6808,98 +6424,203 @@ components: - '' - '' - '' - description: >- - Operator used to evaluate the condition. Please note that an - operator with an inappropriate key/value operand will result in - IllegalArgumentException, e.g. CONTAINS with boolean key/value pair. - type: string - eventPropertyKey: - type: string - description: >- - Key that's evaluated against the `value`. Please note the data type - of the runtime value associated with the key should match the data - type of `value`, else an IllegalArgumentException is thrown. - type: object - GoogleCloudIntegrationsV1alphaTaskConfig: - id: GoogleCloudIntegrationsV1alphaTaskConfig - properties: + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + description: The data type of the parameter. + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE description: - description: >- - Optional. User-provided description intended to give additional - business context about the task. - type: string - displayName: + description: Optional. The description about the parameter type: string + name: description: >- - Optional. User-provided label that is attached to this TaskConfig in - the UI. - successPolicy: - description: >- - Optional. Determines what action to take upon successful task - completion. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuccessPolicy' - taskId: + The name (without prefix) to be displayed in the UI for this + parameter. E.g. if the key is "foo.bar.myName", then the name would + be "myName". type: string + protoDefName: description: >- - Required. The identifier of this task within its parent event - config, specified by the client. This should be unique among all the - tasks belong to the same event config. We use this field as the - identifier to find next tasks (via field `next_tasks.task_id`). - nextTasks: + The name of the protobuf type if the parameter has a protobuf data + type. + type: string + producer: + type: string + children: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry + description: >- + Child parameters nested within this parameter. This field only + applies to protobuf parameters type: array + key: + type: string description: >- - Optional. The set of tasks that are next in line to be executed as - per the execution graph defined for the parent event, specified by - `event_config_id`. Each of these next tasks are executed only if the - condition associated with them evaluates to true. - synchronousCallFailurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. + containsLargeData: description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - synchronous calls to Eventbus alone (Post). - nextTasksExecutionPolicy: + Indicates whether this variable contains large data and need to be + uploaded to Cloud Storage. + type: boolean + inOutType: + enumDescriptions: + - '' + - >- + Input parameters for the workflow. EventBus validates that these + parameters exist in the workflows before execution. + - >- + Output Parameters for the workflow. EventBus will only return the + workflow parameters tagged with OUT in the response back. + - >- + Input or Output Parameters. These can be used as both input and + output. EventBus will validate for the existence of these + parameters before execution and will also return this parameter + back in the response. + description: Specifies the input/output type for the parameter. + enum: + - IN_OUT_TYPE_UNSPECIFIED + - IN + - OUT + - IN_OUT + type: string + producedBy: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNodeIdentifier' description: >- - Optional. The policy dictating the execution of the next set of - tasks for the current task. + The identifier of the node (TaskConfig/TriggerConfig) this parameter + was produced by, if it is a transient param or a copy of an input + param. + defaultValue: + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + jsonSchema: type: string - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. - failurePolicy: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' description: >- - Optional. Determines the number of times the task will be retried on - failure and with what retry strategy. This is applicable for - asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). - parameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaEventParameter' - type: object - description: Optional. The customized parameters the user can pass to this task. - taskTemplate: + This schema will be used to validate runtime JSON-typed values of + this parameter. + isTransient: + description: Whether this parameter is a transient parameter. + type: boolean + attributes: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoAttributes' + description: Metadata information about the parameters. + required: + type: boolean + protoDefPath: type: string description: >- - Optional. Used to define task-template name if task is of type - task-template - jsonValidationOption: + If the data type is of type proto or proto array, this field needs + to be populated with the fully qualified proto name. This message, + for example, would be + "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + GoogleCloudConnectorsV1AuthConfigSshPublicKey: + id: GoogleCloudConnectorsV1AuthConfigSshPublicKey + properties: + sshClientCertPass: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Password (passphrase) for ssh client certificate if it has one. + sshClientCert: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: SSH Client Cert. It should contain both public and private key. + username: + description: The user account used to authenticate. + type: string + certType: + type: string + description: Format of SSH Client cert. + type: object + description: Parameters to support Ssh public key Authentication. + GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse: + id: GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + description: Response for TakeoverEditLock. + type: object + properties: + integrationVersion: + description: Version after the lock is acquired by the new user. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + EnterpriseCrmEventbusProtoTaskMetadata: + properties: + admins: + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTaskMetadataAdmin' + type: array + docMarkdown: + description: Snippet of markdown documentation to embed in the RHP for this task. + type: string + name: description: >- - Optional. If set, overrides the option configured in the Task - implementation class. + The actual class name or the annotated name of the task. Task Author + should initialize this field with value from the getName() method of + the Task class. + type: string + externalDocMarkdown: type: string + description: 'DEPRECATED: Use external_doc_html.' + status: + enumDescriptions: + - >- + Default value. Actual Task Status should always be set to either + INACTIVE or ACTIVE. If none is specified at runtime, it will be + set to INACTIVE. + - Still in-progress or incomplete, and not intended for use. + - Available for use. enum: - - JSON_VALIDATION_OPTION_UNSPECIFIED + - UNSPECIFIED_STATUS + - DEFAULT_INACTIVE + - ACTIVE + type: string + description: >- + Allows author to indicate if the task is ready to use or not. If not + set, then it will default to INACTIVE. + descriptiveName: + type: string + description: >- + The string name to show on the task list on the Workflow editor + screen. This should be a very short, one to two words name for the + task. (e.g. "Send Mail") + defaultJsonValidationOption: + description: >- + Controls whether JSON workflow parameters are validated against + provided schemas before and/or after this task's execution. + enum: + - UNSPECIFIED_JSON_VALIDATION_OPTION - SKIP - PRE_EXECUTION - POST_EXECUTION - PRE_POST_EXECUTION + type: string enumDescriptions: - >- As per the default behavior, no validation will be run. Will not @@ -6907,515 +6628,417 @@ components: - Do not run any validation against JSON schemas. - >- Validate all potential input JSON parameters against schemas - specified in IntegrationParameter. + specified in WorkflowParameters. - >- Validate all potential output JSON parameters against schemas - specified in IntegrationParameter. + specified in WorkflowParameters. - Perform both PRE_EXECUTION and POST_EXECUTION validations. - position: + externalDocHtml: + description: External-facing documention embedded in the RHP for this task. + type: string + externalCategorySequence: + type: integer + format: int32 description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - externalTaskType: + Sequence with which the task in specific category to be displayed in + task discovery panel for external users. + tags: + type: array + items: + type: string + description: >- + A set of tags that pertain to a particular task. This can be used to + improve the searchability of tasks with several names ("REST Caller" + vs. "Call REST Endpoint") or to help users find tasks based on + related words. + category: enum: - - EXTERNAL_TASK_TYPE_UNSPECIFIED - - NORMAL_TASK - - ERROR_TASK + - UNSPECIFIED_CATEGORY + - CUSTOM + - FLOW_CONTROL + - DATA_MANIPULATION + - SCRIPTING + - CONNECTOR + - HIDDEN + - CLOUD_SYSTEMS + - CUSTOM_TASK_TEMPLATE + - TASK_RECOMMENDATIONS enumDescriptions: - - Default value. External task type is not specified - - Tasks belongs to the normal task flows - - Task belongs to the error catch task flows - type: string - description: Optional. External task type of the task - errorCatcherId: + - '' + - '' + - '' + - '' + - '' + - '' + - Internal IP tasks that should not be available in the UI. + - Tasks that are relevant to cloud systems teams and typically + - Task entities that derive from a custom task template. + - Category to show task recommendations type: string - description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - task: + externalCategory: + enum: + - UNSPECIFIED_EXTERNAL_CATEGORY + - CORE + - CONNECTORS + - EXTERNAL_HTTP + - EXTERNAL_INTEGRATION_SERVICES + - EXTERNAL_CUSTOMER_ACTIONS + - EXTERNAL_FLOW_CONTROL + - EXTERNAL_WORKSPACE + - EXTERNAL_SECURITY + - EXTERNAL_DATABASES + - EXTERNAL_ANALYTICS + - EXTERNAL_BYOC + - EXTERNAL_BYOT + - EXTERNAL_ARTIFICIAL_INTELIGENCE + - EXTERNAL_DATA_MANIPULATION type: string - description: Optional. The name for the task. - taskExecutionStrategy: enumDescriptions: - - >- - Default. If the strategy is not set explicitly, it will default to - `WHEN_ALL_SUCCEED`. - - >- - Wait until all of its previous tasks finished execution, then - verify at least one of the edge conditions is met, and execute if - possible. This should be considered as WHEN_ALL_TASKS_SUCCEED. - - >- - Start execution as long as any of its previous tasks finished - execution and the corresponding edge condition is met (since we - will execute if only that succeeding edge condition is met). - - >- - Wait until all of its previous tasks finished execution, then - verify the all edge conditions are met and execute if possible. - description: Optional. The policy dictating the execution strategy of this task. - type: string - enum: - - TASK_EXECUTION_STRATEGY_UNSPECIFIED - - WHEN_ALL_SUCCEED - - WHEN_ANY_SUCCEED - - WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED - conditionalFailurePolicies: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - description: >- - Optional. The list of conditional failure policies that will be - applied to the task in order. - type: object - description: >- - The task configuration details. This is not the implementation of Task. - There might be multiple TaskConfigs for the same Task. - EnterpriseCrmEventbusProtoSuspensionAuthPermissions: - type: object - properties: - gaiaIdentity: - description: Represents a Gaia identity for a person or service account. - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - mdbGroup: + - '' + - '' + - '' + - HTTP tasks, e.g. rest api call task + - Integration services, e.g. connector task + - Customer ations, e.g. email task + - Flow control, e.g. while loop task + - Workspace tasks, e.g. list drive task + - Security, e.g. kms related tasks + - Database operation tasks, e.g. read firestore info tasks + - Analytics tasks, e.g. dataflow creattion tasks + - BYOC tasks + - BYOT tasks + - AI related tasks. + - Data manipulation related tasks, e.g. data mapping task + isDeprecated: + type: boolean + description: The deprecation status of the current task. Default value is false; + g3DocLink: + description: URL to the associated G3 Doc for the task if available type: string - loasRole: + codeSearchLink: type: string - googleGroup: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity - id: EnterpriseCrmEventbusProtoSuspensionAuthPermissions - description: LINT.IfChange - EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage: - properties: - parameters: - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParamSpecEntry - type: array - type: object - id: EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage - EnterpriseCrmEventbusProtoNextTask: - description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - type: object - id: EnterpriseCrmEventbusProtoNextTask - properties: - taskConfigId: + description: The Code Search link to the Task Java file. + externalDocLink: type: string - description: ID of the next task. - description: + description: Doc link for external-facing documentation (separate from g3doc). + defaultSpec: type: string description: >- - User-provided description intended to give more business context - about the next task edge or condition. - condition: - description: >- - Standard filter expression for this task to become an eligible next - task. + Contains the initial configuration of the task with default values + set. For now, The string should be compatible to an ASCII-proto + format. + description: type: string - taskNumber: - description: Task number of the next task. + description: In a few sentences, describe the purpose and usage of the task. + system: + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED_SYSTEM + - GENERIC + - BUGANIZER + - SALESFORCE + - CLOUD_SQL + - PLX + - SHEETS + - GOOGLE_GROUPS + - EMAIL + - SPANNER + - DATA_BRIDGE + activeTaskName: type: string - combinedConditions: - type: array - deprecated: true - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCombinedCondition' description: >- - Combined condition for this task to become an eligible next task. - Each of these combined_conditions are joined with logical OR. - DEPRECATED: use `condition` - label: - description: User-provided label that is attached to this edge in the UI. + The new task name to replace the current task if it is deprecated. + Otherwise, it is the same as the current task name. + iconLink: + description: >- + URL to gstatic image icon for this task. This icon shows up on the + task list panel along with the task name in the Workflow Editor + screen. Use the 24p, 2x, gray color icon image format. type: string - GoogleCloudIntegrationsV1alphaListExecutionsResponse: - properties: - nextPageToken: + standaloneExternalDocHtml: + description: >- + External-facing documention for standalone IP in pantheon embedded + in the RHP for this task. Non null only if different from + external_doc_html type: string - description: The token used to retrieve the next page results. - executions: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' - type: array - description: The detailed information of requested executions - executionInfos: - description: Required. The detailed information of requested executions. - deprecated: true - items: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo - type: array - id: GoogleCloudIntegrationsV1alphaListExecutionsResponse - description: Response for listing the integration execution data. - type: object - EnterpriseCrmEventbusProtoLoopMetadata: - id: EnterpriseCrmEventbusProtoLoopMetadata + id: EnterpriseCrmEventbusProtoTaskMetadata + description: >- + TaskMetadata are attributes that are associated to every common Task we + have. type: object + EnterpriseCrmEventbusProtoCondition: properties: - currentIterationCount: - description: Starting from 1, not 0. - format: int64 - type: string - currentIterationDetail: + value: + description: Value that's checked for the key. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + eventPropertyKey: description: >- - Needs to be set by the loop impl class before each iteration. The - abstract loop class will append the request and response to it. Eg. - The foreach Loop will clean up and set it as the current iteration - element at the start of each loop. The post request and response - will be appended to the value once they are available. + Key that's evaluated against the `value`. Please note the data type + of the runtime value associated with the key should match the data + type of `value`, else an IllegalArgumentException is thrown. type: string - failureLocation: + operator: enum: - - UNKNOWN - - SUBWORKFLOW - - PARAM_OVERRIDING - - PARAM_AGGREGATING - - SETTING_ITERATION_ELEMENT - - GETTING_LIST_TO_ITERATE - - CONDITION_EVALUATION - - BUILDING_REQUEST - description: Indicates where in the loop logic did it error out. - enumDescriptions: - - No error or Unknown. - - Subworkflow failed while firing/running. - - Param overrides failed. - - Param aggregation failed. - - Setting for loop current element failed. - - Getting the list to iterate. - - Evaluating the while loop condition. - - Building the iteration request - type: string - errorMsg: + - UNSET + - EQUALS + - CONTAINS + - LESS_THAN + - GREATER_THAN + - EXISTS + - DOES_NOT_EXIST + - IS_EMPTY + - IS_NOT_EMPTY + description: >- + Operator used to evaluate the condition. Please note that an + operator with an inappropriate key/value operand will result in + IllegalArgumentException, e.g. CONTAINS with boolean key/value pair. type: string - description: Add the error message when loops fail. - GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: - properties: {} - description: Response for PublishIntegrationVersion. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + id: EnterpriseCrmEventbusProtoCondition + deprecated: true type: object - id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse - GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: - description: Response for downloading an execution. + description: Condition that uses `operator` to evaluate the key against the value. + EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity: + id: EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity type: object - id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse properties: - content: + gaiaId: + format: int64 type: string - description: The content of downloaded execution. - GoogleCloudIntegrationsV1alphaListSuspensionsResponse: - description: Response for Suspensions.ListSuspensions. - id: GoogleCloudIntegrationsV1alphaListSuspensionsResponse - properties: - suspensions: - type: array - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - description: >- - The suspensions for the relevant execution which the caller has - permissions to view and resolve. - nextPageToken: - description: Token to retrieve the next page of results. + emailAddress: type: string + EnterpriseCrmEventbusProtoField: type: object - EnterpriseCrmEventbusProtoBaseValue: - type: object - id: EnterpriseCrmEventbusProtoBaseValue + description: Information about the value and type of the field. + id: EnterpriseCrmEventbusProtoField properties: - referenceValue: - description: Start with a reference value to dereference. - type: string - baseFunction: + protoDefPath: description: >- - Start with a function that does not build on existing values. Eg. - CurrentTime, Min, Max, Exists, etc. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' - literalValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Start with a literal value. - GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse: - id: GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse - properties: - triggerUrl: - description: The trigger url that will be returned - type: string - type: object - description: Response for Creating Cloud Function rpc call. - GoogleCloudIntegrationsV1alphaNextTask: - properties: - taskConfigId: - type: string - description: ID of the next task. - taskId: + Optional. The fully qualified proto name (e.g. + enterprise.crm.storage.Account). Required for output field of type + PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES + and output field_type is PROTO_VALUE, then fully qualified proto + type url should be provided to parse the input bytes. If field_type + is *_ARRAY, then all the converted protos are of the same type. type: string - description: Task number of the next task. - displayName: - description: User-provided label that is attached to this edge in the UI. + referenceKey: type: string - condition: + description: >- + This holds the reference key of the workflow or task parameter. 1. + Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input + or output parameter, for e.g. $task1_param1$. 3. Any workflow or + task parameters with subfield references, for e.g., + $task1_param1.employee.id$ + defaultValue: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' + description: >- + This holds the default values for the fields. This value is supplied + by user so may or may not contain PII or SPII data. + cardinality: type: string + enum: + - UNSPECIFIED + - OPTIONAL description: >- - Standard filter expression for this task to become an eligible next - task. - description: + By default, if the cardinality is unspecified the field is + considered required while mapping. + enumDescriptions: + - For fields with unspecified cardinality. + - >- + If field cardinality is set to optional, ignore errors if input + field value is null or the reference_key is not found. + fieldType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' type: string + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + description: Specifies the data type of the field. + transformExpression: description: >- - User-provided description intended to give additional business - context about the task. + This is the transform expression to fetch the input field value. for + e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can + have a transform expression. 2. If a transform expression is + provided, reference_key will be ignored. 3. If no value is returned + after evaluation of transform expression, default_value can be + mapped if provided. 4. The field_type should be the type of the + final object returned after the transform expression is evaluated. + Scrubs the transform expression before logging as value provided by + user so may or may not contain PII or SPII data. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' + EnterpriseCrmEventbusProtoCombinedCondition: description: >- - The task that is next in line to be executed, if the condition specified - evaluated to true. - id: GoogleCloudIntegrationsV1alphaNextTask + This message recursively combines constituent conditions using logical + AND. + id: EnterpriseCrmEventbusProtoCombinedCondition + deprecated: true + properties: + conditions: + description: A set of individual constituent conditions. + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCondition' type: object - GoogleCloudConnectorsV1EventingRuntimeData: + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer: description: >- - Eventing runtime data has the details related to eventing managed by the - system. + Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 + Authorization Grant based authentication. See + https://tools.ietf.org/html/rfc7523 for more details. properties: - status: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' - description: Output only. Current status of eventing. - eventsListenerPscSa: - type: string + clientKey: description: >- - Output only. Events listener PSC Service attachment. The value will - be populated after provisioning the events listener with private - connectivity enabled. - readOnly: true - webhookData: + Secret version reference containing a PKCS#8 PEM-encoded private key + associated with the Client Certificate. This private key will be + used to sign JWTs used for the jwt-bearer authorization grant. + Specified in the form as: `projects/*/secrets/*/versions/*`. + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + jwtClaims: + description: JwtClaims providers fields to generate the token. $ref: >- - #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData - description: Output only. Webhook data. - readOnly: true - eventsListenerEndpoint: - type: string - description: >- - Output only. Events listener endpoint. The value will populated - after provisioning the events listener. - readOnly: true - id: GoogleCloudConnectorsV1EventingRuntimeData - type: object - GoogleCloudIntegrationsV1alphaCloudLoggingDetails: + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims type: object - id: GoogleCloudIntegrationsV1alphaCloudLoggingDetails + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + EnterpriseCrmEventbusProtoMappedField: properties: - enableCloudLogging: - type: boolean - description: >- - Optional. Status of whether Cloud Logging is enabled or not for the - integration version getting executed. - cloudLoggingSeverity: - type: string - description: >- - Optional. Severity selected by the customer for the logs to be sent - to Cloud Logging, for the integration version getting executed. - enumDescriptions: - - Unspecified - - >- - If Severity selected is `INFO`, then all the Integration Execution - States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, - `ERROR`, `CANCELLED`) will be sent to Cloud Logging. - - >- - If Severity selected is `ERROR`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. - - >- - If Severity selected is `WARNING`, then only the following - Integration Execution States (`ERROR`, `CANCELLED`) will be sent - to Cloud Logging. - enum: - - CLOUD_LOGGING_SEVERITY_UNSPECIFIED - - INFO - - ERROR - - WARNING - description: Cloud Logging details for execution info - GoogleCloudIntegrationsV1alphaConditionalFailurePolicies: - id: GoogleCloudIntegrationsV1alphaConditionalFailurePolicies - description: Conditional task failur retry strategies + inputField: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' + description: The input field being mapped from. + outputField: + description: The output field being mapped to. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoField' + description: Mapped field is a pair of input field and output field. + id: EnterpriseCrmEventbusProtoMappedField type: object + EnterpriseCrmEventbusProtoIntParameterArray: properties: - defaultFailurePolicy: - description: >- - The default failure policy to be applied if no conditional failure - policy matches. - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - failurePolicies: - type: array - description: >- - The list of failure policies that will be applied to the task in - order. + intValues: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaFailurePolicy' - EnterpriseCrmEventbusProtoFunction: - properties: - parameters: - description: List of parameters required for the transformation. + format: int64 + type: string type: array - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoTransformExpression' - functionType: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunctionType' - description: The name of the function to perform. type: object - id: EnterpriseCrmEventbusProtoFunction - GoogleCloudIntegrationsV1alphaOidcToken: - id: GoogleCloudIntegrationsV1alphaOidcToken + id: EnterpriseCrmEventbusProtoIntParameterArray + GoogleCloudIntegrationsV1alphaAuthToken: type: object - description: OIDC Token + id: GoogleCloudIntegrationsV1alphaAuthToken properties: token: - description: ID token obtained for the service account - type: string - tokenExpireTime: type: string - description: The approximate time until the token retrieved is valid. - format: google-datetime - audience: + description: The token for the auth type. + type: type: string - description: >- - Audience to be used when generating OIDC token. The audience claim - identifies the recipients that the JWT is intended for. - serviceAccountEmail: - description: The service account email to be used as the identity for the token. - type: string - GoogleCloudConnectorsV1ConnectionStatus: - type: object - properties: - status: - description: Status provides detailed information for the state. - type: string - description: - type: string - description: Description. - state: - enum: - - STATE_UNSPECIFIED - - CREATING - - ACTIVE - - INACTIVE - - DELETING - - UPDATING - - ERROR - - AUTHORIZATION_REQUIRED - type: string - description: State. - enumDescriptions: - - Connection does not have a state yet. - - Connection is being created. - - Connection is running and ready for requests. - - Connection is stopped. - - Connection is being deleted. - - Connection is being updated. - - Connection is not running due to an error. - - >- - Connection is not running because the authorization configuration - is not complete. - description: ConnectionStatus indicates the state of the connection. - id: GoogleCloudConnectorsV1ConnectionStatus - EnterpriseCrmEventbusProtoFieldMappingConfig: - id: EnterpriseCrmEventbusProtoFieldMappingConfig + description: Authentication type, e.g. "Basic", "Bearer", etc. description: >- - Field Mapping Config to map multiple output fields values from input - fields values. - properties: - mappedFields: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' - type: array - type: object - EnterpriseCrmEventbusProtoErrorDetail: - description: An error, warning, or information message associated with a workflow. - id: EnterpriseCrmEventbusProtoErrorDetail + The credentials to authenticate a user agent with a server that is put + in HTTP Authorization request header. + GoogleCloudIntegrationsV1alphaFile: + id: GoogleCloudIntegrationsV1alphaFile properties: - severity: - type: string - description: 'The severity of the error: ERROR|WARN|INFO.' + type: enum: - - SEVERITY_UNSPECIFIED - - ERROR - - WARN - - INFO - enumDescriptions: - - '' - - '' - - '' - - '' - taskNumber: - type: integer - format: int32 - description: >- - The task try-number, in which, the error occurred. If zero, the - error happened at the event level. - errorMessage: + - INTEGRATION_FILE_UNSPECIFIED + - INTEGRATION + - INTEGRATION_CONFIG_VARIABLES description: >- - The full text of the error message, including any parameters that - were thrown along with the exception. + File information like Integration version, Integration Config + variables etc. + enumDescriptions: + - Default value. + - Integration file. + - Integration Config variables. type: string - errorCode: - $ref: '#/components/schemas/CrmlogErrorCode' - description: The associated error-code, which can be a common or internal code. - type: object - EnterpriseCrmEventbusProtoCoordinate: - type: object - description: Represents two-dimensional positions. - properties: - 'y': - format: int32 - type: integer - x: - format: int32 - type: integer - id: EnterpriseCrmEventbusProtoCoordinate - EnterpriseCrmEventbusProtoTriggerCriteria: + integrationVersion: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + description: Integration version + integrationConfig: + additionalProperties: + description: Properties of the object. + type: any + type: object + description: Integration version config file type: object + description: >- + To store Integration version related file i.e. Integration Version, + Config variable etc. + EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition: + id: EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition properties: - condition: + path: + description: Path to the proto file that contains the message type's definition. type: string + fullName: description: >- - Required. Standard filter expression, when true the workflow will be - executed. If there's no - trigger_criteria_task_implementation_class_name specified, the - condition will be validated directly. - parameters: - description: Optional. To be used in TaskConfig for the implementation class. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - triggerCriteriaTaskImplementationClassName: - description: >- - Optional. Implementation class name. The class should implement the - “TypedTask” interface. + The fully-qualified proto name. This message, for example, would be + "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition". type: string - id: EnterpriseCrmEventbusProtoTriggerCriteria - GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: - id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest - description: Request for [Suspensions.ResolveSuspensions]. - properties: - suspension: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' - description: >- - Suspension, containing the event_execution_info_id, task_id, and - state to set on the corresponding suspension record. - type: object - EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: type: object - description: Rule used to validate strings. - properties: - regex: - description: The regex applied to the input value(s). - type: string - exclusive: - description: >- - Whether the regex matcher is applied exclusively (if true, matching - values will be rejected). - type: boolean - id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue: properties: - absolute: - format: int64 - type: string percentage: format: int32 type: integer + absolute: + format: int64 + type: string type: object description: >- The threshold value of the metric, above or below which the alert should @@ -7429,2629 +7052,3315 @@ components: threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. id: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue - EnterpriseCrmEventbusProtoEventExecutionSnapshot: + GoogleCloudIntegrationsV1alphaResolveSuspensionRequest: type: object properties: - conditionResults: - description: All of the computed conditions that been calculated. - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoConditionResult' - type: array - taskName: - deprecated: true - description: The task name associated with this snapshot. Could be empty. + suspension: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSuspension' + description: >- + Suspension, containing the event_execution_info_id, task_id, and + state to set on the corresponding suspension record. + description: Request for [Suspensions.ResolveSuspensions]. + id: GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + GoogleCloudIntegrationsV1alphaAttemptStats: + description: Status for the execution attempt. + id: GoogleCloudIntegrationsV1alphaAttemptStats + properties: + endTime: + format: google-datetime type: string - workflowName: - description: Name of the workflow this event execution snapshot belongs to. + description: The end time of the integration execution for current attempt. + startTime: + format: google-datetime type: string - clientId: + description: >- + The start time of the integration execution for current attempt. + This could be in the future if it's been scheduled. + type: object + GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: + properties: + runAsServiceAccount: type: string - description: Client that the execution snapshot is associated to. - eventParams: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters in Event object. - diffParams: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' - description: The parameters in Event object that differs from last snapshot. - taskExecutionDetails: - description: All of the task execution details at the given point of time. - type: array + description: 'Required. REQUIRED: Run-as service account to be updated' + id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + type: object + description: Request for the ReplaceServiceAccount rpc + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + properties: + exclusive: + type: boolean + description: >- + Whether the regex matcher is applied exclusively (if true, matching + values will be rejected). + regex: + type: string + description: The regex applied to the input value(s). + type: object + description: Rule used to validate strings. + GoogleCloudIntegrationsV1alphaTemplateBundle: + id: GoogleCloudIntegrationsV1alphaTemplateBundle + type: object + description: Define the bundle of the template. + properties: + subIntegrationVersionTemplates: items: $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetails - eventExecutionSnapshotId: - type: string + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + type: array description: >- - Auto-generated. Used as primary key for EventExecutionSnapshots - table. - checkpointTaskNumber: + Optional. Sub integration templates which would be added along with + main integration. + integrationVersionTemplate: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate + description: Required. Main integration templates of the template bundle. + GoogleCloudIntegrationsV1alphaOidcToken: + type: object + id: GoogleCloudIntegrationsV1alphaOidcToken + description: OIDC Token + properties: + tokenExpireTime: + format: google-datetime type: string + description: The approximate time until the token retrieved is valid. + audience: description: >- - Indicates "right after which checkpoint task's execution" this - snapshot is taken. - eventExecutionInfoId: + Audience to be used when generating OIDC token. The audience claim + identifies the recipients that the JWT is intended for. type: string - description: Points to the event execution info this snapshot belongs to. - eventExecutionSnapshotMetadata: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata - snapshotTime: - format: int64 - type: string - description: Indicates when this snapshot is taken. - exceedMaxSize: - description: indicate whether snapshot exceeded maximum size before clean up - type: boolean - id: EnterpriseCrmEventbusProtoEventExecutionSnapshot - description: >- - Contains the snapshot of the event execution for a given checkpoint. - Next available id: 15 - GoogleCloudIntegrationsV1alphaSerializedFile: - description: To store string representation of Integration file. - properties: - file: - description: >- - File information like Integration version, Integration Config - variables etc. + serviceAccountEmail: + description: The service account email to be used as the identity for the token. type: string - enumDescriptions: - - Default value. - - Integration file. - - Integration Config variables. - enum: - - INTEGRATION_FILE_UNSPECIFIED - - INTEGRATION - - INTEGRATION_CONFIG_VARIABLES - content: + token: type: string - description: String representation of the file content. - type: object - id: GoogleCloudIntegrationsV1alphaSerializedFile - GoogleCloudConnectorsV1ConnectorVersionInfraConfig: - type: object - id: GoogleCloudConnectorsV1ConnectorVersionInfraConfig - description: >- - This cofiguration provides infra configs like rate limit threshold which - need to be configurable for every connector version + description: ID token obtained for the service account + EnterpriseCrmEventbusProtoTaskExecutionDetails: + id: EnterpriseCrmEventbusProtoTaskExecutionDetails properties: - hpaConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1HPAConfig' - description: Output only. HPA autoscaling config. - readOnly: true - connectionRatelimitWindowSeconds: - readOnly: true - description: >- - Output only. The window used for ratelimiting runtime requests to - connections. - type: string - format: int64 - resourceLimits: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceLimits' - description: Output only. System resource limits. - deploymentModel: - description: Optional. Indicates whether connector is deployed on GKE/CloudRun - type: string + taskExecutionState: enum: - - DEPLOYMENT_MODEL_UNSPECIFIED - - GKE_MST - - CLOUD_RUN_MST + - UNSPECIFIED + - PENDING_EXECUTION + - IN_PROCESS + - SUCCEED + - FAILED + - FATAL + - RETRY_ON_HOLD + - SKIPPED + - CANCELED + - PENDING_ROLLBACK + - ROLLBACK_IN_PROCESS + - ROLLEDBACK + - SUSPENDED enumDescriptions: - - Deployment model is not specified. - - Default model gke mst. - - Cloud run mst. - sharedDeployment: - readOnly: true - type: string - description: Output only. The name of shared connector deployment. - internalclientRatelimitThreshold: + - '' + - >- + Task is waiting for its precondition tasks to finish to start the + execution. + - Task is under processing. + - >- + Task execution successfully finished. There's no more change after + this state. + - Task execution failed. There's no more change after this state. + - >- + Task execution failed and cause the whole event execution to fail + immediately. There's no more change after this state. + - Task execution failed and waiting for retry. + - >- + Task execution skipped. This happens when its precondition wasn't + met, or the event execution been canceled before reach to the + task. There's no more changes after this state. + - >- + Task execution canceled when in progress. This happens when event + execution been canceled or any other task fall in fatal state. + - >- + Task is waiting for its dependency tasks' rollback to finish to + start its rollback. + - Task is rolling back. + - >- + Task is rolled back. This is the state we will set regardless of + rollback succeeding or failing. + - >- + Task is a SuspensionTask which has executed once, creating a + pending suspension. type: string - format: int64 - readOnly: true - description: >- - Output only. Max QPS supported for internal requests originating - from Connd. - ratelimitThreshold: - format: int64 + taskAttemptStats: + type: array + items: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats + taskNumber: type: string - readOnly: true - description: >- - Output only. Max QPS supported by the connector version before - throttling of requests. - resourceRequests: - description: Output only. System resource requests. - $ref: '#/components/schemas/GoogleCloudConnectorsV1ResourceRequests' - readOnly: true - GoogleCloudConnectorsV1Destination: + description: Pointer to the task config it used for execution. + type: object + description: >- + Contains the details of the execution of this task. Next available id: + 11 + GoogleCloudIntegrationsV1alphaBooleanParameterArray: + description: This message only contains a field of boolean array. type: object + id: GoogleCloudIntegrationsV1alphaBooleanParameterArray properties: - serviceAttachment: - type: string - deprecated: true - description: >- - PSC service attachments. Format: - projects/*/regions/*/serviceAttachments/* - host: - description: For publicly routable host. - type: string - port: - description: >- - The port is the target port number that is accepted by the - destination. - type: integer - format: int32 - id: GoogleCloudConnectorsV1Destination - EnterpriseCrmEventbusProtoToken: - id: EnterpriseCrmEventbusProtoToken + booleanValues: + description: Boolean array. + items: + type: boolean + type: array + EnterpriseCrmEventbusProtoSuccessPolicy: + description: >- + Policy that dictates the behavior for the task after it completes + successfully. type: object properties: - name: - type: string - value: + finalState: + enumDescriptions: + - '' + - >- + The default behavior, where successful tasks will be marked as + SUCCEEDED. + - >- + Sets the state to SUSPENDED after executing. This is required for + SuspensionTask; event execution will continue once the user calls + ResolveSuspensions with the event_execution_info_id and the task + number. type: string - GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest: - id: GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + enum: + - UNSPECIFIED + - SUCCEEDED + - SUSPENDED + description: >- + State to which the execution snapshot status will be set if the task + succeeds. + id: EnterpriseCrmEventbusProtoSuccessPolicy + EnterpriseCrmEventbusProtoEventParameters: properties: - runAsServiceAccount: - type: string - description: 'Required. REQUIRED: Run-as service account to be updated' + parameters: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterEntry' + description: >- + Parameters are a part of Event and can be used to communicate + between different tasks that are part of the same integration + execution. + description: >- + LINT.IfChange This message is used for processing and persisting (when + applicable) key value pair parameters for each event in the event bus. + Please see type: object - description: Request for the ReplaceServiceAccount rpc - GoogleCloudIntegrationsV1alphaTriggerConfig: + id: EnterpriseCrmEventbusProtoEventParameters + GoogleCloudConnectorsV1AuthConfig: type: object - description: Configuration detail of a trigger. - id: GoogleCloudIntegrationsV1alphaTriggerConfig + description: AuthConfig defines details of a authentication type. + id: GoogleCloudConnectorsV1AuthConfig properties: - alertConfig: + authKey: + type: string + description: Identifier key for auth config + sshPublicKey: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' + description: SSH Public Key. + additionalVariables: + description: List containing additional auth configs. type: array - description: >- - Optional. An alert threshold configuration for the [trigger + client - + integration] tuple. If these values are not specified in the - trigger config, default values will be populated by the system. Note - that there must be exactly one alert threshold configured per - [client + trigger + integration] when published. items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationAlertConfig - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' - description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - triggerType: - type: string - description: Optional. Type of trigger - enum: - - TRIGGER_TYPE_UNSPECIFIED - - CRON - - API - - SFDC_CHANNEL - - CLOUD_PUBSUB_EXTERNAL - - SFDC_CDC_CHANNEL - - CLOUD_SCHEDULER - - INTEGRATION_CONNECTOR_TRIGGER - - PRIVATE_TRIGGER + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + userPassword: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' + description: UserPassword. + oauth2ClientCredentials: + description: Oauth2ClientCredentials. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials + authType: enumDescriptions: - - Unknown. - - Trigger by scheduled time. - - Trigger by API call. - - Trigger by Salesforce Channel. - - Trigger by Pub/Sub external. - - SFDC Channel Trigger for CDC. - - Trigger by Cloud Scheduler job. - - Trigger by Connector Event - - Trigger for private workflow - triggerId: - description: Optional. The backend trigger ID. + - Authentication type not specified. + - Username and Password Authentication. + - >- + JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant + based authentication + - Oauth 2.0 Client Credentials Grant Authentication + - SSH Public Key Authentication + - Oauth 2.0 Authorization Code Flow + - Google authentication + - >- + Oauth 2.0 Authorization Code Flow with Google Provided OAuth + Client + description: The type of authentication configured. + enum: + - AUTH_TYPE_UNSPECIFIED + - USER_PASSWORD + - OAUTH2_JWT_BEARER + - OAUTH2_CLIENT_CREDENTIALS + - SSH_PUBLIC_KEY + - OAUTH2_AUTH_CODE_FLOW + - GOOGLE_AUTHENTICATION + - OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED type: string - trigger: + oauth2JwtBearer: + description: Oauth2JwtBearer. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer + oauth2AuthCodeFlow: + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow + description: Oauth2AuthCodeFlow. + oauth2AuthCodeFlowGoogleManaged: + description: Oauth2AuthCodeFlowGoogleManaged. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged + GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse: + description: Response for DownloadIntegrationVersion. + type: object + properties: + files: + description: List containing String represendation for multiple file with type. + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSerializedFile' + content: + description: String representation of the requested file. type: string - description: >- - Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub - Sub Trigger" When set will be sent out to monitoring dashabord for - tracking purpose. - description: - description: >- - Optional. User-provided description intended to give additional - business context about the task. + id: GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest: + properties: + scriptId: type: string - errorCatcherId: + description: The id of the Apps Script project to be linked. + type: object + description: Request for LinkAppsScriptProject rpc call. + id: GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + EnterpriseCrmEventbusProtoLogSettings: + description: >- + The LogSettings define the logging attributes for an event property. + These attributes are used to map the property to the parameter in the + log proto. Also used to define scrubbing/truncation behavior and PII + information. + type: object + id: EnterpriseCrmEventbusProtoLogSettings + properties: + seedScope: type: string + enum: + - SEED_SCOPE_UNSPECIFIED + - EVENT_NAME + - TIME_PERIOD + - PARAM_NAME + enumDescriptions: + - '' + - Hash computations include the event name. + - Hash computations include a time period. + - Hash computations include the param name. + logFieldName: description: >- - Optional. Optional Error catcher id of the error catch flow which - will be executed when execution error happens in the task - properties: - additionalProperties: - type: string - type: object - description: >- - Optional. Configurable properties of the trigger, not to be confused - with integration parameters. E.g. "name" is a property for API - triggers and "subscription" is a property for Pub/sub triggers. - label: - description: Optional. The user created label for a particular trigger. + The name of corresponding logging field of the event property. If + omitted, assumes the same name as the event property key. type: string - nextTasksExecutionPolicy: - enum: - - NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED - - RUN_ALL_MATCH - - RUN_FIRST_MATCH - description: Optional. Dictates how next tasks will be executed. + seedPeriod: enumDescriptions: - - Default. - - Execute all the tasks that satisfy their associated condition. - - Execute the first task that satisfies the associated condition. + - '' + - Sanitized values remain constant for the day of the event. + - >- + Sanitized values remain constant for the week of the event; may + cross month boundaries. + - Sanitized values remain constant for the month of the event. + enum: + - SEED_PERIOD_UNSPECIFIED + - DAY + - WEEK + - MONTH type: string - triggerNumber: + GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig: + description: Configurations for approving the Suspension. + properties: + expiration: description: >- - Required. A number to uniquely identify each trigger config within - the integration on UI. + Indicates the next steps when no external actions happen on the + suspension. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + customMessage: type: string - startTasks: + description: Information to provide for recipients. + emailAddresses: items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' - description: >- - Optional. Set of tasks numbers from where the integration execution - is started by this trigger. If this is empty, then integration is - executed with default start tasks. In the list of start tasks, none - of two tasks can have direct ancestor-descendant relationships (i.e. - in a same integration execution graph). + type: string + description: Email addresses to send approval request to. type: array - cloudSchedulerConfig: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCloudSchedulerConfig - description: Optional. Cloud Scheduler Trigger related metadata - EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray: type: object - id: EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig + EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange: + description: Range used to validate longs and ints. properties: - doubleValues: - type: array - items: - format: double - type: number - GoogleCloudConnectorsV1ConfigVariable: + min: + type: string + format: int64 + description: The inclusive minimum of the acceptable range. + max: + type: string + format: int64 + description: The inclusive maximum of the acceptable range. type: object - id: GoogleCloudConnectorsV1ConfigVariable + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + EnterpriseCrmEventbusProtoTaskMetadataAdmin: + id: EnterpriseCrmEventbusProtoTaskMetadataAdmin description: >- - ConfigVariable represents a configuration variable present in a - Connection. or AuthConfig. + Admins are owners of a Task, and have all permissions on a particular + task identified by the task name. By default, Eventbus periodically + scans all task metadata and syncs (adds) any new admins defined here to + Zanzibar. + type: object properties: - intValue: + userEmail: type: string - description: Value is an integer - format: int64 - encryptionKeyValue: - description: Value is a Encryption Key. - $ref: '#/components/schemas/GoogleCloudConnectorsV1EncryptionKey' - stringValue: + googleGroupEmail: type: string - description: Value is a string. - key: - description: Key of the config variable. + GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: + description: Dead Letter configuration details provided by the user. + type: object + id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig + properties: + topic: type: string - boolValue: - type: boolean - description: Value is a bool. - secretValue: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Value is a secret. - GoogleCloudIntegrationsV1alphaParameterMap: - id: GoogleCloudIntegrationsV1alphaParameterMap + description: Optional. Topic to push events which couldn't be processed. + projectId: + description: Optional. Project which has the topic given. + type: string + EnterpriseCrmEventbusProtoAttributes: description: >- - A generic multi-map that holds key value pairs. They keys and values can - be of any type, unless specified. + Attributes are additional options that can be associated with each event + property. For more information, see + id: EnterpriseCrmEventbusProtoAttributes properties: - entries: - items: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapEntry - type: array - description: A list of parameter map entries. - valueType: - enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - type: string + isRequired: + type: boolean description: >- - Option to specify value type for all entries of the map. If provided - then field types for all entries must conform to this. - enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED - - STRING_VALUE - - INT_VALUE - - DOUBLE_VALUE - - BOOLEAN_VALUE - - STRING_ARRAY - - INT_ARRAY - - DOUBLE_ARRAY - - BOOLEAN_ARRAY - - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY - keyType: + Required for event execution. The validation will be done by the + event bus when the event is triggered. + taskVisibility: + type: array + items: + type: string + description: List of tasks that can view this property, if empty then all. + isSearchable: + type: boolean + deprecated: true + description: >- + Used to indicate if a ParameterEntry should be converted to + ParamIndexes for ST-Spanner full-text search. DEPRECATED: use + searchable. + masked: + description: True if this workflow parameter should be masked in the logs + type: boolean + readOnly: + type: boolean + description: Used to indicate if the ParameterEntry is a read only field or not. + logSettings: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoLogSettings' + description: See + dataType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - >- + Domain is a web url string with one top-level private domain and a + suffix (for example: google.com, walmart.com) + type: string enum: - - INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED + - DATA_TYPE_UNSPECIFIED + - EMAIL + - URL + - CURRENCY + - TIMESTAMP + - DOMAIN_NAME + description: >- + Things like URL, Email, Currency, Timestamp (rather than string, + int64...) + defaultValue: + description: Used to define defaults. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' + searchable: + type: string + enumDescriptions: + - '' + - >- + If yes, the parameter key and value will be full-text indexed. In + a proto, this value will propagate to all children whose + searchable is unspecified. + - >- + If no, the parameter key and value will not be full-text indexed. + In a proto, this value will propagate to all children whose + searchable is unspecified. + enum: + - UNSPECIFIED + - 'YES' + - 'NO' + type: object + EnterpriseCrmFrontendsEventbusProtoParamSpecEntry: + description: 'Key-value pair of EventBus task parameters. Next id: 13' + properties: + key: + type: string + description: >- + Key is used to retrieve the corresponding parameter value. This + should be unique for a given task. These parameters must be + predefined in the workflow definition. + dataType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + enum: + - DATA_TYPE_UNSPECIFIED - STRING_VALUE - INT_VALUE - DOUBLE_VALUE - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE - STRING_ARRAY - INT_ARRAY - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT - JSON_VALUE - - PROTO_VALUE - - PROTO_ARRAY + description: The data type of the parameter. type: string + config: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryConfig' + description: Optional fields, such as help text and other useful info. + collectionElementClassName: description: >- - Option to specify key type for all entries of the map. If provided - then field types for all entries must conform to this. - enumDescriptions: - - Unspecified. - - String. - - Integer. - - Double Number. - - Boolean. - - String Array. - - Integer Array. - - Double Number Array. - - Boolean Array. - - Json. - - Proto Value (Internal use only). - - Proto Array (Internal use only). - type: object - EnterpriseCrmEventbusProtoTaskExecutionDetails: - properties: - taskExecutionState: - enumDescriptions: - - '' - - >- - Task is waiting for its precondition tasks to finish to start the - execution. - - Task is under processing. - - >- - Task execution successfully finished. There's no more change after - this state. - - Task execution failed. There's no more change after this state. - - >- - Task execution failed and cause the whole event execution to fail - immediately. There's no more change after this state. - - Task execution failed and waiting for retry. - - >- - Task execution skipped. This happens when its precondition wasn't - met, or the event execution been canceled before reach to the - task. There's no more changes after this state. - - >- - Task execution canceled when in progress. This happens when event - execution been canceled or any other task fall in fatal state. - - >- - Task is waiting for its dependency tasks' rollback to finish to - start its rollback. - - Task is rolling back. - - >- - Task is rolled back. This is the state we will set regardless of - rollback succeeding or failing. - - >- - Task is a SuspensionTask which has executed once, creating a - pending suspension. - enum: - - UNSPECIFIED - - PENDING_EXECUTION - - IN_PROCESS - - SUCCEED - - FAILED - - FATAL - - RETRY_ON_HOLD - - SKIPPED - - CANCELED - - PENDING_ROLLBACK - - ROLLBACK_IN_PROCESS - - ROLLEDBACK - - SUSPENDED - type: string - taskNumber: - description: Pointer to the task config it used for execution. - type: string - taskAttemptStats: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats - type: array - id: EnterpriseCrmEventbusProtoTaskExecutionDetails - type: object - description: >- - Contains the details of the execution of this task. Next available id: - 11 - GoogleCloudIntegrationsV1alphaRuntimeEntitySchema: - type: object - properties: - arrayFieldSchema: + If it is a collection of objects, this would be the FCQN of every + individual element in the collection. If this is "java.lang.Object", + the parameter is a collection of any type. type: string - description: The above schema, but for an array of the associated entity. - fieldSchema: - description: List of fields in the entity. + protoDef: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition + description: Populated if this represents a proto or proto array. + defaultValue: + description: >- + Default values for the defined keys. Each value can either be + string, int, double or any proto message or a serialized object. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + isDeprecated: + type: boolean + description: >- + If set, this entry is deprecated, so further use of this parameter + should be prohibited. + validationRule: + description: >- + Rule used to validate inputs (individual values and collection + elements) for this parameter. + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRule + isOutput: + type: boolean + jsonSchema: + description: If the data_type is JSON_VALUE, then this will define its schema. type: string - entity: + required: + description: If set, the user must provide an input value for this parameter. + type: boolean + className: type: string - description: Name of the entity. - description: Metadata of an entity, including a schema for its properties. - id: GoogleCloudIntegrationsV1alphaRuntimeEntitySchema - EnterpriseCrmEventbusProtoPropertyEntry: - description: Key-value pair of EventBus property. + description: >- + The FQCN of the Java object this represents. A string, for example, + would be "java.lang.String". If this is "java.lang.Object", the + parameter can be of any type. + id: EnterpriseCrmFrontendsEventbusProtoParamSpecEntry type: object + GoogleCloudConnectorsV1LogConfig: properties: - key: - type: string + enabled: description: >- - Key is used to retrieve the corresponding property value. This - should be unique for a given fired event. The Tasks should be aware - of the keys used while firing the events for them to be able to - retrieve the values. - value: - description: >- - Values for the defined keys. Each value can either be string, int, - double or any proto message. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoValueType' - id: EnterpriseCrmEventbusProtoPropertyEntry - GoogleCloudConnectorsV1AuthConfigUserPassword: - id: GoogleCloudConnectorsV1AuthConfigUserPassword - description: Parameters to support Username and Password Authentication. - properties: - username: + Enabled represents whether logging is enabled or not for a + connection. + type: boolean + level: type: string - description: Username. - password: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret version reference containing the password. - type: object - GoogleCloudIntegrationsV1alphaErrorCatcherConfig: - id: GoogleCloudIntegrationsV1alphaErrorCatcherConfig + description: Optional. Log configuration level. + enumDescriptions: + - Log level unspecified. + - Only error logs are enabled. + - Info and error logs are enabled. + - Debug and high verbosity logs are enabled. + enum: + - LOG_LEVEL_UNSPECIFIED + - ERROR + - INFO + - DEBUG + description: Log configuration for the connection. + id: GoogleCloudConnectorsV1LogConfig type: object - description: Configuration detail of a error catch task + GoogleCloudIntegrationsV1alphaAuthConfig: + description: The AuthConfig resource use to hold channels and connection config data. + id: GoogleCloudIntegrationsV1alphaAuthConfig properties: - errorCatcherNumber: + reason: + type: string + description: The reason / details of the current status. + visibility: + enum: + - AUTH_CONFIG_VISIBILITY_UNSPECIFIED + - PRIVATE + - CLIENT_VISIBLE + enumDescriptions: + - Visibility not specified. + - Profile visible to the creator only. + - Profile visible within the client. + description: The visibility of the auth config. + type: string + displayName: + description: Required. The name of the auth config. + type: string + encryptedCredential: type: string + format: byte description: >- - Required. A number to uniquely identify each error catcher config - within the workflow on UI. + Auth credential encrypted by Cloud KMS. Can be decrypted as + Credential with proper KMS key. + name: + type: string + description: >- + Resource name of the auth config. For more information, see Manage + authentication profiles. + projects/{project}/locations/{location}/authConfigs/{authConfig}. description: type: string + description: A description of the auth config. + creatorEmail: description: >- - Optional. User-provided description intended to give more business - context about the error catcher config. - startErrorTasks: - items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaNextTask' + The creator's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. + type: string + credentialType: + enumDescriptions: + - Unspecified credential type + - Regular username/password pair. + - API key. + - OAuth 2.0 Authorization Code Grant Type. + - OAuth 2.0 Implicit Grant Type. + - OAuth 2.0 Client Credentials Grant Type. + - OAuth 2.0 Resource Owner Credentials Grant Type. + - JWT Token. + - Auth Token, e.g. bearer token. + - >- + Service Account which can be used to generate token for + authentication. + - Client Certificate only. + - Google OIDC ID Token + description: Credential type of the encrypted credential. + type: string + enum: + - CREDENTIAL_TYPE_UNSPECIFIED + - USERNAME_AND_PASSWORD + - API_KEY + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT + - OAUTH2_CLIENT_CREDENTIALS + - OAUTH2_RESOURCE_OWNER_CREDENTIALS + - JWT + - AUTH_TOKEN + - SERVICE_ACCOUNT + - CLIENT_CERTIFICATE_ONLY + - OIDC_TOKEN + validTime: description: >- - Required. The set of start tasks that are to be executed for the - error catch flow - type: array - label: + The time until the auth config is valid. Empty or max value is + considered the auth config won't expire. + format: google-datetime + type: string + state: + type: string + enum: + - STATE_UNSPECIFIED + - VALID + - INVALID + - SOFT_DELETED + - EXPIRED + - UNAUTHORIZED + - UNSUPPORTED + description: The status of the auth config. + enumDescriptions: + - Status not specified. + - Valid Auth config. + - >- + General invalidity, if it doesn't fits in the detailed issue + below. + - Auth config soft deleted. + - Auth config expired. + - Auth config unauthorized. + - Auth config not supported. + lastModifierEmail: type: string description: >- - Optional. The user created label for a particular error catcher. - Optional. - position: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCoordinate' + The last modifier's email address. Generated based on the End User + Credentials/LOAS role of the user making the call. + overrideValidTime: + type: string + format: google-datetime description: >- - Optional. Informs the front-end application where to draw this error - catcher config on the UI. - errorCatcherId: + User provided expiry time to override. For the example of + Salesforce, username/password credentials can be valid for 6 months + depending on the instance settings. + expiryNotificationDuration: description: >- - Required. An error catcher id is string representation for the error - catcher config. Within a workflow, error_catcher_id uniquely - identifies an error catcher config among all error catcher configs - for the workflow + User can define the time to receive notification after which the + auth config becomes invalid. Support up to 30 days. Support + granularity in hours. + type: array + items: + type: string + format: google-duration + createTime: + format: google-datetime + description: Output only. The timestamp when the auth config is created. + readOnly: true type: string - GoogleCloudConnectorsV1SslConfig: - id: GoogleCloudConnectorsV1SslConfig + updateTime: + type: string + description: Output only. The timestamp when the auth config is modified. + readOnly: true + format: google-datetime + certificateId: + description: Certificate id for client certificate + type: string + decryptedCredential: + description: Raw auth credentials. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCredential' type: object - description: SSL Configuration of a connection + GoogleCloudConnectorsV1EventingStatus: + description: EventingStatus indicates the state of eventing. + type: object + id: GoogleCloudConnectorsV1EventingStatus properties: - type: - type: string - enum: - - SSL_TYPE_UNSPECIFIED - - TLS - - MTLS - enumDescriptions: - - No SSL configuration required. - - TLS Handshake - - mutual TLS (MTLS) Handshake - description: Controls the ssl type for the given connector version. - useSsl: - description: Bool for enabling SSL - type: boolean - privateServerCertificate: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: >- - Private Server Certificate. Needs to be specified if trust model is - `PRIVATE`. - clientPrivateKeyPass: - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - description: Secret containing the passphrase protecting the Client Private Key - clientCertificate: - description: Client Certificate - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - serverCertType: + description: type: string - description: Type of Server Cert (PEM/JKS/.. etc.) - enum: - - CERT_TYPE_UNSPECIFIED - - PEM + readOnly: true + description: Output only. Description of error if State is set to "ERROR". + state: + description: Output only. State. enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type - clientCertType: + - Default state. + - Eventing is enabled and ready to receive events. + - Eventing is not active due to an error. + - Ingress endpoint required. enum: - - CERT_TYPE_UNSPECIFIED - - PEM - description: Type of Client Cert (PEM/JKS/.. etc.) - enumDescriptions: - - Cert type unspecified. - - Privacy Enhanced Mail (PEM) Type + - STATE_UNSPECIFIED + - ACTIVE + - ERROR + - INGRESS_ENDPOINT_REQUIRED type: string - trustModel: + readOnly: true + GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse: + type: object + id: GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + description: Response for ListIntegrationVersions. + properties: + nextPageToken: type: string - description: Trust Model of the SSL connection - enumDescriptions: - - Public Trust Model. Takes the Default Java trust store. - - Private Trust Model. Takes custom/private trust store. - - Insecure Trust Model. Accept all certificates. - enum: - - PUBLIC - - PRIVATE - - INSECURE - additionalVariables: - description: Additional SSL related field values - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + integrationVersions: + description: The integrations which match the request. type: array - clientPrivateKey: - description: Client Private Key - $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' - GoogleCloudConnectorsV1AuthConfig: + items: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + noPermission: + type: boolean + description: Whether the user has no permission on the version or not. + GoogleCloudConnectorsV1Secret: + id: GoogleCloudConnectorsV1Secret + description: Secret provides a reference to entries in Secret Manager. properties: - oauth2ClientCredentials: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials - description: Oauth2ClientCredentials. - sshPublicKey: - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigSshPublicKey' - description: SSH Public Key. - oauth2JwtBearer: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer - description: Oauth2JwtBearer. - authType: - description: The type of authentication configured. - enum: - - AUTH_TYPE_UNSPECIFIED - - USER_PASSWORD - - OAUTH2_JWT_BEARER - - OAUTH2_CLIENT_CREDENTIALS - - SSH_PUBLIC_KEY - - OAUTH2_AUTH_CODE_FLOW - - GOOGLE_AUTHENTICATION + secretVersion: + description: >- + The resource name of the secret version in the format, format as: + `projects/*/secrets/*/versions/*`. + type: string + type: object + GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials: + properties: + accessToken: + description: Access token fetched from the authorization server. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAccessToken' + tokenEndpoint: + type: string + description: >- + The token endpoint is used by the client to obtain an access token + by presenting its authorization grant or refresh token. + clientId: + description: The client's ID. + type: string + clientSecret: + type: string + description: The client's secret. + tokenParams: + description: Token parameters for the auth request. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMap' + requestType: + description: Represent how to pass parameters to fetch access token type: string enumDescriptions: - - Authentication type not specified. - - Username and Password Authentication. + - Unspecified request type + - To pass all the parameters in post body. + - To pass all the parameters as a part of query parameter. - >- - JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant - based authentication - - Oauth 2.0 Client Credentials Grant Authentication - - SSH Public Key Authentication - - Oauth 2.0 Authorization Code Flow - - Google authentication - userPassword: - description: UserPassword. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfigUserPassword' - additionalVariables: - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - description: List containing additional auth configs. - type: array - oauth2AuthCodeFlow: - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow - description: Oauth2AuthCodeFlow. - authKey: + To pass client id and client secret as base 64 encoding of + client_id:client_password and rest parameters in post body. + enum: + - REQUEST_TYPE_UNSPECIFIED + - REQUEST_BODY + - QUERY_PARAMETERS + - ENCODED_HEADER + scope: type: string - description: Identifier key for auth config + description: A space-delimited list of requested scope permissions. type: object - id: GoogleCloudConnectorsV1AuthConfig - description: AuthConfig defines details of a authentication type. - GoogleCloudIntegrationsV1alphaEventParameter: description: >- - This message is used for processing and persisting (when applicable) key - value pair parameters for each event in the event bus. Next available - id: 4 + For client credentials grant, the client sends a POST request with + grant_type as 'client_credentials' to the authorization server. The + authorization server will respond with a JSON object containing the + access token. + id: GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials + EnterpriseCrmEventbusProtoParameterMapEntry: + properties: + key: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + value: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterMapField' + description: Entry is a pair of key and value. type: object + id: EnterpriseCrmEventbusProtoParameterMapEntry + EnterpriseCrmEventbusProtoParameterEntry: + description: Key-value pair of EventBus parameters. properties: value: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' description: >- Values for the defined keys. Each value can either be string, int, double or any proto message. masked: - type: boolean description: True if this parameter should be masked in the logs + type: boolean key: type: string description: >- Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. - id: GoogleCloudIntegrationsV1alphaEventParameter - GoogleCloudIntegrationsV1alphaListIntegrationsResponse: - description: Response for ListIntegrations. - id: GoogleCloudIntegrationsV1alphaListIntegrationsResponse type: object + id: EnterpriseCrmEventbusProtoParameterEntry + GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse: + id: GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + properties: {} + description: Response for PublishIntegrationVersion. + type: object + GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration: + description: Expiration configs for the approval request. + properties: + remindTime: + type: string + format: google-datetime + description: >- + Time after the previous suspension action reminder, if any, is sent + using the selected notification option, for a suspension which is + still PENDING_UNSPECIFIED. + liftWhenExpired: + type: boolean + description: >- + Whether the suspension will be REJECTED or LIFTED upon expiration. + REJECTED is the default behavior. + expireTime: + description: >- + Output only. Time after which the suspension expires, if no action + taken. + readOnly: true + type: string + format: google-datetime + type: object + id: GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration + GoogleCloudIntegrationsV1alphaSearchTemplatesResponse: properties: nextPageToken: + description: The token used to retrieve the next page results. type: string - description: The next page token for the response. - integrations: - description: The integrations which match the request. + templates: type: array + description: List of templates retrieved. items: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntegration' - GoogleCloudConnectorsV1EventingConfigDeadLetterConfig: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + description: Response for a request to search templates + type: object + id: GoogleCloudIntegrationsV1alphaSearchTemplatesResponse + GoogleCloudIntegrationsV1alphaUsernameAndPassword: + id: GoogleCloudIntegrationsV1alphaUsernameAndPassword + description: Username and password pair. properties: - projectId: + username: type: string - description: Optional. Project which has the topic given. - topic: - description: Optional. Topic to push events which couldn't be processed. + description: Username to be used + password: type: string + description: Password to be used type: object - id: GoogleCloudConnectorsV1EventingConfigDeadLetterConfig - description: Dead Letter configuration details provided by the user. - GoogleCloudConnectorsV1EncryptionKey: + EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats: type: object + id: EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats properties: - type: - description: Type. - enum: - - TYPE_UNSPECIFIED - - GOOGLE_MANAGED - - CUSTOMER_MANAGED + startTime: + description: >- + The start time of the task execution for current attempt. This could + be in the future if it's been scheduled. type: string - enumDescriptions: - - Value type is not specified. - - Google Managed. - - Customer Managed. - kmsKeyName: + format: int64 + endTime: + format: int64 type: string - description: >- - The [KMS key name] with which the content of the Operation is - encrypted. The expected format: - `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty - string if google managed. - id: GoogleCloudConnectorsV1EncryptionKey - description: Encryption Key value. - GoogleCloudIntegrationsV1alphaValueType: - description: The type of the parameter. - type: object - id: GoogleCloudIntegrationsV1alphaValueType + description: The end time of the task execution for current attempt. + EnterpriseCrmEventbusProtoLoopMetadata: properties: - doubleValue: - type: number - description: Double Number. - format: double - booleanValue: - type: boolean - description: Boolean. - stringArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaStringParameterArray - description: String Array. - intValue: - description: Integer. + currentIterationDetail: + type: string + description: >- + Needs to be set by the loop impl class before each iteration. The + abstract loop class will append the request and response to it. Eg. + The foreach Loop will clean up and set it as the current iteration + element at the start of each loop. The post request and response + will be appended to the value once they are available. + currentIterationCount: format: int64 type: string - doubleArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDoubleParameterArray - description: Double Number Array. - intArray: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaIntParameterArray' - description: Integer Array. - jsonValue: - description: Json. + description: Starting from 1, not 0. + failureLocation: + description: Indicates where in the loop logic did it error out. type: string - stringValue: + enum: + - UNKNOWN + - SUBWORKFLOW + - PARAM_OVERRIDING + - PARAM_AGGREGATING + - SETTING_ITERATION_ELEMENT + - GETTING_LIST_TO_ITERATE + - CONDITION_EVALUATION + - BUILDING_REQUEST + enumDescriptions: + - No error or Unknown. + - Subworkflow failed while firing/running. + - Param overrides failed. + - Param aggregation failed. + - Setting for loop current element failed. + - Getting the list to iterate. + - Evaluating the while loop condition. + - Building the iteration request + errorMsg: + description: Add the error message when loops fail. type: string - description: String. - booleanArray: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaBooleanParameterArray - description: Boolean Array. - GoogleCloudIntegrationsV1alphaStringParameterArray: + id: EnterpriseCrmEventbusProtoLoopMetadata type: object - description: This message only contains a field of string array. - properties: - stringValues: - items: - type: string - type: array - description: String array. - id: GoogleCloudIntegrationsV1alphaStringParameterArray - GoogleCloudIntegrationsV1alphaExecutionReplayInfo: + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest: properties: - originalExecutionInfoId: + authConfigId: description: >- - If this execution is a replay of another execution, then this field - contains the original execution id. + The auth config id necessary to fetch the necessary credentials to + create the project for external clients type: string - replayReason: - description: reason for replay + appsScriptProject: type: string - replayedExecutionInfoIds: - type: array - description: >- - If this execution has been replayed, then this field contains the - execution ids of the replayed executions. - items: - type: string - id: GoogleCloudIntegrationsV1alphaExecutionReplayInfo + description: The name of the Apps Script project to be created. + description: Request for CreateAppsScriptProject rpc call. + type: object + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + GoogleCloudIntegrationsV1alphaJwt: description: >- - Contains the details of the execution info: this includes the replay - reason and replay tree connecting executions in a parent-child - relationship + Represents JSON web token(JWT), which is a compact, URL-safe means of + representing claims to be transferred between two parties, enabling the + claims to be digitally signed or integrity protected. + properties: + jwtHeader: + type: string + description: Identifies which algorithm is used to generate the signature. + secret: + description: User's pre-shared secret to sign the token. + type: string + jwt: + type: string + description: The token calculated by the header, payload and signature. + jwtPayload: + description: >- + Contains a set of claims. The JWT specification defines seven + Registered Claim Names which are the standard fields commonly + included in tokens. Custom claims are usually also included, + depending on the purpose of the token. + type: string type: object - GoogleCloudConnectorsV1Connection: + id: GoogleCloudIntegrationsV1alphaJwt + EnterpriseCrmEventbusProtoTriggerCriteria: + id: EnterpriseCrmEventbusProtoTriggerCriteria type: object - description: Connection represents an instance of connector. properties: - destinationConfigs: - type: array + parameters: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: Optional. To be used in TaskConfig for the implementation class. + triggerCriteriaTaskImplementationClassName: + type: string description: >- - Optional. Configuration of the Connector's destination. Only - accepted for Connectors that accepts user defined destination(s). - items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' - isTrustedTester: - readOnly: true - type: boolean - description: Output only. Is trusted tester program enabled for the project. - envoyImageLocation: + Optional. Implementation class name. The class should implement the + “TypedTask” interface. + condition: type: string description: >- - Output only. GCR location where the envoy image is stored. formatted - like: gcr.io/{bucketName}/{imageName} - readOnly: true - eventingConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' - description: Optional. Eventing config of a connection - billingConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' - readOnly: true - description: Output only. Billing config for the connection. - suspended: + Required. Standard filter expression, when true the workflow will be + executed. If there's no + trigger_criteria_task_implementation_class_name specified, the + condition will be validated directly. + EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: + properties: + key: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + value: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + type: object + description: Entry is a pair of key and value. + EnterpriseCrmFrontendsEventbusProtoParameterEntry: + id: EnterpriseCrmFrontendsEventbusProtoParameterEntry + type: object + properties: + dataType: + enum: + - DATA_TYPE_UNSPECIFIED + - STRING_VALUE + - INT_VALUE + - DOUBLE_VALUE + - BOOLEAN_VALUE + - PROTO_VALUE + - SERIALIZED_OBJECT_VALUE + - STRING_ARRAY + - INT_ARRAY + - DOUBLE_ARRAY + - PROTO_ARRAY + - PROTO_ENUM + - BOOLEAN_ARRAY + - PROTO_ENUM_ARRAY + - BYTES + - BYTES_ARRAY + - NON_SERIALIZABLE_OBJECT + - JSON_VALUE + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - >- + BYTES and BYTES_ARRAY data types are not allowed for top-level + params. They're only meant to support protobufs with BYTES + (sub)fields. + - '' + - '' + - '' + type: string + description: Explicitly getting the type of the parameter. + masked: type: boolean + description: True if this parameter should be masked in the logs + value: description: >- - Optional. Suspended indicates if a user has suspended a connection - or not. - connectorVersion: - type: string + Values for the defined keys. Each value can either be string, int, + double or any proto message. + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterValueType + key: description: >- - Required. Connector version on which the connection is created. The - format is: - projects/*/locations/*/providers/*/connectors/*/versions/* Only - global location is supported for ConnectorVersion resource. - updateTime: - readOnly: true - description: Output only. Updated time. + Key is used to retrieve the corresponding parameter value. This + should be unique for a given fired event. These parameters must be + predefined in the workflow definition. type: string - format: google-datetime - description: + description: Key-value pair of EventBus parameters. + EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList: + id: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList + type: object + properties: + filterType: + enumDescriptions: + - '' + - '' type: string - description: Optional. Description of the resource. - labels: - additionalProperties: + enum: + - DEFAULT_INCLUSIVE + - EXCLUSIVE + enumStrings: + type: array + items: type: string - description: >- - Optional. Resource labels to represent user-provided metadata. Refer - to cloud documentation on labels for more details. - https://cloud.google.com/compute/docs/labeling-resources - type: object - status: - readOnly: true - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' - description: Output only. Current status of the connection. - configVariables: + description: List of error enums for alerts. + EnterpriseCrmEventbusProtoFieldMappingConfig: + id: EnterpriseCrmEventbusProtoFieldMappingConfig + description: >- + Field Mapping Config to map multiple output fields values from input + fields values. + type: object + properties: + mappedFields: type: array - description: >- - Optional. Configuration for configuring the connection with an - external system. items: - $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' - authConfig: - description: >- - Optional. Configuration for establishing the connection's - authentication with an external system. - $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' - lockConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' - description: >- - Optional. Configuration that indicates whether or not the Connection - can be edited. - logConfig: - description: Optional. Log configuration for the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' - createTime: - format: google-datetime - type: string - readOnly: true - description: Output only. Created time. - subscriptionType: - enumDescriptions: - - Unspecified subscription type. - - PayG subscription. - - Paid Subscription. - description: >- - Output only. This subscription type enum states the subscription - type of the project. - enum: - - SUBSCRIPTION_TYPE_UNSPECIFIED - - PAY_G - - PAID - type: string - readOnly: true - connectorVersionLaunchStage: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoMappedField' + EnterpriseCrmEventbusProtoFunctionType: + properties: + baseFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseFunction' + description: LINT.IfChange + booleanFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanFunction' + protoArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoArrayFunction' + stringFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringFunction' + intArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntArrayFunction' + protoFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoProtoFunction' + booleanArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBooleanArrayFunction' + intFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoIntFunction' + jsonFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoJsonFunction' + stringArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoStringArrayFunction' + doubleFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleFunction' + doubleArrayFunction: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoDoubleArrayFunction' + id: EnterpriseCrmEventbusProtoFunctionType + type: object + EnterpriseCrmEventbusProtoDoubleArrayFunction: + id: EnterpriseCrmEventbusProtoDoubleArrayFunction + properties: + functionName: enum: - - LAUNCH_STAGE_UNSPECIFIED - - PREVIEW - - GA - - DEPRECATED - - PRIVATE_PREVIEW - enumDescriptions: - - LAUNCH_STAGE_UNSPECIFIED. - - PREVIEW. - - GA. - - DEPRECATED. - - PRIVATE_PREVIEW. - type: string - description: Output only. Flag to mark the version indicating the launch stage. - readOnly: true - sslConfig: - $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' - description: Optional. Ssl config of a connection - serviceDirectory: - readOnly: true - type: string - description: >- - Output only. The name of the Service Directory service name. Used - for Private Harpoon to resolve the ILB address. e.g. - "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" - nodeConfig: - description: Optional. Node configuration for the connection. - $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' - eventingRuntimeData: - $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' - readOnly: true - description: Output only. Eventing Runtime Data. - eventingEnablementType: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER enumDescriptions: - - Eventing Enablement Type Unspecifeied. - - Both connection and eventing. - - Only Eventing. - type: string - enum: - - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED - - EVENTING_AND_CONNECTION - - ONLY_EVENTING - description: >- - Optional. Eventing enablement type. Will be nil if eventing is not - enabled. - serviceAccount: - description: >- - Optional. Service account needed for runtime plane to access Google - Cloud resources. - type: string - connectorVersionInfraConfig: - description: Output only. Infra configs supported by Connector Version. - $ref: >- - #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig - readOnly: true - imageLocation: - description: >- - Output only. GCR location where the runtime image is stored. - formatted like: gcr.io/{bucketName}/{imageName} - type: string - readOnly: true - connectionRevision: - type: string - format: int64 - readOnly: true - description: >- - Output only. Connection revision. This field is only updated when - the connection is created or updated by User. - name: - description: >- - Output only. Resource name of the Connection. Format: - projects/{project}/locations/{location}/connections/{connection} - type: string - readOnly: true - id: GoogleCloudConnectorsV1Connection - EnterpriseCrmEventbusProtoParameterMapField: - properties: - referenceKey: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' type: string - description: Referencing one of the WF variables. - literalValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoParameterValueType' - description: Passing a literal value. - description: Field represents either the key or value in an entry. - id: EnterpriseCrmEventbusProtoParameterMapField type: object - GoogleCloudIntegrationsV1alphaTestIntegrationsRequest: + EnterpriseCrmEventbusProtoParamSpecEntryValidationRule: + id: EnterpriseCrmEventbusProtoParamSpecEntryValidationRule type: object - description: The request for testing an integration. properties: - parameters: - deprecated: true - description: Optional. Passed in as parameters to each integration execution. + doubleRange: $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - triggerId: - description: >- - Required. The trigger id of the integration trigger config. If both - trigger_id and client_id is present, the integration is executed - from the start tasks provided by the matching trigger config - otherwise it is executed from the default start tasks. - type: string - configParameters: - type: object - additionalProperties: - type: any - description: Properties of the object. - description: Optional. Config parameters used during integration execution. - clientId: + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange + intRange: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange + stringRegex: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex + GoogleCloudIntegrationsV1alphaClientCertificate: + description: Contains client certificate information + properties: + passphrase: description: >- - Required. This is used to identify the client on whose behalf the - event will be executed. + 'passphrase' should be left unset if private key is not encrypted. + Note that 'passphrase' is not the password for web server, but an + extra layer of security to protected private key. type: string - deadlineSecondsTime: + sslCertificate: type: string - format: google-datetime - description: Optional. custom deadline of the rpc - testMode: description: >- - Optional. Can be specified in the event request, otherwise false - (default). If true, enables tasks with condition "test_mode = true". - If false, disables tasks with condition "test_mode = true" if global - test mode (set by platform) is also false {@link EventBusConfig}. - type: boolean - inputParameters: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' - description: Optional. Input parameters used during integration execution. - type: object - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: Required. integration config to execute the workflow - id: GoogleCloudIntegrationsV1alphaTestIntegrationsRequest - EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam: - properties: - allowedCredentialTypes: + The ssl certificate encoded in PEM format. This string must include + the begin header and end footer lines. For example, -----BEGIN + CERTIFICATE----- + MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV + BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw + MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET + MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA + vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 + JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB + xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P + AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB + Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey + Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW + JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr + 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H + wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- + encryptedPrivateKey: + type: string description: >- - Defines the credential types to be supported as Task may restrict - specific types to use, e.g. Cloud SQL Task will use - username/password type only. - type: array - items: - type: string - enum: - - CREDENTIAL_TYPE_UNSPECIFIED - - USERNAME_AND_PASSWORD - - API_KEY - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT - - OAUTH2_CLIENT_CREDENTIALS - - OAUTH2_RESOURCE_OWNER_CREDENTIALS - - JWT - - AUTH_TOKEN - - SERVICE_ACCOUNT - - CLIENT_CERTIFICATE_ONLY - - OIDC_TOKEN - enumDescriptions: - - '' - - Regular username/password pair. - - API key. - - OAuth 2.0 Authorization Code Grant Type. - - OAuth 2.0 Implicit Grant Type. - - OAuth 2.0 Client Credentials Grant Type. - - OAuth 2.0 Resource Owner Credentials Grant Type. - - JWT Token. - - Auth Token, e.g. bearer token. - - >- - Service Account which can be used to generate token for - authentication. - - Client Certificate only. - - Google OIDC ID Token - scope: - description: A space-delimited list of requested scope permissions. - type: string - useServiceAccountInContext: - type: boolean - allowedServiceAccountInContext: - type: boolean - authConfigId: - description: UUID of the AuthConfig. - type: string - id: EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam - type: object - EnterpriseCrmEventbusProtoIntParameterArray: - properties: - intValues: - type: array - items: - format: int64 - type: string - type: object - id: EnterpriseCrmEventbusProtoIntParameterArray - GoogleCloudIntegrationsV1alphaDeprovisionClientRequest: + The ssl certificate encoded in PEM format. This string must include + the begin header and end footer lines. For example, -----BEGIN + CERTIFICATE----- + MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV + BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw + MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET + MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA + vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 + JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB + xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P + AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB + Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey + Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW + JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr + 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H + wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE----- + id: GoogleCloudIntegrationsV1alphaClientCertificate type: object - properties: {} - id: GoogleCloudIntegrationsV1alphaDeprovisionClientRequest - description: Request for the Deprovision rpc - GoogleCloudIntegrationsV1alphaBooleanParameterArray: + EnterpriseCrmEventbusProtoIntArrayFunction: type: object properties: - booleanValues: - items: - type: boolean - type: array - description: Boolean array. - description: This message only contains a field of boolean array. - id: GoogleCloudIntegrationsV1alphaBooleanParameterArray - EnterpriseCrmFrontendsEventbusProtoParameterMapEntry: - id: EnterpriseCrmFrontendsEventbusProtoParameterMapEntry + functionName: + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - SUM + - AVG + - MAX + - MIN + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: string + id: EnterpriseCrmEventbusProtoIntArrayFunction + EnterpriseCrmEventbusProtoProtoArrayFunction: + id: EnterpriseCrmEventbusProtoProtoArrayFunction properties: - key: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField - value: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoParameterMapField + functionName: + enum: + - UNSPECIFIED + - GET + - APPEND + - SIZE + - TO_SET + - APPEND_ALL + - TO_JSON + - SET + - REMOVE + - REMOVE_AT + - CONTAINS + - FOR_EACH + - FILTER + type: string + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + type: object + GoogleCloudIntegrationsV1alphaNextTask: + description: >- + The task that is next in line to be executed, if the condition specified + evaluated to true. + id: GoogleCloudIntegrationsV1alphaNextTask type: object - description: Entry is a pair of key and value. - GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: properties: - subject: + description: type: string - description: Value for the "sub" claim. - issuer: - description: Value for the "iss" claim. + description: >- + User-provided description intended to give additional business + context about the task. + taskConfigId: type: string - audience: + description: ID of the next task. + condition: type: string - description: Value for the "aud" claim. - id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims - type: object - description: JWT claims used for the jwt-bearer authorization grant. - EnterpriseCrmFrontendsEventbusProtoProtoParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoProtoParameterArray - type: object - properties: - protoValues: - type: array - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - GoogleCloudIntegrationsV1alphaCancelExecutionResponse: - properties: - isCanceled: - type: boolean - description: True if cancellation performed successfully + description: >- + Standard filter expression for this task to become an eligible next + task. + displayName: + type: string + description: User-provided label that is attached to this edge in the UI. + taskId: + description: Task number of the next task. + type: string + GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest: + description: >- + LINT.IfChange Use this request to post all workflows associated with a + given trigger id. Next available id: 13 type: object - id: GoogleCloudIntegrationsV1alphaCancelExecutionResponse - description: Response for cancelling an execution. - EnterpriseCrmEventbusProtoFailurePolicy: + id: GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest properties: - maxNumRetries: + quotaRetryCount: + description: >- + Optional. This is a field to see the quota retry count for + integration execution format: int32 type: integer - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the number of times the task will be retried if failed. - intervalInSeconds: - format: int64 - description: >- - Required if retry_strategy is FIXED_INTERVAL or - LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines - the initial interval for backoff. + parameters: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: Passed in as parameters to each workflow execution. Optional. + priority: type: string - retryStrategy: + enum: + - UNSPCIFIED + - SHEDDABLE + - SHEDDABLE_PLUS + - CRITICAL + - CRITICAL_PLUS enumDescriptions: - - '' + - Unspecified - >- - Ignores the failure of this task. The rest of the workflow will be - executed Assuming this task succeeded. + Frequent partial and occasional full unavailability is expected + and not pageable. * Requests to this band will be shed before all + other requests. * This is the default for async calls sent from + batch jobs. - >- - Causes a permanent failure of the task. However, if the last - task(s) of event was successfully completed despite the failure of - this task, it has no impact on the workflow. + Partial unavailability is expected and is not necessarily + pageable. * Requests to this band will be shed before any critical + traffic. * This is the default for async calls sent from + production jobs. - >- - Causes a permanent failure of the event. It is different from NONE - because this will mark the event as FAILED by shutting down the - event execution. - - >- - The task will be retried from the failed task onwards after a - fixed delay. A max-retry count is required to be specified with - this strategy. A jitter is added to each exponential interval so - that concurrently failing tasks of the same type do not end up - retrying after the exact same exponential interval. - Max_num_retries and interval_in_seconds must be specified. - - >- - The task will be retried from the failed task onwards after a - fixed delay that linearly increases with each retry attempt. A - jitter is added to each exponential interval so that concurrently - failing tasks of the same type do not end up retrying after the - exact same exponential interval. A max-retry count is required to - be specified with this strategy. Max_num_retries and - interval_in_seconds must be specified. - - >- - The task will be retried after an exponentially increasing period - of time with each failure. A jitter is added to each exponential - interval so that concurrently failing tasks of the same type do - not end up retrying after the exact same exponential interval. A - max-retry count is required to be specified with this strategy. - `max_num_retries` and `interval_in_seconds` must be specified. + Any outage is a pageable event. * During a production outage + requests in this band will only be shed before CRITICAL_PLUS. * + This is the default for sync calls sent from production jobs. - >- - The entire workflow will be restarted with the initial parameters - that were set when the event was fired. A max-retry count is - required to be specified with this strategy. `max_num_retries` and - `interval_in_seconds` must be specified. - enum: - - UNSPECIFIED - - IGNORE - - NONE - - FATAL - - FIXED_INTERVAL - - LINEAR_BACKOFF - - EXPONENTIAL_BACKOFF - - RESTART_WORKFLOW_WITH_BACKOFF - type: string - description: Defines what happens to the task upon failure. - retryCondition: - type: string + Any outage is a pageable event. * The guideline is for < 10% of + requests to a service to be in this band. * During a production + outage requests in this band will be prioritized above all others. + * Opt-in to CRITICAL_PLUS when your workflow triggers by human. description: >- - Optional. The retry condition that will be evaluated for this - failure policy with the corresponding retry strategy. - description: >- - Policy that defines the task retry logic and failure type. If no - FailurePolicy is defined for a task, all its dependent tasks will not be - executed (i.e, a `retry_strategy` of NONE will be applied). - id: EnterpriseCrmEventbusProtoFailurePolicy - type: object - EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo: - properties: - requestParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Event parameters come in as part of the request. - triggerId: + The request priority this request should be processed at. For + internal users: + resourceName: type: string description: >- - The trigger id of the workflow trigger config. If both trigger_id - and client_id is present, the workflow is executed from the start - tasks provided by the matching trigger config otherwise it is - executed from the default start tasks. - workflowRetryBackoffIntervalSeconds: - format: int64 + This field is only required when using Admin Access. The resource + name of target, or the parent resource name. For example: + "projects/*/locations/*/integrations/*" + requestId: description: >- - Time interval in seconds to schedule retry of workflow in manifold - when workflow is already running - type: string - workflowId: - description: Required. Pointer to the workflow it is executing. + Optional. This is used to de-dup incoming request: if the duplicate + request was detected, the response from the previous execution is + returned. Must have no more than 36 characters and contain only + alphanumeric characters and hyphens. type: string - lastModifiedTime: - format: int64 + userGeneratedExecutionId: type: string - description: Auto-generated. - errors: - items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoErrorDetail' description: >- - Errors, warnings, and informationals associated with the - workflow/task. The order in which the errors were added by the - workflow/task is maintained. - type: array - eventExecutionInfoId: + This is a unique id provided by the method caller. If provided this + will be used as the execution_id when a new execution info is + created. This is a string representation of a UUID. Must have no + more than 36 characters and contain only alphanumeric characters and + hyphens. + testMode: + description: >- + Optional. Sets test mode in {@link + enterprise/crm/eventbus/event_message.proto}. + type: boolean + scheduledTime: type: string - description: Auto-generated primary key. - errorCode: - description: Final error-code if event failed. - $ref: '#/components/schemas/CrmlogErrorCode' - executionTraceInfo: - description: Execution trace info to aggregate parent-child executions. - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExecutionTraceInfo' - snapshotNumber: format: int64 - description: Workflow snapshot number. - type: string - eventExecutionDetails: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails - description: The execution info about this event. - clientId: - description: The event data user sends as request. - type: string - cloudLoggingDetails: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudLoggingDetails' - description: Cloud Logging details for execution info - postMethod: - enum: - - UNSPECIFIED - - POST - - POST_TO_QUEUE - - SCHEDULE - - POST_BY_EVENT_CONFIG_ID - - POST_WITH_EVENT_DETAILS - description: The ways user posts this event. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - type: string - tenant: description: >- - Tenant this event is created. Used to reschedule the event to - correct tenant. - type: string - requestId: - type: string - description: Optional. This is used to de-dup incoming request. - responseParams: - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventParameters - description: Event parameters come out as part of the response. - product: + Optional. Time in milliseconds since epoch when the given event + would be scheduled. + workflowName: + description: >- + Optional. If provided, the workflow_name is used to filter all the + matched workflows having same trigger_id+client_id. A combination of + trigger_id, client_id and workflow_name identifies a unique + workflow. type: string - enum: - - UNSPECIFIED_PRODUCT - - IP - - APIGEE - - SECURITY - enumDescriptions: - - '' - - '' - - '' - - '' + ignoreErrorIfNoActiveWorkflow: + type: boolean description: >- - Which Google product the execution_info belongs to. If not set, the - execution_info belongs to Integration Platform by default. - workflowName: - description: Name of the workflow. + Optional. Flag to determine whether clients would suppress a warning + when no ACTIVE workflows are not found. If this flag is set to be + true, an error will not be thrown if the requested trigger_id or + client_id is not found in any ACTIVE workflow. Otherwise, the error + is always thrown. The flag is set to be false by default. + triggerId: + description: >- + Matched against all {@link TriggerConfig}s across all workflows. + i.e. TriggerConfig.trigger_id.equals(trigger_id) Required. type: string - replayInfo: - description: Replay info for the execution - $ref: >- - #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo - createTime: - description: Auto-generated. + clientId: + description: >- + Optional. If the client id is provided, then the combination of + trigger id and client id is matched across all the workflows. If the + client id is not provided, then workflows with matching trigger id + are executed for each client id in the {@link TriggerConfig}. For + Api Trigger, the client id is required and will be validated against + the allowed clients. type: string - format: int64 - id: EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest: + id: GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest type: object - description: >- - Contains all the execution details for a workflow instance. Next - available id: 26 - GoogleCloudIntegrationsV1alphaAccessToken: - id: GoogleCloudIntegrationsV1alphaAccessToken + description: Request to enable/disable variable masking for a provisioned client + properties: + enableVariableMasking: + type: boolean + description: >- + Required. REQUIRED: True if variable masking feature should be + turned on for this region + EnterpriseCrmEventbusProtoConnectorsConnection: + id: EnterpriseCrmEventbusProtoConnectorsConnection type: object - description: >- - The access token represents the authorization of a specific application - to access specific parts of a user’s data. properties: - refreshTokenExpireTime: - format: google-datetime + serviceName: type: string - description: The approximate time until the refresh token retrieved is valid. - refreshToken: description: >- - If the access token will expire, use the refresh token to obtain - another access token. + Service name Format: + projects/{project}/locations/{location}/namespaces/{namespace}/services/{service} + host: type: string - accessTokenExpireTime: description: >- - Required. The approximate time until the access token retrieved is - valid. - type: string - format: google-datetime - tokenType: + The name of the Hostname of the Service Directory service with TLS + if used. + connectionName: type: string description: >- - Only support "bearer" token in v1 as bearer token is the predominant - type used with OAuth 2.0. - accessToken: + Connection name Format: + projects/{project}/locations/{location}/connections/{connection} + connectorVersion: type: string description: >- - The access token encapsulating the security identity of a process or - thread. - GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse: - id: GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + Connector version Format: + projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} + GoogleCloudIntegrationsV1alphaCertificate: + description: The certificate definition properties: - integrationVersion: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion - description: The uploaded integration. - description: Response for UploadIntegrationVersion. + name: + description: Output only. Auto generated primary key + readOnly: true + type: string + validEndTime: + description: Output only. The timestamp after which certificate will expire + format: google-datetime + readOnly: true + type: string + requestorId: + type: string + description: >- + Immutable. Requestor ID to be used to register certificate with + trawler + certificateStatus: + description: Status of the certificate + enum: + - STATE_UNSPECIFIED + - ACTIVE + - EXPIRED + type: string + enumDescriptions: + - Unspecified certificate status + - Certificate in active state will be able to use + - Certificate in expired state needs to be updated + credentialId: + type: string + description: Immutable. Credential id that will be used to register with trawler + rawCertificate: + description: >- + Input only. Raw client certificate which would be registered with + trawler + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaClientCertificate' + validStartTime: + type: string + format: google-datetime + description: Output only. The timestamp after which certificate will be valid + readOnly: true + description: + type: string + description: Description of the certificate + displayName: + description: Required. Name of the certificate + type: string type: object - EnterpriseCrmEventbusProtoExecutionTraceInfo: + id: GoogleCloudIntegrationsV1alphaCertificate + GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims: + properties: + issuer: + description: Value for the "iss" claim. + type: string + subject: + type: string + description: Value for the "sub" claim. + audience: + type: string + description: Value for the "aud" claim. + description: JWT claims used for the jwt-bearer authorization grant. + id: GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims type: object + EnterpriseCrmEventbusProtoExecutionTraceInfo: + id: EnterpriseCrmEventbusProtoExecutionTraceInfo properties: + traceId: + type: string + description: Used to aggregate ExecutionTraceInfo. parentEventExecutionInfoId: + type: string description: >- Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask. - type: string - traceId: - type: string - description: Used to aggregate ExecutionTraceInfo. - id: EnterpriseCrmEventbusProtoExecutionTraceInfo + type: object description: >- Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships. - EnterpriseCrmEventbusProtoEventExecutionDetails: + EnterpriseCrmEventbusProtoSuspensionResolutionInfo: + type: object + id: EnterpriseCrmEventbusProtoSuspensionResolutionInfo properties: - eventRetriesFromBeginningCount: - type: integer - format: int32 - description: >- - Indicates the number of times the execution has restarted from the - beginning. - eventExecutionSnapshot: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionSnapshot - type: array - nextExecutionTime: - description: >- - Next scheduled execution time in case the execution status was - RETRY_ON_HOLD. - format: int64 - type: string - eventExecutionState: - enum: - - UNSPECIFIED - - ON_HOLD - - IN_PROCESS - - SUCCEEDED - - FAILED - - CANCELED - - RETRY_ON_HOLD - - SUSPENDED + status: enumDescriptions: - '' - - >- - Event is received and waiting for the execution. This happens when - firing the event via "postToQueue" or "schedule". - - Event is under processing. - - >- - Event execution successfully finished. There's no more change - after this state. - - Event execution failed. There's no more change after this state. - - >- - Event execution canceled by user. There's no more change after - this state. - - Event execution failed and waiting for retry. - - Event execution suspended and waiting for manual intervention. + - '' + - '' + - '' + enum: + - PENDING_UNSPECIFIED + - REJECTED + - LIFTED + - CANCELED type: string - ryeLockUnheldCount: - format: int32 - type: integer - description: >- - Used internally and shouldn't be exposed to users. A counter for the - cron job to record how many times this event is in in_process state - but don't have a lock consecutively/ - eventAttemptStats: - items: - $ref: >- - #/components/schemas/EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats - type: array - eventExecutionSnapshotsSize: - description: Total size of all event_execution_snapshots for an execution - format: int64 + clientId: type: string - networkAddress: + description: The event data user sends as request. + cloudKmsConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoCloudKmsConfig' + description: KMS info, used by cmek/gmek integration + eventExecutionInfoId: + type: string + description: Required. ID of the associated execution. + lastModifiedTimestamp: + description: Auto-generated. + type: string + format: google-datetime + wrappedDek: + format: byte + type: string + description: Wrapped dek + createdTimestamp: + type: string + format: google-datetime + description: Auto-generated. + suspensionConfig: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoSuspensionConfig' + externalTraffic: + description: The origin of the suspension for periodic notifications. + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoExternalTraffic' + encryptedSuspensionResolutionInfo: + format: byte + type: string + description: Encrypted SuspensionResolutionInfo + taskNumber: + type: string + description: Required. Task number of the associated SuspensionTask. + audit: + $ref: >- + #/components/schemas/EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit + suspensionId: + description: Primary key for the SuspensionResolutionInfoTable. + type: string + workflowName: + description: Required. The name of the originating workflow. type: string + product: + enum: + - UNSPECIFIED_PRODUCT + - IP + - APIGEE + - SECURITY description: >- - The network address (aka. bns address) that indicates where the - event executor is running. - logFilePath: - description: The log file path (aka. cns address) for this event. + Which Google product the suspension belongs to. If not set, the + suspension belongs to Integration Platform by default. type: string - description: >- - Contains the details of the execution info of this event: this includes - the tasks execution details plus the event execution statistics. Next - available id: 11 - id: EnterpriseCrmEventbusProtoEventExecutionDetails + enumDescriptions: + - '' + - '' + - '' + - '' + EnterpriseCrmEventbusProtoConditionalFailurePolicies: + id: EnterpriseCrmEventbusProtoConditionalFailurePolicies + properties: + failurePolicies: + type: array + items: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' + description: >- + The list of failure policies that will be applied to the task in + order. + defaultFailurePolicy: + description: >- + The default failure policy to be applied if no conditional failure + policy matches + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFailurePolicy' type: object - EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray: - id: EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + GoogleCloudIntegrationsV1alphaListExecutionsResponse: + description: Response for listing the integration execution data. type: object properties: - booleanValues: - items: - type: boolean + nextPageToken: + description: The token used to retrieve the next page results. + type: string + executionInfos: type: array - EnterpriseCrmEventbusProtoTransformExpression: - properties: - initialValue: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoBaseValue' - description: Initial value upon which to perform transformations. - transformationFunctions: items: - $ref: '#/components/schemas/EnterpriseCrmEventbusProtoFunction' + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo + deprecated: true + description: Required. The detailed information of requested executions. + executions: type: array - description: Transformations to be applied sequentially. + description: The detailed information of requested executions + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + id: GoogleCloudIntegrationsV1alphaListExecutionsResponse + GoogleCloudIntegrationsV1alphaSuspensionAudit: + description: Contains when and by whom the suspension was resolved. + id: GoogleCloudIntegrationsV1alphaSuspensionAudit type: object - id: EnterpriseCrmEventbusProtoTransformExpression - parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - key: + properties: + resolver: + description: Email address of the person who resolved this suspension. + type: string + resolveTime: + format: google-datetime + description: Time at which this suspension was resolved. + type: string + GoogleCloudIntegrationsV1alphaDownloadExecutionResponse: + properties: + content: + description: The content of downloaded execution. + type: string + type: object + id: GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + description: Response for downloading an execution. + GoogleCloudIntegrationsV1alphaResolveSuspensionResponse: + properties: {} + description: Response for Suspensions.ResolveSuspensions. + id: GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + type: object + GoogleCloudIntegrationsV1alphaParameterMapEntry: + id: GoogleCloudIntegrationsV1alphaParameterMapEntry + type: object + description: Entry is a pair of key and value. + properties: + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + description: Value of the map entry. + key: + description: Key of the map entry. + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaParameterMapField' + EnterpriseCrmFrontendsEventbusProtoParameterValueType: + description: 'To support various types of parameter values. Next available id: 14' + id: EnterpriseCrmFrontendsEventbusProtoParameterValueType + properties: + jsonValue: + type: string + doubleArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray + booleanValue: + type: boolean + protoValue: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + intArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoIntParameterArray + doubleValue: + format: double + type: number + stringArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoStringParameterArray + stringValue: + type: string + intValue: + type: string + format: int64 + booleanArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray + protoArray: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoProtoParameterArray + serializedObjectValue: + $ref: >- + #/components/schemas/EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter + type: object + EnterpriseCrmEventbusProtoCloudSchedulerConfig: + properties: + location: + description: >- + Required. The location where associated cloud scheduler job will be + created + type: string + cronTab: + description: Required. The cron tab of cloud scheduler trigger. + type: string + serviceAccountEmail: + description: >- + Required. Service account used by Cloud Scheduler to trigger the + integration at scheduled time + type: string + errorMessage: + type: string + description: >- + Optional. When the job was deleted from Pantheon UI, error_message + will be populated when Get/List integrations + id: EnterpriseCrmEventbusProtoCloudSchedulerConfig + description: Cloud Scheduler Trigger configuration + type: object + GoogleCloudConnectorsV1SslConfig: + properties: + clientCertificate: + description: Client Certificate + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + clientCertType: + type: string + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + description: Type of Client Cert (PEM/JKS/.. etc.) + trustModel: + description: Trust Model of the SSL connection + enumDescriptions: + - Public Trust Model. Takes the Default Java trust store. + - Private Trust Model. Takes custom/private trust store. + - Insecure Trust Model. Accept all certificates. + type: string + enum: + - PUBLIC + - PRIVATE + - INSECURE + additionalVariables: + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + type: array + description: Additional SSL related field values + serverCertType: + type: string + enum: + - CERT_TYPE_UNSPECIFIED + - PEM + enumDescriptions: + - Cert type unspecified. + - Privacy Enhanced Mail (PEM) Type + description: Type of Server Cert (PEM/JKS/.. etc.) + type: + description: Controls the ssl type for the given connector version. + type: string + enumDescriptions: + - No SSL configuration required. + - TLS Handshake + - mutual TLS (MTLS) Handshake + enum: + - SSL_TYPE_UNSPECIFIED + - TLS + - MTLS + privateServerCertificate: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: >- + Private Server Certificate. Needs to be specified if trust model is + `PRIVATE`. + clientPrivateKey: + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + description: Client Private Key + clientPrivateKeyPass: + description: Secret containing the passphrase protecting the Client Private Key + $ref: '#/components/schemas/GoogleCloudConnectorsV1Secret' + useSsl: + type: boolean + description: Bool for enabling SSL + description: SSL Configuration of a connection + id: GoogleCloudConnectorsV1SslConfig + type: object + GoogleCloudIntegrationsV1alphaIntegrationConfigParameter: + id: GoogleCloudIntegrationsV1alphaIntegrationConfigParameter + type: object + properties: + value: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaValueType' + description: >- + Values for the defined keys. Each value can either be string, int, + double or any proto message or a serialized object. + parameter: + description: >- + Optional. Integration Parameter to provide the default value, data + type and attributes required for the Integration config variables. + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationParameter description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - connector_platform_regions: - id: google.integrations.connector_platform_regions - name: connector_platform_regions - title: Connector_platform_regions - methods: + Integration Config Parameter is defined in the integration config and + are used to provide external configuration for integration. It provide + information about data types of the expected parameters and provide any + default values or value. They can also be used to add custom attributes. + GoogleCloudConnectorsV1Connection: + properties: + status: + readOnly: true + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConnectionStatus' + description: Output only. Current status of the connection. + tlsMigrationState: + description: Output only. Status of the TLS migration. + enumDescriptions: + - TLS migration state is not specified. + - TLS migration is in progress. + - TLS migration is completed. + readOnly: true + type: string + enum: + - TLS_MIGRATION_STATE_UNSPECIFIED + - TLS_MIGRATION_NOT_STARTED + - TLS_MIGRATION_COMPLETED + sslConfig: + description: Optional. Ssl config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1SslConfig' + destinationConfigs: + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1DestinationConfig' + description: >- + Optional. Configuration of the Connector's destination. Only + accepted for Connectors that accepts user defined destination(s). + type: array + name: + readOnly: true + type: string + description: >- + Output only. Resource name of the Connection. Format: + projects/{project}/locations/{location}/connections/{connection} + labels: + type: object + description: >- + Optional. Resource labels to represent user-provided metadata. Refer + to cloud documentation on labels for more details. + https://cloud.google.com/compute/docs/labeling-resources + additionalProperties: + type: string + nodeConfig: + description: Optional. Node configuration for the connection. + $ref: '#/components/schemas/GoogleCloudConnectorsV1NodeConfig' + logConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1LogConfig' + description: Optional. Log configuration for the connection. + envoyImageLocation: + type: string + description: >- + Output only. GCR location where the envoy image is stored. formatted + like: gcr.io/{bucketName}/{imageName} + readOnly: true + billingConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1BillingConfig' + readOnly: true + description: Output only. Billing config for the connection. + connectorVersion: + description: >- + Required. Connector version on which the connection is created. The + format is: + projects/*/locations/*/providers/*/connectors/*/versions/* Only + global location is supported for ConnectorVersion resource. + type: string + configVariables: + type: array + description: >- + Optional. Configuration for configuring the connection with an + external system. + items: + $ref: '#/components/schemas/GoogleCloudConnectorsV1ConfigVariable' + serviceAccount: + type: string + description: >- + Optional. Service account needed for runtime plane to access Google + Cloud resources. + updateTime: + readOnly: true + type: string + description: Output only. Updated time. + format: google-datetime + connectorVersionLaunchStage: + readOnly: true + description: Output only. Flag to mark the version indicating the launch stage. + type: string + enumDescriptions: + - LAUNCH_STAGE_UNSPECIFIED. + - PREVIEW. + - GA. + - DEPRECATED. + - PRIVATE_PREVIEW. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - PREVIEW + - GA + - DEPRECATED + - PRIVATE_PREVIEW + host: + readOnly: true + description: >- + Output only. The name of the Hostname of the Service Directory + service with TLS. + type: string + lockConfig: + description: >- + Optional. Configuration that indicates whether or not the Connection + can be edited. + $ref: '#/components/schemas/GoogleCloudConnectorsV1LockConfig' + isTrustedTester: + type: boolean + readOnly: true + description: Output only. Is trusted tester program enabled for the project. + description: + description: Optional. Description of the resource. + type: string + authConfig: + $ref: '#/components/schemas/GoogleCloudConnectorsV1AuthConfig' + description: >- + Optional. Configuration for establishing the connection's + authentication with an external system. + subscriptionType: + type: string + description: >- + Output only. This subscription type enum states the subscription + type of the project. + readOnly: true + enum: + - SUBSCRIPTION_TYPE_UNSPECIFIED + - PAY_G + - PAID + enumDescriptions: + - Unspecified subscription type. + - PayG subscription. + - Paid Subscription. + serviceDirectory: + type: string + readOnly: true + description: >- + Output only. The name of the Service Directory service name. Used + for Private Harpoon to resolve the ILB address. e.g. + "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" + tlsServiceDirectory: + type: string + description: Output only. The name of the Service Directory service with TLS. + readOnly: true + imageLocation: + description: >- + Output only. GCR location where the runtime image is stored. + formatted like: gcr.io/{bucketName}/{imageName} + type: string + readOnly: true + eventingEnablementType: + description: >- + Optional. Eventing enablement type. Will be nil if eventing is not + enabled. + type: string + enum: + - EVENTING_ENABLEMENT_TYPE_UNSPECIFIED + - EVENTING_AND_CONNECTION + - ONLY_EVENTING + enumDescriptions: + - Eventing Enablement Type Unspecifeied. + - Both connection and eventing. + - Only Eventing. + connectorVersionInfraConfig: + readOnly: true + description: Output only. Infra configs supported by Connector Version. + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1ConnectorVersionInfraConfig + createTime: + description: Output only. Created time. + readOnly: true + type: string + format: google-datetime + connectionRevision: + type: string + readOnly: true + format: int64 + description: >- + Output only. Connection revision. This field is only updated when + the connection is created or updated by User. + suspended: + description: >- + Optional. Suspended indicates if a user has suspended a connection + or not. + type: boolean + eventingRuntimeData: + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingRuntimeData' + description: Output only. Eventing Runtime Data. + readOnly: true + asyncOperationsEnabled: + type: boolean + description: >- + Optional. Async operations enabled for the connection. If Async + Operations is enabled, Connection allows the customers to initiate + async long running operations using the actions API. + eventingConfig: + description: Optional. Eventing config of a connection + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingConfig' + id: GoogleCloudConnectorsV1Connection + type: object + description: Connection represents an instance of connector. + GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse: + properties: + nextPageToken: + description: The token used to retrieve the next page of results. + type: string + sfdcChannels: + type: array + items: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + description: The list of SfdcChannels retrieved. + type: object + description: Response to list SfdcChannels. + id: GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse: + properties: + projectId: + description: The created AppsScriptProject ID. + type: string + id: GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + type: object + description: Response for CreateAppsScriptProject rpc call. + EnterpriseCrmEventbusProtoTeardownTaskConfig: + properties: + nextTeardownTask: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoNextTeardownTask' + creatorEmail: + description: The creator's email address. + type: string + name: + description: >- + Required. Unique identifier of the teardown task within this Config. + We use this field as the identifier to find next teardown tasks. + type: string + parameters: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventParameters' + description: The parameters the user can pass to this task. + teardownTaskImplementationClassName: + type: string + description: Required. Implementation class name. + properties: + $ref: '#/components/schemas/EnterpriseCrmEventbusProtoEventBusProperties' + id: EnterpriseCrmEventbusProtoTeardownTaskConfig + type: object + GoogleCloudConnectorsV1EventingRuntimeData: + id: GoogleCloudConnectorsV1EventingRuntimeData + properties: + eventsListenerPscSa: + description: >- + Output only. Events listener PSC Service attachment. The value will + be populated after provisioning the events listener with private + connectivity enabled. + readOnly: true + type: string + eventsListenerEndpoint: + readOnly: true + description: >- + Output only. Events listener endpoint. The value will populated + after provisioning the events listener. + type: string + status: + $ref: '#/components/schemas/GoogleCloudConnectorsV1EventingStatus' + description: Output only. Current status of eventing. + readOnly: true + webhookData: + description: Output only. Webhook data. + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudConnectorsV1EventingRuntimeDataWebhookData + type: object + description: >- + Eventing runtime data has the details related to eventing managed by the + system. + parameters: + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + x-stackQL-resources: + callback: + id: google.integrations.callback + name: callback + title: Callback + methods: + callback_generate_token: + operation: + $ref: '#/paths/~1v1~1callback:generateToken/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + connector_platform_regions: + id: google.integrations.connector_platform_regions + name: connector_platform_regions + title: Connector_platform_regions + methods: connector_platform_regions_enumerate: operation: - $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' + $ref: '#/paths/~1v1~1connectorPlatformRegions:enumerate/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + clientmetadata: + id: google.integrations.clientmetadata + name: clientmetadata + title: Clientmetadata + methods: + projects_get_clientmetadata: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata + insert: [] + update: [] + replace: [] + delete: [] + clients: + id: google.integrations.clients + name: clients + title: Clients + methods: + projects_locations_get_clients: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_switch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_deprovision: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_provision: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_switch_variable_masking: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_clients_replace: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/clients/methods/projects_locations_clients_replace + delete: [] + auth_configs: + id: google.integrations.auth_configs + name: auth_configs + title: Auth_configs + methods: + projects_locations_auth_configs_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.authConfigs + projects_locations_auth_configs_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_auth_configs_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_auth_configs_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - callback: - id: google.integrations.callback - name: callback - title: Callback - methods: - callback_generate_token: + projects_locations_auth_configs_patch: operation: - $ref: '#/paths/~1v1~1callback:generateToken/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - clients: - id: google.integrations.clients - name: clients - title: Clients - methods: - projects_locations_get_clients: + projects_locations_products_auth_configs_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_replace: + projects_locations_products_auth_configs_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:replace/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_deprovision: + objectKey: $.authConfigs + projects_locations_products_auth_configs_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:deprovision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch: + projects_locations_products_auth_configs_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switch/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_provision: + projects_locations_products_auth_configs_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:provision/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_clients_switch_variable_masking: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list + insert: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create + update: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete + - $ref: >- + #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete + connections_connection_schema_metadata: + id: google.integrations.connections_connection_schema_metadata + name: connections_connection_schema_metadata + title: Connections_connection_schema_metadata + methods: + projects_locations_connections_get_connection_schema_metadata: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clients:switchVariableMasking/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/clients/methods/projects_locations_get_clients + #/components/x-stackQL-resources/connections_connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata insert: [] update: [] + replace: [] delete: [] - integrations: - id: google.integrations.integrations - name: integrations - title: Integrations + connections: + id: google.integrations.connections + name: connections + title: Connections methods: - projects_locations_integrations_schedule: + projects_locations_connections_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_delete: + objectKey: $.connections + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list + insert: [] + update: [] + replace: [] + delete: [] + runtime_action_schemas: + id: google.integrations.runtime_action_schemas + name: runtime_action_schemas + title: Runtime_action_schemas + methods: + projects_locations_connections_runtime_action_schemas_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.runtimeActionSchemas + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list + insert: [] + update: [] + replace: [] + delete: [] + runtime_entity_schemas: + id: google.integrations.runtime_entity_schemas + name: runtime_entity_schemas + title: Runtime_entity_schemas + methods: + projects_locations_connections_runtime_entity_schemas_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_integrations_list: - operation: &ref_1 + objectKey: $.runtimeEntitySchemas + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list + insert: [] + update: [] + replace: [] + delete: [] + sfdc_instances: + id: google.integrations.sfdc_instances + name: sfdc_instances + title: Sfdc_instances + methods: + projects_locations_sfdc_instances_get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get - response: &ref_2 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_integrations_list: - operation: *ref_1 - response: *ref_2 - projects_locations_integrations_execute: + projects_locations_sfdc_instances_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_test: + projects_locations_sfdc_instances_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_test: + projects_locations_sfdc_instances_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_integrations_list: - operation: &ref_3 + objectKey: $.sfdcInstances + projects_locations_sfdc_instances_create: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get - response: &ref_4 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrations - projects_locations_products_integrations_list: - operation: *ref_3 - response: *ref_4 - projects_locations_products_integrations_schedule: + projects_locations_products_sfdc_instances_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_execute: + projects_locations_products_sfdc_instances_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list - - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list - insert: [] - update: [] - delete: - - $ref: >- - #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete - skip_this_resource: - id: google.integrations.skip_this_resource - name: skip_this_resource - title: Skip_this_resource - methods: - projects_locations_integrations_execute_event: + objectKey: $.sfdcInstances + projects_locations_products_sfdc_instances_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - executions: - id: google.integrations.executions - name: executions - title: Executions - methods: - projects_locations_integrations_executions_download: + projects_locations_products_sfdc_instances_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_integrations_executions_list: - operation: &ref_5 + projects_locations_products_sfdc_instances_get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get - response: &ref_6 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.executions - projects_locations_integrations_executions_list: - operation: *ref_5 - response: *ref_6 - projects_locations_integrations_executions_get: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create + update: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete + - $ref: >- + #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete + sfdc_channels: + id: google.integrations.sfdc_channels + name: sfdc_channels + title: Sfdc_channels + methods: + projects_locations_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_replay: + projects_locations_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:replay/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_download: + projects_locations_sfdc_instances_sfdc_channels_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_integrations_executions_list: - operation: &ref_7 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get - response: &ref_8 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.executions - projects_locations_products_integrations_executions_list: - operation: *ref_7 - response: *ref_8 - projects_locations_products_integrations_executions_get: + projects_locations_sfdc_instances_sfdc_channels_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_cancel: + objectKey: $.sfdcChannels + projects_locations_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:cancel/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_get - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_list - - $ref: >- - #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list - insert: [] - update: [] - delete: [] - suspensions: - id: google.integrations.suspensions - name: suspensions - title: Suspensions - methods: - _projects_locations_integrations_executions_suspensions_list: - operation: &ref_9 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_integrations_executions_suspensions_list: - operation: *ref_9 - response: *ref_10 - projects_locations_integrations_executions_suspensions_resolve: + projects_locations_products_sfdc_instances_sfdc_channels_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_executions_suspensions_lift: + objectKey: $.sfdcChannels + projects_locations_products_sfdc_instances_sfdc_channels_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_executions_suspensions_lift: + projects_locations_products_sfdc_instances_sfdc_channels_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_integrations_executions_suspensions_list: - operation: &ref_11 + projects_locations_products_sfdc_instances_sfdc_channels_delete: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get - response: &ref_12 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.suspensions - projects_locations_products_integrations_executions_suspensions_list: - operation: *ref_11 - response: *ref_12 - projects_locations_products_integrations_executions_suspensions_resolve: + projects_locations_products_sfdc_instances_sfdc_channels_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/suspensions/methods/projects_locations_products_integrations_executions_suspensions_list + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get - $ref: >- - #/components/x-stackQL-resources/suspensions/methods/projects_locations_integrations_executions_suspensions_list - insert: [] - update: [] - delete: [] - versions: - id: google.integrations.versions - name: versions - title: Versions + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list + insert: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create + update: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete + - $ref: >- + #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete + templates: + id: google.integrations.templates + name: templates + title: Templates methods: - projects_locations_integrations_versions_publish: + projects_locations_templates_unshare: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:unshare/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_upload: + projects_locations_templates_share: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:share/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_get: + projects_locations_templates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_patch: + projects_locations_templates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_delete: + projects_locations_templates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download: + projects_locations_templates_import: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:import/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_download_json_package: + projects_locations_templates_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:download/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_integrations_versions_list: - operation: &ref_13 + projects_locations_templates_search: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get - response: &ref_14 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:search/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_integrations_versions_list: - operation: *ref_13 - response: *ref_14 - projects_locations_integrations_versions_create: + projects_locations_templates_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_integrations_versions_unpublish: + objectKey: $.templates + projects_locations_templates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_download: + projects_locations_templates_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_patch: + projects_locations_templates_use: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1templates~1{templatesId}:use/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_delete: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_get + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_list + insert: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_create + update: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/templates/methods/projects_locations_templates_delete + cloud_functions: + id: google.integrations.cloud_functions + name: cloud_functions + title: Cloud_functions + methods: + projects_locations_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_get: + projects_locations_products_cloud_functions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_publish: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create + - $ref: >- + #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create + update: [] + replace: [] + delete: [] + integrations: + id: google.integrations.integrations + name: integrations + title: Integrations + methods: + projects_locations_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_upload: + projects_locations_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_unpublish: + projects_locations_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_integrations_versions_list: - operation: &ref_15 + objectKey: $.integrations + projects_locations_integrations_schedule: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get - response: &ref_16 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:schedule/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.integrationVersions - projects_locations_products_integrations_versions_list: - operation: *ref_15 - response: *ref_16 - projects_locations_products_integrations_versions_create: + projects_locations_integrations_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_integrations_versions_takeover_edit_lock: + projects_locations_products_integrations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations/get response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list - insert: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create - update: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_patch - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete - - $ref: >- - #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete - auth_configs: - id: google.integrations.auth_configs - name: auth_configs - title: Auth_configs - methods: - projects_locations_auth_configs_get: + objectKey: $.integrations + projects_locations_products_integrations_execute: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:execute/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_patch: + projects_locations_products_integrations_test: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:test/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_delete: + projects_locations_products_integrations_schedule: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}:schedule/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_auth_configs_create: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/projects_locations_products_integrations_list + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_list + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/projects_locations_integrations_delete + skip_this_resource: + id: google.integrations.skip_this_resource + name: skip_this_resource + title: Skip_this_resource + methods: + projects_locations_integrations_execute_event: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}:executeEvent/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_auth_configs_list: - operation: &ref_17 + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + executions: + id: google.integrations.executions + name: executions + title: Executions + methods: + projects_locations_integrations_executions_get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authConfigs/get - response: &ref_18 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_auth_configs_list: - operation: *ref_17 - response: *ref_18 - _projects_locations_products_auth_configs_list: - operation: &ref_19 + projects_locations_integrations_executions_download: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/get - response: &ref_20 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.authConfigs - projects_locations_products_auth_configs_list: - operation: *ref_19 - response: *ref_20 - projects_locations_products_auth_configs_create: + projects_locations_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_delete: + objectKey: $.executions + projects_locations_products_integrations_executions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_patch: + projects_locations_products_integrations_executions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_auth_configs_get: + objectKey: $.executions + projects_locations_products_integrations_executions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1authConfigs~1{authConfigsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}/get response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_get - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_get - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_list - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_list - insert: - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_create - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_create - update: - - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_patch + #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_get - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_patch - delete: + #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_get - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_products_auth_configs_delete + #/components/x-stackQL-resources/executions/methods/projects_locations_products_integrations_executions_list - $ref: >- - #/components/x-stackQL-resources/auth_configs/methods/projects_locations_auth_configs_delete - connections_connection_schema_metadata: - id: google.integrations.connections_connection_schema_metadata - name: connections_connection_schema_metadata - title: Connections_connection_schema_metadata + #/components/x-stackQL-resources/executions/methods/projects_locations_integrations_executions_list + insert: [] + update: [] + replace: [] + delete: [] + suspensions: + id: google.integrations.suspensions + name: suspensions + title: Suspensions methods: - projects_locations_connections_get_connection_schema_metadata: + projects_locations_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1connectionSchemaMetadata/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections_connection_schema_metadata/methods/projects_locations_connections_get_connection_schema_metadata - insert: [] - update: [] - delete: [] - connections: - id: google.integrations.connections - name: connections - title: Connections - methods: - _projects_locations_connections_list: - operation: &ref_21 + projects_locations_integrations_executions_suspensions_lift: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections/get - response: &ref_22 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.connections - projects_locations_connections_list: - operation: *ref_21 - response: *ref_22 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/connections/methods/projects_locations_connections_list - insert: [] - update: [] - delete: [] - runtime_action_schemas: - id: google.integrations.runtime_action_schemas - name: runtime_action_schemas - title: Runtime_action_schemas - methods: - _projects_locations_connections_runtime_action_schemas_list: - operation: &ref_23 + projects_locations_integrations_executions_suspensions_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeActionSchemas/get - response: &ref_24 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeActionSchemas - projects_locations_connections_runtime_action_schemas_list: - operation: *ref_23 - response: *ref_24 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_action_schemas/methods/projects_locations_connections_runtime_action_schemas_list - insert: [] - update: [] - delete: [] - runtime_entity_schemas: - id: google.integrations.runtime_entity_schemas - name: runtime_entity_schemas - title: Runtime_entity_schemas - methods: - _projects_locations_connections_runtime_entity_schemas_list: - operation: &ref_25 + objectKey: $.suspensions + projects_locations_products_integrations_executions_suspensions_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connections~1{connectionsId}~1runtimeEntitySchemas/get - response: &ref_26 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.runtimeEntitySchemas - projects_locations_connections_runtime_entity_schemas_list: - operation: *ref_25 - response: *ref_26 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/runtime_entity_schemas/methods/projects_locations_connections_runtime_entity_schemas_list - insert: [] - update: [] - delete: [] - cloud_functions: - id: google.integrations.cloud_functions - name: cloud_functions - title: Cloud_functions - methods: - projects_locations_cloud_functions_create: + objectKey: $.suspensions + projects_locations_products_integrations_executions_suspensions_resolve: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:resolve/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_cloud_functions_create: + projects_locations_products_integrations_executions_suspensions_lift: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1cloudFunctions/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1executions~1{executionsId}~1suspensions~1{suspensionsId}:lift/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: + select: - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_products_cloud_functions_create + #/components/x-stackQL-resources/suspensions/methods/projects_locations_products_integrations_executions_suspensions_list - $ref: >- - #/components/x-stackQL-resources/cloud_functions/methods/projects_locations_cloud_functions_create + #/components/x-stackQL-resources/suspensions/methods/projects_locations_integrations_executions_suspensions_list + insert: [] update: [] + replace: [] delete: [] - sfdc_instances: - id: google.integrations.sfdc_instances - name: sfdc_instances - title: Sfdc_instances + versions: + id: google.integrations.versions + name: versions + title: Versions methods: - _projects_locations_sfdc_instances_list: - operation: &ref_27 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/get - response: &ref_28 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_sfdc_instances_list: - operation: *ref_27 - response: *ref_28 - projects_locations_sfdc_instances_create: + projects_locations_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_delete: + projects_locations_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_patch: + projects_locations_integrations_versions_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_get: + projects_locations_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_get: + objectKey: $.integrationVersions + projects_locations_integrations_versions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_patch: + projects_locations_integrations_versions_download_json_package: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:downloadJsonPackage/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_delete: + projects_locations_integrations_versions_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_sfdc_instances_list: - operation: &ref_29 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/get - response: &ref_30 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.sfdcInstances - projects_locations_products_sfdc_instances_list: - operation: *ref_29 - response: *ref_30 - projects_locations_products_sfdc_instances_create: + projects_locations_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_get - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_list - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_list - insert: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_create - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_create - update: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_patch - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_products_sfdc_instances_delete - - $ref: >- - #/components/x-stackQL-resources/sfdc_instances/methods/projects_locations_sfdc_instances_delete - sfdc_channels: - id: google.integrations.sfdc_channels - name: sfdc_channels - title: Sfdc_channels - methods: - projects_locations_sfdc_instances_sfdc_channels_create: + projects_locations_integrations_versions_publish: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_sfdc_instances_sfdc_channels_list: - operation: &ref_31 + projects_locations_products_integrations_versions_publish: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get - response: &ref_32 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:publish/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_sfdc_instances_sfdc_channels_list: - operation: *ref_31 - response: *ref_32 - projects_locations_sfdc_instances_sfdc_channels_delete: + projects_locations_products_integrations_versions_download: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:download/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_patch: + projects_locations_products_integrations_versions_upload: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions:upload/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_sfdc_instances_sfdc_channels_get: + projects_locations_products_integrations_versions_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_create: + projects_locations_products_integrations_versions_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_products_integrations_versions_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}/patch response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_sfdc_instances_sfdc_channels_list: - operation: &ref_33 + projects_locations_products_integrations_versions_takeover_edit_lock: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels/get - response: &ref_34 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:takeoverEditLock/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.sfdcChannels - projects_locations_products_sfdc_instances_sfdc_channels_list: - operation: *ref_33 - response: *ref_34 - projects_locations_products_sfdc_instances_sfdc_channels_patch: + projects_locations_products_integrations_versions_unpublish: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions~1{versionsId}:unpublish/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_get: + projects_locations_products_integrations_versions_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_sfdc_instances_sfdc_channels_delete: + objectKey: $.integrationVersions + projects_locations_products_integrations_versions_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1sfdcInstances~1{sfdcInstancesId}~1sfdcChannels~1{sfdcChannelsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1integrations~1{integrationsId}~1versions/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_get + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_get - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_get + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_get - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_list + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_list - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_list + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_list insert: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_create + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_create - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_create + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_create update: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_patch + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_patch - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_patch + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_patch + replace: [] delete: - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_products_sfdc_instances_sfdc_channels_delete - - $ref: >- - #/components/x-stackQL-resources/sfdc_channels/methods/projects_locations_sfdc_instances_sfdc_channels_delete - apps_script_projects: - id: google.integrations.apps_script_projects - name: apps_script_projects - title: Apps_script_projects - methods: - projects_locations_apps_script_projects_link: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post - response: - mediaType: application/json - openAPIDocKey: '200' - projects_locations_apps_script_projects_create: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: + #/components/x-stackQL-resources/versions/methods/projects_locations_products_integrations_versions_delete - $ref: >- - #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create - update: [] - delete: [] + #/components/x-stackQL-resources/versions/methods/projects_locations_integrations_versions_delete certificates: id: google.integrations.certificates name: certificates title: Certificates methods: - projects_locations_certificates_delete: + projects_locations_products_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_get: + projects_locations_products_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_certificates_patch: + projects_locations_products_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_certificates_list: - operation: &ref_35 + projects_locations_products_certificates_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get - response: &ref_36 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates - projects_locations_certificates_list: - operation: *ref_35 - response: *ref_36 - projects_locations_certificates_create: + projects_locations_products_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_certificates_list: - operation: &ref_37 + projects_locations_certificates_list: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/get - response: &ref_38 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates - projects_locations_products_certificates_list: - operation: *ref_37 - response: *ref_38 - projects_locations_products_certificates_create: + projects_locations_certificates_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_delete: + projects_locations_certificates_patch: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/delete + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_get: + projects_locations_certificates_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_products_certificates_patch: + projects_locations_certificates_delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1certificates~1{certificatesId}/patch + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificates~1{certificatesId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -10059,10 +10368,10 @@ components: select: - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_get - - $ref: >- - #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_list + - $ref: >- + #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_get - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_list insert: @@ -10075,46 +10384,393 @@ components: #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_patch - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_products_certificates_delete - $ref: >- #/components/x-stackQL-resources/certificates/methods/projects_locations_certificates_delete - clientmetadata: - id: google.integrations.clientmetadata - name: clientmetadata - title: Clientmetadata + apps_script_projects: + id: google.integrations.apps_script_projects + name: apps_script_projects + title: Apps_script_projects methods: - projects_get_clientmetadata: + projects_locations_apps_script_projects_link: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1clientmetadata/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects:link/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_apps_script_projects_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1appsScriptProjects/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: + select: [] + insert: - $ref: >- - #/components/x-stackQL-resources/clientmetadata/methods/projects_get_clientmetadata - insert: [] + #/components/x-stackQL-resources/apps_script_projects/methods/projects_locations_apps_script_projects_create update: [] + replace: [] delete: [] paths: - /v1/connectorPlatformRegions:enumerate: - parameters: &ref_39 - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/alt' + /v1/callback:generateToken: + parameters: &ref_1 - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/prettyPrint' + get: + description: >- + Receives the auth code and auth config id to combine that with the + client id and secret to retrieve access tokens from the token endpoint. + Returns either a success or error message when it's done. + operationId: integrations.callback.generateToken + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse + parameters: + - in: query + name: gcpProjectId + schema: + type: string + - in: query + name: code + schema: + type: string + - in: query + name: state + schema: + type: string + - in: query + name: redirectUri + schema: + type: string + - in: query + name: product + schema: + type: string + /v1/connectorPlatformRegions:enumerate: + parameters: *ref_1 + get: + description: Enumerates the regions for which Connector Platform is provisioned. + operationId: integrations.connectorPlatformRegions.enumerate + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse + parameters: [] + /v1/projects/{projectsId}/clientmetadata: + parameters: *ref_1 + get: + description: Gets the metadata info for the requested client + operationId: integrations.projects.getClientmetadata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients: + parameters: *ref_1 + get: + description: >- + Gets the client configuration for the given project and location + resource name + operationId: integrations.projects.locations.getClients + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: + parameters: *ref_1 + get: + description: >- + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.authConfigs.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + post: + description: >- + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: + parameters: *ref_1 + get: + description: >- + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.authConfigs.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authConfigsId + required: true + schema: + type: string + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.authConfigs.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authConfigsId + required: true + schema: + type: string + patch: + description: >- + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.authConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authConfigsId + required: true + schema: + type: string + - in: query + name: clientCertificate.encryptedPrivateKey + schema: + type: string + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: + parameters: *ref_1 get: - description: Enumerates the regions for which Connector Platform is provisioned. - operationId: integrations.connectorPlatformRegions.enumerate + description: Lists the available entities and actions associated with a Connection. + operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10127,16 +10783,28 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse - parameters: [] - /v1/callback:generateToken: - parameters: *ref_39 + #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections: + parameters: *ref_1 get: - description: >- - Receives the auth code and auth config id to combine that with the - client id and secret to retrieve access tokens from the token endpoint. - Returns either a success or error message when it's done. - operationId: integrations.callback.generateToken + description: Lists Connections in a given project and location. + operationId: integrations.projects.locations.connections.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10149,35 +10817,91 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGenerateTokenResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query - name: code + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query - name: gcpProjectId + name: pageToken schema: type: string - in: query - name: redirectUri + name: orderBy + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: + parameters: *ref_1 + get: + description: >- + Lists the JSON schemas for the inputs and outputs of actions, filtered + by action name. + operationId: integrations.projects.locations.connections.runtimeActionSchemas.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: connectionsId + required: true schema: type: string - in: query - name: state + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query - name: product + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: + parameters: *ref_1 get: description: >- - Gets the client configuration for the given project and location - resource name - operationId: integrations.projects.locations.getClients + Lists the JSON schemas for the properties of runtime entities, filtered + by entity name. + operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10190,7 +10914,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse parameters: - in: path name: projectsId @@ -10202,17 +10926,31 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: - parameters: *ref_39 - post: - description: Update run-as service account for provisioned client - operationId: integrations.projects.locations.clients.replace - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest + - in: path + name: connectionsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: + parameters: *ref_1 + get: + description: >- + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10224,7 +10962,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -10236,19 +10975,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: - parameters: *ref_39 - post: + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + patch: description: >- - Perform the deprovisioning steps to disable a user GCP project to use IP - and purge all related data in a wipeout-compliant way. - operationId: integrations.projects.locations.clients.deprovision + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10260,7 +11001,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -10272,17 +11014,19 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: - parameters: *ref_39 - post: - description: Update client from GMEK to CMEK - operationId: integrations.projects.locations.clients.switch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10306,20 +11050,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: - parameters: *ref_39 - post: + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: + parameters: *ref_1 + get: description: >- - Perform the provisioning steps to enable a user GCP project to use IP. - If GCP project already registered on IP end via Apigee Integration, - provisioning will fail. - operationId: integrations.projects.locations.clients.provision - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10331,7 +11073,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -10343,17 +11086,34 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: - parameters: *ref_39 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask post: - description: Update variable masking for provisioned client - operationId: integrations.projects.locations.clients.switchVariableMasking + description: >- + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.sfdcInstances.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10365,7 +11125,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -10377,19 +11138,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: - parameters: *ref_39 - post: + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + parameters: *ref_1 + get: description: >- - Schedules an integration for execution by passing the trigger id and the - scheduled time in the request body. - operationId: integrations.projects.locations.integrations.schedule - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10401,8 +11156,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -10415,18 +11169,25 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: - parameters: *ref_39 - post: + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + patch: description: >- - Executes an integration on receiving events from Integration Connector - triggers, Eventarc or CPS Trigger. Input data to integration is received - in body in json format - operationId: integrations.projects.locations.integrations.executeEvent + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10438,8 +11199,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -10452,19 +11212,23 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId + required: true + schema: + type: string + - in: path + name: sfdcChannelsId required: true schema: type: string - in: query - name: triggerId + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: - parameters: *ref_39 + format: google-fieldmask delete: - description: Delete the selected integration and all versions inside - operationId: integrations.projects.locations.integrations.delete + description: Deletes an sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10489,15 +11253,22 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations: - parameters: *ref_39 + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + parameters: *ref_1 get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.integrations.list + description: >- + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10510,7 +11281,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -10522,6 +11293,15 @@ paths: required: true schema: type: string + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: @@ -10532,31 +11312,20 @@ paths: schema: type: string - in: query - name: filter - schema: - type: string - - in: query - name: orderBy + name: readMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: - parameters: *ref_39 + format: google-fieldmask post: description: >- - Executes integrations synchronously by passing the trigger id in the - request body. The request is not returned until the requested executions - are either fulfilled or experienced an error. If the integration name is - not specified (passing `-`), all of the associated integration under the - given trigger_id will be executed. Otherwise only the specified - integration for the given `trigger_id` is executed. This is helpful for - execution the integration from UI. - operationId: integrations.projects.locations.integrations.execute + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. + operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10568,8 +11337,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -10582,21 +11350,25 @@ paths: schema: type: string - in: path - name: integrationsId + name: sfdcInstancesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare: + parameters: *ref_1 post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.integrations.test + description: >- + Unshare a template from given clients. Owner of the template can unshare + template with clients. Shared client can only unshare the template from + itself. PERMISSION_DENIED would be thrown if request is not from owner + or for unsharing itself. + operationId: integrations.projects.locations.templates.unshare requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaUnshareTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10608,8 +11380,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10622,15 +11393,24 @@ paths: schema: type: string - in: path - name: integrationsId + name: templatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: - parameters: *ref_39 - get: - description: Download the execution. - operationId: integrations.projects.locations.integrations.executions.download + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share: + parameters: *ref_1 + post: + description: >- + Share a template with other clients. Only the template owner can share + the templates with other projects. PERMISSION_DENIED would be thrown if + the request is not from the owner. + operationId: integrations.projects.locations.templates.share + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaShareTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10642,8 +11422,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10656,24 +11435,15 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: templatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: - parameters: *ref_39 - get: - description: >- - Lists the results of all the integration executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: integrations.projects.locations.integrations.executions.list + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}: + parameters: *ref_1 + delete: + description: Deletes a template + operationId: integrations.projects.locations.templates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10685,8 +11455,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -10699,99 +11468,54 @@ paths: schema: type: string - in: path - name: integrationsId + name: templatesId required: true schema: type: string - - in: query - name: filterParams.customFilter - schema: - type: string - - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: filterParams.parameterPairKey - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: refreshAcl - schema: - type: boolean - - in: query - name: filterParams.eventStatuses - schema: - type: string - - in: query - name: filterParams.workflowName - schema: - type: string - - in: query - name: filterParams.endTime + patch: + description: Updates the template by given id. + operationId: integrations.projects.locations.templates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' + parameters: + - in: path + name: projectsId + required: true schema: type: string - format: int64 - - in: query - name: filterParams.parameterType + - in: path + name: locationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: templatesId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + name: updateMask schema: type: string format: google-fieldmask - - in: query - name: filterParams.parameterPairValue - schema: - type: string - - in: query - name: filterParams.parameterKey - schema: - type: string - - in: query - name: filterParams.parameterValue - schema: - type: string - - in: query - name: filterParams.startTime - schema: - type: string - format: int64 - - in: query - name: filter - schema: - type: string - - in: query - name: filterParams.taskStatuses - schema: - type: string - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: snapshotMetadataWithoutParams - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: - parameters: *ref_39 get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.integrations.executions.get + description: Get a template in the specified project. + operationId: integrations.projects.locations.templates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10803,7 +11527,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -10816,28 +11540,24 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: templatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import: + parameters: *ref_1 post: description: >- - Re-execute an existing execution, with same request parameters and - execution strategy - operationId: integrations.projects.locations.integrations.executions.replay + Import the template to an existing integration. This api would keep + track of usage_count and last_used_time. PERMISSION_DENIED would be + thrown if template is not accessible by client. + operationId: integrations.projects.locations.templates.import requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10850,7 +11570,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaReplayExecutionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaImportTemplateResponse parameters: - in: path name: projectsId @@ -10863,23 +11583,17 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: templatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download: + parameters: *ref_1 get: description: >- - * Lists suspensions associated with a specific execution. Only those - with permissions to resolve the relevant suspensions will be able to - view them. - operationId: integrations.projects.locations.integrations.executions.suspensions.list + Downloads a template. Retrieves the `Template` and returns the response + as a string. + operationId: integrations.projects.locations.templates.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10892,7 +11606,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadTemplateResponse parameters: - in: path name: projectsId @@ -10905,47 +11619,21 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: executionsId + name: templatesId required: true schema: type: string - in: query - name: orderBy - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: fileFormat schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: - parameters: *ref_39 - post: + /v1/projects/{projectsId}/locations/{locationsId}/templates:search: + parameters: *ref_1 + get: description: >- - * Resolves (lifts/rejects) any number of suspensions. If the integration - is already running, only the status of the suspension is updated. - Otherwise, the suspended integration will begin execution again. - operationId: >- - integrations.projects.locations.integrations.executions.suspensions.resolve - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest + Search templates based on user query and filters. This api would query + the templates and return a list of templates based on the user filter. + operationId: integrations.projects.locations.templates.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10958,7 +11646,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaSearchTemplatesResponse parameters: - in: path name: projectsId @@ -10970,35 +11658,33 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: filter schema: type: string - - in: path - name: suspensionsId - required: true + - in: query + name: orderBy schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: - parameters: *ref_39 - post: - description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. - operationId: integrations.projects.locations.integrations.executions.suspensions.lift - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/templates: + parameters: *ref_1 + get: + description: Lists all templates matching the filter. + operationId: integrations.projects.locations.templates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11011,7 +11697,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListTemplatesResponse parameters: - in: path name: projectsId @@ -11023,38 +11709,36 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true + - in: query + name: orderBy schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: suspensionsId - required: true + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: - parameters: *ref_39 + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.integrations.versions.publish + description: Creates a new template + operationId: integrations.projects.locations.templates.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11066,8 +11750,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaTemplate' parameters: - in: path name: projectsId @@ -11079,66 +11762,21 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/templates:upload: + parameters: *ref_1 post: description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion + Uploads a template. The content can be a previously downloaded template. + Performs the same function as CreateTemplate, but accepts input in a + string format, which holds the complete representation of the Template content. - operationId: integrations.projects.locations.integrations.versions.upload + operationId: integrations.projects.locations.templates.upload requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: integrationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: - parameters: *ref_39 - get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.integrations.versions.get + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11151,7 +11789,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadTemplateResponse parameters: - in: path name: projectsId @@ -11163,25 +11801,20 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.patch + /v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use: + parameters: *ref_1 + post: + description: >- + Use the template to create integration. This api would keep track of + usage_count and last_used_time. PERMISSION_DENIED would be thrown if + template is not accessible by client. + operationId: integrations.projects.locations.templates.use requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11194,7 +11827,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaUseTemplateResponse parameters: - in: path name: projectsId @@ -11207,32 +11840,21 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: templatesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.integrations.versions.delete + /v1/projects/{projectsId}/locations/{locationsId}/clients:switch: + parameters: *ref_1 + post: + description: Update client from GMEK to CMEK + operationId: integrations.projects.locations.clients.switch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11256,23 +11878,19 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: - parameters: *ref_39 - get: + /v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision: + parameters: *ref_1 + post: description: >- - Downloads an integration. Retrieves the `IntegrationVersion` for a given - `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.integrations.versions.download + Perform the deprovisioning steps to disable a user GCP project to use IP + and purge all related data in a wipeout-compliant way. + operationId: integrations.projects.locations.clients.deprovision + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDeprovisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11284,8 +11902,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11297,34 +11914,20 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - - in: query - name: fileFormat - schema: - type: string - - in: query - name: files - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: - parameters: *ref_39 - get: + /v1/projects/{projectsId}/locations/{locationsId}/clients:provision: + parameters: *ref_1 + post: description: >- - Downloads an Integration version package like - IntegrationVersion,Integration Config etc. Retrieves the - IntegrationVersion package for a given `integration_id` and returns the - response as a JSON. - operationId: >- - integrations.projects.locations.integrations.versions.downloadJsonPackage + Perform the provisioning steps to enable a user GCP project to use IP. + If GCP project already registered on IP end via Apigee Integration, + provisioning will fail. + operationId: integrations.projects.locations.clients.provision + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaProvisionClientRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11336,8 +11939,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11349,25 +11951,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - - in: query - name: files - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: - parameters: *ref_39 - get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.integrations.versions.list + /v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking: + parameters: *ref_1 + post: + description: Update variable masking for provisioned client + operationId: integrations.projects.locations.clients.switchVariableMasking + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11379,8 +11973,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11392,42 +11985,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: fieldMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageToken - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: filter - schema: - type: string + /v1/projects/{projectsId}/locations/{locationsId}/clients:replace: + parameters: *ref_1 post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.integrations.versions.create + description: Update run-as service account for provisioned client + operationId: integrations.projects.locations.clients.replace requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11439,8 +12007,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11452,35 +12019,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: newIntegration - schema: - type: boolean - - in: query - name: createSampleIntegrations - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: + parameters: *ref_1 post: - description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.integrations.versions.unpublish + description: Creates a cloud function project. + operationId: integrations.projects.locations.cloudFunctions.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11492,7 +12041,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse parameters: - in: path name: projectsId @@ -11504,24 +12054,24 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}: - parameters: *ref_39 - get: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute: + parameters: *ref_1 + post: description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.authConfigs.get + Executes integrations synchronously by passing the trigger id in the + request body. The request is not returned until the requested executions + are either fulfilled or experienced an error. If the integration name is + not specified (passing `-`), all of the associated integration under the + given trigger_id will be executed. Otherwise only the specified + integration for the given `trigger_id` is executed. This is helpful for + execution the integration from UI. + operationId: integrations.projects.locations.integrations.execute + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11533,7 +12083,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -11546,23 +12097,18 @@ paths: schema: type: string - in: path - name: authConfigsId + name: integrationsId required: true schema: type: string - patch: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent: + parameters: *ref_1 + post: description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + Executes an integration on receiving events from Integration Connector + triggers, Eventarc or CPS Trigger. Input data to integration is received + in body in json format + operationId: integrations.projects.locations.integrations.executeEvent security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11574,7 +12120,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteEventResponse parameters: - in: path name: projectsId @@ -11587,30 +12134,25 @@ paths: schema: type: string - in: path - name: authConfigsId + name: integrationsId required: true schema: type: string - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: clientCertificate.passphrase + name: triggerId schema: type: string - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.authConfigs.delete + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test: + parameters: *ref_1 + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.integrations.test + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11622,7 +12164,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -11634,25 +12177,16 @@ paths: required: true schema: type: string - - in: path - name: authConfigsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/authConfigs: - parameters: *ref_39 - post: - description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.authConfigs.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations: + parameters: *ref_1 + get: + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11664,7 +12198,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -11677,22 +12212,35 @@ paths: schema: type: string - in: query - name: clientCertificate.encryptedPrivateKey + name: pageToken schema: type: string - in: query - name: clientCertificate.sslCertificate + name: filter schema: type: string - in: query - name: clientCertificate.passphrase + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule: + parameters: *ref_1 + post: description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.authConfigs.list + Schedules an integration for execution by passing the trigger id and the + scheduled time in the request body. + operationId: integrations.projects.locations.integrations.schedule + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11705,7 +12253,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -11717,29 +12265,16 @@ paths: required: true schema: type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: integrationsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata: - parameters: *ref_39 - get: - description: Lists the available entities and actions associated with a Connection. - operationId: integrations.projects.locations.connections.getConnectionSchemaMetadata + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}: + parameters: *ref_1 + delete: + description: Delete the selected integration and all versions inside + operationId: integrations.projects.locations.integrations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11751,8 +12286,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -11765,15 +12299,15 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}: + parameters: *ref_1 get: - description: Lists Connections in a given project and location. - operationId: integrations.projects.locations.connections.list + description: Get an execution in the specified project. + operationId: integrations.projects.locations.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11785,8 +12319,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListConnectionsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -11798,30 +12331,21 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download: + parameters: *ref_1 get: - description: >- - Lists the JSON schemas for the inputs and outputs of actions, filtered - by action name. - operationId: integrations.projects.locations.connections.runtimeActionSchemas.list + description: Download the execution. + operationId: integrations.projects.locations.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11834,7 +12358,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -11847,30 +12371,24 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: executionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions: + parameters: *ref_1 get: description: >- - Lists the JSON schemas for the properties of runtime entities, filtered - by entity name. - operationId: integrations.projects.locations.connections.runtimeEntitySchemas.list + Lists the results of all the integration executions. The response + includes the same information as the [execution + log](https://cloud.google.com/application-integration/docs/viewing-logs) + in the Integration UI. + operationId: integrations.projects.locations.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11883,7 +12401,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -11896,12 +12414,21 @@ paths: schema: type: string - in: path - name: connectionsId + name: integrationsId required: true schema: type: string - in: query - name: pageToken + name: filterParams.parameterKey + schema: + type: string + - in: query + name: filterParams.startTime + schema: + type: string + format: int64 + - in: query + name: filterParams.parameterPairValue schema: type: string - in: query @@ -11909,52 +12436,87 @@ paths: schema: type: string - in: query - name: pageSize + name: refreshAcl schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions: - parameters: *ref_39 - post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.cloudFunctions.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse - parameters: - - in: path - name: projectsId - required: true + type: boolean + - in: query + name: filterParams.executionId schema: type: string - - in: path - name: locationsId - required: true + - in: query + name: filterParams.parameterPairKey schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances: - parameters: *ref_39 - get: + - in: query + name: filterParams.customFilter + schema: + type: string + - in: query + name: truncateParams + schema: + type: boolean + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: filterParams.eventStatuses + schema: + type: string + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + - in: query + name: filterParams.endTime + schema: + type: string + format: int64 + - in: query + name: filterParams.parameterType + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: filterParams.taskStatuses + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: + parameters: *ref_1 + post: description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.list + * Resolves (lifts/rejects) any number of suspensions. If the integration + is already running, only the status of the suspension is updated. + Otherwise, the suspended integration will begin execution again. + operationId: >- + integrations.projects.locations.integrations.executions.suspensions.resolve + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11967,7 +12529,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaResolveSuspensionResponse parameters: - in: path name: projectsId @@ -11979,34 +12541,35 @@ paths: required: true schema: type: string - - in: query - name: filter + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + - in: path + name: suspensionsId + required: true schema: type: string - format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: + parameters: *ref_1 post: description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.create + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: integrations.projects.locations.integrations.executions.suspensions.lift requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12019,7 +12582,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -12031,11 +12594,29 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}: - parameters: *ref_39 - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.delete + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string + - in: path + name: suspensionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: + parameters: *ref_1 + get: + description: >- + * Lists suspensions associated with a specific execution. Only those + with permissions to resolve the relevant suspensions will be able to + view them. + operationId: integrations.projects.locations.integrations.executions.suspensions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12047,7 +12628,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSuspensionsResponse parameters: - in: path name: projectsId @@ -12060,20 +12642,37 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - patch: - description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.sfdcInstances.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + - in: path + name: executionsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}: + parameters: *ref_1 + get: + description: Get a integration in the specified project. + operationId: integrations.projects.locations.integrations.versions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12086,7 +12685,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12099,20 +12698,27 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: versionsId + required: true schema: type: string - format: google-fieldmask - get: + delete: description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.get + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12124,8 +12730,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12138,22 +12743,24 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: - parameters: *ref_39 - post: - description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.create + - in: path + name: versionsId + required: true + schema: + type: string + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12165,7 +12772,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12178,15 +12786,25 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions: + parameters: *ref_1 get: - description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.list + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12199,7 +12817,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -12212,7 +12830,7 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string @@ -12221,7 +12839,15 @@ paths: schema: type: string - in: query - name: readMask + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: fieldMask schema: type: string format: google-fieldmask @@ -12230,15 +12856,15 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: - parameters: *ref_39 - delete: - description: Deletes an sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.delete + post: + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.integrations.versions.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12250,7 +12876,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -12263,25 +12890,28 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - - in: path - name: sfdcChannelsId - required: true + - in: query + name: createSampleIntegrations schema: - type: string - patch: + type: boolean + - in: query + name: newIntegration + schema: + type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage: + parameters: *ref_1 + get: description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + Downloads an Integration version package like + IntegrationVersion,Integration Config etc. Retrieves the + IntegrationVersion package for a given `integration_id` and returns the + response as a JSON. + operationId: >- + integrations.projects.locations.integrations.versions.downloadJsonPackage security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12293,7 +12923,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse parameters: - in: path name: projectsId @@ -12306,25 +12937,35 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - in: path - name: sfdcChannelsId + name: versionsId required: true schema: type: string - in: query - name: updateMask + name: files schema: type: string - format: google-fieldmask - get: + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload: + parameters: *ref_1 + post: description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.sfdcInstances.sfdcChannels.get + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.integrations.versions.upload + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12336,7 +12977,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12349,26 +12991,26 @@ paths: schema: type: string - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + parameters: *ref_1 post: - description: Links a existing Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.link + description: >- + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.integrations.versions.unpublish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12380,8 +13022,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12393,17 +13034,33 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: - parameters: *ref_39 + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + parameters: *ref_1 post: - description: Creates an Apps Script project. - operationId: integrations.projects.locations.appsScriptProjects.create + description: >- + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.integrations.versions.publish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12416,7 +13073,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12428,11 +13085,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: - parameters: *ref_39 - delete: - description: Delete a certificate - operationId: integrations.projects.locations.certificates.delete + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download: + parameters: *ref_1 + get: + description: >- + Downloads an integration. Retrieves the `IntegrationVersion` for a given + `integration_id` and returns the response as a string. + operationId: integrations.projects.locations.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12444,7 +13113,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -12457,13 +13127,30 @@ paths: schema: type: string - in: path - name: certificatesId + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId required: true schema: type: string + - in: query + name: files + schema: + type: string + - in: query + name: fileFormat + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: + parameters: *ref_1 get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.certificates.get + description: >- + Lists all sfdc channels that match the filter. Restrict to sfdc channels + belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12475,7 +13162,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse parameters: - in: path name: projectsId @@ -12488,22 +13176,44 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId required: true schema: type: string - patch: + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + post: description: >- - Updates the certificate by id. If new certificate file is updated, it - will register with the trawler service, re-encrypt with cloud KMS and - update the Spanner record. Other fields will directly update the Spanner - record. Returns the Certificate. - operationId: integrations.projects.locations.certificates.patch + Creates an sfdc channel record. Store the sfdc channel in Spanner. + Returns the sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12515,7 +13225,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12528,22 +13238,22 @@ paths: schema: type: string - in: path - name: certificatesId + name: productsId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: sfdcInstancesId + required: true schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/certificates: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: + parameters: *ref_1 get: description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.certificates.list + Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12555,8 +13265,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12568,35 +13277,25 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: productsId + required: true schema: type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: sfdcInstancesId + required: true schema: type: string - - in: query - name: pageToken + - in: path + name: sfdcChannelsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: >- - Creates a new certificate. The certificate will be registered to the - trawler service and will be encrypted using cloud KMS and stored in - Spanner Returns the certificate. - operationId: integrations.projects.locations.certificates.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + delete: + description: Deletes an sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12608,7 +13307,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12620,13 +13319,32 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: - parameters: *ref_39 - get: + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: sfdcInstancesId + required: true + schema: + type: string + - in: path + name: sfdcChannelsId + required: true + schema: + type: string + patch: description: >- - List all the certificates that match the filter. Restrict to certificate - of current client only. - operationId: integrations.projects.locations.products.certificates.list + Updates an sfdc channel. Updates the sfdc channel in spanner. Returns + the sfdc channel. + operationId: >- + integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12638,8 +13356,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' parameters: - in: path name: projectsId @@ -12656,35 +13373,33 @@ paths: required: true schema: type: string - - in: query - name: readMask + - in: path + name: sfdcInstancesId + required: true schema: type: string - format: google-fieldmask - - in: query - name: pageToken + - in: path + name: sfdcChannelsId + required: true schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + name: updateMask schema: type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: + parameters: *ref_1 post: description: >- - Creates a new certificate. The certificate will be registered to the - trawler service and will be encrypted using cloud KMS and stored in - Spanner Returns the certificate. - operationId: integrations.projects.locations.products.certificates.create + Creates an sfdc instance record. Store the sfdc instance in Spanner. + Returns the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12696,7 +13411,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12713,11 +13429,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: - parameters: *ref_39 - delete: - description: Delete a certificate - operationId: integrations.projects.locations.products.certificates.delete + get: + description: >- + Lists all sfdc instances that match the filter. Restrict to sfdc + instances belonging to the current client only. + operationId: integrations.projects.locations.products.sfdcInstances.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12729,7 +13445,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse parameters: - in: path name: projectsId @@ -12746,14 +13463,29 @@ paths: required: true schema: type: string - - in: path - name: certificatesId - required: true + - in: query + name: pageToken schema: type: string - get: - description: Get a certificates in the specified project. - operationId: integrations.projects.locations.products.certificates.get + - in: query + name: readMask + schema: + type: string + format: google-fieldmask + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: + parameters: *ref_1 + delete: + description: Deletes an sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12765,7 +13497,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -12783,22 +13515,20 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string patch: description: >- - Updates the certificate by id. If new certificate file is updated, it - will register with the trawler service, re-encrypt with cloud KMS and - update the Spanner record. Other fields will directly update the Spanner - record. Returns the Certificate. - operationId: integrations.projects.locations.products.certificates.patch + Updates an sfdc instance. Updates the sfdc instance in spanner. Returns + the sfdc instance. + operationId: integrations.projects.locations.products.sfdcInstances.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12810,7 +13540,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12828,7 +13559,7 @@ paths: schema: type: string - in: path - name: certificatesId + name: sfdcInstancesId required: true schema: type: string @@ -12837,19 +13568,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels: - parameters: *ref_39 - post: + get: description: >- - Creates an sfdc channel record. Store the sfdc channel in Spanner. - Returns the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND + exception will be thrown. + operationId: integrations.projects.locations.products.sfdcInstances.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12861,7 +13584,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance parameters: - in: path name: projectsId @@ -12883,11 +13607,20 @@ paths: required: true schema: type: string - get: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: + parameters: *ref_1 + post: description: >- - Lists all sfdc channels that match the filter. Restrict to sfdc channels - belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.list + Creates an auth config record. Fetch corresponding credentials for + specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. + Encrypt the auth config with Cloud KMS and store the encrypted + credentials in Spanner. Returns the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12899,8 +13632,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -12917,42 +13649,23 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - in: query - name: pageToken + name: clientCertificate.sslCertificate schema: type: string - in: query - name: filter + name: clientCertificate.encryptedPrivateKey schema: type: string - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: readMask + name: clientCertificate.passphrase schema: type: string - format: google-fieldmask - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}: - parameters: *ref_39 - patch: + get: description: >- - Updates an sfdc channel. Updates the sfdc channel in spanner. Returns - the sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + Lists all auth configs that match the filter. Restrict to auth configs + belong to the current client only. + operationId: integrations.projects.locations.products.authConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12964,7 +13677,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse parameters: - in: path name: projectsId @@ -12981,26 +13695,39 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - - in: path - name: sfdcChannelsId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: readMask schema: type: string format: google-fieldmask - get: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: + parameters: *ref_1 + patch: description: >- - Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.sfdcChannels.get + Updates an auth config. If credential is updated, fetch the encrypted + auth config from Spanner, decrypt with Cloud KMS key, update the + credential fields, re-encrypt with Cloud KMS key and update the Spanner + record. For other fields, directly update the Spanner record. Returns + the encrypted auth config. + operationId: integrations.projects.locations.products.authConfigs.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13012,7 +13739,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcChannel' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13030,19 +13757,33 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: authConfigsId required: true schema: type: string - - in: path - name: sfdcChannelsId - required: true + - in: query + name: clientCertificate.encryptedPrivateKey schema: type: string - delete: - description: Deletes an sfdc channel. - operationId: >- - integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete + - in: query + name: clientCertificate.sslCertificate + schema: + type: string + - in: query + name: clientCertificate.passphrase + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: + description: >- + Gets a complete auth config. If the auth config doesn't exist, + Code.NOT_FOUND exception will be thrown. Returns the decrypted auth + config. + operationId: integrations.projects.locations.products.authConfigs.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13054,7 +13795,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' parameters: - in: path name: projectsId @@ -13072,22 +13813,13 @@ paths: schema: type: string - in: path - name: sfdcInstancesId - required: true - schema: - type: string - - in: path - name: sfdcChannelsId + name: authConfigsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}: - parameters: *ref_39 - get: - description: >- - Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND - exception will be thrown. - operationId: integrations.projects.locations.products.sfdcInstances.get + delete: + description: Deletes an auth config. + operationId: integrations.projects.locations.products.authConfigs.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13099,8 +13831,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13113,25 +13844,20 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: sfdcInstancesId - required: true - schema: - type: string - patch: - description: >- - Updates an sfdc instance. Updates the sfdc instance in spanner. Returns - the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + name: productsId + required: true + schema: + type: string + - in: path + name: authConfigsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: + parameters: *ref_1 + get: + description: Returns the list of all integrations in the specified project. + operationId: integrations.projects.locations.products.integrations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13144,7 +13870,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse parameters: - in: path name: projectsId @@ -13161,19 +13887,41 @@ paths: required: true schema: type: string - - in: path - name: sfdcInstancesId - required: true + - in: query + name: pageToken schema: type: string - in: query - name: updateMask + name: orderBy schema: type: string - format: google-fieldmask - delete: - description: Deletes an sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: + parameters: *ref_1 + post: + description: >- + Executes integrations synchronously by passing the trigger id in the + request body. The request is not returned until the requested executions + are either fulfilled or experienced an error. If the integration name is + not specified (passing `-`), all of the associated integration under the + given trigger_id will be executed. Otherwise only the specified + integration for the given `trigger_id` is executed. This is helpful for + execution the integration from UI. + operationId: integrations.projects.locations.products.integrations.execute + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13185,7 +13933,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse parameters: - in: path name: projectsId @@ -13203,17 +13952,21 @@ paths: schema: type: string - in: path - name: sfdcInstancesId + name: integrationsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances: - parameters: *ref_39 - get: - description: >- - Lists all sfdc instances that match the filter. Restrict to sfdc - instances belonging to the current client only. - operationId: integrations.projects.locations.products.sfdcInstances.list + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: + parameters: *ref_1 + post: + description: Execute the integration in draft state + operationId: integrations.projects.locations.products.integrations.test + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13226,7 +13979,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse parameters: - in: path name: projectsId @@ -13243,34 +13996,24 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filter + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: + parameters: *ref_1 post: description: >- - Creates an sfdc instance record. Store the sfdc instance in Spanner. - Returns the sfdc instance. - operationId: integrations.projects.locations.products.sfdcInstances.create + Schedules an integration for execution by passing the trigger id and the + scheduled time in the request body. + operationId: integrations.projects.locations.products.integrations.schedule requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13283,7 +14026,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaSfdcInstance + #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse parameters: - in: path name: projectsId @@ -13300,17 +14043,28 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test: - parameters: *ref_39 + - in: path + name: integrationsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: + parameters: *ref_1 post: - description: Execute the integration in draft state - operationId: integrations.projects.locations.products.integrations.test + description: >- + This RPC throws an exception if the integration is in ARCHIVED or ACTIVE + state. This RPC throws an exception if the version being published is + DRAFT, and if the `locked_by` user is not the same as the user + performing the Publish. Audit fields updated include + last_published_timestamp, last_published_by, last_modified_timestamp, + last_modified_by. Any existing lock is on this integration is released. + operationId: integrations.projects.locations.products.integrations.versions.publish requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13323,7 +14077,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTestIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse parameters: - in: path name: projectsId @@ -13345,11 +14099,18 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations: - parameters: *ref_39 + - in: path + name: versionsId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: + parameters: *ref_1 get: - description: Returns the list of all integrations in the specified project. - operationId: integrations.projects.locations.products.integrations.list + description: >- + Downloads an integration. Retrieves the `IntegrationVersion` for a given + `integration_id` and returns the response as a string. + operationId: integrations.projects.locations.products.integrations.versions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13362,7 +14123,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -13379,36 +14140,40 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: integrationsId + required: true schema: type: string - - in: query - name: orderBy + - in: path + name: versionsId + required: true schema: type: string - in: query - name: pageSize + name: files schema: - type: integer - format: int32 + type: string - in: query - name: filter + name: fileFormat schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: + parameters: *ref_1 post: description: >- - Schedules an integration for execution by passing the trigger id and the - scheduled time in the request body. - operationId: integrations.projects.locations.products.integrations.schedule + Uploads an integration. The content can be a previously downloaded + integration. Performs the same function as + CreateDraftIntegrationVersion, but accepts input in a string format, + which holds the complete representation of the IntegrationVersion + content. + operationId: integrations.projects.locations.products.integrations.versions.upload requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13421,7 +14186,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse parameters: - in: path name: projectsId @@ -13443,24 +14208,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute: - parameters: *ref_39 - post: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: + parameters: *ref_1 + delete: description: >- - Executes integrations synchronously by passing the trigger id in the - request body. The request is not returned until the requested executions - are either fulfilled or experienced an error. If the integration name is - not specified (passing `-`), all of the associated integration under the - given trigger_id will be executed. Otherwise only the specified - integration for the given `trigger_id` is executed. This is helpful for - execution the integration from UI. - operationId: integrations.projects.locations.products.integrations.execute - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest + Soft-deletes the integration. Changes the status of the integration to + ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag + is removed from this snapshot and set to the previous non-ARCHIVED + snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. + This RPC throws an exception if the version being deleted is DRAFT, and + if the `locked_by` user is not the same as the user performing the + Delete. Audit fields updated include last_modified_timestamp, + last_modified_by. Any existing lock is released when Deleting a + integration. Currently, there is no undelete mechanism. + operationId: integrations.projects.locations.products.integrations.versions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13472,8 +14233,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13495,12 +14255,62 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: - parameters: *ref_39 + - in: path + name: versionsId + required: true + schema: + type: string get: - description: Download the execution. - operationId: >- - integrations.projects.locations.products.integrations.executions.download + description: Get a integration in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: productsId + required: true + schema: + type: string + - in: path + name: integrationsId + required: true + schema: + type: string + - in: path + name: versionsId + required: true + schema: + type: string + patch: + description: Update a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13513,7 +14323,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -13536,19 +14346,39 @@ paths: schema: type: string - in: path - name: executionsId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: - parameters: *ref_39 - get: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: + parameters: *ref_1 + post: description: >- - Lists the results of all the integration executions. The response - includes the same information as the [execution - log](https://cloud.google.com/application-integration/docs/viewing-logs) - in the Integration UI. - operationId: integrations.projects.locations.products.integrations.executions.list + Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of + this integration. It then performs the same action as the + CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the + integration as a SNAPSHOT and then creates a new DRAFT version with the + `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` + set to the current timestamp). Both the `locked_by` and + `user_taking_over` are notified via email about the takeover. This RPC + throws an exception if the integration is not in DRAFT status or if the + `locked_by` and `locked_at_timestamp` fields are not set.The + TakeoverEdit lock is treated the same as an edit of the integration, and + hence shares ACLs with edit. Audit fields updated include + last_modified_timestamp, last_modified_by. + operationId: >- + integrations.projects.locations.products.integrations.versions.takeoverEditLock + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13561,7 +14391,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse parameters: - in: path name: projectsId @@ -13583,95 +14413,27 @@ paths: required: true schema: type: string - - in: query - name: truncateParams - schema: - type: boolean - - in: query - name: filterParams.parameterValue - schema: - type: string - - in: query - name: filterParams.executionId - schema: - type: string - - in: query - name: filterParams.workflowName - schema: - type: string - - in: query - name: orderBy - schema: - type: string - - in: query - name: readMask - schema: - type: string - format: google-fieldmask - - in: query - name: filterParams.parameterKey - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filterParams.endTime - schema: - type: string - format: int64 - - in: query - name: filterParams.eventStatuses - schema: - type: string - - in: query - name: filterParams.customFilter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filterParams.startTime - schema: - type: string - format: int64 - - in: query - name: filterParams.parameterPairValue - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: filterParams.parameterPairKey - schema: - type: string - - in: query - name: filterParams.taskStatuses - schema: - type: string - - in: query - name: filterParams.parameterType + - in: path + name: versionsId + required: true schema: type: string - - in: query - name: refreshAcl - schema: - type: boolean - - in: query - name: snapshotMetadataWithoutParams - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: - parameters: *ref_39 - get: - description: Get an execution in the specified project. - operationId: integrations.projects.locations.products.integrations.executions.get + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: + parameters: *ref_1 + post: + description: >- + Sets the status of the ACTIVE integration to SNAPSHOT with a new tag + "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and + "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if + the version being snapshot is not ACTIVE. Audit fields added include + action, action_by, action_timestamp. + operationId: integrations.projects.locations.products.integrations.versions.unpublish + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13683,7 +14445,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -13706,21 +14468,15 @@ paths: schema: type: string - in: path - name: executionsId + name: versionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel: - parameters: *ref_39 - post: - description: Cancellation of an execution - operationId: integrations.projects.locations.products.integrations.executions.cancel - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionRequest + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: + parameters: *ref_1 + get: + description: Returns the list of all integration versions in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13733,7 +14489,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCancelExecutionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse parameters: - in: path name: projectsId @@ -13755,26 +14511,37 @@ paths: required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: fieldMask + schema: + type: string + format: google-fieldmask + - in: query + name: filter schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: - parameters: *ref_39 post: - description: >- - * Lifts suspension for the Suspension task. Fetch corresponding - suspension with provided suspension Id, resolve suspension, and set up - suspension result for the Suspension Task. - operationId: >- - integrations.projects.locations.products.integrations.executions.suspensions.lift + description: Create a integration with a draft version in the specified project. + operationId: integrations.projects.locations.products.integrations.versions.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13787,7 +14554,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion parameters: - in: path name: projectsId @@ -13809,18 +14576,16 @@ paths: required: true schema: type: string - - in: path - name: executionsId - required: true + - in: query + name: createSampleIntegrations schema: - type: string - - in: path - name: suspensionsId - required: true + type: boolean + - in: query + name: newIntegration schema: - type: string + type: boolean /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions: - parameters: *ref_39 + parameters: *ref_1 get: description: >- * Lists suspensions associated with a specific execution. Only those @@ -13868,24 +14633,24 @@ paths: schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query name: filter schema: type: string - in: query - name: pageToken + name: orderBy schema: type: string - in: query - name: orderBy + name: pageSize schema: - type: string + type: integer + format: int32 /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve: - parameters: *ref_39 + parameters: *ref_1 post: description: >- * Resolves (lifts/rejects) any number of suspensions. If the integration @@ -13943,13 +14708,21 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download: - parameters: *ref_39 - get: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift: + parameters: *ref_1 + post: description: >- - Downloads an integration. Retrieves the `IntegrationVersion` for a given - `integration_id` and returns the response as a string. - operationId: integrations.projects.locations.products.integrations.versions.download + * Lifts suspension for the Suspension task. Fetch corresponding + suspension with provided suspension Id, resolve suspension, and set up + suspension result for the Suspension Task. + operationId: >- + integrations.projects.locations.products.integrations.executions.suspensions.lift + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -13962,7 +14735,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLiftSuspensionResponse parameters: - in: path name: projectsId @@ -13984,30 +14757,22 @@ paths: required: true schema: type: string - - in: path - name: versionsId - required: true - schema: - type: string - - in: query - name: fileFormat + - in: path + name: executionsId + required: true schema: type: string - - in: query - name: files + - in: path + name: suspensionsId + required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}: - parameters: *ref_39 - patch: - description: Update a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.patch - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download: + parameters: *ref_1 + get: + description: Download the execution. + operationId: >- + integrations.projects.locations.products.integrations.executions.download security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14020,7 +14785,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + #/components/schemas/GoogleCloudIntegrationsV1alphaDownloadExecutionResponse parameters: - in: path name: projectsId @@ -14043,27 +14808,19 @@ paths: schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions: + parameters: *ref_1 + get: description: >- - Soft-deletes the integration. Changes the status of the integration to - ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag - is removed from this snapshot and set to the previous non-ARCHIVED - snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. - This RPC throws an exception if the version being deleted is DRAFT, and - if the `locked_by` user is not the same as the user performing the - Delete. Audit fields updated include last_modified_timestamp, - last_modified_by. Any existing lock is released when Deleting a - integration. Currently, there is no undelete mechanism. - operationId: integrations.projects.locations.products.integrations.versions.delete + Lists the results of all the integration executions. The response + includes the same information as the [execution + log](https://cloud.google.com/application-integration/docs/viewing-logs) + in the Integration UI. + operationId: integrations.projects.locations.products.integrations.executions.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14075,7 +14832,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaListExecutionsResponse parameters: - in: path name: projectsId @@ -14097,14 +14855,95 @@ paths: required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: filterParams.endTime + schema: + type: string + format: int64 + - in: query + name: filterParams.parameterPairValue + schema: + type: string + - in: query + name: truncateParams + schema: + type: boolean + - in: query + name: filterParams.executionId + schema: + type: string + - in: query + name: filterParams.parameterPairKey + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string + - in: query + name: snapshotMetadataWithoutParams + schema: + type: boolean + - in: query + name: filterParams.workflowName + schema: + type: string + - in: query + name: filterParams.customFilter + schema: + type: string + - in: query + name: filterParams.taskStatuses + schema: + type: string + - in: query + name: filterParams.startTime + schema: + type: string + format: int64 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filterParams.eventStatuses + schema: + type: string + - in: query + name: filterParams.parameterType + schema: + type: string + - in: query + name: refreshAcl + schema: + type: boolean + - in: query + name: filterParams.parameterKey + schema: + type: string + - in: query + name: filterParams.parameterValue + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: readMask schema: type: string + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}: + parameters: *ref_1 get: - description: Get a integration in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.get + description: Get an execution in the specified project. + operationId: integrations.projects.locations.products.integrations.executions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14116,8 +14955,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaExecution' parameters: - in: path name: projectsId @@ -14140,27 +14978,15 @@ paths: schema: type: string - in: path - name: versionsId + name: executionsId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish: - parameters: *ref_39 - post: - description: >- - This RPC throws an exception if the integration is in ARCHIVED or ACTIVE - state. This RPC throws an exception if the version being published is - DRAFT, and if the `locked_by` user is not the same as the user - performing the Publish. Audit fields updated include - last_published_timestamp, last_published_by, last_modified_timestamp, - last_modified_by. Any existing lock is on this integration is released. - operationId: integrations.projects.locations.products.integrations.versions.publish - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}: + parameters: *ref_1 + delete: + description: Delete a certificate + operationId: integrations.projects.locations.products.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14172,8 +14998,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14191,31 +15016,13 @@ paths: schema: type: string - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload: - parameters: *ref_39 - post: - description: >- - Uploads an integration. The content can be a previously downloaded - integration. Performs the same function as - CreateDraftIntegrationVersion, but accepts input in a string format, - which holds the complete representation of the IntegrationVersion - content. - operationId: integrations.projects.locations.products.integrations.versions.upload - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest + get: + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.products.certificates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14227,8 +15034,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -14246,26 +15052,22 @@ paths: schema: type: string - in: path - name: integrationsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish: - parameters: *ref_39 - post: + patch: description: >- - Sets the status of the ACTIVE integration to SNAPSHOT with a new tag - "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and - "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if - the version being snapshot is not ACTIVE. Audit fields added include - action, action_by, action_timestamp. - operationId: integrations.projects.locations.products.integrations.versions.unpublish + Updates the certificate by id. If new certificate file is updated, it + will register with the trawler service, re-encrypt with cloud KMS and + update the Spanner record. Other fields will directly update the Spanner + record. Returns the Certificate. + operationId: integrations.projects.locations.products.certificates.patch requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14277,7 +15079,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -14295,20 +15097,22 @@ paths: schema: type: string - in: path - name: integrationsId + name: certificatesId required: true schema: type: string - - in: path - name: versionsId - required: true + - in: query + name: updateMask schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions: - parameters: *ref_39 + format: google-fieldmask + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates: + parameters: *ref_1 get: - description: Returns the list of all integration versions in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.list + description: >- + List all the certificates that match the filter. Restrict to certificate + of current client only. + operationId: integrations.projects.locations.products.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14321,7 +15125,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -14332,48 +15136,41 @@ paths: name: locationsId required: true schema: - type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: orderBy + type: string + - in: path + name: productsId + required: true schema: type: string - in: query - name: fieldMask + name: readMask schema: type: string format: google-fieldmask - in: query - name: pageToken + name: filter schema: type: string - in: query - name: filter + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string post: - description: Create a integration with a draft version in the specified project. - operationId: integrations.projects.locations.products.integrations.versions.create + description: >- + Creates a new certificate. The certificate will be registered to the + trawler service and will be encrypted using cloud KMS and stored in + Spanner Returns the certificate. + operationId: integrations.projects.locations.products.certificates.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14385,8 +15182,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaIntegrationVersion + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -14403,43 +15199,17 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: query - name: newIntegration - schema: - type: boolean - - in: query - name: createSampleIntegrations - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: + parameters: *ref_1 post: - description: >- - Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of - this integration. It then performs the same action as the - CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the - integration as a SNAPSHOT and then creates a new DRAFT version with the - `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` - set to the current timestamp). Both the `locked_by` and - `user_taking_over` are notified via email about the takeover. This RPC - throws an exception if the integration is not in DRAFT status or if the - `locked_by` and `locked_at_timestamp` fields are not set.The - TakeoverEdit lock is treated the same as an edit of the integration, and - hence shares ACLs with edit. Audit fields updated include - last_modified_timestamp, last_modified_by. - operationId: >- - integrations.projects.locations.products.integrations.versions.takeoverEditLock + description: Creates a cloud function project. + operationId: integrations.projects.locations.products.cloudFunctions.create requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14452,7 +15222,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse parameters: - in: path name: projectsId @@ -14469,23 +15239,13 @@ paths: required: true schema: type: string - - in: path - name: integrationsId - required: true - schema: - type: string - - in: path - name: versionsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/certificates: + parameters: *ref_1 get: description: >- - Lists all auth configs that match the filter. Restrict to auth configs - belong to the current client only. - operationId: integrations.projects.locations.products.authConfigs.list + List all the certificates that match the filter. Restrict to certificate + of current client only. + operationId: integrations.projects.locations.certificates.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14498,7 +15258,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaListAuthConfigsResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaListCertificatesResponse parameters: - in: path name: projectsId @@ -14510,41 +15270,35 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - in: query - name: readMask + name: pageToken schema: type: string - format: google-fieldmask - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: filter schema: type: string - in: query - name: pageSize + name: readMask schema: - type: integer - format: int32 + type: string + format: google-fieldmask post: description: >- - Creates an auth config record. Fetch corresponding credentials for - specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. - Encrypt the auth config with Cloud KMS and store the encrypted - credentials in Spanner. Returns the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.create + Creates a new certificate. The certificate will be registered to the + trawler service and will be encrypted using cloud KMS and stored in + Spanner Returns the certificate. + operationId: integrations.projects.locations.certificates.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14556,7 +15310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -14568,28 +15322,20 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}: - parameters: *ref_39 - delete: - description: Deletes an auth config. - operationId: integrations.projects.locations.products.authConfigs.delete + /v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}: + parameters: *ref_1 + patch: + description: >- + Updates the certificate by id. If new certificate file is updated, it + will register with the trawler service, re-encrypt with cloud KMS and + update the Spanner record. Other fields will directly update the Spanner + record. Returns the Certificate. + operationId: integrations.projects.locations.certificates.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14601,7 +15347,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -14614,28 +15360,18 @@ paths: schema: type: string - in: path - name: productsId + name: certificatesId required: true schema: type: string - - in: path - name: authConfigsId - required: true + - in: query + name: updateMask schema: type: string - patch: - description: >- - Updates an auth config. If credential is updated, fetch the encrypted - auth config from Spanner, decrypt with Cloud KMS key, update the - credential fields, re-encrypt with Cloud KMS key and update the Spanner - record. For other fields, directly update the Spanner record. Returns - the encrypted auth config. - operationId: integrations.projects.locations.products.authConfigs.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + format: google-fieldmask + get: + description: Get a certificates in the specified project. + operationId: integrations.projects.locations.certificates.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14647,7 +15383,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaCertificate' parameters: - in: path name: projectsId @@ -14660,38 +15396,13 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: authConfigsId + name: certificatesId required: true schema: type: string - - in: query - name: clientCertificate.sslCertificate - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - - in: query - name: clientCertificate.passphrase - schema: - type: string - - in: query - name: clientCertificate.encryptedPrivateKey - schema: - type: string - get: - description: >- - Gets a complete auth config. If the auth config doesn't exist, - Code.NOT_FOUND exception will be thrown. Returns the decrypted auth - config. - operationId: integrations.projects.locations.products.authConfigs.get + delete: + description: Delete a certificate + operationId: integrations.projects.locations.certificates.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14703,7 +15414,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudIntegrationsV1alphaAuthConfig' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: projectsId @@ -14716,26 +15427,21 @@ paths: schema: type: string - in: path - name: productsId - required: true - schema: - type: string - - in: path - name: authConfigsId + name: certificatesId required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions: - parameters: *ref_39 + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link: + parameters: *ref_1 post: - description: Creates a cloud function project. - operationId: integrations.projects.locations.products.cloudFunctions.create + description: Links a existing Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.link requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14748,7 +15454,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse parameters: - in: path name: projectsId @@ -14760,16 +15466,17 @@ paths: required: true schema: type: string - - in: path - name: productsId - required: true - schema: - type: string - /v1/projects/{projectsId}/clientmetadata: - parameters: *ref_39 - get: - description: Gets the metadata info for the requested client - operationId: integrations.projects.getClientmetadata + /v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects: + parameters: *ref_1 + post: + description: Creates an Apps Script project. + operationId: integrations.projects.locations.appsScriptProjects.create + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -14782,10 +15489,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudIntegrationsV1alphaGetClientMetadataResponse + #/components/schemas/GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml b/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml index 67469dd5..93397643 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/jobs.yaml @@ -9,8 +9,8 @@ info: Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. version: v4 - x-discovery-doc-revision: '20240404' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240620' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/talent-solution/job-search/docs/ servers: @@ -2830,169 +2830,6 @@ components: type: array items: $ref: '#/components/schemas/JobResult' - MendelDebugInput: - id: MendelDebugInput - description: >- - Message representing input to a Mendel server for debug forcing. See - go/mendel-debug-forcing for more details. Next ID: 2 - type: object - properties: - namespacedDebugInput: - description: >- - When a request spans multiple servers, a MendelDebugInput may travel - with the request and take effect in all the servers. This field is a - map of namespaces to NamespacedMendelDebugInput protos. In a single - server, up to two NamespacedMendelDebugInput protos are applied: 1. - NamespacedMendelDebugInput with the global namespace (key == ""). 2. - NamespacedMendelDebugInput with the server's namespace. When both - NamespacedMendelDebugInput protos are present, they are merged. See - go/mendel-debug-forcing for more details. - type: object - additionalProperties: - $ref: '#/components/schemas/NamespacedDebugInput' - NamespacedDebugInput: - id: NamespacedDebugInput - description: 'Next ID: 16' - type: object - properties: - forcedFlags: - description: >- - Flags to force in a particular experiment state. Map from flag name - to flag value. - type: object - additionalProperties: - type: string - forcedRollouts: - description: >- - Rollouts to force in a particular experiment state. Map from rollout - name to rollout value. - type: object - additionalProperties: - type: boolean - absolutelyForcedExps: - description: >- - Set of experiment ids to be absolutely forced. These ids will be - forced without evaluating the conditions. - type: array - items: - type: integer - format: int32 - conditionallyForcedExps: - description: >- - Set of experiment ids to be conditionally forced. These ids will be - forced only if their conditions and their parent domain's conditions - are true. - type: array - items: - type: integer - format: int32 - absolutelyForcedExpTags: - description: >- - Set of experiment tags to be absolutely forced. The experiments with - these tags will be forced without evaluating the conditions. - type: array - items: - type: string - conditionallyForcedExpTags: - description: >- - Set of experiment tags to be conditionally forced. The experiments - with these tags will be forced only if their conditions and their - parent domain's conditions are true. - type: array - items: - type: string - absolutelyForcedExpNames: - description: >- - Set of experiment names to be absolutely forced. These experiments - will be forced without evaluating the conditions. - type: array - items: - type: string - conditionallyForcedExpNames: - description: >- - Set of experiment names to be conditionally forced. These - experiments will be forced only if their conditions and their parent - domain's conditions are true. - type: array - items: - type: string - disableOrganicSelection: - description: >- - If true, disable organic experiment selection (at all diversion - points). Organic selection means experiment selection process based - on traffic allocation and diversion condition evaluation. This does - not disable selection of forced experiments. This is useful in cases - when it is not known whether experiment selection behavior is - responsible for a error or breakage. Disabling organic selection may - help to isolate the cause of a given problem. Setting this field to - false does not change anything in the experiment selection process. - type: boolean - disableManualEnrollmentSelection: - description: >- - If true, disable manual enrollment selection (at all diversion - points). Manual enrollment selection means experiment selection - process based on the request's manual enrollment states (a.k.a. - opt-in experiments). This does not disable selection of forced - experiments. Setting this field to false does not change anything in - the experiment selection process. - type: boolean - disableAutomaticEnrollmentSelection: - description: >- - If true, disable automatic enrollment selection (at all diversion - points). Automatic enrollment selection means experiment selection - process based on the experiment's automatic enrollment condition. - This does not disable selection of forced experiments. Setting this - field to false does not change anything in the experiment selection - process. - type: boolean - disableExps: - description: >- - Set of experiment ids to be disabled. If an experiment is disabled, - it is never selected nor forced. If an aggregate experiment is - disabled, its partitions are disabled together. If an experiment - with an enrollment is disabled, the enrollment is disabled together. - If an ID corresponds to a domain, the domain itself and all - descendant experiments and domains are disabled together. - type: array - items: - type: integer - format: int32 - disableExpNames: - description: >- - Set of experiment names to be disabled. If an experiment is - disabled, it is never selected nor forced. If an aggregate - experiment is disabled, its partitions are disabled together. If an - experiment with an enrollment is disabled, the enrollment is - disabled together. If a name corresponds to a domain, the domain - itself and all descendant experiments and domains are disabled - together. - type: array - items: - type: string - disableExpTags: - description: >- - Set of experiment tags to be disabled. All experiments that are - tagged with one or more of these tags are disabled. If an experiment - is disabled, it is never selected nor forced. If an aggregate - experiment is disabled, its partitions are disabled together. If an - experiment with an enrollment is disabled, the enrollment is - disabled together. - type: array - items: - type: string - testingMode: - description: >- - Sets different testing modes. See the documentation in the - TestingMode message for more information. - type: string - enumDescriptions: - - '' - - '' - - '' - enum: - - TESTING_MODE_UNSPECIFIED - - TESTING_MODE_ALL_OFF - - TESTING_MODE_ALL_ON parameters: access_token: description: OAuth access token. @@ -3091,6 +2928,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] + replace: [] delete: [] tenants: id: google.jobs.tenants @@ -3110,16 +2948,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v4~1projects~1{projectsId}~1tenants/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tenants - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v4~1projects~1{projectsId}~1tenants~1{tenantsId}/get' @@ -3146,6 +2981,7 @@ components: - $ref: '#/components/x-stackQL-resources/tenants/methods/create' update: - $ref: '#/components/x-stackQL-resources/tenants/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tenants/methods/delete' companies: @@ -3160,17 +2996,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v4~1projects~1{projectsId}~1tenants~1{tenantsId}~1companies/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.companies - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -3200,6 +3033,7 @@ components: - $ref: '#/components/x-stackQL-resources/companies/methods/create' update: - $ref: '#/components/x-stackQL-resources/companies/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/companies/methods/delete' client_events: @@ -3219,6 +3053,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/client_events/methods/create' update: [] + replace: [] delete: [] jobs: id: google.jobs.jobs @@ -3232,17 +3067,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v4~1projects~1{projectsId}~1tenants~1{tenantsId}~1jobs/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - list: - operation: *ref_5 - response: *ref_6 batch_create: operation: $ref: >- @@ -3305,13 +3137,17 @@ components: - $ref: '#/components/x-stackQL-resources/jobs/methods/list' insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' + - $ref: '#/components/x-stackQL-resources/jobs/methods/batch_create' update: - $ref: '#/components/x-stackQL-resources/jobs/methods/patch' + - $ref: '#/components/x-stackQL-resources/jobs/methods/batch_update' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' + - $ref: '#/components/x-stackQL-resources/jobs/methods/batch_delete' paths: /v4/projects/{projectsId}/operations/{operationsId}: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3357,7 +3193,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}:completeQuery: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Completes the specified prefix with keyword suggestions. Intended for @@ -3416,7 +3252,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a new tenant entity. operationId: jobs.projects.tenants.create @@ -3482,7 +3318,7 @@ paths: type: integer format: int32 /v4/projects/{projectsId}/tenants/{tenantsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Retrieves specified tenant. operationId: jobs.projects.tenants.get @@ -3584,7 +3420,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/companies: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a new company entity. operationId: jobs.projects.tenants.companies.create @@ -3664,7 +3500,7 @@ paths: schema: type: boolean /v4/projects/{projectsId}/tenants/{tenantsId}/companies/{companiesId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Retrieves specified company. operationId: jobs.projects.tenants.companies.get @@ -3783,7 +3619,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/clientEvents: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Report events issued when end user interacts with customer's application @@ -3827,7 +3663,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/jobs: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Creates a new job. Typically, the job becomes searchable within 10 @@ -3913,7 +3749,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/jobs:batchCreate: - parameters: *ref_7 + parameters: *ref_1 post: description: Begins executing a batch create jobs operation. operationId: jobs.projects.tenants.jobs.batchCreate @@ -3950,7 +3786,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/jobs/{jobsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Retrieves the specified job, whose status is OPEN or recently EXPIRED @@ -4073,7 +3909,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/jobs:batchUpdate: - parameters: *ref_7 + parameters: *ref_1 post: description: Begins executing a batch update jobs operation. operationId: jobs.projects.tenants.jobs.batchUpdate @@ -4110,7 +3946,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/jobs:batchDelete: - parameters: *ref_7 + parameters: *ref_1 post: description: Begins executing a batch delete jobs operation. operationId: jobs.projects.tenants.jobs.batchDelete @@ -4147,7 +3983,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/jobs:search: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Searches for jobs using the provided SearchJobsRequest. This call @@ -4187,7 +4023,7 @@ paths: schema: type: string /v4/projects/{projectsId}/tenants/{tenantsId}/jobs:searchForAlert: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Searches for jobs using the provided SearchJobsRequest. This API call is diff --git a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml index 64815059..700ccac8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/kmsinventory.yaml @@ -7,8 +7,8 @@ info: title: KMS Inventory API description: '' version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/kms/ servers: @@ -35,303 +35,234 @@ components: scopes: *ref_0 schemas: GoogleCloudKmsV1KeyOperationAttestationCertificateChains: + id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains description: >- Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. type: object - id: GoogleCloudKmsV1KeyOperationAttestationCertificateChains properties: + googleCardCerts: + type: array + description: Google card certificate chain corresponding to the attestation. + items: + type: string googlePartitionCerts: items: type: string description: Google partition certificate chain corresponding to the attestation. type: array - googleCardCerts: - type: array - description: Google card certificate chain corresponding to the attestation. + caviumCerts: items: type: string - caviumCerts: + type: array description: Cavium certificate chain corresponding to the attestation. + GoogleCloudKmsV1ExternalProtectionLevelOptions: + properties: + ekmConnectionKeyPath: + description: >- + The path to the external key material on the EKM when using + EkmConnection e.g., "v0/my/key". Set this field instead of + external_key_uri when using an EkmConnection. + type: string + externalKeyUri: + type: string + description: >- + The URI for an external resource that this CryptoKeyVersion + represents. + id: GoogleCloudKmsV1ExternalProtectionLevelOptions + type: object + description: >- + ExternalProtectionLevelOptions stores a group of additional fields for + configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. + GoogleCloudKmsV1KeyAccessJustificationsPolicy: + description: >- + A KeyAccessJustificationsPolicy specifies zero or more allowed + AccessReason values for encrypt, decrypt, and sign operations on a + CryptoKey. + id: GoogleCloudKmsV1KeyAccessJustificationsPolicy + type: object + properties: + allowedAccessReasons: + description: >- + The list of allowed reasons for access to a CryptoKey. Zero allowed + access reasons means all encrypt, decrypt, and sign operations for + the CryptoKey associated with this policy will fail. type: array items: type: string + enumDescriptions: + - Unspecified access reason. + - Customer-initiated support. + - >- + Google-initiated access for system management and + troubleshooting. + - >- + Google-initiated access in response to a legal request or legal + process. + - >- + Google-initiated access for security, fraud, abuse, or + compliance purposes. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer. + - No reason is expected for this key request. + - >- + Customer uses their account to perform any access to their own + data which their IAM policy authorizes, and one of the following + is true: * A Google administrator has reset the root-access + account associated with the user's organization within the past + 7 days. * A Google-initiated emergency access operation has + interacted with a resource in the same project or folder as the + currently accessed resource within the past 7 days. + - >- + Google systems access customer data to help optimize the + structure of the data or quality for future uses by the + customer, and one of the following is true: * A Google + administrator has reset the root-access account associated with + the user's organization within the past 7 days. * A + Google-initiated emergency access operation has interacted with + a resource in the same project or folder as the currently + accessed resource within the past 7 days. + - Google-initiated access to maintain system reliability. + - >- + One of the following operations is being executed while + simultaneously encountering an internal technical issue which + prevented a more precise justification code from being + generated: * Your account has been used to perform any access to + your own data which your IAM policy authorizes. * An automated + Google system operates on encrypted customer data which your IAM + policy authorizes. * Customer-initiated Google support access. * + Google-initiated support access to protect system reliability. + enum: + - REASON_UNSPECIFIED + - CUSTOMER_INITIATED_SUPPORT + - GOOGLE_INITIATED_SERVICE + - THIRD_PARTY_DATA_REQUEST + - GOOGLE_INITIATED_REVIEW + - CUSTOMER_INITIATED_ACCESS + - GOOGLE_INITIATED_SYSTEM_OPERATION + - REASON_NOT_EXPECTED + - MODIFIED_CUSTOMER_INITIATED_ACCESS + - MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION + - GOOGLE_RESPONSE_TO_PRODUCTION_ALERT + - CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING GoogleCloudKmsInventoryV1ProtectedResource: + id: GoogleCloudKmsInventoryV1ProtectedResource type: object properties: - createTime: + name: type: string - readOnly: true - format: google-datetime description: >- - Output only. The time at which this resource was created. The - granularity is in seconds. Timestamp.nanos will always be 0. - projectId: + The full resource name of the resource. Example: + `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. + labels: + description: A key-value pair of the resource's labels (v1) to their values. + additionalProperties: + type: string + type: object + cryptoKeyVersion: type: string - description: The ID of the project that owns the resource. - cryptoKeyVersions: - type: array description: >- - The names of the Cloud KMS + The name of the Cloud KMS [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) used to protect this resource via CMEK. This field is empty if the Google Cloud product owning the resource does not provide key - versions data to Asset Inventory. The first element of this field is - stored in crypto_key_version. - items: - type: string - cloudProduct: - description: 'The Cloud product that owns the resource. Example: `compute`' + version data to Asset Inventory. If there are multiple key versions + protecting the resource, then this is same value as the first + element of crypto_key_versions. + project: + description: 'Format: `projects/{PROJECT_NUMBER}`.' type: string - name: - description: >- - The full resource name of the resource. Example: - `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. + projectId: type: string - location: + description: The ID of the project that owns the resource. + resourceType: type: string + description: 'Example: `compute.googleapis.com/Disk`' + location: description: >- Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`. - resourceType: - description: 'Example: `compute.googleapis.com/Disk`' type: string - cryptoKeyVersion: + cryptoKeyVersions: + type: array description: >- - The name of the Cloud KMS + The names of the Cloud KMS [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) used to protect this resource via CMEK. This field is empty if the Google Cloud product owning the resource does not provide key - version data to Asset Inventory. If there are multiple key versions - protecting the resource, then this is same value as the first - element of crypto_key_versions. - type: string - project: - description: 'Format: `projects/{PROJECT_NUMBER}`.' - type: string - labels: - description: A key-value pair of the resource's labels (v1) to their values. - type: object - additionalProperties: + versions data to Asset Inventory. The first element of this field is + stored in crypto_key_version. + items: type: string - description: Metadata about a resource protected by a Cloud KMS key. - id: GoogleCloudKmsInventoryV1ProtectedResource - GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: - properties: - nextPageToken: + createTime: description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted, there are no subsequent pages. - type: string - protectedResources: - description: Protected resources for this page. - items: - $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource' - type: array - description: Response message for KeyTrackingService.SearchProtectedResources. - id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse - type: object - GoogleCloudKmsV1KeyOperationAttestation: - description: >- - Contains an HSM-generated attestation about a key operation. For more - information, see [Verifying attestations] - (https://cloud.google.com/kms/docs/attest-key). - id: GoogleCloudKmsV1KeyOperationAttestation - properties: - format: - enum: - - ATTESTATION_FORMAT_UNSPECIFIED - - CAVIUM_V1_COMPRESSED - - CAVIUM_V2_COMPRESSED + Output only. The time at which this resource was created. The + granularity is in seconds. Timestamp.nanos will always be 0. readOnly: true - description: Output only. The format of the attestation data. - enumDescriptions: - - Not specified. - - >- - Cavium HSM attestation compressed with gzip. Note that this format - is defined by Cavium and subject to change at any time. See - https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. - - >- - Cavium HSM attestation V2 compressed with gzip. This is a new - format introduced in Cavium's version 3.2-08. type: string - certChains: - $ref: >- - #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains - readOnly: true - description: >- - Output only. The certificate chains needed to validate the - attestation - content: - readOnly: true - format: byte - description: >- - Output only. The attestation data provided by the HSM when the key - operation was performed. + format: google-datetime + cloudProduct: type: string - type: object + description: 'The Cloud product that owns the resource. Example: `compute`' + description: Metadata about a resource protected by a Cloud KMS key. GoogleCloudKmsInventoryV1ProtectedResourcesSummary: id: GoogleCloudKmsInventoryV1ProtectedResourcesSummary + type: object + description: >- + Aggregate information about the resources protected by a Cloud KMS key + in the same Cloud organization as the key. properties: - resourceTypes: - type: object - additionalProperties: - type: string - format: int64 - description: >- - The number of resources protected by the key grouped by resource - type. - resourceCount: - format: int64 - description: >- - The total number of protected resources in the same Cloud - organization as the key. - type: string name: description: >- The full name of the ProtectedResourcesSummary resource. Example: projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary type: string - cloudProducts: + projectCount: + type: integer description: >- - The number of resources protected by the key grouped by Cloud - product. + The number of distinct Cloud projects in the same Cloud organization + as the key that have resources protected by the key. + format: int32 + resourceTypes: + type: object + description: >- + The number of resources protected by the key grouped by resource + type. + additionalProperties: + format: int64 + type: string + cloudProducts: additionalProperties: format: int64 type: string type: object - projectCount: - format: int32 description: >- - The number of distinct Cloud projects in the same Cloud organization - as the key that have resources protected by the key. - type: integer + The number of resources protected by the key grouped by Cloud + product. + resourceCount: + description: >- + The total number of protected resources in the same Cloud + organization as the key. + type: string + format: int64 locations: - description: The number of resources protected by the key grouped by region. + type: object additionalProperties: format: int64 type: string - type: object - description: >- - Aggregate information about the resources protected by a Cloud KMS key - in the same Cloud organization as the key. - type: object - GoogleCloudKmsV1CryptoKeyVersion: + description: The number of resources protected by the key grouped by region. + GoogleCloudKmsV1CryptoKeyVersionTemplate: type: object + id: GoogleCloudKmsV1CryptoKeyVersionTemplate properties: - destroyTime: - format: google-datetime - readOnly: true - description: >- - Output only. The time this CryptoKeyVersion's key material is - scheduled for destruction. Only present if state is - DESTROY_SCHEDULED. - type: string - reimportEligible: - type: boolean - readOnly: true - description: >- - Output only. Whether or not this key version is eligible for - reimport, by being specified as a target in - ImportCryptoKeyVersionRequest.crypto_key_version. - externalProtectionLevelOptions: - description: >- - ExternalProtectionLevelOptions stores a group of additional fields - for configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. - $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' - importFailureReason: - type: string - readOnly: true - description: >- - Output only. The root cause of the most recent import failure. Only - present if state is IMPORT_FAILED. - importTime: - format: google-datetime - type: string - readOnly: true - description: >- - Output only. The time at which this CryptoKeyVersion's key material - was most recently imported. - state: - description: The current state of the CryptoKeyVersion. - enum: - - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED - - PENDING_GENERATION - - ENABLED - - DISABLED - - DESTROYED - - DESTROY_SCHEDULED - - PENDING_IMPORT - - IMPORT_FAILED - - GENERATION_FAILED - - PENDING_EXTERNAL_DESTRUCTION - - EXTERNAL_DESTRUCTION_FAILED - enumDescriptions: - - Not specified. - - >- - This version is still being generated. It may not be used, - enabled, disabled, or destroyed yet. Cloud KMS will automatically - mark this version ENABLED as soon as the version is ready. - - This version may be used for cryptographic operations. - - >- - This version may not be used, but the key material is still - available, and the version can be placed back into the ENABLED - state. - - >- - This version is destroyed, and the key material is no longer - stored. This version may only become ENABLED again if this version - is reimport_eligible and the original key material is reimported - with a call to KeyManagementService.ImportCryptoKeyVersion. - - >- - This version is scheduled for destruction, and will be destroyed - soon. Call RestoreCryptoKeyVersion to put it back into the - DISABLED state. - - >- - This version is still being imported. It may not be used, enabled, - disabled, or destroyed yet. Cloud KMS will automatically mark this - version ENABLED as soon as the version is ready. - - >- - This version was not imported successfully. It may not be used, - enabled, disabled, or destroyed. The submitted key material has - been discarded. Additional details can be found in - CryptoKeyVersion.import_failure_reason. - - >- - This version was not generated successfully. It may not be used, - enabled, disabled, or destroyed. Additional details can be found - in CryptoKeyVersion.generation_failure_reason. - - >- - This version was destroyed, and it may not be used or enabled - again. Cloud KMS is waiting for the corresponding key material - residing in an external key manager to be destroyed. - - >- - This version was destroyed, and it may not be used or enabled - again. However, Cloud KMS could not confirm that the corresponding - key material residing in an external key manager was destroyed. - Additional details can be found in - CryptoKeyVersion.external_destruction_failure_reason. - type: string - name: - description: >- - Output only. The resource name for this CryptoKeyVersion in the - format - `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. - type: string - readOnly: true - attestation: - description: >- - Output only. Statement that was generated and signed by the HSM at - key creation time. Use this statement to verify attributes of the - key as stored on the HSM, independently of Google. Only provided for - key versions with protection_level HSM. - readOnly: true - $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' - algorithm: - description: >- - Output only. The CryptoKeyVersionAlgorithm that this - CryptoKeyVersion supports. - type: string + algorithm: enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -369,6 +300,12 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION + type: string + description: >- + Required. Algorithm to use when creating a CryptoKeyVersion based on + this template. For backwards compatibility, + GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted + and CryptoKey.purpose is ENCRYPT_DECRYPT. enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -418,109 +355,103 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - readOnly: true protectionLevel: - enumDescriptions: - - Not specified. - - Crypto operations are performed in software. - - Crypto operations are performed in a Hardware Security Module. - - Crypto operations are performed by an external key manager. - - Crypto operations are performed in an EKM-over-VPC backend. - description: >- - Output only. The ProtectionLevel describing how crypto operations - are performed with this CryptoKeyVersion. enum: - PROTECTION_LEVEL_UNSPECIFIED - SOFTWARE - HSM - EXTERNAL - EXTERNAL_VPC - readOnly: true - type: string - createTime: - readOnly: true - description: Output only. The time at which this CryptoKeyVersion was created. - format: google-datetime - type: string - generationFailureReason: - readOnly: true - description: >- - Output only. The root cause of the most recent generation failure. - Only present if state is GENERATION_FAILED. - type: string - destroyEventTime: - readOnly: true - format: google-datetime - type: string - description: >- - Output only. The time this CryptoKeyVersion's key material was - destroyed. Only present if state is DESTROYED. - importJob: - description: >- - Output only. The name of the ImportJob used in the most recent - import of this CryptoKeyVersion. Only present if the underlying key - material was imported. - type: string - readOnly: true - generateTime: - readOnly: true - type: string - format: google-datetime + enumDescriptions: + - Not specified. + - Crypto operations are performed in software. + - Crypto operations are performed in a Hardware Security Module. + - Crypto operations are performed by an external key manager. + - Crypto operations are performed in an EKM-over-VPC backend. description: >- - Output only. The time this CryptoKeyVersion's key material was - generated. - externalDestructionFailureReason: + ProtectionLevel to use when creating a CryptoKeyVersion based on + this template. Immutable. Defaults to SOFTWARE. type: string - description: >- - Output only. The root cause of the most recent external destruction - failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. - readOnly: true - id: GoogleCloudKmsV1CryptoKeyVersion description: >- - A CryptoKeyVersion represents an individual cryptographic key, and the - associated key material. An ENABLED version can be used for - cryptographic operations. For security reasons, the raw cryptographic - key material represented by a CryptoKeyVersion can never be viewed or - exported. It can only be used to encrypt, decrypt, or sign data when an - authorized user or application invokes Cloud KMS. - GoogleCloudKmsInventoryV1ListCryptoKeysResponse: + A CryptoKeyVersionTemplate specifies the properties to use when creating + a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or + automatically as a result of auto-rotation. + GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse: + description: Response message for KeyTrackingService.SearchProtectedResources. + type: object + id: GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse properties: - cryptoKeys: - description: The list of CryptoKeys. - type: array - items: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' nextPageToken: description: >- - The page token returned from the previous response if the next page - is desired. + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted, there are no subsequent pages. type: string - description: Response message for KeyDashboardService.ListCryptoKeys. - id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse - type: object + protectedResources: + items: + $ref: '#/components/schemas/GoogleCloudKmsInventoryV1ProtectedResource' + description: Protected resources for this page. + type: array GoogleCloudKmsV1CryptoKey: type: object - id: GoogleCloudKmsV1CryptoKey description: >- A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations. properties: name: - readOnly: true type: string description: >- Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. - purpose: + readOnly: true + importOnly: + type: boolean + description: Immutable. Whether this key may contain imported versions only. + destroyScheduledDuration: + format: google-duration type: string - enum: - - CRYPTO_KEY_PURPOSE_UNSPECIFIED - - ENCRYPT_DECRYPT - - ASYMMETRIC_SIGN - - ASYMMETRIC_DECRYPT - - RAW_ENCRYPT_DECRYPT - - MAC + description: >- + Immutable. The period of time that versions of this key spend in the + DESTROY_SCHEDULED state before transitioning to DESTROYED. If not + specified at creation time, the default duration is 30 days. + keyAccessJustificationsPolicy: + description: >- + Optional. The policy used for Key Access Justifications Policy + Enforcement. If this field is present and this key is enrolled in + Key Access Justifications Policy Enforcement, the policy will be + evaluated in encrypt, decrypt, and sign operations, and the + operation will fail if rejected by the policy. The policy is defined + by specifying zero or more allowed justification codes. + https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes + By default, this field is absent, and all justification codes are + allowed. + $ref: '#/components/schemas/GoogleCloudKmsV1KeyAccessJustificationsPolicy' + labels: + type: object + additionalProperties: + type: string + description: >- + Labels with user-defined metadata. For more information, see + [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). + primary: + description: >- + Output only. A copy of the "primary" CryptoKeyVersion that will be + used by Encrypt when this CryptoKey is given in EncryptRequest.name. + The CryptoKey's primary version can be updated via + UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may + have a primary. For other keys, this field will be omitted. + readOnly: true + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' + rotationPeriod: + description: >- + next_rotation_time will be advanced by this period when the service + automatically rotates a key. Must be at least 24 hours and at most + 876,000 hours. If rotation_period is set, next_rotation_time must + also be set. Keys with purpose ENCRYPT_DECRYPT support automatic + rotation. For other keys, this field must be omitted. + format: google-duration + type: string + purpose: description: Immutable. The immutable purpose of this CryptoKey. enumDescriptions: - Not specified. @@ -537,8 +468,25 @@ components: symmetric encryption and does not support automatic CryptoKey rotation. - CryptoKeys with this purpose may be used with MacSign. - cryptoKeyBackend: + enum: + - CRYPTO_KEY_PURPOSE_UNSPECIFIED + - ENCRYPT_DECRYPT + - ASYMMETRIC_SIGN + - ASYMMETRIC_DECRYPT + - RAW_ENCRYPT_DECRYPT + - MAC type: string + nextRotationTime: + type: string + format: google-datetime + description: >- + At next_rotation_time, the Key Management Service will + automatically: 1. Create a new version of this CryptoKey. 2. Mark + the new version as primary. Key rotations performed manually via + CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not + affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support + automatic rotation. For other keys, this field must be omitted. + cryptoKeyBackend: description: >- Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this @@ -548,13 +496,12 @@ components: format `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. - labels: - type: object - additionalProperties: - type: string - description: >- - Labels with user-defined metadata. For more information, see - [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). + type: string + createTime: + type: string + description: Output only. The time at which this CryptoKey was created. + readOnly: true + format: google-datetime versionTemplate: description: >- A template describing settings for new CryptoKeyVersion instances. @@ -562,57 +509,186 @@ components: CreateCryptoKeyVersion or auto-rotation are controlled by this template. $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersionTemplate' - nextRotationTime: + id: GoogleCloudKmsV1CryptoKey + GoogleCloudKmsV1KeyOperationAttestation: + description: >- + Contains an HSM-generated attestation about a key operation. For more + information, see [Verifying attestations] + (https://cloud.google.com/kms/docs/attest-key). + type: object + properties: + content: type: string + format: byte + readOnly: true description: >- - At next_rotation_time, the Key Management Service will - automatically: 1. Create a new version of this CryptoKey. 2. Mark - the new version as primary. Key rotations performed manually via - CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not - affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support - automatic rotation. For other keys, this field must be omitted. + Output only. The attestation data provided by the HSM when the key + operation was performed. + format: + description: Output only. The format of the attestation data. + enum: + - ATTESTATION_FORMAT_UNSPECIFIED + - CAVIUM_V1_COMPRESSED + - CAVIUM_V2_COMPRESSED + readOnly: true + enumDescriptions: + - Not specified. + - >- + Cavium HSM attestation compressed with gzip. Note that this format + is defined by Cavium and subject to change at any time. See + https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html. + - >- + Cavium HSM attestation V2 compressed with gzip. This is a new + format introduced in Cavium's version 3.2-08. + type: string + certChains: + $ref: >- + #/components/schemas/GoogleCloudKmsV1KeyOperationAttestationCertificateChains + description: >- + Output only. The certificate chains needed to validate the + attestation + readOnly: true + id: GoogleCloudKmsV1KeyOperationAttestation + GoogleCloudKmsInventoryV1ListCryptoKeysResponse: + id: GoogleCloudKmsInventoryV1ListCryptoKeysResponse + type: object + description: Response message for KeyDashboardService.ListCryptoKeys. + properties: + nextPageToken: + type: string + description: >- + The page token returned from the previous response if the next page + is desired. + cryptoKeys: + description: The list of CryptoKeys. + items: + $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKey' + type: array + GoogleCloudKmsV1CryptoKeyVersion: + type: object + description: >- + A CryptoKeyVersion represents an individual cryptographic key, and the + associated key material. An ENABLED version can be used for + cryptographic operations. For security reasons, the raw cryptographic + key material represented by a CryptoKeyVersion can never be viewed or + exported. It can only be used to encrypt, decrypt, or sign data when an + authorized user or application invokes Cloud KMS. + id: GoogleCloudKmsV1CryptoKeyVersion + properties: + generateTime: + type: string + description: >- + Output only. The time this CryptoKeyVersion's key material was + generated. + readOnly: true format: google-datetime - importOnly: + reimportEligible: + description: >- + Output only. Whether or not this key version is eligible for + reimport, by being specified as a target in + ImportCryptoKeyVersionRequest.crypto_key_version. + readOnly: true type: boolean - description: Immutable. Whether this key may contain imported versions only. - rotationPeriod: - format: google-duration + importJob: + readOnly: true type: string description: >- - next_rotation_time will be advanced by this period when the service - automatically rotates a key. Must be at least 24 hours and at most - 876,000 hours. If rotation_period is set, next_rotation_time must - also be set. Keys with purpose ENCRYPT_DECRYPT support automatic - rotation. For other keys, this field must be omitted. - destroyScheduledDuration: + Output only. The name of the ImportJob used in the most recent + import of this CryptoKeyVersion. Only present if the underlying key + material was imported. + importTime: description: >- - Immutable. The period of time that versions of this key spend in the - DESTROY_SCHEDULED state before transitioning to DESTROYED. If not - specified at creation time, the default duration is 24 hours. + Output only. The time at which this CryptoKeyVersion's key material + was most recently imported. + format: google-datetime type: string - format: google-duration - createTime: - description: Output only. The time at which this CryptoKey was created. + readOnly: true + name: + description: >- + Output only. The resource name for this CryptoKeyVersion in the + format + `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. + type: string + readOnly: true + importFailureReason: + readOnly: true + description: >- + Output only. The root cause of the most recent import failure. Only + present if state is IMPORT_FAILED. type: string + generationFailureReason: + type: string + description: >- + Output only. The root cause of the most recent generation failure. + Only present if state is GENERATION_FAILED. readOnly: true + state: + enumDescriptions: + - Not specified. + - >- + This version is still being generated. It may not be used, + enabled, disabled, or destroyed yet. Cloud KMS will automatically + mark this version ENABLED as soon as the version is ready. + - This version may be used for cryptographic operations. + - >- + This version may not be used, but the key material is still + available, and the version can be placed back into the ENABLED + state. + - >- + This version is destroyed, and the key material is no longer + stored. This version may only become ENABLED again if this version + is reimport_eligible and the original key material is reimported + with a call to KeyManagementService.ImportCryptoKeyVersion. + - >- + This version is scheduled for destruction, and will be destroyed + soon. Call RestoreCryptoKeyVersion to put it back into the + DISABLED state. + - >- + This version is still being imported. It may not be used, enabled, + disabled, or destroyed yet. Cloud KMS will automatically mark this + version ENABLED as soon as the version is ready. + - >- + This version was not imported successfully. It may not be used, + enabled, disabled, or destroyed. The submitted key material has + been discarded. Additional details can be found in + CryptoKeyVersion.import_failure_reason. + - >- + This version was not generated successfully. It may not be used, + enabled, disabled, or destroyed. Additional details can be found + in CryptoKeyVersion.generation_failure_reason. + - >- + This version was destroyed, and it may not be used or enabled + again. Cloud KMS is waiting for the corresponding key material + residing in an external key manager to be destroyed. + - >- + This version was destroyed, and it may not be used or enabled + again. However, Cloud KMS could not confirm that the corresponding + key material residing in an external key manager was destroyed. + Additional details can be found in + CryptoKeyVersion.external_destruction_failure_reason. + description: The current state of the CryptoKeyVersion. + type: string + enum: + - CRYPTO_KEY_VERSION_STATE_UNSPECIFIED + - PENDING_GENERATION + - ENABLED + - DISABLED + - DESTROYED + - DESTROY_SCHEDULED + - PENDING_IMPORT + - IMPORT_FAILED + - GENERATION_FAILED + - PENDING_EXTERNAL_DESTRUCTION + - EXTERNAL_DESTRUCTION_FAILED + destroyEventTime: format: google-datetime - primary: - $ref: '#/components/schemas/GoogleCloudKmsV1CryptoKeyVersion' description: >- - Output only. A copy of the "primary" CryptoKeyVersion that will be - used by Encrypt when this CryptoKey is given in EncryptRequest.name. - The CryptoKey's primary version can be updated via - UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may - have a primary. For other keys, this field will be omitted. + Output only. The time this CryptoKeyVersion's key material was + destroyed. Only present if state is DESTROYED. readOnly: true - GoogleCloudKmsV1CryptoKeyVersionTemplate: - properties: + type: string algorithm: - description: >- - Required. Algorithm to use when creating a CryptoKeyVersion based on - this template. For backwards compatibility, - GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted - and CryptoKey.purpose is ENCRYPT_DECRYPT. + type: string enum: - CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED - GOOGLE_SYMMETRIC_ENCRYPTION @@ -650,6 +726,7 @@ components: - HMAC_SHA512 - HMAC_SHA224 - EXTERNAL_SYMMETRIC_ENCRYPTION + readOnly: true enumDescriptions: - Not specified. - Creates symmetric encryption keys. @@ -699,74 +776,104 @@ components: - >- Algorithm representing symmetric encryption by an external key manager. - type: string + description: >- + Output only. The CryptoKeyVersionAlgorithm that this + CryptoKeyVersion supports. protectionLevel: + enum: + - PROTECTION_LEVEL_UNSPECIFIED + - SOFTWARE + - HSM + - EXTERNAL + - EXTERNAL_VPC + readOnly: true enumDescriptions: - Not specified. - Crypto operations are performed in software. - Crypto operations are performed in a Hardware Security Module. - Crypto operations are performed by an external key manager. - Crypto operations are performed in an EKM-over-VPC backend. + type: string description: >- - ProtectionLevel to use when creating a CryptoKeyVersion based on - this template. Immutable. Defaults to SOFTWARE. + Output only. The ProtectionLevel describing how crypto operations + are performed with this CryptoKeyVersion. + externalProtectionLevelOptions: + $ref: '#/components/schemas/GoogleCloudKmsV1ExternalProtectionLevelOptions' + description: >- + ExternalProtectionLevelOptions stores a group of additional fields + for configuring a CryptoKeyVersion that are specific to the EXTERNAL + protection level and EXTERNAL_VPC protection levels. + externalDestructionFailureReason: + readOnly: true + description: >- + Output only. The root cause of the most recent external destruction + failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. type: string - enum: - - PROTECTION_LEVEL_UNSPECIFIED - - SOFTWARE - - HSM - - EXTERNAL - - EXTERNAL_VPC - type: object - description: >- - A CryptoKeyVersionTemplate specifies the properties to use when creating - a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or - automatically as a result of auto-rotation. - id: GoogleCloudKmsV1CryptoKeyVersionTemplate - GoogleCloudKmsV1ExternalProtectionLevelOptions: - id: GoogleCloudKmsV1ExternalProtectionLevelOptions - properties: - ekmConnectionKeyPath: + createTime: + readOnly: true + description: Output only. The time at which this CryptoKeyVersion was created. type: string + format: google-datetime + attestation: + readOnly: true + $ref: '#/components/schemas/GoogleCloudKmsV1KeyOperationAttestation' description: >- - The path to the external key material on the EKM when using - EkmConnection e.g., "v0/my/key". Set this field instead of - external_key_uri when using an EkmConnection. - externalKeyUri: - type: string + Output only. Statement that was generated and signed by the HSM at + key creation time. Use this statement to verify attributes of the + key as stored on the HSM, independently of Google. Only provided for + key versions with protection_level HSM. + destroyTime: + readOnly: true + format: google-datetime description: >- - The URI for an external resource that this CryptoKeyVersion - represents. - description: >- - ExternalProtectionLevelOptions stores a group of additional fields for - configuring a CryptoKeyVersion that are specific to the EXTERNAL - protection level and EXTERNAL_VPC protection levels. - type: object + Output only. The time this CryptoKeyVersion's key material is + scheduled for destruction. Only present if state is + DESTROY_SCHEDULED. + type: string parameters: + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string access_token: description: OAuth access token. in: query name: access_token schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + alt: + description: Data format for response. in: query - name: upload_protocol + name: alt schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + enum: + - json + - media + - proto + _.xgafv: + description: V1 error format. in: query - name: uploadType + name: $.xgafv schema: type: string + enum: + - '1' + - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -776,15 +883,6 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -794,20 +892,10 @@ components: name: quotaUser schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string callback: @@ -823,22 +911,24 @@ components: schema: type: boolean x-stackQL-resources: - protected_resources: - id: google.kmsinventory.protected_resources - name: protected_resources - title: Protected_resources + crypto_keys: + id: google.kmsinventory.crypto_keys + name: crypto_keys + title: Crypto_keys methods: - search: + list: operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1protectedResources:search/get + $ref: '#/paths/~1v1~1projects~1{projectsId}~1cryptoKeys/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.cryptoKeys sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/list' insert: [] update: [] + replace: [] delete: [] crypto_keys_protected_resources_summary: id: google.kmsinventory.crypto_keys_protected_resources_summary @@ -858,47 +948,46 @@ components: #/components/x-stackQL-resources/crypto_keys_protected_resources_summary/methods/get_protected_resources_summary insert: [] update: [] + replace: [] delete: [] - crypto_keys: - id: google.kmsinventory.crypto_keys - name: crypto_keys - title: Crypto_keys + protected_resources: + id: google.kmsinventory.protected_resources + name: protected_resources + title: Protected_resources methods: - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1cryptoKeys/get' - response: &ref_2 + search: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1protectedResources:search/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.cryptoKeys - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/crypto_keys/methods/list' + select: [] insert: [] update: [] + replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/protectedResources:search: - parameters: &ref_3 + /v1/projects/{projectsId}/cryptoKeys: + parameters: &ref_1 + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/prettyPrint' get: description: >- - Returns metadata about the resources protected by the given Cloud KMS - CryptoKey in the given Cloud organization. - operationId: kmsinventory.organizations.protectedResources.search + Returns cryptographic keys managed by Cloud KMS in a given Cloud + project. Note that this data is sourced from snapshots, meaning it may + not completely reflect the actual state of key metadata at call time. + operationId: kmsinventory.projects.cryptoKeys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -911,19 +1000,15 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse + #/components/schemas/GoogleCloudKmsInventoryV1ListCryptoKeysResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: query - name: cryptoKey - schema: - type: string - - in: query - name: resourceTypes + name: pageToken schema: type: string - in: query @@ -931,12 +1016,8 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/protectedResourcesSummary: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Returns aggregate information about the resources protected by the given @@ -979,14 +1060,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/cryptoKeys: - parameters: *ref_3 + /v1/organizations/{organizationsId}/protectedResources:search: + parameters: *ref_1 get: description: >- - Returns cryptographic keys managed by Cloud KMS in a given Cloud - project. Note that this data is sourced from snapshots, meaning it may - not completely reflect the actual state of key metadata at call time. - operationId: kmsinventory.projects.cryptoKeys.list + Returns metadata about the resources protected by the given Cloud KMS + CryptoKey in the given Cloud organization. + operationId: kmsinventory.organizations.protectedResources.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -999,19 +1079,27 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudKmsInventoryV1ListCryptoKeysResponse + #/components/schemas/GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: resourceTypes + schema: + type: string - in: query name: pageToken schema: type: string - in: query - name: pageSize + name: cryptoKey schema: - type: integer - format: int32 + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/language.yaml b/providers/src/googleapis.com/v00.00.00000/services/language.yaml index b48a7789..ccfcce53 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/language.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/language.yaml @@ -10,8 +10,8 @@ info: analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers. version: v2 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/natural-language/ servers: @@ -25,12 +25,12 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. https://www.googleapis.com/auth/cloud-language: >- Apply machine learning models to reveal the structure and meaning of text + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -40,64 +40,151 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - ModerateTextRequest: + XPSModelArtifactItem: + id: XPSModelArtifactItem type: object - id: ModerateTextRequest - properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - description: The document moderation request message. - XPSVideoObjectTrackingTrainResponse: + description: A single model artifact item. properties: - trainCostNodeSeconds: + gcsUri: + type: string description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - format: int64 + The Google Cloud Storage (GCS) uri that stores the model binary + files. + artifactFormat: + enumDescriptions: + - Should not be used. + - >- + The Tensorflow checkpoints. See + https://www.tensorflow.org/guide/checkpoint. + - The Tensorflow SavedModel binary. + - >- + Model artifact in generic TensorFlow Lite (.tflite) format. See + https://www.tensorflow.org/lite. + - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. + - >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be + used in the browser and in Node.js using JavaScript. + - >- + Used for iOS mobile devices in (.mlmodel) format. See + https://developer.apple.com/documentation/coreml + enum: + - ARTIFACT_FORMAT_UNSPECIFIED + - TF_CHECKPOINT + - TF_SAVED_MODEL + - TF_LITE + - EDGE_TPU_TF_LITE + - TF_JS + - CORE_ML + description: The model artifact format. type: string - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - exportModelSpec: - $ref: '#/components/schemas/XPSVideoExportModelSpec' - description: Populated for AutoML request only. - id: XPSVideoObjectTrackingTrainResponse + Color: + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + id: Color type: object - XPSTimestampStats: properties: - medianTimestampNanos: + blue: + type: number + description: The amount of blue in the color as a value in the interval [0, 1]. + format: float + green: + description: The amount of green in the color as a value in the interval [0, 1]. + format: float + type: number + alpha: + type: number + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + format: float + red: + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + XPSVideoTrainingOperationMetadata: + id: XPSVideoTrainingOperationMetadata + properties: + trainCostMilliNodeHour: type: string - format: int64 - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - granularStats: description: >- - The string key is the pre-defined granularity. Currently supported: - hour_of_day, day_of_week, month_of_year. Granularities finer that - the granularity of timestamp data are not populated (e.g. if - timestamps are at day granularity, then hour_of_day is not - populated). - type: object - additionalProperties: - $ref: '#/components/schemas/XPSTimestampStatsGranularStats' - id: XPSTimestampStats - description: The data statistics of a series of TIMESTAMP values. + This is an estimation of the node hours necessary for training a + model, expressed in milli node hours (i.e. 1,000 value in this field + means 1 node hour). A node hour represents the time a virtual + machine spends running your training job. The cost of one node + running for one hour is a node hour. + format: int64 type: object XPSVideoActionMetricsEntry: - description: The Evaluation metrics entry given a specific precision_window_length. - type: object id: XPSVideoActionMetricsEntry + type: object + description: The Evaluation metrics entry given a specific precision_window_length. properties: meanAveragePrecision: - type: number - description: The mean average precision. format: float + description: The mean average precision. + type: number confidenceMetricsEntries: - type: array items: $ref: >- #/components/schemas/XPSVideoActionMetricsEntryConfidenceMetricsEntry + type: array description: >- Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. @@ -110,661 +197,461 @@ components: this specific length, the prediction result is treated as a true positive. format: google-duration - XPSExportModelOutputConfig: + XPSCommonStats: + type: object + description: Common statistics for a column with a specified data type. properties: - edgeTpuTfLiteFormat: - $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' - exportFirebaseAuxiliaryInfo: - description: >- - For any model and format: If true, will additionally export - FirebaseExportedModelInfo in a firebase.txt file. - type: boolean - tfLiteFormat: - $ref: '#/components/schemas/XPSTfLiteFormat' - tfSavedModelFormat: - $ref: '#/components/schemas/XPSTfSavedModelFormat' - outputGcsUri: - description: >- - The Google Cloud Storage (GCS) directory where XPS will output the - exported models and related files. Format: gs://bucket/directory + nullValueCount: type: string - tfJsFormat: - $ref: '#/components/schemas/XPSTfJsFormat' - coreMlFormat: - $ref: '#/components/schemas/XPSCoreMlFormat' - outputGcrUri: + format: int64 + validValueCount: type: string - description: >- - The Google Contained Registry (GCR) path the exported files to be - pushed to. This location is set if the exported format is DOCKDER. - dockerFormat: - $ref: '#/components/schemas/XPSDockerFormat' - type: object - id: XPSExportModelOutputConfig - Document: + format: int64 + distinctValueCount: + format: int64 + type: string + id: XPSCommonStats + TextSpan: type: object - id: Document properties: - gcsContentUri: - description: >- - The Google Cloud Storage URI where the file content is located. This - URI must be of the form: gs://bucket_name/object_name. For more - details, see https://cloud.google.com/storage/docs/reference-uris. - NOTE: Cloud Storage object versioning is not supported. - type: string - languageCode: - description: >- - Optional. The language of the document (if not specified, the - language is automatically detected). Both ISO and BCP-47 language - codes are accepted. [Language - Support](https://cloud.google.com/natural-language/docs/languages) - lists currently supported languages for each API method. If the - language (either specified by the caller or automatically detected) - is not supported by the called API method, an `INVALID_ARGUMENT` - error is returned. + content: type: string - type: + description: The content of the text span, which is a substring of the document. + beginOffset: description: >- - Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns - an `INVALID_ARGUMENT` error. - enumDescriptions: - - The content type is not specified. - - Plain text - - HTML + The API calculates the beginning offset of the content in the + original document according to the EncodingType specified in the API + request. + type: integer + format: int32 + id: TextSpan + description: Represents a text span in the input document. + XPSTableSpec: + type: object + id: XPSTableSpec + properties: + validRowCount: + format: int64 + description: The number of valid rows. type: string - enum: - - TYPE_UNSPECIFIED - - PLAIN_TEXT - - HTML - content: - description: >- - The content of the input in string format. Cloud audit logging - exempt since it is based on user data. + columnSpecs: + description: Mapping from column id to column spec. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSColumnSpec' + rowCount: + format: int64 + description: The number of rows in the table. type: string - description: Represents the input to API methods. - XPSImageExportModelSpec: - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. - properties: - exportModelOutputConfig: - items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' - type: array - description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the GCS bucket name which is provided - via TrainRequest.gcs_bucket_name to store the model files. + importedDataSizeInBytes: + description: The total size of imported data of the table. + format: int64 + type: string + timeColumnId: + type: integer + format: int32 + description: The id of the time column. + XPSColorMapIntColor: type: object - id: XPSImageExportModelSpec - XPSSpeechPreprocessResponse: + description: RGB color and each channel is represented by an integer. + id: XPSColorMapIntColor + properties: + red: + type: integer + format: int32 + description: The value should be in range of [0, 255]. + blue: + description: The value should be in range of [0, 255]. + format: int32 + type: integer + green: + type: integer + description: The value should be in range of [0, 255]. + format: int32 + XPSBatchPredictResponse: type: object - id: XPSSpeechPreprocessResponse properties: - prebuiltModelEvaluationMetrics: - $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' - description: >- - The metrics for prebuilt speech models. They are included here - because there is no prebuilt speech models stored in the AutoML. - speechPreprocessStats: - description: Stats associated with the data. - $ref: '#/components/schemas/XPSSpeechPreprocessStats' - cnsTestDataPath: - description: Location od shards of sstables (test data) of DataUtterance protos. - type: string - cnsTrainDataPath: - type: string + exampleSet: + $ref: '#/components/schemas/XPSExampleSet' description: >- - Location of shards of sstables (training data) of DataUtterance - protos. - Entity: - id: Entity + Examples for batch prediction result. Under full API implementation, + results are stored in shared RecordIO of AnnotatedExample protobufs, + the annotations field of which is populated by XPS backend. + id: XPSBatchPredictResponse + DiskMetric: properties: - name: - type: string - description: The representative name for the entity. - sentiment: - description: >- - For calls to AnalyzeEntitySentiment or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the aggregate sentiment expressed for - this entity in the provided document. - $ref: '#/components/schemas/Sentiment' - mentions: - items: - $ref: '#/components/schemas/EntityMention' - description: >- - The mentions of this entity in the input document. The API currently - supports proper noun mentions. - type: array - type: + gibSec: + format: int64 type: string - description: The entity type. + description: Required. Seconds of physical disk usage, e.g. 3600. + diskType: enum: - - UNKNOWN - - PERSON - - LOCATION - - ORGANIZATION - - EVENT - - WORK_OF_ART - - CONSUMER_GOOD - - OTHER - - PHONE_NUMBER - - ADDRESS - - DATE - - NUMBER - - PRICE + - UNKNOWN_DISK_TYPE + - REGIONAL_SSD + - REGIONAL_STORAGE + - PD_SSD + - PD_STANDARD + - STORAGE_SNAPSHOT + description: Required. Type of Disk, e.g. REGIONAL_SSD. enumDescriptions: - - Unknown - - Person - - Location - - Organization - - Event - - Artwork - - Consumer product - - Other types of entities - - >- - Phone number The metadata lists the phone number, formatted - according to local convention, plus whichever additional elements - appear in the text: * `number` - the actual number, broken down - into sections as per local convention * `national_prefix` - - country code, if detected * `area_code` - region or area code, if - detected * `extension` - phone extension (to be dialed after - connection), if detected - - >- - Address The metadata identifies the street number and locality - plus whichever additional elements appear in the text: * - `street_number` - street number * `locality` - city or town * - `street_name` - street/route name, if detected * `postal_code` - - postal code, if detected * `country` - country, if detected * - `broad_region` - administrative area, such as the state, if - detected * `narrow_region` - smaller administrative area, such as - county, if detected * `sublocality` - used in Asian addresses to - demark a district within a city, if detected - - >- - Date The metadata identifies the components of the date: * `year` - - four digit year, if detected * `month` - two digit month number, - if detected * `day` - two digit day number, if detected - - Number The metadata is the number itself. - - Price The metadata identifies the `value` and `currency`. - metadata: - type: object - additionalProperties: - type: string + - '' + - '' + - '' + - '' + - '' + - '' + type: string + id: DiskMetric + type: object + XPSArrayStats: + id: XPSArrayStats + description: The data statistics of a series of ARRAY values. + properties: + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + memberStats: + $ref: '#/components/schemas/XPSDataStats' description: >- - Metadata associated with the entity. For the metadata associated - with other entity types, see the Type table below. - description: >- - Represents a phrase in the text that is a known entity, such as a - person, an organization, or location. The API associates information, - such as probability and mentions, with entities. + Stats of all the values of all arrays, as if they were a single long + series of data. The type depends on the element type of the array. type: object - XPSEvaluationMetricsSet: - description: Specifies location of model evaluation metrics. - id: XPSEvaluationMetricsSet + XPSRow: properties: - fileSpec: - $ref: '#/components/schemas/XPSFileSpec' + values: description: >- - File spec containing evaluation metrics of a model, must point to - RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics - messages. - evaluationMetrics: + The values of the row cells, given in the same order as the + column_ids. If column_ids is not set, then in the same order as the + input_feature_column_ids in TablesModelMetadata. + items: + type: any type: array - description: >- - Inline EvaluationMetrics - should be relatively small. For passing - large quantities of exhaustive metrics, use file_spec. + columnIds: items: - $ref: '#/components/schemas/XPSEvaluationMetrics' - numEvaluationMetrics: - type: string + format: int32 + type: integer description: >- - Number of the evaluation metrics (usually one per label plus - overall). - format: int64 + The ids of the columns. Note: The below `values` field must match + order of this field, if this field is set. + type: array + id: XPSRow type: object - XPSVisualization: - id: XPSVisualization - description: Visualization configurations for image explanation. + XPSTextSentimentEvaluationMetrics: type: object - deprecated: true + description: Model evaluation metrics for text sentiment problems. properties: - type: - enumDescriptions: - - Should not be used. - - Shows which pixel contributed to the image prediction. - - >- - Shows which region contributed to the image prediction by - outlining the region. - description: >- - Type of the image visualization. Only applicable to Integrated - Gradients attribution. OUTLINES shows regions of attribution, while - PIXELS shows per-pixel attribution. Defaults to OUTLINES. - enum: - - TYPE_UNSPECIFIED - - PIXELS - - OUTLINES - type: string - polarity: + f1Score: + description: Output only. The harmonic mean of recall and precision. + format: float + type: number + linearKappa: + format: float + type: number description: >- - Whether to only highlight pixels with positive contributions, - negative or both. Defaults to POSITIVE. - type: string - enum: - - POLARITY_UNSPECIFIED - - POSITIVE - - NEGATIVE - - BOTH - enumDescriptions: - - Default value. This is the same as POSITIVE. - - >- - Highlights the pixels/outlines that were most influential to the - model's prediction. - - >- - Setting polarity to negative highlights areas that does not lead - to the models's current prediction. - - Shows both positive and negative attributions. - clipPercentLowerbound: - description: >- - Excludes attributions below the specified percentile, from the - highlighted areas. Defaults to 62. + Output only. Linear weighted kappa. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. + recall: + type: number + description: Output only. Recall. + format: float + meanSquaredError: format: float type: number - overlayType: - type: string - enum: - - OVERLAY_TYPE_UNSPECIFIED - - NONE - - ORIGINAL - - GRAYSCALE - - MASK_BLACK - enumDescriptions: - - Default value. This is the same as NONE. - - No overlay. - - The attributions are shown on top of the original image. - - >- - The attributions are shown on top of grayscaled version of the - original image. - - >- - The attributions are used as a mask to reveal predictive parts of - the image and hide the un-predictive parts. description: >- - How the original image is displayed in the visualization. Adjusting - the overlay can help increase visual clarity if the original image - makes it difficult to view the visualization. Defaults to NONE. - clipPercentUpperbound: + Output only. Mean squared error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. + meanAbsoluteError: + type: number description: >- - Excludes attributions above the specified percentile from the - highlighted areas. Using the clip_percent_upperbound and - clip_percent_lowerbound together can be useful for filtering out - noise and making it easier to see areas of strong attribution. - Defaults to 99.9. + Output only. Mean absolute error. Only set for the overall model + evaluation, not for evaluation of a single annotation spec. format: float + precision: type: number - colorMap: - type: string + format: float + description: Output only. Precision. + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' description: >- - The color scheme used for the highlighted areas. Defaults to - PINK_GREEN for Integrated Gradients attribution, which shows - positive attributions in green and negative in pink. Defaults to - VIRIDIS for XRAI attribution, which highlights the most influential - regions in yellow and the least influential in blue. - enumDescriptions: - - Should not be used. - - 'Positive: green. Negative: pink.' - - >- - Viridis color map: A perceptually uniform color mapping which is - easier to see by those with colorblindness and progresses from - yellow to green to blue. Positive: yellow. Negative: blue. - - 'Positive: red. Negative: red.' - - 'Positive: green. Negative: green.' - - 'Positive: green. Negative: red.' - - PiYG palette. - enum: - - COLOR_MAP_UNSPECIFIED - - PINK_GREEN - - VIRIDIS - - RED - - GREEN - - RED_GREEN - - PINK_WHITE_GREEN - XPSCoreMlFormat: - id: XPSCoreMlFormat - type: object - properties: {} - description: A model format used for iOS mobile devices. - EntityMention: - description: >- - Represents a mention for an entity in the text. Currently, proper noun - mentions are supported. - type: object - properties: - probability: + Output only. Confusion matrix of the evaluation. Only set for the + overall model evaluation, not for evaluation of a single annotation + spec. + quadraticKappa: description: >- - Probability score associated with the entity. The score shows the - probability of the entity mention being the entity type. The score - is in (0, 1] range. - format: float + Output only. Quadratic weighted kappa. Only set for the overall + model evaluation, not for evaluation of a single annotation spec. type: number - type: - type: string - description: The type of the entity mention. - enumDescriptions: - - Unknown - - Proper name - - Common noun (or noun compound) - enum: - - TYPE_UNKNOWN - - PROPER - - COMMON + format: float + id: XPSTextSentimentEvaluationMetrics + Sentence: + properties: text: - description: The mention text. $ref: '#/components/schemas/TextSpan' + description: The sentence text. sentiment: $ref: '#/components/schemas/Sentiment' description: >- - For calls to AnalyzeEntitySentiment or if - AnnotateTextRequest.Features.extract_entity_sentiment is set to - true, this field will contain the sentiment expressed for this - mention of the entity in the provided document. - id: EntityMention - XPSVideoExportModelSpec: - properties: - exportModelOutputConfig: - type: array - items: - $ref: '#/components/schemas/XPSExportModelOutputConfig' - description: >- - Contains the model format and internal location of the model files - to be exported/downloaded. Use the GCS bucket name which is provided - via TrainRequest.gcs_bucket_name to store the model files. - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Upon receiving - ExportModel request from user, AutoMl backend can serve the - pre-generated models to user if exists (by copying the files from - internal path to user provided location), otherwise, AutoMl backend will - call xPS ExportModel API to generate the model on the fly with the - requesting format. - type: object - id: XPSVideoExportModelSpec - XPSTfJsFormat: - properties: {} - description: >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used - in the browser and in Node.js using JavaScript. + For calls to AnalyzeSentiment or if + AnnotateTextRequest.Features.extract_document_sentiment is set to + true, this field will contain the sentiment for the sentence. type: object - id: XPSTfJsFormat - XPSColumnSpecCorrelatedColumn: - properties: - correlationStats: - $ref: '#/components/schemas/XPSCorrelationStats' - columnId: - type: integer - format: int32 + description: Represents a sentence in the input document. + id: Sentence + XPSColorMap: type: object - id: XPSColumnSpecCorrelatedColumn + id: XPSColorMap description: >- - Identifies a table's column, and its correlation with the column this - ColumnSpec describes. - XPSTablesModelStructureModelParametersParameter: - id: XPSTablesModelStructureModelParametersParameter + Map from color to display name. Will only be used by Image Segmentation + for uCAIP. properties: - floatValue: - format: double - description: Float type parameter value. - type: number - stringValue: - description: String type parameter value. - type: string - name: + intColor: + $ref: '#/components/schemas/XPSColorMapIntColor' + displayName: + description: Should be used during preprocessing. type: string - description: Parameter name. - intValue: - description: Integer type parameter value. - format: int64 + color: + description: >- + This type is deprecated in favor of the IntColor below. This is + because google.type.Color represent color has a float which + semantically does not reflect discrete classes/categories concept. + Moreover, to handle it well we need to have some tolerance when + converting to a discretized color. As such, the recommendation is to + have API surface still use google.type.Color while internally + IntColor is used. + deprecated: true + $ref: '#/components/schemas/Color' + annotationSpecIdToken: type: string + description: Should be used during training. + XPSSpeechModelSpecSubModelSpec: type: object - XPSExampleSet: - description: Set of examples or input sources. properties: - numInputSources: + isEnhancedModel: + type: boolean + description: >- + If true then it means we have an enhanced version of the biasing + models. + clientId: + description: In S3, Recognition ClientContextId.client_id type: string - description: Number of input sources. - format: int64 - fingerprint: - description: Fingerprint of the example set. - format: int64 + biasingModelType: + description: Type of the biasing model. type: string - numExamples: + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + enumDescriptions: + - '' + - Build biasing model on top of COMMAND_AND_SEARCH model + - Build biasing model on top of PHONE_CALL model + - Build biasing model on top of VIDEO model + - Build biasing model on top of DEFAULT model + contextId: type: string - format: int64 - description: Number of examples. - fileSpec: - $ref: '#/components/schemas/XPSFileSpec' - description: File spec of the examples or input sources. - id: XPSExampleSet - type: object - XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: - type: object - id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + description: In S3, Recognition ClientContextId.context_id + id: XPSSpeechModelSpecSubModelSpec + XPSTablesRegressionMetrics: properties: - recall: - type: number - description: Recall for the given confidence threshold. - format: float - f1Score: - format: float - description: The harmonic mean of recall and precision. - type: number - confidenceThreshold: - description: The confidence threshold value used to compute the metrics. - type: number - format: float - precision: - description: Precision for the given confidence threshold. - type: number - format: float - description: Metrics for a single confidence threshold. - XPSTranslationPreprocessResponse: - type: object - id: XPSTranslationPreprocessResponse - description: Translation preprocess response. - properties: - validExampleCount: - type: string - description: Total valid example count. - format: int64 - parsedExampleCount: - type: string - description: Total example count parsed. - format: int64 - XPSTablesRegressionMetrics: - description: Metrics for Tables regression problems. - id: XPSTablesRegressionMetrics - type: object - properties: - rootMeanSquaredError: + rootMeanSquaredLogError: + description: Root mean squared log error. type: number format: double - description: Root mean squared error. - rSquared: - description: R squared. - format: double - type: number meanAbsoluteError: - type: number format: double + type: number description: Mean absolute error. + rSquared: + format: double + type: number + description: R squared. regressionMetricsEntries: + items: + $ref: '#/components/schemas/XPSRegressionMetricsEntry' description: >- A list of actual versus predicted points for the model being evaluated. - items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' type: array - rootMeanSquaredLogError: - format: double - description: Root mean squared log error. - type: number meanAbsolutePercentageError: + type: number description: >- Mean absolute percentage error, only set if all of the target column's values are positive. + format: double + rootMeanSquaredError: type: number format: double - XPSFloat64Stats: - id: XPSFloat64Stats + description: Root mean squared error. type: object - description: The data statistics of a series of FLOAT64 values. + id: XPSTablesRegressionMetrics + description: Metrics for Tables regression problems. + XPSConfusionMatrix: + type: object + id: XPSConfusionMatrix properties: - mean: - description: The mean of the series. - format: double - type: number - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - histogramBuckets: + category: items: - $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' + type: integer + format: int32 type: array description: >- - Histogram buckets of the data series. Sorted by the min value of the - bucket, ascendingly, and the number of the buckets is dynamically - generated. The buckets are non-overlapping and completely cover - whole FLOAT64 range with min of first bucket being `"-Infinity"`, - and max of the last one being `"Infinity"`. - standardDeviation: - type: number - format: double - description: The standard deviation of the series. - quantiles: + Category (mainly for segmentation). Set only for image segmentation + models. Note: uCAIP Image Segmentation should use + annotation_spec_id_token. + annotationSpecIdToken: + type: array items: - type: number - format: double + type: string description: >- - Ordered from 0 to k k-quantile values of the data series of n - values. The value at index i is, approximately, the i*n/k-th - smallest value in the series; for i = 0 and i = k these are, - respectively, the min and max values. + For the following three repeated fields, only one is intended to be + set. annotation_spec_id_token is preferable to be set. ID tokens of + the annotation specs used in the confusion matrix. + sentimentLabel: + items: + format: int32 + type: integer type: array - XPSRegressionMetricsEntry: + description: >- + Sentiment labels used in the confusion matrix. Set only for text + sentiment models. For AutoML Text Revamp, use + `annotation_spec_id_token` instead and leave this field empty. + row: + type: array + description: >- + Rows in the confusion matrix. The number of rows is equal to the + size of `annotation_spec_id_token`. `row[i].value[j]` is the number + of examples that have ground truth of the + `annotation_spec_id_token[i]` and are predicted as + `annotation_spec_id_token[j]` by the model being evaluated. + items: + $ref: '#/components/schemas/XPSConfusionMatrixRow' + description: Confusion matrix of the model running the classification. + XPSResponseExplanationMetadataOutputMetadata: + type: object properties: - trueValue: - format: float + outputTensorName: + description: Name of the output tensor. Only needed in train response. + type: string + description: Metadata of the prediction output to be explained. + id: XPSResponseExplanationMetadataOutputMetadata + XPSTranslationEvaluationMetrics: + id: XPSTranslationEvaluationMetrics + description: Evaluation metrics for the dataset. + type: object + properties: + baseBleuScore: + format: double type: number - description: The actual target value for a row in the dataset. - predictedValue: - description: The observed value for a row in the dataset. + description: BLEU score for base model. + bleuScore: + description: BLEU score. type: number - format: float + format: double + XPSExportModelOutputConfig: type: object - description: A pair of actual & observed values for the model being evaluated. - id: XPSRegressionMetricsEntry - XPSDataErrors: - description: Different types of errors and the stats associatesd with each error. + id: XPSExportModelOutputConfig properties: - errorType: - description: Type of the error. - enum: - - ERROR_TYPE_UNSPECIFIED - - UNSUPPORTED_AUDIO_FORMAT - - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT - - FILE_TOO_LARGE - - MISSING_TRANSCRIPTION - enumDescriptions: - - Not specified. - - >- - Audio format not in the formats by cloud-speech AutoML. Currently - only wav and flac file formats are supported. - - >- - File format differnt from what is specified in the file name - extension. - - File too large. Maximum allowed size is 50 MB. - - Transcript is missing. + tfSavedModelFormat: + $ref: '#/components/schemas/XPSTfSavedModelFormat' + dockerFormat: + $ref: '#/components/schemas/XPSDockerFormat' + outputGcsUri: type: string - count: - type: integer + description: >- + The Google Cloud Storage (GCS) directory where XPS will output the + exported models and related files. Format: gs://bucket/directory + tfJsFormat: + $ref: '#/components/schemas/XPSTfJsFormat' + outputGcrUri: + description: >- + The Google Contained Registry (GCR) path the exported files to be + pushed to. This location is set if the exported format is DOCKDER. + type: string + edgeTpuTfLiteFormat: + $ref: '#/components/schemas/XPSEdgeTpuTfLiteFormat' + exportFirebaseAuxiliaryInfo: + type: boolean + description: >- + For any model and format: If true, will additionally export + FirebaseExportedModelInfo in a firebase.txt file. + coreMlFormat: + $ref: '#/components/schemas/XPSCoreMlFormat' + tfLiteFormat: + $ref: '#/components/schemas/XPSTfLiteFormat' + XPSIntegratedGradientsAttribution: + deprecated: true + type: object + properties: + stepCount: + description: >- + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is within the desired error range. Valid range of its value + is [1, 100], inclusively. format: int32 - description: Number of records having errors associated with the enum. - id: XPSDataErrors + type: integer + id: XPSIntegratedGradientsAttribution + description: >- + An attribution method that computes the Aumann-Shapley value taking + advantage of the model's fully differentiable structure. Refer to this + paper for more details: https://arxiv.org/abs/1703.01365 + XPSClassificationEvaluationMetrics: + description: >- + Model evaluation metrics for classification problems. It can be used for + image and video classification. Next tag: 9. type: object - XPSTextSentimentEvaluationMetrics: - description: Model evaluation metrics for text sentiment problems. + id: XPSClassificationEvaluationMetrics properties: - recall: + confidenceMetricsEntries: + type: array + items: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. + baseAuPrc: format: float - description: Output only. Recall. + description: The Area under precision recall curve metric based on priors. type: number - precision: - description: Output only. Precision. + auPrc: format: float + description: The Area under precision recall curve metric. type: number - quadraticKappa: + auRoc: format: float description: >- - Output only. Quadratic weighted kappa. Only set for the overall - model evaluation, not for evaluation of a single annotation spec. - type: number - meanSquaredError: + The Area Under Receiver Operating Characteristic curve metric. + Micro-averaged for the overall evaluation. type: number - format: float - description: >- - Output only. Mean squared error. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - meanAbsoluteError: - format: float + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' description: >- - Output only. Mean absolute error. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - type: number - linearKappa: + Confusion matrix of the evaluation. Only set for MULTICLASS + classification problems where number of annotation specs is no more + than 10. Only set for model level evaluation, not for evaluation per + label. + evaluatedExamplesCount: + description: The number of examples used for model evaluation. + format: int32 + type: integer + logLoss: format: float + description: The Log Loss metric. type: number - description: >- - Output only. Linear weighted kappa. Only set for the overall model - evaluation, not for evaluation of a single annotation spec. - f1Score: - type: number - format: float - description: Output only. The harmonic mean of recall and precision. - confusionMatrix: - description: >- - Output only. Confusion matrix of the evaluation. Only set for the - overall model evaluation, not for evaluation of a single annotation - spec. - $ref: '#/components/schemas/XPSConfusionMatrix' - type: object - id: XPSTextSentimentEvaluationMetrics XPSTablesTrainingOperationMetadata: properties: - trainingObjectivePoints: - items: - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - description: >- - This field records the training objective value with respect to - time, giving insight into how the model architecture search is - performing as training time elapses. - type: array - trainingStartTime: - type: string - description: Timestamp when training process starts. - format: google-datetime topTrials: - items: - $ref: '#/components/schemas/XPSTuningTrial' - type: array description: >- This field is for training. When the operation is terminated successfully, AutoML Backend post this field to operation metadata in spanner. If the metadata has no trials returned, the training operation is supposed to be a failure. + items: + $ref: '#/components/schemas/XPSTuningTrial' + type: array createModelStage: + description: Current stage of creating model. enum: - CREATE_MODEL_STAGE_UNSPECIFIED - DATA_PREPROCESSING @@ -778,891 +665,526 @@ components: - Training model. - Run evaluation. - Finalizing model training pipeline. - description: Current stage of creating model. - trainBudgetMilliNodeHours: - format: int64 + trainingStartTime: + description: Timestamp when training process starts. + format: google-datetime type: string - description: Creating model budget. optimizationObjective: - type: string description: The optimization objective for model. - id: XPSTablesTrainingOperationMetadata - type: object - XPSClassificationEvaluationMetrics: - properties: - auPrc: - format: float - type: number - description: The Area under precision recall curve metric. - evaluatedExamplesCount: - format: int32 - type: integer - description: The number of examples used for model evaluation. - confidenceMetricsEntries: - description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. + type: string + trainingObjectivePoints: type: array items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - confusionMatrix: - description: >- - Confusion matrix of the evaluation. Only set for MULTICLASS - classification problems where number of annotation specs is no more - than 10. Only set for model level evaluation, not for evaluation per - label. - $ref: '#/components/schemas/XPSConfusionMatrix' - auRoc: + $ref: '#/components/schemas/XPSTrainingObjectivePoint' description: >- - The Area Under Receiver Operating Characteristic curve metric. - Micro-averaged for the overall evaluation. - format: float - type: number - baseAuPrc: - description: The Area under precision recall curve metric based on priors. - type: number - format: float - logLoss: - description: The Log Loss metric. - type: number - format: float - description: >- - Model evaluation metrics for classification problems. It can be used for - image and video classification. Next tag: 9. - id: XPSClassificationEvaluationMetrics + This field records the training objective value with respect to + time, giving insight into how the model architecture search is + performing as training time elapses. + trainBudgetMilliNodeHours: + format: int64 + type: string + description: Creating model budget. type: object - XPSVideoTrainingOperationMetadata: - id: XPSVideoTrainingOperationMetadata + id: XPSTablesTrainingOperationMetadata + XPSTuningTrial: + properties: + trainingObjectivePoint: + description: The optimization objective evaluation of the eval split data. + $ref: '#/components/schemas/XPSTrainingObjectivePoint' + modelStructure: + description: Model parameters for the trial. + $ref: '#/components/schemas/XPSTablesModelStructure' + type: object + id: XPSTuningTrial + description: >- + Metrics for a tuning job generated, will get forwarded to Stackdriver as + model tuning logs. Setting this as a standalone message out of + CreateModelMetadata to avoid confusion as we expose this message only to + users. + Entity: + id: Entity type: object properties: - trainCostMilliNodeHour: - format: int64 + sentiment: + $ref: '#/components/schemas/Sentiment' description: >- - This is an estimation of the node hours necessary for training a - model, expressed in milli node hours (i.e. 1,000 value in this field - means 1 node hour). A node hour represents the time a virtual - machine spends running your training job. The cost of one node - running for one hour is a node hour. + For calls to AnalyzeEntitySentiment or if + AnnotateTextRequest.Features.extract_entity_sentiment is set to + true, this field will contain the aggregate sentiment expressed for + this entity in the provided document. + metadata: + type: object + additionalProperties: + type: string + description: >- + Metadata associated with the entity. For the metadata associated + with other entity types, see the Type table below. + name: type: string - XPSVideoModelArtifactSpec: - id: XPSVideoModelArtifactSpec - type: object + description: The representative name for the entity. + mentions: + description: >- + The mentions of this entity in the input document. The API currently + supports proper noun mentions. + items: + $ref: '#/components/schemas/EntityMention' + type: array + type: + enumDescriptions: + - Unknown + - Person + - Location + - Organization + - Event + - Artwork + - Consumer product + - Other types of entities + - >- + Phone number The metadata lists the phone number, formatted + according to local convention, plus whichever additional elements + appear in the text: * `number` - the actual number, broken down + into sections as per local convention * `national_prefix` - + country code, if detected * `area_code` - region or area code, if + detected * `extension` - phone extension (to be dialed after + connection), if detected + - >- + Address The metadata identifies the street number and locality + plus whichever additional elements appear in the text: * + `street_number` - street number * `locality` - city or town * + `street_name` - street/route name, if detected * `postal_code` - + postal code, if detected * `country` - country, if detected * + `broad_region` - administrative area, such as the state, if + detected * `narrow_region` - smaller administrative area, such as + county, if detected * `sublocality` - used in Asian addresses to + demark a district within a city, if detected + - >- + Date The metadata identifies the components of the date: * `year` + - four digit year, if detected * `month` - two digit month number, + if detected * `day` - two digit day number, if detected + - Number The metadata is the number itself. + - Price The metadata identifies the `value` and `currency`. + type: string + description: The entity type. + enum: + - UNKNOWN + - PERSON + - LOCATION + - ORGANIZATION + - EVENT + - WORK_OF_ART + - CONSUMER_GOOD + - OTHER + - PHONE_NUMBER + - ADDRESS + - DATE + - NUMBER + - PRICE + description: >- + Represents a phrase in the text that is a known entity, such as a + person, an organization, or location. The API associates information, + such as probability and mentions, with entities. + XPSImageModelArtifactSpec: + description: >- + Stores the locations and related metadata of the model artifacts. + Populated for uCAIP requests only. + id: XPSImageModelArtifactSpec properties: servingArtifact: $ref: '#/components/schemas/XPSModelArtifactItem' description: >- - The default model binary file used for serving (e.g. batch predict) - via public Cloud AI Platform API. + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud AI Platform API. + checkpointArtifact: + description: The Tensorflow checkpoint files. e.g. Used for resumable training. + $ref: '#/components/schemas/XPSModelArtifactItem' + tfJsBinaryGcsPrefix: + description: >- + GCS uri prefix of Tensorflow JavaScript binary files + 'groupX-shardXofX.bin' Deprecated. + type: string exportArtifact: + type: array + description: The model binary files in different formats for model export. items: $ref: '#/components/schemas/XPSModelArtifactItem' - description: The model binary files in different formats for model export. - type: array - ClassifyTextRequest: - id: ClassifyTextRequest - description: The document classification request message. - properties: - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - type: object - TextSpan: - id: TextSpan + labelGcsUri: + description: GCS uri of decoded labels file for model export 'dict.txt'. + type: string + tfLiteMetadataGcsUri: + description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. + type: string type: object + XPSResponseExplanationSpec: + description: >- + Specification of Model explanation. Feature-based XAI in AutoML Vision + ICN is deprecated, see b/288407203 for context. + deprecated: true + id: XPSResponseExplanationSpec properties: - content: - type: string - description: The content of the text span, which is a substring of the document. - beginOffset: + parameters: + description: Parameters that configure explaining of the Model's predictions. + $ref: '#/components/schemas/XPSResponseExplanationParameters' + explanationType: description: >- - The API calculates the beginning offset of the content in the - original document according to the EncodingType specified in the API - request. - format: int32 + Explanation type. For AutoML Image Classification models, possible + values are: * `image-integrated-gradients` * `image-xrai` + type: string + metadata: + $ref: '#/components/schemas/XPSResponseExplanationMetadata' + description: Metadata describing the Model's input and output for explanation. + type: object + XPSTablesModelStructureModelParametersParameter: + id: XPSTablesModelStructureModelParametersParameter + properties: + floatValue: + format: double + description: Float type parameter value. + type: number + intValue: + description: Integer type parameter value. + type: string + format: int64 + name: + description: Parameter name. + type: string + stringValue: + type: string + description: String type parameter value. + type: object + XPSColumnSpecCorrelatedColumn: + properties: + correlationStats: + $ref: '#/components/schemas/XPSCorrelationStats' + columnId: type: integer - description: Represents a text span in the input document. - AnalyzeSentimentResponse: + format: int32 + description: >- + Identifies a table's column, and its correlation with the column this + ColumnSpec describes. + type: object + id: XPSColumnSpecCorrelatedColumn + XPSTablesConfidenceMetricsEntry: properties: - languageCode: + precision: + type: number + format: double + description: 'Precision = #true positives / (#true positives + #false positives).' + truePositiveRate: + description: 'TPR = #true positives / (#true positives + #false negatvies)' + type: number + format: double + truePositiveCount: + description: True positive count. + format: int64 type: string + f1Score: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. + The harmonic mean of recall and precision. (2 * precision * recall) + / (precision + recall) + format: double + type: number + falseNegativeCount: + description: False negative count. + type: string + format: int64 + falsePositiveRate: + format: double + description: 'FPR = #false positives / (#false positives + #true negatives)' + type: number + falsePositiveCount: + format: int64 + type: string + description: False positive count. + trueNegativeCount: + description: True negative count. + format: int64 + type: string + recall: + description: 'Recall = #true positives / (#true positives + #false negatives).' + format: double + type: number + confidenceThreshold: + format: double + description: The confidence threshold value used to compute the metrics. + type: number + id: XPSTablesConfidenceMetricsEntry + type: object + description: Metrics for a single confidence threshold. + AnalyzeSentimentResponse: + id: AnalyzeSentimentResponse + properties: sentences: - description: The sentiment for all the sentences in the document. items: $ref: '#/components/schemas/Sentence' + description: The sentiment for all the sentences in the document. type: array languageSupported: + type: boolean description: >- Whether the language is officially supported. The API may still return a response when the language is not supported, but it is on a best effort basis. - type: boolean + languageCode: + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + type: string documentSentiment: $ref: '#/components/schemas/Sentiment' description: The overall sentiment of the input document. - id: AnalyzeSentimentResponse type: object description: The sentiment analysis response message. - XPSVideoActionRecognitionEvaluationMetrics: - properties: - evaluatedActionCount: - format: int32 - description: >- - Output only. The number of ground truth actions used to create this - evaluation. - type: integer - videoActionMetricsEntries: - items: - $ref: '#/components/schemas/XPSVideoActionMetricsEntry' - type: array - description: >- - Output only. The metric entries for precision window lengths: - 1s,2s,3s,4s, 5s. - id: XPSVideoActionRecognitionEvaluationMetrics - type: object - description: Model evaluation metrics for video action recognition. - XPSCommonStats: - id: XPSCommonStats - type: object - description: Common statistics for a column with a specified data type. + TpuMetric: properties: - distinctValueCount: - format: int64 - type: string - validValueCount: + tpuSec: + description: Required. Seconds of TPU usage, e.g. 3600. type: string format: int64 - nullValueCount: - format: int64 + tpuType: + enum: + - UNKNOWN_TPU_TYPE + - TPU_V2_POD + - TPU_V2 + - TPU_V3_POD + - TPU_V3 + - TPU_V5_LITEPOD + description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. type: string - XPSTablesPreprocessResponse: - properties: - tablesDatasetMetadata: - $ref: '#/components/schemas/XPSTablesDatasetMetadata' - description: >- - The table/column id, column_name and the DataTypes of the columns - will be populated. - id: XPSTablesPreprocessResponse + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' type: object - XPSTableSpec: - id: XPSTableSpec + id: TpuMetric + XPSTablesEvaluationMetrics: type: object + id: XPSTablesEvaluationMetrics properties: - timeColumnId: - type: integer - format: int32 - description: The id of the time column. - importedDataSizeInBytes: - description: The total size of imported data of the table. - type: string - format: int64 - columnSpecs: - additionalProperties: - $ref: '#/components/schemas/XPSColumnSpec' - type: object - description: Mapping from column id to column spec. - validRowCount: - description: The number of valid rows. - type: string - format: int64 - rowCount: - type: string - format: int64 - description: The number of rows in the table. - XPSTrackMetricsEntryConfidenceMetricsEntry: + classificationMetrics: + $ref: '#/components/schemas/XPSTablesClassificationMetrics' + description: Classification metrics. + regressionMetrics: + $ref: '#/components/schemas/XPSTablesRegressionMetrics' + description: Regression metrics. + XPSCategoryStats: + description: The data statistics of a series of CATEGORY values. type: object - description: 'Metrics for a single confidence threshold. Next tag: 6.' - id: XPSTrackMetricsEntryConfidenceMetricsEntry properties: - trackingPrecision: - format: float - description: Output only. Tracking precision. - type: number - boundingBoxIou: - description: >- - Output only. Bounding box intersection-over-union precision. - Measures how well the bounding boxes overlap between each other - (e.g. complete overlap or just barely above iou_threshold). - format: float - type: number - confidenceThreshold: - type: number - format: float - description: >- - Output only. The confidence threshold value used to compute the - metrics. - trackingRecall: - description: Output only. Tracking recall. - format: float - type: number - mismatchRate: + topCategoryStats: description: >- - Output only. Mismatch rate, which measures the tracking consistency, - i.e. correctness of instance ID continuity. - type: number - format: float - XPSResponseExplanationParameters: + The statistics of the top 20 CATEGORY values, ordered by + CategoryStats.SingleCategoryStats.count. + items: + $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' + type: array + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + id: XPSCategoryStats + XPSReportingMetrics: + type: object + id: XPSReportingMetrics properties: - xraiAttribution: - $ref: '#/components/schemas/XPSXraiAttribution' + effectiveTrainingDuration: description: >- - An attribution method that redistributes Integrated Gradients - attribution to segmented regions, taking advantage of the model's - fully differentiable structure. Refer to this paper for more - details: https://arxiv.org/abs/1906.02825 XRAI currently performs - better on natural images, like a picture of a house or an animal. If - the images are taken in artificial environments, like a lab or - manufacturing line, or from diagnostic equipment, like x-rays or - quality-control cameras, use Integrated Gradients instead. - integratedGradientsAttribution: + The effective time training used. If set, this is used for quota + management and billing. Deprecated. AutoML BE doesn't use this. + Don't set. + format: google-duration + type: string + deprecated: true + metricEntries: description: >- - An attribution method that computes Aumann-Shapley values taking - advantage of the model's fully differentiable structure. Refer to - this paper for more details: https://arxiv.org/abs/1703.01365 - $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' - type: object - deprecated: true - id: XPSResponseExplanationParameters - XPSCategoryStatsSingleCategoryStats: + One entry per metric name. The values must be aggregated per metric + name. + type: array + items: + $ref: '#/components/schemas/XPSMetricEntry' + XPSResponseExplanationMetadataInputMetadata: type: object + description: Metadata of the input of a feature. + id: XPSResponseExplanationMetadataInputMetadata properties: - value: - description: The CATEGORY value. + visualizationConfig: + $ref: '#/components/schemas/XPSVisualization' + description: Visualization configurations for image explanation. + modality: + description: >- + Modality of the feature. Valid values are: numeric, image. Defaults + to numeric. + enum: + - MODALITY_UNSPECIFIED + - NUMERIC + - IMAGE + - CATEGORICAL + enumDescriptions: + - '' + - '' + - '' + - '' type: string - count: + inputTensorName: + description: >- + Name of the input tensor for this model. Only needed in train + response. type: string - format: int64 - description: The number of occurrences of this value in the series. - id: XPSCategoryStatsSingleCategoryStats - description: The statistics of a single CATEGORY value. - XPSVideoClassificationTrainResponse: - id: XPSVideoClassificationTrainResponse - type: object + XPSDockerFormat: + description: >- + A model format used for Docker containers. Use the params field to + customize the container. The container is verified to work correctly on + ubuntu 16.04 operating system. properties: - trainCostNodeSeconds: + gpuArchitecture: + enum: + - GPU_ARCHITECTURE_UNSPECIFIED + - GPU_ARCHITECTURE_NVIDIA + description: >- + Optional. Additional gpu information describing the requirements for + the to be exported model files. + type: string + enumDescriptions: + - '' + - '' + cpuArchitecture: type: string + enum: + - CPU_ARCHITECTURE_UNSPECIFIED + - CPU_ARCHITECTURE_X86_64 + enumDescriptions: + - '' + - '' description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - format: int64 - modelArtifactSpec: - description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - XPSSpeechModelSpec: + Optional. Additional cpu information describing the requirements for + the to be exported model files. + id: XPSDockerFormat + type: object + XPSTablesModelColumnInfo: + id: XPSTablesModelColumnInfo + description: >- + An information specific to given column and Tables Model, in context of + the Model and the predictions created by it. properties: - datasetId: - type: string - format: int64 + featureImportance: + type: number + format: float description: >- - Required for speech xps backend. Speech xps has to use dataset_id - and model_id as the primary key in db so that speech API can query - the db directly. - subModelSpecs: - type: array - description: Model specs for all submodels contained in this model. - items: - $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' - language: - type: string + When given as part of a Model: Measurement of how much model + predictions correctness on the TEST data depend on values in this + column. A value between 0 and 1, higher means higher influence. + These values are normalized - for all input feature columns of a + given model they add to 1. When given back by Predict or Batch + Predict: Measurement of how impactful for the prediction returned + for the given row the value in this column was. Specifically, the + feature importance specifies the marginal contribution that the + feature made to the prediction score compared to the baseline score. + These values are computed using the Sampled Shapley method. + columnId: + type: integer + format: int32 + description: The ID of the column. type: object - id: XPSSpeechModelSpec - XPSConfusionMatrixRow: + XPSStructType: type: object + id: XPSStructType properties: - count: - type: array - items: - format: int64 - type: string - description: >- - Same as above except intended to represent other counts (for e.g. - for segmentation this is pixel count). NOTE(params): Only - example_count or count is set (oneoff does not support repeated - fields unless they are embedded inside another message). - exampleCount: - items: - format: int32 - type: integer - description: >- - Value of the specific cell in the confusion matrix. The number of - values each row has (i.e. the length of the row) is equal to the - length of the annotation_spec_id_token field. - type: array - description: A row in the confusion matrix. - id: XPSConfusionMatrixRow - XPSEdgeTpuTfLiteFormat: - description: >- - A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) - devices. + fields: + description: Unordered map of struct field names to their data types. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSDataType' + description: '`StructType` defines the DataType-s of a STRUCT type.' + ModerateTextRequest: type: object - properties: {} - id: XPSEdgeTpuTfLiteFormat - XPSStringStats: + description: The document moderation request message. + properties: + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + modelVersion: + enumDescriptions: + - The default model version. + - >- + Use the v1 model, this model is used by default when not provided. + The v1 model only returns probability (confidence) score for each + category. + - >- + Use the v2 model. The v2 model only returns probability + (confidence) score for each category, and returns severity score + for a subset of the categories. + enum: + - MODEL_VERSION_UNSPECIFIED + - MODEL_VERSION_1 + - MODEL_VERSION_2 + description: Optional. The model version to use for ModerateText. + type: string + id: ModerateTextRequest + XPSTablesClassificationMetrics: + description: Metrics for Tables classification problems. type: object properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - topUnigramStats: - description: >- - The statistics of the top 20 unigrams, ordered by - StringStats.UnigramStats.count. - type: array + curveMetrics: + description: Metrics building a curve. items: - $ref: '#/components/schemas/XPSStringStatsUnigramStats' - description: The data statistics of a series of STRING values. - id: XPSStringStats - XPSImageModelServingSpecModelThroughputEstimation: - type: object - id: XPSImageModelServingSpecModelThroughputEstimation + $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' + type: array + id: XPSTablesClassificationMetrics + GpuMetric: + id: GpuMetric properties: - latencyInMilliseconds: - description: Estimated latency. - format: double - type: number - nodeQps: - format: double - description: The approximate qps a deployed node can serve. - type: number - computeEngineAcceleratorType: + trackingLabels: + additionalProperties: + type: string + description: >- + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" + type: object + gpuType: + description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. enumDescriptions: - '' - - Nvidia Tesla K80 GPU. - - Nvidia Tesla P100 GPU. - - Nvidia Tesla V100 GPU. - - Nvidia Tesla P4 GPU. - - Nvidia Tesla T4 GPU. - - Nvidia Tesla A100 GPU. - - Nvidia A100 80GB GPU. - - Nvidia L4 GPU. - - Nvidia H100 80Gb GPU. - - TPU v2 (JellyFish). - - TPU v3 (DragonFish). - - TPU_v4 (PufferFish). - - TPU v5 Lite Pods. + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' enum: - - UNSPECIFIED + - UNKNOWN_GPU_TYPE + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB - NVIDIA_TESLA_K80 + - NVIDIA_L4 - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_V100 - NVIDIA_TESLA_P4 - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_L4 + - NVIDIA_TESLA_V100 - NVIDIA_H100_80GB - - TPU_V2 - - TPU_V3 - - TPU_V4_POD - - TPU_V5_LITEPOD type: string - servomaticPartitionType: - type: string - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU + machineSpec: enumDescriptions: - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - >- - To be used by customers with Jellyfish-accelerated ops. See - go/servomatic-jellyfish for details. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. - Color: - type: object - id: Color - properties: - alpha: - description: >- - The fraction of this color that should be applied to the pixel. That - is, the final pixel color is defined by the equation: `pixel color = - alpha * (this color) + (1.0 - alpha) * (background color)` This - means that a value of 1.0 corresponds to a solid color, whereas a - value of 0.0 corresponds to a completely transparent color. This - uses a wrapper message rather than a simple float scalar so that it - is possible to distinguish between a default value and the value - being unset. If omitted, this color object is rendered as a solid - color (as if the alpha value had been explicitly given a value of - 1.0). - format: float - type: number - red: - type: number - format: float - description: The amount of red in the color as a value in the interval [0, 1]. - green: - description: The amount of green in the color as a value in the interval [0, 1]. - format: float - type: number - blue: - format: float - type: number - description: The amount of blue in the color as a value in the interval [0, 1]. - description: >- - Represents a color in the RGBA color space. This representation is - designed for simplicity of conversion to and from color representations - in various languages over compactness. For example, the fields of this - representation can be trivially provided to the constructor of - `java.awt.Color` in Java; it can also be trivially provided to UIColor's - `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little - work, it can be easily formatted into a CSS `rgba()` string in - JavaScript. This reference page doesn't have information about the - absolute color space that should be used to interpret the RGB value—for - example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications - should assume the sRGB color space. When color equality needs to be - decided, implementations, unless documented otherwise, treat two colors - as equal if all their red, green, blue, and alpha values each differ by - at most `1e-5`. Example (Java): import com.google.type.Color; // ... - public static java.awt.Color fromProto(Color protocolor) { float alpha = - protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return - new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), - protocolor.getBlue(), alpha); } public static Color - toProto(java.awt.Color color) { float red = (float) color.getRed(); - float green = (float) color.getGreen(); float blue = (float) - color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder - = Color .newBuilder() .setRed(red / denominator) .setGreen(green / - denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); - if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() - .setValue(((float) alpha) / denominator) .build()); } return - resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static - UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; - float green = [protocolor green]; float blue = [protocolor blue]; - FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if - (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return - [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static - Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if - (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return - nil; } Color* result = [[Color alloc] init]; [result setRed:red]; - [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { - [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; - return result; } // ... Example (JavaScript): // ... var protoToCssColor - = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var - greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || - 0.0; var red = Math.floor(redFrac * 255); var green = - Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if - (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } - var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, - green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, - ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var - rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString - = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var - resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { - resultBuilder.push('0'); } resultBuilder.push(hexString); return - resultBuilder.join(''); }; // ... - DiskMetric: - type: object - id: DiskMetric - properties: - gibSec: - format: int64 - type: string - description: Required. Seconds of physical disk usage, e.g. 3600. - diskType: - type: string - enum: - - UNKNOWN_DISK_TYPE - - REGIONAL_SSD - - REGIONAL_STORAGE - - PD_SSD - - PD_STANDARD - - STORAGE_SNAPSHOT - enumDescriptions: - '' - '' - '' - '' - '' - '' - description: Required. Type of Disk, e.g. REGIONAL_SSD. - XPSFileSpec: - description: >- - Spec of input and output files, on external file systems (CNS, GCS, - etc). - id: XPSFileSpec - properties: - fileFormat: - type: string - enum: - - FILE_FORMAT_UNKNOWN - - FILE_FORMAT_SSTABLE - - FILE_FORMAT_TRANSLATION_RKV - - FILE_FORMAT_RECORDIO - - FILE_FORMAT_RAW_CSV - - FILE_FORMAT_RAW_CAPACITOR - enumDeprecated: - - false - - true - - false - - false - - false - - false - enumDescriptions: - '' - '' - - >- - Internal format for parallel text data used by Google Translate. - go/rkvtools - '' - - >- - Only the lexicographically first file described by the file_spec - contains the header line. - '' - directoryPath: - deprecated: true - type: string - description: Deprecated. Use file_spec. - singleFilePath: - type: string - deprecated: true - description: Deprecated. Use file_spec. - fileSpec: - description: >- - Single file path, or file pattern of format - "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is - expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and - /cns/cell-d/somewhere/file-00001-of-00002. - type: string - type: object - XPSTablesConfidenceMetricsEntry: - id: XPSTablesConfidenceMetricsEntry - description: Metrics for a single confidence threshold. - properties: - f1Score: - description: >- - The harmonic mean of recall and precision. (2 * precision * recall) - / (precision + recall) - type: number - format: double - recall: - type: number - description: 'Recall = #true positives / (#true positives + #false negatives).' - format: double - confidenceThreshold: - format: double - description: The confidence threshold value used to compute the metrics. - type: number - falseNegativeCount: - description: False negative count. - type: string - format: int64 - trueNegativeCount: - format: int64 - description: True negative count. - type: string - falsePositiveRate: - format: double - description: 'FPR = #false positives / (#false positives + #true negatives)' - type: number - precision: - description: 'Precision = #true positives / (#true positives + #false positives).' - format: double - type: number - truePositiveCount: - format: int64 - description: True positive count. - type: string - falsePositiveCount: - type: string - format: int64 - description: False positive count. - truePositiveRate: - type: number - format: double - description: 'TPR = #true positives / (#true positives + #false negatvies)' - type: object - XPSSpeechPreprocessStats: - type: object - id: XPSSpeechPreprocessStats - properties: - testSentencesCount: - description: The number of sentences in the test data set. - format: int32 - type: integer - testExamplesCount: - description: The number of examples labelled as TEST by Speech xps server. - type: integer - format: int32 - dataErrors: - items: - $ref: '#/components/schemas/XPSDataErrors' - description: Different types of data errors and the counts associated with them. - type: array - testWordsCount: - type: integer - format: int32 - description: The number of words in the test data set. - trainExamplesCount: - description: The number of examples labeled as TRAIN by Speech xps server. - format: int32 - type: integer - numHumanLabeledExamples: - type: integer - description: The number of rows marked HUMAN_LABELLED - format: int32 - numMachineTranscribedExamples: - type: integer - description: The number of rows marked as MACHINE_TRANSCRIBED - format: int32 - trainSentencesCount: - type: integer - description: The number of sentences in the training data set. - format: int32 - trainWordsCount: - format: int32 - description: The number of words in the training data set. - type: integer - numLogsExamples: - type: integer - description: The number of samples found in the previously recorded logs data. - format: int32 - XPSModelArtifactItem: - description: A single model artifact item. - id: XPSModelArtifactItem - properties: - gcsUri: - description: >- - The Google Cloud Storage (GCS) uri that stores the model binary - files. - type: string - artifactFormat: - type: string - description: The model artifact format. - enum: - - ARTIFACT_FORMAT_UNSPECIFIED - - TF_CHECKPOINT - - TF_SAVED_MODEL - - TF_LITE - - EDGE_TPU_TF_LITE - - TF_JS - - CORE_ML - enumDescriptions: - - Should not be used. - - >- - The Tensorflow checkpoints. See - https://www.tensorflow.org/guide/checkpoint. - - The Tensorflow SavedModel binary. - - >- - Model artifact in generic TensorFlow Lite (.tflite) format. See - https://www.tensorflow.org/lite. - - Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. - - >- - A [TensorFlow.js](https://www.tensorflow.org/js) model that can be - used in the browser and in Node.js using JavaScript. - - >- - Used for iOS mobile devices in (.mlmodel) format. See - https://developer.apple.com/documentation/coreml - type: object - XPSTranslationTrainResponse: - properties: - modelType: - enumDescriptions: - - Default - - Legacy model. Will be deprecated. - - Current model. - type: string - enum: - - MODEL_TYPE_UNSPECIFIED - - LEGACY - - CURRENT - description: Type of the model. - description: Train response for translation. - type: object - id: XPSTranslationTrainResponse - AnnotateTextRequestFeatures: - id: AnnotateTextRequestFeatures - description: >- - All available features. Setting each one to true will enable that - specific analysis for the input. - type: object - properties: - moderateText: - type: boolean - description: >- - Optional. Moderate the document for harmful and sensitive - categories. - extractEntities: - type: boolean - description: Optional. Extract entities. - extractDocumentSentiment: - type: boolean - description: Optional. Extract document-level sentiment. - classifyText: - description: Optional. Classify the full document into categories. - type: boolean - XPSImageSegmentationTrainResponse: - properties: - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - exportModelSpec: - description: 'NOTE: These fields are not used/needed in EAP but will be set later.' - $ref: '#/components/schemas/XPSImageExportModelSpec' - trainCostNodeSeconds: - type: string - format: int64 - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - description: >- - ## The fields below are only populated under uCAIP request scope. - Model artifact spec stores and model gcs pathes and related metadata - stopReason: - enumDescriptions: - '' - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - type: string - colorMaps: - description: Color map of the model. - type: array - items: - $ref: '#/components/schemas/XPSColorMap' - type: object - id: XPSImageSegmentationTrainResponse - XPSResponseExplanationMetadataOutputMetadata: - type: object - id: XPSResponseExplanationMetadataOutputMetadata - properties: - outputTensorName: - description: Name of the output tensor. Only needed in train response. - type: string - description: Metadata of the prediction output to be explained. - XPSVisionErrorAnalysisConfig: - description: 'The vision model error analysis configuration. Next tag: 3' - id: XPSVisionErrorAnalysisConfig - properties: - exampleCount: - format: int32 - type: integer - description: The number of query examples in error analysis. - queryType: - enum: - - QUERY_TYPE_UNSPECIFIED - - QUERY_TYPE_ALL_SIMILAR - - QUERY_TYPE_SAME_CLASS_SIMILAR - - QUERY_TYPE_SAME_CLASS_DISSIMILAR - enumDescriptions: - - Unspecified query type for model error analysis. - - Query similar samples across all classes in the dataset. - - Query similar samples from the same class of the input sample. - - Query dissimilar samples from the same class of the input sample. - description: >- - The query type used in retrieval. The enum values are frozen in the - foreseeable future. - type: string - type: object - XPSImageModelArtifactSpec: - properties: - checkpointArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: The Tensorflow checkpoint files. e.g. Used for resumable training. - tfLiteMetadataGcsUri: - type: string - description: GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'. - tfJsBinaryGcsPrefix: - type: string - description: >- - GCS uri prefix of Tensorflow JavaScript binary files - 'groupX-shardXofX.bin' Deprecated. - servingArtifact: - description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud AI Platform API. - $ref: '#/components/schemas/XPSModelArtifactItem' - labelGcsUri: - type: string - description: GCS uri of decoded labels file for model export 'dict.txt'. - exportArtifact: - items: - $ref: '#/components/schemas/XPSModelArtifactItem' - type: array - description: The model binary files in different formats for model export. - description: >- - Stores the locations and related metadata of the model artifacts. - Populated for uCAIP requests only. - type: object - id: XPSImageModelArtifactSpec - XPSTextComponentModel: - type: object - id: XPSTextComponentModel - description: 'Component model. Next ID: 10' - properties: - partition: - enum: - - PARTITION_TYPE_UNSPECIFIED - - PARTITION_ZERO - - PARTITION_REDUCED_HOMING - - PARTITION_JELLYFISH - - PARTITION_CPU - - PARTITION_CUSTOM_STORAGE_CPU - type: string - enumDescriptions: - '' - - The default partition. - - >- - It has significantly lower replication than partition-0 and is - located in the US only. It also has a larger model size limit and - higher default RAM quota than partition-0. Customers with batch - traffic, US-based traffic, or very large models should use this - partition. Capacity in this partition is significantly cheaper - than partition-0. - - >- - To be used by customers with Jellyfish-accelerated ops. See - go/servomatic-jellyfish for details. - - The partition used by regionalized servomatic cloud regions. - - The partition used for loading models from custom storage. - description: >- - The partition where the model is deployed. Populated by uCAIP BE as - part of online PredictRequest. - batchPredictionModelGcsUri: - type: string - description: The Cloud Storage resource path to hold batch prediction model. - onlinePredictionModelGcsUri: - description: The Cloud Storage resource path to hold online prediction model. - type: string - submodelType: - enum: - - TEXT_MODEL_TYPE_UNSPECIFIED - - TEXT_MODEL_TYPE_DEFAULT - - TEXT_MODEL_TYPE_META_ARCHITECT - - TEXT_MODEL_TYPE_ATC - - TEXT_MODEL_TYPE_CLARA2 - - TEXT_MODEL_TYPE_CHATBASE - - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING - - TEXT_MODEL_TYPE_TEXT_EXTRACTION - - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION - - TEXT_MODEL_TYPE_COMPOSITE - - TEXT_MODEL_TYPE_ALL_MODELS - - TEXT_MODEL_TYPE_BERT - - TEXT_MODEL_TYPE_ENC_PALM - enumDescriptions: - '' - '' - '' @@ -1670,662 +1192,665 @@ components: - '' - '' - '' - - Model type for entity extraction. - - Model type for relationship extraction. - - >- - A composite model represents a set of component models that have - to be used together for prediction. A composite model appears to - be a single model to the model user. It may contain only one - component model. Please refer to go/cnl-composite-models for more - information. - - >- - Model type used to train default, MA, and ATC models in a single - batch worker pipeline. - - >- - BERT pipeline needs a specific model type, since it uses a - different TFX configuration compared with DEFAULT (despite sharing - most of the code). - - Model type for EncPaLM. - description: The type of trained NL submodel - type: string - servingArtifact: - $ref: '#/components/schemas/XPSModelArtifactItem' - description: >- - The default model binary file used for serving (e.g. online predict, - batch predict) via public Cloud Ai Platform API. - submodelName: - type: string - description: The name of the trained NL submodel. - servoModelName: - description: >- - The name of servo model. Populated by uCAIP BE as part of online - PredictRequest. - type: string - tfRuntimeVersion: - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list - type: string - versionNumber: - format: int64 - type: string - description: >- - The servomatic model version number. Populated by uCAIP BE as part - of online PredictRequest. - XPSImageClassificationTrainResponse: - properties: - modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' - description: '## The fields below are only populated under uCAIP request scope.' - stopReason: - type: string - enumDescriptions: - '' - '' - - Model fully converged, can not be resumbed training. - - >- - Model early converged, can be further trained till full - convergency. - enum: - - TRAIN_STOP_REASON_UNSPECIFIED - - TRAIN_STOP_REASON_BUDGET_REACHED - - TRAIN_STOP_REASON_MODEL_CONVERGED - - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. - classCount: - type: string - format: int64 - description: Total number of classes. - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' - description: >- - Information of downloadable models that are pre-generated as part of - training flow and will be persisted in AutoMl backend. Populated for - AutoMl requests. - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' - trainCostNodeSeconds: - description: >- - The actual training cost, expressed in node seconds. Populated for - models trained in node time. - format: int64 - type: string - trainCostInNodeTime: - format: google-duration - type: string - description: >- - The actual cost to create this model. - For edge type model, the - cost is expressed in node hour. - For cloud type model,the cost is - expressed in compute hour. - Populated for models created before GA. - To be deprecated after GA. - id: XPSImageClassificationTrainResponse - type: object - XPSMetricEntryLabel: - properties: - labelValue: - description: The value of the label. - type: string - labelName: - description: The name of the label. - type: string - id: XPSMetricEntryLabel - type: object - XPSColorMapIntColor: - id: XPSColorMapIntColor - type: object - description: RGB color and each channel is represented by an integer. - properties: - green: - type: integer - description: The value should be in range of [0, 255]. - format: int32 - blue: - format: int32 - type: integer - description: The value should be in range of [0, 255]. - red: - description: The value should be in range of [0, 255]. - type: integer - format: int32 - XPSResponseExplanationMetadata: - deprecated: true - properties: - outputs: - type: object - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' - description: Metadata of the output. - inputs: - description: Metadata of the input. - additionalProperties: - $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' - type: object - id: XPSResponseExplanationMetadata - type: object - XPSBoundingBoxMetricsEntry: - description: >- - Bounding box matching model metrics for a single intersection-over-union - threshold and multiple label match confidence thresholds. - properties: - meanAveragePrecision: - type: number - format: float - description: The mean average precision. - iouThreshold: - format: float - type: number - description: >- - The intersection-over-union threshold value used to compute this - metrics entry. - confidenceMetricsEntries: - items: - $ref: >- - #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry - description: >- - Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - type: array - type: object - id: XPSBoundingBoxMetricsEntry - XPSColumnSpec: - type: object - properties: - displayName: - description: >- - The display name of the column. It's outputed in Preprocess and a - required input for RefreshTablesStats and Train. - type: string - forecastingMetadata: - $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' - dataStats: - $ref: '#/components/schemas/XPSDataStats' - description: >- - The data stats of the column. It's outputed in RefreshTablesStats - and a required input for Train. - dataType: - $ref: '#/components/schemas/XPSDataType' - description: >- - The data type of the column. It's outputed in Preprocess rpc and a - required input for RefreshTablesStats and Train. - topCorrelatedColumns: - type: array - items: - $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' - description: It's outputed in RefreshTablesStats, and a required input in Train. - columnId: - type: integer - format: int32 - description: >- - The unique id of the column. When Preprocess, the Tables BE will - popuate the order id of the column, which reflects the order of the - column inside the table, i.e. 0 means the first column in the table, - N-1 means the last column. AutoML BE will persist this order id in - Spanner and set the order id here when calling RefreshTablesStats - and Train. Note: it's different than the column_spec_id that is - generated in AutoML BE. - id: XPSColumnSpec - XPSTfLiteFormat: - properties: {} - id: XPSTfLiteFormat - description: >- - LINT.IfChange A model format used for mobile and IoT devices. See - https://www.tensorflow.org/lite. - type: object - XPSReportingMetrics: - properties: - effectiveTrainingDuration: - description: >- - The effective time training used. If set, this is used for quota - management and billing. Deprecated. AutoML BE doesn't use this. - Don't set. - deprecated: true - format: google-duration + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: Required. Machine spec, e.g. N1_STANDARD_4. type: string - metricEntries: - description: >- - One entry per metric name. The values must be aggregated per metric - name. - type: array - items: - $ref: '#/components/schemas/XPSMetricEntry' - id: XPSReportingMetrics - type: object - XPSCategoryStats: - properties: - topCategoryStats: - items: - $ref: '#/components/schemas/XPSCategoryStatsSingleCategoryStats' - description: >- - The statistics of the top 20 CATEGORY values, ordered by - CategoryStats.SingleCategoryStats.count. - type: array - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - id: XPSCategoryStats - type: object - description: The data statistics of a series of CATEGORY values. - AnalyzeEntitiesResponse: - description: The entity analysis response message. - id: AnalyzeEntitiesResponse - properties: - languageCode: - description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. + enum: + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + gpuSec: type: string - languageSupported: - description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - type: boolean - entities: - type: array - description: The recognized entities in the input document. - items: - $ref: '#/components/schemas/Entity' + description: Required. Seconds of GPU usage, e.g. 3600. + format: int64 type: object - XPSIntegratedGradientsAttribution: + XPSStructStats: + description: The data statistics of a series of STRUCT values. properties: - stepCount: + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + fieldStats: description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is within the desired error range. Valid range of its value - is [1, 100], inclusively. - format: int32 - type: integer - deprecated: true - id: XPSIntegratedGradientsAttribution + Map from a field name of the struct to data stats aggregated over + series of all data in that field across all the structs. + type: object + additionalProperties: + $ref: '#/components/schemas/XPSDataStats' + id: XPSStructStats type: object - description: >- - An attribution method that computes the Aumann-Shapley value taking - advantage of the model's fully differentiable structure. Refer to this - paper for more details: https://arxiv.org/abs/1703.01365 - XPSMetricEntry: + XPSVideoBatchPredictOperationMetadata: properties: - systemLabels: - description: Billing system labels for this (metric, value) pair. + outputExamples: type: array items: - $ref: '#/components/schemas/XPSMetricEntryLabel' - int64Value: - description: A signed 64-bit integer value. + type: string + description: >- + All the partial batch prediction results that are completed at the + moment. Output examples are sorted by completion time. The order + will not be changed. Each output example should be the path of a + single RecordIO file of AnnotatedExamples. + id: XPSVideoBatchPredictOperationMetadata + type: object + XPSTrainResponse: + description: 'Next ID: 18' + properties: + tablesTrainResp: + $ref: '#/components/schemas/XPSTablesTrainResponse' + translationTrainResp: + $ref: '#/components/schemas/XPSTranslationTrainResponse' + videoClassificationTrainResp: + $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' + deployedModelSizeBytes: type: string + description: Estimated model size in bytes once deployed. format: int64 - argentumMetricId: - type: string + imageClassificationTrainResp: + $ref: '#/components/schemas/XPSImageClassificationTrainResponse' + imageSegmentationTrainResp: + $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' + modelToken: description: >- - For billing metrics that are using legacy sku's, set the legacy - billing metric id here. This will be sent to Chemist as the - "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise - leave empty. - doubleValue: - type: number - format: double - description: A double value. - metricName: + Token that represents the trained model. This is considered + immutable and is persisted in AutoML. xPS can put their own proto in + the byte string, to e.g. point to the model checkpoints. The token + is passed to other xPS APIs to refer to the model. type: string - description: The metric name defined in the service configuration. - id: XPSMetricEntry - type: object - XPSTextTrainResponse: - id: XPSTextTrainResponse - properties: - componentModel: + format: byte + explanationConfigs: + type: array items: - $ref: '#/components/schemas/XPSTextComponentModel' + $ref: '#/components/schemas/XPSResponseExplanationSpec' + description: >- + VisionExplanationConfig for XAI on test set. Optional for when XAI + is enable in training request. + deprecated: true + errorAnalysisConfigs: type: array - description: Component submodels. + items: + $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' + description: >- + Optional vision model error analysis configuration. The field is set + when model error analysis is enabled in the training request. The + results of error analysis will be binded together with evaluation + results (in the format of AnnotatedExample). + imageObjectDetectionTrainResp: + $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' + speechTrainResp: + $ref: '#/components/schemas/XPSSpeechModelSpec' + textTrainResp: + $ref: '#/components/schemas/XPSTextTrainResponse' + description: Will only be needed for uCAIP from Beta. + videoObjectTrackingTrainResp: + $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' + textToSpeechTrainResp: + $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' + videoActionRecognitionTrainResp: + $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' + evaluationMetricsSet: + description: >- + The trained model evaluation metrics. This can be optionally + returned. + $ref: '#/components/schemas/XPSEvaluationMetricsSet' + evaluatedExampleSet: + $ref: '#/components/schemas/XPSExampleSet' + description: >- + Examples used to evaluate the model (usually the test set), with the + predicted annotations. The file_spec should point to recordio + file(s) of AnnotatedExample. For each returned example, the + example_id_token and annotations predicted by the model must be set. + The example payload can and is recommended to be omitted. type: object - XPSTuningTrial: + id: XPSTrainResponse + AnalyzeSentimentRequest: + description: The sentiment analysis request message. type: object - description: >- - Metrics for a tuning job generated, will get forwarded to Stackdriver as - model tuning logs. Setting this as a standalone message out of - CreateModelMetadata to avoid confusion as we expose this message only to - users. - id: XPSTuningTrial - properties: - trainingObjectivePoint: - $ref: '#/components/schemas/XPSTrainingObjectivePoint' - description: The optimization objective evaluation of the eval split data. - modelStructure: - description: Model parameters for the trial. - $ref: '#/components/schemas/XPSTablesModelStructure' - XPSResponseExplanationMetadataInputMetadata: properties: - inputTensorName: - type: string - description: >- - Name of the input tensor for this model. Only needed in train - response. - modality: + document: + description: Required. Input document. + $ref: '#/components/schemas/Document' + encodingType: type: string - description: >- - Modality of the feature. Valid values are: numeric, image. Defaults - to numeric. enumDescriptions: - - '' - - '' - - '' - - '' + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + description: The encoding type used by the API to calculate sentence offsets. enum: - - MODALITY_UNSPECIFIED - - NUMERIC - - IMAGE - - CATEGORICAL - visualizationConfig: - description: Visualization configurations for image explanation. - $ref: '#/components/schemas/XPSVisualization' - type: object - id: XPSResponseExplanationMetadataInputMetadata - description: Metadata of the input of a feature. - XPSCorrelationStats: - id: XPSCorrelationStats - type: object - description: >- - A correlation statistics between two series of DataType values. The - series may have differing DataType-s, but within a single series the - DataType must be the same. - properties: - cramersV: - type: number - format: double - description: The correlation value using the Cramer's V measure. - XPSResponseExplanationSpec: - id: XPSResponseExplanationSpec - deprecated: true + - NONE + - UTF8 + - UTF16 + - UTF32 + id: AnalyzeSentimentRequest + XPSVideoActionRecognitionTrainResponse: properties: - parameters: - description: Parameters that configure explaining of the Model's predictions. - $ref: '#/components/schemas/XPSResponseExplanationParameters' - metadata: - $ref: '#/components/schemas/XPSResponseExplanationMetadata' - description: Metadata describing the Model's input and output for explanation. - explanationType: + trainCostNodeSeconds: type: string description: >- - Explanation type. For AutoML Image Classification models, possible - values are: * `image-integrated-gradients` * `image-xrai` - type: object - description: >- - Specification of Model explanation. Feature-based XAI in AutoML Vision - ICN is deprecated, see b/288407203 for context. - XPSTextToSpeechTrainResponse: - type: object - id: XPSTextToSpeechTrainResponse - description: TextToSpeech train response - properties: {} - XPSTablesModelColumnInfo: - id: XPSTablesModelColumnInfo + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + format: int64 + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' type: object - properties: - columnId: - format: int32 - type: integer - description: The ID of the column. - featureImportance: - format: float - description: >- - When given as part of a Model: Measurement of how much model - predictions correctness on the TEST data depend on values in this - column. A value between 0 and 1, higher means higher influence. - These values are normalized - for all input feature columns of a - given model they add to 1. When given back by Predict or Batch - Predict: Measurement of how impactful for the prediction returned - for the given row the value in this column was. Specifically, the - feature importance specifies the marginal contribution that the - feature made to the prediction score compared to the baseline score. - These values are computed using the Sampled Shapley method. - type: number - description: >- - An information specific to given column and Tables Model, in context of - the Model and the predictions created by it. - XPSColumnSpecForecastingMetadata: + id: XPSVideoActionRecognitionTrainResponse + XPSMetricEntry: type: object properties: - columnType: - description: The type of the column for FORECASTING model training purposes. - enum: - - COLUMN_TYPE_UNSPECIFIED - - KEY - - KEY_METADATA - - TIME_SERIES_AVAILABLE_PAST_ONLY - - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE - enumDescriptions: - - An un-set value of this enum. - - Key columns are used to identify timeseries. - - >- - This column contains information describing static properties of - the entities identified by the key column(s) (e.g. city's ZIP - code). - - >- - This column contains information for the given entity, at any time - poinrt, they are only available in the time series before. - - >- - This column contains information for the given entity is known - both for the past and the sufficiently far future. + argentumMetricId: type: string - description: >- - =========================================================================== - # The fields below are used exclusively for Forecasting. - id: XPSColumnSpecForecastingMetadata - XPSTrackMetricsEntry: - id: XPSTrackMetricsEntry + description: >- + For billing metrics that are using legacy sku's, set the legacy + billing metric id here. This will be sent to Chemist as the + "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise + leave empty. + int64Value: + format: int64 + description: A signed 64-bit integer value. + type: string + systemLabels: + description: Billing system labels for this (metric, value) pair. + type: array + items: + $ref: '#/components/schemas/XPSMetricEntryLabel' + doubleValue: + type: number + format: double + description: A double value. + metricName: + description: The metric name defined in the service configuration. + type: string + id: XPSMetricEntry + XPSTextExtractionEvaluationMetrics: properties: confidenceMetricsEntries: - type: array description: >- - Output only. Metrics for each label-match confidence_threshold from - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is - derived from them. + If the enclosing EvaluationMetrics.label is empty, + confidence_metrics_entries is an evaluation of the entire model + across all labels. If the enclosing EvaluationMetrics.label is set, + confidence_metrics_entries applies to that label. + type: array items: - $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' - meanTrackingAveragePrecision: - type: number + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + confusionMatrix: description: >- - Output only. The mean average precision over all confidence - thresholds. - format: float - iouThreshold: + Confusion matrix of the model, at the default confidence threshold + (0.0). Only set for whole-model evaluation, not for evaluation per + label. + $ref: '#/components/schemas/XPSConfusionMatrix' + bestF1ConfidenceMetrics: + deprecated: true description: >- - Output only. The intersection-over-union threshold value between - bounding boxes across frames used to compute this metric entry. - format: float - type: number - meanMismatchRate: - description: Output only. The mean mismatch rate over all confidence thresholds. - format: float - type: number - meanBoundingBoxIou: + Values are at the highest F1 score on the precision-recall curve. + Only confidence_threshold, recall, precision, and f1_score will be + set. + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + perLabelConfidenceMetrics: + type: object + description: Only recall, precision, and f1_score will be set. + additionalProperties: + $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + deprecated: true + type: object + id: XPSTextExtractionEvaluationMetrics + XPSTablesPreprocessResponse: + properties: + tablesDatasetMetadata: + $ref: '#/components/schemas/XPSTablesDatasetMetadata' description: >- - Output only. The mean bounding box iou over all confidence - thresholds. - format: float - type: number + The table/column id, column_name and the DataTypes of the columns + will be populated. type: object - description: >- - Track matching model metrics for a single track match threshold and - multiple label match confidence thresholds. Next tag: 6. - XPSStructType: + id: XPSTablesPreprocessResponse + XPSTablesModelStructure: + description: A description of Tables model structure. type: object - id: XPSStructType - properties: - fields: - type: object - description: Unordered map of struct field names to their data types. - additionalProperties: - $ref: '#/components/schemas/XPSDataType' - description: '`StructType` defines the DataType-s of a STRUCT type.' - XPSSpeechEvaluationMetrics: + id: XPSTablesModelStructure properties: - subModelEvaluationMetrics: + modelParameters: + description: A list of models. items: - $ref: >- - #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric - description: Evaluation metrics for all submodels contained in this model. + $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' type: array - id: XPSSpeechEvaluationMetrics + XPSConfusionMatrixRow: type: object - XPSStringStatsUnigramStats: + id: XPSConfusionMatrixRow properties: count: - description: The number of occurrences of this unigram in the series. - format: int64 - type: string - value: - description: The unigram. - type: string - description: The statistics of a unigram. + description: >- + Same as above except intended to represent other counts (for e.g. + for segmentation this is pixel count). NOTE(params): Only + example_count or count is set (oneoff does not support repeated + fields unless they are embedded inside another message). + type: array + items: + type: string + format: int64 + exampleCount: + description: >- + Value of the specific cell in the confusion matrix. The number of + values each row has (i.e. the length of the row) is equal to the + length of the annotation_spec_id_token field. + type: array + items: + type: integer + format: int32 + description: A row in the confusion matrix. + XPSVideoModelArtifactSpec: + id: XPSVideoModelArtifactSpec type: object - id: XPSStringStatsUnigramStats + properties: + servingArtifact: + $ref: '#/components/schemas/XPSModelArtifactItem' + description: >- + The default model binary file used for serving (e.g. batch predict) + via public Cloud AI Platform API. + exportArtifact: + description: The model binary files in different formats for model export. + type: array + items: + $ref: '#/components/schemas/XPSModelArtifactItem' XPSTablesClassificationMetricsCurveMetrics: - description: Metrics curve data point for a single value. - id: XPSTablesClassificationMetricsCurveMetrics - type: object properties: - positionThreshold: - format: int32 - type: integer - description: The position threshold value used to compute the metrics. - aucRoc: + logLoss: + description: The Log loss metric. + format: double type: number + aucRoc: description: The area under receiver operating characteristic curve. + type: number format: double aucPr: format: double type: number description: The area under the precision-recall curve. value: - type: string description: >- The CATEGORY row value (for ARRAY unnested) the curve metrics are for. - confidenceMetricsEntries: - description: >- - Metrics that have confidence thresholds. Precision-recall curve and - ROC curve can be derived from them. - type: array - items: - $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' - logLoss: - format: double - description: The Log loss metric. - type: number - XPSPreprocessResponse: - type: object - properties: - translationPreprocessResp: - $ref: '#/components/schemas/XPSTranslationPreprocessResponse' - tablesPreprocessResponse: - $ref: '#/components/schemas/XPSTablesPreprocessResponse' - speechPreprocessResp: - $ref: '#/components/schemas/XPSSpeechPreprocessResponse' - outputExampleSet: - $ref: '#/components/schemas/XPSExampleSet' - description: >- - Preprocessed examples, that are to be imported into AutoML storage. - This should point to RecordIO file(s) of PreprocessedExample - messages. The PreprocessedExample.mvp_training_data-s returned here - are later verbatim passed to Train() call in - TrainExample.mvp_training_data. - id: XPSPreprocessResponse - description: 'Next ID: 8' - Sentence: - description: Represents a sentence in the input document. - id: Sentence - properties: - sentiment: - description: >- - For calls to AnalyzeSentiment or if - AnnotateTextRequest.Features.extract_document_sentiment is set to - true, this field will contain the sentiment for the sentence. - $ref: '#/components/schemas/Sentiment' - text: - $ref: '#/components/schemas/TextSpan' - description: The sentence text. - type: object - ClassifyTextResponse: - type: object - description: The document classification response message. - properties: - languageCode: type: string + confidenceMetricsEntries: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - categories: - items: - $ref: '#/components/schemas/ClassificationCategory' - description: Categories representing the input document. - type: array - languageSupported: - description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - type: boolean - id: ClassifyTextResponse - AnalyzeEntitiesRequest: + Metrics that have confidence thresholds. Precision-recall curve and + ROC curve can be derived from them. + items: + $ref: '#/components/schemas/XPSTablesConfidenceMetricsEntry' + type: array + positionThreshold: + description: The position threshold value used to compute the metrics. + format: int32 + type: integer + description: Metrics curve data point for a single value. + type: object + id: XPSTablesClassificationMetricsCurveMetrics + XPSVisionErrorAnalysisConfig: + description: 'The vision model error analysis configuration. Next tag: 3' + id: XPSVisionErrorAnalysisConfig properties: - encodingType: + exampleCount: + description: The number of query examples in error analysis. + format: int32 + type: integer + queryType: + description: >- + The query type used in retrieval. The enum values are frozen in the + foreseeable future. enum: - - NONE - - UTF8 - - UTF16 - - UTF32 + - QUERY_TYPE_UNSPECIFIED + - QUERY_TYPE_ALL_SIMILAR + - QUERY_TYPE_SAME_CLASS_SIMILAR + - QUERY_TYPE_SAME_CLASS_DISSIMILAR type: string - description: The encoding type used by the API to calculate offsets. enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - id: AnalyzeEntitiesRequest - description: The entity analysis request message. + - Unspecified query type for model error analysis. + - Query similar samples across all classes in the dataset. + - Query similar samples from the same class of the input sample. + - Query dissimilar samples from the same class of the input sample. + type: object + XPSTablesModelStructureModelParameters: + description: Model hyper-parameters for a model. + properties: + hyperparameters: + items: + $ref: >- + #/components/schemas/XPSTablesModelStructureModelParametersParameter + type: array + id: XPSTablesModelStructureModelParameters type: object XPSImageObjectDetectionModelSpec: + id: XPSImageObjectDetectionModelSpec + type: object properties: - exportModelSpec: - $ref: '#/components/schemas/XPSImageExportModelSpec' + classCount: + format: int64 + type: string + description: Total number of classes. modelArtifactSpec: - $ref: '#/components/schemas/XPSImageModelArtifactSpec' description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSImageModelArtifactSpec' maxBoundingBoxCount: - description: Max number of bounding box. - format: int64 type: string + format: int64 + description: Max number of bounding box. + exportModelSpec: + $ref: '#/components/schemas/XPSImageExportModelSpec' stopReason: - description: >- - Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', - 'MODEL_CONVERGED'. enum: - TRAIN_STOP_REASON_UNSPECIFIED - TRAIN_STOP_REASON_BUDGET_REACHED - TRAIN_STOP_REASON_MODEL_CONVERGED - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + type: string enumDescriptions: - '' - '' @@ -2333,860 +1858,946 @@ components: - >- Model early converged, can be further trained till full convergency. - type: string - modelServingSpec: - $ref: '#/components/schemas/XPSImageModelServingSpec' + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. trainCostNodeSeconds: type: string + format: int64 description: >- The actual train cost of creating this model, expressed in node seconds, i.e. 3,600 value in this field means 1 node hour. - format: int64 - classCount: - type: string - format: int64 - description: Total number of classes. - id: XPSImageObjectDetectionModelSpec - type: object - Sentiment: - type: object - id: Sentiment - properties: - magnitude: - description: >- - A non-negative number in the [0, +inf) range, which represents the - absolute magnitude of sentiment regardless of score (positive or - negative). - type: number - format: float - score: - format: float - description: >- - Sentiment score between -1.0 (negative sentiment) and 1.0 (positive - sentiment). - type: number - description: >- - Represents the feeling associated with the entire text or entities in - the text. - XPSImageModelServingSpec: - id: XPSImageModelServingSpec + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + XPSTranslationTrainResponse: type: object properties: - modelThroughputEstimation: - items: - $ref: >- - #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation - description: Populate under uCAIP request scope. - type: array - tfRuntimeVersion: + modelType: + enum: + - MODEL_TYPE_UNSPECIFIED + - LEGACY + - CURRENT type: string - description: >- - ## The fields below are only populated under uCAIP request scope. - https://cloud.google.com/ml-engine/docs/runtime-version-list - nodeQps: - format: double - type: number - description: >- - An estimated value of how much traffic a node can serve. Populated - for AutoMl request only. - description: Serving specification for image models. - XPSVisionTrainingOperationMetadata: - id: XPSVisionTrainingOperationMetadata + enumDescriptions: + - Default + - Legacy model. Will be deprecated. + - Current model. + description: Type of the model. + description: Train response for translation. + id: XPSTranslationTrainResponse + XPSPreprocessResponse: + id: XPSPreprocessResponse properties: - explanationUsage: - $ref: '#/components/schemas/InfraUsage' + tablesPreprocessResponse: + $ref: '#/components/schemas/XPSTablesPreprocessResponse' + outputExampleSet: description: >- - Aggregated infra usage within certain time period, for billing - report purpose if XAI is enable in training request. - deprecated: true - type: object - XPSVideoObjectTrackingEvaluationMetrics: + Preprocessed examples, that are to be imported into AutoML storage. + This should point to RecordIO file(s) of PreprocessedExample + messages. The PreprocessedExample.mvp_training_data-s returned here + are later verbatim passed to Train() call in + TrainExample.mvp_training_data. + $ref: '#/components/schemas/XPSExampleSet' + speechPreprocessResp: + $ref: '#/components/schemas/XPSSpeechPreprocessResponse' + translationPreprocessResp: + $ref: '#/components/schemas/XPSTranslationPreprocessResponse' + description: 'Next ID: 8' type: object - id: XPSVideoObjectTrackingEvaluationMetrics + XPSStringStats: properties: - boundingBoxMetricsEntries: - items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + topUnigramStats: description: >- - Output only. The bounding boxes match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + The statistics of the top 20 unigrams, ordered by + StringStats.UnigramStats.count. type: array - trackMeanAveragePrecision: - description: >- - Output only. The single metric for tracks accuracy evaluation: the - mean_average_precision averaged over all track_metrics_entries. - type: number - format: float - boundingBoxMeanAveragePrecision: - type: number - format: float - description: >- - Output only. The single metric for bounding boxes evaluation: the - mean_average_precision averaged over all - bounding_box_metrics_entries. - trackMeanMismatchRate: - format: float - type: number - description: >- - Output only. The single metric for tracking consistency evaluation: - the mean_mismatch_rate averaged over all track_metrics_entries. - trackMetricsEntries: items: - $ref: '#/components/schemas/XPSTrackMetricsEntry' - type: array - description: >- - Output only. The tracks match metrics for each - Intersection-over-union threshold - 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. - evaluatedTrackCount: - type: integer - format: int32 - description: The number of tracks used for model evaluation. - trackMeanBoundingBoxIou: + $ref: '#/components/schemas/XPSStringStatsUnigramStats' + id: XPSStringStats + description: The data statistics of a series of STRING values. + type: object + XPSEvaluationMetrics: + properties: + tablesClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + label: + type: string description: >- - Output only. The single metric for tracks bounding box iou - evaluation: the mean_bounding_box_iou averaged over all - track_metrics_entries. - format: float - type: number - evaluatedBoundingboxCount: + The label for which this evaluation metrics instance had been + created. Empty iff this is an overall model evaluation (like Tables + evaluation metrics), i.e. aggregated across all labels. The label + maps to AnnotationSpec.display_name in Public API protos. Only used + by MVP implementation and text sentiment FULL implementation. + textClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + textExtractionEvalMetrics: + $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' + imageClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + videoActionRecognitionEvalMetrics: + $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' + videoObjectTrackingEvalMetrics: + $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' + category: + description: >- + The integer category label for which this evaluation metric instance + had been created. Valid categories are 0 or higher. Overall model + evaluation should set this to negative values (rather than implicit + zero). Only used for Image Segmentation (prefer to set + annotation_spec_id_token instead). Note: uCAIP Image Segmentation + should use annotation_spec_id_token. type: integer - description: The number of bounding boxes used for model evaluation. format: int32 - evaluatedFrameCount: - description: The number of video frames used for model evaluation. + tablesEvalMetrics: + $ref: '#/components/schemas/XPSTablesEvaluationMetrics' + regressionEvalMetrics: + $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' + translationEvalMetrics: + $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' + textSentimentEvalMetrics: + $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' + videoClassificationEvalMetrics: + $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' + imageObjectDetectionEvalMetrics: + $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' + imageSegmentationEvalMetrics: + $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' + evaluatedExampleCount: format: int32 type: integer - description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' - XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: - type: object - id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry - description: Metrics for a single confidence threshold. - properties: - iouScore: - type: number - format: float - description: IOU score. - recall: - type: number - description: Recall for the given confidence threshold. - format: float - precision: - type: number - description: Precision for the given confidence threshold. - format: float - diceScoreCoefficient: - format: float - type: number - description: 'DSC or the F1 score: The harmonic mean of recall and precision.' - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' description: >- - Confusion matrix of the per confidence_threshold evaluation. Pixel - counts are set here. Only set for model level evaluation, not for - evaluation per label. - confidenceThreshold: - format: float - type: number - description: The confidence threshold value used to compute the metrics. - XPSTimestampStatsGranularStats: - id: XPSTimestampStatsGranularStats - description: Stats split by a defined in context granularity. + The number of examples used to create this evaluation metrics + instance. + annotationSpecIdToken: + type: string + description: >- + The annotation_spec for which this evaluation metrics instance had + been created. Empty iff this is an overall model evaluation (like + Tables evaluation metrics), i.e. aggregated across all labels. The + value comes from the input annotations in AnnotatedExample. For MVP + product or for text sentiment models where annotation_spec_id_token + is not available, set label instead. + description: >- + Contains xPS-specific model evaluation metrics either for a single + annotation spec (label), or for the model overall. Next tag: 18. + id: XPSEvaluationMetrics + type: object + AnnotateTextRequestFeatures: + description: >- + All available features. Setting each one to true will enable that + specific analysis for the input. properties: - buckets: - additionalProperties: - type: string - format: int64 - type: object + extractDocumentSentiment: + type: boolean + description: Optional. Extract document-level sentiment. + extractEntities: + type: boolean + description: Optional. Extract entities. + classifyText: + description: Optional. Classify the full document into categories. + type: boolean + moderateText: description: >- - A map from granularity key to example count for that key. E.g. for - hour_of_day `13` means 1pm, or for month_of_year `5` means May). + Optional. Moderate the document for harmful and sensitive + categories. + type: boolean type: object - XPSTextExtractionEvaluationMetrics: + id: AnnotateTextRequestFeatures + XPSVisualization: type: object - id: XPSTextExtractionEvaluationMetrics + id: XPSVisualization + deprecated: true properties: - confidenceMetricsEntries: - type: array - items: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + clipPercentLowerbound: + type: number description: >- - If the enclosing EvaluationMetrics.label is empty, - confidence_metrics_entries is an evaluation of the entire model - across all labels. If the enclosing EvaluationMetrics.label is set, - confidence_metrics_entries applies to that label. - confusionMatrix: - $ref: '#/components/schemas/XPSConfusionMatrix' + Excludes attributions below the specified percentile, from the + highlighted areas. Defaults to 62. + format: float + colorMap: description: >- - Confusion matrix of the model, at the default confidence threshold - (0.0). Only set for whole-model evaluation, not for evaluation per - label. - perLabelConfidenceMetrics: - type: object - deprecated: true - additionalProperties: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' - description: Only recall, precision, and f1_score will be set. - bestF1ConfidenceMetrics: - $ref: '#/components/schemas/XPSConfidenceMetricsEntry' + The color scheme used for the highlighted areas. Defaults to + PINK_GREEN for Integrated Gradients attribution, which shows + positive attributions in green and negative in pink. Defaults to + VIRIDIS for XRAI attribution, which highlights the most influential + regions in yellow and the least influential in blue. + enumDescriptions: + - Should not be used. + - 'Positive: green. Negative: pink.' + - >- + Viridis color map: A perceptually uniform color mapping which is + easier to see by those with colorblindness and progresses from + yellow to green to blue. Positive: yellow. Negative: blue. + - 'Positive: red. Negative: red.' + - 'Positive: green. Negative: green.' + - 'Positive: green. Negative: red.' + - PiYG palette. + enum: + - COLOR_MAP_UNSPECIFIED + - PINK_GREEN + - VIRIDIS + - RED + - GREEN + - RED_GREEN + - PINK_WHITE_GREEN + type: string + overlayType: + enumDescriptions: + - Default value. This is the same as NONE. + - No overlay. + - The attributions are shown on top of the original image. + - >- + The attributions are shown on top of grayscaled version of the + original image. + - >- + The attributions are used as a mask to reveal predictive parts of + the image and hide the un-predictive parts. description: >- - Values are at the highest F1 score on the precision-recall curve. - Only confidence_threshold, recall, precision, and f1_score will be - set. - deprecated: true - AnnotateTextRequest: - type: object - id: AnnotateTextRequest - properties: - encodingType: + How the original image is displayed in the visualization. Adjusting + the overlay can help increase visual clarity if the original image + makes it difficult to view the visualization. Defaults to NONE. enum: + - OVERLAY_TYPE_UNSPECIFIED - NONE - - UTF8 - - UTF16 - - UTF32 + - ORIGINAL + - GRAYSCALE + - MASK_BLACK type: string - description: The encoding type used by the API to calculate offsets. + clipPercentUpperbound: + format: float + type: number + description: >- + Excludes attributions above the specified percentile from the + highlighted areas. Using the clip_percent_upperbound and + clip_percent_lowerbound together can be useful for filtering out + noise and making it easier to see areas of strong attribution. + Defaults to 99.9. + type: enumDescriptions: + - Should not be used. + - Shows which pixel contributed to the image prediction. - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. + Shows which region contributed to the image prediction by + outlining the region. + enum: + - TYPE_UNSPECIFIED + - PIXELS + - OUTLINES + type: string + description: >- + Type of the image visualization. Only applicable to Integrated + Gradients attribution. OUTLINES shows regions of attribution, while + PIXELS shows per-pixel attribution. Defaults to OUTLINES. + polarity: + enum: + - POLARITY_UNSPECIFIED + - POSITIVE + - NEGATIVE + - BOTH + description: >- + Whether to only highlight pixels with positive contributions, + negative or both. Defaults to POSITIVE. + enumDescriptions: + - Default value. This is the same as POSITIVE. - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. + Highlights the pixels/outlines that were most influential to the + model's prediction. - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. - features: - $ref: '#/components/schemas/AnnotateTextRequestFeatures' - description: Required. The enabled features. - description: >- - The request message for the text annotation API, which can perform - multiple analysis types in one call. - ModerateTextResponse: - id: ModerateTextResponse - description: The document moderation response message. + Setting polarity to negative highlights areas that does not lead + to the models's current prediction. + - Shows both positive and negative attributions. + type: string + description: Visualization configurations for image explanation. + ClassificationCategory: type: object + id: ClassificationCategory + description: Represents a category returned from the text classifier. properties: - languageCode: + severity: + description: >- + Optional. The classifier's severity of the category. This is only + present when the ModerateTextRequest.ModelVersion is set to + MODEL_VERSION_2, and the corresponding category has a severity + score. + type: number + format: float + name: + description: The name of the category representing the document. type: string + confidence: description: >- - The language of the text, which will be the same as the language - specified in the request or, if not specified, the - automatically-detected language. See Document.language field for - more details. - moderationCategories: + The classifier's confidence of the category. Number represents how + certain the classifier is that this category represents the given + text. + format: float + type: number + InfraUsage: + properties: + ramMetrics: + type: array items: - $ref: '#/components/schemas/ClassificationCategory' + $ref: '#/components/schemas/RamMetric' + description: Aggregated ram metrics since requested start_time. + gpuMetrics: + items: + $ref: '#/components/schemas/GpuMetric' + description: Aggregated gpu metrics since requested start_time. type: array - description: Harmful and sensitive categories representing the input document. - languageSupported: - type: boolean - description: >- - Whether the language is officially supported. The API may still - return a response when the language is not supported, but it is on a - best effort basis. - XPSEvaluationMetrics: - id: XPSEvaluationMetrics + cpuMetrics: + type: array + items: + $ref: '#/components/schemas/CpuMetric' + description: Aggregated core metrics since requested start_time. + tpuMetrics: + items: + $ref: '#/components/schemas/TpuMetric' + type: array + description: Aggregated tpu metrics since requested start_time. + diskMetrics: + description: Aggregated persistent disk metrics since requested start_time. + type: array + items: + $ref: '#/components/schemas/DiskMetric' + description: 'Infra Usage of billing metrics. Next ID: 6' type: object + id: InfraUsage + XPSSpeechPreprocessStats: properties: - annotationSpecIdToken: - description: >- - The annotation_spec for which this evaluation metrics instance had - been created. Empty iff this is an overall model evaluation (like - Tables evaluation metrics), i.e. aggregated across all labels. The - value comes from the input annotations in AnnotatedExample. For MVP - product or for text sentiment models where annotation_spec_id_token - is not available, set label instead. - type: string - imageObjectDetectionEvalMetrics: - $ref: '#/components/schemas/XPSImageObjectDetectionEvaluationMetrics' - textClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - label: - type: string - description: >- - The label for which this evaluation metrics instance had been - created. Empty iff this is an overall model evaluation (like Tables - evaluation metrics), i.e. aggregated across all labels. The label - maps to AnnotationSpec.display_name in Public API protos. Only used - by MVP implementation and text sentiment FULL implementation. - videoObjectTrackingEvalMetrics: - $ref: '#/components/schemas/XPSVideoObjectTrackingEvaluationMetrics' - videoActionRecognitionEvalMetrics: - $ref: '#/components/schemas/XPSVideoActionRecognitionEvaluationMetrics' - textSentimentEvalMetrics: - $ref: '#/components/schemas/XPSTextSentimentEvaluationMetrics' - translationEvalMetrics: - $ref: '#/components/schemas/XPSTranslationEvaluationMetrics' - category: + numLogsExamples: format: int32 - description: >- - The integer category label for which this evaluation metric instance - had been created. Valid categories are 0 or higher. Overall model - evaluation should set this to negative values (rather than implicit - zero). Only used for Image Segmentation (prefer to set - annotation_spec_id_token instead). Note: uCAIP Image Segmentation - should use annotation_spec_id_token. + description: The number of samples found in the previously recorded logs data. type: integer - evaluatedExampleCount: + numHumanLabeledExamples: + type: integer + description: The number of rows marked HUMAN_LABELLED + format: int32 + trainSentencesCount: format: int32 type: integer - description: >- - The number of examples used to create this evaluation metrics - instance. - imageClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - textExtractionEvalMetrics: - $ref: '#/components/schemas/XPSTextExtractionEvaluationMetrics' - regressionEvalMetrics: - $ref: '#/components/schemas/XPSRegressionEvaluationMetrics' - tablesEvalMetrics: - $ref: '#/components/schemas/XPSTablesEvaluationMetrics' - videoClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - imageSegmentationEvalMetrics: - $ref: '#/components/schemas/XPSImageSegmentationEvaluationMetrics' - tablesClassificationEvalMetrics: - $ref: '#/components/schemas/XPSClassificationEvaluationMetrics' - description: >- - Contains xPS-specific model evaluation metrics either for a single - annotation spec (label), or for the model overall. Next tag: 18. - XPSTablesDatasetMetadata: - id: XPSTablesDatasetMetadata - properties: - primaryTableSpec: - $ref: '#/components/schemas/XPSTableSpec' - description: Primary table. - targetColumnId: + description: The number of sentences in the training data set. + trainExamplesCount: + description: The number of examples labeled as TRAIN by Speech xps server. + type: integer + format: int32 + dataErrors: + type: array + description: Different types of data errors and the counts associated with them. + items: + $ref: '#/components/schemas/XPSDataErrors' + testExamplesCount: + description: The number of examples labelled as TEST by Speech xps server. format: int32 - description: >- - Id of the primary table column that should be used as the training - label. type: integer - targetColumnCorrelations: - additionalProperties: - $ref: '#/components/schemas/XPSCorrelationStats' - description: '(the column id : its CorrelationStats with target column).' - type: object - mlUseColumnId: + numMachineTranscribedExamples: + type: integer format: int32 - description: Id the column to split the table. + description: The number of rows marked as MACHINE_TRANSCRIBED + testSentencesCount: type: integer - weightColumnId: + description: The number of sentences in the test data set. + format: int32 + trainWordsCount: + format: int32 + description: The number of words in the training data set. type: integer - description: >- - Id of the primary table column that should be used as the weight - column. + testWordsCount: format: int32 + type: integer + description: The number of words in the test data set. + id: XPSSpeechPreprocessStats type: object - description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' - XPSTranslationEvaluationMetrics: - id: XPSTranslationEvaluationMetrics - description: Evaluation metrics for the dataset. - properties: - baseBleuScore: - description: BLEU score for base model. - format: double - type: number - bleuScore: - type: number - format: double - description: BLEU score. + XPSTfJsFormat: + description: >- + A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used + in the browser and in Node.js using JavaScript. + properties: {} type: object - XPSConfusionMatrix: + id: XPSTfJsFormat + Document: type: object - description: Confusion matrix of the model running the classification. - id: XPSConfusionMatrix + description: Represents the input to API methods. properties: - category: - description: >- - Category (mainly for segmentation). Set only for image segmentation - models. Note: uCAIP Image Segmentation should use - annotation_spec_id_token. - type: array - items: - type: integer - format: int32 - row: - items: - $ref: '#/components/schemas/XPSConfusionMatrixRow' - type: array + type: + type: string description: >- - Rows in the confusion matrix. The number of rows is equal to the - size of `annotation_spec_id_token`. `row[i].value[j]` is the number - of examples that have ground truth of the - `annotation_spec_id_token[i]` and are predicted as - `annotation_spec_id_token[j]` by the model being evaluated. - annotationSpecIdToken: - items: - type: string - type: array + Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns + an `INVALID_ARGUMENT` error. + enumDescriptions: + - The content type is not specified. + - Plain text + - HTML + enum: + - TYPE_UNSPECIFIED + - PLAIN_TEXT + - HTML + languageCode: + type: string description: >- - For the following three repeated fields, only one is intended to be - set. annotation_spec_id_token is preferable to be set. ID tokens of - the annotation specs used in the confusion matrix. - sentimentLabel: - type: array + Optional. The language of the document (if not specified, the + language is automatically detected). Both ISO and BCP-47 language + codes are accepted. [Language + Support](https://cloud.google.com/natural-language/docs/languages) + lists currently supported languages for each API method. If the + language (either specified by the caller or automatically detected) + is not supported by the called API method, an `INVALID_ARGUMENT` + error is returned. + gcsContentUri: description: >- - Sentiment labels used in the confusion matrix. Set only for text - sentiment models. For AutoML Text Revamp, use - `annotation_spec_id_token` instead and leave this field empty. - items: - format: int32 - type: integer - XPSBatchPredictResponse: - id: XPSBatchPredictResponse + The Google Cloud Storage URI where the file content is located. This + URI must be of the form: gs://bucket_name/object_name. For more + details, see https://cloud.google.com/storage/docs/reference-uris. + NOTE: Cloud Storage object versioning is not supported. + type: string + content: + description: >- + The content of the input in string format. Cloud audit logging + exempt since it is based on user data. + type: string + id: Document + XPSSpeechPreprocessResponse: + id: XPSSpeechPreprocessResponse properties: - exampleSet: - $ref: '#/components/schemas/XPSExampleSet' + prebuiltModelEvaluationMetrics: + $ref: '#/components/schemas/XPSSpeechEvaluationMetrics' description: >- - Examples for batch prediction result. Under full API implementation, - results are stored in shared RecordIO of AnnotatedExample protobufs, - the annotations field of which is populated by XPS backend. + The metrics for prebuilt speech models. They are included here + because there is no prebuilt speech models stored in the AutoML. + cnsTestDataPath: + type: string + description: Location od shards of sstables (test data) of DataUtterance protos. + speechPreprocessStats: + $ref: '#/components/schemas/XPSSpeechPreprocessStats' + description: Stats associated with the data. + cnsTrainDataPath: + type: string + description: >- + Location of shards of sstables (training data) of DataUtterance + protos. type: object - XPSRow: - id: XPSRow + XPSTablesTrainResponse: + id: XPSTablesTrainResponse type: object properties: - values: - items: - type: any + tablesModelColumnInfo: description: >- - The values of the row cells, given in the same order as the - column_ids. If column_ids is not set, then in the same order as the - input_feature_column_ids in TablesModelMetadata. + Output only. Auxiliary information for each of the + input_feature_column_specs, with respect to this particular model. + items: + $ref: '#/components/schemas/XPSTablesModelColumnInfo' type: array - columnIds: + predictionSampleRows: + type: array + description: Sample rows from the dataset this model was trained. items: - type: integer - format: int32 + $ref: '#/components/schemas/XPSRow' + modelStructure: + $ref: '#/components/schemas/XPSTablesModelStructure' + trainCostMilliNodeHours: + type: string description: >- - The ids of the columns. Note: The below `values` field must match - order of this field, if this field is set. - type: array - XPSColorMap: + The actual training cost of the model, expressed in milli node + hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed + to not exceed the train budget. + format: int64 + Status: properties: - annotationSpecIdToken: - type: string - description: Should be used during training. - intColor: - $ref: '#/components/schemas/XPSColorMapIntColor' - color: - deprecated: true + details: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - This type is deprecated in favor of the IntColor below. This is - because google.type.Color represent color has a float which - semantically does not reflect discrete classes/categories concept. - Moreover, to handle it well we need to have some tolerance when - converting to a discretized color. As such, the recommendation is to - have API surface still use google.type.Color while internally - IntColor is used. - $ref: '#/components/schemas/Color' - displayName: - description: Should be used during preprocessing. + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + code: + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + type: integer + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - description: >- - Map from color to display name. Will only be used by Image Segmentation - for uCAIP. - id: XPSColorMap type: object - XPSXraiAttribution: - deprecated: true + id: Status description: >- - An explanation method that redistributes Integrated Gradients - attributions to segmented regions, taking advantage of the model's fully - differentiable structure. Refer to this paper for more details: - https://arxiv.org/abs/1906.02825 Only supports image Models (modality is - IMAGE). + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + XPSEdgeTpuTfLiteFormat: + description: >- + A model format used for [Edge TPU](https://cloud.google.com/edge-tpu/) + devices. + type: object + properties: {} + id: XPSEdgeTpuTfLiteFormat + XPSVideoExportModelSpec: + id: XPSVideoExportModelSpec properties: - stepCount: + exportModelOutputConfig: + type: array description: >- - The number of steps for approximating the path integral. A good - value to start is 50 and gradually increase until the sum to diff - property is met within the desired error range. Valid range of its - value is [1, 100], inclusively. - format: int32 - type: integer + Contains the model format and internal location of the model files + to be exported/downloaded. Use the GCS bucket name which is provided + via TrainRequest.gcs_bucket_name to store the model files. + items: + $ref: '#/components/schemas/XPSExportModelOutputConfig' type: object - id: XPSXraiAttribution - XPSTablesClassificationMetrics: + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + XPSImageModelServingSpecModelThroughputEstimation: + id: XPSImageModelServingSpecModelThroughputEstimation properties: - curveMetrics: + computeEngineAcceleratorType: + enumDescriptions: + - '' + - Nvidia Tesla K80 GPU. + - Nvidia Tesla P100 GPU. + - Nvidia Tesla V100 GPU. + - Nvidia Tesla P4 GPU. + - Nvidia Tesla T4 GPU. + - Nvidia Tesla A100 GPU. + - Nvidia A100 80GB GPU. + - Nvidia L4 GPU. + - Nvidia H100 80Gb GPU. + - Nvidia H100 80Gb GPU. + - TPU v2 (JellyFish). + - TPU v3 (DragonFish). + - TPU_v4 (PufferFish). + - TPU v5 Lite Pods. + enum: + - UNSPECIFIED + - NVIDIA_TESLA_K80 + - NVIDIA_TESLA_P100 + - NVIDIA_TESLA_V100 + - NVIDIA_TESLA_P4 + - NVIDIA_TESLA_T4 + - NVIDIA_TESLA_A100 + - NVIDIA_A100_80GB + - NVIDIA_L4 + - NVIDIA_H100_80GB + - NVIDIA_H100_MEGA_80GB + - TPU_V2 + - TPU_V3 + - TPU_V4_POD + - TPU_V5_LITEPOD + type: string + servomaticPartitionType: + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + type: string + enumDescriptions: + - '' + - The default partition. + - >- + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - >- + To be used by customers with Jellyfish-accelerated ops. See + go/servomatic-jellyfish for details. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. + nodeQps: + format: double + description: The approximate qps a deployed node can serve. + type: number + latencyInMilliseconds: + description: Estimated latency. + format: double + type: number + type: object + XPSSpeechEvaluationMetrics: + type: object + properties: + subModelEvaluationMetrics: items: - $ref: '#/components/schemas/XPSTablesClassificationMetricsCurveMetrics' + $ref: >- + #/components/schemas/XPSSpeechEvaluationMetricsSubModelEvaluationMetric + description: Evaluation metrics for all submodels contained in this model. type: array - description: Metrics building a curve. + id: XPSSpeechEvaluationMetrics + XPSBoundingBoxMetricsEntry: + properties: + confidenceMetricsEntries: + type: array + items: + $ref: >- + #/components/schemas/XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + description: >- + Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + meanAveragePrecision: + type: number + format: float + description: The mean average precision. + iouThreshold: + description: >- + The intersection-over-union threshold value used to compute this + metrics entry. + type: number + format: float type: object - description: Metrics for Tables classification problems. - id: XPSTablesClassificationMetrics - XPSArrayStats: - id: XPSArrayStats + description: >- + Bounding box matching model metrics for a single intersection-over-union + threshold and multiple label match confidence thresholds. + id: XPSBoundingBoxMetricsEntry + XPSTfLiteFormat: + description: >- + LINT.IfChange A model format used for mobile and IoT devices. See + https://www.tensorflow.org/lite. type: object - properties: - memberStats: - $ref: '#/components/schemas/XPSDataStats' - description: >- - Stats of all the values of all arrays, as if they were a single long - series of data. The type depends on the element type of the array. - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - description: The data statistics of a series of ARRAY values. - XPSTfSavedModelFormat: + id: XPSTfLiteFormat properties: {} + XPSBoundingBoxMetricsEntryConfidenceMetricsEntry: type: object - id: XPSTfSavedModelFormat - description: A tensorflow model format in SavedModel format. - XPSTrainingObjectivePoint: - id: XPSTrainingObjectivePoint - type: object + id: XPSBoundingBoxMetricsEntryConfidenceMetricsEntry + description: Metrics for a single confidence threshold. properties: - createTime: - format: google-datetime - type: string - description: The time at which this point was recorded. - value: + confidenceThreshold: + type: number + format: float + description: The confidence threshold value used to compute the metrics. + precision: + description: Precision for the given confidence threshold. + type: number + format: float + recall: format: float type: number - description: The objective value when this point was recorded. - XPSDataType: + description: Recall for the given confidence threshold. + f1Score: + format: float + description: The harmonic mean of recall and precision. + type: number + Sentiment: + id: Sentiment properties: - nullable: - type: boolean - description: If true, this DataType can also be `null`. - structType: - description: >- - If type_code == STRUCT, then `struct_type` provides type information - for the struct's fields. - $ref: '#/components/schemas/XPSStructType' - listElementType: + score: description: >- - If type_code == ARRAY, then `list_element_type` is the type of the - elements. - $ref: '#/components/schemas/XPSDataType' - typeCode: - enum: - - TYPE_CODE_UNSPECIFIED - - FLOAT64 - - TIMESTAMP - - STRING - - ARRAY - - STRUCT - - CATEGORY - enumDescriptions: - - Not specified. Should not be used. - - >- - Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or - `"-Infinity"`. - - >- - Must be between 0AD and 9999AD. Encoded as `string` according to - time_format, or, if that format is not set, then in RFC 3339 - `date-time` format, where `time-offset` = `"Z"` (e.g. - 1985-04-12T23:20:50.52Z). - - Encoded as `string`. - - >- - Encoded as `list`, where the list elements are represented - according to list_element_type. - - >- - Encoded as `struct`, where field values are represented according - to struct_type. - - >- - Values of this type are not further understood by AutoML, e.g. - AutoML is unable to tell the order of values (as it could with - FLOAT64), or is unable to say if one value contains another (as it - could with STRING). Encoded as `string` (bytes should be - base64-encoded, as described in RFC 4648, section 4). - type: string - description: Required. The TypeCode for this type. - compatibleDataTypes: - type: array - description: The highly compatible data types to this data type. - items: - $ref: '#/components/schemas/XPSDataType' - timeFormat: - type: string + Sentiment score between -1.0 (negative sentiment) and 1.0 (positive + sentiment). + type: number + format: float + magnitude: + type: number description: >- - If type_code == TIMESTAMP then `time_format` provides the format in - which that time field is expressed. The time_format must be written - in `strftime` syntax. If time_format is not set, then the default - format as described on the field is used. + A non-negative number in the [0, +inf) range, which represents the + absolute magnitude of sentiment regardless of score (positive or + negative). + format: float type: object - id: XPSDataType description: >- - Indicated the type of data that can be stored in a structured data - entity (e.g. a table). - XPSTablesModelStructure: - description: A description of Tables model structure. - type: object - properties: - modelParameters: - description: A list of models. - type: array - items: - $ref: '#/components/schemas/XPSTablesModelStructureModelParameters' - id: XPSTablesModelStructure - XPSStructStats: - description: The data statistics of a series of STRUCT values. - id: XPSStructStats + Represents the feeling associated with the entire text or entities in + the text. + XPSMetricEntryLabel: properties: - commonStats: - $ref: '#/components/schemas/XPSCommonStats' - fieldStats: - type: object - additionalProperties: - $ref: '#/components/schemas/XPSDataStats' - description: >- - Map from a field name of the struct to data stats aggregated over - series of all data in that field across all the structs. + labelName: + description: The name of the label. + type: string + labelValue: + type: string + description: The value of the label. + id: XPSMetricEntryLabel type: object XPSSpeechEvaluationMetricsSubModelEvaluationMetric: - id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric type: object + id: XPSSpeechEvaluationMetricsSubModelEvaluationMetric properties: - wer: - type: number - description: Word error rate (standard error metric used for speech recognition). - format: double - numWords: + numSubstitutions: format: int32 type: integer - description: Number of words over which the word error rate was computed. - numInsertions: + numUtterances: format: int32 type: integer - numSubstitutions: - type: integer - format: int32 + description: Number of utterances used in the wer computation. isEnhancedModel: description: >- If true then it means we have an enhanced version of the biasing models. type: boolean - numDeletions: - type: integer - format: int32 - numUtterances: - description: Number of utterances used in the wer computation. + numInsertions: format: int32 type: integer + sentenceAccuracy: + format: double + description: Below fields are used for debugging purposes + type: number + wer: + type: number + description: Word error rate (standard error metric used for speech recognition). + format: double biasingModelType: - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - description: Type of the biasing model. - type: string enumDescriptions: - '' - Build biasing model on top of COMMAND_AND_SEARCH model - Build biasing model on top of PHONE_CALL model - Build biasing model on top of VIDEO model - Build biasing model on top of DEFAULT model - sentenceAccuracy: - type: number - format: double - description: Below fields are used for debugging purposes - XPSTablesModelStructureModelParameters: - description: Model hyper-parameters for a model. - id: XPSTablesModelStructureModelParameters + type: string + description: Type of the biasing model. + enum: + - BIASING_MODEL_TYPE_UNSPECIFIED + - COMMAND_AND_SEARCH + - PHONE_CALL + - VIDEO + - DEFAULT + numWords: + description: Number of words over which the word error rate was computed. + type: integer + format: int32 + numDeletions: + format: int32 + type: integer + AnalyzeEntitiesResponse: type: object properties: - hyperparameters: - type: array + languageCode: + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + type: string + languageSupported: + type: boolean + description: >- + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + entities: items: - $ref: >- - #/components/schemas/XPSTablesModelStructureModelParametersParameter - XPSImageSegmentationEvaluationMetrics: + $ref: '#/components/schemas/Entity' + type: array + description: The recognized entities in the input document. + description: The entity analysis response message. + id: AnalyzeEntitiesResponse + XPSFloat64Stats: properties: - confidenceMetricsEntries: + quantiles: + description: >- + Ordered from 0 to k k-quantile values of the data series of n + values. The value at index i is, approximately, the i*n/k-th + smallest value in the series; for i = 0 and i = k these are, + respectively, the min and max values. + type: array + items: + format: double + type: number + standardDeviation: + type: number + format: double + description: The standard deviation of the series. + mean: + type: number + description: The mean of the series. + format: double + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + histogramBuckets: description: >- - Metrics that have confidence thresholds. Precision-recall curve can - be derived from it. + Histogram buckets of the data series. Sorted by the min value of the + bucket, ascendingly, and the number of the buckets is dynamically + generated. The buckets are non-overlapping and completely cover + whole FLOAT64 range with min of first bucket being `"-Infinity"`, + and max of the last one being `"Infinity"`. items: - $ref: >- - #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + $ref: '#/components/schemas/XPSFloat64StatsHistogramBucket' type: array - id: XPSImageSegmentationEvaluationMetrics - description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' - type: object - GpuMetric: + description: The data statistics of a series of FLOAT64 values. + id: XPSFloat64Stats type: object - id: GpuMetric + XPSTextComponentModel: properties: - machineSpec: + tfRuntimeVersion: + type: string + description: >- + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list + submodelType: + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - Model type for entity extraction. + - Model type for relationship extraction. + - >- + A composite model represents a set of component models that have + to be used together for prediction. A composite model appears to + be a single model to the model user. It may contain only one + component model. Please refer to go/cnl-composite-models for more + information. + - >- + Model type used to train default, MA, and ATC models in a single + batch worker pipeline. + - >- + BERT pipeline needs a specific model type, since it uses a + different TFX configuration compared with DEFAULT (despite sharing + most of the code). + - Model type for EncPaLM. type: string - description: Required. Machine spec, e.g. N1_STANDARD_4. enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 + - TEXT_MODEL_TYPE_UNSPECIFIED + - TEXT_MODEL_TYPE_DEFAULT + - TEXT_MODEL_TYPE_META_ARCHITECT + - TEXT_MODEL_TYPE_ATC + - TEXT_MODEL_TYPE_CLARA2 + - TEXT_MODEL_TYPE_CHATBASE + - TEXT_MODEL_TYPE_SAFT_SPAN_LABELING + - TEXT_MODEL_TYPE_TEXT_EXTRACTION + - TEXT_MODEL_TYPE_RELATIONSHIP_EXTRACTION + - TEXT_MODEL_TYPE_COMPOSITE + - TEXT_MODEL_TYPE_ALL_MODELS + - TEXT_MODEL_TYPE_BERT + - TEXT_MODEL_TYPE_ENC_PALM + description: The type of trained NL submodel + batchPredictionModelGcsUri: + type: string + description: The Cloud Storage resource path to hold batch prediction model. + partition: + description: >- + The partition where the model is deployed. Populated by uCAIP BE as + part of online PredictRequest. + type: string + enum: + - PARTITION_TYPE_UNSPECIFIED + - PARTITION_ZERO + - PARTITION_REDUCED_HOMING + - PARTITION_JELLYFISH + - PARTITION_CPU + - PARTITION_CUSTOM_STORAGE_CPU + enumDescriptions: + - '' + - The default partition. + - >- + It has significantly lower replication than partition-0 and is + located in the US only. It also has a larger model size limit and + higher default RAM quota than partition-0. Customers with batch + traffic, US-based traffic, or very large models should use this + partition. Capacity in this partition is significantly cheaper + than partition-0. + - >- + To be used by customers with Jellyfish-accelerated ops. See + go/servomatic-jellyfish for details. + - The partition used by regionalized servomatic cloud regions. + - The partition used for loading models from custom storage. + submodelName: + type: string + description: The name of the trained NL submodel. + servoModelName: + description: >- + The name of servo model. Populated by uCAIP BE as part of online + PredictRequest. + type: string + servingArtifact: + description: >- + The default model binary file used for serving (e.g. online predict, + batch predict) via public Cloud Ai Platform API. + $ref: '#/components/schemas/XPSModelArtifactItem' + versionNumber: + type: string + format: int64 + description: >- + The servomatic model version number. Populated by uCAIP BE as part + of online PredictRequest. + onlinePredictionModelGcsUri: + description: The Cloud Storage resource path to hold online prediction model. + type: string + type: object + id: XPSTextComponentModel + description: 'Component model. Next ID: 10' + XPSTranslationPreprocessResponse: + properties: + validExampleCount: + format: int64 + description: Total valid example count. + type: string + parsedExampleCount: + description: Total example count parsed. + type: string + format: int64 + id: XPSTranslationPreprocessResponse + type: object + description: Translation preprocess response. + CpuMetric: + type: object + properties: + cpuType: + type: string + enumDescriptions: + - '' + - GPU-based machine, skip quota reporting. + - GPU-based machine, skip quota reporting. + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - GPU-based machine, skip quota reporting. + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' + - '' + - '' + description: Required. Type of cpu, e.g. N2. + enum: + - UNKNOWN_CPU_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D + coreNumber: + description: Required. Number of CPU cores. + format: int64 + type: string + trackingLabels: + type: object + additionalProperties: + type: string + description: >- + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" + machineSpec: enumDescriptions: - '' - '' @@ -3346,317 +2957,501 @@ components: - '' - '' - '' - gpuSec: - description: Required. Seconds of GPU usage, e.g. 3600. + - '' + - '' + - '' type: string - format: int64 - trackingLabels: - type: object - additionalProperties: - type: string - description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - gpuType: + enum: + - UNKNOWN_MACHINE_SPEC + - N1_STANDARD_2 + - N1_STANDARD_4 + - N1_STANDARD_8 + - N1_STANDARD_16 + - N1_STANDARD_32 + - N1_STANDARD_64 + - N1_STANDARD_96 + - N1_HIGHMEM_2 + - N1_HIGHMEM_4 + - N1_HIGHMEM_8 + - N1_HIGHMEM_16 + - N1_HIGHMEM_32 + - N1_HIGHMEM_64 + - N1_HIGHMEM_96 + - N1_HIGHCPU_2 + - N1_HIGHCPU_4 + - N1_HIGHCPU_8 + - N1_HIGHCPU_16 + - N1_HIGHCPU_32 + - N1_HIGHCPU_64 + - N1_HIGHCPU_96 + - A2_HIGHGPU_1G + - A2_HIGHGPU_2G + - A2_HIGHGPU_4G + - A2_HIGHGPU_8G + - A2_MEGAGPU_16G + - A2_ULTRAGPU_1G + - A2_ULTRAGPU_2G + - A2_ULTRAGPU_4G + - A2_ULTRAGPU_8G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G + - A3_HIGHGPU_8G + - A3_MEGAGPU_8G + - E2_STANDARD_2 + - E2_STANDARD_4 + - E2_STANDARD_8 + - E2_STANDARD_16 + - E2_STANDARD_32 + - E2_HIGHMEM_2 + - E2_HIGHMEM_4 + - E2_HIGHMEM_8 + - E2_HIGHMEM_16 + - E2_HIGHCPU_2 + - E2_HIGHCPU_4 + - E2_HIGHCPU_8 + - E2_HIGHCPU_16 + - E2_HIGHCPU_32 + - N2_STANDARD_2 + - N2_STANDARD_4 + - N2_STANDARD_8 + - N2_STANDARD_16 + - N2_STANDARD_32 + - N2_STANDARD_48 + - N2_STANDARD_64 + - N2_STANDARD_80 + - N2_STANDARD_96 + - N2_STANDARD_128 + - N2_HIGHMEM_2 + - N2_HIGHMEM_4 + - N2_HIGHMEM_8 + - N2_HIGHMEM_16 + - N2_HIGHMEM_32 + - N2_HIGHMEM_48 + - N2_HIGHMEM_64 + - N2_HIGHMEM_80 + - N2_HIGHMEM_96 + - N2_HIGHMEM_128 + - N2_HIGHCPU_2 + - N2_HIGHCPU_4 + - N2_HIGHCPU_8 + - N2_HIGHCPU_16 + - N2_HIGHCPU_32 + - N2_HIGHCPU_48 + - N2_HIGHCPU_64 + - N2_HIGHCPU_80 + - N2_HIGHCPU_96 + - N2D_STANDARD_2 + - N2D_STANDARD_4 + - N2D_STANDARD_8 + - N2D_STANDARD_16 + - N2D_STANDARD_32 + - N2D_STANDARD_48 + - N2D_STANDARD_64 + - N2D_STANDARD_80 + - N2D_STANDARD_96 + - N2D_STANDARD_128 + - N2D_STANDARD_224 + - N2D_HIGHMEM_2 + - N2D_HIGHMEM_4 + - N2D_HIGHMEM_8 + - N2D_HIGHMEM_16 + - N2D_HIGHMEM_32 + - N2D_HIGHMEM_48 + - N2D_HIGHMEM_64 + - N2D_HIGHMEM_80 + - N2D_HIGHMEM_96 + - N2D_HIGHCPU_2 + - N2D_HIGHCPU_4 + - N2D_HIGHCPU_8 + - N2D_HIGHCPU_16 + - N2D_HIGHCPU_32 + - N2D_HIGHCPU_48 + - N2D_HIGHCPU_64 + - N2D_HIGHCPU_80 + - N2D_HIGHCPU_96 + - N2D_HIGHCPU_128 + - N2D_HIGHCPU_224 + - C2_STANDARD_4 + - C2_STANDARD_8 + - C2_STANDARD_16 + - C2_STANDARD_30 + - C2_STANDARD_60 + - C2D_STANDARD_2 + - C2D_STANDARD_4 + - C2D_STANDARD_8 + - C2D_STANDARD_16 + - C2D_STANDARD_32 + - C2D_STANDARD_56 + - C2D_STANDARD_112 + - C2D_HIGHCPU_2 + - C2D_HIGHCPU_4 + - C2D_HIGHCPU_8 + - C2D_HIGHCPU_16 + - C2D_HIGHCPU_32 + - C2D_HIGHCPU_56 + - C2D_HIGHCPU_112 + - C2D_HIGHMEM_2 + - C2D_HIGHMEM_4 + - C2D_HIGHMEM_8 + - C2D_HIGHMEM_16 + - C2D_HIGHMEM_32 + - C2D_HIGHMEM_56 + - C2D_HIGHMEM_112 + - G2_STANDARD_4 + - G2_STANDARD_8 + - G2_STANDARD_12 + - G2_STANDARD_16 + - G2_STANDARD_24 + - G2_STANDARD_32 + - G2_STANDARD_48 + - G2_STANDARD_96 + - C3_STANDARD_4 + - C3_STANDARD_8 + - C3_STANDARD_22 + - C3_STANDARD_44 + - C3_STANDARD_88 + - C3_STANDARD_176 + - C3_HIGHCPU_4 + - C3_HIGHCPU_8 + - C3_HIGHCPU_22 + - C3_HIGHCPU_44 + - C3_HIGHCPU_88 + - C3_HIGHCPU_176 + - C3_HIGHMEM_4 + - C3_HIGHMEM_8 + - C3_HIGHMEM_22 + - C3_HIGHMEM_44 + - C3_HIGHMEM_88 + - C3_HIGHMEM_176 + description: Required. Machine spec, e.g. N1_STANDARD_4. + coreSec: + description: Required. Total seconds of core usage, e.g. 4. type: string - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - description: Required. Type of GPU, e.g. NVIDIA_TESLA_V100. - enum: - - UNKNOWN_GPU_TYPE - - NVIDIA_TESLA_A100 - - NVIDIA_A100_80GB - - NVIDIA_TESLA_K80 - - NVIDIA_L4 - - NVIDIA_TESLA_P100 - - NVIDIA_TESLA_P4 - - NVIDIA_TESLA_T4 - - NVIDIA_TESLA_V100 - - NVIDIA_H100_80GB - XPSTablesTrainResponse: - properties: - trainCostMilliNodeHours: format: int64 - type: string + id: CpuMetric + description: Metric for billing reports. + XPSVideoActionRecognitionEvaluationMetrics: + properties: + evaluatedActionCount: + type: integer + format: int32 description: >- - The actual training cost of the model, expressed in milli node - hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed - to not exceed the train budget. - predictionSampleRows: - description: Sample rows from the dataset this model was trained. - items: - $ref: '#/components/schemas/XPSRow' - type: array - tablesModelColumnInfo: + Output only. The number of ground truth actions used to create this + evaluation. + videoActionMetricsEntries: items: - $ref: '#/components/schemas/XPSTablesModelColumnInfo' - type: array + $ref: '#/components/schemas/XPSVideoActionMetricsEntry' description: >- - Output only. Auxiliary information for each of the - input_feature_column_specs, with respect to this particular model. - modelStructure: - $ref: '#/components/schemas/XPSTablesModelStructure' - id: XPSTablesTrainResponse - type: object - TpuMetric: - properties: - tpuSec: - description: Required. Seconds of TPU usage, e.g. 3600. - format: int64 - type: string - tpuType: - enum: - - UNKNOWN_TPU_TYPE - - TPU_V2_POD - - TPU_V2 - - TPU_V3_POD - - TPU_V3 - - TPU_V5_LITEPOD - type: string - description: Required. Type of TPU, e.g. TPU_V2, TPU_V3_POD. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - type: object - id: TpuMetric - XPSDataStats: - id: XPSDataStats + Output only. The metric entries for precision window lengths: + 1s,2s,3s,4s, 5s. + type: array type: object - properties: - validValueCount: - description: The number of values that are valid. - format: int64 - type: string - float64Stats: - description: The statistics for FLOAT64 DataType. - $ref: '#/components/schemas/XPSFloat64Stats' - stringStats: - description: The statistics for STRING DataType. - $ref: '#/components/schemas/XPSStringStats' - categoryStats: - description: The statistics for CATEGORY DataType. - $ref: '#/components/schemas/XPSCategoryStats' - distinctValueCount: - format: int64 - type: string - description: The number of distinct values. - structStats: - $ref: '#/components/schemas/XPSStructStats' - description: The statistics for STRUCT DataType. - arrayStats: - $ref: '#/components/schemas/XPSArrayStats' - description: The statistics for ARRAY DataType. - nullValueCount: - description: The number of values that are null. - type: string - format: int64 - timestampStats: - $ref: '#/components/schemas/XPSTimestampStats' - description: The statistics for TIMESTAMP DataType. - description: The data statistics of a series of values that share the same DataType. - ClassificationCategory: + id: XPSVideoActionRecognitionEvaluationMetrics + description: Model evaluation metrics for video action recognition. + XPSRegressionEvaluationMetrics: + description: >- + Model evaluation metrics for regression problems. It can be used for + Tables. type: object properties: - confidence: - description: >- - The classifier's confidence of the category. Number represents how - certain the classifier is that this category represents the given - text. + rSquared: format: float type: number - name: - description: The name of the category representing the document. - type: string - description: Represents a category returned from the text classifier. - id: ClassificationCategory - XPSVideoActionMetricsEntryConfidenceMetricsEntry: - type: object - id: XPSVideoActionMetricsEntryConfidenceMetricsEntry - description: Metrics for a single confidence threshold. - properties: - confidenceThreshold: - format: float + description: R squared. + rootMeanSquaredError: type: number + description: Root Mean Squared Error (RMSE). + format: float + regressionMetricsEntries: description: >- - Output only. The confidence threshold value used to compute the - metrics. - recall: - type: number + A list of actual versus predicted points for the model being + evaluated. + type: array + items: + $ref: '#/components/schemas/XPSRegressionMetricsEntry' + meanAbsolutePercentageError: + description: >- + Mean absolute percentage error. Only set if all ground truth values + are positive. format: float - description: Output only. Recall for the given confidence threshold. - precision: - description: Output only. Precision for the given confidence threshold. type: number - format: float - f1Score: - description: Output only. The harmonic mean of recall and precision. + meanAbsoluteError: type: number + description: Mean Absolute Error (MAE). format: float - XPSDockerFormat: + rootMeanSquaredLogError: + format: float + type: number + description: Root mean squared log error. + id: XPSRegressionEvaluationMetrics + XPSFloat64StatsHistogramBucket: type: object - description: >- - A model format used for Docker containers. Use the params field to - customize the container. The container is verified to work correctly on - ubuntu 16.04 operating system. - id: XPSDockerFormat properties: - cpuArchitecture: - enum: - - CPU_ARCHITECTURE_UNSPECIFIED - - CPU_ARCHITECTURE_X86_64 - enumDescriptions: - - '' - - '' + max: + type: number + format: double description: >- - Optional. Additional cpu information describing the requirements for - the to be exported model files. - type: string - gpuArchitecture: + The maximum value of the bucket, exclusive unless max = + `"Infinity"`, in which case it's inclusive. + count: description: >- - Optional. Additional gpu information describing the requirements for - the to be exported model files. - enum: - - GPU_ARCHITECTURE_UNSPECIFIED - - GPU_ARCHITECTURE_NVIDIA + The number of data values that are in the bucket, i.e. are between + min and max values. + format: int64 type: string - enumDescriptions: - - '' - - '' - XPSTablesEvaluationMetrics: - id: XPSTablesEvaluationMetrics - type: object - properties: - regressionMetrics: - $ref: '#/components/schemas/XPSTablesRegressionMetrics' - description: Regression metrics. - classificationMetrics: - description: Classification metrics. - $ref: '#/components/schemas/XPSTablesClassificationMetrics' - XPSSpeechModelSpecSubModelSpec: - id: XPSSpeechModelSpecSubModelSpec + min: + format: double + description: The minimum value of the bucket, inclusive. + type: number + description: A bucket of a histogram. + id: XPSFloat64StatsHistogramBucket + XPSEvaluationMetricsSet: properties: - contextId: - type: string - description: In S3, Recognition ClientContextId.context_id - biasingModelType: - type: string - description: Type of the biasing model. - enumDescriptions: - - '' - - Build biasing model on top of COMMAND_AND_SEARCH model - - Build biasing model on top of PHONE_CALL model - - Build biasing model on top of VIDEO model - - Build biasing model on top of DEFAULT model - enum: - - BIASING_MODEL_TYPE_UNSPECIFIED - - COMMAND_AND_SEARCH - - PHONE_CALL - - VIDEO - - DEFAULT - isEnhancedModel: - type: boolean + fileSpec: + $ref: '#/components/schemas/XPSFileSpec' description: >- - If true then it means we have an enhanced version of the biasing - models. - clientId: - description: In S3, Recognition ClientContextId.client_id + File spec containing evaluation metrics of a model, must point to + RecordIO file(s) of intelligence.cloud.automl.xps.EvaluationMetrics + messages. + evaluationMetrics: + type: array + items: + $ref: '#/components/schemas/XPSEvaluationMetrics' + description: >- + Inline EvaluationMetrics - should be relatively small. For passing + large quantities of exhaustive metrics, use file_spec. + numEvaluationMetrics: type: string + format: int64 + description: >- + Number of the evaluation metrics (usually one per label plus + overall). + description: Specifies location of model evaluation metrics. type: object - XPSRegressionEvaluationMetrics: + id: XPSEvaluationMetricsSet + XPSConfidenceMetricsEntry: properties: - rootMeanSquaredError: + precision: type: number + description: Precision for the given confidence threshold. format: float - description: Root Mean Squared Error (RMSE). - rSquared: + f1ScoreAt1: type: number + description: The harmonic mean of recall_at1 and precision_at1. format: float - description: R squared. - meanAbsoluteError: - description: Mean Absolute Error (MAE). + falsePositiveRate: + format: float + type: number + description: False Positive Rate for the given confidence threshold. + falseNegativeCount: + format: int64 + type: string + description: >- + The number of ground truth labels that are not matched by a model + created label. + positionThreshold: + type: integer + format: int32 + description: >- + Metrics are computed with an assumption that the model always + returns at most this many predictions (ordered by their score, + descendingly), but they all still need to meet the + confidence_threshold. + recallAt1: type: number + description: >- + The recall (true positive rate) when only considering the label that + has the highest prediction score and not below the confidence + threshold for each example. format: float - rootMeanSquaredLogError: + precisionAt1: type: number - description: Root mean squared log error. format: float - meanAbsolutePercentageError: + description: >- + The precision when only considering the label that has the highest + prediction score and not below the confidence threshold for each + example. + recall: + format: float + description: Recall (true positive rate) for the given confidence threshold. type: number + confidenceThreshold: description: >- - Mean absolute percentage error. Only set if all ground truth values - are positive. + Metrics are computed with an assumption that the model never return + predictions with score lower than this value. + type: number format: float - regressionMetricsEntries: - items: - $ref: '#/components/schemas/XPSRegressionMetricsEntry' + truePositiveCount: + format: int64 + description: The number of model created labels that match a ground truth label. + type: string + trueNegativeCount: + type: string + format: int64 description: >- - A list of actual versus predicted points for the model being - evaluated. - type: array + The number of labels that were not created by the model, but if they + would, they would not match a ground truth label. + falsePositiveRateAt1: + format: float + description: >- + The False Positive Rate when only considering the label that has the + highest prediction score and not below the confidence threshold for + each example. + type: number + falsePositiveCount: + description: >- + The number of model created labels that do not match a ground truth + label. + type: string + format: int64 + f1Score: + format: float + type: number + description: The harmonic mean of recall and precision. + type: object + id: XPSConfidenceMetricsEntry description: >- - Model evaluation metrics for regression problems. It can be used for - Tables. - id: XPSRegressionEvaluationMetrics + ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. + Next tag: 16. + XPSXpsOperationMetadata: type: object - InfraUsage: - id: InfraUsage + id: XPSXpsOperationMetadata properties: - tpuMetrics: - type: array - description: Aggregated tpu metrics since requested start_time. - items: - $ref: '#/components/schemas/TpuMetric' - cpuMetrics: - description: Aggregated core metrics since requested start_time. - items: - $ref: '#/components/schemas/CpuMetric' - type: array - ramMetrics: - type: array - description: Aggregated ram metrics since requested start_time. - items: - $ref: '#/components/schemas/RamMetric' - diskMetrics: - type: array - description: Aggregated persistent disk metrics since requested start_time. - items: - $ref: '#/components/schemas/DiskMetric' - gpuMetrics: + exampleCount: + format: int64 + type: string + description: >- + Optional. XPS server can opt to provide example count of the long + running operation (e.g. training, data importing, batch prediction). + reportingMetrics: + $ref: '#/components/schemas/XPSReportingMetrics' + description: >- + Metrics for the operation. By the time the operation is terminated + (whether succeeded or failed) as returned from XPS, AutoML BE + assumes the metrics are finalized. AutoML BE transparently posts the + metrics to Chemist if it's not empty, regardless of the response + content or error type. If user is supposed to be charged in case of + cancellation/error, this field should be set. In the case where the + type of LRO doesn't require any billing, this field should be left + unset. + tablesTrainingOperationMetadata: + $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' + videoBatchPredictOperationMetadata: + $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' + visionTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' + videoTrainingOperationMetadata: + $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' + XPSDataErrors: + properties: + count: + description: Number of records having errors associated with the enum. + format: int32 + type: integer + errorType: + type: string + description: Type of the error. + enum: + - ERROR_TYPE_UNSPECIFIED + - UNSUPPORTED_AUDIO_FORMAT + - FILE_EXTENSION_MISMATCH_WITH_AUDIO_FORMAT + - FILE_TOO_LARGE + - MISSING_TRANSCRIPTION + enumDescriptions: + - Not specified. + - >- + Audio format not in the formats by cloud-speech AutoML. Currently + only wav and flac file formats are supported. + - >- + File format differnt from what is specified in the file name + extension. + - File too large. Maximum allowed size is 50 MB. + - Transcript is missing. + id: XPSDataErrors + type: object + description: Different types of errors and the stats associatesd with each error. + XPSDataType: + type: object + description: >- + Indicated the type of data that can be stored in a structured data + entity (e.g. a table). + id: XPSDataType + properties: + timeFormat: + type: string + description: >- + If type_code == TIMESTAMP then `time_format` provides the format in + which that time field is expressed. The time_format must be written + in `strftime` syntax. If time_format is not set, then the default + format as described on the field is used. + compatibleDataTypes: + description: The highly compatible data types to this data type. items: - $ref: '#/components/schemas/GpuMetric' - description: Aggregated gpu metrics since requested start_time. + $ref: '#/components/schemas/XPSDataType' type: array - description: 'Infra Usage of billing metrics. Next ID: 6' - type: object + listElementType: + $ref: '#/components/schemas/XPSDataType' + description: >- + If type_code == ARRAY, then `list_element_type` is the type of the + elements. + typeCode: + description: Required. The TypeCode for this type. + enum: + - TYPE_CODE_UNSPECIFIED + - FLOAT64 + - TIMESTAMP + - STRING + - ARRAY + - STRUCT + - CATEGORY + enumDescriptions: + - Not specified. Should not be used. + - >- + Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or + `"-Infinity"`. + - >- + Must be between 0AD and 9999AD. Encoded as `string` according to + time_format, or, if that format is not set, then in RFC 3339 + `date-time` format, where `time-offset` = `"Z"` (e.g. + 1985-04-12T23:20:50.52Z). + - Encoded as `string`. + - >- + Encoded as `list`, where the list elements are represented + according to list_element_type. + - >- + Encoded as `struct`, where field values are represented according + to struct_type. + - >- + Values of this type are not further understood by AutoML, e.g. + AutoML is unable to tell the order of values (as it could with + FLOAT64), or is unable to say if one value contains another (as it + could with STRING). Encoded as `string` (bytes should be + base64-encoded, as described in RFC 4648, section 4). + type: string + nullable: + type: boolean + description: If true, this DataType can also be `null`. + structType: + $ref: '#/components/schemas/XPSStructType' + description: >- + If type_code == STRUCT, then `struct_type` provides type information + for the struct's fields. AnnotateTextResponse: description: The text annotations response message. - id: AnnotateTextResponse properties: - documentSentiment: + sentences: description: >- - The overall sentiment for the document. Populated if the user - enables AnnotateTextRequest.Features.extract_document_sentiment. - $ref: '#/components/schemas/Sentiment' - categories: - type: array + Sentences in the input document. Populated if the user enables + AnnotateTextRequest.Features.extract_document_sentiment. items: - $ref: '#/components/schemas/ClassificationCategory' - description: Categories identified in the input document. + $ref: '#/components/schemas/Sentence' + type: array + languageSupported: + description: >- + Whether the language is officially supported by all requested + features. The API may still return a response when the language is + not supported, but it is on a best effort basis. + type: boolean languageCode: type: string description: >- @@ -3664,631 +3459,772 @@ components: specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details. - sentences: - description: >- - Sentences in the input document. Populated if the user enables - AnnotateTextRequest.Features.extract_document_sentiment. + categories: + description: Categories identified in the input document. type: array - items: - $ref: '#/components/schemas/Sentence' - moderationCategories: - description: Harmful and sensitive categories identified in the input document. items: $ref: '#/components/schemas/ClassificationCategory' - type: array + documentSentiment: + $ref: '#/components/schemas/Sentiment' + description: >- + The overall sentiment for the document. Populated if the user + enables AnnotateTextRequest.Features.extract_document_sentiment. entities: type: array - items: - $ref: '#/components/schemas/Entity' description: >- Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment. - languageSupported: - type: boolean - description: >- - Whether the language is officially supported by all requested - features. The API may still return a response when the language is - not supported, but it is on a best effort basis. + items: + $ref: '#/components/schemas/Entity' + moderationCategories: + items: + $ref: '#/components/schemas/ClassificationCategory' + type: array + description: Harmful and sensitive categories identified in the input document. type: object - XPSFloat64StatsHistogramBucket: - id: XPSFloat64StatsHistogramBucket - description: A bucket of a histogram. + id: AnnotateTextResponse + XPSTextTrainResponse: properties: - max: - description: >- - The maximum value of the bucket, exclusive unless max = - `"Infinity"`, in which case it's inclusive. + componentModel: + items: + $ref: '#/components/schemas/XPSTextComponentModel' + type: array + description: Component submodels. + type: object + id: XPSTextTrainResponse + XPSImageModelServingSpec: + type: object + id: XPSImageModelServingSpec + properties: + nodeQps: type: number format: double - min: - format: double - description: The minimum value of the bucket, inclusive. - type: number - count: + description: >- + An estimated value of how much traffic a node can serve. Populated + for AutoMl request only. + tfRuntimeVersion: + description: >- + ## The fields below are only populated under uCAIP request scope. + https://cloud.google.com/ml-engine/docs/runtime-version-list type: string + modelThroughputEstimation: + type: array + items: + $ref: >- + #/components/schemas/XPSImageModelServingSpecModelThroughputEstimation + description: Populate under uCAIP request scope. + description: Serving specification for image models. + XPSTrackMetricsEntryConfidenceMetricsEntry: + id: XPSTrackMetricsEntryConfidenceMetricsEntry + properties: + trackingPrecision: + description: Output only. Tracking precision. + format: float + type: number + trackingRecall: + format: float + description: Output only. Tracking recall. + type: number + confidenceThreshold: + type: number + format: float description: >- - The number of data values that are in the bucket, i.e. are between - min and max values. + Output only. The confidence threshold value used to compute the + metrics. + mismatchRate: + type: number + description: >- + Output only. Mismatch rate, which measures the tracking consistency, + i.e. correctness of instance ID continuity. + format: float + boundingBoxIou: + format: float + type: number + description: >- + Output only. Bounding box intersection-over-union precision. + Measures how well the bounding boxes overlap between each other + (e.g. complete overlap or just barely above iou_threshold). + description: 'Metrics for a single confidence threshold. Next tag: 6.' + type: object + XPSVideoObjectTrackingTrainResponse: + id: XPSVideoObjectTrackingTrainResponse + type: object + properties: + modelArtifactSpec: + description: '## The fields below are only populated under uCAIP request scope.' + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + trainCostNodeSeconds: format: int64 + type: string + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + exportModelSpec: + description: Populated for AutoML request only. + $ref: '#/components/schemas/XPSVideoExportModelSpec' + XPSTrackMetricsEntry: + id: XPSTrackMetricsEntry + properties: + meanBoundingBoxIou: + type: number + description: >- + Output only. The mean bounding box iou over all confidence + thresholds. + format: float + meanMismatchRate: + description: Output only. The mean mismatch rate over all confidence thresholds. + type: number + format: float + meanTrackingAveragePrecision: + type: number + format: float + description: >- + Output only. The mean average precision over all confidence + thresholds. + iouThreshold: + type: number + format: float + description: >- + Output only. The intersection-over-union threshold value between + bounding boxes across frames used to compute this metric entry. + confidenceMetricsEntries: + description: >- + Output only. Metrics for each label-match confidence_threshold from + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is + derived from them. + items: + $ref: '#/components/schemas/XPSTrackMetricsEntryConfidenceMetricsEntry' + type: array + description: >- + Track matching model metrics for a single track match threshold and + multiple label match confidence thresholds. Next tag: 6. type: object - XPSImageObjectDetectionEvaluationMetrics: + XPSResponseExplanationParameters: + properties: + xraiAttribution: + description: >- + An attribution method that redistributes Integrated Gradients + attribution to segmented regions, taking advantage of the model's + fully differentiable structure. Refer to this paper for more + details: https://arxiv.org/abs/1906.02825 XRAI currently performs + better on natural images, like a picture of a house or an animal. If + the images are taken in artificial environments, like a lab or + manufacturing line, or from diagnostic equipment, like x-rays or + quality-control cameras, use Integrated Gradients instead. + $ref: '#/components/schemas/XPSXraiAttribution' + integratedGradientsAttribution: + $ref: '#/components/schemas/XPSIntegratedGradientsAttribution' + description: >- + An attribution method that computes Aumann-Shapley values taking + advantage of the model's fully differentiable structure. Refer to + this paper for more details: https://arxiv.org/abs/1703.01365 type: object + id: XPSResponseExplanationParameters + deprecated: true + XPSImageObjectDetectionEvaluationMetrics: properties: boundingBoxMetricsEntries: + items: + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' description: >- The bounding boxes match metrics for each Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair. type: array - items: - $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' - evaluatedBoundingBoxCount: - format: int32 - description: >- - The total number of bounding boxes (i.e. summed over all images) the - ground truth used to create this evaluation had. - type: integer boundingBoxMeanAveragePrecision: - format: float + type: number description: >- The single metric for bounding boxes evaluation: the mean_average_precision averaged over all bounding_box_metrics_entries. - type: number + format: float + evaluatedBoundingBoxCount: + type: integer + description: >- + The total number of bounding boxes (i.e. summed over all images) the + ground truth used to create this evaluation had. + format: int32 + id: XPSImageObjectDetectionEvaluationMetrics description: >- Model evaluation metrics for image object detection problems. Evaluates prediction quality of labeled bounding boxes. - id: XPSImageObjectDetectionEvaluationMetrics - RamMetric: + type: object + XPSVisionTrainingOperationMetadata: properties: - gibSec: + explanationUsage: + $ref: '#/components/schemas/InfraUsage' + description: >- + Aggregated infra usage within certain time period, for billing + report purpose if XAI is enable in training request. + type: object + deprecated: true + id: XPSVisionTrainingOperationMetadata + XPSColumnSpec: + id: XPSColumnSpec + properties: + topCorrelatedColumns: + items: + $ref: '#/components/schemas/XPSColumnSpecCorrelatedColumn' + description: It's outputed in RefreshTablesStats, and a required input in Train. + type: array + columnId: + format: int32 + type: integer + description: >- + The unique id of the column. When Preprocess, the Tables BE will + popuate the order id of the column, which reflects the order of the + column inside the table, i.e. 0 means the first column in the table, + N-1 means the last column. AutoML BE will persist this order id in + Spanner and set the order id here when calling RefreshTablesStats + and Train. Note: it's different than the column_spec_id that is + generated in AutoML BE. + forecastingMetadata: + $ref: '#/components/schemas/XPSColumnSpecForecastingMetadata' + dataType: + $ref: '#/components/schemas/XPSDataType' description: >- - Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type - to match billing metrics definition. + The data type of the column. It's outputed in Preprocess rpc and a + required input for RefreshTablesStats and Train. + dataStats: + $ref: '#/components/schemas/XPSDataStats' + description: >- + The data stats of the column. It's outputed in RefreshTablesStats + and a required input for Train. + displayName: + description: >- + The display name of the column. It's outputed in Preprocess and a + required input for RefreshTablesStats and Train. type: string + type: object + XPSTextToSpeechTrainResponse: + id: XPSTextToSpeechTrainResponse + type: object + properties: {} + description: TextToSpeech train response + XPSTimestampStats: + properties: + medianTimestampNanos: format: int64 - trackingLabels: + type: string + granularStats: + additionalProperties: + $ref: '#/components/schemas/XPSTimestampStatsGranularStats' description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" + The string key is the pre-defined granularity. Currently supported: + hour_of_day, day_of_week, month_of_year. Granularities finer that + the granularity of timestamp data are not populated (e.g. if + timestamps are at day granularity, then hour_of_day is not + populated). type: object - additionalProperties: - type: string - memories: - format: double - type: number - description: Required. VM memory in gb. - machineSpec: - type: string - description: Required. Machine spec, e.g. N1_STANDARD_4. + commonStats: + $ref: '#/components/schemas/XPSCommonStats' + description: The data statistics of a series of TIMESTAMP values. + id: XPSTimestampStats + type: object + AnnotateTextRequest: + properties: + encodingType: + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. enum: - - UNKNOWN_MACHINE_SPEC - - N1_STANDARD_2 - - N1_STANDARD_4 - - N1_STANDARD_8 - - N1_STANDARD_16 - - N1_STANDARD_32 - - N1_STANDARD_64 - - N1_STANDARD_96 - - N1_HIGHMEM_2 - - N1_HIGHMEM_4 - - N1_HIGHMEM_8 - - N1_HIGHMEM_16 - - N1_HIGHMEM_32 - - N1_HIGHMEM_64 - - N1_HIGHMEM_96 - - N1_HIGHCPU_2 - - N1_HIGHCPU_4 - - N1_HIGHCPU_8 - - N1_HIGHCPU_16 - - N1_HIGHCPU_32 - - N1_HIGHCPU_64 - - N1_HIGHCPU_96 - - A2_HIGHGPU_1G - - A2_HIGHGPU_2G - - A2_HIGHGPU_4G - - A2_HIGHGPU_8G - - A2_MEGAGPU_16G - - A2_ULTRAGPU_1G - - A2_ULTRAGPU_2G - - A2_ULTRAGPU_4G - - A2_ULTRAGPU_8G - - A3_HIGHGPU_8G - - E2_STANDARD_2 - - E2_STANDARD_4 - - E2_STANDARD_8 - - E2_STANDARD_16 - - E2_STANDARD_32 - - E2_HIGHMEM_2 - - E2_HIGHMEM_4 - - E2_HIGHMEM_8 - - E2_HIGHMEM_16 - - E2_HIGHCPU_2 - - E2_HIGHCPU_4 - - E2_HIGHCPU_8 - - E2_HIGHCPU_16 - - E2_HIGHCPU_32 - - N2_STANDARD_2 - - N2_STANDARD_4 - - N2_STANDARD_8 - - N2_STANDARD_16 - - N2_STANDARD_32 - - N2_STANDARD_48 - - N2_STANDARD_64 - - N2_STANDARD_80 - - N2_STANDARD_96 - - N2_STANDARD_128 - - N2_HIGHMEM_2 - - N2_HIGHMEM_4 - - N2_HIGHMEM_8 - - N2_HIGHMEM_16 - - N2_HIGHMEM_32 - - N2_HIGHMEM_48 - - N2_HIGHMEM_64 - - N2_HIGHMEM_80 - - N2_HIGHMEM_96 - - N2_HIGHMEM_128 - - N2_HIGHCPU_2 - - N2_HIGHCPU_4 - - N2_HIGHCPU_8 - - N2_HIGHCPU_16 - - N2_HIGHCPU_32 - - N2_HIGHCPU_48 - - N2_HIGHCPU_64 - - N2_HIGHCPU_80 - - N2_HIGHCPU_96 - - N2D_STANDARD_2 - - N2D_STANDARD_4 - - N2D_STANDARD_8 - - N2D_STANDARD_16 - - N2D_STANDARD_32 - - N2D_STANDARD_48 - - N2D_STANDARD_64 - - N2D_STANDARD_80 - - N2D_STANDARD_96 - - N2D_STANDARD_128 - - N2D_STANDARD_224 - - N2D_HIGHMEM_2 - - N2D_HIGHMEM_4 - - N2D_HIGHMEM_8 - - N2D_HIGHMEM_16 - - N2D_HIGHMEM_32 - - N2D_HIGHMEM_48 - - N2D_HIGHMEM_64 - - N2D_HIGHMEM_80 - - N2D_HIGHMEM_96 - - N2D_HIGHCPU_2 - - N2D_HIGHCPU_4 - - N2D_HIGHCPU_8 - - N2D_HIGHCPU_16 - - N2D_HIGHCPU_32 - - N2D_HIGHCPU_48 - - N2D_HIGHCPU_64 - - N2D_HIGHCPU_80 - - N2D_HIGHCPU_96 - - N2D_HIGHCPU_128 - - N2D_HIGHCPU_224 - - C2_STANDARD_4 - - C2_STANDARD_8 - - C2_STANDARD_16 - - C2_STANDARD_30 - - C2_STANDARD_60 - - C2D_STANDARD_2 - - C2D_STANDARD_4 - - C2D_STANDARD_8 - - C2D_STANDARD_16 - - C2D_STANDARD_32 - - C2D_STANDARD_56 - - C2D_STANDARD_112 - - C2D_HIGHCPU_2 - - C2D_HIGHCPU_4 - - C2D_HIGHCPU_8 - - C2D_HIGHCPU_16 - - C2D_HIGHCPU_32 - - C2D_HIGHCPU_56 - - C2D_HIGHCPU_112 - - C2D_HIGHMEM_2 - - C2D_HIGHMEM_4 - - C2D_HIGHMEM_8 - - C2D_HIGHMEM_16 - - C2D_HIGHMEM_32 - - C2D_HIGHMEM_56 - - C2D_HIGHMEM_112 - - G2_STANDARD_4 - - G2_STANDARD_8 - - G2_STANDARD_12 - - G2_STANDARD_16 - - G2_STANDARD_24 - - G2_STANDARD_32 - - G2_STANDARD_48 - - G2_STANDARD_96 - - C3_STANDARD_4 - - C3_STANDARD_8 - - C3_STANDARD_22 - - C3_STANDARD_44 - - C3_STANDARD_88 - - C3_STANDARD_176 - - C3_HIGHCPU_4 - - C3_HIGHCPU_8 - - C3_HIGHCPU_22 - - C3_HIGHCPU_44 - - C3_HIGHCPU_88 - - C3_HIGHCPU_176 - - C3_HIGHMEM_4 - - C3_HIGHMEM_8 - - C3_HIGHMEM_22 - - C3_HIGHMEM_44 - - C3_HIGHMEM_88 - - C3_HIGHMEM_176 + - NONE + - UTF8 + - UTF16 + - UTF32 + description: The encoding type used by the API to calculate offsets. + type: string + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + features: + description: Required. The enabled features. + $ref: '#/components/schemas/AnnotateTextRequestFeatures' + description: >- + The request message for the text annotation API, which can perform + multiple analysis types in one call. + type: object + id: AnnotateTextRequest + ClassifyTextResponse: + id: ClassifyTextResponse + description: The document classification response message. + properties: + categories: + description: Categories representing the input document. + items: + $ref: '#/components/schemas/ClassificationCategory' + type: array + languageCode: + type: string + description: >- + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + languageSupported: + description: >- + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + type: boolean + type: object + XPSFileSpec: + id: XPSFileSpec + type: object + properties: + fileSpec: + description: >- + Single file path, or file pattern of format + "/path/to/file@shard_count". E.g. /cns/cell-d/somewhere/file@2 is + expanded to two files: /cns/cell-d/somewhere/file-00000-of-00002 and + /cns/cell-d/somewhere/file-00001-of-00002. + type: string + directoryPath: + description: Deprecated. Use file_spec. + type: string + deprecated: true + fileFormat: + enum: + - FILE_FORMAT_UNKNOWN + - FILE_FORMAT_SSTABLE + - FILE_FORMAT_TRANSLATION_RKV + - FILE_FORMAT_RECORDIO + - FILE_FORMAT_RAW_CSV + - FILE_FORMAT_RAW_CAPACITOR enumDescriptions: - '' - '' + - >- + Internal format for parallel text data used by Google Translate. + go/rkvtools - '' + - >- + Only the lexicographically first file described by the file_spec + contains the header line. - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - ramType: + type: string + enumDeprecated: + - false + - true + - false + - false + - false + - false + singleFilePath: + description: Deprecated. Use file_spec. + type: string + deprecated: true + description: >- + Spec of input and output files, on external file systems (CNS, GCS, + etc). + XPSTrainingObjectivePoint: + id: XPSTrainingObjectivePoint + properties: + value: + description: The objective value when this point was recorded. + format: float + type: number + createTime: + description: The time at which this point was recorded. + format: google-datetime + type: string + type: object + XPSExampleSet: + type: object + description: Set of examples or input sources. + id: XPSExampleSet + properties: + numExamples: + description: Number of examples. + type: string + format: int64 + numInputSources: + format: int64 + description: Number of input sources. + type: string + fileSpec: + description: File spec of the examples or input sources. + $ref: '#/components/schemas/XPSFileSpec' + fingerprint: + type: string + description: Fingerprint of the example set. + format: int64 + XPSImageSegmentationEvaluationMetrics: + description: 'Model evaluation metrics for image segmentation problems. Next tag: 4.' + id: XPSImageSegmentationEvaluationMetrics + properties: + confidenceMetricsEntries: + items: + $ref: >- + #/components/schemas/XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + type: array + description: >- + Metrics that have confidence thresholds. Precision-recall curve can + be derived from it. + type: object + ClassifyTextRequest: + type: object + properties: + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + description: The document classification request message. + id: ClassifyTextRequest + AnalyzeEntitiesRequest: + type: object + id: AnalyzeEntitiesRequest + description: The entity analysis request message. + properties: + encodingType: + description: The encoding type used by the API to calculate offsets. + type: string enum: - - UNKNOWN_RAM_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D + - NONE + - UTF8 + - UTF16 + - UTF32 + enumDescriptions: + - >- + If `EncodingType` is not specified, encoding-dependent information + (such as `begin_offset`) will be set at `-1`. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-8 encoding of the input. C++ and Go + are examples of languages that use this encoding natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-16 encoding of the input. Java and + JavaScript are examples of languages that use this encoding + natively. + - >- + Encoding-dependent information (such as `begin_offset`) is + calculated based on the UTF-32 encoding of the input. Python is an + example of a language that uses this encoding natively. + document: + $ref: '#/components/schemas/Document' + description: Required. Input document. + XPSVideoActionMetricsEntryConfidenceMetricsEntry: + id: XPSVideoActionMetricsEntryConfidenceMetricsEntry + properties: + recall: + description: Output only. Recall for the given confidence threshold. + type: number + format: float + precision: + description: Output only. Precision for the given confidence threshold. + format: float + type: number + f1Score: + format: float + description: Output only. The harmonic mean of recall and precision. + type: number + confidenceThreshold: + format: float + type: number + description: >- + Output only. The confidence threshold value used to compute the + metrics. + type: object + description: Metrics for a single confidence threshold. + XPSColumnSpecForecastingMetadata: + id: XPSColumnSpecForecastingMetadata + description: >- + =========================================================================== + # The fields below are used exclusively for Forecasting. + type: object + properties: + columnType: type: string - description: Required. Type of ram. enumDescriptions: - - '' - - '' - - '' - - COMPUTE_OPTIMIZED - - '' - - '' - - '' - - '' - - '' - - MEMORY_OPTIMIZED_UPGRADE_PREMIUM - - MEMORY_OPTIMIZED - - '' - - '' - - '' - - '' + - An un-set value of this enum. + - Key columns are used to identify timeseries. + - >- + This column contains information describing static properties of + the entities identified by the key column(s) (e.g. city's ZIP + code). + - >- + This column contains information for the given entity, at any time + poinrt, they are only available in the time series before. + - >- + This column contains information for the given entity is known + both for the past and the sufficiently far future. + description: The type of the column for FORECASTING model training purposes. + enum: + - COLUMN_TYPE_UNSPECIFIED + - KEY + - KEY_METADATA + - TIME_SERIES_AVAILABLE_PAST_ONLY + - TIME_SERIES_AVAILABLE_PAST_AND_FUTURE + XPSDataStats: type: object - id: RamMetric - XPSTrainResponse: - description: 'Next ID: 18' + properties: + categoryStats: + description: The statistics for CATEGORY DataType. + $ref: '#/components/schemas/XPSCategoryStats' + validValueCount: + description: The number of values that are valid. + type: string + format: int64 + nullValueCount: + description: The number of values that are null. + type: string + format: int64 + distinctValueCount: + description: The number of distinct values. + format: int64 + type: string + stringStats: + description: The statistics for STRING DataType. + $ref: '#/components/schemas/XPSStringStats' + arrayStats: + description: The statistics for ARRAY DataType. + $ref: '#/components/schemas/XPSArrayStats' + float64Stats: + $ref: '#/components/schemas/XPSFloat64Stats' + description: The statistics for FLOAT64 DataType. + timestampStats: + $ref: '#/components/schemas/XPSTimestampStats' + description: The statistics for TIMESTAMP DataType. + structStats: + $ref: '#/components/schemas/XPSStructStats' + description: The statistics for STRUCT DataType. + id: XPSDataStats + description: The data statistics of a series of values that share the same DataType. + XPSImageSegmentationTrainResponse: type: object - id: XPSTrainResponse properties: - videoClassificationTrainResp: - $ref: '#/components/schemas/XPSVideoClassificationTrainResponse' - errorAnalysisConfigs: + stopReason: + enumDescriptions: + - '' + - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + type: string description: >- - Optional vision model error analysis configuration. The field is set - when model error analysis is enabled in the training request. The - results of error analysis will be binded together with evaluation - results (in the format of AnnotatedExample). + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED'. + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + exportModelSpec: + description: 'NOTE: These fields are not used/needed in EAP but will be set later.' + $ref: '#/components/schemas/XPSImageExportModelSpec' + trainCostNodeSeconds: + description: >- + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. + format: int64 + type: string + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' + colorMaps: items: - $ref: '#/components/schemas/XPSVisionErrorAnalysisConfig' + $ref: '#/components/schemas/XPSColorMap' + description: Color map of the model. type: array - evaluatedExampleSet: + modelArtifactSpec: description: >- - Examples used to evaluate the model (usually the test set), with the - predicted annotations. The file_spec should point to recordio - file(s) of AnnotatedExample. For each returned example, the - example_id_token and annotations predicted by the model must be set. - The example payload can and is recommended to be omitted. - $ref: '#/components/schemas/XPSExampleSet' - translationTrainResp: - $ref: '#/components/schemas/XPSTranslationTrainResponse' - imageSegmentationTrainResp: - $ref: '#/components/schemas/XPSImageSegmentationTrainResponse' - imageClassificationTrainResp: - $ref: '#/components/schemas/XPSImageClassificationTrainResponse' - videoActionRecognitionTrainResp: - $ref: '#/components/schemas/XPSVideoActionRecognitionTrainResponse' - textToSpeechTrainResp: - $ref: '#/components/schemas/XPSTextToSpeechTrainResponse' - explanationConfigs: + ## The fields below are only populated under uCAIP request scope. + Model artifact spec stores and model gcs pathes and related metadata + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + id: XPSImageSegmentationTrainResponse + XPSCorrelationStats: + properties: + cramersV: + description: The correlation value using the Cramer's V measure. + format: double + type: number + id: XPSCorrelationStats + type: object + description: >- + A correlation statistics between two series of DataType values. The + series may have differing DataType-s, but within a single series the + DataType must be the same. + ModerateTextResponse: + properties: + languageCode: + type: string description: >- - VisionExplanationConfig for XAI on test set. Optional for when XAI - is enable in training request. - deprecated: true - type: array - items: - $ref: '#/components/schemas/XPSResponseExplanationSpec' - speechTrainResp: - $ref: '#/components/schemas/XPSSpeechModelSpec' - videoObjectTrackingTrainResp: - $ref: '#/components/schemas/XPSVideoObjectTrackingTrainResponse' - textTrainResp: - description: Will only be needed for uCAIP from Beta. - $ref: '#/components/schemas/XPSTextTrainResponse' - evaluationMetricsSet: - $ref: '#/components/schemas/XPSEvaluationMetricsSet' + The language of the text, which will be the same as the language + specified in the request or, if not specified, the + automatically-detected language. See Document.language field for + more details. + languageSupported: + type: boolean description: >- - The trained model evaluation metrics. This can be optionally - returned. - deployedModelSizeBytes: - description: Estimated model size in bytes once deployed. + Whether the language is officially supported. The API may still + return a response when the language is not supported, but it is on a + best effort basis. + moderationCategories: + items: + $ref: '#/components/schemas/ClassificationCategory' + type: array + description: Harmful and sensitive categories representing the input document. + id: ModerateTextResponse + description: The document moderation response message. + type: object + XPSVideoClassificationTrainResponse: + id: XPSVideoClassificationTrainResponse + properties: + trainCostNodeSeconds: format: int64 - type: string - imageObjectDetectionTrainResp: - $ref: '#/components/schemas/XPSImageObjectDetectionModelSpec' - tablesTrainResp: - $ref: '#/components/schemas/XPSTablesTrainResponse' - modelToken: description: >- - Token that represents the trained model. This is considered - immutable and is persisted in AutoML. xPS can put their own proto in - the byte string, to e.g. point to the model checkpoints. The token - is passed to other xPS APIs to refer to the model. + The actual train cost of creating this model, expressed in node + seconds, i.e. 3,600 value in this field means 1 node hour. type: string - format: byte - XPSVideoBatchPredictOperationMetadata: + modelArtifactSpec: + $ref: '#/components/schemas/XPSVideoModelArtifactSpec' + description: '## The fields below are only populated under uCAIP request scope.' type: object - id: XPSVideoBatchPredictOperationMetadata + XPSCoreMlFormat: + properties: {} + id: XPSCoreMlFormat + type: object + description: A model format used for iOS mobile devices. + XPSSpeechModelSpec: properties: - outputExamples: - type: array + datasetId: + type: string + format: int64 description: >- - All the partial batch prediction results that are completed at the - moment. Output examples are sorted by completion time. The order - will not be changed. Each output example should be the path of a - single RecordIO file of AnnotatedExamples. + Required for speech xps backend. Speech xps has to use dataset_id + and model_id as the primary key in db so that speech API can query + the db directly. + language: + type: string + subModelSpecs: + description: Model specs for all submodels contained in this model. + type: array items: - type: string - Status: + $ref: '#/components/schemas/XPSSpeechModelSpecSubModelSpec' + type: object + id: XPSSpeechModelSpec + EntityMention: + description: >- + Represents a mention for an entity in the text. Currently, proper noun + mentions are supported. properties: - details: + type: + enumDescriptions: + - Unknown + - Proper name + - Common noun (or noun compound) + enum: + - TYPE_UNKNOWN + - PROPER + - COMMON + type: string + description: The type of the entity mention. + text: + $ref: '#/components/schemas/TextSpan' + description: The mention text. + probability: + type: number + format: float description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array + Probability score associated with the entity. The score shows the + probability of the entity mention being the entity type. The score + is in (0, 1] range. + sentiment: + $ref: '#/components/schemas/Sentiment' + description: >- + For calls to AnalyzeEntitySentiment or if + AnnotateTextRequest.Features.extract_entity_sentiment is set to + true, this field will contain the sentiment expressed for this + mention of the entity in the provided document. + id: EntityMention + type: object + XPSImageExportModelSpec: + type: object + properties: + exportModelOutputConfig: items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - message: - type: string + $ref: '#/components/schemas/XPSExportModelOutputConfig' description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - id: Status + Contains the model format and internal location of the model files + to be exported/downloaded. Use the GCS bucket name which is provided + via TrainRequest.gcs_bucket_name to store the model files. + type: array description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - CpuMetric: + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Upon receiving + ExportModel request from user, AutoMl backend can serve the + pre-generated models to user if exists (by copying the files from + internal path to user provided location), otherwise, AutoMl backend will + call xPS ExportModel API to generate the model on the fly with the + requesting format. + id: XPSImageExportModelSpec + XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry: + description: Metrics for a single confidence threshold. properties: - trackingLabels: + confidenceThreshold: + format: float + type: number + description: The confidence threshold value used to compute the metrics. + diceScoreCoefficient: + description: 'DSC or the F1 score: The harmonic mean of recall and precision.' + type: number + format: float + recall: + description: Recall for the given confidence threshold. + format: float + type: number + iouScore: + type: number + format: float + description: IOU score. + confusionMatrix: + $ref: '#/components/schemas/XPSConfusionMatrix' description: >- - Billing tracking labels. They do not contain any user data but only - the labels set by Vertex Core Infra itself. Tracking labels' keys - are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": - "goog-k8s-cluster-name","value": "us-east1-b4rk" - additionalProperties: - type: string - type: object - coreNumber: + Confusion matrix of the per confidence_threshold evaluation. Pixel + counts are set here. Only set for model level evaluation, not for + evaluation per label. + precision: + type: number + description: Precision for the given confidence threshold. + format: float + type: object + id: XPSImageSegmentationEvaluationMetricsConfidenceMetricsEntry + XPSCategoryStatsSingleCategoryStats: + description: The statistics of a single CATEGORY value. + id: XPSCategoryStatsSingleCategoryStats + properties: + count: format: int64 - description: Required. Number of CPU cores. type: string - cpuType: - enumDescriptions: - - '' - - GPU-based machine, skip quota reporting. - - GPU-based machine, skip quota reporting. - - COMPUTE_OPTIMIZED - - '' - - '' - - '' - - GPU-based machine, skip quota reporting. - - '' - - MEMORY_OPTIMIZED_UPGRADE_PREMIUM - - MEMORY_OPTIMIZED - - '' - - '' - - '' - - '' - description: Required. Type of cpu, e.g. N2. + description: The number of occurrences of this value in the series. + value: + description: The CATEGORY value. type: string - enum: - - UNKNOWN_CPU_TYPE - - A2 - - A3 - - C2 - - C2D - - CUSTOM - - E2 - - G2 - - C3 - - M2 - - M1 - - N1 - - N2_CUSTOM - - N2 - - N2D - coreSec: - format: int64 + type: object + RamMetric: + properties: + gibSec: + description: >- + Required. VM memory in Gigabyte second, e.g. 3600. Using int64 type + to match billing metrics definition. type: string - description: Required. Total seconds of core usage, e.g. 4. + format: int64 machineSpec: enum: - UNKNOWN_MACHINE_SPEC @@ -4322,7 +4258,10 @@ components: - A2_ULTRAGPU_2G - A2_ULTRAGPU_4G - A2_ULTRAGPU_8G + - A3_HIGHGPU_2G + - A3_HIGHGPU_4G - A3_HIGHGPU_8G + - A3_MEGAGPU_8G - E2_STANDARD_2 - E2_STANDARD_4 - E2_STANDARD_8 @@ -4449,6 +4388,8 @@ components: - C3_HIGHMEM_44 - C3_HIGHMEM_88 - C3_HIGHMEM_176 + description: Required. Machine spec, e.g. N1_STANDARD_4. + type: string enumDescriptions: - '' - '' @@ -4608,212 +4549,318 @@ components: - '' - '' - '' - description: Required. Machine spec, e.g. N1_STANDARD_4. + - '' + - '' + - '' + trackingLabels: + description: >- + Billing tracking labels. They do not contain any user data but only + the labels set by Vertex Core Infra itself. Tracking labels' keys + are defined with special format: goog-[\p{Ll}\p{N}]+ E.g. "key": + "goog-k8s-cluster-name","value": "us-east1-b4rk" + additionalProperties: + type: string + type: object + ramType: + description: Required. Type of ram. + enumDescriptions: + - '' + - '' + - '' + - COMPUTE_OPTIMIZED + - '' + - '' + - '' + - '' + - '' + - MEMORY_OPTIMIZED_UPGRADE_PREMIUM + - MEMORY_OPTIMIZED + - '' + - '' + - '' + - '' + enum: + - UNKNOWN_RAM_TYPE + - A2 + - A3 + - C2 + - C2D + - CUSTOM + - E2 + - G2 + - C3 + - M2 + - M1 + - N1 + - N2_CUSTOM + - N2 + - N2D type: string + memories: + format: double + type: number + description: Required. VM memory in gb. + type: object + id: RamMetric + XPSVideoObjectTrackingEvaluationMetrics: type: object - id: CpuMetric - description: Metric for billing reports. - XPSConfidenceMetricsEntry: properties: - falseNegativeCount: - format: int64 + trackMeanBoundingBoxIou: description: >- - The number of ground truth labels that are not matched by a model - created label. - type: string - f1Score: - format: float + Output only. The single metric for tracks bounding box iou + evaluation: the mean_bounding_box_iou averaged over all + track_metrics_entries. type: number - description: The harmonic mean of recall and precision. - falsePositiveCount: - format: int64 - description: >- - The number of model created labels that do not match a ground truth - label. - type: string - falsePositiveRateAt1: + format: float + evaluatedFrameCount: + description: The number of video frames used for model evaluation. + format: int32 + type: integer + trackMeanAveragePrecision: + format: float type: number description: >- - The False Positive Rate when only considering the label that has the - highest prediction score and not below the confidence threshold for - each example. - format: float - positionThreshold: + Output only. The single metric for tracks accuracy evaluation: the + mean_average_precision averaged over all track_metrics_entries. + trackMetricsEntries: + items: + $ref: '#/components/schemas/XPSTrackMetricsEntry' + type: array description: >- - Metrics are computed with an assumption that the model always - returns at most this many predictions (ordered by their score, - descendingly), but they all still need to meet the - confidence_threshold. - type: integer + Output only. The tracks match metrics for each + Intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + evaluatedBoundingboxCount: + description: The number of bounding boxes used for model evaluation. format: int32 - confidenceThreshold: + type: integer + boundingBoxMetricsEntries: description: >- - Metrics are computed with an assumption that the model never return - predictions with score lower than this value. - format: float - type: number - precisionAt1: + Output only. The bounding boxes match metrics for each + Intersection-over-union threshold + 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. + type: array + items: + $ref: '#/components/schemas/XPSBoundingBoxMetricsEntry' + trackMeanMismatchRate: type: number description: >- - The precision when only considering the label that has the highest - prediction score and not below the confidence threshold for each - example. - format: float - truePositiveCount: - format: int64 - type: string - description: The number of model created labels that match a ground truth label. - falsePositiveRate: - description: False Positive Rate for the given confidence threshold. - type: number + Output only. The single metric for tracking consistency evaluation: + the mean_mismatch_rate averaged over all track_metrics_entries. format: float - precision: + boundingBoxMeanAveragePrecision: format: float - description: Precision for the given confidence threshold. type: number - recall: + description: >- + Output only. The single metric for bounding boxes evaluation: the + mean_average_precision averaged over all + bounding_box_metrics_entries. + evaluatedTrackCount: + format: int32 + type: integer + description: The number of tracks used for model evaluation. + description: 'Model evaluation metrics for ObjectTracking problems. Next tag: 10.' + id: XPSVideoObjectTrackingEvaluationMetrics + XPSRegressionMetricsEntry: + id: XPSRegressionMetricsEntry + properties: + trueValue: + description: The actual target value for a row in the dataset. + type: number format: float + predictedValue: type: number - description: Recall (true positive rate) for the given confidence threshold. - recallAt1: + description: The observed value for a row in the dataset. format: float + type: object + description: A pair of actual & observed values for the model being evaluated. + XPSTimestampStatsGranularStats: + properties: + buckets: + additionalProperties: + format: int64 + type: string description: >- - The recall (true positive rate) when only considering the label that - has the highest prediction score and not below the confidence - threshold for each example. - type: number - trueNegativeCount: - type: string + A map from granularity key to example count for that key. E.g. for + hour_of_day `13` means 1pm, or for month_of_year `5` means May). + type: object + id: XPSTimestampStatsGranularStats + type: object + description: Stats split by a defined in context granularity. + XPSResponseExplanationMetadata: + id: XPSResponseExplanationMetadata + properties: + outputs: + type: object + description: Metadata of the output. + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataOutputMetadata' + inputs: + type: object + additionalProperties: + $ref: '#/components/schemas/XPSResponseExplanationMetadataInputMetadata' + description: Metadata of the input. + deprecated: true + type: object + XPSTablesDatasetMetadata: + type: object + id: XPSTablesDatasetMetadata + description: 'Metadata for a dataset used for AutoML Tables. Next ID: 6' + properties: + primaryTableSpec: + description: Primary table. + $ref: '#/components/schemas/XPSTableSpec' + mlUseColumnId: + type: integer + format: int32 + description: Id the column to split the table. + targetColumnCorrelations: + type: object + description: '(the column id : its CorrelationStats with target column).' + additionalProperties: + $ref: '#/components/schemas/XPSCorrelationStats' + weightColumnId: description: >- - The number of labels that were not created by the model, but if they - would, they would not match a ground truth label. - format: int64 - f1ScoreAt1: - type: number - format: float - description: The harmonic mean of recall_at1 and precision_at1. + Id of the primary table column that should be used as the weight + column. + type: integer + format: int32 + targetColumnId: + description: >- + Id of the primary table column that should be used as the training + label. + format: int32 + type: integer + XPSTfSavedModelFormat: + properties: {} + id: XPSTfSavedModelFormat type: object - description: >- - ConfidenceMetricsEntry includes generic precision, recall, f1 score etc. - Next tag: 16. - id: XPSConfidenceMetricsEntry - AnalyzeSentimentRequest: - id: AnalyzeSentimentRequest + description: A tensorflow model format in SavedModel format. + XPSXraiAttribution: properties: - encodingType: - enum: - - NONE - - UTF8 - - UTF16 - - UTF32 - enumDescriptions: - - >- - If `EncodingType` is not specified, encoding-dependent information - (such as `begin_offset`) will be set at `-1`. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-8 encoding of the input. C++ and Go - are examples of languages that use this encoding natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-16 encoding of the input. Java and - JavaScript are examples of languages that use this encoding - natively. - - >- - Encoding-dependent information (such as `begin_offset`) is - calculated based on the UTF-32 encoding of the input. Python is an - example of a language that uses this encoding natively. - description: The encoding type used by the API to calculate sentence offsets. - type: string - document: - $ref: '#/components/schemas/Document' - description: Required. Input document. + stepCount: + description: >- + The number of steps for approximating the path integral. A good + value to start is 50 and gradually increase until the sum to diff + property is met within the desired error range. Valid range of its + value is [1, 100], inclusively. + type: integer + format: int32 + deprecated: true type: object - description: The sentiment analysis request message. - XPSXpsOperationMetadata: - id: XPSXpsOperationMetadata + description: >- + An explanation method that redistributes Integrated Gradients + attributions to segmented regions, taking advantage of the model's fully + differentiable structure. Refer to this paper for more details: + https://arxiv.org/abs/1906.02825 Only supports image Models (modality is + IMAGE). + id: XPSXraiAttribution + XPSStringStatsUnigramStats: + id: XPSStringStatsUnigramStats + description: The statistics of a unigram. properties: - reportingMetrics: - $ref: '#/components/schemas/XPSReportingMetrics' - description: >- - Metrics for the operation. By the time the operation is terminated - (whether succeeded or failed) as returned from XPS, AutoML BE - assumes the metrics are finalized. AutoML BE transparently posts the - metrics to Chemist if it's not empty, regardless of the response - content or error type. If user is supposed to be charged in case of - cancellation/error, this field should be set. In the case where the - type of LRO doesn't require any billing, this field should be left - unset. - exampleCount: - description: >- - Optional. XPS server can opt to provide example count of the long - running operation (e.g. training, data importing, batch prediction). + value: + type: string + description: The unigram. + count: type: string format: int64 - visionTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVisionTrainingOperationMetadata' - videoBatchPredictOperationMetadata: - $ref: '#/components/schemas/XPSVideoBatchPredictOperationMetadata' - videoTrainingOperationMetadata: - $ref: '#/components/schemas/XPSVideoTrainingOperationMetadata' - tablesTrainingOperationMetadata: - $ref: '#/components/schemas/XPSTablesTrainingOperationMetadata' + description: The number of occurrences of this unigram in the series. type: object - XPSVideoActionRecognitionTrainResponse: + XPSImageClassificationTrainResponse: + id: XPSImageClassificationTrainResponse type: object properties: - trainCostNodeSeconds: - description: >- - The actual train cost of creating this model, expressed in node - seconds, i.e. 3,600 value in this field means 1 node hour. - type: string + classCount: + description: Total number of classes. format: int64 + type: string + stopReason: + enum: + - TRAIN_STOP_REASON_UNSPECIFIED + - TRAIN_STOP_REASON_BUDGET_REACHED + - TRAIN_STOP_REASON_MODEL_CONVERGED + - TRAIN_STOP_REASON_MODEL_EARLY_STOPPED + enumDescriptions: + - '' + - '' + - Model fully converged, can not be resumbed training. + - >- + Model early converged, can be further trained till full + convergency. + type: string + description: >- + Stop reason for training job, e.g. 'TRAIN_BUDGET_REACHED', + 'MODEL_CONVERGED', 'MODEL_EARLY_STOPPED'. modelArtifactSpec: description: '## The fields below are only populated under uCAIP request scope.' - $ref: '#/components/schemas/XPSVideoModelArtifactSpec' - id: XPSVideoActionRecognitionTrainResponse + $ref: '#/components/schemas/XPSImageModelArtifactSpec' + exportModelSpec: + description: >- + Information of downloadable models that are pre-generated as part of + training flow and will be persisted in AutoMl backend. Populated for + AutoMl requests. + $ref: '#/components/schemas/XPSImageExportModelSpec' + trainCostNodeSeconds: + format: int64 + type: string + description: >- + The actual training cost, expressed in node seconds. Populated for + models trained in node time. + trainCostInNodeTime: + description: >- + The actual cost to create this model. - For edge type model, the + cost is expressed in node hour. - For cloud type model,the cost is + expressed in compute hour. - Populated for models created before GA. + To be deprecated after GA. + type: string + format: google-duration + modelServingSpec: + $ref: '#/components/schemas/XPSImageModelServingSpec' parameters: - alt: - description: Data format for response. + _.xgafv: + description: V1 error format. in: query - name: alt + name: $.xgafv schema: type: string enum: - - json - - media - - proto - fields: - description: Selector specifying which fields to include in a partial response. + - '1' + - '2' + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: fields + name: quotaUser schema: type: string - _.xgafv: - description: V1 error format. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: $.xgafv + name: oauth_token schema: type: string - enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. in: query - name: upload_protocol + name: key schema: type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string prettyPrint: @@ -4822,45 +4869,43 @@ components: name: prettyPrint schema: type: boolean - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + callback: + description: JSONP in: query - name: uploadType + name: callback schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: quotaUser + name: fields schema: type: string - access_token: - description: OAuth access token. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: access_token + name: uploadType schema: type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + alt: + description: Data format for response. in: query - name: key + name: alt schema: type: string + enum: + - json + - media + - proto x-stackQL-resources: documents: id: google.language.documents name: documents title: Documents methods: - annotate_text: + moderate_text: operation: - $ref: '#/paths/~1v2~1documents:annotateText/post' + $ref: '#/paths/~1v2~1documents:moderateText/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4870,21 +4915,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - moderate_text: + annotate_text: operation: - $ref: '#/paths/~1v2~1documents:moderateText/post' + $ref: '#/paths/~1v2~1documents:annotateText/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_sentiment: + analyze_entities: operation: - $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' + $ref: '#/paths/~1v2~1documents:analyzeEntities/post' response: mediaType: application/json openAPIDocKey: '200' - analyze_entities: + analyze_sentiment: operation: - $ref: '#/paths/~1v2~1documents:analyzeEntities/post' + $ref: '#/paths/~1v2~1documents:analyzeSentiment/post' response: mediaType: application/json openAPIDocKey: '200' @@ -4892,29 +4937,30 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: - /v2/documents:annotateText: + /v2/documents:moderateText: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/alt' post: - description: A convenience method that provides all features in one call. - operationId: language.documents.annotateText + description: Moderates a document for harmful and sensitive categories. + operationId: language.documents.moderateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextRequest' + $ref: '#/components/schemas/ModerateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4930,7 +4976,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnnotateTextResponse' + $ref: '#/components/schemas/ModerateTextResponse' parameters: [] /v2/documents:classifyText: parameters: *ref_1 @@ -4959,16 +5005,16 @@ paths: schema: $ref: '#/components/schemas/ClassifyTextResponse' parameters: [] - /v2/documents:moderateText: + /v2/documents:annotateText: parameters: *ref_1 post: - description: Moderates a document for harmful and sensitive categories. - operationId: language.documents.moderateText + description: A convenience method that provides all features in one call. + operationId: language.documents.annotateText requestBody: content: application/json: schema: - $ref: '#/components/schemas/ModerateTextRequest' + $ref: '#/components/schemas/AnnotateTextRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -4984,18 +5030,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ModerateTextResponse' + $ref: '#/components/schemas/AnnotateTextResponse' parameters: [] - /v2/documents:analyzeSentiment: + /v2/documents:analyzeEntities: parameters: *ref_1 post: - description: Analyzes the sentiment of the provided text. - operationId: language.documents.analyzeSentiment + description: >- + Finds named entities (currently proper names and common nouns) in the + text along with entity types, probability, mentions for each entity, and + other properties. + operationId: language.documents.analyzeEntities requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentRequest' + $ref: '#/components/schemas/AnalyzeEntitiesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5011,21 +5060,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeSentimentResponse' + $ref: '#/components/schemas/AnalyzeEntitiesResponse' parameters: [] - /v2/documents:analyzeEntities: + /v2/documents:analyzeSentiment: parameters: *ref_1 post: - description: >- - Finds named entities (currently proper names and common nouns) in the - text along with entity types, probability, mentions for each entity, and - other properties. - operationId: language.documents.analyzeEntities + description: Analyzes the sentiment of the provided text. + operationId: language.documents.analyzeSentiment requestBody: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesRequest' + $ref: '#/components/schemas/AnalyzeSentimentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-language @@ -5041,5 +5087,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AnalyzeEntitiesResponse' + $ref: '#/components/schemas/AnalyzeSentimentResponse' parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml index f6e30358..d14eb5f1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/libraryagent.yaml @@ -7,8 +7,8 @@ info: title: Library Agent API description: A simple Google Example Library API. version: v1 - x-discovery-doc-revision: '20240530' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/docs/quota servers: @@ -34,59 +34,40 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleExampleLibraryagentV1ListShelvesResponse: - id: GoogleExampleLibraryagentV1ListShelvesResponse - description: Response message for LibraryAgent.ListShelves. - properties: - shelves: - description: The list of shelves. - items: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' - type: array - nextPageToken: - description: >- - A token to retrieve next page of results. Pass this value in the - ListShelvesRequest.page_token field in the subsequent call to - `ListShelves` method to retrieve the next page of results. - type: string - type: object GoogleExampleLibraryagentV1ListBooksResponse: - type: object description: Response message for LibraryAgent.ListBooks. properties: - books: - description: The list of books. - type: array - items: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' nextPageToken: type: string description: >- A token to retrieve next page of results. Pass this value in the ListBooksRequest.page_token field in the subsequent call to `ListBooks` method to retrieve the next page of results. + books: + description: The list of books. + items: + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' + type: array + type: object id: GoogleExampleLibraryagentV1ListBooksResponse - GoogleExampleLibraryagentV1Book: + GoogleExampleLibraryagentV1ListShelvesResponse: type: object - description: A single book in the library. - id: GoogleExampleLibraryagentV1Book properties: - title: - description: The title of the book. + nextPageToken: type: string - name: description: >- - The resource name of the book. Book names have the form - `shelves/{shelf_id}/books/{book_id}`. The name is ignored when - creating a book. - type: string - author: - description: The name of the book author. - type: string - read: - type: boolean - description: Value indicating whether the book has been read. + A token to retrieve next page of results. Pass this value in the + ListShelvesRequest.page_token field in the subsequent call to + `ListShelves` method to retrieve the next page of results. + shelves: + items: + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' + type: array + description: The list of shelves. + description: Response message for LibraryAgent.ListShelves. + id: GoogleExampleLibraryagentV1ListShelvesResponse GoogleExampleLibraryagentV1Shelf: + id: GoogleExampleLibraryagentV1Shelf description: A Shelf contains a collection of books with a theme. properties: name: @@ -98,36 +79,28 @@ components: theme: type: string description: The theme of the shelf - id: GoogleExampleLibraryagentV1Shelf type: object + GoogleExampleLibraryagentV1Book: + id: GoogleExampleLibraryagentV1Book + type: object + description: A single book in the library. + properties: + read: + description: Value indicating whether the book has been read. + type: boolean + title: + description: The title of the book. + type: string + name: + type: string + description: >- + The resource name of the book. Book names have the form + `shelves/{shelf_id}/books/{book_id}`. The name is ignored when + creating a book. + author: + type: string + description: The name of the book author. parameters: - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - callback: - description: JSONP - in: query - name: callback - schema: - type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string alt: description: Data format for response. in: query @@ -138,10 +111,19 @@ components: - json - media - proto - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: uploadType + name: quotaUser + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string fields: @@ -150,34 +132,52 @@ components: name: fields schema: type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - access_token: - description: OAuth access token. + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. in: query - name: access_token + name: key schema: type: string - _.xgafv: - description: V1 error format. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: $.xgafv + name: upload_protocol schema: type: string - enum: - - '1' - - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string x-stackQL-resources: @@ -186,90 +186,85 @@ components: name: books title: Books methods: - borrow: + list: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:borrow/post' + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.books get: operation: $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}/get' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.books - list: - operation: *ref_1 - response: *ref_2 return: operation: $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:return/post' response: mediaType: application/json openAPIDocKey: '200' + borrow: + operation: + $ref: '#/paths/~1v1~1shelves~1{shelvesId}~1books~1{booksId}:borrow/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/books/methods/get' - $ref: '#/components/x-stackQL-resources/books/methods/list' insert: [] update: [] + replace: [] delete: [] shelves: id: google.libraryagent.shelves name: shelves title: Shelves methods: - _list: - operation: &ref_3 - $ref: '#/paths/~1v1~1shelves/get' - response: &ref_4 + get: + operation: + $ref: '#/paths/~1v1~1shelves~1{shelvesId}/get' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.shelves list: - operation: *ref_3 - response: *ref_4 - get: operation: - $ref: '#/paths/~1v1~1shelves~1{shelvesId}/get' + $ref: '#/paths/~1v1~1shelves/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.shelves sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/shelves/methods/get' - $ref: '#/components/x-stackQL-resources/shelves/methods/list' insert: [] update: [] + replace: [] delete: [] paths: - /v1/shelves/{shelvesId}/books/{booksId}:borrow: - parameters: &ref_5 - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/upload_protocol' + /v1/shelves/{shelvesId}/books: + parameters: &ref_1 - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - post: + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/uploadType' + get: description: >- - Borrow a book from the library. Returns the book if it is borrowed - successfully. Returns NOT_FOUND if the book does not exist in the - library. Returns quota exceeded error if the amount of books borrowed - exceeds allocation quota in any dimensions. - operationId: libraryagent.shelves.books.borrow + Lists books in a shelf. The order is unspecified but deterministic. + Newly created books will not necessarily be added to the end of this + list. Returns NOT_FOUND if the shelf does not exist. + operationId: libraryagent.shelves.books.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -281,20 +276,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' + $ref: >- + #/components/schemas/GoogleExampleLibraryagentV1ListBooksResponse parameters: - in: path name: shelvesId required: true schema: type: string - - in: path - name: booksId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string /v1/shelves/{shelvesId}/books/{booksId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets a book. Returns NOT_FOUND if the book does not exist. operationId: libraryagent.shelves.books.get @@ -321,14 +321,14 @@ paths: required: true schema: type: string - /v1/shelves/{shelvesId}/books: - parameters: *ref_5 - get: + /v1/shelves/{shelvesId}/books/{booksId}:return: + parameters: *ref_1 + post: description: >- - Lists books in a shelf. The order is unspecified but deterministic. - Newly created books will not necessarily be added to the end of this - list. Returns NOT_FOUND if the shelf does not exist. - operationId: libraryagent.shelves.books.list + Return a book to the library. Returns the book if it is returned to the + library successfully. Returns error if the book does not belong to the + library or the users didn't borrow before. + operationId: libraryagent.shelves.books.return security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -340,31 +340,27 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleExampleLibraryagentV1ListBooksResponse + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Book' parameters: - in: path name: shelvesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: booksId + required: true schema: type: string - /v1/shelves/{shelvesId}/books/{booksId}:return: - parameters: *ref_5 + /v1/shelves/{shelvesId}/books/{booksId}:borrow: + parameters: *ref_1 post: description: >- - Return a book to the library. Returns the book if it is returned to the - library successfully. Returns error if the book does not belong to the - library or the users didn't borrow before. - operationId: libraryagent.shelves.books.return + Borrow a book from the library. Returns the book if it is borrowed + successfully. Returns NOT_FOUND if the book does not exist in the + library. Returns quota exceeded error if the amount of books borrowed + exceeds allocation quota in any dimensions. + operationId: libraryagent.shelves.books.borrow security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -388,13 +384,11 @@ paths: required: true schema: type: string - /v1/shelves: - parameters: *ref_5 + /v1/shelves/{shelvesId}: + parameters: *ref_1 get: - description: >- - Lists shelves. The order is unspecified but deterministic. Newly created - shelves will not necessarily be added to the end of this list. - operationId: libraryagent.shelves.list + description: Gets a shelf. Returns NOT_FOUND if the shelf does not exist. + operationId: libraryagent.shelves.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -406,23 +400,20 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleExampleLibraryagentV1ListShelvesResponse + $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' parameters: - - in: query - name: pageToken + - in: path + name: shelvesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/shelves/{shelvesId}: - parameters: *ref_5 + /v1/shelves: + parameters: *ref_1 get: - description: Gets a shelf. Returns NOT_FOUND if the shelf does not exist. - operationId: libraryagent.shelves.get + description: >- + Lists shelves. The order is unspecified but deterministic. Newly created + shelves will not necessarily be added to the end of this list. + operationId: libraryagent.shelves.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -434,10 +425,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleExampleLibraryagentV1Shelf' + $ref: >- + #/components/schemas/GoogleExampleLibraryagentV1ListShelvesResponse parameters: - - in: path - name: shelvesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml b/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml index b90c79ac..66168611 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/lifesciences.yaml @@ -9,8 +9,8 @@ info: Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data. version: v2beta - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/life-sciences servers: @@ -1243,16 +1243,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2beta~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -1266,23 +1263,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.lifesciences.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2beta~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1303,6 +1298,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] pipelines: id: google.lifesciences.pipelines @@ -1320,10 +1316,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v2beta/projects/{projectsId}/locations: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1370,7 +1367,7 @@ paths: schema: type: string /v2beta/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Gets information about a location. operationId: lifesciences.projects.locations.get @@ -1398,7 +1395,7 @@ paths: schema: type: string /v2beta/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. @@ -1443,7 +1440,7 @@ paths: schema: type: string /v2beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1481,7 +1478,7 @@ paths: schema: type: string /v2beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1526,7 +1523,7 @@ paths: schema: type: string /v2beta/projects/{projectsId}/locations/{locationsId}/pipelines:run: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Runs a pipeline. The returned Operation's metadata field will contain a diff --git a/providers/src/googleapis.com/v00.00.00000/services/logging.yaml b/providers/src/googleapis.com/v00.00.00000/services/logging.yaml index 7a6703de..cd6f92f5 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/logging.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/logging.yaml @@ -7,8 +7,8 @@ info: title: Cloud Logging API description: Writes log entries and manages your Cloud Logging configuration. version: v2 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/logging/docs/ servers: @@ -683,8 +683,8 @@ components: Required. The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( - https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) - for details.For example: jsonPayload.request.status + https://cloud.google.com/logging/docs/analyze/custom-index) for + details.For example: jsonPayload.request.status type: string type: description: Required. The type of data in this index. @@ -826,6 +826,60 @@ components: example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND NOT LOG_ID("stdout") type: string + ListLogScopesResponse: + id: ListLogScopesResponse + description: >- + The response from ListLogScopes. Every project has a _Default log scope + that cannot be modified or deleted. + type: object + properties: + logScopes: + description: A list of log scopes. + type: array + items: + $ref: '#/components/schemas/LogScope' + nextPageToken: + description: >- + If there might be more results than appear in this response, then + nextPageToken is included. To get the next set of results, call the + same method again using the value of nextPageToken as pageToken. + type: string + LogScope: + id: LogScope + description: Describes a group of resources to read log entries from. + type: object + properties: + name: + description: >- + Output only. The resource name of the log scope.For + example:projects/my-project/locations/global/logScopes/my-log-scope + readOnly: true + type: string + resourceNames: + description: >- + Required. Names of one or more parent resources: + projects/[PROJECT_ID]May alternatively be one or more views: + projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A + log scope can include a maximum of 50 projects and a maximum of 100 + resources in total. + type: array + items: + type: string + description: + description: >- + Optional. Describes this log scope.The maximum length of the + description is 8000 characters. + type: string + createTime: + description: Output only. The creation timestamp of the log scope. + readOnly: true + type: string + format: google-datetime + updateTime: + description: Output only. The last update timestamp of the log scope. + readOnly: true + type: string + format: google-datetime ListExclusionsResponse: id: ListExclusionsResponse description: Result returned from ListExclusions. @@ -1898,7 +1952,9 @@ components: latency: description: >- The request processing latency on the server, from the time the - request was received until the response was sent. + request was received until the response was sent. For WebSocket + connections, this field refers to the entire time duration of the + connection. type: string format: google-duration cacheLookup: @@ -1922,9 +1978,7 @@ components: type: string format: int64 protocol: - description: >- - Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", - "websocket" + description: 'Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2"' type: string MonitoredResourceMetadata: id: MonitoredResourceMetadata @@ -2075,9 +2129,15 @@ components: resourceNames: description: >- Required. Names of one or more parent resources from which to - retrieve log entries: projects/[PROJECT_ID] + retrieve log entries. Resources may either be resource containers or + specific LogViews. For the case of resource containers, all logs + ingested into that container will be returned regardless of which + LogBuckets they are actually stored in - i.e. these queries may fan + out to multiple regions. In the event of region unavailability, + specify a specific set of LogViews that do not include the + unavailable region. projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] - folders/[FOLDER_ID]May alternatively be one or more views: + folders/[FOLDER_ID] projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] @@ -2836,6 +2896,21 @@ components: excluding data loss due to errors. type: string format: google-duration + timeSeriesResourceHierarchyLevel: + description: The scope of the timeseries data of the metric. + type: array + items: + type: string + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER BucketOptions: id: BucketOptions description: >- @@ -3497,42 +3572,33 @@ components: name: locations title: Locations methods: - _locations_list: - operation: &ref_1 + locations_list: + operation: $ref: '#/paths/~1v2~1{name}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - locations_list: - operation: *ref_1 - response: *ref_2 - _projects_locations_list: - operation: &ref_3 + projects_locations_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_3 - response: *ref_4 projects_locations_get: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_list: - operation: &ref_5 + organizations_locations_list: + operation: $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1locations/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - organizations_locations_list: - operation: *ref_5 - response: *ref_6 organizations_locations_get: operation: $ref: >- @@ -3540,32 +3606,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_list: - operation: &ref_7 + folders_locations_list: + operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1locations/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - folders_locations_list: - operation: *ref_7 - response: *ref_8 folders_locations_get: operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_list: - operation: &ref_9 + billing_accounts_locations_list: + operation: $ref: '#/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - billing_accounts_locations_list: - operation: *ref_9 - response: *ref_10 billing_accounts_locations_get: operation: $ref: >- @@ -3594,6 +3654,7 @@ components: #/components/x-stackQL-resources/locations/methods/billing_accounts_locations_list insert: [] update: [] + replace: [] delete: [] exclusions: id: google.logging.exclusions @@ -3618,32 +3679,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _exclusions_list: - operation: &ref_11 + exclusions_list: + operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1exclusions/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.exclusions - exclusions_list: - operation: *ref_11 - response: *ref_12 exclusions_create: operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1exclusions/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_exclusions_list: - operation: &ref_13 + projects_exclusions_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1exclusions/get' - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.exclusions - projects_exclusions_list: - operation: *ref_13 - response: *ref_14 projects_exclusions_create: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1exclusions/post' @@ -3671,16 +3726,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_exclusions_list: - operation: &ref_15 + organizations_exclusions_list: + operation: $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1exclusions/get' - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.exclusions - organizations_exclusions_list: - operation: *ref_15 - response: *ref_16 organizations_exclusions_create: operation: $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1exclusions/post' @@ -3708,16 +3760,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_exclusions_list: - operation: &ref_17 + folders_exclusions_list: + operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1exclusions/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.exclusions - folders_exclusions_list: - operation: *ref_17 - response: *ref_18 folders_exclusions_create: operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1exclusions/post' @@ -3744,16 +3793,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_exclusions_list: - operation: &ref_19 + billing_accounts_exclusions_list: + operation: $ref: '#/paths/~1v2~1billingAccounts~1{billingAccountsId}~1exclusions/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.exclusions - billing_accounts_exclusions_list: - operation: *ref_19 - response: *ref_20 billing_accounts_exclusions_create: operation: $ref: >- @@ -3825,6 +3871,7 @@ components: #/components/x-stackQL-resources/exclusions/methods/billing_accounts_exclusions_patch - $ref: >- #/components/x-stackQL-resources/exclusions/methods/exclusions_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/exclusions/methods/projects_exclusions_delete @@ -3847,33 +3894,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _locations_buckets_list: - operation: &ref_21 + locations_buckets_list: + operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1buckets/get' - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.buckets - locations_buckets_list: - operation: *ref_21 - response: *ref_22 locations_buckets_create: operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1buckets/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_buckets_list: - operation: &ref_23 + projects_locations_buckets_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1buckets/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.buckets - projects_locations_buckets_list: - operation: *ref_23 - response: *ref_24 projects_locations_buckets_create: operation: $ref: >- @@ -3909,17 +3950,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_buckets_list: - operation: &ref_25 + organizations_locations_buckets_list: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1buckets/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.buckets - organizations_locations_buckets_list: - operation: *ref_25 - response: *ref_26 organizations_locations_buckets_create: operation: $ref: >- @@ -3955,17 +3993,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_buckets_list: - operation: &ref_27 + folders_locations_buckets_list: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1buckets/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.buckets - folders_locations_buckets_list: - operation: *ref_27 - response: *ref_28 folders_locations_buckets_create: operation: $ref: >- @@ -4001,17 +4036,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_buckets_list: - operation: &ref_29 + billing_accounts_locations_buckets_list: + operation: $ref: >- #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1buckets/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.buckets - billing_accounts_locations_buckets_list: - operation: *ref_29 - response: *ref_30 billing_accounts_locations_buckets_create: operation: $ref: >- @@ -4087,6 +4119,7 @@ components: #/components/x-stackQL-resources/buckets/methods/folders_locations_buckets_patch - $ref: >- #/components/x-stackQL-resources/buckets/methods/billing_accounts_locations_buckets_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/buckets/methods/projects_locations_buckets_delete @@ -4101,27 +4134,21 @@ components: name: operations title: Operations methods: - _locations_operations_list: - operation: &ref_31 + locations_operations_list: + operation: $ref: '#/paths/~1v2~1{name}~1operations/get' - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - locations_operations_list: - operation: *ref_31 - response: *ref_32 - _projects_locations_operations_list: - operation: &ref_33 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_33 - response: *ref_34 projects_locations_operations_get: operation: $ref: >- @@ -4136,17 +4163,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_operations_list: - operation: &ref_35 + organizations_locations_operations_list: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - organizations_locations_operations_list: - operation: *ref_35 - response: *ref_36 organizations_locations_operations_get: operation: $ref: >- @@ -4161,17 +4185,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_operations_list: - operation: &ref_37 + folders_locations_operations_list: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1operations/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - folders_locations_operations_list: - operation: *ref_37 - response: *ref_38 folders_locations_operations_get: operation: $ref: >- @@ -4186,17 +4207,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_operations_list: - operation: &ref_39 + billing_accounts_locations_operations_list: + operation: $ref: >- #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1operations/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - billing_accounts_locations_operations_list: - operation: *ref_39 - response: *ref_40 billing_accounts_locations_operations_get: operation: $ref: >- @@ -4229,8 +4247,11 @@ components: #/components/x-stackQL-resources/operations/methods/folders_locations_operations_list - $ref: >- #/components/x-stackQL-resources/operations/methods/billing_accounts_locations_operations_list + - $ref: >- + #/components/x-stackQL-resources/operations/methods/locations_operations_list insert: [] update: [] + replace: [] delete: [] views_iam_policies: id: google.logging.views_iam_policies @@ -4250,17 +4271,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_buckets_views_get_iam_policy: - operation: &ref_41 + projects_locations_buckets_views_get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views~1{viewsId}:getIamPolicy/post - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_buckets_views_get_iam_policy: - operation: *ref_41 - response: *ref_42 projects_locations_buckets_views_test_iam_permissions: operation: $ref: >- @@ -4275,17 +4293,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_buckets_views_get_iam_policy: - operation: &ref_43 + organizations_locations_buckets_views_get_iam_policy: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views~1{viewsId}:getIamPolicy/post - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - organizations_locations_buckets_views_get_iam_policy: - operation: *ref_43 - response: *ref_44 organizations_locations_buckets_views_test_iam_permissions: operation: $ref: >- @@ -4300,17 +4315,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_buckets_views_get_iam_policy: - operation: &ref_45 + folders_locations_buckets_views_get_iam_policy: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views~1{viewsId}:getIamPolicy/post - response: &ref_46 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - folders_locations_buckets_views_get_iam_policy: - operation: *ref_45 - response: *ref_46 folders_locations_buckets_views_test_iam_permissions: operation: $ref: >- @@ -4328,39 +4340,40 @@ components: #/components/x-stackQL-resources/views_iam_policies/methods/folders_locations_buckets_views_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/views_iam_policies/methods/projects_locations_buckets_views_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/views_iam_policies/methods/organizations_locations_buckets_views_set_iam_policy + - $ref: >- + #/components/x-stackQL-resources/views_iam_policies/methods/folders_locations_buckets_views_set_iam_policy delete: [] views: id: google.logging.views name: views title: Views methods: - _locations_buckets_views_list: - operation: &ref_47 + locations_buckets_views_list: + operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1views/get' - response: &ref_48 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.views - locations_buckets_views_list: - operation: *ref_47 - response: *ref_48 locations_buckets_views_create: operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1views/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_buckets_views_list: - operation: &ref_49 + projects_locations_buckets_views_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views/get - response: &ref_50 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.views - projects_locations_buckets_views_list: - operation: *ref_49 - response: *ref_50 projects_locations_buckets_views_create: operation: $ref: >- @@ -4389,17 +4402,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_buckets_views_list: - operation: &ref_51 + organizations_locations_buckets_views_list: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views/get - response: &ref_52 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.views - organizations_locations_buckets_views_list: - operation: *ref_51 - response: *ref_52 organizations_locations_buckets_views_create: operation: $ref: >- @@ -4428,17 +4438,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_buckets_views_list: - operation: &ref_53 + folders_locations_buckets_views_list: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views/get - response: &ref_54 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.views - folders_locations_buckets_views_list: - operation: *ref_53 - response: *ref_54 folders_locations_buckets_views_create: operation: $ref: >- @@ -4467,17 +4474,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_buckets_views_list: - operation: &ref_55 + billing_accounts_locations_buckets_views_list: + operation: $ref: >- #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views/get - response: &ref_56 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.views - billing_accounts_locations_buckets_views_list: - operation: *ref_55 - response: *ref_56 billing_accounts_locations_buckets_views_create: operation: $ref: >- @@ -4546,6 +4550,7 @@ components: #/components/x-stackQL-resources/views/methods/folders_locations_buckets_views_patch - $ref: >- #/components/x-stackQL-resources/views/methods/billing_accounts_locations_buckets_views_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/views/methods/projects_locations_buckets_views_delete @@ -4560,33 +4565,27 @@ components: name: links title: Links methods: - _locations_buckets_links_list: - operation: &ref_57 + locations_buckets_links_list: + operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1links/get' - response: &ref_58 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.links - locations_buckets_links_list: - operation: *ref_57 - response: *ref_58 locations_buckets_links_create: operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1links/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_buckets_links_list: - operation: &ref_59 + projects_locations_buckets_links_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1links/get - response: &ref_60 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.links - projects_locations_buckets_links_list: - operation: *ref_59 - response: *ref_60 projects_locations_buckets_links_create: operation: $ref: >- @@ -4608,17 +4607,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_buckets_links_list: - operation: &ref_61 + organizations_locations_buckets_links_list: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1links/get - response: &ref_62 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.links - organizations_locations_buckets_links_list: - operation: *ref_61 - response: *ref_62 organizations_locations_buckets_links_create: operation: $ref: >- @@ -4640,17 +4636,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_buckets_links_list: - operation: &ref_63 + folders_locations_buckets_links_list: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1links/get - response: &ref_64 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.links - folders_locations_buckets_links_list: - operation: *ref_63 - response: *ref_64 folders_locations_buckets_links_create: operation: $ref: >- @@ -4672,17 +4665,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_buckets_links_list: - operation: &ref_65 + billing_accounts_locations_buckets_links_list: + operation: $ref: >- #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1links/get - response: &ref_66 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.links - billing_accounts_locations_buckets_links_list: - operation: *ref_65 - response: *ref_66 billing_accounts_locations_buckets_links_create: operation: $ref: >- @@ -4736,6 +4726,7 @@ components: - $ref: >- #/components/x-stackQL-resources/links/methods/locations_buckets_links_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/links/methods/projects_locations_buckets_links_delete @@ -4750,16 +4741,13 @@ components: name: sinks title: Sinks methods: - _sinks_list: - operation: &ref_67 + sinks_list: + operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1sinks/get' - response: &ref_68 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sinks - sinks_list: - operation: *ref_67 - response: *ref_68 sinks_create: operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1sinks/post' @@ -4784,16 +4772,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_sinks_list: - operation: &ref_69 + projects_sinks_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1sinks/get' - response: &ref_70 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sinks - projects_sinks_list: - operation: *ref_69 - response: *ref_70 projects_sinks_create: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1sinks/post' @@ -4824,16 +4809,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_sinks_list: - operation: &ref_71 + organizations_sinks_list: + operation: $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1sinks/get' - response: &ref_72 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sinks - organizations_sinks_list: - operation: *ref_71 - response: *ref_72 organizations_sinks_create: operation: $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1sinks/post' @@ -4868,16 +4850,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_sinks_list: - operation: &ref_73 + folders_sinks_list: + operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1sinks/get' - response: &ref_74 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sinks - folders_sinks_list: - operation: *ref_73 - response: *ref_74 folders_sinks_create: operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1sinks/post' @@ -4908,16 +4887,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_sinks_list: - operation: &ref_75 + billing_accounts_sinks_list: + operation: $ref: '#/paths/~1v2~1billingAccounts~1{billingAccountsId}~1sinks/get' - response: &ref_76 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sinks - billing_accounts_sinks_list: - operation: *ref_75 - response: *ref_76 billing_accounts_sinks_create: operation: $ref: '#/paths/~1v2~1billingAccounts~1{billingAccountsId}~1sinks/post' @@ -4979,21 +4955,22 @@ components: - $ref: >- #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_create update: - - $ref: >- - #/components/x-stackQL-resources/sinks/methods/projects_sinks_update - $ref: >- #/components/x-stackQL-resources/sinks/methods/projects_sinks_patch - - $ref: >- - #/components/x-stackQL-resources/sinks/methods/organizations_sinks_update - $ref: >- #/components/x-stackQL-resources/sinks/methods/organizations_sinks_patch + - $ref: '#/components/x-stackQL-resources/sinks/methods/folders_sinks_patch' + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_patch + replace: + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/projects_sinks_update + - $ref: >- + #/components/x-stackQL-resources/sinks/methods/organizations_sinks_update - $ref: >- #/components/x-stackQL-resources/sinks/methods/folders_sinks_update - - $ref: '#/components/x-stackQL-resources/sinks/methods/folders_sinks_patch' - $ref: >- #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_update - - $ref: >- - #/components/x-stackQL-resources/sinks/methods/billing_accounts_sinks_patch - $ref: '#/components/x-stackQL-resources/sinks/methods/sinks_update' delete: - $ref: >- @@ -5027,7 +5004,10 @@ components: - $ref: >- #/components/x-stackQL-resources/logging_cmek_settings/methods/get_cmek_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/logging_cmek_settings/methods/update_cmek_settings + replace: [] delete: [] logging_settings: id: google.logging.logging_settings @@ -5051,7 +5031,10 @@ components: - $ref: >- #/components/x-stackQL-resources/logging_settings/methods/get_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/logging_settings/methods/update_settings + replace: [] delete: [] cmek_settings: id: google.logging.cmek_settings @@ -5091,7 +5074,10 @@ components: - $ref: >- #/components/x-stackQL-resources/cmek_settings/methods/folders_get_cmek_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/cmek_settings/methods/organizations_update_cmek_settings + replace: [] delete: [] settings: id: google.logging.settings @@ -5137,7 +5123,12 @@ components: - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_get_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/settings/methods/organizations_update_settings + - $ref: >- + #/components/x-stackQL-resources/settings/methods/folders_update_settings + replace: [] delete: [] buckets_async: id: google.logging.buckets_async @@ -5211,51 +5202,51 @@ components: #/components/x-stackQL-resources/buckets_async/methods/folders_locations_buckets_create_async - $ref: >- #/components/x-stackQL-resources/buckets_async/methods/billing_accounts_locations_buckets_create_async - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/buckets_async/methods/projects_locations_buckets_update_async + - $ref: >- + #/components/x-stackQL-resources/buckets_async/methods/organizations_locations_buckets_update_async + - $ref: >- + #/components/x-stackQL-resources/buckets_async/methods/folders_locations_buckets_update_async + - $ref: >- + #/components/x-stackQL-resources/buckets_async/methods/billing_accounts_locations_buckets_update_async + replace: [] delete: [] logs: id: google.logging.logs name: logs title: Logs methods: - _projects_locations_buckets_views_logs_list: - operation: &ref_77 + projects_locations_buckets_views_logs_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views~1{viewsId}~1logs/get - response: &ref_78 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - projects_locations_buckets_views_logs_list: - operation: *ref_77 - response: *ref_78 projects_logs_delete: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1logs~1{logsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - _projects_logs_list: - operation: &ref_79 + projects_logs_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1logs/get' - response: &ref_80 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - projects_logs_list: - operation: *ref_79 - response: *ref_80 - _organizations_locations_buckets_views_logs_list: - operation: &ref_81 + organizations_locations_buckets_views_logs_list: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views~1{viewsId}~1logs/get - response: &ref_82 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - organizations_locations_buckets_views_logs_list: - operation: *ref_81 - response: *ref_82 organizations_logs_delete: operation: $ref: >- @@ -5263,54 +5254,42 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_logs_list: - operation: &ref_83 + organizations_logs_list: + operation: $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1logs/get' - response: &ref_84 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - organizations_logs_list: - operation: *ref_83 - response: *ref_84 - _folders_locations_buckets_views_logs_list: - operation: &ref_85 + folders_locations_buckets_views_logs_list: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views~1{viewsId}~1logs/get - response: &ref_86 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - folders_locations_buckets_views_logs_list: - operation: *ref_85 - response: *ref_86 folders_logs_delete: operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1logs~1{logsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - _folders_logs_list: - operation: &ref_87 + folders_logs_list: + operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1logs/get' - response: &ref_88 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - folders_logs_list: - operation: *ref_87 - response: *ref_88 - _billing_accounts_locations_buckets_views_logs_list: - operation: &ref_89 + billing_accounts_locations_buckets_views_logs_list: + operation: $ref: >- #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1buckets~1{bucketsId}~1views~1{viewsId}~1logs/get - response: &ref_90 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - billing_accounts_locations_buckets_views_logs_list: - operation: *ref_89 - response: *ref_90 billing_accounts_logs_delete: operation: $ref: >- @@ -5318,32 +5297,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_logs_list: - operation: &ref_91 - $ref: '#/paths/~1v2~1billingAccounts~1{billingAccountsId}~1logs/get' - response: &ref_92 + billing_accounts_logs_list: + operation: + $ref: '#/paths/~1v2~1billingAccounts~1{billingAccountsId}~1logs/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - billing_accounts_logs_list: - operation: *ref_91 - response: *ref_92 logs_delete: operation: $ref: '#/paths/~1v2~1{logName}/delete' response: mediaType: application/json openAPIDocKey: '200' - _logs_list: - operation: &ref_93 + logs_list: + operation: $ref: '#/paths/~1v2~1{parentType}~1{parent}~1logs/get' - response: &ref_94 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.logNames - logs_list: - operation: *ref_93 - response: *ref_94 sqlVerbs: select: - $ref: >- @@ -5363,6 +5336,7 @@ components: #/components/x-stackQL-resources/logs/methods/billing_accounts_logs_list insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/logs/methods/projects_logs_delete' - $ref: >- @@ -5371,22 +5345,168 @@ components: - $ref: >- #/components/x-stackQL-resources/logs/methods/billing_accounts_logs_delete - $ref: '#/components/x-stackQL-resources/logs/methods/logs_delete' + log_scopes: + id: google.logging.log_scopes + name: log_scopes + title: Log_scopes + methods: + projects_locations_log_scopes_list: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1logScopes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.logScopes + projects_locations_log_scopes_create: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1logScopes/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_log_scopes_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_log_scopes_patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_log_scopes_delete: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_log_scopes_list: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1logScopes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.logScopes + organizations_locations_log_scopes_create: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1logScopes/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_log_scopes_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_log_scopes_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_log_scopes_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_log_scopes_list: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1logScopes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.logScopes + folders_locations_log_scopes_create: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1logScopes/post + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_log_scopes_get: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_log_scopes_patch: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_log_scopes_delete: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1logScopes~1{logScopesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/projects_locations_log_scopes_get + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/organizations_locations_log_scopes_get + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/folders_locations_log_scopes_get + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/projects_locations_log_scopes_list + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/organizations_locations_log_scopes_list + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/folders_locations_log_scopes_list + insert: + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/projects_locations_log_scopes_create + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/organizations_locations_log_scopes_create + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/folders_locations_log_scopes_create + update: + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/projects_locations_log_scopes_patch + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/organizations_locations_log_scopes_patch + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/folders_locations_log_scopes_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/projects_locations_log_scopes_delete + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/organizations_locations_log_scopes_delete + - $ref: >- + #/components/x-stackQL-resources/log_scopes/methods/folders_locations_log_scopes_delete saved_queries: id: google.logging.saved_queries name: saved_queries title: Saved_queries methods: - _projects_locations_saved_queries_list: - operation: &ref_95 + projects_locations_saved_queries_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1savedQueries/get - response: &ref_96 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.savedQueries - projects_locations_saved_queries_list: - operation: *ref_95 - response: *ref_96 projects_locations_saved_queries_create: operation: $ref: >- @@ -5394,6 +5514,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + projects_locations_saved_queries_get: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_saved_queries_patch: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' projects_locations_saved_queries_delete: operation: $ref: >- @@ -5401,17 +5535,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_saved_queries_list: - operation: &ref_97 + organizations_locations_saved_queries_list: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1savedQueries/get - response: &ref_98 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.savedQueries - organizations_locations_saved_queries_list: - operation: *ref_97 - response: *ref_98 organizations_locations_saved_queries_create: operation: $ref: >- @@ -5419,6 +5550,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + organizations_locations_saved_queries_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_saved_queries_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' organizations_locations_saved_queries_delete: operation: $ref: >- @@ -5426,17 +5571,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_saved_queries_list: - operation: &ref_99 + folders_locations_saved_queries_list: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1savedQueries/get - response: &ref_100 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.savedQueries - folders_locations_saved_queries_list: - operation: *ref_99 - response: *ref_100 folders_locations_saved_queries_create: operation: $ref: >- @@ -5444,6 +5586,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + folders_locations_saved_queries_get: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_saved_queries_patch: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' folders_locations_saved_queries_delete: operation: $ref: >- @@ -5451,17 +5607,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_saved_queries_list: - operation: &ref_101 + billing_accounts_locations_saved_queries_list: + operation: $ref: >- #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1savedQueries/get - response: &ref_102 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.savedQueries - billing_accounts_locations_saved_queries_list: - operation: *ref_101 - response: *ref_102 billing_accounts_locations_saved_queries_create: operation: $ref: >- @@ -5469,6 +5622,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' + billing_accounts_locations_saved_queries_get: + operation: + $ref: >- + #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + billing_accounts_locations_saved_queries_patch: + operation: + $ref: >- + #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1savedQueries~1{savedQueriesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' billing_accounts_locations_saved_queries_delete: operation: $ref: >- @@ -5478,6 +5645,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/projects_locations_saved_queries_get + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/organizations_locations_saved_queries_get + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/folders_locations_saved_queries_get + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/billing_accounts_locations_saved_queries_get - $ref: >- #/components/x-stackQL-resources/saved_queries/methods/projects_locations_saved_queries_list - $ref: >- @@ -5495,7 +5670,16 @@ components: #/components/x-stackQL-resources/saved_queries/methods/folders_locations_saved_queries_create - $ref: >- #/components/x-stackQL-resources/saved_queries/methods/billing_accounts_locations_saved_queries_create - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/projects_locations_saved_queries_patch + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/organizations_locations_saved_queries_patch + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/folders_locations_saved_queries_patch + - $ref: >- + #/components/x-stackQL-resources/saved_queries/methods/billing_accounts_locations_saved_queries_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/saved_queries/methods/projects_locations_saved_queries_delete @@ -5510,50 +5694,38 @@ components: name: recent_queries title: Recent_queries methods: - _projects_locations_recent_queries_list: - operation: &ref_103 + projects_locations_recent_queries_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1recentQueries/get - response: &ref_104 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.recentQueries - projects_locations_recent_queries_list: - operation: *ref_103 - response: *ref_104 - _organizations_locations_recent_queries_list: - operation: &ref_105 + organizations_locations_recent_queries_list: + operation: $ref: >- #/paths/~1v2~1organizations~1{organizationsId}~1locations~1{locationsId}~1recentQueries/get - response: &ref_106 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.recentQueries - organizations_locations_recent_queries_list: - operation: *ref_105 - response: *ref_106 - _folders_locations_recent_queries_list: - operation: &ref_107 + folders_locations_recent_queries_list: + operation: $ref: >- #/paths/~1v2~1folders~1{foldersId}~1locations~1{locationsId}~1recentQueries/get - response: &ref_108 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.recentQueries - folders_locations_recent_queries_list: - operation: *ref_107 - response: *ref_108 - _billing_accounts_locations_recent_queries_list: - operation: &ref_109 + billing_accounts_locations_recent_queries_list: + operation: $ref: >- #/paths/~1v2~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recentQueries/get - response: &ref_110 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.recentQueries - billing_accounts_locations_recent_queries_list: - operation: *ref_109 - response: *ref_110 sqlVerbs: select: - $ref: >- @@ -5566,22 +5738,20 @@ components: #/components/x-stackQL-resources/recent_queries/methods/billing_accounts_locations_recent_queries_list insert: [] update: [] + replace: [] delete: [] metrics: id: google.logging.metrics name: metrics title: Metrics methods: - _projects_metrics_list: - operation: &ref_111 + projects_metrics_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1metrics/get' - response: &ref_112 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.metrics - projects_metrics_list: - operation: *ref_111 - response: *ref_112 projects_metrics_create: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1metrics/post' @@ -5615,7 +5785,8 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/metrics/methods/projects_metrics_create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/metrics/methods/projects_metrics_update delete: @@ -5639,6 +5810,7 @@ components: #/components/x-stackQL-resources/billing_accounts_cmek_settings/methods/billing_accounts_get_cmek_settings insert: [] update: [] + replace: [] delete: [] billing_accounts_settings: id: google.logging.billing_accounts_settings @@ -5657,6 +5829,7 @@ components: #/components/x-stackQL-resources/billing_accounts_settings/methods/billing_accounts_get_settings insert: [] update: [] + replace: [] delete: [] entries: id: google.logging.entries @@ -5688,35 +5861,35 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/entries/methods/entries_list' insert: [] update: [] + replace: [] delete: [] monitored_resource_descriptors: id: google.logging.monitored_resource_descriptors name: monitored_resource_descriptors title: Monitored_resource_descriptors methods: - _monitored_resource_descriptors_list: - operation: &ref_113 + monitored_resource_descriptors_list: + operation: $ref: '#/paths/~1v2~1monitoredResourceDescriptors/get' - response: &ref_114 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resourceDescriptors - monitored_resource_descriptors_list: - operation: *ref_113 - response: *ref_114 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/monitored_resource_descriptors/methods/monitored_resource_descriptors_list insert: [] update: [] + replace: [] delete: [] paths: /v2/{name}/locations: - parameters: &ref_115 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -5775,7 +5948,7 @@ paths: schema: type: string /v2/{name}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets the description of an exclusion in the _Default sink. operationId: logging.exclusions.get @@ -5904,7 +6077,7 @@ paths: schema: type: string /v2/{name}/operations: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -5954,7 +6127,7 @@ paths: schema: type: string /v2/{parentType}/{parent}/buckets: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists log buckets. operationId: logging.locations.buckets.list @@ -6044,7 +6217,7 @@ paths: schema: type: string /v2/{resource}: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6089,7 +6262,7 @@ paths: schema: type: string /v2/{parentType}/{parent}/views: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists views on a log bucket. operationId: logging.locations.buckets.views.list @@ -6179,7 +6352,7 @@ paths: schema: type: string /v2/{parentType}/{parent}/links: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists links. operationId: logging.locations.buckets.links.list @@ -6270,7 +6443,7 @@ paths: schema: type: string /v2/{parentType}/{parent}/exclusions: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists all the exclusions on the _Default sink in a parent resource. operationId: logging.exclusions.list @@ -6357,7 +6530,7 @@ paths: schema: type: string /v2/{parentType}/{parent}/sinks: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists sinks. operationId: logging.sinks.list @@ -6457,7 +6630,7 @@ paths: schema: type: string /v2/{sinkName}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a sink. operationId: logging.sinks.get @@ -6566,7 +6739,7 @@ paths: schema: type: string /v2/{name}/cmekSettings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the Logging CMEK settings for the given resource.Note: CMEK for the @@ -6653,7 +6826,7 @@ paths: type: string format: google-fieldmask /v2/{name}/settings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the settings for the given resource.Note: Settings can be retrieved @@ -6740,7 +6913,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/cmekSettings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the Logging CMEK settings for the given resource.Note: CMEK for the @@ -6782,7 +6955,7 @@ paths: schema: type: string /v2/projects/{projectsId}/settings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the settings for the given resource.Note: Settings can be retrieved @@ -6822,7 +6995,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: logging.projects.locations.list @@ -6870,7 +7043,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets information about a location. operationId: logging.projects.locations.get @@ -6910,7 +7083,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -6965,7 +7138,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -7013,7 +7186,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -7064,7 +7237,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists log buckets. operationId: logging.projects.locations.buckets.list @@ -7154,7 +7327,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a log bucket. operationId: logging.projects.locations.buckets.get @@ -7285,7 +7458,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets:createAsync: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Creates a log bucket asynchronously that can be used to store log @@ -7329,7 +7502,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}:updateAsync: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Updates a log bucket asynchronously.If the bucket has a lifecycle_state @@ -7379,7 +7552,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}:undelete: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Undeletes a log bucket. A bucket that has been deleted can be undeleted @@ -7423,7 +7596,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7473,7 +7646,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7530,7 +7703,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7590,7 +7763,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists views on a log bucket. operationId: logging.projects.locations.buckets.views.list @@ -7690,7 +7863,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a view on a log bucket. operationId: logging.projects.locations.buckets.views.get @@ -7838,7 +8011,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -7903,7 +8076,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/links: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists links. operationId: logging.projects.locations.buckets.links.list @@ -8004,7 +8177,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}/links/{linksId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a link. operationId: logging.projects.locations.buckets.links.get @@ -8095,11 +8268,11 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/savedQueries: - parameters: *ref_115 + /v2/projects/{projectsId}/locations/{locationsId}/logScopes: + parameters: *ref_1 get: - description: Lists the SavedQueries that were created by the user making the request. - operationId: logging.projects.locations.savedQueries.list + description: Lists log scopes. + operationId: logging.projects.locations.logScopes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8123,7 +8296,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListSavedQueriesResponse' + $ref: '#/components/schemas/ListLogScopesResponse' parameters: - in: path name: projectsId @@ -8145,13 +8318,13 @@ paths: type: integer format: int32 post: - description: Creates a new SavedQuery for the user making the request. - operationId: logging.projects.locations.savedQueries.create + description: Creates a log scope. + operationId: logging.projects.locations.logScopes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SavedQuery' + $ref: '#/components/schemas/LogScope' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8167,7 +8340,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SavedQuery' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: projectsId @@ -8180,32 +8353,38 @@ paths: schema: type: string - in: query - name: savedQueryId + name: logScopeId schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/savedQueries/{savedQueriesId}: - parameters: *ref_115 - delete: - description: >- - Deletes an existing SavedQuery that was created by the user making the - request. - operationId: logging.projects.locations.savedQueries.delete + /v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}: + parameters: *ref_1 + get: + description: Gets a log scope. + operationId: logging.projects.locations.logScopes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2: - https://www.googleapis.com/auth/logging.admin Oauth2c: - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: projectsId @@ -8218,41 +8397,34 @@ paths: schema: type: string - in: path - name: savedQueriesId + name: logScopesId required: true schema: type: string - /v2/projects/{projectsId}/locations/{locationsId}/recentQueries: - parameters: *ref_115 - get: - description: >- - Lists the RecentQueries that were created by the user making the - request. - operationId: logging.projects.locations.recentQueries.list + patch: + description: Updates a log scope. + operationId: logging.projects.locations.logScopes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogScope' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2: - https://www.googleapis.com/auth/logging.admin Oauth2c: - https://www.googleapis.com/auth/logging.admin - - Oauth2: - - https://www.googleapis.com/auth/logging.read - Oauth2c: - - https://www.googleapis.com/auth/logging.read responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ListRecentQueriesResponse' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: projectsId @@ -8264,20 +8436,56 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: logScopesId + required: true schema: type: string - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 - /v2/projects/{projectsId}/exclusions: - parameters: *ref_115 - get: - description: Lists all the exclusions on the _Default sink in a parent resource. - operationId: logging.projects.exclusions.list + type: string + format: google-fieldmask + delete: + description: Deletes a log scope. + operationId: logging.projects.locations.logScopes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: logScopesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/savedQueries: + parameters: *ref_1 + get: + description: Lists the SavedQueries that were created by the user making the request. + operationId: logging.projects.locations.savedQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8301,13 +8509,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListExclusionsResponse' + $ref: '#/components/schemas/ListSavedQueriesResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query name: pageToken schema: @@ -8317,17 +8530,18 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string post: - description: >- - Creates a new exclusion in the _Default sink in a specified parent - resource. Only log entries belonging to that resource can be excluded. - You can have up to 10 exclusions in a resource. - operationId: logging.projects.exclusions.create + description: Creates a new SavedQuery for the user making the request. + operationId: logging.projects.locations.savedQueries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8343,18 +8557,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: projectsId required: true schema: type: string - /v2/projects/{projectsId}/exclusions/{exclusionsId}: - parameters: *ref_115 + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: savedQueryId + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/savedQueries/{savedQueriesId}: + parameters: *ref_1 get: - description: Gets the description of an exclusion in the _Default sink. - operationId: logging.projects.exclusions.get + description: Returns all data associated with the requested query. + operationId: logging.projects.locations.savedQueries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8378,7 +8601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: projectsId @@ -8386,20 +8609,23 @@ paths: schema: type: string - in: path - name: exclusionsId + name: locationsId + required: true + schema: + type: string + - in: path + name: savedQueriesId required: true schema: type: string patch: - description: >- - Changes one or more properties of an existing exclusion in the _Default - sink. - operationId: logging.projects.exclusions.patch + description: Updates an existing SavedQuery. + operationId: logging.projects.locations.savedQueries.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8415,7 +8641,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: projectsId @@ -8423,7 +8649,12 @@ paths: schema: type: string - in: path - name: exclusionsId + name: locationsId + required: true + schema: + type: string + - in: path + name: savedQueriesId required: true schema: type: string @@ -8433,8 +8664,10 @@ paths: type: string format: google-fieldmask delete: - description: Deletes an exclusion in the _Default sink. - operationId: logging.projects.exclusions.delete + description: >- + Deletes an existing SavedQuery that was created by the user making the + request. + operationId: logging.projects.locations.savedQueries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8458,15 +8691,22 @@ paths: schema: type: string - in: path - name: exclusionsId + name: locationsId required: true schema: type: string - /v2/projects/{projectsId}/sinks: - parameters: *ref_115 + - in: path + name: savedQueriesId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/recentQueries: + parameters: *ref_1 get: - description: Lists sinks. - operationId: logging.projects.sinks.list + description: >- + Lists the RecentQueries that were created by the user making the + request. + operationId: logging.projects.locations.recentQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8490,13 +8730,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListSinksResponse' + $ref: '#/components/schemas/ListRecentQueriesResponse' parameters: - in: path name: projectsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query name: pageToken schema: @@ -8510,18 +8755,61 @@ paths: name: filter schema: type: string + /v2/projects/{projectsId}/exclusions: + parameters: *ref_1 + get: + description: Lists all the exclusions on the _Default sink in a parent resource. + operationId: logging.projects.exclusions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListExclusionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- - Creates a sink that exports specified log entries to a destination. The - export begins upon ingress, unless the sink's writer_identity is not - permitted to write to the destination. A sink can export log entries - only from the resource owning the sink. - operationId: logging.projects.sinks.create + Creates a new exclusion in the _Default sink in a specified parent + resource. Only log entries belonging to that resource can be excluded. + You can have up to 10 exclusions in a resource. + operationId: logging.projects.exclusions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8537,26 +8825,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: uniqueWriterIdentity - schema: - type: boolean - - in: query - name: customWriterIdentity - schema: - type: string - /v2/projects/{projectsId}/sinks/{sinksId}: - parameters: *ref_115 + /v2/projects/{projectsId}/exclusions/{exclusionsId}: + parameters: *ref_1 get: - description: Gets a sink. - operationId: logging.projects.sinks.get + description: Gets the description of an exclusion in the _Default sink. + operationId: logging.projects.exclusions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8580,7 +8860,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' parameters: - in: path name: projectsId @@ -8588,22 +8868,20 @@ paths: schema: type: string - in: path - name: sinksId + name: exclusionsId required: true schema: type: string - put: + patch: description: >- - Updates a sink. This method replaces the values of the destination and - filter fields of the existing sink with the corresponding values from - the new sink.The updated sink might also have a new writer_identity; see - the unique_writer_identity field. - operationId: logging.projects.sinks.update + Changes one or more properties of an existing exclusion in the _Default + sink. + operationId: logging.projects.exclusions.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8619,7 +8897,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' parameters: - in: path name: projectsId @@ -8627,35 +8905,18 @@ paths: schema: type: string - in: path - name: sinksId + name: exclusionsId required: true schema: type: string - - in: query - name: uniqueWriterIdentity - schema: - type: boolean - - in: query - name: customWriterIdentity - schema: - type: string - in: query name: updateMask schema: type: string format: google-fieldmask - patch: - description: >- - Updates a sink. This method replaces the values of the destination and - filter fields of the existing sink with the corresponding values from - the new sink.The updated sink might also have a new writer_identity; see - the unique_writer_identity field. - operationId: logging.projects.sinks.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LogSink' + delete: + description: Deletes an exclusion in the _Default sink. + operationId: logging.projects.exclusions.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -8671,7 +8932,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/Empty' parameters: - in: path name: projectsId @@ -8679,23 +8940,244 @@ paths: schema: type: string - in: path - name: sinksId + name: exclusionsId required: true schema: type: string - - in: query - name: uniqueWriterIdentity - schema: - type: boolean - - in: query - name: customWriterIdentity - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + /v2/projects/{projectsId}/sinks: + parameters: *ref_1 + get: + description: Lists sinks. + operationId: logging.projects.sinks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListSinksResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + post: + description: >- + Creates a sink that exports specified log entries to a destination. The + export begins upon ingress, unless the sink's writer_identity is not + permitted to write to the destination. A sink can export log entries + only from the resource owning the sink. + operationId: logging.projects.sinks.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: uniqueWriterIdentity + schema: + type: boolean + - in: query + name: customWriterIdentity + schema: + type: string + /v2/projects/{projectsId}/sinks/{sinksId}: + parameters: *ref_1 + get: + description: Gets a sink. + operationId: logging.projects.sinks.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: sinksId + required: true + schema: + type: string + put: + description: >- + Updates a sink. This method replaces the values of the destination and + filter fields of the existing sink with the corresponding values from + the new sink.The updated sink might also have a new writer_identity; see + the unique_writer_identity field. + operationId: logging.projects.sinks.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: sinksId + required: true + schema: + type: string + - in: query + name: uniqueWriterIdentity + schema: + type: boolean + - in: query + name: customWriterIdentity + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + patch: + description: >- + Updates a sink. This method replaces the values of the destination and + filter fields of the existing sink with the corresponding values from + the new sink.The updated sink might also have a new writer_identity; see + the unique_writer_identity field. + operationId: logging.projects.sinks.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: sinksId + required: true + schema: + type: string + - in: query + name: uniqueWriterIdentity + schema: + type: boolean + - in: query + name: customWriterIdentity + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: description: >- Deletes a sink. If the sink has a unique writer_identity, then that @@ -8729,7 +9211,7 @@ paths: schema: type: string /v2/projects/{projectsId}/logs/{logsId}: - parameters: *ref_115 + parameters: *ref_1 delete: description: >- Deletes all the log entries in a log for the _Default Log Bucket. The @@ -8766,7 +9248,7 @@ paths: schema: type: string /v2/projects/{projectsId}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -8816,7 +9298,7 @@ paths: schema: type: string /v2/projects/{projectsId}/metrics: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists logs-based metrics. operationId: logging.projects.metrics.list @@ -8894,7 +9376,7 @@ paths: schema: type: string /v2/projects/{projectsId}/metrics/{metricsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a logs-based metric. operationId: logging.projects.metrics.get @@ -9007,7 +9489,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/cmekSettings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the Logging CMEK settings for the given resource.Note: CMEK for the @@ -9094,7 +9576,7 @@ paths: type: string format: google-fieldmask /v2/organizations/{organizationsId}/settings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the settings for the given resource.Note: Settings can be retrieved @@ -9181,7 +9663,7 @@ paths: type: string format: google-fieldmask /v2/organizations/{organizationsId}/locations: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: logging.organizations.locations.list @@ -9229,7 +9711,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets information about a location. operationId: logging.organizations.locations.get @@ -9269,7 +9751,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/operations: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -9324,7 +9806,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -9372,7 +9854,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -9423,7 +9905,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists log buckets. operationId: logging.organizations.locations.buckets.list @@ -9513,7 +9995,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a log bucket. operationId: logging.organizations.locations.buckets.get @@ -9644,7 +10126,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets:createAsync: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Creates a log bucket asynchronously that can be used to store log @@ -9688,7 +10170,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}:updateAsync: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Updates a log bucket asynchronously.If the bucket has a lifecycle_state @@ -9738,7 +10220,7 @@ paths: type: string format: google-fieldmask /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}:undelete: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Undeletes a log bucket. A bucket that has been deleted can be undeleted @@ -9782,7 +10264,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -9832,7 +10314,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -9889,7 +10371,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -9949,7 +10431,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists views on a log bucket. operationId: logging.organizations.locations.buckets.views.list @@ -10049,7 +10531,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a view on a log bucket. operationId: logging.organizations.locations.buckets.views.get @@ -10197,7 +10679,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -10262,7 +10744,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/links: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists links. operationId: logging.organizations.locations.buckets.links.list @@ -10363,7 +10845,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/locations/{locationsId}/buckets/{bucketsId}/links/{linksId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a link. operationId: logging.organizations.locations.buckets.links.get @@ -10454,11 +10936,11 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries: - parameters: *ref_115 + /v2/organizations/{organizationsId}/locations/{locationsId}/logScopes: + parameters: *ref_1 get: - description: Lists the SavedQueries that were created by the user making the request. - operationId: logging.organizations.locations.savedQueries.list + description: Lists log scopes. + operationId: logging.organizations.locations.logScopes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10482,7 +10964,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListSavedQueriesResponse' + $ref: '#/components/schemas/ListLogScopesResponse' parameters: - in: path name: organizationsId @@ -10504,13 +10986,13 @@ paths: type: integer format: int32 post: - description: Creates a new SavedQuery for the user making the request. - operationId: logging.organizations.locations.savedQueries.create + description: Creates a log scope. + operationId: logging.organizations.locations.logScopes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SavedQuery' + $ref: '#/components/schemas/LogScope' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10526,7 +11008,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SavedQuery' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: organizationsId @@ -10539,32 +11021,38 @@ paths: schema: type: string - in: query - name: savedQueryId + name: logScopeId schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries/{savedQueriesId}: - parameters: *ref_115 - delete: - description: >- - Deletes an existing SavedQuery that was created by the user making the - request. - operationId: logging.organizations.locations.savedQueries.delete + /v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}: + parameters: *ref_1 + get: + description: Gets a log scope. + operationId: logging.organizations.locations.logScopes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2: - https://www.googleapis.com/auth/logging.admin Oauth2c: - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: organizationsId @@ -10577,41 +11065,34 @@ paths: schema: type: string - in: path - name: savedQueriesId + name: logScopesId required: true schema: type: string - /v2/organizations/{organizationsId}/locations/{locationsId}/recentQueries: - parameters: *ref_115 - get: - description: >- - Lists the RecentQueries that were created by the user making the - request. - operationId: logging.organizations.locations.recentQueries.list + patch: + description: Updates a log scope. + operationId: logging.organizations.locations.logScopes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogScope' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2: - https://www.googleapis.com/auth/logging.admin Oauth2c: - https://www.googleapis.com/auth/logging.admin - - Oauth2: - - https://www.googleapis.com/auth/logging.read - Oauth2c: - - https://www.googleapis.com/auth/logging.read responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ListRecentQueriesResponse' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: organizationsId @@ -10623,20 +11104,56 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: logScopesId + required: true schema: type: string - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/exclusions: - parameters: *ref_115 + type: string + format: google-fieldmask + delete: + description: Deletes a log scope. + operationId: logging.organizations.locations.logScopes.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: logScopesId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries: + parameters: *ref_1 get: - description: Lists all the exclusions on the _Default sink in a parent resource. - operationId: logging.organizations.exclusions.list + description: Lists the SavedQueries that were created by the user making the request. + operationId: logging.organizations.locations.savedQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10660,13 +11177,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListExclusionsResponse' + $ref: '#/components/schemas/ListSavedQueriesResponse' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query name: pageToken schema: @@ -10676,17 +11198,18 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string post: - description: >- - Creates a new exclusion in the _Default sink in a specified parent - resource. Only log entries belonging to that resource can be excluded. - You can have up to 10 exclusions in a resource. - operationId: logging.organizations.exclusions.create + description: Creates a new SavedQuery for the user making the request. + operationId: logging.organizations.locations.savedQueries.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10702,18 +11225,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: organizationsId required: true schema: type: string - /v2/organizations/{organizationsId}/exclusions/{exclusionsId}: - parameters: *ref_115 + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: savedQueryId + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/savedQueries/{savedQueriesId}: + parameters: *ref_1 get: - description: Gets the description of an exclusion in the _Default sink. - operationId: logging.organizations.exclusions.get + description: Returns all data associated with the requested query. + operationId: logging.organizations.locations.savedQueries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10737,7 +11269,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: organizationsId @@ -10745,20 +11277,23 @@ paths: schema: type: string - in: path - name: exclusionsId + name: locationsId + required: true + schema: + type: string + - in: path + name: savedQueriesId required: true schema: type: string patch: - description: >- - Changes one or more properties of an existing exclusion in the _Default - sink. - operationId: logging.organizations.exclusions.patch + description: Updates an existing SavedQuery. + operationId: logging.organizations.locations.savedQueries.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10774,7 +11309,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogExclusion' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: organizationsId @@ -10782,7 +11317,12 @@ paths: schema: type: string - in: path - name: exclusionsId + name: locationsId + required: true + schema: + type: string + - in: path + name: savedQueriesId required: true schema: type: string @@ -10792,8 +11332,10 @@ paths: type: string format: google-fieldmask delete: - description: Deletes an exclusion in the _Default sink. - operationId: logging.organizations.exclusions.delete + description: >- + Deletes an existing SavedQuery that was created by the user making the + request. + operationId: logging.organizations.locations.savedQueries.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10817,15 +11359,22 @@ paths: schema: type: string - in: path - name: exclusionsId + name: locationsId required: true schema: type: string - /v2/organizations/{organizationsId}/sinks: - parameters: *ref_115 + - in: path + name: savedQueriesId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/locations/{locationsId}/recentQueries: + parameters: *ref_1 get: - description: Lists sinks. - operationId: logging.organizations.sinks.list + description: >- + Lists the RecentQueries that were created by the user making the + request. + operationId: logging.organizations.locations.recentQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10849,13 +11398,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListSinksResponse' + $ref: '#/components/schemas/ListRecentQueriesResponse' parameters: - in: path name: organizationsId required: true schema: type: string + - in: path + name: locationsId + required: true + schema: + type: string - in: query name: pageToken schema: @@ -10869,18 +11423,61 @@ paths: name: filter schema: type: string + /v2/organizations/{organizationsId}/exclusions: + parameters: *ref_1 + get: + description: Lists all the exclusions on the _Default sink in a parent resource. + operationId: logging.organizations.exclusions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListExclusionsResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- - Creates a sink that exports specified log entries to a destination. The - export begins upon ingress, unless the sink's writer_identity is not - permitted to write to the destination. A sink can export log entries - only from the resource owning the sink. - operationId: logging.organizations.sinks.create + Creates a new exclusion in the _Default sink in a specified parent + resource. Only log entries belonging to that resource can be excluded. + You can have up to 10 exclusions in a resource. + operationId: logging.organizations.exclusions.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10896,26 +11493,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' parameters: - in: path name: organizationsId required: true schema: type: string - - in: query - name: uniqueWriterIdentity - schema: - type: boolean - - in: query - name: customWriterIdentity - schema: - type: string - /v2/organizations/{organizationsId}/sinks/{sinksId}: - parameters: *ref_115 + /v2/organizations/{organizationsId}/exclusions/{exclusionsId}: + parameters: *ref_1 get: - description: Gets a sink. - operationId: logging.organizations.sinks.get + description: Gets the description of an exclusion in the _Default sink. + operationId: logging.organizations.exclusions.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10939,7 +11528,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' parameters: - in: path name: organizationsId @@ -10947,22 +11536,20 @@ paths: schema: type: string - in: path - name: sinksId + name: exclusionsId required: true schema: type: string - put: + patch: description: >- - Updates a sink. This method replaces the values of the destination and - filter fields of the existing sink with the corresponding values from - the new sink.The updated sink might also have a new writer_identity; see - the unique_writer_identity field. - operationId: logging.organizations.sinks.update + Changes one or more properties of an existing exclusion in the _Default + sink. + operationId: logging.organizations.exclusions.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -10978,7 +11565,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogSink' + $ref: '#/components/schemas/LogExclusion' parameters: - in: path name: organizationsId @@ -10986,24 +11573,228 @@ paths: schema: type: string - in: path - name: sinksId + name: exclusionsId required: true schema: type: string - - in: query - name: uniqueWriterIdentity - schema: - type: boolean - - in: query - name: customWriterIdentity - schema: - type: string - in: query name: updateMask schema: type: string format: google-fieldmask - patch: + delete: + description: Deletes an exclusion in the _Default sink. + operationId: logging.organizations.exclusions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: exclusionsId + required: true + schema: + type: string + /v2/organizations/{organizationsId}/sinks: + parameters: *ref_1 + get: + description: Lists sinks. + operationId: logging.organizations.sinks.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListSinksResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + post: + description: >- + Creates a sink that exports specified log entries to a destination. The + export begins upon ingress, unless the sink's writer_identity is not + permitted to write to the destination. A sink can export log entries + only from the resource owning the sink. + operationId: logging.organizations.sinks.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: uniqueWriterIdentity + schema: + type: boolean + - in: query + name: customWriterIdentity + schema: + type: string + /v2/organizations/{organizationsId}/sinks/{sinksId}: + parameters: *ref_1 + get: + description: Gets a sink. + operationId: logging.organizations.sinks.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: sinksId + required: true + schema: + type: string + put: + description: >- + Updates a sink. This method replaces the values of the destination and + filter fields of the existing sink with the corresponding values from + the new sink.The updated sink might also have a new writer_identity; see + the unique_writer_identity field. + operationId: logging.organizations.sinks.update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LogSink' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: sinksId + required: true + schema: + type: string + - in: query + name: uniqueWriterIdentity + schema: + type: boolean + - in: query + name: customWriterIdentity + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + patch: description: >- Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from @@ -11088,7 +11879,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/logs/{logsId}: - parameters: *ref_115 + parameters: *ref_1 delete: description: >- Deletes all the log entries in a log for the _Default Log Bucket. The @@ -11125,7 +11916,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -11175,7 +11966,7 @@ paths: schema: type: string /v2/folders/{foldersId}/cmekSettings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the Logging CMEK settings for the given resource.Note: CMEK for the @@ -11217,7 +12008,7 @@ paths: schema: type: string /v2/folders/{foldersId}/settings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the settings for the given resource.Note: Settings can be retrieved @@ -11304,7 +12095,7 @@ paths: type: string format: google-fieldmask /v2/folders/{foldersId}/locations: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: logging.folders.locations.list @@ -11352,7 +12143,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets information about a location. operationId: logging.folders.locations.get @@ -11392,7 +12183,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}/operations: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -11447,7 +12238,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -11495,7 +12286,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -11546,7 +12337,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}/buckets: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists log buckets. operationId: logging.folders.locations.buckets.list @@ -11636,7 +12427,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a log bucket. operationId: logging.folders.locations.buckets.get @@ -11767,7 +12558,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}/buckets:createAsync: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Creates a log bucket asynchronously that can be used to store log @@ -11794,7 +12585,312 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: bucketId + schema: + type: string + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}:updateAsync: + parameters: *ref_1 + post: + description: >- + Updates a log bucket asynchronously.If the bucket has a lifecycle_state + of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a + bucket has been created, the bucket's location cannot be changed. + operationId: logging.folders.locations.buckets.updateAsync + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogBucket' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: bucketsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}:undelete: + parameters: *ref_1 + post: + description: >- + Undeletes a log bucket. A bucket that has been deleted can be undeleted + within the grace period of 7 days. + operationId: logging.folders.locations.buckets.undelete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteBucketRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: bucketsId + required: true + schema: + type: string + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and + PERMISSION_DENIED errors. + operationId: logging.folders.locations.buckets.views.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: bucketsId + required: true + schema: + type: string + - in: path + name: viewsId + required: true + schema: + type: string + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: logging.folders.locations.buckets.views.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: bucketsId + required: true + schema: + type: string + - in: path + name: viewsId + required: true + schema: + type: string + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: logging.folders.locations.buckets.views.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: bucketsId + required: true + schema: + type: string + - in: path + name: viewsId + required: true + schema: + type: string + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views: + parameters: *ref_1 + get: + description: Lists views on a log bucket. + operationId: logging.folders.locations.buckets.views.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListViewsResponse' parameters: - in: path name: foldersId @@ -11806,23 +12902,30 @@ paths: required: true schema: type: string + - in: path + name: bucketsId + required: true + schema: + type: string - in: query - name: bucketId + name: pageToken schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}:updateAsync: - parameters: *ref_115 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: >- - Updates a log bucket asynchronously.If the bucket has a lifecycle_state - of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a - bucket has been created, the bucket's location cannot be changed. - operationId: logging.folders.locations.buckets.updateAsync + Creates a view over log entries in a log bucket. A bucket may contain a + maximum of 30 views. + operationId: logging.folders.locations.buckets.views.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogBucket' + $ref: '#/components/schemas/LogView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11838,7 +12941,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/LogView' parameters: - in: path name: foldersId @@ -11856,38 +12959,38 @@ paths: schema: type: string - in: query - name: updateMask + name: viewId schema: type: string - format: google-fieldmask - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}:undelete: - parameters: *ref_115 - post: - description: >- - Undeletes a log bucket. A bucket that has been deleted can be undeleted - within the grace period of 7 days. - operationId: logging.folders.locations.buckets.undelete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UndeleteBucketRequest' + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}: + parameters: *ref_1 + get: + description: Gets a view on a log bucket. + operationId: logging.folders.locations.buckets.views.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2: - https://www.googleapis.com/auth/logging.admin Oauth2c: - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/LogView' parameters: - in: path name: foldersId @@ -11904,19 +13007,24 @@ paths: required: true schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:setIamPolicy: - parameters: *ref_115 - post: + - in: path + name: viewsId + required: true + schema: + type: string + patch: description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and - PERMISSION_DENIED errors. - operationId: logging.folders.locations.buckets.views.setIamPolicy + Updates a view on a log bucket. This method replaces the value of the + filter field from the existing view with the corresponding value from + the new view. If an UNAVAILABLE error is returned, this indicates that + system is not in a state where it can update the view. If this occurs, + please try again in a few minutes. + operationId: logging.folders.locations.buckets.views.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/LogView' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -11932,7 +13040,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/LogView' parameters: - in: path name: foldersId @@ -11954,42 +13062,33 @@ paths: required: true schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:getIamPolicy: - parameters: *ref_115 - post: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: logging.folders.locations.buckets.views.getIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GetIamPolicyRequest' + Deletes a view on a log bucket. If an UNAVAILABLE error is returned, + this indicates that system is not in a state where it can delete the + view. If this occurs, please try again in a few minutes. + operationId: logging.folders.locations.buckets.views.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2: - https://www.googleapis.com/auth/logging.admin Oauth2c: - https://www.googleapis.com/auth/logging.admin - - Oauth2: - - https://www.googleapis.com/auth/logging.read - Oauth2c: - - https://www.googleapis.com/auth/logging.read responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Empty' parameters: - in: path name: foldersId @@ -12011,21 +13110,13 @@ paths: required: true schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}:testIamPermissions: - parameters: *ref_115 - post: + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs: + parameters: *ref_1 + get: description: >- - 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. - operationId: logging.folders.locations.buckets.views.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + Lists the logs in projects, organizations, folders, or billing accounts. + Only logs that have entries are listed. + operationId: logging.folders.locations.buckets.views.logs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12049,7 +13140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' + $ref: '#/components/schemas/ListLogsResponse' parameters: - in: path name: foldersId @@ -12071,11 +13162,24 @@ paths: required: true schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views: - parameters: *ref_115 + - in: query + name: resourceNames + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/links: + parameters: *ref_1 get: - description: Lists views on a log bucket. - operationId: logging.folders.locations.buckets.views.list + description: Lists links. + operationId: logging.folders.locations.buckets.links.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12099,7 +13203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListViewsResponse' + $ref: '#/components/schemas/ListLinksResponse' parameters: - in: path name: foldersId @@ -12127,14 +13231,15 @@ paths: format: int32 post: description: >- - Creates a view over log entries in a log bucket. A bucket may contain a - maximum of 30 views. - operationId: logging.folders.locations.buckets.views.create + Asynchronously creates a linked dataset in BigQuery which makes it + possible to use BigQuery to read the logs stored in the log bucket. A + log bucket may currently only contain one link. + operationId: logging.folders.locations.buckets.links.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogView' + $ref: '#/components/schemas/Link' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12150,7 +13255,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogView' + $ref: '#/components/schemas/Operation' parameters: - in: path name: foldersId @@ -12168,14 +13273,14 @@ paths: schema: type: string - in: query - name: viewId + name: linkId schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}: - parameters: *ref_115 + /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/links/{linksId}: + parameters: *ref_1 get: - description: Gets a view on a log bucket. - operationId: logging.folders.locations.buckets.views.get + description: Gets a link. + operationId: logging.folders.locations.buckets.links.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12199,7 +13304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogView' + $ref: '#/components/schemas/Link' parameters: - in: path name: foldersId @@ -12217,23 +13322,15 @@ paths: schema: type: string - in: path - name: viewsId + name: linksId required: true schema: type: string - patch: + delete: description: >- - Updates a view on a log bucket. This method replaces the value of the - filter field from the existing view with the corresponding value from - the new view. If an UNAVAILABLE error is returned, this indicates that - system is not in a state where it can update the view. If this occurs, - please try again in a few minutes. - operationId: logging.folders.locations.buckets.views.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LogView' + Deletes a link. This will also delete the corresponding BigQuery linked + dataset. + operationId: logging.folders.locations.buckets.links.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12249,7 +13346,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogView' + $ref: '#/components/schemas/Operation' parameters: - in: path name: foldersId @@ -12267,21 +13364,67 @@ paths: schema: type: string - in: path - name: viewsId + name: linksId + required: true + schema: + type: string + /v2/folders/{foldersId}/locations/{locationsId}/logScopes: + parameters: *ref_1 + get: + description: Lists log scopes. + operationId: logging.folders.locations.logScopes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListLogScopesResponse' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId required: true schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - delete: - description: >- - Deletes a view on a log bucket. If an UNAVAILABLE error is returned, - this indicates that system is not in a state where it can delete the - view. If this occurs, please try again in a few minutes. - operationId: logging.folders.locations.buckets.views.delete + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a log scope. + operationId: logging.folders.locations.logScopes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogScope' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12297,7 +13440,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: foldersId @@ -12309,23 +13452,15 @@ paths: required: true schema: type: string - - in: path - name: bucketsId - required: true - schema: - type: string - - in: path - name: viewsId - required: true + - in: query + name: logScopeId schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs: - parameters: *ref_115 + /v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}: + parameters: *ref_1 get: - description: >- - Lists the logs in projects, organizations, folders, or billing accounts. - Only logs that have entries are listed. - operationId: logging.folders.locations.buckets.views.logs.list + description: Gets a log scope. + operationId: logging.folders.locations.logScopes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12349,7 +13484,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListLogsResponse' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: foldersId @@ -12362,57 +13497,34 @@ paths: schema: type: string - in: path - name: bucketsId - required: true - schema: - type: string - - in: path - name: viewsId + name: logScopesId required: true schema: type: string - - in: query - name: resourceNames - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/links: - parameters: *ref_115 - get: - description: Lists links. - operationId: logging.folders.locations.buckets.links.list + patch: + description: Updates a log scope. + operationId: logging.folders.locations.logScopes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogScope' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2: - https://www.googleapis.com/auth/logging.admin Oauth2c: - https://www.googleapis.com/auth/logging.admin - - Oauth2: - - https://www.googleapis.com/auth/logging.read - Oauth2c: - - https://www.googleapis.com/auth/logging.read responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/ListLinksResponse' + $ref: '#/components/schemas/LogScope' parameters: - in: path name: foldersId @@ -12425,30 +13537,18 @@ paths: schema: type: string - in: path - name: bucketsId + name: logScopesId required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: >- - Asynchronously creates a linked dataset in BigQuery which makes it - possible to use BigQuery to read the logs stored in the log bucket. A - log bucket may currently only contain one link. - operationId: logging.folders.locations.buckets.links.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Link' + format: google-fieldmask + delete: + description: Deletes a log scope. + operationId: logging.folders.locations.logScopes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12464,7 +13564,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: foldersId @@ -12477,19 +13577,15 @@ paths: schema: type: string - in: path - name: bucketsId + name: logScopesId required: true schema: type: string - - in: query - name: linkId - schema: - type: string - /v2/folders/{foldersId}/locations/{locationsId}/buckets/{bucketsId}/links/{linksId}: - parameters: *ref_115 + /v2/folders/{foldersId}/locations/{locationsId}/savedQueries: + parameters: *ref_1 get: - description: Gets a link. - operationId: logging.folders.locations.buckets.links.get + description: Lists the SavedQueries that were created by the user making the request. + operationId: logging.folders.locations.savedQueries.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12513,7 +13609,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Link' + $ref: '#/components/schemas/ListSavedQueriesResponse' parameters: - in: path name: foldersId @@ -12525,21 +13621,27 @@ paths: required: true schema: type: string - - in: path - name: bucketsId - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: linksId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - delete: - description: >- - Deletes a link. This will also delete the corresponding BigQuery linked - dataset. - operationId: logging.folders.locations.buckets.links.delete + post: + description: Creates a new SavedQuery for the user making the request. + operationId: logging.folders.locations.savedQueries.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SavedQuery' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12555,7 +13657,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: foldersId @@ -12567,21 +13669,15 @@ paths: required: true schema: type: string - - in: path - name: bucketsId - required: true - schema: - type: string - - in: path - name: linksId - required: true + - in: query + name: savedQueryId schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/savedQueries: - parameters: *ref_115 + /v2/folders/{foldersId}/locations/{locationsId}/savedQueries/{savedQueriesId}: + parameters: *ref_1 get: - description: Lists the SavedQueries that were created by the user making the request. - operationId: logging.folders.locations.savedQueries.list + description: Returns all data associated with the requested query. + operationId: logging.folders.locations.savedQueries.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -12605,7 +13701,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListSavedQueriesResponse' + $ref: '#/components/schemas/SavedQuery' parameters: - in: path name: foldersId @@ -12617,18 +13713,14 @@ paths: required: true schema: type: string - - in: query - name: pageToken + - in: path + name: savedQueriesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a new SavedQuery for the user making the request. - operationId: logging.folders.locations.savedQueries.create + patch: + description: Updates an existing SavedQuery. + operationId: logging.folders.locations.savedQueries.patch requestBody: content: application/json: @@ -12661,12 +13753,16 @@ paths: required: true schema: type: string + - in: path + name: savedQueriesId + required: true + schema: + type: string - in: query - name: savedQueryId + name: updateMask schema: type: string - /v2/folders/{foldersId}/locations/{locationsId}/savedQueries/{savedQueriesId}: - parameters: *ref_115 + format: google-fieldmask delete: description: >- Deletes an existing SavedQuery that was created by the user making the @@ -12705,7 +13801,7 @@ paths: schema: type: string /v2/folders/{foldersId}/locations/{locationsId}/recentQueries: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the RecentQueries that were created by the user making the @@ -12755,8 +13851,12 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string /v2/folders/{foldersId}/exclusions: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists all the exclusions on the _Default sink in a parent resource. operationId: logging.folders.exclusions.list @@ -12833,7 +13933,7 @@ paths: schema: type: string /v2/folders/{foldersId}/exclusions/{exclusionsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets the description of an exclusion in the _Default sink. operationId: logging.folders.exclusions.get @@ -12945,7 +14045,7 @@ paths: schema: type: string /v2/folders/{foldersId}/sinks: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists sinks. operationId: logging.folders.sinks.list @@ -13035,7 +14135,7 @@ paths: schema: type: string /v2/folders/{foldersId}/sinks/{sinksId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a sink. operationId: logging.folders.sinks.get @@ -13211,7 +14311,7 @@ paths: schema: type: string /v2/folders/{foldersId}/logs/{logsId}: - parameters: *ref_115 + parameters: *ref_1 delete: description: >- Deletes all the log entries in a log for the _Default Log Bucket. The @@ -13248,7 +14348,7 @@ paths: schema: type: string /v2/folders/{foldersId}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -13298,7 +14398,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/cmekSettings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the Logging CMEK settings for the given resource.Note: CMEK for the @@ -13340,7 +14440,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/settings: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the settings for the given resource.Note: Settings can be retrieved @@ -13380,7 +14480,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: logging.billingAccounts.locations.list @@ -13428,7 +14528,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets information about a location. operationId: logging.billingAccounts.locations.get @@ -13468,7 +14568,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/operations: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -13523,7 +14623,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -13571,7 +14671,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -13622,7 +14722,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists log buckets. operationId: logging.billingAccounts.locations.buckets.list @@ -13712,7 +14812,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a log bucket. operationId: logging.billingAccounts.locations.buckets.get @@ -13843,7 +14943,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets:createAsync: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Creates a log bucket asynchronously that can be used to store log @@ -13887,7 +14987,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}:updateAsync: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Updates a log bucket asynchronously.If the bucket has a lifecycle_state @@ -13937,7 +15037,7 @@ paths: type: string format: google-fieldmask /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}:undelete: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Undeletes a log bucket. A bucket that has been deleted can be undeleted @@ -13981,7 +15081,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists views on a log bucket. operationId: logging.billingAccounts.locations.buckets.views.list @@ -14081,7 +15181,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a view on a log bucket. operationId: logging.billingAccounts.locations.buckets.views.get @@ -14229,7 +15329,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/views/{viewsId}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -14294,7 +15394,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/links: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists links. operationId: logging.billingAccounts.locations.buckets.links.list @@ -14395,7 +15495,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/buckets/{bucketsId}/links/{linksId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a link. operationId: logging.billingAccounts.locations.buckets.links.get @@ -14487,7 +15587,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists the SavedQueries that were created by the user making the request. operationId: logging.billingAccounts.locations.savedQueries.list @@ -14535,6 +15635,10 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string post: description: Creates a new SavedQuery for the user making the request. operationId: logging.billingAccounts.locations.savedQueries.create @@ -14575,7 +15679,95 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/savedQueries/{savedQueriesId}: - parameters: *ref_115 + parameters: *ref_1 + get: + description: Returns all data associated with the requested query. + operationId: logging.billingAccounts.locations.savedQueries.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + - Oauth2: + - https://www.googleapis.com/auth/logging.read + Oauth2c: + - https://www.googleapis.com/auth/logging.read + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SavedQuery' + parameters: + - in: path + name: billingAccountsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: savedQueriesId + required: true + schema: + type: string + patch: + description: Updates an existing SavedQuery. + operationId: logging.billingAccounts.locations.savedQueries.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SavedQuery' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/logging.admin + Oauth2c: + - https://www.googleapis.com/auth/logging.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SavedQuery' + parameters: + - in: path + name: billingAccountsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: savedQueriesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask delete: description: >- Deletes an existing SavedQuery that was created by the user making the @@ -14614,7 +15806,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/locations/{locationsId}/recentQueries: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the RecentQueries that were created by the user making the @@ -14664,8 +15856,12 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string /v2/billingAccounts/{billingAccountsId}/exclusions: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists all the exclusions on the _Default sink in a parent resource. operationId: logging.billingAccounts.exclusions.list @@ -14742,7 +15938,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets the description of an exclusion in the _Default sink. operationId: logging.billingAccounts.exclusions.get @@ -14854,7 +16050,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/sinks: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists sinks. operationId: logging.billingAccounts.sinks.list @@ -14944,7 +16140,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}: - parameters: *ref_115 + parameters: *ref_1 get: description: Gets a sink. operationId: logging.billingAccounts.sinks.get @@ -15120,7 +16316,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/logs/{logsId}: - parameters: *ref_115 + parameters: *ref_1 delete: description: >- Deletes all the log entries in a log for the _Default Log Bucket. The @@ -15157,7 +16353,7 @@ paths: schema: type: string /v2/billingAccounts/{billingAccountsId}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -15207,7 +16403,7 @@ paths: schema: type: string /v2/entries:copy: - parameters: *ref_115 + parameters: *ref_1 post: description: Copies a set of log entries from a log bucket to a Cloud Storage bucket. operationId: logging.entries.copy @@ -15234,7 +16430,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: [] /v2/entries:write: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Writes log entries to Logging. This API method is the only way to send @@ -15272,7 +16468,7 @@ paths: $ref: '#/components/schemas/WriteLogEntriesResponse' parameters: [] /v2/entries:list: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Lists log entries. Use this method to retrieve log entries that @@ -15311,7 +16507,7 @@ paths: $ref: '#/components/schemas/ListLogEntriesResponse' parameters: [] /v2/entries:tail: - parameters: *ref_115 + parameters: *ref_1 post: description: >- Streaming read of log entries as they are received. Until the stream is @@ -15348,7 +16544,7 @@ paths: $ref: '#/components/schemas/TailLogEntriesResponse' parameters: [] /v2/{logName}: - parameters: *ref_115 + parameters: *ref_1 delete: description: >- Deletes all the log entries in a log for the _Default Log Bucket. The @@ -15380,7 +16576,7 @@ paths: schema: type: string /v2/{parentType}/{parent}/logs: - parameters: *ref_115 + parameters: *ref_1 get: description: >- Lists the logs in projects, organizations, folders, or billing accounts. @@ -15435,7 +16631,7 @@ paths: schema: type: string /v2/monitoredResourceDescriptors: - parameters: *ref_115 + parameters: *ref_1 get: description: Lists the descriptors for monitored resource types used by Logging. operationId: logging.monitoredResourceDescriptors.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/looker.yaml b/providers/src/googleapis.com/v00.00.00000/services/looker.yaml index 3c5b23e1..2167ca97 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/looker.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/looker.yaml @@ -7,8 +7,8 @@ info: title: Looker (Google Cloud core) API description: '' version: v1 - x-discovery-doc-revision: '20240516' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240821' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/looker/docs/reference/rest/ servers: @@ -170,7 +170,7 @@ components: type: string Instance: id: Instance - description: A Looker instance. LINT.IfChange + description: A Looker instance. type: object properties: name: @@ -260,6 +260,15 @@ components: Looker Instance UI. readOnly: true type: string + pscEnabled: + description: >- + Optional. Whether to use Private Service Connect (PSC) for private + IP connectivity. If true, neither `public_ip_enabled` nor + `private_ip_enabled` can be true. + type: boolean + pscConfig: + description: Optional. PSC configuration. Used when `psc_enabled` is true. + $ref: '#/components/schemas/PscConfig' consumerNetwork: description: >- Network name in the consumer project. Format: @@ -308,6 +317,70 @@ components: description: Optional. Linked Google Cloud Project Number for Looker Studio Pro. type: string format: int64 + PscConfig: + id: PscConfig + description: >- + Information for Private Service Connect (PSC) setup for a Looker + instance. + type: object + properties: + allowedVpcs: + description: >- + Optional. List of VPCs that are allowed ingress into looker. Format: + projects/{project}/global/networks/{network} + type: array + items: + type: string + serviceAttachments: + description: Optional. List of egress service attachment configurations. + type: array + items: + $ref: '#/components/schemas/ServiceAttachment' + lookerServiceAttachmentUri: + description: Output only. URI of the Looker service attachment. + readOnly: true + type: string + ServiceAttachment: + id: ServiceAttachment + description: Service attachment configuration. + type: object + properties: + localFqdn: + description: >- + Required. Fully qualified domain name that will be used in the + private DNS record created for the service attachment. + type: string + targetServiceAttachmentUri: + description: >- + Required. URI of the service attachment to connect to. Format: + projects/{project}/regions/{region}/serviceAttachments/{service_attachment} + type: string + connectionStatus: + description: Output only. Connection status. + readOnly: true + type: string + enumDescriptions: + - Connection status is unspecified. + - Connection is established and functioning normally. + - >- + Connection is not established (Looker tenant project hasn't been + allowlisted). + - >- + Connection is not established (Looker tenant project is explicitly + in reject list). + - >- + Issue with target service attachment, e.g. NAT subnet is + exhausted. + - >- + Target service attachment does not exist. This status is a + terminal state. + enum: + - UNKNOWN + - ACCEPTED + - PENDING + - REJECTED + - NEEDS_ATTENTION + - CLOSED MaintenanceWindow: id: MaintenanceWindow description: Specifies the recurring maintenance window. @@ -1128,16 +1201,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1150,23 +1220,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.looker.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1194,6 +1262,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: @@ -1201,17 +1270,14 @@ components: name: instances title: Instances methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1269,6 +1335,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_iam_policies: @@ -1283,17 +1350,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -1307,6 +1371,9 @@ components: #/components/x-stackQL-resources/instances_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/set_iam_policy delete: [] backups_iam_policies: id: google.looker.backups_iam_policies @@ -1320,17 +1387,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_9 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1backups~1{backupsId}:getIamPolicy/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_9 - response: *ref_10 test_iam_permissions: operation: $ref: >- @@ -1344,10 +1408,13 @@ components: #/components/x-stackQL-resources/backups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backups_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_11 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1394,7 +1461,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets information about a location. operationId: looker.projects.locations.get @@ -1422,7 +1489,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1465,7 +1532,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1536,7 +1603,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1583,7 +1650,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_11 + parameters: *ref_1 get: description: Lists Instances in a given project and location. operationId: looker.projects.locations.instances.list @@ -1655,7 +1722,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_11 + parameters: *ref_1 get: description: Gets details of a single Instance. operationId: looker.projects.locations.instances.get @@ -1764,7 +1831,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restart: - parameters: *ref_11 + parameters: *ref_1 post: description: Restart instance. operationId: looker.projects.locations.instances.restart @@ -1802,7 +1869,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import: - parameters: *ref_11 + parameters: *ref_1 post: description: Import instance. operationId: looker.projects.locations.instances.import @@ -1840,7 +1907,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export: - parameters: *ref_11 + parameters: *ref_1 post: description: Export instance. operationId: looker.projects.locations.instances.export @@ -1878,7 +1945,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -1919,7 +1986,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -1959,7 +2026,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2002,7 +2069,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2048,7 +2115,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}:getIamPolicy: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2093,7 +2160,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/backups/{backupsId}:testIamPermissions: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml b/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml index 05b04152..3495f3fe 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/managedidentities.yaml @@ -10,8 +10,8 @@ info: a highly available, hardened service running Microsoft Active Directory (AD). version: v1 - x-discovery-doc-revision: '20240112' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240530' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/managed-microsoft-ad/ servers: @@ -236,9 +236,11 @@ components: type: string locations: description: >- - Required. Locations where domain needs to be provisioned. regions - e.g. us-west1 or us-east4 Service supports up to 4 locations at - once. Each location will use a /26 block. + Required. Locations where domain needs to be provisioned. The + locations can be specified according to + https://cloud.google.com/compute/docs/regions-zones, such as + `us-west1` or `us-east4`. Each domain supports up to 4 locations, + separated by commas. Each location will use a /26 block. type: array items: type: string @@ -1053,7 +1055,11 @@ components: role: description: >- Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). type: string members: description: >- @@ -1706,7 +1712,7 @@ components: type: boolean MaintenancePolicy: id: MaintenancePolicy - description: LINT.IfChange Defines policies to service maintenance events. + description: Defines policies to service maintenance events. type: object properties: name: @@ -2056,16 +2062,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2078,23 +2081,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.managedidentities.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2122,6 +2123,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' domains: @@ -2136,17 +2138,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1domains/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.domains - list: - operation: *ref_5 - response: *ref_6 reset_admin_password: operation: $ref: >- @@ -2253,6 +2252,7 @@ components: - $ref: '#/components/x-stackQL-resources/domains/methods/create' update: - $ref: '#/components/x-stackQL-resources/domains/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/domains/methods/delete' domains_ldapssettings: @@ -2279,7 +2279,10 @@ components: - $ref: >- #/components/x-stackQL-resources/domains_ldapssettings/methods/get_ldapssettings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/domains_ldapssettings/methods/update_ldapssettings + replace: [] delete: [] domains_iam_policies: id: google.managedidentities.domains_iam_policies @@ -2293,17 +2296,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1domains~1{domainsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2317,6 +2317,9 @@ components: #/components/x-stackQL-resources/domains_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/domains_iam_policies/methods/set_iam_policy delete: [] backups: id: google.managedidentities.backups @@ -2330,17 +2333,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1domains~1{domainsId}~1backups/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backups - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -2370,6 +2370,7 @@ components: - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: - $ref: '#/components/x-stackQL-resources/backups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_iam_policies: @@ -2384,17 +2385,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1domains~1{domainsId}~1backups~1{backupsId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -2408,23 +2406,23 @@ components: #/components/x-stackQL-resources/backups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backups_iam_policies/methods/set_iam_policy delete: [] sql_integrations: id: google.managedidentities.sql_integrations name: sql_integrations title: Sql_integrations methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1domains~1{domainsId}~1sqlIntegrations/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sqlIntegrations - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -2438,6 +2436,7 @@ components: - $ref: '#/components/x-stackQL-resources/sql_integrations/methods/list' insert: [] update: [] + replace: [] delete: [] peerings: id: google.managedidentities.peerings @@ -2451,17 +2450,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1peerings/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.peerings - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -2491,6 +2487,7 @@ components: - $ref: '#/components/x-stackQL-resources/peerings/methods/create' update: - $ref: '#/components/x-stackQL-resources/peerings/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/peerings/methods/delete' peerings_iam_policies: @@ -2505,17 +2502,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_17 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1peerings~1{peeringsId}:getIamPolicy/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_17 - response: *ref_18 test_iam_permissions: operation: $ref: >- @@ -2529,10 +2523,13 @@ components: #/components/x-stackQL-resources/peerings_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/peerings_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2579,7 +2576,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets information about a location. operationId: managedidentities.projects.locations.get @@ -2607,7 +2604,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/operations: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2645,7 +2642,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/operations/{operationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2706,7 +2703,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/operations/{operationsId}:cancel: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2748,7 +2745,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a Microsoft AD domain. operationId: managedidentities.projects.locations.global.domains.create @@ -2818,7 +2815,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:resetAdminPassword: - parameters: *ref_19 + parameters: *ref_1 post: description: Resets a domain's administrator password. operationId: managedidentities.projects.locations.global.domains.resetAdminPassword @@ -2851,7 +2848,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets information about a domain. operationId: managedidentities.projects.locations.global.domains.get @@ -2941,7 +2938,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:domainJoinMachine: - parameters: *ref_19 + parameters: *ref_1 post: description: DomainJoinMachine API joins a Compute Engine VM to the domain operationId: managedidentities.projects.locations.global.domains.domainJoinMachine @@ -2974,7 +2971,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:restore: - parameters: *ref_19 + parameters: *ref_1 post: description: >- RestoreDomain restores domain backup mentioned in the @@ -3009,7 +3006,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:attachTrust: - parameters: *ref_19 + parameters: *ref_1 post: description: Adds an AD trust to a domain. operationId: managedidentities.projects.locations.global.domains.attachTrust @@ -3042,7 +3039,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:reconfigureTrust: - parameters: *ref_19 + parameters: *ref_1 post: description: Updates the DNS conditional forwarder. operationId: managedidentities.projects.locations.global.domains.reconfigureTrust @@ -3075,7 +3072,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:detachTrust: - parameters: *ref_19 + parameters: *ref_1 post: description: Removes an AD trust. operationId: managedidentities.projects.locations.global.domains.detachTrust @@ -3108,7 +3105,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:validateTrust: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Validates a trust state, that the target domain is reachable, and that @@ -3143,7 +3140,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}/ldapssettings: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets the domain ldaps settings. operationId: managedidentities.projects.locations.global.domains.getLdapssettings @@ -3207,7 +3204,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/global/domains/{domainsId}:extendSchema: - parameters: *ref_19 + parameters: *ref_1 post: description: Extend Schema for Domain operationId: managedidentities.projects.locations.global.domains.extendSchema @@ -3240,7 +3237,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:enableMigration: - parameters: *ref_19 + parameters: *ref_1 post: description: Enable Domain Migration operationId: managedidentities.projects.locations.global.domains.enableMigration @@ -3273,7 +3270,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:disableMigration: - parameters: *ref_19 + parameters: *ref_1 post: description: Disable Domain Migration operationId: managedidentities.projects.locations.global.domains.disableMigration @@ -3306,7 +3303,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:checkMigrationPermission: - parameters: *ref_19 + parameters: *ref_1 post: description: CheckMigrationPermission API gets the current state of DomainMigration operationId: >- @@ -3340,7 +3337,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3376,7 +3373,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3411,7 +3408,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/global/domains/{domainsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3449,7 +3446,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}/backups: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a Backup for a domain. operationId: managedidentities.projects.locations.global.domains.backups.create @@ -3529,7 +3526,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}/backups/{backupsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets details of a single Backup. operationId: managedidentities.projects.locations.global.domains.backups.get @@ -3634,7 +3631,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3675,7 +3672,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}/backups/{backupsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3715,7 +3712,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/global/domains/{domainsId}/backups/{backupsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3759,7 +3756,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}/sqlIntegrations: - parameters: *ref_19 + parameters: *ref_1 get: description: Lists SqlIntegrations in a given domain. operationId: managedidentities.projects.locations.global.domains.sqlIntegrations.list @@ -3804,7 +3801,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/domains/{domainsId}/sqlIntegrations/{sqlIntegrationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets details of a single sqlIntegration. operationId: managedidentities.projects.locations.global.domains.sqlIntegrations.get @@ -3837,7 +3834,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/peerings: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates a Peering for Managed AD instance. operationId: managedidentities.projects.locations.global.peerings.create @@ -3907,7 +3904,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/peerings/{peeringsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets details of a single Peering. operationId: managedidentities.projects.locations.global.peerings.get @@ -3997,7 +3994,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/peerings/{peeringsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4033,7 +4030,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/peerings/{peeringsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4068,7 +4065,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/global/peerings/{peeringsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml b/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml index 07b87d72..503102ab 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/memcache.yaml @@ -9,8 +9,8 @@ info: Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP. version: v1 - x-discovery-doc-revision: '20240502' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240711' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/memorystore/ servers: @@ -372,6 +372,14 @@ components: type: array items: type: string + satisfiesPzs: + description: Optional. Output only. Reserved for future use. + readOnly: true + type: boolean + satisfiesPzi: + description: Optional. Output only. Reserved for future use. + readOnly: true + type: boolean NodeConfig: id: NodeConfig description: Configuration for a Memcached Node. @@ -1476,16 +1484,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1498,23 +1503,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.memcache.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1542,6 +1545,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: @@ -1549,17 +1553,14 @@ components: name: instances title: Instances methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1617,6 +1618,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_parameters: @@ -1634,11 +1636,14 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/instances_parameters/methods/update_parameters + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1685,7 +1690,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets information about a location. operationId: memcache.projects.locations.get @@ -1713,7 +1718,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1756,7 +1761,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1827,7 +1832,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1874,7 +1879,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_7 + parameters: *ref_1 get: description: Lists Instances in a given location. operationId: memcache.projects.locations.instances.list @@ -1954,7 +1959,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets details of a single Instance. operationId: memcache.projects.locations.instances.get @@ -2059,7 +2064,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:updateParameters: - parameters: *ref_7 + parameters: *ref_1 patch: description: >- Updates the defined Memcached parameters for an existing instance. This @@ -2101,7 +2106,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:applyParameters: - parameters: *ref_7 + parameters: *ref_1 post: description: >- `ApplyParameters` restarts the set of specified nodes in order to update @@ -2141,7 +2146,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rescheduleMaintenance: - parameters: *ref_7 + parameters: *ref_1 post: description: Reschedules upcoming maintenance event. operationId: memcache.projects.locations.instances.rescheduleMaintenance @@ -2179,7 +2184,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Upgrades the Memcache instance to a newer memcached engine version diff --git a/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml b/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml index 1838d620..4937bea6 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/metastore.yaml @@ -9,8 +9,8 @@ info: The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services. version: v1 - x-discovery-doc-revision: '20240516' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240818' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/dataproc-metastore/docs servers: @@ -365,6 +365,8 @@ components: - >- The metastore service has encountered an error and cannot be used. The metastore service should be deleted. + - The Dataproc Metastore service 2 is being scaled up or down. + - The metastore service is processing a managed migration. enum: - STATE_UNSPECIFIED - CREATING @@ -374,6 +376,8 @@ components: - UPDATING - DELETING - ERROR + - AUTOSCALING + - MIGRATING stateMessage: description: >- Output only. Additional information about the current state of the @@ -885,6 +889,44 @@ components: increments of 1.0 for values greater than 1.0. type: number format: float + autoscalingConfig: + description: Optional. The autoscaling configuration. + $ref: '#/components/schemas/AutoscalingConfig' + AutoscalingConfig: + id: AutoscalingConfig + description: Represents the autoscaling configuration of a metastore service. + type: object + properties: + autoscalingFactor: + description: >- + Output only. The scaling factor of a service with autoscaling + enabled. + readOnly: true + type: number + format: float + autoscalingEnabled: + description: Optional. Whether or not autoscaling is enabled for this service. + type: boolean + limitConfig: + description: Optional. The LimitConfig of the service. + $ref: '#/components/schemas/LimitConfig' + LimitConfig: + id: LimitConfig + description: Represents the autoscaling limit configuration of a metastore service. + type: object + properties: + maxScalingFactor: + description: >- + Optional. The highest scaling factor that the service should be + autoscaled to. + type: number + format: float + minScalingFactor: + description: >- + Optional. The lowest scaling factor that the service should be + autoscaled to. + type: number + format: float ScheduledBackup: id: ScheduledBackup description: This specifies the configuration of scheduled backup. @@ -1295,6 +1337,265 @@ components: type: object additionalProperties: type: string + StartMigrationRequest: + id: StartMigrationRequest + description: Request message for DataprocMetastore.StartMigration. + type: object + properties: + migrationExecution: + description: Required. The configuration details for the migration. + $ref: '#/components/schemas/MigrationExecution' + requestId: + description: >- + Optional. A request ID. Specify a unique request ID to allow the + server to ignore the request if it has completed. The server will + ignore subsequent requests that provide a duplicate request ID for + at least 60 minutes after the first request.For example, if an + initial request times out, followed by another request with the same + request ID, the server ignores the second request to prevent the + creation of duplicate commitments.The request ID must be a valid + UUID + (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) + A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. + type: string + MigrationExecution: + id: MigrationExecution + description: The details of a migration execution resource. + type: object + properties: + cloudSqlMigrationConfig: + description: >- + Configuration information specific to migrating from self-managed + hive metastore on Google Cloud using Cloud SQL as the backend + database to Dataproc Metastore. + $ref: '#/components/schemas/CloudSQLMigrationConfig' + name: + description: >- + Output only. The relative resource name of the migration execution, + in the following form: + projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id} + readOnly: true + type: string + createTime: + description: Output only. The time when the migration execution was started. + readOnly: true + type: string + format: google-datetime + endTime: + description: Output only. The time when the migration execution finished. + readOnly: true + type: string + format: google-datetime + state: + description: Output only. The current state of the migration execution. + readOnly: true + type: string + enumDescriptions: + - The state of the migration execution is unknown. + - The migration execution is starting. + - The migration execution is running. + - The migration execution is in the process of being cancelled. + - The migration execution is awaiting user action. + - The migration execution has completed successfully. + - The migration execution has failed. + - The migration execution is cancelled. + - The migration execution is being deleted. + enum: + - STATE_UNSPECIFIED + - STARTING + - RUNNING + - CANCELLING + - AWAITING_USER_ACTION + - SUCCEEDED + - FAILED + - CANCELLED + - DELETING + phase: + description: Output only. The current phase of the migration execution. + readOnly: true + type: string + enumDescriptions: + - The phase of the migration execution is unknown. + - >- + Replication phase refers to the migration phase when Dataproc + Metastore is running a pipeline to replicate changes in the + customer database to its backend database. During this phase, + Dataproc Metastore uses the customer database as the hive + metastore backend database. + - >- + Cutover phase refers to the migration phase when Dataproc + Metastore switches to using its own backend database. Migration + enters this phase when customer is done migrating all their + clusters/workloads to Dataproc Metastore and triggers + CompleteMigration. + enum: + - PHASE_UNSPECIFIED + - REPLICATION + - CUTOVER + stateMessage: + description: >- + Output only. Additional information about the current state of the + migration execution. + readOnly: true + type: string + CloudSQLMigrationConfig: + id: CloudSQLMigrationConfig + description: >- + Configuration information for migrating from self-managed hive metastore + on Google Cloud using Cloud SQL as the backend database to Dataproc + Metastore. + type: object + properties: + cdcConfig: + description: >- + Required. Configuration information to start the Change Data Capture + (CDC) streams from customer database to backend database of Dataproc + Metastore. Dataproc Metastore switches to using its backend database + after the cutover phase of migration. + $ref: '#/components/schemas/CdcConfig' + cloudSqlConnectionConfig: + description: >- + Required. Configuration information to establish customer database + connection before the cutover phase of migration + $ref: '#/components/schemas/CloudSQLConnectionConfig' + CdcConfig: + id: CdcConfig + description: >- + Configuration information to start the Change Data Capture (CDC) streams + from customer database to backend database of Dataproc Metastore. + type: object + properties: + vpcNetwork: + description: >- + Required. Fully qualified name of the Cloud SQL instance's VPC + network or the shared VPC network that Datastream will peer to, in + the following format: + projects/{project_id}/locations/global/networks/{network_id}. More + context in + https://cloud.google.com/datastream/docs/network-connectivity-options#privateconnectivity + type: string + subnetIpRange: + description: Required. A /29 CIDR IP range for peering with datastream. + type: string + username: + description: >- + Required. The username that the Datastream service should use for + the MySQL connection. + type: string + password: + description: >- + Required. Input only. The password for the user that Datastream + service should use for the MySQL connection. This field is not + returned on request. + type: string + reverseProxySubnet: + description: >- + Required. The URL of the subnetwork resource to create the VM + instance hosting the reverse proxy in. More context in + https://cloud.google.com/datastream/docs/private-connectivity#reverse-csql-proxy + The subnetwork should reside in the network provided in the request + that Datastream will peer to and should be in the same region as + Datastream, in the following format. + projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} + type: string + bucket: + description: >- + Optional. The bucket to write the intermediate stream event data in. + The bucket name must be without any prefix like "gs://". See the + bucket naming requirements + (https://cloud.google.com/storage/docs/buckets#naming). This field + is optional. If not set, the Artifacts Cloud Storage bucket will be + used. + type: string + rootPath: + description: >- + Optional. The root path inside the Cloud Storage bucket. The stream + event data will be written to this path. The default value is + /migration. + type: string + CloudSQLConnectionConfig: + id: CloudSQLConnectionConfig + description: >- + Configuration information to establish customer database connection + before the cutover phase of migration + type: object + properties: + instanceConnectionName: + description: >- + Required. Cloud SQL database connection name + (project_id:region:instance_name) + type: string + ipAddress: + description: Required. The private IP address of the Cloud SQL instance. + type: string + port: + description: Required. The network port of the database. + type: integer + format: int32 + hiveDatabaseName: + description: Required. The hive database name. + type: string + username: + description: >- + Required. The username that Dataproc Metastore service will use to + connect to the database. + type: string + password: + description: >- + Required. Input only. The password for the user that Dataproc + Metastore service will be using to connect to the database. This + field is not returned on request. + type: string + proxySubnet: + description: >- + Required. The relative resource name of the subnetwork to deploy the + SOCKS5 proxy service in. The subnetwork should reside in a network + through which the Cloud SQL instance is accessible. The resource + name should be in the format, + projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} + type: string + natSubnet: + description: >- + Required. The relative resource name of the subnetwork to be used + for Private Service Connect. Note that this cannot be a regular + subnet and is used only for NAT. + (https://cloud.google.com/vpc/docs/about-vpc-hosted-services#psc-subnets) + This subnet is used to publish the SOCKS5 proxy service. The subnet + size must be at least /29 and it should reside in a network through + which the Cloud SQL instance is accessible. The resource name should + be in the format, + projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} + type: string + CompleteMigrationRequest: + id: CompleteMigrationRequest + description: Request message for DataprocMetastore.CompleteMigration. + type: object + properties: {} + CancelMigrationRequest: + id: CancelMigrationRequest + description: Request message for DataprocMetastore.CancelMigration. + type: object + properties: {} + ListMigrationExecutionsResponse: + id: ListMigrationExecutionsResponse + description: Response message for DataprocMetastore.ListMigrationExecutions. + type: object + properties: + migrationExecutions: + description: The migration executions on the specified service. + type: array + items: + $ref: '#/components/schemas/MigrationExecution' + nextPageToken: + description: >- + A token that can be sent as page_token to retrieve the next page. If + this field is omitted, there are no subsequent pages. + type: string + unreachable: + description: Locations that could not be reached. + type: array + items: + type: string ListLocationsResponse: id: ListLocationsResponse description: The response message for Locations.ListLocations. @@ -1903,16 +2204,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1925,23 +2223,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.metastore.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1969,6 +2265,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' federations: @@ -1976,17 +2273,14 @@ components: name: federations title: Federations methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.federations - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -2023,6 +2317,7 @@ components: - $ref: '#/components/x-stackQL-resources/federations/methods/create' update: - $ref: '#/components/x-stackQL-resources/federations/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/federations/methods/delete' federations_iam_policies: @@ -2037,17 +2332,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1federations~1{federationsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2061,23 +2353,23 @@ components: #/components/x-stackQL-resources/federations_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/federations_iam_policies/methods/set_iam_policy delete: [] services: id: google.metastore.services name: services title: Services methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -2148,6 +2440,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' + start_migration: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:startMigration/post + response: + mediaType: application/json + openAPIDocKey: '200' + complete_migration: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:completeMigration/post + response: + mediaType: application/json + openAPIDocKey: '200' + cancel_migration: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:cancelMigration/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/services/methods/get' @@ -2156,6 +2469,7 @@ components: - $ref: '#/components/x-stackQL-resources/services/methods/create' update: - $ref: '#/components/x-stackQL-resources/services/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_iam_policies: @@ -2170,17 +2484,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -2194,23 +2505,23 @@ components: #/components/x-stackQL-resources/services_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/services_iam_policies/methods/set_iam_policy delete: [] metadata_imports: id: google.metastore.metadata_imports name: metadata_imports title: Metadata_imports methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1metadataImports/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.metadataImports - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: >- @@ -2240,23 +2551,21 @@ components: - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/create' update: - $ref: '#/components/x-stackQL-resources/metadata_imports/methods/patch' + replace: [] delete: [] backups: id: google.metastore.backups name: backups title: Backups methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backups - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -2285,6 +2594,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/backups/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backups/methods/delete' backups_iam_policies: @@ -2299,24 +2609,61 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_17 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1backups~1{backupsId}:getIamPolicy/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_17 - response: *ref_18 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/backups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backups_iam_policies/methods/set_iam_policy delete: [] + migration_executions: + id: google.metastore.migration_executions + name: migration_executions + title: Migration_executions + methods: + get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1migrationExecutions~1{migrationExecutionsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1migrationExecutions~1{migrationExecutionsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1migrationExecutions/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.migrationExecutions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/migration_executions/methods/get' + - $ref: '#/components/x-stackQL-resources/migration_executions/methods/list' + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/migration_executions/methods/delete databases_iam_policies: id: google.metastore.databases_iam_policies name: databases_iam_policies @@ -2329,23 +2676,23 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1databases~1{databasesId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/databases_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/databases_iam_policies/methods/set_iam_policy delete: [] tables_iam_policies: id: google.metastore.tables_iam_policies @@ -2359,27 +2706,27 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_21 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1databases~1{databasesId}~1tables~1{tablesId}:getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_21 - response: *ref_22 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/tables_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/tables_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_23 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2426,7 +2773,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets information about a location. operationId: metastore.projects.locations.get @@ -2454,7 +2801,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2497,7 +2844,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2568,7 +2915,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2615,7 +2962,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/federations: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists federations in a project and location. operationId: metastore.projects.locations.federations.list @@ -2699,7 +3046,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets the details of a single federation. operationId: metastore.projects.locations.federations.get @@ -2812,7 +3159,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2853,7 +3200,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2893,7 +3240,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/federations/{federationsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2936,7 +3283,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists services in a project and location. operationId: metastore.projects.locations.services.list @@ -3020,7 +3367,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets the details of a single service. operationId: metastore.projects.locations.services.get @@ -3133,7 +3480,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:exportMetadata: - parameters: *ref_23 + parameters: *ref_1 post: description: Exports metadata from a service. operationId: metastore.projects.locations.services.exportMetadata @@ -3171,7 +3518,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:restore: - parameters: *ref_23 + parameters: *ref_1 post: description: Restores a service from a backup. operationId: metastore.projects.locations.services.restore @@ -3209,7 +3556,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:queryMetadata: - parameters: *ref_23 + parameters: *ref_1 post: description: Query Dataproc Metastore metadata. operationId: metastore.projects.locations.services.queryMetadata @@ -3247,7 +3594,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:moveTableToDatabase: - parameters: *ref_23 + parameters: *ref_1 post: description: Move a table to another database. operationId: metastore.projects.locations.services.moveTableToDatabase @@ -3285,7 +3632,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterLocation: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Alter metadata resource location. The metadata resource can be a @@ -3327,7 +3674,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterTableProperties: - parameters: *ref_23 + parameters: *ref_1 post: description: Alter metadata table properties. operationId: metastore.projects.locations.services.alterTableProperties @@ -3364,8 +3711,125 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:startMigration: + parameters: *ref_1 + post: + description: Starts the Managed Migration process. + operationId: metastore.projects.locations.services.startMigration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartMigrationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:completeMigration: + parameters: *ref_1 + post: + description: >- + Completes the managed migration process. The Dataproc Metastore service + will switch to using its own backend database after successful + migration. + operationId: metastore.projects.locations.services.completeMigration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompleteMigrationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:cancelMigration: + parameters: *ref_1 + post: + description: Cancels the ongoing Managed Migration process. + operationId: metastore.projects.locations.services.cancelMigration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelMigrationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3406,7 +3870,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3446,7 +3910,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3489,7 +3953,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists imports in a service. operationId: metastore.projects.locations.services.metadataImports.list @@ -3583,7 +4047,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/metadataImports/{metadataImportsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets details of a single import. operationId: metastore.projects.locations.services.metadataImports.get @@ -3673,7 +4137,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists backups in a service. operationId: metastore.projects.locations.services.backups.list @@ -3767,7 +4231,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets details of a single backup. operationId: metastore.projects.locations.services.backups.get @@ -3845,7 +4309,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3891,7 +4355,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3935,8 +4399,136 @@ paths: schema: type: integer format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}: + parameters: *ref_1 + get: + description: Gets details of a single migration execution. + operationId: metastore.projects.locations.services.migrationExecutions.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/MigrationExecution' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string + - in: path + name: migrationExecutionsId + required: true + schema: + type: string + delete: + description: Deletes a single migration execution. + operationId: metastore.projects.locations.services.migrationExecutions.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string + - in: path + name: migrationExecutionsId + required: true + schema: + type: string + - in: query + name: requestId + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions: + parameters: *ref_1 + get: + description: Lists migration executions on a service. + operationId: metastore.projects.locations.services.migrationExecutions.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListMigrationExecutionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: servicesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: orderBy + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3982,7 +4574,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4027,7 +4619,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}/tables/{tablesId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4078,7 +4670,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/databases/{databasesId}/tables/{tablesId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy diff --git a/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml b/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml index 5cf4e633..aec011bd 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/migrationcenter.yaml @@ -9,8 +9,8 @@ info: A unified platform that helps you accelerate your end-to-end cloud journey from your current on-premises or cloud environments to Google Cloud. version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/migration-center servers: @@ -238,7 +238,7 @@ components: type: string format: google-datetime coreCount: - description: Number of CPU cores in the machine. Must be non-negative. + description: Number of logical CPU cores in the machine. Must be non-negative. type: integer format: int32 memoryMb: @@ -1177,7 +1177,8 @@ components: type: object properties: fitLevel: - description: Fit level. + description: Output only. Fit level. + readOnly: true type: string enumDescriptions: - Not enough information. @@ -1211,17 +1212,21 @@ components: type: integer format: int32 logicalCoreCount: - description: Number of logical cores. + description: Output only. Number of logical cores. + readOnly: true type: integer format: int32 series: - description: Compute Engine machine series. + description: Output only. Compute Engine machine series. + readOnly: true type: string machineType: - description: Compute Engine machine type. + description: Output only. Compute Engine machine type. + readOnly: true type: string storage: - description: Compute Engine storage. Never empty. + description: Output only. Compute Engine storage. Never empty. + readOnly: true type: array items: $ref: '#/components/schemas/ComputeStorageDescriptor' @@ -1231,7 +1236,8 @@ components: type: object properties: type: - description: Disk type backing the storage. + description: Output only. Disk type backing the storage. + readOnly: true type: string enumDescriptions: - >- @@ -1247,7 +1253,8 @@ components: - PERSISTENT_DISK_TYPE_BALANCED - PERSISTENT_DISK_TYPE_SSD sizeGb: - description: Disk size in GiB. + description: Output only. Disk size in GiB. + readOnly: true type: integer format: int32 GenericInsight: @@ -1872,6 +1879,12 @@ components: type: array items: $ref: '#/components/schemas/ImportError' + csvError: + description: Error details for a CSV file. + $ref: '#/components/schemas/ImportRowErrorCsvErrorDetails' + xlsxError: + description: Error details for an XLSX file. + $ref: '#/components/schemas/ImportRowErrorXlsxErrorDetails' ImportError: id: ImportError description: >- @@ -1895,6 +1908,27 @@ components: - ERROR - WARNING - INFO + ImportRowErrorCsvErrorDetails: + id: ImportRowErrorCsvErrorDetails + description: Error details for a CSV file. + type: object + properties: + rowNumber: + description: The row number where the error was detected. + type: integer + format: int32 + ImportRowErrorXlsxErrorDetails: + id: ImportRowErrorXlsxErrorDetails + description: Error details for an XLSX file. + type: object + properties: + sheet: + description: The name of the sheet where the error was detected. + type: string + rowNumber: + description: The row number where the error was detected. + type: integer + format: int32 ExecutionReport: id: ExecutionReport description: A resource that reports result of the import job execution. @@ -3502,23 +3536,22 @@ components: select: - $ref: '#/components/x-stackQL-resources/settings/methods/get_settings' insert: [] - update: [] + update: + - $ref: '#/components/x-stackQL-resources/settings/methods/update_settings' + replace: [] delete: [] locations: id: google.migrationcenter.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3531,23 +3564,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.migrationcenter.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -3575,6 +3606,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' assets: @@ -3582,17 +3614,14 @@ components: name: assets title: Assets methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1assets/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.assets - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -3649,8 +3678,11 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/assets/methods/patch' + - $ref: '#/components/x-stackQL-resources/assets/methods/batch_update' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/assets/methods/delete' + - $ref: '#/components/x-stackQL-resources/assets/methods/batch_delete' import_jobs: id: google.migrationcenter.import_jobs name: import_jobs @@ -3663,17 +3695,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1importJobs/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.importJobs - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -3717,6 +3746,7 @@ components: - $ref: '#/components/x-stackQL-resources/import_jobs/methods/create' update: - $ref: '#/components/x-stackQL-resources/import_jobs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/import_jobs/methods/delete' import_data_files: @@ -3738,17 +3768,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1importJobs~1{importJobsId}~1importDataFiles/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.importDataFiles - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -3763,6 +3790,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/import_data_files/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/import_data_files/methods/delete' groups: @@ -3770,17 +3798,14 @@ components: name: groups title: Groups methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1groups/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.groups - list: - operation: *ref_11 - response: *ref_12 create: operation: $ref: >- @@ -3817,6 +3842,7 @@ components: - $ref: '#/components/x-stackQL-resources/groups/methods/create' update: - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/groups/methods/delete' groups_assets: @@ -3840,25 +3866,26 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: '#/components/x-stackQL-resources/groups_assets/methods/add_assets' update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/groups_assets/methods/remove_assets sources: id: google.migrationcenter.sources name: sources title: Sources methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sources - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: >- @@ -3895,6 +3922,7 @@ components: - $ref: '#/components/x-stackQL-resources/sources/methods/create' update: - $ref: '#/components/x-stackQL-resources/sources/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/sources/methods/delete' error_frames: @@ -3902,17 +3930,14 @@ components: name: error_frames title: Error_frames methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1errorFrames/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.errorFrames - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -3926,23 +3951,21 @@ components: - $ref: '#/components/x-stackQL-resources/error_frames/methods/list' insert: [] update: [] + replace: [] delete: [] preference_sets: id: google.migrationcenter.preference_sets name: preference_sets title: Preference_sets methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1preferenceSets/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.preferenceSets - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: >- @@ -3979,6 +4002,7 @@ components: - $ref: '#/components/x-stackQL-resources/preference_sets/methods/create' update: - $ref: '#/components/x-stackQL-resources/preference_sets/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/preference_sets/methods/delete' report_configs: @@ -3993,17 +4017,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reportConfigs/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.reportConfigs - list: - operation: *ref_19 - response: *ref_20 get: operation: $ref: >- @@ -4025,6 +4046,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/report_configs/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/report_configs/methods/delete' reports: @@ -4039,17 +4061,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1reportConfigs~1{reportConfigsId}~1reports/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.reports - list: - operation: *ref_21 - response: *ref_22 get: operation: $ref: >- @@ -4071,6 +4090,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/reports/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/reports/methods/delete' discovery_clients: @@ -4085,17 +4105,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_23 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1discoveryClients/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.discoveryClients - list: - operation: *ref_23 - response: *ref_24 get: operation: $ref: >- @@ -4132,11 +4149,12 @@ components: - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/create' update: - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/discovery_clients/methods/delete' paths: /v1/projects/{projectsId}/locations/{locationsId}/settings: - parameters: &ref_25 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4215,7 +4233,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_25 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: migrationcenter.projects.locations.list @@ -4251,7 +4269,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets information about a location. operationId: migrationcenter.projects.locations.get @@ -4279,7 +4297,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_25 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4322,7 +4340,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4393,7 +4411,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4440,7 +4458,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/assets: - parameters: *ref_25 + parameters: *ref_1 get: description: Lists all the assets in a given project and location. operationId: migrationcenter.projects.locations.assets.list @@ -4489,7 +4507,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/assets/{assetsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets the details of an asset. operationId: migrationcenter.projects.locations.assets.get @@ -4606,7 +4624,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/assets:batchUpdate: - parameters: *ref_25 + parameters: *ref_1 post: description: Updates the parameters of a list of assets. operationId: migrationcenter.projects.locations.assets.batchUpdate @@ -4639,7 +4657,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/assets:batchDelete: - parameters: *ref_25 + parameters: *ref_1 post: description: Deletes list of Assets. operationId: migrationcenter.projects.locations.assets.batchDelete @@ -4672,7 +4690,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/assets:reportAssetFrames: - parameters: *ref_25 + parameters: *ref_1 post: description: Reports a set of frames. operationId: migrationcenter.projects.locations.assets.reportAssetFrames @@ -4709,7 +4727,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/assets:aggregateValues: - parameters: *ref_25 + parameters: *ref_1 post: description: Aggregates the requested fields based on provided function. operationId: migrationcenter.projects.locations.assets.aggregateValues @@ -4742,7 +4760,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/importJobs: - parameters: *ref_25 + parameters: *ref_1 post: description: Creates an import job. operationId: migrationcenter.projects.locations.importJobs.create @@ -4830,7 +4848,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets the details of an import job. operationId: migrationcenter.projects.locations.importJobs.get @@ -4951,7 +4969,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}:validate: - parameters: *ref_25 + parameters: *ref_1 post: description: Validates an import job. operationId: migrationcenter.projects.locations.importJobs.validate @@ -4989,7 +5007,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}:run: - parameters: *ref_25 + parameters: *ref_1 post: description: Runs an import job. operationId: migrationcenter.projects.locations.importJobs.run @@ -5027,7 +5045,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}/importDataFiles/{importDataFilesId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets an import data file. operationId: migrationcenter.projects.locations.importJobs.importDataFiles.get @@ -5105,7 +5123,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}/importDataFiles: - parameters: *ref_25 + parameters: *ref_1 get: description: List import data files. operationId: migrationcenter.projects.locations.importJobs.importDataFiles.list @@ -5199,7 +5217,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups: - parameters: *ref_25 + parameters: *ref_1 get: description: Lists all groups in a given project and location. operationId: migrationcenter.projects.locations.groups.list @@ -5283,7 +5301,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets the details of a group. operationId: migrationcenter.projects.locations.groups.get @@ -5396,7 +5414,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:addAssets: - parameters: *ref_25 + parameters: *ref_1 post: description: Adds assets to a group. operationId: migrationcenter.projects.locations.groups.addAssets @@ -5434,7 +5452,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:removeAssets: - parameters: *ref_25 + parameters: *ref_1 post: description: Removes assets from a group. operationId: migrationcenter.projects.locations.groups.removeAssets @@ -5472,7 +5490,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources: - parameters: *ref_25 + parameters: *ref_1 get: description: Lists all the sources in a given project and location. operationId: migrationcenter.projects.locations.sources.list @@ -5556,7 +5574,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets the details of a source. operationId: migrationcenter.projects.locations.sources.get @@ -5669,7 +5687,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/errorFrames: - parameters: *ref_25 + parameters: *ref_1 get: description: Lists all error frames in a given source and location. operationId: migrationcenter.projects.locations.sources.errorFrames.list @@ -5715,7 +5733,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/errorFrames/{errorFramesId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets the details of an error frame. operationId: migrationcenter.projects.locations.sources.errorFrames.get @@ -5757,7 +5775,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/preferenceSets: - parameters: *ref_25 + parameters: *ref_1 get: description: Lists all the preference sets in a given project and location. operationId: migrationcenter.projects.locations.preferenceSets.list @@ -5837,7 +5855,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/preferenceSets/{preferenceSetsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets the details of a preference set. operationId: migrationcenter.projects.locations.preferenceSets.get @@ -5950,7 +5968,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/reportConfigs: - parameters: *ref_25 + parameters: *ref_1 post: description: Creates a report configuration. operationId: migrationcenter.projects.locations.reportConfigs.create @@ -6034,7 +6052,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets details of a single ReportConfig. operationId: migrationcenter.projects.locations.reportConfigs.get @@ -6106,7 +6124,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reports: - parameters: *ref_25 + parameters: *ref_1 post: description: Creates a report. operationId: migrationcenter.projects.locations.reportConfigs.reports.create @@ -6204,7 +6222,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reports/{reportsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets details of a single Report. operationId: migrationcenter.projects.locations.reportConfigs.reports.get @@ -6286,7 +6304,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveryClients: - parameters: *ref_25 + parameters: *ref_1 post: description: Creates a new discovery client. operationId: migrationcenter.projects.locations.discoveryClients.create @@ -6370,7 +6388,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveryClients/{discoveryClientsId}: - parameters: *ref_25 + parameters: *ref_1 get: description: Gets the details of a discovery client. operationId: migrationcenter.projects.locations.discoveryClients.get @@ -6483,7 +6501,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/discoveryClients/{discoveryClientsId}:sendHeartbeat: - parameters: *ref_25 + parameters: *ref_1 post: description: >- Sends a discovery client heartbeat. Healthy clients are expected to send diff --git a/providers/src/googleapis.com/v00.00.00000/services/ml.yaml b/providers/src/googleapis.com/v00.00.00000/services/ml.yaml index 48e38b62..31182e67 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ml.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ml.yaml @@ -7,8 +7,8 @@ info: title: AI Platform Training & Prediction API description: An API to enable creating and using machine learning models. version: v1 - x-discovery-doc-revision: '20240427' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240816' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/ml/ servers: @@ -3347,6 +3347,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] config: id: google.ml.config @@ -3365,6 +3366,7 @@ components: #/components/x-stackQL-resources/config/methods/projects_get_config insert: [] update: [] + replace: [] delete: [] jobs: id: google.ml.jobs @@ -3377,16 +3379,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_jobs_list: - operation: &ref_1 + projects_jobs_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1jobs/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - projects_jobs_list: - operation: *ref_1 - response: *ref_2 projects_jobs_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1jobs~1{jobsId}/get' @@ -3413,6 +3412,7 @@ components: - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_create' update: - $ref: '#/components/x-stackQL-resources/jobs/methods/projects_jobs_patch' + replace: [] delete: [] jobs_iam_policies: id: google.ml.jobs_iam_policies @@ -3426,17 +3426,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_jobs_get_iam_policy: - operation: &ref_3 + projects_jobs_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1jobs~1{jobsId}:getIamPolicy/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_jobs_get_iam_policy: - operation: *ref_3 - response: *ref_4 projects_jobs_test_iam_permissions: operation: $ref: >- @@ -3450,6 +3447,9 @@ components: #/components/x-stackQL-resources/jobs_iam_policies/methods/projects_jobs_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/jobs_iam_policies/methods/projects_jobs_set_iam_policy delete: [] locations: id: google.ml.locations @@ -3462,16 +3462,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_list: - operation: &ref_5 + projects_locations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: >- @@ -3480,6 +3477,7 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] operations: id: google.ml.operations @@ -3500,16 +3498,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_operations_list: - operation: &ref_7 + projects_operations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_operations_list: - operation: *ref_7 - response: *ref_8 projects_operations_get: operation: $ref: >- @@ -3534,6 +3529,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] + replace: [] delete: [] studies: id: google.ml.studies @@ -3578,6 +3574,7 @@ components: - $ref: >- #/components/x-stackQL-resources/studies/methods/projects_locations_studies_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/studies/methods/projects_locations_studies_delete @@ -3652,6 +3649,7 @@ components: - $ref: >- #/components/x-stackQL-resources/trials/methods/projects_locations_studies_trials_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/trials/methods/projects_locations_studies_trials_delete @@ -3669,8 +3667,11 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/trials_measurement/methods/projects_locations_studies_trials_add_measurement update: [] + replace: [] delete: [] trials_optimal_trials: id: google.ml.trials_optimal_trials @@ -3685,9 +3686,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/trials_optimal_trials/methods/projects_locations_studies_trials_list_optimal_trials insert: [] update: [] + replace: [] delete: [] models: id: google.ml.models @@ -3700,16 +3704,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_models_list: - operation: &ref_9 + projects_models_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1models/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.models - projects_models_list: - operation: *ref_9 - response: *ref_10 projects_models_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1models~1{modelsId}/get' @@ -3740,6 +3741,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_models_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_models_delete @@ -3755,17 +3757,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_models_get_iam_policy: - operation: &ref_11 + projects_models_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1models~1{modelsId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_models_get_iam_policy: - operation: *ref_11 - response: *ref_12 projects_models_test_iam_permissions: operation: $ref: >- @@ -3779,6 +3778,9 @@ components: #/components/x-stackQL-resources/models_iam_policies/methods/projects_models_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/models_iam_policies/methods/projects_models_set_iam_policy delete: [] versions: id: google.ml.versions @@ -3792,17 +3794,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_models_versions_list: - operation: &ref_13 + projects_models_versions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1models~1{modelsId}~1versions/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.versions - projects_models_versions_list: - operation: *ref_13 - response: *ref_14 projects_models_versions_patch: operation: $ref: >- @@ -3843,12 +3842,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_models_versions_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/versions/methods/projects_models_versions_delete paths: /v1/projects/{projectsId}:predict: - parameters: &ref_15 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3889,7 +3889,7 @@ paths: schema: type: string /v1/projects/{projectsId}:explain: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Performs explanation on the data in the request. {% dynamic include @@ -3919,7 +3919,7 @@ paths: schema: type: string /v1/projects/{projectsId}:getConfig: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Get the service account information associated with your project. You @@ -3946,7 +3946,7 @@ paths: schema: type: string /v1/projects/{projectsId}/jobs: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a training or a batch prediction job. operationId: ml.projects.jobs.create @@ -4014,7 +4014,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/jobs/{jobsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Describes a job. operationId: ml.projects.jobs.get @@ -4084,7 +4084,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/jobs/{jobsId}:cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: Cancels a running job. operationId: ml.projects.jobs.cancel @@ -4117,7 +4117,7 @@ paths: schema: type: string /v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4153,7 +4153,7 @@ paths: schema: type: string /v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4188,7 +4188,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4226,7 +4226,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Get the complete list of CMLE capabilities in a location, along with @@ -4260,7 +4260,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_15 + parameters: *ref_1 get: description: List all locations that provides at least one type of CMLE capability. operationId: ml.projects.locations.list @@ -4296,7 +4296,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4332,7 +4332,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4374,7 +4374,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a study. operationId: ml.projects.locations.studies.create @@ -4437,7 +4437,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets a study. operationId: ml.projects.locations.studies.get @@ -4501,7 +4501,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Adds one or more trials to a study, with parameter values suggested by @@ -4543,7 +4543,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials: - parameters: *ref_15 + parameters: *ref_1 post: description: Adds a user provided trial to a study. operationId: ml.projects.locations.studies.trials.create @@ -4612,7 +4612,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets a trial. operationId: ml.projects.locations.studies.trials.get @@ -4686,7 +4686,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addMeasurement: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Adds a measurement of the objective metrics to a trial. This measurement @@ -4731,7 +4731,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete: - parameters: *ref_15 + parameters: *ref_1 post: description: Marks a trial as complete. operationId: ml.projects.locations.studies.trials.complete @@ -4774,7 +4774,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkEarlyStoppingState: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Checks whether a trial should stop or not. Returns a long-running @@ -4821,7 +4821,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop: - parameters: *ref_15 + parameters: *ref_1 post: description: Stops a trial. operationId: ml.projects.locations.studies.trials.stop @@ -4864,7 +4864,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Lists the pareto-optimal trials for multi-objective study or the optimal @@ -4906,7 +4906,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4944,7 +4944,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4975,7 +4975,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}:cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5012,7 +5012,7 @@ paths: schema: type: string /v1/projects/{projectsId}/models: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Creates a model which will later contain one or more versions. You must @@ -5085,7 +5085,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/models/{modelsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets information about a model, including its name, the description (if @@ -5186,7 +5186,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/models/{modelsId}:setIamPolicy: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5222,7 +5222,7 @@ paths: schema: type: string /v1/projects/{projectsId}/models/{modelsId}:getIamPolicy: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5257,7 +5257,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/models/{modelsId}:testIamPermissions: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5295,7 +5295,7 @@ paths: schema: type: string /v1/projects/{projectsId}/models/{modelsId}/versions: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Creates a new version of a model from a trained TensorFlow model. If the @@ -5383,7 +5383,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}: - parameters: *ref_15 + parameters: *ref_1 patch: description: >- Updates the specified Version resource. Currently the only update-able @@ -5498,7 +5498,7 @@ paths: schema: type: string /v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Designates a version to be the default for the model. The default diff --git a/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml b/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml index 926c080b..8e28cf39 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/monitoring.yaml @@ -7,8 +7,8 @@ info: title: Cloud Monitoring API description: Manages your Cloud Monitoring data and configurations. version: v3 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/monitoring/api/ servers: @@ -485,6 +485,21 @@ components: excluding data loss due to errors. type: string format: google-duration + timeSeriesResourceHierarchyLevel: + description: The scope of the timeseries data of the metric. + type: array + items: + type: string + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER Empty: id: Empty description: >- @@ -626,7 +641,14 @@ components: description: >- The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The - unit defines the representation of the stored metric values. + unit defines the representation of the stored metric values. This + field can only be changed through CreateTimeSeries when it is empty. + type: string + description: + description: >- + Input only. A detailed description of the time series that will be + associated with the google.api.MetricDescriptor for the metric. Once + set, this field cannot be changed through CreateTimeSeries. type: string Metric: id: Metric @@ -1280,8 +1302,8 @@ components: properties: name: description: >- - Required if the policy exists. The resource name for this policy. - The format is: + Identifier. Required if the policy exists. The resource name for + this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not @@ -1443,7 +1465,7 @@ components: exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables - (https://cloud.google.com/monitoring/alerts/doc-variables). + (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). type: string mimeType: description: >- @@ -1463,8 +1485,33 @@ components: and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables - (https://cloud.google.com/monitoring/alerts/doc-variables). If this - field is missing or empty, a default subject line will be generated. + (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). + If this field is missing or empty, a default subject line will be + generated. + type: string + links: + description: >- + Optional. Links to content such as playbooks, repositories, and + other resources. This field can contain up to 3 entries. + type: array + items: + $ref: '#/components/schemas/Link' + Link: + id: Link + description: Links to content such as playbooks, repositories, and other resources. + type: object + properties: + displayName: + description: >- + A short display name for the link. The display name must not be + empty or exceed 63 characters. Example: "playbook". + type: string + url: + description: >- + The url of a webpage. A url can be templatized by using variables in + the path or the query parameters. The total length of a URL should + not exceed 2083 characters before and after variable expansion. + Example: "https://my_domain.com/playbook?name=${resource.name}" type: string Condition: id: Condition @@ -2226,9 +2273,10 @@ components: Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables - (https://cloud.google.com/monitoring/alerts/doc-variables). The only - available variable names are the names of the labels in the PromQL - result, including "__name__" and "value". "labels" may be empty. + (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). + The only available variable names are the names of the labels in the + PromQL result, including "__name__" and "value". "labels" may be + empty. type: object additionalProperties: type: string @@ -2278,8 +2326,9 @@ components: properties: notificationRateLimit: description: >- - Required for alert policies with a LogMatch condition.This limit is - not implemented for alert policies that are not log-based. + Required for log-based alert policies, i.e. policies with a LogMatch + condition.This limit is not implemented for alert policies that do + not have a LogMatch condition. $ref: '#/components/schemas/NotificationRateLimit' autoClose: description: >- @@ -2596,7 +2645,8 @@ components: type: string name: description: >- - The full REST resource name for this channel. The format is: + Identifier. The full REST resource name for this channel. The format + is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. @@ -2750,7 +2800,11 @@ components: type: string QueryTimeSeriesRequest: id: QueryTimeSeriesRequest - description: The QueryTimeSeries request. + deprecated: true + description: >- + The QueryTimeSeries request. For information about the status of + Monitoring Query Language (MQL), see the MQL deprecation notice + (https://cloud.google.com/stackdriver/docs/deprecations/mql). type: object properties: query: @@ -2774,7 +2828,11 @@ components: type: string QueryTimeSeriesResponse: id: QueryTimeSeriesResponse - description: The QueryTimeSeries response. + deprecated: true + description: >- + The QueryTimeSeries response. For information about the status of + Monitoring Query Language (MQL), see the MQL deprecation notice + (https://cloud.google.com/stackdriver/docs/deprecations/mql). type: object properties: timeSeriesDescriptor: @@ -3287,7 +3345,7 @@ components: goal: description: >- The fraction of service that must be good in order for this - objective to be met. 0 < goal <= 0.999. + objective to be met. 0 < goal <= 0.9999. type: number format: double rollingPeriod: @@ -3622,7 +3680,7 @@ components: properties: name: description: >- - Required. The name of the Snooze. The format is: + Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. type: string @@ -4712,17 +4770,14 @@ components: name: monitored_resource_descriptors title: Monitored_resource_descriptors methods: - _projects_monitored_resource_descriptors_list: - operation: &ref_1 + projects_monitored_resource_descriptors_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1monitoredResourceDescriptors/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resourceDescriptors - projects_monitored_resource_descriptors_list: - operation: *ref_1 - response: *ref_2 projects_monitored_resource_descriptors_get: operation: $ref: >- @@ -4738,22 +4793,20 @@ components: #/components/x-stackQL-resources/monitored_resource_descriptors/methods/projects_monitored_resource_descriptors_list insert: [] update: [] + replace: [] delete: [] metric_descriptors: id: google.monitoring.metric_descriptors name: metric_descriptors title: Metric_descriptors methods: - _projects_metric_descriptors_list: - operation: &ref_3 + projects_metric_descriptors_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1metricDescriptors/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.metricDescriptors - projects_metric_descriptors_list: - operation: *ref_3 - response: *ref_4 projects_metric_descriptors_create: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1metricDescriptors/post' @@ -4784,6 +4837,7 @@ components: - $ref: >- #/components/x-stackQL-resources/metric_descriptors/methods/projects_metric_descriptors_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/metric_descriptors/methods/projects_metric_descriptors_delete @@ -4792,16 +4846,13 @@ components: name: time_series title: Time_series methods: - _projects_time_series_list: - operation: &ref_5 + projects_time_series_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1timeSeries/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.timeSeries - projects_time_series_list: - operation: *ref_5 - response: *ref_6 projects_time_series_create: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1timeSeries/post' @@ -4814,26 +4865,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_time_series_list: - operation: &ref_7 + organizations_time_series_list: + operation: $ref: '#/paths/~1v3~1organizations~1{organizationsId}~1timeSeries/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.timeSeries - organizations_time_series_list: - operation: *ref_7 - response: *ref_8 - _folders_time_series_list: - operation: &ref_9 + folders_time_series_list: + operation: $ref: '#/paths/~1v3~1folders~1{foldersId}~1timeSeries/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.timeSeries - folders_time_series_list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: >- @@ -4846,6 +4891,7 @@ components: - $ref: >- #/components/x-stackQL-resources/time_series/methods/projects_time_series_create update: [] + replace: [] delete: [] time_series_service: id: google.monitoring.time_series_service @@ -4865,6 +4911,7 @@ components: - $ref: >- #/components/x-stackQL-resources/time_series_service/methods/projects_time_series_create_service update: [] + replace: [] delete: [] collectd_time_series: id: google.monitoring.collectd_time_series @@ -4883,22 +4930,20 @@ components: - $ref: >- #/components/x-stackQL-resources/collectd_time_series/methods/projects_collectd_time_series_create update: [] + replace: [] delete: [] alert_policies: id: google.monitoring.alert_policies name: alert_policies title: Alert_policies methods: - _projects_alert_policies_list: - operation: &ref_11 + projects_alert_policies_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1alertPolicies/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.alertPolicies - projects_alert_policies_list: - operation: *ref_11 - response: *ref_12 projects_alert_policies_create: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1alertPolicies/post' @@ -4938,6 +4983,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/alert_policies/methods/projects_alert_policies_delete @@ -4946,16 +4992,13 @@ components: name: groups title: Groups methods: - _projects_groups_list: - operation: &ref_13 + projects_groups_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1groups/get' - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.group - projects_groups_list: - operation: *ref_13 - response: *ref_14 projects_groups_create: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1groups/post' @@ -4989,7 +5032,8 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/groups/methods/projects_groups_create - update: + update: [] + replace: - $ref: >- #/components/x-stackQL-resources/groups/methods/projects_groups_update delete: @@ -5000,40 +5044,35 @@ components: name: members title: Members methods: - _projects_groups_members_list: - operation: &ref_15 + projects_groups_members_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1groups~1{groupsId}~1members/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.members - projects_groups_members_list: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/members/methods/projects_groups_members_list insert: [] update: [] + replace: [] delete: [] notification_channel_descriptors: id: google.monitoring.notification_channel_descriptors name: notification_channel_descriptors title: Notification_channel_descriptors methods: - _projects_notification_channel_descriptors_list: - operation: &ref_17 + projects_notification_channel_descriptors_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1notificationChannelDescriptors/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.channelDescriptors - projects_notification_channel_descriptors_list: - operation: *ref_17 - response: *ref_18 projects_notification_channel_descriptors_get: operation: $ref: >- @@ -5049,22 +5088,20 @@ components: #/components/x-stackQL-resources/notification_channel_descriptors/methods/projects_notification_channel_descriptors_list insert: [] update: [] + replace: [] delete: [] notification_channels: id: google.monitoring.notification_channels name: notification_channels title: Notification_channels methods: - _projects_notification_channels_list: - operation: &ref_19 + projects_notification_channels_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1notificationChannels/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.notificationChannels - projects_notification_channels_list: - operation: *ref_19 - response: *ref_20 projects_notification_channels_create: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1notificationChannels/post' @@ -5118,6 +5155,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/notification_channels/methods/projects_notification_channels_delete @@ -5134,9 +5172,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/notification_channels_verification_code/methods/projects_notification_channels_get_verification_code insert: [] update: [] + replace: [] delete: [] snoozes: id: google.monitoring.snoozes @@ -5149,16 +5190,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_snoozes_list: - operation: &ref_21 + projects_snoozes_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1snoozes/get' - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.snoozes - projects_snoozes_list: - operation: *ref_21 - response: *ref_22 projects_snoozes_get: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1snoozes~1{snoozesId}/get' @@ -5183,22 +5221,20 @@ components: update: - $ref: >- #/components/x-stackQL-resources/snoozes/methods/projects_snoozes_patch + replace: [] delete: [] uptime_check_configs: id: google.monitoring.uptime_check_configs name: uptime_check_configs title: Uptime_check_configs methods: - _projects_uptime_check_configs_list: - operation: &ref_23 + projects_uptime_check_configs_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1uptimeCheckConfigs/get' - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.uptimeCheckConfigs - projects_uptime_check_configs_list: - operation: *ref_23 - response: *ref_24 projects_uptime_check_configs_create: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1uptimeCheckConfigs/post' @@ -5238,6 +5274,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/uptime_check_configs/methods/projects_uptime_check_configs_delete @@ -5252,22 +5289,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _services_list: - operation: &ref_25 + services_list: + operation: $ref: '#/paths/~1v3~1{parentType}~1{parent}~1services/get' - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - services_list: - operation: *ref_25 - response: *ref_26 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/services/methods/services_list' insert: - $ref: '#/components/x-stackQL-resources/services/methods/services_create' update: [] + replace: [] delete: [] service_level_objectives: id: google.monitoring.service_level_objectives @@ -5298,16 +5333,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _services_service_level_objectives_list: - operation: &ref_27 + services_service_level_objectives_list: + operation: $ref: '#/paths/~1v3~1{parentType}~1{parent}~1serviceLevelObjectives/get' - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceLevelObjectives - services_service_level_objectives_list: - operation: *ref_27 - response: *ref_28 sqlVerbs: select: - $ref: >- @@ -5320,6 +5352,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/service_level_objectives/methods/services_service_level_objectives_delete @@ -5328,26 +5361,24 @@ components: name: uptime_check_ips title: Uptime_check_ips methods: - _uptime_check_ips_list: - operation: &ref_29 + uptime_check_ips_list: + operation: $ref: '#/paths/~1v3~1uptimeCheckIps/get' - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.uptimeCheckIps - uptime_check_ips_list: - operation: *ref_29 - response: *ref_30 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/uptime_check_ips/methods/uptime_check_ips_list insert: [] update: [] + replace: [] delete: [] paths: /v3/projects/{projectsId}/monitoredResourceDescriptors: - parameters: &ref_31 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -5406,7 +5437,7 @@ paths: schema: type: string /v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}: - parameters: *ref_31 + parameters: *ref_1 get: description: Gets a single monitored resource descriptor. operationId: monitoring.projects.monitoredResourceDescriptors.get @@ -5446,7 +5477,7 @@ paths: schema: type: string /v3/projects/{projectsId}/metricDescriptors: - parameters: *ref_31 + parameters: *ref_1 get: description: Lists metric descriptors that match a filter. operationId: monitoring.projects.metricDescriptors.list @@ -5533,7 +5564,7 @@ paths: schema: type: string /v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}: - parameters: *ref_31 + parameters: *ref_1 get: description: Gets a single metric descriptor. operationId: monitoring.projects.metricDescriptors.get @@ -5605,7 +5636,7 @@ paths: schema: type: string /v3/projects/{projectsId}/timeSeries: - parameters: *ref_31 + parameters: *ref_1 get: description: Lists time series that match a filter. operationId: monitoring.projects.timeSeries.list @@ -5741,7 +5772,7 @@ paths: schema: type: string /v3/projects/{projectsId}/timeSeries:createService: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Creates or adds data to one or more service time series. A service time @@ -5784,9 +5815,13 @@ paths: schema: type: string /v3/projects/{projectsId}/timeSeries:query: - parameters: *ref_31 + parameters: *ref_1 post: - description: Queries time series using Monitoring Query Language. + description: >- + Queries time series by using Monitoring Query Language (MQL). We + recommend using PromQL instead of MQL. For more information about the + status of MQL, see the MQL deprecation notice + (https://cloud.google.com/stackdriver/docs/deprecations/mql). operationId: monitoring.projects.timeSeries.query requestBody: content: @@ -5820,7 +5855,7 @@ paths: schema: type: string /v3/projects/{projectsId}/collectdTimeSeries: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Cloud Monitoring Agent only: Creates a new time series.This method is @@ -5859,7 +5894,7 @@ paths: schema: type: string /v3/projects/{projectsId}/alertPolicies: - parameters: *ref_31 + parameters: *ref_1 get: description: Lists the existing alerting policies for the workspace. operationId: monitoring.projects.alertPolicies.list @@ -5941,7 +5976,7 @@ paths: schema: type: string /v3/projects/{projectsId}/alertPolicies/{alertPoliciesId}: - parameters: *ref_31 + parameters: *ref_1 get: description: Gets a single alerting policy. operationId: monitoring.projects.alertPolicies.get @@ -6058,7 +6093,7 @@ paths: type: string format: google-fieldmask /v3/projects/{projectsId}/groups: - parameters: *ref_31 + parameters: *ref_1 get: description: Lists the existing groups. operationId: monitoring.projects.groups.list @@ -6144,7 +6179,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/groups/{groupsId}: - parameters: *ref_31 + parameters: *ref_1 get: description: Gets a single group. operationId: monitoring.projects.groups.get @@ -6255,7 +6290,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/groups/{groupsId}/members: - parameters: *ref_31 + parameters: *ref_1 get: description: Lists the monitored resources that are members of a group. operationId: monitoring.projects.groups.members.list @@ -6314,7 +6349,7 @@ paths: type: string format: google-datetime /v3/projects/{projectsId}/notificationChannelDescriptors: - parameters: *ref_31 + parameters: *ref_1 get: description: >- Lists the descriptors for supported channel types. The use of @@ -6358,7 +6393,7 @@ paths: schema: type: string /v3/projects/{projectsId}/notificationChannelDescriptors/{notificationChannelDescriptorsId}: - parameters: *ref_31 + parameters: *ref_1 get: description: >- Gets a single channel descriptor. The descriptor indicates which fields @@ -6396,7 +6431,7 @@ paths: schema: type: string /v3/projects/{projectsId}/notificationChannels: - parameters: *ref_31 + parameters: *ref_1 get: description: >- Lists the notification channels that have been created for the project. @@ -6483,7 +6518,7 @@ paths: schema: type: string /v3/projects/{projectsId}/notificationChannels/{notificationChannelsId}: - parameters: *ref_31 + parameters: *ref_1 get: description: >- Gets a single notification channel. The channel includes the relevant @@ -6607,7 +6642,7 @@ paths: schema: type: boolean /v3/projects/{projectsId}/notificationChannels/{notificationChannelsId}:sendVerificationCode: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Causes a verification code to be delivered to the channel. The code can @@ -6647,7 +6682,7 @@ paths: schema: type: string /v3/projects/{projectsId}/notificationChannels/{notificationChannelsId}:getVerificationCode: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Requests a verification code for an already verified channel that can @@ -6706,7 +6741,7 @@ paths: schema: type: string /v3/projects/{projectsId}/notificationChannels/{notificationChannelsId}:verify: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Verifies a NotificationChannel by proving receipt of the code delivered @@ -6746,7 +6781,7 @@ paths: schema: type: string /v3/projects/{projectsId}/snoozes: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Creates a Snooze that will prevent alerts, which match the provided @@ -6825,7 +6860,7 @@ paths: schema: type: string /v3/projects/{projectsId}/snoozes/{snoozesId}: - parameters: *ref_31 + parameters: *ref_1 get: description: Retrieves a Snooze by name. operationId: monitoring.projects.snoozes.get @@ -6903,7 +6938,7 @@ paths: type: string format: google-fieldmask /v3/projects/{projectsId}/uptimeCheckConfigs: - parameters: *ref_31 + parameters: *ref_1 get: description: >- Lists the existing valid Uptime check configurations for the project @@ -6979,7 +7014,7 @@ paths: schema: type: string /v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}: - parameters: *ref_31 + parameters: *ref_1 get: description: Gets a single Uptime check configuration. operationId: monitoring.projects.uptimeCheckConfigs.get @@ -7092,7 +7127,7 @@ paths: schema: type: string /v3/organizations/{organizationsId}/timeSeries: - parameters: *ref_31 + parameters: *ref_1 get: description: Lists time series that match a filter. operationId: monitoring.organizations.timeSeries.list @@ -7188,7 +7223,7 @@ paths: schema: type: string /v3/folders/{foldersId}/timeSeries: - parameters: *ref_31 + parameters: *ref_1 get: description: Lists time series that match a filter. operationId: monitoring.folders.timeSeries.list @@ -7284,7 +7319,7 @@ paths: schema: type: string /v3/{parentType}/{parent}/services: - parameters: *ref_31 + parameters: *ref_1 post: description: Create a Service. operationId: monitoring.services.create @@ -7372,7 +7407,7 @@ paths: schema: type: string /v3/{name}: - parameters: *ref_31 + parameters: *ref_1 get: description: Get a ServiceLevelObjective by name. operationId: monitoring.services.serviceLevelObjectives.get @@ -7467,7 +7502,7 @@ paths: schema: type: string /v3/{parentType}/{parent}/serviceLevelObjectives: - parameters: *ref_31 + parameters: *ref_1 post: description: Create a ServiceLevelObjective for the given Service. operationId: monitoring.services.serviceLevelObjectives.create @@ -7559,7 +7594,7 @@ paths: schema: type: string /v3/uptimeCheckIps: - parameters: *ref_31 + parameters: *ref_1 get: description: Returns the list of IP addresses that checkers run from. operationId: monitoring.uptimeCheckIps.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml index 1b3e4946..0ec5c88c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkconnectivity.yaml @@ -7,8 +7,8 @@ info: title: Network Connectivity API description: This API enables connectivity with and between Google Cloud resources. version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240807' + x-generated-date: '2024-09-13' externalDocs: url: >- https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest @@ -297,11 +297,16 @@ components: - >- Service Connection Policy limit reached for this network and Service Class + - >- + The consumer instance project is not in + AllowedGoogleProducersResourceHierarchyLevels of the matching + ServiceConnectionPolicy. enum: - STATE_UNSPECIFIED - VALID - CONNECTION_POLICY_MISSING - POLICY_LIMIT_REACHED + - CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED producerInstanceId: description: Immutable. An immutable identifier for the producer instance. type: string @@ -314,6 +319,15 @@ components: type: object additionalProperties: type: string + consumerInstanceProject: + description: >- + Required. The project ID or project number of the consumer project. + This project is the one that the consumer uses to interact with the + producer instance. From the perspective of a consumer who's created + a producer instance, this is the project of the producer instance. + Format: 'projects/' Eg. 'projects/consumer-project' or + 'projects/1234' + type: string ConsumerPscConnection: id: ConsumerPscConnection description: PSC connection details on consumer side. @@ -510,9 +524,9 @@ components: The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service - Producer. Google services have a prefix of gcp. For example, - gcp-cloud-sql. 3rd party services do not. For example, - test-service-a3dfcx. + Producer. Google services have a prefix of gcp or google-cloud. For + example, gcp-memorystore-redis or google-cloud-sql. 3rd party + services do not. For example, test-service-a3dfcx. type: string infrastructure: description: >- @@ -564,6 +578,45 @@ components: description: Optional. Max number of PSC connections for this policy. type: string format: int64 + producerInstanceLocation: + description: >- + Required. ProducerInstanceLocation is used to specify which + authorization mechanism to use to determine which projects the + Producer instance can be within. + type: string + enumDescriptions: + - >- + Producer instance location is not specified. When this option is + chosen, then the PSC connections created by this + ServiceConnectionPolicy must be within the same project as the + Producer instance. This is the default ProducerInstanceLocation + value. To allow for PSC connections from this network to other + networks, use the CUSTOM_RESOURCE_HIERARCHY_LEVELS option. + - >- + Producer instance must be within one of the values provided in + allowed_google_producers_resource_hierarchy_level. + enum: + - PRODUCER_INSTANCE_LOCATION_UNSPECIFIED + - CUSTOM_RESOURCE_HIERARCHY_LEVELS + allowedGoogleProducersResourceHierarchyLevel: + description: >- + Optional. List of Projects, Folders, or Organizations from where the + Producer instance can be within. For example, a network + administrator can provide both 'organizations/foo' and + 'projects/bar' as + allowed_google_producers_resource_hierarchy_levels. This allowlists + this network to connect with any Producer instance within the 'foo' + organization or the 'bar' project. By default, + allowed_google_producers_resource_hierarchy_level is empty. The + format for each allowed_google_producers_resource_hierarchy_level is + / where is one of 'projects', 'folders', or 'organizations' and is + either the ID or the number of the resource type. Format for each + allowed_google_producers_resource_hierarchy_level value: 'projects/' + or 'folders/' or 'organizations/' Eg. [projects/my-project-id, + projects/567, folders/891, organizations/123] + type: array + items: + type: string PscConnection: id: PscConnection description: Information about a specific Private Service Connect connection. @@ -1249,6 +1302,14 @@ components: description: Output only. The VPC network where these VPN tunnels are located. readOnly: true type: string + includeImportRanges: + description: >- + Optional. IP ranges allowed to be included during import from + hub.(does not control transit connectivity) The only allowed value + for now is "ALL_IPV4_RANGES". + type: array + items: + type: string LinkedInterconnectAttachments: id: LinkedInterconnectAttachments description: >- @@ -1275,6 +1336,14 @@ components: located. readOnly: true type: string + includeImportRanges: + description: >- + Optional. IP ranges allowed to be included during import from + hub.(does not control transit connectivity) The only allowed value + for now is "ALL_IPV4_RANGES". + type: array + items: + type: string LinkedRouterApplianceInstances: id: LinkedRouterApplianceInstances description: >- @@ -1301,6 +1370,14 @@ components: are located. readOnly: true type: string + includeImportRanges: + description: >- + Optional. IP ranges allowed to be included during import from + hub.(does not control transit connectivity) The only allowed value + for now is "ALL_IPV4_RANGES". + type: array + items: + type: string RouterApplianceInstance: id: RouterApplianceInstance description: >- @@ -1331,6 +1408,20 @@ components: type: array items: type: string + includeExportRanges: + description: Optional. IP ranges allowed to be included from peering. + type: array + items: + type: string + producerVpcSpokes: + description: >- + Output only. The list of Producer VPC spokes that this VPC spoke is + a service consumer VPC spoke for. These producer VPCs are connected + through VPC peering to this spoke's backing VPC network. + readOnly: true + type: array + items: + type: string StateReason: id: StateReason description: The reason a spoke is inactive. @@ -2874,16 +2965,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2896,23 +2984,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.networkconnectivity.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2940,6 +3026,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' service_connection_maps: @@ -2947,17 +3034,14 @@ components: name: service_connection_maps title: Service_connection_maps methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceConnectionMaps/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceConnectionMaps - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -2998,6 +3082,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/service_connection_maps/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/service_connection_maps/methods/delete @@ -3013,17 +3098,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceConnectionMaps~1{serviceConnectionMapsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -3037,23 +3119,23 @@ components: #/components/x-stackQL-resources/service_connection_maps_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/service_connection_maps_iam_policies/methods/set_iam_policy delete: [] service_connection_policies: id: google.networkconnectivity.service_connection_policies name: service_connection_policies title: Service_connection_policies methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceConnectionPolicies/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceConnectionPolicies - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -3094,6 +3176,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/service_connection_policies/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/service_connection_policies/methods/delete @@ -3109,17 +3192,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceConnectionPolicies~1{serviceConnectionPoliciesId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -3133,23 +3213,23 @@ components: #/components/x-stackQL-resources/service_connection_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/service_connection_policies_iam_policies/methods/set_iam_policy delete: [] service_classes: id: google.networkconnectivity.service_classes name: service_classes title: Service_classes methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceClasses/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceClasses - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -3178,6 +3258,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/service_classes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/service_classes/methods/delete' service_classes_iam_policies: @@ -3192,17 +3273,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_15 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceClasses~1{serviceClassesId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_15 - response: *ref_16 test_iam_permissions: operation: $ref: >- @@ -3216,6 +3294,9 @@ components: #/components/x-stackQL-resources/service_classes_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/service_classes_iam_policies/methods/set_iam_policy delete: [] service_connection_tokens: id: google.networkconnectivity.service_connection_tokens @@ -3236,17 +3317,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceConnectionTokens/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceConnectionTokens - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: >- @@ -3264,6 +3342,7 @@ components: - $ref: >- #/components/x-stackQL-resources/service_connection_tokens/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/service_connection_tokens/methods/delete @@ -3272,16 +3351,13 @@ components: name: hubs title: Hubs methods: - _list: - operation: &ref_19 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.hubs - list: - operation: *ref_19 - response: *ref_20 create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs/post' @@ -3331,6 +3407,7 @@ components: - $ref: '#/components/x-stackQL-resources/hubs/methods/create' update: - $ref: '#/components/x-stackQL-resources/hubs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/hubs/methods/delete' spokes: @@ -3338,28 +3415,22 @@ components: name: spokes title: Spokes methods: - _list_spokes: - operation: &ref_21 + list_spokes: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}:listSpokes/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.spokes - list_spokes: - operation: *ref_21 - response: *ref_22 - _list: - operation: &ref_23 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1spokes/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.spokes - list: - operation: *ref_23 - response: *ref_24 create: operation: $ref: >- @@ -3397,6 +3468,7 @@ components: - $ref: '#/components/x-stackQL-resources/spokes/methods/create' update: - $ref: '#/components/x-stackQL-resources/spokes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/spokes/methods/delete' hubs_iam_policies: @@ -3411,17 +3483,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_25 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}:getIamPolicy/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_25 - response: *ref_26 test_iam_permissions: operation: $ref: >- @@ -3435,6 +3504,9 @@ components: #/components/x-stackQL-resources/hubs_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/hubs_iam_policies/methods/set_iam_policy delete: [] route_tables: id: google.networkconnectivity.route_tables @@ -3448,23 +3520,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_27 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}~1routeTables/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.routeTables - list: - operation: *ref_27 - response: *ref_28 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/route_tables/methods/get' - $ref: '#/components/x-stackQL-resources/route_tables/methods/list' insert: [] update: [] + replace: [] delete: [] routes: id: google.networkconnectivity.routes @@ -3478,23 +3548,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_29 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}~1routeTables~1{routeTablesId}~1routes/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.routes - list: - operation: *ref_29 - response: *ref_30 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/routes/methods/get' - $ref: '#/components/x-stackQL-resources/routes/methods/list' insert: [] update: [] + replace: [] delete: [] groups: id: google.networkconnectivity.groups @@ -3515,17 +3583,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_31 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}~1groups/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.groups - list: - operation: *ref_31 - response: *ref_32 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/groups/methods/get' @@ -3533,6 +3598,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: [] delete: [] groups_iam_policies: id: google.networkconnectivity.groups_iam_policies @@ -3546,17 +3612,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_33 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1hubs~1{hubsId}~1groups~1{groupsId}:getIamPolicy/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_33 - response: *ref_34 test_iam_permissions: operation: $ref: >- @@ -3570,23 +3633,23 @@ components: #/components/x-stackQL-resources/groups_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/groups_iam_policies/methods/set_iam_policy delete: [] policy_based_routes: id: google.networkconnectivity.policy_based_routes name: policy_based_routes title: Policy_based_routes methods: - _list: - operation: &ref_35 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1policyBasedRoutes/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policyBasedRoutes - list: - operation: *ref_35 - response: *ref_36 create: operation: $ref: >- @@ -3616,6 +3679,7 @@ components: - $ref: >- #/components/x-stackQL-resources/policy_based_routes/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/policy_based_routes/methods/delete @@ -3631,17 +3695,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_37 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1policyBasedRoutes~1{policyBasedRoutesId}:getIamPolicy/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_37 - response: *ref_38 test_iam_permissions: operation: $ref: >- @@ -3655,6 +3716,9 @@ components: #/components/x-stackQL-resources/policy_based_routes_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/policy_based_routes_iam_policies/methods/set_iam_policy delete: [] spokes_iam_policies: id: google.networkconnectivity.spokes_iam_policies @@ -3668,17 +3732,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_39 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1spokes~1{spokesId}:getIamPolicy/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_39 - response: *ref_40 test_iam_permissions: operation: $ref: >- @@ -3692,23 +3753,23 @@ components: #/components/x-stackQL-resources/spokes_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/spokes_iam_policies/methods/set_iam_policy delete: [] internal_ranges: id: google.networkconnectivity.internal_ranges name: internal_ranges title: Internal_ranges methods: - _list: - operation: &ref_41 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1internalRanges/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.internalRanges - list: - operation: *ref_41 - response: *ref_42 create: operation: $ref: >- @@ -3745,6 +3806,7 @@ components: - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/create' update: - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/internal_ranges/methods/delete' regional_endpoints: @@ -3752,17 +3814,14 @@ components: name: regional_endpoints title: Regional_endpoints methods: - _list: - operation: &ref_43 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1regionalEndpoints/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.regionalEndpoints - list: - operation: *ref_43 - response: *ref_44 create: operation: $ref: >- @@ -3791,11 +3850,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/regional_endpoints/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/regional_endpoints/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_45 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3842,7 +3902,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets information about a location. operationId: networkconnectivity.projects.locations.get @@ -3870,7 +3930,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3913,7 +3973,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3984,7 +4044,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4031,7 +4091,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists ServiceConnectionMaps in a given project and location. operationId: networkconnectivity.projects.locations.serviceConnectionMaps.list @@ -4115,7 +4175,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single ServiceConnectionMap. operationId: networkconnectivity.projects.locations.serviceConnectionMaps.get @@ -4232,7 +4292,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4274,7 +4334,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4315,7 +4375,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4359,7 +4419,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists ServiceConnectionPolicies in a given project and location. operationId: networkconnectivity.projects.locations.serviceConnectionPolicies.list @@ -4443,7 +4503,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single ServiceConnectionPolicy. operationId: networkconnectivity.projects.locations.serviceConnectionPolicies.get @@ -4560,7 +4620,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4602,7 +4662,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4643,7 +4703,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4687,7 +4747,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceClasses: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists ServiceClasses in a given project and location. operationId: networkconnectivity.projects.locations.serviceClasses.list @@ -4732,7 +4792,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single ServiceClass. operationId: networkconnectivity.projects.locations.serviceClasses.get @@ -4849,7 +4909,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4890,7 +4950,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4930,7 +4990,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4973,7 +5033,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens/{serviceConnectionTokensId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single ServiceConnectionToken. operationId: networkconnectivity.projects.locations.serviceConnectionTokens.get @@ -5045,7 +5105,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionTokens: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists ServiceConnectionTokens in a given project and location. operationId: networkconnectivity.projects.locations.serviceConnectionTokens.list @@ -5129,7 +5189,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Lists the Network Connectivity Center hubs associated with a given @@ -5205,7 +5265,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details about a Network Connectivity Center hub. operationId: networkconnectivity.projects.locations.global.hubs.get @@ -5305,7 +5365,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:listSpokes: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Lists the Network Connectivity Center spokes associated with a specified @@ -5361,7 +5421,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:rejectSpoke: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Rejects a Network Connectivity Center spoke from being attached to a @@ -5398,7 +5458,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:acceptSpoke: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Accepts a proposal to attach a Network Connectivity Center spoke to a @@ -5433,7 +5493,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5469,7 +5529,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5504,7 +5564,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/global/hubs/{hubsId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5542,7 +5602,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details about a Network Connectivity Center route table. operationId: networkconnectivity.projects.locations.global.hubs.routeTables.get @@ -5575,7 +5635,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists route tables in a given hub. operationId: networkconnectivity.projects.locations.global.hubs.routeTables.list @@ -5620,7 +5680,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}/routes/{routesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details about the specified route. operationId: >- @@ -5659,7 +5719,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}/routes: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists routes in a given route table. operationId: >- @@ -5710,7 +5770,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details about a Network Connectivity Center group. operationId: networkconnectivity.projects.locations.global.hubs.groups.get @@ -5788,7 +5848,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists groups in a given hub. operationId: networkconnectivity.projects.locations.global.hubs.groups.list @@ -5833,7 +5893,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5874,7 +5934,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5914,7 +5974,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/global/hubs/{hubsId}/groups/{groupsId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5958,7 +6018,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/policyBasedRoutes: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists policy-based routes in a given project and location. operationId: networkconnectivity.projects.locations.global.policyBasedRoutes.list @@ -6032,7 +6092,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single policy-based route. operationId: networkconnectivity.projects.locations.global.policyBasedRoutes.get @@ -6090,7 +6150,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6127,7 +6187,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6163,7 +6223,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6202,7 +6262,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/spokes: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Lists the Network Connectivity Center spokes in a specified project and @@ -6288,7 +6348,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details about a Network Connectivity Center spoke. operationId: networkconnectivity.projects.locations.spokes.get @@ -6401,7 +6461,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6442,7 +6502,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6482,7 +6542,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6525,7 +6585,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/internalRanges: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists internal ranges in a given project and location. operationId: networkconnectivity.projects.locations.internalRanges.list @@ -6609,7 +6669,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single internal range. operationId: networkconnectivity.projects.locations.internalRanges.get @@ -6722,7 +6782,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/regionalEndpoints: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists RegionalEndpoints in a given project and location. operationId: networkconnectivity.projects.locations.regionalEndpoints.list @@ -6806,7 +6866,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/regionalEndpoints/{regionalEndpointsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single RegionalEndpoint. operationId: networkconnectivity.projects.locations.regionalEndpoints.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml index 6a3234ff..dae788ef 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkmanagement.yaml @@ -9,8 +9,8 @@ info: The Network Management API provides a collection of network performance monitoring and diagnostic capabilities. version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/ servers: @@ -649,6 +649,12 @@ components: Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information. + - >- + Initial state: packet originating from a Redis instance. A + RedisInstanceInfo is populated with starting instance information. + - >- + Initial state: packet originating from a Redis Cluster. A + RedisClusterInfo is populated with starting Cluster information. - >- Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information. @@ -722,6 +728,8 @@ components: - false - false - false + - false + - false - true - true - false @@ -742,6 +750,8 @@ components: - START_FROM_PRIVATE_NETWORK - START_FROM_GKE_MASTER - START_FROM_CLOUD_SQL_INSTANCE + - START_FROM_REDIS_INSTANCE + - START_FROM_REDIS_CLUSTER - START_FROM_CLOUD_FUNCTION - START_FROM_APP_ENGINE_VERSION - START_FROM_CLOUD_RUN_REVISION @@ -831,6 +841,12 @@ components: cloudSqlInstance: description: Display information of a Cloud SQL instance. $ref: '#/components/schemas/CloudSQLInstanceInfo' + redisInstance: + description: Display information of a Redis Instance. + $ref: '#/components/schemas/RedisInstanceInfo' + redisCluster: + description: Display information of a Redis Cluster. + $ref: '#/components/schemas/RedisClusterInfo' cloudFunction: description: Display information of a Cloud Function. $ref: '#/components/schemas/CloudFunctionInfo' @@ -891,22 +907,27 @@ components: description: Service account authorized for the instance. deprecated: true type: string + pscNetworkAttachmentUri: + description: >- + URI of the PSC network attachment the NIC is attached to (if + relevant). + type: string FirewallInfo: id: FirewallInfo description: >- For display only. Metadata associated with a VPC firewall rule, an - implied VPC firewall rule, or a hierarchical firewall policy rule. + implied VPC firewall rule, or a firewall policy rule. type: object properties: displayName: description: >- - The display name of the VPC firewall rule. This field is not - applicable to hierarchical firewall policy rules. + The display name of the firewall rule. This field might be empty for + firewall policy rules. type: string uri: description: >- - The URI of the VPC firewall rule. This field is not applicable to - implied firewall rules or hierarchical firewall policy rules. + The URI of the firewall rule. This field is not applicable to + implied VPC firewall rules. type: string direction: description: 'Possible values: INGRESS, EGRESS' @@ -927,7 +948,7 @@ components: targetTags: description: >- The target tags defined by the VPC firewall rule. This field is not - applicable to hierarchical firewall policy rules. + applicable to firewall policy rules. type: array items: type: string @@ -938,8 +959,15 @@ components: type: string policy: description: >- - The hierarchical firewall policy that this rule is associated with. - This field is not applicable to VPC firewall rules. + The name of the firewall policy that this rule is associated with. + This field is not applicable to VPC firewall rules and implied VPC + firewall rules. + type: string + policyUri: + description: >- + The URI of the firewall policy that this rule is associated with. + This field is not applicable to VPC firewall rules and implied VPC + firewall rules. type: string firewallRuleType: description: The firewall rule's type. @@ -1325,6 +1353,8 @@ components: traces. - Target is a Cloud Run revision. Used only for return traces. - Target is a Google-managed service. Used only for return traces. + - Target is a Redis Instance. + - Target is a Redis Cluster. enum: - TARGET_UNSPECIFIED - INSTANCE @@ -1342,6 +1372,8 @@ components: - APP_ENGINE_VERSION - CLOUD_RUN_REVISION - GOOGLE_MANAGED_SERVICE + - REDIS_INSTANCE + - REDIS_CLUSTER resourceUri: description: URI of the resource that the packet is delivered to. type: string @@ -1491,6 +1523,12 @@ components: - >- Aborted because tests with a PSC-based Cloud SQL instance as a source are not supported. + - >- + Aborted because tests with a Redis Cluster as a source are not + supported. + - >- + Aborted because tests with a Redis Instance as a source are not + supported. - >- Aborted because tests with a forwarding rule as a source are not supported. @@ -1535,6 +1573,8 @@ components: - false - false - false + - false + - false enum: - CAUSE_UNSPECIFIED - UNKNOWN_NETWORK @@ -1565,6 +1605,8 @@ components: - ROUTE_CONFIG_NOT_FOUND - GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT - SOURCE_PSC_CLOUD_SQL_UNSUPPORTED + - SOURCE_REDIS_CLUSTER_UNSUPPORTED + - SOURCE_REDIS_INSTANCE_UNSUPPORTED - SOURCE_FORWARDING_RULE_UNSUPPORTED - NON_ROUTABLE_IP_ADDRESS - UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT @@ -1668,6 +1710,12 @@ components: - >- Packet sent from or to a Cloud SQL instance that is not in running state. + - >- + Packet sent from or to a Redis Instance that is not in running + state. + - >- + Packet sent from or to a Redis Cluster that is not in running + state. - >- The type of traffic is blocked and the user cannot configure a firewall rule to enable it. See [Always blocked @@ -1717,6 +1765,10 @@ components: - >- Packet was dropped because there is no route from a Cloud SQL instance to a destination network. + - >- + Packet was dropped because the Cloud SQL instance requires all + connections to use Cloud SQL connectors and to target the Cloud + SQL proxy port (3307). - >- Packet could be dropped because the Cloud Function is not in an active status. @@ -1753,6 +1805,9 @@ components: endpoint group) targeting a Cloud SQL service attachment, but this configuration is not supported. - No NAT subnets are defined for the PSC service attachment. + - >- + PSC endpoint is accessed via NCC, but PSC transitivity + configuration is not yet propagated. - >- The packet sent from the hybrid NEG proxy matches a non-dynamic route, but such a configuration is not supported. @@ -1772,6 +1827,36 @@ components: - >- Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces. + - >- + Packet is dropped due to a load balancer backend instance not + having a network interface in the network expected by the load + balancer. + - >- + Packet is dropped due to a backend service named port not being + defined on the instance group level. + - >- + Packet is dropped due to a destination IP range being part of a + Private NAT IP range. + - >- + Generic drop cause for a packet being dropped inside a Redis + Instance service project. + - >- + Packet is dropped due to an unsupported port being used to connect + to a Redis Instance. Port 6379 should be used to connect to a + Redis Instance. + - >- + Packet is dropped due to connecting from PUPI address to a PSA + based Redis Instance. + - Packet is dropped due to no route to the destination network. + - Redis Instance does not have an external IP address. + - >- + Generic drop cause for a packet being dropped inside a Redis + Cluster service project. + - >- + Packet is dropped due to an unsupported port being used to connect + to a Redis Cluster. Ports 6379 and 11000 to 13047 should be used + to connect to a Redis Cluster. + - Redis Cluster does not have an external IP address. enum: - CAUSE_UNSPECIFIED - UNKNOWN_EXTERNAL_ADDRESS @@ -1801,6 +1886,8 @@ components: - INSTANCE_NOT_RUNNING - GKE_CLUSTER_NOT_RUNNING - CLOUD_SQL_INSTANCE_NOT_RUNNING + - REDIS_INSTANCE_NOT_RUNNING + - REDIS_CLUSTER_NOT_RUNNING - TRAFFIC_TYPE_BLOCKED - GKE_MASTER_UNAUTHORIZED_ACCESS - CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS @@ -1816,6 +1903,7 @@ components: - CLOUD_SQL_INSTANCE_NOT_CONFIGURED_FOR_EXTERNAL_TRAFFIC - PUBLIC_CLOUD_SQL_INSTANCE_TO_PRIVATE_DESTINATION - CLOUD_SQL_INSTANCE_NO_ROUTE + - CLOUD_SQL_CONNECTOR_REQUIRED - CLOUD_FUNCTION_NOT_ACTIVE - VPC_CONNECTOR_NOT_SET - VPC_CONNECTOR_NOT_RUNNING @@ -1828,6 +1916,7 @@ components: - PSC_NEG_PRODUCER_FORWARDING_RULE_MULTIPLE_PORTS - CLOUD_SQL_PSC_NEG_UNSUPPORTED - NO_NAT_SUBNETS_FOR_PSC_SERVICE_ATTACHMENT + - PSC_TRANSITIVITY_NOT_PROPAGATED - HYBRID_NEG_NON_DYNAMIC_ROUTE_MATCHED - HYBRID_NEG_NON_LOCAL_DYNAMIC_ROUTE_MATCHED - CLOUD_RUN_REVISION_NOT_READY @@ -1836,6 +1925,17 @@ components: - CLOUD_NAT_NO_ADDRESSES - ROUTING_LOOP - DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE + - LOAD_BALANCER_BACKEND_INVALID_NETWORK + - BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED + - DESTINATION_IS_PRIVATE_NAT_IP_RANGE + - DROPPED_INSIDE_REDIS_INSTANCE_SERVICE + - REDIS_INSTANCE_UNSUPPORTED_PORT + - REDIS_INSTANCE_CONNECTING_FROM_PUPI_ADDRESS + - REDIS_INSTANCE_NO_ROUTE_TO_DESTINATION_NETWORK + - REDIS_INSTANCE_NO_EXTERNAL_IP + - DROPPED_INSIDE_REDIS_CLUSTER_SERVICE + - REDIS_CLUSTER_UNSUPPORTED_PORT + - REDIS_CLUSTER_NO_EXTERNAL_IP resourceUri: description: URI of the resource that caused the drop. type: string @@ -2001,6 +2101,58 @@ components: region: description: Region in which the Cloud SQL instance is running. type: string + RedisInstanceInfo: + id: RedisInstanceInfo + description: For display only. Metadata associated with a Cloud Redis Instance. + type: object + properties: + displayName: + description: Name of a Cloud Redis Instance. + type: string + uri: + description: URI of a Cloud Redis Instance. + type: string + networkUri: + description: URI of a Cloud Redis Instance network. + type: string + primaryEndpointIp: + description: Primary endpoint IP address of a Cloud Redis Instance. + type: string + readEndpointIp: + description: Read endpoint IP address of a Cloud Redis Instance (if applicable). + type: string + region: + description: Region in which the Cloud Redis Instance is defined. + type: string + RedisClusterInfo: + id: RedisClusterInfo + description: For display only. Metadata associated with a Redis Cluster. + type: object + properties: + displayName: + description: Name of a Redis Cluster. + type: string + uri: + description: >- + URI of a Redis Cluster in format + "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + type: string + networkUri: + description: >- + URI of a Redis Cluster network in format + "projects/{project_id}/global/networks/{network_id}". + type: string + discoveryEndpointIpAddress: + description: Discovery endpoint IP address of a Redis Cluster. + type: string + secondaryEndpointIpAddress: + description: Secondary endpoint IP address of a Redis Cluster. + type: string + location: + description: >- + Name of the region in which the Redis Cluster is defined. For + example, "us-central1". + type: string CloudFunctionInfo: id: CloudFunctionInfo description: For display only. Metadata associated with a Cloud Function. @@ -2834,16 +2986,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2856,23 +3005,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.networkmanagement.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2900,6 +3047,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' connectivity_tests: @@ -2907,17 +3055,14 @@ components: name: connectivity_tests title: Connectivity_tests methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1connectivityTests/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resources - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -2961,6 +3106,7 @@ components: - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/create' update: - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/connectivity_tests/methods/delete' connectivity_tests_iam_policies: @@ -2975,17 +3121,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1global~1connectivityTests~1{connectivityTestsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2999,10 +3142,13 @@ components: #/components/x-stackQL-resources/connectivity_tests_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/connectivity_tests_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3049,7 +3195,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: networkmanagement.projects.locations.get @@ -3077,7 +3223,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3115,7 +3261,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3176,7 +3322,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/operations/{operationsId}:cancel: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3218,7 +3364,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/connectivityTests: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists all Connectivity Tests owned by a project. operationId: networkmanagement.projects.locations.global.connectivityTests.list @@ -3298,7 +3444,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the details of a specific Connectivity Test. operationId: networkmanagement.projects.locations.global.connectivityTests.get @@ -3399,7 +3545,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:rerun: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Rerun an existing `ConnectivityTest`. After the user triggers the rerun, @@ -3441,7 +3587,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3478,7 +3624,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3514,7 +3660,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/global/connectivityTests/{connectivityTestsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml b/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml index 65b46e24..84998b76 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networksecurity.yaml @@ -7,8 +7,8 @@ info: title: Network Security API description: '' version: v1 - x-discovery-doc-revision: '20240510' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240828' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/networking servers: @@ -220,6 +220,21 @@ components: description: Output only. Server-defined fully-qualified URL for this resource. readOnly: true type: string + purpose: + description: Optional. List of supported purposes of the Address Group. + type: array + items: + type: string + enumDescriptions: + - Default value. Should never happen. + - >- + Address Group is distributed to VMC, and is usable in Firewall + Policies and other systems that rely on VMC. + - Address Group is usable in Cloud Armor. + enum: + - PURPOSE_UNSPECIFIED + - DEFAULT + - CLOUD_ARMOR AddAddressGroupItemsRequest: id: AddAddressGroupItemsRequest description: Request used by the AddAddressGroupItems method. @@ -491,12 +506,14 @@ components: - Active and ready for traffic. - Being deleted. - Down or in an error state. + - The GCP project that housed the association has been deleted. enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - DELETING - INACTIVE + - ORPHAN network: description: Required. The URL of the network that is being associated. type: string @@ -730,11 +747,11 @@ components: authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by - external HTTPS load balancers can be attached only to TargetHttpsProxy - with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic - Director compatible ServerTlsPolicies can be attached to EndpointPolicy - and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load - balancing scheme. + Application Load Balancers can be attached only to TargetHttpsProxy with + an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing + scheme. Traffic Director compatible ServerTlsPolicies can be attached to + EndpointPolicy and TargetHttpsProxy with Traffic Director + `INTERNAL_SELF_MANAGED` load balancing scheme. type: object properties: name: @@ -764,10 +781,10 @@ components: allowOpen: description: >- This field applies only for Traffic Director policies. It is must be - set to false for external HTTPS load balancer policies. Determines - if server allows plaintext connections. If set to true, server - allows plain text connections. By default, it is set to false. This - setting is not exclusive of other encryption modes. For example, if + set to false for Application Load Balancer policies. Determines if + server allows plaintext connections. If set to true, server allows + plain text connections. By default, it is set to false. This setting + is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to @@ -776,21 +793,21 @@ components: type: boolean serverCertificate: description: >- - Optional if policy is to be used with Traffic Director. For external - HTTPS load balancer must be empty. Defines a mechanism to provision - server identity (public and private keys). Cannot be combined with - `allow_open` as a permissive mode that allows both plain text and - TLS is not supported. + Optional if policy is to be used with Traffic Director. For + Application Load Balancers must be empty. Defines a mechanism to + provision server identity (public and private keys). Cannot be + combined with `allow_open` as a permissive mode that allows both + plain text and TLS is not supported. $ref: '#/components/schemas/GoogleCloudNetworksecurityV1CertificateProvider' mtlsPolicy: description: >- - This field is required if the policy is used with external HTTPS - load balancers. This field can be empty for Traffic Director. - Defines a mechanism to provision peer validation certificates for - peer to peer authentication (Mutual TLS - mTLS). If not specified, - client certificate will not be requested. The connection is treated - as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, - server allows both plain text and mTLS connections. + This field is required if the policy is used with Application Load + Balancers. This field can be empty for Traffic Director. Defines a + mechanism to provision peer validation certificates for peer to peer + authentication (Mutual TLS - mTLS). If not specified, client + certificate will not be requested. The connection is treated as TLS + and not mTLS. If `allow_open` and `mtls_policy` are set, server + allows both plain text and mTLS connections. $ref: '#/components/schemas/MTLSPolicy' GoogleCloudNetworksecurityV1CertificateProvider: id: GoogleCloudNetworksecurityV1CertificateProvider @@ -847,8 +864,8 @@ components: When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used - with the external HTTPS load balancing. For Traffic Director it must - be empty. + with the Application Load Balancers. For Traffic Director it must be + empty. type: string enumDescriptions: - Not allowed. @@ -872,9 +889,9 @@ components: clientValidationCa: description: >- Required if the policy is to be used with Traffic Director. For - external HTTPS load balancers it must be empty. Defines the - mechanism to obtain the Certificate Authority certificate to - validate the client certificate. + Application Load Balancers it must be empty. Defines the mechanism + to obtain the Certificate Authority certificate to validate the + client certificate. type: array items: $ref: '#/components/schemas/ValidationCA' @@ -883,7 +900,7 @@ components: Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed - only if the policy is to be used with external HTTPS load balancers. + only if the policy is to be used with Application Load Balancers. type: string ValidationCA: id: ValidationCA @@ -1326,7 +1343,7 @@ components: id: SecurityProfileGroup description: >- SecurityProfileGroup is a resource that defines the behavior for various - ProfileTypes. Next ID: 9 + ProfileTypes. Next ID: 11 type: object properties: name: @@ -1364,8 +1381,8 @@ components: type: string threatPreventionProfile: description: >- - Optional. Reference to a SecurityProfile with the threat prevention - configuration for the SecurityProfileGroup. + Optional. Reference to a SecurityProfile with the ThreatPrevention + configuration. type: string ListSecurityProfilesResponse: id: ListSecurityProfilesResponse @@ -1388,7 +1405,7 @@ components: id: SecurityProfile description: >- SecurityProfile is a resource that defines the behavior for one of many - ProfileTypes. Next ID: 10 + ProfileTypes. Next ID: 12 type: object properties: threatPreventionProfile: @@ -2090,16 +2107,13 @@ components: name: locations title: Locations methods: - _projects_locations_list: - operation: &ref_1 + projects_locations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 projects_locations_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2114,23 +2128,21 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] operations: id: google.networksecurity.operations name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -2152,17 +2164,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_operations_list: - operation: &ref_5 + organizations_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1operations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - organizations_locations_operations_list: - operation: *ref_5 - response: *ref_6 organizations_locations_operations_get: operation: $ref: >- @@ -2196,6 +2205,7 @@ components: #/components/x-stackQL-resources/operations/methods/organizations_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete @@ -2206,17 +2216,14 @@ components: name: address_groups title: Address_groups methods: - _projects_locations_address_groups_list: - operation: &ref_7 + projects_locations_address_groups_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.addressGroups - projects_locations_address_groups_list: - operation: *ref_7 - response: *ref_8 projects_locations_address_groups_create: operation: $ref: >- @@ -2252,17 +2259,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_address_groups_list: - operation: &ref_9 + organizations_locations_address_groups_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.addressGroups - organizations_locations_address_groups_list: - operation: *ref_9 - response: *ref_10 organizations_locations_address_groups_create: operation: $ref: >- @@ -2318,6 +2322,7 @@ components: #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_patch - $ref: >- #/components/x-stackQL-resources/address_groups/methods/organizations_locations_address_groups_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/address_groups/methods/projects_locations_address_groups_delete @@ -2358,36 +2363,39 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/projects_locations_address_groups_add_items + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/organizations_locations_address_groups_add_items update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/projects_locations_address_groups_remove_items + - $ref: >- + #/components/x-stackQL-resources/address_groups_items/methods/organizations_locations_address_groups_remove_items address_groups_references: id: google.networksecurity.address_groups_references name: address_groups_references title: Address_groups_references methods: - _projects_locations_address_groups_list_references: - operation: &ref_11 + projects_locations_address_groups_list_references: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:listReferences/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.addressGroupReferences - projects_locations_address_groups_list_references: - operation: *ref_11 - response: *ref_12 - _organizations_locations_address_groups_list_references: - operation: &ref_13 + organizations_locations_address_groups_list_references: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:listReferences/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.addressGroupReferences - organizations_locations_address_groups_list_references: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: >- @@ -2396,6 +2404,7 @@ components: #/components/x-stackQL-resources/address_groups_references/methods/organizations_locations_address_groups_list_references insert: [] update: [] + replace: [] delete: [] address_groups_iam_policies: id: google.networksecurity.address_groups_iam_policies @@ -2409,17 +2418,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_address_groups_get_iam_policy: - operation: &ref_15 + projects_locations_address_groups_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1addressGroups~1{addressGroupsId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_address_groups_get_iam_policy: - operation: *ref_15 - response: *ref_16 projects_locations_address_groups_test_iam_permissions: operation: $ref: >- @@ -2433,23 +2439,23 @@ components: #/components/x-stackQL-resources/address_groups_iam_policies/methods/projects_locations_address_groups_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/address_groups_iam_policies/methods/projects_locations_address_groups_set_iam_policy delete: [] firewall_endpoint_associations: id: google.networksecurity.firewall_endpoint_associations name: firewall_endpoint_associations title: Firewall_endpoint_associations methods: - _projects_locations_firewall_endpoint_associations_list: - operation: &ref_17 + projects_locations_firewall_endpoint_associations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1firewallEndpointAssociations/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.firewallEndpointAssociations - projects_locations_firewall_endpoint_associations_list: - operation: *ref_17 - response: *ref_18 projects_locations_firewall_endpoint_associations_create: operation: $ref: >- @@ -2490,6 +2496,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/firewall_endpoint_associations/methods/projects_locations_firewall_endpoint_associations_delete @@ -2498,17 +2505,14 @@ components: name: authorization_policies title: Authorization_policies methods: - _projects_locations_authorization_policies_list: - operation: &ref_19 + projects_locations_authorization_policies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizationPolicies/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.authorizationPolicies - projects_locations_authorization_policies_list: - operation: *ref_19 - response: *ref_20 projects_locations_authorization_policies_create: operation: $ref: >- @@ -2549,6 +2553,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/authorization_policies/methods/projects_locations_authorization_policies_delete @@ -2564,17 +2569,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_authorization_policies_get_iam_policy: - operation: &ref_21 + projects_locations_authorization_policies_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authorizationPolicies~1{authorizationPoliciesId}:getIamPolicy/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_authorization_policies_get_iam_policy: - operation: *ref_21 - response: *ref_22 projects_locations_authorization_policies_test_iam_permissions: operation: $ref: >- @@ -2588,23 +2590,23 @@ components: #/components/x-stackQL-resources/authorization_policies_iam_policies/methods/projects_locations_authorization_policies_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/authorization_policies_iam_policies/methods/projects_locations_authorization_policies_set_iam_policy delete: [] server_tls_policies: id: google.networksecurity.server_tls_policies name: server_tls_policies title: Server_tls_policies methods: - _projects_locations_server_tls_policies_list: - operation: &ref_23 + projects_locations_server_tls_policies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serverTlsPolicies/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serverTlsPolicies - projects_locations_server_tls_policies_list: - operation: *ref_23 - response: *ref_24 projects_locations_server_tls_policies_create: operation: $ref: >- @@ -2645,6 +2647,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/server_tls_policies/methods/projects_locations_server_tls_policies_delete @@ -2660,17 +2663,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_server_tls_policies_get_iam_policy: - operation: &ref_25 + projects_locations_server_tls_policies_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serverTlsPolicies~1{serverTlsPoliciesId}:getIamPolicy/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_server_tls_policies_get_iam_policy: - operation: *ref_25 - response: *ref_26 projects_locations_server_tls_policies_test_iam_permissions: operation: $ref: >- @@ -2684,23 +2684,23 @@ components: #/components/x-stackQL-resources/server_tls_policies_iam_policies/methods/projects_locations_server_tls_policies_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/server_tls_policies_iam_policies/methods/projects_locations_server_tls_policies_set_iam_policy delete: [] client_tls_policies: id: google.networksecurity.client_tls_policies name: client_tls_policies title: Client_tls_policies methods: - _projects_locations_client_tls_policies_list: - operation: &ref_27 + projects_locations_client_tls_policies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientTlsPolicies/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clientTlsPolicies - projects_locations_client_tls_policies_list: - operation: *ref_27 - response: *ref_28 projects_locations_client_tls_policies_create: operation: $ref: >- @@ -2741,6 +2741,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/client_tls_policies/methods/projects_locations_client_tls_policies_delete @@ -2756,17 +2757,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_client_tls_policies_get_iam_policy: - operation: &ref_29 + projects_locations_client_tls_policies_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clientTlsPolicies~1{clientTlsPoliciesId}:getIamPolicy/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_locations_client_tls_policies_get_iam_policy: - operation: *ref_29 - response: *ref_30 projects_locations_client_tls_policies_test_iam_permissions: operation: $ref: >- @@ -2780,23 +2778,23 @@ components: #/components/x-stackQL-resources/client_tls_policies_iam_policies/methods/projects_locations_client_tls_policies_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/client_tls_policies_iam_policies/methods/projects_locations_client_tls_policies_set_iam_policy delete: [] gateway_security_policies: id: google.networksecurity.gateway_security_policies name: gateway_security_policies title: Gateway_security_policies methods: - _projects_locations_gateway_security_policies_list: - operation: &ref_31 + projects_locations_gateway_security_policies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gatewaySecurityPolicies/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.gatewaySecurityPolicies - projects_locations_gateway_security_policies_list: - operation: *ref_31 - response: *ref_32 projects_locations_gateway_security_policies_create: operation: $ref: >- @@ -2837,6 +2835,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/gateway_security_policies/methods/projects_locations_gateway_security_policies_delete @@ -2845,17 +2844,14 @@ components: name: rules title: Rules methods: - _projects_locations_gateway_security_policies_rules_list: - operation: &ref_33 + projects_locations_gateway_security_policies_rules_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gatewaySecurityPolicies~1{gatewaySecurityPoliciesId}~1rules/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.gatewaySecurityPolicyRules - projects_locations_gateway_security_policies_rules_list: - operation: *ref_33 - response: *ref_34 projects_locations_gateway_security_policies_rules_create: operation: $ref: >- @@ -2896,6 +2892,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/rules/methods/projects_locations_gateway_security_policies_rules_delete @@ -2904,17 +2901,14 @@ components: name: url_lists title: Url_lists methods: - _projects_locations_url_lists_list: - operation: &ref_35 + projects_locations_url_lists_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1urlLists/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.urlLists - projects_locations_url_lists_list: - operation: *ref_35 - response: *ref_36 projects_locations_url_lists_create: operation: $ref: >- @@ -2955,6 +2949,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/url_lists/methods/projects_locations_url_lists_delete @@ -2963,17 +2958,14 @@ components: name: tls_inspection_policies title: Tls_inspection_policies methods: - _projects_locations_tls_inspection_policies_list: - operation: &ref_37 + projects_locations_tls_inspection_policies_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tlsInspectionPolicies/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tlsInspectionPolicies - projects_locations_tls_inspection_policies_list: - operation: *ref_37 - response: *ref_38 projects_locations_tls_inspection_policies_create: operation: $ref: >- @@ -3014,25 +3006,60 @@ components: update: - $ref: >- #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/tls_inspection_policies/methods/projects_locations_tls_inspection_policies_delete + authz_policies_iam_policies: + id: google.networksecurity.authz_policies_iam_policies + name: authz_policies_iam_policies + title: Authz_policies_iam_policies + methods: + projects_locations_authz_policies_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies~1{authzPoliciesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_locations_authz_policies_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies~1{authzPoliciesId}:getIamPolicy/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_locations_authz_policies_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1authzPolicies~1{authzPoliciesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/authz_policies_iam_policies/methods/projects_locations_authz_policies_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/authz_policies_iam_policies/methods/projects_locations_authz_policies_set_iam_policy + delete: [] firewall_endpoints: id: google.networksecurity.firewall_endpoints name: firewall_endpoints title: Firewall_endpoints methods: - _organizations_locations_firewall_endpoints_list: - operation: &ref_39 + organizations_locations_firewall_endpoints_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1firewallEndpoints/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.firewallEndpoints - organizations_locations_firewall_endpoints_list: - operation: *ref_39 - response: *ref_40 organizations_locations_firewall_endpoints_create: operation: $ref: >- @@ -3073,6 +3100,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/firewall_endpoints/methods/organizations_locations_firewall_endpoints_delete @@ -3081,17 +3109,14 @@ components: name: security_profile_groups title: Security_profile_groups methods: - _organizations_locations_security_profile_groups_list: - operation: &ref_41 + organizations_locations_security_profile_groups_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1securityProfileGroups/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityProfileGroups - organizations_locations_security_profile_groups_list: - operation: *ref_41 - response: *ref_42 organizations_locations_security_profile_groups_create: operation: $ref: >- @@ -3132,6 +3157,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/security_profile_groups/methods/organizations_locations_security_profile_groups_delete @@ -3140,17 +3166,14 @@ components: name: security_profiles title: Security_profiles methods: - _organizations_locations_security_profiles_list: - operation: &ref_43 + organizations_locations_security_profiles_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1securityProfiles/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityProfiles - organizations_locations_security_profiles_list: - operation: *ref_43 - response: *ref_44 organizations_locations_security_profiles_create: operation: $ref: >- @@ -3191,12 +3214,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/security_profiles/methods/organizations_locations_security_profiles_delete paths: /v1/projects/{projectsId}/locations: - parameters: &ref_45 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3243,7 +3267,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets information about a location. operationId: networksecurity.projects.locations.get @@ -3271,7 +3295,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3314,7 +3338,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3385,7 +3409,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3432,7 +3456,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists address groups in a given project and location. operationId: networksecurity.projects.locations.addressGroups.list @@ -3508,7 +3532,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single address group. operationId: networksecurity.projects.locations.addressGroups.get @@ -3621,7 +3645,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems: - parameters: *ref_45 + parameters: *ref_1 post: description: Adds items to an address group. operationId: networksecurity.projects.locations.addressGroups.addItems @@ -3659,7 +3683,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems: - parameters: *ref_45 + parameters: *ref_1 post: description: Removes items from an address group. operationId: networksecurity.projects.locations.addressGroups.removeItems @@ -3697,7 +3721,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems: - parameters: *ref_45 + parameters: *ref_1 post: description: Clones items from one address group to another. operationId: networksecurity.projects.locations.addressGroups.cloneItems @@ -3735,7 +3759,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists references of an address group. operationId: networksecurity.projects.locations.addressGroups.listReferences @@ -3777,7 +3801,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3818,7 +3842,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3858,7 +3882,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3901,7 +3925,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists Associations in a given project and location. operationId: networksecurity.projects.locations.firewallEndpointAssociations.list @@ -3987,7 +4011,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/firewallEndpointAssociations/{firewallEndpointAssociationsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single FirewallEndpointAssociation. operationId: networksecurity.projects.locations.firewallEndpointAssociations.get @@ -4100,7 +4124,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists AuthorizationPolicies in a given project and location. operationId: networksecurity.projects.locations.authorizationPolicies.list @@ -4172,7 +4196,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single AuthorizationPolicy. operationId: networksecurity.projects.locations.authorizationPolicies.get @@ -4277,7 +4301,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4318,7 +4342,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4358,7 +4382,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/authorizationPolicies/{authorizationPoliciesId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4402,7 +4426,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists ServerTlsPolicies in a given project and location. operationId: networksecurity.projects.locations.serverTlsPolicies.list @@ -4474,7 +4498,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single ServerTlsPolicy. operationId: networksecurity.projects.locations.serverTlsPolicies.get @@ -4579,7 +4603,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4620,7 +4644,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4660,7 +4684,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/serverTlsPolicies/{serverTlsPoliciesId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4703,7 +4727,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists ClientTlsPolicies in a given project and location. operationId: networksecurity.projects.locations.clientTlsPolicies.list @@ -4775,7 +4799,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single ClientTlsPolicy. operationId: networksecurity.projects.locations.clientTlsPolicies.get @@ -4880,7 +4904,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:setIamPolicy: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4921,7 +4945,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:getIamPolicy: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4961,7 +4985,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/clientTlsPolicies/{clientTlsPoliciesId}:testIamPermissions: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5004,7 +5028,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gatewaySecurityPolicies: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists GatewaySecurityPolicies in a given project and location. operationId: networksecurity.projects.locations.gatewaySecurityPolicies.list @@ -5076,7 +5100,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gatewaySecurityPolicies/{gatewaySecurityPoliciesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single GatewaySecurityPolicy. operationId: networksecurity.projects.locations.gatewaySecurityPolicies.get @@ -5181,7 +5205,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gatewaySecurityPolicies/{gatewaySecurityPoliciesId}/rules: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists GatewaySecurityPolicyRules in a given project and location. operationId: networksecurity.projects.locations.gatewaySecurityPolicies.rules.list @@ -5263,7 +5287,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/gatewaySecurityPolicies/{gatewaySecurityPoliciesId}/rules/{rulesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single GatewaySecurityPolicyRule. operationId: networksecurity.projects.locations.gatewaySecurityPolicies.rules.get @@ -5383,7 +5407,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/urlLists: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists UrlLists in a given project and location. operationId: networksecurity.projects.locations.urlLists.list @@ -5455,7 +5479,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/urlLists/{urlListsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single UrlList. operationId: networksecurity.projects.locations.urlLists.get @@ -5560,7 +5584,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists TlsInspectionPolicies in a given project and location. operationId: networksecurity.projects.locations.tlsInspectionPolicies.list @@ -5632,7 +5656,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tlsInspectionPolicies/{tlsInspectionPoliciesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single TlsInspectionPolicy. operationId: networksecurity.projects.locations.tlsInspectionPolicies.get @@ -5740,8 +5764,132 @@ paths: name: force schema: type: boolean + /v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and + `PERMISSION_DENIED` errors. + operationId: networksecurity.projects.locations.authzPolicies.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzPoliciesId + required: true + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:getIamPolicy: + parameters: *ref_1 + get: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: networksecurity.projects.locations.authzPolicies.getIamPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzPoliciesId + required: true + schema: + type: string + - in: query + name: options.requestedPolicyVersion + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + 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. + operationId: networksecurity.projects.locations.authzPolicies.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleIamV1TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: authzPoliciesId + required: true + schema: + type: string /v1/organizations/{organizationsId}/locations/{locationsId}/operations: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -5784,7 +5932,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5855,7 +6003,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_45 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5902,7 +6050,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists address groups in a given project and location. operationId: networksecurity.organizations.locations.addressGroups.list @@ -5978,7 +6126,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single address group. operationId: networksecurity.organizations.locations.addressGroups.get @@ -6091,7 +6239,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:addItems: - parameters: *ref_45 + parameters: *ref_1 post: description: Adds items to an address group. operationId: networksecurity.organizations.locations.addressGroups.addItems @@ -6129,7 +6277,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:removeItems: - parameters: *ref_45 + parameters: *ref_1 post: description: Removes items from an address group. operationId: networksecurity.organizations.locations.addressGroups.removeItems @@ -6167,7 +6315,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:cloneItems: - parameters: *ref_45 + parameters: *ref_1 post: description: Clones items from one address group to another. operationId: networksecurity.organizations.locations.addressGroups.cloneItems @@ -6205,7 +6353,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/addressGroups/{addressGroupsId}:listReferences: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists references of an address group. operationId: networksecurity.organizations.locations.addressGroups.listReferences @@ -6247,7 +6395,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists FirewallEndpoints in a given project and location. operationId: networksecurity.organizations.locations.firewallEndpoints.list @@ -6331,7 +6479,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/firewallEndpoints/{firewallEndpointsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single Endpoint. operationId: networksecurity.organizations.locations.firewallEndpoints.get @@ -6444,7 +6592,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists SecurityProfileGroups in a given organization and location. operationId: networksecurity.organizations.locations.securityProfileGroups.list @@ -6516,7 +6664,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/securityProfileGroups/{securityProfileGroupsId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single SecurityProfileGroup. operationId: networksecurity.organizations.locations.securityProfileGroups.get @@ -6625,7 +6773,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles: - parameters: *ref_45 + parameters: *ref_1 get: description: Lists SecurityProfiles in a given organization and location. operationId: networksecurity.organizations.locations.securityProfiles.list @@ -6697,7 +6845,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/securityProfiles/{securityProfilesId}: - parameters: *ref_45 + parameters: *ref_1 get: description: Gets details of a single SecurityProfile. operationId: networksecurity.organizations.locations.securityProfiles.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml b/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml index 1dc0e967..4bc4c529 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/networkservices.yaml @@ -7,8 +7,8 @@ info: title: Network Services API description: '' version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240827' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/networking servers: @@ -240,9 +240,9 @@ components: - EXTERNAL_MANAGED metadata: description: >- - Optional. The metadata provided here will be included in the + Optional. The metadata provided here is included in the `ProcessingRequest.metadata_context.filter_metadata` map field. The - metadata will be available under the key + metadata is available under the key `com.google.lb_traffic_extension.`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. @@ -480,10 +480,10 @@ components: - EXTERNAL_MANAGED metadata: description: >- - Optional. The metadata provided here will be included as part of the + Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The - metadata will be available under the namespace + metadata is available under the namespace `com.google.lb_route_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource @@ -520,7 +520,7 @@ components: properties: name: description: >- - Required. Name of the EndpointPolicy resource. It matches pattern + Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`. type: string createTime: @@ -711,7 +711,7 @@ components: properties: name: description: >- - Required. Name of the Gateway resource. It matches pattern + Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. type: string selfLink: @@ -853,6 +853,24 @@ components: - ENVOY_HEADERS_UNSPECIFIED - NONE - DEBUG_HEADERS + routingMode: + description: >- + Optional. The routing mode of the Gateway. This field is + configurable only for gateways of type SECURE_WEB_GATEWAY. This + field is required for gateways of type SECURE_WEB_GATEWAY. + type: string + enumDescriptions: + - >- + The routing mode is explicit; clients are configured to send + traffic through the gateway. This is the default routing mode. + - >- + The routing mode is next-hop. Clients are unaware of the gateway, + and a route (advanced route or other route type) can be configured + to direct traffic from client to gateway. The gateway then acts as + a next-hop to the destination. + enum: + - EXPLICIT_ROUTING_MODE + - NEXT_HOP_ROUTING_MODE ListGrpcRoutesResponse: id: ListGrpcRoutesResponse description: Response returned by the ListGrpcRoutes method. @@ -879,7 +897,7 @@ components: properties: name: description: >- - Required. Name of the GrpcRoute resource. It matches pattern + Identifier. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/` type: string selfLink: @@ -1187,7 +1205,9 @@ components: format: int32 GrpcRouteRetryPolicy: id: GrpcRouteRetryPolicy - description: The specifications for retries. + description: >- + The specifications for retries. Specifies one or more conditions for + which this retry rule applies. Valid values are: type: object properties: retryConditions: @@ -1258,7 +1278,7 @@ components: properties: name: description: >- - Required. Name of the HttpRoute resource. It matches pattern + Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`. type: string selfLink: @@ -1943,7 +1963,7 @@ components: properties: name: description: >- - Required. Name of the TcpRoute resource. It matches pattern + Identifier. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`. type: string selfLink: @@ -2114,7 +2134,7 @@ components: properties: name: description: >- - Required. Name of the TlsRoute resource. It matches pattern + Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`. type: string selfLink: @@ -2276,7 +2296,7 @@ components: properties: name: description: >- - Required. Name of the ServiceBinding resource. It matches pattern + Identifier. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/global/serviceBindings/service_binding_name`. type: string description: @@ -2341,7 +2361,7 @@ components: properties: name: description: >- - Required. Name of the Mesh resource. It matches pattern + Identifier. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`. type: string selfLink: @@ -3024,16 +3044,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3046,23 +3063,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.networkservices.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -3090,6 +3105,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' lb_traffic_extensions: @@ -3097,17 +3113,14 @@ components: name: lb_traffic_extensions title: Lb_traffic_extensions methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lbTrafficExtensions/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.lbTrafficExtensions - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -3147,6 +3160,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/lb_traffic_extensions/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/lb_traffic_extensions/methods/delete @@ -3155,17 +3169,14 @@ components: name: lb_route_extensions title: Lb_route_extensions methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1lbRouteExtensions/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.lbRouteExtensions - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -3203,6 +3214,7 @@ components: #/components/x-stackQL-resources/lb_route_extensions/methods/create update: - $ref: '#/components/x-stackQL-resources/lb_route_extensions/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/lb_route_extensions/methods/delete @@ -3211,17 +3223,14 @@ components: name: endpoint_policies title: Endpoint_policies methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.endpointPolicies - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -3258,61 +3267,22 @@ components: - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/create' update: - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/endpoint_policies/methods/delete' - endpoint_policies_iam_policies: - id: google.networkservices.endpoint_policies_iam_policies - name: endpoint_policies_iam_policies - title: Endpoint_policies_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}:getIamPolicy/get - response: &ref_12 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1endpointPolicies~1{endpointPoliciesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/endpoint_policies_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] gateways: id: google.networkservices.gateways name: gateways title: Gateways methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gateways/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.gateways - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: >- @@ -3349,61 +3319,22 @@ components: - $ref: '#/components/x-stackQL-resources/gateways/methods/create' update: - $ref: '#/components/x-stackQL-resources/gateways/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/gateways/methods/delete' - gateways_iam_policies: - id: google.networkservices.gateways_iam_policies - name: gateways_iam_policies - title: Gateways_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gateways~1{gatewaysId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_15 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gateways~1{gatewaysId}:getIamPolicy/get - response: &ref_16 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_15 - response: *ref_16 - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1gateways~1{gatewaysId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/gateways_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] grpc_routes: id: google.networkservices.grpc_routes name: grpc_routes title: Grpc_routes methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1grpcRoutes/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.grpcRoutes - list: - operation: *ref_17 - response: *ref_18 create: operation: $ref: >- @@ -3440,6 +3371,7 @@ components: - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/create' update: - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/grpc_routes/methods/delete' http_routes: @@ -3447,17 +3379,14 @@ components: name: http_routes title: Http_routes methods: - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1httpRoutes/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.httpRoutes - list: - operation: *ref_19 - response: *ref_20 create: operation: $ref: >- @@ -3494,6 +3423,7 @@ components: - $ref: '#/components/x-stackQL-resources/http_routes/methods/create' update: - $ref: '#/components/x-stackQL-resources/http_routes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/http_routes/methods/delete' tcp_routes: @@ -3501,17 +3431,14 @@ components: name: tcp_routes title: Tcp_routes methods: - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tcpRoutes/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tcpRoutes - list: - operation: *ref_21 - response: *ref_22 create: operation: $ref: >- @@ -3548,6 +3475,7 @@ components: - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/create' update: - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tcp_routes/methods/delete' tls_routes: @@ -3555,17 +3483,14 @@ components: name: tls_routes title: Tls_routes methods: - _list: - operation: &ref_23 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1tlsRoutes/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tlsRoutes - list: - operation: *ref_23 - response: *ref_24 create: operation: $ref: >- @@ -3602,6 +3527,7 @@ components: - $ref: '#/components/x-stackQL-resources/tls_routes/methods/create' update: - $ref: '#/components/x-stackQL-resources/tls_routes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tls_routes/methods/delete' service_bindings: @@ -3609,17 +3535,14 @@ components: name: service_bindings title: Service_bindings methods: - _list: - operation: &ref_25 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceBindings/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceBindings - list: - operation: *ref_25 - response: *ref_26 create: operation: $ref: >- @@ -3648,61 +3571,22 @@ components: insert: - $ref: '#/components/x-stackQL-resources/service_bindings/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/service_bindings/methods/delete' - service_bindings_iam_policies: - id: google.networkservices.service_bindings_iam_policies - name: service_bindings_iam_policies - title: Service_bindings_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceBindings~1{serviceBindingsId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_27 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceBindings~1{serviceBindingsId}:getIamPolicy/get - response: &ref_28 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_27 - response: *ref_28 - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceBindings~1{serviceBindingsId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/service_bindings_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] meshes: id: google.networkservices.meshes name: meshes title: Meshes methods: - _list: - operation: &ref_29 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1meshes/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.meshes - list: - operation: *ref_29 - response: *ref_30 create: operation: $ref: >- @@ -3739,61 +3623,22 @@ components: - $ref: '#/components/x-stackQL-resources/meshes/methods/create' update: - $ref: '#/components/x-stackQL-resources/meshes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/meshes/methods/delete' - meshes_iam_policies: - id: google.networkservices.meshes_iam_policies - name: meshes_iam_policies - title: Meshes_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1meshes~1{meshesId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_31 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1meshes~1{meshesId}:getIamPolicy/get - response: &ref_32 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_31 - response: *ref_32 - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1meshes~1{meshesId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/meshes_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] service_lb_policies: id: google.networkservices.service_lb_policies name: service_lb_policies title: Service_lb_policies methods: - _list: - operation: &ref_33 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceLbPolicies/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceLbPolicies - list: - operation: *ref_33 - response: *ref_34 create: operation: $ref: >- @@ -3831,6 +3676,7 @@ components: #/components/x-stackQL-resources/service_lb_policies/methods/create update: - $ref: '#/components/x-stackQL-resources/service_lb_policies/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/service_lb_policies/methods/delete @@ -3846,17 +3692,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_35 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1serviceLbPolicies~1{serviceLbPoliciesId}:getIamPolicy/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_35 - response: *ref_36 test_iam_permissions: operation: $ref: >- @@ -3870,6 +3713,9 @@ components: #/components/x-stackQL-resources/service_lb_policies_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/service_lb_policies_iam_policies/methods/set_iam_policy delete: [] edge_cache_keysets_iam_policies: id: google.networkservices.edge_cache_keysets_iam_policies @@ -3883,17 +3729,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_37 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1edgeCacheKeysets~1{edgeCacheKeysetsId}:getIamPolicy/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_37 - response: *ref_38 test_iam_permissions: operation: $ref: >- @@ -3907,6 +3750,9 @@ components: #/components/x-stackQL-resources/edge_cache_keysets_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/edge_cache_keysets_iam_policies/methods/set_iam_policy delete: [] edge_cache_origins_iam_policies: id: google.networkservices.edge_cache_origins_iam_policies @@ -3920,17 +3766,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_39 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1edgeCacheOrigins~1{edgeCacheOriginsId}:getIamPolicy/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_39 - response: *ref_40 test_iam_permissions: operation: $ref: >- @@ -3944,6 +3787,9 @@ components: #/components/x-stackQL-resources/edge_cache_origins_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/edge_cache_origins_iam_policies/methods/set_iam_policy delete: [] edge_cache_services_iam_policies: id: google.networkservices.edge_cache_services_iam_policies @@ -3957,17 +3803,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_41 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1edgeCacheServices~1{edgeCacheServicesId}:getIamPolicy/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_41 - response: *ref_42 test_iam_permissions: operation: $ref: >- @@ -3981,10 +3824,13 @@ components: #/components/x-stackQL-resources/edge_cache_services_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/edge_cache_services_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_43 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4031,7 +3877,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets information about a location. operationId: networkservices.projects.locations.get @@ -4059,7 +3905,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4102,7 +3948,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4173,7 +4019,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4220,7 +4066,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists `LbTrafficExtension` resources in a given project and location. operationId: networkservices.projects.locations.lbTrafficExtensions.list @@ -4306,7 +4152,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions/{lbTrafficExtensionsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of the specified `LbTrafficExtension` resource. operationId: networkservices.projects.locations.lbTrafficExtensions.get @@ -4419,7 +4265,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists `LbRouteExtension` resources in a given project and location. operationId: networkservices.projects.locations.lbRouteExtensions.list @@ -4505,7 +4351,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions/{lbRouteExtensionsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of the specified `LbRouteExtension` resource. operationId: networkservices.projects.locations.lbRouteExtensions.get @@ -4618,7 +4464,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists EndpointPolicies in a given project and location. operationId: networkservices.projects.locations.endpointPolicies.list @@ -4690,7 +4536,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single EndpointPolicy. operationId: networkservices.projects.locations.endpointPolicies.get @@ -4794,19 +4640,51 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy: - parameters: *ref_43 + /v1/projects/{projectsId}/locations/{locationsId}/gateways: + parameters: *ref_1 + get: + description: Lists Gateways in a given project and location. + operationId: networkservices.projects.locations.gateways.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListGatewaysResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: networkservices.projects.locations.endpointPolicies.setIamPolicy + description: Creates a new Gateway in a given project and location. + operationId: networkservices.projects.locations.gateways.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SetIamPolicyRequest' + $ref: '#/components/schemas/Gateway' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4818,7 +4696,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -4830,18 +4708,15 @@ paths: required: true schema: type: string - - in: path - name: endpointPoliciesId - required: true + - in: query + name: gatewayId schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy: - parameters: *ref_43 + /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}: + parameters: *ref_1 get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: networkservices.projects.locations.endpointPolicies.getIamPolicy + description: Gets details of a single Gateway. + operationId: networkservices.projects.locations.gateways.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4853,7 +4728,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Policy' + $ref: '#/components/schemas/Gateway' parameters: - in: path name: projectsId @@ -4866,30 +4741,18 @@ paths: schema: type: string - in: path - name: endpointPoliciesId + name: gatewaysId required: true schema: type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions: - parameters: *ref_43 - post: - description: >- - 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. - operationId: networkservices.projects.locations.endpointPolicies.testIamPermissions + patch: + description: Updates the parameters of a single Gateway. + operationId: networkservices.projects.locations.gateways.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' + $ref: '#/components/schemas/Gateway' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4901,148 +4764,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: endpointPoliciesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/gateways: - parameters: *ref_43 - get: - description: Lists Gateways in a given project and location. - operationId: networkservices.projects.locations.gateways.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListGatewaysResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: Creates a new Gateway in a given project and location. - operationId: networkservices.projects.locations.gateways.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Gateway' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: query - name: gatewayId - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}: - parameters: *ref_43 - get: - description: Gets details of a single Gateway. - operationId: networkservices.projects.locations.gateways.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Gateway' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: gatewaysId - required: true - schema: - type: string - patch: - description: Updates the parameters of a single Gateway. - operationId: networkservices.projects.locations.gateways.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Gateway' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Operation' parameters: - in: path name: projectsId @@ -5095,132 +4817,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy: - parameters: *ref_43 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: networkservices.projects.locations.gateways.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: gatewaysId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy: - parameters: *ref_43 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: networkservices.projects.locations.gateways.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: gatewaysId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions: - parameters: *ref_43 - post: - description: >- - 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. - operationId: networkservices.projects.locations.gateways.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: gatewaysId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists GrpcRoutes in a given project and location. operationId: networkservices.projects.locations.grpcRoutes.list @@ -5292,7 +4890,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/grpcRoutes/{grpcRoutesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single GrpcRoute. operationId: networkservices.projects.locations.grpcRoutes.get @@ -5397,7 +4995,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/httpRoutes: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists HttpRoute in a given project and location. operationId: networkservices.projects.locations.httpRoutes.list @@ -5469,7 +5067,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/httpRoutes/{httpRoutesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single HttpRoute. operationId: networkservices.projects.locations.httpRoutes.get @@ -5574,7 +5172,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists TcpRoute in a given project and location. operationId: networkservices.projects.locations.tcpRoutes.list @@ -5646,7 +5244,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tcpRoutes/{tcpRoutesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single TcpRoute. operationId: networkservices.projects.locations.tcpRoutes.get @@ -5751,7 +5349,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists TlsRoute in a given project and location. operationId: networkservices.projects.locations.tlsRoutes.list @@ -5823,7 +5421,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/tlsRoutes/{tlsRoutesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single TlsRoute. operationId: networkservices.projects.locations.tlsRoutes.get @@ -5928,7 +5526,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceBindings: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists ServiceBinding in a given project and location. operationId: networkservices.projects.locations.serviceBindings.list @@ -6000,7 +5598,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single ServiceBinding. operationId: networkservices.projects.locations.serviceBindings.get @@ -6063,132 +5661,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy: - parameters: *ref_43 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: networkservices.projects.locations.serviceBindings.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: serviceBindingsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy: - parameters: *ref_43 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: networkservices.projects.locations.serviceBindings.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: serviceBindingsId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions: - parameters: *ref_43 - post: - description: >- - 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. - operationId: networkservices.projects.locations.serviceBindings.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: serviceBindingsId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/meshes: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists Meshes in a given project and location. operationId: networkservices.projects.locations.meshes.list @@ -6260,7 +5734,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single Mesh. operationId: networkservices.projects.locations.meshes.get @@ -6364,132 +5838,8 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy: - parameters: *ref_43 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and - `PERMISSION_DENIED` errors. - operationId: networkservices.projects.locations.meshes.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: meshesId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy: - parameters: *ref_43 - get: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: networkservices.projects.locations.meshes.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: meshesId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions: - parameters: *ref_43 - post: - description: >- - 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. - operationId: networkservices.projects.locations.meshes.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: meshesId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists ServiceLbPolicies in a given project and location. operationId: networkservices.projects.locations.serviceLbPolicies.list @@ -6561,7 +5911,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets details of a single ServiceLbPolicy. operationId: networkservices.projects.locations.serviceLbPolicies.get @@ -6666,7 +6016,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:setIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6707,7 +6057,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:getIamPolicy: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6747,7 +6097,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6790,7 +6140,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheKeysets/{edgeCacheKeysetsId}:setIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6831,7 +6181,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheKeysets/{edgeCacheKeysetsId}:getIamPolicy: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6871,7 +6221,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheKeysets/{edgeCacheKeysetsId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -6914,7 +6264,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheOrigins/{edgeCacheOriginsId}:setIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -6955,7 +6305,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheOrigins/{edgeCacheOriginsId}:getIamPolicy: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -6995,7 +6345,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheOrigins/{edgeCacheOriginsId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -7038,7 +6388,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheServices/{edgeCacheServicesId}:setIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -7079,7 +6429,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheServices/{edgeCacheServicesId}:getIamPolicy: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -7119,7 +6469,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/edgeCacheServices/{edgeCacheServicesId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml b/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml index 5887babe..baaa9255 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/notebooks.yaml @@ -7,8 +7,8 @@ info: title: Notebooks API description: Notebooks API is used to manage notebook resources in Google Cloud. version: v2 - x-discovery-doc-revision: '20240422' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240820' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/notebooks/docs/ servers: @@ -356,6 +356,14 @@ components: access the Jupyter notebook. readOnly: true type: string + satisfiesPzs: + description: Output only. Reserved for future use for Zone Separation. + readOnly: true + type: boolean + satisfiesPzi: + description: Output only. Reserved for future use for Zone Isolation. + readOnly: true + type: boolean GceSetup: id: GceSetup description: >- @@ -368,6 +376,12 @@ components: Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource type: string + minCpuPlatform: + description: >- + Optional. The minimum CPU platform to use for this instance. The + list of valid values can be found in + https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones + type: string acceleratorConfigs: description: >- Optional. The hardware accelerators used on this instance. If you @@ -690,6 +704,28 @@ components: - NIC_TYPE_UNSPECIFIED - VIRTIO_NET - GVNIC + accessConfigs: + description: >- + Optional. An array of configurations for this interface. Currently, + only one access config, ONE_TO_ONE_NAT, is supported. If no + accessConfigs specified, the instance will have an external internet + access through an ephemeral external IP address. + type: array + items: + $ref: '#/components/schemas/AccessConfig' + AccessConfig: + id: AccessConfig + description: An access configuration attached to an instance's network interface. + type: object + properties: + externalIp: + description: >- + An external IP address associated with this instance. Specify an + unused static external IP address available to the project or leave + this field undefined to use an IP from a shared ephemeral IP address + pool. If you specify a static external IP address, it must live in + the same region as the zone of the instance. + type: string GPUDriverConfig: id: GPUDriverConfig description: A GPU driver configuration @@ -947,6 +983,28 @@ components: description: Output only. The release of the image of the form m123 readOnly: true type: string + RestoreInstanceRequest: + id: RestoreInstanceRequest + description: Request for restoring the notebook instance from a BackupSource. + type: object + properties: + snapshot: + description: Snapshot to be used for restore. + $ref: '#/components/schemas/Snapshot' + Snapshot: + id: Snapshot + description: >- + Snapshot represents the snapshot of the data disk used to restore the + Workbench Instance from. Refers to: + compute/v1/projects/{project_id}/global/snapshots/{snapshot_id} + type: object + properties: + snapshotId: + description: Required. The ID of the snapshot. + type: string + projectId: + description: Required. The project ID of the snapshot. + type: string ReportInstanceInfoSystemRequest: id: ReportInstanceInfoSystemRequest description: Request for notebook instances to report information to Notebooks API. @@ -1391,16 +1449,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1413,23 +1468,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.notebooks.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1457,6 +1510,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' instances: @@ -1464,17 +1518,14 @@ components: name: instances title: Instances methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1559,6 +1610,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + restore: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:restore/post + response: + mediaType: application/json + openAPIDocKey: '200' report_info_system: operation: $ref: >- @@ -1581,6 +1639,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_config: @@ -1601,6 +1660,7 @@ components: #/components/x-stackQL-resources/instances_config/methods/get_config insert: [] update: [] + replace: [] delete: [] instances_iam_policies: id: google.notebooks.instances_iam_policies @@ -1614,17 +1674,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -1638,10 +1695,13 @@ components: #/components/x-stackQL-resources/instances_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/set_iam_policy delete: [] paths: /v2/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1688,7 +1748,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: notebooks.projects.locations.get @@ -1716,7 +1776,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1759,7 +1819,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1830,7 +1890,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1877,7 +1937,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists instances in a given project and location. operationId: notebooks.projects.locations.instances.list @@ -1961,7 +2021,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a single Instance. operationId: notebooks.projects.locations.instances.get @@ -2074,7 +2134,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:start: - parameters: *ref_9 + parameters: *ref_1 post: description: Starts a notebook instance. operationId: notebooks.projects.locations.instances.start @@ -2112,7 +2172,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:stop: - parameters: *ref_9 + parameters: *ref_1 post: description: Stops a notebook instance. operationId: notebooks.projects.locations.instances.stop @@ -2150,7 +2210,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset: - parameters: *ref_9 + parameters: *ref_1 post: description: Resets a notebook instance. operationId: notebooks.projects.locations.instances.reset @@ -2188,7 +2248,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:checkUpgradability: - parameters: *ref_9 + parameters: *ref_1 get: description: Checks whether a notebook instance is upgradable. operationId: notebooks.projects.locations.instances.checkUpgradability @@ -2221,7 +2281,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade: - parameters: *ref_9 + parameters: *ref_1 post: description: Upgrades a notebook instance to the latest version. operationId: notebooks.projects.locations.instances.upgrade @@ -2259,7 +2319,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:resizeDisk: - parameters: *ref_9 + parameters: *ref_1 post: description: Resize a notebook instance disk to a higher capacity. operationId: notebooks.projects.locations.instances.resizeDisk @@ -2297,7 +2357,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rollback: - parameters: *ref_9 + parameters: *ref_1 post: description: Rollbacks a notebook instance to the previous version. operationId: notebooks.projects.locations.instances.rollback @@ -2335,7 +2395,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:diagnose: - parameters: *ref_9 + parameters: *ref_1 post: description: Creates a Diagnostic File and runs Diagnostic Tool given an Instance. operationId: notebooks.projects.locations.instances.diagnose @@ -2373,7 +2433,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances:getConfig: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets general backend configurations that might also affect the frontend. @@ -2405,8 +2465,46 @@ paths: required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restore: + parameters: *ref_1 + post: + description: RestoreInstance restores an Instance from a BackupSource. + operationId: notebooks.projects.locations.instances.restore + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreInstanceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reportInfoSystem: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Allows notebook instances to report their latest instance information to @@ -2447,7 +2545,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgradeSystem: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Allows notebook instances to upgrade themselves. Do not use this method @@ -2487,7 +2585,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2528,7 +2626,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2568,7 +2666,7 @@ paths: type: integer format: int32 /v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml b/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml index be3f93ca..8d70f1d0 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/ondemandscanning.yaml @@ -7,8 +7,8 @@ info: title: On-Demand Scanning API description: A service to scan container images for vulnerabilities. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/container-analysis/docs/on-demand-scanning/ servers: @@ -203,6 +203,7 @@ components: - Ruby packges (from RubyGems package manager). - Rust packages from Cargo (Github ecosystem is `RUST`). - PHP packages from Composer package manager. + - Swift packages from Swift Package Manager (SwiftPM). enum: - PACKAGE_TYPE_UNSPECIFIED - OS @@ -215,6 +216,7 @@ components: - RUBYGEMS - RUST - COMPOSER + - SWIFT hashDigest: description: >- HashDigest stores the SHA512 hash digest of the jar file if the @@ -2684,17 +2686,14 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -2729,6 +2728,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' scans: @@ -2747,32 +2747,31 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] vulnerabilities: id: google.ondemandscanning.vulnerabilities name: vulnerabilities title: Vulnerabilities methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1scans~1{scansId}~1vulnerabilities/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.occurrences - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/vulnerabilities/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2826,7 +2825,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2897,7 +2896,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2939,7 +2938,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -2986,7 +2985,7 @@ paths: type: string format: google-duration /v1/projects/{projectsId}/locations/{locationsId}/scans:analyzePackages: - parameters: *ref_5 + parameters: *ref_1 post: description: Initiates an analysis of the provided packages. operationId: ondemandscanning.projects.locations.scans.analyzePackages @@ -3019,7 +3018,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/scans/{scansId}/vulnerabilities: - parameters: *ref_5 + parameters: *ref_1 get: description: Lists vulnerabilities resulting from a successfully completed scan. operationId: ondemandscanning.projects.locations.scans.vulnerabilities.list diff --git a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml index 744ff61e..cbd8b886 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/orgpolicy.yaml @@ -9,8 +9,8 @@ info: The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy. version: v2 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/orgpolicy/docs/reference/rest/index.html servers: @@ -36,16 +36,29 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: - type: object - description: >- - A constraint that is either enforced or not. For example, a constraint - `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM - instance, serial port connections will not be opened to that instance. - id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint - properties: {} GoogleTypeExpr: - type: object + properties: + location: + type: string + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + title: + type: string + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + description: + type: string + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + expression: + type: string + description: >- + Textual representation of an expression in Common Expression + Language syntax. description: >- Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of @@ -64,160 +77,52 @@ components: be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. id: GoogleTypeExpr - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - location: - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - type: string - description: - type: string - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - title: - type: string - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - GoogleCloudOrgpolicyV2Constraint: - properties: - supportsDryRun: - description: Shows if dry run is supported for this constraint or not. - type: boolean - constraintDefault: - enum: - - CONSTRAINT_DEFAULT_UNSPECIFIED - - ALLOW - - DENY - enumDescriptions: - - >- - This is only used for distinguishing unset values and should never - be used. - - >- - Indicate that all values are allowed for list constraints. - Indicate that enforcement is off for boolean constraints. - - >- - Indicate that all values are denied for list constraints. Indicate - that enforcement is on for boolean constraints. - description: >- - The evaluation behavior of this constraint in the absence of a - policy. - type: string - listConstraint: - description: Defines this constraint as being a ListConstraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' - booleanConstraint: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint - description: Defines this constraint as being a BooleanConstraint. - name: - type: string - description: >- - Immutable. The resource name of the constraint. Must be in one of - the following forms: * - `projects/{project_number}/constraints/{constraint_name}` * - `folders/{folder_id}/constraints/{constraint_name}` * - `organizations/{organization_id}/constraints/{constraint_name}` For - example, - "/projects/123/constraints/compute.disableSerialPortAccess". - description: - description: >- - Detailed description of what this constraint controls as well as how - and where it is enforced. Mutable. - type: string - displayName: - type: string - description: The human readable name. Mutable. type: object - id: GoogleCloudOrgpolicyV2Constraint - description: >- - A constraint describes a way to restrict resource's configuration. For - example, you could enforce a constraint that controls which Google Cloud - services can be activated across an organization, or whether a Compute - Engine instance can have serial port connections established. - Constraints can be configured by the organization policy administrator - to fit the needs of the organization by setting a policy that includes - constraints at different locations in the organization's resource - hierarchy. Policies are inherited down the resource hierarchy from - higher levels, but can also be overridden. For details about the - inheritance rules please read about `policies`. Constraints have a - default behavior determined by the `constraint_default` field, which is - the enforcement behavior that is used in the absence of a policy being - defined or inherited for the resource in question. - GoogleCloudOrgpolicyV2ConstraintListConstraint: - properties: - supportsUnder: - type: boolean - description: >- - Indicates whether subtrees of the Resource Manager resource - hierarchy can be used in `Policy.allowed_values` and - `Policy.denied_values`. For example, `"under:folders/123"` would - match any resource under the 'folders/123' folder. - supportsIn: - description: >- - Indicates whether values grouped into categories can be used in - `Policy.allowed_values` and `Policy.denied_values`. For example, - `"in:Python"` would match any value in the 'Python' group. - type: boolean + GoogleCloudOrgpolicyV2ConstraintBooleanConstraint: + id: GoogleCloudOrgpolicyV2ConstraintBooleanConstraint description: >- - A constraint that allows or disallows a list of string values, which are - configured by an Organization Policy administrator with a policy. - id: GoogleCloudOrgpolicyV2ConstraintListConstraint + A constraint that is either enforced or not. For example, a constraint + `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM + instance, serial port connections will not be opened to that instance. + properties: {} type: object GoogleCloudOrgpolicyV2ListCustomConstraintsResponse: - properties: - customConstraints: - type: array - description: >- - All custom constraints that exist on the organization resource. It - will be empty if no custom constraints are set. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - nextPageToken: - type: string - description: >- - Page token used to retrieve the next page. This is currently not - used, but the server may at any point start supplying a valid token. description: >- The response returned from the ListCustomConstraints method. It will be empty if no custom constraints are set on the organization resource. - type: object id: GoogleCloudOrgpolicyV2ListCustomConstraintsResponse - GoogleCloudOrgpolicyV2ListPoliciesResponse: - description: >- - The response returned from the ListPolicies method. It will be empty if - no policies are set on the resource. properties: - policies: - type: array - description: >- - All policies that exist on the resource. It will be empty if no - policies are set. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' nextPageToken: + type: string description: >- Page token used to retrieve the next page. This is currently not used, but the server may at any point start supplying a valid token. - type: string - id: GoogleCloudOrgpolicyV2ListPoliciesResponse + customConstraints: + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + description: >- + All custom constraints that exist on the organization resource. It + will be empty if no custom constraints are set. + type: array type: object GoogleCloudOrgpolicyV2Policy: - description: >- - Defines an organization policy which is used to specify constraints for - configurations of Google Cloud resources. properties: - spec: + dryRunSpec: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Basic information about the Organization Policy. + description: >- + Dry-run policy. Audit-only policy, can be used to monitor how the + policy would have impacted the existing and future resources if it's + enforced. + etag: + description: >- + Optional. An opaque tag indicating the current state of the policy, + used for concurrency control. This 'etag' is computed by the server + based on the value of other fields, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + type: string name: + type: string description: >- Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the @@ -229,109 +134,30 @@ components: Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. - type: string - etag: - description: >- - Optional. An opaque tag indicating the current state of the policy, - used for concurrency control. This 'etag' is computed by the server - based on the value of other fields, and may be sent on update and - delete requests to ensure the client has an up-to-date value before - proceeding. - type: string + spec: + description: Basic information about the Organization Policy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' alternate: - description: Deprecated. - deprecated: true $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - dryRunSpec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: >- - Dry-run policy. Audit-only policy, can be used to monitor how the - policy would have impacted the existing and future resources if it's - enforced. - id: GoogleCloudOrgpolicyV2Policy + deprecated: true + description: Deprecated. type: object - GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: - properties: - deniedValues: - description: List of values denied at this resource. - items: - type: string - type: array - allowedValues: - type: array - description: List of values allowed at this resource. - items: - type: string + id: GoogleCloudOrgpolicyV2Policy description: >- - A message that holds specific allowed and denied values. This message - can define specific values and subtrees of the Resource Manager resource - hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or - denied. This is achieved by using the `under:` and optional `is:` - prefixes. The `under:` prefix is used to denote resource subtree values. - The `is:` prefix is used to denote specific values, and is required only - if the value contains a ":". Values prefixed with "is:" are treated the - same as values with no prefix. Ancestry subtrees must be in one of the - following formats: - `projects/` (for example, - `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - - `organizations/` (for example, `organizations/1234`) The - `supports_under` field of the associated `Constraint` defines whether - ancestry prefixes can be used. - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - type: object - GoogleCloudOrgpolicyV2PolicySpecPolicyRule: + Defines an organization policy which is used to specify constraints for + configurations of Google Cloud resources. + GoogleCloudOrgpolicyV2PolicySpec: type: object - description: A rule used to express this policy. properties: - values: - description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - enforce: - type: boolean - description: >- - If `true`, then the policy is enforced. If `false`, then any - configuration is acceptable. This field can be set only in policies - for boolean constraints. - allowAll: - type: boolean - description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - denyAll: + inheritFromParent: type: boolean description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - A condition which determines whether this rule is used in the - evaluation of the policy. When set, the `expression` field in the - `Expr' must include from 1 to 10 subexpressions, joined by the "||" - or "&&" operators. Each subexpression must be of the form - "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". - or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". - where key_name and value_name are the resource names for Label Keys - and Values. These names are available from the Tag Manager Service. - An example expression is: "resource.matchTag('123456789/environment, - 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - GoogleCloudOrgpolicyV2PolicySpec: - id: GoogleCloudOrgpolicyV2PolicySpec - properties: - rules: - description: >- - In policies for boolean constraints, the following requirements - apply: - There must be one and only one policy rule where condition - is unset. - Boolean policy rules with conditions must set `enforced` - to the opposite of the policy rule without a condition. - During - policy evaluation, policy rules with conditions that are true for a - target resource take precedence. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' - type: array + Determines the inheritance behavior for this policy. If + `inherit_from_parent` is true, policy rules set higher up in the + hierarchy (up to the closest root) are inherited and present in the + effective policy. If it is false, then no rules are inherited, and + this policy becomes the new root for evaluation. This field can be + set only for policies which configure list constraints. etag: description: >- An opaque tag indicating the current version of the policySpec, used @@ -342,147 +168,322 @@ components: read-modify-write loop. When the policy is returned from a `GetEffectivePolicy` request, the `etag` will be unset. type: string - inheritFromParent: + reset: description: >- - Determines the inheritance behavior for this policy. If - `inherit_from_parent` is true, policy rules set higher up in the - hierarchy (up to the closest root) are inherited and present in the - effective policy. If it is false, then no rules are inherited, and - this policy becomes the new root for evaluation. This field can be - set only for policies which configure list constraints. + Ignores policies set above this resource and restores the + `constraint_default` enforcement behavior of the specific constraint + at this resource. This field can be set in policies for either list + or boolean constraints. If set, `rules` must be empty and + `inherit_from_parent` must be set to false. type: boolean updateTime: readOnly: true - format: google-datetime - type: string description: >- Output only. The time stamp this was previously updated. This represents the last time a call to `CreatePolicy` or `UpdatePolicy` was made for that policy. - reset: + format: google-datetime + type: string + rules: description: >- - Ignores policies set above this resource and restores the - `constraint_default` enforcement behavior of the specific constraint - at this resource. This field can be set in policies for either list - or boolean constraints. If set, `rules` must be empty and - `inherit_from_parent` must be set to false. - type: boolean + In policies for boolean constraints, the following requirements + apply: - There must be one and only one policy rule where condition + is unset. - Boolean policy rules with conditions must set `enforced` + to the opposite of the policy rule without a condition. - During + policy evaluation, policy rules with conditions that are true for a + target resource take precedence. + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + type: array + id: GoogleCloudOrgpolicyV2PolicySpec description: >- Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. + GoogleCloudOrgpolicyV2ConstraintListConstraint: type: object - GoogleCloudOrgpolicyV2AlternatePolicySpec: properties: - spec: - description: Specify constraint for configurations of Google Cloud resources. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - launch: + supportsUnder: + type: boolean description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. - type: string - type: object - id: GoogleCloudOrgpolicyV2AlternatePolicySpec + Indicates whether subtrees of the Resource Manager resource + hierarchy can be used in `Policy.allowed_values` and + `Policy.denied_values`. For example, `"under:folders/123"` would + match any resource under the 'folders/123' folder. + supportsIn: + description: >- + Indicates whether values grouped into categories can be used in + `Policy.allowed_values` and `Policy.denied_values`. For example, + `"in:Python"` would match any value in the 'Python' group. + type: boolean description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. + A constraint that allows or disallows a list of string values, which are + configured by an Organization Policy administrator with a policy. + id: GoogleCloudOrgpolicyV2ConstraintListConstraint GoogleCloudOrgpolicyV2CustomConstraint: - description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. + id: GoogleCloudOrgpolicyV2CustomConstraint properties: - displayName: + name: + description: >- + Immutable. Name of the constraint. This is unique within the + organization. Format of the name should be * + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The + max length is 70 characters and the minimum length is 1. Note that + the prefix `organizations/{organization_id}/customConstraints/` is + not counted. type: string + methodTypes: + description: All the operations being applied for this constraint. + items: + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - REMOVE_GRANT + - GOVERN_TAGS + type: string + enumDescriptions: + - Unspecified. Results in an error. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - >- + Constraint applied when deleting the resource. Not supported + yet. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. + type: array + description: + type: string + description: >- + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + resourceTypes: + items: + type: string + type: array + description: >- + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + displayName: description: >- One line display name for the UI. The max length of the display_name is 200 characters. + type: string + updateTime: + readOnly: true + description: >- + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` RPC was called + format: google-datetime + type: string actionType: - enum: - - ACTION_TYPE_UNSPECIFIED - - ALLOW - - DENY description: Allow or deny type. - type: string enumDescriptions: - Unspecified. Results in an error. - Allowed action type. - Deny action type. - updateTime: + enum: + - ACTION_TYPE_UNSPECIFIED + - ALLOW + - DENY + type: string + condition: type: string description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called - format: google-datetime - readOnly: true + Org policy condition/expression. For example: + `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, + `resource.management.auto_upgrade == true` The max length of the + condition is 1000 characters. + description: >- + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. + type: object + GoogleCloudOrgpolicyV2Constraint: + id: GoogleCloudOrgpolicyV2Constraint + type: object + properties: + supportsDryRun: + description: Shows if dry run is supported for this constraint or not. + type: boolean name: type: string description: >- - Immutable. Name of the constraint. This is unique within the - organization. Format of the name should be * - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The - max length is 70 characters and the minimum length is 1. Note that - the prefix `organizations/{organization_id}/customConstraints/` is - not counted. - condition: - description: >- - Org policy condition/expression. For example: - `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, - `resource.management.auto_upgrade == true` The max length of the - condition is 1000 characters. + Immutable. The resource name of the constraint. Must be in one of + the following forms: * + `projects/{project_number}/constraints/{constraint_name}` * + `folders/{folder_id}/constraints/{constraint_name}` * + `organizations/{organization_id}/constraints/{constraint_name}` For + example, + "/projects/123/constraints/compute.disableSerialPortAccess". + constraintDefault: + type: string + description: >- + The evaluation behavior of this constraint in the absence of a + policy. + enum: + - CONSTRAINT_DEFAULT_UNSPECIFIED + - ALLOW + - DENY + enumDescriptions: + - >- + This is only used for distinguishing unset values and should never + be used. + - >- + Indicate that all values are allowed for list constraints. + Indicate that enforcement is off for boolean constraints. + - >- + Indicate that all values are denied for list constraints. Indicate + that enforcement is on for boolean constraints. + booleanConstraint: + description: Defines this constraint as being a BooleanConstraint. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ConstraintBooleanConstraint + description: + description: >- + Detailed description of what this constraint controls as well as how + and where it is enforced. Mutable. + type: string + listConstraint: + description: Defines this constraint as being a ListConstraint. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2ConstraintListConstraint' + displayName: + description: The human readable name. Mutable. + type: string + description: >- + A constraint describes a way to restrict resource's configuration. For + example, you could enforce a constraint that controls which Google Cloud + services can be activated across an organization, or whether a Compute + Engine instance can have serial port connections established. + Constraints can be configured by the organization policy administrator + to fit the needs of the organization by setting a policy that includes + constraints at different locations in the organization's resource + hierarchy. Policies are inherited down the resource hierarchy from + higher levels, but can also be overridden. For details about the + inheritance rules please read about `policies`. Constraints have a + default behavior determined by the `constraint_default` field, which is + the enforcement behavior that is used in the absence of a policy being + defined or inherited for the resource in question. + GoogleCloudOrgpolicyV2AlternatePolicySpec: + description: >- + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. + properties: + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Specify constraint for configurations of Google Cloud resources. + launch: + description: >- + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. type: string - description: + type: object + id: GoogleCloudOrgpolicyV2AlternatePolicySpec + GoogleCloudOrgpolicyV2ListPoliciesResponse: + properties: + nextPageToken: type: string description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. - resourceTypes: + Page token used to retrieve the next page. This is currently not + used, but the server may at any point start supplying a valid token. + policies: description: >- - Immutable. The resource instance type on which this policy applies. - Format will be of the form : `/` Example: * - `compute.googleapis.com/Instance`. - items: - type: string - type: array - methodTypes: + All policies that exist on the resource. It will be empty if no + policies are set. type: array - description: All the operations being applied for this constraint. items: - enumDescriptions: - - Unspecified. Results in an error. - - Constraint applied when creating the resource. - - Constraint applied when updating the resource. - - >- - Constraint applied when deleting the resource. Not supported - yet. - - Constraint applied when removing an IAM grant. - - Constraint applied when enforcing forced tagging. - enum: - - METHOD_TYPE_UNSPECIFIED - - CREATE - - UPDATE - - DELETE - - REMOVE_GRANT - - GOVERN_TAGS - type: string - id: GoogleCloudOrgpolicyV2CustomConstraint + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + description: >- + The response returned from the ListPolicies method. It will be empty if + no policies are set on the resource. + id: GoogleCloudOrgpolicyV2ListPoliciesResponse type: object GoogleProtobufEmpty: - properties: {} - id: GoogleProtobufEmpty - type: object description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + properties: {} + id: GoogleProtobufEmpty + type: object + GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + type: object + properties: + deniedValues: + description: List of values denied at this resource. + items: + type: string + type: array + allowedValues: + description: List of values allowed at this resource. + type: array + items: + type: string + description: >- + A message that holds specific allowed and denied values. This message + can define specific values and subtrees of the Resource Manager resource + hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or + denied. This is achieved by using the `under:` and optional `is:` + prefixes. The `under:` prefix is used to denote resource subtree values. + The `is:` prefix is used to denote specific values, and is required only + if the value contains a ":". Values prefixed with "is:" are treated the + same as values with no prefix. Ancestry subtrees must be in one of the + following formats: - `projects/` (for example, + `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - + `organizations/` (for example, `organizations/1234`) The + `supports_under` field of the associated `Constraint` defines whether + ancestry prefixes can be used. + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + GoogleCloudOrgpolicyV2PolicySpecPolicyRule: + description: A rule used to express this policy. + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + type: object + properties: + enforce: + type: boolean + description: >- + If `true`, then the policy is enforced. If `false`, then any + configuration is acceptable. This field can be set only in policies + for boolean constraints. + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + A condition which determines whether this rule is used in the + evaluation of the policy. When set, the `expression` field in the + `Expr' must include from 1 to 10 subexpressions, joined by the "||" + or "&&" operators. Each subexpression must be of the form + "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". + or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". + where key_name and value_name are the resource names for Label Keys + and Values. These names are available from the Tag Manager Service. + An example expression is: "resource.matchTag('123456789/environment, + 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". + denyAll: + description: >- + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + type: boolean + values: + description: >- + List of values to be used for this policy rule. This field can be + set only in policies for list constraints. + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + allowAll: + description: >- + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + type: boolean GoogleCloudOrgpolicyV2ListConstraintsResponse: type: object + description: The response returned from the ListConstraints method. properties: nextPageToken: description: >- @@ -493,19 +494,15 @@ components: description: >- The collection of constraints that are available on the targeted resource. - type: array items: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Constraint' + type: array id: GoogleCloudOrgpolicyV2ListConstraintsResponse - description: The response returned from the ListConstraints method. parameters: - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token schema: type: string uploadType: @@ -514,28 +511,19 @@ components: name: uploadType schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: oauth_token + name: quotaUser schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + callback: + description: JSONP in: query - name: upload_protocol + name: callback schema: type: string alt: @@ -548,6 +536,12 @@ components: - json - media - proto + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean key: description: >- API key. Your API key identifies your project and provides you with API @@ -557,16 +551,22 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string - callback: - description: JSONP + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: callback + name: upload_protocol + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string _.xgafv: @@ -579,46 +579,106 @@ components: - '1' - '2' x-stackQL-resources: - policies: - id: google.orgpolicy.policies - name: policies - title: Policies + custom_constraints: + id: google.orgpolicy.custom_constraints + name: custom_constraints + title: Custom_constraints methods: - projects_policies_delete: + organizations_custom_constraints_get: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_custom_constraints_delete: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_custom_constraints_patch: + operation: + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_custom_constraints_list: operation: $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/get response: mediaType: application/json openAPIDocKey: '200' - projects_policies_get: + objectKey: $.customConstraints + organizations_custom_constraints_create: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post response: mediaType: application/json openAPIDocKey: '200' - projects_policies_patch: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_get + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_list + insert: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_create + update: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete + policies_effective_policy: + id: google.orgpolicy.policies_effective_policy + name: policies_effective_policy + title: Policies_effective_policy + methods: + organizations_policies_get_effective_policy: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' + $ref: >- + #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - projects_policies_create: + projects_policies_get_effective_policy: operation: - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get response: mediaType: application/json openAPIDocKey: '200' - _projects_policies_list: - operation: &ref_1 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' - response: &ref_2 + folders_policies_get_effective_policy: + operation: + $ref: >- + #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.policies - projects_policies_list: - operation: *ref_1 - response: *ref_2 + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/policies_effective_policy/methods/organizations_policies_get_effective_policy + - $ref: >- + #/components/x-stackQL-resources/policies_effective_policy/methods/projects_policies_get_effective_policy + - $ref: >- + #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy + insert: [] + update: [] + replace: [] + delete: [] + policies: + id: google.orgpolicy.policies + name: policies + title: Policies + methods: organizations_policies_get: operation: $ref: >- @@ -646,22 +706,45 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_policies_list: - operation: &ref_3 + organizations_policies_list: + operation: $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1policies/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - organizations_policies_list: - operation: *ref_3 - response: *ref_4 - folders_policies_patch: + projects_policies_delete: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + projects_policies_patch: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_policies_get: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_policies_create: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/post' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_policies_list: + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1policies/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.policies folders_policies_get: operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/get' @@ -674,219 +757,118 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_policies_create: + folders_policies_patch: operation: - $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - _folders_policies_list: - operation: &ref_5 + folders_policies_list: + operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.policies - folders_policies_list: - operation: *ref_5 - response: *ref_6 + folders_policies_create: + operation: + $ref: '#/paths/~1v2~1folders~1{foldersId}~1policies/post' + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_get + #/components/x-stackQL-resources/policies/methods/projects_policies_get - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_list + #/components/x-stackQL-resources/policies/methods/folders_policies_get - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_list + - $ref: >- + #/components/x-stackQL-resources/policies/methods/projects_policies_list - $ref: >- #/components/x-stackQL-resources/policies/methods/folders_policies_list insert: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_create - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_create + - $ref: >- + #/components/x-stackQL-resources/policies/methods/projects_policies_create - $ref: >- #/components/x-stackQL-resources/policies/methods/folders_policies_create update: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_patch - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_patch + - $ref: >- + #/components/x-stackQL-resources/policies/methods/projects_policies_patch - $ref: >- #/components/x-stackQL-resources/policies/methods/folders_policies_patch + replace: [] delete: - - $ref: >- - #/components/x-stackQL-resources/policies/methods/projects_policies_delete - $ref: >- #/components/x-stackQL-resources/policies/methods/organizations_policies_delete - $ref: >- - #/components/x-stackQL-resources/policies/methods/folders_policies_delete - policies_effective_policy: - id: google.orgpolicy.policies_effective_policy - name: policies_effective_policy - title: Policies_effective_policy - methods: - projects_policies_get_effective_policy: - operation: - $ref: >- - #/paths/~1v2~1projects~1{projectsId}~1policies~1{policiesId}:getEffectivePolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_policies_get_effective_policy: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1policies~1{policiesId}:getEffectivePolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - folders_policies_get_effective_policy: - operation: - $ref: >- - #/paths/~1v2~1folders~1{foldersId}~1policies~1{policiesId}:getEffectivePolicy/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/projects_policies_get_effective_policy - - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/organizations_policies_get_effective_policy + #/components/x-stackQL-resources/policies/methods/projects_policies_delete - $ref: >- - #/components/x-stackQL-resources/policies_effective_policy/methods/folders_policies_get_effective_policy - insert: [] - update: [] - delete: [] + #/components/x-stackQL-resources/policies/methods/folders_policies_delete constraints: id: google.orgpolicy.constraints name: constraints title: Constraints methods: - _projects_constraints_list: - operation: &ref_7 - $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' - response: &ref_8 + organizations_constraints_list: + operation: + $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.constraints projects_constraints_list: - operation: *ref_7 - response: *ref_8 - _organizations_constraints_list: - operation: &ref_9 - $ref: '#/paths/~1v2~1organizations~1{organizationsId}~1constraints/get' - response: &ref_10 + operation: + $ref: '#/paths/~1v2~1projects~1{projectsId}~1constraints/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.constraints - organizations_constraints_list: - operation: *ref_9 - response: *ref_10 - _folders_constraints_list: - operation: &ref_11 + folders_constraints_list: + operation: $ref: '#/paths/~1v2~1folders~1{foldersId}~1constraints/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.constraints - folders_constraints_list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/constraints/methods/projects_constraints_list - $ref: >- #/components/x-stackQL-resources/constraints/methods/organizations_constraints_list + - $ref: >- + #/components/x-stackQL-resources/constraints/methods/projects_constraints_list - $ref: >- #/components/x-stackQL-resources/constraints/methods/folders_constraints_list insert: [] update: [] + replace: [] delete: [] - custom_constraints: - id: google.orgpolicy.custom_constraints - name: custom_constraints - title: Custom_constraints - methods: - organizations_custom_constraints_get: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_custom_constraints_patch: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_custom_constraints_delete: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints~1{customConstraintsId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_custom_constraints_list: - operation: &ref_13 - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/get - response: &ref_14 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.customConstraints - organizations_custom_constraints_list: - operation: *ref_13 - response: *ref_14 - organizations_custom_constraints_create: - operation: - $ref: >- - #/paths/~1v2~1organizations~1{organizationsId}~1customConstraints/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_get - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_list - insert: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_create - update: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_patch - delete: - - $ref: >- - #/components/x-stackQL-resources/custom_constraints/methods/organizations_custom_constraints_delete paths: - /v2/projects/{projectsId}/policies/{policiesId}: - parameters: &ref_15 - - $ref: '#/components/parameters/quotaUser' + /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: + parameters: &ref_1 + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/_.xgafv' - delete: + get: description: >- - Deletes a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or organization policy - does not exist. - operationId: orgpolicy.projects.policies.delete + Gets a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. + operationId: orgpolicy.organizations.customConstraints.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -898,28 +880,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string - - in: query - name: etag - schema: - type: string - get: + delete: description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.projects.policies.get + Deletes a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. + operationId: orgpolicy.organizations.customConstraints.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -931,32 +908,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string patch: description: >- - Updates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not - exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if - the etag supplied in the request does not match the persisted etag of - the policy Note: the supplied policy will perform a full overwrite of - all fields. - operationId: orgpolicy.projects.policies.patch + Updates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the + supplied policy will perform a full overwrite of all fields. + operationId: orgpolicy.organizations.customConstraints.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -968,37 +942,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - in: path - name: policiesId + name: customConstraintsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v2/projects/{projectsId}/policies: - parameters: *ref_15 - post: + /v2/organizations/{organizationsId}/customConstraints: + parameters: *ref_1 + get: description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.projects.policies.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + Retrieves all of the custom constraints that exist on a particular + organization resource. + operationId: orgpolicy.organizations.customConstraints.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1010,16 +972,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.projects.policies.list + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: >- + Creates a custom constraint. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns + a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the + constraint already exists on the given organization. + operationId: orgpolicy.organizations.customConstraints.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1031,25 +1012,15 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_15 + /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_1 get: description: >- Gets the effective policy on a resource. This is the result of merging @@ -1057,7 +1028,7 @@ paths: returned policy will not have an `etag` or `condition` set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.projects.policies.getEffectivePolicy + operationId: orgpolicy.organizations.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1072,7 +1043,7 @@ paths: $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: projectsId + name: organizationsId required: true schema: type: string @@ -1081,74 +1052,8 @@ paths: required: true schema: type: string - /v2/projects/{projectsId}/constraints: - parameters: *ref_15 - get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.projects.constraints.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v2/organizations/{organizationsId}/constraints: - parameters: *ref_15 - get: - description: Lists constraints that could be applied on the specified resource. - operationId: orgpolicy.organizations.constraints.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse - parameters: - - in: path - name: organizationsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string /v2/organizations/{organizationsId}/policies/{policiesId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets a policy on a resource. If no policy is set on the resource, @@ -1254,7 +1159,7 @@ paths: schema: type: string /v2/organizations/{organizationsId}/policies: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Creates a policy. Returns a `google.rpc.Status` with @@ -1316,16 +1221,80 @@ paths: name: pageToken schema: type: string - /v2/organizations/{organizationsId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_15 + /v2/organizations/{organizationsId}/constraints: + parameters: *ref_1 get: + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.organizations.constraints.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v2/projects/{projectsId}/constraints: + parameters: *ref_1 + get: + description: Lists constraints that could be applied on the specified resource. + operationId: orgpolicy.projects.constraints.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListConstraintsResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v2/projects/{projectsId}/policies/{policiesId}: + parameters: *ref_1 + delete: description: >- - Gets the effective policy on a resource. This is the result of merging - policies in the resource hierarchy and evaluating conditions. The - returned policy will not have an `etag` or `condition` set because it is - an evaluated policy across multiple resources. Subtrees of Resource - Manager resource hierarchy with 'under:' prefix will not be expanded. - operationId: orgpolicy.organizations.policies.getEffectivePolicy + Deletes a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or organization policy + does not exist. + operationId: orgpolicy.projects.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1337,10 +1306,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1349,13 +1318,24 @@ paths: required: true schema: type: string - /v2/organizations/{organizationsId}/customConstraints/{customConstraintsId}: - parameters: *ref_15 - get: + - in: query + name: etag + schema: + type: string + patch: description: >- - Gets a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the custom constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.get + Updates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not + exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if + the etag supplied in the request does not match the persisted etag of + the policy Note: the supplied policy will perform a full overwrite of + all fields. + operationId: orgpolicy.projects.policies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1367,29 +1347,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: path - name: customConstraintsId + name: policiesId required: true schema: type: string - patch: + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + get: description: >- - Updates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the - supplied policy will perform a full overwrite of all fields. - operationId: orgpolicy.organizations.customConstraints.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.projects.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1401,23 +1381,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string - in: path - name: customConstraintsId + name: policiesId required: true schema: type: string - delete: + /v2/projects/{projectsId}/policies: + parameters: *ref_1 + post: description: >- - Deletes a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. - operationId: orgpolicy.organizations.customConstraints.delete + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.projects.policies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1429,25 +1418,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId - required: true - schema: - type: string - - in: path - name: customConstraintsId + name: projectsId required: true schema: type: string - /v2/organizations/{organizationsId}/customConstraints: - parameters: *ref_15 get: - description: >- - Retrieves all of the custom constraints that exist on a particular - organization resource. - operationId: orgpolicy.organizations.customConstraints.list + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.projects.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1460,10 +1440,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListCustomConstraintsResponse + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -1476,18 +1456,16 @@ paths: name: pageToken schema: type: string - post: + /v2/projects/{projectsId}/policies/{policiesId}:getEffectivePolicy: + parameters: *ref_1 + get: description: >- - Creates a custom constraint. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns - a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the - constraint already exists on the given organization. - operationId: orgpolicy.organizations.customConstraints.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + Gets the effective policy on a resource. This is the result of merging + policies in the resource hierarchy and evaluating conditions. The + returned policy will not have an `etag` or `condition` set because it is + an evaluated policy across multiple resources. Subtrees of Resource + Manager resource hierarchy with 'under:' prefix will not be expanded. + operationId: orgpolicy.projects.policies.getEffectivePolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1499,15 +1477,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path - name: organizationsId + name: projectsId + required: true + schema: + type: string + - in: path + name: policiesId required: true schema: type: string /v2/folders/{foldersId}/constraints: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists constraints that could be applied on the specified resource. operationId: orgpolicy.folders.constraints.list @@ -1530,31 +1513,23 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string /v2/folders/{foldersId}/policies/{policiesId}: - parameters: *ref_15 - patch: + parameters: *ref_1 + get: description: >- - Updates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not - exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if - the etag supplied in the request does not match the persisted etag of - the policy Note: the supplied policy will perform a full overwrite of - all fields. - operationId: orgpolicy.folders.policies.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + Gets a policy on a resource. If no policy is set on the resource, + `NOT_FOUND` is returned. The `etag` value can be used with + `UpdatePolicy()` to update a policy during read-modify-write. + operationId: orgpolicy.folders.policies.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1578,17 +1553,12 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: + delete: description: >- - Gets a policy on a resource. If no policy is set on the resource, - `NOT_FOUND` is returned. The `etag` value can be used with - `UpdatePolicy()` to update a policy during read-modify-write. - operationId: orgpolicy.folders.policies.get + Deletes a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or organization policy + does not exist. + operationId: orgpolicy.folders.policies.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1600,7 +1570,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: '#/components/schemas/GoogleProtobufEmpty' parameters: - in: path name: foldersId @@ -1612,12 +1582,24 @@ paths: required: true schema: type: string - delete: + - in: query + name: etag + schema: + type: string + patch: description: >- - Deletes a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint or organization policy - does not exist. - operationId: orgpolicy.folders.policies.delete + Updates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not + exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if + the etag supplied in the request does not match the persisted etag of + the policy Note: the supplied policy will perform a full overwrite of + all fields. + operationId: orgpolicy.folders.policies.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1629,7 +1611,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: foldersId @@ -1642,11 +1624,12 @@ paths: schema: type: string - in: query - name: etag + name: updateMask schema: type: string + format: google-fieldmask /v2/folders/{foldersId}/policies/{policiesId}:getEffectivePolicy: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the effective policy on a resource. This is the result of merging @@ -1679,19 +1662,10 @@ paths: schema: type: string /v2/folders/{foldersId}/policies: - parameters: *ref_15 - post: - description: >- - Creates a policy. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a - `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy - already exists on the given Google Cloud resource. - operationId: orgpolicy.folders.policies.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + parameters: *ref_1 + get: + description: Retrieves all of the policies that exist on a particular resource. + operationId: orgpolicy.folders.policies.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1703,16 +1677,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse parameters: - in: path name: foldersId required: true schema: type: string - get: - description: Retrieves all of the policies that exist on a particular resource. - operationId: orgpolicy.folders.policies.list + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: >- + Creates a policy. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Returns a + `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the policy + already exists on the given Google Cloud resource. + operationId: orgpolicy.folders.policies.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1724,20 +1717,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2ListPoliciesResponse + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' parameters: - in: path name: foldersId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml b/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml index 7f660cac..298640f3 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/osconfig.yaml @@ -9,8 +9,8 @@ info: OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/compute/docs/osconfig/rest servers: @@ -1811,7 +1811,7 @@ components: created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or failure to read this file will result in this ExecResource being - non-compliant. Output file size is limited to 100K bytes. + non-compliant. Output file size is limited to 500K bytes. type: string OSPolicyResourceFileResource: id: OSPolicyResourceFileResource @@ -2058,7 +2058,10 @@ components: Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service - errors were encountered while attempting to apply the policy. + errors were encountered while attempting to apply the policy. * + `os-policy-execution-pending`: OS policy was assigned to the given + VM, but was not executed yet. Typically this is a transient + condition that will go away after the next policy execution cycle. type: string osPolicyResourceCompliances: description: >- @@ -2110,7 +2113,9 @@ components: prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be - determined. + determined. * `os-policy-execution-pending`: OS policy that owns + this resource was assigned to the given VM, but was not executed + yet. type: string execResourceOutput: description: ExecResource specific output. @@ -2275,7 +2280,7 @@ components: description: The specific type of inventory, correlating to its specific details. type: string enumDescriptions: - - Invalid. An type must be specified. + - Invalid. A type must be specified. - This represents a package that is installed on the VM. - This represents an update that is available for a package. enum: @@ -3086,7 +3091,10 @@ components: - $ref: >- #/components/x-stackQL-resources/global_project_feature_settings/methods/get_project_feature_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/global_project_feature_settings/methods/update_project_feature_settings + replace: [] delete: [] os_policy_assignments: id: google.osconfig.os_policy_assignments @@ -3100,17 +3108,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.osPolicyAssignments - list: - operation: *ref_1 - response: *ref_2 patch: operation: $ref: >- @@ -3143,6 +3148,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/os_policy_assignments/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/os_policy_assignments/methods/delete @@ -3151,23 +3157,21 @@ components: name: os_policy_assignments_revisions title: Os_policy_assignments_revisions methods: - _list_revisions: - operation: &ref_3 + list_revisions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1osPolicyAssignments~1{osPolicyAssignmentsId}:listRevisions/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.osPolicyAssignments - list_revisions: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/os_policy_assignments_revisions/methods/list_revisions insert: [] update: [] + replace: [] delete: [] operations: id: google.osconfig.operations @@ -3193,6 +3197,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/get' insert: [] update: [] + replace: [] delete: [] report: id: google.osconfig.report @@ -3211,28 +3216,27 @@ components: - $ref: '#/components/x-stackQL-resources/report/methods/get' insert: [] update: [] + replace: [] delete: [] reports: id: google.osconfig.reports name: reports title: Reports methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1osPolicyAssignments~1{osPolicyAssignmentsId}~1reports/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.osPolicyAssignmentReports - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/reports/methods/list' insert: [] update: [] + replace: [] delete: [] inventory: id: google.osconfig.inventory @@ -3250,28 +3254,27 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] inventories: id: google.osconfig.inventories name: inventories title: Inventories methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1inventories/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.inventories - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/inventories/methods/list' insert: [] update: [] + replace: [] delete: [] vulnerability_report: id: google.osconfig.vulnerability_report @@ -3290,29 +3293,28 @@ components: - $ref: '#/components/x-stackQL-resources/vulnerability_report/methods/get' insert: [] update: [] + replace: [] delete: [] vulnerability_reports: id: google.osconfig.vulnerability_reports name: vulnerability_reports title: Vulnerability_reports methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances~1{instancesId}~1vulnerabilityReports/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.vulnerabilityReports - list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/vulnerability_reports/methods/list insert: [] update: [] + replace: [] delete: [] patch_jobs: id: google.osconfig.patch_jobs @@ -3338,44 +3340,40 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1patchJobs/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.patchJobs - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/patch_jobs/methods/get' - $ref: '#/components/x-stackQL-resources/patch_jobs/methods/list' insert: [] update: [] + replace: [] delete: [] instance_details: id: google.osconfig.instance_details name: instance_details title: Instance_details methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1patchJobs~1{patchJobsId}~1instanceDetails/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.patchJobInstanceDetails - list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/instance_details/methods/list' insert: [] update: [] + replace: [] delete: [] patch_deployments: id: google.osconfig.patch_deployments @@ -3388,16 +3386,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1patchDeployments/get' - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.patchDeployments - list: - operation: *ref_15 - response: *ref_16 get: operation: $ref: >- @@ -3441,11 +3436,12 @@ components: - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/create' update: - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/patch_deployments/methods/delete' paths: /v1/projects/{projectsId}/locations/global/projectFeatureSettings: - parameters: &ref_17 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3512,7 +3508,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Create an OS policy assignment. This method also creates the first @@ -3595,7 +3591,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}: - parameters: *ref_17 + parameters: *ref_1 patch: description: >- Update an existing OS policy assignment. This method creates a new @@ -3727,7 +3723,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}:listRevisions: - parameters: *ref_17 + parameters: *ref_1 get: description: >- List the OS policy assignment revisions for a given OS policy @@ -3771,7 +3767,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3812,7 +3808,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}:cancel: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3864,7 +3860,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/report: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Get the OS policy assignment report for the specified Compute Engine VM @@ -3904,7 +3900,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/reports: - parameters: *ref_17 + parameters: *ref_1 get: description: >- List OS policy assignment reports for all Compute Engine VM instances in @@ -3957,7 +3953,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventory: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Get inventory data for the specified VM instance. If the VM has no @@ -3996,7 +3992,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventories: - parameters: *ref_17 + parameters: *ref_1 get: description: List inventory data for all VM instances in the specified zone. operationId: osconfig.projects.locations.instances.inventories.list @@ -4046,7 +4042,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReport: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the vulnerability report for the specified VM instance. Only VMs @@ -4081,7 +4077,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReports: - parameters: *ref_17 + parameters: *ref_1 get: description: List vulnerability reports for all VM instances in the specified zone. operationId: osconfig.projects.locations.instances.vulnerabilityReports.list @@ -4127,7 +4123,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchJobs:execute: - parameters: *ref_17 + parameters: *ref_1 post: description: Patch VM instances by creating and running a patch job. operationId: osconfig.projects.patchJobs.execute @@ -4155,7 +4151,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchJobs/{patchJobsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Get the patch job. This can be used to track the progress of an ongoing @@ -4185,7 +4181,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchJobs/{patchJobsId}:cancel: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Cancel a patch job. The patch job must be active. Canceled patch jobs @@ -4220,7 +4216,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchJobs: - parameters: *ref_17 + parameters: *ref_1 get: description: Get a list of patch jobs. operationId: osconfig.projects.patchJobs.list @@ -4256,7 +4252,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchJobs/{patchJobsId}/instanceDetails: - parameters: *ref_17 + parameters: *ref_1 get: description: Get a list of instance details for a given patch job. operationId: osconfig.projects.patchJobs.instanceDetails.list @@ -4297,7 +4293,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchDeployments: - parameters: *ref_17 + parameters: *ref_1 post: description: Create an OS Config patch deployment. operationId: osconfig.projects.patchDeployments.create @@ -4359,7 +4355,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Get an OS Config patch deployment. operationId: osconfig.projects.patchDeployments.get @@ -4449,7 +4445,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:pause: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Change state of patch deployment to "PAUSED". Patch deployment in paused @@ -4484,7 +4480,7 @@ paths: schema: type: string /v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:resume: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Change state of patch deployment back to "ACTIVE". Patch deployment in diff --git a/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml b/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml index 0f15515f..58b52158 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/oslogin.yaml @@ -7,8 +7,8 @@ info: title: Cloud OS Login API description: You can use OS Login to manage access to your VM instances using IAM roles. version: v1 - x-discovery-doc-revision: '20240519' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240825' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/compute/docs/oslogin/ servers: @@ -251,6 +251,7 @@ components: #/components/x-stackQL-resources/users_login_profile/methods/get_login_profile insert: [] update: [] + replace: [] delete: [] users: id: google.oslogin.users @@ -267,6 +268,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] ssh_public_keys: id: google.oslogin.ssh_public_keys @@ -307,6 +309,7 @@ components: - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/create' update: - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/delete' projects: @@ -324,6 +327,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/projects/methods/delete' paths: diff --git a/providers/src/googleapis.com/v00.00.00000/services/places.yaml b/providers/src/googleapis.com/v00.00.00000/services/places.yaml index 5ae56801..01a7c0ed 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/places.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/places.yaml @@ -7,8 +7,8 @@ info: title: Places API (New) description: '' version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://mapsplatform.google.com/maps-products/#places-section servers: @@ -22,24 +22,24 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/maps-platform.places.nearbysearch: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.nearbysearch https://www.googleapis.com/auth/maps-platform.places: >- Private Service: https://www.googleapis.com/auth/maps-platform.places https://www.googleapis.com/auth/maps-platform.places.details: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.details - https://www.googleapis.com/auth/maps-platform.places.textsearch: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places.textsearch https://www.googleapis.com/auth/maps-platform.places.autocomplete: >- Private Service: https://www.googleapis.com/auth/maps-platform.places.autocomplete + https://www.googleapis.com/auth/maps-platform.places.textsearch: >- + Private Service: + https://www.googleapis.com/auth/maps-platform.places.textsearch https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. - https://www.googleapis.com/auth/maps-platform.places.nearbysearch: >- - Private Service: - https://www.googleapis.com/auth/maps-platform.places.nearbysearch Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -49,77 +49,18 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleTypeLocalizedText: - description: Localized variant of a text in a particular language. - properties: - languageCode: - type: string - description: >- - The text's BCP-47 language code, such as "en-US" or "sr-Latn". For - more information, see - http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - text: - type: string - description: >- - Localized string in the language corresponding to language_code - below. - id: GoogleTypeLocalizedText - type: object - GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: - properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by a center point and radius. - rectangle: - description: A viewport defined by a northeast and a southwest corner. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - description: >- - The region to search. The results may be biased around the specified - region. - type: object - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: - id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction - properties: - circle: - description: A circle defined by center point and radius. - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: The region to search. - type: object - GoogleMapsPlacesV1AuthorAttribution: - properties: - uri: - type: string - description: URI of the author of the Photo or Review. - photoUri: - description: Profile photo URI of the author of the Photo or Review. - type: string - displayName: - description: Name of the author of the Photo or Review. - type: string - description: Information about the author of the UGC data. Used in Photo, and Review. - type: object - id: GoogleMapsPlacesV1AuthorAttribution GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction - type: object description: Prediction results for a Place Autocomplete prediction. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction properties: - types: - items: - type: string - description: >- - List of types that apply to this Place from Table A or Table B in - https://developers.google.com/maps/documentation/places/web-service/place-types. - A type is a categorization of a Place. Places with shared types will - share similar characteristics. - type: array placeId: type: string description: >- The unique identifier of the suggested Place. This identifier can be used in other APIs that accept Place IDs. structuredFormat: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat description: >- A breakdown of the Place prediction into main text containing the name of the Place and secondary text containing additional @@ -129,16 +70,9 @@ components: a single UI element may want to use `text` instead. They are two different ways to represent a Place prediction. Users should not try to parse `structured_format` into `text` or vice versa. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - distanceMeters: - type: integer - format: int32 - description: >- - The length of the geodesic in meters from `origin` if `origin` is - specified. Certain predictions such as routes may not populate this - field. text: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText description: >- Contains the human-readable name for the returned result. For establishment results, this is usually the business name and @@ -151,305 +85,328 @@ components: by GetPlace. May be in mixed languages if the request `input` and `language_code` are in different languages or if the Place does not have a translation from the local language to `language_code`. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + distanceMeters: + type: integer + format: int32 + description: >- + The length of the geodesic in meters from `origin` if `origin` is + specified. Certain predictions such as routes may not populate this + field. + types: + type: array + description: >- + List of types that apply to this Place from Table A or Table B in + https://developers.google.com/maps/documentation/places/web-service/place-types. + A type is a categorization of a Place. Places with shared types will + share similar characteristics. + items: + type: string place: type: string description: >- The resource name of the suggested Place. This name can be used in other APIs that accept Place names. - GoogleTypeMoney: - description: Represents an amount of money with its currency type. - properties: - nanos: - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - currencyCode: - description: The three-letter currency code defined in ISO 4217. - type: string - units: - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - format: int64 type: object - id: GoogleTypeMoney - GoogleMapsPlacesV1EVChargeOptions: + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: + description: Prediction results for a Query Autocomplete prediction. type: object - id: GoogleMapsPlacesV1EVChargeOptions properties: - connectorAggregation: - type: array + text: description: >- - A list of EV charging connector aggregations that contain connectors - of the same type and same charge rate. - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation - connectorCount: + The predicted text. This text does not represent a Place, but rather + a text query that could be used in a search endpoint (for example, + Text Search). `text` is recommended for developers who wish to show + a single UI element. Developers who wish to show two separate, but + related, UI elements may want to use `structured_format` instead. + They are two different ways to represent a query prediction. Users + should not try to parse `structured_format` into `text` or vice + versa. May be in mixed languages if the request `input` and + `language_code` are in different languages or if part of the query + does not have a translation from the local language to + `language_code`. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + structuredFormat: description: >- - Number of connectors at this station. However, because some ports - can have multiple connectors but only be able to charge one car at a - time (e.g.) the number of connectors may be greater than the total - number of cars which can charge simultaneously. - type: integer - format: int32 - description: >- - Information about the EV Charge Station hosted in Place. Terminology - follows https://afdc.energy.gov/fuels/electricity_infrastructure.html - One port could charge one car at a time. One port has one or more - connectors. One station has one or more ports. - GoogleMapsPlacesV1SearchTextRequest: - type: object - description: 'Request proto for SearchText. ' - id: GoogleMapsPlacesV1SearchTextRequest + A breakdown of the query prediction into main text containing the + query and secondary text containing additional disambiguating + features (such as a city or region). `structured_format` is + recommended for developers who wish to show two separate, but + related, UI elements. Developers who wish to show a single UI + element may want to use `text` instead. They are two different ways + to represent a query prediction. Users should not try to parse + `structured_format` into `text` or vice versa. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + GoogleMapsPlacesV1SearchTextRequestEVOptions: properties: - priceLevels: + connectorTypes: items: + enumDescriptions: + - Unspecified connector. + - Other connector types. + - J1772 type 1 connector. + - IEC 62196 type 2 connector. Often referred to as MENNEKES. + - CHAdeMO type connector. + - >- + Combined Charging System (AC and DC). Based on SAE. Type-1 + J-1772 connector + - >- + Combined Charging System (AC and DC). Based on Type-2 Mennekes + connector + - >- + The generic TESLA connector. This is NACS in the North America + but can be non-NACS in other parts of the world (e.g. CCS Combo + 2 (CCS2) or GB/T). This value is less representative of an + actual connector type, and more represents the ability to charge + a Tesla brand vehicle at a Tesla owned charging station. + - >- + GB/T type corresponds to the GB/T standard in China. This type + covers all GB_T types. + - Unspecified wall outlet. type: string enum: - - PRICE_LEVEL_UNSPECIFIED - - PRICE_LEVEL_FREE - - PRICE_LEVEL_INEXPENSIVE - - PRICE_LEVEL_MODERATE - - PRICE_LEVEL_EXPENSIVE - - PRICE_LEVEL_VERY_EXPENSIVE - enumDescriptions: - - Place price level is unspecified or unknown. - - Place provides free services. - - Place provides inexpensive services. - - Place provides moderately priced services. - - Place provides expensive services. - - Place provides very expensive services. + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET description: >- - Used to restrict the search to places that are marked as certain - price levels. Users can choose any combinations of price levels. - Default to select all price levels. + Optional. The list of preferred EV connector types. A place that + does not support any of the listed connector types is filtered out. type: array - minRating: + minimumChargingRateKw: format: double - description: >- - Filter out results whose average user rating is strictly less than - this limit. A valid value must be a float between 0 and 5 - (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] - inclusively. The input rating will round up to the nearest - 0.5(ceiling). For instance, a rating of 0.6 will eliminate all - results with a less than 1.0 rating. type: number - regionCode: - type: string - description: >- - The Unicode country/region code (CLDR) of the location where the - request is coming from. This parameter is used to display the place - details, like region-specific place name, if available. The - parameter can affect results based on applicable law. For more - information, see - https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. - Note that 3-digit region codes are not currently supported. - openNow: description: >- - Used to restrict the search to places that are currently open. The - default is false. - type: boolean - textQuery: - type: string - description: Required. The text query for textual search. - pageSize: - format: int32 + Optional. Minimum required charging rate in kilowatts. A place with + a charging rate less than the specified rate is filtered out. + description: Searchable EV options of a place search request. + id: GoogleMapsPlacesV1SearchTextRequestEVOptions + type: object + GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction + description: >- + The region to search. The results will be restricted to the specified + region. + type: object + properties: + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by a center point and radius. + rectangle: + $ref: '#/components/schemas/GoogleGeoTypeViewport' + description: A viewport defined by a northeast and a southwest corner. + GoogleTypeDate: + id: GoogleTypeDate + type: object + properties: + year: description: >- - Optional. The maximum number of results per page that can be - returned. If the number of available results is larger than - `page_size`, a `next_page_token` is returned which can be passed to - `page_token` to get the next page of results in subsequent requests. - If 0 or no value is provided, a default of 20 is used. The maximum - value is 20; values above 20 will be set to 20. Negative values will - return an INVALID_ARGUMENT error. If both `max_result_count` and - `page_size` are specified, `max_result_count` will be ignored. + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 type: integer - evOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' - description: Optional. Set the searchable EV options of a place search request. - locationBias: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' + day: + format: int32 description: >- - The region to search. This location serves as a bias which means - results around given location might be returned. Cannot be set along - with location_restriction. - pageToken: - type: string + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + month: + format: int32 + type: integer description: >- - Optional. A page token, received from a previous TextSearch call. - Provide this to retrieve the subsequent page. When paginating, all - parameters other than `page_token`, `page_size`, and - `max_result_count` provided to TextSearch must match the initial - call that provided the page token. Otherwise an INVALID_ARGUMENT - error is returned. - locationRestriction: + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: + type: object + properties: + mainText: $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: Represents the name of the Place or query. + secondaryText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText description: >- - The region to search. This location serves as a restriction which - means results outside given location will not be returned. Cannot be - set along with location_bias. - includedType: + Represents additional disambiguating features (such as a city or + region) to further identify the Place or refine the query. + description: >- + Contains a breakdown of a Place or query prediction into main text and + secondary text. For Place predictions, the main text contains the + specific name of the Place. For query predictions, the main text + contains the query. The secondary text contains additional + disambiguating features (such as a city or region) to further identify + the Place or refine the query. + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange + properties: + endOffset: + description: Zero-based offset of the last Unicode character (exclusive). + type: integer + format: int32 + startOffset: + type: integer description: >- - The requested place type. Full list of types supported: - https://developers.google.com/maps/documentation/places/web-service/place-types. - Only support one included type. - type: string - languageCode: + Zero-based offset of the first Unicode character of the string + (inclusive). + format: int32 + type: object + description: Identifies a substring within a given text. + GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction: + type: object + id: GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + properties: + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by center point and radius. + description: The region to search. + GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: + type: object + id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + description: >- + EV charging information grouped by [type, max_charge_rate_kw]. Shows EV + charge aggregation of connectors that have the same type and max charge + rate in kw. + properties: + availabilityLastUpdateTime: type: string + format: google-datetime description: >- - Place details will be displayed with the preferred language if - available. If the language code is unspecified or unrecognized, - place details of any language may be returned, with a preference for - English if such details exist. Current list of supported languages: - https://developers.google.com/maps/faq#languagesupport. - strictTypeFiltering: - type: boolean + The timestamp when the connector availability information in this + aggregation was last updated. + maxChargeRateKw: + type: number + format: double description: >- - Used to set strict type filtering for included_type. If set to true, - only results of the same type will be returned. Default to false. - maxResultCount: + The static max charging rate in kw of each connector in the + aggregation. + outOfServiceCount: type: integer - deprecated: true - format: int32 description: >- - Deprecated: Use `page_size` instead. The maximum number of results - per page that can be returned. If the number of available results is - larger than `max_result_count`, a `next_page_token` is returned - which can be passed to `page_token` to get the next page of results - in subsequent requests. If 0 or no value is provided, a default of - 20 is used. The maximum value is 20; values above 20 will be coerced - to 20. Negative values will return an INVALID_ARGUMENT error. If - both `max_result_count` and `page_size` are specified, - `max_result_count` will be ignored. - rankPreference: + Number of connectors in this aggregation that are currently out of + service. + format: int32 + count: + format: int32 + type: integer + description: Number of connectors in this aggregation. + type: + type: string + description: The connector type of this aggregation. + enum: + - EV_CONNECTOR_TYPE_UNSPECIFIED + - EV_CONNECTOR_TYPE_OTHER + - EV_CONNECTOR_TYPE_J1772 + - EV_CONNECTOR_TYPE_TYPE_2 + - EV_CONNECTOR_TYPE_CHADEMO + - EV_CONNECTOR_TYPE_CCS_COMBO_1 + - EV_CONNECTOR_TYPE_CCS_COMBO_2 + - EV_CONNECTOR_TYPE_TESLA + - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T + - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET enumDescriptions: + - Unspecified connector. + - Other connector types. + - J1772 type 1 connector. + - IEC 62196 type 2 connector. Often referred to as MENNEKES. + - CHAdeMO type connector. - >- - For a categorical query such as "Restaurants in New York City", - RELEVANCE is the default. For non-categorical queries such as - "Mountain View, CA" we recommend that you leave rankPreference - unset. - - Ranks results by distance. + Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 + connector - >- - Ranks results by relevance. Sort order determined by normal - ranking stack. - enum: - - RANK_PREFERENCE_UNSPECIFIED - - DISTANCE - - RELEVANCE - description: How results will be ranked in the response. - type: string - GoogleMapsPlacesV1SearchTextRequestEVOptions: - id: GoogleMapsPlacesV1SearchTextRequestEVOptions + Combined Charging System (AC and DC). Based on Type-2 Mennekes + connector + - >- + The generic TESLA connector. This is NACS in the North America but + can be non-NACS in other parts of the world (e.g. CCS Combo 2 + (CCS2) or GB/T). This value is less representative of an actual + connector type, and more represents the ability to charge a Tesla + brand vehicle at a Tesla owned charging station. + - >- + GB/T type corresponds to the GB/T standard in China. This type + covers all GB_T types. + - Unspecified wall outlet. + availableCount: + description: >- + Number of connectors in this aggregation that are currently + available. + format: int32 + type: integer + GoogleMapsPlacesV1ContextualContent: type: object - description: Searchable EV options of a place search request. + id: GoogleMapsPlacesV1ContextualContent properties: - minimumChargingRateKw: - format: double - description: >- - Optional. Minimum required charging rate in kilowatts. A place with - a charging rate less than the specified rate is filtered out. - type: number - connectorTypes: - items: - type: string - enumDescriptions: - - Unspecified connector. - - Other connector types. - - J1772 type 1 connector. - - IEC 62196 type 2 connector. Often referred to as MENNEKES. - - CHAdeMO type connector. - - >- - Combined Charging System (AC and DC). Based on SAE. Type-1 - J-1772 connector - - >- - Combined Charging System (AC and DC). Based on Type-2 Mennekes - connector - - >- - The generic TESLA connector. This is NACS in the North America - but can be non-NACS in other parts of the world (e.g. CCS Combo - 2 (CCS2) or GB/T). This value is less representative of an - actual connector type, and more represents the ability to charge - a Tesla brand vehicle at a Tesla owned charging station. - - >- - GB/T type corresponds to the GB/T standard in China. This type - covers all GB_T types. - - Unspecified wall outlet. - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET + justifications: type: array description: >- - Optional. The list of preferred EV connector types. A place that - does not support any of the listed connector types is filtered out. - GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction: - id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification + photos: + type: array + description: >- + Information (including references) about photos of this place, + contexual to the place query. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' + reviews: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + description: List of reviews about this place, contexual to the place query. description: >- - The region to search. The results will be restricted to the specified - region. + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Content that is contextual to the place query. + GoogleMapsPlacesV1ContentBlock: + description: A block of content that can be served individually. type: object + id: GoogleMapsPlacesV1ContentBlock properties: - rectangle: - description: A viewport defined by a northeast and a southwest corner. - $ref: '#/components/schemas/GoogleGeoTypeViewport' - circle: - description: A circle defined by a center point and radius. - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + references: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. References that are related to this block of + content. + $ref: '#/components/schemas/GoogleMapsPlacesV1References' + topic: + type: string + description: The topic of the content, for example "overview" or "restaurant". + content: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: Content related to the topic. GoogleMapsPlacesV1AutocompletePlacesRequest: - description: Request proto for AutocompletePlaces. + type: object + id: GoogleMapsPlacesV1AutocompletePlacesRequest properties: - includedRegionCodes: - description: >- - Optional. Only include results in the specified regions, specified - as up to 15 CLDR two-character region codes. An empty set will not - restrict the results. If both `location_restriction` and - `included_region_codes` are set, the results will be located in the - area of intersection. + includedPrimaryTypes: items: type: string type: array - regionCode: - type: string - description: >- - Optional. The region code, specified as a CLDR two-character region - code. This affects address formatting, result ranking, and may - influence what results are returned. This does not restrict results - to the specified region. To restrict results to a region, use - `region_code_restriction`. - locationBias: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias - description: >- - Optional. Bias results to a specified location. At most one of - `location_bias` or `location_restriction` should be set. If neither - are set, the results will be biased by IP address, meaning the IP - address will be mapped to an imprecise location and used as a - biasing signal. - origin: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: >- - Optional. The origin point from which to calculate geodesic distance - to the destination (returned as `distance_meters`). If this value is - omitted, geodesic distance will not be returned. - includedPrimaryTypes: description: >- Optional. Included primary Place type (for example, "restaurant" or "gas_station") in Place Types @@ -457,9 +414,15 @@ components: or only `(regions)`, or only `(cities)`. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned. - type: array - items: - type: string + locationRestriction: + description: >- + Optional. Restrict results to a specified location. At most one of + `location_bias` or `location_restriction` should be set. If neither + are set, the results will be biased by IP address, meaning the IP + address will be mapped to an imprecise location and used as a + biasing signal. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction languageCode: type: string description: >- @@ -468,6 +431,16 @@ components: `input` is different from `language_code` or if the returned Place does not have a translation from the local language to `language_code`. + includedRegionCodes: + items: + type: string + type: array + description: >- + Optional. Only include results in the specified regions, specified + as up to 15 CLDR two-character region codes. An empty set will not + restrict the results. If both `location_restriction` and + `included_region_codes` are set, the results will be located in the + area of intersection. sessionToken: type: string description: >- @@ -492,259 +465,371 @@ components: the same Cloud Console project. * Be sure to pass a unique session token for each new session. Using the same token for more than one session will result in each request being billed individually. - inputOffset: - type: integer - format: int32 - description: >- - Optional. A zero-based Unicode character offset of `input` - indicating the cursor position in `input`. The cursor position may - influence what predictions are returned. If empty, defaults to the - length of `input`. - input: - type: string - description: Required. The text string on which to search. - locationRestriction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction + locationBias: description: >- - Optional. Restrict results to a specified location. At most one of + Optional. Bias results to a specified location. At most one of `location_bias` or `location_restriction` should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal. - includeQueryPredictions: - type: boolean - description: >- - Optional. If true, the response will include both Place and query - predictions. Otherwise the response will only return Place - predictions. - id: GoogleMapsPlacesV1AutocompletePlacesRequest - type: object - GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: - type: object - id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. User review justifications. This highlights a section - of the user review that would interest an end user. For instance, if the - search query is "firewood pizza", the review justification highlights - the text relevant to the search query. - properties: - review: - description: The review that the highlighted text is generated from. - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - highlightedText: $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText - GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: - properties: - date: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of this special day. - type: object - id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay - description: >- - Structured information for special days that fall within the period that - the returned opening hours cover. Special days are days that could - impact the business hours of a place, e.g. Christmas day. - GoogleMapsPlacesV1PlaceAreaSummary: - properties: - contentBlocks: - description: >- - Content blocks that compose the area summary. Each block has a - separate topic about the area. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is in. - id: GoogleMapsPlacesV1PlaceAreaSummary - type: object - GoogleMapsPlacesV1AutocompletePlacesResponse: - id: GoogleMapsPlacesV1AutocompletePlacesResponse - properties: - suggestions: - items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias + inputOffset: description: >- - Contains a list of suggestions, ordered in descending order of - relevance. - type: array - type: object - description: Response proto for AutocompletePlaces. - GoogleMapsPlacesV1PlaceOpeningHours: - id: GoogleMapsPlacesV1PlaceOpeningHours - type: object - properties: - weekdayDescriptions: - items: - type: string + Optional. A zero-based Unicode character offset of `input` + indicating the cursor position in `input`. The cursor position may + influence what predictions are returned. If empty, defaults to the + length of `input`. + format: int32 + type: integer + origin: + $ref: '#/components/schemas/GoogleTypeLatLng' description: >- - Localized strings describing the opening hours of this place, one - string for each day of the week. Will be empty if the hours are - unknown or could not be converted to localized text. Example: "Sun: - 18:00–06:00" - type: array - secondaryHoursType: - enumDescriptions: - - Default value when secondary hour type is not specified. - - The drive-through hour for banks, restaurants, or pharmacies. - - The happy hour. - - The delivery hour. - - The takeout hour. - - The kitchen hour. - - The breakfast hour. - - The lunch hour. - - The dinner hour. - - The brunch hour. - - The pickup hour. - - The access hours for storage places. - - The special hours for seniors. - - The online service hours. - enum: - - SECONDARY_HOURS_TYPE_UNSPECIFIED - - DRIVE_THROUGH - - HAPPY_HOUR - - DELIVERY - - TAKEOUT - - KITCHEN - - BREAKFAST - - LUNCH - - DINNER - - BRUNCH - - PICKUP - - ACCESS - - SENIOR_HOURS - - ONLINE_SERVICE_HOURS + Optional. The origin point from which to calculate geodesic distance + to the destination (returned as `distance_meters`). If this value is + omitted, geodesic distance will not be returned. + regionCode: type: string - description: A type string used to identify the type of secondary hours. - specialDays: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' - description: >- - Structured information for special days that fall within the period - that the returned opening hours cover. Special days are days that - could impact the business hours of a place, e.g. Christmas day. Set - for current_opening_hours and current_secondary_opening_hours if - there are exceptional hours. - type: array - openNow: - type: boolean description: >- - Is this place open right now? Always present unless we lack - time-of-day or timezone data for these opening hours. - periods: + Optional. The region code, specified as a CLDR two-character region + code. This affects address formatting, result ranking, and may + influence what results are returned. This does not restrict results + to the specified region. To restrict results to a region, use + `region_code_restriction`. + input: + type: string + description: Required. The text string on which to search. + includeQueryPredictions: + type: boolean description: >- - The periods that this place is open during the week. The periods are - in chronological order, starting with Sunday in the place-local - timezone. An empty (but not absent) value indicates a place that is - never open, e.g. because it is closed temporarily for renovations. - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' - description: Information about business hour of the place. - GoogleMapsPlacesV1PlaceSubDestination: - id: GoogleMapsPlacesV1PlaceSubDestination - description: >- - Place resource name and id of sub destinations that relate to the place. - For example, different terminals are different destinations of an - airport. + Optional. If true, the response will include both Place and query + predictions. Otherwise the response will only return Place + predictions. + description: Request proto for AutocompletePlaces. + GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias: type: object + description: >- + The region to search. The results may be biased around the specified + region. + id: GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias properties: - id: - type: string - description: The place id of the sub destination. - name: - type: string - description: The resource name of the sub destination. - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: - properties: - queryPrediction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction - description: A prediction for a query. - placePrediction: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction - description: A prediction for a Place. - type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion - description: An Autocomplete suggestion result. + circle: + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' + description: A circle defined by a center point and radius. + rectangle: + description: A viewport defined by a northeast and a southwest corner. + $ref: '#/components/schemas/GoogleGeoTypeViewport' GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange: + type: object id: >- GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange description: The range of highlighted text. properties: - endIndex: + startIndex: format: int32 type: integer - startIndex: + endIndex: type: integer format: int32 + GoogleMapsPlacesV1Circle: type: object - GoogleMapsPlacesV1FuelOptions: - id: GoogleMapsPlacesV1FuelOptions + description: Circle with a LatLng as center and radius. + id: GoogleMapsPlacesV1Circle properties: - fuelPrices: + radius: description: >- - The last known fuel price for each type of fuel this station has. - There is one entry per fuel type this station has. Order is not - important. + Required. Radius measured in meters. The radius must be within [0.0, + 50000.0]. + type: number + format: double + center: + description: >- + Required. Center latitude and longitude. The range of latitude must + be within [-90.0, 90.0]. The range of the longitude must be within + [-180.0, 180.0]. + $ref: '#/components/schemas/GoogleTypeLatLng' + GoogleMapsPlacesV1SearchNearbyResponse: + description: 'Response proto for Search Nearby. ' + properties: + places: + description: >- + A list of places that meets user's requirements like places types, + number of places and specific location restriction. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' type: array + id: GoogleMapsPlacesV1SearchNearbyResponse + type: object + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: description: >- - The most recent information about fuel options in a gas station. This - information is updated regularly. + The text highlighted by the justification. This is a subset of the + review itself. The exact word to highlight is marked by the + HighlightedTextRange. There could be several words in the text being + highlighted. + id: >- + GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText type: object - GoogleMapsPlacesV1PlaceOpeningHoursPeriod: + properties: + text: + type: string + highlightedTextRanges: + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange + description: The list of the ranges of the highlighted text. + GoogleMapsPlacesV1ContextualContentJustification: + id: GoogleMapsPlacesV1ContextualContentJustification type: object properties: - open: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: The time that the place starts to be open. - close: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' - description: The time that the place starts to be closed. - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod - description: A period the place remains in open_now status. + businessAvailabilityAttributesJustification: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. + reviewJustification: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Justifications for the place. Justifications answers + the question of why a place could interest an end user. GoogleMapsPlacesV1PlaceAddressComponent: + type: object + id: GoogleMapsPlacesV1PlaceAddressComponent properties: + languageCode: + type: string + description: The language used to format this components, in CLDR notation. types: + type: array items: type: string - type: array description: An array indicating the type(s) of the address component. - languageCode: + longText: + type: string + description: >- + The full text description or name of the address component. For + example, an address component for the country Australia may have a + long_name of "Australia". + shortText: + type: string + description: >- + An abbreviated textual name for the address component, if available. + For example, an address component for the country of Australia may + have a short_name of "AU". + description: >- + The structured components that form the formatted address, if this + information is available. + GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. BusinessAvailabilityAttributes justifications. This + shows some attributes a business has that could interest an end user. + properties: + takeout: + description: If a place provides takeout. + type: boolean + dineIn: + type: boolean + description: If a place provides dine-in. + delivery: + description: If a place provides delivery. + type: boolean + id: >- + GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification + type: object + GoogleMapsPlacesV1SearchNearbyRequest: + description: 'Request proto for Search Nearby. ' + type: object + properties: + includedPrimaryTypes: + type: array + items: + type: string + description: >- + Included primary Place type (e.g. "restaurant" or "gas_station") + from + https://developers.google.com/maps/documentation/places/web-service/place-types. + A place can only have a single primary type from the supported types + table associated with it. Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting primary types, i.e. a + type appears in both included_primary_types and + excluded_primary_types, an INVALID_ARGUMENT error is returned. If a + Place type is specified with multiple type restrictions, only places + that satisfy all of the restrictions are returned. For example, if + we have {included_types = ["restaurant"], excluded_primary_types = + ["restaurant"]}, the returned places provide "restaurant" related + services but do not operate primarily as "restaurants". + maxResultCount: + description: >- + Maximum number of results to return. It must be between 1 and 20 + (default), inclusively. If the number is unset, it falls back to the + upper limit. If the number is set to negative or exceeds the upper + limit, an INVALID_ARGUMENT error is returned. + type: integer + format: int32 + excludedPrimaryTypes: + type: array + description: >- + Excluded primary Place type (e.g. "restaurant" or "gas_station") + from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting primary types, i.e. a + type appears in both included_primary_types and + excluded_primary_types, an INVALID_ARGUMENT error is returned. If a + Place type is specified with multiple type restrictions, only places + that satisfy all of the restrictions are returned. For example, if + we have {included_types = ["restaurant"], excluded_primary_types = + ["restaurant"]}, the returned places provide "restaurant" related + services but do not operate primarily as "restaurants". + items: + type: string + includedTypes: + type: array + items: + type: string + description: >- + Included Place type (eg, "restaurant" or "gas_station") from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If there are any conflicting types, i.e. a type + appears in both included_types and excluded_types, an + INVALID_ARGUMENT error is returned. If a Place type is specified + with multiple type restrictions, only places that satisfy all of the + restrictions are returned. For example, if we have {included_types = + ["restaurant"], excluded_primary_types = ["restaurant"]}, the + returned places provide "restaurant" related services but do not + operate primarily as "restaurants". + excludedTypes: + type: array + items: + type: string + description: >- + Excluded Place type (eg, "restaurant" or "gas_station") from + https://developers.google.com/maps/documentation/places/web-service/place-types. + Up to 50 types from [Table + A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) + may be specified. If the client provides both included_types (e.g. + restaurant) and excluded_types (e.g. cafe), then the response should + include places that are restaurant but not cafe. The response + includes places that match at least one of the included_types and + none of the excluded_types. If there are any conflicting types, i.e. + a type appears in both included_types and excluded_types, an + INVALID_ARGUMENT error is returned. If a Place type is specified + with multiple type restrictions, only places that satisfy all of the + restrictions are returned. For example, if we have {included_types = + ["restaurant"], excluded_primary_types = ["restaurant"]}, the + returned places provide "restaurant" related services but do not + operate primarily as "restaurants". + regionCode: type: string - description: The language used to format this components, in CLDR notation. - shortText: description: >- - An abbreviated textual name for the address component, if available. - For example, an address component for the country of Australia may - have a short_name of "AU". + The Unicode country/region code (CLDR) of the location where the + request is coming from. This parameter is used to display the place + details, like region-specific place name, if available. The + parameter can affect results based on applicable law. For more + information, see + https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. + Note that 3-digit region codes are not currently supported. + languageCode: type: string - longText: description: >- - The full text description or name of the address component. For - example, an address component for the country Australia may have a - long_name of "Australia". + Place details will be displayed with the preferred language if + available. If the language code is unspecified or unrecognized, + place details of any language may be returned, with a preference for + English if such details exist. Current list of supported languages: + https://developers.google.com/maps/faq#languagesupport. + locationRestriction: + description: Required. The region to search. + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + rankPreference: type: string - id: GoogleMapsPlacesV1PlaceAddressComponent + description: How results will be ranked in the response. + enumDescriptions: + - >- + RankPreference value not set. Will use rank by POPULARITY by + default. + - Ranks results by distance. + - Ranks results by popularity. + enum: + - RANK_PREFERENCE_UNSPECIFIED + - DISTANCE + - POPULARITY + id: GoogleMapsPlacesV1SearchNearbyRequest + GoogleMapsPlacesV1FuelOptionsFuelPrice: + properties: + price: + $ref: '#/components/schemas/GoogleTypeMoney' + description: The price of the fuel. + type: + enum: + - FUEL_TYPE_UNSPECIFIED + - DIESEL + - REGULAR_UNLEADED + - MIDGRADE + - PREMIUM + - SP91 + - SP91_E10 + - SP92 + - SP95 + - SP95_E10 + - SP98 + - SP99 + - SP100 + - LPG + - E80 + - E85 + - METHANE + - BIO_DIESEL + - TRUCK_DIESEL + enumDescriptions: + - Unspecified fuel type. + - Diesel fuel. + - Regular unleaded. + - Midgrade. + - Premium. + - SP 91. + - SP 91 E10. + - SP 92. + - SP 95. + - SP95 E10. + - SP 98. + - SP 99. + - SP 100. + - LPG. + - E 80. + - E 85. + - Methane. + - Bio-diesel. + - Truck diesel. + type: string + description: The type of fuel. + updateTime: + format: google-datetime + type: string + description: The time the fuel price was last updated. + id: GoogleMapsPlacesV1FuelOptionsFuelPrice type: object + description: Fuel price information for a given type. + GoogleMapsPlacesV1SearchTextRequestLocationBias: description: >- - The structured components that form the formatted address, if this - information is available. - GoogleMapsPlacesV1SearchTextRequestLocationRestriction: - id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction - description: >- - The region to search. This location serves as a restriction which means - results outside given location will not be returned. - type: object + The region to search. This location serves as a bias which means results + around given location might be returned. + id: GoogleMapsPlacesV1SearchTextRequestLocationBias properties: rectangle: $ref: '#/components/schemas/GoogleGeoTypeViewport' @@ -756,257 +841,230 @@ components: than `rectangle.high().latitude()`. This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees. - GoogleMapsPlacesV1ContentBlock: - id: GoogleMapsPlacesV1ContentBlock - description: A block of content that can be served individually. - properties: - topic: - type: string - description: The topic of the content, for example "overview" or "restaurant". - references: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. References that are related to this block of - content. - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - content: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: Content related to the topic. + circle: + description: A circle defined by center point and radius. + $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' type: object - GoogleMapsPlacesV1ContextualContentJustification: + GoogleMapsPlacesV1PlaceAreaSummary: description: >- Experimental: See https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. Justifications answers - the question of why a place could interest an end user. - id: GoogleMapsPlacesV1ContextualContentJustification - type: object + for more details. AI-generated summary of the area that the place is in. + id: GoogleMapsPlacesV1PlaceAreaSummary properties: - businessAvailabilityAttributesJustification: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification - reviewJustification: + contentBlocks: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContentBlock' description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustification - GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: - id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint - description: Status changing points. + Content blocks that compose the area summary. Each block has a + separate topic about the area. type: object + GoogleMapsPlacesV1AutocompletePlacesResponse: + id: GoogleMapsPlacesV1AutocompletePlacesResponse properties: - day: - description: >- - A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is - Monday, etc. - format: int32 - type: integer - hour: - description: The hour in 2 digits. Ranges from 00 to 23. - type: integer - format: int32 - truncated: - type: boolean + suggestions: description: >- - Whether or not this endpoint was truncated. Truncation occurs when - the real hours are outside the times we are willing to return hours - between, so we truncate the hours back to these boundaries. This - ensures that at most 24 * 7 hours from midnight of the day of the - request are returned. - date: - description: Date in the local timezone for the place. - $ref: '#/components/schemas/GoogleTypeDate' - minute: - format: int32 - type: integer - description: The minute in 2 digits. Ranges from 00 to 59. - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat: + Contains a list of suggestions, ordered in descending order of + relevance. + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + description: Response proto for AutocompletePlaces. + type: object + GoogleMapsPlacesV1PlaceAttribution: + id: GoogleMapsPlacesV1PlaceAttribution + description: Information about data providers of this place. properties: - secondaryText: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: >- - Represents additional disambiguating features (such as a city or - region) to further identify the Place or refine the query. - mainText: - description: Represents the name of the Place or query. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText - description: >- - Contains a breakdown of a Place or query prediction into main text and - secondary text. For Place predictions, the main text contains the - specific name of the Place. For query predictions, the main text - contains the query. The secondary text contains additional - disambiguating features (such as a city or region) to further identify - the Place or refine the query. + provider: + description: Name of the Place's data provider. + type: string + providerUri: + type: string + description: URI to the Place's data provider. type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat + GoogleMapsPlacesV1SearchTextResponse: + type: object + description: 'Response proto for SearchText. ' + properties: + places: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + type: array + description: A list of places that meet the user's text search criteria. + contextualContents: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. A list of contextual contents where each entry + associates to the corresponding place in the same index in the + places field. The contents that are relevant to the `text_query` in + the request are preferred. If the contextual content is not + available for one of the places, it will return non-contextual + content. It will be empty only when the content is unavailable for + this place. This list will have as many entries as the list of + places if requested. + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' + nextPageToken: + description: >- + A token that can be sent as `page_token` to retrieve the next page. + If this field is omitted or empty, there are no subsequent pages. + type: string + id: GoogleMapsPlacesV1SearchTextResponse GoogleMapsPlacesV1PlaceParkingOptions: properties: - freeParkingLot: - type: boolean - description: Place offers free parking lots. - valetParking: + paidStreetParking: + description: Place offers paid street parking. type: boolean - description: Place offers valet parking. - freeStreetParking: + paidParkingLot: type: boolean - description: Place offers free street parking. + description: Place offers paid parking lots. freeGarageParking: - type: boolean description: Place offers free garage parking. + type: boolean paidGarageParking: description: Place offers paid garage parking. type: boolean - paidStreetParking: + freeParkingLot: + description: Place offers free parking lots. type: boolean - description: Place offers paid street parking. - paidParkingLot: - description: Place offers paid parking lots. + freeStreetParking: type: boolean - id: GoogleMapsPlacesV1PlaceParkingOptions - type: object + description: Place offers free street parking. + valetParking: + type: boolean + description: Place offers valet parking. description: >- Information about parking options for the place. A parking lot could support more than one option at the same time. - GoogleMapsPlacesV1Review: - id: GoogleMapsPlacesV1Review - properties: - rating: - format: double - type: number - description: A number between 1.0 and 5.0, also called the number of stars. - authorAttribution: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This review's author. - relativePublishTimeDescription: - type: string - description: >- - A string of formatted recent time, expressing the review time - relative to the current time in a form appropriate for the language - and country. - text: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The localized text of the review. - publishTime: - format: google-datetime - description: Timestamp for the review. - type: string - name: - type: string - description: >- - A reference representing this place review which may be used to look - up this place review again (also called the API "resource" name: - `places/{place_id}/reviews/{review}`). - originalText: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The review text in its original language. - description: Information about a review of a place. type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: + id: GoogleMapsPlacesV1PlaceParkingOptions + GoogleMapsPlacesV1References: + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. Reference that the generative content is related to. + id: GoogleMapsPlacesV1References properties: - matches: - type: array + places: description: >- - A list of string ranges identifying where the input request matched - in `text`. The ranges can be used to format specific parts of - `text`. The substrings may not be exact matches of `input` if the - matching was determined by criteria other than string matching (for - example, spell corrections or transliterations). These values are - Unicode character offsets of `text`. The ranges are guaranteed to be - ordered in increasing offset values. + The list of resource names of the referenced places. This name can + be used in other APIs that accept Place resource names. + type: array items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange - text: - type: string - description: Text that may be used as is or formatted with `matches`. + type: string + reviews: + description: Reviews that serve as references. + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + type: array type: object - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + GoogleMapsPlacesV1PlaceSubDestination: description: >- - Text representing a Place or query prediction. The text may be used as - is or formatted. - GoogleMapsPlacesV1Circle: + Place resource name and id of sub destinations that relate to the place. + For example, different terminals are different destinations of an + airport. properties: - center: - $ref: '#/components/schemas/GoogleTypeLatLng' - description: >- - Required. Center latitude and longitude. The range of latitude must - be within [-90.0, 90.0]. The range of the longitude must be within - [-180.0, 180.0]. - radius: - type: number - format: double - description: >- - Required. Radius measured in meters. The radius must be within [0.0, - 50000.0]. - description: Circle with a LatLng as center and radius. - id: GoogleMapsPlacesV1Circle + name: + type: string + description: The resource name of the sub destination. + id: + type: string + description: The place id of the sub destination. + id: GoogleMapsPlacesV1PlaceSubDestination + type: object + GoogleMapsPlacesV1PlaceOpeningHoursPeriod: + description: A period the place remains in open_now status. + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriod type: object - GoogleGeoTypeViewport: - id: GoogleGeoTypeViewport properties: - high: - description: Required. The high point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' - low: - description: Required. The low point of the viewport. - $ref: '#/components/schemas/GoogleTypeLatLng' + open: + description: The time that the place starts to be open. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + close: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint' + description: The time that the place starts to be closed. + GoogleMapsPlacesV1PlacePaymentOptions: + id: GoogleMapsPlacesV1PlacePaymentOptions + description: Payment options the place accepts. + type: object + properties: + acceptsDebitCards: + type: boolean + description: Place accepts debit cards as payment. + acceptsNfc: + type: boolean + description: Place accepts NFC payments. + acceptsCashOnly: + description: >- + Place accepts cash only as payment. Places with this attribute may + still accept other payment methods. + type: boolean + acceptsCreditCards: + type: boolean + description: Place accepts credit cards as payment. + GoogleTypeLatLng: description: >- - A latitude-longitude viewport, represented as two diagonally opposite - `low` and `high` points. A viewport is considered a closed region, i.e. - it includes its boundary. The latitude bounds must range between -90 to - 90 degrees inclusive, and the longitude bounds must range between -180 - to 180 degrees inclusive. Various cases include: - If `low` = `high`, - the viewport consists of that single point. - If `low.longitude` > - `high.longitude`, the longitude range is inverted (the viewport crosses - the 180 degree longitude line). - If `low.longitude` = -180 degrees and - `high.longitude` = 180 degrees, the viewport includes all longitudes. - - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, - the longitude range is empty. - If `low.latitude` > `high.latitude`, the - latitude range is empty. Both `low` and `high` must be populated, and - the represented box cannot be empty (as specified by the definitions - above). An empty viewport will result in an error. For example, this - viewport fully encloses New York City: { "low": { "latitude": 40.477398, - "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": - -73.70018 } } + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. type: object + id: GoogleTypeLatLng + properties: + longitude: + type: number + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + format: double + latitude: + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + format: double + type: number GoogleMapsPlacesV1Place: - description: All the information representing a Place. - id: GoogleMapsPlacesV1Place - type: object properties: - servesDessert: - description: Place serves dessert. + servesBeer: type: boolean - generativeSummary: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' + description: Specifies if the place serves beer. + goodForChildren: + description: Place is good for children. + type: boolean + utcOffsetMinutes: + format: int32 description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. - adrFormatAddress: - type: string + Number of minutes this place's timezone is currently offset from + UTC. This is expressed in minutes to support timezones that are + offset by fractions of an hour, e.g. X hours and 15 minutes. + type: integer + servesWine: + type: boolean + description: Specifies if the place serves wine. + parkingOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' + description: Options of parking provided by the place. + fuelOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' description: >- - The place's address in adr microformat: - http://microformats.org/wiki/adr. - editorialSummary: - $ref: '#/components/schemas/GoogleTypeLocalizedText' + The most recent information about fuel options in a gas station. + This information is updated regularly. + photos: + type: array + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' description: >- - Contains a summary of the place. A summary is comprised of a textual - overview, and also includes the language code for these if - applicable. Summary text must be presented as-is and can not be - modified or altered. - nationalPhoneNumber: - type: string - description: A human-readable phone number for the place, in national format. + Information (including references) about photos of this place. A + maximum of 10 photos can be returned. + servesCocktails: + type: boolean + description: Place serves cocktails. + servesDessert: + description: Place serves dessert. + type: boolean + servesLunch: + type: boolean + description: Specifies if the place serves lunch. reviews: type: array items: @@ -1014,28 +1072,27 @@ components: description: >- List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned. - userRatingCount: - type: integer - description: The total number of reviews (with or without text) for this place. - format: int32 - utcOffsetMinutes: + iconMaskBaseUri: description: >- - Number of minutes this place's timezone is currently offset from - UTC. This is expressed in minutes to support timezones that are - offset by fractions of an hour, e.g. X hours and 15 minutes. - type: integer - format: int32 + A truncated URL to an icon mask. User can access different icon type + by appending type suffix to the end (eg, ".svg" or ".png"). + type: string location: $ref: '#/components/schemas/GoogleTypeLatLng' description: The position of this place. - servesDinner: + liveMusic: type: boolean - description: Specifies if the place serves dinner. - dineIn: + description: Place provides live music. + menuForChildren: + description: Place has a children's menu. type: boolean - description: >- - Specifies if the business supports indoor or outdoor seating - options. + shortFormattedAddress: + type: string + description: A short, human-readable address for this place. + userRatingCount: + format: int32 + description: The total number of reviews (with or without text) for this place. + type: integer primaryType: type: string description: >- @@ -1044,32 +1101,22 @@ components: "airport", etc. A place can only have a single primary type. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types - rating: - type: number - format: double - description: A rating between 1.0 and 5.0, based on user reviews of this place. businessStatus: - enum: - - BUSINESS_STATUS_UNSPECIFIED - - OPERATIONAL - - CLOSED_TEMPORARILY - - CLOSED_PERMANENTLY description: The business status for the place. - type: string enumDescriptions: - Default value. This value is unused. - The establishment is operational, not necessarily open now. - The establishment is temporarily closed. - The establishment is permanently closed. - servesCoffee: + enum: + - BUSINESS_STATUS_UNSPECIFIED + - OPERATIONAL + - CLOSED_TEMPORARILY + - CLOSED_PERMANENTLY + type: string + takeout: + description: Specifies if the business supports takeout. type: boolean - description: Place serves coffee. - displayName: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: >- - The localized name of the place, suitable as a short human-readable - description. For example, "Google Sydney", "Starbucks", "Pyrmont", - etc. regularSecondaryOpeningHours: description: >- Contains an array of entries for information about regular secondary @@ -1079,68 +1126,41 @@ components: the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. - type: array items: $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - regularOpeningHours: - description: The regular hours of operation. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + type: array + displayName: + description: >- + The localized name of the place, suitable as a short human-readable + description. For example, "Google Sydney", "Starbucks", "Pyrmont", + etc. + $ref: '#/components/schemas/GoogleTypeLocalizedText' reservable: - type: boolean description: Specifies if the place supports reservations. - fuelOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptions' - description: >- - The most recent information about fuel options in a gas station. - This information is updated regularly. - servesCocktails: type: boolean - description: Place serves cocktails. - menuForChildren: - type: boolean - description: Place has a children's menu. - name: - type: string - description: >- - This Place's resource name, in `places/{place_id}` format. Can be - used to look up the Place. - currentSecondaryOpeningHours: + addressComponents: type: array description: >- - Contains an array of entries for the next seven days including - information about secondary hours of a business. Secondary hours are - different from a business's main hours. For example, a restaurant - can specify drive through hours or delivery hours as its secondary - hours. This field populates the type subfield, which draws from a - predefined list of opening hours types (such as DRIVE_THROUGH, - PICKUP, or TAKEOUT) based on the types of the place. This field - includes the special_days subfield of all hours, set for dates that - have exceptional hours. + Repeated components for each locality level. Note the following + facts about the address_components[] array: - The array of address + components may contain more components than the formatted_address. - + The array does not necessarily include all the political entities + that contain an address, apart from those included in the + formatted_address. To retrieve all the political entities that + contain a specific address, you should use reverse geocoding, + passing the latitude/longitude of the address as a parameter to the + request. - The format of the response is not guaranteed to remain + the same between requests. In particular, the number of + address_components varies based on the address requested and can + change over time for the same address. A component can change + position in the array. The type of the component can change. A + particular component may be missing in a later response. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' - allowsDogs: - type: boolean - description: Place allows dogs. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' outdoorSeating: description: Place provides outdoor seating. type: boolean - parkingOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions' - description: Options of parking provided by the place. - servesLunch: - description: Specifies if the place serves lunch. - type: boolean - servesBreakfast: - type: boolean - description: Specifies if the place serves breakfast. - accessibilityOptions: - description: Information about the accessibility options a place offers. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' - goodForWatchingSports: - description: Place is suitable for watching sports. - type: boolean priceLevel: - type: string enumDescriptions: - Place price level is unspecified or unknown. - Place provides free services. @@ -1149,6 +1169,7 @@ components: - Place provides expensive services. - Place provides very expensive services. description: Price level of the place. + type: string enum: - PRICE_LEVEL_UNSPECIFIED - PRICE_LEVEL_FREE @@ -1156,236 +1177,218 @@ components: - PRICE_LEVEL_MODERATE - PRICE_LEVEL_EXPENSIVE - PRICE_LEVEL_VERY_EXPENSIVE - id: - description: The unique identifier of a place. - type: string + rating: + format: double + type: number + description: A rating between 1.0 and 5.0, based on user reviews of this place. + currentOpeningHours: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + description: >- + The hours of operation for the next seven days (including today). + The time period starts at midnight on the date of the request and + ends at 11:59 pm six days later. This field includes the + special_days subfield of all hours, set for dates that have + exceptional hours. + areaSummary: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the area that the place is + in. + primaryTypeDisplayName: + description: >- + The display name of the primary type, localized to the request + language if applicable. For the complete list of possible values, + see Table A and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types + $ref: '#/components/schemas/GoogleTypeLocalizedText' + restroom: + description: Place has restroom. + type: boolean viewport: - $ref: '#/components/schemas/GoogleGeoTypeViewport' description: >- A viewport suitable for displaying the place on an average-sized map. - internationalPhoneNumber: - description: >- - A human-readable phone number for the place, in international - format. - type: string - paymentOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' - description: >- - Payment options the place accepts. If a payment option data is not - available, the payment option field will be unset. - servesVegetarianFood: + $ref: '#/components/schemas/GoogleGeoTypeViewport' + allowsDogs: type: boolean - description: Specifies if the place serves vegetarian food. - liveMusic: + description: Place allows dogs. + evChargeOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' + description: Information of ev charging options. + delivery: type: boolean - description: Place provides live music. - servesBeer: + description: Specifies if the business supports delivery. + servesBrunch: type: boolean - description: Specifies if the place serves beer. - plusCode: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' - description: Plus code of the place location lat/long. - types: - description: >- - A set of type tags for this result. For example, "political" and - "locality". For the complete list of possible values, see Table A - and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types + description: Specifies if the place serves brunch. + attributions: + description: A set of data provider that must be shown with this result. type: array items: - type: string - formattedAddress: - type: string - description: A full, human-readable address for this place. - curbsidePickup: - description: Specifies if the business supports curbside pickup. - type: boolean - areaSummary: - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the area that the place is - in. - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAreaSummary' - googleMapsUri: - type: string - description: A URL providing more information about this place. - goodForChildren: - description: Place is good for children. - type: boolean + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' websiteUri: + type: string description: >- The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain. + iconBackgroundColor: type: string - delivery: - description: Specifies if the business supports delivery. + description: 'Background color for icon_mask in hex format, e.g. #909CE1.' + goodForGroups: + description: Place accommodates groups. + type: boolean + id: + description: The unique identifier of a place. + type: string + plusCode: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePlusCode' + description: Plus code of the place location lat/long. + paymentOptions: + description: >- + Payment options the place accepts. If a payment option data is not + available, the payment option field will be unset. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions' + name: + description: >- + This Place's resource name, in `places/{place_id}` format. Can be + used to look up the Place. + type: string + generativeSummary: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceGenerativeSummary' + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the place. + servesVegetarianFood: + description: Specifies if the place serves vegetarian food. + type: boolean + servesDinner: type: boolean - addressComponents: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent' + description: Specifies if the place serves dinner. + dineIn: description: >- - Repeated components for each locality level. Note the following - facts about the address_components[] array: - The array of address - components may contain more components than the formatted_address. - - The array does not necessarily include all the political entities - that contain an address, apart from those included in the - formatted_address. To retrieve all the political entities that - contain a specific address, you should use reverse geocoding, - passing the latitude/longitude of the address as a parameter to the - request. - The format of the response is not guaranteed to remain - the same between requests. In particular, the number of - address_components varies based on the address requested and can - change over time for the same address. A component can change - position in the array. The type of the component can change. A - particular component may be missing in a later response. - servesBrunch: + Specifies if the business supports indoor or outdoor seating + options. type: boolean - description: Specifies if the place serves brunch. - evChargeOptions: - $ref: '#/components/schemas/GoogleMapsPlacesV1EVChargeOptions' - description: Information of ev charging options. - iconBackgroundColor: - description: 'Background color for icon_mask in hex format, e.g. #909CE1.' + formattedAddress: type: string - restroom: - description: Place has restroom. - type: boolean - takeout: - description: Specifies if the business supports takeout. + description: A full, human-readable address for this place. + goodForWatchingSports: type: boolean - primaryTypeDisplayName: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: >- - The display name of the primary type, localized to the request - language if applicable. For the complete list of possible values, - see Table A and Table B at - https://developers.google.com/maps/documentation/places/web-service/place-types - servesWine: - description: Specifies if the place serves wine. + description: Place is suitable for watching sports. + servesBreakfast: + description: Specifies if the place serves breakfast. type: boolean - attributions: + currentSecondaryOpeningHours: type: array - description: A set of data provider that must be shown with this result. items: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAttribution' - currentOpeningHours: - $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' description: >- - The hours of operation for the next seven days (including today). - The time period starts at midnight on the date of the request and - ends at 11:59 pm six days later. This field includes the - special_days subfield of all hours, set for dates that have - exceptional hours. - goodForGroups: - type: boolean - description: Place accommodates groups. + Contains an array of entries for the next seven days including + information about secondary hours of a business. Secondary hours are + different from a business's main hours. For example, a restaurant + can specify drive through hours or delivery hours as its secondary + hours. This field populates the type subfield, which draws from a + predefined list of opening hours types (such as DRIVE_THROUGH, + PICKUP, or TAKEOUT) based on the types of the place. This field + includes the special_days subfield of all hours, set for dates that + have exceptional hours. subDestinations: type: array - description: A list of sub destinations related to the place. items: $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination' - iconMaskBaseUri: + description: A list of sub destinations related to the place. + internationalPhoneNumber: description: >- - A truncated URL to an icon mask. User can access different icon type - by appending type suffix to the end (eg, ".svg" or ".png"). + A human-readable phone number for the place, in international + format. type: string - shortFormattedAddress: - description: A short, human-readable address for this place. + googleMapsUri: type: string - photos: - type: array + description: A URL providing more information about this place. + regularOpeningHours: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours' + description: The regular hours of operation. + servesCoffee: + type: boolean + description: Place serves coffee. + curbsidePickup: + type: boolean + description: Specifies if the business supports curbside pickup. + editorialSummary: + $ref: '#/components/schemas/GoogleTypeLocalizedText' description: >- - Information (including references) about photos of this place. A - maximum of 10 photos can be returned. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' - GoogleMapsPlacesV1Photo: - properties: - heightPx: - description: The maximum available height, in pixels. - type: integer - format: int32 - authorAttributions: - type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' - description: This photo's authors. - name: + Contains a summary of the place. A summary is comprised of a textual + overview, and also includes the language code for these if + applicable. Summary text must be presented as-is and can not be + modified or altered. + nationalPhoneNumber: + description: A human-readable phone number for the place, in national format. type: string + accessibilityOptions: + description: Information about the accessibility options a place offers. + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions' + adrFormatAddress: description: >- - Identifier. A reference representing this place photo which may be - used to look up this place photo again (also called the API - "resource" name: `places/{place_id}/photos/{photo}`). - widthPx: - format: int32 - description: The maximum available width, in pixels. - type: integer - type: object - id: GoogleMapsPlacesV1Photo - description: Information about a photo of a place. - GoogleMapsPlacesV1ContextualContent: - id: GoogleMapsPlacesV1ContextualContent - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Content that is contextual to the place query. - type: object - properties: - reviews: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: List of reviews about this place, contexual to the place query. - type: array - justifications: + The place's address in adr microformat: + http://microformats.org/wiki/adr. + type: string + types: type: array items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustification - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Justifications for the place. - photos: - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Photo' - type: array + type: string description: >- - Information (including references) about photos of this place, - contexual to the place query. - GoogleTypeLatLng: + A set of type tags for this result. For example, "political" and + "locality". For the complete list of possible values, see Table A + and Table B at + https://developers.google.com/maps/documentation/places/web-service/place-types + id: GoogleMapsPlacesV1Place + type: object + description: All the information representing a Place. + GoogleMapsPlacesV1Review: properties: - longitude: - format: double - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - type: number - latitude: + rating: + description: A number between 1.0 and 5.0, also called the number of stars. format: double type: number - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - id: GoogleTypeLatLng + publishTime: + type: string + description: Timestamp for the review. + format: google-datetime + name: + type: string + description: >- + A reference representing this place review which may be used to look + up this place review again (also called the API "resource" name: + `places/{place_id}/reviews/{review}`). + originalText: + description: The review text in its original language. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + relativePublishTimeDescription: + type: string + description: >- + A string of formatted recent time, expressing the review time + relative to the current time in a form appropriate for the language + and country. + authorAttribution: + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + description: This review's author. + text: + $ref: '#/components/schemas/GoogleTypeLocalizedText' + description: The localized text of the review. + description: Information about a review of a place. type: object - GoogleMapsPlacesV1SearchTextRequestLocationBias: - id: GoogleMapsPlacesV1SearchTextRequestLocationBias + id: GoogleMapsPlacesV1Review + GoogleMapsPlacesV1SearchTextRequestLocationRestriction: description: >- - The region to search. This location serves as a bias which means results - around given location might be returned. - type: object + The region to search. This location serves as a restriction which means + results outside given location will not be returned. properties: - circle: - $ref: '#/components/schemas/GoogleMapsPlacesV1Circle' - description: A circle defined by center point and radius. rectangle: - $ref: '#/components/schemas/GoogleGeoTypeViewport' description: >- A rectangle box defined by northeast and southwest corner. `rectangle.high()` must be the northeast point of the rectangle @@ -1394,75 +1397,120 @@ components: than `rectangle.high().latitude()`. This will result in an empty latitude range. A rectangle viewport cannot be wider than 180 degrees. - GoogleMapsPlacesV1SearchNearbyRequest: - id: GoogleMapsPlacesV1SearchNearbyRequest + $ref: '#/components/schemas/GoogleGeoTypeViewport' + type: object + id: GoogleMapsPlacesV1SearchTextRequestLocationRestriction + GoogleTypeMoney: + description: Represents an amount of money with its currency type. + type: object + properties: + units: + format: int64 + type: string + description: >- + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + nanos: + description: >- + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + currencyCode: + type: string + description: The three-letter currency code defined in ISO 4217. + id: GoogleTypeMoney + GoogleMapsPlacesV1SearchTextRequest: + type: object + description: 'Request proto for SearchText. ' + id: GoogleMapsPlacesV1SearchTextRequest properties: - includedPrimaryTypes: - items: - type: string - type: array + pageToken: description: >- - Included primary Place type (e.g. "restaurant" or "gas_station") - from - https://developers.google.com/maps/documentation/places/web-service/place-types. - A place can only have a single primary type from the supported types - table associated with it. Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting primary types, i.e. a - type appears in both included_primary_types and - excluded_primary_types, an INVALID_ARGUMENT error is returned. If a - Place type is specified with multiple type restrictions, only places - that satisfy all of the restrictions are returned. For example, if - we have {included_types = ["restaurant"], excluded_primary_types = - ["restaurant"]}, the returned places provide "restaurant" related - services but do not operate primarily as "restaurants". + Optional. A page token, received from a previous TextSearch call. + Provide this to retrieve the subsequent page. When paginating, all + parameters other than `page_token`, `page_size`, and + `max_result_count` provided to TextSearch must match the initial + call that provided the page token. Otherwise an INVALID_ARGUMENT + error is returned. + type: string languageCode: + type: string description: >- Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist. Current list of supported languages: https://developers.google.com/maps/faq#languagesupport. - type: string - excludedTypes: + openNow: + description: >- + Used to restrict the search to places that are currently open. The + default is false. + type: boolean + locationRestriction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationRestriction + description: >- + The region to search. This location serves as a restriction which + means results outside given location will not be returned. Cannot be + set along with location_bias. + locationBias: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestLocationBias' + description: >- + The region to search. This location serves as a bias which means + results around given location might be returned. Cannot be set along + with location_restriction. + priceLevels: items: + enum: + - PRICE_LEVEL_UNSPECIFIED + - PRICE_LEVEL_FREE + - PRICE_LEVEL_INEXPENSIVE + - PRICE_LEVEL_MODERATE + - PRICE_LEVEL_EXPENSIVE + - PRICE_LEVEL_VERY_EXPENSIVE + enumDescriptions: + - Place price level is unspecified or unknown. + - Place provides free services. + - Place provides inexpensive services. + - Place provides moderately priced services. + - Place provides expensive services. + - Place provides very expensive services. type: string type: array description: >- - Excluded Place type (eg, "restaurant" or "gas_station") from + Used to restrict the search to places that are marked as certain + price levels. Users can choose any combinations of price levels. + Default to select all price levels. + includedType: + type: string + description: >- + The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If the client provides both included_types (e.g. - restaurant) and excluded_types (e.g. cafe), then the response should - include places that are restaurant but not cafe. The response - includes places that match at least one of the included_types and - none of the excluded_types. If there are any conflicting types, i.e. - a type appears in both included_types and excluded_types, an - INVALID_ARGUMENT error is returned. If a Place type is specified - with multiple type restrictions, only places that satisfy all of the - restrictions are returned. For example, if we have {included_types = - ["restaurant"], excluded_primary_types = ["restaurant"]}, the - returned places provide "restaurant" related services but do not - operate primarily as "restaurants". + Only support one included type. rankPreference: + enumDescriptions: + - >- + For a categorical query such as "Restaurants in New York City", + RELEVANCE is the default. For non-categorical queries such as + "Mountain View, CA" we recommend that you leave rankPreference + unset. + - Ranks results by distance. + - >- + Ranks results by relevance. Sort order determined by normal + ranking stack. enum: - RANK_PREFERENCE_UNSPECIFIED - DISTANCE - - POPULARITY - type: string + - RELEVANCE description: How results will be ranked in the response. - enumDescriptions: - - >- - RankPreference value not set. Will use rank by POPULARITY by - default. - - Ranks results by distance. - - Ranks results by popularity. - locationRestriction: - description: Required. The region to search. - $ref: >- - #/components/schemas/GoogleMapsPlacesV1SearchNearbyRequestLocationRestriction + type: string regionCode: + type: string description: >- The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place @@ -1471,484 +1519,429 @@ components: information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. - type: string - includedTypes: - description: >- - Included Place type (eg, "restaurant" or "gas_station") from - https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting types, i.e. a type - appears in both included_types and excluded_types, an - INVALID_ARGUMENT error is returned. If a Place type is specified - with multiple type restrictions, only places that satisfy all of the - restrictions are returned. For example, if we have {included_types = - ["restaurant"], excluded_primary_types = ["restaurant"]}, the - returned places provide "restaurant" related services but do not - operate primarily as "restaurants". - type: array - items: - type: string - excludedPrimaryTypes: - type: array - items: - type: string - description: >- - Excluded primary Place type (e.g. "restaurant" or "gas_station") - from - https://developers.google.com/maps/documentation/places/web-service/place-types. - Up to 50 types from [Table - A](https://developers.google.com/maps/documentation/places/web-service/place-types#table-a) - may be specified. If there are any conflicting primary types, i.e. a - type appears in both included_primary_types and - excluded_primary_types, an INVALID_ARGUMENT error is returned. If a - Place type is specified with multiple type restrictions, only places - that satisfy all of the restrictions are returned. For example, if - we have {included_types = ["restaurant"], excluded_primary_types = - ["restaurant"]}, the returned places provide "restaurant" related - services but do not operate primarily as "restaurants". maxResultCount: - type: integer + deprecated: true description: >- - Maximum number of results to return. It must be between 1 and 20 - (default), inclusively. If the number is unset, it falls back to the - upper limit. If the number is set to negative or exceeds the upper - limit, an INVALID_ARGUMENT error is returned. + Deprecated: Use `page_size` instead. The maximum number of results + per page that can be returned. If the number of available results is + larger than `max_result_count`, a `next_page_token` is returned + which can be passed to `page_token` to get the next page of results + in subsequent requests. If 0 or no value is provided, a default of + 20 is used. The maximum value is 20; values above 20 will be coerced + to 20. Negative values will return an INVALID_ARGUMENT error. If + both `max_result_count` and `page_size` are specified, + `max_result_count` will be ignored. + type: integer format: int32 - type: object - description: 'Request proto for Search Nearby. ' - GoogleMapsPlacesV1PhotoMedia: - description: A photo media from Places API. - id: GoogleMapsPlacesV1PhotoMedia - type: object - properties: - photoUri: - type: string - description: A short-lived uri that can be used to render the photo. - name: - type: string - description: >- - The resource name of a photo media in the format: - `places/{place_id}/photos/{photo_reference}/media`. - GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation: - properties: - type: - description: The connector type of this aggregation. - enumDescriptions: - - Unspecified connector. - - Other connector types. - - J1772 type 1 connector. - - IEC 62196 type 2 connector. Often referred to as MENNEKES. - - CHAdeMO type connector. - - >- - Combined Charging System (AC and DC). Based on SAE. Type-1 J-1772 - connector - - >- - Combined Charging System (AC and DC). Based on Type-2 Mennekes - connector - - >- - The generic TESLA connector. This is NACS in the North America but - can be non-NACS in other parts of the world (e.g. CCS Combo 2 - (CCS2) or GB/T). This value is less representative of an actual - connector type, and more represents the ability to charge a Tesla - brand vehicle at a Tesla owned charging station. - - >- - GB/T type corresponds to the GB/T standard in China. This type - covers all GB_T types. - - Unspecified wall outlet. + evOptions: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextRequestEVOptions' + description: Optional. Set the searchable EV options of a place search request. + textQuery: type: string - enum: - - EV_CONNECTOR_TYPE_UNSPECIFIED - - EV_CONNECTOR_TYPE_OTHER - - EV_CONNECTOR_TYPE_J1772 - - EV_CONNECTOR_TYPE_TYPE_2 - - EV_CONNECTOR_TYPE_CHADEMO - - EV_CONNECTOR_TYPE_CCS_COMBO_1 - - EV_CONNECTOR_TYPE_CCS_COMBO_2 - - EV_CONNECTOR_TYPE_TESLA - - EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T - - EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET - availableCount: + description: Required. The text query for textual search. + pageSize: format: int32 description: >- - Number of connectors in this aggregation that are currently - available. + Optional. The maximum number of results per page that can be + returned. If the number of available results is larger than + `page_size`, a `next_page_token` is returned which can be passed to + `page_token` to get the next page of results in subsequent requests. + If 0 or no value is provided, a default of 20 is used. The maximum + value is 20; values above 20 will be set to 20. Negative values will + return an INVALID_ARGUMENT error. If both `max_result_count` and + `page_size` are specified, `max_result_count` will be ignored. + type: integer + strictTypeFiltering: + type: boolean + description: >- + Used to set strict type filtering for included_type. If set to true, + only results of the same type will be returned. Default to false. + minRating: + format: double + type: number + description: >- + Filter out results whose average user rating is strictly less than + this limit. A valid value must be a float between 0 and 5 + (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, ... , 5.0] + inclusively. The input rating will round up to the nearest + 0.5(ceiling). For instance, a rating of 0.6 will eliminate all + results with a less than 1.0 rating. + GoogleMapsPlacesV1Photo: + id: GoogleMapsPlacesV1Photo + description: Information about a photo of a place. + properties: + widthPx: type: integer - maxChargeRateKw: - format: double + description: The maximum available width, in pixels. + format: int32 + name: + type: string description: >- - The static max charging rate in kw of each connector in the - aggregation. - type: number - count: + Identifier. A reference representing this place photo which may be + used to look up this place photo again (also called the API + "resource" name: `places/{place_id}/photos/{photo}`). + heightPx: type: integer - description: Number of connectors in this aggregation. + description: The maximum available height, in pixels. format: int32 - availabilityLastUpdateTime: - type: string - format: google-datetime + authorAttributions: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1AuthorAttribution' + description: This photo's authors. + type: array + type: object + GoogleMapsPlacesV1EVChargeOptions: + id: GoogleMapsPlacesV1EVChargeOptions + type: object + properties: + connectorAggregation: description: >- - The timestamp when the connector availability information in this - aggregation was last updated. - outOfServiceCount: + A list of EV charging connector aggregations that contain connectors + of the same type and same charge rate. + type: array + items: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + connectorCount: description: >- - Number of connectors in this aggregation that are currently out of - service. - format: int32 + Number of connectors at this station. However, because some ports + can have multiple connectors but only be able to charge one car at a + time (e.g.) the number of connectors may be greater than the total + number of cars which can charge simultaneously. type: integer - id: GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation + format: int32 description: >- - EV charging information grouped by [type, max_charge_rate_kw]. Shows EV - charge aggregation of connectors that have the same type and max charge - rate in kw. - type: object - GoogleMapsPlacesV1PlaceGenerativeSummary: + Information about the EV Charge Station hosted in Place. Terminology + follows https://afdc.energy.gov/fuels/electricity_infrastructure.html + One port could charge one car at a time. One port has one or more + connectors. One station has one or more ports. + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion: + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion + properties: + queryPrediction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + description: A prediction for a query. + placePrediction: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction + description: A prediction for a Place. + description: An Autocomplete suggestion result. type: object - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. AI-generated summary of the place. + GoogleMapsPlacesV1PlacePlusCode: properties: - references: - $ref: '#/components/schemas/GoogleMapsPlacesV1References' - description: References that are used to generate the summary description. - overview: - description: The overview of the place. - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: - $ref: '#/components/schemas/GoogleTypeLocalizedText' - description: The detailed description of the place. - id: GoogleMapsPlacesV1PlaceGenerativeSummary - GoogleMapsPlacesV1References: - id: GoogleMapsPlacesV1References + globalCode: + type: string + description: >- + Place's global (full) code, such as "9FWM33GV+HQ", representing an + 1/8000 by 1/8000 degree area (~14 by 14 meters). + compoundCode: + description: >- + Place's compound code, such as "33GV+HQ, Ramberg, Norway", + containing the suffix of the global code and replacing the prefix + with a formatted name of a reference entity. + type: string + id: GoogleMapsPlacesV1PlacePlusCode type: object + description: >- + Plus code (http://plus.codes) is a location reference with two formats: + global code defining a 14mx14m (1/8000th of a degree) or smaller + rectangle, and compound code, replacing the prefix with a reference + location. + GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText: properties: - reviews: + text: + type: string + description: Text that may be used as is or formatted with `matches`. + matches: type: array - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Review' - description: Reviews that serve as references. - places: description: >- - The list of resource names of the referenced places. This name can - be used in other APIs that accept Place resource names. + A list of string ranges identifying where the input request matched + in `text`. The ranges can be used to format specific parts of + `text`. The substrings may not be exact matches of `input` if the + matching was determined by criteria other than string matching (for + example, spell corrections or transliterations). These values are + Unicode character offsets of `text`. The ranges are guaranteed to be + ordered in increasing offset values. items: - type: string - type: array - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. Reference that the generative content is related to. - GoogleTypeDate: - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange type: object + id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + description: >- + Text representing a Place or query prediction. The text may be used as + is or formatted. + GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint: properties: - month: - type: integer - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 - year: + date: + $ref: '#/components/schemas/GoogleTypeDate' + description: Date in the local timezone for the place. + hour: + description: The hour in 2 digits. Ranges from 00 to 23. format: int32 type: integer + minute: + description: The minute in 2 digits. Ranges from 00 to 59. + type: integer + format: int32 + truncated: + type: boolean description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. + Whether or not this endpoint was truncated. Truncation occurs when + the real hours are outside the times we are willing to return hours + between, so we truncate the hours back to these boundaries. This + ensures that at most 24 * 7 hours from midnight of the day of the + request are returned. day: - format: int32 - type: integer description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. - id: GoogleTypeDate - GoogleMapsPlacesV1PlacePaymentOptions: + A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is + Monday, etc. + type: integer + format: int32 + id: GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint + type: object + description: Status changing points. + GoogleGeoTypeViewport: + type: object properties: - acceptsDebitCards: - description: Place accepts debit cards as payment. - type: boolean - acceptsCreditCards: - type: boolean - description: Place accepts credit cards as payment. - acceptsCashOnly: - type: boolean - description: >- - Place accepts cash only as payment. Places with this attribute may - still accept other payment methods. - acceptsNfc: - type: boolean - description: Place accepts NFC payments. - id: GoogleMapsPlacesV1PlacePaymentOptions - description: Payment options the place accepts. + low: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: Required. The low point of the viewport. + high: + $ref: '#/components/schemas/GoogleTypeLatLng' + description: Required. The high point of the viewport. + id: GoogleGeoTypeViewport + description: >- + A latitude-longitude viewport, represented as two diagonally opposite + `low` and `high` points. A viewport is considered a closed region, i.e. + it includes its boundary. The latitude bounds must range between -90 to + 90 degrees inclusive, and the longitude bounds must range between -180 + to 180 degrees inclusive. Various cases include: - If `low` = `high`, + the viewport consists of that single point. - If `low.longitude` > + `high.longitude`, the longitude range is inverted (the viewport crosses + the 180 degree longitude line). - If `low.longitude` = -180 degrees and + `high.longitude` = 180 degrees, the viewport includes all longitudes. - + If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, + the longitude range is empty. - If `low.latitude` > `high.latitude`, the + latitude range is empty. Both `low` and `high` must be populated, and + the represented box cannot be empty (as specified by the definitions + above). An empty viewport will result in an error. For example, this + viewport fully encloses New York City: { "low": { "latitude": 40.477398, + "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": + -73.70018 } } + GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay: + description: >- + Structured information for special days that fall within the period that + the returned opening hours cover. Special days are days that could + impact the business hours of a place, e.g. Christmas day. type: object - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction + id: GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay properties: - structuredFormat: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat - description: >- - A breakdown of the query prediction into main text containing the - query and secondary text containing additional disambiguating - features (such as a city or region). `structured_format` is - recommended for developers who wish to show two separate, but - related, UI elements. Developers who wish to show a single UI - element may want to use `text` instead. They are two different ways - to represent a query prediction. Users should not try to parse - `structured_format` into `text` or vice versa. - text: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText + date: + $ref: '#/components/schemas/GoogleTypeDate' + description: The date of this special day. + GoogleMapsPlacesV1FuelOptions: + id: GoogleMapsPlacesV1FuelOptions + properties: + fuelPrices: + items: + $ref: '#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice' + type: array description: >- - The predicted text. This text does not represent a Place, but rather - a text query that could be used in a search endpoint (for example, - Text Search). `text` is recommended for developers who wish to show - a single UI element. Developers who wish to show two separate, but - related, UI elements may want to use `structured_format` instead. - They are two different ways to represent a query prediction. Users - should not try to parse `structured_format` into `text` or vice - versa. May be in mixed languages if the request `input` and - `language_code` are in different languages or if part of the query - does not have a translation from the local language to - `language_code`. + The last known fuel price for each type of fuel this station has. + There is one entry per fuel type this station has. Order is not + important. type: object - description: Prediction results for a Query Autocomplete prediction. - GoogleMapsPlacesV1PlacePlusCode: description: >- - Plus code (http://plus.codes) is a location reference with two formats: - global code defining a 14mx14m (1/8000th of a degree) or smaller - rectangle, and compound code, replacing the prefix with a reference - location. + The most recent information about fuel options in a gas station. This + information is updated regularly. + GoogleMapsPlacesV1PhotoMedia: properties: - compoundCode: + name: type: string description: >- - Place's compound code, such as "33GV+HQ, Ramberg, Norway", - containing the suffix of the global code and replacing the prefix - with a formatted name of a reference entity. - globalCode: + The resource name of a photo media in the format: + `places/{place_id}/photos/{photo_reference}/media`. + photoUri: + description: A short-lived uri that can be used to render the photo. type: string - description: >- - Place's global (full) code, such as "9FWM33GV+HQ", representing an - 1/8000 by 1/8000 degree area (~14 by 14 meters). - id: GoogleMapsPlacesV1PlacePlusCode + id: GoogleMapsPlacesV1PhotoMedia type: object - GoogleMapsPlacesV1FuelOptionsFuelPrice: + description: A photo media from Places API. + GoogleMapsPlacesV1PlaceGenerativeSummary: properties: - updateTime: - description: The time the fuel price was last updated. + overview: + description: The overview of the place. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + references: + description: References that are used to generate the summary description. + $ref: '#/components/schemas/GoogleMapsPlacesV1References' + description: + description: The detailed description of the place. + $ref: '#/components/schemas/GoogleTypeLocalizedText' + type: object + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. AI-generated summary of the place. + id: GoogleMapsPlacesV1PlaceGenerativeSummary + GoogleMapsPlacesV1AuthorAttribution: + description: Information about the author of the UGC data. Used in Photo, and Review. + properties: + uri: + description: URI of the author of the Photo or Review. type: string - format: google-datetime - type: - enumDescriptions: - - Unspecified fuel type. - - Diesel fuel. - - Regular unleaded. - - Midgrade. - - Premium. - - SP 91. - - SP 91 E10. - - SP 92. - - SP 95. - - SP95 E10. - - SP 98. - - SP 99. - - SP 100. - - LPG. - - E 80. - - E 85. - - Methane. - - Bio-diesel. - - Truck diesel. - enum: - - FUEL_TYPE_UNSPECIFIED - - DIESEL - - REGULAR_UNLEADED - - MIDGRADE - - PREMIUM - - SP91 - - SP91_E10 - - SP92 - - SP95 - - SP95_E10 - - SP98 - - SP99 - - SP100 - - LPG - - E80 - - E85 - - METHANE - - BIO_DIESEL - - TRUCK_DIESEL - description: The type of fuel. + displayName: + description: Name of the author of the Photo or Review. type: string - price: - $ref: '#/components/schemas/GoogleTypeMoney' - description: The price of the fuel. - id: GoogleMapsPlacesV1FuelOptionsFuelPrice + photoUri: + type: string + description: Profile photo URI of the author of the Photo or Review. + id: GoogleMapsPlacesV1AuthorAttribution type: object - description: Fuel price information for a given type. - GoogleMapsPlacesV1SearchTextResponse: + GoogleMapsPlacesV1PlaceOpeningHours: + description: Information about business hour of the place. + id: GoogleMapsPlacesV1PlaceOpeningHours type: object - id: GoogleMapsPlacesV1SearchTextResponse properties: - places: - type: array - description: A list of places that meet the user's text search criteria. + periods: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - nextPageToken: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod' description: >- - A token that can be sent as `page_token` to retrieve the next page. - If this field is omitted or empty, there are no subsequent pages. - type: string - contextualContents: + The periods that this place is open during the week. The periods are + in chronological order, starting with Sunday in the place-local + timezone. An empty (but not absent) value indicates a place that is + never open, e.g. because it is closed temporarily for renovations. + type: array + weekdayDescriptions: items: - $ref: '#/components/schemas/GoogleMapsPlacesV1ContextualContent' + type: string type: array description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. A list of contextual contents where each entry - associates to the corresponding place in the same index in the - places field. The contents that are relevant to the `text_query` in - the request are preferred. If the contextual content is not - available for one of the places, it will return non-contextual - content. It will be empty only when the content is unavailable for - this place. This list should have as many entries as the list of - places if requested. - description: 'Response proto for SearchText. ' - GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange: - id: GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange - properties: - endOffset: - type: integer - format: int32 - description: Zero-based offset of the last Unicode character (exclusive). - startOffset: - description: >- - Zero-based offset of the first Unicode character of the string - (inclusive). - type: integer - format: int32 - type: object - description: Identifies a substring within a given text. - GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification: - properties: - delivery: - description: If a place provides delivery. - type: boolean - dineIn: - type: boolean - description: If a place provides dine-in. - takeout: - description: If a place provides takeout. + Localized strings describing the opening hours of this place, one + string for each day of the week. Will be empty if the hours are + unknown or could not be converted to localized text. Example: "Sun: + 18:00–06:00" + openNow: type: boolean - id: >- - GoogleMapsPlacesV1ContextualContentJustificationBusinessAvailabilityAttributesJustification - description: >- - Experimental: See - https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative - for more details. BusinessAvailabilityAttributes justifications. This - shows some attributes a business has that could interest an end user. - type: object - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText: - type: object - description: >- - The text highlighted by the justification. This is a subset of the - review itself. The exact word to highlight is marked by the - HighlightedTextRange. There could be several words in the text being - highlighted. - id: >- - GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText - properties: - highlightedTextRanges: + description: >- + Whether the opening hours period is currently active. For regular + opening hours and current opening hours, this field means whether + the place is open. For secondary opening hours and current secondary + opening hours, this field means whether the secondary hours of this + place is active. + secondaryHoursType: + enumDescriptions: + - Default value when secondary hour type is not specified. + - The drive-through hour for banks, restaurants, or pharmacies. + - The happy hour. + - The delivery hour. + - The takeout hour. + - The kitchen hour. + - The breakfast hour. + - The lunch hour. + - The dinner hour. + - The brunch hour. + - The pickup hour. + - The access hours for storage places. + - The special hours for seniors. + - The online service hours. + enum: + - SECONDARY_HOURS_TYPE_UNSPECIFIED + - DRIVE_THROUGH + - HAPPY_HOUR + - DELIVERY + - TAKEOUT + - KITCHEN + - BREAKFAST + - LUNCH + - DINNER + - BRUNCH + - PICKUP + - ACCESS + - SENIOR_HOURS + - ONLINE_SERVICE_HOURS + type: string + description: A type string used to identify the type of secondary hours. + specialDays: type: array - description: The list of the ranges of the highlighted text. + description: >- + Structured information for special days that fall within the period + that the returned opening hours cover. Special days are days that + could impact the business hours of a place, e.g. Christmas day. Set + for current_opening_hours and current_secondary_opening_hours if + there are exceptional hours. items: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedTextHighlightedTextRange - text: - type: string - GoogleMapsPlacesV1PlaceAttribution: + $ref: '#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay' + GoogleTypeLocalizedText: + id: GoogleTypeLocalizedText + description: Localized variant of a text in a particular language. type: object - description: Information about data providers of this place. - id: GoogleMapsPlacesV1PlaceAttribution properties: - provider: - description: Name of the Place's data provider. + languageCode: type: string - providerUri: + description: >- + The text's BCP-47 language code, such as "en-US" or "sr-Latn". For + more information, see + http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + text: type: string - description: URI to the Place's data provider. - GoogleMapsPlacesV1PlaceAccessibilityOptions: - id: GoogleMapsPlacesV1PlaceAccessibilityOptions + description: >- + Localized string in the language corresponding to language_code + below. + GoogleMapsPlacesV1ContextualContentJustificationReviewJustification: + properties: + highlightedText: + $ref: >- + #/components/schemas/GoogleMapsPlacesV1ContextualContentJustificationReviewJustificationHighlightedText + review: + $ref: '#/components/schemas/GoogleMapsPlacesV1Review' + description: The review that the highlighted text is generated from. type: object + description: >- + Experimental: See + https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative + for more details. User review justifications. This highlights a section + of the user review that would interest an end user. For instance, if the + search query is "firewood pizza", the review justification highlights + the text relevant to the search query. + id: GoogleMapsPlacesV1ContextualContentJustificationReviewJustification + GoogleMapsPlacesV1PlaceAccessibilityOptions: description: Information about the accessibility options a place offers. properties: - wheelchairAccessibleSeating: - description: Place has wheelchair accessible seating. - type: boolean - wheelchairAccessibleRestroom: - description: Place has wheelchair accessible restroom. - type: boolean wheelchairAccessibleEntrance: description: Places has wheelchair accessible entrance. type: boolean + wheelchairAccessibleSeating: + description: Place has wheelchair accessible seating. + type: boolean wheelchairAccessibleParking: type: boolean description: Place offers wheelchair accessible parking. - GoogleMapsPlacesV1SearchNearbyResponse: - id: GoogleMapsPlacesV1SearchNearbyResponse - description: 'Response proto for Search Nearby. ' + wheelchairAccessibleRestroom: + type: boolean + description: Place has wheelchair accessible restroom. type: object - properties: - places: - description: >- - A list of places that meets user's requirements like places types, - number of places and specific location restriction. - items: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - type: array + id: GoogleMapsPlacesV1PlaceAccessibilityOptions parameters: - alt: - description: Data format for response. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: alt + name: oauth_token schema: type: string - enum: - - json - - media - - proto - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean + type: string fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -1958,39 +1951,49 @@ components: name: key schema: type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + alt: + description: Data format for response. in: query - name: uploadType + name: alt schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + enum: + - json + - media + - proto + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - _.xgafv: - description: V1 error format. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: $.xgafv + name: uploadType schema: type: string - enum: - - '1' - - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -2017,15 +2020,16 @@ components: - $ref: '#/components/x-stackQL-resources/photos_media/methods/get_media' insert: [] update: [] + replace: [] delete: [] places: id: google.places.places name: places title: Places methods: - autocomplete: + get: operation: - $ref: '#/paths/~1v1~1places:autocomplete/post' + $ref: '#/paths/~1v1~1places~1{placesId}/get' response: mediaType: application/json openAPIDocKey: '200' @@ -2035,15 +2039,15 @@ components: response: mediaType: application/json openAPIDocKey: '200' - get: + search_nearby: operation: - $ref: '#/paths/~1v1~1places~1{placesId}/get' + $ref: '#/paths/~1v1~1places:searchNearby/post' response: mediaType: application/json openAPIDocKey: '200' - search_nearby: + autocomplete: operation: - $ref: '#/paths/~1v1~1places:searchNearby/post' + $ref: '#/paths/~1v1~1places:autocomplete/post' response: mediaType: application/json openAPIDocKey: '200' @@ -2052,20 +2056,21 @@ components: - $ref: '#/components/x-stackQL-resources/places/methods/get' insert: [] update: [] + replace: [] delete: [] paths: /v1/places/{placesId}/photos/{photosId}/media: parameters: &ref_1 - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/quotaUser' get: description: Get a photo media with a photo reference string. @@ -2098,29 +2103,26 @@ paths: schema: type: string - in: query - name: skipHttpRedirect + name: maxWidthPx schema: - type: boolean + type: integer + format: int32 - in: query name: maxHeightPx schema: type: integer format: int32 - in: query - name: maxWidthPx + name: skipHttpRedirect schema: - type: integer - format: int32 - /v1/places:autocomplete: + type: boolean + /v1/places/{placesId}: parameters: *ref_1 - post: - description: Returns predictions for the given input. - operationId: places.places.autocomplete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequest' + get: + description: >- + Get the details of a place based on its resource name, which is a string + in the `places/{place_id}` format. + operationId: places.places.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2131,18 +2133,34 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.autocomplete + - https://www.googleapis.com/auth/maps-platform.places.details Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.autocomplete + - https://www.googleapis.com/auth/maps-platform.places.details responses: '200': description: Successful response content: application/json: schema: - $ref: >- - #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse - parameters: [] + $ref: '#/components/schemas/GoogleMapsPlacesV1Place' + parameters: + - in: path + name: placesId + required: true + schema: + type: string + - in: query + name: sessionToken + schema: + type: string + - in: query + name: regionCode + schema: + type: string + - in: query + name: languageCode + schema: + type: string /v1/places:searchText: parameters: *ref_1 post: @@ -2174,13 +2192,16 @@ paths: schema: $ref: '#/components/schemas/GoogleMapsPlacesV1SearchTextResponse' parameters: [] - /v1/places/{placesId}: + /v1/places:searchNearby: parameters: *ref_1 - get: - description: >- - Get the details of a place based on its resource name, which is a string - in the `places/{place_id}` format. - operationId: places.places.get + post: + description: Search for places near locations. + operationId: places.places.searchNearby + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2191,44 +2212,27 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.details + - https://www.googleapis.com/auth/maps-platform.places.nearbysearch Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.details + - https://www.googleapis.com/auth/maps-platform.places.nearbysearch responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1Place' - parameters: - - in: path - name: placesId - required: true - schema: - type: string - - in: query - name: sessionToken - schema: - type: string - - in: query - name: languageCode - schema: - type: string - - in: query - name: regionCode - schema: - type: string - /v1/places:searchNearby: + $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' + parameters: [] + /v1/places:autocomplete: parameters: *ref_1 post: - description: Search for places near locations. - operationId: places.places.searchNearby + description: Returns predictions for the given input. + operationId: places.places.autocomplete requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest' + $ref: '#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2239,14 +2243,15 @@ paths: Oauth2c: - https://www.googleapis.com/auth/maps-platform.places - Oauth2: - - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + - https://www.googleapis.com/auth/maps-platform.places.autocomplete Oauth2c: - - https://www.googleapis.com/auth/maps-platform.places.nearbysearch + - https://www.googleapis.com/auth/maps-platform.places.autocomplete responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse' + $ref: >- + #/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml index 50affe36..f93f2248 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policyanalyzer.yaml @@ -7,8 +7,8 @@ info: title: Policy Analyzer API description: '' version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://www.google.com servers: @@ -34,67 +34,77 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicyanalyzerV1Activity: + GoogleCloudPolicyanalyzerV1ObservationPeriod: type: object properties: - fullResourceName: + endTime: type: string description: >- - The full resource name that identifies the resource. For examples of - full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + The observation end time. The time in this timestamp is always + `07:00:00Z`. + format: google-datetime + startTime: + description: >- + The observation start time. The time in this timestamp is always + `07:00:00Z`. + format: google-datetime + type: string + description: Represents data observation period. + id: GoogleCloudPolicyanalyzerV1ObservationPeriod + GoogleCloudPolicyanalyzerV1Activity: + description: Represents Activity on a GCP resource over specific observation period. + properties: + observationPeriod: + description: The data observation period to build the activity. + $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' activity: additionalProperties: - description: Properties of the object. type: any - type: object + description: Properties of the object. description: A struct of custom fields to explain the activity. - activityType: + type: object + fullResourceName: type: string + description: >- + The full resource name that identifies the resource. For examples of + full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + activityType: description: The type of the activity. - observationPeriod: - description: The data observation period to build the activity. - $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1ObservationPeriod' + type: string id: GoogleCloudPolicyanalyzerV1Activity + type: object GoogleCloudPolicyanalyzerV1QueryActivityResponse: + id: GoogleCloudPolicyanalyzerV1QueryActivityResponse + description: Response to the `QueryActivity` method. properties: activities: - description: The set of activities that match the filter included in the request. type: array items: $ref: '#/components/schemas/GoogleCloudPolicyanalyzerV1Activity' + description: The set of activities that match the filter included in the request. nextPageToken: - type: string description: >- If there might be more results than those appearing in this response, then `nextPageToken` is included. To get the next set of results, call this method again using the value of `nextPageToken` as `pageToken`. - description: Response to the `QueryActivity` method. - id: GoogleCloudPolicyanalyzerV1QueryActivityResponse - type: object - GoogleCloudPolicyanalyzerV1ObservationPeriod: - type: object - description: Represents data observation period. - properties: - startTime: - description: >- - The observation start time. The time in this timestamp is always - `07:00:00Z`. - format: google-datetime - type: string - endTime: - description: >- - The observation end time. The time in this timestamp is always - `07:00:00Z`. type: string - format: google-datetime - id: GoogleCloudPolicyanalyzerV1ObservationPeriod + type: object parameters: - fields: - description: Selector specifying which fields to include in a partial response. + callback: + description: JSONP in: query - name: fields + name: callback + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser schema: type: string upload_protocol: @@ -103,22 +113,25 @@ components: name: upload_protocol schema: type: string - _.xgafv: - description: V1 error format. + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. in: query - name: $.xgafv + name: key schema: type: string - enum: - - '1' - - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: quotaUser + name: uploadType + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string access_token: @@ -137,37 +150,25 @@ components: - json - media - proto - oauth_token: - description: OAuth 2.0 token for the current user. + _.xgafv: + description: V1 error format. in: query - name: oauth_token + name: $.xgafv schema: type: string + enum: + - '1' + - '2' prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - callback: - description: JSONP - in: query - name: callback - schema: - type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: uploadType + name: oauth_token schema: type: string x-stackQL-resources: @@ -184,27 +185,29 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/activities/methods/query' insert: [] update: [] + replace: [] delete: [] paths: - /v1/projects/{projectsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: - parameters: - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/_.xgafv' + /v1/folders/{foldersId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + parameters: &ref_1 + - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/oauth_token' get: description: Queries policy activities on Google Cloud resources. - operationId: policyanalyzer.projects.locations.activityTypes.activities.query + operationId: policyanalyzer.folders.locations.activityTypes.activities.query security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -220,7 +223,7 @@ paths: #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -238,12 +241,106 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 + /v1/organizations/{organizationsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + parameters: *ref_1 + get: + description: Queries policy activities on Google Cloud resources. + operationId: policyanalyzer.organizations.locations.activityTypes.activities.query + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: activityTypesId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/activityTypes/{activityTypesId}/activities:query: + parameters: *ref_1 + get: + description: Queries policy activities on Google Cloud resources. + operationId: policyanalyzer.projects.locations.activityTypes.activities.query + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudPolicyanalyzerV1QueryActivityResponse + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: activityTypesId + required: true + schema: + type: string - in: query name: filter schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml index 6fddcdb6..d28a1cef 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policysimulator.yaml @@ -7,8 +7,8 @@ info: title: Policy Simulator API description: ' Policy Simulator is a collection of endpoints for creating, running, and viewing a Replay. A `Replay` is a type of simulation that lets you see how your members'' access to resources might change if you changed your IAM policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members'' access might change under the proposed policy.' version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/iam/docs/simulating-access servers: @@ -34,137 +34,37 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicysimulatorV1BindingExplanation: - description: >- - Details about how a binding in a policy affects a principal's ability to - use a permission. - properties: - access: - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. - type: string - description: >- - Required. Indicates whether _this binding_ provides the specified - permission to the specified principal for the specified resource. - This field does _not_ indicate whether the principal actually has - the permission for the resource. There might be another binding that - overrides this binding. To determine whether the principal actually - has the permission, use the `access` field in the - TroubleshootIamPolicyResponse. - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - rolePermission: - type: string - enumDescriptions: - - Default value. This value is unused. - - The permission is included in the role. - - The permission is not included in the role. - - >- - The user who created the Replay is not allowed to access the - binding. - enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED - description: >- - Indicates whether the role granted by this binding contains the - specified permission. - rolePermissionRelevance: - type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. - relevance: - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of this binding to the overall determination for the - entire policy. - type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - role: - type: string - description: >- - The role that this binding grants. For example, - `roles/compute.serviceAgent`. For a complete list of predefined IAM - roles, as well as the permissions in each role, see - https://cloud.google.com/iam/help/roles/reference. - memberships: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - type: object - description: >- - Indicates whether each principal in the binding includes the - principal specified in the request, either directly or indirectly. - Each key identifies a principal in the binding, and each value - indicates whether the principal in the binding includes the - principal in the request. For example, suppose that a binding - includes the following principals: * `user:alice@example.com` * - `group:product-eng@example.com` The principal in the replayed access - tuple is `user:bob@example.com`. This user is a principal of the - group `group:product-eng@example.com`. For the first principal in - the binding, the key is `user:alice@example.com`, and the - `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. - For the second principal in the binding, the key is - `group:product-eng@example.com`, and the `membership` field in the - value is set to `MEMBERSHIP_INCLUDED`. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/docs/conditions-overview. - type: object - id: GoogleCloudPolicysimulatorV1BindingExplanation GoogleCloudOrgpolicyV2CustomConstraint: - description: >- - A custom constraint defined by customers which can *only* be applied to - the given resource types and organization. By creating a custom - constraint, customers can apply policies of this custom constraint. - *Creating a custom constraint itself does NOT apply any policy - enforcement*. properties: - displayName: - type: string + methodTypes: + description: All the operations being applied for this constraint. + type: array + items: + enumDescriptions: + - Unspecified. Results in an error. + - Constraint applied when creating the resource. + - Constraint applied when updating the resource. + - >- + Constraint applied when deleting the resource. Not supported + yet. + - Constraint applied when removing an IAM grant. + - Constraint applied when enforcing forced tagging. + type: string + enum: + - METHOD_TYPE_UNSPECIFIED + - CREATE + - UPDATE + - DELETE + - REMOVE_GRANT + - GOVERN_TAGS + resourceTypes: + type: array description: >- - One line display name for the UI. The max length of the display_name - is 200 characters. + Immutable. The resource instance type on which this policy applies. + Format will be of the form : `/` Example: * + `compute.googleapis.com/Instance`. + items: + type: string name: type: string description: >- @@ -176,540 +76,83 @@ components: max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. + description: + description: >- + Detailed information about this custom policy constraint. The max + length of the description is 2000 characters. + type: string condition: + type: string description: >- Org policy condition/expression. For example: `resource.instanceName.matches("[production|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. - type: string - updateTime: - readOnly: true - type: string - format: google-datetime + displayName: description: >- - Output only. The last time this custom constraint was updated. This - represents the last time that the `CreateCustomConstraint` or - `UpdateCustomConstraint` RPC was called - description: + One line display name for the UI. The max length of the display_name + is 200 characters. type: string - description: >- - Detailed information about this custom policy constraint. The max - length of the description is 2000 characters. - resourceTypes: - items: - type: string - description: >- - Immutable. The resource instance type on which this policy applies. - Format will be of the form : `/` Example: * - `compute.googleapis.com/Instance`. - type: array actionType: enum: - ACTION_TYPE_UNSPECIFIED - ALLOW - DENY - type: string - description: Allow or deny type. enumDescriptions: - Unspecified. Results in an error. - Allowed action type. - Deny action type. - methodTypes: - type: array - items: - type: string - enum: - - METHOD_TYPE_UNSPECIFIED - - CREATE - - UPDATE - - DELETE - - REMOVE_GRANT - - GOVERN_TAGS - enumDescriptions: - - Unspecified. Results in an error. - - Constraint applied when creating the resource. - - Constraint applied when updating the resource. - - >- - Constraint applied when deleting the resource. Not supported - yet. - - Constraint applied when removing an IAM grant. - - Constraint applied when enforcing forced tagging. - description: All the operations being applied for this constraint. + type: string + description: Allow or deny type. + updateTime: + type: string + description: >- + Output only. The last time this custom constraint was updated. This + represents the last time that the `CreateCustomConstraint` or + `UpdateCustomConstraint` RPC was called + readOnly: true + format: google-datetime + description: >- + A custom constraint defined by customers which can *only* be applied to + the given resource types and organization. By creating a custom + constraint, customers can apply policies of this custom constraint. + *Creating a custom constraint itself does NOT apply any policy + enforcement*. id: GoogleCloudOrgpolicyV2CustomConstraint type: object - GoogleIamV1AuditConfig: + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: type: object + id: >- + GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - id: GoogleIamV1AuditConfig + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. properties: - auditLogConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - description: The configuration for logging of each type of permission. - service: - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - type: string - GoogleCloudPolicysimulatorV1ExplainedAccess: - type: object - id: GoogleCloudPolicysimulatorV1ExplainedAccess - description: >- - Details about how a set of policies, listed in ExplainedPolicy, resulted - in a certain AccessState when replaying an access tuple. - properties: - accessState: - description: >- - Whether the principal in the access tuple has permission to access - the resource in the access tuple under the given policies. - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - type: string - policies: - description: >- - If the AccessState is `UNKNOWN`, this field contains the policies - that led to that result. If the `AccessState` is `GRANTED` or - `NOT_GRANTED`, this field is omitted. - type: array - items: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' - errors: - type: array - description: >- - If the AccessState is `UNKNOWN`, this field contains a list of - errors explaining why the result is `UNKNOWN`. If the `AccessState` - is `GRANTED` or `NOT_GRANTED`, this field is omitted. - items: - $ref: '#/components/schemas/GoogleRpcStatus' - GoogleCloudPolicysimulatorV1OrgPolicyOverlay: - type: object - description: The proposed changes to OrgPolicy. - properties: - policies: - description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay - type: array - customConstraints: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay - description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - type: array - id: GoogleCloudPolicysimulatorV1OrgPolicyOverlay - GoogleIamV1Binding: - type: object - id: GoogleIamV1Binding - properties: - role: - type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - members: - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - description: Associates `members`, or principals, with a `role`. - GoogleCloudOrgpolicyV2PolicySpecPolicyRule: - description: A rule used to express this policy. - properties: - values: - $ref: >- - #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - description: >- - List of values to be used for this policy rule. This field can be - set only in policies for list constraints. - allowAll: - type: boolean - description: >- - Setting this to true means that all values are allowed. This field - can be set only in policies for list constraints. - denyAll: - description: >- - Setting this to true means that all values are denied. This field - can be set only in policies for list constraints. - type: boolean - enforce: - type: boolean - description: >- - If `true`, then the policy is enforced. If `false`, then any - configuration is acceptable. This field can be set only in policies - for boolean constraints. - condition: - $ref: '#/components/schemas/GoogleTypeExpr' - description: >- - A condition which determines whether this rule is used in the - evaluation of the policy. When set, the `expression` field in the - `Expr' must include from 1 to 10 subexpressions, joined by the "||" - or "&&" operators. Each subexpression must be of the form - "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". - or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". - where key_name and value_name are the resource names for Label Keys - and Values. These names are available from the Tag Manager Service. - An example expression is: "resource.matchTag('123456789/environment, - 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule - type: object - GoogleCloudOrgpolicyV2PolicySpec: - properties: - updateTime: - type: string - description: >- - Output only. The time stamp this was previously updated. This - represents the last time a call to `CreatePolicy` or `UpdatePolicy` - was made for that policy. - readOnly: true - format: google-datetime - etag: - description: >- - An opaque tag indicating the current version of the policySpec, used - for concurrency control. This field is ignored if used in a - `CreatePolicy` request. When the policy is returned from either a - `GetPolicy` or a `ListPolicies` request, this `etag` indicates the - version of the current policySpec to use when executing a - read-modify-write loop. When the policy is returned from a - `GetEffectivePolicy` request, the `etag` will be unset. - type: string - reset: - description: >- - Ignores policies set above this resource and restores the - `constraint_default` enforcement behavior of the specific constraint - at this resource. This field can be set in policies for either list - or boolean constraints. If set, `rules` must be empty and - `inherit_from_parent` must be set to false. - type: boolean - inheritFromParent: - description: >- - Determines the inheritance behavior for this policy. If - `inherit_from_parent` is true, policy rules set higher up in the - hierarchy (up to the closest root) are inherited and present in the - effective policy. If it is false, then no rules are inherited, and - this policy becomes the new root for evaluation. This field can be - set only for policies which configure list constraints. - type: boolean - rules: - type: array - description: >- - In policies for boolean constraints, the following requirements - apply: - There must be one and only one policy rule where condition - is unset. - Boolean policy rules with conditions must set `enforced` - to the opposite of the policy rule without a condition. - During - policy evaluation, policy rules with conditions that are true for a - target resource take precedence. - items: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' - description: >- - Defines a Google Cloud policy specification which is used to specify - constraints for configurations of Google Cloud resources. - id: GoogleCloudOrgpolicyV2PolicySpec - type: object - GoogleCloudPolicysimulatorV1ReplayDiff: - id: GoogleCloudPolicysimulatorV1ReplayDiff - properties: - accessDiff: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' - description: >- - A summary and comparison of the principal's access under the current - (baseline) policies and the proposed (simulated) policies for a - single access tuple. The evaluation of the principal's access is - reported in the AccessState field. - type: object - description: >- - The difference between the results of evaluating an access tuple under - the current (baseline) policies and under the proposed (simulated) - policies. This difference explains how a principal's access could change - if the proposed policies were applied. - GoogleCloudPolicysimulatorV1ReplayOperationMetadata: - type: object - properties: - startTime: - format: google-datetime - description: Time when the request was received. - type: string - id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata - description: Metadata about a Replay operation. - GoogleCloudPolicysimulatorV1ExplainedPolicy: - type: object - id: GoogleCloudPolicysimulatorV1ExplainedPolicy - description: Details about how a specific IAM Policy contributed to the access check. - properties: - bindingExplanations: - description: >- - Details about how each binding in the policy affects the principal's - ability, or inability, to use the permission for the resource. If - the user who created the Replay does not have access to the policy, - this field is omitted. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation - fullResourceName: - type: string - description: >- - The full resource name that identifies the resource. For example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - If the user who created the Replay does not have access to the - policy, this field is omitted. For examples of full resource names - for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - relevance: - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - type: string - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of this policy to the overall determination in the - TroubleshootIamPolicyResponse. If the user who created the Replay - does not have access to the policy, this field is omitted. - policy: - $ref: '#/components/schemas/GoogleIamV1Policy' - description: >- - The IAM policy attached to the resource. If the user who created the - Replay does not have access to the policy, this field is empty. - access: - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The user who created the Replay does not have access to all of the - policies that Policy Simulator needs to evaluate. - type: string - description: >- - Indicates whether _this policy_ provides the specified permission to - the specified principal for the specified resource. This field does - _not_ indicate whether the principal actually has the permission for - the resource. There might be another policy that overrides this - policy. To determine whether the principal actually has the - permission, use the `access` field in the - TroubleshootIamPolicyResponse. - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: - description: A change to an OrgPolicy. - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - properties: - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - policyParent: - description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - type: string - type: object - GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: - properties: - membership: - enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED - description: Indicates whether the binding includes the principal. + resourcesFound: + type: integer + format: int32 + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + resourcesScanned: + format: int32 + type: integer + description: Number of resources already scanned. + resourcesPending: + description: Number of resources still to scan. + format: int32 + type: integer + requestTime: + format: google-datetime type: string - enumDescriptions: - - Default value. This value is unused. - - >- - The binding includes the principal. The principal can be included - directly or indirectly. For example: * A principal is included - directly if that principal is listed in the binding. * A principal - is included indirectly if that principal is in a Google group or - Google Workspace domain that is listed in the binding. - - The binding does not include the principal. - - >- - The user who created the Replay is not allowed to access the - binding. - - >- - The principal is an unsupported type. Only Google Accounts and - service accounts are supported. - relevance: + description: Time when the request was received. + startTime: type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - description: >- - The relevance of the principal's status to the overall determination - for the binding. - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: Details about whether the binding includes the principal. - id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership - type: object - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: - description: >- - OrgPolicyViolationsPreview is a resource providing a preview of the - violations that will exist if an OrgPolicy change is made. The list of - violations are modeled as child resources and retrieved via a - ListOrgPolicyViolations API call. There are potentially more - OrgPolicyViolations than could fit in an embedded field. Thus, the use - of a child resource instead of a field. - properties: - customConstraints: - readOnly: true + format: google-datetime description: >- - Output only. The names of the constraints against which all - `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only - contains `PolicyOverlay` then it contains the name of the configured - custom constraint, applicable to the specified policies. Otherwise - it contains the name of the constraint specified in - `CustomConstraintOverlay`. Format: - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - type: array - items: - type: string + Time when the request started processing, i.e., when the state was + set to RUNNING. state: - readOnly: true - type: string - description: Output only. The state of the `OrgPolicyViolationsPreview`. enum: - PREVIEW_STATE_UNSPECIFIED - PREVIEW_PENDING @@ -722,462 +165,413 @@ components: - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - violationsCount: - format: int32 - type: integer - description: >- - Output only. The number of OrgPolicyViolations in this - `OrgPolicyViolationsPreview`. This count may differ from - `resource_summary.noncompliant_count` because each - OrgPolicyViolation is specific to a resource **and** constraint. If - there are multiple constraints being evaluated (i.e. multiple - policies in the overlay), a single resource may violate multiple - constraints. - readOnly: true - resourceCounts: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts - description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - name: - description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` readOnly: true type: string - createTime: - description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. - type: string - format: google-datetime - readOnly: true - overlay: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - description: Required. The proposed changes we are previewing violations for. - type: object - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview - GoogleCloudPolicysimulatorV1OrgPolicyViolation: - type: object + description: Output only. The current state of the operation. + GoogleCloudPolicysimulatorV1ListReplayResultsResponse: properties: - resource: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ResourceContext' - description: The resource violating the constraint. - customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - description: The custom constraint being violated. - name: - description: >- - The name of the `OrgPolicyViolation`. Example: - organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f/orgPolicyViolations/38ce` + replayResults: + description: The results of running a Replay. + type: array + items: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayResult' + nextPageToken: type: string - error: - description: Any error encountered during the evaluation. - $ref: '#/components/schemas/GoogleRpcStatus' - id: GoogleCloudPolicysimulatorV1OrgPolicyViolation - description: >- - OrgPolicyViolation is a resource representing a single resource - violating a single OrgPolicy constraint. - GoogleIamV1Policy: + description: >- + A token that you can use to retrieve the next page of ReplayResult + objects. If this field is omitted, there are no subsequent pages. + id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse + type: object + description: Response message for Simulator.ListReplayResults. + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: properties: - version: + errors: + type: integer format: int32 + readOnly: true description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + Output only. Number of resources that returned an error when + scanned. + compliant: + format: int32 type: integer - etag: - format: byte + description: Output only. Number of scanned resources with zero violations. + readOnly: true + scanned: + format: int32 + readOnly: true description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - type: string - bindings: - type: array + Output only. Number of resources checked for compliance. Must equal: + unenforced + noncompliant + compliant + error + type: integer + noncompliant: description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - items: - $ref: '#/components/schemas/GoogleIamV1Binding' - auditConfigs: - type: array - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - id: GoogleIamV1Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - GoogleCloudOrgpolicyV2Policy: + Output only. Number of scanned resources with at least one + violation. + format: int32 + readOnly: true + type: integer + unenforced: + type: integer + readOnly: true + description: >- + Output only. Number of resources where the constraint was not + enforced, i.e. the Policy set `enforced: false` for that resource. + format: int32 description: >- - Defines an organization policy which is used to specify constraints for - configurations of Google Cloud resources. + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. type: object + id: >- + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: properties: - dryRunSpec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + resourcesPending: + description: Number of resources still to scan. + type: integer + format: int32 + startTime: + type: string description: >- - Dry-run policy. Audit-only policy, can be used to monitor how the - policy would have impacted the existing and future resources if it's - enforced. - alternate: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' - description: Deprecated. - deprecated: true - etag: + Time when the request started processing, i.e. when the state was + set to RUNNING. + format: google-datetime + resourcesFound: + format: int32 + type: integer description: >- - Optional. An opaque tag indicating the current state of the policy, - used for concurrency control. This 'etag' is computed by the server - based on the value of other fields, and may be sent on update and - delete requests to ensure the client has an up-to-date value before - proceeding. + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + state: + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED type: string - spec: - description: Basic information about the Organization Policy. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - name: + description: The current state of the operation. + resourcesScanned: + type: integer + format: int32 + description: Number of resources already scanned. + requestTime: + description: Time when the request was received. + format: google-datetime type: string - description: >- - Immutable. The resource name of the policy. Must be one of the - following forms, where `constraint_name` is the name of the - constraint which this policy configures: * - `projects/{project_number}/policies/{constraint_name}` * - `folders/{folder_id}/policies/{constraint_name}` * - `organizations/{organization_id}/policies/{constraint_name}` For - example, `projects/123/policies/compute.disableSerialPortAccess`. - Note: `projects/{project_id}/policies/{constraint_name}` is also an - acceptable name for API requests, but responses will return the name - using the equivalent project number. - id: GoogleCloudOrgpolicyV2Policy - GoogleTypeExpr: + description: >- + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. + id: >- + GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata type: object - id: GoogleTypeExpr + GoogleCloudPolicysimulatorV1BindingExplanation: + id: GoogleCloudPolicysimulatorV1BindingExplanation properties: - expression: - type: string + memberships: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership description: >- - Textual representation of an expression in Common Expression - Language syntax. - description: + Indicates whether each principal in the binding includes the + principal specified in the request, either directly or indirectly. + Each key identifies a principal in the binding, and each value + indicates whether the principal in the binding includes the + principal in the request. For example, suppose that a binding + includes the following principals: * `user:alice@example.com` * + `group:product-eng@example.com` The principal in the replayed access + tuple is `user:bob@example.com`. This user is a principal of the + group `group:product-eng@example.com`. For the first principal in + the binding, the key is `user:alice@example.com`, and the + `membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. + For the second principal in the binding, the key is + `group:product-eng@example.com`, and the `membership` field in the + value is set to `MEMBERSHIP_INCLUDED`. + type: object + rolePermission: type: string + enumDescriptions: + - Default value. This value is unused. + - The permission is included in the role. + - The permission is not included in the role. + - >- + The user who created the Replay is not allowed to access the + binding. description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - location: + Indicates whether the role granted by this binding contains the + specified permission. + enum: + - ROLE_PERMISSION_UNSPECIFIED + - ROLE_PERMISSION_INCLUDED + - ROLE_PERMISSION_NOT_INCLUDED + - ROLE_PERMISSION_UNKNOWN_INFO_DENIED + role: type: string description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - title: + The role that this binding grants. For example, + `roles/compute.serviceAgent`. For a complete list of predefined IAM + roles, as well as the permissions in each role, see + https://cloud.google.com/iam/help/roles/reference. + condition: + $ref: '#/components/schemas/GoogleTypeExpr' description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - 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. - GoogleCloudPolicysimulatorV1Replay: - properties: - name: + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/docs/conditions-overview. + access: + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED description: >- - Output only. The resource name of the `Replay`, which has the - following format: - `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, - where `{resource-id}` is the ID of the project, folder, or - organization that owns the Replay. Example: - `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` - readOnly: true - type: string - resultsSummary: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary - description: Output only. Summary statistics about the replayed log entries. - state: + Required. Indicates whether _this binding_ provides the specified + permission to the specified principal for the specified resource. + This field does _not_ indicate whether the principal actually has + the permission for the resource. There might be another binding that + overrides this binding. To determine whether the principal actually + has the permission, use the `access` field in the + TroubleshootIamPolicyResponse. + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. type: string + relevance: enumDescriptions: - Default value. This value is unused. - - The `Replay` has not started yet. - - The `Replay` is currently running. - - The `Replay` has successfully completed. - - The `Replay` has finished with an error. - description: Output only. The current state of the `Replay`. - readOnly: true + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. enum: - - STATE_UNSPECIFIED - - PENDING - - RUNNING - - SUCCEEDED - - FAILED - config: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' - description: Required. The configuration used for the `Replay`. - description: A resource describing a `Replay`, or simulation. - type: object - id: GoogleCloudPolicysimulatorV1Replay - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata: - properties: - resourcesFound: - format: int32 - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - type: integer - requestTime: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH type: string - description: Time when the request was received. - format: google-datetime - resourcesPending: - format: int32 - description: Number of resources still to scan. - type: integer - startTime: description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - type: string - format: google-datetime - resourcesScanned: - format: int32 - description: Number of resources already scanned. - type: integer - state: + The relevance of this binding to the overall determination for the + entire policy. + rolePermissionRelevance: type: string - readOnly: true + description: >- + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - description: Output only. The current state of the operation. - id: >- - GoogleCloudPolicysimulatorV1betaCreateOrgPolicyViolationsPreviewOperationMetadata + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + description: >- + Details about how a binding in a policy affects a principal's ability to + use a permission. type: object + GoogleCloudPolicysimulatorV1AccessStateDiff: description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview: + A summary and comparison of the principal's access under the current + (baseline) policies and the proposed (simulated) policies for a single + access tuple. properties: - customConstraints: - readOnly: true + simulated: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' description: >- - Output only. The names of the constraints against which all - `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only - contains `PolicyOverlay` then it contains the name of the configured - custom constraint, applicable to the specified policies. Otherwise - it contains the name of the constraint specified in - `CustomConstraintOverlay`. Format: - `organizations/{organization_id}/customConstraints/{custom_constraint_id}` - Example: - `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - type: array - items: - type: string - state: + The results of evaluating the access tuple under the proposed + (simulated) policies. If the AccessState couldn't be fully + evaluated, this field explains why. + accessChange: enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - type: string + - Default value. This value is unused. + - >- + The principal's access did not change. This includes the case + where both baseline and simulated are UNKNOWN, but the unknown + information is equivalent. + - >- + The principal's access under both the current policies and the + proposed policies is `UNKNOWN`, but the unknown information + differs between them. + - >- + The principal had access under the current policies (`GRANTED`), + but will no longer have access after the proposed changes + (`NOT_GRANTED`). + - >- + The principal did not have access under the current policies + (`NOT_GRANTED`), but will have access after the proposed changes + (`GRANTED`). + - >- + This result can occur for the following reasons: * The principal + had access under the current policies (`GRANTED`), but their + access after the proposed changes is `UNKNOWN`. * The principal's + access under the current policies is `UNKNOWN`, but they will not + have access after the proposed changes (`NOT_GRANTED`). + - >- + This result can occur for the following reasons: * The principal + did not have access under the current policies (`NOT_GRANTED`), + but their access after the proposed changes is `UNKNOWN`. * The + principal's access under the current policies is `UNKNOWN`, but + they will have access after the proposed changes (`GRANTED`). enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - description: Output only. The state of the `OrgPolicyViolationsPreview`. - readOnly: true - resourceCounts: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts + - ACCESS_CHANGE_TYPE_UNSPECIFIED + - NO_CHANGE + - UNKNOWN_CHANGE + - ACCESS_REVOKED + - ACCESS_GAINED + - ACCESS_MAYBE_REVOKED + - ACCESS_MAYBE_GAINED description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - readOnly: true - name: + How the principal's access, specified in the AccessState field, + changed between the current (baseline) policies and proposed + (simulated) policies. type: string - readOnly: true + baseline: description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` - violationsCount: + The results of evaluating the access tuple under the current + (baseline) policies. If the AccessState couldn't be fully evaluated, + this field explains why. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + type: object + id: GoogleCloudPolicysimulatorV1AccessStateDiff + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay: + properties: + policyParent: + type: string + description: >- + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + policy: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + description: Optional. The new or updated OrgPolicy. + type: object + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + description: A change to an OrgPolicy. + GoogleRpcStatus: + id: GoogleRpcStatus + type: object + properties: + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + code: type: integer - readOnly: true format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + message: description: >- - Output only. The number of OrgPolicyViolations in this - `OrgPolicyViolationsPreview`. This count may differ from - `resource_summary.noncompliant_count` because each - OrgPolicyViolation is specific to a resource **and** constraint. If - there are multiple constraints being evaluated (i.e. multiple - policies in the overlay), a single resource may violate multiple - constraints. - overlay: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyOverlay' - description: Required. The proposed changes we are previewing violations for. - createTime: - format: google-datetime - readOnly: true + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: + type: object + properties: + customConstraint: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + description: Optional. The new or updated custom constraint. + customConstraintParent: type: string description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. + Optional. Resource the constraint is attached to. Example: + "organization/987654" + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay + description: A change to an OrgPolicy custom constraint. + GoogleCloudPolicysimulatorV1ReplayOperationMetadata: + id: GoogleCloudPolicysimulatorV1ReplayOperationMetadata type: object + description: Metadata about a Replay operation. + properties: + startTime: + type: string + format: google-datetime + description: Time when the request was received. + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: description: >- - OrgPolicyViolationsPreview is a resource providing a preview of the - violations that will exist if an OrgPolicy change is made. The list of - violations are modeled as child resources and retrieved via a - ListOrgPolicyViolations API call. There are potentially more - OrgPolicyViolations than could fit in an embedded field. Thus, the use - of a child resource instead of a field. - id: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: + GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. type: object - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview - description: >- - OrgPolicyViolationsPreview is a resource providing a preview of the - violations that will exist if an OrgPolicy change is made. The list of - violations are modeled as child resources and retrieved via a - ListOrgPolicyViolations API call. There are potentially more - OrgPolicyViolations than could fit in an embedded field. Thus, the use - of a child resource instead of a field. properties: - resourceCounts: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - description: >- - Output only. A summary of the state of all resources scanned for - compliance with the changed OrgPolicy. - readOnly: true + resourcesScanned: + format: int32 + type: integer + description: Number of resources already scanned. state: - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - readOnly: true + type: string enum: - PREVIEW_STATE_UNSPECIFIED - PREVIEW_PENDING - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED - description: Output only. The state of the `OrgPolicyViolationsPreview`. - type: string - overlay: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay - description: Required. The proposed changes we are previewing violations for. - name: + description: The current state of the operation. + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + resourcesFound: description: >- - Output only. The resource name of the `OrgPolicyViolationsPreview`. - It has the following format: - `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` - Example: - `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending + type: integer + format: int32 + resourcesPending: + format: int32 + type: integer + description: Number of resources still to scan. + startTime: + description: >- + Time when the request started processing, i.e. when the state was + set to RUNNING. type: string - readOnly: true + format: google-datetime + requestTime: + type: string + format: google-datetime + description: Time when the request was received. + id: >- + GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata + GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview: + properties: violationsCount: - type: integer format: int32 - readOnly: true + type: integer description: >- Output only. The number of OrgPolicyViolations in this `OrgPolicyViolationsPreview`. This count may differ from @@ -1186,18 +580,8 @@ components: there are multiple constraints being evaluated (i.e. multiple policies in the overlay), a single resource may violate multiple constraints. - createTime: - description: >- - Output only. Time when this `OrgPolicyViolationsPreview` was - created. readOnly: true - format: google-datetime - type: string customConstraints: - items: - type: string - type: array - readOnly: true description: >- Output only. The names of the constraints against which all `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only @@ -1208,49 +592,45 @@ components: `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` - GoogleLongrunningListOperationsResponse: - id: GoogleLongrunningListOperationsResponse - properties: - operations: - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' type: array + readOnly: true + items: + type: string + resourceCounts: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts description: >- - A list of operations that matches the specified filter in the - request. - nextPageToken: - description: The standard List next-page token. - type: string - type: object - description: The response message for Operations.ListOperations. - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata: - type: object - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - id: >- - GoogleCloudPolicysimulatorV1alphaGenerateOrgPolicyViolationsPreviewOperationMetadata - properties: - startTime: - type: string - description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + readOnly: true + createTime: format: google-datetime - resourcesFound: - format: int32 + readOnly: true description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - type: integer + Output only. Time when this `OrgPolicyViolationsPreview` was + created. + type: string + name: + description: >- + Output only. The resource name of the `OrgPolicyViolationsPreview`. + It has the following format: + `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` + Example: + `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` + readOnly: true + type: string + overlay: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + description: Required. The proposed changes we are previewing violations for. state: + readOnly: true enumDescriptions: - The state is unspecified. - The OrgPolicyViolationsPreview has not been created yet. - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - description: The current state of the operation. enum: - PREVIEW_STATE_UNSPECIFIED - PREVIEW_PENDING @@ -1258,247 +638,266 @@ components: - PREVIEW_SUCCEEDED - PREVIEW_FAILED type: string - requestTime: - type: string - format: google-datetime - description: Time when the request was received. - resourcesPending: - format: int32 - type: integer - description: Number of resources still to scan. - resourcesScanned: - format: int32 - description: Number of resources already scanned. - type: integer - GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: + description: Output only. The state of the `OrgPolicyViolationsPreview`. + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreview + type: object + description: >- + OrgPolicyViolationsPreview is a resource providing a preview of the + violations that will exist if an OrgPolicy change is made. The list of + violations are modeled as child resources and retrieved via a + ListOrgPolicyViolations API call. There are potentially more + OrgPolicyViolations than could fit in an embedded field. Thus, the use + of a child resource instead of a field. + GoogleTypeExpr: + 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. + id: GoogleTypeExpr properties: - scanned: + title: description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - type: integer - readOnly: true - format: int32 - noncompliant: - type: integer + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + location: description: >- - Output only. Number of scanned resources with at least one - violation. - format: int32 - readOnly: true - compliant: - type: integer - description: Output only. Number of scanned resources with zero violations. - readOnly: true - format: int32 - errors: - readOnly: true - type: integer + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + type: string + expression: + type: string description: >- - Output only. Number of resources that returned an error when - scanned. - format: int32 - unenforced: - type: integer + Textual representation of an expression in Common Expression + Language syntax. + description: + type: string description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. - readOnly: true - format: int32 - id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts - type: object - description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: - description: The proposed changes to OrgPolicy. + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. type: object - properties: - customConstraints: - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay - type: array - description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - policies: - type: array - description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay - id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay - GoogleCloudPolicysimulatorV1ReplayResultsSummary: - id: GoogleCloudPolicysimulatorV1ReplayResultsSummary + GoogleCloudPolicysimulatorV1Replay: + description: A resource describing a `Replay`, or simulation. type: object - description: Summary statistics about the replayed log entries. properties: - differenceCount: - type: integer - format: int32 - description: >- - The number of replayed log entries with a difference between - baseline and simulated policies. - newestDate: - description: The date of the newest log entry replayed. - $ref: '#/components/schemas/GoogleTypeDate' - oldestDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The date of the oldest log entry replayed. - logCount: - description: The total number of log entries replayed. - format: int32 - type: integer - errorCount: - format: int32 - type: integer - description: The number of log entries that could not be replayed. - unchangedCount: - format: int32 + name: description: >- - The number of replayed log entries with no difference between - baseline and simulated policies. - type: integer + Output only. The resource name of the `Replay`, which has the + following format: + `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, + where `{resource-id}` is the ID of the project, folder, or + organization that owns the Replay. Example: + `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` + readOnly: true + type: string + config: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayConfig' + description: Required. The configuration used for the `Replay`. + state: + description: Output only. The current state of the `Replay`. + enum: + - STATE_UNSPECIFIED + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + type: string + enumDescriptions: + - Default value. This value is unused. + - The `Replay` has not started yet. + - The `Replay` is currently running. + - The `Replay` has successfully completed. + - The `Replay` has finished with an error. + readOnly: true + resultsSummary: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ReplayResultsSummary + readOnly: true + description: Output only. Summary statistics about the replayed log entries. + id: GoogleCloudPolicysimulatorV1Replay GoogleIamV1AuditLogConfig: - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - id: GoogleIamV1AuditLogConfig + type: object properties: exemptedMembers: - type: array items: type: string description: >- Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + type: array logType: - type: string description: The log type that this config enables. - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ enumDescriptions: - Default case. Should never be this. - 'Admin reads. Example: CloudIAM getIamPolicy' - 'Data writes. Example: CloudSQL Users create' - 'Data reads. Example: CloudSQL Users list' + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + type: string + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + id: GoogleIamV1AuditLogConfig + GoogleIamV1Binding: type: object - GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + id: GoogleIamV1Binding + description: Associates `members`, or principals, with a `role`. properties: - deniedValues: - items: - type: string - description: List of values denied at this resource. + condition: + description: >- + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + $ref: '#/components/schemas/GoogleTypeExpr' + members: type: array - allowedValues: - description: List of values allowed at this resource. items: type: string - type: array - id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues - description: >- - A message that holds specific allowed and denied values. This message - can define specific values and subtrees of the Resource Manager resource - hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or - denied. This is achieved by using the `under:` and optional `is:` - prefixes. The `under:` prefix is used to denote resource subtree values. - The `is:` prefix is used to denote specific values, and is required only - if the value contains a ":". Values prefixed with "is:" are treated the - same as values with no prefix. Ancestry subtrees must be in one of the - following formats: - `projects/` (for example, - `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - - `organizations/` (for example, `organizations/1234`) The - `supports_under` field of the associated `Constraint` defines whether - ancestry prefixes can be used. + description: >- + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + role: + description: >- + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + type: string + GoogleCloudPolicysimulatorV1ReplayResultsSummary: + description: Summary statistics about the replayed log entries. type: object - GoogleTypeDate: - id: GoogleTypeDate properties: - year: - format: int32 + unchangedCount: type: integer + format: int32 description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without a year. - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. + The number of replayed log entries with no difference between + baseline and simulated policies. + newestDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: The date of the newest log entry replayed. + oldestDate: + $ref: '#/components/schemas/GoogleTypeDate' + description: The date of the oldest log entry replayed. + differenceCount: format: int32 type: integer - day: + description: >- + The number of replayed log entries with a difference between + baseline and simulated policies. + logCount: format: int32 type: integer - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 to specify a year by itself or a year and month where - the day isn't significant. + description: The total number of log entries replayed. + errorCount: + type: integer + description: The number of log entries that could not be replayed. + format: int32 + id: GoogleCloudPolicysimulatorV1ReplayResultsSummary + GoogleCloudOrgpolicyV2AlternatePolicySpec: description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp + Similar to PolicySpec but with an extra 'launch' field for launch + reference. The PolicySpec here is specific for dry-run/darklaunch. type: object - GoogleCloudPolicysimulatorV1ReplayConfig: + id: GoogleCloudOrgpolicyV2AlternatePolicySpec properties: - policyOverlay: - type: object - additionalProperties: - $ref: '#/components/schemas/GoogleIamV1Policy' + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Specify constraint for configurations of Google Cloud resources. + launch: description: >- - A mapping of the resources that you want to simulate policies for - and the policies that you want to simulate. Keys are the full - resource names for the resources. For example, - `//cloudresourcemanager.googleapis.com/projects/my-project`. For - examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - Values are Policy objects representing the policies that you want to - simulate. Replays automatically take into account any IAM policies - inherited through the resource hierarchy, and any policies set on - descendant resources. You do not need to include these policies in - the policy overlay. - logSource: - enum: - - LOG_SOURCE_UNSPECIFIED - - RECENT_ACCESSES - type: string - description: The logs to use as input for the Replay. - enumDescriptions: - - >- - An unspecified log source. If the log source is unspecified, the - Replay defaults to using `RECENT_ACCESSES`. - - >- - All access logs from the last 90 days. These logs may not include - logs from the most recent 7 days. - description: The configuration used for a Replay. - id: GoogleCloudPolicysimulatorV1ReplayConfig - type: object + Reference to the launch that will be used while audit logging and to + control the launch. Should be set only in the alternate policy. + type: string GoogleCloudPolicysimulatorV1AccessTuple: - type: object + description: Information about the principal, resource, and permission to check. properties: principal: + type: string description: >- Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, @@ -1506,15 +905,14 @@ components: `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported. - type: string fullResourceName: + type: string description: >- Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - type: string permission: type: string description: >- @@ -1524,454 +922,574 @@ components: complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. id: GoogleCloudPolicysimulatorV1AccessTuple - description: Information about the principal, resource, and permission to check. - GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay: - description: A change to an OrgPolicy. + type: object + GoogleLongrunningOperation: + id: GoogleLongrunningOperation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + type: object properties: - policy: - description: Optional. The new or updated OrgPolicy. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - policyParent: + done: + type: boolean description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error result of the operation in case of failure or + cancellation. + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + response: + description: >- + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay: type: object - id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayPolicyOverlay - GoogleCloudPolicysimulatorV1ReplayResult: + description: The proposed changes to OrgPolicy. + id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay properties: - accessTuple: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' + policies: description: >- - The access tuple that was replayed. This field includes information - about the principal, resource, and permission that were involved in - the access attempt. - lastSeenDate: - $ref: '#/components/schemas/GoogleTypeDate' - description: The latest date this access tuple was seen in the logs. - parent: - description: The Replay that the access tuple was included in. + Optional. The OrgPolicy changes to preview violations for. Any + existing OrgPolicies with the same name will be overridden in the + simulation. That is, violations will be determined as if all + policies in the overlay were created or updated. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayPolicyOverlay + type: array + customConstraints: + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay + type: array + description: >- + Optional. The OrgPolicy CustomConstraint changes to preview + violations for. Any existing CustomConstraints with the same name + will be overridden in the simulation. That is, violations will be + determined as if all custom constraints in the overlay were + instantiated. Only a single custom_constraint is supported in the + overlay at a time. For evaluating multiple constraints, multiple + `GenerateOrgPolicyViolationsPreview` requests are made, where each + request evaluates a single constraint. + GoogleCloudPolicysimulatorV1ExplainedPolicy: + id: GoogleCloudPolicysimulatorV1ExplainedPolicy + type: object + description: Details about how a specific IAM Policy contributed to the access check. + properties: + relevance: + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH type: string - diff: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' description: >- - The difference between the principal's access under the current - (baseline) policies and the principal's access under the proposed - (simulated) policies. This field is only included for access tuples - that were successfully replayed and had different results under the - current policies and the proposed policies. - name: + The relevance of this policy to the overall determination in the + TroubleshootIamPolicyResponse. If the user who created the Replay + does not have access to the policy, this field is omitted. + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + bindingExplanations: + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1BindingExplanation + description: >- + Details about how each binding in the policy affects the principal's + ability, or inability, to use the permission for the resource. If + the user who created the Replay does not have access to the policy, + this field is omitted. + type: array + policy: + $ref: '#/components/schemas/GoogleIamV1Policy' + description: >- + The IAM policy attached to the resource. If the user who created the + Replay does not have access to the policy, this field is empty. + fullResourceName: type: string description: >- - The resource name of the `ReplayResult`, in the following format: - `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, - where `{resource-id}` is the ID of the project, folder, or - organization that owns the Replay. Example: - `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` - error: - $ref: '#/components/schemas/GoogleRpcStatus' + The full resource name that identifies the resource. For example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + If the user who created the Replay does not have access to the + policy, this field is omitted. For examples of full resource names + for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + access: + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. + type: string description: >- - The error that caused the access tuple replay to fail. This field is - only included for access tuples that were not replayed successfully. + Indicates whether _this policy_ provides the specified permission to + the specified principal for the specified resource. This field does + _not_ indicate whether the principal actually has the permission for + the resource. There might be another policy that overrides this + policy. To determine whether the principal actually has the + permission, use the `access` field in the + TroubleshootIamPolicyResponse. + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + GoogleTypeDate: + type: object + id: GoogleTypeDate + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + properties: + day: + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + type: integer + format: int32 + year: + type: integer + format: int32 + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + month: + format: int32 + type: integer + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership: + id: GoogleCloudPolicysimulatorV1BindingExplanationAnnotatedMembership + properties: + relevance: + description: >- + The relevance of the principal's status to the overall determination + for the binding. + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + type: string + membership: + description: Indicates whether the binding includes the principal. + enum: + - MEMBERSHIP_UNSPECIFIED + - MEMBERSHIP_INCLUDED + - MEMBERSHIP_NOT_INCLUDED + - MEMBERSHIP_UNKNOWN_INFO_DENIED + - MEMBERSHIP_UNKNOWN_UNSUPPORTED + enumDescriptions: + - Default value. This value is unused. + - >- + The binding includes the principal. The principal can be included + directly or indirectly. For example: * A principal is included + directly if that principal is listed in the binding. * A principal + is included indirectly if that principal is in a Google group or + Google Workspace domain that is listed in the binding. + - The binding does not include the principal. + - >- + The user who created the Replay is not allowed to access the + binding. + - >- + The principal is an unsupported type. Only Google Accounts and + service accounts are supported. + type: string + description: Details about whether the binding includes the principal. type: object - id: GoogleCloudPolicysimulatorV1ReplayResult - description: The result of replaying a single access tuple against a simulated state. - GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse: + GoogleCloudOrgpolicyV2PolicySpecPolicyRule: + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRule + description: A rule used to express this policy. type: object properties: - nextPageToken: - type: string + enforce: + type: boolean description: >- - A token that you can use to retrieve the next page of results. If - this field is omitted, there are no subsequent pages. - orgPolicyViolationsPreviews: - description: The list of OrgPolicyViolationsPreview - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview - description: >- - ListOrgPolicyViolationsPreviewsResponse is the response message for - OrgPolicyViolationsPreviewService.ListOrgPolicyViolationsPreviews. - id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse - GoogleCloudPolicysimulatorV1ListReplayResultsResponse: - id: GoogleCloudPolicysimulatorV1ListReplayResultsResponse - properties: - replayResults: - items: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayResult' - type: array - description: The results of running a Replay. - nextPageToken: + If `true`, then the policy is enforced. If `false`, then any + configuration is acceptable. This field can be set only in policies + for boolean constraints. + condition: + $ref: '#/components/schemas/GoogleTypeExpr' description: >- - A token that you can use to retrieve the next page of ReplayResult - objects. If this field is omitted, there are no subsequent pages. - type: string - description: Response message for Simulator.ListReplayResults. + A condition which determines whether this rule is used in the + evaluation of the policy. When set, the `expression` field in the + `Expr' must include from 1 to 10 subexpressions, joined by the "||" + or "&&" operators. Each subexpression must be of the form + "resource.matchTag('/tag_key_short_name, 'tag_value_short_name')". + or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". + where key_name and value_name are the resource names for Label Keys + and Values. These names are available from the Tag Manager Service. + An example expression is: "resource.matchTag('123456789/environment, + 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')". + values: + $ref: >- + #/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + description: >- + List of values to be used for this policy rule. This field can be + set only in policies for list constraints. + allowAll: + type: boolean + description: >- + Setting this to true means that all values are allowed. This field + can be set only in policies for list constraints. + denyAll: + description: >- + Setting this to true means that all values are denied. This field + can be set only in policies for list constraints. + type: boolean + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview: + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreview type: object - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts: - id: >- - GoogleCloudPolicysimulatorV1alphaOrgPolicyViolationsPreviewResourceCounts - description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. properties: - errors: - type: integer - description: >- - Output only. Number of resources that returned an error when - scanned. - format: int32 + createTime: readOnly: true - scanned: + format: google-datetime description: >- - Output only. Number of resources checked for compliance. Must equal: - unenforced + noncompliant + compliant + error - format: int32 - type: integer - readOnly: true - compliant: - readOnly: true - description: Output only. Number of scanned resources with zero violations. - format: int32 - type: integer - unenforced: - format: int32 - type: integer + Output only. Time when this `OrgPolicyViolationsPreview` was + created. + type: string + overlay: + description: Required. The proposed changes we are previewing violations for. + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyOverlay + name: readOnly: true + type: string description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. - noncompliant: - type: integer + Output only. The resource name of the `OrgPolicyViolationsPreview`. + It has the following format: + `organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreview}` + Example: + `organizations/my-example-org/locations/global/orgPolicyViolationsPreviews/506a5f7f` + resourceCounts: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts readOnly: true description: >- - Output only. Number of scanned resources with at least one - violation. - format: int32 - type: object - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: - description: A change to an OrgPolicy. - type: object - properties: - policy: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' - description: Optional. The new or updated OrgPolicy. - policyParent: - type: string + Output only. A summary of the state of all resources scanned for + compliance with the changed OrgPolicy. + violationsCount: description: >- - Optional. The parent of the policy we are attaching to. Example: - "projects/123456" - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse: - description: >- - ListOrgPolicyViolationsResponse is the response message for - OrgPolicyViolationsPreviewService.ListOrgPolicyViolations - id: GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse - properties: - nextPageToken: - type: string + Output only. The number of OrgPolicyViolations in this + `OrgPolicyViolationsPreview`. This count may differ from + `resource_summary.noncompliant_count` because each + OrgPolicyViolation is specific to a resource **and** constraint. If + there are multiple constraints being evaluated (i.e. multiple + policies in the overlay), a single resource may violate multiple + constraints. + readOnly: true + format: int32 + type: integer + customConstraints: description: >- - A token that you can use to retrieve the next page of results. If - this field is omitted, there are no subsequent pages. - orgPolicyViolations: + Output only. The names of the constraints against which all + `OrgPolicyViolations` were evaluated. If `OrgPolicyOverlay` only + contains `PolicyOverlay` then it contains the name of the configured + custom constraint, applicable to the specified policies. Otherwise + it contains the name of the constraint specified in + `CustomConstraintOverlay`. Format: + `organizations/{organization_id}/customConstraints/{custom_constraint_id}` + Example: + `organizations/123/customConstraints/custom.createOnlyE2TypeVms` items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolation + type: string + readOnly: true type: array - description: The list of OrgPolicyViolations - type: object - GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts: - id: GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreviewResourceCounts - type: object + state: + type: string + enumDescriptions: + - The state is unspecified. + - The OrgPolicyViolationsPreview has not been created yet. + - The OrgPolicyViolationsPreview is currently being created. + - The OrgPolicyViolationsPreview creation finished successfully. + - The OrgPolicyViolationsPreview creation failed with an error. + description: Output only. The state of the `OrgPolicyViolationsPreview`. + readOnly: true + enum: + - PREVIEW_STATE_UNSPECIFIED + - PREVIEW_PENDING + - PREVIEW_RUNNING + - PREVIEW_SUCCEEDED + - PREVIEW_FAILED description: >- - A summary of the state of all resources scanned for compliance with the - changed OrgPolicy. + OrgPolicyViolationsPreview is a resource providing a preview of the + violations that will exist if an OrgPolicy change is made. The list of + violations are modeled as child resources and retrieved via a + ListOrgPolicyViolations API call. There are potentially more + OrgPolicyViolations than could fit in an embedded field. Thus, the use + of a child resource instead of a field. + GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts: properties: noncompliant: format: int32 - type: integer + readOnly: true description: >- Output only. Number of scanned resources with at least one violation. - readOnly: true + type: integer scanned: + format: int32 description: >- Output only. Number of resources checked for compliance. Must equal: unenforced + noncompliant + compliant + error type: integer readOnly: true - format: int32 - unenforced: + compliant: type: integer readOnly: true - description: >- - Output only. Number of resources where the constraint was not - enforced, i.e. the Policy set `enforced: false` for that resource. + description: Output only. Number of scanned resources with zero violations. format: int32 errors: - readOnly: true - format: int32 type: integer description: >- Output only. Number of resources that returned an error when scanned. - compliant: - description: Output only. Number of scanned resources with zero violations. - format: int32 readOnly: true + format: int32 + unenforced: type: integer - GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay: - description: A change to an OrgPolicy custom constraint. + description: >- + Output only. Number of resources where the constraint was not + enforced, i.e. the Policy set `enforced: false` for that resource. + readOnly: true + format: int32 type: object + description: >- + A summary of the state of all resources scanned for compliance with the + changed OrgPolicy. + id: GoogleCloudPolicysimulatorV1betaOrgPolicyViolationsPreviewResourceCounts + GoogleCloudPolicysimulatorV1ExplainedAccess: + description: >- + Details about how a set of policies, listed in ExplainedPolicy, resulted + in a certain AccessState when replaying an access tuple. properties: - customConstraintParent: + accessState: type: string + enumDescriptions: + - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. + - >- + The principal has the permission only if a condition expression + evaluates to `true`. + - >- + The user who created the Replay does not have access to all of the + policies that Policy Simulator needs to evaluate. description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" - customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - description: Optional. The new or updated custom constraint. - id: GoogleCloudPolicysimulatorV1OrgPolicyOverlayCustomConstraintOverlay - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay: - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay - description: A change to an OrgPolicy custom constraint. - properties: - customConstraint: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' - description: Optional. The new or updated custom constraint. - customConstraintParent: - type: string + Whether the principal in the access tuple has permission to access + the resource in the access tuple under the given policies. + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + policies: + type: array + items: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedPolicy' description: >- - Optional. Resource the constraint is attached to. Example: - "organization/987654" + If the AccessState is `UNKNOWN`, this field contains the policies + that led to that result. If the `AccessState` is `GRANTED` or + `NOT_GRANTED`, this field is omitted. + errors: + description: >- + If the AccessState is `UNKNOWN`, this field contains a list of + errors explaining why the result is `UNKNOWN`. If the `AccessState` + is `GRANTED` or `NOT_GRANTED`, this field is omitted. + type: array + items: + $ref: '#/components/schemas/GoogleRpcStatus' + type: object + id: GoogleCloudPolicysimulatorV1ExplainedAccess + GoogleIamV1AuditConfig: + id: GoogleIamV1AuditConfig type: object - GoogleCloudPolicysimulatorV1ResourceContext: - id: GoogleCloudPolicysimulatorV1ResourceContext properties: - ancestors: + auditLogConfigs: items: - type: string + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' type: array + description: The configuration for logging of each type of permission. + service: description: >- - The ancestry path of the resource in Google Cloud [resource - hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), - represented as a list of relative resource names. An ancestry path - starts with the closest ancestor in the hierarchy and ends at root. - If the resource is a project, folder, or organization, the ancestry - path starts from the resource itself. Example: - `["projects/123456789", "folders/5432", "organizations/1234"]` - assetType: - description: >- - The asset type of the resource as defined by CAIS. Example: - `compute.googleapis.com/Firewall` See [Supported asset - types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - for more information. - type: string - resource: + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. type: string - description: >- - The full name of the resource. Example: - `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` - See [Resource - names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - for more information. - type: object description: >- - ResourceContext provides the context we know about a resource. It is - similar in concept to google.cloud.asset.v1.Resource, but focuses on the - information specifically used by Simulator. - GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues: + id: GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues + description: >- + A message that holds specific allowed and denied values. This message + can define specific values and subtrees of the Resource Manager resource + hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed or + denied. This is achieved by using the `under:` and optional `is:` + prefixes. The `under:` prefix is used to denote resource subtree values. + The `is:` prefix is used to denote specific values, and is required only + if the value contains a ":". Values prefixed with "is:" are treated the + same as values with no prefix. Ancestry subtrees must be in one of the + following formats: - `projects/` (for example, + `projects/tokyo-rain-123`) - `folders/` (for example, `folders/1234`) - + `organizations/` (for example, `organizations/1234`) The + `supports_under` field of the associated `Constraint` defines whether + ancestry prefixes can be used. type: object properties: - policies: - type: array - description: >- - Optional. The OrgPolicy changes to preview violations for. Any - existing OrgPolicies with the same name will be overridden in the - simulation. That is, violations will be determined as if all - policies in the overlay were created or updated. + deniedValues: items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay - customConstraints: + type: string + description: List of values denied at this resource. + type: array + allowedValues: + description: List of values allowed at this resource. items: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay + type: string type: array - description: >- - Optional. The OrgPolicy CustomConstraint changes to preview - violations for. Any existing CustomConstraints with the same name - will be overridden in the simulation. That is, violations will be - determined as if all custom constraints in the overlay were - instantiated. Only a single custom_constraint is supported in the - overlay at a time. For evaluating multiple constraints, multiple - `GenerateOrgPolicyViolationsPreview` requests are made, where each - request evaluates a single constraint. - description: The proposed changes to OrgPolicy. - id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay - GoogleRpcStatus: + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay: type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: GoogleRpcStatus - properties: - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - GoogleLongrunningOperation: + description: A change to an OrgPolicy. properties: - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + policyParent: type: string - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - error: - $ref: '#/components/schemas/GoogleRpcStatus' description: >- - The error result of the operation in case of failure or - cancellation. - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: GoogleLongrunningOperation + Optional. The parent of the policy we are attaching to. Example: + "projects/123456" + policy: + description: Optional. The new or updated OrgPolicy. + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2Policy' + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + GoogleCloudOrgpolicyV2Policy: type: object - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata: + description: >- + Defines an organization policy which is used to specify constraints for + configurations of Google Cloud resources. properties: - resourcesScanned: - description: Number of resources already scanned. - type: integer - format: int32 - state: - enumDescriptions: - - The state is unspecified. - - The OrgPolicyViolationsPreview has not been created yet. - - The OrgPolicyViolationsPreview is currently being created. - - The OrgPolicyViolationsPreview creation finished successfully. - - The OrgPolicyViolationsPreview creation failed with an error. - enum: - - PREVIEW_STATE_UNSPECIFIED - - PREVIEW_PENDING - - PREVIEW_RUNNING - - PREVIEW_SUCCEEDED - - PREVIEW_FAILED - description: The current state of the operation. - type: string - resourcesFound: - type: integer - format: int32 + spec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' + description: Basic information about the Organization Policy. + alternate: + description: Deprecated. + deprecated: true + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2AlternatePolicySpec' + dryRunSpec: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending - requestTime: - description: Time when the request was received. + Dry-run policy. Audit-only policy, can be used to monitor how the + policy would have impacted the existing and future resources if it's + enforced. + name: + description: >- + Immutable. The resource name of the policy. Must be one of the + following forms, where `constraint_name` is the name of the + constraint which this policy configures: * + `projects/{project_number}/policies/{constraint_name}` * + `folders/{folder_id}/policies/{constraint_name}` * + `organizations/{organization_id}/policies/{constraint_name}` For + example, `projects/123/policies/compute.disableSerialPortAccess`. + Note: `projects/{project_id}/policies/{constraint_name}` is also an + acceptable name for API requests, but responses will return the name + using the equivalent project number. type: string - format: google-datetime - startTime: - format: google-datetime + etag: type: string description: >- - Time when the request started processing, i.e. when the state was - set to RUNNING. - resourcesPending: - format: int32 - description: Number of resources still to scan. - type: integer - description: >- - GenerateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. - type: object - id: >- - GoogleCloudPolicysimulatorV1betaGenerateOrgPolicyViolationsPreviewOperationMetadata + Optional. An opaque tag indicating the current state of the policy, + used for concurrency control. This 'etag' is computed by the server + based on the value of other fields, and may be sent on update and + delete requests to ensure the client has an up-to-date value before + proceeding. + id: GoogleCloudOrgpolicyV2Policy GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata: - id: >- - GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata - type: object - description: >- - CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an - OrgPolicyViolationsPreview generations operation. properties: - resourcesFound: - format: int32 - description: >- - Total number of resources that need scanning. Should equal - resource_scanned + resources_pending + resourcesPending: + description: Number of resources still to scan. type: integer + format: int32 resourcesScanned: - description: Number of resources already scanned. type: integer format: int32 - startTime: - type: string - format: google-datetime - description: >- - Time when the request started processing, i.e., when the state was - set to RUNNING. - resourcesPending: + description: Number of resources already scanned. + resourcesFound: type: integer + description: >- + Total number of resources that need scanning. Should equal + resource_scanned + resources_pending format: int32 - description: Number of resources still to scan. - requestTime: - type: string - description: Time when the request was received. - format: google-datetime state: enum: - PREVIEW_STATE_UNSPECIFIED @@ -1979,130 +1497,336 @@ components: - PREVIEW_RUNNING - PREVIEW_SUCCEEDED - PREVIEW_FAILED - description: Output only. The current state of the operation. - readOnly: true - type: string enumDescriptions: - The state is unspecified. - The OrgPolicyViolationsPreview has not been created yet. - The OrgPolicyViolationsPreview is currently being created. - The OrgPolicyViolationsPreview creation finished successfully. - The OrgPolicyViolationsPreview creation failed with an error. - GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: - description: A change to an OrgPolicy custom constraint. + description: Output only. The current state of the operation. + readOnly: true + type: string + requestTime: + type: string + description: Time when the request was received. + format: google-datetime + startTime: + description: >- + Time when the request started processing, i.e., when the state was + set to RUNNING. + type: string + format: google-datetime + id: >- + GoogleCloudPolicysimulatorV1alphaCreateOrgPolicyViolationsPreviewOperationMetadata type: object + description: >- + CreateOrgPolicyViolationsPreviewOperationMetadata is metadata about an + OrgPolicyViolationsPreview generations operation. + GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay: properties: + customConstraint: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' + description: Optional. The new or updated custom constraint. customConstraintParent: + type: string description: >- Optional. Resource the constraint is attached to. Example: "organization/987654" - type: string - customConstraint: - description: Optional. The new or updated custom constraint. - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2CustomConstraint' id: GoogleCloudPolicysimulatorV1betaOrgPolicyOverlayCustomConstraintOverlay - GoogleCloudPolicysimulatorV1AccessStateDiff: + type: object + description: A change to an OrgPolicy custom constraint. + GoogleCloudPolicysimulatorV1ReplayResult: properties: - accessChange: + error: + $ref: '#/components/schemas/GoogleRpcStatus' + description: >- + The error that caused the access tuple replay to fail. This field is + only included for access tuples that were not replayed successfully. + diff: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ReplayDiff' + description: >- + The difference between the principal's access under the current + (baseline) policies and the principal's access under the proposed + (simulated) policies. This field is only included for access tuples + that were successfully replayed and had different results under the + current policies and the proposed policies. + lastSeenDate: + description: The latest date this access tuple was seen in the logs. + $ref: '#/components/schemas/GoogleTypeDate' + parent: + type: string + description: The Replay that the access tuple was included in. + name: + type: string + description: >- + The resource name of the `ReplayResult`, in the following format: + `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, + where `{resource-id}` is the ID of the project, folder, or + organization that owns the Replay. Example: + `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` + accessTuple: + description: >- + The access tuple that was replayed. This field includes information + about the principal, resource, and permission that were involved in + the access attempt. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessTuple' + id: GoogleCloudPolicysimulatorV1ReplayResult + type: object + description: The result of replaying a single access tuple against a simulated state. + GoogleCloudPolicysimulatorV1ReplayConfig: + id: GoogleCloudPolicysimulatorV1ReplayConfig + description: The configuration used for a Replay. + properties: + policyOverlay: + type: object + description: >- + A mapping of the resources that you want to simulate policies for + and the policies that you want to simulate. Keys are the full + resource names for the resources. For example, + `//cloudresourcemanager.googleapis.com/projects/my-project`. For + examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + Values are Policy objects representing the policies that you want to + simulate. Replays automatically take into account any IAM policies + inherited through the resource hierarchy, and any policies set on + descendant resources. You do not need to include these policies in + the policy overlay. + additionalProperties: + $ref: '#/components/schemas/GoogleIamV1Policy' + logSource: + type: string + description: The logs to use as input for the Replay. + enum: + - LOG_SOURCE_UNSPECIFIED + - RECENT_ACCESSES enumDescriptions: - - Default value. This value is unused. - - >- - The principal's access did not change. This includes the case - where both baseline and simulated are UNKNOWN, but the unknown - information is equivalent. - - >- - The principal's access under both the current policies and the - proposed policies is `UNKNOWN`, but the unknown information - differs between them. - >- - The principal had access under the current policies (`GRANTED`), - but will no longer have access after the proposed changes - (`NOT_GRANTED`). - - >- - The principal did not have access under the current policies - (`NOT_GRANTED`), but will have access after the proposed changes - (`GRANTED`). - - >- - This result can occur for the following reasons: * The principal - had access under the current policies (`GRANTED`), but their - access after the proposed changes is `UNKNOWN`. * The principal's - access under the current policies is `UNKNOWN`, but they will not - have access after the proposed changes (`NOT_GRANTED`). + An unspecified log source. If the log source is unspecified, the + Replay defaults to using `RECENT_ACCESSES`. - >- - This result can occur for the following reasons: * The principal - did not have access under the current policies (`NOT_GRANTED`), - but their access after the proposed changes is `UNKNOWN`. * The - principal's access under the current policies is `UNKNOWN`, but - they will have access after the proposed changes (`GRANTED`). + All access logs from the last 90 days. These logs may not include + logs from the most recent 7 days. + type: object + GoogleIamV1Policy: + properties: + etag: + description: >- + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. + format: byte + type: string + bindings: + description: >- + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + type: array + version: + format: int32 + type: integer + description: >- + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + auditConfigs: + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + description: Specifies cloud audit logging configuration for this policy. + type: array + id: GoogleIamV1Policy + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + type: object + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + description: The response message for Operations.ListOperations. + type: object + properties: + nextPageToken: type: string - enum: - - ACCESS_CHANGE_TYPE_UNSPECIFIED - - NO_CHANGE - - UNKNOWN_CHANGE - - ACCESS_REVOKED - - ACCESS_GAINED - - ACCESS_MAYBE_REVOKED - - ACCESS_MAYBE_GAINED - description: >- - How the principal's access, specified in the AccessState field, - changed between the current (baseline) policies and proposed - (simulated) policies. - simulated: + description: The standard List next-page token. + operations: + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' description: >- - The results of evaluating the access tuple under the proposed - (simulated) policies. If the AccessState couldn't be fully - evaluated, this field explains why. - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' - baseline: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1ExplainedAccess' + A list of operations that matches the specified filter in the + request. + GoogleCloudPolicysimulatorV1ReplayDiff: + id: GoogleCloudPolicysimulatorV1ReplayDiff + properties: + accessDiff: description: >- - The results of evaluating the access tuple under the current - (baseline) policies. If the AccessState couldn't be fully evaluated, - this field explains why. - id: GoogleCloudPolicysimulatorV1AccessStateDiff + A summary and comparison of the principal's access under the current + (baseline) policies and the proposed (simulated) policies for a + single access tuple. The evaluation of the principal's access is + reported in the AccessState field. + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1AccessStateDiff' description: >- - A summary and comparison of the principal's access under the current - (baseline) policies and the proposed (simulated) policies for a single - access tuple. + The difference between the results of evaluating an access tuple under + the current (baseline) policies and under the proposed (simulated) + policies. This difference explains how a principal's access could change + if the proposed policies were applied. type: object - GoogleCloudOrgpolicyV2AlternatePolicySpec: - id: GoogleCloudOrgpolicyV2AlternatePolicySpec + GoogleCloudOrgpolicyV2PolicySpec: + description: >- + Defines a Google Cloud policy specification which is used to specify + constraints for configurations of Google Cloud resources. + type: object + id: GoogleCloudOrgpolicyV2PolicySpec properties: - spec: - $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpec' - description: Specify constraint for configurations of Google Cloud resources. - launch: + inheritFromParent: + description: >- + Determines the inheritance behavior for this policy. If + `inherit_from_parent` is true, policy rules set higher up in the + hierarchy (up to the closest root) are inherited and present in the + effective policy. If it is false, then no rules are inherited, and + this policy becomes the new root for evaluation. This field can be + set only for policies which configure list constraints. + type: boolean + reset: + type: boolean + description: >- + Ignores policies set above this resource and restores the + `constraint_default` enforcement behavior of the specific constraint + at this resource. This field can be set in policies for either list + or boolean constraints. If set, `rules` must be empty and + `inherit_from_parent` must be set to false. + etag: type: string description: >- - Reference to the launch that will be used while audit logging and to - control the launch. Should be set only in the alternate policy. + An opaque tag indicating the current version of the policySpec, used + for concurrency control. This field is ignored if used in a + `CreatePolicy` request. When the policy is returned from either a + `GetPolicy` or a `ListPolicies` request, this `etag` indicates the + version of the current policySpec to use when executing a + read-modify-write loop. When the policy is returned from a + `GetEffectivePolicy` request, the `etag` will be unset. + updateTime: + format: google-datetime + description: >- + Output only. The time stamp this was previously updated. This + represents the last time a call to `CreatePolicy` or `UpdatePolicy` + was made for that policy. + type: string + readOnly: true + rules: + description: >- + In policies for boolean constraints, the following requirements + apply: - There must be one and only one policy rule where condition + is unset. - Boolean policy rules with conditions must set `enforced` + to the opposite of the policy rule without a condition. - During + policy evaluation, policy rules with conditions that are true for a + target resource take precedence. + type: array + items: + $ref: '#/components/schemas/GoogleCloudOrgpolicyV2PolicySpecPolicyRule' + GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay: + description: The proposed changes to OrgPolicy. type: object - description: >- - Similar to PolicySpec but with an extra 'launch' field for launch - reference. The PolicySpec here is specific for dry-run/darklaunch. + id: GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlay + properties: + policies: + type: array + description: >- + Optional. The OrgPolicy changes to preview violations for. Any + existing OrgPolicies with the same name will be overridden in the + simulation. That is, violations will be determined as if all + policies in the overlay were created or updated. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayPolicyOverlay + customConstraints: + type: array + description: >- + Optional. The OrgPolicy CustomConstraint changes to preview + violations for. Any existing CustomConstraints with the same name + will be overridden in the simulation. That is, violations will be + determined as if all custom constraints in the overlay were + instantiated. Only a single custom_constraint is supported in the + overlay at a time. For evaluating multiple constraints, multiple + `GenerateOrgPolicyViolationsPreview` requests are made, where each + request evaluates a single constraint. + items: + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1alphaOrgPolicyOverlayCustomConstraintOverlay parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: upload_protocol + name: quotaUser schema: type: string fields: @@ -2130,10 +1854,10 @@ components: - json - media - proto - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token schema: type: string _.xgafv: @@ -2145,19 +1869,28 @@ components: enum: - '1' - '2' - oauth_token: - description: OAuth 2.0 token for the current user. + access_token: + description: OAuth access token. in: query - name: oauth_token + name: access_token schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType schema: type: string x-stackQL-resources: @@ -2173,17 +1906,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_replays_operations_list: - operation: &ref_1 + folders_locations_replays_operations_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - folders_locations_replays_operations_list: - operation: *ref_1 - response: *ref_2 folders_locations_replays_operations_get: operation: $ref: >- @@ -2191,24 +1921,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_replays_operations_list: - operation: &ref_3 + organizations_locations_replays_operations_get: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get - response: &ref_4 + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.operations organizations_locations_replays_operations_list: - operation: *ref_3 - response: *ref_4 - organizations_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations organizations_locations_org_policy_violations_previews_operations_get: operation: $ref: >- @@ -2216,28 +1943,25 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_operations_get: + projects_locations_org_policy_violations_previews_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_replays_operations_list: - operation: &ref_5 + projects_locations_replays_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_replays_operations_list: - operation: *ref_5 - response: *ref_6 - projects_locations_org_policy_violations_previews_operations_get: + projects_locations_replays_operations_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -2247,16 +1971,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _operations_list: - operation: &ref_7 + operations_list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - operations_list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: >- @@ -2267,10 +1988,10 @@ components: #/components/x-stackQL-resources/operations/methods/organizations_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_locations_org_policy_violations_previews_operations_get - - $ref: >- - #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_org_policy_violations_previews_operations_get + - $ref: >- + #/components/x-stackQL-resources/operations/methods/projects_locations_replays_operations_get - $ref: >- #/components/x-stackQL-resources/operations/methods/folders_locations_replays_operations_list - $ref: >- @@ -2282,45 +2003,37 @@ components: #/components/x-stackQL-resources/operations/methods/operations_list insert: [] update: [] + replace: [] delete: [] results: id: google.policysimulator.results name: results title: Results methods: - _folders_locations_replays_results_list: - operation: &ref_9 + folders_locations_replays_results_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - folders_locations_replays_results_list: - operation: *ref_9 - response: *ref_10 - _organizations_locations_replays_results_list: - operation: &ref_11 + organizations_locations_replays_results_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - organizations_locations_replays_results_list: - operation: *ref_11 - response: *ref_12 - _projects_locations_replays_results_list: - operation: &ref_13 + projects_locations_replays_results_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}~1results/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.replayResults - projects_locations_replays_results_list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: >- @@ -2331,6 +2044,7 @@ components: #/components/x-stackQL-resources/results/methods/projects_locations_replays_results_list insert: [] update: [] + replace: [] delete: [] replays: id: google.policysimulator.replays @@ -2351,31 +2065,31 @@ components: response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_create: + organizations_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_replays_get: + organizations_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_get: + projects_locations_replays_create: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_replays_create: + projects_locations_replays_get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1replays~1{replaysId}/get response: mediaType: application/json openAPIDocKey: '200' @@ -2395,297 +2109,29 @@ components: - $ref: >- #/components/x-stackQL-resources/replays/methods/projects_locations_replays_create update: [] - delete: [] - org_policy_violations_previews: - id: google.policysimulator.org_policy_violations_previews - name: org_policy_violations_previews - title: Org_policy_violations_previews - methods: - organizations_locations_org_policy_violations_previews_create: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews/post - response: - mediaType: application/json - openAPIDocKey: '200' - _organizations_locations_org_policy_violations_previews_list: - operation: &ref_15 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews/get - response: &ref_16 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.orgPolicyViolationsPreviews - organizations_locations_org_policy_violations_previews_list: - operation: *ref_15 - response: *ref_16 - organizations_locations_org_policy_violations_previews_get: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}/get - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/org_policy_violations_previews/methods/organizations_locations_org_policy_violations_previews_get - - $ref: >- - #/components/x-stackQL-resources/org_policy_violations_previews/methods/organizations_locations_org_policy_violations_previews_list - insert: - - $ref: >- - #/components/x-stackQL-resources/org_policy_violations_previews/methods/organizations_locations_org_policy_violations_previews_create - update: [] - delete: [] - org_policy_violations: - id: google.policysimulator.org_policy_violations - name: org_policy_violations - title: Org_policy_violations - methods: - _organizations_locations_org_policy_violations_previews_org_policy_violations_list: - operation: &ref_17 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1orgPolicyViolationsPreviews~1{orgPolicyViolationsPreviewsId}~1orgPolicyViolations/get - response: &ref_18 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.orgPolicyViolations - organizations_locations_org_policy_violations_previews_org_policy_violations_list: - operation: *ref_17 - response: *ref_18 - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/org_policy_violations/methods/organizations_locations_org_policy_violations_previews_org_policy_violations_list - insert: [] - update: [] + replace: [] delete: [] paths: /v1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: - parameters: &ref_19 - - $ref: '#/components/parameters/uploadType' + parameters: &ref_1 - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/quotaUser' - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: >- - policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: orgPolicyViolationsPreviewsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: - parameters: *ref_19 - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.folders.locations.replays.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: replaysId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: - parameters: *ref_19 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: policysimulator.folders.locations.replays.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: replaysId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: - parameters: *ref_19 - get: - description: Lists the results of running a Replay. - operationId: policysimulator.folders.locations.replays.results.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: replaysId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays: - parameters: *ref_19 - post: - description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.folders.locations.replays.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: foldersId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: - parameters: *ref_19 - get: - description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.folders.locations.replays.get + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + get: + description: >- + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2697,7 +2143,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: foldersId @@ -2710,15 +2156,22 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: - parameters: *ref_19 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations: + parameters: *ref_1 get: - description: Lists the results of running a Replay. - operationId: policysimulator.organizations.locations.replays.results.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.folders.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2730,11 +2183,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -2753,17 +2205,22 @@ paths: schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: - parameters: *ref_19 + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.organizations.locations.replays.operations.list + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: policysimulator.folders.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2775,10 +2232,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -2792,27 +2249,16 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: - parameters: *ref_19 + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/results: + parameters: *ref_1 get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: policysimulator.organizations.locations.replays.operations.get + description: Lists the results of running a Replay. + operationId: policysimulator.folders.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2824,10 +2270,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -2841,16 +2288,20 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/replays: - parameters: *ref_19 + /v1/folders/{foldersId}/locations/{locationsId}/replays: + parameters: *ref_1 post: description: Creates and starts a Replay using the given ReplayConfig. - operationId: policysimulator.organizations.locations.replays.create + operationId: policysimulator.folders.locations.replays.create requestBody: content: application/json: @@ -2870,7 +2321,37 @@ paths: $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path - name: organizationsId + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}: + parameters: *ref_1 + get: + description: >- + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.folders.locations.replays.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + parameters: + - in: path + name: foldersId required: true schema: type: string @@ -2879,8 +2360,13 @@ paths: required: true schema: type: string + - in: path + name: replaysId + required: true + schema: + type: string /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the specified Replay. Each `Replay` is available for at least 7 @@ -2914,23 +2400,16 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews: - parameters: *ref_19 + /v1/organizations/{organizationsId}/locations/{locationsId}/replays: + parameters: *ref_1 post: - description: >- - CreateOrgPolicyViolationsPreview creates an OrgPolicyViolationsPreview - for the proposed changes in the provided - OrgPolicyViolationsPreview.OrgPolicyOverlay. The changes to OrgPolicy - are specified by this `OrgPolicyOverlay`. The resources to scan are - inferred from these specified changes. - operationId: >- - policysimulator.organizations.locations.orgPolicyViolationsPreviews.create + description: Creates and starts a Replay using the given ReplayConfig. + operationId: policysimulator.organizations.locations.replays.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2954,16 +2433,11 @@ paths: required: true schema: type: string - - in: query - name: orgPolicyViolationsPreviewId - schema: - type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/results: + parameters: *ref_1 get: - description: >- - ListOrgPolicyViolationsPreviews lists each OrgPolicyViolationsPreview in - an organization. Each OrgPolicyViolationsPreview is available for at - least 7 days. - operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.list + description: Lists the results of running a Replay. + operationId: policysimulator.organizations.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2976,7 +2450,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsPreviewsResponse + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path name: organizationsId @@ -2988,6 +2462,11 @@ paths: required: true schema: type: string + - in: path + name: replaysId + required: true + schema: + type: string - in: query name: pageSize schema: @@ -2997,14 +2476,14 @@ paths: name: pageToken schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}: - parameters: *ref_19 + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- - GetOrgPolicyViolationsPreview gets the specified - OrgPolicyViolationsPreview. Each OrgPolicyViolationsPreview is available - for at least 7 days. - operationId: policysimulator.organizations.locations.orgPolicyViolationsPreviews.get + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: policysimulator.organizations.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3016,8 +2495,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1OrgPolicyViolationsPreview + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: organizationsId @@ -3030,18 +2508,22 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/orgPolicyViolations: - parameters: *ref_19 + - in: path + name: operationsId + required: true + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations: + parameters: *ref_1 get: description: >- - ListOrgPolicyViolations lists the OrgPolicyViolations that are present - in an OrgPolicyViolationsPreview. - operationId: >- - policysimulator.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.list + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.organizations.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3053,8 +2535,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListOrgPolicyViolationsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: organizationsId @@ -3067,7 +2548,7 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string @@ -3075,13 +2556,17 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 /v1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3122,13 +2607,15 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: - parameters: *ref_19 + /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- - Gets the specified Replay. Each `Replay` is available for at least 7 - days. - operationId: policysimulator.projects.locations.replays.get + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: >- + policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3140,7 +2627,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId @@ -3153,12 +2640,17 @@ paths: schema: type: string - in: path - name: replaysId + name: orgPolicyViolationsPreviewsId + required: true + schema: + type: string + - in: path + name: operationsId required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/replays: - parameters: *ref_19 + parameters: *ref_1 post: description: Creates and starts a Replay using the given ReplayConfig. operationId: policysimulator.projects.locations.replays.create @@ -3190,14 +2682,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: - parameters: *ref_19 + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}: + parameters: *ref_1 get: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: policysimulator.projects.locations.replays.operations.get + Gets the specified Replay. Each `Replay` is available for at least 7 + days. + operationId: policysimulator.projects.locations.replays.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3209,7 +2700,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' + $ref: '#/components/schemas/GoogleCloudPolicysimulatorV1Replay' parameters: - in: path name: projectsId @@ -3226,18 +2717,11 @@ paths: required: true schema: type: string - - in: path - name: operationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: - parameters: *ref_19 + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: + parameters: *ref_1 get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: policysimulator.projects.locations.replays.operations.list + description: Lists the results of running a Replay. + operationId: policysimulator.projects.locations.replays.results.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3249,7 +2733,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: >- + #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse parameters: - in: path name: projectsId @@ -3267,23 +2752,21 @@ paths: schema: type: string - in: query - name: filter + name: pageSize schema: - type: string + type: integer + format: int32 - in: query name: pageToken schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/results: - parameters: *ref_19 + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations: + parameters: *ref_1 get: - description: Lists the results of running a Replay. - operationId: policysimulator.projects.locations.replays.results.list + description: >- + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: policysimulator.projects.locations.replays.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3295,8 +2778,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudPolicysimulatorV1ListReplayResultsResponse + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - in: path name: projectsId @@ -3322,15 +2804,18 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}: - parameters: *ref_19 + - in: query + name: filter + schema: + type: string + /v1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}: + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - operationId: >- - policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get + operationId: policysimulator.projects.locations.replays.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3355,7 +2840,7 @@ paths: schema: type: string - in: path - name: orgPolicyViolationsPreviewsId + name: replaysId required: true schema: type: string @@ -3365,7 +2850,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3391,7 +2876,7 @@ paths: schema: type: string /v1/operations: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3410,10 +2895,6 @@ paths: schema: $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: @@ -3423,3 +2904,7 @@ paths: name: filter schema: type: string + - in: query + name: pageToken + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml index 5a186792..799b29ea 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/policytroubleshooter.yaml @@ -7,8 +7,8 @@ info: title: Policy Troubleshooter API description: '' version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/iam/ servers: @@ -34,163 +34,166 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: + GoogleIamV1Policy: + description: >- + An Identity and Access Management (IAM) policy, which specifies access + controls for Google Cloud resources. A `Policy` is a collection of + `bindings`. A `binding` binds one or more `members`, or principals, to a + single `role`. Principals can be user accounts, service accounts, Google + groups, and domains (such as G Suite). A `role` is a named list of + permissions; each `role` can be an IAM predefined role or a user-created + custom role. For some types of Google Cloud resources, a `binding` can + also specify a `condition`, which is a logical expression that allows + access to a resource only if the expression evaluates to `true`. A + condition can add constraints based on attributes of the request, the + resource, or both. To learn which resources support conditions in their + IAM policies, see the [IAM + documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + **JSON example:** ``` { "bindings": [ { "role": + "roles/resourcemanager.organizationAdmin", "members": [ + "user:mike@example.com", "group:admins@example.com", + "domain:google.com", + "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { + "role": "roles/resourcemanager.organizationViewer", "members": [ + "user:eve@example.com" ], "condition": { "title": "expirable access", + "description": "Does not grant access after Sep 2020", "expression": + "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": + "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - + members: - user:mike@example.com - group:admins@example.com - + domain:google.com - + serviceAccount:my-project-id@appspot.gserviceaccount.com role: + roles/resourcemanager.organizationAdmin - members: - + user:eve@example.com role: roles/resourcemanager.organizationViewer + condition: title: expirable access description: Does not grant access + after Sep 2020 expression: request.time < + timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` + For a description of IAM and its features, see the [IAM + documentation](https://cloud.google.com/iam/docs/). + id: GoogleIamV1Policy type: object - description: Details about whether the binding includes the principal. properties: - relevance: - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH - type: string + etag: + format: byte description: >- - The relevance of the principal's status to the overall determination - for the binding. - membership: - enum: - - MEMBERSHIP_UNSPECIFIED - - MEMBERSHIP_INCLUDED - - MEMBERSHIP_NOT_INCLUDED - - MEMBERSHIP_UNKNOWN_INFO_DENIED - - MEMBERSHIP_UNKNOWN_UNSUPPORTED + `etag` is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the `etag` + in the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An `etag` is returned in the response to + `getIamPolicy`, and systems are expected to put that etag in the + request to `setIamPolicy` to ensure that their change will be + applied to the same version of the policy. **Important:** If you use + IAM Conditions, you must include the `etag` field whenever you call + `setIamPolicy`. If you omit this field, then IAM allows you to + overwrite a version `3` policy with a version `1` policy, and all of + the conditions in the version `3` policy are lost. type: string - description: Indicates whether the binding includes the principal. - enumDescriptions: - - Default value. This value is unused. - - >- - The binding includes the principal. The principal can be included - directly or indirectly. For example: * A principal is included - directly if that principal is listed in the binding. * A principal - is included indirectly if that principal is in a Google group or - Google Workspace domain that is listed in the binding. - - The binding does not include the principal. - - The sender of the request is not allowed to access the binding. - - >- - The principal is an unsupported type. Only Google Accounts and - service accounts are supported. - id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership - GoogleIamV1Binding: - id: GoogleIamV1Binding - description: Associates `members`, or principals, with a `role`. - properties: - members: - type: array - items: - type: string + bindings: description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - condition: + Associates a list of `members`, or principals, with a `role`. + Optionally, may specify a `condition` that determines how and when + the `bindings` are applied. Each of the `bindings` must contain at + least one principal. The `bindings` in a `Policy` can refer to up to + 1,500 principals; up to 250 of these principals can be Google + groups. Each occurrence of a principal counts towards these limits. + For example, if the `bindings` grant 50 different roles to + `user:alice@example.com`, and not to any other principal, then you + can add another 1,450 principals to the `bindings` in the `Policy`. + items: + $ref: '#/components/schemas/GoogleIamV1Binding' + type: array + version: description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM + Specifies the format of the policy. Valid values are `0`, `1`, and + `3`. Requests that specify an invalid value are rejected. Any + operation that affects conditional role bindings must specify + version `3`. This requirement applies to the following operations: * + Getting a policy that includes a conditional role binding * Adding a + conditional role binding to a policy * Changing a conditional role + binding in a policy * Removing any role binding, with or without a + condition, from a policy that includes conditions **Important:** If + you use IAM Conditions, you must include the `etag` field whenever + you call `setIamPolicy`. If you omit this field, then IAM allows you + to overwrite a version `3` policy with a version `1` policy, and all + of the conditions in the version `3` policy are lost. If a policy + does not include any conditions, operations on that policy may + specify any valid version or leave the field unset. To learn which + resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/GoogleTypeExpr' - role: - type: string - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: object + format: int32 + type: integer + auditConfigs: + items: + $ref: '#/components/schemas/GoogleIamV1AuditConfig' + type: array + description: Specifies cloud audit logging configuration for this policy. GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest: type: object id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest - description: Request for TroubleshootIamPolicy. properties: accessTuple: description: >- The information to use for checking whether a principal has a permission for a resource. $ref: '#/components/schemas/GoogleCloudPolicytroubleshooterV1AccessTuple' + description: Request for TroubleshootIamPolicy. + GoogleTypeExpr: + 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. + properties: + expression: + description: >- + Textual representation of an expression in Common Expression + Language syntax. + type: string + title: + description: >- + Optional. Title for the expression, i.e. a short string describing + its purpose. This can be used e.g. in UIs which allow to enter the + expression. + type: string + description: + type: string + description: >- + Optional. Description of the expression. This is a longer text which + describes the expression, e.g. when hovered over it in a UI. + location: + type: string + description: >- + Optional. String indicating the location of the expression for error + reporting, e.g. a file name and a position in the file. + id: GoogleTypeExpr + type: object GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse: + type: object id: GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyResponse + description: Response for TroubleshootIamPolicy. properties: + errors: + type: array + description: The general errors contained in the troubleshooting response. + items: + $ref: '#/components/schemas/GoogleRpcStatus' access: - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED description: >- Indicates whether the principal has the specified permission for the specified resource, based on evaluating all of the applicable IAM policies. - type: string enumDescriptions: - Default value. This value is unused. - The principal has the permission. @@ -201,11 +204,13 @@ components: - >- The sender of the request does not have access to all of the policies that Policy Troubleshooter needs to evaluate. - errors: - description: The general errors contained in the troubleshooting response. - type: array - items: - $ref: '#/components/schemas/GoogleRpcStatus' + type: string + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED explainedPolicies: description: >- List of IAM policies that were evaluated to check the principal's @@ -220,48 +225,50 @@ components: $ref: >- #/components/schemas/GoogleCloudPolicytroubleshooterV1ExplainedPolicy type: array - description: Response for TroubleshootIamPolicy. + GoogleRpcStatus: type: object - GoogleIamV1AuditConfig: - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - id: GoogleIamV1AuditConfig properties: - service: - type: string - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array + details: items: - $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' - type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus GoogleCloudPolicytroubleshooterV1AccessTuple: - description: Information about the principal, resource, and permission to check. type: object - id: GoogleCloudPolicytroubleshooterV1AccessTuple properties: - principal: + fullResourceName: + description: >- + Required. The full resource name that identifies the resource. For + example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + For examples of full resource names for Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. type: string + principal: description: >- Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, @@ -269,14 +276,7 @@ components: `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported. - fullResourceName: type: string - description: >- - Required. The full resource name that identifies the resource. For - example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - For examples of full resource names for Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. permission: type: string description: >- @@ -285,53 +285,161 @@ components: https://cloud.google.com/iam/help/permissions/reference. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference. - GoogleTypeExpr: + id: GoogleCloudPolicytroubleshooterV1AccessTuple + description: Information about the principal, resource, and permission to check. + GoogleIamV1AuditLogConfig: + type: object properties: - description: + exemptedMembers: description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - location: + Specifies the identities that do not cause logging for this type of + permission. Follows the same format of Binding.members. + type: array + items: + type: string + logType: + enumDescriptions: + - Default case. Should never be this. + - 'Admin reads. Example: CloudIAM getIamPolicy' + - 'Data writes. Example: CloudSQL Users create' + - 'Data reads. Example: CloudSQL Users list' type: string - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. + description: The log type that this config enables. + enum: + - LOG_TYPE_UNSPECIFIED + - ADMIN_READ + - DATA_WRITE + - DATA_READ + description: >- + Provides the configuration for logging a type of permissions. Example: { + "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ + "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This + enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + jose@example.com from DATA_READ logging. + id: GoogleIamV1AuditLogConfig + GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership: + id: GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership + properties: + membership: + description: Indicates whether the binding includes the principal. + enumDescriptions: + - Default value. This value is unused. + - >- + The binding includes the principal. The principal can be included + directly or indirectly. For example: * A principal is included + directly if that principal is listed in the binding. * A principal + is included indirectly if that principal is in a Google group or + Google Workspace domain that is listed in the binding. + - The binding does not include the principal. + - The sender of the request is not allowed to access the binding. + - >- + The principal is an unsupported type. Only Google Accounts and + service accounts are supported. + enum: + - MEMBERSHIP_UNSPECIFIED + - MEMBERSHIP_INCLUDED + - MEMBERSHIP_NOT_INCLUDED + - MEMBERSHIP_UNKNOWN_INFO_DENIED + - MEMBERSHIP_UNKNOWN_UNSUPPORTED type: string - title: + relevance: + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. + The relevance of the principal's status to the overall determination + for the binding. type: string - id: GoogleTypeExpr + description: Details about whether the binding includes the principal. type: object + GoogleIamV1AuditConfig: + properties: + auditLogConfigs: + description: The configuration for logging of each type of permission. + type: array + items: + $ref: '#/components/schemas/GoogleIamV1AuditLogConfig' + service: + type: string + description: >- + Specifies a service that will be enabled for audit logging. For + example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + `allServices` is a special value that covers all services. + id: GoogleIamV1AuditConfig 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. + Specifies the audit configuration for a service. The configuration + determines which permission types are logged, and what identities, if + any, are exempted from logging. An AuditConfig must have one or more + AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + specific service, the union of the two AuditConfigs is used for that + service: the log_types specified in each AuditConfig are enabled, and + the exempted_members in each AuditLogConfig are exempted. Example Policy + with multiple AuditConfigs: { "audit_configs": [ { "service": + "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", + "exempted_members": [ "user:jose@example.com" ] }, { "log_type": + "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": + "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": + "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ + "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy + enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts + `jose@example.com` from DATA_READ logging, and `aliya@example.com` from + DATA_WRITE logging. + type: object GoogleCloudPolicytroubleshooterV1BindingExplanation: id: GoogleCloudPolicytroubleshooterV1BindingExplanation + type: object properties: + rolePermissionRelevance: + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + type: string + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + description: >- + The relevance of the permission's existence, or nonexistence, in the + role to the overall determination for the entire policy. + relevance: + enum: + - HEURISTIC_RELEVANCE_UNSPECIFIED + - NORMAL + - HIGH + enumDescriptions: + - Default value. This value is unused. + - >- + The data point has a limited effect on the result. Changing the + data point is unlikely to affect the overall determination. + - >- + The data point has a strong effect on the result. Changing the + data point is likely to affect the overall determination. + type: string + description: >- + The relevance of this binding to the overall determination for the + entire policy. + condition: + $ref: '#/components/schemas/GoogleTypeExpr' + description: >- + A condition expression that prevents this binding from granting + access unless the expression evaluates to `true`. To learn about IAM + Conditions, see + https://cloud.google.com/iam/help/conditions/overview. memberships: - type: object description: >- Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. @@ -347,16 +455,19 @@ components: second principal in the binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`. + type: object additionalProperties: $ref: >- #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanationAnnotatedMembership + role: + description: >- + The role that this binding grants. For example, + `roles/compute.serviceAgent`. For a complete list of predefined IAM + roles, as well as the permissions in each role, see + https://cloud.google.com/iam/help/roles/reference. + type: string rolePermission: type: string - enum: - - ROLE_PERMISSION_UNSPECIFIED - - ROLE_PERMISSION_INCLUDED - - ROLE_PERMISSION_NOT_INCLUDED - - ROLE_PERMISSION_UNKNOWN_INFO_DENIED description: >- Indicates whether the role granted by this binding contains the specified permission. @@ -365,31 +476,22 @@ components: - The permission is included in the role. - The permission is not included in the role. - The sender of the request is not allowed to access the binding. - relevance: enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH + - ROLE_PERMISSION_UNSPECIFIED + - ROLE_PERMISSION_INCLUDED + - ROLE_PERMISSION_NOT_INCLUDED + - ROLE_PERMISSION_UNKNOWN_INFO_DENIED + access: enumDescriptions: - Default value. This value is unused. + - The principal has the permission. + - The principal does not have the permission. - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. + The principal has the permission only if a condition expression + evaluates to `true`. - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - description: >- - The relevance of this binding to the overall determination for the - entire policy. - type: string - role: - description: >- - The role that this binding grants. For example, - `roles/compute.serviceAgent`. For a complete list of predefined IAM - roles, as well as the permissions in each role, see - https://cloud.google.com/iam/help/roles/reference. - type: string - access: + The sender of the request does not have access to all of the + policies that Policy Troubleshooter needs to evaluate. description: >- Required. Indicates whether _this binding_ provides the specified permission to the specified principal for the specified resource. @@ -399,130 +501,47 @@ components: has the permission, use the `access` field in the TroubleshootIamPolicyResponse. type: string - enumDescriptions: - - Default value. This value is unused. - - The principal has the permission. - - The principal does not have the permission. - - >- - The principal has the permission only if a condition expression - evaluates to `true`. - - >- - The sender of the request does not have access to all of the - policies that Policy Troubleshooter needs to evaluate. enum: - ACCESS_STATE_UNSPECIFIED - GRANTED - NOT_GRANTED - UNKNOWN_CONDITIONAL - UNKNOWN_INFO_DENIED - condition: - description: >- - A condition expression that prevents this binding from granting - access unless the expression evaluates to `true`. To learn about IAM - Conditions, see - https://cloud.google.com/iam/help/conditions/overview. - $ref: '#/components/schemas/GoogleTypeExpr' - rolePermissionRelevance: - description: >- - The relevance of the permission's existence, or nonexistence, in the - role to the overall determination for the entire policy. - enumDescriptions: - - Default value. This value is unused. - - >- - The data point has a limited effect on the result. Changing the - data point is unlikely to affect the overall determination. - - >- - The data point has a strong effect on the result. Changing the - data point is likely to affect the overall determination. - type: string - enum: - - HEURISTIC_RELEVANCE_UNSPECIFIED - - NORMAL - - HIGH description: >- Details about how a binding in a policy affects a principal's ability to use a permission. - type: object - GoogleRpcStatus: - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object + GoogleCloudPolicytroubleshooterV1ExplainedPolicy: + id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy properties: - details: + bindingExplanations: type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - GoogleIamV1AuditLogConfig: - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - properties: - exemptedMembers: + $ref: >- + #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - logType: - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - type: string - description: The log type that this config enables. - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - type: object - id: GoogleIamV1AuditLogConfig - GoogleCloudPolicytroubleshooterV1ExplainedPolicy: - properties: + Details about how each binding in the policy affects the principal's + ability, or inability, to use the permission for the resource. If + the sender of the request does not have access to the policy, this + field is omitted. policy: - $ref: '#/components/schemas/GoogleIamV1Policy' description: >- The IAM policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty. - bindingExplanations: + $ref: '#/components/schemas/GoogleIamV1Policy' + fullResourceName: description: >- - Details about how each binding in the policy affects the principal's - ability, or inability, to use the permission for the resource. If - the sender of the request does not have access to the policy, this - field is omitted. - items: - $ref: >- - #/components/schemas/GoogleCloudPolicytroubleshooterV1BindingExplanation - type: array + The full resource name that identifies the resource. For example, + `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + If the sender of the request does not have access to the policy, + this field is omitted. For examples of full resource names for + Google Cloud services, see + https://cloud.google.com/iam/help/troubleshooter/full-resource-names. + type: string relevance: + description: >- + The relevance of this policy to the overall determination in the + TroubleshootIamPolicyResponse. If the sender of the request does not + have access to the policy, this field is omitted. enum: - HEURISTIC_RELEVANCE_UNSPECIFIED - NORMAL @@ -536,11 +555,14 @@ components: - >- The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination. - description: >- - The relevance of this policy to the overall determination in the - TroubleshootIamPolicyResponse. If the sender of the request does not - have access to the policy, this field is omitted. access: + enum: + - ACCESS_STATE_UNSPECIFIED + - GRANTED + - NOT_GRANTED + - UNKNOWN_CONDITIONAL + - UNKNOWN_INFO_DENIED + type: string enumDescriptions: - Default value. This value is unused. - The principal has the permission. @@ -551,127 +573,111 @@ components: - >- The sender of the request does not have access to all of the policies that Policy Troubleshooter needs to evaluate. - type: string - enum: - - ACCESS_STATE_UNSPECIFIED - - GRANTED - - NOT_GRANTED - - UNKNOWN_CONDITIONAL - - UNKNOWN_INFO_DENIED description: >- Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for - the resource. There might be another policy that overrides this - policy. To determine whether the principal actually has the - permission, use the `access` field in the - TroubleshootIamPolicyResponse. - fullResourceName: - description: >- - The full resource name that identifies the resource. For example, - `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. - If the sender of the request does not have access to the policy, - this field is omitted. For examples of full resource names for - Google Cloud services, see - https://cloud.google.com/iam/help/troubleshooter/full-resource-names. - type: string + the resource. There might be another policy that overrides this + policy. To determine whether the principal actually has the + permission, use the `access` field in the + TroubleshootIamPolicyResponse. description: Details about how a specific IAM Policy contributed to the access check. type: object - id: GoogleCloudPolicytroubleshooterV1ExplainedPolicy - GoogleIamV1Policy: - id: GoogleIamV1Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). + GoogleIamV1Binding: + description: Associates `members`, or principals, with a `role`. + type: object + id: GoogleIamV1Binding properties: - bindings: - items: - $ref: '#/components/schemas/GoogleIamV1Binding' + role: + type: string description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - version: - type: integer - format: int32 + Role that is assigned to the list of `members`, or principals. For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an + overview of the IAM roles and permissions, see the [IAM + documentation](https://cloud.google.com/iam/docs/roles-overview). + For a list of the available pre-defined roles, see + [here](https://cloud.google.com/iam/docs/understanding-roles). + condition: description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM + The condition that is associated with this binding. If the condition + evaluates to `true`, then this binding applies to the current + request. If the condition evaluates to `false`, then this binding + does not apply to the current request. However, a different role + binding might grant the same role to one or more of the principals + in this binding. To learn which resources support conditions in + their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - auditConfigs: - items: - $ref: '#/components/schemas/GoogleIamV1AuditConfig' - description: Specifies cloud audit logging configuration for this policy. - type: array - etag: + $ref: '#/components/schemas/GoogleTypeExpr' + members: description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - type: string - format: byte - type: object + Specifies the principals requesting access for a Google Cloud + resource. `members` can have the following values: * `allUsers`: A + special identifier that represents anyone who is on the internet; + with or without a Google account. * `allAuthenticatedUsers`: A + special identifier that represents anyone who is authenticated with + a Google account or a service account. Does not include identities + that come from external identity providers (IdPs) through identity + federation. * `user:{emailid}`: An email address that represents a + specific Google account. For example, `alice@example.com` . * + `serviceAccount:{emailid}`: An email address that represents a + Google service account. For example, + `my-other-app@appspot.gserviceaccount.com`. * + `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: + An identifier for a [Kubernetes service + account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). + For example, + `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * + `group:{emailid}`: An email address that represents a Google group. + For example, `admins@example.com`. * `domain:{domain}`: The G Suite + domain (primary) that represents all the users of that domain. For + example, `google.com` or `example.com`. * + `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workforce identity pool. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: + All workforce identities in a group. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All workforce identities with a specific attribute value. * + `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: + All identities in a workforce identity pool. * + `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: + A single identity in a workload identity pool. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: + A workload identity pool group. * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: + All identities in a workload identity pool with a certain attribute. + * + `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: + All identities in a workload identity pool. * + `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus + unique identifier) representing a user that has been recently + deleted. For example, `alice@example.com?uid=123456789012345678901`. + If the user is recovered, this value reverts to `user:{emailid}` and + the recovered user retains the role in the binding. * + `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address + (plus unique identifier) representing a service account that has + been recently deleted. For example, + `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + If the service account is undeleted, this value reverts to + `serviceAccount:{emailid}` and the undeleted service account retains + the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: + An email address (plus unique identifier) representing a Google + group that has been recently deleted. For example, + `admins@example.com?uid=123456789012345678901`. If the group is + recovered, this value reverts to `group:{emailid}` and the recovered + group retains the role in the binding. * + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: + Deleted single identity in a workforce identity pool. For example, + `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + type: array + items: + type: string parameters: + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean _.xgafv: description: V1 error format. in: query @@ -681,10 +687,13 @@ components: enum: - '1' - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. in: query - name: upload_protocol + name: key schema: type: string oauth_token: @@ -693,18 +702,33 @@ components: name: oauth_token schema: type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string callback: description: JSONP in: query name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: prettyPrint + name: upload_protocol schema: - type: boolean + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string alt: description: Data format for response. in: query @@ -715,40 +739,16 @@ components: - json - media - proto - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string x-stackQL-resources: @@ -767,21 +767,22 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/iam:troubleshoot: parameters: + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/fields' post: description: >- Checks whether a principal has a specific permission for a specific diff --git a/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml new file mode 100644 index 00000000..194d22ab --- /dev/null +++ b/providers/src/googleapis.com/v00.00.00000/services/pollen.yaml @@ -0,0 +1,653 @@ +openapi: 3.1.0 +info: + contact: + name: StackQL Studios + url: https://github.com/stackql/google-discovery-to-openapi + email: info@stackql.io + title: Pollen API + description: 'The Pollen API. ' + version: v1 + x-discovery-doc-revision: '20240909' + x-generated-date: '2024-09-13' +externalDocs: + url: https://developers.google.com/maps/documentation/pollen +servers: + - url: https://pollen.googleapis.com +components: + securitySchemes: + Oauth2: + type: oauth2 + description: Oauth 2.0 implicit authentication + flows: + implicit: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + scopes: &ref_0 + https://www.googleapis.com/auth/cloud-platform: >- + See, edit, configure, and delete your Google Cloud data and see + the email address for your Google Account. + Oauth2c: + type: oauth2 + description: Oauth 2.0 authorization code authentication + flows: + authorizationCode: + authorizationUrl: https://accounts.google.com/o/oauth2/auth + tokenUrl: https://accounts.google.com/o/oauth2/token + scopes: *ref_0 + schemas: + LookupForecastResponse: + properties: + nextPageToken: + type: string + description: Optional. The token to retrieve the next page. + regionCode: + type: string + description: >- + The ISO_3166-1 alpha-2 code of the country/region corresponding to + the location provided in the request. This field might be omitted + from the response if the location provided in the request resides in + a disputed territory. + dailyInfo: + type: array + items: + $ref: '#/components/schemas/DayInfo' + description: >- + Required. This object contains the daily forecast information for + each day requested. + id: LookupForecastResponse + type: object + HttpBody: + description: >- + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + type: object + id: HttpBody + properties: + data: + type: string + description: The HTTP request/response body as raw binary. + format: byte + contentType: + description: >- + The HTTP Content-Type header value specifying the content type of + the body. + type: string + extensions: + type: array + description: >- + Application specific response metadata. Must be set in the first + response for streaming APIs. + items: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + Color: + id: Color + properties: + blue: + description: The amount of blue in the color as a value in the interval [0, 1]. + type: number + format: float + alpha: + description: >- + The fraction of this color that should be applied to the pixel. That + is, the final pixel color is defined by the equation: `pixel color = + alpha * (this color) + (1.0 - alpha) * (background color)` This + means that a value of 1.0 corresponds to a solid color, whereas a + value of 0.0 corresponds to a completely transparent color. This + uses a wrapper message rather than a simple float scalar so that it + is possible to distinguish between a default value and the value + being unset. If omitted, this color object is rendered as a solid + color (as if the alpha value had been explicitly given a value of + 1.0). + type: number + format: float + red: + format: float + description: The amount of red in the color as a value in the interval [0, 1]. + type: number + green: + type: number + format: float + description: The amount of green in the color as a value in the interval [0, 1]. + description: >- + Represents a color in the RGBA color space. This representation is + designed for simplicity of conversion to and from color representations + in various languages over compactness. For example, the fields of this + representation can be trivially provided to the constructor of + `java.awt.Color` in Java; it can also be trivially provided to UIColor's + `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little + work, it can be easily formatted into a CSS `rgba()` string in + JavaScript. This reference page doesn't have information about the + absolute color space that should be used to interpret the RGB value—for + example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications + should assume the sRGB color space. When color equality needs to be + decided, implementations, unless documented otherwise, treat two colors + as equal if all their red, green, blue, and alpha values each differ by + at most `1e-5`. Example (Java): import com.google.type.Color; // ... + public static java.awt.Color fromProto(Color protocolor) { float alpha = + protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return + new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), + protocolor.getBlue(), alpha); } public static Color + toProto(java.awt.Color color) { float red = (float) color.getRed(); + float green = (float) color.getGreen(); float blue = (float) + color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + = Color .newBuilder() .setRed(red / denominator) .setGreen(green / + denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); + if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() + .setValue(((float) alpha) / denominator) .build()); } return + resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static + UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; + float green = [protocolor green]; float blue = [protocolor blue]; + FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if + (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return + [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static + Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if + (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return + nil; } Color* result = [[Color alloc] init]; [result setRed:red]; + [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { + [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; + return result; } // ... Example (JavaScript): // ... var protoToCssColor + = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var + greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || + 0.0; var red = Math.floor(redFrac * 255); var green = + Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if + (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } + var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, + green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, + ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var + rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString + = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var + resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { + resultBuilder.push('0'); } resultBuilder.push(hexString); return + resultBuilder.join(''); }; // ... + type: object + PlantDescription: + type: object + properties: + type: + type: string + description: >- + The plant's pollen type. For example: "GRASS". A list of all + available codes could be found here. + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. + specialColors: + description: >- + Textual description of the plants' colors of leaves, bark, flowers + or seeds that helps identify the plant. + type: string + specialShapes: + type: string + description: >- + Textual description of the plants' shapes of leaves, bark, flowers + or seeds that helps identify the plant. + family: + type: string + description: >- + A human readable representation of the plant family name. Example: + "Betulaceae (the Birch family)". + crossReaction: + description: >- + Textual description of pollen cross reaction plants. Example: Alder, + Hazel, Hornbeam, Beech, Willow, and Oak pollen. + type: string + season: + type: string + description: >- + Textual list of explanations of seasons where the pollen is active. + Example: "Late winter, spring". + picture: + type: string + description: Link to the picture of the plant. + pictureCloseup: + type: string + description: Link to a closeup picture of the plant. + description: >- + Contains general information about plants, including details on their + seasonality, special shapes and colors, information about allergic + cross-reactions, and plant photos. + id: PlantDescription + Date: + properties: + year: + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without a year. + format: int32 + type: integer + day: + type: integer + format: int32 + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 to specify a year by itself or a year and month where + the day isn't significant. + month: + type: integer + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. + format: int32 + id: Date + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp + type: object + DayInfo: + properties: + pollenTypeInfo: + type: array + description: >- + This list will include up to three pollen types (GRASS, WEED, TREE) + affecting the location specified in the request. + items: + $ref: '#/components/schemas/PollenTypeInfo' + date: + $ref: '#/components/schemas/Date' + description: The date in UTC at which the pollen forecast data is represented. + plantInfo: + items: + $ref: '#/components/schemas/PlantInfo' + description: >- + This list will include up to 15 pollen species affecting the + location specified in the request. + type: array + id: DayInfo + description: >- + This object contains the daily forecast information for each day + requested. + type: object + PlantInfo: + description: This object contains the daily information on specific plant. + properties: + indexInfo: + $ref: '#/components/schemas/IndexInfo' + description: >- + This object contains data representing specific pollen index value, + category and description. + plantDescription: + description: >- + Contains general information about plants, including details on + their seasonality, special shapes and colors, information about + allergic cross-reactions, and plant photos. + $ref: '#/components/schemas/PlantDescription' + code: + enumDescriptions: + - Unspecified plant code. + - Alder is classified as a tree pollen type. + - Ash is classified as a tree pollen type. + - Birch is classified as a tree pollen type. + - Cottonwood is classified as a tree pollen type. + - Elm is classified as a tree pollen type. + - Maple is classified as a tree pollen type. + - Olive is classified as a tree pollen type. + - Juniper is classified as a tree pollen type. + - Oak is classified as a tree pollen type. + - Pine is classified as a tree pollen type. + - Cypress pine is classified as a tree pollen type. + - Hazel is classified as a tree pollen type. + - Graminales is classified as a grass pollen type. + - Ragweed is classified as a weed pollen type. + - Mugwort is classified as a weed pollen type. + - Japanese cedar is classified as a tree pollen type. + - Japanese cypress is classified as a tree pollen type. + type: string + enum: + - PLANT_UNSPECIFIED + - ALDER + - ASH + - BIRCH + - COTTONWOOD + - ELM + - MAPLE + - OLIVE + - JUNIPER + - OAK + - PINE + - CYPRESS_PINE + - HAZEL + - GRAMINALES + - RAGWEED + - MUGWORT + - JAPANESE_CEDAR + - JAPANESE_CYPRESS + description: >- + The plant code name. For example: "COTTONWOOD". A list of all + available codes could be found here. + displayName: + type: string + description: >- + A human readable representation of the plant name. Example: + “Cottonwood". + inSeason: + description: Indication of either the plant is in season or not. + type: boolean + type: object + id: PlantInfo + IndexInfo: + id: IndexInfo + description: >- + This object contains data representing specific pollen index value, + category and description. + properties: + color: + $ref: '#/components/schemas/Color' + description: The color used to represent the Pollen Index numeric score. + value: + format: int32 + description: The index's numeric score. Numeric range is between 0 and 5. + type: integer + indexDescription: + type: string + description: Textual explanation of current index level. + category: + type: string + description: >- + Text classification of index numerical score interpretation. The + index consists of six categories: * 0: "None" * 1: "Very low" * 2: + "Low" * 3: "Moderate" * 4: "High" * 5: "Very high + code: + enumDescriptions: + - Unspecified index. + - Universal Pollen Index. + type: string + description: >- + The index's code. This field represents the index for programming + purposes by using snake cases instead of spaces. Example: "UPI". + enum: + - INDEX_UNSPECIFIED + - UPI + displayName: + type: string + description: >- + A human readable representation of the index name. Example: + "Universal Pollen Index". + type: object + PollenTypeInfo: + id: PollenTypeInfo + properties: + healthRecommendations: + type: array + description: >- + Textual list of explanations, related to health insights based on + the current pollen levels. + items: + type: string + inSeason: + type: boolean + description: Indication whether the plant is in season or not. + code: + description: 'The pollen type''s code name. For example: "GRASS"' + enum: + - POLLEN_TYPE_UNSPECIFIED + - GRASS + - TREE + - WEED + enumDescriptions: + - Unspecified plant type. + - Grass pollen type. + - Tree pollen type. + - Weed pollen type. + type: string + displayName: + type: string + description: >- + A human readable representation of the pollen type name. Example: + "Grass" + indexInfo: + $ref: '#/components/schemas/IndexInfo' + description: Contains the Universal Pollen Index (UPI) data for the pollen type. + description: >- + This object contains the pollen type index and health recommendation + information on specific pollen type. + type: object + parameters: + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + access_token: + description: OAuth access token. + in: query + name: access_token + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + callback: + description: JSONP + in: query + name: callback + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string + x-stackQL-resources: + forecast: + id: google.pollen.forecast + name: forecast + title: Forecast + methods: + lookup: + operation: + $ref: '#/paths/~1v1~1forecast:lookup/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + heatmap_tiles: + id: google.pollen.heatmap_tiles + name: heatmap_tiles + title: Heatmap_tiles + methods: + lookup_heatmap_tile: + operation: + $ref: >- + #/paths/~1v1~1mapTypes~1{mapType}~1heatmapTiles~1{zoom}~1{x}~1{y}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] +paths: + /v1/forecast:lookup: + parameters: &ref_1 + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' + get: + description: >- + Returns up to 5 days of daily pollen information in more than 65 + countries, up to 1km resolution. + operationId: pollen.forecast.lookup + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/LookupForecastResponse' + parameters: + - in: query + name: days + schema: + type: integer + format: int32 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: location.longitude + schema: + type: number + format: double + - in: query + name: plantsDescription + schema: + type: boolean + - in: query + name: languageCode + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: location.latitude + schema: + type: number + format: double + /v1/mapTypes/{mapType}/heatmapTiles/{zoom}/{x}/{y}: + parameters: *ref_1 + get: + description: Returns a byte array containing the data of the tile PNG image. + operationId: pollen.mapTypes.heatmapTiles.lookupHeatmapTile + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/HttpBody' + parameters: + - in: path + name: mapType + required: true + schema: + type: string + - in: path + name: zoom + required: true + schema: + type: string + - in: path + name: x + required: true + schema: + type: string + - in: path + name: 'y' + required: true + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml b/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml index 17a41be2..709f54ec 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/privateca.yaml @@ -11,8 +11,8 @@ info: certificate authorities (CAs) while staying in control of your private keys. version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240819' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/ servers: @@ -474,7 +474,8 @@ components: caOptions: description: >- Optional. Describes options in this X509Parameters that are relevant - in a CA certificate. + in a CA certificate. If not specified, a default basic constraints + extension with `is_ca=false` will be added for leaf certificates. $ref: '#/components/schemas/CaOptions' policyIds: description: >- @@ -594,22 +595,24 @@ components: type: boolean CaOptions: id: CaOptions - description: Describes values that are relevant in a CA certificate. + description: >- + Describes the X.509 basic constraints extension, per [RFC 5280 section + 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) type: object properties: isCa: description: >- - Optional. Refers to the "CA" X.509 extension, which is a boolean - value. When this value is missing, the extension will be omitted - from the CA certificate. + Optional. Refers to the "CA" boolean field in the X.509 extension. + When this value is missing, the basic constraints extension will be + omitted from the certificate. type: boolean maxIssuerPathLength: description: >- - Optional. Refers to the path length restriction X.509 extension. For - a CA certificate, this value describes the depth of subordinate CA - certificates that are allowed. If this value is less than 0, the - request will fail. If this value is missing, the max path length - will be omitted from the CA certificate. + Optional. Refers to the path length constraint field in the X.509 + extension. For a CA certificate, this value describes the depth of + subordinate CA certificates that are allowed. If this value is less + than 0, the request will fail. If this value is missing, the max + path length will be omitted from the certificate. type: integer format: int32 NameConstraints: @@ -832,6 +835,13 @@ components: certFingerprint: description: The hash of the x.509 certificate. $ref: '#/components/schemas/CertificateFingerprint' + tbsCertificateDigest: + description: >- + The hash of the pre-signed certificate, which will be signed by the + CA. Corresponds to the TBS Certificate in + https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will + always be populated. + type: string SubjectDescription: id: SubjectDescription description: >- @@ -2475,16 +2485,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2497,23 +2504,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.privateca.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2541,6 +2546,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' ca_pools: @@ -2555,17 +2561,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1caPools/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.caPools - list: - operation: *ref_5 - response: *ref_6 patch: operation: $ref: >- @@ -2595,6 +2598,7 @@ components: - $ref: '#/components/x-stackQL-resources/ca_pools/methods/create' update: - $ref: '#/components/x-stackQL-resources/ca_pools/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/ca_pools/methods/delete' ca_pools_ca_certs: @@ -2610,9 +2614,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/ca_pools_ca_certs/methods/fetch_ca_certs insert: [] update: [] + replace: [] delete: [] ca_pools_iam_policies: id: google.privateca.ca_pools_iam_policies @@ -2626,17 +2633,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1caPools~1{caPoolsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2650,6 +2654,9 @@ components: #/components/x-stackQL-resources/ca_pools_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/ca_pools_iam_policies/methods/set_iam_policy delete: [] certificates: id: google.privateca.certificates @@ -2663,17 +2670,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1caPools~1{caPoolsId}~1certificates/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificates - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -2703,6 +2707,7 @@ components: - $ref: '#/components/x-stackQL-resources/certificates/methods/create' update: - $ref: '#/components/x-stackQL-resources/certificates/methods/patch' + replace: [] delete: [] certificate_authorities: id: google.privateca.certificate_authorities @@ -2723,17 +2728,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1caPools~1{caPoolsId}~1certificateAuthorities/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificateAuthorities - list: - operation: *ref_11 - response: *ref_12 disable: operation: $ref: >- @@ -2785,6 +2787,8 @@ components: openAPIDocKey: '200' sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/certificate_authorities/methods/fetch - $ref: >- #/components/x-stackQL-resources/certificate_authorities/methods/get - $ref: >- @@ -2795,6 +2799,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/certificate_authorities/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/certificate_authorities/methods/delete @@ -2817,17 +2822,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1caPools~1{caPoolsId}~1certificateAuthorities~1{certificateAuthoritiesId}~1certificateRevocationLists/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificateRevocationLists - list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: >- @@ -2838,6 +2840,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/certificate_revocation_lists/methods/patch + replace: [] delete: [] certificate_revocation_lists_iam_policies: id: google.privateca.certificate_revocation_lists_iam_policies @@ -2851,17 +2854,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_15 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1caPools~1{caPoolsId}~1certificateAuthorities~1{certificateAuthoritiesId}~1certificateRevocationLists~1{certificateRevocationListsId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_15 - response: *ref_16 test_iam_permissions: operation: $ref: >- @@ -2875,6 +2875,9 @@ components: #/components/x-stackQL-resources/certificate_revocation_lists_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/certificate_revocation_lists_iam_policies/methods/set_iam_policy delete: [] certificate_templates: id: google.privateca.certificate_templates @@ -2888,17 +2891,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificateTemplates/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.certificateTemplates - list: - operation: *ref_17 - response: *ref_18 delete: operation: $ref: >- @@ -2931,6 +2931,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/certificate_templates/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/certificate_templates/methods/delete @@ -2946,17 +2947,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_19 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1certificateTemplates~1{certificateTemplatesId}:getIamPolicy/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_19 - response: *ref_20 test_iam_permissions: operation: $ref: >- @@ -2970,10 +2968,13 @@ components: #/components/x-stackQL-resources/certificate_templates_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/certificate_templates_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_21 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3020,7 +3021,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets information about a location. operationId: privateca.projects.locations.get @@ -3048,7 +3049,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3091,7 +3092,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3162,7 +3163,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3209,7 +3210,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools: - parameters: *ref_21 + parameters: *ref_1 post: description: Create a CaPool. operationId: privateca.projects.locations.caPools.create @@ -3293,7 +3294,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}: - parameters: *ref_21 + parameters: *ref_1 patch: description: Update a CaPool. operationId: privateca.projects.locations.caPools.patch @@ -3410,7 +3411,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}:fetchCaCerts: - parameters: *ref_21 + parameters: *ref_1 post: description: >- FetchCaCerts returns the current trust anchor for the CaPool. This will @@ -3451,7 +3452,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}:setIamPolicy: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3492,7 +3493,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}:getIamPolicy: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3532,7 +3533,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}:testIamPermissions: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3575,7 +3576,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificates: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Create a new Certificate in a given Project, Location from a particular @@ -3679,7 +3680,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificates/{certificatesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Returns a Certificate. operationId: privateca.projects.locations.caPools.certificates.get @@ -3769,7 +3770,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificates/{certificatesId}:revoke: - parameters: *ref_21 + parameters: *ref_1 post: description: Revoke a Certificate. operationId: privateca.projects.locations.caPools.certificates.revoke @@ -3812,7 +3813,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}:activate: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Activate a CertificateAuthority that is in state @@ -3860,7 +3861,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities: - parameters: *ref_21 + parameters: *ref_1 post: description: Create a new CertificateAuthority in a given Project and Location. operationId: privateca.projects.locations.caPools.certificateAuthorities.create @@ -3954,7 +3955,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}:disable: - parameters: *ref_21 + parameters: *ref_1 post: description: Disable a CertificateAuthority. operationId: privateca.projects.locations.caPools.certificateAuthorities.disable @@ -3997,7 +3998,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}:enable: - parameters: *ref_21 + parameters: *ref_1 post: description: Enable a CertificateAuthority. operationId: privateca.projects.locations.caPools.certificateAuthorities.enable @@ -4040,7 +4041,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}:fetch: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Fetch a certificate signing request (CSR) from a CertificateAuthority @@ -4083,7 +4084,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Returns a CertificateAuthority. operationId: privateca.projects.locations.caPools.certificateAuthorities.get @@ -4223,7 +4224,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}:undelete: - parameters: *ref_21 + parameters: *ref_1 post: description: Undelete a CertificateAuthority that has been deleted. operationId: privateca.projects.locations.caPools.certificateAuthorities.undelete @@ -4266,7 +4267,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Returns a CertificateRevocationList. operationId: >- @@ -4366,7 +4367,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists CertificateRevocationLists. operationId: >- @@ -4422,7 +4423,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}:setIamPolicy: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4474,7 +4475,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}:getIamPolicy: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4525,7 +4526,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/caPools/{caPoolsId}/certificateAuthorities/{certificateAuthoritiesId}/certificateRevocationLists/{certificateRevocationListsId}:testIamPermissions: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4579,7 +4580,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateTemplates: - parameters: *ref_21 + parameters: *ref_1 post: description: Create a new CertificateTemplate in a given Project and Location. operationId: privateca.projects.locations.certificateTemplates.create @@ -4663,7 +4664,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateTemplates/{certificateTemplatesId}: - parameters: *ref_21 + parameters: *ref_1 delete: description: DeleteCertificateTemplate deletes a CertificateTemplate. operationId: privateca.projects.locations.certificateTemplates.delete @@ -4776,7 +4777,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateTemplates/{certificateTemplatesId}:setIamPolicy: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4817,7 +4818,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/certificateTemplates/{certificateTemplatesId}:getIamPolicy: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4857,7 +4858,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/certificateTemplates/{certificateTemplatesId}:testIamPermissions: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml index 5606114d..9cd5636b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/prod_tt_sasportal.yaml @@ -7,8 +7,8 @@ info: title: SAS Portal API (Testing) description: '' version: v1alpha1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://developers.google.com/spectrum-access-system/ servers: @@ -22,10 +22,10 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. - https://www.googleapis.com/auth/sasportal: Read, create, update, and delete your SAS Portal data. Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -35,493 +35,609 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalSignDeviceRequest: - properties: - device: - $ref: '#/components/schemas/SasPortalDevice' - description: >- - Required. The device to sign. The device fields name, fcc_id and - serial_number must be set. The user_id field must be set. - id: SasPortalSignDeviceRequest - description: Request for SignDevice. - type: object - SasPortalNode: - id: SasPortalNode + SasPortalListDeploymentsResponse: properties: - sasUserIds: - description: User ids used by the devices belonging to this node. - items: - type: string - type: array - name: - description: Output only. Resource name. - type: string - displayName: + nextPageToken: type: string - description: The node's display name. - type: object - description: The Node. - SasPortalListLegacyOrganizationsResponse: - type: object - description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - properties: - organizations: + description: >- + A pagination token returned from a previous call to ListDeployments + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more deployments. + deployments: items: - $ref: '#/components/schemas/SasPortalOrganization' - description: Optional. Legacy SAS organizations. + $ref: '#/components/schemas/SasPortalDeployment' type: array - id: SasPortalListLegacyOrganizationsResponse - SasPortalPolicy: + description: The deployments that match the request. type: object - id: SasPortalPolicy - description: Defines an access control policy to the resources. + description: Response for ListDeployments. + id: SasPortalListDeploymentsResponse + SasPortalListCustomersResponse: + id: SasPortalListCustomersResponse + description: Response for `ListCustomers`. properties: - etag: - format: byte + nextPageToken: type: string description: >- - The etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the etag in - the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An etag is returned in the response to - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. - assignments: - description: List of assignments - type: array + A pagination token returned from a previous call to ListCustomers + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more customers. + customers: items: - $ref: '#/components/schemas/SasPortalAssignment' - SasPortalDeviceGrant: + $ref: '#/components/schemas/SasPortalCustomer' + description: The list of customers that match the request. + type: array type: object - id: SasPortalDeviceGrant + SasPortalSetPolicyRequest: + id: SasPortalSetPolicyRequest + type: object + description: Request message for `SetPolicy` method. properties: - state: - type: string - enumDescriptions: - - '' - - >- - The grant has been granted but the device is not heartbeating on - it. - - The grant has been terminated by the SAS. - - The grant has been suspended by the SAS. - - The device is currently transmitting. - - The grant has expired. - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED - description: State of the grant. - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The transmission frequency range. - maxEirp: - format: double - type: number + policy: + description: Required. The policy to be applied to the `resource`. + $ref: '#/components/schemas/SasPortalPolicy' + disableNotification: + type: boolean description: >- - Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by - the grant. The maximum EIRP is in units of dBm/MHz. The value of - `maxEirp` represents the average (RMS) EIRP that would be measured - by the procedure defined in FCC part 96.41(e)(3). - lastHeartbeatTransmitExpireTime: - description: The transmit expiration time of the last heartbeat. - format: google-datetime - type: string - grantId: - type: string - description: Grant Id. - moveList: - description: The DPA move lists on which this grant appears. - type: array - items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - expireTime: - type: string - format: google-datetime - description: The expiration time of the grant. - channelType: + Optional. Set the field as `true` to disable the onboarding + notification. + resource: type: string - enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL - description: Type of channel used. - enumDescriptions: - - '' - - '' - - '' - suspensionReason: - description: If the grant is suspended, the reason(s) for suspension. - type: array - items: - type: string - description: >- - Device grant. It is an authorization provided by the Spectrum Access - System to a device to transmit using specified operating parameters - after a successful heartbeat by the device. + description: >- + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. SasPortalInstallationParams: description: Information about the device installation parameters. type: object properties: + verticalAccuracy: + format: double + description: >- + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + type: number + antennaAzimuth: + format: int32 + description: >- + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. + type: integer antennaModel: type: string description: >- If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. - verticalAccuracy: + horizontalAccuracy: description: >- A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. + antenna horizontal location. This optional parameter should only be + present if its value is less than the FCC requirement of 50 meters. + format: double type: number + height: format: double + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. + type: number latitude: format: double - type: number description: >- Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. - antennaBeamwidth: - format: int32 + type: number + indoorDeployment: description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - type: integer + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. + type: boolean longitude: + format: double + type: number description: >- Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. - format: double - type: number - indoorDeployment: - type: boolean + heightType: + description: Specifies how the height is measured. + enum: + - HEIGHT_TYPE_UNSPECIFIED + - HEIGHT_TYPE_AGL + - HEIGHT_TYPE_AMSL + type: string + enumDescriptions: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. + cpeCbsdIndication: description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - antennaGain: + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + type: boolean + antennaDowntilt: + type: integer + format: int32 description: >- - Peak antenna gain in dBi. This parameter is a double with a value - between -127 and +128 (dBi) inclusive. Part of Release 2 to support - floating-point value - format: double - type: number + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. eirpCapability: format: int32 + type: integer description: >- This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. - type: integer - horizontalAccuracy: - format: double - description: >- - A positive number in meters to indicate accuracy of the device - antenna horizontal location. This optional parameter should only be - present if its value is less than the FCC requirement of 50 meters. + antennaGain: type: number - cpeCbsdIndication: + format: double description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. - type: boolean - antennaAzimuth: + Peak antenna gain in dBi. This parameter is a double with a value + between -127 and +128 (dBi) inclusive. Part of Release 2 to support + floating-point value + antennaBeamwidth: type: integer description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - format: int32 - height: - format: double - type: number - description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - heightType: - enum: - - HEIGHT_TYPE_UNSPECIFIED - - HEIGHT_TYPE_AGL - - HEIGHT_TYPE_AMSL - enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. - type: string - description: Specifies how the height is measured. - antennaDowntilt: - format: int32 - type: integer - description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. + format: int32 id: SasPortalInstallationParams - SasPortalFrequencyRange: + SasPortalChannelWithScore: type: object + id: SasPortalChannelWithScore + description: The channel with score. properties: - highFrequencyMhz: + score: format: double - description: The highest frequency of the frequency range in MHz. + description: The channel score, normalized to be in the range [0,100]. type: number - lowFrequencyMhz: + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The frequency range of the channel. + SasPortalNrqzValidation: + description: Information about National Radio Quiet Zone validation. + id: SasPortalNrqzValidation + type: object + properties: + state: + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + type: string + description: State of the NRQZ validation info. + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. + latitude: type: number - description: The lowest frequency of the frequency range in MHz. + description: Device latitude that's associated with the validation. format: double - id: SasPortalFrequencyRange - description: Frequency range from `low_frequency` to `high_frequency`. - SasPortalListDevicesResponse: - description: Response for ListDevices. - properties: - devices: - type: array - description: The devices that match the request. - items: - $ref: '#/components/schemas/SasPortalDevice' - nextPageToken: - description: >- - A pagination token returned from a previous call to ListDevices that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more devices. + caseId: + description: Validation case ID. + type: string + longitude: + type: number + description: Device longitude that's associated with the validation. + format: double + cpiId: + description: CPI who signed the validation. type: string + SasPortalSetupSasAnalyticsMetadata: + properties: {} + id: SasPortalSetupSasAnalyticsMetadata + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. type: object - id: SasPortalListDevicesResponse - SasPortalOrganization: + SasPortalMoveNodeRequest: + description: Request for MoveNode. type: object - id: SasPortalOrganization - description: Organization details. properties: - displayName: + destination: type: string - description: Name of organization - id: + description: >- + Required. The name of the new parent resource node or customer to + reparent the node under. + id: SasPortalMoveNodeRequest + SasPortalMigrateOrganizationMetadata: + description: >- + Long-running operation metadata message returned by the + MigrateOrganization. + id: SasPortalMigrateOrganizationMetadata + properties: + operationState: type: string - format: int64 - description: Id of organization - SasPortalDeviceMetadata: + readOnly: true + description: Output only. Current operation state + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. + enum: + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED type: object + SasPortalGetPolicyRequest: properties: - commonChannelGroup: - description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + resource: + description: Required. The resource for which the policy is being requested. type: string - nrqzValidation: - $ref: '#/components/schemas/SasPortalNrqzValidation' - readOnly: true - description: Output only. National Radio Quiet Zone validation info. - antennaModel: + type: object + description: Request message for `GetPolicy` method. + id: SasPortalGetPolicyRequest + SasPortalDpaMoveList: + type: object + description: An entry in a DPA's move list. + id: SasPortalDpaMoveList + properties: + frequencyRange: + description: The frequency range that the move list affects. + $ref: '#/components/schemas/SasPortalFrequencyRange' + dpaId: type: string + description: The ID of the DPA. + SasPortalOperation: + type: object + id: SasPortalOperation + properties: + response: + type: object description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` - interferenceCoordinationGroup: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + name: type: string description: >- - Interference Coordination Group (ICG). A group of CBSDs that manage - their own interference with the group. For more details, see - [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - nrqzValidated: - readOnly: true + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + error: description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/SasPortalStatus' + done: type: boolean - deprecated: true - id: SasPortalDeviceMetadata - description: Device data overridable by both SAS Portal and registration requests. - SasPortalDeviceAirInterface: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + metadata: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + SasPortalDeviceGrant: + description: >- + Device grant. It is an authorization provided by the Spectrum Access + System to a device to transmit using specified operating parameters + after a successful heartbeat by the device. + id: SasPortalDeviceGrant properties: - radioTechnology: - enum: - - RADIO_TECHNOLOGY_UNSPECIFIED - - E_UTRA - - CAMBIUM_NETWORKS - - FOUR_G_BBW_SAA_1 - - NR - - DOODLE_CBRS - - CW - - REDLINE - - TARANA_WIRELESS + grantId: + type: string + description: Grant Id. + lastHeartbeatTransmitExpireTime: + type: string + description: The transmit expiration time of the last heartbeat. + format: google-datetime + suspensionReason: + description: If the grant is suspended, the reason(s) for suspension. + type: array + items: + type: string + channelType: type: string enumDescriptions: - '' - '' - '' + description: Type of channel used. + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL + state: + enumDescriptions: - '' - - '' - - '' - - '' - - '' - - '' - description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. - supportedSpec: + - >- + The grant has been granted but the device is not heartbeating on + it. + - The grant has been terminated by the SAS. + - The grant has been suspended by the SAS. + - The device is currently transmitting. + - The grant has expired. + enum: + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + type: string + description: State of the grant. + frequencyRange: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: The transmission frequency range. + expireTime: + format: google-datetime type: string + description: The expiration time of the grant. + maxEirp: description: >- - Optional. This field is related to the `radioTechnology` and - provides the air interface specification that the CBSD is compliant - with at the time of registration. - description: Information about the device's air interface. - type: object - id: SasPortalDeviceAirInterface - SasPortalMigrateOrganizationResponse: - properties: - deploymentAssociation: + Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by + the grant. The maximum EIRP is in units of dBm/MHz. The value of + `maxEirp` represents the average (RMS) EIRP that would be measured + by the procedure defined in FCC part 96.41(e)(3). + format: double + type: number + moveList: type: array + description: The DPA move lists on which this grant appears. items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' - description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. + $ref: '#/components/schemas/SasPortalDpaMoveList' type: object - id: SasPortalMigrateOrganizationResponse + SasPortalEmpty: + properties: {} description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. - SasPortalTestPermissionsRequest: + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: SasPortalEmpty + type: object + SasPortalDeviceConfig: + description: Information about the device configuration. + type: object properties: - permissions: + state: + enumDescriptions: + - '' + - '' + - '' + enum: + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + description: State of the configuration. + type: string + installationParams: + description: Installation parameters for the device. + $ref: '#/components/schemas/SasPortalInstallationParams' + updateTime: + description: Output only. The last time the device configuration was edited. + format: google-datetime + type: string + model: + $ref: '#/components/schemas/SasPortalDeviceModel' + description: Information about this device model. + isSigned: + description: Output only. Whether the configuration has been signed by a CPI. + type: boolean + airInterface: + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + description: Information about this device's air interface. + measurementCapabilities: + description: Measurement reporting capabilities of the device. type: array items: type: string - description: The set of permissions to check for the `resource`. - resource: + enum: + - MEASUREMENT_CAPABILITY_UNSPECIFIED + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT + - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT + enumDescriptions: + - '' + - '' + - '' + userId: + description: The identifier of a device user. + type: string + callSign: + type: string + description: The call sign of the device operator. + category: + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. + type: string + description: FCC category of the device. + id: SasPortalDeviceConfig + SasPortalSetupSasAnalyticsRequest: + properties: + userId: type: string description: >- - Required. The resource for which the permissions are being - requested. - id: SasPortalTestPermissionsRequest + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional + id: SasPortalSetupSasAnalyticsRequest type: object - description: Request message for `TestPermissions` method. - SasPortalListCustomersResponse: + description: Request for the SetupSasAnalytics rpc. + SasPortalGenerateSecretResponse: + id: SasPortalGenerateSecretResponse properties: - customers: + secret: + type: string + description: The secret generated by the string and used by ValidateInstaller. + type: object + description: Response for GenerateSecret. + SasPortalTestPermissionsResponse: + properties: + permissions: type: array - description: The list of customers that match the request. items: - $ref: '#/components/schemas/SasPortalCustomer' - nextPageToken: - type: string - description: >- - A pagination token returned from a previous call to ListCustomers - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more customers. - id: SasPortalListCustomersResponse - description: Response for `ListCustomers`. + type: string + description: A set of permissions that the caller is allowed. + id: SasPortalTestPermissionsResponse type: object - SasPortalChannelWithScore: + description: Response message for `TestPermissions` method. + SasPortalDeploymentAssociation: type: object - description: The channel with score. + description: Association between a gcp project and a SAS user id. + id: SasPortalDeploymentAssociation properties: - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range of the channel. - score: - description: The channel score, normalized to be in the range [0,100]. - type: number - format: double - id: SasPortalChannelWithScore - SasPortalMigrateOrganizationMetadata: + gcpProjectId: + type: string + description: GCP project id of the associated project. + userId: + type: string + description: User id of the deployment. + SasPortalListNodesResponse: + description: Response for ListNodes. + id: SasPortalListNodesResponse type: object properties: - operationState: - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - readOnly: true - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. + nextPageToken: + description: >- + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. type: string - description: Output only. Current operation state - id: SasPortalMigrateOrganizationMetadata + nodes: + description: The nodes that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalNode' + SasPortalGcpProjectDeployment: + id: SasPortalGcpProjectDeployment + properties: + hasEnabledAnalytics: + description: Whether SAS analytics has been enabled. + type: boolean + deployment: + $ref: '#/components/schemas/SasPortalDeployment' + description: Deployment associated with the GCP project. + type: object description: >- - Long-running operation metadata message returned by the - MigrateOrganization. - SasPortalCustomer: + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. + SasPortalListGcpProjectDeploymentsResponse: + id: SasPortalListGcpProjectDeploymentsResponse type: object - id: SasPortalCustomer - description: Entity representing a SAS customer. + description: Response for [ListGcpProjectDeployments]. + properties: + deployments: + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + type: array + description: Optional. Deployments associated with the GCP project + SasPortalFrequencyRange: + description: Frequency range from `low_frequency` to `high_frequency`. + properties: + highFrequencyMhz: + description: The highest frequency of the frequency range in MHz. + format: double + type: number + lowFrequencyMhz: + format: double + description: The lowest frequency of the frequency range in MHz. + type: number + id: SasPortalFrequencyRange + type: object + SasPortalNode: + description: The Node. + id: SasPortalNode properties: + name: + type: string + description: Output only. Resource name. sasUserIds: - description: User IDs used by the devices belonging to this customer. - type: array items: type: string - name: - type: string - description: Output only. Resource name of the customer. + description: User ids used by the devices belonging to this node. + type: array displayName: type: string - description: >- - Required. Name of the organization that the customer entity - represents. - SasPortalGcpProjectDeployment: - id: SasPortalGcpProjectDeployment - type: object - properties: - deployment: - description: Deployment associated with the GCP project. - $ref: '#/components/schemas/SasPortalDeployment' - hasEnabledAnalytics: - description: Whether SAS analytics has been enabled. - type: boolean - description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. - SasPortalGenerateSecretResponse: + description: The node's display name. type: object - description: Response for GenerateSecret. + SasPortalTestPermissionsRequest: properties: - secret: - description: The secret generated by the string and used by ValidateInstaller. + permissions: + description: The set of permissions to check for the `resource`. + items: + type: string + type: array + resource: type: string - id: SasPortalGenerateSecretResponse - SasPortalProvisionDeploymentResponse: - id: SasPortalProvisionDeploymentResponse + description: >- + Required. The resource for which the permissions are being + requested. + id: SasPortalTestPermissionsRequest + description: Request message for `TestPermissions` method. type: object + SasPortalProvisionDeploymentResponse: properties: errorMessage: description: >- Optional. Optional error message if the provisioning request is not successful. type: string + type: object description: >- Response for [ProvisionDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. + id: SasPortalProvisionDeploymentResponse SasPortalProvisionDeploymentRequest: + description: >- + Request for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP + Project, Organization Info, and caller’s GAIA ID should be retrieved + from the RPC handler, and used as inputs to create a new SAS + organization (if not exists) and a new SAS deployment. + type: object + id: SasPortalProvisionDeploymentRequest properties: + organizationId: + format: int64 + description: >- + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. + type: string newOrganizationDisplayName: type: string description: >- @@ -529,74 +645,108 @@ components: needs to be created, its display name will be set to the value of this field. newDeploymentDisplayName: - type: string description: >- Optional. If this field is set, and a new SAS Portal Deployment needs to be created, its display name will be set to the value of this field. - organizationId: - format: int64 type: string - description: >- - Optional. If this field is set then a new deployment will be created - under the organization specified by this id. + SasPortalSetupSasAnalyticsResponse: description: >- - Request for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP - Project, Organization Info, and caller’s GAIA ID should be retrieved - from the RPC handler, and used as inputs to create a new SAS - organization (if not exists) and a new SAS deployment. - id: SasPortalProvisionDeploymentRequest + Response returned by the long running operation for the + SetupSasAnalytics rpc. type: object - SasPortalCreateSignedDeviceRequest: - description: Request for CreateSignedDevice. - id: SasPortalCreateSignedDeviceRequest + properties: {} + id: SasPortalSetupSasAnalyticsResponse + SasPortalDeviceAirInterface: type: object + description: Information about the device's air interface. + id: SasPortalDeviceAirInterface properties: - installerId: + radioTechnology: description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. + Conditional. This field specifies the radio access technology that + is used for the CBSD. + enumDescriptions: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + - '' + enum: + - RADIO_TECHNOLOGY_UNSPECIFIED + - E_UTRA + - CAMBIUM_NETWORKS + - FOUR_G_BBW_SAA_1 + - NR + - DOODLE_CBRS + - CW + - REDLINE + - TARANA_WIRELESS + - FAROS type: string - encodedDevice: + supportedSpec: type: string - format: byte description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - SasPortalDevice: + Optional. This field is related to the `radioTechnology` and + provides the air interface specification that the CBSD is compliant + with at the time of registration. + SasPortalListLegacyOrganizationsResponse: + id: SasPortalListLegacyOrganizationsResponse type: object properties: - name: - description: Output only. The resource path name. + organizations: + description: Optional. Legacy SAS organizations. + type: array + items: + $ref: '#/components/schemas/SasPortalOrganization' + description: >- + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. + SasPortalOrganization: + description: Organization details. + type: object + properties: + id: type: string - fccId: - description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. + format: int64 + description: Id of organization + displayName: type: string - preloadedConfig: - $ref: '#/components/schemas/SasPortalDeviceConfig' - description: Configuration of the device, as specified via SAS Portal API. - serialNumber: - description: A serial number assigned to the device by the device manufacturer. + description: Name of organization + id: SasPortalOrganization + SasPortalDevice: + type: object + id: SasPortalDevice + properties: + displayName: type: string - grantRangeAllowlists: + description: Device display name. + currentChannels: + description: Output only. Current channels with scores. + readOnly: true items: - $ref: '#/components/schemas/SasPortalFrequencyRange' + $ref: '#/components/schemas/SasPortalChannelWithScore' type: array + deprecated: true + activeConfig: description: >- - Only ranges that are within the allowlists are available for new - grants. + Output only. Current configuration of the device as registered to + the SAS. + $ref: '#/components/schemas/SasPortalDeviceConfig' + deviceMetadata: + $ref: '#/components/schemas/SasPortalDeviceMetadata' + description: >- + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + preloadedConfig: + description: Configuration of the device, as specified via SAS Portal API. + $ref: '#/components/schemas/SasPortalDeviceConfig' state: - type: string - enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED enumDescriptions: - Unspecified state. - >- @@ -605,515 +755,361 @@ components: - Device registered with SAS. - Device de-registered with SAS. description: Output only. Device state. - displayName: + enum: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED type: string - description: Device display name. - grants: - description: Output only. Grants held by the device. - type: array - items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - deviceMetadata: - $ref: '#/components/schemas/SasPortalDeviceMetadata' - description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - currentChannels: - readOnly: true - type: array - deprecated: true - description: Output only. Current channels with scores. - items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - activeConfig: - description: >- - Output only. Current configuration of the device as registered to - the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' - id: SasPortalDevice - SasPortalDeployment: - properties: - sasUserIds: - type: array - items: - type: string - description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. - frns: - items: - type: string - type: array - readOnly: true - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. name: - description: Output only. Resource name. - readOnly: true + description: Output only. The resource path name. type: string - displayName: - description: The deployment's display name. + fccId: type: string - type: object - description: The Deployment. - id: SasPortalDeployment - SasPortalAssignment: - properties: - members: + description: >- + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. + grants: + description: Output only. Grants held by the device. items: - type: string - description: >- - The identities the role is assigned to. It can have the following - values: * `{user_email}`: An email address that represents a - specific Google account. For example: `alice@gmail.com`. * - `{group_email}`: An email address that represents a Google group. - For example, `viewers@gmail.com`. + $ref: '#/components/schemas/SasPortalDeviceGrant' type: array - role: + serialNumber: type: string - description: Required. Role that is assigned to `members`. - description: Associates `members` with a `role`. - type: object - id: SasPortalAssignment - SasPortalMoveNodeRequest: - id: SasPortalMoveNodeRequest + description: A serial number assigned to the device by the device manufacturer. + grantRangeAllowlists: + items: + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: >- + Only ranges that are within the allowlists are available for new + grants. + type: array + SasPortalCreateSignedDeviceRequest: + description: Request for CreateSignedDevice. + id: SasPortalCreateSignedDeviceRequest type: object - description: Request for MoveNode. properties: - destination: + encodedDevice: description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. + Required. JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. type: string - SasPortalDpaMoveList: - properties: - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range that the move list affects. - dpaId: - description: The ID of the DPA. + format: byte + installerId: type: string - type: object - description: An entry in a DPA's move list. - id: SasPortalDpaMoveList - SasPortalListDeploymentsResponse: - type: object - id: SasPortalListDeploymentsResponse + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + SasPortalDeviceModel: + id: SasPortalDeviceModel + description: Information about the model of the device. properties: - nextPageToken: + name: + description: The name of the device model. type: string - description: >- - A pagination token returned from a previous call to ListDeployments - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more deployments. - deployments: - items: - $ref: '#/components/schemas/SasPortalDeployment' - description: The deployments that match the request. - type: array - description: Response for ListDeployments. - SasPortalSetupSasAnalyticsMetadata: - properties: {} - id: SasPortalSetupSasAnalyticsMetadata - type: object - description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. - SasPortalSetupSasAnalyticsRequest: - id: SasPortalSetupSasAnalyticsRequest + hardwareVersion: + type: string + description: The hardware version of the device. + vendor: + type: string + description: The name of the device vendor. + firmwareVersion: + type: string + description: The firmware version of the device. + softwareVersion: + type: string + description: The software version of the device. type: object - description: Request for the SetupSasAnalytics rpc. + SasPortalUpdateSignedDeviceRequest: properties: - userId: + encodedDevice: + type: string + format: byte description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + installerId: type: string - SasPortalListNodesResponse: + description: >- + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. + type: object + id: SasPortalUpdateSignedDeviceRequest + description: Request for UpdateSignedDevice. + SasPortalListDevicesResponse: + id: SasPortalListDevicesResponse + description: Response for ListDevices. properties: - nodes: - description: The nodes that match the request. - items: - $ref: '#/components/schemas/SasPortalNode' - type: array nextPageToken: description: >- - A pagination token returned from a previous call to ListNodes that + A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. + missing or empty, it means there is no more devices. type: string + devices: + description: The devices that match the request. + type: array + items: + $ref: '#/components/schemas/SasPortalDevice' type: object - id: SasPortalListNodesResponse - description: Response for ListNodes. - SasPortalMoveDeviceRequest: - description: Request for MoveDevice. + SasPortalMoveDeploymentRequest: + id: SasPortalMoveDeploymentRequest properties: destination: type: string description: >- Required. The name of the new parent resource node or customer to - reparent the device under. - type: object - id: SasPortalMoveDeviceRequest - SasPortalStatus: - properties: - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: object - id: SasPortalStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - SasPortalGenerateSecretRequest: - properties: {} + reparent the deployment under. type: object - id: SasPortalGenerateSecretRequest - description: Request for GenerateSecret. - SasPortalOperation: + description: Request for MoveDeployment. + SasPortalPolicy: type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: SasPortalOperation + description: Defines an access control policy to the resources. properties: - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - name: + etag: + format: byte description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the etag in + the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An etag is returned in the response to + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. type: string - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/SasPortalStatus' - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - response: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - SasPortalListGcpProjectDeploymentsResponse: - description: Response for [ListGcpProjectDeployments]. - id: SasPortalListGcpProjectDeploymentsResponse - properties: - deployments: - items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + assignments: + description: List of assignments type: array - description: Optional. Deployments associated with the GCP project - type: object - SasPortalUpdateSignedDeviceRequest: - id: SasPortalUpdateSignedDeviceRequest - description: Request for UpdateSignedDevice. - type: object + items: + $ref: '#/components/schemas/SasPortalAssignment' + id: SasPortalPolicy + SasPortalAssignment: properties: - installerId: - type: string + members: + type: array + items: + type: string description: >- - Required. Unique installer ID (CPI ID) from the Certified - Professional Installers database. - encodedDevice: - format: byte + The identities the role is assigned to. It can have the following + values: * `{user_email}`: An email address that represents a + specific Google account. For example: `alice@gmail.com`. * + `{group_email}`: An email address that represents a Google group. + For example, `viewers@gmail.com`. + role: type: string - description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - SasPortalMigrateOrganizationRequest: + description: Required. Role that is assigned to `members`. type: object + id: SasPortalAssignment + description: Associates `members` with a `role`. + SasPortalMigrateOrganizationRequest: description: >- Request for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP Project, Organization Info, and caller's GAIA ID should be retrieved from the RPC handler, and used to check authorization on SAS Portal organization and to create GCP Projects. + id: SasPortalMigrateOrganizationRequest properties: organizationId: + format: int64 type: string description: Required. Id of the SAS organization to be migrated. - format: int64 - id: SasPortalMigrateOrganizationRequest - SasPortalEmpty: - id: SasPortalEmpty + type: object + SasPortalGenerateSecretRequest: + type: object properties: {} - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + description: Request for GenerateSecret. + id: SasPortalGenerateSecretRequest + SasPortalDeployment: type: object - SasPortalValidateInstallerRequest: - id: SasPortalValidateInstallerRequest + id: SasPortalDeployment properties: - secret: - description: Required. Secret returned by the GenerateSecret. - type: string - encodedSecret: + sasUserIds: + items: + type: string + description: >- + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + type: array + displayName: type: string + description: The deployment's display name. + frns: + readOnly: true + items: + type: string description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. - installerId: + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + type: array + name: + readOnly: true + description: Output only. Resource name. type: string + description: The Deployment. + SasPortalSignDeviceRequest: + properties: + device: description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. - description: Request for ValidateInstaller. + Required. The device to sign. The device fields name, fcc_id and + serial_number must be set. The user_id field must be set. + $ref: '#/components/schemas/SasPortalDevice' + id: SasPortalSignDeviceRequest + description: Request for SignDevice. type: object - SasPortalMoveDeploymentRequest: + SasPortalMoveDeviceRequest: + type: object + description: Request for MoveDevice. properties: destination: type: string description: >- Required. The name of the new parent resource node or customer to - reparent the deployment under. - description: Request for MoveDeployment. + reparent the device under. + id: SasPortalMoveDeviceRequest + SasPortalValidateInstallerResponse: + properties: {} + description: Response for ValidateInstaller. + id: SasPortalValidateInstallerResponse type: object - id: SasPortalMoveDeploymentRequest - SasPortalSetPolicyRequest: + SasPortalMigrateOrganizationResponse: type: object - id: SasPortalSetPolicyRequest - description: Request message for `SetPolicy` method. + id: SasPortalMigrateOrganizationResponse properties: - policy: - $ref: '#/components/schemas/SasPortalPolicy' - description: Required. The policy to be applied to the `resource`. - resource: - description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - type: string - disableNotification: - type: boolean + deploymentAssociation: + items: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - SasPortalGetPolicyRequest: - id: SasPortalGetPolicyRequest - description: Request message for `GetPolicy` method. - type: object - properties: - resource: - type: string - description: Required. The resource for which the policy is being requested. - SasPortalNrqzValidation: - id: SasPortalNrqzValidation - description: Information about National Radio Quiet Zone validation. - properties: - state: - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - description: State of the NRQZ validation info. - type: string - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - longitude: - format: double - type: number - description: Device longitude that's associated with the validation. - caseId: - type: string - description: Validation case ID. - latitude: - type: number - format: double - description: Device latitude that's associated with the validation. - cpiId: - description: CPI who signed the validation. - type: string + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. + type: array + description: >- + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + SasPortalDeviceMetadata: + description: Device data overridable by both SAS Portal and registration requests. type: object - SasPortalDeviceModel: properties: - vendor: - type: string - description: The name of the device vendor. - softwareVersion: - type: string - description: The software version of the device. - name: - description: The name of the device model. + antennaModel: + description: >- + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` type: string - firmwareVersion: - description: The firmware version of the device. + nrqzValidation: + readOnly: true + description: Output only. National Radio Quiet Zone validation info. + $ref: '#/components/schemas/SasPortalNrqzValidation' + commonChannelGroup: + description: >- + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). type: string - hardwareVersion: + interferenceCoordinationGroup: + description: >- + Interference Coordination Group (ICG). A group of CBSDs that manage + their own interference with the group. For more details, see + [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). type: string - description: The hardware version of the device. - id: SasPortalDeviceModel - description: Information about the model of the device. - type: object - SasPortalValidateInstallerResponse: - description: Response for ValidateInstaller. - type: object - id: SasPortalValidateInstallerResponse - properties: {} - SasPortalSetupSasAnalyticsResponse: - properties: {} - id: SasPortalSetupSasAnalyticsResponse + nrqzValidated: + readOnly: true + description: >- + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + deprecated: true + type: boolean + id: SasPortalDeviceMetadata + SasPortalStatus: + id: SasPortalStatus type: object description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. - SasPortalTestPermissionsResponse: - properties: - permissions: - type: array - description: A set of permissions that the caller is allowed. - items: - type: string - type: object - description: Response message for `TestPermissions` method. - id: SasPortalTestPermissionsResponse - SasPortalDeploymentAssociation: - id: SasPortalDeploymentAssociation - type: object - description: Association between a gcp project and a SAS user id. + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). properties: - userId: - type: string - description: User id of the deployment. - gcpProjectId: - description: GCP project id of the associated project. + message: type: string - SasPortalDeviceConfig: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + details: + items: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + type: array + SasPortalValidateInstallerRequest: + id: SasPortalValidateInstallerRequest properties: - updateTime: - format: google-datetime - description: Output only. The last time the device configuration was edited. + secret: type: string - model: - description: Information about this device model. - $ref: '#/components/schemas/SasPortalDeviceModel' - category: - enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B + description: Required. Secret returned by the GenerateSecret. + installerId: type: string - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. - description: FCC category of the device. - callSign: + description: >- + Required. Unique installer id (CPI ID) from the Certified + Professional Installers database. + encodedSecret: type: string - description: The call sign of the device operator. - installationParams: - $ref: '#/components/schemas/SasPortalInstallationParams' - description: Installation parameters for the device. - measurementCapabilities: + description: >- + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. + type: object + description: Request for ValidateInstaller. + SasPortalCustomer: + description: Entity representing a SAS customer. + properties: + name: + description: Output only. Resource name of the customer. + type: string + sasUserIds: type: array items: - enumDescriptions: - - '' - - '' - - '' type: string - enum: - - MEASUREMENT_CAPABILITY_UNSPECIFIED - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT - description: Measurement reporting capabilities of the device. - state: - description: State of the configuration. - enumDescriptions: - - '' - - '' - - '' - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - type: string - isSigned: - type: boolean - description: Output only. Whether the configuration has been signed by a CPI. - userId: - description: The identifier of a device user. + description: User IDs used by the devices belonging to this customer. + displayName: type: string - airInterface: - description: Information about this device's air interface. - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - description: Information about the device configuration. - id: SasPortalDeviceConfig + description: >- + Required. Name of the organization that the customer entity + represents. + id: SasPortalCustomer type: object parameters: - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string prettyPrint: description: Returns response with indentations and line breaks. in: query name: prettyPrint schema: type: boolean - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + _.xgafv: + description: V1 error format. in: query - name: upload_protocol + name: $.xgafv schema: type: string + enum: + - '1' + - '2' quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -1123,39 +1119,18 @@ components: name: quotaUser schema: type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: $.xgafv + name: fields schema: type: string - enum: - - '1' - - '2' access_token: description: OAuth access token. in: query name: access_token schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string alt: description: Data format for response. in: query @@ -1166,68 +1141,76 @@ components: - json - media - proto - fields: - description: Selector specifying which fields to include in a partial response. + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol + schema: + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key + schema: + type: string + callback: + description: JSONP + in: query + name: callback + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string x-stackQL-resources: - installer: - id: google.prod_tt_sasportal.installer - name: installer - title: Installer + devices: + id: google.prod_tt_sasportal.devices + name: devices + title: Devices methods: - installer_validate: + nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - installer_generate_secret: + nodes_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - policies: - id: google.prod_tt_sasportal.policies - name: policies - title: Policies - methods: - policies_test: + objectKey: $.devices + nodes_devices_get: operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' response: mediaType: application/json openAPIDocKey: '200' - policies_get: + nodes_devices_delete: operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' response: mediaType: application/json openAPIDocKey: '200' - policies_set: + nodes_devices_patch: operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] - devices: - id: google.prod_tt_sasportal.devices - name: devices - title: Devices - methods: nodes_devices_sign_device: operation: $ref: >- @@ -1235,22 +1218,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _nodes_devices_list: - operation: &ref_1 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_list: - operation: *ref_1 - response: *ref_2 - nodes_devices_create: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' - response: - mediaType: application/json - openAPIDocKey: '200' nodes_devices_move: operation: $ref: >- @@ -1258,113 +1225,77 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_patch: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_devices_delete: + nodes_nodes_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - _nodes_deployments_devices_list: - operation: &ref_3 $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get - response: &ref_4 + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - nodes_deployments_devices_list: - operation: *ref_3 - response: *ref_4 - nodes_deployments_devices_create: + nodes_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_devices_list: - operation: &ref_5 - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - nodes_nodes_devices_list: - operation: *ref_5 - response: *ref_6 - nodes_nodes_devices_create: + nodes_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_patch: + nodes_deployments_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_delete: + objectKey: $.devices + customers_devices_get: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_get: + customers_devices_delete: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_move: + customers_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create: + customers_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - _customers_deployments_devices_list: - operation: &ref_7 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get - response: &ref_8 + customers_devices_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - customers_deployments_devices_list: - operation: *ref_7 - response: *ref_8 customers_devices_move: operation: $ref: >- @@ -1372,96 +1303,99 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_devices_get: + customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/get + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: + customers_nodes_devices_list: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - customers_devices_delete: + objectKey: $.devices + customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/delete + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create: + customers_deployments_devices_list: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - _customers_devices_list: - operation: &ref_9 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' - response: &ref_10 + objectKey: $.devices + deployments_devices_get: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_devices_list: - operation: *ref_9 - response: *ref_10 - customers_devices_sign_device: + deployments_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + deployments_devices_delete: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/delete response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_devices_list: - operation: &ref_11 + deployments_devices_sign_device: + operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get - response: &ref_12 + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.devices - customers_nodes_devices_list: - operation: *ref_11 - response: *ref_12 - customers_nodes_devices_create: + deployments_devices_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/devices/methods/nodes_devices_get' - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_get - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list + #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_list insert: - - $ref: >- - #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create + #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_create - $ref: >- @@ -1469,17 +1403,18 @@ components: update: - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_patch - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_patch + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_delete - - $ref: >- - #/components/x-stackQL-resources/devices/methods/deployments_devices_delete - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_delete + - $ref: >- + #/components/x-stackQL-resources/devices/methods/deployments_devices_delete devices_signed: id: google.prod_tt_sasportal.devices_signed name: devices_signed @@ -1498,77 +1433,99 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_devices_create_signed: + nodes_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_devices_create_signed: + nodes_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices:createSigned/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_update_signed: + customers_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create_signed: + customers_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_update_signed: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create_signed: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: + deployments_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] insert: - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed + #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed + replace: [] delete: [] deployments: id: google.prod_tt_sasportal.deployments name: deployments title: Deployments methods: + nodes_nodes_deployments_list: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.deployments + nodes_nodes_deployments_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' nodes_deployments_delete: operation: $ref: >- @@ -1590,16 +1547,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _nodes_deployments_list: - operation: &ref_13 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' - response: &ref_14 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - nodes_deployments_list: - operation: *ref_13 - response: *ref_14 nodes_deployments_move: operation: $ref: >- @@ -1607,34 +1554,32 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_deployments_create: + nodes_deployments_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_deployments_list: - operation: &ref_15 + objectKey: $.deployments + customers_nodes_deployments_list: + operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get - response: &ref_16 + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - nodes_nodes_deployments_list: - operation: *ref_15 - response: *ref_16 - deployments_get: + customers_nodes_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_patch: + customers_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1652,63 +1597,48 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _customers_deployments_list: - operation: &ref_17 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' - response: &ref_18 + customers_deployments_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments customers_deployments_list: - operation: *ref_17 - response: *ref_18 - customers_deployments_create: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_move: + objectKey: $.deployments + customers_deployments_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}:move/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_deployments_create: + deployments_get: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + $ref: '#/paths/~1v1alpha1~1deployments~1{deploymentsId}/get' response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_deployments_list: - operation: &ref_19 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get - response: &ref_20 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.deployments - customers_nodes_deployments_list: - operation: *ref_19 - response: *ref_20 sqlVerbs: select: - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - $ref: >- - #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list + #/components/x-stackQL-resources/deployments/methods/customers_deployments_get - $ref: >- - #/components/x-stackQL-resources/deployments/methods/deployments_get + #/components/x-stackQL-resources/deployments/methods/nodes_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_deployments_list + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/deployments_get insert: - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_create @@ -1721,6 +1651,7 @@ components: #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete @@ -1731,6 +1662,20 @@ components: name: nodes title: Nodes methods: + nodes_nodes_nodes_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_nodes_nodes_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nodes nodes_nodes_patch: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/patch' @@ -1749,50 +1694,30 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_list: - operation: &ref_21 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' - response: &ref_22 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_list: - operation: *ref_21 - response: *ref_22 nodes_nodes_create: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_nodes_list: - operation: &ref_23 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_nodes_list: - operation: *ref_23 - response: *ref_24 - nodes_nodes_nodes_create: + nodes_nodes_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_patch: + objectKey: $.nodes + customers_nodes_move: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_move: + customers_nodes_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}:move/post + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1809,6 +1734,7 @@ components: - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' - $ref: >- #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch + replace: [] delete: - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' node: @@ -1834,34 +1760,43 @@ components: - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' insert: [] update: [] + replace: [] delete: [] - customers: - id: google.prod_tt_sasportal.customers - name: customers - title: Customers + policies: + id: google.prod_tt_sasportal.policies + name: policies + title: Policies methods: - _customers_list: - operation: &ref_25 - $ref: '#/paths/~1v1alpha1~1customers/get' - response: &ref_26 + policies_get: + operation: + $ref: '#/paths/~1v1alpha1~1policies:get/post' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customers - customers_list: - operation: *ref_25 - response: *ref_26 - customers_patch: + policies_test: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + $ref: '#/paths/~1v1alpha1~1policies:test/post' response: mediaType: application/json openAPIDocKey: '200' - customers_get: + policies_set: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + $ref: '#/paths/~1v1alpha1~1policies:set/post' response: mediaType: application/json openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' + insert: [] + update: [] + replace: [] + delete: [] + customers: + id: google.prod_tt_sasportal.customers + name: customers + title: Customers + methods: customers_setup_sas_analytics: operation: $ref: '#/paths/~1v1alpha1~1customers:setupSasAnalytics/post' @@ -1874,6 +1809,25 @@ components: response: mediaType: application/json openAPIDocKey: '200' + customers_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.customers + customers_get: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_patch: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' customers_migrate_organization: operation: $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' @@ -1887,6 +1841,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + replace: [] delete: [] customers_legacy_organizations: id: google.prod_tt_sasportal.customers_legacy_organizations @@ -1905,6 +1860,7 @@ components: #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations insert: [] update: [] + replace: [] delete: [] customers_gcp_project_deployments: id: google.prod_tt_sasportal.customers_gcp_project_deployments @@ -1923,53 +1879,48 @@ components: #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments insert: [] update: [] + replace: [] delete: [] customer_nodes: id: google.prod_tt_sasportal.customer_nodes name: customer_nodes title: Customer_nodes methods: - _customers_nodes_list: - operation: &ref_27 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' - response: &ref_28 + customers_nodes_nodes_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_list: - operation: *ref_27 - response: *ref_28 - customers_nodes_create: + customers_nodes_nodes_list: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_delete: + objectKey: $.nodes + customers_nodes_list: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_nodes_create: + objectKey: $.nodes + customers_nodes_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_nodes_list: - operation: &ref_29 + customers_nodes_delete: + operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get - response: &ref_30 + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.nodes - customers_nodes_nodes_list: - operation: *ref_29 - response: *ref_30 sqlVerbs: select: - $ref: >- @@ -1982,6 +1933,7 @@ components: - $ref: >- #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete @@ -2002,168 +1954,53 @@ components: #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get insert: [] update: [] + replace: [] + delete: [] + installer: + id: google.prod_tt_sasportal.installer + name: installer + title: Installer + methods: + installer_validate: + operation: + $ref: '#/paths/~1v1alpha1~1installer:validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + installer_generate_secret: + operation: + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] delete: [] paths: - /v1alpha1/installer:validate: - parameters: &ref_31 - - $ref: '#/components/parameters/key' + /v1alpha1/nodes/{nodesId}/devices: + parameters: &ref_1 - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: prod_tt_sasportal.installer.validate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] - /v1alpha1/installer:generateSecret: - parameters: *ref_31 - post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: prod_tt_sasportal.installer.generateSecret - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/policies:test: - parameters: *ref_31 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: prod_tt_sasportal.policies.test - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' - parameters: [] - /v1alpha1/policies:get: - parameters: *ref_31 - post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: prod_tt_sasportal.policies.get - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:set: - parameters: *ref_31 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: prod_tt_sasportal.policies.set - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: - parameters: *ref_31 + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/oauth_token' post: - description: Signs a device. - operationId: prod_tt_sasportal.nodes.devices.signDevice + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2179,20 +2016,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/devices: - parameters: *ref_31 get: description: Lists devices under a node or customer. operationId: prod_tt_sasportal.nodes.devices.list @@ -2218,27 +2048,29 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string - in: query name: filter schema: type: string - post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.create + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.nodes.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2261,16 +2093,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: - parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.nodes.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + parameters: *ref_1 + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2298,16 +2130,9 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_31 - post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.nodes.devices.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2323,7 +2148,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -2335,16 +2160,14 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices:createSigned: - parameters: *ref_31 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.devices.createSigned + patch: + description: Updates a device. + operationId: prod_tt_sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2367,11 +2190,26 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: - parameters: *ref_31 - get: - description: Gets details about a device. - operationId: prod_tt_sasportal.nodes.devices.get + - in: path + name: devicesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2394,19 +2232,16 @@ paths: required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.nodes.devices.patch + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: prod_tt_sasportal.nodes.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2422,7 +2257,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -2434,14 +2269,16 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.nodes.devices.delete + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.nodes.devices.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2457,7 +2294,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -2469,11 +2306,11 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: - parameters: *ref_31 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.list + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2489,7 +2326,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId @@ -2497,7 +2334,7 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string @@ -2505,23 +2342,23 @@ paths: name: pageToken schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.create + description: Creates a new deployment. + operationId: prod_tt_sasportal.nodes.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2537,7 +2374,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -2545,20 +2382,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: - parameters: *ref_31 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: + parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2574,7 +2411,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -2582,15 +2419,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: - parameters: *ref_31 - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.nodes.deployments.delete + get: + description: Lists nodes. + operationId: prod_tt_sasportal.nodes.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2606,7 +2441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId @@ -2614,48 +2449,33 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.nodes.deployments.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: nodesId - required: true + - in: query + name: filter schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: pageToken schema: type: string - patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.nodes.deployments.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2671,7 +2491,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -2679,20 +2499,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/nodes/{nodesId}/deployments: - parameters: *ref_31 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + parameters: *ref_1 get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.deployments.list + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2708,13 +2523,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId required: true schema: type: string + - in: path + name: nodesId1 + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 - in: query name: pageToken schema: @@ -2723,21 +2548,14 @@ paths: name: filter schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: - parameters: *ref_31 post: - description: Moves a deployment under another node or customer. - operationId: prod_tt_sasportal.nodes.deployments.move + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2753,7 +2571,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -2761,12 +2579,12 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: - parameters: *ref_31 + parameters: *ref_1 patch: description: Updates an existing node. operationId: prod_tt_sasportal.nodes.nodes.patch @@ -2868,7 +2686,7 @@ paths: schema: type: string /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: - parameters: *ref_31 + parameters: *ref_1 post: description: Moves a node under another node or customer. operationId: prod_tt_sasportal.nodes.nodes.move @@ -2905,7 +2723,37 @@ paths: schema: type: string /v1alpha1/nodes/{nodesId}/nodes: - parameters: *ref_31 + parameters: *ref_1 + post: + description: Creates a new node. + operationId: prod_tt_sasportal.nodes.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string get: description: Lists nodes. operationId: prod_tt_sasportal.nodes.nodes.list @@ -2935,23 +2783,25 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.nodes.create + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2967,23 +2817,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: - parameters: *ref_31 + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.nodes.nodes.deployments.create + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2999,7 +2854,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -3007,13 +2862,13 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string get: - description: Lists deployments. - operationId: prod_tt_sasportal.nodes.nodes.deployments.list + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3029,7 +2884,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId @@ -3037,28 +2892,58 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string + - in: query + name: filter + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: filter + name: pageToken schema: type: string - - in: query - name: pageToken + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + parameters: *ref_1 + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.nodes.deployments.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalEmpty' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: - parameters: *ref_31 get: - description: Lists nodes. - operationId: prod_tt_sasportal.nodes.nodes.nodes.list + description: Returns a requested deployment. + operationId: prod_tt_sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3074,7 +2959,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -3082,31 +2967,60 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - - in: query - name: pageToken + patch: + description: Updates an existing deployment. + operationId: prod_tt_sasportal.nodes.deployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' + parameters: + - in: path + name: nodesId + required: true schema: type: string - - in: query - name: filter + - in: path + name: deploymentsId + required: true schema: type: string - in: query - name: pageSize + name: updateMask schema: - type: integer - format: int32 + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + parameters: *ref_1 post: - description: Creates a new node. - operationId: prod_tt_sasportal.nodes.nodes.nodes.create + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.nodes.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3122,7 +3036,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -3130,15 +3044,89 @@ paths: schema: type: string - in: path - name: nodesId1 + name: deploymentsId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: - parameters: *ref_31 + /v1alpha1/nodes/{nodesId}/deployments: + parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.list + description: Lists deployments. + operationId: prod_tt_sasportal.nodes.deployments.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}: + parameters: *ref_1 + get: + description: Returns a requested node. + operationId: prod_tt_sasportal.nodes.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/policies:get: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: prod_tt_sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3154,39 +3142,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:test: + parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.create + description: Returns permissions that a caller has on the specified resource. + operationId: prod_tt_sasportal.policies.test requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3202,28 +3169,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] + /v1alpha1/policies:set: + parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.nodes.nodes.devices.createSigned + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: prod_tt_sasportal.policies.set requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3239,23 +3198,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}: - parameters: *ref_31 - get: - description: Returns a requested node. - operationId: prod_tt_sasportal.nodes.get + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/customers:setupSasAnalytics: + parameters: *ref_1 + post: + description: >- + Setups the a GCP Project to receive SAS Analytics messages via GCP + Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and + BigQuery tables are created automatically as part of this service. + operationId: prod_tt_sasportal.customers.setupSasAnalytics + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3271,18 +3228,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers:listLegacyOrganizations: + parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.deployments.get + description: Returns a list of legacy organizations. + operationId: prod_tt_sasportal.customers.listLegacyOrganizations security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3298,23 +3250,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: - parameters: *ref_31 - patch: - description: Updates a device. - operationId: prod_tt_sasportal.deployments.devices.patch + $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' + parameters: [] + /v1alpha1/customers:provisionDeployment: + parameters: *ref_1 + post: + description: >- + Creates a new SAS deployment through the GCP workflow. Creates a SAS + organization if an organization match is not found. + operationId: prod_tt_sasportal.customers.provisionDeployment requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3330,26 +3279,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.deployments.devices.delete + $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' + parameters: [] + /v1alpha1/customers: + parameters: *ref_1 + get: + description: Returns a list of requested customers. + operationId: prod_tt_sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3365,21 +3301,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListCustomersResponse' parameters: - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: devicesId - required: true + type: integer + format: int32 + - in: query + name: pageToken schema: type: string + /v1alpha1/customers/{customersId}: + parameters: *ref_1 get: - description: Gets details about a device. - operationId: prod_tt_sasportal.deployments.devices.get + description: Returns a requested customer. + operationId: prod_tt_sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3395,28 +3332,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId + name: customersId required: true schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: - parameters: *ref_31 patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.deployments.devices.updateSigned + description: Updates an existing customer. + operationId: prod_tt_sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3432,28 +3362,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: updateMask schema: type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: - parameters: *ref_31 - post: - description: Signs a device. - operationId: prod_tt_sasportal.deployments.devices.signDevice - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + format: google-fieldmask + /v1alpha1/customers:listGcpProjectDeployments: + parameters: *ref_1 + get: + description: >- + Returns a list of SAS deployments associated with current GCP project. + Includes whether SAS analytics has been enabled or not. + operationId: prod_tt_sasportal.customers.listGcpProjectDeployments security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3469,28 +3396,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: - parameters: *ref_31 + $ref: >- + #/components/schemas/SasPortalListGcpProjectDeploymentsResponse + parameters: [] + /v1alpha1/customers:migrateOrganization: + parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.deployments.devices.move + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: prod_tt_sasportal.customers.migrateOrganization requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] + /v1alpha1/customers/{customersId}/devices/{devicesId}: + parameters: *ref_1 + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3506,10 +3450,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: deploymentsId + name: customersId required: true schema: type: string @@ -3518,11 +3462,9 @@ paths: required: true schema: type: string - /v1alpha1/customers: - parameters: *ref_31 - get: - description: Returns a list of requested customers. - operationId: prod_tt_sasportal.customers.list + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3538,27 +3480,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - - in: query - name: pageSize + - in: path + name: customersId + required: true schema: - type: integer - format: int32 - - in: query - name: pageToken + type: string + - in: path + name: devicesId + required: true schema: type: string - /v1alpha1/customers/{customersId}: - parameters: *ref_31 patch: - description: Updates an existing customer. - operationId: prod_tt_sasportal.customers.patch + description: Updates a device. + operationId: prod_tt_sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3574,21 +3515,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId required: true schema: type: string + - in: path + name: devicesId + required: true + schema: + type: string - in: query name: updateMask schema: type: string format: google-fieldmask - get: - description: Returns a requested customer. - operationId: prod_tt_sasportal.customers.get + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: prod_tt_sasportal.customers.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3604,48 +3557,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers:setupSasAnalytics: - parameters: *ref_31 - post: - description: >- - Setups the a GCP Project to receive SAS Analytics messages via GCP - Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and - BigQuery tables are created automatically as part of this service. - operationId: prod_tt_sasportal.customers.setupSasAnalytics + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.customers.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSetupSasAnalyticsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers:listLegacyOrganizations: - parameters: *ref_31 - get: - description: Returns a list of legacy organizations. - operationId: prod_tt_sasportal.customers.listLegacyOrganizations + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3661,20 +3594,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' - parameters: [] - /v1alpha1/customers:provisionDeployment: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices: + parameters: *ref_1 post: - description: >- - Creates a new SAS deployment through the GCP workflow. Creates a SAS - organization if an organization match is not found. - operationId: prod_tt_sasportal.customers.provisionDeployment + description: Creates a device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3690,22 +3631,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' - parameters: [] - /v1alpha1/customers:migrateOrganization: - parameters: *ref_31 - post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: prod_tt_sasportal.customers.migrateOrganization - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + get: + description: Lists devices under a node or customer. + operationId: prod_tt_sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3721,15 +3656,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers:listGcpProjectDeployments: - parameters: *ref_31 - get: - description: >- - Returns a list of SAS deployments associated with current GCP project. - Includes whether SAS analytics has been enabled or not. - operationId: prod_tt_sasportal.customers.listGcpProjectDeployments + $ref: '#/components/schemas/SasPortalListDevicesResponse' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3745,19 +3701,23 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/SasPortalListGcpProjectDeploymentsResponse - parameters: [] - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: - parameters: *ref_31 - patch: - description: Updates an existing deployment. - operationId: prod_tt_sasportal.customers.deployments.patch + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.customers.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3773,7 +3733,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -3781,18 +3741,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: devicesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Returns a requested deployment. - operationId: prod_tt_sasportal.customers.deployments.get + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: + parameters: *ref_1 + post: + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.nodes.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3808,7 +3770,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -3816,13 +3778,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - delete: - description: Deletes a deployment. - operationId: prod_tt_sasportal.customers.deployments.delete + get: + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3838,23 +3800,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize schema: - type: string - /v1alpha1/customers/{customersId}/deployments: - parameters: *ref_31 + type: integer + format: int32 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + parameters: *ref_1 get: description: Lists deployments. - operationId: prod_tt_sasportal.customers.deployments.list + operationId: prod_tt_sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3877,6 +3852,15 @@ paths: required: true schema: type: string + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string - in: query name: filter schema: @@ -3886,13 +3870,9 @@ paths: schema: type: integer format: int32 - - in: query - name: pageToken - schema: - type: string post: description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.deployments.create + operationId: prod_tt_sasportal.customers.nodes.deployments.create requestBody: content: application/json: @@ -3920,16 +3900,21 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: - parameters: *ref_31 + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 post: - description: Moves a deployment under another node or customer. - operationId: prod_tt_sasportal.customers.deployments.move + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3945,7 +3930,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3953,15 +3938,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + parameters: *ref_1 post: description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.create + operationId: prod_tt_sasportal.customers.nodes.devices.create requestBody: content: application/json: @@ -3990,13 +3975,13 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string get: description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.list + operationId: prod_tt_sasportal.customers.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4020,7 +4005,7 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string @@ -4037,16 +4022,54 @@ paths: name: filter schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/nodes: + parameters: *ref_1 + get: + description: Lists nodes. + operationId: prod_tt_sasportal.customers.nodes.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalListNodesResponse' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.deployments.devices.createSigned + description: Creates a new node. + operationId: prod_tt_sasportal.customers.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4062,28 +4085,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: deploymentsId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: prod_tt_sasportal.customers.devices.move + description: Moves a node under another node or customer. + operationId: prod_tt_sasportal.customers.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4107,15 +4125,15 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/nodes/{nodesId}: + parameters: *ref_1 get: - description: Gets details about a device. - operationId: prod_tt_sasportal.customers.devices.get + description: Returns a requested node. + operationId: prod_tt_sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4131,7 +4149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -4139,18 +4157,13 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - patch: - description: Updates a device. - operationId: prod_tt_sasportal.customers.devices.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + delete: + description: Deletes a node. + operationId: prod_tt_sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4166,7 +4179,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -4174,18 +4187,18 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: prod_tt_sasportal.customers.devices.delete + patch: + description: Updates an existing node. + operationId: prod_tt_sasportal.customers.nodes.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4201,7 +4214,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -4209,15 +4222,20 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: - parameters: *ref_31 + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 post: description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.create + operationId: prod_tt_sasportal.customers.deployments.devices.create requestBody: content: application/json: @@ -4245,9 +4263,14 @@ paths: required: true schema: type: string + - in: path + name: deploymentsId + required: true + schema: + type: string get: description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.devices.list + operationId: prod_tt_sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4270,6 +4293,15 @@ paths: required: true schema: type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string - in: query name: pageToken schema: @@ -4279,20 +4311,16 @@ paths: schema: type: integer format: int32 - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 post: - description: Signs a device. - operationId: prod_tt_sasportal.customers.devices.signDevice + description: Creates a signed device under a node or customer. + operationId: prod_tt_sasportal.customers.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4308,7 +4336,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -4316,20 +4344,20 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: - parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: prod_tt_sasportal.customers.devices.updateSigned + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: prod_tt_sasportal.customers.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4345,7 +4373,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -4353,20 +4381,15 @@ paths: schema: type: string - in: path - name: devicesId + name: deploymentsId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices:createSigned: - parameters: *ref_31 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.devices.createSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Returns a requested deployment. + operationId: prod_tt_sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4382,18 +4405,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes: - parameters: *ref_31 - get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.list + - in: path + name: deploymentsId + required: true + schema: + type: string + delete: + description: Deletes a deployment. + operationId: prod_tt_sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4409,34 +4435,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + required: true schema: type: string - - in: query - name: filter + - in: path + name: deploymentsId + required: true schema: type: string - post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.create + patch: + description: Updates an existing deployment. + operationId: prod_tt_sasportal.customers.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4452,18 +4470,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}: - parameters: *ref_31 + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/customers/{customersId}/deployments: + parameters: *ref_1 get: - description: Returns a requested node. - operationId: prod_tt_sasportal.customers.nodes.get + description: Lists deployments. + operationId: prod_tt_sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4479,26 +4507,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: nodesId - required: true + - in: query + name: pageToken schema: type: string - patch: - description: Updates an existing node. - operationId: prod_tt_sasportal.customers.nodes.patch + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + post: + description: Creates a new deployment. + operationId: prod_tt_sasportal.customers.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4514,26 +4550,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: nodesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a node. - operationId: prod_tt_sasportal.customers.nodes.delete + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + parameters: *ref_1 + get: + description: Gets details about a device. + operationId: prod_tt_sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4549,28 +4577,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: - parameters: *ref_31 - post: - description: Moves a node under another node or customer. - operationId: prod_tt_sasportal.customers.nodes.move + patch: + description: Updates a device. + operationId: prod_tt_sasportal.deployments.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4586,23 +4612,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: - parameters: *ref_31 - get: - description: Lists devices under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.list + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: prod_tt_sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4618,39 +4647,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.create + description: Signs a device. + operationId: prod_tt_sasportal.deployments.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4666,28 +4684,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: - parameters: *ref_31 - post: - description: Creates a signed device under a node or customer. - operationId: prod_tt_sasportal.customers.nodes.devices.createSigned + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: prod_tt_sasportal.deployments.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4706,25 +4724,25 @@ paths: $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: - parameters: *ref_31 + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + parameters: *ref_1 post: - description: Creates a new node. - operationId: prod_tt_sasportal.customers.nodes.nodes.create + description: Moves a device under another node or customer. + operationId: prod_tt_sasportal.deployments.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4740,21 +4758,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path - name: customersId + name: deploymentsId required: true schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string + /v1alpha1/deployments/{deploymentsId}: + parameters: *ref_1 get: - description: Lists nodes. - operationId: prod_tt_sasportal.customers.nodes.nodes.list + description: Returns a requested deployment. + operationId: prod_tt_sasportal.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4770,41 +4790,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: - parameters: *ref_31 + /v1alpha1/installer:validate: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: prod_tt_sasportal.customers.nodes.deployments.create + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: prod_tt_sasportal.installer.validate requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4820,21 +4822,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - get: - description: Lists deployments. - operationId: prod_tt_sasportal.customers.nodes.deployments.list + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/installer:generateSecret: + parameters: *ref_1 + post: + description: Generates a secret to be used with the ValidateInstaller. + operationId: prod_tt_sasportal.installer.generateSecret + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4850,28 +4849,5 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] diff --git a/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml b/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml index 9bb39614..a04d9469 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/publicca.yaml @@ -10,8 +10,8 @@ info: external account binding keys associated with Google Trust Services' publicly trusted certificate authority. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/public-certificate-authority/docs servers: @@ -164,6 +164,7 @@ components: - $ref: >- #/components/x-stackQL-resources/external_account_keys/methods/create update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/externalAccountKeys: diff --git a/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml b/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml index b88f0972..8f41b9c8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pubsub.yaml @@ -9,8 +9,8 @@ info: Provides reliable, many-to-many, asynchronous messaging between applications. version: v1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240903' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/pubsub/docs servers: @@ -968,6 +968,13 @@ components: - STATE_UNSPECIFIED - ACTIVE - RESOURCE_ERROR + analyticsHubSubscriptionInfo: + description: >- + Output only. Information about the associated Analytics Hub + subscription. Only set if the subscritpion is created by Analytics + Hub. + readOnly: true + $ref: '#/components/schemas/AnalyticsHubSubscriptionInfo' PushConfig: id: PushConfig description: Configuration for a push delivery endpoint. @@ -1192,6 +1199,12 @@ components: than the limit. type: string format: int64 + maxMessages: + description: >- + Optional. The maximum number of messages that can be written to a + Cloud Storage file before a new file is created. Min 1000 messages. + type: string + format: int64 state: description: >- Output only. An output-only field that indicates whether or not the @@ -1254,6 +1267,11 @@ components: properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map. type: boolean + useTopicSchema: + description: >- + Optional. When true, the output Cloud Storage file will be + serialized using the topic schema, if it exists. + type: boolean ExpirationPolicy: id: ExpirationPolicy description: >- @@ -1331,6 +1349,25 @@ components: to 600 seconds. type: string format: google-duration + AnalyticsHubSubscriptionInfo: + id: AnalyticsHubSubscriptionInfo + description: >- + Information about an associated Analytics Hub subscription + (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions). + type: object + properties: + listing: + description: >- + Optional. The name of the associated Analytics Hub listing resource. + Pattern: + "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}" + type: string + subscription: + description: >- + Optional. The name of the associated Analytics Hub subscription + resource. Pattern: + "projects/{project}/locations/{location}/subscriptions/{subscription}" + type: string UpdateSubscriptionRequest: id: UpdateSubscriptionRequest description: Request for the UpdateSubscription method. @@ -1693,17 +1730,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_topics_get_iam_policy: - operation: &ref_1 + projects_topics_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1topics~1{topicsId}:getIamPolicy/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_topics_get_iam_policy: - operation: *ref_1 - response: *ref_2 projects_topics_test_iam_permissions: operation: $ref: >- @@ -1717,6 +1751,9 @@ components: #/components/x-stackQL-resources/topics_iam_policies/methods/projects_topics_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/topics_iam_policies/methods/projects_topics_set_iam_policy delete: [] topics: id: google.pubsub.topics @@ -1754,16 +1791,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_topics_list: - operation: &ref_3 + projects_topics_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1topics/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.topics - projects_topics_list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: >- @@ -1774,6 +1808,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/topics/methods/projects_topics_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/topics/methods/projects_topics_delete @@ -1782,17 +1817,14 @@ components: name: subscriptions title: Subscriptions methods: - _projects_topics_subscriptions_list: - operation: &ref_5 + projects_topics_subscriptions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1topics~1{topicsId}~1subscriptions/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.subscriptions - projects_topics_subscriptions_list: - operation: *ref_5 - response: *ref_6 projects_subscriptions_detach: operation: $ref: >- @@ -1828,16 +1860,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_subscriptions_list: - operation: &ref_7 + projects_subscriptions_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1subscriptions/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.subscriptions - projects_subscriptions_list: - operation: *ref_7 - response: *ref_8 projects_subscriptions_modify_ack_deadline: operation: $ref: >- @@ -1885,6 +1914,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/projects_subscriptions_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/projects_subscriptions_delete @@ -1893,17 +1923,14 @@ components: name: snapshots title: Snapshots methods: - _projects_topics_snapshots_list: - operation: &ref_9 + projects_topics_snapshots_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1topics~1{topicsId}~1snapshots/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.snapshots - projects_topics_snapshots_list: - operation: *ref_9 - response: *ref_10 projects_snapshots_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1snapshots~1{snapshotsId}/get' @@ -1930,16 +1957,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_snapshots_list: - operation: &ref_11 + projects_snapshots_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1snapshots/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.snapshots - projects_snapshots_list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: >- @@ -1952,6 +1976,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/snapshots/methods/projects_snapshots_delete @@ -1967,17 +1992,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_subscriptions_get_iam_policy: - operation: &ref_13 + projects_subscriptions_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1subscriptions~1{subscriptionsId}:getIamPolicy/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_subscriptions_get_iam_policy: - operation: *ref_13 - response: *ref_14 projects_subscriptions_test_iam_permissions: operation: $ref: >- @@ -1991,6 +2013,9 @@ components: #/components/x-stackQL-resources/subscriptions_iam_policies/methods/projects_subscriptions_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/subscriptions_iam_policies/methods/projects_subscriptions_set_iam_policy delete: [] snapshots_iam_policies: id: google.pubsub.snapshots_iam_policies @@ -2004,17 +2029,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_snapshots_get_iam_policy: - operation: &ref_15 + projects_snapshots_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1snapshots~1{snapshotsId}:getIamPolicy/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_snapshots_get_iam_policy: - operation: *ref_15 - response: *ref_16 projects_snapshots_test_iam_permissions: operation: $ref: >- @@ -2028,6 +2050,9 @@ components: #/components/x-stackQL-resources/snapshots_iam_policies/methods/projects_snapshots_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/snapshots_iam_policies/methods/projects_snapshots_set_iam_policy delete: [] schemas_iam_policies: id: google.pubsub.schemas_iam_policies @@ -2041,17 +2066,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_schemas_get_iam_policy: - operation: &ref_17 + projects_schemas_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1schemas~1{schemasId}:getIamPolicy/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_schemas_get_iam_policy: - operation: *ref_17 - response: *ref_18 projects_schemas_test_iam_permissions: operation: $ref: >- @@ -2065,6 +2087,9 @@ components: #/components/x-stackQL-resources/schemas_iam_policies/methods/projects_schemas_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/schemas_iam_policies/methods/projects_schemas_set_iam_policy delete: [] schemas: id: google.pubsub.schemas @@ -2077,16 +2102,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_schemas_list: - operation: &ref_19 + projects_schemas_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1schemas/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.schemas - projects_schemas_list: - operation: *ref_19 - response: *ref_20 projects_schemas_get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1schemas~1{schemasId}/get' @@ -2135,6 +2157,7 @@ components: - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_schemas_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/schemas/methods/projects_schemas_delete @@ -2143,23 +2166,21 @@ components: name: schemas_revisions title: Schemas_revisions methods: - _projects_schemas_list_revisions: - operation: &ref_21 + projects_schemas_list_revisions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1schemas~1{schemasId}:listRevisions/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.schemas - projects_schemas_list_revisions: - operation: *ref_21 - response: *ref_22 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/schemas_revisions/methods/projects_schemas_list_revisions insert: [] update: [] + replace: [] delete: [] schemas_revision: id: google.pubsub.schemas_revision @@ -2177,12 +2198,13 @@ components: select: [] insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/schemas_revision/methods/projects_schemas_delete_revision paths: /v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy: - parameters: &ref_23 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2233,7 +2255,7 @@ paths: schema: type: string /v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2272,7 +2294,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2314,7 +2336,7 @@ paths: schema: type: string /v1/projects/{projectsId}/topics/{topicsId}: - parameters: *ref_23 + parameters: *ref_1 put: description: >- Creates the given topic with the given name. See the [resource name @@ -2456,7 +2478,7 @@ paths: schema: type: string /v1/projects/{projectsId}/topics/{topicsId}:publish: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic @@ -2495,7 +2517,7 @@ paths: schema: type: string /v1/projects/{projectsId}/topics: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists matching topics. operationId: pubsub.projects.topics.list @@ -2531,7 +2553,7 @@ paths: schema: type: string /v1/projects/{projectsId}/topics/{topicsId}/subscriptions: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists the names of the attached subscriptions on this topic. operationId: pubsub.projects.topics.subscriptions.list @@ -2572,7 +2594,7 @@ paths: schema: type: string /v1/projects/{projectsId}/topics/{topicsId}/snapshots: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Lists the names of the snapshots on this topic. Snapshots are used in @@ -2618,7 +2640,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2658,7 +2680,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2697,7 +2719,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2739,7 +2761,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:detach: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Detaches a subscription from this topic. All messages retained in the @@ -2775,7 +2797,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}: - parameters: *ref_23 + parameters: *ref_1 put: description: >- Creates a subscription to a given topic. See the [resource name rules] @@ -2925,7 +2947,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists matching subscriptions. operationId: pubsub.projects.subscriptions.list @@ -2961,7 +2983,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Modifies the ack deadline for a specific message. This method is useful @@ -3003,7 +3025,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Acknowledges the messages associated with the `ack_ids` in the @@ -3046,7 +3068,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull: - parameters: *ref_23 + parameters: *ref_1 post: description: Pulls messages from the server. operationId: pubsub.projects.subscriptions.pull @@ -3083,7 +3105,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Modifies the `PushConfig` for a specified subscription. This may be used @@ -3125,7 +3147,7 @@ paths: schema: type: string /v1/projects/{projectsId}/subscriptions/{subscriptionsId}:seek: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Seeks an existing subscription to a point in time or to a given @@ -3169,7 +3191,7 @@ paths: schema: type: string /v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3209,7 +3231,7 @@ paths: schema: type: string /v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3248,7 +3270,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3290,7 +3312,7 @@ paths: schema: type: string /v1/projects/{projectsId}/snapshots/{snapshotsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the configuration details of a snapshot. Snapshots are used in @@ -3458,7 +3480,7 @@ paths: schema: type: string /v1/projects/{projectsId}/snapshots: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Lists the existing snapshots. Snapshots are used in [Seek]( @@ -3499,7 +3521,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas/{schemasId}:setIamPolicy: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3539,7 +3561,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas/{schemasId}:getIamPolicy: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3578,7 +3600,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/schemas/{schemasId}:testIamPermissions: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -3620,7 +3642,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates a schema. operationId: pubsub.projects.schemas.create @@ -3694,7 +3716,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas/{schemasId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a schema. operationId: pubsub.projects.schemas.get @@ -3760,7 +3782,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas/{schemasId}:listRevisions: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists all schema revisions for the named schema. operationId: pubsub.projects.schemas.listRevisions @@ -3805,7 +3827,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas/{schemasId}:commit: - parameters: *ref_23 + parameters: *ref_1 post: description: Commits a new schema revision to an existing schema. operationId: pubsub.projects.schemas.commit @@ -3842,7 +3864,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas/{schemasId}:rollback: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Creates a new schema revision that is a copy of the provided @@ -3881,7 +3903,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas/{schemasId}:deleteRevision: - parameters: *ref_23 + parameters: *ref_1 delete: description: Deletes a specific schema revision. operationId: pubsub.projects.schemas.deleteRevision @@ -3917,7 +3939,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas:validate: - parameters: *ref_23 + parameters: *ref_1 post: description: Validates a schema. operationId: pubsub.projects.schemas.validate @@ -3949,7 +3971,7 @@ paths: schema: type: string /v1/projects/{projectsId}/schemas:validateMessage: - parameters: *ref_23 + parameters: *ref_1 post: description: Validates a message against a schema. operationId: pubsub.projects.schemas.validateMessage diff --git a/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml b/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml index 154ed5a9..50b7212a 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/pubsublite.yaml @@ -7,8 +7,8 @@ info: title: Pub/Sub Lite API description: '' version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/pubsub/lite/docs servers: @@ -795,17 +795,14 @@ components: name: operations title: Operations methods: - _admin_projects_locations_operations_list: - operation: &ref_1 + admin_projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1admin~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - admin_projects_locations_operations_list: - operation: *ref_1 - response: *ref_2 admin_projects_locations_operations_get: operation: $ref: >- @@ -835,6 +832,7 @@ components: #/components/x-stackQL-resources/operations/methods/admin_projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/admin_projects_locations_operations_delete @@ -850,17 +848,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _admin_projects_locations_topics_list: - operation: &ref_3 + admin_projects_locations_topics_list: + operation: $ref: >- #/paths/~1v1~1admin~1projects~1{projectsId}~1locations~1{locationsId}~1topics/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.topics - admin_projects_locations_topics_list: - operation: *ref_3 - response: *ref_4 admin_projects_locations_topics_get: operation: $ref: >- @@ -882,17 +877,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _admin_projects_locations_reservations_topics_list: - operation: &ref_5 + admin_projects_locations_reservations_topics_list: + operation: $ref: >- #/paths/~1v1~1admin~1projects~1{projectsId}~1locations~1{locationsId}~1reservations~1{reservationsId}~1topics/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.topics - admin_projects_locations_reservations_topics_list: - operation: *ref_5 - response: *ref_6 topic_stats_projects_locations_topics_compute_message_stats: operation: $ref: >- @@ -928,6 +920,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/topics/methods/admin_projects_locations_topics_delete @@ -949,23 +942,21 @@ components: #/components/x-stackQL-resources/topics_partitions/methods/admin_projects_locations_topics_get_partitions insert: [] update: [] + replace: [] delete: [] subscriptions: id: google.pubsublite.subscriptions name: subscriptions title: Subscriptions methods: - _admin_projects_locations_topics_subscriptions_list: - operation: &ref_7 + admin_projects_locations_topics_subscriptions_list: + operation: $ref: >- #/paths/~1v1~1admin~1projects~1{projectsId}~1locations~1{locationsId}~1topics~1{topicsId}~1subscriptions/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.subscriptions - admin_projects_locations_topics_subscriptions_list: - operation: *ref_7 - response: *ref_8 admin_projects_locations_subscriptions_create: operation: $ref: >- @@ -973,17 +964,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _admin_projects_locations_subscriptions_list: - operation: &ref_9 + admin_projects_locations_subscriptions_list: + operation: $ref: >- #/paths/~1v1~1admin~1projects~1{projectsId}~1locations~1{locationsId}~1subscriptions/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.subscriptions - admin_projects_locations_subscriptions_list: - operation: *ref_9 - response: *ref_10 admin_projects_locations_subscriptions_get: operation: $ref: >- @@ -1033,6 +1021,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/subscriptions/methods/admin_projects_locations_subscriptions_delete @@ -1048,17 +1037,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _admin_projects_locations_reservations_list: - operation: &ref_11 + admin_projects_locations_reservations_list: + operation: $ref: >- #/paths/~1v1~1admin~1projects~1{projectsId}~1locations~1{locationsId}~1reservations/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.reservations - admin_projects_locations_reservations_list: - operation: *ref_11 - response: *ref_12 admin_projects_locations_reservations_get: operation: $ref: >- @@ -1092,6 +1078,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/reservations/methods/admin_projects_locations_reservations_delete @@ -1100,27 +1087,25 @@ components: name: cursors title: Cursors methods: - _cursor_projects_locations_subscriptions_cursors_list: - operation: &ref_13 + cursor_projects_locations_subscriptions_cursors_list: + operation: $ref: >- #/paths/~1v1~1cursor~1projects~1{projectsId}~1locations~1{locationsId}~1subscriptions~1{subscriptionsId}~1cursors/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.partitionCursors - cursor_projects_locations_subscriptions_cursors_list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/cursors/methods/cursor_projects_locations_subscriptions_cursors_list insert: [] update: [] + replace: [] delete: [] paths: /v1/admin/projects/{projectsId}/locations/{locationsId}/operations: - parameters: &ref_15 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1174,7 +1159,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1245,7 +1230,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1292,7 +1277,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/topics: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new topic. operationId: pubsublite.admin.projects.locations.topics.create @@ -1364,7 +1349,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/topics/{topicsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Returns the topic configuration. operationId: pubsublite.admin.projects.locations.topics.get @@ -1469,7 +1454,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/topics/{topicsId}/partitions: - parameters: *ref_15 + parameters: *ref_1 get: description: Returns the partition information for the requested topic. operationId: pubsublite.admin.projects.locations.topics.getPartitions @@ -1502,7 +1487,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/topics/{topicsId}/subscriptions: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists the subscriptions attached to the specified topic. operationId: pubsublite.admin.projects.locations.topics.subscriptions.list @@ -1544,7 +1529,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/subscriptions: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new subscription. operationId: pubsublite.admin.projects.locations.subscriptions.create @@ -1620,7 +1605,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Returns the subscription configuration. operationId: pubsublite.admin.projects.locations.subscriptions.get @@ -1725,7 +1710,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:seek: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Performs an out-of-band seek for a subscription to a specified target, @@ -1780,7 +1765,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/reservations: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new reservation. operationId: pubsublite.admin.projects.locations.reservations.create @@ -1852,7 +1837,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Returns the reservation configuration. operationId: pubsublite.admin.projects.locations.reservations.get @@ -1957,7 +1942,7 @@ paths: schema: type: string /v1/admin/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/topics: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists the topics attached to the specified reservation. operationId: pubsublite.admin.projects.locations.reservations.topics.list @@ -1999,7 +1984,7 @@ paths: schema: type: string /v1/cursor/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:commitCursor: - parameters: *ref_15 + parameters: *ref_1 post: description: Updates the committed cursor. operationId: pubsublite.cursor.projects.locations.subscriptions.commitCursor @@ -2037,7 +2022,7 @@ paths: schema: type: string /v1/cursor/projects/{projectsId}/locations/{locationsId}/subscriptions/{subscriptionsId}/cursors: - parameters: *ref_15 + parameters: *ref_1 get: description: Returns all committed cursor information for a subscription. operationId: pubsublite.cursor.projects.locations.subscriptions.cursors.list @@ -2079,7 +2064,7 @@ paths: schema: type: string /v1/topicStats/projects/{projectsId}/locations/{locationsId}/topics/{topicsId}:computeMessageStats: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Compute statistics about a range of messages in a given topic and @@ -2119,7 +2104,7 @@ paths: schema: type: string /v1/topicStats/projects/{projectsId}/locations/{locationsId}/topics/{topicsId}:computeHeadCursor: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Compute the head cursor for the partition. The head cursor's offset is @@ -2162,7 +2147,7 @@ paths: schema: type: string /v1/topicStats/projects/{projectsId}/locations/{locationsId}/topics/{topicsId}:computeTimeCursor: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Compute the corresponding cursor for a publish or event time in a topic diff --git a/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml b/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml index fad449da..c0a2f2d4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/rapidmigrationassessment.yaml @@ -9,8 +9,8 @@ info: The Rapid Migration Assessment service is our first-party migration assessment and planning tool. version: v1 - x-discovery-doc-revision: '20240510' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/migration-center servers: @@ -540,16 +540,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -562,23 +559,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.rapidmigrationassessment.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -606,6 +601,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' collectors: @@ -620,17 +616,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1collectors/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.collectors - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -681,6 +674,7 @@ components: - $ref: '#/components/x-stackQL-resources/collectors/methods/create' update: - $ref: '#/components/x-stackQL-resources/collectors/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/collectors/methods/delete' annotations: @@ -708,10 +702,11 @@ components: insert: - $ref: '#/components/x-stackQL-resources/annotations/methods/create' update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -758,7 +753,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets information about a location. operationId: rapidmigrationassessment.projects.locations.get @@ -786,7 +781,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -829,7 +824,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -900,7 +895,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -947,7 +942,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collectors: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Create a Collector to manage the on-prem appliance which collects @@ -1033,7 +1028,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets details of a single Collector. operationId: rapidmigrationassessment.projects.locations.collectors.get @@ -1148,7 +1143,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}:resume: - parameters: *ref_7 + parameters: *ref_1 post: description: Resumes the given collector. operationId: rapidmigrationassessment.projects.locations.collectors.resume @@ -1186,7 +1181,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}:register: - parameters: *ref_7 + parameters: *ref_1 post: description: Registers the given collector. operationId: rapidmigrationassessment.projects.locations.collectors.register @@ -1224,7 +1219,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}:pause: - parameters: *ref_7 + parameters: *ref_1 post: description: Pauses the given collector. operationId: rapidmigrationassessment.projects.locations.collectors.pause @@ -1262,7 +1257,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/annotations: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates an Annotation operationId: rapidmigrationassessment.projects.locations.annotations.create @@ -1299,7 +1294,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/annotations/{annotationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets details of a single Annotation. operationId: rapidmigrationassessment.projects.locations.annotations.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml index 515b2763..202efbd4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recaptchaenterprise.yaml @@ -9,8 +9,8 @@ info: Help protect your website from fraudulent activity, spam, and abuse without creating friction. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/recaptcha-enterprise/ servers: @@ -36,271 +36,263 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: - description: >- - A redirect action returns a 307 (temporary redirect) response, pointing - the user to a ReCaptcha interstitial page to attach a token. + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: + id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse + type: object + properties: + relatedAccountGroups: + type: array + description: The groups of related accounts listed by the query. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + nextPageToken: + description: >- + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + type: string + description: The response to a `ListRelatedAccountGroups` call. + GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse: + type: object + description: Response for AddIpOverride. + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse properties: {} + GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: + id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + type: object + properties: {} + description: >- + A block action serves an HTTP error code a prevents the request from + hitting the backend. + GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - GoogleCloudRecaptchaenterpriseV1Event: properties: - headers: + cardLabels: + description: Output only. The labels for the payment card in this transaction. type: array + readOnly: true items: type: string - description: Optional. HTTP header information about the request. - hashedAccountId: - type: string - deprecated: true - format: byte - description: >- - Optional. Deprecated: use `user_info.account_id` instead. Unique - stable hashed user identifier for the request. The identifier must - be hashed using hmac-sha256 with stable secret. - fraudPrevention: - enum: - - FRAUD_PREVENTION_UNSPECIFIED - - ENABLED - - DISABLED - description: Optional. The Fraud Prevention setting for this assessment. - enumDescriptions: - - >- - Default, unspecified setting. If opted in for automatic detection, - `fraud_prevention_assessment` is returned based on the request. - Otherwise, `fraud_prevention_assessment` is returned if - `transaction_data` is present in the `Event` and Fraud Prevention - is enabled in the Google Cloud console. - - >- - Enable Fraud Prevention for this assessment, if Fraud Prevention - is enabled in the Google Cloud console. - - >- - Disable Fraud Prevention for this assessment, regardless of opt-in - status or Google Cloud console settings. + enum: + - CARD_LABEL_UNSPECIFIED + - PREPAID + - VIRTUAL + - UNEXPECTED_LOCATION + enumDescriptions: + - No label specified. + - This card has been detected as prepaid. + - >- + This card has been detected as virtual, such as a card number + generated for a single transaction or merchant. + - >- + This card has been detected as being used in an unexpected + geographic location. + description: Signals describing the payment card used in this transaction. + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + GoogleCloudRecaptchaenterpriseV1UserId: + properties: + email: type: string - userInfo: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' - description: >- - Optional. Information about the user that generates this event, when - they can be identified. They are often identified through the use of - an account for logged-in requests or login/registration requests, or - by providing user identifiers for guest actions like checkout. - firewallPolicyEvaluation: - type: boolean - description: >- - Optional. Flag for enabling firewall policy config assessment. If - this flag is enabled, the firewall policy will be evaluated and a - suggested firewall action will be returned in the response. - express: - type: boolean - description: >- - Optional. Flag for a reCAPTCHA express request for an assessment - without a token. If enabled, `site_key` must reference a SCORE key - with WAF feature set to EXPRESS. - ja3: + description: Optional. An email address. + username: type: string - description: Optional. JA3 fingerprint for SSL clients. - transactionData: description: >- - Optional. Data describing a payment transaction to be assessed. - Sending this data enables reCAPTCHA Enterprise Fraud Prevention and - the FraudPreventionAssessment component in the response. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' - expectedAction: + Optional. A unique username, if different from all the other + identifiers and `account_id` that are provided. Can be a unique + login handle or display name for a user. + phoneNumber: + description: Optional. A phone number. Should use the E.164 format. type: string + id: GoogleCloudRecaptchaenterpriseV1UserId + type: object + description: An identifier associated with a user. + GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + type: object + properties: + emailVerified: description: >- - Optional. The expected action for this type of event. This should be - the same action provided at token generation time on client-side - platforms already integrated with recaptcha enterprise. - wafTokenAssessment: + Optional. Whether the email has been verified to be accessible by + the user (OTP or similar). type: boolean - description: >- - Optional. Flag for running WAF token assessment. If enabled, the - token must be specified, and have been created by a WAF-enabled key. - userIpAddress: - description: >- - Optional. The IP address in the request from the user's device - related to this event. - type: string - requestedUri: + phoneNumber: type: string - description: >- - Optional. The URI resource the user requested that triggered an - assessment. - siteKey: + description: Optional. The phone number of the user, with country code. + email: + description: Optional. The email address of the user. type: string - description: >- - Optional. The site key that was used to invoke reCAPTCHA Enterprise - on your site and generate the token. - userAgent: + creationMs: + description: Optional. The epoch milliseconds of the user's account creation. + format: int64 type: string + accountId: description: >- - Optional. The user agent present in the request from the user's - device related to this event. - token: + Optional. Unique account identifier for this user. If using account + defender, this should match the hashed_account_id field. Otherwise, + a unique and persistent identifier for this account. type: string + phoneVerified: description: >- - Optional. The user response token provided by the reCAPTCHA - Enterprise client-side integration on your site. + Optional. Whether the phone number has been verified to be + accessible by the user (OTP or similar). + type: boolean + description: Details about a user's account involved in the transaction. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser + GoogleCloudRecaptchaenterpriseV1IpOverrideData: type: object - description: The event being assessed. - id: GoogleCloudRecaptchaenterpriseV1Event - GoogleCloudRecaptchaenterpriseV1TransactionEvent: properties: - value: - format: double - type: number + ip: description: >- - Optional. The value that corresponds with this transaction event, if - one exists. For example, a refund event where $5.00 was refunded. - Currency is obtained from the original transaction data. - eventTime: - format: google-datetime + Required. The IP address to override (can be IPv4, IPv6 or CIDR). + The IP override must be a valid IPv4 or IPv6 address, or a CIDR + range. The IP override must be a public IP address. Example of IPv4: + 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B + Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: + 2001:0DB8:1234::/48 type: string - description: >- - Optional. Timestamp when this transaction event occurred; otherwise - assumed to be the time of the API call. - reason: + overrideType: + enumDescriptions: + - >- + Default override type that indicates this enum hasn't been + specified. + - >- + Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 + for all valid assessments. + enum: + - OVERRIDE_TYPE_UNSPECIFIED + - ALLOW type: string + description: Required. Describes the type of IP override. + description: Information about the IP or IP range override. + id: GoogleCloudRecaptchaenterpriseV1IpOverrideData + GoogleCloudRecaptchaenterpriseV1TestingOptions: + properties: + testingScore: description: >- - Optional. The reason or standardized code that corresponds with this - transaction event, if one exists. For example, a CHARGEBACK event - with code 6005. - eventType: + Optional. All assessments for this Key return this score. Must be + between 0 (likely not legitimate) and 1 (likely legitimate) + inclusive. + format: float + type: number + testingChallenge: enum: - - TRANSACTION_EVENT_TYPE_UNSPECIFIED - - MERCHANT_APPROVE - - MERCHANT_DENY - - MANUAL_REVIEW - - AUTHORIZATION - - AUTHORIZATION_DECLINE - - PAYMENT_CAPTURE - - PAYMENT_CAPTURE_DECLINE - - CANCEL - - CHARGEBACK_INQUIRY - - CHARGEBACK_ALERT - - FRAUD_NOTIFICATION - - CHARGEBACK - - CHARGEBACK_REPRESENTMENT - - CHARGEBACK_REVERSE - - REFUND_REQUEST - - REFUND_DECLINE - - REFUND - - REFUND_REVERSE + - TESTING_CHALLENGE_UNSPECIFIED + - NOCAPTCHA + - UNSOLVABLE_CHALLENGE type: string - description: Optional. The type of this transaction event. enumDescriptions: - - Default, unspecified event type. - - >- - Indicates that the transaction is approved by the merchant. The - accompanying reasons can include terms such as 'INHOUSE', - 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. - - >- - Indicates that the transaction is denied and concluded due to - risks detected by the merchant. The accompanying reasons can - include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or - 'MANUAL_REVIEW'. - - >- - Indicates that the transaction is being evaluated by a human, due - to suspicion or risk. - - >- - Indicates that the authorization attempt with the card issuer - succeeded. - - >- - Indicates that the authorization attempt with the card issuer - failed. The accompanying reasons can include Visa's '54' - indicating that the card is expired, or '82' indicating that the - CVV is incorrect. - - >- - Indicates that the transaction is completed because the funds were - settled. - >- - Indicates that the transaction could not be completed because the - funds were not settled. - - >- - Indicates that the transaction has been canceled. Specify the - reason for the cancellation. For example, - 'INSUFFICIENT_INVENTORY'. + Perform the normal risk analysis and return either nocaptcha or a + challenge depending on risk and trust factors. - >- - Indicates that the merchant has received a chargeback inquiry due - to fraud for the transaction, requesting additional information - before a fraud chargeback is officially issued and a formal - chargeback notification is sent. + Challenge requests for this key always return a nocaptcha, which + does not require a solution. - >- - Indicates that the merchant has received a chargeback alert due to - fraud for the transaction. The process of resolving the dispute - without involving the payment network is started. - - >- - Indicates that a fraud notification is issued for the transaction, - sent by the payment instrument's issuing bank because the - transaction appears to be fraudulent. We recommend including TC40 - or SAFE data in the `reason` field for this event type. For - partial chargebacks, we recommend that you include an amount in - the `value` field. - - >- - Indicates that the merchant is informed by the payment network - that the transaction has entered the chargeback process due to - fraud. Reason code examples include Discover's '6005' and '6041'. - For partial chargebacks, we recommend that you include an amount - in the `value` field. - - >- - Indicates that the transaction has entered the chargeback process - due to fraud, and that the merchant has chosen to enter - representment. Reason examples include Discover's '6005' and - '6041'. For partial chargebacks, we recommend that you include an - amount in the `value` field. - - >- - Indicates that the transaction has had a fraud chargeback which - was illegitimate and was reversed as a result. For partial - chargebacks, we recommend that you include an amount in the - `value` field. - - >- - Indicates that the merchant has received a refund for a completed - transaction. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - - >- - Indicates that the merchant has received a refund request for this - transaction, but that they have declined it. For partial refunds, - we recommend that you include an amount in the `value` field. - Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) - - >- - Indicates that the completed transaction was refunded by the - merchant. For partial refunds, we recommend that you include an - amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial - refund of exempt tax) - - >- - Indicates that the completed transaction was refunded by the - merchant, and that this refund was reversed. For partial refunds, - we recommend that you include an amount in the `value` field. + Challenge requests for this key always return an unsolvable + challenge. + description: >- + Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all + challenge requests for this site return nocaptcha if NOCAPTCHA, or + an unsolvable challenge if CHALLENGE. + id: GoogleCloudRecaptchaenterpriseV1TestingOptions type: object - id: GoogleCloudRecaptchaenterpriseV1TransactionEvent - description: Describes an event in the lifecycle of a payment transaction. - GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: + description: Options for user acceptance testing. + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: type: object + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict properties: - reasons: - description: Output only. Reasons contributing to the SMS toll fraud verdict. - readOnly: true - items: - type: string - enumDescriptions: - - Default unspecified reason - - The provided phone number was invalid - enum: - - SMS_TOLL_FRAUD_REASON_UNSPECIFIED - - INVALID_PHONE_NUMBER - type: array risk: - description: >- - Output only. Probability of an SMS event being fraudulent. Values - are from 0.0 (lowest) to 1.0 (highest). readOnly: true + type: number + description: >- + Output only. Probability of this transaction attempt being part of a + card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). format: float + description: >- + Information about card testing fraud, where an adversary is testing + fraudulently obtained cards or brute forcing their details. + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: + type: object + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse + description: The reorder firewall policies response message. + properties: {} + GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment: + description: >- + The environment creating the assessment. This describes your environment + (the system invoking CreateAssessment), NOT the environment of your + user. + properties: + version: + type: string + description: Optional. The version of the client module. For example, "1.0.0". + client: + type: string + description: >- + Optional. Identifies the client module initiating the + CreateAssessment request. This can be the link to the client + module's project. Examples include: - + "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" + - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - + "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - + "wordpress.org/plugins/recaptcha-something" + type: object + id: GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment + GoogleCloudRecaptchaenterpriseV1WafSettings: + type: object + id: GoogleCloudRecaptchaenterpriseV1WafSettings + properties: + wafFeature: + type: string + enum: + - WAF_FEATURE_UNSPECIFIED + - CHALLENGE_PAGE + - SESSION_TOKEN + - ACTION_TOKEN + - EXPRESS + enumDescriptions: + - Undefined feature. + - Redirects suspicious traffic to reCAPTCHA. + - >- + Use reCAPTCHA session-tokens to protect the whole user session on + the site's domain. + - Use reCAPTCHA action-tokens to protect user actions. + - >- + Use reCAPTCHA WAF express protection to protect any content other + than web pages, like APIs and IoT devices. + description: Required. The WAF feature for which this key is enabled. + wafService: + enum: + - WAF_SERVICE_UNSPECIFIED + - CA + - FASTLY + - CLOUDFLARE + - AKAMAI + description: Required. The WAF service that uses this key. + type: string + enumDescriptions: + - Undefined WAF + - Cloud Armor + - Fastly + - Cloudflare + - Akamai + description: >- + Settings specific to keys that can be used for WAF (Web Application + Firewall). + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: + description: Information about behavioral trust of the transaction. + properties: + trust: type: number - id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict - description: Information about SMS toll fraud. - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + format: float + readOnly: true + description: >- + Output only. Probability of this transaction attempt being executed + in a behaviorally trustworthy way. Values are from 0.0 (lowest) to + 1.0 (highest). + type: object + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: properties: nextPageToken: type: string @@ -308,1552 +300,1594 @@ components: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. relatedAccountGroupMemberships: - description: The memberships listed by the query. + description: The queried memberships. type: array items: $ref: >- #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership id: >- - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse - type: object - description: The response to a `ListRelatedAccountGroupMemberships` call. - GoogleCloudRecaptchaenterpriseV1TestingOptions: - id: GoogleCloudRecaptchaenterpriseV1TestingOptions + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + description: The response to a `SearchRelatedAccountGroupMemberships` call. type: object - description: Options for user acceptance testing. + GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: properties: - testingChallenge: - enumDescriptions: - - >- - Perform the normal risk analysis and return either nocaptcha or a - challenge depending on risk and trust factors. - - >- - Challenge requests for this key always return a nocaptcha, which - does not require a solution. - - >- - Challenge requests for this key always return an unsolvable - challenge. - enum: - - TESTING_CHALLENGE_UNSPECIFIED - - NOCAPTCHA - - UNSOLVABLE_CHALLENGE - type: string + passedCount: description: >- - Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all - challenge requests for this site will return nocaptcha if NOCAPTCHA, - or an unsolvable challenge if CHALLENGE. - testingScore: - type: number - format: float + Count of nocaptchas (successful verification without a challenge) + plus submitted challenge solutions that were correct and resulted in + verification. + format: int64 + type: string + nocaptchaCount: description: >- - Optional. All assessments for this Key will return this score. Must - be between 0 (likely not legitimate) and 1 (likely legitimate) - inclusive. - GoogleCloudRecaptchaenterpriseV1ChallengeMetrics: - description: Metrics related to challenges. - id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics - properties: + Count of nocaptchas (successful verification without a challenge) + issued. + format: int64 + type: string failedCount: + type: string format: int64 description: >- Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered. - type: string pageloadCount: - format: int64 + type: string description: >- Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA. - type: string - nocaptchaCount: - description: >- - Count of nocaptchas (successful verification without a challenge) - issued. - format: int64 - type: string - passedCount: - description: >- - Count of nocaptchas (successful verification without a challenge) - plus submitted challenge solutions that were correct and resulted in - verification. format: int64 - type: string - type: object - GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: - description: >- - A block action serves an HTTP error code a prevents the request from - hitting the backend. + description: Metrics related to challenges. type: object - properties: {} - id: GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict: - description: >- - Information about card testing fraud, where an adversary is testing - fraudulently obtained cards or brute forcing their details. + id: GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: + id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + properties: + skipBillingCheck: + description: >- + Optional. If true, skips the billing check. A reCAPTCHA Enterprise + key or migrated key behaves differently than a reCAPTCHA + (non-Enterprise version) key when you reach a quota limit (see + https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any + disruption of your usage, we check that a billing account is + present. If your usage of reCAPTCHA is under the free quota, you can + safely skip the billing check and proceed with the migration. See + https://cloud.google.com/recaptcha/docs/billing-information. + type: boolean + description: The migrate key request message. type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict: properties: - risk: + reasons: + description: Output only. Reasons contributing to the SMS toll fraud verdict. + type: array + items: + type: string + enumDescriptions: + - Default unspecified reason + - The provided phone number was invalid + enum: + - SMS_TOLL_FRAUD_REASON_UNSPECIFIED + - INVALID_PHONE_NUMBER readOnly: true + risk: description: >- - Output only. Probability of this transaction attempt being part of a - card testing attack. Values are from 0.0 (lowest) to 1.0 (highest). - format: float + Output only. Probability of an SMS event being fraudulent. Values + are from 0.0 (lowest) to 1.0 (highest). type: number - GoogleCloudRecaptchaenterpriseV1ListKeysResponse: - id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse - description: Response to request to list keys in a project. - properties: - nextPageToken: - type: string - description: >- - Token to retrieve the next page of results. It is set to empty if no - keys remain in results. - keys: - description: Key details. - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' - type: array + readOnly: true + format: float type: object - GoogleCloudRecaptchaenterpriseV1FirewallAction: - properties: - includeRecaptchaScript: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction - description: >- - This action will inject reCAPTCHA JavaScript code into the HTML page - returned by the site backend. - redirect: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction - description: >- - This action will redirect the request to a ReCaptcha interstitial to - attach a token. - allow: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction - description: >- - The user request did not match any policy and should be allowed - access to the requested resource. - substitute: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction - description: >- - This action will transparently serve a different page to an - offending user. - block: - description: >- - This action will deny access to a given page. The user will get an - HTTP error code. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction - setHeader: - description: >- - This action will set a custom header but allow the request to - continue to the customer backend. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction + id: GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict + description: Information about SMS toll fraud. + GoogleRpcStatus: description: >- - An individual action. Each action represents what to do if a policy - matches. - type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallAction - GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: - properties: {} - description: An allow action continues processing a request unimpeded. - id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - GoogleCloudRecaptchaenterpriseV1RiskAnalysis: properties: - extendedVerdictReasons: - readOnly: true - items: - type: string - description: >- - Output only. Extended verdict reasons to be used for experimentation - only. The set of possible reasons is subject to change. + details: type: array - reasons: - readOnly: true items: - enumDescriptions: - - Default unspecified type. - - Interactions matched the behavior of an automated agent. - - The event originated from an illegitimate environment. - - Traffic volume from the event source is higher than normal. - - >- - Interactions with the site were significantly different than - expected patterns. - - >- - Too little traffic has been received from this site thus far to - generate quality risk analysis. - - >- - The request matches behavioral characteristics of a carding - attack. - - >- - The request matches behavioral characteristics of chargebacks - for fraud. - enum: - - CLASSIFICATION_REASON_UNSPECIFIED - - AUTOMATION - - UNEXPECTED_ENVIRONMENT - - TOO_MUCH_TRAFFIC - - UNEXPECTED_USAGE_PATTERNS - - LOW_CONFIDENCE_SCORE - - SUSPECTED_CARDING - - SUSPECTED_CHARGEBACK - type: string - description: Output only. Reasons contributing to the risk analysis verdict. - type: array - score: - format: float - readOnly: true - type: number + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object description: >- - Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very - likely legitimate traffic while 0.0 means very likely non-legitimate - traffic). - description: Risk analysis result for an event. - id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + type: string + id: GoogleRpcStatus + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: + id: >- + GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction type: object - GoogleCloudRecaptchaenterpriseV1FirewallPolicy: + properties: {} description: >- - A FirewallPolicy represents a single matching pattern and resulting - actions to take. + An include reCAPTCHA script action involves injecting reCAPTCHA + JavaScript code into the HTML returned by the site backend. This + reCAPTCHA script is tasked with collecting user signals on the requested + web page, issuing tokens as a cookie within the site domain, and + enabling their utilization in subsequent page requests. + GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: + description: >- + A redirect action returns a 307 (temporary redirect) response, pointing + the user to a reCAPTCHA interstitial page to attach a token. + type: object + properties: {} + id: GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + GoogleCloudRecaptchaenterpriseV1TransactionDataItem: + description: Line items being purchased in this transaction. properties: - path: - description: >- - Optional. The path for which this policy applies, specified as a - glob pattern. For more information on glob, see the [manual - page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has - a max length of 200 characters. - type: string - actions: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction - description: >- - Optional. The actions that the caller should take regarding user - access. There should be at most one terminal action. A terminal - action is any action that forces a response, such as `AllowAction`, - `BlockAction` or `SubstituteAction`. Zero or more non-terminal - actions such as `SetHeader` might be specified. A single policy can - contain up to 16 actions. name: + description: Optional. The full name of the item. type: string - description: >- - Identifier. The resource name for the FirewallPolicy in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - condition: + merchantAccountId: type: string description: >- - Optional. A CEL (Common Expression Language) conditional expression - that specifies if this policy applies to an incoming user request. - If this condition evaluates to true and the requested path matched - the path pattern, the associated actions should be executed by the - caller. The condition string is checked for CEL syntax correctness - on creation. For more information, see the [CEL - spec](https://github.com/google/cel-spec) and its [language - definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). - A condition has a max length of 500 characters. - description: - description: >- - Optional. A description of what this policy aims to achieve, for - convenience purposes. The description can at most include 256 UTF-8 - characters. + Optional. When a merchant is specified, its corresponding + account_id. Necessary to populate marketplace-style transactions. + quantity: + format: int64 type: string - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy + description: Optional. The quantity of this item that is being purchased. + value: + type: number + description: >- + Optional. The value per item that the user is paying, in the + transaction currency, after discounts. + format: double + id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem type: object - GoogleCloudRecaptchaenterpriseV1Assessment: + GoogleCloudRecaptchaenterpriseV1IOSKeySettings: + description: Settings specific to keys that can be used by iOS apps. + id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings type: object - description: A reCAPTCHA Enterprise assessment resource. properties: - fraudSignals: + allowedBundleIds: + type: array + items: + type: string description: >- - Output only. Fraud Signals specific to the users involved in a - payment transaction. - readOnly: true - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' - privatePasswordLeakVerification: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + Optional. iOS bundle ids of apps allowed to use the key. Example: + 'com.companyname.productname.appname' + allowAllBundleIds: + type: boolean + description: Optional. If set to true, allowed_bundle_ids are not enforced. + appleDeveloperId: description: >- - Optional. The private password leak verification field contains the - parameters that are used to to check for leaks privately without - sharing user credentials. - accountVerification: + Optional. Apple Developer account details for the app that is + protected by the reCAPTCHA Key. reCAPTCHA leverages + platform-specific checks like Apple App Attest and Apple DeviceCheck + to protect your app from abuse. Providing these fields allows + reCAPTCHA to get a better assessment of the integrity of your app. $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + GoogleCloudRecaptchaenterpriseV1TransactionEvent: + id: GoogleCloudRecaptchaenterpriseV1TransactionEvent + description: Describes an event in the lifecycle of a payment transaction. + properties: + value: description: >- - Optional. Account verification information for identity - verification. The assessment event must include a token and site key - to use this feature. - phoneFraudAssessment: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment - readOnly: true + Optional. The value that corresponds with this transaction event, if + one exists. For example, a refund event where $5.00 was refunded. + Currency is obtained from the original transaction data. + type: number + format: double + eventTime: + type: string description: >- - Output only. Assessment returned when a site key, a token, and a - phone number as `user_id` are provided. Account defender and SMS - toll fraud protection need to be enabled. - fraudPreventionAssessment: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment - description: >- - Output only. Assessment returned by Fraud Prevention when - TransactionData is provided. - readOnly: true - event: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' - description: Optional. The event being assessed. - riskAnalysis: - description: Output only. The risk analysis result for the event being assessed. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' - readOnly: true - accountDefenderAssessment: - readOnly: true - description: >- - Output only. Assessment returned by account defender when an account - identifier is provided. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - name: - description: >- - Output only. Identifier. The resource name for the Assessment in the - format `projects/{project}/assessments/{assessment}`. + Optional. Timestamp when this transaction event occurred; otherwise + assumed to be the time of the API call. + format: google-datetime + reason: type: string - readOnly: true - firewallPolicyAssessment: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment - description: >- - Output only. Assessment returned when firewall policies belonging to - the project are evaluated using the field - firewall_policy_evaluation. - tokenProperties: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' - description: Output only. Properties of the provided event token. - readOnly: true - id: GoogleCloudRecaptchaenterpriseV1Assessment - GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: - properties: - smsTollFraudVerdict: - readOnly: true - description: >- - Output only. Assessment of this phone event for risk of SMS toll - fraud. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict - description: Assessment for Phone Fraud - type: object - id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment - GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest: - id: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest - properties: - skipBillingCheck: description: >- - Optional. If true, skips the billing check. A reCAPTCHA Enterprise - key or migrated key behaves differently than a reCAPTCHA - (non-Enterprise version) key when you reach a quota limit (see - https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). - To avoid any disruption of your usage, we check that a billing - account is present. If your usage of reCAPTCHA is under the free - quota, you can safely skip the billing check and proceed with the - migration. See - https://cloud.google.com/recaptcha-enterprise/docs/billing-information. - type: boolean + Optional. The reason or standardized code that corresponds with this + transaction event, if one exists. For example, a CHARGEBACK event + with code 6005. + eventType: + enumDescriptions: + - Default, unspecified event type. + - >- + Indicates that the transaction is approved by the merchant. The + accompanying reasons can include terms such as 'INHOUSE', + 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. + - >- + Indicates that the transaction is denied and concluded due to + risks detected by the merchant. The accompanying reasons can + include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or + 'MANUAL_REVIEW'. + - >- + Indicates that the transaction is being evaluated by a human, due + to suspicion or risk. + - >- + Indicates that the authorization attempt with the card issuer + succeeded. + - >- + Indicates that the authorization attempt with the card issuer + failed. The accompanying reasons can include Visa's '54' + indicating that the card is expired, or '82' indicating that the + CVV is incorrect. + - >- + Indicates that the transaction is completed because the funds were + settled. + - >- + Indicates that the transaction could not be completed because the + funds were not settled. + - >- + Indicates that the transaction has been canceled. Specify the + reason for the cancellation. For example, + 'INSUFFICIENT_INVENTORY'. + - >- + Indicates that the merchant has received a chargeback inquiry due + to fraud for the transaction, requesting additional information + before a fraud chargeback is officially issued and a formal + chargeback notification is sent. + - >- + Indicates that the merchant has received a chargeback alert due to + fraud for the transaction. The process of resolving the dispute + without involving the payment network is started. + - >- + Indicates that a fraud notification is issued for the transaction, + sent by the payment instrument's issuing bank because the + transaction appears to be fraudulent. We recommend including TC40 + or SAFE data in the `reason` field for this event type. For + partial chargebacks, we recommend that you include an amount in + the `value` field. + - >- + Indicates that the merchant is informed by the payment network + that the transaction has entered the chargeback process due to + fraud. Reason code examples include Discover's '6005' and '6041'. + For partial chargebacks, we recommend that you include an amount + in the `value` field. + - >- + Indicates that the transaction has entered the chargeback process + due to fraud, and that the merchant has chosen to enter + representment. Reason examples include Discover's '6005' and + '6041'. For partial chargebacks, we recommend that you include an + amount in the `value` field. + - >- + Indicates that the transaction has had a fraud chargeback which + was illegitimate and was reversed as a result. For partial + chargebacks, we recommend that you include an amount in the + `value` field. + - >- + Indicates that the merchant has received a refund for a completed + transaction. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the merchant has received a refund request for this + transaction, but that they have declined it. For partial refunds, + we recommend that you include an amount in the `value` field. + Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant. For partial refunds, we recommend that you include an + amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial + refund of exempt tax) + - >- + Indicates that the completed transaction was refunded by the + merchant, and that this refund was reversed. For partial refunds, + we recommend that you include an amount in the `value` field. + type: string + description: Optional. The type of this transaction event. + enum: + - TRANSACTION_EVENT_TYPE_UNSPECIFIED + - MERCHANT_APPROVE + - MERCHANT_DENY + - MANUAL_REVIEW + - AUTHORIZATION + - AUTHORIZATION_DECLINE + - PAYMENT_CAPTURE + - PAYMENT_CAPTURE_DECLINE + - CANCEL + - CHARGEBACK_INQUIRY + - CHARGEBACK_ALERT + - FRAUD_NOTIFICATION + - CHARGEBACK + - CHARGEBACK_REPRESENTMENT + - CHARGEBACK_REVERSE + - REFUND_REQUEST + - REFUND_DECLINE + - REFUND + - REFUND_REVERSE type: object - description: The migrate key request message. - GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse: + properties: {} + description: Response for RemoveIpOverride. + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse type: object + GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: + description: >- + A set header action sets a header and forwards the request to the + backend. This can be used to trigger custom protection implemented on + the backend. properties: - legacySecretKey: + value: type: string description: >- - The secret key (also known as shared secret) authorizes - communication between your application backend and the reCAPTCHA - Enterprise server to create an assessment. The secret key needs to - be kept safe for security purposes. - id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse - description: >- - Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd - party integration with legacy reCAPTCHA. - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: - description: The reorder firewall policies request message. - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest - properties: - names: + Optional. The header value to set in the request to the backend + server. + key: + type: string description: >- - Required. A list containing all policy names, in the new order. Each - name is in the format - `projects/{project}/firewallpolicies/{firewallpolicy}`. - type: array - items: - type: string + Optional. The header key to set in the request to the backend + server. + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction type: object - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: + GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: properties: - accountId: - description: >- - Optional. The unique stable account identifier used to search - connections. The identifier should correspond to an `account_id` - provided in a previous `CreateAssessment` or `AnnotateAssessment` - call. Either hashed_account_id or account_id must be set, but not - both. + phoneNumber: type: string - hashedAccountId: - deprecated: true description: >- - Optional. Deprecated: use `account_id` instead. The unique stable - hashed account identifier used to search connections. The identifier - should correspond to a `hashed_account_id` provided in a previous - `CreateAssessment` or `AnnotateAssessment` call. Either - hashed_account_id or account_id must be set, but not both. + Phone number for which to trigger a verification request. Should be + given in E.164 format. + emailAddress: type: string - format: byte - pageSize: - type: integer + description: Email address for which to trigger a verification request. + lastVerificationTime: description: >- - Optional. The maximum number of groups to return. The service might - return fewer than this value. If unspecified, at most 50 groups are - returned. The maximum value is 1000; values above 1000 are coerced - to 1000. - format: int32 - pageToken: + Output only. Timestamp of the last successful verification for the + endpoint, if any. + readOnly: true + format: google-datetime + type: string + requestToken: description: >- - Optional. A page token, received from a previous - `SearchRelatedAccountGroupMemberships` call. Provide this to - retrieve the subsequent page. When paginating, all other parameters - provided to `SearchRelatedAccountGroupMemberships` must match the - call that provided the page token. + Output only. Token to provide to the client to trigger endpoint + verification. It must be used within 15 minutes. type: string - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest - description: The request message to search related account group memberships. + readOnly: true + description: Information about a verification endpoint that can be used for 2FA. + id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo type: object - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: properties: name: + description: >- + Required. Identifier. The resource name for this membership in the + format + `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. + type: string + accountId: type: string description: >- - Required. Identifier. The resource name for the related account - group in the format - `projects/{project}/relatedaccountgroups/{related_account_group}`. - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - description: A group of related accounts. - type: object - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: + The unique stable account identifier of the member. The identifier + corresponds to an `account_id` provided in a previous + `CreateAssessment` or `AnnotateAssessment` call. + hashedAccountId: + description: >- + Deprecated: use `account_id` instead. The unique stable hashed + account identifier of the member. The identifier corresponds to a + `hashed_account_id` provided in a previous `CreateAssessment` or + `AnnotateAssessment` call. + deprecated: true + format: byte + type: string + description: A membership in a group of related accounts. type: object - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership + GoogleCloudRecaptchaenterpriseV1FirewallAction: properties: - risk: + redirect: description: >- - Output only. Probability of this transaction being executed with a - stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). - format: float - type: number - readOnly: true + This action redirects the request to a reCAPTCHA interstitial to + attach a token. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction + allow: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction + description: >- + The user request did not match any policy and should be allowed + access to the requested resource. + substitute: + description: >- + This action transparently serves a different page to an offending + user. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + includeRecaptchaScript: + description: >- + This action injects reCAPTCHA JavaScript code into the HTML page + returned by the site backend. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction + block: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction + description: >- + This action denies access to a given page. The user gets an HTTP + error code. + setHeader: + description: >- + This action sets a custom header but allow the request to continue + to the customer backend. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction description: >- - Information about stolen instrument fraud, where the user is not the - legitimate owner of the instrument being used for the purchase. - GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: - description: Account defender risk assessment. + An individual action. Each action represents what to do if a policy + matches. + type: object + id: GoogleCloudRecaptchaenterpriseV1FirewallAction + GoogleCloudRecaptchaenterpriseV1RiskAnalysis: type: object + description: Risk analysis result for an event. properties: - labels: + score: + description: >- + Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very + likely legitimate traffic while 0.0 means very likely non-legitimate + traffic). + type: number + format: float + readOnly: true + extendedVerdictReasons: + description: >- + Output only. Extended verdict reasons to be used for experimentation + only. The set of possible reasons is subject to change. readOnly: true type: array - description: Output only. Labels for this request. items: + type: string + reasons: + description: Output only. Reasons contributing to the risk analysis verdict. + type: array + items: + type: string + enum: + - CLASSIFICATION_REASON_UNSPECIFIED + - AUTOMATION + - UNEXPECTED_ENVIRONMENT + - TOO_MUCH_TRAFFIC + - UNEXPECTED_USAGE_PATTERNS + - LOW_CONFIDENCE_SCORE + - SUSPECTED_CARDING + - SUSPECTED_CHARGEBACK enumDescriptions: - Default unspecified type. - - The request matches a known good profile for the user. + - Interactions matched the behavior of an automated agent. + - The event originated from an illegitimate environment. + - Traffic volume from the event source is higher than normal. - >- - The request is potentially a suspicious login event and must be - further verified either through multi-factor authentication or - another system. + Interactions with the site were significantly different than + expected patterns. - >- - The request matched a profile that previously had suspicious - account creation behavior. This can mean that this is a fake - account. + Too little traffic has been received from this site thus far to + generate quality risk analysis. - >- - The account in the request has a high number of related - accounts. It does not necessarily imply that the account is bad - but can require further investigation. - enum: - - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED - - PROFILE_MATCH - - SUSPICIOUS_LOGIN_ACTIVITY - - SUSPICIOUS_ACCOUNT_CREATION - - RELATED_ACCOUNTS_NUMBER_HIGH - type: string - id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment - GoogleCloudRecaptchaenterpriseV1UserId: - type: object + The request matches behavioral characteristics of a carding + attack. + - >- + The request matches behavioral characteristics of chargebacks + for fraud. + readOnly: true + id: GoogleCloudRecaptchaenterpriseV1RiskAnalysis + GoogleCloudRecaptchaenterpriseV1Event: + id: GoogleCloudRecaptchaenterpriseV1Event + description: The event being assessed. properties: - username: + ja3: + description: Optional. JA3 fingerprint for SSL clients. type: string - description: >- - Optional. A unique username, if different from all the other - identifiers and `account_id` that are provided. Can be a unique - login handle or display name for a user. - email: - description: Optional. An email address. + expectedAction: type: string - phoneNumber: - description: Optional. A phone number. Should use the E.164 format. + description: >- + Optional. The expected action for this type of event. This should be + the same action provided at token generation time on client-side + platforms already integrated with recaptcha enterprise. + hashedAccountId: + deprecated: true + description: >- + Optional. Deprecated: use `user_info.account_id` instead. Unique + stable hashed user identifier for the request. The identifier must + be hashed using hmac-sha256 with stable secret. type: string - id: GoogleCloudRecaptchaenterpriseV1UserId - description: An identifier associated with a user. - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse: - properties: - relatedAccountGroups: - description: The groups of related accounts listed by the query. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup - type: array - nextPageToken: + format: byte + fraudPrevention: + enum: + - FRAUD_PREVENTION_UNSPECIFIED + - ENABLED + - DISABLED + enumDescriptions: + - >- + Default, unspecified setting. If opted in for automatic detection, + `fraud_prevention_assessment` is returned based on the request. + Otherwise, `fraud_prevention_assessment` is returned if + `transaction_data` is present in the `Event` and Fraud Prevention + is enabled in the Google Cloud console. + - >- + Enable Fraud Prevention for this assessment, if Fraud Prevention + is enabled in the Google Cloud console. + - >- + Disable Fraud Prevention for this assessment, regardless of opt-in + status or Google Cloud console settings. + description: Optional. The Fraud Prevention setting for this assessment. type: string + wafTokenAssessment: + type: boolean description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. - id: GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse - description: The response to a `ListRelatedAccountGroups` call. - type: object - GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse: - properties: {} - id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse - description: The reorder firewall policies response message. - type: object - GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: - id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - type: object - description: Details about the transaction from the gateway. - properties: - cvvResponseCode: - type: string + Optional. Flag for running WAF token assessment. If enabled, the + token must be specified, and have been created by a WAF-enabled key. + express: + type: boolean description: >- - Optional. CVV response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - name: + Optional. Flag for a reCAPTCHA express request for an assessment + without a token. If enabled, `site_key` must reference an Express + site key. + firewallPolicyEvaluation: + type: boolean description: >- - Optional. Name of the gateway service (for example, stripe, square, - paypal). - type: string - gatewayResponseCode: + Optional. Flag for enabling firewall policy config assessment. If + this flag is enabled, the firewall policy is evaluated and a + suggested firewall action is returned in the response. + userAgent: type: string description: >- - Optional. Gateway response code describing the state of the - transaction. - avsResponseCode: - type: string + Optional. The user agent present in the request from the user's + device related to this event. + transactionData: description: >- - Optional. AVS response code from the gateway (available only when - reCAPTCHA Enterprise is called after authorization). - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: - id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment - properties: - stolenInstrumentVerdict: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + Optional. Data describing a payment transaction to be assessed. + Sending this data enables reCAPTCHA Enterprise Fraud Prevention and + the FraudPreventionAssessment component in the response. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData' + userInfo: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo' description: >- - Output only. Assessment of this transaction for risk of a stolen - instrument. - readOnly: true - cardTestingVerdict: + Optional. Information about the user that generates this event, when + they can be identified. They are often identified through the use of + an account for logged-in requests or login/registration requests, or + by providing user identifiers for guest actions like checkout. + userIpAddress: + type: string description: >- - Output only. Assessment of this transaction for risk of being part - of a card testing attack. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict - readOnly: true - transactionRisk: - format: float - type: number - readOnly: true + Optional. The IP address in the request from the user's device + related to this event. + siteKey: description: >- - Output only. Probability of this transaction being fraudulent. - Summarizes the combined risk of attack vectors below. Values are - from 0.0 (lowest) to 1.0 (highest). - behavioralTrustVerdict: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict - description: Output only. Assessment of this transaction for behavioral trust. - type: object - description: Assessment for Fraud Prevention. - GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: - properties: - value: + Optional. The site key that was used to invoke reCAPTCHA Enterprise + on your site and generate the token. + type: string + token: type: string description: >- - Optional. The header value to set in the request to the backend - server. - key: + Optional. The user response token provided by the reCAPTCHA + Enterprise client-side integration on your site. + headers: + description: Optional. HTTP header information about the request. + type: array + items: + type: string + requestedUri: description: >- - Optional. The header key to set in the request to the backend - server. + Optional. The URI resource the user requested that triggered an + assessment. type: string - description: >- - A set header action sets a header and forwards the request to the - backend. This can be used to trigger custom protection implemented on - the backend. type: object - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction - GoogleCloudRecaptchaenterpriseV1TransactionDataUser: + GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment: properties: - phoneVerified: - type: boolean - description: >- - Optional. Whether the phone number has been verified to be - accessible by the user (OTP or similar). - accountId: - type: string - description: >- - Optional. Unique account identifier for this user. If using account - defender, this should match the hashed_account_id field. Otherwise, - a unique and persistent identifier for this account. - emailVerified: + smsTollFraudVerdict: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict description: >- - Optional. Whether the email has been verified to be accessible by - the user (OTP or similar). - type: boolean - phoneNumber: - type: string - description: Optional. The phone number of the user, with country code. - creationMs: - type: string - format: int64 - description: Optional. The epoch milliseconds of the user's account creation. - email: - description: Optional. The email address of the user. - type: string + Output only. Assessment of this phone event for risk of SMS toll + fraud. + readOnly: true + id: GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment type: object - id: GoogleCloudRecaptchaenterpriseV1TransactionDataUser - description: Details about a user's account involved in the transaction. - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + description: Assessment for Phone Fraud + GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest: type: object - description: The request message to annotate an Assessment. + id: GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest + description: The AddIpOverride request message. properties: - transactionEvent: + ipOverrideData: + description: Required. IP override added to the key. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse: + id: GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse + type: object + description: Response for ListIpOverrides. + properties: + nextPageToken: + type: string description: >- - Optional. If the assessment is part of a payment transaction, - provide details on payment lifecycle events that occur in the - transaction. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent - reasons: + Token to retrieve the next page of results. If this field is empty, + no keys remain in the results. + ipOverrides: items: - enumDescriptions: - - Default unspecified reason. - - >- - Indicates that the transaction had a chargeback issued with no - other details. When possible, specify the type by using - CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. - - >- - Indicates that the transaction had a chargeback issued related - to an alleged unauthorized transaction from the cardholder's - perspective (for example, the card number was stolen). - - >- - Indicates that the transaction had a chargeback issued related - to the cardholder having provided their card details but - allegedly not being satisfied with the purchase (for example, - misrepresentation, attempted cancellation). - - >- - Indicates that the completed payment transaction was refunded by - the seller. - - >- - Indicates that the completed payment transaction was determined - to be fraudulent by the seller, and was cancelled and refunded - as a result. - - >- - Indicates that the payment transaction was accepted, and the - user was charged. - - >- - Indicates that the payment transaction was declined, for example - due to invalid card details. - - >- - Indicates the transaction associated with the assessment is - suspected of being fraudulent based on the payment method, - billing details, shipping address or other transaction - information. - - >- - Indicates that the user was served a 2FA challenge. An old - assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that - has not been overwritten with `PASSED_TWO_FACTOR` is treated as - an abandoned 2FA flow. This is equivalent to - `FAILED_TWO_FACTOR`. - - Indicates that the user passed a 2FA challenge. - - Indicates that the user failed a 2FA challenge. - - Indicates the user provided the correct password. - - Indicates the user provided an incorrect password. - - >- - Indicates that the user sent unwanted and abusive messages to - other users of the platform, such as spam, scams, phishing, or - social engineering. - enum: - - REASON_UNSPECIFIED - - CHARGEBACK - - CHARGEBACK_FRAUD - - CHARGEBACK_DISPUTE - - REFUND - - REFUND_FRAUD - - TRANSACTION_ACCEPTED - - TRANSACTION_DECLINED - - PAYMENT_HEURISTICS - - INITIATED_TWO_FACTOR - - PASSED_TWO_FACTOR - - FAILED_TWO_FACTOR - - CORRECT_PASSWORD - - INCORRECT_PASSWORD - - SOCIAL_SPAM - type: string - description: Optional. Reasons for the annotation that are assigned to the event. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData + type: array + description: IP Overrides details. + GoogleCloudRecaptchaenterpriseV1UserInfo: + description: >- + User information associated with a request protected by reCAPTCHA + Enterprise. + properties: + userIds: + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' type: array + description: Optional. Identifiers associated with this user or request. accountId: type: string description: >- - Optional. A stable account identifier to apply to the assessment. - This is an alternative to setting `account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. - hashedAccountId: + Optional. For logged-in requests or login/registration requests, the + unique account identifier associated with this user. You can use the + username if it is stable (meaning it is the same for every request + associated with the same user), or any stable user ID of your + choice. Leave blank for non logged-in actions or guest checkout. + createAccountTime: + description: >- + Optional. Creation time for this account associated with this user. + Leave blank for non logged-in actions, guest checkout, or when there + is no account associated with the current user. + type: string + format: google-datetime + id: GoogleCloudRecaptchaenterpriseV1UserInfo + type: object + GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: + description: Information about account verification, used for identity verification. + properties: + username: + description: >- + Username of the account that is being verified. Deprecated. + Customers should now provide the `account_id` field in + `event.user_info`. + deprecated: true + type: string + languageCode: description: >- - Optional. A stable hashed account identifier to apply to the - assessment. This is an alternative to setting `hashed_account_id` in - `CreateAssessment`, for example when a stable account identifier is - not yet known in the initial request. + Optional. Language code preference for the verification message, set + as a IETF BCP 47 language code. type: string - format: byte - annotation: - enumDeprecated: - - false - - false - - false - - true - - true + endpoints: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo + description: Optional. Endpoints that can be used for identity verification. + type: array + latestVerificationResult: + description: Output only. Result of the latest account verification challenge. + readOnly: true type: string - enum: - - ANNOTATION_UNSPECIFIED - - LEGITIMATE - - FRAUDULENT - - PASSWORD_CORRECT - - PASSWORD_INCORRECT enumDescriptions: - - Default unspecified type. - - Provides information that the event turned out to be legitimate. - - Provides information that the event turned out to be fraudulent. + - No information about the latest account verification. - >- - Provides information that the event was related to a login event - in which the user typed the correct password. Deprecated, prefer - indicating CORRECT_PASSWORD through the reasons field instead. + The user was successfully verified. This means the account + verification challenge was successfully completed. + - The user failed the verification challenge. - >- - Provides information that the event was related to a login event - in which the user typed the incorrect password. Deprecated, prefer - indicating INCORRECT_PASSWORD through the reasons field instead. - description: >- - Optional. The annotation that will be assigned to the Event. This - field can be left empty to provide reasons that apply to an event - without concluding whether the event is legitimate or fraudulent. - GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: - description: Private password leak verification info. + The site is not properly onboarded to use the account verification + feature. + - >- + The recipient is not allowed for account verification. This can + occur during integration but should not occur in production. + - >- + The recipient has already been sent too many verification codes in + a short amount of time. + - >- + The verification flow could not be completed due to a critical + internal error. + - >- + The client has exceeded their two factor request quota for this + period of time. + - >- + The request cannot be processed at the time because of an + incident. This bypass can be restricted to a problematic + destination email domain, a customer, or could affect the entire + service. + - >- + The request parameters do not match with the token provided and + cannot be processed. + enum: + - RESULT_UNSPECIFIED + - SUCCESS_USER_VERIFIED + - ERROR_USER_NOT_VERIFIED + - ERROR_SITE_ONBOARDING_INCOMPLETE + - ERROR_RECIPIENT_NOT_ALLOWED + - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED + - ERROR_CRITICAL_INTERNAL + - ERROR_CUSTOMER_QUOTA_EXHAUSTED + - ERROR_VERIFICATION_BYPASSED + - ERROR_VERDICT_MISMATCH + id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + type: object + GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: type: object properties: - lookupHashPrefix: + address: + items: + type: string + type: array description: >- - Required. Exactly 26-bit prefix of the SHA-256 hash of the - canonicalized username. It is used to look up password leaks - associated with that hash prefix. + Optional. The first lines of the address. The first line generally + contains the street name and number, and further lines may include + information such as an apartment number. + administrativeArea: + description: >- + Optional. The state, province, or otherwise administrative area of + the address. type: string - format: byte - encryptedUserCredentialsHash: - format: byte + recipient: + description: >- + Optional. The recipient name, potentially including information such + as "care of". + type: string + postalCode: + description: Optional. The postal or ZIP code of the address. + type: string + locality: + type: string + description: Optional. The town/city of the address. + regionCode: type: string + description: Optional. The CLDR country/region of the address. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + description: Structured address format for billing and shipping addresses. + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict: + properties: + risk: + readOnly: true + type: number description: >- - Optional. Encrypted Scrypt hash of the canonicalized - username+password. It is re-encrypted by the server and returned - through `reencrypted_user_credentials_hash`. - encryptedLeakMatchPrefixes: + Output only. Probability of this transaction being executed with a + stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest). + format: float + type: object + id: >- + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict + description: >- + Information about stolen instrument fraud, where the user is not the + legitimate owner of the instrument being used for the purchase. + GoogleCloudRecaptchaenterpriseV1ScoreDistribution: + type: object + description: Score distribution. + properties: + scoreBuckets: + additionalProperties: + type: string + format: int64 + type: object + description: >- + Map key is score value multiplied by 100. The scores are discrete + values between [0, 1]. The maximum number of buckets is on order of + a few dozen, but typically much lower (ie. 10). + id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution + GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: + type: object + properties: + activeDaysLowerBound: + format: int32 + description: >- + Output only. This user (based on email, phone, and other + identifiers) has been seen on the internet for at least this number + of days. + type: integer + readOnly: true + syntheticRisk: readOnly: true + type: number + format: float + description: >- + Output only. Likelihood (from 0.0 to 1.0) this user includes + synthetic components in their identity, such as a randomly generated + email address, temporary phone number, or fake shipping address. + description: Signals describing the user involved in this transaction. + id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification: + properties: + encryptedLeakMatchPrefixes: items: - format: byte type: string + format: byte description: >- Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of `reencrypted_user_credentials_hash` + readOnly: true type: array - reencryptedUserCredentialsHash: + lookupHashPrefix: + description: >- + Required. Exactly 26-bit prefix of the SHA-256 hash of the + canonicalized username. It is used to look up password leaks + associated with that hash prefix. format: byte type: string + reencryptedUserCredentialsHash: + readOnly: true + type: string description: >- Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash` field. It is used to match potential password leaks within `encrypted_leak_match_prefixes`. - readOnly: true - id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse: - properties: - nextPageToken: + format: byte + encryptedUserCredentialsHash: description: >- - A token, which can be sent as `page_token` to retrieve the next - page. If this field is omitted, there are no subsequent pages. + Optional. Encrypted Scrypt hash of the canonicalized + username+password. It is re-encrypted by the server and returned + through `reencrypted_user_credentials_hash`. type: string - relatedAccountGroupMemberships: - type: array - description: The queried memberships. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - description: The response to a `SearchRelatedAccountGroupMemberships` call. - type: object - id: >- - GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse - GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals: - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + format: byte + id: GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + description: Private password leak verification info. type: object - description: Signals describing the user involved in this transaction. + GoogleCloudRecaptchaenterpriseV1Assessment: properties: - activeDaysLowerBound: - type: integer - format: int32 + accountVerification: description: >- - Output only. This user (based on email, phone, and other - identifiers) has been seen on the internet for at least this number - of days. + Optional. Account verification information for identity + verification. The assessment event must include a token and site key + to use this feature. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo + event: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event' + description: Optional. The event being assessed. + fraudSignals: + description: >- + Output only. Fraud Signals specific to the users involved in a + payment transaction. readOnly: true - syntheticRisk: - type: number - format: float + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals' + fraudPreventionAssessment: description: >- - Output only. Likelihood (from 0.0 to 1.0) this user includes - synthetic components in their identity, such as a randomly generated - email address, temporary phone number, or fake shipping address. + Output only. Assessment returned by Fraud Prevention when + TransactionData is provided. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment readOnly: true - GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: - id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - type: object - properties: - supportNonGoogleAppStoreDistribution: + assessmentEnvironment: description: >- - Optional. Set to true for keys that are used in an Android - application that is available for download in app stores in addition - to the Google Play Store. - type: boolean - allowAllPackageNames: - type: boolean - description: Optional. If set to true, allowed_package_names are not enforced. - allowedPackageNames: - items: - type: string - type: array + Optional. The environment creating the assessment. This describes + your environment (the system invoking CreateAssessment), NOT the + environment of your user. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment + privatePasswordLeakVerification: description: >- - Optional. Android package names of apps allowed to use the key. - Example: 'com.companyname.appname' - description: Settings specific to keys that can be used by Android apps. - GoogleCloudRecaptchaenterpriseV1UserInfo: - type: object - id: GoogleCloudRecaptchaenterpriseV1UserInfo - properties: - createAccountTime: - format: google-datetime + Optional. The private password leak verification field contains the + parameters that are used to to check for leaks privately without + sharing user credentials. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification + accountDefenderAssessment: + readOnly: true + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment description: >- - Optional. Creation time for this account associated with this user. - Leave blank for non logged-in actions, guest checkout, or when there - is no account associated with the current user. - type: string - accountId: - type: string + Output only. Assessment returned by account defender when an account + identifier is provided. + firewallPolicyAssessment: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment description: >- - Optional. For logged-in requests or login/registration requests, the - unique account identifier associated with this user. You can use the - username if it is stable (meaning it is the same for every request - associated with the same user), or any stable user ID of your - choice. Leave blank for non logged-in actions or guest checkout. - userIds: - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserId' - description: Optional. Identifiers associated with this user or request. - type: array - description: >- - User information associated with a request protected by reCAPTCHA - Enterprise. - GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: - type: object - description: Response to request to list firewall policies belonging to a project. - id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse - properties: - firewallPolicies: - description: Policy details. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - type: array - nextPageToken: + Output only. Assessment returned when firewall policies belonging to + the project are evaluated using the field + firewall_policy_evaluation. + readOnly: true + tokenProperties: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties' + description: Output only. Properties of the provided event token. + readOnly: true + phoneFraudAssessment: + readOnly: true + description: >- + Output only. Assessment returned when a site key, a token, and a + phone number as `user_id` are provided. Account defender and SMS + toll fraud protection need to be enabled. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment + riskAnalysis: + description: Output only. The risk analysis result for the event being assessed. + readOnly: true + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis' + name: type: string description: >- - Token to retrieve the next page of results. It is set to empty if no - policies remain in results. - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction: - id: >- - GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction - properties: {} + Output only. Identifier. The resource name for the Assessment in the + format `projects/{project}/assessments/{assessment}`. + readOnly: true type: object - description: >- - An include reCAPTCHA script action involves injecting reCAPTCHA - JavaScript code into the HTML returned by the site backend. This - reCAPTCHA script is tasked with collecting user signals on the requested - web page, issuing tokens as a cookie within the site domain, and - enabling their utilization in subsequent page requests. - GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals: + description: A reCAPTCHA Enterprise assessment resource. + id: GoogleCloudRecaptchaenterpriseV1Assessment + GoogleCloudRecaptchaenterpriseV1TokenProperties: + description: Properties of the provided event token. type: object - id: GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals - description: Signals describing the payment card used in this transaction. properties: - cardLabels: + invalidReason: + enumDescriptions: + - Default unspecified type. + - If the failure reason was not accounted for. + - The provided user verification token was malformed. + - The user verification token had expired. + - The user verification had already been seen. + - The user verification token was not present. + - >- + A retriable error (such as network failure) occurred on the + browser. Could easily be simulated by an attacker. readOnly: true - items: - enum: - - CARD_LABEL_UNSPECIFIED - - PREPAID - - VIRTUAL - - UNEXPECTED_LOCATION - enumDescriptions: - - No label specified. - - This card has been detected as prepaid. - - >- - This card has been detected as virtual, such as a card number - generated for a single transaction or merchant. - - >- - This card has been detected as being used in an unexpected - geographic location. - type: string - type: array - description: Output only. The labels for the payment card in this transaction. - GoogleCloudRecaptchaenterpriseV1TransactionData: - description: >- - Transaction data associated with a payment protected by reCAPTCHA - Enterprise. - properties: - paymentMethod: + description: Output only. Reason associated with the response when valid = false. + enum: + - INVALID_REASON_UNSPECIFIED + - UNKNOWN_INVALID_REASON + - MALFORMED + - EXPIRED + - DUPE + - MISSING + - BROWSER_ERROR type: string + hostname: description: >- - Optional. The payment method for the transaction. The allowed values - are: * credit-card * debit-card * gift-card * processor-{name} (If a - third-party is used, for example, processor-paypal) * custom-{name} - (If an alternative method is used, for example, custom-crypto) - currencyCode: - description: Optional. The currency code in ISO-4217 format. + Output only. The hostname of the page on which the token was + generated (Web keys only). + readOnly: true type: string - value: - format: double - type: number - description: >- - Optional. The decimal value of the transaction in the specified - currency. - transactionId: + createTime: + format: google-datetime type: string + readOnly: true description: >- - Unique identifier for the transaction. This custom identifier can be - used to reference this transaction in the future, for example, - labeling a refund or chargeback event. Two attempts at the same - transaction should use the same transaction id. - shippingAddress: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress + Output only. The timestamp corresponding to the generation of the + token. + valid: + readOnly: true description: >- - Optional. Destination address if this transaction involves shipping - a physical item. - cardLastFour: - description: Optional. The last four digits of the card. + Output only. Whether the provided user response token is valid. When + valid = false, the reason could be specified in invalid_reason or it + could also be due to a user failing to solve a challenge or a + sitekey mismatch (i.e the sitekey used to generate the token was + different than the one specified in the assessment). + type: boolean + iosBundleId: type: string - merchants: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser - description: >- - Optional. Information about the user or users fulfilling the - transaction. - shippingValue: - format: double - type: number - description: >- - Optional. The value of shipping in the specified currency. 0 for - free or no shipping. - user: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser description: >- - Optional. Information about the user paying/initiating the - transaction. - cardBin: + Output only. The ID of the iOS bundle with which the token was + generated (iOS keys only). + readOnly: true + androidPackageName: + readOnly: true type: string description: >- - Optional. The Bank Identification Number - generally the first 6 or - 8 digits of the card. - gatewayInfo: + Output only. The name of the Android package with which the token + was generated (Android keys only). + action: + type: string + readOnly: true + description: Output only. Action name provided at token generation. + id: GoogleCloudRecaptchaenterpriseV1TokenProperties + GoogleProtobufEmpty: + properties: {} + type: object + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + GoogleCloudRecaptchaenterpriseV1FraudSignals: + properties: + cardSignals: description: >- - Optional. Information about the payment gateway's response to the - transaction. + Output only. Signals describing the payment card or cards used in + this transaction. + readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo - billingAddress: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + userSignals: + readOnly: true $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - description: >- - Optional. Address associated with the payment method when - applicable. - items: - description: Optional. Items purchased in this transaction. - items: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem - type: array - id: GoogleCloudRecaptchaenterpriseV1TransactionData - type: object - GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: - type: object - id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse - description: Empty response for AnnotateAssessment. - properties: {} - GoogleCloudRecaptchaenterpriseV1IOSKeySettings: + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals + description: Output only. Signals describing the end user in this transaction. + description: Fraud signals describing users and cards involved in the transaction. + id: GoogleCloudRecaptchaenterpriseV1FraudSignals type: object - description: Settings specific to keys that can be used by iOS apps. + GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment: properties: - appleDeveloperId: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId - description: >- - Optional. Apple Developer account details for the app that is - protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages - platform-specific checks like Apple App Attest and Apple DeviceCheck - to protect your app from abuse. Providing these fields allows - reCAPTCHA Enterprise to get a better assessment of the integrity of - your app. - allowAllBundleIds: - type: boolean - description: Optional. If set to true, allowed_bundle_ids are not enforced. - allowedBundleIds: + labels: type: array + readOnly: true + description: Output only. Labels for this request. items: type: string - description: >- - Optional. iOS bundle ids of apps allowed to use the key. Example: - 'com.companyname.productname.appname' - id: GoogleCloudRecaptchaenterpriseV1IOSKeySettings - GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: - id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + enumDescriptions: + - Default unspecified type. + - The request matches a known good profile for the user. + - >- + The request is potentially a suspicious login event and must be + further verified either through multi-factor authentication or + another system. + - >- + The request matched a profile that previously had suspicious + account creation behavior. This can mean that this is a fake + account. + - >- + The account in the request has a high number of related + accounts. It does not necessarily imply that the account is bad + but can require further investigation. + enum: + - ACCOUNT_DEFENDER_LABEL_UNSPECIFIED + - PROFILE_MATCH + - SUSPICIOUS_LOGIN_ACTIVITY + - SUSPICIOUS_ACCOUNT_CREATION + - RELATED_ACCOUNTS_NUMBER_HIGH + description: Account defender risk assessment. type: object - properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - Output only. If the processing of a policy config fails, an error - will be populated and the firewall_policy will be left empty. - readOnly: true - firewallPolicy: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' - description: >- - Output only. The policy that matched the request. If more than one - policy may match, this is the first match. If no policy matches the - incoming request, the policy field will be left empty. - readOnly: true - description: Policy config assessment. - GoogleCloudRecaptchaenterpriseV1WafSettings: - properties: - wafService: - enumDescriptions: - - Undefined WAF - - Cloud Armor - - Fastly - - Cloudflare - enum: - - WAF_SERVICE_UNSPECIFIED - - CA - - FASTLY - - CLOUDFLARE - type: string - description: Required. The WAF service that uses this key. - wafFeature: - description: Required. The WAF feature for which this key is enabled. - type: string - enum: - - WAF_FEATURE_UNSPECIFIED - - CHALLENGE_PAGE - - SESSION_TOKEN - - ACTION_TOKEN - - EXPRESS - enumDescriptions: - - Undefined feature. - - Redirects suspicious traffic to reCAPTCHA. - - >- - Use reCAPTCHA session-tokens to protect the whole user session on - the site's domain. - - Use reCAPTCHA action-tokens to protect user actions. - - >- - Use reCAPTCHA WAF express protection to protect any content other - than web pages, like APIs and IoT devices. - description: >- - Settings specific to keys that can be used for WAF (Web Application - Firewall). - id: GoogleCloudRecaptchaenterpriseV1WafSettings + id: GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment + GoogleCloudRecaptchaenterpriseV1Key: type: object - GoogleCloudRecaptchaenterpriseV1TransactionDataItem: - description: Line items being purchased in this transaction. + description: >- + A key used to identify and configure applications (web and/or mobile) + that use reCAPTCHA Enterprise. properties: - name: - type: string - description: Optional. The full name of the item. - merchantAccountId: + displayName: type: string description: >- - Optional. When a merchant is specified, its corresponding - account_id. Necessary to populate marketplace-style transactions. - value: + Required. Human-readable display name of this key. Modifiable by + user. + name: description: >- - Optional. The value per item that the user is paying, in the - transaction currency, after discounts. - format: double - type: number - quantity: + Identifier. The resource name for the Key in the format + `projects/{project}/keys/{key}`. type: string - description: Optional. The quantity of this item that is being purchased. - format: int64 - id: GoogleCloudRecaptchaenterpriseV1TransactionDataItem - type: object - GoogleRpcStatus: - properties: - message: + webSettings: + description: Settings for keys that can be used by websites. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' + wafSettings: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' + description: Optional. Settings for WAF + testingOptions: + description: Optional. Options for user acceptance testing. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' + labels: + additionalProperties: + type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Optional. See [Creating and managing labels] + (https://cloud.google.com/recaptcha/docs/labels). + type: object + androidSettings: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Settings for keys that can be used by Android apps. + expressSettings: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ExpressKeySettings + description: Settings for keys that can be used by reCAPTCHA Express. + iosSettings: + description: Settings for keys that can be used by iOS apps. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' + createTime: + readOnly: true type: string - details: - type: array - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + format: google-datetime description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - type: integer - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + Output only. The timestamp corresponding to the creation of this + key. + id: GoogleCloudRecaptchaenterpriseV1Key + GoogleCloudRecaptchaenterpriseV1ScoreMetrics: type: object - GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: + id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics + properties: + actionMetrics: + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + description: >- + Action-based metrics. The map key is the action name which specified + by the site owners at time of the "execute" client-side call. + type: object + overallMetrics: + description: Aggregated score metrics for all traffic. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution + description: Metrics related to scoring. + GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: + description: An allow action continues processing a request unimpeded. + id: GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction type: object - id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + properties: {} + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest: + id: >- + GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest properties: - keyId: - description: Required. The Apple developer key ID (10-character string). + hashedAccountId: + format: byte + deprecated: true type: string - teamId: + description: >- + Optional. Deprecated: use `account_id` instead. The unique stable + hashed account identifier used to search connections. The identifier + should correspond to a `hashed_account_id` provided in a previous + `CreateAssessment` or `AnnotateAssessment` call. Either + hashed_account_id or account_id must be set, but not both. + pageToken: + description: >- + Optional. A page token, received from a previous + `SearchRelatedAccountGroupMemberships` call. Provide this to + retrieve the subsequent page. When paginating, all other parameters + provided to `SearchRelatedAccountGroupMemberships` must match the + call that provided the page token. type: string + accountId: description: >- - Required. The Apple team ID (10-character string) owning the - provisioning profile used to build your application. - privateKey: - description: >- - Required. Input only. A private key (downloaded as a text file with - a .p8 file extension) generated for your Apple Developer account. - Ensure that Apple DeviceCheck is enabled for the private key. - type: string - description: >- - Contains fields that are required to perform Apple-specific integrity - checks. - GoogleCloudRecaptchaenterpriseV1Metrics: - description: Metrics for a single Key. - properties: - name: + Optional. The unique stable account identifier used to search + connections. The identifier should correspond to an `account_id` + provided in a previous `CreateAssessment` or `AnnotateAssessment` + call. Either hashed_account_id or account_id must be set, but not + both. type: string + pageSize: + type: integer + format: int32 description: >- - Output only. Identifier. The name of the metrics, in the format - `projects/{project}/keys/{key}/metrics`. - readOnly: true - startTime: - description: Inclusive start time aligned to a day (UTC). + Optional. The maximum number of groups to return. The service might + return fewer than this value. If unspecified, at most 50 groups are + returned. The maximum value is 1000; values above 1000 are coerced + to 1000. + description: The request message to search related account group memberships. + type: object + GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse: + properties: + nextPageToken: type: string - format: google-datetime - scoreMetrics: - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' description: >- - Metrics will be continuous and in order by dates, and in the - granularity of day. All Key types should have score-based data. - challengeMetrics: + Token to retrieve the next page of results. It is set to empty if no + policies remain in results. + firewallPolicies: + description: Policy details. type: array - description: >- - Metrics will be continuous and in order by dates, and in the - granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), - will have challenge-based data. items: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + description: Response to request to list firewall policies belonging to a project. type: object - id: GoogleCloudRecaptchaenterpriseV1Metrics - GoogleCloudRecaptchaenterpriseV1FraudSignals: - id: GoogleCloudRecaptchaenterpriseV1FraudSignals - description: Fraud signals describing users and cards involved in the transaction. + id: GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + GoogleCloudRecaptchaenterpriseV1TransactionData: properties: - cardSignals: - readOnly: true - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals + value: + format: double + type: number description: >- - Output only. Signals describing the payment card or cards used in - this transaction. - userSignals: - description: Output only. Signals describing the end user in this transaction. - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals - readOnly: true - type: object - GoogleProtobufEmpty: - type: object - properties: {} - id: GoogleProtobufEmpty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo: - type: object - properties: - emailAddress: - type: string - description: Email address for which to trigger a verification request. - requestToken: - readOnly: true + Optional. The decimal value of the transaction in the specified + currency. + currencyCode: + description: Optional. The currency code in ISO-4217 format. type: string + merchants: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser + type: array description: >- - Output only. Token to provide to the client to trigger endpoint - verification. It must be used within 15 minutes. - lastVerificationTime: + Optional. Information about the user or users fulfilling the + transaction. + transactionId: description: >- - Output only. Timestamp of the last successful verification for the - endpoint, if any. - format: google-datetime + Unique identifier for the transaction. This custom identifier can be + used to reference this transaction in the future, for example, + labeling a refund or chargeback event. Two attempts at the same + transaction should use the same transaction id. type: string - readOnly: true - phoneNumber: + cardBin: type: string description: >- - Phone number for which to trigger a verification request. Should be - given in E.164 format. - id: GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - description: Information about a verification endpoint that can be used for 2FA. - GoogleCloudRecaptchaenterpriseV1TransactionDataAddress: - properties: - locality: - description: Optional. The town/city of the address. - type: string - recipient: + Optional. The Bank Identification Number - generally the first 6 or + 8 digits of the card. + billingAddress: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress description: >- - Optional. The recipient name, potentially including information such - as "care of". - type: string - administrativeArea: + Optional. Address associated with the payment method when + applicable. + user: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataUser description: >- - Optional. The state, province, or otherwise administrative area of - the address. - type: string - regionCode: + Optional. Information about the user paying/initiating the + transaction. + paymentMethod: type: string - description: Optional. The CLDR country/region of the address. - postalCode: + description: >- + Optional. The payment method for the transaction. The allowed values + are: * credit-card * debit-card * gift-card * processor-{name} (If a + third-party is used, for example, processor-paypal) * custom-{name} + (If an alternative method is used, for example, custom-crypto) + cardLastFour: type: string - description: Optional. The postal or ZIP code of the address. - address: + description: Optional. The last four digits of the card. + items: + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataItem type: array + description: Optional. Items purchased in this transaction. + shippingAddress: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataAddress description: >- - Optional. The first lines of the address. The first line generally - contains the street name and number, and further lines may include - information such as an apartment number. - items: - type: string - type: object - id: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress - description: Structured address format for billing and shipping addresses. - GoogleCloudRecaptchaenterpriseV1ScoreDistribution: - properties: - scoreBuckets: + Optional. Destination address if this transaction involves shipping + a physical item. + shippingValue: description: >- - Map key is score value multiplied by 100. The scores are discrete - values between [0, 1]. The maximum number of buckets is on order of - a few dozen, but typically much lower (ie. 10). - type: object - additionalProperties: - type: string - format: int64 - description: Score distribution. - type: object - id: GoogleCloudRecaptchaenterpriseV1ScoreDistribution - GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: - id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction - description: >- - A substitute action transparently serves a different page than the one - requested. - properties: - path: - type: string + Optional. The value of shipping in the specified currency. 0 for + free or no shipping. + format: double + type: number + gatewayInfo: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo description: >- - Optional. The address to redirect to. The target is a relative path - in the current host. Example: "/blog/404.html". + Optional. Information about the payment gateway's response to the + transaction. + description: >- + Transaction data associated with a payment protected by reCAPTCHA + Enterprise. + type: object + id: GoogleCloudRecaptchaenterpriseV1TransactionData + GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment: + description: Policy config assessment. type: object - GoogleCloudRecaptchaenterpriseV1TokenProperties: - id: GoogleCloudRecaptchaenterpriseV1TokenProperties - description: Properties of the provided event token. properties: - hostname: + error: description: >- - Output only. The hostname of the page on which the token was - generated (Web keys only). - type: string + Output only. If the processing of a policy config fails, an error is + populated and the firewall_policy is left empty. + $ref: '#/components/schemas/GoogleRpcStatus' readOnly: true - createTime: + firewallPolicy: description: >- - Output only. The timestamp corresponding to the generation of the - token. - type: string + Output only. The policy that matched the request. If more than one + policy may match, this is the first match. If no policy matches the + incoming request, the policy field is left empty. readOnly: true - format: google-datetime - invalidReason: - enum: - - INVALID_REASON_UNSPECIFIED - - UNKNOWN_INVALID_REASON - - MALFORMED - - EXPIRED - - DUPE - - MISSING - - BROWSER_ERROR - enumDescriptions: - - Default unspecified type. - - If the failure reason was not accounted for. - - The provided user verification token was malformed. - - The user verification token had expired. - - The user verification had already been seen. - - The user verification token was not present. - - >- - A retriable error (such as network failure) occurred on the - browser. Could easily be simulated by an attacker. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy' + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse: + description: Empty response for AnnotateAssessment. + properties: {} + type: object + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + GoogleCloudRecaptchaenterpriseV1Metrics: + properties: + challengeMetrics: + type: array + description: >- + Metrics are continuous and in order by dates, and in the granularity + of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have + challenge-based data. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics + scoreMetrics: + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics' + description: >- + Metrics are continuous and in order by dates, and in the granularity + of day. All Key types should have score-based data. + startTime: type: string - description: Output only. Reason associated with the response when valid = false. - readOnly: true - action: + description: Inclusive start time aligned to a day (UTC). + format: google-datetime + name: readOnly: true - description: Output only. Action name provided at token generation. + description: >- + Output only. Identifier. The name of the metrics, in the format + `projects/{project}/keys/{key}/metrics`. type: string - iosBundleId: - readOnly: true + id: GoogleCloudRecaptchaenterpriseV1Metrics + description: Metrics for a single Key. + type: object + GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: + type: object + properties: + path: type: string description: >- - Output only. The ID of the iOS bundle with which the token was - generated (iOS keys only). - valid: + Optional. The address to redirect to. The target is a relative path + in the current host. Example: "/blog/404.html". + id: GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction + description: >- + A substitute action transparently serves a different page than the one + requested. + GoogleCloudRecaptchaenterpriseV1AndroidKeySettings: + properties: + supportNonGoogleAppStoreDistribution: type: boolean description: >- - Output only. Whether the provided user response token is valid. When - valid = false, the reason could be specified in invalid_reason or it - could also be due to a user failing to solve a challenge or a - sitekey mismatch (i.e the sitekey used to generate the token was - different than the one specified in the assessment). - readOnly: true - androidPackageName: - type: string - readOnly: true + Optional. Set to true for keys that are used in an Android + application that is available for download in app stores in addition + to the Google Play Store. + allowedPackageNames: + type: array + items: + type: string description: >- - Output only. The name of the Android package with which the token - was generated (Android keys only). + Optional. Android package names of apps allowed to use the key. + Example: 'com.companyname.appname' + allowAllPackageNames: + description: Optional. If set to true, allowed_package_names are not enforced. + type: boolean + type: object + id: GoogleCloudRecaptchaenterpriseV1AndroidKeySettings + description: Settings specific to keys that can be used by Android apps. + GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest: type: object - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict: - id: >- - GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict properties: - trust: - type: number + ipOverrideData: + description: Required. IP override to be removed from the key. + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IpOverrideData' + id: GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest + description: The removeIpOverride request message. + GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest: + properties: + names: + items: + type: string + type: array description: >- - Output only. Probability of this transaction attempt being executed - in a behaviorally trustworthy way. Values are from 0.0 (lowest) to - 1.0 (highest). - format: float - readOnly: true + Required. A list containing all policy names, in the new order. Each + name is in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + id: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest + description: The reorder firewall policies request message. type: object - description: Information about behavioral trust of the transaction. - GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo: + GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest: properties: - username: + transactionEvent: description: >- - Username of the account that is being verified. Deprecated. - Customers should now provide the `account_id` field in - `event.user_info`. - deprecated: true + Optional. If the assessment is part of a payment transaction, + provide details on payment lifecycle events that occur in the + transaction. + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent + reasons: + type: array + items: + enumDescriptions: + - Default unspecified reason. + - >- + Indicates that the transaction had a chargeback issued with no + other details. When possible, specify the type by using + CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. + - >- + Indicates that the transaction had a chargeback issued related + to an alleged unauthorized transaction from the cardholder's + perspective (for example, the card number was stolen). + - >- + Indicates that the transaction had a chargeback issued related + to the cardholder having provided their card details but + allegedly not being satisfied with the purchase (for example, + misrepresentation, attempted cancellation). + - >- + Indicates that the completed payment transaction was refunded by + the seller. + - >- + Indicates that the completed payment transaction was determined + to be fraudulent by the seller, and was cancelled and refunded + as a result. + - >- + Indicates that the payment transaction was accepted, and the + user was charged. + - >- + Indicates that the payment transaction was declined, for example + due to invalid card details. + - >- + Indicates the transaction associated with the assessment is + suspected of being fraudulent based on the payment method, + billing details, shipping address or other transaction + information. + - >- + Indicates that the user was served a 2FA challenge. An old + assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that + has not been overwritten with `PASSED_TWO_FACTOR` is treated as + an abandoned 2FA flow. This is equivalent to + `FAILED_TWO_FACTOR`. + - Indicates that the user passed a 2FA challenge. + - Indicates that the user failed a 2FA challenge. + - Indicates the user provided the correct password. + - Indicates the user provided an incorrect password. + - >- + Indicates that the user sent unwanted and abusive messages to + other users of the platform, such as spam, scams, phishing, or + social engineering. + type: string + enum: + - REASON_UNSPECIFIED + - CHARGEBACK + - CHARGEBACK_FRAUD + - CHARGEBACK_DISPUTE + - REFUND + - REFUND_FRAUD + - TRANSACTION_ACCEPTED + - TRANSACTION_DECLINED + - PAYMENT_HEURISTICS + - INITIATED_TWO_FACTOR + - PASSED_TWO_FACTOR + - FAILED_TWO_FACTOR + - CORRECT_PASSWORD + - INCORRECT_PASSWORD + - SOCIAL_SPAM + description: Optional. Reasons for the annotation that are assigned to the event. + accountId: type: string - latestVerificationResult: + description: >- + Optional. A stable account identifier to apply to the assessment. + This is an alternative to setting `account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. + hashedAccountId: + type: string + description: >- + Optional. A stable hashed account identifier to apply to the + assessment. This is an alternative to setting `hashed_account_id` in + `CreateAssessment`, for example when a stable account identifier is + not yet known in the initial request. + format: byte + annotation: + enumDeprecated: + - false + - false + - false + - true + - true + enum: + - ANNOTATION_UNSPECIFIED + - LEGITIMATE + - FRAUDULENT + - PASSWORD_CORRECT + - PASSWORD_INCORRECT type: string + description: >- + Optional. The annotation that is assigned to the Event. This field + can be left empty to provide reasons that apply to an event without + concluding whether the event is legitimate or fraudulent. enumDescriptions: - - No information about the latest account verification. - - >- - The user was successfully verified. This means the account - verification challenge was successfully completed. - - The user failed the verification challenge. - - >- - The site is not properly onboarded to use the account verification - feature. - - >- - The recipient is not allowed for account verification. This can - occur during integration but should not occur in production. - - >- - The recipient has already been sent too many verification codes in - a short amount of time. - - >- - The verification flow could not be completed due to a critical - internal error. - - >- - The client has exceeded their two factor request quota for this - period of time. + - Default unspecified type. + - Provides information that the event turned out to be legitimate. + - Provides information that the event turned out to be fraudulent. - >- - The request cannot be processed at the time because of an - incident. This bypass can be restricted to a problematic - destination email domain, a customer, or could affect the entire - service. + Provides information that the event was related to a login event + in which the user typed the correct password. Deprecated, prefer + indicating CORRECT_PASSWORD through the reasons field instead. - >- - The request parameters do not match with the token provided and - cannot be processed. - enum: - - RESULT_UNSPECIFIED - - SUCCESS_USER_VERIFIED - - ERROR_USER_NOT_VERIFIED - - ERROR_SITE_ONBOARDING_INCOMPLETE - - ERROR_RECIPIENT_NOT_ALLOWED - - ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED - - ERROR_CRITICAL_INTERNAL - - ERROR_CUSTOMER_QUOTA_EXHAUSTED - - ERROR_VERIFICATION_BYPASSED - - ERROR_VERDICT_MISMATCH - description: Output only. Result of the latest account verification challenge. - readOnly: true - endpoints: + Provides information that the event was related to a login event + in which the user typed the incorrect password. Deprecated, prefer + indicating INCORRECT_PASSWORD through the reasons field instead. + type: object + description: The request message to annotate an Assessment. + id: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse: + type: object + description: The response to a `ListRelatedAccountGroupMemberships` call. + id: >- + GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + properties: + relatedAccountGroupMemberships: + description: The memberships listed by the query. items: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo - description: Optional. Endpoints that can be used for identity verification. + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership type: array - languageCode: + nextPageToken: type: string description: >- - Optional. Language code preference for the verification message, set - as a IETF BCP 47 language code. - description: Information about account verification, used for identity verification. - type: object - id: GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo - GoogleCloudRecaptchaenterpriseV1Key: - type: object - id: GoogleCloudRecaptchaenterpriseV1Key + A token, which can be sent as `page_token` to retrieve the next + page. If this field is omitted, there are no subsequent pages. + GoogleCloudRecaptchaenterpriseV1ListKeysResponse: + description: Response to request to list keys in a project. properties: - testingOptions: - description: Optional. Options for user acceptance testing. - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions' - name: - type: string - description: >- - Identifier. The resource name for the Key in the format - `projects/{project}/keys/{key}`. - wafSettings: - description: Optional. Settings for WAF - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings' - webSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings' - description: Settings for keys that can be used by websites. - displayName: + nextPageToken: type: string description: >- - Required. Human-readable display name of this key. Modifiable by - user. - createTime: - format: google-datetime + Token to retrieve the next page of results. It is set to empty if no + keys remain in results. + keys: + description: Key details. + items: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + type: array + type: object + id: GoogleCloudRecaptchaenterpriseV1ListKeysResponse + GoogleCloudRecaptchaenterpriseV1ExpressKeySettings: + id: GoogleCloudRecaptchaenterpriseV1ExpressKeySettings + properties: {} + type: object + description: Settings specific to keys that can be used for reCAPTCHA Express. + GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment: + type: object + properties: + behavioralTrustVerdict: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict + description: Output only. Assessment of this transaction for behavioral trust. + readOnly: true + stolenInstrumentVerdict: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict description: >- - Output only. The timestamp corresponding to the creation of this - key. + Output only. Assessment of this transaction for risk of a stolen + instrument. readOnly: true - type: string - labels: + transactionRisk: + readOnly: true + format: float description: >- - Optional. See [Creating and managing labels] - (https://cloud.google.com/recaptcha-enterprise/docs/labels). - type: object - additionalProperties: - type: string - iosSettings: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings' - description: Settings for keys that can be used by iOS apps. - androidSettings: + Output only. Probability of this transaction being fraudulent. + Summarizes the combined risk of attack vectors below. Values are + from 0.0 (lowest) to 1.0 (highest). + type: number + cardTestingVerdict: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings - description: Settings for keys that can be used by Android apps. - description: >- - A key used to identify and configure applications (web and/or mobile) - that use reCAPTCHA Enterprise. - GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership: - id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership - description: A membership in a group of related accounts. - type: object + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict + description: >- + Output only. Assessment of this transaction for risk of being part + of a card testing attack. + readOnly: true + id: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment + description: Assessment for Fraud Prevention. + GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup: properties: name: - description: >- - Required. Identifier. The resource name for this membership in the - format - `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. - type: string - accountId: - description: >- - The unique stable account identifier of the member. The identifier - corresponds to an `account_id` provided in a previous - `CreateAssessment` or `AnnotateAssessment` call. type: string - hashedAccountId: description: >- - Deprecated: use `account_id` instead. The unique stable hashed - account identifier of the member. The identifier corresponds to a - `hashed_account_id` provided in a previous `CreateAssessment` or - `AnnotateAssessment` call. - type: string - format: byte - deprecated: true + Required. Identifier. The resource name for the related account + group in the format + `projects/{project}/relatedaccountgroups/{related_account_group}`. + type: object + id: GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup + description: A group of related accounts. GoogleCloudRecaptchaenterpriseV1WebKeySettings: + type: object description: Settings specific to keys that can be used by websites. id: GoogleCloudRecaptchaenterpriseV1WebKeySettings - type: object properties: - integrationType: + challengeSecurityPreference: + enumDescriptions: + - Default type that indicates this enum hasn't been specified. + - Key tends to show fewer and easier challenges. + - Key tends to show balanced (in amount and difficulty) challenges. + - Key tends to show more and harder challenges. + description: >- + Optional. Settings for the frequency and difficulty at which this + key triggers captcha challenges. This should only be specified for + IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. + type: string enum: - - INTEGRATION_TYPE_UNSPECIFIED - - SCORE - - CHECKBOX - - INVISIBLE + - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED + - USABILITY + - BALANCE + - SECURITY + allowAllDomains: + type: boolean + description: Optional. If set to true, it means allowed_domains are not enforced. + allowAmpTraffic: + description: >- + Optional. If set to true, the key can be used on AMP (Accelerated + Mobile Pages) websites. This is supported only for the SCORE + integration type. + type: boolean + integrationType: enumDescriptions: - >- Default type that indicates this enum hasn't been specified. This @@ -1870,67 +1904,137 @@ components: captcha challenges after risk analysis. description: Required. Describes how this key is integrated with the website. type: string - allowAmpTraffic: - type: boolean + enum: + - INTEGRATION_TYPE_UNSPECIFIED + - SCORE + - CHECKBOX + - INVISIBLE + allowedDomains: + type: array + items: + type: string description: >- - Optional. If set to true, the key can be used on AMP (Accelerated - Mobile Pages) websites. This is supported only for the SCORE - integration type. - allowAllDomains: - type: boolean + Optional. Domains or subdomains of websites allowed to use the key. + All subdomains of an allowed domain are automatically allowed. A + valid domain requires a host and must not include any path, port, + query or fragment. Examples: 'example.com' or + 'subdomain.example.com' + GoogleCloudRecaptchaenterpriseV1AppleDeveloperId: + type: object + properties: + keyId: + type: string + description: Required. The Apple developer key ID (10-character string). + privateKey: description: >- - Optional. If set to true, it means allowed_domains will not be - enforced. - challengeSecurityPreference: + Required. Input only. A private key (downloaded as a text file with + a .p8 file extension) generated for your Apple Developer account. + Ensure that Apple DeviceCheck is enabled for the private key. + type: string + teamId: description: >- - Optional. Settings for the frequency and difficulty at which this - key triggers captcha challenges. This should only be specified for - IntegrationTypes CHECKBOX and INVISIBLE. + Required. The Apple team ID (10-character string) owning the + provisioning profile used to build your application. + type: string + id: GoogleCloudRecaptchaenterpriseV1AppleDeveloperId + description: >- + Contains fields that are required to perform Apple-specific integrity + checks. + GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo: + properties: + name: + type: string + description: >- + Optional. Name of the gateway service (for example, stripe, square, + paypal). + cvvResponseCode: + type: string + description: >- + Optional. CVV response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + avsResponseCode: + description: >- + Optional. AVS response code from the gateway (available only when + reCAPTCHA Enterprise is called after authorization). + type: string + gatewayResponseCode: + type: string + description: >- + Optional. Gateway response code describing the state of the + transaction. + id: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo + description: Details about the transaction from the gateway. + type: object + GoogleCloudRecaptchaenterpriseV1FirewallPolicy: + type: object + description: >- + A FirewallPolicy represents a single matching pattern and resulting + actions to take. + properties: + name: + description: >- + Identifier. The resource name for the FirewallPolicy in the format + `projects/{project}/firewallpolicies/{firewallpolicy}`. + type: string + condition: + type: string + description: >- + Optional. A CEL (Common Expression Language) conditional expression + that specifies if this policy applies to an incoming user request. + If this condition evaluates to true and the requested path matched + the path pattern, the associated actions should be executed by the + caller. The condition string is checked for CEL syntax correctness + on creation. For more information, see the [CEL + spec](https://github.com/google/cel-spec) and its [language + definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). + A condition has a max length of 500 characters. + description: + description: >- + Optional. A description of what this policy aims to achieve, for + convenience purposes. The description can at most include 256 UTF-8 + characters. type: string - enumDescriptions: - - Default type that indicates this enum hasn't been specified. - - Key tends to show fewer and easier challenges. - - Key tends to show balanced (in amount and difficulty) challenges. - - Key tends to show more and harder challenges. - enum: - - CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED - - USABILITY - - BALANCE - - SECURITY - allowedDomains: - items: - type: string + actions: type: array description: >- - Optional. Domains or subdomains of websites allowed to use the key. - All subdomains of an allowed domain are automatically allowed. A - valid domain requires a host and must not include any path, port, - query or fragment. Examples: 'example.com' or - 'subdomain.example.com' - GoogleCloudRecaptchaenterpriseV1ScoreMetrics: - description: Metrics related to scoring. - id: GoogleCloudRecaptchaenterpriseV1ScoreMetrics + Optional. The actions that the caller should take regarding user + access. There should be at most one terminal action. A terminal + action is any action that forces a response, such as `AllowAction`, + `BlockAction` or `SubstituteAction`. Zero or more non-terminal + actions such as `SetHeader` might be specified. A single policy can + contain up to 16 actions. + items: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction + path: + type: string + description: >- + Optional. The path for which this policy applies, specified as a + glob pattern. For more information on glob, see the [manual + page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has + a max length of 200 characters. + id: GoogleCloudRecaptchaenterpriseV1FirewallPolicy + GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse: + description: >- + Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd + party integration with legacy reCAPTCHA. type: object properties: - actionMetrics: - additionalProperties: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution - type: object + legacySecretKey: description: >- - Action-based metrics. The map key is the action name which specified - by the site owners at time of the "execute" client-side call. - overallMetrics: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreDistribution - description: Aggregated score metrics for all traffic. + The secret key (also known as shared secret) authorizes + communication between your application backend and the reCAPTCHA + Enterprise server to create an assessment. The secret key needs to + be kept safe for security purposes. + type: string + id: GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse parameters: - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: uploadType + name: prettyPrint schema: - type: string + type: boolean alt: description: Data format for response. in: query @@ -1941,12 +2045,6 @@ components: - json - media - proto - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -1956,21 +2054,6 @@ components: enum: - '1' - '2' - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -1992,81 +2075,155 @@ components: name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + callback: + description: JSONP in: query - name: prettyPrint + name: callback schema: - type: boolean + type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields + schema: + type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string x-stackQL-resources: - assessments: - id: google.recaptchaenterprise.assessments - name: assessments - title: Assessments + firewallpolicies: + id: google.recaptchaenterprise.firewallpolicies + name: firewallpolicies + title: Firewallpolicies methods: - annotate: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1assessments~1{assessmentsId}:annotate/post + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + reorder: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/post + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.firewallPolicies create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1assessments/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/get' + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/list' insert: - - $ref: '#/components/x-stackQL-resources/assessments/methods/create' + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/patch' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/delete' + keys_metrics: + id: google.recaptchaenterprise.keys_metrics + name: keys_metrics + title: Keys_metrics + methods: + get_metrics: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' + insert: [] update: [] + replace: [] delete: [] - relatedaccountgroupmemberships: - id: google.recaptchaenterprise.relatedaccountgroupmemberships - name: relatedaccountgroupmemberships - title: Relatedaccountgroupmemberships + keys_ip_override: + id: google.recaptchaenterprise.keys_ip_override + name: keys_ip_override + title: Keys_ip_override methods: - search: + add_ip_override: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:addIpOverride/post + response: + mediaType: application/json + openAPIDocKey: '200' + remove_ip_override: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:removeIpOverride/post response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/keys_ip_override/methods/add_ip_override update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/keys_ip_override/methods/remove_ip_override keys: id: google.recaptchaenterprise.keys name: keys title: Keys methods: - create: + migrate: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.keys - list: - operation: *ref_1 - response: *ref_2 delete: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}/delete' @@ -2085,9 +2242,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - migrate: + list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:migrate/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.keys + create: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys/post' response: mediaType: application/json openAPIDocKey: '200' @@ -2099,24 +2263,29 @@ components: - $ref: '#/components/x-stackQL-resources/keys/methods/create' update: - $ref: '#/components/x-stackQL-resources/keys/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/keys/methods/delete' - keys_metrics: - id: google.recaptchaenterprise.keys_metrics - name: keys_metrics - title: Keys_metrics + keys_ip_overrides: + id: google.recaptchaenterprise.keys_ip_overrides + name: keys_ip_overrides + title: Keys_ip_overrides methods: - get_metrics: + list_ip_overrides: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}~1metrics/get' + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1keys~1{keysId}:listIpOverrides/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.ipOverrides sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/keys_metrics/methods/get_metrics' + - $ref: >- + #/components/x-stackQL-resources/keys_ip_overrides/methods/list_ip_overrides insert: [] update: [] + replace: [] delete: [] keys_legacy_secret_key: id: google.recaptchaenterprise.keys_legacy_secret_key @@ -2131,138 +2300,211 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/keys_legacy_secret_key/methods/retrieve_legacy_secret_key insert: [] update: [] + replace: [] delete: [] - firewallpolicies: - id: google.recaptchaenterprise.firewallpolicies - name: firewallpolicies - title: Firewallpolicies + assessments: + id: google.recaptchaenterprise.assessments + name: assessments + title: Assessments methods: - delete: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/delete - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/patch - response: - mediaType: application/json - openAPIDocKey: '200' - get: + annotate: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies~1{firewallpoliciesId}/get + #/paths/~1v1~1projects~1{projectsId}~1assessments~1{assessmentsId}:annotate/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/get' - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.firewallPolicies - list: - operation: *ref_3 - response: *ref_4 create: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1firewallpolicies/post' + $ref: '#/paths/~1v1~1projects~1{projectsId}~1assessments/post' response: mediaType: application/json openAPIDocKey: '200' - reorder: + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/assessments/methods/create' + update: [] + replace: [] + delete: [] + memberships: + id: google.recaptchaenterprise.memberships + name: memberships + title: Memberships + methods: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1firewallpolicies:reorder/post + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.relatedAccountGroupMemberships sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/get' - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/firewallpolicies/methods/delete' + - $ref: '#/components/x-stackQL-resources/memberships/methods/list' + insert: [] + update: [] + replace: [] + delete: [] relatedaccountgroups: id: google.recaptchaenterprise.relatedaccountgroups name: relatedaccountgroups title: Relatedaccountgroups methods: - _list: - operation: &ref_5 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.relatedAccountGroups - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/relatedaccountgroups/methods/list' insert: [] update: [] + replace: [] delete: [] - memberships: - id: google.recaptchaenterprise.memberships - name: memberships - title: Memberships + relatedaccountgroupmemberships: + id: google.recaptchaenterprise.relatedaccountgroupmemberships + name: relatedaccountgroupmemberships + title: Relatedaccountgroupmemberships methods: - _list: - operation: &ref_7 + search: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroups~1{relatedaccountgroupsId}~1memberships/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1relatedaccountgroupmemberships:search/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.relatedAccountGroupMemberships - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/memberships/methods/list' + select: [] insert: [] update: [] + replace: [] delete: [] paths: - /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate: - parameters: &ref_9 - - $ref: '#/components/parameters/uploadType' + /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: + parameters: &ref_1 + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/callback' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/quotaUser' + get: + description: Returns the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: firewallpoliciesId + required: true + schema: + type: string + patch: + description: Updates the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.patch + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: firewallpoliciesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes the specified firewall policy. + operationId: recaptchaenterprise.projects.firewallpolicies.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleProtobufEmpty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: firewallpoliciesId + required: true + schema: + type: string + /v1/projects/{projectsId}/firewallpolicies:reorder: + parameters: *ref_1 post: - description: >- - Annotates a previously created Assessment to provide additional - information on whether the event turned out to be authentic or - fraudulent. - operationId: recaptchaenterprise.projects.assessments.annotate + description: Reorders all firewall policies. + operationId: recaptchaenterprise.projects.firewallpolicies.reorder requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2275,28 +2517,58 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse parameters: - in: path name: projectsId required: true schema: type: string + /v1/projects/{projectsId}/firewallpolicies: + parameters: *ref_1 + get: + description: Returns the list of all firewall policies that belong to a project. + operationId: recaptchaenterprise.projects.firewallpolicies.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + parameters: - in: path - name: assessmentsId + name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/assessments: - parameters: *ref_9 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Creates an Assessment of the likelihood an event is legitimate. - operationId: recaptchaenterprise.projects.assessments.create + description: >- + Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA + Enterprise actions can be executed. A project may have a maximum of 1000 + policies. + operationId: recaptchaenterprise.projects.firewallpolicies.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2309,24 +2581,58 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment + #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy parameters: - in: path name: projectsId required: true schema: type: string - /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: - parameters: *ref_9 + /v1/projects/{projectsId}/keys/{keysId}/metrics: + parameters: *ref_1 + get: + description: >- + Get some aggregated metrics for a Key. This data can be used to build + dashboards. + operationId: recaptchaenterprise.projects.keys.getMetrics + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/keys/{keysId}:addIpOverride: + parameters: *ref_1 post: - description: Search group memberships related to a given account. - operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search + description: >- + Adds an IP override to a key. The following restrictions hold: * The + maximum number of IP overrides per key is 100. * For any conflict (such + as IP already exists or IP part of an existing IP range), an error is + returned. + operationId: recaptchaenterprise.projects.keys.addIpOverride requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2339,23 +2645,34 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse parameters: - in: path - name: projectsId + name: projectsId + required: true + schema: + type: string + - in: path + name: keysId required: true schema: type: string - /v1/projects/{projectsId}/keys: - parameters: *ref_9 + /v1/projects/{projectsId}/keys/{keysId}:migrate: + parameters: *ref_1 post: - description: Creates a new reCAPTCHA Enterprise key. - operationId: recaptchaenterprise.projects.keys.create + description: >- + Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a + key is migrated, it can be used from either product. SiteVerify requests + are billed as CreateAssessment calls. You must be authenticated as one + of the current owners of the reCAPTCHA Key, and your user must have the + reCAPTCHA Enterprise Admin IAM role in the destination project. + operationId: recaptchaenterprise.projects.keys.migrate requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2374,9 +2691,26 @@ paths: required: true schema: type: string - get: - description: Returns the list of all keys that belong to a project. - operationId: recaptchaenterprise.projects.keys.list + - in: path + name: keysId + required: true + schema: + type: string + /v1/projects/{projectsId}/keys/{keysId}:removeIpOverride: + parameters: *ref_1 + post: + description: >- + Removes an IP override from a key. The following restrictions hold: * If + the IP isn't found in an existing IP override, a `NOT_FOUND` error is + returned. * If the IP is found in an existing IP override, but the + override type does not match, a `NOT_FOUND` error is returned. + operationId: recaptchaenterprise.projects.keys.removeIpOverride + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2389,24 +2723,20 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: keysId + required: true schema: type: string /v1/projects/{projectsId}/keys/{keysId}: - parameters: *ref_9 + parameters: *ref_1 delete: description: Deletes the specified key. operationId: recaptchaenterprise.projects.keys.delete @@ -2495,13 +2825,11 @@ paths: schema: type: string format: google-fieldmask - /v1/projects/{projectsId}/keys/{keysId}/metrics: - parameters: *ref_9 + /v1/projects/{projectsId}/keys/{keysId}:listIpOverrides: + parameters: *ref_1 get: - description: >- - Get some aggregated metrics for a Key. This data can be used to build - dashboards. - operationId: recaptchaenterprise.projects.keys.getMetrics + description: Lists all IP overrides for a key. + operationId: recaptchaenterprise.projects.keys.listIpOverrides security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2513,7 +2841,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse parameters: - in: path name: projectsId @@ -2525,14 +2854,20 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: - parameters: *ref_9 + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/keys: + parameters: *ref_1 get: - description: >- - Returns the secret key related to the specified public key. You must use - the legacy secret key only in a 3rd party integration with legacy - reCAPTCHA. - operationId: recaptchaenterprise.projects.keys.retrieveLegacySecretKey + description: Returns the list of all keys that belong to a project. + operationId: recaptchaenterprise.projects.keys.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2545,34 +2880,30 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: keysId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/keys/{keysId}:migrate: - parameters: *ref_9 post: - description: >- - Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a - key is migrated, it can be used from either product. SiteVerify requests - are billed as CreateAssessment calls. You must be authenticated as one - of the current owners of the reCAPTCHA Key, and your user must have the - reCAPTCHA Enterprise Admin IAM role in the destination project. - operationId: recaptchaenterprise.projects.keys.migrate + description: Creates a new reCAPTCHA Enterprise key. + operationId: recaptchaenterprise.projects.keys.create requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2591,16 +2922,14 @@ paths: required: true schema: type: string - - in: path - name: keysId - required: true - schema: - type: string - /v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}: - parameters: *ref_9 - delete: - description: Deletes the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.delete + /v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey: + parameters: *ref_1 + get: + description: >- + Returns the secret key related to the specified public key. You must use + the legacy secret key only in a 3rd party integration with legacy + reCAPTCHA. + operationId: recaptchaenterprise.projects.keys.retrieveLegacySecretKey security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2612,7 +2941,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleProtobufEmpty' + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse parameters: - in: path name: projectsId @@ -2620,19 +2950,24 @@ paths: schema: type: string - in: path - name: firewallpoliciesId + name: keysId required: true schema: type: string - patch: - description: Updates the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.patch + /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate: + parameters: *ref_1 + post: + description: >- + Annotates a previously created Assessment to provide additional + information on whether the event turned out to be authentic or + fraudulent. + operationId: recaptchaenterprise.projects.assessments.annotate requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2645,7 +2980,7 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse parameters: - in: path name: projectsId @@ -2653,18 +2988,20 @@ paths: schema: type: string - in: path - name: firewallpoliciesId + name: assessmentsId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - get: - description: Returns the specified firewall policy. - operationId: recaptchaenterprise.projects.firewallpolicies.get + /v1/projects/{projectsId}/assessments: + parameters: *ref_1 + post: + description: Creates an Assessment of the likelihood an event is legitimate. + operationId: recaptchaenterprise.projects.assessments.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2677,23 +3014,18 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy + #/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: firewallpoliciesId - required: true - schema: - type: string - /v1/projects/{projectsId}/firewallpolicies: - parameters: *ref_9 + /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: + parameters: *ref_1 get: - description: Returns the list of all firewall policies that belong to a project. - operationId: recaptchaenterprise.projects.firewallpolicies.list + description: Get memberships in a group of related accounts. + operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2706,15 +3038,16 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageToken + - in: path + name: relatedaccountgroupsId + required: true schema: type: string - in: query @@ -2722,69 +3055,12 @@ paths: schema: type: integer format: int32 - post: - description: >- - Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA - Enterprise actions can be executed. A project may have a maximum of 1000 - policies. - operationId: recaptchaenterprise.projects.firewallpolicies.create - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v1/projects/{projectsId}/firewallpolicies:reorder: - parameters: *ref_9 - post: - description: Reorders all firewall policies. - operationId: recaptchaenterprise.projects.firewallpolicies.reorder - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse - parameters: - - in: path - name: projectsId - required: true + - in: query + name: pageToken schema: type: string /v1/projects/{projectsId}/relatedaccountgroups: - parameters: *ref_9 + parameters: *ref_1 get: description: List groups of related accounts. operationId: recaptchaenterprise.projects.relatedaccountgroups.list @@ -2816,11 +3092,17 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/relatedaccountgroups/{relatedaccountgroupsId}/memberships: - parameters: *ref_9 - get: - description: Get memberships in a group of related accounts. - operationId: recaptchaenterprise.projects.relatedaccountgroups.memberships.list + /v1/projects/{projectsId}/relatedaccountgroupmemberships:search: + parameters: *ref_1 + post: + description: Search group memberships related to a given account. + operationId: recaptchaenterprise.projects.relatedaccountgroupmemberships.search + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2833,24 +3115,10 @@ paths: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse + #/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: relatedaccountgroupsId - required: true - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml index 0c251941..7c5f553d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recommendationengine.yaml @@ -14,8 +14,8 @@ info: personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud. version: v1beta1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/recommendations-ai/docs servers: @@ -1582,17 +1582,14 @@ components: name: catalogs title: Catalogs methods: - _projects_locations_catalogs_list: - operation: &ref_1 + projects_locations_catalogs_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.catalogs - projects_locations_catalogs_list: - operation: *ref_1 - response: *ref_2 projects_locations_catalogs_patch: operation: $ref: >- @@ -1608,23 +1605,21 @@ components: update: - $ref: >- #/components/x-stackQL-resources/catalogs/methods/projects_locations_catalogs_patch + replace: [] delete: [] operations: id: google.recommendationengine.operations name: operations title: Operations methods: - _projects_locations_catalogs_operations_list: - operation: &ref_3 + projects_locations_catalogs_operations_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_catalogs_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_catalogs_operations_get: operation: $ref: >- @@ -1632,17 +1627,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_event_stores_operations_list: - operation: &ref_5 + projects_locations_catalogs_event_stores_operations_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1eventStores~1{eventStoresId}~1operations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_catalogs_event_stores_operations_list: - operation: *ref_5 - response: *ref_6 projects_locations_catalogs_event_stores_operations_get: operation: $ref: >- @@ -1662,6 +1654,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_catalogs_operations_list insert: [] update: [] + replace: [] delete: [] prediction_api_key_registrations: id: google.recommendationengine.prediction_api_key_registrations @@ -1675,17 +1668,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_event_stores_prediction_api_key_registrations_list: - operation: &ref_7 + projects_locations_catalogs_event_stores_prediction_api_key_registrations_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1eventStores~1{eventStoresId}~1predictionApiKeyRegistrations/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.predictionApiKeyRegistrations - projects_locations_catalogs_event_stores_prediction_api_key_registrations_list: - operation: *ref_7 - response: *ref_8 projects_locations_catalogs_event_stores_prediction_api_key_registrations_delete: operation: $ref: >- @@ -1701,6 +1691,7 @@ components: - $ref: >- #/components/x-stackQL-resources/prediction_api_key_registrations/methods/projects_locations_catalogs_event_stores_prediction_api_key_registrations_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/prediction_api_key_registrations/methods/projects_locations_catalogs_event_stores_prediction_api_key_registrations_delete @@ -1720,6 +1711,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] user_events: id: google.recommendationengine.user_events @@ -1740,17 +1732,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_event_stores_user_events_list: - operation: &ref_9 + projects_locations_catalogs_event_stores_user_events_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1eventStores~1{eventStoresId}~1userEvents/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.userEvents - projects_locations_catalogs_event_stores_user_events_list: - operation: *ref_9 - response: *ref_10 projects_locations_catalogs_event_stores_user_events_purge: operation: $ref: >- @@ -1778,6 +1767,7 @@ components: #/components/x-stackQL-resources/user_events/methods/projects_locations_catalogs_event_stores_user_events_list insert: [] update: [] + replace: [] delete: [] catalog_items: id: google.recommendationengine.catalog_items @@ -1791,17 +1781,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_catalog_items_list: - operation: &ref_11 + projects_locations_catalogs_catalog_items_list: + operation: $ref: >- #/paths/~1v1beta1~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1catalogItems/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.catalogItems - projects_locations_catalogs_catalog_items_list: - operation: *ref_11 - response: *ref_12 projects_locations_catalogs_catalog_items_get: operation: $ref: >- @@ -1842,12 +1829,13 @@ components: update: - $ref: >- #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/catalog_items/methods/projects_locations_catalogs_catalog_items_delete paths: /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1896,7 +1884,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}: - parameters: *ref_13 + parameters: *ref_1 patch: description: Updates the catalog configuration. operationId: recommendationengine.projects.locations.catalogs.patch @@ -1941,7 +1929,7 @@ paths: type: string format: google-fieldmask /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1989,7 +1977,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations/{operationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2030,7 +2018,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/operations: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2084,7 +2072,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/operations/{operationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2131,7 +2119,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/predictionApiKeyRegistrations: - parameters: *ref_13 + parameters: *ref_1 post: description: Register an API key for use with predict method. operationId: >- @@ -2224,7 +2212,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/predictionApiKeyRegistrations/{predictionApiKeyRegistrationsId}: - parameters: *ref_13 + parameters: *ref_1 delete: description: Unregister an apiKey from using for predict method. operationId: >- @@ -2268,7 +2256,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/placements/{placementsId}:predict: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Makes a recommendation prediction. If using API Key based @@ -2323,7 +2311,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:write: - parameters: *ref_13 + parameters: *ref_1 post: description: Writes a single user event. operationId: >- @@ -2369,7 +2357,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:collect: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Writes a single user event from the browser. This uses a GET request to @@ -2425,7 +2413,7 @@ paths: type: string format: int64 /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets a list of user events within a time range, with potential @@ -2485,7 +2473,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:purge: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Deletes permanently all user events specified by the filter provided. @@ -2534,7 +2522,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:import: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Bulk import of User events. Request processing might be synchronous. @@ -2584,7 +2572,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/eventStores/{eventStoresId}/userEvents:rejoin: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Triggers a user event rejoin operation with latest catalog data. Events @@ -2636,7 +2624,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/catalogItems: - parameters: *ref_13 + parameters: *ref_1 post: description: Creates a catalog item. operationId: recommendationengine.projects.locations.catalogs.catalogItems.create @@ -2721,7 +2709,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/catalogItems/{catalogItemsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a specific catalog item. operationId: recommendationengine.projects.locations.catalogs.catalogItems.get @@ -2846,7 +2834,7 @@ paths: schema: type: string /v1beta1/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/catalogItems:import: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Bulk import of multiple catalog items. Request processing may be diff --git a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml index 050c5dbd..93624106 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/recommender.yaml @@ -7,8 +7,8 @@ info: title: Recommender API description: '' version: v1 - x-discovery-doc-revision: '20240519' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/recommender/docs/ servers: @@ -34,48 +34,36 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleTypeMoney: - type: object - description: Represents an amount of money with its currency type. - id: GoogleTypeMoney + GoogleCloudRecommenderV1ReliabilityProjection: properties: - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - units: - type: string - format: int64 - description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - nanos: - format: int32 - type: integer - description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - GoogleCloudRecommenderV1SustainabilityProjection: + risks: + type: array + items: + enum: + - RISK_TYPE_UNSPECIFIED + - SERVICE_DISRUPTION + - DATA_LOSS + - ACCESS_DENY + type: string + enumDescriptions: + - Default unspecified risk. Don't use directly. + - Potential service downtime. + - Potential data loss. + - >- + Potential access denial. The service is still up but some or all + clients can't access it. + description: Reliability risks mitigated by this recommendation. + details: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: Per-recommender projection. + description: Contains information on the impact of a reliability recommendation. type: object - id: GoogleCloudRecommenderV1SustainabilityProjection - description: >- - Contains metadata about how much sustainability a recommendation can - save or incur. - properties: - kgCO2e: - format: double - description: >- - Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e - so that the name renders correctly in camelCase (kgCO2e). - type: number - duration: - type: string - description: Duration for which this sustainability applies. - format: google-duration - GoogleCloudRecommenderV1MarkRecommendationFailedRequest: + id: GoogleCloudRecommenderV1ReliabilityProjection + GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: + description: Request for the `MarkRecommendationSucceeded` Method. properties: etag: description: >- @@ -90,46 +78,153 @@ components: `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. type: object + id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + type: object + GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: + description: Request for the `MarkRecommendationClaimed` Method. type: object - id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest - description: Request for the `MarkRecommendationFailed` Method. - GoogleCloudRecommenderV1RecommendationInsightReference: properties: - insight: + stateMetadata: + type: object description: >- - Insight resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] + State properties to include with this state. Overwrites any existing + `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + additionalProperties: + type: string + etag: + description: >- + Required. Fingerprint of the Recommendation. Provides optimistic + locking. type: string - id: GoogleCloudRecommenderV1RecommendationInsightReference - description: Reference to an associated insight. + id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + GoogleCloudRecommenderV1InsightTypeGenerationConfig: + description: >- + A configuration to customize the generation of insights. Eg, customizing + the lookback period considered when generating a insight. type: object - GoogleCloudRecommenderV1ListInsightsResponse: - description: Response to the `ListInsights` method. + id: GoogleCloudRecommenderV1InsightTypeGenerationConfig + properties: + params: + additionalProperties: + description: Properties of the object. + type: any + type: object + description: >- + Parameters for this InsightTypeGenerationConfig. These configs can + be used by or are applied to all subtypes. + GoogleCloudRecommenderV1SecurityProjection: + properties: + details: + description: >- + Additional security impact details that is provided by the + recommender. + type: object + additionalProperties: + description: Properties of the object. + type: any + type: object + id: GoogleCloudRecommenderV1SecurityProjection + description: Contains various ways of describing the impact on Security. + GoogleCloudRecommenderV1InsightStateInfo: type: object + id: GoogleCloudRecommenderV1InsightStateInfo + properties: + state: + enumDescriptions: + - Unspecified state. + - >- + Insight is active. Content for ACTIVE insights can be updated by + Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. + - >- + Some action has been taken based on this insight. Insights become + accepted when a recommendation derived from the insight has been + marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be + marked ACCEPTED explicitly. Content for ACCEPTED insights is + immutable. ACCEPTED insights can only be marked ACCEPTED (which + may update state metadata). + - >- + Insight is dismissed. Content for DISMISSED insights can be + updated by Google. DISMISSED insights can be marked as ACTIVE. + type: string + description: Insight state. + enum: + - STATE_UNSPECIFIED + - ACTIVE + - ACCEPTED + - DISMISSED + stateMetadata: + additionalProperties: + type: string + type: object + description: >- + A map of metadata for the state, provided by user or automations + systems. + description: Information related to insight state. + GoogleCloudRecommenderV1ListInsightsResponse: properties: - insights: - description: The set of insights for the `parent` resource. - type: array - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' nextPageToken: type: string description: >- A token that can be used to request the next page of results. This field is empty if there are no additional results. + insights: + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + description: The set of insights for the `parent` resource. id: GoogleCloudRecommenderV1ListInsightsResponse + type: object + description: Response to the `ListInsights` method. GoogleCloudRecommenderV1Insight: type: object properties: + observationPeriod: + description: >- + Observation period that led to the insight. The source data used to + generate the insight ends at last_refresh_time and begins at + (last_refresh_time - observation_period). + type: string + format: google-duration + name: + type: string + description: Identifier. Name of the insight. + description: + type: string + description: >- + Free-form human readable summary in English. The maximum length is + 500 characters. + targetResources: + description: Fully qualified resource names that this insight is targeting. + type: array + items: + type: string + etag: + type: string + description: >- + Fingerprint of the Insight. Provides optimistic locking when + updating states. + lastRefreshTime: + format: google-datetime + description: Timestamp of the latest data used to generate the insight. + type: string + stateInfo: + description: Information state and metadata. + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' + insightSubtype: + type: string + description: >- + Insight subtype. Insight content schema will be stable for a given + subtype. + content: + description: >- + A struct of custom fields to explain the insight. Example: + "grantedPermissionsCount": "1000" + type: object + additionalProperties: + description: Properties of the object. + type: any category: - enum: - - CATEGORY_UNSPECIFIED - - COST - - SECURITY - - PERFORMANCE - - MANAGEABILITY - - SUSTAINABILITY - - RELIABILITY description: Category being targeted by the insight. enumDescriptions: - Unspecified category. @@ -139,12 +234,20 @@ components: - This insight is related to manageability. - The insight is related to sustainability. - This insight is related to reliability. + enum: + - CATEGORY_UNSPECIFIED + - COST + - SECURITY + - PERFORMANCE + - MANAGEABILITY + - SUSTAINABILITY + - RELIABILITY type: string associatedRecommendations: + type: array items: $ref: >- #/components/schemas/GoogleCloudRecommenderV1InsightRecommendationReference - type: array description: Recommendations derived from this insight. severity: enum: @@ -154,122 +257,32 @@ components: - HIGH - CRITICAL type: string - description: Insight's severity. enumDescriptions: - Insight has unspecified severity. - Insight has low severity. - Insight has medium severity. - Insight has high severity. - Insight has critical severity. - etag: - description: >- - Fingerprint of the Insight. Provides optimistic locking when - updating states. - type: string - targetResources: - items: - type: string - description: Fully qualified resource names that this insight is targeting. - type: array - stateInfo: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightStateInfo' - description: Information state and metadata. - content: - description: >- - A struct of custom fields to explain the insight. Example: - "grantedPermissionsCount": "1000" - additionalProperties: - type: any - description: Properties of the object. - type: object - description: - type: string - description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. - insightSubtype: - description: >- - Insight subtype. Insight content schema will be stable for a given - subtype. - type: string - lastRefreshTime: - description: Timestamp of the latest data used to generate the insight. - type: string - format: google-datetime - observationPeriod: - description: >- - Observation period that led to the insight. The source data used to - generate the insight ends at last_refresh_time and begins at - (last_refresh_time - observation_period). - type: string - format: google-duration - name: - description: Identifier. Name of the insight. - type: string - id: GoogleCloudRecommenderV1Insight - description: >- - An insight along with the information used to derive the insight. The - insight may have associated recommendations as well. - GoogleCloudRecommenderV1RecommendationContent: - id: GoogleCloudRecommenderV1RecommendationContent - properties: - overview: - additionalProperties: - type: any - description: Properties of the object. - description: Condensed overview information about the recommendation. - type: object - operationGroups: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' - type: array - description: >- - Operations to one or more Google Cloud resources grouped in such a - way that, all operations within one group are expected to be - performed atomically and in an order. - description: Contains what resources are changing and how they are changing. - type: object - GoogleCloudRecommenderV1InsightStateInfo: - type: object - description: Information related to insight state. - properties: - stateMetadata: - type: object - additionalProperties: - type: string - description: >- - A map of metadata for the state, provided by user or automations - systems. - state: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - ACCEPTED - - DISMISSED - description: Insight state. + description: Insight's severity. + description: >- + An insight along with the information used to derive the insight. The + insight may have associated recommendations as well. + id: GoogleCloudRecommenderV1Insight + GoogleCloudRecommenderV1Impact: + type: object + description: Contains the impact a recommendation can have for a given category. + properties: + securityProjection: + $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' + description: Use with CategoryType.SECURITY + reliabilityProjection: + description: Use with CategoryType.RELIABILITY + $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' + costProjection: + $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' + description: Use with CategoryType.COST + category: type: string - enumDescriptions: - - Unspecified state. - - >- - Insight is active. Content for ACTIVE insights can be updated by - Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED. - - >- - Some action has been taken based on this insight. Insights become - accepted when a recommendation derived from the insight has been - marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be - marked ACCEPTED explicitly. Content for ACCEPTED insights is - immutable. ACCEPTED insights can only be marked ACCEPTED (which - may update state metadata). - - >- - Insight is dismissed. Content for DISMISSED insights can be - updated by Google. DISMISSED insights can be marked as ACTIVE. - id: GoogleCloudRecommenderV1InsightStateInfo - GoogleCloudRecommenderV1Impact: - properties: - costProjection: - description: Use with CategoryType.COST - $ref: '#/components/schemas/GoogleCloudRecommenderV1CostProjection' - category: enumDescriptions: - Default unspecified category. Don't use directly. - Indicates a potential increase or decrease in cost. @@ -279,7 +292,6 @@ components: - Indicates a potential increase or decrease in sustainability. - Indicates a potential increase or decrease in reliability. description: Category that is being targeted. - type: string enum: - CATEGORY_UNSPECIFIED - COST @@ -292,211 +304,100 @@ components: $ref: >- #/components/schemas/GoogleCloudRecommenderV1SustainabilityProjection description: Use with CategoryType.SUSTAINABILITY - reliabilityProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ReliabilityProjection' - description: Use with CategoryType.RELIABILITY - securityProjection: - $ref: '#/components/schemas/GoogleCloudRecommenderV1SecurityProjection' - description: Use with CategoryType.SECURITY id: GoogleCloudRecommenderV1Impact - description: Contains the impact a recommendation can have for a given category. - type: object - GoogleCloudRecommenderV1SecurityProjection: - description: Contains various ways of describing the impact on Security. - id: GoogleCloudRecommenderV1SecurityProjection - type: object - properties: - details: - type: object - additionalProperties: - description: Properties of the object. - type: any - description: >- - Additional security impact details that is provided by the - recommender. - GoogleCloudRecommenderV1Operation: - id: GoogleCloudRecommenderV1Operation + GoogleTypeMoney: properties: - value: - description: >- - Value for the `path` field. Will be set for actions:'add'/'replace'. - Maybe set for action: 'test'. Either this or `value_matcher` will be - set for 'test' operation. An exact match must be performed. - type: any - pathValueMatchers: - additionalProperties: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - type: object - description: >- - Similar to path_filters, this contains set of filters to apply if - `path` field refers to array elements. This is meant to support - value matching beyond exact match. To perform exact match, use - path_filters. When both path_filters and path_value_matchers are - set, an implicit AND must be performed. - action: - type: string - description: >- - Type of this operation. Contains one of 'add', 'remove', 'replace', - 'move', 'copy', 'test' and custom operations. This field is - case-insensitive and always populated. - path: - description: >- - Path to the target field being operated on. If the operation is at - the resource level, then path should be "/". This field is always - populated. - type: string - resourceType: - description: >- - Type of GCP resource being modified/tested. This field is always - populated. Example: cloudresourcemanager.googleapis.com/Project, - compute.googleapis.com/Instance - type: string - valueMatcher: - $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' - description: >- - Can be set for action 'test' for advanced matching for the value of - 'path' field. Either this or `value` will be set for 'test' - operation. - pathFilters: - additionalProperties: - type: any - description: >- - Set of filters to apply if `path` refers to array elements or nested - array elements in order to narrow down to a single unique element - that is being tested/modified. This is intended to be an exact match - per filter. To perform advanced matching, use path_value_matchers. * - Example: ``` { "/versions/*/name" : "it-123" - "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { - "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } - ``` * Example: ``` { "/bindings/*/role": "roles/owner" - "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` - When both path_filters and path_value_matchers are set, an implicit - AND must be performed. - type: object - resource: + currencyCode: type: string - description: >- - Contains the fully qualified resource name. This field is always - populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. - sourceResource: + description: The three-letter currency code defined in ISO 4217. + units: type: string description: >- - Can be set with action 'copy' to copy resource configuration across - different resources of the same type. Example: A resource clone can - be done via action = 'copy', path = "/", from = "/", source_resource - = and resource_name = . This field is empty for all other values of - `action`. - sourcePath: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. + format: int64 + nanos: description: >- - Can be set with action 'copy' or 'move' to indicate the source field - within resource or source_resource, ignored if provided for other - operation types. - type: string - description: >- - Contains an operation for a resource loosely based on the JSON-PATCH - format with support for: * Custom filters for describing partial array - patch. * Extended path values for describing nested arrays. * Custom - fields for describing the resource for which the operation is being - described. * Allows extension to custom operations not natively - supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for - details on the original RFC. - type: object - GoogleCloudRecommenderV1ReliabilityProjection: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + format: int32 + description: Represents an amount of money with its currency type. type: object - description: Contains information on the impact of a reliability recommendation. - id: GoogleCloudRecommenderV1ReliabilityProjection - properties: - risks: - description: Reliability risks mitigated by this recommendation. - items: - enum: - - RISK_TYPE_UNSPECIFIED - - SERVICE_DISRUPTION - - DATA_LOSS - - ACCESS_DENY - type: string - enumDescriptions: - - Default unspecified risk. Don't use directly. - - Potential service downtime. - - Potential data loss. - - >- - Potential access denial. The service is still up but some or all - clients can't access it. - type: array - details: - type: object - description: Per-recommender projection. - additionalProperties: - description: Properties of the object. - type: any - GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: + id: GoogleTypeMoney + GoogleCloudRecommenderV1CostProjection: + id: GoogleCloudRecommenderV1CostProjection type: object - description: Request for the `MarkRecommendationDismissed` Method. - id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest properties: - etag: - description: Fingerprint of the Recommendation. Provides optimistic locking. + costInLocalCurrency: + description: >- + The approximate cost savings in the billing account's local + currency. + $ref: '#/components/schemas/GoogleTypeMoney' + cost: + $ref: '#/components/schemas/GoogleTypeMoney' + description: >- + An approximate projection on amount saved or amount incurred. + Negative cost units indicate cost savings and positive cost units + indicate increase. See google.type.Money documentation for + positive/negative units. A user's permissions may affect whether the + cost is computed using list prices or custom contract prices. + duration: type: string - GoogleCloudRecommenderV1RecommenderGenerationConfig: - id: GoogleCloudRecommenderV1RecommenderGenerationConfig + description: Duration for which this cost applies. + format: google-duration + description: >- + Contains metadata about how much money a recommendation can save or + incur. + GoogleCloudRecommenderV1ListRecommendationsResponse: + id: GoogleCloudRecommenderV1ListRecommendationsResponse + description: Response to the `ListRecommendations` method. properties: - params: - additionalProperties: - type: any - description: Properties of the object. + nextPageToken: description: >- - Parameters for this RecommenderGenerationConfig. These configs can - be used by or are applied to all subtypes. - type: object - type: object - description: >- - A Configuration to customize the generation of recommendations. Eg, - customizing the lookback period considered when generating a - recommendation. - GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: - id: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + A token that can be used to request the next page of results. This + field is empty if there are no additional results. + type: string + recommendations: + description: The set of recommendations for the `parent` resource. + type: array + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' type: object + GoogleCloudRecommenderV1MarkRecommendationFailedRequest: + description: Request for the `MarkRecommendationFailed` Method. + id: GoogleCloudRecommenderV1MarkRecommendationFailedRequest properties: - etag: - type: string - description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. stateMetadata: - additionalProperties: - type: string description: >- State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - type: object - description: Request for the `MarkRecommendationClaimed` Method. - GoogleCloudRecommenderV1InsightTypeConfig: - type: object - properties: + Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. + type: object + additionalProperties: + type: string etag: - type: string description: >- - Fingerprint of the InsightTypeConfig. Provides optimistic locking - when updating. - updateTime: + Required. Fingerprint of the Recommendation. Provides optimistic + locking. type: string - format: google-datetime - description: Last time when the config was updated. + type: object + GoogleCloudRecommenderV1InsightTypeConfig: + properties: name: description: >- Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config type: string - revisionId: + updateTime: + format: google-datetime type: string - readOnly: true - description: >- - Output only. Immutable. The revision ID of the config. A new - revision is committed whenever the config is changed in any way. The - format is an 8-character hexadecimal string. + description: Last time when the config was updated. annotations: - type: object additionalProperties: type: string description: >- @@ -507,22 +408,36 @@ components: must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. + type: object + etag: + type: string + description: >- + Fingerprint of the InsightTypeConfig. Provides optimistic locking + when updating. displayName: type: string description: >- A user-settable field to provide a human-readable name to be used in user interfaces. + revisionId: + description: >- + Output only. Immutable. The revision ID of the config. A new + revision is committed whenever the config is changed in any way. The + format is an 8-character hexadecimal string. + readOnly: true + type: string insightTypeGenerationConfig: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig description: >- InsightTypeGenerationConfig which configures the generation of insights for this insight type. - description: Configuration for an InsightType. + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1InsightTypeGenerationConfig id: GoogleCloudRecommenderV1InsightTypeConfig + description: Configuration for an InsightType. + type: object GoogleCloudRecommenderV1ValueMatcher: + type: object id: GoogleCloudRecommenderV1ValueMatcher - description: Contains various matching options for values for a GCP resource field. properties: matchesPattern: type: string @@ -530,21 +445,39 @@ components: To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch + description: Contains various matching options for values for a GCP resource field. + GoogleCloudRecommenderV1MarkInsightAcceptedRequest: type: object + description: Request for the `MarkInsightAccepted` method. + properties: + etag: + description: Required. Fingerprint of the Insight. Provides optimistic locking. + type: string + stateMetadata: + additionalProperties: + type: string + description: >- + Optional. State properties user wish to include with this state. + Full replace of the current state_metadata. + type: object + id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest GoogleCloudRecommenderV1RecommenderConfig: - id: GoogleCloudRecommenderV1RecommenderConfig type: object description: Configuration for a Recommender. properties: - displayName: + revisionId: type: string description: >- - A user-settable field to provide a human-readable name to be used in - user interfaces. + Output only. Immutable. The revision ID of the config. A new + revision is committed whenever the config is changed in any way. The + format is an 8-character hexadecimal string. + readOnly: true + name: + description: >- + Identifier. Name of recommender config. Eg, + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config + type: string annotations: - type: object - additionalProperties: - type: string description: >- Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and @@ -553,311 +486,360 @@ components: must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. - etag: - type: string - description: >- - Fingerprint of the RecommenderConfig. Provides optimistic locking - when updating. + type: object + additionalProperties: + type: string recommenderGenerationConfig: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig description: >- RecommenderGenerationConfig which configures the Generation of recommendations for this recommender. + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommenderGenerationConfig updateTime: - type: string - description: Last time when the config was updated. format: google-datetime - revisionId: - description: >- - Output only. Immutable. The revision ID of the config. A new - revision is committed whenever the config is changed in any way. The - format is an 8-character hexadecimal string. - readOnly: true + description: Last time when the config was updated. type: string - name: + displayName: description: >- - Identifier. Name of recommender config. Eg, - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config + A user-settable field to provide a human-readable name to be used in + user interfaces. type: string - GoogleCloudRecommenderV1ListRecommendationsResponse: - properties: - recommendations: - items: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' - description: The set of recommendations for the `parent` resource. - type: array - nextPageToken: + etag: description: >- - A token that can be used to request the next page of results. This - field is empty if there are no additional results. + Fingerprint of the RecommenderConfig. Provides optimistic locking + when updating. type: string + id: GoogleCloudRecommenderV1RecommenderConfig + GoogleCloudRecommenderV1RecommendationInsightReference: type: object - description: Response to the `ListRecommendations` method. - id: GoogleCloudRecommenderV1ListRecommendationsResponse - GoogleCloudRecommenderV1InsightTypeGenerationConfig: - type: object - description: >- - A configuration to customize the generation of insights. Eg, customizing - the lookback period considered when generating a insight. properties: - params: - type: object + insight: + type: string description: >- - Parameters for this InsightTypeGenerationConfig. These configs can - be used by or are applied to all subtypes. - additionalProperties: - description: Properties of the object. - type: any - id: GoogleCloudRecommenderV1InsightTypeGenerationConfig + Insight resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] + description: Reference to an associated insight. + id: GoogleCloudRecommenderV1RecommendationInsightReference + GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: + id: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + type: object + properties: + etag: + description: Fingerprint of the Recommendation. Provides optimistic locking. + type: string + description: Request for the `MarkRecommendationDismissed` Method. GoogleCloudRecommenderV1OperationGroup: description: Group of operations that need to be performed atomically. - id: GoogleCloudRecommenderV1OperationGroup properties: operations: - type: array items: $ref: '#/components/schemas/GoogleCloudRecommenderV1Operation' description: >- List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear. + type: array + id: GoogleCloudRecommenderV1OperationGroup type: object - GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: - type: object - id: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest - properties: - etag: - type: string - description: >- - Required. Fingerprint of the Recommendation. Provides optimistic - locking. - stateMetadata: - additionalProperties: - type: string - type: object - description: >- - State properties to include with this state. Overwrites any existing - `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`. - Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. - description: Request for the `MarkRecommendationSucceeded` Method. GoogleCloudRecommenderV1InsightRecommendationReference: - id: GoogleCloudRecommenderV1InsightRecommendationReference - properties: - recommendation: - type: string - description: >- - Recommendation resource name, e.g. - projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] - type: object description: Reference to an associated recommendation. - GoogleCloudRecommenderV1MarkInsightAcceptedRequest: - description: Request for the `MarkInsightAccepted` method. - id: GoogleCloudRecommenderV1MarkInsightAcceptedRequest - type: object - properties: - etag: - type: string - description: Required. Fingerprint of the Insight. Provides optimistic locking. - stateMetadata: - type: object - additionalProperties: - type: string - description: >- - Optional. State properties user wish to include with this state. - Full replace of the current state_metadata. - GoogleCloudRecommenderV1CostProjection: - id: GoogleCloudRecommenderV1CostProjection - type: object - properties: - costInLocalCurrency: - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - The approximate cost savings in the billing account's local - currency. - duration: - format: google-duration - description: Duration for which this cost applies. - type: string - cost: - description: >- - An approximate projection on amount saved or amount incurred. - Negative cost units indicate cost savings and positive cost units - indicate increase. See google.type.Money documentation for - positive/negative units. A user's permissions may affect whether the - cost is computed using list prices or custom contract prices. - $ref: '#/components/schemas/GoogleTypeMoney' - description: >- - Contains metadata about how much money a recommendation can save or - incur. - GoogleCloudRecommenderV1RecommendationStateInfo: - description: Information for state. Contains state and metadata. + id: GoogleCloudRecommenderV1InsightRecommendationReference type: object properties: - state: - enum: - - STATE_UNSPECIFIED - - ACTIVE - - CLAIMED - - SUCCEEDED - - FAILED - - DISMISSED - description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. - type: string - enumDescriptions: - - Default state. Don't use directly. - - >- - Recommendation is active and can be applied. Recommendations - content can be updated by Google. ACTIVE recommendations can be - marked as CLAIMED, SUCCEEDED, or FAILED. - - >- - Recommendation is in claimed state. Recommendations content is - immutable and cannot be updated by Google. CLAIMED recommendations - can be marked as CLAIMED, SUCCEEDED, or FAILED. - - >- - Recommendation is in succeeded state. Recommendations content is - immutable and cannot be updated by Google. SUCCEEDED - recommendations can be marked as SUCCEEDED, or FAILED. - - >- - Recommendation is in failed state. Recommendations content is - immutable and cannot be updated by Google. FAILED recommendations - can be marked as SUCCEEDED, or FAILED. - - >- - Recommendation is in dismissed state. Recommendation content can - be updated by Google. DISMISSED recommendations can be marked as - ACTIVE. - stateMetadata: + recommendation: description: >- - A map of metadata for the state, provided by user or automations - systems. - additionalProperties: - type: string - type: object - id: GoogleCloudRecommenderV1RecommendationStateInfo + Recommendation resource name, e.g. + projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] + type: string GoogleCloudRecommenderV1Recommendation: + type: object description: >- A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc - type: object id: GoogleCloudRecommenderV1Recommendation properties: + associatedInsights: + description: Insights that led to this recommendation. + items: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference + type: array + description: + description: >- + Free-form human readable summary in English. The maximum length is + 500 characters. + type: string + content: + description: >- + Content of the recommendation describing recommended changes to + resources. + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' additionalImpact: items: $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + type: array description: >- Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. - type: array - stateInfo: - description: Information for state. Contains state and metadata. - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' + name: + description: Identifier. Name of recommendation. + type: string + primaryImpact: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' + description: >- + The primary impact that this recommendation can have while trying to + optimize for one category. + etag: + description: >- + Fingerprint of the Recommendation. Provides optimistic locking when + updating states. + type: string + recommenderSubtype: + description: >- + Contains an identifier for a subtype of recommendations produced for + the same recommender. Subtype is a function of content and impact, + meaning a new subtype might be added when significant changes to + `content` or `primary_impact.category` are introduced. See the + Recommenders section to see a list of subtypes for a given + Recommender. Examples: For recommender = + "google.iam.policy.Recommender", recommender_subtype can be one of + "REMOVE_ROLE"/"REPLACE_ROLE" + type: string targetResources: - type: array + items: + type: string description: >- Fully qualified resource names that this recommendation is targeting. - items: - type: string - name: + type: array + xorGroupId: type: string - description: Identifier. Name of recommendation. + description: >- + Corresponds to a mutually exclusive group ID within a recommender. A + non-empty ID indicates that the recommendation belongs to a mutually + exclusive group. This means that only one recommendation within the + group is suggested to be applied. priority: - type: string + description: Recommendation's priority. enum: - PRIORITY_UNSPECIFIED - P4 - P3 - P2 - P1 - description: Recommendation's priority. enumDescriptions: - Recommendation has unspecified priority. - Recommendation has P4 priority (lowest priority). - Recommendation has P3 priority (second lowest priority). - Recommendation has P2 priority (second highest priority). - Recommendation has P1 priority (highest priority). - description: type: string - description: >- - Free-form human readable summary in English. The maximum length is - 500 characters. lastRefreshTime: description: >- Last time this recommendation was refreshed by the system that created it in the first place. format: google-datetime type: string - primaryImpact: + stateInfo: + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationStateInfo' + description: Information for state. Contains state and metadata. + GoogleCloudRecommenderV1RecommendationContent: + type: object + id: GoogleCloudRecommenderV1RecommendationContent + description: Contains what resources are changing and how they are changing. + properties: + operationGroups: + items: + $ref: '#/components/schemas/GoogleCloudRecommenderV1OperationGroup' + type: array description: >- - The primary impact that this recommendation can have while trying to - optimize for one category. - $ref: '#/components/schemas/GoogleCloudRecommenderV1Impact' - content: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommendationContent' + Operations to one or more Google Cloud resources grouped in such a + way that, all operations within one group are expected to be + performed atomically and in an order. + overview: + type: object + additionalProperties: + description: Properties of the object. + type: any + description: Condensed overview information about the recommendation. + GoogleCloudRecommenderV1RecommenderGenerationConfig: + description: >- + A Configuration to customize the generation of recommendations. Eg, + customizing the lookback period considered when generating a + recommendation. + properties: + params: + additionalProperties: + type: any + description: Properties of the object. description: >- - Content of the recommendation describing recommended changes to - resources. - recommenderSubtype: + Parameters for this RecommenderGenerationConfig. These configs can + be used by or are applied to all subtypes. + type: object + id: GoogleCloudRecommenderV1RecommenderGenerationConfig + type: object + GoogleCloudRecommenderV1SustainabilityProjection: + id: GoogleCloudRecommenderV1SustainabilityProjection + description: >- + Contains metadata about how much sustainability a recommendation can + save or incur. + properties: + duration: type: string + description: Duration for which this sustainability applies. + format: google-duration + kgCO2e: + format: double + type: number description: >- - Contains an identifier for a subtype of recommendations produced for - the same recommender. Subtype is a function of content and impact, - meaning a new subtype might be added when significant changes to - `content` or `primary_impact.category` are introduced. See the - Recommenders section to see a list of subtypes for a given - Recommender. Examples: For recommender = - "google.iam.policy.Recommender", recommender_subtype can be one of - "REMOVE_ROLE"/"REPLACE_ROLE" - etag: + Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e + so that the name renders correctly in camelCase (kgCO2e). + type: object + GoogleCloudRecommenderV1Operation: + id: GoogleCloudRecommenderV1Operation + description: >- + Contains an operation for a resource loosely based on the JSON-PATCH + format with support for: * Custom filters for describing partial array + patch. * Extended path values for describing nested arrays. * Custom + fields for describing the resource for which the operation is being + described. * Allows extension to custom operations not natively + supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for + details on the original RFC. + type: object + properties: + resource: type: string description: >- - Fingerprint of the Recommendation. Provides optimistic locking when - updating states. - xorGroupId: + Contains the fully qualified resource name. This field is always + populated. ex: //cloudresourcemanager.googleapis.com/projects/foo. + path: type: string description: >- - Corresponds to a mutually exclusive group ID within a recommender. A - non-empty ID indicates that the recommendation belongs to a mutually - exclusive group. This means that only one recommendation within the - group is suggested to be applied. - associatedInsights: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1RecommendationInsightReference - description: Insights that led to this recommendation. + Path to the target field being operated on. If the operation is at + the resource level, then path should be "/". This field is always + populated. + pathFilters: + type: object + description: >- + Set of filters to apply if `path` refers to array elements or nested + array elements in order to narrow down to a single unique element + that is being tested/modified. This is intended to be an exact match + per filter. To perform advanced matching, use path_value_matchers. * + Example: ``` { "/versions/*/name" : "it-123" + "/versions/*/targetSize/percent": 20 } ``` * Example: ``` { + "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } + ``` * Example: ``` { "/bindings/*/role": "roles/owner" + "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } ``` + When both path_filters and path_value_matchers are set, an implicit + AND must be performed. + additionalProperties: + type: any + action: + type: string + description: >- + Type of this operation. Contains one of 'add', 'remove', 'replace', + 'move', 'copy', 'test' and custom operations. This field is + case-insensitive and always populated. + sourceResource: + description: >- + Can be set with action 'copy' to copy resource configuration across + different resources of the same type. Example: A resource clone can + be done via action = 'copy', path = "/", from = "/", source_resource + = and resource_name = . This field is empty for all other values of + `action`. + type: string + value: + type: any + description: >- + Value for the `path` field. Will be set for actions:'add'/'replace'. + Maybe set for action: 'test'. Either this or `value_matcher` will be + set for 'test' operation. An exact match must be performed. + sourcePath: + description: >- + Can be set with action 'copy' or 'move' to indicate the source field + within resource or source_resource, ignored if provided for other + operation types. + type: string + valueMatcher: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' + description: >- + Can be set for action 'test' for advanced matching for the value of + 'path' field. Either this or `value` will be set for 'test' + operation. + resourceType: + type: string + description: >- + Type of GCP resource being modified/tested. This field is always + populated. Example: cloudresourcemanager.googleapis.com/Project, + compute.googleapis.com/Instance + pathValueMatchers: + description: >- + Similar to path_filters, this contains set of filters to apply if + `path` field refers to array elements. This is meant to support + value matching beyond exact match. To perform exact match, use + path_filters. When both path_filters and path_value_matchers are + set, an implicit AND must be performed. + type: object + additionalProperties: + $ref: '#/components/schemas/GoogleCloudRecommenderV1ValueMatcher' + GoogleCloudRecommenderV1RecommendationStateInfo: + id: GoogleCloudRecommenderV1RecommendationStateInfo + type: object + properties: + stateMetadata: + type: object + additionalProperties: + type: string + description: >- + A map of metadata for the state, provided by user or automations + systems. + state: + description: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. + type: string + enum: + - STATE_UNSPECIFIED + - ACTIVE + - CLAIMED + - SUCCEEDED + - FAILED + - DISMISSED + enumDescriptions: + - Default state. Don't use directly. + - >- + Recommendation is active and can be applied. Recommendations + content can be updated by Google. ACTIVE recommendations can be + marked as CLAIMED, SUCCEEDED, or FAILED. + - >- + Recommendation is in claimed state. Recommendations content is + immutable and cannot be updated by Google. CLAIMED recommendations + can be marked as CLAIMED, SUCCEEDED, or FAILED. + - >- + Recommendation is in succeeded state. Recommendations content is + immutable and cannot be updated by Google. SUCCEEDED + recommendations can be marked as SUCCEEDED, or FAILED. + - >- + Recommendation is in failed state. Recommendations content is + immutable and cannot be updated by Google. FAILED recommendations + can be marked as SUCCEEDED, or FAILED. + - >- + Recommendation is in dismissed state. Recommendation content can + be updated by Google. DISMISSED recommendations can be marked as + ACTIVE. + description: Information for state. Contains state and metadata. parameters: - oauth_token: - description: OAuth 2.0 token for the current user. + callback: + description: JSONP in: query - name: oauth_token + name: callback schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string fields: description: Selector specifying which fields to include in a partial response. in: query @@ -879,6 +861,27 @@ components: name: quotaUser schema: type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' key: description: >- API key. Your API key identifies your project and provides you with API @@ -888,6 +891,12 @@ components: name: key schema: type: string + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). + in: query + name: uploadType + schema: + type: string alt: description: Data format for response. in: query @@ -898,79 +907,41 @@ components: - json - media - proto - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' x-stackQL-resources: - insight_types_config: - id: google.recommender.insight_types_config - name: insight_types_config - title: Insight_types_config + insights: + id: google.recommender.insights + name: insights + title: Insights methods: - organizations_locations_insight_types_get_config: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get - response: - mediaType: application/json - openAPIDocKey: '200' - organizations_locations_insight_types_update_config: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch - response: - mediaType: application/json - openAPIDocKey: '200' - billing_accounts_locations_insight_types_update_config: + folders_locations_insight_types_insights_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_insight_types_get_config: + folders_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_get_config: + objectKey: $.insights + folders_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_update_config: + organizations_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_get_config - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_get_config - - $ref: >- - #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_get_config - insert: [] - update: [] - delete: [] - insights: - id: google.recommender.insights - name: insights - title: Insights - methods: organizations_locations_insight_types_insights_get: operation: $ref: >- @@ -978,42 +949,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_insight_types_insights_list: - operation: &ref_1 - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.insights organizations_locations_insight_types_insights_list: - operation: *ref_1 - response: *ref_2 - organizations_locations_insight_types_insights_mark_accepted: - operation: - $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post - response: - mediaType: application/json - openAPIDocKey: '200' - billing_accounts_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_insight_types_insights_list: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' objectKey: $.insights - billing_accounts_locations_insight_types_insights_list: - operation: *ref_3 - response: *ref_4 billing_accounts_locations_insight_types_insights_get: operation: $ref: >- @@ -1021,42 +964,28 @@ components: response: mediaType: application/json openAPIDocKey: '200' - folders_locations_insight_types_insights_mark_accepted: + billing_accounts_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_insight_types_insights_list: - operation: &ref_5 - $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' objectKey: $.insights - folders_locations_insight_types_insights_list: - operation: *ref_5 - response: *ref_6 - folders_locations_insight_types_insights_get: + billing_accounts_locations_insight_types_insights_mark_accepted: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_insight_types_insights_list: - operation: &ref_7 + projects_locations_insight_types_insights_mark_accepted: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get - response: &ref_8 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.insights - projects_locations_insight_types_insights_list: - operation: *ref_7 - response: *ref_8 projects_locations_insight_types_insights_get: operation: $ref: >- @@ -1064,321 +993,424 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_locations_insight_types_insights_mark_accepted: + projects_locations_insight_types_insights_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights~1{insightsId}:markAccepted/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1insights/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.insights sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_get - - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_get - $ref: >- #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_get + - $ref: >- + #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list - $ref: >- #/components/x-stackQL-resources/insights/methods/organizations_locations_insight_types_insights_list - $ref: >- #/components/x-stackQL-resources/insights/methods/billing_accounts_locations_insight_types_insights_list - - $ref: >- - #/components/x-stackQL-resources/insights/methods/folders_locations_insight_types_insights_list - $ref: >- #/components/x-stackQL-resources/insights/methods/projects_locations_insight_types_insights_list insert: [] update: [] + replace: [] delete: [] - recommenders_config: - id: google.recommender.recommenders_config - name: recommenders_config - title: Recommenders_config + recommendations: + id: google.recommender.recommendations + name: recommendations + title: Recommendations methods: - organizations_locations_recommenders_get_config: + folders_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_update_config: + folders_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_recommenders_recommendations_get: + operation: + $ref: >- + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_recommenders_recommendations_mark_claimed: + operation: + $ref: >- + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + response: + mediaType: application/json + openAPIDocKey: '200' + folders_locations_recommenders_recommendations_list: + operation: + $ref: >- + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.recommendations + folders_locations_recommenders_recommendations_mark_succeeded: + operation: + $ref: >- + #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_recommenders_recommendations_mark_succeeded: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + response: + mediaType: application/json + openAPIDocKey: '200' + organizations_locations_recommenders_recommendations_mark_claimed: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_get_config: + organizations_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_update_config: + organizations_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_update_config: + organizations_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_get_config: + objectKey: $.recommendations + organizations_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config - - $ref: >- - #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config - insert: [] - update: [] - delete: [] - recommendations: - id: google.recommender.recommendations - name: recommendations - title: Recommendations - methods: - organizations_locations_recommenders_recommendations_mark_dismissed: + billing_accounts_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_recommenders_recommendations_list: - operation: &ref_9 + billing_accounts_locations_recommenders_recommendations_mark_dismissed: + operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get - response: &ref_10 + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - organizations_locations_recommenders_recommendations_list: - operation: *ref_9 - response: *ref_10 - organizations_locations_recommenders_recommendations_mark_succeeded: + billing_accounts_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_recommendations_list: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_mark_failed: + objectKey: $.recommendations + billing_accounts_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - organizations_locations_recommenders_recommendations_get: + billing_accounts_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_dismissed: + projects_locations_recommenders_recommendations_mark_succeeded: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_claimed: + projects_locations_recommenders_recommendations_mark_failed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_failed: + projects_locations_recommenders_recommendations_get: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_mark_succeeded: + projects_locations_recommenders_recommendations_mark_dismissed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post response: mediaType: application/json openAPIDocKey: '200' - billing_accounts_locations_recommenders_recommendations_get: + projects_locations_recommenders_recommendations_mark_claimed: operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post response: mediaType: application/json openAPIDocKey: '200' - _billing_accounts_locations_recommenders_recommendations_list: - operation: &ref_11 + projects_locations_recommenders_recommendations_list: + operation: $ref: >- - #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get - response: &ref_12 + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.recommendations - billing_accounts_locations_recommenders_recommendations_list: - operation: *ref_11 - response: *ref_12 - folders_locations_recommenders_recommendations_mark_claimed: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_list + - $ref: >- + #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list + insert: [] + update: [] + replace: [] + delete: [] + insight_types_config: + id: google.recommender.insight_types_config + name: insight_types_config + title: Insight_types_config + methods: + organizations_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_recommenders_recommendations_list: - operation: &ref_13 + organizations_locations_insight_types_update_config: + operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get - response: &ref_14 + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - folders_locations_recommenders_recommendations_list: - operation: *ref_13 - response: *ref_14 - folders_locations_recommenders_recommendations_mark_dismissed: + billing_accounts_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_get: + billing_accounts_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_succeeded: + projects_locations_insight_types_get_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - folders_locations_recommenders_recommendations_mark_failed: + projects_locations_insight_types_update_config: operation: $ref: >- - #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1insightTypes~1{insightTypesId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_dismissed: + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_get_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_get_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_get_config + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/organizations_locations_insight_types_update_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/billing_accounts_locations_insight_types_update_config + - $ref: >- + #/components/x-stackQL-resources/insight_types_config/methods/projects_locations_insight_types_update_config + replace: [] + delete: [] + recommenders_config: + id: google.recommender.recommenders_config + name: recommenders_config + title: Recommenders_config + methods: + organizations_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markDismissed/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_succeeded: + organizations_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markSucceeded/post + #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_mark_claimed: + billing_accounts_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markClaimed/post + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_recommenders_recommendations_list: - operation: &ref_15 + billing_accounts_locations_recommenders_get_config: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations/get - response: &ref_16 + #/paths/~1v1~1billingAccounts~1{billingAccountsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.recommendations - projects_locations_recommenders_recommendations_list: - operation: *ref_15 - response: *ref_16 - projects_locations_recommenders_recommendations_mark_failed: + projects_locations_recommenders_get_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}:markFailed/post + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/get response: mediaType: application/json openAPIDocKey: '200' - projects_locations_recommenders_recommendations_get: + projects_locations_recommenders_update_config: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1recommendations~1{recommendationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1recommenders~1{recommendersId}~1config/patch response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: select: - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_get - - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_get + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_get_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_get + #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_get_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/organizations_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_get_config + insert: [] + update: - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/billing_accounts_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommenders_config/methods/organizations_locations_recommenders_update_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/folders_locations_recommenders_recommendations_list + #/components/x-stackQL-resources/recommenders_config/methods/billing_accounts_locations_recommenders_update_config - $ref: >- - #/components/x-stackQL-resources/recommendations/methods/projects_locations_recommenders_recommendations_list - insert: [] - update: [] + #/components/x-stackQL-resources/recommenders_config/methods/projects_locations_recommenders_update_config + replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: - parameters: &ref_17 - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + parameters: &ref_1 - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/_.xgafv' get: description: >- - Gets the requested InsightTypeConfig. There is only one instance of the - config for each InsightType. - operationId: recommender.organizations.locations.insightTypes.getConfig + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.folders.locations.insightTypes.insights.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + parameters: + - in: path + name: foldersId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: insightTypesId + required: true + schema: + type: string + - in: path + name: insightsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + parameters: *ref_1 + get: + description: >- + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.folders.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1390,10 +1422,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1407,16 +1440,35 @@ paths: required: true schema: type: string - patch: + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + parameters: *ref_1 + post: description: >- - Updates an InsightTypeConfig change. This will create a new revision of - the config. - operationId: recommender.organizations.locations.insightTypes.updateConfig + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.folders.locations.insightTypes.insights.markAccepted requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1428,10 +1480,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1445,22 +1497,27 @@ paths: required: true schema: type: string - - in: query - name: validateOnly - schema: - type: boolean - - in: query - name: updateMask + - in: path + name: insightsId + required: true schema: type: string - format: google-fieldmask - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: - parameters: *ref_17 - get: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + parameters: *ref_1 + post: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.get + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markDismissed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1472,10 +1529,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1485,22 +1542,34 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: - parameters: *ref_17 - get: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + parameters: *ref_1 + post: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.organizations.locations.insightTypes.insights.list + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markFailed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1512,11 +1581,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1526,39 +1594,22 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: recommendationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_17 - post: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_1 + get: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.organizations.locations.insightTypes.insights.markAccepted - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1570,10 +1621,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1583,22 +1634,33 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: - parameters: *ref_17 - get: + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + parameters: *ref_1 + post: description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.organizations.locations.recommenders.getConfig + Marks the Recommendation State as Claimed. Users can use this method to + indicate to the Recommender API that they are starting to apply the + recommendation themselves. This stops the recommendation content from + being updated. Associated insights are frozen and placed in the ACCEPTED + state. MarkRecommendationClaimed can be applied to recommendations in + CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the + recommender.*.update IAM permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markClaimed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1610,10 +1672,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1627,16 +1689,18 @@ paths: required: true schema: type: string - patch: + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + parameters: *ref_1 + get: description: >- - Updates a Recommender Config. This will create a new revision of the - config. - operationId: recommender.organizations.locations.recommenders.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1648,10 +1712,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1666,31 +1731,37 @@ paths: schema: type: string - in: query - name: updateMask + name: filter schema: type: string - format: google-fieldmask - in: query - name: validateOnly + name: pageToken schema: - type: boolean - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: - parameters: *ref_17 + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + parameters: *ref_1 post: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markDismissed + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: recommender.folders.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1705,7 +1776,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: organizationsId + name: foldersId required: true schema: type: string @@ -1724,13 +1795,13 @@ paths: required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: - parameters: *ref_17 + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: + parameters: *ref_1 get: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.organizations.locations.recommenders.recommendations.list + Gets the requested InsightTypeConfig. There is only one instance of the + config for each InsightType. + operationId: recommender.organizations.locations.insightTypes.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1742,8 +1813,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: organizationsId @@ -1756,43 +1826,20 @@ paths: schema: type: string - in: path - name: recommendersId - required: true - schema: - type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + name: insightTypesId + required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: - parameters: *ref_17 - post: + patch: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markSucceeded + Updates an InsightTypeConfig change. This will create a new revision of + the config. + operationId: recommender.organizations.locations.insightTypes.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1804,7 +1851,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1InsightTypeConfig' parameters: - in: path name: organizationsId @@ -1817,34 +1864,35 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: updateMask schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: - parameters: *ref_17 + format: google-fieldmask + - in: query + name: validateOnly + schema: + type: boolean + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + parameters: *ref_1 post: description: >- - Marks the Recommendation State as Claimed. Users can use this method to - indicate to the Recommender API that they are starting to apply the - recommendation themselves. This stops the recommendation content from - being updated. Associated insights are frozen and placed in the ACCEPTED - state. MarkRecommendationClaimed can be applied to recommendations in - CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the - recommender.*.update IAM permission for the specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markClaimed + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.organizations.locations.insightTypes.insights.markAccepted requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationClaimedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1856,7 +1904,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: organizationsId @@ -1869,35 +1917,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: - parameters: *ref_17 - post: + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + parameters: *ref_1 + get: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.organizations.locations.recommenders.recommendations.markFailed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.organizations.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1909,7 +1944,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: organizationsId @@ -1922,22 +1957,22 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - in: path - name: recommendationsId + name: insightsId required: true schema: type: string - /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: - parameters: *ref_17 + /v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + parameters: *ref_1 get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.organizations.locations.recommenders.recommendations.get + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.organizations.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1949,7 +1984,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path name: organizationsId @@ -1962,32 +1998,43 @@ paths: schema: type: string - in: path - name: recommendersId + name: insightTypesId required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: - parameters: *ref_17 + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + parameters: *ref_1 post: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markDismissed + recommender.organizations.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2002,7 +2049,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2021,8 +2068,8 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: - parameters: *ref_17 + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + parameters: *ref_1 post: description: >- Marks the Recommendation State as Claimed. Users can use this method to @@ -2033,7 +2080,7 @@ paths: CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markClaimed + recommender.organizations.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: @@ -2054,7 +2101,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2073,26 +2120,23 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: - parameters: *ref_17 + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + parameters: *ref_1 post: description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markFailed + recommender.organizations.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2107,7 +2151,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2126,26 +2170,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: - parameters: *ref_17 - post: + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_1 + get: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: >- - recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.organizations.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2160,7 +2191,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2179,13 +2210,13 @@ paths: required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: - parameters: *ref_17 + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + parameters: *ref_1 get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.billingAccounts.locations.recommenders.recommendations.get + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.organizations.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2197,10 +2228,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2214,18 +2246,39 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: - parameters: *ref_17 - get: + - in: query + name: filter + schema: + type: string + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + parameters: *ref_1 + post: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.billingAccounts.locations.recommenders.recommendations.list + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.organizations.locations.recommenders.recommendations.markFailed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2237,11 +2290,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2255,26 +2307,18 @@ paths: required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter + - in: path + name: recommendationsId + required: true schema: type: string - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: - parameters: *ref_17 + /v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + parameters: *ref_1 get: description: >- Gets the requested Recommender Config. There is only one instance of the config for each Recommender. - operationId: recommender.billingAccounts.locations.recommenders.getConfig + operationId: recommender.organizations.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2289,7 +2333,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2307,7 +2351,7 @@ paths: description: >- Updates a Recommender Config. This will create a new revision of the config. - operationId: recommender.billingAccounts.locations.recommenders.updateConfig + operationId: recommender.organizations.locations.recommenders.updateConfig requestBody: content: application/json: @@ -2327,7 +2371,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: billingAccountsId + name: organizationsId required: true schema: type: string @@ -2350,22 +2394,13 @@ paths: schema: type: string format: google-fieldmask - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_17 - post: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: + parameters: *ref_1 + get: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + Gets the requested insight. Requires the recommender.*.get IAM + permission for the specified insight type. + operationId: recommender.billingAccounts.locations.insightTypes.insights.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2400,7 +2435,7 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists insights for the specified Cloud Resource. Requires the @@ -2448,13 +2483,22 @@ paths: schema: type: integer format: int32 - /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: - parameters: *ref_17 - get: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + parameters: *ref_1 + post: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.billingAccounts.locations.insightTypes.insights.get + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.billingAccounts.locations.insightTypes.insights.markAccepted + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2489,7 +2533,7 @@ paths: schema: type: string /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: - parameters: *ref_17 + parameters: *ref_1 patch: description: >- Updates an InsightTypeConfig change. This will create a new revision of @@ -2570,22 +2614,63 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_17 + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_1 + get: + description: >- + Gets the requested recommendation. Requires the recommender.*.get IAM + permission for the specified recommender. + operationId: recommender.billingAccounts.locations.recommenders.recommendations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + parameters: + - in: path + name: billingAccountsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: recommendersId + required: true + schema: + type: string + - in: path + name: recommendationsId + required: true + schema: + type: string + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + parameters: *ref_1 post: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.folders.locations.insightTypes.insights.markAccepted + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2597,10 +2682,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: billingAccountsId required: true schema: type: string @@ -2610,22 +2695,35 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - in: path - name: insightsId + name: recommendationsId required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: - parameters: *ref_17 - get: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + parameters: *ref_1 + post: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.list + Marks the Recommendation State as Failed. Users can use this method to + indicate to the Recommender API that they have applied the + recommendation themselves, and the operation failed. This stops the + recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be + applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markFailed + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2637,11 +2735,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: billingAccountsId required: true schema: type: string @@ -2651,30 +2748,22 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: recommendationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1/folders/{foldersId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: - parameters: *ref_17 + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: + parameters: *ref_1 get: description: >- - Gets the requested insight. Requires the recommender.*.get IAM - permission for the specified insight type. - operationId: recommender.folders.locations.insightTypes.insights.get + Lists recommendations for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified recommender. + operationId: recommender.billingAccounts.locations.recommenders.recommendations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2686,10 +2775,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse parameters: - in: path - name: foldersId + name: billingAccountsId required: true schema: type: string @@ -2699,17 +2789,25 @@ paths: schema: type: string - in: path - name: insightTypesId + name: recommendersId required: true schema: type: string - - in: path - name: insightsId - required: true + - in: query + name: filter schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: - parameters: *ref_17 + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: + parameters: *ref_1 post: description: >- Marks the Recommendation State as Claimed. Users can use this method to @@ -2719,7 +2817,8 @@ paths: state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markClaimed + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markClaimed requestBody: content: application/json: @@ -2740,7 +2839,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: billingAccountsId required: true schema: type: string @@ -2759,13 +2858,26 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: - parameters: *ref_17 - get: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + parameters: *ref_1 + post: description: >- - Lists recommendations for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.list + Marks the Recommendation State as Succeeded. Users can use this method + to indicate to the Recommender API that they have applied the + recommendation themselves, and the operation was successful. This stops + the recommendation content from being updated. Associated insights are + frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can + be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED + state. Requires the recommender.*.update IAM permission for the + specified recommender. + operationId: >- + recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2777,11 +2889,10 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListRecommendationsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: billingAccountsId required: true schema: type: string @@ -2795,35 +2906,23 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: recommendationsId + required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: - parameters: *ref_17 - post: + /v1/billingAccounts/{billingAccountsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + parameters: *ref_1 + patch: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM - permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markDismissed + Updates a Recommender Config. This will create a new revision of the + config. + operationId: recommender.billingAccounts.locations.recommenders.updateConfig requestBody: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2835,10 +2934,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: billingAccountsId required: true schema: type: string @@ -2852,18 +2951,20 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true + - in: query + name: validateOnly + schema: + type: boolean + - in: query + name: updateMask schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: - parameters: *ref_17 + format: google-fieldmask get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.get + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.billingAccounts.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2875,10 +2976,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path - name: foldersId + name: billingAccountsId required: true schema: type: string @@ -2892,13 +2993,8 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true - schema: - type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: + parameters: *ref_1 post: description: >- Marks the Recommendation State as Succeeded. Users can use this method @@ -2909,7 +3005,8 @@ paths: be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markSucceeded + operationId: >- + recommender.projects.locations.recommenders.recommendations.markSucceeded requestBody: content: application/json: @@ -2930,7 +3027,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -2949,8 +3046,8 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: + parameters: *ref_1 post: description: >- Marks the Recommendation State as Failed. Users can use this method to @@ -2961,7 +3058,7 @@ paths: applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. - operationId: recommender.folders.locations.recommenders.recommendations.markFailed + operationId: recommender.projects.locations.recommenders.recommendations.markFailed requestBody: content: application/json: @@ -2982,7 +3079,7 @@ paths: $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' parameters: - in: path - name: foldersId + name: projectsId required: true schema: type: string @@ -3001,23 +3098,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: - parameters: *ref_17 - post: + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: + parameters: *ref_1 + get: description: >- - Mark the Recommendation State as Dismissed. Users can use this method to - indicate to the Recommender API that an ACTIVE recommendation has to be - marked back as DISMISSED. MarkRecommendationDismissed can be applied to - recommendations in ACTIVE state. Requires the recommender.*.update IAM + Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. - operationId: >- - recommender.projects.locations.recommenders.recommendations.markDismissed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest + operationId: recommender.projects.locations.recommenders.recommendations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3051,26 +3138,23 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markSucceeded: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markDismissed: + parameters: *ref_1 post: description: >- - Marks the Recommendation State as Succeeded. Users can use this method - to indicate to the Recommender API that they have applied the - recommendation themselves, and the operation was successful. This stops - the recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can - be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. + Mark the Recommendation State as Dismissed. Users can use this method to + indicate to the Recommender API that an ACTIVE recommendation has to be + marked back as DISMISSED. MarkRecommendationDismissed can be applied to + recommendations in ACTIVE state. Requires the recommender.*.update IAM + permission for the specified recommender. operationId: >- - recommender.projects.locations.recommenders.recommendations.markSucceeded + recommender.projects.locations.recommenders.recommendations.markDismissed requestBody: content: application/json: schema: $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationSucceededRequest + #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationDismissedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3105,7 +3189,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markClaimed: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Marks the Recommendation State as Claimed. Users can use this method to @@ -3156,7 +3240,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists recommendations for the specified Cloud Resource. Requires the @@ -3204,65 +3288,13 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}:markFailed: - parameters: *ref_17 - post: - description: >- - Marks the Recommendation State as Failed. Users can use this method to - indicate to the Recommender API that they have applied the - recommendation themselves, and the operation failed. This stops the - recommendation content from being updated. Associated insights are - frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be - applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED - state. Requires the recommender.*.update IAM permission for the - specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.markFailed - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkRecommendationFailedRequest - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: recommendersId - required: true - schema: - type: string - - in: path - name: recommendationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/recommendations/{recommendationsId}: - parameters: *ref_17 + /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: + parameters: *ref_1 get: description: >- - Gets the requested recommendation. Requires the recommender.*.get IAM - permission for the specified recommender. - operationId: recommender.projects.locations.recommenders.recommendations.get + Gets the requested Recommender Config. There is only one instance of the + config for each Recommender. + operationId: recommender.projects.locations.recommenders.getConfig security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3274,7 +3306,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Recommendation' + $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' parameters: - in: path name: projectsId @@ -3291,13 +3323,6 @@ paths: required: true schema: type: string - - in: path - name: recommendationsId - required: true - schema: - type: string - /v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config: - parameters: *ref_17 patch: description: >- Updates a Recommender Config. This will create a new revision of the @@ -3345,41 +3370,8 @@ paths: schema: type: string format: google-fieldmask - get: - description: >- - Gets the requested Recommender Config. There is only one instance of the - config for each Recommender. - operationId: recommender.projects.locations.recommenders.getConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1RecommenderConfig' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: locationsId - required: true - schema: - type: string - - in: path - name: recommendersId - required: true - schema: - type: string /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the requested InsightTypeConfig. There is only one instance of the @@ -3451,22 +3443,31 @@ paths: required: true schema: type: string + - in: query + name: validateOnly + schema: + type: boolean - in: query name: updateMask schema: type: string format: google-fieldmask - - in: query - name: validateOnly - schema: - type: boolean - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: - parameters: *ref_17 - get: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: + parameters: *ref_1 + post: description: >- - Lists insights for the specified Cloud Resource. Requires the - recommender.*.list IAM permission for the specified insight type. - operationId: recommender.projects.locations.insightTypes.insights.list + Marks the Insight State as Accepted. Users can use this method to + indicate to the Recommender API that they have applied some action based + on the insight. This stops the insight content from being updated. + MarkInsightAccepted can be applied to insights in ACTIVE state. Requires + the recommender.*.update IAM permission for the specified insight. + operationId: recommender.projects.locations.insightTypes.insights.markAccepted + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3478,8 +3479,7 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse + $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' parameters: - in: path name: projectsId @@ -3496,21 +3496,13 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: insightsId + required: true schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the requested insight. Requires the recommender.*.get IAM @@ -3549,22 +3541,13 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights/{insightsId}:markAccepted: - parameters: *ref_17 - post: + /v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/insights: + parameters: *ref_1 + get: description: >- - Marks the Insight State as Accepted. Users can use this method to - indicate to the Recommender API that they have applied some action based - on the insight. This stops the insight content from being updated. - MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - the recommender.*.update IAM permission for the specified insight. - operationId: recommender.projects.locations.insightTypes.insights.markAccepted - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/GoogleCloudRecommenderV1MarkInsightAcceptedRequest + Lists insights for the specified Cloud Resource. Requires the + recommender.*.list IAM permission for the specified insight type. + operationId: recommender.projects.locations.insightTypes.insights.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3576,7 +3559,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudRecommenderV1Insight' + $ref: >- + #/components/schemas/GoogleCloudRecommenderV1ListInsightsResponse parameters: - in: path name: projectsId @@ -3593,8 +3577,16 @@ paths: required: true schema: type: string - - in: path - name: insightsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/redis.yaml b/providers/src/googleapis.com/v00.00.00000/services/redis.yaml index 097ace6e..5885e52c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/redis.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/redis.yaml @@ -7,8 +7,8 @@ info: title: Google Cloud Memorystore for Redis API description: Creates and manages Redis instances on the Google Cloud Platform. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240904' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/memorystore/docs/redis/ servers: @@ -231,8 +231,8 @@ components: properties: name: description: >- - Required. Unique name of the resource in this scope including - project and location using the form: + Required. Identifier. Unique name of the resource in this scope + including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` type: string createTime: @@ -302,7 +302,7 @@ components: type: integer format: int32 shardCount: - description: Required. Number of shards for the Redis cluster. + description: Optional. Number of shards for the Redis cluster. type: integer format: int32 pscConfigs: @@ -371,11 +371,30 @@ components: readOnly: true type: number format: double + zoneDistributionConfig: + description: >- + Optional. This config will be used to determine how the customer + wants us to distribute cluster resources within the region. + $ref: '#/components/schemas/ZoneDistributionConfig' + crossClusterReplicationConfig: + description: Optional. Cross cluster replication config. + $ref: '#/components/schemas/CrossClusterReplicationConfig' deletionProtectionEnabled: description: >- Optional. The delete operation will fail when the value is set to true. type: boolean + maintenancePolicy: + description: >- + Optional. ClusterMaintenancePolicy determines when to allow or deny + updates. + $ref: '#/components/schemas/ClusterMaintenancePolicy' + maintenanceSchedule: + description: >- + Output only. ClusterMaintenanceSchedule Output only Published + maintenance schedule. + readOnly: true + $ref: '#/components/schemas/ClusterMaintenanceSchedule' PscConfig: id: PscConfig type: object @@ -538,13 +557,256 @@ components: fsync every second. Fast enough, and you may lose 1 second of data if there is a disaster - >- - fsync every time new commands are appended to the AOF. It has the - best data loss protection at the cost of performance + fsync every time new write commands are appended to the AOF. It + has the best data loss protection at the cost of performance enum: - APPEND_FSYNC_UNSPECIFIED - 'NO' - EVERYSEC - ALWAYS + ZoneDistributionConfig: + id: ZoneDistributionConfig + description: Zone distribution config for allocation of cluster resources. + type: object + properties: + mode: + description: >- + Optional. The mode of zone distribution. Defaults to MULTI_ZONE, + when not specified. + type: string + enumDescriptions: + - 'Not Set. Default: MULTI_ZONE' + - >- + Distribute all resources across 3 zones picked at random, within + the region. + - >- + Distribute all resources in a single zone. The zone field must be + specified, when this mode is selected. + enum: + - ZONE_DISTRIBUTION_MODE_UNSPECIFIED + - MULTI_ZONE + - SINGLE_ZONE + zone: + description: >- + Optional. When SINGLE ZONE distribution is selected, zone field + would be used to allocate all resources in that zone. This is not + applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE + clusters. + type: string + CrossClusterReplicationConfig: + id: CrossClusterReplicationConfig + description: Cross cluster replication config. + type: object + properties: + clusterRole: + description: The role of the cluster in cross cluster replication. + type: string + enumDescriptions: + - Cluster role is not set. The behavior is equivalent to NONE. + - >- + This cluster does not participate in cross cluster replication. It + is an independent cluster and does not replicate to or from any + other clusters. + - >- + A cluster that allows both reads and writes. Any data written to + this cluster is also replicated to the attached secondary + clusters. + - >- + A cluster that allows only reads and replicates data from a + primary cluster. + enum: + - CLUSTER_ROLE_UNSPECIFIED + - NONE + - PRIMARY + - SECONDARY + primaryCluster: + description: >- + Details of the primary cluster that is used as the replication + source for this secondary cluster. This field is only set for a + secondary cluster. + $ref: '#/components/schemas/RemoteCluster' + secondaryClusters: + description: >- + List of secondary clusters that are replicating from this primary + cluster. This field is only set for a primary cluster. + type: array + items: + $ref: '#/components/schemas/RemoteCluster' + updateTime: + description: >- + Output only. The last time cross cluster replication config was + updated. + readOnly: true + type: string + format: google-datetime + membership: + description: >- + Output only. An output only view of all the member clusters + participating in the cross cluster replication. This view will be + provided by every member cluster irrespective of its cluster + role(primary or secondary). A primary cluster can provide + information about all the secondary clusters replicating from it. + However, a secondary cluster only knows about the primary cluster + from which it is replicating. However, for scenarios, where the + primary cluster is unavailable(e.g. regional outage), a GetCluster + request can be sent to any other member cluster and this field will + list all the member clusters participating in cross cluster + replication. + readOnly: true + $ref: '#/components/schemas/Membership' + RemoteCluster: + id: RemoteCluster + description: >- + Details of the remote cluster associated with this cluster in a cross + cluster replication setup. + type: object + properties: + cluster: + description: >- + The full resource path of the remote cluster in the format: + projects//locations//clusters/ + type: string + uid: + description: Output only. The unique identifier of the remote cluster. + readOnly: true + type: string + Membership: + id: Membership + description: >- + An output only view of all the member clusters participating in the + cross cluster replication. + type: object + properties: + primaryCluster: + description: >- + Output only. The primary cluster that acts as the source of + replication for the secondary clusters. + readOnly: true + $ref: '#/components/schemas/RemoteCluster' + secondaryClusters: + description: >- + Output only. The list of secondary clusters replicating from the + primary cluster. + readOnly: true + type: array + items: + $ref: '#/components/schemas/RemoteCluster' + ClusterMaintenancePolicy: + id: ClusterMaintenancePolicy + description: Maintenance policy per cluster. + type: object + properties: + createTime: + description: >- + Output only. The time when the policy was created i.e. Maintenance + Window or Deny Period was assigned. + readOnly: true + type: string + format: google-datetime + updateTime: + description: >- + Output only. The time when the policy was updated i.e. Maintenance + Window or Deny Period was updated. + readOnly: true + type: string + format: google-datetime + weeklyMaintenanceWindow: + description: >- + Optional. Maintenance window that is applied to resources covered by + this policy. Minimum 1. For the current version, the maximum number + of weekly_maintenance_window is expected to be one. + type: array + items: + $ref: '#/components/schemas/ClusterWeeklyMaintenanceWindow' + ClusterWeeklyMaintenanceWindow: + id: ClusterWeeklyMaintenanceWindow + description: Time window specified for weekly operations. + type: object + properties: + day: + description: Allows to define schedule that runs specified day of the week. + type: string + enumDescriptions: + - The day of the week is unspecified. + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + enum: + - DAY_OF_WEEK_UNSPECIFIED + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + startTime: + description: Start time of the window in UTC. + $ref: '#/components/schemas/TimeOfDay' + duration: + description: Duration of the time window. + type: string + format: google-duration + TimeOfDay: + id: TimeOfDay + description: >- + Represents a time of day. The date and time zone are either not + significant or are specified elsewhere. An API may choose to allow leap + seconds. Related types are google.type.Date and + `google.protobuf.Timestamp`. + type: object + properties: + hours: + description: >- + Hours of day in 24 hour format. Should be from 0 to 23. An API may + choose to allow the value "24:00:00" for scenarios like business + closing time. + type: integer + format: int32 + minutes: + description: Minutes of hour of day. Must be from 0 to 59. + type: integer + format: int32 + seconds: + description: >- + Seconds of minutes of the time. Must normally be from 0 to 59. An + API may allow the value 60 if it allows leap-seconds. + type: integer + format: int32 + nanos: + description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + type: integer + format: int32 + ClusterMaintenanceSchedule: + id: ClusterMaintenanceSchedule + description: Upcoming maitenance schedule. + type: object + properties: + startTime: + description: >- + Output only. The start time of any upcoming scheduled maintenance + for this instance. + readOnly: true + type: string + format: google-datetime + endTime: + description: >- + Output only. The end time of any upcoming scheduled maintenance for + this instance. + readOnly: true + type: string + format: google-datetime + scheduleDeadlineTime: + description: >- + Output only. The deadline that the maintenance schedule start time + can not go beyond, including reschedule. + readOnly: true + type: string + format: google-datetime CertificateAuthority: id: CertificateAuthority description: Redis cluster certificate authority @@ -578,6 +840,33 @@ components: type: array items: type: string + RescheduleClusterMaintenanceRequest: + id: RescheduleClusterMaintenanceRequest + description: Request for rescheduling a cluster maintenance. + type: object + properties: + rescheduleType: + description: >- + Required. If reschedule type is SPECIFIC_TIME, must set up + schedule_time as well. + type: string + enumDescriptions: + - Not set. + - If the user wants to schedule the maintenance to happen now. + - >- + If the user wants to reschedule the maintenance to a specific + time. + enum: + - RESCHEDULE_TYPE_UNSPECIFIED + - IMMEDIATE + - SPECIFIC_TIME + scheduleTime: + description: >- + Optional. Timestamp when the maintenance shall be rescheduled to if + reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example + `2012-11-15T16:19:00.094Z`. + type: string + format: google-datetime ListInstancesResponse: id: ListInstancesResponse description: Response for ListInstances. @@ -1015,36 +1304,6 @@ components: readOnly: true type: string format: google-duration - TimeOfDay: - id: TimeOfDay - description: >- - Represents a time of day. The date and time zone are either not - significant or are specified elsewhere. An API may choose to allow leap - seconds. Related types are google.type.Date and - `google.protobuf.Timestamp`. - type: object - properties: - hours: - description: >- - Hours of day in 24 hour format. Should be from 0 to 23. An API may - choose to allow the value "24:00:00" for scenarios like business - closing time. - type: integer - format: int32 - minutes: - description: Minutes of hour of day. Must be from 0 to 59. - type: integer - format: int32 - seconds: - description: >- - Seconds of minutes of the time. Must normally be from 0 to 59. An - API may allow the value 60 if it allows leap-seconds. - type: integer - format: int32 - nanos: - description: Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - type: integer - format: int32 MaintenanceSchedule: id: MaintenanceSchedule description: >- @@ -1341,7 +1600,6 @@ components: recommendationSignalData: $ref: '#/components/schemas/DatabaseResourceRecommendationSignalData' observabilityMetricData: - description: More feed data would be added in subsequent CLs $ref: '#/components/schemas/ObservabilityMetricData' DatabaseResourceId: id: DatabaseResourceId @@ -1389,12 +1647,15 @@ components: Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, - spanner.googleapis.com/Instance REQUIRED Please refer + spanner.googleapis.com/Instance, spanner.googleapis.com/Database, + firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, + bigtableadmin.googleapis.com/Cluster, + bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel type: string DatabaseResourceMetadata: id: DatabaseResourceMetadata - description: Common model for database resource instance metadata. + description: 'Common model for database resource instance metadata. Next ID: 21' type: object properties: id: @@ -1537,6 +1798,9 @@ components: machineConfiguration: description: Machine configuration for this resource. $ref: '#/components/schemas/MachineConfiguration' + tagsSet: + description: Optional. Tags associated with this resources. + $ref: '#/components/schemas/Tags' Product: id: Product description: Product specification for Condor resources. @@ -1561,6 +1825,7 @@ components: - >- Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum. + - Firestore product area in GCP. enumDeprecated: - false - false @@ -1573,6 +1838,7 @@ components: - false - false - false + - false enum: - PRODUCT_TYPE_UNSPECIFIED - PRODUCT_TYPE_CLOUD_SQL @@ -1585,6 +1851,7 @@ components: - PRODUCT_TYPE_MEMORYSTORE - PRODUCT_TYPE_BIGTABLE - PRODUCT_TYPE_OTHER + - PRODUCT_TYPE_FIRESTORE engine: description: The specific engine that the underlying database is running. type: string @@ -1605,6 +1872,8 @@ components: - >- Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum. + - Firestore with native mode. + - Firestore with datastore mode. enumDeprecated: - false - false @@ -1620,6 +1889,8 @@ components: - false - false - false + - false + - false enum: - ENGINE_UNSPECIFIED - ENGINE_MYSQL @@ -1635,6 +1906,8 @@ components: - ENGINE_MEMORYSTORE_FOR_REDIS - ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER - ENGINE_OTHER + - ENGINE_FIRESTORE_WITH_NATIVE_MODE + - ENGINE_FIRESTORE_WITH_DATASTORE_MODE version: description: >- Version of the underlying database engine. Example values: For @@ -1674,6 +1947,12 @@ components: Checks for resources that are configured to have redundancy, and ongoing replication across regions type: boolean + automaticFailoverRoutingConfigured: + description: >- + Checks for existence of (multi-cluster) routing configuration that + allows automatic failover to a different zone/region in case of an + outage. Applicable to Bigtable resources. + type: boolean BackupConfiguration: id: BackupConfiguration description: Configuration for automatic backups @@ -1783,29 +2062,36 @@ components: CustomMetadataData: id: CustomMetadataData description: >- - Any custom metadata associated with the resource. i.e. A spanner + Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data type: object properties: - databaseMetadata: + internalResourceMetadata: + description: >- + Metadata for individual internal resources in an instance. e.g. + spanner instance can have multiple databases with unique + configuration. type: array items: - $ref: '#/components/schemas/DatabaseMetadata' - DatabaseMetadata: - id: DatabaseMetadata + $ref: '#/components/schemas/InternalResourceMetadata' + InternalResourceMetadata: + id: InternalResourceMetadata description: >- - Metadata for individual databases created in an instance. i.e. spanner + Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. + Similarly bigtable can have multiple clusters within same bigtable + instance. type: object properties: resourceId: $ref: '#/components/schemas/DatabaseResourceId' resourceName: description: >- - Required. Database name. Resource name to follow CAIS resource_name - format as noted here go/condor-common-datamodel + Required. internal resource name for spanner this will be database + name + e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1" type: string product: $ref: '#/components/schemas/Product' @@ -1878,6 +2164,19 @@ components: validations again after bug fix. type: string format: int64 + Tags: + id: Tags + description: >- + Message type for storing tags. Tags provide a way to create annotations + for resources, and in some cases conditionally allow or deny policies + based on whether a resource has a specific tag. + type: object + properties: + tags: + description: The Tag key/value mappings. + type: object + additionalProperties: + type: string DatabaseResourceHealthSignalData: id: DatabaseResourceHealthSignalData description: Common model for database resource health signal data. @@ -1987,6 +2286,33 @@ components: - MISCONFIGURATION - OBSERVATION - ERROR + signalSeverity: + description: The severity of the signal, such as if it's a HIGH or LOW severity. + type: string + enumDescriptions: + - >- + This value is used for findings when a source doesn't write a + severity value. + - >- + A critical vulnerability is easily discoverable by an external + actor, exploitable. + - >- + A high risk vulnerability can be easily discovered and exploited + in combination with other vulnerabilities. + - >- + A medium risk vulnerability could be used by an actor to gain + access to resources or privileges that enable them to eventually + gain access and the ability to execute arbitrary code or + exfiltrate data. + - >- + A low risk vulnerability hampers a security organization's ability + to detect vulnerabilities or active threats in their deployment. + enum: + - SIGNAL_SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW compliance: description: >- Industry standards associated with this signal; if this signal is an @@ -2772,7 +3098,7 @@ components: description: Required. Type of metric like CPU, Memory, etc. type: string enumDescriptions: - - '' + - Unspecified metric type. - >- CPU utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). @@ -2780,20 +3106,32 @@ components: Memory utilization for a resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). - Number of network connections for a resource. + - >- + Storage utilization for a resource. The value is a fraction + between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases). + - Sotrage used by a resource. enum: - METRIC_TYPE_UNSPECIFIED - CPU_UTILIZATION - MEMORY_UTILIZATION - NETWORK_CONNECTIONS + - STORAGE_UTILIZATION + - STORAGE_USED_BYTES aggregationType: description: Required. Type of aggregation performed on the metric. type: string enumDescriptions: - Unspecified aggregation type. - - Maximum aggregation type. + - PEAK aggregation type. + - P99 aggregation type. + - P95 aggregation type. + - current aggregation type. enum: - AGGREGATION_TYPE_UNSPECIFIED - - MAXIMUM + - PEAK + - P99 + - P95 + - CURRENT value: description: Required. Value of the metric type. $ref: '#/components/schemas/TypedValue' @@ -2809,15 +3147,340 @@ components: type: object properties: doubleValue: + description: For double value type: number format: double int64Value: + description: For integer value type: string format: int64 stringValue: + description: For string value type: string boolValue: + description: For boolean value type: boolean + AssetLocation: + id: AssetLocation + description: >- + Provides the mapping of a cloud asset to a direct physical location or + to a proxy that defines the location on its behalf. + type: object + properties: + expected: + description: >- + Defines the customer expectation around ZI/ZS for this asset and + ZI/ZS state of the region at the time of asset creation. + $ref: '#/components/schemas/IsolationExpectations' + locationData: + description: Contains all kinds of physical location definitions for this asset. + type: array + items: + $ref: '#/components/schemas/LocationData' + parentAsset: + description: >- + Defines parents assets if any in order to allow later generation of + child_asset_location data via child assets. + type: array + items: + $ref: '#/components/schemas/CloudAsset' + extraParameters: + description: Defines extra parameters required for specific asset types. + type: array + items: + $ref: '#/components/schemas/ExtraParameter' + ccfeRmsPath: + description: >- + Spanner path of the CCFE RMS database. It is only applicable for + CCFE tenants that use CCFE RMS for storing resource metadata. + type: string + IsolationExpectations: + id: IsolationExpectations + type: object + properties: + zoneIsolation: + description: >- + Deprecated: use zi_org_policy, zi_region_policy and zi_region_state + instead for setting ZI expectations as per + go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zoneSeparation: + description: >- + Deprecated: use zs_org_policy, and zs_region_stateinstead for + setting Zs expectations as per go/zicy-publish-physical-location. + deprecated: true + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + zsRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking of the asset ZS-bit is not available + - '' + - '' + enum: + - ZS_REGION_UNSPECIFIED + - ZS_REGION_UNKNOWN + - ZS_REGION_NOT_ENABLED + - ZS_REGION_ENABLED + ziOrgPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + ziRegionPolicy: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_REGION_POLICY_UNSPECIFIED + - ZI_REGION_POLICY_UNKNOWN + - ZI_REGION_POLICY_NOT_SET + - ZI_REGION_POLICY_FAIL_OPEN + - ZI_REGION_POLICY_FAIL_CLOSED + ziRegionState: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZI_REGION_UNSPECIFIED + - ZI_REGION_UNKNOWN + - ZI_REGION_NOT_ENABLED + - ZI_REGION_ENABLED + requirementOverride: + description: >- + Explicit overrides for ZI and ZS requirements to be used for + resources that should be excluded from ZI/ZS verification logic. + $ref: '#/components/schemas/RequirementOverride' + RequirementOverride: + id: RequirementOverride + type: object + properties: + ziOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zsOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED + LocationData: + id: LocationData + type: object + properties: + directLocation: + $ref: '#/components/schemas/DirectLocationAssignment' + spannerLocation: + $ref: '#/components/schemas/SpannerLocation' + childAssetLocation: + $ref: '#/components/schemas/CloudAssetComposition' + gcpProjectProxy: + $ref: '#/components/schemas/TenantProjectProxy' + blobstoreLocation: + $ref: '#/components/schemas/BlobstoreLocation' + placerLocation: + $ref: '#/components/schemas/PlacerLocation' + DirectLocationAssignment: + id: DirectLocationAssignment + type: object + properties: + location: + type: array + items: + $ref: '#/components/schemas/LocationAssignment' + LocationAssignment: + id: LocationAssignment + type: object + properties: + location: + type: string + locationType: + type: string + enumDescriptions: + - '' + - '1-10: Physical failure domains.' + - '' + - '11-20: Logical failure domains.' + - '' + - '' + - '' + - '' + - '' + enum: + - UNSPECIFIED + - CLUSTER + - POP + - CLOUD_ZONE + - CLOUD_REGION + - MULTI_REGION_GEO + - MULTI_REGION_JURISDICTION + - GLOBAL + - OTHER + SpannerLocation: + id: SpannerLocation + type: object + properties: + dbName: + description: Set of databases used by the resource in format /span// + type: array + items: + type: string + backupName: + description: >- + Set of backups used by the resource with name in the same format as + what is available at http://table/spanner_automon.backup_metadata + type: array + items: + type: string + CloudAssetComposition: + id: CloudAssetComposition + type: object + properties: + childAsset: + type: array + items: + $ref: '#/components/schemas/CloudAsset' + CloudAsset: + id: CloudAsset + type: object + properties: + assetType: + type: string + assetName: + type: string + TenantProjectProxy: + id: TenantProjectProxy + type: object + properties: + projectNumbers: + type: array + items: + type: string + BlobstoreLocation: + id: BlobstoreLocation + description: >- + Policy ID that identified data placement in Blobstore as per + go/blobstore-user-guide#data-metadata-placement-and-failure-domains + type: object + properties: + policyId: + type: array + items: + type: string + PlacerLocation: + id: PlacerLocation + description: >- + Message describing that the location of the customer resource is tied to + placer allocations + type: object + properties: + placerConfig: + description: >- + Directory with a config related to it in placer (e.g. + "/placer/prod/home/my-root/my-dir") + type: string + ExtraParameter: + id: ExtraParameter + description: Defines parameters that should only be used for specific asset types. + type: object + properties: + regionalMigDistributionPolicy: + description: >- + Details about zones used by regional + compute.googleapis.com/InstanceGroupManager to create instances. + $ref: '#/components/schemas/RegionalMigDistributionPolicy' + RegionalMigDistributionPolicy: + id: RegionalMigDistributionPolicy + description: >- + To be used for specifying the intended distribution of regional + compute.googleapis.com/InstanceGroupManager instances + type: object + properties: + zones: + description: Cloud zones used by regional MIG to create instances. + type: array + items: + $ref: '#/components/schemas/ZoneConfiguration' + targetShape: + description: >- + The shape in which the group converges around distribution of + resources. Instance of proto2 enum + type: integer + format: int32 + ZoneConfiguration: + id: ZoneConfiguration + type: object + properties: + zone: + type: string OperationMetadata: id: OperationMetadata description: Pre-defined metadata fields. @@ -2999,16 +3662,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3021,23 +3681,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.redis.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -3065,6 +3723,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' clusters: @@ -3072,17 +3731,14 @@ components: name: clusters title: Clusters methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clusters - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -3111,6 +3767,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + reschedule_cluster_maintenance: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1clusters~1{clustersId}:rescheduleClusterMaintenance/post + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/clusters/methods/get' @@ -3119,6 +3782,7 @@ components: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' update: - $ref: '#/components/x-stackQL-resources/clusters/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' clusters_certificate_authority: @@ -3139,23 +3803,21 @@ components: #/components/x-stackQL-resources/clusters_certificate_authority/methods/get_certificate_authority insert: [] update: [] + replace: [] delete: [] instances: id: google.redis.instances name: instances title: Instances methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1instances/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -3227,6 +3889,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/create' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' instances_auth_string: @@ -3247,10 +3910,11 @@ components: #/components/x-stackQL-resources/instances_auth_string/methods/get_auth_string insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3297,7 +3961,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: redis.projects.locations.get @@ -3325,7 +3989,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3368,7 +4032,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3439,7 +4103,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3481,7 +4145,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists all Redis clusters owned by a project in either the specified @@ -3569,7 +4233,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the details of a specific Redis cluster. operationId: redis.projects.locations.clusters.get @@ -3688,7 +4352,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the details of certificate authority information for Redis cluster. operationId: redis.projects.locations.clusters.getCertificateAuthority @@ -3720,8 +4384,46 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:rescheduleClusterMaintenance: + parameters: *ref_1 + post: + description: Reschedules upcoming maintenance event. + operationId: redis.projects.locations.clusters.rescheduleClusterMaintenance + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RescheduleClusterMaintenanceRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: clustersId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/instances: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists all Redis instances owned by a project in either the specified @@ -3807,7 +4509,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets the details of a specific Redis instance. operationId: redis.projects.locations.instances.get @@ -3918,7 +4620,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/authString: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the AUTH string for a Redis instance. If AUTH is not enabled for @@ -3954,7 +4656,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Upgrades Redis instance to the newer Redis version specified in the @@ -3994,7 +4696,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:import: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Import a Redis RDB snapshot file from Cloud Storage into a Redis @@ -4038,7 +4740,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:export: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Export Redis instance data into a Redis RDB format file in Cloud @@ -4080,7 +4782,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:failover: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Initiates a failover of the primary node to current replica node for a @@ -4120,7 +4822,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rescheduleMaintenance: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Reschedule maintenance for a given instance in a given project and diff --git a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml index 2f1911db..541c0ba8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/resourcesettings.yaml @@ -10,8 +10,8 @@ info: their GCP resources (e.g., VM, firewall, Project, etc.) across the Cloud Resource Hierarchy. version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/resource-manager/docs/resource-settings/overview servers: @@ -37,23 +37,84 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleCloudResourcesettingsV1ValueStringSet: - id: GoogleCloudResourcesettingsV1ValueStringSet + GoogleCloudResourcesettingsV1SettingMetadata: + description: Metadata about a setting which is not editable by the end user. + id: GoogleCloudResourcesettingsV1SettingMetadata + properties: + defaultValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' + description: >- + The value provided by Setting.effective_value if no setting value is + explicitly set. Note: not all settings have a default value. + dataType: + description: The data type for this setting. + enum: + - DATA_TYPE_UNSPECIFIED + - BOOLEAN + - STRING + - STRING_SET + - ENUM_VALUE + - DURATION_VALUE + - STRING_MAP + enumDescriptions: + - Unspecified data type. + - A boolean setting. + - A string setting. + - A string set setting. + - A Enum setting + - A Duration setting + - A string->string map setting + type: string + displayName: + type: string + description: The human readable name for this setting. + description: + description: A detailed description of what this setting does. + type: string + readOnly: + type: boolean + description: >- + A flag indicating that values of this setting cannot be modified. + See documentation for the specific setting for updates and reasons. type: object + GoogleCloudResourcesettingsV1ValueStringMap: description: >- - A string set value that can hold a set of strings. The maximum length of - each string is 200 characters and there can be a maximum of 50 strings - in the string set. + A string->string map value that can hold a map of string keys to string + values. The maximum length of each string is 200 characters and there + can be a maximum of 50 key-value pairs in the map. + id: GoogleCloudResourcesettingsV1ValueStringMap properties: - values: - items: + mappings: + type: object + description: The key-value pairs in the map + additionalProperties: type: string - description: The strings in the set - type: array - GoogleCloudResourcesettingsV1Setting: - description: The schema for settings. type: object - id: GoogleCloudResourcesettingsV1Setting + GoogleCloudResourcesettingsV1Value: + properties: + enumValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' + description: Defines this value as being a Enum. + stringMapValue: + description: Defines this value as being a StringMap. + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' + stringSetValue: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' + description: Defines this value as being a StringSet. + stringValue: + type: string + description: Defines this value as being a string value. + durationValue: + format: google-duration + description: Defines this value as being a Duration. + type: string + booleanValue: + type: boolean + description: Defines this value as being a boolean value. + id: GoogleCloudResourcesettingsV1Value + description: The data in a setting value. + type: object + GoogleCloudResourcesettingsV1Setting: properties: effectiveValue: readOnly: true @@ -70,14 +131,6 @@ components: `Value` with all fields unset. The data type of Value must always be consistent with the data type defined in Setting.metadata. $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - name: - description: >- - The resource name of the setting. Must be in one of the following - forms: * `projects/{project_number}/settings/{setting_name}` * - `folders/{folder_id}/settings/{setting_name}` * - `organizations/{organization_id}/settings/{setting_name}` For - example, "/projects/123/settings/gcp-enableMyFeature" - type: string localValue: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' description: >- @@ -89,174 +142,116 @@ components: A fingerprint used for optimistic concurrency. See UpdateSetting for more details. type: string + name: + type: string + description: >- + The resource name of the setting. Must be in one of the following + forms: * `projects/{project_number}/settings/{setting_name}` * + `folders/{folder_id}/settings/{setting_name}` * + `organizations/{organization_id}/settings/{setting_name}` For + example, "/projects/123/settings/gcp-enableMyFeature" metadata: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1SettingMetadata' readOnly: true + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1SettingMetadata' description: >- Output only. Metadata about a setting which is not editable by the end user. - GoogleCloudResourcesettingsV1ListSettingsResponse: type: object - id: GoogleCloudResourcesettingsV1ListSettingsResponse + id: GoogleCloudResourcesettingsV1Setting + description: The schema for settings. + GoogleCloudResourcesettingsV1ValueEnumValue: + description: >- + A enum value that can hold any enum type setting values. Each enum type + is represented by a number, this representation is stored in the + definitions. + properties: + value: + type: string + description: The value of this enum + type: object + id: GoogleCloudResourcesettingsV1ValueEnumValue + GoogleCloudResourcesettingsV1ValueStringSet: + type: object + description: >- + A string set value that can hold a set of strings. The maximum length of + each string is 200 characters and there can be a maximum of 50 strings + in the string set. + properties: + values: + type: array + items: + type: string + description: The strings in the set + id: GoogleCloudResourcesettingsV1ValueStringSet + GoogleCloudResourcesettingsV1ListSettingsResponse: properties: nextPageToken: type: string description: Unused. A page token used to retrieve the next page. settings: + items: + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' type: array description: >- A list of settings that are available at the specified Cloud resource. - items: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + id: GoogleCloudResourcesettingsV1ListSettingsResponse description: The response from ListSettings. - GoogleCloudResourcesettingsV1Value: - description: The data in a setting value. - id: GoogleCloudResourcesettingsV1Value - properties: - enumValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueEnumValue' - description: Defines this value as being a Enum. - stringSetValue: - description: Defines this value as being a StringSet. - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringSet' - durationValue: - type: string - description: Defines this value as being a Duration. - format: google-duration - stringMapValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1ValueStringMap' - description: Defines this value as being a StringMap. - booleanValue: - description: Defines this value as being a boolean value. - type: boolean - stringValue: - description: Defines this value as being a string value. - type: string - type: object - GoogleCloudResourcesettingsV1ValueStringMap: - properties: - mappings: - type: object - additionalProperties: - type: string - description: The key-value pairs in the map - type: object - description: >- - A string->string map value that can hold a map of string keys to string - values. The maximum length of each string is 200 characters and there - can be a maximum of 50 key-value pairs in the map. - id: GoogleCloudResourcesettingsV1ValueStringMap - GoogleCloudResourcesettingsV1SettingMetadata: - id: GoogleCloudResourcesettingsV1SettingMetadata - properties: - displayName: - type: string - description: The human readable name for this setting. - defaultValue: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Value' - description: >- - The value provided by Setting.effective_value if no setting value is - explicitly set. Note: not all settings have a default value. - description: - description: A detailed description of what this setting does. - type: string - dataType: - type: string - description: The data type for this setting. - enumDescriptions: - - Unspecified data type. - - A boolean setting. - - A string setting. - - A string set setting. - - A Enum setting - - A Duration setting - - A string->string map setting - enum: - - DATA_TYPE_UNSPECIFIED - - BOOLEAN - - STRING - - STRING_SET - - ENUM_VALUE - - DURATION_VALUE - - STRING_MAP - readOnly: - description: >- - A flag indicating that values of this setting cannot be modified. - See documentation for the specific setting for updates and reasons. - type: boolean - description: Metadata about a setting which is not editable by the end user. - type: object - GoogleCloudResourcesettingsV1ValueEnumValue: - id: GoogleCloudResourcesettingsV1ValueEnumValue type: object - properties: - value: - type: string - description: The value of this enum - description: >- - A enum value that can hold any enum type setting values. Each enum type - is represented by a number, this representation is stored in the - definitions. parameters: - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query name: uploadType schema: type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: key + name: oauth_token schema: type: string - access_token: - description: OAuth access token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: access_token + name: prettyPrint schema: - type: string - callback: - description: JSONP + type: boolean + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: callback + name: quotaUser schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + alt: + description: Data format for response. in: query - name: oauth_token + name: alt schema: type: string + enum: + - json + - media + - proto upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: quotaUser + name: fields schema: type: string _.xgafv: @@ -268,32 +263,46 @@ components: enum: - '1' - '2' - alt: - description: Data format for response. + callback: + description: JSONP in: query - name: alt + name: callback + schema: + type: string + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. + in: query + name: key schema: type: string - enum: - - json - - media - - proto x-stackQL-resources: settings: id: google.resourcesettings.settings name: settings title: Settings methods: - _organizations_settings_list: - operation: &ref_1 - $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1settings/get' - response: &ref_2 + projects_settings_list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.settings - organizations_settings_list: - operation: *ref_1 - response: *ref_2 + projects_settings_get: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + projects_settings_patch: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' organizations_settings_get: operation: $ref: >- @@ -308,16 +317,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_settings_list: - operation: &ref_3 - $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings/get' - response: &ref_4 + organizations_settings_list: + operation: + $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1settings/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.settings - folders_settings_list: - operation: *ref_3 - response: *ref_4 folders_settings_patch: operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings~1{settingsId}/patch' @@ -330,70 +336,56 @@ components: response: mediaType: application/json openAPIDocKey: '200' - projects_settings_patch: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - projects_settings_get: + folders_settings_list: operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings~1{settingsId}/get' + $ref: '#/paths/~1v1~1folders~1{foldersId}~1settings/get' response: mediaType: application/json openAPIDocKey: '200' - _projects_settings_list: - operation: &ref_5 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1settings/get' - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' objectKey: $.settings - projects_settings_list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: + - $ref: >- + #/components/x-stackQL-resources/settings/methods/projects_settings_get - $ref: >- #/components/x-stackQL-resources/settings/methods/organizations_settings_get - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_get - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_get + #/components/x-stackQL-resources/settings/methods/projects_settings_list - $ref: >- #/components/x-stackQL-resources/settings/methods/organizations_settings_list - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_list - - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_list insert: [] update: + - $ref: >- + #/components/x-stackQL-resources/settings/methods/projects_settings_patch - $ref: >- #/components/x-stackQL-resources/settings/methods/organizations_settings_patch - $ref: >- #/components/x-stackQL-resources/settings/methods/folders_settings_patch - - $ref: >- - #/components/x-stackQL-resources/settings/methods/projects_settings_patch + replace: [] delete: [] paths: - /v1/organizations/{organizationsId}/settings: - parameters: &ref_7 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' + /v1/projects/{projectsId}/settings: + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/key' get: description: >- Lists all the settings that are available on the Cloud resource `parent`. - operationId: resourcesettings.organizations.settings.list + operationId: resourcesettings.projects.settings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -409,7 +401,7 @@ paths: #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -417,22 +409,22 @@ paths: name: view schema: type: string - - in: query - name: pageToken - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1/organizations/{organizationsId}/settings/{settingsId}: - parameters: *ref_7 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/settings/{settingsId}: + parameters: *ref_1 get: description: >- Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.organizations.settings.get + operationId: resourcesettings.projects.settings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -447,7 +439,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -471,7 +463,7 @@ paths: will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.organizations.settings.patch + operationId: resourcesettings.projects.settings.patch requestBody: content: application/json: @@ -491,7 +483,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: organizationsId + name: projectsId required: true schema: type: string @@ -500,13 +492,13 @@ paths: required: true schema: type: string - /v1/folders/{foldersId}/settings: - parameters: *ref_7 + /v1/organizations/{organizationsId}/settings/{settingsId}: + parameters: *ref_1 get: description: >- - Lists all the settings that are available on the Cloud resource - `parent`. - operationId: resourcesettings.folders.settings.list + Returns a specified setting. Returns a `google.rpc.Status` with + `google.rpc.Code.NOT_FOUND` if the setting does not exist. + operationId: resourcesettings.organizations.settings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -518,29 +510,22 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse + $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: settingsId + required: true schema: type: string - in: query name: view schema: type: string - /v1/folders/{foldersId}/settings/{settingsId}: - parameters: *ref_7 patch: description: >- Updates a specified setting. Returns a `google.rpc.Status` with @@ -552,7 +537,7 @@ paths: will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.folders.settings.patch + operationId: resourcesettings.organizations.settings.patch requestBody: content: application/json: @@ -572,7 +557,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string @@ -581,11 +566,13 @@ paths: required: true schema: type: string + /v1/organizations/{organizationsId}/settings: + parameters: *ref_1 get: description: >- - Returns a specified setting. Returns a `google.rpc.Status` with - `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.folders.settings.get + Lists all the settings that are available on the Cloud resource + `parent`. + operationId: resourcesettings.organizations.settings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -597,24 +584,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' + $ref: >- + #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse parameters: - in: path - name: foldersId + name: organizationsId required: true schema: type: string - - in: path - name: settingsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - in: query name: view schema: type: string - /v1/projects/{projectsId}/settings/{settingsId}: - parameters: *ref_7 + /v1/folders/{foldersId}/settings/{settingsId}: + parameters: *ref_1 patch: description: >- Updates a specified setting. Returns a `google.rpc.Status` with @@ -626,7 +618,7 @@ paths: will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. - operationId: resourcesettings.projects.settings.patch + operationId: resourcesettings.folders.settings.patch requestBody: content: application/json: @@ -646,7 +638,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -659,7 +651,7 @@ paths: description: >- Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. - operationId: resourcesettings.projects.settings.get + operationId: resourcesettings.folders.settings.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -674,7 +666,7 @@ paths: $ref: '#/components/schemas/GoogleCloudResourcesettingsV1Setting' parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string @@ -687,13 +679,13 @@ paths: name: view schema: type: string - /v1/projects/{projectsId}/settings: - parameters: *ref_7 + /v1/folders/{foldersId}/settings: + parameters: *ref_1 get: description: >- Lists all the settings that are available on the Cloud resource `parent`. - operationId: resourcesettings.projects.settings.list + operationId: resourcesettings.folders.settings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -709,16 +701,16 @@ paths: #/components/schemas/GoogleCloudResourcesettingsV1ListSettingsResponse parameters: - in: path - name: projectsId + name: foldersId required: true schema: type: string - in: query - name: pageToken + name: view schema: type: string - in: query - name: view + name: pageToken schema: type: string - in: query diff --git a/providers/src/googleapis.com/v00.00.00000/services/retail.yaml b/providers/src/googleapis.com/v00.00.00000/services/retail.yaml index 2be960ef..1d57be05 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/retail.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/retail.yaml @@ -11,8 +11,8 @@ info: personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. version: v2 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/recommendations servers: @@ -831,17 +831,6 @@ components: no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. type: string - mergedFacetValues: - description: >- - Each instance is a list of facet values that map into the same - (possibly different) merged facet value. For the current attribute - config, each facet value should map to at most one merged facet - value. - deprecated: true - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig: id: GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig description: >- @@ -1878,8 +1867,13 @@ components: availability: description: >- The online availability of the Product. Default to - Availability.IN_STOCK. Corresponding properties: Google Merchant - Center property + Availability.IN_STOCK. For primary products with variants set the + availability of the primary as Availability.OUT_OF_STOCK and set the + true availability at the variant level. This way the primary product + will be considered "in stock" as long as it has at least one variant + in stock. For primary products with no variants set the true + availability at the primary level. Corresponding properties: Google + Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). @@ -2552,6 +2546,15 @@ components: items: $ref: >- #/components/schemas/GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult + attributeResults: + description: >- + A map of matched attribute suggestions. This field is only available + for "cloud-retail" dataset. Current supported keys: * `brands` * + `categories` + type: object + additionalProperties: + $ref: >- + #/components/schemas/GoogleCloudRetailV2CompleteQueryResponseAttributeResult GoogleCloudRetailV2CompleteQueryResponseCompletionResult: id: GoogleCloudRetailV2CompleteQueryResponseCompletionResult description: Resource that represents completion results. @@ -2573,12 +2576,23 @@ components: GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult: id: GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult deprecated: true - description: Recent search of this user. + description: 'Deprecated: Recent search of this user.' type: object properties: recentSearch: description: The recent search query. type: string + GoogleCloudRetailV2CompleteQueryResponseAttributeResult: + id: GoogleCloudRetailV2CompleteQueryResponseAttributeResult + description: >- + Resource that represents attribute results. The list of suggestions for + the attribute. + type: object + properties: + suggestions: + type: array + items: + type: string GoogleCloudRetailV2ImportCompletionDataRequest: id: GoogleCloudRetailV2ImportCompletionDataRequest description: Request message for ImportCompletionData methods. @@ -2899,7 +2913,7 @@ components: facetPositionAdjustments: description: >- Each instance corresponds to a force return attribute for the given - condition. There can't be more 3 instances here. + condition. There can't be more 15 instances here. type: array items: $ref: >- @@ -5967,21 +5981,6 @@ components: ProductService.AddLocalInventories method. type: object properties: {} - GoogleCloudRetailV2betaCreateMerchantCenterAccountLinkMetadata: - id: GoogleCloudRetailV2betaCreateMerchantCenterAccountLinkMetadata - description: Common metadata related to the progress of the operations. - type: object - properties: - createTime: - description: Operation create time. - type: string - format: google-datetime - updateTime: - description: >- - Operation last update time. If the operation is done, this is also - the finish time. - type: string - format: google-datetime GoogleCloudRetailV2betaCreateModelMetadata: id: GoogleCloudRetailV2betaCreateModelMetadata description: Metadata associated with a create operation. @@ -6239,106 +6238,6 @@ components: found in the imported catalog. type: string format: int64 - GoogleCloudRetailV2betaMerchantCenterAccountLink: - id: GoogleCloudRetailV2betaMerchantCenterAccountLink - description: >- - Represents a link between a Merchant Center account and a branch. After - a link is established, products from the linked Merchant Center account - are streamed to the linked branch. - type: object - properties: - name: - description: >- - Output only. Immutable. Full resource name of the Merchant Center - Account Link, such as - `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/merchant_center_account_link`. - readOnly: true - type: string - id: - description: >- - Output only. Immutable. MerchantCenterAccountLink identifier, which - is the final component of name. This field is auto generated and - follows the convention: `BranchId_MerchantCenterAccountId`. - `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/id_1`. - readOnly: true - type: string - merchantCenterAccountId: - description: >- - Required. The linked [Merchant center account - id](https://developers.google.com/shopping-content/guides/accountstatuses). - The account must be a standalone account or a sub-account of a MCA. - type: string - format: int64 - branchId: - description: >- - Required. The branch ID (e.g. 0/1/2) within the catalog that - products from merchant_center_account_id are streamed to. When - updating this field, an empty value will use the currently - configured default branch. However, changing the default branch - later on won't change the linked branch here. A single branch ID can - only have one linked Merchant Center account ID. - type: string - feedLabel: - description: >- - The FeedLabel used to perform filtering. Note: this replaces - [region_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.feed_label). - Example value: `US`. Example value: `FeedLabel1`. - type: string - languageCode: - description: >- - Language of the title/description and other string attributes. Use - language tags defined by [BCP - 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO 639-1. This - specifies the language of offers in Merchant Center that will be - accepted. If empty, no language filtering will be performed. Example - value: `en`. - type: string - feedFilters: - description: >- - Criteria for the Merchant Center feeds to be ingested via the link. - All offers will be ingested if the list is empty. Otherwise the - offers will be ingested from selected feeds. - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudRetailV2betaMerchantCenterAccountLinkMerchantCenterFeedFilter - state: - description: Output only. Represents the state of the link. - readOnly: true - type: string - enumDescriptions: - - Default value. - - Link is created and LRO is not complete. - - Link is active. - - Link creation failed. - enum: - - STATE_UNSPECIFIED - - PENDING - - ACTIVE - - FAILED - projectId: - description: Output only. Google Cloud project ID. - readOnly: true - type: string - source: - description: >- - Optional. An optional arbitrary string that could be used as a tag - for tracking link source. - type: string - GoogleCloudRetailV2betaMerchantCenterAccountLinkMerchantCenterFeedFilter: - id: GoogleCloudRetailV2betaMerchantCenterAccountLinkMerchantCenterFeedFilter - description: Merchant Center Feed filter criterion. - type: object - properties: - primaryFeedId: - description: Merchant Center primary feed ID. - type: string - format: int64 - primaryFeedName: - description: >- - Merchant Center primary feed name. The name is used for the display - purposes only. - type: string GoogleCloudRetailV2betaModel: id: GoogleCloudRetailV2betaModel description: >- @@ -6793,17 +6692,14 @@ components: name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_1 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_1 - response: *ref_2 projects_locations_operations_get: operation: $ref: >- @@ -6811,17 +6707,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_operations_list: - operation: &ref_3 + projects_locations_catalogs_operations_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_catalogs_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_catalogs_operations_get: operation: $ref: >- @@ -6836,16 +6729,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_operations_list: - operation: &ref_5 + projects_operations_list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1operations/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_operations_list: - operation: *ref_5 - response: *ref_6 projects_operations_get: operation: $ref: >- @@ -6871,6 +6761,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_operations_list insert: [] update: [] + replace: [] delete: [] catalogs: id: google.retail.catalogs @@ -6884,17 +6775,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_list: - operation: &ref_7 + projects_locations_catalogs_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.catalogs - projects_locations_catalogs_list: - operation: *ref_7 - response: *ref_8 projects_locations_catalogs_patch: operation: $ref: >- @@ -6924,6 +6812,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/catalogs/methods/projects_locations_catalogs_patch + replace: [] delete: [] catalogs_default_branch: id: google.retail.catalogs_default_branch @@ -6943,6 +6832,7 @@ components: #/components/x-stackQL-resources/catalogs_default_branch/methods/projects_locations_catalogs_get_default_branch insert: [] update: [] + replace: [] delete: [] catalogs_completion_config: id: google.retail.catalogs_completion_config @@ -6968,7 +6858,10 @@ components: - $ref: >- #/components/x-stackQL-resources/catalogs_completion_config/methods/projects_locations_catalogs_get_completion_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/catalogs_completion_config/methods/projects_locations_catalogs_update_completion_config + replace: [] delete: [] catalogs_attributes_config: id: google.retail.catalogs_attributes_config @@ -6994,7 +6887,10 @@ components: - $ref: >- #/components/x-stackQL-resources/catalogs_attributes_config/methods/projects_locations_catalogs_get_attributes_config insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/catalogs_attributes_config/methods/projects_locations_catalogs_update_attributes_config + replace: [] delete: [] products: id: google.retail.products @@ -7008,17 +6904,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_branches_products_list: - operation: &ref_9 + projects_locations_catalogs_branches_products_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1branches~1{branchesId}~1products/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.products - projects_locations_catalogs_branches_products_list: - operation: *ref_9 - response: *ref_10 projects_locations_catalogs_branches_products_get: operation: $ref: >- @@ -7073,6 +6966,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_catalogs_branches_products_delete @@ -7097,9 +6991,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/products_fulfillment_places/methods/projects_locations_catalogs_branches_products_add_fulfillment_places update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/products_fulfillment_places/methods/projects_locations_catalogs_branches_products_remove_fulfillment_places products_local_inventories: id: google.retail.products_local_inventories name: products_local_inventories @@ -7121,9 +7020,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/products_local_inventories/methods/projects_locations_catalogs_branches_products_add_local_inventories update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/products_local_inventories/methods/projects_locations_catalogs_branches_products_remove_local_inventories attributes_config_catalog_attribute: id: google.retail.attributes_config_catalog_attribute name: attributes_config_catalog_attribute @@ -7145,9 +7049,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/attributes_config_catalog_attribute/methods/projects_locations_catalogs_attributes_config_add_catalog_attribute update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/attributes_config_catalog_attribute/methods/projects_locations_catalogs_attributes_config_remove_catalog_attribute attributes_config: id: google.retail.attributes_config name: attributes_config @@ -7164,6 +7073,9 @@ components: select: [] insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/attributes_config/methods/projects_locations_catalogs_attributes_config_replace_catalog_attribute delete: [] placements: id: google.retail.placements @@ -7188,6 +7100,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] serving_configs: id: google.retail.serving_configs @@ -7215,17 +7128,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_serving_configs_list: - operation: &ref_11 + projects_locations_catalogs_serving_configs_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1servingConfigs/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.servingConfigs - projects_locations_catalogs_serving_configs_list: - operation: *ref_11 - response: *ref_12 projects_locations_catalogs_serving_configs_delete: operation: $ref: >- @@ -7259,6 +7169,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/serving_configs/methods/projects_locations_catalogs_serving_configs_delete @@ -7283,9 +7194,14 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/serving_configs_control/methods/projects_locations_catalogs_serving_configs_add_control update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/serving_configs_control/methods/projects_locations_catalogs_serving_configs_remove_control completion_data: id: google.retail.completion_data name: completion_data @@ -7302,6 +7218,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] controls: id: google.retail.controls @@ -7315,17 +7232,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_controls_list: - operation: &ref_13 + projects_locations_catalogs_controls_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1controls/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.controls - projects_locations_catalogs_controls_list: - operation: *ref_13 - response: *ref_14 projects_locations_catalogs_controls_delete: operation: $ref: >- @@ -7359,6 +7273,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/controls/methods/projects_locations_catalogs_controls_delete @@ -7374,17 +7289,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_catalogs_models_list: - operation: &ref_15 + projects_locations_catalogs_models_list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1catalogs~1{catalogsId}~1models/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.models - projects_locations_catalogs_models_list: - operation: *ref_15 - response: *ref_16 projects_locations_catalogs_models_get: operation: $ref: >- @@ -7439,6 +7351,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_catalogs_models_delete @@ -7486,10 +7399,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v2/projects/{projectsId}/locations/{locationsId}/operations: - parameters: &ref_17 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -7543,7 +7457,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -7579,7 +7493,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:exportAnalyticsMetrics: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Exports analytics metrics. `Operation.response` is of type @@ -7621,7 +7535,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists all the Catalogs associated with the project. operationId: retail.projects.locations.catalogs.list @@ -7658,7 +7572,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}: - parameters: *ref_17 + parameters: *ref_1 patch: description: Updates the Catalogs. operationId: retail.projects.locations.catalogs.patch @@ -7701,7 +7615,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:setDefaultBranch: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Set a specified branch id as default branch. API methods such as @@ -7760,7 +7674,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:getDefaultBranch: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Get which branch is currently default branch set by @@ -7796,7 +7710,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets a CompletionConfig. operationId: retail.projects.locations.catalogs.getCompletionConfig @@ -7870,7 +7784,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets an AttributesConfig. operationId: retail.projects.locations.catalogs.getAttributesConfig @@ -7951,7 +7865,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:completeQuery: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Completes the specified prefix with keyword suggestions. This feature is @@ -8020,7 +7934,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -8068,7 +7982,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8109,7 +8023,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8155,7 +8069,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products: - parameters: *ref_17 + parameters: *ref_1 post: description: Creates a Product. operationId: retail.projects.locations.catalogs.branches.products.create @@ -8256,7 +8170,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets a Product. operationId: retail.projects.locations.catalogs.branches.products.get @@ -8395,7 +8309,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products:purge: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Permanently deletes all selected Products under a branch. This process @@ -8446,7 +8360,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products:import: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Bulk import of multiple Products. Request processing may be synchronous. @@ -8492,7 +8406,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:setInventory: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Updates inventory information for a Product while respecting the last @@ -8563,7 +8477,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addFulfillmentPlaces: - parameters: *ref_17 + parameters: *ref_1 post: description: >- We recommend that you use the ProductService.AddLocalInventories method @@ -8627,7 +8541,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeFulfillmentPlaces: - parameters: *ref_17 + parameters: *ref_1 post: description: >- We recommend that you use the ProductService.RemoveLocalInventories @@ -8692,7 +8606,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:addLocalInventories: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Updates local inventory information for a Product at a list of places, @@ -8755,7 +8669,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}:removeLocalInventories: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Remove local inventory information for a Product at a list of places at @@ -8817,7 +8731,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:addCatalogAttribute: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Adds the specified CatalogAttribute to the AttributesConfig. If the @@ -8859,7 +8773,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:removeCatalogAttribute: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Removes the specified CatalogAttribute from the AttributesConfig. If the @@ -8902,7 +8816,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig:replaceCatalogAttribute: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Replaces the specified CatalogAttribute in the AttributesConfig by @@ -8946,7 +8860,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:search: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Performs a search. This feature is only available for users who have @@ -8992,7 +8906,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:predict: - parameters: *ref_17 + parameters: *ref_1 post: description: Makes a recommendation prediction. operationId: retail.projects.locations.catalogs.placements.predict @@ -9035,7 +8949,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:search: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Performs a search. This feature is only available for users who have @@ -9081,7 +8995,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:predict: - parameters: *ref_17 + parameters: *ref_1 post: description: Makes a recommendation prediction. operationId: retail.projects.locations.catalogs.servingConfigs.predict @@ -9124,7 +9038,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in @@ -9209,7 +9123,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}: - parameters: *ref_17 + parameters: *ref_1 delete: description: >- Deletes a ServingConfig. Returns a NotFound error if the ServingConfig @@ -9333,7 +9247,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:addControl: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Enables a Control on the specified ServingConfig. The control is added @@ -9383,7 +9297,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:removeControl: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Disables a Control on the specified ServingConfig. The control is @@ -9429,7 +9343,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionData:import: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Bulk import of processed completion dataset. Request processing is @@ -9474,7 +9388,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Creates a Control. If the Control to create already exists, an @@ -9562,7 +9476,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/controls/{controlsId}: - parameters: *ref_17 + parameters: *ref_1 delete: description: >- Deletes a Control. If the Control to delete does not exist, a NOT_FOUND @@ -9687,7 +9601,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models: - parameters: *ref_17 + parameters: *ref_1 post: description: Creates a new model. operationId: retail.projects.locations.catalogs.models.create @@ -9769,7 +9683,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets a model. operationId: retail.projects.locations.catalogs.models.get @@ -9892,7 +9806,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:pause: - parameters: *ref_17 + parameters: *ref_1 post: description: Pauses the training of an existing model. operationId: retail.projects.locations.catalogs.models.pause @@ -9935,7 +9849,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:resume: - parameters: *ref_17 + parameters: *ref_1 post: description: Resumes the training of an existing model. operationId: retail.projects.locations.catalogs.models.resume @@ -9978,7 +9892,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:tune: - parameters: *ref_17 + parameters: *ref_1 post: description: Tunes an existing model. operationId: retail.projects.locations.catalogs.models.tune @@ -10021,7 +9935,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:write: - parameters: *ref_17 + parameters: *ref_1 post: description: Writes a single user event. operationId: retail.projects.locations.catalogs.userEvents.write @@ -10063,7 +9977,7 @@ paths: schema: type: boolean /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:collect: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Writes a single user event from the browser. This uses a GET request to @@ -10121,7 +10035,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:purge: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Deletes permanently all user events specified by the filter provided. @@ -10163,7 +10077,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Bulk import of User events. Request processing might be synchronous. @@ -10207,7 +10121,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:rejoin: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Starts a user-event rejoin operation with latest product catalog. Events @@ -10253,7 +10167,7 @@ paths: schema: type: string /v2/projects/{projectsId}/operations: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -10291,7 +10205,7 @@ paths: schema: type: string /v2/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this diff --git a/providers/src/googleapis.com/v00.00.00000/services/run.yaml b/providers/src/googleapis.com/v00.00.00000/services/run.yaml index 35b1602f..ecb70cbc 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/run.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/run.yaml @@ -11,8 +11,8 @@ info: Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/. version: v2 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/run/ servers: @@ -277,6 +277,128 @@ components: will be used. type: string format: google-duration + GoogleCloudRunV2SubmitBuildRequest: + id: GoogleCloudRunV2SubmitBuildRequest + description: Request message for submitting a Build. + type: object + properties: + storageSource: + description: Required. Source for the build. + $ref: '#/components/schemas/GoogleCloudRunV2StorageSource' + imageUri: + description: Required. Artifact Registry URI to store the built image. + type: string + buildpackBuild: + description: Build the source using Buildpacks. + $ref: '#/components/schemas/GoogleCloudRunV2BuildpacksBuild' + dockerBuild: + description: >- + Build the source using Docker. This means the source has a + Dockerfile. + $ref: '#/components/schemas/GoogleCloudRunV2DockerBuild' + serviceAccount: + description: >- + Optional. The service account to use for the build. If not set, the + default Cloud Build service account for the project will be used. + type: string + workerPool: + description: >- + Optional. Name of the Cloud Build Custom Worker Pool that should be + used to build the function. The format of this field is + `projects/{project}/locations/{region}/workerPools/{workerPool}` + where {project} and {region} are the project id and region + respectively where the worker pool is defined and {workerPool} is + the short name of the worker pool. + type: string + tags: + description: Optional. Additional tags to annotate the build. + type: array + items: + type: string + GoogleCloudRunV2StorageSource: + id: GoogleCloudRunV2StorageSource + description: Location of the source in an archive file in Google Cloud Storage. + type: object + properties: + bucket: + description: >- + Required. Google Cloud Storage bucket containing the source (see + [Bucket Name + Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + type: string + object: + description: >- + Required. Google Cloud Storage object containing the source. This + object must be a gzipped archive file (`.tar.gz`) containing source + to build. + type: string + generation: + description: >- + Optional. Google Cloud Storage generation for the object. If the + generation is omitted, the latest generation will be used. + type: string + format: int64 + GoogleCloudRunV2BuildpacksBuild: + id: GoogleCloudRunV2BuildpacksBuild + description: Build the source using Buildpacks. + type: object + properties: + runtime: + description: The runtime name, e.g. 'go113'. Leave blank for generic builds. + deprecated: true + type: string + functionTarget: + description: >- + Optional. Name of the function target if the source is a function + source. Required for function builds. + type: string + cacheImageUri: + description: >- + Optional. cache_image_uri is the GCR/AR URL where the cache image + will be stored. cache_image_uri is optional and omitting it will + disable caching. This URL must be stable across builds. It is used + to derive a build-specific temporary URL by substituting the tag + with the build ID. The build will clean up the temporary image on a + best-effort basis. + type: string + baseImage: + description: >- + Optional. The base image used to opt into automatic base image + updates. + type: string + environmentVariables: + description: Optional. User-provided build-time environment variables. + type: object + additionalProperties: + type: string + enableAutomaticUpdates: + description: >- + Optional. Whether or not the application container will be enrolled + in automatic base image updates. When true, the application will be + built on a scratch base image, so the base layers can be appended at + run time. + type: boolean + GoogleCloudRunV2DockerBuild: + id: GoogleCloudRunV2DockerBuild + description: Build the source using Docker. This means the source has a Dockerfile. + type: object + properties: {} + GoogleCloudRunV2SubmitBuildResponse: + id: GoogleCloudRunV2SubmitBuildResponse + description: Response message for submitting a Build. + type: object + properties: + buildOperation: + description: Cloud Build operation to be polled via CloudBuild API. + $ref: '#/components/schemas/GoogleLongrunningOperation' + baseImageUri: + description: >- + URI of the base builder image in Artifact Registry being used in the + build. Used to opt into automatic base image updates. + type: string + baseImageWarning: + description: Warning message for the base image. + type: string GoogleCloudRunV2Execution: id: GoogleCloudRunV2Execution description: >- @@ -673,14 +795,9 @@ components: type: string value: description: >- - Variable references $(VAR_NAME) are expanded using the previous - defined environment variables in the container and any route - environment variables. If a variable cannot be resolved, the - reference in the input string will be unchanged. The $(VAR_NAME) - syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped - references will never be expanded, regardless of whether the - variable exists or not. Defaults to "", and the maximum length is - 32768 bytes. + Literal value of the environment variable. Defaults to "", and the + maximum length is 32768 bytes. Variable references are not supported + in Cloud Run. type: string valueSource: description: Source for the environment variable's value. @@ -1382,7 +1499,9 @@ components: type: string format: google-datetime deleteTime: - description: Output only. The deletion time. + description: >- + Output only. The deletion time. It is only populated as a response + to a Delete request. readOnly: true type: string format: google-datetime @@ -1653,6 +1772,29 @@ components: description: Creation timestamp of the execution. type: string format: google-datetime + deleteTime: + description: >- + The deletion time of the execution. It is only populated as a + response to a Delete request. + type: string + format: google-datetime + completionStatus: + description: Status for the execution completion. + type: string + enumDescriptions: + - The default value. This value is used if the state is omitted. + - Job execution has succeeded. + - Job execution has failed. + - Job execution is running normally. + - Waiting for backing resources to be provisioned. + - Job execution has been cancelled by the user. + enum: + - COMPLETION_STATUS_UNSPECIFIED + - EXECUTION_SUCCEEDED + - EXECUTION_FAILED + - EXECUTION_RUNNING + - EXECUTION_PENDING + - EXECUTION_CANCELLED GoogleCloudRunV2ListJobsResponse: id: GoogleCloudRunV2ListJobsResponse description: Response message containing a list of Jobs. @@ -2256,6 +2398,9 @@ components: encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek type: string + serviceMesh: + description: Enables service mesh connectivity. + $ref: '#/components/schemas/GoogleCloudRunV2ServiceMesh' encryptionKeyRevocationAction: description: The action to take if the encryption key is revoked. type: string @@ -2338,9 +2483,24 @@ components: maxInstanceCount: description: >- Optional. Maximum number of serving instances that this resource - should have. + should have. When unspecified, the field is set to the server + default value of 100. For more information see + https://cloud.google.com/run/docs/configuring/max-instances type: integer format: int32 + GoogleCloudRunV2ServiceMesh: + id: GoogleCloudRunV2ServiceMesh + description: >- + Settings for Cloud Service Mesh. For more information see + https://cloud.google.com/service-mesh/docs/overview. + type: object + properties: + mesh: + description: >- + The Mesh resource name. Format: + projects/{project}/locations/global/meshes/{mesh}, where {project} + can be project id or number. + type: string GoogleCloudRunV2RevisionScalingStatus: id: GoogleCloudRunV2RevisionScalingStatus description: Effective settings for the current revision @@ -2453,7 +2613,9 @@ components: type: string format: google-datetime deleteTime: - description: Output only. The deletion time. + description: >- + Output only. The deletion time. It is only populated as a response + to a Delete request. readOnly: true type: string format: google-datetime @@ -2576,6 +2738,22 @@ components: Optional. Disables public resolution of the default URI of this service. type: boolean + urls: + description: Output only. All URLs serving traffic for this Service. + readOnly: true + type: array + items: + type: string + customAudiences: + description: >- + One or more custom audiences that you want this service to support. + Specify each custom audience as the full URL in a string. The custom + audiences are encoded in the token and used to authenticate + requests. For more information, see + https://cloud.google.com/run/docs/configuring/custom-audiences. + type: array + items: + type: string observedGeneration: description: >- Output only. The generation of this Service currently serving @@ -2631,16 +2809,6 @@ components: description: Output only. The main URI in which this Service is serving traffic. readOnly: true type: string - customAudiences: - description: >- - One or more custom audiences that you want this service to support. - Specify each custom audience as the full URL in a string. The custom - audiences are encoded in the token and used to authenticate - requests. For more information, see - https://cloud.google.com/run/docs/configuring/custom-audiences. - type: array - items: - type: string satisfiesPzs: description: Output only. Reserved for future use. readOnly: true @@ -2773,9 +2941,13 @@ components: maxInstanceRequestConcurrency: description: >- Optional. Sets the maximum number of requests that each serving - instance can receive. + instance can receive. If not specified or 0, defaults to 80 when + requested CPU >= 1 and defaults to 1 when requested CPU < 1. type: integer format: int32 + serviceMesh: + description: Optional. Enables service mesh connectivity. + $ref: '#/components/schemas/GoogleCloudRunV2ServiceMesh' sessionAffinity: description: Optional. Enable session affinity. type: boolean @@ -4554,35 +4726,12 @@ components: properties: proxySecretVersionName: description: >- - SecretVersion resource of the HTTP proxy URL. The proxy URL should - be in format protocol://@]proxyhost[:port]. - type: string - proxySslCaInfo: - description: >- - Optional. Cloud Storage object storing the certificate to use with - the HTTP proxy. - $ref: '#/components/schemas/GoogleDevtoolsCloudbuildV1GCSLocation' - GoogleDevtoolsCloudbuildV1GCSLocation: - id: GoogleDevtoolsCloudbuildV1GCSLocation - description: Represents a storage location in Cloud Storage - type: object - properties: - bucket: - description: >- - Cloud Storage bucket. See - https://cloud.google.com/storage/docs/naming#requirements - type: string - object: - description: >- - Cloud Storage object. See - https://cloud.google.com/storage/docs/naming#objectnames - type: string - generation: - description: >- - Cloud Storage generation for the object. If the generation is - omitted, the latest generation will be used. + SecretVersion resource of the HTTP proxy URL. The Service Account + used in the build (either the default Service Account or + user-specified Service Account) should have + `secretmanager.versions.access` permissions on this secret. The + proxy URL should be in format `protocol://@]proxyhost[:port]`. type: string - format: int64 GoogleDevtoolsCloudbuildV1FailureInfo: id: GoogleDevtoolsCloudbuildV1FailureInfo description: A fatal problem encountered during the execution of the build. @@ -4696,6 +4845,13 @@ components: name: locations title: Locations methods: + export_project_metadata: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}:exportProjectMetadata/get + response: + mediaType: application/json + openAPIDocKey: '200' export_metadata: operation: $ref: >- @@ -4721,23 +4877,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] operations: id: google.run.operations name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -4765,8 +4919,27 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' + builds: + id: google.run.builds + name: builds + title: Builds + methods: + submit: + operation: + $ref: >- + #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1builds:submit/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] jobs: id: google.run.jobs name: jobs @@ -4779,17 +4952,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobs/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -4826,6 +4996,7 @@ components: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' update: - $ref: '#/components/x-stackQL-resources/jobs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' jobs_iam_policies: @@ -4833,17 +5004,14 @@ components: name: jobs_iam_policies title: Jobs_iam_policies methods: - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 set_iam_policy: operation: $ref: >- @@ -4864,6 +5032,9 @@ components: #/components/x-stackQL-resources/jobs_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/jobs_iam_policies/methods/set_iam_policy delete: [] executions: id: google.run.executions @@ -4891,17 +5062,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}~1executions/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.executions - list: - operation: *ref_7 - response: *ref_8 cancel: operation: $ref: >- @@ -4915,6 +5083,7 @@ components: - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/executions/methods/delete' tasks: @@ -4929,23 +5098,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1jobs~1{jobsId}~1executions~1{executionsId}~1tasks/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.tasks - list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/tasks/methods/get' - $ref: '#/components/x-stackQL-resources/tasks/methods/list' insert: [] update: [] + replace: [] delete: [] services: id: google.run.services @@ -4959,17 +5126,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1services/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -4999,6 +5163,7 @@ components: - $ref: '#/components/x-stackQL-resources/services/methods/create' update: - $ref: '#/components/x-stackQL-resources/services/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_iam_policies: @@ -5006,17 +5171,14 @@ components: name: services_iam_policies title: Services_iam_policies methods: - _get_iam_policy: - operation: &ref_13 + get_iam_policy: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}:getIamPolicy/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_13 - response: *ref_14 set_iam_policy: operation: $ref: >- @@ -5037,6 +5199,9 @@ components: #/components/x-stackQL-resources/services_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/services_iam_policies/methods/set_iam_policy delete: [] revisions: id: google.run.revisions @@ -5064,28 +5229,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1services~1{servicesId}~1revisions/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.revisions - list: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/revisions/methods/get' - $ref: '#/components/x-stackQL-resources/revisions/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/revisions/methods/delete' paths: - /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportMetadata: - parameters: &ref_17 + /v2/projects/{projectsId}/locations/{locationsId}:exportProjectMetadata: + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -5097,6 +5260,34 @@ paths: - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/_.xgafv' + get: + description: Export generated customer metadata for a given project. + operationId: run.projects.locations.exportProjectMetadata + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2Metadata' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportMetadata: + parameters: *ref_1 get: description: Export generated customer metadata for a given resource. operationId: run.projects.locations.exportMetadata @@ -5129,7 +5320,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImageMetadata: - parameters: *ref_17 + parameters: *ref_1 get: description: Export image metadata for a given resource. operationId: run.projects.locations.exportImageMetadata @@ -5162,7 +5353,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/{locationsId1}:exportImage: - parameters: *ref_17 + parameters: *ref_1 post: description: Export image for a given resource. operationId: run.projects.locations.exportImage @@ -5200,7 +5391,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -5243,7 +5434,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5314,7 +5505,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -5360,8 +5551,41 @@ paths: required: true schema: type: string + /v2/projects/{projectsId}/locations/{locationsId}/builds:submit: + parameters: *ref_1 + post: + description: Submits a build in a given project. + operationId: run.projects.locations.builds.submit + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2SubmitBuildRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleCloudRunV2SubmitBuildResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs: - parameters: *ref_17 + parameters: *ref_1 post: description: Creates a Job. operationId: run.projects.locations.jobs.create @@ -5441,7 +5665,7 @@ paths: schema: type: boolean /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about a Job. operationId: run.projects.locations.jobs.get @@ -5557,7 +5781,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run: - parameters: *ref_17 + parameters: *ref_1 post: description: Triggers creation of a new Execution of this Job. operationId: run.projects.locations.jobs.run @@ -5595,7 +5819,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:getIamPolicy: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the IAM Access Control policy currently in effect for the given @@ -5635,7 +5859,7 @@ paths: type: integer format: int32 /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:setIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Sets the IAM Access control policy for the specified Job. Overwrites any @@ -5675,7 +5899,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified Project. There @@ -5715,7 +5939,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/{executionsId1}:exportStatus: - parameters: *ref_17 + parameters: *ref_1 get: description: Read the status of an image export operation. operationId: run.projects.locations.jobs.executions.exportStatus @@ -5758,7 +5982,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about an Execution. operationId: run.projects.locations.jobs.executions.get @@ -5840,7 +6064,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists Executions from a Job. Results are sorted by creation time, @@ -5888,7 +6112,7 @@ paths: schema: type: boolean /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}:cancel: - parameters: *ref_17 + parameters: *ref_1 post: description: Cancels an Execution. operationId: run.projects.locations.jobs.executions.cancel @@ -5931,7 +6155,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks/{tasksId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about a Task. operationId: run.projects.locations.jobs.executions.tasks.get @@ -5974,7 +6198,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/executions/{executionsId}/tasks: - parameters: *ref_17 + parameters: *ref_1 get: description: Lists Tasks from an Execution of a Job. operationId: run.projects.locations.jobs.executions.tasks.list @@ -6025,7 +6249,7 @@ paths: schema: type: boolean /v2/projects/{projectsId}/locations/{locationsId}/services: - parameters: *ref_17 + parameters: *ref_1 post: description: Creates a new Service in a given project and location. operationId: run.projects.locations.services.create @@ -6105,7 +6329,7 @@ paths: schema: type: boolean /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about a Service. operationId: run.projects.locations.services.get @@ -6228,7 +6452,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:getIamPolicy: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Gets the IAM Access Control policy currently in effect for the given @@ -6268,7 +6492,7 @@ paths: type: integer format: int32 /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:setIamPolicy: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Sets the IAM Access control policy for the specified Service. Overwrites @@ -6308,7 +6532,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:testIamPermissions: - parameters: *ref_17 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified Project. There @@ -6348,7 +6572,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}/{revisionsId1}:exportStatus: - parameters: *ref_17 + parameters: *ref_1 get: description: Read the status of an image export operation. operationId: run.projects.locations.services.revisions.exportStatus @@ -6391,7 +6615,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions/{revisionsId}: - parameters: *ref_17 + parameters: *ref_1 get: description: Gets information about a Revision. operationId: run.projects.locations.services.revisions.get @@ -6473,7 +6697,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/revisions: - parameters: *ref_17 + parameters: *ref_1 get: description: >- Lists Revisions from a given Service, or from a given location. Results diff --git a/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml b/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml index 1bb1fd1d..a5e295b8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/runtimeconfig.yaml @@ -11,8 +11,8 @@ info: Watchers and Waiters that will watch for changes to your data and return based on certain conditions. version: v1 - x-discovery-doc-revision: '20240227' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240627' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/deployment-manager/runtime-configurator/ servers: @@ -236,16 +236,13 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 delete: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' @@ -263,11 +260,12 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: /v1/operations: - parameters: &ref_3 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -315,7 +313,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_3 + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -346,7 +344,7 @@ paths: schema: type: string /v1/operations/{operationsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server diff --git a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml index d371791e..dae7c2df 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sasportal.yaml @@ -7,8 +7,8 @@ info: title: SAS Portal API description: '' version: v1alpha1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://developers.google.com/spectrum-access-system/ servers: @@ -35,395 +35,513 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SasPortalFrequencyRange: + SasPortalGetPolicyRequest: + description: Request message for `GetPolicy` method. + id: SasPortalGetPolicyRequest properties: - lowFrequencyMhz: - description: The lowest frequency of the frequency range in MHz. - format: double - type: number - highFrequencyMhz: - description: The highest frequency of the frequency range in MHz. - type: number - format: double + resource: + description: Required. The resource for which the policy is being requested. + type: string type: object - description: Frequency range from `low_frequency` to `high_frequency`. - id: SasPortalFrequencyRange - SasPortalListNodesResponse: - description: Response for ListNodes. + SasPortalGcpProjectDeployment: + description: >- + Deployment associated with the GCP project. Includes whether SAS + analytics has been enabled or not. + id: SasPortalGcpProjectDeployment + properties: + hasEnabledAnalytics: + type: boolean + description: Whether SAS analytics has been enabled. + deployment: + $ref: '#/components/schemas/SasPortalDeployment' + description: Deployment associated with the GCP project. type: object - id: SasPortalListNodesResponse + SasPortalSetupSasAnalyticsMetadata: + description: >- + Metadata returned by the long running operation for the + SetupSasAnalytics rpc. + type: object + properties: {} + id: SasPortalSetupSasAnalyticsMetadata + SasPortalMigrateOrganizationMetadata: + type: object + description: >- + Long-running operation metadata message returned by the + MigrateOrganization. properties: - nextPageToken: - description: >- - A pagination token returned from a previous call to ListNodes that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more nodes. + operationState: + readOnly: true + enum: + - OPERATION_STATE_UNSPECIFIED + - OPERATION_STATE_PENDING + - OPERATION_STATE_RUNNING + - OPERATION_STATE_SUCCEEDED + - OPERATION_STATE_FAILED + enumDescriptions: + - Unspecified. + - Pending (Not started). + - In-progress. + - Done successfully. + - Done with errors. + description: Output only. Current operation state type: string - nodes: - description: The nodes that match the request. - items: - $ref: '#/components/schemas/SasPortalNode' - type: array - SasPortalValidateInstallerRequest: - id: SasPortalValidateInstallerRequest - type: object + id: SasPortalMigrateOrganizationMetadata + SasPortalSetupSasAnalyticsRequest: properties: - installerId: + userId: description: >- - Required. Unique installer id (CPI ID) from the Certified - Professional Installers database. + Optional. User id to setup analytics for, if not provided the user + id associated with the project is used. optional type: string - secret: - description: Required. Secret returned by the GenerateSecret. + type: object + description: Request for the SetupSasAnalytics rpc. + id: SasPortalSetupSasAnalyticsRequest + SasPortalListGcpProjectDeploymentsResponse: + id: SasPortalListGcpProjectDeploymentsResponse + type: object + description: Response for [ListGcpProjectDeployments]. + properties: + deployments: + type: array + description: Optional. Deployments associated with the GCP project + items: + $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + SasPortalDeploymentAssociation: + properties: + userId: type: string - encodedSecret: + description: User id of the deployment. + gcpProjectId: type: string - description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must include a "secret" claim whose value is the secret. - description: Request for ValidateInstaller. - SasPortalCustomer: + description: GCP project id of the associated project. + id: SasPortalDeploymentAssociation type: object + description: Association between a gcp project and a SAS user id. + SasPortalCustomer: properties: + displayName: + type: string + description: >- + Required. Name of the organization that the customer entity + represents. sasUserIds: - type: array - description: User IDs used by the devices belonging to this customer. items: type: string + description: User IDs used by the devices belonging to this customer. + type: array name: type: string description: Output only. Resource name of the customer. - displayName: + type: object + id: SasPortalCustomer + description: Entity representing a SAS customer. + SasPortalChannelWithScore: + id: SasPortalChannelWithScore + type: object + description: The channel with score. + properties: + score: + description: The channel score, normalized to be in the range [0,100]. + type: number + format: double + frequencyRange: + description: The frequency range of the channel. + $ref: '#/components/schemas/SasPortalFrequencyRange' + SasPortalSetupSasAnalyticsResponse: + properties: {} + description: >- + Response returned by the long running operation for the + SetupSasAnalytics rpc. + type: object + id: SasPortalSetupSasAnalyticsResponse + SasPortalProvisionDeploymentRequest: + description: >- + Request for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP + Project, Organization Info, and caller’s GAIA ID should be retrieved + from the RPC handler, and used as inputs to create a new SAS + organization (if not exists) and a new SAS deployment. + type: object + properties: + newDeploymentDisplayName: + type: string description: >- - Required. Name of the organization that the customer entity - represents. + Optional. If this field is set, and a new SAS Portal Deployment + needs to be created, its display name will be set to the value of + this field. + organizationId: type: string - description: Entity representing a SAS customer. - id: SasPortalCustomer - SasPortalMoveDeviceRequest: - id: SasPortalMoveDeviceRequest + description: >- + Optional. If this field is set then a new deployment will be created + under the organization specified by this id. + format: int64 + newOrganizationDisplayName: + type: string + description: >- + Optional. If this field is set, and a new SAS Portal Organization + needs to be created, its display name will be set to the value of + this field. + id: SasPortalProvisionDeploymentRequest + SasPortalDeviceMetadata: + id: SasPortalDeviceMetadata + description: Device data overridable by both SAS Portal and registration requests. properties: - destination: + nrqzValidated: + readOnly: true + deprecated: true + description: >- + Output only. Set to `true` if a CPI has validated that they have + coordinated with the National Quiet Zone office. + type: boolean + commonChannelGroup: + description: >- + Common Channel Group (CCG). A group of CBSDs in the same ICG + requesting a common primary channel assignment. For more details, + see [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). type: string + interferenceCoordinationGroup: description: >- - Required. The name of the new parent resource node or customer to - reparent the device under. + Interference Coordination Group (ICG). A group of CBSDs that manage + their own interference with the group. For more details, see + [CBRSA-TS-2001 + V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). + type: string + nrqzValidation: + readOnly: true + $ref: '#/components/schemas/SasPortalNrqzValidation' + description: Output only. National Radio Quiet Zone validation info. + antennaModel: + description: >- + If populated, the Antenna Model Pattern to use. Format is: + `RecordCreatorId:PatternId` + type: string type: object - description: Request for MoveDevice. - SasPortalProvisionDeploymentResponse: + SasPortalSignDeviceRequest: + description: Request for SignDevice. + id: SasPortalSignDeviceRequest + properties: + device: + $ref: '#/components/schemas/SasPortalDevice' + description: >- + Required. The device to sign. The device fields name, fcc_id and + serial_number must be set. The user_id field must be set. type: object - id: SasPortalProvisionDeploymentResponse + SasPortalStatus: + type: object + id: SasPortalStatus properties: - errorMessage: + code: + type: integer + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. + details: + type: array + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + message: type: string description: >- - Optional. Optional error message if the provisioning request is not - successful. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. description: >- - Response for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. - SasPortalListGcpProjectDeploymentsResponse: - description: Response for [ListGcpProjectDeployments]. - id: SasPortalListGcpProjectDeploymentsResponse + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + SasPortalMoveDeploymentRequest: type: object + id: SasPortalMoveDeploymentRequest + description: Request for MoveDeployment. properties: - deployments: + destination: + type: string + description: >- + Required. The name of the new parent resource node or customer to + reparent the deployment under. + SasPortalDeployment: + properties: + name: + readOnly: true + description: Output only. Resource name. + type: string + sasUserIds: + type: array items: - $ref: '#/components/schemas/SasPortalGcpProjectDeployment' + type: string + description: >- + User ID used by the devices belonging to this deployment. Each + deployment should be associated with one unique user ID. + displayName: + type: string + description: The deployment's display name. + frns: type: array - description: Optional. Deployments associated with the GCP project - SasPortalSetupSasAnalyticsMetadata: - id: SasPortalSetupSasAnalyticsMetadata + items: + type: string + readOnly: true + description: >- + Output only. The FCC Registration Numbers (FRNs) copied from its + direct parent. + description: The Deployment. + type: object + id: SasPortalDeployment + SasPortalEmpty: + type: object properties: {} + id: SasPortalEmpty description: >- - Metadata returned by the long running operation for the - SetupSasAnalytics rpc. + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + SasPortalListNodesResponse: + id: SasPortalListNodesResponse + properties: + nextPageToken: + type: string + description: >- + A pagination token returned from a previous call to ListNodes that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more nodes. + nodes: + items: + $ref: '#/components/schemas/SasPortalNode' + type: array + description: The nodes that match the request. type: object + description: Response for ListNodes. SasPortalListLegacyOrganizationsResponse: - type: object - description: >- - Response for [ListLegacyOrganizations]. - [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. - id: SasPortalListLegacyOrganizationsResponse properties: organizations: - type: array - description: Optional. Legacy SAS organizations. items: $ref: '#/components/schemas/SasPortalOrganization' - SasPortalGcpProjectDeployment: - id: SasPortalGcpProjectDeployment - properties: - hasEnabledAnalytics: - type: boolean - description: Whether SAS analytics has been enabled. - deployment: - description: Deployment associated with the GCP project. - $ref: '#/components/schemas/SasPortalDeployment' + type: array + description: Optional. Legacy SAS organizations. + id: SasPortalListLegacyOrganizationsResponse + type: object description: >- - Deployment associated with the GCP project. Includes whether SAS - analytics has been enabled or not. + Response for [ListLegacyOrganizations]. + [spectrum.sas.portal.v1alpha1.Provisioning.ListLegacyOrganizations]. + SasPortalAssignment: + description: Associates `members` with a `role`. type: object - SasPortalDpaMoveList: - description: An entry in a DPA's move list. - id: SasPortalDpaMoveList properties: - frequencyRange: - description: The frequency range that the move list affects. - $ref: '#/components/schemas/SasPortalFrequencyRange' - dpaId: + role: + description: Required. Role that is assigned to `members`. type: string - description: The ID of the DPA. + members: + items: + type: string + description: >- + The identities the role is assigned to. It can have the following + values: * `{user_email}`: An email address that represents a + specific Google account. For example: `alice@gmail.com`. * + `{group_email}`: An email address that represents a Google group. + For example, `viewers@gmail.com`. + type: array + id: SasPortalAssignment + SasPortalOrganization: + description: Organization details. + id: SasPortalOrganization type: object - SasPortalDeviceModel: - description: Information about the model of the device. properties: - hardwareVersion: - type: string - description: The hardware version of the device. - softwareVersion: - description: The software version of the device. - type: string - vendor: - type: string - description: The name of the device vendor. - firmwareVersion: + displayName: type: string - description: The firmware version of the device. - name: - description: The name of the device model. + description: Name of organization + id: type: string - id: SasPortalDeviceModel + description: Id of organization + format: int64 + SasPortalListDevicesResponse: + id: SasPortalListDevicesResponse type: object + description: Response for ListDevices. + properties: + nextPageToken: + type: string + description: >- + A pagination token returned from a previous call to ListDevices that + indicates from where listing should continue. If the field is + missing or empty, it means there is no more devices. + devices: + items: + $ref: '#/components/schemas/SasPortalDevice' + type: array + description: The devices that match the request. SasPortalListDeploymentsResponse: type: object - id: SasPortalListDeploymentsResponse - description: Response for ListDeployments. properties: deployments: - type: array + description: The deployments that match the request. items: $ref: '#/components/schemas/SasPortalDeployment' - description: The deployments that match the request. + type: array nextPageToken: - type: string description: >- A pagination token returned from a previous call to ListDeployments that indicates from where listing should continue. If the field is missing or empty, it means there are no more deployments. - SasPortalNrqzValidation: - properties: - caseId: - description: Validation case ID. - type: string - longitude: - description: Device longitude that's associated with the validation. - type: number - format: double - latitude: - format: double - description: Device latitude that's associated with the validation. - type: number - state: - enum: - - STATE_UNSPECIFIED - - DRAFT - - FINAL - description: State of the NRQZ validation info. - type: string - enumDescriptions: - - Unspecified state. - - Draft state. - - Final state. - cpiId: type: string - description: CPI who signed the validation. - type: object - description: Information about National Radio Quiet Zone validation. - id: SasPortalNrqzValidation - SasPortalDeviceMetadata: - description: Device data overridable by both SAS Portal and registration requests. + description: Response for ListDeployments. + id: SasPortalListDeploymentsResponse + SasPortalSetPolicyRequest: type: object + description: Request message for `SetPolicy` method. properties: - commonChannelGroup: - description: >- - Common Channel Group (CCG). A group of CBSDs in the same ICG - requesting a common primary channel assignment. For more details, - see [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - type: string - nrqzValidation: - description: Output only. National Radio Quiet Zone validation info. - $ref: '#/components/schemas/SasPortalNrqzValidation' - readOnly: true - antennaModel: + resource: description: >- - If populated, the Antenna Model Pattern to use. Format is: - `RecordCreatorId:PatternId` + Required. The resource for which the policy is being specified. This + policy replaces any existing policy. type: string - nrqzValidated: - description: >- - Output only. Set to `true` if a CPI has validated that they have - coordinated with the National Quiet Zone office. + policy: + description: Required. The policy to be applied to the `resource`. + $ref: '#/components/schemas/SasPortalPolicy' + disableNotification: type: boolean - readOnly: true - deprecated: true - interferenceCoordinationGroup: - type: string description: >- - Interference Coordination Group (ICG). A group of CBSDs that manage - their own interference with the group. For more details, see - [CBRSA-TS-2001 - V3.0.0](https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf). - id: SasPortalDeviceMetadata - SasPortalDeviceAirInterface: - description: Information about the device's air interface. + Optional. Set the field as `true` to disable the onboarding + notification. + id: SasPortalSetPolicyRequest + SasPortalUpdateSignedDeviceRequest: + description: Request for UpdateSignedDevice. + id: SasPortalUpdateSignedDeviceRequest properties: - supportedSpec: + encodedDevice: description: >- - Optional. This field is related to the `radioTechnology` and - provides the air interface specification that the CBSD is compliant - with at the time of registration. + Required. The JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. type: string - radioTechnology: + format: byte + installerId: description: >- - Conditional. This field specifies the radio access technology that - is used for the CBSD. - enumDescriptions: - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - - '' - enum: - - RADIO_TECHNOLOGY_UNSPECIFIED - - E_UTRA - - CAMBIUM_NETWORKS - - FOUR_G_BBW_SAA_1 - - NR - - DOODLE_CBRS - - CW - - REDLINE - - TARANA_WIRELESS + Required. Unique installer ID (CPI ID) from the Certified + Professional Installers database. type: string - id: SasPortalDeviceAirInterface type: object - SasPortalSetPolicyRequest: - description: Request message for `SetPolicy` method. + SasPortalMigrateOrganizationResponse: type: object - id: SasPortalSetPolicyRequest properties: - policy: - $ref: '#/components/schemas/SasPortalPolicy' - description: Required. The policy to be applied to the `resource`. - resource: - type: string - description: >- - Required. The resource for which the policy is being specified. This - policy replaces any existing policy. - disableNotification: + deploymentAssociation: description: >- - Optional. Set the field as `true` to disable the onboarding - notification. - type: boolean - SasPortalProvisionDeploymentRequest: - type: object - id: SasPortalProvisionDeploymentRequest + Optional. A list of deployment association that were created for the + migration, or current associations if they already exist. + items: + $ref: '#/components/schemas/SasPortalDeploymentAssociation' + type: array + id: SasPortalMigrateOrganizationResponse + description: >- + Response for [MigrateOrganization]. + [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + SasPortalDeviceGrant: properties: - newDeploymentDisplayName: + channelType: + description: Type of channel used. + enum: + - CHANNEL_TYPE_UNSPECIFIED + - CHANNEL_TYPE_GAA + - CHANNEL_TYPE_PAL type: string - description: >- - Optional. If this field is set, and a new SAS Portal Deployment - needs to be created, its display name will be set to the value of - this field. - newOrganizationDisplayName: - description: >- - Optional. If this field is set, and a new SAS Portal Organization - needs to be created, its display name will be set to the value of - this field. + enumDescriptions: + - '' + - '' + - '' + expireTime: + type: string + description: The expiration time of the grant. + format: google-datetime + frequencyRange: + description: The transmission frequency range. + $ref: '#/components/schemas/SasPortalFrequencyRange' + state: + enum: + - GRANT_STATE_UNSPECIFIED + - GRANT_STATE_GRANTED + - GRANT_STATE_TERMINATED + - GRANT_STATE_SUSPENDED + - GRANT_STATE_AUTHORIZED + - GRANT_STATE_EXPIRED + description: State of the grant. + enumDescriptions: + - '' + - >- + The grant has been granted but the device is not heartbeating on + it. + - The grant has been terminated by the SAS. + - The grant has been suspended by the SAS. + - The device is currently transmitting. + - The grant has expired. type: string - organizationId: - format: int64 + moveList: + type: array + items: + $ref: '#/components/schemas/SasPortalDpaMoveList' + description: The DPA move lists on which this grant appears. + lastHeartbeatTransmitExpireTime: + format: google-datetime type: string + description: The transmit expiration time of the last heartbeat. + maxEirp: description: >- - Optional. If this field is set then a new deployment will be created - under the organization specified by this id. - description: >- - Request for [ProvisionDeployment]. - [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. GCP - Project, Organization Info, and caller’s GAIA ID should be retrieved - from the RPC handler, and used as inputs to create a new SAS - organization (if not exists) and a new SAS deployment. - SasPortalGenerateSecretResponse: - id: SasPortalGenerateSecretResponse - properties: - secret: + Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by + the grant. The maximum EIRP is in units of dBm/MHz. The value of + `maxEirp` represents the average (RMS) EIRP that would be measured + by the procedure defined in FCC part 96.41(e)(3). + format: double + type: number + grantId: type: string - description: The secret generated by the string and used by ValidateInstaller. - type: object - description: Response for GenerateSecret. - SasPortalMoveNodeRequest: + description: Grant Id. + suspensionReason: + items: + type: string + description: If the grant is suspended, the reason(s) for suspension. + type: array type: object - description: Request for MoveNode. - id: SasPortalMoveNodeRequest - properties: - destination: - type: string - description: >- - Required. The name of the new parent resource node or customer to - reparent the node under. - SasPortalMigrateOrganizationMetadata: description: >- - Long-running operation metadata message returned by the - MigrateOrganization. - type: object - id: SasPortalMigrateOrganizationMetadata - properties: - operationState: - description: Output only. Current operation state - enum: - - OPERATION_STATE_UNSPECIFIED - - OPERATION_STATE_PENDING - - OPERATION_STATE_RUNNING - - OPERATION_STATE_SUCCEEDED - - OPERATION_STATE_FAILED - enumDescriptions: - - Unspecified. - - Pending (Not started). - - In-progress. - - Done successfully. - - Done with errors. - readOnly: true - type: string + Device grant. It is an authorization provided by the Spectrum Access + System to a device to transmit using specified operating parameters + after a successful heartbeat by the device. + id: SasPortalDeviceGrant SasPortalInstallationParams: - id: SasPortalInstallationParams - description: Information about the device installation parameters. properties: + antennaDowntilt: + format: int32 + type: integer + description: >- + Antenna downtilt in degrees and is an integer with a value between + -90 and +90 inclusive; a negative value means the antenna is tilted + up (above horizontal). This parameter is optional for Category A + devices and conditional for Category B devices. + verticalAccuracy: + format: double + description: >- + A positive number in meters to indicate accuracy of the device + antenna vertical location. This optional parameter should only be + present if its value is less than the FCC requirement of 3 meters. + type: number heightType: - enumDescriptions: - - Unspecified height type. - - AGL height is measured relative to the ground level. - - AMSL height is measured relative to the mean sea level. enum: - HEIGHT_TYPE_UNSPECIFIED - HEIGHT_TYPE_AGL - HEIGHT_TYPE_AMSL - type: string description: Specifies how the height is measured. - antennaAzimuth: - description: >- - Boresight direction of the horizontal plane of the antenna in - degrees with respect to true north. The value of this parameter is - an integer with a value between 0 and 359 inclusive. A value of 0 - degrees means true north; a value of 90 degrees means east. This - parameter is optional for Category A devices and conditional for - Category B devices. - format: int32 - type: integer + type: string + enumDescriptions: + - Unspecified height type. + - AGL height is measured relative to the ground level. + - AMSL height is measured relative to the mean sea level. antennaGain: description: >- Peak antenna gain in dBi. This parameter is a double with a value @@ -431,496 +549,381 @@ components: floating-point value format: double type: number - latitude: - type: number + antennaModel: + type: string + description: >- + If an external antenna is used, the antenna model is optionally + provided in this field. The string has a maximum length of 128 + octets. + longitude: format: double + type: number description: >- - Latitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -90.000000 to +90.000000. - Positive values represent latitudes north of the equator; negative - values south of the equator. - cpeCbsdIndication: + Longitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -180.000000 to +180.000000. + Positive values represent longitudes east of the prime meridian; + negative values west of the prime meridian. + indoorDeployment: description: >- - If present, this parameter specifies whether the CBSD is a CPE-CBSD - or not. + Whether the device antenna is indoor or not. `true`: indoor. + `false`: outdoor. type: boolean - height: - description: >- - Device antenna height in meters. When the `heightType` parameter - value is "AGL", the antenna height should be given relative to - ground level. When the `heightType` parameter value is "AMSL", it is - given with respect to WGS84 datum. - type: number - format: double eirpCapability: - type: integer format: int32 + type: integer description: >- This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. - longitude: - description: >- - Longitude of the device antenna location in degrees relative to the - WGS 84 datum. The allowed range is from -180.000000 to +180.000000. - Positive values represent longitudes east of the prime meridian; - negative values west of the prime meridian. - format: double + height: type: number - antennaBeamwidth: - format: int32 - description: >- - 3-dB antenna beamwidth of the antenna in the horizontal-plane in - degrees. This parameter is an unsigned integer having a value - between 0 and 360 (degrees) inclusive; it is optional for Category A - devices and conditional for Category B devices. - type: integer - verticalAccuracy: - description: >- - A positive number in meters to indicate accuracy of the device - antenna vertical location. This optional parameter should only be - present if its value is less than the FCC requirement of 3 meters. format: double - type: number + description: >- + Device antenna height in meters. When the `heightType` parameter + value is "AGL", the antenna height should be given relative to + ground level. When the `heightType` parameter value is "AMSL", it is + given with respect to WGS84 datum. horizontalAccuracy: - format: double type: number description: >- A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. - indoorDeployment: - type: boolean - description: >- - Whether the device antenna is indoor or not. `true`: indoor. - `false`: outdoor. - antennaDowntilt: + format: double + antennaAzimuth: description: >- - Antenna downtilt in degrees and is an integer with a value between - -90 and +90 inclusive; a negative value means the antenna is tilted - up (above horizontal). This parameter is optional for Category A - devices and conditional for Category B devices. - format: int32 + Boresight direction of the horizontal plane of the antenna in + degrees with respect to true north. The value of this parameter is + an integer with a value between 0 and 359 inclusive. A value of 0 + degrees means true north; a value of 90 degrees means east. This + parameter is optional for Category A devices and conditional for + Category B devices. type: integer - antennaModel: - description: >- - If an external antenna is used, the antenna model is optionally - provided in this field. The string has a maximum length of 128 - octets. - type: string - type: object - SasPortalValidateInstallerResponse: - id: SasPortalValidateInstallerResponse - description: Response for ValidateInstaller. - properties: {} - type: object - SasPortalAssignment: - type: object - description: Associates `members` with a `role`. - id: SasPortalAssignment - properties: - role: - type: string - description: Required. Role that is assigned to `members`. - members: - items: - type: string - description: >- - The identities the role is assigned to. It can have the following - values: * `{user_email}`: An email address that represents a - specific Google account. For example: `alice@gmail.com`. * - `{group_email}`: An email address that represents a Google group. - For example, `viewers@gmail.com`. - type: array - SasPortalGetPolicyRequest: - properties: - resource: - type: string - description: Required. The resource for which the policy is being requested. - type: object - description: Request message for `GetPolicy` method. - id: SasPortalGetPolicyRequest - SasPortalNode: - type: object - description: The Node. - properties: - name: - type: string - description: Output only. Resource name. - sasUserIds: - type: array - items: - type: string - description: User ids used by the devices belonging to this node. - displayName: - description: The node's display name. - type: string - id: SasPortalNode - SasPortalTestPermissionsResponse: - description: Response message for `TestPermissions` method. - id: SasPortalTestPermissionsResponse + format: int32 + antennaBeamwidth: + description: >- + 3-dB antenna beamwidth of the antenna in the horizontal-plane in + degrees. This parameter is an unsigned integer having a value + between 0 and 360 (degrees) inclusive; it is optional for Category A + devices and conditional for Category B devices. + type: integer + format: int32 + cpeCbsdIndication: + type: boolean + description: >- + If present, this parameter specifies whether the CBSD is a CPE-CBSD + or not. + latitude: + description: >- + Latitude of the device antenna location in degrees relative to the + WGS 84 datum. The allowed range is from -90.000000 to +90.000000. + Positive values represent latitudes north of the equator; negative + values south of the equator. + type: number + format: double + description: Information about the device installation parameters. + id: SasPortalInstallationParams type: object - properties: - permissions: - description: A set of permissions that the caller is allowed. - items: - type: string - type: array - SasPortalDeviceGrant: + SasPortalDeviceAirInterface: + id: SasPortalDeviceAirInterface type: object properties: - maxEirp: - format: double - type: number - description: >- - Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by - the grant. The maximum EIRP is in units of dBm/MHz. The value of - `maxEirp` represents the average (RMS) EIRP that would be measured - by the procedure defined in FCC part 96.41(e)(3). - channelType: - description: Type of channel used. + radioTechnology: enum: - - CHANNEL_TYPE_UNSPECIFIED - - CHANNEL_TYPE_GAA - - CHANNEL_TYPE_PAL - type: string + - RADIO_TECHNOLOGY_UNSPECIFIED + - E_UTRA + - CAMBIUM_NETWORKS + - FOUR_G_BBW_SAA_1 + - NR + - DOODLE_CBRS + - CW + - REDLINE + - TARANA_WIRELESS + - FAROS enumDescriptions: - '' - '' - '' - grantId: + - '' + - '' + - '' + - '' + - '' + - '' + - '' + description: >- + Conditional. This field specifies the radio access technology that + is used for the CBSD. type: string - description: Grant Id. - frequencyRange: - description: The transmission frequency range. - $ref: '#/components/schemas/SasPortalFrequencyRange' - moveList: - type: array - items: - $ref: '#/components/schemas/SasPortalDpaMoveList' - description: The DPA move lists on which this grant appears. - expireTime: - description: The expiration time of the grant. - format: google-datetime + supportedSpec: type: string - suspensionReason: - description: If the grant is suspended, the reason(s) for suspension. - items: - type: string - type: array - lastHeartbeatTransmitExpireTime: - format: google-datetime - description: The transmit expiration time of the last heartbeat. + description: >- + Optional. This field is related to the `radioTechnology` and + provides the air interface specification that the CBSD is compliant + with at the time of registration. + description: Information about the device's air interface. + SasPortalValidateInstallerResponse: + properties: {} + id: SasPortalValidateInstallerResponse + type: object + description: Response for ValidateInstaller. + SasPortalDeviceModel: + id: SasPortalDeviceModel + description: Information about the model of the device. + type: object + properties: + hardwareVersion: type: string - state: - enum: - - GRANT_STATE_UNSPECIFIED - - GRANT_STATE_GRANTED - - GRANT_STATE_TERMINATED - - GRANT_STATE_SUSPENDED - - GRANT_STATE_AUTHORIZED - - GRANT_STATE_EXPIRED - enumDescriptions: - - '' - - >- - The grant has been granted but the device is not heartbeating on - it. - - The grant has been terminated by the SAS. - - The grant has been suspended by the SAS. - - The device is currently transmitting. - - The grant has expired. + description: The hardware version of the device. + vendor: type: string - description: State of the grant. - description: >- - Device grant. It is an authorization provided by the Spectrum Access - System to a device to transmit using specified operating parameters - after a successful heartbeat by the device. - id: SasPortalDeviceGrant - SasPortalDeployment: - id: SasPortalDeployment - description: The Deployment. - properties: - displayName: + description: The name of the device vendor. + firmwareVersion: type: string - description: The deployment's display name. - frns: - description: >- - Output only. The FCC Registration Numbers (FRNs) copied from its - direct parent. - type: array - items: - type: string - readOnly: true + description: The firmware version of the device. name: + description: The name of the device model. type: string - readOnly: true - description: Output only. Resource name. - sasUserIds: - description: >- - User ID used by the devices belonging to this deployment. Each - deployment should be associated with one unique user ID. - type: array - items: - type: string - type: object - SasPortalTestPermissionsRequest: - properties: - resource: + softwareVersion: + description: The software version of the device. type: string + SasPortalMoveNodeRequest: + properties: + destination: description: >- - Required. The resource for which the permissions are being - requested. - permissions: - description: The set of permissions to check for the `resource`. - type: array - items: - type: string - id: SasPortalTestPermissionsRequest + Required. The name of the new parent resource node or customer to + reparent the node under. + type: string type: object - description: Request message for `TestPermissions` method. + description: Request for MoveNode. + id: SasPortalMoveNodeRequest SasPortalDeviceConfig: - type: object description: Information about the device configuration. - id: SasPortalDeviceConfig + type: object properties: installationParams: $ref: '#/components/schemas/SasPortalInstallationParams' description: Installation parameters for the device. + userId: + type: string + description: The identifier of a device user. + airInterface: + description: Information about this device's air interface. + $ref: '#/components/schemas/SasPortalDeviceAirInterface' + category: + type: string + description: FCC category of the device. + enumDescriptions: + - Unspecified device category. + - Category A. + - Category B. + enum: + - DEVICE_CATEGORY_UNSPECIFIED + - DEVICE_CATEGORY_A + - DEVICE_CATEGORY_B measurementCapabilities: - description: Measurement reporting capabilities of the device. - type: array items: + type: string enum: - MEASUREMENT_CAPABILITY_UNSPECIFIED - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT - MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT - type: string enumDescriptions: - '' - '' - '' - callSign: + type: array + description: Measurement reporting capabilities of the device. + isSigned: + type: boolean + description: Output only. Whether the configuration has been signed by a CPI. + state: + enum: + - DEVICE_CONFIG_STATE_UNSPECIFIED + - DRAFT + - FINAL + enumDescriptions: + - '' + - '' + - '' type: string + description: State of the configuration. + callSign: description: The call sign of the device operator. - userId: type: string - description: The identifier of a device user. + model: + description: Information about this device model. + $ref: '#/components/schemas/SasPortalDeviceModel' updateTime: + type: string description: Output only. The last time the device configuration was edited. format: google-datetime + id: SasPortalDeviceConfig + SasPortalMoveDeviceRequest: + properties: + destination: + description: >- + Required. The name of the new parent resource node or customer to + reparent the device under. type: string - category: - enum: - - DEVICE_CATEGORY_UNSPECIFIED - - DEVICE_CATEGORY_A - - DEVICE_CATEGORY_B - description: FCC category of the device. - enumDescriptions: - - Unspecified device category. - - Category A. - - Category B. + type: object + description: Request for MoveDevice. + id: SasPortalMoveDeviceRequest + SasPortalNode: + properties: + sasUserIds: + description: User ids used by the devices belonging to this node. + items: + type: string + type: array + name: + type: string + description: Output only. Resource name. + displayName: + description: The node's display name. type: string - isSigned: - type: boolean - description: Output only. Whether the configuration has been signed by a CPI. - state: - enumDescriptions: - - '' - - '' - - '' - enum: - - DEVICE_CONFIG_STATE_UNSPECIFIED - - DRAFT - - FINAL - description: State of the configuration. + description: The Node. + type: object + id: SasPortalNode + SasPortalGenerateSecretRequest: + type: object + id: SasPortalGenerateSecretRequest + description: Request for GenerateSecret. + properties: {} + SasPortalGenerateSecretResponse: + properties: + secret: + description: The secret generated by the string and used by ValidateInstaller. type: string - airInterface: - description: Information about this device's air interface. - $ref: '#/components/schemas/SasPortalDeviceAirInterface' - model: - description: Information about this device model. - $ref: '#/components/schemas/SasPortalDeviceModel' + id: SasPortalGenerateSecretResponse + type: object + description: Response for GenerateSecret. SasPortalCreateSignedDeviceRequest: id: SasPortalCreateSignedDeviceRequest - type: object - description: Request for CreateSignedDevice. properties: - encodedDevice: - format: byte - description: >- - Required. JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. - type: string installerId: type: string description: >- Required. Unique installer id (CPI ID) from the Certified Professional Installers database. - SasPortalSignDeviceRequest: - properties: - device: + encodedDevice: description: >- - Required. The device to sign. The device fields name, fcc_id and - serial_number must be set. The user_id field must be set. - $ref: '#/components/schemas/SasPortalDevice' - type: object - id: SasPortalSignDeviceRequest - description: Request for SignDevice. - SasPortalPolicy: + Required. JSON Web Token signed using a CPI private key. Payload + must be the JSON encoding of the device. The user_id field must be + set. + format: byte + type: string type: object + description: Request for CreateSignedDevice. + SasPortalDevice: properties: - assignments: + displayName: + description: Device display name. + type: string + preloadedConfig: + description: Configuration of the device, as specified via SAS Portal API. + $ref: '#/components/schemas/SasPortalDeviceConfig' + serialNumber: + description: A serial number assigned to the device by the device manufacturer. + type: string + activeConfig: + description: >- + Output only. Current configuration of the device as registered to + the SAS. + $ref: '#/components/schemas/SasPortalDeviceConfig' + grants: + type: array + description: Output only. Grants held by the device. items: - $ref: '#/components/schemas/SasPortalAssignment' + $ref: '#/components/schemas/SasPortalDeviceGrant' + grantRangeAllowlists: + items: + $ref: '#/components/schemas/SasPortalFrequencyRange' type: array - description: List of assignments - etag: + description: >- + Only ranges that are within the allowlists are available for new + grants. + deviceMetadata: + $ref: '#/components/schemas/SasPortalDeviceMetadata' + description: >- + Device parameters that can be overridden by both SAS Portal and SAS + registration requests. + currentChannels: + readOnly: true + type: array + description: Output only. Current channels with scores. + items: + $ref: '#/components/schemas/SasPortalChannelWithScore' + deprecated: true + fccId: type: string description: >- - The etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the etag in - the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An etag is returned in the response to - GetPolicy, and systems are expected to put that etag in the request - to SetPolicy to ensure that their change will be applied to the same - version of the policy. If no etag is provided in the call to - GetPolicy, then the existing policy is overwritten blindly. - format: byte - description: Defines an access control policy to the resources. - id: SasPortalPolicy - SasPortalSetupSasAnalyticsRequest: - description: Request for the SetupSasAnalytics rpc. - id: SasPortalSetupSasAnalyticsRequest + The FCC identifier of the device. Refer to + https://www.fcc.gov/oet/ea/fccid for FccID format. Accept + underscores and periods because some test-SAS customers use them. + state: + type: string + description: Output only. Device state. + enumDescriptions: + - Unspecified state. + - >- + Device created in the SAS Portal, however, not yet registered with + SAS. + - Device registered with SAS. + - Device de-registered with SAS. + enum: + - DEVICE_STATE_UNSPECIFIED + - RESERVED + - REGISTERED + - DEREGISTERED + name: + description: Output only. The resource path name. + type: string type: object + id: SasPortalDevice + SasPortalTestPermissionsResponse: properties: - userId: - type: string - description: >- - Optional. User id to setup analytics for, if not provided the user - id associated with the project is used. optional + permissions: + description: A set of permissions that the caller is allowed. + items: + type: string + type: array + id: SasPortalTestPermissionsResponse + type: object + description: Response message for `TestPermissions` method. SasPortalMigrateOrganizationRequest: - id: SasPortalMigrateOrganizationRequest properties: organizationId: format: int64 - type: string description: Required. Id of the SAS organization to be migrated. - type: object + type: string description: >- Request for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP Project, Organization Info, and caller's GAIA ID should be retrieved from the RPC handler, and used to check authorization on SAS Portal organization and to create GCP Projects. - SasPortalEmpty: - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - type: object - id: SasPortalEmpty - SasPortalSetupSasAnalyticsResponse: - id: SasPortalSetupSasAnalyticsResponse - properties: {} - type: object - description: >- - Response returned by the long running operation for the - SetupSasAnalytics rpc. - SasPortalGenerateSecretRequest: - type: object - description: Request for GenerateSecret. - properties: {} - id: SasPortalGenerateSecretRequest - SasPortalStatus: - type: object - properties: - details: - items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - type: array - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - id: SasPortalStatus - SasPortalListCustomersResponse: - type: object - properties: - customers: - description: The list of customers that match the request. - type: array - items: - $ref: '#/components/schemas/SasPortalCustomer' - nextPageToken: - type: string - description: >- - A pagination token returned from a previous call to ListCustomers - that indicates from where listing should continue. If the field is - missing or empty, it means there are no more customers. - id: SasPortalListCustomersResponse - description: Response for `ListCustomers`. - SasPortalMoveDeploymentRequest: - type: object - id: SasPortalMoveDeploymentRequest - description: Request for MoveDeployment. - properties: - destination: - type: string - description: >- - Required. The name of the new parent resource node or customer to - reparent the deployment under. - SasPortalChannelWithScore: - description: The channel with score. type: object - id: SasPortalChannelWithScore - properties: - score: - format: double - type: number - description: The channel score, normalized to be in the range [0,100]. - frequencyRange: - $ref: '#/components/schemas/SasPortalFrequencyRange' - description: The frequency range of the channel. + id: SasPortalMigrateOrganizationRequest SasPortalOperation: - type: object + id: SasPortalOperation description: >- This resource represents a long-running operation that is the result of a network API call. - id: SasPortalOperation properties: + error: + $ref: '#/components/schemas/SasPortalStatus' + description: >- + The error result of the operation in case of failure or + cancellation. done: - type: boolean description: >- If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + type: boolean response: - type: object additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any @@ -933,165 +936,164 @@ components: where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - metadata: type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. name: - type: string description: >- The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - error: - $ref: '#/components/schemas/SasPortalStatus' + type: string + metadata: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - The error result of the operation in case of failure or - cancellation. - SasPortalDeploymentAssociation: - id: SasPortalDeploymentAssociation - description: Association between a gcp project and a SAS user id. + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + type: object + type: object + SasPortalNrqzValidation: properties: - userId: - description: User id of the deployment. + longitude: + format: double + type: number + description: Device longitude that's associated with the validation. + state: + description: State of the NRQZ validation info. + enum: + - STATE_UNSPECIFIED + - DRAFT + - FINAL + enumDescriptions: + - Unspecified state. + - Draft state. + - Final state. type: string - gcpProjectId: + cpiId: type: string - description: GCP project id of the associated project. + description: CPI who signed the validation. + caseId: + description: Validation case ID. + type: string + latitude: + format: double + description: Device latitude that's associated with the validation. + type: number + id: SasPortalNrqzValidation type: object - SasPortalOrganization: + description: Information about National Radio Quiet Zone validation. + SasPortalProvisionDeploymentResponse: + description: >- + Response for [ProvisionDeployment]. + [spectrum.sas.portal.v1alpha1.Provisioning.ProvisionDeployment]. properties: - id: - format: int64 - description: Id of organization + errorMessage: type: string - displayName: - description: Name of organization + description: >- + Optional. Optional error message if the provisioning request is not + successful. + type: object + id: SasPortalProvisionDeploymentResponse + SasPortalDpaMoveList: + id: SasPortalDpaMoveList + type: object + properties: + dpaId: type: string - description: Organization details. + description: The ID of the DPA. + frequencyRange: + description: The frequency range that the move list affects. + $ref: '#/components/schemas/SasPortalFrequencyRange' + description: An entry in a DPA's move list. + SasPortalValidateInstallerRequest: type: object - id: SasPortalOrganization - SasPortalUpdateSignedDeviceRequest: properties: - encodedDevice: - format: byte - description: >- - Required. The JSON Web Token signed using a CPI private key. Payload - must be the JSON encoding of the device. The user_id field must be - set. + secret: type: string + description: Required. Secret returned by the GenerateSecret. installerId: description: >- - Required. Unique installer ID (CPI ID) from the Certified + Required. Unique installer id (CPI ID) from the Certified Professional Installers database. type: string - description: Request for UpdateSignedDevice. - id: SasPortalUpdateSignedDeviceRequest - type: object - SasPortalListDevicesResponse: - properties: - devices: - type: array - items: - $ref: '#/components/schemas/SasPortalDevice' - description: The devices that match the request. - nextPageToken: + encodedSecret: description: >- - A pagination token returned from a previous call to ListDevices that - indicates from where listing should continue. If the field is - missing or empty, it means there is no more devices. + Required. JSON Web Token signed using a CPI private key. Payload + must include a "secret" claim whose value is the secret. type: string + description: Request for ValidateInstaller. + id: SasPortalValidateInstallerRequest + SasPortalFrequencyRange: type: object - id: SasPortalListDevicesResponse - description: Response for ListDevices. - SasPortalDevice: properties: - serialNumber: - type: string - description: A serial number assigned to the device by the device manufacturer. - deviceMetadata: - $ref: '#/components/schemas/SasPortalDeviceMetadata' - description: >- - Device parameters that can be overridden by both SAS Portal and SAS - registration requests. - name: - description: Output only. The resource path name. + lowFrequencyMhz: + format: double + type: number + description: The lowest frequency of the frequency range in MHz. + highFrequencyMhz: + type: number + description: The highest frequency of the frequency range in MHz. + format: double + description: Frequency range from `low_frequency` to `high_frequency`. + id: SasPortalFrequencyRange + SasPortalTestPermissionsRequest: + id: SasPortalTestPermissionsRequest + description: Request message for `TestPermissions` method. + type: object + properties: + permissions: + items: + type: string + type: array + description: The set of permissions to check for the `resource`. + resource: type: string - activeConfig: description: >- - Output only. Current configuration of the device as registered to - the SAS. - $ref: '#/components/schemas/SasPortalDeviceConfig' - preloadedConfig: - description: Configuration of the device, as specified via SAS Portal API. - $ref: '#/components/schemas/SasPortalDeviceConfig' - displayName: - description: Device display name. - type: string - currentChannels: - readOnly: true + Required. The resource for which the permissions are being + requested. + SasPortalPolicy: + description: Defines an access control policy to the resources. + type: object + properties: + assignments: + description: List of assignments items: - $ref: '#/components/schemas/SasPortalChannelWithScore' - description: Output only. Current channels with scores. - deprecated: true + $ref: '#/components/schemas/SasPortalAssignment' type: array - grantRangeAllowlists: + etag: description: >- - Only ranges that are within the allowlists are available for new - grants. - type: array - items: - $ref: '#/components/schemas/SasPortalFrequencyRange' - fccId: + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates of a policy from overwriting each + other. It is strongly suggested that systems make use of the etag in + the read-modify-write cycle to perform policy updates in order to + avoid race conditions: An etag is returned in the response to + GetPolicy, and systems are expected to put that etag in the request + to SetPolicy to ensure that their change will be applied to the same + version of the policy. If no etag is provided in the call to + GetPolicy, then the existing policy is overwritten blindly. + format: byte type: string - description: >- - The FCC identifier of the device. Refer to - https://www.fcc.gov/oet/ea/fccid for FccID format. Accept - underscores and periods because some test-SAS customers use them. - state: + id: SasPortalPolicy + SasPortalListCustomersResponse: + id: SasPortalListCustomersResponse + properties: + nextPageToken: type: string - enumDescriptions: - - Unspecified state. - - >- - Device created in the SAS Portal, however, not yet registered with - SAS. - - Device registered with SAS. - - Device de-registered with SAS. - description: Output only. Device state. - enum: - - DEVICE_STATE_UNSPECIFIED - - RESERVED - - REGISTERED - - DEREGISTERED - grants: - description: Output only. Grants held by the device. - type: array + description: >- + A pagination token returned from a previous call to ListCustomers + that indicates from where listing should continue. If the field is + missing or empty, it means there are no more customers. + customers: + description: The list of customers that match the request. items: - $ref: '#/components/schemas/SasPortalDeviceGrant' - type: object - id: SasPortalDevice - SasPortalMigrateOrganizationResponse: - type: object - id: SasPortalMigrateOrganizationResponse - properties: - deploymentAssociation: + $ref: '#/components/schemas/SasPortalCustomer' type: array - items: - $ref: '#/components/schemas/SasPortalDeploymentAssociation' - description: >- - Optional. A list of deployment association that were created for the - migration, or current associations if they already exist. - description: >- - Response for [MigrateOrganization]. - [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. + type: object + description: Response for `ListCustomers`. parameters: upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). @@ -1099,12 +1101,31 @@ components: name: upload_protocol schema: type: string + alt: + description: Data format for response. + in: query + name: alt + schema: + type: string + enum: + - json + - media + - proto access_token: description: OAuth access token. in: query name: access_token schema: type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string uploadType: description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query @@ -1117,29 +1138,16 @@ components: name: callback schema: type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto fields: description: Selector specifying which fields to include in a partial response. in: query name: fields schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: quotaUser + name: oauth_token schema: type: string _.xgafv: @@ -1157,12 +1165,6 @@ components: name: prettyPrint schema: type: boolean - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -1173,34 +1175,6 @@ components: schema: type: string x-stackQL-resources: - policies: - id: google.sasportal.policies - name: policies - title: Policies - methods: - policies_get: - operation: - $ref: '#/paths/~1v1alpha1~1policies:get/post' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_test: - operation: - $ref: '#/paths/~1v1alpha1~1policies:test/post' - response: - mediaType: application/json - openAPIDocKey: '200' - policies_set: - operation: - $ref: '#/paths/~1v1alpha1~1policies:set/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] devices: id: google.sasportal.devices name: devices @@ -1213,6 +1187,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + deployments_devices_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' deployments_devices_delete: operation: $ref: >- @@ -1220,10 +1201,10 @@ components: response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_patch: + deployments_devices_sign_device: operation: $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}/patch + #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' @@ -1234,16 +1215,23 @@ components: response: mediaType: application/json openAPIDocKey: '200' - deployments_devices_sign_device: + nodes_devices_list: operation: - $ref: >- - #/paths/~1v1alpha1~1deployments~1{deploymentsId}~1devices~1{devicesId}:signDevice/post + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_patch: + objectKey: $.devices + nodes_devices_create: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + response: + mediaType: application/json + openAPIDocKey: '200' + nodes_devices_move: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post response: mediaType: application/json openAPIDocKey: '200' @@ -1259,19 +1247,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _nodes_devices_list: - operation: &ref_1 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - nodes_devices_list: - operation: *ref_1 - response: *ref_2 - nodes_devices_create: + nodes_devices_patch: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices/post' + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}/patch' response: mediaType: application/json openAPIDocKey: '200' @@ -1282,31 +1260,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_move: + nodes_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_devices_list: - operation: &ref_3 - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices nodes_nodes_devices_list: - operation: *ref_3 - response: *ref_4 - nodes_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1devices/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.devices nodes_deployments_devices_create: operation: $ref: >- @@ -1314,50 +1282,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _nodes_deployments_devices_list: - operation: &ref_5 - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get - response: &ref_6 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices nodes_deployments_devices_list: - operation: *ref_5 - response: *ref_6 - customers_nodes_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_devices_list: - operation: &ref_7 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get - response: &ref_8 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.devices - customers_nodes_devices_list: - operation: *ref_7 - response: *ref_8 - _customers_deployments_devices_list: - operation: &ref_9 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get - response: &ref_10 - mediaType: application/json - openAPIDocKey: '200' objectKey: $.devices - customers_deployments_devices_list: - operation: *ref_9 - response: *ref_10 - customers_deployments_devices_create: + customers_devices_patch: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1375,26 +1311,23 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_devices_patch: + customers_devices_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}/patch + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' response: mediaType: application/json openAPIDocKey: '200' - _customers_devices_list: - operation: &ref_11 + customers_devices_list: + operation: $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.devices - customers_devices_list: - operation: *ref_11 - response: *ref_12 - customers_devices_create: + customers_devices_sign_device: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1devices/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post response: mediaType: application/json openAPIDocKey: '200' @@ -1405,13 +1338,36 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_devices_sign_device: + customers_deployments_devices_create: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:signDevice/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/post + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_devices_list: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.devices + customers_nodes_devices_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/post + response: + mediaType: application/json + openAPIDocKey: '200' + customers_nodes_devices_list: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.devices sqlVerbs: select: - $ref: >- @@ -1422,11 +1378,11 @@ components: - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list + #/components/x-stackQL-resources/devices/methods/customers_devices_get - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_list - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_devices_get + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_list - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_list - $ref: >- @@ -1436,10 +1392,10 @@ components: #/components/x-stackQL-resources/devices/methods/nodes_nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_deployments_devices_create - - $ref: >- - #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_deployments_devices_create + - $ref: >- + #/components/x-stackQL-resources/devices/methods/customers_nodes_devices_create - $ref: >- #/components/x-stackQL-resources/devices/methods/nodes_devices_create - $ref: >- @@ -1451,6 +1407,7 @@ components: #/components/x-stackQL-resources/devices/methods/nodes_devices_patch - $ref: >- #/components/x-stackQL-resources/devices/methods/customers_devices_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/devices/methods/deployments_devices_delete @@ -1470,16 +1427,16 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_update_signed: + nodes_devices_create_signed: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' response: mediaType: application/json openAPIDocKey: '200' - nodes_devices_create_signed: + nodes_devices_update_signed: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1devices:createSigned/post' + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' @@ -1497,31 +1454,31 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_nodes_devices_create_signed: + customers_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_devices_create_signed: + customers_devices_update_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch response: mediaType: application/json openAPIDocKey: '200' - customers_devices_create_signed: + customers_deployments_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices:createSigned/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' - customers_devices_update_signed: + customers_nodes_devices_create_signed: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1devices~1{devicesId}:updateSigned/patch + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1devices:createSigned/post response: mediaType: application/json openAPIDocKey: '200' @@ -1532,15 +1489,22 @@ components: #/components/x-stackQL-resources/devices_signed/methods/nodes_nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_deployments_devices_create_signed - - $ref: >- - #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_deployments_devices_create_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_create_signed - $ref: >- #/components/x-stackQL-resources/devices_signed/methods/customers_devices_create_signed - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/deployments_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/nodes_devices_update_signed + - $ref: >- + #/components/x-stackQL-resources/devices_signed/methods/customers_devices_update_signed + replace: [] delete: [] deployments: id: google.sasportal.deployments @@ -1553,77 +1517,60 @@ components: response: mediaType: application/json openAPIDocKey: '200' - nodes_nodes_deployments_create: + nodes_nodes_deployments_list: operation: - $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post - response: - mediaType: application/json - openAPIDocKey: '200' - _nodes_nodes_deployments_list: - operation: &ref_13 $ref: >- #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - nodes_nodes_deployments_list: - operation: *ref_13 - response: *ref_14 - nodes_deployments_move: + nodes_nodes_deployments_create: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post + #/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1deployments/post response: mediaType: application/json openAPIDocKey: '200' - _nodes_deployments_list: - operation: &ref_15 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' - response: &ref_16 + nodes_deployments_patch: + operation: + $ref: >- + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - nodes_deployments_list: - operation: *ref_15 - response: *ref_16 - nodes_deployments_delete: + nodes_deployments_get: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_patch: + nodes_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/patch + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' - nodes_deployments_get: + nodes_deployments_move: operation: $ref: >- - #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}/get + #/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments~1{deploymentsId}:move/post response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_deployments_list: - operation: &ref_17 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get - response: &ref_18 + nodes_deployments_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1deployments/get' + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deployments - customers_nodes_deployments_list: - operation: *ref_17 - response: *ref_18 - customers_nodes_deployments_create: + customers_deployments_delete: operation: $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete response: mediaType: application/json openAPIDocKey: '200' @@ -1641,13 +1588,19 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_delete: + customers_deployments_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1deployments~1{deploymentsId}/delete + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + customers_deployments_list: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.deployments customers_deployments_move: operation: $ref: >- @@ -1655,32 +1608,31 @@ components: response: mediaType: application/json openAPIDocKey: '200' - customers_deployments_create: + customers_nodes_deployments_list: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/post' + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/get response: mediaType: application/json openAPIDocKey: '200' - _customers_deployments_list: - operation: &ref_19 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1deployments/get' - response: &ref_20 + objectKey: $.deployments + customers_nodes_deployments_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1deployments/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.deployments - customers_deployments_list: - operation: *ref_19 - response: *ref_20 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_nodes_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_deployments_get - - $ref: >- - #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_deployments_get + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/customers_nodes_deployments_list - $ref: >- #/components/x-stackQL-resources/deployments/methods/deployments_get - $ref: >- @@ -1699,38 +1651,114 @@ components: #/components/x-stackQL-resources/deployments/methods/nodes_deployments_patch - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_deployments_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/deployments/methods/nodes_deployments_delete - $ref: >- #/components/x-stackQL-resources/deployments/methods/customers_deployments_delete - nodes: - id: google.sasportal.nodes - name: nodes - title: Nodes + installer: + id: google.sasportal.installer + name: installer + title: Installer methods: - nodes_nodes_move: + installer_generate_secret: operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' + $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' + response: + mediaType: application/json + openAPIDocKey: '200' + installer_validate: + operation: + $ref: '#/paths/~1v1alpha1~1installer:validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: [] + policies: + id: google.sasportal.policies + name: policies + title: Policies + methods: + policies_get: + operation: + $ref: '#/paths/~1v1alpha1~1policies:get/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_test: + operation: + $ref: '#/paths/~1v1alpha1~1policies:test/post' + response: + mediaType: application/json + openAPIDocKey: '200' + policies_set: + operation: + $ref: '#/paths/~1v1alpha1~1policies:set/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/policies_get' + insert: [] + update: [] + replace: [] + delete: [] + node: + id: google.sasportal.node + name: node + title: Node + methods: + nodes_get: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' response: mediaType: application/json openAPIDocKey: '200' + nodes_nodes_get: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' + - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' + insert: [] + update: [] + replace: [] + delete: [] + nodes: + id: google.sasportal.nodes + name: nodes + title: Nodes + methods: nodes_nodes_create: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/post' response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_list: - operation: &ref_21 + nodes_nodes_list: + operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes/get' - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - nodes_nodes_list: - operation: *ref_21 - response: *ref_22 + nodes_nodes_move: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}:move/post' + response: + mediaType: application/json + openAPIDocKey: '200' nodes_nodes_delete: operation: $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/delete' @@ -1743,16 +1771,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _nodes_nodes_nodes_list: - operation: &ref_23 - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' - response: &ref_24 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes - nodes_nodes_nodes_list: - operation: *ref_23 - response: *ref_24 nodes_nodes_nodes_create: operation: $ref: >- @@ -1760,6 +1778,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + nodes_nodes_nodes_list: + operation: + $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}~1nodes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nodes customers_nodes_patch: operation: $ref: >- @@ -1787,87 +1812,39 @@ components: - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_patch' - $ref: >- #/components/x-stackQL-resources/nodes/methods/customers_nodes_patch + replace: [] delete: - $ref: '#/components/x-stackQL-resources/nodes/methods/nodes_nodes_delete' - node: - id: google.sasportal.node - name: node - title: Node - methods: - nodes_nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}~1nodes~1{nodesId1}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1nodes~1{nodesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_nodes_get' - - $ref: '#/components/x-stackQL-resources/node/methods/nodes_get' - insert: [] - update: [] - delete: [] - installer: - id: google.sasportal.installer - name: installer - title: Installer - methods: - installer_validate: - operation: - $ref: '#/paths/~1v1alpha1~1installer:validate/post' - response: - mediaType: application/json - openAPIDocKey: '200' - installer_generate_secret: - operation: - $ref: '#/paths/~1v1alpha1~1installer:generateSecret/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] customers: id: google.sasportal.customers name: customers title: Customers methods: - customers_get: + customers_list: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + $ref: '#/paths/~1v1alpha1~1customers/get' response: mediaType: application/json openAPIDocKey: '200' - customers_patch: + objectKey: $.customers + customers_migrate_organization: operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' + $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' response: mediaType: application/json openAPIDocKey: '200' - customers_migrate_organization: + customers_patch: operation: - $ref: '#/paths/~1v1alpha1~1customers:migrateOrganization/post' + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/patch' response: mediaType: application/json openAPIDocKey: '200' - _customers_list: - operation: &ref_25 - $ref: '#/paths/~1v1alpha1~1customers/get' - response: &ref_26 + customers_get: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}/get' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.customers - customers_list: - operation: *ref_25 - response: *ref_26 customers_provision_deployment: operation: $ref: '#/paths/~1v1alpha1~1customers:provisionDeployment/post' @@ -1887,6 +1864,7 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/customers/methods/customers_patch' + replace: [] delete: [] customers_gcp_project_deployments: id: google.sasportal.customers_gcp_project_deployments @@ -1905,6 +1883,7 @@ components: #/components/x-stackQL-resources/customers_gcp_project_deployments/methods/customers_list_gcp_project_deployments insert: [] update: [] + replace: [] delete: [] customers_legacy_organizations: id: google.sasportal.customers_legacy_organizations @@ -1923,30 +1902,28 @@ components: #/components/x-stackQL-resources/customers_legacy_organizations/methods/customers_list_legacy_organizations insert: [] update: [] - delete: [] - customer_node: - id: google.sasportal.customer_node - name: customer_node - title: Customer_node - methods: - customers_nodes_get: - operation: - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get - insert: [] - update: [] + replace: [] delete: [] customer_nodes: id: google.sasportal.customer_nodes name: customer_nodes title: Customer_nodes methods: + customers_nodes_nodes_list: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.nodes + customers_nodes_nodes_create: + operation: + $ref: >- + #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + response: + mediaType: application/json + openAPIDocKey: '200' customers_nodes_delete: operation: $ref: >- @@ -1960,34 +1937,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_list: - operation: &ref_27 - $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' - response: &ref_28 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.nodes customers_nodes_list: - operation: *ref_27 - response: *ref_28 - customers_nodes_nodes_create: operation: - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/post + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes/get' response: mediaType: application/json openAPIDocKey: '200' - _customers_nodes_nodes_list: - operation: &ref_29 - $ref: >- - #/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}~1nodes/get - response: &ref_30 - mediaType: application/json - openAPIDocKey: '200' objectKey: $.nodes - customers_nodes_nodes_list: - operation: *ref_29 - response: *ref_30 sqlVerbs: select: - $ref: >- @@ -2000,33 +1956,46 @@ components: - $ref: >- #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/customer_nodes/methods/customers_nodes_delete + customer_node: + id: google.sasportal.customer_node + name: customer_node + title: Customer_node + methods: + customers_nodes_get: + operation: + $ref: '#/paths/~1v1alpha1~1customers~1{customersId}~1nodes~1{nodesId}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/customer_node/methods/customers_nodes_get + insert: [] + update: [] + replace: [] + delete: [] paths: - /v1alpha1/policies:get: - parameters: &ref_31 + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: + parameters: &ref_1 - $ref: '#/components/parameters/upload_protocol' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/uploadType' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/key' - post: - description: >- - Gets the access control policy for a resource. Returns an empty policy - if the resource exists and does not have a policy set. - operationId: sasportal.policies.get - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalGetPolicyRequest' + get: + description: Gets details about a device. + operationId: sasportal.deployments.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2042,18 +2011,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/policies:test: - parameters: *ref_31 - post: - description: Returns permissions that a caller has on the specified resource. - operationId: sasportal.policies.test + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + patch: + description: Updates a device. + operationId: sasportal.deployments.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2069,20 +2046,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalTestPermissionsResponse' - parameters: [] - /v1alpha1/policies:set: - parameters: *ref_31 - post: - description: >- - Sets the access control policy on the specified resource. Replaces any - existing policy. - operationId: sasportal.policies.set - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalSetPolicyRequest' + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a device. + operationId: sasportal.deployments.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2098,13 +2081,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalPolicy' - parameters: [] - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}: - parameters: *ref_31 - get: - description: Gets details about a device. - operationId: sasportal.deployments.devices.get + $ref: '#/components/schemas/SasPortalEmpty' + parameters: + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: sasportal.deployments.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2132,9 +2130,16 @@ paths: required: true schema: type: string - delete: - description: Deletes a device. - operationId: sasportal.deployments.devices.delete + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: sasportal.deployments.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2162,14 +2167,16 @@ paths: required: true schema: type: string - patch: - description: Updates a device. - operationId: sasportal.deployments.devices.patch + /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: sasportal.deployments.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2185,7 +2192,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: deploymentsId @@ -2197,21 +2204,43 @@ paths: required: true schema: type: string - - in: query - name: updateMask + /v1alpha1/deployments/{deploymentsId}: + parameters: *ref_1 + get: + description: Returns a requested deployment. + operationId: sasportal.deployments.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' + parameters: + - in: path + name: deploymentsId + required: true schema: type: string - format: google-fieldmask - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:move: - parameters: *ref_31 + /v1alpha1/installer:generateSecret: + parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: sasportal.deployments.devices.move + description: Generates a secret to be used with the ValidateInstaller. + operationId: sasportal.installer.generateSecret requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalGenerateSecretRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2227,28 +2256,74 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:signDevice: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalGenerateSecretResponse' + parameters: [] + /v1alpha1/installer:validate: + parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.deployments.devices.signDevice + description: Validates the identity of a Certified Professional Installer (CPI). + operationId: sasportal.installer.validate requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalValidateInstallerRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalValidateInstallerResponse' + parameters: [] + /v1alpha1/policies:get: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a resource. Returns an empty policy + if the resource exists and does not have a policy set. + operationId: sasportal.policies.get + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalGetPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/policies:test: + parameters: *ref_1 + post: + description: Returns permissions that a caller has on the specified resource. + operationId: sasportal.policies.test + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalTestPermissionsRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2264,28 +2339,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}/devices/{devicesId}:updateSigned: - parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: sasportal.deployments.devices.updateSigned + $ref: '#/components/schemas/SasPortalTestPermissionsResponse' + parameters: [] + /v1alpha1/policies:set: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on the specified resource. Replaces any + existing policy. + operationId: sasportal.policies.set requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalSetPolicyRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2301,23 +2368,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' - parameters: - - in: path - name: deploymentsId - required: true - schema: - type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/deployments/{deploymentsId}: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalPolicy' + parameters: [] + /v1alpha1/nodes/{nodesId}: + parameters: *ref_1 get: - description: Returns a requested deployment. - operationId: sasportal.deployments.get + description: Returns a requested node. + operationId: sasportal.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2333,23 +2390,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}: - parameters: *ref_31 - patch: - description: Updates a device. - operationId: sasportal.nodes.devices.patch + /v1alpha1/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2372,19 +2429,11 @@ paths: required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a device. - operationId: sasportal.nodes.devices.delete + /v1alpha1/nodes/{nodesId}/devices: + parameters: *ref_1 + get: + description: Lists devices under a node or customer. + operationId: sasportal.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2400,21 +2449,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: filter schema: type: string - get: - description: Gets details about a device. - operationId: sasportal.nodes.devices.get + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + post: + description: Creates a device under a node or customer. + operationId: sasportal.nodes.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2437,21 +2499,16 @@ paths: required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: - parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: sasportal.nodes.devices.updateSigned + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: + parameters: *ref_1 + post: + description: Moves a device under another node or customer. + operationId: sasportal.nodes.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2467,7 +2524,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -2479,11 +2536,11 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices: - parameters: *ref_31 - get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.devices.list + /v1alpha1/nodes/{nodesId}/devices/{devicesId}: + parameters: *ref_1 + delete: + description: Deletes a device. + operationId: sasportal.nodes.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2499,34 +2556,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: devicesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + get: + description: Gets details about a device. + operationId: sasportal.nodes.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2549,16 +2593,19 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: - parameters: *ref_31 - post: - description: Signs a device. - operationId: sasportal.nodes.devices.signDevice + - in: path + name: devicesId + required: true + schema: + type: string + patch: + description: Updates a device. + operationId: sasportal.nodes.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2574,7 +2621,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -2586,16 +2633,21 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices:createSigned: - parameters: *ref_31 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.devices.createSigned + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: sasportal.nodes.devices.updateSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2618,16 +2670,21 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/devices/{devicesId}:move: - parameters: *ref_31 + - in: path + name: devicesId + required: true + schema: + type: string + /v1alpha1/nodes/{nodesId}/devices/{devicesId}:signDevice: + parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: sasportal.nodes.devices.move + description: Signs a device. + operationId: sasportal.nodes.devices.signDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2643,7 +2700,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -2655,16 +2712,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: - parameters: *ref_31 + /v1alpha1/nodes/{nodesId}/nodes: + parameters: *ref_1 post: - description: Moves a node under another node or customer. - operationId: sasportal.nodes.nodes.move + description: Creates a new node. + operationId: sasportal.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2680,28 +2737,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes: - parameters: *ref_31 - post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + get: + description: Lists nodes. + operationId: sasportal.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2717,16 +2762,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: nodesId required: true schema: type: string - get: - description: Lists nodes. - operationId: sasportal.nodes.nodes.list + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}:move: + parameters: *ref_1 + post: + description: Moves a node under another node or customer. + operationId: sasportal.nodes.nodes.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2742,28 +2807,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: nodesId1 + required: true schema: type: string /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}: - parameters: *ref_31 + parameters: *ref_1 delete: description: Deletes a node. operationId: sasportal.nodes.nodes.delete @@ -2864,46 +2921,16 @@ paths: schema: type: string format: google-fieldmask - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: - parameters: *ref_31 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: sasportal.nodes.nodes.deployments.create + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: path - name: nodesId1 - required: true - schema: - type: string - get: - description: Lists deployments. - operationId: sasportal.nodes.nodes.deployments.list + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2919,7 +2946,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -2931,29 +2958,16 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices:createSigned: - parameters: *ref_31 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: + parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.nodes.devices.createSigned + description: Creates a device under a node or customer. + operationId: sasportal.nodes.nodes.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -2981,8 +2995,6 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/devices: - parameters: *ref_31 get: description: Lists devices under a node or customer. operationId: sasportal.nodes.nodes.devices.list @@ -3014,26 +3026,28 @@ paths: schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query name: filter schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string + type: integer + format: int32 + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: + parameters: *ref_1 post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.nodes.devices.create + description: Creates a new node. + operationId: sasportal.nodes.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3049,7 +3063,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: nodesId @@ -3061,8 +3075,6 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/nodes: - parameters: *ref_31 get: description: Lists nodes. operationId: sasportal.nodes.nodes.nodes.list @@ -3093,10 +3105,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: @@ -3106,14 +3114,15 @@ paths: schema: type: integer format: int32 - post: - description: Creates a new node. - operationId: sasportal.nodes.nodes.nodes.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/nodes/{nodesId1}/deployments: + parameters: *ref_1 + get: + description: Lists deployments. + operationId: sasportal.nodes.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3129,7 +3138,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId @@ -3141,16 +3150,27 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: - parameters: *ref_31 + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.nodes.deployments.devices.createSigned + description: Creates a new deployment. + operationId: sasportal.nodes.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3166,7 +3186,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -3174,20 +3194,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId1 required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: - parameters: *ref_31 - post: - description: Creates a device under a node or customer. - operationId: sasportal.nodes.deployments.devices.create + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: + parameters: *ref_1 + patch: + description: Updates an existing deployment. + operationId: sasportal.nodes.deployments.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3203,7 +3223,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -3215,9 +3235,14 @@ paths: required: true schema: type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Lists devices under a node or customer. - operationId: sasportal.nodes.deployments.devices.list + description: Returns a requested deployment. + operationId: sasportal.nodes.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3233,7 +3258,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: nodesId @@ -3245,29 +3270,9 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: - parameters: *ref_31 - post: - description: Moves a deployment under another node or customer. - operationId: sasportal.nodes.deployments.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + delete: + description: Deletes a deployment. + operationId: sasportal.nodes.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3283,7 +3288,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: nodesId @@ -3295,51 +3300,16 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}/deployments: - parameters: *ref_31 - get: - description: Lists deployments. - operationId: sasportal.nodes.deployments.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' - parameters: - - in: path - name: nodesId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken - schema: - type: string - /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}: - parameters: *ref_31 - delete: - description: Deletes a deployment. - operationId: sasportal.nodes.deployments.delete + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: sasportal.nodes.deployments.move + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3355,7 +3325,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: nodesId @@ -3367,14 +3337,11 @@ paths: required: true schema: type: string - patch: - description: Updates an existing deployment. - operationId: sasportal.nodes.deployments.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + /v1alpha1/nodes/{nodesId}/deployments: + parameters: *ref_1 + get: + description: Lists deployments. + operationId: sasportal.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3390,26 +3357,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: nodesId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - in: query - name: updateMask + name: pageToken schema: type: string - format: google-fieldmask - get: - description: Returns a requested deployment. - operationId: sasportal.nodes.deployments.get + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 + post: + description: Creates a device under a node or customer. + operationId: sasportal.nodes.deployments.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3425,7 +3402,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: nodesId @@ -3437,11 +3414,9 @@ paths: required: true schema: type: string - /v1alpha1/nodes/{nodesId}: - parameters: *ref_31 get: - description: Returns a requested node. - operationId: sasportal.nodes.get + description: Lists devices under a node or customer. + operationId: sasportal.nodes.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3457,50 +3432,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: nodesId required: true schema: type: string - /v1alpha1/installer:validate: - parameters: *ref_31 - post: - description: Validates the identity of a Certified Professional Installer (CPI). - operationId: sasportal.installer.validate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalValidateInstallerResponse' - parameters: [] - /v1alpha1/installer:generateSecret: - parameters: *ref_31 + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + /v1alpha1/nodes/{nodesId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 post: - description: Generates a secret to be used with the ValidateInstaller. - operationId: sasportal.installer.generateSecret + description: Creates a signed device under a node or customer. + operationId: sasportal.nodes.deployments.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretRequest' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3516,13 +3482,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalGenerateSecretResponse' - parameters: [] - /v1alpha1/customers/{customersId}: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalDevice' + parameters: + - in: path + name: nodesId + required: true + schema: + type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + /v1alpha1/customers: + parameters: *ref_1 get: - description: Returns a requested customer. - operationId: sasportal.customers.get + description: Returns a list of requested customers. + operationId: sasportal.customers.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3538,21 +3514,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalListCustomersResponse' parameters: - - in: path - name: customersId - required: true + - in: query + name: pageToken schema: type: string - patch: - description: Updates an existing customer. - operationId: sasportal.customers.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers:migrateOrganization: + parameters: *ref_1 + post: + description: >- + Migrates a SAS organization to the cloud. This will create GCP projects + for each deployment and associate them. The SAS Organization is linked + to the gcp project that called the command. + go/sas-legacy-customer-migration + operationId: sasportal.customers.migrateOrganization requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' + $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3568,20 +3554,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCustomer' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask + $ref: '#/components/schemas/SasPortalOperation' + parameters: [] /v1alpha1/customers:listGcpProjectDeployments: - parameters: *ref_31 + parameters: *ref_1 get: description: >- Returns a list of SAS deployments associated with current GCP project. @@ -3605,20 +3581,16 @@ paths: $ref: >- #/components/schemas/SasPortalListGcpProjectDeploymentsResponse parameters: [] - /v1alpha1/customers:migrateOrganization: - parameters: *ref_31 - post: - description: >- - Migrates a SAS organization to the cloud. This will create GCP projects - for each deployment and associate them. The SAS Organization is linked - to the gcp project that called the command. - go/sas-legacy-customer-migration - operationId: sasportal.customers.migrateOrganization + /v1alpha1/customers/{customersId}: + parameters: *ref_1 + patch: + description: Updates an existing customer. + operationId: sasportal.customers.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMigrateOrganizationRequest' + $ref: '#/components/schemas/SasPortalCustomer' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3634,13 +3606,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' - parameters: [] - /v1alpha1/customers: - parameters: *ref_31 + $ref: '#/components/schemas/SasPortalCustomer' + parameters: + - in: path + name: customersId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Returns a list of requested customers. - operationId: sasportal.customers.list + description: Returns a requested customer. + operationId: sasportal.customers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3656,19 +3636,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListCustomersResponse' + $ref: '#/components/schemas/SasPortalCustomer' parameters: - - in: query - name: pageToken + - in: path + name: customersId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 /v1alpha1/customers:listLegacyOrganizations: - parameters: *ref_31 + parameters: *ref_1 get: description: Returns a list of legacy organizations. operationId: sasportal.customers.listLegacyOrganizations @@ -3690,7 +3666,7 @@ paths: $ref: '#/components/schemas/SasPortalListLegacyOrganizationsResponse' parameters: [] /v1alpha1/customers:provisionDeployment: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Creates a new SAS deployment through the GCP workflow. Creates a SAS @@ -3719,7 +3695,7 @@ paths: $ref: '#/components/schemas/SasPortalProvisionDeploymentResponse' parameters: [] /v1alpha1/customers:setupSasAnalytics: - parameters: *ref_31 + parameters: *ref_1 post: description: >- Setups the a GCP Project to receive SAS Analytics messages via GCP @@ -3748,16 +3724,16 @@ paths: schema: $ref: '#/components/schemas/SasPortalOperation' parameters: [] - /v1alpha1/customers/{customersId}/nodes/{nodesId}: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/devices/{devicesId}: + parameters: *ref_1 patch: - description: Updates an existing node. - operationId: sasportal.customers.nodes.patch + description: Updates a device. + operationId: sasportal.customers.devices.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3773,7 +3749,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3781,7 +3757,7 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string @@ -3790,39 +3766,9 @@ paths: schema: type: string format: google-fieldmask - get: - description: Returns a requested node. - operationId: sasportal.customers.nodes.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/sasportal - Oauth2c: - - https://www.googleapis.com/auth/sasportal - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalNode' - parameters: - - in: path - name: customersId - required: true - schema: - type: string - - in: path - name: nodesId - required: true - schema: - type: string delete: - description: Deletes a node. - operationId: sasportal.customers.nodes.delete + description: Deletes a device. + operationId: sasportal.customers.devices.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3846,20 +3792,13 @@ paths: schema: type: string - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: - parameters: *ref_31 - post: - description: Moves a node under another node or customer. - operationId: sasportal.customers.nodes.move - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalMoveNodeRequest' + name: devicesId + required: true + schema: + type: string + get: + description: Gets details about a device. + operationId: sasportal.customers.devices.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3875,7 +3814,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3883,20 +3822,20 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/devices: + parameters: *ref_1 post: - description: Creates a new node. - operationId: sasportal.customers.nodes.create + description: Creates a device under a node or customer. + operationId: sasportal.customers.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3912,7 +3851,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -3920,8 +3859,8 @@ paths: schema: type: string get: - description: Lists nodes. - operationId: sasportal.customers.nodes.list + description: Lists devices under a node or customer. + operationId: sasportal.customers.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3937,7 +3876,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: customersId @@ -3948,20 +3887,25 @@ paths: name: pageToken schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageSize schema: type: integer format: int32 - /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: - parameters: *ref_31 - get: - description: Lists deployments. - operationId: sasportal.customers.nodes.deployments.list + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: + parameters: *ref_1 + post: + description: Signs a device. + operationId: sasportal.customers.devices.signDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalSignDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3977,7 +3921,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDeploymentsResponse' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -3985,31 +3929,20 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string + /v1alpha1/customers/{customersId}/devices/{devicesId}:move: + parameters: *ref_1 post: - description: Creates a new deployment. - operationId: sasportal.customers.nodes.deployments.create + description: Moves a device under another node or customer. + operationId: sasportal.customers.devices.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalMoveDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4025,7 +3958,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -4033,20 +3966,20 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/devices:createSigned: + parameters: *ref_1 post: - description: Creates a new node. - operationId: sasportal.customers.nodes.nodes.create + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4062,21 +3995,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalNode' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: nodesId - required: true - schema: - type: string - get: - description: Lists nodes. - operationId: sasportal.customers.nodes.nodes.list + /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: + parameters: *ref_1 + patch: + description: Updates a signed device. + operationId: sasportal.customers.devices.updateSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4092,7 +4027,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListNodesResponse' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -4100,33 +4035,15 @@ paths: schema: type: string - in: path - name: nodesId + name: devicesId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter - schema: - type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: - parameters: *ref_31 - post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.nodes.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: + parameters: *ref_1 + delete: + description: Deletes a deployment. + operationId: sasportal.customers.deployments.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4142,7 +4059,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId @@ -4150,13 +4067,13 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.nodes.devices.list + description: Returns a requested deployment. + operationId: sasportal.customers.deployments.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4172,7 +4089,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -4180,33 +4097,60 @@ paths: schema: type: string - in: path - name: nodesId + name: deploymentsId required: true schema: type: string - - in: query - name: pageSize + patch: + description: Updates an existing deployment. + operationId: sasportal.customers.deployments.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sasportal + Oauth2c: + - https://www.googleapis.com/auth/sasportal + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDeployment' + parameters: + - in: path + name: customersId + required: true schema: - type: integer - format: int32 - - in: query - name: filter + type: string + - in: path + name: deploymentsId + required: true schema: type: string - in: query - name: pageToken + name: updateMask schema: type: string - /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: - parameters: *ref_31 + format: google-fieldmask + /v1alpha1/customers/{customersId}/deployments: + parameters: *ref_1 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.nodes.devices.createSigned + description: Creates a new deployment. + operationId: sasportal.customers.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4222,23 +4166,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: nodesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}: - parameters: *ref_31 get: - description: Returns a requested deployment. - operationId: sasportal.customers.deployments.get + description: Lists deployments. + operationId: sasportal.customers.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4254,26 +4191,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDeploymentsResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: deploymentsId - required: true + - in: query + name: filter schema: type: string - patch: - description: Updates an existing deployment. - operationId: sasportal.customers.deployments.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: + parameters: *ref_1 + post: + description: Moves a deployment under another node or customer. + operationId: sasportal.customers.deployments.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4289,7 +4236,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -4301,14 +4248,16 @@ paths: required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - delete: - description: Deletes a deployment. - operationId: sasportal.customers.deployments.delete + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.deployments.devices.createSigned + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4324,7 +4273,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -4336,16 +4285,16 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}:move: - parameters: *ref_31 - post: - description: Moves a deployment under another node or customer. - operationId: sasportal.customers.deployments.move + /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: + parameters: *ref_1 + post: + description: Creates a device under a node or customer. + operationId: sasportal.customers.deployments.devices.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeploymentRequest' + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4361,7 +4310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -4373,16 +4322,9 @@ paths: required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments: - parameters: *ref_31 - post: - description: Creates a new deployment. - operationId: sasportal.customers.deployments.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDeployment' + get: + description: Lists devices under a node or customer. + operationId: sasportal.customers.deployments.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4398,16 +4340,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDeployment' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: customersId required: true schema: type: string + - in: path + name: deploymentsId + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/deployments: + parameters: *ref_1 get: description: Lists deployments. - operationId: sasportal.customers.deployments.list + operationId: sasportal.customers.nodes.deployments.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4430,29 +4392,32 @@ paths: required: true schema: type: string + - in: path + name: nodesId + required: true + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string - in: query - name: filter + name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices:createSigned: - parameters: *ref_31 post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.deployments.devices.createSigned + description: Creates a new deployment. + operationId: sasportal.customers.nodes.deployments.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalDeployment' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4468,7 +4433,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalDeployment' parameters: - in: path name: customersId @@ -4476,15 +4441,15 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/deployments/{deploymentsId}/devices: - parameters: *ref_31 + /v1alpha1/customers/{customersId}/nodes/{nodesId}/nodes: + parameters: *ref_1 get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.deployments.devices.list + description: Lists nodes. + operationId: sasportal.customers.nodes.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4500,7 +4465,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId @@ -4508,12 +4473,12 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - in: query - name: filter + name: pageToken schema: type: string - in: query @@ -4522,17 +4487,17 @@ paths: type: integer format: int32 - in: query - name: pageToken + name: filter schema: type: string post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.deployments.devices.create + description: Creates a new node. + operationId: sasportal.customers.nodes.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4548,7 +4513,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId @@ -4556,15 +4521,20 @@ paths: schema: type: string - in: path - name: deploymentsId + name: nodesId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}: - parameters: *ref_31 - delete: - description: Deletes a device. - operationId: sasportal.customers.devices.delete + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices: + parameters: *ref_1 + post: + description: Creates a device under a node or customer. + operationId: sasportal.customers.nodes.devices.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SasPortalDevice' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4580,7 +4550,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalDevice' parameters: - in: path name: customersId @@ -4588,13 +4558,13 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string get: - description: Gets details about a device. - operationId: sasportal.customers.devices.get + description: Lists devices under a node or customer. + operationId: sasportal.customers.nodes.devices.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4610,7 +4580,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListDevicesResponse' parameters: - in: path name: customersId @@ -4618,18 +4588,33 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - patch: - description: Updates a device. - operationId: sasportal.customers.devices.patch + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}/devices:createSigned: + parameters: *ref_1 + post: + description: Creates a signed device under a node or customer. + operationId: sasportal.customers.nodes.devices.createSigned requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4653,25 +4638,20 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string - - in: query - name: updateMask - schema: - type: string - format: google-fieldmask - /v1alpha1/customers/{customersId}/devices:createSigned: - parameters: *ref_31 - post: - description: Creates a signed device under a node or customer. - operationId: sasportal.customers.devices.createSigned + /v1alpha1/customers/{customersId}/nodes/{nodesId}: + parameters: *ref_1 + patch: + description: Updates an existing node. + operationId: sasportal.customers.nodes.patch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalCreateSignedDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4687,18 +4667,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices: - parameters: *ref_31 + - in: path + name: nodesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask get: - description: Lists devices under a node or customer. - operationId: sasportal.customers.devices.list + description: Returns a requested node. + operationId: sasportal.customers.nodes.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4714,34 +4702,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalListDevicesResponse' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: nodesId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - post: - description: Creates a device under a node or customer. - operationId: sasportal.customers.devices.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalDevice' + delete: + description: Deletes a node. + operationId: sasportal.customers.nodes.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4757,23 +4732,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalEmpty' parameters: - in: path name: customersId required: true schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:move: - parameters: *ref_31 + - in: path + name: nodesId + required: true + schema: + type: string + /v1alpha1/customers/{customersId}/nodes: + parameters: *ref_1 post: - description: Moves a device under another node or customer. - operationId: sasportal.customers.devices.move + description: Creates a new node. + operationId: sasportal.customers.nodes.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalMoveDeviceRequest' + $ref: '#/components/schemas/SasPortalNode' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4789,28 +4769,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalOperation' + $ref: '#/components/schemas/SasPortalNode' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true - schema: - type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:updateSigned: - parameters: *ref_31 - patch: - description: Updates a signed device. - operationId: sasportal.customers.devices.updateSigned - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SasPortalUpdateSignedDeviceRequest' + get: + description: Lists nodes. + operationId: sasportal.customers.nodes.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4826,28 +4794,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalDevice' + $ref: '#/components/schemas/SasPortalListNodesResponse' parameters: - in: path name: customersId required: true schema: type: string - - in: path - name: devicesId - required: true + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken schema: type: string - /v1alpha1/customers/{customersId}/devices/{devicesId}:signDevice: - parameters: *ref_31 + - in: query + name: filter + schema: + type: string + /v1alpha1/customers/{customersId}/nodes/{nodesId}:move: + parameters: *ref_1 post: - description: Signs a device. - operationId: sasportal.customers.devices.signDevice + description: Moves a node under another node or customer. + operationId: sasportal.customers.nodes.move requestBody: content: application/json: schema: - $ref: '#/components/schemas/SasPortalSignDeviceRequest' + $ref: '#/components/schemas/SasPortalMoveNodeRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4863,7 +4839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SasPortalEmpty' + $ref: '#/components/schemas/SasPortalOperation' parameters: - in: path name: customersId @@ -4871,7 +4847,7 @@ paths: schema: type: string - in: path - name: devicesId + name: nodesId required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml index e3fda3f5..bd557b5c 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/secretmanager.yaml @@ -9,8 +9,8 @@ info: Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/secret-manager/ servers: @@ -305,7 +305,7 @@ components: properties: name: description: >- - Required. The resource name of the Pub/Sub topic that will be + Identifier. The resource name of the Pub/Sub topic that will be published to, in the following format: `projects/*/topics/*`. For publication to succeed, the Secret Manager service agent must have the `pubsub.topic.publish` permission on the topic. The Pub/Sub @@ -1015,16 +1015,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1037,22 +1034,20 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] secrets: id: google.secretmanager.secrets name: secrets title: Secrets methods: - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1secrets/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.secrets - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1secrets/post' @@ -1081,17 +1076,13 @@ components: select: - $ref: '#/components/x-stackQL-resources/secrets/methods/get' - $ref: '#/components/x-stackQL-resources/secrets/methods/list' - - $ref: '#/components/x-stackQL-resources/secrets/methods/get' - - $ref: '#/components/x-stackQL-resources/secrets/methods/list' insert: - $ref: '#/components/x-stackQL-resources/secrets/methods/create' - - $ref: '#/components/x-stackQL-resources/secrets/methods/create' update: - $ref: '#/components/x-stackQL-resources/secrets/methods/patch' - - $ref: '#/components/x-stackQL-resources/secrets/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/secrets/methods/delete' - - $ref: '#/components/x-stackQL-resources/secrets/methods/delete' secrets_version: id: google.secretmanager.secrets_version name: secrets_version @@ -1106,8 +1097,11 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/secrets_version/methods/add_version update: [] + replace: [] delete: [] secrets_iam_policies: id: google.secretmanager.secrets_iam_policies @@ -1121,17 +1115,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1secrets~1{secretsId}:getIamPolicy/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: >- @@ -1143,27 +1134,25 @@ components: select: - $ref: >- #/components/x-stackQL-resources/secrets_iam_policies/methods/get_iam_policy - - $ref: >- - #/components/x-stackQL-resources/secrets_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/secrets_iam_policies/methods/set_iam_policy delete: [] versions: id: google.secretmanager.versions name: versions title: Versions methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1secrets~1{secretsId}~1versions/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.versions - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -1203,14 +1192,14 @@ components: select: - $ref: '#/components/x-stackQL-resources/versions/methods/get' - $ref: '#/components/x-stackQL-resources/versions/methods/list' - - $ref: '#/components/x-stackQL-resources/versions/methods/get' - - $ref: '#/components/x-stackQL-resources/versions/methods/list' insert: [] update: [] - delete: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/versions/methods/destroy' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1257,7 +1246,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: secretmanager.projects.locations.get @@ -1285,7 +1274,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists Secrets. operationId: secretmanager.projects.locations.secrets.list @@ -1361,7 +1350,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:addVersion: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates a new SecretVersion containing secret data and attaches it to an @@ -1401,7 +1390,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets metadata for a given Secret. operationId: secretmanager.projects.locations.secrets.get @@ -1510,7 +1499,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified secret. Replaces any @@ -1551,7 +1540,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a secret. Returns empty policy if the @@ -1591,7 +1580,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has for the specified secret. If the @@ -1634,7 +1623,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists SecretVersions. This call does not return secret data. operationId: secretmanager.projects.locations.secrets.versions.list @@ -1680,7 +1669,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets metadata for a SecretVersion. @@ -1721,7 +1710,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:access: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Accesses a SecretVersion. This call returns the secret data. @@ -1762,7 +1751,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:disable: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Disables a SecretVersion. Sets the state of the SecretVersion to @@ -1807,7 +1796,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:enable: - parameters: *ref_9 + parameters: *ref_1 post: description: Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. operationId: secretmanager.projects.locations.secrets.versions.enable @@ -1850,7 +1839,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}/versions/{versionsId}:destroy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Destroys a SecretVersion. Sets the state of the SecretVersion to @@ -1895,7 +1884,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists Secrets. operationId: secretmanager.projects.secrets.list @@ -1961,7 +1950,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}:addVersion: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates a new SecretVersion containing secret data and attaches it to an @@ -1996,7 +1985,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets metadata for a given Secret. operationId: secretmanager.projects.secrets.get @@ -2090,7 +2079,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}:setIamPolicy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified secret. Replaces any @@ -2126,7 +2115,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}:getIamPolicy: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the access control policy for a secret. Returns empty policy if the @@ -2161,7 +2150,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/secrets/{secretsId}:testIamPermissions: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Returns permissions that a caller has for the specified secret. If the @@ -2199,7 +2188,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}/versions: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists SecretVersions. This call does not return secret data. operationId: secretmanager.projects.secrets.versions.list @@ -2240,7 +2229,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets metadata for a SecretVersion. @@ -2276,7 +2265,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:access: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Accesses a SecretVersion. This call returns the secret data. @@ -2312,7 +2301,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:disable: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Disables a SecretVersion. Sets the state of the SecretVersion to @@ -2352,7 +2341,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:enable: - parameters: *ref_9 + parameters: *ref_1 post: description: Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. operationId: secretmanager.projects.secrets.versions.enable @@ -2390,7 +2379,7 @@ paths: schema: type: string /v1/projects/{projectsId}/secrets/{secretsId}/versions/{versionsId}:destroy: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Destroys a SecretVersion. Sets the state of the SecretVersion to diff --git a/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml b/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml index 8c86bd3d..cb6c1693 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/securitycenter.yaml @@ -9,8 +9,8 @@ info: Security Command Center API provides access to temporal views of assets and findings within an organization. version: v1 - x-discovery-doc-revision: '20240527' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/security-command-center servers: @@ -171,6 +171,21 @@ components: mute/unmute of findings based on the filter. deprecated: true type: string + muteState: + description: >- + Optional. All findings matching the given filter will have their + mute state set to this value. The default value is `MUTED`. Setting + this to `UNDEFINED` will clear the mute state on all matching + findings. + type: string + enumDescriptions: + - Unused. + - Matching findings will be muted (default). + - Matching findings will have their mute state cleared. + enum: + - MUTE_STATE_UNSPECIFIED + - MUTED + - UNDEFINED GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule: id: GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule description: >- @@ -602,6 +617,14 @@ components: - >- Describes a potential security risk due to a change in the security posture. + - >- + Describes a group of security issues that, when the issues occur + together, represent a greater risk than when the issues occur + independently. A group of such issues is referred to as a toxic + combination. + - >- + Describes a potential security risk to data assets that contain + sensitive data. enum: - FINDING_CLASS_UNSPECIFIED - THREAT @@ -610,6 +633,8 @@ components: - OBSERVATION - SCC_ERROR - POSTURE_VIOLATION + - TOXIC_COMBINATION + - SENSITIVE_DATA_RISK indicator: description: >- Represents what's commonly known as an *indicator of compromise* @@ -662,6 +687,10 @@ components: configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. type: string + muteInfo: + description: Output only. The mute information regarding this finding. + readOnly: true + $ref: '#/components/schemas/MuteInfo' processes: description: Represents operating system processes associated with the Finding. type: array @@ -776,6 +805,33 @@ components: notebook: description: Notebook associated with the finding. $ref: '#/components/schemas/Notebook' + toxicCombination: + description: >- + Contains details about a group of security issues that, when the + issues occur together, represent a greater risk than when the issues + occur independently. A group of such issues is referred to as a + toxic combination. This field cannot be updated. Its value is + ignored in all update requests. + $ref: '#/components/schemas/ToxicCombination' + groupMemberships: + description: >- + Contains details about groups of which this finding is a member. A + group is a collection of findings that are related in some way. This + field cannot be updated. Its value is ignored in all update + requests. + type: array + items: + $ref: '#/components/schemas/GroupMembership' + dataAccessEvents: + description: Data access events associated with the finding. + type: array + items: + $ref: '#/components/schemas/DataAccessEvent' + dataFlowEvents: + description: Data flow events associated with the finding. + type: array + items: + $ref: '#/components/schemas/DataFlowEvent' SecurityMarks: id: SecurityMarks description: >- @@ -1003,6 +1059,14 @@ components: Whether or not the vulnerability was zero day when the finding was published. type: boolean + exploitReleaseDate: + description: Date the first publicly available exploit or PoC was released. + type: string + format: google-datetime + firstExploitationDate: + description: Date of the earliest known exploitation. + type: string + format: google-datetime Reference: id: Reference description: Additional Links @@ -1376,8 +1440,10 @@ components: - T1059 - T1059.004 - T1059.006 + - T1068 - T1069 - T1069.003 + - T1070.004 - T1071 - T1071.004 - T1072 @@ -1425,7 +1491,10 @@ components: - T1588 - T1595 - T1595.001 + - T1609 + - T1611 - T1613 + - T1649 enum: - TECHNIQUE_UNSPECIFIED - MASQUERADING @@ -1437,8 +1506,10 @@ components: - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL - PYTHON + - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL_FILE_DELETION - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -1486,7 +1557,10 @@ components: - OBTAIN_CAPABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - CONTAINER_ADMINISTRATION_COMMAND + - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES additionalTactics: description: Additional MITRE ATT&CK tactics related to this finding, if any. type: array @@ -1542,8 +1616,10 @@ components: - T1059 - T1059.004 - T1059.006 + - T1068 - T1069 - T1069.003 + - T1070.004 - T1071 - T1071.004 - T1072 @@ -1591,7 +1667,10 @@ components: - T1588 - T1595 - T1595.001 + - T1609 + - T1611 - T1613 + - T1649 enum: - TECHNIQUE_UNSPECIFIED - MASQUERADING @@ -1603,8 +1682,10 @@ components: - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL - PYTHON + - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL_FILE_DELETION - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -1652,7 +1733,10 @@ components: - OBTAIN_CAPABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - CONTAINER_ADMINISTRATION_COMMAND + - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES version: description: The MITRE ATT&CK version referenced by the above fields. E.g. "8". type: string @@ -1801,6 +1885,66 @@ components: - UDP - GRE - ESP + MuteInfo: + id: MuteInfo + description: >- + Mute information about the finding, including whether the finding has a + static mute or any matching dynamic mute rules. + type: object + properties: + staticMute: + description: >- + If set, the static mute applied to this finding. Static mutes + override dynamic mutes. If unset, there is no static mute. + $ref: '#/components/schemas/StaticMute' + dynamicMuteRecords: + description: The list of dynamic mute rules that currently match the finding. + type: array + items: + $ref: '#/components/schemas/DynamicMuteRecord' + StaticMute: + id: StaticMute + description: >- + Information about the static mute state. A static mute state overrides + any dynamic mute rules that apply to this finding. The static mute state + can be set by a static mute rule or by muting the finding directly. + type: object + properties: + state: + description: >- + The static mute state. If the value is `MUTED` or `UNMUTED`, then + the finding's overall mute state will have the same value. + type: string + enumDescriptions: + - Unspecified. + - Finding has been muted. + - Finding has been unmuted. + - Finding has never been muted/unmuted. + enum: + - MUTE_UNSPECIFIED + - MUTED + - UNMUTED + - UNDEFINED + applyTime: + description: When the static mute was applied. + type: string + format: google-datetime + DynamicMuteRecord: + id: DynamicMuteRecord + description: The record of a dynamic mute rule that matches the finding. + type: object + properties: + muteConfig: + description: >- + The relative resource name of the mute rule, represented by a mute + config, that created this record, for example + `organizations/123/muteConfigs/mymuteconfig` or + `organizations/123/locations/global/muteConfigs/mymuteconfig`. + type: string + matchTime: + description: When the dynamic mute rule first matched the finding. + type: string + format: google-datetime Process: id: Process description: Represents an operating system process. @@ -2382,7 +2526,7 @@ components: description: >- The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: - organizations/123/simulations/456/attackExposureResults/789 + `organizations/123/simulations/456/attackExposureResults/789` type: string state: description: >- @@ -2873,6 +3017,121 @@ components: description: The most recent time the notebook was updated. type: string format: google-datetime + ToxicCombination: + id: ToxicCombination + description: >- + Contains details about a group of security issues that, when the issues + occur together, represent a greater risk than when the issues occur + independently. A group of such issues is referred to as a toxic + combination. + type: object + properties: + attackExposureScore: + description: >- + The [Attack exposure + score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) + of this toxic combination. The score is a measure of how much this + toxic combination exposes one or more high-value resources to + potential attack. + type: number + format: double + relatedFindings: + description: >- + List of resource names of findings associated with this toxic + combination. For example, + `organizations/123/sources/456/findings/789`. + type: array + items: + type: string + GroupMembership: + id: GroupMembership + description: >- + Contains details about groups of which this finding is a member. A group + is a collection of findings that are related in some way. + type: object + properties: + groupType: + description: Type of group. + type: string + enumDescriptions: + - Default value. + - Group represents a toxic combination. + enum: + - GROUP_TYPE_UNSPECIFIED + - GROUP_TYPE_TOXIC_COMBINATION + groupId: + description: ID of the group. + type: string + DataAccessEvent: + id: DataAccessEvent + description: >- + Details about a data access attempt made by a principal not authorized + under applicable data security policy. + type: object + properties: + eventId: + description: Unique identifier for data access event. + type: string + principalEmail: + description: >- + The email address of the principal that accessed the data. The + principal could be a user account, service account, Google group, or + other. + type: string + operation: + description: The operation performed by the principal to access the data. + type: string + enumDescriptions: + - The operation is unspecified. + - Represents a read operation. + - Represents a move operation. + - Represents a copy operation. + enum: + - OPERATION_UNSPECIFIED + - READ + - MOVE + - COPY + eventTime: + description: Timestamp of data access event. + type: string + format: google-datetime + DataFlowEvent: + id: DataFlowEvent + description: >- + Details about a data flow event, in which either the data is moved to or + is accessed from a non-compliant geo-location, as defined in the + applicable data security policy. + type: object + properties: + eventId: + description: Unique identifier for data flow event. + type: string + principalEmail: + description: >- + The email address of the principal that initiated the data flow + event. The principal could be a user account, service account, + Google group, or other. + type: string + operation: + description: The operation performed by the principal for the data flow event. + type: string + enumDescriptions: + - The operation is unspecified. + - Represents a read operation. + - Represents a move operation. + - Represents a copy operation. + enum: + - OPERATION_UNSPECIFIED + - READ + - MOVE + - COPY + violatedLocation: + description: Non-compliant location of the principal or the data destination. + type: string + eventTime: + description: Timestamp of data flow event. + type: string + format: google-datetime GoogleCloudSecuritycenterV1MuteConfig: id: GoogleCloudSecuritycenterV1MuteConfig description: >- @@ -2883,12 +3142,12 @@ components: name: description: >- This field will be ignored if provided on config creation. Format - "organizations/{organization}/muteConfigs/{mute_config}" - "folders/{folder}/muteConfigs/{mute_config}" - "projects/{project}/muteConfigs/{mute_config}" - "organizations/{organization}/locations/global/muteConfigs/{mute_config}" - "folders/{folder}/locations/global/muteConfigs/{mute_config}" - "projects/{project}/locations/global/muteConfigs/{mute_config}" + `organizations/{organization}/muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `organizations/{organization}/locations/global/muteConfigs/{mute_config}` + `folders/{folder}/locations/global/muteConfigs/{mute_config}` + `projects/{project}/locations/global/muteConfigs/{mute_config}` type: string displayName: description: The human readable name to be displayed for the mute config. @@ -2935,6 +3194,38 @@ components: provided on config creation or update. readOnly: true type: string + type: + description: >- + Optional. The type of the mute config, which determines what type of + mute state the config affects. The static mute state takes + precedence over the dynamic mute state. Immutable after creation. + STATIC by default if not set during creation. + type: string + enumDescriptions: + - Unused. + - >- + A static mute config, which sets the static mute state of future + matching findings to muted. Once the static mute state has been + set, finding or config modifications will not affect the state. + - >- + A dynamic mute config, which is applied to existing and future + matching findings, setting their dynamic mute state to "muted". If + the config is updated or deleted, or a matching finding is + updated, such that the finding doesn't match the config, the + config will be removed from the finding, and the finding's dynamic + mute state may become "unmuted" (unless other configs still + match). + enum: + - MUTE_CONFIG_TYPE_UNSPECIFIED + - STATIC + - DYNAMIC + expiryTime: + description: >- + Optional. The expiry of the mute config. Only applicable for dynamic + configs. If the expiry is set, when the config expires, it is + removed from all findings. + type: string + format: google-datetime NotificationConfig: id: NotificationConfig description: >- @@ -3000,7 +3291,7 @@ components: name: description: >- Full resource name of the Simulation: - organizations/123/simulations/456 + `organizations/123/simulations/456` type: string createTime: description: Output only. Time simulation was created @@ -4127,6 +4418,9 @@ components: awsMetadata: description: The AWS metadata associated with the finding. $ref: '#/components/schemas/AwsMetadata' + azureMetadata: + description: The Azure metadata associated with the finding. + $ref: '#/components/schemas/AzureMetadata' resourcePath: description: Provides the path to the resource within the resource hierarchy. $ref: '#/components/schemas/ResourcePath' @@ -4134,13 +4428,13 @@ components: description: >- A string representation of the resource path. For Google Cloud, it has the format of - org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} + `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of - org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} + `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of - mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} + `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. type: string AwsMetadata: @@ -4210,6 +4504,74 @@ components: name: description: The friendly name of this account. type: string + AzureMetadata: + id: AzureMetadata + description: >- + Azure metadata associated with the resource, only applicable if the + finding's cloud provider is Microsoft Azure. + type: object + properties: + managementGroups: + description: >- + A list of Azure management groups associated with the resource, + ordered from lowest level (closest to the subscription) to highest + level. + type: array + items: + $ref: '#/components/schemas/AzureManagementGroup' + subscription: + description: The Azure subscription associated with the resource. + $ref: '#/components/schemas/AzureSubscription' + resourceGroup: + description: The Azure resource group associated with the resource. + $ref: '#/components/schemas/AzureResourceGroup' + tenant: + description: The Azure Entra tenant associated with the resource. + $ref: '#/components/schemas/AzureTenant' + AzureManagementGroup: + id: AzureManagementGroup + description: Represents an Azure management group. + type: object + properties: + id: + description: >- + The UUID of the Azure management group, for example, + `20000000-0001-0000-0000-000000000000`. + type: string + displayName: + description: The display name of the Azure management group. + type: string + AzureSubscription: + id: AzureSubscription + description: Represents an Azure subscription. + type: object + properties: + id: + description: >- + The UUID of the Azure subscription, for example, + `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. + type: string + displayName: + description: The display name of the Azure subscription. + type: string + AzureResourceGroup: + id: AzureResourceGroup + description: Represents an Azure resource group. + type: object + properties: + name: + description: The name of the Azure resource group. This is not a UUID. + type: string + AzureTenant: + id: AzureTenant + description: Represents a Microsoft Entra tenant. + type: object + properties: + id: + description: >- + The ID of the Microsoft Entra tenant, for example, + "a11aaa11-aa11-1aa1-11aa-1aaa11a". + type: string ResourcePath: id: ResourcePath description: >- @@ -4526,11 +4888,11 @@ components: description: >- Immutable. The resource name of the Event Threat Detection custom module. Its format is: * - "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". + `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * - "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". + `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * - "projects/{project}/eventThreatDetectionSettings/customModules/{module}". + `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. type: string config: description: >- @@ -4706,11 +5068,11 @@ components: description: >- Output only. The resource name of the effective ETD custom module. Its format is: * - "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". + `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * - "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". + `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * - "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". + `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. readOnly: true type: string config: @@ -4809,9 +5171,9 @@ components: - NONE tagValues: description: >- - Required. Tag values combined with AND to check against. Values in - the form "tagValues/123" Example: [ "tagValues/123", - "tagValues/456", "tagValues/789" ] + Required. Tag values combined with `AND` to check against. Values in + the form "tagValues/123" Example: `[ "tagValues/123", + "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing type: array items: @@ -4819,7 +5181,7 @@ components: resourceType: description: >- Apply resource_value only to resources that match resource_type. - resource_type will be checked with AND of other resources. For + resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. @@ -4828,13 +5190,14 @@ components: description: >- Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in - "project/456" scope will be checked with AND of other resources. + "project/456" scope will be checked with `AND` of other resources. type: string resourceLabelsSelector: description: >- - List of resource labels to search for, evaluated with AND. For - example, "resource_labels_selector": {"key": "value", "env": "prod"} - will match resources with labels "key": "value" AND "env": "prod" + List of resource labels to search for, evaluated with `AND`. For + example, `"resource_labels_selector": {"key": "value", "env": + "prod"}` will match resources with labels "key": "value" `AND` + "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels type: object additionalProperties: @@ -5015,12 +5378,12 @@ components: description: >- The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name - format]("https://cloud.google.com/asset-inventory/docs/resource-name-format") + format](https://cloud.google.com/asset-inventory/docs/resource-name-format) type: string resourceType: description: >- The [supported resource - type](https://cloud.google.com/asset-inventory/docs/supported-asset-types") + type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) type: string displayName: description: Human-readable name of this resource. @@ -5046,7 +5409,7 @@ components: canonicalFinding: description: >- Canonical name of the associated findings. Example: - organizations/123/sources/456/findings/789 + `organizations/123/sources/456/findings/789` type: string findingCategory: description: The additional taxonomy group within findings from a given source. @@ -5213,6 +5576,9 @@ components: awsMetadata: description: The AWS metadata associated with the finding. $ref: '#/components/schemas/AwsMetadata' + azureMetadata: + description: The Azure metadata associated with the finding. + $ref: '#/components/schemas/AzureMetadata' resourcePath: description: Provides the path to the resource within the resource hierarchy. $ref: '#/components/schemas/ResourcePath' @@ -5220,13 +5586,13 @@ components: description: >- A string representation of the resource path. For Google Cloud, it has the format of - organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} + `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of - org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} + `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of - mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} + `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. type: string GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse: @@ -5364,8 +5730,8 @@ components: properties: name: description: >- - This field will be ignored if provided on config creation. The - following list shows some examples of the format: + + Identifier. This field will be ignored if provided on config + creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + @@ -5425,9 +5791,25 @@ components: A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state. + - >- + A dynamic mute config, which is applied to existing and future + matching findings, setting their dynamic mute state to "muted". If + the config is updated or deleted, or a matching finding is + updated, such that the finding doesn't match the config, the + config will be removed from the finding, and the finding's dynamic + mute state may become "unmuted" (unless other configs still + match). enum: - MUTE_CONFIG_TYPE_UNSPECIFIED - STATIC + - DYNAMIC + expiryTime: + description: >- + Optional. The expiry of the mute config. Only applicable for dynamic + configs. If the expiry is set, when the config expires, it is + removed from all findings. + type: string + format: google-datetime GoogleCloudSecuritycenterV2BigQueryExport: id: GoogleCloudSecuritycenterV2BigQueryExport description: Configures how to deliver Findings to BigQuery Instance. @@ -5435,7 +5817,7 @@ components: properties: name: description: >- - The relative resource name of this export. See: + Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` @@ -5468,7 +5850,7 @@ components: description: >- The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery - Dataset unique ID must contain only letters (a-z, A-Z), numbers + dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). type: string createTime: @@ -5711,6 +6093,10 @@ components: - MUTED - UNMUTED - UNDEFINED + muteInfo: + description: Output only. The mute information regarding this finding. + readOnly: true + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2MuteInfo' findingClass: description: The class of the finding. type: string @@ -5730,6 +6116,12 @@ components: - >- Describes a potential security risk due to a change in the security posture. + - >- + Describes a combination of security issues that represent a more + severe security problem when taken together. + - >- + Describes a potential security risk to data assets that contain + sensitive data. enum: - FINDING_CLASS_UNSPECIFIED - THREAT @@ -5738,6 +6130,8 @@ components: - OBSERVATION - SCC_ERROR - POSTURE_VIOLATION + - TOXIC_COMBINATION + - SENSITIVE_DATA_RISK indicator: description: >- Represents what's commonly known as an *indicator of compromise* @@ -5905,6 +6299,33 @@ components: notebook: description: Notebook associated with the finding. $ref: '#/components/schemas/GoogleCloudSecuritycenterV2Notebook' + toxicCombination: + description: >- + Contains details about a group of security issues that, when the + issues occur together, represent a greater risk than when the issues + occur independently. A group of such issues is referred to as a + toxic combination. This field cannot be updated. Its value is + ignored in all update requests. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2ToxicCombination' + groupMemberships: + description: >- + Contains details about groups of which this finding is a member. A + group is a collection of findings that are related in some way. This + field cannot be updated. Its value is ignored in all update + requests. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2GroupMembership' + dataAccessEvents: + description: Data access events associated with the finding. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2DataAccessEvent' + dataFlowEvents: + description: Data flow events associated with the finding. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2DataFlowEvent' GoogleCloudSecuritycenterV2SecurityMarks: id: GoogleCloudSecuritycenterV2SecurityMarks description: >- @@ -5952,6 +6373,66 @@ components: + `projects/{project_number}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks` type: string + GoogleCloudSecuritycenterV2MuteInfo: + id: GoogleCloudSecuritycenterV2MuteInfo + description: >- + Mute information about the finding, including whether the finding has a + static mute or any matching dynamic mute rules. + type: object + properties: + staticMute: + description: >- + If set, the static mute applied to this finding. Static mutes + override dynamic mutes. If unset, there is no static mute. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2StaticMute' + dynamicMuteRecords: + description: The list of dynamic mute rules that currently match the finding. + type: array + items: + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2DynamicMuteRecord' + GoogleCloudSecuritycenterV2StaticMute: + id: GoogleCloudSecuritycenterV2StaticMute + description: >- + Information about the static mute state. A static mute state overrides + any dynamic mute rules that apply to this finding. The static mute state + can be set by a static mute rule or by muting the finding directly. + type: object + properties: + state: + description: >- + The static mute state. If the value is `MUTED` or `UNMUTED`, then + the finding's overall mute state will have the same value. + type: string + enumDescriptions: + - Unspecified. + - Finding has been muted. + - Finding has been unmuted. + - Finding has never been muted/unmuted. + enum: + - MUTE_UNSPECIFIED + - MUTED + - UNMUTED + - UNDEFINED + applyTime: + description: When the static mute was applied. + type: string + format: google-datetime + GoogleCloudSecuritycenterV2DynamicMuteRecord: + id: GoogleCloudSecuritycenterV2DynamicMuteRecord + description: The record of a dynamic mute rule that matches the finding. + type: object + properties: + muteConfig: + description: >- + The relative resource name of the mute rule, represented by a mute + config, that created this record, for example + `organizations/123/muteConfigs/mymuteconfig` or + `organizations/123/locations/global/muteConfigs/mymuteconfig`. + type: string + matchTime: + description: When the dynamic mute rule first matched the finding. + type: string + format: google-datetime GoogleCloudSecuritycenterV2Indicator: id: GoogleCloudSecuritycenterV2Indicator description: >- @@ -6141,6 +6622,14 @@ components: Whether or not the vulnerability was zero day when the finding was published. type: boolean + exploitReleaseDate: + description: Date the first publicly available exploit or PoC was released. + type: string + format: google-datetime + firstExploitationDate: + description: Date of the earliest known exploitation. + type: string + format: google-datetime GoogleCloudSecuritycenterV2Reference: id: GoogleCloudSecuritycenterV2Reference description: Additional Links @@ -6424,8 +6913,10 @@ components: - T1059 - T1059.004 - T1059.006 + - T1068 - T1069 - T1069.003 + - T1070.004 - T1071 - T1071.004 - T1072 @@ -6473,7 +6964,10 @@ components: - T1588 - T1595 - T1595.001 + - T1609 + - T1611 - T1613 + - T1649 enum: - TECHNIQUE_UNSPECIFIED - MASQUERADING @@ -6485,8 +6979,10 @@ components: - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL - PYTHON + - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL_FILE_DELETION - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -6534,7 +7030,10 @@ components: - OBTAIN_CAPABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - CONTAINER_ADMINISTRATION_COMMAND + - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES additionalTactics: description: Additional MITRE ATT&CK tactics related to this finding, if any. type: array @@ -6590,8 +7089,10 @@ components: - T1059 - T1059.004 - T1059.006 + - T1068 - T1069 - T1069.003 + - T1070.004 - T1071 - T1071.004 - T1072 @@ -6639,7 +7140,10 @@ components: - T1588 - T1595 - T1595.001 + - T1609 + - T1611 - T1613 + - T1649 enum: - TECHNIQUE_UNSPECIFIED - MASQUERADING @@ -6651,8 +7155,10 @@ components: - COMMAND_AND_SCRIPTING_INTERPRETER - UNIX_SHELL - PYTHON + - EXPLOITATION_FOR_PRIVILEGE_ESCALATION - PERMISSION_GROUPS_DISCOVERY - CLOUD_GROUPS + - INDICATOR_REMOVAL_FILE_DELETION - APPLICATION_LAYER_PROTOCOL - DNS - SOFTWARE_DEPLOYMENT_TOOLS @@ -6700,7 +7206,10 @@ components: - OBTAIN_CAPABILITIES - ACTIVE_SCANNING - SCANNING_IP_BLOCKS + - CONTAINER_ADMINISTRATION_COMMAND + - ESCAPE_TO_HOST - CONTAINER_AND_RESOURCE_DISCOVERY + - STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES version: description: The MITRE ATT&CK version referenced by the above fields. E.g. "8". type: string @@ -7432,7 +7941,7 @@ components: description: >- The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: - organizations/123/simulations/456/attackExposureResults/789 + `organizations/123/simulations/456/attackExposureResults/789` type: string state: description: >- @@ -7924,6 +8433,121 @@ components: description: The most recent time the notebook was updated. type: string format: google-datetime + GoogleCloudSecuritycenterV2ToxicCombination: + id: GoogleCloudSecuritycenterV2ToxicCombination + description: >- + Contains details about a group of security issues that, when the issues + occur together, represent a greater risk than when the issues occur + independently. A group of such issues is referred to as a toxic + combination. + type: object + properties: + attackExposureScore: + description: >- + The [Attack exposure + score](https://cloud.google.com/security-command-center/docs/attack-exposure-learn#attack_exposure_scores) + of this toxic combination. The score is a measure of how much this + toxic combination exposes one or more high-value resources to + potential attack. + type: number + format: double + relatedFindings: + description: >- + List of resource names of findings associated with this toxic + combination. For example, + `organizations/123/sources/456/findings/789`. + type: array + items: + type: string + GoogleCloudSecuritycenterV2GroupMembership: + id: GoogleCloudSecuritycenterV2GroupMembership + description: >- + Contains details about groups of which this finding is a member. A group + is a collection of findings that are related in some way. + type: object + properties: + groupType: + description: Type of group. + type: string + enumDescriptions: + - Default value. + - Group represents a toxic combination. + enum: + - GROUP_TYPE_UNSPECIFIED + - GROUP_TYPE_TOXIC_COMBINATION + groupId: + description: ID of the group. + type: string + GoogleCloudSecuritycenterV2DataAccessEvent: + id: GoogleCloudSecuritycenterV2DataAccessEvent + description: >- + Details about a data access attempt made by a principal not authorized + under applicable data security policy. + type: object + properties: + eventId: + description: Unique identifier for data access event. + type: string + principalEmail: + description: >- + The email address of the principal that accessed the data. The + principal could be a user account, service account, Google group, or + other. + type: string + operation: + description: The operation performed by the principal to access the data. + type: string + enumDescriptions: + - The operation is unspecified. + - Represents a read operation. + - Represents a move operation. + - Represents a copy operation. + enum: + - OPERATION_UNSPECIFIED + - READ + - MOVE + - COPY + eventTime: + description: Timestamp of data access event. + type: string + format: google-datetime + GoogleCloudSecuritycenterV2DataFlowEvent: + id: GoogleCloudSecuritycenterV2DataFlowEvent + description: >- + Details about a data flow event, in which either the data is moved to or + is accessed from a non-compliant geo-location, as defined in the + applicable data security policy. + type: object + properties: + eventId: + description: Unique identifier for data flow event. + type: string + principalEmail: + description: >- + The email address of the principal that initiated the data flow + event. The principal could be a user account, service account, + Google group, or other. + type: string + operation: + description: The operation performed by the principal for the data flow event. + type: string + enumDescriptions: + - The operation is unspecified. + - Represents a read operation. + - Represents a move operation. + - Represents a copy operation. + enum: + - OPERATION_UNSPECIFIED + - READ + - MOVE + - COPY + violatedLocation: + description: Non-compliant location of the principal or the data destination. + type: string + eventTime: + description: Timestamp of data flow event. + type: string + format: google-datetime GoogleCloudSecuritycenterV2Resource: id: GoogleCloudSecuritycenterV2Resource description: Information related to the Google Cloud resource. @@ -7965,6 +8589,9 @@ components: awsMetadata: description: The AWS metadata associated with the finding. $ref: '#/components/schemas/GoogleCloudSecuritycenterV2AwsMetadata' + azureMetadata: + description: The Azure metadata associated with the finding. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2AzureMetadata' resourcePath: description: Provides the path to the resource within the resource hierarchy. $ref: '#/components/schemas/GoogleCloudSecuritycenterV2ResourcePath' @@ -7972,13 +8599,13 @@ components: description: >- A string representation of the resource path. For Google Cloud, it has the format of - organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} + `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of - org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} + `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of - mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} + `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. type: string GcpMetadata: @@ -8089,11 +8716,80 @@ components: properties: id: description: >- - The unique identifier (ID) of the account, containing exactly 12 - digits. - type: string - name: - description: The friendly name of this account. + The unique identifier (ID) of the account, containing exactly 12 + digits. + type: string + name: + description: The friendly name of this account. + type: string + GoogleCloudSecuritycenterV2AzureMetadata: + id: GoogleCloudSecuritycenterV2AzureMetadata + description: >- + Azure metadata associated with the resource, only applicable if the + finding's cloud provider is Microsoft Azure. + type: object + properties: + managementGroups: + description: >- + A list of Azure management groups associated with the resource, + ordered from lowest level (closest to the subscription) to highest + level. + type: array + items: + $ref: >- + #/components/schemas/GoogleCloudSecuritycenterV2AzureManagementGroup + subscription: + description: The Azure subscription associated with the resource. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2AzureSubscription' + resourceGroup: + description: The Azure resource group associated with the resource. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2AzureResourceGroup' + tenant: + description: The Azure Entra tenant associated with the resource. + $ref: '#/components/schemas/GoogleCloudSecuritycenterV2AzureTenant' + GoogleCloudSecuritycenterV2AzureManagementGroup: + id: GoogleCloudSecuritycenterV2AzureManagementGroup + description: Represents an Azure management group. + type: object + properties: + id: + description: >- + The UUID of the Azure management group, for example, + `20000000-0001-0000-0000-000000000000`. + type: string + displayName: + description: The display name of the Azure management group. + type: string + GoogleCloudSecuritycenterV2AzureSubscription: + id: GoogleCloudSecuritycenterV2AzureSubscription + description: Represents an Azure subscription. + type: object + properties: + id: + description: >- + The UUID of the Azure subscription, for example, + `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. + type: string + displayName: + description: The display name of the Azure subscription. + type: string + GoogleCloudSecuritycenterV2AzureResourceGroup: + id: GoogleCloudSecuritycenterV2AzureResourceGroup + description: Represents an Azure resource group. + type: object + properties: + name: + description: The name of the Azure resource group. This is not a UUID. + type: string + GoogleCloudSecuritycenterV2AzureTenant: + id: GoogleCloudSecuritycenterV2AzureTenant + description: Represents a Microsoft Entra tenant. + type: object + properties: + id: + description: >- + The ID of the Microsoft Entra tenant, for example, + "a11aaa11-aa11-1aa1-11aa-1aaa11a". type: string GoogleCloudSecuritycenterV2ResourcePath: id: GoogleCloudSecuritycenterV2ResourcePath @@ -8155,12 +8851,12 @@ components: type: object properties: name: - description: Name for the resource value configuration + description: Identifier. Name for the resource value configuration type: string resourceValue: description: >- Resource value level this expression represents Only required when - there is no SDP mapping in the request + there is no Sensitive Data Protection mapping in the request type: string enumDescriptions: - Unspecific value @@ -8176,9 +8872,9 @@ components: - NONE tagValues: description: >- - Required. Tag values combined with AND to check against. Values in - the form "tagValues/123" Example: [ "tagValues/123", - "tagValues/456", "tagValues/789" ] + Tag values combined with `AND` to check against. Values in the form + "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", + "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing type: array items: @@ -8186,7 +8882,7 @@ components: resourceType: description: >- Apply resource_value only to resources that match resource_type. - resource_type will be checked with AND of other resources. For + resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. @@ -8195,13 +8891,14 @@ components: description: >- Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in - "project/456" scope will be checked with AND of other resources. + "project/456" scope and will be checked with `AND` of other + resources. type: string resourceLabelsSelector: description: >- - List of resource labels to search for, evaluated with AND. For + List of resource labels to search for, evaluated with `AND`. For example, "resource_labels_selector": {"key": "value", "env": "prod"} - will match resources with labels "key": "value" AND "env": "prod" + will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels type: object additionalProperties: @@ -8718,17 +9415,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_sources_findings_list: - operation: &ref_1 + folders_sources_findings_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1sources~1{sourcesId}~1findings/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.listFindingsResults - folders_sources_findings_list: - operation: *ref_1 - response: *ref_2 folders_sources_findings_set_state: operation: $ref: >- @@ -8763,17 +9457,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_sources_findings_list: - operation: &ref_3 + projects_sources_findings_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1sources~1{sourcesId}~1findings/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.listFindingsResults - projects_sources_findings_list: - operation: *ref_3 - response: *ref_4 projects_sources_findings_set_state: operation: $ref: >- @@ -8809,17 +9500,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_sources_findings_list: - operation: &ref_5 + organizations_sources_findings_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1sources~1{sourcesId}~1findings/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.listFindingsResults - organizations_sources_findings_list: - operation: *ref_5 - response: *ref_6 organizations_sources_findings_group: operation: $ref: >- @@ -8866,6 +9554,7 @@ components: #/components/x-stackQL-resources/findings/methods/projects_sources_findings_patch - $ref: >- #/components/x-stackQL-resources/findings/methods/organizations_sources_findings_patch + replace: [] delete: [] security_health_analytics_modules: id: google.securitycenter.security_health_analytics_modules @@ -8879,17 +9568,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_security_health_analytics_settings_custom_modules_list: - operation: &ref_7 + folders_security_health_analytics_settings_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1securityHealthAnalyticsSettings~1customModules/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityHealthAnalyticsCustomModules - folders_security_health_analytics_settings_custom_modules_list: - operation: *ref_7 - response: *ref_8 folders_security_health_analytics_settings_custom_modules_delete: operation: $ref: >- @@ -8911,17 +9597,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_security_health_analytics_settings_custom_modules_list: - operation: &ref_9 + projects_security_health_analytics_settings_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1securityHealthAnalyticsSettings~1customModules/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityHealthAnalyticsCustomModules - projects_security_health_analytics_settings_custom_modules_list: - operation: *ref_9 - response: *ref_10 projects_security_health_analytics_settings_custom_modules_delete: operation: $ref: >- @@ -8943,17 +9626,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_security_health_analytics_settings_custom_modules_list: - operation: &ref_11 + organizations_security_health_analytics_settings_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1securityHealthAnalyticsSettings~1customModules/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityHealthAnalyticsCustomModules - organizations_security_health_analytics_settings_custom_modules_list: - operation: *ref_11 - response: *ref_12 organizations_security_health_analytics_settings_custom_modules_delete: operation: $ref: >- @@ -8990,6 +9670,7 @@ components: - $ref: >- #/components/x-stackQL-resources/security_health_analytics_modules/methods/organizations_security_health_analytics_settings_custom_modules_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/security_health_analytics_modules/methods/folders_security_health_analytics_settings_custom_modules_delete @@ -9108,78 +9789,61 @@ components: #/components/x-stackQL-resources/custom_modules/methods/organizations_security_health_analytics_settings_custom_modules_patch - $ref: >- #/components/x-stackQL-resources/custom_modules/methods/organizations_event_threat_detection_settings_custom_modules_patch + replace: [] delete: [] custom_modules_descendant: id: google.securitycenter.custom_modules_descendant name: custom_modules_descendant title: Custom_modules_descendant methods: - _folders_security_health_analytics_settings_custom_modules_list_descendant: - operation: &ref_13 + folders_security_health_analytics_settings_custom_modules_list_descendant: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1securityHealthAnalyticsSettings~1customModules:listDescendant/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityHealthAnalyticsCustomModules - folders_security_health_analytics_settings_custom_modules_list_descendant: - operation: *ref_13 - response: *ref_14 - _folders_event_threat_detection_settings_custom_modules_list_descendant: - operation: &ref_15 + folders_event_threat_detection_settings_custom_modules_list_descendant: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1eventThreatDetectionSettings~1customModules:listDescendant/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.eventThreatDetectionCustomModules - folders_event_threat_detection_settings_custom_modules_list_descendant: - operation: *ref_15 - response: *ref_16 - _projects_security_health_analytics_settings_custom_modules_list_descendant: - operation: &ref_17 + projects_security_health_analytics_settings_custom_modules_list_descendant: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1securityHealthAnalyticsSettings~1customModules:listDescendant/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityHealthAnalyticsCustomModules - projects_security_health_analytics_settings_custom_modules_list_descendant: - operation: *ref_17 - response: *ref_18 - _projects_event_threat_detection_settings_custom_modules_list_descendant: - operation: &ref_19 + projects_event_threat_detection_settings_custom_modules_list_descendant: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1eventThreatDetectionSettings~1customModules:listDescendant/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.eventThreatDetectionCustomModules - projects_event_threat_detection_settings_custom_modules_list_descendant: - operation: *ref_19 - response: *ref_20 - _organizations_security_health_analytics_settings_custom_modules_list_descendant: - operation: &ref_21 + organizations_security_health_analytics_settings_custom_modules_list_descendant: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1securityHealthAnalyticsSettings~1customModules:listDescendant/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.securityHealthAnalyticsCustomModules - organizations_security_health_analytics_settings_custom_modules_list_descendant: - operation: *ref_21 - response: *ref_22 - _organizations_event_threat_detection_settings_custom_modules_list_descendant: - operation: &ref_23 + organizations_event_threat_detection_settings_custom_modules_list_descendant: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1eventThreatDetectionSettings~1customModules:listDescendant/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.eventThreatDetectionCustomModules - organizations_event_threat_detection_settings_custom_modules_list_descendant: - operation: *ref_23 - response: *ref_24 sqlVerbs: select: - $ref: >- @@ -9196,6 +9860,7 @@ components: #/components/x-stackQL-resources/custom_modules_descendant/methods/organizations_event_threat_detection_settings_custom_modules_list_descendant insert: [] update: [] + replace: [] delete: [] effective_custom_modules: id: google.securitycenter.effective_custom_modules @@ -9209,17 +9874,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_security_health_analytics_settings_effective_custom_modules_list: - operation: &ref_25 + folders_security_health_analytics_settings_effective_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1securityHealthAnalyticsSettings~1effectiveCustomModules/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.effectiveSecurityHealthAnalyticsCustomModules - folders_security_health_analytics_settings_effective_custom_modules_list: - operation: *ref_25 - response: *ref_26 folders_event_threat_detection_settings_effective_custom_modules_get: operation: $ref: >- @@ -9227,17 +9889,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_event_threat_detection_settings_effective_custom_modules_list: - operation: &ref_27 + folders_event_threat_detection_settings_effective_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1eventThreatDetectionSettings~1effectiveCustomModules/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.effectiveEventThreatDetectionCustomModules - folders_event_threat_detection_settings_effective_custom_modules_list: - operation: *ref_27 - response: *ref_28 projects_security_health_analytics_settings_effective_custom_modules_get: operation: $ref: >- @@ -9245,17 +9904,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_security_health_analytics_settings_effective_custom_modules_list: - operation: &ref_29 + projects_security_health_analytics_settings_effective_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1securityHealthAnalyticsSettings~1effectiveCustomModules/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.effectiveSecurityHealthAnalyticsCustomModules - projects_security_health_analytics_settings_effective_custom_modules_list: - operation: *ref_29 - response: *ref_30 projects_event_threat_detection_settings_effective_custom_modules_get: operation: $ref: >- @@ -9263,17 +9919,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_event_threat_detection_settings_effective_custom_modules_list: - operation: &ref_31 + projects_event_threat_detection_settings_effective_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1eventThreatDetectionSettings~1effectiveCustomModules/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.effectiveEventThreatDetectionCustomModules - projects_event_threat_detection_settings_effective_custom_modules_list: - operation: *ref_31 - response: *ref_32 organizations_security_health_analytics_settings_effective_custom_modules_get: operation: $ref: >- @@ -9281,17 +9934,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_security_health_analytics_settings_effective_custom_modules_list: - operation: &ref_33 + organizations_security_health_analytics_settings_effective_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1securityHealthAnalyticsSettings~1effectiveCustomModules/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.effectiveSecurityHealthAnalyticsCustomModules - organizations_security_health_analytics_settings_effective_custom_modules_list: - operation: *ref_33 - response: *ref_34 organizations_event_threat_detection_settings_effective_custom_modules_get: operation: $ref: >- @@ -9299,17 +9949,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_event_threat_detection_settings_effective_custom_modules_list: - operation: &ref_35 + organizations_event_threat_detection_settings_effective_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1eventThreatDetectionSettings~1effectiveCustomModules/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.effectiveEventThreatDetectionCustomModules - organizations_event_threat_detection_settings_effective_custom_modules_list: - operation: *ref_35 - response: *ref_36 sqlVerbs: select: - $ref: >- @@ -9338,6 +9985,7 @@ components: #/components/x-stackQL-resources/effective_custom_modules/methods/organizations_event_threat_detection_settings_effective_custom_modules_list insert: [] update: [] + replace: [] delete: [] mute_configs: id: google.securitycenter.mute_configs @@ -9350,16 +9998,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_mute_configs_list: - operation: &ref_37 + folders_mute_configs_list: + operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1muteConfigs/get' - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.muteConfigs - folders_mute_configs_list: - operation: *ref_37 - response: *ref_38 folders_mute_configs_delete: operation: $ref: >- @@ -9388,17 +10033,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_locations_mute_configs_list: - operation: &ref_39 + folders_locations_mute_configs_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1locations~1{locationsId}~1muteConfigs/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.muteConfigs - folders_locations_mute_configs_list: - operation: *ref_39 - response: *ref_40 folders_locations_mute_configs_delete: operation: $ref: >- @@ -9426,16 +10068,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_mute_configs_list: - operation: &ref_41 + projects_mute_configs_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1muteConfigs/get' - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.muteConfigs - projects_mute_configs_list: - operation: *ref_41 - response: *ref_42 projects_mute_configs_delete: operation: $ref: >- @@ -9464,17 +10103,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_mute_configs_list: - operation: &ref_43 + projects_locations_mute_configs_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1muteConfigs/get - response: &ref_44 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.muteConfigs - projects_locations_mute_configs_list: - operation: *ref_43 - response: *ref_44 projects_locations_mute_configs_delete: operation: $ref: >- @@ -9502,16 +10138,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_mute_configs_list: - operation: &ref_45 + organizations_mute_configs_list: + operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1muteConfigs/get' - response: &ref_46 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.muteConfigs - organizations_mute_configs_list: - operation: *ref_45 - response: *ref_46 organizations_mute_configs_delete: operation: $ref: >- @@ -9540,17 +10173,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_locations_mute_configs_list: - operation: &ref_47 + organizations_locations_mute_configs_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1locations~1{locationsId}~1muteConfigs/get - response: &ref_48 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.muteConfigs - organizations_locations_mute_configs_list: - operation: *ref_47 - response: *ref_48 organizations_locations_mute_configs_delete: operation: $ref: >- @@ -9624,6 +10254,7 @@ components: #/components/x-stackQL-resources/mute_configs/methods/projects_mute_configs_patch - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/organizations_mute_configs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/mute_configs/methods/folders_locations_mute_configs_delete @@ -9648,16 +10279,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_notification_configs_list: - operation: &ref_49 + folders_notification_configs_list: + operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1notificationConfigs/get' - response: &ref_50 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.notificationConfigs - folders_notification_configs_list: - operation: *ref_49 - response: *ref_50 folders_notification_configs_delete: operation: $ref: >- @@ -9685,16 +10313,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_notification_configs_list: - operation: &ref_51 + projects_notification_configs_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1notificationConfigs/get' - response: &ref_52 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.notificationConfigs - projects_notification_configs_list: - operation: *ref_51 - response: *ref_52 projects_notification_configs_delete: operation: $ref: >- @@ -9723,17 +10348,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_notification_configs_list: - operation: &ref_53 + organizations_notification_configs_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1notificationConfigs/get - response: &ref_54 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.notificationConfigs - organizations_notification_configs_list: - operation: *ref_53 - response: *ref_54 organizations_notification_configs_delete: operation: $ref: >- @@ -9783,6 +10405,7 @@ components: #/components/x-stackQL-resources/notification_configs/methods/projects_notification_configs_patch - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/organizations_notification_configs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/notification_configs/methods/folders_notification_configs_delete @@ -9822,16 +10445,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_big_query_exports_list: - operation: &ref_55 + folders_big_query_exports_list: + operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1bigQueryExports/get' - response: &ref_56 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bigQueryExports - folders_big_query_exports_list: - operation: *ref_55 - response: *ref_56 projects_big_query_exports_get: operation: $ref: >- @@ -9859,16 +10479,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_big_query_exports_list: - operation: &ref_57 + projects_big_query_exports_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1bigQueryExports/get' - response: &ref_58 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bigQueryExports - projects_big_query_exports_list: - operation: *ref_57 - response: *ref_58 organizations_big_query_exports_get: operation: $ref: >- @@ -9897,17 +10514,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_big_query_exports_list: - operation: &ref_59 + organizations_big_query_exports_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1bigQueryExports/get - response: &ref_60 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bigQueryExports - organizations_big_query_exports_list: - operation: *ref_59 - response: *ref_60 sqlVerbs: select: - $ref: >- @@ -9936,6 +10550,7 @@ components: #/components/x-stackQL-resources/big_query_exports/methods/projects_big_query_exports_patch - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/organizations_big_query_exports_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/big_query_exports/methods/folders_big_query_exports_delete @@ -9954,48 +10569,39 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_assets_list: - operation: &ref_61 + folders_assets_list: + operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1assets/get' - response: &ref_62 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.listAssetsResults - folders_assets_list: - operation: *ref_61 - response: *ref_62 projects_assets_group: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1assets:group/post' response: mediaType: application/json openAPIDocKey: '200' - _projects_assets_list: - operation: &ref_63 + projects_assets_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1assets/get' - response: &ref_64 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.listAssetsResults - projects_assets_list: - operation: *ref_63 - response: *ref_64 organizations_assets_group: operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1assets:group/post' response: mediaType: application/json openAPIDocKey: '200' - _organizations_assets_list: - operation: &ref_65 + organizations_assets_list: + operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1assets/get' - response: &ref_66 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.listAssetsResults - organizations_assets_list: - operation: *ref_65 - response: *ref_66 organizations_assets_run_discovery: operation: $ref: >- @@ -10013,6 +10619,7 @@ components: #/components/x-stackQL-resources/assets/methods/organizations_assets_list insert: [] update: [] + replace: [] delete: [] assets_security_marks: id: google.securitycenter.assets_security_marks @@ -10043,49 +10650,47 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/assets_security_marks/methods/folders_assets_update_security_marks + - $ref: >- + #/components/x-stackQL-resources/assets_security_marks/methods/projects_assets_update_security_marks + - $ref: >- + #/components/x-stackQL-resources/assets_security_marks/methods/organizations_assets_update_security_marks + replace: [] delete: [] sources: id: google.securitycenter.sources name: sources title: Sources methods: - _folders_sources_list: - operation: &ref_67 + folders_sources_list: + operation: $ref: '#/paths/~1v1~1folders~1{foldersId}~1sources/get' - response: &ref_68 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sources - folders_sources_list: - operation: *ref_67 - response: *ref_68 - _projects_sources_list: - operation: &ref_69 + projects_sources_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1sources/get' - response: &ref_70 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sources - projects_sources_list: - operation: *ref_69 - response: *ref_70 organizations_sources_create: operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sources/post' response: mediaType: application/json openAPIDocKey: '200' - _organizations_sources_list: - operation: &ref_71 + organizations_sources_list: + operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1sources/get' - response: &ref_72 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sources - organizations_sources_list: - operation: *ref_71 - response: *ref_72 organizations_sources_get: operation: $ref: >- @@ -10116,6 +10721,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/sources/methods/organizations_sources_patch + replace: [] delete: [] findings_security_marks: id: google.securitycenter.findings_security_marks @@ -10146,7 +10752,14 @@ components: sqlVerbs: select: [] insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/findings_security_marks/methods/folders_sources_findings_update_security_marks + - $ref: >- + #/components/x-stackQL-resources/findings_security_marks/methods/projects_sources_findings_update_security_marks + - $ref: >- + #/components/x-stackQL-resources/findings_security_marks/methods/organizations_sources_findings_update_security_marks + replace: [] delete: [] external_systems: id: google.securitycenter.external_systems @@ -10184,6 +10797,7 @@ components: #/components/x-stackQL-resources/external_systems/methods/projects_sources_findings_external_systems_patch - $ref: >- #/components/x-stackQL-resources/external_systems/methods/organizations_sources_findings_external_systems_patch + replace: [] delete: [] event_threat_detection_settings: id: google.securitycenter.event_threat_detection_settings @@ -10215,6 +10829,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] event_threat_detection_modules: id: google.securitycenter.event_threat_detection_modules @@ -10228,17 +10843,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _folders_event_threat_detection_settings_custom_modules_list: - operation: &ref_73 + folders_event_threat_detection_settings_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1folders~1{foldersId}~1eventThreatDetectionSettings~1customModules/get - response: &ref_74 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.eventThreatDetectionCustomModules - folders_event_threat_detection_settings_custom_modules_list: - operation: *ref_73 - response: *ref_74 folders_event_threat_detection_settings_custom_modules_delete: operation: $ref: >- @@ -10253,17 +10865,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_event_threat_detection_settings_custom_modules_list: - operation: &ref_75 + projects_event_threat_detection_settings_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1eventThreatDetectionSettings~1customModules/get - response: &ref_76 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.eventThreatDetectionCustomModules - projects_event_threat_detection_settings_custom_modules_list: - operation: *ref_75 - response: *ref_76 projects_event_threat_detection_settings_custom_modules_delete: operation: $ref: >- @@ -10278,17 +10887,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_event_threat_detection_settings_custom_modules_list: - operation: &ref_77 + organizations_event_threat_detection_settings_custom_modules_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1eventThreatDetectionSettings~1customModules/get - response: &ref_78 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.eventThreatDetectionCustomModules - organizations_event_threat_detection_settings_custom_modules_list: - operation: *ref_77 - response: *ref_78 organizations_event_threat_detection_settings_custom_modules_delete: operation: $ref: >- @@ -10312,6 +10918,7 @@ components: - $ref: >- #/components/x-stackQL-resources/event_threat_detection_modules/methods/organizations_event_threat_detection_settings_custom_modules_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/event_threat_detection_modules/methods/folders_event_threat_detection_settings_custom_modules_delete @@ -10343,23 +10950,23 @@ components: - $ref: >- #/components/x-stackQL-resources/organization_settings/methods/organizations_get_organization_settings insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/organization_settings/methods/organizations_update_organization_settings + replace: [] delete: [] operations: id: google.securitycenter.operations name: operations title: Operations methods: - _organizations_operations_list: - operation: &ref_79 + organizations_operations_list: + operation: $ref: '#/paths/~1v1~1organizations~1{organizationsId}~1operations/get' - response: &ref_80 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - organizations_operations_list: - operation: *ref_79 - response: *ref_80 organizations_operations_get: operation: $ref: >- @@ -10389,6 +10996,7 @@ components: #/components/x-stackQL-resources/operations/methods/organizations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/organizations_operations_delete @@ -10397,17 +11005,14 @@ components: name: sources_iam_policies title: Sources_iam_policies methods: - _organizations_sources_get_iam_policy: - operation: &ref_81 + organizations_sources_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1sources~1{sourcesId}:getIamPolicy/post - response: &ref_82 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - organizations_sources_get_iam_policy: - operation: *ref_81 - response: *ref_82 organizations_sources_set_iam_policy: operation: $ref: >- @@ -10428,6 +11033,9 @@ components: #/components/x-stackQL-resources/sources_iam_policies/methods/organizations_sources_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/sources_iam_policies/methods/organizations_sources_set_iam_policy delete: [] simulations: id: google.securitycenter.simulations @@ -10447,6 +11055,7 @@ components: #/components/x-stackQL-resources/simulations/methods/organizations_simulations_get insert: [] update: [] + replace: [] delete: [] valued_resources: id: google.securitycenter.valued_resources @@ -10460,28 +11069,30 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_simulations_valued_resources_list: - operation: &ref_83 + organizations_simulations_valued_resources_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1simulations~1{simulationsId}~1valuedResources/get - response: &ref_84 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.valuedResources - organizations_simulations_valued_resources_list: - operation: *ref_83 - response: *ref_84 - _organizations_simulations_attack_exposure_results_valued_resources_list: - operation: &ref_85 + organizations_simulations_attack_exposure_results_valued_resources_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1simulations~1{simulationsId}~1attackExposureResults~1{attackExposureResultsId}~1valuedResources/get - response: &ref_86 + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.valuedResources + organizations_valued_resources_list: + operation: + $ref: >- + #/paths/~1v1~1organizations~1{organizationsId}~1valuedResources/get + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.valuedResources - organizations_simulations_attack_exposure_results_valued_resources_list: - operation: *ref_85 - response: *ref_86 sqlVerbs: select: - $ref: >- @@ -10490,47 +11101,41 @@ components: #/components/x-stackQL-resources/valued_resources/methods/organizations_simulations_attack_exposure_results_valued_resources_list - $ref: >- #/components/x-stackQL-resources/valued_resources/methods/organizations_simulations_valued_resources_list + - $ref: >- + #/components/x-stackQL-resources/valued_resources/methods/organizations_valued_resources_list insert: [] update: [] + replace: [] delete: [] attack_paths: id: google.securitycenter.attack_paths name: attack_paths title: Attack_paths methods: - _organizations_simulations_valued_resources_attack_paths_list: - operation: &ref_87 + organizations_simulations_valued_resources_attack_paths_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1simulations~1{simulationsId}~1valuedResources~1{valuedResourcesId}~1attackPaths/get - response: &ref_88 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.attackPaths - organizations_simulations_valued_resources_attack_paths_list: - operation: *ref_87 - response: *ref_88 - _organizations_simulations_attack_exposure_results_attack_paths_list: - operation: &ref_89 + organizations_simulations_attack_exposure_results_attack_paths_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1simulations~1{simulationsId}~1attackExposureResults~1{attackExposureResultsId}~1attackPaths/get - response: &ref_90 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.attackPaths - organizations_simulations_attack_exposure_results_attack_paths_list: - operation: *ref_89 - response: *ref_90 - _organizations_simulations_attack_paths_list: - operation: &ref_91 + organizations_simulations_attack_paths_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1simulations~1{simulationsId}~1attackPaths/get - response: &ref_92 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.attackPaths - organizations_simulations_attack_paths_list: - operation: *ref_91 - response: *ref_92 sqlVerbs: select: - $ref: >- @@ -10541,6 +11146,7 @@ components: #/components/x-stackQL-resources/attack_paths/methods/organizations_simulations_attack_paths_list insert: [] update: [] + replace: [] delete: [] resource_value_configs: id: google.securitycenter.resource_value_configs @@ -10575,33 +11181,33 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _organizations_resource_value_configs_list: - operation: &ref_93 + organizations_resource_value_configs_list: + operation: $ref: >- #/paths/~1v1~1organizations~1{organizationsId}~1resourceValueConfigs/get - response: &ref_94 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.resourceValueConfigs - organizations_resource_value_configs_list: - operation: *ref_93 - response: *ref_94 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_get - $ref: >- #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_list - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_batch_create update: - $ref: >- #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/resource_value_configs/methods/organizations_resource_value_configs_delete paths: /v1/folders/{foldersId}/findings:bulkMute: - parameters: &ref_95 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -10643,7 +11249,7 @@ paths: schema: type: string /v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a resident SecurityHealthAnalyticsCustomModule at the scope of @@ -10713,7 +11319,7 @@ paths: schema: type: string /v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules/{customModulesId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: >- Deletes the specified SecurityHealthAnalyticsCustomModule and all of its @@ -10817,7 +11423,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules:listDescendant: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Returns a list of all resident SecurityHealthAnalyticsCustomModules @@ -10853,7 +11459,7 @@ paths: schema: type: string /v1/folders/{foldersId}/securityHealthAnalyticsSettings/customModules:simulate: - parameters: *ref_95 + parameters: *ref_1 post: description: Simulates a given SecurityHealthAnalyticsCustomModule and Resource. operationId: >- @@ -10884,7 +11490,7 @@ paths: schema: type: string /v1/folders/{foldersId}/securityHealthAnalyticsSettings/effectiveCustomModules/{effectiveCustomModulesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Retrieves an EffectiveSecurityHealthAnalyticsCustomModule. operationId: >- @@ -10914,7 +11520,7 @@ paths: schema: type: string /v1/folders/{foldersId}/securityHealthAnalyticsSettings/effectiveCustomModules: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for @@ -10951,7 +11557,7 @@ paths: schema: type: string /v1/folders/{foldersId}/muteConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a mute config. operationId: securitycenter.folders.muteConfigs.create @@ -11013,7 +11619,7 @@ paths: schema: type: string /v1/folders/{foldersId}/muteConfigs/{muteConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes an existing mute config. operationId: securitycenter.folders.muteConfigs.delete @@ -11103,7 +11709,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/locations/{locationsId}/muteConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a mute config. operationId: securitycenter.folders.locations.muteConfigs.create @@ -11175,7 +11781,7 @@ paths: schema: type: string /v1/folders/{foldersId}/locations/{locationsId}/muteConfigs/{muteConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes an existing mute config. operationId: securitycenter.folders.locations.muteConfigs.delete @@ -11280,7 +11886,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/notificationConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a notification config. operationId: securitycenter.folders.notificationConfigs.create @@ -11342,7 +11948,7 @@ paths: type: integer format: int32 /v1/folders/{foldersId}/notificationConfigs/{notificationConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes a notification config. operationId: securitycenter.folders.notificationConfigs.delete @@ -11432,7 +12038,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/bigQueryExports/{bigQueryExportsId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Gets a BigQuery export. operationId: securitycenter.folders.bigQueryExports.get @@ -11522,7 +12128,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/bigQueryExports: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a BigQuery export. operationId: securitycenter.folders.bigQueryExports.create @@ -11589,7 +12195,7 @@ paths: schema: type: string /v1/folders/{foldersId}/assets:group: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Filters an organization's assets and groups them by their specified @@ -11619,7 +12225,7 @@ paths: schema: type: string /v1/folders/{foldersId}/assets: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists an organization's assets. operationId: securitycenter.folders.assets.list @@ -11674,7 +12280,7 @@ paths: type: integer format: int32 /v1/folders/{foldersId}/assets/{assetsId}/securityMarks: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates security marks. operationId: securitycenter.folders.assets.updateSecurityMarks @@ -11717,7 +12323,7 @@ paths: type: string format: google-datetime /v1/folders/{foldersId}/sources: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists all sources belonging to an organization. operationId: securitycenter.folders.sources.list @@ -11749,7 +12355,7 @@ paths: type: integer format: int32 /v1/folders/{foldersId}/sources/{sourcesId}/findings:group: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Filters an organization or source's findings and groups them by their @@ -11788,7 +12394,7 @@ paths: schema: type: string /v1/folders/{foldersId}/sources/{sourcesId}/findings: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists an organization or source's findings. To list across all sources @@ -11851,7 +12457,7 @@ paths: type: integer format: int32 /v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}:setState: - parameters: *ref_95 + parameters: *ref_1 post: description: Updates the state of a finding. operationId: securitycenter.folders.sources.findings.setState @@ -11889,7 +12495,7 @@ paths: schema: type: string /v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}:setMute: - parameters: *ref_95 + parameters: *ref_1 post: description: Updates the mute state of a finding. operationId: securitycenter.folders.sources.findings.setMute @@ -11927,7 +12533,7 @@ paths: schema: type: string /v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}: - parameters: *ref_95 + parameters: *ref_1 patch: description: >- Creates or updates a finding. The corresponding source must exist for a @@ -11972,7 +12578,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}/securityMarks: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates security marks. operationId: securitycenter.folders.sources.findings.updateSecurityMarks @@ -12020,7 +12626,7 @@ paths: type: string format: google-datetime /v1/folders/{foldersId}/sources/{sourcesId}/findings/{findingsId}/externalSystems/{externalSystemsId}: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates external system. This is for a given finding. operationId: securitycenter.folders.sources.findings.externalSystems.patch @@ -12068,7 +12674,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/eventThreatDetectionSettings:validateCustomModule: - parameters: *ref_95 + parameters: *ref_1 post: description: Validates the given Event Threat Detection custom module. operationId: securitycenter.folders.eventThreatDetectionSettings.validateCustomModule @@ -12098,7 +12704,7 @@ paths: schema: type: string /v1/folders/{foldersId}/eventThreatDetectionSettings/customModules: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a resident Event Threat Detection custom module at the scope of @@ -12164,7 +12770,7 @@ paths: type: integer format: int32 /v1/folders/{foldersId}/eventThreatDetectionSettings/customModules/{customModulesId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: >- Deletes the specified Event Threat Detection custom module and all of @@ -12263,7 +12869,7 @@ paths: type: string format: google-fieldmask /v1/folders/{foldersId}/eventThreatDetectionSettings/customModules:listDescendant: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists all resident Event Threat Detection custom modules under the given @@ -12299,7 +12905,7 @@ paths: type: integer format: int32 /v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Gets an effective Event Threat Detection custom module at the given @@ -12330,7 +12936,7 @@ paths: schema: type: string /v1/folders/{foldersId}/eventThreatDetectionSettings/effectiveCustomModules: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists all effective Event Threat Detection custom modules for the given @@ -12367,7 +12973,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/findings:bulkMute: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Kicks off an LRO to bulk mute findings for a parent based on a filter. @@ -12398,7 +13004,7 @@ paths: schema: type: string /v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a resident SecurityHealthAnalyticsCustomModule at the scope of @@ -12468,7 +13074,7 @@ paths: schema: type: string /v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: >- Deletes the specified SecurityHealthAnalyticsCustomModule and all of its @@ -12573,7 +13179,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules:listDescendant: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Returns a list of all resident SecurityHealthAnalyticsCustomModules @@ -12609,7 +13215,7 @@ paths: schema: type: string /v1/projects/{projectsId}/securityHealthAnalyticsSettings/customModules:simulate: - parameters: *ref_95 + parameters: *ref_1 post: description: Simulates a given SecurityHealthAnalyticsCustomModule and Resource. operationId: >- @@ -12640,7 +13246,7 @@ paths: schema: type: string /v1/projects/{projectsId}/securityHealthAnalyticsSettings/effectiveCustomModules/{effectiveCustomModulesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Retrieves an EffectiveSecurityHealthAnalyticsCustomModule. operationId: >- @@ -12670,7 +13276,7 @@ paths: schema: type: string /v1/projects/{projectsId}/securityHealthAnalyticsSettings/effectiveCustomModules: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for @@ -12707,7 +13313,7 @@ paths: schema: type: string /v1/projects/{projectsId}/muteConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a mute config. operationId: securitycenter.projects.muteConfigs.create @@ -12769,7 +13375,7 @@ paths: schema: type: string /v1/projects/{projectsId}/muteConfigs/{muteConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes an existing mute config. operationId: securitycenter.projects.muteConfigs.delete @@ -12859,7 +13465,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/muteConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a mute config. operationId: securitycenter.projects.locations.muteConfigs.create @@ -12931,7 +13537,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes an existing mute config. operationId: securitycenter.projects.locations.muteConfigs.delete @@ -13036,7 +13642,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/notificationConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a notification config. operationId: securitycenter.projects.notificationConfigs.create @@ -13098,7 +13704,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/notificationConfigs/{notificationConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes a notification config. operationId: securitycenter.projects.notificationConfigs.delete @@ -13188,7 +13794,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/bigQueryExports/{bigQueryExportsId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Gets a BigQuery export. operationId: securitycenter.projects.bigQueryExports.get @@ -13278,7 +13884,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/bigQueryExports: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a BigQuery export. operationId: securitycenter.projects.bigQueryExports.create @@ -13345,7 +13951,7 @@ paths: schema: type: string /v1/projects/{projectsId}/assets:group: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Filters an organization's assets and groups them by their specified @@ -13375,7 +13981,7 @@ paths: schema: type: string /v1/projects/{projectsId}/assets: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists an organization's assets. operationId: securitycenter.projects.assets.list @@ -13430,7 +14036,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/assets/{assetsId}/securityMarks: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates security marks. operationId: securitycenter.projects.assets.updateSecurityMarks @@ -13473,7 +14079,7 @@ paths: type: string format: google-datetime /v1/projects/{projectsId}/sources: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists all sources belonging to an organization. operationId: securitycenter.projects.sources.list @@ -13505,7 +14111,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/sources/{sourcesId}/findings:group: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Filters an organization or source's findings and groups them by their @@ -13544,7 +14150,7 @@ paths: schema: type: string /v1/projects/{projectsId}/sources/{sourcesId}/findings: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists an organization or source's findings. To list across all sources @@ -13607,7 +14213,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}:setState: - parameters: *ref_95 + parameters: *ref_1 post: description: Updates the state of a finding. operationId: securitycenter.projects.sources.findings.setState @@ -13645,7 +14251,7 @@ paths: schema: type: string /v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}:setMute: - parameters: *ref_95 + parameters: *ref_1 post: description: Updates the mute state of a finding. operationId: securitycenter.projects.sources.findings.setMute @@ -13683,7 +14289,7 @@ paths: schema: type: string /v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}: - parameters: *ref_95 + parameters: *ref_1 patch: description: >- Creates or updates a finding. The corresponding source must exist for a @@ -13728,7 +14334,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}/securityMarks: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates security marks. operationId: securitycenter.projects.sources.findings.updateSecurityMarks @@ -13776,7 +14382,7 @@ paths: type: string format: google-datetime /v1/projects/{projectsId}/sources/{sourcesId}/findings/{findingsId}/externalSystems/{externalSystemsId}: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates external system. This is for a given finding. operationId: securitycenter.projects.sources.findings.externalSystems.patch @@ -13824,7 +14430,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/eventThreatDetectionSettings:validateCustomModule: - parameters: *ref_95 + parameters: *ref_1 post: description: Validates the given Event Threat Detection custom module. operationId: >- @@ -13855,7 +14461,7 @@ paths: schema: type: string /v1/projects/{projectsId}/eventThreatDetectionSettings/customModules: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a resident Event Threat Detection custom module at the scope of @@ -13922,7 +14528,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/eventThreatDetectionSettings/customModules/{customModulesId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: >- Deletes the specified Event Threat Detection custom module and all of @@ -14022,7 +14628,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/eventThreatDetectionSettings/customModules:listDescendant: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists all resident Event Threat Detection custom modules under the given @@ -14058,7 +14664,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Gets an effective Event Threat Detection custom module at the given @@ -14089,7 +14695,7 @@ paths: schema: type: string /v1/projects/{projectsId}/eventThreatDetectionSettings/effectiveCustomModules: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists all effective Event Threat Detection custom modules for the given @@ -14126,7 +14732,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/organizationSettings: - parameters: *ref_95 + parameters: *ref_1 get: description: Gets the settings for an organization. operationId: securitycenter.organizations.getOrganizationSettings @@ -14180,7 +14786,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/operations: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -14218,7 +14824,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/operations/{operationsId}: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -14279,7 +14885,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/operations/{operationsId}:cancel: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -14316,7 +14922,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/findings:bulkMute: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Kicks off an LRO to bulk mute findings for a parent based on a filter. @@ -14347,7 +14953,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a resident SecurityHealthAnalyticsCustomModule at the scope of @@ -14417,7 +15023,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules/{customModulesId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: >- Deletes the specified SecurityHealthAnalyticsCustomModule and all of its @@ -14522,7 +15128,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules:listDescendant: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Returns a list of all resident SecurityHealthAnalyticsCustomModules @@ -14558,7 +15164,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/customModules:simulate: - parameters: *ref_95 + parameters: *ref_1 post: description: Simulates a given SecurityHealthAnalyticsCustomModule and Resource. operationId: >- @@ -14589,7 +15195,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/effectiveCustomModules/{effectiveCustomModulesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Retrieves an EffectiveSecurityHealthAnalyticsCustomModule. operationId: >- @@ -14619,7 +15225,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/securityHealthAnalyticsSettings/effectiveCustomModules: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for @@ -14656,7 +15262,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/sources: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a source. operationId: securitycenter.organizations.sources.create @@ -14714,7 +15320,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/sources/{sourcesId}:getIamPolicy: - parameters: *ref_95 + parameters: *ref_1 post: description: Gets the access control policy on the specified Source. operationId: securitycenter.organizations.sources.getIamPolicy @@ -14747,7 +15353,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/sources/{sourcesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Gets a source. operationId: securitycenter.organizations.sources.get @@ -14811,7 +15417,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/sources/{sourcesId}:setIamPolicy: - parameters: *ref_95 + parameters: *ref_1 post: description: Sets the access control policy on the specified Source. operationId: securitycenter.organizations.sources.setIamPolicy @@ -14844,7 +15450,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/sources/{sourcesId}:testIamPermissions: - parameters: *ref_95 + parameters: *ref_1 post: description: Returns the permissions that a caller has on the specified source. operationId: securitycenter.organizations.sources.testIamPermissions @@ -14877,7 +15483,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/sources/{sourcesId}/findings: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a finding. The corresponding source must exist for finding @@ -14977,7 +15583,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/sources/{sourcesId}/findings:group: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Filters an organization or source's findings and groups them by their @@ -15016,7 +15622,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}:setState: - parameters: *ref_95 + parameters: *ref_1 post: description: Updates the state of a finding. operationId: securitycenter.organizations.sources.findings.setState @@ -15054,7 +15660,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}:setMute: - parameters: *ref_95 + parameters: *ref_1 post: description: Updates the mute state of a finding. operationId: securitycenter.organizations.sources.findings.setMute @@ -15092,7 +15698,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}: - parameters: *ref_95 + parameters: *ref_1 patch: description: >- Creates or updates a finding. The corresponding source must exist for a @@ -15137,7 +15743,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}/securityMarks: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates security marks. operationId: securitycenter.organizations.sources.findings.updateSecurityMarks @@ -15185,7 +15791,7 @@ paths: type: string format: google-datetime /v1/organizations/{organizationsId}/sources/{sourcesId}/findings/{findingsId}/externalSystems/{externalSystemsId}: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates external system. This is for a given finding. operationId: securitycenter.organizations.sources.findings.externalSystems.patch @@ -15233,7 +15839,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/muteConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a mute config. operationId: securitycenter.organizations.muteConfigs.create @@ -15295,7 +15901,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/muteConfigs/{muteConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes an existing mute config. operationId: securitycenter.organizations.muteConfigs.delete @@ -15385,7 +15991,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a mute config. operationId: securitycenter.organizations.locations.muteConfigs.create @@ -15457,7 +16063,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes an existing mute config. operationId: securitycenter.organizations.locations.muteConfigs.delete @@ -15562,7 +16168,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/notificationConfigs: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a notification config. operationId: securitycenter.organizations.notificationConfigs.create @@ -15624,7 +16230,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/notificationConfigs/{notificationConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes a notification config. operationId: securitycenter.organizations.notificationConfigs.delete @@ -15714,7 +16320,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/simulations/{simulationsId}: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Get the simulation by name or the latest simulation for the given @@ -15744,7 +16350,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/simulations/{simulationsId}/valuedResources/{valuedResourcesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Get the valued resource by name operationId: securitycenter.organizations.simulations.valuedResources.get @@ -15777,7 +16383,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/simulations/{simulationsId}/valuedResources: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists the valued resources for a set of simulation results and filter. operationId: securitycenter.organizations.simulations.valuedResources.list @@ -15822,7 +16428,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/simulations/{simulationsId}/valuedResources/{valuedResourcesId}/attackPaths: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists the attack paths for a set of simulation results or valued @@ -15871,7 +16477,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/simulations/{simulationsId}/attackExposureResults/{attackExposureResultsId}/valuedResources: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists the valued resources for a set of simulation results and filter. operationId: >- @@ -15922,7 +16528,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/simulations/{simulationsId}/attackExposureResults/{attackExposureResultsId}/attackPaths: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists the attack paths for a set of simulation results or valued @@ -15971,7 +16577,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/simulations/{simulationsId}/attackPaths: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists the attack paths for a set of simulation results or valued @@ -16014,7 +16620,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/bigQueryExports/{bigQueryExportsId}: - parameters: *ref_95 + parameters: *ref_1 get: description: Gets a BigQuery export. operationId: securitycenter.organizations.bigQueryExports.get @@ -16104,7 +16710,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/bigQueryExports: - parameters: *ref_95 + parameters: *ref_1 post: description: Creates a BigQuery export. operationId: securitycenter.organizations.bigQueryExports.create @@ -16171,7 +16777,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/assets:group: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Filters an organization's assets and groups them by their specified @@ -16201,7 +16807,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/assets: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists an organization's assets. operationId: securitycenter.organizations.assets.list @@ -16256,7 +16862,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/assets:runDiscovery: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Runs asset discovery. The discovery is tracked with a long-running @@ -16288,7 +16894,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/assets/{assetsId}/securityMarks: - parameters: *ref_95 + parameters: *ref_1 patch: description: Updates security marks. operationId: securitycenter.organizations.assets.updateSecurityMarks @@ -16331,7 +16937,7 @@ paths: type: string format: google-datetime /v1/organizations/{organizationsId}/eventThreatDetectionSettings:validateCustomModule: - parameters: *ref_95 + parameters: *ref_1 post: description: Validates the given Event Threat Detection custom module. operationId: >- @@ -16362,7 +16968,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a resident Event Threat Detection custom module at the scope of @@ -16430,7 +17036,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules/{customModulesId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: >- Deletes the specified Event Threat Detection custom module and all of @@ -16532,7 +17138,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/eventThreatDetectionSettings/customModules:listDescendant: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists all resident Event Threat Detection custom modules under the given @@ -16568,7 +17174,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules/{effectiveCustomModulesId}: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Gets an effective Event Threat Detection custom module at the given @@ -16599,7 +17205,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/eventThreatDetectionSettings/effectiveCustomModules: - parameters: *ref_95 + parameters: *ref_1 get: description: >- Lists all effective Event Threat Detection custom modules for the given @@ -16636,7 +17242,7 @@ paths: type: integer format: int32 /v1/organizations/{organizationsId}/resourceValueConfigs:batchCreate: - parameters: *ref_95 + parameters: *ref_1 post: description: >- Creates a ResourceValueConfig for an organization. Maps user's tags to @@ -16666,7 +17272,7 @@ paths: schema: type: string /v1/organizations/{organizationsId}/resourceValueConfigs/{resourceValueConfigsId}: - parameters: *ref_95 + parameters: *ref_1 delete: description: Deletes a ResourceValueConfig. operationId: securitycenter.organizations.resourceValueConfigs.delete @@ -16759,7 +17365,7 @@ paths: type: string format: google-fieldmask /v1/organizations/{organizationsId}/resourceValueConfigs: - parameters: *ref_95 + parameters: *ref_1 get: description: Lists all ResourceValueConfigs. operationId: securitycenter.organizations.resourceValueConfigs.list @@ -16790,3 +17396,43 @@ paths: name: pageToken schema: type: string + /v1/organizations/{organizationsId}/valuedResources: + parameters: *ref_1 + get: + description: Lists the valued resources for a set of simulation results and filter. + operationId: securitycenter.organizations.valuedResources.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListValuedResourcesResponse' + parameters: + - in: path + name: organizationsId + required: true + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: orderBy + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml index 6fa1bd59..e9829abe 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceconsumermanagement.yaml @@ -7,8 +7,8 @@ info: title: Service Consumer Management API description: Manages the service consumers of a Service Infrastructure service. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/service-consumer-management/docs/overview servers: @@ -34,385 +34,509 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SystemParameter: + Endpoint: description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true + type: object properties: - httpHeader: + allowCors: + type: boolean description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - type: string - urlQueryParameter: + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. + target: type: string description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". name: - description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. + description: The canonical name of this endpoint. type: string - type: object - id: SystemParameter - SourceInfo: - id: SourceInfo - description: Source information used to create a Service Config + aliases: + type: array + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + items: + type: string + id: Endpoint + TenantProjectConfig: + description: >- + This structure defines a tenant project to be added to the specified + tenancy unit and its initial configuration and properties. A project + lien is created for the tenant project to prevent the tenant project + from being deleted accidentally. The lien is deleted as part of tenant + project removal. properties: - sourceFiles: + labels: + description: Labels that are applied to this project. + type: object + additionalProperties: + type: string + tenantProjectPolicy: + $ref: '#/components/schemas/TenantProjectPolicy' + description: Describes ownership and policies for the new tenant project. + billingConfig: + description: Billing account properties. The billing account must be specified. + $ref: '#/components/schemas/BillingConfig' + serviceAccountConfig: + description: Configuration for the IAM service account on the tenant project. + $ref: '#/components/schemas/ServiceAccountConfig' + services: items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + type: string + description: >- + Google Cloud API names of services that are activated on this + project during provisioning. If any of these services can't be + activated, the request fails. For example: + 'compute.googleapis.com','cloudfunctions.googleapis.com' type: array - description: All files used during config generation. - type: object - CancelOperationRequest: - description: The request message for Operations.CancelOperation. + folder: + type: string + description: >- + Folder where project in this tenancy unit must be located This + folder must have been previously created with the required + permissions for the caller to create and configure a project in it. + Valid folder resource names have the format + `folders/{folder_number}` (for example, `folders/123456`). + id: TenantProjectConfig type: object - properties: {} - id: CancelOperationRequest - ListOperationsResponse: + V1Beta1ImportProducerQuotaPoliciesResponse: + id: V1Beta1ImportProducerQuotaPoliciesResponse + description: Response message for ImportProducerQuotaPolicies type: object - description: The response message for Operations.ListOperations. properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: + policies: items: - $ref: '#/components/schemas/Operation' - type: array - description: >- - A list of operations that matches the specified filter in the - request. - id: ListOperationsResponse - Context: - id: Context - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. - properties: - rules: + $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' + description: The policies that were created from the imported data. type: array - items: - $ref: '#/components/schemas/ContextRule' - description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + V1Beta1BatchCreateProducerOverridesResponse: type: object - AuthenticationRule: + id: V1Beta1BatchCreateProducerOverridesResponse properties: - requirements: - description: Requirements for additional authentication providers. - type: array + overrides: + description: The overrides that were created. items: - $ref: '#/components/schemas/AuthRequirement' - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - allowWithoutCredential: - type: boolean - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. + $ref: '#/components/schemas/V1Beta1QuotaOverride' + type: array + description: Response message for BatchCreateProducerOverrides + MetricRule: + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + properties: selector: - type: string description: >- Selects the methods to which this rule applies. Refer to selector for syntax details. - id: AuthenticationRule - type: object - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - MethodSettings: - id: MethodSettings - type: object - properties: - selector: type: string + metricCosts: description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... - autoPopulatedFields: - type: array - description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id - items: + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + type: object + additionalProperties: + format: int64 type: string - longRunning: - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - $ref: '#/components/schemas/LongRunning' - description: Describes the generator configuration for a method. - V1Beta1RefreshConsumerResponse: + id: MetricRule + type: object + V1DisableConsumerResponse: type: object - id: V1Beta1RefreshConsumerResponse properties: {} + id: V1DisableConsumerResponse description: >- - Response message for the `RefreshConsumer` method. This response message + Response message for the `DisableConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - CustomErrorRule: - description: A custom error rule. - id: CustomErrorRule + Usage: type: object + id: Usage properties: - selector: + producerNotificationChannel: + description: >- + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. type: string + rules: + type: array + items: + $ref: '#/components/schemas/UsageRule' description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. - isErrorType: - type: boolean + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + requirements: description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - Quota: - properties: - limits: - description: List of QuotaLimit definitions for the service. - items: - $ref: '#/components/schemas/QuotaLimit' + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. type: array - metricRules: items: - $ref: '#/components/schemas/MetricRule' - description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. - type: array - id: Quota + type: string + description: Configuration controlling usage of a service. + Operation: description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - type: object - V1Beta1ImportProducerOverridesResponse: - properties: - overrides: - items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - type: array - description: The overrides that were created from the imported data. - description: Response message for ImportProducerOverrides - id: V1Beta1ImportProducerOverridesResponse - type: object - GoSettings: - type: object - id: GoSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Go client libraries. - FieldPolicy: - id: FieldPolicy + This resource represents a long-running operation that is the result of + a network API call. properties: - selector: - type: string + response: + type: object description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". - resourceType: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + name: + description: >- + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. type: string + error: + $ref: '#/components/schemas/Status' description: >- - Specifies the resource type for the resource referred to by the - field. - resourcePermission: + The error result of the operation in case of failure or + cancellation. + metadata: + type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - type: string - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean + id: Operation type: object - TenancyUnit: - id: TenancyUnit + EnumValue: type: object - description: Representation of a tenancy unit. properties: name: type: string - description: >- - Globally unique identifier of this tenancy unit - "services/{service}/{collection id}/{resource - id}/tenancyUnits/{unit}" - service: - description: >- - Output only. Google Cloud API name of the managed service owning - this tenancy unit. For example - 'serviceconsumermanagement.googleapis.com'. - type: string - readOnly: true - consumer: - readOnly: true - description: >- - Output only. @OutputOnly Cloud resource name of the consumer of this - service. For example 'projects/123456'. - type: string - tenantResources: + description: Enum value name. + options: items: - $ref: '#/components/schemas/TenantResource' - description: >- - Resources constituting the tenancy unit. There can be at most 512 - tenant resources in a tenancy unit. + $ref: '#/components/schemas/Option' type: array - createTime: - type: string - readOnly: true - format: google-datetime - description: Output only. @OutputOnly The time this tenancy unit was created. - ApplyTenantProjectConfigRequest: - description: Request to apply configuration to an existing tenant project. + description: Protocol buffer options. + number: + description: Enum value number. + format: int32 + type: integer + description: Enum value definition. + id: EnumValue + AuthRequirement: + id: AuthRequirement type: object - id: ApplyTenantProjectConfigRequest + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). properties: - projectConfig: - description: Configuration that should be applied to the existing tenant project. - $ref: '#/components/schemas/TenantProjectConfig' - tag: + audiences: + type: string description: >- - Required. Tag of the project. Must be less than 128 characters. - Required. + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + providerId: + description: >- + id from authentication provider. Example: provider_id: + bookstore_auth type: string - SystemParameters: - description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - id: SystemParameters + PhpSettings: + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for Php client libraries. type: object + id: PhpSettings + BillingConfig: properties: - rules: - items: - $ref: '#/components/schemas/SystemParameterRule' + billingAccount: + type: string description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - type: array - ClientLibrarySettings: + Name of the billing account. For example + `billingAccounts/012345-567890-ABCDEF`. + description: Describes the billing configuration for a new tenant project. type: object - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings - properties: - goSettings: - description: Settings for Go client libraries. - $ref: '#/components/schemas/GoSettings' - pythonSettings: - description: Settings for Python client libraries. - $ref: '#/components/schemas/PythonSettings' - dotnetSettings: - description: Settings for .NET client libraries. - $ref: '#/components/schemas/DotnetSettings' - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - phpSettings: - description: Settings for PHP client libraries. - $ref: '#/components/schemas/PhpSettings' - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - restNumericEnums: + id: BillingConfig + Service: + id: Service + properties: + title: description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - type: boolean - version: + The product title for this service, it is the name displayed in + Google Cloud Console. type: string + endpoints: description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - cppSettings: - description: Settings for C++ client libraries. - $ref: '#/components/schemas/CppSettings' + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + items: + $ref: '#/components/schemas/Endpoint' + type: array + monitoredResources: + type: array + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + sourceInfo: + $ref: '#/components/schemas/SourceInfo' + description: >- + Output only. The source information for this configuration if + available. + name: + description: >- + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + type: string + types: + items: + $ref: '#/components/schemas/Type' + type: array + description: >- + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + enums: + items: + $ref: '#/components/schemas/Enum' + type: array + description: >- + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + metrics: + items: + $ref: '#/components/schemas/MetricDescriptor' + type: array + description: Defines the metrics used by this service. + authentication: + description: Auth configuration. + $ref: '#/components/schemas/Authentication' + apis: + type: array + items: + $ref: '#/components/schemas/Api' + description: >- + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + publishing: + $ref: '#/components/schemas/Publishing' + description: >- + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + producerProjectId: + type: string + description: The Google project that owns this service. + configVersion: + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + format: uint32 + type: integer + systemTypes: + items: + $ref: '#/components/schemas/Type' + description: >- + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + type: array + id: + type: string + description: >- + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + quota: + $ref: '#/components/schemas/Quota' + description: Quota configuration. + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + customError: + description: Custom error configuration. + $ref: '#/components/schemas/CustomError' + context: + $ref: '#/components/schemas/Context' + description: Context configuration. + control: + description: Configuration for the service control plane. + $ref: '#/components/schemas/Control' + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + logs: + type: array + items: + $ref: '#/components/schemas/LogDescriptor' + description: Defines the logs used by this service. + backend: + $ref: '#/components/schemas/Backend' + description: API backend configuration. + type: object + description: >- + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth + MonitoredResourceDescriptor: + id: MonitoredResourceDescriptor + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. + type: object + properties: + displayName: + type: string + description: >- + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. + name: + description: >- + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + type: string + type: + type: string + description: >- + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + labels: + description: >- + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array launchStage: - description: Launch stage of this version of the API. + description: Optional. The launch stage of the monitored resource definition. enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED @@ -461,43 +585,14 @@ components: [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. type: string - UsageRule: - properties: - selector: + description: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Optional. A detailed description of the monitored resource type that + might be used in documentation. type: string - skipServiceControl: - type: boolean - description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - allowUnregisteredCalls: - type: boolean - description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - type: object - id: UsageRule HttpRule: - id: HttpRule description: >- - # gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google @@ -520,19 +615,19 @@ components: (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET - /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields - in the request message which are not bound by the path template - automatically become HTTP query parameters if there is no HTTP request - body. For example: service Messaging { rpc GetMessage(GetMessageRequest) - returns (Message) { option (google.api.http) = { - get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { - message SubMessage { string subfield = 1; } string message_id = 1; // - Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter - `revision`. SubMessage sub = 3; // Mapped to URL query parameter - `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP - | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` - | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be @@ -546,8 +641,8 @@ components: }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: HTTP | - gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request @@ -555,8 +650,8 @@ components: method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC - -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option @@ -569,36 +664,37 @@ components: additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | - `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP - mapping 1. Leaf request fields (recursive expansion nested messages in - the request message) are classified into three categories: - Fields - referred by the path template. They are passed via the URL path. - - Fields referred by the HttpRule.body. They are passed via the HTTP - request body. - All other fields are passed via the URL query - parameters, and the parameter name is the field path in the request - message. A repeated field can be represented as multiple query - parameters under the same name. 2. If HttpRule.body is "*", there is no - URL query parameter, all fields are passed via URL path and HTTP request - body. 3. If HttpRule.body is omitted, there is no HTTP request body, all - fields are passed via URL path and URL query parameters. ### Path - template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { - "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = - "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; - Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. - The syntax `**` matches zero or more URL path segments, which must be - the last part of the URL path except the `Verb`. The syntax `Variable` - matches part of the URL path as specified by its template. A variable - template must not contain other variables. If a variable matches a - single path segment, its template may be omitted, e.g. `{var}` is - equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in - the URL path. If the `LITERAL` contains any reserved character, such - characters should be percent-encoded before the matching. If a variable - contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, - when such a variable is expanded into a URL path on the client side, all - characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - does the reverse decoding. Such variables show up in the [Discovery + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a @@ -607,7 +703,7 @@ components: "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. ## Using gRPC API Service Configuration gRPC API Service + `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` @@ -617,10 +713,10 @@ components: endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. Example: - http: rules: # Selects a gRPC method and applies HttpRule to it. - - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). @@ -641,14 +737,21 @@ components: API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. - type: object + id: HttpRule properties: - patch: - type: string - description: Maps to HTTP PATCH. Used for updating a resource. - delete: + get: type: string - description: Maps to HTTP DELETE. Used for deleting a resource. + description: >- + Maps to HTTP GET. Used for listing and getting information about + resources. + additionalBindings: + type: array + description: >- + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + items: + $ref: '#/components/schemas/HttpRule' body: type: string description: >- @@ -657,11 +760,19 @@ components: the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. - get: - type: string + responseBody: description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + type: string + patch: + type: string + description: Maps to HTTP PATCH. Used for updating a resource. + put: + type: string + description: Maps to HTTP PUT. Used for replacing a resource. custom: $ref: '#/components/schemas/CustomHttpPattern' description: >- @@ -669,1245 +780,1130 @@ components: included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - additionalBindings: - items: - $ref: '#/components/schemas/HttpRule' - type: array + delete: + type: string + description: Maps to HTTP DELETE. Used for deleting a resource. + post: + type: string description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). + Maps to HTTP POST. Used for creating a resource or performing an + action. selector: type: string description: >- Selects a method to which this rule applies. Refer to selector for syntax details. - put: + type: object + Publishing: + properties: + docTagPrefix: + description: >- + A prefix used in sample code when demarking regions to be included + in documentation. + type: string + githubLabel: type: string - description: Maps to HTTP PUT. Used for replacing a resource. - responseBody: description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. + GitHub label to apply to issues and pull requests opened for this + API. + apiShortName: + description: >- + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". type: string - post: + newIssueUri: type: string description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - MethodPolicy: - id: MethodPolicy - type: object - description: Defines policies applying to an RPC method. - properties: - selector: + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + restReferenceDocumentationUri: + type: string description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + organization: + description: For whom the client library is being published. + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI type: string - requestPolicies: + documentationUri: + type: string + description: >- + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + protoReferenceDocumentationUri: + description: >- + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + type: string + librarySettings: + description: >- + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. type: array - description: Policies that are applicable to the request message. items: - $ref: '#/components/schemas/FieldPolicy' - V1AddVisibilityLabelsResponse: - type: object - id: V1AddVisibilityLabelsResponse - properties: - labels: + $ref: '#/components/schemas/ClientLibrarySettings' + methodSettings: type: array description: >- - The updated set of visibility labels for this consumer on this - service. + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. items: - type: string - description: >- - Response message for the `AddVisibilityLabels` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - Endpoint: - description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true - properties: - name: - type: string - description: The canonical name of this endpoint. - allowCors: - description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - type: boolean - target: + $ref: '#/components/schemas/MethodSettings' + codeownerGithubTeams: description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - type: string - aliases: + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. items: type: string - description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. type: array type: object - id: Endpoint - AuthRequirement: + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + id: Publishing + V1GenerateServiceAccountResponse: + properties: + account: + $ref: '#/components/schemas/V1ServiceAccount' + description: ServiceAccount that was created or retrieved. + description: >- + Response message for the `GenerateServiceAccount` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. type: object + id: V1GenerateServiceAccountResponse + Enum: + id: Enum + description: Enum type definition. properties: - providerId: + edition: type: string description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - audiences: + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + options: + type: array + items: + $ref: '#/components/schemas/Option' + description: Protocol buffer options. + name: type: string - description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - id: AuthRequirement - description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - V1GenerateDefaultIdentityResponse: - properties: - identity: - $ref: '#/components/schemas/V1DefaultIdentity' - description: DefaultIdentity that was created or retrieved. - role: - type: string - description: >- - Role attached to consumer project. Empty if not attached in this - request. (Under development, currently always return empty.) - attachStatus: - description: >- - Status of the role attachment. Under development - (go/si-attach-role), currently always return - ATTACH_STATUS_UNSPECIFIED) + description: Enum type name. + syntax: enumDescriptions: - - Indicates that the AttachStatus was not set. - - >- - The default identity was attached to a role successfully in this - request. - - >- - The request specified that no attempt should be made to attach the - role. - - >- - Role was attached to the consumer project at some point in time. - Tenant manager doesn't make assertion about the current state of - the identity with respect to the consumer. Role attachment should - happen only once after activation and cannot be reattached after - customer removes it. (go/si-attach-role) - - >- - Role attachment was denied in this request by customer set org - policy. (go/si-attach-role) - type: string + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. enum: - - ATTACH_STATUS_UNSPECIFIED - - ATTACHED - - ATTACH_SKIPPED - - PREVIOUSLY_ATTACHED - - ATTACH_DENIED_BY_ORG_POLICY - id: V1GenerateDefaultIdentityResponse + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + type: string + description: The source syntax. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + enumvalue: + items: + $ref: '#/components/schemas/EnumValue' + type: array + description: Enum value definitions. + type: object + DeleteTenantProjectRequest: + description: Request message to delete tenant project resource from the tenancy unit. type: object - description: >- - Response message for the `GenerateDefaultIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - Operation: properties: - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - name: + tag: type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - response: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - id: Operation - type: object - description: >- - This resource represents a long-running operation that is the result of - a network API call. - PhpSettings: + description: Required. Tag of the resource within the tenancy unit. + id: DeleteTenantProjectRequest + NodeSettings: type: object - description: Settings for Php client libraries. - id: PhpSettings + id: NodeSettings + description: Settings for Node client libraries. properties: common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - ContextRule: + Documentation: type: object description: >- - A context rule provides information about the context for an individual - API element. + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. + id: Documentation properties: - allowedResponseExtensions: + rules: description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array items: - type: string - provided: - description: A list of full type names of provided contexts. - items: - type: string + $ref: '#/components/schemas/DocumentationRule' + summary: + type: string + description: >- + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. + pages: type: array - requested: - description: A list of full type names of requested contexts. + description: The top level pages for the documentation set. items: - type: string - type: array - allowedRequestExtensions: - type: array + $ref: '#/components/schemas/Page' + overview: + type: string description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + sectionOverrides: items: - type: string - selector: + $ref: '#/components/schemas/Page' description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - id: ContextRule - Backend: - type: object - properties: - rules: + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries type: array + serviceRootUrl: description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/BackendRule' - description: '`Backend` defines the backend configuration for a service.' - id: Backend - BillingDestination: + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + type: string + documentationRootUrl: + type: string + description: The URL to the root of documentation. + V1Beta1QuotaOverride: + id: V1Beta1QuotaOverride properties: - metrics: - items: - type: string - type: array + unit: description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - monitoredResource: + The limit unit of the limit to which this override applies. An + example unit would be: `1/{project}/{region}` Note that `{project}` + and `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. type: string + metric: description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: object - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - id: BillingDestination - Publishing: - type: object - id: Publishing - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - properties: - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - restReferenceDocumentationUri: + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` type: string - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest - documentationUri: - description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview + name: type: string - librarySettings: - type: array - items: - $ref: '#/components/schemas/ClientLibrarySettings' description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. - protoReferenceDocumentationUri: + The resource name of the producer override. An example name would + be: + `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` + adminOverrideAncestor: type: string description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - codeownerGithubTeams: - items: - type: string + The resource name of the ancestor that requested the override. For + example: "organizations/12345" or "folders/67890". Used by admin + overrides only. + overrideValue: description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. - type: array - githubLabel: + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + format: int64 type: string + dimensions: + description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + type: object + additionalProperties: + type: string + type: object + description: A quota override + UsageRule: + description: >- + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true + properties: + allowUnregisteredCalls: + type: boolean description: >- - GitHub label to apply to issues and pull requests opened for this - API. - methodSettings: - type: array - items: - $ref: '#/components/schemas/MethodSettings' + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. + selector: description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - apiShortName: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string + skipServiceControl: + type: boolean description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". - docTagPrefix: - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - type: string - organization: - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - type: string - description: For whom the client library is being published. - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - V1Beta1ProducerQuotaPolicy: - id: V1Beta1ProducerQuotaPolicy + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + id: UsageRule + type: object + LoggingDestination: + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). properties: - metric: - type: string + monitoredResource: description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` - unit: + The monitored resource type. The type must be defined in the + Service.monitored_resources section. type: string + logs: + items: + type: string description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - policyValue: - format: int64 + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + type: array + id: LoggingDestination + type: object + Page: + properties: + content: description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). - type: string - container: + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. type: string - description: >- - The cloud resource container at which the quota policy is created. - The format is {container_type}/{container_number} - dimensions: - additionalProperties: - type: string - type: object - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' name: description: >- - The resource name of the producer policy. An example name would be: - `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. type: string + subpages: + items: + $ref: '#/components/schemas/Page' + type: array + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. + id: Page + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. type: object - description: Quota policy created by service producer. - V1EnableConsumerResponse: - type: object - properties: {} - id: V1EnableConsumerResponse + ExperimentalFeatures: + properties: + restAsyncIoEnabled: + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean description: >- - Response message for the `EnableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - CommonLanguageSettings: - description: Required information for every language. - id: CommonLanguageSettings + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + type: object + id: ExperimentalFeatures + V1AddVisibilityLabelsResponse: properties: - destinations: + labels: + description: >- + The updated set of visibility labels for this consumer on this + service. items: type: string - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - description: >- - The destination where API teams want this client library to be - published. type: array - referenceDocsUri: - type: string - description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - deprecated: true type: object - BackendRule: + description: >- + Response message for the `AddVisibilityLabels` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: V1AddVisibilityLabelsResponse + PythonSettings: + id: PythonSettings + description: Settings for Python client libraries. properties: - address: - type: string + experimentalFeatures: + $ref: '#/components/schemas/ExperimentalFeatures' description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - protocol: - type: string - description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - operationDeadline: - type: number - format: double - description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - selector: + Experimental features to be included during client library + generation. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + type: object + Api: + type: object + properties: + syntax: + description: The source syntax of the service. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS type: string + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + version: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - jwtAudience: - description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. type: string - deadline: - type: number - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - format: double - disableAuth: + name: description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - type: boolean - pathTranslation: + The fully qualified name of this interface, including package name + followed by the interface's simple name. type: string - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - overridesByRequestProtocol: - type: object - additionalProperties: - $ref: '#/components/schemas/BackendRule' - description: The map between request protocol and the backend address. - minDeadline: - type: number - format: double - description: Deprecated, do not use. - deprecated: true - type: object - description: A backend rule provides configuration for an individual API element. - id: BackendRule - Type: - description: A protocol buffer message type. - properties: - fields: + mixins: + description: Included interfaces. See Mixin. type: array items: - $ref: '#/components/schemas/Field' - description: The list of fields. + $ref: '#/components/schemas/Mixin' + methods: + type: array + items: + $ref: '#/components/schemas/Method' + description: The methods of this interface, in unspecified order. options: - description: The protocol buffer options. + type: array items: $ref: '#/components/schemas/Option' - type: array + description: Any metadata attached to the interface. sourceContext: - description: The source context. $ref: '#/components/schemas/SourceContext' - oneofs: - type: array - items: - type: string - description: The list of types appearing in `oneof` definitions in this type. - edition: description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + Source context for the protocol buffer service represented by this + message. + id: Api + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + V1Beta1ServiceIdentity: + type: object + id: V1Beta1ServiceIdentity + properties: + uniqueId: + description: The unique and stable id of the service identity. type: string - syntax: - description: The source syntax. - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. + email: + type: string + description: The email address of the service identity. + tag: + description: >- + The P4 service identity configuration tag. This must be defined in + activation_grants. If not specified when creating the account, the + tag is set to "default". type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS name: - description: The fully qualified message name. type: string + description: >- + P4 service identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` + description: A service identity in the Identity and Access Management API. + Http: type: object - id: Type - V1Beta1DisableConsumerResponse: + id: Http + properties: + rules: + description: >- + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + items: + $ref: '#/components/schemas/HttpRule' + fullyDecodeReservedExpansion: + description: >- + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + description: >- + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + V1RefreshConsumerResponse: + id: V1RefreshConsumerResponse properties: {} - id: V1Beta1DisableConsumerResponse - type: object description: >- - Response message for the `DisableConsumer` method. This response message + Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - Enum: type: object - id: Enum - description: Enum type definition. + AuthProvider: + id: AuthProvider + type: object properties: - enumvalue: - description: Enum value definitions. - items: - $ref: '#/components/schemas/EnumValue' - type: array - name: - description: Enum type name. + jwksUri: + description: >- + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs type: string - options: - description: Protocol buffer options. - type: array - items: - $ref: '#/components/schemas/Option' - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS + authorizationUrl: type: string - edition: description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - type: string - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - CreateTenancyUnitRequest: - type: object - description: >- - Request to create a tenancy unit for a service consumer of a managed - service. - properties: - tenancyUnitId: + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + id: type: string description: >- - Optional. Optional service producer-provided identifier of the - tenancy unit. Must be no longer than 40 characters and preferably - URI friendly. If it isn't provided, a UID for the tenancy unit is - automatically generated. The identifier must be unique across a - managed service. If the tenancy unit already exists for the managed - service and service consumer pair, calling `CreateTenancyUnit` - returns the existing tenancy unit if the provided identifier is - identical or empty, otherwise the call fails. - id: CreateTenancyUnitRequest - Method: - type: object - id: Method - description: Method represents a method of an API interface. - properties: - responseTypeUrl: - description: The URL of the output message type. + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". + issuer: + description: >- + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com type: string - requestStreaming: - type: boolean - description: If true, the request is streamed. - options: + jwtLocations: + description: >- + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token type: array - description: Any metadata attached to the method. items: - $ref: '#/components/schemas/Option' - responseStreaming: - description: If true, the response is streamed. - type: boolean - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax of this method. - name: - description: The simple name of this method. - type: string - requestTypeUrl: + $ref: '#/components/schemas/JwtLocation' + audiences: + description: >- + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com type: string - description: A URL of the input message type. - Option: - id: Option description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + MetricDescriptor: + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. properties: - value: - description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any name: - description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. + description: The resource name of the metric descriptor. type: string - type: object - Field: - properties: - name: - description: The field name. + displayName: type: string - typeUrl: description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - type: string - cardinality: - type: string - description: The field cardinality. - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - number: - type: integer - format: int32 - description: The field number. - packed: - description: Whether to use alternative packed wire representation. - type: boolean - kind: - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - type: string - description: The field type. - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - defaultValue: + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + metadata: + $ref: '#/components/schemas/MetricDescriptorMetadata' + description: Optional. Metadata which can be used to guide usage of the metric. + type: + description: >- + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" type: string + labels: description: >- - The string value of the default value of this field. Proto2 syntax - only. - options: + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. type: array items: - $ref: '#/components/schemas/Option' - description: The protocol buffer options. - jsonName: - type: string - description: The field JSON name. - oneofIndex: - format: int32 + $ref: '#/components/schemas/LabelDescriptor' + valueType: + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - type: integer - type: object - id: Field - description: A single field of a message type. - CppSettings: - description: Settings for C++ client libraries. - id: CppSettings - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - DotnetSettings: - description: Settings for Dotnet client libraries. - properties: - ignoredResources: - type: array - items: - type: string - description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - renamedResources: - additionalProperties: - type: string - type: object - description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - renamedServices: - additionalProperties: - type: string - description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - type: object - handwrittenSignatures: - description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + type: string + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the metric definition. + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + type: string + monitoredResourceTypes: items: type: string type: array - forcedNamespaceAliases: description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - type: array - items: - type: string - id: DotnetSettings - type: object - BillingConfig: - properties: - billingAccount: + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + unit: type: string description: >- - Name of the billing account. For example - `billingAccounts/012345-567890-ABCDEF`. - id: BillingConfig - type: object - description: Describes the billing configuration for a new tenant project. - CustomError: - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - type: object - id: CustomError - properties: - types: - items: - type: string - type: array + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + metricKind: description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - rules: - type: array - items: - $ref: '#/components/schemas/CustomErrorRule' + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + type: string + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + description: + type: string description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. - Logging: - id: Logging + A detailed description of the metric, which can be used in + documentation. + id: MetricDescriptor type: object - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history + AddTenantProjectRequest: properties: - producerDestinations: - type: array - items: - $ref: '#/components/schemas/LoggingDestination' + projectConfig: + $ref: '#/components/schemas/TenantProjectConfig' description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. - consumerDestinations: - items: - $ref: '#/components/schemas/LoggingDestination' + Configuration of the new tenant project to be added to tenancy unit + resources. + tag: description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - type: array - V1DisableConsumerResponse: - properties: {} - type: object - description: >- - Response message for the `DisableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - id: V1DisableConsumerResponse - V1Beta1GenerateServiceIdentityResponse: + Required. Tag of the added project. Must be less than 128 + characters. Required. + type: string description: >- - Response message for the `GenerateServiceIdentity` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - properties: - identity: - description: ServiceIdentity that was created or retrieved. - $ref: '#/components/schemas/V1Beta1ServiceIdentity' - id: V1Beta1GenerateServiceIdentityResponse - type: object - Control: + Request to add a newly created and configured tenant project to a + tenancy unit. + id: AddTenantProjectRequest type: object + SystemParameters: + id: SystemParameters description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. properties: - methodPolicies: - items: - $ref: '#/components/schemas/MethodPolicy' + rules: type: array - description: Defines policies applying to the API methods of the service. - environment: description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - type: string - id: Control - SearchTenancyUnitsResponse: - id: SearchTenancyUnitsResponse + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + items: + $ref: '#/components/schemas/SystemParameterRule' type: object + V1GenerateDefaultIdentityResponse: properties: - nextPageToken: - description: Pagination token for large results. + identity: + description: DefaultIdentity that was created or retrieved. + $ref: '#/components/schemas/V1DefaultIdentity' + attachStatus: + description: >- + Status of the role attachment. Under development + (go/si-attach-role), currently always return + ATTACH_STATUS_UNSPECIFIED) + enumDescriptions: + - Indicates that the AttachStatus was not set. + - >- + The default identity was attached to a role successfully in this + request. + - >- + The request specified that no attempt should be made to attach the + role. + - >- + Role was attached to the consumer project at some point in time. + Tenant manager doesn't make assertion about the current state of + the identity with respect to the consumer. Role attachment should + happen only once after activation and cannot be reattached after + customer removes it. (go/si-attach-role) + - >- + Role attachment was denied in this request by customer set org + policy. (go/si-attach-role) + type: string + enum: + - ATTACH_STATUS_UNSPECIFIED + - ATTACHED + - ATTACH_SKIPPED + - PREVIOUSLY_ATTACHED + - ATTACH_DENIED_BY_ORG_POLICY + role: + description: >- + Role attached to consumer project. Empty if not attached in this + request. (Under development, currently always return empty.) type: string - tenancyUnits: - description: Tenancy Units matching the request. - type: array - items: - $ref: '#/components/schemas/TenancyUnit' - description: Response for the search query. - TenantProjectPolicy: description: >- - Describes policy settings that can be applied to a newly created tenant - project. + Response message for the `GenerateDefaultIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. type: object - id: TenantProjectPolicy + id: V1GenerateDefaultIdentityResponse + LogDescriptor: properties: - policyBindings: + displayName: description: >- - Policy bindings to be applied to the tenant project, in addition to - the 'roles/owner' role granted to the Service Consumer Management - service account. + The human-readable name for this log. This information appears on + the user interface and should be concise. + type: string + labels: + description: >- + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. items: - $ref: '#/components/schemas/PolicyBinding' + $ref: '#/components/schemas/LabelDescriptor' type: array - JavaSettings: - description: Settings for Java client libraries. - properties: - serviceClassNames: + name: + type: string description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - additionalProperties: - type: string - type: object - libraryPackage: + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + description: description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 + A human-readable description of this log. This information appears + in the documentation and can contain details. type: string - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' + id: LogDescriptor + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer type: object - id: JavaSettings - Api: + V1Beta1EnableConsumerResponse: + id: V1Beta1EnableConsumerResponse + properties: {} + description: >- + Response message for the `EnableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + type: object + ContextRule: + id: ContextRule properties: - syntax: - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax of the service. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - name: - description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - type: string - options: - items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the interface. + allowedRequestExtensions: type: array - version: - type: string description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - mixins: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. items: - $ref: '#/components/schemas/Mixin' + type: string + allowedResponseExtensions: type: array - description: Included interfaces. See Mixin. - methods: - description: The methods of this interface, in unspecified order. + items: + type: string + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + requested: + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. type: array items: - $ref: '#/components/schemas/Method' - sourceContext: - $ref: '#/components/schemas/SourceContext' + type: string + selector: + type: string description: >- - Source context for the protocol buffer service represented by this - message. - type: object - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. - id: Api - V1RemoveVisibilityLabelsResponse: - description: >- - Response message for the `RemoveVisibilityLabels` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - properties: - labels: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + provided: description: >- - The updated set of visibility labels for this consumer on this - service. - type: array + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. items: type: string - id: V1RemoveVisibilityLabelsResponse + type: array + description: >- + A context rule provides information about the context for an individual + API element. type: object - MonitoringDestination: + V1EnableConsumerResponse: + description: >- + Response message for the `EnableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + properties: {} + id: V1EnableConsumerResponse type: object + CommonLanguageSettings: + id: CommonLanguageSettings + type: object + description: Required information for every language. properties: - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - metrics: + destinations: type: array description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. + The destination where API teams want this client library to be + published. items: + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. type: string - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - id: MonitoringDestination - V1Beta1QuotaOverride: - type: object - description: A quota override - id: V1Beta1QuotaOverride - properties: - dimensions: - additionalProperties: - type: string - type: object - description: ' If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota overrides that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' - unit: + referenceDocsUri: + deprecated: true type: string description: >- - The limit unit of the limit to which this override applies. An - example unit would be: `1/{project}/{region}` Note that `{project}` - and `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - overrideValue: - format: int64 - description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - type: string - adminOverrideAncestor: + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + TenancyUnit: + id: TenancyUnit + properties: + service: + readOnly: true type: string description: >- - The resource name of the ancestor that requested the override. For - example: "organizations/12345" or "folders/67890". Used by admin - overrides only. + Output only. Google Cloud API name of the managed service owning + this tenancy unit. For example + 'serviceconsumermanagement.googleapis.com'. + tenantResources: + items: + $ref: '#/components/schemas/TenantResource' + description: >- + Resources constituting the tenancy unit. There can be at most 512 + tenant resources in a tenancy unit. + type: array name: type: string description: >- - The resource name of the producer override. An example name would - be: - `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` - metric: + Globally unique identifier of this tenancy unit + "services/{service}/{collection id}/{resource + id}/tenancyUnits/{unit}" + consumer: description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` + Output only. @OutputOnly Cloud resource name of the consumer of this + service. For example 'projects/123456'. + readOnly: true type: string - TenantResource: - id: TenantResource + createTime: + readOnly: true + description: Output only. @OutputOnly The time this tenancy unit was created. + format: google-datetime + type: string + description: Representation of a tenancy unit. type: object - description: Resource constituting the TenancyUnit. + V1Beta1GenerateServiceIdentityResponse: + id: V1Beta1GenerateServiceIdentityResponse properties: - tag: - type: string - description: Unique per single tenancy unit. - status: - description: Status of tenant resource. - enum: - - STATUS_UNSPECIFIED - - PENDING_CREATE - - ACTIVE - - PENDING_DELETE - - FAILED - - DELETED - type: string - enumDescriptions: - - Unspecified status is the default unset value. - - Creation of the tenant resource is ongoing. - - Active resource. - - Deletion of the resource is ongoing. - - Tenant resource creation or deletion has failed. - - Tenant resource has been deleted. - resource: + identity: + description: ServiceIdentity that was created or retrieved. + $ref: '#/components/schemas/V1Beta1ServiceIdentity' + description: >- + Response message for the `GenerateServiceIdentity` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + type: object + V1Beta1RefreshConsumerResponse: + id: V1Beta1RefreshConsumerResponse + type: object + properties: {} + description: >- + Response message for the `RefreshConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + Empty: + properties: {} + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + id: Empty + type: object + BillingDestination: + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + id: BillingDestination + properties: + metrics: + type: array + description: >- + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + items: + type: string + monitoredResource: type: string - readOnly: true description: >- - Output only. @OutputOnly Identifier of the tenant resource. For - cloud projects, it is in the form 'projects/{number}'. For example - 'projects/123456'. + The monitored resource type. The type must be defined in + Service.monitored_resources section. + type: object + TenantProjectPolicy: + id: TenantProjectPolicy + type: object + properties: + policyBindings: + description: >- + Policy bindings to be applied to the tenant project, in addition to + the 'roles/owner' role granted to the Service Consumer Management + service account. + type: array + items: + $ref: '#/components/schemas/PolicyBinding' + description: >- + Describes policy settings that can be applied to a newly created tenant + project. V1ServiceAccount: - id: V1ServiceAccount + type: object properties: iamAccountName: deprecated: true @@ -1919,182 +1915,132 @@ components: The P4 SA configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to "default". - email: - type: string - description: The email address of the service account. uniqueId: type: string description: The unique and stable id of the service account. + email: + type: string + description: The email address of the service account. name: + type: string description: >- P4 SA resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default` + id: V1ServiceAccount + description: A service account in the Identity and Access Management API. + CreateTenancyUnitRequest: + properties: + tenancyUnitId: type: string + description: >- + Optional. Optional service producer-provided identifier of the + tenancy unit. Must be no longer than 40 characters and preferably + URI friendly. If it isn't provided, a UID for the tenancy unit is + automatically generated. The identifier must be unique across a + managed service. If the tenancy unit already exists for the managed + service and service consumer pair, calling `CreateTenancyUnit` + returns the existing tenancy unit if the provided identifier is + identical or empty, otherwise the call fails. type: object - description: A service account in the Identity and Access Management API. - Page: + id: CreateTenancyUnitRequest description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - type: object + Request to create a tenancy unit for a service consumer of a managed + service. + V1DefaultIdentity: + description: A default identity in the Identity and Access Management API. properties: - content: - description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + uniqueId: + type: string + description: The unique and stable id of the default identity. + tag: type: string - subpages: description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - items: - $ref: '#/components/schemas/Page' - type: array + The Default Identity tag. If specified when creating the account, + the tag must be present in activation_grants. If not specified when + creating the account, the tag is set to the tag specified in + activation_grants. + email: + type: string + description: The email address of the default identity. name: + description: >- + Default identity resource name. An example name would be: + `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` type: string - description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - id: Page - V1RefreshConsumerResponse: - id: V1RefreshConsumerResponse - description: >- - Response message for the `RefreshConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - properties: {} type: object - V1Beta1EnableConsumerResponse: + id: V1DefaultIdentity + MonitoringDestination: type: object - id: V1Beta1EnableConsumerResponse description: >- - Response message for the `EnableConsumer` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - properties: {} - Usage: + Configuration of a specific monitoring destination (the producer project + or the consumer project). + id: MonitoringDestination properties: - rules: + monitoredResource: + type: string description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - items: - $ref: '#/components/schemas/UsageRule' - requirements: - type: array + The monitored resource type. The type must be defined in + Service.monitored_resources section. + metrics: description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. items: type: string - producerNotificationChannel: + type: array + Status: + properties: + code: + description: The status code, which should be an enum value of google.rpc.Code. + type: integer + format: int32 + message: description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. type: string - description: Configuration controlling usage of a service. - id: Usage - type: object - V1Beta1ImportProducerQuotaPoliciesResponse: - description: Response message for ImportProducerQuotaPolicies - id: V1Beta1ImportProducerQuotaPoliciesResponse - properties: - policies: - type: array + details: + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. items: - $ref: '#/components/schemas/V1Beta1ProducerQuotaPolicy' - description: The policies that were created from the imported data. - type: object - Empty: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: array description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). type: object - id: Empty - properties: {} - Mixin: - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + id: Status + MethodPolicy: + description: Defines policies applying to an RPC method. + id: MethodPolicy type: object properties: - root: + requestPolicies: + description: Policies that are applicable to the request message. + type: array + items: + $ref: '#/components/schemas/FieldPolicy' + selector: description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - type: string - name: - type: string - description: The fully qualified name of the interface which is included. - id: Mixin - DeleteTenantProjectRequest: - properties: - tag: - description: Required. Tag of the resource within the tenancy unit. + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . type: string - type: object - id: DeleteTenantProjectRequest - description: Request message to delete tenant project resource from the tenancy unit. ServiceAccountConfig: - type: object + description: Describes the service account configuration for the tenant project. properties: - tenantProjectRoles: - description: Roles for the associated service account for the tenant project. - items: - type: string - type: array accountId: description: >- ID of the IAM service account to be created in tenant project. The @@ -2104,49 +2050,93 @@ components: and match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`. type: string - description: Describes the service account configuration for the tenant project. + tenantProjectRoles: + items: + type: string + type: array + description: Roles for the associated service account for the tenant project. id: ServiceAccountConfig - PolicyBinding: type: object - description: Translates to IAM Policy bindings (without auditing at this level) + SourceContext: + type: object + id: SourceContext + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. properties: - role: + fileName: type: string description: >- - Role. (https://cloud.google.com/iam/docs/understanding-roles) For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. - members: + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + Type: + id: Type + properties: + options: items: - type: string + $ref: '#/components/schemas/Option' type: array + description: The protocol buffer options. + edition: + type: string description: >- - Uses the same format as in IAM policy. `member` must include both a - prefix and ID. For example, `user:{emailId}`, - `serviceAccount:{emailId}`, `group:{emailId}`. - id: PolicyBinding - CustomHttpPattern: - description: A custom pattern is used for defining custom HTTP verb. - properties: - kind: - description: The name of this custom HTTP verb. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + syntax: + description: The source syntax. type: string - path: - description: The path matched by this custom verb. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + fields: + items: + $ref: '#/components/schemas/Field' + description: The list of fields. + type: array + oneofs: + items: + type: string + description: The list of types appearing in `oneof` definitions in this type. + type: array + name: + description: The fully qualified message name. + type: string + description: A protocol buffer message type. + type: object + ApplyTenantProjectConfigRequest: + id: ApplyTenantProjectConfigRequest + properties: + projectConfig: + $ref: '#/components/schemas/TenantProjectConfig' + description: Configuration that should be applied to the existing tenant project. + tag: + description: >- + Required. Tag of the project. Must be less than 128 characters. + Required. type: string type: object - id: CustomHttpPattern + description: Request to apply configuration to an existing tenant project. OAuthRequirements: - id: OAuthRequirements type: object properties: canonicalScopes: + type: string description: >- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read - type: string + id: OAuthRequirements description: >- OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google @@ -2162,403 +2152,385 @@ components: that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. - SourceContext: - type: object + Field: properties: - fileName: + number: + type: integer + description: The field number. + format: int32 + options: + items: + $ref: '#/components/schemas/Option' + description: The protocol buffer options. + type: array + kind: + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + description: The field type. + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 type: string + packed: + type: boolean + description: Whether to use alternative packed wire representation. + oneofIndex: + type: integer description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - id: SourceContext - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - RemoveTenantProjectRequest: - description: >- - Request message to remove a tenant project resource from the tenancy - unit. - id: RemoveTenantProjectRequest - type: object - properties: - tag: + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + format: int32 + name: + description: The field name. type: string - description: Required. Tag of the resource within the tenancy unit. - RubySettings: - id: RubySettings - description: Settings for Ruby client libraries. - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object - LoggingDestination: - id: LoggingDestination - properties: - logs: - type: array - items: - type: string - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - monitoredResource: - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. + cardinality: + type: string + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + description: The field cardinality. + defaultValue: type: string - type: object - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - Http: - properties: - fullyDecodeReservedExpansion: description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - type: boolean - rules: + The string value of the default value of this field. Proto2 syntax + only. + jsonName: + description: The field JSON name. + type: string + typeUrl: + type: string description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - type: array - items: - $ref: '#/components/schemas/HttpRule' - id: Http - type: object - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - V1Beta1BatchCreateProducerOverridesResponse: - id: V1Beta1BatchCreateProducerOverridesResponse + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. type: object - properties: - overrides: - description: The overrides that were created. - type: array - items: - $ref: '#/components/schemas/V1Beta1QuotaOverride' - description: Response message for BatchCreateProducerOverrides - Billing: + id: Field + description: A single field of a message type. + TenantResource: + id: TenantResource type: object - id: Billing - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count - properties: - consumerDestinations: - items: - $ref: '#/components/schemas/BillingDestination' - description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - type: array - DocumentationRule: properties: - selector: + status: + description: Status of tenant resource. + enumDescriptions: + - Unspecified status is the default unset value. + - Creation of the tenant resource is ongoing. + - Active resource. + - Deletion of the resource is ongoing. + - Tenant resource creation or deletion has failed. + - Tenant resource has been deleted. type: string - description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. - disableReplacementWords: + enum: + - STATUS_UNSPECIFIED + - PENDING_CREATE + - ACTIVE + - PENDING_DELETE + - FAILED + - DELETED + tag: + description: Unique per single tenancy unit. + type: string + resource: + readOnly: true type: string description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. - deprecationDescription: - description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. + Output only. @OutputOnly Identifier of the tenant resource. For + cloud projects, it is in the form 'projects/{number}'. For example + 'projects/123456'. + description: Resource constituting the TenancyUnit. + JwtLocation: + type: object + properties: + query: + description: Specifies URL query parameter name to extract JWT token. type: string - description: + cookie: + description: Specifies cookie name to extract JWT token. + type: string + header: + description: Specifies HTTP header name to extract JWT token. + type: string + valuePrefix: type: string description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. - description: A documentation rule provides information about individual API elements. - id: DocumentationRule - type: object - Documentation: - description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + description: Specifies a location to extract JWT from an API request. + id: JwtLocation + PolicyBinding: + id: PolicyBinding type: object - id: Documentation properties: - overview: - type: string - description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - rules: + members: description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. + Uses the same format as in IAM policy. `member` must include both a + prefix and ID. For example, `user:{emailId}`, + `serviceAccount:{emailId}`, `group:{emailId}`. type: array items: - $ref: '#/components/schemas/DocumentationRule' - documentationRootUrl: + type: string + role: + description: >- + Role. (https://cloud.google.com/iam/docs/understanding-roles) For + example, `roles/viewer`, `roles/editor`, or `roles/owner`. type: string - description: The URL to the root of documentation. - sectionOverrides: + description: Translates to IAM Policy bindings (without auditing at this level) + ListTenancyUnitsResponse: + type: object + properties: + nextPageToken: + description: Pagination token for large results. + type: string + tenancyUnits: type: array items: - $ref: '#/components/schemas/Page' - description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - serviceRootUrl: - type: string - description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. - summary: - description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. + $ref: '#/components/schemas/TenancyUnit' + description: Tenancy units matching the request. + id: ListTenancyUnitsResponse + description: Response for the list request. + SearchTenancyUnitsResponse: + properties: + nextPageToken: type: string - pages: + description: Pagination token for large results. + tenancyUnits: + description: Tenancy Units matching the request. type: array items: - $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. - NodeSettings: - description: Settings for Node client libraries. - id: NodeSettings + $ref: '#/components/schemas/TenancyUnit' type: object + description: Response for the search query. + id: SearchTenancyUnitsResponse + JavaSettings: + id: JavaSettings + description: Settings for Java client libraries. properties: + libraryPackage: + type: string + description: >- + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 + serviceClassNames: + additionalProperties: + type: string + type: object + description: >- + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - Monitoring: - id: Monitoring + type: object + DotnetSettings: properties: - producerDestinations: - description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + forcedNamespaceAliases: type: array + description: >- + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision items: - $ref: '#/components/schemas/MonitoringDestination' - consumerDestinations: + type: string + renamedResources: + type: object + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + additionalProperties: + type: string + ignoredResources: type: array items: - $ref: '#/components/schemas/MonitoringDestination' + type: string description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - type: object - description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - V1GenerateServiceAccountResponse: - description: >- - Response message for the `GenerateServiceAccount` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - properties: - account: - description: ServiceAccount that was created or retrieved. - $ref: '#/components/schemas/V1ServiceAccount' - type: object - id: V1GenerateServiceAccountResponse - JwtLocation: - description: Specifies a location to extract JWT from an API request. - properties: - cookie: - type: string - description: Specifies cookie name to extract JWT token. - valuePrefix: + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + renamedServices: + type: object + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + additionalProperties: + type: string + handwrittenSignatures: + type: array description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - type: string - header: - description: Specifies HTTP header name to extract JWT token. - type: string - query: - description: Specifies URL query parameter name to extract JWT token. - type: string + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + items: + type: string type: object - id: JwtLocation - EnumValue: + description: Settings for Dotnet client libraries. + id: DotnetSettings + AuthenticationRule: type: object properties: - name: - description: Enum value name. + allowWithoutCredential: + description: >- + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + type: boolean + oauth: + description: The requirements for OAuth credentials. + $ref: '#/components/schemas/OAuthRequirements' + selector: type: string - options: - description: Protocol buffer options. + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + requirements: + description: Requirements for additional authentication providers. items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/AuthRequirement' type: array - number: - description: Enum value number. - format: int32 - type: integer - id: EnumValue - description: Enum value definition. - TenantProjectConfig: - id: TenantProjectConfig + id: AuthenticationRule + description: >- + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + RemoveTenantProjectRequest: + description: >- + Request message to remove a tenant project resource from the tenancy + unit. + id: RemoveTenantProjectRequest + type: object + properties: + tag: + type: string + description: Required. Tag of the resource within the tenancy unit. + CustomError: type: object description: >- - This structure defines a tenant project to be added to the specified - tenancy unit and its initial configuration and properties. A project - lien is created for the tenant project to prevent the tenant project - from being deleted accidentally. The lien is deleted as part of tenant - project removal. + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + id: CustomError properties: - services: - description: >- - Google Cloud API names of services that are activated on this - project during provisioning. If any of these services can't be - activated, the request fails. For example: - 'compute.googleapis.com','cloudfunctions.googleapis.com' + types: type: array + description: >- + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. items: type: string - tenantProjectPolicy: - $ref: '#/components/schemas/TenantProjectPolicy' - description: Describes ownership and policies for the new tenant project. - serviceAccountConfig: - $ref: '#/components/schemas/ServiceAccountConfig' - description: Configuration for the IAM service account on the tenant project. - billingConfig: - description: Billing account properties. The billing account must be specified. - $ref: '#/components/schemas/BillingConfig' - labels: - description: Labels that are applied to this project. - additionalProperties: - type: string - type: object - folder: - type: string + rules: + items: + $ref: '#/components/schemas/CustomErrorRule' + type: array description: >- - Folder where project in this tenancy unit must be located This - folder must have been previously created with the required - permissions for the caller to create and configure a project in it. - Valid folder resource names have the format - `folders/{folder_number}` (for example, `folders/123456`). - PythonSettings: - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - id: PythonSettings - description: Settings for Python client libraries. + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + Authentication: type: object + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + id: Authentication + properties: + providers: + items: + $ref: '#/components/schemas/AuthProvider' + type: array + description: Defines a set of authentication providers that a service supports. + rules: + description: >- + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + items: + $ref: '#/components/schemas/AuthenticationRule' LongRunning: + type: object id: LongRunning properties: + totalPollTimeout: + description: 'Total polling timeout. Default value: 5 minutes.' + format: google-duration + type: string + pollDelayMultiplier: + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + format: float + type: number initialPollDelay: format: google-duration description: >- @@ -2569,459 +2541,489 @@ components: description: >- Maximum time between two subsequent poll requests. Default value: 45 seconds. - format: google-duration - type: string - pollDelayMultiplier: - format: float - type: number - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - totalPollTimeout: type: string - description: 'Total polling timeout. Default value: 5 minutes.' format: google-duration description: >- Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + DocumentationRule: + properties: + description: + type: string + description: >- + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + disableReplacementWords: + type: string + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + deprecationDescription: + type: string + description: >- + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + selector: + type: string + description: >- + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + description: A documentation rule provides information about individual API elements. type: object - Authentication: + id: DocumentationRule + Quota: + type: object + properties: + metricRules: + description: >- + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + type: array + items: + $ref: '#/components/schemas/MetricRule' + limits: + type: array + items: + $ref: '#/components/schemas/QuotaLimit' + description: List of QuotaLimit definitions for the service. description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + id: Quota + Billing: + id: Billing type: object + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count properties: - providers: - items: - $ref: '#/components/schemas/AuthProvider' - type: array - description: Defines a set of authentication providers that a service supports. - rules: + consumerDestinations: description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. items: - $ref: '#/components/schemas/AuthenticationRule' + $ref: '#/components/schemas/BillingDestination' type: array - id: Authentication - SystemParameterRule: + RubySettings: type: object - id: SystemParameterRule + description: Settings for Ruby client libraries. properties: - parameters: - items: - $ref: '#/components/schemas/SystemParameter' - type: array - description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. - selector: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + id: RubySettings + V1Beta1ProducerQuotaPolicy: + id: V1Beta1ProducerQuotaPolicy + type: object + description: Quota policy created by service producer. + properties: + policyValue: + format: int64 description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). type: string - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - ListTenancyUnitsResponse: - id: ListTenancyUnitsResponse - description: Response for the list request. - properties: - tenancyUnits: - items: - $ref: '#/components/schemas/TenancyUnit' - description: Tenancy units matching the request. - type: array - nextPageToken: - description: Pagination token for large results. + unit: + description: >- + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. type: string - type: object - LabelDescriptor: - id: LabelDescriptor - description: A description of a label. - properties: - key: + container: type: string - description: The label key. - description: + description: >- + The cloud resource container at which the quota policy is created. + The format is {container_type}/{container_number} + name: type: string - description: A human-readable description for the label. - valueType: - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. + description: >- + The resource name of the producer policy. An example name would be: + `services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d` + metric: type: string - description: The type of data that can be assigned to the label. - enum: - - STRING - - BOOL - - INT64 + description: >- + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + dimensions: + type: object + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key "region" and the value "us-east-1"; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit''s unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key. * "project" is not a valid key; the project is already specified in the parent resource name. * "user" is not a valid key; the API does not support quota polcies that apply only to a specific user. * If "region" appears as a key, its value must be a valid Cloud region. * If "zone" appears as a key, its value must be a valid Cloud zone. * If any valid key other than "region" or "zone" appears in the map, then all valid keys other than "region" or "zone" must also appear in the map.' + additionalProperties: + type: string + V1Beta1DisableConsumerResponse: + id: V1Beta1DisableConsumerResponse + description: >- + Response message for the `DisableConsumer` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. type: object - V1Beta1ServiceIdentity: - description: A service identity in the Identity and Access Management API. + properties: {} + SystemParameter: + id: SystemParameter + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. type: object - id: V1Beta1ServiceIdentity properties: - name: - description: >- - P4 service identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` - type: string - tag: + urlQueryParameter: type: string description: >- - The P4 service identity configuration tag. This must be defined in - activation_grants. If not specified when creating the account, the - tag is set to "default". - email: + Define the URL query parameter name to use for the parameter. It is + case sensitive. + httpHeader: type: string - description: The email address of the service identity. - uniqueId: + description: >- + Define the HTTP header name to use for the parameter. It is case + insensitive. + name: type: string - description: The unique and stable id of the service identity. - AuthProvider: + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. + QuotaLimit: + id: QuotaLimit properties: - id: + name: + type: string description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + description: + description: >- + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + type: string + maxLimit: + format: int64 type: string - jwtLocations: - items: - $ref: '#/components/schemas/JwtLocation' description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - type: array - issuer: + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + metric: description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. type: string - authorizationUrl: + freeTier: type: string + format: int64 description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - audiences: + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + unit: + type: string description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + values: + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + additionalProperties: + type: string + format: int64 + type: object + defaultLimit: type: string - jwksUri: + description: >- + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + format: int64 + duration: type: string description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - id: AuthProvider + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + displayName: + description: >- + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + type: string type: object description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - MetricDescriptor: + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. + FieldPolicy: + id: FieldPolicy type: object - id: MetricDescriptor + description: >- + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. properties: - launchStage: - type: string - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Optional. The launch stage of the metric definition. - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - name: + resourceType: + description: >- + Specifies the resource type for the resource referred to by the + field. type: string - description: The resource name of the metric descriptor. - displayName: + resourcePermission: + description: >- + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". type: string + selector: description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". + type: string + LabelDescriptor: + type: object + id: LabelDescriptor + properties: valueType: - description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. + type: string enum: - - VALUE_TYPE_UNSPECIFIED + - STRING - BOOL - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. - type: string - unit: - type: string - description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). - metadata: - description: Optional. Metadata which can be used to guide usage of the metric. - $ref: '#/components/schemas/MetricDescriptorMetadata' + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + description: The type of data that can be assigned to the label. description: - description: >- - A detailed description of the metric, which can be used in - documentation. + description: A human-readable description for the label. type: string - metricKind: - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE + key: + description: The label key. type: string - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - monitoredResourceTypes: + description: A description of a label. + CustomErrorRule: + description: A custom error rule. + id: CustomErrorRule + type: object + properties: + selector: description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - items: - type: string - type: array - type: + Selects messages to which this rule applies. Refer to selector for + syntax details. type: string + isErrorType: + type: boolean description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - labels: + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + Control: + id: Control + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + properties: + environment: description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + type: string + methodPolicies: + type: array + description: Defines policies applying to the API methods of the service. items: - $ref: '#/components/schemas/LabelDescriptor' + $ref: '#/components/schemas/MethodPolicy' + type: object + Backend: + type: object + properties: + rules: type: array + description: >- + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/BackendRule' + id: Backend + description: '`Backend` defines the backend configuration for a service.' + Monitoring: + id: Monitoring description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. - MonitoredResourceDescriptor: + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue type: object - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - id: MonitoredResourceDescriptor properties: - labels: + consumerDestinations: type: array items: - $ref: '#/components/schemas/LabelDescriptor' + $ref: '#/components/schemas/MonitoringDestination' description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. - type: - type: string + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + producerDestinations: description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - name: + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + items: + $ref: '#/components/schemas/MonitoringDestination' + type: array + UndeleteTenantProjectRequest: + description: >- + Request message to undelete tenant project resource previously deleted + from the tenancy unit. + id: UndeleteTenantProjectRequest + properties: + tag: type: string + description: Required. Tag of the resource within the tenancy unit. + type: object + MetricDescriptorMetadata: + properties: + ingestDelay: description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. - displayName: + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. type: string + format: google-duration + samplePeriod: + format: google-duration description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. - description: - description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. type: string + timeSeriesResourceHierarchyLevel: + type: array + items: + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + type: string + description: The scope of the timeseries data of the metric. launchStage: + deprecated: true + type: string + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -3060,8 +3062,6 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - description: Optional. The launch stage of the monitored resource definition. enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED @@ -3071,287 +3071,468 @@ components: - BETA - GA - DEPRECATED - QuotaLimit: + description: Additional annotations that can be used to guide the usage of a metric. + id: MetricDescriptorMetadata + type: object + Method: + description: Method represents a method of an API interface. + id: Method + type: object properties: - duration: + requestTypeUrl: + type: string + description: A URL of the input message type. + options: + type: array + items: + $ref: '#/components/schemas/Option' + description: Any metadata attached to the method. + responseTypeUrl: + type: string + description: The URL of the output message type. + responseStreaming: + description: If true, the response is streamed. + type: boolean + syntax: + type: string + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax of this method. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + name: + type: string + description: The simple name of this method. + requestStreaming: + description: If true, the request is streamed. + type: boolean + V1Beta1ImportProducerOverridesResponse: + type: object + description: Response message for ImportProducerOverrides + properties: + overrides: + items: + $ref: '#/components/schemas/V1Beta1QuotaOverride' + type: array + description: The overrides that were created from the imported data. + id: V1Beta1ImportProducerOverridesResponse + Context: + id: Context + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. + properties: + rules: + description: >- + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/ContextRule' + type: array + type: object + ListOperationsResponse: + type: object + description: The response message for Operations.ListOperations. + id: ListOperationsResponse + properties: + nextPageToken: type: string + description: The standard List next-page token. + operations: + type: array description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - maxLimit: - format: int64 + A list of operations that matches the specified filter in the + request. + items: + $ref: '#/components/schemas/Operation' + MethodSettings: + type: object + id: MethodSettings + description: Describes the generator configuration for a method. + properties: + autoPopulatedFields: description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - type: string - freeTier: + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id + type: array + items: + type: string + longRunning: + $ref: '#/components/schemas/LongRunning' description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - type: string - format: int64 - unit: + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + selector: description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - type: string - displayName: + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... type: string - description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. + CppSettings: + description: Settings for C++ client libraries. + id: CppSettings + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + type: object + Mixin: + id: Mixin + type: object + description: >- + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + properties: name: + description: The fully qualified name of the interface which is included. type: string - description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - description: + root: type: string description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - metric: - description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - type: string - values: - additionalProperties: - format: int64 - type: string + If non-empty specifies a path under which inherited HTTP paths are + rooted. + Option: + type: object + properties: + value: type: object + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - defaultLimit: - format: int64 + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + name: description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. type: string - type: object description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - id: QuotaLimit - Service: - id: Service - type: object + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + id: Option + SystemParameterRule: + id: SystemParameterRule description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth + Define a system parameter rule mapping system parameter definitions to + methods. + type: object properties: - systemTypes: + selector: + type: string description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - items: - $ref: '#/components/schemas/Type' + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + parameters: type: array - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - apis: - description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. items: - $ref: '#/components/schemas/Api' - type: array - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - monitoring: - $ref: '#/components/schemas/Monitoring' - description: Monitoring configuration. - documentation: - $ref: '#/components/schemas/Documentation' - description: Additional API documentation. - enums: + $ref: '#/components/schemas/SystemParameter' + description: >- + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. + CustomHttpPattern: + description: A custom pattern is used for defining custom HTTP verb. + type: object + properties: + path: + description: The path matched by this custom verb. + type: string + kind: + description: The name of this custom HTTP verb. + type: string + id: CustomHttpPattern + Logging: + type: object + id: Logging + properties: + consumerDestinations: type: array description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. items: - $ref: '#/components/schemas/Enum' - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. - name: + $ref: '#/components/schemas/LoggingDestination' + producerDestinations: + type: array + items: + $ref: '#/components/schemas/LoggingDestination' + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history + AttachTenantProjectRequest: + properties: + tag: type: string description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - types: - type: array + Required. Tag of the tenant resource after attachment. Must be less + than 128 characters. Required. + externalResource: description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - items: - $ref: '#/components/schemas/Type' - monitoredResources: + When attaching an external project, this is in the format of + `projects/{project_number}`. + type: string + reservedResource: description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - type: array - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - id: + When attaching a reserved project already in tenancy units, this is + the tag of a tenant resource under the tenancy unit for the managed + service's service producer project. The reserved tenant resource + must be in an active state. type: string + description: >- + Request to attach an existing project to the tenancy unit as a new + tenant resource. + id: AttachTenantProjectRequest + type: object + GoSettings: + description: Settings for Go client libraries. + id: GoSettings + type: object + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + BackendRule: + properties: + operationDeadline: + format: double description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - producerProjectId: - description: The Google project that owns this service. + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + type: number + pathTranslation: + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS type: string - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - backend: - description: API backend configuration. - $ref: '#/components/schemas/Backend' - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - metrics: - description: Defines the metrics used by this service. - items: - $ref: '#/components/schemas/MetricDescriptor' - type: array - title: + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + protocol: + description: >- + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + type: string + address: type: string description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - sourceInfo: - $ref: '#/components/schemas/SourceInfo' + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + jwtAudience: description: >- - Output only. The source information for this configuration if - available. - logs: - items: - $ref: '#/components/schemas/LogDescriptor' - type: array - description: Defines the logs used by this service. - publishing: + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. + type: string + minDeadline: + deprecated: true + format: double + type: number + description: Deprecated, do not use. + disableAuth: + type: boolean description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - $ref: '#/components/schemas/Publishing' - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - configVersion: + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + deadline: + type: number + format: double description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - format: uint32 - type: integer - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. - endpoints: + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + selector: + type: string + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + overridesByRequestProtocol: + description: The map between request protocol and the backend address. + additionalProperties: + $ref: '#/components/schemas/BackendRule' + type: object + description: A backend rule provides configuration for an individual API element. + type: object + id: BackendRule + SourceInfo: + description: Source information used to create a Service Config + id: SourceInfo + type: object + properties: + sourceFiles: type: array - description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. + description: All files used during config generation. items: - $ref: '#/components/schemas/Endpoint' - MetricDescriptorMetadata: - description: Additional annotations that can be used to guide the usage of a metric. - id: MetricDescriptorMetadata + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + ClientLibrarySettings: + description: Details about how and where to publish client libraries. type: object + id: ClientLibrarySettings properties: - ingestDelay: - format: google-duration - description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - type: string - samplePeriod: - format: google-duration + version: description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". type: string + phpSettings: + $ref: '#/components/schemas/PhpSettings' + description: Settings for PHP client libraries. + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + nodeSettings: + description: Settings for Node client libraries. + $ref: '#/components/schemas/NodeSettings' + pythonSettings: + description: Settings for Python client libraries. + $ref: '#/components/schemas/PythonSettings' launchStage: - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + description: Launch stage of this version of the API. enumDescriptions: - Do not use this default value. - The feature is not yet implemented. Users can not use it. @@ -3390,202 +3571,63 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: string - deprecated: true - AddTenantProjectRequest: - type: object - properties: - projectConfig: - $ref: '#/components/schemas/TenantProjectConfig' - description: >- - Configuration of the new tenant project to be added to tenancy unit - resources. - tag: + restNumericEnums: + type: boolean description: >- - Required. Tag of the added project. Must be less than 128 - characters. Required. - type: string - description: >- - Request to add a newly created and configured tenant project to a - tenancy unit. - id: AddTenantProjectRequest - Status: - id: Status - type: object - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + When using transport=rest, the client request will encode enums as + numbers rather than strings. + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + rubySettings: + $ref: '#/components/schemas/RubySettings' + description: Settings for Ruby client libraries. + V1RemoveVisibilityLabelsResponse: properties: - code: - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - details: + labels: type: array description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + The updated set of visibility labels for this consumer on this + service. items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object - MetricRule: - id: MetricRule - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - type: object - properties: - metricCosts: - description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - type: object - additionalProperties: type: string - format: int64 - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - V1DefaultIdentity: - description: A default identity in the Identity and Access Management API. - id: V1DefaultIdentity - type: object - properties: - uniqueId: - description: The unique and stable id of the default identity. - type: string - name: - type: string - description: >- - Default identity resource name. An example name would be: - `services/serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity` - tag: - description: >- - The Default Identity tag. If specified when creating the account, - the tag must be present in activation_grants. If not specified when - creating the account, the tag is set to the tag specified in - activation_grants. - type: string - email: - type: string - description: The email address of the default identity. - LogDescriptor: - description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer - properties: - name: - description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - type: string - labels: - type: array - items: - $ref: '#/components/schemas/LabelDescriptor' - description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - description: - type: string - description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - displayName: - description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - type: string - id: LogDescriptor - type: object - UndeleteTenantProjectRequest: - properties: - tag: - description: Required. Tag of the resource within the tenancy unit. - type: string - id: UndeleteTenantProjectRequest + id: V1RemoveVisibilityLabelsResponse description: >- - Request message to undelete tenant project resource previously deleted - from the tenancy unit. + Response message for the `RemoveVisibilityLabels` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. type: object - AttachTenantProjectRequest: - description: >- - Request to attach an existing project to the tenancy unit as a new - tenant resource. - properties: - reservedResource: - description: >- - When attaching a reserved project already in tenancy units, this is - the tag of a tenant resource under the tenancy unit for the managed - service's service producer project. The reserved tenant resource - must be in an active state. - type: string - tag: - type: string - description: >- - Required. Tag of the tenant resource after attachment. Must be less - than 128 characters. Required. - externalResource: - description: >- - When attaching an external project, this is in the format of - `projects/{project_number}`. - type: string - id: AttachTenantProjectRequest + CancelOperationRequest: + properties: {} + description: The request message for Operations.CancelOperation. type: object + id: CancelOperationRequest parameters: - fields: - description: Selector specifying which fields to include in a partial response. + alt: + description: Data format for response. in: query - name: fields + name: alt schema: type: string - _.xgafv: - description: V1 error format. + enum: + - json + - media + - proto + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: $.xgafv + name: uploadType schema: type: string - enum: - - '1' - - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: upload_protocol + name: prettyPrint schema: - type: string + type: boolean oauth_token: description: OAuth 2.0 token for the current user. in: query @@ -3598,22 +3640,36 @@ components: name: access_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + _.xgafv: + description: V1 error format. in: query - name: prettyPrint + name: $.xgafv schema: - type: boolean - alt: - description: Data format for response. + type: string + enum: + - '1' + - '2' + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: alt + name: fields + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. + in: query + name: quotaUser + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string - enum: - - json - - media - - proto key: description: >- API key. Your API key identifies your project and provides you with API @@ -3629,127 +3685,91 @@ components: name: callback schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string x-stackQL-resources: operations: id: google.serviceconsumermanagement.operations name: operations title: Operations methods: - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 cancel: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' response: mediaType: application/json openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' get: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - delete: + list: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + $ref: '#/paths/~1v1~1operations/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - services: - id: google.serviceconsumermanagement.services - name: services - title: Services - methods: - search: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}:search/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] tenancy_units: id: google.serviceconsumermanagement.tenancy_units name: tenancy_units title: Tenancy_units methods: - apply_project_config: + list: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:applyProjectConfig/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/get response: mediaType: application/json openAPIDocKey: '200' - delete: + objectKey: $.tenancyUnits + create: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}/delete + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/post response: mediaType: application/json openAPIDocKey: '200' - create: + undelete_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + delete: + operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits/get - response: &ref_4 + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}/delete + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.tenancyUnits - list: - operation: *ref_3 - response: *ref_4 - undelete_project: + attach_project: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:undeleteProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:attachProject/post response: mediaType: application/json openAPIDocKey: '200' - attach_project: + apply_project_config: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:attachProject/post + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:applyProjectConfig/post response: mediaType: application/json openAPIDocKey: '200' @@ -3759,6 +3779,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/tenancy_units/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/tenancy_units/methods/delete' tenancy_units_project: @@ -3766,6 +3787,13 @@ components: name: tenancy_units_project title: Tenancy_units_project methods: + delete_project: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post + response: + mediaType: application/json + openAPIDocKey: '200' remove_project: operation: $ref: >- @@ -3780,10 +3808,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_project: + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/tenancy_units_project/methods/add_project + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/tenancy_units_project/methods/delete_project + - $ref: >- + #/components/x-stackQL-resources/tenancy_units_project/methods/remove_project + services: + id: google.serviceconsumermanagement.services + name: services + title: Services + methods: + search: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}~1tenancyUnits~1{tenancyUnitsId}:deleteProject/post + $ref: '#/paths/~1v1~1services~1{servicesId}:search/get' response: mediaType: application/json openAPIDocKey: '200' @@ -3791,54 +3835,22 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: - /v1/operations: - parameters: &ref_5 - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/upload_protocol' + /v1/operations/{operationsId}:cancel: + parameters: &ref_1 + - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/quotaUser' - get: - description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: serviceconsumermanagement.operations.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListOperationsResponse' - parameters: - - in: query - name: filter - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - /v1/operations/{operationsId}:cancel: - parameters: *ref_5 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3875,7 +3887,32 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_5 + parameters: *ref_1 + delete: + description: >- + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: serviceconsumermanagement.operations.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: operationsId + required: true + schema: + type: string get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3900,13 +3937,13 @@ paths: required: true schema: type: string - delete: + /v1/operations: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: serviceconsumermanagement.operations.delete + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: serviceconsumermanagement.operations.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3918,18 +3955,31 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/ListOperationsResponse' parameters: - - in: path - name: operationsId - required: true + - in: query + name: pageToken + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: filter schema: type: string - /v1/services/{servicesId}:search: - parameters: *ref_5 + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: + parameters: *ref_1 get: - description: Search tenancy units for a managed service. - operationId: serviceconsumermanagement.services.search + description: >- + Find the tenancy unit for a managed service and service consumer. This + method shouldn't be used in a service producer's runtime path, for + example to find the tenant project number when creating VMs. Service + producers must persist the tenant project's information after the + project is created. + operationId: serviceconsumermanagement.services.tenancyUnits.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3941,50 +3991,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SearchTenancyUnitsResponse' + $ref: '#/components/schemas/ListTenancyUnitsResponse' parameters: - in: path name: servicesId required: true schema: type: string + - in: path + name: servicesId1 + required: true + schema: + type: string + - in: path + name: servicesId2 + required: true + schema: + type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: type: integer format: int32 - in: query - name: query - schema: - type: string - - in: query - name: pageToken + name: filter schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: - parameters: *ref_5 post: description: >- - Apply a configuration to an existing tenant project. This project must - exist in an active state and have the original owner account. The caller - must have permission to add a project to the given tenancy unit. The - configuration is applied, but any existing settings on the project - aren't modified. Specified policy bindings are applied. Existing - bindings aren't modified. Specified services are activated. No service - is deactivated. If specified, new billing configuration is applied. Omit - a billing configuration to keep the existing one. A service account in - the project is created if previously non existed. Specified labels will - be appended to tenant project, note that the value of existing label key - will be updated if the same label key is requested. The specified folder - is ignored, as moving a tenant project to a different folder isn't - supported. The operation fails if any of the steps fail, but no rollback - of already applied configuration changes is attempted. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.applyProjectConfig + Creates a tenancy unit with no tenant resources. If tenancy unit already + exists, it will be returned, however, in this case, returned TenancyUnit + does not have tenant_resources field set and ListTenancyUnits has to be + used to get a complete TenancyUnit with all fields populated. + operationId: serviceconsumermanagement.services.tenancyUnits.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplyTenantProjectConfigRequest' + $ref: '#/components/schemas/CreateTenancyUnitRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3996,7 +4044,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/TenancyUnit' parameters: - in: path name: servicesId @@ -4013,18 +4061,24 @@ paths: required: true schema: type: string - - in: path - name: tenancyUnitsId - required: true - schema: - type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: - parameters: *ref_5 - delete: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: + parameters: *ref_1 + post: description: >- - Delete a tenancy unit. Before you delete the tenancy unit, there should - be no tenant resources in it that aren't in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.delete + Deletes the specified project resource identified by a tenant resource + tag. The mothod removes a project lien with a 'TenantManager' origin if + that was added. It will then attempt to delete the project. If that + operation fails, this method also fails. After the project has been + deleted, the tenant resource state is set to DELETED. To permanently + remove resource metadata, call the `RemoveTenantProject` method. New + resources with the same tag can't be added if there are existing + resources in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4058,20 +4112,23 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits: - parameters: *ref_5 + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: + parameters: *ref_1 post: description: >- - Creates a tenancy unit with no tenant resources. If tenancy unit already - exists, it will be returned, however, in this case, returned TenancyUnit - does not have tenant_resources field set and ListTenancyUnits has to be - used to get a complete TenancyUnit with all fields populated. - operationId: serviceconsumermanagement.services.tenancyUnits.create + Removes the specified project resource identified by a tenant resource + tag. The method removes the project lien with 'TenantManager' origin if + that was added. It then attempts to delete the project. If that + operation fails, this method also fails. Calls to remove already removed + or non-existent tenant project succeed. After the project has been + deleted, or if was already in a DELETED state, resource metadata is + permanently removed from the tenancy unit. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.removeProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTenancyUnitRequest' + $ref: '#/components/schemas/RemoveTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4083,7 +4140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TenancyUnit' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -4100,14 +4157,26 @@ paths: required: true schema: type: string - get: + - in: path + name: tenancyUnitsId + required: true + schema: + type: string + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: + parameters: *ref_1 + post: description: >- - Find the tenancy unit for a managed service and service consumer. This - method shouldn't be used in a service producer's runtime path, for - example to find the tenant project number when creating VMs. Service - producers must persist the tenant project's information after the - project is created. - operationId: serviceconsumermanagement.services.tenancyUnits.list + Attempts to undelete a previously deleted tenant project. The project + must be in a DELETED state. There are no guarantees that an undeleted + project will be in a fully restored and functional state. Call the + `ApplyTenantProjectConfig` method to update its configuration and then + validate all managed service resources. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UndeleteTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4119,7 +4188,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListTenancyUnitsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -4136,36 +4205,18 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - - in: query - name: filter + - in: path + name: tenancyUnitsId + required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject: - parameters: *ref_5 - post: + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}: + parameters: *ref_1 + delete: description: >- - Removes the specified project resource identified by a tenant resource - tag. The method removes the project lien with 'TenantManager' origin if - that was added. It then attempts to delete the project. If that - operation fails, this method also fails. Calls to remove already removed - or non-existent tenant project succeed. After the project has been - deleted, or if was already in a DELETED state, resource metadata is - permanently removed from the tenancy unit. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.removeProject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemoveTenantProjectRequest' + Delete a tenancy unit. Before you delete the tenancy unit, there should + be no tenant resources in it that aren't in a DELETED state. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4199,21 +4250,26 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:undeleteProject: - parameters: *ref_5 + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: + parameters: *ref_1 post: description: >- - Attempts to undelete a previously deleted tenant project. The project - must be in a DELETED state. There are no guarantees that an undeleted - project will be in a fully restored and functional state. Call the - `ApplyTenantProjectConfig` method to update its configuration and then - validate all managed service resources. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.undeleteProject + Attach an existing project to the tenancy unit as a new tenant resource. + The project could either be the tenant project reserved by calling + `AddTenantProject` under a tenancy unit of a service producer's project + of a managed service, or from a separate project. The caller is checked + against a set of permissions as if calling `AddTenantProject` on the + same service consumer. To trigger the attachment, the targeted tenant + project must be in a folder. Make sure the ServiceConsumerManagement + service account is the owner of that project. These two requirements are + already met if the project is reserved by calling `AddTenantProject`. + Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.attachProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/UndeleteTenantProjectRequest' + $ref: '#/components/schemas/AttachTenantProjectRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4248,7 +4304,7 @@ paths: schema: type: string /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Add a new tenant project to the tenancy unit. There can be a maximum of @@ -4295,24 +4351,30 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:deleteProject: - parameters: *ref_5 + /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:applyProjectConfig: + parameters: *ref_1 post: description: >- - Deletes the specified project resource identified by a tenant resource - tag. The mothod removes a project lien with a 'TenantManager' origin if - that was added. It will then attempt to delete the project. If that - operation fails, this method also fails. After the project has been - deleted, the tenant resource state is set to DELETED. To permanently - remove resource metadata, call the `RemoveTenantProject` method. New - resources with the same tag can't be added if there are existing - resources in a DELETED state. Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.deleteProject + Apply a configuration to an existing tenant project. This project must + exist in an active state and have the original owner account. The caller + must have permission to add a project to the given tenancy unit. The + configuration is applied, but any existing settings on the project + aren't modified. Specified policy bindings are applied. Existing + bindings aren't modified. Specified services are activated. No service + is deactivated. If specified, new billing configuration is applied. Omit + a billing configuration to keep the existing one. A service account in + the project is created if previously non existed. Specified labels will + be appended to tenant project, note that the value of existing label key + will be updated if the same label key is requested. The specified folder + is ignored, as moving a tenant project to a different folder isn't + supported. The operation fails if any of the steps fail, but no rollback + of already applied configuration changes is attempted. Operation. + operationId: serviceconsumermanagement.services.tenancyUnits.applyProjectConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteTenantProjectRequest' + $ref: '#/components/schemas/ApplyTenantProjectConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4346,26 +4408,11 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:attachProject: - parameters: *ref_5 - post: - description: >- - Attach an existing project to the tenancy unit as a new tenant resource. - The project could either be the tenant project reserved by calling - `AddTenantProject` under a tenancy unit of a service producer's project - of a managed service, or from a separate project. The caller is checked - against a set of permissions as if calling `AddTenantProject` on the - same service consumer. To trigger the attachment, the targeted tenant - project must be in a folder. Make sure the ServiceConsumerManagement - service account is the owner of that project. These two requirements are - already met if the project is reserved by calling `AddTenantProject`. - Operation. - operationId: serviceconsumermanagement.services.tenancyUnits.attachProject - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AttachTenantProjectRequest' + /v1/services/{servicesId}:search: + parameters: *ref_1 + get: + description: Search tenancy units for a managed service. + operationId: serviceconsumermanagement.services.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4377,25 +4424,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/SearchTenancyUnitsResponse' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: servicesId1 - required: true + - in: query + name: pageToken schema: type: string - - in: path - name: servicesId2 - required: true + - in: query + name: pageSize schema: - type: string - - in: path - name: tenancyUnitsId - required: true + type: integer + format: int32 + - in: query + name: query schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml index 66026d55..eed1114f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicecontrol.yaml @@ -9,8 +9,8 @@ info: Provides admission control and telemetry reporting for services integrated with Service Infrastructure. version: v2 - x-discovery-doc-revision: '20240516' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240830' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/service-control/ servers: @@ -922,10 +922,10 @@ components: properties: payload: description: >- - Optional. Resource payload that is currently in scope and is - subjected to orgpolicy conditions. This payload may be the subset of - the actual Resource that may come in the request. This payload - should not contain any core content. + Optional. Deprecated. Resource payload that is currently in scope + and is subjected to orgpolicy conditions. This payload may be the + subset of the actual Resource that may come in the request. + deprecated: true type: object additionalProperties: type: any @@ -938,12 +938,9 @@ components: type: string resourceTags: description: >- - Optional. Tags referenced on the resource at the time of evaluation. - These also include the federated tags, if they are supplied in the - CheckOrgPolicy or CheckCustomConstraints Requests. Optional field as - of now. These tags are the Cloud tags that are available on the - resource during the policy evaluation and will be available as part - of the OrgPolicy check response for logging purposes. + Optional. Deprecated. Tags referenced on the resource at the time of + evaluation. + deprecated: true type: object additionalProperties: type: string @@ -1365,6 +1362,14 @@ components: - API_PATH_UNSPECIFIED - REQUEST - RESPONSE + contextId: + description: >- + The ESF unique context id of the api request, from which this + resource event originated. This field is only needed for CAIS + integration via api annotation. See go/cais-lro-delete for more + details. + type: string + format: int64 parameters: access_token: description: OAuth access token. @@ -1467,6 +1472,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v2/services/{serviceName}:check: diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml index 2b4c0f6e..f513e202 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicedirectory.yaml @@ -9,8 +9,8 @@ info: Service Directory is a platform for discovering, publishing, and connecting services. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240821' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/service-directory servers: @@ -690,16 +690,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -712,6 +709,7 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] namespaces: id: google.servicedirectory.namespaces @@ -725,17 +723,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1namespaces/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.namespaces - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -765,6 +760,7 @@ components: - $ref: '#/components/x-stackQL-resources/namespaces/methods/create' update: - $ref: '#/components/x-stackQL-resources/namespaces/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete' namespaces_iam_policies: @@ -772,17 +768,14 @@ components: name: namespaces_iam_policies title: Namespaces_iam_policies methods: - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1namespaces~1{namespacesId}:getIamPolicy/post - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 set_iam_policy: operation: $ref: >- @@ -803,6 +796,9 @@ components: #/components/x-stackQL-resources/namespaces_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/namespaces_iam_policies/methods/set_iam_policy delete: [] services: id: google.servicedirectory.services @@ -823,17 +819,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1namespaces~1{namespacesId}~1services/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -863,6 +856,7 @@ components: - $ref: '#/components/x-stackQL-resources/services/methods/create' update: - $ref: '#/components/x-stackQL-resources/services/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_iam_policies: @@ -870,17 +864,14 @@ components: name: services_iam_policies title: Services_iam_policies methods: - _get_iam_policy: - operation: &ref_9 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1namespaces~1{namespacesId}~1services~1{servicesId}:getIamPolicy/post - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_9 - response: *ref_10 set_iam_policy: operation: $ref: >- @@ -901,6 +892,9 @@ components: #/components/x-stackQL-resources/services_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/services_iam_policies/methods/set_iam_policy delete: [] endpoints: id: google.servicedirectory.endpoints @@ -914,17 +908,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1namespaces~1{namespacesId}~1services~1{servicesId}~1endpoints/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.endpoints - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -954,11 +945,12 @@ components: - $ref: '#/components/x-stackQL-resources/endpoints/methods/create' update: - $ref: '#/components/x-stackQL-resources/endpoints/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1005,7 +997,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a location. operationId: servicedirectory.projects.locations.get @@ -1033,7 +1025,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces: - parameters: *ref_13 + parameters: *ref_1 post: description: Creates a namespace, and returns the new namespace. operationId: servicedirectory.projects.locations.namespaces.create @@ -1113,7 +1105,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a namespace. operationId: servicedirectory.projects.locations.namespaces.get @@ -1220,7 +1212,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}:getIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: Gets the IAM Policy for a resource (namespace or service only). operationId: servicedirectory.projects.locations.namespaces.getIamPolicy @@ -1258,7 +1250,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}:setIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: Sets the IAM Policy for a resource (namespace or service only). operationId: servicedirectory.projects.locations.namespaces.setIamPolicy @@ -1296,7 +1288,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}:testIamPermissions: - parameters: *ref_13 + parameters: *ref_1 post: description: Tests IAM permissions for a resource (namespace or service only). operationId: servicedirectory.projects.locations.namespaces.testIamPermissions @@ -1334,7 +1326,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services/{servicesId}:resolve: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Returns a service and its associated endpoints. Resolving a service is @@ -1379,7 +1371,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services: - parameters: *ref_13 + parameters: *ref_1 post: description: Creates a service, and returns the new service. operationId: servicedirectory.projects.locations.namespaces.services.create @@ -1469,7 +1461,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services/{servicesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a service. operationId: servicedirectory.projects.locations.namespaces.services.get @@ -1591,7 +1583,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services/{servicesId}:getIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: Gets the IAM Policy for a resource (namespace or service only). operationId: servicedirectory.projects.locations.namespaces.services.getIamPolicy @@ -1634,7 +1626,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services/{servicesId}:setIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: Sets the IAM Policy for a resource (namespace or service only). operationId: servicedirectory.projects.locations.namespaces.services.setIamPolicy @@ -1677,7 +1669,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services/{servicesId}:testIamPermissions: - parameters: *ref_13 + parameters: *ref_1 post: description: Tests IAM permissions for a resource (namespace or service only). operationId: >- @@ -1721,7 +1713,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services/{servicesId}/endpoints: - parameters: *ref_13 + parameters: *ref_1 post: description: Creates an endpoint, and returns the new endpoint. operationId: servicedirectory.projects.locations.namespaces.services.endpoints.create @@ -1821,7 +1813,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/namespaces/{namespacesId}/services/{servicesId}/endpoints/{endpointsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets an endpoint. operationId: servicedirectory.projects.locations.namespaces.services.endpoints.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml index 4e552358..85e0faf1 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicemanagement.yaml @@ -10,8 +10,8 @@ info: on Google Cloud Platform so that they can be discovered and used by service consumers. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/service-management/ servers: @@ -1018,7 +1018,7 @@ components: HttpRule: id: HttpRule description: >- - # gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google @@ -1041,19 +1041,19 @@ components: (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET - /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields - in the request message which are not bound by the path template - automatically become HTTP query parameters if there is no HTTP request - body. For example: service Messaging { rpc GetMessage(GetMessageRequest) - returns (Message) { option (google.api.http) = { - get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { - message SubMessage { string subfield = 1; } string message_id = 1; // - Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter - `revision`. SubMessage sub = 3; // Mapped to URL query parameter - `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP - | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` - | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be @@ -1067,8 +1067,8 @@ components: }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: HTTP | - gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request @@ -1076,8 +1076,8 @@ components: method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC - -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option @@ -1090,36 +1090,37 @@ components: additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | - `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP - mapping 1. Leaf request fields (recursive expansion nested messages in - the request message) are classified into three categories: - Fields - referred by the path template. They are passed via the URL path. - - Fields referred by the HttpRule.body. They are passed via the HTTP - request body. - All other fields are passed via the URL query - parameters, and the parameter name is the field path in the request - message. A repeated field can be represented as multiple query - parameters under the same name. 2. If HttpRule.body is "*", there is no - URL query parameter, all fields are passed via URL path and HTTP request - body. 3. If HttpRule.body is omitted, there is no HTTP request body, all - fields are passed via URL path and URL query parameters. ### Path - template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { - "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = - "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; - Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. - The syntax `**` matches zero or more URL path segments, which must be - the last part of the URL path except the `Verb`. The syntax `Variable` - matches part of the URL path as specified by its template. A variable - template must not contain other variables. If a variable matches a - single path segment, its template may be omitted, e.g. `{var}` is - equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in - the URL path. If the `LITERAL` contains any reserved character, such - characters should be percent-encoded before the matching. If a variable - contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, - when such a variable is expanded into a URL path on the client side, all - characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - does the reverse decoding. Such variables show up in the [Discovery + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a @@ -1128,7 +1129,7 @@ components: "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. ## Using gRPC API Service Configuration gRPC API Service + `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` @@ -1138,10 +1139,10 @@ components: endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. Example: - http: rules: # Selects a gRPC method and applies HttpRule to it. - - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). @@ -1624,12 +1625,17 @@ components: for syntax details. type: string requested: - description: A list of full type names of requested contexts. + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. type: array items: type: string provided: - description: A list of full type names of provided contexts. + description: >- + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. type: array items: type: string @@ -2210,6 +2216,21 @@ components: excluding data loss due to errors. type: string format: google-duration + timeSeriesResourceHierarchyLevel: + description: The scope of the timeseries data of the metric. + type: array + items: + type: string + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER MonitoredResourceDescriptor: id: MonitoredResourceDescriptor description: >- @@ -2906,6 +2927,26 @@ components: common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' + experimentalFeatures: + description: >- + Experimental features to be included during client library + generation. + $ref: '#/components/schemas/ExperimentalFeatures' + ExperimentalFeatures: + id: ExperimentalFeatures + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + type: object + properties: + restAsyncIoEnabled: + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean NodeSettings: id: NodeSettings description: Settings for Node client libraries. @@ -3926,16 +3967,13 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/get' @@ -3948,22 +3986,20 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] services: id: google.servicemanagement.services name: services title: Services methods: - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1services/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.services - list: - operation: *ref_3 - response: *ref_4 create: operation: $ref: '#/paths/~1v1~1services/post' @@ -4001,6 +4037,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/services/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete' services_config: @@ -4020,6 +4057,7 @@ components: #/components/x-stackQL-resources/services_config/methods/get_config insert: [] update: [] + replace: [] delete: [] services_iam_policies: id: google.servicemanagement.services_iam_policies @@ -4032,16 +4070,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: '#/paths/~1v1~1services~1{servicesId}:getIamPolicy/post' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 test_iam_permissions: operation: $ref: '#/paths/~1v1~1services~1{servicesId}:testIamPermissions/post' @@ -4054,22 +4089,22 @@ components: #/components/x-stackQL-resources/services_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/services_iam_policies/methods/set_iam_policy delete: [] configs: id: google.servicemanagement.configs name: configs title: Configs methods: - _list: - operation: &ref_7 + list: + operation: $ref: '#/paths/~1v1~1services~1{serviceName}~1configs/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.serviceConfigs - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: '#/paths/~1v1~1services~1{serviceName}~1configs/post' @@ -4095,22 +4130,20 @@ components: insert: - $ref: '#/components/x-stackQL-resources/configs/methods/create' update: [] + replace: [] delete: [] rollouts: id: google.servicemanagement.rollouts name: rollouts title: Rollouts methods: - _list: - operation: &ref_9 + list: + operation: $ref: '#/paths/~1v1~1services~1{serviceName}~1rollouts/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.rollouts - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: '#/paths/~1v1~1services~1{serviceName}~1rollouts/post' @@ -4130,6 +4163,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/rollouts/methods/create' update: [] + replace: [] delete: [] consumers_iam_policies: id: google.servicemanagement.consumers_iam_policies @@ -4143,17 +4177,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1services~1{servicesId}~1consumers~1{consumersId}:getIamPolicy/post - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -4167,10 +4198,13 @@ components: #/components/x-stackQL-resources/consumers_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/consumers_iam_policies/methods/set_iam_policy delete: [] paths: /v1/operations: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4220,7 +4254,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4250,7 +4284,7 @@ paths: schema: type: string /v1/services: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists managed services. Returns all public services. For authenticated @@ -4331,7 +4365,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: [] /v1/services/{serviceName}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets a managed service. Authentication is required unless the service is @@ -4397,7 +4431,7 @@ paths: schema: type: string /v1/services/{serviceName}:undelete: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Revives a previously deleted managed service. The method restores the @@ -4428,7 +4462,7 @@ paths: schema: type: string /v1/services/{serviceName}/config: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a service configuration (version) for a managed service. operationId: servicemanagement.services.getConfig @@ -4471,7 +4505,7 @@ paths: schema: type: string /v1/services:generateConfigReport: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Generates and returns a report (errors, warnings and changes from @@ -4508,7 +4542,7 @@ paths: $ref: '#/components/schemas/GenerateConfigReportResponse' parameters: [] /v1/services/{servicesId}:setIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4543,7 +4577,7 @@ paths: schema: type: string /v1/services/{servicesId}:getIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4585,7 +4619,7 @@ paths: schema: type: string /v1/services/{servicesId}:testIamPermissions: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4630,7 +4664,7 @@ paths: schema: type: string /v1/services/{serviceName}/configs: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists the history of the service configuration for a managed service, @@ -4712,7 +4746,7 @@ paths: schema: type: string /v1/services/{serviceName}/configs/{configId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a service configuration (version) for a managed service. operationId: servicemanagement.services.configs.get @@ -4756,7 +4790,7 @@ paths: schema: type: string /v1/services/{serviceName}/configs:submit: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Creates a new service configuration (version) for a managed service @@ -4796,7 +4830,7 @@ paths: schema: type: string /v1/services/{serviceName}/rollouts: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists the history of the service configuration rollouts for a managed @@ -4886,7 +4920,7 @@ paths: schema: type: string /v1/services/{serviceName}/rollouts/{rolloutId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a service configuration rollout. operationId: servicemanagement.services.rollouts.get @@ -4926,7 +4960,7 @@ paths: schema: type: string /v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4966,7 +5000,7 @@ paths: schema: type: string /v1/services/{servicesId}/consumers/{consumersId}:getIamPolicy: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5013,7 +5047,7 @@ paths: schema: type: string /v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the diff --git a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml index 4d7c0f64..89356e03 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/servicenetworking.yaml @@ -9,8 +9,8 @@ info: Provides automatic management of network configurations necessary for certain services. version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: >- https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started @@ -38,1100 +38,890 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - PhpSettings: - id: PhpSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object - description: Settings for Php client libraries. - Method: - id: Method + Endpoint: + description: >- + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true properties: - requestTypeUrl: + target: + description: >- + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". type: string - description: A URL of the input message type. - requestStreaming: - description: If true, the request is streamed. - type: boolean - responseStreaming: + aliases: + type: array + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. + items: + type: string + allowCors: + description: >- + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. type: boolean - description: If true, the response is streamed. - syntax: - description: The source syntax of this method. - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - responseTypeUrl: - description: The URL of the output message type. + name: type: string - options: - description: Any metadata attached to the method. + description: The canonical name of this endpoint. + id: Endpoint + type: object + Usage: + properties: + rules: + type: array items: - $ref: '#/components/schemas/Option' + $ref: '#/components/schemas/UsageRule' + description: >- + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + producerNotificationChannel: + description: >- + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + type: string + requirements: type: array + items: + type: string + description: >- + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. + id: Usage + description: Configuration controlling usage of a service. + type: object + Route: + id: Route + properties: + nextHopGateway: + type: string + description: >- + Fully-qualified URL of the gateway that should handle matching + packets that this route applies to. For example: + `projects/123456/global/gateways/default-internet-gateway` + network: + type: string + description: >- + Fully-qualified URL of the VPC network in the producer host tenant + project that this route applies to. For example: + `projects/123456/global/networks/host-network` name: - description: The simple name of this method. + description: Route name. See https://cloud.google.com/vpc/docs/routes + type: string + destRange: + description: Destination CIDR range that this route applies to. type: string + description: >- + Represents a route that was created or discovered by a private access + management service. type: object - description: Method represents a method of an API interface. + LabelDescriptor: + type: object + id: LabelDescriptor + properties: + valueType: + enum: + - STRING + - BOOL + - INT64 + type: string + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + description: The type of data that can be assigned to the label. + description: + type: string + description: A human-readable description for the label. + key: + type: string + description: The label key. + description: A description of a label. + DnsZonePair: + id: DnsZonePair + type: object + description: '* Represents a pair of private and peering DNS zone resources. *' + properties: + consumerPeeringZone: + description: The DNS peering zone in the consumer project. + $ref: '#/components/schemas/DnsZone' + producerPrivateZone: + $ref: '#/components/schemas/DnsZone' + description: The private DNS zone in the shared producer host project. GoSettings: + description: Settings for Go client libraries. + id: GoSettings + type: object properties: common: description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - id: GoSettings + Billing: + id: Billing type: object - description: Settings for Go client libraries. - JavaSettings: + description: >- + Billing related configuration of the service. The following example + shows how to configure monitored resources and metrics for billing, + `consumer_destinations` is the only supported destination and the + monitored resources need at least one label key + `cloud.googleapis.com/location` to indicate the location of the billing + usage, using different monitored resources between monitoring and + billing is recommended so they can be evolved independently: + monitored_resources: - type: library.googleapis.com/billing_branch + labels: - key: cloud.googleapis.com/location description: | Predefined + label to support billing location restriction. - key: city description: + | Custom label to define the city where the library branch is located + in. - key: name description: Custom label to define the name of the + library branch. metrics: - name: + library.googleapis.com/book/borrowed_count metric_kind: DELTA + value_type: INT64 unit: "1" billing: consumer_destinations: - + monitored_resource: library.googleapis.com/billing_branch metrics: - + library.googleapis.com/book/borrowed_count properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - serviceClassNames: + consumerDestinations: description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - type: object - additionalProperties: - type: string - libraryPackage: + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. + type: array + items: + $ref: '#/components/schemas/BillingDestination' + Control: + type: object + id: Control + properties: + environment: + type: string description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + methodPolicies: + description: Defines policies applying to the API methods of the service. + type: array + items: + $ref: '#/components/schemas/MethodPolicy' + description: >- + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + DeleteConnectionRequest: + description: >- + Request to delete a private service access connection. The call will + fail if there are any managed service instances using this connection. + id: DeleteConnectionRequest + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. type: string type: object - id: JavaSettings - description: Settings for Java client libraries. - ClientLibrarySettings: - type: object - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings - properties: - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Launch stage of this version of the API. - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - rubySettings: - description: Settings for Ruby client libraries. - $ref: '#/components/schemas/RubySettings' - javaSettings: - description: Settings for legacy Java features, supported in the Service YAML. - $ref: '#/components/schemas/JavaSettings' - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - version: - type: string - description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - pythonSettings: - $ref: '#/components/schemas/PythonSettings' - description: Settings for Python client libraries. - restNumericEnums: - type: boolean - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - goSettings: - description: Settings for Go client libraries. - $ref: '#/components/schemas/GoSettings' - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - RemoveDnsRecordSetRequest: + DeleteConnectionMetadata: description: >- - Request to remove a record set from a private managed DNS zone in the - shared producer host project. The name, type, ttl, and data values must - all exactly match an existing record set in the specified zone. - id: RemoveDnsRecordSetRequest + Metadata provided through GetOperation request for the LRO generated by + Delete Connection API + properties: {} + id: DeleteConnectionMetadata type: object - properties: - zone: - description: >- - Required. The name of the private DNS zone in the shared producer - host project from which the record set will be removed. - type: string - dnsRecordSet: - description: Required. The DNS record set to remove. - $ref: '#/components/schemas/DnsRecordSet' - consumerNetwork: - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - type: string - Service: - description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth + ContextRule: type: object - id: Service + description: >- + A context rule provides information about the context for an individual + API element. + id: ContextRule properties: - logs: + provided: + type: array + description: >- + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. items: - $ref: '#/components/schemas/LogDescriptor' - description: Defines the logs used by this service. + type: string + requested: + items: + type: string + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. type: array - systemTypes: + allowedResponseExtensions: items: - $ref: '#/components/schemas/Type' + type: string type: array description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - usage: - description: Configuration controlling usage of this service. - $ref: '#/components/schemas/Usage' - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - producerProjectId: - description: The Google project that owns this service. + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + selector: type: string - name: description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - type: string - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - monitoring: - description: Monitoring configuration. - $ref: '#/components/schemas/Monitoring' - http: - description: HTTP configuration. - $ref: '#/components/schemas/Http' - context: - description: Context configuration. - $ref: '#/components/schemas/Context' - configVersion: - format: uint32 + Selects the methods to which this rule applies. Refer to selector + for syntax details. + allowedRequestExtensions: + items: + type: string description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - type: integer - apis: + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. type: array - items: - $ref: '#/components/schemas/Api' + DnsRecordSet: + properties: + type: + description: Required. The identifier of a supported record type. + type: string + ttl: description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. - types: + Required. The period of time for which this RecordSet can be cached + by resolvers. + format: google-duration + type: string + data: type: array description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 + Required. As defined in RFC 1035 (section 5) and RFC 1034 (section + 3.6.1) for examples see + https://cloud.google.com/dns/records/json-record. items: - $ref: '#/components/schemas/Type' - customError: - description: Custom error configuration. - $ref: '#/components/schemas/CustomError' - id: + type: string + domain: type: string description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - sourceInfo: - description: >- - Output only. The source information for this configuration if - available. - $ref: '#/components/schemas/SourceInfo' - metrics: - description: Defines the metrics used by this service. - items: - $ref: '#/components/schemas/MetricDescriptor' - type: array - documentation: - description: Additional API documentation. - $ref: '#/components/schemas/Documentation' - enums: - type: array - description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum - items: - $ref: '#/components/schemas/Enum' - control: - $ref: '#/components/schemas/Control' - description: Configuration for the service control plane. - publishing: - $ref: '#/components/schemas/Publishing' - description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. - title: - description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. - type: string - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - endpoints: - description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. + Required. The DNS or domain name of the record set, e.g. + `test.example.com`. Cloud DNS requires that a DNS suffix ends with a + trailing dot. + description: Represents a DNS record set resource. + id: DnsRecordSet + type: object + SourceInfo: + description: Source information used to create a Service Config + properties: + sourceFiles: items: - $ref: '#/components/schemas/Endpoint' + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object type: array - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. - monitoredResources: + description: All files used during config generation. + type: object + id: SourceInfo + LoggingDestination: + type: object + id: LoggingDestination + properties: + logs: + description: >- + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' + type: string type: array + monitoredResource: description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - Api: - id: Api + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + type: string description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. + Configuration of a specific logging destination (the producer project or + the consumer project). + AuthProvider: + id: AuthProvider + type: object + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). properties: - name: + jwtLocations: + items: + $ref: '#/components/schemas/JwtLocation' description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - type: string - syntax: - description: The source syntax of the service. - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - options: + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token type: array - items: - $ref: '#/components/schemas/Option' - description: Any metadata attached to the interface. - version: + issuer: type: string description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - sourceContext: - $ref: '#/components/schemas/SourceContext' + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + audiences: + type: string description: >- - Source context for the protocol buffer service represented by this - message. - methods: - items: - $ref: '#/components/schemas/Method' - description: The methods of this interface, in unspecified order. - type: array - mixins: - description: Included interfaces. See Mixin. - items: - $ref: '#/components/schemas/Mixin' - type: array - type: object - CloudSQLConfig: - description: Cloud SQL configuration. - type: object - properties: - umbrellaNetwork: - description: The name of the umbrella network in the Cloud SQL umbrella project. + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + authorizationUrl: type: string - service: - description: Peering service used for peering with the Cloud SQL project. + description: >- + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + jwksUri: type: string - umbrellaProject: - format: int64 + description: >- + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + id: type: string - description: The project number of the Cloud SQL umbrella project. - id: CloudSQLConfig - MetricDescriptorMetadata: - description: Additional annotations that can be used to guide the usage of a metric. + description: >- + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". + DnsZone: type: object - id: MetricDescriptorMetadata + description: Represents a DNS zone resource. properties: - ingestDelay: + name: type: string - format: google-duration description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + User assigned name for this resource. Must be unique within the + project. The name must be 1-63 characters long, must begin with a + letter, end with a letter or digit, and only contain lowercase + letters, digits or dashes. + dnsSuffix: type: string - deprecated: true - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - samplePeriod: - type: string - format: google-duration - description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - Mixin: - type: object - id: Mixin - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } - properties: - root: - type: string - description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. - name: - type: string - description: The fully qualified name of the interface which is included. - AddDnsZoneRequest: - description: >- - Request to add a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. - properties: - consumerNetwork: description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - type: string - dnsSuffix: - type: string - description: >- - Required. The DNS name suffix for the zones e.g. `example.com.`. - Cloud DNS requires that a DNS suffix ends with a trailing dot. - name: - description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. Must be - unique within both projects. The name must be 1-63 characters long, - must begin with a letter, end with a letter or digit, and only - contain lowercase letters, digits or dashes. - type: string - id: AddDnsZoneRequest - type: object + The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS + requires that a DNS suffix ends with a trailing dot. + id: DnsZone EnableVpcServiceControlsRequest: + id: EnableVpcServiceControlsRequest properties: consumerNetwork: + type: string description: >- Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is network name. - type: string + type: object description: Request to enable VPC service controls. - id: EnableVpcServiceControlsRequest + Quota: + description: >- + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 type: object - Context: properties: - rules: + limits: items: - $ref: '#/components/schemas/ContextRule' + $ref: '#/components/schemas/QuotaLimit' type: array + description: List of QuotaLimit definitions for the service. + metricRules: + items: + $ref: '#/components/schemas/MetricRule' description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: object - id: Context + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + type: array + id: Quota + ExperimentalFeatures: description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. - SystemParameters: + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + id: ExperimentalFeatures + properties: + restAsyncIoEnabled: + type: boolean + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. type: object - id: SystemParameters + OAuthRequirements: + type: object + id: OAuthRequirements properties: - rules: + canonicalScopes: + type: string description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. - type: array - items: - $ref: '#/components/schemas/SystemParameterRule' + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - PeeredDnsDomain: - id: PeeredDnsDomain + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. + SystemParameter: + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. properties: - name: + urlQueryParameter: + description: >- + Define the URL query parameter name to use for the parameter. It is + case sensitive. type: string + name: description: >- - User assigned name for this resource. Must be unique within the - consumer network. The name must be 1-63 characters long, must begin - with a letter, end with a letter or digit, and only contain - lowercase letters, digits or dashes. - dnsSuffix: + Define the name of the parameter, such as "api_key" . It is case + sensitive. + type: string + httpHeader: type: string description: >- - The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires - that a DNS suffix ends with a trailing dot. + Define the HTTP header name to use for the parameter. It is case + insensitive. + id: SystemParameter + type: object + AddRolesRequest: type: object - description: >- - DNS domain suffix for which requests originating in the producer VPC - network are resolved in the associated consumer VPC network. - AuthRequirement: properties: - audiences: + policyBinding: + items: + $ref: '#/components/schemas/PolicyBinding' + description: Required. List of policy bindings to add to shared VPC host project. + type: array + consumerNetwork: type: string description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - providerId: - type: string - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - id: AuthRequirement - type: object + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is a network name. + id: AddRolesRequest description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - DocumentationRule: - description: A documentation rule provides information about individual API elements. + Request for AddRoles to allow Service Producers to add roles in the + shared VPC host project for them to use. + ConsumerConfig: type: object - id: DocumentationRule + id: ConsumerConfig properties: - description: - description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. - type: string - selector: - type: string - description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. - deprecationDescription: + consumerExportCustomRoutes: + type: boolean description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - type: string - disableReplacementWords: + Export custom routes flag value for peering from consumer to + producer. + reservedRanges: + readOnly: true + items: + $ref: >- + #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. - type: string - CustomError: - description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - properties: - types: + Output only. The reserved ranges associated with this private + service access connection. type: array - items: - type: string + producerImportCustomRoutes: description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - rules: + Import custom routes flag value for peering from producer to + consumer. + type: boolean + producerExportCustomRoutes: + type: boolean description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. + Export custom routes flag value for peering from producer to + consumer. + usedIpRanges: items: - $ref: '#/components/schemas/CustomErrorRule' + type: string + readOnly: true + description: Output only. The IP ranges already in use by consumer or producer type: array - type: object - id: CustomError - MethodSettings: - type: object - properties: - autoPopulatedFields: + producerExportSubnetRoutesWithPublicIp: + type: boolean description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id + Export subnet routes with public ip flag value for peering from + producer to consumer. + cloudsqlConfigs: items: - type: string + $ref: '#/components/schemas/CloudSQLConfig' + description: Represents one or multiple Cloud SQL configurations. type: array - longRunning: - $ref: '#/components/schemas/LongRunning' + vpcScReferenceArchitectureEnabled: + type: boolean description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes - selector: + Output only. Indicates whether the VPC Service Controls reference + architecture is configured for the producer VPC host network. + readOnly: true + producerImportSubnetRoutesWithPublicIp: + type: boolean description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... + Import subnet routes with public ip flag value for peering from + producer to consumer. + producerNetwork: type: string - id: MethodSettings - description: Describes the generator configuration for a method. - CustomHttpPattern: - type: object + description: >- + Output only. The VPC host network that is used to host managed + service instances. In the format, + projects/{project}/global/networks/{network} where {project} is the + project number e.g. '12345' and {network} is the network name. + readOnly: true + consumerImportSubnetRoutesWithPublicIp: + type: boolean + description: >- + Import subnet routes with public ip flag value for peering from + consumer to producer. + consumerExportSubnetRoutesWithPublicIp: + description: >- + Export subnet routes with public ip flag value for peering from + consumer to producer. + type: boolean + consumerImportCustomRoutes: + description: >- + Import custom routes flag value for peering from consumer to + producer. + type: boolean + description: Configuration information for a private service access connection. + PeeredDnsDomain: + id: PeeredDnsDomain properties: - path: - description: The path matched by this custom verb. + name: + description: >- + User assigned name for this resource. Must be unique within the + consumer network. The name must be 1-63 characters long, must begin + with a letter, end with a letter or digit, and only contain + lowercase letters, digits or dashes. type: string - kind: + dnsSuffix: type: string - description: The name of this custom HTTP verb. - id: CustomHttpPattern - description: A custom pattern is used for defining custom HTTP verb. - AddSubnetworkRequest: - id: AddSubnetworkRequest - description: Request to create a subnetwork in a previously peered service network. + description: >- + The DNS domain name suffix e.g. `example.com.`. Cloud DNS requires + that a DNS suffix ends with a trailing dot. type: object + description: >- + DNS domain suffix for which requests originating in the producer VPC + network are resolved in the associated consumer VPC network. + Backend: properties: - secondaryIpRangeSpecs: + rules: items: - $ref: '#/components/schemas/SecondaryIpRangeSpec' - description: >- - Optional. A list of secondary IP ranges to be created within the new - subnetwork. + $ref: '#/components/schemas/BackendRule' type: array - internalRange: - type: string description: >- - Optional. The url of an Internal Range. Eg: - `projects//locations/global/internalRanges/`. If specified, it means - that the subnetwork cidr will be created using the combination of - requested_address/ip_prefix_length. Note that the subnet cidr has to - be within the cidr range of this Internal Range. - subnetworkUsers: - items: - type: string + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + id: Backend + description: '`Backend` defines the backend configuration for a service.' + type: object + PeeredDnsDomainMetadata: + type: object + id: PeeredDnsDomainMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + CreatePeeredDnsDomain API. + properties: {} + AddDnsZoneRequest: + type: object + properties: + name: + type: string description: >- - A list of members that are granted the - `roles/servicenetworking.subnetworkAdmin` role on the subnet. - type: array - useCustomComputeIdempotencyWindow: - type: boolean + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. Must be + unique within both projects. The name must be 1-63 characters long, + must begin with a letter, end with a letter or digit, and only + contain lowercase letters, digits or dashes. + dnsSuffix: + type: string description: >- - Optional. Specifies if Service Networking should use a custom time - bucket for Arcus idempotency. If false, Service Networking uses a - 300 second (5 minute) Arcus idempotency window. If true, Service - Networking uses a custom idempotency window provided by the user in - field compute_idempotency_window. For more information on how to - use, see: go/revisit-sn-idempotency-window - ipPrefixLength: - type: integer - format: int32 + Required. The DNS name suffix for the zones e.g. `example.com.`. + Cloud DNS requires that a DNS suffix ends with a trailing dot. + consumerNetwork: + type: string description: >- - Required. The prefix length of the subnet's IP address range. Use - CIDR range notation, such as `29` to provision a subnet with an - `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool - of available ranges in the service consumer's allocated range. GCE - disallows subnets with prefix_length > 29 - region: - type: string - description: >- - Required. The name of a [region](/compute/docs/regions-zones) for - the subnet, such `europe-west1`. - purpose: - description: >- - Optional. Defines the purpose field of the subnet, e.g. - 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that - can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - type: string - privateIpv6GoogleAccess: + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + id: AddDnsZoneRequest + description: >- + Request to add a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. + ListDnsRecordSetsResponse: + description: Represents all DNS RecordSets associated with the producer network + type: object + id: ListDnsRecordSetsResponse + properties: + dnsRecordSets: + description: DNS record Set Resource + items: + $ref: '#/components/schemas/DnsRecordSet' + type: array + AuthenticationRule: + id: AuthenticationRule + description: >- + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + type: object + properties: + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + allowWithoutCredential: description: >- - Optional. The private IPv6 google access type for the VMs in this - subnet. For information about the access types that can be set using - this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + type: boolean + requirements: + items: + $ref: '#/components/schemas/AuthRequirement' + type: array + description: Requirements for additional authentication providers. + selector: type: string - allowSubnetCidrRoutesOverlap: description: >- - Optional. Defines the allowSubnetCidrRoutesOverlap field of the - subnet, e.g. Available in alpha and beta according to [Compute API - documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) - type: boolean - role: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + MonitoringDestination: + properties: + metrics: + items: + type: string description: >- - Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For - information about the roles that can be set using this field, see - [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) - in the Compute API documentation. - type: string - computeIdempotencyWindow: + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. + type: array + monitoredResource: description: >- - Optional. Specifies a custom time bucket for Arcus subnetwork - request idempotency. If two equivalent concurrent requests are made, - Arcus will know to ignore the request if it has already been - completed or is in progress. Only requests with matching - compute_idempotency_window have guaranteed idempotency. Changing - this time window between requests results in undefined behavior. - Zero (or empty) value with custom_compute_idempotency_window=true - specifies no idempotency (i.e. no request ID is provided to Arcus). - Maximum value of 14 days (enforced by Arcus limit). For more - information on how to use, see: go/revisit-sn-idempotency-window - format: google-duration + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: string - consumer: + type: object + id: MonitoringDestination + description: >- + Configuration of a specific monitoring destination (the producer project + or the consumer project). + AuthRequirement: + id: AuthRequirement + description: >- + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + type: object + properties: + providerId: type: string description: >- - Required. A resource that represents the service consumer, such as - `projects/123456`. The project number can be different from the - value in the consumer network parameter. For example, the network - might be part of a Shared VPC network. In those cases, Service - Networking validates that this resource belongs to that Shared VPC. - description: - description: Optional. Description of the subnet. + id from authentication provider. Example: provider_id: + bookstore_auth + audiences: + description: >- + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com type: string - consumerNetwork: + Mixin: + description: >- + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + id: Mixin + properties: + name: + description: The fully qualified name of the interface which is included. type: string - description: >- - Required. The name of the service consumer's VPC network. The - network must have an existing private connection that was - provisioned through the connections.create method. The name must be - in the following format: - `projects/{project}/global/networks/{network}`, where {project} is a - project number, such as `12345`. {network} is the name of a VPC - network in the project. - checkServiceNetworkingUsePermission: - type: boolean - description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - subnetwork: + root: type: string description: >- - Required. A name for the new subnet. For information about the - naming requirements, see - [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the - Compute API documentation. - requestedRanges: + If non-empty specifies a path under which inherited HTTP paths are + rooted. + type: object + UsageRule: + description: >- + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true + properties: + skipServiceControl: + type: boolean description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges, the call fails. - type: array - items: - type: string - requestedAddress: - type: string + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + selector: description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the subnet. The range must - be within the allocated range that is assigned to the private - connection. If the CIDR range isn't available, the call fails. - outsideAllocationPublicIpRange: + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. type: string + allowUnregisteredCalls: + type: boolean description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this primary IP range. - Monitoring: - id: Monitoring + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. + type: object + id: UsageRule + Api: type: object + id: Api properties: - consumerDestinations: - items: - $ref: '#/components/schemas/MonitoringDestination' - description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - type: array - producerDestinations: - items: - $ref: '#/components/schemas/MonitoringDestination' - type: array - description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - UpdateConsumerConfigRequest: - properties: - consumerConfig: - description: Required. The updated peering config. - $ref: '#/components/schemas/ConsumerConfig' - description: >- - Request to update the configuration of a service networking connection - including the import/export of custom routes and subnetwork routes with - public IP. - type: object - id: UpdateConsumerConfigRequest - RangeReservation: - type: object - properties: - ipPrefixLength: - description: >- - Required. The size of the desired subnet. Use usual CIDR range - notation. For example, '29' to find unused x.x.x.x/29 CIDR range. - The goal is to determine if one of the allocated ranges has enough - free space for a subnet of the requested size. GCE disallows subnets - with prefix_length > 29 - format: int32 - type: integer - requestedRanges: - description: >- - Optional. The name of one or more allocated IP address ranges - associated with this private service access connection. If no range - names are provided all ranges associated with this connection will - be considered. If a CIDR range with the specified IP prefix length - is not available within these ranges the validation fails. - items: - type: string - type: array - subnetworkCandidates: - type: array - description: >- - Optional. List of subnetwork candidates to validate. The required - input fields are `name`, `network`, and `region`. Subnetworks from - this list which exist will be returned in the response with the - `ip_cidr_range`, `secondary_ip_cider_ranges`, and - `outside_allocation` fields set. - items: - $ref: '#/components/schemas/Subnetwork' - secondaryRangeIpPrefixLengths: - description: >- - Optional. The size of the desired secondary ranges for the subnet. - Use usual CIDR range notation. For example, '29' to find unused - x.x.x.x/29 CIDR range. The goal is to determine that the allocated - ranges have enough free space for all the requested secondary - ranges. GCE disallows subnets with prefix_length > 29 - items: - format: int32 - type: integer - type: array - id: RangeReservation - description: Represents a range reservation. - Type: - id: Type - properties: - options: - type: array - description: The protocol buffer options. + options: + type: array items: $ref: '#/components/schemas/Option' - edition: + description: Any metadata attached to the interface. + version: type: string description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - fields: - type: array - items: - $ref: '#/components/schemas/Field' - description: The list of fields. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - oneofs: - description: The list of types appearing in `oneof` definitions in this type. - items: - type: string - type: array - syntax: - description: The source syntax. + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. + name: type: string + description: >- + The fully qualified name of this interface, including package name + followed by the interface's simple name. + syntax: enumDescriptions: - Syntax `proto2`. - Syntax `proto3`. @@ -1140,38 +930,67 @@ components: - SYNTAX_PROTO2 - SYNTAX_PROTO3 - SYNTAX_EDITIONS + type: string + description: The source syntax of the service. + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: >- + Source context for the protocol buffer service represented by this + message. + methods: + description: The methods of this interface, in unspecified order. + items: + $ref: '#/components/schemas/Method' + type: array + mixins: + items: + $ref: '#/components/schemas/Mixin' + type: array + description: Included interfaces. See Mixin. + description: >- + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: + description: Allocated IP address ranges for this private service access connection. + properties: + address: + type: string + description: >- + The starting address of the reserved range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix length is the CIDR range for the reserved range. name: + description: The name of the reserved range. type: string - description: The fully qualified message name. - description: A protocol buffer message type. + ipPrefixLength: + format: int32 + type: integer + description: The prefix length of the reserved range. + id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange type: object - DnsZone: - id: DnsZone + Range: properties: - name: - description: >- - User assigned name for this resource. Must be unique within the - project. The name must be 1-63 characters long, must begin with a - letter, end with a letter or digit, and only contain lowercase - letters, digits or dashes. + ipCidrRange: type: string - dnsSuffix: description: >- - The DNS name suffix of this zone e.g. `example.com.`. Cloud DNS - requires that a DNS suffix ends with a trailing dot. + CIDR range in "10.x.x.x/y" format that is within the allocated + ranges and currently unused. + network: type: string - description: Represents a DNS zone resource. - type: object - DeletePeeredDnsDomainMetadata: + description: >- + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` + description: Represents a found unused range. type: object - properties: {} - id: DeletePeeredDnsDomainMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - DeletePeeredDnsDomain API. + id: Range SecondaryIpRange: - type: object - id: SecondaryIpRange properties: rangeName: description: Name of the secondary IP range. @@ -1179,222 +998,67 @@ components: ipCidrRange: description: Secondary IP CIDR range in `x.x.x.x/y` format. type: string - Control: - id: Control + id: SecondaryIpRange + type: object + SecondaryIpRangeSpec: + id: SecondaryIpRangeSpec type: object properties: - methodPolicies: - items: - $ref: '#/components/schemas/MethodPolicy' - type: array - description: Defines policies applying to the API methods of the service. - environment: + outsideAllocationPublicIpRange: type: string description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - GoogleCloudServicenetworkingV1ConsumerConfigReservedRange: - type: object - description: Allocated IP address ranges for this private service access connection. - properties: - address: + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this secondary IP range. + rangeName: type: string description: >- - The starting address of the reserved range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix length is the CIDR range for the reserved range. + Required. A name for the secondary IP range. The name must be 1-63 + characters long, and comply with RFC1035. The name must be unique + within the subnetwork. ipPrefixLength: - description: The prefix length of the reserved range. - type: integer format: int32 - name: - description: The name of the reserved range. - type: string - id: GoogleCloudServicenetworkingV1ConsumerConfigReservedRange - RemoveDnsRecordSetMetadata: - properties: {} - type: object - id: RemoveDnsRecordSetMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsRecordSet API - AuthenticationRule: - properties: - allowWithoutCredential: - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - type: boolean - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - requirements: - items: - $ref: '#/components/schemas/AuthRequirement' - description: Requirements for additional authentication providers. - type: array - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - type: object - id: AuthenticationRule - SearchRangeRequest: - properties: - ipPrefixLength: type: integer - format: int32 - description: >- - Required. The prefix length of the IP range. Use usual CIDR range - notation. For example, '30' to find unused x.x.x.x/30 CIDR range. - Actual range will be determined using allocated range for the - consumer peered network and returned in the result. - network: - type: string - description: >- - Network name in the consumer project. This network must have been - already peered with a shared VPC network using CreateConnection - method. Must be in a form - 'projects/{project}/global/networks/{network}'. {project} is a - project number, as in '12345' {network} is network name. - id: SearchRangeRequest - type: object - description: Request to search for an unused range within allocated ranges. - GoogleCloudServicenetworkingV1betaSubnetwork: - properties: - name: - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ - type: string - network: - type: string description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` - ipCidrRange: + Required. The prefix length of the secondary IP range. Use CIDR + range notation, such as `30` to provision a secondary IP range with + an `x.x.x.x/30` CIDR range. The IP address range is drawn from a + pool of available ranges in the service consumer's allocated range. + requestedAddress: type: string - description: Subnetwork CIDR range in `10.x.x.x/y` format. - outsideAllocation: - type: boolean description: >- - This is a discovered subnet that is not within the current consumer - allocated ranges. - description: >- - Represents a subnet that was created or discovered by a private access - management service. - id: GoogleCloudServicenetworkingV1betaSubnetwork - type: object - Enum: + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the secondary IP range. + The range must be within the allocated range that is assigned to the + private connection. If the CIDR range isn't available, the call + fails. + AddDnsZoneResponse: properties: - name: - type: string - description: Enum type name. - edition: - description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - type: string - options: - items: - $ref: '#/components/schemas/Option' - type: array - description: Protocol buffer options. - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - description: The source syntax. - enumvalue: - type: array - items: - $ref: '#/components/schemas/EnumValue' - description: Enum value definitions. - type: object - id: Enum - description: Enum type definition. - Empty: + producerPrivateZone: + description: The private DNS zone created in the shared producer host project. + $ref: '#/components/schemas/DnsZone' + consumerPeeringZone: + description: The DNS peering zone created in the consumer project. + $ref: '#/components/schemas/DnsZone' + id: AddDnsZoneResponse type: object - id: Empty description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} - ContextRule: - properties: - allowedResponseExtensions: - type: array - items: - type: string - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - provided: - items: - type: string - description: A list of full type names of provided contexts. - type: array - requested: - items: - type: string - type: array - description: A list of full type names of requested contexts. - selector: - type: string - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - allowedRequestExtensions: - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - items: - type: string - type: array - id: ContextRule + Represents managed DNS zones created in the shared producer host and + consumer projects. + FieldPolicy: description: >- - A context rule provides information about the context for an individual - API element. - type: object - PeeredDnsDomainMetadata: + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. type: object - id: PeeredDnsDomainMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - CreatePeeredDnsDomain API. - properties: {} - FieldPolicy: - id: FieldPolicy properties: - resourcePermission: - description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - type: string selector: + type: string description: >- Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the @@ -1403,370 +1067,840 @@ components: in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz". + resourcePermission: type: string + description: >- + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". resourceType: - type: string description: >- Specifies the resource type for the resource referred to by the field. - type: object + type: string + id: FieldPolicy + MetricRule: description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. - LogDescriptor: - id: LogDescriptor + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. + id: MetricRule + type: object properties: - description: + metricCosts: + type: object description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - type: string - displayName: + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + additionalProperties: + type: string + format: int64 + selector: type: string description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. - labels: - description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - type: array - items: - $ref: '#/components/schemas/LabelDescriptor' - name: - description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - type: string - type: object - description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer - PolicyBinding: - description: Grouping of IAM role and IAM member. - properties: - member: - description: >- - Required. Member to bind the role with. See - /iam/docs/reference/rest/v1/Policy#Binding for how to format each - member. Eg. - user:myuser@mydomain.com - - serviceAccount:my-service-account@app.gserviceaccount.com - type: string - role: - description: >- - Required. Role to apply. Only allowlisted roles can be used at the - specified granularity. The role must be one of the following: - - 'roles/container.hostServiceAgentUser' applied on the shared VPC - host project - 'roles/compute.securityAdmin' applied on the shared - VPC host project - 'roles/compute.networkAdmin' applied on the - shared VPC host project - 'roles/compute.xpnAdmin' applied on the - shared VPC host project - 'roles/dns.admin' applied on the shared - VPC host project - 'roles/logging.admin' applied on the shared VPC - host project - type: string - id: PolicyBinding - type: object - UpdateDnsRecordSetMetadata: - type: object + Selects the methods to which this rule applies. Refer to selector + for syntax details. + PartialDeleteConnectionMetadata: description: >- Metadata provided through GetOperation request for the LRO generated by - UpdateDnsRecordSet API - id: UpdateDnsRecordSetMetadata + Partial Delete Connection API + id: PartialDeleteConnectionMetadata + type: object properties: {} - Subnetwork: - id: Subnetwork + RemoveDnsRecordSetResponse: + properties: {} + type: object + id: RemoveDnsRecordSetResponse + description: Blank message response type for RemoveDnsRecordSet API + CloudSQLConfig: + type: object + id: CloudSQLConfig properties: - region: - description: GCP region where the subnetwork is located. + umbrellaProject: type: string - network: - description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` + format: int64 + description: The project number of the Cloud SQL umbrella project. + umbrellaNetwork: + description: The name of the umbrella network in the Cloud SQL umbrella project. type: string - secondaryIpRanges: - description: List of secondary IP ranges in this subnetwork. - items: - $ref: '#/components/schemas/SecondaryIpRange' - type: array - ipCidrRange: - description: Subnetwork CIDR range in `10.x.x.x/y` format. + service: + description: Peering service used for peering with the Cloud SQL project. type: string - outsideAllocation: + description: Cloud SQL configuration. + ValidateConsumerConfigResponse: + properties: + existingSubnetworkCandidates: + type: array + items: + $ref: '#/components/schemas/Subnetwork' description: >- - This is a discovered subnet that is not within the current consumer - allocated ranges. + List of subnetwork candidates from the request which exist with the + `ip_cidr_range`, `secondary_ip_cider_ranges`, and + `outside_allocation` fields set. + isValid: + description: Indicates whether all the requested validations passed. type: boolean - name: + validationError: type: string - description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + enum: + - VALIDATION_ERROR_UNSPECIFIED + - VALIDATION_NOT_REQUESTED + - SERVICE_NETWORKING_NOT_ENABLED + - NETWORK_NOT_FOUND + - NETWORK_NOT_PEERED + - NETWORK_PEERING_DELETED + - NETWORK_NOT_IN_CONSUMERS_PROJECT + - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT + - HOST_PROJECT_NOT_FOUND + - CONSUMER_PROJECT_NOT_SERVICE_PROJECT + - RANGES_EXHAUSTED + - RANGES_NOT_RESERVED + - RANGES_DELETED_LATER + - COMPUTE_API_NOT_ENABLED + - USE_PERMISSION_NOT_FOUND + enumDescriptions: + - '' + - In case none of the validations are requested. + - '' + - The network provided by the consumer does not exist. + - The network has not been peered with the producer org. + - The peering was created and later deleted. + - >- + The network is a regular VPC but the network is not in the + consumer's project. + - >- + The consumer project is a service project, and network is a shared + VPC, but the network is not in the host project of this consumer + project. + - >- + The host project associated with the consumer project was not + found. + - >- + The consumer project is not a service project for the specified + host project. + - >- + The reserved IP ranges do not have enough space to create a subnet + of desired size. + - The IP ranges were not reserved. + - The IP ranges were reserved but deleted later. + - The consumer project does not have the compute api enabled. + - >- + The consumer project does not have the permission from the host + project. + description: The first validation which failed. type: object + id: ValidateConsumerConfigResponse + Option: + id: Option description: >- - Represents a subnet that was created or discovered by a private access - management service. - ConsumerProject: - description: Represents a consumer project. - id: ConsumerProject - properties: - projectNum: - description: >- - Required. Project number of the consumer that is launching the - service instance. It can own the network that is peered with Google - or, be a service project in an XPN where the host project has the - network. - type: string - format: int64 + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. type: object - UpdateDnsRecordSetRequest: - id: UpdateDnsRecordSetRequest properties: - newDnsRecordSet: - description: >- - Required. The new values that the DNS record set should be updated - to hold. - $ref: '#/components/schemas/DnsRecordSet' - consumerNetwork: + name: type: string description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - zone: - type: string + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. + value: + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - Required. The name of the private DNS zone in the shared producer - host project from which the record set will be removed. - existingDnsRecordSet: - $ref: '#/components/schemas/DnsRecordSet' - description: Required. The existing DNS record set to update. - description: >- - Request to update a record set from a private managed DNS zone in the - shared producer host project. The name, type, ttl, and data values of - the existing record set must all exactly match an existing record set in - the specified zone. - type: object - ConsumerConfigMetadata: - description: >- - Metadata provided through GetOperation request for the LRO generated by - UpdateConsumerConfig API. - type: object - id: ConsumerConfigMetadata - properties: {} - NodeSettings: - type: object - id: NodeSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Node client libraries. - SystemParameter: + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + BackendRule: properties: - name: - type: string - description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - httpHeader: + protocol: description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - type: string - urlQueryParameter: + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. type: string + deadline: + format: double description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. - type: object - description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. - id: SystemParameter - ListDnsRecordSetsResponse: - properties: - dnsRecordSets: - description: DNS record Set Resource - items: - $ref: '#/components/schemas/DnsRecordSet' - type: array - type: object - id: ListDnsRecordSetsResponse - description: Represents all DNS RecordSets associated with the producer network - VpcServiceControls: + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + type: number + overridesByRequestProtocol: + description: The map between request protocol and the backend address. + type: object + additionalProperties: + $ref: '#/components/schemas/BackendRule' + pathTranslation: + enumDescriptions: + - '' + - >- + Use the backend address as-is, with no modification to the path. + If the URL pattern contains variables, the variable names and + values will be appended to the query string. If a query string + parameter and a URL pattern variable have the same name, this may + result in duplicate keys in the query string. # Examples Given the + following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.cloudfunctions.net/getUser Requests to the + following request paths will call the backend at the translated + path: Request path: /api/company/widgetworks/user/johndoe + Translated: + https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe + - >- + The request path will be appended to the backend address. # + Examples Given the following operation config: Method path: + /api/company/{cid}/user/{uid} Backend address: + https://example.appspot.com Requests to the following request + paths will call the backend at the translated path: Request path: + /api/company/widgetworks/user/johndoe Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe + Request path: /api/company/widgetworks/user/johndoe?timezone=EST + Translated: + https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + type: string + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS + operationDeadline: + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + format: double + type: number + disableAuth: + type: boolean + description: >- + When disable_auth is true, a JWT ID token won't be generated and the + original "Authorization" HTTP header will be preserved. If the + header is used to carry the original token and is expected by the + backend, this field must be set to true to preserve the header. + selector: + type: string + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + minDeadline: + format: double + description: Deprecated, do not use. + type: number + deprecated: true + address: + type: string + description: >- + The address of the API backend. The scheme is used to determine the + backend protocol and security. The following schemes are accepted: + SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// + gRPC None grpcs:// gRPC TLS It is recommended to explicitly include + a scheme. Leaving out the scheme may cause constrasting behaviors + across platforms. If the port is unspecified, the default is: - 80 + for schemes without TLS - 443 for schemes with TLS For HTTP + backends, use protocol to specify the protocol version. + jwtAudience: + type: string + description: >- + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. type: object - description: Response for the get VPC Service Controls request. + description: A backend rule provides configuration for an individual API element. + id: BackendRule + Authentication: + id: Authentication properties: - enabled: + providers: + items: + $ref: '#/components/schemas/AuthProvider' + description: Defines a set of authentication providers that a service supports. + type: array + rules: + items: + $ref: '#/components/schemas/AuthenticationRule' description: >- - Output only. Indicates whether the VPC Service Controls are enabled - or disabled for the connection. If the consumer called the - EnableVpcServiceControls method, then this is true. If the consumer - called DisableVpcServiceControls, then this is false. The default is - false. - readOnly: true - type: boolean - id: VpcServiceControls - RemoveDnsZoneMetadata: + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + type: array + description: >- + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + type: object + SystemParameterRule: + properties: + parameters: + type: array + items: + $ref: '#/components/schemas/SystemParameter' + description: >- + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. + selector: + description: >- + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + type: string + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + type: object + id: SystemParameterRule + RemoveDnsZoneResponse: + id: RemoveDnsZoneResponse properties: {} + description: Blank message response type for RemoveDnsZone API type: object + Subnetwork: description: >- - Metadata provided through GetOperation request for the LRO generated by - RemoveDnsZone API - id: RemoveDnsZoneMetadata - Field: - description: A single field of a message type. + Represents a subnet that was created or discovered by a private access + management service. properties: + secondaryIpRanges: + items: + $ref: '#/components/schemas/SecondaryIpRange' + type: array + description: List of secondary IP ranges in this subnetwork. + outsideAllocation: + description: >- + This is a discovered subnet that is not within the current consumer + allocated ranges. + type: boolean name: type: string - description: The field name. - defaultValue: + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + region: + type: string + description: GCP region where the subnetwork is located. + ipCidrRange: type: string + description: Subnetwork CIDR range in `10.x.x.x/y` format. + network: description: >- - The string value of the default value of this field. Proto2 syntax - only. - options: - description: The protocol buffer options. - type: array - items: - $ref: '#/components/schemas/Option' - number: - description: The field number. - format: int32 - type: integer - kind: - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - description: The field type. + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` type: string - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - jsonName: - description: The field JSON name. + type: object + id: Subnetwork + DocumentationRule: + id: DocumentationRule + type: object + description: A documentation rule provides information about individual API elements. + properties: + selector: type: string - oneofIndex: - type: integer description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - format: int32 - packed: - description: Whether to use alternative packed wire representation. - type: boolean - cardinality: - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - description: The field cardinality. + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + description: + type: string + description: >- + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + deprecationDescription: + description: >- + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + type: string + disableReplacementWords: + description: >- + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + type: string + MethodPolicy: + type: object + properties: + selector: + type: string + description: >- + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . + requestPolicies: + description: Policies that are applicable to the request message. + items: + $ref: '#/components/schemas/FieldPolicy' + type: array + description: Defines policies applying to an RPC method. + id: MethodPolicy + ListPeeredDnsDomainsResponse: + description: Response to list peered DNS domains for a given connection. + properties: + peeredDnsDomains: + items: + $ref: '#/components/schemas/PeeredDnsDomain' + description: The list of peered DNS domains. + type: array + id: ListPeeredDnsDomainsResponse + type: object + Connection: + description: >- + Represents a private connection resource. A private connection is + implemented as a VPC Network Peering connection between a service + producer's VPC network and a service consumer's VPC network. + type: object + id: Connection + properties: + peering: + readOnly: true + type: string + description: >- + Output only. The name of the VPC Network Peering connection that was + created by the service producer. + reservedPeeringRanges: + type: array + description: >- + The name of one or more allocated IP address ranges for this service + producer of type `PEERING`. Note that invoking CreateConnection + method with a different range when connection is already established + will not modify already provisioned service producer subnetworks. If + CreateConnection method is invoked repeatedly to reconnect when + peering connection had been disconnected on the consumer side, + leaving this field empty will restore previously allocated IP + ranges. + items: + type: string + service: + type: string + readOnly: true + description: >- + Output only. The name of the peering service that's associated with + this connection, in the following format: `services/{service name}`. + network: + type: string + description: >- + The name of service consumer's VPC network that's connected with + service producer network, in the following format: + `projects/{project}/global/networks/{network}`. `{project}` is a + project number, such as in `12345` that includes the VPC service + consumer's VPC network. `{network}` is the name of the service + consumer's VPC network. + ListOperationsResponse: + type: object + description: The response message for Operations.ListOperations. + id: ListOperationsResponse + properties: + nextPageToken: + type: string + description: The standard List next-page token. + operations: + type: array + items: + $ref: '#/components/schemas/Operation' + description: >- + A list of operations that matches the specified filter in the + request. + AddDnsRecordSetMetadata: + id: AddDnsRecordSetMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsRecordSet API + type: object + properties: {} + Monitoring: + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + properties: + consumerDestinations: + items: + $ref: '#/components/schemas/MonitoringDestination' + type: array + description: >- + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + producerDestinations: + description: >- + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + type: array + items: + $ref: '#/components/schemas/MonitoringDestination' + type: object + id: Monitoring + JwtLocation: + id: JwtLocation + properties: + valuePrefix: + description: >- + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. + type: string + header: + type: string + description: Specifies HTTP header name to extract JWT token. + cookie: + type: string + description: Specifies cookie name to extract JWT token. + query: + description: Specifies URL query parameter name to extract JWT token. + type: string + type: object + description: Specifies a location to extract JWT from an API request. + MetricDescriptor: + properties: + description: + type: string + description: >- + A detailed description of the metric, which can be used in + documentation. + monitoredResourceTypes: + description: >- + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + items: + type: string + type: array + launchStage: + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + description: Optional. The launch stage of the metric definition. + name: + type: string + description: The resource name of the metric descriptor. + displayName: + type: string + description: >- + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + type: + description: >- + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" + type: string + valueType: + type: string + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + description: >- + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + labels: + description: >- + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + type: array + items: + $ref: '#/components/schemas/LabelDescriptor' + metricKind: + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + type: string + unit: + type: string + description: >- + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + type: object + id: MetricDescriptor + description: >- + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + CustomHttpPattern: + id: CustomHttpPattern + type: object + properties: + path: + type: string + description: The path matched by this custom verb. + kind: + type: string + description: The name of this custom HTTP verb. + description: A custom pattern is used for defining custom HTTP verb. + JavaSettings: + type: object + description: Settings for Java client libraries. + id: JavaSettings + properties: + serviceClassNames: + type: object + description: >- + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + additionalProperties: + type: string + libraryPackage: + description: >- + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 type: string - typeUrl: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + RemoveDnsZoneRequest: + type: object + properties: + name: + description: >- + Required. The name for both the private zone in the shared producer + host project and the peering zone in the consumer project. type: string + consumerNetwork: description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - type: object - id: Field + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + type: string + id: RemoveDnsZoneRequest + description: >- + Request to remove a private managed DNS zone in the shared producer host + project and a matching DNS peering zone in the consumer project. Publishing: properties: - organization: - type: string - description: For whom the client library is being published. - enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google protoReferenceDocumentationUri: - type: string description: >- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc + type: string restReferenceDocumentationUri: type: string description: >- Optional link to REST reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rest - methodSettings: + codeownerGithubTeams: description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - items: - $ref: '#/components/schemas/MethodSettings' + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. type: array - newIssueUri: - type: string - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 + items: + type: string librarySettings: type: array description: >- @@ -1775,18 +1909,11 @@ components: settings with the same version string are discarded. items: $ref: '#/components/schemas/ClientLibrarySettings' - documentationUri: + newIssueUri: type: string description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - codeownerGithubTeams: - items: - type: string - type: array - description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 apiShortName: description: >- Used as a tracking tag when collecting data about the APIs developer @@ -1799,115 +1926,52 @@ components: in documentation. type: string githubLabel: - type: string description: >- GitHub label to apply to issues and pull requests opened for this API. - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - type: object - id: Publishing - LabelDescriptor: - description: A description of a label. - id: LabelDescriptor - properties: - description: - type: string - description: A human-readable description for the label. - key: - description: The label key. - type: string - valueType: - enum: - - STRING - - BOOL - - INT64 - description: The type of data that can be assigned to the label. type: string + organization: enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - type: object - LoggingDestination: - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). - type: object - id: LoggingDestination - properties: - monitoredResource: - type: string - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. - logs: - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - items: - type: string - type: array - HttpRule: - properties: - patch: - type: string - description: Maps to HTTP PATCH. Used for updating a resource. - put: - type: string - description: Maps to HTTP PUT. Used for replacing a resource. - selector: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google type: string + description: For whom the client library is being published. + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI + documentationUri: description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - delete: - type: string - description: Maps to HTTP DELETE. Used for deleting a resource. - get: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview type: string - description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - additionalBindings: - description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - type: array + methodSettings: items: - $ref: '#/components/schemas/HttpRule' - body: - type: string - description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. - custom: - description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - $ref: '#/components/schemas/CustomHttpPattern' - post: - type: string - description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - responseBody: - type: string + $ref: '#/components/schemas/MethodSettings' description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + type: array + type: object + description: >- + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + id: Publishing + HttpRule: + type: object + id: HttpRule description: >- gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to @@ -2030,9 +2094,9 @@ components: endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. Example - below selects a gRPC method and applies HttpRule to it. http: rules: - - selector: example.v1.Messaging.GetMessage get: + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 @@ -2052,479 +2116,379 @@ components: Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. - type: object - id: HttpRule - ValidateConsumerConfigRequest: - id: ValidateConsumerConfigRequest - type: object - properties: - rangeReservation: - $ref: '#/components/schemas/RangeReservation' - description: >- - RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are - done when range_reservation is provided. - checkServiceNetworkingUsePermission: - description: >- - Optional. The IAM permission check determines whether the consumer - project has 'servicenetworking.services.use' permission or not. - type: boolean - consumerProject: - $ref: '#/components/schemas/ConsumerProject' - description: >- - NETWORK_NOT_IN_CONSUMERS_PROJECT, - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND - are done when consumer_project is provided. - validateNetwork: - type: boolean - description: >- - The validations will be performed in the order listed in the - ValidationError enum. The first failure will return. If a validation - is not requested, then the next one will be performed. - SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are - performed for all requests where validation is requested. - NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for - requests that have validate_network set to true. - consumerNetwork: - type: string - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. - Route: - type: object + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. properties: - nextHopGateway: + put: + description: Maps to HTTP PUT. Used for replacing a resource. type: string + responseBody: description: >- - Fully-qualified URL of the gateway that should handle matching - packets that this route applies to. For example: - `projects/123456/global/gateways/default-internet-gateway` - destRange: - type: string - description: Destination CIDR range that this route applies to. - name: + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. type: string - description: Route name. See https://cloud.google.com/vpc/docs/routes - network: + body: type: string description: >- - Fully-qualified URL of the VPC network in the producer host tenant - project that this route applies to. For example: - `projects/123456/global/networks/host-network` - description: >- - Represents a route that was created or discovered by a private access - management service. - id: Route - DeleteConnectionMetadata: - id: DeleteConnectionMetadata - description: >- - Metadata provided through GetOperation request for the LRO generated by - Delete Connection API - properties: {} - type: object - DisableVpcServiceControlsRequest: - description: Request to disable VPC service controls. - type: object - properties: - consumerNetwork: - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is network name. - type: string - id: DisableVpcServiceControlsRequest - Authentication: - id: Authentication - type: object - properties: - providers: - description: Defines a set of authentication providers that a service supports. - type: array + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + additionalBindings: items: - $ref: '#/components/schemas/AuthProvider' - rules: - description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. + $ref: '#/components/schemas/HttpRule' type: array - items: - $ref: '#/components/schemas/AuthenticationRule' - description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - DnsRecordSet: - type: object - properties: - type: - description: Required. The identifier of a supported record type. + description: >- + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). + patch: type: string - data: - type: array + description: Maps to HTTP PATCH. Used for updating a resource. + custom: description: >- - Required. As defined in RFC 1035 (section 5) and RFC 1034 (section - 3.6.1) for examples see - https://cloud.google.com/dns/records/json-record. - items: - type: string - domain: + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + $ref: '#/components/schemas/CustomHttpPattern' + selector: description: >- - Required. The DNS or domain name of the record set, e.g. - `test.example.com`. Cloud DNS requires that a DNS suffix ends with a - trailing dot. + Selects a method to which this rule applies. Refer to selector for + syntax details. type: string - ttl: + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. + type: string + get: type: string - format: google-duration description: >- - Required. The period of time for which this RecordSet can be cached - by resolvers. - id: DnsRecordSet - description: Represents a DNS record set resource. - EnumValue: + Maps to HTTP GET. Used for listing and getting information about + resources. + post: + type: string + description: >- + Maps to HTTP POST. Used for creating a resource or performing an + action. + RubySettings: + description: Settings for Ruby client libraries. type: object - id: EnumValue + id: RubySettings properties: - options: - type: array - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' - number: - description: Enum value number. - type: integer - format: int32 - name: - type: string - description: Enum value name. - description: Enum value definition. - SourceContext: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + LongRunning: + id: LongRunning type: object - id: SourceContext - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. properties: - fileName: + pollDelayMultiplier: + description: >- + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + type: number + format: float + totalPollTimeout: + description: 'Total polling timeout. Default value: 5 minutes.' + type: string + format: google-duration + initialPollDelay: + format: google-duration type: string description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - ListDnsZonesResponse: - description: >- - Represents all DNS zones in the shared producer host project and the - matching peering zones in the consumer project. - properties: - dnsZonePairs: - type: array + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + maxPollDelay: description: >- - All pairs of private DNS zones in the shared producer host project - and the matching peering zones in the consumer project.. - items: - $ref: '#/components/schemas/DnsZonePair' - id: ListDnsZonesResponse + Maximum time between two subsequent poll requests. Default value: 45 + seconds. + type: string + format: google-duration + description: >- + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + UpdateConsumerConfigRequest: type: object - Option: - id: Option + id: UpdateConsumerConfigRequest + description: >- + Request to update the configuration of a service networking connection + including the import/export of custom routes and subnetwork routes with + public IP. properties: - name: + consumerConfig: + $ref: '#/components/schemas/ConsumerConfig' + description: Required. The updated peering config. + Http: + properties: + rules: + items: + $ref: '#/components/schemas/HttpRule' + type: array description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - type: string - value: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + fullyDecodeReservedExpansion: description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - type: object + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + id: Http type: object description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - Logging: - id: Logging - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + NodeSettings: + type: object + description: Settings for Node client libraries. + id: NodeSettings properties: - consumerDestinations: - items: - $ref: '#/components/schemas/LoggingDestination' - description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + Context: + description: >- + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. + properties: + rules: type: array - producerDestinations: items: - $ref: '#/components/schemas/LoggingDestination' - type: array + $ref: '#/components/schemas/ContextRule' description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: object - QuotaLimit: + id: Context + GoogleCloudServicenetworkingV1betaSubnetwork: type: object properties: - unit: - description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - type: string - defaultLimit: - type: string - description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - format: int64 - displayName: - description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - type: string - freeTier: - description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - type: string - format: int64 - duration: - type: string + network: description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - maxLimit: - format: int64 + In the Shared VPC host project, the VPC network that's peered with + the consumer network. For example: + `projects/1234321/global/networks/host-network` type: string + outsideAllocation: description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. + This is a discovered subnet that is not within the current consumer + allocated ranges. + type: boolean name: + description: Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + type: string + ipCidrRange: + description: Subnetwork CIDR range in `10.x.x.x/y` format. type: string + description: >- + Represents a subnet that was created or discovered by a private access + management service. + id: GoogleCloudServicenetworkingV1betaSubnetwork + AddSubnetworkRequest: + description: Request to create a subnetwork in a previously peered service network. + id: AddSubnetworkRequest + type: object + properties: + useCustomComputeIdempotencyWindow: + type: boolean description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - values: - type: object - additionalProperties: + Optional. Specifies if Service Networking should use a custom time + bucket for Arcus idempotency. If false, Service Networking uses a + 300 second (5 minute) Arcus idempotency window. If true, Service + Networking uses a custom idempotency window provided by the user in + field compute_idempotency_window. For more information on how to + use, see: go/revisit-sn-idempotency-window + subnetworkUsers: + items: type: string - format: int64 + type: array description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - metric: + A list of members that are granted the + `roles/servicenetworking.subnetworkAdmin` role on the subnet. + outsideAllocationPublicIpRange: type: string description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - description: + Optional. Enable outside allocation using public IP addresses. Any + public IP range may be specified. If this field is provided, we will + not use customer reserved ranges for this primary IP range. + role: + type: string description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). + Optional. Defines the role field of the subnet, e.g. 'ACTIVE'. For + information about the roles that can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + purpose: type: string - description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - id: QuotaLimit - ListPeeredDnsDomainsResponse: - description: Response to list peered DNS domains for a given connection. - properties: - peeredDnsDomains: - type: array - description: The list of peered DNS domains. - items: - $ref: '#/components/schemas/PeeredDnsDomain' - id: ListPeeredDnsDomainsResponse - type: object - MetricRule: - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. - properties: - metricCosts: - type: object description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - additionalProperties: - format: int64 - type: string - selector: + Optional. Defines the purpose field of the subnet, e.g. + 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that + can be set using this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. + requestedAddress: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. + Optional. The starting address of a range. The address must be a + valid IPv4 address in the x.x.x.x format. This value combined with + the IP prefix range is the CIDR range for the subnet. The range must + be within the allocated range that is assigned to the private + connection. If the CIDR range isn't available, the call fails. type: string - id: MetricRule - type: object - CancelOperationRequest: - description: The request message for Operations.CancelOperation. - type: object - id: CancelOperationRequest - properties: {} - AddDnsRecordSetMetadata: - id: AddDnsRecordSetMetadata - properties: {} - type: object - description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsRecordSet API - RemoveDnsRecordSetResponse: - type: object - properties: {} - id: RemoveDnsRecordSetResponse - description: Blank message response type for RemoveDnsRecordSet API - GoogleCloudServicenetworkingV1betaConnection: - id: GoogleCloudServicenetworkingV1betaConnection - properties: - network: - description: >- - The name of service consumer's VPC network that's connected with - service producer network, in the following format: - `projects/{project}/global/networks/{network}`. `{project}` is a - project number, such as in `12345` that includes the VPC service - consumer's VPC network. `{network}` is the name of the service - consumer's VPC network. + description: type: string - reservedPeeringRanges: + description: Optional. Description of the subnet. + secondaryIpRangeSpecs: type: array + description: >- + Optional. A list of secondary IP ranges to be created within the new + subnetwork. items: - type: string + $ref: '#/components/schemas/SecondaryIpRangeSpec' + requestedRanges: description: >- - The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking this method with a - different range when connection is already established will not - modify already provisioned service producer subnetworks. - service: + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges, the call fails. + items: + type: string + type: array + consumer: type: string description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - peering: + Required. A resource that represents the service consumer, such as + `projects/123456`. The project number can be different from the + value in the consumer network parameter. For example, the network + might be part of a Shared VPC network. In those cases, Service + Networking validates that this resource belongs to that Shared VPC. + skipRequestedAddressValidation: + type: boolean + description: >- + Optional. Skips validating if the requested_address is in use by SN + VPC’s peering group. Compute Engine will still perform this check + and fail the request if the requested_address is in use. Note that + Compute Engine does not check for the existence of dynamic routes + when performing this check. Caller of this API should make sure that + there are no dynamic routes overlapping with the + requested_address/prefix_length IP address range otherwise the + created subnet could cause misrouting. + region: type: string description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. - description: >- - Represents a private connection resource. A private connection is - implemented as a VPC Network Peering connection between a service - producer's VPC network and a service consumer's VPC network. - type: object - MonitoredResourceDescriptor: - description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - properties: - name: + Required. The name of a [region](/compute/docs/regions-zones) for + the subnet, such `europe-west1`. + allowSubnetCidrRoutesOverlap: description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. + Optional. Defines the allowSubnetCidrRoutesOverlap field of the + subnet, e.g. Available in alpha and beta according to [Compute API + documentation](https://cloud.google.com/compute/docs/reference/rest/beta/subnetworks/insert) + type: boolean + checkServiceNetworkingUsePermission: + type: boolean + description: >- + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + subnetwork: type: string - labels: - type: array - items: - $ref: '#/components/schemas/LabelDescriptor' description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. - description: + Required. A name for the new subnet. For information about the + naming requirements, see + [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the + Compute API documentation. + computeIdempotencyWindow: + format: google-duration + description: >- + Optional. Specifies a custom time bucket for Arcus subnetwork + request idempotency. If two equivalent concurrent requests are made, + Arcus will know to ignore the request if it has already been + completed or is in progress. Only requests with matching + compute_idempotency_window have guaranteed idempotency. Changing + this time window between requests results in undefined behavior. + Zero (or empty) value with custom_compute_idempotency_window=true + specifies no idempotency (i.e. no request ID is provided to Arcus). + Maximum value of 14 days (enforced by Arcus limit). For more + information on how to use, see: go/revisit-sn-idempotency-window type: string + consumerNetwork: description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - displayName: + Required. The name of the service consumer's VPC network. The + network must have an existing private connection that was + provisioned through the connections.create method. The name must be + in the following format: + `projects/{project}/global/networks/{network}`, where {project} is a + project number, such as `12345`. {network} is the name of a VPC + network in the project. + type: string + privateIpv6GoogleAccess: description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. + Optional. The private IPv6 google access type for the VMs in this + subnet. For information about the access types that can be set using + this field, see + [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) + in the Compute API documentation. type: string - type: + ipPrefixLength: + format: int32 + description: >- + Required. The prefix length of the subnet's IP address range. Use + CIDR range notation, such as `29` to provision a subnet with an + `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool + of available ranges in the service consumer's allocated range. GCE + disallows subnets with prefix_length > 29 + type: integer + internalRange: type: string description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). + Optional. The url of an Internal Range. Eg: + `projects//locations/global/internalRanges/`. If specified, it means + that the subnetwork cidr will be created using the combination of + requested_address/ip_prefix_length. Note that the subnet cidr has to + be within the cidr range of this Internal Range. + AddDnsZoneMetadata: + properties: {} + type: object + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddDnsZone API + id: AddDnsZoneMetadata + ClientLibrarySettings: + id: ClientLibrarySettings + description: Details about how and where to publish client libraries. + type: object + properties: + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + goSettings: + $ref: '#/components/schemas/GoSettings' + description: Settings for Go client libraries. + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. launchStage: - type: string + description: Launch stage of this version of the API. enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED @@ -2566,261 +2530,157 @@ components: - >- GA features are open to all developers and are considered stable and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - description: Optional. The launch stage of the monitored resource definition. - id: MonitoredResourceDescriptor - type: object - CommonLanguageSettings: - id: CommonLanguageSettings - type: object - properties: - referenceDocsUri: - type: string - deprecated: true - description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - destinations: - type: array - items: - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - type: string - description: >- - The destination where API teams want this client library to be - published. - description: Required information for every language. - AddRolesRequest: - properties: - policyBinding: - description: Required. List of policy bindings to add to shared VPC host project. - items: - $ref: '#/components/schemas/PolicyBinding' - type: array - consumerNetwork: - type: string - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. - type: object - id: AddRolesRequest - description: >- - Request for AddRoles to allow Service Producers to add roles in the - shared VPC host project for them to use. - UsageRule: - properties: - skipServiceControl: - description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - type: boolean - allowUnregisteredCalls: - description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - type: boolean - selector: - type: string - description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true - type: object - id: UsageRule - RemoveDnsZoneResponse: - id: RemoveDnsZoneResponse - description: Blank message response type for RemoveDnsZone API - properties: {} - type: object - BillingDestination: - properties: - metrics: - description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - type: array - items: - type: string - monitoredResource: + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. type: string + restNumericEnums: + type: boolean description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). + When using transport=rest, the client request will encode enums as + numbers rather than strings. + nodeSettings: + $ref: '#/components/schemas/NodeSettings' + description: Settings for Node client libraries. + cppSettings: + description: Settings for C++ client libraries. + $ref: '#/components/schemas/CppSettings' + dotnetSettings: + $ref: '#/components/schemas/DotnetSettings' + description: Settings for .NET client libraries. + phpSettings: + description: Settings for PHP client libraries. + $ref: '#/components/schemas/PhpSettings' + version: + description: >- + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". + type: string + pythonSettings: + $ref: '#/components/schemas/PythonSettings' + description: Settings for Python client libraries. + PhpSettings: + id: PhpSettings + properties: + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. type: object - id: BillingDestination - Page: - id: Page + description: Settings for Php client libraries. + Enum: + description: Enum type definition. type: object - description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. properties: + enumvalue: + items: + $ref: '#/components/schemas/EnumValue' + description: Enum value definitions. + type: array name: + description: Enum type name. type: string - description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - content: - description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + edition: type: string - subpages: description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. - items: - $ref: '#/components/schemas/Page' + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + options: type: array - JwtLocation: - properties: - header: - description: Specifies HTTP header name to extract JWT token. - type: string - cookie: - description: Specifies cookie name to extract JWT token. + items: + $ref: '#/components/schemas/Option' + description: Protocol buffer options. + syntax: + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. type: string - valuePrefix: + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + id: Enum + AddDnsRecordSetRequest: + description: >- + Request to add a record set to a private managed DNS zone in the shared + producer host project. + properties: + zone: description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - type: string - query: + Required. The name of the private DNS zone in the shared producer + host project to which the record set will be added. type: string - description: Specifies URL query parameter name to extract JWT token. - description: Specifies a location to extract JWT from an API request. - id: JwtLocation - type: object - MonitoringDestination: - type: object - id: MonitoringDestination - properties: - monitoredResource: + dnsRecordSet: + description: Required. The DNS record set to add. + $ref: '#/components/schemas/DnsRecordSet' + consumerNetwork: type: string description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - metrics: - description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. - items: - type: string - type: array - description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). - GetDnsZoneResponse: + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. type: object - id: GetDnsZoneResponse - properties: - producerPrivateZone: - $ref: '#/components/schemas/DnsZone' - description: The private DNS zone created in the shared producer host project. - consumerPeeringZone: - $ref: '#/components/schemas/DnsZone' - description: The DNS peering zone created in the consumer project. - description: >- - Represents managed DNS zones created in the shared Producer host and - consumer projects. - DotnetSettings: + id: AddDnsRecordSetRequest + Operation: properties: - forcedNamespaceAliases: - items: - type: string + name: description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - type: array - handwrittenSignatures: - items: - type: string + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + type: string + done: + type: boolean description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. - type: array - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - ignoredResources: + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + metadata: description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - items: - type: string - type: array - renamedServices: + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + error: description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + response: additionalProperties: - type: string - renamedResources: + type: any + description: Properties of the object. Contains field @type with type URL. type: object description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - additionalProperties: - type: string - description: Settings for Dotnet client libraries. + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + description: >- + This resource represents a long-running operation that is the result of + a network API call. + id: Operation type: object - id: DotnetSettings Status: description: >- The `Status` type defines a logical error model that is suitable for @@ -2831,146 +2691,281 @@ components: with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). properties: + code: + format: int32 + type: integer + description: The status code, which should be an enum value of google.rpc.Code. details: items: - type: object additionalProperties: description: Properties of the object. Contains field @type with type URL. type: any + type: object type: array description: >- A list of messages that carry the error details. There is a common set of message types for APIs to use. - code: - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - format: int32 message: type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - type: object id: Status - SecondaryIpRangeSpec: - type: object - properties: - requestedAddress: - description: >- - Optional. The starting address of a range. The address must be a - valid IPv4 address in the x.x.x.x format. This value combined with - the IP prefix range is the CIDR range for the secondary IP range. - The range must be within the allocated range that is assigned to the - private connection. If the CIDR range isn't available, the call - fails. - type: string - rangeName: - type: string - description: >- - Required. A name for the secondary IP range. The name must be 1-63 - characters long, and comply with RFC1035. The name must be unique - within the subnetwork. - ipPrefixLength: - description: >- - Required. The prefix length of the secondary IP range. Use CIDR - range notation, such as `30` to provision a secondary IP range with - an `x.x.x.x/30` CIDR range. The IP address range is drawn from a - pool of available ranges in the service consumer's allocated range. - type: integer - format: int32 - outsideAllocationPublicIpRange: - type: string - description: >- - Optional. Enable outside allocation using public IP addresses. Any - public IP range may be specified. If this field is provided, we will - not use customer reserved ranges for this secondary IP range. - id: SecondaryIpRangeSpec - AddRolesResponse: type: object - id: AddRolesResponse + Logging: properties: - policyBinding: + consumerDestinations: description: >- - Required. List of policy bindings that were added to the shared VPC - host project. + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + items: + $ref: '#/components/schemas/LoggingDestination' type: array + producerDestinations: + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. items: - $ref: '#/components/schemas/PolicyBinding' - description: Represents IAM roles added to the shared VPC host project. - DeleteConnectionRequest: + $ref: '#/components/schemas/LoggingDestination' + type: array + id: Logging + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history type: object - id: DeleteConnectionRequest + DeletePeeredDnsDomainMetadata: + type: object + id: DeletePeeredDnsDomainMetadata + properties: {} description: >- - Request to delete a private service access connection. The call will - fail if there are any managed service instances using this connection. + Metadata provided through GetOperation request for the LRO generated by + DeletePeeredDnsDomain API. + RemoveDnsZoneMetadata: + properties: {} + type: object + id: RemoveDnsZoneMetadata + description: >- + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsZone API + PythonSettings: + id: PythonSettings + type: object + description: Settings for Python client libraries. properties: - consumerNetwork: + experimentalFeatures: + $ref: '#/components/schemas/ExperimentalFeatures' description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is a project - number, as in '12345' {network} is a network name. + Experimental features to be included during client library + generation. + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + Method: + description: Method represents a method of an API interface. + type: object + id: Method + properties: + responseStreaming: + description: If true, the response is streamed. + type: boolean + responseTypeUrl: type: string - Billing: + description: The URL of the output message type. + requestTypeUrl: + description: A URL of the input message type. + type: string + name: + description: The simple name of this method. + type: string + requestStreaming: + description: If true, the request is streamed. + type: boolean + syntax: + description: The source syntax of this method. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: Any metadata attached to the method. + MetricDescriptorMetadata: + description: Additional annotations that can be used to guide the usage of a metric. type: object - description: >- - Billing related configuration of the service. The following example - shows how to configure monitored resources and metrics for billing, - `consumer_destinations` is the only supported destination and the - monitored resources need at least one label key - `cloud.googleapis.com/location` to indicate the location of the billing - usage, using different monitored resources between monitoring and - billing is recommended so they can be evolved independently: - monitored_resources: - type: library.googleapis.com/billing_branch - labels: - key: cloud.googleapis.com/location description: | Predefined - label to support billing location restriction. - key: city description: - | Custom label to define the city where the library branch is located - in. - key: name description: Custom label to define the name of the - library branch. metrics: - name: - library.googleapis.com/book/borrowed_count metric_kind: DELTA - value_type: INT64 unit: "1" billing: consumer_destinations: - - monitored_resource: library.googleapis.com/billing_branch metrics: - - library.googleapis.com/book/borrowed_count properties: - consumerDestinations: + samplePeriod: + type: string + format: google-duration + description: >- + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. + timeSeriesResourceHierarchyLevel: + description: The scope of the timeseries data of the metric. items: - $ref: '#/components/schemas/BillingDestination' + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER + type: string type: array + launchStage: + type: string + deprecated: true + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + ingestDelay: + type: string + format: google-duration description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - id: Billing - RemoveDnsZoneRequest: + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + id: MetricDescriptorMetadata + Empty: + type: object + properties: {} + id: Empty description: >- - Request to remove a private managed DNS zone in the shared producer host - project and a matching DNS peering zone in the consumer project. + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + CppSettings: + description: Settings for C++ client libraries. + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + id: CppSettings + type: object + AddRolesMetadata: + properties: {} + description: >- + Metadata provided through GetOperation request for the LRO generated by + AddRoles API + type: object + id: AddRolesMetadata + Page: type: object + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. + id: Page properties: - consumerNetwork: - type: string - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. name: description: >- - Required. The name for both the private zone in the shared producer - host project and the peering zone in the consumer project. + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. type: string - id: RemoveDnsZoneRequest - Documentation: - id: Documentation - type: object - properties: - pages: + content: + description: >- + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. + type: string + subpages: + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. type: array items: $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. + Documentation: + id: Documentation + properties: + documentationRootUrl: + type: string + description: The URL to the root of documentation. + serviceRootUrl: + type: string + description: >- + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. overview: type: string description: >- @@ -2980,6 +2975,27 @@ components: documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. + pages: + description: The top level pages for the documentation set. + items: + $ref: '#/components/schemas/Page' + type: array + sectionOverrides: + type: array + items: + $ref: '#/components/schemas/Page' + description: >- + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries + rules: + type: array + items: + $ref: '#/components/schemas/DocumentationRule' + description: >- + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. summary: type: string description: >- @@ -2987,767 +3003,978 @@ components: plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`. - sectionOverrides: + type: object + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. + SearchRangeRequest: + properties: + ipPrefixLength: + type: integer + format: int32 + description: >- + Required. The prefix length of the IP range. Use usual CIDR range + notation. For example, '30' to find unused x.x.x.x/30 CIDR range. + Actual range will be determined using allocated range for the + consumer peered network and returned in the result. + network: + description: >- + Network name in the consumer project. This network must have been + already peered with a shared VPC network using CreateConnection + method. Must be in a form + 'projects/{project}/global/networks/{network}'. {project} is a + project number, as in '12345' {network} is network name. + type: string + type: object + id: SearchRangeRequest + description: Request to search for an unused range within allocated ranges. + Field: + description: A single field of a message type. + id: Field + type: object + properties: + kind: + enumDescriptions: + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + description: The field type. + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 + type: string + name: + type: string + description: The field name. + packed: + type: boolean + description: Whether to use alternative packed wire representation. + jsonName: + description: The field JSON name. + type: string + number: + format: int32 + description: The field number. + type: integer + oneofIndex: + format: int32 + type: integer + description: >- + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + typeUrl: + type: string + description: >- + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + cardinality: + enum: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. + type: string + description: The field cardinality. + options: + description: The protocol buffer options. + type: array items: - $ref: '#/components/schemas/Page' + $ref: '#/components/schemas/Option' + defaultValue: description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries + The string value of the default value of this field. Proto2 syntax + only. + type: string + CancelOperationRequest: + id: CancelOperationRequest + description: The request message for Operations.CancelOperation. + type: object + properties: {} + ListConnectionsResponse: + id: ListConnectionsResponse + properties: + connections: + items: + $ref: '#/components/schemas/Connection' + type: array + description: The list of Connections. + type: object + description: >- + ListConnectionsResponse is the response to list peering states for the + given service and consumer project. + Type: + description: A protocol buffer message type. + id: Type + type: object + properties: + edition: + description: >- + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + type: string + fields: + description: The list of fields. + items: + $ref: '#/components/schemas/Field' type: array - documentationRootUrl: + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. type: string - description: The URL to the root of documentation. - rules: - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. + oneofs: + description: The list of types appearing in `oneof` definitions in this type. type: array items: - $ref: '#/components/schemas/DocumentationRule' - serviceRootUrl: - description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. + type: string + name: type: string - description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. - AddRolesMetadata: - id: AddRolesMetadata - properties: {} + description: The fully qualified message name. + options: + type: array + items: + $ref: '#/components/schemas/Option' + description: The protocol buffer options. + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + UpdateDnsRecordSetMetadata: description: >- Metadata provided through GetOperation request for the LRO generated by - AddRoles API - type: object - AddDnsRecordSetRequest: - description: >- - Request to add a record set to a private managed DNS zone in the shared - producer host project. - id: AddDnsRecordSetRequest + UpdateDnsRecordSet API type: object + id: UpdateDnsRecordSetMetadata + properties: {} + ConsumerProject: properties: - zone: - type: string + projectNum: + format: int64 description: >- - Required. The name of the private DNS zone in the shared producer - host project to which the record set will be added. - dnsRecordSet: - description: Required. The DNS record set to add. - $ref: '#/components/schemas/DnsRecordSet' - consumerNetwork: + Required. Project number of the consumer that is launching the + service instance. It can own the network that is peered with Google + or, be a service project in an XPN where the host project has the + network. type: string - description: >- - Required. The network that the consumer is using to connect with - services. Must be in the form of - projects/{project}/global/networks/{network} {project} is the - project number, as in '12345' {network} is the network name. - CppSettings: + description: Represents a consumer project. type: object - id: CppSettings - description: Settings for C++ client libraries. + id: ConsumerProject + DotnetSettings: properties: common: - description: Some settings. $ref: '#/components/schemas/CommonLanguageSettings' - PythonSettings: - type: object - description: Settings for Python client libraries. - properties: - common: description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - id: PythonSettings - ListConnectionsResponse: - id: ListConnectionsResponse - properties: - connections: + forcedNamespaceAliases: + description: >- + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision items: - $ref: '#/components/schemas/Connection' - description: The list of Connections. + type: string type: array + renamedServices: + additionalProperties: + type: string + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + type: object + ignoredResources: + type: array + items: + type: string + description: >- + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + handwrittenSignatures: + items: + type: string + type: array + description: >- + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + renamedResources: + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + additionalProperties: + type: string + type: object type: object + description: Settings for Dotnet client libraries. + id: DotnetSettings + SystemParameters: description: >- - ListConnectionsResponse is the response to list peering states for the - given service and consumer project. - ValidateConsumerConfigResponse: + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + id: SystemParameters + type: object properties: - isValid: + rules: + description: >- + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. + type: array + items: + $ref: '#/components/schemas/SystemParameterRule' + CustomErrorRule: + properties: + isErrorType: type: boolean - description: Indicates whether all the requested validations passed. - validationError: - description: The first validation which failed. - enum: - - VALIDATION_ERROR_UNSPECIFIED - - VALIDATION_NOT_REQUESTED - - SERVICE_NETWORKING_NOT_ENABLED - - NETWORK_NOT_FOUND - - NETWORK_NOT_PEERED - - NETWORK_PEERING_DELETED - - NETWORK_NOT_IN_CONSUMERS_PROJECT - - NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT - - HOST_PROJECT_NOT_FOUND - - CONSUMER_PROJECT_NOT_SERVICE_PROJECT - - RANGES_EXHAUSTED - - RANGES_NOT_RESERVED - - RANGES_DELETED_LATER - - COMPUTE_API_NOT_ENABLED - - USE_PERMISSION_NOT_FOUND - enumDescriptions: - - '' - - In case none of the validations are requested. - - '' - - The network provided by the consumer does not exist. - - The network has not been peered with the producer org. - - The peering was created and later deleted. - - >- - The network is a regular VPC but the network is not in the - consumer's project. - - >- - The consumer project is a service project, and network is a shared - VPC, but the network is not in the host project of this consumer - project. - - >- - The host project associated with the consumer project was not - found. - - >- - The consumer project is not a service project for the specified - host project. - - >- - The reserved IP ranges do not have enough space to create a subnet - of desired size. - - The IP ranges were not reserved. - - The IP ranges were reserved but deleted later. - - The consumer project does not have the compute api enabled. - - >- - The consumer project does not have the permission from the host - project. + description: >- + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + selector: + description: >- + Selects messages to which this rule applies. Refer to selector for + syntax details. type: string - existingSubnetworkCandidates: + type: object + description: A custom error rule. + id: CustomErrorRule + VpcServiceControls: + properties: + enabled: + readOnly: true + type: boolean description: >- - List of subnetwork candidates from the request which exist with the + Output only. Indicates whether the VPC Service Controls are enabled + or disabled for the connection. If the consumer called the + EnableVpcServiceControls method, then this is true. If the consumer + called DisableVpcServiceControls, then this is false. The default is + false. + id: VpcServiceControls + description: Response for the get VPC Service Controls request. + type: object + RangeReservation: + properties: + requestedRanges: + items: + type: string + type: array + description: >- + Optional. The name of one or more allocated IP address ranges + associated with this private service access connection. If no range + names are provided all ranges associated with this connection will + be considered. If a CIDR range with the specified IP prefix length + is not available within these ranges the validation fails. + subnetworkCandidates: + type: array + description: >- + Optional. List of subnetwork candidates to validate. The required + input fields are `name`, `network`, and `region`. Subnetworks from + this list which exist will be returned in the response with the `ip_cidr_range`, `secondary_ip_cider_ranges`, and `outside_allocation` fields set. - type: array items: $ref: '#/components/schemas/Subnetwork' - type: object - id: ValidateConsumerConfigResponse - Quota: - properties: - limits: + secondaryRangeIpPrefixLengths: type: array - description: List of QuotaLimit definitions for the service. items: - $ref: '#/components/schemas/QuotaLimit' - metricRules: + format: int32 + type: integer + description: >- + Optional. The size of the desired secondary ranges for the subnet. + Use usual CIDR range notation. For example, '29' to find unused + x.x.x.x/29 CIDR range. The goal is to determine that the allocated + ranges have enough free space for all the requested secondary + ranges. GCE disallows subnets with prefix_length > 29 + ipPrefixLength: + description: >- + Required. The size of the desired subnet. Use usual CIDR range + notation. For example, '29' to find unused x.x.x.x/29 CIDR range. + The goal is to determine if one of the allocated ranges has enough + free space for a subnet of the requested size. GCE disallows subnets + with prefix_length > 29 + format: int32 + type: integer + description: Represents a range reservation. + type: object + id: RangeReservation + BillingDestination: + id: BillingDestination + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + type: object + properties: + monitoredResource: + type: string + description: >- + The monitored resource type. The type must be defined in + Service.monitored_resources section. + metrics: items: - $ref: '#/components/schemas/MetricRule' + type: string description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. type: array - id: Quota - type: object + RemoveDnsRecordSetMetadata: description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - SourceInfo: - id: SourceInfo + Metadata provided through GetOperation request for the LRO generated by + RemoveDnsRecordSet API + properties: {} type: object + id: RemoveDnsRecordSetMetadata + CustomError: + id: CustomError properties: - sourceFiles: + rules: + items: + $ref: '#/components/schemas/CustomErrorRule' + description: >- + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. + type: array + types: type: array - description: All files used during config generation. items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - description: Source information used to create a Service Config - SystemParameterRule: + type: string + description: >- + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. + type: object + description: >- + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + CommonLanguageSettings: + id: CommonLanguageSettings + description: Required information for every language. + type: object properties: - selector: - type: string + referenceDocsUri: + deprecated: true description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - parameters: + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest + type: string + destinations: description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. + The destination where API teams want this client library to be + published. type: array items: - $ref: '#/components/schemas/SystemParameter' + type: string + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + ConsumerConfigMetadata: + description: >- + Metadata provided through GetOperation request for the LRO generated by + UpdateConsumerConfig API. + id: ConsumerConfigMetadata + properties: {} + type: object + GetDnsZoneResponse: type: object - id: SystemParameterRule description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - ListOperationsResponse: - description: The response message for Operations.ListOperations. + Represents managed DNS zones created in the shared Producer host and + consumer projects. properties: - nextPageToken: - description: The standard List next-page token. - type: string - operations: + consumerPeeringZone: + $ref: '#/components/schemas/DnsZone' + description: The DNS peering zone created in the consumer project. + producerPrivateZone: + description: The private DNS zone created in the shared producer host project. + $ref: '#/components/schemas/DnsZone' + id: GetDnsZoneResponse + EnumValue: + description: Enum value definition. + id: EnumValue + type: object + properties: + number: + type: integer + description: Enum value number. + format: int32 + options: items: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Option' + description: Protocol buffer options. type: array - description: >- - A list of operations that matches the specified filter in the - request. - id: ListOperationsResponse - type: object - ConsumerConfig: - description: Configuration information for a private service access connection. - type: object + name: + type: string + description: Enum value name. + QuotaLimit: properties: - consumerExportCustomRoutes: - type: boolean + maxLimit: + format: int64 + type: string + description: >- + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + duration: + type: string + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. + values: + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + type: object + additionalProperties: + type: string + format: int64 + freeTier: description: >- - Export custom routes flag value for peering from consumer to - producer. - producerNetwork: + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + type: string + format: int64 + displayName: type: string description: >- - Output only. The VPC host network that is used to host managed - service instances. In the format, - projects/{project}/global/networks/{network} where {project} is the - project number e.g. '12345' and {network} is the network name. - readOnly: true - cloudsqlConfigs: - description: Represents one or multiple Cloud SQL configurations. - type: array - items: - $ref: '#/components/schemas/CloudSQLConfig' - consumerImportSubnetRoutesWithPublicIp: - type: boolean - description: >- - Import subnet routes with public ip flag value for peering from - consumer to producer. - vpcScReferenceArchitectureEnabled: - readOnly: true + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + metric: description: >- - Output only. Indicates whether the VPC Service Controls reference - architecture is configured for the producer VPC host network. - type: boolean - consumerImportCustomRoutes: - type: boolean + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + type: string + defaultLimit: + type: string description: >- - Import custom routes flag value for peering from consumer to - producer. - producerImportSubnetRoutesWithPublicIp: + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + format: int64 + name: description: >- - Import subnet routes with public ip flag value for peering from - producer to consumer. - type: boolean - producerExportSubnetRoutesWithPublicIp: - type: boolean + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + type: string + unit: description: >- - Export subnet routes with public ip flag value for peering from - producer to consumer. - producerExportCustomRoutes: - type: boolean + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + type: string + description: description: >- - Export custom routes flag value for peering from producer to - consumer. - producerImportCustomRoutes: - type: boolean + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + type: string + id: QuotaLimit + type: object + description: >- + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. + LogDescriptor: + id: LogDescriptor + type: object + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer + properties: + displayName: + type: string description: >- - Import custom routes flag value for peering from producer to - consumer. - usedIpRanges: - description: Output only. The IP ranges already in use by consumer or producer - type: array - readOnly: true + The human-readable name for this log. This information appears on + the user interface and should be concise. + labels: items: - type: string - consumerExportSubnetRoutesWithPublicIp: + $ref: '#/components/schemas/LabelDescriptor' description: >- - Export subnet routes with public ip flag value for peering from - consumer to producer. - type: boolean - reservedRanges: - items: - $ref: >- - #/components/schemas/GoogleCloudServicenetworkingV1ConsumerConfigReservedRange - readOnly: true + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. type: array + description: description: >- - Output only. The reserved ranges associated with this private - service access connection. - id: ConsumerConfig - Range: - properties: - network: - description: >- - In the Shared VPC host project, the VPC network that's peered with - the consumer network. For example: - `projects/1234321/global/networks/host-network` + A human-readable description of this log. This information appears + in the documentation and can contain details. type: string - ipCidrRange: + name: type: string description: >- - CIDR range in "10.x.x.x/y" format that is within the allocated - ranges and currently unused. - type: object - description: Represents a found unused range. - id: Range - BackendRule: + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + Service: properties: - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - pathTranslation: - enumDescriptions: - - '' - - >- - Use the backend address as-is, with no modification to the path. - If the URL pattern contains variables, the variable names and - values will be appended to the query string. If a query string - parameter and a URL pattern variable have the same name, this may - result in duplicate keys in the query string. # Examples Given the - following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.cloudfunctions.net/getUser Requests to the - following request paths will call the backend at the translated - path: Request path: /api/company/widgetworks/user/johndoe - Translated: - https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe - - >- - The request path will be appended to the backend address. # - Examples Given the following operation config: Method path: - /api/company/{cid}/user/{uid} Backend address: - https://example.appspot.com Requests to the following request - paths will call the backend at the translated path: Request path: - /api/company/widgetworks/user/johndoe Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe - Request path: /api/company/widgetworks/user/johndoe?timezone=EST - Translated: - https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + id: type: string - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS - jwtAudience: description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + title: type: string - deadline: description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - format: double - type: number - operationDeadline: + The product title for this service, it is the name displayed in + Google Cloud Console. + customError: + $ref: '#/components/schemas/CustomError' + description: Custom error configuration. + context: + $ref: '#/components/schemas/Context' + description: Context configuration. + apis: + type: array + items: + $ref: '#/components/schemas/Api' description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - type: number - format: double - disableAuth: - type: boolean + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + authentication: + description: Auth configuration. + $ref: '#/components/schemas/Authentication' + sourceInfo: + $ref: '#/components/schemas/SourceInfo' + description: >- + Output only. The source information for this configuration if + available. + monitoredResources: description: >- - When disable_auth is true, a JWT ID token won't be generated and the - original "Authorization" HTTP header will be preserved. If the - header is used to carry the original token and is expected by the - backend, this field must be set to true to preserve the header. - protocol: + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + type: array + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + name: description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. - type: string - address: + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. type: string + billing: + $ref: '#/components/schemas/Billing' + description: Billing configuration. + http: + description: HTTP configuration. + $ref: '#/components/schemas/Http' + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. + logs: + items: + $ref: '#/components/schemas/LogDescriptor' + description: Defines the logs used by this service. + type: array + publishing: description: >- - The address of the API backend. The scheme is used to determine the - backend protocol and security. The following schemes are accepted: - SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// - gRPC None grpcs:// gRPC TLS It is recommended to explicitly include - a scheme. Leaving out the scheme may cause constrasting behaviors - across platforms. If the port is unspecified, the default is: - 80 - for schemes without TLS - 443 for schemes with TLS For HTTP - backends, use protocol to specify the protocol version. - overridesByRequestProtocol: - description: The map between request protocol and the backend address. - type: object - additionalProperties: - $ref: '#/components/schemas/BackendRule' - minDeadline: - format: double - deprecated: true - type: number - description: Deprecated, do not use. - type: object - id: BackendRule - description: A backend rule provides configuration for an individual API element. - DnsZonePair: - properties: - consumerPeeringZone: - description: The DNS peering zone in the consumer project. - $ref: '#/components/schemas/DnsZone' - producerPrivateZone: - $ref: '#/components/schemas/DnsZone' - description: The private DNS zone in the shared producer host project. - description: '* Represents a pair of private and peering DNS zone resources. *' - id: DnsZonePair - type: object - Usage: - properties: - requirements: + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' + systemTypes: + type: array + items: + $ref: '#/components/schemas/Type' description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + backend: + description: API backend configuration. + $ref: '#/components/schemas/Backend' + configVersion: + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + type: integer + format: uint32 + systemParameters: + description: System parameter configuration. + $ref: '#/components/schemas/SystemParameters' + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + metrics: + description: Defines the metrics used by this service. + type: array items: - type: string + $ref: '#/components/schemas/MetricDescriptor' + enums: + description: >- + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum type: array - rules: + items: + $ref: '#/components/schemas/Enum' + producerProjectId: + description: The Google project that owns this service. + type: string + endpoints: type: array items: - $ref: '#/components/schemas/UsageRule' + $ref: '#/components/schemas/Endpoint' description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - producerNotificationChannel: + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. + types: description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. - type: string + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + type: array + items: + $ref: '#/components/schemas/Type' + id: Service type: object - description: Configuration controlling usage of a service. - id: Usage - OAuthRequirements: - id: OAuthRequirements - properties: - canonicalScopes: - description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read - type: string description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - type: object - AddDnsZoneResponse: + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth + MethodSettings: type: object - description: >- - Represents managed DNS zones created in the shared producer host and - consumer projects. - id: AddDnsZoneResponse - properties: - consumerPeeringZone: - description: The DNS peering zone created in the consumer project. - $ref: '#/components/schemas/DnsZone' - producerPrivateZone: - $ref: '#/components/schemas/DnsZone' - description: The private DNS zone created in the shared producer host project. - RubySettings: properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - id: RubySettings - description: Settings for Ruby client libraries. - Http: + selector: + description: >- + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + type: string + autoPopulatedFields: + description: >- + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id + items: + type: string + type: array + longRunning: + description: >- + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + $ref: '#/components/schemas/LongRunning' + description: Describes the generator configuration for a method. + id: MethodSettings + ListDnsZonesResponse: + id: ListDnsZonesResponse properties: - rules: - items: - $ref: '#/components/schemas/HttpRule' + dnsZonePairs: type: array + items: + $ref: '#/components/schemas/DnsZonePair' description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. - fullyDecodeReservedExpansion: - type: boolean - description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. + All pairs of private DNS zones in the shared producer host project + and the matching peering zones in the consumer project.. description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. - id: Http + Represents all DNS zones in the shared producer host project and the + matching peering zones in the consumer project. type: object - Endpoint: + SourceContext: + id: SourceContext + type: object + description: >- + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. properties: - name: + fileName: type: string - description: The canonical name of this endpoint. - aliases: - items: - type: string description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. - type: array - target: + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + UpdateDnsRecordSetRequest: + type: object + properties: + zone: description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". + Required. The name of the private DNS zone in the shared producer + host project from which the record set will be removed. + type: string + existingDnsRecordSet: + $ref: '#/components/schemas/DnsRecordSet' + description: Required. The existing DNS record set to update. + consumerNetwork: type: string - allowCors: - type: boolean description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - type: object - id: Endpoint - description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true - LongRunning: + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. + newDnsRecordSet: + $ref: '#/components/schemas/DnsRecordSet' + description: >- + Required. The new values that the DNS record set should be updated + to hold. description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - type: object + Request to update a record set from a private managed DNS zone in the + shared producer host project. The name, type, ttl, and data values of + the existing record set must all exactly match an existing record set in + the specified zone. + id: UpdateDnsRecordSetRequest + RemoveDnsRecordSetRequest: properties: - initialPollDelay: + zone: type: string - format: google-duration description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - maxPollDelay: - format: google-duration - type: string + Required. The name of the private DNS zone in the shared producer + host project from which the record set will be removed. + dnsRecordSet: + $ref: '#/components/schemas/DnsRecordSet' + description: Required. The DNS record set to remove. + consumerNetwork: description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - totalPollTimeout: - description: 'Total polling timeout. Default value: 5 minutes.' + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is the + project number, as in '12345' {network} is the network name. type: string - format: google-duration - pollDelayMultiplier: - type: number - description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - format: float - id: LongRunning - MethodPolicy: + description: >- + Request to remove a record set from a private managed DNS zone in the + shared producer host project. The name, type, ttl, and data values must + all exactly match an existing record set in the specified zone. type: object - properties: - selector: - description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - type: string - requestPolicies: - type: array - items: - $ref: '#/components/schemas/FieldPolicy' - description: Policies that are applicable to the request message. - id: MethodPolicy - description: Defines policies applying to an RPC method. - Connection: - id: Connection + id: RemoveDnsRecordSetRequest + ValidateConsumerConfigRequest: type: object + id: ValidateConsumerConfigRequest properties: - reservedPeeringRanges: - items: - type: string - type: array + checkServiceNetworkingUsePermission: description: >- - The name of one or more allocated IP address ranges for this service - producer of type `PEERING`. Note that invoking CreateConnection - method with a different range when connection is already established - will not modify already provisioned service producer subnetworks. If - CreateConnection method is invoked repeatedly to reconnect when - peering connection had been disconnected on the consumer side, - leaving this field empty will restore previously allocated IP - ranges. - service: - readOnly: true + Optional. The IAM permission check determines whether the consumer + project has 'servicenetworking.services.use' permission or not. + type: boolean + consumerProject: description: >- - Output only. The name of the peering service that's associated with - this connection, in the following format: `services/{service name}`. - type: string - network: + NETWORK_NOT_IN_CONSUMERS_PROJECT, + NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND + are done when consumer_project is provided. + $ref: '#/components/schemas/ConsumerProject' + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. type: string + validateNetwork: description: >- - The name of service consumer's VPC network that's connected with - service producer network, in the following format: - `projects/{project}/global/networks/{network}`. `{project}` is a - project number, such as in `12345` that includes the VPC service - consumer's VPC network. `{network}` is the name of the service - consumer's VPC network. - peering: - readOnly: true + The validations will be performed in the order listed in the + ValidationError enum. The first failure will return. If a validation + is not requested, then the next one will be performed. + SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are + performed for all requests where validation is requested. + NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for + requests that have validate_network set to true. + type: boolean + rangeReservation: + $ref: '#/components/schemas/RangeReservation' description: >- - Output only. The name of the VPC Network Peering connection that was - created by the service producer. - type: string - description: >- - Represents a private connection resource. A private connection is - implemented as a VPC Network Peering connection between a service - producer's VPC network and a service consumer's VPC network. - MetricDescriptor: - id: MetricDescriptor - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. + RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are + done when range_reservation is provided. + MonitoredResourceDescriptor: + id: MonitoredResourceDescriptor properties: name: type: string - description: The resource name of the metric descriptor. + description: >- + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. + labels: + description: >- + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array type: type: string description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - metricKind: - description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - type: string + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). launchStage: enumDescriptions: - Do not use this default value. @@ -3787,7 +4014,6 @@ components: [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. - description: Optional. The launch stage of the metric definition. enum: - LAUNCH_STAGE_UNSPECIFIED - UNIMPLEMENTED @@ -3798,292 +4024,122 @@ components: - GA - DEPRECATED type: string - unit: - type: string - description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). - metadata: - description: Optional. Metadata which can be used to guide usage of the metric. - $ref: '#/components/schemas/MetricDescriptorMetadata' + description: Optional. The launch stage of the monitored resource definition. displayName: - description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. type: string - valueType: - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - type: string - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. description: description: >- - A detailed description of the metric, which can be used in - documentation. - type: string - labels: - items: - $ref: '#/components/schemas/LabelDescriptor' - type: array - description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. - monitoredResourceTypes: - items: - type: string - type: array - description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. - type: object - AuthProvider: - description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - id: AuthProvider - type: object - properties: - jwksUri: - description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs - type: string - issuer: - description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - type: string - authorizationUrl: - type: string - description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. - audiences: - type: string - description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com - jwtLocations: - description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - type: array - items: - $ref: '#/components/schemas/JwtLocation' - id: - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". + Optional. A detailed description of the monitored resource type that + might be used in documentation. type: string - AddDnsZoneMetadata: - properties: {} description: >- - Metadata provided through GetOperation request for the LRO generated by - AddDnsZone API - type: object - id: AddDnsZoneMetadata - Backend: - description: '`Backend` defines the backend configuration for a service.' + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. type: object - id: Backend - properties: - rules: - type: array - description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/BackendRule' - Operation: - id: Operation - description: >- - This resource represents a long-running operation that is the result of - a network API call. + GoogleCloudServicenetworkingV1betaConnection: properties: - response: + reservedPeeringRanges: + items: + type: string + type: array description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - name: + The name of one or more allocated IP address ranges for this service + producer of type `PEERING`. Note that invoking this method with a + different range when connection is already established will not + modify already provisioned service producer subnetworks. + peering: description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. + Output only. The name of the VPC Network Peering connection that was + created by the service producer. + type: string + network: type: string - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - metadata: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - done: + The name of service consumer's VPC network that's connected with + service producer network, in the following format: + `projects/{project}/global/networks/{network}`. `{project}` is a + project number, such as in `12345` that includes the VPC service + consumer's VPC network. `{network}` is the name of the service + consumer's VPC network. + service: + type: string description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - type: object - PartialDeleteConnectionMetadata: + Output only. The name of the peering service that's associated with + this connection, in the following format: `services/{service name}`. type: object - properties: {} - id: PartialDeleteConnectionMetadata description: >- - Metadata provided through GetOperation request for the LRO generated by - Partial Delete Connection API - CustomErrorRule: - description: A custom error rule. - id: CustomErrorRule + Represents a private connection resource. A private connection is + implemented as a VPC Network Peering connection between a service + producer's VPC network and a service consumer's VPC network. + id: GoogleCloudServicenetworkingV1betaConnection + AddRolesResponse: type: object + id: AddRolesResponse + description: Represents IAM roles added to the shared VPC host project. properties: - selector: + policyBinding: + items: + $ref: '#/components/schemas/PolicyBinding' + type: array + description: >- + Required. List of policy bindings that were added to the shared VPC + host project. + PolicyBinding: + description: Grouping of IAM role and IAM member. + properties: + member: type: string description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. - isErrorType: + Required. Member to bind the role with. See + /iam/docs/reference/rest/v1/Policy#Binding for how to format each + member. Eg. - user:myuser@mydomain.com - + serviceAccount:my-service-account@app.gserviceaccount.com + role: description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - type: boolean + Required. Role to apply. Only allowlisted roles can be used at the + specified granularity. The role must be one of the following: - + 'roles/container.hostServiceAgentUser' applied on the shared VPC + host project - 'roles/compute.securityAdmin' applied on the shared + VPC host project - 'roles/compute.networkAdmin' applied on the + shared VPC host project - 'roles/tpu.xpnAgent' applied on the shared + VPC host project - 'roles/dns.admin' applied on the shared VPC host + project - 'roles/logging.admin' applied on the shared VPC host + project - 'roles/monitoring.viewer' applied on the shared VPC host + project - 'roles/servicemanagement.quotaViewer' applied on the + shared VPC host project + type: string + id: PolicyBinding + type: object + DisableVpcServiceControlsRequest: + description: Request to disable VPC service controls. + properties: + consumerNetwork: + description: >- + Required. The network that the consumer is using to connect with + services. Must be in the form of + projects/{project}/global/networks/{network} {project} is a project + number, as in '12345' {network} is network name. + type: string + type: object + id: DisableVpcServiceControlsRequest parameters: - oauth_token: - description: OAuth 2.0 token for the current user. + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: oauth_token + name: quotaUser schema: type: string upload_protocol: @@ -4092,19 +4148,26 @@ components: name: upload_protocol schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + callback: + description: JSONP in: query - name: quotaUser + name: callback schema: type: string - fields: - description: Selector specifying which fields to include in a partial response. + alt: + description: Data format for response. in: query - name: fields + name: alt + schema: + type: string + enum: + - json + - media + - proto + access_token: + description: OAuth access token. + in: query + name: access_token schema: type: string key: @@ -4116,18 +4179,6 @@ components: name: key schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - callback: - description: JSONP - in: query - name: callback - schema: - type: string _.xgafv: description: V1 error format. in: query @@ -4137,28 +4188,30 @@ components: enum: - '1' - '2' - alt: - description: Data format for response. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: alt + name: prettyPrint + schema: + type: boolean + fields: + description: Selector specifying which fields to include in a partial response. + in: query + name: fields schema: type: string - enum: - - json - - media - - proto - access_token: - description: OAuth access token. + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: access_token + name: oauth_token schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: prettyPrint + name: uploadType schema: - type: boolean + type: string x-stackQL-resources: dns_zones: id: google.servicenetworking.dns_zones @@ -4195,9 +4248,12 @@ components: select: - $ref: '#/components/x-stackQL-resources/dns_zones/methods/get' - $ref: '#/components/x-stackQL-resources/dns_zones/methods/list' - insert: [] + insert: + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/add' update: [] - delete: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dns_zones/methods/remove' roles: id: google.servicenetworking.roles name: roles @@ -4211,70 +4267,20 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] - update: [] - delete: [] - dns_record_set: - id: google.servicenetworking.dns_record_set - name: dns_record_set - title: Dns_record_set - methods: - get: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' - insert: [] - update: [] - delete: [] - dns_record_sets: - id: google.servicenetworking.dns_record_sets - name: dns_record_sets - title: Dns_record_sets - methods: - add: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' - response: - mediaType: application/json - openAPIDocKey: '200' - list: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:list/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' - response: - mediaType: application/json - openAPIDocKey: '200' - remove: - operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' - insert: [] - update: - - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/update' + insert: + - $ref: '#/components/x-stackQL-resources/roles/methods/add' + update: [] + replace: [] delete: [] connections: id: google.servicenetworking.connections name: connections title: Connections methods: - list: + patch: operation: - $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch response: mediaType: application/json openAPIDocKey: '200' @@ -4284,10 +4290,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - patch: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1connections~1{connectionsId}/patch + $ref: '#/paths/~1v1~1services~1{servicesId}~1connections/get' response: mediaType: application/json openAPIDocKey: '200' @@ -4298,6 +4303,7 @@ components: - $ref: '#/components/x-stackQL-resources/connections/methods/create' update: - $ref: '#/components/x-stackQL-resources/connections/methods/patch' + replace: [] delete: [] connections_connection: id: google.servicenetworking.connections_connection @@ -4315,6 +4321,64 @@ components: select: [] insert: [] update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/connections_connection/methods/delete_connection + peered_dns_domains: + id: google.servicenetworking.peered_dns_domains + name: peered_dns_domains + title: Peered_dns_domains + methods: + delete: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get + response: + mediaType: application/json + openAPIDocKey: '200' + create: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/create' + update: [] + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' + networks_consumer_config: + id: google.servicenetworking.networks_consumer_config + name: networks_consumer_config + title: Networks_consumer_config + methods: + update_consumer_config: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}:updateConsumerConfig/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/networks_consumer_config/methods/update_consumer_config + replace: [] delete: [] networks_vpc_service_controls: id: google.servicenetworking.networks_vpc_service_controls @@ -4334,6 +4398,7 @@ components: #/components/x-stackQL-resources/networks_vpc_service_controls/methods/get_vpc_service_controls insert: [] update: [] + replace: [] delete: [] networks: id: google.servicenetworking.networks @@ -4352,75 +4417,65 @@ components: - $ref: '#/components/x-stackQL-resources/networks/methods/get' insert: [] update: [] + replace: [] delete: [] - networks_consumer_config: - id: google.servicenetworking.networks_consumer_config - name: networks_consumer_config - title: Networks_consumer_config + dns_record_set: + id: google.servicenetworking.dns_record_set + name: dns_record_set + title: Dns_record_set methods: - update_consumer_config: + get: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}:updateConsumerConfig/patch + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:get/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/dns_record_set/methods/get' insert: [] update: [] + replace: [] delete: [] - peered_dns_domains: - id: google.servicenetworking.peered_dns_domains - name: peered_dns_domains - title: Peered_dns_domains + dns_record_sets: + id: google.servicenetworking.dns_record_sets + name: dns_record_sets + title: Dns_record_sets methods: - create: + remove: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/post + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:remove/post' response: mediaType: application/json openAPIDocKey: '200' - list: + add: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains/get + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:add/post' response: mediaType: application/json openAPIDocKey: '200' - delete: + update: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1projects~1{projectsId}~1global~1networks~1{networksId}~1peeredDnsDomains~1{peeredDnsDomainsId}/delete + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:update/post' response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/create' - update: [] - delete: - - $ref: '#/components/x-stackQL-resources/peered_dns_domains/methods/delete' - services_subnetwork: - id: google.servicenetworking.services_subnetwork - name: services_subnetwork - title: Services_subnetwork - methods: - add_subnetwork: + list: operation: - $ref: >- - #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post + $ref: '#/paths/~1v1~1services~1{servicesId}~1dnsRecordSets:list/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] - insert: [] - update: [] - delete: [] + select: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/add' + update: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/update' + replace: [] + delete: + - $ref: '#/components/x-stackQL-resources/dns_record_sets/methods/remove' services: id: google.servicenetworking.services name: services @@ -4432,17 +4487,17 @@ components: response: mediaType: application/json openAPIDocKey: '200' - enable_vpc_service_controls: + disable_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch + #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' - disable_vpc_service_controls: + enable_vpc_service_controls: operation: $ref: >- - #/paths/~1v1~1services~1{servicesId}:disableVpcServiceControls/patch + #/paths/~1v1~1services~1{servicesId}:enableVpcServiceControls/patch response: mediaType: application/json openAPIDocKey: '200' @@ -4456,6 +4511,27 @@ components: select: [] insert: [] update: [] + replace: [] + delete: [] + services_subnetwork: + id: google.servicenetworking.services_subnetwork + name: services_subnetwork + title: Services_subnetwork + methods: + add_subnetwork: + operation: + $ref: >- + #/paths/~1v1~1services~1{servicesId}~1{servicesId1}~1{servicesId2}:addSubnetwork/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/services_subnetwork/methods/add_subnetwork + update: [] + replace: [] delete: [] operations: id: google.servicenetworking.operations @@ -4468,25 +4544,22 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 - delete: + get: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' @@ -4496,104 +4569,34 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: /v1/services/{servicesId}/dnsZones:add: - parameters: &ref_3 - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/upload_protocol' + parameters: &ref_1 - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' + - $ref: '#/components/parameters/uploadType' post: - description: >- - Service producers can use this method to add private DNS zones in the - shared producer host project and matching peering zones in the consumer - project. - operationId: servicenetworking.services.dnsZones.add - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddDnsZoneRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: servicesId - required: true - schema: - type: string - /v1/services/{servicesId}/dnsZones:remove: - parameters: *ref_3 - post: - description: >- - Service producers can use this method to remove private DNS zones in the - shared producer host project and matching peering zones in the consumer - project. - operationId: servicenetworking.services.dnsZones.remove - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemoveDnsZoneRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: servicesId - required: true - schema: - type: string - /v1/services/{servicesId}/roles:add: - parameters: *ref_3 - post: - description: >- - Service producers can use this method to add roles in the shared VPC - host project. Each role is bound to the provided member. Each role must - be selected from within an allowlisted set of roles. Each role is - applied at only the granularity specified in the allowlist. - operationId: servicenetworking.services.roles.add + description: >- + Service producers can use this method to add private DNS zones in the + shared producer host project and matching peering zones in the consumer + project. + operationId: servicenetworking.services.dnsZones.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddRolesRequest' + $ref: '#/components/schemas/AddDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4616,14 +4619,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:get: - parameters: *ref_3 - get: + /v1/services/{servicesId}/dnsZones:remove: + parameters: *ref_1 + post: description: >- - Producers can use this method to retrieve information about the DNS - record set added to the private zone inside the shared tenant host - project associated with a consumer network. - operationId: servicenetworking.services.dnsRecordSets.get + Service producers can use this method to remove private DNS zones in the + shared producer host project and matching peering zones in the consumer + project. + operationId: servicenetworking.services.dnsZones.remove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveDnsZoneRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4639,41 +4647,27 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DnsRecordSet' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: domain - schema: - type: string - - in: query - name: type - schema: - type: string - - in: query - name: zone - schema: - type: string - - in: query - name: consumerNetwork - schema: - type: string - /v1/services/{servicesId}/dnsRecordSets:add: - parameters: *ref_3 + /v1/services/{servicesId}/roles:add: + parameters: *ref_1 post: description: >- - Service producers can use this method to add DNS record sets to private - DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.add + Service producers can use this method to add roles in the shared VPC + host project. Each role is bound to the provided member. Each role must + be selected from within an allowlisted set of roles. Each role is + applied at only the granularity specified in the allowlist. + operationId: servicenetworking.services.roles.add requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddDnsRecordSetRequest' + $ref: '#/components/schemas/AddRolesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4696,14 +4690,16 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:list: - parameters: *ref_3 - get: - description: >- - Producers can use this method to retrieve a list of available DNS - RecordSets available inside the private zone on the tenant host project - accessible from their network. - operationId: servicenetworking.services.dnsRecordSets.list + /v1/services/{servicesId}/connections/{connectionsId}: + parameters: *ref_1 + patch: + description: Updates the allocated ranges that are assigned to a connection. + operationId: servicenetworking.services.connections.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4719,33 +4715,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsRecordSetsResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string - - in: query - name: zone + - in: path + name: connectionsId + required: true schema: type: string - in: query - name: consumerNetwork + name: force + schema: + type: boolean + - in: query + name: updateMask schema: type: string - /v1/services/{servicesId}/dnsRecordSets:update: - parameters: *ref_3 + format: google-fieldmask post: - description: >- - Service producers can use this method to update DNS record sets from - private DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.update + description: Deletes a private service access connection. + operationId: servicenetworking.services.connections.deleteConnection requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateDnsRecordSetRequest' + $ref: '#/components/schemas/DeleteConnectionRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4768,18 +4766,28 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/dnsRecordSets:remove: - parameters: *ref_3 + - in: path + name: connectionsId + required: true + schema: + type: string + /v1/services/{servicesId}/connections: + parameters: *ref_1 post: description: >- - Service producers can use this method to remove DNS record sets from - private DNS zones in the shared producer host project. - operationId: servicenetworking.services.dnsRecordSets.remove + Creates a private connection that establishes a VPC Network Peering + connection to a VPC network in the service producer's organization. The + administrator of the service consumer's VPC network invokes this method. + The administrator must assign one or more allocated IP ranges for + provisioning subnetworks in the service producer's VPC network. This + connection is used for all supported services in the service producer's + organization, so it only needs to be invoked once. + operationId: servicenetworking.services.connections.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/RemoveDnsRecordSetRequest' + $ref: '#/components/schemas/Connection' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4802,8 +4810,6 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/connections: - parameters: *ref_3 get: description: >- List the private connections that are configured in a service consumer's @@ -4835,21 +4841,14 @@ paths: name: network schema: type: string - post: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones/{dnsZonesId}: + parameters: *ref_1 + get: description: >- - Creates a private connection that establishes a VPC Network Peering - connection to a VPC network in the service producer's organization. The - administrator of the service consumer's VPC network invokes this method. - The administrator must assign one or more allocated IP ranges for - provisioning subnetworks in the service producer's VPC network. This - connection is used for all supported services in the service producer's - organization, so it only needs to be invoked once. - operationId: servicenetworking.services.connections.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' + Service producers can use this method to retrieve a DNS zone in the + shared producer host project and the matching peering zones in consumer + project + operationId: servicenetworking.services.projects.global.networks.dnsZones.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4865,67 +4864,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/GetDnsZoneResponse' parameters: - in: path name: servicesId required: true schema: type: string - /v1/services/{servicesId}/connections/{connectionsId}: - parameters: *ref_3 - patch: - description: Updates the allocated ranges that are assigned to a connection. - operationId: servicenetworking.services.connections.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/service.management - Oauth2c: - - https://www.googleapis.com/auth/service.management - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - in: path - name: servicesId + name: projectsId required: true schema: type: string - in: path - name: connectionsId + name: networksId required: true schema: type: string - - in: query - name: updateMask + - in: path + name: dnsZonesId + required: true schema: type: string - format: google-fieldmask - - in: query - name: force - schema: - type: boolean - post: - description: Deletes a private service access connection. - operationId: servicenetworking.services.connections.deleteConnection - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteConnectionRequest' + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: + parameters: *ref_1 + get: + description: >- + * Service producers can use this method to retrieve a list of available + DNS zones in the shared producer host project and the matching peering + zones in the consumer project. * + operationId: servicenetworking.services.projects.global.networks.dnsZones.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4941,7 +4909,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ListDnsZonesResponse' parameters: - in: path name: servicesId @@ -4949,18 +4917,21 @@ paths: schema: type: string - in: path - name: connectionsId + name: projectsId required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: - parameters: *ref_3 - get: - description: >- - Consumers use this method to find out the state of VPC Service Controls. - The controls could be enabled or disabled for a connection. + - in: path + name: networksId + required: true + schema: + type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: + parameters: *ref_1 + delete: + description: Deletes a peered DNS domain. operationId: >- - servicenetworking.services.projects.global.networks.getVpcServiceControls + servicenetworking.services.projects.global.networks.peeredDnsDomains.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4976,7 +4947,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/VpcServiceControls' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId @@ -4993,14 +4964,17 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: - parameters: *ref_3 + - in: path + name: peeredDnsDomainsId + required: true + schema: + type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: + parameters: *ref_1 get: - description: >- - Service producers use this method to get the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.get + description: Lists peered DNS domains for a connection. + operationId: >- + servicenetworking.services.projects.global.networks.peeredDnsDomains.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5016,7 +4990,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConsumerConfig' + $ref: '#/components/schemas/ListPeeredDnsDomainsResponse' parameters: - in: path name: servicesId @@ -5033,23 +5007,18 @@ paths: required: true schema: type: string - - in: query - name: includeUsedIpRanges - schema: - type: boolean - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: - parameters: *ref_3 - patch: + post: description: >- - Service producers use this method to update the configuration of their - connection including the import/export of custom routes and subnetwork - routes with public IP. - operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig + Creates a peered DNS domain which sends requests for records in given + namespace originating in the service producer VPC network to the + consumer VPC network to be resolved. + operationId: >- + servicenetworking.services.projects.global.networks.peeredDnsDomains.create requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateConsumerConfigRequest' + $ref: '#/components/schemas/PeeredDnsDomain' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5082,20 +5051,19 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains: - parameters: *ref_3 - post: + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}:updateConsumerConfig: + parameters: *ref_1 + patch: description: >- - Creates a peered DNS domain which sends requests for records in given - namespace originating in the service producer VPC network to the - consumer VPC network to be resolved. - operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.create + Service producers use this method to update the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.updateConsumerConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/PeeredDnsDomain' + $ref: '#/components/schemas/UpdateConsumerConfigRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5128,10 +5096,14 @@ paths: required: true schema: type: string + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/vpcServiceControls: + parameters: *ref_1 get: - description: Lists peered DNS domains for a connection. + description: >- + Consumers use this method to find out the state of VPC Service Controls. + The controls could be enabled or disabled for a connection. operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.list + servicenetworking.services.projects.global.networks.getVpcServiceControls security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5147,7 +5119,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListPeeredDnsDomainsResponse' + $ref: '#/components/schemas/VpcServiceControls' parameters: - in: path name: servicesId @@ -5164,12 +5136,14 @@ paths: required: true schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/peeredDnsDomains/{peeredDnsDomainsId}: - parameters: *ref_3 - delete: - description: Deletes a peered DNS domain. - operationId: >- - servicenetworking.services.projects.global.networks.peeredDnsDomains.delete + /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}: + parameters: *ref_1 + get: + description: >- + Service producers use this method to get the configuration of their + connection including the import/export of custom routes and subnetwork + routes with public IP. + operationId: servicenetworking.services.projects.global.networks.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5185,7 +5159,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/ConsumerConfig' parameters: - in: path name: servicesId @@ -5202,19 +5176,18 @@ paths: required: true schema: type: string - - in: path - name: peeredDnsDomainsId - required: true + - in: query + name: includeUsedIpRanges schema: - type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones/{dnsZonesId}: - parameters: *ref_3 + type: boolean + /v1/services/{servicesId}/dnsRecordSets:get: + parameters: *ref_1 get: description: >- - Service producers can use this method to retrieve a DNS zone in the - shared producer host project and the matching peering zones in consumer - project - operationId: servicenetworking.services.projects.global.networks.dnsZones.get + Producers can use this method to retrieve information about the DNS + record set added to the private zone inside the shared tenant host + project associated with a consumer network. + operationId: servicenetworking.services.dnsRecordSets.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5230,36 +5203,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetDnsZoneResponse' + $ref: '#/components/schemas/DnsRecordSet' parameters: - in: path name: servicesId required: true schema: type: string - - in: path - name: projectsId - required: true + - in: query + name: consumerNetwork schema: type: string - - in: path - name: networksId - required: true + - in: query + name: domain schema: type: string - - in: path - name: dnsZonesId - required: true + - in: query + name: type schema: type: string - /v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/dnsZones:list: - parameters: *ref_3 - get: + - in: query + name: zone + schema: + type: string + /v1/services/{servicesId}/dnsRecordSets:remove: + parameters: *ref_1 + post: description: >- - * Service producers can use this method to retrieve a list of available - DNS zones in the shared producer host project and the matching peering - zones in the consumer project. * - operationId: servicenetworking.services.projects.global.networks.dnsZones.list + Service producers can use this method to remove DNS record sets from + private DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.remove + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoveDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5275,41 +5253,59 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListDnsZonesResponse' + $ref: '#/components/schemas/Operation' parameters: - in: path name: servicesId required: true schema: type: string + /v1/services/{servicesId}/dnsRecordSets:add: + parameters: *ref_1 + post: + description: >- + Service producers can use this method to add DNS record sets to private + DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.add + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddDnsRecordSetRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: networksId + name: servicesId required: true schema: type: string - /v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork: - parameters: *ref_3 + /v1/services/{servicesId}/dnsRecordSets:update: + parameters: *ref_1 post: description: >- - For service producers, provisions a new subnet in a peered service's - shared VPC network in the requested region and with the requested size - that's expressed as a CIDR range (number of leading bits of ipV4 network - mask). The method checks against the assigned allocated ranges to find a - non-conflicting IP address range. The method will reuse a subnet if - subsequent calls contain the same subnet name, region, and prefix - length. This method will make producer's tenant project to be a shared - VPC service project as needed. - operationId: servicenetworking.services.addSubnetwork + Service producers can use this method to update DNS record sets from + private DNS zones in the shared producer host project. + operationId: servicenetworking.services.dnsRecordSets.update requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddSubnetworkRequest' + $ref: '#/components/schemas/UpdateDnsRecordSetRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5332,18 +5328,46 @@ paths: required: true schema: type: string + /v1/services/{servicesId}/dnsRecordSets:list: + parameters: *ref_1 + get: + description: >- + Producers can use this method to retrieve a list of available DNS + RecordSets available inside the private zone on the tenant host project + accessible from their network. + operationId: servicenetworking.services.dnsRecordSets.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListDnsRecordSetsResponse' + parameters: - in: path - name: servicesId1 + name: servicesId required: true schema: type: string - - in: path - name: servicesId2 - required: true + - in: query + name: zone + schema: + type: string + - in: query + name: consumerNetwork schema: type: string /v1/services/{servicesId}:searchRange: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Service producers can use this method to find a currently unused range @@ -5380,8 +5404,40 @@ paths: required: true schema: type: string + /v1/services/{servicesId}:disableVpcServiceControls: + parameters: *ref_1 + patch: + description: Disables VPC service controls for a connection. + operationId: servicenetworking.services.disableVpcServiceControls + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DisableVpcServiceControlsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/service.management + Oauth2c: + - https://www.googleapis.com/auth/service.management + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: servicesId + required: true + schema: + type: string /v1/services/{servicesId}:enableVpcServiceControls: - parameters: *ref_3 + parameters: *ref_1 patch: description: Enables VPC service controls for a connection. operationId: servicenetworking.services.enableVpcServiceControls @@ -5412,16 +5468,24 @@ paths: required: true schema: type: string - /v1/services/{servicesId}:disableVpcServiceControls: - parameters: *ref_3 - patch: - description: Disables VPC service controls for a connection. - operationId: servicenetworking.services.disableVpcServiceControls + /v1/services/{servicesId}/{servicesId1}/{servicesId2}:addSubnetwork: + parameters: *ref_1 + post: + description: >- + For service producers, provisions a new subnet in a peered service's + shared VPC network in the requested region and with the requested size + that's expressed as a CIDR range (number of leading bits of ipV4 network + mask). The method checks against the assigned allocated ranges to find a + non-conflicting IP address range. The method will reuse a subnet if + subsequent calls contain the same subnet name, region, and prefix + length. This method will make producer's tenant project to be a shared + VPC service project as needed. + operationId: servicenetworking.services.addSubnetwork requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableVpcServiceControlsRequest' + $ref: '#/components/schemas/AddSubnetworkRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5444,8 +5508,18 @@ paths: required: true schema: type: string + - in: path + name: servicesId1 + required: true + schema: + type: string + - in: path + name: servicesId2 + required: true + schema: + type: string /v1/services/{servicesId}:validate: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Service producers use this method to validate if the consumer provided @@ -5482,7 +5556,7 @@ paths: schema: type: string /v1/operations/{operationsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5523,7 +5597,7 @@ paths: schema: type: string /v1/operations: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -5560,14 +5634,13 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_3 - delete: + parameters: *ref_1 + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: servicenetworking.operations.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: servicenetworking.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5583,19 +5656,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: operationsId required: true schema: type: string - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: servicenetworking.operations.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: servicenetworking.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -5611,7 +5685,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: operationsId diff --git a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml index cc214f01..77c8a18d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/serviceusage.yaml @@ -10,8 +10,8 @@ info: Platform, lists the available or enabled services, or disables services that service consumers no longer use. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/service-usage/ servers: @@ -25,13 +25,13 @@ components: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: &ref_0 + https://www.googleapis.com/auth/cloud-platform.read-only: >- + View your data across Google Cloud services and see the email + address of your Google Account https://www.googleapis.com/auth/cloud-platform: >- See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/service.management: Manage your Google API service configuration - https://www.googleapis.com/auth/cloud-platform.read-only: >- - View your data across Google Cloud services and see the email - address of your Google Account Oauth2c: type: oauth2 description: Oauth 2.0 authorization code authentication @@ -41,1448 +41,922 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - LongRunning: + DisableServiceRequest: properties: - maxPollDelay: - format: google-duration - description: >- - Maximum time between two subsequent poll requests. Default value: 45 - seconds. - type: string - totalPollTimeout: - type: string - format: google-duration - description: 'Total polling timeout. Default value: 5 minutes.' - initialPollDelay: - format: google-duration - type: string - description: >- - Initial delay after which the first poll request will be made. - Default value: 5 seconds. - pollDelayMultiplier: - type: number + disableDependentServices: + type: boolean description: >- - Multiplier to gradually increase delay between subsequent polls - until it reaches max_poll_delay. Default value: 1.5. - format: float - description: >- - Describes settings to use when generating API methods that use the - long-running operation pattern. All default values below are from those - used in the client library generators (e.g. - [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - type: object - id: LongRunning - GoogleApiServiceusageV1Service: - properties: - parent: + Indicates if services that are enabled and which depend on this + service should also be disabled. If not set, an error will be + generated if any enabled services depend on the service to be + disabled. When set, the service, and any enabled services that + depend on it, will be disabled together. + checkIfServiceHasUsage: type: string description: >- - The resource name of the consumer. A valid name would be: - - projects/123 - config: - $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' - description: >- - The service configuration of the available service. Some fields may - be filtered out of the configuration in responses to the - `ListServices` method. These fields are present only in responses to - the `GetService` method. - name: - description: >- - The resource name of the consumer and service. A valid name would - be: - projects/123/services/serviceusage.googleapis.com - type: string - state: - type: string - enum: - - STATE_UNSPECIFIED - - DISABLED - - ENABLED + Defines the behavior for checking service usage when disabling a + service. enumDescriptions: + - When unset, the default behavior is used, which is SKIP. + - If set, skip checking service usage when disabling a service. - >- - The default value, which indicates that the enabled state of the - service is unspecified or not meaningful. Currently, all consumers - other than projects (such as folders and organizations) are always - in this state. - - >- - The service cannot be used by this consumer. It has either been - explicitly disabled, or has never been enabled. - - The service has been explicitly enabled for use by this consumer. - description: Whether or not the service has been enabled for use by the consumer. - description: A service that is available for use by the consumer. - type: object - id: GoogleApiServiceusageV1Service - ImportAdminOverridesMetadata: - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by ImportAdminOverrides. - id: ImportAdminOverridesMetadata - properties: {} + If set, service usage is checked when disabling the service. If a + service, or its dependents, has usage in the last 30 days, the + request returns a FAILED_PRECONDITION error. + enum: + - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED + - SKIP + - CHECK type: object - UsageRule: - id: UsageRule + description: Request message for the `DisableService` method. + id: DisableServiceRequest + QuotaLimit: type: object + id: QuotaLimit description: >- - Usage configuration rules for the service. NOTE: Under development. Use - this rule to configure unregistered calls for the service. Unregistered - calls are calls that do not contain consumer project identity. (Example: - calls that do not contain an API key). By default, API methods do not - allow unregistered calls, and each method call must be identified by a - consumer project identity. Use this rule to allow/disallow unregistered - calls. Example of an API that wants to allow unregistered calls for - entire service. usage: rules: - selector: "*" allow_unregistered_calls: - true Example of a method that wants to allow unregistered calls. usage: - rules: - selector: "google.example.library.v1.LibraryService.CreateBook" - allow_unregistered_calls: true + `QuotaLimit` defines a specific limit that applies over a specified + duration for a limit type. There can be at most one limit for a duration + and limit type combination defined within a `QuotaGroup`. properties: - allowUnregisteredCalls: + description: description: >- - If true, the selected method allows unregistered calls, e.g. calls - that don't identify any user or application. - type: boolean - selector: + Optional. User-visible, extended description for this quota limit. + Should be used only when more context is needed to understand this + limit than provided by the limit's display name (see: + `display_name`). + type: string + freeTier: type: string + format: int64 description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. - skipServiceControl: - type: boolean + Free tier value displayed in the Developers Console for this limit. + The free tier is the number of tokens that will be subtracted from + the billed amount when billing is enabled. This field can only be + set on a limit with duration "1d", in a billable group; it is + invalid on any other limit. If this field is not set, it defaults to + 0, indicating that there is no free tier for this service. Used by + group-based quotas only. + displayName: description: >- - If true, the selected method should skip service control and the - control plane features, such as quota and billing, will not be - available. This flag is used by Google Cloud Endpoints to bypass - checks for internal methods, such as service health check methods. - Monitoring: - type: object - description: >- - Monitoring configuration of the service. The example below shows how to - configure monitored resources and metrics for monitoring. In the - example, a monitored resource and two metrics are defined. The - `library.googleapis.com/book/returned_count` metric is sent to both - producer and consumer projects, whereas the - `library.googleapis.com/book/num_overdue` metric is only sent to the - consumer project. monitored_resources: - type: - library.googleapis.com/Branch display_name: "Library Branch" - description: "A branch of a library." launch_stage: GA labels: - key: - resource_container description: "The Cloud container (ie. project id) - for the Branch." - key: location description: "The location of the - library branch." - key: branch_id description: "The id of the branch." - metrics: - name: library.googleapis.com/book/returned_count - display_name: "Books Returned" description: "The count of books that - have been returned." launch_stage: GA metric_kind: DELTA value_type: - INT64 unit: "1" labels: - key: customer_id description: "The id of the - customer." - name: library.googleapis.com/book/num_overdue display_name: - "Books Overdue" description: "The current number of overdue books." - launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - - key: customer_id description: "The id of the customer." monitoring: - producer_destinations: - monitored_resource: - library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count consumer_destinations: - - monitored_resource: library.googleapis.com/Branch metrics: - - library.googleapis.com/book/returned_count - - library.googleapis.com/book/num_overdue - id: Monitoring - properties: - producerDestinations: - items: - $ref: '#/components/schemas/MonitoringDestination' - type: array + User-visible display name for this limit. Optional. If not set, the + UI will provide a default display name based on the quota + configuration. This field can be used to override the default + display name generated from the configuration. + type: string + maxLimit: + type: string description: >- - Monitoring configurations for sending metrics to the producer - project. There can be multiple producer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - consumerDestinations: - type: array + Maximum number of tokens that can be consumed during the specified + duration. Client application developers can override the default + limit up to this maximum. If specified, this value cannot be set to + a value less than the default limit. If not specified, it is set to + the default limit. To allow clients to apply overrides with no upper + bound, set this to -1, indicating unlimited maximum quota. Used by + group-based quotas only. + format: int64 + metric: + type: string description: >- - Monitoring configurations for sending metrics to the consumer - project. There can be multiple consumer destinations. A monitored - resource type may appear in multiple monitoring destinations if - different aggregations are needed for different sets of metrics - associated with that monitored resource type. A monitored resource - and metric pair may only be used once in the Monitoring - configuration. - items: - $ref: '#/components/schemas/MonitoringDestination' - Field: - id: Field - properties: - defaultValue: + The name of the metric this quota limit applies to. The quota limits + with the same metric will be checked together during runtime. The + metric must be defined within the service config. + values: + type: object + additionalProperties: + format: int64 + type: string + description: >- + Tiered limit values. You must specify this as a key:value pair, with + an integer value that is the maximum number of requests allowed for + the specified unit. Currently only STANDARD is supported. + duration: + description: >- + Duration of this limit in textual notation. Must be "100s" or "1d". + Used by group-based quotas only. type: string + name: description: >- - The string value of the default value of this field. Proto2 syntax - only. - number: - type: integer - format: int32 - description: The field number. - options: - description: The protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array - typeUrl: + Name of the quota limit. The name must be provided, and it must be + unique within the service. The name can only include alphanumeric + characters as well as '-'. The maximum length of the limit name is + 64 characters. + type: string + unit: type: string description: >- - The field type URL, without the scheme, for message or enumeration - types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. - cardinality: - enum: - - CARDINALITY_UNKNOWN - - CARDINALITY_OPTIONAL - - CARDINALITY_REQUIRED - - CARDINALITY_REPEATED - description: The field cardinality. - type: string - enumDescriptions: - - For fields with unknown cardinality. - - For optional fields. - - For required fields. Proto2 syntax only. - - For repeated fields. - jsonName: + Specify the unit of the quota limit. It uses the same syntax as + Metric.unit. The supported unit kinds are determined by the quota + backend system. Here are some examples: * "1/min/{project}" for + quota per minute per project. Note: the order of unit components is + insignificant. The "1" at the beginning is required to follow the + metric unit syntax. + defaultLimit: + format: int64 type: string - description: The field JSON name. - packed: - description: Whether to use alternative packed wire representation. + description: >- + Default number of tokens that can be consumed during the specified + duration. This is the number of tokens assigned when a client + application developer activates the service for his/her project. + Specifying a value of 0 will block all requests. This can be used if + you are provisioning quota to selected consumers and blocking + others. Similarly, a value of -1 will indicate an unlimited quota. + No other negative values are allowed. Used by group-based quotas + only. + ClientLibrarySettings: + description: Details about how and where to publish client libraries. + id: ClientLibrarySettings + properties: + phpSettings: + description: Settings for PHP client libraries. + $ref: '#/components/schemas/PhpSettings' + restNumericEnums: + description: >- + When using transport=rest, the client request will encode enums as + numbers rather than strings. type: boolean - kind: + version: + description: >- + Version of the API to apply these settings to. This is the full + protobuf package for the API, ending in the version element. + Examples: "google.cloud.speech.v1" and + "google.spanner.admin.database.v1". type: string - description: The field type. - enumDescriptions: - - Field type unknown. - - Field type double. - - Field type float. - - Field type int64. - - Field type uint64. - - Field type int32. - - Field type fixed64. - - Field type fixed32. - - Field type bool. - - Field type string. - - Field type group. Proto2 syntax only, and deprecated. - - Field type message. - - Field type bytes. - - Field type uint32. - - Field type enum. - - Field type sfixed32. - - Field type sfixed64. - - Field type sint32. - - Field type sint64. - enum: - - TYPE_UNKNOWN - - TYPE_DOUBLE - - TYPE_FLOAT - - TYPE_INT64 - - TYPE_UINT64 - - TYPE_INT32 - - TYPE_FIXED64 - - TYPE_FIXED32 - - TYPE_BOOL - - TYPE_STRING - - TYPE_GROUP - - TYPE_MESSAGE - - TYPE_BYTES - - TYPE_UINT32 - - TYPE_ENUM - - TYPE_SFIXED32 - - TYPE_SFIXED64 - - TYPE_SINT32 - - TYPE_SINT64 - name: + goSettings: + description: Settings for Go client libraries. + $ref: '#/components/schemas/GoSettings' + nodeSettings: + description: Settings for Node client libraries. + $ref: '#/components/schemas/NodeSettings' + rubySettings: + description: Settings for Ruby client libraries. + $ref: '#/components/schemas/RubySettings' + javaSettings: + $ref: '#/components/schemas/JavaSettings' + description: Settings for legacy Java features, supported in the Service YAML. + launchStage: type: string - description: The field name. - oneofIndex: - description: >- - The index of the field type in `Type.oneofs`, for message or - enumeration types. The first type has index 1; zero means the type - is not in the list. - type: integer - format: int32 - description: A single field of a message type. - type: object - Enum: - description: Enum type definition. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + description: Launch stage of this version of the API. + dotnetSettings: + description: Settings for .NET client libraries. + $ref: '#/components/schemas/DotnetSettings' + cppSettings: + $ref: '#/components/schemas/CppSettings' + description: Settings for C++ client libraries. + pythonSettings: + $ref: '#/components/schemas/PythonSettings' + description: Settings for Python client libraries. type: object + CustomError: properties: - edition: - type: string + types: + type: array description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - type: string - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax. - name: - type: string - description: Enum type name. - enumvalue: + The list of custom error detail types, e.g. + 'google.foo.v1.CustomError'. items: - $ref: '#/components/schemas/EnumValue' + type: string + rules: type: array - description: Enum value definitions. - sourceContext: - description: The source context. - $ref: '#/components/schemas/SourceContext' - options: - description: Protocol buffer options. items: - $ref: '#/components/schemas/Option' - type: array - id: Enum - Endpoint: + $ref: '#/components/schemas/CustomErrorRule' + description: >- + The list of custom error rules that apply to individual API + messages. **NOTE:** All service configuration rules follow "last one + wins" order. description: >- - `Endpoint` describes a network address of a service that serves a set of - APIs. It is commonly known as a service endpoint. A service may expose - any number of service endpoints, and all service endpoints share the - same service definition, such as quota limits and monitoring metrics. - Example: type: google.api.Service name: library-example.googleapis.com - endpoints: # Declares network address - `https://library-example.googleapis.com` # for service - `library-example.googleapis.com`. The `https` scheme # is implicit for - all service endpoints. Other schemes may be # supported in the future. - - name: library-example.googleapis.com allow_cors: false - name: - content-staging-library-example.googleapis.com # Allows HTTP OPTIONS - calls to be passed to the API frontend, for it # to decide whether the - subsequent cross-origin request is allowed # to proceed. allow_cors: - true + Customize service error responses. For example, list any service + specific protobuf types that can appear in error detail lists of error + responses. Example: custom_error: types: - google.foo.v1.CustomError - + google.foo.v1.AnotherError + id: CustomError + type: object + GoogleApiServiceusageV2alphaConsumerPolicy: properties: - aliases: - type: array + etag: + readOnly: true description: >- - Aliases for this endpoint, these will be served by the same UrlMap - as the parent endpoint, and will be provisioned in the GCP stack for - the Regional Endpoints. - items: - type: string - allowCors: - type: boolean + Output only. An opaque tag indicating the current version of the + policy, used for concurrency control. + type: string + name: description: >- - Allowing - [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), - aka cross-domain traffic, would allow the backends served from this - endpoint to receive and respond to HTTP OPTIONS requests. The - response will be used by the browser to determine whether the - subsequent cross-origin request is allowed to proceed. - target: + Output only. The resource name of the policy. Only the `default` + policy is supported: `projects/12345/consumerPolicies/default`, + `folders/12345/consumerPolicies/default`, + `organizations/12345/consumerPolicies/default`. type: string + readOnly: true + enableRules: + type: array + items: + $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' description: >- - The specification of an Internet routable address of API frontend - that will handle requests to this [API - Endpoint](https://cloud.google.com/apis/design/glossary). It should - be either a valid IPv4 address or a fully-qualified domain name. For - example, "8.8.8.8" or "myservice.appspot.com". - name: + Enable rules define usable services, groups, and categories. There + can currently be at most one `EnableRule`. This restriction will be + lifted in later releases. + annotations: + additionalProperties: + type: string + type: object + description: >- + Optional. Annotations is an unstructured key-value map stored with a + policy that may be set by external tools to store and retrieve + arbitrary metadata. They are not queryable and should be preserved + when modifying objects. + [AIP-128](https://google.aip.dev/128#annotations) + updateTime: + readOnly: true + format: google-datetime + description: Output only. The time the policy was last updated. type: string - description: The canonical name of this endpoint. - type: object - id: Endpoint - OAuthRequirements: - id: OAuthRequirements - description: >- - OAuth scopes are a way to define data and permissions on data. For - example, there are scopes defined for "Read-only access to Google - Calendar" and "Access to Cloud Platform". Users can consent to a scope - for an application, giving it permission to access that data on their - behalf. OAuth scope specifications should be fairly coarse grained; a - user will need to see and understand the text description of what your - scope means. In most cases: use one or at most two OAuth scopes for an - entire family of products. If your product has multiple APIs, you should - probably be sharing the OAuth scope across all of those APIs. When you - need finer grained OAuth consent screens: talk with your product - management about how developers will use them in practice. Please note - that even though each of the canonical scopes is enough for a request to - be accepted and passed to the backend, a request can still fail due to - the backend requiring additional scopes or permissions. - properties: - canonicalScopes: + createTime: type: string description: >- - The list of publicly documented OAuth scopes that are allowed - access. An OAuth token containing any of these scopes will be - accepted. Example: canonical_scopes: - https://www.googleapis.com/auth/calendar, - https://www.googleapis.com/auth/calendar.read + Output only. The time the policy was created. For singleton + policies, this is the first touch of the policy. + readOnly: true + format: google-datetime + id: GoogleApiServiceusageV2alphaConsumerPolicy type: object - Publishing: + description: >- + Consumer Policy is a set of rules that define what services or service + groups can be used for a cloud resource hierarchy. + MetricDescriptorMetadata: + id: MetricDescriptorMetadata properties: - codeownerGithubTeams: + ingestDelay: + format: google-duration + type: string description: >- - GitHub teams to be added to CODEOWNERS in the directory in GitHub - containing source code for the client libraries for this API. + The delay of data points caused by ingestion. Data points older than + this age are guaranteed to be ingested and available to be read, + excluding data loss due to errors. + timeSeriesResourceHierarchyLevel: items: + enumDescriptions: + - Do not use this default value. + - Scopes a metric to a project. + - Scopes a metric to an organization. + - Scopes a metric to a folder. type: string + enum: + - TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED + - PROJECT + - ORGANIZATION + - FOLDER type: array - restReferenceDocumentationUri: - description: >- - Optional link to REST reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rest + description: The scope of the timeseries data of the metric. + samplePeriod: type: string - organization: + format: google-duration + description: >- + The sampling period of metric data points. For metrics which are + written periodically, consecutive data points are stored at this + time interval, excluding data loss due to errors. Metrics with a + higher granularity have a smaller sampling period. + launchStage: enumDescriptions: - - Not useful. - - Google Cloud Platform Org. - - Ads (Advertising) Org. - - Photos Org. - - Street View Org. - - Shopping Org. - - Geo Org. - - Generative AI - https://developers.generativeai.google - type: string - description: For whom the client library is being published. + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. enum: - - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED - - CLOUD - - ADS - - PHOTOS - - STREET_VIEW - - SHOPPING - - GEO - - GENERATIVE_AI - protoReferenceDocumentationUri: - description: >- - Optional link to proto reference documentation. Example: - https://cloud.google.com/pubsub/lite/docs/reference/rpc - type: string - newIssueUri: - description: >- - Link to a *public* URI where users can report issues. Example: - https://issuetracker.google.com/issues/new?component=190865&template=1161103 - type: string - methodSettings: - type: array - items: - $ref: '#/components/schemas/MethodSettings' - description: >- - A list of API method settings, e.g. the behavior for methods that - use the long-running operation pattern. - librarySettings: - type: array - description: >- - Client library settings. If the same version string appears multiple - times in this list, then the last one wins. Settings from earlier - settings with the same version string are discarded. - items: - $ref: '#/components/schemas/ClientLibrarySettings' - docTagPrefix: - description: >- - A prefix used in sample code when demarking regions to be included - in documentation. - type: string - documentationUri: - type: string - description: >- - Link to product home page. Example: - https://cloud.google.com/asset-inventory/docs/overview - githubLabel: - description: >- - GitHub label to apply to issues and pull requests opened for this - API. - type: string - apiShortName: - description: >- - Used as a tracking tag when collecting data about the APIs developer - relations artifacts like docs, packages delivered to package - managers, etc. Example: "speech". + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED type: string - id: Publishing - type: object - description: >- - This message configures the settings for publishing [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from the service config. - NodeSettings: + deprecated: true + description: Deprecated. Must use the MetricDescriptor.launch_stage instead. type: object - id: NodeSettings - description: Settings for Node client libraries. - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - DeleteAdminQuotaPolicyMetadata: - properties: {} - description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by DeleteAdminQuotaPolicy. + description: Additional annotations that can be used to guide the usage of a metric. + GoogleApiServiceusageV1beta1GetServiceIdentityResponse: type: object - id: DeleteAdminQuotaPolicyMetadata - GetServiceIdentityResponse: - id: GetServiceIdentityResponse - description: Response message for getting service identity. properties: state: + type: string + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE + description: Service identity state. enumDescriptions: - >- Default service identity state. This value is used if the state is omitted. - Service identity has been created and can be used. - type: string - description: Service identity state. - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE identity: - $ref: '#/components/schemas/ServiceIdentity' description: >- Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id. - type: object - QuotaLimit: - id: QuotaLimit + $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' + description: Response message for getting service identity. + id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse + ImportConsumerOverridesMetadata: + id: ImportConsumerOverridesMetadata description: >- - `QuotaLimit` defines a specific limit that applies over a specified - duration for a limit type. There can be at most one limit for a duration - and limit type combination defined within a `QuotaGroup`. - properties: - displayName: - type: string - description: >- - User-visible display name for this limit. Optional. If not set, the - UI will provide a default display name based on the quota - configuration. This field can be used to override the default - display name generated from the configuration. - defaultLimit: - format: int64 - description: >- - Default number of tokens that can be consumed during the specified - duration. This is the number of tokens assigned when a client - application developer activates the service for his/her project. - Specifying a value of 0 will block all requests. This can be used if - you are provisioning quota to selected consumers and blocking - others. Similarly, a value of -1 will indicate an unlimited quota. - No other negative values are allowed. Used by group-based quotas - only. - type: string - maxLimit: - type: string - description: >- - Maximum number of tokens that can be consumed during the specified - duration. Client application developers can override the default - limit up to this maximum. If specified, this value cannot be set to - a value less than the default limit. If not specified, it is set to - the default limit. To allow clients to apply overrides with no upper - bound, set this to -1, indicating unlimited maximum quota. Used by - group-based quotas only. - format: int64 - freeTier: - description: >- - Free tier value displayed in the Developers Console for this limit. - The free tier is the number of tokens that will be subtracted from - the billed amount when billing is enabled. This field can only be - set on a limit with duration "1d", in a billable group; it is - invalid on any other limit. If this field is not set, it defaults to - 0, indicating that there is no free tier for this service. Used by - group-based quotas only. - format: int64 - type: string - values: - additionalProperties: - type: string - format: int64 - description: >- - Tiered limit values. You must specify this as a key:value pair, with - an integer value that is the maximum number of requests allowed for - the specified unit. Currently only STANDARD is supported. - type: object - name: - description: >- - Name of the quota limit. The name must be provided, and it must be - unique within the service. The name can only include alphanumeric - characters as well as '-'. The maximum length of the limit name is - 64 characters. - type: string - duration: - type: string - description: >- - Duration of this limit in textual notation. Must be "100s" or "1d". - Used by group-based quotas only. - unit: - description: >- - Specify the unit of the quota limit. It uses the same syntax as - Metric.unit. The supported unit kinds are determined by the quota - backend system. Here are some examples: * "1/min/{project}" for - quota per minute per project. Note: the order of unit components is - insignificant. The "1" at the beginning is required to follow the - metric unit syntax. - type: string - metric: - type: string - description: >- - The name of the metric this quota limit applies to. The quota limits - with the same metric will be checked together during runtime. The - metric must be defined within the service config. - description: - description: >- - Optional. User-visible, extended description for this quota limit. - Should be used only when more context is needed to understand this - limit than provided by the limit's display name (see: - `display_name`). - type: string - type: object - GoogleApiServiceusageV1ServiceConfig: - id: GoogleApiServiceusageV1ServiceConfig + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportConsumerOverrides. type: object - description: The configuration of the service. + properties: {} + Authentication: properties: - endpoints: - items: - $ref: '#/components/schemas/Endpoint' - type: array - description: >- - Configuration for network endpoints. Contains only the names and - aliases of the endpoints. - quota: - description: Quota configuration. - $ref: '#/components/schemas/Quota' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - title: - type: string - description: The product title for this service. - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. Contains only the OAuth rules. - monitoring: - $ref: '#/components/schemas/Monitoring' - description: >- - Monitoring configuration. This should not include the - 'producer_destinations' field. - name: + rules: description: >- - The DNS address at which this service is available. An example DNS - address would be: `calendar.googleapis.com`. - type: string - apis: + A list of authentication rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. type: array items: - $ref: '#/components/schemas/Api' - description: >- - A list of API interfaces exported by this service. Contains only the - names, versions, and method names of the interfaces. - documentation: - $ref: '#/components/schemas/Documentation' - description: >- - Additional API documentation. Contains only the summary and the - documentation URL. - monitoredResources: - description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. + $ref: '#/components/schemas/AuthenticationRule' + providers: + description: Defines a set of authentication providers that a service supports. type: array items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - UpdateAdminQuotaPolicyMetadata: + $ref: '#/components/schemas/AuthProvider' type: object - properties: {} - id: UpdateAdminQuotaPolicyMetadata description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by UpdateAdminQuotaPolicy. - Method: - id: Method + `Authentication` defines the authentication configuration for API + methods provided by an API service. Example: name: + calendar.googleapis.com authentication: providers: - id: + google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth - selector: google.calendar.Delegate + oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read + id: Authentication + GetServiceIdentityResponse: + id: GetServiceIdentityResponse type: object - description: Method represents a method of an API interface. properties: - requestStreaming: - description: If true, the request is streamed. - type: boolean - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - description: The source syntax of this method. - type: string + state: enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - responseTypeUrl: - type: string - description: The URL of the output message type. - options: - description: Any metadata attached to the method. - type: array - items: - $ref: '#/components/schemas/Option' - requestTypeUrl: - description: A URL of the input message type. - type: string - responseStreaming: - type: boolean - description: If true, the response is streamed. - name: - type: string - description: The simple name of this method. - GetServiceIdentityMetadata: - id: GetServiceIdentityMetadata - description: Metadata for the `GetServiceIdentity` method. - properties: {} - type: object - Control: - properties: - environment: + - >- + Default service identity state. This value is used if the state is + omitted. + - Service identity has been created and can be used. + description: Service identity state. + enum: + - IDENTITY_STATE_UNSPECIFIED + - ACTIVE type: string + identity: + $ref: '#/components/schemas/ServiceIdentity' description: >- - The service controller environment to use. If empty, no control - plane feature (like quota and billing) will be enabled. The - recommended value for most services is servicecontrol.googleapis.com - methodPolicies: - description: Defines policies applying to the API methods of the service. - items: - $ref: '#/components/schemas/MethodPolicy' - type: array - id: Control - type: object + Service identity that service producer can use to access consumer + resources. If exists is true, it contains email and unique_id. If + exists is false, it contains pre-constructed email and empty + unique_id. + description: Response message for getting service identity. + ImportAdminQuotaPoliciesMetadata: + properties: {} description: >- - Selects and configures the service controller used by the service. - Example: control: environment: servicecontrol.googleapis.com - UpdateConsumerPolicyMetadata: + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by ImportAdminQuotaPolicies. type: object - id: UpdateConsumerPolicyMetadata - properties: {} - description: Metadata for the `UpdateConsumerPolicy` method. - ImportConsumerOverridesMetadata: - id: ImportConsumerOverridesMetadata + id: ImportAdminQuotaPoliciesMetadata + CreateAdminQuotaPolicyMetadata: properties: {} type: object + id: CreateAdminQuotaPolicyMetadata description: >- Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO - returned by ImportConsumerOverrides. - ImportAdminQuotaPoliciesResponse: + returned by CreateAdminQuotaPolicy. + PythonSettings: + description: Settings for Python client libraries. properties: - policies: - description: The policies that were created from the imported data. - items: - $ref: '#/components/schemas/AdminQuotaPolicy' - type: array - id: ImportAdminQuotaPoliciesResponse + common: + $ref: '#/components/schemas/CommonLanguageSettings' + description: Some settings. + experimentalFeatures: + description: >- + Experimental features to be included during client library + generation. + $ref: '#/components/schemas/ExperimentalFeatures' type: object - description: Response message for ImportAdminQuotaPolicies - MetricRule: - id: MetricRule + id: PythonSettings + AnalyzeConsumerPolicyResponse: + description: The response of analyzing a consumer policy update. + type: object + id: AnalyzeConsumerPolicyResponse properties: - metricCosts: - description: >- - Metrics to update when the selected methods are called, and the - associated cost applied to each metric. The key of the map is the - metric name, and the values are the amount increased for the metric - against which the quota limits are defined. The value must not be - negative. - additionalProperties: - format: int64 - type: string - type: object - selector: + analysis: description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - description: >- - Bind API methods to metrics. Binding a method to a metric causes that - metric's configured quota behaviors to apply to the method call. + The list of analyses returned from performing the intended policy + update analysis. The analysis is grouped by service name and + different analysis types. The empty analysis list means that the + consumer policy can be updated without any warnings or blockers. + items: + $ref: '#/components/schemas/Analysis' + type: array + UpdateAdminQuotaPolicyMetadata: type: object + id: UpdateAdminQuotaPolicyMetadata + properties: {} + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by UpdateAdminQuotaPolicy. DisableServiceResponse: - properties: - service: - description: The new state of the service after disabling. - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + type: object description: >- Response message for the `DisableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. - type: object id: DisableServiceResponse - AddEnableRulesResponse: - type: object - description: The response message of `AddEnableRules` method. - id: AddEnableRulesResponse properties: - parent: - description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. - type: string - addedValues: - description: The values added to the parent consumer policy. + service: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + description: The new state of the service after disabling. + ImportAdminOverridesResponse: + description: Response message for ImportAdminOverrides + id: ImportAdminOverridesResponse + properties: + overrides: + description: The overrides that were created from the imported data. type: array items: - type: string - MonitoredResourceDescriptor: + $ref: '#/components/schemas/QuotaOverride' + type: object + MethodSettings: + type: object + description: Describes the generator configuration for a method. + id: MethodSettings properties: - description: + autoPopulatedFields: + items: + type: string + type: array + description: >- + List of top-level fields of the request message, that should be + automatically populated by the client libraries based on their + (google.api.field_info).format. Currently supported format: UUID4. + Example of a YAML configuration: publishing: method_settings: - + selector: google.example.v1.ExampleService.CreateExample + auto_populated_fields: - request_id + selector: type: string description: >- - Optional. A detailed description of the monitored resource type that - might be used in documentation. - displayName: + The fully qualified name of the method, for which the options below + apply. This is used to find the method to apply the options. + Example: publishing: method_settings: - selector: + google.storage.control.v2.StorageControl.CreateFolder # method + settings for CreateFolder... + longRunning: + $ref: '#/components/schemas/LongRunning' description: >- - Optional. A concise name for the monitored resource type that might - be displayed in user interfaces. It should be a Title Cased Noun - Phrase, without any article or other determiners. For example, - `"Google Cloud SQL Database"`. + Describes settings to use for long-running operations when + generating API methods for RPCs. Complements RPCs that use the + annotations in google/longrunning/operations.proto. Example of a + YAML configuration:: publishing: method_settings: - selector: + google.cloud.speech.v2.Speech.BatchRecognize long_running: + initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 + max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 + minutes + EnableServiceRequest: + properties: {} + description: Request message for the `EnableService` method. + type: object + id: EnableServiceRequest + AdminQuotaPolicy: + type: object + description: Quota policy created by quota administrator. + properties: + policyValue: + format: int64 + description: >- + The quota policy value. Can be any nonnegative integer, or -1 + (unlimited quota). type: string - labels: - type: array - items: - $ref: '#/components/schemas/LabelDescriptor' + unit: description: >- - Required. A set of labels used to describe instances of this - monitored resource type. For example, an individual Google Cloud SQL - database is identified by values for the labels `"database_id"` and - `"zone"`. - launchStage: - description: Optional. The launch stage of the monitored resource definition. + The limit unit of the limit to which this policy applies. An example + unit would be: `1/{project}/{region}` Note that `{project}` and + `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. type: string - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: + name: + description: >- + The resource name of the policy. This name is generated by the + server when the policy is created. Example names would be: + `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` + type: string + container: type: string description: >- - Required. The monitored resource type. For example, the type - `"cloudsql_database"` represents databases in Google Cloud SQL. For - a list of types, see [Monitored resource - types](https://cloud.google.com/monitoring/api/resources) and - [Logging resource - types](https://cloud.google.com/logging/docs/api/v2/resource-list). - name: + The cloud resource container at which the quota policy is created. + The format is `{container_type}/{container_number}` + dimensions: + type: object + additionalProperties: + type: string + description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' + metric: type: string description: >- - Optional. The resource name of the monitored resource descriptor: - `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where - {type} is the value of the `type` field in this object and - {project_id} is a project ID that provides API-specific context for - accessing the type. APIs that do not use project information can use - the resource name format `"monitoredResourceDescriptors/{type}"`. - id: MonitoredResourceDescriptor + The name of the metric to which this policy applies. An example name + would be: `compute.googleapis.com/cpus` + id: AdminQuotaPolicy + GoogleApiServiceusageV1beta1ServiceIdentity: description: >- - An object that describes the schema of a MonitoredResource object using - a type name and a set of labels. For example, the monitored resource - descriptor for Google Compute Engine VM instances has a type of - `"gce_instance"` and specifies the use of the labels `"instance_id"` and - `"zone"` to identify particular VM instances. Different APIs can support - different monitored resource types. APIs generally provide a `list` - method that returns the monitored resource descriptors used by the API. - type: object - RemoveEnableRulesResponse: + Service identity for a service. This is the identity that service + producer should use to access consumer resources. properties: - removedValues: - description: The values removed from the parent consumer policy. - deprecated: true - items: - type: string - type: array - parent: + email: type: string description: >- - The parent consumer policy. It can be - `projects/12345/consumerPolicies/default`, or - `folders/12345/consumerPolicies/default`, or - `organizations/12345/consumerPolicies/default`. + The email address of the service account that a service producer + would use to access consumer resources. + uniqueId: + description: >- + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + type: string type: object - description: The response message of `RemoveEnableRules` method. - id: RemoveEnableRulesResponse - JavaSettings: - id: JavaSettings + id: GoogleApiServiceusageV1beta1ServiceIdentity + RemoveEnableRulesMetadata: type: object - description: Settings for Java client libraries. + description: Metadata for the `RemoveEnableRules` method. + id: RemoveEnableRulesMetadata + properties: {} + LabelDescriptor: properties: - serviceClassNames: - additionalProperties: - type: string - type: object - description: >- - Configure the Java class name to use instead of the service's for - its corresponding generated GAPIC client. Keys are fully-qualified - service names as they appear in the protobuf (including the full the - language_settings.java.interface_names" field in gapic.yaml. API - teams should otherwise use the service name as it appears in the - protobuf. Example of a YAML configuration:: publishing: - java_settings: service_class_names: - google.pubsub.v1.Publisher: - TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin - libraryPackage: - description: >- - The package name to use in Java. Clobbers the java_package option - set in the protobuf. This should be used **only** by APIs who have - already set the language_settings.java.package_name" field in - gapic.yaml. API teams should use the protobuf java_package option - where possible. Example of a YAML configuration:: publishing: - java_settings: library_package: com.google.cloud.pubsub.v1 + valueType: + enum: + - STRING + - BOOL + - INT64 type: string - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - EnumValue: - properties: - number: - format: int32 - type: integer - description: Enum value number. - options: - description: Protocol buffer options. - items: - $ref: '#/components/schemas/Option' - type: array - name: + description: The type of data that can be assigned to the label. + enumDescriptions: + - A variable-length string. This is the default. + - Boolean; true or false. + - A 64-bit signed integer. + key: + description: The label key. type: string - description: Enum value name. - id: EnumValue + description: + type: string + description: A human-readable description for the label. + description: A description of a label. type: object - description: Enum value definition. - DotnetSettings: + id: LabelDescriptor + MetricRule: + id: MetricRule type: object - id: DotnetSettings - description: Settings for Dotnet client libraries. + description: >- + Bind API methods to metrics. Binding a method to a metric causes that + metric's configured quota behaviors to apply to the method call. properties: - renamedServices: + selector: description: >- - Map from original service names to renamed versions. This is used - when the default generated types would cause a naming conflict. - (Neither name is fully-qualified.) Example: Subscriber to - SubscriberServiceApi. - additionalProperties: - type: string - type: object - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - renamedResources: + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: string + metricCosts: additionalProperties: - type: string - type: object - description: >- - Map from full resource types to the effective short name for the - resource. This is used when otherwise resource named from different - services would cause naming collisions. Example entry: - "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - forcedNamespaceAliases: - items: + format: int64 type: string description: >- - Namespaces which must be aliased in snippets due to a known (but - non-generator-predictable) naming collision - type: array - ignoredResources: + Metrics to update when the selected methods are called, and the + associated cost applied to each metric. The key of the map is the + metric name, and the values are the amount increased for the metric + against which the quota limits are defined. The value must not be + negative. + type: object + SystemParameters: + type: object + properties: + rules: description: >- - List of full resource types to ignore during generation. This is - typically used for API-specific Location resources, which should be - handled by the generator as if they were actually the common - Location resources. Example entry: - "documentai.googleapis.com/Location" - items: - type: string + Define system parameters. The parameters defined here will override + the default parameters implemented by the system. If this field is + missing from the service config, default system parameters will be + used. Default system parameters and names is + implementation-dependent. Example: define api key for all methods + system_parameters rules: - selector: "*" parameters: - name: api_key + url_query_parameter: api_key Example: define 2 api key names for a + specific method. system_parameters rules: - selector: "/ListShelves" + parameters: - name: api_key http_header: Api-Key1 - name: api_key + http_header: Api-Key2 **NOTE:** All service configuration rules + follow "last one wins" order. type: array - handwrittenSignatures: - description: >- - Method signatures (in the form "service.method(signature)") which - are provided separately, so shouldn't be generated. Snippets - *calling* these methods are still generated, however. items: - type: string - type: array - BatchCreateConsumerOverridesResponse: - description: Response message for BatchCreateConsumerOverrides + $ref: '#/components/schemas/SystemParameterRule' + id: SystemParameters + description: >- + ### System parameter configuration A system parameter is a special kind + of parameter defined by the API system, not by an individual API. It is + typically mapped to an HTTP header and/or a URL query parameter. This + configuration specifies which methods change the names of the system + parameters. + Method: + description: Method represents a method of an API interface. + id: Method type: object properties: - overrides: + requestStreaming: + type: boolean + description: If true, the request is streamed. + responseTypeUrl: + type: string + description: The URL of the output message type. + responseStreaming: + type: boolean + description: If true, the response is streamed. + requestTypeUrl: + type: string + description: A URL of the input message type. + options: type: array items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created. - id: BatchCreateConsumerOverridesResponse - Operation: - type: object - properties: - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + $ref: '#/components/schemas/Option' + description: Any metadata attached to the method. + syntax: + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax of this method. + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + type: string name: type: string - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - error: - $ref: '#/components/schemas/Status' - description: >- - The error result of the operation in case of failure or - cancellation. - metadata: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - description: >- - This resource represents a long-running operation that is the result of - a network API call. - id: Operation - GoogleApiServiceusageV2alphaEnableRule: - description: >- - The consumer policy rule that defines enabled services, groups, and - categories. - id: GoogleApiServiceusageV2alphaEnableRule + description: The simple name of this method. + Mixin: type: object + id: Mixin properties: - services: - type: array + name: + description: The fully qualified name of the interface which is included. + type: string + root: description: >- - The names of the services that are enabled. Example: - `services/storage.googleapis.com`. - items: - type: string - AuthenticationRule: + If non-empty specifies a path under which inherited HTTP paths are + rooted. + type: string description: >- - Authentication rules for the service. By default, if a method has any - authentication requirements, every request must include a valid - credential matching one of the requirements. It's an error to include - more than one kind of credential in a single request. If a method - doesn't have any auth requirements, request credentials will be ignored. - id: AuthenticationRule - type: object - properties: - requirements: - description: Requirements for additional authentication providers. - type: array - items: - $ref: '#/components/schemas/AuthRequirement' - oauth: - $ref: '#/components/schemas/OAuthRequirements' - description: The requirements for OAuth credentials. - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - allowWithoutCredential: - description: >- - If true, the service accepts API keys without any other credential. - This flag only applies to HTTP and gRPC requests. - type: boolean - CommonLanguageSettings: - id: CommonLanguageSettings - description: Required information for every language. + Declares an API Interface to be included in this interface. The + including interface must redeclare all the methods from the included + interface, but documentation and options are inherited as follows: - If + after comment and whitespace stripping, the documentation string of the + redeclared method is empty, it will be inherited from the original + method. - Each annotation belonging to the service config (http, + visibility) which is not set in the redeclared method will be inherited. + - If an http annotation is inherited, the path pattern will be modified + as follows. Any version prefix will be replaced by the version of the + including interface plus the root path if specified. Example of a simple + mixin: package google.acl.v1; service AccessControl { // Get the + underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package + google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) + returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns + (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example + of a mixin configuration: apis: - name: google.storage.v2.Storage + mixins: - name: google.acl.v1.AccessControl The mixin construct implies + that all methods in `AccessControl` are also declared with same name and + request/response types in `Storage`. A documentation generator or + annotation processor will see the effective `Storage.GetAcl` method + after inherting documentation and annotations as follows: service + Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) + returns (Acl) { option (google.api.http).get = + "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path + pattern changed from `v1` to `v2`. If the `root` field in the mixin is + specified, it should be a relative path under which inherited HTTP paths + are placed. Example: apis: - name: google.storage.v2.Storage mixins: - + name: google.acl.v1.AccessControl root: acls This implies the following + inherited HTTP annotation: service Storage { // Get the underlying ACL + object. rpc GetAcl(GetAclRequest) returns (Acl) { option + (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: + description: Metadata for the `UpdateConsumerPolicy` method. type: object + id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata + properties: {} + GoogleApiServiceusageV1Service: properties: - destinations: - description: >- - The destination where API teams want this client library to be - published. - items: - enum: - - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED - - GITHUB - - PACKAGE_MANAGER - enumDescriptions: - - >- - Client libraries will neither be generated nor published to - package managers. - - >- - Generate the client library in a repo under - github.com/googleapis, but don't publish it to package managers. - - >- - Publish the library to package managers like nuget.org and - npmjs.com. - type: string - type: array - referenceDocsUri: + parent: description: >- - Link to automatically generated reference documentation. Example: - https://cloud.google.com/nodejs/docs/reference/asset/latest - deprecated: true + The resource name of the consumer. A valid name would be: - + projects/123 type: string - EnableFailure: - type: object - id: EnableFailure - properties: - errorMessage: - description: An error message describing why the service could not be enabled. + state: + enumDescriptions: + - >- + The default value, which indicates that the enabled state of the + service is unspecified or not meaningful. Currently, all consumers + other than projects (such as folders and organizations) are always + in this state. + - >- + The service cannot be used by this consumer. It has either been + explicitly disabled, or has never been enabled. + - The service has been explicitly enabled for use by this consumer. type: string - serviceId: - description: The service id of a service that could not be enabled. + enum: + - STATE_UNSPECIFIED + - DISABLED + - ENABLED + description: Whether or not the service has been enabled for use by the consumer. + name: type: string - description: Provides error messages for the failing services. - ListOperationsResponse: + description: >- + The resource name of the consumer and service. A valid name would + be: - projects/123/services/serviceusage.googleapis.com + config: + description: >- + The service configuration of the available service. Some fields may + be filtered out of the configuration in responses to the + `ListServices` method. These fields are present only in responses to + the `GetService` method. + $ref: '#/components/schemas/GoogleApiServiceusageV1ServiceConfig' type: object + id: GoogleApiServiceusageV1Service + description: A service that is available for use by the consumer. + PhpSettings: properties: - nextPageToken: - type: string - description: The standard List next-page token. - operations: - type: array - items: - $ref: '#/components/schemas/Operation' - description: >- - A list of operations that matches the specified filter in the - request. - id: ListOperationsResponse - description: The response message for Operations.ListOperations. - LabelDescriptor: - description: A description of a label. + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + id: PhpSettings + description: Settings for Php client libraries. + type: object + Enum: + id: Enum type: object - id: LabelDescriptor properties: - key: - description: The label key. - type: string - valueType: - enumDescriptions: - - A variable-length string. This is the default. - - Boolean; true or false. - - A 64-bit signed integer. - enum: - - STRING - - BOOL - - INT64 + enumvalue: + items: + $ref: '#/components/schemas/EnumValue' + description: Enum value definitions. + type: array + sourceContext: + description: The source context. + $ref: '#/components/schemas/SourceContext' + name: type: string - description: The type of data that can be assigned to the label. - description: + description: Enum type name. + edition: type: string - description: A human-readable description for the label. - Page: - properties: - subpages: description: >- - Subpages of this page. The order of subpages specified here will be - honored in the generated docset. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + options: type: array items: - $ref: '#/components/schemas/Page' - name: - description: >- - The name of the page. It will be used as an identity of the page to - generate URI of the page, text of the link to this page in - navigation, etc. The full page name (start from the root page name - to this page concatenated with `.`) can be used as reference to the - page in your documentation. For example: pages: - name: Tutorial - content: (== include tutorial.md ==) subpages: - name: Java content: - (== include tutorial_java.md ==) You can reference `Java` page using - Markdown reference link syntax: `Java`. - type: string - content: - description: >- - The Markdown content of the page. You can use (== include {path} ==) - to include content from a Markdown file. The content can be used to - produce the documentation page such as HTML format page. + $ref: '#/components/schemas/Option' + description: Protocol buffer options. + syntax: type: string - type: object + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + description: The source syntax. + description: Enum type definition. + MonitoringDestination: + id: MonitoringDestination description: >- - Represents a documentation page. A page can contain subpages to - represent nested documentation set structure. - id: Page - Usage: - description: Configuration controlling usage of a service. - id: Usage + Configuration of a specific monitoring destination (the producer project + or the consumer project). properties: - rules: - items: - $ref: '#/components/schemas/UsageRule' - description: >- - A list of usage rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - producerNotificationChannel: + monitoredResource: description: >- - The full resource name of a channel used for sending notifications - to the service producer. Google Service Management currently only - supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as - a notification channel. To use Google Cloud Pub/Sub as the channel, - this must be the name of a Cloud Pub/Sub topic that uses the Cloud - Pub/Sub topic name format documented in - https://cloud.google.com/pubsub/docs/overview. + The monitored resource type. The type must be defined in + Service.monitored_resources section. type: string - requirements: + metrics: description: >- - Requirements that must be satisfied before a consumer project can - use the service. Each requirement is of the form /; for example - 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a - Terms of Service requirement must be included here. Google Cloud - APIs must include "serviceusage.googleapis.com/tos/cloud". Other - Google APIs should include - "serviceusage.googleapis.com/tos/universal". Additional ToS can be - included based on the business needs. - type: array + Types of the metrics to report to this monitoring destination. Each + type must be defined in Service.metrics section. items: type: string + type: array type: object - Api: - description: >- - Api is a light-weight descriptor for an API Interface. Interfaces are - also described as "protocol buffer services" in some contexts, such as - by the "service" keyword in a .proto file, but they are different from - API Services, which represent a concrete implementation of an interface - as opposed to simply a description of methods and bindings. They are - also sometimes simply referred to as "APIs" in other contexts, such as - the name of this message itself. See - https://cloud.google.com/apis/design/glossary for detailed terminology. + MethodPolicy: + id: MethodPolicy type: object - id: Api properties: - version: - type: string - description: >- - A version string for this interface. If specified, must have the - form `major-version.minor-version`, as in `1.10`. If the minor - version is omitted, it defaults to zero. If the entire version field - is empty, the major version is derived from the package name, as - outlined below. If the field is not empty, the version in the - package name will be verified to be consistent with what is provided - here. The versioning schema uses [semantic - versioning](http://semver.org) where the major version number - indicates a breaking change and the minor version an additive, - non-breaking change. Both version numbers are signals to users what - to expect from different versions, and should be carefully chosen - based on the product plan. The major version is also reflected in - the package name of the interface, which must end in `v`, as in - `google.feature.v1`. For major versions 0 and 1, the suffix can be - omitted. Zero major versions must only be used for experimental, - non-GA interfaces. - mixins: - description: Included interfaces. See Mixin. - items: - $ref: '#/components/schemas/Mixin' - type: array - name: - type: string - description: >- - The fully qualified name of this interface, including package name - followed by the interface's simple name. - options: - items: - $ref: '#/components/schemas/Option' + requestPolicies: type: array - description: Any metadata attached to the interface. - methods: items: - $ref: '#/components/schemas/Method' - type: array - description: The methods of this interface, in unspecified order. - syntax: - type: string - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - description: The source syntax of the service. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: >- - Source context for the protocol buffer service represented by this - message. - MetricDescriptorMetadata: - description: Additional annotations that can be used to guide the usage of a metric. - id: MetricDescriptorMetadata - type: object - properties: - samplePeriod: - description: >- - The sampling period of metric data points. For metrics which are - written periodically, consecutive data points are stored at this - time interval, excluding data loss due to errors. Metrics with a - higher granularity have a smaller sampling period. - type: string - format: google-duration - ingestDelay: - format: google-duration - type: string + $ref: '#/components/schemas/FieldPolicy' + description: Policies that are applicable to the request message. + selector: description: >- - The delay of data points caused by ingestion. Data points older than - this age are guaranteed to be ingested and available to be read, - excluding data loss due to errors. - launchStage: - type: string - deprecated: true - description: Deprecated. Must use the MetricDescriptor.launch_stage instead. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - EnableServiceResponse: - description: >- - Response message for the `EnableService` method. This response message - is assigned to the `response` field of the returned Operation when that - operation is done. - id: EnableServiceResponse - properties: - service: - description: The new state of the service after enabling. - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - type: object - DisableServiceRequest: - type: object - description: Request message for the `DisableService` method. - properties: - checkIfServiceHasUsage: + Selects a method to which these policies should be enforced, for + example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to + selector for syntax details. NOTE: This field must not be set in the + proto annotation. It will be automatically filled by the service + config compiler . type: string - enum: - - CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED - - SKIP - - CHECK - enumDescriptions: - - When unset, the default behavior is used, which is SKIP. - - If set, skip checking service usage when disabling a service. - - >- - If set, service usage is checked when disabling the service. If a - service, or its dependents, has usage in the last 30 days, the - request returns a FAILED_PRECONDITION error. - description: >- - Defines the behavior for checking service usage when disabling a - service. - disableDependentServices: - description: >- - Indicates if services that are enabled and which depend on this - service should also be disabled. If not set, an error will be - generated if any enabled services depend on the service to be - disabled. When set, the service, and any enabled services that - depend on it, will be disabled together. - type: boolean - id: DisableServiceRequest + description: Defines policies applying to an RPC method. ConsumerPolicy: - id: ConsumerPolicy description: >- Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy. + id: ConsumerPolicy + type: object properties: enableRules: - type: array description: Enable rules define usable services and service groups. items: $ref: '#/components/schemas/EnableRule' + type: array name: readOnly: true type: string @@ -1492,574 +966,399 @@ components: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. + updateTime: + format: google-datetime + type: string + description: The last-modified time. annotations: - type: object description: >- Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) + type: object additionalProperties: type: string - updateTime: - type: string - format: google-datetime - description: The last-modified time. etag: description: >- An opaque tag indicating the current version of the policy, used for concurrency control. type: string + Api: type: object - FieldPolicy: - id: FieldPolicy properties: - resourcePermission: + methods: + description: The methods of this interface, in unspecified order. + type: array + items: + $ref: '#/components/schemas/Method' + name: type: string description: >- - Specifies the required permission(s) for the resource referred to by - the field. It requires the field contains a valid resource - reference, and the request must pass the permission checks to - proceed. For example, "resourcemanager.projects.get". - resourceType: - description: >- - Specifies the resource type for the resource referred to by the - field. + The fully qualified name of this interface, including package name + followed by the interface's simple name. + syntax: + description: The source syntax of the service. + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. type: string - selector: + version: type: string description: >- - Selects one or more request or response message fields to apply this - `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the - selector must be left as empty. The service config generator will - automatically fill the correct value. When a `FieldPolicy` is used - in service config, the selector must be a comma-separated string - with valid request or response field paths, such as "foo.bar" or - "foo.bar,foo.baz". - type: object - description: >- - Google API Policy Annotation This message defines a simple API policy - annotation that can be used to annotate API request and response message - fields with applicable policies. One field may have multiple applicable - policies that must all be satisfied before a request can be processed. - This policy annotation is used to generate the overall policy that will - be used for automatic runtime policy enforcement and documentation - generation. - GoogleApiServiceusageV1OperationMetadata: - properties: - resourceNames: - type: array - items: - type: string - description: >- - The full name of the resources that this operation is directly - associated with. - type: object - id: GoogleApiServiceusageV1OperationMetadata - description: The operation metadata returned for the batchend services operation. - CreateAdminQuotaPolicyMetadata: - type: object - id: CreateAdminQuotaPolicyMetadata + A version string for this interface. If specified, must have the + form `major-version.minor-version`, as in `1.10`. If the minor + version is omitted, it defaults to zero. If the entire version field + is empty, the major version is derived from the package name, as + outlined below. If the field is not empty, the version in the + package name will be verified to be consistent with what is provided + here. The versioning schema uses [semantic + versioning](http://semver.org) where the major version number + indicates a breaking change and the minor version an additive, + non-breaking change. Both version numbers are signals to users what + to expect from different versions, and should be carefully chosen + based on the product plan. The major version is also reflected in + the package name of the interface, which must end in `v`, as in + `google.feature.v1`. For major versions 0 and 1, the suffix can be + omitted. Zero major versions must only be used for experimental, + non-GA interfaces. + options: + type: array + description: Any metadata attached to the interface. + items: + $ref: '#/components/schemas/Option' + mixins: + type: array + description: Included interfaces. See Mixin. + items: + $ref: '#/components/schemas/Mixin' + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: >- + Source context for the protocol buffer service represented by this + message. description: >- - Metadata message that provides information such as progress, partial - failures, and similar information on each GetOperation call of LRO - returned by CreateAdminQuotaPolicy. - properties: {} - Documentation: + Api is a light-weight descriptor for an API Interface. Interfaces are + also described as "protocol buffer services" in some contexts, such as + by the "service" keyword in a .proto file, but they are different from + API Services, which represent a concrete implementation of an interface + as opposed to simply a description of methods and bindings. They are + also sometimes simply referred to as "APIs" in other contexts, such as + the name of this message itself. See + https://cloud.google.com/apis/design/glossary for detailed terminology. + id: Api + AuthRequirement: type: object - id: Documentation + id: AuthRequirement description: >- - `Documentation` provides the information for describing a service. - Example: documentation: summary: > The Google Calendar API gives access - to most calendar features. pages: - name: Overview content: (== include - google/foo/overview.md ==) - name: Tutorial content: (== include - google/foo/tutorial.md ==) subpages: - name: Java content: (== include - google/foo/tutorial_java.md ==) rules: - selector: - google.calendar.Calendar.Get description: > ... - selector: - google.calendar.Calendar.Put description: > ... Documentation is - provided in markdown syntax. In addition to standard markdown features, - definition lists, tables and fenced code blocks are supported. Section - headers can be provided and are interpreted relative to the section - nesting of the context where a documentation fragment is embedded. - Documentation from the IDL is merged with documentation defined via the - config at normalization time, where documentation provided by config - rules overrides IDL provided. A number of constructs specific to the API - platform are supported in documentation text. In order to reference a - proto element, the following notation can be used: - [fully.qualified.proto.name][] To override the display text used for the - link, this can be used: [display text][fully.qualified.proto.name] Text - can be excluded from doc using the following notation: (-- internal - comment --) A few directives are available in documentation. Note that - directives must appear on a single line to be properly identified. The - `include` directive includes a markdown file from an external source: - (== include path/to/file ==) The `resource_for` directive marks a - message to be the resource of a collection in REST view. If it is not - specified, tools attempt to infer the resource from the operations in a - collection: (== resource_for v1.shelves.books ==) The directive - `suppress_warning` does not directly affect documentation and is - documented together with service config validation. + User-defined authentication requirements, including support for [JSON + Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). properties: - rules: - items: - $ref: '#/components/schemas/DocumentationRule' - description: >- - A list of documentation rules that apply to individual API elements. - **NOTE:** All service configuration rules follow "last one wins" - order. - type: array - summary: + audiences: type: string description: >- - A short description of what the service does. The summary must be - plain text. It becomes the overview of the service displayed in - Google Cloud Console. NOTE: This field is equivalent to the standard - field `description`. - pages: - type: array - items: - $ref: '#/components/schemas/Page' - description: The top level pages for the documentation set. - documentationRootUrl: - description: The URL to the root of documentation. - type: string - overview: + NOTE: This will be deprecated soon, once AuthProvider.audiences is + implemented and accepted in all the runtime components. The list of + JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, only JWTs with + audience "https://Service_name/API_name" will be accepted. For + example, if no audiences are in the setting, LibraryService API will + only accept JWTs with the following audience + "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + Example: audiences: bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + providerId: type: string description: >- - Declares a single overview page. For example: documentation: - summary: ... overview: (== include overview.md ==) This is a - shortcut for the following declaration (using pages style): - documentation: summary: ... pages: - name: Overview content: (== - include overview.md ==) Note: you cannot specify both `overview` - field and `pages` field. - serviceRootUrl: + id from authentication provider. Example: provider_id: + bookstore_auth + AuthenticationRule: + type: object + properties: + selector: description: >- - Specifies the service root url if the default one (the service name - from the yaml file) is not suitable. This can be seen in any fully - specified service urls as well as sections that show a base that - other urls are relative to. + Selects the methods to which this rule applies. Refer to selector + for syntax details. type: string - sectionOverrides: - type: array + oauth: + $ref: '#/components/schemas/OAuthRequirements' + description: The requirements for OAuth credentials. + allowWithoutCredential: description: >- - Specifies section and content to override boilerplate content - provided by go/api-docgen. Currently overrides following sections: - 1. rest.service.client_libraries - items: - $ref: '#/components/schemas/Page' - SystemParameters: - properties: - rules: + If true, the service accepts API keys without any other credential. + This flag only applies to HTTP and gRPC requests. + type: boolean + requirements: items: - $ref: '#/components/schemas/SystemParameterRule' - description: >- - Define system parameters. The parameters defined here will override - the default parameters implemented by the system. If this field is - missing from the service config, default system parameters will be - used. Default system parameters and names is - implementation-dependent. Example: define api key for all methods - system_parameters rules: - selector: "*" parameters: - name: api_key - url_query_parameter: api_key Example: define 2 api key names for a - specific method. system_parameters rules: - selector: "/ListShelves" - parameters: - name: api_key http_header: Api-Key1 - name: api_key - http_header: Api-Key2 **NOTE:** All service configuration rules - follow "last one wins" order. + $ref: '#/components/schemas/AuthRequirement' type: array - id: SystemParameters + description: Requirements for additional authentication providers. + id: AuthenticationRule description: >- - ### System parameter configuration A system parameter is a special kind - of parameter defined by the API system, not by an individual API. It is - typically mapped to an HTTP header and/or a URL query parameter. This - configuration specifies which methods change the names of the system - parameters. - type: object - Type: + Authentication rules for the service. By default, if a method has any + authentication requirements, every request must include a valid + credential matching one of the requirements. It's an error to include + more than one kind of credential in a single request. If a method + doesn't have any auth requirements, request credentials will be ignored. + Page: + description: >- + Represents a documentation page. A page can contain subpages to + represent nested documentation set structure. properties: - fields: - type: array + subpages: + description: >- + Subpages of this page. The order of subpages specified here will be + honored in the generated docset. items: - $ref: '#/components/schemas/Field' - description: The list of fields. - syntax: - enum: - - SYNTAX_PROTO2 - - SYNTAX_PROTO3 - - SYNTAX_EDITIONS - enumDescriptions: - - Syntax `proto2`. - - Syntax `proto3`. - - Syntax `editions`. - type: string - description: The source syntax. - options: - description: The protocol buffer options. + $ref: '#/components/schemas/Page' type: array - items: - $ref: '#/components/schemas/Option' - name: + content: + description: >- + The Markdown content of the page. You can use (== include {path} ==) + to include content from a Markdown file. The content can be used to + produce the documentation page such as HTML format page. type: string - description: The fully qualified message name. - sourceContext: - $ref: '#/components/schemas/SourceContext' - description: The source context. - edition: + name: description: >- - The source edition string, only valid when syntax is - SYNTAX_EDITIONS. + The name of the page. It will be used as an identity of the page to + generate URI of the page, text of the link to this page in + navigation, etc. The full page name (start from the root page name + to this page concatenated with `.`) can be used as reference to the + page in your documentation. For example: pages: - name: Tutorial + content: (== include tutorial.md ==) subpages: - name: Java content: + (== include tutorial_java.md ==) You can reference `Java` page using + Markdown reference link syntax: `Java`. type: string - oneofs: - type: array - description: The list of types appearing in `oneof` definitions in this type. - items: - type: string - description: A protocol buffer message type. - type: object - id: Type - CancelOperationRequest: - properties: {} - id: CancelOperationRequest - description: The request message for Operations.CancelOperation. type: object - LoggingDestination: - description: >- - Configuration of a specific logging destination (the producer project or - the consumer project). + id: Page + HttpRule: properties: - logs: - type: array - items: - type: string - description: >- - Names of the logs to be sent to this destination. Each name must be - defined in the Service.logs section. If the log name is not a domain - scoped name, it will be automatically prefixed with the service name - followed by "/". - monitoredResource: - description: >- - The monitored resource type. The type must be defined in the - Service.monitored_resources section. + patch: type: string - type: object - id: LoggingDestination - ImportAdminOverridesResponse: - type: object - description: Response message for ImportAdminOverrides - id: ImportAdminOverridesResponse - properties: - overrides: - description: The overrides that were created from the imported data. - type: array - items: - $ref: '#/components/schemas/QuotaOverride' - CppSettings: - id: CppSettings - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object - description: Settings for C++ client libraries. - ContextRule: - id: ContextRule - type: object - description: >- - A context rule provides information about the context for an individual - API element. - properties: - selector: + description: Maps to HTTP PATCH. Used for updating a resource. + put: + type: string + description: Maps to HTTP PUT. Used for replacing a resource. + responseBody: type: string description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - allowedResponseExtensions: - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from backend to client. - items: - type: string - type: array - requested: - items: - type: string - description: A list of full type names of requested contexts. - type: array - provided: - items: - type: string - description: A list of full type names of provided contexts. - type: array - allowedRequestExtensions: - items: - type: string - type: array - description: >- - A list of full type names or extension IDs of extensions allowed in - grpc side channel from client to backend. - BatchGetServicesResponse: - id: BatchGetServicesResponse - type: object - properties: - services: - description: The requested Service states. - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - type: array - description: Response message for the `BatchGetServices` method. - ListServicesResponse: - description: Response message for the `ListServices` method. - type: object - properties: - nextPageToken: - description: >- - Token that can be passed to `ListServices` to resume a paginated - query. + Optional. The name of the response field whose value is mapped to + the HTTP response body. When omitted, the entire response message + will be used as the HTTP response body. NOTE: The referred field + must be present at the top-level of the response message type. + get: type: string - services: - type: array - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The available services for the requested project. - id: ListServicesResponse - ImportConsumerOverridesResponse: - properties: - overrides: - items: - $ref: '#/components/schemas/QuotaOverride' - description: The overrides that were created from the imported data. - type: array - id: ImportConsumerOverridesResponse - type: object - description: Response message for ImportConsumerOverrides - BatchEnableServicesRequest: - type: object - id: BatchEnableServicesRequest - properties: - serviceIds: description: >- - The identifiers of the services to enable on the project. A valid - identifier would be: serviceusage.googleapis.com Enabling services - requires that each service is public or is shared with the user - enabling the service. A single request can enable a maximum of 20 - services at a time. If more than 20 services are specified, the - request will fail, and no state changes will occur. - type: array - items: - type: string - description: Request message for the `BatchEnableServices` method. - SystemParameterRule: - type: object - description: >- - Define a system parameter rule mapping system parameter definitions to - methods. - id: SystemParameterRule - properties: - parameters: + Maps to HTTP GET. Used for listing and getting information about + resources. + custom: + $ref: '#/components/schemas/CustomHttpPattern' description: >- - Define parameters. Multiple names may be defined for a parameter. - For a given method call, only one of them should be used. If - multiple names are used the behavior is implementation-dependent. If - none of the specified names are present the behavior is - parameter-dependent. - type: array - items: - $ref: '#/components/schemas/SystemParameter' - selector: + The custom pattern is used for specifying an HTTP method that is not + included in the `pattern` field, such as HEAD, or "*" to leave the + HTTP method unspecified for this rule. The wild-card rule is useful + for services that provide content to Web (HTML) clients. + post: description: >- - Selects the methods to which this rule applies. Use '*' to indicate - all methods in all APIs. Refer to selector for syntax details. + Maps to HTTP POST. Used for creating a resource or performing an + action. type: string - CustomErrorRule: - properties: - isErrorType: - description: >- - Mark this message as possible payload in error response. Otherwise, - objects of this type will be filtered when they appear in error - payload. - type: boolean - selector: - description: >- - Selects messages to which this rule applies. Refer to selector for - syntax details. + delete: + description: Maps to HTTP DELETE. Used for deleting a resource. type: string - description: A custom error rule. - id: CustomErrorRule - type: object - Context: - id: Context - type: object - description: >- - `Context` defines which contexts an API requests. Example: context: - rules: - selector: "*" requested: - google.rpc.context.ProjectContext - - google.rpc.context.OriginContext The above specifies that all methods in - the API request `google.rpc.context.ProjectContext` and - `google.rpc.context.OriginContext`. Available context types are defined - in package `google.rpc.context`. This also provides mechanism to - allowlist any protobuf message extension that can be sent in grpc - metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For - example, list any service specific protobuf types that can appear in - grpc metadata as follows in your yaml file: Example: context: rules: - - selector: "google.example.library.v1.LibraryService.CreateBook" - allowed_request_extensions: - google.foo.v1.NewExtension - allowed_response_extensions: - google.foo.v1.NewExtension You can also - specify extension ID instead of fully qualified extension name here. - properties: - rules: - type: array + additionalBindings: items: - $ref: '#/components/schemas/ContextRule' + $ref: '#/components/schemas/HttpRule' description: >- - A list of RPC context rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - Status: - properties: - details: - items: - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - type: object + Additional HTTP bindings for the selector. Nested bindings must not + contain an `additional_bindings` field themselves (that is, the + nesting may only be one level deep). type: array + body: description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - code: - format: int32 - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - message: + The name of the request field whose value is mapped to the HTTP + request body, or `*` for mapping all request fields not captured by + the path pattern to the HTTP body, or omitted for not having any + HTTP request body. NOTE: the referred field must be present at the + top-level of the request message type. + type: string + selector: type: string description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + Selects a method to which this rule applies. Refer to selector for + syntax details. description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - id: Status - ClientLibrarySettings: - properties: - javaSettings: - $ref: '#/components/schemas/JavaSettings' - description: Settings for legacy Java features, supported in the Service YAML. - nodeSettings: - $ref: '#/components/schemas/NodeSettings' - description: Settings for Node client libraries. - version: - description: >- - Version of the API to apply these settings to. This is the full - protobuf package for the API, ending in the version element. - Examples: "google.cloud.speech.v1" and - "google.spanner.admin.database.v1". - type: string - dotnetSettings: - $ref: '#/components/schemas/DotnetSettings' - description: Settings for .NET client libraries. - rubySettings: - $ref: '#/components/schemas/RubySettings' - description: Settings for Ruby client libraries. - phpSettings: - $ref: '#/components/schemas/PhpSettings' - description: Settings for PHP client libraries. - restNumericEnums: - description: >- - When using transport=rest, the client request will encode enums as - numbers rather than strings. - type: boolean - launchStage: - description: Launch stage of this version of the API. - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - type: string - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - cppSettings: - $ref: '#/components/schemas/CppSettings' - description: Settings for C++ client libraries. - pythonSettings: - description: Settings for Python client libraries. - $ref: '#/components/schemas/PythonSettings' - goSettings: - $ref: '#/components/schemas/GoSettings' - description: Settings for Go client libraries. + gRPC Transcoding gRPC Transcoding is a feature for mapping between a + gRPC method and one or more HTTP REST endpoints. It allows developers to + build a single API service that supports both gRPC APIs and REST APIs. + Many systems, including [Google + APIs](https://github.com/googleapis/googleapis), [Cloud + Endpoints](https://cloud.google.com/endpoints), [gRPC + Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + and use it for large scale production services. `HttpRule` defines the + schema of the gRPC/REST mapping. The mapping specifies how different + portions of the gRPC request message are mapped to the URL path, URL + query parameters, and HTTP request body. It also controls how the gRPC + response message is mapped to the HTTP response body. `HttpRule` is + typically specified as an `google.api.http` annotation on the gRPC + method. Each mapping specifies a URL path template and an HTTP method. + The path template may refer to one or more fields in the gRPC request + message, as long as each field is a non-repeated field with a primitive + (non-message) type. The path template controls how fields of the request + message are mapped to the URL path. Example: service Messaging { rpc + GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message + GetMessageRequest { string name = 1; // Mapped to URL path. } message + Message { string text = 1; // The resource content. } This enables an + HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - + gRPC: `GetMessage(name: "messages/123456")` Any fields in the request + message which are not bound by the path template automatically become + HTTP query parameters if there is no HTTP request body. For example: + service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) + { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } + message GetMessageRequest { message SubMessage { string subfield = 1; } + string message_id = 1; // Mapped to URL path. int64 revision = 2; // + Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped + to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC + mapping as below: - HTTP: `GET + /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: + `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + "foo"))` Note that fields which are mapped to URL query parameters must + have a primitive type or a repeated primitive type or a non-repeated + message type. In the case of a repeated type, the parameter can be + repeated in the URL as `...?param=A¶m=B`. In the case of a message + type, each field of the message is mapped to a separate parameter, such + as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request + body, the `body` field specifies the mapping. Consider a REST update + method on the message resource collection: service Messaging { rpc + UpdateMessage(UpdateMessageRequest) returns (Message) { option + (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" + }; } } message UpdateMessageRequest { string message_id = 1; // mapped + to the URL Message message = 2; // mapped to the body } The following + HTTP JSON to RPC mapping is enabled, where the representation of the + JSON in the request body is determined by protos JSON encoding: - HTTP: + `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The + special name `*` can be used in the body mapping to define that every + field not bound by the path template should be mapped to the request + body. This enables the following alternative definition of the update + method: service Messaging { rpc UpdateMessage(Message) returns (Message) + { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: + "*" }; } } message Message { string message_id = 1; string text = 2; } + The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH + /v1/messages/123456 { "text": "Hi!" }` - gRPC: + `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using + `*` in the body mapping, it is not possible to have HTTP parameters, as + all fields not bound by the path end in the body. This makes this option + more rarely used in practice when defining REST APIs. The common usage + of `*` is in custom methods which don't use the URL at all for + transferring data. It is possible to define multiple HTTP methods for + one RPC by using the `additional_bindings` option. Example: service + Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option + (google.api.http) = { get: "/v1/messages/{message_id}" + additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } + }; } } message GetMessageRequest { string message_id = 1; string user_id + = 2; } This enables the following two alternative HTTP JSON to RPC + mappings: - HTTP: `GET /v1/messages/123456` - gRPC: + `GetMessage(message_id: "123456")` - HTTP: `GET + /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" + message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields + (recursive expansion nested messages in the request message) are + classified into three categories: - Fields referred by the path + template. They are passed via the URL path. - Fields referred by the + HttpRule.body. They are passed via the HTTP request body. - All other + fields are passed via the URL query parameters, and the parameter name + is the field path in the request message. A repeated field can be + represented as multiple query parameters under the same name. 2. If + HttpRule.body is "*", there is no URL query parameter, all fields are + passed via URL path and HTTP request body. 3. If HttpRule.body is + omitted, there is no HTTP request body, all fields are passed via URL + path and URL query parameters. Path template syntax Template = "/" + Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | + "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] + "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax + `*` matches a single URL path segment. The syntax `**` matches zero or + more URL path segments, which must be the last part of the URL path + except the `Verb`. The syntax `Variable` matches part of the URL path as + specified by its template. A variable template must not contain other + variables. If a variable matches a single path segment, its template may + be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax + `LITERAL` matches literal text in the URL path. If the `LITERAL` + contains any reserved character, such characters should be + percent-encoded before the matching. If a variable contains exactly one + path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is + expanded into a URL path on the client side, all characters except + `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse + decoding. Such variables show up in the [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{var}`. If a variable contains multiple path segments, such as + `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a + URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` + are percent-encoded. The server side does the reverse decoding, except + "%2F" and "%2f" are left unchanged. Such variables show up in the + [Discovery + Document](https://developers.google.com/discovery/v1/reference/apis) as + `{+var}`. Using gRPC API Service Configuration gRPC API Service + Configuration (service config) is a configuration language for + configuring a gRPC service to become a user-facing product. The service + config is simply the YAML representation of the `google.api.Service` + proto message. As an alternative to annotating your proto file, you can + configure gRPC transcoding in your service config YAML files. You do + this by specifying a `HttpRule` that maps the gRPC method to a REST + endpoint, achieving the same effect as the proto annotation. This can be + particularly useful if you have a proto that is reused in multiple + services. Note that any transcoding specified in the service config will + override any matching transcoding configuration in the proto. The + following example selects a gRPC method and applies an `HttpRule` to it: + http: rules: - selector: example.v1.Messaging.GetMessage get: + /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC + Transcoding is used to map a gRPC to JSON REST endpoints, the proto to + JSON conversion must follow the [proto3 + specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + While the single segment variable follows the semantics of [RFC + 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + Expansion, the multi segment variable **does not** follow RFC 6570 + Section 3.2.3 Reserved Expansion. The reason is that the Reserved + Expansion does not expand special characters like `?` and `#`, which + would lead to invalid URLs. As the result, gRPC Transcoding uses a + custom encoding for multi segment variables. The path variables **must + not** refer to any repeated or mapped field, because client libraries + are not capable of handling such variable expansion. The path variables + **must not** capture the leading "/" character. The reason is that the + most common use case "{var}" does not capture the leading "/" character. + For consistency, all path variables must share the same behavior. + Repeated message fields must not be mapped to URL query parameters, + because no client library can support such complicated mapping. If an + API needs to use a JSON array for request or response body, it can map + the request or response body to a repeated field. However, some gRPC + Transcoding implementations may not support this feature. type: object - description: Details about how and where to publish client libraries. - id: ClientLibrarySettings + id: HttpRule BackendRule: description: A backend rule provides configuration for an individual API element. + id: BackendRule + type: object properties: - jwtAudience: + selector: type: string description: >- - The JWT audience is used when generating a JWT ID token for the - backend. This ID token will be added in the HTTP "authorization" - header, and sent to the backend. - deadline: - format: double - type: number - description: >- - The number of seconds to wait for a response from a request. The - default varies based on the request protocol and deployment - environment. - minDeadline: - type: number - deprecated: true - format: double - description: Deprecated, do not use. + Selects the methods to which this rule applies. Refer to selector + for syntax details. overridesByRequestProtocol: + type: object + description: The map between request protocol and the backend address. additionalProperties: $ref: '#/components/schemas/BackendRule' - description: The map between request protocol and the backend address. - type: object address: description: >- The address of the API backend. The scheme is used to determine the @@ -2072,18 +1371,50 @@ components: backends, use protocol to specify the protocol version. type: string disableAuth: + type: boolean description: >- When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. - type: boolean - pathTranslation: + deadline: + description: >- + The number of seconds to wait for a response from a request. The + default varies based on the request protocol and deployment + environment. + format: double + type: number + operationDeadline: + description: >- + The number of seconds to wait for the completion of a long running + operation. The default is no deadline. + format: double + type: number + minDeadline: + description: Deprecated, do not use. + deprecated: true + type: number + format: double + jwtAudience: + description: >- + The JWT audience is used when generating a JWT ID token for the + backend. This ID token will be added in the HTTP "authorization" + header, and sent to the backend. type: string - enum: - - PATH_TRANSLATION_UNSPECIFIED - - CONSTANT_ADDRESS - - APPEND_PATH_TO_ADDRESS + protocol: + description: >- + The protocol used for sending a request to the backend. The + supported values are "http/1.1" and "h2". The default value is + inferred from the scheme in the address field: SCHEME PROTOCOL + http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure + HTTP backends (https://) that support HTTP/2, set this field to "h2" + for improved performance. Configuring this field to non-default + values is only supported for secure HTTP backends. This field will + be ignored for all other backends. See + https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids + for more details on the supported values. + type: string + pathTranslation: enumDescriptions: - '' - >- @@ -2113,1392 +1444,2037 @@ components: Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST - protocol: - description: >- - The protocol used for sending a request to the backend. The - supported values are "http/1.1" and "h2". The default value is - inferred from the scheme in the address field: SCHEME PROTOCOL - http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure - HTTP backends (https://) that support HTTP/2, set this field to "h2" - for improved performance. Configuring this field to non-default - values is only supported for secure HTTP backends. This field will - be ignored for all other backends. See - https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids - for more details on the supported values. + enum: + - PATH_TRANSLATION_UNSPECIFIED + - CONSTANT_ADDRESS + - APPEND_PATH_TO_ADDRESS type: string - operationDeadline: - description: >- - The number of seconds to wait for the completion of a long running - operation. The default is no deadline. - type: number - format: double - selector: - description: >- - Selects the methods to which this rule applies. Refer to selector - for syntax details. - type: string - type: object - id: BackendRule - PythonSettings: - id: PythonSettings - properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - type: object - description: Settings for Python client libraries. - EnableRule: + GetServiceIdentityMetadata: + id: GetServiceIdentityMetadata type: object - id: EnableRule - description: >- - The consumer policy rule that defines usable services and service - groups. + description: Metadata for the `GetServiceIdentity` method. + properties: {} + Field: properties: - groups: + defaultValue: description: >- - DEPRECATED: Please use field `values`. Service group should have - prefix `groups/`. The names of the service groups that are enabled - (Not Implemented). Example: `groups/googleServices`. - type: array - deprecated: true - items: - type: string - services: - items: - type: string - type: array - deprecated: true + The string value of the default value of this field. Proto2 syntax + only. + type: string + typeUrl: description: >- - DEPRECATED: Please use field `values`. Service should have prefix - `services/`. The names of the services that are enabled. Example: - `storage.googleapis.com`. - values: - type: array - items: - type: string + The field type URL, without the scheme, for message or enumeration + types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + type: string + number: + format: int32 + type: integer + description: The field number. + oneofIndex: + format: int32 description: >- - The names of the services or service groups that are enabled. - Example: `services/storage.googleapis.com`, `groups/googleServices`, - `groups/allServices`. - enableType: + The index of the field type in `Type.oneofs`, for message or + enumeration types. The first type has index 1; zero means the type + is not in the list. + type: integer + kind: + enum: + - TYPE_UNKNOWN + - TYPE_DOUBLE + - TYPE_FLOAT + - TYPE_INT64 + - TYPE_UINT64 + - TYPE_INT32 + - TYPE_FIXED64 + - TYPE_FIXED32 + - TYPE_BOOL + - TYPE_STRING + - TYPE_GROUP + - TYPE_MESSAGE + - TYPE_BYTES + - TYPE_UINT32 + - TYPE_ENUM + - TYPE_SFIXED32 + - TYPE_SFIXED64 + - TYPE_SINT32 + - TYPE_SINT64 type: string - description: Client and resource project enable type. enumDescriptions: - - >- - Unspecified enable type, which means enabled as both client and - resource project. - - >- - Enable all clients under the CRM node specified by - `ConsumerPolicy.name` to use the listed services. A client can be - an API key, an OAuth client, or a service account. - - >- - Enable resources in the list services to be created and used under - the CRM node specified by the `ConsumerPolicy.name`. - - >- - Activation made by Service Usage v1 API. This will be how - consumers differentiate between policy changes made by v1 and v2 - clients and understand what is actually possible based on those - different policies. + - Field type unknown. + - Field type double. + - Field type float. + - Field type int64. + - Field type uint64. + - Field type int32. + - Field type fixed64. + - Field type fixed32. + - Field type bool. + - Field type string. + - Field type group. Proto2 syntax only, and deprecated. + - Field type message. + - Field type bytes. + - Field type uint32. + - Field type enum. + - Field type sfixed32. + - Field type sfixed64. + - Field type sint32. + - Field type sint64. + description: The field type. + options: + items: + $ref: '#/components/schemas/Option' + type: array + description: The protocol buffer options. + packed: + description: Whether to use alternative packed wire representation. + type: boolean + jsonName: + type: string + description: The field JSON name. + name: + description: The field name. + type: string + cardinality: + type: string + description: The field cardinality. + enumDescriptions: + - For fields with unknown cardinality. + - For optional fields. + - For required fields. Proto2 syntax only. + - For repeated fields. enum: - - ENABLE_TYPE_UNSPECIFIED - - CLIENT - - RESOURCE - - V1_COMPATIBLE - AuthRequirement: + - CARDINALITY_UNKNOWN + - CARDINALITY_OPTIONAL + - CARDINALITY_REQUIRED + - CARDINALITY_REPEATED + description: A single field of a message type. type: object + id: Field + Publishing: properties: - providerId: - type: string - description: >- - id from authentication provider. Example: provider_id: - bookstore_auth - audiences: + protoReferenceDocumentationUri: description: >- - NOTE: This will be deprecated soon, once AuthProvider.audiences is - implemented and accepted in all the runtime components. The list of - JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, only JWTs with - audience "https://Service_name/API_name" will be accepted. For - example, if no audiences are in the setting, LibraryService API will - only accept JWTs with the following audience - "https://library-example.googleapis.com/google.example.library.v1.LibraryService". - Example: audiences: bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + Optional link to proto reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rpc + type: string + documentationUri: type: string - description: >- - User-defined authentication requirements, including support for [JSON - Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - id: AuthRequirement - Option: - id: Option - properties: - value: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object description: >- - The option's value packed in an Any message. If the value is a - primitive, the corresponding wrapper type defined in - google/protobuf/wrappers.proto should be used. If the value is an - enum, it should be stored as an int32 value using the - google.protobuf.Int32Value type. - name: + Link to product home page. Example: + https://cloud.google.com/asset-inventory/docs/overview + librarySettings: description: >- - The option's name. For protobuf built-in options (options defined in - descriptor.proto), this is the short name. For example, - `"map_entry"`. For custom options, it should be the fully-qualified - name. For example, `"google.api.http"`. - type: string - description: >- - A protocol buffer option, which can be attached to a message, field, - enumeration, etc. - type: object - BatchCreateAdminOverridesResponse: - id: BatchCreateAdminOverridesResponse - properties: - overrides: + Client library settings. If the same version string appears multiple + times in this list, then the last one wins. Settings from earlier + settings with the same version string are discarded. items: - $ref: '#/components/schemas/QuotaOverride' + $ref: '#/components/schemas/ClientLibrarySettings' type: array - description: The overrides that were created. - description: Response message for BatchCreateAdminOverrides - type: object - SourceContext: - type: object - properties: - fileName: + docTagPrefix: type: string description: >- - The path-qualified name of the .proto file that contained the - associated protobuf element. For example: - `"google/protobuf/source_context.proto"`. - id: SourceContext - description: >- - `SourceContext` represents information about the source of a protobuf - element, like the file in which it is defined. - DocumentationRule: - description: A documentation rule provides information about individual API elements. - type: object - properties: - selector: + A prefix used in sample code when demarking regions to be included + in documentation. + methodSettings: + type: array + items: + $ref: '#/components/schemas/MethodSettings' description: >- - The selector is a comma-separated list of patterns for any element - such as a method, a field, an enum value. Each pattern is a - qualified name of the element which may end in "*", indicating a - wildcard. Wildcards are only allowed at the end and for a whole - component of the qualified name, i.e. "foo.*" is ok, but not - "foo.b*" or "foo.*.bar". A wildcard will match one or more - components. To specify a default for all applicable elements, the - whole pattern "*" is used. + A list of API method settings, e.g. the behavior for methods that + use the long-running operation pattern. + newIssueUri: type: string - deprecationDescription: description: >- - Deprecation description of the selected element(s). It can be - provided if an element is marked as `deprecated`. - type: string - description: + Link to a *public* URI where users can report issues. Example: + https://issuetracker.google.com/issues/new?component=190865&template=1161103 + githubLabel: type: string description: >- - Description of the selected proto element (e.g. a message, a method, - a 'service' definition, or a field). Defaults to leading & trailing - comments taken from the proto source definition of the proto - element. - disableReplacementWords: - description: >- - String of comma or space separated case-sensitive words for which - method/field name replacement will be disabled by go/api-docgen. + GitHub label to apply to issues and pull requests opened for this + API. + organization: + description: For whom the client library is being published. + enum: + - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED + - CLOUD + - ADS + - PHOTOS + - STREET_VIEW + - SHOPPING + - GEO + - GENERATIVE_AI type: string - id: DocumentationRule - SourceInfo: - description: Source information used to create a Service Config - type: object - properties: - sourceFiles: - description: All files used during config generation. - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: array - id: SourceInfo - Logging: - description: >- - Logging configuration of the service. The following example shows how to - configure logs to be sent to the producer and consumer projects. In the - example, the `activity_history` log is sent to both the producer and - consumer projects, whereas the `purchase_history` log is only sent to - the producer project. monitored_resources: - type: - library.googleapis.com/branch labels: - key: /city description: The city - where the library branch is located in. - key: /name description: The - name of the branch. logs: - name: activity_history labels: - key: - /customer_id - name: purchase_history logging: producer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - purchase_history consumer_destinations: - - monitored_resource: library.googleapis.com/branch logs: - - activity_history - properties: - consumerDestinations: + enumDescriptions: + - Not useful. + - Google Cloud Platform Org. + - Ads (Advertising) Org. + - Photos Org. + - Street View Org. + - Shopping Org. + - Geo Org. + - Generative AI - https://developers.generativeai.google + restReferenceDocumentationUri: description: >- - Logging configurations for sending logs to the consumer project. - There can be multiple consumer destinations, each one must have a - different monitored resource type. A log can be used in at most one - consumer destination. - items: - $ref: '#/components/schemas/LoggingDestination' - type: array - producerDestinations: + Optional link to REST reference documentation. Example: + https://cloud.google.com/pubsub/lite/docs/reference/rest + type: string + codeownerGithubTeams: description: >- - Logging configurations for sending logs to the producer project. - There can be multiple producer destinations, each one must have a - different monitored resource type. A log can be used in at most one - producer destination. + GitHub teams to be added to CODEOWNERS in the directory in GitHub + containing source code for the client libraries for this API. type: array items: - $ref: '#/components/schemas/LoggingDestination' - id: Logging - type: object - Authentication: - properties: - providers: - description: Defines a set of authentication providers that a service supports. - items: - $ref: '#/components/schemas/AuthProvider' - type: array - rules: + type: string + apiShortName: + type: string description: >- - A list of authentication rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - items: - $ref: '#/components/schemas/AuthenticationRule' - type: array + Used as a tracking tag when collecting data about the APIs developer + relations artifacts like docs, packages delivered to package + managers, etc. Example: "speech". type: object + id: Publishing description: >- - `Authentication` defines the authentication configuration for API - methods provided by an API service. Example: name: - calendar.googleapis.com authentication: providers: - id: - google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - selector: google.calendar.Delegate - oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read - id: Authentication - LogDescriptor: - description: >- - A description of a log type. Example in YAML format: - name: - library.googleapis.com/activity_history description: The history of - borrowing and returning library items. display_name: Activity labels: - - key: /customer_id description: Identifier of a library customer + This message configures the settings for publishing [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from the service config. + CommonLanguageSettings: properties: - description: - type: string - description: >- - A human-readable description of this log. This information appears - in the documentation and can contain details. - name: - type: string - description: >- - The name of the log. It must be less than 512 characters long and - can include the following characters: upper- and lower-case - alphanumeric characters [A-Za-z0-9], and punctuation characters - including slash, underscore, hyphen, period [/_-.]. - displayName: + referenceDocsUri: description: >- - The human-readable name for this log. This information appears on - the user interface and should be concise. + Link to automatically generated reference documentation. Example: + https://cloud.google.com/nodejs/docs/reference/asset/latest type: string - labels: + deprecated: true + destinations: items: - $ref: '#/components/schemas/LabelDescriptor' - type: array + enumDescriptions: + - >- + Client libraries will neither be generated nor published to + package managers. + - >- + Generate the client library in a repo under + github.com/googleapis, but don't publish it to package managers. + - >- + Publish the library to package managers like nuget.org and + npmjs.com. + enum: + - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED + - GITHUB + - PACKAGE_MANAGER + type: string description: >- - The set of labels that are available to describe a specific log - entry. Runtime requests that contain labels not specified here are - considered invalid. - type: object - id: LogDescriptor - JwtLocation: + The destination where API teams want this client library to be + published. + type: array type: object + description: Required information for every language. + id: CommonLanguageSettings + UsageRule: + id: UsageRule properties: - valuePrefix: + selector: type: string description: >- - The value prefix. The value format is "value_prefix{token}" Only - applies to "in" header type. Must be empty for "in" query type. If - not empty, the header value has to match (case sensitive) this - prefix. If not matched, JWT will not be extracted. If matched, JWT - will be extracted after the prefix is removed. For example, for - "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space - at the end. - query: - description: Specifies URL query parameter name to extract JWT token. - type: string - cookie: - type: string - description: Specifies cookie name to extract JWT token. - header: - type: string - description: Specifies HTTP header name to extract JWT token. - id: JwtLocation - description: Specifies a location to extract JWT from an API request. - GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata: - id: GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + skipServiceControl: + description: >- + If true, the selected method should skip service control and the + control plane features, such as quota and billing, will not be + available. This flag is used by Google Cloud Endpoints to bypass + checks for internal methods, such as service health check methods. + type: boolean + allowUnregisteredCalls: + type: boolean + description: >- + If true, the selected method allows unregistered calls, e.g. calls + that don't identify any user or application. + description: >- + Usage configuration rules for the service. NOTE: Under development. Use + this rule to configure unregistered calls for the service. Unregistered + calls are calls that do not contain consumer project identity. (Example: + calls that do not contain an API key). By default, API methods do not + allow unregistered calls, and each method call must be identified by a + consumer project identity. Use this rule to allow/disallow unregistered + calls. Example of an API that wants to allow unregistered calls for + entire service. usage: rules: - selector: "*" allow_unregistered_calls: + true Example of a method that wants to allow unregistered calls. usage: + rules: - selector: "google.example.library.v1.LibraryService.CreateBook" + allow_unregistered_calls: true type: object - description: Metadata for the `UpdateConsumerPolicy` method. + ImportAdminOverridesMetadata: properties: {} - ImportAdminQuotaPoliciesMetadata: - id: ImportAdminQuotaPoliciesMetadata + id: ImportAdminOverridesMetadata + type: object description: >- Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO - returned by ImportAdminQuotaPolicies. - type: object - properties: {} - Backend: - id: Backend + returned by ImportAdminOverrides. + Http: + description: >- + Defines the HTTP configuration for an API service. It contains a list of + HttpRule, each specifying the mapping of an RPC method to one or more + HTTP REST API methods. + id: Http type: object properties: rules: type: array items: - $ref: '#/components/schemas/BackendRule' + $ref: '#/components/schemas/HttpRule' description: >- - A list of API backend rules that apply to individual API methods. - **NOTE:** All service configuration rules follow "last one wins" - order. - description: '`Backend` defines the backend configuration for a service.' - RemoveEnableRulesMetadata: - properties: {} - id: RemoveEnableRulesMetadata + A list of HTTP configuration rules that apply to individual API + methods. **NOTE:** All service configuration rules follow "last one + wins" order. + fullyDecodeReservedExpansion: + description: >- + When set to true, URL path parameters will be fully URI-decoded + except in cases of single segment matches in reserved expansion, + where "%2F" will be left encoded. The default behavior is to not + decode RFC 6570 reserved characters in multi segment matches. + type: boolean + Status: type: object - description: Metadata for the `RemoveEnableRules` method. - Quota: properties: - limits: - description: List of QuotaLimit definitions for the service. - type: array - items: - $ref: '#/components/schemas/QuotaLimit' - metricRules: + details: items: - $ref: '#/components/schemas/MetricRule' - description: >- - List of MetricRule definitions, each one mapping a selected method - to one or more metrics. + type: object + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. type: array - id: Quota - type: object + description: >- + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: + type: integer + description: The status code, which should be an enum value of google.rpc.Code. + format: int32 + id: Status description: >- - Quota configuration helps to achieve fairness and budgeting in service - usage. The metric based quota configuration works this way: - The - service configuration defines a set of metrics. - For API calls, the - quota.metric_rules maps methods to metrics with corresponding costs. - - The quota.limits defines limits on the metrics, which will be used for - quota checks at runtime. An example quota configuration in yaml format: - quota: limits: - name: apiWriteQpsPerProject metric: - library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit - for consumer projects values: STANDARD: 10000 (The metric rules bind all - methods to the read_calls metric, except for the UpdateBook and - DeleteBook methods. These two methods are mapped to the write_calls - metric, with the UpdateBook method consuming at twice rate as the - DeleteBook method.) metric_rules: - selector: "*" metric_costs: - library.googleapis.com/read_calls: 1 - selector: - google.example.library.v1.LibraryService.UpdateBook metric_costs: - library.googleapis.com/write_calls: 2 - selector: - google.example.library.v1.LibraryService.DeleteBook metric_costs: - library.googleapis.com/write_calls: 1 Corresponding Metric definition: - metrics: - name: library.googleapis.com/read_calls display_name: Read - requests metric_kind: DELTA value_type: INT64 - name: - library.googleapis.com/write_calls display_name: Write requests - metric_kind: DELTA value_type: INT64 - AddEnableRulesMetadata: + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + Analysis: type: object - properties: {} - description: Metadata for the `AddEnableRules` method. - id: AddEnableRulesMetadata - GoogleApiServiceusageV1beta1ServiceIdentity: properties: - email: - type: string + displayName: description: >- - The email address of the service account that a service producer - would use to access consumer resources. - uniqueId: + Output only. The user friendly display name of the analysis type. + E.g. service dependency analysis, service resource usage analysis, + etc. + readOnly: true + type: string + service: type: string description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + The names of the service that has analysis result of warnings or + blockers. Example: `services/storage.googleapis.com`. + analysis: + readOnly: true + description: Output only. Analysis result of updating a policy. + $ref: '#/components/schemas/AnalysisResult' + analysisType: + readOnly: true + enumDescriptions: + - Unspecified analysis type. Do not use. + - The analysis of service dependencies. + - The analysis of service resource usage. + enum: + - ANALYSIS_TYPE_UNSPECIFIED + - ANALYSIS_TYPE_DEPENDENCY + - ANALYSIS_TYPE_RESOURCE_USAGE + description: Output only. The type of analysis. + type: string + id: Analysis + description: A message to group the analysis information. + BatchGetServicesResponse: + description: Response message for the `BatchGetServices` method. + properties: + services: + type: array + description: The requested Service states. + items: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + id: BatchGetServicesResponse type: object + Context: description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - id: GoogleApiServiceusageV1beta1ServiceIdentity - MetricDescriptor: - description: >- - Defines a metric type and its schema. Once a metric descriptor is - created, deleting or altering it stops data collection and makes the - metric type's existing data unusable. - id: MetricDescriptor + `Context` defines which contexts an API requests. Example: context: + rules: - selector: "*" requested: - google.rpc.context.ProjectContext - + google.rpc.context.OriginContext The above specifies that all methods in + the API request `google.rpc.context.ProjectContext` and + `google.rpc.context.OriginContext`. Available context types are defined + in package `google.rpc.context`. This also provides mechanism to + allowlist any protobuf message extension that can be sent in grpc + metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For + example, list any service specific protobuf types that can appear in + grpc metadata as follows in your yaml file: Example: context: rules: - + selector: "google.example.library.v1.LibraryService.CreateBook" + allowed_request_extensions: - google.foo.v1.NewExtension + allowed_response_extensions: - google.foo.v1.NewExtension You can also + specify extension ID instead of fully qualified extension name here. type: object + id: Context properties: - monitoredResourceTypes: + rules: + type: array description: >- - Read-only. If present, then a time series, which is identified - partially by a metric type and a MonitoredResourceDescriptor, that - is associated with this metric type can only be associated with one - of the monitored resource types listed here. + A list of RPC context rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. items: - type: string + $ref: '#/components/schemas/ContextRule' + BillingDestination: + description: >- + Configuration of a specific billing destination (Currently only support + bill against consumer project). + type: object + properties: + metrics: type: array - launchStage: - enum: - - LAUNCH_STAGE_UNSPECIFIED - - UNIMPLEMENTED - - PRELAUNCH - - EARLY_ACCESS - - ALPHA - - BETA - - GA - - DEPRECATED - description: Optional. The launch stage of the metric definition. - enumDescriptions: - - Do not use this default value. - - The feature is not yet implemented. Users can not use it. - - >- - Prelaunch features are hidden from users and are only visible - internally. - - >- - Early Access features are limited to a closed group of testers. To - use these features, you must sign up in advance and sign a Trusted - Tester agreement (which includes confidentiality provisions). - These features may be unstable, changed in backward-incompatible - ways, and are not guaranteed to be released. - - >- - Alpha is a limited availability test for releases before they are - cleared for widespread use. By Alpha, all significant design - issues are resolved and we are in the process of verifying - functionality. Alpha customers need to apply for access, agree to - applicable terms, and have their projects allowlisted. Alpha - releases don't have to be feature complete, no SLAs are provided, - and there are no technical support obligations, but they will be - far enough along that customers can actually use them in test - environments or for limited-use tests -- just like they would in - normal production cases. - - >- - Beta is the point at which we are ready to open a release for any - customer to use. There are no SLA or technical support obligations - in a Beta release. Products will be complete from a feature - perspective, but may have some open outstanding issues. Beta - releases are suitable for limited production use cases. - - >- - GA features are open to all developers and are considered stable - and fully qualified for production use. - - >- - Deprecated features are scheduled to be shut down and removed. For - more information, see the "Deprecation Policy" section of our - [Terms of Service](https://cloud.google.com/terms/) and the - [Google Cloud Platform Subject to the Deprecation - Policy](https://cloud.google.com/terms/deprecation) documentation. - type: string - metadata: - $ref: '#/components/schemas/MetricDescriptorMetadata' - description: Optional. Metadata which can be used to guide usage of the metric. - type: + items: + type: string description: >- - The metric type, including its DNS name prefix. The type is not - URL-encoded. All user-defined metric types have the DNS name - `custom.googleapis.com` or `external.googleapis.com`. Metric types - should use a natural hierarchical grouping. For example: - "custom.googleapis.com/invoice/paid/amount" - "external.googleapis.com/prometheus/up" - "appengine.googleapis.com/http/server/response_latencies" - type: string - valueType: + Names of the metrics to report to this billing destination. Each + name must be defined in Service.metrics section. + monitoredResource: type: string - enum: - - VALUE_TYPE_UNSPECIFIED - - BOOL - - INT64 - - DOUBLE - - STRING - - DISTRIBUTION - - MONEY - enumDescriptions: - - Do not use this default value. - - >- - The value is a boolean. This value type can be used only if the - metric kind is `GAUGE`. - - The value is a signed 64-bit integer. - - The value is a double precision floating point number. - - >- - The value is a text string. This value type can be used only if - the metric kind is `GAUGE`. - - The value is a `Distribution`. - - The value is money. description: >- - Whether the measurement is an integer, a floating-point number, etc. - Some combinations of `metric_kind` and `value_type` might not be - supported. - labels: + The monitored resource type. The type must be defined in + Service.monitored_resources section. + id: BillingDestination + LoggingDestination: + properties: + monitoredResource: description: >- - The set of labels that can be used to describe a specific instance - of this metric type. For example, the - `appengine.googleapis.com/http/server/response_latencies` metric - type has a label for the HTTP response code, `response_code`, so you - can look at latencies for successful responses or just for responses - that failed. + The monitored resource type. The type must be defined in the + Service.monitored_resources section. + type: string + logs: + description: >- + Names of the logs to be sent to this destination. Each name must be + defined in the Service.logs section. If the log name is not a domain + scoped name, it will be automatically prefixed with the service name + followed by "/". + items: + type: string + type: array + description: >- + Configuration of a specific logging destination (the producer project or + the consumer project). + type: object + id: LoggingDestination + UpdateConsumerPolicyMetadata: + id: UpdateConsumerPolicyMetadata + properties: {} + type: object + description: Metadata for the `UpdateConsumerPolicy` method. + Monitoring: + type: object + id: Monitoring + properties: + producerDestinations: type: array items: - $ref: '#/components/schemas/LabelDescriptor' - metricKind: + $ref: '#/components/schemas/MonitoringDestination' description: >- - Whether the metric records instantaneous values, changes to a value, - etc. Some combinations of `metric_kind` and `value_type` might not - be supported. - enumDescriptions: - - Do not use this default value. - - An instantaneous measurement of a value. - - The change in a value during a time interval. - - >- - A value accumulated over a time interval. Cumulative measurements - in a time series should have the same start time and increasing - end times, until an event resets the cumulative value to zero and - sets a new start time for the following points. - type: string - enum: - - METRIC_KIND_UNSPECIFIED - - GAUGE - - DELTA - - CUMULATIVE - unit: + Monitoring configurations for sending metrics to the producer + project. There can be multiple producer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + consumerDestinations: + type: array description: >- - The units in which the metric value is reported. It is only - applicable if the `value_type` is `INT64`, `DOUBLE`, or - `DISTRIBUTION`. The `unit` defines the representation of the stored - metric values. Different systems might scale the values to be more - easily displayed (so a value of `0.02kBy` _might_ be displayed as - `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). - However, if the `unit` is `kBy`, then the value of the metric is - always in thousands of bytes, no matter how it might be displayed. - If you want a custom metric to record the exact number of - CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` - metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just - `s`). If the job uses 12,005 CPU-seconds, then the value is written - as `12005`. Alternatively, if you want a custom metric to record - data in a more granular way, you can create a `DOUBLE CUMULATIVE` - metric whose `unit` is `ks{CPU}`, and then write the value `12.005` - (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which - is `12005/1024`). The supported units are a subset of [The Unified - Code for Units of Measure](https://unitsofmeasure.org/ucum.html) - standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` - second * `min` minute * `h` hour * `d` day * `1` dimensionless - **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga - (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` - zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro - (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) - * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` - kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) - * `Pi` pebi (2^50) **Grammar** The grammar also includes these - connectors: * `/` division or ratio (as an infix operator). For - examples, `kBy/{email}` or `MiBy/10ms` (although you should almost - never have `/s` in a metric `unit`; rates should always be computed - at query time from the underlying cumulative or delta value). * `.` - multiplication or composition (as an infix operator). For examples, - `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: - Expression = Component { "." Component } { "/" Component } ; - Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | - "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a - comment if it follows a `UNIT`. If the annotation is used alone, - then the unit is equivalent to `1`. For examples, `{request}/s == - 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of - non-blank printable ASCII characters not containing `{` or `}`. * - `1` represents a unitary [dimensionless - unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, - such as in `1/s`. It is typically used when none of the basic units - are appropriate. For example, "new users per day" can be represented - as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 - new users). Alternatively, "thousands of page views per day" would - be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a - metric value of `5.3` would mean "5300 page views per day"). * `%` - represents dimensionless value of 1/100, and annotates values giving - a percentage (so the metric values are typically in the range of - 0..100, and a metric value `3` means "3 percent"). * `10^2.%` - indicates a metric contains a ratio, typically in the range 0..1, - that will be multiplied by 100 and displayed as a percentage (so a - metric value `0.03` means "3 percent"). - type: string - name: - description: The resource name of the metric descriptor. - type: string - description: - type: string + Monitoring configurations for sending metrics to the consumer + project. There can be multiple consumer destinations. A monitored + resource type may appear in multiple monitoring destinations if + different aggregations are needed for different sets of metrics + associated with that monitored resource type. A monitored resource + and metric pair may only be used once in the Monitoring + configuration. + items: + $ref: '#/components/schemas/MonitoringDestination' + description: >- + Monitoring configuration of the service. The example below shows how to + configure monitored resources and metrics for monitoring. In the + example, a monitored resource and two metrics are defined. The + `library.googleapis.com/book/returned_count` metric is sent to both + producer and consumer projects, whereas the + `library.googleapis.com/book/num_overdue` metric is only sent to the + consumer project. monitored_resources: - type: + library.googleapis.com/Branch display_name: "Library Branch" + description: "A branch of a library." launch_stage: GA labels: - key: + resource_container description: "The Cloud container (ie. project id) + for the Branch." - key: location description: "The location of the + library branch." - key: branch_id description: "The id of the branch." + metrics: - name: library.googleapis.com/book/returned_count + display_name: "Books Returned" description: "The count of books that + have been returned." launch_stage: GA metric_kind: DELTA value_type: + INT64 unit: "1" labels: - key: customer_id description: "The id of the + customer." - name: library.googleapis.com/book/num_overdue display_name: + "Books Overdue" description: "The current number of overdue books." + launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: + - key: customer_id description: "The id of the customer." monitoring: + producer_destinations: - monitored_resource: + library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count consumer_destinations: - + monitored_resource: library.googleapis.com/Branch metrics: - + library.googleapis.com/book/returned_count - + library.googleapis.com/book/num_overdue + AnalysisResult: + type: object + properties: + warnings: description: >- - A detailed description of the metric, which can be used in - documentation. - displayName: + Warning information indicating that the policy changes might be + unsafe, but will not block the changes at runtime. + type: array + items: + $ref: '#/components/schemas/Impact' + blockers: + items: + $ref: '#/components/schemas/Impact' description: >- - A concise name for the metric, which can be displayed in user - interfaces. Use sentence case without an ending period, for example - "Request count". This field is optional but it is recommended to be - set for any metrics associated with user-visible concepts, such as - Quota. - type: string - CustomError: + Blocking information that would prevent the policy changes at + runtime. + type: array + description: An analysis result including blockers and warnings. + id: AnalysisResult + ExperimentalFeatures: properties: - types: + restAsyncIoEnabled: + description: >- + Enables generation of asynchronous REST clients if `rest` transport + is enabled. By default, asynchronous REST clients will not be + generated. This feature will be enabled by default 1 month after + launching the feature in preview packages. + type: boolean + type: object + id: ExperimentalFeatures + description: >- + Experimental features to be included during client library generation. + These fields will be deprecated once the feature graduates and is + enabled by default. + GoSettings: + type: object + description: Settings for Go client libraries. + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + id: GoSettings + GoogleApiServiceusageV1OperationMetadata: + id: GoogleApiServiceusageV1OperationMetadata + description: The operation metadata returned for the batchend services operation. + type: object + properties: + resourceNames: items: type: string type: array description: >- - The list of custom error detail types, e.g. - 'google.foo.v1.CustomError'. - rules: + The full name of the resources that this operation is directly + associated with. + AddEnableRulesResponse: + type: object + id: AddEnableRulesResponse + properties: + addedValues: + type: array + items: + type: string + description: The values added to the parent consumer policy. + parent: description: >- - The list of custom error rules that apply to individual API - messages. **NOTE:** All service configuration rules follow "last one - wins" order. + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. + type: string + description: The response message of `AddEnableRules` method. + ImportConsumerOverridesResponse: + properties: + overrides: items: - $ref: '#/components/schemas/CustomErrorRule' + $ref: '#/components/schemas/QuotaOverride' + description: The overrides that were created from the imported data. type: array + id: ImportConsumerOverridesResponse + description: Response message for ImportConsumerOverrides type: object - id: CustomError + BatchEnableServicesResponse: + type: object + properties: + services: + type: array + description: The new state of the services after enabling. + items: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + failures: + items: + $ref: '#/components/schemas/EnableFailure' + type: array + description: >- + If allow_partial_success is true, and one or more services could not + be enabled, this field contains the details about each failure. description: >- - Customize service error responses. For example, list any service - specific protobuf types that can appear in error detail lists of error - responses. Example: custom_error: types: - google.foo.v1.CustomError - - google.foo.v1.AnotherError - HttpRule: + Response message for the `BatchEnableServices` method. This response + message is assigned to the `response` field of the returned Operation + when that operation is done. + id: BatchEnableServicesResponse + MetricDescriptor: description: >- - # gRPC Transcoding gRPC Transcoding is a feature for mapping between a - gRPC method and one or more HTTP REST endpoints. It allows developers to - build a single API service that supports both gRPC APIs and REST APIs. - Many systems, including [Google - APIs](https://github.com/googleapis/googleapis), [Cloud - Endpoints](https://cloud.google.com/endpoints), [gRPC - Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and - [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature - and use it for large scale production services. `HttpRule` defines the - schema of the gRPC/REST mapping. The mapping specifies how different - portions of the gRPC request message are mapped to the URL path, URL - query parameters, and HTTP request body. It also controls how the gRPC - response message is mapped to the HTTP response body. `HttpRule` is - typically specified as an `google.api.http` annotation on the gRPC - method. Each mapping specifies a URL path template and an HTTP method. - The path template may refer to one or more fields in the gRPC request - message, as long as each field is a non-repeated field with a primitive - (non-message) type. The path template controls how fields of the request - message are mapped to the URL path. Example: service Messaging { rpc - GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message - GetMessageRequest { string name = 1; // Mapped to URL path. } message - Message { string text = 1; // The resource content. } This enables an - HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET - /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields - in the request message which are not bound by the path template - automatically become HTTP query parameters if there is no HTTP request - body. For example: service Messaging { rpc GetMessage(GetMessageRequest) - returns (Message) { option (google.api.http) = { - get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { - message SubMessage { string subfield = 1; } string message_id = 1; // - Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter - `revision`. SubMessage sub = 3; // Mapped to URL query parameter - `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP - | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` - | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: - "foo"))` Note that fields which are mapped to URL query parameters must - have a primitive type or a repeated primitive type or a non-repeated - message type. In the case of a repeated type, the parameter can be - repeated in the URL as `...?param=A¶m=B`. In the case of a message - type, each field of the message is mapped to a separate parameter, such - as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request - body, the `body` field specifies the mapping. Consider a REST update - method on the message resource collection: service Messaging { rpc - UpdateMessage(UpdateMessageRequest) returns (Message) { option - (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" - }; } } message UpdateMessageRequest { string message_id = 1; // mapped - to the URL Message message = 2; // mapped to the body } The following - HTTP JSON to RPC mapping is enabled, where the representation of the - JSON in the request body is determined by protos JSON encoding: HTTP | - gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | - `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The - special name `*` can be used in the body mapping to define that every - field not bound by the path template should be mapped to the request - body. This enables the following alternative definition of the update - method: service Messaging { rpc UpdateMessage(Message) returns (Message) - { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: - "*" }; } } message Message { string message_id = 1; string text = 2; } - The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC - -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | - `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using - `*` in the body mapping, it is not possible to have HTTP parameters, as - all fields not bound by the path end in the body. This makes this option - more rarely used in practice when defining REST APIs. The common usage - of `*` is in custom methods which don't use the URL at all for - transferring data. It is possible to define multiple HTTP methods for - one RPC by using the `additional_bindings` option. Example: service - Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option - (google.api.http) = { get: "/v1/messages/{message_id}" - additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } - }; } } message GetMessageRequest { string message_id = 1; string user_id - = 2; } This enables the following two alternative HTTP JSON to RPC - mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | - `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | - `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP - mapping 1. Leaf request fields (recursive expansion nested messages in - the request message) are classified into three categories: - Fields - referred by the path template. They are passed via the URL path. - - Fields referred by the HttpRule.body. They are passed via the HTTP - request body. - All other fields are passed via the URL query - parameters, and the parameter name is the field path in the request - message. A repeated field can be represented as multiple query - parameters under the same name. 2. If HttpRule.body is "*", there is no - URL query parameter, all fields are passed via URL path and HTTP request - body. 3. If HttpRule.body is omitted, there is no HTTP request body, all - fields are passed via URL path and URL query parameters. ### Path - template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { - "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = - "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; - Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. - The syntax `**` matches zero or more URL path segments, which must be - the last part of the URL path except the `Verb`. The syntax `Variable` - matches part of the URL path as specified by its template. A variable - template must not contain other variables. If a variable matches a - single path segment, its template may be omitted, e.g. `{var}` is - equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in - the URL path. If the `LITERAL` contains any reserved character, such - characters should be percent-encoded before the matching. If a variable - contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, - when such a variable is expanded into a URL path on the client side, all - characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side - does the reverse decoding. Such variables show up in the [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{var}`. If a variable contains multiple path segments, such as - `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a - URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` - are percent-encoded. The server side does the reverse decoding, except - "%2F" and "%2f" are left unchanged. Such variables show up in the - [Discovery - Document](https://developers.google.com/discovery/v1/reference/apis) as - `{+var}`. ## Using gRPC API Service Configuration gRPC API Service - Configuration (service config) is a configuration language for - configuring a gRPC service to become a user-facing product. The service - config is simply the YAML representation of the `google.api.Service` - proto message. As an alternative to annotating your proto file, you can - configure gRPC transcoding in your service config YAML files. You do - this by specifying a `HttpRule` that maps the gRPC method to a REST - endpoint, achieving the same effect as the proto annotation. This can be - particularly useful if you have a proto that is reused in multiple - services. Note that any transcoding specified in the service config will - override any matching transcoding configuration in the proto. Example: - http: rules: # Selects a gRPC method and applies HttpRule to it. - - selector: example.v1.Messaging.GetMessage get: - /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC - Transcoding is used to map a gRPC to JSON REST endpoints, the proto to - JSON conversion must follow the [proto3 - specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - While the single segment variable follows the semantics of [RFC - 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String - Expansion, the multi segment variable **does not** follow RFC 6570 - Section 3.2.3 Reserved Expansion. The reason is that the Reserved - Expansion does not expand special characters like `?` and `#`, which - would lead to invalid URLs. As the result, gRPC Transcoding uses a - custom encoding for multi segment variables. The path variables **must - not** refer to any repeated or mapped field, because client libraries - are not capable of handling such variable expansion. The path variables - **must not** capture the leading "/" character. The reason is that the - most common use case "{var}" does not capture the leading "/" character. - For consistency, all path variables must share the same behavior. - Repeated message fields must not be mapped to URL query parameters, - because no client library can support such complicated mapping. If an - API needs to use a JSON array for request or response body, it can map - the request or response body to a repeated field. However, some gRPC - Transcoding implementations may not support this feature. - id: HttpRule + Defines a metric type and its schema. Once a metric descriptor is + created, deleting or altering it stops data collection and makes the + metric type's existing data unusable. + type: object + properties: + displayName: + type: string + description: >- + A concise name for the metric, which can be displayed in user + interfaces. Use sentence case without an ending period, for example + "Request count". This field is optional but it is recommended to be + set for any metrics associated with user-visible concepts, such as + Quota. + description: + type: string + description: >- + A detailed description of the metric, which can be used in + documentation. + type: + type: string + description: >- + The metric type, including its DNS name prefix. The type is not + URL-encoded. All user-defined metric types have the DNS name + `custom.googleapis.com` or `external.googleapis.com`. Metric types + should use a natural hierarchical grouping. For example: + "custom.googleapis.com/invoice/paid/amount" + "external.googleapis.com/prometheus/up" + "appengine.googleapis.com/http/server/response_latencies" + monitoredResourceTypes: + description: >- + Read-only. If present, then a time series, which is identified + partially by a metric type and a MonitoredResourceDescriptor, that + is associated with this metric type can only be associated with one + of the monitored resource types listed here. + items: + type: string + type: array + valueType: + enumDescriptions: + - Do not use this default value. + - >- + The value is a boolean. This value type can be used only if the + metric kind is `GAUGE`. + - The value is a signed 64-bit integer. + - The value is a double precision floating point number. + - >- + The value is a text string. This value type can be used only if + the metric kind is `GAUGE`. + - The value is a `Distribution`. + - The value is money. + description: >- + Whether the measurement is an integer, a floating-point number, etc. + Some combinations of `metric_kind` and `value_type` might not be + supported. + enum: + - VALUE_TYPE_UNSPECIFIED + - BOOL + - INT64 + - DOUBLE + - STRING + - DISTRIBUTION + - MONEY + type: string + metricKind: + enumDescriptions: + - Do not use this default value. + - An instantaneous measurement of a value. + - The change in a value during a time interval. + - >- + A value accumulated over a time interval. Cumulative measurements + in a time series should have the same start time and increasing + end times, until an event resets the cumulative value to zero and + sets a new start time for the following points. + description: >- + Whether the metric records instantaneous values, changes to a value, + etc. Some combinations of `metric_kind` and `value_type` might not + be supported. + enum: + - METRIC_KIND_UNSPECIFIED + - GAUGE + - DELTA + - CUMULATIVE + type: string + name: + type: string + description: The resource name of the metric descriptor. + launchStage: + type: string + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + description: Optional. The launch stage of the metric definition. + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + metadata: + description: Optional. Metadata which can be used to guide usage of the metric. + $ref: '#/components/schemas/MetricDescriptorMetadata' + unit: + description: >- + The units in which the metric value is reported. It is only + applicable if the `value_type` is `INT64`, `DOUBLE`, or + `DISTRIBUTION`. The `unit` defines the representation of the stored + metric values. Different systems might scale the values to be more + easily displayed (so a value of `0.02kBy` _might_ be displayed as + `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). + However, if the `unit` is `kBy`, then the value of the metric is + always in thousands of bytes, no matter how it might be displayed. + If you want a custom metric to record the exact number of + CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` + metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just + `s`). If the job uses 12,005 CPU-seconds, then the value is written + as `12005`. Alternatively, if you want a custom metric to record + data in a more granular way, you can create a `DOUBLE CUMULATIVE` + metric whose `unit` is `ks{CPU}`, and then write the value `12.005` + (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which + is `12005/1024`). The supported units are a subset of [The Unified + Code for Units of Measure](https://unitsofmeasure.org/ucum.html) + standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` + second * `min` minute * `h` hour * `d` day * `1` dimensionless + **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga + (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` + zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro + (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) + * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` + kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) + * `Pi` pebi (2^50) **Grammar** The grammar also includes these + connectors: * `/` division or ratio (as an infix operator). For + examples, `kBy/{email}` or `MiBy/10ms` (although you should almost + never have `/s` in a metric `unit`; rates should always be computed + at query time from the underlying cumulative or delta value). * `.` + multiplication or composition (as an infix operator). For examples, + `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: + Expression = Component { "." Component } { "/" Component } ; + Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | + "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a + comment if it follows a `UNIT`. If the annotation is used alone, + then the unit is equivalent to `1`. For examples, `{request}/s == + 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of + non-blank printable ASCII characters not containing `{` or `}`. * + `1` represents a unitary [dimensionless + unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, + such as in `1/s`. It is typically used when none of the basic units + are appropriate. For example, "new users per day" can be represented + as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 + new users). Alternatively, "thousands of page views per day" would + be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a + metric value of `5.3` would mean "5300 page views per day"). * `%` + represents dimensionless value of 1/100, and annotates values giving + a percentage (so the metric values are typically in the range of + 0..100, and a metric value `3` means "3 percent"). * `10^2.%` + indicates a metric contains a ratio, typically in the range 0..1, + that will be multiplied by 100 and displayed as a percentage (so a + metric value `0.03` means "3 percent"). + type: string + labels: + items: + $ref: '#/components/schemas/LabelDescriptor' + type: array + description: >- + The set of labels that can be used to describe a specific instance + of this metric type. For example, the + `appengine.googleapis.com/http/server/response_latencies` metric + type has a label for the HTTP response code, `response_code`, so you + can look at latencies for successful responses or just for responses + that failed. + id: MetricDescriptor + ContextRule: + description: >- + A context rule provides information about the context for an individual + API element. + id: ContextRule + properties: + allowedRequestExtensions: + items: + type: string + type: array + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from client to backend. + requested: + description: >- + A list of full type names of requested contexts, only the requested + context will be made available to the backend. + items: + type: string + type: array + provided: + items: + type: string + description: >- + A list of full type names of provided contexts. It is used to + support propagating HTTP headers and ETags from the response + extension. + type: array + allowedResponseExtensions: + type: array + description: >- + A list of full type names or extension IDs of extensions allowed in + grpc side channel from backend to client. + items: + type: string + selector: + type: string + description: >- + Selects the methods to which this rule applies. Refer to selector + for syntax details. + type: object + Impact: + id: Impact + description: A message to group impacts of updating a policy. + properties: + impactType: + type: string + enum: + - IMPACT_TYPE_UNSPECIFIED + - DEPENDENCY_MISSING_DEPENDENCIES + description: Output only. The type of impact. + enumDescriptions: + - >- + Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 + Block 0 - Special/Admin codes Block 1 - Impact Type of + ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of + ANALYSIS_TYPE_RESOURCE_USAGE ... + - Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY + readOnly: true + detail: + type: string + description: Output only. User friendly impact detail in a free form message. + readOnly: true + type: object + Logging: + properties: + consumerDestinations: + description: >- + Logging configurations for sending logs to the consumer project. + There can be multiple consumer destinations, each one must have a + different monitored resource type. A log can be used in at most one + consumer destination. + type: array + items: + $ref: '#/components/schemas/LoggingDestination' + producerDestinations: + type: array + description: >- + Logging configurations for sending logs to the producer project. + There can be multiple producer destinations, each one must have a + different monitored resource type. A log can be used in at most one + producer destination. + items: + $ref: '#/components/schemas/LoggingDestination' + description: >- + Logging configuration of the service. The following example shows how to + configure logs to be sent to the producer and consumer projects. In the + example, the `activity_history` log is sent to both the producer and + consumer projects, whereas the `purchase_history` log is only sent to + the producer project. monitored_resources: - type: + library.googleapis.com/branch labels: - key: /city description: The city + where the library branch is located in. - key: /name description: The + name of the branch. logs: - name: activity_history labels: - key: + /customer_id - name: purchase_history logging: producer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history - purchase_history consumer_destinations: - + monitored_resource: library.googleapis.com/branch logs: - + activity_history + type: object + id: Logging + Documentation: + properties: + sectionOverrides: + items: + $ref: '#/components/schemas/Page' + description: >- + Specifies section and content to override boilerplate content + provided by go/api-docgen. Currently overrides following sections: + 1. rest.service.client_libraries + type: array + documentationRootUrl: + type: string + description: The URL to the root of documentation. + overview: + description: >- + Declares a single overview page. For example: documentation: + summary: ... overview: (== include overview.md ==) This is a + shortcut for the following declaration (using pages style): + documentation: summary: ... pages: - name: Overview content: (== + include overview.md ==) Note: you cannot specify both `overview` + field and `pages` field. + type: string + pages: + description: The top level pages for the documentation set. + type: array + items: + $ref: '#/components/schemas/Page' + serviceRootUrl: + type: string + description: >- + Specifies the service root url if the default one (the service name + from the yaml file) is not suitable. This can be seen in any fully + specified service urls as well as sections that show a base that + other urls are relative to. + rules: + type: array + description: >- + A list of documentation rules that apply to individual API elements. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/DocumentationRule' + summary: + description: >- + A short description of what the service does. The summary must be + plain text. It becomes the overview of the service displayed in + Google Cloud Console. NOTE: This field is equivalent to the standard + field `description`. + type: string + id: Documentation + description: >- + `Documentation` provides the information for describing a service. + Example: documentation: summary: > The Google Calendar API gives access + to most calendar features. pages: - name: Overview content: (== include + google/foo/overview.md ==) - name: Tutorial content: (== include + google/foo/tutorial.md ==) subpages: - name: Java content: (== include + google/foo/tutorial_java.md ==) rules: - selector: + google.calendar.Calendar.Get description: > ... - selector: + google.calendar.Calendar.Put description: > ... Documentation is + provided in markdown syntax. In addition to standard markdown features, + definition lists, tables and fenced code blocks are supported. Section + headers can be provided and are interpreted relative to the section + nesting of the context where a documentation fragment is embedded. + Documentation from the IDL is merged with documentation defined via the + config at normalization time, where documentation provided by config + rules overrides IDL provided. A number of constructs specific to the API + platform are supported in documentation text. In order to reference a + proto element, the following notation can be used: + [fully.qualified.proto.name][] To override the display text used for the + link, this can be used: [display text][fully.qualified.proto.name] Text + can be excluded from doc using the following notation: (-- internal + comment --) A few directives are available in documentation. Note that + directives must appear on a single line to be properly identified. The + `include` directive includes a markdown file from an external source: + (== include path/to/file ==) The `resource_for` directive marks a + message to be the resource of a collection in REST view. If it is not + specified, tools attempt to infer the resource from the operations in a + collection: (== resource_for v1.shelves.books ==) The directive + `suppress_warning` does not directly affect documentation and is + documented together with service config validation. + type: object + SystemParameter: + type: object + id: SystemParameter + properties: + name: + type: string + description: >- + Define the name of the parameter, such as "api_key" . It is case + sensitive. + httpHeader: + description: >- + Define the HTTP header name to use for the parameter. It is case + insensitive. + type: string + urlQueryParameter: + type: string + description: >- + Define the URL query parameter name to use for the parameter. It is + case sensitive. + description: >- + Define a parameter's name and location. The parameter may be passed as + either an HTTP header or a URL query parameter, and if both are passed + the behavior is implementation-dependent. + BatchCreateConsumerOverridesResponse: + id: BatchCreateConsumerOverridesResponse + type: object + properties: + overrides: + items: + $ref: '#/components/schemas/QuotaOverride' + type: array + description: The overrides that were created. + description: Response message for BatchCreateConsumerOverrides + LogDescriptor: + description: >- + A description of a log type. Example in YAML format: - name: + library.googleapis.com/activity_history description: The history of + borrowing and returning library items. display_name: Activity labels: - + key: /customer_id description: Identifier of a library customer + properties: + name: + type: string + description: >- + The name of the log. It must be less than 512 characters long and + can include the following characters: upper- and lower-case + alphanumeric characters [A-Za-z0-9], and punctuation characters + including slash, underscore, hyphen, period [/_-.]. + description: + description: >- + A human-readable description of this log. This information appears + in the documentation and can contain details. + type: string + labels: + items: + $ref: '#/components/schemas/LabelDescriptor' + description: >- + The set of labels that are available to describe a specific log + entry. Runtime requests that contain labels not specified here are + considered invalid. + type: array + displayName: + description: >- + The human-readable name for this log. This information appears on + the user interface and should be concise. + type: string + type: object + id: LogDescriptor + SystemParameterRule: + type: object + properties: + selector: + description: >- + Selects the methods to which this rule applies. Use '*' to indicate + all methods in all APIs. Refer to selector for syntax details. + type: string + parameters: + type: array + description: >- + Define parameters. Multiple names may be defined for a parameter. + For a given method call, only one of them should be used. If + multiple names are used the behavior is implementation-dependent. If + none of the specified names are present the behavior is + parameter-dependent. + items: + $ref: '#/components/schemas/SystemParameter' + id: SystemParameterRule + description: >- + Define a system parameter rule mapping system parameter definitions to + methods. + DeleteAdminQuotaPolicyMetadata: + type: object + properties: {} + description: >- + Metadata message that provides information such as progress, partial + failures, and similar information on each GetOperation call of LRO + returned by DeleteAdminQuotaPolicy. + id: DeleteAdminQuotaPolicyMetadata + CustomHttpPattern: + id: CustomHttpPattern + properties: + path: + description: The path matched by this custom verb. + type: string + kind: + type: string + description: The name of this custom HTTP verb. + type: object + description: A custom pattern is used for defining custom HTTP verb. + Backend: + properties: + rules: + type: array + description: >- + A list of API backend rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/BackendRule' + type: object + id: Backend + description: '`Backend` defines the backend configuration for a service.' + BatchCreateAdminOverridesResponse: + type: object + id: BatchCreateAdminOverridesResponse + properties: + overrides: + type: array + items: + $ref: '#/components/schemas/QuotaOverride' + description: The overrides that were created. + description: Response message for BatchCreateAdminOverrides + AddEnableRulesMetadata: + properties: {} + description: Metadata for the `AddEnableRules` method. + id: AddEnableRulesMetadata + type: object + SourceInfo: + properties: + sourceFiles: + description: All files used during config generation. + type: array + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + id: SourceInfo + description: Source information used to create a Service Config + type: object + EnableRule: + type: object + id: EnableRule + properties: + values: + description: >- + The names of the services or service groups that are enabled. + Example: `services/storage.googleapis.com`, `groups/googleServices`, + `groups/allServices`. + type: array + items: + type: string + services: + description: >- + DEPRECATED: Please use field `values`. Service should have prefix + `services/`. The names of the services that are enabled. Example: + `storage.googleapis.com`. + deprecated: true + items: + type: string + type: array + groups: + deprecated: true + description: >- + DEPRECATED: Please use field `values`. Service group should have + prefix `groups/`. The names of the service groups that are enabled + (Not Implemented). Example: `groups/googleServices`. + type: array + items: + type: string + enableType: + description: Client and resource project enable type. + enumDescriptions: + - >- + Unspecified enable type, which means enabled as both client and + resource project. + - >- + Enable all clients under the CRM node specified by + `ConsumerPolicy.name` to use the listed services. A client can be + an API key, an OAuth client, or a service account. + - >- + Enable resources in the list services to be created and used under + the CRM node specified by the `ConsumerPolicy.name`. + - >- + Activation made by Service Usage v1 API. This will be how + consumers differentiate between policy changes made by v1 and v2 + clients and understand what is actually possible based on those + different policies. + type: string + enum: + - ENABLE_TYPE_UNSPECIFIED + - CLIENT + - RESOURCE + - V1_COMPATIBLE + description: >- + The consumer policy rule that defines usable services and service + groups. + FieldPolicy: + type: object + id: FieldPolicy + properties: + resourcePermission: + type: string + description: >- + Specifies the required permission(s) for the resource referred to by + the field. It requires the field contains a valid resource + reference, and the request must pass the permission checks to + proceed. For example, "resourcemanager.projects.get". + resourceType: + type: string + description: >- + Specifies the resource type for the resource referred to by the + field. + selector: + type: string + description: >- + Selects one or more request or response message fields to apply this + `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the + selector must be left as empty. The service config generator will + automatically fill the correct value. When a `FieldPolicy` is used + in service config, the selector must be a comma-separated string + with valid request or response field paths, such as "foo.bar" or + "foo.bar,foo.baz". + description: >- + Google API Policy Annotation This message defines a simple API policy + annotation that can be used to annotate API request and response message + fields with applicable policies. One field may have multiple applicable + policies that must all be satisfied before a request can be processed. + This policy annotation is used to generate the overall policy that will + be used for automatic runtime policy enforcement and documentation + generation. + DotnetSettings: + description: Settings for Dotnet client libraries. + properties: + handwrittenSignatures: + items: + type: string + type: array + description: >- + Method signatures (in the form "service.method(signature)") which + are provided separately, so shouldn't be generated. Snippets + *calling* these methods are still generated, however. + renamedServices: + type: object + description: >- + Map from original service names to renamed versions. This is used + when the default generated types would cause a naming conflict. + (Neither name is fully-qualified.) Example: Subscriber to + SubscriberServiceApi. + additionalProperties: + type: string + forcedNamespaceAliases: + type: array + items: + type: string + description: >- + Namespaces which must be aliased in snippets due to a known (but + non-generator-predictable) naming collision + renamedResources: + type: object + additionalProperties: + type: string + description: >- + Map from full resource types to the effective short name for the + resource. This is used when otherwise resource named from different + services would cause naming collisions. Example entry: + "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + ignoredResources: + description: >- + List of full resource types to ignore during generation. This is + typically used for API-specific Location resources, which should be + handled by the generator as if they were actually the common + Location resources. Example entry: + "documentai.googleapis.com/Location" + type: array + items: + type: string + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + type: object + id: DotnetSettings + ServiceIdentity: properties: - post: + uniqueId: + description: >- + The unique and stable id of the service account. + https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount + type: string + email: type: string description: >- - Maps to HTTP POST. Used for creating a resource or performing an - action. - selector: + The email address of the service account that a service producer + would use to access consumer resources. + type: object + id: ServiceIdentity + description: >- + Service identity for a service. This is the identity that service + producer should use to access consumer resources. + ListServicesResponse: + description: Response message for the `ListServices` method. + properties: + services: + items: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + type: array + description: The available services for the requested project. + nextPageToken: + description: >- + Token that can be passed to `ListServices` to resume a paginated + query. + type: string + type: object + id: ListServicesResponse + DocumentationRule: + type: object + id: DocumentationRule + properties: + deprecationDescription: type: string description: >- - Selects a method to which this rule applies. Refer to selector for - syntax details. - patch: - description: Maps to HTTP PATCH. Used for updating a resource. + Deprecation description of the selected element(s). It can be + provided if an element is marked as `deprecated`. + disableReplacementWords: type: string - responseBody: description: >- - Optional. The name of the response field whose value is mapped to - the HTTP response body. When omitted, the entire response message - will be used as the HTTP response body. NOTE: The referred field - must be present at the top-level of the response message type. + String of comma or space separated case-sensitive words for which + method/field name replacement will be disabled by go/api-docgen. + description: type: string - get: + description: >- + Description of the selected proto element (e.g. a message, a method, + a 'service' definition, or a field). Defaults to leading & trailing + comments taken from the proto source definition of the proto + element. + selector: type: string description: >- - Maps to HTTP GET. Used for listing and getting information about - resources. - delete: - description: Maps to HTTP DELETE. Used for deleting a resource. + The selector is a comma-separated list of patterns for any element + such as a method, a field, an enum value. Each pattern is a + qualified name of the element which may end in "*", indicating a + wildcard. Wildcards are only allowed at the end and for a whole + component of the qualified name, i.e. "foo.*" is ok, but not + "foo.b*" or "foo.*.bar". A wildcard will match one or more + components. To specify a default for all applicable elements, the + whole pattern "*" is used. + description: A documentation rule provides information about individual API elements. + ListOperationsResponse: + properties: + operations: + items: + $ref: '#/components/schemas/Operation' + type: array + description: >- + A list of operations that matches the specified filter in the + request. + nextPageToken: type: string - custom: - $ref: '#/components/schemas/CustomHttpPattern' + description: The standard List next-page token. + description: The response message for Operations.ListOperations. + id: ListOperationsResponse + type: object + Operation: + type: object + id: Operation + description: >- + This resource represents a long-running operation that is the result of + a network API call. + properties: + response: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. description: >- - The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - put: + The normal, successful response of the operation. If the original + method returns no data on success, such as `Delete`, the response is + `google.protobuf.Empty`. If the original method is standard + `Get`/`Create`/`Update`, the response should be the resource. For + other methods, the response should have the type `XxxResponse`, + where `Xxx` is the original method name. For example, if the + original method name is `TakeSnapshot()`, the inferred response type + is `TakeSnapshotResponse`. + type: object + metadata: + description: >- + Service-specific metadata associated with the operation. It + typically contains progress information and common metadata such as + create time. Some services might not provide such metadata. Any + method that returns a long-running operation should document the + metadata type, if any. + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object + name: type: string - description: Maps to HTTP PUT. Used for replacing a resource. - additionalBindings: - items: - $ref: '#/components/schemas/HttpRule' description: >- - Additional HTTP bindings for the selector. Nested bindings must not - contain an `additional_bindings` field themselves (that is, the - nesting may only be one level deep). - type: array - body: + The server-assigned name, which is only unique within the same + service that originally returns it. If you use the default HTTP + mapping, the `name` should be a resource name ending with + `operations/{unique_id}`. + done: + type: boolean description: >- - The name of the request field whose value is mapped to the HTTP - request body, or `*` for mapping all request fields not captured by - the path pattern to the HTTP body, or omitted for not having any - HTTP request body. NOTE: the referred field must be present at the - top-level of the request message type. + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/Status' + NodeSettings: + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + description: Settings for Node client libraries. + id: NodeSettings + type: object + JavaSettings: + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + serviceClassNames: + additionalProperties: + type: string + type: object + description: >- + Configure the Java class name to use instead of the service's for + its corresponding generated GAPIC client. Keys are fully-qualified + service names as they appear in the protobuf (including the full the + language_settings.java.interface_names" field in gapic.yaml. API + teams should otherwise use the service name as it appears in the + protobuf. Example of a YAML configuration:: publishing: + java_settings: service_class_names: - google.pubsub.v1.Publisher: + TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin + libraryPackage: type: string + description: >- + The package name to use in Java. Clobbers the java_package option + set in the protobuf. This should be used **only** by APIs who have + already set the language_settings.java.package_name" field in + gapic.yaml. API teams should use the protobuf java_package option + where possible. Example of a YAML configuration:: publishing: + java_settings: library_package: com.google.cloud.pubsub.v1 + id: JavaSettings + description: Settings for Java client libraries. type: object - EnableServiceRequest: - description: Request message for the `EnableService` method. - properties: {} + EnableFailure: + properties: + serviceId: + description: The service id of a service that could not be enabled. + type: string + errorMessage: + type: string + description: An error message describing why the service could not be enabled. + description: Provides error messages for the failing services. + id: EnableFailure type: object - id: EnableServiceRequest - SystemParameter: - id: SystemParameter + EnableServiceResponse: + type: object + id: EnableServiceResponse description: >- - Define a parameter's name and location. The parameter may be passed as - either an HTTP header or a URL query parameter, and if both are passed - the behavior is implementation-dependent. + Response message for the `EnableService` method. This response message + is assigned to the `response` field of the returned Operation when that + operation is done. + properties: + service: + description: The new state of the service after enabling. + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + AuthProvider: + description: >- + Configuration for an authentication provider, including support for + [JSON Web Token + (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). type: object + id: AuthProvider properties: - urlQueryParameter: + jwtLocations: + items: + $ref: '#/components/schemas/JwtLocation' + type: array + description: >- + Defines the locations to extract the JWT. For now it is only used by + the Cloud Endpoints to store the OpenAPI extension + [x-google-jwt-locations] + (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) + JWT locations can be one of HTTP headers, URL query parameters or + cookies. The rule is that the first match wins. If not specified, + default to use following 3 locations: 1) Authorization: Bearer 2) + x-goog-iap-jwt-assertion 3) access_token query parameter Default + locations can be specified as followings: jwt_locations: - header: + Authorization value_prefix: "Bearer " - header: + x-goog-iap-jwt-assertion - query: access_token + id: description: >- - Define the URL query parameter name to use for the parameter. It is - case sensitive. + The unique identifier of the auth provider. It will be referred to + by `AuthRequirement.provider_id`. Example: "bookstore_auth". type: string - name: + authorizationUrl: type: string description: >- - Define the name of the parameter, such as "api_key" . It is case - sensitive. - httpHeader: + Redirect URL if JWT token is required but not present or is expired. + Implement authorizationUrl of securityDefinitions in OpenAPI spec. + audiences: + description: >- + The list of JWT + [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + that are allowed to access. A JWT containing any of these audiences + will be accepted. When this setting is absent, JWTs with audiences: + - "https://[service.name]/[google.protobuf.Api.name]" - + "https://[service.name]/" will be accepted. For example, if no + audiences are in the setting, LibraryService API will accept JWTs + with the following audiences: - + https://library-example.googleapis.com/google.example.library.v1.LibraryService + - https://library-example.googleapis.com/ Example: audiences: + bookstore_android.apps.googleusercontent.com, + bookstore_web.apps.googleusercontent.com + type: string + jwksUri: type: string description: >- - Define the HTTP header name to use for the parameter. It is case - insensitive. - GoogleApiServiceusageV1beta1GetServiceIdentityResponse: - description: Response message for getting service identity. - id: GoogleApiServiceusageV1beta1GetServiceIdentityResponse + URL of the provider's public key set to validate signature of the + JWT. See [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + Optional if the key set document: - can be retrieved from [OpenID + Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) + of the issuer. - can be inferred from the email domain of the issuer + (e.g. a Google service account). Example: + https://www.googleapis.com/oauth2/v1/certs + issuer: + description: >- + Identifies the principal that issued the JWT. See + https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + Usually a URL or an email address. Example: + https://securetoken.google.com Example: + 1234567-compute@developer.gserviceaccount.com + type: string + CustomErrorRule: properties: - identity: + selector: description: >- - Service identity that service producer can use to access consumer - resources. If exists is true, it contains email and unique_id. If - exists is false, it contains pre-constructed email and empty - unique_id. - $ref: '#/components/schemas/GoogleApiServiceusageV1beta1ServiceIdentity' - state: - enum: - - IDENTITY_STATE_UNSPECIFIED - - ACTIVE - description: Service identity state. + Selects messages to which this rule applies. Refer to selector for + syntax details. type: string - enumDescriptions: - - >- - Default service identity state. This value is used if the state is - omitted. - - Service identity has been created and can be used. + isErrorType: + description: >- + Mark this message as possible payload in error response. Otherwise, + objects of this type will be filtered when they appear in error + payload. + type: boolean + id: CustomErrorRule type: object - BatchEnableServicesResponse: + description: A custom error rule. + AnalyzeConsumerPolicyMetadata: type: object + description: Metadata for the `AnalyzeConsumerPolicy` method. + id: AnalyzeConsumerPolicyMetadata + properties: {} + SourceContext: description: >- - Response message for the `BatchEnableServices` method. This response - message is assigned to the `response` field of the returned Operation - when that operation is done. - id: BatchEnableServicesResponse + `SourceContext` represents information about the source of a protobuf + element, like the file in which it is defined. + id: SourceContext properties: - failures: + fileName: + type: string description: >- - If allow_partial_success is true, and one or more services could not - be enabled, this field contains the details about each failure. - items: - $ref: '#/components/schemas/EnableFailure' - type: array - services: - items: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - description: The new state of the services after enabling. - type: array - CustomHttpPattern: - id: CustomHttpPattern + The path-qualified name of the .proto file that contained the + associated protobuf element. For example: + `"google/protobuf/source_context.proto"`. + type: object + GoogleApiServiceusageV1ServiceConfig: + id: GoogleApiServiceusageV1ServiceConfig type: object + description: The configuration of the service. properties: - path: - type: string - description: The path matched by this custom verb. - kind: + name: + description: >- + The DNS address at which this service is available. An example DNS + address would be: `calendar.googleapis.com`. type: string - description: The name of this custom HTTP verb. - description: A custom pattern is used for defining custom HTTP verb. - GoogleApiService: - properties: - billing: - $ref: '#/components/schemas/Billing' - description: Billing configuration. - apis: + endpoints: description: >- - A list of API interfaces exported by this service. Only the `name` - field of the google.protobuf.Api needs to be provided by the - configuration author, as the remaining fields will be derived from - the IDL during the normalization process. It is an error to specify - an API interface here which cannot be resolved against the - associated IDL files. + Configuration for network endpoints. Contains only the names and + aliases of the endpoints. + items: + $ref: '#/components/schemas/Endpoint' + type: array + documentation: + description: >- + Additional API documentation. Contains only the summary and the + documentation URL. + $ref: '#/components/schemas/Documentation' + apis: type: array items: $ref: '#/components/schemas/Api' + description: >- + A list of API interfaces exported by this service. Contains only the + names, versions, and method names of the interfaces. + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + title: + description: The product title for this service. + type: string monitoring: - description: Monitoring configuration. $ref: '#/components/schemas/Monitoring' - title: description: >- - The product title for this service, it is the name displayed in - Google Cloud Console. + Monitoring configuration. This should not include the + 'producer_destinations' field. + usage: + description: Configuration controlling usage of this service. + $ref: '#/components/schemas/Usage' + authentication: + $ref: '#/components/schemas/Authentication' + description: Auth configuration. Contains only the OAuth rules. + monitoredResources: + type: array + description: >- + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + CancelOperationRequest: + type: object + description: The request message for Operations.CancelOperation. + id: CancelOperationRequest + properties: {} + QuotaOverride: + type: object + properties: + metric: type: string - logging: - $ref: '#/components/schemas/Logging' - description: Logging configuration. - documentation: - $ref: '#/components/schemas/Documentation' - description: Additional API documentation. - producerProjectId: + description: >- + The name of the metric to which this override applies. An example + name would be: `compute.googleapis.com/cpus` + unit: type: string - description: The Google project that owns this service. - http: - $ref: '#/components/schemas/Http' - description: HTTP configuration. - publishing: - $ref: '#/components/schemas/Publishing' description: >- - Settings for [Google Cloud Client - libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - generated from APIs defined as protocol buffers. - control: - description: Configuration for the service control plane. - $ref: '#/components/schemas/Control' - backend: - $ref: '#/components/schemas/Backend' - description: API backend configuration. - configVersion: + The limit unit of the limit to which this override applies. An + example unit would be: `1/{project}/{region}` Note that `{project}` + and `{region}` are not placeholders in this example; the literal + characters `{` and `}` occur in the string. + dimensions: + additionalProperties: + type: string description: >- - Obsolete. Do not use. This field has no semantic meaning. The - service config compiler always sets this field to `3`. - type: integer - format: uint32 - endpoints: + If this map is nonempty, then this override applies only to specific + values for dimensions defined in the limit unit. For example, an + override on a limit with the unit `1/{project}/{region}` could + contain an entry with the key `region` and the value `us-east-1`; + the override is only applied to quota consumed in that region. This + map has the following restrictions: * Keys that are not defined in + the limit's unit are not valid keys. Any string appearing in + `{brackets}` in the unit (besides `{project}` or `{user}`) is a + defined key. * `project` is not a valid key; the project is already + specified in the parent resource name. * `user` is not a valid key; + the API does not support quota overrides that apply only to a + specific user. * If `region` appears as a key, its value must be a + valid Cloud region. * If `zone` appears as a key, its value must be + a valid Cloud zone. * If any valid key other than `region` or `zone` + appears in the map, then all valid keys other than `region` or + `zone` must also appear in the map. + type: object + overrideValue: + format: int64 + type: string + description: >- + The overriding quota limit value. Can be any nonnegative integer, or + -1 (unlimited quota). + name: + type: string + description: >- + The resource name of the override. This name is generated by the + server when the override is created. Example names would be: + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` + `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` + The resource name is intended to be opaque and should not be parsed + for its component strings, since its representation could change in + the future. + adminOverrideAncestor: + description: >- + The resource name of the ancestor that requested the override. For + example: `organizations/12345` or `folders/67890`. Used by admin + overrides only. + type: string + description: A quota override + id: QuotaOverride + Type: + description: A protocol buffer message type. + type: object + properties: + oneofs: + description: The list of types appearing in `oneof` definitions in this type. + items: + type: string + type: array + sourceContext: + $ref: '#/components/schemas/SourceContext' + description: The source context. + options: + items: + $ref: '#/components/schemas/Option' + description: The protocol buffer options. + type: array + edition: description: >- - Configuration for network endpoints. If this is empty, then an - endpoint with the same name as the service is automatically - generated to service all defined APIs. + The source edition string, only valid when syntax is + SYNTAX_EDITIONS. + type: string + fields: + description: The list of fields. type: array items: - $ref: '#/components/schemas/Endpoint' + $ref: '#/components/schemas/Field' + syntax: + type: string + enum: + - SYNTAX_PROTO2 + - SYNTAX_PROTO3 + - SYNTAX_EDITIONS + enumDescriptions: + - Syntax `proto2`. + - Syntax `proto3`. + - Syntax `editions`. + description: The source syntax. name: type: string + description: The fully qualified message name. + id: Type + MonitoredResourceDescriptor: + type: object + id: MonitoredResourceDescriptor + properties: + description: description: >- - The service name, which is a DNS-like logical identifier for the - service, such as `calendar.googleapis.com`. The service name - typically goes through DNS verification to make sure the owner of - the service also owns the DNS name. - sourceInfo: - $ref: '#/components/schemas/SourceInfo' + Optional. A detailed description of the monitored resource type that + might be used in documentation. + type: string + displayName: + type: string description: >- - Output only. The source information for this configuration if - available. - authentication: - $ref: '#/components/schemas/Authentication' - description: Auth configuration. - metrics: - type: array - items: - $ref: '#/components/schemas/MetricDescriptor' - description: Defines the metrics used by this service. - systemTypes: - items: - $ref: '#/components/schemas/Type' + Optional. A concise name for the monitored resource type that might + be displayed in user interfaces. It should be a Title Cased Noun + Phrase, without any article or other determiners. For example, + `"Google Cloud SQL Database"`. + name: description: >- - A list of all proto message types included in this API service. It - serves similar purpose as [google.api.Service.types], except that - these types are not needed by user-defined APIs. Therefore, they - will not show up in the generated discovery doc. This field should - only be used to define system APIs in ESF. - type: array - quota: - $ref: '#/components/schemas/Quota' - description: Quota configuration. - context: - $ref: '#/components/schemas/Context' - description: Context configuration. - id: + Optional. The resource name of the monitored resource descriptor: + `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where + {type} is the value of the `type` field in this object and + {project_id} is a project ID that provides API-specific context for + accessing the type. APIs that do not use project information can use + the resource name format `"monitoredResourceDescriptors/{type}"`. type: string - description: >- - A unique ID for a specific instance of this message, typically - assigned by the client for tracking purpose. Must be no longer than - 63 characters and only lower case letters, digits, '.', '_' and '-' - are allowed. If empty, the server may choose to generate one - instead. - logs: - description: Defines the logs used by this service. - type: array - items: - $ref: '#/components/schemas/LogDescriptor' - usage: - $ref: '#/components/schemas/Usage' - description: Configuration controlling usage of this service. - customError: - $ref: '#/components/schemas/CustomError' - description: Custom error configuration. - enums: + launchStage: + description: Optional. The launch stage of the monitored resource definition. + enumDescriptions: + - Do not use this default value. + - The feature is not yet implemented. Users can not use it. + - >- + Prelaunch features are hidden from users and are only visible + internally. + - >- + Early Access features are limited to a closed group of testers. To + use these features, you must sign up in advance and sign a Trusted + Tester agreement (which includes confidentiality provisions). + These features may be unstable, changed in backward-incompatible + ways, and are not guaranteed to be released. + - >- + Alpha is a limited availability test for releases before they are + cleared for widespread use. By Alpha, all significant design + issues are resolved and we are in the process of verifying + functionality. Alpha customers need to apply for access, agree to + applicable terms, and have their projects allowlisted. Alpha + releases don't have to be feature complete, no SLAs are provided, + and there are no technical support obligations, but they will be + far enough along that customers can actually use them in test + environments or for limited-use tests -- just like they would in + normal production cases. + - >- + Beta is the point at which we are ready to open a release for any + customer to use. There are no SLA or technical support obligations + in a Beta release. Products will be complete from a feature + perspective, but may have some open outstanding issues. Beta + releases are suitable for limited production use cases. + - >- + GA features are open to all developers and are considered stable + and fully qualified for production use. + - >- + Deprecated features are scheduled to be shut down and removed. For + more information, see the "Deprecation Policy" section of our + [Terms of Service](https://cloud.google.com/terms/) and the + [Google Cloud Platform Subject to the Deprecation + Policy](https://cloud.google.com/terms/deprecation) documentation. + enum: + - LAUNCH_STAGE_UNSPECIFIED + - UNIMPLEMENTED + - PRELAUNCH + - EARLY_ACCESS + - ALPHA + - BETA + - GA + - DEPRECATED + type: string + labels: items: - $ref: '#/components/schemas/Enum' - description: >- - A list of all enum types included in this API service. Enums - referenced directly or indirectly by the `apis` are automatically - included. Enums which are not referenced but shall be included - should be listed here by name by the configuration author. Example: - enums: - name: google.someapi.v1.SomeEnum - type: array - monitoredResources: + $ref: '#/components/schemas/LabelDescriptor' description: >- - Defines the monitored resources used by this service. This is - required by the Service.monitoring and Service.logging - configurations. - type: array - items: - $ref: '#/components/schemas/MonitoredResourceDescriptor' - systemParameters: - $ref: '#/components/schemas/SystemParameters' - description: System parameter configuration. - types: + Required. A set of labels used to describe instances of this + monitored resource type. For example, an individual Google Cloud SQL + database is identified by values for the labels `"database_id"` and + `"zone"`. type: array + type: description: >- - A list of all proto message types included in this API service. - Types referenced directly or indirectly by the `apis` are - automatically included. Messages which are not referenced but shall - be included, such as types used by the `google.protobuf.Any` type, - should be listed here by name by the configuration author. Example: - types: - name: google.protobuf.Int32 - items: - $ref: '#/components/schemas/Type' + Required. The monitored resource type. For example, the type + `"cloudsql_database"` represents databases in Google Cloud SQL. For + a list of types, see [Monitored resource + types](https://cloud.google.com/monitoring/api/resources) and + [Logging resource + types](https://cloud.google.com/logging/docs/api/v2/resource-list). + type: string + description: >- + An object that describes the schema of a MonitoredResource object using + a type name and a set of labels. For example, the monitored resource + descriptor for Google Compute Engine VM instances has a type of + `"gce_instance"` and specifies the use of the labels `"instance_id"` and + `"zone"` to identify particular VM instances. Different APIs can support + different monitored resource types. APIs generally provide a `list` + method that returns the monitored resource descriptors used by the API. + CppSettings: + type: object + id: CppSettings + description: Settings for C++ client libraries. + properties: + common: + description: Some settings. + $ref: '#/components/schemas/CommonLanguageSettings' + Control: type: object description: >- - `Service` is the root object of Google API service configuration - (service config). It describes the basic information about a logical - service, such as the service name and the user-facing title, and - delegates other aspects to sub-sections. Each sub-section is either a - proto message or a repeated proto message that configures a specific - aspect, such as auth. For more information, see each proto message - definition. Example: type: google.api.Service name: - calendar.googleapis.com title: Google Calendar API apis: - name: - google.calendar.v3.Calendar visibility: rules: - selector: - "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: - "google.calendar.v3.*" address: calendar.example.com authentication: - providers: - id: google_calendar_auth jwks_uri: - https://www.googleapis.com/oauth2/v1/certs issuer: - https://securetoken.google.com rules: - selector: "*" requirements: - provider_id: google_calendar_auth - id: GoogleApiService - MethodSettings: - description: Describes the generator configuration for a method. - id: MethodSettings + Selects and configures the service controller used by the service. + Example: control: environment: servicecontrol.googleapis.com + properties: + environment: + type: string + description: >- + The service controller environment to use. If empty, no control + plane feature (like quota and billing) will be enabled. The + recommended value for most services is servicecontrol.googleapis.com + methodPolicies: + items: + $ref: '#/components/schemas/MethodPolicy' + type: array + description: Defines policies applying to the API methods of the service. + id: Control + OperationMetadata: + id: OperationMetadata + type: object + description: The operation metadata returned for the batchend services operation. properties: - autoPopulatedFields: + resourceNames: type: array description: >- - List of top-level fields of the request message, that should be - automatically populated by the client libraries based on their - (google.api.field_info).format. Currently supported format: UUID4. - Example of a YAML configuration: publishing: method_settings: - - selector: google.example.v1.ExampleService.CreateExample - auto_populated_fields: - request_id + The full name of the resources that this operation is directly + associated with. items: type: string - selector: - type: string - description: >- - The fully qualified name of the method, for which the options below - apply. This is used to find the method to apply the options. - Example: publishing: method_settings: - selector: - google.storage.control.v2.StorageControl.CreateFolder # method - settings for CreateFolder... - longRunning: - $ref: '#/components/schemas/LongRunning' - description: >- - Describes settings to use for long-running operations when - generating API methods for RPCs. Complements RPCs that use the - annotations in google/longrunning/operations.proto. Example of a - YAML configuration:: publishing: method_settings: - selector: - google.cloud.speech.v2.Speech.BatchRecognize long_running: - initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 - max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 - minutes + JwtLocation: + description: Specifies a location to extract JWT from an API request. type: object - AuthProvider: - id: AuthProvider + id: JwtLocation properties: - id: - type: string - description: >- - The unique identifier of the auth provider. It will be referred to - by `AuthRequirement.provider_id`. Example: "bookstore_auth". - audiences: - description: >- - The list of JWT - [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). - that are allowed to access. A JWT containing any of these audiences - will be accepted. When this setting is absent, JWTs with audiences: - - "https://[service.name]/[google.protobuf.Api.name]" - - "https://[service.name]/" will be accepted. For example, if no - audiences are in the setting, LibraryService API will accept JWTs - with the following audiences: - - https://library-example.googleapis.com/google.example.library.v1.LibraryService - - https://library-example.googleapis.com/ Example: audiences: - bookstore_android.apps.googleusercontent.com, - bookstore_web.apps.googleusercontent.com + cookie: + description: Specifies cookie name to extract JWT token. type: string - jwksUri: - description: >- - URL of the provider's public key set to validate signature of the - JWT. See [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). - Optional if the key set document: - can be retrieved from [OpenID - Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) - of the issuer. - can be inferred from the email domain of the issuer - (e.g. a Google service account). Example: - https://www.googleapis.com/oauth2/v1/certs + header: type: string - jwtLocations: - type: array + description: Specifies HTTP header name to extract JWT token. + valuePrefix: description: >- - Defines the locations to extract the JWT. For now it is only used by - the Cloud Endpoints to store the OpenAPI extension - [x-google-jwt-locations] - (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) - JWT locations can be one of HTTP headers, URL query parameters or - cookies. The rule is that the first match wins. If not specified, - default to use following 3 locations: 1) Authorization: Bearer 2) - x-goog-iap-jwt-assertion 3) access_token query parameter Default - locations can be specified as followings: jwt_locations: - header: - Authorization value_prefix: "Bearer " - header: - x-goog-iap-jwt-assertion - query: access_token - items: - $ref: '#/components/schemas/JwtLocation' - issuer: + The value prefix. The value format is "value_prefix{token}" Only + applies to "in" header type. Must be empty for "in" query type. If + not empty, the header value has to match (case sensitive) this + prefix. If not matched, JWT will not be extracted. If matched, JWT + will be extracted after the prefix is removed. For example, for + "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space + at the end. type: string - description: >- - Identifies the principal that issued the JWT. See - https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 - Usually a URL or an email address. Example: - https://securetoken.google.com Example: - 1234567-compute@developer.gserviceaccount.com - authorizationUrl: - description: >- - Redirect URL if JWT token is required but not present or is expired. - Implement authorizationUrl of securityDefinitions in OpenAPI spec. + query: type: string + description: Specifies URL query parameter name to extract JWT token. + LongRunning: type: object + id: LongRunning description: >- - Configuration for an authentication provider, including support for - [JSON Web Token - (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). - AdminQuotaPolicy: - id: AdminQuotaPolicy + Describes settings to use when generating API methods that use the + long-running operation pattern. All default values below are from those + used in the client library generators (e.g. + [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). properties: - unit: - type: string - description: >- - The limit unit of the limit to which this policy applies. An example - unit would be: `1/{project}/{region}` Note that `{project}` and - `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - name: + pollDelayMultiplier: + type: number description: >- - The resource name of the policy. This name is generated by the - server when the policy is created. Example names would be: - `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` + Multiplier to gradually increase delay between subsequent polls + until it reaches max_poll_delay. Default value: 1.5. + format: float + totalPollTimeout: type: string - policyValue: + description: 'Total polling timeout. Default value: 5 minutes.' + format: google-duration + maxPollDelay: + format: google-duration description: >- - The quota policy value. Can be any nonnegative integer, or -1 - (unlimited quota). + Maximum time between two subsequent poll requests. Default value: 45 + seconds. type: string - format: int64 - metric: + initialPollDelay: + format: google-duration type: string description: >- - The name of the metric to which this policy applies. An example name - would be: `compute.googleapis.com/cpus` - container: - description: >- - The cloud resource container at which the quota policy is created. - The format is `{container_type}/{container_number}` - type: string - dimensions: - additionalProperties: - type: string - type: object - description: ' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.' - description: Quota policy created by quota administrator. + Initial delay after which the first poll request will be made. + Default value: 5 seconds. + RemoveEnableRulesResponse: + id: RemoveEnableRulesResponse + description: The response message of `RemoveEnableRules` method. type: object - GoogleApiServiceusageV2alphaConsumerPolicy: properties: - enableRules: - type: array + removedValues: + description: The values removed from the parent consumer policy. items: - $ref: '#/components/schemas/GoogleApiServiceusageV2alphaEnableRule' - description: >- - Enable rules define usable services, groups, and categories. There - can currently be at most one `EnableRule`. This restriction will be - lifted in later releases. - etag: - description: >- - Output only. An opaque tag indicating the current version of the - policy, used for concurrency control. - readOnly: true - type: string - name: - type: string - readOnly: true - description: >- - Output only. The resource name of the policy. Only the `default` - policy is supported: `projects/12345/consumerPolicies/default`, - `folders/12345/consumerPolicies/default`, - `organizations/12345/consumerPolicies/default`. - annotations: - type: object - additionalProperties: type: string + type: array + deprecated: true + parent: description: >- - Optional. Annotations is an unstructured key-value map stored with a - policy that may be set by external tools to store and retrieve - arbitrary metadata. They are not queryable and should be preserved - when modifying objects. - [AIP-128](https://google.aip.dev/128#annotations) - updateTime: - type: string - description: Output only. The time the policy was last updated. - format: google-datetime - readOnly: true - createTime: - format: google-datetime - description: >- - Output only. The time the policy was created. For singleton - policies, this is the first touch of the policy. + The parent consumer policy. It can be + `projects/12345/consumerPolicies/default`, or + `folders/12345/consumerPolicies/default`, or + `organizations/12345/consumerPolicies/default`. type: string - readOnly: true - id: GoogleApiServiceusageV2alphaConsumerPolicy + Quota: + id: Quota type: object + properties: + metricRules: + items: + $ref: '#/components/schemas/MetricRule' + description: >- + List of MetricRule definitions, each one mapping a selected method + to one or more metrics. + type: array + limits: + items: + $ref: '#/components/schemas/QuotaLimit' + description: List of QuotaLimit definitions for the service. + type: array description: >- - Consumer Policy is a set of rules that define what services or service - groups can be used for a cloud resource hierarchy. - Mixin: - id: Mixin + Quota configuration helps to achieve fairness and budgeting in service + usage. The metric based quota configuration works this way: - The + service configuration defines a set of metrics. - For API calls, the + quota.metric_rules maps methods to metrics with corresponding costs. - + The quota.limits defines limits on the metrics, which will be used for + quota checks at runtime. An example quota configuration in yaml format: + quota: limits: - name: apiWriteQpsPerProject metric: + library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit + for consumer projects values: STANDARD: 10000 (The metric rules bind all + methods to the read_calls metric, except for the UpdateBook and + DeleteBook methods. These two methods are mapped to the write_calls + metric, with the UpdateBook method consuming at twice rate as the + DeleteBook method.) metric_rules: - selector: "*" metric_costs: + library.googleapis.com/read_calls: 1 - selector: + google.example.library.v1.LibraryService.UpdateBook metric_costs: + library.googleapis.com/write_calls: 2 - selector: + google.example.library.v1.LibraryService.DeleteBook metric_costs: + library.googleapis.com/write_calls: 1 Corresponding Metric definition: + metrics: - name: library.googleapis.com/read_calls display_name: Read + requests metric_kind: DELTA value_type: INT64 - name: + library.googleapis.com/write_calls display_name: Write requests + metric_kind: DELTA value_type: INT64 + EnumValue: type: object + description: Enum value definition. + id: EnumValue properties: - root: - type: string - description: >- - If non-empty specifies a path under which inherited HTTP paths are - rooted. + number: + description: Enum value number. + format: int32 + type: integer + options: + description: Protocol buffer options. + items: + $ref: '#/components/schemas/Option' + type: array name: type: string - description: The fully qualified name of the interface which is included. - description: >- - Declares an API Interface to be included in this interface. The - including interface must redeclare all the methods from the included - interface, but documentation and options are inherited as follows: - If - after comment and whitespace stripping, the documentation string of the - redeclared method is empty, it will be inherited from the original - method. - Each annotation belonging to the service config (http, - visibility) which is not set in the redeclared method will be inherited. - - If an http annotation is inherited, the path pattern will be modified - as follows. Any version prefix will be replaced by the version of the - including interface plus the root path if specified. Example of a simple - mixin: package google.acl.v1; service AccessControl { // Get the - underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v1/{resource=**}:getAcl"; } } package - google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) - returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns - (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example - of a mixin configuration: apis: - name: google.storage.v2.Storage - mixins: - name: google.acl.v1.AccessControl The mixin construct implies - that all methods in `AccessControl` are also declared with same name and - request/response types in `Storage`. A documentation generator or - annotation processor will see the effective `Storage.GetAcl` method - after inherting documentation and annotations as follows: service - Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) - returns (Acl) { option (google.api.http).get = - "/v2/{resource=**}:getAcl"; } ... } Note how the version in the path - pattern changed from `v1` to `v2`. If the `root` field in the mixin is - specified, it should be a relative path under which inherited HTTP paths - are placed. Example: apis: - name: google.storage.v2.Storage mixins: - - name: google.acl.v1.AccessControl root: acls This implies the following - inherited HTTP annotation: service Storage { // Get the underlying ACL - object. rpc GetAcl(GetAclRequest) returns (Acl) { option - (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... } + description: Enum value name. RubySettings: - properties: - common: - description: Some settings. - $ref: '#/components/schemas/CommonLanguageSettings' - type: object description: Settings for Ruby client libraries. id: RubySettings - BillingDestination: type: object - description: >- - Configuration of a specific billing destination (Currently only support - bill against consumer project). - properties: - metrics: - description: >- - Names of the metrics to report to this billing destination. Each - name must be defined in Service.metrics section. - type: array - items: - type: string - monitoredResource: - description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string - id: BillingDestination - PhpSettings: - description: Settings for Php client libraries. properties: common: $ref: '#/components/schemas/CommonLanguageSettings' description: Some settings. + BatchEnableServicesRequest: + properties: + serviceIds: + items: + type: string + type: array + description: >- + The identifiers of the services to enable on the project. A valid + identifier would be: serviceusage.googleapis.com Enabling services + requires that each service is public or is shared with the user + enabling the service. A single request can enable a maximum of 20 + services at a time. If more than 20 services are specified, the + request will fail, and no state changes will occur. + id: BatchEnableServicesRequest type: object - id: PhpSettings + description: Request message for the `BatchEnableServices` method. Billing: type: object + properties: + consumerDestinations: + type: array + items: + $ref: '#/components/schemas/BillingDestination' + description: >- + Billing configurations for sending metrics to the consumer project. + There can be multiple consumer destinations per service, each one + must have a different monitored resource type. A metric can be used + in at most one consumer destination. description: >- Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, @@ -3518,202 +3494,379 @@ components: monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count id: Billing + GoogleApiServiceusageV2alphaEnableRule: + id: GoogleApiServiceusageV2alphaEnableRule + type: object + description: >- + The consumer policy rule that defines enabled services, groups, and + categories. properties: - consumerDestinations: - items: - $ref: '#/components/schemas/BillingDestination' + services: type: array + items: + type: string description: >- - Billing configurations for sending metrics to the consumer project. - There can be multiple consumer destinations per service, each one - must have a different monitored resource type. A metric can be used - in at most one consumer destination. - ServiceIdentity: - id: ServiceIdentity + The names of the services that are enabled. Example: + `services/storage.googleapis.com`. + Option: properties: - uniqueId: - type: string - description: >- - The unique and stable id of the service account. - https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount - email: + value: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object description: >- - The email address of the service account that a service producer - would use to access consumer resources. + The option's value packed in an Any message. If the value is a + primitive, the corresponding wrapper type defined in + google/protobuf/wrappers.proto should be used. If the value is an + enum, it should be stored as an int32 value using the + google.protobuf.Int32Value type. + name: type: string + description: >- + The option's name. For protobuf built-in options (options defined in + descriptor.proto), this is the short name. For example, + `"map_entry"`. For custom options, it should be the fully-qualified + name. For example, `"google.api.http"`. type: object description: >- - Service identity for a service. This is the identity that service - producer should use to access consumer resources. - GoSettings: - type: object + A protocol buffer option, which can be attached to a message, field, + enumeration, etc. + id: Option + ImportAdminQuotaPoliciesResponse: + id: ImportAdminQuotaPoliciesResponse + description: Response message for ImportAdminQuotaPolicies properties: - common: - $ref: '#/components/schemas/CommonLanguageSettings' - description: Some settings. - description: Settings for Go client libraries. - id: GoSettings - QuotaOverride: - id: QuotaOverride + policies: + description: The policies that were created from the imported data. + type: array + items: + $ref: '#/components/schemas/AdminQuotaPolicy' type: object - description: A quota override + GoogleApiService: properties: - overrideValue: - format: int64 - type: string + monitoring: + $ref: '#/components/schemas/Monitoring' + description: Monitoring configuration. + enums: description: >- - The overriding quota limit value. Can be any nonnegative integer, or - -1 (unlimited quota). - metric: - type: string + A list of all enum types included in this API service. Enums + referenced directly or indirectly by the `apis` are automatically + included. Enums which are not referenced but shall be included + should be listed here by name by the configuration author. Example: + enums: - name: google.someapi.v1.SomeEnum + items: + $ref: '#/components/schemas/Enum' + type: array + apis: + type: array + items: + $ref: '#/components/schemas/Api' description: >- - The name of the metric to which this override applies. An example - name would be: `compute.googleapis.com/cpus` + A list of API interfaces exported by this service. Only the `name` + field of the google.protobuf.Api needs to be provided by the + configuration author, as the remaining fields will be derived from + the IDL during the normalization process. It is an error to specify + an API interface here which cannot be resolved against the + associated IDL files. + metrics: + type: array + items: + $ref: '#/components/schemas/MetricDescriptor' + description: Defines the metrics used by this service. name: type: string description: >- - The resource name of the override. This name is generated by the - server when the override is created. Example names would be: - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` - `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` - The resource name is intended to be opaque and should not be parsed - for its component strings, since its representation could change in - the future. - unit: + The service name, which is a DNS-like logical identifier for the + service, such as `calendar.googleapis.com`. The service name + typically goes through DNS verification to make sure the owner of + the service also owns the DNS name. + systemTypes: + type: array + items: + $ref: '#/components/schemas/Type' + description: >- + A list of all proto message types included in this API service. It + serves similar purpose as [google.api.Service.types], except that + these types are not needed by user-defined APIs. Therefore, they + will not show up in the generated discovery doc. This field should + only be used to define system APIs in ESF. + logs: + type: array + description: Defines the logs used by this service. + items: + $ref: '#/components/schemas/LogDescriptor' + title: type: string description: >- - The limit unit of the limit to which this override applies. An - example unit would be: `1/{project}/{region}` Note that `{project}` - and `{region}` are not placeholders in this example; the literal - characters `{` and `}` occur in the string. - adminOverrideAncestor: + The product title for this service, it is the name displayed in + Google Cloud Console. + configVersion: + description: >- + Obsolete. Do not use. This field has no semantic meaning. The + service config compiler always sets this field to `3`. + format: uint32 + type: integer + id: + type: string + description: >- + A unique ID for a specific instance of this message, typically + assigned by the client for tracking purpose. Must be no longer than + 63 characters and only lower case letters, digits, '.', '_' and '-' + are allowed. If empty, the server may choose to generate one + instead. + http: + $ref: '#/components/schemas/Http' + description: HTTP configuration. + logging: + $ref: '#/components/schemas/Logging' + description: Logging configuration. + backend: + description: API backend configuration. + $ref: '#/components/schemas/Backend' + producerProjectId: type: string + description: The Google project that owns this service. + customError: + description: Custom error configuration. + $ref: '#/components/schemas/CustomError' + sourceInfo: + $ref: '#/components/schemas/SourceInfo' description: >- - The resource name of the ancestor that requested the override. For - example: `organizations/12345` or `folders/67890`. Used by admin - overrides only. - dimensions: - type: object - additionalProperties: - type: string + Output only. The source information for this configuration if + available. + types: description: >- - If this map is nonempty, then this override applies only to specific - values for dimensions defined in the limit unit. For example, an - override on a limit with the unit `1/{project}/{region}` could - contain an entry with the key `region` and the value `us-east-1`; - the override is only applied to quota consumed in that region. This - map has the following restrictions: * Keys that are not defined in - the limit's unit are not valid keys. Any string appearing in - `{brackets}` in the unit (besides `{project}` or `{user}`) is a - defined key. * `project` is not a valid key; the project is already - specified in the parent resource name. * `user` is not a valid key; - the API does not support quota overrides that apply only to a - specific user. * If `region` appears as a key, its value must be a - valid Cloud region. * If `zone` appears as a key, its value must be - a valid Cloud zone. * If any valid key other than `region` or `zone` - appears in the map, then all valid keys other than `region` or - `zone` must also appear in the map. - MonitoringDestination: - properties: - monitoredResource: + A list of all proto message types included in this API service. + Types referenced directly or indirectly by the `apis` are + automatically included. Messages which are not referenced but shall + be included, such as types used by the `google.protobuf.Any` type, + should be listed here by name by the configuration author. Example: + types: - name: google.protobuf.Int32 + type: array + items: + $ref: '#/components/schemas/Type' + authentication: + description: Auth configuration. + $ref: '#/components/schemas/Authentication' + quota: + description: Quota configuration. + $ref: '#/components/schemas/Quota' + context: + description: Context configuration. + $ref: '#/components/schemas/Context' + usage: + $ref: '#/components/schemas/Usage' + description: Configuration controlling usage of this service. + endpoints: description: >- - The monitored resource type. The type must be defined in - Service.monitored_resources section. - type: string - metrics: + Configuration for network endpoints. If this is empty, then an + endpoint with the same name as the service is automatically + generated to service all defined APIs. type: array items: - type: string + $ref: '#/components/schemas/Endpoint' + billing: + description: Billing configuration. + $ref: '#/components/schemas/Billing' + monitoredResources: + items: + $ref: '#/components/schemas/MonitoredResourceDescriptor' + type: array description: >- - Types of the metrics to report to this monitoring destination. Each - type must be defined in Service.metrics section. + Defines the monitored resources used by this service. This is + required by the Service.monitoring and Service.logging + configurations. + documentation: + description: Additional API documentation. + $ref: '#/components/schemas/Documentation' + systemParameters: + $ref: '#/components/schemas/SystemParameters' + description: System parameter configuration. + publishing: + description: >- + Settings for [Google Cloud Client + libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + generated from APIs defined as protocol buffers. + $ref: '#/components/schemas/Publishing' + control: + $ref: '#/components/schemas/Control' + description: Configuration for the service control plane. description: >- - Configuration of a specific monitoring destination (the producer project - or the consumer project). + `Service` is the root object of Google API service configuration + (service config). It describes the basic information about a logical + service, such as the service name and the user-facing title, and + delegates other aspects to sub-sections. Each sub-section is either a + proto message or a repeated proto message that configures a specific + aspect, such as auth. For more information, see each proto message + definition. Example: type: google.api.Service name: + calendar.googleapis.com title: Google Calendar API apis: - name: + google.calendar.v3.Calendar visibility: rules: - selector: + "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: + "google.calendar.v3.*" address: calendar.example.com authentication: + providers: - id: google_calendar_auth jwks_uri: + https://www.googleapis.com/oauth2/v1/certs issuer: + https://securetoken.google.com rules: - selector: "*" requirements: + provider_id: google_calendar_auth type: object - id: MonitoringDestination - Http: + id: GoogleApiService + Usage: + id: Usage type: object - description: >- - Defines the HTTP configuration for an API service. It contains a list of - HttpRule, each specifying the mapping of an RPC method to one or more - HTTP REST API methods. properties: - fullyDecodeReservedExpansion: - description: >- - When set to true, URL path parameters will be fully URI-decoded - except in cases of single segment matches in reserved expansion, - where "%2F" will be left encoded. The default behavior is to not - decode RFC 6570 reserved characters in multi segment matches. - type: boolean rules: - items: - $ref: '#/components/schemas/HttpRule' description: >- - A list of HTTP configuration rules that apply to individual API - methods. **NOTE:** All service configuration rules follow "last one - wins" order. + A list of usage rules that apply to individual API methods. + **NOTE:** All service configuration rules follow "last one wins" + order. + items: + $ref: '#/components/schemas/UsageRule' + type: array + requirements: type: array - id: Http - MethodPolicy: - id: MethodPolicy - description: Defines policies applying to an RPC method. - properties: - selector: description: >- - Selects a method to which these policies should be enforced, for - example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to - selector for syntax details. NOTE: This field must not be set in the - proto annotation. It will be automatically filled by the service - config compiler . - type: string - requestPolicies: + Requirements that must be satisfied before a consumer project can + use the service. Each requirement is of the form /; for example + 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a + Terms of Service requirement must be included here. Google Cloud + APIs must include "serviceusage.googleapis.com/tos/cloud". Other + Google APIs should include + "serviceusage.googleapis.com/tos/universal". Additional ToS can be + included based on the business needs. items: - $ref: '#/components/schemas/FieldPolicy' - type: array - description: Policies that are applicable to the request message. - type: object + type: string + producerNotificationChannel: + type: string + description: >- + The full resource name of a channel used for sending notifications + to the service producer. Google Service Management currently only + supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as + a notification channel. To use Google Cloud Pub/Sub as the channel, + this must be the name of a Cloud Pub/Sub topic that uses the Cloud + Pub/Sub topic name format documented in + https://cloud.google.com/pubsub/docs/overview. + description: Configuration controlling usage of a service. Empty: - id: Empty + properties: {} + type: object description: >- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - properties: {} + id: Empty + Endpoint: type: object - OperationMetadata: + id: Endpoint + description: >- + `Endpoint` describes a network address of a service that serves a set of + APIs. It is commonly known as a service endpoint. A service may expose + any number of service endpoints, and all service endpoints share the + same service definition, such as quota limits and monitoring metrics. + Example: type: google.api.Service name: library-example.googleapis.com + endpoints: # Declares network address + `https://library-example.googleapis.com` # for service + `library-example.googleapis.com`. The `https` scheme # is implicit for + all service endpoints. Other schemes may be # supported in the future. - + name: library-example.googleapis.com allow_cors: false - name: + content-staging-library-example.googleapis.com # Allows HTTP OPTIONS + calls to be passed to the API frontend, for it # to decide whether the + subsequent cross-origin request is allowed # to proceed. allow_cors: + true properties: - resourceNames: + aliases: + description: >- + Aliases for this endpoint, these will be served by the same UrlMap + as the parent endpoint, and will be provisioned in the GCP stack for + the Regional Endpoints. items: type: string type: array + allowCors: description: >- - The full name of the resources that this operation is directly - associated with. - description: The operation metadata returned for the batchend services operation. - id: OperationMetadata + Allowing + [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), + aka cross-domain traffic, would allow the backends served from this + endpoint to receive and respond to HTTP OPTIONS requests. The + response will be used by the browser to determine whether the + subsequent cross-origin request is allowed to proceed. + type: boolean + name: + type: string + description: The canonical name of this endpoint. + target: + type: string + description: >- + The specification of an Internet routable address of API frontend + that will handle requests to this [API + Endpoint](https://cloud.google.com/apis/design/glossary). It should + be either a valid IPv4 address or a fully-qualified domain name. For + example, "8.8.8.8" or "myservice.appspot.com". + OAuthRequirements: + properties: + canonicalScopes: + description: >- + The list of publicly documented OAuth scopes that are allowed + access. An OAuth token containing any of these scopes will be + accepted. Example: canonical_scopes: + https://www.googleapis.com/auth/calendar, + https://www.googleapis.com/auth/calendar.read + type: string + description: >- + OAuth scopes are a way to define data and permissions on data. For + example, there are scopes defined for "Read-only access to Google + Calendar" and "Access to Cloud Platform". Users can consent to a scope + for an application, giving it permission to access that data on their + behalf. OAuth scope specifications should be fairly coarse grained; a + user will need to see and understand the text description of what your + scope means. In most cases: use one or at most two OAuth scopes for an + entire family of products. If your product has multiple APIs, you should + probably be sharing the OAuth scope across all of those APIs. When you + need finer grained OAuth consent screens: talk with your product + management about how developers will use them in practice. Please note + that even though each of the canonical scopes is enough for a request to + be accepted and passed to the backend, a request can still fail due to + the backend requiring additional scopes or permissions. + id: OAuthRequirements type: object parameters: - callback: - description: JSONP + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: callback + name: fields schema: type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. + access_token: + description: OAuth access token. in: query - name: quotaUser + name: access_token + schema: + type: string + _.xgafv: + description: V1 error format. + in: query + name: $.xgafv + schema: + type: string + enum: + - '1' + - '2' + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean + callback: + description: JSONP + in: query + name: callback schema: type: string alt: @@ -3726,16 +3879,25 @@ components: - json - media - proto + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol + schema: + type: string oauth_token: description: OAuth 2.0 token for the current user. in: query name: oauth_token schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: uploadType + name: quotaUser schema: type: string key: @@ -3747,61 +3909,31 @@ components: name: key schema: type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string x-stackQL-resources: operations: id: google.serviceusage.operations name: operations title: Operations methods: - delete: + get: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' + $ref: '#/paths/~1v1~1operations~1{operationsId}/get' response: mediaType: application/json openAPIDocKey: '200' - get: + delete: operation: - $ref: '#/paths/~1v1~1operations~1{operationsId}/get' + $ref: '#/paths/~1v1~1operations~1{operationsId}/delete' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 cancel: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}:cancel/post' @@ -3814,6 +3946,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' services: @@ -3821,31 +3954,28 @@ components: name: services title: Services methods: - batch_enable: + get: operation: - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' + $ref: '#/paths/~1v1~1{name}/get' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 - $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' - response: &ref_4 + enable: + operation: + $ref: '#/paths/~1v1~1{name}/post' + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.services list: - operation: *ref_3 - response: *ref_4 - disable: operation: - $ref: '#/paths/~1v1~1{name}/post' + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/get' response: mediaType: application/json openAPIDocKey: '200' - get: + objectKey: $.services + batch_enable: operation: - $ref: '#/paths/~1v1~1{name}/get' + $ref: '#/paths/~1v1~1{parentType}~1{parent}~1services/post' response: mediaType: application/json openAPIDocKey: '200' @@ -3855,28 +3985,28 @@ components: - $ref: '#/components/x-stackQL-resources/services/methods/get' insert: [] update: [] + replace: [] delete: [] paths: /v1/operations/{operationsId}: - parameters: &ref_5 + parameters: &ref_1 + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' + - $ref: '#/components/parameters/prettyPrint' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/upload_protocol' - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/quotaUser' - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/access_token' - delete: + get: description: >- - Deletes a long-running operation. This method indicates that the client - is no longer interested in the operation result. It does not cancel the - operation. If the server doesn't support this method, it returns - `google.rpc.Code.UNIMPLEMENTED`. - operationId: serviceusage.operations.delete + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: serviceusage.operations.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3892,19 +4022,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Empty' + $ref: '#/components/schemas/Operation' parameters: - in: path name: operationsId required: true schema: type: string - get: + delete: description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: serviceusage.operations.get + Deletes a long-running operation. This method indicates that the client + is no longer interested in the operation result. It does not cancel the + operation. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + operationId: serviceusage.operations.delete security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -3920,7 +4051,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Operation' + $ref: '#/components/schemas/Empty' parameters: - in: path name: operationsId @@ -3928,7 +4059,7 @@ paths: schema: type: string /v1/operations: - parameters: *ref_5 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3955,6 +4086,10 @@ paths: name: name schema: type: string + - in: query + name: pageToken + schema: + type: string - in: query name: pageSize schema: @@ -3964,12 +4099,8 @@ paths: name: filter schema: type: string - - in: query - name: pageToken - schema: - type: string /v1/operations/{operationsId}:cancel: - parameters: *ref_5 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4009,20 +4140,41 @@ paths: required: true schema: type: string - /v1/{parentType}/{parent}/services: - parameters: *ref_5 + /v1/{name}: + parameters: *ref_1 + get: + description: Returns the service configuration and enabled state for a given service. + operationId: serviceusage.services.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform.read-only + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform.read-only + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/GoogleApiServiceusageV1Service' + parameters: + - in: path + name: name + required: true + schema: + type: string post: - description: >- - Enable multiple services on a project. The operation is atomic: if - enabling any service fails, then the entire batch fails, and no state - changes occur. To enable a single service, use the `EnableService` - method instead. - operationId: serviceusage.services.batchEnable + description: Enable a service so that it can be used with a project. + operationId: serviceusage.services.enable requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchEnableServicesRequest' + $ref: '#/components/schemas/EnableServiceRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4041,15 +4193,12 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: parentType - required: true - schema: - type: string - - in: path - name: parent + name: name required: true schema: type: string + /v1/{parentType}/{parent}/services: + parameters: *ref_1 get: description: >- List all services available to the specified project, and the current @@ -4092,34 +4241,30 @@ paths: schema: type: string - in: query - name: pageSize + name: pageToken schema: - type: integer - format: int32 + type: string - in: query name: filter schema: type: string - in: query - name: pageToken + name: pageSize schema: - type: string - /v1/{name}: - parameters: *ref_5 + type: integer + format: int32 post: description: >- - Disable a service so that it can no longer be used with a project. This - prevents unintended usage that may cause unexpected billing charges or - security leaks. It is not valid to call the disable method on a service - that is not currently enabled. Callers will receive a - `FAILED_PRECONDITION` status if the target service is not currently - enabled. - operationId: serviceusage.services.disable + Enable multiple services on a project. The operation is atomic: if + enabling any service fails, then the entire batch fails, and no state + changes occur. To enable a single service, use the `EnableService` + method instead. + operationId: serviceusage.services.batchEnable requestBody: content: application/json: schema: - $ref: '#/components/schemas/DisableServiceRequest' + $ref: '#/components/schemas/BatchEnableServicesRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -4138,32 +4283,12 @@ paths: $ref: '#/components/schemas/Operation' parameters: - in: path - name: name + name: parentType required: true schema: type: string - get: - description: Returns the service configuration and enabled state for a given service. - operationId: serviceusage.services.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform.read-only - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform.read-only - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleApiServiceusageV1Service' - parameters: - in: path - name: name + name: parent required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml index fe9aa7d4..bcb93859 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/solar.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/solar.yaml @@ -7,8 +7,8 @@ info: title: Solar API description: Solar API. version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://developers.google.com/maps/documentation/solar servers: @@ -34,763 +34,742 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - SolarPanel: + BuildingInsights: properties: - yearlyEnergyDcKwh: - format: float - description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh. - type: number + imageryDate: + description: Date that the underlying imagery was acquired. This is approximate. + $ref: '#/components/schemas/Date' center: - description: The centre of the panel. $ref: '#/components/schemas/LatLng' - orientation: - description: The orientation of the panel. + description: A point near the center of the building. + regionCode: + type: string + description: Region code for the country (or region) this building is in. + administrativeArea: + description: >- + Administrative area 1 (e.g., in the US, the state) that contains + this building. For example, in the US, the abbreviation might be + "MA" or "CA." + type: string + postalCode: + description: Postal code (e.g., US zip code) this building is contained by. + type: string + solarPotential: + $ref: '#/components/schemas/SolarPotential' + description: Solar potential of the building. + statisticalArea: + description: Statistical area (e.g., US census tract) this building is in. + type: string + imageryQuality: + description: >- + The quality of the imagery used to compute the data for this + building. type: string - enum: - - SOLAR_PANEL_ORIENTATION_UNSPECIFIED - - LANDSCAPE - - PORTRAIT enumDescriptions: - - No panel orientation is known. + - No quality is known. - >- - A `LANDSCAPE` panel has its long edge perpendicular to the azimuth - direction of the roof segment that it is placed on. + Solar data is derived from aerial imagery captured at low-altitude + and processed at 0.1 m/pixel. - >- - A `PORTRAIT` panel has its long edge parallel to the azimuth - direction of the roof segment that it is placed on. - segmentIndex: - format: int32 - description: >- - Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` - which corresponds to the roof segment that this panel is placed on. - type: integer + Solar data is derived from enhanced aerial imagery captured at + high-altitude and processed at 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + enum: + - IMAGERY_QUALITY_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - BASE + boundingBox: + $ref: '#/components/schemas/LatLngBox' + description: The bounding box of the building. + imageryProcessedDate: + $ref: '#/components/schemas/Date' + description: When processing was completed on this imagery. + name: + type: string + description: The resource name for the building, of the format `building/`. type: object - id: SolarPanel description: >- - SolarPanel describes the position, orientation, and production of a - single solar panel. See the panel_height_meters, panel_width_meters, and - panel_capacity_watts fields in SolarPotential for information on the - parameters of the panel. - LatLng: - id: LatLng + Response message for `Solar.FindClosestBuildingInsights`. Information + about the location, dimensions, and solar potential of a building. + id: BuildingInsights + FinancedPurchaseSavings: properties: - longitude: - type: number - description: The longitude in degrees. It must be in the range [-180.0, +180.0]. - format: double - latitude: + savings: + $ref: '#/components/schemas/SavingsOverTime' + description: How much is saved (or not) over the lifetime period. + rebateValue: + description: >- + The value of all tax rebates (including Federal Investment Tax + Credit (ITC)). + $ref: '#/components/schemas/Money' + loanInterestRate: + description: The interest rate on loans assumed in this set of calculations. + format: float type: number - format: double - description: The latitude in degrees. It must be in the range [-90.0, +90.0]. - description: >- - An object that represents a latitude/longitude pair. This is expressed - as a pair of doubles to represent degrees latitude and degrees - longitude. Unless specified otherwise, this object must conform to the - WGS84 standard. Values must be within normalized ranges. - type: object - SolarPotential: + annualLoanPayment: + $ref: '#/components/schemas/Money' + description: Annual loan payments. type: object + description: >- + Cost and benefit of using a loan to buy a particular configuration of + solar panels with a particular electricity usage. + id: FinancedPurchaseSavings + RoofSegmentSizeAndSunshineStats: properties: - financialAnalyses: - description: >- - A FinancialAnalysis gives the savings from going solar assuming a - given monthly bill and a given electricity provider. They are in - order of increasing order of monthly bill amount. This field will be - empty for buildings in areas for which the Solar API does not have - enough information to perform financial computations. - type: array - items: - $ref: '#/components/schemas/FinancialAnalysis' - panelWidthMeters: + azimuthDegrees: + format: float type: number description: >- - Width, in meters in portrait orientation, of the panel used in the - calculations. + Compass direction the roof segment is pointing in. 0 = North, 90 = + East, 180 = South. For a "flat" roof segment (`pitch_degrees` very + near 0), azimuth is not well defined, so for consistency, we define + it arbitrarily to be 0 (North). + center: + $ref: '#/components/schemas/LatLng' + description: A point near the center of the roof segment. + boundingBox: + $ref: '#/components/schemas/LatLngBox' + description: The bounding box of the roof segment. + pitchDegrees: format: float - panelLifetimeYears: - type: integer - description: >- - The expected lifetime, in years, of the solar panels. This is used - in the financial calculations. - format: int32 - solarPanelConfigs: - description: >- - Each SolarPanelConfig describes a different arrangement of solar - panels on the roof. They are in order of increasing number of - panels. The `SolarPanelConfig` with panels_count=N is based on the - first N panels in the `solar_panels` list. This field is only - populated if at least 4 panels can fit on a roof. - items: - $ref: '#/components/schemas/SolarPanelConfig' - type: array - solarPanels: - items: - $ref: '#/components/schemas/SolarPanel' - description: >- - Each SolarPanel describes a single solar panel. They are listed in - the order that the panel layout algorithm placed this. This is - usually, though not always, in decreasing order of annual energy - production. - type: array - wholeRoofStats: description: >- - Total size and sunlight quantiles for the part of the roof that was - assigned to some roof segment. Despite the name, this may not - include the entire building. See building_stats. - $ref: '#/components/schemas/SizeAndSunshineStats' - roofSegmentStats: - type: array - description: Size and sunlight quantiles for each roof segment. - items: - $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' - panelCapacityWatts: + Angle of the roof segment relative to the theoretical ground plane. + 0 = parallel to the ground, 90 = perpendicular to the ground. type: number - format: float - description: Capacity, in watts, of the panel used in the calculations. - panelHeightMeters: + planeHeightAtCenterMeters: description: >- - Height, in meters in portrait orientation, of the panel used in the - calculations. - type: number - format: float - maxArrayAreaMeters2: + The height of the roof segment plane, in meters above sea level, at + the point designated by `center`. Together with the pitch, azimuth, + and center location, this fully defines the roof segment plane. format: float type: number - description: Size, in square meters, of the maximum array. - carbonOffsetFactorKgPerMwh: + stats: + $ref: '#/components/schemas/SizeAndSunshineStats' + description: Total size and sunlight quantiles for the roof segment. + description: Information about the size and sunniness quantiles of a roof segment. + id: RoofSegmentSizeAndSunshineStats + type: object + FinancialAnalysis: + properties: + leasingSavings: + description: Cost and benefit of leasing the solar panels. + $ref: '#/components/schemas/LeasingSavings' + averageKwhPerMonth: + format: float + description: >- + How much electricity the house uses in an average month, based on + the bill size and the local electricity rates. type: number + panelConfigIndex: + format: int32 description: >- - Equivalent amount of CO2 produced per MWh of grid electricity. This - is a measure of the carbon intensity of grid electricity displaced - by solar electricity. - format: float - maxArrayPanelsCount: + Index in solar_panel_configs of the optimum solar layout for this + bill size. This can be -1 indicating that there is no layout. In + this case, the remaining submessages will be omitted. type: integer + cashPurchaseSavings: + description: Cost and benefit of buying the solar panels with cash. + $ref: '#/components/schemas/CashPurchaseSavings' + financedPurchaseSavings: + $ref: '#/components/schemas/FinancedPurchaseSavings' description: >- - Size of the maximum array - that is, the maximum number of panels - that can fit on the roof. - format: int32 - maxSunshineHoursPerYear: - format: float - type: number + Cost and benefit of buying the solar panels by financing the + purchase. + monthlyBill: + description: The monthly electric bill this analysis assumes. + $ref: '#/components/schemas/Money' + financialDetails: + $ref: '#/components/schemas/FinancialDetails' description: >- - Maximum number of sunshine hours received per year, by any point on - the roof. Sunshine hours are a measure of the total amount of - insolation (energy) received per year. 1 sunshine hour = 1 kWh per - kW (where kW refers to kW of capacity under Standard Testing - Conditions). - buildingStats: - $ref: '#/components/schemas/SizeAndSunshineStats' + Financial information that applies regardless of the financing + method used. + defaultBill: description: >- - Size and sunlight quantiles for the entire building, including parts - of the roof that were not assigned to some roof segment. Because the - orientations of these parts are not well characterised, the roof - area estimate is unreliable, but the ground area estimate is - reliable. It may be that a more reliable whole building roof area - can be obtained by scaling the roof area from whole_roof_stats by - the ratio of the ground areas of `building_stats` and - `whole_roof_stats`. - id: SolarPotential - description: >- - Information about the solar potential of a building. A number of fields + Whether this is the bill size selected to be the default bill for + the area this building is in. Exactly one `FinancialAnalysis` in + `BuildingSolarPotential` should have `default_bill` set. + type: boolean + description: >- + Analysis of the cost and benefits of the optimum solar layout for a + particular electric bill size. + id: FinancialAnalysis + type: object + DataLayers: + type: object + properties: + dsmUrl: + type: string + description: >- + The URL for an image of the DSM (Digital Surface Model) of the + region. Values are in meters above EGM96 geoid (i.e., sea level). + Invalid locations (where we don't have data) are stored as -9999. + imageryProcessedDate: + $ref: '#/components/schemas/Date' + description: When processing was completed on this imagery. + maskUrl: + type: string + description: >- + The URL for the building mask image: one bit per pixel saying + whether that pixel is considered to be part of a rooftop or not. + rgbUrl: + type: string + description: The URL for an image of RGB data (aerial photo) of the region. + imageryQuality: + enumDescriptions: + - No quality is known. + - >- + Solar data is derived from aerial imagery captured at low-altitude + and processed at 0.1 m/pixel. + - >- + Solar data is derived from enhanced aerial imagery captured at + high-altitude and processed at 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + - >- + Solar data is derived from enhanced satellite imagery processed at + 0.25 m/pixel. + description: The quality of the result's imagery. + type: string + enum: + - IMAGERY_QUALITY_UNSPECIFIED + - HIGH + - MEDIUM + - LOW + - BASE + annualFluxUrl: + description: >- + The URL for the annual flux map (annual sunlight on roofs) of the + region. Values are kWh/kW/year. This is *unmasked flux*: flux is + computed for every location, not just building rooftops. Invalid + locations are stored as -9999: locations outside our coverage area + will be invalid, and a few locations inside the coverage area, where + we were unable to calculate flux, will also be invalid. + type: string + imageryDate: + $ref: '#/components/schemas/Date' + description: >- + When the source imagery (from which all the other data are derived) + in this region was taken. It is necessarily somewhat approximate, as + the images may have been taken over more than one day. + hourlyShadeUrls: + items: + type: string + description: >- + Twelve URLs for hourly shade, corresponding to January...December, + in order. Each GeoTIFF will contain 24 bands, corresponding to the + 24 hours of the day. Each pixel is a 32 bit integer, corresponding + to the (up to) 31 days of that month; a 1 bit means that the + corresponding location is able to see the sun at that day, of that + hour, of that month. Invalid locations are stored as -9999 (since + this is negative, it has bit 31 set, and no valid value could have + bit 31 set as that would correspond to the 32nd day of the month). + An example may be useful. If you want to know whether a point (at + pixel location (x, y)) saw sun at 4pm on the 22nd of June you would: + 1. fetch the sixth URL in this list (corresponding to June). 1. look + up the 17th channel (corresponding to 4pm). 1. read the 32-bit value + at (x, y). 1. read bit 21 of the value (corresponding to the 22nd of + the month). 1. if that bit is a 1, then that spot saw the sun at 4pm + 22 June. More formally: Given `month` (1-12), `day` (1...month max; + February has 28 days) and `hour` (0-23), the shade/sun for that + month/day/hour at a position `(x, y)` is the bit ``` + (hourly_shade[month - 1])(x, y)[hour] & (1 << (day - 1)) ``` where + `(x, y)` is spatial indexing, `[month - 1]` refers to fetching the + `month - 1`st URL (indexing from zero), `[hour]` is indexing into + the channels, and a final non-zero result means "sunny". There are + no leap days, and DST doesn't exist (all days are 24 hours long; + noon is always "standard time" noon). + type: array + monthlyFluxUrl: + type: string + description: >- + The URL for the monthly flux map (sunlight on roofs, broken down by + month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to + by this URL will contain twelve bands, corresponding to + January...December, in order. + description: >- + Information about the solar potential of a region. The actual data are + contained in a number of GeoTIFF files covering the requested region, + for which this message contains URLs: Each string in the `DataLayers` + message contains a URL from which the corresponding GeoTIFF can be + fetched. These URLs are valid for a few hours after they've been + generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, + but the monthly flux file is at 0.5m/pixel, and the hourly shade files + are at 1m/pixel. If a `pixel_size_meters` value was specified in the + `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files + will be that value. + id: DataLayers + SolarPotential: + description: >- + Information about the solar potential of a building. A number of fields in this are defined in terms of "panels". The fields panel_capacity_watts, panel_height_meters, and panel_width_meters describe the parameters of the model of panel used in these calculations. - SizeAndSunshineStats: - id: SizeAndSunshineStats + id: SolarPotential + type: object properties: - sunshineQuantiles: - description: >- - Quantiles of the pointwise sunniness across the area. If there are N - values here, this represents the (N-1)-iles. For example, if there - are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, - max). Values are in annual kWh/kW like max_sunshine_hours_per_year. - items: - type: number - format: float - type: array - areaMeters2: - type: number + carbonOffsetFactorKgPerMwh: description: >- - The area of the roof or roof segment, in m^2. This is the roof area - (accounting for tilt), not the ground footprint area. - format: float - groundAreaMeters2: + Equivalent amount of CO2 produced per MWh of grid electricity. This + is a measure of the carbon intensity of grid electricity displaced + by solar electricity. format: float type: number + buildingStats: description: >- - The ground footprint area covered by the roof or roof segment, in - m^2. - type: object - description: Size and sunniness quantiles of a roof, or part of a roof. - LatLngBox: - description: A bounding box in lat/lng coordinates. - id: LatLngBox - properties: - sw: - description: The southwest corner of the box. - $ref: '#/components/schemas/LatLng' - ne: - description: The northeast corner of the box. - $ref: '#/components/schemas/LatLng' - type: object - SolarPanelConfig: - type: object - id: SolarPanelConfig - description: >- - SolarPanelConfig describes a particular placement of solar panels on the - roof. - properties: - roofSegmentSummaries: - description: >- - Information about the production of each roof segment that is - carrying at least one panel in this layout. - `roof_segment_summaries[i]` describes the i-th roof segment, - including its size, expected production and orientation. + Size and sunlight quantiles for the entire building, including parts + of the roof that were not assigned to some roof segment. Because the + orientations of these parts are not well characterised, the roof + area estimate is unreliable, but the ground area estimate is + reliable. It may be that a more reliable whole building roof area + can be obtained by scaling the roof area from whole_roof_stats by + the ratio of the ground areas of `building_stats` and + `whole_roof_stats`. + $ref: '#/components/schemas/SizeAndSunshineStats' + roofSegmentStats: items: - $ref: '#/components/schemas/RoofSegmentSummary' + $ref: '#/components/schemas/RoofSegmentSizeAndSunshineStats' type: array - panelsCount: + description: Size and sunlight quantiles for each roof segment. + maxArrayPanelsCount: type: integer format: int32 description: >- - Total number of panels. Note that this is redundant to (the sum of) - the corresponding fields in roof_segment_summaries. - yearlyEnergyDcKwh: - type: number + Size of the maximum array - that is, the maximum number of panels + that can fit on the roof. + panelHeightMeters: format: float description: >- - How much sunlight energy this layout captures over the course of a - year, in DC kWh, assuming the panels described above. - FinancedPurchaseSavings: - description: >- - Cost and benefit of using a loan to buy a particular configuration of - solar panels with a particular electricity usage. - id: FinancedPurchaseSavings - properties: - rebateValue: - $ref: '#/components/schemas/Money' + Height, in meters in portrait orientation, of the panel used in the + calculations. + type: number + wholeRoofStats: + $ref: '#/components/schemas/SizeAndSunshineStats' description: >- - The value of all tax rebates (including Federal Investment Tax - Credit (ITC)). - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' - loanInterestRate: - description: The interest rate on loans assumed in this set of calculations. - format: float + Total size and sunlight quantiles for the part of the roof that was + assigned to some roof segment. Despite the name, this may not + include the entire building. See building_stats. + maxArrayAreaMeters2: + description: Size, in square meters, of the maximum array. type: number - annualLoanPayment: - $ref: '#/components/schemas/Money' - description: Annual loan payments. - type: object - HttpBody: - id: HttpBody - type: object - properties: - contentType: + format: float + solarPanelConfigs: description: >- - The HTTP Content-Type header value specifying the content type of - the body. - type: string - data: - format: byte - type: string - description: The HTTP request/response body as raw binary. - extensions: + Each SolarPanelConfig describes a different arrangement of solar + panels on the roof. They are in order of increasing number of + panels. The `SolarPanelConfig` with panels_count=N is based on the + first N panels in the `solar_panels` list. This field is only + populated if at least 4 panels can fit on a roof. + type: array + items: + $ref: '#/components/schemas/SolarPanelConfig' + panelCapacityWatts: + format: float + type: number + description: Capacity, in watts, of the panel used in the calculations. + solarPanels: type: array description: >- - Application specific response metadata. Must be set in the first - response for streaming APIs. + Each SolarPanel describes a single solar panel. They are listed in + the order that the panel layout algorithm placed this. This is + usually, though not always, in decreasing order of annual energy + production. items: - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - type: object - description: >- - Message that represents an arbitrary HTTP body. It should only be used - for payload formats that can't be represented as JSON, such as raw - binary or an HTML page. This message can be used both in streaming and - non-streaming API methods in the request as well as the response. It can - be used as a top-level request field, which is convenient if one wants - to extract parameters from either the URL or HTTP template into the - request fields and also want access to the raw HTTP body. Example: - message GetResourceRequest { // A unique request id. string request_id = - 1; // The raw HTTP body is bound to this field. google.api.HttpBody - http_body = 2; } service ResourceService { rpc - GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc - UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } - Example with streaming methods: service CaldavService { rpc - GetCalendar(stream google.api.HttpBody) returns (stream - google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) - returns (stream google.api.HttpBody); } Use of this type only changes - how the request and response bodies are handled, all other features will - continue to work unchanged. - RoofSegmentSizeAndSunshineStats: - type: object - id: RoofSegmentSizeAndSunshineStats - properties: - stats: - description: Total size and sunlight quantiles for the roof segment. - $ref: '#/components/schemas/SizeAndSunshineStats' - planeHeightAtCenterMeters: + $ref: '#/components/schemas/SolarPanel' + maxSunshineHoursPerYear: format: float type: number description: >- - The height of the roof segment plane, in meters above sea level, at - the point designated by `center`. Together with the pitch, azimuth, - and center location, this fully defines the roof segment plane. - boundingBox: - $ref: '#/components/schemas/LatLngBox' - description: The bounding box of the roof segment. + Maximum number of sunshine hours received per year, by any point on + the roof. Sunshine hours are a measure of the total amount of + insolation (energy) received per year. 1 sunshine hour = 1 kWh per + kW (where kW refers to kW of capacity under Standard Testing + Conditions). + panelLifetimeYears: + type: integer + description: >- + The expected lifetime, in years, of the solar panels. This is used + in the financial calculations. + format: int32 + panelWidthMeters: + type: number + description: >- + Width, in meters in portrait orientation, of the panel used in the + calculations. + format: float + financialAnalyses: + items: + $ref: '#/components/schemas/FinancialAnalysis' + description: >- + A FinancialAnalysis gives the savings from going solar assuming a + given monthly bill and a given electricity provider. They are in + order of increasing order of monthly bill amount. This field will be + empty for buildings in areas for which the Solar API does not have + enough information to perform financial computations. + type: array + RoofSegmentSummary: + id: RoofSegmentSummary + type: object + description: >- + Information about a roof segment on the building, with some number of + panels placed on it. + properties: pitchDegrees: description: >- Angle of the roof segment relative to the theoretical ground plane. 0 = parallel to the ground, 90 = perpendicular to the ground. - format: float type: number - center: - $ref: '#/components/schemas/LatLng' - description: A point near the center of the roof segment. + format: float + segmentIndex: + format: int32 + description: >- + Index in roof_segment_stats of the corresponding + `RoofSegmentSizeAndSunshineStats`. + type: integer azimuthDegrees: + format: float + type: number description: >- Compass direction the roof segment is pointing in. 0 = North, 90 = East, 180 = South. For a "flat" roof segment (`pitch_degrees` very near 0), azimuth is not well defined, so for consistency, we define it arbitrarily to be 0 (North). - type: number + panelsCount: + format: int32 + type: integer + description: The total number of panels on this segment. + yearlyEnergyDcKwh: format: float - description: Information about the size and sunniness quantiles of a roof segment. - SavingsOverTime: + type: number + description: >- + How much sunlight energy this part of the layout captures over the + course of a year, in DC kWh, assuming the panels described above. + FinancialDetails: properties: - presentValueOfSavingsYear20: - $ref: '#/components/schemas/Money' + percentageExportedToGrid: description: >- - Using the assumed discount rate, what is the present value of the - cumulative 20-year savings? - financiallyViable: + The percentage (0-100) of solar electricity production we assumed + was exported to the grid, based on the first quarter of production. + This affects the calculations if net metering is not allowed. + format: float + type: number + solarPercentage: description: >- - Indicates whether this scenario is financially viable. Will be false - for scenarios with poor financial viability (e.g., money-losing). - type: boolean - savingsYear1: - description: Savings in the first year after panel installation. + Percentage (0-100) of the user's power supplied by solar. Valid for + the first year but approximately correct for future years. + format: float + type: number + costOfElectricityWithoutSolar: + description: >- + Total cost of electricity the user would have paid over the lifetime + period if they didn't install solar. $ref: '#/components/schemas/Money' - savingsLifetime: + federalIncentive: $ref: '#/components/schemas/Money' - description: Savings in the entire panel lifetime. - savingsYear20: + description: >- + Amount of money available from federal incentives; this applies if + the user buys (with or without a loan) the panels. + utilityIncentive: $ref: '#/components/schemas/Money' - description: Savings in the first twenty years after panel installation. - presentValueOfSavingsLifetime: + description: >- + Amount of money available from utility incentives; this applies if + the user buys (with or without a loan) the panels. + remainingLifetimeUtilityBill: $ref: '#/components/schemas/Money' description: >- - Using the assumed discount rate, what is the present value of the - cumulative lifetime savings? - id: SavingsOverTime - description: Financial information that's shared between different financing methods. + Utility bill for electricity not produced by solar, for the lifetime + of the panels. + initialAcKwhPerYear: + type: number + description: >- + How many AC kWh we think the solar panels will generate in their + first year. + format: float + netMeteringAllowed: + description: Whether net metering is allowed. + type: boolean + lifetimeSrecTotal: + description: >- + Amount of money the user will receive from Solar Renewable Energy + Credits over the panel lifetime; this applies if the user buys (with + or without a loan) the panels. + $ref: '#/components/schemas/Money' + stateIncentive: + description: >- + Amount of money available from state incentives; this applies if the + user buys (with or without a loan) the panels. + $ref: '#/components/schemas/Money' + description: >- + Details of a financial analysis. Some of these details are already + stored at higher levels (e.g., out of pocket cost). Total money amounts + are over a lifetime period defined by the panel_lifetime_years field in + SolarPotential. Note: The out of pocket cost of purchasing the panels is + given in the out_of_pocket_cost field in CashPurchaseSavings. + id: FinancialDetails + type: object + LeasingSavings: type: object - Money: properties: - nanos: + annualLeasingCost: + $ref: '#/components/schemas/Money' + description: Estimated annual leasing cost. + savings: + $ref: '#/components/schemas/SavingsOverTime' + description: How much is saved (or not) over the lifetime period. + leasesSupported: + type: boolean description: >- - Number of nano (10^-9) units of the amount. The value must be - between -999,999,999 and +999,999,999 inclusive. If `units` is - positive, `nanos` must be positive or zero. If `units` is zero, - `nanos` can be positive, zero, or negative. If `units` is negative, - `nanos` must be negative or zero. For example $-1.75 is represented - as `units`=-1 and `nanos`=-750,000,000. - type: integer - format: int32 - currencyCode: - type: string - description: The three-letter currency code defined in ISO 4217. - units: - format: int64 + Whether leases are supported in this juristiction by the financial + calculation engine. If this field is false, then the values in this + message should probably be ignored. This is independent of + `leases_allowed`: in some areas leases are allowed, but under + conditions that aren't handled by the financial models. + leasesAllowed: + type: boolean description: >- - The whole units of the amount. For example if `currencyCode` is - `"USD"`, then 1 unit is one US dollar. - type: string - type: object - id: Money - description: Represents an amount of money with its currency type. - RoofSegmentSummary: - id: RoofSegmentSummary + Whether leases are allowed in this juristiction (leases are not + allowed in some states). If this field is false, then the values in + this message should probably be ignored. description: >- - Information about a roof segment on the building, with some number of - panels placed on it. + Cost and benefit of leasing a particular configuration of solar panels + with a particular electricity usage. + id: LeasingSavings + SolarPanel: + description: >- + SolarPanel describes the position, orientation, and production of a + single solar panel. See the panel_height_meters, panel_width_meters, and + panel_capacity_watts fields in SolarPotential for information on the + parameters of the panel. properties: + orientation: + description: The orientation of the panel. + enumDescriptions: + - No panel orientation is known. + - >- + A `LANDSCAPE` panel has its long edge perpendicular to the azimuth + direction of the roof segment that it is placed on. + - >- + A `PORTRAIT` panel has its long edge parallel to the azimuth + direction of the roof segment that it is placed on. + type: string + enum: + - SOLAR_PANEL_ORIENTATION_UNSPECIFIED + - LANDSCAPE + - PORTRAIT yearlyEnergyDcKwh: - description: >- - How much sunlight energy this part of the layout captures over the - course of a year, in DC kWh, assuming the panels described above. - format: float type: number - segmentIndex: - format: int32 - description: >- - Index in roof_segment_stats of the corresponding - `RoofSegmentSizeAndSunshineStats`. - type: integer - pitchDegrees: format: float description: >- - Angle of the roof segment relative to the theoretical ground plane. - 0 = parallel to the ground, 90 = perpendicular to the ground. - type: number - panelsCount: + How much sunlight energy this layout captures over the course of a + year, in DC kWh. + segmentIndex: format: int32 - description: The total number of panels on this segment. - type: integer - azimuthDegrees: description: >- - Compass direction the roof segment is pointing in. 0 = North, 90 = - East, 180 = South. For a "flat" roof segment (`pitch_degrees` very - near 0), azimuth is not well defined, so for consistency, we define - it arbitrarily to be 0 (North). - type: number - format: float + Index in roof_segment_stats of the `RoofSegmentSizeAndSunshineStats` + which corresponds to the roof segment that this panel is placed on. + type: integer + center: + $ref: '#/components/schemas/LatLng' + description: The centre of the panel. type: object + id: SolarPanel Date: - type: object - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of day and time zone are either specified elsewhere or are - insignificant. The date is relative to the Gregorian Calendar. This can - represent one of the following: * A full date, with non-zero year, - month, and day values. * A month and day, with a zero year (for example, - an anniversary). * A year on its own, with a zero month and a zero day. - * A year and month, with a zero day (for example, a credit card - expiration date). Related types: * google.type.TimeOfDay * - google.type.DateTime * google.protobuf.Timestamp properties: - day: - format: int32 + month: + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a month and day. type: integer + format: int32 + day: description: >- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - year: type: integer + format: int32 + year: + format: int32 description: >- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - format: int32 - month: - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a month and day. - format: int32 type: integer id: Date - DataLayers: description: >- - Information about the solar potential of a region. The actual data are - contained in a number of GeoTIFF files covering the requested region, - for which this message contains URLs: Each string in the `DataLayers` - message contains a URL from which the corresponding GeoTIFF can be - fetched. These URLs are valid for a few hours after they've been - generated. Most of the GeoTIFF files are at a resolution of 0.1m/pixel, - but the monthly flux file is at 0.5m/pixel, and the hourly shade files - are at 1m/pixel. If a `pixel_size_meters` value was specified in the - `GetDataLayersRequest`, then the minimum resolution in the GeoTIFF files - will be that value. + Represents a whole or partial calendar date, such as a birthday. The + time of day and time zone are either specified elsewhere or are + insignificant. The date is relative to the Gregorian Calendar. This can + represent one of the following: * A full date, with non-zero year, + month, and day values. * A month and day, with a zero year (for example, + an anniversary). * A year on its own, with a zero month and a zero day. + * A year and month, with a zero day (for example, a credit card + expiration date). Related types: * google.type.TimeOfDay * + google.type.DateTime * google.protobuf.Timestamp type: object + SizeAndSunshineStats: properties: - annualFluxUrl: - type: string - description: >- - The URL for the annual flux map (annual sunlight on roofs) of the - region. Values are kWh/kW/year. This is *unmasked flux*: flux is - computed for every location, not just building rooftops. Invalid - locations are stored as -9999: locations outside our coverage area - will be invalid, and a few locations inside the coverage area, where - we were unable to calculate flux, will also be invalid. - maskUrl: - description: >- - The URL for the building mask image: one bit per pixel saying - whether that pixel is considered to be part of a rooftop or not. - type: string - monthlyFluxUrl: - description: >- - The URL for the monthly flux map (sunlight on roofs, broken down by - month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to - by this URL will contain twelve bands, corresponding to - January...December, in order. - type: string - imageryQuality: - description: The quality of the result's imagery. - enum: - - IMAGERY_QUALITY_UNSPECIFIED - - HIGH - - MEDIUM - - LOW - type: string - enumDescriptions: - - No quality is known. - - The underlying imagery and DSM data were processed at 0.1 m/pixel. - - >- - The underlying imagery and DSM data were processed at 0.25 - m/pixel. - - The underlying imagery and DSM data were processed at 0.5 m/pixel. - imageryProcessedDate: - description: When processing was completed on this imagery. - $ref: '#/components/schemas/Date' - dsmUrl: - type: string - description: >- - The URL for an image of the DSM (Digital Surface Model) of the - region. Values are in meters above EGM96 geoid (i.e., sea level). - Invalid locations (where we don't have data) are stored as -9999. - imageryDate: - $ref: '#/components/schemas/Date' - description: >- - When the source imagery (from which all the other data are derived) - in this region was taken. It is necessarily somewhat approximate, as - the images may have been taken over more than one day. - rgbUrl: - type: string - description: The URL for an image of RGB data (aerial photo) of the region. - hourlyShadeUrls: - type: array + sunshineQuantiles: items: - type: string - description: >- - Twelve URLs for hourly shade, corresponding to January...December, - in order. Each GeoTIFF will contain 24 bands, corresponding to the - 24 hours of the day. Each pixel is a 32 bit integer, corresponding - to the (up to) 31 days of that month; a 1 bit means that the - corresponding location is able to see the sun at that day, of that - hour, of that month. Invalid locations are stored as -9999 (since - this is negative, it has bit 31 set, and no valid value could have - bit 31 set as that would correspond to the 32nd day of the month). - An example may be useful. If you want to know whether a point (at - pixel location (x, y)) saw sun at 4pm on the 22nd of June you would: - 1. fetch the sixth URL in this list (corresponding to June). 1. look - up the 17th channel (corresponding to 4pm). 1. read the 32-bit value - at (x, y). 1. read bit 21 of the value (corresponding to the 22nd of - the month). 1. if that bit is a 1, then that spot saw the sun at 4pm - 22 June. More formally: Given `month` (1-12), `day` (1...month max; - February has 28 days) and `hour` (0-23), the shade/sun for that - month/day/hour at a position `(x, y)` is the bit ``` - (hourly_shade[month - 1])(x, y)[hour] & (1 << (day - 1)) ``` where - `(x, y)` is spatial indexing, `[month - 1]` refers to fetching the - `month - 1`st URL (indexing from zero), `[hour]` is indexing into - the channels, and a final non-zero result means "sunny". There are - no leap days, and DST doesn't exist (all days are 24 hours long; - noon is always "standard time" noon). - id: DataLayers - FinancialDetails: - id: FinancialDetails - description: >- - Details of a financial analysis. Some of these details are already - stored at higher levels (e.g., out of pocket cost). Total money amounts - are over a lifetime period defined by the panel_lifetime_years field in - SolarPotential. Note: The out of pocket cost of purchasing the panels is - given in the out_of_pocket_cost field in CashPurchaseSavings. - properties: - utilityIncentive: + type: number + format: float description: >- - Amount of money available from utility incentives; this applies if - the user buys (with or without a loan) the panels. - $ref: '#/components/schemas/Money' - initialAcKwhPerYear: + Quantiles of the pointwise sunniness across the area. If there are N + values here, this represents the (N-1)-iles. For example, if there + are 5 values, then they would be the quartiles (min, 25%, 50%, 75%, + max). Values are in annual kWh/kW like max_sunshine_hours_per_year. + type: array + areaMeters2: type: number - format: float - description: >- - How many AC kWh we think the solar panels will generate in their - first year. - federalIncentive: - $ref: '#/components/schemas/Money' - description: >- - Amount of money available from federal incentives; this applies if - the user buys (with or without a loan) the panels. - stateIncentive: - description: >- - Amount of money available from state incentives; this applies if the - user buys (with or without a loan) the panels. - $ref: '#/components/schemas/Money' - costOfElectricityWithoutSolar: - $ref: '#/components/schemas/Money' - description: >- - Total cost of electricity the user would have paid over the lifetime - period if they didn't install solar. - lifetimeSrecTotal: - $ref: '#/components/schemas/Money' description: >- - Amount of money the user will receive from Solar Renewable Energy - Credits over the panel lifetime; this applies if the user buys (with - or without a loan) the panels. - solarPercentage: + The area of the roof or roof segment, in m^2. This is the roof area + (accounting for tilt), not the ground footprint area. format: float - type: number + groundAreaMeters2: description: >- - Percentage (0-100) of the user's power supplied by solar. Valid for - the first year but approximately correct for future years. - percentageExportedToGrid: + The ground footprint area covered by the roof or roof segment, in + m^2. type: number - description: >- - The percentage (0-100) of solar electricity production we assumed - was exported to the grid, based on the first quarter of production. - This affects the calculations if net metering is not allowed. format: float - netMeteringAllowed: - type: boolean - description: Whether net metering is allowed. - remainingLifetimeUtilityBill: - description: >- - Utility bill for electricity not produced by solar, for the lifetime - of the panels. - $ref: '#/components/schemas/Money' type: object - LeasingSavings: - id: LeasingSavings + id: SizeAndSunshineStats + description: Size and sunniness quantiles of a roof, or part of a roof. + LatLngBox: + properties: + sw: + $ref: '#/components/schemas/LatLng' + description: The southwest corner of the box. + ne: + description: The northeast corner of the box. + $ref: '#/components/schemas/LatLng' + description: A bounding box in lat/lng coordinates. type: object + id: LatLngBox + LatLng: + id: LatLng + properties: + latitude: + format: double + description: The latitude in degrees. It must be in the range [-90.0, +90.0]. + type: number + longitude: + description: The longitude in degrees. It must be in the range [-180.0, +180.0]. + format: double + type: number description: >- - Cost and benefit of leasing a particular configuration of solar panels - with a particular electricity usage. + An object that represents a latitude/longitude pair. This is expressed + as a pair of doubles to represent degrees latitude and degrees + longitude. Unless specified otherwise, this object must conform to the + WGS84 standard. Values must be within normalized ranges. + type: object + HttpBody: + id: HttpBody + type: object properties: - annualLeasingCost: - description: Estimated annual leasing cost. - $ref: '#/components/schemas/Money' - leasesAllowed: - type: boolean + data: + type: string + description: The HTTP request/response body as raw binary. + format: byte + extensions: + type: array description: >- - Whether leases are allowed in this juristiction (leases are not - allowed in some states). If this field is false, then the values in - this message should probably be ignored. - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' - leasesSupported: - type: boolean + Application specific response metadata. Must be set in the first + response for streaming APIs. + items: + additionalProperties: + description: Properties of the object. Contains field @type with type URL. + type: any + type: object + contentType: + type: string description: >- - Whether leases are supported in this juristiction by the financial - calculation engine. If this field is false, then the values in this - message should probably be ignored. This is independent of - `leases_allowed`: in some areas leases are allowed, but under - conditions that aren't handled by the financial models. - FinancialAnalysis: + The HTTP Content-Type header value specifying the content type of + the body. description: >- - Analysis of the cost and benefits of the optimum solar layout for a - particular electric bill size. - type: object + Message that represents an arbitrary HTTP body. It should only be used + for payload formats that can't be represented as JSON, such as raw + binary or an HTML page. This message can be used both in streaming and + non-streaming API methods in the request as well as the response. It can + be used as a top-level request field, which is convenient if one wants + to extract parameters from either the URL or HTTP template into the + request fields and also want access to the raw HTTP body. Example: + message GetResourceRequest { // A unique request id. string request_id = + 1; // The raw HTTP body is bound to this field. google.api.HttpBody + http_body = 2; } service ResourceService { rpc + GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + Example with streaming methods: service CaldavService { rpc + GetCalendar(stream google.api.HttpBody) returns (stream + google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + returns (stream google.api.HttpBody); } Use of this type only changes + how the request and response bodies are handled, all other features will + continue to work unchanged. + SolarPanelConfig: + id: SolarPanelConfig properties: - financialDetails: + panelsCount: description: >- - Financial information that applies regardless of the financing - method used. - $ref: '#/components/schemas/FinancialDetails' - financedPurchaseSavings: - $ref: '#/components/schemas/FinancedPurchaseSavings' + Total number of panels. Note that this is redundant to (the sum of) + the corresponding fields in roof_segment_summaries. + type: integer + format: int32 + roofSegmentSummaries: + items: + $ref: '#/components/schemas/RoofSegmentSummary' + type: array description: >- - Cost and benefit of buying the solar panels by financing the - purchase. - averageKwhPerMonth: - format: float + Information about the production of each roof segment that is + carrying at least one panel in this layout. + `roof_segment_summaries[i]` describes the i-th roof segment, + including its size, expected production and orientation. + yearlyEnergyDcKwh: type: number + format: float description: >- - How much electricity the house uses in an average month, based on - the bill size and the local electricity rates. - cashPurchaseSavings: - $ref: '#/components/schemas/CashPurchaseSavings' - description: Cost and benefit of buying the solar panels with cash. - monthlyBill: - description: The monthly electric bill this analysis assumes. - $ref: '#/components/schemas/Money' - defaultBill: - type: boolean - description: >- - Whether this is the bill size selected to be the default bill for - the area this building is in. Exactly one `FinancialAnalysis` in - `BuildingSolarPotential` should have `default_bill` set. - panelConfigIndex: - format: int32 - type: integer - description: >- - Index in solar_panel_configs of the optimum solar layout for this - bill size. This can be -1 indicating that there is no layout. In - this case, the remaining submessages will be omitted. - leasingSavings: - description: Cost and benefit of leasing the solar panels. - $ref: '#/components/schemas/LeasingSavings' - id: FinancialAnalysis - BuildingInsights: - id: BuildingInsights + How much sunlight energy this layout captures over the course of a + year, in DC kWh, assuming the panels described above. + description: >- + SolarPanelConfig describes a particular placement of solar panels on the + roof. + type: object + Money: properties: - imageryProcessedDate: - description: When processing was completed on this imagery. - $ref: '#/components/schemas/Date' - statisticalArea: - type: string - description: Statistical area (e.g., US census tract) this building is in. - imageryQuality: - enumDescriptions: - - No quality is known. - - The underlying imagery and DSM data were processed at 0.1 m/pixel. - - >- - The underlying imagery and DSM data were processed at 0.25 - m/pixel. - - The underlying imagery and DSM data were processed at 0.5 m/pixel. - type: string + units: + format: int64 description: >- - The quality of the imagery used to compute the data for this - building. - enum: - - IMAGERY_QUALITY_UNSPECIFIED - - HIGH - - MEDIUM - - LOW - solarPotential: - $ref: '#/components/schemas/SolarPotential' - description: Solar potential of the building. - postalCode: + The whole units of the amount. For example if `currencyCode` is + `"USD"`, then 1 unit is one US dollar. type: string - description: Postal code (e.g., US zip code) this building is contained by. - administrativeArea: + nanos: + format: int32 description: >- - Administrative area 1 (e.g., in the US, the state) that contains - this building. For example, in the US, the abbreviation might be - "MA" or "CA." - type: string - regionCode: - type: string - description: Region code for the country (or region) this building is in. - name: + Number of nano (10^-9) units of the amount. The value must be + between -999,999,999 and +999,999,999 inclusive. If `units` is + positive, `nanos` must be positive or zero. If `units` is zero, + `nanos` can be positive, zero, or negative. If `units` is negative, + `nanos` must be negative or zero. For example $-1.75 is represented + as `units`=-1 and `nanos`=-750,000,000. + type: integer + currencyCode: + description: The three-letter currency code defined in ISO 4217. type: string - description: The resource name for the building, of the format `building/`. - center: - $ref: '#/components/schemas/LatLng' - description: A point near the center of the building. - imageryDate: - description: Date that the underlying imagery was acquired. This is approximate. - $ref: '#/components/schemas/Date' - boundingBox: - $ref: '#/components/schemas/LatLngBox' - description: The bounding box of the building. - description: >- - Response message for `Solar.FindClosestBuildingInsights`. Information - about the location, dimensions, and solar potential of a building. type: object + id: Money + description: Represents an amount of money with its currency type. CashPurchaseSavings: - id: CashPurchaseSavings description: >- Cost and benefit of an outright purchase of a particular configuration of solar panels with a particular electricity usage. + type: object + id: CashPurchaseSavings properties: - outOfPocketCost: - $ref: '#/components/schemas/Money' - description: >- - Initial cost before tax incentives: the amount that must be paid - out-of-pocket. Contrast with `upfront_cost`, which is after tax - incentives. - savings: - description: How much is saved (or not) over the lifetime period. - $ref: '#/components/schemas/SavingsOverTime' rebateValue: $ref: '#/components/schemas/Money' description: The value of all tax rebates. @@ -806,50 +785,81 @@ components: never occurs within the lifetime period. type: number format: float + savings: + description: How much is saved (or not) over the lifetime period. + $ref: '#/components/schemas/SavingsOverTime' + outOfPocketCost: + $ref: '#/components/schemas/Money' + description: >- + Initial cost before tax incentives: the amount that must be paid + out-of-pocket. Contrast with `upfront_cost`, which is after tax + incentives. + SavingsOverTime: type: object + properties: + savingsYear20: + $ref: '#/components/schemas/Money' + description: Savings in the first twenty years after panel installation. + savingsYear1: + $ref: '#/components/schemas/Money' + description: Savings in the first year after panel installation. + presentValueOfSavingsYear20: + $ref: '#/components/schemas/Money' + description: >- + Using the assumed discount rate, what is the present value of the + cumulative 20-year savings? + presentValueOfSavingsLifetime: + $ref: '#/components/schemas/Money' + description: >- + Using the assumed discount rate, what is the present value of the + cumulative lifetime savings? + savingsLifetime: + $ref: '#/components/schemas/Money' + description: Savings in the entire panel lifetime. + financiallyViable: + description: >- + Indicates whether this scenario is financially viable. Will be false + for scenarios with poor financial viability (e.g., money-losing). + type: boolean + id: SavingsOverTime + description: Financial information that's shared between different financing methods. parameters: - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string upload_protocol: description: Upload protocol for media (e.g. "raw", "multipart"). in: query name: upload_protocol schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: oauth_token + name: uploadType schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + key: + description: >- + API key. Your API key identifies your project and provides you with API + access, quota, and reports. Required unless you provide an OAuth 2.0 + token. in: query - name: uploadType + name: key schema: type: string - callback: - description: JSONP + _.xgafv: + description: V1 error format. in: query - name: callback + name: $.xgafv schema: type: string + enum: + - '1' + - '2' alt: description: Data format for response. in: query @@ -860,6 +870,12 @@ components: - json - media - proto + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token + schema: + type: string quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -869,41 +885,41 @@ components: name: quotaUser schema: type: string - _.xgafv: - description: V1 error format. + access_token: + description: OAuth access token. in: query - name: $.xgafv + name: access_token schema: type: string - enum: - - '1' - - '2' - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. + prettyPrint: + description: Returns response with indentations and line breaks. in: query - name: key + name: prettyPrint + schema: + type: boolean + callback: + description: JSONP + in: query + name: callback schema: type: string x-stackQL-resources: - data_layers: - id: google.solar.data_layers - name: data_layers - title: Data_layers + building_insights: + id: google.solar.building_insights + name: building_insights + title: Building_insights methods: - get: + find_closest: operation: - $ref: '#/paths/~1v1~1dataLayers:get/get' + $ref: '#/paths/~1v1~1buildingInsights:findClosest/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/data_layers/methods/get' + select: [] insert: [] update: [] + replace: [] delete: [] geo_tiff: id: google.solar.geo_tiff @@ -921,43 +937,46 @@ components: - $ref: '#/components/x-stackQL-resources/geo_tiff/methods/get' insert: [] update: [] + replace: [] delete: [] - building_insights: - id: google.solar.building_insights - name: building_insights - title: Building_insights + data_layers: + id: google.solar.data_layers + name: data_layers + title: Data_layers methods: - find_closest: + get: operation: - $ref: '#/paths/~1v1~1buildingInsights:findClosest/get' + $ref: '#/paths/~1v1~1dataLayers:get/get' response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: '#/components/x-stackQL-resources/data_layers/methods/get' insert: [] update: [] + replace: [] delete: [] paths: - /v1/dataLayers:get: + /v1/buildingInsights:findClosest: parameters: &ref_1 - - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/alt' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/callback' get: description: >- - Gets solar information for a region surrounding a location. Returns an - error with code `NOT_FOUND` if the location is outside the coverage - area. - operationId: solar.dataLayers.get + Locates the closest building to a query point. Returns an error with + code `NOT_FOUND` if there are no buildings within approximately 50m of + the query point. + operationId: solar.buildingInsights.findClosest security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -969,40 +988,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DataLayers' + $ref: '#/components/schemas/BuildingInsights' parameters: - in: query - name: requiredQuality - schema: - type: string - - in: query - name: view - schema: - type: string - - in: query - name: location.longitude + name: location.latitude schema: type: number format: double - in: query - name: radiusMeters + name: experiments schema: - type: number - format: float + type: string - in: query - name: exactQualityRequired + name: requiredQuality schema: - type: boolean + type: string - in: query - name: location.latitude + name: location.longitude schema: type: number format: double - - in: query - name: pixelSizeMeters - schema: - type: number - format: float /v1/geoTiff:get: parameters: *ref_1 get: @@ -1025,14 +1030,14 @@ paths: name: id schema: type: string - /v1/buildingInsights:findClosest: + /v1/dataLayers:get: parameters: *ref_1 get: description: >- - Locates the closest building to a query point. Returns an error with - code `NOT_FOUND` if there are no buildings within approximately 50m of - the query point. - operationId: solar.buildingInsights.findClosest + Gets solar information for a region surrounding a location. Returns an + error with code `NOT_FOUND` if the location is outside the coverage + area. + operationId: solar.dataLayers.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1044,10 +1049,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BuildingInsights' + $ref: '#/components/schemas/DataLayers' parameters: - in: query - name: location.longitude + name: experiments + schema: + type: string + - in: query + name: pixelSizeMeters + schema: + type: number + format: float + - in: query + name: location.latitude schema: type: number format: double @@ -1056,7 +1070,20 @@ paths: schema: type: string - in: query - name: location.latitude + name: exactQualityRequired + schema: + type: boolean + - in: query + name: view + schema: + type: string + - in: query + name: radiusMeters + schema: + type: number + format: float + - in: query + name: location.longitude schema: type: number format: double diff --git a/providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml b/providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml deleted file mode 100644 index d5212e0d..00000000 --- a/providers/src/googleapis.com/v00.00.00000/services/sourcerepo.yaml +++ /dev/null @@ -1,1260 +0,0 @@ -openapi: 3.1.0 -info: - contact: - name: StackQL Studios - url: https://github.com/stackql/google-discovery-to-openapi - email: info@stackql.io - title: Cloud Source Repositories API - description: >- - Accesses source code repositories hosted by Google. Important: Cloud Source - Repositories is scheduled for end of sales starting June 17, 2024. Customers - who have enabled the API prior to this date will not be affected and can - continue to use Cloud Source Repositories. Organizations or projects who - have not previously enabled the API cannot use Cloud Source Repositories - after this date. View Cloud Source Repositories documentation for more - info. - version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' -externalDocs: - url: https://cloud.google.com/source-repositories/docs -servers: - - url: https://sourcerepo.googleapis.com -components: - securitySchemes: - Oauth2: - type: oauth2 - description: Oauth 2.0 implicit authentication - flows: - implicit: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - scopes: &ref_0 - https://www.googleapis.com/auth/cloud-platform: >- - See, edit, configure, and delete your Google Cloud data and see - the email address for your Google Account. - https://www.googleapis.com/auth/source.full_control: Manage your source code repositories - https://www.googleapis.com/auth/source.read_only: View the contents of your source code repositories - https://www.googleapis.com/auth/source.read_write: Manage the contents of your source code repositories - Oauth2c: - type: oauth2 - description: Oauth 2.0 authorization code authentication - flows: - authorizationCode: - authorizationUrl: https://accounts.google.com/o/oauth2/auth - tokenUrl: https://accounts.google.com/o/oauth2/token - scopes: *ref_0 - schemas: - ProjectConfig: - id: ProjectConfig - description: Cloud Source Repositories configuration of a project. - type: object - properties: - name: - description: The name of the project. Values are of the form `projects/`. - type: string - pubsubConfigs: - description: >- - How this project publishes a change in the repositories through - Cloud Pub/Sub. Keyed by the topic names. - type: object - additionalProperties: - $ref: '#/components/schemas/PubsubConfig' - enablePrivateKeyCheck: - description: Reject a Git push that contains a private key. - type: boolean - PubsubConfig: - id: PubsubConfig - description: Configuration to publish a Cloud Pub/Sub message. - type: object - properties: - topic: - description: >- - A topic of Cloud Pub/Sub. Values are of the form - `projects//topics/`. The project needs to be the same project as - this config is in. - type: string - messageFormat: - description: The format of the Cloud Pub/Sub messages. - type: string - enumDescriptions: - - Unspecified. - - >- - The message payload is a serialized protocol buffer of - SourceRepoEvent. - - The message payload is a JSON string of SourceRepoEvent. - enum: - - MESSAGE_FORMAT_UNSPECIFIED - - PROTOBUF - - JSON - serviceAccountEmail: - description: >- - Email address of the service account used for publishing Cloud - Pub/Sub messages. This service account needs to be in the same - project as the PubsubConfig. When added, the caller needs to have - iam.serviceAccounts.actAs permission on this service account. If - unspecified, it defaults to the compute engine default service - account. - type: string - UpdateProjectConfigRequest: - id: UpdateProjectConfigRequest - description: Request for UpdateProjectConfig. - type: object - properties: - projectConfig: - description: The new configuration for the project. - $ref: '#/components/schemas/ProjectConfig' - updateMask: - description: >- - A FieldMask specifying which fields of the project_config to modify. - Only the fields in the mask will be modified. If no mask is - provided, this request is no-op. - type: string - format: google-fieldmask - ListReposResponse: - id: ListReposResponse - description: >- - Response for ListRepos. The size is not set in the returned - repositories. - type: object - properties: - repos: - description: The listed repos. - type: array - items: - $ref: '#/components/schemas/Repo' - nextPageToken: - description: >- - If non-empty, additional repositories exist within the project. - These can be retrieved by including this value in the next - ListReposRequest's page_token field. - type: string - Repo: - id: Repo - description: >- - A repository (or repo) is a Git repository storing versioned source - content. - type: object - properties: - name: - description: >- - Resource name of the repository, of the form `projects//repos/`. The - repo name may contain slashes. eg, - `projects/myproject/repos/name/with/slash` - type: string - size: - description: >- - The disk usage of the repo, in bytes. Read-only field. Size is only - returned by GetRepo. - type: string - format: int64 - url: - description: >- - URL to clone the repository from Google Cloud Source Repositories. - Read-only field. - type: string - mirrorConfig: - description: >- - How this repository mirrors a repository managed by another service. - Read-only field. - $ref: '#/components/schemas/MirrorConfig' - pubsubConfigs: - description: >- - How this repository publishes a change in the repository through - Cloud Pub/Sub. Keyed by the topic names. - type: object - additionalProperties: - $ref: '#/components/schemas/PubsubConfig' - MirrorConfig: - id: MirrorConfig - description: >- - Configuration to automatically mirror a repository from another hosting - service, for example GitHub or Bitbucket. - type: object - properties: - url: - description: URL of the main repository at the other hosting service. - type: string - webhookId: - description: >- - ID of the webhook listening to updates to trigger mirroring. - Removing this webhook from the other hosting service will stop - Google Cloud Source Repositories from receiving notifications, and - thereby disabling mirroring. - type: string - deployKeyId: - description: >- - ID of the SSH deploy key at the other hosting service. Removing this - key from the other service would deauthorize Google Cloud Source - Repositories from mirroring. - type: string - UpdateRepoRequest: - id: UpdateRepoRequest - description: Request for UpdateRepo. - type: object - properties: - repo: - description: The new configuration for the repository. - $ref: '#/components/schemas/Repo' - updateMask: - description: >- - A FieldMask specifying which fields of the repo to modify. Only the - fields in the mask will be modified. If no mask is provided, this - request is no-op. - type: string - format: google-fieldmask - Empty: - id: Empty - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - type: object - properties: {} - SyncRepoRequest: - id: SyncRepoRequest - description: Request for SyncRepo. - type: object - properties: {} - Operation: - id: Operation - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object - properties: - name: - description: >- - The server-assigned name, which is only unique within the same - service that originally returns it. If you use the default HTTP - mapping, the `name` should be a resource name ending with - `operations/{unique_id}`. - type: string - metadata: - description: >- - Service-specific metadata associated with the operation. It - typically contains progress information and common metadata such as - create time. Some services might not provide such metadata. Any - method that returns a long-running operation should document the - metadata type, if any. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - done: - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. - type: boolean - error: - description: >- - The error result of the operation in case of failure or - cancellation. - $ref: '#/components/schemas/Status' - response: - description: >- - The normal, successful response of the operation. If the original - method returns no data on success, such as `Delete`, the response is - `google.protobuf.Empty`. If the original method is standard - `Get`/`Create`/`Update`, the response should be the resource. For - other methods, the response should have the type `XxxResponse`, - where `Xxx` is the original method name. For example, if the - original method name is `TakeSnapshot()`, the inferred response type - is `TakeSnapshotResponse`. - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - Status: - id: Status - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). - type: object - properties: - code: - description: The status code, which should be an enum value of google.rpc.Code. - type: integer - format: int32 - message: - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. - type: string - details: - description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. - type: array - items: - type: object - additionalProperties: - type: any - description: Properties of the object. Contains field @type with type URL. - SetIamPolicyRequest: - id: SetIamPolicyRequest - description: Request message for `SetIamPolicy` method. - type: object - properties: - policy: - description: >- - REQUIRED: The complete policy to be applied to the `resource`. The - size of the policy is limited to a few 10s of KB. An empty policy is - a valid policy but certain Google Cloud services (such as Projects) - might reject them. - $ref: '#/components/schemas/Policy' - updateMask: - description: >- - OPTIONAL: A FieldMask specifying which fields of the policy to - modify. Only the fields in the mask will be modified. If no mask is - provided, the following default mask is used: `paths: "bindings, - etag"` - type: string - format: google-fieldmask - Policy: - id: Policy - description: >- - An Identity and Access Management (IAM) policy, which specifies access - controls for Google Cloud resources. A `Policy` is a collection of - `bindings`. A `binding` binds one or more `members`, or principals, to a - single `role`. Principals can be user accounts, service accounts, Google - groups, and domains (such as G Suite). A `role` is a named list of - permissions; each `role` can be an IAM predefined role or a user-created - custom role. For some types of Google Cloud resources, a `binding` can - also specify a `condition`, which is a logical expression that allows - access to a resource only if the expression evaluates to `true`. A - condition can add constraints based on attributes of the request, the - resource, or both. To learn which resources support conditions in their - IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - **JSON example:** ``` { "bindings": [ { "role": - "roles/resourcemanager.organizationAdmin", "members": [ - "user:mike@example.com", "group:admins@example.com", - "domain:google.com", - "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { - "role": "roles/resourcemanager.organizationViewer", "members": [ - "user:eve@example.com" ], "condition": { "title": "expirable access", - "description": "Does not grant access after Sep 2020", "expression": - "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": - "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - - members: - user:mike@example.com - group:admins@example.com - - domain:google.com - - serviceAccount:my-project-id@appspot.gserviceaccount.com role: - roles/resourcemanager.organizationAdmin - members: - - user:eve@example.com role: roles/resourcemanager.organizationViewer - condition: title: expirable access description: Does not grant access - after Sep 2020 expression: request.time < - timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` - For a description of IAM and its features, see the [IAM - documentation](https://cloud.google.com/iam/docs/). - type: object - properties: - version: - description: >- - Specifies the format of the policy. Valid values are `0`, `1`, and - `3`. Requests that specify an invalid value are rejected. Any - operation that affects conditional role bindings must specify - version `3`. This requirement applies to the following operations: * - Getting a policy that includes a conditional role binding * Adding a - conditional role binding to a policy * Changing a conditional role - binding in a policy * Removing any role binding, with or without a - condition, from a policy that includes conditions **Important:** If - you use IAM Conditions, you must include the `etag` field whenever - you call `setIamPolicy`. If you omit this field, then IAM allows you - to overwrite a version `3` policy with a version `1` policy, and all - of the conditions in the version `3` policy are lost. If a policy - does not include any conditions, operations on that policy may - specify any valid version or leave the field unset. To learn which - resources support conditions in their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - type: integer - format: int32 - bindings: - description: >- - Associates a list of `members`, or principals, with a `role`. - Optionally, may specify a `condition` that determines how and when - the `bindings` are applied. Each of the `bindings` must contain at - least one principal. The `bindings` in a `Policy` can refer to up to - 1,500 principals; up to 250 of these principals can be Google - groups. Each occurrence of a principal counts towards these limits. - For example, if the `bindings` grant 50 different roles to - `user:alice@example.com`, and not to any other principal, then you - can add another 1,450 principals to the `bindings` in the `Policy`. - type: array - items: - $ref: '#/components/schemas/Binding' - auditConfigs: - description: Specifies cloud audit logging configuration for this policy. - type: array - items: - $ref: '#/components/schemas/AuditConfig' - etag: - description: >- - `etag` is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a policy from overwriting each - other. It is strongly suggested that systems make use of the `etag` - in the read-modify-write cycle to perform policy updates in order to - avoid race conditions: An `etag` is returned in the response to - `getIamPolicy`, and systems are expected to put that etag in the - request to `setIamPolicy` to ensure that their change will be - applied to the same version of the policy. **Important:** If you use - IAM Conditions, you must include the `etag` field whenever you call - `setIamPolicy`. If you omit this field, then IAM allows you to - overwrite a version `3` policy with a version `1` policy, and all of - the conditions in the version `3` policy are lost. - type: string - format: byte - Binding: - id: Binding - description: Associates `members`, or principals, with a `role`. - type: object - properties: - role: - description: >- - Role that is assigned to the list of `members`, or principals. For - example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an - overview of the IAM roles and permissions, see the [IAM - documentation](https://cloud.google.com/iam/docs/roles-overview). - For a list of the available pre-defined roles, see - [here](https://cloud.google.com/iam/docs/understanding-roles). - type: string - members: - description: >- - Specifies the principals requesting access for a Google Cloud - resource. `members` can have the following values: * `allUsers`: A - special identifier that represents anyone who is on the internet; - with or without a Google account. * `allAuthenticatedUsers`: A - special identifier that represents anyone who is authenticated with - a Google account or a service account. Does not include identities - that come from external identity providers (IdPs) through identity - federation. * `user:{emailid}`: An email address that represents a - specific Google account. For example, `alice@example.com` . * - `serviceAccount:{emailid}`: An email address that represents a - Google service account. For example, - `my-other-app@appspot.gserviceaccount.com`. * - `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: - An identifier for a [Kubernetes service - account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). - For example, - `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * - `group:{emailid}`: An email address that represents a Google group. - For example, `admins@example.com`. * `domain:{domain}`: The G Suite - domain (primary) that represents all the users of that domain. For - example, `google.com` or `example.com`. * - `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workforce identity pool. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: - All workforce identities in a group. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All workforce identities with a specific attribute value. * - `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: - All identities in a workforce identity pool. * - `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: - A single identity in a workload identity pool. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: - A workload identity pool group. * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: - All identities in a workload identity pool with a certain attribute. - * - `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: - All identities in a workload identity pool. * - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus - unique identifier) representing a user that has been recently - deleted. For example, `alice@example.com?uid=123456789012345678901`. - If the user is recovered, this value reverts to `user:{emailid}` and - the recovered user retains the role in the binding. * - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address - (plus unique identifier) representing a service account that has - been recently deleted. For example, - `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - If the service account is undeleted, this value reverts to - `serviceAccount:{emailid}` and the undeleted service account retains - the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: - An email address (plus unique identifier) representing a Google - group that has been recently deleted. For example, - `admins@example.com?uid=123456789012345678901`. If the group is - recovered, this value reverts to `group:{emailid}` and the recovered - group retains the role in the binding. * - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: - Deleted single identity in a workforce identity pool. For example, - `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - type: array - items: - type: string - condition: - description: >- - The condition that is associated with this binding. If the condition - evaluates to `true`, then this binding applies to the current - request. If the condition evaluates to `false`, then this binding - does not apply to the current request. However, a different role - binding might grant the same role to one or more of the principals - in this binding. To learn which resources support conditions in - their IAM policies, see the [IAM - documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - $ref: '#/components/schemas/Expr' - Expr: - id: Expr - 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. - type: object - properties: - expression: - description: >- - Textual representation of an expression in Common Expression - Language syntax. - type: string - title: - description: >- - Optional. Title for the expression, i.e. a short string describing - its purpose. This can be used e.g. in UIs which allow to enter the - expression. - type: string - description: - description: >- - Optional. Description of the expression. This is a longer text which - describes the expression, e.g. when hovered over it in a UI. - type: string - location: - description: >- - Optional. String indicating the location of the expression for error - reporting, e.g. a file name and a position in the file. - type: string - AuditConfig: - id: AuditConfig - description: >- - Specifies the audit configuration for a service. The configuration - determines which permission types are logged, and what identities, if - any, are exempted from logging. An AuditConfig must have one or more - AuditLogConfigs. If there are AuditConfigs for both `allServices` and a - specific service, the union of the two AuditConfigs is used for that - service: the log_types specified in each AuditConfig are enabled, and - the exempted_members in each AuditLogConfig are exempted. Example Policy - with multiple AuditConfigs: { "audit_configs": [ { "service": - "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", - "exempted_members": [ "user:jose@example.com" ] }, { "log_type": - "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": - "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": - "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ - "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy - enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts - `jose@example.com` from DATA_READ logging, and `aliya@example.com` from - DATA_WRITE logging. - type: object - properties: - service: - description: >- - Specifies a service that will be enabled for audit logging. For - example, `storage.googleapis.com`, `cloudsql.googleapis.com`. - `allServices` is a special value that covers all services. - type: string - auditLogConfigs: - description: The configuration for logging of each type of permission. - type: array - items: - $ref: '#/components/schemas/AuditLogConfig' - AuditLogConfig: - id: AuditLogConfig - description: >- - Provides the configuration for logging a type of permissions. Example: { - "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ - "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This - enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - jose@example.com from DATA_READ logging. - type: object - properties: - logType: - description: The log type that this config enables. - type: string - enumDescriptions: - - Default case. Should never be this. - - 'Admin reads. Example: CloudIAM getIamPolicy' - - 'Data writes. Example: CloudSQL Users create' - - 'Data reads. Example: CloudSQL Users list' - enum: - - LOG_TYPE_UNSPECIFIED - - ADMIN_READ - - DATA_WRITE - - DATA_READ - exemptedMembers: - description: >- - Specifies the identities that do not cause logging for this type of - permission. Follows the same format of Binding.members. - type: array - items: - type: string - TestIamPermissionsRequest: - id: TestIamPermissionsRequest - description: Request message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - The set of permissions to check for the `resource`. Permissions with - wildcards (such as `*` or `storage.*`) are not allowed. For more - information see [IAM - Overview](https://cloud.google.com/iam/docs/overview#permissions). - type: array - items: - type: string - TestIamPermissionsResponse: - id: TestIamPermissionsResponse - description: Response message for `TestIamPermissions` method. - type: object - properties: - permissions: - description: >- - A subset of `TestPermissionsRequest.permissions` that the caller is - allowed. - type: array - items: - type: string - SyncRepoMetadata: - id: SyncRepoMetadata - description: >- - Metadata of SyncRepo. This message is in the metadata field of - Operation. - type: object - properties: - name: - description: >- - The name of the repo being synchronized. Values are of the form - `projects//repos/`. - type: string - statusMessage: - description: The latest status message on syncing the repository. - type: string - startTime: - description: The time this operation is started. - type: string - format: google-datetime - updateTime: - description: The time this operation's status message is updated. - type: string - format: google-datetime - parameters: - access_token: - description: OAuth access token. - in: query - name: access_token - schema: - type: string - alt: - description: Data format for response. - in: query - name: alt - schema: - type: string - enum: - - json - - media - - proto - callback: - description: JSONP - in: query - name: callback - schema: - type: string - fields: - description: Selector specifying which fields to include in a partial response. - in: query - name: fields - schema: - type: string - key: - description: >- - API key. Your API key identifies your project and provides you with API - access, quota, and reports. Required unless you provide an OAuth 2.0 - token. - in: query - name: key - schema: - type: string - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). - in: query - name: upload_protocol - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string - _.xgafv: - description: V1 error format. - in: query - name: $.xgafv - schema: - type: string - enum: - - '1' - - '2' - x-stackQL-resources: - config: - id: google.sourcerepo.config - name: config - title: Config - methods: - get_config: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1config/get' - response: - mediaType: application/json - openAPIDocKey: '200' - update_config: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1config/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/config/methods/get_config' - insert: [] - update: [] - delete: [] - repos: - id: google.sourcerepo.repos - name: repos - title: Repos - methods: - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1repos/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.repos - list: - operation: *ref_1 - response: *ref_2 - create: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1repos/post' - response: - mediaType: application/json - openAPIDocKey: '200' - get: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1repos~1{reposId}/get' - response: - mediaType: application/json - openAPIDocKey: '200' - patch: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1repos~1{reposId}/patch' - response: - mediaType: application/json - openAPIDocKey: '200' - delete: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1repos~1{reposId}/delete' - response: - mediaType: application/json - openAPIDocKey: '200' - sync: - operation: - $ref: '#/paths/~1v1~1projects~1{projectsId}~1repos~1{reposId}:sync/post' - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/repos/methods/get' - - $ref: '#/components/x-stackQL-resources/repos/methods/list' - insert: - - $ref: '#/components/x-stackQL-resources/repos/methods/create' - update: - - $ref: '#/components/x-stackQL-resources/repos/methods/patch' - delete: - - $ref: '#/components/x-stackQL-resources/repos/methods/delete' - repos_iam_policies: - id: google.sourcerepo.repos_iam_policies - name: repos_iam_policies - title: Repos_iam_policies - methods: - set_iam_policy: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1repos~1{reposId}:setIamPolicy/post - response: - mediaType: application/json - openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_3 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1repos~1{reposId}:getIamPolicy/get - response: &ref_4 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.bindings - get_iam_policy: - operation: *ref_3 - response: *ref_4 - test_iam_permissions: - operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1repos~1{reposId}:testIamPermissions/post - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: >- - #/components/x-stackQL-resources/repos_iam_policies/methods/get_iam_policy - insert: [] - update: [] - delete: [] -paths: - /v1/projects/{projectsId}/config: - parameters: &ref_5 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/oauth_token' - - $ref: '#/components/parameters/prettyPrint' - - $ref: '#/components/parameters/quotaUser' - - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/_.xgafv' - get: - description: Returns the Cloud Source Repositories configuration of the project. - operationId: sourcerepo.projects.getConfig - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectConfig' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - patch: - description: Updates the Cloud Source Repositories configuration of the project. - operationId: sourcerepo.projects.updateConfig - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateProjectConfigRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ProjectConfig' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v1/projects/{projectsId}/repos: - parameters: *ref_5 - get: - description: >- - Returns all repos belonging to a project. The sizes of the repos are not - set by ListRepos. To get the size of a repo, use GetRepo. - operationId: sourcerepo.projects.repos.list - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/source.full_control - Oauth2c: - - https://www.googleapis.com/auth/source.full_control - - Oauth2: - - https://www.googleapis.com/auth/source.read_only - Oauth2c: - - https://www.googleapis.com/auth/source.read_only - - Oauth2: - - https://www.googleapis.com/auth/source.read_write - Oauth2c: - - https://www.googleapis.com/auth/source.read_write - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/ListReposResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string - post: - description: >- - Creates a repo in the given project with the given name. If the named - repository already exists, `CreateRepo` returns `ALREADY_EXISTS`. - operationId: sourcerepo.projects.repos.create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Repo' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/source.full_control - Oauth2c: - - https://www.googleapis.com/auth/source.full_control - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Repo' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - /v1/projects/{projectsId}/repos/{reposId}: - parameters: *ref_5 - get: - description: Returns information about a repo. - operationId: sourcerepo.projects.repos.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/source.full_control - Oauth2c: - - https://www.googleapis.com/auth/source.full_control - - Oauth2: - - https://www.googleapis.com/auth/source.read_only - Oauth2c: - - https://www.googleapis.com/auth/source.read_only - - Oauth2: - - https://www.googleapis.com/auth/source.read_write - Oauth2c: - - https://www.googleapis.com/auth/source.read_write - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Repo' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: reposId - required: true - schema: - type: string - patch: - description: Updates information about a repo. - operationId: sourcerepo.projects.repos.patch - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateRepoRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Repo' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: reposId - required: true - schema: - type: string - delete: - description: Deletes a repo. - operationId: sourcerepo.projects.repos.delete - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/source.full_control - Oauth2c: - - https://www.googleapis.com/auth/source.full_control - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Empty' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: reposId - required: true - schema: - type: string - /v1/projects/{projectsId}/repos/{reposId}:sync: - parameters: *ref_5 - post: - description: >- - Synchronize a connected repo. The response contains SyncRepoMetadata in - the metadata field. - operationId: sourcerepo.projects.repos.sync - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SyncRepoRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Operation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: reposId - required: true - schema: - type: string - /v1/projects/{projectsId}/repos/{reposId}:setIamPolicy: - parameters: *ref_5 - post: - description: >- - Sets the IAM policy on the specified resource. Replaces any existing - policy. - operationId: sourcerepo.projects.repos.setIamPolicy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetIamPolicyRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/source.full_control - Oauth2c: - - https://www.googleapis.com/auth/source.full_control - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: reposId - required: true - schema: - type: string - /v1/projects/{projectsId}/repos/{reposId}:getIamPolicy: - parameters: *ref_5 - get: - description: >- - Gets the IAM policy policy for a resource. Returns an empty policy if - the resource exists and does not have a policy set. - operationId: sourcerepo.projects.repos.getIamPolicy - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/source.full_control - Oauth2c: - - https://www.googleapis.com/auth/source.full_control - - Oauth2: - - https://www.googleapis.com/auth/source.read_only - Oauth2c: - - https://www.googleapis.com/auth/source.read_only - - Oauth2: - - https://www.googleapis.com/auth/source.read_write - Oauth2c: - - https://www.googleapis.com/auth/source.read_write - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/Policy' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: reposId - required: true - schema: - type: string - - in: query - name: options.requestedPolicyVersion - schema: - type: integer - format: int32 - /v1/projects/{projectsId}/repos/{reposId}:testIamPermissions: - parameters: *ref_5 - post: - description: >- - 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. - operationId: sourcerepo.projects.repos.testIamPermissions - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsRequest' - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - - Oauth2: - - https://www.googleapis.com/auth/source.full_control - Oauth2c: - - https://www.googleapis.com/auth/source.full_control - - Oauth2: - - https://www.googleapis.com/auth/source.read_only - Oauth2c: - - https://www.googleapis.com/auth/source.read_only - - Oauth2: - - https://www.googleapis.com/auth/source.read_write - Oauth2c: - - https://www.googleapis.com/auth/source.read_write - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/TestIamPermissionsResponse' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: reposId - required: true - schema: - type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml b/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml index 5d8fd97d..4c5a2747 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/spanner.yaml @@ -9,8 +9,8 @@ info: Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service. version: v1 - x-discovery-doc-revision: '20240529' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/spanner/ servers: @@ -725,9 +725,9 @@ components: - POSTGRESQL enableDropProtection: description: >- - Whether drop protection is enabled for this database. Defaults to - false, if not set. For more details, please see how to [prevent - accidental database + Optional. Whether drop protection is enabled for this database. + Defaults to false, if not set. For more details, please see how to + [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). type: boolean reconciling: @@ -738,7 +738,7 @@ components: type: boolean quorumInfo: description: >- - Output only. Applicable only for databases that use dual region + Output only. Applicable only for databases that use dual-region instance configurations. Contains information about the quorum. readOnly: true $ref: '#/components/schemas/QuorumInfo' @@ -853,7 +853,7 @@ components: type: string QuorumInfo: id: QuorumInfo - description: Information about the dual region quorum. + description: Information about the dual-region quorum. type: object properties: quorumType: @@ -864,14 +864,14 @@ components: $ref: '#/components/schemas/QuorumType' initiator: description: >- - Output only. Whether this ChangeQuorum is a Google or User + Output only. Whether this `ChangeQuorum` is Google or User initiated. readOnly: true type: string enumDescriptions: - Unspecified. - - ChangeQuorum initiated by Google. - - ChangeQuorum initiated by User. + - '`ChangeQuorum` initiated by Google.' + - '`ChangeQuorum` initiated by User.' enum: - INITIATOR_UNSPECIFIED - GOOGLE @@ -884,22 +884,22 @@ components: etag: description: >- Output only. The etag is used for optimistic concurrency control as - a way to help prevent simultaneous ChangeQuorum requests that could - create a race condition. + a way to help prevent simultaneous `ChangeQuorum` requests that + might create a race condition. readOnly: true type: string QuorumType: id: QuorumType description: >- - Information about the database quorum type. this applies only for dual - region instance configs. + Information about the database quorum type. This only applies to + dual-region instance configs. type: object properties: singleRegion: - description: Single region quorum type. + description: Single-region quorum type. $ref: '#/components/schemas/SingleRegionQuorum' dualRegion: - description: Dual region quorum type. + description: Dual-region quorum type. $ref: '#/components/schemas/DualRegionQuorum' SingleRegionQuorum: id: SingleRegionQuorum @@ -909,11 +909,10 @@ components: servingLocation: description: >- Required. The location of the serving region, e.g. "us-central1". - The location must be one of the regions within the dual region + The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations - is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] - API. This should only be used if you plan to change quorum in - single-region quorum type. + is available using the GetInstanceConfig API. This should only be + used if you plan to change quorum to the single-region quorum type. type: string DualRegionQuorum: id: DualRegionQuorum @@ -965,13 +964,13 @@ components: - POSTGRESQL protoDescriptors: description: >- - Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE - statements in 'extra_statements' above. Contains a - protobuf-serialized - [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). - To generate it, [install](https://grpc.io/docs/protoc-installation/) - and run `protoc` with --include_imports and --descriptor_set_out. - For example, to generate for moon/shot/app.proto, run ``` $protoc + Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` + statements in 'extra_statements'. Contains a protobuf-serialized + [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) + descriptor set. To generate it, + [install](https://grpc.io/docs/protoc-installation/) and run + `protoc` with --include_imports and --descriptor_set_out. For + example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self @@ -1057,18 +1056,18 @@ components: properties: name: description: >- - Required. Name of the database in which to apply the ChangeQuorum. + Required. Name of the database in which to apply `ChangeQuorum`. Values are of the form `projects//instances//databases/`. type: string quorumType: - description: Required. The type of this Quorum. + description: Required. The type of this quorum. $ref: '#/components/schemas/QuorumType' etag: description: >- - Optional. The etag is the hash of the QuorumInfo. The ChangeQuorum - operation will only be performed if the etag matches that of the - QuorumInfo in the current database resource. Otherwise the API will - return an `ABORTED` error. The etag is used for optimistic + Optional. The etag is the hash of the `QuorumInfo`. The + `ChangeQuorum` operation is only performed if the etag matches that + of the `QuorumInfo` in the current database resource. Otherwise the + API returns an `ABORTED` error. The etag is used for optimistic concurrency control as a way to help prevent simultaneous change quorum requests that could create a race condition. type: string @@ -1407,7 +1406,34 @@ components: type: string format: google-datetime sizeBytes: - description: Output only. Size of the backup in bytes. + description: >- + Output only. Size of the backup in bytes. For a backup in an + incremental backup chain, this is the sum of the + `exclusive_size_bytes` of itself and all older backups in the chain. + readOnly: true + type: string + format: int64 + freeableSizeBytes: + description: >- + Output only. The number of bytes that will be freed by deleting this + backup. This value will be zero if, for example, this backup is part + of an incremental backup chain and younger backups in the chain + require that we keep its data. For backups not in an incremental + backup chain, this is always the size of the backup. This value may + change if backups on the same chain get created, deleted or expired. + readOnly: true + type: string + format: int64 + exclusiveSizeBytes: + description: >- + Output only. For a backup in an incremental backup chain, this is + the storage space needed to keep the data that has changed since the + previous backup. For all other backups, this is always the size of + the backup. This value may change if backups on the same chain get + deleted or expired. This field can be used to calculate the total + storage space used by a set of backups. For example, the total space + used by all backups of a database can be computed by summing up this + field. readOnly: true type: string format: int64 @@ -1492,6 +1518,41 @@ components: readOnly: true type: string format: google-datetime + backupSchedules: + description: >- + Output only. List of backup schedule URIs that are associated with + creating this backup. This is only applicable for scheduled backups, + and is empty for on-demand backups. To optimize for storage, + whenever possible, multiple schedules are collapsed together to + create one backup. In such cases, this field captures the list of + all backup schedule URIs that are associated with creating this + backup. If collapsing is not done, then this field captures the + single backup schedule URI associated with creating this backup. + readOnly: true + type: array + items: + type: string + incrementalBackupChainId: + description: >- + Output only. Populated only for backups in an incremental backup + chain. Backups share the same chain id if and only if they belong to + the same incremental backup chain. Use this field to determine which + backups are part of the same incremental backup chain. The ordering + of backups in the chain can be determined by ordering the backup + `version_time`. + readOnly: true + type: string + oldestVersionTime: + description: >- + Output only. Data deleted at a time older than this is guaranteed + not to be retained in order to support this backup. For a backup in + an incremental backup chain, this is the version time of the oldest + backup that exists or ever existed in the chain. For all other + backups, this is the version time of the backup. This field can be + used to understand what data is being retained by the backup system. + readOnly: true + type: string + format: google-datetime CopyBackupRequest: id: CopyBackupRequest description: The request for CopyBackup. @@ -1652,18 +1713,19 @@ components: kmsKeyNames: description: >- Optional. Specifies the KMS configuration for the one or more keys - used to encrypt the database. Values are of the form + used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance - configs, specify a single regional location KMS key. * For - multi-regional database instance configs of type GOOGLE_MANAGED, - either specify a multi-regional location KMS key or multiple - regional location KMS keys that cover all regions in the instance - config. * For a database instance config of type USER_MANAGED, - please specify only regional location KMS keys to cover each region - in the instance config. Multi-regional location KMS keys are not - supported for USER_MANAGED instance configs. + configurations, specify a single regional location KMS key. * For + multi-regional database instance configurations of type + `GOOGLE_MANAGED`, either specify a multi-regional location KMS key + or multiple regional location KMS keys that cover all regions in the + instance configuration. * For a database instance configuration of + type `USER_MANAGED`, please specify only regional location KMS keys + to cover each region in the instance configuration. Multi-regional + location KMS keys are not supported for USER_MANAGED instance + configurations. type: array items: type: string @@ -1735,6 +1797,184 @@ components: `projects//instances//databases//databaseRoles/` where `` is as specified in the `CREATE ROLE` DDL statement. type: string + BackupSchedule: + id: BackupSchedule + description: >- + BackupSchedule expresses the automated backup creation specification for + a Spanner database. Next ID: 10 + type: object + properties: + name: + description: >- + Identifier. Output only for the CreateBackupSchedule operation. + Required for the UpdateBackupSchedule operation. A globally unique + identifier for the backup schedule which cannot be changed. Values + are of the form + `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The + final segment of the name must be between 2 and 60 characters in + length. + type: string + spec: + description: >- + Optional. The schedule specification based on which the backup + creations are triggered. + $ref: '#/components/schemas/BackupScheduleSpec' + retentionDuration: + description: >- + Optional. The retention duration of a backup that must be at least 6 + hours and at most 366 days. The backup is eligible to be + automatically deleted once the retention period has elapsed. + type: string + format: google-duration + encryptionConfig: + description: >- + Optional. The encryption configuration that will be used to encrypt + the backup. If this field is not specified, the backup will use the + same encryption configuration as the database. + $ref: '#/components/schemas/CreateBackupEncryptionConfig' + fullBackupSpec: + description: The schedule creates only full backups. + $ref: '#/components/schemas/FullBackupSpec' + incrementalBackupSpec: + description: The schedule creates incremental backup chains. + $ref: '#/components/schemas/IncrementalBackupSpec' + updateTime: + description: >- + Output only. The timestamp at which the schedule was last updated. + If the schedule has never been updated, this field contains the + timestamp when the schedule was first created. + readOnly: true + type: string + format: google-datetime + BackupScheduleSpec: + id: BackupScheduleSpec + description: Defines specifications of the backup schedule. + type: object + properties: + cronSpec: + description: Cron style schedule specification. + $ref: '#/components/schemas/CrontabSpec' + CrontabSpec: + id: CrontabSpec + description: >- + CrontabSpec can be used to specify the version time and frequency at + which the backup should be created. + type: object + properties: + text: + description: >- + Required. Textual representation of the crontab. User can customize + the backup frequency and the backup version time using the cron + expression. The version time must be in UTC timzeone. The backup + will contain an externally consistent copy of the database at the + version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 + month. Examples of valid cron specifications: * `0 2/12 * * * ` : + every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * + * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * + * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once + a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once + a month on 8th day at 2 past midnight in UTC. + type: string + timeZone: + description: >- + Output only. The time zone of the times in `CrontabSpec.text`. + Currently only UTC is supported. + readOnly: true + type: string + creationWindow: + description: >- + Output only. Schedule backups will contain an externally consistent + copy of the database at the version time specified in + `schedule_spec.cron_spec`. However, Spanner may not initiate the + creation of the scheduled backups at that version time. Spanner will + initiate the creation of scheduled backups within the time window + bounded by the version_time specified in `schedule_spec.cron_spec` + and version_time + `creation_window`. + readOnly: true + type: string + format: google-duration + CreateBackupEncryptionConfig: + id: CreateBackupEncryptionConfig + description: Encryption configuration for the backup to create. + type: object + properties: + encryptionType: + description: Required. The encryption type of the backup. + type: string + enumDescriptions: + - Unspecified. Do not use. + - >- + Use the same encryption configuration as the database. This is the + default option when encryption_config is empty. For example, if + the database is using `Customer_Managed_Encryption`, the backup + will be using the same Cloud KMS key as the database. + - Use Google default encryption. + - >- + Use customer managed encryption. If specified, `kms_key_name` must + contain a valid Cloud KMS key. + enum: + - ENCRYPTION_TYPE_UNSPECIFIED + - USE_DATABASE_ENCRYPTION + - GOOGLE_DEFAULT_ENCRYPTION + - CUSTOMER_MANAGED_ENCRYPTION + kmsKeyName: + description: >- + Optional. The Cloud KMS key that will be used to protect the backup. + This field should be set only when encryption_type is + `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form + `projects//locations//keyRings//cryptoKeys/`. + type: string + kmsKeyNames: + description: >- + Optional. Specifies the KMS configuration for the one or more keys + used to protect the backup. Values are of the form + `projects//locations//keyRings//cryptoKeys/`. The keys referenced by + kms_key_names must fully cover all regions of the backup's instance + configuration. Some examples: * For single region instance configs, + specify a single regional location KMS key. * For multi-regional + instance configs of type GOOGLE_MANAGED, either specify a + multi-regional location KMS key or multiple regional location KMS + keys that cover all regions in the instance config. * For an + instance config of type USER_MANAGED, please specify only regional + location KMS keys to cover each region in the instance config. + Multi-regional location KMS keys are not supported for USER_MANAGED + instance configs. + type: array + items: + type: string + FullBackupSpec: + id: FullBackupSpec + description: >- + The specification for full backups. A full backup stores the entire + contents of the database at a given version time. + type: object + properties: {} + IncrementalBackupSpec: + id: IncrementalBackupSpec + description: >- + The specification for incremental backup chains. An incremental backup + stores the delta of changes between a previous backup and the database + contents at a given version time. An incremental backup chain consists + of a full backup and zero or more successive incremental backups. The + first backup created for an incremental backup chain is always a full + backup. + type: object + properties: {} + ListBackupSchedulesResponse: + id: ListBackupSchedulesResponse + description: The response for ListBackupSchedules. + type: object + properties: + backupSchedules: + description: The list of backup schedules for a database. + type: array + items: + $ref: '#/components/schemas/BackupSchedule' + nextPageToken: + description: >- + `next_page_token` can be sent in a subsequent ListBackupSchedules + call to fetch more of the schedules. + type: string ListInstanceConfigsResponse: id: ListInstanceConfigsResponse description: The response for ListInstanceConfigs. @@ -1760,21 +2000,22 @@ components: name: description: >- A unique identifier for the instance configuration. Values are of - the form `projects//instanceConfigs/a-z*`. + the form `projects//instanceConfigs/a-z*`. User instance + configuration must start with `custom-`. type: string displayName: description: The name of this instance configuration as it appears in UIs. type: string configType: description: >- - Output only. Whether this instance config is a Google or User - Managed Configuration. + Output only. Whether this instance configuration is a Google-managed + or user-managed configuration. readOnly: true type: string enumDescriptions: - Unspecified. - - Google managed configuration. - - User managed configuration. + - Google-managed configuration. + - User-managed configuration. enum: - TYPE_UNSPECIFIED - GOOGLE_MANAGED @@ -1782,14 +2023,18 @@ components: replicas: description: >- The geographic placement of nodes in this instance configuration and - their replication properties. + their replication properties. To create user-managed configurations, + input `replicas` must include all replicas in `replicas` of the + `base_config` and include one or more replicas in the + `optional_replicas` of the `base_config`. type: array items: $ref: '#/components/schemas/ReplicaInfo' optionalReplicas: description: >- - Output only. The available optional replicas to choose from for user - managed configurations. Populated for Google managed configurations. + Output only. The available optional replicas to choose from for + user-managed configurations. Populated for Google-managed + configurations. readOnly: true type: array items: @@ -1797,9 +2042,9 @@ components: baseConfig: description: >- Base configuration name, e.g. projects//instanceConfigs/nam3, based - on which this configuration is created. Only set for user managed + on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type - GOOGLE_MANAGED in the same project as this configuration. + `GOOGLE_MANAGED` in the same project as this configuration. type: string labels: description: >- @@ -1827,16 +2072,16 @@ components: etag: description: >- etag is used for optimistic concurrency control as a way to help - prevent simultaneous updates of a instance config from overwriting - each other. It is strongly suggested that systems make use of the - etag in the read-modify-write cycle to perform instance config - updates in order to avoid race conditions: An etag is returned in - the response which contains instance configs, and systems are - expected to put that etag in the request to update instance config - to ensure that their change will be applied to the same version of - the instance config. If no etag is provided in the call to update - instance config, then the existing instance config is overwritten - blindly. + prevent simultaneous updates of a instance configuration from + overwriting each other. It is strongly suggested that systems make + use of the etag in the read-modify-write cycle to perform instance + configuration updates in order to avoid race conditions: An etag is + returned in the response which contains instance configurations, and + systems are expected to put that etag in the request to update + instance configuration to ensure that their change is applied to the + same version of the instance configuration. If no etag is provided + in the call to update the instance configuration, then the existing + instance configuration is overwritten blindly. type: string leaderOptions: description: >- @@ -1847,23 +2092,23 @@ components: type: string reconciling: description: >- - Output only. If true, the instance config is being created or + Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance - config. + configuration. readOnly: true type: boolean state: description: >- - Output only. The current instance config state. Applicable only for - USER_MANAGED configs. + Output only. The current instance configuration state. Applicable + only for `USER_MANAGED` configurations. readOnly: true type: string enumDescriptions: - Not specified. - - The instance config is still being created. + - The instance configuration is still being created. - >- - The instance config is fully created and ready to be used to - create instances. + The instance configuration is fully created and ready to be used + to create instances. enum: - STATE_UNSPECIFIED - CREATING @@ -1871,24 +2116,24 @@ components: freeInstanceAvailability: description: >- Output only. Describes whether free instances are available to be - created in this instance config. + created in this instance configuration. readOnly: true type: string enumDescriptions: - Not specified. - >- Indicates that free instances are available to be created in this - instance config. + instance configuration. - >- Indicates that free instances are not supported in this instance - config. + configuration. - >- Indicates that free instances are currently not available to be - created in this instance config. + created in this instance configuration. - >- Indicates that additional free instances cannot be created in this - instance config because the project has reached its limit of free - instances. + instance configuration because the project has reached its limit + of free instances. enum: - FREE_INSTANCE_AVAILABILITY_UNSPECIFIED - AVAILABLE @@ -1900,19 +2145,19 @@ components: readOnly: true type: string enumDescriptions: - - Not specified. + - Quorum type not specified. - >- - An instance configuration tagged with REGION quorum type forms a + An instance configuration tagged with `REGION` quorum type forms a write quorum in a single region. - >- - An instance configuration tagged with DUAL_REGION quorum type - forms a write quorums with exactly two read-write regions in a - multi-region configuration. This instance configurations requires - reconfiguration in the event of regional failures. + An instance configuration tagged with the `DUAL_REGION` quorum + type forms a write quorum with exactly two read-write regions in a + multi-region configuration. This instance configuration requires + failover in the event of regional failures. - >- - An instance configuration tagged with MULTI_REGION quorum type - forms a write quorums from replicas are spread across more than - one region in a multi-region configuration. + An instance configuration tagged with the `MULTI_REGION` quorum + type forms a write quorum from replicas that are spread across + more than one region in a multi-region configuration. enum: - QUORUM_TYPE_UNSPECIFIED - REGION @@ -1970,16 +2215,16 @@ components: properties: instanceConfigId: description: >- - Required. The ID of the instance config to create. Valid identifiers - are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 - and 64 characters in length. The `custom-` prefix is required to - avoid name conflicts with Google managed configurations. + Required. The ID of the instance configuration to create. Valid + identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be + between 2 and 64 characters in length. The `custom-` prefix is + required to avoid name conflicts with Google-managed configurations. type: string instanceConfig: description: >- - Required. The InstanceConfig proto of the configuration to create. - instance_config.name must be `/instanceConfigs/`. - instance_config.base_config must be a Google managed configuration + Required. The `InstanceConfig` proto of the configuration to create. + `instance_config.name` must be `/instanceConfigs/`. + `instance_config.base_config` must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. $ref: '#/components/schemas/InstanceConfig' validateOnly: @@ -1994,10 +2239,10 @@ components: properties: instanceConfig: description: >- - Required. The user instance config to update, which must always - include the instance config name. Otherwise, only fields mentioned - in update_mask need be included. To prevent conflicts of concurrent - updates, etag can be used. + Required. The user instance configuration to update, which must + always include the instance configuration name. Otherwise, only + fields mentioned in update_mask need be included. To prevent + conflicts of concurrent updates, etag can be used. $ref: '#/components/schemas/InstanceConfig' updateMask: description: >- @@ -2020,10 +2265,10 @@ components: properties: operations: description: >- - The list of matching instance config long-running operations. Each - operation's name will be prefixed by the instance config's name. The - operation's metadata field type `metadata.type_url` describes the - type of the metadata. + The list of matching instance configuration long-running operations. + Each operation's name will be prefixed by the name of the instance + configuration. The operation's metadata field type + `metadata.type_url` describes the type of the metadata. type: array items: $ref: '#/components/schemas/Operation' @@ -2084,30 +2329,30 @@ components: type: string nodeCount: description: >- - The number of nodes allocated to this instance. At most one of - either node_count or processing_units should be present in the - message. Users can set the node_count field to specify the target + The number of nodes allocated to this instance. At most, one of + either `node_count` or `processing_units` should be present in the + message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is - enabled, node_count is treated as an OUTPUT_ONLY field and reflects - the current number of nodes allocated to the instance. This may be - zero in API responses for instances that are not yet in state - `READY`. See [the - documentation](https://cloud.google.com/spanner/docs/compute-capacity) - for more information about nodes and processing units. + enabled, `node_count` is treated as an `OUTPUT_ONLY` field and + reflects the current number of nodes allocated to the instance. This + might be zero in API responses for instances that are not yet in the + `READY` state. For more information, see [Compute capacity, nodes, + and processing + units](https://cloud.google.com/spanner/docs/compute-capacity). type: integer format: int32 processingUnits: description: >- - The number of processing units allocated to this instance. At most - one of processing_units or node_count should be present in the - message. Users can set the processing_units field to specify the - target number of processing units allocated to the instance. If - autoscaling is enabled, processing_units is treated as an - OUTPUT_ONLY field and reflects the current number of processing - units allocated to the instance. This may be zero in API responses - for instances that are not yet in state `READY`. See [the - documentation](https://cloud.google.com/spanner/docs/compute-capacity) - for more information about nodes and processing units. + The number of processing units allocated to this instance. At most, + one of either `processing_units` or `node_count` should be present + in the message. Users can set the `processing_units` field to + specify the target number of processing units allocated to the + instance. If autoscaling is enabled, `processing_units` is treated + as an `OUTPUT_ONLY` field and reflects the current number of + processing units allocated to the instance. This might be zero in + API responses for instances that are not yet in the `READY` state. + For more information, see [Compute capacity, nodes and processing + units](https://cloud.google.com/spanner/docs/compute-capacity). type: integer format: int32 autoscalingConfig: @@ -2196,9 +2441,22 @@ components: freeInstanceMetadata: description: Free instance metadata. Only populated for free instances. $ref: '#/components/schemas/FreeInstanceMetadata' + edition: + description: Optional. The `Edition` of the current instance. + type: string + enumDescriptions: + - Edition not specified. + - Standard edition. + - Enterprise edition. + - Enterprise Plus edition. + enum: + - EDITION_UNSPECIFIED + - STANDARD + - ENTERPRISE + - ENTERPRISE_PLUS AutoscalingConfig: id: AutoscalingConfig - description: Autoscaling config for an instance. + description: Autoscaling configuration for an instance. type: object properties: autoscalingLimits: @@ -2358,7 +2616,7 @@ components: nodeCount: description: >- The number of nodes allocated to this instance partition. Users can - set the node_count field to specify the target number of nodes + set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. type: integer @@ -2366,10 +2624,10 @@ components: processingUnits: description: >- The number of processing units allocated to this instance partition. - Users can set the processing_units field to specify the target + Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This - may be zero in API responses for instance partitions that are not - yet in state `READY`. + might be zero in API responses for instance partitions that are not + yet in the `READY` state. type: integer format: int32 state: @@ -2413,11 +2671,13 @@ components: type: string referencingBackups: description: >- - Output only. The names of the backups that reference this instance - partition. Referencing backups should share the parent instance. The - existence of any referencing backup prevents the instance partition - from being deleted. + Output only. Deprecated: This field is not populated. Output only. + The names of the backups that reference this instance partition. + Referencing backups should share the parent instance. The existence + of any referencing backup prevents the instance partition from being + deleted. readOnly: true + deprecated: true type: array items: type: string @@ -2541,8 +2801,8 @@ components: properties: targetConfig: description: >- - Required. The target instance config for the instance to move. - Values are of the form `projects//instanceConfigs/`. + Required. The target instance configuration where to move the + instance. Values are of the form `projects//instanceConfigs/`. type: string CreateSessionRequest: id: CreateSessionRequest @@ -2592,12 +2852,12 @@ components: type: string multiplexed: description: >- - Optional. If true, specifies a multiplexed session. A multiplexed - session may be used for multiple, concurrent read-only operations - but can not be used for read-write transactions, partitioned reads, - or partitioned queries. Multiplexed sessions can be created via - CreateSession but not via BatchCreateSessions. Multiplexed sessions - may not be deleted nor listed. + Optional. If true, specifies a multiplexed session. Use a + multiplexed session for multiple, concurrent read-only operations. + Don't use them for read-write transactions, partitioned reads, or + partitioned queries. Use CreateSession to create multiplexed + sessions. Don't use BatchCreateSessions to create a multiplexed + session. You can't delete or list multiplexed sessions. type: boolean BatchCreateSessionsRequest: id: BatchCreateSessionsRequest @@ -2709,7 +2969,9 @@ components: execution statistics information. - >- This mode returns both the query plan and the execution statistics - along with the results. + along with the results. This has a performance overhead compared + to the NORMAL mode. It is not recommended to use this mode for + production traffic. enum: - NORMAL - PLAN @@ -3971,6 +4233,77 @@ components: resources. If the field is set to `true` but the request does not set `partition_token`, the API returns an `INVALID_ARGUMENT` error. type: boolean + orderBy: + description: >- + Optional. Order for the returned rows. By default, Spanner will + return result rows in primary key order except for PartitionRead + requests. For applications that do not require rows to be returned + in primary key (`ORDER_BY_PRIMARY_KEY`) order, setting + `ORDER_BY_NO_ORDER` option allows Spanner to optimize row retrieval, + resulting in lower latencies in certain cases (e.g. bulk point + lookups). + type: string + enumDescriptions: + - >- + Default value. ORDER_BY_UNSPECIFIED is equivalent to + ORDER_BY_PRIMARY_KEY. + - >- + Read rows are returned in primary key order. In the event that + this option is used in conjunction with the `partition_token` + field, the API will return an `INVALID_ARGUMENT` error. + - Read rows are returned in any order. + enum: + - ORDER_BY_UNSPECIFIED + - ORDER_BY_PRIMARY_KEY + - ORDER_BY_NO_ORDER + lockHint: + description: >- + Optional. Lock Hint for the request, it can only be used with + read-write transactions. + type: string + enumDescriptions: + - >- + Default value. LOCK_HINT_UNSPECIFIED is equivalent to + LOCK_HINT_SHARED. + - >- + Acquire shared locks. By default when you perform a read as part + of a read-write transaction, Spanner acquires shared read locks, + which allows other reads to still access the data until your + transaction is ready to commit. When your transaction is + committing and writes are being applied, the transaction attempts + to upgrade to an exclusive lock for any data you are writing. For + more information about locks, see [Lock + modes](https://cloud.google.com/spanner/docs/introspection/lock-statistics#explain-lock-modes). + - >- + Acquire exclusive locks. Requesting exclusive locks is beneficial + if you observe high write contention, which means you notice that + multiple transactions are concurrently trying to read and write to + the same data, resulting in a large number of aborts. This problem + occurs when two transactions initially acquire shared locks and + then both try to upgrade to exclusive locks at the same time. In + this situation both transactions are waiting for the other to give + up their lock, resulting in a deadlocked situation. Spanner is + able to detect this occurring and force one of the transactions to + abort. However, this is a slow and expensive operation and results + in lower performance. In this case it makes sense to acquire + exclusive locks at the start of the transaction because then when + multiple transactions try to act on the same data, they + automatically get serialized. Each transaction waits its turn to + acquire the lock and avoids getting into deadlock situations. + Because the exclusive lock hint is just a hint, it should not be + considered equivalent to a mutex. In other words, you should not + use Spanner exclusive locks as a mutual exclusion mechanism for + the execution of code outside of Spanner. **Note:** Request + exclusive locks judiciously because they block others from reading + that data for the entire transaction, rather than just when the + writes are being performed. Unless you observe high write + contention, you should use the default of shared read locks so you + don't prematurely block other clients from reading the data that + you're writing to. + enum: + - LOCK_HINT_UNSPECIFIED + - LOCK_HINT_SHARED + - LOCK_HINT_EXCLUSIVE KeySet: id: KeySet description: >- @@ -4274,15 +4607,16 @@ components: sql: description: >- Required. The query request to generate partitions for. The request - will fail if the query is not root partitionable. For a query to be - root partitionable, it needs to satisfy a few conditions. For - example, if the query execution plan contains a distributed union - operator, then it must be the first operator in the plan. For more - information about other conditions, see [Read data in + fails if the query is not root partitionable. For a query to be root + partitionable, it needs to satisfy a few conditions. For example, if + the query execution plan contains a distributed union operator, then + it must be the first operator in the plan. For more information + about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). - The query request must not contain DML commands, such as INSERT, - UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml - transaction for large, partition-friendly DML operations. + The query request must not contain DML commands, such as `INSERT`, + `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a + PartitionedDml transaction for large, partition-friendly DML + operations. type: string params: description: >- @@ -4602,7 +4936,7 @@ components: type: object properties: instanceConfig: - description: The target instance config end state. + description: The target instance configuration end state. $ref: '#/components/schemas/InstanceConfig' progress: description: The progress of the CreateInstanceConfig operation. @@ -4902,7 +5236,7 @@ components: type: object properties: instanceConfig: - description: The desired instance config after updating. + description: The desired instance configuration after updating. $ref: '#/components/schemas/InstanceConfig' progress: description: The progress of the UpdateInstanceConfig operation. @@ -5022,37 +5356,32 @@ components: name: scans title: Scans methods: - _scans_list: - operation: &ref_1 + scans_list: + operation: $ref: '#/paths/~1v1~1scans/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.scans - scans_list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/scans/methods/scans_list' insert: [] update: [] + replace: [] delete: [] instance_configs: id: google.spanner.instance_configs name: instance_configs title: Instance_configs methods: - _projects_instance_configs_list: - operation: &ref_3 + projects_instance_configs_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1instanceConfigs/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instanceConfigs - projects_instance_configs_list: - operation: *ref_3 - response: *ref_4 projects_instance_configs_create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1instanceConfigs/post' @@ -5092,6 +5421,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instance_configs/methods/projects_instance_configs_delete @@ -5100,17 +5430,14 @@ components: name: operations title: Operations methods: - _projects_instance_configs_operations_list: - operation: &ref_5 + projects_instance_configs_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instanceConfigs~1{instanceConfigsId}~1operations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instance_configs_operations_list: - operation: *ref_5 - response: *ref_6 projects_instance_configs_operations_get: operation: $ref: >- @@ -5132,17 +5459,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instance_configs_ssd_caches_operations_list: - operation: &ref_7 + projects_instance_configs_ssd_caches_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instanceConfigs~1{instanceConfigsId}~1ssdCaches~1{ssdCachesId}~1operations/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instance_configs_ssd_caches_operations_list: - operation: *ref_7 - response: *ref_8 projects_instance_configs_ssd_caches_operations_get: operation: $ref: >- @@ -5164,17 +5488,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_databases_operations_list: - operation: &ref_9 + projects_instances_databases_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1operations/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_databases_operations_list: - operation: *ref_9 - response: *ref_10 projects_instances_databases_operations_get: operation: $ref: >- @@ -5196,17 +5517,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_operations_list: - operation: &ref_11 + projects_instances_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1operations/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_operations_list: - operation: *ref_11 - response: *ref_12 projects_instances_operations_get: operation: $ref: >- @@ -5228,17 +5546,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_backups_operations_list: - operation: &ref_13 + projects_instances_backups_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}~1operations/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_backups_operations_list: - operation: *ref_13 - response: *ref_14 projects_instances_backups_operations_get: operation: $ref: >- @@ -5260,17 +5575,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_instance_partitions_operations_list: - operation: &ref_15 + projects_instances_instance_partitions_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions~1{instancePartitionsId}~1operations/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_instance_partitions_operations_list: - operation: *ref_15 - response: *ref_16 projects_instances_instance_partitions_operations_get: operation: $ref: >- @@ -5320,6 +5632,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_instances_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_instance_configs_ssd_caches_operations_delete @@ -5338,38 +5651,33 @@ components: name: instance_config_operations title: Instance_config_operations methods: - _projects_instance_config_operations_list: - operation: &ref_17 + projects_instance_config_operations_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1instanceConfigOperations/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instance_config_operations_list: - operation: *ref_17 - response: *ref_18 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/instance_config_operations/methods/projects_instance_config_operations_list insert: [] update: [] + replace: [] delete: [] instances: id: google.spanner.instances name: instances title: Instances methods: - _projects_instances_list: - operation: &ref_19 + projects_instances_list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1instances/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instances - projects_instances_list: - operation: *ref_19 - response: *ref_20 projects_instances_create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1instances/post' @@ -5415,6 +5723,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_instances_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instances/methods/projects_instances_delete @@ -5430,17 +5739,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_get_iam_policy: - operation: &ref_21 + projects_instances_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}:getIamPolicy/post - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_instances_get_iam_policy: - operation: *ref_21 - response: *ref_22 projects_instances_test_iam_permissions: operation: $ref: >- @@ -5454,6 +5760,9 @@ components: #/components/x-stackQL-resources/instances_iam_policies/methods/projects_instances_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/instances_iam_policies/methods/projects_instances_set_iam_policy delete: [] databases_scans: id: google.spanner.databases_scans @@ -5473,23 +5782,21 @@ components: #/components/x-stackQL-resources/databases_scans/methods/projects_instances_databases_get_scans insert: [] update: [] + replace: [] delete: [] databases: id: google.spanner.databases name: databases title: Databases methods: - _projects_instances_databases_list: - operation: &ref_23 + projects_instances_databases_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.databases - projects_instances_databases_list: - operation: *ref_23 - response: *ref_24 projects_instances_databases_create: operation: $ref: >- @@ -5544,7 +5851,10 @@ components: update: - $ref: >- #/components/x-stackQL-resources/databases/methods/projects_instances_databases_patch - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/databases/methods/projects_instances_databases_drop_database databases_ddl: id: google.spanner.databases_ddl name: databases_ddl @@ -5569,7 +5879,10 @@ components: - $ref: >- #/components/x-stackQL-resources/databases_ddl/methods/projects_instances_databases_get_ddl insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/databases_ddl/methods/projects_instances_databases_update_ddl + replace: [] delete: [] databases_iam_policies: id: google.spanner.databases_iam_policies @@ -5583,17 +5896,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_databases_get_iam_policy: - operation: &ref_25 + projects_instances_databases_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}:getIamPolicy/post - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_instances_databases_get_iam_policy: - operation: *ref_25 - response: *ref_26 projects_instances_databases_test_iam_permissions: operation: $ref: >- @@ -5607,7 +5917,104 @@ components: #/components/x-stackQL-resources/databases_iam_policies/methods/projects_instances_databases_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/databases_iam_policies/methods/projects_instances_databases_set_iam_policy + delete: [] + backup_schedules_iam_policies: + id: google.spanner.backup_schedules_iam_policies + name: backup_schedules_iam_policies + title: Backup_schedules_iam_policies + methods: + projects_instances_databases_backup_schedules_set_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules~1{backupSchedulesId}:setIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_backup_schedules_get_iam_policy: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules~1{backupSchedulesId}:getIamPolicy/post + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.bindings + projects_instances_databases_backup_schedules_test_iam_permissions: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules~1{backupSchedulesId}:testIamPermissions/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/backup_schedules_iam_policies/methods/projects_instances_databases_backup_schedules_get_iam_policy + insert: [] + update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backup_schedules_iam_policies/methods/projects_instances_databases_backup_schedules_set_iam_policy delete: [] + backup_schedules: + id: google.spanner.backup_schedules + name: backup_schedules + title: Backup_schedules + methods: + projects_instances_databases_backup_schedules_create: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules/post + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_backup_schedules_list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.backupSchedules + projects_instances_databases_backup_schedules_get: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules~1{backupSchedulesId}/get + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_backup_schedules_patch: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules~1{backupSchedulesId}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + projects_instances_databases_backup_schedules_delete: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1backupSchedules~1{backupSchedulesId}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/backup_schedules/methods/projects_instances_databases_backup_schedules_get + - $ref: >- + #/components/x-stackQL-resources/backup_schedules/methods/projects_instances_databases_backup_schedules_list + insert: + - $ref: >- + #/components/x-stackQL-resources/backup_schedules/methods/projects_instances_databases_backup_schedules_create + update: + - $ref: >- + #/components/x-stackQL-resources/backup_schedules/methods/projects_instances_databases_backup_schedules_patch + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/backup_schedules/methods/projects_instances_databases_backup_schedules_delete database_roles_iam_policies: id: google.spanner.database_roles_iam_policies name: database_roles_iam_policies @@ -5624,29 +6031,28 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] database_roles: id: google.spanner.database_roles name: database_roles title: Database_roles methods: - _projects_instances_databases_database_roles_list: - operation: &ref_27 + projects_instances_databases_database_roles_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1databaseRoles/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.databaseRoles - projects_instances_databases_database_roles_list: - operation: *ref_27 - response: *ref_28 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/database_roles/methods/projects_instances_databases_database_roles_list insert: [] update: [] + replace: [] delete: [] sessions: id: google.spanner.sessions @@ -5660,17 +6066,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_databases_sessions_list: - operation: &ref_29 + projects_instances_databases_sessions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databases~1{databasesId}~1sessions/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sessions - projects_instances_databases_sessions_list: - operation: *ref_29 - response: *ref_30 projects_instances_databases_sessions_batch_create: operation: $ref: >- @@ -5778,7 +6181,10 @@ components: insert: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_create + - $ref: >- + #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_batch_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/sessions/methods/projects_instances_databases_sessions_delete @@ -5794,17 +6200,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_backups_get_iam_policy: - operation: &ref_31 + projects_instances_backups_get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups~1{backupsId}:getIamPolicy/post - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - projects_instances_backups_get_iam_policy: - operation: *ref_31 - response: *ref_32 projects_instances_backups_test_iam_permissions: operation: $ref: >- @@ -5818,6 +6221,9 @@ components: #/components/x-stackQL-resources/backups_iam_policies/methods/projects_instances_backups_get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/backups_iam_policies/methods/projects_instances_backups_set_iam_policy delete: [] backups: id: google.spanner.backups @@ -5831,17 +6237,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_instances_backups_list: - operation: &ref_33 + projects_instances_backups_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backups/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.backups - projects_instances_backups_list: - operation: *ref_33 - response: *ref_34 projects_instances_backups_copy: operation: $ref: >- @@ -5882,6 +6285,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/backups/methods/projects_instances_backups_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/backups/methods/projects_instances_backups_delete @@ -5890,63 +6294,56 @@ components: name: database_operations title: Database_operations methods: - _projects_instances_database_operations_list: - operation: &ref_35 + projects_instances_database_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1databaseOperations/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_database_operations_list: - operation: *ref_35 - response: *ref_36 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/database_operations/methods/projects_instances_database_operations_list insert: [] update: [] + replace: [] delete: [] backup_operations: id: google.spanner.backup_operations name: backup_operations title: Backup_operations methods: - _projects_instances_backup_operations_list: - operation: &ref_37 + projects_instances_backup_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1backupOperations/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_backup_operations_list: - operation: *ref_37 - response: *ref_38 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/backup_operations/methods/projects_instances_backup_operations_list insert: [] update: [] + replace: [] delete: [] instance_partitions: id: google.spanner.instance_partitions name: instance_partitions title: Instance_partitions methods: - _projects_instances_instance_partitions_list: - operation: &ref_39 + projects_instances_instance_partitions_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitions/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.instancePartitions - projects_instances_instance_partitions_list: - operation: *ref_39 - response: *ref_40 projects_instances_instance_partitions_create: operation: $ref: >- @@ -5987,6 +6384,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/instance_partitions/methods/projects_instances_instance_partitions_delete @@ -5995,27 +6393,25 @@ components: name: instance_partition_operations title: Instance_partition_operations methods: - _projects_instances_instance_partition_operations_list: - operation: &ref_41 + projects_instances_instance_partition_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1instances~1{instancesId}~1instancePartitionOperations/get - response: &ref_42 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_instances_instance_partition_operations_list: - operation: *ref_41 - response: *ref_42 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/instance_partition_operations/methods/projects_instances_instance_partition_operations_list insert: [] update: [] + replace: [] delete: [] paths: /v1/scans: - parameters: &ref_43 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -6065,9 +6461,11 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigs: - parameters: *ref_43 + parameters: *ref_1 get: - description: Lists the supported instance configurations for a given project. + description: >- + Lists the supported instance configurations for a given project. Returns + both Google-managed configurations and user-managed configurations. operationId: spanner.projects.instanceConfigs.list security: - Oauth2: @@ -6102,22 +6500,23 @@ paths: type: string post: description: >- - Creates an instance config and begins preparing it to be used. The - returned long-running operation can be used to track the progress of - preparing the new instance config. The instance config name is assigned - by the caller. If the named instance config already exists, - `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the - request returns: * The instance config is readable via the API, with all - requested attributes. The instance config's reconciling field is set to - true. Its state is `CREATING`. While the operation is pending: * - Cancelling the operation renders the instance config immediately - unreadable via the API. * Except for deleting the creating resource, all - other attempts to modify the instance config are rejected. Upon - completion of the returned operation: * Instances can be created using - the instance configuration. * The instance config's reconciling field - becomes false. Its state becomes `READY`. The returned long-running - operation will have a name of the format `/operations/` and can be used - to track creation of the instance config. The metadata field type is + Creates an instance configuration and begins preparing it to be used. + The returned long-running operation can be used to track the progress of + preparing the new instance configuration. The instance configuration + name is assigned by the caller. If the named instance configuration + already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. + Immediately after the request returns: * The instance configuration is + readable via the API, with all requested attributes. The instance + configuration's reconciling field is set to true. Its state is + `CREATING`. While the operation is pending: * Cancelling the operation + renders the instance configuration immediately unreadable via the API. * + Except for deleting the creating resource, all other attempts to modify + the instance configuration are rejected. Upon completion of the returned + operation: * Instances can be created using the instance configuration. + * The instance configuration's reconciling field becomes false. Its + state becomes `READY`. The returned long-running operation will have a + name of the format `/operations/` and can be used to track creation of + the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. @@ -6150,7 +6549,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets information about a particular instance configuration. operationId: spanner.projects.instanceConfigs.get @@ -6183,25 +6582,26 @@ paths: type: string patch: description: >- - Updates an instance config. The returned long-running operation can be - used to track the progress of updating the instance. If the named - instance config does not exist, returns `NOT_FOUND`. Only user managed - configurations can be updated. Immediately after the request returns: * - The instance config's reconciling field is set to true. While the - operation is pending: * Cancelling the operation sets its metadata's - cancel_time. The operation is guaranteed to succeed at undoing all - changes, after which point it terminates with a `CANCELLED` status. * - All other attempts to modify the instance config are rejected. * Reading - the instance config via the API continues to give the pre-request - values. Upon completion of the returned operation: * Creating instances - using the instance configuration uses the new values. * The instance - config's new values are readable via the API. * The instance config's - reconciling field becomes false. The returned long-running operation - will have a name of the format `/operations/` and can be used to track - the instance config modification. The metadata field type is - UpdateInstanceConfigMetadata. The response field type is InstanceConfig, - if successful. Authorization requires `spanner.instanceConfigs.update` - permission on the resource name. + Updates an instance configuration. The returned long-running operation + can be used to track the progress of updating the instance. If the named + instance configuration does not exist, returns `NOT_FOUND`. Only + user-managed configurations can be updated. Immediately after the + request returns: * The instance configuration's reconciling field is set + to true. While the operation is pending: * Cancelling the operation sets + its metadata's cancel_time. The operation is guaranteed to succeed at + undoing all changes, after which point it terminates with a `CANCELLED` + status. * All other attempts to modify the instance configuration are + rejected. * Reading the instance configuration via the API continues to + give the pre-request values. Upon completion of the returned operation: + * Creating instances using the instance configuration uses the new + values. * The new values of the instance configuration are readable via + the API. * The instance configuration's reconciling field becomes false. + The returned long-running operation will have a name of the format + `/operations/` and can be used to track the instance configuration + modification. The metadata field type is UpdateInstanceConfigMetadata. + The response field type is InstanceConfig, if successful. Authorization + requires `spanner.instanceConfigs.update` permission on the resource + name. operationId: spanner.projects.instanceConfigs.patch requestBody: content: @@ -6237,11 +6637,11 @@ paths: type: string delete: description: >- - Deletes the instance config. Deletion is only allowed when no instances - are using the configuration. If any instances are using the config, - returns `FAILED_PRECONDITION`. Only user managed configurations can be - deleted. Authorization requires `spanner.instanceConfigs.delete` - permission on the resource name. + Deletes the instance configuration. Deletion is only allowed when no + instances are using the configuration. If any instances are using the + configuration, returns `FAILED_PRECONDITION`. Only user-managed + configurations can be deleted. Authorization requires + `spanner.instanceConfigs.delete` permission on the resource name. operationId: spanner.projects.instanceConfigs.delete security: - Oauth2: @@ -6279,7 +6679,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -6326,7 +6726,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -6405,7 +6805,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/operations/{operationsId}:cancel: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -6451,7 +6851,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/ssdCaches/{ssdCachesId}/operations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -6503,7 +6903,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/ssdCaches/{ssdCachesId}/operations/{operationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -6592,7 +6992,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}/ssdCaches/{ssdCachesId}/operations/{operationsId}:cancel: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -6643,14 +7043,14 @@ paths: schema: type: string /v1/projects/{projectsId}/instanceConfigOperations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- - Lists the user-managed instance config long-running operations in the - given project. An instance config operation has a name of the form - `projects//instanceConfigs//operations/`. The long-running operation - metadata field type `metadata.type_url` describes the type of the - metadata. Operations returned include those that have + Lists the user-managed instance configuration long-running operations in + the given project. An instance configuration operation has a name of the + form `projects//instanceConfigs//operations/`. The long-running + operation metadata field type `metadata.type_url` describes the type of + the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from @@ -6692,7 +7092,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists all instances in the given project. operationId: spanner.projects.instances.list @@ -6785,7 +7185,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets information about a particular instance. operationId: spanner.projects.instances.get @@ -6914,7 +7314,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Sets the access control policy on an instance resource. Replaces any @@ -6954,7 +7354,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Gets the access control policy for an instance resource. Returns an @@ -6994,7 +7394,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified instance @@ -7036,40 +7436,40 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}:move: - parameters: *ref_43 + parameters: *ref_1 post: description: >- - Moves the instance to the target instance config. The returned - long-running operation can be used to track the progress of moving the + Moves an instance to the target instance configuration. You can use the + returned long-running operation to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance - meets any of the following criteria: * Has an ongoing move to a - different instance config * Has backups * Has an ongoing update * Is - under free trial * Contains any CMEK-enabled databases While the + meets any of the following criteria: * Is undergoing a move to a + different instance configuration * Has backups * Has an ongoing update * + Contains any CMEK-enabled databases * Is a free trial instance While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * - DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl - (Disabled if default_leader is specified in the request.) * - DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * - DatabaseAdmin.CopyBackup * Both the source and target instance configs - are subject to hourly compute and storage charges. * The instance may - experience higher read-write latencies and a higher transaction abort - rate. However, moving an instance does not cause any downtime. The - returned long-running operation will have a name of the format + `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` + (disabled if default_leader is specified in the request.) * + `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * + `DatabaseAdmin.CopyBackup` * Both the source and target instance + configurations are subject to hourly compute and storage charges. * The + instance might experience higher read-write latencies and a higher + transaction abort rate. However, moving an instance doesn't cause any + downtime. The returned long-running operation has a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's - cancel_time. Cancellation is not immediate since it involves moving any - data previously moved to target instance config back to the original - instance config. The same operation can be used to track the progress of - the cancellation. Upon successful completion of the cancellation, the - operation terminates with CANCELLED status. Upon completion(if not - cancelled) of the returned operation: * Instance would be successfully - moved to the target instance config. * You are billed for compute and - storage in target instance config. Authorization requires - `spanner.instances.update` permission on the resource instance. For more - details, please see - [documentation](https://cloud.google.com/spanner/docs/move-instance). + cancel_time. Cancellation is not immediate because it involves moving + any data previously moved to the target instance configuration back to + the original instance configuration. You can use this operation to track + the progress of the cancellation. Upon successful completion of the + cancellation, the operation terminates with `CANCELLED` status. If not + cancelled, upon completion of the returned operation: * The instance + successfully moves to the target instance configuration. * You are + billed for compute and storage in target instance configuration. + Authorization requires the `spanner.instances.update` permission on the + resource instance. For more details, see [Move an + instance](https://cloud.google.com/spanner/docs/move-instance). operationId: spanner.projects.instances.move requestBody: content: @@ -7104,7 +7504,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/scans: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Request a specific scan with Database-specific data for Cloud Key @@ -7157,7 +7557,7 @@ paths: type: string format: google-datetime /v1/projects/{projectsId}/instances/{instancesId}/databases: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists Cloud Spanner databases. operationId: spanner.projects.instances.databases.list @@ -7199,11 +7599,11 @@ paths: type: string post: description: >- - Creates a new Cloud Spanner database and starts to prepare it for - serving. The returned long-running operation will have a name of the - format `/operations/` and can be used to track preparation of the - database. The metadata field type is CreateDatabaseMetadata. The - response field type is Database, if successful. + Creates a new Spanner database and starts to prepare it for serving. The + returned long-running operation will have a name of the format + `/operations/` and can be used to track preparation of the database. The + metadata field type is CreateDatabaseMetadata. The response field type + is Database, if successful. operationId: spanner.projects.instances.databases.create requestBody: content: @@ -7238,7 +7638,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets the state of a Cloud Spanner database. operationId: spanner.projects.instances.databases.get @@ -7376,7 +7776,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl: - parameters: *ref_43 + parameters: *ref_1 patch: description: >- Updates the schema of a Cloud Spanner database by @@ -7461,15 +7861,15 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:changequorum: - parameters: *ref_43 + parameters: *ref_1 post: description: >- - ChangeQuorum is strictly restricted to databases that use dual region - instance configurations. Initiates a background operation to change - quorum a database from dual-region mode to single-region mode and vice - versa. The returned long-running operation will have a name of the - format `projects//instances//databases//operations/` and can be used to - track execution of the ChangeQuorum. The metadata field type is + `ChangeQuorum` is strictly restricted to databases that use dual-region + instance configurations. Initiates a background operation to change the + quorum of a database from dual-region mode to single-region mode or vice + versa. The returned long-running operation has a name of the format + `projects//instances//databases//operations/` and can be used to track + execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database. operationId: spanner.projects.instances.databases.changequorum @@ -7511,7 +7911,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Sets the access control policy on a database or backup resource. @@ -7558,7 +7958,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Gets the access control policy for a database or backup resource. @@ -7605,7 +8005,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified database or @@ -7655,7 +8055,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases:restore: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Create a new database by restoring from a completed backup. The new @@ -7704,7 +8104,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -7756,7 +8156,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -7845,7 +8245,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -7895,8 +8295,389 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy: + parameters: *ref_1 + post: + description: >- + Sets the access control policy on a database or backup resource. + Replaces any existing policy. Authorization requires + `spanner.databases.setIamPolicy` permission on resource. For backups, + authorization requires `spanner.backups.setIamPolicy` permission on + resource. + operationId: spanner.projects.instances.databases.backupSchedules.setIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: backupSchedulesId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy: + parameters: *ref_1 + post: + description: >- + Gets the access control policy for a database or backup resource. + Returns an empty policy if a database or backup exists but does not have + a policy set. Authorization requires `spanner.databases.getIamPolicy` + permission on resource. For backups, authorization requires + `spanner.backups.getIamPolicy` permission on resource. + operationId: spanner.projects.instances.databases.backupSchedules.getIamPolicy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetIamPolicyRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Policy' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: backupSchedulesId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions: + parameters: *ref_1 + post: + description: >- + Returns permissions that the caller has on the specified database or + backup resource. Attempting this RPC on a non-existent Cloud Spanner + database will result in a NOT_FOUND error if the user has + `spanner.databases.list` permission on the containing Cloud Spanner + instance. Otherwise returns an empty set of permissions. Calling this + method on a backup that does not exist will result in a NOT_FOUND error + if the user has `spanner.backups.list` permission on the containing + instance. + operationId: spanner.projects.instances.databases.backupSchedules.testIamPermissions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/TestIamPermissionsResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: backupSchedulesId + required: true + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules: + parameters: *ref_1 + post: + description: Creates a new backup schedule. + operationId: spanner.projects.instances.databases.backupSchedules.create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupSchedule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupSchedule' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: query + name: backupScheduleId + schema: + type: string + get: + description: Lists all the backup schedules for the database. + operationId: spanner.projects.instances.databases.backupSchedules.list + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/ListBackupSchedulesResponse' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 + - in: query + name: pageToken + schema: + type: string + /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}: + parameters: *ref_1 + get: + description: Gets backup schedule for the input schedule name. + operationId: spanner.projects.instances.databases.backupSchedules.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupSchedule' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: backupSchedulesId + required: true + schema: + type: string + patch: + description: Updates a backup schedule. + operationId: spanner.projects.instances.databases.backupSchedules.patch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BackupSchedule' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/BackupSchedule' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: backupSchedulesId + required: true + schema: + type: string + - in: query + name: updateMask + schema: + type: string + format: google-fieldmask + delete: + description: Deletes a backup schedule. + operationId: spanner.projects.instances.databases.backupSchedules.delete + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/spanner.admin + Oauth2c: + - https://www.googleapis.com/auth/spanner.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: instancesId + required: true + schema: + type: string + - in: path + name: databasesId + required: true + schema: + type: string + - in: path + name: backupSchedulesId + required: true + schema: + type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles/{databaseRolesId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified database or @@ -7951,7 +8732,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/databaseRoles: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists Cloud Spanner database roles. operationId: spanner.projects.instances.databases.databaseRoles.list @@ -7997,7 +8778,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Creates a new session. A session can be used to perform transactions @@ -8099,7 +8880,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions:batchCreate: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Creates multiple new sessions. This API can be used to initialize a @@ -8144,7 +8925,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets a session. Returns `NOT_FOUND` if the session does not exist. This @@ -8231,7 +9012,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Executes an SQL statement, returning all results in a single reply. This @@ -8286,7 +9067,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Like ExecuteSql, except returns the result set as a stream. Unlike @@ -8337,7 +9118,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeBatchDml: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Executes a batch of SQL DML statements. This method allows many @@ -8392,7 +9173,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Reads rows from the database using key lookups and scans, as a simple @@ -8447,7 +9228,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Like Read, except returns the result set as a stream. Unlike Read, there @@ -8498,7 +9279,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Begins a new transaction. This step can often be skipped: Read, @@ -8547,7 +9328,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Commits a transaction. The request includes the mutations to be applied @@ -8605,7 +9386,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Rolls back a transaction, releasing any locks it holds. It is a good @@ -8658,7 +9439,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionQuery: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Creates a set of partition tokens that can be used to execute a query @@ -8715,7 +9496,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:partitionRead: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Creates a set of partition tokens that can be used to execute a read @@ -8774,7 +9555,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:batchWrite: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Batches the supplied mutation groups in a collection of efficient @@ -8835,7 +9616,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/operations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -8882,7 +9663,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8961,7 +9742,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -9007,7 +9788,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:setIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Sets the access control policy on a database or backup resource. @@ -9054,7 +9835,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:getIamPolicy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Gets the access control policy for a database or backup resource. @@ -9101,7 +9882,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}:testIamPermissions: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Returns permissions that the caller has on the specified database or @@ -9151,7 +9932,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts creating a new Cloud Spanner Backup. The returned backup @@ -9258,7 +10039,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups:copy: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts copying a Cloud Spanner Backup. The returned backup long-running @@ -9303,7 +10084,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets metadata on a pending or completed Backup. operationId: spanner.projects.instances.backups.get @@ -9420,7 +10201,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -9472,7 +10253,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -9561,7 +10342,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backups/{backupsId}/operations/{operationsId}:cancel: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -9612,7 +10393,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/databaseOperations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists database longrunning-operations. A database operation has a name @@ -9663,7 +10444,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/backupOperations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists the backup long-running operations in the given instance. A backup @@ -9717,7 +10498,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions: - parameters: *ref_43 + parameters: *ref_1 get: description: Lists all instance partitions for the given instance. operationId: spanner.projects.instances.instancePartitions.list @@ -9818,7 +10599,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: Gets information about a particular instance partition. operationId: spanner.projects.instances.instancePartitions.get @@ -9961,7 +10742,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -10013,7 +10794,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -10102,7 +10883,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/instancePartitions/{instancePartitionsId}/operations/{operationsId}:cancel: - parameters: *ref_43 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -10153,7 +10934,7 @@ paths: schema: type: string /v1/projects/{projectsId}/instances/{instancesId}/instancePartitionOperations: - parameters: *ref_43 + parameters: *ref_1 get: description: >- Lists instance partition long-running operations in the given instance. diff --git a/providers/src/googleapis.com/v00.00.00000/services/speech.yaml b/providers/src/googleapis.com/v00.00.00000/services/speech.yaml index f68543bb..9e99c020 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/speech.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/speech.yaml @@ -7,8 +7,8 @@ info: title: Cloud Speech-to-Text API description: Converts audio to text by applying powerful neural network models. version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/speech-to-text/docs/quickstart-protocol servers: @@ -1391,17 +1391,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1phraseSets/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.phraseSets - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -1431,6 +1428,7 @@ components: - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/create' update: - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/phrase_sets/methods/delete' custom_classes: @@ -1445,17 +1443,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1customClasses/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.customClasses - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1485,6 +1480,7 @@ components: - $ref: '#/components/x-stackQL-resources/custom_classes/methods/create' update: - $ref: '#/components/x-stackQL-resources/custom_classes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/custom_classes/methods/delete' operations: @@ -1492,16 +1488,13 @@ components: name: operations title: Operations methods: - _list: - operation: &ref_5 + list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/get' @@ -1514,6 +1507,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] speech: id: google.speech.speech @@ -1536,10 +1530,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/phraseSets: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1621,7 +1616,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/phraseSets/{phraseSetsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Get a phrase set. operationId: speech.projects.locations.phraseSets.get @@ -1726,7 +1721,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/customClasses: - parameters: *ref_7 + parameters: *ref_1 post: description: Create a custom class. operationId: speech.projects.locations.customClasses.create @@ -1794,7 +1789,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/customClasses/{customClassesId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Get a custom class. operationId: speech.projects.locations.customClasses.get @@ -1899,7 +1894,7 @@ paths: schema: type: string /v1/operations: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1936,7 +1931,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1962,7 +1957,7 @@ paths: schema: type: string /v1/speech:recognize: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Performs synchronous speech recognition: receive results after all audio @@ -1987,7 +1982,7 @@ paths: $ref: '#/components/schemas/RecognizeResponse' parameters: [] /v1/speech:longrunningrecognize: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Performs asynchronous speech recognition: receive results via the diff --git a/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml b/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml index bc9c0208..08bd34aa 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/sqladmin.yaml @@ -7,8 +7,8 @@ info: title: Cloud SQL Admin API description: API for Cloud SQL database instance management version: v1 - x-discovery-doc-revision: '20240521' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240831' + x-generated-date: '2024-09-13' externalDocs: url: https://developers.google.com/cloud-sql/ servers: @@ -178,6 +178,7 @@ components: - >- Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance. + - Updates the major version of a Cloud SQL instance. enumDeprecated: - false - false @@ -224,6 +225,7 @@ components: - false - false - false + - false enum: - SQL_OPERATION_TYPE_UNSPECIFIED - IMPORT @@ -270,6 +272,7 @@ components: - CLUSTER_MAINTENANCE - SELF_SERVICE_MAINTENANCE - SWITCHOVER_TO_REPLICA + - MAJOR_VERSION_UPGRADE importContext: description: The context for import operation, if applicable. $ref: '#/components/schemas/ImportContext' @@ -513,6 +516,24 @@ components: parallel: description: Optional. Whether or not the import should be parallel. type: boolean + postgresImportOptions: + description: >- + Optional. Options for importing from a Cloud SQL for PostgreSQL + instance. + type: object + properties: + clean: + description: >- + Optional. The --clean flag for the pg_restore utility. This + flag applies only if you enabled Cloud SQL to import files + in parallel. + type: boolean + ifExists: + description: >- + Optional. The --if-exists flag for the pg_restore utility. + This flag applies only if you enabled Cloud SQL to import + files in parallel. + type: boolean ExportContext: id: ExportContext description: Database instance export context. @@ -582,6 +603,21 @@ components: parallel: description: Optional. Whether or not the export should be parallel. type: boolean + postgresExportOptions: + description: Options for exporting from a Cloud SQL for PostgreSQL instance. + type: object + properties: + clean: + description: >- + Optional. Use this option to include DROP SQL statements. + These statements are used to delete database objects before + running the import operation. + type: boolean + ifExists: + description: >- + Optional. Option to include an IF EXISTS SQL statement with + each DROP statement produced by clean. + type: boolean csvExportOptions: description: >- Options for exporting data as CSV. `MySQL` and `PostgreSQL` @@ -667,6 +703,26 @@ components: Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base type: boolean + exportLogStartTime: + description: >- + Optional. The begin timestamp when transaction log will be + included in the export operation. [RFC + 3339](https://tools.ietf.org/html/rfc3339) format (for example, + `2023-10-01T16:19:00.094`) in UTC. When omitted, all available + logs from the beginning of retention period will be included. + Only applied to Cloud SQL for SQL Server. + type: string + format: google-datetime + exportLogEndTime: + description: >- + Optional. The end timestamp when transaction log will be + included in the export operation. [RFC + 3339](https://tools.ietf.org/html/rfc3339) format (for example, + `2023-10-01T16:19:00.094`) in UTC. When omitted, all available + logs until current time will be included. Only applied to Cloud + SQL for SQL Server. + type: string + format: google-datetime BackupContext: id: BackupContext description: Backup context. @@ -760,6 +816,13 @@ components: primary zone as the source instance. This field applies to all DB types. type: string + preferredSecondaryZone: + description: >- + Optional. Copy clone and point-in-time recovery clone of a regional + instance in the specified zones. If not specified, clone to the same + secondary zone as the source instance. This value cannot be the same + as the preferred_zone field. This field applies to all DB types. + type: string BinLogCoordinates: id: BinLogCoordinates description: Binary log coordinates. @@ -1007,6 +1070,7 @@ components: - The database version is PostgreSQL 14. - The database version is PostgreSQL 15. - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. - The database version is MySQL 8. - >- The database major version is MySQL 8.0 and the minor version is @@ -1057,7 +1121,6 @@ components: The database major version is MySQL 8.0 and the minor version is 40. - The database version is MySQL 8.4. - - The database version is MySQL 8.4 and the patch version is 0. - The database version is SQL Server 2019 Standard. - The database version is SQL Server 2019 Enterprise. - The database version is SQL Server 2019 Express. @@ -1089,8 +1152,8 @@ components: - false - false - false - - true - false + - true - false - false - false @@ -1129,6 +1192,7 @@ components: - POSTGRES_14 - POSTGRES_15 - POSTGRES_16 + - POSTGRES_17 - MYSQL_8_0 - MYSQL_8_0_18 - MYSQL_8_0_26 @@ -1147,7 +1211,6 @@ components: - MYSQL_8_0_39 - MYSQL_8_0_40 - MYSQL_8_4 - - MYSQL_8_4_0 - SQLSERVER_2019_STANDARD - SQLSERVER_2019_ENTERPRISE - SQLSERVER_2019_EXPRESS @@ -1434,6 +1497,17 @@ components: geminiConfig: description: Gemini instance configuration. $ref: '#/components/schemas/GeminiInstanceConfig' + satisfiesPzi: + description: >- + Output only. This status indicates whether the instance satisfies + PZI. The status is reserved for future use. + readOnly: true + type: boolean + switchTransactionLogsToCloudStorageEnabled: + description: >- + Input only. Whether Cloud SQL is enabled to switch storing + point-in-time recovery log files from a data disk to Cloud Storage. + type: boolean Settings: id: Settings description: Database instance settings. @@ -1699,6 +1773,12 @@ components: and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances. type: boolean + enableDataplexIntegration: + description: >- + Optional. By default, Cloud SQL instances have schema extraction + disabled for Dataplex. When this parameter is set to true, schema + extraction for Dataplex on Cloud SQL instances is activated. + type: boolean IpConfiguration: id: IpConfiguration description: IP Management configuration. @@ -1800,6 +1880,19 @@ components: pscConfig: description: PSC settings for this instance. $ref: '#/components/schemas/PscConfig' + serverCaMode: + description: Specify what type of CA is used for the server certificate. + type: string + enumDescriptions: + - CA mode is unknown. + - Google-managed self-signed internal CA. + - >- + Google-managed regional CA part of root CA hierarchy hosted on + Google Cloud's Certificate Authority Service (CAS). + enum: + - CA_MODE_UNSPECIFIED + - GOOGLE_MANAGED_INTERNAL_CA + - GOOGLE_MANAGED_CAS_CA AclEntry: id: AclEntry description: An entry for an Access Control list. @@ -1898,34 +1991,38 @@ components: type: object properties: hour: - description: hour of day - 0 to 23. + description: Hour of day - 0 to 23. Specify in the UTC time zone. type: integer format: int32 day: - description: day of week (1-7), starting on Monday. + description: >- + Day of week - `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, + `FRIDAY`, `SATURDAY`, or `SUNDAY`. Specify in the UTC time zone. + Returned in output as an integer, 1 to 7, where `1` equals Monday. type: integer format: int32 updateTrack: description: >- - Maintenance timing setting: `canary` (Earlier) or `stable` (Later). - [Learn - more](https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen). + Maintenance timing settings: `canary`, `stable`, or `week5`. For + more information, see [About maintenance on Cloud SQL + instances](https://cloud.google.com/sql/docs/mysql/maintenance). type: string enumDescriptions: - This is an unknown maintenance timing preference. - >- - For instance update that requires a restart, this update track - indicates your instance prefer to restart for new version early in - maintenance window. + For an instance with a scheduled maintenance window, this + maintenance timing indicates that the maintenance update is + scheduled 7 to 14 days after the notification is sent out. Also + referred to as `Week 1` (Console) and `preview` (gcloud CLI). - >- - For instance update that requires a restart, this update track - indicates your instance prefer to let Cloud SQL choose the timing - of restart (within its Maintenance window, if applicable). + For an instance with a scheduled maintenance window, this + maintenance timing indicates that the maintenance update is + scheduled 15 to 21 days after the notification is sent out. Also + referred to as `Week 2` (Console) and `production` (gcloud CLI). - >- - For instance update that requires a restart, this update track - indicates your instance prefer to let Cloud SQL choose the timing - of restart (within its Maintenance window, if applicable) to be at - least 5 weeks after the notification. + For instance with a scheduled maintenance window, this maintenance + timing indicates that the maintenance update is scheduled 35 to 42 + days after the notification is sent out. enum: - SQL_UPDATE_TRACK_UNSPECIFIED - canary @@ -2604,6 +2701,31 @@ components: kind: description: This is always `sql#instancesListServerCas`. type: string + InstancesListServerCertificatesResponse: + id: InstancesListServerCertificatesResponse + description: Instances ListServerCertificates response. + type: object + properties: + caCerts: + description: List of server CA certificates for the instance. + type: array + items: + $ref: '#/components/schemas/SslCert' + serverCerts: + description: >- + List of server certificates for the instance, signed by the + corresponding CA from the `ca_certs` list. + type: array + items: + $ref: '#/components/schemas/SslCert' + activeVersion: + description: >- + The `sha1_fingerprint` of the active certificate from + `server_certs`. + type: string + kind: + description: This is always `sql#instancesListServerCertificates`. + type: string InstancesRestoreBackupRequest: id: InstancesRestoreBackupRequest description: Database instance restore backup request. @@ -2654,6 +2776,30 @@ components: unspecified, will be rotated to the most recently added server CA version. type: string + InstancesRotateServerCertificateRequest: + id: InstancesRotateServerCertificateRequest + description: Rotate server certificate request. + type: object + properties: + rotateServerCertificateContext: + description: >- + Optional. Contains details about the rotate server certificate + operation. + $ref: '#/components/schemas/RotateServerCertificateContext' + RotateServerCertificateContext: + id: RotateServerCertificateContext + description: Instance rotate server certificate context. + type: object + properties: + kind: + description: Optional. This is always `sql#rotateServerCertificateContext`. + type: string + nextVersion: + description: >- + The fingerprint of the next version to be rotated to. If left + unspecified, will be rotated to the most recently added server + certificate version. + type: string InstancesTruncateLogRequest: id: InstancesTruncateLogRequest description: Instance truncate log request. @@ -2869,7 +3015,8 @@ components: - SQL Server Agent is not running. - >- The table definition is not support due to missing primary key or - replica identity, applicable for postgres. + replica identity, applicable for postgres. Note that this is a + warning and won't block the migration. - The customer has a definer that will break EM setup. - SQL Server @@SERVERNAME does not match actual host name. - The primary instance has been setup and will fail the setup. @@ -2924,6 +3071,36 @@ components: The data size of the source instance is greater than 1 TB, the number of cores of the replica instance is less than 8, and the memory of the replica is less than 32 GB. + - >- + The warning message indicates the unsupported extensions will not + be migrated to the destination. + - >- + The warning message indicates the pg_cron extension and settings + will not be migrated to the destination. + - >- + The error message indicates that pg_cron flags are enabled on the + destination which is not supported during the migration. + - >- + This error message indicates that the specified extensions are not + enabled on destination instance. For example, before you can + migrate data to the destination instance, you must enable the + PGAudit extension on the instance. + - >- + The source database has generated columns that can't be migrated. + Please change them to regular columns before migration. + - >- + The source database has users that aren't created in the replica. + First, create all users, which are in the pg_user_mappings table + of the source database, in the destination instance. Then, perform + the migration. + - >- + The selected objects include system objects that aren't supported + for migration. + - >- + The source database has tables with the FULL or NOTHING replica + identity. Before starting your migration, either remove the + identity or change it to DEFAULT. Note that this is an error and + will block the migration. enum: - SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED - CONNECTION_FAILURE @@ -2970,6 +3147,14 @@ components: - PG_SYNC_PARALLEL_LEVEL - INSUFFICIENT_DISK_SIZE - INSUFFICIENT_MACHINE_TIER + - UNSUPPORTED_EXTENSIONS_NOT_MIGRATED + - EXTENSIONS_NOT_MIGRATED + - PG_CRON_FLAG_ENABLED_IN_REPLICA + - EXTENSIONS_NOT_ENABLED_IN_REPLICA + - UNSUPPORTED_COLUMNS + - USERS_NOT_CREATED_IN_REPLICA + - UNSUPPORTED_SYSTEM_OBJECTS + - UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY detail: description: Additional information about the error encountered. type: string @@ -3221,6 +3406,11 @@ components: Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server. type: string + maxChargeableBytes: + description: Output only. The maximum chargeable bytes for the backup. + readOnly: true + type: string + format: int64 BackupRunsListResponse: id: BackupRunsListResponse description: Backup run list results. @@ -3295,6 +3485,7 @@ components: - The database version is PostgreSQL 14. - The database version is PostgreSQL 15. - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. - The database version is MySQL 8. - >- The database major version is MySQL 8.0 and the minor version is @@ -3345,7 +3536,6 @@ components: The database major version is MySQL 8.0 and the minor version is 40. - The database version is MySQL 8.4. - - The database version is MySQL 8.4 and the patch version is 0. - The database version is SQL Server 2019 Standard. - The database version is SQL Server 2019 Enterprise. - The database version is SQL Server 2019 Express. @@ -3377,8 +3567,8 @@ components: - false - false - false - - true - false + - true - false - false - false @@ -3417,6 +3607,7 @@ components: - POSTGRES_14 - POSTGRES_15 - POSTGRES_16 + - POSTGRES_17 - MYSQL_8_0 - MYSQL_8_0_18 - MYSQL_8_0_26 @@ -3435,7 +3626,6 @@ components: - MYSQL_8_0_39 - MYSQL_8_0_40 - MYSQL_8_4 - - MYSQL_8_4_0 - SQLSERVER_2019_STANDARD - SQLSERVER_2019_ENTERPRISE - SQLSERVER_2019_EXPRESS @@ -3472,6 +3662,19 @@ components: dnsName: description: The dns name of the instance. type: string + serverCaMode: + description: Specify what type of CA is used for the server certificate. + type: string + enumDescriptions: + - CA mode is unknown. + - Google-managed self-signed internal CA. + - >- + Google-managed regional CA part of root CA hierarchy hosted on + Google Cloud's Certificate Authority Service (CAS). + enum: + - CA_MODE_UNSPECIFIED + - GOOGLE_MANAGED_INTERNAL_CA + - GOOGLE_MANAGED_CAS_CA GenerateEphemeralCertRequest: id: GenerateEphemeralCertRequest description: Ephemeral certificate creation request. @@ -3648,6 +3851,7 @@ components: - The database version is PostgreSQL 14. - The database version is PostgreSQL 15. - The database version is PostgreSQL 16. + - The database version is PostgreSQL 17. - The database version is MySQL 8. - >- The database major version is MySQL 8.0 and the minor version is @@ -3698,7 +3902,6 @@ components: The database major version is MySQL 8.0 and the minor version is 40. - The database version is MySQL 8.4. - - The database version is MySQL 8.4 and the patch version is 0. - The database version is SQL Server 2019 Standard. - The database version is SQL Server 2019 Enterprise. - The database version is SQL Server 2019 Express. @@ -3730,8 +3933,8 @@ components: - false - false - false - - true - false + - true - false - false - false @@ -3770,6 +3973,7 @@ components: - POSTGRES_14 - POSTGRES_15 - POSTGRES_16 + - POSTGRES_17 - MYSQL_8_0 - MYSQL_8_0_18 - MYSQL_8_0_26 @@ -3788,7 +3992,6 @@ components: - MYSQL_8_0_39 - MYSQL_8_0_40 - MYSQL_8_4 - - MYSQL_8_4_0 - SQLSERVER_2019_STANDARD - SQLSERVER_2019_ENTERPRISE - SQLSERVER_2019_EXPRESS @@ -4002,9 +4205,11 @@ components: - The database's built-in user type. - Cloud IAM user. - Cloud IAM service account. - - Cloud IAM group non-login user. - - Cloud IAM group login user. - - Cloud IAM group login service account. + - Cloud IAM group. Not used for login. + - Read-only. Login for a user that belongs to the Cloud IAM group. + - >- + Read-only. Login for a service account that belongs to the Cloud + IAM group. enum: - BUILT_IN - CLOUD_IAM_USER @@ -4233,8 +4438,31 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/instances_server_ca/methods/add_server_ca + update: [] + replace: [] + delete: [] + instances_server_certificate: + id: google.sqladmin.instances_server_certificate + name: instances_server_certificate + title: Instances_server_certificate + methods: + add_server_certificate: + operation: + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1addServerCertificate/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/instances_server_certificate/methods/add_server_certificate update: [] + replace: [] delete: [] instances: id: google.sqladmin.instances @@ -4320,16 +4548,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{project}~1instances/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.warnings - list: - operation: *ref_1 - response: *ref_2 + list_server_certificates: + operation: + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1listServerCertificates/get + response: + mediaType: application/json + openAPIDocKey: '200' promote_replica: operation: $ref: >- @@ -4372,6 +4604,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' + rotate_server_certificate: + operation: + $ref: >- + #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1rotateServerCertificate/post + response: + mediaType: application/json + openAPIDocKey: '200' start_replica: operation: $ref: >- @@ -4450,6 +4689,7 @@ components: - $ref: '#/components/x-stackQL-resources/instances/methods/insert' update: - $ref: '#/components/x-stackQL-resources/instances/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/instances/methods/update' delete: - $ref: '#/components/x-stackQL-resources/instances/methods/delete' @@ -4471,6 +4711,7 @@ components: #/components/x-stackQL-resources/instances_server_cas/methods/list_server_cas insert: [] update: [] + replace: [] delete: [] ssl_certs_ephemeral: id: google.sqladmin.ssl_certs_ephemeral @@ -4490,6 +4731,7 @@ components: - $ref: >- #/components/x-stackQL-resources/ssl_certs_ephemeral/methods/create_ephemeral update: [] + replace: [] delete: [] ssl_certs: id: google.sqladmin.ssl_certs @@ -4531,6 +4773,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/ssl_certs/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/ssl_certs/methods/delete' instances_disk_shrink_config: @@ -4551,6 +4794,7 @@ components: #/components/x-stackQL-resources/instances_disk_shrink_config/methods/get_disk_shrink_config insert: [] update: [] + replace: [] delete: [] instances_latest_recovery_time: id: google.sqladmin.instances_latest_recovery_time @@ -4570,6 +4814,7 @@ components: #/components/x-stackQL-resources/instances_latest_recovery_time/methods/get_latest_recovery_time insert: [] update: [] + replace: [] delete: [] backup_runs: id: google.sqladmin.backup_runs @@ -4597,17 +4842,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1backupRuns/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/backup_runs/methods/get' @@ -4615,6 +4857,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/backup_runs/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/backup_runs/methods/delete' connect: @@ -4641,6 +4884,7 @@ components: - $ref: '#/components/x-stackQL-resources/connect/methods/get' insert: [] update: [] + replace: [] delete: [] databases: id: google.sqladmin.databases @@ -4697,6 +4941,7 @@ components: - $ref: '#/components/x-stackQL-resources/databases/methods/insert' update: - $ref: '#/components/x-stackQL-resources/databases/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/databases/methods/update' delete: - $ref: '#/components/x-stackQL-resources/databases/methods/delete' @@ -4716,6 +4961,7 @@ components: - $ref: '#/components/x-stackQL-resources/flags/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.sqladmin.operations @@ -4728,16 +4974,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: '#/paths/~1v1~1projects~1{project}~1operations/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_5 - response: *ref_6 cancel: operation: $ref: >- @@ -4751,6 +4994,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] tiers: id: google.sqladmin.tiers @@ -4768,6 +5012,7 @@ components: - $ref: '#/components/x-stackQL-resources/tiers/methods/list' insert: [] update: [] + replace: [] delete: [] users: id: google.sqladmin.users @@ -4788,17 +5033,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{project}~1instances~1{instance}~1users/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_7 - response: *ref_8 update: operation: $ref: >- @@ -4819,13 +5061,14 @@ components: - $ref: '#/components/x-stackQL-resources/users/methods/list' insert: - $ref: '#/components/x-stackQL-resources/users/methods/insert' - update: + update: [] + replace: - $ref: '#/components/x-stackQL-resources/users/methods/update' delete: - $ref: '#/components/x-stackQL-resources/users/methods/delete' paths: /v1/projects/{project}/instances/{instance}/addServerCa: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4843,7 +5086,9 @@ paths: instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA - version waiting to be rotated in. + version waiting to be rotated in. For instances that have enabled + Certificate Authority Service (CAS) based server CA, please use + AddServerCertificate to add a new server certificate. operationId: sql.instances.addServerCa security: - Oauth2: @@ -4872,8 +5117,47 @@ paths: required: true schema: type: string + /v1/projects/{project}/instances/{instance}/addServerCertificate: + parameters: *ref_1 + post: + description: >- + Add a new trusted server certificate version for the specified instance + using Certificate Authority Service (CAS) server CA. Required to prepare + for a certificate rotation. If a server certificate version was + previously added but never used in a certificate rotation, this + operation replaces that version. There cannot be more than one + certificate version waiting to be rotated in. For instances not using + CAS server CA, please use AddServerCa instead. + operationId: sql.instances.addServerCertificate + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: instance + required: true + schema: + type: string /v1/projects/{project}/instances/{instance}/clone: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates a Cloud SQL instance as a clone of the source instance. Using @@ -4912,7 +5196,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}: - parameters: *ref_9 + parameters: *ref_1 delete: description: Deletes a Cloud SQL instance. operationId: sql.instances.delete @@ -5049,7 +5333,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/demoteMaster: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Demotes the stand-alone instance to be a Cloud SQL read replica for an @@ -5088,7 +5372,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/demote: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Demotes an existing standalone instance to be a Cloud SQL read replica @@ -5127,7 +5411,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/export: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Exports data from a Cloud SQL instance to a Cloud Storage bucket as a @@ -5162,7 +5446,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/failover: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Initiates a manual failover of a high availability (HA) primary instance @@ -5206,7 +5490,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/reencrypt: - parameters: *ref_9 + parameters: *ref_1 post: description: Reencrypt CMEK instance with latest key version. operationId: sql.instances.reencrypt @@ -5243,7 +5527,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/import: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Imports data into a Cloud SQL instance from a SQL dump or CSV file in @@ -5278,7 +5562,7 @@ paths: schema: type: string /v1/projects/{project}/instances: - parameters: *ref_9 + parameters: *ref_1 post: description: Creates a new Cloud SQL instance. operationId: sql.instances.insert @@ -5348,7 +5632,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/listServerCas: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists all of the trusted Certificate Authorities (CAs) for the specified @@ -5384,8 +5668,45 @@ paths: required: true schema: type: string + /v1/projects/{project}/instances/{instance}/listServerCertificates: + parameters: *ref_1 + get: + description: >- + Lists all versions of server certificates and certificate authorities + (CAs) for the specified instance. There can be up to three sets of certs + listed: the certificate that is currently in use, a future that has been + added but not yet used to sign a certificate, and a certificate that has + been rotated out. + operationId: sql.instances.ListServerCertificates + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesListServerCertificatesResponse' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: instance + required: true + schema: + type: string /v1/projects/{project}/instances/{instance}/promoteReplica: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Promotes the read replica instance to be an independent Cloud SQL @@ -5424,7 +5745,7 @@ paths: schema: type: boolean /v1/projects/{project}/instances/{instance}/switchover: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Switches over from the primary instance to the designated DR replica @@ -5463,7 +5784,7 @@ paths: type: string format: google-duration /v1/projects/{project}/instances/{instance}/resetSslConfig: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Deletes all client certificates and generates a new server SSL @@ -5497,7 +5818,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/restart: - parameters: *ref_9 + parameters: *ref_1 post: description: Restarts a Cloud SQL instance. operationId: sql.instances.restart @@ -5529,7 +5850,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/restoreBackup: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Restores a backup of a Cloud SQL instance. Using this operation might @@ -5568,11 +5889,14 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/rotateServerCa: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Rotates the server certificate to one signed by the Certificate - Authority (CA) version previously added with the addServerCA method. + Authority (CA) version previously added with the addServerCA method. For + instances that have enabled Certificate Authority Service (CAS) based + server CA, please use RotateServerCertificate to rotate the server + certificate. operationId: sql.instances.rotateServerCa requestBody: content: @@ -5606,8 +5930,48 @@ paths: required: true schema: type: string + /v1/projects/{project}/instances/{instance}/rotateServerCertificate: + parameters: *ref_1 + post: + description: >- + Rotates the server certificate version to one previously added with the + addServerCertificate method. For instances not using Certificate + Authority Service (CAS) server CA, please use RotateServerCa instead. + operationId: sql.instances.RotateServerCertificate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InstancesRotateServerCertificateRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/sqlservice.admin + Oauth2c: + - https://www.googleapis.com/auth/sqlservice.admin + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Operation' + parameters: + - in: path + name: project + required: true + schema: + type: string + - in: path + name: instance + required: true + schema: + type: string /v1/projects/{project}/instances/{instance}/startReplica: - parameters: *ref_9 + parameters: *ref_1 post: description: Starts the replication in the read replica instance. operationId: sql.instances.startReplica @@ -5639,7 +6003,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/stopReplica: - parameters: *ref_9 + parameters: *ref_1 post: description: Stops the replication in the read replica instance. operationId: sql.instances.stopReplica @@ -5671,7 +6035,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/truncateLog: - parameters: *ref_9 + parameters: *ref_1 post: description: Truncate MySQL general and slow query log tables MySQL only. operationId: sql.instances.truncateLog @@ -5708,7 +6072,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/acquireSsrsLease: - parameters: *ref_9 + parameters: *ref_1 post: description: Acquire a lease for the setup of SQL Server Reporting Services (SSRS). operationId: sql.instances.acquireSsrsLease @@ -5745,7 +6109,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/releaseSsrsLease: - parameters: *ref_9 + parameters: *ref_1 post: description: Release a lease for the setup of SQL Server Reporting Services (SSRS). operationId: sql.instances.releaseSsrsLease @@ -5777,7 +6141,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/createEphemeral: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Generates a short-lived X509 certificate containing the provided public @@ -5818,7 +6182,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/sslCerts/{sha1Fingerprint}: - parameters: *ref_9 + parameters: *ref_1 delete: description: >- Deletes the SSL certificate. For First Generation instances, the @@ -5895,7 +6259,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/sslCerts: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Creates an SSL certificate and returns it along with the private key and @@ -5965,7 +6329,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/rescheduleMaintenance: - parameters: *ref_9 + parameters: *ref_1 post: description: Reschedules the maintenance on the given instance. operationId: sql.projects.instances.rescheduleMaintenance @@ -6003,7 +6367,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/verifyExternalSyncSettings: - parameters: *ref_9 + parameters: *ref_1 post: description: Verify External primary instance external sync settings. operationId: sql.projects.instances.verifyExternalSyncSettings @@ -6042,7 +6406,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/startExternalSync: - parameters: *ref_9 + parameters: *ref_1 post: description: Start External primary instance migration. operationId: sql.projects.instances.startExternalSync @@ -6079,7 +6443,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/performDiskShrink: - parameters: *ref_9 + parameters: *ref_1 post: description: Perform Disk Shrink on primary instance. operationId: sql.projects.instances.performDiskShrink @@ -6116,7 +6480,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/getDiskShrinkConfig: - parameters: *ref_9 + parameters: *ref_1 get: description: Get Disk Shrink Config for a given instance. operationId: sql.projects.instances.getDiskShrinkConfig @@ -6148,7 +6512,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/resetReplicaSize: - parameters: *ref_9 + parameters: *ref_1 post: description: Reset Replica Size to primary instance disk size. operationId: sql.projects.instances.resetReplicaSize @@ -6185,7 +6549,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/getLatestRecoveryTime: - parameters: *ref_9 + parameters: *ref_1 get: description: Get Latest Recovery Time for a given instance. operationId: sql.projects.instances.getLatestRecoveryTime @@ -6217,7 +6581,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/backupRuns/{id}: - parameters: *ref_9 + parameters: *ref_1 delete: description: Deletes the backup taken by a backup run. operationId: sql.backupRuns.delete @@ -6289,7 +6653,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/backupRuns: - parameters: *ref_9 + parameters: *ref_1 post: description: Creates a new backup run on demand. operationId: sql.backupRuns.insert @@ -6368,7 +6732,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/connectSettings: - parameters: *ref_9 + parameters: *ref_1 get: description: Retrieves connect settings about a Cloud SQL instance. operationId: sql.connect.get @@ -6405,7 +6769,7 @@ paths: type: string format: google-datetime /v1/projects/{project}/instances/{instance}:generateEphemeralCert: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Generates a short-lived X509 certificate containing the provided public @@ -6446,7 +6810,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/databases/{database}: - parameters: *ref_9 + parameters: *ref_1 delete: description: Deletes a database from a Cloud SQL instance. operationId: sql.databases.delete @@ -6604,7 +6968,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/databases: - parameters: *ref_9 + parameters: *ref_1 post: description: >- Inserts a resource containing information about a database inside a @@ -6674,7 +7038,7 @@ paths: schema: type: string /v1/flags: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists all available database flags for Cloud SQL instances. operationId: sql.flags.list @@ -6700,7 +7064,7 @@ paths: schema: type: string /v1/projects/{project}/operations/{operation}: - parameters: *ref_9 + parameters: *ref_1 get: description: Retrieves an instance operation that has been performed on an instance. operationId: sql.operations.get @@ -6732,7 +7096,7 @@ paths: schema: type: string /v1/projects/{project}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists all instance operations that have been performed on the given @@ -6774,7 +7138,7 @@ paths: schema: type: string /v1/projects/{project}/operations/{operation}/cancel: - parameters: *ref_9 + parameters: *ref_1 post: description: Cancels an instance operation that has been performed on an instance. operationId: sql.operations.cancel @@ -6806,7 +7170,7 @@ paths: schema: type: string /v1/projects/{project}/tiers: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists all available machine types (tiers) for Cloud SQL, for example, @@ -6836,7 +7200,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/users: - parameters: *ref_9 + parameters: *ref_1 delete: description: Deletes a user from a Cloud SQL instance. operationId: sql.users.delete @@ -6984,7 +7348,7 @@ paths: schema: type: string /v1/projects/{project}/instances/{instance}/users/{name}: - parameters: *ref_9 + parameters: *ref_1 get: description: Retrieves a resource containing information about a user. operationId: sql.users.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/storage.yaml b/providers/src/googleapis.com/v00.00.00000/services/storage.yaml index b39c4a5e..26bbae0f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/storage.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/storage.yaml @@ -7,8 +7,8 @@ info: title: Cloud Storage JSON API description: Stores and retrieves potentially large, immutable data objects. version: v1 - x-discovery-doc-revision: '20240528' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240831' + x-generated-date: '2024-09-13' externalDocs: url: https://developers.google.com/storage/docs/json_api/ servers: @@ -204,6 +204,50 @@ components: description: >- The ID of the bucket. For buckets, the id and name properties are the same. + ipFilter: + type: object + description: >- + The bucket's IP filter configuration. Specifies the network sources + that are allowed to access the operations on the bucket, as well as + its underlying objects. Only enforced when the mode is set to + 'Enabled'. + properties: + mode: + type: string + description: >- + The mode of the IP filter. Valid values are 'Enabled' and + 'Disabled'. + publicNetworkSource: + type: object + description: The public network source of the bucket's IP filter. + properties: + allowedIpCidrRanges: + type: array + description: >- + The list of public IPv4, IPv6 cidr ranges that are allowed + to access the bucket. + items: + type: string + vpcNetworkSources: + type: array + description: >- + The list of [VPC network](https://cloud.google.com/vpc/docs/vpc) + sources of the bucket's IP filter. + items: + type: object + properties: + network: + type: string + description: >- + Name of the network. Format: + projects/{PROJECT_ID}/global/networks/{NETWORK_NAME} + allowedIpCidrRanges: + type: array + description: >- + The list of IPv4, IPv6 cidr ranges subnetworks that are + allowed to access the bucket. + items: + type: string kind: type: string description: >- @@ -219,7 +263,8 @@ components: lifecycle: type: object description: >- - The bucket's lifecycle configuration. See lifecycle management for + The bucket's lifecycle configuration. See [Lifecycle + Management](https://cloud.google.com/storage/docs/lifecycle) for more information. properties: rule: @@ -380,7 +425,9 @@ components: description: >- The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See - the developer's guide for the authoritative list. + the [Developer's + Guide](https://cloud.google.com/storage/docs/locations) for the + authoritative list. locationType: type: string description: The type of the bucket location. @@ -398,6 +445,10 @@ components: logObjectPrefix: type: string description: A prefix for log object names. + generation: + type: string + description: The generation of this bucket. + format: int64 metageneration: type: string description: The metadata generation of this bucket. @@ -501,7 +552,8 @@ components: storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will - default to STANDARD. For more information, see storage classes. + default to STANDARD. For more information, see [Storage + Classes](https://cloud.google.com/storage/docs/storage-classes). timeCreated: type: string description: The creation time of the bucket in RFC 3339 format. @@ -510,6 +562,14 @@ components: type: string description: The modification time of the bucket in RFC 3339 format. format: date-time + softDeleteTime: + type: string + description: The soft delete time of the bucket in RFC 3339 format. + format: date-time + hardDeleteTime: + type: string + description: The hard delete time of the bucket in RFC 3339 format. + format: date-time versioning: type: object description: The bucket's versioning configuration. @@ -521,8 +581,10 @@ components: type: object description: >- The bucket's website configuration, controlling how the service - behaves when accessing bucket contents as a web site. See the Static - Website Examples for more information. + behaves when accessing bucket contents as a web site. See the + [Static Website + Examples](https://cloud.google.com/storage/docs/static-website) for + more information. properties: mainPageSuffix: type: string @@ -541,6 +603,9 @@ components: satisfiesPZS: type: boolean description: Reserved for future use. + satisfiesPZI: + type: boolean + description: Reserved for future use. AnywhereCache: id: AnywhereCache type: object @@ -1018,6 +1083,15 @@ components: original method name is "TakeSnapshot()", the inferred response type is "TakeSnapshotResponse". type: object + selfLink: + type: string + description: The link to this long running operation. + kind: + type: string + description: >- + The kind of item this is. For operations, this is always + storage#operation. + default: storage#operation type: object GoogleLongrunningListOperationsResponse: description: The response message for storage.buckets.operations.list. @@ -1036,6 +1110,12 @@ components: items: $ref: '#/components/schemas/GoogleLongrunningOperation' type: array + kind: + type: string + description: >- + The kind of item this is. For lists of operations, this is always + storage#operations. + default: storage#operations type: object GoogleRpcStatus: description: >- @@ -1334,7 +1414,8 @@ components: description: >- CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using - the CRC32c checksum, see Hashes and ETags: Best Practices. + the CRC32c checksum, see [Data Validation and Change + Detection](https://cloud.google.com/storage/docs/data-validation). customTime: type: string description: A timestamp in RFC 3339 format specified by the user for an object. @@ -1393,7 +1474,8 @@ components: type: string description: >- MD5 hash of the data; encoded using base64. For more information - about using the MD5 hash, see Hashes and ETags: Best Practices. + about using the MD5 hash, see [Data Validation and Change + Detection](https://cloud.google.com/storage/docs/data-validation). mediaLink: type: string description: Media download link. @@ -1998,16 +2080,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1b~1{bucket}~1anywhereCaches/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_1 - response: *ref_2 update: operation: $ref: '#/paths/~1b~1{bucket}~1anywhereCaches~1{anywhereCacheId}/patch' @@ -2049,6 +2128,7 @@ components: - $ref: '#/components/x-stackQL-resources/anywhere_caches/methods/insert' update: - $ref: '#/components/x-stackQL-resources/anywhere_caches/methods/update' + replace: [] delete: [] bucket_access_controls: id: google.storage.bucket_access_controls @@ -2103,6 +2183,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/bucket_access_controls/methods/patch + replace: - $ref: >- #/components/x-stackQL-resources/bucket_access_controls/methods/update delete: @@ -2137,22 +2218,25 @@ components: response: mediaType: application/json openAPIDocKey: '200' + restore: + operation: + $ref: '#/paths/~1b~1{bucket}~1restore/post' + response: + mediaType: application/json + openAPIDocKey: '200' insert: operation: $ref: '#/paths/~1b/post' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1b/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_3 - response: *ref_4 lock_retention_policy: operation: $ref: '#/paths/~1b~1{bucket}~1lockRetentionPolicy/post' @@ -2167,6 +2251,7 @@ components: - $ref: '#/components/x-stackQL-resources/buckets/methods/insert' update: - $ref: '#/components/x-stackQL-resources/buckets/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/buckets/methods/update' delete: - $ref: '#/components/x-stackQL-resources/buckets/methods/delete' @@ -2175,16 +2260,13 @@ components: name: buckets_iam_policies title: Buckets_iam_policies methods: - _get_iam_policy: - operation: &ref_5 + get_iam_policy: + operation: $ref: '#/paths/~1b~1{bucket}~1iam/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_5 - response: *ref_6 set_iam_policy: operation: $ref: '#/paths/~1b~1{bucket}~1iam/put' @@ -2203,6 +2285,9 @@ components: #/components/x-stackQL-resources/buckets_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/buckets_iam_policies/methods/set_iam_policy delete: [] buckets_storage_layout: id: google.storage.buckets_storage_layout @@ -2221,6 +2306,7 @@ components: #/components/x-stackQL-resources/buckets_storage_layout/methods/get_storage_layout insert: [] update: [] + replace: [] delete: [] operations: id: google.storage.operations @@ -2239,22 +2325,20 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: '#/paths/~1b~1{bucket}~1operations/get' - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] channels: id: google.storage.channels @@ -2271,6 +2355,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] default_object_access_controls: id: google.storage.default_object_access_controls @@ -2325,6 +2410,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/default_object_access_controls/methods/patch + replace: - $ref: >- #/components/x-stackQL-resources/default_object_access_controls/methods/update delete: @@ -2353,16 +2439,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_9 + list: + operation: $ref: '#/paths/~1b~1{bucket}~1folders/get' - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_9 - response: *ref_10 rename: operation: $ref: >- @@ -2377,6 +2460,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/folders/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/folders/methods/delete' managed_folders: @@ -2402,16 +2486,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: '#/paths/~1b~1{bucket}~1managedFolders/get' - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/managed_folders/methods/get' @@ -2419,6 +2500,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/managed_folders/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/managed_folders/methods/delete' managed_folders_iam_policies: @@ -2426,16 +2508,13 @@ components: name: managed_folders_iam_policies title: Managed_folders_iam_policies methods: - _get_iam_policy: - operation: &ref_13 + get_iam_policy: + operation: $ref: '#/paths/~1b~1{bucket}~1managedFolders~1{managedFolder}~1iam/get' - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_13 - response: *ref_14 set_iam_policy: operation: $ref: '#/paths/~1b~1{bucket}~1managedFolders~1{managedFolder}~1iam/put' @@ -2455,6 +2534,9 @@ components: #/components/x-stackQL-resources/managed_folders_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/managed_folders_iam_policies/methods/set_iam_policy delete: [] notifications: id: google.storage.notifications @@ -2492,6 +2574,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/notifications/methods/insert' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/notifications/methods/delete' object_access_controls: @@ -2547,6 +2630,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/object_access_controls/methods/patch + replace: - $ref: >- #/components/x-stackQL-resources/object_access_controls/methods/update delete: @@ -2601,16 +2685,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: '#/paths/~1b~1{bucket}~1o/get' - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_15 - response: *ref_16 rewrite: operation: $ref: >- @@ -2644,6 +2725,7 @@ components: - $ref: '#/components/x-stackQL-resources/objects/methods/insert' update: - $ref: '#/components/x-stackQL-resources/objects/methods/patch' + replace: - $ref: '#/components/x-stackQL-resources/objects/methods/update' delete: - $ref: '#/components/x-stackQL-resources/objects/methods/delete' @@ -2652,16 +2734,13 @@ components: name: objects_iam_policies title: Objects_iam_policies methods: - _get_iam_policy: - operation: &ref_17 + get_iam_policy: + operation: $ref: '#/paths/~1b~1{bucket}~1o~1{object}~1iam/get' - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_17 - response: *ref_18 set_iam_policy: operation: $ref: '#/paths/~1b~1{bucket}~1o~1{object}~1iam/put' @@ -2680,6 +2759,9 @@ components: #/components/x-stackQL-resources/objects_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/objects_iam_policies/methods/set_iam_policy delete: [] hmac_keys: id: google.storage.hmac_keys @@ -2692,16 +2774,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_19 + list: + operation: $ref: '#/paths/~1projects~1{projectId}~1hmacKeys/get' - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.items - list: - operation: *ref_19 - response: *ref_20 delete: operation: $ref: '#/paths/~1projects~1{projectId}~1hmacKeys~1{accessId}/delete' @@ -2726,7 +2805,8 @@ components: - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/list' insert: - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/create' - update: + update: [] + replace: - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/update' delete: - $ref: '#/components/x-stackQL-resources/hmac_keys/methods/delete' @@ -2746,10 +2826,11 @@ components: - $ref: '#/components/x-stackQL-resources/service_account/methods/get' insert: [] update: [] + replace: [] delete: [] paths: /b/{bucket}/anywhereCaches: - parameters: &ref_21 + parameters: &ref_1 - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/key' @@ -2841,7 +2922,7 @@ paths: schema: type: string /b/{bucket}/anywhereCaches/{anywhereCacheId}: - parameters: *ref_21 + parameters: *ref_1 patch: description: >- Updates the config(ttl and admissionPolicy) of an Anywhere Cache @@ -2926,7 +3007,7 @@ paths: schema: type: string /b/{bucket}/anywhereCaches/{anywhereCacheId}/pause: - parameters: *ref_21 + parameters: *ref_1 post: description: Pauses an Anywhere Cache instance. operationId: storage.anywhereCaches.pause @@ -2962,7 +3043,7 @@ paths: schema: type: string /b/{bucket}/anywhereCaches/{anywhereCacheId}/resume: - parameters: *ref_21 + parameters: *ref_1 post: description: Resumes a paused or disabled Anywhere Cache instance. operationId: storage.anywhereCaches.resume @@ -2998,7 +3079,7 @@ paths: schema: type: string /b/{bucket}/anywhereCaches/{anywhereCacheId}/disable: - parameters: *ref_21 + parameters: *ref_1 post: description: Disables an Anywhere Cache instance. operationId: storage.anywhereCaches.disable @@ -3034,7 +3115,7 @@ paths: schema: type: string /b/{bucket}/acl/{entity}: - parameters: *ref_21 + parameters: *ref_1 delete: description: >- Permanently deletes the ACL entry for the specified entity on the @@ -3180,7 +3261,7 @@ paths: schema: type: string /b/{bucket}/acl: - parameters: *ref_21 + parameters: *ref_1 post: description: Creates a new ACL entry on the specified bucket. operationId: storage.bucketAccessControls.insert @@ -3245,9 +3326,11 @@ paths: schema: type: string /b/{bucket}: - parameters: *ref_21 + parameters: *ref_1 delete: - description: Permanently deletes an empty bucket. + description: >- + Deletes an empty bucket. Deletions are permanent unless soft delete is + enabled on the bucket. operationId: storage.buckets.delete security: - Oauth2: @@ -3322,6 +3405,15 @@ paths: required: true schema: type: string + - in: query + name: generation + schema: + type: string + format: int64 + - in: query + name: softDeleted + schema: + type: boolean - in: query name: ifMetagenerationMatch schema: @@ -3456,8 +3548,45 @@ paths: name: userProject schema: type: string + /b/{bucket}/restore: + parameters: *ref_1 + post: + description: Restores a soft-deleted bucket. + operationId: storage.buckets.restore + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/devstorage.full_control + Oauth2c: + - https://www.googleapis.com/auth/devstorage.full_control + - Oauth2: + - https://www.googleapis.com/auth/devstorage.read_write + Oauth2c: + - https://www.googleapis.com/auth/devstorage.read_write + responses: + '204': + description: No Content + parameters: + - in: path + name: bucket + required: true + schema: + type: string + - in: query + name: generation + required: true + schema: + type: string + format: int64 + - in: query + name: userProject + schema: + type: string /b/{bucket}/iam: - parameters: *ref_21 + parameters: *ref_1 get: description: Returns an IAM policy for the specified bucket. operationId: storage.buckets.getIamPolicy @@ -3527,7 +3656,7 @@ paths: schema: type: string /b/{bucket}/storageLayout: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Returns the storage layout configuration for the specified bucket. Note @@ -3572,7 +3701,7 @@ paths: schema: type: string /b: - parameters: *ref_21 + parameters: *ref_1 post: description: Creates a new bucket. operationId: storage.buckets.insert @@ -3677,6 +3806,10 @@ paths: name: prefix schema: type: string + - in: query + name: softDeleted + schema: + type: boolean - in: query name: projection schema: @@ -3686,7 +3819,7 @@ paths: schema: type: string /b/{bucket}/lockRetentionPolicy: - parameters: *ref_21 + parameters: *ref_1 post: description: Locks retention policy on a bucket. operationId: storage.buckets.lockRetentionPolicy @@ -3727,7 +3860,7 @@ paths: schema: type: string /b/{bucket}/iam/testPermissions: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Tests a set of permissions on the given bucket to see which, if any, are @@ -3777,7 +3910,7 @@ paths: schema: type: string /b/{bucket}/operations/{operationId}/cancel: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3812,7 +3945,7 @@ paths: schema: type: string /b/{bucket}/operations/{operationId}: - parameters: *ref_21 + parameters: *ref_1 get: description: Gets the latest state of a long-running operation. operationId: storage.buckets.operations.get @@ -3856,7 +3989,7 @@ paths: schema: type: string /b/{bucket}/operations: - parameters: *ref_21 + parameters: *ref_1 get: description: Lists operations that match the specified filter in the request. operationId: storage.buckets.operations.list @@ -3908,7 +4041,7 @@ paths: schema: type: string /channels/stop: - parameters: *ref_21 + parameters: *ref_1 post: description: Stop watching resources through this channel operationId: storage.channels.stop @@ -3942,7 +4075,7 @@ paths: '204': description: No Content /b/{bucket}/defaultObjectAcl/{entity}: - parameters: *ref_21 + parameters: *ref_1 delete: description: >- Permanently deletes the default object ACL entry for the specified @@ -4090,7 +4223,7 @@ paths: schema: type: string /b/{bucket}/defaultObjectAcl: - parameters: *ref_21 + parameters: *ref_1 post: description: Creates a new default object ACL entry on the specified bucket. operationId: storage.defaultObjectAccessControls.insert @@ -4165,7 +4298,7 @@ paths: schema: type: string /b/{bucket}/folders/{folder}: - parameters: *ref_21 + parameters: *ref_1 delete: description: >- Permanently deletes a folder. Only applicable to buckets with @@ -4263,7 +4396,7 @@ paths: type: string format: int64 /b/{bucket}/folders: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Creates a new folder. Only applicable to buckets with hierarchical @@ -4369,7 +4502,7 @@ paths: schema: type: string /b/{bucket}/folders/{sourceFolder}/renameTo/folders/{destinationFolder}: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Renames a source folder to a destination folder. Only applicable to @@ -4422,7 +4555,7 @@ paths: type: string format: int64 /b/{bucket}/managedFolders/{managedFolder}: - parameters: *ref_21 + parameters: *ref_1 delete: description: Permanently deletes a managed folder. operationId: storage.managedFolders.delete @@ -4520,7 +4653,7 @@ paths: type: string format: int64 /b/{bucket}/managedFolders/{managedFolder}/iam: - parameters: *ref_21 + parameters: *ref_1 get: description: Returns an IAM policy for the specified managed folder. operationId: storage.managedFolders.getIamPolicy @@ -4612,7 +4745,7 @@ paths: schema: type: string /b/{bucket}/managedFolders: - parameters: *ref_21 + parameters: *ref_1 post: description: Creates a new managed folder. operationId: storage.managedFolders.insert @@ -4698,7 +4831,7 @@ paths: schema: type: string /b/{bucket}/managedFolders/{managedFolder}/iam/testPermissions: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Tests a set of permissions on the given managed folder to see which, if @@ -4753,7 +4886,7 @@ paths: schema: type: string /b/{bucket}/notificationConfigs/{notification}: - parameters: *ref_21 + parameters: *ref_1 delete: description: Permanently deletes a notification subscription. operationId: storage.notifications.delete @@ -4835,7 +4968,7 @@ paths: schema: type: string /b/{bucket}/notificationConfigs: - parameters: *ref_21 + parameters: *ref_1 post: description: Creates a notification subscription for a given bucket. operationId: storage.notifications.insert @@ -4916,7 +5049,7 @@ paths: schema: type: string /b/{bucket}/o/{object}/acl/{entity}: - parameters: *ref_21 + parameters: *ref_1 delete: description: >- Permanently deletes the ACL entry for the specified entity on the @@ -5102,7 +5235,7 @@ paths: schema: type: string /b/{bucket}/o/{object}/acl: - parameters: *ref_21 + parameters: *ref_1 post: description: Creates a new ACL entry on the specified object. operationId: storage.objectAccessControls.insert @@ -5187,7 +5320,7 @@ paths: schema: type: string /b/{destinationBucket}/o/{destinationObject}/compose: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Concatenates a list of existing objects into a new object in the same @@ -5252,7 +5385,7 @@ paths: schema: type: string /b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Copies a source object to a destination object. Optionally overrides @@ -5366,7 +5499,7 @@ paths: schema: type: string /b/{bucket}/o/{object}: - parameters: *ref_21 + parameters: *ref_1 delete: description: >- Deletes an object and its metadata. Deletions are permanent if @@ -5661,7 +5794,7 @@ paths: schema: type: string /b/{bucket}/o/{object}/iam: - parameters: *ref_21 + parameters: *ref_1 get: description: Returns an IAM policy for the specified object. operationId: storage.objects.getIamPolicy @@ -5762,7 +5895,7 @@ paths: schema: type: string /b/{bucket}/o: - parameters: *ref_21 + parameters: *ref_1 post: description: Stores a new object and metadata. operationId: storage.objects.insert @@ -5932,7 +6065,7 @@ paths: schema: type: boolean /b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}: - parameters: *ref_21 + parameters: *ref_1 post: description: >- Rewrites a source object to a destination object. Optionally overrides @@ -6055,7 +6188,7 @@ paths: schema: type: string /b/{bucket}/o/{object}/iam/testPermissions: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Tests a set of permissions on the given object to see which, if any, are @@ -6115,7 +6248,7 @@ paths: schema: type: string /b/{bucket}/o/watch: - parameters: *ref_21 + parameters: *ref_1 post: description: Watch for changes on all objects in a bucket. operationId: storage.objects.watchAll @@ -6200,7 +6333,7 @@ paths: schema: type: boolean /b/{bucket}/o/{object}/restore: - parameters: *ref_21 + parameters: *ref_1 post: description: Restores a soft-deleted object. operationId: storage.objects.restore @@ -6270,7 +6403,7 @@ paths: schema: type: string /b/{bucket}/o/bulkRestore: - parameters: *ref_21 + parameters: *ref_1 post: description: Initiates a long-running bulk restore operation on the specified bucket. operationId: storage.objects.bulkRestore @@ -6306,7 +6439,7 @@ paths: schema: type: string /projects/{projectId}/hmacKeys: - parameters: *ref_21 + parameters: *ref_1 post: description: Creates a new HMAC key for the specified service account. operationId: storage.projects.hmacKeys.create @@ -6396,7 +6529,7 @@ paths: schema: type: string /projects/{projectId}/hmacKeys/{accessId}: - parameters: *ref_21 + parameters: *ref_1 delete: description: Deletes an HMAC key. operationId: storage.projects.hmacKeys.delete @@ -6475,7 +6608,8 @@ paths: type: string put: description: >- - Updates the state of an HMAC key. See the HMAC Key resource descriptor + Updates the state of an HMAC key. See the [HMAC Key resource + descriptor](https://cloud.google.com/storage/docs/json_api/v1/projects/hmacKeys/update#request-body) for valid states. operationId: storage.projects.hmacKeys.update requestBody: @@ -6515,7 +6649,7 @@ paths: schema: type: string /projects/{projectId}/serviceAccount: - parameters: *ref_21 + parameters: *ref_1 get: description: >- Get the email address of this project's Google Cloud Storage service diff --git a/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml b/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml index a6338078..b6162606 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/storagetransfer.yaml @@ -9,8 +9,8 @@ info: Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets. version: v1 - x-discovery-doc-revision: '20240525' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240907' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/storage-transfer/docs servers: @@ -949,8 +949,9 @@ components: description: >- Specifies how each object's `timeCreated` metadata is preserved for transfers. If unspecified, the default behavior is the same as - TIME_CREATED_SKIP. This behavior is supported for transfers to GCS - buckets from GCS, S3, Azure, S3 Compatible, and Azure sources. + TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud + Storage buckets from Cloud Storage, Amazon S3, S3-compatible + storage, and Azure sources. type: string enumDescriptions: - TimeCreated behavior is unspecified. @@ -1801,16 +1802,13 @@ components: name: transfer_operations title: Transfer_operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1transferOperations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1transferOperations~1{transferOperationsId}/get' @@ -1844,6 +1842,7 @@ components: - $ref: '#/components/x-stackQL-resources/transfer_operations/methods/list' insert: [] update: [] + replace: [] delete: [] google_service_accounts: id: google.storagetransfer.google_service_accounts @@ -1862,6 +1861,7 @@ components: #/components/x-stackQL-resources/google_service_accounts/methods/get insert: [] update: [] + replace: [] delete: [] transfer_jobs: id: google.storagetransfer.transfer_jobs @@ -1874,16 +1874,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: '#/paths/~1v1~1transferJobs/get' - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.transferJobs - list: - operation: *ref_3 - response: *ref_4 patch: operation: $ref: '#/paths/~1v1~1transferJobs~1{transferJobsId}/patch' @@ -1916,6 +1913,7 @@ components: - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/create' update: - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/transfer_jobs/methods/delete' agent_pools: @@ -1929,16 +1927,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1agentPools/get' - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.agentPools - list: - operation: *ref_5 - response: *ref_6 patch: operation: $ref: >- @@ -1968,11 +1963,12 @@ components: - $ref: '#/components/x-stackQL-resources/agent_pools/methods/create' update: - $ref: '#/components/x-stackQL-resources/agent_pools/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/agent_pools/methods/delete' paths: /v1/transferOperations: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2017,7 +2013,7 @@ paths: schema: type: string /v1/transferOperations/{transferOperationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2043,7 +2039,7 @@ paths: schema: type: string /v1/transferOperations/{transferOperationsId}:cancel: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Cancels a transfer. Use the transferOperations.get method to check if @@ -2089,7 +2085,7 @@ paths: schema: type: string /v1/transferOperations/{transferOperationsId}:pause: - parameters: *ref_7 + parameters: *ref_1 post: description: Pauses a transfer operation. operationId: storagetransfer.transferOperations.pause @@ -2117,7 +2113,7 @@ paths: schema: type: string /v1/transferOperations/{transferOperationsId}:resume: - parameters: *ref_7 + parameters: *ref_1 post: description: Resumes a transfer operation that is paused. operationId: storagetransfer.transferOperations.resume @@ -2145,7 +2141,7 @@ paths: schema: type: string /v1/googleServiceAccounts/{projectId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Returns the Google service account that is used by Storage Transfer @@ -2175,7 +2171,7 @@ paths: schema: type: string /v1/transferJobs: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a transfer job that runs periodically. operationId: storagetransfer.transferJobs.create @@ -2228,7 +2224,7 @@ paths: schema: type: string /v1/transferJobs/{transferJobsId}: - parameters: *ref_7 + parameters: *ref_1 patch: description: >- Updates a transfer job. Updating a job's transfer spec does not affect @@ -2314,7 +2310,7 @@ paths: schema: type: string /v1/transferJobs/{transferJobsId}:run: - parameters: *ref_7 + parameters: *ref_1 post: description: >- Starts a new operation for the specified transfer job. A `TransferJob` @@ -2345,7 +2341,7 @@ paths: schema: type: string /v1/projects/{projectsId}/agentPools: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates an agent pool resource. operationId: storagetransfer.projects.agentPools.create @@ -2411,7 +2407,7 @@ paths: schema: type: string /v1/projects/{projectsId}/agentPools/{agentPoolsId}: - parameters: *ref_7 + parameters: *ref_1 patch: description: Updates an existing agent pool resource. operationId: storagetransfer.projects.agentPools.patch diff --git a/providers/src/googleapis.com/v00.00.00000/services/testing.yaml b/providers/src/googleapis.com/v00.00.00000/services/testing.yaml index 87637a89..1b76d311 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/testing.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/testing.yaml @@ -9,8 +9,8 @@ info: Allows developers to run automated tests for their mobile applications on Google infrastructure. version: v1 - x-discovery-doc-revision: '20240530' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://firebase.google.com/docs/test-lab/ servers: @@ -2635,6 +2635,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/test_matrices/methods/create' update: [] + replace: [] delete: [] device_sessions: id: google.testing.device_sessions @@ -2647,16 +2648,13 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1deviceSessions/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.deviceSessions - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -2686,6 +2684,7 @@ components: - $ref: '#/components/x-stackQL-resources/device_sessions/methods/create' update: - $ref: '#/components/x-stackQL-resources/device_sessions/methods/patch' + replace: [] delete: [] application_detail_service_apk_details: id: google.testing.application_detail_service_apk_details @@ -2699,9 +2698,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/application_detail_service_apk_details/methods/get_apk_details insert: [] update: [] + replace: [] delete: [] test_environment_catalog: id: google.testing.test_environment_catalog @@ -2720,10 +2722,11 @@ components: #/components/x-stackQL-resources/test_environment_catalog/methods/get insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectId}/testMatrices: - parameters: &ref_3 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2775,7 +2778,7 @@ paths: schema: type: string /v1/projects/{projectId}/testMatrices/{testMatrixId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Checks the status of a test matrix and the executions once they are @@ -2815,7 +2818,7 @@ paths: schema: type: string /v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Cancels unfinished test executions in a test matrix. This call returns @@ -2849,7 +2852,7 @@ paths: schema: type: string /v1/projects/{projectsId}/deviceSessions: - parameters: *ref_3 + parameters: *ref_1 post: description: POST /v1/projects/{project_id}/deviceSessions operationId: testing.projects.deviceSessions.create @@ -2913,7 +2916,7 @@ paths: schema: type: string /v1/projects/{projectsId}/deviceSessions/{deviceSessionsId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- GET /v1/projects/{project_id}/deviceSessions/{device_session_id} Return @@ -2985,7 +2988,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/deviceSessions/{deviceSessionsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:cancel @@ -3023,7 +3026,7 @@ paths: schema: type: string /v1/applicationDetailService/getApkDetails: - parameters: *ref_3 + parameters: *ref_1 post: description: Gets the details of an Android application APK. operationId: testing.applicationDetailService.getApkDetails @@ -3050,7 +3053,7 @@ paths: schema: type: string /v1/testEnvironmentCatalog/{environmentType}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets the catalog of supported test environments. May return any of the diff --git a/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml b/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml index 2d1ba4e4..281a49ae 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/texttospeech.yaml @@ -9,8 +9,8 @@ info: Synthesizes natural-sounding speech by applying powerful neural network models. version: v1 - x-discovery-doc-revision: '20240525' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240910' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/text-to-speech/ servers: @@ -430,8 +430,7 @@ components: input: description: >- Required. The Synthesizer requires either plain text or SSML as - input. While Long Audio is in preview, SSML is temporarily - unsupported. + input. $ref: '#/components/schemas/SynthesisInput' audioConfig: description: Required. The configuration of the synthesized audio. @@ -582,6 +581,7 @@ components: - $ref: '#/components/x-stackQL-resources/voices/methods/list' insert: [] update: [] + replace: [] delete: [] text: id: google.texttospeech.text @@ -598,6 +598,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] locations: id: google.texttospeech.locations @@ -615,23 +616,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] operations: id: google.texttospeech.operations name: operations title: Operations methods: - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -657,11 +656,12 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' paths: /v1/voices: - parameters: &ref_3 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -694,7 +694,7 @@ paths: schema: type: string /v1/text:synthesize: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Synthesizes speech synchronously: receive results after all text input @@ -719,7 +719,7 @@ paths: $ref: '#/components/schemas/SynthesizeSpeechResponse' parameters: [] /v1/projects/{projectsId}/locations/{locationsId}:synthesizeLongAudio: - parameters: *ref_3 + parameters: *ref_1 post: description: Synthesizes long form text asynchronously. operationId: texttospeech.projects.locations.synthesizeLongAudio @@ -752,7 +752,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -795,7 +795,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -831,7 +831,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_3 + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -858,7 +858,7 @@ paths: schema: type: string /v1/operations/{operationsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server diff --git a/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml b/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml index 7568cdbd..7d8d1b6f 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/tpu.yaml @@ -7,8 +7,8 @@ info: title: Cloud TPU API description: TPU API provides customers with access to Google TPU technology. version: v2 - x-discovery-doc-revision: '20240528' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240829' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/tpu/ servers: @@ -570,12 +570,14 @@ components: - TPU v2. - TPU v3. - TPU v4. + - TPU v5lite pod. - TPU v5p enum: - TYPE_UNSPECIFIED - V2 - V3 - V4 + - V5LITE_POD - V5P topology: description: Required. Topology of TPU in chips. @@ -1192,16 +1194,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1221,23 +1220,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.tpu.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1265,6 +1262,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' nodes: @@ -1272,17 +1270,14 @@ components: name: nodes title: Nodes methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1nodes/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1333,6 +1328,7 @@ components: - $ref: '#/components/x-stackQL-resources/nodes/methods/create' update: - $ref: '#/components/x-stackQL-resources/nodes/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/nodes/methods/delete' nodes_guest_attributes: @@ -1348,26 +1344,26 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/nodes_guest_attributes/methods/get_guest_attributes insert: [] update: [] + replace: [] delete: [] queued_resources: id: google.tpu.queued_resources name: queued_resources title: Queued_resources methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1queuedResources/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.queuedResources - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -1403,6 +1399,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/queued_resources/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/queued_resources/methods/delete' accelerator_types: @@ -1410,17 +1407,14 @@ components: name: accelerator_types title: Accelerator_types methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1acceleratorTypes/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.acceleratorTypes - list: - operation: *ref_9 - response: *ref_10 get: operation: $ref: >- @@ -1434,23 +1428,21 @@ components: - $ref: '#/components/x-stackQL-resources/accelerator_types/methods/list' insert: [] update: [] + replace: [] delete: [] runtime_versions: id: google.tpu.runtime_versions name: runtime_versions title: Runtime_versions methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v2~1projects~1{projectsId}~1locations~1{locationsId}~1runtimeVersions/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.runtimeVersions - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -1464,10 +1456,11 @@ components: - $ref: '#/components/x-stackQL-resources/runtime_versions/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v2/projects/{projectsId}/locations: - parameters: &ref_13 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1514,7 +1507,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets information about a location. operationId: tpu.projects.locations.get @@ -1542,7 +1535,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}:generateServiceIdentity: - parameters: *ref_13 + parameters: *ref_1 post: description: Generates the Cloud TPU service identity for the project. operationId: tpu.projects.locations.generateServiceIdentity @@ -1575,7 +1568,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1618,7 +1611,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1689,7 +1682,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_13 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -1731,7 +1724,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/nodes: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists nodes. operationId: tpu.projects.locations.nodes.list @@ -1803,7 +1796,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets the details of a node. operationId: tpu.projects.locations.nodes.get @@ -1908,7 +1901,7 @@ paths: type: string format: google-fieldmask /v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop: - parameters: *ref_13 + parameters: *ref_1 post: description: Stops a node. This operation is only available with single TPU nodes. operationId: tpu.projects.locations.nodes.stop @@ -1946,7 +1939,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start: - parameters: *ref_13 + parameters: *ref_1 post: description: Starts a node. operationId: tpu.projects.locations.nodes.start @@ -1984,7 +1977,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:getGuestAttributes: - parameters: *ref_13 + parameters: *ref_1 post: description: Retrieves the guest attributes for the node. operationId: tpu.projects.locations.nodes.getGuestAttributes @@ -2022,7 +2015,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queuedResources: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists queued resources. operationId: tpu.projects.locations.queuedResources.list @@ -2098,7 +2091,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets details of a queued resource. operationId: tpu.projects.locations.queuedResources.get @@ -2170,7 +2163,7 @@ paths: schema: type: boolean /v2/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:reset: - parameters: *ref_13 + parameters: *ref_1 post: description: Resets a QueuedResource TPU instance operationId: tpu.projects.locations.queuedResources.reset @@ -2208,7 +2201,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists accelerator types supported by this API. operationId: tpu.projects.locations.acceleratorTypes.list @@ -2253,7 +2246,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/acceleratorTypes/{acceleratorTypesId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets AcceleratorType. operationId: tpu.projects.locations.acceleratorTypes.get @@ -2286,7 +2279,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions: - parameters: *ref_13 + parameters: *ref_1 get: description: Lists runtime versions supported by this API. operationId: tpu.projects.locations.runtimeVersions.list @@ -2331,7 +2324,7 @@ paths: schema: type: string /v2/projects/{projectsId}/locations/{locationsId}/runtimeVersions/{runtimeVersionsId}: - parameters: *ref_13 + parameters: *ref_1 get: description: Gets a runtime version. operationId: tpu.projects.locations.runtimeVersions.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml b/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml index 2ead9f16..976e8e80 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/trafficdirector.yaml @@ -7,8 +7,8 @@ info: title: Traffic Director API description: '' version: v3 - x-discovery-doc-revision: '20240513' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240828' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/traffic-director servers: @@ -1456,6 +1456,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v3/discovery:client_status: diff --git a/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml b/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml index 6fa39801..f0e04474 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/transcoder.yaml @@ -9,8 +9,8 @@ info: This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview. version: v1 - x-discovery-doc-revision: '20240515' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240819' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/transcoder/docs/ servers: @@ -1319,8 +1319,8 @@ components: uri: description: >- URI for the output file(s). For example, `gs://my-bucket/outputs/`. - If empty, the value is populated from Job.output_uri. See [Supported - input and output + Must be a directory and not a top-level bucket. If empty, the value + is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). type: string AdBreak: @@ -1848,17 +1848,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobs/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobs - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -1880,6 +1877,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/jobs/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/jobs/methods/delete' job_templates: @@ -1894,17 +1892,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1jobTemplates/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.jobTemplates - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1926,11 +1921,12 @@ components: insert: - $ref: '#/components/x-stackQL-resources/job_templates/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/job_templates/methods/delete' paths: /v1/projects/{projectsId}/locations/{locationsId}/jobs: - parameters: &ref_5 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2017,7 +2013,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Returns the job data. operationId: transcoder.projects.locations.jobs.get @@ -2085,7 +2081,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/jobTemplates: - parameters: *ref_5 + parameters: *ref_1 post: description: Creates a job template in the specified region. operationId: transcoder.projects.locations.jobTemplates.create @@ -2165,7 +2161,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}: - parameters: *ref_5 + parameters: *ref_1 get: description: Returns the job template data. operationId: transcoder.projects.locations.jobTemplates.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/translate.yaml b/providers/src/googleapis.com/v00.00.00000/services/translate.yaml index 37f0064a..267e5fe9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/translate.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/translate.yaml @@ -7,8 +7,8 @@ info: title: Cloud Translation API description: Integrates text translation into your website or application. version: v3 - x-discovery-doc-revision: '20240301' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240903' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/translate/docs/quickstarts servers: @@ -247,6 +247,8 @@ components: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, + - Translation LLM models: + `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. @@ -1136,8 +1138,8 @@ components: properties: name: description: >- - Required. The resource name of the entry. Format: - "projects/*/locations/*/glossaries/*/glossaryEntries/*" + Identifier. The resource name of the entry. Format: + `projects/*/locations/*/glossaries/*/glossaryEntries/*` type: string termsPair: description: Used for an unidirectional glossary. @@ -1336,12 +1338,78 @@ components: `projects/{project}/locations/{location-id}/adaptiveMtDatasets/{dataset}` type: string content: - description: >- - Required. The content of the input in string format. For now only - one sentence per request is supported. + description: Required. The content of the input in string format. type: array items: type: string + referenceSentenceConfig: + description: Configuration for caller provided reference sentences. + $ref: '#/components/schemas/ReferenceSentenceConfig' + glossaryConfig: + description: >- + Optional. Glossary to be applied. The glossary must be within the + same region (have the same location-id) as the model, otherwise an + INVALID_ARGUMENT (400) error is returned. + $ref: '#/components/schemas/GlossaryConfig' + ReferenceSentenceConfig: + id: ReferenceSentenceConfig + description: Message of caller-provided reference configuration. + type: object + properties: + referenceSentencePairLists: + description: >- + Reference sentences pair lists. Each list will be used as the + references to translate the sentence under "content" field at the + corresponding index. Length of the list is required to be equal to + the length of "content" field. + type: array + items: + $ref: '#/components/schemas/ReferenceSentencePairList' + sourceLanguageCode: + description: Source language code. + type: string + targetLanguageCode: + description: Target language code. + type: string + ReferenceSentencePairList: + id: ReferenceSentencePairList + description: A list of reference sentence pairs. + type: object + properties: + referenceSentencePairs: + description: Reference sentence pairs. + type: array + items: + $ref: '#/components/schemas/ReferenceSentencePair' + ReferenceSentencePair: + id: ReferenceSentencePair + description: A pair of sentences used as reference in source and target languages. + type: object + properties: + sourceSentence: + description: Source sentence in the sentence pair. + type: string + targetSentence: + description: Target sentence in the sentence pair. + type: string + GlossaryConfig: + id: GlossaryConfig + description: >- + Configures which glossary is used for a specific target language and + defines options for applying that glossary. + type: object + properties: + glossary: + description: >- + Required. The `glossary` to be applied for this translation. The + format depends on the glossary: - User-provided custom glossary: + `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}` + type: string + ignoreCase: + description: >- + Optional. Indicates match is case insensitive. The default value is + `false` if missing. + type: boolean AdaptiveMtTranslateResponse: id: AdaptiveMtTranslateResponse description: An AdaptiveMtTranslate response. @@ -1357,6 +1425,13 @@ components: description: Output only. The translation's language code. readOnly: true type: string + glossaryTranslations: + description: >- + Text translation response if a glossary is provided in the request. + This could be the same as 'translation' above if no terms apply. + type: array + items: + $ref: '#/components/schemas/AdaptiveMtTranslation' AdaptiveMtTranslation: id: AdaptiveMtTranslation description: An AdaptiveMt translation. @@ -1577,7 +1652,7 @@ components: name: description: >- Output only. The resource name of the example, in form of - `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}' + `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}` readOnly: true type: string sourceText: @@ -1778,6 +1853,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] supported_languages: id: google.translate.supported_languages @@ -1805,22 +1881,20 @@ components: #/components/x-stackQL-resources/supported_languages/methods/projects_get_supported_languages insert: [] update: [] + replace: [] delete: [] locations: id: google.translate.locations name: locations title: Locations methods: - _projects_locations_list: - operation: &ref_1 + projects_locations_list: + operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - projects_locations_list: - operation: *ref_1 - response: *ref_2 projects_locations_get: operation: $ref: '#/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1884,23 +1958,21 @@ components: #/components/x-stackQL-resources/locations/methods/projects_locations_list insert: [] update: [] + replace: [] delete: [] operations: id: google.translate.operations name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_3 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_3 - response: *ref_4 projects_locations_operations_get: operation: $ref: >- @@ -1937,6 +2009,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete @@ -1952,17 +2025,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_glossaries_list: - operation: &ref_5 + projects_locations_glossaries_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.glossaries - projects_locations_glossaries_list: - operation: *ref_5 - response: *ref_6 projects_locations_glossaries_patch: operation: $ref: >- @@ -1996,6 +2066,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/glossaries/methods/projects_locations_glossaries_delete @@ -2025,17 +2096,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_glossaries_glossary_entries_list: - operation: &ref_7 + projects_locations_glossaries_glossary_entries_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1glossaries~1{glossariesId}~1glossaryEntries/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.glossaryEntries - projects_locations_glossaries_glossary_entries_list: - operation: *ref_7 - response: *ref_8 projects_locations_glossaries_glossary_entries_create: operation: $ref: >- @@ -2055,6 +2123,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/glossary_entries/methods/projects_locations_glossaries_glossary_entries_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/glossary_entries/methods/projects_locations_glossaries_glossary_entries_delete @@ -2070,17 +2139,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_datasets_list: - operation: &ref_9 + projects_locations_datasets_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1datasets/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.datasets - projects_locations_datasets_list: - operation: *ref_9 - response: *ref_10 projects_locations_datasets_get: operation: $ref: >- @@ -2119,6 +2185,7 @@ components: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_locations_datasets_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/datasets/methods/projects_locations_datasets_delete @@ -2127,23 +2194,21 @@ components: name: examples title: Examples methods: - _projects_locations_datasets_examples_list: - operation: &ref_11 + projects_locations_datasets_examples_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1datasets~1{datasetsId}~1examples/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.examples - projects_locations_datasets_examples_list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/examples/methods/projects_locations_datasets_examples_list insert: [] update: [] + replace: [] delete: [] adaptive_mt_datasets: id: google.translate.adaptive_mt_datasets @@ -2157,17 +2222,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_adaptive_mt_datasets_list: - operation: &ref_13 + projects_locations_adaptive_mt_datasets_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1adaptiveMtDatasets/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.adaptiveMtDatasets - projects_locations_adaptive_mt_datasets_list: - operation: *ref_13 - response: *ref_14 projects_locations_adaptive_mt_datasets_delete: operation: $ref: >- @@ -2199,6 +2261,7 @@ components: - $ref: >- #/components/x-stackQL-resources/adaptive_mt_datasets/methods/projects_locations_adaptive_mt_datasets_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/adaptive_mt_datasets/methods/projects_locations_adaptive_mt_datasets_delete @@ -2221,17 +2284,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_adaptive_mt_datasets_adaptive_mt_files_list: - operation: &ref_15 + projects_locations_adaptive_mt_datasets_adaptive_mt_files_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1adaptiveMtDatasets~1{adaptiveMtDatasetsId}~1adaptiveMtFiles/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.adaptiveMtFiles - projects_locations_adaptive_mt_datasets_adaptive_mt_files_list: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: >- @@ -2240,6 +2300,7 @@ components: #/components/x-stackQL-resources/adaptive_mt_files/methods/projects_locations_adaptive_mt_datasets_adaptive_mt_files_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/adaptive_mt_files/methods/projects_locations_adaptive_mt_datasets_adaptive_mt_files_delete @@ -2248,28 +2309,22 @@ components: name: adaptive_mt_sentences title: Adaptive_mt_sentences methods: - _projects_locations_adaptive_mt_datasets_adaptive_mt_files_adaptive_mt_sentences_list: - operation: &ref_17 + projects_locations_adaptive_mt_datasets_adaptive_mt_files_adaptive_mt_sentences_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1adaptiveMtDatasets~1{adaptiveMtDatasetsId}~1adaptiveMtFiles~1{adaptiveMtFilesId}~1adaptiveMtSentences/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.adaptiveMtSentences - projects_locations_adaptive_mt_datasets_adaptive_mt_files_adaptive_mt_sentences_list: - operation: *ref_17 - response: *ref_18 - _projects_locations_adaptive_mt_datasets_adaptive_mt_sentences_list: - operation: &ref_19 + projects_locations_adaptive_mt_datasets_adaptive_mt_sentences_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1adaptiveMtDatasets~1{adaptiveMtDatasetsId}~1adaptiveMtSentences/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.adaptiveMtSentences - projects_locations_adaptive_mt_datasets_adaptive_mt_sentences_list: - operation: *ref_19 - response: *ref_20 sqlVerbs: select: - $ref: >- @@ -2278,6 +2333,7 @@ components: #/components/x-stackQL-resources/adaptive_mt_sentences/methods/projects_locations_adaptive_mt_datasets_adaptive_mt_sentences_list insert: [] update: [] + replace: [] delete: [] models: id: google.translate.models @@ -2291,17 +2347,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_models_list: - operation: &ref_21 + projects_locations_models_list: + operation: $ref: >- #/paths/~1v3~1projects~1{projectsId}~1locations~1{locationsId}~1models/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.models - projects_locations_models_list: - operation: *ref_21 - response: *ref_22 projects_locations_models_get: operation: $ref: >- @@ -2326,12 +2379,13 @@ components: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_models_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/models/methods/projects_locations_models_delete paths: /v3/projects/{projectsId}:translateText: - parameters: &ref_23 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2374,7 +2428,7 @@ paths: schema: type: string /v3/projects/{projectsId}:romanizeText: - parameters: *ref_23 + parameters: *ref_1 post: description: Romanize input text written in non-Latin scripts to Latin text. operationId: translate.projects.romanizeText @@ -2406,7 +2460,7 @@ paths: schema: type: string /v3/projects/{projectsId}:detectLanguage: - parameters: *ref_23 + parameters: *ref_1 post: description: Detects the language of text within a request. operationId: translate.projects.detectLanguage @@ -2438,7 +2492,7 @@ paths: schema: type: string /v3/projects/{projectsId}/supportedLanguages: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns a list of supported languages for translation. operationId: translate.projects.getSupportedLanguages @@ -2473,7 +2527,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: translate.projects.locations.list @@ -2513,7 +2567,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets information about a location. operationId: translate.projects.locations.get @@ -2545,7 +2599,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}:translateText: - parameters: *ref_23 + parameters: *ref_1 post: description: Translates input text and returns translated text. operationId: translate.projects.locations.translateText @@ -2582,7 +2636,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}:romanizeText: - parameters: *ref_23 + parameters: *ref_1 post: description: Romanize input text written in non-Latin scripts to Latin text. operationId: translate.projects.locations.romanizeText @@ -2619,7 +2673,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}:detectLanguage: - parameters: *ref_23 + parameters: *ref_1 post: description: Detects the language of text within a request. operationId: translate.projects.locations.detectLanguage @@ -2656,7 +2710,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/supportedLanguages: - parameters: *ref_23 + parameters: *ref_1 get: description: Returns a list of supported languages for translation. operationId: translate.projects.locations.getSupportedLanguages @@ -2696,7 +2750,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}:translateDocument: - parameters: *ref_23 + parameters: *ref_1 post: description: Translates documents in synchronous mode. operationId: translate.projects.locations.translateDocument @@ -2733,7 +2787,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}:batchTranslateText: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Translates a large volume of text in asynchronous batch mode. This @@ -2772,7 +2826,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}:batchTranslateDocument: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Translates a large volume of document in asynchronous batch mode. This @@ -2811,7 +2865,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}:adaptiveMtTranslate: - parameters: *ref_23 + parameters: *ref_1 post: description: Translate text using Adaptive MT. operationId: translate.projects.locations.adaptiveMtTranslate @@ -2848,7 +2902,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2895,7 +2949,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2974,7 +3028,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -3025,7 +3079,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Waits until the specified long-running operation is done or reaches at @@ -3076,7 +3130,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/glossaries: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Creates a glossary and returns the long-running operation. Returns @@ -3156,7 +3210,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}: - parameters: *ref_23 + parameters: *ref_1 patch: description: >- Updates a glossary. A LRO is used since the update can be async if the @@ -3172,6 +3226,10 @@ paths: - https://www.googleapis.com/auth/cloud-platform Oauth2c: - https://www.googleapis.com/auth/cloud-platform + - Oauth2: + - https://www.googleapis.com/auth/cloud-translation + Oauth2c: + - https://www.googleapis.com/auth/cloud-translation responses: '200': description: Successful response @@ -3273,7 +3331,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/glossaryEntries/{glossaryEntriesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a single glossary entry by the given id. operationId: translate.projects.locations.glossaries.glossaryEntries.get @@ -3400,7 +3458,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}/glossaryEntries: - parameters: *ref_23 + parameters: *ref_1 get: description: List the entries for the glossary. operationId: translate.projects.locations.glossaries.glossaryEntries.list @@ -3486,7 +3544,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/datasets: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates a Dataset. operationId: translate.projects.locations.datasets.create @@ -3562,7 +3620,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a Dataset. operationId: translate.projects.locations.datasets.get @@ -3634,7 +3692,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:importData: - parameters: *ref_23 + parameters: *ref_1 post: description: Import sentence pairs into translation Dataset. operationId: translate.projects.locations.datasets.importData @@ -3676,7 +3734,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:exportData: - parameters: *ref_23 + parameters: *ref_1 post: description: Exports dataset's data to the provided output location. operationId: translate.projects.locations.datasets.exportData @@ -3718,7 +3776,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/examples: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists sentence pairs in the dataset. operationId: translate.projects.locations.datasets.examples.list @@ -3768,7 +3826,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/adaptiveMtDatasets: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates an Adaptive MT dataset. operationId: translate.projects.locations.adaptiveMtDatasets.create @@ -3848,7 +3906,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/adaptiveMtDatasets/{adaptiveMtDatasetsId}: - parameters: *ref_23 + parameters: *ref_1 delete: description: >- Deletes an Adaptive MT dataset, including all its entries and associated @@ -3922,7 +3980,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/adaptiveMtDatasets/{adaptiveMtDatasetsId}:importAdaptiveMtFile: - parameters: *ref_23 + parameters: *ref_1 post: description: >- Imports an AdaptiveMtFile and adds all of its sentences into the @@ -3966,7 +4024,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/adaptiveMtDatasets/{adaptiveMtDatasetsId}/adaptiveMtFiles/{adaptiveMtFilesId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets and AdaptiveMtFile operationId: translate.projects.locations.adaptiveMtDatasets.adaptiveMtFiles.get @@ -4048,7 +4106,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/adaptiveMtDatasets/{adaptiveMtDatasetsId}/adaptiveMtFiles: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists all AdaptiveMtFiles associated to an AdaptiveMtDataset. operationId: translate.projects.locations.adaptiveMtDatasets.adaptiveMtFiles.list @@ -4094,7 +4152,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/adaptiveMtDatasets/{adaptiveMtDatasetsId}/adaptiveMtFiles/{adaptiveMtFilesId}/adaptiveMtSentences: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists all AdaptiveMtSentences under a given file/dataset. operationId: >- @@ -4146,7 +4204,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/adaptiveMtDatasets/{adaptiveMtDatasetsId}/adaptiveMtSentences: - parameters: *ref_23 + parameters: *ref_1 get: description: Lists all AdaptiveMtSentences under a given file/dataset. operationId: translate.projects.locations.adaptiveMtDatasets.adaptiveMtSentences.list @@ -4192,7 +4250,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/models: - parameters: *ref_23 + parameters: *ref_1 post: description: Creates a Model. operationId: translate.projects.locations.models.create @@ -4272,7 +4330,7 @@ paths: schema: type: string /v3/projects/{projectsId}/locations/{locationsId}/models/{modelsId}: - parameters: *ref_23 + parameters: *ref_1 get: description: Gets a model. operationId: translate.projects.locations.models.get diff --git a/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml b/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml index 943c6252..21be03e8 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/videointelligence.yaml @@ -10,8 +10,8 @@ info: specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API. version: v1 - x-discovery-doc-revision: '20240327' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240719' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/video-intelligence/docs/ servers: @@ -4858,17 +4858,14 @@ components: name: operations title: Operations methods: - _projects_locations_operations_list: - operation: &ref_1 + projects_locations_operations_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - projects_locations_operations_list: - operation: *ref_1 - response: *ref_2 projects_locations_operations_get: operation: $ref: >- @@ -4898,6 +4895,7 @@ components: #/components/x-stackQL-resources/operations/methods/projects_locations_operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/projects_locations_operations_delete @@ -4933,6 +4931,7 @@ components: #/components/x-stackQL-resources/long_running_operations/methods/operations_projects_locations_operations_get insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/long_running_operations/methods/operations_projects_locations_operations_delete @@ -4951,10 +4950,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: &ref_3 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -5008,7 +5008,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5079,7 +5079,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5126,7 +5126,7 @@ paths: schema: type: string /v1/operations/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -5197,7 +5197,7 @@ paths: schema: type: string /v1/operations/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -5239,7 +5239,7 @@ paths: schema: type: string /v1/videos:annotate: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Performs asynchronous video annotation. Progress and results can be diff --git a/providers/src/googleapis.com/v00.00.00000/services/vision.yaml b/providers/src/googleapis.com/v00.00.00000/services/vision.yaml index 43e7173f..4d6686df 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vision.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vision.yaml @@ -10,8 +10,8 @@ info: landmark detection, optical character recognition (OCR), and detection of explicit content, into applications. version: v1 - x-discovery-doc-revision: '20240524' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240906' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/vision/ servers: @@ -1064,7 +1064,11 @@ components: - VERY_LIKELY Landmark: id: Landmark - description: A face-specific landmark (for example, a face feature). + description: >- + A face-specific landmark (for example, a face feature). Landmark + positions may fall outside the bounds of the image if the face is near + one or more edges of the image. Therefore it is NOT guaranteed that `0 + <= x < width` or `0 <= y < height`. type: object properties: type: @@ -2722,7 +2726,11 @@ components: format: float GoogleCloudVisionV1p1beta1FaceAnnotationLandmark: id: GoogleCloudVisionV1p1beta1FaceAnnotationLandmark - description: A face-specific landmark (for example, a face feature). + description: >- + A face-specific landmark (for example, a face feature). Landmark + positions may fall outside the bounds of the image if the face is near + one or more edges of the image. Therefore it is NOT guaranteed that `0 + <= x < width` or `0 <= y < height`. type: object properties: type: @@ -4092,7 +4100,11 @@ components: format: float GoogleCloudVisionV1p2beta1FaceAnnotationLandmark: id: GoogleCloudVisionV1p2beta1FaceAnnotationLandmark - description: A face-specific landmark (for example, a face feature). + description: >- + A face-specific landmark (for example, a face feature). Landmark + positions may fall outside the bounds of the image if the face is near + one or more edges of the image. Therefore it is NOT guaranteed that `0 + <= x < width` or `0 <= y < height`. type: object properties: type: @@ -5554,7 +5566,11 @@ components: - VERY_LIKELY GoogleCloudVisionV1p3beta1FaceAnnotationLandmark: id: GoogleCloudVisionV1p3beta1FaceAnnotationLandmark - description: A face-specific landmark (for example, a face feature). + description: >- + A face-specific landmark (for example, a face feature). Landmark + positions may fall outside the bounds of the image if the face is near + one or more edges of the image. Therefore it is NOT guaranteed that `0 + <= x < width` or `0 <= y < height`. type: object properties: type: @@ -7026,7 +7042,11 @@ components: #/components/schemas/GoogleCloudVisionV1p4beta1FaceRecognitionResult GoogleCloudVisionV1p4beta1FaceAnnotationLandmark: id: GoogleCloudVisionV1p4beta1FaceAnnotationLandmark - description: A face-specific landmark (for example, a face feature). + description: >- + A face-specific landmark (for example, a face feature). Landmark + positions may fall outside the bounds of the image if the face is near + one or more edges of the image. Therefore it is NOT guaranteed that `0 + <= x < width` or `0 <= y < height`. type: object properties: type: @@ -8178,16 +8198,13 @@ components: name: operations title: Operations methods: - _operations_list: - operation: &ref_1 + operations_list: + operation: $ref: '#/paths/~1v1~1operations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - operations_list: - operation: *ref_1 - response: *ref_2 operations_get: operation: $ref: '#/paths/~1v1~1operations~1{operationsId}/get' @@ -8240,6 +8257,7 @@ components: #/components/x-stackQL-resources/operations/methods/operations_list insert: [] update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/operations/methods/operations_delete @@ -8255,17 +8273,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_product_sets_list: - operation: &ref_3 + projects_locations_product_sets_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1productSets/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.productSets - projects_locations_product_sets_list: - operation: *ref_3 - response: *ref_4 projects_locations_product_sets_get: operation: $ref: >- @@ -8306,6 +8321,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/product_sets/methods/projects_locations_product_sets_delete @@ -8330,25 +8346,27 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/product_sets_product/methods/projects_locations_product_sets_add_product update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/product_sets_product/methods/projects_locations_product_sets_remove_product products: id: google.vision.products name: products title: Products methods: - _projects_locations_product_sets_products_list: - operation: &ref_5 + projects_locations_product_sets_products_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1productSets~1{productSetsId}~1products/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.products - projects_locations_product_sets_products_list: - operation: *ref_5 - response: *ref_6 projects_locations_products_create: operation: $ref: >- @@ -8356,17 +8374,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_list: - operation: &ref_7 + projects_locations_products_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.products - projects_locations_products_list: - operation: *ref_7 - response: *ref_8 projects_locations_products_get: operation: $ref: >- @@ -8409,6 +8424,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_products_patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/products/methods/projects_locations_products_delete @@ -8424,17 +8440,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _projects_locations_products_reference_images_list: - operation: &ref_9 + projects_locations_products_reference_images_list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1products~1{productsId}~1referenceImages/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.referenceImages - projects_locations_products_reference_images_list: - operation: *ref_9 - response: *ref_10 projects_locations_products_reference_images_delete: operation: $ref: >- @@ -8459,6 +8472,7 @@ components: - $ref: >- #/components/x-stackQL-resources/reference_images/methods/projects_locations_products_reference_images_create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/reference_images/methods/projects_locations_products_reference_images_delete @@ -8510,6 +8524,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] files: id: google.vision.files @@ -8559,10 +8574,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/operations: - parameters: &ref_11 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -8610,7 +8626,7 @@ paths: schema: type: string /v1/operations/{operationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8669,7 +8685,7 @@ paths: schema: type: string /v1/operations/{operationsId}:cancel: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -8710,7 +8726,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8745,7 +8761,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -8785,7 +8801,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/productSets: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Creates and returns a new ProductSet resource. Possible errors: * @@ -8870,7 +8886,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets information associated with a ProductSet. Possible errors: * @@ -8996,7 +9012,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}:addProduct: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Adds a Product to the specified ProductSet. If the Product is already @@ -9042,7 +9058,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}:removeProduct: - parameters: *ref_11 + parameters: *ref_1 post: description: Removes a Product from the specified ProductSet. operationId: vision.projects.locations.productSets.removeProduct @@ -9084,7 +9100,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/productSets:import: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Asynchronous API that imports a list of reference images to specified @@ -9129,7 +9145,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}/products: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Lists the Products in a ProductSet, in an unspecified order. If the @@ -9179,7 +9195,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/products: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Creates and returns a new product resource. Possible errors: * Returns @@ -9266,7 +9282,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets information associated with a Product. Possible errors: * Returns @@ -9398,7 +9414,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/products:purge: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Asynchronous API to delete all Products in a ProductSet or all Products @@ -9453,7 +9469,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Creates and returns a new ReferenceImage resource. The `bounding_poly` @@ -9559,7 +9575,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages/{referenceImagesId}: - parameters: *ref_11 + parameters: *ref_1 delete: description: >- Permanently deletes a reference image. The image metadata will be @@ -9647,7 +9663,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/images:annotate: - parameters: *ref_11 + parameters: *ref_1 post: description: Run image detection and annotation for a batch of images. operationId: vision.projects.locations.images.annotate @@ -9684,7 +9700,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Run asynchronous image detection and annotation for a list of images. @@ -9728,7 +9744,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/files:annotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Service that performs image detection and annotation for a batch of @@ -9771,7 +9787,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Run asynchronous image detection and annotation for a list of generic @@ -9814,7 +9830,7 @@ paths: schema: type: string /v1/projects/{projectsId}/images:annotate: - parameters: *ref_11 + parameters: *ref_1 post: description: Run image detection and annotation for a batch of images. operationId: vision.projects.images.annotate @@ -9846,7 +9862,7 @@ paths: schema: type: string /v1/projects/{projectsId}/images:asyncBatchAnnotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Run asynchronous image detection and annotation for a list of images. @@ -9885,7 +9901,7 @@ paths: schema: type: string /v1/projects/{projectsId}/files:annotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Service that performs image detection and annotation for a batch of @@ -9923,7 +9939,7 @@ paths: schema: type: string /v1/projects/{projectsId}/files:asyncBatchAnnotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Run asynchronous image detection and annotation for a list of generic @@ -9961,7 +9977,7 @@ paths: schema: type: string /v1/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_11 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -9996,7 +10012,7 @@ paths: schema: type: string /v1/images:annotate: - parameters: *ref_11 + parameters: *ref_1 post: description: Run image detection and annotation for a batch of images. operationId: vision.images.annotate @@ -10023,7 +10039,7 @@ paths: $ref: '#/components/schemas/BatchAnnotateImagesResponse' parameters: [] /v1/images:asyncBatchAnnotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Run asynchronous image detection and annotation for a list of images. @@ -10057,7 +10073,7 @@ paths: $ref: '#/components/schemas/Operation' parameters: [] /v1/files:annotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Service that performs image detection and annotation for a batch of @@ -10090,7 +10106,7 @@ paths: $ref: '#/components/schemas/BatchAnnotateFilesResponse' parameters: [] /v1/files:asyncBatchAnnotate: - parameters: *ref_11 + parameters: *ref_1 post: description: >- Run asynchronous image detection and annotation for a list of generic diff --git a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml index 955d41ce..09da924d 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmmigration.yaml @@ -9,8 +9,8 @@ info: Use the Migrate to Virtual Machines API to programmatically migrate workloads. version: v1 - x-discovery-doc-revision: '20240523' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/migrate/virtual-machines servers: @@ -323,10 +323,10 @@ components: type: object properties: key: - description: Key of tag. + description: Required. Key of tag. type: string value: - description: Value of tag. + description: Required. Value of tag. type: string AzureSourceDetails: id: AzureSourceDetails @@ -1143,8 +1143,9 @@ components: - SUCCEEDED error: description: >- - Provides details on the state of the upgrade operation in case of an - error. + Output only. Provides details on the state of the upgrade operation + in case of an error. + readOnly: true $ref: '#/components/schemas/Status' startTime: description: The time the operation was started. @@ -1389,11 +1390,13 @@ components: - >- An alternative to SSD persistent disks that balance performance and cost. + - Hyperdisk balanced disk type. enum: - COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED - COMPUTE_ENGINE_DISK_TYPE_STANDARD - COMPUTE_ENGINE_DISK_TYPE_SSD - COMPUTE_ENGINE_DISK_TYPE_BALANCED + - COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED labels: description: A map of labels to associate with the VM. type: object @@ -1424,6 +1427,17 @@ components: Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. type: boolean + enableVtpm: + description: >- + Optional. Defines whether the instance has vTPM enabled. This can be + set to true only if the VM boot option is EFI. + type: boolean + enableIntegrityMonitoring: + description: >- + Optional. Defines whether the instance has integrity monitoring + enabled. This can be set to true only if the VM boot option is EFI, + and vTPM is enabled. + type: boolean bootOption: description: Output only. The VM Boot Option, as set in the source VM. readOnly: true @@ -1452,6 +1466,21 @@ components: encryption: description: Optional. Immutable. The encryption to apply to the VM disks. $ref: '#/components/schemas/Encryption' + bootConversion: + description: >- + Optional. By default the virtual machine will keep its existing boot + option. Setting this property will trigger an internal process which + will convert the virtual machine from using the existing boot option + to another. + type: string + enumDescriptions: + - Unspecified conversion type. + - No conversion. + - Convert from BIOS to EFI. + enum: + - BOOT_CONVERSION_UNSPECIFIED + - NONE + - BIOS_TO_EFI NetworkInterface: id: NetworkInterface description: NetworkInterface represents a NIC of a VM. @@ -1461,16 +1490,32 @@ components: description: The network to connect the NIC to. type: string subnetwork: - description: The subnetwork to connect the NIC to. + description: Optional. The subnetwork to connect the NIC to. type: string internalIp: description: >- - The internal IP to define in the NIC. The formats accepted are: - `ephemeral` \ ipv4 address \ a named address resource full path. + Optional. The internal IP to define in the NIC. The formats accepted + are: `ephemeral` \ ipv4 address \ a named address resource full + path. type: string externalIp: - description: The external IP to define in the NIC. + description: Optional. The external IP to define in the NIC. + type: string + networkTier: + description: >- + Optional. The networking tier used for optimizing connectivity + between instances and systems on the internet. Applies only for + external ephemeral IP addresses. If left empty, will default to + PREMIUM. type: string + enumDescriptions: + - An unspecified network tier. Will be used as PREMIUM. + - A standard network tier. + - A premium network tier. + enum: + - COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED + - NETWORK_TIER_STANDARD + - NETWORK_TIER_PREMIUM AppliedLicense: id: AppliedLicense description: >- @@ -1498,7 +1543,9 @@ components: id: ComputeScheduling description: >- Scheduling information for VM on maintenance/restart behaviour and node - allocation in sole tenant nodes. + allocation in sole tenant nodes. Options for instance behavior when the + host machine undergoes maintenance that may temporarily impact instance + performance. type: object properties: onHostMaintenance: @@ -1652,6 +1699,14 @@ components: Optional. Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. type: boolean + enableVtpm: + description: Optional. Defines whether the instance has vTPM enabled. + type: boolean + enableIntegrityMonitoring: + description: >- + Optional. Defines whether the instance has integrity monitoring + enabled. + type: boolean metadata: description: Optional. The metadata key/value pairs to assign to the VM. type: object @@ -1697,11 +1752,13 @@ components: - >- An alternative to SSD persistent disks that balance performance and cost. + - Hyperdisk balanced disk type. enum: - COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED - COMPUTE_ENGINE_DISK_TYPE_STANDARD - COMPUTE_ENGINE_DISK_TYPE_SSD - COMPUTE_ENGINE_DISK_TYPE_BALANCED + - COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED deviceName: description: >- Optional. Specifies a unique device name of your choice that is @@ -1744,11 +1801,13 @@ components: - >- An alternative to SSD persistent disks that balance performance and cost. + - Hyperdisk balanced disk type. enum: - COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED - COMPUTE_ENGINE_DISK_TYPE_STANDARD - COMPUTE_ENGINE_DISK_TYPE_SSD - COMPUTE_ENGINE_DISK_TYPE_BALANCED + - COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED additionalLabels: description: A map of labels to associate with the Persistent Disk. type: object @@ -1760,7 +1819,7 @@ components: vmAttachmentDetails: description: >- Optional. Details for attachment of the disk to a VM. Used when the - disk is set to be attacked to a target VM. + disk is set to be attached to a target VM. $ref: '#/components/schemas/VmAttachmentDetails' VmAttachmentDetails: id: VmAttachmentDetails @@ -1782,7 +1841,8 @@ components: type: object properties: firmware: - description: The firmware type of the source VM. + description: Output only. The firmware type of the source VM. + readOnly: true type: string enumDescriptions: - The firmware is unknown. @@ -1793,11 +1853,13 @@ components: - EFI - BIOS committedStorageBytes: - description: The total size of the disks being migrated in bytes. + description: Output only. The total size of the disks being migrated in bytes. + readOnly: true type: string format: int64 disks: - description: The disks attached to the source VM. + description: Output only. The disks attached to the source VM. + readOnly: true type: array items: $ref: '#/components/schemas/VmwareDiskDetails' @@ -1813,15 +1875,18 @@ components: type: object properties: diskNumber: - description: The ordinal number of the disk. + description: Output only. The ordinal number of the disk. + readOnly: true type: integer format: int32 sizeGb: - description: Size in GB. + description: Output only. Size in GB. + readOnly: true type: string format: int64 label: - description: The disk label. + description: Output only. The disk label. + readOnly: true type: string VmCapabilities: id: VmCapabilities @@ -1857,7 +1922,8 @@ components: type: object properties: firmware: - description: The firmware type of the source VM. + description: Output only. The firmware type of the source VM. + readOnly: true type: string enumDescriptions: - The firmware is unknown. @@ -1868,11 +1934,13 @@ components: - EFI - BIOS committedStorageBytes: - description: The total size of the disks being migrated in bytes. + description: Output only. The total size of the disks being migrated in bytes. + readOnly: true type: string format: int64 disks: - description: The disks attached to the source VM. + description: Output only. The disks attached to the source VM. + readOnly: true type: array items: $ref: '#/components/schemas/AwsDiskDetails' @@ -1888,14 +1956,17 @@ components: type: object properties: diskNumber: - description: The ordinal number of the disk. + description: Output only. The ordinal number of the disk. + readOnly: true type: integer format: int32 volumeId: - description: AWS volume ID. + description: Output only. AWS volume ID. + readOnly: true type: string sizeGb: - description: Size in GB. + description: Output only. Size in GB. + readOnly: true type: string format: int64 AzureSourceVmDetails: @@ -1904,7 +1975,8 @@ components: type: object properties: firmware: - description: The firmware type of the source VM. + description: Output only. The firmware type of the source VM. + readOnly: true type: string enumDescriptions: - The firmware is unknown. @@ -1915,11 +1987,13 @@ components: - EFI - BIOS committedStorageBytes: - description: The total size of the disks being migrated in bytes. + description: Output only. The total size of the disks being migrated in bytes. + readOnly: true type: string format: int64 disks: - description: The disks attached to the source VM. + description: Output only. The disks attached to the source VM. + readOnly: true type: array items: $ref: '#/components/schemas/AzureDiskDetails' @@ -1935,14 +2009,17 @@ components: type: object properties: diskNumber: - description: The ordinal number of the disk. + description: Output only. The ordinal number of the disk. + readOnly: true type: integer format: int32 diskId: - description: Azure disk ID. + description: Output only. Azure disk ID. + readOnly: true type: string sizeGb: - description: Size in GB. + description: Output only. Size in GB. + readOnly: true type: string format: int64 SchedulePolicy: @@ -2031,7 +2108,10 @@ components: - FAILED - SUCCEEDED error: - description: Provides details on the state of the cycle in case of an error. + description: >- + Output only. Provides details on the state of the cycle in case of + an error. + readOnly: true $ref: '#/components/schemas/Status' warnings: description: Output only. Warnings that occurred during the cycle. @@ -2114,15 +2194,18 @@ components: - WARNING_CODE_UNSPECIFIED - ADAPTATION_WARNING warningMessage: - description: The localized warning message. + description: Output only. The localized warning message. + readOnly: true $ref: '#/components/schemas/LocalizedMessage' actionItem: - description: Suggested action for solving the warning. + description: Output only. Suggested action for solving the warning. + readOnly: true $ref: '#/components/schemas/LocalizedMessage' helpLinks: description: >- - URL(s) pointing to additional information on handling the current - warning. + Output only. URL(s) pointing to additional information on handling + the current warning. + readOnly: true type: array items: $ref: '#/components/schemas/Link' @@ -2286,11 +2369,13 @@ components: - >- An alternative to SSD persistent disks that balance performance and cost. + - Hyperdisk balanced disk type. enum: - COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED - COMPUTE_ENGINE_DISK_TYPE_STANDARD - COMPUTE_ENGINE_DISK_TYPE_SSD - COMPUTE_ENGINE_DISK_TYPE_BALANCED + - COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED labels: description: A map of labels to associate with the VM. type: object @@ -2318,6 +2403,14 @@ components: Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. type: boolean + enableVtpm: + description: Optional. Defines whether the instance has vTPM enabled. + type: boolean + enableIntegrityMonitoring: + description: >- + Optional. Defines whether the instance has integrity monitoring + enabled. + type: boolean bootOption: description: The VM Boot Option, as set in the source VM. type: string @@ -2345,6 +2438,21 @@ components: encryption: description: Optional. The encryption to apply to the VM disks. $ref: '#/components/schemas/Encryption' + bootConversion: + description: >- + Optional. By default the virtual machine will keep its existing boot + option. Setting this property will trigger an internal process which + will convert the virtual machine from using the existing boot option + to another. + type: string + enumDescriptions: + - Unspecified conversion type. + - No conversion. + - Convert from BIOS to EFI. + enum: + - BOOT_CONVERSION_UNSPECIFIED + - NONE + - BIOS_TO_EFI ComputeEngineDisksTargetDetails: id: ComputeEngineDisksTargetDetails description: >- @@ -2862,6 +2970,11 @@ components: Immutable. Target details for importing a disk image, will be used by ImageImportJob. $ref: '#/components/schemas/DiskImageTargetDetails' + machineImageTargetDefaults: + description: >- + Immutable. Target details for importing a machine image, will be + used by ImageImportJob. + $ref: '#/components/schemas/MachineImageTargetDetails' name: description: Output only. The resource path of the ImageImport. readOnly: true @@ -2922,7 +3035,11 @@ components: additionalProperties: type: string additionalLicenses: - description: Optional. Additional licenses to assign to the image. + description: >- + Optional. Additional licenses to assign to the image. Format: + https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME + Or + https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME type: array items: type: string @@ -2966,6 +3083,159 @@ components: description: Mentions that the image import is not using OS adaptation process. type: object properties: {} + MachineImageTargetDetails: + id: MachineImageTargetDetails + description: >- + The target details of the machine image resource that will be created by + the image import job. + type: object + properties: + osAdaptationParameters: + description: >- + Optional. Use to set the parameters relevant for the OS adaptation + process. + $ref: '#/components/schemas/ImageImportOsAdaptationParameters' + skipOsAdaptation: + description: Optional. Use to skip OS adaptation process. + $ref: '#/components/schemas/SkipOsAdaptation' + machineImageName: + description: Required. The name of the machine image to be created. + type: string + targetProject: + description: >- + Required. Reference to the TargetProject resource that represents + the target project in which the imported machine image will be + created. + type: string + description: + description: Optional. An optional description of the machine image. + type: string + singleRegionStorage: + description: >- + Optional. Set to true to set the machine image storageLocations to + the single region of the import job. When false, the closest + multi-region is selected. + type: boolean + encryption: + description: Immutable. The encryption to apply to the machine image. + $ref: '#/components/schemas/Encryption' + machineImageParametersOverrides: + description: >- + Optional. Parameters overriding decisions based on the source + machine image configurations. + $ref: '#/components/schemas/MachineImageParametersOverrides' + serviceAccount: + description: >- + Optional. The service account to assign to the instance created by + the machine image. + $ref: '#/components/schemas/ServiceAccount' + additionalLicenses: + description: >- + Optional. Additional licenses to assign to the instance created by + the machine image. Format: + https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME + Or + https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + type: array + items: + type: string + labels: + description: >- + Optional. The labels to apply to the instance created by the machine + image. + type: object + additionalProperties: + type: string + tags: + description: >- + Optional. The tags to apply to the instance created by the machine + image. + type: array + items: + type: string + shieldedInstanceConfig: + description: Optional. Shielded instance configuration. + $ref: '#/components/schemas/ShieldedInstanceConfig' + networkInterfaces: + description: >- + Optional. The network interfaces to create with the instance created + by the machine image. Internal and external IP addresses are ignored + for machine image import. + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + SkipOsAdaptation: + id: SkipOsAdaptation + description: >- + Mentions that the machine image import is not using OS adaptation + process. + type: object + properties: {} + MachineImageParametersOverrides: + id: MachineImageParametersOverrides + description: >- + Parameters overriding decisions based on the source machine image + configurations. + type: object + properties: + machineType: + description: >- + Optional. The machine type to create the MachineImage with. If + empty, the service will choose a relevant machine type based on the + information from the source image. For more information about + machine types, please refer to + https://cloud.google.com/compute/docs/machine-resource. + type: string + ServiceAccount: + id: ServiceAccount + description: Service account to assign to the instance created by the machine image. + type: object + properties: + email: + description: Required. The email address of the service account. + type: string + scopes: + description: >- + Optional. The list of scopes to be made available for this service + account. + type: array + items: + type: string + ShieldedInstanceConfig: + id: ShieldedInstanceConfig + description: Shielded instance configuration. + type: object + properties: + secureBoot: + description: >- + Optional. Defines whether the instance created by the machine image + has Secure Boot enabled. This can be set to true only if the image + boot option is EFI. + type: string + enumDescriptions: + - >- + No explicit value is selected. Will use the configuration of the + source (if exists, otherwise the default will be false). + - >- + Use secure boot. This can be set to true only if the image boot + option is EFI. + - Do not use secure boot. + enum: + - SECURE_BOOT_UNSPECIFIED + - 'TRUE' + - 'FALSE' + enableVtpm: + description: >- + Optional. Defines whether the instance created by the machine image + has vTPM enabled. This can be set to true only if the image boot + option is EFI. + type: boolean + enableIntegrityMonitoring: + description: >- + Optional. Defines whether the instance created by the machine image + has integrity monitoring enabled. This can be set to true only if + the image boot option is EFI, and vTPM is enabled. + type: boolean ImageImportJob: id: ImageImportJob description: ImageImportJob describes the progress and result of an image import. @@ -2981,6 +3251,10 @@ components: description: Output only. Target details used to import a disk image. readOnly: true $ref: '#/components/schemas/DiskImageTargetDetails' + machineImageTargetDetails: + description: Output only. Target details used to import a machine image. + readOnly: true + $ref: '#/components/schemas/MachineImageTargetDetails' name: description: Output only. The resource path of the ImageImportJob. readOnly: true @@ -3367,16 +3641,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -3389,23 +3660,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.vmmigration.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -3433,6 +3702,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' sources: @@ -3440,17 +3710,14 @@ components: name: sources title: Sources methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.sources - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -3487,6 +3754,7 @@ components: - $ref: '#/components/x-stackQL-resources/sources/methods/create' update: - $ref: '#/components/x-stackQL-resources/sources/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/sources/methods/delete' sources_inventory: @@ -3502,26 +3770,26 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/sources_inventory/methods/fetch_inventory insert: [] update: [] + replace: [] delete: [] utilization_reports: id: google.vmmigration.utilization_reports name: utilization_reports title: Utilization_reports methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1utilizationReports/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.utilizationReports - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -3551,6 +3819,7 @@ components: - $ref: >- #/components/x-stackQL-resources/utilization_reports/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/utilization_reports/methods/delete @@ -3559,17 +3828,14 @@ components: name: datacenter_connectors title: Datacenter_connectors methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1datacenterConnectors/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.datacenterConnectors - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -3607,6 +3873,7 @@ components: - $ref: >- #/components/x-stackQL-resources/datacenter_connectors/methods/create update: [] + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/datacenter_connectors/methods/delete @@ -3622,17 +3889,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1migratingVms/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.migratingVms - list: - operation: *ref_11 - response: *ref_12 get: operation: $ref: >- @@ -3690,6 +3954,7 @@ components: - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/create' update: - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/migrating_vms/methods/delete' clone_jobs: @@ -3704,17 +3969,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1migratingVms~1{migratingVmsId}~1cloneJobs/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.cloneJobs - list: - operation: *ref_13 - response: *ref_14 cancel: operation: $ref: >- @@ -3736,6 +3998,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/clone_jobs/methods/create' update: [] + replace: [] delete: [] cutover_jobs: id: google.vmmigration.cutover_jobs @@ -3749,17 +4012,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1migratingVms~1{migratingVmsId}~1cutoverJobs/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.cutoverJobs - list: - operation: *ref_15 - response: *ref_16 cancel: operation: $ref: >- @@ -3781,23 +4041,21 @@ components: insert: - $ref: '#/components/x-stackQL-resources/cutover_jobs/methods/create' update: [] + replace: [] delete: [] replication_cycles: id: google.vmmigration.replication_cycles name: replication_cycles title: Replication_cycles methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1sources~1{sourcesId}~1migratingVms~1{migratingVmsId}~1replicationCycles/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.replicationCycles - list: - operation: *ref_17 - response: *ref_18 get: operation: $ref: >- @@ -3811,23 +4069,21 @@ components: - $ref: '#/components/x-stackQL-resources/replication_cycles/methods/list' insert: [] update: [] + replace: [] delete: [] groups: id: google.vmmigration.groups name: groups title: Groups methods: - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1groups/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.groups - list: - operation: *ref_19 - response: *ref_20 create: operation: $ref: >- @@ -3864,6 +4120,7 @@ components: - $ref: '#/components/x-stackQL-resources/groups/methods/create' update: - $ref: '#/components/x-stackQL-resources/groups/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/groups/methods/delete' groups_group_migration: @@ -3887,25 +4144,27 @@ components: openAPIDocKey: '200' sqlVerbs: select: [] - insert: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/groups_group_migration/methods/add_group_migration update: [] - delete: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/groups_group_migration/methods/remove_group_migration target_projects: id: google.vmmigration.target_projects name: target_projects title: Target_projects methods: - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1targetProjects/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.targetProjects - list: - operation: *ref_21 - response: *ref_22 create: operation: $ref: >- @@ -3942,6 +4201,7 @@ components: - $ref: '#/components/x-stackQL-resources/target_projects/methods/create' update: - $ref: '#/components/x-stackQL-resources/target_projects/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/target_projects/methods/delete' image_imports: @@ -3949,17 +4209,14 @@ components: name: image_imports title: Image_imports methods: - _list: - operation: &ref_23 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1imageImports/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.imageImports - list: - operation: *ref_23 - response: *ref_24 create: operation: $ref: >- @@ -3988,6 +4245,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/image_imports/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/image_imports/methods/delete' image_import_jobs: @@ -3995,17 +4253,14 @@ components: name: image_import_jobs title: Image_import_jobs methods: - _list: - operation: &ref_25 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1imageImports~1{imageImportsId}~1imageImportJobs/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.imageImportJobs - list: - operation: *ref_25 - response: *ref_26 get: operation: $ref: >- @@ -4026,10 +4281,11 @@ components: - $ref: '#/components/x-stackQL-resources/image_import_jobs/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_27 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -4076,7 +4332,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets information about a location. operationId: vmmigration.projects.locations.get @@ -4104,7 +4360,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -4147,7 +4403,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -4218,7 +4474,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -4265,7 +4521,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists Sources in a given project and location. operationId: vmmigration.projects.locations.sources.list @@ -4349,7 +4605,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single Source. operationId: vmmigration.projects.locations.sources.get @@ -4462,7 +4718,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}:fetchInventory: - parameters: *ref_27 + parameters: *ref_1 get: description: >- List remote source's inventory of VMs. The remote source is the onprem @@ -4513,7 +4769,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/utilizationReports: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists Utilization Reports of the given Source. operationId: vmmigration.projects.locations.sources.utilizationReports.list @@ -4611,7 +4867,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/utilizationReports/{utilizationReportsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets a single Utilization Report. operationId: vmmigration.projects.locations.sources.utilizationReports.get @@ -4693,7 +4949,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists DatacenterConnectors in a given Source. operationId: vmmigration.projects.locations.sources.datacenterConnectors.list @@ -4787,7 +5043,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors/{datacenterConnectorsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single DatacenterConnector. operationId: vmmigration.projects.locations.sources.datacenterConnectors.get @@ -4865,7 +5121,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/datacenterConnectors/{datacenterConnectorsId}:upgradeAppliance: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Upgrades the appliance relate to this DatacenterConnector to the @@ -4911,7 +5167,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms: - parameters: *ref_27 + parameters: *ref_1 post: description: Creates a new MigratingVm in a given Source. operationId: vmmigration.projects.locations.sources.migratingVms.create @@ -5009,7 +5265,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single MigratingVm. operationId: vmmigration.projects.locations.sources.migratingVms.get @@ -5137,7 +5393,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:startMigration: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Starts migration for a VM. Starts the process of uploading data and @@ -5182,7 +5438,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:resumeMigration: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Resumes a migration for a VM. When called on a paused migration, will @@ -5229,7 +5485,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:pauseMigration: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Pauses a migration for a VM. If cycle tasks are running they will be @@ -5275,7 +5531,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}:finalizeMigration: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Marks a migration as completed, deleting migration resources that are no @@ -5320,7 +5576,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs: - parameters: *ref_27 + parameters: *ref_1 post: description: Initiates a Clone of a specific migrating VM. operationId: vmmigration.projects.locations.sources.migratingVms.cloneJobs.create @@ -5426,7 +5682,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs/{cloneJobsId}:cancel: - parameters: *ref_27 + parameters: *ref_1 post: description: Initiates the cancellation of a running clone job. operationId: vmmigration.projects.locations.sources.migratingVms.cloneJobs.cancel @@ -5474,7 +5730,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cloneJobs/{cloneJobsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single CloneJob. operationId: vmmigration.projects.locations.sources.migratingVms.cloneJobs.get @@ -5517,7 +5773,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cutoverJobs: - parameters: *ref_27 + parameters: *ref_1 post: description: >- Initiates a Cutover of a specific migrating VM. The returned LRO is @@ -5626,7 +5882,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cutoverJobs/{cutoverJobsId}:cancel: - parameters: *ref_27 + parameters: *ref_1 post: description: Initiates the cancellation of a running cutover job. operationId: vmmigration.projects.locations.sources.migratingVms.cutoverJobs.cancel @@ -5674,7 +5930,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/cutoverJobs/{cutoverJobsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single CutoverJob. operationId: vmmigration.projects.locations.sources.migratingVms.cutoverJobs.get @@ -5717,7 +5973,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists ReplicationCycles in a given MigratingVM. operationId: >- @@ -5773,7 +6029,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/migratingVms/{migratingVmsId}/replicationCycles/{replicationCyclesId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single ReplicationCycle. operationId: >- @@ -5817,7 +6073,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists Groups in a given project and location. operationId: vmmigration.projects.locations.groups.list @@ -5901,7 +6157,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single Group. operationId: vmmigration.projects.locations.groups.get @@ -6014,7 +6270,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:addGroupMigration: - parameters: *ref_27 + parameters: *ref_1 post: description: Adds a MigratingVm to a Group. operationId: vmmigration.projects.locations.groups.addGroupMigration @@ -6052,7 +6308,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:removeGroupMigration: - parameters: *ref_27 + parameters: *ref_1 post: description: Removes a MigratingVm from a Group. operationId: vmmigration.projects.locations.groups.removeGroupMigration @@ -6090,7 +6346,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/targetProjects: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Lists TargetProjects in a given project. NOTE: TargetProject is a global @@ -6179,7 +6435,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/targetProjects/{targetProjectsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: >- Gets details of a single TargetProject. NOTE: TargetProject is a global @@ -6299,7 +6555,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/imageImports: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists ImageImports in a given project. operationId: vmmigration.projects.locations.imageImports.list @@ -6383,7 +6639,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single ImageImport. operationId: vmmigration.projects.locations.imageImports.get @@ -6451,7 +6707,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs: - parameters: *ref_27 + parameters: *ref_1 get: description: Lists ImageImportJobs in a given project. operationId: vmmigration.projects.locations.imageImports.imageImportJobs.list @@ -6501,7 +6757,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}: - parameters: *ref_27 + parameters: *ref_1 get: description: Gets details of a single ImageImportJob. operationId: vmmigration.projects.locations.imageImports.imageImportJobs.get @@ -6539,7 +6795,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}:cancel: - parameters: *ref_27 + parameters: *ref_1 post: description: Initiates the cancellation of a running clone job. operationId: vmmigration.projects.locations.imageImports.imageImportJobs.cancel diff --git a/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml b/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml index a6e5e3c0..4ab8eaec 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vmwareengine.yaml @@ -9,8 +9,8 @@ info: The Google VMware Engine API lets you programmatically manage VMware environments. version: v1 - x-discovery-doc-revision: '20240509' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240820' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/solutions/vmware-as-a-service servers: @@ -404,10 +404,12 @@ components: - Unspecified appliance state. This is the default value. - The appliance is operational and can be used. - The appliance is being deployed. + - The appliance is being activated. enum: - STATE_UNSPECIFIED - ACTIVE - CREATING + - ACTIVATING fqdn: description: Fully qualified domain name of the appliance. type: string @@ -548,6 +550,9 @@ components: cloud and it has to be the first one. readOnly: true type: boolean + autoscalingSettings: + description: Optional. Configuration of the autoscaling applied to this cluster. + $ref: '#/components/schemas/AutoscalingSettings' uid: description: Output only. System-generated unique identifier for the resource. readOnly: true @@ -565,6 +570,106 @@ components: Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud. $ref: '#/components/schemas/StretchedClusterConfig' + AutoscalingSettings: + id: AutoscalingSettings + description: >- + Autoscaling settings define the rules used by VMware Engine to + automatically scale-out and scale-in the clusters in a private cloud. + type: object + properties: + autoscalingPolicies: + description: >- + Required. The map with autoscaling policies applied to the cluster. + The key is the identifier of the policy. It must meet the following + requirements: * Only contains 1-63 alphanumeric characters and + hyphens * Begins with an alphabetical character * Ends with a + non-hyphen character * Not formatted as a UUID * Complies with [RFC + 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + Currently there map must contain only one element that describes the + autoscaling policy for compute nodes. + type: object + additionalProperties: + $ref: '#/components/schemas/AutoscalingPolicy' + minClusterNodeCount: + description: >- + Optional. Minimum number of nodes of any type in a cluster. If not + specified the default limits apply. + type: integer + format: int32 + maxClusterNodeCount: + description: >- + Optional. Maximum number of nodes of any type in a cluster. If not + specified the default limits apply. + type: integer + format: int32 + coolDownPeriod: + description: >- + Optional. The minimum duration between consecutive autoscale + operations. It starts once addition or removal of nodes is fully + completed. Defaults to 30 minutes if not specified. Cool down period + must be in whole minutes (for example, 30, 31, 50, 180 minutes). + type: string + format: google-duration + AutoscalingPolicy: + id: AutoscalingPolicy + description: >- + Autoscaling policy describes the behavior of the autoscaling with + respect to the resource utilization. The scale-out operation is + initiated if the utilization exceeds ANY of the respective thresholds. + The scale-in operation is initiated if the utilization is below ALL of + the respective thresholds. + type: object + properties: + nodeTypeId: + description: >- + Required. The canonical identifier of the node type to add or + remove. Corresponds to the `NodeType`. + type: string + scaleOutSize: + description: >- + Required. Number of nodes to add to a cluster during a scale-out + operation. Must be divisible by 2 for stretched clusters. During a + scale-in operation only one node (or 2 for stretched clusters) are + removed in a single iteration. + type: integer + format: int32 + cpuThresholds: + description: Optional. Utilization thresholds pertaining to CPU utilization. + $ref: '#/components/schemas/Thresholds' + grantedMemoryThresholds: + description: >- + Optional. Utilization thresholds pertaining to amount of granted + memory. + $ref: '#/components/schemas/Thresholds' + consumedMemoryThresholds: + description: >- + Optional. Utilization thresholds pertaining to amount of consumed + memory. + $ref: '#/components/schemas/Thresholds' + storageThresholds: + description: >- + Optional. Utilization thresholds pertaining to amount of consumed + storage. + $ref: '#/components/schemas/Thresholds' + Thresholds: + id: Thresholds + description: >- + Thresholds define the utilization of resources triggering scale-out and + scale-in operations. + type: object + properties: + scaleOut: + description: >- + Required. The utilization triggering the scale-out operation in + percent. + type: integer + format: int32 + scaleIn: + description: >- + Required. The utilization triggering the scale-in operation in + percent. + type: integer + format: int32 ListNodesResponse: id: ListNodesResponse description: Response message for VmwareEngine.ListNodes @@ -1401,6 +1506,9 @@ components: Most third-party services require manual setup of reverse peering on the VPC network associated with the third-party service. - Peering connection used for connecting to Dell PowerScale Filers + - >- + Peering connection used for connecting to Google Cloud NetApp + Volumes. enum: - PEER_NETWORK_TYPE_UNSPECIFIED - STANDARD @@ -1409,6 +1517,7 @@ components: - NETAPP_CLOUD_VOLUMES - THIRD_PARTY_SERVICE - DELL_POWERSCALE + - GOOGLE_CLOUD_NETAPP_VOLUMES uid: description: Output only. System-generated unique identifier for the resource. readOnly: true @@ -2774,22 +2883,20 @@ components: #/components/x-stackQL-resources/dns_bind_permission/methods/get_dns_bind_permission insert: [] update: [] + replace: [] delete: [] locations: id: google.vmwareengine.locations name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -2802,23 +2909,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.vmwareengine.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -2839,6 +2944,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' private_clouds: @@ -2846,17 +2952,14 @@ components: name: private_clouds title: Private_clouds methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.privateClouds - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -2928,6 +3031,7 @@ components: - $ref: '#/components/x-stackQL-resources/private_clouds/methods/create' update: - $ref: '#/components/x-stackQL-resources/private_clouds/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/private_clouds/methods/delete' private_clouds_dns_forwarding: @@ -2954,7 +3058,10 @@ components: - $ref: >- #/components/x-stackQL-resources/private_clouds_dns_forwarding/methods/get_dns_forwarding insert: [] - update: [] + update: + - $ref: >- + #/components/x-stackQL-resources/private_clouds_dns_forwarding/methods/update_dns_forwarding + replace: [] delete: [] private_clouds_iam_policies: id: google.vmwareengine.private_clouds_iam_policies @@ -2968,17 +3075,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_7 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}:getIamPolicy/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_7 - response: *ref_8 test_iam_permissions: operation: $ref: >- @@ -2992,23 +3096,23 @@ components: #/components/x-stackQL-resources/private_clouds_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/private_clouds_iam_policies/methods/set_iam_policy delete: [] clusters: id: google.vmwareengine.clusters name: clusters title: Clusters methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1clusters/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.clusters - list: - operation: *ref_9 - response: *ref_10 create: operation: $ref: >- @@ -3045,6 +3149,7 @@ components: - $ref: '#/components/x-stackQL-resources/clusters/methods/create' update: - $ref: '#/components/x-stackQL-resources/clusters/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete' clusters_iam_policies: @@ -3059,17 +3164,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1clusters~1{clustersId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -3083,23 +3185,23 @@ components: #/components/x-stackQL-resources/clusters_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/clusters_iam_policies/methods/set_iam_policy delete: [] nodes: id: google.vmwareengine.nodes name: nodes title: Nodes methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1clusters~1{clustersId}~1nodes/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodes - list: - operation: *ref_13 - response: *ref_14 get: operation: $ref: >- @@ -3113,23 +3215,21 @@ components: - $ref: '#/components/x-stackQL-resources/nodes/methods/list' insert: [] update: [] + replace: [] delete: [] external_addresses: id: google.vmwareengine.external_addresses name: external_addresses title: External_addresses methods: - _list: - operation: &ref_15 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1externalAddresses/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.externalAddresses - list: - operation: *ref_15 - response: *ref_16 create: operation: $ref: >- @@ -3166,6 +3266,7 @@ components: - $ref: '#/components/x-stackQL-resources/external_addresses/methods/create' update: - $ref: '#/components/x-stackQL-resources/external_addresses/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/external_addresses/methods/delete' subnets: @@ -3173,17 +3274,14 @@ components: name: subnets title: Subnets methods: - _list: - operation: &ref_17 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1subnets/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.subnets - list: - operation: *ref_17 - response: *ref_18 get: operation: $ref: >- @@ -3205,23 +3303,21 @@ components: insert: [] update: - $ref: '#/components/x-stackQL-resources/subnets/methods/patch' + replace: [] delete: [] logging_servers: id: google.vmwareengine.logging_servers name: logging_servers title: Logging_servers methods: - _list: - operation: &ref_19 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1loggingServers/get - response: &ref_20 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.loggingServers - list: - operation: *ref_19 - response: *ref_20 create: operation: $ref: >- @@ -3258,6 +3354,7 @@ components: - $ref: '#/components/x-stackQL-resources/logging_servers/methods/create' update: - $ref: '#/components/x-stackQL-resources/logging_servers/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/logging_servers/methods/delete' hcx_activation_keys: @@ -3272,17 +3369,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_21 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1hcxActivationKeys/get - response: &ref_22 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.hcxActivationKeys - list: - operation: *ref_21 - response: *ref_22 get: operation: $ref: >- @@ -3298,6 +3392,7 @@ components: - $ref: >- #/components/x-stackQL-resources/hcx_activation_keys/methods/create update: [] + replace: [] delete: [] hcx_activation_keys_iam_policies: id: google.vmwareengine.hcx_activation_keys_iam_policies @@ -3311,17 +3406,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_23 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1hcxActivationKeys~1{hcxActivationKeysId}:getIamPolicy/get - response: &ref_24 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_23 - response: *ref_24 test_iam_permissions: operation: $ref: >- @@ -3335,23 +3427,23 @@ components: #/components/x-stackQL-resources/hcx_activation_keys_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/hcx_activation_keys_iam_policies/methods/set_iam_policy delete: [] management_dns_zone_bindings: id: google.vmwareengine.management_dns_zone_bindings name: management_dns_zone_bindings title: Management_dns_zone_bindings methods: - _list: - operation: &ref_25 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateClouds~1{privateCloudsId}~1managementDnsZoneBindings/get - response: &ref_26 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.managementDnsZoneBindings - list: - operation: *ref_25 - response: *ref_26 create: operation: $ref: >- @@ -3399,6 +3491,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/management_dns_zone_bindings/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/management_dns_zone_bindings/methods/delete @@ -3415,9 +3508,12 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - select: [] + select: + - $ref: >- + #/components/x-stackQL-resources/network_policies_external_addresses/methods/fetch_external_addresses insert: [] update: [] + replace: [] delete: [] network_policies: id: google.vmwareengine.network_policies @@ -3445,17 +3541,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_27 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkPolicies/get - response: &ref_28 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.networkPolicies - list: - operation: *ref_27 - response: *ref_28 create: operation: $ref: >- @@ -3471,6 +3564,7 @@ components: - $ref: '#/components/x-stackQL-resources/network_policies/methods/create' update: - $ref: '#/components/x-stackQL-resources/network_policies/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/network_policies/methods/delete' external_access_rules: @@ -3478,17 +3572,14 @@ components: name: external_access_rules title: External_access_rules methods: - _list: - operation: &ref_29 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkPolicies~1{networkPoliciesId}~1externalAccessRules/get - response: &ref_30 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.externalAccessRules - list: - operation: *ref_29 - response: *ref_30 create: operation: $ref: >- @@ -3528,6 +3619,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/external_access_rules/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/external_access_rules/methods/delete @@ -3536,17 +3628,14 @@ components: name: node_types title: Node_types methods: - _list: - operation: &ref_31 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1nodeTypes/get - response: &ref_32 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.nodeTypes - list: - operation: *ref_31 - response: *ref_32 get: operation: $ref: >- @@ -3560,6 +3649,7 @@ components: - $ref: '#/components/x-stackQL-resources/node_types/methods/list' insert: [] update: [] + replace: [] delete: [] network_peerings: id: google.vmwareengine.network_peerings @@ -3587,17 +3677,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_33 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1networkPeerings/get - response: &ref_34 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.networkPeerings - list: - operation: *ref_33 - response: *ref_34 create: operation: $ref: >- @@ -3613,6 +3700,7 @@ components: - $ref: '#/components/x-stackQL-resources/network_peerings/methods/create' update: - $ref: '#/components/x-stackQL-resources/network_peerings/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/network_peerings/methods/delete' peering_routes: @@ -3620,23 +3708,20 @@ components: name: peering_routes title: Peering_routes methods: - _list: - operation: &ref_35 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateConnections~1{privateConnectionsId}~1peeringRoutes/get - response: &ref_36 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.peeringRoutes - list: - operation: *ref_35 - response: *ref_36 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/peering_routes/methods/list' - - $ref: '#/components/x-stackQL-resources/peering_routes/methods/list' insert: [] update: [] + replace: [] delete: [] vmware_engine_networks: id: google.vmwareengine.vmware_engine_networks @@ -3650,17 +3735,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_37 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1vmwareEngineNetworks/get - response: &ref_38 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.vmwareEngineNetworks - list: - operation: *ref_37 - response: *ref_38 patch: operation: $ref: >- @@ -3694,6 +3776,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/vmware_engine_networks/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/vmware_engine_networks/methods/delete @@ -3709,17 +3792,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_39 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1privateConnections/get - response: &ref_40 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.privateConnections - list: - operation: *ref_39 - response: *ref_40 get: operation: $ref: >- @@ -3750,12 +3830,13 @@ components: #/components/x-stackQL-resources/private_connections/methods/create update: - $ref: '#/components/x-stackQL-resources/private_connections/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/private_connections/methods/delete paths: /v1/projects/{projectsId}/locations/{locationsId}/dnsBindPermission: - parameters: &ref_41 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -3797,7 +3878,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists information about the supported locations for this service. operationId: vmwareengine.projects.locations.list @@ -3833,7 +3914,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets information about a location. operationId: vmwareengine.projects.locations.get @@ -3861,7 +3942,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -3904,7 +3985,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -3975,7 +4056,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists `PrivateCloud` resources in a given project and location. operationId: vmwareengine.projects.locations.privateClouds.list @@ -4069,7 +4150,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Retrieves a `PrivateCloud` resource by its resource name. operationId: vmwareengine.projects.locations.privateClouds.get @@ -4211,7 +4292,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:undelete: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Restores a private cloud that was previously scheduled for deletion by @@ -4253,7 +4334,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:showNsxCredentials: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of credentials for NSX appliance. operationId: vmwareengine.projects.locations.privateClouds.showNsxCredentials @@ -4286,7 +4367,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:showVcenterCredentials: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of credentials for Vcenter appliance. operationId: vmwareengine.projects.locations.privateClouds.showVcenterCredentials @@ -4323,7 +4404,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:resetNsxCredentials: - parameters: *ref_41 + parameters: *ref_1 post: description: Resets credentials of the NSX appliance. operationId: vmwareengine.projects.locations.privateClouds.resetNsxCredentials @@ -4361,7 +4442,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:resetVcenterCredentials: - parameters: *ref_41 + parameters: *ref_1 post: description: Resets credentials of the Vcenter appliance. operationId: vmwareengine.projects.locations.privateClouds.resetVcenterCredentials @@ -4399,7 +4480,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/dnsForwarding: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of the `DnsForwarding` config. operationId: vmwareengine.projects.locations.privateClouds.getDnsForwarding @@ -4479,7 +4560,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4520,7 +4601,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4560,7 +4641,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4603,7 +4684,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists `Cluster` resources in a given private cloud. operationId: vmwareengine.projects.locations.privateClouds.clusters.list @@ -4705,7 +4786,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Retrieves a `Cluster` resource by its resource name. operationId: vmwareengine.projects.locations.privateClouds.clusters.get @@ -4846,7 +4927,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -4892,7 +4973,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -4937,7 +5018,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -4986,7 +5067,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}/nodes: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists nodes in a given cluster. operationId: vmwareengine.projects.locations.privateClouds.clusters.nodes.list @@ -5033,7 +5114,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}/nodes/{nodesId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a single node. operationId: vmwareengine.projects.locations.privateClouds.clusters.nodes.get @@ -5076,7 +5157,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/externalAddresses: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists external IP addresses assigned to VMware workload VMs in a given @@ -5176,7 +5257,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/externalAddresses/{externalAddressesId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a single external IP address. operationId: vmwareengine.projects.locations.privateClouds.externalAddresses.get @@ -5312,7 +5393,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists subnets in a given private cloud. operationId: vmwareengine.projects.locations.privateClouds.subnets.list @@ -5354,7 +5435,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets/{subnetsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a single subnet. operationId: vmwareengine.projects.locations.privateClouds.subnets.get @@ -5442,7 +5523,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/loggingServers: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists logging servers configured for a given private cloud. operationId: vmwareengine.projects.locations.privateClouds.loggingServers.list @@ -5536,7 +5617,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/loggingServers/{loggingServersId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a logging server. operationId: vmwareengine.projects.locations.privateClouds.loggingServers.get @@ -5666,7 +5747,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys: - parameters: *ref_41 + parameters: *ref_1 post: description: Creates a new HCX activation key in a given private cloud. operationId: vmwareengine.projects.locations.privateClouds.hcxActivationKeys.create @@ -5752,7 +5833,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Retrieves a `HcxActivationKey` resource by its resource name. operationId: vmwareengine.projects.locations.privateClouds.hcxActivationKeys.get @@ -5790,7 +5871,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:setIamPolicy: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -5837,7 +5918,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:getIamPolicy: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -5883,7 +5964,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:testIamPermissions: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -5932,7 +6013,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/managementDnsZoneBindings: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists Consumer VPCs bound to Management DNS Zone of a given private @@ -6037,7 +6118,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/managementDnsZoneBindings/{managementDnsZoneBindingsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Retrieves a 'ManagementDnsZoneBinding' resource by its resource name. operationId: >- @@ -6173,7 +6254,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/managementDnsZoneBindings/{managementDnsZoneBindingsId}:repair: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Retries to create a `ManagementDnsZoneBinding` resource that is in @@ -6219,7 +6300,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}:fetchExternalAddresses: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists external IP addresses assigned to VMware workload VMs within the @@ -6264,7 +6345,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Retrieves a `NetworkPolicy` resource by its resource name. operationId: vmwareengine.projects.locations.networkPolicies.get @@ -6390,7 +6471,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPolicies: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists `NetworkPolicy` resources in a specified project and location. operationId: vmwareengine.projects.locations.networkPolicies.list @@ -6477,7 +6558,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}/externalAccessRules: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists `ExternalAccessRule` resources in the specified network policy. operationId: vmwareengine.projects.locations.networkPolicies.externalAccessRules.list @@ -6572,7 +6653,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}/externalAccessRules/{externalAccessRulesId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a single external access rule. operationId: vmwareengine.projects.locations.networkPolicies.externalAccessRules.get @@ -6704,7 +6785,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/nodeTypes: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists node types operationId: vmwareengine.projects.locations.nodeTypes.list @@ -6745,7 +6826,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/nodeTypes/{nodeTypesId}: - parameters: *ref_41 + parameters: *ref_1 get: description: Gets details of a single `NodeType`. operationId: vmwareengine.projects.locations.nodeTypes.get @@ -6778,7 +6859,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPeerings/{networkPeeringsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Retrieves a `NetworkPeering` resource by its resource name. The resource @@ -6902,7 +6983,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPeerings: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists `NetworkPeering` resources in a given project. NetworkPeering is a @@ -6991,7 +7072,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/networkPeerings/{networkPeeringsId}/peeringRoutes: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Lists the network peering routes exchanged over a peering connection. @@ -7039,7 +7120,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks: - parameters: *ref_41 + parameters: *ref_1 post: description: Creates a new VMware Engine network that can be used by a private cloud. operationId: vmwareengine.projects.locations.vmwareEngineNetworks.create @@ -7123,7 +7204,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks/{vmwareEngineNetworksId}: - parameters: *ref_41 + parameters: *ref_1 patch: description: >- Modifies a VMware Engine network resource. Only the following fields can @@ -7251,7 +7332,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Creates a new private connection that can be used for accessing private @@ -7337,7 +7418,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}: - parameters: *ref_41 + parameters: *ref_1 get: description: >- Retrieves a `PrivateConnection` resource by its resource name. The @@ -7459,7 +7540,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/peeringRoutes: - parameters: *ref_41 + parameters: *ref_1 get: description: Lists the private connection routes exchanged over a peering connection. operationId: vmwareengine.projects.locations.privateConnections.peeringRoutes.list @@ -7502,7 +7583,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dnsBindPermission:grant: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Grants the bind permission to the customer provided principal(user / @@ -7539,7 +7620,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/dnsBindPermission:revoke: - parameters: *ref_41 + parameters: *ref_1 post: description: >- Revokes the bind permission from the customer provided principal(user / diff --git a/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml b/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml index 1f0a1b20..15cdac49 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/vpcaccess.yaml @@ -7,8 +7,8 @@ info: title: Serverless VPC Access API description: API for managing VPC access connectors. version: v1 - x-discovery-doc-revision: '20240502' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240905' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/vpc/docs/configure-serverless-vpc-access servers: @@ -191,12 +191,12 @@ components: `projects/*/locations/*/connectors/*`. type: string network: - description: Name of a VPC network. + description: Optional. Name of a VPC network. type: string ipCidrRange: description: >- - The range of internal addresses that follows RFC 4632 notation. - Example: `10.132.0.0/28`. + Optional. The range of internal addresses that follows RFC 4632 + notation. Example: `10.132.0.0/28`. type: string state: description: Output only. State of the VPC access connector. @@ -225,6 +225,7 @@ components: min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`. + deprecated: true type: integer format: int32 maxThroughput: @@ -236,6 +237,7 @@ components: max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`. + deprecated: true type: integer format: int32 connectedProjects: @@ -245,7 +247,7 @@ components: items: type: string subnet: - description: The subnet in which to house the VPC Access Connector. + description: Optional. The subnet in which to house the VPC Access Connector. $ref: '#/components/schemas/Subnet' machineType: description: >- @@ -271,16 +273,16 @@ components: properties: name: description: >- - Subnet name (relative, not fully qualified). E.g. if the full subnet - selfLink is + Optional. Subnet name (relative, not fully qualified). E.g. if the + full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName} type: string projectId: description: >- - Project in which the subnet exists. If not set, this project is - assumed to be the project for which the connector create request was - issued. + Optional. Project in which the subnet exists. If not set, this + project is assumed to be the project for which the connector create + request was issued. type: string ListConnectorsResponse: id: ListConnectorsResponse @@ -462,38 +464,33 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.vpcaccess.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -507,6 +504,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: [] connectors: id: google.vpcaccess.connectors @@ -520,17 +518,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1connectors/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.connectors - list: - operation: *ref_5 - response: *ref_6 patch: operation: $ref: >- @@ -560,11 +555,12 @@ components: - $ref: '#/components/x-stackQL-resources/connectors/methods/create' update: - $ref: '#/components/x-stackQL-resources/connectors/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/connectors/methods/delete' paths: /v1/projects/{projectsId}/locations: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -611,7 +607,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -654,7 +650,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -690,7 +686,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connectors: - parameters: *ref_7 + parameters: *ref_1 post: description: Creates a Serverless VPC Access connector, returns an operation. operationId: vpcaccess.projects.locations.connectors.create @@ -762,7 +758,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}: - parameters: *ref_7 + parameters: *ref_1 patch: description: Updates a Serverless VPC Access connector, returns an operation. operationId: vpcaccess.projects.locations.connectors.patch diff --git a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml index 36afe136..5d34c4ed 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/webrisk.yaml @@ -7,8 +7,8 @@ info: title: Web Risk API description: '' version: v1 - x-discovery-doc-revision: '20240519' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240908' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/web-risk/ servers: @@ -34,11 +34,61 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - GoogleLongrunningCancelOperationRequest: + GoogleLongrunningListOperationsResponse: + id: GoogleLongrunningListOperationsResponse + type: object + properties: + nextPageToken: + description: The standard List next-page token. + type: string + operations: + description: >- + A list of operations that matches the specified filter in the + request. + type: array + items: + $ref: '#/components/schemas/GoogleLongrunningOperation' + description: The response message for Operations.ListOperations. + GoogleCloudWebriskV1RiceDeltaEncoding: + id: GoogleCloudWebriskV1RiceDeltaEncoding + properties: + firstValue: + format: int64 + type: string + description: >- + The offset of the first entry in the encoded data, or, if only a + single integer was encoded, that single integer's value. If the + field is empty or missing, assume zero. + riceParameter: + description: >- + The Golomb-Rice parameter, which is a number between 2 and 28. This + field is missing (that is, zero) if `num_entries` is zero. + type: integer + format: int32 + entryCount: + format: int32 + type: integer + description: >- + The number of entries that are delta encoded in the encoded data. If + only a single integer was encoded, this will be zero and the single + value will be stored in `first_value`. + encodedData: + type: string + description: The encoded deltas that are encoded using the Golomb-Rice coder. + format: byte + type: object + description: >- + The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes + or compressed removal indices. + GoogleProtobufEmpty: properties: {} - id: GoogleLongrunningCancelOperationRequest - description: The request message for Operations.CancelOperation. type: object + id: GoogleProtobufEmpty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } GoogleCloudWebriskV1SearchUrisResponse: type: object properties: @@ -48,142 +98,92 @@ components: The threat list matches. This might be empty if the URI is on no list. id: GoogleCloudWebriskV1SearchUrisResponse - GoogleRpcStatus: - id: GoogleRpcStatus - description: >- - The `Status` type defines a logical error model that is suitable for - different programming environments, including REST APIs and RPC APIs. It - is used by [gRPC](https://github.com/grpc). Each `Status` message - contains three pieces of data: error code, error message, and error - details. You can find out more about this error model and how to work - with it in the [API Design - Guide](https://cloud.google.com/apis/design/errors). + GoogleCloudWebriskV1Submission: + id: GoogleCloudWebriskV1Submission type: object properties: - code: - format: int32 - type: integer - description: The status code, which should be an enum value of google.rpc.Code. - details: + uri: + type: string description: >- - A list of messages that carry the error details. There is a common - set of message types for APIs to use. + Required. The URI that is being reported for malicious content to be + analyzed. + description: Wraps a URI that might be displaying malicious content. + GoogleCloudWebriskV1SearchHashesResponse: + properties: + threats: type: array - items: - type: object - additionalProperties: - description: Properties of the object. Contains field @type with type URL. - type: any - message: description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - google.rpc.Status.details field, or localized by the client. + The full hashes that matched the requested prefixes. The hash will + be populated in the key. + items: + $ref: >- + #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash + negativeExpireTime: + format: google-datetime type: string - GoogleCloudWebriskV1ComputeThreatListDiffResponse: + description: >- + For requested entities that did not match the threat list, how long + to cache the response until. + id: GoogleCloudWebriskV1SearchHashesResponse type: object - id: GoogleCloudWebriskV1ComputeThreatListDiffResponse + GoogleLongrunningCancelOperationRequest: + type: object + id: GoogleLongrunningCancelOperationRequest + properties: {} + description: The request message for Operations.CancelOperation. + GoogleCloudWebriskV1RawHashes: + id: GoogleCloudWebriskV1RawHashes + description: >- + The uncompressed threat entries in hash format. Hashes can be anywhere + from 4 to 32 bytes in size. A large majority are 4 bytes, but some + hashes are lengthened if they collide with the hash of a popular URI. + Used for sending ThreatEntryAdditons to clients that do not support + compression, or when sending non-4-byte hashes to clients that do + support compression. properties: - removals: + rawHashes: description: >- - A set of entries to remove from a local threat type's list. This - field may be empty. - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' - newVersionToken: + The hashes, in binary format, concatenated into one long string. + Hashes are sorted in lexicographic order. For JSON API users, hashes + are base64-encoded. format: byte - description: >- - The new opaque client version token. This should be retained by the - client and passed into the next call of ComputeThreatListDiff as - 'version_token'. A separate version token should be stored and used - for each threatList. type: string - recommendedNextDiff: - description: >- - The soonest the client should wait before issuing any diff request. - Querying sooner is unlikely to produce a meaningful diff. Waiting - longer is acceptable considering the use case. If this field is not - set clients may update as soon as they want. - type: string - format: google-datetime - checksum: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum - description: >- - The expected SHA256 hash of the client state; that is, of the sorted - list of all hashes present in the database after applying the - provided diff. If the client state doesn't match the expected state, - the client must discard this diff and retry later. - additions: - $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' - description: A set of entries to add to a local threat type's list. - responseType: - enumDescriptions: - - Unknown. - - >- - Partial updates are applied to the client's existing local - database. - - >- - Full updates resets the client's entire local database. This means - that either the client had no state, was seriously out-of-date, or - the client is believed to be corrupt. - enum: - - RESPONSE_TYPE_UNSPECIFIED - - DIFF - - RESET + prefixSize: + format: int32 + type: integer description: >- - The type of response. This may indicate that an action must be taken - by the client when the response is received. - type: string - GoogleLongrunningListOperationsResponse: + The number of bytes for each prefix encoded below. This field can be + anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). In + practice this is almost always 4, except in exceptional + circumstances. type: object - description: The response message for Operations.ListOperations. + GoogleCloudWebriskV1SearchHashesResponseThreatHash: properties: - nextPageToken: - description: The standard List next-page token. + expireTime: type: string - operations: - type: array - items: - $ref: '#/components/schemas/GoogleLongrunningOperation' - description: >- - A list of operations that matches the specified filter in the - request. - id: GoogleLongrunningListOperationsResponse - GoogleCloudWebriskV1ThreatEntryAdditions: - properties: - rawHashes: - items: - $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' - type: array - description: >- - The raw SHA256-formatted entries. Repeated to allow returning sets - of hashes with different prefix sizes. - riceHashes: + format: google-datetime description: >- - The encoded 4-byte prefixes of SHA256-formatted entries, using a - Golomb-Rice encoding. The hashes are converted to uint32, sorted in - ascending order, then delta encoded and stored as encoded_data. - $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' - id: GoogleCloudWebriskV1ThreatEntryAdditions - description: >- - Contains the set of entries to add to a local database. May contain a - combination of compressed and raw data in a single response. - type: object - GoogleCloudWebriskV1Submission: - id: GoogleCloudWebriskV1Submission - properties: - uri: + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. + hash: type: string description: >- - Required. The URI that is being reported for malicious content to be - analyzed. - description: Wraps a URI that might be displaying malicious content. - type: object - GoogleCloudWebriskV1SearchHashesResponseThreatHash: - description: Contains threat information on a matching hash. - properties: + A 32 byte SHA256 hash. This field is in binary format. For JSON + requests, hashes are base64-encoded. + format: byte threatTypes: + description: >- + The ThreatList this threat belongs to. This must contain at least + one entry. + type: array items: + enum: + - THREAT_TYPE_UNSPECIFIED + - MALWARE + - SOCIAL_ENGINEERING + - UNWANTED_SOFTWARE + - SOCIAL_ENGINEERING_EXTENDED_COVERAGE + type: string enumDescriptions: - >- No entries should match this threat type. This threat type is @@ -194,107 +194,109 @@ components: - >- A list of extended coverage social engineering URIs targeting any platform. - type: string - enum: - - THREAT_TYPE_UNSPECIFIED - - MALWARE - - SOCIAL_ENGINEERING - - UNWANTED_SOFTWARE - - SOCIAL_ENGINEERING_EXTENDED_COVERAGE - type: array - description: >- - The ThreatList this threat belongs to. This must contain at least - one entry. - expireTime: - format: google-datetime - type: string - description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. - hash: - format: byte - description: >- - A 32 byte SHA256 hash. This field is in binary format. For JSON - requests, hashes are base64-encoded. - type: string + type: object id: GoogleCloudWebriskV1SearchHashesResponseThreatHash + description: Contains threat information on a matching hash. + GoogleCloudWebriskV1RawIndices: + description: A set of raw indices to remove from a local list. + id: GoogleCloudWebriskV1RawIndices type: object - GoogleCloudWebriskV1RiceDeltaEncoding: properties: - encodedData: - type: string - format: byte - description: The encoded deltas that are encoded using the Golomb-Rice coder. - entryCount: - format: int32 - type: integer + indices: + type: array + items: + type: integer + format: int32 + description: The indices to remove from a lexicographically-sorted local list. + GoogleRpcStatus: + description: >- + The `Status` type defines a logical error model that is suitable for + different programming environments, including REST APIs and RPC APIs. It + is used by [gRPC](https://github.com/grpc). Each `Status` message + contains three pieces of data: error code, error message, and error + details. You can find out more about this error model and how to work + with it in the [API Design + Guide](https://cloud.google.com/apis/design/errors). + id: GoogleRpcStatus + properties: + details: + type: array + items: + additionalProperties: + type: any + description: Properties of the object. Contains field @type with type URL. + type: object description: >- - The number of entries that are delta encoded in the encoded data. If - only a single integer was encoded, this will be zero and the single - value will be stored in `first_value`. - firstValue: + A list of messages that carry the error details. There is a common + set of message types for APIs to use. + message: type: string description: >- - The offset of the first entry in the encoded data, or, if only a - single integer was encoded, that single integer's value. If the - field is empty or missing, assume zero. - format: int64 - riceParameter: - format: int32 + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + google.rpc.Status.details field, or localized by the client. + code: type: integer - description: >- - The Golomb-Rice parameter, which is a number between 2 and 28. This - field is missing (that is, zero) if `num_entries` is zero. - type: object - description: >- - The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes - or compressed removal indices. - id: GoogleCloudWebriskV1RiceDeltaEncoding - GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: - id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum - description: The expected state of a client's local database. + format: int32 + description: The status code, which should be an enum value of google.rpc.Code. type: object + GoogleCloudWebriskV1ComputeThreatListDiffResponse: properties: - sha256: - type: string + removals: + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryRemovals' description: >- - The SHA256 hash of the client state; that is, of the sorted list of - all hashes present in the database. + A set of entries to remove from a local threat type's list. This + field may be empty. + newVersionToken: format: byte - GoogleProtobufEmpty: - type: object - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: GoogleProtobufEmpty - properties: {} - GoogleCloudWebriskV1SearchHashesResponse: - properties: - threats: - type: array - items: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1SearchHashesResponseThreatHash description: >- - The full hashes that matched the requested prefixes. The hash will - be populated in the key. - negativeExpireTime: - format: google-datetime + The new opaque client version token. This should be retained by the + client and passed into the next call of ComputeThreatListDiff as + 'version_token'. A separate version token should be stored and used + for each threatList. type: string + checksum: + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum description: >- - For requested entities that did not match the threat list, how long - to cache the response until. + The expected SHA256 hash of the client state; that is, of the sorted + list of all hashes present in the database after applying the + provided diff. If the client state doesn't match the expected state, + the client must discard this diff and retry later. + additions: + $ref: '#/components/schemas/GoogleCloudWebriskV1ThreatEntryAdditions' + description: A set of entries to add to a local threat type's list. + responseType: + enumDescriptions: + - Unknown. + - >- + Partial updates are applied to the client's existing local + database. + - >- + Full updates resets the client's entire local database. This means + that either the client had no state, was seriously out-of-date, or + the client is believed to be corrupt. + type: string + enum: + - RESPONSE_TYPE_UNSPECIFIED + - DIFF + - RESET + description: >- + The type of response. This may indicate that an action must be taken + by the client when the response is received. + recommendedNextDiff: + type: string + format: google-datetime + description: >- + The soonest the client should wait before issuing any diff request. + Querying sooner is unlikely to produce a meaningful diff. Waiting + longer is acceptable considering the use case. If this field is not + set clients may update as soon as they want. type: object - id: GoogleCloudWebriskV1SearchHashesResponse + id: GoogleCloudWebriskV1ComputeThreatListDiffResponse GoogleCloudWebriskV1ThreatEntryRemovals: - description: Contains the set of entries to remove from a local database. type: object properties: - rawIndices: - $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' - description: The raw removal indices for a local list. riceIndices: $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' description: >- @@ -302,66 +304,56 @@ components: Golomb-Rice encoding. Used for sending compressed removal indices. The removal indices (uint32) are sorted in ascending order, then delta encoded and stored as encoded_data. + rawIndices: + description: The raw removal indices for a local list. + $ref: '#/components/schemas/GoogleCloudWebriskV1RawIndices' + description: Contains the set of entries to remove from a local database. id: GoogleCloudWebriskV1ThreatEntryRemovals - GoogleCloudWebriskV1RawIndices: + GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum: properties: - indices: - items: - format: int32 - type: integer - type: array - description: The indices to remove from a lexicographically-sorted local list. - id: GoogleCloudWebriskV1RawIndices - description: A set of raw indices to remove from a local list. + sha256: + type: string + format: byte + description: >- + The SHA256 hash of the client state; that is, of the sorted list of + all hashes present in the database. + id: GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum + description: The expected state of a client's local database. type: object - GoogleCloudWebriskV1RawHashes: + GoogleCloudWebriskV1ThreatEntryAdditions: description: >- - The uncompressed threat entries in hash format. Hashes can be anywhere - from 4 to 32 bytes in size. A large majority are 4 bytes, but some - hashes are lengthened if they collide with the hash of a popular URI. - Used for sending ThreatEntryAdditons to clients that do not support - compression, or when sending non-4-byte hashes to clients that do - support compression. - id: GoogleCloudWebriskV1RawHashes + Contains the set of entries to add to a local database. May contain a + combination of compressed and raw data in a single response. + id: GoogleCloudWebriskV1ThreatEntryAdditions + type: object properties: - rawHashes: - format: byte - type: string + riceHashes: + $ref: '#/components/schemas/GoogleCloudWebriskV1RiceDeltaEncoding' description: >- - The hashes, in binary format, concatenated into one long string. - Hashes are sorted in lexicographic order. For JSON API users, hashes - are base64-encoded. - prefixSize: + The encoded 4-byte prefixes of SHA256-formatted entries, using a + Golomb-Rice encoding. The hashes are converted to uint32, sorted in + ascending order, then delta encoded and stored as encoded_data. + rawHashes: + items: + $ref: '#/components/schemas/GoogleCloudWebriskV1RawHashes' + type: array description: >- - The number of bytes for each prefix encoded below. This field can be - anywhere from 4 (shortest prefix) to 32 (full SHA256 hash). In - practice this is almost always 4, except in exceptional - circumstances. - format: int32 - type: integer - type: object + The raw SHA256-formatted entries. Repeated to allow returning sets + of hashes with different prefix sizes. GoogleLongrunningOperation: + description: >- + This resource represents a long-running operation that is the result of + a network API call. properties: - error: - $ref: '#/components/schemas/GoogleRpcStatus' - description: >- - The error result of the operation in case of failure or - cancellation. metadata: - type: object + description: Contains a `SubmitUriMetadata` object. additionalProperties: - type: any description: Properties of the object. Contains field @type with type URL. - description: Contains a `SubmitUriMetadata` object. - done: - type: boolean - description: >- - If the value is `false`, it means the operation is still in - progress. If `true`, the operation is completed, and either `error` - or `response` is available. + type: any + type: object name: - description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. type: string + description: Matches the `/v1/{project-name}/operations/{operation-id}` pattern. response: description: >- The normal, successful response of the operation. If the original @@ -372,35 +364,39 @@ components: where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - type: object additionalProperties: - description: Properties of the object. Contains field @type with type URL. type: any - description: >- - This resource represents a long-running operation that is the result of - a network API call. - type: object + description: Properties of the object. Contains field @type with type URL. + type: object + error: + description: >- + The error result of the operation in case of failure or + cancellation. + $ref: '#/components/schemas/GoogleRpcStatus' + done: + description: >- + If the value is `false`, it means the operation is still in + progress. If `true`, the operation is completed, and either `error` + or `response` is available. + type: boolean id: GoogleLongrunningOperation + type: object GoogleCloudWebriskV1SearchUrisResponseThreatUri: type: object + id: GoogleCloudWebriskV1SearchUrisResponseThreatUri description: Contains threat information on a matching uri. properties: - expireTime: - format: google-datetime - description: >- - The cache lifetime for the returned match. Clients must not cache - this response past this timestamp to avoid false positives. - type: string threatTypes: description: The ThreatList this threat belongs to. + type: array items: - type: string enum: - THREAT_TYPE_UNSPECIFIED - MALWARE - SOCIAL_ENGINEERING - UNWANTED_SOFTWARE - SOCIAL_ENGINEERING_EXTENDED_COVERAGE + type: string enumDescriptions: - >- No entries should match this threat type. This threat type is @@ -411,19 +407,29 @@ components: - >- A list of extended coverage social engineering URIs targeting any platform. - type: array - id: GoogleCloudWebriskV1SearchUrisResponseThreatUri + expireTime: + format: google-datetime + type: string + description: >- + The cache lifetime for the returned match. Clients must not cache + this response past this timestamp to avoid false positives. parameters: - access_token: - description: OAuth access token. + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: access_token + name: fields schema: type: string - callback: - description: JSONP + oauth_token: + description: OAuth 2.0 token for the current user. in: query - name: callback + name: oauth_token + schema: + type: string + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). + in: query + name: upload_protocol schema: type: string _.xgafv: @@ -435,12 +441,18 @@ components: enum: - '1' - '2' - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string + prettyPrint: + description: Returns response with indentations and line breaks. + in: query + name: prettyPrint + schema: + type: boolean quotaUser: description: >- Available to use for quota purposes for server-side applications. Can be @@ -450,12 +462,6 @@ components: name: quotaUser schema: type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). - in: query - name: uploadType - schema: - type: string key: description: >- API key. Your API key identifies your project and provides you with API @@ -465,43 +471,37 @@ components: name: key schema: type: string - prettyPrint: - description: Returns response with indentations and line breaks. - in: query - name: prettyPrint - schema: - type: boolean - alt: - description: Data format for response. + callback: + description: JSONP in: query - name: alt + name: callback schema: type: string - enum: - - json - - media - - proto - fields: - description: Selector specifying which fields to include in a partial response. + access_token: + description: OAuth access token. in: query - name: fields + name: access_token schema: type: string - oauth_token: - description: OAuth 2.0 token for the current user. + alt: + description: Data format for response. in: query - name: oauth_token + name: alt schema: type: string + enum: + - json + - media + - proto x-stackQL-resources: - threat_lists: - id: google.webrisk.threat_lists - name: threat_lists - title: Threat_lists + uris: + id: google.webrisk.uris + name: uris + title: Uris methods: - compute_diff: + search: operation: - $ref: '#/paths/~1v1~1threatLists:computeDiff/get' + $ref: '#/paths/~1v1~1uris:search/get' response: mediaType: application/json openAPIDocKey: '200' @@ -509,6 +509,7 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] submissions: id: google.webrisk.submissions @@ -526,36 +527,27 @@ components: insert: - $ref: '#/components/x-stackQL-resources/submissions/methods/create' update: [] + replace: [] delete: [] operations: id: google.webrisk.operations name: operations title: Operations methods: - get: + delete: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/delete response: mediaType: application/json openAPIDocKey: '200' - delete: + get: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/delete + #/paths/~1v1~1projects~1{projectsId}~1operations~1{operationsId}/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.operations - list: - operation: *ref_1 - response: *ref_2 cancel: operation: $ref: >- @@ -563,22 +555,30 @@ components: response: mediaType: application/json openAPIDocKey: '200' + list: + operation: + $ref: '#/paths/~1v1~1projects~1{projectsId}~1operations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.operations sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/operations/methods/get' - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' - uris: - id: google.webrisk.uris - name: uris - title: Uris + hashes: + id: google.webrisk.hashes + name: hashes + title: Hashes methods: search: operation: - $ref: '#/paths/~1v1~1uris:search/get' + $ref: '#/paths/~1v1~1hashes:search/get' response: mediaType: application/json openAPIDocKey: '200' @@ -586,15 +586,16 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] - hashes: - id: google.webrisk.hashes - name: hashes - title: Hashes + threat_lists: + id: google.webrisk.threat_lists + name: threat_lists + title: Threat_lists methods: - search: + compute_diff: operation: - $ref: '#/paths/~1v1~1hashes:search/get' + $ref: '#/paths/~1v1~1threatLists:computeDiff/get' response: mediaType: application/json openAPIDocKey: '200' @@ -602,30 +603,30 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: - /v1/threatLists:computeDiff: - parameters: &ref_3 - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/_.xgafv' + /v1/uris:search: + parameters: &ref_1 + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' - - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/prettyPrint' + - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/key' + - $ref: '#/components/parameters/callback' + - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - - $ref: '#/components/parameters/fields' - - $ref: '#/components/parameters/oauth_token' get: description: >- - Gets the most recent threat list diffs. These diffs should be applied to - a local database of hashes to keep it up-to-date. If the local database - is empty or excessively out-of-date, a complete snapshot of the database - will be returned. This Method only updates a single ThreatList at a - time. To update multiple ThreatList databases, this method needs to be - called once for each list. - operationId: webrisk.threatLists.computeDiff + This method is used to check whether a URI is on a given threatList. + Multiple threatLists may be searched in a single query. The response + will list all requested threatLists the URI was found to match. If the + URI is not found on any of the requested ThreatList an empty response + will be returned. + operationId: webrisk.uris.search security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -637,34 +638,18 @@ paths: content: application/json: schema: - $ref: >- - #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse + $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponse' parameters: - in: query - name: constraints.maxDiffEntries - schema: - type: integer - format: int32 - - in: query - name: constraints.maxDatabaseEntries - schema: - type: integer - format: int32 - - in: query - name: constraints.supportedCompressions - schema: - type: string - - in: query - name: versionToken + name: threatTypes schema: type: string - format: byte - in: query - name: threatType + name: uri schema: type: string /v1/projects/{projectsId}/submissions: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Creates a Submission of a URI suspected of containing phishing content @@ -700,36 +685,7 @@ paths: schema: type: string /v1/projects/{projectsId}/operations/{operationsId}: - parameters: *ref_3 - get: - description: >- - Gets the latest state of a long-running operation. Clients can use this - method to poll the operation result at intervals as recommended by the - API service. - operationId: webrisk.projects.operations.get - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform - responses: - '200': - description: Successful response - content: - application/json: - schema: - $ref: '#/components/schemas/GoogleLongrunningOperation' - parameters: - - in: path - name: projectsId - required: true - schema: - type: string - - in: path - name: operationsId - required: true - schema: - type: string + parameters: *ref_1 delete: description: >- Deletes a long-running operation. This method indicates that the client @@ -756,42 +712,37 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/operations: - parameters: *ref_3 get: description: >- - Lists operations that match the specified filter in the request. If the - server doesn't support this method, it returns `UNIMPLEMENTED`. - operationId: webrisk.projects.operations.list - security: [] + Gets the latest state of a long-running operation. Clients can use this + method to poll the operation result at intervals as recommended by the + API service. + operationId: webrisk.projects.operations.get + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' + $ref: '#/components/schemas/GoogleLongrunningOperation' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: filter - schema: - type: string - - in: query - name: pageToken + - in: path + name: operationsId + required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 /v1/projects/{projectsId}/operations/{operationsId}:cancel: - parameters: *ref_3 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -828,39 +779,42 @@ paths: required: true schema: type: string - /v1/uris:search: - parameters: *ref_3 + /v1/projects/{projectsId}/operations: + parameters: *ref_1 get: description: >- - This method is used to check whether a URI is on a given threatList. - Multiple threatLists may be searched in a single query. The response - will list all requested threatLists the URI was found to match. If the - URI is not found on any of the requested ThreatList an empty response - will be returned. - operationId: webrisk.uris.search - security: - - Oauth2: - - https://www.googleapis.com/auth/cloud-platform - Oauth2c: - - https://www.googleapis.com/auth/cloud-platform + Lists operations that match the specified filter in the request. If the + server doesn't support this method, it returns `UNIMPLEMENTED`. + operationId: webrisk.projects.operations.list + security: [] responses: '200': description: Successful response content: application/json: schema: - $ref: '#/components/schemas/GoogleCloudWebriskV1SearchUrisResponse' + $ref: '#/components/schemas/GoogleLongrunningListOperationsResponse' parameters: + - in: path + name: projectsId + required: true + schema: + type: string - in: query - name: threatTypes + name: filter schema: type: string - in: query - name: uri + name: pageToken schema: type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/hashes:search: - parameters: *ref_3 + parameters: *ref_1 get: description: >- Gets the full hashes that match the requested hash prefix. This is used @@ -882,12 +836,60 @@ paths: schema: $ref: '#/components/schemas/GoogleCloudWebriskV1SearchHashesResponse' parameters: + - in: query + name: threatTypes + schema: + type: string - in: query name: hashPrefix schema: type: string format: byte + /v1/threatLists:computeDiff: + parameters: *ref_1 + get: + description: >- + Gets the most recent threat list diffs. These diffs should be applied to + a local database of hashes to keep it up-to-date. If the local database + is empty or excessively out-of-date, a complete snapshot of the database + will be returned. This Method only updates a single ThreatList at a + time. To update multiple ThreatList databases, this method needs to be + called once for each list. + operationId: webrisk.threatLists.computeDiff + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: >- + #/components/schemas/GoogleCloudWebriskV1ComputeThreatListDiffResponse + parameters: - in: query - name: threatTypes + name: constraints.supportedCompressions + schema: + type: string + - in: query + name: threatType + schema: + type: string + - in: query + name: constraints.maxDiffEntries + schema: + type: integer + format: int32 + - in: query + name: versionToken schema: type: string + format: byte + - in: query + name: constraints.maxDatabaseEntries + schema: + type: integer + format: int32 diff --git a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml index e5b8ff87..a1a6e169 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/websecurityscanner.yaml @@ -7,8 +7,8 @@ info: title: Web Security Scanner API description: Scans your Compute and App Engine apps for common web vulnerabilities. version: v1 - x-discovery-doc-revision: '20240526' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240901' + x-generated-date: '2024-09-13' externalDocs: url: >- https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/ @@ -35,380 +35,613 @@ components: tokenUrl: https://accounts.google.com/o/oauth2/token scopes: *ref_0 schemas: - StartScanRunRequest: - properties: {} + Finding: + properties: + findingType: + type: string + description: >- + Output only. The type of the Finding. Detailed and up-to-date + information on findings can be found here: + https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings + vulnerableParameters: + $ref: '#/components/schemas/VulnerableParameters' + description: >- + Output only. An addon containing information about request + parameters which were found to be vulnerable. + violatingResource: + description: >- + Output only. An addon containing detailed information regarding any + resource causing the vulnerability such as JavaScript sources, + image, audio files, etc. + $ref: '#/components/schemas/ViolatingResource' + fuzzedUrl: + description: >- + Output only. The URL produced by the server-side fuzzer and used in + the request that triggered the vulnerability. + type: string + vulnerableHeaders: + $ref: '#/components/schemas/VulnerableHeaders' + description: >- + Output only. An addon containing information about vulnerable or + missing HTTP headers. + trackingId: + description: >- + Output only. The tracking ID uniquely identifies a vulnerability + instance across multiple ScanRuns. + type: string + httpMethod: + description: >- + Output only. The http method of the request that triggered the + vulnerability, in uppercase. + type: string + xxe: + readOnly: true + $ref: '#/components/schemas/Xxe' + description: >- + Output only. An addon containing information reported for an XXE, if + any. + outdatedLibrary: + description: >- + Output only. An addon containing information about outdated + libraries. + $ref: '#/components/schemas/OutdatedLibrary' + body: + type: string + description: >- + Output only. The body of the request that triggered the + vulnerability. + severity: + enum: + - SEVERITY_UNSPECIFIED + - CRITICAL + - HIGH + - MEDIUM + - LOW + description: Output only. The severity level of the reported vulnerability. + type: string + readOnly: true + enumDescriptions: + - No severity specified. The default value. + - Critical severity. + - High severity. + - Medium severity. + - Low severity. + name: + description: >- + Output only. The resource name of the Finding. The name follows the + format of + 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. + The finding IDs are generated by the system. + type: string + form: + description: >- + Output only. An addon containing information reported for a + vulnerability with an HTML form, if any. + $ref: '#/components/schemas/Form' + description: + type: string + description: Output only. The description of the vulnerability. + frameUrl: + description: >- + Output only. If the vulnerability was originated from nested IFrame, + the immediate parent IFrame is reported. + type: string + reproductionUrl: + description: >- + Output only. The URL containing human-readable payload that user can + leverage to reproduce the vulnerability. + type: string + finalUrl: + type: string + description: >- + Output only. The URL where the browser lands when the vulnerability + is detected. + xss: + description: >- + Output only. An addon containing information reported for an XSS, if + any. + $ref: '#/components/schemas/Xss' + id: Finding type: object - description: Request for the `StartScanRun` method. - id: StartScanRunRequest - OutdatedLibrary: + description: >- + A Finding resource represents a vulnerability instance identified during + a ScanRun. + ListFindingsResponse: properties: - libraryName: - description: The name of the outdated library. + nextPageToken: type: string - learnMoreUrls: - items: - type: string description: >- - URLs to learn more information about the vulnerabilities in the - library. + Token to retrieve the next page of results, or empty if there are no + more results in the list. + findings: type: array - version: - type: string - description: The version number. - id: OutdatedLibrary - description: Information reported for an outdated library. + description: The list of Findings returned. + items: + $ref: '#/components/schemas/Finding' + type: object + id: ListFindingsResponse + description: Response for the `ListFindings` method. + ScanRun: type: object - CustomAccount: properties: - loginUrl: + startTime: type: string - description: Required. The login form URL of the website. - username: - description: Required. The user name of the custom account. + format: google-datetime + description: Output only. The time at which the ScanRun started. + warningTraces: + description: >- + Output only. A list of warnings, if such are encountered during this + scan run. + items: + $ref: '#/components/schemas/ScanRunWarningTrace' + type: array + progressPercent: + type: integer + format: int32 + description: >- + Output only. The percentage of total completion ranging from 0 to + 100. If the scan is in queue, the value is 0. If the scan is + running, the value ranges from 0 to 100. If the scan is finished, + the value is 100. + endTime: + description: >- + Output only. The time at which the ScanRun reached termination state + - that the ScanRun is either finished or stopped by user. + format: google-datetime type: string - password: + errorTrace: + description: >- + Output only. If result_state is an ERROR, this field provides the + primary reason for scan's termination and more details, if such are + available. + $ref: '#/components/schemas/ScanRunErrorTrace' + name: type: string description: >- - Required. Input only. The password of the custom account. The - credential is stored encrypted and not returned in any response nor - included in audit logs. - id: CustomAccount - description: Describes authentication configuration that uses a custom account. - type: object - CrawledUrl: - properties: - body: - description: Output only. The body of the request that was used to visit the URL. + Output only. The resource name of the ScanRun. The name follows the + format of + 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. + The ScanRun IDs are generated by the system. + urlsTestedCount: type: string - url: - description: Output only. The URL that was crawled. + description: >- + Output only. The number of URLs tested during this ScanRun. If the + scan is in progress, the value represents the number of URLs tested + up to now. The number of URLs tested is usually larger than the + number URLS crawled because typically a crawled URL is tested with + multiple test payloads. + format: int64 + resultState: + enum: + - RESULT_STATE_UNSPECIFIED + - SUCCESS + - ERROR + - KILLED type: string - httpMethod: + description: >- + Output only. The result state of the ScanRun. This field is only + available after the execution state reaches "FINISHED". + enumDescriptions: + - >- + Default value. This value is returned when the ScanRun is not yet + finished. + - The scan finished without errors. + - The scan finished with errors. + - The scan was terminated by user. + urlsCrawledCount: type: string + format: int64 description: >- - Output only. The http method of the request that was used to visit - the URL, in uppercase. - id: CrawledUrl - type: object + Output only. The number of URLs crawled during this ScanRun. If the + scan is in progress, the value represents the number of URLs crawled + up to now. + hasVulnerabilities: + description: Output only. Whether the scan run has found any vulnerabilities. + type: boolean + executionState: + description: Output only. The execution state of the ScanRun. + enumDescriptions: + - >- + Represents an invalid state caused by internal server error. This + value should never be returned. + - The scan is waiting in the queue. + - The scan is in progress. + - The scan is either finished or stopped by user. + enum: + - EXECUTION_STATE_UNSPECIFIED + - QUEUED + - SCANNING + - FINISHED + type: string description: >- - A CrawledUrl resource represents a URL that was crawled during a - ScanRun. Web Security Scanner Service crawls the web applications, - following all links within the scope of sites, to find the URLs to test - against. + A ScanRun is a output-only resource representing an actual run of the + scan. Next id: 12 + id: ScanRun + Authentication: + id: Authentication + properties: + customAccount: + $ref: '#/components/schemas/CustomAccount' + description: Authentication using a custom account. + googleAccount: + $ref: '#/components/schemas/GoogleAccount' + deprecated: true + description: Authentication using a Google account. + iapCredential: + description: Authentication using Identity-Aware-Proxy (IAP). + $ref: '#/components/schemas/IapCredential' + description: Scan authentication configuration. + type: object ScanConfig: + type: object + description: A ScanConfig resource contains the configurations to launch a scan. + id: ScanConfig properties: - ignoreHttpStatusErrors: - description: >- - Whether to keep scanning even if most requests return HTTP error - codes. + staticIpScan: type: boolean - blacklistPatterns: - items: - type: string description: >- - The excluded URL patterns as described in - https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls - type: array + Whether the scan configuration has enabled static IP address scan + feature. If enabled, the scanner will access applications from + static IP addresses. + displayName: + type: string + description: Required. The user provided display name of the ScanConfig. + userAgent: + type: string + description: The user agent used during scanning. + enumDescriptions: + - The user agent is unknown. Service will default to CHROME_LINUX. + - Chrome on Linux. This is the service default if unspecified. + - Chrome on Android. + - Safari on IPhone. + enum: + - USER_AGENT_UNSPECIFIED + - CHROME_LINUX + - CHROME_ANDROID + - SAFARI_IPHONE riskLevel: enumDescriptions: - Use default, which is NORMAL. - Normal scanning (Recommended) - Lower impact scanning - description: The risk level selected for the scan + type: string enum: - RISK_LEVEL_UNSPECIFIED - NORMAL - LOW - type: string - maxQps: - description: >- - The maximum QPS during scanning. A valid value ranges from 5 to 20 - inclusively. If the field is unspecified or its value is set 0, - server will default to 15. Other values outside of [5, 20] range - will be rejected with INVALID_ARGUMENT error. - format: int32 - type: integer - name: - type: string + description: The risk level selected for the scan + blacklistPatterns: description: >- - The resource name of the ScanConfig. The name follows the format of - 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig - IDs are generated by the system. - displayName: - description: Required. The user provided display name of the ScanConfig. + The excluded URL patterns as described in + https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls + type: array + items: + type: string + exportToSecurityCommandCenter: type: string - authentication: description: >- - The authentication configuration. If specified, service will use the - authentication configuration during scanning. - $ref: '#/components/schemas/Authentication' + Controls export of scan configurations and results to Security + Command Center. + enum: + - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED + - ENABLED + - DISABLED + enumDescriptions: + - Use default, which is ENABLED. + - Export results of this scan to Security Command Center. + - Do not export results of this scan to Security Command Center. schedule: description: The schedule of the ScanConfig. $ref: '#/components/schemas/Schedule' startingUrls: - type: array + description: Required. The starting URLs from which the scanner finds site pages. items: type: string - description: Required. The starting URLs from which the scanner finds site pages. - staticIpScan: + type: array + maxQps: + format: int32 + type: integer description: >- - Whether the scan configuration has enabled static IP address scan - feature. If enabled, the scanner will access applications from - static IP addresses. - type: boolean + The maximum QPS during scanning. A valid value ranges from 5 to 20 + inclusively. If the field is unspecified or its value is set 0, + server will default to 15. Other values outside of [5, 20] range + will be rejected with INVALID_ARGUMENT error. managedScan: type: boolean description: >- - Whether the scan config is managed by Web Security Scanner, output - only. - exportToSecurityCommandCenter: - description: >- - Controls export of scan configurations and results to Security - Command Center. - type: string - enum: - - EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED - - ENABLED - - DISABLED - enumDescriptions: - - Use default, which is ENABLED. - - Export results of this scan to Security Command Center. - - Do not export results of this scan to Security Command Center. - userAgent: - description: The user agent used during scanning. - enumDescriptions: - - The user agent is unknown. Service will default to CHROME_LINUX. - - Chrome on Linux. This is the service default if unspecified. - - Chrome on Android. - - Safari on IPhone. - enum: - - USER_AGENT_UNSPECIFIED - - CHROME_LINUX - - CHROME_ANDROID - - SAFARI_IPHONE + Whether the scan config is managed by Web Security Scanner, output + only. + ignoreHttpStatusErrors: + description: >- + Whether to keep scanning even if most requests return HTTP error + codes. + type: boolean + name: + description: >- + The resource name of the ScanConfig. The name follows the format of + 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig + IDs are generated by the system. type: string + authentication: + description: >- + The authentication configuration. If specified, service will use the + authentication configuration during scanning. + $ref: '#/components/schemas/Authentication' + IapCredential: + description: Describes authentication configuration for Identity-Aware-Proxy (IAP). + id: IapCredential type: object - id: ScanConfig - description: A ScanConfig resource contains the configurations to launch a scan. - ListFindingTypeStatsResponse: - description: Response for the `ListFindingTypeStats` method. - id: ListFindingTypeStatsResponse properties: - findingTypeStats: - type: array - description: The list of FindingTypeStats returned. - items: - $ref: '#/components/schemas/FindingTypeStats' - type: object + iapTestServiceAccountInfo: + $ref: '#/components/schemas/IapTestServiceAccountInfo' + description: >- + Authentication configuration when Web-Security-Scanner service + account is added in Identity-Aware-Proxy (IAP) access policies. IapTestServiceAccountInfo: description: >- Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies. + id: IapTestServiceAccountInfo type: object properties: targetAudienceClientId: - type: string description: >- Required. Describes OAuth2 client id of resources protected by Identity-Aware-Proxy (IAP). - id: IapTestServiceAccountInfo - IapCredential: - id: IapCredential - description: Describes authentication configuration for Identity-Aware-Proxy (IAP). - type: object - properties: - iapTestServiceAccountInfo: - description: >- - Authentication configuration when Web-Security-Scanner service - account is added in Identity-Aware-Proxy (IAP) access policies. - $ref: '#/components/schemas/IapTestServiceAccountInfo' - Header: - id: Header - properties: - name: type: string - description: Header name. - value: - description: Header value. - type: string - description: Describes a HTTP Header. - type: object - Authentication: - properties: - customAccount: - description: Authentication using a custom account. - $ref: '#/components/schemas/CustomAccount' - iapCredential: - description: Authentication using Identity-Aware-Proxy (IAP). - $ref: '#/components/schemas/IapCredential' - googleAccount: - description: Authentication using a Google account. - deprecated: true - $ref: '#/components/schemas/GoogleAccount' - description: Scan authentication configuration. - id: Authentication - type: object - VulnerableHeaders: - id: VulnerableHeaders - description: Information about vulnerable or missing HTTP Headers. + StopScanRunRequest: + id: StopScanRunRequest type: object + description: Request for the `StopScanRun` method. + properties: {} + GoogleAccount: properties: - missingHeaders: - items: - $ref: '#/components/schemas/Header' - description: List of missing headers. - type: array - headers: - description: List of vulnerable headers. - items: - $ref: '#/components/schemas/Header' - type: array - ListScanConfigsResponse: - properties: - scanConfigs: - type: array - items: - $ref: '#/components/schemas/ScanConfig' - description: The list of ScanConfigs returned. - nextPageToken: + password: + type: string description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. + Required. Input only. The password of the Google account. The + credential is stored encrypted and not returned in any response nor + included in audit logs. + username: type: string - id: ListScanConfigsResponse - description: Response for the `ListScanConfigs` method. + description: Required. The user name of the Google account. + description: Describes authentication configuration that uses a Google account. + id: GoogleAccount + deprecated: true type: object - ListScanRunsResponse: - id: ListScanRunsResponse + ScanRunErrorTrace: type: object - description: Response for the `ListScanRuns` method. properties: - nextPageToken: + scanConfigError: + $ref: '#/components/schemas/ScanConfigError' description: >- - Token to retrieve the next page of results, or empty if there are no - more results in the list. - type: string - scanRuns: - type: array - description: The list of ScanRuns returned. - items: - $ref: '#/components/schemas/ScanRun' - Xxe: - id: Xxe - type: object - properties: - payloadLocation: + Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this + field has the error message encountered during scan configuration + validation that is performed before each scan run. + code: + description: Output only. Indicates the error reason code. enum: - - LOCATION_UNSPECIFIED - - COMPLETE_REQUEST_BODY - description: Location within the request where the payload was placed. + - CODE_UNSPECIFIED + - INTERNAL_ERROR + - SCAN_CONFIG_ISSUE + - AUTHENTICATION_CONFIG_ISSUE + - TIMED_OUT_WHILE_SCANNING + - TOO_MANY_REDIRECTS + - TOO_MANY_HTTP_ERRORS + - STARTING_URLS_CRAWL_HTTP_ERRORS type: string enumDescriptions: - - Unknown Location. - - The XML payload replaced the complete request body. - payloadValue: + - Default value is never used. + - >- + Indicates that the scan run failed due to an internal server + error. + - >- + Indicates a scan configuration error, usually due to outdated + ScanConfig settings, such as starting_urls or the DNS + configuration. + - >- + Indicates an authentication error, usually due to outdated + ScanConfig authentication settings. + - >- + Indicates a scan operation timeout, usually caused by a very large + site. + - >- + Indicates that a scan encountered excessive redirects, either to + authentication or some other page outside of the scan scope. + - >- + Indicates that a scan encountered numerous errors from the web + site pages. When available, most_common_http_error_code field + indicates the most common HTTP error code encountered during the + scan. + - >- + Indicates that some of the starting web urls returned HTTP errors + during the scan. + mostCommonHttpErrorCode: + format: int32 + type: integer description: >- - The XML string that triggered the XXE vulnerability. Non-payload - values might be redacted. - type: string - description: Information reported for an XXE. - Empty: - description: >- - A generic empty message that you can re-use to avoid defining duplicated - empty messages in your APIs. A typical example is to use it as the - request or the response type of an API method. For instance: service Foo - { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } - id: Empty - properties: {} + Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field + indicates the most common HTTP error code, if such is available. For + example, if this code is 404, the scan has encountered too many + NOT_FOUND responses. + description: Output only. Defines an error trace message for a ScanRun. + id: ScanRunErrorTrace + ViolatingResource: type: object - FindingTypeStats: + properties: + contentType: + description: The MIME type of this resource. + type: string + resourceUrl: + type: string + description: URL of this violating resource. + id: ViolatingResource description: >- - A FindingTypeStats resource represents stats regarding a specific - FindingType of Findings under a given ScanRun. - id: FindingTypeStats + Information regarding any resource causing the vulnerability such as + JavaScript sources, image, audio files, etc. + CrawledUrl: type: object properties: - findingType: + url: + description: Output only. The URL that was crawled. type: string - description: Output only. The finding type associated with the stats. - findingCount: - format: int32 - type: integer - description: Output only. The count of findings belonging to this finding type. + body: + description: Output only. The body of the request that was used to visit the URL. + type: string + httpMethod: + description: >- + Output only. The http method of the request that was used to visit + the URL, in uppercase. + type: string + description: >- + A CrawledUrl resource represents a URL that was crawled during a + ScanRun. Web Security Scanner Service crawls the web applications, + following all links within the scope of sites, to find the URLs to test + against. + id: CrawledUrl Schedule: - id: Schedule - description: Scan schedule configuration. type: object properties: - intervalDurationDays: - type: integer - description: Required. The duration of time between executions in days. - format: int32 scheduleTime: - type: string format: google-datetime description: >- A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately. - ListCrawledUrlsResponse: + type: string + intervalDurationDays: + format: int32 + type: integer + description: Required. The duration of time between executions in days. + id: Schedule + description: Scan schedule configuration. + StartScanRunRequest: type: object + id: StartScanRunRequest + description: Request for the `StartScanRun` method. + properties: {} + ListScanRunsResponse: + id: ListScanRunsResponse + type: object + description: Response for the `ListScanRuns` method. properties: + scanRuns: + type: array + description: The list of ScanRuns returned. + items: + $ref: '#/components/schemas/ScanRun' nextPageToken: description: >- Token to retrieve the next page of results, or empty if there are no more results in the list. type: string - crawledUrls: - description: The list of CrawledUrls returned. + ListScanConfigsResponse: + description: Response for the `ListScanConfigs` method. + properties: + scanConfigs: + description: The list of ScanConfigs returned. items: - $ref: '#/components/schemas/CrawledUrl' + $ref: '#/components/schemas/ScanConfig' type: array - description: Response for the `ListCrawledUrls` method. - id: ListCrawledUrlsResponse - ViolatingResource: - properties: - contentType: - type: string - description: The MIME type of this resource. - resourceUrl: + nextPageToken: type: string - description: URL of this violating resource. - id: ViolatingResource - description: >- - Information regarding any resource causing the vulnerability such as - JavaScript sources, image, audio files, etc. + description: >- + Token to retrieve the next page of results, or empty if there are no + more results in the list. + id: ListScanConfigsResponse type: object - VulnerableParameters: + ScanRunWarningTrace: + type: object + id: ScanRunWarningTrace + description: >- + Output only. Defines a warning trace message for ScanRun. Warning traces + provide customers with useful information that helps make the scanning + process more effective. properties: - parameterNames: + code: + enumDescriptions: + - Default value is never used. + - >- + Indicates that a scan discovered an unexpectedly low number of + URLs. This is sometimes caused by complex navigation features or + by using a single URL for numerous pages. + - >- + Indicates that a scan discovered too many URLs to test, or + excessive redundant URLs. + - >- + Indicates that too many tests have been generated for the scan. + Customer should try reducing the number of starting URLs, + increasing the QPS rate, or narrowing down the scope of the scan + using the excluded patterns. + - Indicates that a scan is blocked by IAP. + - Indicates that no seeds is found for a scan + description: Output only. Indicates the warning code. + type: string + enum: + - CODE_UNSPECIFIED + - INSUFFICIENT_CRAWL_RESULTS + - TOO_MANY_CRAWL_RESULTS + - TOO_MANY_FUZZ_TASKS + - BLOCKED_BY_IAP + - NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN + OutdatedLibrary: + id: OutdatedLibrary + properties: + libraryName: + description: The name of the outdated library. + type: string + version: + type: string + description: The version number. + learnMoreUrls: items: type: string + description: >- + URLs to learn more information about the vulnerabilities in the + library. type: array - description: The vulnerable parameter names. type: object - id: VulnerableParameters + description: Information reported for an outdated library. + VulnerableParameters: description: Information about vulnerable request parameters. - Form: type: object - description: '! Information about a vulnerability with an HTML.' - id: Form + id: VulnerableParameters properties: - fields: + parameterNames: + type: array items: type: string - type: array - description: '! The names of form fields related to the vulnerability.' - actionUri: - description: '! The URI where to send the form when it''s submitted.' - type: string + description: The vulnerable parameter names. Xss: - description: Information reported for an XSS. id: Xss type: object properties: + storedXssSeedingUrl: + description: The reproduction url for the seeding POST request of a Stored XSS. + type: string + errorMessage: + type: string + description: An error message generated by a javascript breakage. attackVector: + enum: + - ATTACK_VECTOR_UNSPECIFIED + - LOCAL_STORAGE + - SESSION_STORAGE + - WINDOW_NAME + - REFERRER + - FORM_INPUT + - COOKIE + - POST_MESSAGE + - GET_PARAMETERS + - URL_FRAGMENT + - HTML_COMMENT + - POST_PARAMETERS + - PROTOCOL + - STORED_XSS + - SAME_ORIGIN + - USER_CONTROLLABLE_URL + description: The attack vector of the payload triggering this XSS. enumDescriptions: - Unknown attack vector. - The attack comes from fuzzing the browser's localStorage. @@ -431,86 +664,98 @@ components: The attack payload is received from a third-party host via a URL that is user-controllable type: string - description: The attack vector of the payload triggering this XSS. - enum: - - ATTACK_VECTOR_UNSPECIFIED - - LOCAL_STORAGE - - SESSION_STORAGE - - WINDOW_NAME - - REFERRER - - FORM_INPUT - - COOKIE - - POST_MESSAGE - - GET_PARAMETERS - - URL_FRAGMENT - - HTML_COMMENT - - POST_PARAMETERS - - PROTOCOL - - STORED_XSS - - SAME_ORIGIN - - USER_CONTROLLABLE_URL stackTraces: items: type: string description: Stack traces leading to the point where the XSS occurred. type: array - storedXssSeedingUrl: + description: Information reported for an XSS. + Empty: + properties: {} + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + CustomAccount: + properties: + username: type: string - description: The reproduction url for the seeding POST request of a Stored XSS. - errorMessage: - description: An error message generated by a javascript breakage. + description: Required. The user name of the custom account. + password: + type: string + description: >- + Required. Input only. The password of the custom account. The + credential is stored encrypted and not returned in any response nor + included in audit logs. + loginUrl: + description: Required. The login form URL of the website. type: string - ListFindingsResponse: - id: ListFindingsResponse - description: Response for the `ListFindings` method. + type: object + id: CustomAccount + description: Describes authentication configuration that uses a custom account. + ListCrawledUrlsResponse: type: object properties: - findings: - description: The list of Findings returned. + crawledUrls: + description: The list of CrawledUrls returned. type: array items: - $ref: '#/components/schemas/Finding' + $ref: '#/components/schemas/CrawledUrl' nextPageToken: + type: string description: >- Token to retrieve the next page of results, or empty if there are no more results in the list. - type: string - ScanRunWarningTrace: + description: Response for the `ListCrawledUrls` method. + id: ListCrawledUrlsResponse + FindingTypeStats: type: object - id: ScanRunWarningTrace - description: >- - Output only. Defines a warning trace message for ScanRun. Warning traces - provide customers with useful information that helps make the scanning - process more effective. + id: FindingTypeStats properties: - code: - enumDescriptions: - - Default value is never used. - - >- - Indicates that a scan discovered an unexpectedly low number of - URLs. This is sometimes caused by complex navigation features or - by using a single URL for numerous pages. - - >- - Indicates that a scan discovered too many URLs to test, or - excessive redundant URLs. - - >- - Indicates that too many tests have been generated for the scan. - Customer should try reducing the number of starting URLs, - increasing the QPS rate, or narrowing down the scope of the scan - using the excluded patterns. - - Indicates that a scan is blocked by IAP. - - Indicates that no seeds is found for a scan - description: Output only. Indicates the warning code. + findingCount: + format: int32 + description: Output only. The count of findings belonging to this finding type. + type: integer + findingType: + description: Output only. The finding type associated with the stats. type: string - enum: - - CODE_UNSPECIFIED - - INSUFFICIENT_CRAWL_RESULTS - - TOO_MANY_CRAWL_RESULTS - - TOO_MANY_FUZZ_TASKS - - BLOCKED_BY_IAP - - NO_STARTING_URL_FOUND_FOR_MANAGED_SCAN + description: >- + A FindingTypeStats resource represents stats regarding a specific + FindingType of Findings under a given ScanRun. + VulnerableHeaders: + description: Information about vulnerable or missing HTTP Headers. + type: object + id: VulnerableHeaders + properties: + missingHeaders: + type: array + description: List of missing headers. + items: + $ref: '#/components/schemas/Header' + headers: + items: + $ref: '#/components/schemas/Header' + type: array + description: List of vulnerable headers. ScanConfigError: + description: >- + Defines a custom error message used by CreateScanConfig and + UpdateScanConfig APIs when scan configuration validation fails. It is + also reported as part of a ScanRunErrorTrace message if scan validation + fails due to a scan configuration error. + id: ScanConfigError + type: object properties: + fieldName: + description: >- + Output only. Indicates the full name of the ScanConfig field that + triggers this error, for example "scan_config.max_qps". This field + is provided for troubleshooting purposes only and its actual value + can change in the future. + type: string code: enumDescriptions: - There is no error. @@ -577,408 +822,147 @@ components: reserved for the current project. - One of the seed URLs has on-routable IP address. - >- - One of the seed URLs has an IP address that is not reserved for - the current project. - - >- - The Web Security Scanner service account is not configured under - the project. - - A project has reached the maximum number of scans. - - Resolving the details of the current project fails. - - One or more blacklist patterns were in the wrong format. - - The supplied filter is not supported. - - >- - The supplied finding type is not supported. For example, we do not - provide findings of the given finding type. - - >- - The URL scheme of one or more of the supplied URLs is not - supported. - - CAI is not able to list assets. - description: Output only. Indicates the reason code for a configuration failure. - type: string - enum: - - CODE_UNSPECIFIED - - OK - - INTERNAL_ERROR - - APPENGINE_API_BACKEND_ERROR - - APPENGINE_API_NOT_ACCESSIBLE - - APPENGINE_DEFAULT_HOST_MISSING - - CANNOT_USE_GOOGLE_COM_ACCOUNT - - CANNOT_USE_OWNER_ACCOUNT - - COMPUTE_API_BACKEND_ERROR - - COMPUTE_API_NOT_ACCESSIBLE - - CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT - - CUSTOM_LOGIN_URL_MALFORMED - - CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS - - CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS - - CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS - - CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS - - DUPLICATE_SCAN_NAME - - INVALID_FIELD_VALUE - - FAILED_TO_AUTHENTICATE_TO_TARGET - - FINDING_TYPE_UNSPECIFIED - - FORBIDDEN_TO_SCAN_COMPUTE - - FORBIDDEN_UPDATE_TO_MANAGED_SCAN - - MALFORMED_FILTER - - MALFORMED_RESOURCE_NAME - - PROJECT_INACTIVE - - REQUIRED_FIELD - - RESOURCE_NAME_INCONSISTENT - - SCAN_ALREADY_RUNNING - - SCAN_NOT_RUNNING - - SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT - - SEED_URL_MALFORMED - - SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS - - SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS - - SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS - - SEED_URL_HAS_UNRESERVED_IP_ADDRESS - - SERVICE_ACCOUNT_NOT_CONFIGURED - - TOO_MANY_SCANS - - UNABLE_TO_RESOLVE_PROJECT_INFO - - UNSUPPORTED_BLACKLIST_PATTERN_FORMAT - - UNSUPPORTED_FILTER - - UNSUPPORTED_FINDING_TYPE - - UNSUPPORTED_URL_SCHEME - - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND - fieldName: - description: >- - Output only. Indicates the full name of the ScanConfig field that - triggers this error, for example "scan_config.max_qps". This field - is provided for troubleshooting purposes only and its actual value - can change in the future. - type: string - id: ScanConfigError - type: object - description: >- - Defines a custom error message used by CreateScanConfig and - UpdateScanConfig APIs when scan configuration validation fails. It is - also reported as part of a ScanRunErrorTrace message if scan validation - fails due to a scan configuration error. - Finding: - type: object - description: >- - A Finding resource represents a vulnerability instance identified during - a ScanRun. - id: Finding - properties: - outdatedLibrary: - $ref: '#/components/schemas/OutdatedLibrary' - description: >- - Output only. An addon containing information about outdated - libraries. - frameUrl: - description: >- - Output only. If the vulnerability was originated from nested IFrame, - the immediate parent IFrame is reported. - type: string - trackingId: - description: >- - Output only. The tracking ID uniquely identifies a vulnerability - instance across multiple ScanRuns. - type: string - fuzzedUrl: - type: string - description: >- - Output only. The URL produced by the server-side fuzzer and used in - the request that triggered the vulnerability. - form: - description: >- - Output only. An addon containing information reported for a - vulnerability with an HTML form, if any. - $ref: '#/components/schemas/Form' - body: - description: >- - Output only. The body of the request that triggered the - vulnerability. - type: string - description: - description: Output only. The description of the vulnerability. - type: string - httpMethod: - type: string - description: >- - Output only. The http method of the request that triggered the - vulnerability, in uppercase. - xxe: - description: >- - Output only. An addon containing information reported for an XXE, if - any. - $ref: '#/components/schemas/Xxe' - readOnly: true - vulnerableHeaders: - $ref: '#/components/schemas/VulnerableHeaders' - description: >- - Output only. An addon containing information about vulnerable or - missing HTTP headers. - findingType: - type: string - description: >- - Output only. The type of the Finding. Detailed and up-to-date - information on findings can be found here: - https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings - severity: - enumDescriptions: - - No severity specified. The default value. - - Critical severity. - - High severity. - - Medium severity. - - Low severity. - type: string - readOnly: true - enum: - - SEVERITY_UNSPECIFIED - - CRITICAL - - HIGH - - MEDIUM - - LOW - description: Output only. The severity level of the reported vulnerability. - xss: - $ref: '#/components/schemas/Xss' - description: >- - Output only. An addon containing information reported for an XSS, if - any. - vulnerableParameters: - $ref: '#/components/schemas/VulnerableParameters' - description: >- - Output only. An addon containing information about request - parameters which were found to be vulnerable. - reproductionUrl: - type: string - description: >- - Output only. The URL containing human-readable payload that user can - leverage to reproduce the vulnerability. - name: - description: >- - Output only. The resource name of the Finding. The name follows the - format of - 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. - The finding IDs are generated by the system. - type: string - finalUrl: - description: >- - Output only. The URL where the browser lands when the vulnerability - is detected. - type: string - violatingResource: - $ref: '#/components/schemas/ViolatingResource' - description: >- - Output only. An addon containing detailed information regarding any - resource causing the vulnerability such as JavaScript sources, - image, audio files, etc. - GoogleAccount: - id: GoogleAccount - description: Describes authentication configuration that uses a Google account. - type: object - properties: - password: - type: string - description: >- - Required. Input only. The password of the Google account. The - credential is stored encrypted and not returned in any response nor - included in audit logs. - username: - description: Required. The user name of the Google account. - type: string - deprecated: true - ScanRunErrorTrace: - description: Output only. Defines an error trace message for a ScanRun. - type: object - id: ScanRunErrorTrace - properties: - mostCommonHttpErrorCode: - type: integer - description: >- - Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field - indicates the most common HTTP error code, if such is available. For - example, if this code is 404, the scan has encountered too many - NOT_FOUND responses. - format: int32 - scanConfigError: - description: >- - Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this - field has the error message encountered during scan configuration - validation that is performed before each scan run. - $ref: '#/components/schemas/ScanConfigError' - code: - enumDescriptions: - - Default value is never used. - - >- - Indicates that the scan run failed due to an internal server - error. - - >- - Indicates a scan configuration error, usually due to outdated - ScanConfig settings, such as starting_urls or the DNS - configuration. - - >- - Indicates an authentication error, usually due to outdated - ScanConfig authentication settings. - - >- - Indicates a scan operation timeout, usually caused by a very large - site. + One of the seed URLs has an IP address that is not reserved for + the current project. - >- - Indicates that a scan encountered excessive redirects, either to - authentication or some other page outside of the scan scope. + The Web Security Scanner service account is not configured under + the project. + - A project has reached the maximum number of scans. + - Resolving the details of the current project fails. + - One or more blacklist patterns were in the wrong format. + - The supplied filter is not supported. - >- - Indicates that a scan encountered numerous errors from the web - site pages. When available, most_common_http_error_code field - indicates the most common HTTP error code encountered during the - scan. + The supplied finding type is not supported. For example, we do not + provide findings of the given finding type. - >- - Indicates that some of the starting web urls returned HTTP errors - during the scan. - type: string + The URL scheme of one or more of the supplied URLs is not + supported. + - CAI is not able to list assets. enum: - CODE_UNSPECIFIED + - OK - INTERNAL_ERROR - - SCAN_CONFIG_ISSUE - - AUTHENTICATION_CONFIG_ISSUE - - TIMED_OUT_WHILE_SCANNING - - TOO_MANY_REDIRECTS - - TOO_MANY_HTTP_ERRORS - - STARTING_URLS_CRAWL_HTTP_ERRORS - description: Output only. Indicates the error reason code. - ScanRun: - id: ScanRun - type: object - description: >- - A ScanRun is a output-only resource representing an actual run of the - scan. Next id: 12 + - APPENGINE_API_BACKEND_ERROR + - APPENGINE_API_NOT_ACCESSIBLE + - APPENGINE_DEFAULT_HOST_MISSING + - CANNOT_USE_GOOGLE_COM_ACCOUNT + - CANNOT_USE_OWNER_ACCOUNT + - COMPUTE_API_BACKEND_ERROR + - COMPUTE_API_NOT_ACCESSIBLE + - CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT + - CUSTOM_LOGIN_URL_MALFORMED + - CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS + - CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS + - CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS + - CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS + - DUPLICATE_SCAN_NAME + - INVALID_FIELD_VALUE + - FAILED_TO_AUTHENTICATE_TO_TARGET + - FINDING_TYPE_UNSPECIFIED + - FORBIDDEN_TO_SCAN_COMPUTE + - FORBIDDEN_UPDATE_TO_MANAGED_SCAN + - MALFORMED_FILTER + - MALFORMED_RESOURCE_NAME + - PROJECT_INACTIVE + - REQUIRED_FIELD + - RESOURCE_NAME_INCONSISTENT + - SCAN_ALREADY_RUNNING + - SCAN_NOT_RUNNING + - SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT + - SEED_URL_MALFORMED + - SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS + - SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS + - SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS + - SEED_URL_HAS_UNRESERVED_IP_ADDRESS + - SERVICE_ACCOUNT_NOT_CONFIGURED + - TOO_MANY_SCANS + - UNABLE_TO_RESOLVE_PROJECT_INFO + - UNSUPPORTED_BLACKLIST_PATTERN_FORMAT + - UNSUPPORTED_FILTER + - UNSUPPORTED_FINDING_TYPE + - UNSUPPORTED_URL_SCHEME + - CLOUD_ASSET_INVENTORY_ASSET_NOT_FOUND + type: string + description: Output only. Indicates the reason code for a configuration failure. + Form: properties: - progressPercent: - description: >- - Output only. The percentage of total completion ranging from 0 to - 100. If the scan is in queue, the value is 0. If the scan is - running, the value ranges from 0 to 100. If the scan is finished, - the value is 100. - format: int32 - type: integer - urlsTestedCount: + fields: + type: array + description: '! The names of form fields related to the vulnerability.' + items: + type: string + actionUri: + description: '! The URI where to send the form when it''s submitted.' type: string - description: >- - Output only. The number of URLs tested during this ScanRun. If the - scan is in progress, the value represents the number of URLs tested - up to now. The number of URLs tested is usually larger than the - number URLS crawled because typically a crawled URL is tested with - multiple test payloads. - format: int64 - startTime: + description: '! Information about a vulnerability with an HTML.' + id: Form + type: object + Xxe: + type: object + properties: + payloadValue: type: string - description: Output only. The time at which the ScanRun started. - format: google-datetime - endTime: description: >- - Output only. The time at which the ScanRun reached termination state - - that the ScanRun is either finished or stopped by user. - format: google-datetime - type: string - resultState: + The XML string that triggered the XXE vulnerability. Non-payload + values might be redacted. + payloadLocation: enumDescriptions: - - >- - Default value. This value is returned when the ScanRun is not yet - finished. - - The scan finished without errors. - - The scan finished with errors. - - The scan was terminated by user. - description: >- - Output only. The result state of the ScanRun. This field is only - available after the execution state reaches "FINISHED". - type: string - enum: - - RESULT_STATE_UNSPECIFIED - - SUCCESS - - ERROR - - KILLED - executionState: + - Unknown Location. + - The XML payload replaced the complete request body. enum: - - EXECUTION_STATE_UNSPECIFIED - - QUEUED - - SCANNING - - FINISHED + - LOCATION_UNSPECIFIED + - COMPLETE_REQUEST_BODY + description: Location within the request where the payload was placed. type: string - description: Output only. The execution state of the ScanRun. - enumDescriptions: - - >- - Represents an invalid state caused by internal server error. This - value should never be returned. - - The scan is waiting in the queue. - - The scan is in progress. - - The scan is either finished or stopped by user. - errorTrace: - $ref: '#/components/schemas/ScanRunErrorTrace' - description: >- - Output only. If result_state is an ERROR, this field provides the - primary reason for scan's termination and more details, if such are - available. + id: Xxe + description: Information reported for an XXE. + ListFindingTypeStatsResponse: + description: Response for the `ListFindingTypeStats` method. + id: ListFindingTypeStatsResponse + properties: + findingTypeStats: + type: array + description: The list of FindingTypeStats returned. + items: + $ref: '#/components/schemas/FindingTypeStats' + type: object + Header: + id: Header + properties: name: - description: >- - Output only. The resource name of the ScanRun. The name follows the - format of - 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. - The ScanRun IDs are generated by the system. type: string - urlsCrawledCount: - format: int64 + description: Header name. + value: type: string - description: >- - Output only. The number of URLs crawled during this ScanRun. If the - scan is in progress, the value represents the number of URLs crawled - up to now. - warningTraces: - items: - $ref: '#/components/schemas/ScanRunWarningTrace' - type: array - description: >- - Output only. A list of warnings, if such are encountered during this - scan run. - hasVulnerabilities: - description: Output only. Whether the scan run has found any vulnerabilities. - type: boolean - StopScanRunRequest: - properties: {} - description: Request for the `StopScanRun` method. + description: Header value. + description: Describes a HTTP Header. type: object - id: StopScanRunRequest parameters: - oauth_token: - description: OAuth 2.0 token for the current user. - in: query - name: oauth_token - schema: - type: string - uploadType: - description: Legacy upload protocol for media (e.g. "media", "multipart"). + fields: + description: Selector specifying which fields to include in a partial response. in: query - name: uploadType + name: fields schema: type: string - callback: - description: JSONP + access_token: + description: OAuth access token. in: query - name: callback + name: access_token schema: type: string - alt: - description: Data format for response. + _.xgafv: + description: V1 error format. in: query - name: alt + name: $.xgafv schema: type: string enum: - - json - - media - - proto - quotaUser: - description: >- - Available to use for quota purposes for server-side applications. Can be - any arbitrary string assigned to a user, but should not exceed 40 - characters. - in: query - name: quotaUser - schema: - type: string - upload_protocol: - description: Upload protocol for media (e.g. "raw", "multipart"). + - '1' + - '2' + uploadType: + description: Legacy upload protocol for media (e.g. "media", "multipart"). in: query - name: upload_protocol + name: uploadType schema: type: string key: @@ -990,25 +974,41 @@ components: name: key schema: type: string - access_token: - description: OAuth access token. + callback: + description: JSONP + in: query + name: callback + schema: + type: string + quotaUser: + description: >- + Available to use for quota purposes for server-side applications. Can be + any arbitrary string assigned to a user, but should not exceed 40 + characters. in: query - name: access_token + name: quotaUser schema: type: string - _.xgafv: - description: V1 error format. + alt: + description: Data format for response. in: query - name: $.xgafv + name: alt schema: type: string enum: - - '1' - - '2' - fields: - description: Selector specifying which fields to include in a partial response. + - json + - media + - proto + upload_protocol: + description: Upload protocol for media (e.g. "raw", "multipart"). in: query - name: fields + name: upload_protocol + schema: + type: string + oauth_token: + description: OAuth 2.0 token for the current user. + in: query + name: oauth_token schema: type: string prettyPrint: @@ -1030,17 +1030,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_1 - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get - response: &ref_2 - mediaType: application/json - openAPIDocKey: '200' - objectKey: $.scanRuns - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: >- @@ -1048,82 +1037,88 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - select: - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' - - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' - insert: [] - update: [] - delete: [] - finding_type_stats: - id: google.websecurityscanner.finding_type_stats - name: finding_type_stats - title: Finding_type_stats - methods: list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findingTypeStats/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns/get response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.scanRuns sqlVerbs: select: - - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/get' + - $ref: '#/components/x-stackQL-resources/scan_runs/methods/list' insert: [] update: [] + replace: [] delete: [] findings: id: google.websecurityscanner.findings name: findings title: Findings methods: - get: + list: operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings~1{findingsId}/get + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings/get response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_3 + objectKey: $.findings + get: + operation: $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings/get - response: &ref_4 + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findings~1{findingsId}/get + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.findings - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/findings/methods/get' - $ref: '#/components/x-stackQL-resources/findings/methods/list' insert: [] update: [] + replace: [] delete: [] crawled_urls: id: google.websecurityscanner.crawled_urls name: crawled_urls title: Crawled_urls methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1crawledUrls/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.crawledUrls - list: - operation: *ref_5 - response: *ref_6 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/crawled_urls/methods/list' insert: [] update: [] + replace: [] + delete: [] + finding_type_stats: + id: google.websecurityscanner.finding_type_stats + name: finding_type_stats + title: Finding_type_stats + methods: + list: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}~1scanRuns~1{scanRunsId}~1findingTypeStats/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/finding_type_stats/methods/list' + insert: [] + update: [] + replace: [] delete: [] scan_configs: id: google.websecurityscanner.scan_configs @@ -1151,29 +1146,26 @@ components: response: mediaType: application/json openAPIDocKey: '200' - start: + list: operation: - $ref: >- - #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}:start/post + $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/get' response: mediaType: application/json openAPIDocKey: '200' + objectKey: $.scanConfigs create: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/post' response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 - $ref: '#/paths/~1v1~1projects~1{projectsId}~1scanConfigs/get' - response: &ref_8 + start: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1scanConfigs~1{scanConfigsId}:start/post + response: mediaType: application/json openAPIDocKey: '200' - objectKey: $.scanConfigs - list: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/get' @@ -1182,21 +1174,22 @@ components: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/create' update: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/scan_configs/methods/delete' paths: /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}:stop: - parameters: &ref_9 - - $ref: '#/components/parameters/oauth_token' + parameters: &ref_1 + - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/access_token' + - $ref: '#/components/parameters/_.xgafv' - $ref: '#/components/parameters/uploadType' + - $ref: '#/components/parameters/key' - $ref: '#/components/parameters/callback' - - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/quotaUser' + - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/upload_protocol' - - $ref: '#/components/parameters/key' - - $ref: '#/components/parameters/access_token' - - $ref: '#/components/parameters/_.xgafv' - - $ref: '#/components/parameters/fields' + - $ref: '#/components/parameters/oauth_token' - $ref: '#/components/parameters/prettyPrint' post: description: Stops a ScanRun. The stopped ScanRun is returned. @@ -1234,13 +1227,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: - parameters: *ref_9 + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: + parameters: *ref_1 get: - description: >- - Lists ScanRuns under a given ScanConfig, in descending order of ScanRun - stop time. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.list + description: Gets a ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.get security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1252,7 +1243,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListScanRunsResponse' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId @@ -1264,20 +1255,18 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: scanRunsId + required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}: - parameters: *ref_9 + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns: + parameters: *ref_1 get: - description: Gets a ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.get + description: >- + Lists ScanRuns under a given ScanConfig, in descending order of ScanRun + stop time. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1289,7 +1278,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/ListScanRunsResponse' parameters: - in: path name: projectsId @@ -1301,16 +1290,20 @@ paths: required: true schema: type: string - - in: path - name: scanRunsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: - parameters: *ref_9 + - in: query + name: pageSize + schema: + type: integer + format: int32 + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: + parameters: *ref_1 get: - description: List all FindingTypeStats under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list + description: List Findings under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1322,7 +1315,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingTypeStatsResponse' + $ref: '#/components/schemas/ListFindingsResponse' parameters: - in: path name: projectsId @@ -1339,8 +1332,21 @@ paths: required: true schema: type: string + - in: query + name: pageToken + schema: + type: string + - in: query + name: filter + schema: + type: string + - in: query + name: pageSize + schema: + type: integer + format: int32 /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings/{findingsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets a Finding. operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.get @@ -1377,11 +1383,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findings: - parameters: *ref_9 + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: + parameters: *ref_1 get: - description: List Findings under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.findings.list + description: List CrawledUrls under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1393,7 +1399,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListFindingsResponse' + $ref: '#/components/schemas/ListCrawledUrlsResponse' parameters: - in: path name: projectsId @@ -1410,10 +1416,6 @@ paths: required: true schema: type: string - - in: query - name: filter - schema: - type: string - in: query name: pageToken schema: @@ -1423,11 +1425,11 @@ paths: schema: type: integer format: int32 - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/crawledUrls: - parameters: *ref_9 + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}/scanRuns/{scanRunsId}/findingTypeStats: + parameters: *ref_1 get: - description: List CrawledUrls under a given ScanRun. - operationId: websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list + description: List all FindingTypeStats under a given ScanRun. + operationId: websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1439,7 +1441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListCrawledUrlsResponse' + $ref: '#/components/schemas/ListFindingTypeStatsResponse' parameters: - in: path name: projectsId @@ -1456,17 +1458,8 @@ paths: required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken - schema: - type: string /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets a ScanConfig. operationId: websecurityscanner.projects.scanConfigs.get @@ -1557,16 +1550,11 @@ paths: required: true schema: type: string - /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}:start: - parameters: *ref_9 - post: - description: Start a ScanRun according to the given ScanConfig. - operationId: websecurityscanner.projects.scanConfigs.start - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StartScanRunRequest' + /v1/projects/{projectsId}/scanConfigs: + parameters: *ref_1 + get: + description: Lists ScanConfigs under a given project. + operationId: websecurityscanner.projects.scanConfigs.list security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1578,20 +1566,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScanRun' + $ref: '#/components/schemas/ListScanConfigsResponse' parameters: - in: path name: projectsId required: true schema: type: string - - in: path - name: scanConfigsId - required: true + - in: query + name: pageToken schema: type: string - /v1/projects/{projectsId}/scanConfigs: - parameters: *ref_9 + - in: query + name: pageSize + schema: + type: integer + format: int32 post: description: Creates a new ScanConfig. operationId: websecurityscanner.projects.scanConfigs.create @@ -1618,9 +1608,16 @@ paths: required: true schema: type: string - get: - description: Lists ScanConfigs under a given project. - operationId: websecurityscanner.projects.scanConfigs.list + /v1/projects/{projectsId}/scanConfigs/{scanConfigsId}:start: + parameters: *ref_1 + post: + description: Start a ScanRun according to the given ScanConfig. + operationId: websecurityscanner.projects.scanConfigs.start + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartScanRunRequest' security: - Oauth2: - https://www.googleapis.com/auth/cloud-platform @@ -1632,19 +1629,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListScanConfigsResponse' + $ref: '#/components/schemas/ScanRun' parameters: - in: path name: projectsId required: true schema: type: string - - in: query - name: pageSize - schema: - type: integer - format: int32 - - in: query - name: pageToken + - in: path + name: scanConfigsId + required: true schema: type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml b/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml index 78442591..084640a9 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workflowexecutions.yaml @@ -7,8 +7,8 @@ info: title: Workflow Executions API description: Execute workflows created with Workflows API. version: v1 - x-discovery-doc-revision: '20240528' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240827' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/workflows servers: @@ -197,11 +197,13 @@ components: - The step entry is in progress. - The step entry finished successfully. - The step entry failed with an error. + - The step entry is cancelled. enum: - STATE_UNSPECIFIED - STATE_IN_PROGRESS - STATE_SUCCEEDED - STATE_FAILED + - STATE_CANCELLED exception: description: Output only. The exception thrown by the step entry. readOnly: true @@ -219,6 +221,10 @@ components: description: Output only. The StepEntryMetadata associated to this step. readOnly: true $ref: '#/components/schemas/StepEntryMetadata' + variableData: + description: Output only. The VariableData associated to this step. + readOnly: true + $ref: '#/components/schemas/VariableData' Exception: id: Exception description: Exception describes why the step entry failed. @@ -294,6 +300,16 @@ components: the step's progress. type: string format: int64 + VariableData: + id: VariableData + description: VariableData contains the variable data for this step. + type: object + properties: + variables: + description: Variables that are associated with this step. + type: object + additionalProperties: + type: any ListExecutionsResponse: id: ListExecutionsResponse description: Response for the ListExecutions method. @@ -438,6 +454,23 @@ components: the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available. type: boolean + executionHistoryLevel: + description: >- + Optional. Describes the level of the execution history feature to + apply to this execution. If not specified, the level of the + execution history feature will be determined by its workflow's + execution history level. If the value is different from its + workflow's value, it will override the workflow's execution history + level for this exeuction. + type: string + enumDescriptions: + - The default/unset value. + - Enable execution history basic feature for this execution. + - Enable execution history detailed feature for this execution. + enum: + - EXECUTION_HISTORY_LEVEL_UNSPECIFIED + - EXECUTION_HISTORY_BASIC + - EXECUTION_HISTORY_DETAILED Error: id: Error description: Error describes why the execution was abnormally terminated. @@ -644,6 +677,20 @@ components: the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering). type: string + DeleteExecutionHistoryRequest: + id: DeleteExecutionHistoryRequest + description: Request for the DeleteExecutionHistory method. + type: object + properties: {} + Empty: + id: Empty + description: >- + A generic empty message that you can re-use to avoid defining duplicated + empty messages in your APIs. A typical example is to use it as the + request or the response type of an API method. For instance: service Foo + { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } + type: object + properties: {} parameters: access_token: description: OAuth access token. @@ -741,23 +788,21 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] executions: id: google.workflowexecutions.executions name: executions title: Executions methods: - _list: - operation: &ref_1 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflows~1{workflowsId}~1executions/get - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.executions - list: - operation: *ref_1 - response: *ref_2 create: operation: $ref: >- @@ -793,45 +838,61 @@ components: insert: - $ref: '#/components/x-stackQL-resources/executions/methods/create' update: [] + replace: [] delete: [] + executions_execution_history: + id: google.workflowexecutions.executions_execution_history + name: executions_execution_history + title: Executions_execution_history + methods: + delete_execution_history: + operation: + $ref: >- + #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflows~1{workflowsId}~1executions~1{executionsId}:deleteExecutionHistory/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + replace: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/executions_execution_history/methods/delete_execution_history callbacks: id: google.workflowexecutions.callbacks name: callbacks title: Callbacks methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflows~1{workflowsId}~1executions~1{executionsId}~1callbacks/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.callbacks - list: - operation: *ref_3 - response: *ref_4 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/callbacks/methods/list' insert: [] update: [] + replace: [] delete: [] step_entries: id: google.workflowexecutions.step_entries name: step_entries title: Step_entries methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflows~1{workflowsId}~1executions~1{executionsId}~1stepEntries/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.stepEntries - list: - operation: *ref_5 - response: *ref_6 get: operation: $ref: >- @@ -845,10 +906,11 @@ components: - $ref: '#/components/x-stackQL-resources/step_entries/methods/list' insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}:triggerPubsubExecution: - parameters: &ref_7 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -899,7 +961,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Returns a list of executions which belong to the workflow with the given @@ -994,7 +1056,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Returns an execution of the given name. operationId: workflowexecutions.projects.locations.workflows.executions.get @@ -1036,7 +1098,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:cancel: - parameters: *ref_7 + parameters: *ref_1 post: description: Cancels an execution of the given name. operationId: workflowexecutions.projects.locations.workflows.executions.cancel @@ -1079,7 +1141,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:exportData: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Returns all metadata stored about an execution, excluding most data that @@ -1118,8 +1180,52 @@ paths: required: true schema: type: string + /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:deleteExecutionHistory: + parameters: *ref_1 + post: + description: Deletes all step entries for an execution. + operationId: >- + workflowexecutions.projects.locations.workflows.executions.deleteExecutionHistory + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteExecutionHistoryRequest' + security: + - Oauth2: + - https://www.googleapis.com/auth/cloud-platform + Oauth2c: + - https://www.googleapis.com/auth/cloud-platform + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Empty' + parameters: + - in: path + name: projectsId + required: true + schema: + type: string + - in: path + name: locationsId + required: true + schema: + type: string + - in: path + name: workflowsId + required: true + schema: + type: string + - in: path + name: executionsId + required: true + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}/callbacks: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Returns a list of active callbacks that belong to the execution with the @@ -1169,7 +1275,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}/stepEntries: - parameters: *ref_7 + parameters: *ref_1 get: description: >- Lists step entries for the corresponding workflow execution. Returned @@ -1231,8 +1337,12 @@ paths: name: orderBy schema: type: string + - in: query + name: view + schema: + type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}/stepEntries/{stepEntriesId}: - parameters: *ref_7 + parameters: *ref_1 get: description: Gets a step entry. operationId: >- @@ -1275,3 +1385,7 @@ paths: required: true schema: type: string + - in: query + name: view + schema: + type: string diff --git a/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml b/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml index 120f3b8c..04f40d07 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workflows.yaml @@ -9,8 +9,8 @@ info: Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API. version: v1 - x-discovery-doc-revision: '20240522' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240821' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/workflows servers: @@ -213,7 +213,7 @@ components: type: string Workflow: id: Workflow - description: Workflow program to be executed by Workflows. + description: LINT.IfChange Workflow program to be executed by Workflows. type: object properties: name: @@ -345,18 +345,31 @@ components: type: object additionalProperties: type: string + executionHistoryLevel: + description: >- + Optional. Describes the level of the execution history feature to + apply to this workflow. + type: string + enumDescriptions: + - The default/unset value. + - Enable execution history basic feature. + - Enable execution history detailed feature. + enum: + - EXECUTION_HISTORY_LEVEL_UNSPECIFIED + - EXECUTION_HISTORY_BASIC + - EXECUTION_HISTORY_DETAILED allKmsKeys: description: >- - Output only. A list of all KMS crypto keys used to encrypt or decrpt - the data associated with the workflow. + Output only. A list of all KMS crypto keys used to encrypt or + decrypt the data associated with the workflow. readOnly: true type: array items: type: string allKmsKeysVersions: description: >- - Output only. A list of all KMS crypto keys versions used to encrypt - or decrpt the data associated with the workflow. + Output only. A list of all KMS crypto key versions used to encrypt + or decrypt the data associated with the workflow. readOnly: true type: array items: @@ -510,16 +523,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -532,23 +542,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.workflows.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -569,6 +577,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' workflows: @@ -576,17 +585,14 @@ components: name: workflows title: Workflows methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflows/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workflows - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -623,6 +629,7 @@ components: - $ref: '#/components/x-stackQL-resources/workflows/methods/create' update: - $ref: '#/components/x-stackQL-resources/workflows/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/workflows/methods/delete' workflows_revisions: @@ -630,27 +637,25 @@ components: name: workflows_revisions title: Workflows_revisions methods: - _list_revisions: - operation: &ref_7 + list_revisions: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workflows~1{workflowsId}:listRevisions/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workflows - list_revisions: - operation: *ref_7 - response: *ref_8 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/workflows_revisions/methods/list_revisions insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_9 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -697,7 +702,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets information about a location. operationId: workflows.projects.locations.get @@ -725,7 +730,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -768,7 +773,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -839,7 +844,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows: - parameters: *ref_9 + parameters: *ref_1 get: description: >- Lists workflows in a given project and location. The default order is @@ -924,7 +929,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}: - parameters: *ref_9 + parameters: *ref_1 get: description: Gets details of a single workflow. operationId: workflows.projects.locations.workflows.get @@ -1039,7 +1044,7 @@ paths: type: string format: google-fieldmask /v1/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}:listRevisions: - parameters: *ref_9 + parameters: *ref_1 get: description: Lists revisions for a given workflow. operationId: workflows.projects.locations.workflows.listRevisions diff --git a/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml b/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml index b8cfe89a..bf15a60b 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workloadmanager.yaml @@ -10,8 +10,8 @@ info: to automate the deployment and validation of your workloads against best practices and recommendations. version: v1 - x-discovery-doc-revision: '20240501' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240731' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/workload-manager/docs servers: @@ -387,7 +387,7 @@ components: properties: name: description: >- - Required. Name of external data source. The name will be used inside + Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data type: string uri: @@ -404,6 +404,13 @@ components: enum: - TYPE_UNSPECIFIED - BIG_QUERY_TABLE + assetType: + description: >- + Required. The asset type of the external data source this can be one + of go/cai-asset-types to override the default asset type or it can + be a custom type defined by the user custom type must match the + asset type in the rule + type: string RunEvaluationRequest: id: RunEvaluationRequest description: Message for creating a Execution @@ -454,53 +461,105 @@ components: type: object properties: violationMessage: - description: the violation message of an execution + description: The violation message of an execution. type: string severity: - description: severity of violation + description: The severity of violation. type: string rule: - description: the rule which violate in execution + description: The rule that is violated in an evaluation. type: string documentationUrl: - description: the document url of the rule + description: The URL for the documentation of the rule. type: string resource: - description: the violate resource + description: The resource that violates the rule. $ref: '#/components/schemas/Resource' violationDetails: - description: the details of violation in result + description: The details of violation in an evaluation result. $ref: '#/components/schemas/ViolationDetails' + commands: + description: The commands to remediate the violation. + type: array + items: + $ref: '#/components/schemas/Command' Resource: id: Resource description: Message represent resource in execution result type: object properties: type: - description: the type of reresource + description: The type of resource. type: string name: - description: the name of the resource + description: The name of the resource. type: string serviceAccount: - description: the service account accosiate with resource + description: The service account associated with the resource. type: string ViolationDetails: id: ViolationDetails - description: Message describing the violdation in execution result + description: Message describing the violation in an evaluation result. type: object properties: asset: - description: the name of asset + description: The name of the asset. type: string serviceAccount: - description: the service account associate with resource + description: The service account associated with the resource. type: string observed: - description: observed + description: Details of the violation. type: object additionalProperties: type: string + Command: + id: Command + description: '* Command specifies the type of command to execute.' + type: object + properties: + agentCommand: + description: >- + AgentCommand specifies a one-time executable program for the agent + to run. + $ref: '#/components/schemas/AgentCommand' + shellCommand: + description: ShellCommand is invoked via the agent's command line executor. + $ref: '#/components/schemas/ShellCommand' + AgentCommand: + id: AgentCommand + description: >- + * An AgentCommand specifies a one-time executable program for the agent + to run. + type: object + properties: + command: + description: >- + command is the name of the agent one-time executable that will be + invoked. + type: string + parameters: + description: >- + parameters is a map of key/value pairs that can be used to specify + additional one-time executable settings. + type: object + additionalProperties: + type: string + ShellCommand: + id: ShellCommand + description: '* A ShellCommand is invoked via the agent''s command line executor' + type: object + properties: + command: + description: command is the name of the command to be executed. + type: string + args: + description: args is a string of arguments to be passed to the command. + type: string + timeoutSeconds: + description: Optional. If not specified, the default timeout is 60 seconds. + type: integer + format: int32 ListRulesResponse: id: ListRulesResponse description: Mesesage of response of list rules @@ -843,6 +902,13 @@ components: type: array items: type: string + replicationSites: + description: >- + Optional. A list of replication sites used in Disaster Recovery (DR) + configurations. + type: array + items: + $ref: '#/components/schemas/SapDiscoveryComponent' SapDiscoveryResource: id: SapDiscoveryResource description: Message describing a resource. @@ -939,12 +1005,42 @@ components: - Enqueue replication server. - Application server. - Database node. + - >- + Combinations of roles. Application central services and enqueue + replication server. + - Application central services and application server. + - Application central services and database. + - Enqueue replication server and application server. + - Enqueue replication server and database. + - Application server and database. + - >- + Application central services, enqueue replication server and + application server. + - >- + Application central services, enqueue replication server and + database. + - Application central services, application server and database. + - Enqueue replication server, application server and database. + - >- + Application central services, enqueue replication server, + application server and database. enum: - INSTANCE_ROLE_UNSPECIFIED - INSTANCE_ROLE_ASCS - INSTANCE_ROLE_ERS - INSTANCE_ROLE_APP_SERVER - INSTANCE_ROLE_DATABASE + - INSTANCE_ROLE_ASCS_ERS + - INSTANCE_ROLE_ASCS_APP_SERVER + - INSTANCE_ROLE_ASCS_DATABASE + - INSTANCE_ROLE_ERS_APP_SERVER + - INSTANCE_ROLE_ERS_DATABASE + - INSTANCE_ROLE_APP_SERVER_DATABASE + - INSTANCE_ROLE_ASCS_ERS_APP_SERVER + - INSTANCE_ROLE_ASCS_ERS_DATABASE + - INSTANCE_ROLE_ASCS_APP_SERVER_DATABASE + - INSTANCE_ROLE_ERS_APP_SERVER_DATABASE + - INSTANCE_ROLE_ASCS_ERS_APP_SERVER_DATABASE appInstances: description: Optional. App server instances on the host type: array @@ -973,9 +1069,13 @@ components: enumDescriptions: - Unspecified application type - SAP Netweaver + - SAP Netweaver ABAP + - SAP Netweaver Java enum: - APPLICATION_TYPE_UNSPECIFIED - NETWEAVER + - NETWEAVER_ABAP + - NETWEAVER_JAVA ascsUri: description: >- Optional. Resource URI of the recognized ASCS host of the @@ -992,8 +1092,9 @@ components: type: string abap: description: >- - Optional. Indicates whether this is a Java or ABAP Netweaver - instance. true means it is ABAP, false means it is Java. + Optional. Deprecated: ApplicationType now tells you whether this is + ABAP or Java. + deprecated: true type: boolean appInstanceNumber: description: Optional. Instance number of the SAP application instance. @@ -1244,6 +1345,11 @@ components: type: array items: $ref: '#/components/schemas/ExtraParameter' + ccfeRmsPath: + description: >- + Spanner path of the CCFE RMS database. It is only applicable for + CCFE tenants that use CCFE RMS for storing resource metadata. + type: string IsolationExpectations: id: IsolationExpectations type: object @@ -1347,6 +1453,41 @@ components: - ZI_REGION_UNKNOWN - ZI_REGION_NOT_ENABLED - ZI_REGION_ENABLED + requirementOverride: + description: >- + Explicit overrides for ZI and ZS requirements to be used for + resources that should be excluded from ZI/ZS verification logic. + $ref: '#/components/schemas/RequirementOverride' + RequirementOverride: + id: RequirementOverride + type: object + properties: + ziOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + - '' + enum: + - ZI_UNSPECIFIED + - ZI_UNKNOWN + - ZI_NOT_REQUIRED + - ZI_PREFERRED + - ZI_REQUIRED + zsOverride: + type: string + enumDescriptions: + - '' + - To be used if tracking is not available + - '' + - '' + enum: + - ZS_UNSPECIFIED + - ZS_UNKNOWN + - ZS_NOT_REQUIRED + - ZS_REQUIRED LocationData: id: LocationData type: object @@ -1361,6 +1502,8 @@ components: $ref: '#/components/schemas/TenantProjectProxy' blobstoreLocation: $ref: '#/components/schemas/BlobstoreLocation' + placerLocation: + $ref: '#/components/schemas/PlacerLocation' DirectLocationAssignment: id: DirectLocationAssignment type: object @@ -1402,6 +1545,14 @@ components: type: object properties: dbName: + description: Set of databases used by the resource in format /span// + type: array + items: + type: string + backupName: + description: >- + Set of backups used by the resource with name in the same format as + what is available at http://table/spanner_automon.backup_metadata type: array items: type: string @@ -1440,6 +1591,18 @@ components: type: array items: type: string + PlacerLocation: + id: PlacerLocation + description: >- + Message describing that the location of the customer resource is tied to + placer allocations + type: object + properties: + placerConfig: + description: >- + Directory with a config related to it in placer (e.g. + "/placer/prod/home/my-root/my-dir") + type: string ExtraParameter: id: ExtraParameter description: Defines parameters that should only be used for specific asset types. @@ -1560,16 +1723,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1582,23 +1742,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.workloadmanager.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1626,6 +1784,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' evaluations: @@ -1633,17 +1792,14 @@ components: name: evaluations title: Evaluations methods: - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1evaluations/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.evaluations - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1672,6 +1828,7 @@ components: insert: - $ref: '#/components/x-stackQL-resources/evaluations/methods/create' update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/evaluations/methods/delete' executions: @@ -1679,17 +1836,14 @@ components: name: executions title: Executions methods: - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1evaluations~1{evaluationsId}~1executions/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.executions - list: - operation: *ref_7 - response: *ref_8 get: operation: $ref: >- @@ -1717,6 +1871,7 @@ components: - $ref: '#/components/x-stackQL-resources/executions/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/executions/methods/delete' results: @@ -1724,66 +1879,60 @@ components: name: results title: Results methods: - _list: - operation: &ref_9 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1evaluations~1{evaluationsId}~1executions~1{executionsId}~1results/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.executionResults - list: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/results/methods/list' insert: [] update: [] + replace: [] delete: [] scanned_resources: id: google.workloadmanager.scanned_resources name: scanned_resources title: Scanned_resources methods: - _list: - operation: &ref_11 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1evaluations~1{evaluationsId}~1executions~1{executionsId}~1scannedResources/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.scannedResources - list: - operation: *ref_11 - response: *ref_12 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/scanned_resources/methods/list' insert: [] update: [] + replace: [] delete: [] rules: id: google.workloadmanager.rules name: rules title: Rules methods: - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1rules/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.rules - list: - operation: *ref_13 - response: *ref_14 sqlVerbs: select: - $ref: '#/components/x-stackQL-resources/rules/methods/list' insert: [] update: [] + replace: [] delete: [] insights: id: google.workloadmanager.insights @@ -1801,10 +1950,11 @@ components: select: [] insert: [] update: [] + replace: [] delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_15 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -1851,7 +2001,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets information about a location. operationId: workloadmanager.projects.locations.get @@ -1879,7 +2029,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -1922,7 +2072,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -1993,7 +2143,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_15 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2040,7 +2190,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/evaluations: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists Evaluations in a given project and location. operationId: workloadmanager.projects.locations.evaluations.list @@ -2124,7 +2274,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets details of a single Evaluation. operationId: workloadmanager.projects.locations.evaluations.get @@ -2196,7 +2346,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists Executions in a given project and location. operationId: workloadmanager.projects.locations.evaluations.executions.list @@ -2246,7 +2396,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}: - parameters: *ref_15 + parameters: *ref_1 get: description: Gets details of a single Execution. operationId: workloadmanager.projects.locations.evaluations.executions.get @@ -2324,7 +2474,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions:run: - parameters: *ref_15 + parameters: *ref_1 post: description: Creates a new Execution in a given project and location. operationId: workloadmanager.projects.locations.evaluations.executions.run @@ -2362,9 +2512,9 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/results: - parameters: *ref_15 + parameters: *ref_1 get: - description: List the running result of a single Execution. + description: Lists the result of a single evaluation. operationId: workloadmanager.projects.locations.evaluations.executions.results.list security: - Oauth2: @@ -2413,7 +2563,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/scannedResources: - parameters: *ref_15 + parameters: *ref_1 get: description: List all scanned resources for a single Execution. operationId: >- @@ -2473,7 +2623,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/rules: - parameters: *ref_15 + parameters: *ref_1 get: description: Lists rules in a given project. operationId: workloadmanager.projects.locations.rules.list @@ -2518,7 +2668,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/insights:writeInsight: - parameters: *ref_15 + parameters: *ref_1 post: description: Write the data insights to workload manager data warehouse. operationId: workloadmanager.projects.locations.insights.writeInsight diff --git a/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml b/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml index 1bfd24fd..0b8709b4 100644 --- a/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml +++ b/providers/src/googleapis.com/v00.00.00000/services/workstations.yaml @@ -9,8 +9,8 @@ info: Allows administrators to create managed developer environments in the cloud. version: v1 - x-discovery-doc-revision: '20240520' - x-generated-date: '2024-06-03' + x-discovery-doc-revision: '20240821' + x-generated-date: '2024-09-13' externalDocs: url: https://cloud.google.com/workstations servers: @@ -462,6 +462,19 @@ components: updates. type: string format: google-duration + maxUsableWorkstations: + description: >- + Optional. Maximum number of workstations under this config a user + can have `workstations.workstation.use` permission on. Only enforced + on CreateWorkstation API calls on the user issuing the API request. + Can be overridden by: - granting a user + workstations.workstationConfigs.exemptMaxUsableWorkstationLimit + permission, or - having a user with that permission create a + workstation and granting another user `workstations.workstation.use` + permission on that workstation. If not specified defaults to 0 which + indicates unlimited. + type: integer + format: int32 host: description: Optional. Runtime host for the workstation. $ref: '#/components/schemas/Host' @@ -535,10 +548,16 @@ components: enableAuditAgent: description: >- Optional. Whether to enable Linux `auditd` logging on the - workstation. When enabled, a service account must also be specified - that has `logging.buckets.write` permission on the project. - Operating system audit logging is distinct from [Cloud Audit - Logs](https://cloud.google.com/workstations/docs/audit-logging). + workstation. When enabled, a service_account must also be specified + that has `roles/logging.logWriter` and + `roles/monitoring.metricWriter` on the project. Operating system + audit logging is distinct from [Cloud Audit + Logs](https://cloud.google.com/workstations/docs/audit-logging) and + [Container output + logging](http://cloud/workstations/docs/container-output-logging#overview). + Operating system audit logs are available in the [Cloud + Logging](https://cloud.google.com/logging/docs) console by querying: + resource.type="gce_instance" log_name:"/logs/linux-auditd" type: boolean disableTcpConnections: description: >- @@ -549,6 +568,23 @@ components: connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. type: boolean + allowedPorts: + description: >- + Optional. A list of PortRanges specifying single ports or ranges of + ports that are externally accessible in the workstation. Allowed + ports must be one of 22, 80, or within range 1024-65535. If not + specified defaults to ports 22, 80, and ports 1024-65535. + type: array + items: + $ref: '#/components/schemas/PortRange' + grantWorkstationAdminRoleOnCreate: + description: >- + Optional. Grant creator of a workstation + `roles/workstations.policyAdmin` role along with + `roles/workstations.user` role on the workstation created by them. + This allows workstation users to share access to either their entire + workstation, or individual ports. Defaults to false. + type: boolean Host: id: Host description: Runtime host for a workstation. @@ -635,10 +671,11 @@ components: description: >- Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. - Nested virtualization lets you run virtual machine (VM) instances - inside your workstation. Before enabling nested virtualization, - consider the following important considerations. Cloud Workstations - instances are subject to the [same restrictions as Compute Engine + Defaults to false. Nested virtualization lets you run virtual + machine (VM) instances inside your workstation. Before enabling + nested virtualization, consider the following important + considerations. Cloud Workstations instances are subject to the + [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested @@ -651,15 +688,7 @@ components: possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a - machine_type in the N1 or N2 machine series. * **GPUs**: nested - virtualization may not be enabled on workstation configurations with - accelerators. * **Operating System**: Because [Container-Optimized - OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) - does not support nested virtualization, when nested virtualization - is enabled, the underlying Compute Engine VM instances boot from an - [Ubuntu - LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) - image. + machine_type in the N1 or N2 machine series. type: boolean shieldedInstanceConfig: description: Optional. A set of Compute Engine Shielded instance options. @@ -683,6 +712,16 @@ components: disableSsh: description: Optional. Whether to disable SSH access to the VM. type: boolean + vmTags: + description: >- + Optional. Resource manager tags to be bound to this instance. Tag + keys and values have the same definition as [resource manager + tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). + Keys must be in the format `tagKeys/{tag_key_id}`, and values are in + the format `tagValues/456`. + type: object + additionalProperties: + type: string GceShieldedInstanceConfig: id: GceShieldedInstanceConfig description: A set of Compute Engine Shielded instance options. @@ -910,6 +949,25 @@ components: description: Optional. Port to which the request should be sent. type: integer format: int32 + PortRange: + id: PortRange + description: >- + A PortRange defines a range of ports. Both first and last are inclusive. + To specify a single port, both first and last should be the same. + type: object + properties: + first: + description: >- + Required. Starting port number for the current range of ports. Valid + ports are 22, 80, and ports within the range 1024-65535. + type: integer + format: int32 + last: + description: >- + Required. Ending port number for the current range of ports. Valid + ports are 22, 80, and ports within the range 1024-65535. + type: integer + format: int32 ListWorkstationConfigsResponse: id: ListWorkstationConfigsResponse description: Response message for ListWorkstationConfigs. @@ -1151,6 +1209,15 @@ components: will be set to a default value of 1 hour. type: string format: google-duration + port: + description: >- + Optional. Port for which the access token should be generated. If + specified, the generated access token grants access only to the + specified port of the workstation. If specified, values must be + within the range [1 - 65535]. If not specified, the generated access + token grants access to all ports of the workstation. + type: integer + format: int32 GenerateAccessTokenResponse: id: GenerateAccessTokenResponse description: Response message for GenerateAccessToken. @@ -1623,16 +1690,13 @@ components: name: locations title: Locations methods: - _list: - operation: &ref_1 + list: + operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations/get' - response: &ref_2 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.locations - list: - operation: *ref_1 - response: *ref_2 get: operation: $ref: '#/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}/get' @@ -1645,23 +1709,21 @@ components: - $ref: '#/components/x-stackQL-resources/locations/methods/list' insert: [] update: [] + replace: [] delete: [] operations: id: google.workstations.operations name: operations title: Operations methods: - _list: - operation: &ref_3 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1operations/get - response: &ref_4 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.operations - list: - operation: *ref_3 - response: *ref_4 get: operation: $ref: >- @@ -1689,6 +1751,7 @@ components: - $ref: '#/components/x-stackQL-resources/operations/methods/list' insert: [] update: [] + replace: [] delete: - $ref: '#/components/x-stackQL-resources/operations/methods/delete' workstation_clusters: @@ -1717,17 +1780,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_5 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workstationClusters/get - response: &ref_6 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workstationClusters - list: - operation: *ref_5 - response: *ref_6 create: operation: $ref: >- @@ -1745,6 +1805,7 @@ components: update: - $ref: >- #/components/x-stackQL-resources/workstation_clusters/methods/patch + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/workstation_clusters/methods/delete @@ -1774,17 +1835,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_7 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workstationClusters~1{workstationClustersId}~1workstationConfigs/get - response: &ref_8 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workstationConfigs - list: - operation: *ref_7 - response: *ref_8 create: operation: $ref: >- @@ -1801,6 +1859,7 @@ components: #/components/x-stackQL-resources/workstation_configs/methods/create update: - $ref: '#/components/x-stackQL-resources/workstation_configs/methods/patch' + replace: [] delete: - $ref: >- #/components/x-stackQL-resources/workstation_configs/methods/delete @@ -1809,23 +1868,21 @@ components: name: workstation_configs_usable title: Workstation_configs_usable methods: - _list_usable: - operation: &ref_9 + list_usable: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workstationClusters~1{workstationClustersId}~1workstationConfigs:listUsable/get - response: &ref_10 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workstationConfigs - list_usable: - operation: *ref_9 - response: *ref_10 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/workstation_configs_usable/methods/list_usable insert: [] update: [] + replace: [] delete: [] workstation_configs_iam_policies: id: google.workstations.workstation_configs_iam_policies @@ -1839,17 +1896,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_11 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workstationClusters~1{workstationClustersId}~1workstationConfigs~1{workstationConfigsId}:getIamPolicy/get - response: &ref_12 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_11 - response: *ref_12 test_iam_permissions: operation: $ref: >- @@ -1863,6 +1917,9 @@ components: #/components/x-stackQL-resources/workstation_configs_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/workstation_configs_iam_policies/methods/set_iam_policy delete: [] workstations: id: google.workstations.workstations @@ -1890,17 +1947,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _list: - operation: &ref_13 + list: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workstationClusters~1{workstationClustersId}~1workstationConfigs~1{workstationConfigsId}~1workstations/get - response: &ref_14 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workstations - list: - operation: *ref_13 - response: *ref_14 create: operation: $ref: >- @@ -1937,6 +1991,7 @@ components: - $ref: '#/components/x-stackQL-resources/workstations/methods/create' update: - $ref: '#/components/x-stackQL-resources/workstations/methods/patch' + replace: [] delete: - $ref: '#/components/x-stackQL-resources/workstations/methods/delete' workstations_usable: @@ -1944,23 +1999,21 @@ components: name: workstations_usable title: Workstations_usable methods: - _list_usable: - operation: &ref_15 + list_usable: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workstationClusters~1{workstationClustersId}~1workstationConfigs~1{workstationConfigsId}~1workstations:listUsable/get - response: &ref_16 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.workstations - list_usable: - operation: *ref_15 - response: *ref_16 sqlVerbs: select: - $ref: >- #/components/x-stackQL-resources/workstations_usable/methods/list_usable insert: [] update: [] + replace: [] delete: [] workstations_iam_policies: id: google.workstations.workstations_iam_policies @@ -1974,17 +2027,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - _get_iam_policy: - operation: &ref_17 + get_iam_policy: + operation: $ref: >- #/paths/~1v1~1projects~1{projectsId}~1locations~1{locationsId}~1workstationClusters~1{workstationClustersId}~1workstationConfigs~1{workstationConfigsId}~1workstations~1{workstationsId}:getIamPolicy/get - response: &ref_18 + response: mediaType: application/json openAPIDocKey: '200' objectKey: $.bindings - get_iam_policy: - operation: *ref_17 - response: *ref_18 test_iam_permissions: operation: $ref: >- @@ -1998,10 +2048,13 @@ components: #/components/x-stackQL-resources/workstations_iam_policies/methods/get_iam_policy insert: [] update: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/workstations_iam_policies/methods/set_iam_policy delete: [] paths: /v1/projects/{projectsId}/locations: - parameters: &ref_19 + parameters: &ref_1 - $ref: '#/components/parameters/access_token' - $ref: '#/components/parameters/alt' - $ref: '#/components/parameters/callback' @@ -2048,7 +2101,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Gets information about a location. operationId: workstations.projects.locations.get @@ -2076,7 +2129,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Lists operations that match the specified filter in the request. If the @@ -2119,7 +2172,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the latest state of a long-running operation. Clients can use this @@ -2190,7 +2243,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Starts asynchronous cancellation on a long-running operation. The server @@ -2237,7 +2290,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns the requested workstation cluster. operationId: workstations.projects.locations.workstationClusters.get @@ -2362,7 +2415,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns all workstation clusters in the specified location. operationId: workstations.projects.locations.workstationClusters.list @@ -2438,7 +2491,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns the requested workstation configuration. operationId: >- @@ -2581,7 +2634,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns all workstation configurations in the specified cluster. operationId: >- @@ -2669,7 +2722,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs:listUsable: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Returns all workstation configurations in the specified cluster on which @@ -2714,7 +2767,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -2761,7 +2814,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -2807,7 +2860,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the @@ -2856,7 +2909,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns the requested workstation. operationId: >- @@ -3010,7 +3063,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations: - parameters: *ref_19 + parameters: *ref_1 get: description: Returns all Workstations using the specified workstation configuration. operationId: >- @@ -3108,7 +3161,7 @@ paths: schema: type: boolean /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Returns all workstations using the specified workstation configuration @@ -3158,7 +3211,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:start: - parameters: *ref_19 + parameters: *ref_1 post: description: Starts running a workstation so that users can connect to it. operationId: >- @@ -3207,7 +3260,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:stop: - parameters: *ref_19 + parameters: *ref_1 post: description: Stops running a workstation, reducing costs. operationId: >- @@ -3256,7 +3309,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:generateAccessToken: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns a short-lived credential that can be used to send authenticated @@ -3307,7 +3360,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Sets the access control policy on the specified resource. Replaces any @@ -3359,7 +3412,7 @@ paths: schema: type: string /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy: - parameters: *ref_19 + parameters: *ref_1 get: description: >- Gets the access control policy for a resource. Returns an empty policy @@ -3410,7 +3463,7 @@ paths: type: integer format: int32 /v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions: - parameters: *ref_19 + parameters: *ref_1 post: description: >- Returns permissions that a caller has on the specified resource. If the